ENH: Add C++ build and test tasks

Update CMakeLists.txt.

Update manuscript tasks and their names.

Author: thewtex

.gitignore

@@ -55,3 +55,4 @@ env/
 .env
 
 exports/
+src/img1.png.base.png

myst.yml

@@ -51,7 +51,7 @@ project:
     - format: pdf
       template: arxiv_nips
       article_type: research-article
-      output: exports/arxiv.pdf
+      output: exports/manuscript-arxiv-format.pdf
     - format: tex
       template: arxiv_nips
       output: exports/manuscript.tex

pixi.toml

@@ -38,16 +38,11 @@ build-arxiv = "myst build --pdf"
 build-tex = "myst build --tex"
 build-docx = "myst build --docx"
 build-cff = "myst build --cff"
-build-meca = "myst build --meca"
 
 # Combined tasks
-build = { depends-on = ["build-html", "build-pdf", "build-cff"] }
+build-manuscript = { depends-on = ["build-html", "build-pdf", "build-cff"] }
 build-pdfs = { depends-on = ["build-pdf", "build-arxiv"] }
-build-complete = { depends-on = ["build-html", "build-pdfs", "build-tex", "build-docx", "build-cff", "build-meca"] }
-
-# Build source code
-build-src = { cmd = "mkdir -p build && cd build && cmake ../src && make", cwd = "." }
-test-src = { cmd = "cd build && ctest", cwd = ".", depends-on = ["build-src"] }
+build-meca = { cmd = "myst build --meca", depends-on = ["build-html", "build-pdfs", "build-tex", "build-docx", "build-cff"] }
 
 # Start development server
 start = "myst start"
@@ -57,16 +52,54 @@ dev = { depends-on = ["serve"] }
 # Clean build artifacts
 clean = "myst clean"
 
-[feature.cmake.dependencies]
+# Aggregate, standard build task
+build = { depends-on = ["build-manuscript", "test-project"] }
+
+[feature.cxx.dependencies]
 cmake = "*"
 make = "*"
 ninja = "*"
 
-[feature.cmake.tasks]
-configure-cmake = "cmake -B build -S src"
-build-cmake = "cmake --build build"
-test-cmake = "cd build && ctest"
+[feature.cxx.tasks.clone-itk]
+cmd = ["stat", "build/ITK", ">/dev/null", "||",
+  "git", "clone",
+    "https://github.com/InsightSoftwareConsortium/ITK",
+    "build/ITK"]
+outputs = ["build/ITK/LICENSE"]
+description = "Fetch ITK's source code"
+
+[feature.cxx.tasks.configure-itk]
+cmd = '''cmake -Bbuild/ITK-build -Sbuild/ITK -GNinja
+  -DBUILD_EXAMPLES:BOOL=OFF
+  -DBUILD_TESTING:BOOL=OFF'''
+depends-on = ["clone-itk"]
+outputs = ["build/ITK-build/CMakeFiles/**"]
+description = "Configure ITK"
+
+[feature.cxx.tasks.build-itk]
+cmd = "cmake --build build/ITK-build"
+depends-on = ["configure-itk"]
+outputs = ["build/ITK-build/**"]
+description = "Build ITK"
+
+[feature.cxx.tasks.configure-project]
+cmd = '''cmake -Bbuild/project-build -Ssrc -GNinja
+ -DITK_DIR=$(pwd)/build/ITK-build'''
+depends-on = ["build-itk"]
+outputs = ["build/project-build/CMakeFiles/**"]
+description = "Configure the project"
+
+[feature.cxx.tasks.build-project]
+cmd = "cmake --build build/project-build"
+depends-on = ["configure-project"]
+outputs = ["build/project-build/**"]
+description = "Build the project"
+
+[feature.cxx.tasks.test-project]
+cmd = "cd build/project-build && ctest"
+depends-on = ["build-project"]
+description = "Test the project"
 
 [environments]
 default = { features = [], solve-group = "default" }
-dev = { features = ["cmake"], solve-group = "default" }
+cxx = { features = ["cxx"], solve-group = "default" }

