summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-12-22 09:07:40 +0100
committerTyge Løvset <[email protected]>2021-12-22 09:07:40 +0100
commitf69f26927edb7e2850a5a235ed5117f278f437a1 (patch)
tree7ed42e8654c81f3c3a49298b53530c1f9d5400ac /docs
parent6e65e30c6e3c2bc271d3885e749ceb0289bbd9cf (diff)
downloadSTC-modified-f69f26927edb7e2850a5a235ed5117f278f437a1.tar.gz
STC-modified-f69f26927edb7e2850a5a235ed5117f278f437a1.zip
Renamed '_rawvalue\b' to '_raw'
Diffstat (limited to 'docs')
-rw-r--r--docs/ccommon_api.md2
-rw-r--r--docs/cdeq_api.md4
-rw-r--r--docs/clist_api.md4
-rw-r--r--docs/cmap_api.md10
-rw-r--r--docs/cqueue_api.md2
-rw-r--r--docs/cset_api.md2
-rw-r--r--docs/csmap_api.md8
-rw-r--r--docs/csptr_api.md6
-rw-r--r--docs/csset_api.md2
-rw-r--r--docs/cstack_api.md8
-rw-r--r--docs/cvec_api.md4
11 files changed, 26 insertions, 26 deletions
diff --git a/docs/ccommon_api.md b/docs/ccommon_api.md
index eec56490..9c872519 100644
--- a/docs/ccommon_api.md
+++ b/docs/ccommon_api.md
@@ -137,7 +137,7 @@ c_forrange (i, int, 30, 0, -5) printf(" %d", i);
// apply multiple push_backs
c_apply(v, cvec_i_push_back(&vec, v), int, {1, 2, 3});
// inserts to existing map
-c_apply(v, cmap_i_insert(&map, c_pair(v)), cmap_i_rawvalue, { {4, 5}, {6, 7} });
+c_apply(v, cmap_i_insert(&map, c_pair(v)), cmap_i_raw, { {4, 5}, {6, 7} });
int arr[] = {1, 2, 3};
c_apply_arr(v, cvec_i_push_back(&vec, v), int, arr, c_arraylen(arr));
diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md
index ce14184f..b884c62d 100644
--- a/docs/cdeq_api.md
+++ b/docs/cdeq_api.md
@@ -78,7 +78,7 @@ cdeq_X_iter cdeq_X_begin(const cdeq_X* self);
cdeq_X_iter cdeq_X_end(const cdeq_X* self);
void cdeq_X_next(cdeq_X_iter* it);
-cdeq_X_rawvalue cdeq_X_value_toraw(cdeq_X_value* pval);
+cdeq_X_raw cdeq_X_value_toraw(cdeq_X_value* pval);
cdeq_X_value cdeq_X_value_clone(cdeq_X_value val);
```
@@ -88,7 +88,7 @@ cdeq_X_value cdeq_X_value_clone(cdeq_X_value val);
|:-------------------|:------------------------------------|:-----------------------|
| `cdeq_X` | `struct { cdeq_X_value* data; }` | The cdeq type |
| `cdeq_X_value` | `i_val` | The cdeq value type |
-| `cdeq_X_rawvalue` | `i_valraw` | The raw value type |
+| `cdeq_X_raw` | `i_valraw` | The raw value type |
| `cdeq_X_iter` | `struct { cdeq_X_value* ref; }` | The iterator type |
## Examples
diff --git a/docs/clist_api.md b/docs/clist_api.md
index 41fbd274..fc54f40e 100644
--- a/docs/clist_api.md
+++ b/docs/clist_api.md
@@ -81,7 +81,7 @@ clist_X_iter clist_X_end(const clist_X* self);
void clist_X_next(clist_X_iter* it);
clist_X_iter clist_X_advance(clist_X_iter it, size_t n); // return n elements ahead.
-clist_X_rawvalue clist_X_value_toraw(clist_X_value* pval);
+clist_X_raw clist_X_value_toraw(clist_X_value* pval);
clist_X_value clist_X_value_clone(clist_X_value val);
```
@@ -91,7 +91,7 @@ clist_X_value clist_X_value_clone(clist_X_value val);
|:--------------------|:------------------------------------|:--------------------------|
| `clist_X` | `struct { clist_X_node* last; }` | The clist type |
| `clist_X_value` | `i_val` | The clist element type |
-| `clist_X_rawvalue` | `i_valraw` | clist raw value type |
+| `clist_X_raw` | `i_valraw` | clist raw value type |
| `clist_X_iter` | `struct { clist_value *ref; ... }` | clist iterator |
## Example
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index b7a08e3e..38346e53 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -76,7 +76,7 @@ cmap_X_iter cmap_X_end(const cmap_X* self);
void cmap_X_next(cmap_X_iter* it);
cmap_X_value cmap_X_value_clone(cmap_X_value val);
-cmap_X_rawvalue cmap_X_value_toraw(cmap_X_value* pval);
+cmap_X_raw cmap_X_value_toraw(cmap_X_value* pval);
```
Helpers:
```c
@@ -101,7 +101,7 @@ bool c_rawstr_eq(const char* const* a, const char* const* b); //
| `cmap_X` | `struct { ... }` | The cmap type |
| `cmap_X_rawkey` | `i_keyraw` | The raw key type |
| `cmap_X_rawmapped` | `i_valraw` | The raw mapped type |
-| `cmap_X_rawvalue` | `struct { i_keyraw first; i_valraw second; }` | i_keyraw + i_valraw type |
+| `cmap_X_raw` | `struct { i_keyraw first; i_valraw second; }` | i_keyraw + i_valraw type |
| `cmap_X_key` | `i_key` | The key type |
| `cmap_X_mapped` | `i_val` | The mapped type |
| `cmap_X_value` | `struct { const i_key first; i_val second; }` | The value: key is immutable |
@@ -122,7 +122,7 @@ int main()
// Create an unordered_map of three strings (that map to strings)
c_auto (cmap_str, u)
{
- c_apply(v, cmap_str_emplace(&u, c_pair(v)), cmap_str_rawvalue, {
+ c_apply(v, cmap_str_emplace(&u, c_pair(v)), cmap_str_raw, {
{"RED", "#FF0000"},
{"GREEN", "#00FF00"},
{"BLUE", "#0000FF"}
@@ -168,7 +168,7 @@ int main()
c_auto (cmap_id, idnames)
{
- c_apply(v, cmap_id_emplace(&idnames, c_pair(v)), cmap_id_rawvalue, {
+ c_apply(v, cmap_id_emplace(&idnames, c_pair(v)), cmap_id_raw, {
{100, "Red"}, {110, "Blue"}
});
// replace existing mapped value:
@@ -384,7 +384,7 @@ static inline RViking Viking_toraw(const Viking* vk) {
int main()
{
c_auto (Vikings, vikings) {
- c_apply(v, Vikings_emplace(&vikings, v), c_pair(v), Vikings_rawvalue, {
+ c_apply(v, Vikings_emplace(&vikings, v), c_pair(v), Vikings_raw, {
{{"Einar", "Norway"}, 20},
{{"Olaf", "Denmark"}, 24},
{{"Harald", "Iceland"}, 12},
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md
index 9fd2c4e0..0ecae014 100644
--- a/docs/cqueue_api.md
+++ b/docs/cqueue_api.md
@@ -52,7 +52,7 @@ i_val cqueue_X_value_clone(i_val value);
|:--------------------|:---------------------|:-------------------------|
| `cqueue_X` | `cdeq_X` | The cqueue type |
| `cqueue_X_value` | `i_val` | The cqueue element type |
-| `cqueue_X_rawvalue` | `i_valraw` | cqueue raw value type |
+| `cqueue_X_raw` | `i_valraw` | cqueue raw value type |
| `cqueue_X_iter` | `cdeq_X_iter` | cqueue iterator |
## Examples
diff --git a/docs/cset_api.md b/docs/cset_api.md
index 479cf3f3..18454dcf 100644
--- a/docs/cset_api.md
+++ b/docs/cset_api.md
@@ -65,7 +65,7 @@ cset_X_value cset_X_value_clone(cset_X_value val);
|:-------------------|:-------------------------------------------------|:----------------------------|
| `cset_X` | `struct { ... }` | The cset type |
| `cset_X_rawkey` | `i_keyraw` | The raw key type |
-| `cset_X_rawvalue` | `i_keyraw` | The raw value type |
+| `cset_X_raw` | `i_keyraw` | The raw value type |
| `cset_X_key` | `i_key` | The key type |
| `cset_X_value` | `i_key` | The value |
| `cset_X_result` | `struct { cset_X_value* ref; bool inserted; }` | Result of insert/emplace |
diff --git a/docs/csmap_api.md b/docs/csmap_api.md
index 3791347b..c3f71a7c 100644
--- a/docs/csmap_api.md
+++ b/docs/csmap_api.md
@@ -73,7 +73,7 @@ void csmap_X_next(csmap_X_iter* iter);
csmap_X_iter csmap_X_advance(csmap_X_iter it, size_t n);
csmap_X_value csmap_X_value_clone(csmap_X_value val);
-csmap_X_rawvalue csmap_X_value_toraw(csmap_X_value* pval);
+csmap_X_raw csmap_X_value_toraw(csmap_X_value* pval);
```
## Types
@@ -82,7 +82,7 @@ csmap_X_rawvalue csmap_X_value_toraw(csmap_X_value* pval);
| `csmap_X` | `struct { ... }` | The csmap type |
| `csmap_X_rawkey` | `i_keyraw` | The raw key type |
| `csmap_X_rawmapped` | `i_valraw` | The raw mapped type |
-| `csmap_X_rawvalue` | `struct { i_keyraw first; i_valraw second; }` | i_keyraw+i_valraw type |
+| `csmap_X_raw` | `struct { i_keyraw first; i_valraw second; }` | i_keyraw+i_valraw type |
| `csmap_X_key` | `i_key` | The key type |
| `csmap_X_mapped` | `i_val` | The mapped type |
| `csmap_X_value` | `struct { const i_key first; i_val second; }` | The value: key is immutable |
@@ -100,7 +100,7 @@ int main()
// Create a sorted map of three strings (maps to string)
c_auto (csmap_str, colors) // RAII
{
- c_apply(v, csmap_str_emplace(&colors, c_pair(v)), csmap_str_rawvalue, {
+ c_apply(v, csmap_str_emplace(&colors, c_pair(v)), csmap_str_raw, {
{"RED", "#FF0000"},
{"GREEN", "#00FF00"},
{"BLUE", "#0000FF"}
@@ -146,7 +146,7 @@ int main()
csmap_id idnames = csmap_id_init();
c_autodefer (csmap_id_drop(&idnames))
{
- c_apply(v, csmap_id_emplace(&idnames, c_pair(v)), csmap_id_rawvalue, {
+ c_apply(v, csmap_id_emplace(&idnames, c_pair(v)), csmap_id_raw, {
{100, "Red"},
{110, "Blue"},
});
diff --git a/docs/csptr_api.md b/docs/csptr_api.md
index 6a48f91a..95575417 100644
--- a/docs/csptr_api.md
+++ b/docs/csptr_api.md
@@ -101,17 +101,17 @@ int main()
// POPULATE the stack with shared pointers to Map:
Map *map;
map = Stack_push(&stack, Arc_new(Map_init()))->get;
- c_apply(v, Map_emplace(map, c_pair(v)), Map_rawvalue, {
+ c_apply(v, Map_emplace(map, c_pair(v)), Map_raw, {
{"Joey", 1990}, {"Mary", 1995}, {"Joanna", 1992}
});
map = Stack_push(&stack, Arc_new(Map_init()))->get;
- c_apply(v, Map_emplace(map, c_pair(v)), Map_rawvalue, {
+ c_apply(v, Map_emplace(map, c_pair(v)), Map_raw, {
{"Rosanna", 2001}, {"Brad", 1999}, {"Jack", 1980}
});
// POPULATE the list:
map = List_push_back(&list, Arc_new(Map_init()))->get;
- c_apply(v, Map_emplace(map, c_pair(v)), Map_rawvalue, {
+ c_apply(v, Map_emplace(map, c_pair(v)), Map_raw, {
{"Steve", 1979}, {"Rick", 1974}, {"Tracy", 2003}
});
diff --git a/docs/csset_api.md b/docs/csset_api.md
index 62ccb638..01926453 100644
--- a/docs/csset_api.md
+++ b/docs/csset_api.md
@@ -60,7 +60,7 @@ csset_X_value csset_X_value_clone(csset_X_value val);
|:-------------------|:--------------------------------------------------|:----------------------------|
| `csset_X` | `struct { ... }` | The csset type |
| `csset_X_rawkey` | `i_keyraw` | The raw key type |
-| `csset_X_rawvalue` | `i_keyraw` | The raw key type |
+| `csset_X_raw` | `i_keyraw` | The raw key type |
| `csset_X_key` | `i_key` | The key type |
| `csset_X_value` | `i_key ` | The value: key is immutable |
| `csset_X_result` | `struct { csset_X_value* ref; bool inserted; }` | Result of insert/emplace |
diff --git a/docs/cstack_api.md b/docs/cstack_api.md
index b6992dc0..672b3168 100644
--- a/docs/cstack_api.md
+++ b/docs/cstack_api.md
@@ -55,11 +55,11 @@ i_val cstack_X_value_clone(i_val value);
## Types
-| Type name | Type definition | Used to represent... |
-|:--------------------|:---------------------------------------|:----------------------------|
+| Type name | Type definition | Used to represent... |
+|:--------------------|:-------------------------------------|:----------------------------|
| `cstack_X` | `struct { cstack_value *data; ... }` | The cstack type |
-| `cstack_X_value` | `i_val` | The cstack element type |
-| `cstack_X_rawvalue` | `i_valraw` | cstack raw value type |
+| `cstack_X_value` | `i_val` | The cstack element type |
+| `cstack_X_raw` | `i_valraw` | cstack raw value type |
| `cstack_X_iter` | `struct { cstack_value *ref; }` | cstack iterator |
## Example
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index 2a4ceaf6..ef145b94 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -86,7 +86,7 @@ cvec_X_iter cvec_X_begin(const cvec_X* self);
cvec_X_iter cvec_X_end(const cvec_X* self);
void cvec_X_next(cvec_X_iter* iter);
-cvec_X_rawvalue cvec_X_value_toraw(cvec_X_value* pval);
+cvec_X_raw cvec_X_value_toraw(cvec_X_value* pval);
cvec_X_value cvec_X_value_clone(cvec_X_value val);
```
@@ -96,7 +96,7 @@ cvec_X_value cvec_X_value_clone(cvec_X_value val);
|:-------------------|:----------------------------------|:-----------------------|
| `cvec_X` | `struct { cvec_X_value* data; }` | The cvec type |
| `cvec_X_value` | `i_val` | The cvec value type |
-| `cvec_X_rawvalue` | `i_valraw` | The raw value type |
+| `cvec_X_raw` | `i_valraw` | The raw value type |
| `cvec_X_iter` | `struct { cvec_X_value* ref; }` | The iterator type |
## Examples