[llvm-rc] Support '--' for delimiting options from input paths

[mstorsjo]

Summary

This allows avoiding conflicts between paths that begin with the same chars as some llvm-rc options (which can be used with either slashes or dashes).

It turned out that handling of -- for separating options from input paths isn't a built-in feature in the Options library, but within e.g. clang it's handled manually as part of a loop that iterates over input arguments.

[zturner]

tools/llvm-rc/llvm-rc.cpp

91

Should this be " -- "? I don't think llvm-rc.exe foo--bar should trigger this, that's one argument that happens to have 2 dashes.

[mstorsjo]

tools/llvm-rc/llvm-rc.cpp

91

Yes, but this is strcmp on a per-argument basis, not strstr on the concatenated command line. strcmp("foo--bar", "--") doesn't return 0.

[zturner]

tools/llvm-rc/llvm-rc.cpp

91

Ahh, right. Not sure how I missed that. I think it would still compile if you made the lambda function take a StringRef and then just wrote return str == "--";. If that works, then I'd request that change. If it doesn't though, LGTM as-is.

[mstorsjo]

tools/llvm-rc/llvm-rc.cpp

91

Right - yes, that works. Will change it that way (and rename str to Str) before committing.

[mstorsjo]

Using a lambda that takes StringRef, renamed the lambda parameter to match coding conventions. Will commit tomorrow.

[eugenis]

llvm/trunk/test/tools/llvm-rc/tag-accelerators.test

82 ↗

(On Diff #181983)

Hi! I think you missed a spot here (and in a hundred other places).
I'll upload a patch.

test/tools/llvm-rc/absolute.test

 ; RUN: touch %t.manifest
 ; RUN: echo "1 24 \"%t.manifest\"" > %t.rc
-; RUN: llvm-rc %t.rc
+; RUN: llvm-rc -- %t.rc

test/tools/llvm-rc/codepage.test

-; RUN: llvm-rc /C 65001 /FO %t.utf8.res %p/Inputs/utf8.rc
+; RUN: llvm-rc /C 65001 /FO %t.utf8.res -- %p/Inputs/utf8.rc
 ; RUN: llvm-readobj %t.utf8.res | FileCheck %s --check-prefix=UTF8
 
 ; UTF8:      Resource type (int): 6
 ; UTF8-NEXT: Resource name (int): 1
 ; UTF8-NEXT: Data version: 0
 ; UTF8-NEXT: Memory flags: 0x1030
 ; UTF8-NEXT: Language ID: 1033
 ; UTF8-NEXT: Version (major): 0

test/tools/llvm-rc/cpp-output.test

-; RUN: llvm-rc /FO %t %p/Inputs/cpp-output.rc
+; RUN: llvm-rc /FO %t -- %p/Inputs/cpp-output.rc
 ; RUN: llvm-readobj %t | FileCheck %s
 
 ; CHECK:      Resource type (int): 6
 ; CHECK-NEXT: Resource name (int): 1
 ; CHECK-NEXT: Data version: 0
 ; CHECK-NEXT: Memory flags: 0x1030
 ; CHECK-NEXT: Language ID: 1033
 ; CHECK-NEXT: Version (major): 0
 ; CHECK-NEXT: Version (minor): 0
 ; CHECK-NEXT: Characteristics: 0
 ; CHECK-NEXT: Data size: 40
 ; CHECK-NEXT: Data: (
 ; CHECK-NEXT:   0000: 00000100 61000100 62000100 63000100  |....a...b...c...|
 ; CHECK-NEXT:   0010: 64000000 00000000 00000000 00000000  |d...............|
 ; CHECK-NEXT:   0020: 00000000 00000000                    |........|
 ; CHECK-NEXT: )

test/tools/llvm-rc/flags.test

-; RUN: llvm-rc /dry-run /FO %t %p/Inputs/empty.rc 2>&1 | FileCheck %s --allow-empty --check-prefix=FO
-; RUN: llvm-rc /dry-run /FO%t %p/Inputs/empty.rc 2>&1 | FileCheck %s --allow-empty --check-prefix=FO
+; RUN: llvm-rc /dry-run /FO %t -- %p/Inputs/empty.rc 2>&1 | FileCheck %s --allow-empty --check-prefix=FO
+; RUN: llvm-rc /dry-run /FO%t -- %p/Inputs/empty.rc 2>&1 | FileCheck %s --allow-empty --check-prefix=FO
 
 ; FO-NOT: Exactly one input file should be provided.

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

 ; Should find the bitmap if it is in the same folder as the rc file.
 ; RUN: rm -f %t.include.res
-; RUN: llvm-rc /FO %t.include.res %p/Inputs/include.rc
+; RUN: llvm-rc /FO %t.include.res -- %p/Inputs/include.rc
 ; RUN: llvm-readobj %t.include.res | FileCheck --check-prefix=FOUND %s
 
 ; Try including files without quotes.
 ; RUN: rm -f %t.noquotes.res
-; RUN: llvm-rc /FO %t.noquotes.res %p/Inputs/include-noquotes.rc
+; RUN: llvm-rc /FO %t.noquotes.res -- %p/Inputs/include-noquotes.rc
 ; RUN: llvm-readobj %t.noquotes.res | FileCheck --check-prefix=FOUND %s
 
 ; Should find the bitmap if the folder is explicitly specified.
 ; RUN: rm -f %t.nested-include.res
-; RUN: llvm-rc /FO %t.nested-include.res /I %p/Inputs/nested %p/Inputs/deep-include.rc
+; RUN: llvm-rc /FO %t.nested-include.res /I %p/Inputs/nested -- %p/Inputs/deep-include.rc
 ; RUN: llvm-readobj %t.nested-include.res | FileCheck --check-prefix=FOUND %s
 
 ; Otherwise, it should not find the bitmap.
 ; RUN: rm -f %t.nested-include.res
-; RUN: not llvm-rc /FO %t.nested-include.res %p/Inputs/deep-include.rc 2>&1 \
+; RUN: not llvm-rc /FO %t.nested-include.res -- %p/Inputs/deep-include.rc 2>&1 \
 ; RUN:   | FileCheck --check-prefix=MISSING %s
 
 ; Should find the bitmap if the process's current working directory
 ; 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-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 (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

test/tools/llvm-rc/memoryflags-stringtable.test

-; RUN: llvm-rc /FO %t %p/Inputs/memoryflags-stringtable.rc
+; RUN: llvm-rc /FO %t -- %p/Inputs/memoryflags-stringtable.rc
 ; RUN: llvm-readobj %t | FileCheck %s
 
 ; CHECK:      Resource type (int): 6
 ; CHECK-NEXT: Resource name (int): 1
 ; CHECK-NEXT: Data version: 0
 ; CHECK-NEXT: Memory flags: 0x10
 ; CHECK:      Resource type (int): 6
 ; CHECK-NEXT: Resource name (int): 1
 ; CHECK-NEXT: Data version: 0
 ; CHECK-NEXT: Memory flags: 0x1030
 ; CHECK:      Resource type (int): 6
 ; CHECK-NEXT: Resource name (int): 1
 ; CHECK-NEXT: Data version: 0
 ; CHECK-NEXT: Memory flags: 0x60

test/tools/llvm-rc/memoryflags.test

-; RUN: llvm-rc /FO %t %p/Inputs/memoryflags.rc
+; RUN: llvm-rc /FO %t -- %p/Inputs/memoryflags.rc
 ; RUN: llvm-readobj %t | FileCheck %s
 
 ; CHECK:      Resource type (int): 1
 ; CHECK-NEXT: Resource name (int): 1
 ; CHECK-NEXT: Data version: 0
 ; CHECK-NEXT: Memory flags: 0x1050
 ; CHECK:      Resource type (int): 12
 ; CHECK-NEXT: Resource name (int): 1

test/tools/llvm-rc/not-expr.test

-; RUN: llvm-rc /FO %t %p/Inputs/not-expr.rc
+; RUN: llvm-rc /FO %t -- %p/Inputs/not-expr.rc
 ; RUN: llvm-readobj %t | FileCheck %s --check-prefix=NOTEXPR
 
 ; NOTEXPR: Resource type (int): 5
 ; NOTEXPR-NEXT: Resource name (string): NOT
 ; NOTEXPR-NEXT: Data version: 0
 ; NOTEXPR-NEXT: Memory flags: 0x1030
 ; NOTEXPR-NEXT: Language ID: 1033
 ; NOTEXPR-NEXT: Version (major): 0

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

-; RUN: llvm-rc /dry-run /V %p/Inputs/parser-expr.rc | FileCheck %s
+; RUN: llvm-rc /dry-run /V -- %p/Inputs/parser-expr.rc | FileCheck %s
 
 ; CHECK:  Language: 5, Sublanguage: 1
 ; CHECK-NEXT:  Language: 3, Sublanguage: 2
 ; CHECK-NEXT:  Language: 4294967293, Sublanguage: 4294967292
 ; CHECK-NEXT:  Language: 0, Sublanguage: 1
 ; CHECK-NEXT:  Language: 2, Sublanguage: 4
 ; CHECK-NEXT:  Language: 3, Sublanguage: 5
 ; CHECK-NEXT:  Language: 2, Sublanguage: 0

test/tools/llvm-rc/parser.test

-; RUN: llvm-rc /dry-run /V %p/Inputs/parser-correct-everything.rc | FileCheck %s --check-prefix PGOOD
+; RUN: llvm-rc /dry-run /V -- %p/Inputs/parser-correct-everything.rc | FileCheck %s --check-prefix PGOOD
 
 ; PGOOD:  Icon (meh): "hello.bmp"
 ; PGOOD-NEXT:  Icon (Icon): "Icon"
 ; PGOOD-NEXT:  Language: 5, Sublanguage: 12
 ; PGOOD-NEXT:  StringTable:
 ; PGOOD-NEXT:    Option: Language: 1, Sublanguage: 1
 ; PGOOD-NEXT:    Option: Characteristics: 500
 ; PGOOD-NEXT:    Option: Language: 3, Sublanguage: 4

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

-; RUN: llvm-rc /FO %t %p/Inputs/tag-accelerators.rc
+; RUN: llvm-rc /FO %t -- %p/Inputs/tag-accelerators.rc
 ; RUN: llvm-readobj %t | FileCheck %s --check-prefix=ACCELERATORS
 
 ; ACCELERATORS: Resource type (int): 9
 ; ACCELERATORS-NEXT: Resource name (int): 1
 ; ACCELERATORS-NEXT: Data version: 0
 ; ACCELERATORS-NEXT: Memory flags: 0x30
 ; ACCELERATORS-NEXT: Language ID: 1029
 ; ACCELERATORS-NEXT: Version (major): 0

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

-; RUN: llvm-rc /FO %t %p/Inputs/tag-dialog.rc
+; RUN: llvm-rc /FO %t -- %p/Inputs/tag-dialog.rc
 ; RUN: llvm-readobj %t | FileCheck %s --check-prefix=DIALOG
 
 ; DIALOG: Resource type (int): 5
 ; DIALOG-NEXT: Resource name (string): EMPTY
 ; DIALOG-NEXT: Data version: 0
 ; DIALOG-NEXT: Memory flags: 0x1030
 ; DIALOG-NEXT: Language ID: 1033
 ; DIALOG-NEXT: Version (major): 0

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

-; RUN: llvm-rc /FO %t %p/Inputs/tag-escape.rc
+; RUN: llvm-rc /FO %t -- %p/Inputs/tag-escape.rc
 ; RUN: llvm-readobj %t | FileCheck %s
 
 ; CHECK:      Resource type (int): 4
 ; CHECK-NEXT: Resource name (int): 1
 ; CHECK-NEXT: Data version: 0
 ; CHECK-NEXT: Memory flags: 0x1030
 ; CHECK-NEXT: Language ID: 1033
 ; CHECK-NEXT: Version (major): 0

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

 ; RUN: rm -rf %t && mkdir %t && cd %t
 ; RUN: cp %p/Inputs/webpage*.html .
-; RUN: llvm-rc /FO %t/tag-html.res %p/Inputs/tag-html.rc
+; RUN: llvm-rc /FO %t/tag-html.res -- %p/Inputs/tag-html.rc
 ; RUN: llvm-readobj %t/tag-html.res | FileCheck %s --check-prefix HTML
 
 ; HTML: Resource type (int): 23
 ; HTML-NEXT: Resource name (int): 100
 ; HTML-NEXT: Data version: 0
 ; HTML-NEXT: Memory flags: 0x30
 ; HTML-NEXT: Language ID: 1033
 ; HTML-NEXT: Version (major): 0

test/tools/llvm-rc/tag-icon-cursor.test

 ; RUN: rm -rf %t
 ; RUN: mkdir %t
 
-; RUN: llvm-rc /FO %t/tag-icon-cursor.res %p/Inputs/tag-icon-cursor.rc
+; RUN: llvm-rc /FO %t/tag-icon-cursor.res -- %p/Inputs/tag-icon-cursor.rc
 ; RUN: llvm-readobj %t/tag-icon-cursor.res | FileCheck %s
 
 ; CHECK: Resource type (int): 1
 ; CHECK-NEXT: Resource name (int): 1
 ; CHECK-NEXT: Data version: 0
 ; CHECK-NEXT: Memory flags: 0x1010
 ; CHECK-NEXT: Language ID: 1033
 ; CHECK-NEXT: Version (major): 0

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

-; RUN: llvm-rc /FO %t %p/Inputs/tag-menu.rc
+; RUN: llvm-rc /FO %t -- %p/Inputs/tag-menu.rc
 ; RUN: llvm-readobj %t | FileCheck %s --check-prefix=MENU
 
 ; Test running llvm-rc without an explicit output file.
 ; RUN: cp %p/Inputs/tag-menu.rc %t.implicit.rc
-; RUN: llvm-rc %t.implicit.rc
+; RUN: llvm-rc -- %t.implicit.rc
 ; RUN: llvm-readobj %t.implicit.res | FileCheck --check-prefix=MENU %s
 
 ; MENU: Resource type (int): 4
 ; MENU-NEXT: Resource name (string): CHECKRECURSION
 ; MENU-NEXT: Data version: 0
 ; MENU-NEXT: Memory flags: 0x1030
 ; MENU-NEXT: Language ID: 1033
 ; MENU-NEXT: Version (major): 0

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

-; RUN: llvm-rc /FO %t %p/Inputs/tag-stringtable-basic.rc
+; RUN: llvm-rc /FO %t -- %p/Inputs/tag-stringtable-basic.rc
 ; RUN: llvm-readobj %t | FileCheck %s
 
 ; CHECK:      Resource type (int): 6
 ; CHECK-NEXT: Resource name (int): 1
 ; CHECK-NEXT: Data version: 0
 ; CHECK-NEXT: Memory flags: 0x1030
 ; CHECK-NEXT: Language ID: 1033
 ; CHECK-NEXT: Version (major): 0

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-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

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

-; RUN: llvm-rc /FO %t %p/Inputs/tag-versioninfo.rc
+; RUN: llvm-rc /FO %t -- %p/Inputs/tag-versioninfo.rc
 ; RUN: llvm-readobj %t | FileCheck %s
 
 ; CHECK:      Resource type (int): 16
 ; CHECK-NEXT: Resource name (int): 1
 ; CHECK-NEXT: Data version: 0
 ; CHECK-NEXT: Memory flags: 0x30
 ; CHECK-NEXT: Language ID: 1033
 ; CHECK-NEXT: Version (major): 0

test/tools/llvm-rc/tokenizer.test

-; RUN: not llvm-rc /V /FO %t.res %p/Inputs/tokens.rc | FileCheck %s
+; RUN: not llvm-rc /V /FO %t.res -- %p/Inputs/tokens.rc | FileCheck %s
 ; llvm-rc fails now on this sample because it is an invalid resource file
 ; script. We silence the error message and just analyze the output.
 
 ; CHECK:  Int: 1; int value = 1
 ; CHECK-NEXT:  Plus: +
 ; CHECK-NEXT:  Int: 2; int value = 2
 ; CHECK-NEXT:  Minus: -
 ; CHECK-NEXT:  Int: 3214L; int value = 3214

test/tools/llvm-rc/versioninfo-padding.test

-; RUN: llvm-rc /FO %t %p/Inputs/versioninfo-padding.rc
+; RUN: llvm-rc /FO %t -- %p/Inputs/versioninfo-padding.rc
 ; RUN: llvm-readobj %t | FileCheck %s
 
 ; CHECK:      Resource type (int): 16
 ; CHECK-NEXT: Resource name (int): 1
 ; CHECK-NEXT: Data version: 0
 ; CHECK-NEXT: Memory flags: 0x30
 ; CHECK-NEXT: Language ID: 1033
 ; CHECK-NEXT: Version (major): 0

tools/llvm-rc/llvm-rc.cpp

 #include "llvm/Support/ManagedStatic.h"
 #include "llvm/Support/MemoryBuffer.h"
 #include "llvm/Support/Path.h"
 #include "llvm/Support/PrettyStackTrace.h"
 #include "llvm/Support/Process.h"
 #include "llvm/Support/Signals.h"
 #include "llvm/Support/raw_ostream.h"
 
+#include <algorithm>
 #include <system_error>
 
 using namespace llvm;
 using namespace llvm::rc;
 
 namespace {
 
 // Input options tables.

 } // anonymous namespace
 
 int main(int Argc, const char **Argv) {
   InitLLVM X(Argc, Argv);
   ExitOnErr.setBanner("llvm-rc: ");
 
   RcOptTable T;
   unsigned MAI, MAC;
-  ArrayRef<const char *> ArgsArr = makeArrayRef(Argv + 1, Argc - 1);
+  const char **DashDash = std::find_if(
+      Argv + 1, Argv + Argc, [](StringRef Str) { return Str == "--"; });
+  ArrayRef<const char *> ArgsArr = makeArrayRef(Argv + 1, DashDash);
+
   opt::InputArgList InputArgs = T.ParseArgs(ArgsArr, MAI, MAC);
 
   // The tool prints nothing when invoked with no command-line arguments.
   if (InputArgs.hasArg(OPT_HELP)) {
     T.PrintHelp(outs(), "rc [options] file...", "Resource Converter", false);
     return 0;
   }
 
   const bool BeVerbose = InputArgs.hasArg(OPT_VERBOSE);
 
   std::vector<std::string> InArgsInfo = InputArgs.getAllArgValues(OPT_INPUT);
+  if (DashDash != Argv + Argc)
+    InArgsInfo.insert(InArgsInfo.end(), DashDash + 1, Argv + Argc);
   if (InArgsInfo.size() != 1) {
     fatalError("Exactly one input file should be provided.");
   }
 
   // Read and tokenize the input file.
   ErrorOr<std::unique_ptr<MemoryBuffer>> File =
       MemoryBuffer::getFile(InArgsInfo[0]);
   if (!File) {