Annotation of mandoc/mandoc-db.c, Revision 1.15
1.15 ! kristaps 1: /* $Id: mandoc-db.c,v 1.14 2011/05/01 11:56:26 kristaps Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4: *
5: * Permission to use, copy, modify, and distribute this software for any
6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
8: *
9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16: */
1.2 kristaps 17: #ifdef HAVE_CONFIG_H
18: #include "config.h"
19: #endif
20:
1.1 kristaps 21: #include <sys/param.h>
22:
23: #include <assert.h>
24: #ifdef __linux__
25: # include <db_185.h>
26: #else
27: # include <db.h>
28: #endif
29: #include <fcntl.h>
30: #include <getopt.h>
31: #include <stdio.h>
32: #include <stdint.h>
33: #include <stdlib.h>
34: #include <string.h>
35:
36: #include "man.h"
37: #include "mdoc.h"
38: #include "mandoc.h"
39:
40: #define MANDOC_DB "mandoc.db"
1.3 kristaps 41: #define MANDOC_IDX "mandoc.index"
1.2 kristaps 42: #define MANDOC_BUFSZ BUFSIZ
1.3 kristaps 43: #define MANDOC_FLAGS O_CREAT|O_TRUNC|O_RDWR
1.1 kristaps 44:
45: enum type {
46: MANDOC_NONE = 0,
47: MANDOC_NAME,
48: MANDOC_FUNCTION,
49: MANDOC_UTILITY,
50: MANDOC_INCLUDES,
1.13 kristaps 51: MANDOC_VARIABLE,
52: MANDOC_STANDARD
1.1 kristaps 53: };
54:
1.6 kristaps 55: #define MAN_ARGS DB *db, \
56: const char *dbn, \
57: DBT *key, size_t *ksz, \
58: DBT *val, \
1.11 kristaps 59: DBT *rval, size_t *rsz, \
1.6 kristaps 60: const struct man_node *n
1.1 kristaps 61: #define MDOC_ARGS DB *db, \
62: const char *dbn, \
63: DBT *key, size_t *ksz, \
64: DBT *val, \
1.11 kristaps 65: DBT *rval, size_t *rsz, \
1.1 kristaps 66: const struct mdoc_node *n
67:
68: static void dbt_append(DBT *, size_t *, const char *);
69: static void dbt_appendb(DBT *, size_t *,
70: const void *, size_t);
71: static void dbt_init(DBT *, size_t *);
1.8 kristaps 72: static void dbt_put(DB *, const char *, DBT *, DBT *);
1.1 kristaps 73: static void usage(void);
1.11 kristaps 74: static void pman(DB *, const char *, DBT *, size_t *,
75: DBT *, DBT *, size_t *, struct man *);
1.6 kristaps 76: static int pman_node(MAN_ARGS);
1.11 kristaps 77: static void pmdoc(DB *, const char *, DBT *, size_t *,
78: DBT *, DBT *, size_t *, struct mdoc *);
1.1 kristaps 79: static void pmdoc_node(MDOC_ARGS);
80: static void pmdoc_Fd(MDOC_ARGS);
81: static void pmdoc_In(MDOC_ARGS);
82: static void pmdoc_Fn(MDOC_ARGS);
83: static void pmdoc_Fo(MDOC_ARGS);
1.11 kristaps 84: static void pmdoc_Nd(MDOC_ARGS);
1.1 kristaps 85: static void pmdoc_Nm(MDOC_ARGS);
1.13 kristaps 86: static void pmdoc_St(MDOC_ARGS);
1.1 kristaps 87: static void pmdoc_Vt(MDOC_ARGS);
88:
89: typedef void (*pmdoc_nf)(MDOC_ARGS);
90:
91: static const char *progname;
92:
93: static const pmdoc_nf mdocs[MDOC_MAX] = {
94: NULL, /* Ap */
95: NULL, /* Dd */
96: NULL, /* Dt */
97: NULL, /* Os */
98: NULL, /* Sh */
99: NULL, /* Ss */
100: NULL, /* Pp */
101: NULL, /* D1 */
102: NULL, /* Dl */
103: NULL, /* Bd */
104: NULL, /* Ed */
105: NULL, /* Bl */
106: NULL, /* El */
107: NULL, /* It */
108: NULL, /* Ad */
109: NULL, /* An */
110: NULL, /* Ar */
111: NULL, /* Cd */
112: NULL, /* Cm */
113: NULL, /* Dv */
114: NULL, /* Er */
115: NULL, /* Ev */
116: NULL, /* Ex */
117: NULL, /* Fa */
118: pmdoc_Fd, /* Fd */
119: NULL, /* Fl */
120: pmdoc_Fn, /* Fn */
121: NULL, /* Ft */
122: NULL, /* Ic */
123: pmdoc_In, /* In */
124: NULL, /* Li */
1.11 kristaps 125: pmdoc_Nd, /* Nd */
1.1 kristaps 126: pmdoc_Nm, /* Nm */
127: NULL, /* Op */
128: NULL, /* Ot */
129: NULL, /* Pa */
130: NULL, /* Rv */
1.13 kristaps 131: pmdoc_St, /* St */
1.1 kristaps 132: pmdoc_Vt, /* Va */
133: pmdoc_Vt, /* Vt */
134: NULL, /* Xr */
135: NULL, /* %A */
136: NULL, /* %B */
137: NULL, /* %D */
138: NULL, /* %I */
139: NULL, /* %J */
140: NULL, /* %N */
141: NULL, /* %O */
142: NULL, /* %P */
143: NULL, /* %R */
144: NULL, /* %T */
145: NULL, /* %V */
146: NULL, /* Ac */
147: NULL, /* Ao */
148: NULL, /* Aq */
149: NULL, /* At */
150: NULL, /* Bc */
151: NULL, /* Bf */
152: NULL, /* Bo */
153: NULL, /* Bq */
154: NULL, /* Bsx */
155: NULL, /* Bx */
156: NULL, /* Db */
157: NULL, /* Dc */
158: NULL, /* Do */
159: NULL, /* Dq */
160: NULL, /* Ec */
161: NULL, /* Ef */
162: NULL, /* Em */
163: NULL, /* Eo */
164: NULL, /* Fx */
165: NULL, /* Ms */
166: NULL, /* No */
167: NULL, /* Ns */
168: NULL, /* Nx */
169: NULL, /* Ox */
170: NULL, /* Pc */
171: NULL, /* Pf */
172: NULL, /* Po */
173: NULL, /* Pq */
174: NULL, /* Qc */
175: NULL, /* Ql */
176: NULL, /* Qo */
177: NULL, /* Qq */
178: NULL, /* Re */
179: NULL, /* Rs */
180: NULL, /* Sc */
181: NULL, /* So */
182: NULL, /* Sq */
183: NULL, /* Sm */
184: NULL, /* Sx */
185: NULL, /* Sy */
186: NULL, /* Tn */
187: NULL, /* Ux */
188: NULL, /* Xc */
189: NULL, /* Xo */
190: pmdoc_Fo, /* Fo */
191: NULL, /* Fc */
192: NULL, /* Oo */
193: NULL, /* Oc */
194: NULL, /* Bk */
195: NULL, /* Ek */
196: NULL, /* Bt */
197: NULL, /* Hf */
198: NULL, /* Fr */
199: NULL, /* Ud */
200: NULL, /* Lb */
201: NULL, /* Lp */
202: NULL, /* Lk */
203: NULL, /* Mt */
204: NULL, /* Brq */
205: NULL, /* Bro */
206: NULL, /* Brc */
207: NULL, /* %C */
208: NULL, /* Es */
209: NULL, /* En */
210: NULL, /* Dx */
211: NULL, /* %Q */
212: NULL, /* br */
213: NULL, /* sp */
214: NULL, /* %U */
215: NULL, /* Ta */
216: };
217:
218: int
219: main(int argc, char *argv[])
220: {
1.2 kristaps 221: struct mparse *mp; /* parse sequence */
222: struct mdoc *mdoc; /* resulting mdoc */
1.6 kristaps 223: struct man *man; /* resulting man */
1.11 kristaps 224: char *fn; /* current file being parsed */
225: const char *msec, /* manual section */
1.10 kristaps 226: *dir; /* result dir (default: cwd) */
1.3 kristaps 227: char ibuf[MAXPATHLEN], /* index fname */
228: ibbuf[MAXPATHLEN], /* index backup fname */
229: fbuf[MAXPATHLEN], /* btree fname */
1.2 kristaps 230: fbbuf[MAXPATHLEN]; /* btree backup fname */
1.11 kristaps 231: int ch;
1.9 kristaps 232: DB *idx, /* index database */
1.3 kristaps 233: *db; /* keyword database */
234: DBT rkey, rval, /* recno entries */
235: key, val; /* persistent keyword entries */
1.11 kristaps 236: size_t sv,
237: ksz, rsz; /* entry buffer size */
238: char vbuf[8]; /* stringified record number */
1.2 kristaps 239: BTREEINFO info; /* btree configuration */
1.11 kristaps 240: recno_t rec; /* current record number */
1.1 kristaps 241: extern int optind;
242: extern char *optarg;
243:
244: progname = strrchr(argv[0], '/');
245: if (progname == NULL)
246: progname = argv[0];
247: else
248: ++progname;
249:
1.3 kristaps 250: dir = "";
1.2 kristaps 251:
1.11 kristaps 252: while (-1 != (ch = getopt(argc, argv, "d:")))
253: switch (ch) {
1.2 kristaps 254: case ('d'):
255: dir = optarg;
1.1 kristaps 256: break;
257: default:
258: usage();
259: return((int)MANDOCLEVEL_BADARG);
260: }
261:
262: argc -= optind;
263: argv += optind;
264:
265: /*
1.3 kristaps 266: * Set up temporary file-names into which we're going to write
267: * all of our data (both for the index and database). These
268: * will be securely renamed to the real file-names after we've
269: * written all of our data.
1.1 kristaps 270: */
271:
1.3 kristaps 272: ibuf[0] = ibuf[MAXPATHLEN - 2] =
273: ibbuf[0] = ibbuf[MAXPATHLEN - 2] =
274: fbuf[0] = fbuf[MAXPATHLEN - 2] =
275: fbbuf[0] = fbbuf[MAXPATHLEN - 2] = '\0';
1.2 kristaps 276:
277: strlcat(fbuf, dir, MAXPATHLEN);
278: strlcat(fbuf, MANDOC_DB, MAXPATHLEN);
1.3 kristaps 279:
1.2 kristaps 280: strlcat(fbbuf, fbuf, MAXPATHLEN);
281: strlcat(fbbuf, "~", MAXPATHLEN);
282:
1.3 kristaps 283: strlcat(ibuf, dir, MAXPATHLEN);
284: strlcat(ibuf, MANDOC_IDX, MAXPATHLEN);
285:
286: strlcat(ibbuf, ibuf, MAXPATHLEN);
287: strlcat(ibbuf, "~", MAXPATHLEN);
288:
1.2 kristaps 289: if ('\0' != fbuf[MAXPATHLEN - 2] ||
1.3 kristaps 290: '\0' != fbbuf[MAXPATHLEN - 2] ||
291: '\0' != ibuf[MAXPATHLEN - 2] ||
292: '\0' != ibbuf[MAXPATHLEN - 2]) {
293: fprintf(stderr, "%s: Path too long\n", progname);
1.1 kristaps 294: exit((int)MANDOCLEVEL_SYSERR);
295: }
296:
297: /*
1.3 kristaps 298: * For the keyword database, open a BTREE database that allows
299: * duplicates. For the index database, use a standard RECNO
300: * database type.
1.1 kristaps 301: */
302:
303: memset(&info, 0, sizeof(BTREEINFO));
304: info.flags = R_DUP;
1.3 kristaps 305: db = dbopen(fbbuf, MANDOC_FLAGS, 0644, DB_BTREE, &info);
1.1 kristaps 306:
307: if (NULL == db) {
1.2 kristaps 308: perror(fbbuf);
1.1 kristaps 309: exit((int)MANDOCLEVEL_SYSERR);
310: }
311:
1.9 kristaps 312: idx = dbopen(ibbuf, MANDOC_FLAGS, 0644, DB_RECNO, NULL);
1.1 kristaps 313:
1.3 kristaps 314: if (NULL == db) {
315: perror(ibbuf);
316: (*db->close)(db);
317: exit((int)MANDOCLEVEL_SYSERR);
318: }
1.1 kristaps 319:
320: /*
321: * Try parsing the manuals given on the command line. If we
322: * totally fail, then just keep on going. Take resulting trees
323: * and push them down into the database code.
1.3 kristaps 324: * Use the auto-parser and don't report any errors.
1.1 kristaps 325: */
326:
1.3 kristaps 327: mp = mparse_alloc(MPARSE_AUTO, MANDOCLEVEL_FATAL, NULL, NULL);
328:
1.1 kristaps 329: memset(&key, 0, sizeof(DBT));
330: memset(&val, 0, sizeof(DBT));
1.3 kristaps 331: memset(&rkey, 0, sizeof(DBT));
332: memset(&rval, 0, sizeof(DBT));
333:
334: val.size = sizeof(vbuf);
335: val.data = vbuf;
336: rkey.size = sizeof(recno_t);
337:
338: rec = 1;
1.10 kristaps 339: ksz = rsz = 0;
1.1 kristaps 340:
341: while (NULL != (fn = *argv++)) {
342: mparse_reset(mp);
1.3 kristaps 343:
1.11 kristaps 344: /* Parse and get (non-empty) AST. */
345:
1.4 kristaps 346: if (mparse_readfd(mp, -1, fn) >= MANDOCLEVEL_FATAL) {
347: fprintf(stderr, "%s: Parse failure\n", fn);
1.1 kristaps 348: continue;
1.4 kristaps 349: }
1.6 kristaps 350: mparse_result(mp, &mdoc, &man);
351: if (NULL == mdoc && NULL == man)
1.3 kristaps 352: continue;
353:
1.11 kristaps 354: /* Manual section: can be empty string. */
355:
1.10 kristaps 356: msec = NULL != mdoc ?
357: mdoc_meta(mdoc)->msec :
358: man_meta(man)->msec;
359:
1.11 kristaps 360: assert(msec);
361:
362: /*
363: * The index record value consists of a nil-terminated
364: * filename, a nil-terminated manual section, and a
365: * nil-terminated description. Since the description
366: * may not be set, we set a sentinel to see if we're
367: * going to write a nil byte in its place.
368: */
1.3 kristaps 369:
1.10 kristaps 370: dbt_init(&rval, &rsz);
371: dbt_appendb(&rval, &rsz, fn, strlen(fn) + 1);
372: dbt_appendb(&rval, &rsz, msec, strlen(msec) + 1);
1.11 kristaps 373: sv = rval.size;
1.10 kristaps 374:
1.11 kristaps 375: /* Fix the record number in the btree value. */
1.3 kristaps 376:
377: memset(val.data, 0, sizeof(uint32_t));
378: memcpy(val.data + 4, &rec, sizeof(uint32_t));
379:
1.6 kristaps 380: if (mdoc)
1.11 kristaps 381: pmdoc(db, fbbuf, &key, &ksz,
382: &val, &rval, &rsz, mdoc);
1.6 kristaps 383: else
1.11 kristaps 384: pman(db, fbbuf, &key, &ksz,
385: &val, &rval, &rsz, man);
386:
387: /*
388: * Apply this to the index. If we haven't had a
389: * description set, put an empty one in now.
390: */
391:
392: if (rval.size == sv)
393: dbt_appendb(&rval, &rsz, "", 1);
394:
395: rkey.data = &rec;
396: dbt_put(idx, ibbuf, &rkey, &rval);
397:
398: printf("Indexed: %s\n", fn);
1.3 kristaps 399: rec++;
1.1 kristaps 400: }
401:
402: (*db->close)(db);
1.9 kristaps 403: (*idx->close)(idx);
1.3 kristaps 404:
1.1 kristaps 405: mparse_free(mp);
406:
407: free(key.data);
1.10 kristaps 408: free(rval.data);
1.1 kristaps 409:
410: /* Atomically replace the file with our temporary one. */
411:
1.2 kristaps 412: if (-1 == rename(fbbuf, fbuf))
413: perror(fbuf);
1.3 kristaps 414: if (-1 == rename(ibbuf, ibuf))
415: perror(fbuf);
1.1 kristaps 416:
417: return((int)MANDOCLEVEL_OK);
418: }
419:
420: /*
421: * Initialise the stored database key whose data buffer is shared
422: * between uses (as the key must sometimes be constructed from an array
423: * of
424: */
425: static void
426: dbt_init(DBT *key, size_t *ksz)
427: {
428:
429: if (0 == *ksz) {
430: assert(0 == key->size);
431: assert(NULL == key->data);
432: key->data = mandoc_malloc(MANDOC_BUFSZ);
433: *ksz = MANDOC_BUFSZ;
434: }
435:
436: key->size = 0;
437: }
438:
439: /*
440: * Append a binary value to a database entry. This can be invoked
441: * multiple times; the buffer is automatically resized.
442: */
443: static void
444: dbt_appendb(DBT *key, size_t *ksz, const void *cp, size_t sz)
445: {
446:
447: assert(key->data);
448:
449: /* Overshoot by MANDOC_BUFSZ. */
450:
451: while (key->size + sz >= *ksz) {
452: *ksz = key->size + sz + MANDOC_BUFSZ;
453: key->data = mandoc_realloc(key->data, *ksz);
454: }
455:
1.15 ! kristaps 456: #if 0
1.14 kristaps 457: dstp = key->data + (int)key->size;
458:
459: while (NULL != (endp = memchr(cp, '\\', sz))) {
460: ssz = endp - cp;
461: memcpy(dstp, cp, ssz);
462:
463: dstp += ssz;
464: key->size += ssz;
465: sz -= ssz;
466:
467: cp = endp++;
468: /* FIXME: expects nil-terminated string! */
469: esc = mandoc_escape((const char **)&endp, NULL, NULL);
470:
471: switch (esc) {
472: case (ESCAPE_ERROR):
473: /* Nil-terminate this point. */
474: memcpy(dstp, "", 1);
475: key->size++;
476: return;
477: case (ESCAPE_PREDEF):
478: /* FALLTHROUGH */
479: case (ESCAPE_SPECIAL):
480: break;
481: default:
482: sz -= endp - cp;
483: cp = endp;
484: continue;
485: }
486:
487: ssz = endp - cp;
488: memcpy(dstp, cp, ssz);
489:
490: dstp += ssz;
491: key->size += ssz;
492: sz -= ssz;
493:
494: cp = endp;
495: }
1.15 ! kristaps 496: #endif
1.14 kristaps 497:
1.15 ! kristaps 498: memcpy(key->data + (int)key->size, cp, sz);
1.1 kristaps 499: key->size += sz;
500: }
501:
502: /*
503: * Append a nil-terminated string to the database entry. This can be
504: * invoked multiple times. The database entry will be nil-terminated as
505: * well; if invoked multiple times, a space is put between strings.
506: */
507: static void
508: dbt_append(DBT *key, size_t *ksz, const char *cp)
509: {
510: size_t sz;
511:
512: if (0 == (sz = strlen(cp)))
513: return;
514:
1.3 kristaps 515: assert(key->data);
1.1 kristaps 516:
517: if (key->size)
518: ((char *)key->data)[(int)key->size - 1] = ' ';
519:
1.3 kristaps 520: dbt_appendb(key, ksz, cp, sz + 1);
1.1 kristaps 521: }
522:
523: /* ARGSUSED */
524: static void
525: pmdoc_Fd(MDOC_ARGS)
526: {
527: uint32_t fl;
528: const char *start, *end;
529: size_t sz;
530:
531: if (SEC_SYNOPSIS != n->sec)
532: return;
533: if (NULL == (n = n->child) || MDOC_TEXT != n->type)
534: return;
1.4 kristaps 535:
536: /*
537: * Only consider those `Fd' macro fields that begin with an
538: * "inclusion" token (versus, e.g., #define).
539: */
1.1 kristaps 540: if (strcmp("#include", n->string))
541: return;
1.4 kristaps 542:
1.1 kristaps 543: if (NULL == (n = n->next) || MDOC_TEXT != n->type)
544: return;
545:
1.4 kristaps 546: /*
547: * Strip away the enclosing angle brackets and make sure we're
548: * not zero-length.
549: */
550:
1.1 kristaps 551: start = n->string;
1.5 kristaps 552: if ('<' == *start || '"' == *start)
1.1 kristaps 553: start++;
554:
555: if (0 == (sz = strlen(start)))
556: return;
557:
558: end = &start[(int)sz - 1];
1.5 kristaps 559: if ('>' == *end || '"' == *end)
1.1 kristaps 560: end--;
561:
562: dbt_appendb(key, ksz, start, end - start + 1);
1.14 kristaps 563: dbt_appendb(key, ksz, "", 1);
1.1 kristaps 564:
565: fl = MANDOC_INCLUDES;
566: memcpy(val->data, &fl, 4);
567: }
568:
569: /* ARGSUSED */
570: static void
571: pmdoc_In(MDOC_ARGS)
572: {
573: uint32_t fl;
574:
575: if (SEC_SYNOPSIS != n->sec)
576: return;
577: if (NULL == n->child || MDOC_TEXT != n->child->type)
578: return;
579:
580: dbt_append(key, ksz, n->child->string);
581: fl = MANDOC_INCLUDES;
582: memcpy(val->data, &fl, 4);
583: }
584:
585: /* ARGSUSED */
586: static void
587: pmdoc_Fn(MDOC_ARGS)
588: {
589: uint32_t fl;
590: const char *cp;
591:
592: if (SEC_SYNOPSIS != n->sec)
593: return;
594: if (NULL == n->child || MDOC_TEXT != n->child->type)
595: return;
596:
597: /* .Fn "struct type *arg" "foo" */
598:
599: cp = strrchr(n->child->string, ' ');
600: if (NULL == cp)
601: cp = n->child->string;
602:
1.4 kristaps 603: /* Strip away pointer symbol. */
1.1 kristaps 604:
605: while ('*' == *cp)
606: cp++;
607:
608: dbt_append(key, ksz, cp);
609: fl = MANDOC_FUNCTION;
1.13 kristaps 610: memcpy(val->data, &fl, 4);
611: }
612:
613: /* ARGSUSED */
614: static void
615: pmdoc_St(MDOC_ARGS)
616: {
617: uint32_t fl;
618:
619: if (SEC_STANDARDS != n->sec)
620: return;
621: if (NULL == n->child || MDOC_TEXT != n->child->type)
622: return;
623:
624: dbt_append(key, ksz, n->child->string);
625: fl = MANDOC_STANDARD;
1.1 kristaps 626: memcpy(val->data, &fl, 4);
627: }
628:
629: /* ARGSUSED */
630: static void
631: pmdoc_Vt(MDOC_ARGS)
632: {
633: uint32_t fl;
1.14 kristaps 634: const char *start;
1.1 kristaps 635: size_t sz;
636:
637: if (SEC_SYNOPSIS != n->sec)
638: return;
639: if (MDOC_Vt == n->tok && MDOC_BODY != n->type)
640: return;
1.7 kristaps 641: if (NULL == n->last || MDOC_TEXT != n->last->type)
1.1 kristaps 642: return;
643:
644: /*
1.4 kristaps 645: * Strip away leading pointer symbol '*' and trailing ';'.
1.1 kristaps 646: */
647:
648: start = n->last->string;
649:
650: while ('*' == *start)
651: start++;
652:
653: if (0 == (sz = strlen(start)))
654: return;
655:
1.14 kristaps 656: if (';' == start[sz - 1])
657: sz--;
1.1 kristaps 658:
1.14 kristaps 659: if (0 == sz)
1.1 kristaps 660: return;
661:
1.14 kristaps 662: dbt_appendb(key, ksz, start, sz);
663: dbt_appendb(key, ksz, "", 1);
664:
1.1 kristaps 665: fl = MANDOC_VARIABLE;
666: memcpy(val->data, &fl, 4);
667: }
668:
669: /* ARGSUSED */
670: static void
671: pmdoc_Fo(MDOC_ARGS)
672: {
673: uint32_t fl;
674:
675: if (SEC_SYNOPSIS != n->sec || MDOC_HEAD != n->type)
676: return;
677: if (NULL == n->child || MDOC_TEXT != n->child->type)
678: return;
679:
680: dbt_append(key, ksz, n->child->string);
681: fl = MANDOC_FUNCTION;
682: memcpy(val->data, &fl, 4);
683: }
684:
1.11 kristaps 685:
686: /* ARGSUSED */
687: static void
688: pmdoc_Nd(MDOC_ARGS)
689: {
690: int first;
691:
692: for (first = 1, n = n->child; n; n = n->next) {
693: if (MDOC_TEXT != n->type)
694: continue;
695: if (first)
696: dbt_appendb(rval, rsz, n->string, strlen(n->string) + 1);
697: else
698: dbt_append(rval, rsz, n->string);
699: first = 0;
700: }
701: }
702:
1.1 kristaps 703: /* ARGSUSED */
704: static void
705: pmdoc_Nm(MDOC_ARGS)
706: {
707: uint32_t fl;
708:
709: if (SEC_NAME == n->sec) {
710: for (n = n->child; n; n = n->next) {
711: if (MDOC_TEXT != n->type)
712: continue;
713: dbt_append(key, ksz, n->string);
714: }
715: fl = MANDOC_NAME;
716: memcpy(val->data, &fl, 4);
717: return;
718: } else if (SEC_SYNOPSIS != n->sec || MDOC_HEAD != n->type)
719: return;
720:
721: for (n = n->child; n; n = n->next) {
722: if (MDOC_TEXT != n->type)
723: continue;
724: dbt_append(key, ksz, n->string);
725: }
726:
727: fl = MANDOC_UTILITY;
728: memcpy(val->data, &fl, 4);
729: }
730:
1.8 kristaps 731: static void
732: dbt_put(DB *db, const char *dbn, DBT *key, DBT *val)
733: {
734:
735: if (0 == key->size)
736: return;
737:
738: assert(key->data);
1.10 kristaps 739: assert(val->size);
1.8 kristaps 740: assert(val->data);
741:
742: if (0 == (*db->put)(db, key, val, 0))
743: return;
744:
745: perror(dbn);
746: exit((int)MANDOCLEVEL_SYSERR);
747: /* NOTREACHED */
748: }
749:
1.1 kristaps 750: /*
751: * Call out to per-macro handlers after clearing the persistent database
752: * key. If the macro sets the database key, flush it to the database.
753: */
754: static void
755: pmdoc_node(MDOC_ARGS)
756: {
757:
758: if (NULL == n)
759: return;
760:
761: switch (n->type) {
762: case (MDOC_HEAD):
763: /* FALLTHROUGH */
764: case (MDOC_BODY):
765: /* FALLTHROUGH */
766: case (MDOC_TAIL):
767: /* FALLTHROUGH */
768: case (MDOC_BLOCK):
769: /* FALLTHROUGH */
770: case (MDOC_ELEM):
771: if (NULL == mdocs[n->tok])
772: break;
773:
774: dbt_init(key, ksz);
1.14 kristaps 775:
1.11 kristaps 776: (*mdocs[n->tok])(db, dbn, key, ksz, val, rval, rsz, n);
1.8 kristaps 777: dbt_put(db, dbn, key, val);
778: break;
1.1 kristaps 779: default:
780: break;
781: }
782:
1.11 kristaps 783: pmdoc_node(db, dbn, key, ksz, val, rval, rsz, n->child);
784: pmdoc_node(db, dbn, key, ksz, val, rval, rsz, n->next);
1.1 kristaps 785: }
1.6 kristaps 786:
787: static int
788: pman_node(MAN_ARGS)
789: {
790: const struct man_node *head, *body;
1.12 kristaps 791: const char *start, *sv;
1.8 kristaps 792: size_t sz;
1.6 kristaps 793: uint32_t fl;
794:
795: if (NULL == n)
796: return(0);
797:
798: /*
799: * We're only searching for one thing: the first text child in
800: * the BODY of a NAME section. Since we don't keep track of
801: * sections in -man, run some hoops to find out whether we're in
802: * the correct section or not.
803: */
804:
805: if (MAN_BODY == n->type && MAN_SH == n->tok) {
806: body = n;
807: assert(body->parent);
808: if (NULL != (head = body->parent->head) &&
809: 1 == head->nchild &&
810: NULL != (head = (head->child)) &&
811: MAN_TEXT == head->type &&
812: 0 == strcmp(head->string, "NAME") &&
813: NULL != (body = body->child) &&
814: MAN_TEXT == body->type) {
815:
1.8 kristaps 816: fl = MANDOC_NAME;
817: memcpy(val->data, &fl, 4);
818:
1.12 kristaps 819: assert(body->string);
820: start = sv = body->string;
1.6 kristaps 821:
1.8 kristaps 822: /*
823: * Go through a special heuristic dance here.
824: * This is why -man manuals are great!
825: * Conventionally, one or more manual names are
826: * comma-specified prior to a whitespace, then a
827: * dash, then a description. Try to puzzle out
828: * the name parts here.
829: */
830:
1.12 kristaps 831: for ( ;; ) {
1.8 kristaps 832: sz = strcspn(start, " ,");
833: if ('\0' == start[(int)sz])
834: break;
835:
836: dbt_init(key, ksz);
837: dbt_appendb(key, ksz, start, sz);
1.14 kristaps 838: dbt_appendb(key, ksz, "", 1);
1.8 kristaps 839:
840: dbt_put(db, dbn, key, val);
841:
1.12 kristaps 842: if (' ' == start[(int)sz]) {
843: start += (int)sz + 1;
1.8 kristaps 844: break;
1.12 kristaps 845: }
1.8 kristaps 846:
847: assert(',' == start[(int)sz]);
848: start += (int)sz + 1;
849: while (' ' == *start)
850: start++;
851: }
852:
1.12 kristaps 853: if (sv == start) {
854: dbt_init(key, ksz);
855: dbt_append(key, ksz, start);
856: return(1);
857: }
858:
859: while (' ' == *start)
860: start++;
861:
862: if ('\\' == *start && '-' == *(start + 1))
863: start += 2;
864: else if ('-' == *start)
865: start++;
866:
867: while (' ' == *start)
868: start++;
869:
870: dbt_appendb(rval, rsz, start, strlen(start) + 1);
1.6 kristaps 871: }
872: }
873:
1.11 kristaps 874: if (pman_node(db, dbn, key, ksz, val, rval, rsz, n->child))
1.6 kristaps 875: return(1);
1.11 kristaps 876: if (pman_node(db, dbn, key, ksz, val, rval, rsz, n->next))
1.6 kristaps 877: return(1);
878:
879: return(0);
880: }
881:
882: static void
1.11 kristaps 883: pman(DB *db, const char *dbn, DBT *key, size_t *ksz,
884: DBT *val, DBT *rval, size_t *rsz, struct man *m)
1.6 kristaps 885: {
886:
1.11 kristaps 887: pman_node(db, dbn, key, ksz, val, rval, rsz, man_node(m));
1.6 kristaps 888: }
889:
1.1 kristaps 890:
891: static void
1.11 kristaps 892: pmdoc(DB *db, const char *dbn, DBT *key, size_t *ksz,
893: DBT *val, DBT *rval, size_t *rsz, struct mdoc *m)
1.1 kristaps 894: {
895:
1.11 kristaps 896: pmdoc_node(db, dbn, key, ksz, val, rval, rsz, mdoc_node(m));
1.1 kristaps 897: }
898:
899: static void
900: usage(void)
901: {
902:
903: fprintf(stderr, "usage: %s "
1.2 kristaps 904: "[-d path] "
1.1 kristaps 905: "[file...]\n",
906: progname);
907: }
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mandoc-db.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc