Is there a way to specify project files explicitly?

[d-s-h]

Given an example project folder structure:

  + 3rdparty
  + src
    .gitmodules
    myproj.sharpmake.cs
    mylib.sharpmake.cs
    README.md

I'd like to have in my vsxproj file only the src folder files and *.sharpmake.cs files, avoiding filtering out 3rdparty folder files.
The preferrable way would be by explicitly specifying these items to add via wildcards, like this pseudo-code:

SourceFiles.Add("src/**.h");
SourceFiles.Add("src/**.cpp");
SourceFiles.Add("*.sharpmake.cs");

Unfortunately I see no way to do like that. Instead I have to add the whole root folder to the project then filtering extra files out by regex expressions, which doesn't seem easy for such a simple case.

What's the proper way to handle my situation?

[jspelletier]

This should work:
project.SourceRootPath = "src";

[d-s-h]

Thank you for your feedback.

However, I think I didn't present my idea clear enough. The initial idea is to be able to add files from a root project folder too ("*.sharpmake.cs" in my example), and any other files based on wildcards.
Please, take a look at my fix which meets things what I wanted to do.
Add a Glob package and use it for adding files to a project with wildcards instead of regex filtering
Please let me know if you can't see it.

So now I can simply do the following to add only specific files to my project:

SourceFilesIncludeWildcards.Add("src/**/*.h");
SourceFilesIncludeWildcards.Add("src/**/*.cpp");
SourceFilesIncludeWildcards.Add("*.sharpmake.cs");

I'm not sure if my change satisfies PR requirements, but it would be cool to have such a feature in the main branch.

Regards.

[jspelletier]

Hi,
What is the advantage of this compared to the existing regexes ? The actual way to specify source files works and could easily satisfy this kind of source hierarchy, so I'm not sure I want to add another alternative way to do that. More code = more maintenance even if here there is not a lot of code added in this PR.

Will dicuss it with other maintainers soon.

[d-s-h]

To be honest I just couldn't figure out how to properly prepare regex and filtering rules to correctly glob files I want.
I need to include C++ and shader files from the src folder and project/script files from the root folder. In the same time I need to avoid scanning of the 3rdpart folder which may contain thousand of various files.

Premake5 example:

files
{
	path.join("src/**.h"),
	path.join("src/**.cpp"),
	path.join("src/**.inl"),
	path.join("src/**.sh"),
	path.join("src/**.sc"),
	path.join("*.lua"), -- Premake5 project
	path.join("*.bat") -- helper scripts
}

CMake equivalent:

file (GLOB SRC_FILES 
    ${PROJECT_SOURCE_DIR}/src/*.h
    ${PROJECT_SOURCE_DIR}/src/**/*.h
    ${PROJECT_SOURCE_DIR}/src/*.cpp
    ${PROJECT_SOURCE_DIR}/src/**/*.cpp
    ${PROJECT_SOURCE_DIR}/src/*.inl
    ${PROJECT_SOURCE_DIR}/src/**/*.inl
    ${PROJECT_SOURCE_DIR}/src/*.sh
    ${PROJECT_SOURCE_DIR}/src/**/*.sh
    ${PROJECT_SOURCE_DIR}/src/*.sc
    ${PROJECT_SOURCE_DIR}/src/**/*.sc
    ${PROJECT_SOURCE_DIR}/*.lua
    ${PROJECT_SOURCE_DIR}/*.bat
)

Or GLOB_RECURSE could be used to simplify the example, but I wanted to show '**' usage.

With my change I could easily manage to port my Premake5 build scripts to Sharpmake ones:

SourceFilesIncludeWildcards.Add("*.bat");
SourceFilesIncludeWildcards.Add("*.sharpmake.cs");
SourceFilesIncludeWildcards.Add("src/**/*.h");
SourceFilesIncludeWildcards.Add("src/**/*.cpp");
SourceFilesIncludeWildcards.Add("src/**/*.inl");
SourceFilesIncludeWildcards.Add("src/**/*.sh");
SourceFilesIncludeWildcards.Add("src/**/*.sc");

It would be interesting how to handle this case in the vanilla Sharpmake.

In general wildcard based rules look simpler than regex ones and usually faster performance-wise to parse and execute. But it depends on implementations, of course.

[jspelletier]

Hi,

Sharpmake already knows about many of the extensions your need:
public Strings SourceFilesExtensions = new Strings(".cpp", ".c", ".cc", ".h", ".inl", ".hpp", ".hh", ".asm");// All files under SourceRootPath are evaluated, if match found, it will be added to SourceFiles

For the first project in the thread, could do:

[Sharpmake.Generate]
public class MyProjectFirstCase : Project
{
    public MyProject()
    {
        SourceRootPath = "[project.SharpmakeCsPath]\src";
        SourceFilesExtensions.AddRange(".sc", ".sh");
        SourceFiles.Add("myproj.sharpmake.cs");
        SourceFiles.Add("mylib.sharpmake.cs");
    }
   
}

// For second project in the thread
// Would suggest you move the .bat and .lua scripts in a subdirectory if possible.
That would let you to use AdditionalSourceRootPaths as shown below

[Sharpmake.Generate]
public class MyProjectSecondCase : Project
{
    public MyProject()
    {
        SourceRootPath = "[project.SharpmakeCsPath]\src";
        SourceFilesExtensions.AddRange(".sc", ".sh", ".lua", ".bat");
        AdditionalSourceRootPaths.Add([project.SharpmakeCsPath]\helpers"); // assumes .bat and .lua are moved there
    }
}

// Alternative could be that you do the globbing yourself in the project constructor and add to SourceFiles container.
// Would suggest you move the .bat and .lua scripts in a subdirectory if possible.

[Sharpmake.Generate]
public class MyProjectAlternative : Project
{
    public MyProject()
    {
        SourceRootPath = "[project.SharpmakeCsPath]\src";
        SourceFilesExtensions.AddRange(".sc", ".sh", ".lua", ".bat");
        SourceFiles.AddRange(Glob.Files(SharpmakeCsPath, "*.bat"));
        SourceFiles.AddRange(Glob.Files(SharpmakeCsPath, "*.lua"));
    }
}

[d-s-h]

Nice. Explicit file adding looks suitable for me. Indeed this way I can use the Glob class just in my project without Sharpmake modification.
Merci Jean-Sébastien.

[jspelletier]

You're welcome.