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

   1 /*  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
   2  *
   3  *  Libmemcached library
   4  *
   5  *  Copyright (C) 2011 Data Differential, http://datadifferential.com/
   6  *  Copyright (C) 2006-2009 Brian Aker All rights reserved.
   7  *
   8  *  Redistribution and use in source and binary forms, with or without
   9  *  modification, are permitted provided that the following conditions are
  10  *  met:
  11  *
  12  *      * Redistributions of source code must retain the above copyright
  13  *  notice, this list of conditions and the following disclaimer.
  14  *
  15  *      * Redistributions in binary form must reproduce the above
  16  *  copyright notice, this list of conditions and the following disclaimer
  17  *  in the documentation and/or other materials provided with the
  18  *  distribution.
  19  *
  20  *      * The names of its contributors may not be used to endorse or
  21  *  promote products derived from this software without specific prior
  22  *  written permission.
  23  *
  24  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  27  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  28  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  30  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  34  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35  *
  36  */
  37
  38 #pragma once
  39
  40 #include <libmemcached/basic_string.h>
  41
  42 /**
  43   Strings are always under our control so we make some assumptions
  44   about them.
  45
  46   1) is_initialized is always valid.
  47   2) A string once intialized will always be, until free where we
  48      unset this flag.
  49   3) A string always has a root.
  50 */
  51
  52 struct memcached_string_st {
  53   char *end;
  54   char *string;
  55   size_t current_size;
  56   memcached_st *root;
  57   struct {
  58     bool is_allocated:1;
  59     bool is_initialized:1;
  60   } options;
  61 };
  62
  63 #ifdef __cplusplus
  64 extern "C" {
  65 #endif
  66
  67 LIBMEMCACHED_LOCAL
  68 memcached_string_st *memcached_string_create(memcached_st *ptr,
  69                                              memcached_string_st *string,
  70                                              size_t initial_size);
  71 LIBMEMCACHED_LOCAL
  72 memcached_return_t memcached_string_check(memcached_string_st *string, size_t need);
  73
  74 LIBMEMCACHED_LOCAL
  75 char *memcached_string_c_copy(memcached_string_st *string);
  76
  77 LIBMEMCACHED_LOCAL
  78 memcached_return_t memcached_string_append_character(memcached_string_st *string,
  79                                                      char character);
  80 LIBMEMCACHED_LOCAL
  81 memcached_return_t memcached_string_append(memcached_string_st *string,
  82                                            const char *value, size_t length);
  83 LIBMEMCACHED_LOCAL
  84 memcached_return_t memcached_string_reset(memcached_string_st *string);
  85
  86 LIBMEMCACHED_LOCAL
  87 void memcached_string_free(memcached_string_st *string);
  88
  89 LIBMEMCACHED_LOCAL
  90 size_t memcached_string_length(const memcached_string_st *self);
  91
  92 LIBMEMCACHED_LOCAL
  93 size_t memcached_string_size(const memcached_string_st *self);
  94
  95 LIBMEMCACHED_LOCAL
  96 const char *memcached_string_value(const memcached_string_st *self);
  97
  98 LIBMEMCACHED_LOCAL
  99 char *memcached_string_take_value(memcached_string_st *self);
 100
 101 LIBMEMCACHED_LOCAL
 102 char *memcached_string_value_mutable(const memcached_string_st *self);
 103
 104 LIBMEMCACHED_LOCAL
 105 void memcached_string_set_length(memcached_string_st *self, size_t length);
 106
 107 #ifdef __cplusplus
 108 }
 109 #endif