summaryrefslogtreecommitdiff
path: root/modules/console/includes/getKey.h
diff options
context:
space:
mode:
Diffstat (limited to 'modules/console/includes/getKey.h')
-rwxr-xr-xmodules/console/includes/getKey.h44
1 files changed, 44 insertions, 0 deletions
diff --git a/modules/console/includes/getKey.h b/modules/console/includes/getKey.h
new file mode 100755
index 000000000..e064e8066
--- /dev/null
+++ b/modules/console/includes/getKey.h
@@ -0,0 +1,44 @@
+/*
+* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+* Copyright (C) 2011 - DIGITEO - Karim Mamode
+*
+* This file must be used under the terms of the CeCILL.
+* This source file is licensed as described in the file COPYING, which
+* you should have received as part of this distribution. The terms
+* are also available at
+* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
+*/
+
+#ifndef GET_KEY_H_
+#define GET_KEY_H_
+
+#define CHECK_TOKEN -1
+#define CONTINUE_COMMAND 0
+#define RESET_TOKEN 0
+#define SEND_COMMAND 1
+#define SEND_MULTI_COMMAND 2
+#define DO_NOT_SEND_COMMAND 3
+
+/**
+ * Wait for user user input and Manage all the command line.
+ * Function is left when the user press enter.
+ * @return command line enter by the user.
+ */
+char *getCmdLine(void);
+
+/**
+ * Set a token to know what to do during command line edition.
+ * @param token to set.
+ * @return token saved.
+ */
+int setTokenInteruptExecution(int token);
+
+/**
+ * Get the token to know if the line must be edited.
+ * @return token saved.
+ */
+int getTokenInteruptExecution();
+
+int getTokenInteruptExecution(void);
+
+#endif /* !GET_KEY_H_ */