File: manpagexml.py

package info (click to toggle)
audiotools 3.1.1-1.1
  • links: PTS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 18,308 kB
  • sloc: ansic: 417,746; python: 59,093; xml: 1,639; makefile: 303; sh: 99
file content (865 lines) | stat: -rwxr-xr-x 29,307 bytes parent folder | download
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
#!/usr/bin/python

# Audio Tools, a module and set of tools for manipulating audio data
# Copyright (C) 2007-2015  Brian Langenberger

# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

import os
import re
import time
from sys import version_info

PY3 = version_info[0] >= 3


WHITESPACE = re.compile(r'\s+')


def subtag(node, name):
    return [child for child in node.childNodes
            if (hasattr(child, "nodeName") and
                (child.nodeName == name))][0]


def subtags(node, name):
    return [child for child in node.childNodes
            if (hasattr(child, "nodeName") and
                (child.nodeName == name))]


def text(node):
    try:
        return WHITESPACE.sub(u" ", node.childNodes[0].wholeText.strip())
    except IndexError:
        return u""


def man_escape(s):
    return s.replace('-', '\\-')


if PY3:
    def write_u(stream, unicode_string):
        assert(isinstance(unicode_string, str))
        stream.write(unicode_string)
else:
    def write_u(stream, unicode_string):
        assert(isinstance(unicode_string, unicode))
        stream.write(unicode_string.encode("utf-8"))


