[llvm-rc] Add support for the optional CLASS statement for dialogs

[amccarth]

tools/llvm-rc/ResourceScriptParser.cpp

788

The documentation is ambiguous and it's been a while since I've done this. The class can be a string, but it can also be an unsigned integer. Are those both parsed as quoted strings? Are you choosing to just handle the string case for now?

[mstorsjo]

tools/llvm-rc/ResourceScriptParser.cpp

788

You're right, this should probably be an IntOrString, will update.

[mstorsjo]

Changed String into IntOrString and changed the test to exercise both value types.

test/tools/llvm-rc/Inputs/tag-dialog-headers.rc

 22 DIALOGEX 4, 4, 4, 4 STYLE 0x00FF00FF {}
 23 DIALOG 4, 4, 4, 4 STYLE 0x00FF00FF {}
 
 24 DIALOGEX 5, 5, 5, 5 CAPTION "" STYLE 0 {}
 25 DIALOG 5, 5, 5, 5 CAPTION "" STYLE 0 {}
 
 26 DIALOGEX 1, 2, 3, 4, 5 {}
 
+27 DIALOGEX 5, 5, 5, 5 CLASS "Foobar" {}
+28 DIALOG 5, 5, 5, 5 CLASS 42 {}
+

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

 ; HEADERS-NEXT: Version (minor): 0
 ; HEADERS-NEXT: Characteristics: 0
 ; HEADERS-NEXT: Data size: 32
 ; HEADERS-NEXT: Data: (
 ; HEADERS-NEXT:   0000: 0100FFFF 05000000 00000000 00008880  |................|
 ; HEADERS-NEXT:   0010: 00000100 02000300 04000000 00000000  |................|
 ; HEADERS-NEXT: )
 
+; HEADERS-DAG: Resource type (int): 5
+; HEADERS-NEXT: Resource name (int): 27
+; HEADERS-NEXT: Data version: 0
+; HEADERS-NEXT: Memory flags: 0x1030
+; HEADERS-NEXT: Language ID: 1033
+; HEADERS-NEXT: Version (major): 0
+; HEADERS-NEXT: Version (minor): 0
+; HEADERS-NEXT: Characteristics: 0
+; HEADERS-NEXT: Data size: 44
+; HEADERS-NEXT: Data: (
+; HEADERS-NEXT:   0000: 0100FFFF 00000000 00000000 00008880  |................|
+; HEADERS-NEXT:   0010: 00000500 05000500 05000000 46006F00  |............F.o.|
+; HEADERS-NEXT:   0020: 6F006200 61007200 00000000           |o.b.a.r.....|
+; HEADERS-NEXT: )
+
+; HEADERS-DAG: Resource type (int): 5
+; HEADERS-NEXT: Resource name (int): 28
+; HEADERS-NEXT: Data version: 0
+; HEADERS-NEXT: Memory flags: 0x1030
+; HEADERS-NEXT: Language ID: 1033
+; HEADERS-NEXT: Version (major): 0
+; HEADERS-NEXT: Version (minor): 0
+; HEADERS-NEXT: Characteristics: 0
+; HEADERS-NEXT: Data size: 26
+; HEADERS-NEXT: Data: (
+; HEADERS-NEXT:   0000: 00008880 00000000 00000500 05000500  |................|
+; HEADERS-NEXT:   0010: 05000000 FFFF2A00 0000               |......*...|
+; HEADERS-NEXT: )
+
 
 ; RUN: not llvm-rc /FO %t %p/Inputs/tag-dialog-large-coord.rc 2>&1 | FileCheck %s --check-prefix COORD1
 
 ; COORD1: llvm-rc: Error in DIALOGEX statement (ID 1):
 ; COORD1-NEXT: Dialog x-coordinate (50000) does not fit in 16-bit signed integer type.
 
 
 ; RUN: not llvm-rc /FO %t %p/Inputs/tag-dialog-large-coord-neg.rc 2>&1 | FileCheck %s --check-prefix COORD2

tools/llvm-rc/ResourceFileWriter.h

