config-file.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2024 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
 *
 * You should have received copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 */
 
#ifndef NDN_CXX_MANAGEMENT_CONFIG_FILE_HPP
#define NDN_CXX_MANAGEMENT_CONFIG_FILE_HPP
 
#include "ndn-cxx/detail/common.hpp"
 
#include <filesystem>
#include <fstream>
 
#include <boost/property_tree/ptree.hpp>
 
namespace ndn {
 
class ConfigFile : noncopyable
{
public:
  class Error : public std::runtime_error
  {
  public:
    using std::runtime_error::runtime_error;
  };
 
  using Parsed = boost::property_tree::ptree;
 
  ConfigFile();
 
  ~ConfigFile();
 
  const std::filesystem::path&
  getPath() const noexcept
  {
    return m_path;
  }
 
  const Parsed&
  getParsedConfiguration() const noexcept
  {
    return m_config;
  }
 
private:
  bool
  open();
 
  void
  close();
 
  const Parsed&
  parse();
 
  std::filesystem::path
  findConfigFile();
 
private:
  std::filesystem::path m_path; // absolute path to active configuration file (if any)
  std::ifstream m_input;
  Parsed m_config;
};
 
} // namespace ndn
 
#endif // NDN_CXX_MANAGEMENT_CONFIG_FILE_HPP