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

1 files changed, 183 insertions, 0 deletions

diff --git a/Source/cmDocumentationFormatterText.cxx b/Source/cmDocumentationFormatterText.cxx
new file mode 100644
index 0000000..4ab2695
--- /dev/null
+++ b/Source/cmDocumentationFormatterText.cxx
@@ -0,0 +1,183 @@
+/*=========================================================================
+
+  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 "cmDocumentationFormatterText.h"
+
+cmDocumentationFormatterText::cmDocumentationFormatterText()
+:cmDocumentationFormatter()
+,TextWidth(77)
+,TextIndent("")
+{
+}
+
+void cmDocumentationFormatterText::PrintSection(std::ostream& os,
+                  const cmDocumentationEntry* section,
+                  const char* name)
+{
+  if(name)
+    {
+    os <<
+      "---------------------------------------"
+      "---------------------------------------\n";
+    os << name << "\n\n";
+    }
+  if(!section) { return; }
+  for(const cmDocumentationEntry* op = section; op->brief; ++op)
+    {
+    if(op->name)
+      {
+      if(op->name[0])
+        {
+        os << "  " << op->name << "\n";
+        }
+      this->TextIndent = "       ";
+      this->PrintFormatted(os, op->brief);
+      if(op->full)
+        {
+        os << "\n";
+        this->PrintFormatted(os, op->full);
+        }
+      }
+    else
+      {
+      this->TextIndent = "";
+      this->PrintFormatted(os, op->brief);
+      }
+    os << "\n";
+    }
+}
+
+void cmDocumentationFormatterText::PrintPreformatted(std::ostream& os, 
+                                                     const char* text)
+{
+  bool newline = true;
+  for(const char* ptr = text; *ptr; ++ptr)
+    {
+    if(newline)
+      {
+      os << this->TextIndent;
+      newline = false;
+      }
+    os << *ptr;
+    if(*ptr == '\n')
+      {
+      newline = true;
+      }
+    }
+  os << "\n";
+}
+
+void cmDocumentationFormatterText::PrintParagraph(std::ostream& os, 
+                                                  const char* text)
+{
+  os << this->TextIndent;
+  this->PrintColumn(os, text);
+  os << "\n";
+}
+
+void cmDocumentationFormatterText::SetIndent(const char* indent)
+{
+  this->TextIndent = indent;
+}
+
+void cmDocumentationFormatterText::PrintColumn(std::ostream& os, 
+                                               const char* text)
+{
+  // Print text arranged in an indented column of fixed witdh.
+  const char* l = text;
+  int column = 0;
+  bool newSentence = false;
+  bool firstLine = true;
+  int width = this->TextWidth - static_cast<int>(strlen(this->TextIndent));
+  
+  // Loop until the end of the text.
+  while(*l)
+    {
+    // Parse the next word.
+    const char* r = l;
+    while(*r && (*r != '\n') && (*r != ' ')) { ++r; }
+    
+    // Does it fit on this line?
+    if(r-l < (width-column-(newSentence?1:0)))
+      {
+      // Word fits on this line.
+      if(r > l)
+        {
+        if(column)
+          {
+          // Not first word on line.  Separate from the previous word
+          // by a space, or two if this is a new sentence.
+          if(newSentence)
+            {
+            os << "  ";
+            column += 2;
+            }
+          else
+            {
+            os << " ";
+            column += 1;
+            }
+          }
+        else
+          {
+          // First word on line.  Print indentation unless this is the
+          // first line.
+          os << (firstLine?"":this->TextIndent);
+          }
+        
+        // Print the word.
+        os.write(l, static_cast<long>(r-l));
+        newSentence = (*(r-1) == '.');
+        }
+      
+      if(*r == '\n')
+        {
+        // Text provided a newline.  Start a new line.
+        os << "\n";
+        ++r;
+        column = 0;
+        firstLine = false;
+        }
+      else
+        {
+        // No provided newline.  Continue this line.
+        column += static_cast<long>(r-l);
+        }
+      }
+    else
+      {
+      // Word does not fit on this line.  Start a new line.
+      os << "\n";
+      firstLine = false;
+      if(r > l)
+        {
+        os << this->TextIndent;
+        os.write(l, static_cast<long>(r-l));
+        column = static_cast<long>(r-l);
+        newSentence = (*(r-1) == '.');
+        }
+      else
+        {
+        column = 0;
+        }
+      }
+
+    // Move to beginning of next word.  Skip over whitespace.
+    l = r;
+    while(*l && (*l == ' ')) { ++l; }    
+    }
+}