Next: Symbol expected events, Previous: Symbol nulled events, Up: Events [Contents][Index]
Allows the user to deactivate and reactivate symbol prediction events in the grammar. When a recognizer is created, the activation status of each of its events is initialized to the activation status of that event in the base grammar. If reactivate is zero, the event is deactivated in the grammar. If reactivate is one, the event is activated in the grammar.
Symbol prediction events are active by default if the symbol was set up for prediction events in the grammar. If a symbol was not set up for prediction events in the grammar, symbol prediction events are inactive by default and any attempt to change that is a fatal error.
The activation status of a prediction event in the grammar can only be changed if the symbol is marked as a prediction event symbol in the grammar, and before the grammar is precomputed. However, if a symbol is marked as a prediction event symbol in the recognizer, the prediction event can be deactivated and reactivated in the recognizer.
Success cases: On success, the method returns the value of reactivate. The method succeeds trivially if the symbol is already set as indicated by reactivate.
Failure cases: If the active status of the prediction event for sym_id cannot be set as indicated by reactivate, the method fails. On failure, -2 is returned.
Allows the user to deactivate and reactivate symbol prediction events in the recognizer. If boolean is zero, the event is deactivated. If boolean is one, the event is activated.
Symbol prediction events are active by default if the symbol was set up for prediction events in the grammar. If a symbol was not set up for prediction events in the grammar, symbol prediction events are inactive by default and any attempt to change that is a fatal error.
Success cases: On success, the method returns the value of boolean. The method succeeds trivially if the symbol is already set as indicated by boolean.
Failure cases: If the active status of the prediction event for sym_id cannot be set as indicated by boolean, the method fails. On failure, -2 is returned.
Libmarpa can be set up
to generate a
MARPA_EVENT_SYMBOL_PREDICTED
event when a non-nulled symbol is predicted.
A non-nulled symbol is said to be predicted
when a instance of it
is acceptable at the current
earleme according to the grammar.
Nulled symbols do not generate predictions.
For predicted events to occur, the symbol must be marked
as a predicted event symbol.
The
marpa_g_symbol_is_predicted_event_set()
function
marks symbol sym_id as a predicted event symbol
if value is 1,
and unmarks it
it as a predicted event symbol if value is 0.
The
marpa_g_symbol_is_predicted_event()
method
returns the current value of the predicted event marking
for symbol sym_id.
Marking a prediction event sets its activation status to on. Unmarking a prediction event sets its activation status to off. The prediction event marking cannot be changed once the grammar is precomputed.
If a prediction event is marked,
its activation status can be changed using the
marpa_g_prediction_symbol_activate()
method.
Note that, if a symbol is marked as a prediction event symbol
in the recognizer,
its prediction event can be deactivated
and reactivated in the recognizer.
Success: On success, 1 if symbol sym_id is a predicted event symbol after the call, 0 otherwise.
Failures: If sym_id is well-formed, but there is no such symbol, -1. If the grammar g is precomputed; or on other failure, -2.
Next: Symbol expected events, Previous: Symbol nulled events, Up: Events [Contents][Index]