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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
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
254
255
256
|
# Copyright (c) 2006-2009 Alexander Neundorf, <neundorf@kde.org>
# Copyright (c) 2006, 2007, Laurent Montel, <montel@kde.org>
# Copyright (c) 2007 Matthias Kretz <kretz@kde.org>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# 3. Neither the name of the University nor the names of its contributors
# may be used to endorse or promote products derived from this software
# without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
# KDOCTOOLS_CREATE_HANDBOOK( docbookfile [INSTALL_DESTINATION installdest] [SUBDIR subdir])
# Create the handbook from the docbookfile (using meinproc5)
# The resulting handbook will be installed to <installdest> when using
# INSTALL_DESTINATION <installdest>, or to <installdest>/<subdir> if
# SUBDIR <subdir> is specified.
#
# KDOCTOOLS_CREATE_MANPAGE( docbookfile section [INSTALL_DESTINATION installdest])
# Create the manpage for the specified section from the docbookfile (using meinproc5)
# The resulting manpage will be installed to <installdest> when using
# INSTALL_DESTINATION <installdest>.
#
# KDOCTOOLS_INSTALL(podir)
# Search for docbook files in <podir> and install them to the standard
# location.
# This is a convenience function which relies on all docbooks being kept in
# <podir>/<lang>/docs/<project>, where <lang> is the language the docbooks
# for <project> are written in.
#
# Within this directory, files ending with .[0-9].docbook are installed using
# KDOCTOOLS_CREATE_MANPAGE, other .docbook files are installed using
# KDOCTOOLS_CREATE_HANDBOOK if index.docbook is available.
#
# For example, given the following directory structure:
#
# po/
# fr/
# docs/
# foo/
# kioslave5/
# fooslave/
# index.docbook
# footool.1.docbook
# footool.conf.5.docbook
# index.docbook
#
# KDOCTOOLS_INSTALL(po) does the following:
# - Create man pages from footool.1.docbook and footool.conf.5.docbook,
# install them in ${MAN_INSTALL_DIR}/fr
# - Create handbooks from index.docbook files, install the one from the
# fooslave/ directory in ${HTML_INSTALL_DIR}/fr/kioslave5/fooslave
# and the one from the docs/ directory in $[HTML_INSTALL_DIR}/fr
#
# If ${HTML_INSTALL_DIR} is not set, share/doc/HTML is used instead.
# If ${MAN_INSTALL_DIR} is not set, share/man/<lang> is used instead.
#
# KDOCTOOLS_MEINPROC_EXECUTABLE - the meinproc5 executable
#
# KDOCTOOLS_SERIALIZE_TOOL - wrapper to serialize potentially resource-intensive commands during
# parallel builds (set to 'icecc' when using icecream)
#
# The following variables are defined for the various tools required to
# compile KDE software:
#
# KDOCTOOLS_MEINPROC_EXECUTABLE - the meinproc5 executable
#
set(KDOCTOOLS_SERIALIZE_TOOL "" CACHE STRING "Tool to serialize resource-intensive commands in parallel builds")
set(KDOCTOOLS_MEINPROC_EXECUTABLE "KF5::meinproc5")
if(KDOCTOOLS_SERIALIZE_TOOL)
# parallel build with many meinproc invocations can consume a huge amount of memory
set(KDOCTOOLS_MEINPROC_EXECUTABLE ${KDOCTOOLS_SERIALIZE_TOOL} ${KDOCTOOLS_MEINPROC_EXECUTABLE})
endif(KDOCTOOLS_SERIALIZE_TOOL)
function(_kdoctools_create_target_name out in)
string(REGEX REPLACE "^${CMAKE_BINARY_DIR}/?" "" in "${in}")
string(REGEX REPLACE "[^0-9a-zA-Z]+" "-" tmp "${in}")
set(${out} ${tmp} PARENT_SCOPE)
endfunction()
function (kdoctools_create_handbook docbook)
# Parse arguments
set(options)
set(oneValueArgs INSTALL_DESTINATION SUBDIR)
set(multiValueArgs)
cmake_parse_arguments(ARGS "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
if(NOT DEFINED ARGS_SUBDIR)
message(FATAL_ERROR "SUBDIR needs to be defined when calling kdoctools_create_handbook")
endif()
# Init vars
get_filename_component(docbook ${docbook} ABSOLUTE)
file(RELATIVE_PATH src_doc ${CMAKE_CURRENT_SOURCE_DIR} ${docbook})
get_filename_component(src_dir ${src_doc} DIRECTORY)
set(build_dir ${CMAKE_CURRENT_BINARY_DIR}/${src_dir})
set(build_doc ${build_dir}/index.cache.bz2)
set(build_html ${build_dir}/index.html)
# current directory is the docbook directory, but if this is empty, the
# globs which finds the docbooks and the images will be empty too as
# they will expand into "/*.docbook" and "/*.png"
if (src_dir STREQUAL "")
set(src_dir ".")
endif ()
# Create some place to store our files
file(MAKE_DIRECTORY ${build_dir})
#Bootstrap
if (_kdoctoolsBootStrapping)
set(_bootstrapOption "--srcdir=${KDocTools_BINARY_DIR}/src")
elseif (CMAKE_CROSSCOMPILING AND CMAKE_SYSTEM_NAME STREQUAL "Windows")
set(_bootstrapOption "--srcdir=${KDOCTOOLS_DATA_INSTALL_DIR}/kdoctools")
else ()
set(_bootstrapOption)
endif ()
set(_ssheet "${KDOCTOOLS_CUSTOMIZATION_DIR}/kde-chunk.xsl")
file(GLOB candidate_src_docs ${src_dir}/*.docbook)
set(src_docs)
foreach (src_single_doc ${candidate_src_docs})
# Exclude manpages
get_filename_component(src_single_doc_name ${src_single_doc} NAME)
if (NOT src_single_doc_name MATCHES "^man-.+\\.docbook$")
list(APPEND src_docs ${src_single_doc})
endif()
endforeach()
add_custom_command(OUTPUT ${build_doc}
COMMAND ${KDOCTOOLS_MEINPROC_EXECUTABLE} --check ${_bootstrapOption} --cache ${build_doc} ${src_doc}
DEPENDS ${src_docs} ${_ssheet}
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
)
_kdoctools_create_target_name(_targ ${build_doc})
add_custom_target(${_targ} ALL DEPENDS ${build_doc})
if(KDOCTOOLS_ENABLE_HTMLHANDBOOK)
add_custom_command(OUTPUT ${build_html}
COMMAND ${KDOCTOOLS_MEINPROC_EXECUTABLE} --check ${_bootstrapOption} -o ${build_html} ${src_doc}
DEPENDS ${src_doc} ${_ssheet}
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
)
_kdoctools_create_target_name(_targ_html ${build_html})
add_custom_target(${_targ_html} ALL DEPENDS ${build_html})
endif(KDOCTOOLS_ENABLE_HTMLHANDBOOK)
set(installDest "${ARGS_INSTALL_DESTINATION}")
if(installDest)
set(subdir "${ARGS_SUBDIR}")
file(GLOB images ${src_dir}/*.png)
install(FILES ${build_doc} ${src_docs} ${images} DESTINATION ${installDest}/${subdir})
if(KDOCTOOLS_ENABLE_HTMLHANDBOOK)
install(FILES ${build_html} DESTINATION ${installDest}/${subdir})
endif(KDOCTOOLS_ENABLE_HTMLHANDBOOK)
endif()
endfunction()
function (kdoctools_create_manpage docbook section)
# Parse arguments
set(options)
set(oneValueArgs INSTALL_DESTINATION)
set(multiValueArgs)
cmake_parse_arguments(ARGS "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
# Init vars
get_filename_component(docbook ${docbook} ABSOLUTE)
file(RELATIVE_PATH src_doc ${CMAKE_CURRENT_SOURCE_DIR} ${docbook})
get_filename_component(src_dir ${src_doc} DIRECTORY)
set(build_dir ${CMAKE_CURRENT_BINARY_DIR}/${src_dir})
get_filename_component(name ${src_doc} NAME)
string(REGEX REPLACE "^man-(.*)\\.${section}\\.docbook$" "\\1" name ${name})
set(build_doc ${build_dir}/${name}.${section})
# Create some place to store our files
file(MAKE_DIRECTORY ${build_dir})
#Bootstrap
if (_kdoctoolsBootStrapping)
set(_bootstrapOption "--srcdir=${KDocTools_BINARY_DIR}/src")
elseif (CMAKE_CROSSCOMPILING AND CMAKE_SYSTEM_NAME STREQUAL "Windows")
set(_bootstrapOption "--srcdir=${KDOCTOOLS_DATA_INSTALL_DIR}/kdoctools")
else ()
set(_bootstrapOption)
endif ()
set(_ssheet "${KDOCTOOLS_CUSTOMIZATION_DIR}/kde-include-man.xsl")
add_custom_command(OUTPUT ${build_doc}
COMMAND ${KDOCTOOLS_MEINPROC_EXECUTABLE} --stylesheet ${_ssheet} --check ${_bootstrapOption} ${CMAKE_CURRENT_SOURCE_DIR}/${src_doc}
DEPENDS ${src_doc} ${_ssheet}
WORKING_DIRECTORY ${build_dir}
)
_kdoctools_create_target_name(_targ ${build_doc})
add_custom_target(${_targ} ALL DEPENDS "${build_doc}")
if(ARGS_INSTALL_DESTINATION)
install(FILES ${build_doc} DESTINATION ${ARGS_INSTALL_DESTINATION}/man${section})
endif()
endfunction()
function(kdoctools_install podir)
file(GLOB lang_dirs "${podir}/*")
if (NOT MAN_INSTALL_DIR)
set(MAN_INSTALL_DIR share/man)
endif()
if (NOT HTML_INSTALL_DIR)
set(HTML_INSTALL_DIR share/doc/HTML)
endif()
foreach(lang_dir ${lang_dirs})
get_filename_component(lang ${lang_dir} NAME)
file(GLOB_RECURSE docbooks "${lang_dir}/docs/*.docbook")
foreach(docbook ${docbooks})
string(REGEX MATCH "\\.([0-9])\\.docbook" match ${docbook})
if (match)
kdoctools_create_manpage(${docbook} ${CMAKE_MATCH_1}
INSTALL_DESTINATION ${MAN_INSTALL_DIR}/${lang}
)
else()
string(REGEX MATCH "docs/(.*)/index.docbook" match ${docbook})
if (match)
kdoctools_create_handbook(${docbook}
INSTALL_DESTINATION ${HTML_INSTALL_DIR}/${lang}
SUBDIR ${CMAKE_MATCH_1}
)
endif()
endif()
endforeach()
endforeach()
endfunction()
|