class Manpage:
    FIELDS = [
        ("%(track_number)2.2d", "the track's number on the CD"),
        ("%(track_total)d", "the total number of tracks on the CD"),
        ("%(album_number)d", "the CD's album number"),
        ("%(album_total)d", "the total number of CDs in the set"),
        ("%(album_track_number)s", "combination of album and track number"),
        ("%(track_name)s", "the track's name"),
        ("%(album_name)s", "the album's name"),
        ("%(artist_name)s", "the track's artist name"),
        ("%(performer_name)s", "the track's performer name"),
        ("%(composer_name)s", "the track's composer name"),
        ("%(conductor_name)s", "the track's conductor name"),
        ("%(media)s", "the track's source media"),
        ("%(ISRC)s", "the track's ISRC"),
        ("%(catalog)s", "the track's catalog number"),
        ("%(copyright)s", "the track's copyright information"),
        ("%(publisher)s", "the track's publisher"),
        ("%(year)s", "the track's publication year"),
        ("%(date)s", "the track's original recording date"),
        ("%(suffix)s", "the track's suffix"),
        ("%(basename)s", "the track's original name, without suffix")]

    def __init__(self,
                 utility=u"",
                 section=1,
                 name=u"",
                 title=u"",
                 synopsis=None,
                 description=u"",
                 author=u"",
                 options=None,
                 elements=None,
                 examples=None,
                 see_also=None):
        self.utility = utility
        self.section = int(section)
        self.name = name
        self.title = title
        self.synopsis = synopsis
        self.description = description
        self.author = author

        if options is not None:
            self.options = options
        else:
            self.options = []

        if examples is not None:
            self.examples = examples
        else:
            self.examples = []

        if elements is not None:
            self.elements = elements
        else:
            self.elements = []

        if see_also is not None:
            self.see_also = see_also
        else:
            self.see_also = []

    def __repr__(self):
        return "Manpage(%s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s)" % \
            (repr(self.utility),
             repr(self.section),
             repr(self.name),
             repr(self.title),
             repr(self.synopsis),
             repr(self.description),
             repr(self.author),
             repr(self.options),
             repr(self.elements),
             repr(self.examples),
             repr(self.see_also))

    def flatten_options(self):
        for option_category in self.options:
            for option in option_category.options:
                yield option

    @classmethod
    def parse_file(cls, filename):
        return cls.parse(xml.dom.minidom.parse(filename))

    @classmethod
    def parse(cls, xml_dom):
        manpage = xml_dom.getElementsByTagName(u"manpage")[0]

        try:
            synopsis = text(subtag(manpage, u"synopsis"))
        except IndexError:
            synopsis = None

        options = [Options.parse(options)
                   for options in subtags(manpage, u"options")]

        elements = [Element.parse(element)
                    for element in subtags(manpage, u"element")]

        try:
            examples = [Example.parse(example)
                        for example in subtags(subtag(manpage,
                                                      u"examples"),
                                               u"example")]
        except IndexError:
            examples = None

        return cls(utility=text(subtag(manpage, u"utility")),
                   section=text(subtag(manpage, u"section")),
                   name=text(subtag(manpage, u"name")),
                   title=text(subtag(manpage, u"title")),
                   synopsis=synopsis,
                   description=text(subtag(manpage, u"description")),
                   author=text(subtag(manpage, u"author")),
                   options=options,
                   elements=elements,
                   examples=examples)

    def to_man(self, stream):
        curdate = time.gmtime(int(os.environ.get('SOURCE_DATE_EPOCH',
                                                 time.time())))
        write_u(stream,
                (u".TH \"%(utility)s\" %(section)d " +
                 u"\"%(date)s\" \"\" \"%(title)s\"\n") %
                {"utility": self.utility.upper(),
                 "section": self.section,
                 "date": time.strftime("%F", curdate),
                 "title": self.title})
        write_u(stream, u".SH NAME\n")
        write_u(stream, u"%(utility)s \\- %(name)s\n" %
                {"utility": self.utility,
                 "name": self.name})
        if self.synopsis is not None:
            write_u(stream, u".SH SYNOPSIS\n")
            write_u(stream, u"%(utility)s %(synopsis)s\n" %
                    {"utility": self.utility,
                     "synopsis": self.synopsis})
        write_u(stream, u".SH DESCRIPTION\n")
        write_u(stream, u".PP\n")
        write_u(stream, self.description)
        write_u(stream, u"\n")
        for option in self.options:
            option.to_man(stream)
        for element in self.elements:
            element.to_man(stream)
        if len(self.examples) > 0:
            if len(self.examples) > 1:
                write_u(stream, u".SH EXAMPLES\n")
            else:
                write_u(stream, u".SH EXAMPLE\n")
            for example in self.examples:
                example.to_man(stream)

        for option in self.flatten_options():
            if option.long_arg == 'format':
                self.format_fields_man(stream)
                break

        self.see_also.sort(key=lambda x: x.utility)

        if len(self.see_also) > 0:
            write_u(stream, u".SH SEE ALSO\n")
            # handle the trailing comma correctly
            for page in self.see_also[0:-1]:
                write_u(stream, u".BR %(utility)s (%(section)d),\n" %
                        {"utility": page.utility,
                         "section": page.section})

            write_u(stream, u".BR %(utility)s (%(section)d)\n" %
                    {"utility": self.see_also[-1].utility,
                     "section": self.see_also[-1].section})

        write_u(stream, u".SH AUTHOR\n")
        write_u(stream, u"%(author)s\n" % {"author": self.author})

    def format_fields_man(self, stream):
        write_u(stream, u".SH FORMAT STRING FIELDS\n")
        write_u(stream, u".TS\n")
        write_u(stream, u"tab(:);\n")
        write_u(stream, u"| c   s |\n")
        write_u(stream, u"| c | c |\n")
        write_u(stream, u"| r | l |.\n")
        write_u(stream, u"_\n")
        write_u(stream, u"Template Fields\n")
        write_u(stream, u"Key:Value\n")
        write_u(stream, u"=\n")
        for (field, description) in self.FIELDS:
            write_u(stream, u"\\fC%(field)s\\fR:%(description)s\n" %
                    {"field": field,
                     "description": description})
        write_u(stream, u"_\n")
        write_u(stream, u".TE\n")

    def to_html(self, stream):
        write_u(stream, u'<div class="utility" id="%s">\n' % (self.utility))

        # display utility name
        write_u(stream, u"<h2>%s</h2>\n" % (self.utility))

        # display utility description
        write_u(stream, u"<p>%s</p>\n" % (self.description))

        # display options
        for option_section in self.options:
            option_section.to_html(stream)

        # display additional sections
        for element in self.elements:
            element.to_html(stream)

        # display examples
        if len(self.examples) > 0:
            write_u(stream, u'<dl class="examples">\n')
            if len(self.examples) > 1:
                write_u(stream, u"<dt>Examples</dt>\n")
            else:
                write_u(stream, u"<dt>Example</dt>\n")
            write_u(stream, u"<dd>\n")
            for example in self.examples:
                example.to_html(stream)
            write_u(stream, u"</dd>\n")
            write_u(stream, u"</dl>\n")

        write_u(stream, u'</div>\n')


