string.h

The string.h module provides utility methods for interacting with strings in a consistent and safe manner.

API

Views

struct mn_view

A portion of a string. Unlike the mn_str type, this type only refers to part of a backing string. This backing string must remain valid for the duration of a mn_view instance’s lifetime.

size_t len

The length of the referenced portion of some string.

PRImnv

A utility macro for including the contents of a mn_view into a printf call. Should be used with mn_view_pri. For example:

struct mn_view const v = mn_view_ref("hello, world", 5);
printf("View: " PRImnv "\n", mn_view_pri(v));
// Outputs: View hello\n
mn_view_pri(X)

A utility macro for including the contents of a mn_view into a printf call. Should be used with PRImnv. For example:

struct mn_view const v = mn_view_ref("hello, world", 5);
printf("View: " PRImnv "\n", mn_view_pri(v));
// Outputs: View hello\n
struct mn_view const mn_view_ref(
char const ss[static 1],
size_t const len
)

Create a new mn_view pointing to ss with length len.

Parameters:

  • ss – The C-string to point to. Must remain valid during the lifetime of the mn_view instance.

  • len – The length of the portion of the string the mn_view references.

struct mn_view const mn_view_substr(
struct mn_view const v,
size_t const i,
size_t const j
)

Create a subview of another.

Parameters:

  • v – The mn_view to take a subview of.

  • i – The starting index of the subview, inclusive.

  • j – The ending index of the subview, exclusive.

size_t mn_view_cpy(
char *const dst,
struct mn_view const src,
size_t const count
)

Copy the contents of src into dst.

Parameters:

  • dst – The buffer to copy src into.

  • src – The string to copy into dst.

  • count – OPTIONAL. The maximum number of characters to copy. Ignored if greater than src’s len. If excluded, SIZE_MAX is assumed.

size_t mn_view_find(
struct mn_view const haystack,
struct mn_view const needle
)

Find the first index of haystack in which subview needle is found.

Parameters:

  • haystack – The view to search the needle in.

  • needle – The subview to search for.

Returns:

The index the needle was found starting at. If not present, haystack.len is returned instead.

bool mn_view_eq(struct mn_view const, struct mn_view const)

Case-sensitive equality checking. Checks two mn_view instances are equal, byte-per-byte.

bool mn_view_ieq(struct mn_view const, struct mn_view const)

Case-insensitive equality checking. Checks two mn_view instances are equal, ignoring case for ASCII characters. In other words, this only works as outlined when restricting attention to just strings in the BMP.

Strings

struct mn_str

A thin wrapper around a C-style string. Unlike the mn_view type, this type always refers to the entirety of a backing string. This backing string must remain valid for the duration of a mn_str instance’s lifetime.

This type is primarily motivated as a convenient means of referencing C-style strings’ length.

char const *ss

The backing string.

size_t len

The length of the backing string excluding the trailing NUL character.

mn_str_lit(X)

Create a new mn_str instance pointing at C-string literal X. It is assumed X does not contain embedded NUL characters.

struct mn_str const mn_str_ref(
char const ss[static 1],
size_t const len
)

Create a new mn_str pointing to ss with length len. It is assumed ss does not contain embedded NUL characters and is NUL-terminated with ss[len] == '\0'.

Parameters:

  • ss – The C-string to point to. Must remain valid during the lifetime of the mn_str instance.

  • len – The length of ss excluding the trailing NUL character.