diff options
| author | Tyge Løvset <[email protected]> | 2021-11-21 23:17:24 +0100 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2021-11-21 23:17:24 +0100 |
| commit | ee09c3627dee4eb2ec87fda9783be1bb15e132d9 (patch) | |
| tree | ecc646a430e75f618e00c2a95ce2372e1021ba5d /docs | |
| parent | 879f7a1c5637a5f67d430d3583fc7ba34b687234 (diff) | |
| download | STC-modified-ee09c3627dee4eb2ec87fda9783be1bb15e132d9.tar.gz STC-modified-ee09c3627dee4eb2ec87fda9783be1bb15e132d9.zip | |
BREAKING CHANGE: Replaced c_new(T) with c_new(T, ...). This now is similar to the c++ new operator. The previous c_new(T) is renamed to c_alloc(T), and c_new_n(T,n) => c_alloc_n(T,n). Old usage of c_new() will fail as it requires additional argument. Sorry for the inconvenience.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ccommon_api.md | 13 | ||||
| -rw-r--r-- | docs/cdeq_api.md | 2 | ||||
| -rw-r--r-- | docs/cvec_api.md | 4 |
3 files changed, 12 insertions, 7 deletions
diff --git a/docs/ccommon_api.md b/docs/ccommon_api.md index 9a309835..db89120e 100644 --- a/docs/ccommon_api.md +++ b/docs/ccommon_api.md @@ -133,17 +133,22 @@ int arr[] = {1, 2, 3}; c_apply_n(cvec_i, push_back, &vec, arr, c_arraylen(arr)); ``` -### c_new, c_new_n, c_del, c_make +### c_new, c_alloc, c_alloc_n, c_del, c_make | Usage | Meaning | |:-------------------------------|:----------------------------------------| -| `c_new (type)` | `(type *) c_malloc(sizeof(type))` | -| `c_new_n (type, N)` | `(type *) c_malloc((N)*sizeof(type))` | +| `c_new (type, value)` | Move value to a new object on the heap | +| `c_alloc (type)` | `(type *) c_malloc(sizeof(type))` | +| `c_alloc_n (type, N)` | `(type *) c_malloc((N)*sizeof(type))` | | `c_del (ctype, &c1, ..., &cN)` | `ctype_del(&c1); ... ctype_del(&cN)` | | `c_make(type){value...}` | `(type){value...}` // c++ compatability | ```c -int* array = c_new_n (int, 100); +struct Pnt { double x, y, z; }; +struct Pnt *pnt = c_new (struct Pnt, {1.2, 3.4, 5.6}); +c_free(pnt); + +int* array = c_alloc_n (int, 100); c_free(array); cstr a = cstr_from("Hello"), b = cstr_from("World"); diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md index 22487682..554b4c7b 100644 --- a/docs/cdeq_api.md +++ b/docs/cdeq_api.md @@ -28,7 +28,7 @@ cdeq_X cdeq_X_clone(cdeq_X deq); void cdeq_X_clear(cdeq_X* self); void cdeq_X_copy(cdeq_X* self, cdeq_X other); -void cdeq_X_reserve(cdeq_X* self, size_t cap); +bool cdeq_X_reserve(cdeq_X* self, size_t cap); void cdeq_X_shrink_to_fit(cdeq_X* self); void cdeq_X_swap(cdeq_X* a, cdeq_X* b); void cdeq_X_del(cdeq_X* self); // destructor diff --git a/docs/cvec_api.md b/docs/cvec_api.md index 64ca724f..b3bc0f1b 100644 --- a/docs/cvec_api.md +++ b/docs/cvec_api.md @@ -35,8 +35,8 @@ cvec_X cvec_X_clone(cvec_X vec); void cvec_X_clear(cvec_X* self); void cvec_X_copy(cvec_X* self, cvec_X other); -void cvec_X_reserve(cvec_X* self, size_t cap); -void cvec_X_resize(cvec_X* self, size_t size, i_val fill); +bool cvec_X_reserve(cvec_X* self, size_t cap); +bool cvec_X_resize(cvec_X* self, size_t size, i_val fill); void cvec_X_shrink_to_fit(cvec_X* self); void cvec_X_swap(cvec_X* a, cvec_X* b); void cvec_X_del(cvec_X* self); // destructor |