Fix some easy to fix warnings
[scilab.git] / scilab / modules / core / includes / storeCommand.h
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) 2007-2008 - INRIA
4  * Copyright (C) 2008-2008 - Bruno JOFRET
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  */
16
17 #ifndef __STORECOMMAND_H__
18 #define __STORECOMMAND_H__
19
20 enum command_origin_t
21 {
22     NONE,
23     CONSOLE, // command from console
24     TCLSCI   // command from tclsci using ScilabEval interpreter
25 };
26
27 /**
28  * Store a non-prioritary and interruptible command
29  *
30  * @param command           : command wich will be stored
31  * @param piInterruptible   : 1 if it is a interruptible command
32  * @param piPrioritary      : 1 if it is a prioritary command
33  * @param iCmdorigin        : origine of the command
34  * @return <ReturnValue>
35  */
36 int StoreCommandWithFlags(const char* command, int iPrioritary, int iInterruptible, enum command_origin_t iCmdorigin);
37
38 /**
39  * Store a non-prioritary and interruptible command
40  *
41  * @param command : the command
42  * @return <ReturnValue>
43  */
44 int StoreCommand(const char *command);
45
46 /**
47  * Store a prioritary and interruptible command
48  *
49  * @param command : the command
50  * @return <ReturnValue>
51  */
52
53 int StoreConsoleCommand(const char *command, int iWaitFor);
54 /**
55  * Store a prioritary and non-interruptible command
56  *
57  * @param command : the command
58  * @return <ReturnValue>
59  */
60 int StorePrioritaryCommand(const char *command);
61
62 /**
63  * Get the next command to execute
64  *
65  * @param command           : command wich will be executed
66  * @param piInterruptible   : 1 if it is a interruptible command
67  * @param piPrioritary      : 1 if it is a prioritary command
68  * @param iCmdorigin        : origine of the command
69  * @return <ReturnValue>    : 0 if command queue is empty
70  */
71 int GetCommand(char** command, int* piPrioritary, int* piInterruptible, enum command_origin_t* iCmdorigin);
72
73 /**
74 * check if command queue is empty
75 * @return 1 if empty , 0 is not empty
76 */
77 int isEmptyCommandQueue(void);
78
79 /*
80  * Checks if there's something on the
81  * commandQueue
82  * @return
83  */
84 int ismenu(void);
85
86
87 #endif /* __STORECOMMAND_H__ */