xnm.h

Go to the documentation of this file.

/* libxnm
 * xnm.h:
 *
 * Copyright (C) 2007 Dov Grobgeld
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 *
 * Dov Grobgeld <dov.grobgeld@gmail.com>
 * Thu Jan 11 23:44:32 2007
 */

#ifndef XNM_H
#define XNM_H

#ifdef __cplusplus
extern "C"
{
#endif

#include <glib.h>

enum {
  XNM_ERROR = 0,
  XNM_ERROR_SYNTAX_ERROR = 1,
  XNM_ERROR_KEY_NOT_FOUND = 2
};

typedef enum  {
  XNM_UNKNOWN,
  XNM_TABLE,
  XNM_ARRAY,
  XNM_STRING,
  XNM_BINARY 
} XnmValueType;

typedef enum {
  XNM_GET_UINT8,
  XNM_GET_UINT16,
  XNM_GET_UINT,
  XNM_GET_UINT32,
  XNM_GET_INT8,
  XNM_GET_INT16,
  XNM_GET_INT,
  XNM_GET_INT32,
  XNM_GET_INT64,
  XNM_GET_FLOAT,
  XNM_GET_DOUBLE,
  XNM_GET_STRING,
  XNM_GET_BOOL
} XnmValueGetType;

/* Forward declarations */
struct xnm_string_struct;
struct xnm_table_struct;
struct xnm_array_struct;
struct xnm_bin_struct;

typedef struct {
    int ref_count;              
    XnmValueType type;

    union {
        struct xnm_table_struct *table;
        struct xnm_array_struct *array;
        struct xnm_string_struct *string;
        struct xnm_binary_struct *binary;
    } value;
} XnmValue;

XnmValue * xnm_value_new_string            (const gchar *s);

XnmValue * xnm_value_new_table             ();

XnmValue * xnm_value_new_array             ();


XnmValue * xnm_value_new_binary            (const gchar *buf, size_t size);


void          xnm_value_ref              (XnmValue *xnm_value);

void          xnm_value_unref            (XnmValue *xnm_value);

gchar *       xnm_value_export_to_string (XnmValue *xnm_value);

int           xnm_value_get              (XnmValue *xnm_value_tree,
                                          const char *key,
                                          // output
                                          XnmValue **xnm_value);

int           xnm_value_get_string       (XnmValue *xnm_value,
                                          const char *key,
                                          // output
                                          gchar **string_val);

int           xnm_value_get_const_string  (XnmValue *xnm_value_tree,
                                           const char *key,

                                           /* output */
                                           const gchar **const_val_string);

int           xnm_value_get_int           (XnmValue *xnm_value,
                                           const char *key,
                                           /* output */
                                           int *val_int);


int xnm_value_get_bool (XnmValue *xnm_value,
                        const char *key,
                        /* output */
                        gboolean *val_bool);

int xnm_value_array_push_value(XnmValue * xnm_value_array,
                               XnmValue * value);

int xnm_value_array_push_string(XnmValue * xnm_value_array,
                                const gchar *string);


int xnm_value_array_push_int(XnmValue * xnm_value_array,
                             int value_int);


int xnm_value_array_push_printf(XnmValue * xnm_value_array,
                                const gchar *format,
                                ...);

int xnm_value_table_set_key_value(XnmValue    * xnm_value_tree,
                                  const gchar * key,
                                  XnmValue    * xnm_value);

int
xnm_value_table_set_key_value_string(XnmValue *xnm_value_parent,
                                     const gchar *key,
                                     const gchar *string);

int
xnm_value_set_key_value_printf(XnmValue *xnm_value_parent,
                               const gchar *key,
                               const gchar *format,
                               ...
                               );

int
xnm_value_get_array_length (XnmValue *xnm_value,
                            const char *key);

int
xnm_value_get_values(XnmValue *xnm_value,
                     ...);


int
xnm_value_get_table_key_list (XnmValue *xnm_value,
                              const char *key,
                              // output
                              const GPtrArray **key_list
                              );

int
xnm_parse_string(const gchar *string,
                 // output
                 XnmValue **value,
                 GError **error
                 );

int
xnm_parse_string_len(const gchar *string,
                     int len,
                     // output
                     XnmValue **value,
                     GError **error
                     );


int
xnm_parse_file(const gchar *filenam,
               // output
               XnmValue **xnm_value,
               GError **error);

#ifdef  __cplusplus
}
#endif

#endif