fgen.wrapper_building.fortran_wrapper_module

Generation of the Fortran wrapper module

FortranWrapperModuleBuilder

class FortranWrapperModuleBuilder(package, module, shared)

Bases: object

Builder of a Fortran wrapper module

get_module_level_docstring()

Get the module-level docstring

Returns:

str – Module-level docstring

get_module_use_statements()

Get the module-level use statements

Returns:

str – Module-level use statements

get_provided_type_build_methods()

Get the provided type’s build methods

Returns:

str – Class methods

get_provided_type_getters_and_setters()

Get the provided type’s getters and setters

Returns:

str – Provided type’s getters and setters

get_provided_type_methods()

Get the provided type’s methods

Returns:

str – Provided type’s methods

get_receiving_from_python_steps(arguments)

Get receiving from Python steps for a set of arguments

Parameters:

arguments (collections.abc.Iterable[typing.Union[fgen.data_models.multi_return.MultiReturn, fgen.data_models.value.Value]]) – Arguments for which to get the receiving from Python steps

Returns:

fgen.wrapping_strategies.receiving_from_python_steps.ReceivingFromPythonSteps – Steps for receiving the arguments from Python

get_requirements_fortran_use_statements()

Get the Fortran use statements needed for the module

Returns:

str – Fortran use statements needed for the module

get_requirements_fortran_uses(module)

Get the Fortran use’s needed for the module

Parameters:

module (fgen.data_models.module.Module) – Module for which to get the use’s

Returns:

dict[str, fgen.wrapper_building.fortran_wrapper_module.NeededType] – Fortran use statements needed for the module

get_statement_declarations_getters_and_setters()

Get the statement declarations for getters and setters

Returns:

str – Statement declarations for the getters and setters

get_statement_declarations_methods()

Get the statement declarations for methods

Returns:

str – Statement declarations for the methods exposed by the derived type defined by this module.

get_wrapping_strategy(value)

Get wrapping strategy

Parameters:

value (typing.Union[fgen.data_models.multi_return.MultiReturn, fgen.data_models.value.Value]) – Value for which to get the wrapping strategy

Returns:

fgen.wrapping_strategies.interface.WrappingStrategyLike – Wrapping strategy to use with the value

module: fgen.data_models.module.Module

Module for which to build the wrapper

package: fgen.data_models.package.Package

Package for which the builder is building wrappers

requires_import(value, module)

Return whether a value requires an import or not

Parameters:

• value (typing.Union[fgen.data_models.value.Value, fgen.data_models.multi_return.MultiReturn]) – Value to check

• module (fgen.data_models.module.Module) – Module in which the value is being used

Returns:

bool – True if this values requires an import, False otherwise.

shared: fgen.data_models.package_shared_elements.PackageSharedElements

Elements which have to be shared across the package

For example, the names of functions which are used in more than one wrapper module.

NeededType

class NeededType(name, providing_module, requires_get_instance, requires_get_free_instance_number)

Bases: object

Helper class for keeping track of the first-party types needed by the modle

name: str

Name of the needed type

providing_module: typing.Union[fgen.data_models.module.Module, str]

Module or name of the module which provides this type

requires_get_free_instance_number: bool

Whether this needed type also requires its get_free_instance_number function

requires_get_instance: bool

Whether this needed type also requires its get_instance function

generate_fortran_wrapper_module

generate_fortran_wrapper_module(builder)

Generate the Fortran wrapper module

Parameters:

builder (fgen.wrapper_building.fortran_wrapper_module.FortranWrapperModuleBuilder) – Builder to use to generate the Fortran wrapper module

Returns:

str – Fortran wrapper module as code