read_nextnano_inputfile.h

Go to the documentation of this file.

/*
** read_nextnano_inputfile.h
** 
** Made by Johnny Q. Hacker
** Login   <solarion@borkborkbork>
** 


    Copyright (C) 2008 Joseph Pingenot

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

** Started on  Mon Sep 29 16:18:03 2008 Johnny Q. Hacker
** Last update Wed Oct  1 08:14:40 2008 Johnny Q. Hacker
*/

#ifndef     READ_NEXTNANO_INPUTFILE_H_
# define    READ_NEXTNANO_INPUTFILE_H_

#include <glib.h>
#include <gio/gio.h>
#include <libcommon/gimme_alpha_types.h>

#define DOMAIN_READ_NEXTNANO_INPUTFILE 1024

/*!error codes*/
#define ERR_NO_START_SECTION -1 /*!There was no section start; just keywords*/
#define ERR_BAD_KEYWORD_LINE -2 /*!This was a bad keyword line*/

struct nextnano_keyword {
  /*!\var the data type for this */
  enum data_types t;
  /*!\var 0 if this keyword is optional; 1 otherwise*/
  short int required;
  /*!\var sequence number within the section; the first is 1, second
   * is 2, etc.*/
  int seqnum;
};

struct nextnano_keyword_section { 
 /*!\var GHashTable containing keywords for this section.*/
  GHashTable *keywords;
  /*!\var 0 if this section is optional; 1 otherwise*/
  short int required;
};

struct nextnano_value {
  enum data_types t;
  union {
    int i;
    double d;
    char *s;
  } store;
};

/*NextNano input files are complicated.  See the Notes.
*/

GHashTable* read_nextnano_inputfile(GInputStream *istream, GError **err);
GHashTable* read_nextnano_inputfile2(GFile *basedir, GHashTable *keys, int inputfile, GError **err, char** filename);
GHashTable* read_nextnano_inputfile_stringy(GInputStream *istream, GError **err);
GHashTable* read_nextnano_inputfile_stringy2(GFile *basedir, GHashTable *keys, int inputfile, GError **err);
GHashTable *read_nextnano_dbfile(GInputStream *istream, GError **err);
GHashTable *read_nextnano_dbfile2(GFile *basedir, GError **err);
GHashTable *read_nextnano_keyfile2(GFile *basedir, GError **err);

void print_stringy_inputfile(GHashTable *h);
void print_finalized_inputfile(GHashTable *h);

/*Returns the list for a specific part of the input file.
 *ARGS:
 *  section     name of the section you want
 *  secnum      There may be multiple sections that match the name.
 *                This specifies which one you want (in order of
 *                occurrance)
 *  chunknum    There may be multiple chunks of key/value lists within
 *                each section.  This specifies which which one you
 *                want (in order of occurrance)
 *  key         Specifies the key within the section.
 *RETURNS:
 *  The list associated with the requested key.
 *  NULL if the key wasn't found.
 */
GList* read_nextnano_extract_list_db(GHashTable *input, char* section, int secnum, int chunknum, char* key);

GList* read_nextnano_extract_list(GHashTable *input, char* section, int chunknum, char* key, int *err);
GList* read_nextnano_extract_list_typed(GHashTable *input, char* section, int chunknum, char* key, int *err, enum data_types type);

/*Returns the first value in the key/value list.  If there are
 *  multiple key/value lists, err is set to 1.
 *ARGS:
 *  same as read_nextnano_extract_list
 *  err          pointer to an int to store the error.
 *RETURNS
 *  the item
 */
char* read_nextnano_extract_item(GHashTable *input, char* section, int chunknum, char* key, int* err);
void* read_nextnano_extract_item_typed(GHashTable *input, char* section, int chunknum, char* key, int* err, enum data_types type);


#endif      /* !READ_NEXTNANO_INPUTFILE_H_ */