git.m6w6.name Git - awesomized/libmemcached/blob - libmemcached/string.h

   1 /* LibMemcached
   2  * Copyright (C) 2006-2009 Brian Aker
   3  * All rights reserved.
   4  *
   5  * Use and distribution licensed under the BSD license.  See
   6  * the COPYING file in the parent directory for full text.
   7  *
   8  * Summary: String structure used for libmemcached.
   9  *
  10  */
  11
  12 #ifndef __MEMCACHED_STRING_H__
  13 #define __MEMCACHED_STRING_H__
  14
  15 #ifdef __cplusplus
  16 extern "C" {
  17 #endif
  18
  19 /**
  20   Strings are always under our control so we make some assumptions
  21   about them.
  22
  23   1) is_initialized is always valid.
  24   2) A string once intialized will always be, until free where we
  25      unset this flag.
  26   3) A string always has a root.
  27 */
  28
  29 struct memcached_string_st {
  30   char *end;
  31   char *string;
  32   size_t current_size;
  33   const memcached_st *root;
  34   struct {
  35     bool is_allocated:1;
  36     bool is_initialized:1;
  37   } options;
  38 };
  39
  40 #define memcached_string_length(A) (size_t)((A)->end - (A)->string)
  41 #define memcached_string_set_length(A, B) (A)->end= (A)->string + B
  42 #define memcached_string_size(A) (A)->current_size
  43 #define memcached_string_value(A) (A)->string
  44
  45 LIBMEMCACHED_LOCAL
  46 memcached_string_st *memcached_string_create(const memcached_st *ptr,
  47                                              memcached_string_st *string,
  48                                              size_t initial_size);
  49 LIBMEMCACHED_LOCAL
  50 memcached_return_t memcached_string_check(memcached_string_st *string, size_t need);
  51
  52 LIBMEMCACHED_LOCAL
  53 char *memcached_string_c_copy(memcached_string_st *string);
  54
  55 LIBMEMCACHED_LOCAL
  56 memcached_return_t memcached_string_append_character(memcached_string_st *string,
  57                                                      char character);
  58 LIBMEMCACHED_LOCAL
  59 memcached_return_t memcached_string_append(memcached_string_st *string,
  60                                            const char *value, size_t length);
  61 LIBMEMCACHED_LOCAL
  62 memcached_return_t memcached_string_reset(memcached_string_st *string);
  63
  64 LIBMEMCACHED_LOCAL
  65 void memcached_string_free(memcached_string_st *string);
  66
  67 #ifdef __cplusplus
  68 }
  69 #endif
  70
  71 #endif /* __MEMCACHED_STRING_H__ */