CMake/Source/cmSourceGroup.h

128 lines
3.0 KiB
C
Raw Normal View History

Simplify CMake per-source license notices Per-source copyright/license notice headers that spell out copyright holder names and years are hard to maintain and often out-of-date or plain wrong. Precise contributor information is already maintained automatically by the version control tool. Ultimately it is the receiver of a file who is responsible for determining its licensing status, and per-source notices are merely a convenience. Therefore it is simpler and more accurate for each source to have a generic notice of the license name and references to more detailed information on copyright holders and full license terms. Our `Copyright.txt` file now contains a list of Contributors whose names appeared source-level copyright notices. It also references version control history for more precise information. Therefore we no longer need to spell out the list of Contributors in each source file notice. Replace CMake per-source copyright/license notice headers with a short description of the license and links to `Copyright.txt` and online information available from "https://cmake.org/licensing". The online URL also handles cases of modules being copied out of our source into other projects, so we can drop our notices about replacing links with full license text. Run the `Utilities/Scripts/filter-notices.bash` script to perform the majority of the replacements mechanically. Manually fix up shebang lines and trailing newlines in a few files. Manually update the notices in a few files that the script does not handle.
2016-09-27 22:01:08 +03:00
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#ifndef cmSourceGroup_h
#define cmSourceGroup_h
#include <cmConfigure.h>
#include <cmsys/RegularExpression.hxx>
#include <set>
#include <string>
#include <vector>
2002-03-04 22:14:41 +03:00
class cmSourceFile;
class cmSourceGroupInternals;
/** \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(const char* name, const char* regex,
2016-06-27 23:44:16 +03:00
const char* parentName = CM_NULLPTR);
cmSourceGroup(cmSourceGroup const& r);
~cmSourceGroup();
cmSourceGroup& operator=(cmSourceGroup const&);
/**
* Set the regular expression for this group.
*/
void SetGroupRegex(const char* regex);
/**
* Add a file name to the explicit list of files for this group.
*/
void AddGroupFile(const std::string& name);
2005-07-13 19:21:30 +04:00
/**
* Add child to this sourcegroup
*/
void AddChild(cmSourceGroup const& child);
2005-07-13 19:21:30 +04:00
/**
* Looks up child and returns it
*/
cmSourceGroup* LookupChild(const char* name) const;
/**
* Get the name of this group.
*/
const char* GetName() const;
/**
* Get the full path name for group.
*/
const char* GetFullName() const;
/**
* Check if the given name matches this group's regex.
*/
bool MatchesRegex(const char* name);
/**
* Check if the given name matches this group's explicit file list.
*/
bool MatchesFiles(const char* name);
2005-07-13 19:21:30 +04:00
/**
2006-03-10 19:13:15 +03:00
* Check if the given name matches this group's explicit file list
* in children.
2005-07-13 19:21:30 +04:00
*/
cmSourceGroup* MatchChildrenFiles(const char* name);
2005-07-13 19:21:30 +04:00
/**
* Check if the given name matches this group's regex in children.
*/
cmSourceGroup* MatchChildrenRegex(const char* name);
/**
* Assign the given source file to this group. Used only by
* generators.
*/
void AssignSource(const cmSourceFile* sf);
2003-06-03 18:30:23 +04:00
/**
* Get the list of the source files that have been assigned to this
* source group.
2003-06-03 18:30:23 +04:00
*/
const std::vector<const cmSourceFile*>& GetSourceFiles() const;
std::vector<cmSourceGroup> const& GetGroupChildren() const;
private:
/**
* The name of the source group.
*/
2006-03-15 19:02:08 +03:00
std::string Name;
// Full path to group
std::string FullName;
/**
* The regular expression matching the files in the group.
*/
2006-03-15 19:02:08 +03:00
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.
*/
2006-03-15 19:02:08 +03:00
std::vector<const cmSourceFile*> SourceFiles;
2005-07-13 19:21:30 +04:00
cmSourceGroupInternals* Internal;
};
#endif