fpx.f

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 9 Open GitHub ↗

A Fortran preprocessor in Fortran for modern Fortran.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 class="title">
    <span class="name">FPX</span>
    <br>
    <span class="text">A Fortran preprocessor</span>
    <br>
    <span class="tagline">
    Simple, embeddable, and open-source preprocessor written in modern Fortran.
    </span>
</h1>
<br>

<div class="actions">
    <div class="action">
        <a class="button medium brand" href="index.html#autotoc_md2">Get Started</a>
    </div>
    <div class="action">
        <a class="button medium alt" href="topics.html">API</a>
    </div>
    <div class="action">
        <a class="button medium alt" href="https://github.com/davidpfister/fpx.f" target="_blank" rel="noreferrer">View on GitHub</a>
    </div>
</div>

# Introduction

## About the Project
<center>
<p align="center">
  <img src="https://github.com/davidpfister/fpx.f/blob/master/.dox/images/logo.png?raw=true" width="300" height="300">
</p>
</center>

Fortran, the venerable language of scientific computing, has powered simulations of galaxies, weather systems, and quantum phenomena for over seven decades. Its enduring strength lies in its clarity, performance, and mathematical soul, qualities that resonate deeply with its community of developers. Yet, nestled within this ecosystem is a contentious tool: the preprocessor. From its ad hoc beginnings in the 1970s to its modern incarnations in tools like `cpp`, `fpp`, and `fypp`, preprocessing has been both a lifeline and a lightning rod for Fortran developers.

It enables portability across diverse platforms, conditional compilation for debugging, and code generation for complex libraries. These capabilities are critical to Fortran's role in high-performance computing. But it also sparks fierce debate, with many Fortraners decrying its tendency to obscure code, disrupt the language's elegant simplicity, and introduce bugs.

This project aims at providing a *simple*, *embeddable*, *open-source* preprocessor written in modern Fortran. `fpx` is mostly compliant to a C preprocessor, fine-tuned for the specificity of the Fortran language. 
`fpx` is an embeddable preprocessor. It can be used as a command-line tool or directly embedded into any solution with the module `fpx_parser`.

* [![fpm][fpm]][fpm-url]
* [![ifort][ifort]][ifort-url]
* [![gfortran][gfortran]][gfortran-url]

`fpx` supports: 
- conditional compilation with `#if`, `#ifdef`, `#ifndef`, `#elif`, `#elifdef`, `#elifndef`, `#else`,`#endif`
- simple macros and function like macros with `#define`, `#undef`, `defined` and `!defined`
- simple arithmetic and bitwise operations with `+`, `-`, `*`, `**`, `/`, `>`, `<`, `>=`, `=<`, `||`, `&&`, `|`, `^`, `&`, `!`, `?:` and `~`.
- include files with `#include`
- diagnostic messages with `#warning` and `#error`
- For loop `#for`, `#endfor`
- variadic macros with `__VA_ARGS__`, and `__VA_OPT__`, 
- build-in macros as `__LINE__`, `__FILE__`, `__FILENAME__`, `__TIME__`, `__DATE__`, `__TIMESTAMP__`
- stringification `#` and concatenation `##`
- and more...       

## Installation

### Requirements

To build that library you need

- a Fortran 2008 compliant compiler, or better, a Fortran 2018 compliant compiler (Intel Fortran and gfortran compilers are known to work well for _fpx.f_).

The following compilers are tested on the default branch of _fpx.f_:

| Name |	Version	| Platform	| Architecture |
|:--:|:--:|:--:|:--:|
| GCC Fortran (MinGW) | 14 | Windows 10 | x86_64 |
| Intel oneAPI classic	| 2021.5	| Windows 10 |	x86_64 |

</center>

