summaryrefslogtreecommitdiff
path: root/cmake/modules/FindASCIIDOC.cmake
blob: 31fbb71fd317aedee81451936d5667b0f7cf04bf (plain)
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
#
# - Find unix commands from cygwin
# This module looks for some usual Unix commands.
#

INCLUDE(FindCygwin)

FIND_PROGRAM(A2X_EXECUTABLE
    NAMES
        a2x
    PATHS
        ${CYGWIN_INSTALL_PATH}/bin
        /bin
        /usr/bin
        /usr/local/bin
        /sbin
)

string( TOLOWER "${CYGWIN_INSTALL_PATH}" l_cyg_path)
string( TOLOWER "${A2X_EXECUTABLE}" l_a2x_ex)
if (NOT "${CYGWIN_INSTALL_PATH}" STREQUAL "" AND "${l_a2x_ex}" MATCHES "${l_cyg_path}")
    message(STATUS "Using Cygwin a2x")
    # We have most likely found a symlink to a2x.py. This won't work from the Windows shell.
    FIND_PROGRAM(CYGPATH_EXECUTABLE
        NAMES cygpath
        PATHS ${CYGWIN_INSTALL_PATH}/bin
    )

    MACRO( TO_A2X_COMPATIBLE_PATH _cmake_path _result )
        execute_process(
            COMMAND ${CYGPATH_EXECUTABLE} -u ${_cmake_path}
            OUTPUT_VARIABLE _cygwin_path
        )
        # cygpath adds a linefeed.
        string(STRIP "${_cygwin_path}" _cygwin_path)

        set( ${_result} ${_cygwin_path} )
    ENDMACRO()

    TO_A2X_COMPATIBLE_PATH( ${CMAKE_SOURCE_DIR}/tools/runa2x.sh RUNA2X_CYGWIN_PATH )

    # It's difficult or impossible to call /usr/bin/a2x directly from
    # Windows because:
    # - /usr/bin/a2x, which is a symlink to /usr/bin/a2x.py.
    # - We need to set environment variables (LC_ALL, PATH, TZ, PYTHONHOME)
    # so we use a wrapper script.
    set( RUNA2X ${SH_EXECUTABLE} ${RUNA2X_CYGWIN_PATH} )
else()
    # Make sure we don't get language specific quotes
    set( RUNA2X LC_ALL=C TZ=UTC ${A2X_EXECUTABLE} )

    MACRO( TO_A2X_COMPATIBLE_PATH _cmake_path _result )
        set( ${_result} ${_cmake_path} )
    ENDMACRO()
endif()

# Handle the QUIETLY and REQUIRED arguments and set ASCIIDOC_FOUND to TRUE if
# all listed variables are TRUE
INCLUDE(FindPackageHandleStandardArgs)
FIND_PACKAGE_HANDLE_STANDARD_ARGS(ASCIIDOC DEFAULT_MSG RUNA2X)

MARK_AS_ADVANCED(RUNA2X)

TO_A2X_COMPATIBLE_PATH( ${CMAKE_CURRENT_BINARY_DIR} _a2x_current_binary_dir )

