Skip to content

SeisSol/fty

Repository files navigation

fty - Fortran To Yaml

It is a small header-only C++ library which is supposed to help people to start converting their legacy Fortran code to C++. The library reads a text file or lists of strings formatted according to Fortran NAMELIST I/O style, and generates a YAML::Node (a hash table) containing retrieved information.

Requirements

Make sure that you have yaml-cpp installed

Exceptions

The library throws the following exceptions in case of a failure during a convertion:

fty::exception::FileException
fty::exception::CriticalTextBlockException
fty::exception::CriticalKeyValueError

Policies

The library offers several base policies for storing keys in a generated hash table due to issues related to the case sensitivity.

Name Description
AsOriginal stores keys as it is given in an input file/list
AsUppercase converts all keys to upper-case
AsLowercase converts all keys to lower-case

If none of the policies fit to your particular problem you can provide yours by defining and providing a class to either fty::Loader or fty::Converter

Policy Example

struct MyPolicy {
  std::string apply(const std::string& String) {
    std::string ConvertedString(String.size(), '\0');
    // your code is here
    return ConvertedString;
  }
};

fty::Loader<MyPolicy> Loader{};

Code Example

#include "Fty.hpp"
#include <iostream>
#include <cstdlib>

int main(int Argc, char *Argv[]) {
  if (Argc != 2) {
    std::cerr << "Error: Please, provide an input file\n";
    std::cerr << "Example: fty-converter [input file path]\n";
    exit(EXIT_FAILURE);
  }

  std::string FileName = Argv[1];
  fty::Loader<fty::AsLowercase> Loader{};
  try {
    YAML::Node Params = Loader.load(FileName);
    std::cout << Params;
  }
  catch (const fty::exception::FileException& Error) {
    std::cerr << Error.what() << std::endl;
  }
  catch (const std::exception& Error) {
    std::cerr << Error.what() << std::endl;
    throw Error;
  }
  return 0;
}

See CMakeLists.txt as an example of compiling

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published