quickref

Signed-off-by: Davide Bettio <davide@uninstall.it>

Author: bettio

C_CODING_STYLE.md

@@ -2235,7 +2235,7 @@ This convention system creates self-documenting code where the naming pattern im
 | Function Pattern | Allocation | Cleanup Required | Usage |
 |------------------|------------|------------------|--------|
 | `_init` | Stack-friendly | No | `date_time_init(&obj, 2025, 4, 25)` |
-| `_create` / `_destroy` | Stack-friendly | Yes | `buffer_create(&obj, 1024)`, `buffer_destroy(&obj)` |
+| `_create` / `_destroy` | Stack with resources | Yes | `buffer_create(&obj, 1024)`, `buffer_destroy(&obj)` |
 | `_new` / `_delete` | Heap-allocated | Yes | `user_new("Alice")`, `user_delete(obj)` |
 
 ### Pointer Type Usage
@@ -2262,19 +2262,20 @@ This convention system creates self-documenting code where the naming pattern im
 | Early exit | Reduce nesting | Guard clause with braces |
 | Switch | Testing one variable for 3+ values | More efficient and clear |
 | Empty lines in switch | Cases > 3 lines | Improves readability |
-| Increment operators | Avoid return value usage | `i++; b = i;` not `b = ++i` |
+| Increment operators | Post-increment preferred | `i++` (stylistic choice) |
 | Goto for cleanup | Resource management | Single cleanup path |
 
 ### API Design Patterns
 
 | Pattern | Description | Example |
 |---------|-------------|---------|
-| Parameter order | `target, inputs, outputs, options, environment` | `parse_csv(data, len, &table, opts, env)` |
+| Parameter order | target, inputs, outputs, options, environment | `parse_csv(data, len, &table, opts, env)` |
 | Array + length | Arrays always followed by length | `process(arr, arr_len)` |
 | Error handling | Return status, output via parameters | `if (parse_int(str, &val) != ParseIntOk)` |
 | Enums over bools | Self-documenting options | `UserMessageBlinking` not `true` |
 | Array syntax | `[]` for multiple items, `*` for single | `void sort(int arr[], size_t len)` |
 | Global state | Use context struct, not globals | `process(Request *req, GlobalContext *ctx)` |
+| Struct parameters | Always pass by pointer | `void update(User *user)` |
 
 ### Type Selection
 
@@ -2284,7 +2285,8 @@ This convention system creates self-documenting code where the naming pattern im
 | Pointer as integer | `uintptr_t` | `uintptr_t addr = (uintptr_t)ptr` |
 | Pointer difference | `ptrdiff_t` | `ptrdiff_t off = p2 - p1` |
 | Fixed sizes | `uint32_t`, `int64_t` | `uint32_t crc32` |
-| Binary data | `uint8_t *` | `hash_compute(uint8_t *hash)` |
+| Binary data | `uint8_t *` | `hash_compute(uint8_t data[])` |
+| Generic types | typedef | `typedef void (*callback_t)(int)` |
 
 ### Macro Safety
 
@@ -2293,6 +2295,7 @@ This convention system creates self-documenting code where the naming pattern im
 | Parenthesize parameters | `#define SQUARE(x) ((x) * (x))` |
 | Parenthesize entire expression | `#define MAX(a, b) ((a) > (b) ? (a) : (b))` |
 | Multi-statement pattern | `#define SWAP(a, b) do { ... } while (0)` |
+| Avoid side effects | Don't use with `++` or function calls |
 
 ### Memory Guidelines
 
@@ -2303,6 +2306,8 @@ This convention system creates self-documenting code where the naming pattern im
 | Allocation checks | Always check malloc | Handle or abort |
 | Cleanup | Use goto pattern | Initialize pointers to NULL |
 | `free(NULL)` | Safe, no check needed | Simplifies cleanup |
+| Struct alignment | Largest to smallest | Minimize padding |
+| Bit fields | Unsigned only | Explicit padding |
 
 ### Static Assertions
 
@@ -2312,13 +2317,53 @@ This convention system creates self-documenting code where the naming pattern im
 | Layout assumptions | `_Static_assert(offsetof(T, field) == 8, "Layout changed")` |
 | Config validation | `_Static_assert(MAX >= MIN, "Invalid config")` |
 | Platform assumptions | `_Static_assert(sizeof(int) == 4, "Needs 32-bit int")` |
+| Enum bounds | `_Static_assert(StateMax <= 255, "Exceeds uint8_t")` |
 
 ### Header Naming Convention
 
 | Module Name | Header File | Not |
 |-------------|-------------|-----|
 | `date_time` | `date_time.h` | `datetime.h`, `DateTime.h` |
 | `csv_parser` | `csv_parser.h` | `csvparser.h`, `CSVParser.h` |
+| `buffer_pool` | `buffer_pool.h` | `BufferPool.h`, `buffer-pool.h` |
+
+### Common Unit Suffixes
+
+| Category | Suffixes | Examples |
+|----------|----------|----------|
+| Time | `_ms`, `_us`, `_ns`, `_sec`, `_min` | `delay_ms(100)`, `timeout_sec` |
+| Distance | `_mm`, `_cm`, `_m`, `_km` | `distance_km`, `gap_mm` |
+| Angles | `_deg`, `_rad` | `rotate_deg(90)`, `angle_rad` |
+| Data | `_bytes`, `_kib`, `_mib`, `_gib` | `buffer_size_bytes`, `cache_mib` |
+| Frequency | `_hz`, `_khz`, `_mhz` | `sample_rate_khz`, `clock_mhz` |
+| Speed | `_rpm`, `_kmh`, `_mps` | `motor_rpm`, `velocity_mps` |
+
+### Typedef and Forward Declarations
+
+| Pattern | Usage | Example |
+|---------|-------|---------|
+| Public API types | Use typedef in headers | `typedef struct { ... } DateTime;` |
+| Internal types | Use explicit struct keyword | `struct ParserState state;` |
+| Function pointers | Always use typedef | `typedef void (*handler_t)(Event *);` |
+| Opaque types | Forward declare in headers | `typedef struct Buffer Buffer;` |
+| Circular dependencies | Use forward declarations | `typedef struct Node Node;` |
+
+### External Data Handling
+
+| Issue | Solution | Example |
+|-------|----------|---------|
+| Byte order | Convert to host order | `value = ntohl(network_value)` |
+| Alignment | Use memcpy for safety | `memcpy(&val, &buffer[off], 4)` |
+| Packed structs | Compiler-specific attributes | `__attribute__((packed))` |
+
+### Comment Tags
+
+| Tag | Usage | Example |
+|-----|-------|---------|
+| TODO | Planned improvements | `// TODO: Add IPv6 support` |
+| FIXME | Known bugs | `// FIXME: Buffer overflow risk` |
+| HACK | Temporary workarounds | `// HACK: Sleep to avoid race` |
+| WORKAROUND | Permanent fixes for external issues | `// WORKAROUND: Library bug #123` |
 
 ### Documentation Guidelines