Source/cmDocumentationFormatterText.cxx

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmDocumentationFormatterText.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2009-06-28 12:05:22 $
   7   Version:   $Revision: 1.6 $
   8
   9   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  10   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  11
  12      This software is distributed WITHOUT ANY WARRANTY; without even
  13      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14      PURPOSE.  See the above copyright notices for more information.
  15
  16 =========================================================================*/
  17
  18 #include "cmDocumentationFormatterText.h"
  19 #include "cmDocumentationSection.h"
  20
  21 cmDocumentationFormatterText::cmDocumentationFormatterText()
  22 :cmDocumentationFormatter()
  23 ,TextWidth(77)
  24 ,TextIndent("")
  25 {
  26 }
  27
  28 void cmDocumentationFormatterText
  29 ::PrintSection(std::ostream& os,
  30                const cmDocumentationSection &section,
  31                const char* name)
  32 {
  33   if(name && (strcmp(name, "SingleItem")!=0))
  34     {
  35     os <<
  36       "---------------------------------------"
  37       "---------------------------------------\n";
  38     os << name << "\n\n";
  39     }
  40
  41   const std::vector<cmDocumentationEntry> &entries =
  42     section.GetEntries();
  43   for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin();
  44       op != entries.end(); ++op)
  45     {
  46     if(op->Name.size())
  47       {
  48       os << "  " << op->Name << "\n";
  49       this->TextIndent = "       ";
  50       this->PrintFormatted(os, op->Brief.c_str());
  51       if(op->Full.size())
  52         {
  53         os << "\n";
  54         this->PrintFormatted(os, op->Full.c_str());
  55         }
  56       }
  57     else
  58       {
  59       this->TextIndent = "";
  60       this->PrintFormatted(os, op->Brief.c_str());
  61       }
  62     os << "\n";
  63     }
  64 }
  65
  66 void cmDocumentationFormatterText::PrintPreformatted(std::ostream& os,
  67                                                      const char* text)
  68 {
  69   bool newline = true;
  70   for(const char* ptr = text; *ptr; ++ptr)
  71     {
  72     if(newline && *ptr != '\n')
  73       {
  74       os << this->TextIndent;
  75       newline = false;
  76       }
  77     os << *ptr;
  78     if(*ptr == '\n')
  79       {
  80       newline = true;
  81       }
  82     }
  83   os << "\n";
  84 }
  85
  86 void cmDocumentationFormatterText::PrintParagraph(std::ostream& os,
  87                                                   const char* text)
  88 {
  89   os << this->TextIndent;
  90   this->PrintColumn(os, text);
  91   os << "\n";
  92 }
  93
  94 void cmDocumentationFormatterText::SetIndent(const char* indent)
  95 {
  96   this->TextIndent = indent;
  97 }
  98
  99 void cmDocumentationFormatterText::PrintColumn(std::ostream& os,
 100                                                const char* text)
 101 {
 102   // Print text arranged in an indented column of fixed witdh.
 103   const char* l = text;
 104   int column = 0;
 105   bool newSentence = false;
 106   bool firstLine = true;
 107   int width = this->TextWidth - static_cast<int>(strlen(this->TextIndent));
 108
 109   // Loop until the end of the text.
 110   while(*l)
 111     {
 112     // Parse the next word.
 113     const char* r = l;
 114     while(*r && (*r != '\n') && (*r != ' ')) { ++r; }
 115
 116     // Does it fit on this line?
 117     if(r-l < (width-column-(newSentence?1:0)))
 118       {
 119       // Word fits on this line.
 120       if(r > l)
 121         {
 122         if(column)
 123           {
 124           // Not first word on line.  Separate from the previous word
 125           // by a space, or two if this is a new sentence.
 126           if(newSentence)
 127             {
 128             os << "  ";
 129             column += 2;
 130             }
 131           else
 132             {
 133             os << " ";
 134             column += 1;
 135             }
 136           }
 137         else
 138           {
 139           // First word on line.  Print indentation unless this is the
 140           // first line.
 141           os << (firstLine?"":this->TextIndent);
 142           }
 143
 144         // Print the word.
 145         os.write(l, static_cast<long>(r-l));
 146         newSentence = (*(r-1) == '.');
 147         }
 148
 149       if(*r == '\n')
 150         {
 151         // Text provided a newline.  Start a new line.
 152         os << "\n";
 153         ++r;
 154         column = 0;
 155         firstLine = false;
 156         }
 157       else
 158         {
 159         // No provided newline.  Continue this line.
 160         column += static_cast<long>(r-l);
 161         }
 162       }
 163     else
 164       {
 165       // Word does not fit on this line.  Start a new line.
 166       os << "\n";
 167       firstLine = false;
 168       if(r > l)
 169         {
 170         os << this->TextIndent;
 171         os.write(l, static_cast<long>(r-l));
 172         column = static_cast<long>(r-l);
 173         newSentence = (*(r-1) == '.');
 174         }
 175       else
 176         {
 177         column = 0;
 178         }
 179       }
 180
 181     // Move to beginning of next word.  Skip over whitespace.
 182     l = r;
 183     while(*l && (*l == ' ')) { ++l; }
 184     }
 185 }