credits for release testing

[mandoc.git] / mansearch.h

diff --git a/mansearch.h b/mansearch.h
index 4f92ef2608385b758792601c79614bafbfd49967..8a0aa121d0c6a50404fc37cdb7d197248c4362d9 100644 (file)
--- a/mansearch.h
+++ b/mansearch.h
@@ -1,7 +1,7 @@
-/*     $Id: mansearch.h,v 1.21 2014/11/27 01:58:21 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) 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
  *
  * 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.
  */
  * 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        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
 
 #define        TYPE_arch        0x0000000000000001ULL
 #define        TYPE_sec         0x0000000000000002ULL


@@ -68,9 +75,11 @@
 #define        NAME_FILE        0x0000004000000010ULL
 #define        NAME_MASK        0x000000000000001fULL
 
 #define        NAME_FILE        0x0000004000000010ULL
 #define        NAME_MASK        0x000000000000001fULL
 

-#define        FORM_CAT         0  /* manual page is preformatted */
-#define        FORM_SRC         1  /* format is mdoc(7) or man(7) */
-#define        FORM_NONE        4  /* format is unknown */
+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,
 
 enum   argmode {
        ARG_FILE = 0,


@@ -83,10 +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 */
        char            *file; /* to be prefixed by manpath */
        char            *names; /* a list of names with sections */
        char            *output; /* user-defined additional output */

-       size_t           ipath; /* number of the manpath */

        uint64_t         bits; /* name type mask */
        uint64_t         bits; /* name type mask */

+       size_t           ipath; /* number of the manpath */

        int              sec; /* section number, 10 means invalid */
        int              sec; /* section number, 10 means invalid */

-       int              form; /* 0 == catpage */
+       enum form        form;

 };
 
 struct mansearch {
 };
 
 struct mansearch {


@@ -97,9 +106,9 @@ struct       mansearch {
        int              firstmatch; /* first matching database only */
 };
 
        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 */
 int    mansearch(const struct mansearch *cfg, /* options */
                const struct manpaths *paths, /* manpaths */
                int argc, /* size of argv */


@@ -107,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);
                struct manpage **res, /* results */
                size_t *ressz); /* results returned */
 void   mansearch_free(struct manpage *, size_t);

-
-__END_DECLS
-
-#endif /* MANSEARCH_H */