/
hexlex.h
100 lines (85 loc) · 3.09 KB
/
hexlex.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/** @file hexlex.h Lexical analyzer for Hexen definition/script syntax.
*
* @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
* @authors Copyright © 2007-2014 Daniel Swanson <danij@dengine.net>
* @authors Copyright © 1999 Activision
*
* @par License
* GPL: http://www.gnu.org/licenses/gpl.html
*
* <small>This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. This program is distributed in the hope that it
* will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
* Public License for more details. You should have received a copy of the GNU
* General Public License along with this program; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA</small>
*/
#ifndef IDTECH1CONVERTER_HEXLEX_H
#define IDTECH1CONVERTER_HEXLEX_H
#include "idtech1converter.h"
namespace idtech1 {
/**
* Lexical analyzer for Hexen definition/script syntax.
*
* @ingroup idtech1converter
*/
class HexLex
{
public:
/// Base error for syntax errors at the level of lexical analysis (e.g.,
/// a non-terminated string constant). @ingroup errors
DENG2_ERROR(SyntaxError);
public:
/**
* Construct a new lexer and optionally prepare a script for parsing.
*
* @param script If non-zero, prepare this script for parsing.
* @param sourcePath If non-zero, set this as the script source path.
*
* @see parse(), setSourcePath()
*/
explicit HexLex(Str const *script = nullptr, de::String const &sourcePath = "");
/**
* Prepare a new script for parsing. It is assumed that the @a script data
* remains available until parsing is completed (or the script is replaced).
*
* @param script The script source to be parsed.
*/
void parse(Str const *script);
/**
* Change the source path used to identify the script in log messages.
*
* @param sourcePath New source path to apply. A copy is made.
*/
void setSourcePath(de::String const &sourcePath);
/**
* Attempt to read the next token from the script. @c true is returned if a
* token was parsed (or the previously parsed token was @em unread); otherwise
* @c false is returned (e.g., the end of the script was reached).
*/
bool readToken();
/**
* Mark the last read token as @em unread, so that it will be re-read as the
* next read token.
*/
void unreadToken();
/**
* Returns a copy of the last read token.
*/
Str const *token();
de::ddouble readNumber();
Str const *readString();
de::Uri readUri(de::String const &defaultScheme = "");
/**
* Returns the line number at the current position in the script.
*/
int lineNumber() const;
private:
DENG2_PRIVATE(d)
};
} // namespace idtech1
#endif // IDTECH1CONVERTER_HEXLEX_H