Detailed Description

public methods for user interface dialog

Author: Tobias Achterberg

Definition in file pub_dialog.h.

#include "scip/def.h"
#include "scip/type_retcode.h"
#include "scip/type_scip.h"
#include "scip/type_dialog.h"

Functions
SCIP_DIALOG *	SCIPdialoghdlrGetRoot (SCIP_DIALOGHDLR *dialoghdlr)

void	SCIPdialoghdlrClearBuffer (SCIP_DIALOGHDLR *dialoghdlr)

SCIP_Bool	SCIPdialoghdlrIsBufferEmpty (SCIP_DIALOGHDLR *dialoghdlr)

SCIP_RETCODE	SCIPdialoghdlrGetLine (SCIP_DIALOGHDLR dialoghdlr, SCIP_DIALOG dialog, const char prompt, char inputline, SCIP_Bool endoffile)

SCIP_RETCODE	SCIPdialoghdlrGetWord (SCIP_DIALOGHDLR dialoghdlr, SCIP_DIALOG dialog, const char prompt, char inputword, SCIP_Bool endoffile)

SCIP_RETCODE	SCIPdialoghdlrAddInputLine (SCIP_DIALOGHDLR dialoghdlr, const char inputline)

SCIP_RETCODE	SCIPdialoghdlrAddHistory (SCIP_DIALOGHDLR dialoghdlr, SCIP_DIALOG dialog, const char *command, SCIP_Bool escapecommand)

SCIP_Bool	SCIPdialogHasEntry (SCIP_DIALOG dialog, const char entryname)

int	SCIPdialogFindEntry (SCIP_DIALOG dialog, const char entryname, SCIP_DIALOG **subdialog)

SCIP_RETCODE	SCIPdialogDisplayMenu (SCIP_DIALOG dialog, SCIP scip)

SCIP_RETCODE	SCIPdialogDisplayMenuEntry (SCIP_DIALOG dialog, SCIP scip)

SCIP_RETCODE	SCIPdialogDisplayCompletions (SCIP_DIALOG dialog, SCIP scip, const char *entryname)

void	SCIPdialogGetPath (SCIP_DIALOG dialog, const char sepchar, char path)

const char *	SCIPdialogGetName (SCIP_DIALOG *dialog)

const char *	SCIPdialogGetDesc (SCIP_DIALOG *dialog)

SCIP_Bool	SCIPdialogIsSubmenu (SCIP_DIALOG *dialog)

SCIP_DIALOG *	SCIPdialogGetParent (SCIP_DIALOG *dialog)

SCIP_DIALOG **	SCIPdialogGetSubdialogs (SCIP_DIALOG *dialog)

int	SCIPdialogGetNSubdialogs (SCIP_DIALOG *dialog)

SCIP_DIALOGDATA *	SCIPdialogGetData (SCIP_DIALOG *dialog)

void	SCIPdialogSetData (SCIP_DIALOG dialog, SCIP_DIALOGDATA dialogdata)

SCIP_RETCODE	SCIPdialogWriteHistory (const char *filename)

Function Documentation

SCIP_DIALOG* SCIPdialoghdlrGetRoot ( SCIP_DIALOGHDLR * dialoghdlr )

returns the root dialog of the dialog handler

Parameters

dialoghdlr dialog handler

Definition at line 425 of file dialog.c.

References NULL, and SCIP_Dialoghdlr::rootdialog.

Referenced by dialogExecMenu(), SCIP_DECL_DIALOGEXEC(), SCIPaddDialogEntry(), and SCIPgetRootDialog().

void SCIPdialoghdlrClearBuffer ( SCIP_DIALOGHDLR * dialoghdlr )

clears the input command buffer of the dialog handler

Parameters

dialoghdlr dialog handler

Definition at line 435 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().

SCIP_Bool SCIPdialoghdlrIsBufferEmpty ( SCIP_DIALOGHDLR * dialoghdlr )

returns TRUE iff input command buffer is empty

Parameters

dialoghdlr dialog handler

Definition at line 446 of file dialog.c.

References 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

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 459 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().

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 536 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().

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 687 of file dialog.c.

References BMSallocMemory, BMSduplicateMemoryArray, SCIP_Linelist::inputline, SCIP_Dialoghdlr::inputlistptr, SCIP_Linelist::nextline, NULL, SCIP_ALLOC, 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

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 711 of file dialog.c.

References addHistory(), getHistoryLength(), SCIP_Dialog::name, SCIP_Dialoghdlr::nprotectedhistelems, NULL, SCIP_Dialog::parent, removeHistory(), SCIP_Dialoghdlr::rootdialog, SCIP_Bool, SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPescapeString(), and SCIPsnprintf().

Referenced by 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

Parameters

dialog	dialog
entryname	name of the dialog entry to find

Definition at line 970 of file dialog.c.

References FALSE, NULL, SCIPdialogGetName(), SCIPdialogGetNSubdialogs(), SCIPdialogGetSubdialogs(), and TRUE.

Referenced by addFixParamDialog(), addSetParamDialog(), createCountDialog(), createEmphasisSubmenu(), SCIPdialogAddEntry(), SCIPincludeConshdlrSuperindicator(), SCIPincludeDialogDefault(), 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.

Parameters