git.sur5r.net Git - glabels/blob - glabels2/src/merge.h

   1 /*
   2  *  (GLABELS) Label and Business Card Creation program for GNOME
   3  *
   4  *  merge.h:  document merge module header file
   5  *
   6  *  Copyright (C) 2002  Jim Evins <evins@snaught.com>.
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  21  */
  22 #ifndef __MERGE_H__
  23 #define __MERGE_H__
  24
  25 #include <glib-object.h>
  26
  27 G_BEGIN_DECLS
  28
  29 typedef enum {
  30         GL_MERGE_SRC_IS_FIXED,
  31         GL_MERGE_SRC_IS_FILE,
  32 } glMergeSrcType;
  33
  34 typedef struct {
  35         gchar *key;
  36         gchar *value;
  37 } glMergeField;
  38
  39 typedef struct {
  40         gboolean select_flag;
  41         GList    *field_list;  /* List of glMergeFields */
  42 } glMergeRecord;
  43
  44
  45 #define GL_TYPE_MERGE              (gl_merge_get_type ())
  46 #define GL_MERGE(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GL_TYPE_MERGE, glMerge))
  47 #define GL_MERGE_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GL_TYPE_MERGE, glMergeClass))
  48 #define GL_IS_MERGE(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GL_TYPE_MERGE))
  49 #define GL_IS_MERGE_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GL_TYPE_MERGE))
  50 #define GL_MERGE_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS ((object), GL_TYPE_MERGE, glMergeClass))
  51
  52
  53 typedef struct _glMerge          glMerge;
  54 typedef struct _glMergeClass     glMergeClass;
  55
  56 typedef struct _glMergePrivate   glMergePrivate;
  57
  58
  59 struct _glMerge {
  60         GObject          object;
  61
  62         glMergePrivate  *private;
  63 };
  64
  65 struct _glMergeClass {
  66         GObjectClass     parent_class;
  67
  68         GList         *(*get_key_list)    (glMerge *merge);
  69
  70         gchar         *(*get_primary_key) (glMerge *merge);
  71
  72         void           (*open)            (glMerge *merge);
  73
  74         void           (*close)           (glMerge *merge);
  75
  76         glMergeRecord *(*get_record)      (glMerge *merge);
  77
  78         void           (*copy)            (glMerge *dst_merge,
  79                                            glMerge *src_merge);
  80 };
  81
  82
  83 void              gl_merge_register_backend    (GType              type,
  84                                                 gchar             *name,
  85                                                 gchar             *description,
  86                                                 glMergeSrcType     src_type,
  87                                                 const gchar       *first_arg_name,
  88                                                 ...);
  89
  90 GList            *gl_merge_get_descriptions    (void);
  91
  92 void              gl_merge_free_descriptions   (GList **descriptions);
  93
  94 gchar            *gl_merge_description_to_name (gchar *description);
  95
  96 GType             gl_merge_get_type            (void);
  97
  98 glMerge          *gl_merge_new                 (gchar             *name);
  99
 100 glMerge          *gl_merge_dup                 (glMerge           *orig);
 101
 102 gchar            *gl_merge_get_name            (glMerge           *merge);
 103
 104 gchar            *gl_merge_get_description     (glMerge           *merge);
 105
 106 glMergeSrcType    gl_merge_get_src_type        (glMerge           *merge);
 107
 108 void              gl_merge_set_src             (glMerge           *merge,
 109                                                 gchar             *src);
 110
 111 gchar            *gl_merge_get_src             (glMerge           *merge);
 112
 113 GList            *gl_merge_get_key_list        (glMerge           *merge);
 114
 115 void              gl_merge_free_key_list       (GList            **keys);
 116
 117 gchar            *gl_merge_get_primary_key     (glMerge           *merge);
 118
 119 gchar            *gl_merge_eval_key            (glMergeRecord     *record,
 120                                                 gchar             *key);
 121
 122 const GList      *gl_merge_get_record_list     (glMerge           *merge);
 123
 124 gint              gl_merge_get_record_count    (glMerge           *merge);
 125
 126 G_END_DECLS
 127
 128 #endif