1322249Sbapt/* $Id: mansearch.h,v 1.28 2017/04/17 20:05:08 schwarze Exp $ */ 2274876Sbapt/* 3274876Sbapt * Copyright (c) 2012 Kristaps Dzonsons <kristaps@bsd.lv> 4322249Sbapt * Copyright (c) 2013, 2014, 2016, 2017 Ingo Schwarze <schwarze@openbsd.org> 5274876Sbapt * 6274876Sbapt * Permission to use, copy, modify, and distribute this software for any 7274876Sbapt * purpose with or without fee is hereby granted, provided that the above 8274876Sbapt * copyright notice and this permission notice appear in all copies. 9274876Sbapt * 10274876Sbapt * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 11274876Sbapt * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12274876Sbapt * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 13274876Sbapt * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14274876Sbapt * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 15274876Sbapt * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 16274876Sbapt * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17274876Sbapt */ 18274876Sbapt 19274876Sbapt#define MANDOC_DB "mandoc.db" 20316420Sbapt#define MANDOCDB_MAGIC 0x3a7d0cdb 21316420Sbapt#define MANDOCDB_VERSION 1 22274876Sbapt 23316420Sbapt#define MACRO_MAX 36 24322249Sbapt#define KEY_arch 0 25322249Sbapt#define KEY_sec 1 26322249Sbapt#define KEY_Nm 38 27316420Sbapt#define KEY_Nd 39 28316420Sbapt#define KEY_MAX 40 29316420Sbapt 30274876Sbapt#define TYPE_arch 0x0000000000000001ULL 31274876Sbapt#define TYPE_sec 0x0000000000000002ULL 32274876Sbapt#define TYPE_Xr 0x0000000000000004ULL 33274876Sbapt#define TYPE_Ar 0x0000000000000008ULL 34274876Sbapt#define TYPE_Fa 0x0000000000000010ULL 35274876Sbapt#define TYPE_Fl 0x0000000000000020ULL 36274876Sbapt#define TYPE_Dv 0x0000000000000040ULL 37274876Sbapt#define TYPE_Fn 0x0000000000000080ULL 38274876Sbapt#define TYPE_Ic 0x0000000000000100ULL 39274876Sbapt#define TYPE_Pa 0x0000000000000200ULL 40274876Sbapt#define TYPE_Cm 0x0000000000000400ULL 41274876Sbapt#define TYPE_Li 0x0000000000000800ULL 42274876Sbapt#define TYPE_Em 0x0000000000001000ULL 43274876Sbapt#define TYPE_Cd 0x0000000000002000ULL 44274876Sbapt#define TYPE_Va 0x0000000000004000ULL 45274876Sbapt#define TYPE_Ft 0x0000000000008000ULL 46274876Sbapt#define TYPE_Tn 0x0000000000010000ULL 47274876Sbapt#define TYPE_Er 0x0000000000020000ULL 48274876Sbapt#define TYPE_Ev 0x0000000000040000ULL 49274876Sbapt#define TYPE_Sy 0x0000000000080000ULL 50274876Sbapt#define TYPE_Sh 0x0000000000100000ULL 51274876Sbapt#define TYPE_In 0x0000000000200000ULL 52274876Sbapt#define TYPE_Ss 0x0000000000400000ULL 53274876Sbapt#define TYPE_Ox 0x0000000000800000ULL 54274876Sbapt#define TYPE_An 0x0000000001000000ULL 55274876Sbapt#define TYPE_Mt 0x0000000002000000ULL 56274876Sbapt#define TYPE_St 0x0000000004000000ULL 57274876Sbapt#define TYPE_Bx 0x0000000008000000ULL 58274876Sbapt#define TYPE_At 0x0000000010000000ULL 59274876Sbapt#define TYPE_Nx 0x0000000020000000ULL 60274876Sbapt#define TYPE_Fx 0x0000000040000000ULL 61274876Sbapt#define TYPE_Lk 0x0000000080000000ULL 62274876Sbapt#define TYPE_Ms 0x0000000100000000ULL 63274876Sbapt#define TYPE_Bsx 0x0000000200000000ULL 64274876Sbapt#define TYPE_Dx 0x0000000400000000ULL 65274876Sbapt#define TYPE_Rs 0x0000000800000000ULL 66274876Sbapt#define TYPE_Vt 0x0000001000000000ULL 67274876Sbapt#define TYPE_Lb 0x0000002000000000ULL 68274876Sbapt#define TYPE_Nm 0x0000004000000000ULL 69274876Sbapt#define TYPE_Nd 0x0000008000000000ULL 70274876Sbapt 71274876Sbapt#define NAME_SYN 0x0000004000000001ULL 72275432Sbapt#define NAME_FIRST 0x0000004000000004ULL 73275432Sbapt#define NAME_TITLE 0x0000004000000006ULL 74275432Sbapt#define NAME_HEAD 0x0000004000000008ULL 75275432Sbapt#define NAME_FILE 0x0000004000000010ULL 76274876Sbapt#define NAME_MASK 0x000000000000001fULL 77274876Sbapt 78316420Sbaptenum form { 79316420Sbapt FORM_SRC = 1, /* Format is mdoc(7) or man(7). */ 80316420Sbapt FORM_CAT, /* Manual page is preformatted. */ 81316420Sbapt FORM_NONE /* Format is unknown. */ 82316420Sbapt}; 83274876Sbapt 84275432Sbaptenum argmode { 85275432Sbapt ARG_FILE = 0, 86275432Sbapt ARG_NAME, 87275432Sbapt ARG_WORD, 88275432Sbapt ARG_EXPR 89275432Sbapt}; 90275432Sbapt 91274876Sbaptstruct manpage { 92274876Sbapt char *file; /* to be prefixed by manpath */ 93274876Sbapt char *names; /* a list of names with sections */ 94274876Sbapt char *output; /* user-defined additional output */ 95275432Sbapt size_t ipath; /* number of the manpath */ 96275432Sbapt uint64_t bits; /* name type mask */ 97274876Sbapt int sec; /* section number, 10 means invalid */ 98316420Sbapt enum form form; 99274876Sbapt}; 100274876Sbapt 101274876Sbaptstruct mansearch { 102274876Sbapt const char *arch; /* architecture/NULL */ 103274876Sbapt const char *sec; /* mansection/NULL */ 104275432Sbapt const char *outkey; /* show content of this macro */ 105275432Sbapt enum argmode argmode; /* interpretation of arguments */ 106275432Sbapt int firstmatch; /* first matching database only */ 107274876Sbapt}; 108274876Sbapt 109275432Sbapt 110276219Sbaptstruct manpaths; 111276219Sbapt 112274876Sbaptint mansearch(const struct mansearch *cfg, /* options */ 113274876Sbapt const struct manpaths *paths, /* manpaths */ 114274876Sbapt int argc, /* size of argv */ 115274876Sbapt char *argv[], /* search terms */ 116274876Sbapt struct manpage **res, /* results */ 117274876Sbapt size_t *ressz); /* results returned */ 118275432Sbaptvoid mansearch_free(struct manpage *, size_t); 119