Command history: Save in file before each execution to avoid to lose it in case of...
[scilab.git] / scilab / modules / history_manager / includes / HistoryManager.h
index 076b427..6b610f9 100644 (file)
@@ -3,11 +3,14 @@
 * Copyright (C) 2007-2008 - INRIA - Allan CORNET
 * Copyright (C) 2010 - DIGITEO - Allan CORNET
 *
-* 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-en.txt
+ * Copyright (C) 2012 - 2016 - Scilab Enterprises
+ *
+ * This file is hereby licensed under the terms of the GNU GPL v2.0,
+ * pursuant to article 5.3.4 of the CeCILL v.2.1.
+ * This file was originally licensed under the terms of the CeCILL v2.1,
+ * and continues to be available under such terms.
+ * For more information, see the COPYING file which you should have received
+ * along with this program.
 *
 */
 
@@ -33,7 +36,7 @@ HISTORY_MANAGER_IMPEXP BOOL historyIsEnabled(void);
 * @param size of the array of string
 * @return TRUE or FALSE
 */
-HISTORY_MANAGER_IMPEXP BOOL appendLinesToScilabHistory(char** _pstLines, int _iLines);
+HISTORY_MANAGER_IMPEXP BOOL appendLinesToScilabHistory(char **lines_, int numberoflines);
 // Note it is lines_ because line is a keyword for term stuff
 
 /**
@@ -42,7 +45,7 @@ HISTORY_MANAGER_IMPEXP BOOL appendLinesToScilabHistory(char** _pstLines, int _iL
 * line isn't added if it is the same as previous (FALSE)
 * @return TRUE or FALSE
 */
-HISTORY_MANAGER_IMPEXP BOOL appendLineToScilabHistory(char* _pstLine);
+HISTORY_MANAGER_IMPEXP BOOL appendLineToScilabHistory(char *line);
 
 /**
 * Display history
@@ -52,31 +55,35 @@ HISTORY_MANAGER_IMPEXP void displayScilabHistory(void);
 /**
 * save history in a file
 * @param a filename if NULL saves in default filename
-* default filename --> SCIHOME/history.scilab
 * @return TRUE or FALSE
 */
-HISTORY_MANAGER_IMPEXP BOOL writeScilabHistoryToFile(char* _pstFilename);
+HISTORY_MANAGER_IMPEXP BOOL writeScilabHistoryToFile(char* filename);
+
+/**
+* save history
+* @return TRUE or FALSE
+*/
+HISTORY_MANAGER_IMPEXP BOOL saveScilabHistoryToFile();
 
 /**
 * load history from a file
 * @param a filename if NULL load from default filename
-* default filename --> SCIHOME/history.scilab
 * @return TRUE or FALSE
 */
-HISTORY_MANAGER_IMPEXP BOOL loadScilabHistoryFromFile(char* _pstFilename);
+HISTORY_MANAGER_IMPEXP BOOL loadScilabHistoryFromFile(char *filename);
 
 /**
 * set filename of history
 * @param filename of history
 * @return TRUE or FALSE
 */
-HISTORY_MANAGER_IMPEXP BOOL setFilenameScilabHistory(char* _pstFilename);
+HISTORY_MANAGER_IMPEXP BOOL setFilenameScilabHistory(char *filename);
 
 /**
 * get filename of history
 * @return a filename
 */
-HISTORY_MANAGER_IMPEXP char* getFilenameScilabHistory(void);
+HISTORY_MANAGER_IMPEXP char *getFilenameScilabHistory(void);
 
 /**
 * set default filename of history
@@ -97,9 +104,9 @@ HISTORY_MANAGER_IMPEXP BOOL resetScilabHistory(void);
 
 /**
 * Get all lines in history
-* @return a array of string
+* @return an array of string
 */
-HISTORY_MANAGER_IMPEXP char** getAllLinesOfScilabHistory(void);
+HISTORY_MANAGER_IMPEXP char **getAllLinesOfScilabHistory(void);
 
 /**
 * Get numbers of lines in history
@@ -113,7 +120,7 @@ HISTORY_MANAGER_IMPEXP int getSizeAllLinesOfScilabHistory(void);
 * @param token (a string)
 * @return TRUE or FALSE
 */
