textfile_common.h

Go to the documentation of this file.

/*
** textfile_common.h
* Common routines we want to use when dealing with textfiles.
** 
** 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:22:26 2008 Johnny Q. Hacker
** Last update Mon Sep 29 16:26:10 2008 Johnny Q. Hacker
*/

#ifndef     TEXTFILE_COMMON_H_
# define    TEXTFILE_COMMON_H_

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

void prettify_line(char *line, char comment);

GList *get_key_value_pairs(char* s, const char *delim);

/*Return a list contaning hashes with the column titles as keys.
 *ARGS:
 *  istream   input stream to read data from (the first line is the
 *              title line, which provides titles to be used in the
 *              hashes.  The columns are separated by whitespace.
 *              Multiple whitespaces are ignored (i.e. all columns
 *              MUST have a value in them.
 *  err       pointer to a pointer to hold any error that might occur
 *  titles    pointer to a pointer to a GList where the list of titles
 *              will be kept.  These are required to get the data out
 *              of the hashes.
 *RETURNS:
 *  a pointer to a GList of hashes which contain the values (double
 *     precision float); the keys are the respective column title.
 * OR
 *  NULL if reading failed.
 */
GList* read_titled_whitespaced_data(GInputStream *istream, GError **err, GList **titles, char comment, enum data_types t);

#endif      /* !TEXTFILE_COMMON_H_ */