include/ecoli_yaml.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2018, Olivier MATZ <zer0@droids-corp.org>
   3  */
   4
   5 /**
   6  * @defgroup yaml Yaml
   7  * @{
   8  *
   9  * @brief YAML import/export
  10  *
  11  * Interface to import/export ecoli data structures in YAML.
  12  */
  13
  14 #ifndef ECOLI_NODE_YAML_
  15 #define ECOLI_NODE_YAML_
  16
  17 struct ec_node;
  18
  19 /**
  20  * Parse a YAML file and build an ec_node tree from it.
  21  *
  22  * @param filename
  23  *   The path to the file to be parsed.
  24  * @return
  25  *   The ec_node tree on success, or NULL on error (errno is set).
  26  *   The returned node must be freed by the caller with ec_node_free().
  27  */
  28 struct ec_node *ec_yaml_import(const char *filename);
  29
  30 #endif
  31
  32 /** } */