class Options:
    def __init__(self, options, category=None):
        self.options = options
        self.category = category

    def __repr__(self):
        return "Options(%s, %s)" % \
            (self.options,
             self.category)

    @classmethod
    def parse(cls, xml_dom):
        if xml_dom.hasAttribute(u"category"):
            category = xml_dom.getAttribute(u"category")
        else:
            category = None

        return cls(options=[Option.parse(child) for child in
                            subtags(xml_dom, u"option")],
                   category=category)

    def to_man(self, stream):
        if self.category is None:
            write_u(stream, u".SH OPTIONS\n")
        else:
            write_u(stream, u".SH %(category)s OPTIONS\n" %
                    {"category": self.category.upper()})
        for option in self.options:
            option.to_man(stream)

    def to_html(self, stream):
        write_u(stream, u"<dl>\n")
        if self.category is None:
            write_u(stream, u"<dt>Options</dt>\n")
        else:
            write_u(stream, u"<dt>%s Options</dt>\n" %
                    self.category.capitalize())
        write_u(stream, u"<dd>\n")
        write_u(stream, u"<dl>\n")
        for option in self.options:
            option.to_html(stream)
        write_u(stream, u"</dl>\n")
        write_u(stream, u"</dd>\n")
        write_u(stream, u"</dl>\n")


class Option:
    def __init__(self,
                 short_arg=None,
                 long_arg=None,
                 arg_name=None,
                 description=None):
        self.short_arg = short_arg
        self.long_arg = long_arg
        self.arg_name = arg_name
        self.description = description

    def __repr__(self):
        return "Option(%s, %s, %s, %s)" % \
            (repr(self.short_arg),
             repr(self.long_arg),
             repr(self.arg_name),
             repr(self.description))

    @classmethod
    def parse(cls, xml_dom):
        if xml_dom.hasAttribute("short"):
            short_arg = xml_dom.getAttribute("short")
            if len(short_arg) > 1:
                raise ValueError("short arguments should be 1 character")
        else:
            short_arg = None

        if xml_dom.hasAttribute("long"):
            long_arg = xml_dom.getAttribute("long")
        else:
            long_arg = None

        if xml_dom.hasAttribute("arg"):
            arg_name = xml_dom.getAttribute("arg")
        else:
            arg_name = None

        if len(xml_dom.childNodes) > 0:
            description = WHITESPACE.sub(
                u" ", xml_dom.childNodes[0].wholeText.strip())
        else:
            description = None

        return cls(short_arg=short_arg,
                   long_arg=long_arg,
                   arg_name=arg_name,
                   description=description)

    def to_man(self, stream):
        write_u(stream, u".TP\n")
        if (self.short_arg is not None) and (self.long_arg is not None):
            if self.arg_name is not None:
                write_u(stream,
                        (u"\\fB\\-%(short_arg)s\\fR, " +
                         u"\\fB\\-\\-%(long_arg)s\\fR=" +
                         u"\\fI%(arg_name)s\\fR\n") %
                        {"short_arg": man_escape(self.short_arg),
                         "long_arg": man_escape(self.long_arg),
                         "arg_name": man_escape(self.arg_name.upper())})
            else:
                write_u(stream,
                        (u"\\fB\\-%(short_arg)s\\fR, " +
                         u"\\fB\\-\\-%(long_arg)s\\fR\n") %
                        {"short_arg": man_escape(self.short_arg),
                         "long_arg": man_escape(self.long_arg)})
        elif self.short_arg is not None:
            if self.arg_name is not None:
                write_u(stream,
                        (u"\\fB\\-%(short_arg)s\\fR " +
                         u"\\fI%(arg_name)s\\fR\n") %
                        {"short_arg": man_escape(self.short_arg),
                         "arg_name": man_escape(self.arg_name.upper())})
            else:
                write_u(stream,
                        u"\\fB\\-%(short_arg)s\\fR\n" %
                        {"short_arg": man_escape(self.short_arg)})
        elif self.long_arg is not None:
            if self.arg_name is not None:
                write_u(stream,
                        (u"\\fB\\-\\-%(long_arg)s\\fR" +
                         u"=\\fI%(arg_name)s\\fR\n") %
                        {"long_arg": man_escape(self.long_arg),
                         "arg_name": man_escape(self.arg_name.upper())})
            else:
                write_u(stream,
                        u"\\fB\\-\\-%(long_arg)s\\fR\n" %
                        {"long_arg": man_escape(self.long_arg)})
        else:
            raise ValueError("short arg or long arg must be present in option")

        if self.description is not None:
            write_u(stream, self.description)
            write_u(stream, u"\n")

    def to_html(self, stream):
        write_u(stream, u"<dt>\n")
        if (self.short_arg is not None) and (self.long_arg is not None):
            if self.arg_name is not None:
                write_u(stream,
                        (u"<b>-%(short_arg)s</b>, " +
                         u"<b>--%(long_arg)s</b>=" +
                         u"<i>%(arg_name)s</i>\n") %
                        {"short_arg": self.short_arg,
                         "long_arg": self.long_arg,
                         "arg_name": man_escape(self.arg_name.upper())})
            else:
                write_u(stream,
                        (u"<b>-%(short_arg)s</b>, " +
                         u"<b>--%(long_arg)s</b>\n") %
                        {"short_arg": self.short_arg,
                         "long_arg": self.long_arg})
        elif self.short_arg is not None:
            if self.arg_name is not None:
                write_u(stream,
                        (u"<b>-%(short_arg)s</b> " +
                         u"<i>%(arg_name)s</i>\n") %
                        {"short_arg": self.short_arg,
                         "arg_name": self.arg_name.upper()})
            else:
                write_u(stream,
                        u"<b>-%(short_arg)s\n" % {"short_arg": self.short_arg})
        elif self.long_arg is not None:
            if self.arg_name is not None:
                write_u(stream,
                        (u"<b>--%(long_arg)s</b>" +
                         u"=<i>%(arg_name)s</i>\n") %
                        {"long_arg": self.long_arg,
                         "arg_name": self.arg_name.upper()})
            else:
                write_u(stream,
                        u"<b>--%(long_arg)s</b>\n" %
                        {"long_arg": self.long_arg})
        else:
            raise ValueError("short arg or long arg must be present in option")

        write_u(stream, u"</dt>\n")

        if self.description is not None:
            write_u(stream, u"<dd>%s</dd>\n" % (self.description))
        else:
            write_u(stream, u"<dd></dd>\n")


