de/d67/stringy_8h_source.html

#ifndef PRISM_STRINGY_H

#define PRISM_STRINGY_H


#include "prism/compiler/exported.h"

#include "prism/compiler/nonnull.h"


#include <stddef.h>

#include <stdint.h>


#ifdef __cplusplus

extern "C" {

#endif


typedef struct {

    const uint8_t *source;


    size_t length;

} pm_string_t;


PRISM_EXPORTED_FUNCTION void pm_string_init(pm_string_t *string, const uint8_t *source, size_t length) PRISM_NONNULL(1);


PRISM_EXPORTED_FUNCTION size_t pm_string_length(const pm_string_t *string) PRISM_NONNULL(1);


PRISM_EXPORTED_FUNCTION const uint8_t * pm_string_source(const pm_string_t *string) PRISM_NONNULL(1);


#ifdef __cplusplus

}

#endif


#endif

exported.h

PRISM_EXPORTED_FUNCTION
#define PRISM_EXPORTED_FUNCTION
By default, we compile with -fvisibility=hidden.
Definition exported.h:20

nonnull.h

PRISM_NONNULL
#define PRISM_NONNULL(...)
Mark the parameters of a function as non-null.
Definition nonnull.h:13

pm_string_init
PRISM_EXPORTED_FUNCTION void pm_string_init(pm_string_t *string, const uint8_t *source, size_t length) PRISM_NONNULL(1)
Initialize a string that views the given bytes.
Definition stringy.c:23

pm_string_length
PRISM_EXPORTED_FUNCTION size_t pm_string_length(const pm_string_t *string) PRISM_NONNULL(1)
Returns the length associated with the string.
Definition stringy.c:51

pm_string_source
PRISM_EXPORTED_FUNCTION const uint8_t * pm_string_source(const pm_string_t *string) PRISM_NONNULL(1)
Returns the start pointer associated with the string.
Definition stringy.c:59

pm_string_t
A view of a sequence of bytes.
Definition stringy.h:23

pm_string_t::source
const uint8_t * source
A pointer to the start of the string.
Definition stringy.h:25

pm_string_t::length
size_t length
The length of the string in bytes of memory.
Definition stringy.h:28