extras/gudev/gudevenumerator.h

   1 /* -*- Mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
   2  *
   3  * Copyright (C) 2008-2010 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_ENUMERATOR_H__
  26 #define __G_UDEV_ENUMERATOR_H__
  27
  28 #include <gudev/gudevtypes.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define G_UDEV_TYPE_ENUMERATOR         (g_udev_enumerator_get_type ())
  33 #define G_UDEV_ENUMERATOR(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_UDEV_TYPE_ENUMERATOR, GUdevEnumerator))
  34 #define G_UDEV_ENUMERATOR_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_UDEV_TYPE_ENUMERATOR, GUdevEnumeratorClass))
  35 #define G_UDEV_IS_ENUMERATOR(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_UDEV_TYPE_ENUMERATOR))
  36 #define G_UDEV_IS_ENUMERATOR_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_UDEV_TYPE_ENUMERATOR))
  37 #define G_UDEV_ENUMERATOR_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_UDEV_TYPE_ENUMERATOR, GUdevEnumeratorClass))
  38
  39 typedef struct _GUdevEnumeratorClass   GUdevEnumeratorClass;
  40 typedef struct _GUdevEnumeratorPrivate GUdevEnumeratorPrivate;
  41
  42 /**
  43  * GUdevEnumerator:
  44  *
  45  * The #GUdevEnumerator struct is opaque and should not be accessed directly.
  46  *
  47  * Since: 165
  48  */
  49 struct _GUdevEnumerator
  50 {
  51   GObject              parent;
  52
  53   /*< private >*/
  54   GUdevEnumeratorPrivate *priv;
  55 };
  56
  57 /**
  58  * GUdevEnumeratorClass:
  59  * @parent_class: Parent class.
  60  *
  61  * Class structure for #GUdevEnumerator.
  62  *
  63  * Since: 165
  64  */
  65 struct _GUdevEnumeratorClass
  66 {
  67   GObjectClass   parent_class;
  68
  69   /*< private >*/
  70   /* Padding for future expansion */
  71   void (*reserved1) (void);
  72   void (*reserved2) (void);
  73   void (*reserved3) (void);
  74   void (*reserved4) (void);
  75   void (*reserved5) (void);
  76   void (*reserved6) (void);
  77   void (*reserved7) (void);
  78   void (*reserved8) (void);
  79 };
  80
  81 GType            g_udev_enumerator_get_type                     (void) G_GNUC_CONST;
  82 GUdevEnumerator *g_udev_enumerator_new                          (GUdevClient      *client);
  83 GUdevEnumerator *g_udev_enumerator_add_match_subsystem          (GUdevEnumerator  *enumerator,
  84                                                                  const gchar      *subsystem);
  85 GUdevEnumerator *g_udev_enumerator_add_nomatch_subsystem        (GUdevEnumerator  *enumerator,
  86                                                                  const gchar      *subsystem);
  87 GUdevEnumerator *g_udev_enumerator_add_match_sysfs_attr         (GUdevEnumerator  *enumerator,
  88                                                                  const gchar      *name,
  89                                                                  const gchar      *value);
  90 GUdevEnumerator *g_udev_enumerator_add_nomatch_sysfs_attr       (GUdevEnumerator  *enumerator,
  91                                                                  const gchar      *name,
  92                                                                  const gchar      *value);
  93 GUdevEnumerator *g_udev_enumerator_add_match_property           (GUdevEnumerator  *enumerator,
  94                                                                  const gchar      *name,
  95                                                                  const gchar      *value);
  96 GUdevEnumerator *g_udev_enumerator_add_match_name               (GUdevEnumerator  *enumerator,
  97                                                                  const gchar      *name);
  98 GUdevEnumerator *g_udev_enumerator_add_match_tag                (GUdevEnumerator  *enumerator,
  99                                                                  const gchar      *tag);
 100 GUdevEnumerator *g_udev_enumerator_add_match_is_initialized     (GUdevEnumerator  *enumerator);
 101 GUdevEnumerator *g_udev_enumerator_add_sysfs_path               (GUdevEnumerator  *enumerator,
 102                                                                  const gchar      *sysfs_path);
 103 GList           *g_udev_enumerator_execute                      (GUdevEnumerator  *enumerator);
 104
 105 G_END_DECLS
 106
 107 #endif /* __G_UDEV_ENUMERATOR_H__ */