class Example:
    def __init__(self,
                 description=u"",
                 commands=[]):
        self.description = description
        self.commands = commands

    def __repr__(self):
        return "Example(%s, %s)" % \
            (repr(self.description),
             repr(self.commands))

    @classmethod
    def parse(cls, xml_dom):
        return cls(description=text(subtag(xml_dom, u"description")),
                   commands=map(Command.parse, subtags(xml_dom, u"command")))

    def to_man(self, stream):
        write_u(stream, u".LP\n")
        write_u(stream, self.description)  # FIXME
        write_u(stream, u"\n")
        for command in self.commands:
            command.to_man(stream)

    def to_html(self, stream):
        write_u(stream, u'<dl>\n')
        write_u(stream, u"<dt>%s</dt>\n" % (self.description))
        write_u(stream, u"<dd>\n")
        for command in self.commands:
            command.to_html(stream)
        write_u(stream, u"</dd>\n")
        write_u(stream, u"</dl>\n")


class Command:
    def __init__(self, commandline, note=None):
        self.commandline = commandline
        self.note = note

    def __repr__(self):
        return "Command(%s, %s)" % (repr(self.commandline),
                                    repr(self.note))

    @classmethod
    def parse(cls, xml_dom):
        if xml_dom.hasAttribute(u"note"):
            note = xml_dom.getAttribute(u"note")
        else:
            note = None

        return cls(commandline=text(xml_dom),
                   note=note)

    def to_man(self, stream):
        if self.note is not None:
            write_u(stream, u".LP\n")
            write_u(stream, self.note + u" :\n\n")

        write_u(stream, u".IP\n")
        write_u(stream, self.commandline)
        write_u(stream, u"\n\n")

    def to_html(self, stream):
        if self.note is not None:
            write_u(stream,
                    u'<span class="note">%s :</span><br>\n' % (self.note))

        write_u(stream, self.commandline)
        write_u(stream, u"<br>\n")


class Element_P:
    def __init__(self, contents):
        self.contents = contents

    def __repr__(self):
        return "Element_P(%s)" % (repr(self.contents))

    @classmethod
    def parse(cls, xml_dom):
        return cls(contents=text(xml_dom))

    def to_man(self, stream):
        write_u(stream, self.contents)
        write_u(stream, u"\n.PP\n")

    def to_html(self, stream):
        write_u(stream, u"<p>%s</p>" % (self.contents))


