1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
/*=========================================================================
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.
=========================================================================*/
// Program extracts documentation describing commands from
// the CMake system.
//
#include "cmake.h"
#include "cmDocumentation.h"
#include "cmVersion.h"
//----------------------------------------------------------------------------
static const char *cmDocumentationName[][3] =
{
{0,
" DumpDocumentation - Dump documentation for CMake.", 0},
{0,0,0}
};
//----------------------------------------------------------------------------
static const char *cmDocumentationUsage[][3] =
{
{0,
" DumpDocumentation [filename]", 0},
{0,0,0}
};
//----------------------------------------------------------------------------
static const char *cmDocumentationDescription[][3] =
{
{0,
"The \"DumpDocumentation\" executable is only available in the build "
"tree. It is used for testing, coverage, and documentation.", 0},
CMAKE_STANDARD_INTRODUCTION,
{0,0,0}
};
//----------------------------------------------------------------------------
static const char *cmDocumentationOptions[][3] =
{
{"--all-for-coverage",
"Dump all documentation to stdout. For testing.", 0},
{0,0,0}
};
int DumpHTML(const char* outname)
{
std::ofstream fout(outname);
if(!fout)
{
std::cerr << "failed to open output file: " << outname << "\n";
cmSystemTools::ReportLastSystemError("");
return -1;
}
cmake cmi;
cmDocumentation doc;
std::vector<cmDocumentationEntry> commands;
cmi.GetCommandDocumentation(commands);
cmOStringStream str;
str << "Documentation for Commands of CMake "
<< cmVersion::GetCMakeVersion();
doc.SetSection(str.str().c_str(), commands);
doc.Print(cmDocumentation::HTMLForm, fout);
return 0;
}
int DumpForCoverageToStream(std::ostream& out)
{
cmake cmi;
cmDocumentation doc;
std::vector<cmDocumentationEntry> commands;
std::vector<cmDocumentationEntry> generators;
cmi.GetCommandDocumentation(commands);
cmi.GetGeneratorDocumentation(generators);
doc.SetSection("Name",cmDocumentationName);
doc.SetSection("Usage",cmDocumentationUsage);
doc.SetSection("Description",cmDocumentationDescription);
doc.SetSection("options",cmDocumentationOptions);
doc.SetSection("Commands",commands);
doc.SetSection("Generators",generators);
doc.PrintDocumentation(cmDocumentation::Usage, out);
doc.PrintDocumentation(cmDocumentation::Full, out);
return 0;
}
int DumpForCoverage(const char* outname)
{
if(outname)
{
std::ofstream fout(outname);
if(!fout)
{
std::cerr << "failed to open output file: " << outname << "\n";
cmSystemTools::ReportLastSystemError("");
return -1;
}
return DumpForCoverageToStream(fout);
}
else
{
return DumpForCoverageToStream(std::cout);
}
}
int main(int ac, char** av)
{
cmSystemTools::EnableMSVCDebugHook();
const char* outname = "cmake.html";
bool coverage = false;
if(ac > 1)
{
if(strcmp(av[1], "--all-for-coverage") == 0)
{
coverage = true;
if(ac > 2)
{
outname = av[2];
}
else
{
outname = 0;
}
}
else
{
outname = av[1];
}
}
if(coverage)
{
return DumpForCoverage(outname);
}
else
{
return DumpHTML(outname);
}
}
|
