1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
/* dbus-string-private.h String utility class (internal to D-Bus implementation)
*
* Copyright (C) 2002, 2003 Red Hat, Inc.
*
* SPDX-License-Identifier: AFL-2.1 OR GPL-2.0-or-later
*
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#ifndef DBUS_STRING_PRIVATE_H
#define DBUS_STRING_PRIVATE_H
#include <dbus/dbus-internals.h>
#include <dbus/dbus-memory.h>
#include <dbus/dbus-types.h>
#ifndef DBUS_CAN_USE_DBUS_STRING_PRIVATE
#error "Don't go including dbus-string-private.h for no good reason"
#endif
DBUS_BEGIN_DECLS
/**
* @brief Internals of DBusString.
*
* DBusString internals. DBusString is an opaque objects, it must be
* used via accessor functions.
*/
typedef struct
{
unsigned char *str; /**< String data, plus nul termination */
int len; /**< Length without nul */
int allocated; /**< Allocated size of data */
unsigned int constant : 1; /**< String data is not owned by DBusString */
unsigned int locked : 1; /**< DBusString has been locked and can't be changed */
unsigned int valid : 1; /**< DBusString is valid (initialized and not freed) */
unsigned int align_offset : 3; /**< str - align_offset is the actual malloc block */
} DBusRealString;
_DBUS_STATIC_ASSERT (sizeof (DBusRealString) == sizeof (DBusString));
/**
* @defgroup DBusStringInternals DBusString implementation details
* @ingroup DBusInternals
* @brief DBusString implementation details
*
* The guts of DBusString.
*
* @{
*/
/**
* The maximum length of a DBusString
*/
#define _DBUS_STRING_MAX_LENGTH (_DBUS_INT32_MAX - _DBUS_STRING_ALLOCATION_PADDING)
/**
* Checks a bunch of assertions about a string object
*
* @param real the DBusRealString
*/
#define DBUS_GENERIC_STRING_PREAMBLE(real) \
do { \
(void) real; /* might be unused unless asserting */ \
_dbus_assert ((real) != NULL); \
_dbus_assert ((real)->valid); \
_dbus_assert ((real)->len >= 0); \
_dbus_assert ((real)->allocated >= 0); \
_dbus_assert ((real)->len <= ((real)->allocated - _DBUS_STRING_ALLOCATION_PADDING)); \
_dbus_assert ((real)->len <= _DBUS_STRING_MAX_LENGTH); \
} while (0)
/**
* Checks assertions about a string object that needs to be
* modifiable - may not be locked or const. Also declares
* the "real" variable pointing to DBusRealString.
* @param str the string
*/
#define DBUS_STRING_PREAMBLE(str) DBusRealString *real = (DBusRealString*) str; \
DBUS_GENERIC_STRING_PREAMBLE (real); \
_dbus_assert (!(real)->constant); \
_dbus_assert (!(real)->locked)
/**
* Checks assertions about a string object that may be locked but
* can't be const. i.e. a string object that we can free. Also
* declares the "real" variable pointing to DBusRealString.
*
* @param str the string
*/
#define DBUS_LOCKED_STRING_PREAMBLE(str) DBusRealString *real = (DBusRealString*) str; \
DBUS_GENERIC_STRING_PREAMBLE (real); \
_dbus_assert (!(real)->constant)
/**
* Checks assertions about a string that may be const or locked. Also
* declares the "real" variable pointing to DBusRealString.
* @param str the string.
*/
#define DBUS_CONST_STRING_PREAMBLE(str) const DBusRealString *real = (DBusRealString*) str; \
DBUS_GENERIC_STRING_PREAMBLE (real)
/**
* Checks for ASCII blank byte
* @param c the byte
*/
#define DBUS_IS_ASCII_BLANK(c) ((c) == ' ' || (c) == '\t')
/**
* Checks for ASCII whitespace byte
* @param c the byte
*/
#define DBUS_IS_ASCII_WHITE(c) ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) == '\r')
/** @} */
DBUS_END_DECLS
#endif /* DBUS_STRING_PRIVATE_H */
|
