File: tfm.c

package info (click to toggle)
emboss 6.6.0+dfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 571,248 kB
  • ctags: 39,971
  • sloc: ansic: 460,578; java: 29,439; perl: 13,573; sh: 12,740; makefile: 3,275; csh: 706; asm: 351; xml: 239; pascal: 237; modula3: 8
file content (368 lines) | stat: -rw-r--r-- 8,915 bytes parent folder | download | duplicates (3)
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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
/* @source tfm application
**
** Displays a program's help documentation manual
**
** @author Copyright (C) Gary Williams (gwilliam@hgmp.mrc.ac.uk)
** @@
**
** This program is free software; you can redistribute it and/or
** modify it under the terms of the GNU General Public License
** as published by the Free Software Foundation; either version 2
** of the License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
******************************************************************************/

#include "emboss.h"


static void tfm_FindAppDocRoot(const AjPStr program, AjPStr* docroot,
			       AjBool html);
static AjBool tfm_FindAppDoc(const AjPStr program, const AjPStr docroot,
			     AjBool html, AjPStr* path);
static void tfm_FixImages(AjPStr *line, const AjPStr path);




/* @prog tfm ******************************************************************
**
** Displays a program's help documentation manual
**
******************************************************************************/

int main(int argc, char **argv)
{

    AjPFile outfile = NULL;
    AjPStr program  = NULL;
    AjBool html;
    AjBool more;
    AjPStr path = NULL;			/* path of file to be displayed */
    AjPStr cmd  = NULL;			/* command line for running 'more' */
    AjPFile infile  = NULL;
    AjPStr  line    = NULL;		/* buffer for infile lines */
    AjPStr  pager   = NULL;
    AjPStr  docroot = NULL;
    
    char *shellpager = NULL;

    embInit("tfm", argc, argv);
    
    program = ajAcdGetString("program");
    outfile = ajAcdGetOutfile("outfile");
    html    = ajAcdGetBoolean("html");
    more    = ajAcdGetBoolean("more");

    cmd     = ajStrNew();
    path    = ajStrNew();
    pager   = ajStrNew();
    line    = ajStrNew();
    docroot = ajStrNew();
    

    tfm_FindAppDocRoot(program, &docroot, html);
    
    /* is a search string specified - should be tested in tfm.acd file */
    if(!ajStrGetLen(program))
	ajFatal("No program name specified.");
    
    if(!tfm_FindAppDoc(program, docroot, html, &path))
	ajDie("No documentation found in %S for program '%S'.",
	      docroot,program);
    
    /* outputing to STDOUT and piping through 'more'? */
    if(ajFileIsStdout(outfile) && more)
    {
	if(!ajNamGetValueC("PAGER",&pager))
	{
	    shellpager = getenv("PAGER");
	    if(shellpager)
		ajStrAssignC(&pager,shellpager);
	    if(!ajStrGetLen(pager))
		ajStrAssignC(&pager,"pager");
	}
	ajFmtPrintS(&cmd,"%S %S",pager,path);
	ajSysExecPathS(cmd);
    }
    else
    {
	/* output file as-is */
	infile = ajFileNewInNameS(path);

	while(ajReadline(infile, &line))
	{
	    if(html)
		tfm_FixImages(&line,docroot);
	    ajFmtPrintF(outfile, "%S", line);
	}

	ajFileClose(&infile);
    }
    
    ajFileClose(&outfile);


    ajStrDel(&path);
    ajStrDel(&pager);
    ajStrDel(&line);
    ajStrDel(&cmd);
    ajStrDel(&program);
    ajStrDel(&docroot);

    embExit();

    return 0;
}




/* @funcstatic tfm_FindAppDocRoot *********************************************
**
** return the path to the program doc directory
**
** @param [r] program [const AjPStr] program name
** @param [w] docroot [AjPStr*] root dir for documentation files
** @param [r] html [AjBool] whether html required
** @@
******************************************************************************/

