CMakeLua/Source/cmDocumentationFormatterHTML.cxx

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmDocumentationFormatterHTML.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2008-03-06 16:34:23 $
   7   Version:   $Revision: 1.11 $
   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 "cmDocumentationFormatterHTML.h"
  18 #include "cmDocumentationSection.h"
  19
  20 //----------------------------------------------------------------------------
  21 static bool cmDocumentationIsHyperlinkChar(char c)
  22 {
  23   // This is not a complete list but works for CMake documentation.
  24   return ((c >= 'A' && c <= 'Z') ||
  25           (c >= 'a' && c <= 'z') ||
  26           (c >= '0' && c <= '9') ||
  27           c == '-' || c == '.' || c == '/' || c == '~' || c == '@' ||
  28           c == ':' || c == '_' || c == '&' || c == '?' || c == '=');
  29 }
  30
  31 //----------------------------------------------------------------------------
  32 static void cmDocumentationPrintHTMLChar(std::ostream& os, char c)
  33 {
  34   // Use an escape sequence if necessary.
  35   switch (c)
  36     {
  37     case '<':
  38       os << "&lt;";
  39       break;
  40     case '>':
  41       os << "&gt;";
  42       break;
  43     case '&':
  44       os << "&amp;";
  45       break;
  46     case '\n':
  47       os << "<br>";
  48       break;
  49     default:
  50       os << c;
  51   }
  52 }
  53
  54 //----------------------------------------------------------------------------
  55 const char* cmDocumentationPrintHTMLLink(std::ostream& os, const char* begin)
  56 {
  57   // Look for the end of the link.
  58   const char* end = begin;
  59   while(cmDocumentationIsHyperlinkChar(*end))
  60     {
  61     ++end;
  62     }
  63
  64   // Print the hyperlink itself.
  65   os << "<a href=\"";
  66   for(const char* c = begin; c != end; ++c)
  67     {
  68     cmDocumentationPrintHTMLChar(os, *c);
  69     }
  70   os << "\">";
  71
  72   // The name of the hyperlink is the text itself.
  73   for(const char* c = begin; c != end; ++c)
  74     {
  75     cmDocumentationPrintHTMLChar(os, *c);
  76     }
  77   os << "</a>";
  78
  79   // Return the position at which to continue scanning the input
  80   // string.
  81   return end;
  82 }
  83
  84
  85 cmDocumentationFormatterHTML::cmDocumentationFormatterHTML()
  86 :cmDocumentationFormatter()
  87 {
  88 }
  89
  90 void cmDocumentationFormatterHTML
  91 ::PrintSection(std::ostream& os,
  92                const cmDocumentationSection &section,
  93                const char* name)
  94 {
  95   if(name)
  96     {
  97     os << "<h2><a name=\"section_" << name << "\"/>" << name << "</h2>\n";
  98     }
  99
 100   const std::vector<cmDocumentationEntry> &entries =
 101     section.GetEntries();
 102
 103   os << "<ul>\n";
 104   for(std::vector<cmDocumentationEntry>::const_iterator op
 105         = entries.begin(); op != entries.end(); ++ op )
 106     {
 107     if(op->Name.size())
 108       {
 109       os << "    <li><a href=\"#command_"
 110          << op->Name.c_str() << "\"><b><code>";
 111       this->PrintHTMLEscapes(os, op->Name.c_str());
 112       os << "</code></b></a></li>";
 113       }
 114     }
 115   os << "</ul>\n" ;
 116
 117   for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin();
 118       op != entries.end();)
 119     {
 120     if(op->Name.size())
 121       {
 122       os << "<ul>\n";
 123       for(;op != entries.end() && op->Name.size(); ++op)
 124         {
 125         os << "  <li>\n";
 126         if(op->Name.size())
 127           {
 128           os << "    <a name=\"command_"<<
 129             op->Name.c_str() << "\"><b><code>";
 130           this->PrintHTMLEscapes(os, op->Name.c_str());
 131           os << "</code></b></a>: ";
 132           }
 133         this->PrintHTMLEscapes(os, op->Brief.c_str());
 134         if(op->Full.size())
 135           {
 136           os << "<br>\n    ";
 137           this->PrintFormatted(os, op->Full.c_str());
 138           }
 139         os << "\n";
 140         os << "  </li>\n";
 141         }
 142       os << "</ul>\n";
 143       }
 144     else
 145       {
 146       this->PrintFormatted(os, op->Brief.c_str());
 147       os << "\n";
 148       ++op;
 149       }
 150     }
 151 }
 152
 153 void cmDocumentationFormatterHTML::PrintPreformatted(std::ostream& os,
 154                                                      const char* text)
 155 {
 156   os << "<pre>";
 157   this->PrintHTMLEscapes(os, text);
 158   os << "</pre>\n    ";
 159 }
 160
 161 void cmDocumentationFormatterHTML::PrintParagraph(std::ostream& os,
 162                                                   const char* text)
 163 {
 164   os << "<p>";
 165   this->PrintHTMLEscapes(os, text);
 166 }
 167
 168 //----------------------------------------------------------------------------
 169 void cmDocumentationFormatterHTML::PrintHeader(const char* /*name*/,
 170                                                std::ostream& os)
 171 {
 172   os << "<html><body>\n";
 173 }
 174
 175 //----------------------------------------------------------------------------
 176 void cmDocumentationFormatterHTML::PrintFooter(std::ostream& os)
 177 {
 178   os << "</body></html>\n";
 179 }
 180
 181 //----------------------------------------------------------------------------
 182 void cmDocumentationFormatterHTML::PrintHTMLEscapes(std::ostream& os,
 183                                                     const char* text)
 184 {
 185   // Hyperlink prefixes.
 186   static const char* hyperlinks[] = {"http://", "ftp://", "mailto:", 0};
 187
 188   // Print each character.
 189   for(const char* p = text; *p;)
 190     {
 191     // Handle hyperlinks specially to make them active.
 192     bool found_hyperlink = false;
 193     for(const char** h = hyperlinks; !found_hyperlink && *h; ++h)
 194       {
 195       if(strncmp(p, *h, strlen(*h)) == 0)
 196         {
 197         p = cmDocumentationPrintHTMLLink(os, p);
 198         found_hyperlink = true;
 199         }
 200       }
 201
 202     // Print other characters normally.
 203     if(!found_hyperlink)
 204       {
 205       cmDocumentationPrintHTMLChar(os, *p++);
 206       }
 207     }
 208 }
 209
 210 void cmDocumentationFormatterHTML
 211 ::PrintIndex(std::ostream& os,
 212              std::vector<const cmDocumentationSection *>& sections)
 213 {
 214   os << "<h2><a name=\"section_Index\"/>Master Index</h2>\n";
 215   os << "<ul>\n";
 216   for(unsigned int i=0; i < sections.size(); ++i)
 217     {
 218     std::string name = sections[i]->
 219       GetName((this->GetForm()));
 220     os << "  <li><a href=\"#section_"
 221        << name << "\"<b>" << name << "</b></a></li>\n";
 222     }
 223   os << "</ul>\n";
 224 }