Help generation: add the ability to generate an image from inlined Scilab code
[scilab.git] / scilab / modules / helptools / src / jni / SciDocMain.hxx
1 /* Generated by GIWS (version 2.0.1) with command:
2 giws -e -r -f BuildDocObjectv2.giws.xml
3 */
4 /*
5
6 This is generated code.
7
8 This software is a computer program whose purpose is to hide the complexity
9 of accessing Java objects/methods from C++ code.
10
11 This software is governed by the CeCILL-B license under French law and
12 abiding by the rules of distribution of free software.  You can  use,
13 modify and/ or redistribute the software under the terms of the CeCILL-B
14 license as circulated by CEA, CNRS and INRIA at the following URL
15 "http://www.cecill.info".
16
17 As a counterpart to the access to the source code and  rights to copy,
18 modify and redistribute granted by the license, users are provided only
19 with a limited warranty  and the software's author,  the holder of the
20 economic rights,  and the successive licensors  have only  limited
21 liability.
22
23 In this respect, the user's attention is drawn to the risks associated
24 with loading,  using,  modifying and/or developing or reproducing the
25 software by the user in light of its specific status of free software,
26 that may mean  that it is complicated to manipulate,  and  that  also
27 therefore means  that it is reserved for developers  and  experienced
28 professionals having in-depth computer knowledge. Users are therefore
29 encouraged to load and test the software's suitability as regards their
30 requirements in conditions enabling the security of their systems and/or
31 data to be ensured and,  more generally, to use and operate it in the
32 same conditions as regards security.
33
34 The fact that you are presently reading this means that you have had
35 knowledge of the CeCILL-B license and that you accept its terms.
36 */
37
38
39 #ifndef __ORG_SCILAB_MODULES_HELPTOOLS_SCIDOCMAIN__
40 #define __ORG_SCILAB_MODULES_HELPTOOLS_SCIDOCMAIN__
41 #include <iostream>
42 #include <string>
43 #include <string.h>
44 #include <stdlib.h>
45 #include <jni.h>
46
47 #include "GiwsException.hxx"
48
49 #if !defined(byte) | !defined(_MSC_VER) /* Defined anyway with Visual */
50 typedef signed char byte;
51 #else
52 #pragma message("Byte has been redefined elsewhere. Some problems can happen")
53 #endif
54
55
56 #ifndef GIWSEXPORT
57 # if defined(_MSC_VER) || defined(__WIN32__) || defined(__CYGWIN__)
58 #   if defined(STATIC_LINKED)
59 #     define GIWSEXPORT
60 #   else
61 #     define GIWSEXPORT __declspec(dllexport)
62 #   endif
63 # else
64 #   if __GNUC__ >= 4
65 #     define GIWSEXPORT __attribute__ ((visibility ("default")))
66 #   else
67 #     define GIWSEXPORT
68 #   endif
69 # endif
70 #endif
71
72 namespace org_scilab_modules_helptools
73 {
74 class GIWSEXPORT SciDocMain
75 {
76
77 private:
78     JavaVM * jvm;
79
80 protected:
81     jmethodID voidbuildDocumentationjstringjava_lang_StringID; // cache method id
82     jmethodID jbooleansetOutputDirectoryjstringjava_lang_StringID; // cache method id
83     jmethodID voidsetWorkingLanguagejstringjava_lang_StringID; // cache method id
84     jmethodID voidsetExportFormatjstringjava_lang_StringID; // cache method id
85     jmethodID voidsetIsToolboxjbooleanbooleanID; // cache method id
86     jmethodID jstringprocessjstringjava_lang_Stringjstringjava_lang_StringID; // cache method id
87     jmethodID voidgenerateJavahelpjstringjava_lang_Stringjstringjava_lang_StringID; // cache method id
88
89
90
91     jobject instance;
92     jclass instanceClass; // cache class
93
94
95     // Caching (if any)
96
97
98     /**
99     * Get the environment matching to the current thread.
100     */
101     virtual JNIEnv * getCurrentEnv();
102
103 public:
104     // Constructor
105     /**
106     * Create a wrapping of the object from a JNIEnv.
107     * It will call the default constructor
108     * @param JEnv_ the Java Env
109     */
110     SciDocMain(JavaVM * jvm_);
111
112     /**
113     * Create a wrapping of an already existing object from a JNIEnv.
114     * The object must have already been instantiated
115     * @param JEnv_ the Java Env
116     * @param JObj the object
117     */
118     SciDocMain(JavaVM * jvm_, jobject JObj);
119
120
121     /**
122     * This is a fake constructor to avoid the constructor
123     * chaining when dealing with extended giws classes
124     */
125 #ifdef FAKEGIWSDATATYPE
126     SciDocMain(fakeGiwsDataType::fakeGiwsDataType /* unused */) {}
127 #endif
128
129     // Destructor
130     ~SciDocMain();
131
132     // Generic method
133     // Synchronization methods
134     /**
135     * Enter monitor associated with the object.
136     * Equivalent of creating a "synchronized(obj)" scope in Java.
137     */
138     void synchronize();
139
140     /**
141     * Exit monitor associated with the object.
142     * Equivalent of ending a "synchronized(obj)" scope.
143     */
144     void endSynchronize();
145
146     // Methods
147     void buildDocumentation(char const* type);
148
149     bool setOutputDirectory(char const* directory);
150
151     void setWorkingLanguage(char const* language);
152
153     void setExportFormat(char const* format);
154
155     void setIsToolbox(bool isToolbox);
156
157     char* process(char const* sourceDoc, char const* styleSheet);
158
159     static void generateJavahelp(JavaVM * jvm_, char const* outputDir, char const* language);
160
161
162     /**
163     * Get class name to use for static methods
164     * @return class name to use for static methods
165     */
166
167     static const std::string className()
168     {
169         return "org/scilab/modules/helptools/SciDocMain";
170     }
171
172 };
173
174
175 }
176 #endif