Base class for VLX parsers. More...
#include <Parser.hpp>
Inheritance diagram for vlX::Parser:
Public Member Functions | |
| virtual bool | parseHeader ()=0 |
| virtual bool | parse ()=0 |
| bool | link () |
| Links the. More... | |
| void | parseMetadata () |
| Moves the <Metadata> key/value pairs in the Metadata map for quick and easy access and removes the <Metadata> structure. More... | |
| std::vector< vl::ref< VLXStructure > > & | structures () |
| The imported structures. More... | |
| const std::vector< vl::ref< VLXStructure > > & | structures () const |
| The imported structures. More... | |
| const std::map< std::string, VLXValue > & | metadata () const |
| The imported metadata. More... | |
| const std::string & | encoding () const |
| The encoding used to encode strings. More... | |
| unsigned short | version () const |
| The VLX language version. More... | |
| Public Member Functions inherited from vl::Object | |
| Object () | |
| Constructor. More... | |
| Object (const Object &other) | |
| Copy constructor: copies the name, ref count mutex and user data. More... | |
| Object & | operator= (const Object &other) |
| Copy operator: copies the object's name, ref count mutex and user data. More... | |
| const std::string & | objectName () const |
| The name of the object, by default set to the object's class name. More... | |
| void | setObjectName (const char *name) |
| The name of the object, by default set to the object's class name in debug builds. More... | |
| void | setObjectName (const std::string &name) |
| The name of the object, by default set to the object's class name in debug builds. More... | |
| void | setRefCountMutex (IMutex *mutex) |
| The mutex used to protect the reference counting of an Object across multiple threads. More... | |
| IMutex * | refCountMutex () |
| The mutex used to protect the reference counting of an Object across multiple threads. More... | |
| const IMutex * | refCountMutex () const |
| The mutex used to protect the reference counting of an Object across multiple threads. More... | |
| int | referenceCount () const |
| Returns the number of references of an object. More... | |
| void | incReference () const |
| Increments the reference count of an object. More... | |
| void | decReference () |
Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More... | |
| void | setAutomaticDelete (bool autodel_on) |
| If set to true the Object is deleted when its reference count reaches 0. More... | |
| bool | automaticDelete () const |
| If set to true the Object is deleted when its reference count reaches 0. More... | |
| template<class T > | |
| T * | as () |
| Casts an Object to the specified class. More... | |
| template<class T > | |
| const T * | as () const |
| Casts an Object to the specified class. More... | |
Protected Attributes | |
| std::string | mEncoding |
| unsigned short | mVersion |
| std::vector< vl::ref< VLXStructure > > | mStructures |
| std::map< std::string, VLXValue > | mMetadata |
| Protected Attributes inherited from vl::Object | |
| std::string | mObjectName |
| IMutex * | mRefCountMutex |
| int | mReferenceCount |
| bool | mAutomaticDelete |
Additional Inherited Members | |
| Protected Member Functions inherited from vl::Object | |
| virtual | ~Object () |
Detailed Description
Base class for VLX parsers.
Definition at line 41 of file Parser.hpp.
Member Function Documentation
◆ encoding()
|
inline |
The encoding used to encode strings.
Definition at line 91 of file Parser.hpp.
References mEncoding.
◆ link()
|
inline |
Links the.
Definition at line 52 of file Parser.hpp.
References vlX::Linker::add(), vlX::Linker::link(), and mStructures.
◆ metadata()
|
inline |
◆ parse()
|
pure virtual |
Implemented in vlX::ParserVLB, and vlX::ParserVLT.
◆ parseHeader()
|
pure virtual |
Implemented in vlX::ParserVLT, and vlX::ParserVLB.
◆ parseMetadata()
|
inline |
Moves the <Metadata> key/value pairs in the Metadata map for quick and easy access and removes the <Metadata> structure.
Definition at line 63 of file Parser.hpp.
References mMetadata, mStructures, and vlX::VLXStructure::value().
Referenced by vlX::ParserVLT::parse(), and vlX::ParserVLB::parse().
◆ structures() [1/2]
|
inline |
◆ structures() [2/2]
|
inline |
◆ version()
|
inline |
Member Data Documentation
◆ mEncoding
|
protected |
Definition at line 97 of file Parser.hpp.
Referenced by encoding(), vlX::ParserVLT::parse(), vlX::ParserVLB::parse(), vlX::ParserVLB::parseHeader(), and vlX::ParserVLT::parseHeader().
◆ mMetadata
|
protected |
Definition at line 100 of file Parser.hpp.
Referenced by metadata(), vlX::ParserVLT::parse(), vlX::ParserVLB::parse(), and parseMetadata().
◆ mStructures
|
protected |
Definition at line 99 of file Parser.hpp.
Referenced by link(), vlX::ParserVLT::parse(), vlX::ParserVLB::parse(), parseMetadata(), and structures().
◆ mVersion
|
protected |
Definition at line 98 of file Parser.hpp.
Referenced by vlX::ParserVLT::parse(), vlX::ParserVLB::parse(), vlX::ParserVLB::parseHeader(), vlX::ParserVLT::parseHeader(), vlX::ParserVLB::ParserVLB(), vlX::ParserVLT::ParserVLT(), and version().
The documentation for this class was generated from the following file:
- C:/git/VL/src/vlX/Parser.hpp