FindBISON.cmake 7.89 KB
Newer Older
1 2 3 4
#.rst:
# FindBISON
# ---------
#
5
# Find ``bison`` executable and provide a macro to generate custom build rules.
6
#
Brad King's avatar
Brad King committed
7 8
# The module defines the following variables:
#
9 10
# ``BISON_EXECUTABLE``
#   path to the ``bison`` program
11
#
12 13
# ``BISON_VERSION``
#   version of ``bison``
14
#
15 16
# ``BISON_FOUND``
#   true if the program was found
17
#
18 19
# The minimum required version of ``bison`` can be specified using the
# standard CMake syntax, e.g.  ``find_package(BISON 2.1.3)``.
Brad King's avatar
Brad King committed
20
#
21
# If ``bison`` is found, the module defines the macro::
22
#
23 24
#   BISON_TARGET(<Name> <YaccInput> <CodeOutput>
#                [COMPILE_FLAGS <flags>]
25
#                [DEFINES_FILE <file>]
26 27
#                [VERBOSE <file>]
#                )
28
#
29 30 31 32
# which will create a custom rule to generate a parser.  ``<YaccInput>`` is
# the path to a yacc file.  ``<CodeOutput>`` is the name of the source file
# generated by bison.  A header file is also be generated, and contains
# the token list.
33
#
34
# The options are:
35
#
36 37 38
# ``COMPILE_FLAGS <flags>``
#   Specify flags to be added to the ``bison`` command line.
#
39 40 41
# ``DEFINES_FILE <file>``
#   Specify a non-default header ``<file>`` to be generated by ``bison``.
#
42 43 44
# ``VERBOSE <file>``
#   Tell ``bison`` to write verbose descriptions of the grammar and
#   parser to the given ``<file>``.
45
#
46
# The macro defines the following variables:
47
#
48 49
# ``BISON_<Name>_DEFINED``
#   true is the macro ran successfully
50
#
51 52
# ``BISON_<Name>_INPUT``
#   The input source file, an alias for <YaccInput>
53
#
54 55
# ``BISON_<Name>_OUTPUT_SOURCE``
#   The source file generated by bison
56
#
57 58
# ``BISON_<Name>_OUTPUT_HEADER``
#   The header file generated by bison
59
#
60 61
# ``BISON_<Name>_OUTPUTS``
#   The sources files generated by bison
62
#
63 64
# ``BISON_<Name>_COMPILE_FLAGS``
#   Options used in the ``bison`` command line
65
#
66
# Example usage:
67
#
68
# .. code-block:: cmake
69
#
70
#   find_package(BISON)
71 72
#   BISON_TARGET(MyParser parser.y ${CMAKE_CURRENT_BINARY_DIR}/parser.cpp
#                DEFINES_FILE ${CMAKE_CURRENT_BINARY_DIR}/parser.h)
73
#   add_executable(Foo main.cpp ${BISON_MyParser_OUTPUTS})
Brad King's avatar
Brad King committed
74

75 76 77
#=============================================================================
# Copyright 2009 Kitware, Inc.
# Copyright 2006 Tristan Carel
Brad King's avatar
Brad King committed
78
#
79 80
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
Brad King's avatar
Brad King committed
81
#
82 83 84 85
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
86
# (To distribute this file outside of CMake, substitute the full
87
#  License text for the above reference.)
Brad King's avatar
Brad King committed
88

89
find_program(BISON_EXECUTABLE NAMES bison win_bison DOC "path to the bison executable")
90
mark_as_advanced(BISON_EXECUTABLE)
Brad King's avatar
Brad King committed
91

92 93
include(CMakeParseArguments)

94
if(BISON_EXECUTABLE)
95 96
  # the bison commands should be executed with the C locale, otherwise
  # the message (which are parsed) may be translated
97 98
  set(_Bison_SAVED_LC_ALL "$ENV{LC_ALL}")
  set(ENV{LC_ALL} C)
