rosie-sys 1.3.0

A crate to build or link to librosie to access the Rosie Pattern Language
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

/*  -*- Mode: C/l; -*-                                                       */
/*                                                                           */
/*  rosiestring.c  Part of librosie.c                                        */
/*                                                                           */
/*  © Copyright Jamie A. Jennings 2017, 2018, 2019, 2021.                    */
/*  LICENSE: MIT License (https://opensource.org/licenses/mit-license.html)  */
/*  AUTHOR: Jamie A. Jennings                                                */

/* Symbol visibility in the final library */
#define EXPORT __attribute__ ((visibility("default")))

/* Constant strings are statically allocated in C, so there is no need
 * to copy one in order to return a pointer to it.  However, our API
 * policy is that the client must call rosie_free_string(messages)
 * when librosie returns a non-NULL messages.ptr.  It is an error to
 * free a statically allocated string, so we are forced to (malloc) a
 * copy to return to the client.
 */
static str rosie_new_string_from_const(const char *msg) {
  size_t len = strlen(msg);
  return rosie_new_string((byte_ptr) msg, len);
}

/* Caller must ensure liveness of msg.  Typically, msg must be
 * allocated on the heap.
 */
EXPORT
str rosie_string_from(byte_ptr msg, size_t len) {
  str retval;
  retval.len = len;
  retval.ptr = msg;
  return retval;
}

/* Caller must ensure liveness of msg.  Typically, msg must be
 * allocated on the heap.  Caller must free the str memory (though
 * not necessarily the msg memory).
 */
EXPORT
str *rosie_string_ptr_from(byte_ptr msg, size_t len) {
  str *retval = malloc(sizeof(str));
  if (!retval) {
    display("Out of memory (new2)");
    return NULL;
  }
  retval->ptr = msg;
  retval->len = len;
  return retval;
}     

/* Copies msg into heap-allocated storage */
EXPORT
str rosie_new_string(byte_ptr msg, size_t len) {
  byte_ptr new = malloc(len);
  if (!new) {
    display("Out of memory (new0)");
    return rosie_string_from(NULL, 0);
  }
  memcpy((char *)new, msg, len);
  return rosie_string_from(new, len);
}

/* Copies msg into heap-allocated storage */
EXPORT
str *rosie_new_string_ptr(byte_ptr msg, size_t len) {
  str temp = rosie_new_string(msg, len);
  return rosie_string_ptr_from(temp.ptr, temp.len);
}

/* Frees str struct AND msg storage */
EXPORT
void rosie_free_string_ptr(str *ref) {
  if (ref->ptr) free((void *) ref->ptr);
  free(ref);
}

/* Frees msg storage */
EXPORT
void rosie_free_string(str s) {
  if (s.ptr) free((void *) s.ptr);
}