man_macro.c

   1 /*      $Id: man_macro.c,v 1.37 2010/03/25 07:39:25 kristaps Exp $ */
   2 /*
   3  * Copyright (c) 2008, 2009 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 above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17 #ifdef HAVE_CONFIG_H
  18 #include "config.h"
  19 #endif
  20
  21 #include <assert.h>
  22 #include <ctype.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25
  26 #include "libman.h"
  27
  28 enum    rew {
  29         REW_REWIND,
  30         REW_NOHALT,
  31         REW_HALT,
  32 };
  33
  34 static  int              blk_close(MACRO_PROT_ARGS);
  35 static  int              blk_dotted(MACRO_PROT_ARGS);
  36 static  int              blk_exp(MACRO_PROT_ARGS);
  37 static  int              blk_imp(MACRO_PROT_ARGS);
  38 static  int              in_line_eoln(MACRO_PROT_ARGS);
  39
  40 static  int              rew_scope(enum man_type,
  41                                 struct man *, enum mant);
  42 static  enum rew         rew_dohalt(enum mant, enum man_type,
  43                                 const struct man_node *);
  44 static  enum rew         rew_block(enum mant, enum man_type,
  45                                 const struct man_node *);
  46
  47 const   struct man_macro __man_macros[MAN_MAX] = {
  48         { in_line_eoln, MAN_NSCOPED }, /* br */
  49         { in_line_eoln, 0 }, /* TH */
  50         { blk_imp, MAN_SCOPED }, /* SH */
  51         { blk_imp, MAN_SCOPED }, /* SS */
  52         { blk_imp, MAN_SCOPED | MAN_FSCOPED }, /* TP */
  53         { blk_imp, 0 }, /* LP */
  54         { blk_imp, 0 }, /* PP */
  55         { blk_imp, 0 }, /* P */
  56         { blk_imp, 0 }, /* IP */
  57         { blk_imp, 0 }, /* HP */
  58         { in_line_eoln, MAN_SCOPED }, /* SM */
  59         { in_line_eoln, MAN_SCOPED }, /* SB */
  60         { in_line_eoln, 0 }, /* BI */
  61         { in_line_eoln, 0 }, /* IB */
  62         { in_line_eoln, 0 }, /* BR */
  63         { in_line_eoln, 0 }, /* RB */
  64         { in_line_eoln, MAN_SCOPED }, /* R */
  65         { in_line_eoln, MAN_SCOPED }, /* B */
  66         { in_line_eoln, MAN_SCOPED }, /* I */
  67         { in_line_eoln, 0 }, /* IR */
  68         { in_line_eoln, 0 }, /* RI */
  69         { in_line_eoln, MAN_NSCOPED }, /* na */
  70         { in_line_eoln, 0 }, /* i */
  71         { in_line_eoln, MAN_NSCOPED }, /* sp */
  72         { in_line_eoln, 0 }, /* nf */
  73         { in_line_eoln, 0 }, /* fi */
  74         { in_line_eoln, 0 }, /* r */
  75         { blk_close, 0 }, /* RE */
  76         { blk_exp, MAN_EXPLICIT }, /* RS */
  77         { in_line_eoln, 0 }, /* DT */
  78         { in_line_eoln, 0 }, /* UC */
  79         { in_line_eoln, 0 }, /* PD */
  80         { in_line_eoln, MAN_NSCOPED }, /* Sp */
  81         { in_line_eoln, 0 }, /* Vb */
  82         { in_line_eoln, 0 }, /* Ve */
  83         { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* de */
  84         { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* dei */
  85         { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* am */
  86         { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* ami */
  87         { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* ig */
  88         { blk_dotted, 0 }, /* . */
  89 };
  90
  91 const   struct man_macro * const man_macros = __man_macros;
  92
  93
  94 int
  95 man_unscope(struct man *m, const struct man_node *n)
  96 {
  97
  98         assert(n);
  99
 100         /* LINTED */
 101         while (m->last != n) {
 102                 if ( ! man_valid_post(m))
 103                         return(0);
 104                 if ( ! man_action_post(m))
 105                         return(0);
 106                 m->last = m->last->parent;
 107                 assert(m->last);
 108         }
 109
 110         if ( ! man_valid_post(m))
 111                 return(0);
 112         if ( ! man_action_post(m))
 113                 return(0);
 114
 115         m->next = MAN_ROOT == m->last->type ?
 116                 MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
 117
 118         return(1);
 119 }
 120
 121
 122 static enum rew
 123 rew_block(enum mant ntok, enum man_type type, const struct man_node *n)
 124 {
 125
 126         if (MAN_BLOCK == type && ntok == n->parent->tok &&
 127                         MAN_BODY == n->parent->type)
 128                 return(REW_REWIND);
 129         return(ntok == n->tok ? REW_HALT : REW_NOHALT);
 130 }
 131
 132
 133 /*
 134  * There are three scope levels: scoped to the root (all), scoped to the
 135  * section (all less sections), and scoped to subsections (all less
 136  * sections and subsections).
 137  */
 138 static enum rew
 139 rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n)
 140 {
 141         enum rew         c;
 142
 143         if (MAN_ROOT == n->type)
 144                 return(REW_HALT);
 145         assert(n->parent);
 146         if (MAN_ROOT == n->parent->type)
 147                 return(REW_REWIND);
 148         if (MAN_VALID & n->flags)
 149                 return(REW_NOHALT);
 150
 151         /* Rewind to ourselves, first. */
 152         if (type == n->type && tok == n->tok)
 153                 return(REW_REWIND);
 154
 155         switch (tok) {
 156         case (MAN_SH):
 157                 break;
 158         case (MAN_SS):
 159                 /* Rewind to a section, if a block. */
 160                 if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
 161                         return(c);
 162                 break;
 163         case (MAN_RS):
 164                 /* Rewind to a subsection, if a block. */
 165                 if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
 166                         return(c);
 167                 /* Rewind to a section, if a block. */
 168                 if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
 169                         return(c);
 170                 break;
 171         default:
 172                 /* Rewind to an offsetter, if a block. */
 173                 if (REW_NOHALT != (c = rew_block(MAN_RS, type, n)))
 174                         return(c);
 175                 /* Rewind to a subsection, if a block. */
 176                 if (REW_NOHALT != (c = rew_block(MAN_SS, type, n)))
 177                         return(c);
 178                 /* Rewind to a section, if a block. */
 179                 if (REW_NOHALT != (c = rew_block(MAN_SH, type, n)))
 180                         return(c);
 181                 break;
 182         }
 183
 184         return(REW_NOHALT);
 185 }
 186
 187
 188 /*
 189  * Rewinding entails ascending the parse tree until a coherent point,
 190  * for example, the `SH' macro will close out any intervening `SS'
 191  * scopes.  When a scope is closed, it must be validated and actioned.
 192  */
 193 static int
 194 rew_scope(enum man_type type, struct man *m, enum mant tok)
 195 {
 196         struct man_node *n;
 197         enum rew         c;
 198
 199         /* LINTED */
 200         for (n = m->last; n; n = n->parent) {
 201                 /*
 202                  * Whether we should stop immediately (REW_HALT), stop
 203                  * and rewind until this point (REW_REWIND), or keep
 204                  * rewinding (REW_NOHALT).
 205                  */
 206                 c = rew_dohalt(tok, type, n);
 207                 if (REW_HALT == c)
 208                         return(1);
 209                 if (REW_REWIND == c)
 210                         break;
 211         }
 212
 213         /* Rewind until the current point. */
 214
 215         assert(n);
 216         return(man_unscope(m, n));
 217 }
 218
 219
 220 /*
 221  * Closure for dotted macros (de, dei, am, ami, ign).  This must handle
 222  * any of these as the parent node, so it needs special handling.
 223  * Beyond this, it's the same as blk_close().
 224  */
 225 /* ARGSUSED */
 226 int
 227 blk_dotted(MACRO_PROT_ARGS)
 228 {
 229         enum mant        ntok;
 230         struct man_node *nn;
 231
 232         for (nn = m->last->parent; nn; nn = nn->parent)
 233                 if (nn->tok == MAN_de || nn->tok == MAN_dei ||
 234                                 nn->tok == MAN_am ||
 235                                 nn->tok == MAN_ami ||
 236                                 nn->tok == MAN_ig) {
 237                         ntok = nn->tok;
 238                         break;
 239                 }
 240
 241         if (NULL == nn) {
 242                 if ( ! man_pwarn(m, line, ppos, WNOSCOPE))
 243                         return(0);
 244                 return(1);
 245         }
 246
 247         if ( ! rew_scope(MAN_BODY, m, ntok))
 248                 return(0);
 249         if ( ! rew_scope(MAN_BLOCK, m, ntok))
 250                 return(0);
 251
 252         return(1);
 253 }
 254
 255
 256 /*
 257  * Close out a generic explicit macro.
 258  */
 259 /* ARGSUSED */
 260 int
 261 blk_close(MACRO_PROT_ARGS)
 262 {
 263         enum mant                ntok;
 264         const struct man_node   *nn;
 265
 266         switch (tok) {
 267         case (MAN_RE):
 268                 ntok = MAN_RS;
 269                 break;
 270         default:
 271                 abort();
 272                 /* NOTREACHED */
 273         }
 274
 275         for (nn = m->last->parent; nn; nn = nn->parent)
 276                 if (ntok == nn->tok)
 277                         break;
 278
 279         if (NULL == nn)
 280                 if ( ! man_pwarn(m, line, ppos, WNOSCOPE))
 281                         return(0);
 282
 283         if ( ! rew_scope(MAN_BODY, m, ntok))
 284                 return(0);
 285         if ( ! rew_scope(MAN_BLOCK, m, ntok))
 286                 return(0);
 287
 288         return(1);
 289 }
 290
 291
 292 int
 293 blk_exp(MACRO_PROT_ARGS)
 294 {
 295         int              w, la;
 296         char            *p;
 297
 298         /*
 299          * Close out prior scopes.  "Regular" explicit macros cannot be
 300          * nested, but we allow roff macros to be placed just about
 301          * anywhere.
 302          */
 303
 304         if ( ! (MAN_NOCLOSE & man_macros[tok].flags)) {
 305                 if ( ! rew_scope(MAN_BODY, m, tok))
 306                         return(0);
 307                 if ( ! rew_scope(MAN_BLOCK, m, tok))
 308                         return(0);
 309         }
 310
 311         if ( ! man_block_alloc(m, line, ppos, tok))
 312                 return(0);
 313         if ( ! man_head_alloc(m, line, ppos, tok))
 314                 return(0);
 315
 316         for (;;) {
 317                 la = *pos;
 318                 w = man_args(m, line, pos, buf, &p);
 319
 320                 if (-1 == w)
 321                         return(0);
 322                 if (0 == w)
 323                         break;
 324
 325                 if ( ! man_word_alloc(m, line, la, p))
 326                         return(0);
 327         }
 328
 329         assert(m);
 330         assert(tok != MAN_MAX);
 331
 332         if ( ! rew_scope(MAN_HEAD, m, tok))
 333                 return(0);
 334         return(man_body_alloc(m, line, ppos, tok));
 335 }
 336
 337
 338
 339 /*
 340  * Parse an implicit-block macro.  These contain a MAN_HEAD and a
 341  * MAN_BODY contained within a MAN_BLOCK.  Rules for closing out other
 342  * scopes, such as `SH' closing out an `SS', are defined in the rew
 343  * routines.
 344  */
 345 int
 346 blk_imp(MACRO_PROT_ARGS)
 347 {
 348         int              w, la;
 349         char            *p;
 350         struct man_node *n;
 351
 352         /* Close out prior scopes. */
 353
 354         if ( ! rew_scope(MAN_BODY, m, tok))
 355                 return(0);
 356         if ( ! rew_scope(MAN_BLOCK, m, tok))
 357                 return(0);
 358
 359         /* Allocate new block & head scope. */
 360
 361         if ( ! man_block_alloc(m, line, ppos, tok))
 362                 return(0);
 363         if ( ! man_head_alloc(m, line, ppos, tok))
 364                 return(0);
 365
 366         n = m->last;
 367
 368         /* Add line arguments. */
 369
 370         for (;;) {
 371                 la = *pos;
 372                 w = man_args(m, line, pos, buf, &p);
 373
 374                 if (-1 == w)
 375                         return(0);
 376                 if (0 == w)
 377                         break;
 378
 379                 if ( ! man_word_alloc(m, line, la, p))
 380                         return(0);
 381         }
 382
 383         /* Close out head and open body (unless MAN_SCOPE). */
 384
 385         if (MAN_SCOPED & man_macros[tok].flags) {
 386                 /* If we're forcing scope (`TP'), keep it open. */
 387                 if (MAN_FSCOPED & man_macros[tok].flags) {
 388                         m->flags |= MAN_BLINE;
 389                         return(1);
 390                 } else if (n == m->last) {
 391                         m->flags |= MAN_BLINE;
 392                         return(1);
 393                 }
 394         }
 395
 396         if ( ! rew_scope(MAN_HEAD, m, tok))
 397                 return(0);
 398         return(man_body_alloc(m, line, ppos, tok));
 399 }
 400
 401
 402 int
 403 in_line_eoln(MACRO_PROT_ARGS)
 404 {
 405         int              w, la;
 406         char            *p;
 407         struct man_node *n;
 408
 409         if ( ! man_elem_alloc(m, line, ppos, tok))
 410                 return(0);
 411
 412         n = m->last;
 413
 414         for (;;) {
 415                 la = *pos;
 416                 w = man_args(m, line, pos, buf, &p);
 417
 418                 if (-1 == w)
 419                         return(0);
 420                 if (0 == w)
 421                         break;
 422                 if ( ! man_word_alloc(m, line, la, p))
 423                         return(0);
 424         }
 425
 426         /*
 427          * If no arguments are specified and this is MAN_SCOPED (i.e.,
 428          * next-line scoped), then set our mode to indicate that we're
 429          * waiting for terms to load into our context.
 430          */
 431
 432         if (n == m->last && MAN_SCOPED & man_macros[tok].flags) {
 433                 assert( ! (MAN_NSCOPED & man_macros[tok].flags));
 434                 m->flags |= MAN_ELINE;
 435                 return(1);
 436         }
 437
 438         /* Set ignorable context, if applicable. */
 439
 440         if (MAN_NSCOPED & man_macros[tok].flags) {
 441                 assert( ! (MAN_SCOPED & man_macros[tok].flags));
 442                 m->flags |= MAN_ILINE;
 443         }
 444
 445         /*
 446          * Rewind our element scope.  Note that when TH is pruned, we'll
 447          * be back at the root, so make sure that we don't clobber as
 448          * its sibling.
 449          */
 450
 451         for ( ; m->last; m->last = m->last->parent) {
 452                 if (m->last == n)
 453                         break;
 454                 if (m->last->type == MAN_ROOT)
 455                         break;
 456                 if ( ! man_valid_post(m))
 457                         return(0);
 458                 if ( ! man_action_post(m))
 459                         return(0);
 460         }
 461
 462         assert(m->last);
 463
 464         /*
 465          * Same here regarding whether we're back at the root.
 466          */
 467
 468         if (m->last->type != MAN_ROOT && ! man_valid_post(m))
 469                 return(0);
 470         if (m->last->type != MAN_ROOT && ! man_action_post(m))
 471                 return(0);
 472
 473         m->next = MAN_ROOT == m->last->type ?
 474                 MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
 475
 476         return(1);
 477 }
 478
 479
 480 int
 481 man_macroend(struct man *m)
 482 {
 483         struct man_node *n;
 484
 485         n = MAN_VALID & m->last->flags ?
 486                 m->last->parent : m->last;
 487
 488         for ( ; n; n = n->parent) {
 489                 if (MAN_BLOCK != n->type)
 490                         continue;
 491                 if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
 492                         continue;
 493                 if ( ! man_nwarn(m, n, WEXITSCOPE))
 494                         return(0);
 495         }
 496
 497         return(man_unscope(m, m->first));
 498 }
 499