1*ff2dbb0fSschwarze /* $OpenBSD: dbm.h,v 1.1 2016/08/01 10:32:39 schwarze Exp $ */ 2*ff2dbb0fSschwarze /* 3*ff2dbb0fSschwarze * Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org> 4*ff2dbb0fSschwarze * 5*ff2dbb0fSschwarze * Permission to use, copy, modify, and distribute this software for any 6*ff2dbb0fSschwarze * purpose with or without fee is hereby granted, provided that the above 7*ff2dbb0fSschwarze * copyright notice and this permission notice appear in all copies. 8*ff2dbb0fSschwarze * 9*ff2dbb0fSschwarze * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10*ff2dbb0fSschwarze * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11*ff2dbb0fSschwarze * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12*ff2dbb0fSschwarze * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13*ff2dbb0fSschwarze * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14*ff2dbb0fSschwarze * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15*ff2dbb0fSschwarze * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16*ff2dbb0fSschwarze * 17*ff2dbb0fSschwarze * Public interface for the map-based version 18*ff2dbb0fSschwarze * of the mandoc database, for read-only access. 19*ff2dbb0fSschwarze * To be used by dbm*.c, dba_read.c, and man(1) and apropos(1). 20*ff2dbb0fSschwarze */ 21*ff2dbb0fSschwarze 22*ff2dbb0fSschwarze enum dbm_mtype { 23*ff2dbb0fSschwarze DBM_EXACT = 0, 24*ff2dbb0fSschwarze DBM_SUB, 25*ff2dbb0fSschwarze DBM_REGEX 26*ff2dbb0fSschwarze }; 27*ff2dbb0fSschwarze 28*ff2dbb0fSschwarze struct dbm_match { 29*ff2dbb0fSschwarze regex_t *re; 30*ff2dbb0fSschwarze const char *str; 31*ff2dbb0fSschwarze enum dbm_mtype type; 32*ff2dbb0fSschwarze }; 33*ff2dbb0fSschwarze 34*ff2dbb0fSschwarze struct dbm_res { 35*ff2dbb0fSschwarze int32_t page; 36*ff2dbb0fSschwarze int32_t bits; 37*ff2dbb0fSschwarze }; 38*ff2dbb0fSschwarze 39*ff2dbb0fSschwarze struct dbm_page { 40*ff2dbb0fSschwarze const char *name; 41*ff2dbb0fSschwarze const char *sect; 42*ff2dbb0fSschwarze const char *arch; 43*ff2dbb0fSschwarze const char *desc; 44*ff2dbb0fSschwarze const char *file; 45*ff2dbb0fSschwarze int32_t addr; 46*ff2dbb0fSschwarze }; 47*ff2dbb0fSschwarze 48*ff2dbb0fSschwarze struct dbm_macro { 49*ff2dbb0fSschwarze const char *value; 50*ff2dbb0fSschwarze const int32_t *pp; 51*ff2dbb0fSschwarze }; 52*ff2dbb0fSschwarze 53*ff2dbb0fSschwarze int dbm_open(const char *); 54*ff2dbb0fSschwarze void dbm_close(void); 55*ff2dbb0fSschwarze 56*ff2dbb0fSschwarze int32_t dbm_page_count(void); 57*ff2dbb0fSschwarze struct dbm_page *dbm_page_get(int32_t); 58*ff2dbb0fSschwarze void dbm_page_byname(const struct dbm_match *); 59*ff2dbb0fSschwarze void dbm_page_bysect(const struct dbm_match *); 60*ff2dbb0fSschwarze void dbm_page_byarch(const struct dbm_match *); 61*ff2dbb0fSschwarze void dbm_page_bydesc(const struct dbm_match *); 62*ff2dbb0fSschwarze void dbm_page_bymacro(int32_t, const struct dbm_match *); 63*ff2dbb0fSschwarze struct dbm_res dbm_page_next(void); 64*ff2dbb0fSschwarze 65*ff2dbb0fSschwarze int32_t dbm_macro_count(int32_t); 66*ff2dbb0fSschwarze struct dbm_macro *dbm_macro_get(int32_t, int32_t); 67*ff2dbb0fSschwarze void dbm_macro_bypage(int32_t, int32_t); 68*ff2dbb0fSschwarze char *dbm_macro_next(void); 69