mirror of
https://github.com/reactos/CMake.git
synced 2024-11-24 12:09:48 +00:00
86578eccf2
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.
99 lines
2.8 KiB
C++
99 lines
2.8 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#ifndef _cmRST_h
|
|
#define _cmRST_h
|
|
|
|
#include <cmConfigure.h> // IWYU pragma: keep
|
|
|
|
#include <cmsys/RegularExpression.hxx>
|
|
#include <iosfwd>
|
|
#include <map>
|
|
#include <set>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
/** \class cmRST
|
|
* \brief Perform basic .rst processing for command-line help
|
|
*
|
|
* This class implements a subset of reStructuredText and Sphinx
|
|
* document processing. It is used to print command-line help.
|
|
*
|
|
* If you modify the capabilities of this class, be sure to update
|
|
* the Help/manual/cmake-developer.7.rst documentation and to update
|
|
* the Tests/CMakeLib/testRST.(rst|expect) test input and output.
|
|
*/
|
|
class cmRST
|
|
{
|
|
public:
|
|
cmRST(std::ostream& os, std::string const& docroot);
|
|
bool ProcessFile(std::string const& fname, bool isModule = false);
|
|
|
|
private:
|
|
enum IncludeType
|
|
{
|
|
IncludeNormal,
|
|
IncludeModule,
|
|
IncludeTocTree
|
|
};
|
|
enum MarkupType
|
|
{
|
|
MarkupNone,
|
|
MarkupNormal,
|
|
MarkupEmpty
|
|
};
|
|
enum DirectiveType
|
|
{
|
|
DirectiveNone,
|
|
DirectiveParsedLiteral,
|
|
DirectiveLiteralBlock,
|
|
DirectiveCodeBlock,
|
|
DirectiveReplace,
|
|
DirectiveTocTree
|
|
};
|
|
|
|
void ProcessRST(std::istream& is);
|
|
void ProcessModule(std::istream& is);
|
|
void Reset();
|
|
void ProcessLine(std::string const& line);
|
|
void NormalLine(std::string const& line);
|
|
void OutputLine(std::string const& line, bool inlineMarkup);
|
|
std::string ReplaceSubstitutions(std::string const& line);
|
|
void OutputMarkupLines(bool inlineMarkup);
|
|
bool ProcessInclude(std::string file, IncludeType type);
|
|
void ProcessDirectiveParsedLiteral();
|
|
void ProcessDirectiveLiteralBlock();
|
|
void ProcessDirectiveCodeBlock();
|
|
void ProcessDirectiveReplace();
|
|
void ProcessDirectiveTocTree();
|
|
static void UnindentLines(std::vector<std::string>& lines);
|
|
|
|
std::ostream& OS;
|
|
std::string DocRoot;
|
|
int IncludeDepth;
|
|
bool OutputLinePending;
|
|
bool LastLineEndedInColonColon;
|
|
MarkupType Markup;
|
|
DirectiveType Directive;
|
|
cmsys::RegularExpression CMakeDirective;
|
|
cmsys::RegularExpression CMakeModuleDirective;
|
|
cmsys::RegularExpression ParsedLiteralDirective;
|
|
cmsys::RegularExpression CodeBlockDirective;
|
|
cmsys::RegularExpression ReplaceDirective;
|
|
cmsys::RegularExpression IncludeDirective;
|
|
cmsys::RegularExpression TocTreeDirective;
|
|
cmsys::RegularExpression ProductionListDirective;
|
|
cmsys::RegularExpression NoteDirective;
|
|
cmsys::RegularExpression ModuleRST;
|
|
cmsys::RegularExpression CMakeRole;
|
|
cmsys::RegularExpression Substitution;
|
|
cmsys::RegularExpression TocTreeLink;
|
|
|
|
std::vector<std::string> MarkupLines;
|
|
std::string DocDir;
|
|
std::map<std::string, std::string> Replace;
|
|
std::set<std::string> Replaced;
|
|
std::string ReplaceName;
|
|
};
|
|
|
|
#endif
|