universalservice/examples/string/uns_string.h
Peter McGoron 4f7847b2c0 Major API reorganization, test infrastructure
The API is now hidden behind functions. The GC struct can have an
unstable layout without affecting any compiled binaries (users of
Universal Service or collectors hidden behind the API). The
collectors can be called directly if desired.

The API now allows for different allocation flags. These will be
used in future extensions (like weak pointers). For now none are
used.

Tests are compiled for each collector. I can't think of a good
solution that will encompass everything I want to write, but for
now this will work on POSIX systems.
2024-07-08 19:58:22 -04:00

53 lines
2.4 KiB
C

#ifndef UNS_STRING_H
#define UNS_STRING_H
/* Copyright (c) 2024, Peter McGoron
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1) Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2) Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "uns.h"
/* This code implements imperative strings. Imperative strings can be
* updated in-place. This requires storing the amount of memory left in
* the string, and the length of the string itself.
*
* String format:
* record: [slot 1] [slot 2] [slot 3]
* | | |
* size_t size_t bytes
* (allocated length) (used) (size of used)
*/
size_t uns_string_len(Uns_GC gc, struct uns_ctr *root);
char *uns_string_ptr(Uns_GC gc, struct uns_ctr *root);
/* The following functions may cause a collection. */
void uns_string_alloc(Uns_GC gc, struct uns_ctr *root, size_t start_len);
void uns_string_resize(Uns_GC gc, struct uns_ctr *root, size_t newlen);
void uns_string_ensure(Uns_GC gc, struct uns_ctr *root, size_t extent);
void uns_string_append_bytes(Uns_GC gc, struct uns_ctr *to,
const void *from, size_t bytes);
void uns_string_append_char(Uns_GC gc, struct uns_ctr *root, char c);
char *uns_string_cstring(Uns_GC gc, struct uns_ctr *root);
#endif