envmodules/modules
1
0
Fork 0
mirror of https://github.com/envmodules/modules.git synced 2026-06-10 00:56:30 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
Files
a3a5564d7d5b09642e2beeebeabb57716e9e84fa
modules/xref/ModuleCmd_Whatis.c.src.html
rkowen a77d63f1e1 Updated the cxref docs to 3.2.0rc4
2006-01-12 19:30:05 +00:00

785 lines
42 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- This HTML file generated by cxref (version 1.6a). -->
<!-- cxref program (c) Andrew M. Bishop 1995,96,97,98,99,2000,01,02,03,04,05. -->
<!--
Cxref: cxref -block-comments -verbatim-comments -xref-all -index-all -html-src -Oxref ModuleCmd_Whatis.c
CPP : cxref-cpp -lang-c -C -dD -dI
-->
<HTML>
<HEAD>
<TITLE>Source File ModuleCmd_Whatis.c</TITLE>
<LINK rel="stylesheet" href="cxref.css" type="text/css">
</HEAD>
<BODY>
<pre>
<a name="line1">1 |</a> /*****
<a name="line2">2 |</a> ** ** Module Header ******************************************************* **
<a name="line3">3 |</a> ** **
<a name="line4">4 |</a> ** Modules Revision 3.0 **
<a name="line5">5 |</a> ** Providing a flexible user environment **
<a name="line6">6 |</a> ** **
<a name="line7">7 |</a> ** File: ModuleCmd_Whatis.c **
<a name="line8">8 |</a> ** First Edition: 1995/12/31 **
<a name="line9">9 |</a> ** **
<a name="line10">10 |</a> ** Authors: Jens Hamisch, jens@Strawberry.COM **
<a name="line11">11 |</a> ** **
<a name="line12">12 |</a> ** ModuleCmd_Apropos **
<a name="line13">13 |</a> ** **
<a name="line14">14 |</a> ** Notes: **
<a name="line15">15 |</a> ** **
<a name="line16">16 |</a> ** ************************************************************************ **
<a name="line17">17 |</a> ****/
<a name="line18">18 |</a>
<a name="line19">19 |</a> /** ** Copyright *********************************************************** **
<a name="line20">20 |</a> ** **
<a name="line21">21 |</a> ** Copyright 1991-1994 by John L. Furlan. **
<a name="line22">22 |</a> ** see LICENSE.GPL, which must be provided, for details **
<a name="line23">23 |</a> ** **
<a name="line24">24 |</a> ** ************************************************************************ **/
<a name="line25">25 |</a>
<a name="line26">26 |</a> static char Id[] = "@(#)$Id: ModuleCmd_Whatis.c.src.html,v 1.6 2006/01/18 05:35:11 rkowen Exp $";
<a name="line27">27 |</a> static void *UseId[] = { &amp;UseId, Id };
<a name="line28">28 |</a>
<a name="line29">29 |</a> /** ************************************************************************ **/
<a name="line30">30 |</a> /** HEADERS **/
<a name="line31">31 |</a> /** ************************************************************************ **/
<a name="line32">32 |</a>
<a name="line33">33 |</a> #include "modules_def.h"
<a name="line34">34 |</a>
<a name="line35">35 |</a> /** ************************************************************************ **/
<a name="line36">36 |</a> /** LOCAL DATATYPES **/
<a name="line37">37 |</a> /** ************************************************************************ **/
<a name="line38">38 |</a>
<a name="line39">39 |</a> /** not applicable **/
<a name="line40">40 |</a>
<a name="line41">41 |</a> /** ************************************************************************ **/
<a name="line42">42 |</a> /** CONSTANTS **/
<a name="line43">43 |</a> /** ************************************************************************ **/
<a name="line44">44 |</a>
<a name="line45">45 |</a> /** not applicable **/
<a name="line46">46 |</a>
<a name="line47">47 |</a> /** ************************************************************************ **/
<a name="line48">48 |</a> /** MACROS **/
<a name="line49">49 |</a> /** ************************************************************************ **/
<a name="line50">50 |</a>
<a name="line51">51 |</a> #define WHATIS_SOME 0
<a name="line52">52 |</a> #define WHATIS_ALL 1
<a name="line53">53 |</a>
<a name="line54">54 |</a> /** ************************************************************************ **/
<a name="line55">55 |</a> /** LOCAL DATA **/
<a name="line56">56 |</a> /** ************************************************************************ **/
<a name="line57">57 |</a>
<a name="line58">58 |</a> static char module_name[] = "ModuleCmd_Whatis.c"; /** File name of this module **/
<a name="line59">59 |</a>
<a name="line60">60 |</a> #if WITH_DEBUGGING_MODULECMD
<a name="line61">61 |</a> static char _proc_ModuleCmd_Whatis[] = "ModuleCmd_Whatis";
<a name="line62">62 |</a> static char _proc_ModuleCmd_Apropos[] = "ModuleCmd_Apropos";
<a name="line63">63 |</a> #endif
<a name="line64">64 |</a> #if WITH_DEBUGGING_UTIL_1
<a name="line65">65 |</a> static char _proc_whatis_dir[] = "whatis_dir";
<a name="line66">66 |</a> static char _proc_read_cache[] = "read_cache";
<a name="line67">67 |</a> static char _proc_apropos_cache[] = "apropos_cache";
<a name="line68">68 |</a> #endif
<a name="line69">69 |</a>
<a name="line70">70 |</a> static char cache_name[] = APR_CACHE;
<a name="line71">71 |</a>
<a name="line72">72 |</a> /** ************************************************************************ **/
<a name="line73">73 |</a> /** PROTOTYPES **/
<a name="line74">74 |</a> /** ************************************************************************ **/
<a name="line75">75 |</a>
<a name="line76">76 |</a> static int read_cache( int, char**, FILE*, int);
<a name="line77">77 |</a> static int whatis_dir( char*, int, char**, FILE*, int);
<a name="line78">78 |</a> static char *apropos_cache(void);
<a name="line79">79 |</a>
<a name="line80">80 |</a> /*++++
<a name="line81">81 |</a> ** ** Function-Header ***************************************************** **
<a name="line82">82 |</a> ** **
<a name="line83">83 |</a> ** Function: ModuleCmd_Whatis **
<a name="line84">84 |</a> ** **
<a name="line85">85 |</a> ** Description: Display the passed modules 'whatis' information **
<a name="line86">86 |</a> ** **
<a name="line87">87 |</a> ** First Edition: 1995/12/31 **
<a name="line88">88 |</a> ** **
<a name="line89">89 |</a> ** Parameters: Tcl_Interp *interp Attached Tcl Interp. **
<a name="line90">90 |</a> ** int argc Number of arguments **
<a name="line91">91 |</a> ** char *argv[] Argument list **
<a name="line92">92 |</a> ** **
<a name="line93">93 |</a> ** Result: int TCL_ERROR Failure **
<a name="line94">94 |</a> ** TCL_OK Successfull operation **
<a name="line95">95 |</a> ** **
<a name="line96">96 |</a> ** Attached Globals: g_flags These are set up accordingly before **
<a name="line97">97 |</a> ** this function is called in order to **
<a name="line98">98 |</a> ** control everything **
<a name="line99">99 |</a> ** g_current_module The module which is handled **
<a name="line100">100 |</a> ** by the current command **
<a name="line101">101 |</a> ** **
<a name="line102">102 |</a> ** ************************************************************************ **
<a name="line103">103 |</a> ++++*/
<a name="line104">104 |</a>
<a name="line105">105 |</a> int ModuleCmd_Whatis( Tcl_Interp *interp,
<a name="line106">106 |</a> int argc,
<a name="line107">107 |</a> char *argv[])
<a name="line108">108 |</a> {
<a name="line109">109 |</a> struct stat stats;
<a name="line110">110 |</a> Tcl_Interp *whatis_interp;
<a name="line111">111 |</a> Tcl_DString cmdbuf;
<a name="line112">112 |</a> int i, result = TCL_OK, done = 0;
<a name="line113">113 |</a> char modulefile[ MOD_BUFSIZE],
<a name="line114">114 |</a> modulename[ MOD_BUFSIZE],
<a name="line115">115 |</a> *modpath, /** Buffer for the contents of the **/
<a name="line116">116 |</a> /** environment variable MODULEPATH **/
<a name="line117">117 |</a> **wptr,
<a name="line118">118 |</a> *dirname,
<a name="line119">119 |</a> *cache_file = (char *) NULL; /** Name of the cache file **/
<a name="line120">120 |</a> FILE *cachefp = (FILE *) NULL; /** Cache file pointer **/
<a name="line121">121 |</a>
<a name="line122">122 |</a> #if WITH_DEBUGGING_MODULECMD
<a name="line123">123 |</a> ErrorLogger( NO_ERR_START, LOC, _proc_ModuleCmd_Whatis, NULL);
<a name="line124">124 |</a> #endif
<a name="line125">125 |</a>
<a name="line126">126 |</a> /**
<a name="line127">127 |</a> ** Initialize the command buffer and set up the modules flag to
<a name="line128">128 |</a> ** 'whatisonly'
<a name="line129">129 |</a> **/
<a name="line130">130 |</a> Tcl_DStringInit( &amp;cmdbuf);
<a name="line131">131 |</a> g_flags |= M_WHATIS;
<a name="line132">132 |</a>
<a name="line133">133 |</a> /**
<a name="line134">134 |</a> ** Handle each passed module file. Create a Tcl interpreter for each
<a name="line135">135 |</a> ** module file to be handled and initialize it with custom module commands
<a name="line136">136 |</a> **/
<a name="line137">137 |</a>
<a name="line138">138 |</a> if ( argc) {
<a name="line139">139 |</a> /**
<a name="line140">140 |</a> ** User provided a list of modules for ``whatis'' info
<a name="line141">141 |</a> **/
<a name="line142">142 |</a> for(i=0; i&lt;argc &amp;&amp; argv[i]; i++) {
<a name="line143">143 |</a>
<a name="line144">144 |</a> whatis_interp = Tcl_CreateInterp();
<a name="line145">145 |</a> if( TCL_OK != (result = InitializeModuleCommands( whatis_interp))) {
<a name="line146">146 |</a> Tcl_DeleteInterp( whatis_interp);
<a name="line147">147 |</a> result = TCL_ERROR;
<a name="line148">148 |</a> break;
<a name="line149">149 |</a> }
<a name="line150">150 |</a>
<a name="line151">151 |</a> /**
<a name="line152">152 |</a> ** locate the filename related to the passed module
<a name="line153">153 |</a> **/
<a name="line154">154 |</a> if( TCL_ERROR ==
<a name="line155">155 |</a> Locate_ModuleFile(whatis_interp,argv[i],modulename,modulefile)){
<a name="line156">156 |</a> Tcl_DeleteInterp( whatis_interp);
<a name="line157">157 |</a> if( OK != ErrorLogger( ERR_LOCATE, LOC, argv[i], NULL))
<a name="line158">158 |</a> break;
<a name="line159">159 |</a> else
<a name="line160">160 |</a> continue;
<a name="line161">161 |</a> }
<a name="line162">162 |</a>
<a name="line163">163 |</a> /**
<a name="line164">164 |</a> ** Print out everything that would happen if the module file were
<a name="line165">165 |</a> ** executed ...
<a name="line166">166 |</a> **/
<a name="line167">167 |</a> g_current_module = modulename;
<a name="line168">168 |</a>
<a name="line169">169 |</a> cmdModuleWhatisInit();
<a name="line170">170 |</a> result = CallModuleProcedure( whatis_interp, &amp;cmdbuf, modulefile,
<a name="line171">171 |</a> "ModulesWhatis", 0);
<a name="line172">172 |</a>
<a name="line173">173 |</a> /**
<a name="line174">174 |</a> ** Print the result ...
<a name="line175">175 |</a> **/
<a name="line176">176 |</a> if( whatis) {
<a name="line177">177 |</a> wptr = whatis;
<a name="line178">178 |</a> while( *wptr)
<a name="line179">179 |</a> fprintf( stderr, "%-21s: %s\n", argv[i], *wptr++);
<a name="line180">180 |</a> }
<a name="line181">181 |</a>
<a name="line182">182 |</a> /**
<a name="line183">183 |</a> ** Remove the Tcl interpreter that has been used for printing ...
<a name="line184">184 |</a> **/
<a name="line185">185 |</a> Tcl_DeleteInterp( whatis_interp);
<a name="line186">186 |</a> cmdModuleWhatisShut();
<a name="line187">187 |</a>
<a name="line188">188 |</a> } /** for **/
<a name="line189">189 |</a> } else {
<a name="line190">190 |</a> /**
<a name="line191">191 |</a> ** User wants all module ``whatis'' info
<a name="line192">192 |</a> **/
<a name="line193">193 |</a>
<a name="line194">194 |</a> /**
<a name="line195">195 |</a> ** If no MODULEPATH defined, we can not output anything
<a name="line196">196 |</a> **/
<a name="line197">197 |</a> if( !(modpath = (char *) xgetenv( "MODULEPATH")))
<a name="line198">198 |</a> if( OK != ErrorLogger( ERR_MODULE_PATH, LOC, NULL))
<a name="line199">199 |</a> goto unwind0;
<a name="line200">200 |</a>
<a name="line201">201 |</a> /**
<a name="line202">202 |</a> ** Check whether a cache file exists then list all the ``whatis'' info
<a name="line203">203 |</a> ** Otherwise read all module files ...
<a name="line204">204 |</a> **/
<a name="line205">205 |</a> cache_file = apropos_cache();
<a name="line206">206 |</a> if( !sw_create &amp;&amp; cache_file &amp;&amp; !stat( cache_file, &amp;stats)) {
<a name="line207">207 |</a>
<a name="line208">208 |</a> /**
<a name="line209">209 |</a> ** Open the cache file
<a name="line210">210 |</a> **/
<a name="line211">211 |</a> if((FILE *) NULL == (cachefp = fopen( cache_file, "r"))) {
<a name="line212">212 |</a> if( OK != ErrorLogger( ERR_OPEN, LOC, cache_file, NULL))
<a name="line213">213 |</a> goto unwind1;
<a name="line214">214 |</a>
<a name="line215">215 |</a> } else {
<a name="line216">216 |</a>
<a name="line217">217 |</a> /**
<a name="line218">218 |</a> ** Read the cache and close the file
<a name="line219">219 |</a> **/
<a name="line220">220 |</a> result = read_cache( argc, argv, cachefp, WHATIS_ALL);
<a name="line221">221 |</a>
<a name="line222">222 |</a> if( EOF == fclose( cachefp))
<a name="line223">223 |</a> if( OK != ErrorLogger( ERR_CLOSE, LOC, cache_file, NULL))
<a name="line224">224 |</a> goto unwind1;
<a name="line225">225 |</a>
<a name="line226">226 |</a> done = 1;
<a name="line227">227 |</a> }
<a name="line228">228 |</a> }
<a name="line229">229 |</a>
<a name="line230">230 |</a> /**
<a name="line231">231 |</a> ** If we're not done now, we have to scan the files
<a name="line232">232 |</a> **/
<a name="line233">233 |</a> if( !done) {
<a name="line234">234 |</a>
<a name="line235">235 |</a> /**
<a name="line236">236 |</a> ** Open the cache file if neccessary
<a name="line237">237 |</a> **/
<a name="line238">238 |</a> if( sw_create &amp;&amp; cache_file)
<a name="line239">239 |</a> if((FILE *) NULL == (cachefp = fopen( cache_file, "w")))
<a name="line240">240 |</a> if( OK != ErrorLogger( ERR_OPEN, LOC, cache_file, NULL))
<a name="line241">241 |</a> goto unwind1;
<a name="line242">242 |</a>
<a name="line243">243 |</a> /**
<a name="line244">244 |</a> ** Tokenize the module path string and check all dirs
<a name="line245">245 |</a> **/
<a name="line246">246 |</a> for( dirname = strtok( modpath, ":");
<a name="line247">247 |</a> dirname;
<a name="line248">248 |</a> dirname = strtok( NULL, ":") ) {
<a name="line249">249 |</a>
<a name="line250">250 |</a> if( !check_dir( dirname))
<a name="line251">251 |</a> continue;
<a name="line252">252 |</a>
<a name="line253">253 |</a> whatis_dir( dirname, argc, argv, cachefp, WHATIS_ALL);
<a name="line254">254 |</a>
<a name="line255">255 |</a> } /** for **/
<a name="line256">256 |</a>
<a name="line257">257 |</a> /**
<a name="line258">258 |</a> ** Close the cache file
<a name="line259">259 |</a> **/
<a name="line260">260 |</a> if( cachefp)
<a name="line261">261 |</a> if( EOF == fclose( cachefp))
<a name="line262">262 |</a> if( OK != ErrorLogger( ERR_CLOSE, LOC, cache_file, NULL))
<a name="line263">263 |</a> goto unwind1;
<a name="line264">264 |</a> }
<a name="line265">265 |</a> }
<a name="line266">266 |</a>
<a name="line267">267 |</a> /**
<a name="line268">268 |</a> ** Leave the 'whatis only mode', free up what has been used and return
<a name="line269">269 |</a> **/
<a name="line270">270 |</a> g_flags &amp;= ~M_WHATIS;
<a name="line271">271 |</a> fprintf( stderr, "\n");
<a name="line272">272 |</a>
<a name="line273">273 |</a> Tcl_DStringFree( &amp;cmdbuf);
<a name="line274">274 |</a>
<a name="line275">275 |</a> /**
<a name="line276">276 |</a> ** Free up allocated resources
<a name="line277">277 |</a> **/
<a name="line278">278 |</a> null_free((void *) &amp;cache_file);
<a name="line279">279 |</a> null_free((void *) &amp;modpath);
<a name="line280">280 |</a>
<a name="line281">281 |</a> /**
<a name="line282">282 |</a> ** Return on success
<a name="line283">283 |</a> **/
<a name="line284">284 |</a>
<a name="line285">285 |</a> #if WITH_DEBUGGING_MODULECMD
<a name="line286">286 |</a> ErrorLogger( NO_ERR_END, LOC, _proc_ModuleCmd_Whatis, NULL);
<a name="line287">287 |</a> #endif
<a name="line288">288 |</a>
<a name="line289">289 |</a> return( result); /** --- EXIT PROCEDURE (result) --&gt; **/
<a name="line290">290 |</a>
<a name="line291">291 |</a> unwind1:
<a name="line292">292 |</a> null_free((void *) &amp;cache_file);
<a name="line293">293 |</a> null_free((void *) &amp;modpath);
<a name="line294">294 |</a> unwind0:
<a name="line295">295 |</a> return( TCL_ERROR); /** --- EXIT PROCEDURE (FAILURE) --&gt; **/
<a name="line296">296 |</a>
<a name="line297">297 |</a> } /** End of 'ModuleCmd_Whatis' **/
<a name="line298">298 |</a>
<a name="line299">299 |</a> /*++++
<a name="line300">300 |</a> ** ** Function-Header ***************************************************** **
<a name="line301">301 |</a> ** **
<a name="line302">302 |</a> ** Function: ModuleCmd_Apropos **
<a name="line303">303 |</a> ** **
<a name="line304">304 |</a> ** Description: Scan the whatis database in order to find something **
<a name="line305">305 |</a> ** matching the passed strings **
<a name="line306">306 |</a> ** **
<a name="line307">307 |</a> ** First Edition: 1995/12/31 **
<a name="line308">308 |</a> ** **
<a name="line309">309 |</a> ** Parameters: Tcl_Interp *interp Attached Tcl Interp. **
<a name="line310">310 |</a> ** int argc Number of arguments **
<a name="line311">311 |</a> ** char *argv[] Argument list **
<a name="line312">312 |</a> ** **
<a name="line313">313 |</a> ** Result: int TCL_ERROR Failure **
<a name="line314">314 |</a> ** TCL_OK Successfull operation **
<a name="line315">315 |</a> ** **
<a name="line316">316 |</a> ** Attached Globals: **
<a name="line317">317 |</a> ** **
<a name="line318">318 |</a> ** ************************************************************************ **
<a name="line319">319 |</a> ++++*/
<a name="line320">320 |</a>
<a name="line321">321 |</a> int ModuleCmd_Apropos( Tcl_Interp *interp,
<a name="line322">322 |</a> int argc,
<a name="line323">323 |</a> char *argv[])
<a name="line324">324 |</a> {
<a name="line325">325 |</a> struct stat stats;
<a name="line326">326 |</a> char *dirname;
<a name="line327">327 |</a> char *modpath; /** Buffer for the contents of the **/
<a name="line328">328 |</a> /** environment variable MODULEPATH **/
<a name="line329">329 |</a> int i, done = 0;
<a name="line330">330 |</a> char *c;
<a name="line331">331 |</a> char *cache_file; /** Name of the cache file **/
<a name="line332">332 |</a> FILE *cachefp = (FILE *) NULL; /** Cache file pointer **/
<a name="line333">333 |</a>
<a name="line334">334 |</a> #if WITH_DEBUGGING_MODULECMD
<a name="line335">335 |</a> ErrorLogger( NO_ERR_START, LOC, _proc_ModuleCmd_Apropos, NULL);
<a name="line336">336 |</a> #endif
<a name="line337">337 |</a>
<a name="line338">338 |</a> /**
<a name="line339">339 |</a> ** Ignore case ... convert all arguments to lower case
<a name="line340">340 |</a> **/
<a name="line341">341 |</a> if( sw_icase)
<a name="line342">342 |</a> for( i=0; i&lt;argc; i++)
<a name="line343">343 |</a> for( c=argv[ i]; c &amp;&amp; *c; c++)
<a name="line344">344 |</a> *c = tolower( *c);
<a name="line345">345 |</a>
<a name="line346">346 |</a> /**
<a name="line347">347 |</a> ** If there's no MODULEPATH defined, we cannot output anything
<a name="line348">348 |</a> **/
<a name="line349">349 |</a> if((char *) NULL == (modpath = xgetenv( "MODULEPATH")))
<a name="line350">350 |</a> if( OK != ErrorLogger( ERR_MODULE_PATH, LOC, NULL))
<a name="line351">351 |</a> goto unwind0;
<a name="line352">352 |</a>
<a name="line353">353 |</a> /**
<a name="line354">354 |</a> ** Check whether there's a cache file. If it is, grep for the tokens
<a name="line355">355 |</a> ** in this file. Otherwise read all module files ...
<a name="line356">356 |</a> **/
<a name="line357">357 |</a> cache_file = apropos_cache();
<a name="line358">358 |</a> if( !sw_create &amp;&amp; cache_file &amp;&amp; !stat( cache_file, &amp;stats)) {
<a name="line359">359 |</a>
<a name="line360">360 |</a> /**
<a name="line361">361 |</a> ** Open the cache file
<a name="line362">362 |</a> **/
<a name="line363">363 |</a> if((FILE *) NULL == (cachefp = fopen( cache_file, "r"))) {
<a name="line364">364 |</a> if( OK != ErrorLogger( ERR_OPEN, LOC, cache_file, NULL))
<a name="line365">365 |</a> goto unwind1;
<a name="line366">366 |</a>
<a name="line367">367 |</a> } else {
<a name="line368">368 |</a>
<a name="line369">369 |</a> /**
<a name="line370">370 |</a> ** Read the cache and close the file
<a name="line371">371 |</a> **/
<a name="line372">372 |</a> read_cache( argc, argv, cachefp, WHATIS_SOME);
<a name="line373">373 |</a>
<a name="line374">374 |</a> if( EOF == fclose( cachefp))
<a name="line375">375 |</a> if( OK != ErrorLogger( ERR_CLOSE, LOC, cache_file, NULL))
<a name="line376">376 |</a> goto unwind1;
<a name="line377">377 |</a>
<a name="line378">378 |</a> done = 1;
<a name="line379">379 |</a> }
<a name="line380">380 |</a> }
<a name="line381">381 |</a>
<a name="line382">382 |</a> /**
<a name="line383">383 |</a> ** If we're not done now, we have to scan the files
<a name="line384">384 |</a> **/
<a name="line385">385 |</a> if( !done) {
<a name="line386">386 |</a>
<a name="line387">387 |</a> /**
<a name="line388">388 |</a> ** Open the cache file if neccessary
<a name="line389">389 |</a> **/
<a name="line390">390 |</a> if( sw_create &amp;&amp; cache_file)
<a name="line391">391 |</a> if((FILE *) NULL == (cachefp = fopen( cache_file, "w")))
<a name="line392">392 |</a> if( OK != ErrorLogger( ERR_OPEN, LOC, cache_file, NULL))
<a name="line393">393 |</a> goto unwind1;
<a name="line394">394 |</a>
<a name="line395">395 |</a> /**
<a name="line396">396 |</a> ** Tokenize the module path string and check all dirs
<a name="line397">397 |</a> **/
<a name="line398">398 |</a> for( dirname = strtok( modpath, ":");
<a name="line399">399 |</a> dirname;
<a name="line400">400 |</a> dirname = strtok( NULL, ":") ) {
<a name="line401">401 |</a>
<a name="line402">402 |</a> if( !check_dir( dirname))
<a name="line403">403 |</a> continue;
<a name="line404">404 |</a>
<a name="line405">405 |</a> whatis_dir( dirname, argc, argv, cachefp, WHATIS_SOME);
<a name="line406">406 |</a>
<a name="line407">407 |</a> } /** for **/
<a name="line408">408 |</a>
<a name="line409">409 |</a> /**
<a name="line410">410 |</a> ** Close the cache file
<a name="line411">411 |</a> **/
<a name="line412">412 |</a> if( cachefp)
<a name="line413">413 |</a> if( EOF == fclose( cachefp))
<a name="line414">414 |</a> if( OK != ErrorLogger( ERR_CLOSE, LOC, cache_file, NULL))
<a name="line415">415 |</a> goto unwind1;
<a name="line416">416 |</a> }
<a name="line417">417 |</a>
<a name="line418">418 |</a> /**
<a name="line419">419 |</a> ** Free up what has been allocated and exit from this procedure
<a name="line420">420 |</a> **/
<a name="line421">421 |</a> null_free((void *) &amp;modpath);
<a name="line422">422 |</a>
<a name="line423">423 |</a> #if WITH_DEBUGGING_MODULECMD
<a name="line424">424 |</a> ErrorLogger( NO_ERR_END, LOC, _proc_ModuleCmd_Apropos, NULL);
<a name="line425">425 |</a> #endif
<a name="line426">426 |</a>
<a name="line427">427 |</a> return( TCL_OK);
<a name="line428">428 |</a>
<a name="line429">429 |</a> unwind1:
<a name="line430">430 |</a> null_free((void *) &amp;modpath);
<a name="line431">431 |</a> unwind0:
<a name="line432">432 |</a> return( TCL_ERROR); /** ---- EXIT (FAILURE) ---&gt; **/
<a name="line433">433 |</a>
<a name="line434">434 |</a> } /** End of 'ModuleCmd_Apropos' **/
<a name="line435">435 |</a>
<a name="line436">436 |</a> /*++++
<a name="line437">437 |</a> ** ** Function-Header ***************************************************** **
<a name="line438">438 |</a> ** **
<a name="line439">439 |</a> ** Function: whatis_dir **
<a name="line440">440 |</a> ** **
<a name="line441">441 |</a> ** Description: Print all files beyond the passed directory **
<a name="line442">442 |</a> ** **
<a name="line443">443 |</a> ** First Edition: 1991/10/23 **
<a name="line444">444 |</a> ** **
<a name="line445">445 |</a> ** Parameters: char *dir Directory to be scanned **
<a name="line446">446 |</a> ** int argc Number of tokens **
<a name="line447">447 |</a> ** char **argv List of tokens to check **
<a name="line448">448 |</a> ** FILE *cfp Cache file pointer **
<a name="line449">449 |</a> ** **
<a name="line450">450 |</a> ** Result: int TCL_OK Successfull operation **
<a name="line451">451 |</a> ** **
<a name="line452">452 |</a> ** Attached Globals: g_flags These are set up accordingly before **
<a name="line453">453 |</a> ** this function is called in order to **
<a name="line454">454 |</a> ** control everything **
<a name="line455">455 |</a> ** g_current_module The module which is handled **
<a name="line456">456 |</a> ** by the current command **
<a name="line457">457 |</a> ** **
<a name="line458">458 |</a> ** ************************************************************************ **
<a name="line459">459 |</a> ++++*/
<a name="line460">460 |</a>
<a name="line461">461 |</a> static int whatis_dir( char *dir, int argc, char **argv, FILE *cfp,
<a name="line462">462 |</a> int whatis_list)
<a name="line463">463 |</a> {
<a name="line464">464 |</a> fi_ent *dirlst_head = NULL; /** Directory list base pointer **/
<a name="line465">465 |</a> int count = 0; /** Number of elements in the top **/
<a name="line466">466 |</a> /** level directory list **/
<a name="line467">467 |</a> int tcount = 0; /** Total number of files to print **/
<a name="line468">468 |</a> char **list; /** flat list of module files **/
<a name="line469">469 |</a> int start = 0, i, k;
<a name="line470">470 |</a> int result = TCL_OK;
<a name="line471">471 |</a> Tcl_Interp *whatis_interp;
<a name="line472">472 |</a> Tcl_DString cmdbuf;
<a name="line473">473 |</a> char modulefile[ MOD_BUFSIZE];
<a name="line474">474 |</a> char **wptr, *c;
<a name="line475">475 |</a> struct stat stats;
<a name="line476">476 |</a>
<a name="line477">477 |</a> #if WITH_DEBUGGING_UTIL_1
<a name="line478">478 |</a> ErrorLogger( NO_ERR_START, LOC, _proc_whatis_dir, "dir='", dir, NULL);
<a name="line479">479 |</a> #endif
<a name="line480">480 |</a>
<a name="line481">481 |</a> /**
<a name="line482">482 |</a> ** Normal reading of the files
<a name="line483">483 |</a> **/
<a name="line484">484 |</a>
<a name="line485">485 |</a> if( NULL == (dirlst_head = get_dir( dir, NULL, &amp;count, &amp;tcount)))
<a name="line486">486 |</a> if( OK != ErrorLogger( ERR_READDIR, LOC, dir, NULL))
<a name="line487">487 |</a> goto unwind0;
<a name="line488">488 |</a>
<a name="line489">489 |</a> if( NULL == (list = (char**) malloc( tcount * sizeof( char**))))
<a name="line490">490 |</a> if( OK != ErrorLogger( ERR_ALLOC, LOC, NULL))
<a name="line491">491 |</a> goto unwind1;
<a name="line492">492 |</a>
<a name="line493">493 |</a> dirlst_to_list( list, dirlst_head, count, &amp;start, NULL, NULL);
<a name="line494">494 |</a>
<a name="line495">495 |</a> /**
<a name="line496">496 |</a> ** Initialize the command buffer and set up the modules flag to 'whatislay
<a name="line497">497 |</a> ** only'
<a name="line498">498 |</a> **/
<a name="line499">499 |</a>
<a name="line500">500 |</a> Tcl_DStringInit( &amp;cmdbuf);
<a name="line501">501 |</a> g_flags |= M_WHATIS;
<a name="line502">502 |</a>
<a name="line503">503 |</a> /**
<a name="line504">504 |</a> ** Check all the files in the flat list for the passed tokens
<a name="line505">505 |</a> **/
<a name="line506">506 |</a>
<a name="line507">507 |</a> for( i=0; i&lt;tcount; i++) {
<a name="line508">508 |</a>
<a name="line509">509 |</a> whatis_interp = Tcl_CreateInterp();
<a name="line510">510 |</a> if( TCL_OK != (result = InitializeModuleCommands( whatis_interp))) {
<a name="line511">511 |</a> Tcl_DeleteInterp( whatis_interp);
<a name="line512">512 |</a> result = TCL_ERROR;
<a name="line513">513 |</a> break; /** for( i) **/
<a name="line514">514 |</a> }
<a name="line515">515 |</a>
<a name="line516">516 |</a> /**
<a name="line517">517 |</a> ** locate the filename related to the passed module
<a name="line518">518 |</a> **/
<a name="line519">519 |</a>
<a name="line520">520 |</a> if( (char *) NULL == stringer(modulefile,MOD_BUFSIZE,
<a name="line521">521 |</a> dir,"/",list[i],NULL)) {
<a name="line522">522 |</a> result = TCL_ERROR;
<a name="line523">523 |</a> break; /** for( i) **/
<a name="line524">524 |</a> }
<a name="line525">525 |</a> g_current_module = list[ i];
<a name="line526">526 |</a>
<a name="line527">527 |</a> if( stat( modulefile, &amp;stats) || S_ISDIR( stats.st_mode))
<a name="line528">528 |</a> continue;
<a name="line529">529 |</a>
<a name="line530">530 |</a> cmdModuleWhatisInit();
<a name="line531">531 |</a> result = CallModuleProcedure( whatis_interp, &amp;cmdbuf, modulefile,
<a name="line532">532 |</a> "ModulesApropos", 0);
<a name="line533">533 |</a>
<a name="line534">534 |</a> /**
<a name="line535">535 |</a> ** Check if at least one of the passed tokens is found in the
<a name="line536">536 |</a> ** retrieved whatis strings. If yes, print the string.
<a name="line537">537 |</a> **/
<a name="line538">538 |</a>
<a name="line539">539 |</a> if( whatis) {
<a name="line540">540 |</a> wptr = whatis;
<a name="line541">541 |</a> while( *wptr) {
<a name="line542">542 |</a>
<a name="line543">543 |</a> /**
<a name="line544">544 |</a> ** Cache output enabled?
<a name="line545">545 |</a> **/
<a name="line546">546 |</a>
<a name="line547">547 |</a> if( cfp)
<a name="line548">548 |</a> fprintf( cfp, "%-21s: %s\n", list[i], *wptr);
<a name="line549">549 |</a>
<a name="line550">550 |</a> /**
<a name="line551">551 |</a> ** Ignore case?
<a name="line552">552 |</a> **/
<a name="line553">553 |</a>
<a name="line554">554 |</a> if( sw_icase) {
<a name="line555">555 |</a> strncpy( modulefile, *wptr, MOD_BUFSIZE);
<a name="line556">556 |</a> for( c = modulefile; c &amp;&amp; *c; c++)
<a name="line557">557 |</a> *c = tolower( *c);
<a name="line558">558 |</a> c = modulefile;
<a name="line559">559 |</a> } else
<a name="line560">560 |</a> c = *wptr;
<a name="line561">561 |</a>
<a name="line562">562 |</a> /**
<a name="line563">563 |</a> ** Seek for the passed tokens
<a name="line564">564 |</a> **/
<a name="line565">565 |</a>
<a name="line566">566 |</a> if( whatis_list)
<a name="line567">567 |</a> fprintf( stderr, "%-21s: %s\n", list[i], *wptr);
<a name="line568">568 |</a> else
<a name="line569">569 |</a> for( k=0; k&lt;argc; k++) {
<a name="line570">570 |</a> if( strstr( c, argv[ k]))
<a name="line571">571 |</a> fprintf( stderr, "%-21s: %s\n", list[i], *wptr);
<a name="line572">572 |</a> }
<a name="line573">573 |</a> wptr++;
<a name="line574">574 |</a> }
<a name="line575">575 |</a> }
<a name="line576">576 |</a>
<a name="line577">577 |</a> /**
<a name="line578">578 |</a> ** Remove the Tcl interpreter that has been used for printing ...
<a name="line579">579 |</a> **/
<a name="line580">580 |</a>
<a name="line581">581 |</a> Tcl_DeleteInterp( whatis_interp);
<a name="line582">582 |</a> cmdModuleWhatisShut();
<a name="line583">583 |</a>
<a name="line584">584 |</a> } /** for( i) **/
<a name="line585">585 |</a>
<a name="line586">586 |</a> /**
<a name="line587">587 |</a> ** Cleanup
<a name="line588">588 |</a> **/
<a name="line589">589 |</a> g_flags &amp;= ~M_WHATIS;
<a name="line590">590 |</a> delete_dirlst( dirlst_head, count);
<a name="line591">591 |</a> delete_cache_list( list, start);
<a name="line592">592 |</a>
<a name="line593">593 |</a> #if WITH_DEBUGGING_UTIL_1
<a name="line594">594 |</a> ErrorLogger( NO_ERR_END, LOC, _proc_whatis_dir, NULL);
<a name="line595">595 |</a> #endif
<a name="line596">596 |</a>
<a name="line597">597 |</a> return( result); /** ------- EXIT (result) --------&gt; **/
<a name="line598">598 |</a>
<a name="line599">599 |</a> unwind2:
<a name="line600">600 |</a> delete_cache_list( list, start);
<a name="line601">601 |</a> unwind1:
<a name="line602">602 |</a> delete_dirlst( dirlst_head, count);
<a name="line603">603 |</a> unwind0:
<a name="line604">604 |</a> return( TCL_ERROR); /** ------- EXIT (FAILURE) --------&gt; **/
<a name="line605">605 |</a>
<a name="line606">606 |</a> } /** End of 'whatis_dir' **/
<a name="line607">607 |</a>
<a name="line608">608 |</a> /*++++
<a name="line609">609 |</a> ** ** Function-Header ***************************************************** **
<a name="line610">610 |</a> ** **
<a name="line611">611 |</a> ** Function: read_cache **
<a name="line612">612 |</a> ** **
<a name="line613">613 |</a> ** Description: Grep in the cache file for the passed tokens **
<a name="line614">614 |</a> ** **
<a name="line615">615 |</a> ** First Edition: 1991/10/23 **
<a name="line616">616 |</a> ** **
<a name="line617">617 |</a> ** Parameters: int argc Number of tokens **
<a name="line618">618 |</a> ** char **argv List of tokens to check **
<a name="line619">619 |</a> ** FILE *cfp Cache file pointer **
<a name="line620">620 |</a> ** **
<a name="line621">621 |</a> ** Result: int TCL_OK Successfull operation **
<a name="line622">622 |</a> ** **
<a name="line623">623 |</a> ** Attached Globals: - **
<a name="line624">624 |</a> ** **
<a name="line625">625 |</a> ** ************************************************************************ **
<a name="line626">626 |</a> ++++*/
<a name="line627">627 |</a>
<a name="line628">628 |</a> static int read_cache( int argc, char **argv, FILE *cfp, int whatis_list)
<a name="line629">629 |</a> {
<a name="line630">630 |</a> char *wptr, *c;
<a name="line631">631 |</a> char modulefile[ MOD_BUFSIZE];
<a name="line632">632 |</a> char buffer[ MOD_BUFSIZE];
<a name="line633">633 |</a> int k;
<a name="line634">634 |</a>
<a name="line635">635 |</a> #if WITH_DEBUGGING_UTIL_1
<a name="line636">636 |</a> /*
<a name="line637">637 |</a> ErrorLogger( NO_ERR_START, LOC, _proc_read_cache, "dir='", dir, NULL);
<a name="line638">638 |</a> */
<a name="line639">639 |</a> #endif
<a name="line640">640 |</a>
<a name="line641">641 |</a> while( wptr = fgets( buffer, MOD_BUFSIZE, cfp)) {
<a name="line642">642 |</a>
<a name="line643">643 |</a> /**
<a name="line644">644 |</a> ** Ingnore case?
<a name="line645">645 |</a> **/
<a name="line646">646 |</a>
<a name="line647">647 |</a> if( sw_icase) {
<a name="line648">648 |</a> strncpy( modulefile, wptr, MOD_BUFSIZE);
<a name="line649">649 |</a> for( c = modulefile; c &amp;&amp; *c; c++)
<a name="line650">650 |</a> *c = tolower( *c);
<a name="line651">651 |</a> c = modulefile;
<a name="line652">652 |</a> } else
<a name="line653">653 |</a> c = wptr;
<a name="line654">654 |</a>
<a name="line655">655 |</a> c = strchr( c, ':');
<a name="line656">656 |</a> c++;
<a name="line657">657 |</a>
<a name="line658">658 |</a> /**
<a name="line659">659 |</a> ** Seek for the passed tokens
<a name="line660">660 |</a> **/
<a name="line661">661 |</a>
<a name="line662">662 |</a> if ( whatis_list)
<a name="line663">663 |</a> fprintf( stderr, "%s", wptr);
<a name="line664">664 |</a> else
<a name="line665">665 |</a> for( k=0; k&lt;argc; k++)
<a name="line666">666 |</a> if( strstr( c, argv[ k]))
<a name="line667">667 |</a> fprintf( stderr, "%s", wptr);
<a name="line668">668 |</a> }
<a name="line669">669 |</a>
<a name="line670">670 |</a> #if WITH_DEBUGGING_UTIL_1
<a name="line671">671 |</a> ErrorLogger( NO_ERR_END, LOC, _proc_read_cache, NULL);
<a name="line672">672 |</a> #endif
<a name="line673">673 |</a>
<a name="line674">674 |</a> return( TCL_OK);
<a name="line675">675 |</a>
<a name="line676">676 |</a> } /** End of 'read_cache' **/
<a name="line677">677 |</a>
<a name="line678">678 |</a> /*++++
<a name="line679">679 |</a> ** ** Function-Header ***************************************************** **
<a name="line680">680 |</a> ** **
<a name="line681">681 |</a> ** Function: apropos_cache **
<a name="line682">682 |</a> ** **
<a name="line683">683 |</a> ** Description: Figure out, what's the name of the apropos cache file**
<a name="line684">684 |</a> ** **
<a name="line685">685 |</a> ** First Edition: 1991/10/23 **
<a name="line686">686 |</a> ** **
<a name="line687">687 |</a> ** Parameters: - **
<a name="line688">688 |</a> ** **
<a name="line689">689 |</a> ** Result: char* NULL No cache file configured **
<a name="line690">690 |</a> ** Otherwise Pointer to the file name **
<a name="line691">691 |</a> ** **
<a name="line692">692 |</a> ** Attached Globals: - **
<a name="line693">693 |</a> ** **
<a name="line694">694 |</a> ** ************************************************************************ **
<a name="line695">695 |</a> ++++*/
<a name="line696">696 |</a>
<a name="line697">697 |</a> static char *apropos_cache()
<a name="line698">698 |</a> {
<a name="line699">699 |</a> char *buffer, *env, *env_file, *env_path;
<a name="line700">700 |</a>
<a name="line701">701 |</a> #if WITH_DEBUGGING_UTIL_1
<a name="line702">702 |</a> /*
<a name="line703">703 |</a> ErrorLogger( NO_ERR_START, LOC, _proc_apropos_cache, "dir='", dir, NULL);
<a name="line704">704 |</a> */
<a name="line705">705 |</a> #endif
<a name="line706">706 |</a>
<a name="line707">707 |</a> /**
<a name="line708">708 |</a> ** Figure out, what out global RC file is. This depends on the environ-
<a name="line709">709 |</a> ** ment variable 'MODULEWHATISCACHE', which can be set to one of the
<a name="line710">710 |</a> ** following:
<a name="line711">711 |</a> **
<a name="line712">712 |</a> ** &lt;filename&gt; --&gt; PREFIX/etc/&lt;filename&gt;
<a name="line713">713 |</a> ** &lt;dir&gt;/ --&gt; &lt;dir&gt;/RC_FILE
<a name="line714">714 |</a> ** &lt;dir&gt;/&lt;file&gt; --&gt; &lt;dir&gt;/&lt;file&gt;
<a name="line715">715 |</a> **/
<a name="line716">716 |</a>
<a name="line717">717 |</a> if( env = getenv( "MODULEWHATISCACHE")) {
<a name="line718">718 |</a>
<a name="line719">719 |</a> if((char *) NULL == (env_file = strrchr( env, '/'))) {
<a name="line720">720 |</a> env_file = env;
<a name="line721">721 |</a> env_path = instpath;
<a name="line722">722 |</a>
<a name="line723">723 |</a> } else {
<a name="line724">724 |</a> *env_file++ = '\0';
<a name="line725">725 |</a> env_path = env;
<a name="line726">726 |</a> }
<a name="line727">727 |</a>
<a name="line728">728 |</a> if( !*env_file)
<a name="line729">729 |</a> env_file = cache_name;
<a name="line730">730 |</a>
<a name="line731">731 |</a> } else {
<a name="line732">732 |</a> env_path = instpath;
<a name="line733">733 |</a> env_file = cache_name;
<a name="line734">734 |</a> }
<a name="line735">735 |</a>
<a name="line736">736 |</a> /**
<a name="line737">737 |</a> ** Finaly we have to change PREFIX -&gt; PREFIX/etc
<a name="line738">738 |</a> **/
<a name="line739">739 |</a> if( env_path == instpath) {
<a name="line740">740 |</a> if((char *) NULL == (buffer = stringer(NULL,0,
<a name="line741">741 |</a> env_path,"/etc/",env_file,NULL)))
<a name="line742">742 |</a> goto unwind0;
<a name="line743">743 |</a> } else {
<a name="line744">744 |</a> if((char *) NULL == (buffer = stringer(NULL,0,
<a name="line745">745 |</a> env_path,"/",env_file,NULL)))
<a name="line746">746 |</a> goto unwind0;
<a name="line747">747 |</a> }
<a name="line748">748 |</a>
<a name="line749">749 |</a> /**
<a name="line750">750 |</a> ** Return the name of the cache file
<a name="line751">751 |</a> **/
<a name="line752">752 |</a> #if WITH_DEBUGGING_UTIL_1
<a name="line753">753 |</a> ErrorLogger( NO_ERR_END, LOC, _proc_apropos_cache, NULL);
<a name="line754">754 |</a> #endif
<a name="line755">755 |</a>
<a name="line756">756 |</a> return( buffer);
<a name="line757">757 |</a>
<a name="line758">758 |</a> unwind0:
<a name="line759">759 |</a> return (char *) NULL;
<a name="line760">760 |</a> } /** End of 'apropos_cache' **/
</pre>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink