Make empty shell of new cvtres tool.

[ecbeckmann]

Summary

This patch introduces a currently unimplemented cvtres tool. The only
thing the tool does is take some command line flags and print them out
if they match the expected ones.

[ecbeckmann]

Actually got it to compile and run properly.

[thakis]

I'm out today. Since lld will be a client of the library code of this tool, Rui should probably take a look if he's around this week. I'd also already add a test with just a RUN line for running the tool without parameters, just to have test coverage from day one (makes it easier to add tests in the future once the tool actually does something).

[ecbeckmann]

Added one line test.

[zturner]

Can you make the test run llvm-cvtres.exe /? and then have a FileCheck line that matches the first line of help text?

llvm/tools/llvm-cvtres/llvm-cvtres.cpp

57 ↗

(On Diff #95639)

Can you add these lines to the top?

sys::PrintStackTraceOnErrorSignal(argv_[0]);
PrettyStackTraceProgram X(argc_, argv_);

ExitOnErr.setBanner("llvm-cvtres: ");

SmallVector<const char *, 256> argv;
SpecificBumpPtrAllocator<char> ArgAllocator;
ExitOnErr(errorCodeToError(sys::Process::GetArgumentVector(
    argv, makeArrayRef(argv_, argc_), ArgAllocator)));

llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.

This is basically just boiler plate stuff that makes it so if the tool crashes you get a nice stack trace and that everything terminates cleanly on both a clean and unclean shutdown.

[ecbeckmann]

Added help text, and a basic check for it.

[ruiu]

llvm/tools/llvm-cvtres/Opts.td

12 ↗

(On Diff #95674)

Please fix.

llvm/tools/llvm-cvtres/llvm-cvtres.cpp

60 ↗

(On Diff #95674)

Ah, so this command is a stub. It is fine to submit a command that can do a minimal thing, but it feels to me that this is too small. Can you add a feature so that you can say that this command satisfies minimal user needs?

llvm/tools/llvm-cvtres/llvm-cvtres.h

1 ↗

(On Diff #95674)

This file doesn't seem to make sense. Header files are not mandatory. If you don't have anything to put into a header, you don't need to create it.

[zturner]

Did you run clang-format on the CL? (It looks clang-formatted to me, just want to make sure)

llvm/tools/llvm-cvtres/llvm-cvtres.cpp

60 ↗

(On Diff #95674)

Mostly agree with Nico's comments here. There is nothing it can really do that is more minimal than the full functionality of the program. At least with the stub we don't have to worry about reviewing all this boilerplate once the real code goes in.

75 ↗

(On Diff #95674)

You have using namespace llvm at the top, so no need for the explicit qualifiers.

76 ↗

(On Diff #95674)

s/inputArgs/InputArgs. Variable names are always capitalized, including the first letter.

78–97 ↗

(On Diff #95674)

I would remove all these lines (leave the Help line though), as you're basically just verifying that the lib/Option works as advertised, which doesn't really buy us anything since we have a separate suite of tests specifically for lib/Object itself. All of these will go away once the individual options are implemented, so it can't even really be considered stub code, but rather throwaway code.

[ecbeckmann]

small fixes

[thakis]

Looks good to me.

[zturner]

lgtm, I can commit it for you later today.

[thakis]

llvm/tools/llvm-cvtres/Opts.td

6 ↗

(On Diff #95779)

I tried to leave a comment saying that http://llvm-cs.pcc.me.uk/tools/clang/tools/clang-format/ClangFormat.cpp#1 doesn't need a .td file for flag handling, and that maybe it's overkill here too (but it probably doesn't matter much). Looks like it didn't get sent with my last message, so trying again...

[ecbeckmann]

llvm/tools/llvm-cvtres/Opts.td

6 ↗

(On Diff #95779)

That looks like it's because ClangFormat.cpp uses the CommandLine library instead of the Option library. We had to use the Option library in order to support flags given with slashes.

[krytarowski]

Standalone build has been broken?

I installed llvm svn r. 301591, it does not ship with llvm-cvtres. This state has been reported by clang, which fails to pass configure...

-- The C compiler identification is GNU 5.4.0
-- The CXX compiler identification is GNU 5.4.0
-- Check for working C compiler: /tmp/pkgsrc-tmp/wip/clang-netbsd/work/.cwrapper/bin/gcc
-- Check for working C compiler: /tmp/pkgsrc-tmp/wip/clang-netbsd/work/.cwrapper/bin/gcc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Check for working CXX compiler: /tmp/pkgsrc-tmp/wip/clang-netbsd/work/.cwrapper/bin/g++
-- Check for working CXX compiler: /tmp/pkgsrc-tmp/wip/clang-netbsd/work/.cwrapper/bin/g++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Found LLVM_CONFIG as /usr/pkg/bin/llvm-config
CMake Error at /usr/pkg/lib/cmake/llvm/LLVMExports.cmake:614 (message):
  The imported target "llvm-cvtres" references the file

     "/usr/pkg/bin/llvm-cvtres"

  but this file does not exist.  Possible reasons include:

  * The file was deleted, renamed, or moved to another location.

  * An install or uninstall procedure did not complete successfully.

  * The installation package was faulty and contained

     "/usr/pkg/lib/cmake/llvm/LLVMExports.cmake"

  but not all the files it references.

Call Stack (most recent call first):
  /usr/pkg/lib/cmake/llvm/LLVMConfig.cmake:138 (include)
  CMakeLists.txt:70 (include)


-- Configuring incomplete, errors occurred!
See also "/tmp/pkgsrc-tmp/wip/clang-netbsd/work/build/CMakeFiles/CMakeOutput.log".
*** Error code 1

Stop.
make[1]: stopped in /usr/pkgsrc/wip/clang-netbsd
*** Error code 1

Stop.
make: stopped in /usr/pkgsrc/wip/clang-netbsd

llvm/trunk/test/tools/llvm-cvtres/basic.test

+; RUN: llvm-cvtres /h > %t
+; RUN: FileCheck -input-file=%t %s -check-prefix=HELP_TEST
+
+; HELP_TEST: OVERVIEW: Resource Converter

llvm/trunk/tools/llvm-cvtres/CMakeLists.txt

+set(LLVM_LINK_COMPONENTS
+  Option
+  Support
+  )
+
+set(LLVM_TARGET_DEFINITIONS Opts.td)
+
+tablegen(LLVM Opts.inc -gen-opt-parser-defs)
+add_public_tablegen_target(CvtResTableGen)
+
+add_llvm_tool(llvm-cvtres
+  llvm-cvtres.cpp
+  )

llvm/trunk/tools/llvm-cvtres/LLVMBuild.txt

+;===- ./tools/llvm-cvtres/LLVMBuild.txt ------------------------*- Conf -*--===;
+;
+;                     The LLVM Compiler Infrastructure
+;
+; This file is distributed under the University of Illinois Open Source
+; License. See LICENSE.TXT for details.
+;
+;===------------------------------------------------------------------------===;
+;
+; This is an LLVMBuild description file for the components in this subdirectory.
+;
+; For more information on the LLVMBuild system, please see:
+;
+;   http://llvm.org/docs/LLVMBuild.html
+;
+;===------------------------------------------------------------------------===;
+
+[component_0]
+type = Tool
+name = llvm-cvtres
+parent = Tools
+required_libraries = Option Support

llvm/trunk/tools/llvm-cvtres/Opts.td

+include "llvm/Option/OptParser.td"
+
+def DEFINE : Joined<["/"], "DEFINE:">, HelpText<"">, MetaVarName<"symbol">;
+def FOLDDUPS : Flag<["/"], "FOLDDUPS:">, HelpText<"">;
+def MACHINE : Joined<["/"], "MACHINE:">, HelpText<"">, MetaVarName<"{ARM|EBC|IA64|X64|X86}">;
+def NOLOGO : Flag<["/"], "NOLOGO">, HelpText<"">;
+def OUT : Joined<["/"], "OUT:">, HelpText<"">, MetaVarName<"filename">;
+def READONLY : Flag<["/"], "READONLY">, HelpText<"">;
+def VERBOSE : Flag<["/"], "VERBOSE">, HelpText<"">;
+def HELP : Flag<["/"], "HELP">;
+def H : Flag<["/"], "H">, Alias<HELP>;

llvm/trunk/tools/llvm-cvtres/llvm-cvtres.h

+//===- llvm-cvtres.h ------------------------------------------ *- C++ --*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_TOOLS_LLVMCVTRES_LLVMCVTRES_H
+#define LLVM_TOOLS_LLVMCVTRES_LLVMCVTRES_H
+
+#endif

llvm/trunk/tools/llvm-cvtres/llvm-cvtres.cpp

+//===- llvm-cvtres.cpp - Serialize .res files into .obj ---------*- C++ -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// Serialize .res files into .obj files.  This is intended to be a
+// platform-independent port of Microsoft's cvtres.exe.
+//
+//===----------------------------------------------------------------------===//
+
+#include "llvm-cvtres.h"
+
+#include "llvm/Option/Arg.h"
+#include "llvm/Option/ArgList.h"
+#include "llvm/Option/Option.h"
+#include "llvm/Support/Error.h"
+#include "llvm/Support/ManagedStatic.h"
+#include "llvm/Support/PrettyStackTrace.h"
+#include "llvm/Support/Process.h"
+#include "llvm/Support/Signals.h"
+#include "llvm/Support/raw_ostream.h"
+
+using namespace llvm;
+
+namespace {
+
+enum ID {
+  OPT_INVALID = 0, // This is not an option ID.
+#define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM,  \
+               HELPTEXT, METAVAR)                                              \
+  OPT_##ID,
+#include "Opts.inc"
+#undef OPTION
+};
+
+#define PREFIX(NAME, VALUE) const char *const NAME[] = VALUE;
+#include "Opts.inc"
+#undef PREFIX
+
+static const opt::OptTable::Info InfoTable[] = {
+#define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM,  \
+               HELPTEXT, METAVAR)                                              \
+  {                                                                            \
+      PREFIX,      NAME,     HELPTEXT,                                         \
+      METAVAR,     OPT_##ID, opt::Option::KIND##Class,                         \
+      PARAM,       FLAGS,    OPT_##GROUP,                                      \
+      OPT_##ALIAS, ALIASARGS},
+#include "Opts.inc"
+#undef OPTION
+};
+
+class CvtResOptTable : public opt::OptTable {
+public:
+  CvtResOptTable() : OptTable(InfoTable, true) {}
+};
+
+static ExitOnError ExitOnErr;
+}
+
+int main(int argc_, const char *argv_[]) {
+  sys::PrintStackTraceOnErrorSignal(argv_[0]);
+  PrettyStackTraceProgram X(argc_, argv_);
+
+  ExitOnErr.setBanner("llvm-cvtres: ");
+
+  SmallVector<const char *, 256> argv;
+  SpecificBumpPtrAllocator<char> ArgAllocator;
+  ExitOnErr(errorCodeToError(sys::Process::GetArgumentVector(
+      argv, makeArrayRef(argv_, argc_), ArgAllocator)));
+
+  llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
+
+  CvtResOptTable T;
+  unsigned MAI, MAC;
+  ArrayRef<const char *> ArgsArr = makeArrayRef(argv_, argc_);
+  opt::InputArgList InputArgs = T.ParseArgs(ArgsArr, MAI, MAC);
+
+  if (InputArgs.hasArg(OPT_HELP))
+    T.PrintHelp(outs(), "cvtres", "Resource Converter", false);
+
+  return 0;
+}