blob: 47f8745837ed051e993f3032db250275887b1c17 [file] [log] [blame]
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +00001//===-- ResourceScriptParser.cpp --------------------------------*- C++-*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===---------------------------------------------------------------------===//
9//
10// This implements the parser defined in ResourceScriptParser.h.
11//
12//===---------------------------------------------------------------------===//
13
14#include "ResourceScriptParser.h"
15
16// Take an expression returning llvm::Error and forward the error if it exists.
17#define RETURN_IF_ERROR(Expr) \
18 if (auto Err = (Expr)) \
19 return std::move(Err);
20
21// Take an expression returning llvm::Expected<T> and assign it to Var or
22// forward the error out of the function.
23#define ASSIGN_OR_RETURN(Var, Expr) \
24 auto Var = (Expr); \
25 if (!Var) \
26 return Var.takeError();
27
28namespace llvm {
29namespace rc {
30
31RCParser::ParserError::ParserError(const Twine Expected, const LocIter CurLoc,
32 const LocIter End)
33 : ErrorLoc(CurLoc), FileEnd(End) {
34 CurMessage = "Error parsing file: expected " + Expected.str() + ", got " +
35 (CurLoc == End ? "<EOF>" : CurLoc->value()).str();
36}
37
38char RCParser::ParserError::ID = 0;
39
40RCParser::RCParser(const std::vector<RCToken> &TokenList)
41 : Tokens(TokenList), CurLoc(Tokens.begin()), End(Tokens.end()) {}
42
43RCParser::RCParser(std::vector<RCToken> &&TokenList)
44 : Tokens(std::move(TokenList)), CurLoc(Tokens.begin()), End(Tokens.end()) {}
45
46bool RCParser::isEof() const { return CurLoc == End; }
47
48RCParser::ParseType RCParser::parseSingleResource() {
49 // The first thing we read is usually a resource's name. However, in some
50 // cases (LANGUAGE and STRINGTABLE) the resources don't have their names
51 // and the first token to be read is the type.
52 ASSIGN_OR_RETURN(NameToken, readTypeOrName());
53
54 if (NameToken->equalsLower("LANGUAGE"))
55 return parseLanguageResource();
56 else if (NameToken->equalsLower("STRINGTABLE"))
57 return parseStringTableResource();
58
59 // If it's not an unnamed resource, what we've just read is a name. Now,
60 // read resource type;
61 ASSIGN_OR_RETURN(TypeToken, readTypeOrName());
62
63 ParseType Result = std::unique_ptr<RCResource>();
64 (void)!Result;
65
Marek Sokolowski7f110522017-08-28 22:58:31 +000066 if (TypeToken->equalsLower("ACCELERATORS"))
67 Result = parseAcceleratorsResource();
68 else if (TypeToken->equalsLower("CURSOR"))
Marek Sokolowski72aa9372017-08-28 21:59:54 +000069 Result = parseCursorResource();
Marek Sokolowski4ac54d92017-08-29 16:49:59 +000070 else if (TypeToken->equalsLower("DIALOG"))
71 Result = parseDialogResource(false);
72 else if (TypeToken->equalsLower("DIALOGEX"))
73 Result = parseDialogResource(true);
Marek Sokolowski72aa9372017-08-28 21:59:54 +000074 else if (TypeToken->equalsLower("ICON"))
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +000075 Result = parseIconResource();
Marek Sokolowski72aa9372017-08-28 21:59:54 +000076 else if (TypeToken->equalsLower("HTML"))
77 Result = parseHTMLResource();
Marek Sokolowski99ecb0e2017-08-28 23:46:30 +000078 else if (TypeToken->equalsLower("MENU"))
79 Result = parseMenuResource();
Marek Sokolowskifb74cb12017-09-28 22:41:38 +000080 else if (TypeToken->equalsLower("VERSIONINFO"))
81 Result = parseVersionInfoResource();
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +000082 else
Marek Sokolowskib5f39a02017-09-29 00:14:18 +000083 Result = parseUserDefinedResource(*TypeToken);
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +000084
85 if (Result)
86 (*Result)->setName(*NameToken);
87
88 return Result;
89}
90
91bool RCParser::isNextTokenKind(Kind TokenKind) const {
92 return !isEof() && look().kind() == TokenKind;
93}
94
95const RCToken &RCParser::look() const {
96 assert(!isEof());
97 return *CurLoc;
98}
99
100const RCToken &RCParser::read() {
101 assert(!isEof());
102 return *CurLoc++;
103}
104
105void RCParser::consume() {
106 assert(!isEof());
107 CurLoc++;
108}
109
Marek Sokolowski7e89ee72017-09-28 23:53:25 +0000110// An integer description might consist of a single integer or
111// an arithmetic expression evaluating to the integer. The expressions
112// can contain the following tokens: <int> ( ) + - | & ~. Their meaning
113// is the same as in C++.
114// The operators in the original RC implementation have the following
115// precedence:
116// 1) Unary operators (- ~),
117// 2) Binary operators (+ - & |), with no precedence.
118//
119// The following grammar is used to parse the expressions Exp1:
120// Exp1 ::= Exp2 || Exp1 + Exp2 || Exp1 - Exp2 || Exp1 | Exp2 || Exp1 & Exp2
121// Exp2 ::= -Exp2 || ~Exp2 || Int || (Exp1).
122// (More conveniently, Exp1 is a non-empty sequence of Exp2 expressions,
123// separated by binary operators.)
124//
125// Expressions of type Exp1 are read by parseIntExpr1(Inner) method, while Exp2
126// is read by parseIntExpr2().
127//
128// The original Microsoft tool handles multiple unary operators incorrectly.
129// For example, in 16-bit little-endian integers:
130// 1 => 01 00, -1 => ff ff, --1 => ff ff, ---1 => 01 00;
131// 1 => 01 00, ~1 => fe ff, ~~1 => fd ff, ~~~1 => fc ff.
132// Our implementation differs from the original one and handles these
133// operators correctly:
134// 1 => 01 00, -1 => ff ff, --1 => 01 00, ---1 => ff ff;
135// 1 => 01 00, ~1 => fe ff, ~~1 => 01 00, ~~~1 => fe ff.
136
Zachary Turner07bc04f2017-10-06 21:26:06 +0000137Expected<RCInt> RCParser::readInt() { return parseIntExpr1(); }
Marek Sokolowski7e89ee72017-09-28 23:53:25 +0000138
Zachary Turner07bc04f2017-10-06 21:26:06 +0000139Expected<RCInt> RCParser::parseIntExpr1() {
Marek Sokolowski7e89ee72017-09-28 23:53:25 +0000140 // Exp1 ::= Exp2 || Exp1 + Exp2 || Exp1 - Exp2 || Exp1 | Exp2 || Exp1 & Exp2.
141 ASSIGN_OR_RETURN(FirstResult, parseIntExpr2());
Zachary Turner07bc04f2017-10-06 21:26:06 +0000142 RCInt Result = *FirstResult;
Marek Sokolowski7e89ee72017-09-28 23:53:25 +0000143
144 while (!isEof() && look().isBinaryOp()) {
145 auto OpToken = read();
146 ASSIGN_OR_RETURN(NextResult, parseIntExpr2());
147
148 switch (OpToken.kind()) {
149 case Kind::Plus:
150 Result += *NextResult;
151 break;
152
153 case Kind::Minus:
154 Result -= *NextResult;
155 break;
156
157 case Kind::Pipe:
158 Result |= *NextResult;
159 break;
160
161 case Kind::Amp:
162 Result &= *NextResult;
163 break;
164
165 default:
166 llvm_unreachable("Already processed all binary ops.");
167 }
168 }
169
170 return Result;
171}
172
Zachary Turner07bc04f2017-10-06 21:26:06 +0000173Expected<RCInt> RCParser::parseIntExpr2() {
Marek Sokolowski7e89ee72017-09-28 23:53:25 +0000174 // Exp2 ::= -Exp2 || ~Exp2 || Int || (Exp1).
175 static const char ErrorMsg[] = "'-', '~', integer or '('";
176
177 if (isEof())
178 return getExpectedError(ErrorMsg);
179
180 switch (look().kind()) {
181 case Kind::Minus: {
182 consume();
183 ASSIGN_OR_RETURN(Result, parseIntExpr2());
184 return -(*Result);
185 }
186
187 case Kind::Tilde: {
188 consume();
189 ASSIGN_OR_RETURN(Result, parseIntExpr2());
190 return ~(*Result);
191 }
192
193 case Kind::Int:
Zachary Turner07bc04f2017-10-06 21:26:06 +0000194 return RCInt(read());
Marek Sokolowski7e89ee72017-09-28 23:53:25 +0000195
196 case Kind::LeftParen: {
197 consume();
198 ASSIGN_OR_RETURN(Result, parseIntExpr1());
199 RETURN_IF_ERROR(consumeType(Kind::RightParen));
200 return *Result;
201 }
202
203 default:
204 return getExpectedError(ErrorMsg);
205 }
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000206}
207
208Expected<StringRef> RCParser::readString() {
209 if (!isNextTokenKind(Kind::String))
210 return getExpectedError("string");
211 return read().value();
212}
213
214Expected<StringRef> RCParser::readIdentifier() {
215 if (!isNextTokenKind(Kind::Identifier))
216 return getExpectedError("identifier");
217 return read().value();
218}
219
Marek Sokolowski7f110522017-08-28 22:58:31 +0000220Expected<IntOrString> RCParser::readIntOrString() {
221 if (!isNextTokenKind(Kind::Int) && !isNextTokenKind(Kind::String))
222 return getExpectedError("int or string");
223 return IntOrString(read());
224}
225
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000226Expected<IntOrString> RCParser::readTypeOrName() {
227 // We suggest that the correct resource name or type should be either an
228 // identifier or an integer. The original RC tool is much more liberal.
229 if (!isNextTokenKind(Kind::Identifier) && !isNextTokenKind(Kind::Int))
230 return getExpectedError("int or identifier");
Marek Sokolowski7f110522017-08-28 22:58:31 +0000231 return IntOrString(read());
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000232}
233
234Error RCParser::consumeType(Kind TokenKind) {
235 if (isNextTokenKind(TokenKind)) {
236 consume();
237 return Error::success();
238 }
239
240 switch (TokenKind) {
241#define TOKEN(TokenName) \
242 case Kind::TokenName: \
243 return getExpectedError(#TokenName);
244#define SHORT_TOKEN(TokenName, TokenCh) \
245 case Kind::TokenName: \
246 return getExpectedError(#TokenCh);
247#include "ResourceScriptTokenList.h"
248#undef SHORT_TOKEN
249#undef TOKEN
250 }
251
252 llvm_unreachable("All case options exhausted.");
253}
254
255bool RCParser::consumeOptionalType(Kind TokenKind) {
256 if (isNextTokenKind(TokenKind)) {
257 consume();
258 return true;
259 }
260
261 return false;
262}
263
Zachary Turner07bc04f2017-10-06 21:26:06 +0000264Expected<SmallVector<RCInt, 8>> RCParser::readIntsWithCommas(size_t MinCount,
265 size_t MaxCount) {
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000266 assert(MinCount <= MaxCount);
267
Zachary Turner07bc04f2017-10-06 21:26:06 +0000268 SmallVector<RCInt, 8> Result;
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000269
270 auto FailureHandler =
Zachary Turner07bc04f2017-10-06 21:26:06 +0000271 [&](llvm::Error Err) -> Expected<SmallVector<RCInt, 8>> {
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000272 if (Result.size() < MinCount)
273 return std::move(Err);
274 consumeError(std::move(Err));
275 return Result;
276 };
277
278 for (size_t i = 0; i < MaxCount; ++i) {
279 // Try to read a comma unless we read the first token.
280 // Sometimes RC tool requires them and sometimes not. We decide to
281 // always require them.
282 if (i >= 1) {
283 if (auto CommaError = consumeType(Kind::Comma))
284 return FailureHandler(std::move(CommaError));
285 }
286
287 if (auto IntResult = readInt())
288 Result.push_back(*IntResult);
289 else
290 return FailureHandler(IntResult.takeError());
291 }
292
293 return std::move(Result);
294}
295
Marek Sokolowskic75a0872017-09-29 17:46:32 +0000296Expected<uint32_t> RCParser::parseFlags(ArrayRef<StringRef> FlagDesc,
297 ArrayRef<uint32_t> FlagValues) {
Marek Sokolowski7f110522017-08-28 22:58:31 +0000298 assert(!FlagDesc.empty());
Marek Sokolowskic75a0872017-09-29 17:46:32 +0000299 assert(FlagDesc.size() == FlagValues.size());
Marek Sokolowski7f110522017-08-28 22:58:31 +0000300
301 uint32_t Result = 0;
302 while (isNextTokenKind(Kind::Comma)) {
303 consume();
304 ASSIGN_OR_RETURN(FlagResult, readIdentifier());
305 bool FoundFlag = false;
306
307 for (size_t FlagId = 0; FlagId < FlagDesc.size(); ++FlagId) {
308 if (!FlagResult->equals_lower(FlagDesc[FlagId]))
309 continue;
310
Marek Sokolowskic75a0872017-09-29 17:46:32 +0000311 Result |= FlagValues[FlagId];
Marek Sokolowski7f110522017-08-28 22:58:31 +0000312 FoundFlag = true;
313 break;
314 }
315
316 if (!FoundFlag)
317 return getExpectedError(join(FlagDesc, "/"), true);
318 }
319
320 return Result;
321}
322
Zachary Turner420090a2017-10-06 20:51:20 +0000323Expected<OptionalStmtList>
324RCParser::parseOptionalStatements(OptStmtType StmtsType) {
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000325 OptionalStmtList Result;
326
327 // The last statement is always followed by the start of the block.
328 while (!isNextTokenKind(Kind::BlockBegin)) {
Zachary Turner420090a2017-10-06 20:51:20 +0000329 ASSIGN_OR_RETURN(SingleParse, parseSingleOptionalStatement(StmtsType));
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000330 Result.addStmt(std::move(*SingleParse));
331 }
332
333 return std::move(Result);
334}
335
336Expected<std::unique_ptr<OptionalStmt>>
Zachary Turner420090a2017-10-06 20:51:20 +0000337RCParser::parseSingleOptionalStatement(OptStmtType StmtsType) {
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000338 ASSIGN_OR_RETURN(TypeToken, readIdentifier());
339 if (TypeToken->equals_lower("CHARACTERISTICS"))
340 return parseCharacteristicsStmt();
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000341 if (TypeToken->equals_lower("LANGUAGE"))
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000342 return parseLanguageStmt();
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000343 if (TypeToken->equals_lower("VERSION"))
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000344 return parseVersionStmt();
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000345
Zachary Turner420090a2017-10-06 20:51:20 +0000346 if (StmtsType != OptStmtType::BasicStmt) {
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000347 if (TypeToken->equals_lower("CAPTION"))
348 return parseCaptionStmt();
349 if (TypeToken->equals_lower("FONT"))
Zachary Turner420090a2017-10-06 20:51:20 +0000350 return parseFontStmt(StmtsType);
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000351 if (TypeToken->equals_lower("STYLE"))
352 return parseStyleStmt();
353 }
354
355 return getExpectedError("optional statement type, BEGIN or '{'",
356 /* IsAlreadyRead = */ true);
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000357}
358
359RCParser::ParseType RCParser::parseLanguageResource() {
360 // Read LANGUAGE as an optional statement. If it's read correctly, we can
361 // upcast it to RCResource.
362 return parseLanguageStmt();
363}
364
Marek Sokolowski7f110522017-08-28 22:58:31 +0000365RCParser::ParseType RCParser::parseAcceleratorsResource() {
366 ASSIGN_OR_RETURN(OptStatements, parseOptionalStatements());
367 RETURN_IF_ERROR(consumeType(Kind::BlockBegin));
368
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000369 auto Accels =
370 llvm::make_unique<AcceleratorsResource>(std::move(*OptStatements));
Marek Sokolowski7f110522017-08-28 22:58:31 +0000371
372 while (!consumeOptionalType(Kind::BlockEnd)) {
373 ASSIGN_OR_RETURN(EventResult, readIntOrString());
374 RETURN_IF_ERROR(consumeType(Kind::Comma));
375 ASSIGN_OR_RETURN(IDResult, readInt());
Marek Sokolowskic75a0872017-09-29 17:46:32 +0000376 ASSIGN_OR_RETURN(
377 FlagsResult,
378 parseFlags(AcceleratorsResource::Accelerator::OptionsStr,
379 AcceleratorsResource::Accelerator::OptionsFlags));
Marek Sokolowski7f110522017-08-28 22:58:31 +0000380 Accels->addAccelerator(*EventResult, *IDResult, *FlagsResult);
381 }
382
383 return std::move(Accels);
384}
385
Marek Sokolowski72aa9372017-08-28 21:59:54 +0000386RCParser::ParseType RCParser::parseCursorResource() {
387 ASSIGN_OR_RETURN(Arg, readString());
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000388 return llvm::make_unique<CursorResource>(*Arg);
Marek Sokolowski72aa9372017-08-28 21:59:54 +0000389}
390
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000391RCParser::ParseType RCParser::parseDialogResource(bool IsExtended) {
392 // Dialog resources have the following format of the arguments:
393 // DIALOG: x, y, width, height [opt stmts...] {controls...}
394 // DIALOGEX: x, y, width, height [, helpID] [opt stmts...] {controls...}
395 // These are very similar, so we parse them together.
396 ASSIGN_OR_RETURN(LocResult, readIntsWithCommas(4, 4));
397
398 uint32_t HelpID = 0; // When HelpID is unset, it's assumed to be 0.
399 if (IsExtended && consumeOptionalType(Kind::Comma)) {
400 ASSIGN_OR_RETURN(HelpIDResult, readInt());
401 HelpID = *HelpIDResult;
402 }
403
Zachary Turner420090a2017-10-06 20:51:20 +0000404 ASSIGN_OR_RETURN(OptStatements, parseOptionalStatements(
405 IsExtended ? OptStmtType::DialogExStmt
406 : OptStmtType::DialogStmt));
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000407
408 assert(isNextTokenKind(Kind::BlockBegin) &&
409 "parseOptionalStatements, when successful, halts on BlockBegin.");
410 consume();
411
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000412 auto Dialog = llvm::make_unique<DialogResource>(
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000413 (*LocResult)[0], (*LocResult)[1], (*LocResult)[2], (*LocResult)[3],
414 HelpID, std::move(*OptStatements), IsExtended);
415
416 while (!consumeOptionalType(Kind::BlockEnd)) {
417 ASSIGN_OR_RETURN(ControlDefResult, parseControl());
418 Dialog->addControl(std::move(*ControlDefResult));
419 }
420
421 return std::move(Dialog);
422}
423
Marek Sokolowskib5f39a02017-09-29 00:14:18 +0000424RCParser::ParseType RCParser::parseUserDefinedResource(IntOrString Type) {
425 if (isEof())
426 return getExpectedError("filename, '{' or BEGIN");
427
428 // Check if this is a file resource.
429 if (look().kind() == Kind::String)
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000430 return llvm::make_unique<UserDefinedResource>(Type, read().value());
Marek Sokolowskib5f39a02017-09-29 00:14:18 +0000431
432 RETURN_IF_ERROR(consumeType(Kind::BlockBegin));
433 std::vector<IntOrString> Data;
434
435 // Consume comma before each consecutive token except the first one.
436 bool ConsumeComma = false;
437 while (!consumeOptionalType(Kind::BlockEnd)) {
438 if (ConsumeComma)
439 RETURN_IF_ERROR(consumeType(Kind::Comma));
440 ConsumeComma = true;
441
442 ASSIGN_OR_RETURN(Item, readIntOrString());
443 Data.push_back(*Item);
444 }
445
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000446 return llvm::make_unique<UserDefinedResource>(Type, std::move(Data));
Marek Sokolowskib5f39a02017-09-29 00:14:18 +0000447}
448
Marek Sokolowskifb74cb12017-09-28 22:41:38 +0000449RCParser::ParseType RCParser::parseVersionInfoResource() {
450 ASSIGN_OR_RETURN(FixedResult, parseVersionInfoFixed());
451 ASSIGN_OR_RETURN(BlockResult, parseVersionInfoBlockContents(StringRef()));
Marek Sokolowski99ead702017-09-28 23:12:53 +0000452 return llvm::make_unique<VersionInfoResource>(std::move(**BlockResult),
453 std::move(*FixedResult));
Marek Sokolowskifb74cb12017-09-28 22:41:38 +0000454}
455
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000456Expected<Control> RCParser::parseControl() {
457 // Each control definition (except CONTROL) follows one of the schemes below
458 // depending on the control class:
459 // [class] text, id, x, y, width, height [, style] [, exstyle] [, helpID]
460 // [class] id, x, y, width, height [, style] [, exstyle] [, helpID]
461 // Note that control ids must be integers.
Marek Sokolowski7f7745c2017-09-30 00:38:52 +0000462 // Text might be either a string or an integer pointing to resource ID.
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000463 ASSIGN_OR_RETURN(ClassResult, readIdentifier());
Marek Sokolowski75fa1732017-08-29 20:03:18 +0000464 std::string ClassUpper = ClassResult->upper();
Marek Sokolowski7f7745c2017-09-30 00:38:52 +0000465 auto CtlInfo = Control::SupportedCtls.find(ClassUpper);
466 if (CtlInfo == Control::SupportedCtls.end())
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000467 return getExpectedError("control type, END or '}'", true);
468
469 // Read caption if necessary.
Marek Sokolowski7f7745c2017-09-30 00:38:52 +0000470 IntOrString Caption{StringRef()};
471 if (CtlInfo->getValue().HasTitle) {
472 ASSIGN_OR_RETURN(CaptionResult, readIntOrString());
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000473 RETURN_IF_ERROR(consumeType(Kind::Comma));
474 Caption = *CaptionResult;
475 }
476
477 ASSIGN_OR_RETURN(Args, readIntsWithCommas(5, 8));
478
479 auto TakeOptArg = [&Args](size_t Id) -> Optional<uint32_t> {
Zachary Turner07bc04f2017-10-06 21:26:06 +0000480 return Args->size() > Id ? (uint32_t)(*Args)[Id] : Optional<uint32_t>();
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000481 };
482
483 return Control(*ClassResult, Caption, (*Args)[0], (*Args)[1], (*Args)[2],
484 (*Args)[3], (*Args)[4], TakeOptArg(5), TakeOptArg(6),
485 TakeOptArg(7));
486}
487
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000488RCParser::ParseType RCParser::parseIconResource() {
489 ASSIGN_OR_RETURN(Arg, readString());
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000490 return llvm::make_unique<IconResource>(*Arg);
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000491}
492
Marek Sokolowski72aa9372017-08-28 21:59:54 +0000493RCParser::ParseType RCParser::parseHTMLResource() {
494 ASSIGN_OR_RETURN(Arg, readString());
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000495 return llvm::make_unique<HTMLResource>(*Arg);
Marek Sokolowski72aa9372017-08-28 21:59:54 +0000496}
497
Marek Sokolowski99ecb0e2017-08-28 23:46:30 +0000498RCParser::ParseType RCParser::parseMenuResource() {
499 ASSIGN_OR_RETURN(OptStatements, parseOptionalStatements());
500 ASSIGN_OR_RETURN(Items, parseMenuItemsList());
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000501 return llvm::make_unique<MenuResource>(std::move(*OptStatements),
502 std::move(*Items));
Marek Sokolowski99ecb0e2017-08-28 23:46:30 +0000503}
504
505Expected<MenuDefinitionList> RCParser::parseMenuItemsList() {
506 RETURN_IF_ERROR(consumeType(Kind::BlockBegin));
507
508 MenuDefinitionList List;
509
510 // Read a set of items. Each item is of one of three kinds:
511 // MENUITEM SEPARATOR
512 // MENUITEM caption:String, result:Int [, menu flags]...
513 // POPUP caption:String [, menu flags]... { items... }
514 while (!consumeOptionalType(Kind::BlockEnd)) {
515 ASSIGN_OR_RETURN(ItemTypeResult, readIdentifier());
516
517 bool IsMenuItem = ItemTypeResult->equals_lower("MENUITEM");
518 bool IsPopup = ItemTypeResult->equals_lower("POPUP");
519 if (!IsMenuItem && !IsPopup)
520 return getExpectedError("MENUITEM, POPUP, END or '}'", true);
521
522 if (IsMenuItem && isNextTokenKind(Kind::Identifier)) {
523 // Now, expecting SEPARATOR.
524 ASSIGN_OR_RETURN(SeparatorResult, readIdentifier());
525 if (SeparatorResult->equals_lower("SEPARATOR")) {
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000526 List.addDefinition(llvm::make_unique<MenuSeparator>());
Marek Sokolowski99ecb0e2017-08-28 23:46:30 +0000527 continue;
528 }
529
530 return getExpectedError("SEPARATOR or string", true);
531 }
532
533 // Not a separator. Read the caption.
534 ASSIGN_OR_RETURN(CaptionResult, readString());
535
536 // If MENUITEM, expect also a comma and an integer.
537 uint32_t MenuResult = -1;
538
539 if (IsMenuItem) {
540 RETURN_IF_ERROR(consumeType(Kind::Comma));
541 ASSIGN_OR_RETURN(IntResult, readInt());
542 MenuResult = *IntResult;
543 }
544
Marek Sokolowskic75a0872017-09-29 17:46:32 +0000545 ASSIGN_OR_RETURN(FlagsResult, parseFlags(MenuDefinition::OptionsStr,
546 MenuDefinition::OptionsFlags));
Marek Sokolowski99ecb0e2017-08-28 23:46:30 +0000547
548 if (IsPopup) {
549 // If POPUP, read submenu items recursively.
550 ASSIGN_OR_RETURN(SubMenuResult, parseMenuItemsList());
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000551 List.addDefinition(llvm::make_unique<PopupItem>(
552 *CaptionResult, *FlagsResult, std::move(*SubMenuResult)));
Marek Sokolowski99ecb0e2017-08-28 23:46:30 +0000553 continue;
554 }
555
556 assert(IsMenuItem);
557 List.addDefinition(
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000558 llvm::make_unique<MenuItem>(*CaptionResult, MenuResult, *FlagsResult));
Marek Sokolowski99ecb0e2017-08-28 23:46:30 +0000559 }
560
561 return std::move(List);
562}
563
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000564RCParser::ParseType RCParser::parseStringTableResource() {
565 ASSIGN_OR_RETURN(OptStatements, parseOptionalStatements());
566 RETURN_IF_ERROR(consumeType(Kind::BlockBegin));
567
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000568 auto Table =
569 llvm::make_unique<StringTableResource>(std::move(*OptStatements));
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000570
571 // Read strings until we reach the end of the block.
572 while (!consumeOptionalType(Kind::BlockEnd)) {
573 // Each definition consists of string's ID (an integer) and a string.
574 // Some examples in documentation suggest that there might be a comma in
575 // between, however we strictly adhere to the single statement definition.
576 ASSIGN_OR_RETURN(IDResult, readInt());
577 ASSIGN_OR_RETURN(StrResult, readString());
578 Table->addString(*IDResult, *StrResult);
579 }
580
581 return std::move(Table);
582}
583
Marek Sokolowskifb74cb12017-09-28 22:41:38 +0000584Expected<std::unique_ptr<VersionInfoBlock>>
585RCParser::parseVersionInfoBlockContents(StringRef BlockName) {
586 RETURN_IF_ERROR(consumeType(Kind::BlockBegin));
587
Marek Sokolowski99ead702017-09-28 23:12:53 +0000588 auto Contents = llvm::make_unique<VersionInfoBlock>(BlockName);
Marek Sokolowskifb74cb12017-09-28 22:41:38 +0000589
590 while (!isNextTokenKind(Kind::BlockEnd)) {
591 ASSIGN_OR_RETURN(Stmt, parseVersionInfoStmt());
592 Contents->addStmt(std::move(*Stmt));
593 }
594
595 consume(); // Consume BlockEnd.
596
597 return std::move(Contents);
598}
599
600Expected<std::unique_ptr<VersionInfoStmt>> RCParser::parseVersionInfoStmt() {
601 // Expect either BLOCK or VALUE, then a name or a key (a string).
602 ASSIGN_OR_RETURN(TypeResult, readIdentifier());
603
604 if (TypeResult->equals_lower("BLOCK")) {
605 ASSIGN_OR_RETURN(NameResult, readString());
606 return parseVersionInfoBlockContents(*NameResult);
607 }
608
609 if (TypeResult->equals_lower("VALUE")) {
610 ASSIGN_OR_RETURN(KeyResult, readString());
Zachary Turner07bc04f2017-10-06 21:26:06 +0000611 // Read a non-empty list of strings and/or ints, each
612 // possibly preceded by a comma. Unfortunately, the tool behavior depends
613 // on them existing or not, so we need to memorize where we found them.
Marek Sokolowskifb74cb12017-09-28 22:41:38 +0000614 std::vector<IntOrString> Values;
Zachary Turner07bc04f2017-10-06 21:26:06 +0000615 std::vector<bool> PrecedingCommas;
616 RETURN_IF_ERROR(consumeType(Kind::Comma));
617 while (!isNextTokenKind(Kind::Identifier) &&
618 !isNextTokenKind(Kind::BlockEnd)) {
619 // Try to eat a comma if it's not the first statement.
620 bool HadComma = Values.size() > 0 && consumeOptionalType(Kind::Comma);
Marek Sokolowskifb74cb12017-09-28 22:41:38 +0000621 ASSIGN_OR_RETURN(ValueResult, readIntOrString());
622 Values.push_back(*ValueResult);
Zachary Turner07bc04f2017-10-06 21:26:06 +0000623 PrecedingCommas.push_back(HadComma);
Marek Sokolowskifb74cb12017-09-28 22:41:38 +0000624 }
Zachary Turner07bc04f2017-10-06 21:26:06 +0000625 return llvm::make_unique<VersionInfoValue>(*KeyResult, std::move(Values),
626 std::move(PrecedingCommas));
Marek Sokolowskifb74cb12017-09-28 22:41:38 +0000627 }
628
629 return getExpectedError("BLOCK or VALUE", true);
630}
631
632Expected<VersionInfoResource::VersionInfoFixed>
633RCParser::parseVersionInfoFixed() {
634 using RetType = VersionInfoResource::VersionInfoFixed;
635 RetType Result;
636
637 // Read until the beginning of the block.
638 while (!isNextTokenKind(Kind::BlockBegin)) {
639 ASSIGN_OR_RETURN(TypeResult, readIdentifier());
640 auto FixedType = RetType::getFixedType(*TypeResult);
641
642 if (!RetType::isTypeSupported(FixedType))
643 return getExpectedError("fixed VERSIONINFO statement type", true);
644 if (Result.IsTypePresent[FixedType])
645 return getExpectedError("yet unread fixed VERSIONINFO statement type",
646 true);
647
648 // VERSION variations take multiple integers.
649 size_t NumInts = RetType::isVersionType(FixedType) ? 4 : 1;
650 ASSIGN_OR_RETURN(ArgsResult, readIntsWithCommas(NumInts, NumInts));
Zachary Turner07bc04f2017-10-06 21:26:06 +0000651 SmallVector<uint32_t, 4> ArgInts(ArgsResult->begin(), ArgsResult->end());
652 Result.setValue(FixedType, ArgInts);
Marek Sokolowskifb74cb12017-09-28 22:41:38 +0000653 }
654
655 return Result;
656}
657
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000658RCParser::ParseOptionType RCParser::parseLanguageStmt() {
659 ASSIGN_OR_RETURN(Args, readIntsWithCommas(/* min = */ 2, /* max = */ 2));
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000660 return llvm::make_unique<LanguageResource>((*Args)[0], (*Args)[1]);
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000661}
662
663RCParser::ParseOptionType RCParser::parseCharacteristicsStmt() {
664 ASSIGN_OR_RETURN(Arg, readInt());
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000665 return llvm::make_unique<CharacteristicsStmt>(*Arg);
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000666}
667
668RCParser::ParseOptionType RCParser::parseVersionStmt() {
669 ASSIGN_OR_RETURN(Arg, readInt());
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000670 return llvm::make_unique<VersionStmt>(*Arg);
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000671}
672
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000673RCParser::ParseOptionType RCParser::parseCaptionStmt() {
674 ASSIGN_OR_RETURN(Arg, readString());
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000675 return llvm::make_unique<CaptionStmt>(*Arg);
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000676}
677
Zachary Turner420090a2017-10-06 20:51:20 +0000678RCParser::ParseOptionType RCParser::parseFontStmt(OptStmtType DialogType) {
679 assert(DialogType != OptStmtType::BasicStmt);
680
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000681 ASSIGN_OR_RETURN(SizeResult, readInt());
682 RETURN_IF_ERROR(consumeType(Kind::Comma));
683 ASSIGN_OR_RETURN(NameResult, readString());
Zachary Turner420090a2017-10-06 20:51:20 +0000684
685 // Default values for the optional arguments.
686 uint32_t FontWeight = 0;
687 bool FontItalic = false;
688 uint32_t FontCharset = 1;
689 if (DialogType == OptStmtType::DialogExStmt) {
690 if (consumeOptionalType(Kind::Comma)) {
691 ASSIGN_OR_RETURN(Args, readIntsWithCommas(/* min = */ 0, /* max = */ 3));
692 if (Args->size() >= 1)
693 FontWeight = (*Args)[0];
694 if (Args->size() >= 2)
695 FontItalic = (*Args)[1] != 0;
696 if (Args->size() >= 3)
697 FontCharset = (*Args)[2];
698 }
699 }
700 return llvm::make_unique<FontStmt>(*SizeResult, *NameResult, FontWeight,
701 FontItalic, FontCharset);
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000702}
703
704RCParser::ParseOptionType RCParser::parseStyleStmt() {
705 ASSIGN_OR_RETURN(Arg, readInt());
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000706 return llvm::make_unique<StyleStmt>(*Arg);
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000707}
708
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000709Error RCParser::getExpectedError(const Twine Message, bool IsAlreadyRead) {
710 return make_error<ParserError>(
711 Message, IsAlreadyRead ? std::prev(CurLoc) : CurLoc, End);
712}
713
714} // namespace rc
715} // namespace llvm