cmDocumentation.cxx 30.6 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
  {"--copyright [file]", "Print the CMake copyright and exit.",
   "If a file is specified, the copyright is written into it."},
26
27
28
29
30
  {"--help", "Print usage information and exit.",
   "Usage describes the basic command line interface and its options."},
  {"--help-command cmd [file]", "Print help for a single command and exit.",
   "Full documentation specific to the given command is displayed."},
  {"--help-command-list [file]", "List available listfile commands and exit.",
31
   "The list contains all commands for which help may be obtained by using "
32
33
   "the --help-command argument followed by a command name.  If a file is "
   "specified, the help is written into it."},
34
  {"--help-full [file]", "Print full help and exit.",
35
36
   "Full help displays most of the documentation provided by the UNIX "
   "man page.  It is provided for use on non-UNIX platforms, but is "
37
38
39
40
41
42
43
44
45
46
   "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."},
47
48
49
  {0,0,0}
};

50
51
52
53
54
55
56
57
//----------------------------------------------------------------------------
static const cmDocumentationEntry cmDocumentationCommandsHeader[] =
{
  {0,
   "The following commands are available in CMakeLists.txt code:", 0},
  {0,0,0}
};

58
59
60
61
62
63
64
65
//----------------------------------------------------------------------------
static const cmDocumentationEntry cmDocumentationGeneratorsHeader[] =
{
  {0,
   "The following generators are available on this platform:", 0},
  {0,0,0}
};

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

76
77
78
79
//----------------------------------------------------------------------------
const cmDocumentationEntry cmDocumentationAuthor[] =
{
  {0,
80
   "This manual page was generated by the \"--help-man\" option.", 0},
81
82
83
  {0,0,0}
};

84
85
86
87
//----------------------------------------------------------------------------
const cmDocumentationEntry cmDocumentationCopyright[] =
{
  {0,
88
89
   "Copyright (c) 2002 Kitware, Inc., Insight Consortium.  "
   "All rights reserved.", 0},
90
91
92
  {0,
   "Redistribution and use in source and binary forms, with or without "
   "modification, are permitted provided that the following conditions are "
93
94
   "met:", 0},
  {"",
95
   "Redistributions of source code must retain the above copyright notice, "
96
97
   "this list of conditions and the following disclaimer.", 0},
  {"",
98
99
   "Redistributions in binary form must reproduce the above copyright "
   "notice, this list of conditions and the following disclaimer in the "
100
   "documentation and/or other materials provided with the distribution.",
101
   0},
102
  {"",
103
104
105
   "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 "
106
107
   "specific prior written permission.", 0},
  {"",
108
   "Modified source versions must be plainly marked as such, and must "
109
   "not be misrepresented as being the original software.", 0},
110
111
112
113
114
115
116
117
118
119
120
  {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 "
121
   "SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.", 0},
122
123
124
125
126
127
  {0, 0, 0}
};

//----------------------------------------------------------------------------
cmDocumentation::cmDocumentation()
{
128
129
130
  this->CurrentForm = TextForm;
  this->TextIndent = "";
  this->TextWidth = 77;
131
132
133
}

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

//----------------------------------------------------------------------------
157
bool cmDocumentation::PrintVersion(std::ostream& os)
158
{
159
  os << this->GetNameString() << " version " CMake_VERSION_FULL "\n";
160
  return true;
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
}

//----------------------------------------------------------------------------
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());
}

//----------------------------------------------------------------------------
179
bool cmDocumentation::PrintDocumentation(Type ht, std::ostream& os)
180
181
{
  switch (ht)
182
    {
183
184
185
186
187
188
189
190
191
    case cmDocumentation::Usage:     return this->PrintDocumentationUsage(os);
    case cmDocumentation::Single:    return this->PrintDocumentationSingle(os);
    case cmDocumentation::List:      return this->PrintDocumentationList(os);
    case cmDocumentation::Full:      return this->PrintDocumentationFull(os);
    case cmDocumentation::HTML:      return this->PrintDocumentationHTML(os);
    case cmDocumentation::Man:       return this->PrintDocumentationMan(os);
    case cmDocumentation::Copyright: return this->PrintCopyright(os);
    case cmDocumentation::Version:   return this->PrintVersion(os);
    default: return false;
192
    }
193
194
195
}

