summaryrefslogtreecommitdiffhomepage
path: root/docs/csview_api.md
blob: 2653dafaafde2f4bf74a23696a87ef5af3be5cc1 (plain)
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# STC [csview](../include/stc/csview.h): String View
![String](pics/string.jpg)

The type **csview** is a string view and can refer to a constant contiguous sequence of char-elements with the first
element of the sequence at position zero. The implementation holds two members: a pointer to constant char and a size.

**csview** is an efficient replacent for `const char*`. It never allocates memory, and therefore need not be destructed.
Its lifetime is limited by the source string storage. It keeps the length of the string, and does not call *strlen()*
when passing it around. It is faster when using`csview` as convertion type (raw) than `const char*` in associative
containers with cstr keys.

Note: a **csview** may ***not be null-terminated***, and must therefore be printed like: 
`printf("%.*s", csview_ARG(sv))`.

See the c++ class [std::basic_string_view](https://en.cppreference.com/w/cpp/string/basic_string_view) for a functional
description.

## Header file

All csview definitions and prototypes are available by including a single header file.

```c
#include <stc/csview.h>
```
## Methods

```c
csview        csview_new(const char literal_only[]);                // make csview from literal, no strlen()
csview        csview_from_s(cstr s);                                // same as cstr_sv()
csview        csview_from(const char* str);                         // make csview from const char*
csview        csview_from_n(const char* str, size_t n);             // construct 
csview        c_sv(const char literal_only[]);                      // same as csview_new()

size_t        csview_size(csview sv);
size_t        csview_length(csview sv);
bool          csview_empty(csview sv);
char          csview_front(csview sv);
char          csview_back(csview sv);

void          csview_clear(csview* self);

csview        csview_substr(csview sv, intptr_t pos, size_t n);    // negative pos count from end
csview        csview_slice(csview sv, intptr_t p1, intptr_t p2);   // negative p1, p2 count from end
csview        csview_first_token(csview sv, csview sep);           // see split example below.
csview        csview_next_token(csview sv, csview sep, csview token);

bool          csview_equals(csview sv, csview sv2);
size_t        csview_find(csview sv, csview needle);
bool          csview_contains(csview sv, csview needle);
bool          csview_starts_with(csview sv, csview sub);
bool          csview_ends_with(csview sv, csview sub);

csview_iter   csview_begin(const csview* self);
csview_iter   csview_end(const csview* self);
void          csview_next(csview_iter* it);
```
#### Extended cstr methods
```c
cstr          cstr_from_v(csview sv);                         // construct cstr from csview
cstr          cstr_from_replace_all_v(csview sv, csview find, csview replace);

csview        cstr_sv(cstr s);                                // convert to csview from cstr
csview        cstr_to_v(const cstr* self);                    // convert to csview from cstr*
csview        cstr_substr(cstr s, intptr_t pos, size_t n);    // negative pos counts from end
csview        cstr_slice(cstr s, intptr_t p1, intptr_t p2);   // negative p1, p2 counts from end

cstr*         cstr_assign_v(cstr* self, csview sv);
cstr*         cstr_append_v(cstr* self, csview sv);
void          cstr_insert_v(cstr* self, size_t pos, csview sv);
void          cstr_replace_v(cstr* self, size_t pos, size_t len, csview sv);

bool          cstr_equals_v(cstr s, csview sv);
size_t        cstr_find_v(cstr s, csview needle);
bool          cstr_contains_v(cstr s, csview needle);
bool          cstr_starts_with_v(cstr s, csview sub);
bool          cstr_ends_with_v(cstr s, csview sub);
```
#### Helper methods
```c
int           csview_compare(const csview* x, const csview* y);
bool          csview_equalto(const csview* x, const csview* y);
uint64_t      csview_hash(const csview* x, size_t dummy);
```
## Types

| Type name       | Type definition                           | Used to represent...     |
|:----------------|:------------------------------------------|:-------------------------|
| `csview`        | `struct { const char *str; size_t size }` | The string view type     |
| `csview_value`  | `char`                                    | The string element type  |
| `csview_iter`   | `struct { csview_value *ref; }`           | csview iterator          |

## Constants and macros

| Name             | Value               | Usage                             |
|:-----------------|:--------------------|:----------------------------------|
| `csview_null`    | same as `c_sv("")`  | `sview = csview_null;`            |
| `csview_npos`    | same as `cstr_npos` |                                   |
| `csview_ARG(sv)` | printf argument     | `printf("%.*s", csview_ARG(sv));` |

## Example
```c
#include <stc/csview.h>

int main ()
{
    cstr str1 = cstr_new("We think in generalities, but we live in details.");
                                                    // (quoting Alfred N. Whitehead)

    csview sv1 = cstr_substr(str1, 3, 5);           // "think"
    size_t pos = cstr_find(str1, "live");           // position of "live" in str1
    csview sv2 = cstr_substr(str1, pos, 4);         // get "live"
    csview sv3 = cstr_slice(str1, -8, -1);          // get "details"
    printf("%.*s %.*s %.*s\n", csview_ARG(sv1), csview_ARG(sv2), csview_ARG(sv3));

    cstr s1 = cstr_new("Apples are red");
    cstr s2 = cstr_from_v(cstr_substr(s1, -3, 3));  // "red"
    cstr s3 = cstr_from_v(cstr_substr(s1, 0, 6));   // "Apples"
    printf("%s %s\n", s2, s3.str);

    c_del(cstr, &str1, &s1, &s2, &s3);
}
```
Output:
```
think live details
red Apples
```

### Example 2: csview tokenizer (string split)
Splits strings into tokens. *print_split()* makes **no** memory allocations or *strlen()* calls,
and does not depend on null-terminated strings. *string_split()* function returns a vector of cstr.
```c
#include <stc/csview.h>

void print_split(csview str, csview sep)
{
    csview token = csview_first_token(str, sep);
    for (;;) {
        // print non-null-terminated csview
        printf("\"%.*s\"\n", csview_ARG(token));
        if (csview_end(&token).ref == csview_end(&str).ref) break;
        token = csview_next_token(str, sep, token);
    }
}

#define i_val_str
#include <stc/cvec.h>

cvec_str string_split(csview str, csview sep)
{
    cvec_str vec = cvec_str_init();
    csview token = csview_first_token(str, sep);
    for (;;) {
        cvec_str_push_back(&vec, cstr_from_v(token));
        if (csview_end(&token).ref == csview_end(&str).ref) break;
        token = csview_next_token(str, sep, token);
    }
    return vec;
}

int main()
{
    print_split(c_sv("//This is a//double-slash//separated//string"), c_sv("//"));
    puts("");
    print_split(c_sv("This has no matching separator"), c_sv("xx"));
    puts("");

    c_autovar (cvec_str v = string_split(c_sv("Split,this,,string,now,"), c_sv(",")), cvec_str_del(&v))
        c_foreach (i, cvec_str, v)
            printf("\"%s\"\n", i.ref->str);
}
```
Output:
```
""
"This is a"
"double-slash"
"separated"
"string"

"This has no matching separator"

"Split"
"this"
""
"string"
"now"
""