| awlane | 879afac | 2025-04-28 17:59:36 -0500 | [diff] [blame^] | 1 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
| 2 | /* |
| 3 | * Copyright (c) 2014-2025, The University of Memphis, |
| 4 | * Regents of the University of California, |
| 5 | * Arizona Board of Regents. |
| 6 | * |
| 7 | * This file is part of NLSR (Named-data Link State Routing). |
| 8 | * See AUTHORS.md for complete list of NLSR authors and contributors. |
| 9 | * |
| 10 | * NLSR is free software: you can redistribute it and/or modify it under the terms |
| 11 | * of the GNU General Public License as published by the Free Software Foundation, |
| 12 | * either version 3 of the License, or (at your option) any later version. |
| 13 | * |
| 14 | * NLSR is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; |
| 15 | * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR |
| 16 | * PURPOSE. See the GNU General Public License for more details. |
| 17 | * |
| 18 | * You should have received a copy of the GNU General Public License along with |
| 19 | * NLSR, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>. |
| 20 | */ |
| 21 | |
| 22 | #ifndef NLSR_BOOST_INFO_EDITOR_HPP |
| 23 | #define NLSR_BOOST_INFO_EDITOR_HPP |
| 24 | |
| 25 | #include <string> |
| 26 | |
| 27 | namespace nlsr::util::boost_info_editor { |
| 28 | |
| 29 | /*! Insert a specified combination of configuration field name and value into a specific file path |
| 30 | Returns false if any errors occur on I/O, otherwise true. |
| 31 | \param fileName Path to conf file as string |
| 32 | \param section Section name to add/modify in conf file; expects [section].[subsection]... formatting |
| 33 | \param value The value to insert into the sheet as a string. Typechecking should be done in caller. |
| 34 | */ |
| 35 | bool put(const std::string& fileName, const std::string& section, const std::string& value); |
| 36 | |
| 37 | /*! Remove a specified key and its value from a configuration file at a specific path |
| 38 | Returns false if any errors occur on I/O, otherwise true. |
| 39 | \param fileName Path to conf file as string |
| 40 | \param section Section name to add/modify in conf file; expects [section].[subsection]... formatting |
| 41 | */ |
| 42 | bool remove(const std::string& fileName, const std::string& section); |
| 43 | } // namespace nlsr::util::boost_info_editor |
| 44 | |
| 45 | #endif // NLSR_BOOST_INFO_EDITOR_HPP |