In one of the examples, the tbl(7) source code displayed

[mandoc.git] / mansearch.h

diff --git a/mansearch.h b/mansearch.h
index 6cc6f41047a6293952af29b9985b11b41a1eaa6b..8a0aa121d0c6a50404fc37cdb7d197248c4362d9 100644 (file)
--- a/mansearch.h
+++ b/mansearch.h
@@ -1,7 +1,7 @@
-/*     $Id: mansearch.h,v 1.17 2014/09/01 22:45:53 schwarze Exp $ */
+/*     $Id: mansearch.h,v 1.30 2019/04/30 18:51:57 schwarze Exp $ */
 /*
  * Copyright (c) 2012 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2013, 2014, 2016, 2017 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -15,10 +15,17 @@
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-#ifndef MANSEARCH_H
-#define MANSEARCH_H
 
 #define        MANDOC_DB        "mandoc.db"
+#define        MANDOCDB_MAGIC   0x3a7d0cdb
+#define        MANDOCDB_VERSION 1
+
+#define        MACRO_MAX        36
+#define        KEY_arch         0
+#define        KEY_sec          1
+#define        KEY_Nm           38
+#define        KEY_Nd           39
+#define        KEY_MAX          40
 
 #define        TYPE_arch        0x0000000000000001ULL
 #define        TYPE_sec         0x0000000000000002ULL
@@ -62,12 +69,18 @@
 #define        TYPE_Nd          0x0000008000000000ULL
 
 #define        NAME_SYN         0x0000004000000001ULL
-#define        NAME_FILE        0x0000004000000002ULL
-#define        NAME_TITLE       0x000000400000000cULL
-#define        NAME_FIRST       0x0000004000000008ULL
-#define        NAME_HEAD        0x0000004000000010ULL
+#define        NAME_FIRST       0x0000004000000004ULL
+#define        NAME_TITLE       0x0000004000000006ULL
+#define        NAME_HEAD        0x0000004000000008ULL
+#define        NAME_FILE        0x0000004000000010ULL
 #define        NAME_MASK        0x000000000000001fULL
 
+enum   form {
+       FORM_SRC = 1,   /* Format is mdoc(7) or man(7). */
+       FORM_CAT,       /* Manual page is preformatted. */
+       FORM_NONE       /* Format is unknown. */
+};
+
 enum   argmode {
        ARG_FILE = 0,
        ARG_NAME,
@@ -79,9 +92,10 @@ struct       manpage {
        char            *file; /* to be prefixed by manpath */
        char            *names; /* a list of names with sections */
        char            *output; /* user-defined additional output */
+       uint64_t         bits; /* name type mask */
        size_t           ipath; /* number of the manpath */
        int              sec; /* section number, 10 means invalid */
-       int              form; /* 0 == catpage */
+       enum form        form;
 };
 
 struct mansearch {
@@ -89,11 +103,12 @@ struct     mansearch {
        const char      *sec; /* mansection/NULL */
        const char      *outkey; /* show content of this macro */
        enum argmode     argmode; /* interpretation of arguments */
+       int              firstmatch; /* first matching database only */
 };
 
-__BEGIN_DECLS
 
-int    mansearch_setup(int);
+struct manpaths;
+
 int    mansearch(const struct mansearch *cfg, /* options */
                const struct manpaths *paths, /* manpaths */
                int argc, /* size of argv */
@@ -101,7 +116,3 @@ int mansearch(const struct mansearch *cfg, /* options */
                struct manpage **res, /* results */
                size_t *ressz); /* results returned */
 void   mansearch_free(struct manpage *, size_t);
-
-__END_DECLS
-
-#endif /* MANSEARCH_H */