readLineCallBack
handle user input in OpenMaple
Calling Sequence
Parameters
Description
readLineCallBack(data, debug)
data
-
user_data pointer passed to StartMaple (void*)
debug
indicates when readline has been called inside the debugger (M_BOOL)
This OpenMaple function is part of the MCallBackVector structure passed as an argument to StartMaple.
The readLineCallBack function is called when the kernel executes the Maple readline command (which is also used by readstat and history) to obtain a line of input from the user. In most applications, this is not used.
The prototype for the function you can assign to the entry in the MCallBackVector must look like the following.
char * M_DECL readLineCallBack( void *data, M_BOOL debug );
The debug parameter indicates that the call to readline was made by the Maple debugger (the Maple debugger uses readline to get debugger commands from the user). If debug is TRUE, the readline call is from the debugger. If debug is FALSE, the readline call is from history, readstat, or another non-debugger call.
If no readLineCallBack function is provided, any attempt to execute the Maple readline function produces an error (reported using the errorCallBack or textCallBack).
The data parameter contains the same data as passed to StartMaple in the user_data parameter.
Source code for a readLineCallBack example is provided in the samples/OpenMaple/HelpExamples subdirectory of your Maple installation.
See Also
callBackCallBack
CustomWrapper
errorCallBack
OpenMaple
OpenMaple/C/API
OpenMaple/C/Examples
queryInterrupt
redirectCallBack
StartMaple
statusCallBack
streamCallBack
textCallBack
Download Help Document