1    	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2    	/*                                                                           */
3    	/*                  This file is part of the program and library             */
4    	/*         SCIP --- Solving Constraint Integer Programs                      */
5    	/*                                                                           */
6    	/*  Copyright (c) 2002-2023 Zuse Institute Berlin (ZIB)                      */
7    	/*                                                                           */
8    	/*  Licensed under the Apache License, Version 2.0 (the "License");          */
9    	/*  you may not use this file except in compliance with the License.         */
10   	/*  You may obtain a copy of the License at                                  */
11   	/*                                                                           */
12   	/*      http://www.apache.org/licenses/LICENSE-2.0                           */
13   	/*                                                                           */
14   	/*  Unless required by applicable law or agreed to in writing, software      */
15   	/*  distributed under the License is distributed on an "AS IS" BASIS,        */
16   	/*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17   	/*  See the License for the specific language governing permissions and      */
18   	/*  limitations under the License.                                           */
19   	/*                                                                           */
20   	/*  You should have received a copy of the Apache-2.0 license                */
21   	/*  along with SCIP; see the file LICENSE. If not visit scipopt.org.         */
22   	/*                                                                           */
23   	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24   	
25   	/**@file   struct_dialog.h
26   	 * @ingroup INTERNALAPI
27   	 * @brief  data structures for user interface dialog
28   	 * @author Tobias Achterberg
29   	 */
30   	
31   	/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32   	
33   	#ifndef __SCIP_STRUCT_DIALOG_H__
34   	#define __SCIP_STRUCT_DIALOG_H__
35   	
36   	
37   	#include "scip/def.h"
38   	#include "scip/type_dialog.h"
39   	
40   	#ifdef __cplusplus
41   	extern "C" {
42   	#endif
43   	
44   	/** user interface dialog */
45   	struct SCIP_Dialog
46   	{
47   	   SCIP_DECL_DIALOGCOPY  ((*dialogcopy));    /**< copy method of dialog or NULL if you don't want to copy your plugin into sub-SCIPs */
48   	   SCIP_DECL_DIALOGEXEC  ((*dialogexec));    /**< execution method of dialog */
49   	   SCIP_DECL_DIALOGDESC  ((*dialogdesc));    /**< description output method of dialog, or NULL */
50   	   SCIP_DECL_DIALOGFREE  ((*dialogfree));    /**< destructor of dialog to free user data, or NULL */
51   	   char*                 name;               /**< name of dialog: command name appearing in parent's dialog menu */
52   	   char*                 desc;               /**< description of dialog used if description output method is NULL */
53   	   SCIP_DIALOG*          parent;             /**< parent dialog of dialog */
54   	   SCIP_DIALOG**         subdialogs;         /**< sub dialogs of dialog */
55   	   SCIP_DIALOGDATA*      dialogdata;         /**< user defined dialog data */
56   	   int                   nsubdialogs;        /**< number of sub dialogs */
57   	   int                   subdialogssize;     /**< size of subdialogs array */
58   	   int                   nuses;              /**< number of times, the dialog is used */
59   	   SCIP_Bool             issubmenu;          /**< is the dialog a submenu? */
60   	};
61   	
62   	/** linked list of single input lines */
63   	struct SCIP_Linelist
64   	{
65   	   char*                 inputline;          /**< single line of input */
66   	   SCIP_LINELIST*        nextline;           /**< next input line */
67   	};
68   	
69   	/** dialog handler */
70   	struct SCIP_Dialoghdlr
71   	{
72   	   SCIP_DIALOG*          rootdialog;         /**< main (root) dialog */
73   	   SCIP_LINELIST*        inputlist;          /**< list of input lines that are processed before stdin inputs */
74   	   SCIP_LINELIST**       inputlistptr;       /**< pointer to the ending nextline pointer of the list (which points to 0) */
75   	   char*                 buffer;             /**< command buffer */
76   	   int                   buffersize;         /**< size of command buffer */
77   	   int                   bufferpos;          /**< position of first unprocessed character in buffer */
78   	   int                   nprotectedhistelems;/**< number of history entries protected from cleaning up */
79   	};
80   	
81   	#ifdef __cplusplus
82   	}
83   	#endif
84   	
85   	#endif
86