//----------------------------------------------------------------------------
196
197
198
199
200
201
202
203
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)
    {
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
    // 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.  "
222
         << "Use --help-command-list to see all commands.\n";
223
224
225
      return false;
      }
    
226
227
228
229
230
231
    // 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
232
      fout = new std::ofstream(i->second.c_str(), std::ios::out);
233
234
235
236
237
238
239
240
241
242
243
      if(fout)
        {
        s = fout;
        }
      else
        {
        result = false;
        }
      }
    
    // Print this documentation type to the stream.
244
    if(!this->PrintDocumentation(i->first, *s) || !*s)
245
246
247
248
249
250
251
252
253
254
255
256
257
258
      {
      result = false;
      }
    
    // Close the file if we wrote one.
    if(fout)
      {
      delete fout;
      }
    }
  return result;
}

//----------------------------------------------------------------------------
259
bool cmDocumentation::CheckOptions(int argc, const char* const* argv)
260
{
261
262
263
  // Providing zero arguments gives usage information.
  if(argc == 1)
    {
264
265
    this->RequestedMap[cmDocumentation::Usage] = "";
    return true;
266
267
268
    }
  
  // Search for supported help options.
269
  bool result = false;
270
  for(int i=1; i < argc; ++i)
271
    {
272
273
    // Check if this is a supported help option.
    Type type = cmDocumentation::None;
274
275
276
277
278
279
    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))
280
      {
281
282
283
284
285
      type = cmDocumentation::Usage;
      }
    else if(strcmp(argv[i], "--help-full") == 0)
      {
      type = cmDocumentation::Full;
286
      }
287
    else if(strcmp(argv[i], "--help-html") == 0)
288
      {
289
      type = cmDocumentation::HTML;
290
      }
291
    else if(strcmp(argv[i], "--help-man") == 0)
292
      {
293
      type = cmDocumentation::Man;
294
      }
295
296
297
298
299
300
301
302
303
304
    else if(strcmp(argv[i], "--help-command") == 0)
      {
      type = cmDocumentation::Single;
      if((i+1 < argc) && !this->IsOption(argv[i+1]))
        {
        this->SingleCommand = argv[i+1];
        i = i+1;
        }
      }
    else if(strcmp(argv[i], "--help-command-list") == 0)
305
306
307
      {
      type = cmDocumentation::List;
      }
308
    else if(strcmp(argv[i], "--copyright") == 0)
309
      {
310
      type = cmDocumentation::Copyright;
311
      }
312
313
314
    else if((strcmp(argv[i], "--version") == 0) || 
            (strcmp(argv[i], "-version") == 0) || 
            (strcmp(argv[i], "/V") == 0))
315
      {
316
      type = cmDocumentation::Version;
317
      }
318
    if(type)
319
      {
320
321
      // This is a help option.  See if there is a file name given.
      result = true;
322
      if((i+1 < argc) && !this->IsOption(argv[i+1]))
323
324
325
326
327
328
329
330
        {
        this->RequestedMap[type] = argv[i+1];
        i = i+1;
        }
      else
        {
        this->RequestedMap[type] = "";
        }
331
332
      }
    }
333
  return result;
334
335
}

336
//----------------------------------------------------------------------------
337
void cmDocumentation::Print(Form f, std::ostream& os)
338
{
339
  this->CurrentForm = f;
340
  for(unsigned int i=0; i < this->Sections.size(); ++i)
341
342
343
344
345
    {
    this->PrintSection(os, this->Sections[i], this->Names[i]);
    }
}

346
347
348
349
350
351
//----------------------------------------------------------------------------
void cmDocumentation::SetName(const char* name)
{
  this->NameString = name?name:"";
}

352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
//----------------------------------------------------------------------------
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);
}

