Searchable.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_SEARCHABLE_H
#define YARP_OS_SEARCHABLE_H
 
#include <yarp/os/api.h>
 
#include <cstddef>
#include <string>
 
#ifndef YARP_NO_DEPRECATED // Since YARP 3.0.0
#define YARP_INCLUDING_DEPRECATED_HEADER_ON_PURPOSE
#    include <yarp/os/ConstString.h>
#undef YARP_INCLUDING_DEPRECATED_HEADER_ON_PURPOSE
#endif // YARP_NO_DEPRECATED
 
 
namespace yarp {
namespace os {
class Value;
class Bottle;
} // namespace os
} // namespace yarp
 
namespace yarp {
namespace os {
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
class YARP_os_API SearchReport
{
public:
    YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(std::string) key;
    YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(std::string) value;
    bool isFound;
    bool isGroup;
    bool isComment;
    bool isDefault;
 
    explicit SearchReport();
};
 
class YARP_os_API SearchMonitor
{
public:
    virtual ~SearchMonitor();
    virtual void report(const SearchReport& report, const char* context) = 0;
};
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
class YARP_os_API Searchable
{
private:
    SearchMonitor* monitor;
    YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(std::string) monitorContext;
 
public:
    explicit Searchable();
 
    Searchable(const Searchable& rhs) = default;
 
    Searchable(Searchable&& rhs) noexcept = default;
 
    virtual ~Searchable();
 
    Searchable& operator=(const Searchable& rhs) = default;
 
    Searchable& operator=(Searchable&& rhs) noexcept = default;
 
    virtual bool check(const std::string& key) const = 0;
 
 
    virtual bool check(const std::string& key,
                       const std::string& comment) const;
 
    virtual Value& find(const std::string& key) const = 0;
 
    virtual Bottle& findGroup(const std::string& key) const = 0;
 
    Bottle& findGroup(const std::string& key, const std::string& comment) const;
 
    virtual bool check(const std::string& key,
                       Value*& result,
                       const std::string& comment = "") const;
 
 
    virtual Value check(const std::string& key,
                        const Value& fallback,
                        const std::string& comment = "") const;
 
    virtual bool isNull() const;
 
    virtual std::string toString() const = 0;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    virtual void setMonitor(SearchMonitor* monitor, const char* context = "");
    virtual SearchMonitor* getMonitor() const;
    virtual std::string getMonitorContext() const;
    virtual void reportToMonitor(const SearchReport& report) const;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
};
 
} // namespace os
} // namespace yarp
 
#endif // YARP_OS_SEARCHABLE_H