Home | History | Annotate | Line # | Download | only in dist
libmdoc.h revision 1.1.1.9 
      1 /*	$Vendor-Id: libmdoc.h,v 1.61 2010/07/13 23:53:20 schwarze Exp $ */
      2 /*
      3  * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps (at) bsd.lv>
      4  *
      5  * Permission to use, copy, modify, and distribute this software for any
      6  * purpose with or without fee is hereby granted, provided that the above
      7  * copyright notice and this permission notice appear in all copies.
      8  *
      9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
     10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
     11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
     12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
     13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
     14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
     15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
     16  */
     17 #ifndef LIBMDOC_H
     18 #define LIBMDOC_H
     19 
     20 #include "mdoc.h"
     21 
     22 enum	mdoc_next {
     23 	MDOC_NEXT_SIBLING = 0,
     24 	MDOC_NEXT_CHILD
     25 };
     26 
     27 struct	mdoc {
     28 	void		 *data; /* private application data */
     29 	mandocmsg	  msg; /* message callback */
     30 	int		  flags;
     31 #define	MDOC_HALT	 (1 << 0) /* error in parse: halt */
     32 #define	MDOC_LITERAL	 (1 << 1) /* in a literal scope */
     33 #define	MDOC_PBODY	 (1 << 2) /* in the document body */
     34 #define	MDOC_NEWLINE	 (1 << 3) /* first macro/text in a line */
     35 #define	MDOC_PHRASELIT	 (1 << 4) /* literal within a partila phrase */
     36 #define	MDOC_PPHRASE	 (1 << 5) /* within a partial phrase */
     37 #define	MDOC_FREECOL	 (1 << 6) /* `It' invocation should close */
     38 #define	MDOC_SYNOPSIS	 (1 << 7) /* SYNOPSIS-style formatting */
     39 	int		  pflags;
     40 	enum mdoc_next	  next; /* where to put the next node */
     41 	struct mdoc_node *last; /* the last node parsed */
     42 	struct mdoc_node *first; /* the first node parsed */
     43 	struct mdoc_meta  meta; /* document meta-data */
     44 	enum mdoc_sec	  lastnamed;
     45 	enum mdoc_sec	  lastsec;
     46 	struct regset	 *regs; /* registers */
     47 };
     48 
     49 #define	MACRO_PROT_ARGS	struct mdoc *m, \
     50 			enum mdoct tok, \
     51 			int line, \
     52 			int ppos, \
     53 			int *pos, \
     54 			char *buf
     55 
     56 struct	mdoc_macro {
     57 	int		(*fp)(MACRO_PROT_ARGS);
     58 	int		  flags;
     59 #define	MDOC_CALLABLE	 (1 << 0)
     60 #define	MDOC_PARSED	 (1 << 1)
     61 #define	MDOC_EXPLICIT	 (1 << 2)
     62 #define	MDOC_PROLOGUE	 (1 << 3)
     63 #define	MDOC_IGNDELIM	 (1 << 4)
     64 	/* Reserved words in arguments treated as text. */
     65 };
     66 
     67 enum	margserr {
     68 	ARGS_ERROR,
     69 	ARGS_EOLN,
     70 	ARGS_WORD,
     71 	ARGS_PUNCT,
     72 	ARGS_QWORD,
     73 	ARGS_PHRASE,
     74 	ARGS_PPHRASE,
     75 	ARGS_PEND
     76 };
     77 
     78 enum	margverr {
     79 	ARGV_ERROR,
     80 	ARGV_EOLN,
     81 	ARGV_ARG,
     82 	ARGV_WORD
     83 };
     84 
     85 enum	mdelim {
     86 	DELIM_NONE = 0,
     87 	DELIM_OPEN,
     88 	DELIM_MIDDLE,
     89 	DELIM_CLOSE
     90 };
     91 
     92 extern	const struct mdoc_macro *const mdoc_macros;
     93 
     94 __BEGIN_DECLS
     95 
     96 #define		  mdoc_pmsg(m, l, p, t) \
     97 		  (*(m)->msg)((t), (m)->data, (l), (p), NULL)
     98 #define		  mdoc_nmsg(m, n, t) \
     99 		  (*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL)
    100 int		  mdoc_vmsg(struct mdoc *, enum mandocerr,
    101 			int, int, const char *, ...);
    102 int		  mdoc_macro(MACRO_PROT_ARGS);
    103 int		  mdoc_word_alloc(struct mdoc *,
    104 			int, int, const char *);
    105 int		  mdoc_elem_alloc(struct mdoc *, int, int,
    106 			enum mdoct, struct mdoc_arg *);
    107 int		  mdoc_block_alloc(struct mdoc *, int, int,
    108 			enum mdoct, struct mdoc_arg *);
    109 int		  mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
    110 int		  mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
    111 int		  mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
    112 int		  mdoc_endbody_alloc(struct mdoc *m, int line, int pos,
    113 			enum mdoct tok, struct mdoc_node *body,
    114 			enum mdoc_endbody end);
    115 void		  mdoc_node_delete(struct mdoc *, struct mdoc_node *);
    116 void		  mdoc_hash_init(void);
    117 enum mdoct	  mdoc_hash_find(const char *);
    118 enum mdelim	  mdoc_iscdelim(char);
    119 enum mdelim	  mdoc_isdelim(const char *);
    120 size_t		  mdoc_isescape(const char *);
    121 enum	mdoc_sec  mdoc_str2sec(const char *);
    122 time_t		  mdoc_atotime(const char *);
    123 size_t		  mdoc_macro2len(enum mdoct);
    124 const char	 *mdoc_a2att(const char *);
    125 const char	 *mdoc_a2lib(const char *);
    126 const char	 *mdoc_a2st(const char *);
    127 const char	 *mdoc_a2arch(const char *);
    128 const char	 *mdoc_a2vol(const char *);
    129 const char	 *mdoc_a2msec(const char *);
    130 int		  mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
    131 int		  mdoc_valid_post(struct mdoc *);
    132 int		  mdoc_action_pre(struct mdoc *,
    133 			struct mdoc_node *);
    134 int		  mdoc_action_post(struct mdoc *);
    135 enum margverr	  mdoc_argv(struct mdoc *, int, enum mdoct,
    136 			struct mdoc_arg **, int *, char *);
    137 void		  mdoc_argv_free(struct mdoc_arg *);
    138 void		  mdoc_argn_free(struct mdoc_arg *, int);
    139 enum margserr	  mdoc_args(struct mdoc *, int,
    140 			int *, char *, enum mdoct, char **);
    141 enum margserr	  mdoc_zargs(struct mdoc *, int,
    142 			int *, char *, int, char **);
    143 #define	ARGS_DELIM	(1 << 1)
    144 #define	ARGS_TABSEP	(1 << 2)
    145 #define	ARGS_NOWARN	(1 << 3)
    146 
    147 int		  mdoc_macroend(struct mdoc *);
    148 
    149 __END_DECLS
    150 
    151 #endif /*!LIBMDOC_H*/
    152