MACRO( ASCIIDOC2DOCBOOK _asciidocsource _conf_files _src_files _built_deps )
    GET_FILENAME_COMPONENT( _source_base_name ${_asciidocsource} NAME_WE )
    set( A2X_HTML_OPTS --stylesheet=ws.css )
    set( _output_xml ${_source_base_name}.xml )
    set( _output_dbk ${_source_base_name}.dbk )

    foreach(_conf_file ${${_conf_files}})
        TO_A2X_COMPATIBLE_PATH ( ${CMAKE_CURRENT_SOURCE_DIR}/${_conf_file} _a2x_conf_file )
        set( _conf_opts_list ${_conf_opts_list} --conf-file=${_a2x_conf_file})
    endforeach()
    string( REPLACE ";" " " _conf_opts "${_conf_opts_list}")

    foreach(_conf_file ${${_conf_files}})
        set( _conf_deps ${_conf_deps} ${CMAKE_CURRENT_SOURCE_DIR}/${_conf_file})
    endforeach()

    foreach(_src_file ${${_src_files}})
        set( _src_deps ${_src_deps} ${CMAKE_CURRENT_SOURCE_DIR}/${_src_file})
    endforeach()

    TO_A2X_COMPATIBLE_PATH ( ${CMAKE_CURRENT_SOURCE_DIR}/${_asciidocsource} _a2x_asciidocsource )

    if(CMAKE_GENERATOR MATCHES "Visual Studio")
      # Workaround to prevent parallel msbuild builds from failing, see function
      # get_docbook_xml_depends in FindXSLTPROC.cmake for details. This command
      # updates the stamp file when the XML file is updated.
      set(_stamp_file "${CMAKE_CURRENT_BINARY_DIR}/${_output_xml}-stamp")
      set_property(SOURCE "${_stamp_file}" PROPERTY GENERATED)
      set(_command_touch_stamp COMMAND "${CMAKE_COMMAND}" -E touch "${_stamp_file}")
    else()
      set(_command_touch_stamp "")
    endif()

    add_custom_command(
        OUTPUT
            ${_output_xml}
        # XXX - Output to a specific directory, e.g. wsdg_generated_src
        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
        COMMAND ${RUNA2X}
            --verbose
            --attribute=build_dir=${_a2x_current_binary_dir}
            --attribute=docinfo
            --destination-dir=${_a2x_current_binary_dir}
            --asciidoc-opts=${_conf_opts}
            --no-xmllint
            --format=docbook
            --fop
            ${A2X_HTML_OPTS}
            ${_a2x_asciidocsource}
        ${_command_touch_stamp}
        DEPENDS
            ${CMAKE_CURRENT_SOURCE_DIR}/${_asciidocsource}
            ${_conf_deps}
            ${_src_deps}
            ${${_built_deps}}
    )
    add_custom_target(generate_${_output_xml} DEPENDS ${_output_xml})
    set_target_properties(generate_${_output_xml} PROPERTIES FOLDER "Docbook")
    unset(_src_deps)
    unset(_conf_deps)
    unset(_conf_opts_list)
ENDMACRO()

MACRO( ASCIIDOC2HTML _output _asciidocsource _conf_files )
    GET_FILENAME_COMPONENT( _source_base_name ${_asciidocsource} NAME_WE )
    SET( A2X_HTML_OPTS --stylesheet=ws.css )

    SET( _conf_opts_list )
    FOREACH( _conf_file ${_conf_files} )
        TO_A2X_COMPATIBLE_PATH ( ${CMAKE_CURRENT_SOURCE_DIR}/${_conf_file} _a2x_conf_file )
        SET( _conf_opts_list ${_conf_opts_list} --conf-file=${_a2x_conf_file})
    ENDFOREACH()
    STRING( REPLACE ";" " " _conf_opts "${_conf_opts_list}" )

    SET( _conf_deps )
    FOREACH( _conf_file ${_conf_files} )
        SET( _conf_deps ${_conf_deps} ${CMAKE_CURRENT_SOURCE_DIR}/${_conf_file} )
    ENDFOREACH()

    TO_A2X_COMPATIBLE_PATH ( ${_asciidocsource} _a2x_asciidocsource )

    ADD_CUSTOM_COMMAND(
        OUTPUT
            ${_output}
        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
        COMMAND ${RUNA2X}
            --format=xhtml
            --destination-dir=${_a2x_current_binary_dir}
            --asciidoc-opts=${_conf_opts}
            --fop
            ${A2X_HTML_OPTS}
            ${_a2x_asciidocsource}
        # Replacing file with itself will fail
        # COMMAND ${CMAKE_COMMAND} -E rename
        #     ${CMAKE_CURRENT_BINARY_DIR}/${_source_base_name}.html
        #     ${CMAKE_CURRENT_BINARY_DIR}/${_output}
        DEPENDS
            ${_asciidocsources}
            ${_conf_deps}
            ${_otherdependencies}
    )
    unset(_conf_deps)
    unset(_conf_opts_list)
ENDMACRO()