class Element_UL:
    def __init__(self, list_items):
        self.list_items = list_items

    def __repr__(self):
        return "Element_UL(%s)" % (repr(self.list_items))

    @classmethod
    def parse(cls, xml_dom):
        return cls(list_items=map(text, subtags(xml_dom, u"li")))

    def to_man(self, stream):
        for item in self.list_items:
            write_u(stream, u"\\[bu] ")
            write_u(stream, item)
            write_u(stream, u"\n")
            write_u(stream, u".PP\n")

    def to_html(self, stream):
        write_u(stream, u"<ul>\n")
        for item in self.list_items:
            write_u(stream, u"<li>%s</li>\n" % (item))
        write_u(stream, u"</ul>\n")


class Element_TABLE:
    def __init__(self, rows):
        self.rows = rows

    def __repr__(self):
        return "Element_TABLE(%s)" % (repr(self.rows))

    @classmethod
    def parse(cls, xml_dom):
        return cls(rows=[Element_TR.parse(tr) for tr in subtags(xml_dom,
                                                                u"tr")])

    def to_man(self, stream):
        if len(self.rows) == 0:
            return

        if (len(set([len(row.columns) for row in self.rows
                     if row.tr_class in (TR_NORMAL, TR_HEADER)])) != 1):
            raise ValueError("all rows must have the same number of columns")
        else:
            columns = len(self.rows[0].columns)

        write_u(stream, u".TS\n")
        write_u(stream, u"tab(:);\n")
        write_u(stream,
                u" ".join([u"l" for l in self.rows[0].columns]) + u".\n")
        for row in self.rows:
            row.to_man(stream)
        write_u(stream, u".TE\n")

    def to_html(self, stream):
        if len(self.rows) == 0:
            return

        if (len({len(row.columns) for row in self.rows
                 if row.tr_class in (TR_NORMAL, TR_HEADER)}) != 1):
            raise ValueError("all rows must have the same number of columns")

        write_u(stream, u"<table>\n")
        for (row, spans) in zip(self.rows, self.calculate_row_spans()):
            row.to_html(stream, spans)
        write_u(stream, u"</table>\n")

    def calculate_row_spans(self):
        # turn rows into arrays of "span" boolean values
        row_spans = []
        for row in self.rows:
            if row.tr_class in (TR_NORMAL, TR_HEADER):
                row_spans.append([col.empty() for col in row.columns])
            elif row.tr_class == TR_DIVIDER:
                row_spans.append([False] * len(row_spans[-1]))

        # turn columns into arrays of integers containing the row span
        columns = [list(self.calculate_span_column([row[i] for
                                                    row in row_spans]))
                   for i in xrange(len(row_spans[0]))]

        # turn columns back into rows and return them
        return zip(*columns)

    def calculate_span_column(self, row_spans):
        rows = None
        for span in row_spans:
            if span:
                rows += 1
            else:
                if rows is not None:
                    yield rows
                    for i in xrange(rows - 1):
                        yield 0
                rows = 1

        if rows is not None:
            yield rows
            for i in xrange(rows - 1):
                yield 0


(TR_NORMAL, TR_HEADER, TR_DIVIDER) = range(3)


class Element_TR:
    def __init__(self, columns, tr_class):
        self.columns = columns
        self.tr_class = tr_class

    def __repr__(self):
        if self.tr_class in (TR_NORMAL, TR_HEADER):
            return "Element_TR(%s, %s)" % (repr(self.columns), self.tr_class)
        else:
            return "Element_TR_DIVIDER()"

    @classmethod
    def parse(cls, xml_dom):
        if xml_dom.hasAttribute("class"):
            if xml_dom.getAttribute("class") == "header":
                return cls(columns=[Element_TD.parse(tag)
                                    for tag in subtags(xml_dom, u"td")],
                           tr_class=TR_HEADER)
            elif xml_dom.getAttribute("class") == "divider":
                return cls(columns=None, tr_class=TR_DIVIDER)
            else:
                raise ValueError("unsupported class \"%s\"" %
                                 (xmldom_getAttribute("class")))
        else:
            return cls(columns=[Element_TD.parse(tag)
                                for tag in subtags(xml_dom, u"td")],
                       tr_class=TR_NORMAL)

    def to_man(self, stream):
        if self.tr_class == TR_NORMAL:
            write_u(stream,
                    u":".join(column.string() for column in self.columns) +
                    u"\n")
        elif self.tr_class == TR_HEADER:
            write_u(stream,
                    u":".join(u"\\fB%s\\fR" % (column.string())
                              for column in self.columns) +
                    u"\n")
            write_u(stream, u"_\n")
        elif self.tr_class == TR_DIVIDER:
            write_u(stream, u"_\n")

    def column_widths(self):
        if self.tr_class in (TR_NORMAL, TR_HEADER):
            return [column.width() for column in self.columns]
        else:
            return None

    def to_html(self, stream, rowspans):
        if self.tr_class in (TR_NORMAL, TR_HEADER):
            write_u(stream, u"<tr>\n")
            for (column, span) in zip(self.columns, rowspans):
                column.to_html(stream, self.tr_class == TR_HEADER, span)
            write_u(stream, u"</tr>\n")


