xref: /illumos-gate/usr/src/cmd/hal/hald/property.h (revision 18c2aff7)
1*18c2aff7Sartem /***************************************************************************
2*18c2aff7Sartem  * CVSID: $Id$
3*18c2aff7Sartem  *
4*18c2aff7Sartem  * property.c : HalProperty methods
5*18c2aff7Sartem  *
6*18c2aff7Sartem  * Copyright (C) 2003 David Zeuthen, <david@fubar.dk>
7*18c2aff7Sartem  * Copyright (C) 2004 Novell, Inc.
8*18c2aff7Sartem  *
9*18c2aff7Sartem  * Licensed under the Academic Free License version 2.1
10*18c2aff7Sartem  *
11*18c2aff7Sartem  * This program is free software; you can redistribute it and/or modify
12*18c2aff7Sartem  * it under the terms of the GNU General Public License as published by
13*18c2aff7Sartem  * the Free Software Foundation; either version 2 of the License, or
14*18c2aff7Sartem  * (at your option) any later version.
15*18c2aff7Sartem  *
16*18c2aff7Sartem  * This program is distributed in the hope that it will be useful,
17*18c2aff7Sartem  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18*18c2aff7Sartem  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19*18c2aff7Sartem  * GNU General Public License for more details.
20*18c2aff7Sartem  *
21*18c2aff7Sartem  * You should have received a copy of the GNU General Public License
22*18c2aff7Sartem  * along with this program; if not, write to the Free Software
23*18c2aff7Sartem  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
24*18c2aff7Sartem  *
25*18c2aff7Sartem  **************************************************************************/
26*18c2aff7Sartem 
27*18c2aff7Sartem #ifndef PROPERTY_H
28*18c2aff7Sartem #define PROPERTY_H
29*18c2aff7Sartem 
30*18c2aff7Sartem #include <dbus/dbus.h>
31*18c2aff7Sartem 
32*18c2aff7Sartem typedef struct _HalProperty HalProperty;
33*18c2aff7Sartem 
34*18c2aff7Sartem #define HAL_PROPERTY_TYPE_INVALID         DBUS_TYPE_INVALID
35*18c2aff7Sartem #define HAL_PROPERTY_TYPE_INT32       DBUS_TYPE_INT32
36*18c2aff7Sartem #define HAL_PROPERTY_TYPE_UINT64      DBUS_TYPE_UINT64
37*18c2aff7Sartem #define HAL_PROPERTY_TYPE_DOUBLE      DBUS_TYPE_DOUBLE
38*18c2aff7Sartem #define HAL_PROPERTY_TYPE_BOOLEAN     DBUS_TYPE_BOOLEAN
39*18c2aff7Sartem #define HAL_PROPERTY_TYPE_STRING      DBUS_TYPE_STRING
40*18c2aff7Sartem #define HAL_PROPERTY_TYPE_STRLIST     ((int) (DBUS_TYPE_STRING<<8)+('l'))
41*18c2aff7Sartem 
42*18c2aff7Sartem enum PropertyAttribute {
43*18c2aff7Sartem 	READONLY,
44*18c2aff7Sartem 	PERSISTENCE,
45*18c2aff7Sartem 	CALLOUT
46*18c2aff7Sartem };
47*18c2aff7Sartem 
48*18c2aff7Sartem void          hal_property_free               (HalProperty  *prop);
49*18c2aff7Sartem 
50*18c2aff7Sartem HalProperty *hal_property_new_string          (const char   *key,
51*18c2aff7Sartem 					       const char   *value);
52*18c2aff7Sartem HalProperty *hal_property_new_int             (const char   *key,
53*18c2aff7Sartem 					       dbus_int32_t  value);
54*18c2aff7Sartem HalProperty *hal_property_new_uint64          (const char   *key,
55*18c2aff7Sartem 					       dbus_uint64_t value);
56*18c2aff7Sartem HalProperty *hal_property_new_bool            (const char   *key,
57*18c2aff7Sartem 					       dbus_bool_t   value);
58*18c2aff7Sartem HalProperty *hal_property_new_double          (const char   *key,
59*18c2aff7Sartem 					       double        value);
60*18c2aff7Sartem HalProperty *hal_property_new_strlist         (const char   *key);
61*18c2aff7Sartem 
62*18c2aff7Sartem const char   *hal_property_get_key            (HalProperty  *prop);
63*18c2aff7Sartem int           hal_property_get_type           (HalProperty  *prop);
64*18c2aff7Sartem char         *hal_property_to_string          (HalProperty  *prop);
65*18c2aff7Sartem 
66*18c2aff7Sartem const char   *hal_property_get_string         (HalProperty  *prop);
67*18c2aff7Sartem dbus_int32_t  hal_property_get_int            (HalProperty  *prop);
68*18c2aff7Sartem dbus_uint64_t hal_property_get_uint64         (HalProperty  *prop);
69*18c2aff7Sartem dbus_bool_t   hal_property_get_bool           (HalProperty  *prop);
70*18c2aff7Sartem double        hal_property_get_double         (HalProperty  *prop);
71*18c2aff7Sartem GSList       *hal_property_get_strlist        (HalProperty  *prop);
72*18c2aff7Sartem 
73*18c2aff7Sartem void          hal_property_set_string         (HalProperty  *prop,
74*18c2aff7Sartem 					       const char   *value);
75*18c2aff7Sartem void          hal_property_set_int            (HalProperty  *prop,
76*18c2aff7Sartem 					       dbus_int32_t  value);
77*18c2aff7Sartem void          hal_property_set_uint64         (HalProperty  *prop,
78*18c2aff7Sartem 					       dbus_uint64_t value);
79*18c2aff7Sartem void          hal_property_set_bool           (HalProperty  *prop,
80*18c2aff7Sartem 					       dbus_bool_t   value);
81*18c2aff7Sartem void          hal_property_set_double         (HalProperty  *prop,
82*18c2aff7Sartem 					       double        value);
83*18c2aff7Sartem gboolean      hal_property_strlist_append     (HalProperty  *prop,
84*18c2aff7Sartem 					       const char   *value);
85*18c2aff7Sartem gboolean      hal_property_strlist_prepend    (HalProperty  *prop,
86*18c2aff7Sartem 					       const char   *value);
87*18c2aff7Sartem gboolean      hal_property_strlist_remove_elem (HalProperty  *prop,
88*18c2aff7Sartem 					        guint index);
89*18c2aff7Sartem 
90*18c2aff7Sartem gboolean      hal_property_strlist_add        (HalProperty  *prop,
91*18c2aff7Sartem 					       const char *value);
92*18c2aff7Sartem gboolean      hal_property_strlist_remove     (HalProperty  *prop,
93*18c2aff7Sartem 					       const char *value);
94*18c2aff7Sartem gboolean      hal_property_strlist_clear      (HalProperty  *prop);
95*18c2aff7Sartem 
96*18c2aff7Sartem 
97*18c2aff7Sartem void          hal_property_set_attribute      (HalProperty *prop,
98*18c2aff7Sartem 					       enum PropertyAttribute attr,
99*18c2aff7Sartem 					       gboolean val);
100*18c2aff7Sartem gboolean      hal_property_get_attribute      (HalProperty *prop,
101*18c2aff7Sartem 					       enum PropertyAttribute attr);
102*18c2aff7Sartem 
103*18c2aff7Sartem #endif /* PROPERTY_H */
104