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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
//===-- ResourceScriptParser.h ----------------------------------*- C++-*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===---------------------------------------------------------------------===//
//
// This defines the RC scripts parser. It takes a sequence of RC tokens
// and then provides the method to parse the resources one by one.
//
//===---------------------------------------------------------------------===//
#ifndef LLVM_TOOLS_LLVMRC_RESOURCESCRIPTPARSER_H
#define LLVM_TOOLS_LLVMRC_RESOURCESCRIPTPARSER_H
#include "ResourceScriptStmt.h"
#include "ResourceScriptToken.h"
#include "llvm/Support/Compiler.h"
#include "llvm/Support/raw_ostream.h"
#include <system_error>
#include <vector>
namespace llvm {
namespace rc {
class RCParser {
public:
using LocIter = std::vector<RCToken>::iterator;
using ParseType = Expected<std::unique_ptr<RCResource>>;
using ParseOptionType = Expected<std::unique_ptr<OptionalStmt>>;
// Class describing a single failure of parser.
class ParserError : public ErrorInfo<ParserError> {
public:
ParserError(const Twine &Expected, const LocIter CurLoc, const LocIter End);
void log(raw_ostream &OS) const override { OS << CurMessage; }
std::error_code convertToErrorCode() const override {
return std::make_error_code(std::errc::invalid_argument);
}
const std::string &getMessage() const { return CurMessage; }
static char ID; // Keep llvm::Error happy.
private:
std::string CurMessage;
LocIter ErrorLoc, FileEnd;
};
explicit RCParser(std::vector<RCToken> TokenList);
// Reads and returns a single resource definition, or error message if any
// occurred.
ParseType parseSingleResource();
bool isEof() const;
private:
using Kind = RCToken::Kind;
// Checks if the current parser state points to the token of type TokenKind.
bool isNextTokenKind(Kind TokenKind) const;
// These methods assume that the parser is not in EOF state.
// Take a look at the current token. Do not fetch it.
const RCToken &look() const;
// Read the current token and advance the state by one token.
const RCToken &read();
// Advance the state by one token, discarding the current token.
void consume();
// The following methods try to read a single token, check if it has the
// correct type and then parse it.
// Each integer can be written as an arithmetic expression producing an
// unsigned 32-bit integer.
Expected<RCInt> readInt(); // Parse an integer.
Expected<StringRef> readString(); // Parse a string.
Expected<StringRef> readIdentifier(); // Parse an identifier.
Expected<StringRef> readFilename(); // Parse a filename.
Expected<IntOrString> readIntOrString(); // Parse an integer or a string.
Expected<IntOrString> readTypeOrName(); // Parse an integer or an identifier.
// Helper integer expression parsing methods.
Expected<IntWithNotMask> parseIntExpr1();
Expected<IntWithNotMask> parseIntExpr2();
// Advance the state by one, discarding the current token.
// If the discarded token had an incorrect type, fail.
Error consumeType(Kind TokenKind);
// Check the current token type. If it's TokenKind, discard it.
// Return true if the parser consumed this token successfully.
bool consumeOptionalType(Kind TokenKind);
// Read at least MinCount, and at most MaxCount integers separated by
// commas. The parser stops reading after fetching MaxCount integers
// or after an error occurs. Whenever the parser reads a comma, it
// expects an integer to follow.
Expected<SmallVector<RCInt, 8>> readIntsWithCommas(size_t MinCount,
size_t MaxCount);
// Read an unknown number of flags preceded by commas. Each correct flag
// has an entry in FlagDesc array of length NumFlags. In case i-th
// flag (0-based) has been read, the result is OR-ed with FlagValues[i].
// As long as parser has a comma to read, it expects to be fed with
// a correct flag afterwards.
Expected<uint32_t> parseFlags(ArrayRef<StringRef> FlagDesc,
ArrayRef<uint32_t> FlagValues);
// Reads a set of optional statements. These can change the behavior of
// a number of resource types (e.g. STRINGTABLE, MENU or DIALOG) if provided
// before the main block with the contents of the resource.
// Usually, resources use a basic set of optional statements:
// CHARACTERISTICS, LANGUAGE, VERSION
// However, DIALOG and DIALOGEX extend this list by the following items:
// CAPTION, CLASS, EXSTYLE, FONT, MENU, STYLE
// UseExtendedStatements flag (off by default) allows the parser to read
// the additional types of statements.
//
// Ref (to the list of all optional statements):
// msdn.microsoft.com/en-us/library/windows/desktop/aa381002(v=vs.85).aspx
enum class OptStmtType { BasicStmt, DialogStmt, DialogExStmt };
uint16_t parseMemoryFlags(uint16_t DefaultFlags);
Expected<OptionalStmtList>
parseOptionalStatements(OptStmtType StmtsType = OptStmtType::BasicStmt);
// Read a single optional statement.
Expected<std::unique_ptr<OptionalStmt>>
parseSingleOptionalStatement(OptStmtType StmtsType = OptStmtType::BasicStmt);
// Top-level resource parsers.
ParseType parseLanguageResource();
ParseType parseAcceleratorsResource();
ParseType parseBitmapResource();
ParseType parseCursorResource();
ParseType parseDialogResource(bool IsExtended);
ParseType parseIconResource();
ParseType parseHTMLResource();
ParseType parseMenuResource();
ParseType parseStringTableResource();
ParseType parseUserDefinedResource(IntOrString Type);
ParseType parseVersionInfoResource();
// Helper DIALOG parser - a single control.
Expected<Control> parseControl();
// Helper MENU parser.
Expected<MenuDefinitionList> parseMenuItemsList();
// Helper VERSIONINFO parser - read the contents of a single BLOCK statement,
// from BEGIN to END.
Expected<std::unique_ptr<VersionInfoBlock>>
parseVersionInfoBlockContents(StringRef BlockName);
// Helper VERSIONINFO parser - read either VALUE or BLOCK statement.
Expected<std::unique_ptr<VersionInfoStmt>> parseVersionInfoStmt();
// Helper VERSIONINFO parser - read fixed VERSIONINFO statements.
Expected<VersionInfoResource::VersionInfoFixed> parseVersionInfoFixed();
// Optional statement parsers.
ParseOptionType parseLanguageStmt();
ParseOptionType parseCharacteristicsStmt();
ParseOptionType parseVersionStmt();
ParseOptionType parseCaptionStmt();
ParseOptionType parseClassStmt();
ParseOptionType parseExStyleStmt();
ParseOptionType parseFontStmt(OptStmtType DialogType);
ParseOptionType parseStyleStmt();
// Raises an error. If IsAlreadyRead = false (default), this complains about
// the token that couldn't be parsed. If the flag is on, this complains about
// the correctly read token that makes no sense (that is, the current parser
// state is beyond the erroneous token.)
Error getExpectedError(const Twine &Message, bool IsAlreadyRead = false);
std::vector<RCToken> Tokens;
LocIter CurLoc;
const LocIter End;
};
} // namespace rc
} // namespace llvm
#endif
|
