RigsofRods
Soft-body Physics Simulation
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
GenericDocContextClass.h
Go to the documentation of this file.
1 namespace Script2Game {
2 
12 {
21 };
22 
27 {
28  // PLEASE maintain the same order as in 'GenericFileFormat.h' and 'GenericFileFormatAngelscript.cpp'
29 
31 
32  bool moveNext();
33  uint getPos();
34  bool seekNextLine();
35  int countLineArgs();
36  bool endOfFile(int offset = 0);
37  TokenType tokenType(int offset = 0);
38 
39  string getTokString(int offset = 0);
40  float getTokFloat(int offset = 0);
41  float getTokInt(int offset = 0);
42  bool gettokBool(int offset = 0);
43  string getTokKeyword(int offset = 0);
44  string getTokComment(int offset = 0);
45 
46  bool isTokString(int offset = 0);
47  bool isTokFloat(int offset = 0);
48  bool isTokInt(int offset = 0);
49  bool isTokBool(int offset = 0);
50  bool isTokKeyword(int offset = 0);
51  bool isTokComment(int offset = 0);
52  bool isTokLineBreak(int offset = 0);
53 
54  // Editing functions:
55 
56  void appendTokens(int count);
57  bool insertToken(int offset = 0);
58  bool eraseToken(int offset = 0);
59 
60  void appendTokString(const string&in str);
61  void appendTokFloat(float val);
62  void appendTokInt(float val);
63  void appendTokBool(bool val);
64  void appendTokKeyword(const string&in str);
65  void appendTokComment(const string&in str);
66  void appendTokLineBreak();
67 
68  bool setTokString(int offset, const string&in str);
69  bool setTokFloat(int offset, float val);
70  bool setTokInt(int offset, int val);
71  bool setTokBool(int offset, bool val);
72  bool setTokKeyword(int offset, const string&in str);
73  bool setTokComment(int offset, const string&in str);
74  bool setTokLineBreak(int offset);
75 };
76 
79 
80 } //namespace Script2Game
Script2Game::GenericDocContextClass::appendTokBool
void appendTokBool(bool val)
Script2Game::TOKEN_TYPE_NONE
@ TOKEN_TYPE_NONE
Definition: GenericDocContextClass.h:13
Script2Game::GenericDocContextClass::setTokBool
bool setTokBool(int offset, bool val)
Script2Game::GenericDocContextClass::setTokInt
bool setTokInt(int offset, int val)
RoR::GenericDocumentPtr
RefCountingObjectPtr< GenericDocument > GenericDocumentPtr
Definition: ForwardDeclarations.h:231
Script2Game::GenericDocContextClass::isTokLineBreak
bool isTokLineBreak(int offset=0)
Script2Game::GenericDocContextClass::isTokFloat
bool isTokFloat(int offset=0)
Script2Game::TOKEN_TYPE_BOOL
@ TOKEN_TYPE_BOOL
Definition: GenericDocContextClass.h:19
Script2Game::GenericDocContextClass::appendTokInt
void appendTokInt(float val)
Script2Game
Pseudo-namespace; it doesn't exist in code or script runtime, only in this documentation.
Definition: BeamClass.h:2
Script2Game::GenericDocContextClass::setTokLineBreak
bool setTokLineBreak(int offset)
Script2Game::GenericDocContextClass::moveNext
bool moveNext()
Script2Game::GenericDocContextClass
Binding of RoR::GenericDocContext; Traverses document tokens; See 'demo_script.as' for an example.
Definition: GenericDocContextClass.h:26
Script2Game::GenericDocContextClass::isTokComment
bool isTokComment(int offset=0)
Script2Game::GenericDocContextClass::setTokComment
bool setTokComment(int offset, const string &in str)
Script2Game::GenericDocContextClass::gettokBool
bool gettokBool(int offset=0)
Script2Game::GenericDocContextClass::getTokComment
string getTokComment(int offset=0)
Script2Game::TOKEN_TYPE_STRING
@ TOKEN_TYPE_STRING
Definition: GenericDocContextClass.h:16
Script2Game::GenericDocContextClass::insertToken
bool insertToken(int offset=0)
Inserts TokenType::NONE;.
Script2Game::GenericDocContextClass::getTokFloat
float getTokFloat(int offset=0)
Script2Game::TOKEN_TYPE_LINEBREAK
@ TOKEN_TYPE_LINEBREAK
Definition: GenericDocContextClass.h:14
Script2Game::TOKEN_TYPE_COMMENT
@ TOKEN_TYPE_COMMENT
Definition: GenericDocContextClass.h:15
Script2Game::GenericDocContextClass::setTokString
bool setTokString(int offset, const string &in str)
Script2Game::GenericDocContextClass::isTokInt
bool isTokInt(int offset=0)
Script2Game::GenericDocContextClass::eraseToken
bool eraseToken(int offset=0)
Script2Game::GenericDocContextClass::tokenType
TokenType tokenType(int offset=0)
Script2Game::GenericDocContextClass::appendTokens
void appendTokens(int count)
Appends a series of TokenType::NONE and sets Pos at the first one added; use setTok* functions to fil...
Script2Game::GenericDocContextClass::seekNextLine
bool seekNextLine()
Script2Game::GenericDocContextClass::appendTokComment
void appendTokComment(const string &in str)
Script2Game::GenericDocContextClass::isTokBool
bool isTokBool(int offset=0)
Script2Game::GenericDocContextClass::appendTokFloat
void appendTokFloat(float val)
Script2Game::GenericDocContextClass::appendTokLineBreak
void appendTokLineBreak()
Script2Game::TOKEN_TYPE_KEYWORD
@ TOKEN_TYPE_KEYWORD
Definition: GenericDocContextClass.h:20
Script2Game::TokenType
TokenType
Definition: GenericDocContextClass.h:11
Script2Game::GenericDocContextClass::endOfFile
bool endOfFile(int offset=0)
Script2Game::GenericDocContextClass::appendTokKeyword
void appendTokKeyword(const string &in str)
Script2Game::GenericDocContextClass::isTokString
bool isTokString(int offset=0)
Script2Game::GenericDocContextClass::getTokKeyword
string getTokKeyword(int offset=0)
Script2Game::GenericDocContextClass::appendTokString
void appendTokString(const string &in str)
Script2Game::TOKEN_TYPE_FLOAT
@ TOKEN_TYPE_FLOAT
Definition: GenericDocContextClass.h:17
Script2Game::TOKEN_TYPE_INT
@ TOKEN_TYPE_INT
Definition: GenericDocContextClass.h:18
Script2Game::GenericDocContextClass::isTokKeyword
bool isTokKeyword(int offset=0)
Script2Game::GenericDocContextClass::getTokString
string getTokString(int offset=0)
Script2Game::GenericDocContextClass::setTokFloat
bool setTokFloat(int offset, float val)
Script2Game::GenericDocContextClass::setTokKeyword
bool setTokKeyword(int offset, const string &in str)
Script2Game::GenericDocContextClass::getPos
uint getPos()
Script2Game::GenericDocContextClass::countLineArgs
int countLineArgs()
Script2Game::GenericDocContextClass::GenericDocContext
GenericDocContext(GenericDocumentPtr@ d)
Script2Game::GenericDocContextClass::getTokInt
float getTokInt(int offset=0)