FreeTDS API: include/freetds/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/pushvis.h>
24
30 extern const struct tds_dstr tds_str_empty;
31
37 #define DSTR_INITIALIZER ((struct tds_dstr*) &tds_str_empty)
38
40 static inline void
41 tds_dstr_init(DSTR * s)
42 {
43 *(s) = DSTR_INITIALIZER;
44 }
45
47 static inline int
48 tds_dstr_isempty(DSTR * s)
49 {
50 return (*s)->dstr_size == 0;
51 }
52
58 static inline char *
59 tds_dstr_buf(DSTR * s)
60 {
61 return (*s)->dstr_s;
62 }
63
65 static inline const char *
66 tds_dstr_cstr(DSTR * s)
67 {
68 return (*s)->dstr_s;
69 }
70
72 static inline size_t
73 tds_dstr_len(DSTR * s)
74 {
75 return (*s)->dstr_size;
76 }
77
79 #define tds_dstr_empty(s) \
80 tds_dstr_free(s)
81
82 void tds_dstr_zero(DSTR * s);
83 void tds_dstr_free(DSTR * s);
84
85 DSTR* tds_dstr_dup(DSTR * s, const DSTR * src) TDS_WUR;
86 DSTR* tds_dstr_copy(DSTR * s, const char *src) TDS_WUR;
87 DSTR* tds_dstr_copyn(DSTR * s, const char *src, size_t length) TDS_WUR;
88 DSTR* tds_dstr_set(DSTR * s, char *src) TDS_WUR;
89
90 DSTR* tds_dstr_setlen(DSTR *s, size_t length);
91 DSTR* tds_dstr_alloc(DSTR *s, size_t length) TDS_WUR;
92
95 #include <freetds/popvis.h>
96
97 #endif /* _tdsstring_h_ */
tds_dstr_set
DSTR * tds_dstr_set(DSTR *s, char *src)
set a string from another buffer.
Definition: tdsstring.c:108
tds_dstr
Structure to hold a string.
Definition: tds.h:94
tds_dstr_isempty
static int tds_dstr_isempty(DSTR *s)
test if string is empty
Definition: string.h:48
tds_dstr_cstr
static const char * tds_dstr_cstr(DSTR *s)
Returns a C version (NUL terminated string) of dstr.
Definition: string.h:66
tds_dstr_dup
DSTR * tds_dstr_dup(DSTR *s, const DSTR *src)
Duplicate a string from another dynamic string.
Definition: tdsstring.c:135
tds_dstr_copy
DSTR * tds_dstr_copy(DSTR *s, const char *src)
copy a string from another
Definition: tdsstring.c:123
DSTR_INITIALIZER
#define DSTR_INITIALIZER
Initializer, used to initialize string like in the following example.
Definition: string.h:37
tds_dstr_init
static void tds_dstr_init(DSTR *s)
init a string with empty
Definition: string.h:41
tds_str_empty
const struct tds_dstr tds_str_empty
Internal representation for an empty string.
Definition: tdsstring.c:46
tds_dstr_free
void tds_dstr_free(DSTR *s)
free string
Definition: tdsstring.c:63
tds_dstr_buf
static char * tds_dstr_buf(DSTR *s)
Returns a buffer to edit the string.
Definition: string.h:59
tds_dstr_zero
void tds_dstr_zero(DSTR *s)
clear all string filling with zeroes (mainly for security reason)
Definition: tdsstring.c:56
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:78
tds_dstr_len
static size_t tds_dstr_len(DSTR *s)
Returns the length of the string in bytes.
Definition: string.h:73
tds_dstr_setlen
DSTR * tds_dstr_setlen(DSTR *s, size_t length)
limit length of string, MUST be <= current length
Definition: tdsstring.c:146
tds_dstr_alloc
DSTR * tds_dstr_alloc(DSTR *s, size_t length)
allocate space for length char
Definition: tdsstring.c:166