Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/neutree/c_cpp_project_framework

CMake build system( framework) with kconfig support for C/CPP projects
https://github.com/neutree/c_cpp_project_framework

build c cmake compile cpp framework gui-configuration kconfig kconfig-support make project template wasm

Last synced: 5 days ago
JSON representation

CMake build system( framework) with kconfig support for C/CPP projects

Awesome Lists containing this project

README 

        
C CPP Project Framework (Template)

===================



[中文](./README_ZH.md)



**Simple** and **configurable** `C/C++` project/SDK template 

> `CMake` build system and support Kconfig with `GUI` configuration



Based on this project, you can quickly build your project construction system and reduce many unnecessary troubles~



If it helps you, please give a little star in the upper right corner~~ If needs improvement, just create an [issue](https://github.com/Neutree/c_cpp_project_framework/issues/new).  `(´ε｀ ʃƪ)♡`



The target developer of this project:



* Developers who are preparing to write `SDK` and need to write their own build system

* Preparing to start writing a project who needs to write a build system

* Who don't know much about `CMake`, but want to learn `CMake`

* Who want to refactor the code engineering build system, maybe because of th bad old messy build system

* Who want to add a very useful configuration system to the build system, you can quickly add and delete code modules as needed, and it is best to have an GUI configuration.

* Who want the project to generate a variety of `IDE` supported projects.



![](assets/image/build.gif)



## Features



* The syntax is simple, no knowledge of `Makefile` or `CMake` is required, and it is very simple to use only by modifying the value of the variable based on the template

* Project structure based on the concept of component, which is convenient for building a project structure with a clear hierarchical structure

* Calling between components only requires one statement to specify the dependencies (such as `list(APPEND ADD_REQUIREMENTS component1)`), without setting extra variables such as `INCLUDE path` to call the content of the dependent component in the source code

* Use `Kconfig` to enable project components and code to be tailored and configured to facilitate the project to meet different needs

* Conveniently introduce static libraries (`.a`) and dynamic libraries (`.so`) (such as `list(APPEND ADD_STATIC_LIB "lib/libtest.a")`)

* Conveniently generate static libraries (`.a`) and dynamic libraries (`.so`) (by default, static libraries are generated. If you need components to generate dynamic libraries, you can use `register_component(DYNAMIC)` to register the module)

* Using the `Python` script as an aid, you can easily add commands and tools, and you only need to execute simple commands to compile (such as `python project.py build` `python project.py menuconfig`)

* Conveniently used as `SDK`, the project example can be placed directly in the `SDK` directory, or it can be placed anywhere on the disk separately, just set the environment variable `MY_SDK_PATH`

* Cross-compilation friendly, well as an embedded device `SDK`

* Generate a variety of `IDE` supported projects, then you can directly import to IDE as a project

* Support compile to `WASM`(Web Assembly)



## Get Started



* Clone code by:

```

git clone https://github.com/Neutree/c_cpp_project_framework --recursive

```

> Arg `--recursive` is needed to clone all submodule, or code is not complete



* Or create your github repository based on this template:You can create your github repository with this tempalte by click `use this template` button![](assets/image/use_template.png)



* Start compilethere's two way, use `project.py` script or use original CMake command

  * With project.py(recommend)

    ```

    cd examples/demo1

    # python project.py --toolchain /opt/toolchain/bin --toolchain-prefix mips-elf- config

    python project.py menuconfig

    python project.py build

    # python project.py rebuild    # when you add/remove source files, should use this command instead of build

    # you can use --verbose arg to see more compile info, this is useful when error occurs

    # python project.py build --verbose

    python project.py run        # or ./build/demo1

    python project.py clean

    python project.py distclean

    # python project.py clean_conf

    ```

    * Change dir to project directory

    * Set toolchain path(don't need set if use `gcc`)

    * Config project by command `python project.py menuconfig`, it will generate `global_config` files at `build/config` directory, so we can use it in component's `CMakelists.txt` directly， or in `C/CPP` source files by `#include "global_config.h"`

    * Build project by command `python project.py build`, or output verbose build info with command `python project.py build --verbose`

    * Clean build by `python project.py clean`, clean config generated by `menuconfig` by `python project.py distclean`, this command will not clean toolchain config

    * Clean toolchain config by `python project.py clean_conf`

  * With original CMake command

    ```

    cd examples/demo1

    # python project.py --toolchain /opt/toolchain/bin --toolchain-prefix mips-elf- config

    mkdir build && cd build

    cmake ..

    make menuconfig

    make -j10

    ./build/demo1

    make clean

    rm -rf ./*

    ```

    * Change dir to project directory

    * Set toolchain path(don't need set if use `gcc`)

    * Make a temporary directory and switch the current path to this directory(`build`)

    * Generate makefile by command `cmake ..`, `..` means the project directory

    * Config project by command `make menuconfig`, it will generate `global_config` files at `build/config` directory, so we can use it in component's `CMakelists.txt` directly， or in `C/CPP` source files by `#include "global_config.h"`

    * Build project by command `make`, or parallel build with [make -jN](http://www.gnu.org/software/make/manual/make.html#Parallel)， and output verbose build info with command `make VERBOSE=1`



## Structure



| directory/file | function |

| -------------- | -------- |

| root directory | root directory of this project, also `SDK` projects' `SDK` directory |

| assets         | store assets like image etc. you can delete it if not use it |

| components     | as a component/lib |

| examples       | project dir or demo dir； `SDK` projects' example/project dir, this directory can be separated from the `SDK` directory, just set environment`MY_SDK_PATH` to `SDK` directory's path. |

| tools          | tools like `cmake`、`kconfig`、`burn tool` etc. |

| Kconfig        | root `Kconfig` configuration |



### 1) Component



All libraries are placed as components in the `components` directory or under the project directory. Each component uses a directory. This directory is the name of the component. In order to make the project look more concise, the components are not nested. All components are a hierarchy, and the relationships between components depend on dependencies to maintain



All source files must be in a component. Each project must contain a component called `main` (ie `examples/demo1/main` directory). Each component contains the following files:



* `CMakeLists.txt`: Must exist, declare the component source file and the dependent component, and call the registration function to register itself. For details, please refer to `CMakeLists.txt` of `components/component1` and `components/component2`.



* `Kconfig`: Optional, contains configuration options for this component. In this component or other `CMakeLists.txt` that depends on the component of this component, you can use these configuration items after adding a `CONFIG_` prefix. e.g. In `components/component2`, there is a `COMPONENT2_ENABLED` option in `Kconfig`. We use this variable `if(CONFIG_COMPONENT2_ENABLED)` in its `CMakeLists.txt` to determine if the user configuration want to register this component or not.



### 2) Project Directory



The project directory is in the `examples` directory. Of course, the name of this directory can be modified according to actual needs. The following can contain multiple actual project directories. You can compile when you need to compile the project and switch to the corresponding directory. As mentioned above, there must be a `main` component in each project directory. Of course, you can also put a lot of custom components. More refer to the `examples/demo1` project directory.



Files under the project directory:



* `CMakeLists.txt`: must exist, project properties file, you must first include `include(${SDK_PATH}/tools/cmake/compile.cmake)`, then use the `project` function to declare project name, such as `project(demo1)`, Of course, you can also write other conditions or variables, etc., using the `CMake` syntax, refer to the `examples/demo1/CMakeLists.txt`



* `config_defaults.mk`: Optional, project default configuration file, the default configuration will be loaded when `cmake` execute. The format of the configuration is `Makefile`. You can use the terminal GUI configuration (`make menuconfig`) to generate the configuration file, the generated configuration file is in `build/config/global_config.mk`, then copy to `config_defaults.mk`.

> Note: After modifying `config_defaults.mk`, you need to delete the files in the `build` directory (or just delete the `mk` file in the `build/config` directory) to regenerate, because the current build system will use the existing configuration file (`build/config/global_config.mk`)



* `project.py`: tool script call entry, use `python project.py menuconfig` `python project.py build` and other commands to start building



How to put the project directory anywhere on the disk:



* Change the `MY_SDK_PATH` in `CMakeLists.txt` and `project.py` to the name of the environment variable you like, and then set the value of this environment variable in the terminal to the path of the `SDK`, you can change the project directory It can be compiled anywhere



## Store SDK and project directory separately



Normally, you only need to modify the name of the `example` directory according to your needs, such as changing it to `projects`, or creating a new directory in the project root directory, such as `projects/hello_world`, and copy files in the `examples/demo1`'s content to start a project



In addition, the project directory and the SDK directory can also be stored separately. This is especially used for open source projects, a copy of SDK, users develop based on this SDK, which is more conducive to the spread of routines, users do not need to copy a copy of the SDK, just specify the use SDK version (git commit number)

To do this, only need:



* Download `SDK` and put it in a directory, such as `/home/neucrack/my_SDK`



```

git clone https://github.com/Neutree/c_cpp_project_framework --recursive

```

Note that the `--recursive` parameter is used here, because sub-modules are used in the project. The advantage of sub-modules is that each project is managed separately. For example, `Kconfiglib` is used as a sub-module to provide `menuconfig` with interface function configuration



**If you did't update submodule, the compile will error!!!!**



If you forget to add this parameter when cloning, you can also use the following command to update the submodule:

```

git submodule update --init --recursive

```

In addition, when the remote repository is updated, the user also needs to use the following command to update the code (ie update the submodule code at the same time):

```shell

git pull --recursive

```

or:

```

git pull

git submodule update --init --recursive

```



Of course, you can also just delete the `.git` directory, and start a git repository with no submodule~~~



* Then export the variable `export MY_SDK_PATH=/home/neucrack/my_SDK` in the terminal, which can be placed in the `~/.bashrc` or `~/.zshrc` file, so that this variable will be automatically added every time the terminal is started

* Then create a project anywhere, such as copy the entire content of the folder of `example/demo1` to `/home/neucrack/temp/my_projects/demo1`

* Then clear the previous build cache (if there is one, ignore it if there is none)

```

python3 project.py distclean

```

* Then configure and build

```

python3 project.py menuconfig

python3 project.py build

```



## Custom components path



Generally, the common components are placed in the `SDK directory -> components directory`, and the project-specific components are placed in the `project directory`.

In addition, users can also customize the storage location of their common components by setting the system environment variable `CUSTOM_COMPONENTS_PATH`, for example:

Linux:

```

export CUSTOM_COMPONENTS_PATH=/home/neucrack/my_components

```

Windows just add `CUSTOM_COMPONENTS_PATH` variable in the environment variable interface.

> The name `CUSTOM_COMPONENTS_PATH` can be modified according to your project name or preference in the `project.py` and `CMakeLists.txt` of the project.



Then you can directly use `list(APPEND ADD_REQUIREMENTS component_name)` to reference it in the project component.



## Debug and Release version



By default, it is compiled in debug version. If you want to release version, you can use the following command:

```shell

python project.py distclean

python project.py build --release

```



Then the binary file built is the release version, and the compilation script does a few actions:

* Set the CMake environment variable `CMAKE_BUILD_TYPE` to `MinSizeRel` (default is `Debug`)

* Add `#define RELEASE 1` to the generated header file `global_config.h` (default will add `#define DEBUG 1`)

* Automatically add the macro definition `RELEASE=1` when compiling, so the code actually does not need to import `global_config.h` can also through `RELEASE` and `DEBUG` macro definition to determine whether the current is release version or debug version



## Change project generator



Sometimes you want to faster build speed or generate project for some IDE like Visual Studio,

you can change generator to achieve this, default generator is `Unix Makefiles`.



There are many generator choices, such as `Ninja`, `Visual Studio`, `Xcode`, `Eclipse`, `Unix Makefiles` etc.

Execute command `cmake --help` to see the generator choices, different system support different generators.

Linux for example:

```

Generators



The following generators are available on this platform (* marks default):

  Green Hills MULTI            = Generates Green Hills MULTI files

                                 (experimental, work-in-progress).

* Unix Makefiles               = Generates standard UNIX makefiles.

  Ninja                        = Generates build.ninja files.

  Ninja Multi-Config           = Generates build-.ninja files.

  Watcom WMake                 = Generates Watcom WMake makefiles.

  CodeBlocks - Ninja           = Generates CodeBlocks project files.

  CodeBlocks - Unix Makefiles  = Generates CodeBlocks project files.

  CodeLite - Ninja             = Generates CodeLite project files.

  CodeLite - Unix Makefiles    = Generates CodeLite project files.

  Eclipse CDT4 - Ninja         = Generates Eclipse CDT 4.0 project files.

  Eclipse CDT4 - Unix Makefiles= Generates Eclipse CDT 4.0 project files.

  Kate - Ninja                 = Generates Kate project files.

  Kate - Unix Makefiles        = Generates Kate project files.

  Sublime Text 2 - Ninja       = Generates Sublime Text 2 project files.

  Sublime Text 2 - Unix Makefiles

                               = Generates Sublime Text 2 project files.

```



You can change it by `config` command

```

# clean all build files first(remove build dir)

python project.py distclean



python project.py -G Ninja config

# python project.py -G "Eclipse CDT4 - Ninja" config



python project.py build

```



## Compile to WASM



Install toolchain first according to [emscripten-core/emsdk](https://github.com/emscripten-core/emsdk)

```

git clone https://github.com/emscripten-core/emsdk.git

./emsdk install latest

./emsdk activate latest

```



Just only set toolchain

```

python project.py distclean

python project.py --toolchain $EMSDK/upstream/emscripten/cmake/Modules/Platform/Emscripten.cmake config

python project.py build

```



Then you will find `demo1.html`, `demo1.js` and `demo1.wasm` files in `build` directory, run command below you will see result in browser:

```

emrun demo1.html

```



Or just run by `node`

```

node demo1.js

```



## Add command



By default we can use `python project.py run` to call [tools/cmds/run.py](./tools/run.py) file, and execute the binary file.

If you want to add commands for your SDK, just create new `py` file in tools directory, write a script and content refer to [tools/cmds/run.py](./tools/cmds/run.py).



## Online Debugging



### VSCode + GDB Online Debugging



Here take PC with Linux system as an example:



* Add `c_cpp_project_framework` (recommended for the first trial) or project directory to VSCode workspace

* Copy the [./assets/vscode_local_debug/.vscode](./assets/vscode_local_debug/.vscode) directory to the working directory of the previous step

* Edit the `cwd` field in `.vscode/launch.json` according to whether `.vscode` is under `c_cpp_project_framework` or under the project directory

* Press F5 on the keyboard to start debugging

> Windows is similar, just modify the relevant commands and paths in `.vscode`



### VSCode + gdbserver Debugging on Embedded Device (/Remote Device with Linux System)



Here take PC with Linux system as an example:



* Firstly, Ensure that the remote device has the `gdbserver` program, and the PC has the `gdb-multiarch` program

* Copy the [./assets/vscode_remote_debug/.vscode](./assets/vscode_remote_debug/.vscode) directory to the project directory

* Edit the `launch.json` and `build_run_gdbserver.sh` files, modify the paths and commands inside, as well as the username, etc.

> It is recommended to add the PC's ssh key to the `~/.ssh/authorized_keys` file of the remote device first, so you don't need to enter a password.

* The `build_run_gdbserver.sh` script needs to be executed every time you debug, and then press F5 in VSCode to start debugging

> The script will compile the project, then copy the executable file to the remote device, and start `gdbserver`.

> Press F5 to start debugging, VSCode uses GDB to connect to `gdbserver` on the remote device for debugging.



## License



**MIT**， see [LICENSE](./LICENSE)



## Open source projects used by this project



* [Kconfiglib](https://github.com/ulfalizer/Kconfiglib)： `Kconfig`'s `Python` implementation



## Repos used this framwork



* [Maix-Speech](https://github.com/sipeed/Maix-Speech): AI speech recognization lib for embedded devices

* [MaixPy](https://github.com/sipeed/MaixPy/): `Micropython` port for `AIOT` chip `K210`

* [libmaix](https://github.com/sipeed/libmaix): A lib for embeded AI model running with hardware accelaration

* [MF1_SDK](https://github.com/sipeed/MF1_SDK): SDK for `MF1` AI module(board)



## Other Similar Reference



* [ESP_IDF](https://github.com/espressif/esp-idf)：  `SDK` of `ESP32`, Written very well

* [RT-Thread](https://github.com/RT-Thread/rt-thread)：not `CMake`, but also use component