kvp_frame.h

Go to the documentation of this file.

/********************************************************************\
 * kvp_frame.h -- Implements a key-value frame system               *
 * This program is free software; you can redistribute it and/or    *
 * modify it under the terms of the GNU General Public License as   *
 * published by the Free Software Foundation; either version 2 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 General Public License for more details.                     *
 *                                                                  *
 * You should have received a copy of the GNU General Public License*
 * along with this program; if not, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       [email protected]                   *
 *                                                                  *
\********************************************************************/
#ifndef KVP_FRAME_H
#define KVP_FRAME_H

#ifdef __cplusplus
extern "C"
{
#endif

#include "gnc-date.h"
#include "gnc-numeric.h"
#include "guid.h"

#define QOF_MOD_KVP "qof.kvp"

typedef struct KvpFrameImpl KvpFrame;

typedef struct KvpValueImpl KvpValue;

typedef enum
{
    KVP_TYPE_INVALID = -1,
    KVP_TYPE_GINT64 = 1, 
    KVP_TYPE_DOUBLE,     
    KVP_TYPE_NUMERIC,    
    KVP_TYPE_STRING,     
    KVP_TYPE_GUID,       
    KVP_TYPE_TIMESPEC,   
    KVP_TYPE_PLACEHOLDER_DONT_USE, /* Replaces KVP_TYPE_BINARY */
    KVP_TYPE_GLIST,      
    KVP_TYPE_FRAME       
    , KVP_TYPE_GDATE       
} KvpValueType;

#define kvp_value_t KvpValueType

KvpFrame   * kvp_frame_new(void);

void         kvp_frame_delete(KvpFrame * frame);

KvpFrame   * kvp_frame_copy(const KvpFrame * frame);

gboolean     kvp_frame_is_empty(const KvpFrame * frame);

const char ** kvp_frame_get_keys(const KvpFrame * frame);

void kvp_frame_set_gint64(KvpFrame * frame, const gchar * path, gint64 ival);
void kvp_frame_set_double(KvpFrame * frame, const gchar * path, double dval);

#define kvp_frame_set_gnc_numeric kvp_frame_set_numeric

void kvp_frame_set_numeric(KvpFrame * frame, const gchar * path, gnc_numeric nval);
void kvp_frame_set_timespec(KvpFrame * frame, const gchar * path, Timespec ts);

void kvp_frame_set_string(KvpFrame * frame, const gchar * path, const gchar* str);
void kvp_frame_set_guid(KvpFrame * frame, const gchar * path, const GncGUID *guid);

void kvp_frame_set_frame(KvpFrame *frame, const gchar *path, KvpFrame *chld);
void kvp_frame_set_frame_nc(KvpFrame *frame, const gchar *path, KvpFrame *chld);

KvpFrame *   kvp_frame_set_value(KvpFrame * frame,
                                 const gchar * path, const KvpValue * value);
KvpFrame *    kvp_frame_set_value_nc(KvpFrame * frame,
                                     const gchar * path, KvpValue * value);

KvpValue * kvp_frame_replace_value_nc (KvpFrame * frame, const gchar * slot,
                                       KvpValue * new_value);
void kvp_frame_add_frame_nc(KvpFrame *frame, const gchar *path, KvpFrame *chld);


gint64      kvp_frame_get_gint64(const KvpFrame *frame, const gchar *path);
double      kvp_frame_get_double(const KvpFrame *frame, const gchar *path);
gnc_numeric kvp_frame_get_numeric(const KvpFrame *frame, const gchar *path);
const gchar * kvp_frame_get_string(const KvpFrame *frame, const gchar *path);
GncGUID      * kvp_frame_get_guid(const KvpFrame *frame, const gchar *path);
Timespec    kvp_frame_get_timespec(const KvpFrame *frame, const gchar *path);
KvpValue  * kvp_frame_get_value(const KvpFrame *frame, const gchar *path);

/*@ dependent @*/
KvpFrame  * kvp_frame_get_frame(const KvpFrame *frame, const gchar *path);

KvpFrame    * kvp_frame_get_frame_slash (KvpFrame *frame,
        const gchar *path);

/* KvpValue * kvp_frame_replace_slot_nc (KvpFrame * frame, const gchar * slot, */
/*                                       KvpValue * new_value); */


void          kvp_frame_set_slot(KvpFrame * frame,
                                 const gchar * key, KvpValue * value);
void          kvp_frame_set_slot_nc(KvpFrame * frame,
                                    const gchar * key, KvpValue * value);

void          kvp_frame_set_slot_path (KvpFrame *frame,
                                       KvpValue *value,
                                       const gchar *first_key, ...);

void          kvp_frame_set_slot_path_gslist (KvpFrame *frame,
        KvpValue *value,
        GSList *key_path);

KvpValue   * kvp_frame_get_slot(const KvpFrame * frame, const gchar * key);

KvpValue   * kvp_frame_get_slot_path (KvpFrame *frame,
                                      const gchar *first_key, ...);

KvpValue   * kvp_frame_get_slot_path_gslist (KvpFrame *frame,
        const GSList *key_path);

gint          kvp_frame_compare(const KvpFrame *fa, const KvpFrame *fb);

gint          double_compare(double v1, double v2);
gint        kvp_glist_compare(const GList * list1, const GList * list2);

GList     * kvp_glist_copy(const GList * list);

void        kvp_glist_delete(GList * list);
KvpValue   * kvp_value_new_gint64(gint64 value);
KvpValue   * kvp_value_new_double(double value);

#define kvp_value_new_gnc_numeric kvp_value_new_numeric
KvpValue   * kvp_value_new_numeric(gnc_numeric value);
KvpValue   * kvp_value_new_string(const gchar * value);
KvpValue   * kvp_value_new_guid(const GncGUID * guid);
KvpValue   * kvp_value_new_timespec(Timespec timespec);
KvpValue   * kvp_value_new_frame(const KvpFrame * value);
KvpValue   * kvp_value_new_gdate(GDate date);

KvpValue   * kvp_value_new_glist(const GList * value);

KvpValue   * kvp_value_new_glist_nc(GList *lst);

KvpValue   * kvp_value_new_frame_nc(KvpFrame * value);

void          kvp_value_delete(KvpValue * value);

KvpValue   * kvp_value_copy(const KvpValue * value);

KvpFrame * kvp_value_replace_frame_nc(KvpValue *value, KvpFrame * newframe);

GList * kvp_value_replace_glist_nc(KvpValue *value, GList *newlist);

KvpValueType kvp_value_get_type(const KvpValue * value);


gint64      kvp_value_get_gint64(const KvpValue * value);
double      kvp_value_get_double(const KvpValue * value);
gnc_numeric kvp_value_get_numeric(const KvpValue * value);

char        * kvp_value_get_string(const KvpValue * value);

GncGUID        * kvp_value_get_guid(const KvpValue * value);

GList       * kvp_value_get_glist(const KvpValue * value);

/*@ dependent @*/
KvpFrame   * kvp_value_get_frame(const KvpValue * value);
Timespec    kvp_value_get_timespec(const KvpValue * value);

GDate    kvp_value_get_gdate(const KvpValue * value);

gint          kvp_value_compare(const KvpValue *va, const KvpValue *vb);

gchar* kvp_value_to_string(const KvpValue *val);

void kvp_frame_for_each_slot(KvpFrame *f,
                             void (*proc)(const gchar *key,
                                     KvpValue *value,
                                     gpointer data),
                             gpointer data);

gchar* kvp_frame_to_string(const KvpFrame *frame);

typedef struct
{
    const gchar   *key;
    GValue        *value;
}KvpItem;

GValue *kvp_frame_get_gvalue (KvpFrame *frame, const gchar *key);

void kvp_frame_set_gvalue (KvpFrame *frame, const gchar *key, const GValue *value);

void gnc_gvalue_free (GValue *value);

GType gnc_value_list_get_type (void);
#define GNC_TYPE_VALUE_LIST (gnc_value_list_get_type ())

#ifdef __cplusplus
}
#endif

#endif