fix: Restructured the code base

This change introduces libaries for parser, the IR and and the
llvm backend.

Author: robertoraggi

.github/workflows/ci.yml

@@ -9,17 +9,36 @@ on:
 jobs:
   build-linux:
     runs-on: ubuntu-latest
+    container: ubuntu:22.04
 
     steps:
       - uses: actions/checkout@v2
 
+      - name: Install required ubuntu packages
+        env:
+          DEBIAN_FRONTEND: noninteractive
+
+        run: |
+          apt-get update && apt-get install -y --no-install-recommends \
+            cmake \
+            build-essential \
+            llvm-dev \
+            python3 \
+            python3-pip \
+            ninja-build \
+            git
+
       - name: Install unit tests requirements
         run: |
           pip install -r tests/unit_tests/requirements.txt
 
       - name: Build
         run: |
-          cmake -Bbuild -DCMAKE_BUILD_TYPE=Release .
+          cmake . \
+            -G Ninja \
+            -Bbuild \
+            -DCMAKE_BUILD_TYPE=Release
+
           cmake --build build
 
       - name: Test
@@ -28,24 +47,19 @@ jobs:
           ctest --verbose
 
   build-windows:
-    runs-on: windows-latest
+    runs-on: windows-2022
 
     steps:
       - uses: actions/checkout@v2
 
-      - uses: actions/cache@v2
-        id: vcpkg-cache
-        with:
-          path: ~\AppData\Local\vcpkg\archives
-          key: vcpkg-cache
-
       - name: Install unit tests requirements
         run: |
           pip install -r tests\unit_tests\requirements.txt
 
       - name: Build
         run: |
-          cmake -Bbuild -DCMAKE_TOOLCHAIN_FILE=C:\Vcpkg\scripts\buildsystems\vcpkg.cmake .
+          cmake . -Bbuild
+
           cmake --build build --config Release
 
       - name: Test
@@ -86,7 +100,12 @@ jobs:
       - name: Build
         run: |
           . .env/bin/activate
-          cmake -Bbuild -DCMAKE_BUILD_TYPE=Release .
+
+          cmake . \
+            -Bbuild \
+            -DCMAKE_BUILD_TYPE=Release \
+            -DLLVM_ROOT=$(brew --prefix llvm)
+
           cmake --build build
 
       - name: Test

CMakeLists.txt

@@ -29,6 +29,8 @@ file(READ "${CMAKE_CURRENT_SOURCE_DIR}/version.txt" version)
 
 set(CMAKE_CXX_STANDARD 20)
 
