Annotation of src/usr.bin/mandoc/apropos_db.c, Revision 1.8
1.8 ! schwarze 1: /* $Id: apropos_db.c,v 1.7 2011/11/18 01:10:03 schwarze Exp $ */
1.1 schwarze 2: /*
3: * Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.3 schwarze 4: * Copyright (c) 2011 Ingo Schwarze <schwarze@openbsd.org>
1.1 schwarze 5: *
6: * Permission to use, copy, modify, and distribute this software for any
7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17: */
18: #include <assert.h>
19: #include <fcntl.h>
20: #include <regex.h>
21: #include <stdarg.h>
1.6 schwarze 22: #include <stdint.h>
1.1 schwarze 23: #include <stdlib.h>
24: #include <string.h>
1.5 schwarze 25: #include <unistd.h>
1.1 schwarze 26:
27: #ifdef __linux__
28: # include <db_185.h>
29: #else
30: # include <db.h>
31: #endif
32:
1.2 schwarze 33: #include "mandocdb.h"
1.1 schwarze 34: #include "apropos_db.h"
35: #include "mandoc.h"
36:
1.7 schwarze 37: struct rec {
38: struct res res; /* resulting record info */
39: /*
40: * Maintain a binary tree for checking the uniqueness of `rec'
41: * when adding elements to the results array.
42: * Since the results array is dynamic, use offset in the array
43: * instead of a pointer to the structure.
44: */
45: int lhs;
46: int rhs;
47: int matched; /* expression is true */
48: int *matches; /* partial truth evaluations */
49: };
50:
1.1 schwarze 51: struct expr {
1.7 schwarze 52: int regex; /* is regex? */
53: int index; /* index in match array */
54: uint64_t mask; /* type-mask */
55: int cs; /* is case-sensitive? */
56: int and; /* is rhs of logical AND? */
57: char *v; /* search value */
58: regex_t re; /* compiled re, if regex */
59: struct expr *next; /* next in sequence */
60: struct expr *subexpr;
1.1 schwarze 61: };
62:
63: struct type {
1.6 schwarze 64: uint64_t mask;
1.1 schwarze 65: const char *name;
66: };
67:
1.8 ! schwarze 68: struct rectree {
! 69: struct rec *node; /* record array for dir tree */
! 70: int len; /* length of record array */
! 71: };
! 72:
1.1 schwarze 73: static const struct type types[] = {
1.2 schwarze 74: { TYPE_An, "An" },
1.6 schwarze 75: { TYPE_Ar, "Ar" },
76: { TYPE_At, "At" },
77: { TYPE_Bsx, "Bsx" },
78: { TYPE_Bx, "Bx" },
1.2 schwarze 79: { TYPE_Cd, "Cd" },
1.6 schwarze 80: { TYPE_Cm, "Cm" },
81: { TYPE_Dv, "Dv" },
82: { TYPE_Dx, "Dx" },
83: { TYPE_Em, "Em" },
1.2 schwarze 84: { TYPE_Er, "Er" },
85: { TYPE_Ev, "Ev" },
1.6 schwarze 86: { TYPE_Fa, "Fa" },
87: { TYPE_Fl, "Fl" },
1.2 schwarze 88: { TYPE_Fn, "Fn" },
89: { TYPE_Fn, "Fo" },
1.6 schwarze 90: { TYPE_Ft, "Ft" },
91: { TYPE_Fx, "Fx" },
92: { TYPE_Ic, "Ic" },
1.2 schwarze 93: { TYPE_In, "In" },
1.6 schwarze 94: { TYPE_Lb, "Lb" },
95: { TYPE_Li, "Li" },
96: { TYPE_Lk, "Lk" },
97: { TYPE_Ms, "Ms" },
98: { TYPE_Mt, "Mt" },
1.2 schwarze 99: { TYPE_Nd, "Nd" },
100: { TYPE_Nm, "Nm" },
1.6 schwarze 101: { TYPE_Nx, "Nx" },
102: { TYPE_Ox, "Ox" },
1.2 schwarze 103: { TYPE_Pa, "Pa" },
1.6 schwarze 104: { TYPE_Rs, "Rs" },
105: { TYPE_Sh, "Sh" },
106: { TYPE_Ss, "Ss" },
1.2 schwarze 107: { TYPE_St, "St" },
1.6 schwarze 108: { TYPE_Sy, "Sy" },
109: { TYPE_Tn, "Tn" },
1.2 schwarze 110: { TYPE_Va, "Va" },
111: { TYPE_Va, "Vt" },
112: { TYPE_Xr, "Xr" },
113: { INT_MAX, "any" },
1.1 schwarze 114: { 0, NULL }
115: };
116:
117: static DB *btree_open(void);
1.7 schwarze 118: static int btree_read(const DBT *,
119: const struct mchars *, char **);
120: static int expreval(const struct expr *, int *);
121: static void exprexec(const struct expr *,
122: const char *, uint64_t, struct rec *);
123: static int exprmark(const struct expr *,
124: const char *, uint64_t, int *);
125: static struct expr *exprexpr(int, char *[], int *, int *, size_t *);
126: static struct expr *exprterm(char *, int);
1.1 schwarze 127: static DB *index_open(void);
1.8 ! schwarze 128: static int index_read(const DBT *, const DBT *, int,
1.1 schwarze 129: const struct mchars *, struct rec *);
130: static void norm_string(const char *,
131: const struct mchars *, char **);
132: static size_t norm_utf8(unsigned int, char[7]);
1.4 schwarze 133: static void recfree(struct rec *);
1.7 schwarze 134: static int single_search(struct rectree *, const struct opts *,
1.5 schwarze 135: const struct expr *, size_t terms,
1.8 ! schwarze 136: struct mchars *, int);
1.1 schwarze 137:
138: /*
139: * Open the keyword mandoc-db database.
140: */
141: static DB *
142: btree_open(void)
143: {
144: BTREEINFO info;
145: DB *db;
146:
147: memset(&info, 0, sizeof(BTREEINFO));
148: info.flags = R_DUP;
149:
1.2 schwarze 150: db = dbopen(MANDOC_DB, O_RDONLY, 0, DB_BTREE, &info);
1.8 ! schwarze 151: if (NULL != db)
1.1 schwarze 152: return(db);
153:
154: return(NULL);
155: }
156:
157: /*
158: * Read a keyword from the database and normalise it.
159: * Return 0 if the database is insane, else 1.
160: */
161: static int
162: btree_read(const DBT *v, const struct mchars *mc, char **buf)
163: {
164:
165: /* Sanity: are we nil-terminated? */
166:
167: assert(v->size > 0);
1.8 ! schwarze 168:
1.1 schwarze 169: if ('\0' != ((char *)v->data)[(int)v->size - 1])
170: return(0);
171:
172: norm_string((char *)v->data, mc, buf);
173: return(1);
174: }
175:
176: /*
177: * Take a Unicode codepoint and produce its UTF-8 encoding.
178: * This isn't the best way to do this, but it works.
1.8 ! schwarze 179: * The magic numbers are from the UTF-8 packaging.
1.1 schwarze 180: * They're not as scary as they seem: read the UTF-8 spec for details.
181: */
182: static size_t
183: norm_utf8(unsigned int cp, char out[7])
184: {
185: size_t rc;
186:
187: rc = 0;
188:
189: if (cp <= 0x0000007F) {
190: rc = 1;
191: out[0] = (char)cp;
192: } else if (cp <= 0x000007FF) {
193: rc = 2;
194: out[0] = (cp >> 6 & 31) | 192;
195: out[1] = (cp & 63) | 128;
196: } else if (cp <= 0x0000FFFF) {
197: rc = 3;
198: out[0] = (cp >> 12 & 15) | 224;
199: out[1] = (cp >> 6 & 63) | 128;
200: out[2] = (cp & 63) | 128;
201: } else if (cp <= 0x001FFFFF) {
202: rc = 4;
203: out[0] = (cp >> 18 & 7) | 240;
204: out[1] = (cp >> 12 & 63) | 128;
205: out[2] = (cp >> 6 & 63) | 128;
206: out[3] = (cp & 63) | 128;
207: } else if (cp <= 0x03FFFFFF) {
208: rc = 5;
209: out[0] = (cp >> 24 & 3) | 248;
210: out[1] = (cp >> 18 & 63) | 128;
211: out[2] = (cp >> 12 & 63) | 128;
212: out[3] = (cp >> 6 & 63) | 128;
213: out[4] = (cp & 63) | 128;
214: } else if (cp <= 0x7FFFFFFF) {
215: rc = 6;
216: out[0] = (cp >> 30 & 1) | 252;
217: out[1] = (cp >> 24 & 63) | 128;
218: out[2] = (cp >> 18 & 63) | 128;
219: out[3] = (cp >> 12 & 63) | 128;
220: out[4] = (cp >> 6 & 63) | 128;
221: out[5] = (cp & 63) | 128;
222: } else
223: return(0);
224:
225: out[rc] = '\0';
226: return(rc);
227: }
228:
229: /*
230: * Normalise strings from the index and database.
231: * These strings are escaped as defined by mandoc_char(7) along with
232: * other goop in mandoc.h (e.g., soft hyphens).
233: * This function normalises these into a nice UTF-8 string.
234: * Returns 0 if the database is fucked.
235: */
236: static void
237: norm_string(const char *val, const struct mchars *mc, char **buf)
238: {
239: size_t sz, bsz;
240: char utfbuf[7];
241: const char *seq, *cpp;
242: int len, u, pos;
243: enum mandoc_esc esc;
1.8 ! schwarze 244: static const char res[] = { '\\', '\t',
1.1 schwarze 245: ASCII_NBRSP, ASCII_HYPH, '\0' };
246:
247: /* Pre-allocate by the length of the input */
248:
249: bsz = strlen(val) + 1;
250: *buf = mandoc_realloc(*buf, bsz);
251: pos = 0;
252:
253: while ('\0' != *val) {
254: /*
255: * Halt on the first escape sequence.
256: * This also halts on the end of string, in which case
257: * we just copy, fallthrough, and exit the loop.
258: */
259: if ((sz = strcspn(val, res)) > 0) {
260: memcpy(&(*buf)[pos], val, sz);
261: pos += (int)sz;
262: val += (int)sz;
263: }
264:
265: if (ASCII_HYPH == *val) {
266: (*buf)[pos++] = '-';
267: val++;
268: continue;
269: } else if ('\t' == *val || ASCII_NBRSP == *val) {
270: (*buf)[pos++] = ' ';
271: val++;
272: continue;
273: } else if ('\\' != *val)
274: break;
275:
276: /* Read past the slash. */
277:
278: val++;
279: u = 0;
280:
281: /*
282: * Parse the escape sequence and see if it's a
283: * predefined character or special character.
284: */
285:
286: esc = mandoc_escape(&val, &seq, &len);
287: if (ESCAPE_ERROR == esc)
288: break;
289:
1.8 ! schwarze 290: /*
1.1 schwarze 291: * XXX - this just does UTF-8, but we need to know
292: * beforehand whether we should do text substitution.
293: */
294:
295: switch (esc) {
296: case (ESCAPE_SPECIAL):
297: if (0 != (u = mchars_spec2cp(mc, seq, len)))
298: break;
299: /* FALLTHROUGH */
300: default:
301: continue;
302: }
303:
304: /*
305: * If we have a Unicode codepoint, try to convert that
306: * to a UTF-8 byte string.
307: */
308:
309: cpp = utfbuf;
310: if (0 == (sz = norm_utf8(u, utfbuf)))
311: continue;
312:
313: /* Copy the rendered glyph into the stream. */
314:
315: sz = strlen(cpp);
316: bsz += sz;
317:
318: *buf = mandoc_realloc(*buf, bsz);
319:
320: memcpy(&(*buf)[pos], cpp, sz);
321: pos += (int)sz;
322: }
323:
324: (*buf)[pos] = '\0';
325: }
326:
327: /*
328: * Open the filename-index mandoc-db database.
329: * Returns NULL if opening failed.
330: */
331: static DB *
332: index_open(void)
333: {
334: DB *db;
335:
1.2 schwarze 336: db = dbopen(MANDOC_IDX, O_RDONLY, 0, DB_RECNO, NULL);
1.1 schwarze 337: if (NULL != db)
338: return(db);
339:
340: return(NULL);
341: }
342:
343: /*
344: * Safely unpack from an index file record into the structure.
345: * Returns 1 if an entry was unpacked, 0 if the database is insane.
346: */
347: static int
1.8 ! schwarze 348: index_read(const DBT *key, const DBT *val, int index,
1.1 schwarze 349: const struct mchars *mc, struct rec *rec)
350: {
351: size_t left;
352: char *np, *cp;
353:
354: #define INDEX_BREAD(_dst) \
355: do { \
356: if (NULL == (np = memchr(cp, '\0', left))) \
357: return(0); \
358: norm_string(cp, mc, &(_dst)); \
359: left -= (np - cp) + 1; \
360: cp = np + 1; \
361: } while (/* CONSTCOND */ 0)
362:
363: left = val->size;
364: cp = (char *)val->data;
365:
1.7 schwarze 366: rec->res.rec = *(recno_t *)key->data;
1.8 ! schwarze 367: rec->res.volume = index;
1.1 schwarze 368:
1.7 schwarze 369: INDEX_BREAD(rec->res.file);
370: INDEX_BREAD(rec->res.cat);
371: INDEX_BREAD(rec->res.title);
372: INDEX_BREAD(rec->res.arch);
373: INDEX_BREAD(rec->res.desc);
1.1 schwarze 374: return(1);
375: }
376:
377: /*
1.8 ! schwarze 378: * Search mandocdb databases in paths for expression "expr".
1.1 schwarze 379: * Filter out by "opts".
380: * Call "res" with the results, which may be zero.
1.7 schwarze 381: * Return 0 if there was a database error, else return 1.
1.1 schwarze 382: */
1.7 schwarze 383: int
1.8 ! schwarze 384: apropos_search(int pathsz, char **paths, const struct opts *opts,
! 385: const struct expr *expr, size_t terms, void *arg,
1.7 schwarze 386: void (*res)(struct res *, size_t, void *))
1.1 schwarze 387: {
1.5 schwarze 388: struct rectree tree;
389: struct mchars *mc;
1.7 schwarze 390: struct res *ress;
391: int i, mlen, rc;
1.5 schwarze 392:
393: memset(&tree, 0, sizeof(struct rectree));
394:
1.8 ! schwarze 395: rc = 0;
1.5 schwarze 396: mc = mchars_alloc();
397:
1.8 ! schwarze 398: /*
! 399: * Main loop. Change into the directory containing manpage
! 400: * databases. Run our expession over each database in the set.
! 401: */
! 402:
! 403: for (i = 0; i < pathsz; i++) {
! 404: if (chdir(paths[i]))
1.5 schwarze 405: continue;
1.8 ! schwarze 406: if ( ! single_search(&tree, opts, expr, terms, mc, i))
! 407: goto out;
1.5 schwarze 408: }
409:
410: /*
1.8 ! schwarze 411: * Count matching files, transfer to a "clean" array, then feed
! 412: * them to the output handler.
1.5 schwarze 413: */
414:
415: for (mlen = i = 0; i < tree.len; i++)
1.7 schwarze 416: if (tree.node[i].matched)
1.5 schwarze 417: mlen++;
1.8 ! schwarze 418:
1.7 schwarze 419: ress = mandoc_malloc(mlen * sizeof(struct res));
1.8 ! schwarze 420:
1.5 schwarze 421: for (mlen = i = 0; i < tree.len; i++)
1.7 schwarze 422: if (tree.node[i].matched)
1.8 ! schwarze 423: memcpy(&ress[mlen++], &tree.node[i].res,
1.7 schwarze 424: sizeof(struct res));
1.8 ! schwarze 425:
1.7 schwarze 426: (*res)(ress, mlen, arg);
427: free(ress);
1.5 schwarze 428:
1.8 ! schwarze 429: rc = 1;
! 430: out:
1.5 schwarze 431: for (i = 0; i < tree.len; i++)
432: recfree(&tree.node[i]);
433:
1.8 ! schwarze 434: free(tree.node);
! 435: mchars_free(mc);
1.7 schwarze 436: return(rc);
1.5 schwarze 437: }
438:
1.7 schwarze 439: static int
1.5 schwarze 440: single_search(struct rectree *tree, const struct opts *opts,
441: const struct expr *expr, size_t terms,
1.8 ! schwarze 442: struct mchars *mc, int vol)
1.5 schwarze 443: {
1.8 ! schwarze 444: int root, leaf, ch;
! 445: uint64_t mask;
1.1 schwarze 446: DBT key, val;
447: DB *btree, *idx;
448: char *buf;
449: recno_t rec;
1.7 schwarze 450: struct rec *rs;
451: struct rec r;
1.6 schwarze 452: struct db_val *vbuf;
1.1 schwarze 453:
454: root = -1;
455: leaf = -1;
456: btree = NULL;
457: idx = NULL;
458: buf = NULL;
1.7 schwarze 459: rs = tree->node;
1.1 schwarze 460:
1.7 schwarze 461: memset(&r, 0, sizeof(struct rec));
1.1 schwarze 462:
1.8 ! schwarze 463: if (NULL == (btree = btree_open()))
! 464: return(1);
! 465:
! 466: if (NULL == (idx = index_open())) {
! 467: (*btree->close)(btree);
! 468: return(1);
! 469: }
1.1 schwarze 470:
1.8 ! schwarze 471: while (0 == (ch = (*btree->seq)(btree, &key, &val, R_NEXT))) {
! 472: if (key.size < 2 || sizeof(struct db_val) != val.size)
! 473: break;
1.1 schwarze 474: if ( ! btree_read(&key, mc, &buf))
1.8 ! schwarze 475: break;
! 476:
! 477: vbuf = val.data;
! 478: rec = vbuf->rec;
! 479: mask = vbuf->mask;
1.1 schwarze 480:
1.4 schwarze 481: /*
482: * See if this keyword record matches any of the
483: * expressions we have stored.
484: */
1.8 ! schwarze 485: if ( ! exprmark(expr, buf, mask, NULL))
1.1 schwarze 486: continue;
487:
488: /*
489: * O(log n) scan for prior records. Since a record
490: * number is unbounded, this has decent performance over
491: * a complex hash function.
492: */
493:
494: for (leaf = root; leaf >= 0; )
1.7 schwarze 495: if (rec > rs[leaf].res.rec &&
496: rs[leaf].rhs >= 0)
497: leaf = rs[leaf].rhs;
498: else if (rec < rs[leaf].res.rec &&
499: rs[leaf].lhs >= 0)
500: leaf = rs[leaf].lhs;
1.8 ! schwarze 501: else
1.1 schwarze 502: break;
503:
1.7 schwarze 504: /*
505: * If we find a record, see if it has already evaluated
506: * to true. If it has, great, just keep going. If not,
507: * try to evaluate it now and continue anyway.
508: */
509:
510: if (leaf >= 0 && rs[leaf].res.rec == rec) {
511: if (0 == rs[leaf].matched)
1.8 ! schwarze 512: exprexec(expr, buf, mask, &rs[leaf]);
1.1 schwarze 513: continue;
1.4 schwarze 514: }
1.1 schwarze 515:
516: /*
1.7 schwarze 517: * We have a new file to examine.
518: * Extract the manpage's metadata from the index
519: * database, then begin partial evaluation.
1.1 schwarze 520: */
521:
522: key.data = &rec;
523: key.size = sizeof(recno_t);
524:
525: if (0 != (*idx->get)(idx, &key, &val, 0))
1.8 ! schwarze 526: break;
1.1 schwarze 527:
1.7 schwarze 528: r.lhs = r.rhs = -1;
1.8 ! schwarze 529: if ( ! index_read(&key, &val, vol, mc, &r))
! 530: break;
1.1 schwarze 531:
1.7 schwarze 532: /* XXX: this should be elsewhere, I guess? */
1.8 ! schwarze 533:
1.7 schwarze 534: if (opts->cat && strcasecmp(opts->cat, r.res.cat))
1.1 schwarze 535: continue;
1.7 schwarze 536: if (opts->arch && strcasecmp(opts->arch, r.res.arch))
1.1 schwarze 537: continue;
538:
1.7 schwarze 539: tree->node = rs = mandoc_realloc
540: (rs, (tree->len + 1) * sizeof(struct rec));
1.1 schwarze 541:
1.7 schwarze 542: memcpy(&rs[tree->len], &r, sizeof(struct rec));
1.8 ! schwarze 543: rs[tree->len].matches =
! 544: mandoc_calloc(terms, sizeof(int));
1.4 schwarze 545:
1.8 ! schwarze 546: exprexec(expr, buf, mask, &rs[tree->len]);
1.1 schwarze 547:
548: /* Append to our tree. */
549:
550: if (leaf >= 0) {
1.7 schwarze 551: if (rec > rs[leaf].res.rec)
552: rs[leaf].rhs = tree->len;
1.1 schwarze 553: else
1.7 schwarze 554: rs[leaf].lhs = tree->len;
1.1 schwarze 555: } else
1.5 schwarze 556: root = tree->len;
1.8 ! schwarze 557:
1.7 schwarze 558: memset(&r, 0, sizeof(struct rec));
1.5 schwarze 559: tree->len++;
1.1 schwarze 560: }
561:
1.8 ! schwarze 562: (*btree->close)(btree);
! 563: (*idx->close)(idx);
1.1 schwarze 564:
565: free(buf);
1.8 ! schwarze 566: return(1 == ch);
1.1 schwarze 567: }
568:
1.4 schwarze 569: static void
570: recfree(struct rec *rec)
571: {
572:
1.7 schwarze 573: free(rec->res.file);
574: free(rec->res.cat);
575: free(rec->res.title);
576: free(rec->res.arch);
577: free(rec->res.desc);
578:
1.4 schwarze 579: free(rec->matches);
580: }
581:
1.1 schwarze 582: struct expr *
1.4 schwarze 583: exprcomp(int argc, char *argv[], size_t *tt)
584: {
1.7 schwarze 585: int pos, lvl;
586: struct expr *e;
587:
588: pos = lvl = 0;
589: *tt = 0;
590:
591: e = exprexpr(argc, argv, &pos, &lvl, tt);
592:
593: if (0 == lvl && pos >= argc)
594: return(e);
595:
596: exprfree(e);
597: return(NULL);
598: }
599:
600: /*
601: * Compile an array of tokens into an expression.
602: * An informal expression grammar is defined in apropos(1).
603: * Return NULL if we fail doing so. All memory will be cleaned up.
604: * Return the root of the expression sequence if alright.
605: */
606: static struct expr *
607: exprexpr(int argc, char *argv[], int *pos, int *lvl, size_t *tt)
608: {
1.4 schwarze 609: struct expr *e, *first, *next;
1.7 schwarze 610: int log;
1.4 schwarze 611:
612: first = next = NULL;
613:
1.7 schwarze 614: for ( ; *pos < argc; (*pos)++) {
1.4 schwarze 615: e = next;
1.7 schwarze 616:
617: /*
618: * Close out a subexpression.
619: */
620:
621: if (NULL != e && 0 == strcmp(")", argv[*pos])) {
622: if (--(*lvl) < 0)
623: goto err;
624: break;
625: }
626:
627: /*
628: * Small note: if we're just starting, don't let "-a"
629: * and "-o" be considered logical operators: they're
630: * just tokens unless pairwise joining, in which case we
631: * record their existence (or assume "OR").
632: */
1.4 schwarze 633: log = 0;
634:
1.7 schwarze 635: if (NULL != e && 0 == strcmp("-a", argv[*pos]))
1.8 ! schwarze 636: log = 1;
1.7 schwarze 637: else if (NULL != e && 0 == strcmp("-o", argv[*pos]))
1.4 schwarze 638: log = 2;
639:
1.7 schwarze 640: if (log > 0 && ++(*pos) >= argc)
1.4 schwarze 641: goto err;
642:
1.7 schwarze 643: /*
644: * Now we parse the term part. This can begin with
645: * "-i", in which case the expression is case
646: * insensitive.
647: */
648:
649: if (0 == strcmp("(", argv[*pos])) {
650: ++(*pos);
651: ++(*lvl);
652: next = mandoc_calloc(1, sizeof(struct expr));
653: next->cs = 1;
654: next->subexpr = exprexpr(argc, argv, pos, lvl, tt);
655: if (NULL == next->subexpr) {
656: free(next);
657: next = NULL;
658: }
659: } else if (0 == strcmp("-i", argv[*pos])) {
660: if (++(*pos) >= argc)
1.4 schwarze 661: goto err;
1.7 schwarze 662: next = exprterm(argv[*pos], 0);
1.4 schwarze 663: } else
1.7 schwarze 664: next = exprterm(argv[*pos], 1);
1.4 schwarze 665:
666: if (NULL == next)
667: goto err;
668:
1.7 schwarze 669: next->and = log == 1;
1.4 schwarze 670: next->index = (int)(*tt)++;
671:
1.7 schwarze 672: /* Append to our chain of expressions. */
673:
1.4 schwarze 674: if (NULL == first) {
675: assert(NULL == e);
676: first = next;
677: } else {
678: assert(NULL != e);
679: e->next = next;
680: }
681: }
682:
683: return(first);
684: err:
685: exprfree(first);
686: return(NULL);
687: }
688:
1.7 schwarze 689: /*
690: * Parse a terminal expression with the grammar as defined in
691: * apropos(1).
692: * Return NULL if we fail the parse.
693: */
1.4 schwarze 694: static struct expr *
1.7 schwarze 695: exprterm(char *buf, int cs)
1.1 schwarze 696: {
1.4 schwarze 697: struct expr e;
1.1 schwarze 698: struct expr *p;
1.3 schwarze 699: char *key;
1.4 schwarze 700: int i;
1.1 schwarze 701:
1.4 schwarze 702: memset(&e, 0, sizeof(struct expr));
1.1 schwarze 703:
1.7 schwarze 704: e.cs = cs;
705:
706: /* Choose regex or substring match. */
1.3 schwarze 707:
1.4 schwarze 708: if (NULL == (e.v = strpbrk(buf, "=~"))) {
1.3 schwarze 709: e.regex = 0;
1.4 schwarze 710: e.v = buf;
1.3 schwarze 711: } else {
712: e.regex = '~' == *e.v;
713: *e.v++ = '\0';
714: }
1.1 schwarze 715:
1.7 schwarze 716: /* Determine the record types to search for. */
1.3 schwarze 717:
718: e.mask = 0;
1.4 schwarze 719: if (buf < e.v) {
720: while (NULL != (key = strsep(&buf, ","))) {
1.3 schwarze 721: i = 0;
722: while (types[i].mask &&
1.7 schwarze 723: strcmp(types[i].name, key))
1.3 schwarze 724: i++;
725: e.mask |= types[i].mask;
726: }
727: }
728: if (0 == e.mask)
729: e.mask = TYPE_Nm | TYPE_Nd;
1.1 schwarze 730:
1.4 schwarze 731: if (e.regex) {
1.7 schwarze 732: i = REG_EXTENDED | REG_NOSUB | cs ? 0 : REG_ICASE;
1.4 schwarze 733: if (regcomp(&e.re, e.v, i))
734: return(NULL);
735: }
1.1 schwarze 736:
1.3 schwarze 737: e.v = mandoc_strdup(e.v);
1.1 schwarze 738:
739: p = mandoc_calloc(1, sizeof(struct expr));
740: memcpy(p, &e, sizeof(struct expr));
741: return(p);
742: }
743:
744: void
745: exprfree(struct expr *p)
746: {
1.4 schwarze 747: struct expr *pp;
1.8 ! schwarze 748:
1.4 schwarze 749: while (NULL != p) {
1.7 schwarze 750: if (p->subexpr)
751: exprfree(p->subexpr);
1.4 schwarze 752: if (p->regex)
753: regfree(&p->re);
754: free(p->v);
755: pp = p->next;
756: free(p);
757: p = pp;
758: }
759: }
1.1 schwarze 760:
1.4 schwarze 761: static int
1.8 ! schwarze 762: exprmark(const struct expr *p, const char *cp,
! 763: uint64_t mask, int *ms)
1.4 schwarze 764: {
1.1 schwarze 765:
1.7 schwarze 766: for ( ; p; p = p->next) {
767: if (p->subexpr) {
768: if (exprmark(p->subexpr, cp, mask, ms))
769: return(1);
770: continue;
771: } else if ( ! (mask & p->mask))
1.4 schwarze 772: continue;
1.7 schwarze 773:
1.4 schwarze 774: if (p->regex) {
1.7 schwarze 775: if (regexec(&p->re, cp, 0, NULL, 0))
776: continue;
777: } else if (p->cs) {
778: if (NULL == strstr(cp, p->v))
779: continue;
780: } else {
781: if (NULL == strcasestr(cp, p->v))
782: continue;
783: }
784:
785: if (NULL == ms)
1.4 schwarze 786: return(1);
1.7 schwarze 787: else
788: ms[p->index] = 1;
1.4 schwarze 789: }
1.8 ! schwarze 790:
! 791: return(0);
1.7 schwarze 792: }
793:
794: static int
795: expreval(const struct expr *p, int *ms)
796: {
797: int match;
798:
799: /*
800: * AND has precedence over OR. Analysis is left-right, though
801: * it doesn't matter because there are no side-effects.
802: * Thus, step through pairwise ANDs and accumulate their Boolean
803: * evaluation. If we encounter a single true AND collection or
804: * standalone term, the whole expression is true (by definition
805: * of OR).
806: */
807:
808: for (match = 0; p && ! match; p = p->next) {
809: /* Evaluate a subexpression, if applicable. */
810: if (p->subexpr && ! ms[p->index])
811: ms[p->index] = expreval(p->subexpr, ms);
812:
813: match = ms[p->index];
814: for ( ; p->next && p->next->and; p = p->next) {
815: /* Evaluate a subexpression, if applicable. */
816: if (p->next->subexpr && ! ms[p->next->index])
817: ms[p->next->index] =
818: expreval(p->next->subexpr, ms);
819: match = match && ms[p->next->index];
820: }
821: }
822:
823: return(match);
1.1 schwarze 824: }
825:
1.4 schwarze 826: /*
827: * First, update the array of terms for which this expression evaluates
828: * to true.
829: * Second, logically evaluate all terms over the updated array of truth
830: * values.
831: * If this evaluates to true, mark the expression as satisfied.
832: */
833: static void
1.8 ! schwarze 834: exprexec(const struct expr *e, const char *cp,
! 835: uint64_t mask, struct rec *r)
1.1 schwarze 836: {
837:
1.7 schwarze 838: assert(0 == r->matched);
839: exprmark(e, cp, mask, r->matches);
840: r->matched = expreval(e, r->matches);
1.1 schwarze 841: }