how to import header-only files at `third_party` dir #5966

pplmx · 2024-12-14T11:44:47Z

pplmx
Dec 14, 2024

Reproduction Steps

# When selecting build tool, choose xmake
cookiecutter -c feat_cxx_third_party gh:x-pt/template --directory template/cxx
You've downloaded C:\Users\pplmx\.cookiecutters\template before. Is it okay to delete and re-download it? [y/n] (y):
  [1/10] Enter your project name (My Awesome Project):
  [2/10] Generated project identifier (slug) (my-awesome-project):
  [3/10] Generated package/module name (my_awesome_project):
  [4/10] Brief project description (A nice cxx project):
  [5/10] Initial project version (0.0.1):
  [6/10] Author's email address ([email protected]):
  [7/10] Author's full name (Firstname Lastname):
  [8/10] GitHub username or organization (your-org-or-username):
  [9/10] Select cxx_build_tool
    1 - cmake
    2 - xmake
    Choose from [1/2] (1): 2
  [10/10] cxx_standard_version (20):
Initialized empty Git repository in C:/Users/pplmx/JetBrains/CLionProjects/my-awesome-project/.git/

# After project generation
cd my-awesome-project
make build
make run
make test

Expected Behavior

All of the following commands should work successfully:

make build
make run
make test

Additional Context

The CMake version project you can try (where you select CMake in the build tool options) will execute the same command and it works fine.

Answered by waruqi

Dec 16, 2024

I'm not sure how you plan to organize your project structure, but for the compilation error I currently encounter, you can fix it with the following patch.

It works for me.

ruki-2:hello ruki$ git diff
diff --git a/tests/xmake.lua b/tests/xmake.lua
index 7275822..34a22fc 100644
--- a/tests/xmake.lua
+++ b/tests/xmake.lua
@@ -6,5 +6,6 @@ target("hello-tests")
     set_targetdir("$(buildir)/bin")
     set_kind("binary")
     add_files("*.cpp")
+    add_includedirs("$(projectdir)/include")
     add_deps("hello_lib")
     add_packages("gtest")
