FindFLEX.cmake 7.58 KB
Newer Older
1 2 3 4 5 6 7
#.rst:
# FindFLEX
# --------
#
# Find flex executable and provides a macro to generate custom build rules
#
#
8 9
#
# The module defines the following variables:
10 11 12 13 14 15 16 17 18 19
#
# ::
#
#   FLEX_FOUND - true is flex executable is found
#   FLEX_EXECUTABLE - the path to the flex executable
#   FLEX_VERSION - the version of flex
#   FLEX_LIBRARIES - The flex libraries
#   FLEX_INCLUDE_DIRS - The path to the flex headers
#
#
20
#
21
# The minimum required version of flex can be specified using the
22 23
# standard syntax, e.g.  find_package(FLEX 2.5.13)
#
24 25
#
#
26
# If flex is found on the system, the module provides the macro:
27 28 29
#
# ::
#
30 31 32 33
#   FLEX_TARGET(Name FlexInput FlexOutput
#               [COMPILE_FLAGS <string>]
#               [DEFINES_FILE <string>]
#               )
34 35 36
#
# which creates a custom command to generate the <FlexOutput> file from
# the <FlexInput> file.  If COMPILE_FLAGS option is specified, the next
37 38 39 40
# parameter is added to the flex command line. If flex is configured to
# output a header file, the DEFINES_FILE option may be used to specify its
# name. Name is an alias used to get details of this custom command.
# Indeed the macro defines the following variables:
41
#
42 43 44 45 46 47
# ::
#
#   FLEX_${Name}_DEFINED - true is the macro ran successfully
#   FLEX_${Name}_OUTPUTS - the source file generated by the custom rule, an
#   alias for FlexOutput
#   FLEX_${Name}_INPUT - the flex source file, an alias for ${FlexInput}
48
#   FLEX_${Name}_OUTPUT_HEADER - the header flex output, if any.
49 50 51 52 53
#
#
#
# Flex scanners oftenly use tokens defined by Bison: the code generated
# by Flex depends of the header generated by Bison.  This module also
54
# defines a macro:
55 56 57 58 59 60 61
#
# ::
#
#   ADD_FLEX_BISON_DEPENDENCY(FlexTarget BisonTarget)
#
# which adds the required dependency between a scanner and a parser
# where <FlexTarget> and <BisonTarget> are the first parameters of
62 63
# respectively FLEX_TARGET and BISON_TARGET macros.
#
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
# ::
#
#   ====================================================================
#   Example:
#
#
#
# ::
#
#    find_package(BISON)
#    find_package(FLEX)
#
#
#
# ::
#
#    BISON_TARGET(MyParser parser.y ${CMAKE_CURRENT_BINARY_DIR}/parser.cpp)
#    FLEX_TARGET(MyScanner lexer.l  ${CMAKE_CURRENT_BINARY_DIR}/lexer.cpp)
#    ADD_FLEX_BISON_DEPENDENCY(MyScanner MyParser)
#
84 85
#
#
86
# ::
87
#
88 89 90 91 92 93 94
#    include_directories(${CMAKE_CURRENT_BINARY_DIR})
#    add_executable(Foo
#       Foo.cc
#       ${BISON_MyParser_OUTPUTS}
#       ${FLEX_MyScanner_OUTPUTS}
#    )
#   ====================================================================
95

96 97 98
#=============================================================================
# Copyright 2009 Kitware, Inc.
# Copyright 2006 Tristan Carel
99
#
100 101
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
102
#
103 104 105 106
# 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.
#=============================================================================
107
# (To distribute this file outside of CMake, substitute the full
108
#  License text for the above reference.)
109

110
find_program(FLEX_EXECUTABLE NAMES flex win_flex DOC "path to the flex executable")
111
mark_as_advanced(FLEX_EXECUTABLE)
112

113
find_library(FL_LIBRARY NAMES fl
114 115
  DOC "Path to the fl library")

116
find_path(FLEX_INCLUDE_DIR FlexLexer.h
117 118
  DOC "Path to the flex headers")

119
mark_as_advanced(FL_LIBRARY FLEX_INCLUDE_DIR)
120

121 122
include(${CMAKE_CURRENT_LIST_DIR}/CMakeParseArguments.cmake)

123 124
set(FLEX_INCLUDE_DIRS ${FLEX_INCLUDE_DIR})
set(FLEX_LIBRARIES ${FL_LIBRARY})
125

126
if(FLEX_EXECUTABLE)
127

128
  execute_process(COMMAND ${FLEX_EXECUTABLE} --version
129 130 131 132
    OUTPUT_VARIABLE FLEX_version_output
    ERROR_VARIABLE FLEX_version_error
    RESULT_VARIABLE FLEX_version_result
    OUTPUT_STRIP_TRAILING_WHITESPACE)
133 134 135 136 137 138 139
  if(NOT ${FLEX_version_result} EQUAL 0)
    if(FLEX_FIND_REQUIRED)
      message(SEND_ERROR "Command \"${FLEX_EXECUTABLE} --version\" failed with output:\n${FLEX_version_output}\n${FLEX_version_error}")
    else()
      message("Command \"${FLEX_EXECUTABLE} --version\" failed with output:\n${FLEX_version_output}\n${FLEX_version_error}\nFLEX_VERSION will not be available")
    endif()
  else()
