<h2><a class="toc-backref" id="cdotddotedotcdotldotcolon-commonly-desired-edge-case-library" href="#cdotddotedotcdotldotcolon-commonly-desired-edge-case-library">C.D.E.C.L.: Commonly Desired Edge Case Library</a></h2>See full docs at <a class="reference external" href="https://elcritch.github.io/cdecl/">docs</a> or source on github at <a class="reference external" href="https://github.com/elcritch/cdecl">elcritch/cdecl</a>. Small library for macros to handle various edge cases for Nim syntax. These are mostly edge case syntax handlers or tricky C Macro interfacings. The goal is to implement them as generically and well unit tested as possible. Current macros includes: <ul class="simple"><li><a class="reference external" href="https://elcritch.github.io/cdecl/cdecl/cdecls.html">cdecls</a>: Macros to help using C macros that declare variables<ul class="simple"><li><tt class="docutils literal">cdeclmacro</tt></li> </ul> </li> <li><a class="reference external" href="https://elcritch.github.io/cdecl/cdecl/applies.html">applies</a>: Macros that unpack arguments from various forms and calls functions<ul class="simple"><li><tt class="docutils literal">unpackObjectArgs</tt>: macro to splat an object to position arguments</li> <li><tt class="docutils literal">unpackObjectArgFields</tt>: macro to splat an object to keyword arguments</li> <li><tt class="docutils literal">unpackLabelsAsArgs</tt>: turn labels to named arguments</li> </ul> </li> <li><a class="reference external" href="https://elcritch.github.io/cdecl/cdecl/bitfields.html">bitfields</a>: Macros for making bitfield style accessor<ul class="simple"><li><tt class="docutils literal">bitfields</tt>: create bitfield accessors for hardware registers using any int type</li> </ul> </li> </ul> You can see various usages in the <a class="reference external" href="https://github.com/elcritch/cdecl/tree/main/tests">tests </a> folder. <h2><a class="toc-backref" id="macros" href="#macros">Macros</a></h2> <h3><a class="toc-backref" id="macros-nimunpackobjectargs" href="#macros-nimunpackobjectargs"><tt class="docutils literal">unpackObjectArgs</tt></a></h3>Helper to apply all fields of an object as named paramters. <pre class="listing">type AddObj = object a*: int b*: int

proc add(a, b: int): int = result = a + b

let args = AddObj(a: 1, b: 2) let res = unpackObjectArgs(add, args) assert res == 3 </pre>

<h3><a class="toc-backref" id="macros-nimunpacklabelsasargs" href="#macros-nimunpacklabelsasargs"><tt class="docutils literal">unpackLabelsAsArgs</tt></a></h3>Helper to transform <tt class="docutils literal">labels</tt> as named arguments to a function. Labels are regular Nim syntax for calling procs but are transformed to parameter names: <pre class="listing">proc foo(name: string = "buzz", a, b: int) = echo name, ":", " a: ", $a, " b: ", $b

template Foo(blk: varargs[untyped]) = ## create a new template to act YAML like API unpackLabelsAsArgs(foo, blk)

Foo: name: "buzz" a: 11 b: 22

</pre>

Will call <tt class="docutils literal">foo(name="buzz",a=11,b=22)</tt> and print: <pre class="listing"> buzz: a: 11 b: 22 </pre> <h3><a class="toc-backref" id="macros-nimcdeclmacro" href="#macros-nimcdeclmacro"><tt class="docutils literal">cdeclmacro</tt></a></h3>Macro helper for wrapping a C macro that declares a new C variable. It handles emitting the appropriate C code for calling the macro. Additionally it defines a new Nim variable using importc which imports the declared variable. <h4><a class="toc-backref" id="nimcdeclmacro-basic-example" href="#nimcdeclmacro-basic-example">Basic Example</a></h4><pre class="listing">import cdecl/cdecls import cdecl/cdeclapi export cdeclapi # this is needed clients to use the declared apis

proc CDefineVar*(name: CToken, size: static[int]) {. cdeclmacro: "C_MACRO_VARIABLE_DECLARER", cdeclsVar(name -> array[size, int32])<span class="O

Cdecl

Install / Use

README