Detailed Description
public methods for user interface dialogs
Function Documentation
◆ SCIPdialoghdlrGetRoot()
SCIP_DIALOG* SCIPdialoghdlrGetRoot | ( | SCIP_DIALOGHDLR * | dialoghdlr | ) |
returns the root dialog of the dialog handler
- Parameters
-
dialoghdlr dialog handler
Definition at line 436 of file dialog.c.
References NULL, and SCIP_Dialoghdlr::rootdialog.
Referenced by dialogExecMenu(), SCIP_DECL_DIALOGEXEC(), SCIPaddDialogEntry(), and SCIPgetRootDialog().
◆ SCIPdialoghdlrClearBuffer()
void SCIPdialoghdlrClearBuffer | ( | SCIP_DIALOGHDLR * | dialoghdlr | ) |
clears the input command buffer of the dialog handler
- Parameters
-
dialoghdlr dialog handler
Definition at line 446 of file dialog.c.
References SCIP_Dialoghdlr::buffer, SCIP_Dialoghdlr::bufferpos, and NULL.
Referenced by dialogExecMenu(), SCIP_DECL_DIALOGEXEC(), SCIPdialoghdlrCreate(), SCIPdialoghdlrExec(), SCIPdialoghdlrGetLine(), SCIPdialoghdlrGetWord(), and writeProblem().
◆ SCIPdialoghdlrIsBufferEmpty()
SCIP_Bool SCIPdialoghdlrIsBufferEmpty | ( | SCIP_DIALOGHDLR * | dialoghdlr | ) |
returns TRUE iff input command buffer is empty
- Parameters
-
dialoghdlr dialog handler
Definition at line 457 of file dialog.c.
References SCIP_Dialoghdlr::buffer, SCIP_Dialoghdlr::bufferpos, SCIP_Dialoghdlr::buffersize, and NULL.
Referenced by SCIP_DECL_DIALOGEXEC(), SCIPdialoghdlrGetLine(), and SCIPdialoghdlrGetWord().
◆ SCIPdialoghdlrGetLine()
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
- Parameters
-
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 SCIP_Dialoghdlr::buffer, SCIP_Dialoghdlr::bufferpos, SCIP_Dialoghdlr::buffersize, FALSE, NULL, readInputLine(), SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPdialogGetPath(), SCIPdialoghdlrAddHistory(), SCIPdialoghdlrClearBuffer(), SCIPdialoghdlrIsBufferEmpty(), SCIPsnprintf(), and TRUE.
Referenced by SCIP_DECL_DIALOGEXEC().
◆ SCIPdialoghdlrGetWord()
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
- Parameters
-
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 SCIP_Dialoghdlr::buffer, SCIP_Dialoghdlr::bufferpos, SCIP_Dialoghdlr::buffersize, FALSE, NULL, readInputLine(), SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPdebugMessage, SCIPdialogGetPath(), SCIPdialoghdlrAddHistory(), SCIPdialoghdlrClearBuffer(), SCIPdialoghdlrIsBufferEmpty(), and SCIPsnprintf().
Referenced by dialogExecMenu(), SCIP_DECL_DIALOGEXEC(), and writeProblem().
◆ SCIPdialoghdlrAddInputLine()
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
- Parameters
-
dialoghdlr dialog handler inputline input line to add
Definition at line 697 of file dialog.c.
References BMSallocMemory, BMSduplicateMemoryArray, BMSfreeMemory, SCIP_Linelist::inputline, SCIP_Dialoghdlr::inputlistptr, SCIP_Linelist::nextline, NULL, SCIP_ALLOC, SCIP_ALLOC_TERMINATE, and SCIP_OKAY.
Referenced by SCIPaddDialogInputLine().
◆ SCIPdialoghdlrAddHistory()
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
- Parameters
-
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(), getHistoryLength(), h, SCIP_Dialog::name, SCIP_Dialoghdlr::nprotectedhistelems, NULL, SCIP_Dialog::parent, removeHistory(), SCIP_Dialoghdlr::rootdialog, SCIP_Bool, SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPescapeString(), SCIPsnprintf(), and SCIPstrncpy().
Referenced by SCIP_DECL_DIALOGEXEC(), SCIPaddDialogHistoryLine(), SCIPdialoghdlrGetLine(), SCIPdialoghdlrGetWord(), and writeProblem().
◆ SCIPdialogHasEntry()
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
- Parameters
-
dialog dialog entryname name of the dialog entry to find
Definition at line 995 of file dialog.c.
References FALSE, NULL, SCIPdialogGetName(), SCIPdialogGetNSubdialogs(), SCIPdialogGetSubdialogs(), and TRUE.
Referenced by addFixParamDialog(), addSetParamDialog(), createCountDialog(), createEmphasisSubmenu(), SCIPdialogAddEntry(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrSuperindicator(), SCIPincludeDialogDefaultBasic(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), and SCIPincludeObjDialog().
◆ SCIPdialogFindEntry()
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.
- Parameters
-
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 NULL, SCIPdialogGetName(), SCIPdialogGetNSubdialogs(), and SCIPdialogGetSubdialogs().
Referenced by addFixParamDialog(), addSetParamDialog(), createCountDialog(), createEmphasisSubmenu(), dialogExecMenu(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrSuperindicator(), SCIPincludeDialogDefaultBasic(), SCIPincludeDialogDefaultFix(), and SCIPincludeDialogDefaultSet().
◆ SCIPdialogDisplayMenu()
SCIP_RETCODE SCIPdialogDisplayMenu | ( | SCIP_DIALOG * | dialog, |
SCIP * | scip | ||
) |
displays the dialog's menu
- Parameters
-
dialog dialog scip SCIP data structure
Definition at line 1072 of file dialog.c.
References SCIP_Dialog::nsubdialogs, NULL, SCIP_CALL, SCIP_OKAY, SCIPdialogDisplayMenuEntry(), SCIPdialogIsSubmenu(), SCIPdialogMessage(), and SCIP_Dialog::subdialogs.
Referenced by SCIP_DECL_DIALOGEXEC().
◆ SCIPdialogDisplayMenuEntry()
SCIP_RETCODE SCIPdialogDisplayMenuEntry | ( | SCIP_DIALOG * | dialog, |
SCIP * | scip | ||
) |
displays the entry for the dialog in it's parent's menu
- Parameters
-
dialog dialog scip SCIP data structure
Definition at line 1106 of file dialog.c.
References SCIP_Dialog::desc, SCIP_Dialog::issubmenu, SCIP_Dialog::name, NULL, SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPdialogMessage(), and SCIPsnprintf().
Referenced by SCIPdialogDisplayCompletions(), and SCIPdialogDisplayMenu().
◆ SCIPdialogDisplayCompletions()
SCIP_RETCODE SCIPdialogDisplayCompletions | ( | SCIP_DIALOG * | dialog, |
SCIP * | scip, | ||
const char * | entryname | ||
) |
displays all dialog entries with names starting with the given "entryname"
- Parameters
-
dialog dialog scip SCIP data structure entryname name of the dialog entry to find
Definition at line 1140 of file dialog.c.
References NULL, SCIP_CALL, SCIP_OKAY, SCIPdialogDisplayMenuEntry(), SCIPdialogGetName(), SCIPdialogGetNSubdialogs(), and SCIPdialogGetSubdialogs().
Referenced by dialogExecMenu().
◆ SCIPdialogGetPath()
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
- Parameters
-
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 SCIP_Dialog::name, NULL, SCIP_Dialog::parent, SCIP_MAXSTRLEN, SCIPsnprintf(), and SCIPstrncpy().
Referenced by SCIPdialoghdlrGetLine(), and SCIPdialoghdlrGetWord().
◆ SCIPdialogGetName()
const char* SCIPdialogGetName | ( | SCIP_DIALOG * | dialog | ) |
gets the command name of the dialog
- Parameters
-
dialog dialog
Definition at line 1193 of file dialog.c.
References SCIP_Dialog::name, and NULL.
Referenced by SCIP_DECL_SORTPTRCOMP(), SCIPdialogAddEntry(), SCIPdialogCopyInclude(), SCIPdialogDisplayCompletions(), SCIPdialogFindEntry(), and SCIPdialogHasEntry().
◆ SCIPdialogGetDesc()
const char* SCIPdialogGetDesc | ( | SCIP_DIALOG * | dialog | ) |
gets the description of the dialog
- Parameters
-
dialog dialog
Definition at line 1203 of file dialog.c.
References SCIP_Dialog::desc, and NULL.
◆ SCIPdialogIsSubmenu()
SCIP_Bool SCIPdialogIsSubmenu | ( | SCIP_DIALOG * | dialog | ) |
returns whether the dialog is a sub menu
- Parameters
-
dialog dialog
Definition at line 1213 of file dialog.c.
References SCIP_Dialog::issubmenu, and NULL.
Referenced by SCIPdialogDisplayMenu().
◆ SCIPdialogGetParent()
SCIP_DIALOG* SCIPdialogGetParent | ( | SCIP_DIALOG * | dialog | ) |
gets the parent dialog of the given dialog
- Parameters
-
dialog dialog
Definition at line 1223 of file dialog.c.
References NULL, and SCIP_Dialog::parent.
Referenced by dialogExecMenu(), and SCIP_DECL_DIALOGEXEC().
◆ SCIPdialogGetSubdialogs()
SCIP_DIALOG** SCIPdialogGetSubdialogs | ( | SCIP_DIALOG * | dialog | ) |
gets the array of sub-dialogs associated with the given dialog
- Parameters
-
dialog dialog
Definition at line 1233 of file dialog.c.
References NULL, and SCIP_Dialog::subdialogs.
Referenced by SCIPdialogDisplayCompletions(), SCIPdialogFindEntry(), and SCIPdialogHasEntry().
◆ SCIPdialogGetNSubdialogs()
int SCIPdialogGetNSubdialogs | ( | SCIP_DIALOG * | dialog | ) |
gets the number of sub-dialogs associated with the given dialog
- Parameters
-
dialog dialog
Definition at line 1243 of file dialog.c.
References SCIP_Dialog::nsubdialogs, and NULL.
Referenced by SCIPdialogDisplayCompletions(), SCIPdialogFindEntry(), and SCIPdialogHasEntry().
◆ SCIPdialogGetData()
SCIP_DIALOGDATA* SCIPdialogGetData | ( | SCIP_DIALOG * | dialog | ) |
gets the user defined data associated with the given dialog
- Parameters
-
dialog dialog
Definition at line 1253 of file dialog.c.
References SCIP_Dialog::dialogdata, and NULL.
Referenced by SCIP_DECL_DIALOGCOPY(), SCIP_DECL_DIALOGDESC(), SCIP_DECL_DIALOGEXEC(), and SCIP_DECL_DIALOGFREE().
◆ SCIPdialogSetData()
void SCIPdialogSetData | ( | SCIP_DIALOG * | dialog, |
SCIP_DIALOGDATA * | dialogdata | ||
) |
sets user data of dialog; user has to free old data in advance!
- Parameters
-
dialog dialog dialogdata new dialog user data
Definition at line 1263 of file dialog.c.
References SCIP_Dialog::dialogdata, and NULL.
Referenced by SCIP_DECL_DIALOGFREE().
◆ SCIPdialogWriteHistory()
SCIP_RETCODE SCIPdialogWriteHistory | ( | const char * | filename | ) |
writes command history to specified filename
- Parameters
-
filename file name for (over)writing history
Definition at line 1274 of file dialog.c.
References writeHistory().
Referenced by SCIP_DECL_DIALOGEXEC().
◆ SCIPincludeDialog()
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
- Returns
- SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See SCIP_RETCODE for a complete list of error codes.
- Parameters
-
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 NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPdialogCreate(), SCIPerrorMessage, SCIPexistsDialog(), SCIPsetIncludeDialog(), and Scip::set.
Referenced by addFixParamDialog(), addSetParamDialog(), createCountDialog(), createEmphasisSubmenu(), SCIPcreateRootDialog(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrSuperindicator(), SCIPincludeDialogDefaultBasic(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), and SCIPincludeObjDialog().
◆ SCIPexistsDialog()
SCIP_Bool SCIPexistsDialog | ( | SCIP * | scip, |
SCIP_DIALOG * | dialog | ||
) |
returns if the dialog already exists
- Returns
- TRUE is returned if the dialog exists, otherwise FALSE.
returns if the dialog already exists
- Returns
- TRUE is returned if the dialog exits, otherwise FALSE.
- Parameters
-
scip SCIP data structure dialog dialog
Definition at line 92 of file scip_dialog.c.
References NULL, SCIPsetExistsDialog(), and Scip::set.
Referenced by SCIPincludeDialog().
◆ SCIPcaptureDialog()
SCIP_RETCODE SCIPcaptureDialog | ( | SCIP * | scip, |
SCIP_DIALOG * | dialog | ||
) |
captures a dialog
- Returns
- SCIP_OKAY is returned if everything worked. otherwise a suitable error code is passed. see SCIP_RETCODE for a complete list of error codes.
- Parameters
-
scip SCIP data structure dialog dialog
Definition at line 107 of file scip_dialog.c.
References NULL, SCIP_OKAY, and SCIPdialogCapture().
◆ SCIPreleaseDialog()
SCIP_RETCODE SCIPreleaseDialog | ( | SCIP * | scip, |
SCIP_DIALOG ** | dialog | ||
) |
releases a dialog
- Returns
- SCIP_OKAY is returned if everything worked. otherwise a suitable error code is passed. see SCIP_RETCODE for a complete list of error codes.
- Parameters
-
scip SCIP data structure dialog pointer to the dialog
Definition at line 124 of file scip_dialog.c.
References NULL, SCIP_CALL, SCIP_OKAY, and SCIPdialogRelease().
Referenced by addFixParamDialog(), addSetParamDialog(), createCountDialog(), createEmphasisSubmenu(), SCIPcreateRootDialog(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrSuperindicator(), SCIPincludeDialogDefaultBasic(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), and SCIPincludeObjDialog().
◆ SCIPsetRootDialog()
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
- Returns
- SCIP_OKAY is returned if everything worked. otherwise a suitable error code is passed. see SCIP_RETCODE for a complete list of error codes.
- Parameters
-
scip SCIP data structure dialog dialog to be the root
Definition at line 141 of file scip_dialog.c.
References Scip::dialoghdlr, NULL, SCIP_CALL, SCIP_OKAY, and SCIPdialoghdlrSetRoot().
Referenced by SCIPcreateRootDialog().
◆ SCIPgetRootDialog()
SCIP_DIALOG* SCIPgetRootDialog | ( | SCIP * | scip | ) |
returns the root dialog of SCIP's interactive user shell
- Returns
- the root dialog of SCIP's interactive user shell is returned.
- Parameters
-
scip SCIP data structure
Definition at line 157 of file scip_dialog.c.
References Scip::dialoghdlr, NULL, and SCIPdialoghdlrGetRoot().
Referenced by createCountDialog(), SCIPcreateRootDialog(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrSuperindicator(), SCIPincludeDialogDefaultBasic(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), and SCIPincludeObjDialog().
◆ SCIPaddDialogEntry()
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
- Returns
- SCIP_OKAY is returned if everything worked. otherwise a suitable error code is passed. see SCIP_RETCODE for a complete list of error codes.
- Parameters
-
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 Scip::dialoghdlr, NULL, SCIP_CALL, SCIP_OKAY, SCIPdialogAddEntry(), SCIPdialoghdlrGetRoot(), and Scip::set.
Referenced by addFixParamDialog(), addSetParamDialog(), createCountDialog(), createEmphasisSubmenu(), SCIPincludeConshdlrNonlinear(), SCIPincludeConshdlrSuperindicator(), SCIPincludeDialogDefaultBasic(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), and SCIPincludeObjDialog().
◆ SCIPaddDialogInputLine()
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
- Returns
- SCIP_OKAY is returned if everything worked. otherwise a suitable error code is passed. see SCIP_RETCODE for a complete list of error codes.
- Parameters
-
scip SCIP data structure inputline input line to add
Definition at line 192 of file scip_dialog.c.
References Scip::dialoghdlr, NULL, SCIP_CALL, SCIP_OKAY, and SCIPdialoghdlrAddInputLine().
Referenced by processArguments(), and SCIPprocessShellArguments().
◆ SCIPaddDialogHistoryLine()
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
- Returns
- SCIP_OKAY is returned if everything worked. otherwise a suitable error code is passed. see SCIP_RETCODE for a complete list of error codes.
- Parameters
-
scip SCIP data structure inputline input line to add
Definition at line 209 of file scip_dialog.c.
References Scip::dialoghdlr, FALSE, NULL, SCIP_CALL, SCIP_OKAY, and SCIPdialoghdlrAddHistory().
◆ SCIPstartInteraction()
SCIP_RETCODE SCIPstartInteraction | ( | SCIP * | scip | ) |
starts interactive mode of SCIP by executing the root dialog
- Returns
- SCIP_OKAY is returned if everything worked. otherwise a suitable error code is passed. see SCIP_RETCODE for a complete list of error codes.
- Precondition
- This method can be called if
scip
is in one of the following stages:
- Postcondition
- After calling this method SCIP reaches one of the following stages depending on if and when the interactive shell was closed:
- SCIP_STAGE_PROBLEM if the interactive shell was closed after the problem was created
- SCIP_STAGE_TRANSFORMED if the interactive shell was closed after the problem was transformed
- SCIP_STAGE_PRESOLVING if the interactive shell was closed during presolving
- SCIP_STAGE_PRESOLVED if the interactive shell was closed after presolve
- SCIP_STAGE_SOLVING if the interactive shell was closed during the tree search
- SCIP_STAGE_SOLVED if the interactive shell was closed after the problem was solved
- SCIP_STAGE_FREE if the interactive shell was closed after the problem was freed
See SCIP_STAGE for a complete list of all possible solving stages.
- Parameters
-
scip SCIP data structure
Definition at line 242 of file scip_dialog.c.
References Scip::dialoghdlr, FALSE, SCIP_CALL, SCIP_OKAY, SCIPcheckStage(), SCIPdialoghdlrExec(), SCIPincludeDialogDefaultFix(), SCIPincludeDialogDefaultSet(), Scip::set, and TRUE.
Referenced by interactive(), processArguments(), and SCIPprocessShellArguments().