dao_dynamic_string.h

Go to the documentation of this file.

/* SPDX-License-Identifier: Marvell-MIT
 * Copyright (c) 2023 Marvell.
 */
 
#ifndef _DAO_DYNAMIC_STRING_H_
#define _DAO_DYNAMIC_STRING_H_
 
#include <stdarg.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#include <assert.h>
 
#include <rte_config.h>
#include <rte_common.h>
#include <rte_compat.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct dao_ds {
    char *string;       /*< Null-terminated string. */
    size_t length;      /*< Bytes used, not including null terminator. */
    size_t allocated;   /*< Bytes allocated, not including null terminator. */
};
 
#define DS_EMPTY_INITIALIZER { NULL, 0, 0 }
 
void dao_ds_init(struct dao_ds *ds);
 
void dao_ds_clear(struct dao_ds *ds);
 
void dao_ds_truncate(struct dao_ds *ds, size_t new_length);
 
void dao_ds_reserve(struct dao_ds *ds, size_t min_length);
 
char *dao_ds_put_uninit(struct dao_ds *ds, size_t n);
 
void dao_ds_put_utf8(struct dao_ds *ds, int uc);
 
void dao_ds_put_char_multiple(struct dao_ds *ds, char c, size_t n);
 
void dao_ds_put_buffer(struct dao_ds *ds, const char *buf, size_t n);
 
void dao_ds_put_cstr(struct dao_ds *ds, const char *str);
 
void dao_ds_put_and_free_cstr(struct dao_ds *ds, char *str);
 
void dao_ds_put_format(struct dao_ds *ds, const char *format, ...);
 
void dao_ds_put_format_valist(struct dao_ds *ds, const char *format, va_list va);
 
void dao_ds_put_printable(struct dao_ds *ds, const char *buf, size_t size);
 
void dao_ds_put_hex(struct dao_ds *ds, const void *buf, size_t size);
 
void dao_ds_put_hex_dump(struct dao_ds *ds, const void *buf, size_t size,
             uintptr_t ofs, bool ascii);
 
void dao_ds_put_sparse_hex_dump(struct dao_ds *ds, const void *buf, size_t size,
                uintptr_t ofs, bool ascii);
int dao_ds_get_line(struct dao_ds *ds, FILE *file);
 
int dao_ds_get_preprocessed_line(struct dao_ds *ds, FILE *file, int *line_numberp);
 
int dao_ds_get_test_line(struct dao_ds *ds, FILE *file);
 
char *dao_ds_cstr(struct dao_ds *ds);
 
char *dao_ds_steal_cstr(struct dao_ds *ds);
 
void dao_ds_destroy(struct dao_ds *ds);
 
void dao_ds_swap(struct dao_ds *a, struct dao_ds *b);
 
int dao_ds_last(const struct dao_ds *ds);
 
bool dao_ds_chomp(struct dao_ds *ds, int c);
 
void dao_ds_clone(struct dao_ds *dst, struct dao_ds *source);
 
void dao_ds_put_char__(struct dao_ds *ds, char c);
 
/* Inline functions. */
static inline void
dao_ds_put_char(struct dao_ds *ds, char c)
{
    if (ds->length < ds->allocated) {
        ds->string[ds->length++] = c;
        ds->string[ds->length] = '\0';
    } else {
        dao_ds_put_char__(ds, c);
    }
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* dao_dynamic_string.h */