Brad King's avatar
Brad King committed
99

100
  execute_process(COMMAND ${BISON_EXECUTABLE} --version
Brad King's avatar
Brad King committed
101 102 103 104
    OUTPUT_VARIABLE BISON_version_output
    ERROR_VARIABLE BISON_version_error
    RESULT_VARIABLE BISON_version_result
    OUTPUT_STRIP_TRAILING_WHITESPACE)
105

106
  set(ENV{LC_ALL} ${_Bison_SAVED_LC_ALL})
107

108 109 110
  if(NOT ${BISON_version_result} EQUAL 0)
    message(SEND_ERROR "Command \"${BISON_EXECUTABLE} --version\" failed with output:\n${BISON_version_error}")
  else()
111
    # Bison++
112 113
    if("${BISON_version_output}" MATCHES "^bison\\+\\+ Version ([^,]+)")
      set(BISON_VERSION "${CMAKE_MATCH_1}")
114
    # GNU Bison
115 116 117 118
    elseif("${BISON_version_output}" MATCHES "^bison \\(GNU Bison\\) ([^\n]+)\n")
      set(BISON_VERSION "${CMAKE_MATCH_1}")
    elseif("${BISON_version_output}" MATCHES "^GNU Bison (version )?([^\n]+)")
      set(BISON_VERSION "${CMAKE_MATCH_2}")
119 120
    endif()
  endif()
Brad King's avatar
Brad King committed
121 122

  # internal macro
