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