Home | History | Annotate | Line # | Download | only in dist
libmdoc.h revision 1.1.1.15 
      1 /*	$Id: libmdoc.h,v 1.1.1.15 2015/12/17 21:58:48 christos Exp $ */
      2 /*
      3  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps (at) bsd.lv>
      4  * Copyright (c) 2013, 2014 Ingo Schwarze <schwarze (at) openbsd.org>
      5  *
      6  * Permission to use, copy, modify, and distribute this software for any
      7  * purpose with or without fee is hereby granted, provided that the above
      8  * copyright notice and this permission notice appear in all copies.
      9  *
     10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
     11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
     12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
     13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
     14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
     15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
     16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
     17  */
     18 
     19 enum	mdoc_next {
     20 	MDOC_NEXT_SIBLING = 0,
     21 	MDOC_NEXT_CHILD
     22 };
     23 
     24 struct	mdoc {
     25 	struct mparse	 *parse; /* parse pointer */
     26 	const char	 *defos; /* default argument for .Os */
     27 	int		  quick; /* abort parse early */
     28 	int		  flags; /* parse flags */
     29 #define	MDOC_LITERAL	 (1 << 1) /* in a literal scope */
     30 #define	MDOC_PBODY	 (1 << 2) /* in the document body */
     31 #define	MDOC_NEWLINE	 (1 << 3) /* first macro/text in a line */
     32 #define	MDOC_PHRASELIT	 (1 << 4) /* literal within a partila phrase */
     33 #define	MDOC_PPHRASE	 (1 << 5) /* within a partial phrase */
     34 #define	MDOC_FREECOL	 (1 << 6) /* `It' invocation should close */
     35 #define	MDOC_SYNOPSIS	 (1 << 7) /* SYNOPSIS-style formatting */
     36 #define	MDOC_KEEP	 (1 << 8) /* in a word keep */
     37 #define	MDOC_SMOFF	 (1 << 9) /* spacing is off */
     38 #define	MDOC_NODELIMC	 (1 << 10) /* disable closing delimiter handling */
     39 	enum mdoc_next	  next; /* where to put the next node */
     40 	struct mdoc_node *last; /* the last node parsed */
     41 	struct mdoc_node *first; /* the first node parsed */
     42 	struct mdoc_node *last_es; /* the most recent Es node */
     43 	struct mdoc_meta  meta; /* document meta-data */
     44 	enum mdoc_sec	  lastnamed;
     45 	enum mdoc_sec	  lastsec;
     46 	struct roff	 *roff;
     47 };
     48 
     49 #define	MACRO_PROT_ARGS	struct mdoc *mdoc, \
     50 			enum mdoct tok, \
     51 			int line, \
     52 			int ppos, \
     53 			int *pos, \
     54 			char *buf
     55 
     56 struct	mdoc_macro {
     57 	void		(*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 #define	MDOC_JOIN	 (1 << 5)
     65 };
     66 
     67 enum	margserr {
     68 	ARGS_ERROR,
     69 	ARGS_EOLN, /* end-of-line */
     70 	ARGS_WORD, /* normal word */
     71 	ARGS_PUNCT, /* series of punctuation */
     72 	ARGS_QWORD, /* quoted word */
     73 	ARGS_PHRASE, /* Ta'd phrase (-column) */
     74 	ARGS_PPHRASE, /* tabbed phrase (-column) */
     75 	ARGS_PEND /* last phrase (-column) */
     76 };
     77 
     78 /*
     79  * A punctuation delimiter is opening, closing, or "middle mark"
     80  * punctuation.  These govern spacing.
     81  * Opening punctuation (e.g., the opening parenthesis) suppresses the
     82  * following space; closing punctuation (e.g., the closing parenthesis)
     83  * suppresses the leading space; middle punctuation (e.g., the vertical
     84  * bar) can do either.  The middle punctuation delimiter bends the rules
     85  * depending on usage.
     86  */
     87 enum	mdelim {
     88 	DELIM_NONE = 0,
     89 	DELIM_OPEN,
     90 	DELIM_MIDDLE,
     91 	DELIM_CLOSE,
     92 	DELIM_MAX
     93 };
     94 
     95 extern	const struct mdoc_macro *const mdoc_macros;
     96 
     97 __BEGIN_DECLS
     98 
     99 void		  mdoc_macro(MACRO_PROT_ARGS);
    100 void		  mdoc_word_alloc(struct mdoc *, int, int, const char *);
    101 void		  mdoc_word_append(struct mdoc *, const char *);
    102 void		  mdoc_elem_alloc(struct mdoc *, int, int,
    103 			enum mdoct, struct mdoc_arg *);
    104 struct mdoc_node *mdoc_block_alloc(struct mdoc *, int, int,
    105 			enum mdoct, struct mdoc_arg *);
    106 struct mdoc_node *mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
    107 void		  mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
    108 struct mdoc_node *mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
    109 struct mdoc_node *mdoc_endbody_alloc(struct mdoc *, int, int, enum mdoct,
    110 			struct mdoc_node *, enum mdoc_endbody);
    111 void		  mdoc_node_delete(struct mdoc *, struct mdoc_node *);
    112 void		  mdoc_node_relink(struct mdoc *, struct mdoc_node *);
    113 void		  mdoc_hash_init(void);
    114 enum mdoct	  mdoc_hash_find(const char *);
    115 const char	 *mdoc_a2att(const char *);
    116 const char	 *mdoc_a2lib(const char *);
    117 const char	 *mdoc_a2st(const char *);
    118 const char	 *mdoc_a2arch(const char *);
    119 void		  mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
    120 void		  mdoc_valid_post(struct mdoc *);
    121 void		  mdoc_argv(struct mdoc *, int, enum mdoct,
    122 			struct mdoc_arg **, int *, char *);
    123 void		  mdoc_argv_free(struct mdoc_arg *);
    124 enum margserr	  mdoc_args(struct mdoc *, int,
    125 			int *, char *, enum mdoct, char **);
    126 void		  mdoc_macroend(struct mdoc *);
    127 enum mdelim	  mdoc_isdelim(const char *);
    128 
    129 __END_DECLS
    130