mdoc.h

   1 /* $Id: mdoc.h,v 1.2 2008/12/15 03:13:01 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,
 196         ERR_SYNTAX_WS,
 197         ERR_MACRO_NOTSUP,
 198         ERR_MACRO_NOTCALL,
 199         ERR_SCOPE_BREAK,
 200         ERR_ARGS_GE1
 201 };
 202
 203 enum    mdoc_warn {
 204         WARN_SYNTAX_WS_EOLN,
 205         WARN_SYNTAX_MACLIKE,
 206         WARN_ARGS_GE1
 207 };
 208
 209 struct  mdoc_arg {
 210         int               arg;
 211         size_t            sz;
 212         char            **value;
 213 };
 214
 215 enum    mdoc_type {
 216         MDOC_TEXT,
 217         MDOC_ELEM,
 218         MDOC_HEAD,
 219         MDOC_BODY,
 220         MDOC_BLOCK
 221 };
 222
 223 enum    mdoc_msec {
 224         MSEC_1,
 225         MSEC_2,
 226         MSEC_3,
 227         MSEC_3f,
 228         MSEC_3p,
 229         MSEC_4,
 230         MSEC_5,
 231         MSEC_6,
 232         MSEC_7,
 233         MSEC_8,
 234         MSEC_9,
 235         MSEC_X11,
 236         MSEC_X11R6,
 237         MSEC_local,
 238         MSEC_n,
 239         MSEC_unass,
 240         MSEC_draft,
 241         MSEC_paper,
 242         MSEC_NONE
 243 };
 244
 245 enum    mdoc_sec {
 246         SEC_PROLOGUE,
 247         SEC_NAME,
 248         SEC_SYNOPSIS,
 249         SEC_DESCRIPTION,
 250         SEC_RETURN_VALUES,
 251         SEC_ENVIRONMENT,
 252         SEC_FILES,
 253         SEC_EXAMPLES,
 254         SEC_DIAGNOSTICS,
 255         SEC_ERRORS,
 256         SEC_SEE_ALSO,
 257         SEC_STANDARDS,
 258         SEC_HISTORY,
 259         SEC_AUTHORS,
 260         SEC_CAVEATS,
 261         SEC_BUGS,
 262         SEC_CUSTOM
 263 };
 264
 265 enum    mdoc_vol {
 266         VOL_AMD,
 267         VOL_IND,
 268         VOL_KM,
 269         VOL_LOCAL,
 270         VOL_PRM,
 271         VOL_PS1,
 272         VOL_SMM,
 273         VOL_URM,
 274         VOL_USD,
 275         VOL_DEFAULT
 276 };
 277
 278 enum    mdoc_arch {
 279         ARCH_alpha,
 280         ARCH_amd64,
 281         ARCH_amiga,
 282         ARCH_arc,
 283         ARCH_armish,
 284         ARCH_aviion,
 285         ARCH_hp300,
 286         ARCH_hppa,
 287         ARCH_hppa64,
 288         ARCH_i386,
 289         ARCH_landisk,
 290         ARCH_luna88k,
 291         ARCH_mac68k,
 292         ARCH_macppc,
 293         ARCH_mvme68k,
 294         ARCH_mvme88k,
 295         ARCH_mvmeppc,
 296         ARCH_pmax,
 297         ARCH_sgi,
 298         ARCH_socppc,
 299         ARCH_sparc,
 300         ARCH_sparc64,
 301         ARCH_sun3,
 302         ARCH_vax,
 303         ARCH_zaurus,
 304         ARCH_DEFAULT
 305 };
 306
 307 struct  mdoc_meta {
 308         enum mdoc_msec    msec;
 309         enum mdoc_vol     vol;
 310         enum mdoc_arch    arch;
 311         struct tm         tm;
 312 };
 313
 314 struct  mdoc_text {
 315         char             *string;
 316 };
 317
 318 struct  mdoc_block {
 319         int               tok;
 320         size_t            argc;
 321         struct mdoc_arg  *argv;
 322 };
 323
 324 struct  mdoc_head {
 325         size_t            sz;
 326         char            **args;
 327         int               tok;
 328 };
 329
 330 struct  mdoc_body {
 331         int               tok;
 332 };
 333
 334 struct  mdoc_elem {
 335         size_t            sz;
 336         char            **args;
 337         int               tok;
 338         size_t            argc;
 339         struct mdoc_arg  *argv;
 340 };
 341
 342 union   mdoc_data {
 343         struct mdoc_text  text;
 344         struct mdoc_elem  elem;
 345         struct mdoc_body  body;
 346         struct mdoc_head  head;
 347         struct mdoc_block block;
 348 };
 349
 350 struct  mdoc_node {
 351         struct mdoc_node *parent;
 352         struct mdoc_node *child;
 353         struct mdoc_node *next;
 354         enum mdoc_type    type;
 355         union mdoc_data   data;
 356 };
 357
 358 struct  mdoc_cb {
 359         int     (*mdoc_err)(void *, int, int, enum mdoc_err);
 360         int     (*mdoc_warn)(void *, int, int, enum mdoc_warn);
 361         void    (*mdoc_msg)(void *, int, const char *);
 362 };
 363
 364 extern  const char *const *mdoc_macronames;
 365 extern  const char *const *mdoc_argnames;
 366
 367 __BEGIN_DECLS
 368
 369 struct  mdoc;
 370
 371 void              mdoc_free(struct mdoc *);
 372 struct  mdoc     *mdoc_alloc(void *data, const struct mdoc_cb *);
 373 int               mdoc_parseln(struct mdoc *, char *buf);
 374 const struct mdoc_node
 375                  *mdoc_result(struct mdoc *);
 376
 377 __END_DECLS
 378
 379 #endif /*!MDOC_H*/