Scippy

SCIP

Solving Constraint Integer Programs

pub_dialog.h File Reference

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"

Go to the source code of this file.

Functions

SCIP_DIALOGSCIPdialoghdlrGetRoot (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_DIALOGSCIPdialogGetParent (SCIP_DIALOG *dialog)
 
SCIP_DIALOG ** SCIPdialogGetSubdialogs (SCIP_DIALOG *dialog)
 
int SCIPdialogGetNSubdialogs (SCIP_DIALOG *dialog)
 
SCIP_DIALOGDATASCIPdialogGetData (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
dialoghdlrdialog handler
void SCIPdialoghdlrClearBuffer ( SCIP_DIALOGHDLR dialoghdlr)

clears the input command buffer of the dialog handler

Parameters
dialoghdlrdialog handler
SCIP_Bool SCIPdialoghdlrIsBufferEmpty ( SCIP_DIALOGHDLR dialoghdlr)

returns TRUE iff input command buffer is empty

Parameters
dialoghdlrdialog handler
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
dialoghdlrdialog handler
dialogcurrent dialog
promptprompt to display, or NULL to display the current dialog's path
inputlinepointer to store the complete line in the handler's command buffer
endoffilepointer to store whether the end of the input file was reached
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
dialoghdlrdialog handler
dialogcurrent dialog
promptprompt to display, or NULL to display the current dialog's path
inputwordpointer to store the next word in the handler's command buffer
endoffilepointer to store whether the end of the input file was reached
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
dialoghdlrdialog handler
inputlineinput line to add
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
dialoghdlrdialog handler
dialogcurrent dialog, or NULL
commandcommand string to add to the command history, or NULL
escapecommandshould special characters in command be prefixed by an escape char?
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
dialogdialog
entrynamename of the dialog entry to find
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
dialogdialog
entrynamename of the dialog entry to find
subdialogpointer to store the found dialog entry
SCIP_RETCODE SCIPdialogDisplayMenu ( SCIP_DIALOG dialog,
SCIP scip 
)

displays the dialog's menu

Parameters
dialogdialog
scipSCIP data structure
SCIP_RETCODE SCIPdialogDisplayMenuEntry ( SCIP_DIALOG dialog,
SCIP scip 
)

displays the entry for the dialog in it's parent's menu

Parameters
dialogdialog
scipSCIP data structure
SCIP_RETCODE SCIPdialogDisplayCompletions ( SCIP_DIALOG dialog,
SCIP scip,
const char *  entryname 
)

displays all dialog entries with names starting with the given "entryname"

Parameters
dialogdialog
scipSCIP data structure
entrynamename of the dialog entry to find
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
dialogdialog
sepcharseparation character to insert in path
pathstring buffer to store the path
const char* SCIPdialogGetName ( SCIP_DIALOG dialog)

gets the command name of the dialog

Parameters
dialogdialog
const char* SCIPdialogGetDesc ( SCIP_DIALOG dialog)

gets the description of the dialog

Parameters
dialogdialog
SCIP_Bool SCIPdialogIsSubmenu ( SCIP_DIALOG dialog)

returns whether the dialog is a sub menu

Parameters
dialogdialog
SCIP_DIALOG* SCIPdialogGetParent ( SCIP_DIALOG dialog)

gets the parent dialog of the given dialog

Parameters
dialogdialog
SCIP_DIALOG** SCIPdialogGetSubdialogs ( SCIP_DIALOG dialog)

gets the array of sub-dialogs associated with the given dialog

Parameters
dialogdialog
int SCIPdialogGetNSubdialogs ( SCIP_DIALOG dialog)

gets the number of sub-dialogs associated with the given dialog

Parameters
dialogdialog
SCIP_DIALOGDATA* SCIPdialogGetData ( SCIP_DIALOG dialog)

gets the user defined data associated with the given dialog

Parameters
dialogdialog
void SCIPdialogSetData ( SCIP_DIALOG dialog,
SCIP_DIALOGDATA dialogdata 
)

sets user data of dialog; user has to free old data in advance!

Parameters
dialogdialog
dialogdatanew dialog user data
SCIP_RETCODE SCIPdialogWriteHistory ( const char *  filename)

writes command history to specified filename

Parameters
filenamefile name for (over)writing history