/[ascend]/trunk/tcltk98/generic/interface/LibraryProc.h
ViewVC logotype

Contents of /trunk/tcltk98/generic/interface/LibraryProc.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 10 - (show annotations) (download) (as text)
Sat Nov 13 16:40:11 2004 UTC (17 years, 7 months ago) by aw0a
Original Path: trunk/tcltk98/interface/LibraryProc.h
File MIME type: text/x-chdr
File size: 13188 byte(s)
try again to commit moving tcl stuff
1 /*
2 * LibraryProc.h
3 * by Kirk Abbott and Ben Allan
4 * Created: 1/94
5 * Version: $Revision: 1.22 $
6 * Version control file: $RCSfile: LibraryProc.h,v $
7 * Date last modified: $Date: 2003/08/23 18:43:07 $
8 * Last modified by: $Author: ballan $
9 *
10 * This file is part of the ASCEND Tcl/Tk interface
11 *
12 * Copyright 1997, Carnegie Mellon University
13 *
14 * The ASCEND Tcl/Tk interface is free software; you can redistribute
15 * it and/or modify it under the terms of the GNU General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
18 *
19 * The ASCEND Tcl/Tk interface is distributed in hope that it will be
20 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 * General Public License for more details.
23 *
24 * You should have received a copy of the GNU General Public License
25 * along with the program; if not, write to the Free Software Foundation,
26 * Inc., 675 Mass Ave, Cambridge, MA 02139 USA. Check the file named
27 * COPYING. COPYING is found in ../compiler.
28 */
29
30 #ifndef LibraryProc_module_loaded
31 #define LibraryProc_module_loaded
32
33
34 /*
35 * To include this header, you must include the following:
36 * #include <stdio.h>
37 * #include "tcl.h"
38 * #include "interface/LibraryProc.h"
39 */
40
41
42 extern int Asc_FileIDCopy(FILE *, FILE *);
43 /*
44 * int Asc_FileIDCopy
45 * FILE *filein;
46 * FILE *fileout;
47 * Copies the input from a file with specified file id to the other.
48 * It is the responsibility of the user to ensure that the files are
49 * open and writable.
50 */
51
52
53 STDHLF_H(Asc_LibrParseCmd);
54 extern int Asc_LibrParseCmd(ClientData, Tcl_Interp*, int, CONST84 char**);
55 /* Registered as: */
56 #define Asc_LibrParseCmdHN "libr_parsestring"
57 /* Usage: */
58 #define Asc_LibrParseCmdHU \
59 Asc_LibrParseCmdHN " <ascend code>"
60 #define Asc_LibrParseCmdHS \
61 "Opens and parses ascend code, a string containing ASCEND statements"
62 #define Asc_LibrParseCmdHL "\
63 * Opens and parses a string. If the open is successful,\n\
64 * the name of the module is returned, otherwise an error is reported.\n\
65 * it is impossible to detect if there were parse errors from the exit\n\
66 * status of this command, though this may be fixed in the future.\n\
67 "
68
69 STDHLF_H(Asc_LibrReadCmd);
70 extern int Asc_LibrReadCmd(ClientData, Tcl_Interp*, int, CONST84 char**);
71 /* Registered as: */
72 #define Asc_LibrReadCmdHN "librread"
73 /* Usage: */
74 #define Asc_LibrReadCmdHU \
75 Asc_LibrReadCmdHN " <filename> [parse_relations]"
76 #define Asc_LibrReadCmdHS \
77 "Opens and parses filename, a file containing ASCEND type definitions"
78 #define Asc_LibrReadCmdHL "\
79 * Opens and parses filename; relations will be parsed unless the\n\
80 * optional argument parse_relations is zero. If the open is successful,\n\
81 * the name of the module is returned, otherwise an error is reported.\n\
82 * it is impossible to detect if there were parse errors from the exit\n\
83 * status of this command.\n\
84 "
85
86 STDHLF_H(Asc_LibrOptionsCmd);
87 extern int Asc_LibrOptionsCmd(ClientData, Tcl_Interp*, int, CONST84 char**);
88 /* Registered as: */
89 #define Asc_LibrOptionsCmdHN "asc_compiler_option"
90 /* Usage: */
91 #define Asc_LibrOptionsCmdHU \
92 Asc_LibrOptionsCmdHN " [-<option> [value]]"
93 #define Asc_LibrOptionsCmdHS \
94 "gets and sets global options for parsing and compiling"
95 #define Asc_LibrOptionsCmdHL "\
96 * If given no arguments, returns list of current options.\n\
97 * Given an option and value, sets the option accordingly.\n\
98 * Given just the option name, returns the value.\n\
99 * Processes specific options one at a time only.\n\
100 * Options are:\n\
101 * parserWarnings: values > 1 suppress increasingly bad parser messages\n\
102 * compilerWarnings: 0 (do not), >0 (do) issue instantiation warnings\n\
103 * simplifyRelations: 0 (do not), 1 (do) do trivial simplifications\n\
104 * useCopyAnon: 0 (do not), 1 (do) share relations automatically\n\
105 "
106
107 STDHLF_H(Asc_LibrTypeListCmd);
108 extern int Asc_LibrTypeListCmd(ClientData, Tcl_Interp*, int, CONST84 char**);
109 /* Registered as: */
110 #define Asc_LibrTypeListCmdHN "libr_types_in_module"
111 /* Usage: */
112 #define Asc_LibrTypeListCmdHU \
113 Asc_LibrTypeListCmdHN " <module>"
114 #define Asc_LibrTypeListCmdHS \
115 "Returns a list of types defined in the module named \"module\""
116 #define Asc_LibrTypeListCmdHL "\
117 * Returns a list of types defined in the module named \"module\"\n\
118 "
119
120
121 STDHLF_H(Asc_LibrModuleInfoCmd);
122 extern int Asc_LibrModuleInfoCmd(ClientData, Tcl_Interp*, int, CONST84 char**);
123 /* Registered as: */
124 #define Asc_LibrModuleInfoCmdHN "libr_moduleinfo"
125 /* Usage: */
126 #define Asc_LibrModuleInfoCmdHU \
127 Asc_LibrModuleInfoCmdHN " <module> [<module>...]"
128 #define Asc_LibrModuleInfoCmdHS \
129 "For each module, returns name, file or buffer, time or index, {} or string"
130 #define Asc_LibrModuleInfoCmdHL "\
131 * For each file module, returns the name, filename, time modified and {}.\n\
132 * For each string module, returns the name, name, string parse index, and\n\
133 * string parsed.\n\
134 "
135
136
137
138 STDHLF_H(Asc_LibrDestroyTypesCmd);
139 extern int Asc_LibrDestroyTypesCmd(ClientData, Tcl_Interp*, int, CONST84 char**);
140 /* Registered as: */
141 #define Asc_LibrDestroyTypesCmdHN "libr_destroy_types"
142 /* Usage: */
143 #define Asc_LibrDestroyTypesCmdHU \
144 Asc_LibrDestroyTypesCmdHN " takes no arguments"
145 #define Asc_LibrDestroyTypesCmdHS \
146 "Reinitializes all base types and the module list"
147 #define Asc_LibrDestroyTypesCmdHL "\
148 * calls DestroyLibrary from the compiler, redefines basetypes,\n\
149 * and reinitializes interface module list.\n\
150 * Empties prototype library.\n\
151 "
152
153
154 extern int Asc_GNUTextCmd(ClientData, Tcl_Interp*, int, CONST84 char**);
155 /*
156 * Asc_GNUTextCmd
157 * Registered as : gnutext
158 * gnutext [l,w] returns the string requested from
159 * Tom's license.c. defaults to warranty
160 */
161
162
163
164 STDHLF_H(Asc_LibrHideTypeCmd);
165 extern int Asc_LibrHideTypeCmd(ClientData, Tcl_Interp*, int, CONST84 char**);
166 /* Registered as: */
167 #define Asc_LibrHideTypeCmdHN "libr_hide_type"
168 /* Usage: */
169 #define Asc_LibrHideTypeCmdHU \
170 Asc_LibrHideTypeCmdHN " <type> [part]"
171 #define Asc_LibrHideTypeCmdHS \
172 "Causes the instances of type not to be shown when browsing"
173 #define Asc_LibrHideTypeCmdHL "\
174 * Will set to FALSE the bit TYPESHOW of the Type Description type.\n\
175 * This will cause that the instances of type will not be shown for\n\
176 * browsing purposes.\n\
177 * If part is given, the part named will be hidden when browsing objects\n\
178 * the type given. The part name must be simple, that is no [] or . are\n\
179 * allowed. Parts of arrays cannot be hidden by subscript.\n\
180 "
181
182
183 STDHLF_H(Asc_LibrUnHideTypeCmd);
184 extern int Asc_LibrUnHideTypeCmd(ClientData, Tcl_Interp*, int, CONST84 char**);
185 /* Registered as: */
186 #define Asc_LibrUnHideTypeCmdHN "libr_unhide_type"
187 /* Usage: */
188 #define Asc_LibrUnHideTypeCmdHU \
189 Asc_LibrUnHideTypeCmdHN " <type> [part]"
190 #define Asc_LibrUnHideTypeCmdHS \
191 "Causes the instances of type to be shown when browsing"
192 #define Asc_LibrUnHideTypeCmdHL "\
193 * Will set to TRUE the bit TYPESHOW of the Type Description type.\n\
194 * This will cause that the instances of type will be shown for\n\
195 * browsing purposes.\n\
196 * If part is given, the part named will be shown when browsing objects\n\
197 * the type given.\n\
198 "
199
200 STDHLF_H(Asc_LibrTypeIsShownCmd);
201 extern int Asc_LibrTypeIsShownCmd(ClientData, Tcl_Interp*, int, CONST84 char**);
202 /* Registered as: */
203 #define Asc_LibrTypeIsShownCmdHN "libr_type_is_shown"
204 /* Usage: */
205 #define Asc_LibrTypeIsShownCmdHU \
206 Asc_LibrTypeIsShownCmdHN " <type>"
207 #define Asc_LibrTypeIsShownCmdHS \
208 "Returns 1 if type is being shown, or 0 if not."
209 #define Asc_LibrTypeIsShownCmdHL "\
210 * Returns 1 is the TYPESHOWN bit of a type description is ON. 0 if is\n\
211 * OFF. Query required for updating the Library Display Buttons.\n\
212 "
213
214
215 STDHLF_H(Asc_LibrQueryTypeCmd);
216 extern int Asc_LibrQueryTypeCmd(ClientData, Tcl_Interp*, int, CONST84 char**);
217 /* Registered as: */
218 #define Asc_LibrQueryTypeCmdHN "libr_query"
219 /* Usage: */
220 #define Asc_LibrQueryTypeCmdHU \
221 Asc_LibrQueryTypeCmdHN " -H for more details."
222 #define Asc_LibrQueryTypeCmdHS \
223 "Returns list of all children of type or info on child or info on info"
224 #define Asc_LibrQueryTypeCmdHL1 "\
225 * Should be expanded to handle many other queries and eliminate\n\
226 * most of the libr_ functions. Some of the following are unimplemented\n\
227 "
228 #define Asc_LibrQueryTypeCmdHL10 "\
229 * -ancestors -type typename\n\
230 * Returns the names of types that type REFINES from most to least.\n\
231 "
232 #define Asc_LibrQueryTypeCmdHL20 "\
233 * -basemethods\n\
234 * Returns the names of methods defined on DEFINITION MODEL.\n\
235 "
236 #define Asc_LibrQueryTypeCmdHL30 "\
237 * -catalog\n\
238 * Returns list of all formal types ATOMic and MODEL.\n\
239 "
240 #define Asc_LibrQueryTypeCmdHL40 "\
241 * -childnames -type typename\n\
242 * Returns list of children of type.\n\
243 "
244 #define Asc_LibrQueryTypeCmdHL50 "\
245 * -childinfo [-type typename [-child childname]]\n\
246 * Returns metasyntactic info if type nor child given.\n\
247 * Returns info for all children if type given but childname omitted.\n\
248 * Returns info for childname if type and child given.\n\
249 "
250 #define Asc_LibrQueryTypeCmdHL60 "\
251 * -definition -type typename [-method methodname]\n\
252 * Returns definition of type in standard string form,unless\n\
253 * methodname is given, in which case just gives method.\n\
254 "
255 #define Asc_LibrQueryTypeCmdHL70 "\
256 * -exists -type typename\n\
257 * Returns 1 if typename exists, or 0 if not.\n\
258 "
259 #define Asc_LibrQueryTypeCmdHL80 "\
260 * -externalfunctions\n\
261 * Returns list of all external functions loaded.\n\
262 "
263 #define Asc_LibrQueryTypeCmdHL85 "\
264 * -findtype -type typename\n\
265 * Returns the module defining type.\n\
266 "
267 #define Asc_LibrQueryTypeCmdHL90 "\
268 * -filetypes\n\
269 * Returns list of expected ASCEND source code filename suffixes.\n\
270 * Extensions other than these are probably not ascend MODEL/ATOM/unit\n\
271 * code. The compiler will dutifully attempt to eat any file of any\n\
272 * name; it is not restricted to any particular extension, or lack of\n\
273 * extension.\n\
274 "
275 #define Asc_LibrQueryTypeCmdHL100 "\
276 * -fundamentals\n\
277 * Returns a list containing the names of the fundamental types.\n\
278 "
279 #define Asc_LibrQueryTypeCmdHL110 "\
280 * -language -type typename [-child childname] [-method methodname]\n\
281 * Returns languages of NOTES on typename if no option other than -type\n\
282 * Returns languages of NOTES on childname if given.\n\
283 * Returns languages of NOTES on methodname if given.\n\
284 "
285 #define Asc_LibrQueryTypeCmdHL115 "\
286 * -methods -type typename\n\
287 * Returns a list containing the names of the methods on type given.\n\
288 "
289 #define Asc_LibrQueryTypeCmdHL120 "\
290 * -modulelist -mtype mt\n\
291 * Returns a list of modules that have types defined if mt == 0\n\
292 * Returns a list of interactive modules if mt == 1\n\
293 * Returns a list of interactive modules with global statements if mt == 2\n\
294 "
295 #define Asc_LibrQueryTypeCmdHL130 "\
296 * -notes -dbid $db -record $noteid\n\
297 * Returns data of noteid given, if it is a known record of db.\n\
298 * Data is a tuple {type language child method text}.\n\
299 "
300 #define Asc_LibrQueryTypeCmdHL131 "\
301 * -notesdblist\n\
302 * Returns known dbids in a list.\n\
303 "
304 #define Asc_LibrQueryTypeCmdHL132 "\
305 * -notes -dbid db -type typename -language keyword \n\
306 * [-child childname] [-method methodname]\n\
307 * Returns token to notes on typename in language keyword\n\
308 * if no modifiers given,\n\
309 * or on childname in type if childname given,\n\
310 * or on methodname in type if methodname given, etc.\n\
311 * The returned token should be destroyed when done with it by\n\
312 "
313 #define Asc_LibrQueryTypeCmdHL133 "\
314 * -notes -dbid $db -destroytoken $token\n\
315 * If you forget, destroytoken will be done automagically when\n\
316 * next you delete all types in the library or exit.\n\
317 "
318 #define Asc_LibrQueryTypeCmdHL135 "\
319 * -notesdump -dbid db [-textwidth n] [-notestoken token]\n\
320 * Returns the list of all notes, with texts abbreviated,\n\
321 * unless -notestoken $token given in which case returns just those.\n\
322 * If a string is empty in some field, it becomes ~\n\
323 * If n < 5, n=5 is assumed. If n not specified, n = 15.\n\
324 * List is a tuple of identically sorted lists:\n\
325 * {types} {langs} {names} {methods} {textabbrs} {filelines} {recnums}\n\
326 "
327 #define Asc_LibrQueryTypeCmdHL136 "\
328 * -notekinds -dbid db\n\
329 * Returns the list of languages known in the database.\n\
330 "
331 #define Asc_LibrQueryTypeCmdHL137 "\
332 * -notesmatch -dbid -db -pattern string [-notestoken token]\n\
333 * Returns token to the list of notes with text matching string.\n\
334 * If notestoken is not given, searches whole database, else searches\n\
335 * just those notes in the token.\n\
336 "
337 #define Asc_LibrQueryTypeCmdHL140 "\
338 * -roottypes\n\
339 * Returns a list of all types (base or otherwise) that are not\n\
340 * refinements of other types. These may be the roots of hierarchies.\n\
341 "
342
343 #endif /*LibraryProc_module_loaded*/

john.pye@anu.edu.au
ViewVC Help
Powered by ViewVC 1.1.22