Qiskit / qiskit / 36478721064

88%

Build Type

push

github

Committed by web-flow

Commit Message

Add `VtableEntry` to C API (#17055)

* Add `VTableEntry` to C API

This is intended to be re-used by various C-API function that need to
define vtables, so doesn't belong to any one group.

The `slots` and `flags` fields are deliberately bare `uint32_t` fields
and not particular enums; even within a _single_ vtable definition, this
means that downstream code can provide definitions for optional
methods/slots added in later versions of Qiskit, and still work when
an older Qiskit is loaded at runtime; older Qiskits simply know to
ignore as-yet-unknown values.

(We can also consider adding an environment variable or the like that
enables debug logging for those loads, so developers can see why certain
methods aren't loading.)

The additional include in `bindgen` is because the type isn't used by
functions in this PR, so `cbindgen` wouldn't emit it.  We need it
reachable from `qiskit.h` for Doxygen, though.  The two Doxygen-related
option changes are to suppress a spurious `#include <types.h>` in the
generated HTML.  Actually it's the `breathe_show_include` one that's the
driver (the Doxygen `SHOW_HEADERFILE = NO` doesn't affect the XML), but
I left both in to make the intent clear.

* Correct lint suppressions for visibility

* Rename to `VtableEntry`

While this feels a bit wrong to me, it is actually the Rust style
convention, especially as we use "vtable" as a single word throughout
the docs.

Coverage Stats

2 of 2 new or added lines in 1 file covered. (100.0%)

7 existing lines in 2 files now uncovered.

122381 of 138886 relevant lines covered (88.12%)

943420.5 hits per line