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

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

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 присвоения имен. (Знаки возвышения указывают на исходные имена символов для большей ясности в данном примере, но они не нужны).