384
385
386
387
388
389
390
//----------------------------------------------------------------------------
void cmDocumentation::SetGeneratorsSection(const cmDocumentationEntry* section)
{
  this->SetSection(cmDocumentationGeneratorsHeader, section, 0,
                   this->GeneratorsSection);
}

391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
//----------------------------------------------------------------------------
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);  
}

407
408
409
410
411
412
413
414
415
416
417
418
//----------------------------------------------------------------------------
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;
    }
419
420
}

421
//----------------------------------------------------------------------------
422
423
424
void cmDocumentation::PrintSectionText(std::ostream& os,
                                       const cmDocumentationEntry* section,
                                       const char* name)
425
{
426
427
  if(name)
    {
428
429
430
    os <<
      "---------------------------------------"
      "---------------------------------------\n";
431
432
    os << name << "\n\n";
    }
433
  if(!section) { return; }
434
  for(const cmDocumentationEntry* op = section; op->brief; ++op)
435
    {
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
    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";
467
    }
468
  if(!section) { return; }
469
470
471
472
473
474
475
476
  for(const cmDocumentationEntry* op = section; op->brief;)
    {
    if(op->name)
      {
      os << "<ul>\n";
      for(;op->name;++op)
        {
        os << "  <li>\n";
477
478
479
480
481
482
        if(op->name[0])
          {
          os << "    <b><code>";
          this->PrintHTMLEscapes(os, op->name);
          os << "</code></b>: ";
          }
483
484
485
        this->PrintHTMLEscapes(os, op->brief);
        if(op->full)
          {
486
487
          os << "<br>\n    ";
          this->PrintFormatted(os, op->full);
488
489
490
491
492
493
494
495
          }
        os << "\n";
        os << "  </li>\n";
        }
      os << "</ul>\n";
      }
    else
      {
496
      this->PrintFormatted(os, op->brief);
497
498
499
500
501
502
503
      os << "\n";
      ++op;
      }
    }
}

//----------------------------------------------------------------------------
504
505
506
void cmDocumentation::PrintSectionMan(std::ostream& os,
                                      const cmDocumentationEntry* section,
                                      const char* name)
507
{
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
  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";
    }
539
540
541
542
543
  if(!section) { return; }
  for(const cmDocumentationEntry* op = section; op->brief; ++op)
    {
    if(op->name)
      {
544
      os << "  " << op->name;
545
      this->TextIndent = "                                ";
546
547
      int align = static_cast<int>(strlen(this->TextIndent))-4;
      for(int i = static_cast<int>(strlen(op->name)); i < align; ++i)
548
549
550
        {
        os << " ";
        }
551
552
553
      os << "= ";
      this->PrintColumn(os, op->brief);
      os << "\n";
554
555
556
557
      }
    else
      {
      os << "\n";
558
559
      this->TextIndent = "";
      this->PrintFormatted(os, op->brief);
560
      }
561
    }
562
  os << "\n";
563
564
565
}

//----------------------------------------------------------------------------
566
void cmDocumentation::PrintFormatted(std::ostream& os, const char* text)
567
{
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
  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());
      }
    }
610
611
612
}

//----------------------------------------------------------------------------
613
void cmDocumentation::PrintPreformatted(std::ostream& os, const char* text)
614
{
615
  switch (this->CurrentForm)
616
    {
617
618
619
620
    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;
621
622
623
624
    }
}

//----------------------------------------------------------------------------
625
void cmDocumentation::PrintParagraph(std::ostream& os, const char* text)
626
{
627
628
629
630
631
632
633
  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;
    }
634
635
636
}

//----------------------------------------------------------------------------
637
void cmDocumentation::PrintPreformattedText(std::ostream& os, const char* text)
638
{
639
640
  bool newline = true;
  for(const char* ptr = text; *ptr; ++ptr)
641
    {
642
    if(newline)
643
      {
644
645
      os << this->TextIndent;
      newline = false;
646
      }
647
648
    os << *ptr;
    if(*ptr == '\n')
649
      {
650
      newline = true;
651
652
      }
    }
653
  os << "\n";
654
655
656
}