-HISTORY_MANAGER_IMPEXP BOOL setSearchedTokenInScilabHistory(char* _pstToken);
+HISTORY_MANAGER_IMPEXP BOOL setSearchedTokenInScilabHistory(char *token);
 
 /**
 * reset search in history
@@ -125,21 +132,21 @@ HISTORY_MANAGER_IMPEXP BOOL resetSearchedTokenInScilabHistory(void);
 * get token searched in history
 * @return token (a string)
 */
-HISTORY_MANAGER_IMPEXP char* getSearchedTokenInScilabHistory(void);
+HISTORY_MANAGER_IMPEXP char *getSearchedTokenInScilabHistory(void);
 
 /**
 * Get the previous line in Scilab history
 * @return a line or NULL
-* after a appendLine iterator go to end
+* after an appendLine iterator go to end
 */
-HISTORY_MANAGER_IMPEXP char* getPreviousLineInScilabHistory(void);
+HISTORY_MANAGER_IMPEXP char *getPreviousLineInScilabHistory(void);
 
 /**
 * Get the next line in Scilab history
 * @return a line or NULL
-* after a appendLine iterator go to end
+* after an appendLine iterator go to end
 */
-HISTORY_MANAGER_IMPEXP char* getNextLineInScilabHistory(void);
+HISTORY_MANAGER_IMPEXP char *getNextLineInScilabHistory(void);
 
 /**
 * Get numbers of lines in history
@@ -151,7 +158,7 @@ HISTORY_MANAGER_IMPEXP int getNumberOfLinesInScilabHistory(void);
 * set consecutive duplicate lines are added
 * @param doit (TRUE or FALSE)
 */
-HISTORY_MANAGER_IMPEXP void setSaveConsecutiveDuplicateLinesInScilabHistory(BOOL _bAllow);
+HISTORY_MANAGER_IMPEXP void setSaveConsecutiveDuplicateLinesInScilabHistory(BOOL doit);
 
 /**
 * indicate if consecutive duplicate lines are added
@@ -164,7 +171,7 @@ HISTORY_MANAGER_IMPEXP BOOL getSaveConsecutiveDuplicateLinesInScilabHistory(void
 * @param number between 0 and Max
 * default value is 0 (disabled)
 */
-HISTORY_MANAGER_IMPEXP void setAfterHowManyLinesScilabHistoryIsSaved(int _iNum);
+HISTORY_MANAGER_IMPEXP void setAfterHowManyLinesScilabHistoryIsSaved(int num);
 
 /**
 * Get after how many lines history is saved
@@ -178,14 +185,14 @@ HISTORY_MANAGER_IMPEXP int getAfterHowManyLinesScilabHistoryIsSaved(void);
 * @param N
 * @return the Nth Line
 */
-HISTORY_MANAGER_IMPEXP char* getNthLineInScilabHistory(int _iLine);
+HISTORY_MANAGER_IMPEXP char *getNthLineInScilabHistory(int N);
 
 /**
 * delete the Nth Line in history
 * @param N
 * @return TRUE or FALSE
 */
-HISTORY_MANAGER_IMPEXP BOOL deleteNthLineScilabHistory(int _iLine);
+HISTORY_MANAGER_IMPEXP BOOL deleteNthLineScilabHistory(int N);
 
 /**
 * get number of lines of history
@@ -195,12 +202,13 @@ HISTORY_MANAGER_IMPEXP int getSizeScilabHistory(void);
 
 /**
 */
-BOOL setSizeMaxScilabHistory(int _iMaxLines);
+HISTORY_MANAGER_IMPEXP BOOL setSizeMaxScilabHistory(int nbLinesMax);
 
 /**
 */
 int getSizeMaxScilabHistory(void);
 
+
 /*------------------------------------------------------------------------*/
 #ifdef __cplusplus
 }