6d428882c4f7a471e4e73d12ff934dc1fee26e86
[scilab.git] / scilab / modules / history_manager / src / java / org / scilab / modules / history_manager / HistoryManagement.java
1 /* ----------------------------------------------------------------------------
2  * This file was automatically generated by SWIG (http://www.swig.org).
3  * Version 2.0.7
4  *
5  * Do not make changes to this file unless you know what you are doing--modify
6  * the SWIG interface file instead.
7  * ----------------------------------------------------------------------------- */
8
9 package org.scilab.modules.history_manager;
10
11
12  /** 
13    * All Scilab history management used in Java console 
14    * @author Vincent COUVERT
15    * @author Allan CORNET
16    * @copyright INRIA 
17    */
18 public class HistoryManagement {
19
20   /**
21     * Constructor
22     */
23   protected HistoryManagement() {
24     throw new UnsupportedOperationException();
25   }
26   
27     /**
28     * add a line to History manager
29     * @param line a line to add
30     * line isn't added if it is the same as previous (false)
31     * @return true or false
32     */
33 public static boolean appendLineToScilabHistory(String line) {
34     return HistoryManagementJNI.appendLineToScilabHistory(line);
35   }
36
37   
38     /**
39     * append lines to History manager
40     * @param lines array of string
41     * @param numberoflines size of the array of string
42     * @return true or false
43     */
44 public static boolean appendLinesToScilabHistory(String[] lines, int numberoflines) {
45     return HistoryManagementJNI.appendLinesToScilabHistory(lines, numberoflines);
46   }
47
48   
49     /**
50     * Display history
51     */
52 public static void displayScilabHistory() {
53     HistoryManagementJNI.displayScilabHistory();
54   }
55
56   
57     /**
58     * save history in a file
59     * @param filename if NULL saves in default filename
60     * default filename --> SCIHOME/history.scilab
61     * @return true or false
62     */
63 public static boolean writeScilabHistoryToFile(String filename) {
64     return HistoryManagementJNI.writeScilabHistoryToFile(filename);
65   }
66
67   
68     /**
69     * load history from a file
70     * @param filename if NULL load from default filename
71     * default filename --> SCIHOME/history.scilab
72     * @return true or false
73     */
74 public static boolean loadScilabHistoryFromFile(String filename) {
75     return HistoryManagementJNI.loadScilabHistoryFromFile(filename);
76   }
77
78   
79     /**
80     * set filename of history
81     * @param filename of history
82     * @return true or false
83     */
84 public static boolean setFilenameScilabHistory(String filename) {
85     return HistoryManagementJNI.setFilenameScilabHistory(filename);
86   }
87
88   
89     /**
90     * get filename of history
91     * @return a filename
92     */
93 public static String getFilenameScilabHistory() {
94     return HistoryManagementJNI.getFilenameScilabHistory();
95   }
96
97   
98     /**
99     * set default filename of history
100     * @return true or false
101     */
102 public static boolean setDefaultFilenameScilabHistory() {
103     return HistoryManagementJNI.setDefaultFilenameScilabHistory();
104   }
105
106   
107     /**
108     * reset history manager
109     */
110 public static void resetScilabHistory() {
111     HistoryManagementJNI.resetScilabHistory();
112   }
113
114   
115     /**
116     * Get all lines in history
117     * @return an array of strings
118     */
119 public static String[] getAllLinesOfScilabHistory() {
120     return HistoryManagementJNI.getAllLinesOfScilabHistory();
121   }
122
123   
124     /**
125     * Get numbers of lines in history
126     * size of array returned by getAllLinesOfScilabHistory
127     * @return int 
128     */
129 public static int getSizeAllLinesOfScilabHistory() {
130     return HistoryManagementJNI.getSizeAllLinesOfScilabHistory();
131   }
132
133   
134     /**
135     * set new token to search in history
136     * @param token (a string)
137     * @return true or false
138     */
139 public static boolean setSearchedTokenInScilabHistory(String token) {
140     return HistoryManagementJNI.setSearchedTokenInScilabHistory(token);
141   }
142
143   
144     /**
145     * reset search in history
146     * @return true or false
147     */
148 public static boolean resetSearchedTokenInScilabHistory() {
149     return HistoryManagementJNI.resetSearchedTokenInScilabHistory();
150   }
151
152   
153     /**
154     * get token searched in history
155     * @return token (a string)
156     */
157 public static String getSearchedTokenInScilabHistory() {
158     return HistoryManagementJNI.getSearchedTokenInScilabHistory();
159   }
160
161   
162     /**
163     * Get the previous line in Scilab history
164     * @return a line or NULL
165     * after an appendLine iterator go to end
166     */
167 public static String getPreviousLineInScilabHistory() {
168     return HistoryManagementJNI.getPreviousLineInScilabHistory();
169   }
170
171   
172     /**
173     * Get the next line in Scilab history
174     * @return a line or NULL
175     * after an appendLine iterator go to end
176     */
177 public static String getNextLineInScilabHistory() {
178     return HistoryManagementJNI.getNextLineInScilabHistory();
179   }
180
181   
182     /**
183     * Get numbers of lines in history
184     * @return number of lines
185     */
186 public static int getNumberOfLinesInScilabHistory() {
187     return HistoryManagementJNI.getNumberOfLinesInScilabHistory();
188   }
189
190   
191     /**
192     * set consecutive duplicate lines are added
193     * @param doit (true or false)
194     */
195 public static void setSaveConsecutiveDuplicateLinesInScilabHistory(boolean doit) {
196     HistoryManagementJNI.setSaveConsecutiveDuplicateLinesInScilabHistory(doit);
197   }
198
199   
200     /**
201     * indicate if consecutive duplicate lines are added
202     * @return true or false
203     */
204 public static boolean getSaveConsecutiveDuplicateLinesInScilabHistory() {
205     return HistoryManagementJNI.getSaveConsecutiveDuplicateLinesInScilabHistory();
206   }
207
208   
209     /**
210     * Set after how many lines history is saved
211     * @param num number between 0 and Max
212     * default value is 0 (disabled)
213     */
214 public static void setAfterHowManyLinesScilabHistoryIsSaved(int num) {
215     HistoryManagementJNI.setAfterHowManyLinesScilabHistoryIsSaved(num);
216   }
217
218   
219     /**
220     * Get after how many lines history is saved
221     * @return number between 0 and Max
222     * default value is 0 (disabled)
223     */
224 public static int getAfterHowManyLinesScilabHistoryIsSaved() {
225     return HistoryManagementJNI.getAfterHowManyLinesScilabHistoryIsSaved();
226   }
227
228   
229     /**
230     * Get the Nth Line in history
231     * @param N the number of the line to get
232     * @return the Nth Line
233     */
234 public static String getNthLineInScilabHistory(int N) {
235     return HistoryManagementJNI.getNthLineInScilabHistory(N);
236   }
237
238   
239     /**
240     * delete the Nth Line in history
241     * @param N the number of the line to delete
242     * @return true or false
243     */
244 public static boolean deleteNthLineScilabHistory(int N) {
245     return HistoryManagementJNI.deleteNthLineScilabHistory(N);
246   }
247
248   
249     /**
250     * get number of lines of history
251     * @return a number >= 0
252     */
253 public static int getSizeScilabHistory() {
254     return HistoryManagementJNI.getSizeScilabHistory();
255   }
256
257   
258     /**
259     * get history manager state
260     * @return true or false
261     */
262 public static boolean historyIsEnabled() {
263     return HistoryManagementJNI.historyIsEnabled();
264   }
265
266   
267     /**
268     * set the number of max lines
269     * @return true or false
270     */
271 public static boolean setSizeMaxScilabHistory(int nbLinesMax) {
272     return HistoryManagementJNI.setSizeMaxScilabHistory(nbLinesMax);
273   }
274
275   
276     /**
277     * terminate the history manager
278     * @return true or false
279     */
280 public static boolean InitializeHistoryManager() {
281     return HistoryManagementJNI.InitializeHistoryManager();
282   }
283
284   
285     /**
286     * terminate the history manager
287     * @return true or false
288     */
289 public static boolean TerminateHistoryManager() {
290     return HistoryManagementJNI.TerminateHistoryManager();
291   }
292
293 }