Debian Codegraph @

vms/man2help.c

raw
1 /* Copyright (C) The libssh2 project and its contributors.
2 *
3 * SPDX-License-Identifier: BSD-3-Clause
4 */
5
6 #include <stdio.h>
7 #include <stdlib.h>
8 #include <string.h>
9 #include <ctype.h>
10 #include <errno.h>
11
12 #include <starlet.h>
13 #include <lib$routines.h>
14 #include <ssdef.h>
15 #include <descrip.h>
16 #include <rms.h>
17
18 typedef struct manl {
19 struct manl *next;
20 char *filename;
21 } man, *manPtr;
22
23 typedef struct pf_fabnam {
24 struct FAB dfab;
25 struct RAB drab;
26 struct namldef dnam;
27 char expanded_filename[NAM$C_MAXRSS + 1];
28 } pfn, *pfnPtr;
29
30 /*----------------------------------------------------------*/
31
32 fpcopy(char *output, char *input, int len)
33 {
34 char *is, *os;
35 int i;
36
37 if(len) {
38 for(is = input, os = output, i = 0; i < len; ++i, ++is, ++os) {
39 *os = *is;
40 }
41 *os = 0;
42 }
43 else {
44 output[0] = 0;
45 }
46 }
47
48
49 /*----------------------------------------------------------*/
50 /* give part of ilename in partname. See code for proper
51 value of i ( 0 = node, 1 = dev, 2 = dir, 3 = name etc.
52 */
53
54 int fnamepart(char *inputfile, char *part, int whatpart)
55 {
56 pfnPtr pf;
57 int status;
58 char ipart[6][256], *i, *p;
59
60 pf = calloc(1, sizeof(pfn));
61
62 pf->dfab = cc$rms_fab;
63 pf->drab = cc$rms_rab;
64 pf->dnam = cc$rms_naml;
65
66 pf->dfab.fab$l_naml = &pf->dnam;
67
68 pf->dfab.fab$l_fna = (char *) -1;
69 pf->dfab.fab$l_dna = (char *) -1;
70 pf->dfab.fab$b_fns = 0;
71 pf->dfab.fab$w_ifi = 0;
72
73 pf->dnam.naml$l_long_defname = NULL; /* inputfile; */
74 pf->dnam.naml$l_long_defname_size = 0; /* strlen(inputfile); */
75
76 pf->dnam.naml$l_long_filename = inputfile;
77 pf->dnam.naml$l_long_filename_size = strlen(inputfile);
78
79 pf->dnam.naml$l_long_expand = pf->expanded_filename;
80 pf->dnam.naml$l_long_expand_alloc = NAM$C_MAXRSS;
81
82 pf->dnam.naml$b_nop |= NAML$M_SYNCHK | NAML$M_PWD;
83
84 status = sys$parse(&pf->dfab, 0, 0);
85 if(!(status&1)) {
86 free(pf);
87 return status;
88 }
89
90 fpcopy(ipart[0], pf->dnam.naml$l_long_node,
91 pf->dnam.naml$l_long_node_size);
92 fpcopy(ipart[1], pf->dnam.naml$l_long_dev,
93 pf->dnam.naml$l_long_dev_size);
94 fpcopy(ipart[2], pf->dnam.naml$l_long_dir,
95 pf->dnam.naml$l_long_dir_size);
96 fpcopy(ipart[3], pf->dnam.naml$l_long_name,
97 pf->dnam.naml$l_long_name_size);
98 fpcopy(ipart[4], pf->dnam.naml$l_long_type,
99 pf->dnam.naml$l_long_type_size);
100 fpcopy(ipart[5], pf->dnam.naml$l_long_ver,
101 pf->dnam.naml$l_long_ver_size);
102
103 for(i = ipart[whatpart], p = part; *i; ++i, ++p) {
104 if(p == part) {
105 *p = toupper(*i);
106 }
107 else {
108 *p = tolower(*i);
109 }
110 }
111 *p = 0;
112
113 free(pf);
114 return 1;
115 }
116 /*----------------------------------------------------------*/
117
118 int find_file(char *filename, char *gevonden, int *findex)
119 {
120 int status;
121 struct dsc$descriptor gevondend;
122 struct dsc$descriptor filespec;
123 char gevonden_file[NAM$C_MAXRSS + 1];
124
125 filespec.dsc$w_length = strlen(filename);
126 filespec.dsc$b_dtype = DSC$K_DTYPE_T;
127 filespec.dsc$b_class = DSC$K_CLASS_S;
128 filespec.dsc$a_pointer = filename;
129
130 gevondend.dsc$w_length = NAM$C_MAXRSS;
131 gevondend.dsc$b_dtype = DSC$K_DTYPE_T;
132 gevondend.dsc$b_class = DSC$K_CLASS_S;
133 gevondend.dsc$a_pointer = gevonden_file;
134
135 status = lib$find_file(&filespec, &gevondend, findex, 0, 0, 0, 0);
136
137 if((status & 1) == 1) {
138 /* !checksrc! disable BANNEDFUNC 1 */ /* FIXME */
139 strcpy(gevonden, strtok(gevonden_file, " "));
140 }
141 else {
142 gevonden[0] = 0;
143 }
144
145 return status;
146 }
147
148
149 /*--------------------------------------------*/
150
151 manPtr addman(manPtr *manroot, char *filename)
152 {
153 manPtr m, f;
154
155 m = calloc(1, sizeof(man));
156 if(!m)
157 return NULL;
158
159 m->filename = strdup(filename);
160
161 if(!*manroot) {
162 *manroot = m;
163 }
164 else {
165 for(f = *manroot; f->next; f = f->next)
166 ;
167 f->next = m;
168 }
169 return m;
170 }
171
172 /*--------------------------------------------*/
173 void freeman(manPtr *manroot)
174 {
175 manPtr m, n;
176
177 for(m = *manroot; m; m = n) {
178 free(m->filename);
179 n = m->next;
180 free(m);
181 }
182 *manroot = NULL;
183 }
184
185 /*--------------------------------------------*/
186
187 int listofmans(char *filespec, manPtr *manroot)
188 {
189 manPtr r;
190 int status;
191 int ffindex = 0;
192 char gevonden[NAM$C_MAXRSS + 1];
193
194 for(;;) {
195 status = find_file(filespec, gevonden, &ffindex);
196
197 if((status&1)) {
198 r = addman(manroot, gevonden);
199 if(!r)
200 return 2;
201 }
202 else {
203 if(!(status&1))
204 break;
205 }
206 }
207
208 lib$find_file_end(&ffindex);
209 if(status == RMS$_NMF)
210 status = 1;
211
212 return status;
213 }
214
215 /*--------------------------------------------*/
216
217 int convertman(char *filespec, FILE *hlp, int base_level, int add_parentheses)
218 {
219 FILE *man;
220 char *in, *uit;
221 char *m, *h;
222 size_t len, thislen, maxlen = 50000;
223 int bol, mode, return_status = 1;
224 char subjectname[NAM$C_MAXRSS + 1];
225
226 in = calloc(1, maxlen + 1);
227 uit = calloc(1, maxlen + 1);
228
229 if(!in || !uit)
230 return 2;
231
232 man = fopen(filespec, "r");
233 if(!man)
234 return vaxc$errno;
235
236 for(len = 0; !feof(man) && len < maxlen; len += thislen) {
237 thislen = fread(in + len, 1, maxlen - len, man);
238 }
239
240 fclose(man);
241
242 m = in;
243 h = uit;
244
245 *(m + len) = 0;
246
247 for(mode = 0, bol = 1; *m; ++m) {
248
249 switch(mode) {
250 case 0:
251 switch(*m) {
252 case '.':
253 if(bol) {
254 mode = 1;
255 }
256 else {
257 *h = *m;
258 ++h;
259 }
260 break;
261 case '\\':
262 if(bol) {
263 *h = ' '; ++h;
264 *h = ' '; ++h;
265 }
266 mode = 2;
267 break;
268 default:
269 if(bol) {
270 *h = ' '; ++h;
271 *h = ' '; ++h;
272 }
273 *h = *m;
274 ++h;
275 break;
276 }
277 break;
278
279 case 1: /* after . at bol */
280 switch(*m) {
281 case '\\':
282 while(*m != '\n' && *m != '\r' && *m)
283 ++m;
284 mode = 0;
285 break;
286 case 'B':
287 ++m;
288 *h = ' '; ++h;
289 mode = 0;
290 break;
291 case 'I':
292 /* remove preceding eol */
293 if(*(m + 1) != 'P') {
294 --h;
295 while((*h == '\n' || *h == '\r') && h > uit)
296 --h;
297 ++h;
298 }
299
300 /* skip .Ix */
301 for(; *m != ' ' && *m != '\n' && *m != '\r'; ++m)
302 ;
303
304 /* copy line up to EOL */
305
306 for(; *m != '\n' && *m != '\r' && *m; ++m, ++h)
307 *h = *m;
308
309 /* if line ends in ., this is an EOL */
310
311 if(*(h-1) == '.') {
312 --h;
313 --m;
314 }
315 else {
316 /* if line does not end in ., skip EOL in source */
317
318 if(*(m + 1) == '\n' || *(m + 1) == '\r')
319 ++m;
320 }
321 mode = 0;
322 break;
323 case 'S':
324 if(*(m + 1) == 'H') {
325 *h = '\n';++h;
326 if(strncmp(m + 3, "NAME", 4) == 0 ||
327 strncmp(m + 3, "SYNOPSIS", 8) == 0 ||
328 strncmp(m + 3, "DESCRIPTION", 11) == 0) {
329 while(*m != '\n' && *m != '\r')
330 ++m;
331 mode = 0;
332 }
333 else {
334 ++m;
335
336 /* write help level, and flag it */
337
338 *h = '0' + base_level + 1; ++h;
339 return_status |= 2;
340
341 *h = ' '; ++h;
342
343 /* skip H (or whatever after S) and blank */
344 ++m; ++m;
345
346 for(; *m != '\n' && *m != '\r' && *m; ++m, ++h) {
347
348 /* write help label in lowercase, skip quotes */
349 /* fill blanks with underscores */
350
351 if(*m != '\"') {
352 *h = tolower(*m);
353 if(*h == ' ')
354 *h = '_';
355 }
356 else {
357 --h;
358 }
359 }
360
361 /* Add a linefeed or two */
362
363 *h = *m; ++h;
364 *h = *m; ++h;
365
366 mode = 0;
367 }
368 }
369 break;
370 case 'T':
371 if(*(m + 1) == 'H') {
372 *h = '0' + base_level; ++h;
373 return_status |= 2;
374 *h = ' '; ++h;
375 for(m = m + 3; *m != ' ' && *m; ++m, ++h) {
376 *h = *m;
377 }
378 if(add_parentheses) {
379 *h = '('; ++h;
380 *h = ')'; ++h;
381 }
382 while(*m != '\n' && *m != '\r' && *m)
383 ++m;
384 mode = 0;
385 }
386 break;
387 default:
388 ++m;
389 mode = 0;
390 break;
391 }
392 break;
393 case 2: /* after \ skip two characters or print the backslash */
394 switch(*m) {
395 case '\\':
396 *h = *m;
397 ++h;
398 mode = 0;
399 break;
400 default:
401 ++m;
402 mode = 0;
403 break;
404 }
405 break;
406 } /* end switch mode */
407
408 bol = 0;
409 if(*m == '\n' || *m == '\r')
410 bol = 1;
411
412 } /* end for mode */
413
414 *h = 0;
415
416
417 if(return_status & 2) {
418 fprintf(hlp, "%s\n\n", uit);
419 }
420 else {
421 fnamepart(filespec, subjectname, 3);
422 if(*subjectname) {
423 fprintf(hlp, "%d %s\n\n%s\n\n", base_level, subjectname, uit);
424 }
425 else {
426 /* No filename (as is the case with a logical),
427 use first word as subject name */
428 char *n, *s;
429
430 for(n = in; isspace(*n); ++n)
431 ;
432 for(s = subjectname; !(isspace(*n)); ++n, ++s)
433 *s = *n;
434 *s = 0;
435
436 fprintf(hlp, "%d %s\n\n%s\n\n", base_level, subjectname, uit);
437 }
438 }
439
440 /*
441 printf("read %d from %s, written %d to helpfile, return_status = %d\n",
442 len, filespec, strlen(uit), return_status);
443 */
444
445 free(m);
446 free(h);
447
448 return 1;
449 }
450
451 /*--------------------------------------------*/
452
453 int convertmans(char *filespec, char *hlpfilename, int base_level, int append,
454 int add_parentheses)
455 {
456 int status = 1;
457 manPtr manroot = NULL, m;
458 FILE *hlp;
459
460 if(append) {
461 hlp = fopen(hlpfilename, "a+");
462 }
463 else {
464 hlp = fopen(hlpfilename, "w");
465 }
466
467 if(!hlp)
468 return vaxc$errno;
469
470 status = listofmans(filespec, &manroot);
471 if(!(status&1))
472 return status;
473
474 for(m = manroot; m; m = m->next) {
475 status = convertman(m->filename, hlp, base_level, add_parentheses);
476 if(!(status&1)) {
477 fprintf(stderr, "Convertman of %s went wrong\n", m->filename);
478 break;
479 }
480 }
481 freeman(&manroot);
482 return status;
483 }
484
485 /*--------------------------------------------*/
486 void print_help(void)
487 {
488 fprintf(stderr,
489 "Usage: [-a] [-b x] convertman <manfilespec> <helptextfile>\n"
490 " -a append <manfilespec> to <helptextfile>\n"
491 " -b <baselevel> if no headers found create one "
492 "with level <baselevel>\n"
493 " and the filename as title.\n"
494 " -p add parentheses() to baselevel help items.\n");
495 }
496 /*--------------------------------------------*/
497
498 main(int argc, char **argv)
499 {
500 int status;
501 int i, j;
502 int append, base_level, basechange, add_parentheses;
503 char *manfile = NULL;
504 char *helpfile = NULL;
505
506 if(argc < 3) {
507 print_help();
508 return 1;
509 }
510
511 append = 0;
512 base_level = 1;
513 basechange = 0;
514 add_parentheses = 0;
515
516 for(i = 1; i < argc; ++i) {
517 if(argv[i][0] == '-') {
518 for(j = 1; argv[i][j]; ++j) {
519 switch(argv[i][j]) {
520 case 'a':
521 append = 1;
522 break;
523 case 'b':
524 if((i + 1) < argc) {
525 base_level = atoi(argv[i + 1]);
526 basechange = 1;
527 }
528 break;
529 case 'p':
530 add_parentheses = 1;
531 break;
532 }
533 }
534 if(basechange) {
535 basechange = 0;
536 i = i + 1;
537 }
538 }
539 else {
540 if(!manfile) {
541 manfile = strdup(argv[i]);
542 }
543 else if(!helpfile) {
544 helpfile = strdup(argv[i]);
545 }
546 else {
547 fprintf(stderr, "Unrecognized parameter : %s\n", argv[i]);
548 }
549 }
550 }
551
552 /*
553 fprintf(stderr,"manfile: %s, helpfile: %s, append: %d, base_level : %d\n",
554 manfile, helpfile, append, base_level);
555 */
556
557 status = convertmans(manfile, helpfile, base_level, append,
558 add_parentheses);
559
560 free(manfile);
561 free(helpfile);
562
563 return status;
564 }