as_string_builder.h

Go to the documentation of this file.

/* 
 * Copyright 2008-2024 Aerospike, Inc.
 *
 * Portions may be licensed to Aerospike, Inc. under one or more contributor
 * license agreements.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
#pragma once
 
#include <aerospike/as_std.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
//---------------------------------
// Types
//---------------------------------
 
/**
 * Fast, non thread safe string builder implementation.
 */
typedef struct as_string_builder_s {
    /**
     * String Buffer
     */
    char* data;
 
    /**
     * Number of bytes allocated to the buffer
     */
    uint32_t capacity;
 
    /**
     * String length of buffer.
     */
    uint32_t length;
    
    /**
     * Allow resize.
     */
    bool resize;
    
    /**
     * Should buffer be freed on destroy.
     */
    bool free;
} as_string_builder;
 
//---------------------------------
// Macros
//---------------------------------
    
/**
 * Initialize string builder with a stack allocated buffer.
 */
#define as_string_builder_inita(__sb, __capacity, __resize)\
(__sb)->data = alloca(__capacity);\
(__sb)->data[0] = 0;\
(__sb)->capacity = (__capacity);\
(__sb)->length = 0;\
(__sb)->resize = (__resize);\
(__sb)->free = false;
    
//---------------------------------
// Functions
//---------------------------------
    
/**
 * Initialize string builder with a heap allocated buffer.
 */
AS_EXTERN void
as_string_builder_init(as_string_builder* sb, uint32_t capacity, bool resize);
 
/**
 * Assign external buffer to string builder.  External buffers are not resized.
 */
static inline void
as_string_builder_assign(as_string_builder* sb, uint32_t buffer_size, char* buffer)
{
    sb->data = buffer;
    sb->data[0] = 0;
    sb->capacity = buffer_size;
    sb->length = 0;
    sb->resize = false;
    sb->free = false;
}
 
/**
 * Free the resources allocated to the buffer.
 */
AS_EXTERN void
as_string_builder_destroy(as_string_builder* sb);
 
/**
 * Initialize to empty string from current state.
 * Capacity remains unchanged.
 */
static inline void
as_string_builder_reset(as_string_builder* sb)
{
    sb->data[0] = 0;
    sb->length = 0;
}
 
/**
 * Append null terminated string value to string buffer.
 * Returns if successful or not.
 */
AS_EXTERN bool
as_string_builder_append(as_string_builder* sb, const char* value);
 
/**
 * Append a single character to string buffer.
 * Returns if successful or not.
 */
AS_EXTERN bool
as_string_builder_append_char(as_string_builder* sb, char value);
 
/**
 * Append bytes in hex format to string buffer.
 * Returns if successful or not.
 */
AS_EXTERN bool
as_string_builder_append_bytes(as_string_builder* sb, uint8_t* src, uint32_t size);
 
/**
 * Append integer to string buffer.
 * Returns if successful or not.
 */
AS_EXTERN bool
as_string_builder_append_int(as_string_builder* sb, int val);
 
/**
 * Append unsigned integer to string buffer.
 * Returns if successful or not.
 */
AS_EXTERN bool
as_string_builder_append_uint(as_string_builder* sb, uint32_t val);
 
/**
 * Append signed 64 bit integer to string buffer.
 * Returns if successful or not.
 */
AS_EXTERN bool
as_string_builder_append_int64(as_string_builder* sb, int64_t val);
 
/**
 * Append unsigned 64 bit integer to string buffer.
 * Returns if successful or not.
 */
AS_EXTERN bool
as_string_builder_append_uint64(as_string_builder* sb, uint64_t val);
 
/**
 * Append newline to string buffer.
 * Returns if successful or not.
 */
static inline bool
as_string_builder_append_newline(as_string_builder* sb)
{
    return as_string_builder_append_char(sb, '\n');
}
 
#ifdef __cplusplus
} // end extern "C"
#endif