summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2022-11-03 12:44:44 +0100
committerTyge Løvset <[email protected]>2022-11-03 12:44:44 +0100
commita913e030b5db2e0d0a49234a86fa39930b4ed6e9 (patch)
tree3cf10eb3bdc2bc0f958d32b3dcf44888d16ea75b /README.md
parent0a9ab178aad191dc3a394e5fa8aca860da9ee9b0 (diff)
downloadSTC-modified-a913e030b5db2e0d0a49234a86fa39930b4ed6e9.tar.gz
STC-modified-a913e030b5db2e0d0a49234a86fa39930b4ed6e9.zip
Renamed forward_CONTAINER(...) => declare_CONTAINER(...),
and c_is_fwd => c_declared, for the i_opt option define.
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 4548ea55..f4fd275d 100644
--- a/README.md
+++ b/README.md
@@ -310,7 +310,7 @@ The list of template parameters:
Properties:
- `i_tag` - Container type name tag. Defaults to *i_key* name.
- `i_type` - Full container type name. Alternative to *i_tag*.
-- `i_opt` - Boolean properties: may combine *c_no_cmp*, *c_no_clone*, *c_no_atomic*, *c_is_fwd*, *c_static*, *c_header* with the *|* separator.
+- `i_opt` - Boolean properties: may combine *c_no_cmp*, *c_no_clone*, *c_no_atomic*, *c_declared*, *c_static*, *c_header* with the *|* separator.
Key:
- `i_keydrop` - Destroy map/set key func - defaults to empty destructor.
@@ -425,7 +425,7 @@ but still not expose or include the full implementation / API of the container.
```c
// Header file
#include <stc/forward.h> // only include data structures
-forward_cstack(cstack_pnt, struct Point); // declare cstack_pnt and cstack_pnt_value, cstack_pnt_iter;
+declare_cstack(cstack_pnt, struct Point); // declare cstack_pnt and cstack_pnt_value, cstack_pnt_iter;
// the element may be forward declared type as well
typedef struct Dataset {
cstack_pnt vertices;
@@ -434,7 +434,7 @@ typedef struct Dataset {
...
// Implementation
-#define c_opt c_is_fwd // flag that the container was forward declared.
+#define c_opt c_declared // flag that the container was forward declared.
#define i_val struct Point
#define i_tag pnt
#include <stc/cstack.h>
@@ -527,7 +527,7 @@ Memory efficiency
- Replaced: *csview_first_token()* and *csview_next_token()* with one function: `csview_token()`.
- Added: **checkauto** tool for checking that c-source files uses `c_auto*` macros correctly.
- Added: general `i_keyclass` / `i_valclass` template parameters which auto-binds template functions.
-- Added: `i_opt` template parameter: compile-time options: `c_no_cmp`, `c_no_clone`, `c_no_atomic`, `c_is_fwd`; may be combined with `|`
+- Added: `i_opt` template parameter: compile-time options: `c_no_cmp`, `c_no_clone`, `c_no_atomic`, `c_declared`; may be combined with `|`
- Added: [**cbox**](docs/cbox_api.md) type: smart pointer, similar to [Rust Box](https://doc.rust-lang.org/rust-by-example/std/box.html) and [std::unique_ptr](https://en.cppreference.com/w/cpp/memory/unique_ptr).
- Added: [**c_forpair**](docs/ccommon_api.md) macro: for-loop with "structured binding"