Environment.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is part of the RSC project
 *
 * Copyright (C) 2011, 2012, 2013 Jan Moringen <jmoringe@techfak.uni-bielefeld.de>
 *
 * This file may be licensed under the terms of the
 * GNU Lesser General Public License Version 3 (the ``LGPL''),
 * or (at your option) any later version.
 *
 * Software distributed under the License is distributed
 * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
 * express or implied. See the LGPL for the specific language
 * governing rights and limitations.
 *
 * You should have received a copy of the LGPL along with this
 * program. If not, go to http://www.gnu.org/licenses/lgpl.html
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The development of this software was supported by:
 *   CoR-Lab, Research Institute for Cognition and Robotics
 *     Bielefeld University
 *
 * ============================================================ */

#pragma once

#include <string>

#include <boost/filesystem/path.hpp>

#include <rsc/logging/Logger.h>

#include "ConfigSource.h"

#include "rsc/config.h"
#include "rsc/rscexports.h"


namespace rsc {
namespace config {

RSC_EXPORT boost::filesystem::path systemConfigDirectory();

RSC_EXPORT boost::filesystem::path prefixConfigDirectory(
    const boost::filesystem::path& prefix = RSC_INSTALL_PREFIX);

RSC_EXPORT boost::filesystem::path userHomeDirectory();

RSC_EXPORT boost::filesystem::path userConfigDirectory();


class RSC_EXPORT EnvironmentVariableSource : public ConfigSource {
public:
    EnvironmentVariableSource(const std::string& prefix = "",
            const bool& stripPrefix = true);

    void provideOptions(OptionHandler& handler);
private:
    rsc::logging::LoggerPtr logger;

    const std::string prefix;
    bool stripPrefix;
};

}
}