140 141
    # older versions of flex printed "/full/path/to/executable version X.Y"
    # newer versions use "basename(executable) X.Y"
142 143 144
    get_filename_component(FLEX_EXE_NAME_WE "${FLEX_EXECUTABLE}" NAME_WE)
    get_filename_component(FLEX_EXE_EXT "${FLEX_EXECUTABLE}" EXT)
    string(REGEX REPLACE "^.*${FLEX_EXE_NAME_WE}(${FLEX_EXE_EXT})?\"? (version )?([0-9]+[^ ]*)( .*)?$" "\\3"
145
      FLEX_VERSION "${FLEX_version_output}")
146 147
    unset(FLEX_EXE_EXT)
    unset(FLEX_EXE_NAME_WE)
148
  endif()
149 150 151 152 153

  #============================================================
  # FLEX_TARGET (public macro)
  #============================================================
  #
154
  macro(FLEX_TARGET Name Input Output)
155
    set(FLEX_TARGET_outputs "${Output}")
156 157 158 159 160
    set(FLEX_EXECUTABLE_opts "")

    set(FLEX_TARGET_PARAM_OPTIONS)
    set(FLEX_TARGET_PARAM_ONE_VALUE_KEYWORDS
      COMPILE_FLAGS
161
      DEFINES_FILE
162 163 164 165 166 167 168 169 170 171 172
      )
    set(FLEX_TARGET_PARAM_MULTI_VALUE_KEYWORDS)

    cmake_parse_arguments(
      FLEX_TARGET_ARG
      "${FLEX_TARGET_PARAM_OPTIONS}"
      "${FLEX_TARGET_PARAM_ONE_VALUE_KEYWORDS}"
      "${FLEX_TARGET_MULTI_VALUE_KEYWORDS}"
      ${ARGN}
      )

173
    set(FLEX_TARGET_usage "FLEX_TARGET(<Name> <Input> <Output> [COMPILE_FLAGS <string>] [DEFINES_FILE <string>]")
174 175 176 177 178 179 180

    if(NOT "${FLEX_TARGET_ARG_UNPARSED_ARGUMENTS}" STREQUAL "")
      message(SEND_ERROR ${FLEX_TARGET_usage})
    else()
      if(NOT "${FLEX_TARGET_ARG_COMPILE_FLAGS}" STREQUAL "")
        set(FLEX_EXECUTABLE_opts "${FLEX_TARGET_ARG_COMPILE_FLAGS}")
        separate_arguments(FLEX_EXECUTABLE_opts)
181
      endif()
182 183 184 185
      if(NOT "${FLEX_TARGET_ARG_DEFINES_FILE}" STREQUAL "")
        list(APPEND FLEX_TARGET_outputs "${FLEX_TARGET_ARG_DEFINES_FILE}")
        list(APPEND FLEX_EXECUTABLE_opts --header-file=${FLEX_TARGET_ARG_DEFINES_FILE})
      endif()
186

187
      add_custom_command(OUTPUT ${FLEX_TARGET_outputs}
188 189
        COMMAND ${FLEX_EXECUTABLE} ${FLEX_EXECUTABLE_opts} -o${Output} ${Input}
        VERBATIM
190 191 192 193 194 195 196 197
        DEPENDS ${Input}
        COMMENT "[FLEX][${Name}] Building scanner with flex ${FLEX_VERSION}"
        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})

      set(FLEX_${Name}_DEFINED TRUE)
      set(FLEX_${Name}_OUTPUTS ${Output})
      set(FLEX_${Name}_INPUT ${Input})
      set(FLEX_${Name}_COMPILE_FLAGS ${FLEX_EXECUTABLE_opts})
198 199 200 201 202
      if("${FLEX_TARGET_ARG_DEFINES_FILE}" STREQUAL "")
        set(FLEX_${Name}_OUTPUT_HEADER "")
      else()
        set(FLEX_${Name}_OUTPUT_HEADER ${FLEX_TARGET_ARG_DEFINES_FILE})
      endif()
203
    endif()
204
  endmacro()
205 206 207 208 209 210 211
  #============================================================


  #============================================================
  # ADD_FLEX_BISON_DEPENDENCY (public macro)
  #============================================================
  #
212
  macro(ADD_FLEX_BISON_DEPENDENCY FlexTarget BisonTarget)
213

214
    if(NOT FLEX_${FlexTarget}_OUTPUTS)
215
      message(SEND_ERROR "Flex target `${FlexTarget}' does not exist.")
216
    endif()
217

218
    if(NOT BISON_${BisonTarget}_OUTPUT_HEADER)
219
      message(SEND_ERROR "Bison target `${BisonTarget}' does not exist.")
220
    endif()
221

222
    set_source_files_properties(${FLEX_${FlexTarget}_OUTPUTS}
223
      PROPERTIES OBJECT_DEPENDS ${BISON_${BisonTarget}_OUTPUT_HEADER})
224
  endmacro()
225 226
  #============================================================

227
endif()
228

229
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
230 231
FIND_PACKAGE_HANDLE_STANDARD_ARGS(FLEX REQUIRED_VARS FLEX_EXECUTABLE
                                       VERSION_VAR FLEX_VERSION)
232 233

# FindFLEX.cmake ends here