Boolean Stream Handler API

Table of Contents

Include this API as

#include <wtk/BooleanStreamHandler.h>

Members of this API live in the following namespace

namespace wtk { ...

`class BooleanStreamHandler`

The wtk::BooleanStreamHandler is a virtual class for the user to implement with callbacks for the Parser API to use when stream parsing.

If the Parser supports line-numbering, it will use this callback to set the current line number before a gate’s callback is invoked.

virtual void setLineNum(size_t const line);

Called when an @instance directive is reached.

virtual void handleInstance(wtk::index_t const idx);

Called when an @short_witness directive is reached.

virtual void handleShortWitness(wtk::index_t const idx);

Called when an @xor directive is reached.

virtual void handleXor(wtk::index_t const out, wtk::index_t const left, wtk::index_t const right);

Called when an @and directive is reached.

virtual void handleAnd(wtk::index_t const out, wtk::index_t const left, wtk::index_t const right);

Called when a @not directive is reached.

virtual void handleNot(wtk::index_t const out, wtk::index_t const in);

Called when a constant assignment directive is reached.

virtual void handleAssign(wtk::index_t const out, uint8_t const val);

Called when a copy directive is reached.

virtual void handleCopy(wtk::index_t const out, wtk::index_t const in);

Called when an @assert_zero directive is reached.

virtual void handleAssertZero(wtk::index_t const in);

Called when a @delete directive with a single argument is reached.

virtual void handleDeleteSingle(wtk::index_t const in);

Called when a @delete directive with a range argument is reached. The range is inclusive on both ends.

virtual void handleDeleteRange(wtk::index_t const first, wtk::index_t const last);

Called after the last directive is reached.

virtual void handleEnd();