add function to get scilab version as string and revision
[scilab.git] / scilab / modules / core / includes / getversion.h
1 /*
2 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3 * Copyright (C) 2010 - DIGITEO - Allan CORNET
4 *
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  *
7  * This file is hereby licensed under the terms of the GNU GPL v2.0,
8  * pursuant to article 5.3.4 of the CeCILL v.2.1.
9  * This file was originally licensed under the terms of the CeCILL v2.1,
10  * and continues to be available under such terms.
11  * For more information, see the COPYING file which you should have received
12  * along with this program.
13 *
14 */
15 /*--------------------------------------------------------------------------*/
16 #ifndef __GETVERSION_H__
17 #define __GETVERSION_H__
18
19 #include <wchar.h>
20 #include "BOOL.h"
21
22 /**
23 * get Scilab Version as a int array
24 * @param[out] size of returned array
25 * @return int array ver
26 * ver[0] Major version
27 * ver[1] Minor version
28 * ver[2] Maintenance version
29 * ver[3] timestamp
30 */
31 int *getScilabVersion(int *sizeArrayReturned);
32
33 /**
34 * get Scilab version major number
35 * @return scilab version major
36 */
37 int getScilabVersionMajor();
38
39 /**
40 * get Scilab version minor number
41 * @return scilab version minor
42 */
43 int getScilabVersionMinor();
44
45 /**
46 * get Scilab version maintenance number
47 * @return scilab version maintenance
48 */
49 int getScilabVersionMaintenance();
50
51 /**
52 * get Scilab version timestamp number
53 * @return scilab version timestamp
54 */
55 int getScilabVersionTimestamp();
56
57 /**
58 * get Scilab version revision
59 * @return scilab version revision
60 */
61 char* getScilabVersionRevision();
62
63 /**
64 * get Scilab version number as string
65 * @return scilab version number as string
66 */
67 char* getScilabVersionNumberAsString();
68     /**
69 * get Scilab version as a string
70 * @return scilab version
71 */
72 char* getScilabVersionAsString(void);
73
74 /**
75 * get Scilab version as wide string
76 * @return scilab version
77 */
78 wchar_t* getScilabVersionAsWideString(void);
79
80 /**
81 * get module version as a int array
82 * @param[in] module name
83 * @param[out] size of returned array
84 * @return int array ver
85 * ver[0] Major version
86 * ver[1] Minor version
87 * ver[2] Maintenance version
88 * ver[3] timestamp
89 */
90 int* getModuleVersion(wchar_t* _pwstModule, int *sizeArrayReturned);
91
92 /**
93 * get module version as a string
94 * @param[in] module name
95 * @return scilab version
96 */
97 wchar_t* getModuleVersionInfoAsString(wchar_t* _pwstModule);
98
99 /**
100 * get options used for this version
101 * @param[out]
102 * @return char ** with options used
103 */
104 wchar_t** getScilabVersionOptions(int *sizeArrayReturned);
105
106 /**
107 * get release mode
108 * @return 'release' or 'debug'
109 */
110 wchar_t* getReleaseMode(void);
111
112 /**
113 * get release date
114 * @return date of version
115 */
116 wchar_t* getReleaseDate(void);
117
118 /**
119 * get release time
120 * @return time of version
121 */
122 wchar_t* getReleaseTime(void);
123
124 /**
125 * get compiler used to build scilab
126 * @return 'VC++', 'ICC', 'GCC'
127 */
128 wchar_t* getCompilerUsedToBuildScilab(void);
129
130 /**
131 * get Compiler Architecture
132 * @return 'x86' or 'x64'
133 */
134 wchar_t* getCompilerArchitecture(void);
135
136 /**
137 * with modelica compiler ?
138 * @return TRUE or FALSE
139 */
140 BOOL with_modelica_compiler(void);
141
142 /**
143 * with tcl/tk ?
144 * @return TRUE or FALSE
145 */
146 BOOL with_tk(void);
147
148 #endif /* __GETVERSION_H__ */
149 /*--------------------------------------------------------------------------*/
150