Merge remote-tracking branch 'origin/master' into YaSp
[scilab.git] / scilab / modules / commons / src / jni / ScilabCommons.i
1 /*
2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  * Copyright (C) INRIA - 2010 - Sylvestre Ledru
4  *
5  * This file must be used under the terms of the CeCILL.
6  * This source file is licensed as described in the file COPYING, which
7  * you should have received as part of this distribution.  The terms
8  * are also available at
9  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
10  *
11  */
12
13
14 /* ScilabCommons.i */
15 /**
16  * Windows: swig -java -package org.scilab.modules.commons -outdir ../java/org/scilab/modules/commons/ ScilabCommons.i
17  * Other: Use the option --enable-build-swig to the configure
18 */
19 %module ScilabCommons
20 %{
21 #include "../../../system_env/includes/sci_home.h"
22 #include "../../../system_env/includes/sci_tmpdir.h"
23 #include "../../../fileio/includes/createtempfilename.h"
24 #include "../../../localization/includes/setgetlanguage.h"
25 #include "../../../core/includes/getversion.h"
26 #include "../../../core/includes/setieee.h"
27 #include "../../../core/includes/setformat.h"
28 %}
29
30 /* JavaDoc for ScilabCommonsJNI class */
31 %pragma(java) jniclassclassmodifiers=%{
32 /* It is generated code. Disable checkstyle */
33 //CHECKSTYLE:OFF
34  /**
35    * Some commons values from Scilab engine to Java
36    * @author Sylvestre LEDRU
37    * @copyright DIGITEO 2010
38    */
39 public class%}
40
41 /* Constructor for ScilabCommonsJNI class */
42 %pragma(java) jniclasscode="
43   /**
44     * Constructor
45     */
46   protected ScilabCommonsJNI() {
47     throw new UnsupportedOperationException();
48   }";
49
50 /* static load of library */
51 %pragma(java) jniclasscode=%{
52   static {
53     try {
54         System.loadLibrary("scicommons");
55     } catch (SecurityException e) {
56         System.err.println("A security manager exists and does not allow the loading of the specified dynamic library.");
57         System.err.println(e.getLocalizedMessage());
58         System.exit(-1);
59     } catch (UnsatisfiedLinkError e)    {
60            System.err.println("The native library scicommons does not exist or cannot be found.");
61         if (System.getenv("CONTINUE_ON_JNI_ERROR") == null) {
62            System.err.println(e.getLocalizedMessage());
63            System.err.println("Current java.library.path is : "+System.getProperty("java.library.path"));
64            System.exit(-1);
65         }else{
66            System.err.println("Continuing anyway because of CONTINUE_ON_JNI_ERROR");
67         }
68     }
69   }
70 %}
71
72
73 /* JavaDoc for ScilabCommons class */
74 %pragma(java) moduleclassmodifiers="
75  /**
76    * Some commons values from Scilab engine to Java
77    * @author Sylvestre LEDRU
78    * @copyright DIGITEO 2010
79    */
80 public class";
81
82 /* Constructor for ScilabCommons class */
83 %pragma(java) modulecode="
84  /**
85    * Constructor
86    */
87  protected ScilabCommons() {
88     throw new UnsupportedOperationException();
89  }";
90
91 /* JavaDoc */
92 %javamethodmodifiers getSCIHOME() "
93  /**
94    * Get SCIHOME variable from Scilab
95    * @return SCIHOME value
96    */
97 public";
98 char* getSCIHOME();
99
100
101 /* JavaDoc */
102 %javamethodmodifiers getTMPDIR() "
103  /**
104    * returns TMPDIR directory value
105    * @return TMPDIR value
106    */
107 public";
108 char *getTMPDIR(void);
109
110
111 /* JavaDoc */
112 %javamethodmodifiers getScilabLanguage() "
113  /**
114    * returns Scilab current language
115    * @return language
116    */
117 public";
118 char *getlanguage(void);
119
120
121 /* JavaDoc */
122 %javamethodmodifiers createTempFileName() "
123  /**
124   * Create file with unique file name in TMPDIR
125   * TMPDIR/PREFIX[XXXXXXX]
126   * @param prefix the file prefix
127   * @param bShortFormat set 1 for a 8.5 filename, 0 otherwise
128   * @return a unique filename
129   */
130 public";
131 char *createtempfilename(const char* prefix, int bShortFormat);
132
133 /* JavaDoc */
134 %javamethodmodifiers getScilabIeeeMode() "
135  /**
136    * returns the Scilab ieee mode
137    * @return ieee mode
138    */
139 public";
140 int getieee(void);
141
142 /* JavaDoc */
143 %javamethodmodifiers setScilabIeeeMode(int) "
144  /**
145    * Set the Scilab ieee mode
146    */
147 public";
148 void setieee(int);
149
150 /* JavaDoc */
151 %javamethodmodifiers setformat(const char *, int) "
152  /**
153    * Set the Scilab ieee mode
154    */
155 public";
156 void setformat(const char * format, int width);
157
158 /* JavaDoc */
159 %javamethodmodifiers getformat() "
160  /**
161    * returns the Scilab format (\"v\" or \"e\")
162    * @return format
163    */
164 public";
165 char * getformat();
166
167 /* JavaDoc */
168 %javamethodmodifiers getformatwidth() "
169  /**
170    * returns the Scilab format width
171    * @return format
172    */
173 public";
174 int getformatwidth();
175
176 /* JavaDoc */
177 %javamethodmodifiers getScilabVersionMajor() "
178  /**
179    * returns the Scilab version major number
180    * @return version major
181    */
182 public";
183 int getScilabVersionMajor();
184
185 /* JavaDoc */
186 %javamethodmodifiers getScilabVersionMinor() "
187  /**
188    * returns the Scilab version minor number
189    * @return version minor
190    */
191 public";
192 int getScilabVersionMinor();
193
194 /* JavaDoc */
195 %javamethodmodifiers getScilabVersionMaintenance() "
196  /**
197    * returns the Scilab version maintenance number
198    * @return version maintenance
199    */
200 public";
201 int getScilabVersionMaintenance();
202
203 /* JavaDoc */
204 %javamethodmodifiers getScilabVersionTimestamp() "
205  /**
206    * returns the Scilab version timestamp number
207    * @return version timestamp
208    */
209 public";
210 int getScilabVersionTimestamp();
211
212 /* JavaDoc */
213 %javamethodmodifiers getScilabVersionAsString() "
214  /**
215    * returns the Scilab version as string
216    * @return version Scilab version as a string
217    */
218 public";
219 char* getScilabVersionAsString();