Line data    Source code

       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 _tdsguard_d2McTbRS3vmVcq0ls4BzwH_
      21             : #define _tdsguard_d2McTbRS3vmVcq0ls4BzwH_
      22             : 
      23             : #include <freetds/macros.h>
      24             : 
      25             : #include <freetds/pushvis.h>
      26             : 
      27             : /** \addtogroup dstring
      28             :  * @{ 
      29             :  */
      30             : 
      31             : /**
      32             :  * Structure to hold a string.
      33             :  * Use tds_dstr_* functions/macros, do not access members directly.
      34             :  * There should be always a buffer.
      35             :  */
      36             : typedef struct tds_dstr {
      37             :         size_t dstr_size;
      38             :         char dstr_s[1];
      39             : } *DSTR;
      40             : 
      41             : /** Internal representation for an empty string */
      42             : extern const struct tds_dstr tds_str_empty;
      43             : 
      44             : /** Initializer, used to initialize string like in the following example
      45             :  * @code
      46             :  * DSTR s = DSTR_INITIALIZER;
      47             :  * @endcode
      48             :  */
      49             : #define DSTR_INITIALIZER ((struct tds_dstr*) &tds_str_empty)
      50             : 
      51             : /** init a string with empty */
      52             : static inline void
      53             : tds_dstr_init(DSTR * s)
      54             : {
      55      652026 :         *(s) = DSTR_INITIALIZER;
      56             : }
      57             : 
      58             : /** test if string is empty */
      59             : static inline int
      60             : tds_dstr_isempty(const DSTR * s)
      61             : {
      62      261419 :         return (*s)->dstr_size == 0;
      63             : }
      64             : 
      65             : /**
      66             :  * Returns a buffer to edit the string.
      67             :  * Be careful to avoid buffer overflows and remember to
      68             :  * set the correct length at the end of the editing if changed.
      69             :  */
      70             : static inline char *
      71             : tds_dstr_buf(DSTR * s)
      72             : {
      73      155529 :         return (*s)->dstr_s;
      74             : }
      75             : 
      76             : /** Returns a C version (NUL terminated string) of dstr */
      77             : static inline const char *
      78             : tds_dstr_cstr(const DSTR * s)
      79             : {
      80      231217 :         return (*s)->dstr_s;
      81             : }
      82             : 
      83             : /** Returns the length of the string in bytes */
      84             : static inline size_t
      85             : tds_dstr_len(const DSTR * s)
      86             : {
      87       69437 :         return (*s)->dstr_size;
      88             : }
      89             : 
      90             : /** Make a string empty */
      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             : 
     105             : /** @} */
     106             : 
     107             : #include <freetds/popvis.h>
     108             : 
     109             : #endif /* _tdsguard_d2McTbRS3vmVcq0ls4BzwH_ */