//----------------------------------------------------------------------------
657
void cmDocumentation::PrintParagraphText(std::ostream& os, const char* text)
658
{
659
660
661
662
663
664
665
666
667
668
669
  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    ";
670
671
672
}

//----------------------------------------------------------------------------
673
void cmDocumentation::PrintParagraphHTML(std::ostream& os, const char* text)
674
{
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
  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.
695
696
697
  const char* l = text;
  int column = 0;
  bool newSentence = false;
698
  bool firstLine = true;
699
  int width = this->TextWidth - static_cast<int>(strlen(this->TextIndent));
700
701
  
  // Loop until the end of the text.
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
  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.
733
          os << (firstLine?"":this->TextIndent);
734
735
736
737
738
739
740
741
742
743
744
745
746
          }
        
        // 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;
747
        firstLine = false;
748
749
750
751
752
753
754
755
756
757
758
        }
      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";
759
      firstLine = false;
760
761
      if(r > l)
        {
762
        os << this->TextIndent;
763
764
765
766
767
768
769
770
771
772
773
774
775
        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; }    
    }
}

//----------------------------------------------------------------------------
776
void cmDocumentation::PrintHTMLEscapes(std::ostream& os, const char* text)
777
{
778
779
780
781
782
783
784
785
786
  static cmDocumentationEntry escapes[] =
  {
    {"<", "&lt;", 0},
    {">", "&gt;", 0},
    {"&", "&amp;", 0},
    {"\n", "<br>", 0},
    {0,0,0}
  };
  for(const char* p = text; *p; ++p)
787
    {
788
789
    bool found = false;
    for(const cmDocumentationEntry* op = escapes; !found && op->name; ++op)
790
      {
791
      if(op->name[0] == *p)
792
        {
793
794
        os << op->brief;
        found = true;
795
796
        }
      }
797
    if(!found)
798
      {
799
      os << *p;
800
801
802
803
804
      }
    }
}

//----------------------------------------------------------------------------
805
bool cmDocumentation::PrintDocumentationSingle(std::ostream& os)
806
{
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
  if(this->CommandsSection.empty())
    {
    os << "Internal error: commands list is empty." << std::endl;
    return false;
    }
  if(this->SingleCommand.length() == 0)
    {
    os << "Argument --help-command needs a command name.\n";
    return false;
    }
  for(cmDocumentationEntry* entry = &this->CommandsSection[0];
      entry->brief; ++entry)
    {
    if(entry->name && this->SingleCommand == entry->name)
      {
      this->PrintDocumentationCommand(os, entry);
      return true;
      }
    }
  // Argument was not a command.  Complain.
  os << "Argument \"" << this->SingleCommand.c_str()
     << "\" to --help-command is not a CMake command.  "
     << "Use --help-command-list to see all commands.\n";
  return false;
831
832
}

833
//----------------------------------------------------------------------------
834
bool cmDocumentation::PrintDocumentationList(std::ostream& os)
835
{
836
837
838
839
840
  if(this->CommandsSection.empty())
    {
    os << "Internal error: commands list is empty." << std::endl;
    return false;
    }
841
842
843
844
845
846
847
848
  for(cmDocumentationEntry* entry = &this->CommandsSection[0];
      entry->brief; ++entry)
    {
    if(entry->name)
      {
      os << entry->name << std::endl;
      }
    }
849
  return true;
850
851
}

852
//----------------------------------------------------------------------------
853
854
855
856
857
858
859
860
861
bool cmDocumentation::PrintDocumentationUsage(std::ostream& os)
{
  this->CreateUsageDocumentation();
  this->Print(UsageForm, os);
  return true;
}

//----------------------------------------------------------------------------
bool cmDocumentation::PrintDocumentationFull(std::ostream& os)
862
863
864
{
  this->CreateFullDocumentation();
  this->Print(TextForm, os);
865
  return true;
866
867
868
}

