fredsson / cmakegen

CMAKEGEN

Building on Windows

First step is to install Visual Studio in order to get the MSVC compiler and Windows SDK which are required for the next steps

Next step is to download and install cmake

Next prepare the environment so that cmake can find all dependencies during setup We will need the following

INCLUDE=VS_INSTALL_PATH\VC\Tools\MSVC\14.29.30133\include;WINDOWS_SDK_PATH\10\Include\10.0.19041.0\ucrt;WINDOWS_SDK_PATH\10\Include\10.0.19041.0\um

LIB=VS_INSTALL_PATH\VC\Tools\MSVC\14.29.30133\lib\x64;WINDOWS_SDK_PATH\Lib\10.0.19041.0\um\x64;WINDOWS_SDK_PATH\Lib\10.0.19041.0\ucrt\x64

CXX=VS_INSTALL_PATH\VC\Tools\MSVC\14.29.30133\bin\Hostx64\x64\cl.exe

Then add the following to the PATH

WINDOWS_SDK_PATH\bin\10.0.19041.0\x64

This will allow us to run rc.exe, the root directories for me was:

VS_INSTALL_PATH=C:\Program Files (x86)\Microsoft Visual Studio\2019\Community

WINDOWS_SDK_PATH=C:\Program Files (x86)\Windows Kits\10

In order to use Ninja as build tool we can either use the one provided by VS or provide it ourselves, I downloaded it from the official Github and add it to the PATH.

Once all of this is done create the directory used for output:

# mkdir _build

and then start the build with:

# cd _build
# cmake -GNinja -DCMAKE_BUILD_TYPE=Release ..
# ninja

This should provide a cmakegen.exe that can be added to the PATH for convenience

cmakegen's Issues

Build stuck when running in certain project structures

When trying to run cmakegen with -b on this project it never finish, probably this is due to unknown character or directory resulting in an endless loop

Files that has only been moved are not updated.

If you move a file from one location to another, the -b option will not update the CMakeLists.txt, and the build will fail with a missing file.

Description

A description would help others understand what type of project this is and what to expect from it.

Improve linking with stdc++fs

currently finding stdc++fs is hard coded in the CMakeLists, this will result in errors for anyone trying to build with library in a different location

compile options for visual studio

Generated compile options does not work in visual studio generated project.

Different ordering for include and src files in CMakeLists depending on computer

Ordering is now indeterministic meaning that files might move around in the SRC_FILES and INCLUDE_FILES lists without any files being added / removed. This makes it harder to see what has actually changed when pushing in git. A fix for this would be to always sort the files in asc order.

No executable added when updating project

If the inital project is generated without any source files, and source files are added afterwards no add_executable or add_library is added when running with the -b switch

make is not a valid command on windows

When running cmakegen -b, it tries to run the make command even if it's not available

Empty include files function in generator

When you generate the first CMakeLists.txt for the project it will put a empty set(INCLUDE_FILES) in the file.

Readme

Would be much easier using the project if there was a readme

Generated CMakeLists.txt has incorrect formatting

First time you generate CMakeLists.txt files for the project all functions are inserted without spacing.

Missing header files

Cmakefile should contain all the header files as well, since they are needed for building on windows

Does not allow ':' or '-' in cmake file

the scanner should not throw these characters away.

Might want to consider using the regexp from the official lexer instead.

Potential leak of memory warning

When building the project clang analyzer warns of a potential memory leak in the walk directory function

Cleanup warnings generated by clang tidy

Clean build of project currently generate a lot of warnings that should be fixed

source files variable contain duplications

If there is two sub projects both containing a main.cpp for example, then one of the project's source files variable will contain two entries for ./main.cpp