+find_package(LLVM 13 CONFIG QUIET)
+
 FetchContent_Declare(
     fmt
     GIT_REPOSITORY  https://github.com/fmtlib/fmt
@@ -58,70 +60,16 @@ FetchContent_MakeAvailable(nlohmann_json)
 add_library(nlohmann_json::nlohmann_json INTERFACE IMPORTED)
 set_target_properties(nlohmann_json::nlohmann_json PROPERTIES INTERFACE_INCLUDE_DIRECTORIES "${nlohmann_json_SOURCE_DIR}/single_include")
 
-add_subdirectory(tools/kwgen)
-
-aux_source_directory(src/cxx SOURCES)
-
-add_library(cxx ${SOURCES}
-    # generated files
-    keywords-priv.h
-)
-
-target_include_directories(cxx
-    PRIVATE ${CMAKE_CURRENT_BINARY_DIR}
-    PUBLIC  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src>
-            $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
-)
-
-target_link_libraries(cxx
-    PUBLIC  $<BUILD_INTERFACE:fmt::fmt-header-only>
-            $<BUILD_INTERFACE:utf8::cpp>
-)
-
-add_custom_command(OUTPUT keywords-priv.h
-    COMMAND kwgen < ${CMAKE_CURRENT_SOURCE_DIR}/src/cxx/keywords.kwgen > keywords-priv.h
-    DEPENDS kwgen src/cxx/keywords.kwgen
-    COMMENT "Generate keywords-priv.h")
-
-aux_source_directory(src/frontend FRONTEND_SOURCES)
-
-add_executable(cxx-frontend ${FRONTEND_SOURCES})
-target_link_libraries(cxx-frontend cxx nlohmann_json::nlohmann_json)
-
-if(EMSCRIPTEN)
-    target_link_options(cxx-frontend PUBLIC
-    "SHELL:-s EXIT_RUNTIME=1"
-    "SHELL:-s NODERAWFS=1"
-    "SHELL:-s ALLOW_MEMORY_GROWTH=1"
-    )
-endif()
-
-if(EMSCRIPTEN)
-
-    add_executable(cxx-js src/cxx-js/api.cc)
-
-    target_link_libraries(cxx-js cxx)
-
-    target_link_options(cxx-js PUBLIC
-        "SHELL:--bind"
-        "SHELL:-s ENVIRONMENT=web"
-        "SHELL:-s WASM_ASYNC_COMPILATION=1"
-        "SHELL:-s MODULARIZE=1"
-        "SHELL:-s MALLOC=emmalloc"
-        "SHELL:-s ALLOW_MEMORY_GROWTH=1"
-        "SHELL:-s FILESYSTEM=1"
-        "SHELL:-s NO_DYNAMIC_EXECUTION=1"
-        "SHELL:--extern-post-js ${CMAKE_CURRENT_SOURCE_DIR}/src/cxx-js/suffix.js"
-    )
-
-endif()
-
 enable_testing()
 
+add_subdirectory(tools/kwgen)
+add_subdirectory(src/parser)
+add_subdirectory(src/ir)
+add_subdirectory(src/llvm)
+add_subdirectory(src/js)
+add_subdirectory(src/frontend)
 add_subdirectory(tests)
 
-file(GLOB CXX_INCLUDE_HEADER_FILES src/cxx/*.h)
-
 configure_package_config_file(
     ${CMAKE_CURRENT_SOURCE_DIR}/Config.cmake.in
     "${CMAKE_CURRENT_BINARY_DIR}/cxxConfig.cmake"
@@ -134,27 +82,13 @@ write_basic_package_version_file(
     COMPATIBILITY AnyNewerVersion
 )
 
-install(
-    TARGETS cxx
-    EXPORT cxxTargets
-    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
-    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
-    INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
-)
-
 install(
     EXPORT cxxTargets
     FILE cxxTargets.cmake
     NAMESPACE cxx::
     DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/cxx
 )
 
-install(
-    FILES ${CXX_INCLUDE_HEADER_FILES}
-    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/cxx
-)
-
 install(FILES
     "${CMAKE_CURRENT_BINARY_DIR}/cxxConfig.cmake"
     "${CMAKE_CURRENT_BINARY_DIR}/cxxConfigVersion.cmake"

README.md

@@ -24,14 +24,14 @@ On Linux, macOS and Windows:
 # install the python packages required to run the unit tests
 pip install -r tests/unit_tests/requirements.txt
 
-# configure cxx-frontend
+# configure the source code
 cmake . \
  -G Ninja \
  -B build \
  -DCMAKE_BUILD_TYPE=Release \
  -DCMAKE_INTERPROCEDURAL_OPTIMIZATION=1
 
-# build cxx-frontend
+# build
 cmake --build build
 
 # run the unit tests
@@ -45,7 +45,7 @@ Use `-ast-dump` to dump the AST of a C++ program.
 
 ```sh
 echo 'int main() { auto f = []{ return 1; }; return f(); }' |
-  ./build/cxx-frontend  -ast-dump -
+  ./build/src/frontend/cxx -ast-dump -
 ```
 
 ## Build the npm package using docker

packages/cxx-frontend/package.json

@@ -14,7 +14,7 @@
     "docker:shell": "DOCKER_EXTRA_OPTS=-it npm run docker",
     "configure:wasm": "npm run docker -- emcmake cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INTERPROCEDURAL_OPTIMIZATION=1 -Bbuild.em .",
     "build:wasm": "npm run docker -- cmake --build build.em -- -j4",
-    "copy:wasm": "copyfiles -V -f ../../build.em/cxx-js.* dist",
+    "copy:wasm": "copyfiles -V -f ../../build.em/src/js/cxx-js.* dist",
     "copy:readme": "copyfiles -V -f ../../README.md ../../CHANGELOG.md ."
   },
   "keywords": [
@@ -40,4 +40,4 @@
     "copyfiles": "^2.4.1",
     "typescript": "^4.5.5"
   }
-}
+}

src/frontend/CMakeLists.txt

@@ -0,0 +1,45 @@
+# Copyright (c) 2022 Roberto Raggi <[email protected]>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+aux_source_directory(cxx SOURCES)
+
+add_executable(cxx ${SOURCES})
+
+target_link_libraries(cxx
+    cxx-parser
+    cxx-ir
+    nlohmann_json::nlohmann_json
+)
+
+if (LLVM_FOUND)
+    target_link_libraries(cxx cxx-llvm)
+endif()
+
+if(EMSCRIPTEN)
+    target_link_options(cxx PUBLIC
+        "SHELL:-s EXIT_RUNTIME=1"
+        "SHELL:-s NODERAWFS=1"
+        "SHELL:-s ALLOW_MEMORY_GROWTH=1"
+    )
+endif()
+
+install(
+    TARGETS cxx
+    EXPORT cxxTargets
+)

src/frontend/ast_printer.cc renamed to src/frontend/cxx/ast_printer.cc

@@ -274,7 +274,7 @@ void CLI::parse(int& argc, char**& argv) {
 }
 
 void CLI::showHelp() {
-  fmt::print(stderr, "Usage: cxx-frontend [options] file...\n");
+  fmt::print(stderr, "Usage: cxx [options] file...\n");
   fmt::print(stderr, "Options:\n");
   for (const auto& opt : options) {
     if (opt.visibility == CLIOptionVisibility::kExperimental) {

src/frontend/ast_printer.h renamed to src/frontend/cxx/ast_printer.h

@@ -21,11 +21,12 @@
 // cxx
 #include <cxx/ast.h>
 #include <cxx/ast_visitor.h>
-#include <cxx/codegen.h>
 #include <cxx/control.h>
 #include <cxx/gcc_linux_toolchain.h>
-#include <cxx/ir.h>
-#include <cxx/ir_printer.h>
+#include <cxx/ir/codegen.h>
+#include <cxx/ir/ir.h>
+#include <cxx/ir/ir_printer.h>
+#include <cxx/ir/x64_instruction_selection.h>
 #include <cxx/lexer.h>
 #include <cxx/macos_toolchain.h>
 #include <cxx/preprocessor.h>
@@ -35,7 +36,6 @@
 #include <cxx/symbols.h>
 #include <cxx/translation_unit.h>
 #include <cxx/windows_toolchain.h>
-#include <cxx/x64_instruction_selection.h>
 
 #include "ast_printer.h"
 
@@ -336,12 +336,12 @@ bool runOnFile(const CLI& cli, const std::string& fileName) {
   }
 
   if (cli.opt_S || cli.opt_ir_dump || cli.opt_c) {
-    Codegen cg;
+    ir::Codegen cg;
 
     auto module = cg(&unit);
 
     if (cli.opt_S || cli.opt_c) {
-      X64InstructionSelection isel;
+      ir::X64InstructionSelection isel;
       isel(module.get(), output);
     } else if (cli.opt_ir_dump) {
       ir::IRPrinter printer;
@@ -375,8 +375,8 @@ int main(int argc, char* argv[]) {
   const auto& inputFiles = cli.positionals();
 
   if (inputFiles.empty()) {
-    std::cerr << "cxx-frontend: no input files" << std::endl
-              << "Usage: cxx-frontend [options] file..." << std::endl;
+    std::cerr << "cxx: no input files" << std::endl
+              << "Usage: cxx [options] file..." << std::endl;
     return EXIT_FAILURE;
   }