SourcePP
Several modern C++20 libraries for sanely parsing Valve's formats.
Loading...
Searching...
No Matches
kvpp::KV1 Class Reference

#include <KV1.h>

Inheritance diagram for kvpp::KV1:
Collaboration diagram for kvpp::KV1:

Public Member Functions

 KV1 (std::string_view kv1Data, bool useEscapeSequences_=false)
 
- Public Member Functions inherited from kvpp::KV1ElementBase< std::string_view, KV1ElementReadable >
std::string_view getKey () const
 Get the key associated with the element.
 
std::string_view getValue () const
 Get the value associated with the element.
 
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< KV1ElementReadable > & getChildren () const
 Get the child elements of the element.
 
const KV1ElementBaseoperator[] (unsigned int n) const
 Get the child element of the element at the given index.
 
const KV1ElementBaseoperator[] (std::string_view childKey) const
 Get the first child element of the element with the given key.
 
const KV1ElementBaseoperator() (std::string_view childKey) const
 Get the first child element of the element with the given key.
 
const KV1ElementBaseoperator() (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< std::string_view, KV1ElementReadable >
std::string_view key
 
std::string_view value
 
std::string_view conditional
 
std::vector< KV1ElementReadablechildren
 

Additional Inherited Members

- Protected Member Functions inherited from kvpp::KV1ElementReadable
 KV1ElementReadable ()=default
 
- Protected Member Functions inherited from kvpp::KV1ElementBase< std::string_view, KV1ElementReadable >
 KV1ElementBase ()=default
 
- Static Protected Member Functions inherited from kvpp::KV1ElementBase< std::string_view, KV1ElementReadable >
static const KV1ElementBasegetInvalid ()
 
static void read (BufferStreamReadOnly &stream, BufferStream &backing, std::vector< KV1ElementReadable > &elements, const sourcepp::parser::text::EscapeSequenceMap &escapeSequences)
 

Detailed Description

Definition at line 189 of file KV1.h.

Constructor & Destructor Documentation

◆ KV1()

KV1::KV1 ( std::string_view  kv1Data,
bool  useEscapeSequences_ = false 
)
explicit

Definition at line 6 of file KV1.cpp.

Member Data Documentation

◆ backingData

std::string kvpp::KV1::backingData
protected

Definition at line 198 of file KV1.h.

◆ useEscapeSequences

bool kvpp::KV1::useEscapeSequences
protected

Definition at line 199 of file KV1.h.


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