dbus-string-private.h
/* -*- 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
typedef struct
{
unsigned char *str;
int len;
int allocated;
unsigned int constant : 1;
unsigned int locked : 1;
unsigned int valid : 1;
unsigned int align_offset : 3;
} DBusRealString;
_DBUS_STATIC_ASSERT (sizeof (DBusRealString) == sizeof (DBusString));
#define _DBUS_STRING_MAX_LENGTH (_DBUS_INT32_MAX - _DBUS_STRING_ALLOCATION_PADDING)
#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)
#define DBUS_STRING_PREAMBLE(str) DBusRealString *real = (DBusRealString*) str; \
DBUS_GENERIC_STRING_PREAMBLE (real); \
_dbus_assert (!(real)->constant); \
_dbus_assert (!(real)->locked)
#define DBUS_LOCKED_STRING_PREAMBLE(str) DBusRealString *real = (DBusRealString*) str; \
DBUS_GENERIC_STRING_PREAMBLE (real); \
_dbus_assert (!(real)->constant)
#define DBUS_CONST_STRING_PREAMBLE(str) const DBusRealString *real = (DBusRealString*) str; \
DBUS_GENERIC_STRING_PREAMBLE (real)
#define DBUS_IS_ASCII_BLANK(c) ((c) == ' ' || (c) == '\t')
#define DBUS_IS_ASCII_WHITE(c) ((c) == ' ' || (c) == '\t' || (c) == '\n' || (c) == '\r')
DBUS_END_DECLS
#endif /* DBUS_STRING_PRIVATE_H */
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
Definition dbus-macros.h:36
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.
Definition dbus-macros.h:37
DBusRealString
Internals of DBusString.
Definition dbus-string-private.h:46
DBusRealString::align_offset
unsigned int align_offset
str - align_offset is the actual malloc block
Definition dbus-string-private.h:53
DBusRealString::valid
unsigned int valid
DBusString is valid (initialized and not freed).
Definition dbus-string-private.h:52
DBusRealString::constant
unsigned int constant
String data is not owned by DBusString.
Definition dbus-string-private.h:50
DBusRealString::locked
unsigned int locked
DBusString has been locked and can't be changed.
Definition dbus-string-private.h:51
DBusRealString::str
unsigned char * str
String data, plus nul termination.
Definition dbus-string-private.h:47
DBusRealString::allocated
int allocated
Allocated size of data.
Definition dbus-string-private.h:49
DBusRealString::len
int len
Length without nul.
Definition dbus-string-private.h:48
DBusString
Definition dbus-string.h:47