cmDocumentation.cxx 27.8 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/*=========================================================================

  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 "cmDocumentation.h"

#include "cmSystemTools.h"

//----------------------------------------------------------------------------
static const cmDocumentationEntry cmDocumentationStandardOptions[] =
{
24
25
26
27
28
29
30
  {"--copyright [file]", "Print the CMake copyright and exit.",
   "If a file is specified, the copyright is written into it."},
  {"--help [command]", "Print usage information and exit.",
   "Usage describes the basic command line interface and its options.  "
   "If a listfile command is specified, help for that specific command is "
   "printed."},
  {"--help-full [file]", "Print full help and exit.",
31
32
   "Full help displays most of the documentation provided by the UNIX "
   "man page.  It is provided for use on non-UNIX platforms, but is "
33
34
35
36
37
38
39
40
41
42
   "also convenient if the man page is not installed.  If a file is "
   "specified, the help is written into it."},
  {"--help-html [file]", "Print full help in HTML format.",
   "This option is used by CMake authors to help produce web pages.  "
   "If a file is specified, the help is written into it."},
  {"--help-man [file]", "Print a UNIX man page and exit.",
   "This option is used by the cmake build to generate the UNIX man page.  "
   "If a file is specified, the help is written into it."},
  {"--version [file]", "Show program name/version banner and exit.",
   "If a file is specified, the version is written into it."},
43
44
45
  {0,0,0}
};

46
47
48
49
50
51
52
53
//----------------------------------------------------------------------------
static const cmDocumentationEntry cmDocumentationCommandsHeader[] =
{
  {0,
   "The following commands are available in CMakeLists.txt code:", 0},
  {0,0,0}
};

54
55
56
57
58
59
60
61
//----------------------------------------------------------------------------
static const cmDocumentationEntry cmDocumentationGeneratorsHeader[] =
{
  {0,
   "The following generators are available on this platform:", 0},
  {0,0,0}
};

Andy Cedilnik's avatar
Andy Cedilnik committed
62
63
64
65
66
//----------------------------------------------------------------------------
const cmDocumentationEntry cmDocumentationMailingList[] =
{
  {0,
   "For help and discussion about using cmake, a mailing list is provided "
67
   "at cmake@www.cmake.org.  Please first read the full documentation at "
Andy Cedilnik's avatar
Andy Cedilnik committed
68
69
70
71
   "http://www.cmake.org before posting questions to the list.", 0},
  {0,0,0}
};

72
73
74
75
76
77
78
79
//----------------------------------------------------------------------------
const cmDocumentationEntry cmDocumentationAuthor[] =
{
  {0,
   "This manual page was generated by \"cmake --help-man\".", 0},
  {0,0,0}
};

80
81
82
83
//----------------------------------------------------------------------------
const cmDocumentationEntry cmDocumentationCopyright[] =
{
  {0,
84
85
   "Copyright (c) 2002 Kitware, Inc., Insight Consortium.  "
   "All rights reserved.", 0},
86
87
88
  {0,
   "Redistribution and use in source and binary forms, with or without "
   "modification, are permitted provided that the following conditions are "
89
90
   "met:", 0},
  {"",
91
   "Redistributions of source code must retain the above copyright notice, "
92
93
   "this list of conditions and the following disclaimer.", 0},
  {"",
94
95
   "Redistributions in binary form must reproduce the above copyright "
   "notice, this list of conditions and the following disclaimer in the "
96
   "documentation and/or other materials provided with the distribution.",
97
   0},
98
  {"",
99
100
101
   "The names of Kitware, Inc., the Insight Consortium, or the names of "
   "any consortium members, or of any contributors, may not be used to "
   "endorse or promote products derived from this software without "
102
103
   "specific prior written permission.", 0},
  {"",
104
   "Modified source versions must be plainly marked as such, and must "
105
   "not be misrepresented as being the original software.", 0},
106
107
108
109
110
111
112
113
114
115
116
  {0,
   "THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "
   "``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT "
   "LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR "
   "A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR "
   "CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, "
   "EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, "
   "PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR "
   "PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF "
   "LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING "
   "NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS "
117
   "SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.", 0},
118
119
120
121
122
123
  {0, 0, 0}
};

//----------------------------------------------------------------------------
cmDocumentation::cmDocumentation()
{
124
125
126
  this->CurrentForm = TextForm;
  this->TextIndent = "";
  this->TextWidth = 77;
127
128
129
}

//----------------------------------------------------------------------------
130
void cmDocumentation::PrintCopyright(std::ostream& os)
131
{
132
  os << "CMake version " CMake_VERSION_FULL "\n";
133
134
  for(const cmDocumentationEntry* op = cmDocumentationCopyright;
      op->brief; ++op)
135
136
137
    {
    if(op->name)
      {
138
139
140
      os << " * ";
      this->TextIndent = "    ";
      this->PrintColumn(os, op->brief);
141
142
143
      }
    else
      {
144
145
      this->TextIndent = "";
      this->PrintColumn(os, op->brief);
146
      }
147
148
    os << "\n";
    }
149
150
151
}

//----------------------------------------------------------------------------
152
void cmDocumentation::PrintVersion(std::ostream& os)
153
{
154
  os << "CMake version " CMake_VERSION_FULL "\n";
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
}

//----------------------------------------------------------------------------
void cmDocumentation::AddSection(const char* name,
                                 const cmDocumentationEntry* d)
{
  this->Names.push_back(name);
  this->Sections.push_back(d);
}

//----------------------------------------------------------------------------
void cmDocumentation::ClearSections()
{
  this->Names.erase(this->Names.begin(), this->Names.end());
  this->Sections.erase(this->Sections.begin(), this->Sections.end());
}

//----------------------------------------------------------------------------
void cmDocumentation::PrintDocumentation(Type ht, std::ostream& os)
{
  switch (ht)
176
    {
177
178
179
180
181
182
183
184
    case cmDocumentation::Usage:     this->PrintDocumentationUsage(os); break;
    case cmDocumentation::Full:      this->PrintDocumentationFull(os); break;
    case cmDocumentation::HTML:      this->PrintDocumentationHTML(os); break;
    case cmDocumentation::Man:       this->PrintDocumentationMan(os); break;
    case cmDocumentation::Copyright: this->PrintCopyright(os); break;
    case cmDocumentation::Version:   this->PrintVersion(os); break;
    default: break;
    }
185
186
187
}

//----------------------------------------------------------------------------
188
189
190
191
192
193
194
195
bool cmDocumentation::PrintRequestedDocumentation(std::ostream& os)
{
  bool result = true;
  
  // Loop over requested documentation types.
  for(RequestedMapType::const_iterator i = this->RequestedMap.begin();
      i != this->RequestedMap.end(); ++i)
    {
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
    // Special case for printing help for a single command.
    if(i->first == cmDocumentation::Usage && i->second.length() > 0 &&
       !this->CommandsSection.empty())
      {
      // Check if the argument to the usage request was a command.
      for(cmDocumentationEntry* entry = &this->CommandsSection[0];
          entry->brief; ++entry)
        {
        if(entry->name && (strcmp(entry->name, i->second.c_str()) == 0))
          {
          this->PrintDocumentationCommand(os, entry);
          return true;
          }
        }
      
      // Argument was not a command.  Complain.
      os << "Help argument \"" << i->second.c_str()
         << "\" is not a CMake command.  "
         << "Use --help-full to see all commands.\n";
      return false;
      }
    
218
219
220
221
222
223
    // If a file name was given, use it.  Otherwise, default to the
    // given stream.
    std::ofstream* fout = 0;
    std::ostream* s = &os;
    if(i->second.length() > 0)
      {
Brad King's avatar
Brad King committed
224
      fout = new std::ofstream(i->second.c_str(), std::ios::out);
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
      if(fout)
        {
        s = fout;
        }
      else
        {
        result = false;
        }
      }
    
    // Print this documentation type to the stream.
    this->PrintDocumentation(i->first, *s);
    
    // Check for error.
    if(!*s)
      {
      result = false;
      }
    
    // Close the file if we wrote one.
    if(fout)
      {
      delete fout;
      }
    }
  return result;
}

//----------------------------------------------------------------------------
254
bool cmDocumentation::CheckOptions(int argc, const char* const* argv)
255
{
256
257
258
  // Providing zero arguments gives usage information.
  if(argc == 1)
    {
259
260
    this->RequestedMap[cmDocumentation::Usage] = "";
    return true;
261
262
263
    }
  
  // Search for supported help options.
264
  bool result = false;
265
  for(int i=1; i < argc; ++i)
266
    {
267
268
    // Check if this is a supported help option.
    Type type = cmDocumentation::None;
269
270
271
272
273
274
    if((strcmp(argv[i], "-help") == 0) ||
       (strcmp(argv[i], "--help") == 0) ||
       (strcmp(argv[i], "/?") == 0) ||
       (strcmp(argv[i], "-usage") == 0) ||
       (strcmp(argv[i], "-h") == 0) ||
       (strcmp(argv[i], "-H") == 0))
275
      {
276
277
278
279
280
      type = cmDocumentation::Usage;
      }
    else if(strcmp(argv[i], "--help-full") == 0)
      {
      type = cmDocumentation::Full;
281
      }
282
    else if(strcmp(argv[i], "--help-html") == 0)
283
      {
284
      type = cmDocumentation::HTML;
285
      }
286
    else if(strcmp(argv[i], "--help-man") == 0)
287
      {
288
      type = cmDocumentation::Man;
289
      }
290
    else if(strcmp(argv[i], "--copyright") == 0)
291
      {
292
      type = cmDocumentation::Copyright;
293
      }
294
295
296
297
    else if((strcmp(argv[i], "--version") == 0) || 
            (strcmp(argv[i], "-version") == 0) || 
            (strcmp(argv[i], "-V") == 0) || 
            (strcmp(argv[i], "/V") == 0))
298
      {
299
      type = cmDocumentation::Version;
300
      }
301
    if(type)
302
      {
303
304
305
306
307
308
309
310
311
312
313
314
      // This is a help option.  See if there is a file name given.
      result = true;
      if((i+1 < argc) && (argv[i+1][0] != '-') &&
         (strcmp(argv[i+1], "/V") != 0) && (strcmp(argv[i+1], "/?") != 0))
        {
        this->RequestedMap[type] = argv[i+1];
        i = i+1;
        }
      else
        {
        this->RequestedMap[type] = "";
        }
315
316
      }
    }
317
  return result;
318
319
}

320
//----------------------------------------------------------------------------
321
void cmDocumentation::Print(Form f, std::ostream& os)
322
{
323
  this->CurrentForm = f;
324
  for(unsigned int i=0; i < this->Sections.size(); ++i)
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
    {
    this->PrintSection(os, this->Sections[i], this->Names[i]);
    }
}

//----------------------------------------------------------------------------
void cmDocumentation::SetNameSection(const cmDocumentationEntry* section)
{
  this->SetSection(0, section, 0, this->NameSection);
}

//----------------------------------------------------------------------------
void cmDocumentation::SetUsageSection(const cmDocumentationEntry* section)
{
  this->SetSection(0, section, 0, this->UsageSection);
}

//----------------------------------------------------------------------------
void cmDocumentation::SetDescriptionSection(const cmDocumentationEntry* section)
{
  this->SetSection(0, section, 0, this->DescriptionSection);
}

//----------------------------------------------------------------------------
void cmDocumentation::SetOptionsSection(const cmDocumentationEntry* section)
{
  this->SetSection(0, section, cmDocumentationStandardOptions,
                   this->OptionsSection);
}

//----------------------------------------------------------------------------
void cmDocumentation::SetCommandsSection(const cmDocumentationEntry* section)
{
  this->SetSection(cmDocumentationCommandsHeader, section, 0,
                   this->CommandsSection);
}

362
363
364
365
366
367
368
//----------------------------------------------------------------------------
void cmDocumentation::SetGeneratorsSection(const cmDocumentationEntry* section)
{
  this->SetSection(cmDocumentationGeneratorsHeader, section, 0,
                   this->GeneratorsSection);
}

369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
//----------------------------------------------------------------------------
void cmDocumentation::SetSeeAlsoList(const cmDocumentationEntry* also)
{
  this->SeeAlsoString = ".B ";
  for(const cmDocumentationEntry* i = also; i->brief; ++i)
    {
    this->SeeAlsoString += i->brief;
    this->SeeAlsoString += (i+1)->brief? "(1), ":"(1)";    
    }
  cmDocumentationEntry e = {0, 0, 0};
  e.brief = this->SeeAlsoString.c_str();
  this->SeeAlsoSection.push_back(e);
  e.brief = 0;
  this->SeeAlsoSection.push_back(e);  
}

385
386
387
388
389
390
391
392
393
394
395
396
//----------------------------------------------------------------------------
void cmDocumentation::PrintSection(std::ostream& os,
                                   const cmDocumentationEntry* section,
                                   const char* name)
{
  switch (this->CurrentForm)
    {
    case TextForm: this->PrintSectionText(os, section, name); break;
    case HTMLForm: this->PrintSectionHTML(os, section, name); break;
    case ManForm: this->PrintSectionMan(os, section, name); break;
    case UsageForm: this->PrintSectionUsage(os, section, name); break;
    }
397
398
}

399
//----------------------------------------------------------------------------
400
401
402
void cmDocumentation::PrintSectionText(std::ostream& os,
                                       const cmDocumentationEntry* section,
                                       const char* name)
403
{
404
405
  if(name)
    {
406
407
408
    os <<
      "---------------------------------------"
      "---------------------------------------\n";
409
410
    os << name << "\n\n";
    }
411
  if(!section) { return; }
412
  for(const cmDocumentationEntry* op = section; op->brief; ++op)
413
    {
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
    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 cmDocumentation::PrintSectionHTML(std::ostream& os,
                                       const cmDocumentationEntry* section,
                                       const char* name)
{
  if(name)
    {
    os << "<h2>" << name << "</h2>\n";
445
    }
446
  if(!section) { return; }
447
448
449
450
451
452
453
454
  for(const cmDocumentationEntry* op = section; op->brief;)
    {
    if(op->name)
      {
      os << "<ul>\n";
      for(;op->name;++op)
        {
        os << "  <li>\n";
455
456
457
458
459
460
        if(op->name[0])
          {
          os << "    <b><code>";
          this->PrintHTMLEscapes(os, op->name);
          os << "</code></b>: ";
          }
461
462
463
        this->PrintHTMLEscapes(os, op->brief);
        if(op->full)
          {
464
465
          os << "<br>\n    ";
          this->PrintFormatted(os, op->full);
466
467
468
469
470
471
472
473
          }
        os << "\n";
        os << "  </li>\n";
        }
      os << "</ul>\n";
      }
    else
      {
474
      this->PrintFormatted(os, op->brief);
475
476
477
478
479
480
481
      os << "\n";
      ++op;
      }
    }
}

//----------------------------------------------------------------------------
482
483
484
void cmDocumentation::PrintSectionMan(std::ostream& os,
                                      const cmDocumentationEntry* section,
                                      const char* name)
485
{
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
  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 cmDocumentation::PrintSectionUsage(std::ostream& os,
                                        const cmDocumentationEntry* section,
                                        const char* name)
{
  if(name)
    {
    os << name << "\n";
    }
517
518
519
520
521
  if(!section) { return; }
  for(const cmDocumentationEntry* op = section; op->brief; ++op)
    {
    if(op->name)
      {
522
      os << "  " << op->name;
523
524
525
      this->TextIndent = "                             ";
      int align = static_cast<int>(strlen(this->TextIndent))-4;
      for(int i = static_cast<int>(strlen(op->name)); i < align; ++i)
526
527
528
        {
        os << " ";
        }
529
530
531
      os << "= ";
      this->PrintColumn(os, op->brief);
      os << "\n";
532
533
534
535
      }
    else
      {
      os << "\n";
536
537
      this->TextIndent = "";
      this->PrintFormatted(os, op->brief);
538
      }
539
    }
540
  os << "\n";
541
542
543
}

//----------------------------------------------------------------------------
544
void cmDocumentation::PrintFormatted(std::ostream& os, const char* text)
545
{
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
  if(!text)
    {
    return;
    }
  const char* ptr = text;
  while(*ptr)
    {
    // Any ptrs starting in a space are treated as preformatted text.
    std::string preformatted;
    while(*ptr == ' ')
      {
      for(char ch = *ptr; ch && ch != '\n'; ++ptr, ch = *ptr)
        {
        preformatted.append(1, ch);
        }
      if(*ptr)
        {
        ++ptr;
        preformatted.append(1, '\n');
        }
      }
    if(preformatted.length())
      {
      this->PrintPreformatted(os, preformatted.c_str());
      }
    
    // Other ptrs are treated as paragraphs.
    std::string paragraph;
    for(char ch = *ptr; ch && ch != '\n'; ++ptr, ch = *ptr)
      {
      paragraph.append(1, ch);
      }
    if(*ptr)
      {
      ++ptr;
      paragraph.append(1, '\n');
      }
    if(paragraph.length())
      {
      this->PrintParagraph(os, paragraph.c_str());
      }
    }
588
589
590
}

//----------------------------------------------------------------------------
591
void cmDocumentation::PrintPreformatted(std::ostream& os, const char* text)
592
{
593
  switch (this->CurrentForm)
594
    {
595
596
597
598
    case TextForm: this->PrintPreformattedText(os, text); break;
    case HTMLForm: this->PrintPreformattedHTML(os, text); break;
    case ManForm: this->PrintPreformattedMan(os, text); break;
    case UsageForm: this->PrintPreformattedText(os, text); break;
599
600
601
602
    }
}

//----------------------------------------------------------------------------
603
void cmDocumentation::PrintParagraph(std::ostream& os, const char* text)
604
{
605
606
607
608
609
610
611
  switch (this->CurrentForm)
    {
    case TextForm: this->PrintParagraphText(os, text); break;
    case HTMLForm: this->PrintParagraphHTML(os, text); break;
    case ManForm: this->PrintParagraphMan(os, text); break;
    case UsageForm: this->PrintParagraphText(os, text); break;
    }
612
613
614
}

//----------------------------------------------------------------------------
615
void cmDocumentation::PrintPreformattedText(std::ostream& os, const char* text)
616
{
617
618
  bool newline = true;
  for(const char* ptr = text; *ptr; ++ptr)
619
    {
620
    if(newline)
621
      {
622
623
      os << this->TextIndent;
      newline = false;
624
      }
625
626
    os << *ptr;
    if(*ptr == '\n')
627
      {
628
      newline = true;
629
630
      }
    }
631
  os << "\n";
632
633
634
}

//----------------------------------------------------------------------------
635
void cmDocumentation::PrintParagraphText(std::ostream& os, const char* text)
636
{
637
638
639
640
641
642
643
644
645
646
647
  os << this->TextIndent;
  this->PrintColumn(os, text);
  os << "\n";
}

//----------------------------------------------------------------------------
void cmDocumentation::PrintPreformattedHTML(std::ostream& os, const char* text)
{
  os << "<pre>";
  this->PrintHTMLEscapes(os, text);
  os << "</pre>\n    ";
648
649
650
}

//----------------------------------------------------------------------------
651
void cmDocumentation::PrintParagraphHTML(std::ostream& os, const char* text)
652
{
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
  os << "<p>";
  this->PrintHTMLEscapes(os, text);
}

//----------------------------------------------------------------------------
void cmDocumentation::PrintPreformattedMan(std::ostream& os, const char* text)
{
  os << text << "\n";
}

//----------------------------------------------------------------------------
void cmDocumentation::PrintParagraphMan(std::ostream& os, const char* text)
{
  os << text << "\n\n";
}

//----------------------------------------------------------------------------
void cmDocumentation::PrintColumn(std::ostream& os, const char* text)
{
  // Print text arranged in an indented column of fixed witdh.
673
674
675
  const char* l = text;
  int column = 0;
  bool newSentence = false;
676
  bool firstLine = true;
677
  int width = this->TextWidth - static_cast<int>(strlen(this->TextIndent));
678
679
  
  // Loop until the end of the text.
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
  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.
711
          os << (firstLine?"":this->TextIndent);
712
713
714
715
716
717
718
719
720
721
722
723
724
          }
        
        // 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;
725
        firstLine = false;
726
727
728
729
730
731
732
733
734
735
736
        }
      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";
737
      firstLine = false;
738
739
      if(r > l)
        {
740
        os << this->TextIndent;
741
742
743
744
745
746
747
748
749
750
751
752
753
        os.write(l, static_cast<long>(r-l));
        column = static_cast<long>(r-l);
        newSentence = (*(r-1) == '.');
        }
      }
    
    // Move to beginning of next word.  Skip over whitespace.
    l = r;
    while(*l && (*l == ' ')) { ++l; }    
    }
}

//----------------------------------------------------------------------------
754
void cmDocumentation::PrintHTMLEscapes(std::ostream& os, const char* text)
755
{
756
757
758
759
760
761
762
763
764
  static cmDocumentationEntry escapes[] =
  {
    {"<", "&lt;", 0},
    {">", "&gt;", 0},
    {"&", "&amp;", 0},
    {"\n", "<br>", 0},
    {0,0,0}
  };
  for(const char* p = text; *p; ++p)
765
    {
766
767
    bool found = false;
    for(const cmDocumentationEntry* op = escapes; !found && op->name; ++op)
768
      {
769
      if(op->name[0] == *p)
770
        {
771
772
        os << op->brief;
        found = true;
773
774
        }
      }
775
    if(!found)
776
      {
777
      os << *p;
778
779
780
781
782
      }
    }
}

//----------------------------------------------------------------------------
783
void cmDocumentation::PrintDocumentationUsage(std::ostream& os)
784
{
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
  this->CreateUsageDocumentation();
  this->Print(UsageForm, os);
}

//----------------------------------------------------------------------------
void cmDocumentation::PrintDocumentationFull(std::ostream& os)
{
  this->CreateFullDocumentation();
  this->Print(TextForm, os);
}

//----------------------------------------------------------------------------
void cmDocumentation::PrintDocumentationHTML(std::ostream& os)
{
  this->CreateFullDocumentation();
  os << "<html><body>\n";
  this->Print(HTMLForm, os);
  os << "</body></html>\n";
}

//----------------------------------------------------------------------------
void cmDocumentation::PrintDocumentationMan(std::ostream& os)
{
  this->CreateManDocumentation();
  os << ".TH CMake 1 \""
     << cmSystemTools::GetCurrentDateTime("%B %d, %Y").c_str()
811
     << "\" \"CMake " CMake_VERSION_FULL "\"\n";
812
813
814
  this->Print(ManForm, os);
}

815
816
817
818
819
820
821
822
823
824
825
826
827
828
//----------------------------------------------------------------------------
void cmDocumentation::PrintDocumentationCommand(std::ostream& os,
                                                cmDocumentationEntry* entry)
{
  cmDocumentationEntry singleCommandSection[3] =
    {
      {entry->name, entry->brief, entry->full},
      {0,0,0}
    };
  this->ClearSections();
  this->AddSection(0, &singleCommandSection[0]);
  this->Print(TextForm, os);
}

829
830
831
832
833
834
835
836
837
838
839
//----------------------------------------------------------------------------
void cmDocumentation::CreateUsageDocumentation()
{
  this->ClearSections();
  if(!this->UsageSection.empty())
    {
    this->AddSection("Usage", &this->UsageSection[0]);
    }
  if(!this->OptionsSection.empty())
    {
    this->AddSection("Command-Line Options", &this->OptionsSection[0]);
840
    }
841
842
843
844
  if(!this->GeneratorsSection.empty())
    {
    this->AddSection("Generators", &this->GeneratorsSection[0]);
    }
845
846
847
}

//----------------------------------------------------------------------------
848
void cmDocumentation::CreateFullDocumentation()
849
{
850
851
  this->ClearSections();
  if(!this->NameSection.empty())
852
    {
853
    this->AddSection("Name", &this->NameSection[0]);
854
    }
855
856
857
858
859
860
861
862
863
864
865
866
  if(!this->UsageSection.empty())
    {
    this->AddSection("Usage", &this->UsageSection[0]);
    }
  if(!this->DescriptionSection.empty())
    {
    this->AddSection(0, &this->DescriptionSection[0]);
    }
  if(!this->OptionsSection.empty())
    {
    this->AddSection("Command-Line Options", &this->OptionsSection[0]);
    }
867
868
869
870
  if(!this->GeneratorsSection.empty())
    {
    this->AddSection("Generators", &this->GeneratorsSection[0]);
    }
871
872
873
874
875
876
  if(!this->CommandsSection.empty())
    {
    this->AddSection("Listfile Commands", &this->CommandsSection[0]);
    }
  this->AddSection("Copyright", cmDocumentationCopyright);
  this->AddSection("Mailing List", cmDocumentationMailingList);
877
878
879
}

//----------------------------------------------------------------------------
880
void cmDocumentation::CreateManDocumentation()
881
{
882
883
  this->ClearSections();
  if(!this->NameSection.empty())
884
    {
885
    this->AddSection("NAME", &this->NameSection[0]);
886
    }
887
  if(!this->UsageSection.empty())
888
    {
889
    this->AddSection("SYNOPSIS", &this->UsageSection[0]);
890
    }
891
892
893
894
895
896
897
898
  if(!this->DescriptionSection.empty())
    {
    this->AddSection("DESCRIPTION", &this->DescriptionSection[0]);
    }
  if(!this->OptionsSection.empty())
    {
    this->AddSection("OPTIONS", &this->OptionsSection[0]);
    }
899
900
901
902
  if(!this->GeneratorsSection.empty())
    {
    this->AddSection("GENERATORS", &this->GeneratorsSection[0]);
    }
903
904
905
906
907
  if(!this->CommandsSection.empty())
    {
    this->AddSection("COMMANDS", &this->CommandsSection[0]);
    }
  this->AddSection("COPYRIGHT", cmDocumentationCopyright);
908
909
910
911
912
  this->AddSection("MAILING LIST", cmDocumentationMailingList);  
  if(!this->SeeAlsoSection.empty())
    {
    this->AddSection("SEE ALSO", &this->SeeAlsoSection[0]);
    }
913
  this->AddSection("AUTHOR", cmDocumentationAuthor);
914
}
915
916

//----------------------------------------------------------------------------
917
918
919
920
void cmDocumentation::SetSection(const cmDocumentationEntry* header,
                                 const cmDocumentationEntry* section,
                                 const cmDocumentationEntry* footer,
                                 std::vector<cmDocumentationEntry>& vec)
921
{
922
923
  vec.erase(vec.begin(), vec.end());
  if(header)
924
    {
925
926
927
928
929
930
931
932
933
934
935
    for(const cmDocumentationEntry* op = header; op->brief; ++op)
      {
      vec.push_back(*op);
      }
    }
  if(section)
    {
    for(const cmDocumentationEntry* op = section; op->brief; ++op)
      {
      vec.push_back(*op);
      }
936
    }
937
  if(footer)
938
    {
939
    for(const cmDocumentationEntry* op = footer; op->brief; ++op)
940
      {
941
      vec.push_back(*op);
942
943
944
      }
    }
  cmDocumentationEntry empty = {0,0,0};
945
  vec.push_back(empty);  
946
}