diff options
| author | Tyge Løvset <[email protected]> | 2021-05-21 16:02:25 +0200 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2021-05-21 16:02:25 +0200 |
| commit | 77e61266489a2e69693f714b601f3824d16ae1ba (patch) | |
| tree | 21718c5bf4a9baa80558b3577daf026304c176b0 /docs | |
| parent | 345bff3cc9a36135a00bb963b3fada09d054980d (diff) | |
| download | STC-modified-77e61266489a2e69693f714b601f3824d16ae1ba.tar.gz STC-modified-77e61266489a2e69693f714b601f3824d16ae1ba.zip | |
API change: c_breakwith => c_exitwith, c_breakdefer => c_exitdefer. Added csmap_insert.c example.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ccommon_api.md | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/ccommon_api.md b/docs/ccommon_api.md index 3a2ee521..7e329cfe 100644 --- a/docs/ccommon_api.md +++ b/docs/ccommon_api.md @@ -2,12 +2,13 @@ The following handy macros are safe to use, i.e. have no side-effects. -### c_defer, c_with, c_withvar, c_withbuf, c_breakwith -General *defer* mechanics. These macros allows to specify destructors explicitly or implicitly where the -constructors are defined. This ensures that resources are released after usage, and avoids memory leaks. -**c_with / c_withvar** are inspired by Python's *with* statement. +### c_defer, c_with, c_withvar, c_withbuf, c_exitwith/c_exitdefer +General ***defer*** mechanics. These macros allows to specify a resource release explicitly or implicitly where the +resource acquisition is made. This ensures that resources are released after usage, and avoids memory leaks. +**c_with / c_withvar** are inspired by Python's *with* statement, and **c_defer** from Go language. -**NB**: ***Only*** use `c_breakwith` or `c_breakdefer` to break out of `c_with`/`c_defer`-blocks. ***Never*** use `return`, `break`, or `goto` inside such a block. +**NB**: ***Only*** use `c_exitwith`/`c_exitdefer` to break out of `c_with*`/`c_defer`-blocks. +***Never*** use `return`, `goto` or `break` inside such a block. | Usage | Description | |:---------------------------------|:--------------------------------------------------| @@ -19,7 +20,7 @@ constructors are defined. This ensures that resources are released after usage, The `acquire`argument must be of the form: `type var = getResource`. **c_with** and **c_defer** are general macros, whereas **c_withvar** requires that there are methods *type_init()* to create and return an object of type, and *type_del()* -that destructs the object. These are available for all STC containers. +which destructs the object. These are available for all STC containers. ```c // Example: Load each line of a text file into a vector of strings |