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 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
|
set(SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR}/src)
set(SRC_REFMAN_DIR ${CMAKE_CURRENT_SOURCE_DIR}/src/refman)
# Put these in the order that they should appear in the Info or PDF manual.
set(PAGES
getting_started
config
display
events
file
fixed
fshook
fullscreen_mode
graphics
haptic
joystick
keyboard
memory
misc
monitor
mouse
path
state
system
threads
time
timer
touch
transformations
utf8
platform
direct3d
opengl
audio
acodec
color
font
image
main
memfile
native_dialog
physfs
primitives
shader
video
)
set(PAGES_TXT)
foreach(page ${PAGES})
list(APPEND PAGES_TXT ${SRC_REFMAN_DIR}/${page}.txt)
endforeach(page)
set(TITLE_TXT ${SRC_REFMAN_DIR}/title.txt)
set(IMAGES
primitives1
primitives2
LINE_CAP
LINE_JOIN
audio
)
#-----------------------------------------------------------------------------#
#
# Paths
#
#-----------------------------------------------------------------------------#
set(HTML_DIR ${CMAKE_CURRENT_BINARY_DIR}/html/refman)
set(MAN_DIR ${CMAKE_CURRENT_BINARY_DIR}/man)
set(INFO_DIR ${CMAKE_CURRENT_BINARY_DIR}/info)
set(TEXI_DIR ${CMAKE_CURRENT_BINARY_DIR}/texi)
set(LATEX_DIR ${CMAKE_CURRENT_BINARY_DIR}/latex)
set(PDF_DIR ${CMAKE_CURRENT_BINARY_DIR}/pdf)
set(PROTOS ${CMAKE_CURRENT_BINARY_DIR}/protos)
set(API_EXAMPLES ${CMAKE_CURRENT_BINARY_DIR}/examples)
set(PROTOS_TIMESTAMP ${PROTOS}.timestamp)
set(EXAMPLES_DIR ${CMAKE_SOURCE_DIR}/examples)
set(HTML_REFS ${CMAKE_CURRENT_BINARY_DIR}/html_refs)
set(HTML_REFS_TIMESTAMP ${HTML_REFS}.timestamp)
set(INDEX_ALL ${CMAKE_CURRENT_BINARY_DIR}/index_all.txt)
set(SEARCH_INDEX_JS ${HTML_DIR}/search_index.js)
set(SCRIPT_DIR ${CMAKE_SOURCE_DIR}/docs/scripts)
set(MAKE_PROTOS ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/make_protos)
set(MAKE_HTML_REFS ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/make_html_refs)
set(MAKE_INDEX ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/make_index)
set(SCAN_EXAMPLES ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/scan_examples)
set(MAKE_DOC ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/make_doc
--pandoc "${PANDOC}"
--protos ${PROTOS}
--allegro5_cfg ${CMAKE_SOURCE_DIR}/allegro5.cfg
--git_ref ${REAL_DOC_GIT_REF})
set(INSERT_TIMESTAMP ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/insert_timestamp)
set(MAKE_SEARCH_INDEX ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/make_search_index)
set(DAWK_SOURCES scripts/aatree.c scripts/dawk.c scripts/trex.c)
add_executable(make_protos scripts/make_protos.c ${DAWK_SOURCES})
add_executable(make_html_refs scripts/make_html_refs.c ${DAWK_SOURCES})
add_executable(make_index scripts/make_index.c ${DAWK_SOURCES})
add_executable(make_doc
scripts/make_doc.c
scripts/make_man.c
scripts/make_single.c
${DAWK_SOURCES})
add_executable(insert_timestamp
scripts/insert_timestamp.c
${DAWK_SOURCES})
add_executable(make_search_index scripts/make_search_index.c ${DAWK_SOURCES})
add_executable(scan_examples scripts/scan_examples.c ${DAWK_SOURCES})
#-----------------------------------------------------------------------------#
#
# Protos
#
#-----------------------------------------------------------------------------#
# The protos file is a list of function prototypes and type declarations
# which can then be embedded into the documentation.
# Rebuilding the documentation whenever a source file changes is irritating,
# especially as public prototypes rarely change. Thus we keep a second file
# called protos.timestamp which reflects the last time that the protos file
# changed. We declare _that_ file as the dependency of other targets.
# We can get into a situation where the protos file is newer than the source
# files (up-to-date) but the protos.timestamp is older than the source files.
# If the protos and protos.timestamp files are identical then each time
# you run make, it will compare them and find them equal, so protos.timestamp
# won't be updated. However that check is instantaneous.
# ALL_SRCS is split into multiple lists, otherwise the make_protos command
# line is too long for Windows >:-( We use relative paths for the same reason.
file(GLOB_RECURSE ALL_SRCS1
${CMAKE_SOURCE_DIR}/src/*.[chm]
${CMAKE_SOURCE_DIR}/src/*.[ch]pp
)
file(GLOB_RECURSE ALL_SRCS2
${CMAKE_SOURCE_DIR}/include/*.h
${CMAKE_SOURCE_DIR}/include/*.inl
)
file(GLOB_RECURSE ALL_SRCS3
${CMAKE_SOURCE_DIR}/addons/*.[chm]
${CMAKE_SOURCE_DIR}/addons/*.[ch]pp
)
foreach(x ${ALL_SRCS1})
file(RELATIVE_PATH xrel ${CMAKE_SOURCE_DIR} ${x})
list(APPEND ALL_SRCS1_REL ${xrel})
endforeach()
foreach(x ${ALL_SRCS2})
file(RELATIVE_PATH xrel ${CMAKE_SOURCE_DIR} ${x})
list(APPEND ALL_SRCS2_REL ${xrel})
endforeach()
foreach(x ${ALL_SRCS3})
file(RELATIVE_PATH xrel ${CMAKE_SOURCE_DIR} ${x})
list(APPEND ALL_SRCS3_REL ${xrel})
endforeach()
add_custom_command(
OUTPUT ${PROTOS}
DEPENDS ${ALL_SRCS1} ${ALL_SRCS2} ${ALL_SRCS3} make_protos
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
COMMAND ${MAKE_PROTOS} ${ALL_SRCS1_REL} > ${PROTOS}
COMMAND ${MAKE_PROTOS} ${ALL_SRCS2_REL} >> ${PROTOS}
COMMAND ${MAKE_PROTOS} ${ALL_SRCS3_REL} >> ${PROTOS}
)
add_custom_command(
OUTPUT ${PROTOS_TIMESTAMP}
DEPENDS ${PROTOS}
COMMAND ${CMAKE_COMMAND} -E copy_if_different ${PROTOS} ${PROTOS_TIMESTAMP}
)
# For testing (command line too long for Windows)
if(NOT WIN32)
add_custom_target(gen_protos DEPENDS ${PROTOS})
endif()
#-----------------------------------------------------------------------------#
#
# API Examples
#
#-----------------------------------------------------------------------------#
# Build a list of all the API entries. Then cross-reference these against
# which of the example files make use of them.
set(RESP ${CMAKE_CURRENT_BINARY_DIR}/ex_files)
file(GLOB EXAMPLE_FILES
${EXAMPLES_DIR}/*.c
${EXAMPLES_DIR}/*.cpp)
file(GLOB EXAMPLE_FILES_REL
RELATIVE ${CMAKE_SOURCE_DIR}
${EXAMPLES_DIR}/*.c
${EXAMPLES_DIR}/*.cpp)
foreach(f IN LISTS EXAMPLE_FILES_REL)
string(APPEND multiline "${f}\n")
endforeach()
file(WRITE ${RESP} "${multiline}")
add_custom_command(
OUTPUT ${API_EXAMPLES}
DEPENDS ${PROTOS}
${EXAMPLE_FILES}
${SCAN_EXAMPLES}
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
COMMAND ${SCAN_EXAMPLES} --protos ${PROTOS} "@${RESP}" > ${API_EXAMPLES}.t
COMMAND ${CMAKE_COMMAND} -E copy_if_different ${API_EXAMPLES}.t ${API_EXAMPLES})
#-----------------------------------------------------------------------------#
#
# HTML
#
#-----------------------------------------------------------------------------#
# The html_refs file contains link definitions for each API entry.
# It's used to resolve references across HTML pages.
# The search_index.js file contains definitions for the autosuggest widget.
add_custom_command(
OUTPUT ${HTML_REFS}
DEPENDS ${PAGES_TXT} make_html_refs
COMMAND ${MAKE_HTML_REFS} ${PAGES_TXT} > ${HTML_REFS}
)
add_custom_command(
OUTPUT ${HTML_REFS_TIMESTAMP}
DEPENDS ${HTML_REFS}
COMMAND ${CMAKE_COMMAND} -E copy_if_different
${HTML_REFS} ${HTML_REFS_TIMESTAMP}
)
add_custom_command(
OUTPUT ${INDEX_ALL}
DEPENDS ${HTML_REFS_TIMESTAMP} make_index
COMMAND ${MAKE_INDEX} ${HTML_REFS} > ${INDEX_ALL}
)
add_custom_command(
OUTPUT ${SEARCH_INDEX_JS}
DEPENDS ${HTML_REFS_TIMESTAMP} make_search_index
COMMAND ${MAKE_SEARCH_INDEX} ${HTML_REFS} > ${SEARCH_INDEX_JS}
)
if(WANT_DOCS_HTML)
foreach(inc inc.a inc.z)
add_custom_command(
OUTPUT ${inc}.html
DEPENDS ${SRC_REFMAN_DIR}/${inc}.txt
COMMAND ${PANDOC} ${SRC_REFMAN_DIR}/${inc}.txt --from markdown -o ${inc}.html
)
endforeach(inc)
set(HTML_PAGES)
foreach(page ${PAGES} index index_all)
if(page STREQUAL "index_all")
set(page_src ${INDEX_ALL})
else()
set(page_src ${SRC_REFMAN_DIR}/${page}.txt)
endif()
add_custom_command(
OUTPUT ${HTML_DIR}/${page}.html
DEPENDS
${PROTOS_TIMESTAMP}
${HTML_REFS_TIMESTAMP}
${page_src}
${CMAKE_CURRENT_BINARY_DIR}/inc.a.html
${CMAKE_CURRENT_BINARY_DIR}/inc.z.html
${SEARCH_INDEX_JS}
${API_EXAMPLES}
make_doc
insert_timestamp
COMMAND
${INSERT_TIMESTAMP} ${CMAKE_SOURCE_DIR}/include/allegro5/base.h > inc.timestamp.html
COMMAND
${MAKE_DOC}
--examples ${API_EXAMPLES}
--to html
--raise-sections
--include-before-body inc.a.html
--include-after-body inc.timestamp.html
--include-after-body inc.z.html
--css pandoc.css
--include-in-header ${SRC_DIR}/custom_header.html
--standalone
--toc
-- ${page_src} ${HTML_REFS}
> ${HTML_DIR}/${page}.html
)
list(APPEND HTML_PAGES ${HTML_DIR}/${page}.html)
endforeach(page)
set(HTML_IMAGES)
foreach(image ${IMAGES})
add_custom_command(
OUTPUT ${HTML_DIR}/images/${image}.png
DEPENDS
${SRC_REFMAN_DIR}/images/${image}.png
COMMAND
"${CMAKE_COMMAND}" -E copy
"${SRC_REFMAN_DIR}/images/${image}.png" "${HTML_DIR}/images/${image}.png"
)
list(APPEND HTML_IMAGES ${HTML_DIR}/images/${image}.png)
endforeach(image)
add_custom_target(html ALL DEPENDS ${HTML_PAGES} ${HTML_IMAGES})
foreach(file pandoc.css autosuggest.js)
configure_file(
${SRC_DIR}/${file}
${HTML_DIR}/${file}
COPYONLY)
endforeach(file)
endif(WANT_DOCS_HTML)
#-----------------------------------------------------------------------------#
#
# Man pages
#
#-----------------------------------------------------------------------------#
set(MANDIR "man" CACHE STRING "Install man pages into this directory")
if(WANT_DOCS_MAN)
make_directory(${MAN_DIR})
set(MAN_PAGES)
foreach(page ${PAGES_TXT})
# Figure out the man pages that would be generated from this file.
file(STRINGS ${page} lines REGEX "# API: ")
if(lines)
string(REGEX REPLACE "[#]* API: " ";" entries ${lines})
set(outputs)
foreach(entry ${entries})
list(APPEND outputs ${MAN_DIR}/${entry}.3alleg5)
endforeach(entry)
add_custom_command(
OUTPUT ${outputs}
DEPENDS ${PROTOS_TIMESTAMP} ${page} make_doc
COMMAND ${MAKE_DOC} --to man -- ${page}
WORKING_DIRECTORY ${MAN_DIR}
)
list(APPEND MAN_PAGES ${outputs})
endif(lines)
endforeach(page)
add_custom_target(man ALL DEPENDS ${MAN_PAGES})
install(FILES ${MAN_PAGES}
DESTINATION ${MANDIR}/man3
)
endif(WANT_DOCS_MAN)
#-----------------------------------------------------------------------------#
#
# Info
#
#-----------------------------------------------------------------------------#
if(WANT_DOCS_INFO AND MAKEINFO)
make_directory(${INFO_DIR})
make_directory(${TEXI_DIR})
add_custom_target(info ALL DEPENDS ${INFO_DIR}/refman.info)
add_custom_command(
OUTPUT ${INFO_DIR}/refman.info
DEPENDS ${TEXI_DIR}/refman.texi
COMMAND ${MAKEINFO}
--paragraph-indent 0
--no-split
${TEXI_DIR}/refman.texi
-o ${INFO_DIR}/refman.info
)
add_custom_command(
OUTPUT ${TEXI_DIR}/refman.texi
DEPENDS ${PROTOS_TIMESTAMP} ${TITLE_TXT} ${PAGES_TXT}
make_doc
COMMAND ${MAKE_DOC}
--to texinfo
--standalone
--
${TITLE_TXT} ${PAGES_TXT}
> ${TEXI_DIR}/refman.texi
)
else()
if(WANT_DOCS_INFO)
message("Info documentation requires makeinfo")
endif(WANT_DOCS_INFO)
endif(WANT_DOCS_INFO AND MAKEINFO)
#-----------------------------------------------------------------------------#
#
# LaTeX (PDF)
#
#-----------------------------------------------------------------------------#
set(MAKE_PDF ${WANT_DOCS_PDF})
if(WANT_DOCS_PDF AND NOT PDFLATEX_COMPILER)
set(MAKE_PDF 0)
message("PDF generation requires pdflatex")
endif()
if(MAKE_PDF)
add_custom_target(latex ALL DEPENDS ${LATEX_DIR}/refman.tex)
add_custom_command(
OUTPUT ${LATEX_DIR}/refman.tex
DEPENDS ${PROTOS_TIMESTAMP}
${TITLE_TXT}
${PAGES_TXT}
${LATEX_DIR}/allegro_version.tex
${SRC_REFMAN_DIR}/latex.template
make_doc
COMMAND ${MAKE_DOC}
--to latex
--top-level-division=chapter
--template ${SRC_REFMAN_DIR}/latex.template
--standalone
--toc
--number-sections
-- ${TITLE_TXT} ${PAGES_TXT}
> ${LATEX_DIR}/refman.tex
)
set(PDF_IMAGES)
foreach(image ${IMAGES})
add_custom_command(
OUTPUT ${LATEX_DIR}/images/${image}.png
DEPENDS ${SRC_REFMAN_DIR}/images/${image}.png
COMMAND "${CMAKE_COMMAND}" -E copy
"${SRC_REFMAN_DIR}/images/${image}.png" "${LATEX_DIR}/images/${image}.png"
)
list(APPEND PDF_IMAGES ${LATEX_DIR}/images/${image}.png)
endforeach(image)
make_directory(${PDF_DIR})
add_custom_target(pdf ALL DEPENDS ${PDF_DIR}/refman.pdf)
add_custom_command(
OUTPUT ${PDF_DIR}/refman.pdf
DEPENDS ${LATEX_DIR}/refman.tex
DEPENDS ${PDF_IMAGES}
# Repeat three times to get cross references correct.
COMMAND "${CMAKE_COMMAND}" -E chdir ${LATEX_DIR} ${PDFLATEX_COMPILER} -interaction nonstopmode -output-directory ${PDF_DIR} ${LATEX_DIR}/refman.tex
COMMAND "${CMAKE_COMMAND}" -E chdir ${LATEX_DIR} ${PDFLATEX_COMPILER} -interaction nonstopmode -output-directory ${PDF_DIR} ${LATEX_DIR}/refman.tex
COMMAND "${CMAKE_COMMAND}" -E chdir ${LATEX_DIR} ${PDFLATEX_COMPILER} -interaction nonstopmode -output-directory ${PDF_DIR} ${LATEX_DIR}/refman.tex
)
endif(MAKE_PDF)
#-----------------------------------------------------------------------------#
#
# Tags file
#
#-----------------------------------------------------------------------------#
if(CTAGS)
add_custom_target(gen_tags DEPENDS tags)
add_custom_command(
OUTPUT tags
DEPENDS ${PAGES_TXT}
COMMAND ${CTAGS}
--langdef=allegrodoc
--langmap=allegrodoc:.txt
"--regex-allegrodoc=/^#+ API: (.+)/\\1/"
${PAGES_TXT}
VERBATIM
)
endif(CTAGS)
#-----------------------------------------------------------------------------#
#
# Consistency check
#
#-----------------------------------------------------------------------------#
add_custom_target(check_consistency
DEPENDS ${PROTOS}
COMMAND ${SH} ${SCRIPT_DIR}/check_consistency --protos ${PROTOS}
${PAGES_TXT}
)
#-----------------------------------------------------------------------------#
# vim: set sts=4 sw=4 et:
|