1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /*                                                                           */
3 /*                  This file is part of the program and library             */
4 /*         SCIP --- Solving Constraint Integer Programs                      */
5 /*                                                                           */
6 /*    Copyright (C) 2002-2021 Konrad-Zuse-Zentrum                            */
7 /*                            fuer Informationstechnik Berlin                */
8 /*                                                                           */
9 /*  SCIP is distributed under the terms of the ZIB Academic License.         */
10 /*                                                                           */
11 /*  You should have received a copy of the ZIB Academic License              */
12 /*  along with SCIP; see the file COPYING. If not visit scipopt.org.         */
13 /*                                                                           */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file   scipshell.h
17  * @ingroup PUBLICCOREAPI
18  * @brief  SCIP command line interface
19  * @author Tobias Achterberg
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_SCIPSHELL_H__
25 #define __SCIP_SCIPSHELL_H__
26 
27 #include "scip/def.h"
28 #include "scip/type_retcode.h"
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 /** evaluates command line parameters and runs SCIP appropriately in the given SCIP instance */
35 SCIP_EXPORT
36 SCIP_RETCODE SCIPprocessShellArguments(
37    SCIP*                 scip,               /**< SCIP data structure */
38    int                   argc,               /**< number of shell parameters */
39    char**                argv,               /**< array with shell parameters */
40    const char*           defaultsetname      /**< name of default settings file */
41    );
42 
43 /** creates a SCIP instance with default plugins, evaluates command line parameters, runs SCIP appropriately,
44  *  and frees the SCIP instance
45  */
46 SCIP_EXPORT
47 SCIP_RETCODE SCIPrunShell(
48    int                   argc,               /**< number of shell parameters */
49    char**                argv,               /**< array with shell parameters */
50    const char*           defaultsetname      /**< name of default settings file */
51    );
52 
53 #ifdef __cplusplus
54 }
55 #endif
56 
57 #endif
58