[llvm-rc] Serialize user-defined resources to .res files (serialization, pt 9).

[mnbvmar]

Summary

This allows rc to serialize user-defined resources, as documented in msdn.microsoft.com/en-us/library/windows/desktop/aa381054.aspx.

Escape sequences are yet unavailable, and are to be added in one of child patches.

llvm/test/tools/llvm-rc/Inputs/tag-user.rc

+500 500 {
+  1, 2, 3, 4, 5, "data", L"wide data", 0xABCD, 0xABCDEF01L
+}
+
+NAME1 NAME2 {}
+
+600 600 "bitmap.bmp"
+

llvm/test/tools/llvm-rc/tag-user.test

+; RUN: rm -rf %t
+; RUN: mkdir %t
+; RUN: cd %t
+; RUN: cp %p/Inputs/bitmap.bmp .
+; RUN: llvm-rc /FO %t/tag-user.res %p/Inputs/tag-user.rc
+; RUN: llvm-readobj %t/tag-user.res | FileCheck %s
+
+; CHECK:      Resource type (int): 500
+; CHECK-NEXT: Resource name (int): 500
+; CHECK-NEXT: Data version: 0
+; CHECK-NEXT: Memory flags: 0x30
+; CHECK-NEXT: Language ID: 1033
+; CHECK-NEXT: Version (major): 0
+; CHECK-NEXT: Version (minor): 0
+; CHECK-NEXT: Characteristics: 0
+; CHECK-NEXT: Data size: 38
+; CHECK-NEXT: Data: (
+; CHECK-NEXT:   0000: 01000200 03000400 05006461 74617700  |..........dataw.|
+; CHECK-NEXT:   0010: 69006400 65002000 64006100 74006100  |i.d.e. .d.a.t.a.|
+; CHECK-NEXT:   0020: CDAB01EF CDAB                        |......|
+; CHECK-NEXT: )
+
+; CHECK-DAG:  Resource type (string): NAME2
+; CHECK-NEXT: Resource name (string): NAME1
+; CHECK-NEXT: Data version: 0
+; CHECK-NEXT: Memory flags: 0x30
+; CHECK-NEXT: Language ID: 1033
+; CHECK-NEXT: Version (major): 0
+; CHECK-NEXT: Version (minor): 0
+; CHECK-NEXT: Characteristics: 0
+; CHECK-NEXT: Data size: 0
+; CHECK-NEXT: Data:: ()
+
+; CHECK-DAG:  Resource type (int): 600
+; CHECK-NEXT: Resource name (int): 600
+; CHECK-NEXT: Data version: 0
+; CHECK-NEXT: Memory flags: 0x30
+; CHECK-NEXT: Language ID: 1033
+; CHECK-NEXT: Version (major): 0
+; CHECK-NEXT: Version (minor): 0
+; CHECK-NEXT: Characteristics: 0
+; CHECK-NEXT: Data size: 110
+; CHECK-NEXT: Data: (
+; CHECK-NEXT:   0000: 424D6E00 00000000 00003600 00002800  |BMn.......6...(.|
+; CHECK-NEXT:   0010: 00000200 00000700 00000100 18000000  |................|
+; CHECK-NEXT:   0020: 00003800 00000000 00000000 00000000  |..8.............|
+; CHECK-NEXT:   0030: 00000000 00005BB3 855BB385 0000FFFF  |......[..[......|
+; CHECK-NEXT:   0040: FFFFFFFF 0000FFFF FFFFFFFF 0000FFFF  |................|
+; CHECK-NEXT:   0050: FFFFFFFF 00005BB3 85FFFFFF 0000FFFF  |......[.........|
+; CHECK-NEXT:   0060: FF0EC9FF 0000241C EDFFFFFF 0000      |......$.......|
+; CHECK-NEXT: )
+
+

llvm/tools/llvm-rc/ResourceFileWriter.h

public:
   Error visitAcceleratorsResource(const RCResource *) override;
   Error visitCursorResource(const RCResource *) override;
   Error visitDialogResource(const RCResource *) override;
   Error visitHTMLResource(const RCResource *) override;
   Error visitIconResource(const RCResource *) override;
   Error visitMenuResource(const RCResource *) override;
   Error visitVersionInfoResource(const RCResource *) override;
   Error visitStringTableResource(const RCResource *) override;
+  Error visitUserDefinedResource(const RCResource *) override;
 
   Error visitCaptionStmt(const CaptionStmt *) override;
   Error visitCharacteristicsStmt(const CharacteristicsStmt *) override;
   Error visitFontStmt(const FontStmt *) override;
   Error visitLanguageStmt(const LanguageResource *) override;
   Error visitStyleStmt(const StyleStmt *) override;
   Error visitVersionStmt(const VersionStmt *) override;
 
private:
   Error writeMenuBody(const RCResource *);
 
   // StringTableResource
   Error visitStringTableBundle(const RCResource *);
   Error writeStringTableBundleBody(const RCResource *);
   Error insertStringIntoBundle(StringTableInfo::Bundle &Bundle,
                                uint16_t StringID, StringRef String);
 
+  // User defined resource
+  Error writeUserDefinedBody(const RCResource *);
+
   // VersionInfoResource
   Error writeVersionInfoBody(const RCResource *);
   Error writeVersionInfoBlock(const VersionInfoBlock &);
   Error writeVersionInfoValue(const VersionInfoValue &);
 
   // Output stream handling.
   std::unique_ptr<raw_fd_ostream> FS;
 

llvm/tools/llvm-rc/ResourceFileWriter.cpp

for (auto &String : Res->Table) {
 
     RETURN_IF_ERROR(
         insertStringIntoBundle(Iter->second, String.first, String.second));
   }
 
   return Error::success();
 }
 
+Error ResourceFileWriter::visitUserDefinedResource(const RCResource *Res) {
+  return writeResource(Res, &ResourceFileWriter::writeUserDefinedBody);
+}
 
 Error ResourceFileWriter::visitVersionInfoResource(const RCResource *Res) {
   return writeResource(Res, &ResourceFileWriter::writeVersionInfoBody);
 }
 
 Error ResourceFileWriter::visitCharacteristicsStmt(
     const CharacteristicsStmt *Stmt) {
   ObjectData.Characteristics = Stmt->Value;
for (auto Key : StringTableData.BundleList) {
     BundleResource Res(Iter->second);
     // Bundle #(k+1) contains keys [16k, 16k + 15].
     Res.setName(Key.first + 1);
     RETURN_IF_ERROR(visitStringTableBundle(&Res));
   }
   return Error::success();
 }
 
+// --- UserDefinedResource helpers. --- //
+
+Error ResourceFileWriter::writeUserDefinedBody(const RCResource *Base) {
+  auto *Res = cast<UserDefinedResource>(Base);
+
+  if (Res->IsFileResource)
+    return appendFile(Res->FileLoc);
+
+  for (auto &Elem : Res->Contents) {
+    if (Elem.isInt()) {
+      RETURN_IF_ERROR(
+          checkRCInt(Elem.getInt(), "Number in user-defined resource"));
+      writeRCInt(Elem.getInt());
+      continue;
+    }
+
+    SmallVector<UTF16, 128> ProcessedString;
+    bool IsLongString;
+    RETURN_IF_ERROR(processString(Elem.getString(),
+                                  NullHandlingMethod::UserResource,
+                                  IsLongString, ProcessedString));
+
+    for (auto Ch : ProcessedString) {
+      if (IsLongString) {
+        writeObject(ulittle16_t(Ch));
+        continue;
+      }
+
+      RETURN_IF_ERROR(checkNumberFits<uint8_t>(
+          Ch, "Character in narrow string in user-defined resoutce"));
+      writeObject(uint8_t(Ch));
+    }
+  }
+
+  return Error::success();
+}
+
 // --- VersionInfoResourceResource helpers. --- //
 
 Error ResourceFileWriter::writeVersionInfoBlock(const VersionInfoBlock &Blk) {
   // Output the header if the block has name.
   bool OutputHeader = Blk.Name != "";
   uint64_t LengthLoc;
 
   if (OutputHeader) {

llvm/tools/llvm-rc/ResourceScriptStmt.h

static bool classof(const RCResource *Res) {
     return Res->getKind() == RkDialog;
   }
 };
 
 // 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 {
+public:
   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;
+  IntOrString getResourceType() const override { return Type; }
+  Twine getResourceTypeName() const override { return Type; }
+  uint16_t getMemoryFlags() const override { return MfPure | MfMoveable; }
+
+  Error visit(Visitor *V) const override {
+    return V->visitUserDefinedResource(this);
+  }
+  ResourceKind getKind() const override { return RkUser; }
+  static bool classof(const RCResource *Res) {
+    return Res->getKind() == RkUser;
+  }
 };
 
 // -- 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

llvm/tools/llvm-rc/ResourceVisitor.h

public:
   virtual Error visitNullResource(const RCResource *) = 0;
   virtual Error visitAcceleratorsResource(const RCResource *) = 0;
   virtual Error visitCursorResource(const RCResource *) = 0;
   virtual Error visitDialogResource(const RCResource *) = 0;
   virtual Error visitHTMLResource(const RCResource *) = 0;
   virtual Error visitIconResource(const RCResource *) = 0;
   virtual Error visitMenuResource(const RCResource *) = 0;
   virtual Error visitStringTableResource(const RCResource *) = 0;
+  virtual Error visitUserDefinedResource(const RCResource *) = 0;
   virtual Error visitVersionInfoResource(const RCResource *) = 0;
 
   virtual Error visitCaptionStmt(const CaptionStmt *) = 0;
   virtual Error visitCharacteristicsStmt(const CharacteristicsStmt *) = 0;
   virtual Error visitFontStmt(const FontStmt *) = 0;
   virtual Error visitLanguageStmt(const LanguageResource *) = 0;
   virtual Error visitStyleStmt(const StyleStmt *) = 0;
   virtual Error visitVersionStmt(const VersionStmt *) = 0;
 
   virtual ~Visitor() {}
 };
 
 } // namespace rc
 } // namespace llvm
 
 #endif