RigsofRods  2023.09
Soft-body Physics Simulation
•All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Data Fields
RoR::GenericDocContext Struct Reference

#include <GenericFileFormat.h>

+ Inheritance diagram for RoR::GenericDocContext:

Public Member Functions

 GenericDocContext (GenericDocumentPtr d)
 
virtual ~GenericDocContext ()
 
bool moveNext ()
 
uint32_t getPos () const
 
bool seekNextLine ()
 
int countLineArgs ()
 
bool endOfFile (int offset=0) const
 
TokenType tokenType (int offset=0) const
 
std::string getTokString (int offset=0) const
 
float getTokFloat (int offset=0) const
 
int getTokInt (int offset=0) const
 
float getTokNumeric (int offset=0) const
 
bool getTokBool (int offset=0) const
 
std::string getTokKeyword (int offset=0) const
 
std::string getTokComment (int offset=0) const
 
bool isTokString (int offset=0) const
 
bool isTokFloat (int offset=0) const
 
bool isTokInt (int offset=0) const
 
bool isTokBool (int offset=0) const
 
bool isTokKeyword (int offset=0) const
 
bool isTokComment (int offset=0) const
 
bool isTokLineBreak (int offset=0) const
 
bool isTokNumeric (int offset=0) const
 
void appendTokens (int count)
 Appends a series of TokenType::NONE and sets Pos at the first one added; use setTok* functions to fill them. More...
 
bool insertToken (int offset=0)
 Inserts TokenType::NONE;. More...
 
bool eraseToken (int offset=0)
 
void appendTokString (const std::string &str)
 
void appendTokFloat (float val)
 
void appendTokInt (int val)
 
void appendTokBool (bool val)
 
void appendTokKeyword (const std::string &str)
 
void appendTokComment (const std::string &str)
 
void appendTokLineBreak ()
 
bool setTokString (int offset, const std::string &str)
 
bool setTokFloat (int offset, float val)
 
bool setTokInt (int offset, int val)
 
bool setTokBool (int offset, bool val)
 
bool setTokKeyword (int offset, const std::string &str)
 
bool setTokComment (int offset, const std::string &str)
 
bool setTokLineBreak (int offset)
 
const char * getStringData (int offset=0) const
 
float getFloatData (int offset=0) const
 
bool setStringData (int offset, TokenType type, const std::string &data)
 
bool setFloatData (int offset, TokenType type, float data)
 
- Public Member Functions inherited from RefCountingObject< GenericDocContext >
 RefCountingObject ()
 
virtual ~RefCountingObject ()
 
void AddRef ()
 
void Release ()
 

Data Fields

GenericDocumentPtr doc
 
uint32_t token_pos = 0
 
- Data Fields inherited from RefCountingObject< GenericDocContext >
int m_refcount
 
std::mutex m_refcount_mtx
 

Additional Inherited Members

- Static Public Member Functions inherited from RefCountingObject< GenericDocContext >
static void RegisterRefCountingObject (AS_NAMESPACE_QUALIFIER asIScriptEngine *engine, const char *name)
 

Detailed Description

Definition at line 89 of file GenericFileFormat.h.

Constructor & Destructor Documentation

◆ GenericDocContext()

RoR::GenericDocContext::GenericDocContext ( GenericDocumentPtr  d)
inline

Definition at line 91 of file GenericFileFormat.h.

◆ ~GenericDocContext()

virtual RoR::GenericDocContext::~GenericDocContext ( )
inlinevirtual

Definition at line 99 of file GenericFileFormat.h.

Member Function Documentation

◆ appendTokBool()

void RoR::GenericDocContext::appendTokBool ( bool  val)
inline

Definition at line 139 of file GenericFileFormat.h.

◆ appendTokComment()

void RoR::GenericDocContext::appendTokComment ( const std::string &  str)
inline

Definition at line 141 of file GenericFileFormat.h.

◆ appendTokens()

void GenericDocContext::appendTokens ( int  count)

Appends a series of TokenType::NONE and sets Pos at the first one added; use setTok* functions to fill them.

Definition at line 1158 of file GenericFileFormat.cpp.

◆ appendTokFloat()

void RoR::GenericDocContext::appendTokFloat ( float  val)
inline

Definition at line 137 of file GenericFileFormat.h.

◆ appendTokInt()

void RoR::GenericDocContext::appendTokInt ( int  val)
inline

Definition at line 138 of file GenericFileFormat.h.

◆ appendTokKeyword()

void RoR::GenericDocContext::appendTokKeyword ( const std::string &  str)
inline

Definition at line 140 of file GenericFileFormat.h.

◆ appendTokLineBreak()

void RoR::GenericDocContext::appendTokLineBreak ( )
inline

Definition at line 142 of file GenericFileFormat.h.

◆ appendTokString()

void RoR::GenericDocContext::appendTokString ( const std::string &  str)
inline

Definition at line 136 of file GenericFileFormat.h.

◆ countLineArgs()

int GenericDocContext::countLineArgs ( )

Definition at line 1147 of file GenericFileFormat.cpp.

◆ endOfFile()

bool RoR::GenericDocContext::endOfFile ( int  offset = 0) const
inline

Definition at line 110 of file GenericFileFormat.h.

◆ eraseToken()

bool GenericDocContext::eraseToken ( int  offset = 0)
Returns
false if offset is beyond EOF

Definition at line 1179 of file GenericFileFormat.cpp.

◆ getFloatData()

float RoR::GenericDocContext::getFloatData ( int  offset = 0) const
inline

Definition at line 155 of file GenericFileFormat.h.

◆ getPos()

