SNode.C
Loading...
Searching...
No Matches
ConfigWWW.h
Go to the documentation of this file.
1/*
2 * SNode.C - A Slim Toolkit for Network Communication
3 * Copyright (C) Volker Christian <me@vchrist.at>
4 * 2020, 2021, 2022, 2023, 2024, 2025, 2026
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Lesser General Public License as published
8 * by the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20/*
21 * MIT License
22 *
23 * Permission is hereby granted, free of charge, to any person obtaining a copy
24 * of this software and associated documentation files (the "Software"), to deal
25 * in the Software without restriction, including without limitation the rights
26 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
27 * copies of the Software, and to permit persons to whom the Software is
28 * furnished to do so, subject to the following conditions:
29 *
30 * The above copyright notice and this permission notice shall be included in
31 * all copies or substantial portions of the Software.
32 *
33 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
34 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
35 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
36 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
37 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
38 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
39 * THE SOFTWARE.
40 */
41
42#ifndef CONFIGWWW_H
43#define CONFIGWWW_H
44
45#include "net/config/ConfigSection.hpp"
46
47namespace net::config {
48 class ConfigInstance;
49}
50
51#ifndef DOXYGEN_SHOULD_SKIP_THIS
52
53#include <string_view>
54
55#endif /* DOXYGEN_SHOULD_SKIP_THIS */
56
57namespace section {
58
59 class ConfigWWW : public net::config::ConfigSection {
60 public:
61 constexpr static std::string_view name{"www"};
62 constexpr static std::string_view description{"Web behavior of httpserver"};
63
64 ConfigWWW(net::config::ConfigInstance* instance);
65
66 ConfigWWW& setHtmlRoot(const std::string& htmlRoot);
67 std::string getHtmlRoot();
68
69 private:
70 CLI::Option* htmlRootOpt;
71 };
72
73} // namespace section
74
75namespace instance {
76
77 class ConfigWWW {
78 public:
79 constexpr static std::string_view name{"www"};
80 constexpr static std::string_view description{"Web behavior of httpserver"};
81
82 ConfigWWW();
83
84 ConfigWWW& setHtmlRoot(const std::string& htmlRoot);
85 std::string getHtmlRoot();
86
87 private:
89 CLI::Option* htmlRootOpt;
90 };
91
92} // namespace instance
93
94#endif // CONFIGWWW_H
CLI::Option * htmlRootOpt
Definition ConfigWWW.h:89
ConfigWWW & setHtmlRoot(const std::string &htmlRoot)
Definition ConfigWWW.cpp:86
std::string getHtmlRoot()
Definition ConfigWWW.cpp:96
static constexpr std::string_view name
Definition ConfigWWW.h:79
static constexpr std::string_view description
Definition ConfigWWW.h:80
CLI::App * configWWWSc
Definition ConfigWWW.h:88
CLI::Option * addOption(const std::string &name, const std::string &description, const std::string &typeName, ValueTypeT defaultValue)
ConfigSection(ConfigInstance *instance, T *sectionPtr, const std::string &group="Sections")
void required(CLI::Option *opt, bool req=true)
ConfigWWW(net::config::ConfigInstance *instance)
Definition ConfigWWW.cpp:52
static constexpr std::string_view description
Definition ConfigWWW.h:62
ConfigWWW & setHtmlRoot(const std::string &htmlRoot)
Definition ConfigWWW.cpp:58
std::string getHtmlRoot()
Definition ConfigWWW.cpp:65
static constexpr std::string_view name
Definition ConfigWWW.h:61
CLI::Option * htmlRootOpt
Definition ConfigWWW.h:70
static CLI::App * newInstance(std::shared_ptr< CLI::App > appWithPtr, const std::string &group, bool final=false)
Definition Config.cpp:736
std::shared_ptr< utils::AppWithPtr< T > > Instance(const std::string &name, const std::string &description, T *section)