mirror of
https://github.com/Kitware/CMake.git
synced 2025-05-09 14:57:08 +08:00
bdca8b01d2
#pragma once is a widely supported compiler pragma, even though it is not part of the C++ standard. Many of the issues keeping #pragma once from being standardized (distributed filesystems, build farms, hard links, etc.) do not apply to CMake - it is easy to build CMake on a single machine. CMake also does not install any header files which can be consumed by other projects (though cmCPluginAPI.h has been deliberately omitted from this conversion in case anyone is still using it.) Finally, #pragma once has been required to build CMake since at least August 2017 (7f29bbe6 enabled server mode unconditionally, which had been using #pragma once since September 2016 (b13d3e0d)). The fact that we now require C++11 filters out old compilers, and it is unlikely that there is a compiler which supports C++11 but does not support #pragma once.
127 lines
4.5 KiB
C++
127 lines
4.5 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#pragma once
|
|
|
|
#include "cmConfigure.h" // IWYU pragma: keep
|
|
|
|
#include <iosfwd>
|
|
#include <map>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "cmDocumentationFormatter.h"
|
|
#include "cmDocumentationSection.h"
|
|
|
|
struct cmDocumentationEntry;
|
|
|
|
/** Class to generate documentation. */
|
|
class cmDocumentation : public cmDocumentationEnums
|
|
{
|
|
public:
|
|
cmDocumentation();
|
|
|
|
/**
|
|
* Check command line arguments for documentation options. Returns
|
|
* true if documentation options are found, and false otherwise.
|
|
* When true is returned, PrintRequestedDocumentation should be
|
|
* called. exitOpt can be used for things like cmake -E, so that
|
|
* all arguments after the -E are ignored and not searched for
|
|
* help arguments.
|
|
*/
|
|
bool CheckOptions(int argc, const char* const* argv,
|
|
const char* exitOpt = nullptr);
|
|
|
|
/**
|
|
* Print help requested on the command line. Call after
|
|
* CheckOptions returns true. Returns true on success, and false
|
|
* otherwise. Failure can occur when output files specified on the
|
|
* command line cannot be written.
|
|
*/
|
|
bool PrintRequestedDocumentation(std::ostream& os);
|
|
|
|
/** Print help of the given type. */
|
|
bool PrintDocumentation(Type ht, std::ostream& os);
|
|
|
|
void SetShowGenerators(bool showGen) { this->ShowGenerators = showGen; }
|
|
|
|
/** Set the program name for standard document generation. */
|
|
void SetName(const std::string& name);
|
|
|
|
/** Set a section of the documentation. Typical sections include Name,
|
|
Usage, Description, Options */
|
|
void SetSection(const char* sectionName, cmDocumentationSection section);
|
|
void SetSection(const char* sectionName,
|
|
std::vector<cmDocumentationEntry>& docs);
|
|
void SetSection(const char* sectionName, const char* docs[][2]);
|
|
void SetSections(std::map<std::string, cmDocumentationSection> sections);
|
|
|
|
/** Add the documentation to the beginning/end of the section */
|
|
void PrependSection(const char* sectionName, const char* docs[][2]);
|
|
void PrependSection(const char* sectionName,
|
|
std::vector<cmDocumentationEntry>& docs);
|
|
void PrependSection(const char* sectionName, cmDocumentationEntry& docs);
|
|
void AppendSection(const char* sectionName, const char* docs[][2]);
|
|
void AppendSection(const char* sectionName,
|
|
std::vector<cmDocumentationEntry>& docs);
|
|
void AppendSection(const char* sectionName, cmDocumentationEntry& docs);
|
|
|
|
/** Add common (to all tools) documentation section(s) */
|
|
void addCommonStandardDocSections();
|
|
|
|
/** Add the CMake standard documentation section(s) */
|
|
void addCMakeStandardDocSections();
|
|
|
|
/** Add the CTest standard documentation section(s) */
|
|
void addCTestStandardDocSections();
|
|
|
|
/** Add the CPack standard documentation section(s) */
|
|
void addCPackStandardDocSections();
|
|
|
|
private:
|
|
void GlobHelp(std::vector<std::string>& files, std::string const& pattern);
|
|
void PrintNames(std::ostream& os, std::string const& pattern);
|
|
bool PrintFiles(std::ostream& os, std::string const& pattern);
|
|
|
|
bool PrintVersion(std::ostream& os);
|
|
bool PrintUsage(std::ostream& os);
|
|
bool PrintHelp(std::ostream& os);
|
|
bool PrintHelpFull(std::ostream& os);
|
|
bool PrintHelpOneManual(std::ostream& os);
|
|
bool PrintHelpOneCommand(std::ostream& os);
|
|
bool PrintHelpOneModule(std::ostream& os);
|
|
bool PrintHelpOnePolicy(std::ostream& os);
|
|
bool PrintHelpOneProperty(std::ostream& os);
|
|
bool PrintHelpOneVariable(std::ostream& os);
|
|
bool PrintHelpListManuals(std::ostream& os);
|
|
bool PrintHelpListCommands(std::ostream& os);
|
|
bool PrintHelpListModules(std::ostream& os);
|
|
bool PrintHelpListProperties(std::ostream& os);
|
|
bool PrintHelpListVariables(std::ostream& os);
|
|
bool PrintHelpListPolicies(std::ostream& os);
|
|
bool PrintHelpListGenerators(std::ostream& os);
|
|
bool PrintOldCustomModules(std::ostream& os);
|
|
|
|
const char* GetNameString() const;
|
|
bool IsOption(const char* arg) const;
|
|
|
|
bool ShowGenerators;
|
|
|
|
std::string NameString;
|
|
std::map<std::string, cmDocumentationSection> AllSections;
|
|
cmDocumentationSection& SectionAtName(const char* name);
|
|
|
|
std::string CurrentArgument;
|
|
|
|
struct RequestedHelpItem
|
|
{
|
|
cmDocumentationEnums::Type HelpType = None;
|
|
std::string Filename;
|
|
std::string Argument;
|
|
};
|
|
|
|
std::vector<RequestedHelpItem> RequestedHelpItems;
|
|
cmDocumentationFormatter Formatter;
|
|
|
|
static void WarnFormFromFilename(RequestedHelpItem& request, bool& result);
|
|
};
|