/
mdoc_macro.c
1798 lines (1516 loc) · 42.1 KB
/
mdoc_macro.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* $Id: mdoc_macro.c,v 1.109 2011/04/30 10:18:24 kristaps Exp $ */
/*
* Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
* Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <assert.h>
#include <ctype.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <time.h>
#include "mdoc.h"
#include "mandoc.h"
#include "libmdoc.h"
#include "libmandoc.h"
enum rew { /* see rew_dohalt() */
REWIND_NONE,
REWIND_THIS,
REWIND_MORE,
REWIND_FORCE,
REWIND_LATER,
REWIND_ERROR
};
static int blk_full(MACRO_PROT_ARGS);
static int blk_exp_close(MACRO_PROT_ARGS);
static int blk_part_exp(MACRO_PROT_ARGS);
static int blk_part_imp(MACRO_PROT_ARGS);
static int ctx_synopsis(MACRO_PROT_ARGS);
static int in_line_eoln(MACRO_PROT_ARGS);
static int in_line_argn(MACRO_PROT_ARGS);
static int in_line(MACRO_PROT_ARGS);
static int obsolete(MACRO_PROT_ARGS);
static int phrase_ta(MACRO_PROT_ARGS);
static int dword(struct mdoc *, int, int,
const char *, enum mdelim);
static int append_delims(struct mdoc *,
int, int *, char *);
static enum mdoct lookup(enum mdoct, const char *);
static enum mdoct lookup_raw(const char *);
static int make_pending(struct mdoc_node *, enum mdoct,
struct mdoc *, int, int);
static int phrase(struct mdoc *, int, int, char *);
static enum mdoct rew_alt(enum mdoct);
static enum rew rew_dohalt(enum mdoct, enum mdoc_type,
const struct mdoc_node *);
static int rew_elem(struct mdoc *, enum mdoct);
static int rew_last(struct mdoc *,
const struct mdoc_node *);
static int rew_sub(enum mdoc_type, struct mdoc *,
enum mdoct, int, int);
const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ap */
{ in_line_eoln, MDOC_PROLOGUE }, /* Dd */
{ in_line_eoln, MDOC_PROLOGUE }, /* Dt */
{ in_line_eoln, MDOC_PROLOGUE }, /* Os */
{ blk_full, 0 }, /* Sh */
{ blk_full, 0 }, /* Ss */
{ in_line_eoln, 0 }, /* Pp */
{ blk_part_imp, MDOC_PARSED }, /* D1 */
{ blk_part_imp, MDOC_PARSED }, /* Dl */
{ blk_full, MDOC_EXPLICIT }, /* Bd */
{ blk_exp_close, MDOC_EXPLICIT }, /* Ed */
{ blk_full, MDOC_EXPLICIT }, /* Bl */
{ blk_exp_close, MDOC_EXPLICIT }, /* El */
{ blk_full, MDOC_PARSED }, /* It */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* An */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Cd */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dv */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Er */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ev */
{ in_line_eoln, 0 }, /* Ex */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fa */
{ in_line_eoln, 0 }, /* Fd */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fn */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ft */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* In */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Li */
{ blk_full, 0 }, /* Nd */
{ ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */
{ blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Op */
{ obsolete, 0 }, /* Ot */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */
{ in_line_eoln, 0 }, /* Rv */
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* St */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Va */
{ ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Vt */
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Xr */
{ in_line_eoln, 0 }, /* %A */
{ in_line_eoln, 0 }, /* %B */
{ in_line_eoln, 0 }, /* %D */
{ in_line_eoln, 0 }, /* %I */
{ in_line_eoln, 0 }, /* %J */
{ in_line_eoln, 0 }, /* %N */
{ in_line_eoln, 0 }, /* %O */
{ in_line_eoln, 0 }, /* %P */
{ in_line_eoln, 0 }, /* %R */
{ in_line_eoln, 0 }, /* %T */
{ in_line_eoln, 0 }, /* %V */
{ blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ac */
{ blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Ao */
{ blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Aq */
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* At */
{ blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Bc */
{ blk_full, MDOC_EXPLICIT }, /* Bf */
{ blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bo */
{ blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Bq */
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Bsx */
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Bx */
{ in_line_eoln, 0 }, /* Db */
{ blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Dc */
{ blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Do */
{ blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Dq */
{ blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ec */
{ blk_exp_close, MDOC_EXPLICIT }, /* Ef */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Em */
{ blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Fx */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ms */
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_IGNDELIM }, /* No */
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_IGNDELIM }, /* Ns */
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Nx */
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ox */
{ blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Pc */
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_IGNDELIM }, /* Pf */
{ blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Po */
{ blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Pq */
{ blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Qc */
{ blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Ql */
{ blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Qo */
{ blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Qq */
{ blk_exp_close, MDOC_EXPLICIT }, /* Re */
{ blk_full, MDOC_EXPLICIT }, /* Rs */
{ blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Sc */
{ blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* So */
{ blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Sq */
{ in_line_eoln, 0 }, /* Sm */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Sx */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Sy */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Tn */
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ux */
{ blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Xc */
{ blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Xo */
{ blk_full, MDOC_EXPLICIT | MDOC_CALLABLE }, /* Fo */
{ blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Fc */
{ blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Oo */
{ blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Oc */
{ blk_full, MDOC_EXPLICIT }, /* Bk */
{ blk_exp_close, MDOC_EXPLICIT }, /* Ek */
{ in_line_eoln, 0 }, /* Bt */
{ in_line_eoln, 0 }, /* Hf */
{ obsolete, 0 }, /* Fr */
{ in_line_eoln, 0 }, /* Ud */
{ in_line, 0 }, /* Lb */
{ in_line_eoln, 0 }, /* Lp */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Lk */
{ in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Mt */
{ blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Brq */
{ blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bro */
{ blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Brc */
{ in_line_eoln, 0 }, /* %C */
{ obsolete, 0 }, /* Es */
{ obsolete, 0 }, /* En */
{ in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Dx */
{ in_line_eoln, 0 }, /* %Q */
{ in_line_eoln, 0 }, /* br */
{ in_line_eoln, 0 }, /* sp */
{ in_line_eoln, 0 }, /* %U */
{ phrase_ta, MDOC_CALLABLE | MDOC_PARSED }, /* Ta */
};
const struct mdoc_macro * const mdoc_macros = __mdoc_macros;
/*
* This is called at the end of parsing. It must traverse up the tree,
* closing out open [implicit] scopes. Obviously, open explicit scopes
* are errors.
*/
int
mdoc_macroend(struct mdoc *m)
{
struct mdoc_node *n;
/* Scan for open explicit scopes. */
n = MDOC_VALID & m->last->flags ? m->last->parent : m->last;
for ( ; n; n = n->parent)
if (MDOC_BLOCK == n->type &&
MDOC_EXPLICIT & mdoc_macros[n->tok].flags)
mdoc_nmsg(m, n, MANDOCERR_SCOPEEXIT);
/* Rewind to the first. */
return(rew_last(m, m->first));
}
/*
* Look up a macro from within a subsequent context.
*/
static enum mdoct
lookup(enum mdoct from, const char *p)
{
/* FIXME: make -diag lists be un-PARSED. */
if ( ! (MDOC_PARSED & mdoc_macros[from].flags))
return(MDOC_MAX);
return(lookup_raw(p));
}
/*
* Lookup a macro following the initial line macro.
*/
static enum mdoct
lookup_raw(const char *p)
{
enum mdoct res;
if (MDOC_MAX == (res = mdoc_hash_find(p)))
return(MDOC_MAX);
if (MDOC_CALLABLE & mdoc_macros[res].flags)
return(res);
return(MDOC_MAX);
}
static int
rew_last(struct mdoc *mdoc, const struct mdoc_node *to)
{
struct mdoc_node *n, *np;
assert(to);
mdoc->next = MDOC_NEXT_SIBLING;
/* LINTED */
while (mdoc->last != to) {
/*
* Save the parent here, because we may delete the
* m->last node in the post-validation phase and reset
* it to m->last->parent, causing a step in the closing
* out to be lost.
*/
np = mdoc->last->parent;
if ( ! mdoc_valid_post(mdoc))
return(0);
n = mdoc->last;
mdoc->last = np;
assert(mdoc->last);
mdoc->last->last = n;
}
return(mdoc_valid_post(mdoc));
}
/*
* For a block closing macro, return the corresponding opening one.
* Otherwise, return the macro itself.
*/
static enum mdoct
rew_alt(enum mdoct tok)
{
switch (tok) {
case (MDOC_Ac):
return(MDOC_Ao);
case (MDOC_Bc):
return(MDOC_Bo);
case (MDOC_Brc):
return(MDOC_Bro);
case (MDOC_Dc):
return(MDOC_Do);
case (MDOC_Ec):
return(MDOC_Eo);
case (MDOC_Ed):
return(MDOC_Bd);
case (MDOC_Ef):
return(MDOC_Bf);
case (MDOC_Ek):
return(MDOC_Bk);
case (MDOC_El):
return(MDOC_Bl);
case (MDOC_Fc):
return(MDOC_Fo);
case (MDOC_Oc):
return(MDOC_Oo);
case (MDOC_Pc):
return(MDOC_Po);
case (MDOC_Qc):
return(MDOC_Qo);
case (MDOC_Re):
return(MDOC_Rs);
case (MDOC_Sc):
return(MDOC_So);
case (MDOC_Xc):
return(MDOC_Xo);
default:
return(tok);
}
/* NOTREACHED */
}
/*
* Rewinding to tok, how do we have to handle *p?
* REWIND_NONE: *p would delimit tok, but no tok scope is open
* inside *p, so there is no need to rewind anything at all.
* REWIND_THIS: *p matches tok, so rewind *p and nothing else.
* REWIND_MORE: *p is implicit, rewind it and keep searching for tok.
* REWIND_FORCE: *p is explicit, but tok is full, force rewinding *p.
* REWIND_LATER: *p is explicit and still open, postpone rewinding.
* REWIND_ERROR: No tok block is open at all.
*/
static enum rew
rew_dohalt(enum mdoct tok, enum mdoc_type type,
const struct mdoc_node *p)
{
/*
* No matching token, no delimiting block, no broken block.
* This can happen when full implicit macros are called for
* the first time but try to rewind their previous
* instance anyway.
*/
if (MDOC_ROOT == p->type)
return(MDOC_BLOCK == type &&
MDOC_EXPLICIT & mdoc_macros[tok].flags ?
REWIND_ERROR : REWIND_NONE);
/*
* When starting to rewind, skip plain text
* and nodes that have already been rewound.
*/
if (MDOC_TEXT == p->type || MDOC_VALID & p->flags)
return(REWIND_MORE);
/*
* The easiest case: Found a matching token.
* This applies to both blocks and elements.
*/
tok = rew_alt(tok);
if (tok == p->tok)
return(p->end ? REWIND_NONE :
type == p->type ? REWIND_THIS : REWIND_MORE);
/*
* While elements do require rewinding for themselves,
* they never affect rewinding of other nodes.
*/
if (MDOC_ELEM == p->type)
return(REWIND_MORE);
/*
* Blocks delimited by our target token get REWIND_MORE.
* Blocks delimiting our target token get REWIND_NONE.
*/
switch (tok) {
case (MDOC_Bl):
if (MDOC_It == p->tok)
return(REWIND_MORE);
break;
case (MDOC_It):
if (MDOC_BODY == p->type && MDOC_Bl == p->tok)
return(REWIND_NONE);
break;
/*
* XXX Badly nested block handling still fails badly
* when one block is breaking two blocks of the same type.
* This is an incomplete and extremely ugly workaround,
* required to let the OpenBSD tree build.
*/
case (MDOC_Oo):
if (MDOC_Op == p->tok)
return(REWIND_MORE);
break;
case (MDOC_Nm):
return(REWIND_NONE);
case (MDOC_Nd):
/* FALLTHROUGH */
case (MDOC_Ss):
if (MDOC_BODY == p->type && MDOC_Sh == p->tok)
return(REWIND_NONE);
/* FALLTHROUGH */
case (MDOC_Sh):
if (MDOC_Nd == p->tok || MDOC_Ss == p->tok ||
MDOC_Sh == p->tok)
return(REWIND_MORE);
break;
default:
break;
}
/*
* Default block rewinding rules.
* In particular, always skip block end markers,
* and let all blocks rewind Nm children.
*/
if (ENDBODY_NOT != p->end || MDOC_Nm == p->tok ||
(MDOC_BLOCK == p->type &&
! (MDOC_EXPLICIT & mdoc_macros[tok].flags)))
return(REWIND_MORE);
/*
* By default, closing out full blocks
* forces closing of broken explicit blocks,
* while closing out partial blocks
* allows delayed rewinding by default.
*/
return (&blk_full == mdoc_macros[tok].fp ?
REWIND_FORCE : REWIND_LATER);
}
static int
rew_elem(struct mdoc *mdoc, enum mdoct tok)
{
struct mdoc_node *n;
n = mdoc->last;
if (MDOC_ELEM != n->type)
n = n->parent;
assert(MDOC_ELEM == n->type);
assert(tok == n->tok);
return(rew_last(mdoc, n));
}
/*
* We are trying to close a block identified by tok,
* but the child block *broken is still open.
* Thus, postpone closing the tok block
* until the rew_sub call closing *broken.
*/
static int
make_pending(struct mdoc_node *broken, enum mdoct tok,
struct mdoc *m, int line, int ppos)
{
struct mdoc_node *breaker;
/*
* Iterate backwards, searching for the block matching tok,
* that is, the block breaking the *broken block.
*/
for (breaker = broken->parent; breaker; breaker = breaker->parent) {
/*
* If the *broken block had already been broken before
* and we encounter its breaker, make the tok block
* pending on the inner breaker.
* Graphically, "[A breaker=[B broken=[C->B B] tok=A] C]"
* becomes "[A broken=[B [C->B B] tok=A] C]"
* and finally "[A [B->A [C->B B] A] C]".
*/
if (breaker == broken->pending) {
broken = breaker;
continue;
}
if (REWIND_THIS != rew_dohalt(tok, MDOC_BLOCK, breaker))
continue;
if (MDOC_BODY == broken->type)
broken = broken->parent;
/*
* Found the breaker.
* If another, outer breaker is already pending on
* the *broken block, we must not clobber the link
* to the outer breaker, but make it pending on the
* new, now inner breaker.
* Graphically, "[A breaker=[B broken=[C->A A] tok=B] C]"
* becomes "[A breaker=[B->A broken=[C A] tok=B] C]"
* and finally "[A [B->A [C->B A] B] C]".
*/
if (broken->pending) {
struct mdoc_node *taker;
/*
* If the breaker had also been broken before,
* it cannot take on the outer breaker itself,
* but must hand it on to its own breakers.
* Graphically, this is the following situation:
* "[A [B breaker=[C->B B] broken=[D->A A] tok=C] D]"
* "[A taker=[B->A breaker=[C->B B] [D->C A] C] D]"
*/
taker = breaker;
while (taker->pending)
taker = taker->pending;
taker->pending = broken->pending;
}
broken->pending = breaker;
mandoc_vmsg(MANDOCERR_SCOPENEST, m->parse, line, ppos,
"%s breaks %s", mdoc_macronames[tok],
mdoc_macronames[broken->tok]);
return(1);
}
/*
* Found no matching block for tok.
* Are you trying to close a block that is not open?
*/
return(0);
}
static int
rew_sub(enum mdoc_type t, struct mdoc *m,
enum mdoct tok, int line, int ppos)
{
struct mdoc_node *n;
n = m->last;
while (n) {
switch (rew_dohalt(tok, t, n)) {
case (REWIND_NONE):
return(1);
case (REWIND_THIS):
break;
case (REWIND_FORCE):
mandoc_vmsg(MANDOCERR_SCOPEBROKEN, m->parse,
line, ppos, "%s breaks %s",
mdoc_macronames[tok],
mdoc_macronames[n->tok]);
/* FALLTHROUGH */
case (REWIND_MORE):
n = n->parent;
continue;
case (REWIND_LATER):
if (make_pending(n, tok, m, line, ppos) ||
MDOC_BLOCK != t)
return(1);
/* FALLTHROUGH */
case (REWIND_ERROR):
mdoc_pmsg(m, line, ppos, MANDOCERR_NOSCOPE);
return(1);
}
break;
}
assert(n);
if ( ! rew_last(m, n))
return(0);
/*
* The current block extends an enclosing block.
* Now that the current block ends, close the enclosing block, too.
*/
while (NULL != (n = n->pending)) {
if ( ! rew_last(m, n))
return(0);
if (MDOC_HEAD == n->type &&
! mdoc_body_alloc(m, n->line, n->pos, n->tok))
return(0);
}
return(1);
}
/*
* Allocate a word and check whether it's punctuation or not.
* Punctuation consists of those tokens found in mdoc_isdelim().
*/
static int
dword(struct mdoc *m, int line,
int col, const char *p, enum mdelim d)
{
if (DELIM_MAX == d)
d = mdoc_isdelim(p);
if ( ! mdoc_word_alloc(m, line, col, p))
return(0);
if (DELIM_OPEN == d)
m->last->flags |= MDOC_DELIMO;
/*
* Closing delimiters only suppress the preceding space
* when they follow something, not when they start a new
* block or element, and not when they follow `No'.
*
* XXX Explicitly special-casing MDOC_No here feels
* like a layering violation. Find a better way
* and solve this in the code related to `No'!
*/
else if (DELIM_CLOSE == d && m->last->prev &&
m->last->prev->tok != MDOC_No)
m->last->flags |= MDOC_DELIMC;
return(1);
}
static int
append_delims(struct mdoc *m, int line, int *pos, char *buf)
{
int la;
enum margserr ac;
char *p;
if ('\0' == buf[*pos])
return(1);
for (;;) {
la = *pos;
ac = mdoc_zargs(m, line, pos, buf, &p);
if (ARGS_ERROR == ac)
return(0);
else if (ARGS_EOLN == ac)
break;
dword(m, line, la, p, DELIM_MAX);
/*
* If we encounter end-of-sentence symbols, then trigger
* the double-space.
*
* XXX: it's easy to allow this to propagate outward to
* the last symbol, such that `. )' will cause the
* correct double-spacing. However, (1) groff isn't
* smart enough to do this and (2) it would require
* knowing which symbols break this behaviour, for
* example, `. ;' shouldn't propagate the double-space.
*/
if (mandoc_eos(p, strlen(p), 0))
m->last->flags |= MDOC_EOS;
}
return(1);
}
/*
* Close out block partial/full explicit.
*/
static int
blk_exp_close(MACRO_PROT_ARGS)
{
struct mdoc_node *body; /* Our own body. */
struct mdoc_node *later; /* A sub-block starting later. */
struct mdoc_node *n; /* For searching backwards. */
int j, lastarg, maxargs, flushed, nl;
enum margserr ac;
enum mdoct atok, ntok;
char *p;
nl = MDOC_NEWLINE & m->flags;
switch (tok) {
case (MDOC_Ec):
maxargs = 1;
break;
default:
maxargs = 0;
break;
}
/*
* Search backwards for beginnings of blocks,
* both of our own and of pending sub-blocks.
*/
atok = rew_alt(tok);
body = later = NULL;
for (n = m->last; n; n = n->parent) {
if (MDOC_VALID & n->flags)
continue;
/* Remember the start of our own body. */
if (MDOC_BODY == n->type && atok == n->tok) {
if (ENDBODY_NOT == n->end)
body = n;
continue;
}
if (MDOC_BLOCK != n->type || MDOC_Nm == n->tok)
continue;
if (atok == n->tok) {
assert(body);
/*
* Found the start of our own block.
* When there is no pending sub block,
* just proceed to closing out.
*/
if (NULL == later)
break;
/*
* When there is a pending sub block,
* postpone closing out the current block
* until the rew_sub() closing out the sub-block.
*/
make_pending(later, tok, m, line, ppos);
/*
* Mark the place where the formatting - but not
* the scope - of the current block ends.
*/
if ( ! mdoc_endbody_alloc(m, line, ppos,
atok, body, ENDBODY_SPACE))
return(0);
break;
}
/*
* When finding an open sub block, remember the last
* open explicit block, or, in case there are only
* implicit ones, the first open implicit block.
*/
if (later &&
MDOC_EXPLICIT & mdoc_macros[later->tok].flags)
continue;
if (MDOC_CALLABLE & mdoc_macros[n->tok].flags)
later = n;
}
if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) {
/* FIXME: do this in validate */
if (buf[*pos])
mdoc_pmsg(m, line, ppos, MANDOCERR_ARGSLOST);
if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos))
return(0);
return(rew_sub(MDOC_BLOCK, m, tok, line, ppos));
}
if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos))
return(0);
if (NULL == later && maxargs > 0)
if ( ! mdoc_tail_alloc(m, line, ppos, rew_alt(tok)))
return(0);
for (flushed = j = 0; ; j++) {
lastarg = *pos;
if (j == maxargs && ! flushed) {
if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos))
return(0);
flushed = 1;
}
ac = mdoc_args(m, line, pos, buf, tok, &p);
if (ARGS_ERROR == ac)
return(0);
if (ARGS_PUNCT == ac)
break;
if (ARGS_EOLN == ac)
break;
ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
if (MDOC_MAX == ntok) {
if ( ! dword(m, line, lastarg, p, DELIM_MAX))
return(0);
continue;
}
if ( ! flushed) {
if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos))
return(0);
flushed = 1;
}
if ( ! mdoc_macro(m, ntok, line, lastarg, pos, buf))
return(0);
break;
}
if ( ! flushed && ! rew_sub(MDOC_BLOCK, m, tok, line, ppos))
return(0);
if ( ! nl)
return(1);
return(append_delims(m, line, pos, buf));
}
static int
in_line(MACRO_PROT_ARGS)
{
int la, scope, cnt, nc, nl;
enum margverr av;
enum mdoct ntok;
enum margserr ac;
enum mdelim d;
struct mdoc_arg *arg;
char *p;
nl = MDOC_NEWLINE & m->flags;
/*
* Whether we allow ignored elements (those without content,
* usually because of reserved words) to squeak by.
*/
switch (tok) {
case (MDOC_An):
/* FALLTHROUGH */
case (MDOC_Ar):
/* FALLTHROUGH */
case (MDOC_Fl):
/* FALLTHROUGH */
case (MDOC_Mt):
/* FALLTHROUGH */
case (MDOC_Nm):
/* FALLTHROUGH */
case (MDOC_Pa):
nc = 1;
break;
default:
nc = 0;
break;
}
for (arg = NULL;; ) {
la = *pos;
av = mdoc_argv(m, line, tok, &arg, pos, buf);
if (ARGV_WORD == av) {
*pos = la;
break;
}
if (ARGV_EOLN == av)
break;
if (ARGV_ARG == av)
continue;
mdoc_argv_free(arg);
return(0);
}
for (cnt = scope = 0;; ) {
la = *pos;
ac = mdoc_args(m, line, pos, buf, tok, &p);
if (ARGS_ERROR == ac)
return(0);
if (ARGS_EOLN == ac)
break;
if (ARGS_PUNCT == ac)
break;
ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p);
/*
* In this case, we've located a submacro and must
* execute it. Close out scope, if open. If no
* elements have been generated, either create one (nc)
* or raise a warning.
*/
if (MDOC_MAX != ntok) {
if (scope && ! rew_elem(m, tok))
return(0);
if (nc && 0 == cnt) {
if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))
return(0);
if ( ! rew_last(m, m->last))
return(0);
} else if ( ! nc && 0 == cnt) {
mdoc_argv_free(arg);
mdoc_pmsg(m, line, ppos, MANDOCERR_MACROEMPTY);
}
if ( ! mdoc_macro(m, ntok, line, la, pos, buf))
return(0);
if ( ! nl)
return(1);
return(append_delims(m, line, pos, buf));
}
/*
* Non-quote-enclosed punctuation. Set up our scope, if
* a word; rewind the scope, if a delimiter; then append
* the word.
*/
d = ARGS_QWORD == ac ? DELIM_NONE : mdoc_isdelim(p);
if (DELIM_NONE != d) {
/*
* If we encounter closing punctuation, no word
* has been omitted, no scope is open, and we're
* allowed to have an empty element, then start
* a new scope. `Ar', `Fl', and `Li', only do
* this once per invocation. There may be more
* of these (all of them?).
*/
if (0 == cnt && (nc || MDOC_Li == tok) &&
DELIM_CLOSE == d && ! scope) {
if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))
return(0);
if (MDOC_Ar == tok || MDOC_Li == tok ||
MDOC_Fl == tok)
cnt++;
scope = 1;
}
/*
* Close out our scope, if one is open, before
* any punctuation.
*/
if (scope && ! rew_elem(m, tok))
return(0);
scope = 0;
} else if ( ! scope) {
if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))
return(0);
scope = 1;
}
if (DELIM_NONE == d)
cnt++;
if ( ! dword(m, line, la, p, d))
return(0);
/*
* `Fl' macros have their scope re-opened with each new
* word so that the `-' can be added to each one without
* having to parse out spaces.
*/
if (scope && MDOC_Fl == tok) {
if ( ! rew_elem(m, tok))
return(0);
scope = 0;
}
}
if (scope && ! rew_elem(m, tok))
return(0);
/*
* If no elements have been collected and we're allowed to have
* empties (nc), open a scope and close it out. Otherwise,
* raise a warning.
*/
if (nc && 0 == cnt) {
if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg))
return(0);
if ( ! rew_last(m, m->last))
return(0);
} else if ( ! nc && 0 == cnt) {
mdoc_argv_free(arg);
mdoc_pmsg(m, line, ppos, MANDOCERR_MACROEMPTY);
}
if ( ! nl)
return(1);
return(append_delims(m, line, pos, buf));
}
static int
blk_full(MACRO_PROT_ARGS)
{
int la, nl;
struct mdoc_arg *arg;
struct mdoc_node *head; /* save of head macro */
struct mdoc_node *body; /* save of body macro */
struct mdoc_node *n;
enum mdoc_type mtt;
enum mdoct ntok;
enum margserr ac, lac;
enum margverr av;
char *p;
nl = MDOC_NEWLINE & m->flags;
/* Close out prior implicit scope. */