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_generated_src/WSDG_chapter_build_intro.xml
 186         wsdg_generated_src/WSDG_chapter_capture.xml
 187         wsdg_generated_src/WSDG_chapter_dissection.xml
 188         wsdg_generated_src/WSDG_chapter_env_intro.xml
 189         wsdg_generated_src/WSDG_chapter_libraries.xml
 190         wsdg_generated_src/WSDG_chapter_quick_setup.xml
 191         wsdg_generated_src/WSDG_chapter_sources.xml
 192         wsdg_generated_src/WSDG_chapter_tools.xml
 193         wsdg_src/WSDG_chapter_userinterface.xml
 194         wsdg_generated_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_build_intro.asciidoc
 202         wsdg_src/WSDG_chapter_capture.asciidoc
 203         wsdg_src/WSDG_chapter_dissection.asciidoc
 204         wsdg_src/WSDG_chapter_env_intro.asciidoc
 205         wsdg_src/WSDG_chapter_libraries.asciidoc
 206         wsdg_src/WSDG_chapter_quick_setup.asciidoc
 207         wsdg_src/WSDG_chapter_sources.asciidoc
 208         wsdg_src/WSDG_chapter_tools.asciidoc
 209         wsdg_src/WSDG_chapter_works.asciidoc
 210         wsdg_src/WSDG_preface.asciidoc
 211 )
 212
 213 set(WSDG_GRAPHICS
 214         wsdg_graphics/ws-capture-sync.dia
 215         wsdg_graphics/ws-capture-sync.png
 216         wsdg_graphics/ws-capture_internals.dia
 217         wsdg_graphics/ws-capture_internals.png
 218         wsdg_graphics/ws-function-blocks.dia
 219         wsdg_graphics/ws-function-blocks.png
 220         wsdg_graphics/ws-logo.png
 221         wsdg_graphics/note.png
 222         wsdg_graphics/tip.png
 223         wsdg_graphics/warning.png
 224 )
 225
 226 # user-guide.xml must be first in the list
 227 set(WSUG_SOURCE
 228         user-guide.xml
 229         git_version.xml
 230         wsluarm
 231         ${WSUG_FILES}
 232         ${WSUG_GRAPHICS}
 233 )
 234
 235 SET( WSDG_GENERATED_FILES )
 236 # Convert an AsciiDoc document to a Docbook chapter
 237 # .asciidoc -> whole book (.dbk) -> chapter (.xml)
 238 MACRO( ASCIIDOC2CHAPTER _asciidocsource _conffile )
 239         GET_FILENAME_COMPONENT( _source_base_name ${_asciidocsource} NAME_WE )
 240         set( A2X_HTML_OPTS --stylesheet=ws.css )
 241         set( _output_xml ${_source_base_name}.xml )
 242         set( _output_dbk ${_source_base_name}.dbk )
 243         ADD_CUSTOM_TARGET(${_output_xml}
 244                 # XXX - Output to a specific directory, e.g. wsdg_generated_src
 245                 WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
 246                 COMMAND ${A2X_EXECUTABLE}
 247                         --verbose
 248                         --destination-dir=${CMAKE_CURRENT_BINARY_DIR}
 249                         --asciidoc-opts="--conf-file=${CMAKE_CURRENT_SOURCE_DIR}/${_conffile}"
 250                         --no-xmllint
 251                         --fop
 252                         --format=docbook --doctype=book
 253                         ${A2X_HTML_OPTS}
 254                         ${CMAKE_CURRENT_SOURCE_DIR}/${_asciidocsource}
 255                 COMMAND mv
 256                         ${_output_xml}
 257                         ${_output_dbk}
 258                 COMMAND ${XMLLINT_EXECUTABLE}
 259                         --xpath '//chapter | //preface'
 260                         ${_output_dbk}
 261                         > ${_output_xml}
 262                 DEPENDS
 263                         ${_outptudir}
 264         ${CMAKE_CURRENT_SOURCE_DIR}/${_asciidocsource}
 265         ${CMAKE_CURRENT_SOURCE_DIR}/${_conffile}
 266         )
 267 LIST( APPEND WSDG_GENERATED_FILES ${CMAKE_CURRENT_BINARY_DIR}/${_output_xml} )
 268 ENDMACRO()
 269
 270 FOREACH(ASCIIDOCFILE ${WSDG_ASCIIDOC_FILES})
 271         ASCIIDOC2CHAPTER(
 272                 ${ASCIIDOCFILE}
 273                 asciidoc.conf
 274         )
 275 ENDFOREACH()
 276
 277 ADD_CUSTOM_TARGET( wsdg_generated_src DEPENDS ${WSDG_GENERATED_FILES} )
 278
 279 # developer-guide.xml must be first in the list
 280 set(WSDG_SOURCE
 281         developer-guide.xml
 282         git_version.xml
 283         ${WSDG_FILES}
 284         ${WSDG_GRAPHICS}
 285         wsdg_generated_src
 286 )
 287
 288 set(WSLUA_MODULES
 289         ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_dumper.c
 290         ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_field.c
 291         ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_gui.c
 292         ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_listener.c
 293         ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_pinfo.c
 294         ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_proto.c
 295         ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_tree.c
 296         ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_tvb.c
 297         ${CMAKE_SOURCE_DIR}/epan/wslua/wslua_util.c
 298 )
 299
 300 ADD_CUSTOM_COMMAND(
 301         OUTPUT
 302                 git_version.xml
 303         COMMAND ${SH}
 304                 ${CMAKE_CURRENT_SOURCE_DIR}/check_git_version.sh
 305         DEPENDS
 306                 ${CMAKE_CURRENT_SOURCE_DIR}/check_git_version.sh
 307 )
 308
 309 add_custom_target(
 310         user_guides ALL
 311         DEPENDS
 312                 wsluarm
 313                 wsug_html_chunked/index.html
 314                 wsug_html/index.html
 315                 user-guide-a4.pdf
 316                 user-guide-us.pdf
 317 )
 318
 319 VALIDATE_XML(
 320         wsug.validated
 321         WSUG_SOURCE
 322 )
 323
 324 XML2HTML(
 325         wsug.validated
 326         wsug_html/index.html
 327         single-page
 328         WSUG_SOURCE
 329         WSUG_GRAPHICS
 330 )
 331
 332 XML2HTML(
 333         wsug.validated
 334         wsug_html_chunked/index.html
 335         chunked
 336         WSUG_SOURCE
 337         WSUG_GRAPHICS
 338 )
 339
 340 # 2do: Merge A4 and letter into the smallest dimension of each format.
 341 #      Use   --stringparam  page.height <letter-height>mm --stringparam  page.width <at-width>mm
 342 #      Test the effect of this on letter and a4 printers first (ps and non-ps).
 343
 344 XML2PDF(
 345         user-guide-a4.pdf
 346         WSUG_SOURCE
 347         custom_layer_pdf.xsl
 348         A4
 349 )
 350
 351 XML2PDF(
 352         user-guide-us.pdf
 353         WSUG_SOURCE
 354         custom_layer_pdf.xsl
 355         letter
 356 )
 357
 358 add_custom_target(
 359         developer_guides ALL
 360         DEPENDS
 361                 wsluarm
 362                 wsdg_html_chunked/index.html
 363                 wsdg_html/index.html
 364                 developer-guide-a4.pdf
 365                 developer-guide-us.pdf
 366 )
 367
 368 VALIDATE_XML(
 369         wsdg.validated
 370         WSDG_SOURCE
 371 )
 372
 373 XML2HTML(
 374         wsdg.validated
 375         wsdg_html/index.html
 376         single-page
 377         WSDG_SOURCE
 378         WSDG_GRAPHICS
 379 )
 380
 381 XML2HTML(
 382         wsdg.validated
 383         wsdg_html_chunked/index.html
 384         chunked
 385         WSDG_SOURCE
 386         WSDG_GRAPHICS
 387 )
 388
 389 XML2PDF(
 390         developer-guide-a4.pdf
 391         WSDG_SOURCE
 392         custom_layer_pdf.xsl
 393         A4
 394 )
 395
 396 XML2PDF(
 397         developer-guide-us.pdf
 398         WSDG_SOURCE
 399         custom_layer_pdf.xsl
 400         letter
 401 )
 402
 403 # release_notes: release-notes.html release-notes.txt release-notes-a4.pdf release-notes-us.pdf
 404
 405 add_custom_target(
 406         release_notes ALL
 407         DEPENDS
 408                 release-notes.html
 409                 release-notes.txt
 410                 release-notes-a4.pdf
 411                 release-notes-us.pdf
 412                 ${CMAKE_SOURCE_DIR}/NEWS
 413 )
 414
 415 ADD_CUSTOM_COMMAND(
 416         OUTPUT
 417                 ${CMAKE_SOURCE_DIR}/NEWS
 418         COMMAND cp
 419                 ${CMAKE_CURRENT_BINARY_DIR}/release-notes.txt
 420                 ${CMAKE_SOURCE_DIR}/NEWS
 421         DEPENDS
 422                 ${CMAKE_CURRENT_BINARY_DIR}/release-notes.txt
 423 )
 424
 425 ASCIIDOC2HTML(
 426         release-notes.html
 427         release-notes.asciidoc
 428         asciidoc.conf
 429 )
 430
 431 ASCIIDOC2TXT(
 432         release-notes.txt
 433         release-notes.asciidoc
 434         asciidoc.conf
 435 )
 436
 437 ASCIIDOC2PDF(
 438         release-notes-a4.pdf
 439         release-notes.asciidoc
 440         asciidoc.conf
 441         A4
 442 )
 443
 444 ASCIIDOC2PDF(
 445         release-notes-us.pdf
 446         release-notes.asciidoc
 447         asciidoc.conf
 448         letter
 449 )
 450
 451 # wsluarm
 452 ADD_CUSTOM_COMMAND(
 453         OUTPUT
 454                 wsluarm
 455         COMMAND cmake -E make_directory wsluarm_src
 456         COMMAND ${PERL_EXECUTABLE}
 457                 ${CMAKE_CURRENT_SOURCE_DIR}/make-wsluarm.pl
 458                 ${WSLUA_MODULES}
 459         COMMAND
 460                 touch wsluarm
 461         DEPENDS
 462                 ${CMAKE_CURRENT_SOURCE_DIR}/make-wsluarm.pl
 463                 ${WSLUA_MODULES}
 464 )
 465