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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
#include "cmDocumentationFormatter.h"
#include "cmDocumentationEntry.h"
#include "cmDocumentationSection.h"
#include <ostream>
#include <string.h>
#include <string>
#include <vector>
cmDocumentationFormatter::cmDocumentationFormatter()
: TextWidth(77)
, TextIndent("")
{
}
cmDocumentationFormatter::~cmDocumentationFormatter()
{
}
void cmDocumentationFormatter::PrintFormatted(std::ostream& os,
const char* text)
{
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.empty()) {
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.empty()) {
this->PrintParagraph(os, paragraph.c_str());
}
}
}
void cmDocumentationFormatter::PrintPreformatted(std::ostream& os,
const char* text)
{
bool newline = true;
for (const char* ptr = text; *ptr; ++ptr) {
if (newline && *ptr != '\n') {
os << this->TextIndent;
newline = false;
}
os << *ptr;
if (*ptr == '\n') {
newline = true;
}
}
os << "\n";
}
void cmDocumentationFormatter::PrintParagraph(std::ostream& os,
const char* text)
{
os << this->TextIndent;
this->PrintColumn(os, text);
os << "\n";
}
void cmDocumentationFormatter::SetIndent(const char* indent)
{
this->TextIndent = indent;
}
void cmDocumentationFormatter::PrintColumn(std::ostream& os, const char* text)
{
// Print text arranged in an indented column of fixed witdh.
const char* l = text;
long column = 0;
bool newSentence = false;
bool firstLine = true;
int width = this->TextWidth - static_cast<int>(strlen(this->TextIndent));
// Loop until the end of the text.
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.
os << (firstLine ? "" : this->TextIndent);
}
// 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;
firstLine = false;
} 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";
firstLine = false;
if (r > l) {
os << this->TextIndent;
os.write(l, static_cast<long>(r - l));
column = static_cast<long>(r - l);
newSentence = (*(r - 1) == '.');
} else {
column = 0;
}
}
// Move to beginning of next word. Skip over whitespace.
l = r;
while (*l && (*l == ' ')) {
++l;
}
}
}
void cmDocumentationFormatter::PrintSection(
std::ostream& os, cmDocumentationSection const& section)
{
os << section.GetName() << "\n";
const std::vector<cmDocumentationEntry>& entries = section.GetEntries();
for (std::vector<cmDocumentationEntry>::const_iterator op = entries.begin();
op != entries.end(); ++op) {
if (!op->Name.empty()) {
os << " " << op->Name;
this->TextIndent = " ";
int align = static_cast<int>(strlen(this->TextIndent)) - 4;
for (int i = static_cast<int>(op->Name.size()); i < align; ++i) {
os << " ";
}
if (op->Name.size() > strlen(this->TextIndent) - 4) {
os << "\n";
os.write(this->TextIndent, strlen(this->TextIndent) - 2);
}
os << "= ";
this->PrintColumn(os, op->Brief.c_str());
os << "\n";
} else {
os << "\n";
this->TextIndent = "";
this->PrintFormatted(os, op->Brief.c_str());
}
}
os << "\n";
}
|
