Skip to content

Latest commit

 

History

History
124 lines (87 loc) · 5.19 KB

README.md

File metadata and controls

124 lines (87 loc) · 5.19 KB
Raw

FoXy

License License License License

Status Build Status Coverage Status

FoXy, Fortran XML parser for poor people

A KISS pure Fortran Library for parsing XML files

  • FoXy is a pure Fortran (KISS) library for modern Fortran projects;
  • FoXy is Fortran 2008+ standard compliant;
  • FoXy is OOP designed;
  • FoXy is a Free, Open Source Project.

Compiler Support

Compiler Compiler Compiler Compiler Compiler Compiler

What is FoXy? | Aims | Status | Documentation | Copyrights

What is FoXy?

Modern Fortran standards (2003+) have introduced better support for strings manipulations. Exploiting such new Fortran capabilities, FoXy is aimed to provide an easy to use module library to parse and emit XML files and or tags.

Aims

Other programming languages have many libraries for XML parsing, Fortran has less options, but some there are:

  • xml-fortran of Arjen Markus;
  • xml-f90 of Alberto Garcia;
  • fox of Andrew Walker that is an improved fork of xml-f90 of Alberto Garcia;
  • tixi from DLR Simulation and Software Technology (C-binding).

All of the above are great codes, but lack in some points that we would like to have:

  • actively maintained;
  • designed for modern Fortran:
    • OOP designed;
    • exploiting new features of Fortran (e.g. deferred length allocatable characters);
    • recreate a pure Fortran representation of the XML data (e.g. tree structure exploiting);
  • parallel architectures supported (threads/processes safety ensured);
  • extensively tested (strong unit-test regression);
  • comprehensively documented;
  • pure Fortran:
    • no wrapper;
    • no bindings, no ISO_C_BINDING;
  • be FOSS.

In some sense or other, the afore-mentioned Fortran libraries miss somethings.

Go to Top

Status

Status Build Status Coverage Status

Done

  • lint baseline code:
    • purge doxygen, format docstrings for FORD;
    • adopt best practice of Rouson;
    • clean the API: two modules, one main XML file object;
  • parse input string:
    • autoparse tags:
      • autoparse tag's name;
      • autoparse tag's value;
      • autoparse tag's attributes names;
      • autoparse tag's attributes values;
  • lazy find tag value into file (once provided a tag name);
  • parse input file;
  • fix bug on tag's attributes name parsing.

Doing

  • implement nested tags delete;
  • implement lazy find tag's value attribute into file (once provided a tag name and attribute name).

Todo

  • create team of collaborators;
  • profile the parser:
    • almost surely there are performance penalties;

Go to Top

Documentation

Besides this README file the FoXy documentation is contained into its own wiki. Detailed documentation of the API is contained into the GitHub Pages that can also be created locally by means of ford tool.

Go to Top

Copyrights

FoXy is an open source project, it is distributed under a multi-licensing system:

Anyone is interest to use, to develop or to contribute to FoXy is welcome, feel free to select the license that best matches your soul!

Go to Top