Using Dynamically Generated Header Files with CMake

Sometimes it can be useful to dynamically generate header files and include them from a C source file. However, it can be a little difficult getting CMake to recognize when to generate the files and when to recompile the source files that include those headers. What follows is a method to do this.

Telling CMake to Generate the Header File

To generate the header file we need to create a custom_command which will run the command to generate the header file, when the file it is based on has changed. The following shows how to use the hypothetical generatewordlistheader command to create wordlist.h everytime wordlist.txt changes.

add_custom_command(
    PRE_BUILD
    OUTPUT wordlist.h
    COMMAND generatewordlistheader wordlist.txt wordlist.h
    DEPENDS wordlist.txt
)

Telling CMake When to Recompile

Next we need to tell CMake to recompile any source files which include the generated header file, when the header file has changed. To do this we create a statically linked library, here called poet, that relies on the source files that include the header and the header itself.

add_library(poet STATIC poet.c ${MyApp_SOURCE_DIR}/src/wordlist.h)

Finally we need to ensure that the statically generated library above is linked into the application.

target_link_libraries(myapp poet)

Full example

Using a fictional project called MyApp we can see how this is put together.

cmake_minimum_required(VERSION 2.6)
project(MyApp)
add_executable(myapp myapp.c)

add_custom_command(
    PRE_BUILD
    OUTPUT wordlist.h
    COMMAND generatewordlistheader wordlist.txt wordlist.h
    DEPENDS wordlist.txt
)

add_library(poet STATIC poet.c ${MyApp_SOURCE_DIR}/src/wordlist.h)

target_link_libraries(myapp poet)

Conclusion

This isn't perfect but it does work. Unfortunately CMake is an ugly, but very useful tool. I'm sure there is a better way to do this and if anyone can think of a way, please leave a comment or email me. Until then, this achieves what I and a number of other people have been trying to do.

Creative Commons License
Using Dynamically Generated Header Files with CMake by Lawrence Woodman is licensed under a Creative Commons Attribution 4.0 International License.

Share This Post

Feedback/Discuss

Related Articles

Getting the Address of BASIC Variables on the VIC-20

Getting the address of a BASIC variable can be useful if you want to pass data to a machine code routine or want to access the bytes of a variable directly to improve speed and reduce garbage collectio...   Read More

Saving and Loading Memory on the VIC-20

Saving and loading memory is quite easy on the VIC-20 once you know how. However, it isn't obvious how to do this and therefore this article will present a few simple ways of doing it from BASIC and A...   Read More

Basic Line Storage on the VIC-20

BASIC programs are stored in memory using a simple structure that we can investigate and manipulate. This article will show how they are stored and contains a BASIC program to go through each line of ...   Read More

Programming in Assembly with VICMON on the VIC-20

VICMON is a machine language monitor released by Commodore in 1982 and is great for programming the VIC-20. Its interactive nature means that it can often be quicker to develop via this rather than us...   Read More

Storing Machine Code in REM Statements on the VIC-20

BASIC programs often contain machine code routines but they take up quite a lot of space in BASIC. An interesting way to reduce the amount of space that they take is to store the machine code in REM s...   Read More