diff --git a/dserial-cli/cmake/README.rst b/dserial-cli/cmake/README.rst new file mode 100644 index 0000000000000000000000000000000000000000..e332c54dcb0fdd4157d8d8be7e52eac60924ac61 --- /dev/null +++ b/dserial-cli/cmake/README.rst @@ -0,0 +1,182 @@ +========== +Vala CMake +========== +:Author: + Jakob Westhoff +:Version: + Draft + + +Overview +======== + +Vala CMake is a collection of macros for the CMake_ build system to allow the +creation and management of projects developed using the Vala_ programming +language or its "Genie" flavor (less tested). + + +Installation +============ + +To use the Vala macros in your own project you need to copy the macro files to +an arbitrary folder in your projects directory and reference them in your +``CMakeLists.txt`` file. + +Assuming the macros are stored under ``cmake/vala`` in your projects folder you +need to add the following information to your base ``CMakeLists.txt``:: + + list(APPEND CMAKE_MODULE_PATH + ${CMAKE_SOURCE_DIR}/cmake/vala + ) + +After the new module path as been added you can simply include the provided +modules or use the provided find routines. + + +Finding Vala +============ + +The find module for vala works like any other Find module in CMake. +You can use it by simply calling the usual ``find_package`` function. Default +parameters like ``REQUIRED`` and ``QUIETLY`` are supported. + +:: + + find_package(Vala REQUIRED) + +After a successful call to the find_package function the following variables +will be set: + +VALA_FOUND + Whether the vala compiler has been found or not + +VALA_EXECUTABLE + Full path to the valac executable if it has been found + +VALA_VERSION + Version number of the available valac + + +Precompiling Vala sources +========================= + +CMake is mainly supposed to handle c or c++ based projects. Luckily every vala +program is translated into plain c code using the vala compiler, followed by +normal compilation of the generated c program using gcc. + +The macro ``vala_precompile`` uses that fact to create c files from your .vala +sources for further CMake processing. + +The first parameter provided is a variable, which will be filled with a list of +c files outputted by the vala compiler. This list can than be used in +conjunction with functions like ``add_executable`` or others to create the +necessary compile rules with CMake. + +The initial variable is followed by a list of .vala files to be compiled. +Please take care to add every vala file belonging to the currently compiled +project or library as Vala will otherwise not be able to resolve all +dependencies. + +The following sections may be specified afterwards to provide certain options +to the vala compiler: + +PACKAGES + A list of vala packages/libraries to be used during the compile cycle. The + package names are exactly the same, as they would be passed to the valac + "--pkg=" option. + +OPTIONS + A list of optional options to be passed to the valac executable. This can be + used to pass "--thread" for example to enable multi-threading support. + +DIRECTORY + Specify the directory where the output source files will be stored. If + ommitted, the source files will be stored in CMAKE_CURRENT_BINARY_DIR. + +CUSTOM_VAPIS + A list of custom vapi files to be included for compilation. This can be + useful to include freshly created vala libraries without having to install + them in the system. + +GENERATE_VAPI + Pass all the needed flags to the compiler to create an internal vapi for + the compiled library. The provided name will be used for this and a + <provided_name>.vapi file will be created. + +GENERATE_HEADER + Let the compiler generate a header file for the compiled code. There will + be a header file as well as an internal header file being generated called + <provided_name>.h and <provided_name>_internal.h + +The following call is a simple example to the vala_precompile macro showing an +example to every of the optional sections:: + + vala_precompile(VALA_C + source1.vala + source2.vala + source3.vala + PACKAGES + gtk+-2.0 + gio-1.0 + posix + OPTIONS + --thread + CUSTOM_VAPIS + some_vapi.vapi + GENERATE_VAPI + myvapi + GENERATE_HEADER + myheader + ) + +Most important is the variable VALA_C which will contain all the generated c +file names after the call. The easiest way to use this information is to tell +CMake to create an executable out of it. + +:: + + add_executable(myexecutable ${VALA_C}) + +Building a debug build +====================== +In the section OPTIONS add the '-g' option. This will instruct the Vala compiler +to include the Vala source code line information in the compiled binary. Add the +'--save-temps' option to keep the temporary C source files. + +When running cmake add '-DCMAKE_BUILD_TYPE=Debug' option. After building the +program, it can then be debugged with ``gdb`` or ``nemiver``. + + +Further reading +=============== + +The `Pdf Presenter Console`__ , which is a vala based project of mine, makes +heavy usage of the here described macros. To look at a real world example of +these macros the mentioned project is the right place to take a look. The svn +trunk of it can be found at:: + + svn://pureenergy.cc/pdf_presenter_console/trunk + + +__ http://westhoffswelt.de/projects/pdf_presenter_console.html + + +Acknowledgments +=============== + +Thanks go out to Florian Sowade, a fellow local PHP-Usergroupie, who helped me +a lot with the initial version of this macros and always answered my mostly +dumb CMake questions. + +.. _CMake: http://cmake.org +.. _Vala: http://live.gnome.org/Vala +.. _Genie: http://live.gnome.org/Genie + + + +.. + Local Variables: + mode: rst + fill-column: 79 + End: + vim: et syn=rst tw=79 diff --git a/dserial-cli/cmake/vala/FindVala.cmake b/dserial-cli/cmake/vala/FindVala.cmake new file mode 100644 index 0000000000000000000000000000000000000000..c8fcc51f4a10bd882c05a4078c9f6f27d9d6551a --- /dev/null +++ b/dserial-cli/cmake/vala/FindVala.cmake @@ -0,0 +1,70 @@ +## +# Find module for the Vala compiler (valac) +# +# This module determines wheter a Vala compiler is installed on the current +# system and where its executable is. +# +# Call the module using "find_package(Vala) from within your CMakeLists.txt. +# +# The following variables will be set after an invocation: +# +# VALA_FOUND Whether the vala compiler has been found or not +# VALA_EXECUTABLE Full path to the valac executable if it has been found +# VALA_VERSION Version number of the available valac +# VALA_USE_FILE Include this file to define the vala_precompile function +## + +## +# Copyright 2009-2010 Jakob Westhoff. All rights reserved. +# Copyright 2010-2011 Daniel Pfeifer +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# 1. Redistributions of source code must retain the above copyright notice, +# this list of conditions and the following disclaimer. +# +# 2. Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY JAKOB WESTHOFF ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +# MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO +# EVENT SHALL JAKOB WESTHOFF OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF +# ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# +# The views and conclusions contained in the software and documentation are those +# of the authors and should not be interpreted as representing official policies, +# either expressed or implied, of Jakob Westhoff +## + +# Search for the valac executable in the usual system paths +# Some distributions rename the valac to contain the major.minor in the binary name +find_program(VALA_EXECUTABLE NAMES valac valac-0.20 valac-0.18 valac-0.16 valac-0.14 valac-0.12 valac-0.10) +mark_as_advanced(VALA_EXECUTABLE) + +# Determine the valac version +if(VALA_EXECUTABLE) + execute_process(COMMAND ${VALA_EXECUTABLE} "--version" + OUTPUT_VARIABLE VALA_VERSION + OUTPUT_STRIP_TRAILING_WHITESPACE) + string(REPLACE "Vala " "" VALA_VERSION "${VALA_VERSION}") +endif(VALA_EXECUTABLE) + +# Handle the QUIETLY and REQUIRED arguments, which may be given to the find call. +# Furthermore set VALA_FOUND to TRUE if Vala has been found (aka. +# VALA_EXECUTABLE is set) + +include(FindPackageHandleStandardArgs) +find_package_handle_standard_args(Vala + REQUIRED_VARS VALA_EXECUTABLE + VERSION_VAR VALA_VERSION) + +set(VALA_USE_FILE "${CMAKE_CURRENT_LIST_DIR}/UseVala.cmake") + diff --git a/dserial-cli/cmake/vala/UseVala.cmake b/dserial-cli/cmake/vala/UseVala.cmake new file mode 100644 index 0000000000000000000000000000000000000000..ead9652d36159c5a05cbbe00f6e0418c2e711792 --- /dev/null +++ b/dserial-cli/cmake/vala/UseVala.cmake @@ -0,0 +1,192 @@ +## +# Compile vala files to their c equivalents for further processing. +# +# The "vala_precompile" function takes care of calling the valac executable on +# the given source to produce c files which can then be processed further using +# default cmake functions. +# +# The first parameter provided is a variable, which will be filled with a list +# of c files outputted by the vala compiler. This list can than be used in +# conjuction with functions like "add_executable" or others to create the +# neccessary compile rules with CMake. +# +# The following sections may be specified afterwards to provide certain options +# to the vala compiler: +# +# SOURCES +# A list of .vala files to be compiled. Please take care to add every vala +# file belonging to the currently compiled project or library as Vala will +# otherwise not be able to resolve all dependencies. +# +# PACKAGES +# A list of vala packages/libraries to be used during the compile cycle. The +# package names are exactly the same, as they would be passed to the valac +# "--pkg=" option. +# +# OPTIONS +# A list of optional options to be passed to the valac executable. This can be +# used to pass "--thread" for example to enable multi-threading support. +# +# DEFINITIONS +# A list of symbols to be used for conditional compilation. They are the same +# as they would be passed using the valac "--define=" option. +# +# CUSTOM_VAPIS +# A list of custom vapi files to be included for compilation. This can be +# useful to include freshly created vala libraries without having to install +# them in the system. +# +# GENERATE_VAPI +# Pass all the needed flags to the compiler to create a vapi for +# the compiled library. The provided name will be used for this and a +# <provided_name>.vapi file will be created. +# +# GENERATE_HEADER +# Let the compiler generate a header file for the compiled code. There will +# be a header file as well as an internal header file being generated called +# <provided_name>.h and <provided_name>_internal.h +# +# The following call is a simple example to the vala_precompile macro showing +# an example to every of the optional sections: +# +# find_package(Vala "0.12" REQUIRED) +# include(${VALA_USE_FILE}) +# +# vala_precompile(VALA_C +# SOURCES +# source1.vala +# source2.vala +# source3.vala +# PACKAGES +# gtk+-2.0 +# gio-1.0 +# posix +# DIRECTORY +# gen +# OPTIONS +# --thread +# CUSTOM_VAPIS +# some_vapi.vapi +# GENERATE_VAPI +# myvapi +# GENERATE_HEADER +# myheader +# ) +# +# Most important is the variable VALA_C which will contain all the generated c +# file names after the call. +## + +## +# Copyright 2009-2010 Jakob Westhoff. All rights reserved. +# Copyright 2010-2011 Daniel Pfeifer +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# 1. Redistributions of source code must retain the above copyright notice, +# this list of conditions and the following disclaimer. +# +# 2. Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions and the following disclaimer in the documentation +# and/or other materials provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY JAKOB WESTHOFF ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +# MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO +# EVENT SHALL JAKOB WESTHOFF OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF +# ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# +# The views and conclusions contained in the software and documentation are those +# of the authors and should not be interpreted as representing official policies, +# either expressed or implied, of Jakob Westhoff +## + +include(CMakeParseArguments) + +function(vala_precompile output) + cmake_parse_arguments(ARGS "" "DIRECTORY;GENERATE_HEADER;GENERATE_VAPI" + "SOURCES;PACKAGES;OPTIONS;DEFINITIONS;CUSTOM_VAPIS" ${ARGN}) + + if(ARGS_DIRECTORY) + get_filename_component(DIRECTORY ${ARGS_DIRECTORY} ABSOLUTE) + else(ARGS_DIRECTORY) + set(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}) + endif(ARGS_DIRECTORY) + include_directories(${DIRECTORY}) + + set(vala_pkg_opts "") + foreach(pkg ${ARGS_PACKAGES}) + list(APPEND vala_pkg_opts "--pkg=${pkg}") + endforeach(pkg ${ARGS_PACKAGES}) + + set(vala_define_opts "") + foreach(def ${ARGS_DEFINTIONS}) + list(APPEND vala_define_opts "--define=${def}") + endforeach(def ${ARGS_DEFINTIONS}) + + set(in_files "") + set(out_files "") + foreach(src ${ARGS_SOURCES} ${ARGS_UNPARSED_ARGUMENTS}) + list(APPEND in_files "${CMAKE_CURRENT_SOURCE_DIR}/${src}") + string(REPLACE ".vala" ".c" src ${src}) + string(REPLACE ".gs" ".c" src ${src}) + set(out_file "${DIRECTORY}/${src}") + list(APPEND out_files "${DIRECTORY}/${src}") + endforeach(src ${ARGS_SOURCES} ${ARGS_UNPARSED_ARGUMENTS}) + + set(custom_vapi_arguments "") + if(ARGS_CUSTOM_VAPIS) + foreach(vapi ${ARGS_CUSTOM_VAPIS}) + if(${vapi} MATCHES ${CMAKE_SOURCE_DIR} OR ${vapi} MATCHES ${CMAKE_BINARY_DIR}) + list(APPEND custom_vapi_arguments ${vapi}) + else (${vapi} MATCHES ${CMAKE_SOURCE_DIR} OR ${vapi} MATCHES ${CMAKE_BINARY_DIR}) + list(APPEND custom_vapi_arguments ${CMAKE_CURRENT_SOURCE_DIR}/${vapi}) + endif(${vapi} MATCHES ${CMAKE_SOURCE_DIR} OR ${vapi} MATCHES ${CMAKE_BINARY_DIR}) + endforeach(vapi ${ARGS_CUSTOM_VAPIS}) + endif(ARGS_CUSTOM_VAPIS) + + set(vapi_arguments "") + if(ARGS_GENERATE_VAPI) + list(APPEND out_files "${DIRECTORY}/${ARGS_GENERATE_VAPI}.vapi") + set(vapi_arguments "--vapi=${ARGS_GENERATE_VAPI}.vapi") + + # Header and internal header is needed to generate internal vapi + if (NOT ARGS_GENERATE_HEADER) + set(ARGS_GENERATE_HEADER ${ARGS_GENERATE_VAPI}) + endif(NOT ARGS_GENERATE_HEADER) + endif(ARGS_GENERATE_VAPI) + + set(header_arguments "") + if(ARGS_GENERATE_HEADER) + list(APPEND out_files "${DIRECTORY}/${ARGS_GENERATE_HEADER}.h") + list(APPEND out_files "${DIRECTORY}/${ARGS_GENERATE_HEADER}_internal.h") + list(APPEND header_arguments "--header=${DIRECTORY}/${ARGS_GENERATE_HEADER}.h") + list(APPEND header_arguments "--internal-header=${DIRECTORY}/${ARGS_GENERATE_HEADER}_internal.h") + endif(ARGS_GENERATE_HEADER) + + add_custom_command(OUTPUT ${out_files} + COMMAND + ${VALA_EXECUTABLE} + ARGS + "-C" + ${header_arguments} + ${vapi_arguments} + "-b" ${CMAKE_CURRENT_SOURCE_DIR} + "-d" ${DIRECTORY} + ${vala_pkg_opts} + ${vala_define_opts} + ${ARGS_OPTIONS} + ${in_files} + ${custom_vapi_arguments} + DEPENDS + ${in_files} + ${ARGS_CUSTOM_VAPIS} + ) + set(${output} ${out_files} PARENT_SCOPE) +endfunction(vala_precompile)