MACRO( ASCIIDOC2TXT _output _asciidocsource _conf_files )
    GET_FILENAME_COMPONENT( _source_base_name ${_asciidocsource} NAME_WE )
    if( LYNX_EXECUTABLE MATCHES lynx )
        set( A2X_TEXT_OPTS --lynx )
    else()
        set( A2X_TEXT_OPTS  )
    endif()
    SET( A2X_HTML_OPTS --stylesheet=ws.css )

    SET( _conf_opts_list )
    FOREACH( _conf_file ${_conf_files} )
        TO_A2X_COMPATIBLE_PATH ( ${CMAKE_CURRENT_SOURCE_DIR}/${_conf_file} _a2x_conf_file )
        SET( _conf_opts_list ${_conf_opts_list} --conf-file=${_a2x_conf_file})
    ENDFOREACH()
    STRING( REPLACE ";" " " _conf_opts "${_conf_opts_list}" )

    SET( _conf_deps )
    FOREACH( _conf_file ${_conf_files} )
        SET( _conf_deps ${_conf_deps} ${CMAKE_CURRENT_SOURCE_DIR}/${_conf_file} )
    ENDFOREACH()

    TO_A2X_COMPATIBLE_PATH ( ${_asciidocsource} _a2x_asciidocsource )

    ADD_CUSTOM_COMMAND(
        OUTPUT
            ${_output}
        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
        COMMAND ${RUNA2X}
            --format=text
            --destination-dir=${_a2x_current_binary_dir}
            --asciidoc-opts=${_conf_opts}
            --fop
            ${A2X_TEXT_OPTS}
            # XXX This generates a CMake working but correcting it looks
            # messy.
            --xsltproc-opts '--stringparam generate.toc "article nop" '
            ${_a2x_asciidocsource}
        COMMAND ${CMAKE_COMMAND} -E rename
            ${CMAKE_CURRENT_BINARY_DIR}/${_source_base_name}.text
            ${CMAKE_CURRENT_BINARY_DIR}/${_output}
        DEPENDS
            ${_asciidocsource}
            ${_conf_deps}
    )
    unset(_conf_deps)
    unset(_conf_opts_list)
ENDMACRO()

# news: release-notes.txt
#         ${CMAKE_COMMAND} -E copy_if_different release-notes.txt ../NEWS

MACRO( ASCIIDOC2PDF _output _asciidocsource _conf_files _paper )
    GET_FILENAME_COMPONENT( _source_base_name ${_asciidocsource} NAME_WE )
    SET( A2X_HTML_OPTS --stylesheet=ws.css )

    SET( _conf_opts_list )
    FOREACH( _conf_file ${_conf_files} )
        TO_A2X_COMPATIBLE_PATH ( ${CMAKE_CURRENT_SOURCE_DIR}/${_conf_file} _a2x_conf_file )
        SET( _conf_opts_list ${_conf_opts_list} --conf-file=${_a2x_conf_file})
    ENDFOREACH()
    STRING( REPLACE ";" " " _conf_opts "${_conf_opts_list}")

    SET( _conf_deps )
    FOREACH( _conf_file ${_conf_files} )
        SET( _conf_deps ${_conf_deps} ${CMAKE_CURRENT_SOURCE_DIR}/${_conf_file} )
    ENDFOREACH()

    TO_A2X_COMPATIBLE_PATH ( ${_asciidocsource} _a2x_asciidocsource )

    ADD_CUSTOM_COMMAND(
        OUTPUT
            ${_output}
        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
        COMMAND ${RUNA2X}
            --format=pdf
            --destination-dir=${_a2x_current_binary_dir}
            --asciidoc-opts=${_conf_opts}
            --fop
            ${A2X_HTML_OPTS}
            --xsltproc-opts "--stringparam paper.type ${_paper} --nonet"
            --xsl-file=custom_layer_pdf.xsl
            ${_a2x_asciidocsource}
        COMMAND ${CMAKE_COMMAND} -E rename
            ${CMAKE_CURRENT_BINARY_DIR}/${_source_base_name}.pdf
            ${CMAKE_CURRENT_BINARY_DIR}/${_output}
        DEPENDS
            ${_asciidocsources}
            ${_conf_deps}
            ${_otherdependencies}
    )
    unset(_conf_deps)
    unset(_conf_opts_list)
ENDMACRO()