alec

Abstraction Layer for Escape Codes

git clone git://git.dimitrijedobrota.com/alec.git

commit	ab7d347f7d287bcd1e08a97057f1a34b500b115e
parent	b4cfd8d3f235601b59aa9b9d267f2081fc0b7d58
author	Dimitrije Dobrota <mail@dimitrijedobrota.com>
date	Mon, 10 Mar 2025 16:40:51 +0100

Add support for vcpkg

Diffstat:

M	BUILDING.md	\|	++++
M	CMakeLists.txt	\|	++--
M	CMakePresets.json	\|	++++++++++++++++++++++++++----------------------
M	HACKING.md	\|	++++++++++++++++-
M	README.md	\|	+++---
M	cmake/install-config.cmake	\|	++++++-
M	cmake/lint-targets.cmake	\|	+
M	cmake/lint.cmake	\|	+
A	vcpkg-configuration.json	\|	+++++++++++++++
A	vcpkg.json	\|	+++++++++++++++++++

10 files changed, 93 insertions(+), 29 deletions(-)

diff --git a/BUILDING.md b/BUILDING.md

@@ -1,5 +1,9 @@

# Building with CMake

## Dependencies

For a list of dependencies, please refer to [vcpkg.json](vcpkg.json).

## Build

This project doesn't require any special command-line flags to build to keep

diff --git a/CMakeLists.txt b/CMakeLists.txt