uint32_t RoR::GenericDocContext::getPos ( ) const
inline

Definition at line 107 of file GenericFileFormat.h.

◆ getStringData()

const char* RoR::GenericDocContext::getStringData ( int  offset = 0) const
inline

Definition at line 154 of file GenericFileFormat.h.

◆ getTokBool()

bool RoR::GenericDocContext::getTokBool ( int  offset = 0) const
inline

Definition at line 117 of file GenericFileFormat.h.

◆ getTokComment()

std::string RoR::GenericDocContext::getTokComment ( int  offset = 0) const
inline

Definition at line 119 of file GenericFileFormat.h.

◆ getTokFloat()

float RoR::GenericDocContext::getTokFloat ( int  offset = 0) const
inline

Definition at line 114 of file GenericFileFormat.h.

◆ getTokInt()

int RoR::GenericDocContext::getTokInt ( int  offset = 0) const
inline

Definition at line 115 of file GenericFileFormat.h.

◆ getTokKeyword()

std::string RoR::GenericDocContext::getTokKeyword ( int  offset = 0) const
inline

Definition at line 118 of file GenericFileFormat.h.

◆ getTokNumeric()

float RoR::GenericDocContext::getTokNumeric ( int  offset = 0) const
inline

Definition at line 116 of file GenericFileFormat.h.

◆ getTokString()

std::string RoR::GenericDocContext::getTokString ( int  offset = 0) const
inline

Definition at line 113 of file GenericFileFormat.h.

◆ insertToken()

bool GenericDocContext::insertToken ( int  offset = 0)

Inserts TokenType::NONE;.

Returns
false if offset is beyond EOF

Definition at line 1170 of file GenericFileFormat.cpp.

◆ isTokBool()

bool RoR::GenericDocContext::isTokBool ( int  offset = 0) const
inline

Definition at line 124 of file GenericFileFormat.h.

◆ isTokComment()

bool RoR::GenericDocContext::isTokComment ( int  offset = 0) const
inline

Definition at line 126 of file GenericFileFormat.h.

◆ isTokFloat()

bool RoR::GenericDocContext::isTokFloat ( int  offset = 0) const
inline

Definition at line 122 of file GenericFileFormat.h.

◆ isTokInt()

bool RoR::GenericDocContext::isTokInt ( int  offset = 0) const
inline

Definition at line 123 of file GenericFileFormat.h.

◆ isTokKeyword()

bool RoR::GenericDocContext::isTokKeyword ( int  offset = 0) const
inline

Definition at line 125 of file GenericFileFormat.h.

◆ isTokLineBreak()

bool RoR::GenericDocContext::isTokLineBreak ( int  offset = 0) const
inline

Definition at line 127 of file GenericFileFormat.h.

◆ isTokNumeric()

bool RoR::GenericDocContext::isTokNumeric ( int  offset = 0) const
inline

Definition at line 128 of file GenericFileFormat.h.

◆ isTokString()

bool RoR::GenericDocContext::isTokString ( int  offset = 0) const
inline

Definition at line 121 of file GenericFileFormat.h.

◆ moveNext()

bool RoR::GenericDocContext::moveNext ( )
inline

Definition at line 106 of file GenericFileFormat.h.

◆ seekNextLine()

bool GenericDocContext::seekNextLine ( )

Definition at line 1129 of file GenericFileFormat.cpp.

◆ setFloatData()

bool GenericDocContext::setFloatData ( int  offset,
TokenType  type,
float  data 
)
Returns
false if offset is beyond EOF

Definition at line 1205 of file GenericFileFormat.cpp.

◆ setStringData()

bool GenericDocContext::setStringData ( int  offset,
TokenType  type,
const std::string &  data 
)
Returns
false if offset is beyond EOF

Definition at line 1191 of file GenericFileFormat.cpp.

◆ setTokBool()

bool RoR::GenericDocContext::setTokBool ( int  offset,
bool  val 
)
inline

Definition at line 147 of file GenericFileFormat.h.

◆ setTokComment()

bool RoR::GenericDocContext::setTokComment ( int  offset,
const std::string &  str 
)
inline

Definition at line 149 of file GenericFileFormat.h.

◆ setTokFloat()

bool RoR::GenericDocContext::setTokFloat ( int  offset,
float  val 
)
inline

Definition at line 145 of file GenericFileFormat.h.

◆ setTokInt()

bool RoR::GenericDocContext::setTokInt ( int  offset,
int  val 
)
inline

Definition at line 146 of file GenericFileFormat.h.

◆ setTokKeyword()

bool RoR::GenericDocContext::setTokKeyword ( int  offset,
const std::string &  str 
)
inline

Definition at line 148 of file GenericFileFormat.h.

◆ setTokLineBreak()

bool RoR::GenericDocContext::setTokLineBreak ( int  offset)
inline

Definition at line 150 of file GenericFileFormat.h.

◆ setTokString()

bool RoR::GenericDocContext::setTokString ( int  offset,
const std::string &  str 
)
inline

Definition at line 144 of file GenericFileFormat.h.

◆ tokenType()

TokenType RoR::GenericDocContext::tokenType ( int  offset = 0) const
inline

Definition at line 111 of file GenericFileFormat.h.

Field Documentation

◆ doc

GenericDocumentPtr RoR::GenericDocContext::doc

Definition at line 99 of file GenericFileFormat.h.

◆ token_pos

uint32_t RoR::GenericDocContext::token_pos = 0

Definition at line 102 of file GenericFileFormat.h.

The documentation for this struct was generated from the following files:
Generated by   doxygen 1.8.17