FortranCInterface

Обнаружение интерфейса Fortran/C

Этот модуль автоматически определяет API, посредством которого взаимодействуют языки C и Fortran.

Переменные модуля

Переменные, указывающие, найдено ли форматирование:

FortranCInterface_GLOBAL_FOUND

Глобальные подпрограммы и функции.

FortranCInterface_MODULE_FOUND

Подпрограммы и функции модуля (объявленные с помощью "MODULE PROCEDURE").

Этот модуль также предоставляет следующие переменные для указания обнаруженного форматирования, хотя типичный случай использования не требует обращения к ним и может использовать нижеследующие функции модуля.

FortranCInterface_GLOBAL_PREFIX

Префикс для глобального символа без подчеркивания.

FortranCInterface_GLOBAL_SUFFIX

Суффикс для глобального символа без подчеркивания.

FortranCInterface_GLOBAL_CASE

Регистр для глобального символа без подчеркивания, либо UPPER либо LOWER.

FortranCInterface_GLOBAL__PREFIX

Префикс для глобального символа с подчеркиванием.

FortranCInterface_GLOBAL__SUFFIX

Суффикс для глобального символа с подчеркиванием.

FortranCInterface_GLOBAL__CASE

Регистр для глобального символа с подчеркиванием, либо UPPER либо LOWER.

FortranCInterface_MODULE_PREFIX

Префикс для символа модуля без подчеркивания.

FortranCInterface_MODULE_MIDDLE

Часть символа модуля без подчеркивания, которая находится между именем модуля и именем символа.

FortranCInterface_MODULE_SUFFIX

Суффикс для символа модуля без подчеркивания.

FortranCInterface_MODULE_CASE

Регистр для символа модуля без подчеркивания, либо UPPER либо LOWER.

FortranCInterface_MODULE__PREFIX

Префикс для символа модуля с подчеркиванием.

FortranCInterface_MODULE__MIDDLE

Часть символа модуля с подчеркиванием, которая находится между именем модуля и именем символа.

FortranCInterface_MODULE__SUFFIX

Суффикс для символа модуля с подчеркиванием.

FortranCInterface_MODULE__CASE

Регистр для символа модуля с подчеркиванием, либо UPPER либо LOWER.

Функции модуля

FortranCInterface_HEADER

Функция FortranCInterface_HEADER предназначена для генерации файла заголовка C, содержащего макросы для форматирования имён символов:

FortranCInterface_HEADER(<file>
                         [MACRO_NAMESPACE <macro-ns>]
                         [SYMBOL_NAMESPACE <ns>]
                         [SYMBOLS [<module>:]<function> ...])

Она генерирует в <file> определения следующих макросов:

#define FortranCInterface_GLOBAL (name,NAME) ...
#define FortranCInterface_GLOBAL_(name,NAME) ...
#define FortranCInterface_MODULE (mod,name, MOD,NAME) ...
#define FortranCInterface_MODULE_(mod,name, MOD,NAME) ...

Эти макросы форматируют четыре категории символов Fortran, соответственно:

• Глобальные символы без '_': call mysub()
• Глобальные символы с '_': call my_sub()
• Символы модуля без '_': use mymod; call mysub()
• Символы модуля с '_': use mymod; call my_sub()

Если форматирование для какой-либо категории неизвестно, её макрос остаётся неопределённым. Все макросы требуют исходных имён как в нижнем, так и в верхнем регистре.

Доступные параметры:

MACRO_NAMESPACE

Заменить стандартный префикс FortranCInterface_ заданным пространством имён <macro-ns>.

SYMBOLS

Перечислить символы для автоматического форматирования с определениями препроцессора C:

<function>          ==> #define <ns><function> ...
<module>:<function> ==> #define <ns><module>_<function> ...

Если форматирование для какого-либо символа неизвестно, определение препроцессора не создаётся, и отображается предупреждение.

SYMBOL_NAMESPACE

Добавить заданное пространство имён <ns> ко всем определениям препроцессора, сгенерированным параметром SYMBOLS.

FortranCInterface_VERIFY

Функция FortranCInterface_VERIFY предназначена для проверки совместимости компиляторов Fortran и C/C++:

FortranCInterface_VERIFY([CXX] [QUIET])

Она проверяет, успешно ли компилируется и линкуется простое тестовое исполняемое приложение, использующее Fortran и C (и C++, если задан параметр CXX). Результат сохраняется в записи кэша FortranCInterface_VERIFIED_C (или FortranCInterface_VERIFIED_CXX, если задан CXX). Если проверка завершается неудачно и QUIET не задан, функция завершается с сообщением об ошибке, описывающим проблему. Цель этой проверки — остановить сборку на ранней стадии для несовместимых комбинаций компиляторов. Тест собирается в конфигурации Release.

Пример использования

include(FortranCInterface)
FortranCInterface_HEADER(FC.h MACRO_NAMESPACE "FC_")

Это создаёт заголовок "FC.h", который определяет макросы форматирования FC_GLOBAL(), FC_GLOBAL_(), FC_MODULE(), и FC_MODULE_().

include(FortranCInterface)
FortranCInterface_HEADER(FCMangle.h
                         MACRO_NAMESPACE "FC_"
                         SYMBOL_NAMESPACE "FC_"
                         SYMBOLS mysub mymod:my_sub)

Это создаёт заголовок "FCMangle.h", который определяет те же макросы форматирования, что и в предыдущем примере, плюс символы препроцессора FC_mysub и FC_mymod_my_sub.

Дополнительные форматирования

FortranCInterface знает о возможных форматированиях GLOBAL и MODULE для многих компиляторов Fortran, но также предоставляет интерфейс для задания новых возможных форматирований. Установите переменные:

FortranCInterface_GLOBAL_SYMBOLS
FortranCInterface_MODULE_SYMBOLS

перед включением FortranCInterface, чтобы указать форматирования символов MySub, My_Sub, MyModule:MySub, и My_Module:My_Sub. Например, код:

set(FortranCInterface_GLOBAL_SYMBOLS mysub_ my_sub__ MYSUB_)
  #                                  ^^^^^  ^^^^^^   ^^^^^
set(FortranCInterface_MODULE_SYMBOLS
    __mymodule_MOD_mysub __my_module_MOD_my_sub)
  #   ^^^^^^^^     ^^^^^   ^^^^^^^^^     ^^^^^^
include(FortranCInterface)

указывает FortranCInterface попробовать заданные форматирования GLOBAL и MODULE. (Знаки «^» указывают на исходные имена символов для ясности в этом примере, но не нужны).