mdoc.h

   1 /* $Id: mdoc.h,v 1.6 2008/12/28 23:07:04 kristaps Exp $ */
   2 /*
   3  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
   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
   7  * above copyright notice and this permission notice appear in all
   8  * copies.
   9  *
  10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
  11  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
  12  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
  13  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  14  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  15  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  16  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  17  * PERFORMANCE OF THIS SOFTWARE.
  18  */
  19 #ifndef MDOC_H
  20 #define MDOC_H
  21
  22 #define MDOC_LINEARG_MAX 9
  23
  24 #define MDOC___          0
  25 #define MDOC_Dd          1
  26 #define MDOC_Dt          2
  27 #define MDOC_Os          3
  28 #define MDOC_Sh          4
  29 #define MDOC_Ss          5
  30 #define MDOC_Pp          6
  31 #define MDOC_D1          7
  32 #define MDOC_Dl          8
  33 #define MDOC_Bd          9
  34 #define MDOC_Ed          10
  35 #define MDOC_Bl          11
  36 #define MDOC_El          12
  37 #define MDOC_It          13
  38 #define MDOC_Ad          14
  39 #define MDOC_An          15
  40 #define MDOC_Ar          16
  41 #define MDOC_Cd          17
  42 #define MDOC_Cm          18
  43 #define MDOC_Dv          19
  44 #define MDOC_Er          20
  45 #define MDOC_Ev          21
  46 #define MDOC_Ex          22
  47 #define MDOC_Fa          23
  48 #define MDOC_Fd          24
  49 #define MDOC_Fl          25
  50 #define MDOC_Fn          26
  51 #define MDOC_Ft          27
  52 #define MDOC_Ic          28
  53 #define MDOC_In          29
  54 #define MDOC_Li          30
  55 #define MDOC_Nd          31
  56 #define MDOC_Nm          32
  57 #define MDOC_Op          33
  58 #define MDOC_Ot          34
  59 #define MDOC_Pa          35
  60 #define MDOC_Rv          36
  61 #define MDOC_St          37
  62 #define MDOC_Va          38
  63 #define MDOC_Vt          39
  64 #define MDOC_Xr          40
  65 #define MDOC__A          41
  66 #define MDOC__B          42
  67 #define MDOC__D          43
  68 #define MDOC__I          44
  69 #define MDOC__J          45
  70 #define MDOC__N          46
  71 #define MDOC__O          47
  72 #define MDOC__P          48
  73 #define MDOC__R          49
  74 #define MDOC__T          50
  75 #define MDOC__V          51
  76 #define MDOC_Ac          52
  77 #define MDOC_Ao          53
  78 #define MDOC_Aq          54
  79 #define MDOC_At          55
  80 #define MDOC_Bc          56
  81 #define MDOC_Bf          57
  82 #define MDOC_Bo          58
  83 #define MDOC_Bq          59
  84 #define MDOC_Bsx         60
  85 #define MDOC_Bx          61
  86 #define MDOC_Db          62
  87 #define MDOC_Dc          63
  88 #define MDOC_Do          64
  89 #define MDOC_Dq          65
  90 #define MDOC_Ec          66
  91 #define MDOC_Ef          67
  92 #define MDOC_Em          68
  93 #define MDOC_Eo          69
  94 #define MDOC_Fx          70
  95 #define MDOC_Ms          71
  96 #define MDOC_No          72
  97 #define MDOC_Ns          73
  98 #define MDOC_Nx          74
  99 #define MDOC_Ox          75
 100 #define MDOC_Pc          76
 101 #define MDOC_Pf          77
 102 #define MDOC_Po          78
 103 #define MDOC_Pq          79
 104 #define MDOC_Qc          80
 105 #define MDOC_Ql          81
 106 #define MDOC_Qo          82
 107 #define MDOC_Qq          83
 108 #define MDOC_Re          84
 109 #define MDOC_Rs          85
 110 #define MDOC_Sc          86
 111 #define MDOC_So          87
 112 #define MDOC_Sq          88
 113 #define MDOC_Sm          89
 114 #define MDOC_Sx          90
 115 #define MDOC_Sy          91
 116 #define MDOC_Tn          92
 117 #define MDOC_Ux          93
 118 #define MDOC_Xc          94
 119 #define MDOC_Xo          95
 120 #define MDOC_Fo          96
 121 #define MDOC_Fc          97
 122 #define MDOC_Oo          98
 123 #define MDOC_Oc          99
 124 #define MDOC_Bk          100
 125 #define MDOC_Ek          101
 126 #define MDOC_Bt          102
 127 #define MDOC_Hf          103
 128 #define MDOC_Fr          104
 129 #define MDOC_Ud          105
 130 #define MDOC_MAX         106
 131
 132 #define MDOC_Split       0
 133 #define MDOC_Nosplit     1
 134 #define MDOC_Ragged      2
 135 #define MDOC_Unfilled    3
 136 #define MDOC_Literal     4
 137 #define MDOC_File        5
 138 #define MDOC_Offset      6
 139 #define MDOC_Bullet      7
 140 #define MDOC_Dash        8
 141 #define MDOC_Hyphen      9
 142 #define MDOC_Item        10
 143 #define MDOC_Enum        11
 144 #define MDOC_Tag         12
 145 #define MDOC_Diag        13
 146 #define MDOC_Hang        14
 147 #define MDOC_Ohang       15
 148 #define MDOC_Inset       16
 149 #define MDOC_Column      17
 150 #define MDOC_Width       18
 151 #define MDOC_Compact     19
 152 #define MDOC_Std         20
 153 #define MDOC_p1003_1_88  21
 154 #define MDOC_p1003_1_90  22
 155 #define MDOC_p1003_1_96  23
 156 #define MDOC_p1003_1_2001 24
 157 #define MDOC_p1003_1_2004 25
 158 #define MDOC_p1003_1     26
 159 #define MDOC_p1003_1b    27
 160 #define MDOC_p1003_1b_93 28
 161 #define MDOC_p1003_1c_95 29
 162 #define MDOC_p1003_1g_2000 30
 163 #define MDOC_p1003_2_92  31
 164 #define MDOC_p1387_2_95  32
 165 #define MDOC_p1003_2     33
 166 #define MDOC_p1387_2     34
 167 #define MDOC_isoC_90     35
 168 #define MDOC_isoC_amd1   36
 169 #define MDOC_isoC_tcor1  37
 170 #define MDOC_isoC_tcor2  38
 171 #define MDOC_isoC_99     39
 172 #define MDOC_ansiC       40
 173 #define MDOC_ansiC_89    41
 174 #define MDOC_ansiC_99    42
 175 #define MDOC_ieee754     43
 176 #define MDOC_iso8802_3   44
 177 #define MDOC_xpg3        45
 178 #define MDOC_xpg4        46
 179 #define MDOC_xpg4_2      47
 180 #define MDOC_xpg4_3      48
 181 #define MDOC_xbd5        49
 182 #define MDOC_xcu5        50
 183 #define MDOC_xsh5        51
 184 #define MDOC_xns5        52
 185 #define MDOC_xns5_2d2_0  53
 186 #define MDOC_xcurses4_2  54
 187 #define MDOC_susv2       55
 188 #define MDOC_susv3       56
 189 #define MDOC_svid4       57
 190 #define MDOC_Filled      58
 191 #define MDOC_Words       59
 192 #define MDOC_ARG_MAX     60
 193
 194 enum    mdoc_err {
 195         ERR_SYNTAX_QUOTE, /* NOTUSED */
 196         ERR_SYNTAX_UNQUOTE,
 197         ERR_SYNTAX_WS,
 198         ERR_SYNTAX_ARG,
 199         ERR_SYNTAX_ARGFORM,
 200         ERR_SYNTAX_ARGVAL,
 201         ERR_SYNTAX_ARGBAD,
 202         ERR_SYNTAX_ARGMANY,
 203         ERR_MACRO_NOTSUP,
 204         ERR_MACRO_NOTCALL,
 205         ERR_SCOPE_BREAK,
 206         ERR_SCOPE_NOCTX,
 207         ERR_SCOPE_NONEST,
 208         ERR_SEC_PROLOGUE,
 209         ERR_SEC_NPROLOGUE,
 210         ERR_SEC_PROLOGUE_OO,
 211         ERR_SEC_PROLOGUE_REP,
 212         ERR_SEC_NAME,
 213         ERR_ARGS_GE1,
 214         ERR_ARGS_MANY
 215 };
 216
 217 enum    mdoc_warn {
 218         WARN_SYNTAX_WS_EOLN,
 219         WARN_SYNTAX_MACLIKE,
 220         WARN_SYNTAX_ARGLIKE,
 221         WARN_SYNTAX_QUOTED,
 222         WARN_IGN_AFTER_BLK,
 223         WARN_IGN_BEFORE_BLK,
 224         WARN_SEC_OO,
 225         WARN_ARGS_GE1,
 226         WARN_ARGS_EQ0,
 227         WARN_COMPAT_TROFF
 228 };
 229
 230 struct  mdoc_arg {
 231         int               arg;
 232         size_t            sz;
 233         char            **value;
 234 };
 235
 236 enum    mdoc_type {
 237         MDOC_TEXT,
 238         MDOC_ELEM,
 239         MDOC_HEAD,
 240         MDOC_BODY,
 241         MDOC_BLOCK
 242 };
 243
 244 enum    mdoc_msec {
 245         MSEC_DEFAULT = 0,
 246         MSEC_1,
 247         MSEC_2,
 248         MSEC_3,
 249         MSEC_3f,
 250         MSEC_3p,
 251         MSEC_4,
 252         MSEC_5,
 253         MSEC_6,
 254         MSEC_7,
 255         MSEC_8,
 256         MSEC_9,
 257         MSEC_X11,
 258         MSEC_X11R6,
 259         MSEC_local,
 260         MSEC_n,
 261         MSEC_unass,
 262         MSEC_draft,
 263         MSEC_paper
 264 };
 265
 266 enum    mdoc_sec {
 267         SEC_PROLOGUE = 0,
 268         SEC_BODY,
 269         SEC_NAME,
 270         SEC_SYNOPSIS,
 271         SEC_DESCRIPTION,
 272         SEC_RETURN_VALUES,
 273         SEC_ENVIRONMENT,
 274         SEC_FILES,
 275         SEC_EXAMPLES,
 276         SEC_DIAGNOSTICS,
 277         SEC_ERRORS,
 278         SEC_SEE_ALSO,
 279         SEC_STANDARDS,
 280         SEC_HISTORY,
 281         SEC_AUTHORS,
 282         SEC_CAVEATS,
 283         SEC_BUGS,
 284         SEC_CUSTOM
 285 };
 286
 287 enum    mdoc_vol {
 288         VOL_DEFAULT = 0,
 289         VOL_AMD,
 290         VOL_IND,
 291         VOL_KM,
 292         VOL_LOCAL,
 293         VOL_PRM,
 294         VOL_PS1,
 295         VOL_SMM,
 296         VOL_URM,
 297         VOL_USD
 298 };
 299
 300 enum    mdoc_arch {
 301         ARCH_DEFAULT = 0,
 302         ARCH_alpha,
 303         ARCH_amd64,
 304         ARCH_amiga,
 305         ARCH_arc,
 306         ARCH_armish,
 307         ARCH_aviion,
 308         ARCH_hp300,
 309         ARCH_hppa,
 310         ARCH_hppa64,
 311         ARCH_i386,
 312         ARCH_landisk,
 313         ARCH_luna88k,
 314         ARCH_mac68k,
 315         ARCH_macppc,
 316         ARCH_mvme68k,
 317         ARCH_mvme88k,
 318         ARCH_mvmeppc,
 319         ARCH_pmax,
 320         ARCH_sgi,
 321         ARCH_socppc,
 322         ARCH_sparc,
 323         ARCH_sparc64,
 324         ARCH_sun3,
 325         ARCH_vax,
 326         ARCH_zaurus
 327 };
 328
 329 struct  mdoc_meta {
 330         enum mdoc_msec    msec;
 331         enum mdoc_vol     vol;
 332         enum mdoc_arch    arch;
 333         time_t            date;
 334 #define META_TITLE_SZ    (64)
 335         char              title[META_TITLE_SZ];
 336 #define META_OS_SZ       (64)
 337         char              os[META_OS_SZ];
 338 };
 339
 340 struct  mdoc_text {
 341         char             *string;
 342 };
 343
 344 struct  mdoc_block {
 345         int               tok;
 346         size_t            argc;
 347         struct mdoc_arg  *argv;
 348 };
 349
 350 struct  mdoc_head {
 351         size_t            sz;
 352         char            **args;
 353         int               tok;
 354 };
 355
 356 struct  mdoc_body {
 357         int               tok;
 358 };
 359
 360 struct  mdoc_elem {
 361         size_t            sz;
 362         char            **args;
 363         int               tok;
 364         size_t            argc;
 365         struct mdoc_arg  *argv;
 366 };
 367
 368 union   mdoc_data {
 369         struct mdoc_text  text;
 370         struct mdoc_elem  elem;
 371         struct mdoc_body  body;
 372         struct mdoc_head  head;
 373         struct mdoc_block block;
 374 };
 375
 376 struct  mdoc_node {
 377         struct mdoc_node *parent;
 378         struct mdoc_node *child;
 379         struct mdoc_node *next;
 380         struct mdoc_node *prev;
 381         enum mdoc_type    type;
 382         union mdoc_data   data;
 383 };
 384
 385 struct  mdoc_cb {
 386         int     (*mdoc_err)(void *, int, int, enum mdoc_err);
 387         int     (*mdoc_warn)(void *, int, int, enum mdoc_warn);
 388         void    (*mdoc_msg)(void *, int, const char *);
 389 };
 390
 391 extern  const char *const *mdoc_macronames;
 392 extern  const char *const *mdoc_argnames;
 393
 394 __BEGIN_DECLS
 395
 396 struct  mdoc;
 397
 398 void              mdoc_free(struct mdoc *);
 399 struct  mdoc     *mdoc_alloc(void *data, const struct mdoc_cb *);
 400 int               mdoc_parseln(struct mdoc *, char *buf);
 401 const struct mdoc_node
 402                  *mdoc_result(struct mdoc *);
 403
 404 __END_DECLS
 405
 406 #endif /*!MDOC_H*/