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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 67 - (show annotations) (download) (as text)
Wed Nov 30 16:31:29 2005 UTC (14 years, 2 months ago) by johnpye
File MIME type: text/x-chdr
File size: 5435 byte(s)
Standardised the "if seen" #defines to [ASC|ASCTK|ASCPY|ASCXX]_FILENAME_H
Fixed compile on FC3
1 /*
2 * ProbeProc.h
3 * by Ben Allan
4 * Created: 6/97
5 * Version: $Revision: 1.12 $
6 * Version control file: $RCSfile: ProbeProc.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 /** @file
31 * Probe procedures.
32 * This probe implementation constitutes a total rework of the probe.
33 * <pre>
34 * To include this header, you must include the following:
35 * #include "tcl.h"
36 * #include "utilities/ascConfig.h"
37 * #include "interface/ProbeProc.h" (which is sort of obvious)
38 * </pre>
39 */
40
41 #ifndef ASCTK_PROBEPROC_H
42 #define ASCTK_PROBEPROC_H
43
44 STDHLF_H(Asc_ProbeCmd);
45 /**< Defines a long help string function */
46
47 extern int Asc_ProbeCmd(ClientData cdata, Tcl_Interp *interp,
48 int argc, CONST84 char *argv[]);
49 /**<
50 * <!-- status = Asc_ProbeCmd(cdata,interp,argc,argv); -->
51 * This is the tcl callback for our commandline help facility.
52 * (I'm tempted to quote Lord of the Rings, but it suffices to
53 * say we now have ONE probe command.)
54 */
55 /** Registered as */
56 #define Asc_ProbeCmdHN "__probe"
57 /** Usage */
58 #define Asc_ProbeCmdHU \
59 "__probe option args\noption is one of: add, clear, destroy, expand, " \
60 "filters, get, qlfdid, name, size, trash, update."
61 /** Short help text */
62 #define Asc_ProbeCmdHS \
63 "The probe is a set of instance name collections. Each collection is " \
64 "indicated by a number >= 0 contains 0 or more names."
65 /** Long help text part 1 */
66 #define Asc_ProbeCmdHL1 \
67 "\
68 * A collection created can be empty, or become empty.\n\
69 * Each name may be defined by an ASCEND instance or may be UNCERTAIN\n\
70 * if the existence of the name has not been determined lately by\n\
71 * update. Names are indexed from 0 up in a collection.\n\
72 *\n\
73 "
74 /** Long help text part 2 */
75 #define Asc_ProbeCmdHL2 \
76 "\
77 * add <number> <instance-name> [filter-vars]\n\
78 * Adds the named instance to the numbered collection.\n\
79 * If filter-booleans are provided, adds the instances\n\
80 * resulting from a search in the named instance tree\n\
81 * instead of the instance itself.\n\
82 "
83 /** Long help text part 3 */
84 #define Asc_ProbeCmdHL3 \
85 "\
86 * clear <number> [indices]\n\
87 * Deletes all entries in numth collection unless specific\n\
88 * indices are given. Valid indices are from 0 on up.\n\
89 * Ranges are not supported. Indices must be increasing\n\
90 "
91 /** Long help text part 4 */
92 #define Asc_ProbeCmdHL4 \
93 "\
94 * destroy\n\
95 * Destroys all probe information everywhere in C land.\n\
96 * expand \n\
97 * Adds a collection to the C structures and returns\n\
98 * the number of the new (empty) collection.\n\
99 "
100 /** Long help text part 5 */
101 #define Asc_ProbeCmdHL5 \
102 "\
103 * filters\n\
104 * Returns an ordered list of names/explanations for the \n\
105 * filter-vars, each is a boolean flag.\n\
106 "
107 /** Long help text part 6 */
108 #define Asc_ProbeCmdHL6 \
109 "\
110 * get <number> [indices]\n\
111 * Returns strings in a list describing the indices in\n\
112 * the collection numbered. If no indices given, the complete\n\
113 * collection list is returned.\n\
114 "
115 /** Long help text part 7 */
116 #define Asc_ProbeCmdHL7 \
117 "\
118 * invalidate\n\
119 * Changes the status of all names in all collections to\n\
120 * UNCERTAIN.\n\
121 * name <number> <index>\n\
122 * Returns the name corresponding to number and index.\n\
123 "
124 /** Long help text part 8 */
125 #define Asc_ProbeCmdHL8 \
126 "\
127 * qlfdid <number> <index>\n\
128 * Sets the g_search_inst to point at the specified instance.\n\
129 * This will not force an UNCERTAIN instance to become defined.\n\
130 * If the name is uncertain, g_search_inst will be as if\n\
131 * qlfdid had failed and '0' will be returned, OTHERWISE '1'.\n\
132 "
133 /** Long help text part 9 */
134 #define Asc_ProbeCmdHL9 \
135 "\
136 * size [number]\n\
137 * Returns the number of names in the numbered collection, or\n\
138 * if no number is specified, the number of collections. -1=err\n\
139 * trash [number]\n\
140 * Removes any UNCERTAIN names in the collection specified or\n\
141 * in all collections if no number is given.\n\
142 "
143 /** Long help text part 10 */
144 #define Asc_ProbeCmdHL10 \
145 "\
146 * update [number]\n\
147 * Attempts to resolve all uncertain names in the collection\n\
148 * specified, or in all collections if no number given.\n\
149 "
150 /** Long help text part 11 */
151 #define Asc_ProbeCmdHL11 \
152 "\
153 *\n\
154 * FILTER-VARS are a number of values (currently all boolean) \n\
155 * with positional meanings.\n\
156 * All filters must be specified if any are.\n\
157 "
158 /*
159 * "__probe" will almost certainly move g_search_inst on most calls.
160 */
161
162 #endif /* ASCTK_PROBEPROC_H */
163

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