Files
CMake/Source/cmSourceGroup.h
Cristiano Carvalheiro a46491d0d3 cmLocalGenerator: Improve performance of source group lookups
Introduce an index from source file to source group in
`cmLocalGenerator` to make lookups significantly more efficient
during the source group generation, which could be particularly
slow when dealing with thousands of source files.
Falls back to the recursive lookup when the source file is not present
on the index, which is more likely to happen when dealing with
regex-based sources.

Fixes: #27359
2025-11-26 20:32:19 +00:00

153 lines
3.9 KiB
C++

/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file LICENSE.rst or https://cmake.org/licensing for details. */
#pragma once
#include "cmConfigure.h" // IWYU pragma: keep
#include <memory>
#include <set>
#include <string>
#include <vector>
#include "cmsys/RegularExpression.hxx"
class cmLocalGenerator;
class cmSourceFile;
class cmSourceGroup;
class cmSourceGroupInternals;
using SourceGroupVector = std::vector<std::unique_ptr<cmSourceGroup>>;
/** \class cmSourceGroup
* \brief Hold a group of sources as specified by a SOURCE_GROUP command.
*
* cmSourceGroup holds a regular expression and a list of files. When
* local generators are about to generate the rules for a target's
* files, the set of source groups is consulted to group files
* together. A file is placed into the last source group that lists
* the file by name. If no group lists the file, it is placed into
* the last group whose regex matches it.
*/
class cmSourceGroup
{
public:
cmSourceGroup(std::string name, char const* regex,
char const* parentName = nullptr);
cmSourceGroup(cmSourceGroup const& r) = delete;
~cmSourceGroup();
cmSourceGroup& operator=(cmSourceGroup const&) = delete;
/**
* Set the regular expression for this group.
*/
void SetGroupRegex(char const* regex);
/**
* Resolve genex.
*/
void ResolveGenex(cmLocalGenerator* lg, std::string const& config);
/**
* Add a file name to the explicit list of files for this group.
*/
void AddGroupFile(std::string const& name);
/**
* Add child to this sourcegroup
*/
void AddChild(std::unique_ptr<cmSourceGroup> child);
/**
* Looks up child and returns it
*/
cmSourceGroup* LookupChild(std::string const& name) const;
/**
* Get the name of this group.
*/
std::string const& GetName() const;
/**
* Get the full path name for group.
*/
std::string const& GetFullName() const;
/**
* Check if the given name matches this group's regex.
*/
bool MatchesRegex(std::string const& name) const;
/**
* Check if the given name matches this group's explicit file list.
*/
bool MatchesFiles(std::string const& name) const;
/**
* Check if the given name matches this group's explicit file list
* in children.
*/
cmSourceGroup* MatchChildrenFiles(std::string const& name);
/**
* Check if the given name matches this group's explicit file list
* in children.
*/
cmSourceGroup const* MatchChildrenFiles(std::string const& name) const;
/**
* Check if the given name matches this group's regex in children.
*/
cmSourceGroup* MatchChildrenRegex(std::string const& name) const;
/**
* Assign the given source file to this group. Used only by
* generators.
*/
void AssignSource(cmSourceFile const* sf);
/**
* Get the set of file names explicitly added to this source group.
*/
std::set<std::string> const& GetGroupFiles() const;
/**
* Get the list of the source files that have been assigned to this
* source group.
*/
std::vector<cmSourceFile const*> const& GetSourceFiles() const;
SourceGroupVector const& GetGroupChildren() const;
/**
* Given a source group collection, find the source group for a given source.
*/
static cmSourceGroup* FindSourceGroup(std::string const& source,
SourceGroupVector const& groups);
private:
/**
* The name of the source group.
*/
std::string Name;
// Full path to group
std::string FullName;
/**
* The regular expression matching the files in the group.
*/
cmsys::RegularExpression GroupRegex;
/**
* Set of file names explicitly added to this group.
*/
std::set<std::string> GroupFiles;
/**
* Vector of all source files that have been assigned to
* this group.
*/
std::vector<cmSourceFile const*> SourceFiles;
std::unique_ptr<cmSourceGroupInternals> Internal;
};