public:
   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 visitClassStmt(const ClassStmt *) override;
   Error visitFontStmt(const FontStmt *) override;
   Error visitLanguageStmt(const LanguageResource *) override;
   Error visitStyleStmt(const StyleStmt *) override;
   Error visitVersionStmt(const VersionStmt *) override;
 
   // Stringtables are output at the end of .res file. We need a separate
   // function to do it.
   Error dumpAllStringTables();
struct ObjectInfo {
     struct FontInfo {
       uint32_t Size;
       StringRef Typeface;
       uint32_t Weight;
       bool IsItalic;
       uint32_t Charset;
     };
     Optional<FontInfo> Font;
+    IntOrString Class;
 
-    ObjectInfo() : LanguageInfo(0), Characteristics(0), VersionInfo(0) {}
+    ObjectInfo()
+        : LanguageInfo(0), Characteristics(0), VersionInfo(0),
+          Class(StringRef()) {}
   } ObjectData;
 
   struct StringTableInfo {
     // Each STRINGTABLE bundle depends on ID of the bundle and language
     // description.
     using BundleKey = std::pair<uint16_t, uint16_t>;
     // Each bundle is in fact an array of 16 strings.
     struct Bundle {

tools/llvm-rc/ResourceFileWriter.cpp

Error ResourceFileWriter::visitIconResource(const RCResource *Res) {
   return handleError(visitIconOrCursorResource(Res), Res);
 }
 
 Error ResourceFileWriter::visitCaptionStmt(const CaptionStmt *Stmt) {
   ObjectData.Caption = Stmt->Value;
   return Error::success();
 }
 
+Error ResourceFileWriter::visitClassStmt(const ClassStmt *Stmt) {
+  ObjectData.Class = Stmt->Value;
+  return Error::success();
+}
+
 Error ResourceFileWriter::visitHTMLResource(const RCResource *Res) {
   return writeResource(Res, &ResourceFileWriter::writeHTMLBody);
 }
 
 Error ResourceFileWriter::visitMenuResource(const RCResource *Res) {
   return writeResource(Res, &ResourceFileWriter::writeMenuBody);
 }
 
ulittle16_t DialogHeight;
            ulittle16_t(Res->Y), ulittle16_t(Res->Width),
            ulittle16_t(Res->Height)};
   writeObject(Middle);
 
   // MENU field. As of now, we don't keep them in the state and can peacefully
   // think there is no menu attached to the dialog.
   writeInt<uint16_t>(0);
 
-  // Window CLASS field. Not kept here.
-  writeInt<uint16_t>(0);
+  // Window CLASS field.
+  RETURN_IF_ERROR(writeIntOrString(ObjectData.Class));
 
   // Window title or a single word equal to 0.
   RETURN_IF_ERROR(writeCString(ObjectData.Caption));
 
   // If there *is* a window font declared, output its data.
   auto &Font = ObjectData.Font;
   if (Font) {
     writeInt<uint16_t>(Font->Size);

tools/llvm-rc/ResourceScriptParser.h

private:
   // Helper VERSIONINFO parser - read fixed VERSIONINFO statements.
   Expected<VersionInfoResource::VersionInfoFixed> parseVersionInfoFixed();
 
   // Optional statement parsers.
   ParseOptionType parseLanguageStmt();
   ParseOptionType parseCharacteristicsStmt();
   ParseOptionType parseVersionStmt();
   ParseOptionType parseCaptionStmt();
+  ParseOptionType parseClassStmt();
   ParseOptionType parseFontStmt(OptStmtType DialogType);
   ParseOptionType parseStyleStmt();
 
   // Raises an error. If IsAlreadyRead = false (default), this complains about
   // the token that couldn't be parsed. If the flag is on, this complains about
   // the correctly read token that makes no sense (that is, the current parser
   // state is beyond the erroneous token.)
   Error getExpectedError(const Twine &Message, bool IsAlreadyRead = false);

tools/llvm-rc/ResourceScriptParser.cpp

RCParser::parseSingleOptionalStatement(OptStmtType StmtsType) {
   if (TypeToken->equals_lower("LANGUAGE"))
     return parseLanguageStmt();
   if (TypeToken->equals_lower("VERSION"))
     return parseVersionStmt();
 
   if (StmtsType != OptStmtType::BasicStmt) {
     if (TypeToken->equals_lower("CAPTION"))
       return parseCaptionStmt();
+    if (TypeToken->equals_lower("CLASS"))
+      return parseClassStmt();
     if (TypeToken->equals_lower("FONT"))
       return parseFontStmt(StmtsType);
     if (TypeToken->equals_lower("STYLE"))
       return parseStyleStmt();
   }
 
   return getExpectedError("optional statement type, BEGIN or '{'",
                           /* IsAlreadyRead = */ true);
RCParser::ParseOptionType RCParser::parseVersionStmt() {
   return llvm::make_unique<VersionStmt>(*Arg);
 }
 
 RCParser::ParseOptionType RCParser::parseCaptionStmt() {
   ASSIGN_OR_RETURN(Arg, readString());
   return llvm::make_unique<CaptionStmt>(*Arg);
 }
 
+RCParser::ParseOptionType RCParser::parseClassStmt() {
+  ASSIGN_OR_RETURN(Arg, readIntOrString());
+  return llvm::make_unique<ClassStmt>(*Arg);
+}
+
 RCParser::ParseOptionType RCParser::parseFontStmt(OptStmtType DialogType) {
   assert(DialogType != OptStmtType::BasicStmt);
 
   ASSIGN_OR_RETURN(SizeResult, readInt());
   RETURN_IF_ERROR(consumeType(Kind::Comma));
   ASSIGN_OR_RETURN(NameResult, readString());
 
   // Default values for the optional arguments.

tools/llvm-rc/ResourceScriptStmt.h

public:
   uint32_t Value;
 
   StyleStmt(uint32_t Style) : Value(Style) {}
   raw_ostream &log(raw_ostream &) const override;
   Twine getResourceTypeName() const override { return "STYLE"; }
   Error visit(Visitor *V) const override { return V->visitStyleStmt(this); }
 };
 
+// CLASS optional statement.
+//
+// Ref: msdn.microsoft.com/en-us/library/windows/desktop/aa380883(v=vs.85).aspx
+class ClassStmt : public OptionalStmt {
+public:
+  IntOrString Value;
+
+  ClassStmt(IntOrString Class) : Value(Class) {}
+  raw_ostream &log(raw_ostream &) const override;
+  Twine getResourceTypeName() const override { return "CLASS"; }
+  Error visit(Visitor *V) const override { return V->visitClassStmt(this); }
+};
+
 } // namespace rc
 } // namespace llvm
 
 #endif

tools/llvm-rc/ResourceScriptStmt.cpp

 raw_ostream &VersionStmt::log(raw_ostream &OS) const {
   return OS << "Version: " << Value << "\n";
 }
 
 raw_ostream &CaptionStmt::log(raw_ostream &OS) const {
   return OS << "Caption: " << Value << "\n";
 }
 
+raw_ostream &ClassStmt::log(raw_ostream &OS) const {
+  return OS << "Class: " << Value << "\n";
+}
+
 raw_ostream &FontStmt::log(raw_ostream &OS) const {
   OS << "Font: size = " << Size << ", face = " << Name
      << ", weight = " << Weight;
   if (Italic)
     OS << ", italic";
   return OS << ", charset = " << Charset << "\n";
 }
 
 raw_ostream &StyleStmt::log(raw_ostream &OS) const {
   return OS << "Style: " << Value << "\n";
 }
 
 } // namespace rc
 } // namespace llvm

tools/llvm-rc/ResourceVisitor.h

 #include "llvm/Support/Error.h"
 
 namespace llvm {
 namespace rc {
 
 class RCResource;
 
 class CaptionStmt;
+class ClassStmt;
 class CharacteristicsStmt;
 class FontStmt;
 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;
 
   virtual Error visitCaptionStmt(const CaptionStmt *) = 0;
+  virtual Error visitClassStmt(const ClassStmt *) = 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