@@ -13,8 +13,6 @@ project(

include(cmake/project-is-top-level.cmake)

include(cmake/variables.cmake)

find_package(cemplate 0.2.0 CONFIG REQUIRED)

# ---- Build library ----

set(PARSER_DIR "${CMAKE_CURRENT_BINARY_DIR}/source")

@@ -40,6 +38,8 @@ set_source_files_properties(${PARSER_OUT} PROPERTIES SKIP_LINTING ON)

add_executable(generator "${LEXER_OUT}" "${PARSER_OUT}" source/generator.cpp)

target_include_directories(generator PRIVATE source ${PARSER_DIR})

find_package(cemplate CONFIG REQUIRED)

target_link_libraries(generator PRIVATE cemplate::cemplate)

target_compile_features(generator PUBLIC cxx_std_20)

diff --git a/CMakePresets.json b/CMakePresets.json

@@ -7,26 +7,25 @@

"configurePresets": [

{

"name": "cmake-pedantic",

"name": "dev-mode",

"hidden": true,

"warnings": {

"dev": true,

"deprecated": true,

"uninitialized": true,

"unusedCli": true,

"systemVars": false

"errors": {

"dev": true,

"deprecated": true

"cacheVariables": {

"alec_DEVELOPER_MODE": "ON",

"VCPKG_MANIFEST_FEATURES": "test"

}

{

"name": "dev-mode",

"name": "vcpkg",

"hidden": true,

"cacheVariables": {

"CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"

}

{

"name": "vcpkg-win64-static",

"hidden": true,

"inherits": "cmake-pedantic",

"cacheVariables": {

"alec_DEVELOPER_MODE": "ON"

"VCPKG_TARGET_TRIPLET": "x64-windows-static-md"

}

{

@@ -92,7 +91,10 @@

"name": "ci-darwin",

"inherits": ["flags-appleclang", "ci-std"],

"generator": "Xcode",

"hidden": true

"hidden": true,

"cacheVariables": {

"CMAKE_CATCH_DISCOVER_TESTS_DISCOVERY_MODE": "PRE_TEST"

}

{

"name": "ci-win64",

@@ -111,12 +113,13 @@

"CMAKE_BUILD_TYPE": "Coverage",

"CMAKE_CXX_FLAGS_COVERAGE": "-Og -g --coverage -fkeep-inline-functions -fkeep-static-functions",

"CMAKE_EXE_LINKER_FLAGS_COVERAGE": "--coverage",

"CMAKE_SHARED_LINKER_FLAGS_COVERAGE": "--coverage"

"CMAKE_SHARED_LINKER_FLAGS_COVERAGE": "--coverage",

"CMAKE_MAP_IMPORTED_CONFIG_COVERAGE": "Coverage;RelWithDebInfo;Release;Debug;"

}

{

"name": "ci-coverage",

"inherits": ["coverage-linux", "dev-mode"],

"inherits": ["coverage-linux", "dev-mode", "vcpkg"],

"cacheVariables": {

"COVERAGE_HTML_COMMAND": ""

}

@@ -124,10 +127,11 @@

{

"name": "ci-sanitize",

"binaryDir": "${sourceDir}/build/sanitize",

"inherits": ["ci-linux", "dev-mode"],

"inherits": ["ci-linux", "dev-mode", "vcpkg"],

"cacheVariables": {

"CMAKE_BUILD_TYPE": "Sanitize",

"CMAKE_CXX_FLAGS_SANITIZE": "-U_FORTIFY_SOURCE -O2 -g -fsanitize=address,undefined -fno-omit-frame-pointer -fno-common"

"CMAKE_CXX_FLAGS_SANITIZE": "-U_FORTIFY_SOURCE -O2 -g -fsanitize=address,undefined -fno-omit-frame-pointer -fno-common",

"CMAKE_MAP_IMPORTED_CONFIG_SANITIZE": "Sanitize;RelWithDebInfo;Release;Debug;"

}

{

@@ -145,15 +149,15 @@

{

"name": "ci-macos",

"inherits": ["ci-build", "ci-darwin", "dev-mode", "ci-multi-config"]

"inherits": ["ci-build", "ci-darwin", "dev-mode", "ci-multi-config", "vcpkg"]

{

"name": "ci-ubuntu",

"inherits": ["ci-build", "ci-linux", "clang-tidy", "cppcheck", "dev-mode"]

"inherits": ["ci-build", "ci-linux", "clang-tidy", "vcpkg", "cppcheck", "dev-mode"]

{

"name": "ci-windows",

"inherits": ["ci-build", "ci-win64", "dev-mode", "ci-multi-config"]

"inherits": ["ci-build", "ci-win64", "dev-mode", "ci-multi-config", "vcpkg", "vcpkg-win64-static"]

}

]

}

diff --git a/HACKING.md b/HACKING.md

@@ -41,7 +41,7 @@ the project:

{

"name": "dev",

"binaryDir": "${sourceDir}/build/dev",

"inherits": ["dev-mode", "ci-<os>"],

"inherits": ["dev-mode", "vcpkg", "ci-<os>"],

"cacheVariables": {

"CMAKE_BUILD_TYPE": "Debug"

}

@@ -87,6 +87,17 @@ in the terminal.

> in `Tools > Options > CMake` **prior to opening the project**, after which

> you can manually configure using `Project > Configure Cache`.

### Dependency manager

The above preset will make use of the [vcpkg][vcpkg] dependency manager. After

installing it, make sure the `VCPKG_ROOT` environment variable is pointing at

the directory where the vcpkg executable is. On Windows, you might also want

to inherit from the `vcpkg-win64-static` preset, which will make vcpkg install

the dependencies as static libraries. This is only necessary if you don't want

to setup `PATH` to run tests.

[vcpkg]: https://github.com/microsoft/vcpkg

### Configure, build and test

If you followed the above instructions, then you can configure, build and test

@@ -135,6 +146,10 @@ These targets run the clang-format tool on the codebase to check errors and to

fix them respectively. Customization available using the `FORMAT_PATTERNS` and

`FORMAT_COMMAND` cache variables.

#### `run-examples`

Runs all the examples created by the `add_example` command.

#### `spell-check` and `spell-fix`

These targets run the codespell tool on the codebase to check errors and to fix

diff --git a/README.md b/README.md

@@ -21,7 +21,7 @@ adapted for other use cases.

## Dependencies

* CMake 3.25.2 or latter

* CMake 3.14 or latter

* Compiler with C++20 support (tested on clang version 16.0.5)

* Flex 2.6.4

* Bison 3.8.2

@@ -32,9 +32,9 @@ adapted for other use cases.

See the [`BUILDING`](BUILDING.md) document.

### Usage

## Usage

> Please reference demo folder for relevant usage example.

> Please reference demo folder for relevant usage examples.

Everything that this library provide is found in `alec` namespace.

Functions have names shown in the table below, whilst templates have suffix _v

diff --git a/cmake/install-config.cmake b/cmake/install-config.cmake

@@ -1,1 +1,6 @@

include("${CMAKE_CURRENT_LIST_DIR}/alecTargets.cmake")

include(CMakeFindDependencyMacro)

find_dependency(cemplate)

if(cemplate_FOUND)

include("${CMAKE_CURRENT_LIST_DIR}/alecTargets.cmake")

endif()

diff --git a/cmake/lint-targets.cmake b/cmake/lint-targets.cmake

@@ -3,6 +3,7 @@ set(

source/*.cpp source/*.hpp

include/*.hpp

test/*.cpp test/*.hpp

example/*.cpp example/*.hpp

CACHE STRING

"; separated patterns relative to the project source dir to format"

)

diff --git a/cmake/lint.cmake b/cmake/lint.cmake

@@ -12,6 +12,7 @@ default(

source/*.cpp source/*.hpp

include/*.hpp

test/*.cpp test/*.hpp

example/*.cpp example/*.hpp

)

default(FIX NO)

diff --git a/vcpkg-configuration.json b/vcpkg-configuration.json

@@ -0,0 +1,15 @@

{

"default-registry": {

"kind": "git",

"baseline": "566f9496b7e00ee0cc00aca0ab90493d122d148a",

"repository": "https://github.com/microsoft/vcpkg"

"registries": [

{

"kind": "git",

"repository": "git://git.dimitrijedobrota.com/vcpkg-registry.git",

"baseline": "487d7c36bb87d45fb7f98f5bd6c7dd0bed9b8c08",

"packages": [ "cemplate" ]

}

]

}

diff --git a/vcpkg.json b/vcpkg.json

@@ -0,0 +1,19 @@

{

"name": "alec",

"version-semver": "0.1.17",

"dependencies": [

{

"name": "cemplate",

"version>=": "0.2.0"

}

"default-features": [],

"features": {

"test": {

"description": "Dependencies for testing",

"dependencies": [

]

}

"builtin-baseline": "eba7c6a894fce24146af4fdf161fef8e90dd6be3"

}