diff options
author | Kitware Robot <kwrobot@kitware.com> | 2016-05-16 14:34:04 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2016-05-16 20:05:19 (GMT) |
commit | d9fd2f5402eeaa345691313658e02b51038f570b (patch) | |
tree | dca71b9a7e267f4c6300da3eb770415381726785 /Source/cmDocumentation.cxx | |
parent | 82df6deaafb36cbbfd450202bb20b320f637751a (diff) | |
download | CMake-d9fd2f5402eeaa345691313658e02b51038f570b.zip CMake-d9fd2f5402eeaa345691313658e02b51038f570b.tar.gz CMake-d9fd2f5402eeaa345691313658e02b51038f570b.tar.bz2 |
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.
Diffstat (limited to 'Source/cmDocumentation.cxx')
-rw-r--r-- | Source/cmDocumentation.cxx | 599 |
1 files changed, 228 insertions, 371 deletions
diff --git a/Source/cmDocumentation.cxx b/Source/cmDocumentation.cxx index d3793c2..68a8488 100644 --- a/Source/cmDocumentation.cxx +++ b/Source/cmDocumentation.cxx @@ -24,56 +24,37 @@ #include <algorithm> -static const char *cmDocumentationStandardOptions[][2] = -{ - {"--help,-help,-usage,-h,-H,/?", - "Print usage information and exit."}, - {"--version,-version,/V [<f>]", - "Print version number and exit."}, - {"--help-full [<f>]", - "Print all help manuals and exit."}, - {"--help-manual <man> [<f>]", - "Print one help manual and exit."}, - {"--help-manual-list [<f>]", - "List help manuals available and exit."}, - {"--help-command <cmd> [<f>]", - "Print help for one command and exit."}, - {"--help-command-list [<f>]", - "List commands with help available and exit."}, - {"--help-commands [<f>]", - "Print cmake-commands manual and exit."}, - {"--help-module <mod> [<f>]", - "Print help for one module and exit."}, - {"--help-module-list [<f>]", - "List modules with help available and exit."}, - {"--help-modules [<f>]", - "Print cmake-modules manual and exit."}, - {"--help-policy <cmp> [<f>]", - "Print help for one policy and exit."}, - {"--help-policy-list [<f>]", - "List policies with help available and exit."}, - {"--help-policies [<f>]", - "Print cmake-policies manual and exit."}, - {"--help-property <prop> [<f>]", - "Print help for one property and exit."}, - {"--help-property-list [<f>]", - "List properties with help available and exit."}, - {"--help-properties [<f>]", - "Print cmake-properties manual and exit."}, - {"--help-variable var [<f>]", - "Print help for one variable and exit."}, - {"--help-variable-list [<f>]", - "List variables with help available and exit."}, - {"--help-variables [<f>]", - "Print cmake-variables manual and exit."}, - {0,0} +static const char* cmDocumentationStandardOptions[][2] = { + { "--help,-help,-usage,-h,-H,/?", "Print usage information and exit." }, + { "--version,-version,/V [<f>]", "Print version number and exit." }, + { "--help-full [<f>]", "Print all help manuals and exit." }, + { "--help-manual <man> [<f>]", "Print one help manual and exit." }, + { "--help-manual-list [<f>]", "List help manuals available and exit." }, + { "--help-command <cmd> [<f>]", "Print help for one command and exit." }, + { "--help-command-list [<f>]", + "List commands with help available and exit." }, + { "--help-commands [<f>]", "Print cmake-commands manual and exit." }, + { "--help-module <mod> [<f>]", "Print help for one module and exit." }, + { "--help-module-list [<f>]", "List modules with help available and exit." }, + { "--help-modules [<f>]", "Print cmake-modules manual and exit." }, + { "--help-policy <cmp> [<f>]", "Print help for one policy and exit." }, + { "--help-policy-list [<f>]", + "List policies with help available and exit." }, + { "--help-policies [<f>]", "Print cmake-policies manual and exit." }, + { "--help-property <prop> [<f>]", "Print help for one property and exit." }, + { "--help-property-list [<f>]", + "List properties with help available and exit." }, + { "--help-properties [<f>]", "Print cmake-properties manual and exit." }, + { "--help-variable var [<f>]", "Print help for one variable and exit." }, + { "--help-variable-list [<f>]", + "List variables with help available and exit." }, + { "--help-variables [<f>]", "Print cmake-variables manual and exit." }, + { 0, 0 } }; -static const char *cmDocumentationGeneratorsHeader[][2] = -{ - {0, - "The following generators are available on this platform:"}, - {0,0} +static const char* cmDocumentationGeneratorsHeader[][2] = { + { 0, "The following generators are available on this platform:" }, + { 0, 0 } }; cmDocumentation::cmDocumentation() @@ -102,8 +83,7 @@ bool cmDocumentation::PrintVersion(std::ostream& os) bool cmDocumentation::PrintDocumentation(Type ht, std::ostream& os) { - switch (ht) - { + switch (ht) { case cmDocumentation::Usage: return this->PrintUsage(os); case cmDocumentation::Help: @@ -140,8 +120,9 @@ bool cmDocumentation::PrintDocumentation(Type ht, std::ostream& os) return this->PrintVersion(os); case cmDocumentation::OldCustomModules: return this->PrintOldCustomModules(os); - default: return false; - } + default: + return false; + } } bool cmDocumentation::PrintRequestedDocumentation(std::ostream& os) @@ -150,323 +131,249 @@ bool cmDocumentation::PrintRequestedDocumentation(std::ostream& os) bool result = true; // Loop over requested documentation types. - for(std::vector<RequestedHelpItem>::const_iterator - i = this->RequestedHelpItems.begin(); - i != this->RequestedHelpItems.end(); - ++i) - { + for (std::vector<RequestedHelpItem>::const_iterator i = + this->RequestedHelpItems.begin(); + i != this->RequestedHelpItems.end(); ++i) { this->CurrentArgument = i->Argument; // If a file name was given, use it. Otherwise, default to the // given stream. cmsys::ofstream* fout = 0; std::ostream* s = &os; - if(!i->Filename.empty()) - { + if (!i->Filename.empty()) { fout = new cmsys::ofstream(i->Filename.c_str(), std::ios::out); - if(fout) - { + if (fout) { s = fout; - } - else - { + } else { result = false; - } } - else if(++count > 1) - { + } else if (++count > 1) { os << "\n\n"; - } + } // Print this documentation type to the stream. - if(!this->PrintDocumentation(i->HelpType, *s) || !*s) - { + if (!this->PrintDocumentation(i->HelpType, *s) || !*s) { result = false; - } + } // Close the file if we wrote one. - if(fout) - { + if (fout) { delete fout; - } } + } return result; } -#define GET_OPT_ARGUMENT(target) \ - if((i+1 < argc) && !this->IsOption(argv[i+1])) \ - { \ - target = argv[i+1]; \ - i = i+1; \ - }; - +#define GET_OPT_ARGUMENT(target) \ + if ((i + 1 < argc) && !this->IsOption(argv[i + 1])) { \ + target = argv[i + 1]; \ + i = i + 1; \ + }; void cmDocumentation::WarnFormFromFilename( cmDocumentation::RequestedHelpItem& request, bool& result) { std::string ext = cmSystemTools::GetFilenameLastExtension(request.Filename); ext = cmSystemTools::UpperCase(ext); - if ((ext == ".HTM") || (ext == ".HTML")) - { + if ((ext == ".HTM") || (ext == ".HTML")) { request.HelpType = cmDocumentation::None; result = true; cmSystemTools::Message("Warning: HTML help format no longer supported"); - } - else if (ext == ".DOCBOOK") - { + } else if (ext == ".DOCBOOK") { request.HelpType = cmDocumentation::None; result = true; cmSystemTools::Message("Warning: Docbook help format no longer supported"); - } + } // ".1" to ".9" should be manpages - else if ((ext.length()==2) && (ext[1] >='1') && (ext[1]<='9')) - { + else if ((ext.length() == 2) && (ext[1] >= '1') && (ext[1] <= '9')) { request.HelpType = cmDocumentation::None; result = true; cmSystemTools::Message("Warning: Man help format no longer supported"); - } + } } void cmDocumentation::addCommonStandardDocSections() { - cmDocumentationSection *sec; + cmDocumentationSection* sec; - sec = new cmDocumentationSection("Options","OPTIONS"); - sec->Append(cmDocumentationStandardOptions); - this->AllSections["Options"] = sec; + sec = new cmDocumentationSection("Options", "OPTIONS"); + sec->Append(cmDocumentationStandardOptions); + this->AllSections["Options"] = sec; } void cmDocumentation::addCMakeStandardDocSections() { - cmDocumentationSection *sec; + cmDocumentationSection* sec; - sec = new cmDocumentationSection("Generators","GENERATORS"); - sec->Append(cmDocumentationGeneratorsHeader); - this->AllSections["Generators"] = sec; + sec = new cmDocumentationSection("Generators", "GENERATORS"); + sec->Append(cmDocumentationGeneratorsHeader); + this->AllSections["Generators"] = sec; } void cmDocumentation::addCTestStandardDocSections() { - // This is currently done for backward compatibility reason - // We may suppress some of these. - addCMakeStandardDocSections(); + // This is currently done for backward compatibility reason + // We may suppress some of these. + addCMakeStandardDocSections(); } void cmDocumentation::addCPackStandardDocSections() { - cmDocumentationSection *sec; + cmDocumentationSection* sec; - sec = new cmDocumentationSection("Generators","GENERATORS"); - sec->Append(cmDocumentationGeneratorsHeader); - this->AllSections["Generators"] = sec; + sec = new cmDocumentationSection("Generators", "GENERATORS"); + sec->Append(cmDocumentationGeneratorsHeader); + this->AllSections["Generators"] = sec; } bool cmDocumentation::CheckOptions(int argc, const char* const* argv, const char* exitOpt) { // Providing zero arguments gives usage information. - if(argc == 1) - { + if (argc == 1) { RequestedHelpItem help; help.HelpType = cmDocumentation::Usage; this->RequestedHelpItems.push_back(help); return true; - } + } // Search for supported help options. bool result = false; - for(int i=1; i < argc; ++i) - { - if(exitOpt && strcmp(argv[i], exitOpt) == 0) - { + for (int i = 1; i < argc; ++i) { + if (exitOpt && strcmp(argv[i], exitOpt) == 0) { return result; - } + } RequestedHelpItem help; // Check if this is a supported help option. - if((strcmp(argv[i], "-help") == 0) || - (strcmp(argv[i], "--help") == 0) || - (strcmp(argv[i], "/?") == 0) || - (strcmp(argv[i], "-usage") == 0) || - (strcmp(argv[i], "-h") == 0) || - (strcmp(argv[i], "-H") == 0)) - { + if ((strcmp(argv[i], "-help") == 0) || (strcmp(argv[i], "--help") == 0) || + (strcmp(argv[i], "/?") == 0) || (strcmp(argv[i], "-usage") == 0) || + (strcmp(argv[i], "-h") == 0) || (strcmp(argv[i], "-H") == 0)) { help.HelpType = cmDocumentation::Help; GET_OPT_ARGUMENT(help.Argument); help.Argument = cmSystemTools::LowerCase(help.Argument); // special case for single command - if (!help.Argument.empty()) - { + if (!help.Argument.empty()) { help.HelpType = cmDocumentation::OneCommand; - } } - else if(strcmp(argv[i], "--help-properties") == 0) - { + } else if (strcmp(argv[i], "--help-properties") == 0) { help.HelpType = cmDocumentation::OneManual; help.Argument = "cmake-properties.7"; GET_OPT_ARGUMENT(help.Filename); this->WarnFormFromFilename(help, result); - } - else if(strcmp(argv[i], "--help-policies") == 0) - { + } else if (strcmp(argv[i], "--help-policies") == 0) { help.HelpType = cmDocumentation::OneManual; help.Argument = "cmake-policies.7"; GET_OPT_ARGUMENT(help.Filename); this->WarnFormFromFilename(help, result); - } - else if(strcmp(argv[i], "--help-variables") == 0) - { + } else if (strcmp(argv[i], "--help-variables") == 0) { help.HelpType = cmDocumentation::OneManual; help.Argument = "cmake-variables.7"; GET_OPT_ARGUMENT(help.Filename); this->WarnFormFromFilename(help, result); - } - else if(strcmp(argv[i], "--help-modules") == 0) - { + } else if (strcmp(argv[i], "--help-modules") == 0) { help.HelpType = cmDocumentation::OneManual; help.Argument = "cmake-modules.7"; GET_OPT_ARGUMENT(help.Filename); this->WarnFormFromFilename(help, result); - } - else if(strcmp(argv[i], "--help-custom-modules") == 0) - { + } else if (strcmp(argv[i], "--help-custom-modules") == 0) { GET_OPT_ARGUMENT(help.Filename); cmSystemTools::Message( "Warning: --help-custom-modules no longer supported"); - if(help.Filename.empty()) - { + if (help.Filename.empty()) { return true; - } + } // Avoid breaking old project builds completely by at least generating // the output file. Abuse help.Argument to give the file name to // PrintOldCustomModules without disrupting our internal API. help.HelpType = cmDocumentation::OldCustomModules; help.Argument = cmSystemTools::GetFilenameName(help.Filename); - } - else if(strcmp(argv[i], "--help-commands") == 0) - { + } else if (strcmp(argv[i], "--help-commands") == 0) { help.HelpType = cmDocumentation::OneManual; help.Argument = "cmake-commands.7"; GET_OPT_ARGUMENT(help.Filename); this->WarnFormFromFilename(help, result); - } - else if(strcmp(argv[i], "--help-compatcommands") == 0) - { + } else if (strcmp(argv[i], "--help-compatcommands") == 0) { GET_OPT_ARGUMENT(help.Filename); cmSystemTools::Message( "Warning: --help-compatcommands no longer supported"); return true; - } - else if(strcmp(argv[i], "--help-full") == 0) - { + } else if (strcmp(argv[i], "--help-full") == 0) { help.HelpType = cmDocumentation::Full; GET_OPT_ARGUMENT(help.Filename); this->WarnFormFromFilename(help, result); - } - else if(strcmp(argv[i], "--help-html") == 0) - { + } else if (strcmp(argv[i], "--help-html") == 0) { GET_OPT_ARGUMENT(help.Filename); cmSystemTools::Message("Warning: --help-html no longer supported"); return true; - } - else if(strcmp(argv[i], "--help-man") == 0) - { + } else if (strcmp(argv[i], "--help-man") == 0) { GET_OPT_ARGUMENT(help.Filename); cmSystemTools::Message("Warning: --help-man no longer supported"); return true; - } - else if(strcmp(argv[i], "--help-command") == 0) - { + } else if (strcmp(argv[i], "--help-command") == 0) { help.HelpType = cmDocumentation::OneCommand; GET_OPT_ARGUMENT(help.Argument); GET_OPT_ARGUMENT(help.Filename); help.Argument = cmSystemTools::LowerCase(help.Argument); this->WarnFormFromFilename(help, result); - } - else if(strcmp(argv[i], "--help-module") == 0) - { + } else if (strcmp(argv[i], "--help-module") == 0) { help.HelpType = cmDocumentation::OneModule; GET_OPT_ARGUMENT(help.Argument); GET_OPT_ARGUMENT(help.Filename); this->WarnFormFromFilename(help, result); - } - else if(strcmp(argv[i], "--help-property") == 0) - { + } else if (strcmp(argv[i], "--help-property") == 0) { help.HelpType = cmDocumentation::OneProperty; GET_OPT_ARGUMENT(help.Argument); GET_OPT_ARGUMENT(help.Filename); this->WarnFormFromFilename(help, result); - } - else if(strcmp(argv[i], "--help-policy") == 0) - { + } else if (strcmp(argv[i], "--help-policy") == 0) { help.HelpType = cmDocumentation::OnePolicy; GET_OPT_ARGUMENT(help.Argument); GET_OPT_ARGUMENT(help.Filename); this->WarnFormFromFilename(help, result); - } - else if(strcmp(argv[i], "--help-variable") == 0) - { + } else if (strcmp(argv[i], "--help-variable") == 0) { help.HelpType = cmDocumentation::OneVariable; GET_OPT_ARGUMENT(help.Argument); GET_OPT_ARGUMENT(help.Filename); this->WarnFormFromFilename(help, result); - } - else if(strcmp(argv[i], "--help-manual") == 0) - { + } else if (strcmp(argv[i], "--help-manual") == 0) { help.HelpType = cmDocumentation::OneManual; GET_OPT_ARGUMENT(help.Argument); GET_OPT_ARGUMENT(help.Filename); this->WarnFormFromFilename(help, result); - } - else if(strcmp(argv[i], "--help-command-list") == 0) - { + } else if (strcmp(argv[i], "--help-command-list") == 0) { help.HelpType = cmDocumentation::ListCommands; GET_OPT_ARGUMENT(help.Filename); - } - else if(strcmp(argv[i], "--help-module-list") == 0) - { + } else if (strcmp(argv[i], "--help-module-list") == 0) { help.HelpType = cmDocumentation::ListModules; GET_OPT_ARGUMENT(help.Filename); - } - else if(strcmp(argv[i], "--help-property-list") == 0) - { + } else if (strcmp(argv[i], "--help-property-list") == 0) { help.HelpType = cmDocumentation::ListProperties; GET_OPT_ARGUMENT(help.Filename); - } - else if(strcmp(argv[i], "--help-variable-list") == 0) - { + } else if (strcmp(argv[i], "--help-variable-list") == 0) { help.HelpType = cmDocumentation::ListVariables; GET_OPT_ARGUMENT(help.Filename); - } - else if(strcmp(argv[i], "--help-policy-list") == 0) - { + } else if (strcmp(argv[i], "--help-policy-list") == 0) { help.HelpType = cmDocumentation::ListPolicies; GET_OPT_ARGUMENT(help.Filename); - } - else if(strcmp(argv[i], "--help-manual-list") == 0) - { + } else if (strcmp(argv[i], "--help-manual-list") == 0) { help.HelpType = cmDocumentation::ListManuals; GET_OPT_ARGUMENT(help.Filename); - } - else if(strcmp(argv[i], "--copyright") == 0) - { + } else if (strcmp(argv[i], "--copyright") == 0) { GET_OPT_ARGUMENT(help.Filename); cmSystemTools::Message("Warning: --copyright no longer supported"); return true; - } - else if((strcmp(argv[i], "--version") == 0) || - (strcmp(argv[i], "-version") == 0) || - (strcmp(argv[i], "/V") == 0)) - { + } else if ((strcmp(argv[i], "--version") == 0) || + (strcmp(argv[i], "-version") == 0) || + (strcmp(argv[i], "/V") == 0)) { help.HelpType = cmDocumentation::Version; GET_OPT_ARGUMENT(help.Filename); - } - if(help.HelpType != None) - { + } + if (help.HelpType != None) { // This is a help option. See if there is a file name given. result = true; this->RequestedHelpItems.push_back(help); - } } + } return result; } @@ -475,130 +382,112 @@ void cmDocumentation::SetName(const std::string& name) this->NameString = name; } -void cmDocumentation::SetSection(const char *name, - cmDocumentationSection *section) +void cmDocumentation::SetSection(const char* name, + cmDocumentationSection* section) { - if (this->AllSections.find(name) != this->AllSections.end()) - { + if (this->AllSections.find(name) != this->AllSections.end()) { delete this->AllSections[name]; - } + } this->AllSections[name] = section; } -void cmDocumentation::SetSection(const char *name, - std::vector<cmDocumentationEntry> &docs) +void cmDocumentation::SetSection(const char* name, + std::vector<cmDocumentationEntry>& docs) { - cmDocumentationSection *sec = - new cmDocumentationSection(name, - cmSystemTools::UpperCase(name).c_str()); + cmDocumentationSection* sec = + new cmDocumentationSection(name, cmSystemTools::UpperCase(name).c_str()); sec->Append(docs); - this->SetSection(name,sec); + this->SetSection(name, sec); } -void cmDocumentation::SetSection(const char *name, - const char *docs[][2]) +void cmDocumentation::SetSection(const char* name, const char* docs[][2]) { - cmDocumentationSection *sec = - new cmDocumentationSection(name, - cmSystemTools::UpperCase(name).c_str()); + cmDocumentationSection* sec = + new cmDocumentationSection(name, cmSystemTools::UpperCase(name).c_str()); sec->Append(docs); - this->SetSection(name,sec); + this->SetSection(name, sec); } -void cmDocumentation -::SetSections(std::map<std::string,cmDocumentationSection *> §ions) +void cmDocumentation::SetSections( + std::map<std::string, cmDocumentationSection*>& sections) { - for (std::map<std::string,cmDocumentationSection *>::const_iterator - it = sections.begin(); it != sections.end(); ++it) - { - this->SetSection(it->first.c_str(),it->second); - } + for (std::map<std::string, cmDocumentationSection*>::const_iterator it = + sections.begin(); + it != sections.end(); ++it) { + this->SetSection(it->first.c_str(), it->second); + } } -void cmDocumentation::PrependSection(const char *name, - const char *docs[][2]) +void cmDocumentation::PrependSection(const char* name, const char* docs[][2]) { - cmDocumentationSection *sec = 0; - if (this->AllSections.find(name) == this->AllSections.end()) - { - sec = new cmDocumentationSection - (name, cmSystemTools::UpperCase(name).c_str()); - this->SetSection(name,sec); - } - else - { + cmDocumentationSection* sec = 0; + if (this->AllSections.find(name) == this->AllSections.end()) { + sec = + new cmDocumentationSection(name, cmSystemTools::UpperCase(name).c_str()); + this->SetSection(name, sec); + } else { sec = this->AllSections[name]; - } + } sec->Prepend(docs); } -void cmDocumentation::PrependSection(const char *name, - std::vector<cmDocumentationEntry> &docs) +void cmDocumentation::PrependSection(const char* name, + std::vector<cmDocumentationEntry>& docs) { - cmDocumentationSection *sec = 0; - if (this->AllSections.find(name) == this->AllSections.end()) - { - sec = new cmDocumentationSection - (name, cmSystemTools::UpperCase(name).c_str()); - this->SetSection(name,sec); - } - else - { + cmDocumentationSection* sec = 0; + if (this->AllSections.find(name) == this->AllSections.end()) { + sec = + new cmDocumentationSection(name, cmSystemTools::UpperCase(name).c_str()); + this->SetSection(name, sec); + } else { sec = this->AllSections[name]; - } + } sec->Prepend(docs); } -void cmDocumentation::AppendSection(const char *name, - const char *docs[][2]) +void cmDocumentation::AppendSection(const char* name, const char* docs[][2]) { - cmDocumentationSection *sec = 0; - if (this->AllSections.find(name) == this->AllSections.end()) - { - sec = new cmDocumentationSection - (name, cmSystemTools::UpperCase(name).c_str()); - this->SetSection(name,sec); - } - else - { + cmDocumentationSection* sec = 0; + if (this->AllSections.find(name) == this->AllSections.end()) { + sec = + new cmDocumentationSection(name, cmSystemTools::UpperCase(name).c_str()); + this->SetSection(name, sec); + } else { sec = this->AllSections[name]; - } + } sec->Append(docs); } -void cmDocumentation::AppendSection(const char *name, - std::vector<cmDocumentationEntry> &docs) +void cmDocumentation::AppendSection(const char* name, + std::vector<cmDocumentationEntry>& docs) { - cmDocumentationSection *sec = 0; - if (this->AllSections.find(name) == this->AllSections.end()) - { - sec = new cmDocumentationSection - (name, cmSystemTools::UpperCase(name).c_str()); - this->SetSection(name,sec); - } - else - { + cmDocumentationSection* sec = 0; + if (this->AllSections.find(name) == this->AllSections.end()) { + sec = + new cmDocumentationSection(name, cmSystemTools::UpperCase(name).c_str()); + this->SetSection(name, sec); + } else { sec = this->AllSections[name]; - } + } sec->Append(docs); } -void cmDocumentation::AppendSection(const char *name, - cmDocumentationEntry &docs) +void cmDocumentation::AppendSection(const char* name, + cmDocumentationEntry& docs) { std::vector<cmDocumentationEntry> docsVec; docsVec.push_back(docs); - this->AppendSection(name,docsVec); + this->AppendSection(name, docsVec); } -void cmDocumentation::PrependSection(const char *name, - cmDocumentationEntry &docs) +void cmDocumentation::PrependSection(const char* name, + cmDocumentationEntry& docs) { std::vector<cmDocumentationEntry> docsVec; docsVec.push_back(docs); - this->PrependSection(name,docsVec); + this->PrependSection(name, docsVec); } void cmDocumentation::GlobHelp(std::vector<std::string>& files, @@ -607,42 +496,35 @@ void cmDocumentation::GlobHelp(std::vector<std::string>& files, cmsys::Glob gl; std::string findExpr = cmSystemTools::GetCMakeRoot() + "/Help/" + pattern + ".rst"; - if(gl.FindFiles(findExpr)) - { + if (gl.FindFiles(findExpr)) { files = gl.GetFiles(); - } + } } -void cmDocumentation::PrintNames(std::ostream& os, - std::string const& pattern) +void cmDocumentation::PrintNames(std::ostream& os, std::string const& pattern) { std::vector<std::string> files; this->GlobHelp(files, pattern); std::vector<std::string> names; for (std::vector<std::string>::const_iterator i = files.begin(); - i != files.end(); ++i) - { + i != files.end(); ++i) { std::string line; cmsys::ifstream fin(i->c_str()); - while(fin && cmSystemTools::GetLineFromStream(fin, line)) - { - if(!line.empty() && (isalnum(line[0]) || line[0] == '<')) - { + while (fin && cmSystemTools::GetLineFromStream(fin, line)) { + if (!line.empty() && (isalnum(line[0]) || line[0] == '<')) { names.push_back(line); break; - } } } + } std::sort(names.begin(), names.end()); - for (std::vector<std::string>::iterator i = names.begin(); - i != names.end(); ++i) - { + for (std::vector<std::string>::iterator i = names.begin(); i != names.end(); + ++i) { os << *i << "\n"; - } + } } -bool cmDocumentation::PrintFiles(std::ostream& os, - std::string const& pattern) +bool cmDocumentation::PrintFiles(std::ostream& os, std::string const& pattern) { bool found = false; std::vector<std::string> files; @@ -650,10 +532,9 @@ bool cmDocumentation::PrintFiles(std::ostream& os, std::sort(files.begin(), files.end()); cmRST r(os, cmSystemTools::GetCMakeRoot() + "/Help"); for (std::vector<std::string>::const_iterator i = files.begin(); - i != files.end(); ++i) - { + i != files.end(); ++i) { found = r.ProcessFile(*i) || found; - } + } return found; } @@ -666,16 +547,13 @@ bool cmDocumentation::PrintHelpOneManual(std::ostream& os) { std::string mname = this->CurrentArgument; std::string::size_type mlen = mname.length(); - if(mlen > 3 && mname[mlen-3] == '(' && - mname[mlen-1] == ')') - { - mname = mname.substr(0, mlen-3) + "." + mname[mlen-2]; - } - if(this->PrintFiles(os, "manual/" + mname) || - this->PrintFiles(os, "manual/" + mname + ".[0-9]")) - { + if (mlen > 3 && mname[mlen - 3] == '(' && mname[mlen - 1] == ')') { + mname = mname.substr(0, mlen - 3) + "." + mname[mlen - 2]; + } + if (this->PrintFiles(os, "manual/" + mname) || + this->PrintFiles(os, "manual/" + mname + ".[0-9]")) { return true; - } + } // Argument was not a manual. Complain. os << "Argument \"" << this->CurrentArgument << "\" to --help-manual is not an available manual. " @@ -692,10 +570,9 @@ bool cmDocumentation::PrintHelpListManuals(std::ostream& os) bool cmDocumentation::PrintHelpOneCommand(std::ostream& os) { std::string cname = cmSystemTools::LowerCase(this->CurrentArgument); - if(this->PrintFiles(os, "command/" + cname)) - { + if (this->PrintFiles(os, "command/" + cname)) { return true; - } + } // Argument was not a command. Complain. os << "Argument \"" << this->CurrentArgument << "\" to --help-command is not a CMake command. " @@ -712,10 +589,9 @@ bool cmDocumentation::PrintHelpListCommands(std::ostream& os) bool cmDocumentation::PrintHelpOneModule(std::ostream& os) { std::string mname = this->CurrentArgument; - if(this->PrintFiles(os, "module/" + mname)) - { + if (this->PrintFiles(os, "module/" + mname)) { return true; - } + } // Argument was not a module. Complain. os << "Argument \"" << this->CurrentArgument << "\" to --help-module is not a CMake module.\n"; @@ -728,27 +604,24 @@ bool cmDocumentation::PrintHelpListModules(std::ostream& os) this->GlobHelp(files, "module/*"); std::vector<std::string> modules; for (std::vector<std::string>::iterator fi = files.begin(); - fi != files.end(); ++fi) - { + fi != files.end(); ++fi) { std::string module = cmSystemTools::GetFilenameName(*fi); - modules.push_back(module.substr(0, module.size()-4)); - } + modules.push_back(module.substr(0, module.size() - 4)); + } std::sort(modules.begin(), modules.end()); for (std::vector<std::string>::iterator i = modules.begin(); - i != modules.end(); ++i) - { + i != modules.end(); ++i) { os << *i << "\n"; - } + } return true; } bool cmDocumentation::PrintHelpOneProperty(std::ostream& os) { std::string pname = cmSystemTools::HelpFileName(this->CurrentArgument); - if(this->PrintFiles(os, "prop_*/" + pname)) - { + if (this->PrintFiles(os, "prop_*/" + pname)) { return true; - } + } // Argument was not a property. Complain. os << "Argument \"" << this->CurrentArgument << "\" to --help-property is not a CMake property. " @@ -766,10 +639,9 @@ bool cmDocumentation::PrintHelpOnePolicy(std::ostream& os) { std::string pname = this->CurrentArgument; std::vector<std::string> files; - if(this->PrintFiles(os, "policy/" + pname)) - { + if (this->PrintFiles(os, "policy/" + pname)) { return true; - } + } // Argument was not a policy. Complain. os << "Argument \"" << this->CurrentArgument @@ -785,23 +657,21 @@ bool cmDocumentation::PrintHelpListPolicies(std::ostream& os) bool cmDocumentation::PrintHelpListGenerators(std::ostream& os) { - std::map<std::string,cmDocumentationSection*>::iterator si; + std::map<std::string, cmDocumentationSection*>::iterator si; si = this->AllSections.find("Generators"); - if(si != this->AllSections.end()) - { + if (si != this->AllSections.end()) { this->Formatter.SetIndent(" "); this->Formatter.PrintSection(os, *si->second); - } + } return true; } bool cmDocumentation::PrintHelpOneVariable(std::ostream& os) { std::string vname = cmSystemTools::HelpFileName(this->CurrentArgument); - if(this->PrintFiles(os, "variable/" + vname)) - { + if (this->PrintFiles(os, "variable/" + vname)) { return true; - } + } // Argument was not a variable. Complain. os << "Argument \"" << this->CurrentArgument << "\" to --help-variable is not a defined variable. " @@ -817,49 +687,41 @@ bool cmDocumentation::PrintHelpListVariables(std::ostream& os) bool cmDocumentation::PrintUsage(std::ostream& os) { - std::map<std::string,cmDocumentationSection*>::iterator si; + std::map<std::string, cmDocumentationSection*>::iterator si; si = this->AllSections.find("Usage"); - if(si != this->AllSections.end()) - { + if (si != this->AllSections.end()) { this->Formatter.PrintSection(os, *si->second); - } + } return true; } bool cmDocumentation::PrintHelp(std::ostream& os) { - std::map<std::string,cmDocumentationSection*>::iterator si; + std::map<std::string, cmDocumentationSection*>::iterator si; si = this->AllSections.find("Usage"); - if(si != this->AllSections.end()) - { + if (si != this->AllSections.end()) { this->Formatter.PrintSection(os, *si->second); - } + } si = this->AllSections.find("Options"); - if(si != this->AllSections.end()) - { + if (si != this->AllSections.end()) { this->Formatter.PrintSection(os, *si->second); - } - if(this->ShowGenerators) - { + } + if (this->ShowGenerators) { si = this->AllSections.find("Generators"); - if(si != this->AllSections.end()) - { + if (si != this->AllSections.end()) { this->Formatter.PrintSection(os, *si->second); - } } + } return true; } const char* cmDocumentation::GetNameString() const { - if(!this->NameString.empty()) - { + if (!this->NameString.empty()) { return this->NameString.c_str(); - } - else - { + } else { return "CMake"; - } + } } bool cmDocumentation::IsOption(const char* arg) const @@ -883,15 +745,12 @@ bool cmDocumentation::PrintOldCustomModules(std::ostream& os) "CMake versions 3.0 and above use other means to generate their module\n" "help pages so this functionality is no longer available to be exposed.\n" "\n" - "This file was generated as a placeholder to provide this information.\n" - ; - if((ext == ".HTM") || (ext == ".HTML")) - { + "This file was generated as a placeholder to provide this information.\n"; + if ((ext == ".HTM") || (ext == ".HTML")) { os << "<html><title>" << name << "</title><body>\n" - << summary << "<p/>\n" << detail << "</body></html>\n"; - } - else if((ext.length()==2) && (ext[1] >='1') && (ext[1]<='9')) - { + << summary << "<p/>\n" + << detail << "</body></html>\n"; + } else if ((ext.length() == 2) && (ext[1] >= '1') && (ext[1] <= '9')) { /* clang-format off */ os << ".TH " << name << " " << ext[1] << " \"" << @@ -906,10 +765,8 @@ bool cmDocumentation::PrintOldCustomModules(std::ostream& os) detail ; /* clang-format on */ - } - else - { + } else { os << name << "\n\n" << summary << "\n" << detail; - } + } return true; } |