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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
|
cmake_minimum_required(VERSION 3.5)
project(swipl-doc-core)
include(Documentation)
set(DOC SWI-Prolog-${SWIPL_VERSION_STRING})
# Libraries documented in .doc files
set(DOC_LIB assoc.tex broadcast.tex clpb.tex clpfd.tex clpqr.tex gensym.tex
library.tex libsummary.tex nbset.tex pio.tex predicateoptions.tex
record.tex registry.tex ugraphs.tex wwwbrowser.tex)
if(GMP_FOUND)
set(DOC_LIB ${DOC_LIB} simplex.tex)
endif()
prepend(DOC_LIB lib/ ${DOC_LIB})
set(FIGS broadcast by-sa profnode swipl xrefchatdep xrefchatfile)
# Main files
set(DOC_CORE abstract.tex intro.tex overview.tex builtin.tex module.tex
foreign.tex runtime.tex hack.tex summary.tex xpce.tex glossary.tex
ide.tex license.tex threads.tex engines.tex profile.tex
attvar.tex chr.tex xref.tex bit64.tex dialect.tex extensions.tex
tabling.tex)
set(STYFILES html.sty txt.sty)
# FIXME: we should reduce dependencies
add_custom_command(
OUTPUT ${PLDOC2TEX_STATE}
COMMAND ${PROG_SWIPL} -f none --no-packs -o ${PLDOC2TEX_STATE}
--class=development --no-autoload --no-stand_alone
-c ${CMAKE_CURRENT_SOURCE_DIR}/pldoc2tex.pl
-- --nopce
DEPENDS pldoc2tex.pl swipl core prolog_home
pldoc clib sgml http nlp)
add_custom_target(
pldoc2tex_state
DEPENDS ${PLDOC2TEX_STATE})
function(copy_file file)
add_custom_command(
OUTPUT ${file}
COMMAND ${CMAKE_COMMAND} -E copy_if_different
${CMAKE_CURRENT_SOURCE_DIR}/${file} ${file})
set(cpfiles ${cpfiles} ${file} PARENT_SCOPE)
endfunction()
function(copy_figures)
foreach(f ${ARGN})
if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/figs/${f}.pdf)
copy_file(figs/${f}.pdf)
endif()
if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/figs/${f}.png)
copy_file(figs/${f}.png)
endif()
endforeach()
set(cpfiles ${cpfiles} ${file} PARENT_SCOPE)
endfunction()
function(doc2tex)
foreach(f ${ARGN})
string(REGEX REPLACE "\\.tex" ".doc" docin ${f})
get_filename_component(dir ${f} DIRECTORY)
if(dir)
add_custom_command(
OUTPUT ${f}
COMMAND ${CMAKE_COMMAND} -E make_directory ${dir}
COMMAND ${PROG_SWIPL} -f none --no-packs ${DOC2TEX} ${CMAKE_CURRENT_SOURCE_DIR}/${docin} ${f}
DEPENDS ${docin} ${DOC2TEX_DEPENDS})
else()
add_custom_command(
OUTPUT ${f}
COMMAND ${PROG_SWIPL} -f none --no-packs ${DOC2TEX} ${CMAKE_CURRENT_SOURCE_DIR}/${docin} ${f}
DEPENDS ${docin} ${DOC2TEX_DEPENDS})
endif()
endforeach()
endfunction()
doc2tex(${DOC_CORE})
# pldoc(tex input
# [OPTIONS ...]
# [DEPENDS ...]
set(PLDOC_LIB)
function(pldoc tex input)
set(options
--source=${CMAKE_CURRENT_SOURCE_DIR}
--summaries
--out=${tex})
set(depends ${PLDOC2TEX_DEPENDS})
set(byproducts)
set(PLDOC_LIB ${PLDOC_LIB} ${tex} PARENT_SCOPE)
if(input MATCHES "^library")
string(REGEX REPLACE "library\\((.*)\\)" "\\1" base ${input})
set(depends "../library/${base}.pl")
endif()
get_filename_component(base ${tex} NAME_WE)
set(byproducts lib/summaries.d/${base}.tex)
foreach(arg ${ARGN})
if(arg MATCHES "^--")
set(options ${options} ${arg})
elseif(arg STREQUAL "DEPENDS")
elseif(arg STREQUAL "OPTIONS")
else()
set(depends ${depends} ${arg})
endif()
endforeach()
add_custom_command(
OUTPUT ${tex}
COMMAND ${PROG_SWIPL} -f none --no-packs ${PLDOC2TEX} ${options} "'${input}'"
DEPENDS ${depends}
BYPRODUCTS ${byproducts})
endfunction()
function(libdoc lib)
string(REGEX REPLACE "_" "" texf ${lib})
pldoc(lib/${texf}.tex "library(${lib})" ${ARGN})
set(PLDOC_LIB ${PLDOC_LIB} PARENT_SCOPE)
endfunction()
function(libsdoc)
foreach(lib ${ARGN})
libdoc(${lib})
endforeach()
set(PLDOC_LIB ${PLDOC_LIB} PARENT_SCOPE)
endfunction()
has_package(ssl HAVE_SSL_PACKAGE)
has_package(archive HAVE_ARCHIVE_PACKAGE)
if(HAVE_SSL_PACKAGE)
set(doc_depends_ssl ${doc_depends_ssl} ssl)
endif()
if(HAVE_ARCHIVE_PACKAGE)
set(doc_depends_ssl ${doc_depends_ssl} archive)
endif()
# Specify how to generate tex files from PlDoc
# NOTE: all files must be included from lib/library.doc and
# NOTE: lib/libsummary.doc
libsdoc(apply dicts error url pairs option optparse ordsets aggregate
thread_pool charsio debug csv lists main check random varnumbers
quasi_quotations solution_sequences iostream persistency yall
settings occurs ansi_term readutil prolog_xref intercept thread
prolog_jiti tables listing)
libdoc(shlib --subsection)
libdoc(pure_input --subsection)
libdoc(explain --subsection)
pldoc(lib/prologpack.tex "library(prolog_pack)"
OPTIONS --section DEPENDS ${doc_depends_ssl})
pldoc(lib/assoclib.tex lib/assoclib.md
OPTIONS --lib=assoc --module=assoc
DEPENDS lib/assoclib.md ../library/assoc.pl)
pldoc(lib/clpblib.tex lib/clpblib.md
OPTIONS --lib=clpb --module=clpb
DEPENDS lib/clpblib.md ../library/clp/clpb.pl)
pldoc(lib/clpfdlib.tex lib/clpfdlib.md
OPTIONS --lib=clpfd --module=clpfd
DEPENDS lib/clpfdlib.md ../library/clp/clpfd.pl)
if(GMP_FOUND)
pldoc(lib/simplexlib.tex lib/simplexlib.md
OPTIONS --lib=simplex --module=simplex
DEPENDS lib/simplexlib.md ../library/clp/simplex.pl)
endif()
pldoc(lib/predopts.tex lib/predopts.txt
OPTIONS --lib=predicate_options
DEPENDS lib/predopts.txt ../library/predicate_options.pl)
pldoc(lib/help.tex "library(help)"
OPTIONS --subsection
DEPENDS nlp)
pldoc(lib/dcgbasics.tex "library(dcg/basics)")
pldoc(lib/dcghighorder.tex "library(dcg/high_order)")
# Check that we do not have both a .doc file and extract from the
# Prolog source
foreach(f ${PLDOC_LIB})
string(REGEX REPLACE "\\.tex" ".doc" docin ${f})
if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${docin})
message("WARNING: DOC file for ${f}")
endif()
endforeach()
doc2tex(${DOC_LIB})
# Create SWI-Prolog-<version>.tex
add_custom_command(
OUTPUT ${DOC}.doc
COMMAND ${PROG_SWIPL} -f none --no-packs ${CMAKE_CURRENT_SOURCE_DIR}/select.pl PDF
${CMAKE_CURRENT_SOURCE_DIR}/main.doc > ${DOC}.doc
DEPENDS main.doc select.pl)
add_custom_command(
OUTPUT ${DOC}.tex
COMMAND ${PROG_SWIPL} -f none --no-packs ${DOC2TEX} ${DOC}.doc ${DOC}.tex
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${DOC}.doc ${DOC2TEX_DEPENDS})
set(BIBTEX_DATA ${CMAKE_CURRENT_BINARY_DIR}/pl.bib)
add_custom_command(
OUTPUT pl.bib
COMMAND ${CMAKE_COMMAND} -E copy_if_different
${CMAKE_CURRENT_SOURCE_DIR}/pl.bib .
DEPENDS pl.bib)
# Collect all input files
prepend(TEXFILES ${CMAKE_CURRENT_BINARY_DIR}/
${DOC}.tex ${DOC_CORE} ${DOC_LIB} ${PLDOC_LIB})
# Collect LaTeX aux files
string(REPLACE ".tex" ".aux" AUX_FILES "${DOC_CORE}")
tex_byproducts(${DOC} TEX_BYPRODUCTS)
set(CLEAN_FILES ${AUX_FILES} ${TEX_BYPRODUCTS})
SET_DIRECTORY_PROPERTIES(PROPERTIES
ADDITIONAL_MAKE_CLEAN_FILES "${CLEAN_FILES}")
# Demand copied files (figures, etc)
set(cpfiles)
copy_figures(${FIGS})
if(BUILD_PDF_DOCUMENTATION)
add_custom_command(
OUTPUT ${DOC}.pdf ${DOC}.bbl
COMMAND env TEXINPUTS=lib:$$TEXINPUTS ${RUNTEX} --pdf ${DOC}
DEPENDS ${TEXFILES} ${BIBTEX_DATA} ${cpfiles} prolog_home
COMMENT "Generating ${DOC}.pdf")
else()
add_custom_command(
OUTPUT ${DOC}.bbl
COMMAND ${CMAKE_COMMAND} -E copy_if_different
${CMAKE_CURRENT_SOURCE_DIR}/gen/swipl.bbl ${DOC}.bbl
COMMENT "Copying pre-build LaTeX .bbl file")
endif()
# Create the HTML manual
prepend(cpfiles ${CMAKE_CURRENT_BINARY_DIR}/ ${cpfiles})
add_custom_command(
OUTPUT manual.html
COMMAND rm -f Manual/*.html Manual/*.gif
COMMAND ${PROG_SWIPL} -f none --no-packs ${LATEX2HTML} --texinputs=lib:: ${DOC}
COMMAND ${CMAKE_COMMAND} -E remove ${MAN_INDEX}
COMMAND touch manual.html
COMMENT "Generating HTML documentation for core system"
DEPENDS ${TEXFILES} ${CMAKE_CURRENT_BINARY_DIR}/${DOC}.bbl ${cpfiles}
core latex2html)
################
# Windows and MacOS platform guides
if(WIN32)
doc2tex(windows.tex)
add_custom_command(
OUTPUT windows.html
COMMAND ${PROG_SWIPL} -f none --no-packs ${LATEX2HTML} windows
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/windows.tex
core latex2html)
add_custom_target(
core.doc.windows.html
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/windows.html)
endif()
if(APPLE)
add_custom_command(
OUTPUT macosx/macosx.tex
COMMAND ${CMAKE_COMMAND} -E make_directory macosx
COMMAND ${PROG_SWIPL} -f none --no-packs ${DOC2TEX} ${CMAKE_CURRENT_SOURCE_DIR}/macosx/macosx.doc
macosx/macosx.tex
DEPENDS macosx/macosx.doc ${DOC2TEX_DEPENDS})
add_custom_command(
OUTPUT macosx/macosx.html
COMMAND ${PROG_SWIPL} -f none --no-packs ${LATEX2HTML} macosx
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/macosx/macosx.tex
core latex2html
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/macosx)
add_custom_target(
core.doc.macosx.html
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/macosx/macosx.html)
if(BUILD_MACOS_BUNDLE)
add_dependencies(doc core.doc.macosx.html)
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/macosx/macosx.html
DESTINATION ${SWIPL_INSTALL_RESOURCES})
endif()
endif(APPLE)
if(INSTALL_DOCUMENTATION)
add_custom_target(
core.doc.html
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/manual.html)
add_dependencies(doc.html core.doc.html)
if(BUILD_PDF_DOCUMENTATION)
add_custom_target(
core.doc.pdf
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${DOC}.pdf)
add_dependencies(doc.pdf core.doc.pdf)
endif()
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/Manual
DESTINATION ${SWIPL_INSTALL_DOC})
endif(INSTALL_DOCUMENTATION)
|
