dialog.h File Reference

Detailed Description

internal methods for user interface dialog

Author

Tobias Achterberg

Definition in file dialog.h.

#include "scip/def.h"
#include "scip/type_retcode.h"
#include "scip/type_set.h"
#include "scip/type_dialog.h"
#include "scip/pub_dialog.h"

Go to the source code of this file.

Functions
SCIP_RETCODE	SCIPdialogCopyInclude (SCIP_DIALOG *dialog, SCIP_SET *set)
SCIP_RETCODE	SCIPdialoghdlrCreate (SCIP_SET *set, SCIP_DIALOGHDLR **dialoghdlr)
SCIP_RETCODE	SCIPdialoghdlrFree (SCIP *scip, SCIP_DIALOGHDLR **dialoghdlr)
SCIP_RETCODE	SCIPdialoghdlrExec (SCIP_DIALOGHDLR *dialoghdlr, SCIP_SET *set)
SCIP_RETCODE	SCIPdialoghdlrSetRoot (SCIP *scip, SCIP_DIALOGHDLR *dialoghdlr, SCIP_DIALOG *dialog)
SCIP_RETCODE	SCIPdialogCreate (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)
void	SCIPdialogCapture (SCIP_DIALOG *dialog)
SCIP_RETCODE	SCIPdialogRelease (SCIP *scip, SCIP_DIALOG **dialog)
SCIP_RETCODE	SCIPdialogExec (SCIP_DIALOG *dialog, SCIP_SET *set, SCIP_DIALOGHDLR *dialoghdlr, SCIP_DIALOG **nextdialog)
SCIP_RETCODE	SCIPdialogAddEntry (SCIP_DIALOG *dialog, SCIP_SET *set, SCIP_DIALOG *subdialog)

Function Documentation

SCIPdialogCopyInclude()

SCIP_RETCODE SCIPdialogCopyInclude	(	SCIP_DIALOG *	dialog,
		SCIP_SET *	set
	)

copies the given dialog to a new scip

Parameters

dialog	dialog
set	SCIP_SET of SCIP to copy to

Definition at line 310 of file dialog.c.

References NULL, SCIP_CALL, SCIP_OKAY, SCIPdialogGetName(), and SCIPsetDebugMsg.

Referenced by SCIPsetCopyPlugins().

SCIPdialoghdlrCreate()

SCIP_RETCODE SCIPdialoghdlrCreate	(	SCIP_SET *	set,
		SCIP_DIALOGHDLR **	dialoghdlr
	)

creates a dialog handler

Parameters

set	global SCIP settings
dialoghdlr	pointer to store dialog handler

Definition at line 328 of file dialog.c.

References BMSallocMemory, BMSallocMemoryArray, NULL, SCIP_ALLOC, SCIP_CALL, SCIP_MAXSTRLEN, SCIP_OKAY, SCIPdialoghdlrClearBuffer(), SCIPsetIncludeExternalCode(), and SCIPsnprintf().

Referenced by SCIPcreate().

SCIPdialoghdlrFree()

SCIP_RETCODE SCIPdialoghdlrFree	(	SCIP *	scip,
		SCIP_DIALOGHDLR **	dialoghdlr
	)

frees a dialog handler and it's dialog tree

Parameters

scip	SCIP data structure
dialoghdlr	pointer to dialog handler

Definition at line 358 of file dialog.c.

