extras/gudev/gudevdevice.h

   1 /* -*- Mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
   2  *
   3  * Copyright (C) 2008 David Zeuthen <davidz@redhat.com>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #if !defined (_GUDEV_COMPILATION) && !defined(_GUDEV_INSIDE_GUDEV_H)
  22 #error "Only <gudev/gudev.h> can be included directly, this file may disappear or change contents."
  23 #endif
  24
  25 #ifndef __G_UDEV_DEVICE_H__
  26 #define __G_UDEV_DEVICE_H__
  27
  28 #include <gudev/gudevtypes.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define G_UDEV_TYPE_DEVICE         (g_udev_device_get_type ())
  33 #define G_UDEV_DEVICE(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_UDEV_TYPE_DEVICE, GUdevDevice))
  34 #define G_UDEV_DEVICE_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_UDEV_TYPE_DEVICE, GUdevDeviceClass))
  35 #define G_UDEV_IS_DEVICE(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_UDEV_TYPE_DEVICE))
  36 #define G_UDEV_IS_DEVICE_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_UDEV_TYPE_DEVICE))
  37 #define G_UDEV_DEVICE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_UDEV_TYPE_DEVICE, GUdevDeviceClass))
  38
  39 typedef struct _GUdevDeviceClass   GUdevDeviceClass;
  40 typedef struct _GUdevDevicePrivate GUdevDevicePrivate;
  41
  42 /**
  43  * GUdevDevice:
  44  * @parent: Parent instance.
  45  *
  46  * The #GUdevDevice struct is opaque and should not be accessed directly.
  47  */
  48 struct _GUdevDevice
  49 {
  50   GObject             parent;
  51
  52   /*< private >*/
  53   GUdevDevicePrivate *priv;
  54 };
  55
  56 /**
  57  * GUdevDeviceClass:
  58  * @parent_class: Parent class.
  59  *
  60  * Class structure for #GUdevDevice.
  61  */
  62 struct _GUdevDeviceClass
  63 {
  64   GObjectClass parent_class;
  65
  66   /*< private >*/
  67   /* Padding for future expansion */
  68   void (*reserved1) (void);
  69   void (*reserved2) (void);
  70   void (*reserved3) (void);
  71   void (*reserved4) (void);
  72   void (*reserved5) (void);
  73   void (*reserved6) (void);
  74   void (*reserved7) (void);
  75   void (*reserved8) (void);
  76 };
  77
  78 GType               g_udev_device_get_type                  (void) G_GNUC_CONST;
  79 gboolean            g_udev_device_get_is_initialized        (GUdevDevice  *device);
  80 guint64             g_udev_device_get_usec_since_initialized (GUdevDevice  *device);
  81 const gchar        *g_udev_device_get_subsystem             (GUdevDevice  *device);
  82 const gchar        *g_udev_device_get_devtype               (GUdevDevice  *device);
  83 const gchar        *g_udev_device_get_name                  (GUdevDevice  *device);
  84 const gchar        *g_udev_device_get_number                (GUdevDevice  *device);
  85 const gchar        *g_udev_device_get_sysfs_path            (GUdevDevice  *device);
  86 const gchar        *g_udev_device_get_driver                (GUdevDevice  *device);
  87 const gchar        *g_udev_device_get_action                (GUdevDevice  *device);
  88 guint64             g_udev_device_get_seqnum                (GUdevDevice  *device);
  89 GUdevDeviceType     g_udev_device_get_device_type           (GUdevDevice  *device);
  90 GUdevDeviceNumber   g_udev_device_get_device_number         (GUdevDevice  *device);
  91 const gchar        *g_udev_device_get_device_file           (GUdevDevice  *device);
  92 const gchar* const *g_udev_device_get_device_file_symlinks  (GUdevDevice  *device);
  93 GUdevDevice        *g_udev_device_get_parent                (GUdevDevice  *device);
  94 GUdevDevice        *g_udev_device_get_parent_with_subsystem (GUdevDevice  *device,
  95                                                              const gchar  *subsystem,
  96                                                              const gchar  *devtype);
  97 const gchar* const *g_udev_device_get_property_keys         (GUdevDevice  *device);
  98 gboolean            g_udev_device_has_property              (GUdevDevice  *device,
  99                                                              const gchar  *key);
 100 const gchar        *g_udev_device_get_property              (GUdevDevice  *device,
 101                                                              const gchar  *key);
 102 gint                g_udev_device_get_property_as_int       (GUdevDevice  *device,
 103                                                              const gchar  *key);
 104 guint64             g_udev_device_get_property_as_uint64    (GUdevDevice  *device,
 105                                                              const gchar  *key);
 106 gdouble             g_udev_device_get_property_as_double    (GUdevDevice  *device,
 107                                                              const gchar  *key);
 108 gboolean            g_udev_device_get_property_as_boolean   (GUdevDevice  *device,
 109                                                              const gchar  *key);
 110 const gchar* const *g_udev_device_get_property_as_strv      (GUdevDevice  *device,
 111                                                              const gchar  *key);
 112
 113 const gchar        *g_udev_device_get_sysfs_attr            (GUdevDevice  *device,
 114                                                              const gchar  *name);
 115 gint                g_udev_device_get_sysfs_attr_as_int     (GUdevDevice  *device,
 116                                                              const gchar  *name);
 117 guint64             g_udev_device_get_sysfs_attr_as_uint64  (GUdevDevice  *device,
 118                                                              const gchar  *name);
 119 gdouble             g_udev_device_get_sysfs_attr_as_double  (GUdevDevice  *device,
 120                                                              const gchar  *name);
 121 gboolean            g_udev_device_get_sysfs_attr_as_boolean (GUdevDevice  *device,
 122                                                              const gchar  *name);
 123 const gchar* const *g_udev_device_get_sysfs_attr_as_strv    (GUdevDevice  *device,
 124                                                              const gchar  *name);
 125 const gchar* const *g_udev_device_get_tags                  (GUdevDevice  *device);
 126
 127 G_END_DECLS
 128
 129 #endif /* __G_UDEV_DEVICE_H__ */