diff --git a/xmake.lua b/xmake.lua
index 7e9e669..48c0d66 100644
--- a/xmake.lua
+++ b/xmake.lua
@@ -11,7 +11,7 @@ target("hello_lib")
     set_kind("st…

View full answer

star-hengxing · 2024-12-14T12:09:24Z

star-hengxing
Dec 14, 2024

It seems like cookiecutter dosen't support xmake.

6 replies

pplmx Dec 15, 2024
Author

I don't know what xmake needs to do.

Hi waruqi,

Cookiecutter is only responsible for generating the project scaffold. The issue lies within the generated project itself, not with Cookiecutter.
You can use Cookiecutter to replicate the problematic project.

waruqi Dec 15, 2024
Maintainer

I tried it. But I have never heard of Cookiecutter, and these project templates and generated files are not maintained by us. If there are problems with them, you should report them to the maintainer.

$ cookiecutter -c feat_cxx_third_party gh:x-pt/template --directory template/cxx
  [1/10] Enter your project name (My Awesome Project): hello
  [2/10] Generated project identifier (slug) (hello): 
  [3/10] Generated package/module name (hello): 
  [4/10] Brief project description (A nice cxx project): 
  [5/10] Initial project version (0.0.1): 
  [6/10] Author's email address ([email protected]): 
  [7/10] Author's full name (Firstname Lastname): 
  [8/10] GitHub username or organization (your-org-or-username): 
  [9/10] Select cxx_build_tool
    1 - cmake
    2 - xmake
    Choose from [1/2] (1): 2
  [10/10] cxx_standard_version (20): 
Initialized empty Git repository in /private/tmp/hello/.git/

$ xmake
checking for platform ... macosx
checking for architecture ... x86_64
checking for Xcode directory ... /Applications/Xcode.app
checking for Codesign Identity of Xcode ... Apple Development: [email protected] (T3NA4MRVPU)
checking for SDK version of Xcode for macosx (x86_64) ... 15.1
checking for Minimal target version of Xcode for macosx (x86_64) ... 15.1
note: install or modify (m) these packages (pass -y to skip confirm)?
in xmake-repo:
  -> gtest v1.15.2 
  -> spdlog v1.15.0 
please input: y (y/n/m)

  => download https://github.com/gabime/spdlog/archive/refs/tags/v1.15.0.zip .. ok
  => download https://github.com/google/googletest/archive/refs/tags/v1.15.2.zip .. ok
  => install spdlog v1.15.0 .. ok                 
  => install gtest v1.15.2 .. ok    
[ 57%]: cache compiling.release tests/test_main.cpp
[ 57%]: cache compiling.release tests/test_my_lib.cpp
[ 57%]: cache compiling.release src/my_lib.cpp
[ 57%]: cache compiling.release src/main.cpp
[ 57%]: cache compiling.release src/main.cpp
error: tests/test_my_lib.cpp:2:10: fatal error: 'my_lib.h' file not found
    2 | #include "my_lib.h"
      |          ^~~~~~~~~~
1 error generated.
  > in tests/test_my_lib.cpp

$ make build
[ 35%]: cache compiling.release tests/test_my_lib.cpp
[ 57%]: cache compiling.release src/main.cpp
[ 64%]: archiving.release libhello_lib.a
error: tests/test_my_lib.cpp:2:10: fatal error: 'my_lib.h' file not found
    2 | #include "my_lib.h"
      |          ^~~~~~~~~~
1 error generated.
  > in tests/test_my_lib.cpp
make: *** [Makefile:12: build] Error 255

pplmx Dec 16, 2024
Author

you should report them to the maintainer.

I’m the maintainer of this template project (hi there! 😊), but I don’t know how to properly organize xmake when using a third_party directory and including another library with add_requires. Any suggestions or guidance would be greatly appreciated!

waruqi Dec 16, 2024
Maintainer

I'm not sure how you plan to organize your project structure, but for the compilation error I currently encounter, you can fix it with the following patch.

It works for me.

ruki-2:hello ruki$ git diff
diff --git a/tests/xmake.lua b/tests/xmake.lua
index 7275822..34a22fc 100644
--- a/tests/xmake.lua
+++ b/tests/xmake.lua
@@ -6,5 +6,6 @@ target("hello-tests")
     set_targetdir("$(buildir)/bin")
     set_kind("binary")
     add_files("*.cpp")
+    add_includedirs("$(projectdir)/include")
     add_deps("hello_lib")
     add_packages("gtest")
diff --git a/xmake.lua b/xmake.lua
index 7e9e669..48c0d66 100644
--- a/xmake.lua
+++ b/xmake.lua
@@ -11,7 +11,7 @@ target("hello_lib")
     set_kind("static")                               -- Build as a static library
     set_targetdir("build/lib")                       -- Specify output directory
     add_includedirs("include")                       -- Include project's header files
-    add_includedirs("third_party")                   -- Include project's header files
+    add_includedirs("third_party", {public = true})  -- Include project's header files
     add_files("src/*.cpp")                           -- Add project source files
     add_headerfiles("include/*.h")                   -- Add project's header files
     add_headerfiles("include/*.hpp")                 -- Add project's header files

ruki-2:hello ruki$ xmake -rv
checking for Xcode directory ... /Applications/Xcode.app
checking for Codesign Identity of Xcode ... Apple Development: [email protected] (T3NA4MRVPU)
checking for SDK version of Xcode for macosx (x86_64) ... 15.1
checking for Minimal target version of Xcode for macosx (x86_64) ... 15.1
checking for zig ... no
checking for zig ... no
checking for nim ... /usr/local/bin/nim
checking for git ... /usr/bin/git
checking for gzip ... /usr/bin/gzip
checking for tar ... /usr/bin/tar
/usr/bin/git rev-parse HEAD
checking for xmake::gtest ... gtest v1.15.2
checking for xmake::spdlog ... spdlog v1.15.0
checking for /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/clang ... ok
checking for the c++ compiler (cxx) ... clang
checking for /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/clang ... ok
checking for flags (-fPIC) ... ok
checking for flags (-std=c++20) ... ok
[ 57%]: cache compiling.release tests/test_main.cpp
/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/clang -c -Qunused-arguments -target x86_64-apple-macos15.1 -isysroot /Applications/Xcode.app/Contents/Developer/
Platforms/MacOSX.platform/Developer/SDKs/MacOSX15.1.sdk -std=c++20 -I/private/tmp/hello/include -Ithird_party -isystem /Users/ruki/.xmake/packages/g/gtest/v1.15.2/8edc817844c1479eb291f8d952c4e682/inc
lude -o build/.objs/hello-tests/macosx/x86_64/release/tests/test_main.cpp.o tests/test_main.cpp
checking for flags (-MMD -MF) ... ok
checking for flags (-fdiagnostics-color=always) ... ok
checking for the c++ compiler (cxx) ... clang
[ 57%]: cache compiling.release tests/test_my_lib.cpp
/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/clang -c -Qunused-arguments -target x86_64-apple-macos15.1 -isysroot /Applications/Xcode.app/Contents/Developer/
Platforms/MacOSX.platform/Developer/SDKs/MacOSX15.1.sdk -std=c++20 -I/private/tmp/hello/include -Ithird_party -isystem /Users/ruki/.xmake/packages/g/gtest/v1.15.2/8edc817844c1479eb291f8d952c4e682/inc
lude -o build/.objs/hello-tests/macosx/x86_64/release/tests/test_my_lib.cpp.o tests/test_my_lib.cpp
checking for the c++ compiler (cxx) ... clang
[ 57%]: cache compiling.release src/my_lib.cpp
/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/clang -c -Qunused-arguments -target x86_64-apple-macos15.1 -isysroot /Applications/Xcode.app/Contents/Developer/
Platforms/MacOSX.platform/Developer/SDKs/MacOSX15.1.sdk -std=c++20 -Iinclude -Ithird_party -isystem /Users/ruki/.xmake/packages/s/spdlog/v1.15.0/7dc46620a0c9434ca846be1df644f292/include -o build/.obj
s/hello_lib/macosx/x86_64/release/src/my_lib.cpp.o src/my_lib.cpp
checking for the c++ compiler (cxx) ... clang
[ 57%]: cache compiling.release src/main.cpp
/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/clang -c -Qunused-arguments -target x86_64-apple-macos15.1 -isysroot /Applications/Xcode.app/Contents/Developer/
Platforms/MacOSX.platform/Developer/SDKs/MacOSX15.1.sdk -std=c++20 -Iinclude -Ithird_party -isystem /Users/ruki/.xmake/packages/s/spdlog/v1.15.0/7dc46620a0c9434ca846be1df644f292/include -o build/.obj
s/hello_lib/macosx/x86_64/release/src/main.cpp.o src/main.cpp
checking for the c++ compiler (cxx) ... clang
[ 57%]: cache compiling.release src/main.cpp
/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/clang -c -Qunused-arguments -target x86_64-apple-macos15.1 -isysroot /Applications/Xcode.app/Contents/Developer/
Platforms/MacOSX.platform/Developer/SDKs/MacOSX15.1.sdk -std=c++20 -Ithird_party -isystem /Users/ruki/.xmake/packages/s/spdlog/v1.15.0/7dc46620a0c9434ca846be1df644f292/include -o build/.objs/hello/ma
cosx/x86_64/release/src/main.cpp.o src/main.cpp
checking for /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/ar ... ok
checking for the static library archiver (ar) ... ar
[ 64%]: archiving.release libhello_lib.a
/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/ar -cr build/lib/libhello_lib.a build/.objs/hello_lib/macosx/x86_64/release/src/my_lib.cpp.o build/.objs/hello_l
ib/macosx/x86_64/release/src/main.cpp.o
checking for /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/clang++ ... ok
checking for the linker (ld) ... clang++
checking for /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/clang++ ... ok
checking for flags (-fPIC) ... ok
[ 85%]: linking.release hello
/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/clang++ -o build/bin/hello build/.objs/hello/macosx/x86_64/release/src/main.cpp.o -target x86_64-apple-macos15.1
 -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX15.1.sdk -lz -Lbuild/lib -lhello_lib
checking for the linker (ld) ... clang++
[ 92%]: linking.release hello-tests
/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/clang++ -o build/bin/hello-tests build/.objs/hello-tests/macosx/x86_64/release/tests/test_main.cpp.o build/.objs
/hello-tests/macosx/x86_64/release/tests/test_my_lib.cpp.o -target x86_64-apple-macos15.1 -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX15.1.sdk
-lz -L/Users/ruki/.xmake/packages/g/gtest/v1.15.2/8edc817844c1479eb291f8d952c4e682/lib -Lbuild/lib -lgtest -lgmock -lhello_lib
[100%]: build ok, spent 1.865s

Answer selected by pplmx

pplmx · 2024-12-16T02:39:16Z

pplmx
Dec 16, 2024
Author

Hi @waruqi,

Thank you so much — it works perfectly! I really appreciate your help.

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

how to import header-only files at `third_party` dir #5966

{{title}}

Replies: 2 comments 6 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

Select a reply

how to import header-only files at third_party dir #5966

pplmx Dec 14, 2024

Reproduction Steps

Expected Behavior

Additional Context

Replies: 2 comments · 6 replies

star-hengxing Dec 14, 2024

pplmx Dec 15, 2024 Author

waruqi Dec 15, 2024 Maintainer

pplmx Dec 16, 2024 Author

waruqi Dec 16, 2024 Maintainer

pplmx Dec 16, 2024 Author

how to import header-only files at `third_party` dir #5966

pplmx
Dec 14, 2024

Replies: 2 comments 6 replies

star-hengxing
Dec 14, 2024

pplmx Dec 15, 2024
Author

waruqi Dec 15, 2024
Maintainer

pplmx Dec 16, 2024
Author

waruqi Dec 16, 2024
Maintainer

pplmx
Dec 16, 2024
Author