class Element_TD:
    def __init__(self, value):
        self.value = value

    def __repr__(self):
        return "Element_TD(%s)" % (repr(self.value))

    @classmethod
    def parse(cls, xml_dom):
        try:
            return cls(value=WHITESPACE.sub(
                       u" ",
                       xml_dom.childNodes[0].wholeText.strip()))
        except IndexError:
            return cls(value=None)

    def empty(self):
        return self.value is None

    def string(self):
        if self.value is not None:
            return str(self.value.encode('ascii'))
        else:
            return "\\^"

    def to_man(self, stream):
        stream.write(self.value)

    def width(self):
        if self.value is not None:
            return len(self.value)
        else:
            return 0

    def to_html(self, stream, header, rowspan):
        if self.value is not None:
            if rowspan > 1:
                rowspan = u" rowspan=\"%d\"" % (rowspan)
            else:
                rowspan = u""

            if header:
                write_u(stream,
                        u"<th%s>%s</th>" % (rowspan, self.value))
            else:
                write_u(stream,
                        u"<td%s>%s</td>" % (rowspan, self.value))


class Element:
    SUB_ELEMENTS = {u"p": Element_P,
                    u"ul": Element_UL,
                    u"table": Element_TABLE}

    def __init__(self, name, elements):
        self.name = name
        self.elements = elements

    def __repr__(self):
        return "Element(%s, %s)" % (repr(self.name), repr(self.elements))

    @classmethod
    def parse(cls, xml_dom):
        if xml_dom.hasAttribute(u"name"):
            name = xml_dom.getAttribute(u"name")
        else:
            raise ValueError("elements must have names")

        elements = []
        for child in xml_dom.childNodes:
            if hasattr(child, "tagName"):
                if child.tagName in cls.SUB_ELEMENTS.keys():
                    elements.append(
                        cls.SUB_ELEMENTS[child.tagName].parse(child))
                else:
                    raise ValueError("unsupported tag %s" %
                                     (child.tagName.encode('ascii')))

        return cls(name=name,
                   elements=elements)

    def to_man(self, stream):
        write_u(stream, u".SH %s\n" % (self.name.upper()))
        for element in self.elements:
            element.to_man(stream)

    def to_html(self, stream):
        write_u(stream, u"<dl>\n")
        write_u(stream,
                u"<dt>%s</dt>\n" %
                (u" ".join(part.capitalize() for part in self.name.split())))
        write_u(stream, u"<dd>\n")
        for element in self.elements:
            element.to_html(stream)
        write_u(stream, u"</dd>\n")
        write_u(stream, u"</dl>\n")


if (__name__ == '__main__'):
    import sys
    import xml.dom.minidom
    import argparse

    parser = argparse.ArgumentParser(description="manual page generator")

    parser.add_argument("-i", "--input",
                        dest="input",
                        help="the primary input XML file")

    parser.add_argument("-t", "--type",
                        dest="type",
                        choices=("man", "html"),
                        default="man",
                        help="the output type")

    parser.add_argument("see_also",
                        metavar="FILENAME",
                        nargs="*",
                        help="\"see also\" man pages")

    options = parser.parse_args()

    if options.input is not None:
        main_page = Manpage.parse_file(options.input)
        all_pages = [Manpage.parse_file(filename)
                     for filename in options.see_also]
        main_page.see_also = [page for page in all_pages
                              if (page.utility != main_page.utility)]

        if options.type == "man":
            main_page.to_man(sys.stdout)
        elif options.type == "html":
            main_page.to_html(sys.stdout)