summaryrefslogtreecommitdiffstats
path: root/dbus/dbus-signature.h
diff options
context:
space:
mode:
authorColin Walters <walters@verbum.org>2005-02-24 16:03:56 +0000
committerColin Walters <walters@verbum.org>2005-02-24 16:03:56 +0000
commit54a2e9f7961b4b8afff94bb0c5b756f986965be6 (patch)
tree475800623e70c6bf14e7b4b2af2be8cc14d217ba /dbus/dbus-signature.h
parentd3f1b8bc89631cd9ef1cf2a806ce80f056b940fb (diff)
2005-02-24 Colin Walters <walters@verbum.org>
* dbus/dbus-signature.c: New file; implements various functions related to type signatures. Includes an interator for parsing, validation functions. (dbus_type_is_basic): Moved here from dbus-marshal-basic.c:_dbus_type_is_basic. (dbus_type_is_container): Moved here from dbus-marshal-basic.c:_dbus_type_is_container. All callers of _dbus_type_is_container and _dbus_type_is_basic updated, and include dbus-signature.h. * dbus/dbus-signature.h: New file; prototypes for the above. * dbus/Makefile.am (DBUS_LIB_SOURCES): Add dbus-signature.c, dbus-signature.h. * dbus/dbus-marshal-basic.c (map_type_char_to_type): New utility function factored out of _dbus_first_type_in_signature. (_dbus_first_type_in_signature_c_str): New function; returns first type code for a type signature character. * dbus/dbus-marshal-basic.h: Prototype _dbus_first_type_in_signature_c_str, handle function moves. * dbus/dbus-marshal-recursive.h: Export _dbus_type_signature_next. * dbus/dbus-marshal-recursive.c (_dbus_type_signature_next): New function; skips to next complete type in type signature. Implemented using previous skip_one_complete_type. Now skip_one_complete_type just delegates to _dbus_type_signature_next. * dbus/dbus-marshal-basic.c (_dbus_type_is_basic): Moved to dbus-signature.c (_dbus_type_is_container): Ditto. * doc/dbus-specification.xml: Update introspection sample to use real type signatures. * dbus/dbus-test.h: Prototype signature test. * dbus/dbus-test.c (dbus_internal_do_not_use_run_tests): Run signature tests. * dbus/dbus-protocol.h (DBUS_ERROR_INVALID_SIGNATURE): New error.
Diffstat (limited to 'dbus/dbus-signature.h')
-rw-r--r--dbus/dbus-signature.h71
1 files changed, 71 insertions, 0 deletions
diff --git a/dbus/dbus-signature.h b/dbus/dbus-signature.h
new file mode 100644
index 00000000..3c50795e
--- /dev/null
+++ b/dbus/dbus-signature.h
@@ -0,0 +1,71 @@
+/* -*- mode: C; c-file-style: "gnu" -*- */
+/* dbus-signatures.h utility functions for D-BUS types
+ *
+ * Copyright (C) 2005 Red Hat Inc.
+ *
+ * Licensed under the Academic Free License version 2.1
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ *
+ */
+#if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
+#error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
+#endif
+
+#ifndef DBUS_SIGNATURES_H
+#define DBUS_SIGNATURES_H
+
+#include <dbus/dbus-macros.h>
+#include <dbus/dbus-types.h>
+#include <dbus/dbus-errors.h>
+
+DBUS_BEGIN_DECLS
+
+/**
+ * DBusSignatureIter struct; contains no public fields
+ */
+typedef struct
+{
+ void *dummy1; /**< Don't use this */
+ void *dummy2; /**< Don't use this */
+ dbus_uint32_t dummy8; /**< Don't use this */
+ int dummy12; /**< Don't use this */
+ int dummy17; /**< Don't use this */
+} DBusSignatureIter;
+
+void dbus_signature_iter_init (DBusSignatureIter *iter,
+ const char *signature);
+
+int dbus_signature_iter_get_current_type (const DBusSignatureIter *iter);
+
+int dbus_signature_iter_get_element_type (const DBusSignatureIter *iter);
+
+dbus_bool_t dbus_signature_iter_next (DBusSignatureIter *iter);
+
+void dbus_signature_iter_recurse (const DBusSignatureIter *iter,
+ DBusSignatureIter *subiter);
+
+dbus_bool_t dbus_signature_validate (const char *signature,
+ DBusError *error);
+
+dbus_bool_t dbus_signature_validate_single (const char *signature,
+ DBusError *error);
+
+dbus_bool_t dbus_type_is_basic (int typecode);
+dbus_bool_t dbus_type_is_container (int typecode);
+
+DBUS_END_DECLS
+
+#endif /* DBUS_MESSAGE_H */