welder 0.1.0
Bindings for annotated C++ types, from C++26 reflection
Loading...
Searching...
No Matches
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
 Nluabridge
 CStack< E, std::enable_if_t< std::is_enum_v< E > > >
 Nwelder
 Ncarriages
 Cmarker_resolutionStitch-welding resolution: bind only where welder's markers say to
 Cgreedy_resolutionTack-welding resolution: bind an unmarked library greedily
 Cbasic_carriageA carriage: welder's reflection-driven traversal, parameterized on a Resolution (which markers it obeys)
 NdetailThe stored forms of the annotation vocabulary
 Caccessor_specThe stored form of a getter / setter mark: which property half the function supplies, for which languages, under which (optional) explicit name
 Cany_typeA placeholder class type for shape-probing a member template inside a concept
 Ccontainer_specOne row of the reference-container table: a container template paired with the opaque binder kind it uses
 Cdoc_specThe stored form of a doc annotation: a summary docstring
 Cenum_docThe raw documentation pieces of an enum, handed to a style to assemble
 Cenumerator_docOne enumerator's documentation for the enum_doc list: its bound (target-language) name and its doc text
 Cexclude_specThe stored form of an exclude mark: the languages a member is hidden from
 Cfield_accessSplice-based accessors for data member Mem — the pointer-to-member-free route the rods bind a protected field through
 Cfixed_stringA string literal captured by value, length included, so it can live in a structural annotation constant
 Cfunction_docThe raw documentation pieces of a function, handed to a style to assemble
 Cinclude_specThe stored form of an include mark: the languages a member is opted into
 Ckeep_alive_pairA keep_alive lifetime dependency: a (nurse, patient) index pair
 Ckeep_alive_specThe stored form of a keep_alive annotation: a lifetime dependency between two of a call's entities, addressed by pybind11/nanobind's index convention (0 = the return value, 1 = the first argument — the implicit this for a method — 2 = the second, …)
 Cmodule_welderPick the entry macro's welder: the user's optional override, else the rod's default welder::welder<rod>
 Cmodule_welder< Default, First, Rest... >
 Cno_reassign_specThe stored form of a no_reassign mark: the languages a data member is bound read-only** for, independent of whether its C++ type is const
 Conly_specThe stored form of an only mark: the complete set of languages a member may bind for — implicitly, not for any other
 Cparam_docOne function parameter's documentation: its identifier (nullptr if unnamed) and its doc text (nullptr if undocumented)
 Cpolicy_specThe stored form of a policy annotation
 Cproperty_entryOne resolved property: its getter and its (optional) setter
 Creturn_doc_specThe stored form of a returns annotation: a function's return-value doc
 Creturn_policy_specThe stored form of a return_policy annotation: a return-value policy, optionally scoped to some languages
 Cscoped_registrationThe scope-aware registration oracle: Resolution widened with the member-alias registrations of one class
 Csynthesized_comparison
 Ctparam_docOne documented template parameter of an entity: the parameter's name (as spelled in the tparam annotation) and its doc text
 Ctparam_specThe stored form of a tparam annotation: one template parameter's doc
 Ctrust_bindable_specThe stored form of a trust_bindable member mark
 Cweld_as_specThe stored form of a weld_as annotation: a forced target-language name
 Cweld_protected_specThe stored form of a policy::weld_protected annotation: the languages a type's protected members are admitted for
 Cweld_specThe stored form of a weld annotation: the mask of target languages
 Cwrapper_specOne row of the element-wise STL-wrapper table
 Ndiag
 Clang_out_of_mask_rangeThrown by lang_bit (<welder/annotations.hpp>) when a lang value lies past the 32-bit language-mask width — instead of an opaque shift-overflow error
 Cdangling_return_policyThrown by validate_return_policy (<welder/reflect.hpp>) — every rod runs it at its per-overload bind site — when a reference-category return_policy meets a by-value return
 Cbare_mark_onlyThrown by member_bound (<welder/reflect.hpp>) when a member carries a bare [[=welder::mark::only]] — "only, for every language" restricts nothing, so the mark must be called
 Cno_matching_virtual_slotThrown by virtual_slot (<welder/rods/python/trampoline.hpp>, reached through WELDER_PY_OVERRIDE_AS) when no overridable virtual of the class matches the requested name and function type
 Cstale_hook_signatureThrown by member_access_admitted (<welder/bind_traits.hpp>) when a resolution still declares its optional protected_participates hook under the superseded two-argument signature — which would otherwise be silently ignored (the detection is a requires probe)
 Cmarked_move_constructorThrown by validate_move_ctor_marks (<welder/bind_traits.hpp>) — the carriage runs it for every welded class — when a move constructor carries an include/only mark
 Caccessor_name_too_longThrown by the accessor_name factory helper (<welder/annotations.hpp>) when a getter/setter explicit property name exceeds the spec's inline capacity (the spec is deliberately not length-templated — see accessor_name_capacity)
 Cmalformed_getterThrown by property_entries (<welder/bind_traits.hpp>) when a [[=welder::getter]] sits on a function that is not a getter shape: it must be a const member function taking no parameters and returning a value
 Cmalformed_setterThrown by property_entries (<welder/bind_traits.hpp>) when a [[=welder::setter]] sits on a function that is not a setter shape: it must be a member function taking exactly one parameter
 Caccessor_role_conflictThrown by property_entries (<welder/bind_traits.hpp>) when one function carries both a getter and a setter mark for the same language — a function supplies one property half, never both
 Cduplicate_property_accessorThrown by property_entries (<welder/bind_traits.hpp>) when two getters (or two setters) resolve to the same property name for one language — a property has exactly one function per half
 Csetter_without_getterThrown by property_entries (<welder/bind_traits.hpp>) when a participating setter's property has no participating getter in that language — welder binds no write-only properties
 Caccessor_weld_as_conflictThrown by property_entries (<welder/bind_traits.hpp>) when an accessor-marked function also carries a weld_as — the accessor's explicit name is the property's rename tool, so the two would fight
 Cstatic_property_accessorThrown by property_entries (<welder/bind_traits.hpp>) on an accessor-marked static member function: static properties are not supported yet (deferred — the Python frameworks have def_property_static, the Lua rods have no equivalent surface)
 Cvirtual_property_accessorThrown by property_entries (<welder/bind_traits.hpp>) on an accessor-marked virtual member function: both Python rods dispatch overrides through a by-name attribute lookup, and a property object under that name would silently break the override protocol — rejected rather than bound subtly wrong
 Cproperty_name_collisionThrown by property_entries (<welder/bind_traits.hpp>) when a resolved property name collides with a bound data member or a (non-accessor) method of the same class surface
 Nnaming
 CnoneThe identity style: bind every C++ identifier unchanged
 CuniformA single-convention style: reshape every kind to convention Kind, whatever the source spelling
 Nrods
 Nluabridge
 CrodThe LuaBridge3 rod: a stateless policy type satisfying welder::rod
 Cmodule_scopeA copyable handle to a welded module (or submodule) table: the borrowed Lua state plus the namespace path from the global table
 CsessionPer-module session — unused: LuaBridge3 registers namespace variables as live properties eagerly (no deferred batch is needed, unlike sol2's live- variable proxy), so this is empty and open_module/close_module are no-ops
 Cclass_handleThe class handle threaded from make_class to the add_* hooks: enough to re-open the class (its module, its Lua name) plus the C++ type (via type, recovered by the per-member hooks from decltype)
 Cenum_handleThe enum handle threaded from make_enum to add_enumerator: the enclosing module, the enum's Lua name (a nested namespace of values) and whether it is scoped (an unscoped enum also mirrors its names onto the module)
 Nluacats
 Cclass_writerA class handle
 CdocumentThe growing LuaCATS document shared by every writer handle
 Cenum_writerAn enum handle: the value table text accumulated by add_enumerator, flushed as a ---@enum block by RAII (same rationale as class_writer)
 Cfunc_overloadOne overload of a callee, pre-rendered into the pieces a group needs: the summary doc, the ---@param block, the ---@return line, the function argument list, and the fun(…) signature for a ---@overload line
 Cmodule_writerA module handle: the shared document plus this (sub)module's dotted table path
 CrodThe LuaCATS stub rod: a stateless policy satisfying welder::rod that emits text instead of registering a live module
 CsessionNo deferred module state
 Ctable_declA module/submodule table to declare (prefix = {}), with its optional doc
 Nnanobind
 CrodThe nanobind rod: a stateless policy type satisfying welder::rod
 Nopaque_containers
 CdocumentThe accumulator threaded through the rod's emission hooks: the deduped set of reference containers the welded namespace uses, and the renderer for the finished header
 CentryOne container to open opaque: its C++ spelling, its derived target name, and whether a by_value mark excluded it (kept in the set so a later use site can be reconciled, but skipped at render)
 CrodThe opaque-container generator rod (satisfies welder::rod)
 Cmodule_handleA copyable handle onto the growing document threaded through every emission primitive (the rod's module_type)
 Cclass_handleThe per-class handle: it carries the document so the per-member hooks (add_field / add_method / …) can collect from members and signatures
 Cenum_handleThe enum handle — enums use no containers, so it carries nothing
 CsessionNo deferred module state
 Npybind11
 CrodThe pybind11 rod: a stateless policy type satisfying welder::rod
 Cenum_handleOwning handle for a py::native_enum<E>, plus the scope + name to reach the finalized enum object
 Npython
 Cby_value_specThe stored form of a by_value mark (a plain tag — it carries no state)
 Cgoogle_styleGoogle-style docstring assembly (the default)
 Cnumpy_styleNumPy-style docstring assembly (numpydoc)
 Cpep8PEP 8 naming: CapWords (PascalCase) for classes and enum types, snake_case for everything callable or data — methods, static methods, free functions, data members (properties), namespace variables — and submodules
 Cscanned_trampolineThe outcome of scanning a base's namespace for its trampoline-annotated subclass
 Csphinx_styleSphinx-style docstring assembly (reStructuredText field lists)
 Ctrampoline_specThe stored form of a trampoline mark (a plain tag — it carries no state)
 Nsol2
 CmetamethodA member operator's sol2 metamethod, or {…, nullptr} if welder does not expose it
 CrodThe sol2 rod: a stateless policy type satisfying welder::rod
 CsessionPer-module session: the deferred state for live namespace variables
 C_enum_bindingA welded enum's binding: the name→value table, how to mirror a name onto the enclosing scope, and whether the enum is scoped (an unscoped enum also mirrors its names onto the enclosing scope, like C++)
 Ntrampolines
 CdocumentThe growing generated header: the trampoline struct bodies and their trampoline_for registrations, kept apart so the structs can share one namespace generated { … } block and the registrations sit at global scope
 CrodThe trampoline-generator rod: a stateless welder::rod that, instead of registering a live module, appends a compilable trampoline struct (plus its trampoline_for registration) for every welded virtual type it visits
 Cmodule_handleA copyable handle onto the growing document that the driver threads through every emission primitive (the rod's module_type)
 Cclass_handleThe class handle the driver threads to the per-member hooks
 Cenum_handleThe enum handle
 CsessionNo deferred module state
 Cbind_flat_specThe stored form of a bind_flat mark (a plain tag — it carries no state)
 Cwelded_registrationThe default registration oracle of the bindability gate: a program-defined class/enum type counts as registered iff it is welded for the language
 CwelderWelder's binding entry point, parameterized on a rod