blob: ffa18bdf198b56b2019f155689647e43fb068599 [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"
Zachary Turnerfa0ca6c2017-10-11 20:12:09 +000015#include "llvm/Option/ArgList.h"
16#include "llvm/Support/FileSystem.h"
17#include "llvm/Support/Path.h"
18#include "llvm/Support/Process.h"
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +000019
20// Take an expression returning llvm::Error and forward the error if it exists.
21#define RETURN_IF_ERROR(Expr) \
22 if (auto Err = (Expr)) \
23 return std::move(Err);
24
25// Take an expression returning llvm::Expected<T> and assign it to Var or
26// forward the error out of the function.
27#define ASSIGN_OR_RETURN(Var, Expr) \
28 auto Var = (Expr); \
29 if (!Var) \
30 return Var.takeError();
31
32namespace llvm {
33namespace rc {
34
Zachary Turner514b7102017-10-09 18:50:29 +000035RCParser::ParserError::ParserError(const Twine &Expected, const LocIter CurLoc,
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +000036 const LocIter End)
37 : ErrorLoc(CurLoc), FileEnd(End) {
38 CurMessage = "Error parsing file: expected " + Expected.str() + ", got " +
39 (CurLoc == End ? "<EOF>" : CurLoc->value()).str();
40}
41
42char RCParser::ParserError::ID = 0;
43
Zachary Turner514b7102017-10-09 18:50:29 +000044RCParser::RCParser(std::vector<RCToken> TokenList)
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +000045 : Tokens(std::move(TokenList)), CurLoc(Tokens.begin()), End(Tokens.end()) {}
46
47bool RCParser::isEof() const { return CurLoc == End; }
48
49RCParser::ParseType RCParser::parseSingleResource() {
50 // The first thing we read is usually a resource's name. However, in some
51 // cases (LANGUAGE and STRINGTABLE) the resources don't have their names
52 // and the first token to be read is the type.
53 ASSIGN_OR_RETURN(NameToken, readTypeOrName());
54
55 if (NameToken->equalsLower("LANGUAGE"))
56 return parseLanguageResource();
57 else if (NameToken->equalsLower("STRINGTABLE"))
58 return parseStringTableResource();
59
60 // If it's not an unnamed resource, what we've just read is a name. Now,
61 // read resource type;
62 ASSIGN_OR_RETURN(TypeToken, readTypeOrName());
63
64 ParseType Result = std::unique_ptr<RCResource>();
65 (void)!Result;
66
Marek Sokolowski7f110522017-08-28 22:58:31 +000067 if (TypeToken->equalsLower("ACCELERATORS"))
68 Result = parseAcceleratorsResource();
Martin Storsjo577b9812018-05-07 20:27:37 +000069 else if (TypeToken->equalsLower("BITMAP"))
70 Result = parseBitmapResource();
Marek Sokolowski7f110522017-08-28 22:58:31 +000071 else if (TypeToken->equalsLower("CURSOR"))
Marek Sokolowski72aa9372017-08-28 21:59:54 +000072 Result = parseCursorResource();
Marek Sokolowski4ac54d92017-08-29 16:49:59 +000073 else if (TypeToken->equalsLower("DIALOG"))
74 Result = parseDialogResource(false);
75 else if (TypeToken->equalsLower("DIALOGEX"))
76 Result = parseDialogResource(true);
Marek Sokolowski72aa9372017-08-28 21:59:54 +000077 else if (TypeToken->equalsLower("HTML"))
78 Result = parseHTMLResource();
Martin Storsjo827ddb22018-05-07 20:27:15 +000079 else if (TypeToken->equalsLower("ICON"))
80 Result = parseIconResource();
Marek Sokolowski99ecb0e2017-08-28 23:46:30 +000081 else if (TypeToken->equalsLower("MENU"))
82 Result = parseMenuResource();
Marek Sokolowskifb74cb12017-09-28 22:41:38 +000083 else if (TypeToken->equalsLower("VERSIONINFO"))
84 Result = parseVersionInfoResource();
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +000085 else
Marek Sokolowskib5f39a02017-09-29 00:14:18 +000086 Result = parseUserDefinedResource(*TypeToken);
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +000087
88 if (Result)
89 (*Result)->setName(*NameToken);
90
91 return Result;
92}
93
94bool RCParser::isNextTokenKind(Kind TokenKind) const {
95 return !isEof() && look().kind() == TokenKind;
96}
97
98const RCToken &RCParser::look() const {
99 assert(!isEof());
100 return *CurLoc;
101}
102
103const RCToken &RCParser::read() {
104 assert(!isEof());
105 return *CurLoc++;
106}
107
108void RCParser::consume() {
109 assert(!isEof());
110 CurLoc++;
111}
112
Marek Sokolowski7e89ee72017-09-28 23:53:25 +0000113// An integer description might consist of a single integer or
114// an arithmetic expression evaluating to the integer. The expressions
115// can contain the following tokens: <int> ( ) + - | & ~. Their meaning
116// is the same as in C++.
117// The operators in the original RC implementation have the following
118// precedence:
119// 1) Unary operators (- ~),
120// 2) Binary operators (+ - & |), with no precedence.
121//
122// The following grammar is used to parse the expressions Exp1:
123// Exp1 ::= Exp2 || Exp1 + Exp2 || Exp1 - Exp2 || Exp1 | Exp2 || Exp1 & Exp2
124// Exp2 ::= -Exp2 || ~Exp2 || Int || (Exp1).
125// (More conveniently, Exp1 is a non-empty sequence of Exp2 expressions,
126// separated by binary operators.)
127//
128// Expressions of type Exp1 are read by parseIntExpr1(Inner) method, while Exp2
129// is read by parseIntExpr2().
130//
131// The original Microsoft tool handles multiple unary operators incorrectly.
132// For example, in 16-bit little-endian integers:
133// 1 => 01 00, -1 => ff ff, --1 => ff ff, ---1 => 01 00;
134// 1 => 01 00, ~1 => fe ff, ~~1 => fd ff, ~~~1 => fc ff.
135// Our implementation differs from the original one and handles these
136// operators correctly:
137// 1 => 01 00, -1 => ff ff, --1 => 01 00, ---1 => ff ff;
138// 1 => 01 00, ~1 => fe ff, ~~1 => 01 00, ~~~1 => fe ff.
139
Zachary Turner07bc04f2017-10-06 21:26:06 +0000140Expected<RCInt> RCParser::readInt() { return parseIntExpr1(); }
Marek Sokolowski7e89ee72017-09-28 23:53:25 +0000141
Zachary Turner07bc04f2017-10-06 21:26:06 +0000142Expected<RCInt> RCParser::parseIntExpr1() {
Marek Sokolowski7e89ee72017-09-28 23:53:25 +0000143 // Exp1 ::= Exp2 || Exp1 + Exp2 || Exp1 - Exp2 || Exp1 | Exp2 || Exp1 & Exp2.
144 ASSIGN_OR_RETURN(FirstResult, parseIntExpr2());
Zachary Turner07bc04f2017-10-06 21:26:06 +0000145 RCInt Result = *FirstResult;
Marek Sokolowski7e89ee72017-09-28 23:53:25 +0000146
147 while (!isEof() && look().isBinaryOp()) {
148 auto OpToken = read();
149 ASSIGN_OR_RETURN(NextResult, parseIntExpr2());
150
151 switch (OpToken.kind()) {
152 case Kind::Plus:
153 Result += *NextResult;
154 break;
155
156 case Kind::Minus:
157 Result -= *NextResult;
158 break;
159
160 case Kind::Pipe:
161 Result |= *NextResult;
162 break;
163
164 case Kind::Amp:
165 Result &= *NextResult;
166 break;
167
168 default:
169 llvm_unreachable("Already processed all binary ops.");
170 }
171 }
172
173 return Result;
174}
175
Zachary Turner07bc04f2017-10-06 21:26:06 +0000176Expected<RCInt> RCParser::parseIntExpr2() {
Marek Sokolowski7e89ee72017-09-28 23:53:25 +0000177 // Exp2 ::= -Exp2 || ~Exp2 || Int || (Exp1).
178 static const char ErrorMsg[] = "'-', '~', integer or '('";
179
180 if (isEof())
181 return getExpectedError(ErrorMsg);
182
183 switch (look().kind()) {
184 case Kind::Minus: {
185 consume();
186 ASSIGN_OR_RETURN(Result, parseIntExpr2());
187 return -(*Result);
188 }
189
190 case Kind::Tilde: {
191 consume();
192 ASSIGN_OR_RETURN(Result, parseIntExpr2());
193 return ~(*Result);
194 }
195
196 case Kind::Int:
Zachary Turner07bc04f2017-10-06 21:26:06 +0000197 return RCInt(read());
Marek Sokolowski7e89ee72017-09-28 23:53:25 +0000198
199 case Kind::LeftParen: {
200 consume();
201 ASSIGN_OR_RETURN(Result, parseIntExpr1());
202 RETURN_IF_ERROR(consumeType(Kind::RightParen));
203 return *Result;
204 }
205
206 default:
207 return getExpectedError(ErrorMsg);
208 }
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000209}
210
211Expected<StringRef> RCParser::readString() {
212 if (!isNextTokenKind(Kind::String))
213 return getExpectedError("string");
214 return read().value();
215}
216
217Expected<StringRef> RCParser::readIdentifier() {
218 if (!isNextTokenKind(Kind::Identifier))
219 return getExpectedError("identifier");
220 return read().value();
221}
222
Marek Sokolowski7f110522017-08-28 22:58:31 +0000223Expected<IntOrString> RCParser::readIntOrString() {
224 if (!isNextTokenKind(Kind::Int) && !isNextTokenKind(Kind::String))
225 return getExpectedError("int or string");
226 return IntOrString(read());
227}
228
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000229Expected<IntOrString> RCParser::readTypeOrName() {
230 // We suggest that the correct resource name or type should be either an
231 // identifier or an integer. The original RC tool is much more liberal.
232 if (!isNextTokenKind(Kind::Identifier) && !isNextTokenKind(Kind::Int))
233 return getExpectedError("int or identifier");
Marek Sokolowski7f110522017-08-28 22:58:31 +0000234 return IntOrString(read());
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000235}
236
237Error RCParser::consumeType(Kind TokenKind) {
238 if (isNextTokenKind(TokenKind)) {
239 consume();
240 return Error::success();
241 }
242
243 switch (TokenKind) {
244#define TOKEN(TokenName) \
245 case Kind::TokenName: \
246 return getExpectedError(#TokenName);
247#define SHORT_TOKEN(TokenName, TokenCh) \
248 case Kind::TokenName: \
249 return getExpectedError(#TokenCh);
David Blaikieb961d292017-11-21 00:23:19 +0000250#include "ResourceScriptTokenList.def"
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000251 }
252
253 llvm_unreachable("All case options exhausted.");
254}
255
256bool RCParser::consumeOptionalType(Kind TokenKind) {
257 if (isNextTokenKind(TokenKind)) {
258 consume();
259 return true;
260 }
261
262 return false;
263}
264
Zachary Turner07bc04f2017-10-06 21:26:06 +0000265Expected<SmallVector<RCInt, 8>> RCParser::readIntsWithCommas(size_t MinCount,
266 size_t MaxCount) {
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000267 assert(MinCount <= MaxCount);
268
Zachary Turner07bc04f2017-10-06 21:26:06 +0000269 SmallVector<RCInt, 8> Result;
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000270
271 auto FailureHandler =
Zachary Turner07bc04f2017-10-06 21:26:06 +0000272 [&](llvm::Error Err) -> Expected<SmallVector<RCInt, 8>> {
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000273 if (Result.size() < MinCount)
274 return std::move(Err);
275 consumeError(std::move(Err));
276 return Result;
277 };
278
279 for (size_t i = 0; i < MaxCount; ++i) {
280 // Try to read a comma unless we read the first token.
281 // Sometimes RC tool requires them and sometimes not. We decide to
282 // always require them.
283 if (i >= 1) {
284 if (auto CommaError = consumeType(Kind::Comma))
285 return FailureHandler(std::move(CommaError));
286 }
287
288 if (auto IntResult = readInt())
289 Result.push_back(*IntResult);
290 else
291 return FailureHandler(IntResult.takeError());
292 }
293
294 return std::move(Result);
295}
296
Marek Sokolowskic75a0872017-09-29 17:46:32 +0000297Expected<uint32_t> RCParser::parseFlags(ArrayRef<StringRef> FlagDesc,
298 ArrayRef<uint32_t> FlagValues) {
Marek Sokolowski7f110522017-08-28 22:58:31 +0000299 assert(!FlagDesc.empty());
Marek Sokolowskic75a0872017-09-29 17:46:32 +0000300 assert(FlagDesc.size() == FlagValues.size());
Marek Sokolowski7f110522017-08-28 22:58:31 +0000301
302 uint32_t Result = 0;
303 while (isNextTokenKind(Kind::Comma)) {
304 consume();
305 ASSIGN_OR_RETURN(FlagResult, readIdentifier());
306 bool FoundFlag = false;
307
308 for (size_t FlagId = 0; FlagId < FlagDesc.size(); ++FlagId) {
309 if (!FlagResult->equals_lower(FlagDesc[FlagId]))
310 continue;
311
Marek Sokolowskic75a0872017-09-29 17:46:32 +0000312 Result |= FlagValues[FlagId];
Marek Sokolowski7f110522017-08-28 22:58:31 +0000313 FoundFlag = true;
314 break;
315 }
316
317 if (!FoundFlag)
318 return getExpectedError(join(FlagDesc, "/"), true);
319 }
320
321 return Result;
322}
323
Zachary Turner420090a2017-10-06 20:51:20 +0000324Expected<OptionalStmtList>
325RCParser::parseOptionalStatements(OptStmtType StmtsType) {
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000326 OptionalStmtList Result;
327
328 // The last statement is always followed by the start of the block.
329 while (!isNextTokenKind(Kind::BlockBegin)) {
Zachary Turner420090a2017-10-06 20:51:20 +0000330 ASSIGN_OR_RETURN(SingleParse, parseSingleOptionalStatement(StmtsType));
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000331 Result.addStmt(std::move(*SingleParse));
332 }
333
334 return std::move(Result);
335}
336
337Expected<std::unique_ptr<OptionalStmt>>
Zachary Turner420090a2017-10-06 20:51:20 +0000338RCParser::parseSingleOptionalStatement(OptStmtType StmtsType) {
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000339 ASSIGN_OR_RETURN(TypeToken, readIdentifier());
340 if (TypeToken->equals_lower("CHARACTERISTICS"))
341 return parseCharacteristicsStmt();
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000342 if (TypeToken->equals_lower("LANGUAGE"))
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000343 return parseLanguageStmt();
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000344 if (TypeToken->equals_lower("VERSION"))
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000345 return parseVersionStmt();
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000346
Zachary Turner420090a2017-10-06 20:51:20 +0000347 if (StmtsType != OptStmtType::BasicStmt) {
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000348 if (TypeToken->equals_lower("CAPTION"))
349 return parseCaptionStmt();
350 if (TypeToken->equals_lower("FONT"))
Zachary Turner420090a2017-10-06 20:51:20 +0000351 return parseFontStmt(StmtsType);
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000352 if (TypeToken->equals_lower("STYLE"))
353 return parseStyleStmt();
354 }
355
356 return getExpectedError("optional statement type, BEGIN or '{'",
357 /* IsAlreadyRead = */ true);
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000358}
359
360RCParser::ParseType RCParser::parseLanguageResource() {
361 // Read LANGUAGE as an optional statement. If it's read correctly, we can
362 // upcast it to RCResource.
363 return parseLanguageStmt();
364}
365
Marek Sokolowski7f110522017-08-28 22:58:31 +0000366RCParser::ParseType RCParser::parseAcceleratorsResource() {
367 ASSIGN_OR_RETURN(OptStatements, parseOptionalStatements());
368 RETURN_IF_ERROR(consumeType(Kind::BlockBegin));
369
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000370 auto Accels =
371 llvm::make_unique<AcceleratorsResource>(std::move(*OptStatements));
Marek Sokolowski7f110522017-08-28 22:58:31 +0000372
373 while (!consumeOptionalType(Kind::BlockEnd)) {
374 ASSIGN_OR_RETURN(EventResult, readIntOrString());
375 RETURN_IF_ERROR(consumeType(Kind::Comma));
376 ASSIGN_OR_RETURN(IDResult, readInt());
Marek Sokolowskic75a0872017-09-29 17:46:32 +0000377 ASSIGN_OR_RETURN(
378 FlagsResult,
379 parseFlags(AcceleratorsResource::Accelerator::OptionsStr,
380 AcceleratorsResource::Accelerator::OptionsFlags));
Marek Sokolowski7f110522017-08-28 22:58:31 +0000381 Accels->addAccelerator(*EventResult, *IDResult, *FlagsResult);
382 }
383
384 return std::move(Accels);
385}
386
Marek Sokolowski72aa9372017-08-28 21:59:54 +0000387RCParser::ParseType RCParser::parseCursorResource() {
388 ASSIGN_OR_RETURN(Arg, readString());
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000389 return llvm::make_unique<CursorResource>(*Arg);
Marek Sokolowski72aa9372017-08-28 21:59:54 +0000390}
391
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000392RCParser::ParseType RCParser::parseDialogResource(bool IsExtended) {
393 // Dialog resources have the following format of the arguments:
394 // DIALOG: x, y, width, height [opt stmts...] {controls...}
395 // DIALOGEX: x, y, width, height [, helpID] [opt stmts...] {controls...}
396 // These are very similar, so we parse them together.
397 ASSIGN_OR_RETURN(LocResult, readIntsWithCommas(4, 4));
398
399 uint32_t HelpID = 0; // When HelpID is unset, it's assumed to be 0.
400 if (IsExtended && consumeOptionalType(Kind::Comma)) {
401 ASSIGN_OR_RETURN(HelpIDResult, readInt());
402 HelpID = *HelpIDResult;
403 }
404
Zachary Turner420090a2017-10-06 20:51:20 +0000405 ASSIGN_OR_RETURN(OptStatements, parseOptionalStatements(
406 IsExtended ? OptStmtType::DialogExStmt
407 : OptStmtType::DialogStmt));
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000408
409 assert(isNextTokenKind(Kind::BlockBegin) &&
410 "parseOptionalStatements, when successful, halts on BlockBegin.");
411 consume();
412
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000413 auto Dialog = llvm::make_unique<DialogResource>(
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000414 (*LocResult)[0], (*LocResult)[1], (*LocResult)[2], (*LocResult)[3],
415 HelpID, std::move(*OptStatements), IsExtended);
416
417 while (!consumeOptionalType(Kind::BlockEnd)) {
418 ASSIGN_OR_RETURN(ControlDefResult, parseControl());
419 Dialog->addControl(std::move(*ControlDefResult));
420 }
421
422 return std::move(Dialog);
423}
424
Marek Sokolowskib5f39a02017-09-29 00:14:18 +0000425RCParser::ParseType RCParser::parseUserDefinedResource(IntOrString Type) {
426 if (isEof())
427 return getExpectedError("filename, '{' or BEGIN");
428
429 // Check if this is a file resource.
430 if (look().kind() == Kind::String)
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000431 return llvm::make_unique<UserDefinedResource>(Type, read().value());
Marek Sokolowskib5f39a02017-09-29 00:14:18 +0000432
433 RETURN_IF_ERROR(consumeType(Kind::BlockBegin));
434 std::vector<IntOrString> Data;
435
436 // Consume comma before each consecutive token except the first one.
437 bool ConsumeComma = false;
438 while (!consumeOptionalType(Kind::BlockEnd)) {
439 if (ConsumeComma)
440 RETURN_IF_ERROR(consumeType(Kind::Comma));
441 ConsumeComma = true;
442
443 ASSIGN_OR_RETURN(Item, readIntOrString());
444 Data.push_back(*Item);
445 }
446
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000447 return llvm::make_unique<UserDefinedResource>(Type, std::move(Data));
Marek Sokolowskib5f39a02017-09-29 00:14:18 +0000448}
449
Marek Sokolowskifb74cb12017-09-28 22:41:38 +0000450RCParser::ParseType RCParser::parseVersionInfoResource() {
451 ASSIGN_OR_RETURN(FixedResult, parseVersionInfoFixed());
452 ASSIGN_OR_RETURN(BlockResult, parseVersionInfoBlockContents(StringRef()));
Marek Sokolowski99ead702017-09-28 23:12:53 +0000453 return llvm::make_unique<VersionInfoResource>(std::move(**BlockResult),
454 std::move(*FixedResult));
Marek Sokolowskifb74cb12017-09-28 22:41:38 +0000455}
456
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000457Expected<Control> RCParser::parseControl() {
458 // Each control definition (except CONTROL) follows one of the schemes below
459 // depending on the control class:
460 // [class] text, id, x, y, width, height [, style] [, exstyle] [, helpID]
461 // [class] id, x, y, width, height [, style] [, exstyle] [, helpID]
462 // Note that control ids must be integers.
Marek Sokolowski7f7745c2017-09-30 00:38:52 +0000463 // Text might be either a string or an integer pointing to resource ID.
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000464 ASSIGN_OR_RETURN(ClassResult, readIdentifier());
Marek Sokolowski75fa1732017-08-29 20:03:18 +0000465 std::string ClassUpper = ClassResult->upper();
Marek Sokolowski7f7745c2017-09-30 00:38:52 +0000466 auto CtlInfo = Control::SupportedCtls.find(ClassUpper);
467 if (CtlInfo == Control::SupportedCtls.end())
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000468 return getExpectedError("control type, END or '}'", true);
469
470 // Read caption if necessary.
Marek Sokolowski7f7745c2017-09-30 00:38:52 +0000471 IntOrString Caption{StringRef()};
472 if (CtlInfo->getValue().HasTitle) {
473 ASSIGN_OR_RETURN(CaptionResult, readIntOrString());
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000474 RETURN_IF_ERROR(consumeType(Kind::Comma));
475 Caption = *CaptionResult;
476 }
477
478 ASSIGN_OR_RETURN(Args, readIntsWithCommas(5, 8));
479
480 auto TakeOptArg = [&Args](size_t Id) -> Optional<uint32_t> {
Zachary Turner07bc04f2017-10-06 21:26:06 +0000481 return Args->size() > Id ? (uint32_t)(*Args)[Id] : Optional<uint32_t>();
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000482 };
483
484 return Control(*ClassResult, Caption, (*Args)[0], (*Args)[1], (*Args)[2],
485 (*Args)[3], (*Args)[4], TakeOptArg(5), TakeOptArg(6),
486 TakeOptArg(7));
487}
488
Martin Storsjo577b9812018-05-07 20:27:37 +0000489RCParser::ParseType RCParser::parseBitmapResource() {
490 ASSIGN_OR_RETURN(Arg, readString());
491 return llvm::make_unique<BitmapResource>(*Arg);
492}
493
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000494RCParser::ParseType RCParser::parseIconResource() {
495 ASSIGN_OR_RETURN(Arg, readString());
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000496 return llvm::make_unique<IconResource>(*Arg);
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000497}
498
Marek Sokolowski72aa9372017-08-28 21:59:54 +0000499RCParser::ParseType RCParser::parseHTMLResource() {
500 ASSIGN_OR_RETURN(Arg, readString());
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000501 return llvm::make_unique<HTMLResource>(*Arg);
Marek Sokolowski72aa9372017-08-28 21:59:54 +0000502}
503
Marek Sokolowski99ecb0e2017-08-28 23:46:30 +0000504RCParser::ParseType RCParser::parseMenuResource() {
505 ASSIGN_OR_RETURN(OptStatements, parseOptionalStatements());
506 ASSIGN_OR_RETURN(Items, parseMenuItemsList());
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000507 return llvm::make_unique<MenuResource>(std::move(*OptStatements),
508 std::move(*Items));
Marek Sokolowski99ecb0e2017-08-28 23:46:30 +0000509}
510
511Expected<MenuDefinitionList> RCParser::parseMenuItemsList() {
512 RETURN_IF_ERROR(consumeType(Kind::BlockBegin));
513
514 MenuDefinitionList List;
515
516 // Read a set of items. Each item is of one of three kinds:
517 // MENUITEM SEPARATOR
518 // MENUITEM caption:String, result:Int [, menu flags]...
519 // POPUP caption:String [, menu flags]... { items... }
520 while (!consumeOptionalType(Kind::BlockEnd)) {
521 ASSIGN_OR_RETURN(ItemTypeResult, readIdentifier());
522
523 bool IsMenuItem = ItemTypeResult->equals_lower("MENUITEM");
524 bool IsPopup = ItemTypeResult->equals_lower("POPUP");
525 if (!IsMenuItem && !IsPopup)
526 return getExpectedError("MENUITEM, POPUP, END or '}'", true);
527
528 if (IsMenuItem && isNextTokenKind(Kind::Identifier)) {
529 // Now, expecting SEPARATOR.
530 ASSIGN_OR_RETURN(SeparatorResult, readIdentifier());
531 if (SeparatorResult->equals_lower("SEPARATOR")) {
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000532 List.addDefinition(llvm::make_unique<MenuSeparator>());
Marek Sokolowski99ecb0e2017-08-28 23:46:30 +0000533 continue;
534 }
535
536 return getExpectedError("SEPARATOR or string", true);
537 }
538
539 // Not a separator. Read the caption.
540 ASSIGN_OR_RETURN(CaptionResult, readString());
541
542 // If MENUITEM, expect also a comma and an integer.
543 uint32_t MenuResult = -1;
544
545 if (IsMenuItem) {
546 RETURN_IF_ERROR(consumeType(Kind::Comma));
547 ASSIGN_OR_RETURN(IntResult, readInt());
548 MenuResult = *IntResult;
549 }
550
Marek Sokolowskic75a0872017-09-29 17:46:32 +0000551 ASSIGN_OR_RETURN(FlagsResult, parseFlags(MenuDefinition::OptionsStr,
552 MenuDefinition::OptionsFlags));
Marek Sokolowski99ecb0e2017-08-28 23:46:30 +0000553
554 if (IsPopup) {
555 // If POPUP, read submenu items recursively.
556 ASSIGN_OR_RETURN(SubMenuResult, parseMenuItemsList());
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000557 List.addDefinition(llvm::make_unique<PopupItem>(
558 *CaptionResult, *FlagsResult, std::move(*SubMenuResult)));
Marek Sokolowski99ecb0e2017-08-28 23:46:30 +0000559 continue;
560 }
561
562 assert(IsMenuItem);
563 List.addDefinition(
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000564 llvm::make_unique<MenuItem>(*CaptionResult, MenuResult, *FlagsResult));
Marek Sokolowski99ecb0e2017-08-28 23:46:30 +0000565 }
566
567 return std::move(List);
568}
569
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000570RCParser::ParseType RCParser::parseStringTableResource() {
571 ASSIGN_OR_RETURN(OptStatements, parseOptionalStatements());
572 RETURN_IF_ERROR(consumeType(Kind::BlockBegin));
573
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000574 auto Table =
575 llvm::make_unique<StringTableResource>(std::move(*OptStatements));
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000576
577 // Read strings until we reach the end of the block.
578 while (!consumeOptionalType(Kind::BlockEnd)) {
579 // Each definition consists of string's ID (an integer) and a string.
580 // Some examples in documentation suggest that there might be a comma in
581 // between, however we strictly adhere to the single statement definition.
582 ASSIGN_OR_RETURN(IDResult, readInt());
Martin Storsjo94102762018-05-07 20:27:28 +0000583 consumeOptionalType(Kind::Comma);
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000584 ASSIGN_OR_RETURN(StrResult, readString());
585 Table->addString(*IDResult, *StrResult);
586 }
587
588 return std::move(Table);
589}
590
Marek Sokolowskifb74cb12017-09-28 22:41:38 +0000591Expected<std::unique_ptr<VersionInfoBlock>>
592RCParser::parseVersionInfoBlockContents(StringRef BlockName) {
593 RETURN_IF_ERROR(consumeType(Kind::BlockBegin));
594
Marek Sokolowski99ead702017-09-28 23:12:53 +0000595 auto Contents = llvm::make_unique<VersionInfoBlock>(BlockName);
Marek Sokolowskifb74cb12017-09-28 22:41:38 +0000596
597 while (!isNextTokenKind(Kind::BlockEnd)) {
598 ASSIGN_OR_RETURN(Stmt, parseVersionInfoStmt());
599 Contents->addStmt(std::move(*Stmt));
600 }
601
602 consume(); // Consume BlockEnd.
603
604 return std::move(Contents);
605}
606
607Expected<std::unique_ptr<VersionInfoStmt>> RCParser::parseVersionInfoStmt() {
608 // Expect either BLOCK or VALUE, then a name or a key (a string).
609 ASSIGN_OR_RETURN(TypeResult, readIdentifier());
610
611 if (TypeResult->equals_lower("BLOCK")) {
612 ASSIGN_OR_RETURN(NameResult, readString());
613 return parseVersionInfoBlockContents(*NameResult);
614 }
615
616 if (TypeResult->equals_lower("VALUE")) {
617 ASSIGN_OR_RETURN(KeyResult, readString());
Zachary Turner07bc04f2017-10-06 21:26:06 +0000618 // Read a non-empty list of strings and/or ints, each
619 // possibly preceded by a comma. Unfortunately, the tool behavior depends
620 // on them existing or not, so we need to memorize where we found them.
Marek Sokolowskifb74cb12017-09-28 22:41:38 +0000621 std::vector<IntOrString> Values;
Zachary Turner07bc04f2017-10-06 21:26:06 +0000622 std::vector<bool> PrecedingCommas;
623 RETURN_IF_ERROR(consumeType(Kind::Comma));
624 while (!isNextTokenKind(Kind::Identifier) &&
625 !isNextTokenKind(Kind::BlockEnd)) {
626 // Try to eat a comma if it's not the first statement.
627 bool HadComma = Values.size() > 0 && consumeOptionalType(Kind::Comma);
Marek Sokolowskifb74cb12017-09-28 22:41:38 +0000628 ASSIGN_OR_RETURN(ValueResult, readIntOrString());
629 Values.push_back(*ValueResult);
Zachary Turner07bc04f2017-10-06 21:26:06 +0000630 PrecedingCommas.push_back(HadComma);
Marek Sokolowskifb74cb12017-09-28 22:41:38 +0000631 }
Zachary Turner07bc04f2017-10-06 21:26:06 +0000632 return llvm::make_unique<VersionInfoValue>(*KeyResult, std::move(Values),
633 std::move(PrecedingCommas));
Marek Sokolowskifb74cb12017-09-28 22:41:38 +0000634 }
635
636 return getExpectedError("BLOCK or VALUE", true);
637}
638
639Expected<VersionInfoResource::VersionInfoFixed>
640RCParser::parseVersionInfoFixed() {
641 using RetType = VersionInfoResource::VersionInfoFixed;
642 RetType Result;
643
644 // Read until the beginning of the block.
645 while (!isNextTokenKind(Kind::BlockBegin)) {
646 ASSIGN_OR_RETURN(TypeResult, readIdentifier());
647 auto FixedType = RetType::getFixedType(*TypeResult);
648
649 if (!RetType::isTypeSupported(FixedType))
650 return getExpectedError("fixed VERSIONINFO statement type", true);
651 if (Result.IsTypePresent[FixedType])
652 return getExpectedError("yet unread fixed VERSIONINFO statement type",
653 true);
654
655 // VERSION variations take multiple integers.
656 size_t NumInts = RetType::isVersionType(FixedType) ? 4 : 1;
657 ASSIGN_OR_RETURN(ArgsResult, readIntsWithCommas(NumInts, NumInts));
Zachary Turner07bc04f2017-10-06 21:26:06 +0000658 SmallVector<uint32_t, 4> ArgInts(ArgsResult->begin(), ArgsResult->end());
659 Result.setValue(FixedType, ArgInts);
Marek Sokolowskifb74cb12017-09-28 22:41:38 +0000660 }
661
662 return Result;
663}
664
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000665RCParser::ParseOptionType RCParser::parseLanguageStmt() {
666 ASSIGN_OR_RETURN(Args, readIntsWithCommas(/* min = */ 2, /* max = */ 2));
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000667 return llvm::make_unique<LanguageResource>((*Args)[0], (*Args)[1]);
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000668}
669
670RCParser::ParseOptionType RCParser::parseCharacteristicsStmt() {
671 ASSIGN_OR_RETURN(Arg, readInt());
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000672 return llvm::make_unique<CharacteristicsStmt>(*Arg);
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000673}
674
675RCParser::ParseOptionType RCParser::parseVersionStmt() {
676 ASSIGN_OR_RETURN(Arg, readInt());
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000677 return llvm::make_unique<VersionStmt>(*Arg);
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000678}
679
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000680RCParser::ParseOptionType RCParser::parseCaptionStmt() {
681 ASSIGN_OR_RETURN(Arg, readString());
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000682 return llvm::make_unique<CaptionStmt>(*Arg);
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000683}
684
Zachary Turner420090a2017-10-06 20:51:20 +0000685RCParser::ParseOptionType RCParser::parseFontStmt(OptStmtType DialogType) {
686 assert(DialogType != OptStmtType::BasicStmt);
687
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000688 ASSIGN_OR_RETURN(SizeResult, readInt());
689 RETURN_IF_ERROR(consumeType(Kind::Comma));
690 ASSIGN_OR_RETURN(NameResult, readString());
Zachary Turner420090a2017-10-06 20:51:20 +0000691
692 // Default values for the optional arguments.
693 uint32_t FontWeight = 0;
694 bool FontItalic = false;
695 uint32_t FontCharset = 1;
696 if (DialogType == OptStmtType::DialogExStmt) {
697 if (consumeOptionalType(Kind::Comma)) {
698 ASSIGN_OR_RETURN(Args, readIntsWithCommas(/* min = */ 0, /* max = */ 3));
699 if (Args->size() >= 1)
700 FontWeight = (*Args)[0];
701 if (Args->size() >= 2)
702 FontItalic = (*Args)[1] != 0;
703 if (Args->size() >= 3)
704 FontCharset = (*Args)[2];
705 }
706 }
707 return llvm::make_unique<FontStmt>(*SizeResult, *NameResult, FontWeight,
708 FontItalic, FontCharset);
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000709}
710
711RCParser::ParseOptionType RCParser::parseStyleStmt() {
712 ASSIGN_OR_RETURN(Arg, readInt());
Marek Sokolowski4a765da2017-09-29 00:33:57 +0000713 return llvm::make_unique<StyleStmt>(*Arg);
Marek Sokolowski4ac54d92017-08-29 16:49:59 +0000714}
715
Zachary Turner514b7102017-10-09 18:50:29 +0000716Error RCParser::getExpectedError(const Twine &Message, bool IsAlreadyRead) {
Marek Sokolowski5cd3d5c2017-08-18 18:24:17 +0000717 return make_error<ParserError>(
718 Message, IsAlreadyRead ? std::prev(CurLoc) : CurLoc, End);
719}
720
721} // namespace rc
722} // namespace llvm