[llvm-rc] Implement the BITMAP resource type

[zturner]

tools/llvm-rc/ResourceFileWriter.cpp

705

Can you add a line above this constexpr size_t BITMAPFILEHEADER_size = 14; and then use this here and below?

[mstorsjo]

tools/llvm-rc/ResourceFileWriter.cpp

705

Sure, will do.

[amccarth]

tools/llvm-rc/ResourceFileWriter.cpp

708

Is alignment already guaranteed here?

[mstorsjo]

tools/llvm-rc/ResourceFileWriter.cpp

708

Yes; this is called from writeResource, which aligns the stream before writing the resource header, and then calls this.

test/tools/llvm-rc/include-paths.test

 ; contains the resource being searched for.  Do this test last since it
 ; changes the current working directory and could affect the success or
 ; failure of other tests if run first.
 ; RUN: rm -f %t.nested-include.res
 ; RUN: cd %p/Inputs/nested
 ; RUN: llvm-rc /FO %t.nested-include.res %p/Inputs/include.rc
 ; RUN: llvm-readobj %t.nested-include.res | FileCheck --check-prefix=FOUND %s
 
-FOUND:      Resource type (string): BITMAP
+FOUND:      Resource type (int): 2
 FOUND-NEXT: Resource name (string): FOO
 FOUND-NEXT: Data version: 0
 FOUND-NEXT: Memory flags: 0x30
 FOUND-NEXT: Language ID: 1033
 FOUND-NEXT: Version (major): 0
 FOUND-NEXT: Version (minor): 0
 FOUND-NEXT: Characteristics: 0
