Configuration.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is part of the RSC project
 *
 * Copyright (C) 2012, 2013, 2016 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
 *
 * ============================================================ */

#include <string>

#include <boost/filesystem.hpp>

#include "OptionHandler.h"

#include <rsc/rscexports.h>

namespace rsc {
namespace config {

RSC_EXPORT extern const std::string DEFAULT_DEBUG_VARIABLE_NAME;

RSC_EXPORT extern const std::string DEFAULT_FILE_VARIABLE_NAME;

RSC_EXPORT extern const std::string CONFIG_FILE_KEY_PREFIX;
RSC_EXPORT extern const std::string CONFIG_FILE_KEY_USER;
RSC_EXPORT extern const std::string CONFIG_FILE_KEY_PWD;

std::vector<std::string> RSC_EXPORT
defaultConfigurationFiles(const std::string& fileVariableName
                          = DEFAULT_FILE_VARIABLE_NAME);


std::pair<boost::filesystem::path, std::string> RSC_EXPORT
resolveConfigurationFile(const std::string&             spec,
                         const boost::filesystem::path& prefix,
                         const std::string&             configFileName);

void RSC_EXPORT configure(OptionHandler&                  handler,
                          const std::string&              configFileName,
                          const std::string&              environmentVariablePrefix,
                          int                             argc                           = 0,
                          const char**                    argv                           = 0,
                          bool                            stripEnvironmentVariablePrefix = true,
                          const boost::filesystem::path&  prefix                         = "/",
                          const std::string&              debugVariableName              = DEFAULT_DEBUG_VARIABLE_NAME,
                          const std::vector<std::string>& configurationFiles             = defaultConfigurationFiles());

}
}