#include <StormByte/config/item/comment.hxx>


Public Member Functions | |
| Comment (const StormByte::Safe::String &comment) | |
| Constructs a Comment with a Base-owned string. | |
| Comment (StormByte::Safe::String &&comment) | |
| Constructs a Comment by moving a Base-owned string. | |
| Comment (const char *comment) | |
| Constructs a Comment from a NUL-terminated string. | |
| Comment (const Comment &comment) | |
| Copy constructor. | |
| Comment (Comment &&comment) noexcept | |
| Move constructor. | |
| Comment & | operator= (const Comment &comment) |
| Copy assignment operator. | |
| Comment & | operator= (Comment &&comment) noexcept |
| Move assignment operator. | |
| ~Comment () noexcept override | |
| Destructor, defined in the Config module. | |
| bool | Equals (const Base &other) const noexcept override |
| Polymorphic equality comparison. | |
| StormByte::Safe::String | Serialize (const int &indent_level) const noexcept override |
| Serializes the comment item. | |
| constexpr Item::Type | Type () const noexcept override |
| Gets the item type. | |
| constexpr StormByte::Config::Item::CommentType | CommentType () const noexcept |
| Gets the comment syntax. | |
| constexpr std::string_view | CommentTypeToString () const noexcept |
| Converts comment syntax to its text representation. | |
| StormByte::Safe::String & | Text () noexcept |
| Gets mutable comment text. | |
| const StormByte::Safe::String & | Text () const noexcept |
| Gets const comment text. | |
| PointerType | Clone () const override |
| Clones the comment on Base's heap. | |
| PointerType | Move () override |
| Moves the comment to Base's heap. | |
| ~Comment () noexcept | |
| Destructor for Bash single-line comments. | |
| ~Comment () noexcept | |
| Destructor for C single-line comments. | |
| ~Comment () noexcept | |
| Destructor for C multi-line comments. | |
| bool | Equals (const Base &other) const noexcept |
| Equality for Bash single-line comments. | |
| bool | Equals (const Base &other) const noexcept |
| Equality for C single-line comments. | |
| bool | Equals (const Base &other) const noexcept |
| Equality for C multi-line comments. | |
| StormByte::Safe::String | Serialize (const int &indent_level) const noexcept |
| Serializes a Bash single-line comment. | |
| StormByte::Safe::String | Serialize (const int &indent_level) const noexcept |
| Serializes a C single-line comment. | |
| StormByte::Safe::String | Serialize (const int &indent_level) const noexcept |
| Serializes a C multi-line comment. | |
| Public Member Functions inherited from StormByte::Config::Item::Base | |
| Base () noexcept | |
| Constructor. | |
| Base (const StormByte::Safe::String &name) | |
| Constructor. | |
| Base (const Base &base) noexcept | |
| Copy constructor. | |
| Base (Base &&base) noexcept | |
| Move constructor. | |
| Base & | operator= (const Base &base) noexcept |
| Assignment operator. | |
| Base & | operator= (Base &&base) noexcept |
| Move assignment operator. | |
| ~Base () noexcept override | |
| Destructor. | |
| bool | operator== (const Base &base) const noexcept |
| Compares two items. | |
| bool | operator!= (const Base &base) const noexcept |
| Compares two items. | |
| constexpr const StormByte::Safe::String & | Name () const noexcept |
| Gets the name of the item. | |
| void | Name (std::string_view name) |
| Sets the name of the item. | |
| constexpr std::string_view | TypeToString () const noexcept |
| Gets the type as string. | |
| template<class T> | |
| decltype(auto) | As () |
| Typed view of this item. | |
| template<class T> | |
| decltype(auto) | As () const |
| Typed view of this item. | |
| Public Member Functions inherited from StormByte::Safe::Clonable< Base, StormByte::Safe::Shared< Base > > | |
| constexpr | Clonable ()=default |
| constexpr Clonable & | operator= (const Clonable &)=default |
| virtual constexpr | ~Clonable () noexcept=default |
Static Public Attributes | |
| static constexpr bool | CommentTag = true |
| Identifies this as a comment item. | |
Additional Inherited Members | |
| Public Types inherited from StormByte::Safe::Clonable< Base, StormByte::Safe::Shared< Base > > | |
| typedef SmartPointer | PointerType |
| Static Public Member Functions inherited from StormByte::Config::Item::Base | |
| static bool | IsNameValid (std::string_view name) noexcept |
| Checks if name is valid. | |
| Static Public Member Functions inherited from StormByte::Safe::Clonable< Base, StormByte::Safe::Shared< Base > > | |
| static PointerType | MakePointer (Args &&... args) |
| Protected Attributes inherited from StormByte::Config::Item::Base | |
| StormByte::Safe::String | m_name |
| Name of the item. | |
@class Comment @brief Comment item using Bash, C++ line, or C/C++ block syntax.
| T | Comment syntax (CommentType). |
| StormByte::Config::Item::Comment< T >::Comment | ( | const StormByte::Safe::String & | comment | ) |
Constructs a Comment with a Base-owned string.
| comment | The comment string. |
| StormByte::Config::Item::Comment< T >::Comment | ( | StormByte::Safe::String && | comment | ) |
Constructs a Comment by moving a Base-owned string.
| comment | The comment string. |
| StormByte::Config::Item::Comment< T >::Comment | ( | const char * | comment | ) |
| StormByte::Config::Item::Comment< T >::Comment | ( | const Comment< T > & | comment | ) |
Copy constructor.
| comment | Comment to copy. |
|
noexcept |
Move constructor.
| comment | Comment to move. |
|
overridenoexcept |
Destructor, defined in the Config module.
|
noexcept |
Destructor for Bash single-line comments.
|
noexcept |
Destructor for C single-line comments.
|
noexcept |
Destructor for C multi-line comments.
|
overridevirtual |
Clones the comment on Base's heap.
Implements StormByte::Safe::Clonable< Base, StormByte::Safe::Shared< Base > >.
|
inlineconstexprnoexcept |
Gets the comment syntax.
|
inlineconstexprnoexcept |
Converts comment syntax to its text representation.
|
virtualnoexcept |
Equality for C multi-line comments.
| other | The other item. |
Implements StormByte::Config::Item::Base.
|
virtualnoexcept |
Equality for C single-line comments.
| other | The other item. |
Implements StormByte::Config::Item::Base.
|
virtualnoexcept |
Equality for Bash single-line comments.
| other | The other item. |
Implements StormByte::Config::Item::Base.
|
overridevirtualnoexcept |
Polymorphic equality comparison.
| other | The other item. |
Implements StormByte::Config::Item::Base.
|
overridevirtual |
Moves the comment to Base's heap.
Implements StormByte::Safe::Clonable< Base, StormByte::Safe::Shared< Base > >.
|
noexcept |
| Comment & StormByte::Config::Item::Comment< T >::operator= | ( | const Comment< T > & | comment | ) |
|
virtualnoexcept |
Serializes a C multi-line comment.
| indent_level | Indentation level. |
Reimplemented from StormByte::Config::Item::Base.
|
virtualnoexcept |
Serializes a C single-line comment.
| indent_level | Indentation level. |
Reimplemented from StormByte::Config::Item::Base.
|
virtualnoexcept |
Serializes a Bash single-line comment.
| indent_level | Indentation level. |
Reimplemented from StormByte::Config::Item::Base.
|
overridevirtualnoexcept |
Serializes the comment item.
| indent_level | Indentation level. |
Reimplemented from StormByte::Config::Item::Base.
|
inlinenoexcept |
Gets const comment text.
|
inlinenoexcept |
Gets mutable comment text.
|
inlineconstexproverridevirtualnoexcept |
|
staticconstexpr |
Identifies this as a comment item.