FreeTDS API: include/freetds/utils/string.h Source File

FreeTDS API

string.h
1 /* FreeTDS - Library of routines accessing Sybase and Microsoft databases
2 * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004 Brian Bruns
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
13 *
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
18 */
19
20 #ifndef _tdsstring_h_
21 #define _tdsstring_h_
22
23 #include <freetds/macros.h>
24
25 #include <freetds/pushvis.h>
26
36 typedef struct tds_dstr {
37 size_t dstr_size;
38 char dstr_s[1];
39 } *DSTR;
40
42 extern const struct tds_dstr tds_str_empty;
43
49 #define DSTR_INITIALIZER ((struct tds_dstr*) &tds_str_empty)
50
52 static inline void
53 tds_dstr_init(DSTR * s)
54 {
55 *(s) = DSTR_INITIALIZER;
56 }
57
59 static inline int
60 tds_dstr_isempty(const DSTR * s)
61 {
62 return (*s)->dstr_size == 0;
63 }
64
70 static inline char *
71 tds_dstr_buf(DSTR * s)
72 {
73 return (*s)->dstr_s;
74 }
75
77 static inline const char *
78 tds_dstr_cstr(const DSTR * s)
79 {
80 return (*s)->dstr_s;
81 }
82
84 static inline size_t
85 tds_dstr_len(const DSTR * s)
86 {
87 return (*s)->dstr_size;
88 }
89
91 #define tds_dstr_empty(s) \
92 tds_dstr_free(s)
93
94 void tds_dstr_zero(DSTR * s);
95 void tds_dstr_free(DSTR * s);
96
97 DSTR* tds_dstr_dup(DSTR * s, const DSTR * src) TDS_WUR;
98 DSTR* tds_dstr_copy(DSTR * s, const char *src) TDS_WUR;
99 DSTR* tds_dstr_copyn(DSTR * s, const char *src, size_t length) TDS_WUR;
100 DSTR* tds_dstr_set(DSTR * s, char *src) TDS_WUR;
101
102 DSTR* tds_dstr_setlen(DSTR *s, size_t length);
103 DSTR* tds_dstr_alloc(DSTR *s, size_t length) TDS_WUR;
104
107 #include <freetds/popvis.h>
108
109 #endif /* _tdsstring_h_ */
tds_dstr_init
static void tds_dstr_init(DSTR *s)
init a string with empty
Definition: string.h:53
tds_dstr_cstr
static const char * tds_dstr_cstr(const DSTR *s)
Returns a C version (NUL terminated string) of dstr.
Definition: string.h:78
tds_dstr_isempty
static int tds_dstr_isempty(const DSTR *s)
test if string is empty
Definition: string.h:60
tds_dstr_copyn
DSTR * tds_dstr_copyn(DSTR *s, const char *src, size_t length)
Set string to a given buffer of characters.
Definition: tdsstring.c:77
tds_dstr_dup
DSTR * tds_dstr_dup(DSTR *s, const DSTR *src)
Duplicate a string from another dynamic string.
Definition: tdsstring.c:134
tds_dstr_setlen
DSTR * tds_dstr_setlen(DSTR *s, size_t length)
limit length of string, MUST be <= current length
Definition: tdsstring.c:145
tds_str_empty
const struct tds_dstr tds_str_empty
Internal representation for an empty string.
Definition: tdsstring.c:45
tds_dstr_set
DSTR * tds_dstr_set(DSTR *s, char *src)
set a string from another buffer.
Definition: tdsstring.c:107
DSTR
struct tds_dstr * DSTR
Structure to hold a string.
tds_dstr
Structure to hold a string.
Definition: string.h:36
tds_dstr_alloc
DSTR * tds_dstr_alloc(DSTR *s, size_t length)
allocate space for length char
Definition: tdsstring.c:165
tds_dstr_free
void tds_dstr_free(DSTR *s)
free string
Definition: tdsstring.c:62
tds_dstr_copy
DSTR * tds_dstr_copy(DSTR *s, const char *src)
copy a string from another
Definition: tdsstring.c:122
tds_dstr_len
static size_t tds_dstr_len(const DSTR *s)
Returns the length of the string in bytes.
Definition: string.h:85
DSTR_INITIALIZER
#define DSTR_INITIALIZER
Initializer, used to initialize string like in the following example.
Definition: string.h:49
tds_dstr_buf
static char * tds_dstr_buf(DSTR *s)
Returns a buffer to edit the string.
Definition: string.h:71
tds_dstr_zero
void tds_dstr_zero(DSTR *s)
clear all string filling with zeroes (mainly for security reason)
Definition: tdsstring.c:55