CMake Fixes

[ptheywood]

A number of fixes and additions to FLAMEGPU2's CMake encountered when working on a more complex tempalte model.

• flamegpu_new_linter_target fix. Closes CMake: flamegpu_new_linter_target uses PROJECT_NAME not NAME #1057
• Make the lint_flamegpu target OFF by default when this repo is not he primary CMake. Closes CMake: make lint_flamegpu optional / not part of all_lint when included #1045
• Make the docs target OFF by default when this repo is not primary
• Add flamegpu_add_library, for creating static libraries which are more than just linked against FLAMEGPU2 (i.e. warning levels MSVC + CUDA fixes etc. This allows the creation of unit-testable FLAMEGPU 2 simulators.
• Some Refactoring, to reduce duplication
• Demonstrate flamegpu_add_library in an existing example. This may not actually be desirable for merging.
• Fix source_group errors, Closes CMake flamegpu_add_executable source_group errors #1051. Tested on windows.
• Make sure that abs paths with ++ still work (I.e. check I don't break CMake: Escape user-provided regex patterns. #1085 during a rebase)

[ptheywood]

I've got a fix for source groups in place for examples, which always uses the defualt CMAke Source Files and Header Files filters. If files are children of the CMakeProject.txt dir, then they will be placed into the appropraite file structure. If not, they will just be dumped in the root filter (as we don't have a root to create a structure from).

In this case, the fiules main.h and main.cu are from above CMakeLists.txt (i.e. ../main.cu).

If they are a child, then a dir would also be applied, i.e. src:

This shows the application_icon rc being placed together, rather than being the only thing in Source Files as previously

---

@Robadob If you're happy with this prefixing src with Source Files (I don't have a better option otherwise anyway) then I'll do the same for flamegpu for consistency? (which will also simplify it), and then this will be ready to review once I've done that.

I will push it with the examples showing it now behaving correctly in the erranous cases, but a couple of commits will then want dropping prior to merge as they add examples that are not really examples. Unit testing CMake stuff is not something we're set up for.

[Robadob]

I've no strong preference, removing the redundant src seems fine.

[ptheywood]

removing the redundant src seems fine.

For examples we can't really do that, as the src dir may not exist (which could cause errors / issues with the source grouping before) and would then potentially cause folder conflicts, if say the user had this (unwise) setup

├── a
│   └── b.h
└── src
    └── a
        └── b.h

Then intentionally removing src would cause both a's to be the same filter, which contain files with the same name which I'm not sure how VS would handle.

---

We probably could for the flamegpu target, but its probably simpler / more consistent to keep it.

I'll make the change when I'm back in windows at some point.

---

The CI failure is just from my low-effort testing of the folder structures / CMake, so once I drop the appropraite commit it pass.

[Robadob]

removing the redundant src seems fine.

For examples we can't really do that, as the src dir may not exist (which could cause errors / issues with the source grouping before) and would then potentially cause folder conflicts, if say the user had this (unwise) setup

├── a
│   └── b.h
└── src
    └── a
        └── b.h

Then intentionally removing src would cause both a's to be the same filter, which contain files with the same name which I'm not sure how VS would handle.

We probably could for the flamegpu target, but its probably simpler / more consistent to keep it.

I'll make the change when I'm back in windows at some point.

The CI failure is just from my low-effort testing of the folder structures / CMake, so once I drop the appropraite commit it pass.

As I said, no strong preference do what you think best. It's hard to go wrong.

[ptheywood]

I've now made the source_group change to the FLAMEGPU target, so that it places things into the CMake default filters of Header Files and Source Files, but using tree within the FLAMEGPU_ROOT directory (must use FLAMEGPU_ROOT as include is above src/CMakeLists.txt).

This makes it nest deeper, but is consistent.

I'm not strongly opinionated either way, so if you don't like this we can drop the final commit and still merge this anyway.

---

I've also removed the example(s) which showed the previous CMake failures, as they were messy and I'm not aware of a nice way to have a CMake test suite. I have pushed them to another branch cmake-fixes-rc1-with-example if you would like to test them.

Otherwise this PR is ready for review.

[Robadob]

CMake: Demonstrate use of flamegpu_add_library on the host_fucntions example. Maybe don't merge?

Would require example readme discussing, or delete commit.

Rest of the commits look fine, though I didn't really fully process the changes to the static lib refactor the diff was a bit of a mess.

[ptheywood]

I've now dropped the missed "probably don't merge" commit, which was just a test case demonstrating the library use case rather than binary. I'll open an issue to document it on the docs repo and / or use it in a standalone example in the future too.

rebased onto current master as well.

[Robadob]

LGTM