[BACK]Return to libmdoc.h CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/libmdoc.h between version 1.44 and 1.85

version 1.44, 2010/05/14 17:31:25 version 1.85, 2014/07/02 03:48:07
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2013 Ingo Schwarze <schwarze@openbsd.org>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above   * purpose with or without fee is hereby granted, provided that the above
Line 17 
Line 18 
 #ifndef LIBMDOC_H  #ifndef LIBMDOC_H
 #define LIBMDOC_H  #define LIBMDOC_H
   
 #include "mdoc.h"  
   
 enum    mdoc_next {  enum    mdoc_next {
         MDOC_NEXT_SIBLING = 0,          MDOC_NEXT_SIBLING = 0,
         MDOC_NEXT_CHILD          MDOC_NEXT_CHILD
 };  };
   
 struct  mdoc {  struct  mdoc {
         void             *data;          struct mparse    *parse; /* parse pointer */
         struct mdoc_cb    cb;          char             *defos; /* default argument for .Os */
         int               flags;          int               quick; /* abort parse early */
           int               flags; /* parse flags */
 #define MDOC_HALT        (1 << 0) /* error in parse: halt */  #define MDOC_HALT        (1 << 0) /* error in parse: halt */
 #define MDOC_LITERAL     (1 << 1) /* in a literal scope */  #define MDOC_LITERAL     (1 << 1) /* in a literal scope */
 #define MDOC_PBODY       (1 << 2) /* in the document body */  #define MDOC_PBODY       (1 << 2) /* in the document body */
 #define MDOC_NEWLINE     (1 << 3) /* first macro/text in a line */  #define MDOC_NEWLINE     (1 << 3) /* first macro/text in a line */
 #define MDOC_PHRASELIT   (1 << 4) /* in a literal within a phrase */  #define MDOC_PHRASELIT   (1 << 4) /* literal within a partila phrase */
         int               pflags;  #define MDOC_PPHRASE     (1 << 5) /* within a partial phrase */
         enum mdoc_next    next;  #define MDOC_FREECOL     (1 << 6) /* `It' invocation should close */
         struct mdoc_node *last;  #define MDOC_SYNOPSIS    (1 << 7) /* SYNOPSIS-style formatting */
         struct mdoc_node *first;  #define MDOC_KEEP        (1 << 8) /* in a word keep */
         struct mdoc_meta  meta;  #define MDOC_SMOFF       (1 << 9) /* spacing is off */
           enum mdoc_next    next; /* where to put the next node */
           struct mdoc_node *last; /* the last node parsed */
           struct mdoc_node *first; /* the first node parsed */
           struct mdoc_node *last_es; /* the most recent Es node */
           struct mdoc_meta  meta; /* document meta-data */
         enum mdoc_sec     lastnamed;          enum mdoc_sec     lastnamed;
         enum mdoc_sec     lastsec;          enum mdoc_sec     lastsec;
           struct roff      *roff;
 };  };
   
 enum    merr {  #define MACRO_PROT_ARGS struct mdoc *mdoc, \
         ETAILWS = 0,                          enum mdoct tok, \
         EQUOTPARM,                          int line, \
         EQUOTTERM,                          int ppos, \
         EARGVAL,                          int *pos, \
         EBODYPROL,                          char *buf
         EPROLBODY,  
         ETEXTPROL,  
         ENOBLANK,  
         ETOOLONG,  
         EESCAPE,  
         EPRINT,  
         ENODAT,  
         ENOPROLOGUE,  
         ELINE,  
         EATT,  
         ENAME,  
         ELISTTYPE,  
         EDISPTYPE,  
         EMULTIDISP,  
         EMULTILIST,  
         ESECNAME,  
         ENAMESECINC,  
         EARGREP,  
         EBOOL,  
         ECOLMIS,  
         ENESTDISP,  
         EMISSWIDTH,  
         EWRONGMSEC,  
         ESECOOO,  
         ESECREP,  
         EBADSTAND,  
         ENOMULTILINE,  
         EMULTILINE,  
         ENOLINE,  
         EPROLOOO,  
         EPROLREP,  
         EBADSEC,  
         EFONT,  
         EBADDATE,  
         ENUMFMT,  
         ENOWIDTH,  
         EUTSNAME,  
         EOBS,  
         EIMPBRK,  
         EIGNE,  
         EOPEN,  
         EQUOTPHR,  
         ENOCTX,  
         ELIB,  
         EBADCHILD,  
         ENOTYPE,  
         EBADCOMMENT,  
         MERRMAX  
 };  
   
 #define MACRO_PROT_ARGS struct mdoc *m, enum mdoct tok, \  
                         int line, int ppos, int *pos, char *buf  
   
 struct  mdoc_macro {  struct  mdoc_macro {
         int             (*fp)(MACRO_PROT_ARGS);          int             (*fp)(MACRO_PROT_ARGS);
         int               flags;          int               flags;
Line 108  struct mdoc_macro {
Line 62  struct mdoc_macro {
 #define MDOC_PARSED      (1 << 1)  #define MDOC_PARSED      (1 << 1)
 #define MDOC_EXPLICIT    (1 << 2)  #define MDOC_EXPLICIT    (1 << 2)
 #define MDOC_PROLOGUE    (1 << 3)  #define MDOC_PROLOGUE    (1 << 3)
 #define MDOC_IGNDELIM    (1 << 4)  #define MDOC_IGNDELIM    (1 << 4)
         /* Reserved words in arguments treated as text. */  #define MDOC_JOIN        (1 << 5)
 };  };
   
 enum    margserr {  enum    margserr {
         ARGS_ERROR,          ARGS_ERROR,
         ARGS_EOLN,          ARGS_EOLN, /* end-of-line */
         ARGS_WORD,          ARGS_WORD, /* normal word */
         ARGS_PUNCT,          ARGS_PUNCT, /* series of punctuation */
         ARGS_QWORD,          ARGS_QWORD, /* quoted word */
         ARGS_PHRASE,          ARGS_PHRASE, /* Ta'd phrase (-column) */
         ARGS_PPHRASE,          ARGS_PPHRASE, /* tabbed phrase (-column) */
         ARGS_PEND          ARGS_PEND /* last phrase (-column) */
 };  };
   
 enum    margverr {  enum    margverr {
         ARGV_ERROR,          ARGV_ERROR,
         ARGV_EOLN,          ARGV_EOLN, /* end of line */
         ARGV_ARG,          ARGV_ARG, /* valid argument */
         ARGV_WORD          ARGV_WORD /* normal word (or bad argument---same thing) */
 };  };
   
   /*
    * A punctuation delimiter is opening, closing, or "middle mark"
    * punctuation.  These govern spacing.
    * Opening punctuation (e.g., the opening parenthesis) suppresses the
    * following space; closing punctuation (e.g., the closing parenthesis)
    * suppresses the leading space; middle punctuation (e.g., the vertical
    * bar) can do either.  The middle punctuation delimiter bends the rules
    * depending on usage.
    */
   enum    mdelim {
           DELIM_NONE = 0,
           DELIM_OPEN,
           DELIM_MIDDLE,
           DELIM_CLOSE,
           DELIM_MAX
   };
   
 extern  const struct mdoc_macro *const mdoc_macros;  extern  const struct mdoc_macro *const mdoc_macros;
   
 __BEGIN_DECLS  __BEGIN_DECLS
   
 #define           mdoc_perr(m, l, p, t) \  #define           mdoc_pmsg(mdoc, l, p, t) \
                   mdoc_err((m), (l), (p), 1, (t))                    mandoc_msg((t), (mdoc)->parse, (l), (p), NULL)
 #define           mdoc_pwarn(m, l, p, t) \  #define           mdoc_nmsg(mdoc, n, t) \
                   mdoc_err((m), (l), (p), 0, (t))                    mandoc_msg((t), (mdoc)->parse, (n)->line, (n)->pos, NULL)
 #define           mdoc_nerr(m, n, t) \  
                   mdoc_err((m), (n)->line, (n)->pos, 1, (t))  
 #define           mdoc_nwarn(m, n, t) \  
                   mdoc_err((m), (n)->line, (n)->pos, 0, (t))  
   
 int               mdoc_err(struct mdoc *, int, int, int, enum merr);  
 int               mdoc_verr(struct mdoc *, int, int, const char *, ...);  
 int               mdoc_vwarn(struct mdoc *, int, int, const char *, ...);  
   
 int               mdoc_macro(MACRO_PROT_ARGS);  int               mdoc_macro(MACRO_PROT_ARGS);
 int               mdoc_word_alloc(struct mdoc *,  int               mdoc_word_alloc(struct mdoc *,
                         int, int, const char *);                          int, int, const char *);
 int               mdoc_elem_alloc(struct mdoc *, int, int,  void              mdoc_word_append(struct mdoc *, const char *);
   int               mdoc_elem_alloc(struct mdoc *, int, int,
                         enum mdoct, struct mdoc_arg *);                          enum mdoct, struct mdoc_arg *);
 int               mdoc_block_alloc(struct mdoc *, int, int,  int               mdoc_block_alloc(struct mdoc *, int, int,
                         enum mdoct, struct mdoc_arg *);                          enum mdoct, struct mdoc_arg *);
 int               mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);  int               mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
 int               mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);  int               mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
 int               mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);  int               mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
   int               mdoc_endbody_alloc(struct mdoc *, int, int, enum mdoct,
                           struct mdoc_node *, enum mdoc_endbody);
 void              mdoc_node_delete(struct mdoc *, struct mdoc_node *);  void              mdoc_node_delete(struct mdoc *, struct mdoc_node *);
   int               mdoc_node_relink(struct mdoc *, struct mdoc_node *);
 void              mdoc_hash_init(void);  void              mdoc_hash_init(void);
 enum mdoct        mdoc_hash_find(const char *);  enum mdoct        mdoc_hash_find(const char *);
 int               mdoc_iscdelim(char);  
 int               mdoc_isdelim(const char *);  
 size_t            mdoc_isescape(const char *);  
 enum    mdoc_sec  mdoc_str2sec(const char *);  
 time_t            mdoc_atotime(const char *);  
 size_t            mdoc_macro2len(enum mdoct);  
 const char       *mdoc_a2att(const char *);  const char       *mdoc_a2att(const char *);
 const char       *mdoc_a2lib(const char *);  const char       *mdoc_a2lib(const char *);
 const char       *mdoc_a2st(const char *);  const char       *mdoc_a2st(const char *);
 const char       *mdoc_a2arch(const char *);  const char       *mdoc_a2arch(const char *);
 const char       *mdoc_a2vol(const char *);  const char       *mdoc_a2vol(const char *);
 const char       *mdoc_a2msec(const char *);  int               mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
 int               mdoc_valid_pre(struct mdoc *,  
                         const struct mdoc_node *);  
 int               mdoc_valid_post(struct mdoc *);  int               mdoc_valid_post(struct mdoc *);
 int               mdoc_action_pre(struct mdoc *,  
                         const struct mdoc_node *);  
 int               mdoc_action_post(struct mdoc *);  
 enum margverr     mdoc_argv(struct mdoc *, int, enum mdoct,  enum margverr     mdoc_argv(struct mdoc *, int, enum mdoct,
                         struct mdoc_arg **, int *, char *);                          struct mdoc_arg **, int *, char *);
 void              mdoc_argv_free(struct mdoc_arg *);  void              mdoc_argv_free(struct mdoc_arg *);
 void              mdoc_argn_free(struct mdoc_arg *, int);  
 enum margserr     mdoc_args(struct mdoc *, int,  enum margserr     mdoc_args(struct mdoc *, int,
                         int *, char *, enum mdoct, char **);                          int *, char *, enum mdoct, char **);
 enum margserr     mdoc_zargs(struct mdoc *, int,  enum margserr     mdoc_zargs(struct mdoc *, int,
                         int *, char *, int, char **);                          int *, char *, char **);
 #define ARGS_DELIM      (1 << 1)  
 #define ARGS_TABSEP     (1 << 2)  
 #define ARGS_NOWARN     (1 << 3)  
 #define ARGS_PPHRASED   (1 << 4)  
   
 int               mdoc_macroend(struct mdoc *);  int               mdoc_macroend(struct mdoc *);
   enum mdelim       mdoc_isdelim(const char *);
   
 __END_DECLS  __END_DECLS
   
Legend:
Removed from v.1.44  
changed lines
  Added in v.1.85
CVSweb