1 /*=========================================================================
3 Program: CMake - Cross-Platform Makefile Generator
4 Module: $RCSfile: cmDocumentationFormatterDocbook.cxx,v $
6 Date: $Date: 2008/02/19 19:33:43 $
7 Version: $Revision: 1.1 $
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.
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.
16 =========================================================================*/
17 #include "cmDocumentationFormatterDocbook.h"
18 #include "cmDocumentationSection.h"
19 //----------------------------------------------------------------------------
21 // this function is a copy of the one in the HTML formatter
22 // the three functions below are slightly modified copies
23 static bool cmDocumentationIsHyperlinkCharDocbook(char c
)
25 // This is not a complete list but works for CMake documentation.
26 return ((c
>= 'A' && c
<= 'Z') ||
27 (c
>= 'a' && c
<= 'z') ||
28 (c
>= '0' && c
<= '9') ||
29 c
== '-' || c
== '.' || c
== '/' || c
== '~' || c
== '@' ||
30 c
== ':' || c
== '_' || c
== '&' || c
== '?' || c
== '=');
33 //----------------------------------------------------------------------------
34 static void cmDocumentationPrintDocbookChar(std::ostream
& os
, char c
)
36 // Use an escape sequence if necessary.
53 //----------------------------------------------------------------------------
54 const char* cmDocumentationPrintDocbookLink(std::ostream
& os
,const char* begin
)
56 // Look for the end of the link.
57 const char* end
= begin
;
58 while(cmDocumentationIsHyperlinkCharDocbook(*end
))
63 // Print the hyperlink itself.
64 os
<< "<ulink url=\"";
65 for(const char* c
= begin
; c
!= end
; ++c
)
67 cmDocumentationPrintDocbookChar(os
, *c
);
74 //----------------------------------------------------------------------------
75 void cmDocumentationPrintDocbookEscapes(std::ostream
& os
, const char* text
)
77 // Hyperlink prefixes.
78 static const char* hyperlinks
[] = {"http://", "ftp://", "mailto:", 0};
80 // Print each character.
81 for(const char* p
= text
; *p
;)
83 // Handle hyperlinks specially to make them active.
84 bool found_hyperlink
= false;
85 for(const char** h
= hyperlinks
; !found_hyperlink
&& *h
; ++h
)
87 if(strncmp(p
, *h
, strlen(*h
)) == 0)
89 p
= cmDocumentationPrintDocbookLink(os
, p
);
90 found_hyperlink
= true;
94 // Print other characters normally.
97 cmDocumentationPrintDocbookChar(os
, *p
++);
103 cmDocumentationFormatterDocbook::cmDocumentationFormatterDocbook()
104 :cmDocumentationFormatter()
108 void cmDocumentationFormatterDocbook
109 ::PrintSection(std::ostream
& os
,
110 const cmDocumentationSection
§ion
,
115 std::string id
= "section_";
117 if (this->EmittedLinkIds
.find(id
) == this->EmittedLinkIds
.end())
119 this->EmittedLinkIds
.insert(id
);
120 os
<< "<sect1 id=\"section_" << name
<< "\">\n"
121 "<title>\n" << name
<< "</title>\n";
125 static unsigned int i
=0;
127 os
<< "<sect1 id=\"section_" << name
<< i
<< "\">\n"
128 "<title>\n" << name
<< "</title>\n";
132 const std::vector
<cmDocumentationEntry
> &entries
=
133 section
.GetEntries();
135 os
<< "<itemizedlist>\n";
136 for(std::vector
<cmDocumentationEntry
>::const_iterator op
137 = entries
.begin(); op
!= entries
.end(); ++ op
)
141 os
<< " <listitem><link linkend=\"command_";
142 cmDocumentationPrintDocbookEscapes(os
, op
->Name
.c_str());
143 os
<< "\"><emphasis><literal>";
144 cmDocumentationPrintDocbookEscapes(os
, op
->Name
.c_str());
145 os
<< "</literal></emphasis></link></listitem>";
148 os
<< "</itemizedlist>\n" ;
150 for(std::vector
<cmDocumentationEntry
>::const_iterator op
= entries
.begin();
151 op
!= entries
.end();)
155 for(;op
!= entries
.end() && op
->Name
.size(); ++op
)
159 os
<< " <para id=\"command_";
160 cmDocumentationPrintDocbookEscapes(os
, op
->Name
.c_str());
162 // make sure that each id exists only once, e.g.
163 // command_COMPILE_DEFINITIONS exists at least twice. Since it seems
164 // not easily possible to determine which link refers to which id,
165 // we have at least to make sure that the duplicated id's get a
166 // different name (by appending an increasing number), Alex
167 std::string id
= "command_";
169 if (this->EmittedLinkIds
.find(id
) == this->EmittedLinkIds
.end())
171 this->EmittedLinkIds
.insert(id
);
175 static unsigned int i
=0;
179 // continue as normal...
181 os
<< "\"><sect2><title>";
182 cmDocumentationPrintDocbookEscapes(os
, op
->Name
.c_str());
183 os
<< "</title></sect2> ";
185 cmDocumentationPrintDocbookEscapes(os
, op
->Brief
.c_str());
193 // a line break seems to be simply a line break with docbook
195 this->PrintFormatted(os
, op
->Full
.c_str());
202 this->PrintFormatted(os
, op
->Brief
.c_str());
213 void cmDocumentationFormatterDocbook::PrintPreformatted(std::ostream
& os
,
216 os
<< "<literallayout>";
217 cmDocumentationPrintDocbookEscapes(os
, text
);
218 os
<< "</literallayout>\n ";
221 void cmDocumentationFormatterDocbook::PrintParagraph(std::ostream
& os
,
225 cmDocumentationPrintDocbookEscapes(os
, text
);
229 //----------------------------------------------------------------------------
230 void cmDocumentationFormatterDocbook::PrintHeader(const char* name
,
233 // this one is used to ensure that we don't create multiple link targets
234 // with the same name. We can clear it here since we are at the
235 // start of a document here.
236 this->EmittedLinkIds
.clear();
238 os
<< "<?xml version=\"1.0\" ?>\n"
239 "<!DOCTYPE article PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\" "
240 "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\" [\n"
241 "<!ENTITY % addindex \"IGNORE\">\n"
242 "<!ENTITY % English \"INCLUDE\"> ]>\n"
245 "<title>" << name
<< "</title>\n"
249 //----------------------------------------------------------------------------
250 void cmDocumentationFormatterDocbook::PrintFooter(std::ostream
& os
)
252 os
<< "</article>\n";