public methods for user interface dialogs
SCIP_DIALOG * SCIPdialoghdlrGetRoot | ( | SCIP_DIALOGHDLR * | dialoghdlr | ) |
returns the root dialog of the dialog handler
dialoghdlr | dialog handler |
Definition at line 436 of file dialog.c.
References assert(), NULL, and SCIP_Dialoghdlr::rootdialog.
Referenced by dialogExecMenu(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIPaddDialogEntry(), and SCIPgetRootDialog().
void SCIPdialoghdlrClearBuffer | ( | SCIP_DIALOGHDLR * | dialoghdlr | ) |
clears the input command buffer of the dialog handler
dialoghdlr | dialog handler |
Definition at line 446 of file dialog.c.
References assert(), SCIP_Dialoghdlr::buffer, SCIP_Dialoghdlr::bufferpos, and NULL.
Referenced by dialogExecMenu(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIPdialoghdlrCreate(), SCIPdialoghdlrExec(), SCIPdialoghdlrGetLine(), SCIPdialoghdlrGetWord(), and writeProblem().
SCIP_Bool SCIPdialoghdlrIsBufferEmpty | ( | SCIP_DIALOGHDLR * | dialoghdlr | ) |
returns TRUE iff input command buffer is empty
dialoghdlr | dialog handler |
Definition at line 457 of file dialog.c.
References assert(), SCIP_Dialoghdlr::buffer, SCIP_Dialoghdlr::bufferpos, SCIP_Dialoghdlr::buffersize, and NULL.
Referenced by SCIP_DECL_DIALOGEXEC(), SCIPdialoghdlrGetLine(), and SCIPdialoghdlrGetWord().
SCIP_RETCODE SCIPdialoghdlrGetLine | ( | SCIP_DIALOGHDLR * | dialoghdlr, |
SCIP_DIALOG * | dialog, | ||
const char * | prompt, | ||
char ** | inputline, | ||
SCIP_Bool * | endoffile ) |
returns the next line in the handler's command buffer; if the buffer is empty, displays the given prompt or the current dialog's path and asks the user for further input; the user must not free or modify the returned string
dialoghdlr | dialog handler |
dialog | current dialog |
prompt | prompt to display, or NULL to display the current dialog's path |
inputline | pointer to store the complete line in the handler's command buffer |
endoffile | pointer to store whether the end of the input file was reached |
Definition at line 470 of file dialog.c.
References assert(), SCIP_Dialoghdlr::buffer, SCIP_Dialoghdlr::bufferpos, SCIP_Dialoghdlr::buffersize, FALSE, i, NULL, readInputLine(), SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPdialogGetPath(), SCIPdialoghdlrAddHistory(), SCIPdialoghdlrClearBuffer(), SCIPdialoghdlrIsBufferEmpty(), SCIPsnprintf(), and TRUE.
Referenced by SCIP_DECL_DIALOGEXEC().
SCIP_RETCODE SCIPdialoghdlrGetWord | ( | SCIP_DIALOGHDLR * | dialoghdlr, |
SCIP_DIALOG * | dialog, | ||
const char * | prompt, | ||
char ** | inputword, | ||
SCIP_Bool * | endoffile ) |
returns the next word in the handler's command buffer; if the buffer is empty, displays the given prompt or the current dialog's path and asks the user for further input; the user must not free or modify the returned string
dialoghdlr | dialog handler |
dialog | current dialog |
prompt | prompt to display, or NULL to display the current dialog's path |
inputword | pointer to store the next word in the handler's command buffer |
endoffile | pointer to store whether the end of the input file was reached |
Definition at line 546 of file dialog.c.
References assert(), SCIP_Dialoghdlr::buffer, SCIP_Dialoghdlr::bufferpos, SCIP_Dialoghdlr::buffersize, FALSE, i, NULL, readInputLine(), SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPdebugMessage, SCIPdialogGetPath(), SCIPdialoghdlrAddHistory(), SCIPdialoghdlrClearBuffer(), SCIPdialoghdlrIsBufferEmpty(), and SCIPsnprintf().
Referenced by dialogExecMenu(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), and writeProblem().
SCIP_RETCODE SCIPdialoghdlrAddInputLine | ( | SCIP_DIALOGHDLR * | dialoghdlr, |
const char * | inputline ) |
adds a single line of input to the dialog handler which is treated as if the user entered the command line
dialoghdlr | dialog handler |
inputline | input line to add |
Definition at line 697 of file dialog.c.
References assert(), BMSallocMemory, BMSduplicateMemoryArray, BMSfreeMemory, i, SCIP_Dialoghdlr::inputlistptr, NULL, SCIP_ALLOC, SCIP_ALLOC_TERMINATE, and SCIP_OKAY.
Referenced by SCIPaddDialogInputLine().
SCIP_RETCODE SCIPdialoghdlrAddHistory | ( | SCIP_DIALOGHDLR * | dialoghdlr, |
SCIP_DIALOG * | dialog, | ||
const char * | command, | ||
SCIP_Bool | escapecommand ) |
adds a command to the command history of the dialog handler; if a dialog is given, the command is preceeded by the dialog's command path; if no command is given, only the path to the dialog is added to the command history
dialoghdlr | dialog handler |
dialog | current dialog, or NULL |
command | command string to add to the command history, or NULL |
escapecommand | should special characters in command be prefixed by an escape char? |
Definition at line 726 of file dialog.c.
References addHistory(), assert(), getHistoryLength(), h, i, SCIP_Dialoghdlr::nprotectedhistelems, NULL, removeHistory(), SCIP_Dialoghdlr::rootdialog, SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPescapeString(), SCIPsnprintf(), and SCIPstrncpy().
Referenced by SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIPaddDialogHistoryLine(), SCIPdialoghdlrGetLine(), SCIPdialoghdlrGetWord(), and writeProblem().
SCIP_Bool SCIPdialogHasEntry | ( | SCIP_DIALOG * | dialog, |
const char * | entryname ) |
returns TRUE iff a dialog entry matching exactly the given name is existing in the given dialog
dialog | dialog |
entryname | name of the dialog entry to find |
Definition at line 995 of file dialog.c.
References assert(), FALSE, i, NULL, SCIPdialogGetName(), SCIPdialogGetNSubdialogs(), SCIPdialogGetSubdialogs(), and TRUE.
Referenced by addFixParamDialog(), addSetParamDialog(), createCountDialog(), createEmphasisSubmenu(), SCIPdialogAddEntry(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrSuperindicator(), SCIPincludeDialogDefaultBasic(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), and SCIPincludeObjDialog().
int SCIPdialogFindEntry | ( | SCIP_DIALOG * | dialog, |
const char * | entryname, | ||
SCIP_DIALOG ** | subdialog ) |
searches the dialog for entries corresponding to the given name; If a complete match is found, the entry is returned as "subdialog" and the return value is 1. If no dialog entry completely matches the given "entryname", the number of entries with names beginning with "entryname" is returned. If this number is 1, the single match is returned as "subdialog". Otherwise, "subdialog" is set to NULL.
dialog | dialog |
entryname | name of the dialog entry to find |
subdialog | pointer to store the found dialog entry |
Definition at line 1028 of file dialog.c.
References assert(), i, NULL, SCIPdialogGetName(), SCIPdialogGetNSubdialogs(), and SCIPdialogGetSubdialogs().
Referenced by addFixParamDialog(), addSetParamDialog(), createCountDialog(), createEmphasisSubmenu(), dialogExecMenu(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrSuperindicator(), SCIPincludeDialogDefaultBasic(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().
SCIP_RETCODE SCIPdialogDisplayMenu | ( | SCIP_DIALOG * | dialog, |
SCIP * | scip ) |
displays the dialog's menu
dialog | dialog |
scip | SCIP data structure |
Definition at line 1072 of file dialog.c.
References assert(), i, NULL, SCIP_CALL, SCIP_OKAY, SCIPdialogDisplayMenuEntry(), SCIPdialogIsSubmenu(), and SCIPdialogMessage().
Referenced by SCIP_DECL_DIALOGEXEC(), and SCIP_DECL_DIALOGEXEC().
SCIP_RETCODE SCIPdialogDisplayMenuEntry | ( | SCIP_DIALOG * | dialog, |
SCIP * | scip ) |
displays the entry for the dialog in it's parent's menu
dialog | dialog |
scip | SCIP data structure |
Definition at line 1106 of file dialog.c.
References assert(), i, NULL, SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPdialogMessage(), and SCIPsnprintf().
Referenced by SCIPdialogDisplayCompletions(), and SCIPdialogDisplayMenu().
SCIP_RETCODE SCIPdialogDisplayCompletions | ( | SCIP_DIALOG * | dialog, |
SCIP * | scip, | ||
const char * | entryname ) |
displays all dialog entries with names starting with the given "entryname"
dialog | dialog |
scip | SCIP data structure |
entryname | name of the dialog entry to find |
Definition at line 1140 of file dialog.c.
References assert(), i, NULL, SCIP_CALL, SCIP_OKAY, SCIPdialogDisplayMenuEntry(), SCIPdialogGetName(), SCIPdialogGetNSubdialogs(), and SCIPdialogGetSubdialogs().
Referenced by dialogExecMenu().
void SCIPdialogGetPath | ( | SCIP_DIALOG * | dialog, |
const char | sepchar, | ||
char * | path ) |
gets the name of the current path in the dialog tree, separated by the given character
dialog | dialog |
sepchar | separation character to insert in path |
path | string buffer to store the path |
Definition at line 1171 of file dialog.c.
References assert(), i, NULL, SCIP_MAXSTRLEN, SCIPsnprintf(), and SCIPstrncpy().
Referenced by SCIPdialoghdlrGetLine(), and SCIPdialoghdlrGetWord().
const char * SCIPdialogGetName | ( | SCIP_DIALOG * | dialog | ) |
gets the command name of the dialog
dialog | dialog |
Definition at line 1193 of file dialog.c.
References assert(), i, and NULL.
Referenced by SCIP_DECL_SORTPTRCOMP(), SCIPdialogAddEntry(), SCIPdialogCopyInclude(), SCIPdialogDisplayCompletions(), SCIPdialogFindEntry(), and SCIPdialogHasEntry().
const char * SCIPdialogGetDesc | ( | SCIP_DIALOG * | dialog | ) |
SCIP_Bool SCIPdialogIsSubmenu | ( | SCIP_DIALOG * | dialog | ) |
SCIP_DIALOG * SCIPdialogGetParent | ( | SCIP_DIALOG * | dialog | ) |
gets the parent dialog of the given dialog
dialog | dialog |
Definition at line 1223 of file dialog.c.
References assert(), i, and NULL.
Referenced by dialogExecMenu(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), and SCIP_DECL_DIALOGEXEC().
SCIP_DIALOG ** SCIPdialogGetSubdialogs | ( | SCIP_DIALOG * | dialog | ) |
gets the array of sub-dialogs associated with the given dialog
dialog | dialog |
Definition at line 1233 of file dialog.c.
References assert(), i, and NULL.
Referenced by SCIPdialogDisplayCompletions(), SCIPdialogFindEntry(), and SCIPdialogHasEntry().
int SCIPdialogGetNSubdialogs | ( | SCIP_DIALOG * | dialog | ) |
gets the number of sub-dialogs associated with the given dialog
dialog | dialog |
Definition at line 1243 of file dialog.c.
References assert(), i, and NULL.
Referenced by SCIPdialogDisplayCompletions(), SCIPdialogFindEntry(), and SCIPdialogHasEntry().
SCIP_DIALOGDATA * SCIPdialogGetData | ( | SCIP_DIALOG * | dialog | ) |
gets the user defined data associated with the given dialog
dialog | dialog |
Definition at line 1253 of file dialog.c.
References assert(), i, and NULL.
Referenced by SCIP_DECL_DIALOGCOPY(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), SCIP_DECL_DIALOGEXEC(), and SCIP_DECL_DIALOGFREE().
void SCIPdialogSetData | ( | SCIP_DIALOG * | dialog, |
SCIP_DIALOGDATA * | dialogdata ) |
SCIP_RETCODE SCIPdialogWriteHistory | ( | const char * | filename | ) |
writes command history to specified filename
filename | file name for (over)writing history |
Definition at line 1274 of file dialog.c.
References writeHistory().
Referenced by SCIP_DECL_DIALOGEXEC().
SCIP_RETCODE SCIPincludeDialog | ( | SCIP * | scip, |
SCIP_DIALOG ** | dialog, | ||
SCIP_DECL_DIALOGCOPY((*dialogcopy)) | , | ||
SCIP_DECL_DIALOGEXEC((*dialogexec)) | , | ||
SCIP_DECL_DIALOGDESC((*dialogdesc)) | , | ||
SCIP_DECL_DIALOGFREE((*dialogfree)) | , | ||
const char * | name, | ||
const char * | desc, | ||
SCIP_Bool | issubmenu, | ||
SCIP_DIALOGDATA * | dialogdata ) |
creates and includes dialog
scip | SCIP data structure |
dialog | pointer to store the dialog |
name | name of dialog: command name appearing in parent's dialog menu |
desc | description of dialog used if description output method is NULL |
issubmenu | is the dialog a submenu? |
dialogdata | user defined dialog data |
Definition at line 59 of file scip_dialog.c.
References assert(), i, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPdialogCreate(), SCIPerrorMessage, SCIPexistsDialog(), and SCIPsetIncludeDialog().
Referenced by addFixParamDialog(), addSetParamDialog(), createCountDialog(), createEmphasisSubmenu(), SCIPcreateRootDialog(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrSuperindicator(), SCIPincludeDialogDefaultBasic(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), and SCIPincludeObjDialog().
SCIP_Bool SCIPexistsDialog | ( | SCIP * | scip, |
SCIP_DIALOG * | dialog ) |
returns if the dialog already exists
returns if the dialog already exists
scip | SCIP data structure |
dialog | dialog |
Definition at line 92 of file scip_dialog.c.
References assert(), i, NULL, and SCIPsetExistsDialog().
Referenced by SCIPincludeDialog().
SCIP_RETCODE SCIPcaptureDialog | ( | SCIP * | scip, |
SCIP_DIALOG * | dialog ) |
captures a dialog
scip | SCIP data structure |
dialog | dialog |
Definition at line 107 of file scip_dialog.c.
References assert(), i, NULL, SCIP_OKAY, and SCIPdialogCapture().
SCIP_RETCODE SCIPreleaseDialog | ( | SCIP * | scip, |
SCIP_DIALOG ** | dialog ) |
releases a dialog
scip | SCIP data structure |
dialog | pointer to the dialog |
Definition at line 124 of file scip_dialog.c.
References assert(), i, NULL, SCIP_CALL, SCIP_OKAY, and SCIPdialogRelease().
Referenced by addFixParamDialog(), addSetParamDialog(), createCountDialog(), createEmphasisSubmenu(), SCIPcreateRootDialog(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrSuperindicator(), SCIPincludeDialogDefaultBasic(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), and SCIPincludeObjDialog().
SCIP_RETCODE SCIPsetRootDialog | ( | SCIP * | scip, |
SCIP_DIALOG * | dialog ) |
makes given dialog the root dialog of SCIP's interactive user shell; captures dialog and releases former root dialog
scip | SCIP data structure |
dialog | dialog to be the root |
Definition at line 141 of file scip_dialog.c.
References assert(), i, NULL, SCIP_CALL, SCIP_OKAY, and SCIPdialoghdlrSetRoot().
Referenced by SCIPcreateRootDialog().
SCIP_DIALOG * SCIPgetRootDialog | ( | SCIP * | scip | ) |
returns the root dialog of SCIP's interactive user shell
scip | SCIP data structure |
Definition at line 157 of file scip_dialog.c.
References assert(), NULL, and SCIPdialoghdlrGetRoot().
Referenced by createCountDialog(), SCIPcreateRootDialog(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrSuperindicator(), SCIPincludeDialogDefaultBasic(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), and SCIPincludeObjDialog().
SCIP_RETCODE SCIPaddDialogEntry | ( | SCIP * | scip, |
SCIP_DIALOG * | dialog, | ||
SCIP_DIALOG * | subdialog ) |
adds a sub dialog to the given dialog as menu entry and captures it
scip | SCIP data structure |
dialog | dialog to extend, or NULL for root dialog |
subdialog | subdialog to add as menu entry in dialog |
Definition at line 171 of file scip_dialog.c.
References assert(), i, NULL, SCIP_CALL, SCIP_OKAY, SCIPdialogAddEntry(), and SCIPdialoghdlrGetRoot().
Referenced by addFixParamDialog(), addSetParamDialog(), createCountDialog(), createEmphasisSubmenu(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrSuperindicator(), SCIPincludeDialogDefaultBasic(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), and SCIPincludeObjDialog().
SCIP_RETCODE SCIPaddDialogInputLine | ( | SCIP * | scip, |
const char * | inputline ) |
adds a single line of input which is treated as if the user entered the command line
scip | SCIP data structure |
inputline | input line to add |
Definition at line 192 of file scip_dialog.c.
References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPdialoghdlrAddInputLine().
Referenced by processArguments(), and SCIPprocessShellArguments().
SCIP_RETCODE SCIPaddDialogHistoryLine | ( | SCIP * | scip, |
const char * | inputline ) |
adds a single line of input to the command history which can be accessed with the cursor keys
scip | SCIP data structure |
inputline | input line to add |
Definition at line 209 of file scip_dialog.c.
References assert(), FALSE, NULL, SCIP_CALL, SCIP_OKAY, and SCIPdialoghdlrAddHistory().
SCIP_RETCODE SCIPstartInteraction | ( | SCIP * | scip | ) |
starts interactive mode of SCIP by executing the root dialog
scip
is in one of the following stages:
See SCIP_STAGE for a complete list of all possible solving stages.
scip | SCIP data structure |
Definition at line 242 of file scip_dialog.c.
References FALSE, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPdialoghdlrExec(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), and TRUE.
Referenced by interactive(), processArguments(), and SCIPprocessShellArguments().