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-2018 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_MANAGEMENT_CONFIG_FILE_HPP
23 #define NDN_MANAGEMENT_CONFIG_FILE_HPP
24 
25 #include "../common.hpp"
26 
27 #include <fstream>
28 
29 #include <boost/property_tree/ptree.hpp>
30 #include <boost/filesystem.hpp>
31 
32 namespace ndn {
33 
48 class ConfigFile : noncopyable
49 {
50 public:
51 
52  class Error : public std::runtime_error
53  {
54  public:
55  using std::runtime_error::runtime_error;
56  };
57 
58  typedef boost::property_tree::ptree Parsed;
59 
65  ConfigFile();
66 
67  ~ConfigFile();
68 
69  const boost::filesystem::path&
70  getPath() const;
71 
72  const Parsed&
73  getParsedConfiguration() const;
74 
75 private:
76 
77  bool
78  open();
79 
80  void
81  close();
82 
93  const Parsed&
94  parse();
95 
108  boost::filesystem::path
109  findConfigFile();
110 
111 private:
112  boost::filesystem::path m_path; // absolute path to active configuration file (if any)
113  std::ifstream m_input;
114  Parsed m_config;
115 };
116 
117 inline const boost::filesystem::path&
119 {
120  return m_path;
121 }
122 
123 inline const ConfigFile::Parsed&
125 {
126  return m_config;
127 }
128 
129 } // namespace ndn
130 
131 
132 #endif // NDN_MANAGEMENT_CONFIG_FILE_HPP
Copyright (c) 2013-2017 Regents of the University of California.
Definition: common.hpp:65
const Parsed & getParsedConfiguration() const
boost::property_tree::ptree Parsed
Definition: config-file.hpp:58
System configuration file for NDN platform.
Definition: config-file.hpp:48
const boost::filesystem::path & getPath() const
ConfigFile()
Locate, open, and parse a library configuration file.
Definition: config-file.cpp:29