kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
CMake/Modules/FortranCInterface.cmake

392 lines
14 KiB
CMake
Raw Permalink Normal View History

Simplify CMake per-source license notices Per-source copyright/license notice headers that spell out copyright holder names and years are hard to maintain and often out-of-date or plain wrong. Precise contributor information is already maintained automatically by the version control tool. Ultimately it is the receiver of a file who is responsible for determining its licensing status, and per-source notices are merely a convenience. Therefore it is simpler and more accurate for each source to have a generic notice of the license name and references to more detailed information on copyright holders and full license terms. Our `Copyright.txt` file now contains a list of Contributors whose names appeared source-level copyright notices. It also references version control history for more precise information. Therefore we no longer need to spell out the list of Contributors in each source file notice. Replace CMake per-source copyright/license notice headers with a short description of the license and links to `Copyright.txt` and online information available from "https://cmake.org/licensing". The online URL also handles cases of modules being copied out of our source into other projects, so we can drop our notices about replacing links with full license text. Run the `Utilities/Scripts/filter-notices.bash` script to perform the majority of the replacements mechanically. Manually fix up shebang lines and trailing newlines in a few files. Manually update the notices in a few files that the script does not handle.
2016-09-27 22:01:08 +03:00
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
# file Copyright.txt or https://cmake.org/licensing for details.
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
#[=======================================================================[.rst:
FortranCInterface
-----------------
Fortran/C Interface Detection
This module automatically detects the API by which C and Fortran
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
languages interact.
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
Module Variables
^^^^^^^^^^^^^^^^
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
Variables that indicate if the mangling is found:
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
``FortranCInterface_GLOBAL_FOUND``
Global subroutines and functions.
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
``FortranCInterface_MODULE_FOUND``
Module subroutines and functions (declared by "MODULE PROCEDURE").
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Document mangling result variables publicly Some projects may want to use the detailed mangling information directly instead of using the FortranCInterface_HEADER function. We already provide variables encoding the mangling information, so just document them as available.
2016-02-10 18:35:48 +03:00
This module also provides the following variables to specify
the detected mangling, though a typical use case does not need
to reference them and can use the `Module Functions`_ below.
``FortranCInterface_GLOBAL_PREFIX``
Prefix for a global symbol without an underscore.
``FortranCInterface_GLOBAL_SUFFIX``
Suffix for a global symbol without an underscore.
``FortranCInterface_GLOBAL_CASE``
The case for a global symbol without an underscore,
either ``UPPER`` or ``LOWER``.
``FortranCInterface_GLOBAL__PREFIX``
Prefix for a global symbol with an underscore.
``FortranCInterface_GLOBAL__SUFFIX``
Suffix for a global symbol with an underscore.
``FortranCInterface_GLOBAL__CASE``
The case for a global symbol with an underscore,
either ``UPPER`` or ``LOWER``.
``FortranCInterface_MODULE_PREFIX``
Prefix for a module symbol without an underscore.
``FortranCInterface_MODULE_MIDDLE``
Middle of a module symbol without an underscore that appears
between the name of the module and the name of the symbol.
``FortranCInterface_MODULE_SUFFIX``
Suffix for a module symbol without an underscore.
``FortranCInterface_MODULE_CASE``
The case for a module symbol without an underscore,
either ``UPPER`` or ``LOWER``.
``FortranCInterface_MODULE__PREFIX``
Prefix for a module symbol with an underscore.
``FortranCInterface_MODULE__MIDDLE``
Middle of a module symbol with an underscore that appears
between the name of the module and the name of the symbol.
``FortranCInterface_MODULE__SUFFIX``
Suffix for a module symbol with an underscore.
``FortranCInterface_MODULE__CASE``
The case for a module symbol with an underscore,
either ``UPPER`` or ``LOWER``.
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
Module Functions
^^^^^^^^^^^^^^^^
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
.. command:: FortranCInterface_HEADER
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
The ``FortranCInterface_HEADER`` function is provided to generate a
C header file containing macros to mangle symbol names::
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
FortranCInterface_HEADER(<file>
[MACRO_NAMESPACE <macro-ns>]
[SYMBOL_NAMESPACE <ns>]
[SYMBOLS [<module>:]<function> ...])
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
It generates in ``<file>`` definitions of the following macros::
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
#define FortranCInterface_GLOBAL (name,NAME) ...
#define FortranCInterface_GLOBAL_(name,NAME) ...
#define FortranCInterface_MODULE (mod,name, MOD,NAME) ...
#define FortranCInterface_MODULE_(mod,name, MOD,NAME) ...
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
These macros mangle four categories of Fortran symbols, respectively:
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
* Global symbols without '_': ``call mysub()``
* Global symbols with '_' : ``call my_sub()``
* Module symbols without '_': ``use mymod; call mysub()``
* Module symbols with '_' : ``use mymod; call my_sub()``
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
If mangling for a category is not known, its macro is left undefined.
All macros require raw names in both lower case and upper case.
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
The options are:
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
``MACRO_NAMESPACE``
Replace the default ``FortranCInterface_`` prefix with a given
namespace ``<macro-ns>``.
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
``SYMBOLS``
List symbols to mangle automatically with C preprocessor definitions::
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
<function> ==> #define <ns><function> ...
<module>:<function> ==> #define <ns><module>_<function> ...
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
If the mangling for some symbol is not known then no preprocessor
definition is created, and a warning is displayed.
``SYMBOL_NAMESPACE``
Prefix all preprocessor definitions generated by the ``SYMBOLS``
option with a given namespace ``<ns>``.
.. command:: FortranCInterface_VERIFY
The ``FortranCInterface_VERIFY`` function is provided to verify
that the Fortran and C/C++ compilers work together::
FortranCInterface_VERIFY([CXX] [QUIET])
It tests whether a simple test executable using Fortran and C (and C++
when the CXX option is given) compiles and links successfully. The
result is stored in the cache entry ``FortranCInterface_VERIFIED_C``
(or ``FortranCInterface_VERIFIED_CXX`` if ``CXX`` is given) as a boolean.
If the check fails and ``QUIET`` is not given the function terminates with a
fatal error message describing the problem. The purpose of this check
is to stop a build early for incompatible compiler combinations. The
test is built in the ``Release`` configuration.
Example Usage
^^^^^^^^^^^^^
.. code-block:: cmake
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
include(FortranCInterface)
FortranCInterface_HEADER(FC.h MACRO_NAMESPACE "FC_")
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
This creates a "FC.h" header that defines mangling macros ``FC_GLOBAL()``,
``FC_GLOBAL_()``, ``FC_MODULE()``, and ``FC_MODULE_()``.
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
.. code-block:: cmake
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
include(FortranCInterface)
FortranCInterface_HEADER(FCMangle.h
MACRO_NAMESPACE "FC_"
SYMBOL_NAMESPACE "FC_"
SYMBOLS mysub mymod:my_sub)
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
This creates a "FCMangle.h" header that defines the same ``FC_*()``
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
mangling macros as the previous example plus preprocessor symbols
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
``FC_mysub`` and ``FC_mymod_my_sub``.
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
Additional Manglings
^^^^^^^^^^^^^^^^^^^^
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
FortranCInterface is aware of possible ``GLOBAL`` and ``MODULE`` manglings
for many Fortran compilers, but it also provides an interface to specify
new possible manglings. Set the variables::
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface_GLOBAL_SYMBOLS
FortranCInterface_MODULE_SYMBOLS
before including FortranCInterface to specify manglings of the symbols
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
``MySub``, ``My_Sub``, ``MyModule:MySub``, and ``My_Module:My_Sub``.
For example, the code:
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
.. code-block:: cmake
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
set(FortranCInterface_GLOBAL_SYMBOLS mysub_ my_sub__ MYSUB_)
# ^^^^^ ^^^^^^ ^^^^^
set(FortranCInterface_MODULE_SYMBOLS
__mymodule_MOD_mysub __my_module_MOD_my_sub)
# ^^^^^^^^ ^^^^^ ^^^^^^^^^ ^^^^^^
include(FortranCInterface)
FortranCInterface: Improve documentation formatting and organization Organize content into sections. Define functions via explicit markup blocks so we can cross-reference them.
2016-02-10 00:43:27 +03:00
tells FortranCInterface to try given ``GLOBAL`` and ``MODULE`` manglings.
FortranCInterface: Convert docs to a bracket comment Use a bracket comment to hold the documentation instead of a block of line comments. This will make further updates easier.
2016-02-10 00:38:20 +03:00
(The carets point at raw symbol names for clarity in this example but
are not needed.)
#]=======================================================================]
Rewrite FortranCInterface module This is a new FortranCInterface.cmake module to replace the previous prototype. All module support files lie in a FortranCInterface directory next to it. This module uses a new approach to detect Fortran symbol mangling. We build a single test project which defines symbols in a Fortran library (one per object-file) and calls them from a Fortran executable. The executable links to a C library which defines symbols encoding all known manglings (one per object-file). The C library falls back to the Fortran library for symbols it cannot provide. Therefore the executable will always link, but prefers the C-implemented symbols when they match. These symbols store string literals of the form INFO:symbol[<name>] so we can parse them out of the executable. This module also provides a simpler interface. It always detects the mangling as soon as it is included. A single macro is provided to generate mangling macros and optionally pre-mangled symbols.
2009-08-05 21:40:29 +04:00
#-----------------------------------------------------------------------------
# Execute at most once in a project.
if(FortranCInterface_SOURCE_DIR)
return()
endif()
FortranCInterface: Use CMake 2.8.0 behavior The FortranCInterface module should execute with CMake 2.8.0 behavior even if policies are set differently by the including project. In particular, it makes use of empty list elements and therefore expects NEW behavior of CMP0007.
2009-11-17 22:33:28 +03:00
cmake_policy(PUSH)
FortranCInterface: Do not use cmake_policy(VERSION) Do not force a specific policy version in the module because it prevents projects from setting newer policies to NEW. In particular, projects may want to set CMP0056 to NEW to affect any try_compile calls in this module. Use of this was added in commit v2.8.2~714 (FortranCInterface: Use CMake 2.8.0 behavior, 2009-11-17) in order to set CMP0007 to NEW. Simply set this policy explicitly instead.
2015-05-19 19:59:26 +03:00
cmake_policy(SET CMP0007 NEW)
FortranCInterface: Use CMake 2.8.0 behavior The FortranCInterface module should execute with CMake 2.8.0 behavior even if policies are set differently by the including project. In particular, it makes use of empty list elements and therefore expects NEW behavior of CMP0007.
2009-11-17 22:33:28 +03:00
Teach FortranCInterface to verify languages This module requires both C and Fortran to be enabled, so error-out if they are not.
2009-08-21 00:21:53 +04:00
#-----------------------------------------------------------------------------
# Verify that C and Fortran are available.
foreach(lang C Fortran)
if(NOT CMAKE_${lang}_COMPILER_LOADED)
message(FATAL_ERROR
"FortranCInterface requires the ${lang} language to be enabled.")
endif()
endforeach()
Rewrite FortranCInterface module This is a new FortranCInterface.cmake module to replace the previous prototype. All module support files lie in a FortranCInterface directory next to it. This module uses a new approach to detect Fortran symbol mangling. We build a single test project which defines symbols in a Fortran library (one per object-file) and calls them from a Fortran executable. The executable links to a C library which defines symbols encoding all known manglings (one per object-file). The C library falls back to the Fortran library for symbols it cannot provide. Therefore the executable will always link, but prefers the C-implemented symbols when they match. These symbols store string literals of the form INFO:symbol[<name>] so we can parse them out of the executable. This module also provides a simpler interface. It always detects the mangling as soon as it is included. A single macro is provided to generate mangling macros and optionally pre-mangled symbols.
2009-08-05 21:40:29 +04:00
#-----------------------------------------------------------------------------
set(FortranCInterface_SOURCE_DIR ${CMAKE_ROOT}/Modules/FortranCInterface)
FortranCInterface: Work around mingw32-make trouble with parens The mingw32-make tool does not handle parenthesis in the path to a source file consistently. When CMake is installed in a typical location like "c:\Program Files (x86)\CMake 2.8\" the mingw32-make tool fails on the FortranCInterface detection project sometimes with errors like >mingw32-make -f CMakeFiles\myfort.dir\build.make CMakeFiles/myfort.dir/my_module.f90.obj mingw32-make: *** No rule to make target `x86)/CMake 2.8/share/cmake-2.8/Modules/FortranCInterface/my_module.f90)', needed by `CMakeFiles/myfort.dir/my_module.f90.obj'. Stop. due to parens in the path to the FortranCInterface source directory. However, the behavior varies with the file name of build.make: >copy CMakeFiles\myfort.dir\build.make CMakeFiles\myfort.dir\build2.make >mingw32-make -f CMakeFiles\myfort.dir\build2.make CMakeFiles/myfort.dir/my_module.f90.obj [ 3%] Building Fortran object CMakeFiles/myfort.dir/my_module.f90.obj Tested with >mingw32-make -v GNU Make 3.82 Built for i386-pc-mingw32 Work around the problem by copying the whole FortranCInterface source directory in to the project build tree.
2011-12-09 18:37:46 +04:00
# MinGW's make tool does not always like () in the path
if("${CMAKE_GENERATOR}" MATCHES "MinGW" AND
"${FortranCInterface_SOURCE_DIR}" MATCHES "[()]")
file(COPY ${FortranCInterface_SOURCE_DIR}/
DESTINATION ${CMAKE_BINARY_DIR}/CMakeFiles/FortranCInterfaceMinGW)
set(FortranCInterface_SOURCE_DIR ${CMAKE_BINARY_DIR}/CMakeFiles/FortranCInterfaceMinGW)
endif()
Teach FortranCInterface to load outside results We split the main detection logic into a Detect.cmake support module and load it only when detection results are not already available. This allows results computed by the main project to be used in try-compile projects without recomputing them. The call to try_compile() need only to pass FortranCInterface_BINARY_DIR through the CMAKE_FLAGS option.
2009-08-24 16:49:07 +04:00
# Create the interface detection project if it does not exist.
if(NOT FortranCInterface_BINARY_DIR)
set(FortranCInterface_BINARY_DIR ${CMAKE_BINARY_DIR}/CMakeFiles/FortranCInterface)
include(${FortranCInterface_SOURCE_DIR}/Detect.cmake)
Rewrite FortranCInterface module This is a new FortranCInterface.cmake module to replace the previous prototype. All module support files lie in a FortranCInterface directory next to it. This module uses a new approach to detect Fortran symbol mangling. We build a single test project which defines symbols in a Fortran library (one per object-file) and calls them from a Fortran executable. The executable links to a C library which defines symbols encoding all known manglings (one per object-file). The C library falls back to the Fortran library for symbols it cannot provide. Therefore the executable will always link, but prefers the C-implemented symbols when they match. These symbols store string literals of the form INFO:symbol[<name>] so we can parse them out of the executable. This module also provides a simpler interface. It always detects the mangling as soon as it is included. A single macro is provided to generate mangling macros and optionally pre-mangled symbols.
2009-08-05 21:40:29 +04:00
endif()
# Load the detection results.
include(${FortranCInterface_BINARY_DIR}/Output.cmake)
#-----------------------------------------------------------------------------
function(FortranCInterface_HEADER file)
# Parse arguments.
if(IS_ABSOLUTE "${file}")
set(FILE "${file}")
else()
set(FILE "${CMAKE_CURRENT_BINARY_DIR}/${file}")
endif()
set(MACRO_NAMESPACE "FortranCInterface_")
set(SYMBOL_NAMESPACE)
set(SYMBOLS)
set(doing)
foreach(arg ${ARGN})
if("x${arg}" MATCHES "^x(SYMBOLS|SYMBOL_NAMESPACE|MACRO_NAMESPACE)$")
set(doing "${arg}")
elseif("x${doing}" MATCHES "^x(SYMBOLS)$")
list(APPEND "${doing}" "${arg}")
elseif("x${doing}" MATCHES "^x(SYMBOL_NAMESPACE|MACRO_NAMESPACE)$")
set("${doing}" "${arg}")
set(doing)
else()
message(AUTHOR_WARNING "Unknown argument: \"${arg}\"")
endif()
endforeach()
# Generate macro definitions.
set(HEADER_CONTENT)
set(_desc_GLOBAL "/* Mangling for Fortran global symbols without underscores. */")
set(_desc_GLOBAL_ "/* Mangling for Fortran global symbols with underscores. */")
set(_desc_MODULE "/* Mangling for Fortran module symbols without underscores. */")
set(_desc_MODULE_ "/* Mangling for Fortran module symbols with underscores. */")
foreach(macro GLOBAL GLOBAL_ MODULE MODULE_)
if(FortranCInterface_${macro}_MACRO)
Use string(APPEND) in Modules Automate with: find Modules -type f -print0 | xargs -0 perl -i -0pe \ 's/set\(([a-zA-Z0-9_]+)(\s+)"\$\{\1\}([^"])/string(APPEND \1\2"\3/g'
2016-07-28 01:41:13 +03:00
string(APPEND HEADER_CONTENT "
Rewrite FortranCInterface module This is a new FortranCInterface.cmake module to replace the previous prototype. All module support files lie in a FortranCInterface directory next to it. This module uses a new approach to detect Fortran symbol mangling. We build a single test project which defines symbols in a Fortran library (one per object-file) and calls them from a Fortran executable. The executable links to a C library which defines symbols encoding all known manglings (one per object-file). The C library falls back to the Fortran library for symbols it cannot provide. Therefore the executable will always link, but prefers the C-implemented symbols when they match. These symbols store string literals of the form INFO:symbol[<name>] so we can parse them out of the executable. This module also provides a simpler interface. It always detects the mangling as soon as it is included. A single macro is provided to generate mangling macros and optionally pre-mangled symbols.
2009-08-05 21:40:29 +04:00
${_desc_${macro}}
#define ${MACRO_NAMESPACE}${macro}${FortranCInterface_${macro}_MACRO}
ENH: add support for module functions
2008-10-28 04:42:41 +03:00
")
Rewrite FortranCInterface module This is a new FortranCInterface.cmake module to replace the previous prototype. All module support files lie in a FortranCInterface directory next to it. This module uses a new approach to detect Fortran symbol mangling. We build a single test project which defines symbols in a Fortran library (one per object-file) and calls them from a Fortran executable. The executable links to a C library which defines symbols encoding all known manglings (one per object-file). The C library falls back to the Fortran library for symbols it cannot provide. Therefore the executable will always link, but prefers the C-implemented symbols when they match. These symbols store string literals of the form INFO:symbol[<name>] so we can parse them out of the executable. This module also provides a simpler interface. It always detects the mangling as soon as it is included. A single macro is provided to generate mangling macros and optionally pre-mangled symbols.
2009-08-05 21:40:29 +04:00
endif()
endforeach()
# Generate symbol mangling definitions.
if(SYMBOLS)
Use string(APPEND) in Modules Automate with: find Modules -type f -print0 | xargs -0 perl -i -0pe \ 's/set\(([a-zA-Z0-9_]+)(\s+)"\$\{\1\}([^"])/string(APPEND \1\2"\3/g'
2016-07-28 01:41:13 +03:00
string(APPEND HEADER_CONTENT "
Rewrite FortranCInterface module This is a new FortranCInterface.cmake module to replace the previous prototype. All module support files lie in a FortranCInterface directory next to it. This module uses a new approach to detect Fortran symbol mangling. We build a single test project which defines symbols in a Fortran library (one per object-file) and calls them from a Fortran executable. The executable links to a C library which defines symbols encoding all known manglings (one per object-file). The C library falls back to the Fortran library for symbols it cannot provide. Therefore the executable will always link, but prefers the C-implemented symbols when they match. These symbols store string literals of the form INFO:symbol[<name>] so we can parse them out of the executable. This module also provides a simpler interface. It always detects the mangling as soon as it is included. A single macro is provided to generate mangling macros and optionally pre-mangled symbols.
2009-08-05 21:40:29 +04:00
/*--------------------------------------------------------------------------*/
/* Mangle some symbols automatically. */
ENH: add fortran link discovery module
2008-10-27 22:23:14 +03:00
")
Rewrite FortranCInterface module This is a new FortranCInterface.cmake module to replace the previous prototype. All module support files lie in a FortranCInterface directory next to it. This module uses a new approach to detect Fortran symbol mangling. We build a single test project which defines symbols in a Fortran library (one per object-file) and calls them from a Fortran executable. The executable links to a C library which defines symbols encoding all known manglings (one per object-file). The C library falls back to the Fortran library for symbols it cannot provide. Therefore the executable will always link, but prefers the C-implemented symbols when they match. These symbols store string literals of the form INFO:symbol[<name>] so we can parse them out of the executable. This module also provides a simpler interface. It always detects the mangling as soon as it is included. A single macro is provided to generate mangling macros and optionally pre-mangled symbols.
2009-08-05 21:40:29 +04:00
endif()
foreach(f ${SYMBOLS})
if("${f}" MATCHES ":")
# Module symbol name. Parse "<module>:<function>" syntax.
string(REPLACE ":" ";" pieces "${f}")
list(GET pieces 0 module)
list(GET pieces 1 function)
string(TOUPPER "${module}" m_upper)
string(TOLOWER "${module}" m_lower)
string(TOUPPER "${function}" f_upper)
string(TOLOWER "${function}" f_lower)
if("${function}" MATCHES "_")
set(form "_")
else()
set(form "")
endif()
if(FortranCInterface_MODULE${form}_MACRO)
Use string(APPEND) in Modules Automate with: find Modules -type f -print0 | xargs -0 perl -i -0pe \ 's/set\(([a-zA-Z0-9_]+)(\s+)"\$\{\1\}([^"])/string(APPEND \1\2"\3/g'
2016-07-28 01:41:13 +03:00
string(APPEND HEADER_CONTENT "#define ${SYMBOL_NAMESPACE}${module}_${function} ${MACRO_NAMESPACE}MODULE${form}(${m_lower},${f_lower}, ${m_upper},${f_upper})\n")
Rewrite FortranCInterface module This is a new FortranCInterface.cmake module to replace the previous prototype. All module support files lie in a FortranCInterface directory next to it. This module uses a new approach to detect Fortran symbol mangling. We build a single test project which defines symbols in a Fortran library (one per object-file) and calls them from a Fortran executable. The executable links to a C library which defines symbols encoding all known manglings (one per object-file). The C library falls back to the Fortran library for symbols it cannot provide. Therefore the executable will always link, but prefers the C-implemented symbols when they match. These symbols store string literals of the form INFO:symbol[<name>] so we can parse them out of the executable. This module also provides a simpler interface. It always detects the mangling as soon as it is included. A single macro is provided to generate mangling macros and optionally pre-mangled symbols.
2009-08-05 21:40:29 +04:00
else()
message(AUTHOR_WARNING "No FortranCInterface mangling known for ${f}")
endif()
else()
# Global symbol name.
if("${f}" MATCHES "_")
set(form "_")
else()
set(form "")
endif()
string(TOUPPER "${f}" f_upper)
string(TOLOWER "${f}" f_lower)
if(FortranCInterface_GLOBAL${form}_MACRO)
Use string(APPEND) in Modules Automate with: find Modules -type f -print0 | xargs -0 perl -i -0pe \ 's/set\(([a-zA-Z0-9_]+)(\s+)"\$\{\1\}([^"])/string(APPEND \1\2"\3/g'
2016-07-28 01:41:13 +03:00
string(APPEND HEADER_CONTENT "#define ${SYMBOL_NAMESPACE}${f} ${MACRO_NAMESPACE}GLOBAL${form}(${f_lower}, ${f_upper})\n")
Rewrite FortranCInterface module This is a new FortranCInterface.cmake module to replace the previous prototype. All module support files lie in a FortranCInterface directory next to it. This module uses a new approach to detect Fortran symbol mangling. We build a single test project which defines symbols in a Fortran library (one per object-file) and calls them from a Fortran executable. The executable links to a C library which defines symbols encoding all known manglings (one per object-file). The C library falls back to the Fortran library for symbols it cannot provide. Therefore the executable will always link, but prefers the C-implemented symbols when they match. These symbols store string literals of the form INFO:symbol[<name>] so we can parse them out of the executable. This module also provides a simpler interface. It always detects the mangling as soon as it is included. A single macro is provided to generate mangling macros and optionally pre-mangled symbols.
2009-08-05 21:40:29 +04:00
else()
message(AUTHOR_WARNING "No FortranCInterface mangling known for ${f}")
endif()
endif()
Remove CMake-language block-end command arguments Ancient versions of CMake required else(), endif(), and similar block termination commands to have arguments matching the command starting the block. This is no longer the preferred style. Run the following shell code: for c in else endif endforeach endfunction endmacro endwhile; do echo 's/\b'"$c"'\(\s*\)(.\+)/'"$c"'\1()/' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | egrep -z -v 'Tests/CMakeTests/While-Endwhile-' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:50:14 +04:00
endforeach()
ENH: add fortran link discovery module
2008-10-27 22:23:14 +03:00
Rewrite FortranCInterface module This is a new FortranCInterface.cmake module to replace the previous prototype. All module support files lie in a FortranCInterface directory next to it. This module uses a new approach to detect Fortran symbol mangling. We build a single test project which defines symbols in a Fortran library (one per object-file) and calls them from a Fortran executable. The executable links to a C library which defines symbols encoding all known manglings (one per object-file). The C library falls back to the Fortran library for symbols it cannot provide. Therefore the executable will always link, but prefers the C-implemented symbols when they match. These symbols store string literals of the form INFO:symbol[<name>] so we can parse them out of the executable. This module also provides a simpler interface. It always detects the mangling as soon as it is included. A single macro is provided to generate mangling macros and optionally pre-mangled symbols.
2009-08-05 21:40:29 +04:00
# Store the content.
configure_file(${FortranCInterface_SOURCE_DIR}/Macro.h.in ${FILE} @ONLY)
endfunction()
Create FortranCInterface_VERIFY function This function builds a simple test project using a combination of Fortran and C (and optionally C++) to verify that the compilers are compatible. The idea is to help projects report very early to users that the compilers specified cannot mix languages.
2009-08-24 16:49:35 +04:00
function(FortranCInterface_VERIFY)
# Check arguments.
set(lang C)
set(quiet 0)
set(verify_cxx 0)
foreach(arg ${ARGN})
if("${arg}" STREQUAL "QUIET")
set(quiet 1)
elseif("${arg}" STREQUAL "CXX")
set(lang CXX)
set(verify_cxx 1)
else()
message(FATAL_ERROR
"FortranCInterface_VERIFY - called with unknown argument:\n ${arg}")
endif()
endforeach()
if(NOT CMAKE_${lang}_COMPILER_LOADED)
message(FATAL_ERROR
"FortranCInterface_VERIFY(${lang}) requires ${lang} to be enabled.")
endif()
# Build the verification project if not yet built.
if(NOT DEFINED FortranCInterface_VERIFIED_${lang})
set(_desc "Verifying Fortran/${lang} Compiler Compatibility")
message(STATUS "${_desc}")
# Build a sample project which reports symbols.
FortranCInterface: Pass all flags to VERIFY project (#13579) Teach FortranCInterface_VERIFY to build the test project in a specific configuration and pass all flags for that configuration. This ensures that any modifications made by the user or project to the flag are used in the test project consistently.
2012-10-10 23:38:36 +04:00
set(CMAKE_TRY_COMPILE_CONFIGURATION Release)
Create FortranCInterface_VERIFY function This function builds a simple test project using a combination of Fortran and C (and optionally C++) to verify that the compilers are compatible. The idea is to help projects report very early to users that the compilers specified cannot mix languages.
2009-08-24 16:49:35 +04:00
try_compile(FortranCInterface_VERIFY_${lang}_COMPILED
${FortranCInterface_BINARY_DIR}/Verify${lang}
${FortranCInterface_SOURCE_DIR}/Verify
VerifyFortranC
CMAKE_FLAGS -DVERIFY_CXX=${verify_cxx}
Make FortranCInterface_VERIFY verbose on failure We enable verbose build output in the try_compile of the simple project. This makes valuable information available in the case of failure.
2009-09-01 16:52:43 +04:00
-DCMAKE_VERBOSE_MAKEFILE=ON
FortranCInterface: Support '=' in language flags The commit "FortranCInterface: Honor language flags in checks" taught the FortranCInterface module to pass C and Fortran flags into its detection and verification checks. We improve on the change to allow the '=' character in the language flags. This requires passing the cache entry type with the -D options.
2009-12-15 22:02:52 +03:00
"-DCMAKE_C_FLAGS:STRING=${CMAKE_C_FLAGS}"
"-DCMAKE_CXX_FLAGS:STRING=${CMAKE_CXX_FLAGS}"
"-DCMAKE_Fortran_FLAGS:STRING=${CMAKE_Fortran_FLAGS}"
FortranCInterface: Pass all flags to VERIFY project (#13579) Teach FortranCInterface_VERIFY to build the test project in a specific configuration and pass all flags for that configuration. This ensures that any modifications made by the user or project to the flag are used in the test project consistently.
2012-10-10 23:38:36 +04:00
"-DCMAKE_C_FLAGS_RELEASE:STRING=${CMAKE_C_FLAGS_RELEASE}"
"-DCMAKE_CXX_FLAGS_RELEASE:STRING=${CMAKE_CXX_FLAGS_RELEASE}"
"-DCMAKE_Fortran_FLAGS_RELEASE:STRING=${CMAKE_Fortran_FLAGS_RELEASE}"
Create FortranCInterface_VERIFY function This function builds a simple test project using a combination of Fortran and C (and optionally C++) to verify that the compilers are compatible. The idea is to help projects report very early to users that the compilers specified cannot mix languages.
2009-08-24 16:49:35 +04:00
OUTPUT_VARIABLE _output)
file(WRITE "${FortranCInterface_BINARY_DIR}/Verify${lang}/output.txt" "${_output}")
# Report results.
if(FortranCInterface_VERIFY_${lang}_COMPILED)
message(STATUS "${_desc} - Success")
file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeOutput.log
"${_desc} passed with the following output:\n${_output}\n\n")
set(FortranCInterface_VERIFIED_${lang} 1 CACHE INTERNAL "Fortran/${lang} compatibility")
else()
message(STATUS "${_desc} - Failed")
file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log
"${_desc} failed with the following output:\n${_output}\n\n")
set(FortranCInterface_VERIFIED_${lang} 0 CACHE INTERNAL "Fortran/${lang} compatibility")
endif()
unset(FortranCInterface_VERIFY_${lang}_COMPILED CACHE)
endif()
# Error if compilers are incompatible.
if(NOT FortranCInterface_VERIFIED_${lang} AND NOT quiet)
file(READ "${FortranCInterface_BINARY_DIR}/Verify${lang}/output.txt" _output)
Replace string(REGEX REPLACE) with string(REPLACE) where possible The simple replacement is much faster.
2014-04-06 23:51:33 +04:00
string(REPLACE "\n" "\n " _output "${_output}")
Create FortranCInterface_VERIFY function This function builds a simple test project using a combination of Fortran and C (and optionally C++) to verify that the compilers are compatible. The idea is to help projects report very early to users that the compilers specified cannot mix languages.
2009-08-24 16:49:35 +04:00
message(FATAL_ERROR
"The Fortran compiler:\n ${CMAKE_Fortran_COMPILER}\n"
"and the ${lang} compiler:\n ${CMAKE_${lang}_COMPILER}\n"
"failed to compile a simple test project using both languages. "
"The output was:\n ${_output}")
endif()
endfunction()
FortranCInterface: Use CMake 2.8.0 behavior The FortranCInterface module should execute with CMake 2.8.0 behavior even if policies are set differently by the including project. In particular, it makes use of empty list elements and therefore expects NEW behavior of CMP0007.
2009-11-17 22:33:28 +03:00
# Restore including context policies.
cmake_policy(POP)