SourcePP
Several modern C++20 libraries for sanely parsing Valve's formats.
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
kvpp::KV1< S > Class Template Reference

#include <KV1.h>

Inheritance diagram for kvpp::KV1< S >:
Inheritance graph
[legend]
Collaboration diagram for kvpp::KV1< S >:
Collaboration graph
[legend]

Public Member Functions

 KV1 (std::string_view kv1Data, bool useEscapeSequences_=false)
 
- Public Member Functions inherited from kvpp::KV1ElementBase< S, K >
std::string_view getKey () const
 Get the key associated with the element.
 
std::string_view getValue () const
 Get the value associated with the element.
 
template<KV1ValueType V>
V getValue () const
 Get the value associated with the element as the given type.
 
std::string_view getConditional () const
 Get the conditional associated with the element.
 
bool hasChild (std::string_view childKey) const
 Check if the element has one or more children with the given name.
 
uint64_t getChildCount () const
 Get the number of child elements.
 
uint64_t getChildCount (std::string_view childKey) const
 Get the number of child elements with the given key.
 
const std::vector< K > & getChildren () const
 Get the child elements of the element.
 
constexpr iterator begin ()
 
constexpr iterator end ()
 
constexpr const_iterator begin () const
 
constexpr const_iterator end () const
 
constexpr const_iterator cbegin () const
 
constexpr const_iterator cend () const
 
const KV1ElementBase & operator[] (unsigned int n) const
 Get the child element of the element at the given index.
 
const KV1ElementBase & operator[] (std::string_view childKey) const
 Get the first child element of the element with the given key.
 
const KV1ElementBase & operator() (std::string_view childKey) const
 Get the first child element of the element with the given key.
 
const KV1ElementBase & operator() (std::string_view childKey, unsigned int n) const
 Get the nth child element of the element with the given key.
 
bool isInvalid () const
 Check if the given element is invalid.
 

Protected Attributes

std::string backingData
 
bool useEscapeSequences
 
- Protected Attributes inherited from kvpp::KV1ElementBase< S, K >
S key = ""
 
S value = ""
 
S conditional = ""
 
std::vector< K > children
 

Additional Inherited Members

- Public Types inherited from kvpp::KV1ElementBase< S, K >
using iterator = typename std::vector< K >::iterator
 
using const_iterator = typename std::vector< K >::const_iterator
 
- Static Public Member Functions inherited from kvpp::KV1ElementBase< S, K >
static const KV1ElementBase & getInvalid ()
 
- Protected Member Functions inherited from kvpp::KV1ElementReadable< S >
 KV1ElementReadable ()=default
 
- Protected Member Functions inherited from kvpp::KV1ElementBase< S, K >
 KV1ElementBase ()=default
 
- Static Protected Member Functions inherited from kvpp::KV1ElementBase< S, K >
static void read (BufferStreamReadOnly &stream, BufferStream &backing, std::vector< K > &elements, const sourcepp::parser::text::EscapeSequenceMap &escapeSequences)
 

Detailed Description

template<typename S = std::string_view>
requires std::convertible_to<S, std::string_view>
class kvpp::KV1< S >

Definition at line 221 of file KV1.h.

Constructor & Destructor Documentation

◆ KV1()

template<typename S = std::string_view>
kvpp::KV1< S >::KV1 ( std::string_view  kv1Data,
bool  useEscapeSequences_ = false 
)
inlineexplicit

Definition at line 223 of file KV1.h.

Member Data Documentation

◆ backingData

template<typename S = std::string_view>
std::string kvpp::KV1< S >::backingData
protected

Definition at line 244 of file KV1.h.

◆ useEscapeSequences

template<typename S = std::string_view>
bool kvpp::KV1< S >::useEscapeSequences
protected

Definition at line 245 of file KV1.h.

The documentation for this class was generated from the following file: