ltt/branches/poly/include/lttv/attribute.h

   1 /* This file is part of the Linux Trace Toolkit viewer
   2  * Copyright (C) 2003-2004 Michel Dagenais
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License Version 2 as
   6  * published by the Free Software Foundation;
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  16  * MA 02111-1307, USA.
  17  */
  18
  19 #ifndef ATTRIBUTE_H
  20 #define ATTRIBUTE_H
  21
  22 #include <glib-object.h>
  23 #include <lttv/iattribute.h>
  24
  25 #define LTTV_ATTRIBUTE_TYPE        (lttv_attribute_get_type ())
  26 #define LTTV_ATTRIBUTE(obj)        (G_TYPE_CHECK_INSTANCE_CAST ((obj), LTTV_ATTRIBUTE_TYPE, LttvAttribute))
  27 #define LTTV_ATTRIBUTE_CLASS(vtable)    (G_TYPE_CHECK_CLASS_CAST ((vtable), LTTV_ATTRIBUTE_TYPE, LttvAttributeClass))
  28 #define LTTV_IS_ATTRIBUTE(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LTTV_ATTRIBUTE_TYPE))
  29 #define LTTV_IS_ATTRIBUTE_CLASS(vtable) (G_TYPE_CHECK_CLASS_TYPE ((vtable), LTTV_ATTRIBUTE_TYPE))
  30 #define LTTV_ATTRIBUTE_GET_CLASS(inst)  (G_TYPE_INSTANCE_GET_CLASS ((inst), LTTV_ATTRIBUTE_TYPE, LttvAttributeClass))
  31
  32
  33 typedef struct _LttvAttribute LttvAttribute;
  34 typedef struct _LttvAttributeClass LttvAttributeClass;
  35
  36 struct _LttvAttribute {
  37   GObject parent;
  38
  39   /* private members */
  40   GHashTable *names;
  41   GArray *attributes;
  42 };
  43
  44 struct _LttvAttributeClass {
  45   GObjectClass parent;
  46 };
  47
  48 GType lttv_attribute_get_type (void);
  49
  50
  51 /* The functions exported in the IAttribute interface are also available
  52    directly. */
  53
  54
  55 /* Total number of attributes */
  56
  57 unsigned int lttv_attribute_get_number(LttvAttribute *self);
  58
  59
  60 /* Container type. Named (fields in struct or elements in a hash table)
  61    or unnamed (elements in an array) attributes, homogeneous type or not. */
  62
  63 gboolean lttv_attribute_named(LttvAttribute *self, gboolean *homogeneous);
  64
  65
  66 /* Get the i th attribute along with its type and a pointer to its value. */
  67
  68 LttvAttributeType lttv_attribute_get(LttvAttribute *self, unsigned i,
  69     LttvAttributeName *name, LttvAttributeValue *v);
  70
  71
  72 /* Get the named attribute in the table along with its type and a pointer to
  73    its value. If the named attribute does not exist, the type is LTTV_NONE. */
  74
  75 LttvAttributeType lttv_attribute_get_by_name(LttvAttribute *self,
  76     LttvAttributeName name, LttvAttributeValue *v);
  77
  78
  79 /* Add an attribute, which must not exist. The name is an empty string for
  80    containers with unnamed attributes. */
  81
  82 LttvAttributeValue lttv_attribute_add(LttvAttribute *self,
  83     LttvAttributeName name, LttvAttributeType t);
  84
  85
  86 /* Remove an attribute */
  87
  88 void lttv_attribute_remove(LttvAttribute *self, unsigned i);
  89
  90 void lttv_attribute_remove_by_name(LttvAttribute *self,
  91     LttvAttributeName name);
  92
  93
  94 /* Create an empty iattribute object and add it as an attribute under the
  95    specified name, or return an existing iattribute attribute. If an
  96    attribute of that name already exists but is not a GObject supporting the
  97    iattribute interface, return NULL. */
  98
  99 LttvAttribute* lttv_attribute_find_subdir(LttvAttribute *self,
 100       LttvAttributeName name);
 101
 102 gboolean lttv_attribute_find(LttvAttribute *self, LttvAttributeName name,
 103     LttvAttributeType t, LttvAttributeValue *v);
 104
 105
 106 /* Free recursively a tree of attributes. All contained gobject of type
 107    LttvAttribute are freed (unreferenced) recursively. */
 108
 109 void lttv_attribute_recursive_free(LttvAttribute *self);
 110
 111 /* Add items from a tree of attributes to another tree. */
 112
 113 void lttv_attribute_recursive_add(LttvAttribute *dest, LttvAttribute *src);
 114
 115 #endif // ATTRIBUTE_H