Documentation/Source/eric5.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService.html

changeset 3591
2f2a4a76dd22
parent 3525
66f4b8646622
equal deleted inserted replaced
3590:5280e37405b8 3591:2f2a4a76dd22
67 </table> 67 </table>
68 <h3>Methods</h3> 68 <h3>Methods</h3>
69 <table> 69 <table>
70 <tr> 70 <tr>
71 <td><a href="#SyntaxCheckService.__init__">SyntaxCheckService</a></td> 71 <td><a href="#SyntaxCheckService.__init__">SyntaxCheckService</a></td>
72 <td>Contructor of SyntaxCheckService.</td> 72 <td>Constructor</td>
73 </tr><tr> 73 </tr><tr>
74 <td><a href="#SyntaxCheckService.__determineLanguage">__determineLanguage</a></td> 74 <td><a href="#SyntaxCheckService.__determineLanguage">__determineLanguage</a></td>
75 <td>Private methode to determine the language of the file.</td> 75 <td>Private methode to determine the language of the file.</td>
76 </tr><tr> 76 </tr><tr>
77 <td><a href="#SyntaxCheckService.addLanguage">addLanguage</a></td> 77 <td><a href="#SyntaxCheckService.addLanguage">addLanguage</a></td>
78 <td>Register the new language to the supported languages.</td> 78 <td>Public method to register a new language to the supported languages.</td>
79 </tr><tr> 79 </tr><tr>
80 <td><a href="#SyntaxCheckService.getExtensions">getExtensions</a></td> 80 <td><a href="#SyntaxCheckService.getExtensions">getExtensions</a></td>
81 <td>Return all supported file extensions for the syntax checker dialog.</td> 81 <td>Public method to return all supported file extensions for the syntax checker dialog.</td>
82 </tr><tr> 82 </tr><tr>
83 <td><a href="#SyntaxCheckService.getLanguages">getLanguages</a></td> 83 <td><a href="#SyntaxCheckService.getLanguages">getLanguages</a></td>
84 <td>Return the supported language names.</td> 84 <td>Public method to return the supported language names.</td>
85 </tr><tr> 85 </tr><tr>
86 <td><a href="#SyntaxCheckService.removeLanguage">removeLanguage</a></td> 86 <td><a href="#SyntaxCheckService.removeLanguage">removeLanguage</a></td>
87 <td>Remove the language from syntax check.</td> 87 <td>Public method to remove the language from syntax check.</td>
88 </tr><tr> 88 </tr><tr>
89 <td><a href="#SyntaxCheckService.syntaxCheck">syntaxCheck</a></td> 89 <td><a href="#SyntaxCheckService.syntaxCheck">syntaxCheck</a></td>
90 <td>Method to prepare to compile one Python source file to Python bytecode and to perform a pyflakes check in another task.</td> 90 <td>Public method to prepare to compile one Python source file to Python bytecode and to perform a pyflakes check.</td>
91 </tr> 91 </tr>
92 </table> 92 </table>
93 <h3>Static Methods</h3> 93 <h3>Static Methods</h3>
94 <table> 94 <table>
95 <tr><td>None</td></tr> 95 <tr><td>None</td></tr>
96 </table> 96 </table>
97 <a NAME="SyntaxCheckService.__init__" ID="SyntaxCheckService.__init__"></a> 97 <a NAME="SyntaxCheckService.__init__" ID="SyntaxCheckService.__init__"></a>
98 <h4>SyntaxCheckService (Constructor)</h4> 98 <h4>SyntaxCheckService (Constructor)</h4>
99 <b>SyntaxCheckService</b>(<i></i>) 99 <b>SyntaxCheckService</b>(<i></i>)
100 <p> 100 <p>
101 Contructor of SyntaxCheckService. 101 Constructor
102 </p><a NAME="SyntaxCheckService.__determineLanguage" ID="SyntaxCheckService.__determineLanguage"></a> 102 </p><a NAME="SyntaxCheckService.__determineLanguage" ID="SyntaxCheckService.__determineLanguage"></a>
103 <h4>SyntaxCheckService.__determineLanguage</h4> 103 <h4>SyntaxCheckService.__determineLanguage</h4>
104 <b>__determineLanguage</b>(<i>filename, source</i>) 104 <b>__determineLanguage</b>(<i>filename, source</i>)
105 <p> 105 <p>
106 Private methode to determine the language of the file. 106 Private methode to determine the language of the file.
119 </dd> 119 </dd>
120 </dl><a NAME="SyntaxCheckService.addLanguage" ID="SyntaxCheckService.addLanguage"></a> 120 </dl><a NAME="SyntaxCheckService.addLanguage" ID="SyntaxCheckService.addLanguage"></a>
121 <h4>SyntaxCheckService.addLanguage</h4> 121 <h4>SyntaxCheckService.addLanguage</h4>
122 <b>addLanguage</b>(<i>lang, env, path, module, getArgs, getExt, callback, onError</i>) 122 <b>addLanguage</b>(<i>lang, env, path, module, getArgs, getExt, callback, onError</i>)
123 <p> 123 <p>
124 Register the new language to the supported languages. 124 Public method to register a new language to the supported languages.
125 </p><dl> 125 </p><dl>
126 <dt><i>lang</i></dt> 126 <dt><i>lang</i></dt>
127 <dd> 127 <dd>
128 new language to check syntax (str) 128 new language to check syntax (str)
129 </dd><dt><i>env</i></dt> 129 </dd><dt><i>env</i></dt>
153 </dd> 153 </dd>
154 </dl><a NAME="SyntaxCheckService.getExtensions" ID="SyntaxCheckService.getExtensions"></a> 154 </dl><a NAME="SyntaxCheckService.getExtensions" ID="SyntaxCheckService.getExtensions"></a>
155 <h4>SyntaxCheckService.getExtensions</h4> 155 <h4>SyntaxCheckService.getExtensions</h4>
156 <b>getExtensions</b>(<i></i>) 156 <b>getExtensions</b>(<i></i>)
157 <p> 157 <p>
158 Return all supported file extensions for the syntax checker dialog. 158 Public method to return all supported file extensions for the
159 syntax checker dialog.
159 </p><dl> 160 </p><dl>
160 <dt>Returns:</dt> 161 <dt>Returns:</dt>
161 <dd> 162 <dd>
162 set of all supported file extensions (set of str) 163 set of all supported file extensions (set of str)
163 </dd> 164 </dd>
164 </dl><a NAME="SyntaxCheckService.getLanguages" ID="SyntaxCheckService.getLanguages"></a> 165 </dl><a NAME="SyntaxCheckService.getLanguages" ID="SyntaxCheckService.getLanguages"></a>
165 <h4>SyntaxCheckService.getLanguages</h4> 166 <h4>SyntaxCheckService.getLanguages</h4>
166 <b>getLanguages</b>(<i></i>) 167 <b>getLanguages</b>(<i></i>)
167 <p> 168 <p>
168 Return the supported language names. 169 Public method to return the supported language names.
169 </p><dl> 170 </p><dl>
170 <dt>Returns:</dt> 171 <dt>Returns:</dt>
171 <dd> 172 <dd>
172 list of languanges supported (list of str) 173 list of languanges supported (list of str)
173 </dd> 174 </dd>
174 </dl><a NAME="SyntaxCheckService.removeLanguage" ID="SyntaxCheckService.removeLanguage"></a> 175 </dl><a NAME="SyntaxCheckService.removeLanguage" ID="SyntaxCheckService.removeLanguage"></a>
175 <h4>SyntaxCheckService.removeLanguage</h4> 176 <h4>SyntaxCheckService.removeLanguage</h4>
176 <b>removeLanguage</b>(<i>lang</i>) 177 <b>removeLanguage</b>(<i>lang</i>)
177 <p> 178 <p>
178 Remove the language from syntax check. 179 Public method to remove the language from syntax check.
179 </p><dl> 180 </p><dl>
180 <dt><i>lang</i></dt> 181 <dt><i>lang</i></dt>
181 <dd> 182 <dd>
182 language to remove (str) 183 language to remove (str)
183 </dd> 184 </dd>
184 </dl><a NAME="SyntaxCheckService.syntaxCheck" ID="SyntaxCheckService.syntaxCheck"></a> 185 </dl><a NAME="SyntaxCheckService.syntaxCheck" ID="SyntaxCheckService.syntaxCheck"></a>
185 <h4>SyntaxCheckService.syntaxCheck</h4> 186 <h4>SyntaxCheckService.syntaxCheck</h4>
186 <b>syntaxCheck</b>(<i>lang, filename, source</i>) 187 <b>syntaxCheck</b>(<i>lang, filename, source</i>)
187 <p> 188 <p>
188 Method to prepare to compile one Python source file to Python bytecode 189 Public method to prepare to compile one Python source file to Python
189 and to perform a pyflakes check in another task. 190 bytecode and to perform a pyflakes check.
190 </p><dl> 191 </p><dl>
191 <dt><i>lang</i></dt> 192 <dt><i>lang</i></dt>
192 <dd> 193 <dd>
193 language of the file or None to determine by internal 194 language of the file or None to determine by internal
194 algorithm (str or None) 195 algorithm (str or None)

eric ide

mercurial