kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
CMake/Source/cmRST.h

99 lines
2.8 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. */
Add class cmRST to do basic reStructuredText processing Create a cmRST class to perform just enough reStructuredText processing to support display of Help documents in human-readable text format. This will be used to implement --help-* command-line options. Support directives "include", "replace", "parsed-literal", "toctree" (Sphinx), and "cmake-module" (CMake Sphinx Extension to scan .cmake modules). Support inline CMake Sphinx Domain roles to convert cross-references to corresponding title text. Support inline substitutions defined by the "replace" directive, but keep it simple by requiring replacements to be defined before use. Add a CMakeLib "testRST" case to cover processing of supported constructs and compare results against expected output.
2013-10-01 04:30:57 +04:00
#ifndef _cmRST_h
#define _cmRST_h
fix a load of include-what-you-use violations
2016-09-01 21:59:28 +03:00
#include <cmConfigure.h> // IWYU pragma: keep
Add class cmRST to do basic reStructuredText processing Create a cmRST class to perform just enough reStructuredText processing to support display of Help documents in human-readable text format. This will be used to implement --help-* command-line options. Support directives "include", "replace", "parsed-literal", "toctree" (Sphinx), and "cmake-module" (CMake Sphinx Extension to scan .cmake modules). Support inline CMake Sphinx Domain roles to convert cross-references to corresponding title text. Support inline substitutions defined by the "replace" directive, but keep it simple by requiring replacements to be defined before use. Add a CMakeLib "testRST" case to cover processing of supported constructs and compare results against expected output.
2013-10-01 04:30:57 +04:00
#include <cmsys/RegularExpression.hxx>
fix a load of include-what-you-use violations
2016-09-01 21:59:28 +03:00
#include <iosfwd>
#include <map>
#include <set>
#include <string>
#include <vector>
Add class cmRST to do basic reStructuredText processing Create a cmRST class to perform just enough reStructuredText processing to support display of Help documents in human-readable text format. This will be used to implement --help-* command-line options. Support directives "include", "replace", "parsed-literal", "toctree" (Sphinx), and "cmake-module" (CMake Sphinx Extension to scan .cmake modules). Support inline CMake Sphinx Domain roles to convert cross-references to corresponding title text. Support inline substitutions defined by the "replace" directive, but keep it simple by requiring replacements to be defined before use. Add a CMakeLib "testRST" case to cover processing of supported constructs and compare results against expected output.
2013-10-01 04:30:57 +04:00
cmRST: Cross-reference cmake-developer.7 manual and cmRST Doxygen The cmRST implementation and the list of capabilities documented in the cmake-developer.7 manual must be kept in sync. Add a note to each file to reference the other.
2013-10-22 18:24:25 +04:00
/** \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.
*/
Add class cmRST to do basic reStructuredText processing Create a cmRST class to perform just enough reStructuredText processing to support display of Help documents in human-readable text format. This will be used to implement --help-* command-line options. Support directives "include", "replace", "parsed-literal", "toctree" (Sphinx), and "cmake-module" (CMake Sphinx Extension to scan .cmake modules). Support inline CMake Sphinx Domain roles to convert cross-references to corresponding title text. Support inline substitutions defined by the "replace" directive, but keep it simple by requiring replacements to be defined before use. Add a CMakeLib "testRST" case to cover processing of supported constructs and compare results against expected output.
2013-10-01 04:30:57 +04:00
class cmRST
{
public:
cmRST(std::ostream& os, std::string const& docroot);
bool ProcessFile(std::string const& fname, bool isModule = false);
Revise C++ coding style using clang-format Run the `Utilities/Scripts/clang-format.bash` script to update all our C++ code to a new style defined by `.clang-format`. Use `clang-format` version 3.8. * If you reached this commit for a line in `git blame`, re-run the blame operation starting at the parent of this commit to see older history for the content. * See the parent commit for instructions to rebase a change across this style transition commit.
2016-05-16 17:34:04 +03:00
Add class cmRST to do basic reStructuredText processing Create a cmRST class to perform just enough reStructuredText processing to support display of Help documents in human-readable text format. This will be used to implement --help-* command-line options. Support directives "include", "replace", "parsed-literal", "toctree" (Sphinx), and "cmake-module" (CMake Sphinx Extension to scan .cmake modules). Support inline CMake Sphinx Domain roles to convert cross-references to corresponding title text. Support inline substitutions defined by the "replace" directive, but keep it simple by requiring replacements to be defined before use. Add a CMakeLib "testRST" case to cover processing of supported constructs and compare results against expected output.
2013-10-01 04:30:57 +04:00
private:
enum IncludeType
{
IncludeNormal,
IncludeModule,
IncludeTocTree
};
enum MarkupType
{
MarkupNone,
MarkupNormal,
MarkupEmpty
};
enum DirectiveType
{
DirectiveNone,
DirectiveParsedLiteral,
cmRST: Process literal blocks after paragraphs ending in '::' Teach cmRST to recognize non-markup lines ending in '::' followed by a blank line as starting a literal block. Record the whole block as if it were a literal block directive and print it just like a code block. Extend the CMakeLib.testRST test to cover such cases.
2013-10-21 23:31:44 +04:00
DirectiveLiteralBlock,
Add class cmRST to do basic reStructuredText processing Create a cmRST class to perform just enough reStructuredText processing to support display of Help documents in human-readable text format. This will be used to implement --help-* command-line options. Support directives "include", "replace", "parsed-literal", "toctree" (Sphinx), and "cmake-module" (CMake Sphinx Extension to scan .cmake modules). Support inline CMake Sphinx Domain roles to convert cross-references to corresponding title text. Support inline substitutions defined by the "replace" directive, but keep it simple by requiring replacements to be defined before use. Add a CMakeLib "testRST" case to cover processing of supported constructs and compare results against expected output.
2013-10-01 04:30:57 +04:00
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);
cmRST: Do not process inline markup in code-block literals Move the ProcessDirectiveParsedLiteral and ProcessDirectiveCodeBlock method internals into an OutputMarkupLines helper. Pass through it a new "inlineMarkup" parameter and teach OutputLine to understand it. When false, do not process inline markup. Extend the CMakeLib.testRST test to cover the two cases.
2013-10-21 22:53:25 +04:00
void OutputLine(std::string const& line, bool inlineMarkup);
Add class cmRST to do basic reStructuredText processing Create a cmRST class to perform just enough reStructuredText processing to support display of Help documents in human-readable text format. This will be used to implement --help-* command-line options. Support directives "include", "replace", "parsed-literal", "toctree" (Sphinx), and "cmake-module" (CMake Sphinx Extension to scan .cmake modules). Support inline CMake Sphinx Domain roles to convert cross-references to corresponding title text. Support inline substitutions defined by the "replace" directive, but keep it simple by requiring replacements to be defined before use. Add a CMakeLib "testRST" case to cover processing of supported constructs and compare results against expected output.
2013-10-01 04:30:57 +04:00
std::string ReplaceSubstitutions(std::string const& line);
cmRST: Do not process inline markup in code-block literals Move the ProcessDirectiveParsedLiteral and ProcessDirectiveCodeBlock method internals into an OutputMarkupLines helper. Pass through it a new "inlineMarkup" parameter and teach OutputLine to understand it. When false, do not process inline markup. Extend the CMakeLib.testRST test to cover the two cases.
2013-10-21 22:53:25 +04:00
void OutputMarkupLines(bool inlineMarkup);
Add class cmRST to do basic reStructuredText processing Create a cmRST class to perform just enough reStructuredText processing to support display of Help documents in human-readable text format. This will be used to implement --help-* command-line options. Support directives "include", "replace", "parsed-literal", "toctree" (Sphinx), and "cmake-module" (CMake Sphinx Extension to scan .cmake modules). Support inline CMake Sphinx Domain roles to convert cross-references to corresponding title text. Support inline substitutions defined by the "replace" directive, but keep it simple by requiring replacements to be defined before use. Add a CMakeLib "testRST" case to cover processing of supported constructs and compare results against expected output.
2013-10-01 04:30:57 +04:00
bool ProcessInclude(std::string file, IncludeType type);
void ProcessDirectiveParsedLiteral();
cmRST: Process literal blocks after paragraphs ending in '::' Teach cmRST to recognize non-markup lines ending in '::' followed by a blank line as starting a literal block. Record the whole block as if it were a literal block directive and print it just like a code block. Extend the CMakeLib.testRST test to cover such cases.
2013-10-21 23:31:44 +04:00
void ProcessDirectiveLiteralBlock();
Add class cmRST to do basic reStructuredText processing Create a cmRST class to perform just enough reStructuredText processing to support display of Help documents in human-readable text format. This will be used to implement --help-* command-line options. Support directives "include", "replace", "parsed-literal", "toctree" (Sphinx), and "cmake-module" (CMake Sphinx Extension to scan .cmake modules). Support inline CMake Sphinx Domain roles to convert cross-references to corresponding title text. Support inline substitutions defined by the "replace" directive, but keep it simple by requiring replacements to be defined before use. Add a CMakeLib "testRST" case to cover processing of supported constructs and compare results against expected output.
2013-10-01 04:30:57 +04:00
void ProcessDirectiveCodeBlock();
void ProcessDirectiveReplace();
void ProcessDirectiveTocTree();
static void UnindentLines(std::vector<std::string>& lines);
std::ostream& OS;
std::string DocRoot;
int IncludeDepth;
bool OutputLinePending;
cmRST: Process literal blocks after paragraphs ending in '::' Teach cmRST to recognize non-markup lines ending in '::' followed by a blank line as starting a literal block. Record the whole block as if it were a literal block directive and print it just like a code block. Extend the CMakeLib.testRST test to cover such cases.
2013-10-21 23:31:44 +04:00
bool LastLineEndedInColonColon;
Add class cmRST to do basic reStructuredText processing Create a cmRST class to perform just enough reStructuredText processing to support display of Help documents in human-readable text format. This will be used to implement --help-* command-line options. Support directives "include", "replace", "parsed-literal", "toctree" (Sphinx), and "cmake-module" (CMake Sphinx Extension to scan .cmake modules). Support inline CMake Sphinx Domain roles to convert cross-references to corresponding title text. Support inline substitutions defined by the "replace" directive, but keep it simple by requiring replacements to be defined before use. Add a CMakeLib "testRST" case to cover processing of supported constructs and compare results against expected output.
2013-10-01 04:30:57 +04:00
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;
cmRST: Add support for the note and productionlist directives Simply print out the lines as normal paragraph text. Teach the CMakeLib.testRST test to cover this syntax. Update the cmake-developer.7 manual to document support for the directives.
2013-10-30 00:18:29 +04:00
cmsys::RegularExpression ProductionListDirective;
cmsys::RegularExpression NoteDirective;
cmRST: Teach cmake-module directive to scan bracket comments When scanning CMake module files for .rst comments, recognize bracket comments starting in ".rst:" too. For example: #[[.rst: Include the bracket comment content terminated by the closing bracket. Exclude the line containing the bracket if it starts in "#". Teach the CMakeLib.testRST test to cover multiple bracket lengths and ending brackets on lines with and without "#". Update the cmake-developer.7 manual to document the bracket-comment syntax for .rst documentation.
2013-10-23 03:49:45 +04:00
cmsys::RegularExpression ModuleRST;
Add class cmRST to do basic reStructuredText processing Create a cmRST class to perform just enough reStructuredText processing to support display of Help documents in human-readable text format. This will be used to implement --help-* command-line options. Support directives "include", "replace", "parsed-literal", "toctree" (Sphinx), and "cmake-module" (CMake Sphinx Extension to scan .cmake modules). Support inline CMake Sphinx Domain roles to convert cross-references to corresponding title text. Support inline substitutions defined by the "replace" directive, but keep it simple by requiring replacements to be defined before use. Add a CMakeLib "testRST" case to cover processing of supported constructs and compare results against expected output.
2013-10-01 04:30:57 +04:00
cmsys::RegularExpression CMakeRole;
cmsys::RegularExpression Substitution;
cmRST: Parse toctree lines with Sphinx cross-reference syntax
2016-05-02 20:51:26 +03:00
cmsys::RegularExpression TocTreeLink;
Add class cmRST to do basic reStructuredText processing Create a cmRST class to perform just enough reStructuredText processing to support display of Help documents in human-readable text format. This will be used to implement --help-* command-line options. Support directives "include", "replace", "parsed-literal", "toctree" (Sphinx), and "cmake-module" (CMake Sphinx Extension to scan .cmake modules). Support inline CMake Sphinx Domain roles to convert cross-references to corresponding title text. Support inline substitutions defined by the "replace" directive, but keep it simple by requiring replacements to be defined before use. Add a CMakeLib "testRST" case to cover processing of supported constructs and compare results against expected output.
2013-10-01 04:30:57 +04:00
std::vector<std::string> MarkupLines;
std::string DocDir;
strings: Remove cmStdString references Casts from std::string -> cmStdString were high on the list of things taking up time. Avoid such implicit casts across function calls by just using std::string everywhere. The comment that the symbol name is too long is no longer relevant since modern debuggers alias the templates anyways and the size is a non-issue since the underlying methods are generated since it's inherited.
2014-02-10 09:21:34 +04:00
std::map<std::string, std::string> Replace;
std::set<std::string> Replaced;
Add class cmRST to do basic reStructuredText processing Create a cmRST class to perform just enough reStructuredText processing to support display of Help documents in human-readable text format. This will be used to implement --help-* command-line options. Support directives "include", "replace", "parsed-literal", "toctree" (Sphinx), and "cmake-module" (CMake Sphinx Extension to scan .cmake modules). Support inline CMake Sphinx Domain roles to convert cross-references to corresponding title text. Support inline substitutions defined by the "replace" directive, but keep it simple by requiring replacements to be defined before use. Add a CMakeLib "testRST" case to cover processing of supported constructs and compare results against expected output.
2013-10-01 04:30:57 +04:00
std::string ReplaceName;
};
#endif