cmake/modules/AddOCaml.cmake

   1 # CMake build rules for the OCaml language.
   2 # Assumes FindOCaml is used.
   3 # http://ocaml.org/
   4 #
   5 # Example usage:
   6 #
   7 # add_ocaml_library(pkg_a OCAML mod_a OCAMLDEP pkg_b C mod_a_stubs PKG ctypes LLVM core)
   8 #
   9 # Unnamed parameters:
  10 #
  11 #   * Library name.
  12 #
  13 # Named parameters:
  14 #
  15 # OCAML     OCaml module names. Imply presence of a corresponding .ml and .mli files.
  16 # OCAMLDEP  Names of libraries this library depends on.
  17 # C         C stub sources. Imply presence of a corresponding .c file.
  18 # CFLAGS    Additional arguments passed when compiling C stubs.
  19 # PKG       Names of ocamlfind packages this library depends on.
  20 # LLVM      Names of LLVM libraries this library depends on.
  21 # NOCOPY    Do not automatically copy sources (.c, .ml, .mli) from the source directory,
  22 #           e.g. if they are generated.
  23 #
  24
  25 function(add_ocaml_library name)
  26   CMAKE_PARSE_ARGUMENTS(ARG "NOCOPY" "" "OCAML;OCAMLDEP;C;CFLAGS;PKG;LLVM" ${ARGN})
  27
  28   set(src ${CMAKE_CURRENT_SOURCE_DIR})
  29   set(bin ${CMAKE_CURRENT_BINARY_DIR})
  30
  31   set(ocaml_pkgs)
  32   foreach( ocaml_pkg ${ARG_PKG} )
  33     list(APPEND ocaml_pkgs "-package" "${ocaml_pkg}")
  34   endforeach()
  35
  36   set(sources)
  37
  38   set(ocaml_inputs)
  39
  40   set(ocaml_outputs "${bin}/${name}.cma")
  41   if( ARG_C )
  42     list(APPEND ocaml_outputs
  43          "${bin}/lib${name}${CMAKE_STATIC_LIBRARY_SUFFIX}")
  44     if ( BUILD_SHARED_LIBS )
  45       list(APPEND ocaml_outputs
  46            "${bin}/dll${name}${CMAKE_SHARED_LIBRARY_SUFFIX}")
  47     endif()
  48   endif()
  49   if( HAVE_OCAMLOPT )
  50     list(APPEND ocaml_outputs
  51          "${bin}/${name}.cmxa"
  52          "${bin}/${name}${CMAKE_STATIC_LIBRARY_SUFFIX}")
  53   endif()
  54
  55   set(ocaml_flags "-lstdc++" "-ldopt" "-L${LLVM_LIBRARY_DIR}"
  56                   "-ccopt" "-L\\$CAMLORIGIN/../.."
  57                   "-ccopt" "-Wl,-rpath,\\$CAMLORIGIN/../.."
  58                   ${ocaml_pkgs})
  59
  60   foreach( ocaml_dep ${ARG_OCAMLDEP} )
  61     get_target_property(dep_ocaml_flags "ocaml_${ocaml_dep}" OCAML_FLAGS)
  62     list(APPEND ocaml_flags ${dep_ocaml_flags})
  63   endforeach()
  64
  65   if( NOT BUILD_SHARED_LIBS )
  66     list(APPEND ocaml_flags "-custom")
  67   endif()
  68
  69   if(LLVM_LINK_LLVM_DYLIB)
  70     list(APPEND ocaml_flags "-lLLVM")
  71   else()
  72     explicit_map_components_to_libraries(llvm_libs ${ARG_LLVM})
  73     foreach( llvm_lib ${llvm_libs} )
  74       list(APPEND ocaml_flags "-l${llvm_lib}" )
  75     endforeach()
  76
  77     get_property(system_libs TARGET LLVMSupport PROPERTY LLVM_SYSTEM_LIBS)
  78     foreach(system_lib ${system_libs})
  79       if (system_lib MATCHES "^-")
  80         # If it's an option, pass it without changes.
  81         list(APPEND ocaml_flags "${system_lib}" )
  82       else()
  83         # Otherwise assume it's a library name we need to link with.
  84         list(APPEND ocaml_flags "-l${system_lib}" )
  85       endif()
  86     endforeach()
  87   endif()
  88
  89   string(REPLACE ";" " " ARG_CFLAGS "${ARG_CFLAGS}")
  90   set(c_flags "${ARG_CFLAGS} ${LLVM_DEFINITIONS}")
  91   foreach( include_dir ${LLVM_INCLUDE_DIR} ${LLVM_MAIN_INCLUDE_DIR} )
  92     set(c_flags "${c_flags} -I${include_dir}")
  93   endforeach()
  94   # include -D/-UNDEBUG to match dump function visibility
  95   # regex from HandleLLVMOptions.cmake
  96   string(REGEX MATCH "(^| )[/-][UD] *NDEBUG($| )" flag_matches
  97          "${CMAKE_C_FLAGS_${uppercase_CMAKE_BUILD_TYPE}} ${CMAKE_C_FLAGS}")
  98   set(c_flags "${c_flags} ${flag_matches}")
  99
 100   foreach( ocaml_file ${ARG_OCAML} )
 101     list(APPEND sources "${ocaml_file}.mli" "${ocaml_file}.ml")
 102
 103     list(APPEND ocaml_inputs "${bin}/${ocaml_file}.mli" "${bin}/${ocaml_file}.ml")
 104
 105     list(APPEND ocaml_outputs "${bin}/${ocaml_file}.cmi" "${bin}/${ocaml_file}.cmo")
 106     if( HAVE_OCAMLOPT )
 107       list(APPEND ocaml_outputs
 108            "${bin}/${ocaml_file}.cmx"
 109            "${bin}/${ocaml_file}${CMAKE_C_OUTPUT_EXTENSION}")
 110     endif()
 111   endforeach()
 112
 113   foreach( c_file ${ARG_C} )
 114     list(APPEND sources "${c_file}.c")
 115
 116     list(APPEND c_inputs  "${bin}/${c_file}.c")
 117     list(APPEND c_outputs "${bin}/${c_file}${CMAKE_C_OUTPUT_EXTENSION}")
 118   endforeach()
 119
 120   if( NOT ARG_NOCOPY )
 121     foreach( source ${sources} )
 122       add_custom_command(
 123           OUTPUT "${bin}/${source}"
 124           COMMAND "${CMAKE_COMMAND}" "-E" "copy" "${src}/${source}" "${bin}"
 125           DEPENDS "${src}/${source}"
 126           COMMENT "Copying ${source} to build area")
 127     endforeach()
 128   endif()
 129
 130   foreach( c_input ${c_inputs} )
 131     get_filename_component(basename "${c_input}" NAME_WE)
 132     add_custom_command(
 133       OUTPUT "${basename}${CMAKE_C_OUTPUT_EXTENSION}"
 134       COMMAND "${OCAMLFIND}" "ocamlc" "-c" "${c_input}" -ccopt ${c_flags}
 135       DEPENDS "${c_input}"
 136       COMMENT "Building OCaml stub object file ${basename}${CMAKE_C_OUTPUT_EXTENSION}"
 137       VERBATIM)
 138   endforeach()
 139
 140   set(ocaml_params)
 141   foreach( ocaml_input ${ocaml_inputs} ${c_outputs})
 142     get_filename_component(filename "${ocaml_input}" NAME)
 143     list(APPEND ocaml_params "${filename}")
 144   endforeach()
 145
 146   if( APPLE )
 147     set(ocaml_rpath "@executable_path/../../../lib${LLVM_LIBDIR_SUFFIX}")
 148   elseif( UNIX )
 149     set(ocaml_rpath "\\$ORIGIN/../../../lib${LLVM_LIBDIR_SUFFIX}")
 150   endif()
 151   list(APPEND ocaml_flags "-ldopt" "-Wl,-rpath,${ocaml_rpath}")
 152
 153   add_custom_command(
 154     OUTPUT ${ocaml_outputs}
 155     COMMAND "${OCAMLFIND}" "ocamlmklib" "-o" "${name}" ${ocaml_flags} ${ocaml_params}
 156     DEPENDS ${ocaml_inputs} ${c_outputs}
 157     COMMENT "Building OCaml library ${name}"
 158     VERBATIM)
 159
 160   add_custom_command(
 161     OUTPUT "${bin}/${name}.odoc"
 162     COMMAND "${OCAMLFIND}" "ocamldoc"
 163             "-I" "${bin}"
 164             "-I" "${LLVM_LIBRARY_DIR}/ocaml/llvm/"
 165             "-dump" "${bin}/${name}.odoc"
 166             ${ocaml_pkgs} ${ocaml_inputs}
 167     DEPENDS ${ocaml_inputs} ${ocaml_outputs}
 168     COMMENT "Building OCaml documentation for ${name}"
 169     VERBATIM)
 170
 171   add_custom_target("ocaml_${name}" ALL DEPENDS ${ocaml_outputs} "${bin}/${name}.odoc")
 172
 173   set_target_properties("ocaml_${name}" PROPERTIES
 174     OCAML_FLAGS "-I;${bin}")
 175   set_target_properties("ocaml_${name}" PROPERTIES
 176     OCAML_ODOC "${bin}/${name}.odoc")
 177
 178   foreach( ocaml_dep ${ARG_OCAMLDEP} )
 179     add_dependencies("ocaml_${name}" "ocaml_${ocaml_dep}")
 180   endforeach()
 181
 182   if( NOT LLVM_OCAML_OUT_OF_TREE )
 183     foreach( llvm_lib ${llvm_libs} )
 184       add_dependencies("ocaml_${name}" "${llvm_lib}")
 185     endforeach()
 186   endif()
 187
 188   add_dependencies("ocaml_all" "ocaml_${name}")
 189
 190   set(install_files)
 191   set(install_shlibs)
 192   foreach( ocaml_output ${ocaml_inputs} ${ocaml_outputs} )
 193     get_filename_component(ext "${ocaml_output}" EXT)
 194
 195     if( NOT (ext STREQUAL ".cmo" OR
 196              ext STREQUAL ".ml" OR
 197              ext STREQUAL CMAKE_C_OUTPUT_EXTENSION OR
 198              ext STREQUAL CMAKE_SHARED_LIBRARY_SUFFIX) )
 199       list(APPEND install_files "${ocaml_output}")
 200     elseif( ext STREQUAL CMAKE_SHARED_LIBRARY_SUFFIX)
 201       list(APPEND install_shlibs "${ocaml_output}")
 202     endif()
 203   endforeach()
 204
 205   install(FILES ${install_files}
 206           DESTINATION "${LLVM_OCAML_INSTALL_PATH}/llvm")
 207   install(FILES ${install_shlibs}
 208           PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE
 209                       GROUP_READ GROUP_EXECUTE
 210                       WORLD_READ WORLD_EXECUTE
 211           DESTINATION "${LLVM_OCAML_INSTALL_PATH}/stublibs")
 212
 213   foreach( install_file ${install_files} ${install_shlibs} )
 214     get_filename_component(filename "${install_file}" NAME)
 215     add_custom_command(TARGET "ocaml_${name}" POST_BUILD
 216       COMMAND "${CMAKE_COMMAND}" "-E" "copy" "${install_file}"
 217                                              "${LLVM_LIBRARY_DIR}/ocaml/llvm/"
 218       COMMENT "Copying OCaml library component ${filename} to intermediate area"
 219       VERBATIM)
 220     add_dependencies("ocaml_${name}" ocaml_make_directory)
 221   endforeach()
 222 endfunction()
 223
 224 add_custom_target(ocaml_make_directory
 225   COMMAND "${CMAKE_COMMAND}" "-E" "make_directory" "${LLVM_LIBRARY_DIR}/ocaml/llvm")
 226 add_custom_target("ocaml_all")
 227 set_target_properties(ocaml_all PROPERTIES FOLDER "Misc")
 228 set_target_properties(ocaml_make_directory PROPERTIES FOLDER "Misc")