{"id":5270,"date":"2019-11-13T15:03:11","date_gmt":"2019-11-13T23:03:11","guid":{"rendered":"https:\/\/visualgdb.com\/w\/?p=5270"},"modified":"2020-04-29T11:14:20","modified_gmt":"2020-04-29T18:14:20","slug":"using-custom-cmake-target-properties-with-visualgdb","status":"publish","type":"post","link":"https:\/\/visualgdb.com\/tutorials\/cmake\/targets\/","title":{"rendered":"Using Custom CMake Target Properties with VisualGDB"},"content":{"rendered":"

Large CMake-based codebases often use custom macros or functions for defining executables and libraries instead of the regular add_executable()<\/strong> and add_library()<\/strong> statements. This tutorial shows how to configure VisualGDB to automatically recognize those custom statements and automatically edit them in response to adding\/removing source files in Solution Explorer or changing properties via the Target Properties window.<\/p>\n

We will create a CMake-based project, add 2 CMake functions for defining custom targets using the semantics similar to the ESP-IDF<\/a> framework and the MySQL codebase<\/a> and show how to configure VisualGDB to recognize those statements.<\/p>\n

Before you begin, install VisualGDB 5.5 or later.<\/p>\n

    \n
  1. Start Visual Studio and locate the VisualGDB Linux Project Wizard:\"\"<\/a><\/li>\n
  2. Specify the name and location for your project:\"\"<\/a><\/li>\n
  3. On the first page of the Linux Project Wizard select “Application -> CMake -> Use the Advanced CMake Project Subsystem”: \"\"<\/a><\/li>\n
  4. On the next page of the wizard select your target. In this tutorial we will build the project on the Windows machine using the Raspberry Pi cross-toolchain, however the steps described here will also apply for projects built on the Linux side:\"\"<\/a>Click “Finish” to finish generating the project. VisualGDB will create a basic CMake project with one target.<\/li>\n
  5. Now we will add 4 library targets to the project and will later convert them to use the custom macros. Select “Add->New Item”<\/strong> in Solution Explorer:\"\"<\/a><\/li>\n
  6. Pick “Static Library<\/strong>” and click “Add<\/strong>“:\"\"<\/a><\/li>\n
  7. Add 3 more libraries until the main CMakeLists.txt<\/strong> file declares 4 different libraries:\"\"<\/a><\/li>\n
  8. Create a new text file and save it under <Project Directory>\\functions.cmake<\/strong>. Then add the following content to it:\n
    function(register_static_library NAME)\r\n\tadd_library(Static${NAME} ${ARGN})\r\nendfunction(register_static_library)\r\n\r\nfunction(set_static_library_cflags NAME)\r\n\ttarget_compile_options(Static${NAME} PRIVATE ${ARGN})\r\nendfunction(set_static_library_cflags)\r\n\r\nfunction(register_shared_library)\r\n\tcmake_parse_arguments(_ \"\" \"NAME\" \"SOURCES;CFLAGS\" ${ARGN})\r\n\r\n\tadd_library(Shared${__NAME} SHARED ${__SOURCES})\r\n\ttarget_compile_options(Shared${__NAME} PRIVATE ${__CFLAGS})\r\nendfunction(register_shared_library)<\/pre>\n
    This defines 3 custom CMake functions:<\/p>\n