summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2022-08-15 16:54:56 +0200
committerTyge Løvset <[email protected]>2022-08-15 16:54:56 +0200
commitbf3c50da1a346b56b6846c0f7b9e7a222f602c2f (patch)
tree3284252adec60cce3bd4d7c5876fe2d8a3d9506e /docs
parente9e405dbe1ec3eb51ce2e3398b3c24583293892e (diff)
downloadSTC-modified-bf3c50da1a346b56b6846c0f7b9e7a222f602c2f.tar.gz
STC-modified-bf3c50da1a346b56b6846c0f7b9e7a222f602c2f.zip
More iterator fixes. Make sure cvec/cdeq find_in() return end() iterator if item not found. Small cstr API change to u8_replace*.
Diffstat (limited to 'docs')
-rw-r--r--docs/cdeq_api.md2
-rw-r--r--docs/cstr_api.md2
-rw-r--r--docs/csview_api.md2
-rw-r--r--docs/cvec_api.md4
4 files changed, 5 insertions, 5 deletions
diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md
index 79e6bf39..6a47313d 100644
--- a/docs/cdeq_api.md
+++ b/docs/cdeq_api.md
@@ -43,7 +43,7 @@ const cdeq_X_value* cdeq_X_at(const cdeq_X* self, size_t idx);
const cdeq_X_value* cdeq_X_get(const cdeq_X* self, i_valraw raw); // return NULL if not found
cdeq_X_value* cdeq_X_get_mut(cdeq_X* self, i_valraw raw); // mutable get
cdeq_X_iter cdeq_X_find(const cdeq_X* self, i_valraw raw);
-cdeq_X_iter cdeq_X_find_in(cdeq_X_iter i1, cdeq_X_iter i2, i_valraw raw);
+cdeq_X_iter cdeq_X_find_in(cdeq_X_iter i1, cdeq_X_iter i2, i_valraw raw); // return cvec_X_end() if not found
cdeq_X_value* cdeq_X_front(const cdeq_X* self);
cdeq_X_value* cdeq_X_back(const cdeq_X* self);
diff --git a/docs/cstr_api.md b/docs/cstr_api.md
index f5414f1b..d4e292cd 100644
--- a/docs/cstr_api.md
+++ b/docs/cstr_api.md
@@ -99,7 +99,7 @@ size_t cstr_u8_size_n(const cstr self, size_t nbytes); // utf8 si
size_t cstr_u8_to_pos(const cstr* self, size_t u8idx); // byte pos offset at utf8 codepoint index
const char* cstr_u8_at(const cstr* self, size_t u8idx); // char* position at utf8 codepoint index
csview cstr_u8_chr(const cstr* self, size_t u8idx); // get utf8 character as a csview
-void cstr_u8_replace_at(cstr* self, size_t u8pos, size_t u8len, csview repl); // replace at utf8 indices
+void cstr_u8_replace(cstr* self, size_t pos, size_t u8len, csview repl); // replace u8len utf8 chars
// iterate utf8 codepoints
cstr_iter cstr_begin(const cstr* self);
diff --git a/docs/csview_api.md b/docs/csview_api.md
index d6bb4baf..128a1c9d 100644
--- a/docs/csview_api.md
+++ b/docs/csview_api.md
@@ -146,7 +146,7 @@ int main()
{
c_auto (cstr, s1) {
s1 = cstr_new("hell😀 w😀rld");
- cstr_u8_replace_at(&s1, 7, 1, c_sv("ø"));
+ cstr_u8_replace(&s1, cstr_find(&s1, "😀rld"), 1, c_sv("ø"));
printf("%s\n", cstr_str(&s1));
c_foreach (i, cstr, s1)
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index a1d27a23..579f6eeb 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -49,9 +49,9 @@ size_t cvec_X_capacity(const cvec_X* self);
const cvec_X_value* cvec_X_at(const cvec_X* self, size_t idx);
const cvec_X_value* cvec_X_get(const cvec_X* self, i_valraw raw); // return NULL if not found
cvec_X_value* cvec_X_at_mut(cvec_X* self, size_t idx);
-cvec_X_value* cvec_X_get_mut(cvec_X* self, i_valraw raw); // get mutable value
+cvec_X_value* cvec_X_get_mut(cvec_X* self, i_valraw raw); // find mutable value, return value ptr
cvec_X_iter cvec_X_find(const cvec_X* self, i_valraw raw);
-cvec_X_iter cvec_X_find_in(cvec_X_iter i1, cvec_X_iter i2, i_valraw raw);
+cvec_X_iter cvec_X_find_in(cvec_X_iter i1, cvec_X_iter i2, i_valraw raw); // return cvec_X_end() if not found
// On sorted vectors:
cvec_X_iter cvec_X_binary_search(const cvec_X* self, i_valraw raw); // at elem == raw, else end
cvec_X_iter cvec_X_lower_bound(const cvec_X* self, i_valraw raw); // at first elem >= raw, else end