annotate cmake/function/IrccdDefineHtml.cmake @ 76:7e9a1faeb6f6

CMake: temporarily disable CMake export as it requires Ph.D
author David Demelier <markand@malikania.fr>
date Wed, 30 Mar 2016 14:17:23 +0200
parents b3e0050463bf
children 113d909fdfe1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 # IrccdDefineHtml.cmake -- CMake build system for irccd
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 # Copyright (c) 2013-2016 David Demelier <markand@malikania.fr>
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 # Permission to use, copy, modify, and/or distribute this software for any
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 # purpose with or without fee is hereby granted, provided that the above
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 # copyright notice and this permission notice appear in all copies.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 # irccd_define_html
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 # -------------------------------------------------------------------
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 # irccd_define_html(
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 # SOURCES the source files
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 # DIRECTORY the base directory relative to the WITH_DOCDIR
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 # TARGET the target name
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 # VARS (Optional) variables to pass
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 # )
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 # This first signature processes all files and compile them one per one. Files are placed in the same hierarchy where
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 # the function is invoked.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 # irccd_define_html(
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 # SOURCES the source files
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 # OUTPUT the output file
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 # TARGET the target name
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 # VARS (Optional) variables to pass
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 # )
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 # This second signature generated only one file from all sources. Usually for a book, guide and such.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 # Note: do not pass an absolute path for the output.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 function(irccd_define_html)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 set(options)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 set(oneValueArgs DIRECTORY OUTPUT TARGET)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 set(multiValueArgs ARGS SOURCES)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 cmake_parse_arguments(HTML "" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
51
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 # Required arguments
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 if (NOT HTML_SOURCES)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 message(FATAL_ERROR "Please specify source files")
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 endif ()
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 if (NOT HTML_TARGET)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 message(FATAL_ERROR "Please specify a target")
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 endif ()
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
59
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 if (IRCCD_RELOCATABLE)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 set(base ${CMAKE_BINARY_DIR}/fakeroot/${WITH_DOCDIR})
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 else ()
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 set(base ${CMAKE_BINARY_DIR}/docs)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 endif ()
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
65
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 if (HTML_OUTPUT)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 # First signature.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 if (IS_ABSOLUTE)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 message(FATAL_ERROR "Do not pass absolute path for OUTPUT")
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 endif ()
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
73
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 get_filename_component(directory ${base}/${HTML_OUTPUT} DIRECTORY)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 file(RELATIVE_PATH baseurl ${directory} ${base})
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
76
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
77 if (baseurl STREQUAL "")
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 set(baseurl "./")
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 endif ()
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
80
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 # Configure sources
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 foreach (s ${HTML_SOURCES})
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 file(RELATIVE_PATH basepath ${CMAKE_CURRENT_SOURCE_DIR} ${s})
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 configure_file(${s} ${CMAKE_CURRENT_BINARY_DIR}/${basepath} @ONLY)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 list(APPEND REAL_SOURCES ${CMAKE_CURRENT_BINARY_DIR}/${basepath})
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 endforeach ()
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
87
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 pandoc(
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 OUTPUT ${base}/${HTML_OUTPUT}
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 TARGET ${HTML_TARGET}
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 SOURCES ${REAL_SOURCES}
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
92 TEMPLATE ${resources_SOURCE_DIR}/template.html
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
93 DEPENDS
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 ${resources_SOURCE_DIR}/template.html
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
95 docs-resources
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 ARGS ${HTML_ARGS}
39
b3e0050463bf Docs: remove irccd-web related stuff
David Demelier <markand@malikania.fr>
parents: 6
diff changeset
97 VARIABLE baseurl:${baseurl}
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
98 FROM markdown TO html5
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
99 STANTALONE MAKE_DIRECTORY
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
100 )
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
101
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
102 install(
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
103 FILES ${base}/${HTML_OUTPUT}
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
104 DESTINATION ${WITH_DOCDIR}
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
105 )
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
106 else ()
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
107 if (NOT HTML_DIRECTORY)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
108 message(FATAL_ERROR "Please specify the directory")
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
109 endif ()
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
110
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
111 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
112 # Second signature.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
113 #
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
114 foreach (s ${HTML_SOURCES})
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
115 file(RELATIVE_PATH input ${CMAKE_CURRENT_SOURCE_DIR} ${s})
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
116 string(REGEX REPLACE "^(.*)\\.md$" "\\1.html" filename ${input})
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 get_filename_component(directory ${base}/${HTML_DIRECTORY}/${filename} DIRECTORY)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
118 file(RELATIVE_PATH baseurl ${directory} ${base})
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
119 file(RELATIVE_PATH basepath ${CMAKE_CURRENT_SOURCE_DIR} ${s})
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
120 list(APPEND outputs ${base}/${HTML_DIRECTORY}/${filename})
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
121 configure_file(${s} ${CMAKE_CURRENT_BINARY_DIR}/${basepath} @ONLY)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
122
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
123 pandoc(
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
124 OUTPUT ${base}/${HTML_DIRECTORY}/${filename}
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
125 SOURCES ${CMAKE_CURRENT_BINARY_DIR}/${basepath}
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
126 TEMPLATE ${resources_SOURCE_DIR}/template.html
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
127 DEPENDS
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
128 ${resources_SOURCE_DIR}/template.html
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
129 docs-resources
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
130 ARGS ${HTML_ARGS}
39
b3e0050463bf Docs: remove irccd-web related stuff
David Demelier <markand@malikania.fr>
parents: 6
diff changeset
131 VARIABLE baseurl:${baseurl}
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
132 FROM markdown TO html5
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
133 STANTALONE MAKE_DIRECTORY
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
134 )
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
135 endforeach ()
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
136
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
137 add_custom_target(
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
138 ${HTML_TARGET}
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
139 DEPENDS ${outputs}
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
140 SOURCES ${HTML_SOURCES}
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
141 )
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
142
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
143 install(
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
144 DIRECTORY ${base}/${HTML_DIRECTORY}
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
145 DESTINATION ${WITH_DOCDIR}
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
146 )
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
147 endif ()
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
148
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
149 add_dependencies(docs ${HTML_TARGET})
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
150 endfunction()