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

Diff for /mandoc/roff.h between version 1.65 and 1.76

version 1.65, 2018/12/14 06:33:14 version 1.76, 2023/10/24 20:53:12
Line 1 
Line 1 
 /*      $Id$    */  /* $Id$ */
 /*  /*
    * Copyright (c) 2013-2015,2017-2020,2022 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2013,2014,2015,2017,2018 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 21 
Line 21 
 struct  ohash;  struct  ohash;
 struct  mdoc_arg;  struct  mdoc_arg;
 union   mdoc_data;  union   mdoc_data;
   struct  tbl_span;
   struct  eqn_box;
   
 enum    roff_macroset {  enum    roff_macroset {
         MACROSET_NONE = 0,          MACROSET_NONE = 0,
Line 69  enum roff_type {
Line 71  enum roff_type {
 };  };
   
 enum    roff_tok {  enum    roff_tok {
         ROFF_br = 0,          ROFF_br = 0,    /* Beginning of roff(7) requests. */
         ROFF_ce,          ROFF_ce,
           ROFF_fi,
         ROFF_ft,          ROFF_ft,
         ROFF_ll,          ROFF_ll,
         ROFF_mc,          ROFF_mc,
           ROFF_nf,
         ROFF_po,          ROFF_po,
         ROFF_rj,          ROFF_rj,
         ROFF_sp,          ROFF_sp,
         ROFF_ta,          ROFF_ta,
         ROFF_ti,          ROFF_ti,
         ROFF_MAX,          ROFF_MAX,       /* End of requests that generate nodes. */
         ROFF_ab,          ROFF_ab,        /* Requests only used during preprocessing. */
         ROFF_ad,          ROFF_ad,
         ROFF_af,          ROFF_af,
         ROFF_aln,          ROFF_aln,