static void tfm_FindAppDocRoot(const AjPStr program,
			       AjPStr* docroot, AjBool html)
{

    AjPStr docrootinst = NULL;
    AjPStr roottmp = NULL;
    AjPStr tmpstr = NULL;
    AjPStr embassy = NULL;
    AjPStr doctest = NULL;
    
    AjBool is_windows = ajFalse;
#ifdef WIN32
    is_windows = ajTrue;
#endif

    docrootinst = ajStrNew();
    doctest     = ajStrNew();
    roottmp     = ajStrNew();
    tmpstr      = ajStrNew();
    
    ajDebug("given  docroot '%S'\n", *docroot);
    ajNamGetValueC("docroot", &roottmp);
    ajDebug("defined docroot '%S'\n", roottmp);

    if(html)
      embGrpGetEmbassy(program, &embassy);

    /* look at EMBOSS doc files */

    /* try to open the installed doc directory */
    if(ajStrGetLen(roottmp)) 
    {
        /*
        ** Check for old-style EMBOSS_DOCROOT and adjust accordingly
        */
        ajFmtPrintS(&doctest,"%S%cprograms%ctext",roottmp,SLASH_CHAR,
                    SLASH_CHAR);
        ajStrAssignS(&docrootinst,roottmp);
        ajDirnameFix(&docrootinst);
        
        if(!ajDirnameFixExists(&doctest))
        {
            ajDirnameUp(&docrootinst);
            ajDirnameUp(&docrootinst);
        }
    }
    else
    {
	ajStrAssignS(&docrootinst, ajNamValueInstalldir());
	ajDirnameFix(&docrootinst);

	if(is_windows)
	{
	    ajFmtPrintS(&tmpstr,"%Sdoc",docrootinst);
	    if(!ajDirnameFixExists(&tmpstr))
	    {
		ajDirnameUp(&docrootinst);
		ajDirnameUp(&docrootinst);
	    }
	    ajStrAppendC(&docrootinst,"doc");
	    ajStrAppendC(&docrootinst,SLASH_STRING);
	}
	else
	    ajFmtPrintAppS(&docrootinst, "share%sEMBOSS%sdoc%s",
			SLASH_STRING,SLASH_STRING,SLASH_STRING);
    }

    if(html)
    {
	if(ajStrGetLen(embassy))
	    ajFmtPrintS(docroot,"%Shtml%sembassy%s%S%s",
			docrootinst,SLASH_STRING,SLASH_STRING,
			embassy, SLASH_STRING);
	else
	{
	    if(is_windows)
		ajFmtPrintS(docroot,"%Sprograms%shtml%s",
			    docrootinst,SLASH_STRING,SLASH_STRING);
	    else
		ajFmtPrintS(docroot,"%Sprograms%shtml%s",
			    docrootinst,SLASH_STRING,SLASH_STRING);
	}
    }
    else
	    ajFmtPrintS(docroot,"%Sprograms%stext%s",docrootinst,SLASH_STRING,
			SLASH_STRING);

    ajDirnameFix(docroot);
    ajDebug("installed docroot '%S'\n", *docroot);

    if(!ajDirnameFixExists(docroot) && !is_windows)
    {
	/*
	**  if that didn't work then try the doc directory from the
	**  distribution tarball
	*/
	ajStrAssignS(docroot, ajNamValueRootdir());
	ajDirnameFix(docroot);

	if(ajStrGetLen(embassy))
	{
	  if(ajDirnameFixExists(docroot))
	    ajFmtPrintS(docroot, "embassy/%S/emboss_doc/", embassy);
	  if(html)
	    {
	      ajStrAppendC(docroot, "html/");
	    }
	  else
	    {
	      ajStrAppendC(docroot, "text/");
	    }
	}
	else
	{
	  if(ajDirnameFixExists(docroot))
	    ajStrAppendC(docroot, "doc/programs/");
	  if(html)
	    {
	      ajStrAppendC(docroot, "html/");
	    }
	  else
	    {
	      ajStrAppendC(docroot, "text/");
	    }
	}
    }

    ajStrDel(&roottmp);
    ajStrDel(&docrootinst);
    ajStrDel(&doctest);
    ajStrDel(&tmpstr);
    
    return;
}




/* @funcstatic tfm_FindAppDoc *************************************************
**
** return the path to the program documentation html or text file
**
** @param [r] program [const AjPStr] program name
** @param [r] docroot [const AjPStr] documentation root
** @param [r] html [AjBool] whether html required
** @param [w] path [AjPStr*] returned path
** @return [AjBool] success
** @@
******************************************************************************/

static AjBool tfm_FindAppDoc(const AjPStr program, const AjPStr docroot,
			     AjBool html, AjPStr* path)
{
    ajStrAssignS(path, docroot);
    ajStrAppendS(path, program);

    if(html)
	ajStrAppendC(path, ".html");
    else
	ajStrAppendC(path, ".txt");

    /* does the file exist and is it readable? */

    return ajFilenameExistsRead(*path);
}




/* @funcstatic tfm_FixImages *************************************************
**
** Add full path to installed or local image files
**
** @param [w] line [AjPStr*] html line
** @param [r] path [const AjPStr] file location
** @return [void]
** @@
******************************************************************************/

static void tfm_FixImages(AjPStr *line, const AjPStr path)
{
    AjPStr newpath = NULL;
    AjPStr name = NULL;
    AjPStr pre  = NULL;
    AjPStr post = NULL;
    
    const char *p    = NULL;
    const char *q    = NULL;

#ifdef __CYGWIN__
    char *root = NULL;
#endif

    q = ajStrGetPtr(*line);

    if(!(p = strstr(q,"<img")))
	return;

    if(!(p=strstr(p,"src=")))
	return;

    newpath = ajStrNewC("");
    name    = ajStrNew();
    pre     = ajStrNew();
    post    = ajStrNew();
    
#ifdef __CYGWIN__
    if((root=getenv("EMBOSSCYGROOT")))
	ajFmtPrintS(&newpath,"%s",root);
#endif

    ajStrAppendS(&newpath,path);

    ajStrAssignSubC(&pre,q,0,(ajint)(p-q)+4);
    p += 5;
    while(*p && *p!='"')
    {
	ajStrAppendK(&name,*p);
	++p;
    }
    ajStrAssignC(&post,p);

    ajFmtPrintS(line,"%Sfile:/%S%S%S",pre,newpath,name,post);

    ajStrDel(&newpath);
    ajStrDel(&name);
    ajStrDel(&post);
    ajStrDel(&pre);
    
    return;
}