[llvm-rc] Add user-defined resources parsing ability. [8/8]

[mnbvmar]

Summary

This allows llvm-rc to parse user-defined resources (ref: msdn.microsoft.com/en-us/library/windows/desktop/aa381054(v=vs.85).aspx). These statements either import files, or put the specified raw data in the resulting resource file.

[ecbeckmann]

Looks fine to me.

[mnbvmar]

Change temporary files into pipes in testing infrastructure.

[rnk]

lgtm

llvm/test/tools/llvm-rc/Inputs/parser-correct-everything.rc

BEGIN
     END
 
     BLOCK "VarFileInfo"
     BEGIN
         VALUE "Translation", 0x409, 1252
 
     END
 END
+
+MYNAME MYTYPE "filename"
+
+500 600 "other filename"
+
+HELLO INTEGERS {1, 2, 3, 4}
+
+HELLO STRINGS {"1", "2", "3", "4"}
+
+4 MIXED {1, "2", 3, "4"}

llvm/test/tools/llvm-rc/Inputs/parser-user-invalid-contents.rc

+MYNAME MYTYPE
+BEGIN
+  1, 2, InvalidToken
+END

llvm/test/tools/llvm-rc/parser.test

 ; PGOOD-NEXT:    "ProductName" => "ii" 2 3
 ; PGOOD-NEXT:    "ProductVersion" =>
 ; PGOOD-NEXT:    End of block
 ; PGOOD-NEXT:    End of block
 ; PGOOD-NEXT:    Start of block (name: "VarFileInfo")
 ; PGOOD-NEXT:    "Translation" => 1033 1252
 ; PGOOD-NEXT:    End of block
 ; PGOOD-NEXT:    End of block
+; PGOOD-NEXT:    User-defined (type: MYTYPE, name: MYNAME): "filename"
+; PGOOD-NEXT:    User-defined (type: 600, name: 500): "other filename"
+; PGOOD-NEXT:    User-defined (type: INTEGERS, name: HELLO): data = 1 2 3 4
+; PGOOD-NEXT:    User-defined (type: STRINGS, name: HELLO): data = "1" "2" "3" "4"
+; PGOOD-NEXT:    User-defined (type: MIXED, name: 4): data = 1 "2" 3 "4"
+
 
 
 ; RUN: not llvm-rc /V %p/Inputs/parser-stringtable-no-string.rc 2> %t2
 ; RUN: FileCheck %s --check-prefix PSTRINGTABLE1 --input-file %t2
 
 ; PSTRINGTABLE1:  llvm-rc: Error parsing file: expected string, got }
 
 

 ; RUN: FileCheck %s --check-prefix PNONSENSE1 --input-file %t6
 
 ; PNONSENSE1:  llvm-rc: Error parsing file: expected int or identifier, got &
 
 
 ; RUN: not llvm-rc /V %p/Inputs/parser-nonsense-type.rc 2> %t7
 ; RUN: FileCheck %s --check-prefix PNONSENSE2 --input-file %t7
 
-; PNONSENSE2:  llvm-rc: Error parsing file: expected resource type, got WORLD
+; PNONSENSE2:  llvm-rc: Error parsing file: expected filename, '{' or BEGIN, got <EOF>
 
 
 ; RUN: not llvm-rc /V %p/Inputs/parser-nonsense-type-eof.rc 2> %t8
 ; RUN: FileCheck %s --check-prefix PNONSENSE3 --input-file %t8
 
 ; PNONSENSE3:  llvm-rc: Error parsing file: expected int or identifier, got <EOF>
 
 

 
 ; PVERSIONINFO4:  llvm-rc: Error parsing file: expected string, got END
 
 
 ; RUN: not llvm-rc /V %p/Inputs/parser-versioninfo-bad-type.rc 2> %t26
 ; RUN: FileCheck %s --check-prefix PVERSIONINFO5 --input-file %t26
 
 ; PVERSIONINFO5:  llvm-rc: Error parsing file: expected BLOCK or VALUE, got INCORRECT
+
+
+; RUN: not llvm-rc /V %p/Inputs/parser-user-invalid-contents.rc 2> %t27
+; RUN: FileCheck %s --check-prefix PUSER1 --input-file %t27
+
+; PUSER1:  llvm-rc: Error parsing file: expected int or string, got InvalidToken

llvm/tools/llvm-rc/ResourceScriptParser.h

private:
   ParseType parseLanguageResource();
   ParseType parseAcceleratorsResource();
   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();
 

llvm/tools/llvm-rc/ResourceScriptParser.cpp

else if (TypeToken->equalsLower("ICON"))
     Result = parseIconResource();
   else if (TypeToken->equalsLower("HTML"))
     Result = parseHTMLResource();
   else if (TypeToken->equalsLower("MENU"))
     Result = parseMenuResource();
   else if (TypeToken->equalsLower("VERSIONINFO"))
     Result = parseVersionInfoResource();
   else
