config-file.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2021 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
22 #ifndef NDN_CXX_MANAGEMENT_CONFIG_FILE_HPP
23 #define NDN_CXX_MANAGEMENT_CONFIG_FILE_HPP
24 
26 
27 #include <fstream>
28 
29 #include <boost/filesystem/path.hpp>
30 #include <boost/property_tree/ptree.hpp>
31 
32 namespace ndn {
33 
48 class ConfigFile : noncopyable
49 {
50 public:
51  class Error : public std::runtime_error
52  {
53  public:
54  using std::runtime_error::runtime_error;
55  };
56 
57  using Parsed = boost::property_tree::ptree;
58 
64  ConfigFile();
65 
66  ~ConfigFile();
67 
68  const boost::filesystem::path&
69  getPath() const;
70 
71  const Parsed&
72  getParsedConfiguration() const;
73 
74 private:
75  bool
76  open();
77 
78  void
79  close();
80 
91  const Parsed&
92  parse();
93 
105  boost::filesystem::path
106  findConfigFile();
107 
108 private:
109  boost::filesystem::path m_path; // absolute path to active configuration file (if any)
110  std::ifstream m_input;
111  Parsed m_config;
112 };
113 
114 inline const boost::filesystem::path&
116 {
117  return m_path;
118 }
119 
120 inline const ConfigFile::Parsed&
122 {
123  return m_config;
124 }
125 
126 } // namespace ndn
127 
128 #endif // NDN_CXX_MANAGEMENT_CONFIG_FILE_HPP
System configuration file for NDN platform.
Definition: config-file.hpp:49
ConfigFile()
Locate, open, and parse a library configuration file.
Definition: config-file.cpp:29
const Parsed & getParsedConfiguration() const
const boost::filesystem::path & getPath() const
boost::property_tree::ptree Parsed
Definition: config-file.hpp:57
Common includes and macros used throughout the library.
Definition: data.cpp:25