Vocab.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-FileCopyrightText: 2006-2010 RobotCub Consortium
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef YARP_OS_VOCAB_H
#define YARP_OS_VOCAB_H
 
#include <yarp/os/NetInt32.h>
 
#include <string>
 
namespace yarp {
namespace os {
 
// We need a constexpr for efficient switching.
constexpr yarp::conf::vocab32_t createVocab32(char a, char b = 0, char c = 0, char d = 0)
{
    return (static_cast<yarp::conf::vocab32_t>(a))       +
           (static_cast<yarp::conf::vocab32_t>(b) << 8)  +
           (static_cast<yarp::conf::vocab32_t>(c) << 16) +
           (static_cast<yarp::conf::vocab32_t>(d) << 24);
}
 
#ifndef YARP_NO_DEPRECATED // Since YARP 3.5
YARP_DEPRECATED_MSG("Use createVocab32() instead")
constexpr yarp::conf::vocab32_t createVocab(char a, char b = 0, char c = 0, char d = 0)
{
    return createVocab32(a, b, c, d);
}
#endif // YARP_NO_DEPRECATED
 
namespace Vocab32 {
 
YARP_os_API NetInt32 encode(const std::string& str);
 
YARP_os_API std::string decode(NetInt32 code);
 
} // namespace Vocab32
 
#ifndef YARP_NO_DEPRECATED // Since YARP 3.5
// Swig is not happy of having two methods with the same name in
// different namespaces
#ifndef SWIG
namespace Vocab {
 
YARP_DEPRECATED_MSG("Use yarp::os::Vocab32::encode instead")
inline NetInt32 encode(const std::string& str)
{
    return Vocab32::encode(str);
}
 
YARP_DEPRECATED_MSG("Use yarp::os::Vocab32::decode instead")
inline std::string decode(NetInt32 code)
{
    return Vocab32::decode(code);
}
 
} // namespace Vocab
#endif // SWIG
#endif // YARP_NO_DEPRECATED
 
} // namespace os
} // namespace yarp
 
 
 
 
#ifndef YARP_NO_DEPRECATED // since YARP 3.1.0
YARP_DEPRECATED_MSG("Use yarp::os::createVocab() instead")
constexpr int32_t VOCAB(char a, char b, char c, char d)
{
    return yarp::os::createVocab32(a, b, c, d);
}
YARP_DEPRECATED_MSG("Use yarp::os::createVocab() instead")
constexpr int32_t VOCAB4(char a, char b, char c, char d)
{
    return yarp::os::createVocab32(a, b, c, d);
}
YARP_DEPRECATED_MSG("Use yarp::os::createVocab() instead")
constexpr int32_t VOCAB3(char a, char b, char c)
{
    return yarp::os::createVocab32(a, b, c, 0);
}
YARP_DEPRECATED_MSG("Use yarp::os::createVocab() instead")
constexpr int32_t VOCAB2(char a, char b)
{
    return yarp::os::createVocab32(a, b, 0, 0);
}
YARP_DEPRECATED_MSG("Use yarp::os::createVocab() instead")
constexpr int32_t VOCAB1(char a)
{
    return yarp::os::createVocab32(a, 0, 0, 0);
}
#endif // YARP_NO_DEPRECATED
 
#endif // YARP_OS_VOCAB_H