summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentationFormatterMan.cxx
diff options
context:
space:
mode:
authorAlexander Neundorf <neundorf@kde.org>2007-09-19 13:05:28 (GMT)
committerAlexander Neundorf <neundorf@kde.org>2007-09-19 13:05:28 (GMT)
commitc5f249bdbdb894d72db8211021ac2b9ff8b02fa7 (patch)
tree9378751765b4e994d93ba99cfa7e737a180e6513 /Source/cmDocumentationFormatterMan.cxx
parentb4f02ec0bd8e102fb93230ed2ffe15c90bb33a81 (diff)
downloadCMake-c5f249bdbdb894d72db8211021ac2b9ff8b02fa7.zip
CMake-c5f249bdbdb894d72db8211021ac2b9ff8b02fa7.tar.gz
CMake-c5f249bdbdb894d72db8211021ac2b9ff8b02fa7.tar.bz2
STYLE: move the code for the different formats of the generated help into
their own classes, making cmDocumentation smaller and also making it easier to eventually add another format Alex
Diffstat (limited to 'Source/cmDocumentationFormatterMan.cxx')
-rw-r--r--Source/cmDocumentationFormatterMan.cxx82
1 files changed, 82 insertions, 0 deletions
diff --git a/Source/cmDocumentationFormatterMan.cxx b/Source/cmDocumentationFormatterMan.cxx
new file mode 100644
index 0000000..6b40083
--- /dev/null
+++ b/Source/cmDocumentationFormatterMan.cxx
@@ -0,0 +1,82 @@
+/*=========================================================================
+
+ Program: CMake - Cross-Platform Makefile Generator
+ Module: $RCSfile$
+ Language: C++
+ Date: $Date$
+ Version: $Revision$
+
+ Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
+ See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
+
+ This software is distributed WITHOUT ANY WARRANTY; without even
+ the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ PURPOSE. See the above copyright notices for more information.
+
+=========================================================================*/
+
+#include "cmDocumentationFormatterMan.h"
+
+#include "cmSystemTools.h"
+#include "cmVersion.h"
+
+
+cmDocumentationFormatterMan::cmDocumentationFormatterMan()
+:cmDocumentationFormatter()
+{
+}
+
+void cmDocumentationFormatterMan::PrintSection(std::ostream& os,
+ const cmDocumentationEntry* section,
+ const char* name)
+{
+ if(name)
+ {
+ os << ".SH " << name << "\n";
+ }
+ if(!section) { return; }
+ for(const cmDocumentationEntry* op = section; op->brief; ++op)
+ {
+ if(op->name)
+ {
+ os << ".TP\n"
+ << ".B " << (op->name[0]?op->name:"*") << "\n";
+ this->PrintFormatted(os, op->brief);
+ this->PrintFormatted(os, op->full);
+ }
+ else
+ {
+ os << ".PP\n";
+ this->PrintFormatted(os, op->brief);
+ }
+ }
+}
+
+void cmDocumentationFormatterMan::PrintPreformatted(std::ostream& os,
+ const char* text)
+{
+ std::string man_text = text;
+ cmSystemTools::ReplaceString(man_text, "\\", "\\\\");
+ os << man_text << "\n";
+}
+
+void cmDocumentationFormatterMan::PrintParagraph(std::ostream& os,
+ const char* text)
+{
+ std::string man_text = text;
+ cmSystemTools::ReplaceString(man_text, "\\", "\\\\");
+ os << man_text << "\n\n";
+}
+
+
+//----------------------------------------------------------------------------
+void cmDocumentationFormatterMan::PrintHeader(const char* name,
+ std::ostream& os)
+{
+ os << ".TH " << name << " 1 \""
+ << cmSystemTools::GetCurrentDateTime("%B %d, %Y").c_str()
+// << "\" \"" << this->GetNameString()
+ << " " << cmVersion::GetCMakeVersion()
+ << "\"\n";
+}
+