Source/cmDocumentationFormatter.cxx

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmDocumentationFormatter.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2008-10-10 15:23:35 $
   7   Version:   $Revision: 1.4 $
   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 #include "cmDocumentationFormatter.h"
  18
  19 cmDocumentationFormatter::cmDocumentationFormatter()
  20 {
  21 }
  22
  23 cmDocumentationFormatter::~cmDocumentationFormatter()
  24 {
  25 }
  26
  27 void cmDocumentationFormatter::PrintFormatted(std::ostream& os,
  28                                               const char* text)
  29 {
  30   if(!text)
  31     {
  32     return;
  33     }
  34   const char* ptr = text;
  35   while(*ptr)
  36     {
  37     // Any ptrs starting in a space are treated as preformatted text.
  38     std::string preformatted;
  39     while(*ptr == ' ')
  40       {
  41       for(char ch = *ptr; ch && ch != '\n'; ++ptr, ch = *ptr)
  42         {
  43         preformatted.append(1, ch);
  44         }
  45       if(*ptr)
  46         {
  47         ++ptr;
  48         preformatted.append(1, '\n');
  49         }
  50       }
  51     if(preformatted.length())
  52       {
  53       this->PrintPreformatted(os, preformatted.c_str());
  54       }
  55
  56     // Other ptrs are treated as paragraphs.
  57     std::string paragraph;
  58     for(char ch = *ptr; ch && ch != '\n'; ++ptr, ch = *ptr)
  59       {
  60       paragraph.append(1, ch);
  61       }
  62     if(*ptr)
  63       {
  64       ++ptr;
  65       paragraph.append(1, '\n');
  66       }
  67     if(paragraph.length())
  68       {
  69       this->PrintParagraph(os, paragraph.c_str());
  70       }
  71     }
  72 }
  73
  74 //----------------------------------------------------------------------------
  75 std::string
  76 cmDocumentationFormatter::ComputeSectionLinkPrefix(std::string const& name)
  77 {
  78   // Map from section name to a prefix for links pointing within the
  79   // section.  For example, the commands section should have HTML
  80   // links to each command with names like #command:ADD_EXECUTABLE.
  81   if(name.find("Command") != name.npos)
  82     {
  83     return "command";
  84     }
  85   else if(name.find("Propert") != name.npos)
  86     {
  87     if(name.find("Global") != name.npos)
  88       {
  89       return "prop_global";
  90       }
  91     else if(name.find("Direct") != name.npos)
  92       {
  93       return "prop_dir";
  94       }
  95     else if(name.find("Target") != name.npos)
  96       {
  97       return "prop_tgt";
  98       }
  99     else if(name.find("Test") != name.npos)
 100       {
 101       return "prop_test";
 102       }
 103     else if(name.find("Source") != name.npos)
 104       {
 105       return "prop_sf";
 106       }
 107     return "property";
 108     }
 109   else if(name.find("Variable") != name.npos)
 110     {
 111     return "variable";
 112     }
 113   else if(name.find("Polic") != name.npos)
 114     {
 115     return "policy";
 116     }
 117   else if(name.find("Module") != name.npos)
 118     {
 119     return "module";
 120     }
 121   else if(name.find("Name") != name.npos ||
 122           name.find("Introduction") != name.npos)
 123     {
 124     return "name";
 125     }
 126   else if(name.find("Usage") != name.npos)
 127     {
 128     return "usage";
 129     }
 130   else if(name.find("Description") != name.npos)
 131     {
 132     return "desc";
 133     }
 134   else if(name.find("Generators") != name.npos)
 135     {
 136     return "gen";
 137     }
 138   else if(name.find("Options") != name.npos)
 139     {
 140     return "opt";
 141     }
 142   else if(name.find("Copyright") != name.npos)
 143     {
 144     return "copy";
 145     }
 146   else if(name.find("See Also") != name.npos)
 147     {
 148     return "see";
 149     }
 150   else if(name.find("SingleItem") != name.npos)
 151     {
 152     return "single_item";
 153     }
 154   else
 155     {
 156     std::cerr
 157       << "WARNING: ComputeSectionLinkPrefix failed for \"" << name << "\""
 158       << std::endl;
 159     return "other";
 160     }
 161 }