cspi/spi-private.h

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2002 Ximian, Inc.
   6  *           2002 Sun Microsystems Inc.
   7  *
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Library General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Library General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Library General Public
  20  * License along with this library; if not, write to the
  21  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22  * Boston, MA 02111-1307, USA.
  23  */
  24
  25 #ifndef _SPI_PRIVATE_H_
  26 #define _SPI_PRIVATE_H_
  27
  28 /* Private internal implementation details of at-spi. */
  29
  30 #include "common/spi-dbus.h"
  31 #include "cspi/spi.h"
  32 #include "string.h"
  33 #include "cspi/cspi-lowlevel.h"
  34 #include "cspi/spi-listener.h"
  35 #include "dbind/dbind.h"
  36 #include <glib-object.h>
  37 #include "common/spi-stateset.h"
  38
  39 typedef struct _CSpiApplication CSpiApplication;
  40 struct _CSpiApplication
  41 {
  42   GHashTable *hash;
  43   char *bus_name;
  44 };
  45
  46 struct _Accessible {
  47   gint ref_count;
  48   Accessible *parent;
  49   GList *children;
  50         CSpiApplication *app;
  51         union
  52         {
  53           gint id;
  54           char *path;
  55         } v;
  56   gint role : 8;
  57   gint interfaces : 24;
  58   char *name;
  59   char *description;
  60   AtkStateSet *states;
  61 };
  62
  63 #define SPI_INTERNAL_EVENT_MAGIC 0xc3
  64 /*
  65  * For internal use by CSPI implementation only
  66  */
  67 typedef struct {
  68   AccessibleEvent event;
  69   guint           id;
  70   guchar          magic;
  71   guchar          type;
  72   guint16         ref_count;
  73 } InternalEvent;
  74
  75 struct _SPIException {
  76   SPIExceptionType type;
  77   Accessible *source;
  78   DBusError *error;
  79   SPIExceptionCode code;
  80   char * desc;
  81 };
  82
  83 DBusConnection *SPI_bus (void);
  84 SPIBoolean             cspi_exception         (void);
  85 Accessible            *cspi_object_add (Accessible  *accessible);
  86 void                   cspi_object_ref        (Accessible  *accessible);
  87 void                   cspi_object_unref      (Accessible  *accessible);
  88 SPIBoolean             cspi_accessible_is_a   (Accessible  *accessible,
  89                                                const char  *interface_name);
  90 AccessibleRole         cspi_role_from_spi_role (Accessibility_Role role);
  91 void                   cspi_streams_close_all (void);
  92 gboolean               cspi_exception_throw (DBusError *error, const char *desc_prefix);
  93
  94 AccessibleAttributeSet
  95                      *_cspi_attribute_set_from_sequence (const GArray *seq);
  96 #define cspi_return_if_fail(val)                \
  97         if (!(val))                             \
  98                 return
  99 #define cspi_return_val_if_fail(val, ret)       \
 100         if (!(val))                             \
 101                 return (ret)
 102
 103 #define cspi_return_if_ev(err)                  \
 104         if (cspi_exception ()) \
 105                 return;
 106 #define cspi_return_val_if_ev(err, ret) \
 107         if (cspi_exception ()) \
 108                 return (ret);
 109
 110 typedef struct _Accessibility_BoundingBox Accessibility_BoundingBox;
 111 struct _Accessibility_BoundingBox
 112 {
 113   dbus_int32_t x;
 114   dbus_int32_t y;
 115   dbus_int32_t width;
 116   dbus_int32_t height;
 117 };
 118
 119 #endif /* _SPI_PRIVATE_H_ */