Line 158  enum roff_tok {
Line 162  enum roff_tok {
         ROFF_fcolor,          ROFF_fcolor,
         ROFF_fdeferlig,          ROFF_fdeferlig,
         ROFF_feature,          ROFF_feature,
         /* MAN_fi; ignored in mdoc(7) */  
         ROFF_fkern,          ROFF_fkern,
         ROFF_fl,          ROFF_fl,
         ROFF_flig,          ROFF_flig,
Line 218  enum roff_tok {
Line 221  enum roff_tok {
         ROFF_mso,          ROFF_mso,
         ROFF_na,          ROFF_na,
         ROFF_ne,          ROFF_ne,
         /* MAN_nf; ignored in mdoc(7) */  
         ROFF_nh,          ROFF_nh,
         ROFF_nhychar,          ROFF_nhychar,
         ROFF_nm,          ROFF_nm,
Line 311  enum roff_tok {
Line 313  enum roff_tok {
         ROFF_writec,          ROFF_writec,
         ROFF_writem,          ROFF_writem,
         ROFF_xflag,          ROFF_xflag,
         ROFF_cblock,          ROFF_cblock,    /* Block end marker "..". */
         ROFF_RENAMED,          ROFF_RENAMED,   /* New name of a renamed request or macro. */
         ROFF_USERDEF,          ROFF_USERDEF,   /* User defined macro. */
         TOKEN_NONE,          TOKEN_NONE,     /* Undefined macro or text/tbl/eqn/comment node. */
         MDOC_Dd,          MDOC_Dd,        /* Beginning of mdoc(7) macros. */
         MDOC_Dt,          MDOC_Dt,
         MDOC_Os,          MDOC_Os,
         MDOC_Sh,          MDOC_Sh,
Line 435  enum roff_tok {
Line 437  enum roff_tok {
         MDOC__Q,          MDOC__Q,
         MDOC__U,          MDOC__U,
         MDOC_Ta,          MDOC_Ta,
         MDOC_MAX,          MDOC_Tg,
         MAN_TH,          MDOC_MAX,       /* End of mdoc(7) macros. */
           MAN_TH,         /* Beginning of man(7) macros. */
         MAN_SH,          MAN_SH,
         MAN_SS,          MAN_SS,
         MAN_TP,          MAN_TP,
Line 457  enum roff_tok {
Line 460  enum roff_tok {
         MAN_I,          MAN_I,
         MAN_IR,          MAN_IR,
         MAN_RI,          MAN_RI,
         MAN_nf,  
         MAN_fi,  
         MAN_RE,          MAN_RE,
         MAN_RS,          MAN_RS,
         MAN_DT,          MAN_DT,
Line 475  enum roff_tok {
Line 476  enum roff_tok {
         MAN_UE,          MAN_UE,
         MAN_MT,          MAN_MT,
         MAN_ME,          MAN_ME,
         MAN_MAX          MAN_MR,
           MAN_MAX         /* End of man(7) macros. */
 };  };
   
 enum    roff_next {  
         ROFF_NEXT_SIBLING = 0,  
         ROFF_NEXT_CHILD  
 };  
   
 /*  /*
  * Indicates that a BODY's formatting has ended, but   * Indicates that a BODY's formatting has ended, but
  * the scope is still open.  Used for badly nested blocks.   * the scope is still open.  Used for badly nested blocks.
Line 510  struct roff_node {
Line 507  struct roff_node {
         struct mdoc_arg  *args;    /* BLOCK/ELEM */          struct mdoc_arg  *args;    /* BLOCK/ELEM */
         union mdoc_data  *norm;    /* Normalized arguments. */          union mdoc_data  *norm;    /* Normalized arguments. */
         char             *string;  /* TEXT */          char             *string;  /* TEXT */
           char             *tag;     /* For less(1) :t and HTML id=. */
         struct tbl_span  *span;    /* TBL */          struct tbl_span  *span;    /* TBL */
         struct eqn_box   *eqn;     /* EQN */          struct eqn_box   *eqn;     /* EQN */
         int               line;    /* Input file line number. */          int               line;    /* Input file line number. */
Line 517  struct roff_node {
Line 515  struct roff_node {
         int               flags;          int               flags;
 #define NODE_VALID       (1 << 0)  /* Has been validated. */  #define NODE_VALID       (1 << 0)  /* Has been validated. */
 #define NODE_ENDED       (1 << 1)  /* Gone past body end mark. */  #define NODE_ENDED       (1 << 1)  /* Gone past body end mark. */
 #define NODE_EOS         (1 << 2)  /* At sentence boundary. */  #define NODE_BROKEN      (1 << 2)  /* Must validate parent when ending. */
 #define NODE_LINE        (1 << 3)  /* First macro/text on line. */  #define NODE_LINE        (1 << 3)  /* First macro/text on line. */
 #define NODE_SYNPRETTY   (1 << 4)  /* SYNOPSIS-style formatting. */  #define NODE_DELIMO      (1 << 4)
 #define NODE_BROKEN      (1 << 5)  /* Must validate parent when ending. */  #define NODE_DELIMC      (1 << 5)
 #define NODE_DELIMO      (1 << 6)  #define NODE_EOS         (1 << 6)  /* At sentence boundary. */
 #define NODE_DELIMC      (1 << 7)  #define NODE_SYNPRETTY   (1 << 7)  /* SYNOPSIS-style formatting. */
 #define NODE_NOSRC       (1 << 8)  /* Generated node, not in input file. */  #define NODE_NOFILL      (1 << 8)  /* Fill mode switched off. */
 #define NODE_NOPRT       (1 << 9)  /* Shall not print anything. */  #define NODE_NOSRC       (1 << 9)  /* Generated node, not in input file. */
   #define NODE_NOPRT       (1 << 10) /* Shall not print anything. */
   #define NODE_ID          (1 << 11) /* Target for deep linking. */
   #define NODE_HREF        (1 << 12) /* Link to another place in this page. */
         int               prev_font; /* Before entering this node. */          int               prev_font; /* Before entering this node. */
         int               aux;     /* Decoded node data, type-dependent. */          int               aux;     /* Decoded node data, type-dependent. */
         enum roff_tok     tok;     /* Request or macro ID. */          enum roff_tok     tok;     /* Request or macro ID. */
Line 534  struct roff_node {
Line 535  struct roff_node {
 };  };
   
 struct  roff_meta {  struct  roff_meta {
           struct roff_node *first;   /* The first node parsed. */
         char             *msec;    /* Manual section, usually a digit. */          char             *msec;    /* Manual section, usually a digit. */
         char             *vol;     /* Manual volume title. */          char             *vol;     /* Manual volume title. */
         char             *os;      /* Operating system. */          char             *os;      /* Operating system. */
Line 541  struct roff_meta {
Line 543  struct roff_meta {
         char             *title;   /* Manual title, usually CAPS. */          char             *title;   /* Manual title, usually CAPS. */
         char             *name;    /* Leading manual name. */          char             *name;    /* Leading manual name. */
         char             *date;    /* Normalized date. */          char             *date;    /* Normalized date. */
           char             *sodest;  /* .so target file name or NULL. */
         int               hasbody; /* Document is not empty. */          int               hasbody; /* Document is not empty. */
         int               rcsids;  /* Bits indexed by enum mandoc_os. */          int               rcsids;  /* Bits indexed by enum mandoc_os. */
         enum mandoc_os    os_e;    /* Operating system. */          enum mandoc_os    os_e;    /* Operating system. */
 };  
   
 struct  roff_man {  
         struct roff_meta  meta;    /* Document meta-data. */  
         struct roff      *roff;    /* Roff parser state data. */  
         struct ohash     *mdocmac; /* Mdoc macro lookup table. */  
         struct ohash     *manmac;  /* Man macro lookup table. */  
         const char       *os_s;    /* Default operating system. */  
         struct roff_node *first;   /* The first node parsed. */  
         struct roff_node *last;    /* The last node parsed. */  
         struct roff_node *last_es; /* The most recent Es node. */  
         int               quick;   /* Abort parse early. */  
         int               flags;   /* Parse flags. */  
 #define MDOC_LITERAL     (1 << 1)  /* In a literal scope. */  
 #define MDOC_PBODY       (1 << 2)  /* In the document body. */  
 #define MDOC_NEWLINE     (1 << 3)  /* First macro/text in a line. */  
 #define MDOC_PHRASE      (1 << 4)  /* In a Bl -column phrase. */  
 #define MDOC_PHRASELIT   (1 << 5)  /* Literal within a phrase. */  
 #define MDOC_FREECOL     (1 << 6)  /* `It' invocation should close. */  
 #define MDOC_SYNOPSIS    (1 << 7)  /* SYNOPSIS-style formatting. */  
 #define MDOC_KEEP        (1 << 8)  /* In a word keep. */  
 #define MDOC_SMOFF       (1 << 9)  /* Spacing is off. */  
 #define MDOC_NODELIMC    (1 << 10) /* Disable closing delimiter handling. */  
 #define MAN_ELINE        (1 << 11) /* Next-line element scope. */  
 #define MAN_BLINE        (1 << 12) /* Next-line block scope. */  
 #define MDOC_PHRASEQF    (1 << 13) /* Quote first word encountered. */  
 #define MDOC_PHRASEQL    (1 << 14) /* Quote last word of this phrase. */  
 #define MDOC_PHRASEQN    (1 << 15) /* Quote first word of the next phrase. */  
 #define MAN_LITERAL       MDOC_LITERAL  
 #define MAN_NEWLINE       MDOC_NEWLINE  
         enum roff_macroset macroset; /* Kind of high-level macros used. */          enum roff_macroset macroset; /* Kind of high-level macros used. */
         enum roff_sec     lastsec; /* Last section seen. */  
         enum roff_sec     lastnamed; /* Last standard section seen. */  
         enum roff_next    next;    /* Where to put the next node. */  
 };  };
   
 extern  const char *const *roff_name;  extern  const char *const *roff_name;
   
   
 void             deroff(char **, const struct roff_node *);  int               arch_valid(const char *, enum mandoc_os);
 void             roff_validate(struct roff_man *);  void              deroff(char **, const struct roff_node *);
   struct roff_node *roff_node_child(struct roff_node *);
   struct roff_node *roff_node_next(struct roff_node *);
   struct roff_node *roff_node_prev(struct roff_node *);
   int               roff_node_transparent(struct roff_node *);
   int               roff_tok_transparent(enum roff_tok);
Legend:
Removed from v.1.65  
changed lines
  Added in v.1.76
CVSweb