1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
/*****
** ** Module Header ******************************************************* **
** **
** Modules Revision 3.0 **
** Providing a flexible user environment **
** **
** File: ModuleCmd_Help.c **
** First Edition: 1991/10/23 **
** **
** Authors: John Furlan, jlf@behere.com **
** Jens Hamisch, jens@Strawberry.COM **
** **
** Description: Provides some general help by listing the different **
** commands. It will also allow for a modulefile to **
** provide some module-specific help by calling a Tcl **
** procedure. **
** **
** Exports: ModuleCmd_Help **
** **
** Notes: **
** **
** ************************************************************************ **
****/
/** ** Copyright *********************************************************** **
** **
** Copyright 1991-1994 by John L. Furlan. **
** see LICENSE.GPL, which must be provided, for details **
** **
** ************************************************************************ **/
static char Id[] = "@(#)$Id: 2e5b66b498d8887d467ea70c3ca4ea3c2dc44f06 $";
static void *UseId[] = { &UseId, Id };
/** ************************************************************************ **/
/** HEADERS **/
/** ************************************************************************ **/
#include "modules_def.h"
/** ************************************************************************ **/
/** LOCAL DATATYPES **/
/** ************************************************************************ **/
/** not applicable **/
/** ************************************************************************ **/
/** CONSTANTS **/
/** ************************************************************************ **/
/** not applicable **/
/** ************************************************************************ **/
/** MACROS **/
/** ************************************************************************ **/
/** not applicable **/
/** ************************************************************************ **/
/** LOCAL DATA **/
/** ************************************************************************ **/
static char module_name[] = "ModuleCmd_Help.c"; /** File name of this module **/
#if WITH_DEBUGGING_MODULECMD
static char _proc_ModuleCmd_Help[] = "ModuleCmd_Help";
#endif
#if WITH_DEBUGGING_MODULECMD || WITH_DEBUGGING_UTIL_1
static char _proc_PerModuleHelp[] = "PerModuleHelp";
#endif
/** ************************************************************************ **/
/** PROTOTYPES **/
/** ************************************************************************ **/
static int PerModuleHelp( Tcl_Interp*, int, char*[]);
/*++++
** ** Function-Header ***************************************************** **
** **
** Function: ModuleCmd_Help **
** **
** Description: Execution of the module-command 'help' **
** Called w/o parameters it will print a list of avail- **
** able commands. If it is called with a parameter it **
** will print module specific help. **
** **
** First Edition: 1991/10/23 **
** **
** Parameters: Tcl_Interp *interp Attached Tcl Interp. **
** int argc Number of arguments **
** char *argv[] Argument list **
** **
** Result: int TCL_ERROR Failure **
** TCL_OK Successful operation **
** **
** Attached Globals: **
** **
** ************************************************************************ **
++++*/
int ModuleCmd_Help( Tcl_Interp *interp,
int argc,
char *argv[])
{
/**
** General or module specific help wanted. General help is done within
** here. In case of module specific help we'll call a subroutine to do
** it ...
**/
#if WITH_DEBUGGING_MODULECMD
ErrorLogger( NO_ERR_START, LOC, _proc_ModuleCmd_Help, NULL);
#endif
if( argc > 0)
PerModuleHelp( interp, argc, argv);
else
module_usage(stderr);
/**
** Return on success
**/
#if WITH_DEBUGGING_MODULECMD
ErrorLogger( NO_ERR_START, LOC, _proc_ModuleCmd_Help, NULL);
#endif
return( TCL_OK);
} /** End of 'ModuleCmd_Help' **/
/*++++
** ** Function-Header ***************************************************** **
** **
** Function: PerModuleHelp **
** **
** Description: Print module specific help **
** **
** First Edition: 1991/10/23 **
** **
** Parameters: Tcl_Interp *interp Attached Tcl Interp. **
** int argc Number of arguments **
** char *argv[] Argument list **
** **
** Result: int TCL_ERROR Failure **
** TCL_OK Successful operation **
** **
** Attached Globals: g_flags These are set up accordingly before **
** this function is called in order to **
** control everything **
** g_current_module The module which is handled **
** by the current command **
** **
** ************************************************************************ **
++++*/
static int PerModuleHelp( Tcl_Interp *interp,
int argc,
char *argv[])
{
Tcl_Interp *help_interp;
Tcl_DString cmdbuf;
int i,
result;
char modulefile[ MOD_BUFSIZE];
char modulename[ MOD_BUFSIZE];
#if WITH_DEBUGGING_UTIL_1
ErrorLogger( NO_ERR_START, LOC, _proc_PerModuleHelp, NULL);
#endif
/**
** Initialize the command buffer
**/
Tcl_DStringInit( &cmdbuf);
g_flags |= M_HELP;
/**
** Handle each passed module file. Create a Tcl interpreter for each
** module file to be handled
**/
for(i=0; i<argc; i++) {
help_interp = EM_CreateInterp();
if( TCL_OK != (result = InitializeModuleCommands( help_interp))) {
EM_DeleteInterp( help_interp);
result = TCL_ERROR;
break;
}
/**
** locate the filename related to the passed module
**/
if( Locate_ModuleFile( help_interp, argv[i], modulename, modulefile)) {
if( OK != ErrorLogger( ERR_LOCATE, LOC, argv[i], NULL))
continue;
}
/**
** Now print the module specific help ...
**/
g_current_module = modulename;
fprintf( stderr,
"\n----------- Module Specific Help for '%s' %.*s-------\n\n",
g_current_module, (int)(20-strlen( g_current_module)),
"--------------------");
result = CallModuleProcedure( help_interp, &cmdbuf, modulefile,
"ModulesHelp", 1);
/**
** If there hasn't been any help ...
**/
if( result == TCL_ERROR)
fprintf( stderr, "\t*** No Module Specific Help for %s ***\n",
g_current_module);
/**
** Finally clear up the Tcl interpreter and handle the next module
**/
EM_DeleteInterp( help_interp);
}
/**
** Free the used command buffer and return on success
**/
g_flags &= ~M_HELP;
Tcl_DStringFree(&cmdbuf);
return( TCL_OK);
} /** End of 'PerModuleHelp' **/
|