patternsopaque-pointer
Opaque Pointer Pattern pattern for C development
When & Why to Use This Skill
This Claude skill provides expert guidance and implementation templates for the Opaque Pointer Pattern in C development. It enables developers to achieve strict encapsulation by hiding data structure internals, facilitating the creation of stable, maintainable, and binary-compatible APIs while reducing compilation dependencies.
Use Cases
- Designing Stable Public APIs: Implement the Opaque Pointer pattern to ensure that internal structural changes do not break the binary interface or require recompilation of client applications.
- Enforcing Data Encapsulation: Prevent external modules from directly accessing or modifying private struct members, ensuring data integrity by forcing the use of designated accessor functions.
- Optimizing Build Times: Reduce header file complexity and minimize 'header pollution' by moving internal definitions to implementation files, significantly decreasing recompilation overhead in large-scale C projects.
| name | patterns/opaque-pointer |
|---|---|
| description | Opaque Pointer Pattern pattern for C development |
Opaque Pointer Pattern
Declare struct in header without defining fields. Implementation hidden in .c file. Callers only see pointer, never fields.
ikigai Application
Header:
typedef struct ik_scrollback ik_scrollback_t; // Forward declaration
res_t ik_scrollback_create(void *ctx, ik_scrollback_t **out);
Implementation in .c:
struct ik_scrollback {
// Fields hidden from callers
};
Benefits:
- Callers can't depend on internal fields
- Change internals without recompiling callers
- Enforces use of accessor functions
ikigai usage: Most context types could use this. Currently structs are defined in headers. Consider for stable public APIs.