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

Annotation of /trunk/tcltk98/generic/interface/BrowserMethod.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 10 - (hide annotations) (download) (as text)
Sat Nov 13 16:40:11 2004 UTC (17 years, 7 months ago) by aw0a
Original Path: trunk/tcltk98/interface/BrowserMethod.h
File MIME type: text/x-chdr
File size: 5434 byte(s)
try again to commit moving tcl stuff
1 aw0a 1 /*
2     * BrowserMethod.h
3     * by Kirk Abbott and Ben Allan
4     * Created: 1/94
5     * Version: $Revision: 1.11 $
6     * Version control file: $RCSfile: BrowserMethod.h,v $
7     * Date last modified: $Date: 2003/08/23 18:43:04 $
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 Browser_procedure_io_module
31     #define Browser_procedure_io_module
32    
33     /*
34     * To include this header, you must include the following:
35     * #include "tcl.h"
36     * #include "BrowserMethod.h"
37     */
38    
39    
40     STDHLF_H(Asc_BrowInitializeCmd);
41     extern int Asc_BrowInitializeCmd(ClientData, Tcl_Interp *, int, CONST84 char **);
42     /* Registered as: */
43     #define Asc_BrowInitializeCmdHN "brow_runmethod"
44     /* Usage: */
45     #define Asc_BrowInitializeCmdHU \
46     Asc_BrowInitializeCmdHN "-method name -qlfdid instance_name options"
47     #define Asc_BrowInitializeCmdHS \
48     "Runs the method named in the instance named"
49     #define Asc_BrowInitializeCmdHL "\
50     * Runs a method with control of where output goes, what kind of error \n\
51     * handling, and so forth according to the options:\n\
52     * -stopOnErr 1 causes error to be reported immediately.\n\
53     * -stopOnErr 0 ignores errors (message, but continue).\n\
54     * -backtrace 0 on stopping, offer only local message.\n\
55     * -backtrace 1 on stopping, print method stack unwind.\n\
56     * -output file send output to file. If not set, to ASCERR.\n\
57     "
58    
59     extern int Asc_BrowRunAssignmentCmd(ClientData cdata,Tcl_Interp *interp,
60     int argc, CONST84 char *argv[]);
61     /*
62     * Asc_BrowRunAssignmentCmd
63     * usage: brow_assign [-search] value [units] {browser inst assignment}
64     * Checks for Boolean, Integers and Reals.
65     * A null inst returns a TCL_ERROR.
66     * Bad data or setting an already set integer gets a TCL_ERROR w/message.
67     * If units are present and type is Real, will attempt to use units in
68     * assignment. If units dimensionally incompatible, returns an error.
69     * If units are missing or "*" will assign the value directly without
70     * conversion and without changing the dimensionality of the real.
71     * If value is "UNDEFINED" returns without doing anything, regardless
72     * of units.
73     */
74    
75     extern int Asc_BrowRunAssignQlfdidCmd2(ClientData cdata,Tcl_Interp *interp,
76     int argc, CONST84 char *argv[]);
77     /*
78     * Asc_BrowRunAssignQlfdidCmd2
79     * Usage : qassgn2 qlfdid value [units] {qualified id assignment}
80     * See the notes for Asc_BrowRunAssignment. The same applies only this
81     * function requires a qulaified id. An errors will return a TCL_ERROR;
82     */
83    
84     extern int Asc_BrowRunAssignQlfdidCmd3(ClientData cdata,Tcl_Interp *interp,
85     int argc, CONST84 char *argv[]);
86     /*
87     * Asc_BrowRunAssignQlfdidCmd3
88     * Usage : qassgn3 qlfdid value [units] [-relative] {qualified id assignment}
89     * Yet another variant to try to get some more speed. This version
90     * uses Asc_QlfdidSearch3, which is the mininal implementation of
91     * searching for a name.
92     * If -relative arguement provided then the assignment is expected to
93     * be relative to the results of the last call to qlfdid (tcl call).
94     */
95    
96     extern int Asc_BrowWriteProcedure(ClientData cdata,Tcl_Interp *interp,
97     int argc, CONST84 char *argv[]);
98     /*
99     * bgetproc procname pathname [search]
100     * write the statements of a named procedure
101     * (assumed to be in g_curinst unless search appears)
102     * to a full file pathname given.
103     */
104    
105     extern int Asc_BrowSetAtomAttribute(Tcl_Interp *, struct Instance *,
106     symchar *, enum inst_t, void *);
107     /*
108     * status = Asc_BrowSetAtomAttribute(interp,atominstance,
109     * childname,childtype,dataptr);
110     * Sets the value of an attribute of the ATOM/REL instance given.
111     * Childname must be from the compiler symbol table via AddSymbol or
112     * AddSymbolL. Childtype determines what dataptr contains.
113     * Childtype must be REAL_INST, INTEGER_INST, BOOLEAN_INST, SYMBOL_INST.
114     * SET_INST is not supported at this time. dataptr must be
115     * an appropriate value object for each of the INST types above:
116     * double *, long *, int *, symchar **, respectively.
117     *
118     * Notes:
119     * -A symbol value MUST come from the symbol table.
120     * -You cannot change the dimens of a real child this way
121     * and the double * given is assumed in SI.
122     *
123     * Return a value and message other than TCL_OK if these conditions
124     * are not met. Except that if the childname or symbol value given
125     * are not in the symbol table, then does not return.
126     */
127    
128     #endif /* Browser_procedure_io_module loaded */
129    
130    
131    

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