123 124 125 126 127
  macro(BISON_TARGET_option_verbose Name BisonOutput filename)
    list(APPEND BISON_TARGET_cmdopt "--verbose")
    get_filename_component(BISON_TARGET_output_path "${BisonOutput}" PATH)
    get_filename_component(BISON_TARGET_output_name "${BisonOutput}" NAME_WE)
    add_custom_command(OUTPUT ${filename}
Brad King's avatar
Brad King committed
128 129 130 131 132 133 134 135
      COMMAND ${CMAKE_COMMAND}
      ARGS -E copy
      "${BISON_TARGET_output_path}/${BISON_TARGET_output_name}.output"
      "${filename}"
      DEPENDS
      "${BISON_TARGET_output_path}/${BISON_TARGET_output_name}.output"
      COMMENT "[BISON][${Name}] Copying bison verbose table to ${filename}"
      WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
136 137
    set(BISON_${Name}_VERBOSE_FILE ${filename})
    list(APPEND BISON_TARGET_extraoutputs
Brad King's avatar
Brad King committed
138
      "${BISON_TARGET_output_path}/${BISON_TARGET_output_name}.output")
139
  endmacro()
Brad King's avatar
Brad King committed
140 141

  # internal macro
142 143 144 145
  macro(BISON_TARGET_option_extraopts Options)
    set(BISON_TARGET_extraopts "${Options}")
    separate_arguments(BISON_TARGET_extraopts)
    list(APPEND BISON_TARGET_cmdopt ${BISON_TARGET_extraopts})
146
  endmacro()
Brad King's avatar
Brad King committed
147

148 149 150 151 152 153
  # internal macro
  macro(BISON_TARGET_option_defines Header)
    set(BISON_TARGET_output_header "${Header}")
    list(APPEND BISON_TARGET_cmdopt --defines=${BISON_TARGET_output_header})
  endmacro()

Brad King's avatar
Brad King committed
154 155 156 157
  #============================================================
  # BISON_TARGET (public macro)
  #============================================================
  #
158 159 160 161
  macro(BISON_TARGET Name BisonInput BisonOutput)
    set(BISON_TARGET_output_header "")
    set(BISON_TARGET_cmdopt "")
    set(BISON_TARGET_outputs "${BisonOutput}")
162 163 164 165 166 167

    # Parsing parameters
    set(BISON_TARGET_PARAM_OPTIONS)
    set(BISON_TARGET_PARAM_ONE_VALUE_KEYWORDS
      VERBOSE
      COMPILE_FLAGS
168
      DEFINES_FILE
169 170 171 172 173 174 175 176 177 178 179
      )
    set(BISON_TARGET_PARAM_MULTI_VALUE_KEYWORDS)
    cmake_parse_arguments(
        BISON_TARGET_ARG
        "${BISON_TARGET_PARAM_OPTIONS}"
        "${BISON_TARGET_PARAM_ONE_VALUE_KEYWORDS}"
        "${BISON_TARGET_PARAM_MULTI_VALUE_KEYWORDS}"
        ${ARGN}
    )

    if(NOT "${BISON_TARGET_ARG_UNPARSED_ARGUMENTS}" STREQUAL "")
180 181
      message(SEND_ERROR "Usage")
    else()
182 183
      if(NOT "${BISON_TARGET_ARG_VERBOSE}" STREQUAL "")
        BISON_TARGET_option_verbose(${Name} ${BisonOutput} "${BISON_TARGET_ARG_VERBOSE}")
184
      endif()
185 186
      if(NOT "${BISON_TARGET_ARG_COMPILE_FLAGS}" STREQUAL "")
        BISON_TARGET_option_extraopts("${BISON_TARGET_ARG_COMPILE_FLAGS}")
187
      endif()
188 189 190
      if(NOT "${BISON_TARGET_ARG_DEFINES_FILE}" STREQUAL "")
        BISON_TARGET_option_defines("${BISON_TARGET_ARG_DEFINES_FILE}")
      endif()
Brad King's avatar
Brad King committed
191

192 193 194 195 196 197 198 199 200
      if("${BISON_TARGET_output_header}" STREQUAL "")
        # Header's name generated by bison (see option -d)
        list(APPEND BISON_TARGET_cmdopt "-d")
        string(REGEX REPLACE "^(.*)(\\.[^.]*)$" "\\2" _fileext "${BisonOutput}")
        string(REPLACE "c" "h" _fileext ${_fileext})
        string(REGEX REPLACE "^(.*)(\\.[^.]*)$" "\\1${_fileext}"
            BISON_TARGET_output_header "${BisonOutput}")
      endif()
      list(APPEND BISON_TARGET_outputs "${BISON_TARGET_output_header}")
201

202
      add_custom_command(OUTPUT ${BISON_TARGET_outputs}
Brad King's avatar
Brad King committed
203 204
        ${BISON_TARGET_extraoutputs}
        COMMAND ${BISON_EXECUTABLE}
205 206
        ARGS ${BISON_TARGET_cmdopt} -o ${BisonOutput} ${BisonInput}
        DEPENDS ${BisonInput}
Brad King's avatar
Brad King committed
207 208
        COMMENT "[BISON][${Name}] Building parser with bison ${BISON_VERSION}"
        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
209

Brad King's avatar
Brad King committed
210
      # define target variables
211
      set(BISON_${Name}_DEFINED TRUE)
212
      set(BISON_${Name}_INPUT ${BisonInput})
213 214 215
      set(BISON_${Name}_OUTPUTS ${BISON_TARGET_outputs})
      set(BISON_${Name}_COMPILE_FLAGS ${BISON_TARGET_cmdopt})
      set(BISON_${Name}_OUTPUT_SOURCE "${BisonOutput}")
216
      set(BISON_${Name}_OUTPUT_HEADER "${BISON_TARGET_output_header}")
217

218 219
    endif()
  endmacro()
Brad King's avatar
Brad King committed
220 221 222
  #
  #============================================================

223
endif()
Brad King's avatar
Brad King committed
224

225
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
226 227
FIND_PACKAGE_HANDLE_STANDARD_ARGS(BISON REQUIRED_VARS  BISON_EXECUTABLE
                                        VERSION_VAR BISON_VERSION)
Brad King's avatar
Brad King committed
228 229

# FindBISON.cmake ends here