-FOUND-NEXT: Data size: 110
+FOUND-NEXT: Data size: 96
 FOUND-NEXT: Data: (
-FOUND-NEXT:   0000: 424D6E00 00000000 00003600 00002800  |BMn.......6...(.|
-FOUND-NEXT:   0010: 00000200 00000700 00000100 18000000  |................|
-FOUND-NEXT:   0020: 00003800 00000000 00000000 00000000  |..8.............|
-FOUND-NEXT:   0030: 00000000 00005BB3 855BB385 0000FFFF  |......[..[......|
-FOUND-NEXT:   0040: FFFFFFFF 0000FFFF FFFFFFFF 0000FFFF  |................|
-FOUND-NEXT:   0050: FFFFFFFF 00005BB3 85FFFFFF 0000FFFF  |......[.........|
-FOUND-NEXT:   0060: FF0EC9FF 0000241C EDFFFFFF 0000      |......$.......|
+FOUND-NEXT:   0000: 28000000 02000000 07000000 01001800  |(...............|
+FOUND-NEXT:   0010: 00000000 38000000 00000000 00000000  |....8...........|
+FOUND-NEXT:   0020: 00000000 00000000 5BB3855B B3850000  |........[..[....|
+FOUND-NEXT:   0030: FFFFFFFF FFFF0000 FFFFFFFF FFFF0000  |................|
+FOUND-NEXT:   0040: FFFFFFFF FFFF0000 5BB385FF FFFF0000  |........[.......|
+FOUND-NEXT:   0050: FFFFFF0E C9FF0000 241CEDFF FFFF0000  |........$.......|
 FOUND-NEXT: )
 
 MISSING:      llvm-rc: Error in BITMAP statement (ID foo):
 MISSING-NEXT: error : file not found : nested-bitmap.bmp

tools/llvm-rc/ResourceFileWriter.h

private:
   // NullResource
   Error writeNullBody(const RCResource *);
 
   // AcceleratorsResource
   Error writeSingleAccelerator(const AcceleratorsResource::Accelerator &,
                                bool IsLastItem);
   Error writeAcceleratorsBody(const RCResource *);
 
+  // BitmapResource
+  Error visitBitmapResource(const RCResource *);
+  Error writeBitmapBody(const RCResource *);
+
   // CursorResource and IconResource
   Error visitIconOrCursorResource(const RCResource *);
   Error visitIconOrCursorGroup(const RCResource *);
   Error visitSingleIconOrCursor(const RCResource *);
   Error writeSingleIconOrCursorBody(const RCResource *);
   Error writeIconOrCursorGroupBody(const RCResource *);
 
   // DialogResource

tools/llvm-rc/ResourceFileWriter.cpp

 Error ResourceFileWriter::visitNullResource(const RCResource *Res) {
   return writeResource(Res, &ResourceFileWriter::writeNullBody);
 }
 
 Error ResourceFileWriter::visitAcceleratorsResource(const RCResource *Res) {
   return writeResource(Res, &ResourceFileWriter::writeAcceleratorsBody);
 }
 
+Error ResourceFileWriter::visitBitmapResource(const RCResource *Res) {
+  return writeResource(Res, &ResourceFileWriter::writeBitmapBody);
+}
+
 Error ResourceFileWriter::visitCursorResource(const RCResource *Res) {
   return handleError(visitIconOrCursorResource(Res), Res);
 }
 
 Error ResourceFileWriter::visitDialogResource(const RCResource *Res) {
   return writeResource(Res, &ResourceFileWriter::writeDialogBody);
 }
 
Error ResourceFileWriter::writeAcceleratorsBody(const RCResource *Base) {
   for (auto &Acc : Res->Accelerators) {
     ++AcceleratorId;
     RETURN_IF_ERROR(
         writeSingleAccelerator(Acc, AcceleratorId == Res->Accelerators.size()));
   }
   return Error::success();
 }
 
+// --- BitmapResource helpers. --- //
+
+Error ResourceFileWriter::writeBitmapBody(const RCResource *Base) {
+  StringRef Filename = cast<BitmapResource>(Base)->BitmapLoc;
+  bool IsLong;
+  stripQuotes(Filename, IsLong);
+
+  auto File = loadFile(Filename);
+  if (!File)
+    return File.takeError();
+
+  StringRef Buffer = (*File)->getBuffer();
+
+  // Skip the 14 byte BITMAPFILEHEADER.
+  if (Buffer.size() < 14 || Buffer[0] != 'B' || Buffer[1] != 'M')
+    return createError("Incorrect bitmap file.");
+
+  *FS << Buffer.substr(14);
+  return Error::success();
+}
+
 // --- CursorResource and IconResource helpers. --- //
 
 // ICONRESDIR structure. Describes a single icon in resouce group.
 //
 // Ref: msdn.microsoft.com/en-us/library/windows/desktop/ms648016.aspx
 struct IconResDir {
   uint8_t Width;
   uint8_t Height;

tools/llvm-rc/ResourceScriptParser.h

private:
 
   // 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();

tools/llvm-rc/ResourceScriptParser.cpp

RCParser::ParseType RCParser::parseSingleResource() {
   // read resource type;
   ASSIGN_OR_RETURN(TypeToken, readTypeOrName());
 
   ParseType Result = std::unique_ptr<RCResource>();
   (void)!Result;
 
   if (TypeToken->equalsLower("ACCELERATORS"))
     Result = parseAcceleratorsResource();
+  else if (TypeToken->equalsLower("BITMAP"))
+    Result = parseBitmapResource();
   else if (TypeToken->equalsLower("CURSOR"))
     Result = parseCursorResource();
   else if (TypeToken->equalsLower("DIALOG"))
     Result = parseDialogResource(false);
   else if (TypeToken->equalsLower("DIALOGEX"))
     Result = parseDialogResource(true);
   else if (TypeToken->equalsLower("HTML"))
     Result = parseHTMLResource();
auto TakeOptArg = [&Args](size_t Id) -> Optional<uint32_t> {
     return Args->size() > Id ? (uint32_t)(*Args)[Id] : Optional<uint32_t>();
   };
 
   return Control(*ClassResult, Caption, (*Args)[0], (*Args)[1], (*Args)[2],
                  (*Args)[3], (*Args)[4], TakeOptArg(5), TakeOptArg(6),
                  TakeOptArg(7));
 }
 
+RCParser::ParseType RCParser::parseBitmapResource() {
+  ASSIGN_OR_RETURN(Arg, readString());
+  return llvm::make_unique<BitmapResource>(*Arg);
+}
+
 RCParser::ParseType RCParser::parseIconResource() {
   ASSIGN_OR_RETURN(Arg, readString());
   return llvm::make_unique<IconResource>(*Arg);
 }
 
 RCParser::ParseType RCParser::parseHTMLResource() {
   ASSIGN_OR_RETURN(Arg, readString());
   return llvm::make_unique<HTMLResource>(*Arg);

tools/llvm-rc/ResourceScriptStmt.h

 };
 
 enum ResourceKind {
   // These resource kinds have corresponding .res resource type IDs
   // (TYPE in RESOURCEHEADER structure). The numeric value assigned to each
   // kind is equal to this type ID.
   RkNull = 0,
   RkSingleCursor = 1,
+  RkBitmap = 2,
   RkSingleIcon = 3,
   RkMenu = 4,
   RkDialog = 5,
   RkStringTableBundle = 6,
   RkAccelerators = 9,
   RkCursorGroup = 12,
   RkIconGroup = 14,
   RkVersionInfo = 16,
Error visit(Visitor *V) const override {
     return V->visitAcceleratorsResource(this);
   }
   ResourceKind getKind() const override { return RkAccelerators; }
   static bool classof(const RCResource *Res) {
     return Res->getKind() == RkAccelerators;
   }
 };
 
+// BITMAP resource. Represents a bitmap (".bmp") file.
+//
+// Ref: msdn.microsoft.com/en-us/library/windows/desktop/aa380680(v=vs.85).aspx
+class BitmapResource : public RCResource {
+public:
+  StringRef BitmapLoc;
+
+  BitmapResource(StringRef Location) : BitmapLoc(Location) {}
+  raw_ostream &log(raw_ostream &) const override;
+
+  IntOrString getResourceType() const override { return RkBitmap; }
+  uint16_t getMemoryFlags() const override { return MfPure | MfMoveable; }
+
+  Twine getResourceTypeName() const override { return "BITMAP"; }
+  Error visit(Visitor *V) const override {
+    return V->visitBitmapResource(this);
+  }
+  ResourceKind getKind() const override { return RkBitmap; }
+  static bool classof(const RCResource *Res) {
+    return Res->getKind() == RkBitmap;
+  }
+};
+
 // CURSOR resource. Represents a single cursor (".cur") file.
 //
 // Ref: msdn.microsoft.com/en-us/library/windows/desktop/aa380920(v=vs.85).aspx
 class CursorResource : public RCResource {
 public:
   StringRef CursorLoc;
 
   CursorResource(StringRef Location) : CursorLoc(Location) {}

tools/llvm-rc/ResourceScriptStmt.cpp

for (const auto &Acc : Accelerators) {
     for (size_t i = 0; i < Accelerator::NumFlags; ++i)
       if (Acc.Flags & Accelerator::OptionsFlags[i])
         OS << " " << Accelerator::OptionsStr[i];
     OS << "\n";
   }
   return OS;
 }
 
+raw_ostream &BitmapResource::log(raw_ostream &OS) const {
+  return OS << "Bitmap (" << ResName << "): " << BitmapLoc << "\n";
+}
+
 raw_ostream &CursorResource::log(raw_ostream &OS) const {
   return OS << "Cursor (" << ResName << "): " << CursorLoc << "\n";
 }
 
 raw_ostream &IconResource::log(raw_ostream &OS) const {
   return OS << "Icon (" << ResName << "): " << IconLoc << "\n";
 }
 

tools/llvm-rc/ResourceVisitor.h

 class LanguageResource;
 class StyleStmt;
 class VersionStmt;
 
 class Visitor {
 public:
   virtual Error visitNullResource(const RCResource *) = 0;
   virtual Error visitAcceleratorsResource(const RCResource *) = 0;
+  virtual Error visitBitmapResource(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;