Skip to content

Latest commit

 

History

History
117 lines (80 loc) · 4.21 KB

start_working.md

File metadata and controls

117 lines (80 loc) · 4.21 KB
Raw

How to start working

Build System

Big help will be the official CMake docs at cmake.org/cmake/help/latest/. You can consult them for function description.

Other than that CMake is fairly simple language, which can get things done quickly.

If you found yourself in a situation when you do not know the status of variables, use cmake .. -LH or cmake .. -LAH for current variables values.

Start with reading project_folder/CMakeLists.txt and continue to project_folder/source/CMakeLists.txt. If you are interested in testing (you should be), read also project_folder/test/CMakeLists.txt and see how testing is done and so on.

Source code

Function main is in the source/main.cpp.

If you want to add an file, add it to source/CMakeLists.txt into SRCS variable, then it will be compiled to exampleApp target.

Change the name of the executable

Manual proces:

  • packaging/exampleApp.desktop.desktop - rename file, change texts, replace "exampleApp" strings with your new executable name
  • packaging/exampleApp.ico - rename file
  • packaging/exampleApp.icon.in.rc - rename file, replace "exampleApp" strings with your new executable name
  • packaging/exampleApp.png - rename file
  • packaging/CMakeLists.txt - change description texts, windows desktop icon name (CPACK_NSIS_DISPLAY_NAME), replace "exampleApp" strings with your new executable name
  • test/CMakeLists.txt - replace "exampleApp" strings with your new executable name
  • readme.md - replace "exampleApp" strings with your new executable name
  • source/CMakeLists.txt - replace "exampleApp" strings with your new executable name
  • doc/start_working.md - replace "exampleApp" strings with your new executable name
  • doc/directoryStructure.md - replace "exampleApp" strings with your new executable name

Automatic process (for linux):

This expect, that you have installed ag, the silver searcher (faster grep with simpler usage). If you created build directory starting with other than "build", you may want to delete it (ag respects .gitignore, and it would happily wreck your build directory with sed).

We will first rename the files handling icons, then we run sed (streaming editor) and replace all occurences of exampleApp with your new name.

cd [root/of/project]
export NEWNAME="newExecutableName"

git mv packaging/exampleApp.desktop    packaging/${NEWNAME}.desktop
git mv packaging/exampleApp.ico        packaging/${NEWNAME}.ico
git mv packaging/exampleApp.icon.in.rc packaging/${NEWNAME}.icon.in.rc 
git mv packaging/exampleApp.png        packaging/${NEWNAME}.png

ag -l exampleApp | xargs sed -i -e "s/exampleApp/${NEWNAME}/g"

Then change description in .desktop and packaging/CMakeLists.txt files.

Change icon

Just change replace packaging/exampleApp.ico and packaging/exampleApp.png with your own images.

Add depenencies

Look at the external/CMakeLists.txt to see examples on adding external libraries. There are examples for:

  • nlohmann/json - amazing library for json handling
  • spdlog - fast and simple logging library
  • doctest - alternative to catch unit test library
  • fmt - python text/output like formating
  • cpr - requests for humans for C++

Just uncomment the part of the code and add the dependencies via target_link_libraries.

Tests

Unit tests

Checkout catch tutorial.

When you want to add new unit tests, add source file to test/CMakeLists.txt to SRCTEST variable. You can use following snippet to add tests to a file:

#ifdef UNIT_TESTS
#include "catch.hpp"

TEST_CASE("SomeClass set and get")
{
    //setup
    ...

    REQUIRE(something.get() != 2);
}

#endif

This way you can have tests part of an implementation file and yet they will not be part of a regular build because UNIT_TESTS define is defined only for producing unit test binary.

Integration tests

Start with test/CMakeLists.txt, it is pretty straightforward. See cmake documentation for more information. By default test checks for return value (must be zero), but with PASS_REGULAR_EXPRESSION and FAIL_REGULAR_EXPRESSION that can be changed.