docbook/CMakeLists.txt

   1 # CMakeLists.txt
   2 #
   3 # $Id$
   4 #
   5 # Wireshark - Network traffic analyzer
   6 # By Gerald Combs <gerald@wireshark.org>
   7 # Copyright 1998 Gerald Combs
   8 #
   9 # This program is free software; you can redistribute it and/or
  10 # modify it under the terms of the GNU General Public License
  11 # as published by the Free Software Foundation; either version 2
  12 # of the License, or (at your option) any later version.
  13 #
  14 # This program is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 # GNU General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU General Public License
  20 # along with this program; if not, write to the Free Software
  21 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  22 #
  23
  24 find_package( FOP ) # Call before XSLTPROC
  25 find_package( LYNX )
  26 find_package( XSLTPROC )
  27 find_package( XMLLINT )
  28 find_package( ASCIIDOC )
  29
  30 set(WSUG_FILES
  31         wsug_src/WSUG_app_files.xml
  32         wsug_src/WSUG_app_howitworks.xml
  33         wsug_src/WSUG_app_messages.xml
  34         wsug_src/WSUG_app_protocols.xml
  35         wsug_src/WSUG_app_tools.xml
  36         wsug_src/WSUG_chapter_advanced.xml
  37         wsug_src/WSUG_chapter_build_install.xml
  38         wsug_src/WSUG_chapter_capture.xml
  39         wsug_src/WSUG_chapter_customize.xml
  40         wsug_src/WSUG_chapter_introduction.xml
  41         wsug_src/WSUG_chapter_io.xml
  42         wsug_src/WSUG_chapter_statistics.xml
  43         wsug_src/WSUG_chapter_telephony.xml
  44         wsug_src/WSUG_chapter_troubleshoot.xml
  45         wsug_src/WSUG_chapter_use.xml
  46         wsug_src/WSUG_chapter_work.xml
  47         wsug_src/WSUG_meta_info.xml
  48         wsug_src/WSUG_preface.xml
  49         wsluarm.xml
  50         ws.css
  51 )
  52
  53 set(WSUG_GRAPHICS
  54         wsug_graphics/ws-analyze-menu.png
  55         wsug_graphics/ws-bytes-pane-tabs.png
  56         wsug_graphics/ws-bytes-pane.png
  57         wsug_graphics/ws-capture-info.png
  58         wsug_graphics/ws-capture-interfaces.png
  59         wsug_graphics/ws-capture-interfaces-win32.png
  60         wsug_graphics/ws-capture-menu.png
  61         wsug_graphics/ws-capture-options.png
  62         wsug_graphics/ws-capture-options-remote-capture.png
  63         wsug_graphics/ws-capture-options-remote-interface.png
  64         wsug_graphics/ws-capture-options-remote-settings.png
  65         wsug_graphics/ws-capture-preferences.png
  66         wsug_graphics/ws-choose-color-rule.png
  67         wsug_graphics/ws-coloring-fields.png
  68         wsug_graphics/ws-coloring-rules-dialog.png
  69         wsug_graphics/ws-column-header-popup-menu.png
  70         wsug_graphics/ws-decode-as-show.png
  71         wsug_graphics/ws-decode-as.png
  72         wsug_graphics/ws-column-header-popup-menu.png
  73         wsug_graphics/ws-details-pane-popup-menu.png
  74         wsug_graphics/ws-details-pane.png
  75         wsug_graphics/ws-display-filter-tcp.png
  76         wsug_graphics/ws-edit-color-rule-dialog.png
  77         wsug_graphics/ws-edit-menu.png
  78         wsug_graphics/ws-enabled-protocols.png
  79         wsug_graphics/ws-expert-colored-tree.png
  80         wsug_graphics/ws-expert-column.png
  81         wsug_graphics/ws-expert-infos.png
  82         wsug_graphics/ws-export-objects.png
  83         wsug_graphics/ws-export-pdml.png
  84         wsug_graphics/ws-export-plain.png
  85         wsug_graphics/ws-export-ps.png
  86         wsug_graphics/ws-export-psml.png
  87         wsug_graphics/ws-export-selected.png
  88         wsug_graphics/ws-file-import.png
  89         wsug_graphics/ws-file-menu.png
  90         wsug_graphics/ws-file-set-dialog.png
  91         wsug_graphics/ws-filter-add-expression.png
  92         wsug_graphics/ws-filter-toolbar.png
  93         wsug_graphics/ws-filters.png
  94         wsug_graphics/ws-find-packet.png
  95         wsug_graphics/ws-follow-stream.png
  96         wsug_graphics/ws-go-menu.png
  97         wsug_graphics/ws-goto-packet.png
  98         wsug_graphics/ws-gui-colors-preferences.png
  99         wsug_graphics/ws-gui-columns-preferences.png
 100         wsug_graphics/ws-gui-config-profiles.png
 101         wsug_graphics/ws-gui-font-preferences.png
 102         wsug_graphics/ws-gui-layout-preferences.png
 103         wsug_graphics/ws-gui-preferences.png
 104         wsug_graphics/ws-help-menu.png
 105         wsug_graphics/ws-internals-menu.png
 106         wsug_graphics/ws-list-pane.png
 107         wsug_graphics/ws-logo.png
 108         wsug_graphics/ws-main-toolbar.png
 109         wsug_graphics/ws-main.png
 110         wsug_graphics/ws-menu.png
 111         wsug_graphics/ws-merge-gtk20.png
 112         wsug_graphics/ws-merge-gtk24.png
 113         wsug_graphics/ws-merge-win32.png
 114         wsug_graphics/ws-nameresolution-preferences.png
 115         wsug_graphics/ws-open-gtk20.png
 116         wsug_graphics/ws-open-gtk24.png
 117         wsug_graphics/ws-open-win32.png
 118         wsug_graphics/ws-packet-format.png
 119         wsug_graphics/ws-packet-pane-popup-menu.png
 120         wsug_graphics/ws-packet-range.png
 121         wsug_graphics/ws-packet-selected.png
 122         wsug_graphics/ws-packet-sep-win.png
 123         wsug_graphics/ws-print.png
 124         wsug_graphics/ws-printing-preferences.png
 125         wsug_graphics/ws-save-as-gtk20.png
 126         wsug_graphics/ws-save-as-gtk24.png
 127         wsug_graphics/ws-save-as-win32.png
 128         wsug_graphics/ws-statistics-menu.png
 129         wsug_graphics/ws-stats-conversations.png
 130         wsug_graphics/ws-stats-endpoints.png
 131         wsug_graphics/ws-stats-hierarchy.png
 132         wsug_graphics/ws-stats-iographs.png
 133         wsug_graphics/ws-stats-srt-dcerpc-filter.png
 134         wsug_graphics/ws-stats-srt-dcerpc.png
 135         wsug_graphics/ws-stats-summary.png
 136         wsug_graphics/ws-stats-lte-mac-traffic.png
 137         wsug_graphics/ws-stats-lte-rlc-traffic.png
 138         wsug_graphics/ws-stats-wlan-traffic.png
 139         wsug_graphics/ws-statusbar-empty.png
 140         wsug_graphics/ws-statusbar-loaded.png
 141         wsug_graphics/ws-statusbar-selected.png
 142         wsug_graphics/ws-telephony-menu.png
 143         wsug_graphics/ws-time-reference.png
 144         wsug_graphics/ws-tools-menu.png
 145         wsug_graphics/ws-view-menu.png
 146         wsug_graphics/note.png
 147         wsug_graphics/tip.png
 148         wsug_graphics/warning.png
 149         wsug_graphics/toolbar/autoscroll_24.png
 150         wsug_graphics/toolbar/capture_filter_24.png
 151         wsug_graphics/toolbar/capture_interfaces_24.png
 152         wsug_graphics/toolbar/capture_options_24.png
 153         wsug_graphics/toolbar/capture_restart_24.png
 154         wsug_graphics/toolbar/capture_start_24.png
 155         wsug_graphics/toolbar/capture_stop_24.png
 156         wsug_graphics/toolbar/colorize_24.png
 157         wsug_graphics/toolbar/display_filter_24.png
 158         wsug_graphics/toolbar/resize_columns_24.png
 159         wsug_graphics/toolbar/stock_add_24.png
 160         wsug_graphics/toolbar/stock_apply_20.png
 161         wsug_graphics/toolbar/stock_bottom_24.png
 162         wsug_graphics/toolbar/stock_clear_24.png
 163         wsug_graphics/toolbar/stock_close_24.png
 164         wsug_graphics/toolbar/stock_colorselector_24.png
 165         wsug_graphics/toolbar/stock_help_24.png
 166         wsug_graphics/toolbar/stock_jump_to_24.png
 167         wsug_graphics/toolbar/stock_left_arrow_24.png
 168         wsug_graphics/toolbar/stock_open_24.png
 169         wsug_graphics/toolbar/stock_preferences_24.png
 170         wsug_graphics/toolbar/stock_print_24.png
 171         wsug_graphics/toolbar/stock_properties_24.png
 172         wsug_graphics/toolbar/stock_refresh_24.png
 173         wsug_graphics/toolbar/stock_right_arrow_24.png
 174         wsug_graphics/toolbar/stock_save_24.png
 175         wsug_graphics/toolbar/stock_save_as_24.png
 176         wsug_graphics/toolbar/stock_search_24.png
 177         wsug_graphics/toolbar/stock_stop_24.png
 178         wsug_graphics/toolbar/stock_top_24.png
 179         wsug_graphics/toolbar/stock_zoom_1_24.png
 180         wsug_graphics/toolbar/stock_zoom_in_24.png
 181         wsug_graphics/toolbar/stock_zoom_out_24.png
 182 )
 183
 184 set(WSDG_FILES
 185         wsdg_src/WSDG_chapter_build_intro.xml
 186         wsdg_src/WSDG_chapter_capture.xml
 187         wsdg_src/WSDG_chapter_dissection.xml
 188         wsdg_src/WSDG_chapter_env_intro.xml
 189         wsdg_src/WSDG_chapter_libraries.xml
 190         wsdg_src/WSDG_chapter_quick_setup.xml
 191         wsdg_generated_src/WSDG_chapter_sources.xml
 192         wsdg_src/WSDG_chapter_tools.xml
 193         wsdg_src/WSDG_chapter_userinterface.xml
 194         wsdg_src/WSDG_chapter_works.xml
 195         wsdg_src/WSDG_meta_info.xml
 196         wsdg_generated_src/WSDG_preface.xml
 197         ws.css
 198 )
 199
 200 set(WSDG_ASCIIDOC_FILES
 201         wsdg_src/WSDG_chapter_sources.asciidoc
 202         wsdg_src/WSDG_preface.asciidoc
 203 )
 204
 205 set(WSDG_GRAPHICS
 206         wsdg_graphics/ws-capture-sync.dia
 207         wsdg_graphics/ws-capture-sync.png
 208         wsdg_graphics/ws-capture_internals.dia
 209         wsdg_graphics/ws-capture_internals.png
 210         wsdg_graphics/ws-function-blocks.dia
 211         wsdg_graphics/ws-function-blocks.png
 212         wsdg_graphics/ws-logo.png
 213         wsdg_graphics/note.png
 214         wsdg_graphics/tip.png
 215         wsdg_graphics/warning.png
 216 )
 217
 218 # user-guide.xml must be first in the list
 219 set(WSUG_SOURCE
 220         user-guide.xml
 221         git_version.xml
 222         wsluarm
 223         ${WSUG_FILES}
 224         ${WSUG_GRAPHICS}
 225 )
 226
 227 SET( WSDG_GENERATED_FILES )
 228 # Convert an AsciiDoc document to a Docbook chapter
 229 # .asciidoc -> whole book (.dbk) -> chapter (.xml)
 230 MACRO( ASCIIDOC2CHAPTER _asciidocsource _conffile )
 231         GET_FILENAME_COMPONENT( _source_base_name ${_asciidocsource} NAME_WE )
 232         set( A2X_HTML_OPTS --stylesheet=ws.css )
 233         set( _output_xml ${_source_base_name}.xml )
 234         set( _output_dbk ${_source_base_name}.dbk )
 235         ADD_CUSTOM_TARGET(${_output_xml}
 236                 # XXX - Output to a specific directory, e.g. wsdg_generated_src
 237                 WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
 238                 COMMAND ${A2X_EXECUTABLE}
 239                         --verbose
 240                         --destination-dir=${CMAKE_CURRENT_BINARY_DIR}
 241                         --asciidoc-opts="--conf-file=${CMAKE_CURRENT_SOURCE_DIR}/${_conffile}"
 242                         --no-xmllint
 243                         --fop
 244                         --format=docbook --doctype=book
 245                         ${A2X_HTML_OPTS}
 246                         ${CMAKE_CURRENT_SOURCE_DIR}/${_asciidocsource}
 247                 COMMAND mv
 248                         ${_output_xml}
 249                         ${_output_dbk}
 250                 COMMAND ${XMLLINT_EXECUTABLE}
 251                         --xpath '//chapter | //preface'
 252                         ${_output_dbk}
 253                         > ${_output_xml}
 254                 DEPENDS
 255                         ${_outptudir}
 256         ${CMAKE_CURRENT_SOURCE_DIR}/${_asciidocsource}
 257         ${CMAKE_CURRENT_SOURCE_DIR}/${_conffile}
 258         )
 259 LIST( APPEND WSDG_GENERATED_FILES ${CMAKE_CURRENT_BINARY_DIR}/${_output_xml} )
 260 ENDMACRO()
 261
 262 FOREACH(ASCIIDOCFILE ${WSDG_ASCIIDOC_FILES})
 263         ASCIIDOC2CHAPTER(
 264                 ${ASCIIDOCFILE}
 265                 asciidoc.conf
 266         )
 267 ENDFOREACH()
 268
 269 ADD_CUSTOM_TARGET( wsdg_generated_src DEPENDS ${WSDG_GENERATED_FILES} )
 270
 271 # developer-guide.xml must be first in the list
 272 set(WSDG_SOURCE
 273         developer-guide.xml
 274         git_version.xml
 275         ${WSDG_FILES}
 276         ${WSDG_GRAPHICS}
 277         wsdg_generated_src
 278 )
 279
 280 set(WSLUA_MODULES
 281         ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_dumper.c
 282         ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_field.c
 283         ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_gui.c
 284         ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_listener.c
 285         ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_pinfo.c
 286         ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_proto.c
 287         ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_tree.c
 288         ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_tvb.c
 289         ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_util.c
 290 )
 291
 292 ADD_CUSTOM_COMMAND(
 293         OUTPUT
 294                 git_version.xml
 295         COMMAND ${SH}
 296                 ${CMAKE_CURRENT_SOURCE_DIR}/check_git_version.sh
 297         DEPENDS
 298                 ${CMAKE_CURRENT_SOURCE_DIR}/check_git_version.sh
 299 )
 300
 301 add_custom_target(
 302         user_guides ALL
 303         DEPENDS
 304                 wsluarm
 305                 wsug_html_chunked/index.html
 306                 wsug_html/index.html
 307                 user-guide-a4.pdf
 308                 user-guide-us.pdf
 309 )
 310
 311 VALIDATE_XML(
 312         wsug.validated
 313         WSUG_SOURCE
 314 )
 315
 316 XML2HTML(
 317         wsug.validated
 318         wsug_html/index.html
 319         single-page
 320         WSUG_SOURCE
 321         WSUG_GRAPHICS
 322 )
 323
 324 XML2HTML(
 325         wsug.validated
 326         wsug_html_chunked/index.html
 327         chunked
 328         WSUG_SOURCE
 329         WSUG_GRAPHICS
 330 )
 331
 332 # 2do: Merge A4 and letter into the smallest dimension of each format.
 333 #      Use   --stringparam  page.height <letter-height>mm --stringparam  page.width <at-width>mm
 334 #      Test the effect of this on letter and a4 printers first (ps and non-ps).
 335
 336 XML2PDF(
 337         user-guide-a4.pdf
 338         WSUG_SOURCE
 339         custom_layer_pdf.xsl
 340         A4
 341 )
 342
 343 XML2PDF(
 344         user-guide-us.pdf
 345         WSUG_SOURCE
 346         custom_layer_pdf.xsl
 347         letter
 348 )
 349
 350 add_custom_target(
 351         developer_guides ALL
 352         DEPENDS
 353                 wsluarm
 354                 wsdg_html_chunked/index.html
 355                 wsdg_html/index.html
 356                 developer-guide-a4.pdf
 357                 developer-guide-us.pdf
 358 )
 359
 360 VALIDATE_XML(
 361         wsdg.validated
 362         WSDG_SOURCE
 363 )
 364
 365 XML2HTML(
 366         wsdg.validated
 367         wsdg_html/index.html
 368         single-page
 369         WSDG_SOURCE
 370         WSDG_GRAPHICS
 371 )
 372
 373 XML2HTML(
 374         wsdg.validated
 375         wsdg_html_chunked/index.html
 376         chunked
 377         WSDG_SOURCE
 378         WSDG_GRAPHICS
 379 )
 380
 381 XML2PDF(
 382         developer-guide-a4.pdf
 383         WSDG_SOURCE
 384         custom_layer_pdf.xsl
 385         A4
 386 )
 387
 388 XML2PDF(
 389         developer-guide-us.pdf
 390         WSDG_SOURCE
 391         custom_layer_pdf.xsl
 392         letter
 393 )
 394
 395 # release_notes: release-notes.html release-notes.txt release-notes-a4.pdf release-notes-us.pdf
 396
 397 add_custom_target(
 398         release_notes ALL
 399         DEPENDS
 400                 release-notes.html
 401                 release-notes.txt
 402                 release-notes-a4.pdf
 403                 release-notes-us.pdf
 404                 ${CMAKE_SOURCE_DIR}/NEWS
 405 )
 406
 407 ADD_CUSTOM_COMMAND(
 408         OUTPUT
 409                 ${CMAKE_SOURCE_DIR}/NEWS
 410         COMMAND cp
 411                 ${CMAKE_CURRENT_BINARY_DIR}/release-notes.txt
 412                 ${CMAKE_SOURCE_DIR}/NEWS
 413         DEPENDS
 414                 ${CMAKE_CURRENT_BINARY_DIR}/release-notes.txt
 415 )
 416
 417 ASCIIDOC2HTML(
 418         release-notes.html
 419         release-notes.asciidoc
 420         asciidoc.conf
 421 )
 422
 423 ASCIIDOC2TXT(
 424         release-notes.txt
 425         release-notes.asciidoc
 426         asciidoc.conf
 427 )
 428
 429 ASCIIDOC2PDF(
 430         release-notes-a4.pdf
 431         release-notes.asciidoc
 432         asciidoc.conf
 433         A4
 434 )
 435
 436 ASCIIDOC2PDF(
 437         release-notes-us.pdf
 438         release-notes.asciidoc
 439         asciidoc.conf
 440         letter
 441 )
 442
 443 # wsluarm
 444 ADD_CUSTOM_COMMAND(
 445         OUTPUT
 446                 wsluarm
 447         COMMAND cmake -E make_directory wsluarm_src
 448         COMMAND ${PERL_EXECUTABLE}
 449                 ${CMAKE_CURRENT_SOURCE_DIR}/make-wsluarm.pl
 450                 ${WSLUA_MODULES}
 451         COMMAND
 452                 touch wsluarm
 453         DEPENDS
 454                 ${CMAKE_CURRENT_SOURCE_DIR}/make-wsluarm.pl
 455                 ${WSLUA_MODULES}
 456 )
 457