StormByte-Config 3.0.0
C++26 configuration-document module of the StormByte suite
Loading...
Searching...
No Matches
base.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This file is part of StormByte-Config.
5 *
6 * StormByte-Config original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte-Config source in this
20 * repository. They do not cover other StormByte modules or any third-party
21 * material shipped with this repository (including everything under
22 * thirdparty/, and in particular the bundled StormByte-String tree and
23 * the StormByte Base tree it vendors), which remains under its own license.
24 *
25 * Neither license grants any patent rights. Any patent licenses required
26 * to use this software or third-party components must be obtained separately
27 * from the patent holders.
28 *
29 * StormByte-Config is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU Lesser General Public License for more details.
33 *
34 * You should have received a copy of the GNU Lesser General Public License
35 * version 3 along with StormByte-Config. If not, see
36 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
37 *
38 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
39 */
40
41#pragma once
42
43#include <StormByte/safe/clonable.hxx>
47#include <StormByte/safe/string.hxx>
48
49#include <string_view>
50
56 class Container;
57 class Group;
58 class List;
59 class Value;
60 template<CommentType T> class Comment;
61
66 class STORMBYTE_CONFIG_PUBLIC Base: public StormByte::Safe::Clonable<Base, StormByte::Safe::Shared<Base>> {
67 public:
71 Base() noexcept;
72
77 Base(const StormByte::Safe::String& name);
78
83 Base(const Base& base) noexcept;
84
89 Base(Base&& base) noexcept;
90
96 Base& operator=(const Base& base) noexcept;
97
103 Base& operator=(Base&& base) noexcept;
104
108 ~Base() noexcept override;
109
115 bool operator==(const Base& base) const noexcept;
116
122 bool operator!=(const Base& base) const noexcept;
123
128 constexpr const StormByte::Safe::String& Name() const noexcept {
129 return m_name;
130 }
131
136 STORMBYTE_FORCE_INLINE void Name(std::string_view name) {
138 }
139
144 constexpr virtual Item::Type Type() const noexcept = 0;
145
150 STORMBYTE_FORCE_INLINE constexpr std::string_view TypeToString() const noexcept {
151 return Item::TypeToString(this->Type());
152 }
153
159 static bool IsNameValid(std::string_view name) noexcept;
160
166 template<class T> decltype(auto) As();
167
173 template<class T> decltype(auto) As() const;
174
180 virtual StormByte::Safe::String Serialize(const int& indent_level = 0) const;
181
182 protected:
184
190 virtual bool Equals(const Base& base) const = 0;
191 };
192}
193
Base class for all configuration items.
Definition base.hxx:66
virtual bool Equals(const Base &base) const =0
Equals.
decltype(auto) As()
Typed view of this item.
Base() noexcept
Constructor.
static bool IsNameValid(std::string_view name) noexcept
Checks if name is valid.
decltype(auto) As() const
Typed view of this item.
constexpr std::string_view TypeToString() const noexcept
Gets the type as string.
Definition base.hxx:150
StormByte::Safe::String m_name
Name of the item.
Definition base.hxx:183
void Name(std::string_view name)
Sets the name of the item.
Definition base.hxx:136
virtual constexpr Item::Type Type() const noexcept=0
Gets the type of the item.
virtual StormByte::Safe::String Serialize(const int &indent_level=0) const
Serializes the item as text.
constexpr const StormByte::Safe::String & Name() const noexcept
Gets the name of the item.
Definition base.hxx:128
Definition comment.hxx:71
Holds child items.
Definition container.hxx:62
Named container ({ ... }).
Definition group.hxx:57
Unnamed container ([ ... ]).
Definition list.hxx:57
Scalar configuration item.
Definition value.hxx:73
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Config::Config)
Configuration document items.
Definition base.hxx:55
Type
Node kind in the document tree.
Definition type.hxx:57
static constexpr std::string_view TypeToString(const Type &t) noexcept
Converts a Type to its string representation.
Definition type.hxx:73
Root namespace of the StormByte suite.
STL namespace.
#define STORMBYTE_FORCE_INLINE
#define STORMBYTE_CONFIG_PUBLIC
Definition visibility.h:53