//----------------------------------------------------------------------------
869
bool cmDocumentation::PrintDocumentationHTML(std::ostream& os)
870
871
872
873
874
{
  this->CreateFullDocumentation();
  os << "<html><body>\n";
  this->Print(HTMLForm, os);
  os << "</body></html>\n";
875
  return true;
876
877
878
}

//----------------------------------------------------------------------------
879
bool cmDocumentation::PrintDocumentationMan(std::ostream& os)
880
881
{
  this->CreateManDocumentation();
882
  os << ".TH " << this->GetNameString() << " 1 \""
883
     << cmSystemTools::GetCurrentDateTime("%B %d, %Y").c_str()
884
     << "\" \"" << this->GetNameString() << " " CMake_VERSION_FULL "\"\n";
885
  this->Print(ManForm, os);
886
  return true;
887
888
}

889
890
891
892
893
894
895
896
897
898
899
900
901
902
//----------------------------------------------------------------------------
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);
}

903
904
905
906
907
908
909
910
911
912
913
//----------------------------------------------------------------------------
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]);
914
    }
915
916
917
918
  if(!this->GeneratorsSection.empty())
    {
    this->AddSection("Generators", &this->GeneratorsSection[0]);
    }
919
920
921
}

//----------------------------------------------------------------------------
922
void cmDocumentation::CreateFullDocumentation()
923
{
924
925
  this->ClearSections();
  if(!this->NameSection.empty())
926
    {
927
    this->AddSection("Name", &this->NameSection[0]);
928
    }
929
930
931
932
933
934
935
936
937
938
939
940
  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]);
    }
941
942
943
944
  if(!this->GeneratorsSection.empty())
    {
    this->AddSection("Generators", &this->GeneratorsSection[0]);
    }
945
946
947
948
949
950
  if(!this->CommandsSection.empty())
    {
    this->AddSection("Listfile Commands", &this->CommandsSection[0]);
    }
  this->AddSection("Copyright", cmDocumentationCopyright);
  this->AddSection("Mailing List", cmDocumentationMailingList);
951
952
953
}

//----------------------------------------------------------------------------
954
void cmDocumentation::CreateManDocumentation()
955
{
956
957
  this->ClearSections();
  if(!this->NameSection.empty())
958
    {
959
    this->AddSection("NAME", &this->NameSection[0]);
960
    }
961
  if(!this->UsageSection.empty())
962
    {
963
    this->AddSection("SYNOPSIS", &this->UsageSection[0]);
964
    }
965
966
967
968
969
970
971
972
  if(!this->DescriptionSection.empty())
    {
    this->AddSection("DESCRIPTION", &this->DescriptionSection[0]);
    }
  if(!this->OptionsSection.empty())
    {
    this->AddSection("OPTIONS", &this->OptionsSection[0]);
    }
973
974
975
976
  if(!this->GeneratorsSection.empty())
    {
    this->AddSection("GENERATORS", &this->GeneratorsSection[0]);
    }
977
978
979
980
981
  if(!this->CommandsSection.empty())
    {
    this->AddSection("COMMANDS", &this->CommandsSection[0]);
    }
  this->AddSection("COPYRIGHT", cmDocumentationCopyright);
982
983
984
985
986
  this->AddSection("MAILING LIST", cmDocumentationMailingList);  
  if(!this->SeeAlsoSection.empty())
    {
    this->AddSection("SEE ALSO", &this->SeeAlsoSection[0]);
    }
987
  this->AddSection("AUTHOR", cmDocumentationAuthor);
988
}
989
990

//----------------------------------------------------------------------------
991
992
993
994
void cmDocumentation::SetSection(const cmDocumentationEntry* header,
                                 const cmDocumentationEntry* section,
                                 const cmDocumentationEntry* footer,
                                 std::vector<cmDocumentationEntry>& vec)
995
{
996
997
  vec.erase(vec.begin(), vec.end());
  if(header)
998
    {
999
1000
    for(const cmDocumentationEntry* op = header; op->brief; ++op)
      {