D-Bus  1.13.7
dbus-syntax.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-syntax.h - utility functions for strings with special syntax
3  *
4  * Author: Simon McVittie <simon.mcvittie@collabora.co.uk>
5  * Copyright © 2011 Nokia Corporation
6  *
7  * Licensed under the Academic Free License version 2.1
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program 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
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  *
23  */
24 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
25 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
26 #endif
27 
28 #ifndef DBUS_SYNTAX_H
29 #define DBUS_SYNTAX_H
30 
31 #include <dbus/dbus-macros.h>
32 #include <dbus/dbus-types.h>
33 #include <dbus/dbus-errors.h>
34 
36 
37 DBUS_EXPORT
38 dbus_bool_t dbus_validate_path (const char *path,
39  DBusError *error);
40 DBUS_EXPORT
41 dbus_bool_t dbus_validate_interface (const char *name,
42  DBusError *error);
43 DBUS_EXPORT
44 dbus_bool_t dbus_validate_member (const char *name,
45  DBusError *error);
46 DBUS_EXPORT
47 dbus_bool_t dbus_validate_error_name (const char *name,
48  DBusError *error);
49 DBUS_EXPORT
50 dbus_bool_t dbus_validate_bus_name (const char *name,
51  DBusError *error);
52 DBUS_EXPORT
53 dbus_bool_t dbus_validate_utf8 (const char *alleged_utf8,
54  DBusError *error);
55 
57 
58 #endif /* multiple-inclusion guard */
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
DBUS_EXPORT dbus_bool_t dbus_validate_error_name(const char *name, DBusError *error)
Check an error name for validity.
Definition: dbus-syntax.c:195
DBUS_EXPORT dbus_bool_t dbus_validate_path(const char *path, DBusError *error)
Check an object path for validity.
Definition: dbus-syntax.c:54
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
Object representing an exception.
Definition: dbus-errors.h:48
DBUS_EXPORT dbus_bool_t dbus_validate_utf8(const char *alleged_utf8, DBusError *error)
Check a string for validity.
Definition: dbus-syntax.c:289
DBUS_EXPORT dbus_bool_t dbus_validate_interface(const char *name, DBusError *error)
Check an interface name for validity.
Definition: dbus-syntax.c:101
DBUS_EXPORT dbus_bool_t dbus_validate_bus_name(const char *name, DBusError *error)
Check a bus name for validity.
Definition: dbus-syntax.c:242
DBUS_EXPORT dbus_bool_t dbus_validate_member(const char *name, DBusError *error)
Check a member (method/signal) name for validity.
Definition: dbus-syntax.c:148
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.