strings.h File Reference

#include <stddef.h>
#include <stdint.h>

Include dependency graph for strings.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	srn_string_t

Macros
#define	SRN_STRING_MAX_LEN   (1U << 20U)
	On top of my head, no other reason.

Typedefs
typedef struct srn_string_t	srn_string_t

Functions
srn_value_t *	srn_string_make (srn_context_t *ctx, srn_metadata_t *metadata, const char *src)
	Create a string from a null terminated C string.
size_t	srn_string_size (const srn_string_t *s)
size_t	srn_string_length (const srn_string_t *s)
srn_string_t *	srn_string_copy (srn_context_t *ctx, const srn_string_t *src)
	Copy the src string to dst string.
bool	srn_string_is_empty (const srn_string_t *s)
bool	srn_string_eq (const srn_string_t *a, const srn_string_t *b)

Macro Definition Documentation

SRN_STRING_MAX_LEN

#define SRN_STRING_MAX_LEN   (1U << 20U)

On top of my head, no other reason.

Definition at line 31 of file strings.h.

Typedef Documentation

srn_string_t

typedef struct srn_string_t srn_string_t

Function Documentation

srn_string_copy()

srn_string_t * srn_string_copy	(	srn_context_t *	ctx,
		const srn_string_t *	src )

Copy the src string to dst string.

It's important to note that dst has to be allocated already

Definition at line 38 of file strings.c.

                                                                           {
  PANIC_IF_NULL(ctx);
  size_t alloc_size = sizeof(srn_string_t) + src->size;
  srn_string_t *copy = srn_allocate(ctx, alloc_size, alignof(srn_string_t));
  memcpy(copy->buffer, src->buffer, src->size);
  copy->size = src->size;
  copy->len = src->len;
  return copy;
}

Here is the call graph for this function:

Here is the caller graph for this function:

srn_string_eq()

bool srn_string_eq	(	const srn_string_t *	a,
		const srn_string_t *	b )

Definition at line 76 of file strings.c.

                                                                 {
  if (a == nullptr || b == nullptr || (a->size != b->size)) {
    return false;
  }
 
  return memcmp(&a->buffer, &b->buffer, a->size) == 0;
}

Here is the caller graph for this function:

srn_string_is_empty()

bool srn_string_is_empty

(

const srn_string_t *

s

)

Definition at line 48 of file strings.c.

{ return s->len == 0; }

Here is the caller graph for this function:

srn_string_length()

size_t srn_string_length

(

const srn_string_t *

s

)

Definition at line 33 of file strings.c.

                                                {
  PANIC_IF_NULL(s);
  return s->len;
}

srn_string_make()

srn_value_t * srn_string_make	(	srn_context_t *	ctx,
		srn_metadata_t *	metadata,
		const char *	src )

Create a string from a null terminated C string.

IT HAS TO BE NULL TERMINATED

Definition at line 50 of file strings.c.

                                                                                            {
  PANIC_IF_NULL(ctx);
  size_t size = strnlen(src, SRN_STRING_MAX_LEN);
  if (size == SRN_STRING_MAX_LEN) {
    return srn_errors_make_error(
        ctx, metadata, STRING_LENGTH_LIMIT_EXCEEDED,
        "Check your string to be null terminated and smaller than (1 << 20)");
  }
 
  // The one is there for '\0'. We include the null terminator to have easier
  // time dealing with C strings
  size_t alloc_size = sizeof(srn_string_t) + size + 1;
  srn_string_t *string = srn_allocate(ctx, alloc_size, alignof(srn_string_t));
  // For now we only handle ASCII, but when we implement WTF8 we should
  // handel len here
 
  string->len = size;
  string->size = size + 1; // Again null terminator
  memcpy(&string->buffer, src, size);
  // Inject the null terminator at the end of the buffer to make it C friendly
  string->buffer[string->len] = '\0';
 
  srn_value_t *string_value = srn_value_make(ctx, VString, metadata, (void *)string);
  return string_value;
}

Here is the call graph for this function:

Here is the caller graph for this function:

srn_string_size()

size_t srn_string_size

(

const srn_string_t *

s

)

Definition at line 28 of file strings.c.

                                              {
  PANIC_IF_NULL(s);
  return s->size;
}