- a preprocessor. _fpx.f_ uses some preprocessor macros. It is known to work both with intel `fpp` and `cpp`. The goal is for `fpx` to preproces itself at some point. In particular, the console line application uses the header file ['app.inc'](https://github.com/davidpfister/fortiche/tree/master/src/app) from the ['fortiche'](https://github.com/davidpfister/fortiche) repo.

Unit test rely on the the header file [`assertion.inc`](https://github.com/davidpfister/fortiche/tree/master/src/assertion). Since the whole framework fits in a single file, it has been added directly to the repo.

### Building

#### Get the code
```bash
   git clone https://github.com/davidpfister/fpx.f
   cd fpx.f
```

#### Build with fpm

The repo can be build using _fpm_
```bash
   fpm build
```

Building with ifort requires to specify the compiler name (gfortran by default)
```bash
   fpm build --compiler ifort
```
Alternatively, the compiler can be set using fpm environment variables.
```bash
   set FPM_FC=ifort
```

The settings to the cpp preprocessor are specified in the file.

```toml
[preprocess]
cpp.suffixes = ["F90", "f90"]
cpp.macros = ["_FPM"]
```
The `_FPM` macro is used to differentiate the build when compiling with _fpm_ or _Visual Studio_. This is mostly present to adapt the hard coded paths that differs in both cases.

#### Build with Visual Studio 2019

The project was originally developed on Windows with Visual Studio 2019. The repo contains the solution file (_Fpx.f.sln_) to get you started with Visual Studio 2019.

## Quick Start

### Command line
The preprocessor `fpx` can be used from the command-line using your favorite shell. 
The following options are available:
<center>

|Option|Definition|
|:--|:--| 
|`-D<macro>`|Define a \<macro> with no value.| 
|`-D<macro>=<val>`|Define a \<macro> with \<val> as its value.| 
|`-U<macro>`|Undefine \<macro>'|
|`-I<dir>`|Add \<dir> to the end of the global include paths.| 
|`-h`, `--help`, `-?`|Display this help.|
|`-o`, `--output`|Output file path with name and extension.|
|`-v`, `--version`|Display the version of the program.|
|`--no-color`|Disable ANSI coloring.|
|`--implicit-conti`|Activate implicit continuation line in macro expansion.|
|`--no-exlicit-conti`|Deactivate explicit continuation line in macro expansion using &amp; symbol|
|`--exclude-comments`|Exclude comments from macro expansion.|
|`--extra-macros`|Support extra macros (`__FILENAME__`, `__TIMESTAMP__`, and `__FUNC__`).|
|`--no-macros`|Deactivate macros expansion.|
|`--no-$`|Deactivate ${} substitution in macro expansion.|
|`--std`|Enforce [standard](https://davidpfister.github.io/fpx.f/j3.html) compliance.|

</center>

Using the file preprocessor could not be easier. The function simply takes as arguments the input and output file paths.

### Embedded
```fortran
program test
    use fpx_parser
    
    call preprocess('tests/input.in', 'tests/output.out')
end program
```

_For more examples, please refer to the [Documentation](https://davidpfister.github.io/fpx.f/index.html)_

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. So, thank you for considering contributing to _fpx.f_.
Please review and follow these [guidelines](https://github.com/davidpfister/fpx.f/tree/master?tab=contributing-ov-file) to make the contribution process simple and effective for all involved. In return, the developers will help address your problem, evaluate changes, and guide you through your pull requests.

By contributing to _fpx.f_, you certify that you own or are allowed to share the content of your contribution under the same license.

## License

Distributed under the MIT License.

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]

[contributors-shield]: https://img.shields.io/github/contributors/davidpfister/fpx.f.svg?style=for-the-badge
[contributors-url]: https://github.com/davidpfister/fpx.f/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/davidpfister/fpx.f.svg?style=for-the-badge
[forks-url]: https://github.com/davidpfister/fpx.f/network/members
[stars-shield]: https://img.shields.io/github/stars/davidpfister/fpx.f.svg?style=for-the-badge
[stars-url]: https://github.com/davidpfister/fpx.f/stargazers
[issues-shield]: https://img.shields.io/github/issues/davidpfister/fpx.f.svg?style=for-the-badge
[issues-url]: https://github.com/davidpfister/fpx.f/issues
[license-shield]: https://img.shields.io/github/license/davidpfister/fpx.f.svg?style=for-the-badge
[license-url]: https://github.com/davidpfister/fpx.f/master/LICENSE
[gfortran]: https://img.shields.io/badge/gfortran-000000?style=for-the-badge&logo=gnu&logoColor=white
[gfortran-url]: https://gcc.gnu.org/wiki/GFortran
[ifort]: https://img.shields.io/badge/ifort-000000?style=for-the-badge&logo=Intel&logoColor=61DAFB
[ifort-url]: https://www.intel.com/content/www/us/en/developer/tools/oneapi/fortran-compiler.html
[fpm]: https://img.shields.io/badge/fpm-000000?style=for-the-badge&logo=Fortran&logoColor=734F96
[fpm-url]: https://fpm.fortran-lang.org/

fpx.f

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README