-    return getExpectedError("resource type", /* IsAlreadyRead = */ true);
+    Result = parseUserDefinedResource(*TypeToken);
 
   if (Result)
     (*Result)->setName(*NameToken);
 
   return Result;
 }
 
 bool RCParser::isNextTokenKind(Kind TokenKind) const {
RCParser::ParseType RCParser::parseDialogResource(bool IsExtended) {
   while (!consumeOptionalType(Kind::BlockEnd)) {
     ASSIGN_OR_RETURN(ControlDefResult, parseControl());
     Dialog->addControl(std::move(*ControlDefResult));
   }
 
   return std::move(Dialog);
 }
 
+RCParser::ParseType RCParser::parseUserDefinedResource(IntOrString Type) {
+  if (isEof())
+    return getExpectedError("filename, '{' or BEGIN");
+
+  // Check if this is a file resource.
+  if (look().kind() == Kind::String)
+    return make_unique<UserDefinedResource>(Type, read().value());
+
+  RETURN_IF_ERROR(consumeType(Kind::BlockBegin));
+  std::vector<IntOrString> Data;
+
+  // Consume comma before each consecutive token except the first one.
+  bool ConsumeComma = false;
+  while (!consumeOptionalType(Kind::BlockEnd)) {
+    if (ConsumeComma)
+      RETURN_IF_ERROR(consumeType(Kind::Comma));
+    ConsumeComma = true;
+
+    ASSIGN_OR_RETURN(Item, readIntOrString());
+    Data.push_back(*Item);
+  }
+
+  return make_unique<UserDefinedResource>(Type, std::move(Data));
+}
+
 RCParser::ParseType RCParser::parseVersionInfoResource() {
   ASSIGN_OR_RETURN(FixedResult, parseVersionInfoFixed());
   ASSIGN_OR_RETURN(BlockResult, parseVersionInfoBlockContents(StringRef()));
   return make_unique<VersionInfoResource>(std::move(**BlockResult),
                                           std::move(*FixedResult));
 }
 
 Expected<Control> RCParser::parseControl() {

llvm/tools/llvm-rc/ResourceScriptStmt.h

DialogResource(uint32_t PosX, uint32_t PosY, uint32_t DlgWidth,
       : X(PosX), Y(PosY), Width(DlgWidth), Height(DlgHeight), HelpID(DlgHelpID),
         OptStatements(std::move(OptStmts)), IsExtended(IsDialogEx) {}
 
   void addControl(Control &&Ctl) { Controls.push_back(std::move(Ctl)); }
 
   raw_ostream &log(raw_ostream &) const override;
 };
 
+// User-defined resource. It is either:
+//   * a link to the file, e.g. NAME TYPE "filename",
+//   * or contains a list of integers and strings, e.g. NAME TYPE {1, "a", 2}.
+class UserDefinedResource : public RCResource {
+  IntOrString Type;
+  StringRef FileLoc;
+  std::vector<IntOrString> Contents;
+  bool IsFileResource;
+
+public:
+  UserDefinedResource(IntOrString ResourceType, StringRef FileLocation)
+      : Type(ResourceType), FileLoc(FileLocation), IsFileResource(true) {}
+  UserDefinedResource(IntOrString ResourceType, std::vector<IntOrString> &&Data)
+      : Type(ResourceType), Contents(std::move(Data)), IsFileResource(false) {}
+
+  raw_ostream &log(raw_ostream &) const override;
+};
+
 // -- VERSIONINFO resource and its helper classes --
 //
 // This resource lists the version information on the executable/library.
 // The declaration consists of the following items:
 //   * A number of fixed optional version statements (e.g. FILEVERSION, FILEOS)
 //   * BEGIN
 //   * A number of BLOCK and/or VALUE statements. BLOCK recursively defines
 //       another block of version information, whereas VALUE defines a

llvm/tools/llvm-rc/ResourceScriptStmt.cpp

 }
 
 raw_ostream &VersionInfoResource::log(raw_ostream &OS) const {
   OS << "VersionInfo (" << ResName << "):\n";
   FixedData.log(OS);
   return MainBlock.log(OS);
 }
 
+raw_ostream &UserDefinedResource::log(raw_ostream &OS) const {
+  OS << "User-defined (type: " << Type << ", name: " << ResName << "): ";
+  if (IsFileResource)
+    return OS << FileLoc << "\n";
+  OS << "data = ";
+  for (auto &Item : Contents)
+    OS << Item << " ";
+  return OS << "\n";
+}
+
 raw_ostream &CharacteristicsStmt::log(raw_ostream &OS) const {
   return OS << "Characteristics: " << Value << "\n";
 }
 
 raw_ostream &VersionStmt::log(raw_ostream &OS) const {
   return OS << "Version: " << Value << "\n";
 }