ResourceFinder.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_RESOURCEFINDER_H
#define YARP_OS_RESOURCEFINDER_H
 
#include <yarp/os/Bottle.h>
#include <yarp/os/Property.h>
#include <yarp/os/ResourceFinderOptions.h>
#include <yarp/os/Searchable.h>
#include <yarp/os/Value.h>
 
#include <string>
 
namespace yarp::os {
 
class YARP_os_API ResourceFinder : public Searchable
{
public:
    ResourceFinder();
 
    ResourceFinder(const ResourceFinder& alt);
 
    virtual ~ResourceFinder();
 
    const ResourceFinder& operator=(const ResourceFinder& alt);
 
    bool configure(int argc, char* argv[], bool skipFirstArgument = true);
 
    bool setDefaultContext(const std::string& contextName)
    {
        clearContext();
        return addContext(contextName);
    }
 
    bool setDefault(const std::string& key, const std::string& val);
 
    bool setDefault(const std::string& key, std::int32_t val);
 
    bool setDefault(const std::string& key, yarp::conf::float64_t val);
 
    bool setDefault(const std::string& key, const yarp::os::Value& val);
 
    bool setDefaultConfigFile(const std::string& fname)
    {
        return setDefault("from", fname);
    }
 
    std::string findFile(const std::string& name);
 
    std::string findFileByName(const std::string& name);
 
    std::string findPath(const std::string& name);
 
    yarp::os::Bottle findPaths(const std::string& name);
 
    std::string findPath();
 
 
    std::string getContext();
 
    yarp::os::Bottle getContexts();
 
    // Searchable interface
    bool check(const std::string& key) const override;
    Value& find(const std::string& key) const override;
    Bottle& findGroup(const std::string& key) const override;
    bool isNull() const override;
    std::string toString() const override;
 
 
    virtual ResourceFinder findNestedResourceFinder(const std::string& key);
 
 
    bool isConfigured() const
    {
        return m_isConfiguredFlag;
    }
 
    static ResourceFinder& getResourceFinderSingleton();
 
    using Searchable::check;
    using Searchable::findGroup;
 
    std::string getHomeContextPath();
 
    std::string getHomeRobotPath();
 
    yarp::os::Bottle findPaths(const std::string& name,
                               const ResourceFinderOptions& options);
 
    std::string findPath(const std::string& name,
                         const ResourceFinderOptions& options);
 
    std::string findFile(const std::string& name,
                         const ResourceFinderOptions& options);
 
    std::string findFileByName(const std::string& name,
                               const ResourceFinderOptions& options);
 
    bool readConfig(Property& config,
                    const std::string& key,
                    const ResourceFinderOptions& options);
 
#ifndef YARP_NO_DEPRECATED // Since YARP 3.4
    bool setVerbose(bool verbose = true);
 
    bool setQuiet(bool quiet = true);
#endif // YARP_NO_DEPRECATED
 
#ifndef YARP_NO_DEPRECATED // SINCE YARP 3.5
    YARP_DEPRECATED_MSG("Use yarp::conf::dirs::data_home() + yarp::os::mkdir_p() instead")
    static std::string getDataHome()
    {
        return getDataHomeWithPossibleCreation(true);
    }
 
 
    YARP_DEPRECATED_MSG("Use yarp::conf::dirs::data_home() instead")
    static std::string getDataHomeNoCreate()
    {
        return getDataHomeWithPossibleCreation(false);
    }
 
    YARP_DEPRECATED_MSG("Use yarp::conf::dirs::config_home() + yarp::os::mkdir_p() instead")
    static std::string getConfigHome()
    {
        return getConfigHomeWithPossibleCreation(true);
    }
 
    YARP_DEPRECATED_MSG("Use yarp::conf::dirs::config_home() instead")
    static std::string getConfigHomeNoCreate()
    {
        return getConfigHomeWithPossibleCreation(false);
    }
 
    YARP_DEPRECATED_MSG("Use yarp::conf::dirs::yarpdatadirs() instead")
    static Bottle getDataDirs();
 
    YARP_DEPRECATED_MSG("Use yarp::conf::dirs::config_dirs() instead")
    static Bottle getConfigDirs();
#endif // YARP_NO_DEPRECATED
 
 
private:
    // this might be useful, but is not in spec
    bool addContext(const std::string& appName);
 
    // this might be useful, but is not in spec
    bool clearContext();
 
    bool m_owned;
    bool m_nullConfig;
    bool m_isConfiguredFlag;
    yarp::os::Property m_configprop;
 
    static std::string createIfAbsent(bool mayCreate, const std::string& path);
 
#ifndef YARP_NO_DEPRECATED // SINCE YARP 3.5
    static std::string getDataHomeWithPossibleCreation(bool mayCreate);
    static std::string getConfigHomeWithPossibleCreation(bool mayCreate);
#endif
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
    class Private;
    Private* mPriv;
    ResourceFinder(Searchable& data, Private* altPriv);
#endif // DOXYGEN_SHOULD_SKIP_THIS
};
 
} // namespace yarp::os
 
#endif // YARP_OS_RESOURCEFINDER_H