[objcopy][NFC] Add rules to cmake to put files under specific folders.

[avl]

Summary

This patch adds rules to cmake to put files under specific folders.

It allows to have files for different formats(which are located in different
subdirectories) be displayed in different subfolders of VS IDE solution.

Depends on D114429

[jhenderson]

llvm/lib/Object/CMakeLists.txt

1

Nit: delete this blank line.

2

The backslashes are surprising to me. Can this be forward slashes, like a cross-platform file path?

3

I think you want to use the REGULAR_EXPRESSION rather than FILES, so that you don't need to explicitly specify each source file in the list.

This should allow you to avoid the need for the macros below too.

107–110

Do you need these explicitly?

[avl]

llvm/lib/Object/CMakeLists.txt

2

If forward slashes are used then Visual Studio shows "ObjCopy" not as subfolder of "Header Files" but as another folder on the same level as "Header Files".

[avl]

addressed comments.

[avl]

llvm/lib/Object/CMakeLists.txt

107–110

yes, we need these. If we do not specify include paths here then corresponding .h files would not be shown in the "Header Files" folder.

[jhenderson]

LGTM.

llvm/lib/Object/CMakeLists.txt

2

That's bizarre, but okay.

107–110

Interesting. That suggests the add_llvm_component_library function doesn't recurse down the tree, which it intuitively should (possibly auto-adding the source groups along the way). Anyway, not an issue with this patch.

[avl]

rebased.

[jhenderson]

Thanks, much appreciated. LGTM again!

llvm/lib/Object/CMakeLists.txt

+
+source_group("Header Files\\ObjCopy" FILES
+  ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object/ObjCopy/CommonConfig.h
+  ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object/ObjCopy/ConfigManager.h
+  ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object/ObjCopy/MultiFormatConfig.h
+  ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object/ObjCopy/ObjCopy.h
+)
+
+source_group("Header Files\\ObjCopy\\COFF" FILES
+  ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object/ObjCopy/COFF/COFFConfig.h
+  ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object/ObjCopy/COFF/COFFObjcopy.h
+)
+
+source_group("Header Files\\ObjCopy\\ELF" FILES
+  ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object/ObjCopy/ELF/ELFConfig.h
+  ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object/ObjCopy/ELF/ELFObjcopy.h
+)
+
+source_group("Header Files\\ObjCopy\\MachO" FILES
+  ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object/ObjCopy/MachO/MachOConfig.h
+  ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object/ObjCopy/MachO/MachOObjcopy.h
+)
+
+source_group("Header Files\\ObjCopy\\wasm" FILES
+  ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object/ObjCopy/wasm/WasmConfig.h
+  ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object/ObjCopy/wasm/WasmObjcopy.h
+)
+
+macro(add_objcopy_common_folder)
+  list(APPEND OBJCOPY_SOURCES ${ARGN})
+  source_group("Source Files\\ObjCopy" FILES ${ARGN})
+endmacro()
+
+macro(add_objcopy_format_specific_folder group)
+  list(APPEND OBJCOPY_SOURCES ${ARGN})
+  source_group("Source Files\\ObjCopy\\${group}" FILES ${ARGN})
+endmacro()
+
+add_objcopy_common_folder(
+   ObjCopy/ObjCopy.cpp
+   ObjCopy/ConfigManager.cpp
+)
+
+add_objcopy_format_specific_folder(COFF
+   ObjCopy/COFF/COFFObjcopy.cpp
+   ObjCopy/COFF/Object.cpp
+   ObjCopy/COFF/Reader.cpp
+   ObjCopy/COFF/Writer.cpp
+)
+
+add_objcopy_format_specific_folder(ELF
+   ObjCopy/ELF/ELFObjcopy.cpp
+   ObjCopy/ELF/Object.cpp
+)
+
+add_objcopy_format_specific_folder(MachO
+   ObjCopy/MachO/MachOObjcopy.cpp
+   ObjCopy/MachO/MachOReader.cpp
+   ObjCopy/MachO/MachOWriter.cpp
+   ObjCopy/MachO/MachOLayoutBuilder.cpp
+   ObjCopy/MachO/Object.cpp
+)
+
+add_objcopy_format_specific_folder(wasm
+   ObjCopy/wasm/Object.cpp
+   ObjCopy/wasm/Reader.cpp
+   ObjCopy/wasm/Writer.cpp
+   ObjCopy/wasm/WasmObjcopy.cpp
+)
+
 add_llvm_component_library(LLVMObject
   Archive.cpp
   ArchiveWriter.cpp
   Binary.cpp
   COFFImportFile.cpp
   COFFModuleDefinition.cpp
   COFFObjectFile.cpp
   Decompressor.cpp
add_llvm_component_library(LLVMObject
   SymbolSize.cpp
   TapiFile.cpp
   TapiUniversal.cpp
   MachOUniversalWriter.cpp
   WasmObjectFile.cpp
   WindowsMachineFlag.cpp
   WindowsResource.cpp
   XCOFFObjectFile.cpp
-  ObjCopy/ObjCopy.cpp
-  ObjCopy/ConfigManager.cpp
-  ObjCopy/COFF/COFFObjcopy.cpp
-  ObjCopy/COFF/Object.cpp
-  ObjCopy/COFF/Reader.cpp
-  ObjCopy/COFF/Writer.cpp
-  ObjCopy/ELF/ELFObjcopy.cpp
-  ObjCopy/ELF/Object.cpp
-  ObjCopy/MachO/MachOObjcopy.cpp
-  ObjCopy/MachO/MachOReader.cpp
-  ObjCopy/MachO/MachOWriter.cpp
-  ObjCopy/MachO/MachOLayoutBuilder.cpp
-  ObjCopy/MachO/Object.cpp
-  ObjCopy/wasm/Object.cpp
-  ObjCopy/wasm/Reader.cpp
-  ObjCopy/wasm/Writer.cpp
-  ObjCopy/wasm/WasmObjcopy.cpp
+  ${OBJCOPY_SOURCES}
 
   ADDITIONAL_HEADER_DIRS
   ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object
+  ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object/ObjCopy
+  ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object/ObjCopy/COFF
+  ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object/ObjCopy/ELF
+  ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object/ObjCopy/MachO
+  ${LLVM_MAIN_INCLUDE_DIR}/llvm/Object/ObjCopy/wasm
 
   DEPENDS
   intrinsics_gen
   llvm_vcsrevision_h
 
   LINK_COMPONENTS
   BitReader
   Core
   MC
   BinaryFormat
   MCParser
   Support
   TextAPI
   )