![]() | ![]() | ![]() | Libbonobo Reference Manual | ![]() |
---|
bonobo-arg — simplified CORBA_Any wrappers
typedef BonoboArg; typedef BonoboArgType; #define BONOBO_ARG_NULL #define BONOBO_ARG_BOOLEAN #define BONOBO_ARG_SHORT #define BONOBO_ARG_INT #define BONOBO_ARG_LONG #define BONOBO_ARG_LONGLONG #define BONOBO_ARG_FLOAT #define BONOBO_ARG_DOUBLE #define BONOBO_ARG_CHAR #define BONOBO_ARG_STRING #define BONOBO_ARG_GET_GENERAL (a,c,t,e) #define BONOBO_ARG_SET_GENERAL (a,v,c,t,e) #define BONOBO_ARG_GET_BOOLEAN (a) #define BONOBO_ARG_SET_BOOLEAN (a,v) #define BONOBO_ARG_GET_SHORT (a) #define BONOBO_ARG_SET_SHORT (a,v) #define BONOBO_ARG_GET_INT (a) #define BONOBO_ARG_SET_INT (a,v) #define BONOBO_ARG_GET_LONG (a) #define BONOBO_ARG_SET_LONG (a,v) #define BONOBO_ARG_GET_LONGLONG (a) #define BONOBO_ARG_SET_LONGLONG (a,v) #define BONOBO_ARG_GET_FLOAT (a) #define BONOBO_ARG_SET_FLOAT (a,v) #define BONOBO_ARG_GET_DOUBLE (a) #define BONOBO_ARG_SET_DOUBLE (a,v) #define BONOBO_ARG_GET_CHAR (a) #define BONOBO_ARG_SET_CHAR (a,v) #define BONOBO_ARG_GET_STRING (a) #define BONOBO_ARG_SET_STRING (a,v) BonoboArg* bonobo_arg_new (BonoboArgType t); BonoboArg* bonobo_arg_new_from (BonoboArgType t, gconstpointer data); void bonobo_arg_release (BonoboArg *arg); BonoboArg* bonobo_arg_copy (const BonoboArg *arg); void bonobo_arg_from_gvalue (BonoboArg *a, const GValue *value); BonoboArgType bonobo_arg_type_from_gtype (GType t); void bonobo_arg_to_gvalue (GValue *value, const BonoboArg *arg); GType bonobo_arg_type_to_gtype (BonoboArgType id); gboolean bonobo_arg_is_equal (const BonoboArg *a, const BonoboArg *b, CORBA_Environment *opt_ev); gboolean bonobo_arg_type_is_equal (BonoboArgType a, BonoboArgType b, CORBA_Environment *opt_ev);
The BonoboArg code, and macros are designed to make the use of CORBA_Any's slightly simpler by providing a glib like binding for them. The bonobo-arg code also provides mappings between GValues and CORBA_anys.
A typical use of the BonoboArg macros would be in
Example 6. Property bag implementation
static void get_prop (BonoboPropertyBag *bag, BonoboArg *arg, guint arg_id, CORBA_Environment *ev, gpointer user_data) { GObject *clock = user_data; switch (arg_id) { case PROP_RUNNING: { BONOBO_ARG_SET_BOOLEAN (arg, is_it_running); break; } default: bonobo_exception_set (ev, ex_Bonobo_PropertyBag_NotFound); break; } }
typedef CORBA_TypeCode BonoboArgType;
A glib style looking typedef for a CORBA type description.
#define BONOBO_ARG_GET_GENERAL(a,c,t,e)
A macro to extract a value from a BonoboArg with the given CORBA type t.
a : | the BonoboArg |
c : | a BonoboArgType for checking |
t : | the C type of the value eg. for BONOBO_ARG_LONG: CORBA_long |
e : | an optional CORBA_Environment or NULL. |
#define BONOBO_ARG_SET_GENERAL(a,v,c,t,e)
A macro to insert a value into an empty BonoboArg with the given CORBA type t.
a : | the BonoboArg |
v : | a pointer to the value to insert. |
c : | a BonoboArgType for checking |
t : | the C type of the value eg. for BONOBO_ARG_LONG: CORBA_long |
e : | an optional CORBA_Environment or NULL. |
#define BONOBO_ARG_GET_BOOLEAN(a) (BONOBO_ARG_GET_GENERAL (a, TC_CORBA_boolean, CORBA_boolean, NULL))
This macro returns a CORBA_boolean from inside a BonoboArg. If the BonoboArg's type does not match, the behavior is undefined, and may cause faults.
a : | the BonoboArg to extract the value from. |
#define BONOBO_ARG_SET_BOOLEAN(a,v) (BONOBO_ARG_SET_GENERAL (a, v, TC_CORBA_boolean, CORBA_boolean, NULL))
This macro sets the value of a to contain v
a : | the Bonobo arg to insert the value into |
v : | a CORBA_boolean. |
#define BONOBO_ARG_GET_SHORT(a) (BONOBO_ARG_GET_GENERAL (a, TC_CORBA_short, CORBA_short, NULL))
This macro returns a CORBA_short from inside a BonoboArg. If the BonoboArg's type does not match, the behavior is undefined, and may cause faults.
a : | the BonoboArg to extract the value from. |
#define BONOBO_ARG_SET_SHORT(a,v) (BONOBO_ARG_SET_GENERAL (a, v, TC_CORBA_short, CORBA_short, NULL))
This macro sets the value of a to contain v
a : | the Bonobo arg to insert the value into |
v : | a CORBA_short. |
#define BONOBO_ARG_GET_INT(a) (BONOBO_ARG_GET_GENERAL (a, TC_CORBA_long, CORBA_long, NULL))
this macro returns a CORBA_long from inside a BonoboArg, if the BonoboArg's type does not match, the behavior is undefined, and may cause faults.
a : | the BonoboArg to extract the value from. |
#define BONOBO_ARG_SET_INT(a,v) (BONOBO_ARG_SET_GENERAL (a, v, TC_CORBA_long, CORBA_long, NULL))
This macro sets the value of a to contain v
a : | the Bonobo arg to insert the value into |
v : | a CORBA_long. |
#define BONOBO_ARG_GET_LONG(a) (BONOBO_ARG_GET_GENERAL (a, TC_CORBA_long, CORBA_long, NULL))
this macro returns a CORBA_long from from inside a BonoboArg, if the BonoboArg's type does not match, the behavior is undefined, and may cause faults.
a : | the BonoboArg to extract the value from. |
#define BONOBO_ARG_SET_LONG(a,v) (BONOBO_ARG_SET_GENERAL (a, v, TC_CORBA_long, CORBA_long, NULL))
This macro sets the value of a to contain v
a : | the Bonobo arg to insert the value into |
v : | a CORBA_long. |
#define BONOBO_ARG_GET_LONGLONG(a) (BONOBO_ARG_GET_GENERAL (a, TC_CORBA_long_long, CORBA_long_long, NULL))
this macro returns a CORBA_long_long from from inside a BonoboArg, if the BonoboArg's type does not match, the behavior is undefined, and may cause faults.
a : | the BonoboArg to extract the value from. |
#define BONOBO_ARG_SET_LONGLONG(a,v) (BONOBO_ARG_SET_GENERAL (a, v, TC_CORBA_long_long, CORBA_long_long, NULL))
This macro sets the value of a to contain v
a : | the Bonobo arg to insert the value into |
v : | a CORBA_long_long. |
#define BONOBO_ARG_GET_FLOAT(a) (BONOBO_ARG_GET_GENERAL (a, TC_CORBA_float, CORBA_float, NULL))
this macro returns a CORBA_float from inside a BonoboArg, if the BonoboArg's type does not match, the behavior is undefined, and may cause faults.
a : | the BonoboArg to extract the value from. |
#define BONOBO_ARG_SET_FLOAT(a,v) (BONOBO_ARG_SET_GENERAL (a, v, TC_CORBA_float, CORBA_float, NULL))
This macro sets the value of a to contain v
a : | the Bonobo arg to insert the value into |
v : | a CORBA_float. |
#define BONOBO_ARG_GET_DOUBLE(a) (BONOBO_ARG_GET_GENERAL (a, TC_CORBA_double, CORBA_double, NULL))
This macro returns a CORBA_double from inside a BonoboArg. If the BonoboArg's type does not match, the behavior is undefined, and may cause faults.
a : | the BonoboArg to extract the value from. |
#define BONOBO_ARG_SET_DOUBLE(a,v) (BONOBO_ARG_SET_GENERAL (a, v, TC_CORBA_double, CORBA_double, NULL))
This macro sets the value of a to contain v
a : | the Bonobo arg to insert the value into |
v : | a CORBA_double. |
#define BONOBO_ARG_GET_CHAR(a) (BONOBO_ARG_GET_GENERAL (a, TC_CORBA_char, CORBA_char, NULL))
This macro returns a CORBA_char from inside a BonoboArg, If the BonoboArg's type does not match, the behavior is undefined, and may cause faults.
a : | the BonoboArg to extract the value from. |
#define BONOBO_ARG_SET_CHAR(a,v) (BONOBO_ARG_SET_GENERAL (a, v, TC_CORBA_char, CORBA_char, NULL))
This macro sets the value of a to contain v
a : | the Bonobo arg to insert the value into |
v : | a CORBA_char. |
#define BONOBO_ARG_GET_STRING(a)
this macro returns a const CORBA_char * from from inside a BonoboArg, if the BonoboArg's type does not match, the behavior is undefined, and may cause faults. The pointer to the string is only valid for the scope of the lifetime of a.
a : | the BonoboArg to extract the value from. |
#define BONOBO_ARG_SET_STRING(a,v)
This macro sets the value of a to contain a duplicated copy of v
a : | the Bonobo arg to insert the value into |
v : | a CORBA_char *. |
BonoboArg* bonobo_arg_new (BonoboArgType t);
Create a new BonoboArg with the specified type the value of the BonoboArg is initially empty.
t : | the BonoboArgType eg. TC_CORBA_long |
Returns : | the new BonoboArg |
BonoboArg* bonobo_arg_new_from (BonoboArgType t, gconstpointer data);
Create a new BonoboArg with the specified type and data
t : | the BonoboArgType eg. TC_CORBA_long |
data : | the data for the BonoboArg to be created |
Returns : | the new BonoboArg |
void bonobo_arg_release (BonoboArg *arg);
This frees the memory associated with arg
arg : | the bonobo arg. |
BonoboArg* bonobo_arg_copy (const BonoboArg *arg);
This function duplicates a by a deep copy
arg : | the bonobo arg |
Returns : | a copy of arg |
void bonobo_arg_from_gvalue (BonoboArg *a, const GValue *value);
This maps a GValue value to a BonoboArg a; a must point to a freshly allocated BonoboArg eg. such as returned by bonobo_arg_new
a : | pointer to blank BonoboArg |
value : | GValue to copy |
void bonobo_arg_to_gvalue (GValue *value, const BonoboArg *arg);
Maps a BonoboArg to a GtkArg; a must point to a blank GtkArg.
value : | pointer to a blank GValue |
arg : | the BonoboArg to copy |
GType bonobo_arg_type_to_gtype (BonoboArgType id);
This maps a BonoboArgType to a GType
id : | the BonoboArgType |
Returns : | the mapped type or 0 on failure |
gboolean bonobo_arg_is_equal (const BonoboArg *a, const BonoboArg *b, CORBA_Environment *opt_ev);
Compares two BonoboArg's for equivalence; will return TRUE if equivalent for all simple cases. For Object references CORBA sometimes denies 2 object references are equivalent even if they are [ this is a feature_not_bug ].
This function is commutative.
a : | a bonobo arg |
b : | another bonobo arg |
opt_ev : | optional exception environment or NULL. |
Returns : | TRUE if a == b |
gboolean bonobo_arg_type_is_equal (BonoboArgType a, BonoboArgType b, CORBA_Environment *opt_ev);
This compares two BonoboArgType's in a and b. The opt_ev is an optional CORBA_Environment for exceptions, or NULL. This function is commutative.
a : | a type code |
b : | a type code |
opt_ev : | optional exception environment or NULL. |
Returns : | TRUE if equal, FALSE if different |
<< BonoboPropertyBag | bonobo-property-bag-client >> |