References BMSfreeMemory, BMSfreeMemoryArray, linelistFreeAll(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPdialoghdlrSetRoot().

Referenced by SCIPfree().

SCIPdialoghdlrExec()

SCIP_RETCODE SCIPdialoghdlrExec	(	SCIP_DIALOGHDLR *	dialoghdlr,
		SCIP_SET *	set
	)

executes the root dialog of the dialog handler

Parameters

dialoghdlr	dialog handler
set	global SCIP settings

Definition at line 374 of file dialog.c.

References SCIP_Dialoghdlr::buffer, SCIP_Dialoghdlr::bufferpos, NULL, SCIP_Dialoghdlr::rootdialog, SCIP_CALL, SCIP_OKAY, SCIPdialogExec(), and SCIPdialoghdlrClearBuffer().

Referenced by SCIPstartInteraction().

SCIPdialoghdlrSetRoot()

SCIP_RETCODE SCIPdialoghdlrSetRoot	(	SCIP *	scip,
		SCIP_DIALOGHDLR *	dialoghdlr,
		SCIP_DIALOG *	dialog
	)

makes given dialog the root dialog of dialog handler; captures dialog and releases former root dialog

Parameters

scip	SCIP data structure
dialoghdlr	dialog handler
dialog	dialog to be the root

Definition at line 402 of file dialog.c.

References NULL, SCIP_Dialoghdlr::rootdialog, SCIP_CALL, SCIP_OKAY, SCIPdialogCapture(), and SCIPdialogRelease().

Referenced by SCIPdialoghdlrFree(), and SCIPsetRootDialog().

SCIPdialogCreate()

SCIP_RETCODE SCIPdialogCreate	(	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 captures a user interface dialog

Parameters

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 sub-menu?
dialogdata	user defined dialog data

Definition at line 815 of file dialog.c.

References BMSallocMemory, BMSduplicateMemoryArray, BMSfreeMemory, BMSfreeMemoryArrayNull, NULL, SCIP_ALLOC, SCIP_ALLOC_TERMINATE, SCIP_OKAY, and SCIPdialogCapture().

Referenced by SCIPincludeDialog().

SCIPdialogCapture()

void SCIPdialogCapture

(

SCIP_DIALOG *

dialog

)

captures a dialog

Parameters

dialog

dialog

Definition at line 903 of file dialog.c.

References NULL, and SCIP_Dialog::nuses.

Referenced by SCIPcaptureDialog(), SCIPdialogAddEntry(), SCIPdialogCreate(), and SCIPdialoghdlrSetRoot().

SCIPdialogRelease()

SCIP_RETCODE SCIPdialogRelease	(	SCIP *	scip,
		SCIP_DIALOG **	dialog
	)

releases a dialog

Parameters

scip	SCIP data structure
dialog	pointer to dialog

Definition at line 913 of file dialog.c.

References dialogFree(), NULL, SCIP_CALL, and SCIP_OKAY.

Referenced by dialogFree(), SCIPdialoghdlrSetRoot(), and SCIPreleaseDialog().

SCIPdialogExec()

SCIP_RETCODE SCIPdialogExec	(	SCIP_DIALOG *	dialog,
		SCIP_SET *	set,
		SCIP_DIALOGHDLR *	dialoghdlr,
		SCIP_DIALOG **	nextdialog
	)

executes dialog

Parameters

dialog	dialog
set	global SCIP settings
dialoghdlr	dialog handler
nextdialog	pointer to store the next dialog to process

Definition at line 930 of file dialog.c.

References NULL, SCIP_CALL, and SCIP_OKAY.

Referenced by SCIPdialoghdlrExec().

SCIPdialogAddEntry()

SCIP_RETCODE SCIPdialogAddEntry	(	SCIP_DIALOG *	dialog,
		SCIP_SET *	set,
		SCIP_DIALOG *	subdialog
	)

adds a sub-dialog to the given dialog as menu entry and captures the sub-dialog

Parameters

dialog	dialog
set	global SCIP settings
subdialog	sub-dialog to add as menu entry in dialog

Definition at line 955 of file dialog.c.

References ensureSubdialogMem(), SCIP_Dialog::nsubdialogs, NULL, SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPdialogCapture(), SCIPdialogGetName(), SCIPdialogHasEntry(), SCIPerrorMessage, SCIPsortedvecInsertPtr(), and SCIP_Dialog::subdialogs.

Referenced by SCIPaddDialogEntry().