SourcePP
Several modern C++20 libraries for sanely parsing Valve's formats.
Loading...
Searching...
No Matches
kvpp::KV1Writer< S > Class Template Reference

#include <KV1.h>

Inheritance diagram for kvpp::KV1Writer< S >:
Collaboration diagram for kvpp::KV1Writer< S >:

Public Member Functions

 KV1Writer (std::string_view kv1Data="", bool useEscapeSequences_=false)
 
std::string bake ()
 
void bake (const std::string &kv1Path)
 
- Public Member Functions inherited from kvpp::KV1ElementWritable< S >
void setKey (std::string_view key_)
 Set the key associated with the element.
 
template<KV1ValueType V>
void setValue (V value_)
 Set the value associated with the element.
 
template<KV1ValueType V>
KV1ElementWritableoperator= (V value_)
 Set the value associated with the element.
 
void setConditional (std::string_view conditional_)
 Set the conditional associated with the element.
 
template<KV1ValueType V = std::string_view>
KV1ElementWritableaddChild (std::string_view key_, V value_={}, std::string_view conditional_="")
 
KV1ElementWritableoperator[] (unsigned int n)
 Get the child element of the element at the given index.
 
KV1ElementWritableoperator[] (std::string_view childKey)
 Get the first child element of the element with the given key, or create a new element if it doesn't exist.
 
KV1ElementWritableoperator() (std::string_view childKey)
 Get the first child element of the element with the given key, or create a new element if it doesn't exist.
 
KV1ElementWritableoperator() (std::string_view childKey, unsigned int n)
 Get the nth child element of the element with the given key, or create a new element if it doesn't exist.
 
void removeChild (std::string_view childKey, int n=-1)
 Remove a child element from the element. -1 means all children with the given key.
 
- 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>
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.
 
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

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

Additional Inherited Members

- Protected Member Functions inherited from kvpp::KV1ElementWritable< S >
 KV1ElementWritable ()=default
 
- Protected Member Functions inherited from kvpp::KV1ElementBase< S, K >
 KV1ElementBase ()=default
 
- Static Protected Member Functions inherited from kvpp::KV1ElementWritable< S >
static void write (BufferStream &stream, std::vector< KV1ElementWritable > &elements, unsigned short indentLevel, const sourcepp::parser::text::EscapeSequenceMap &escapeSequences)
 
- Static Protected Member Functions inherited from kvpp::KV1ElementBase< S, K >
static const KV1ElementBasegetInvalid ()
 
static void read (BufferStreamReadOnly &stream, BufferStream &backing, std::vector< K > &elements, const sourcepp::parser::text::EscapeSequenceMap &escapeSequences)
 

Detailed Description

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

Definition at line 338 of file KV1.h.

Constructor & Destructor Documentation

◆ KV1Writer()

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

Definition at line 340 of file KV1.h.

Member Function Documentation

◆ bake() [1/2]

template<typename S = std::string>
std::string kvpp::KV1Writer< S >::bake ( )
inline

Definition at line 357 of file KV1.h.

◆ bake() [2/2]

template<typename S = std::string>
void kvpp::KV1Writer< S >::bake ( const std::string &  kv1Path)
inline

Definition at line 365 of file KV1.h.

Member Data Documentation

◆ useEscapeSequences

template<typename S = std::string>
bool kvpp::KV1Writer< S >::useEscapeSequences
protected

Definition at line 377 of file KV1.h.


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