src/CMakeLists.txt

@@ -1,60 +1,37 @@
-cmake_minimum_required(VERSION 2.8)
-INCLUDE(${CMAKE_SOURCE_DIR}/IJMacros.txt)
-
-#Change PROJECT_NAME to the name of your project
-PROJECT(ImageCopy)
-
-#The following lines are required to use Dart
-ENABLE_TESTING()
-INCLUDE(Dart)
-
-#Declare any external dependencies that your project may have here.
-#examples include: ITK, VTK, JPEG, PNG, OpenGL, ZLIB, Perl, Java
-#If you're not sure what name to use, look in the Modules directory of your
-#cmake install and check that a file named Find(Package).cmake exists
-#
-# The packages can be specified with a version number, for example:
-#
-# ITK 3.2.0
-# ITK 4.6.0
-#
-# If no version is specified, the most recent release of the package
-# will be used.
-SET(Required_Packages
-ITK
+cmake_minimum_required(VERSION 3.16.3)
+
+# Set project name and description
+project(InsightJournalTemplate
+  VERSION 1.0.0
+  DESCRIPTION "Template for Insight Journal submissions with ITK image processing examples"
+  LANGUAGES CXX
 )
 
-#this foreach loads all of the packages that you specified as required.
-#It shouldn't need to be modified.
-FOREACH(Package ${Required_Packages})
-  LOADPACKAGE(${Package})
-ENDFOREACH(Package)
+# Set C++ standard
+set(CMAKE_CXX_STANDARD 17)
+
+# Find ITK
+find_package(ITK REQUIRED)
+include(${ITK_USE_FILE})
+
+# Enable testing
+include(CTest)
+enable_testing()
 
-#Set any libraries that your project depends on.
-#examples: ITKCommon, VTKRendering, etc
-SET(Libraries
-	${ITK_LIBRARIES}
+# Add executables
+add_executable(ImageCompare ImageCompare.cxx)
+target_link_libraries(ImageCompare PUBLIC ${ITK_LIBRARIES})
+
+add_executable(ImageCopy ImageCopy.cxx)
+target_link_libraries(ImageCopy PUBLIC ${ITK_LIBRARIES})
+
+# Add tests
+add_test(
+  NAME CreateImage
+  COMMAND ImageCopy ${CMAKE_SOURCE_DIR}/img1.png
 )
 
-#the following block of code is an example of how to build an executable in
-#cmake.  Unmodified, it will add an executable called "MyExe" to the project.
-#MyExe will be built using the files MyClass.h and MyClass.cxx, and it will
-#be linked to all the libraries you specified above. 
-#You can build more than one executable per project
-SET(CurrentExe "ImageCompare")
-ADD_EXECUTABLE(${CurrentExe} ImageCompare.cxx) 
-TARGET_LINK_LIBRARIES(${CurrentExe} ${Libraries})
-SET(CurrentExe "ImageCopy")
-ADD_EXECUTABLE(${CurrentExe} ImageCopy.cxx) 
-TARGET_LINK_LIBRARIES(${CurrentExe} ${Libraries})
-
-#the following line is an example of how to add a test to your project.
-#Testname is the title for this particular test.  ExecutableToRun is the
-#program which will be running this test.  It can either be a part of this
-#project or an external executable.  After that list any args that are needed
-#for this test.  Include as many tests as you like.  If your project doesn't have
-#any tests you can comment out or delete the following line.
-ADD_TEST(CreateImage ImageCopy ${CMAKE_SOURCE_DIR}/img1.png)
-ADD_TEST(CompareImage ImageCompare ${CMAKE_SOURCE_DIR}/img1.png ${CMAKE_SOURCE_DIR}/img1.png.base.png)
-
-#Once you're done modifying this template, you should rename it to "CMakeLists.txt"
+add_test(
+  NAME CompareImage
+  COMMAND ImageCompare ${CMAKE_SOURCE_DIR}/img1.png ${CMAKE_SOURCE_DIR}/img1.png.base.png
+)