annotate genshi/output.py @ 830:de82830f8816 experimental-inline

inline branch: synced with trunk@1038.
author cmlenz
date Fri, 13 Mar 2009 20:04:26 +0000
parents 1837f39efd6f
children 09cc3627654c
rev   line source
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
1 # -*- coding: utf-8 -*-
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
2 #
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
3 # Copyright (C) 2006-2008 Edgewall Software
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
4 # All rights reserved.
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
5 #
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
6 # This software is licensed as described in the file COPYING, which
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
7 # you should have received as part of this distribution. The terms
230
24757b771651 Renamed Markup to Genshi in repository.
cmlenz
parents: 219
diff changeset
8 # are also available at http://genshi.edgewall.org/wiki/License.
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
9 #
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
10 # This software consists of voluntary contributions made by many
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
11 # individuals. For the exact contribution history, see the revision
230
24757b771651 Renamed Markup to Genshi in repository.
cmlenz
parents: 219
diff changeset
12 # history and logs, available at http://genshi.edgewall.org/log/.
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
13
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
14 """This module provides different kinds of serialization methods for XML event
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
15 streams.
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
16 """
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
17
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
18 from itertools import chain
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
19 import re
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
20
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
21 from genshi.core import escape, Attrs, Markup, Namespace, QName, StreamEventKind
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
22 from genshi.core import START, END, TEXT, XML_DECL, DOCTYPE, START_NS, END_NS, \
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
23 START_CDATA, END_CDATA, PI, COMMENT, XML_NAMESPACE
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
24
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
25 __all__ = ['encode', 'get_serializer', 'DocType', 'XMLSerializer',
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
26 'XHTMLSerializer', 'HTMLSerializer', 'TextSerializer']
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
27 __docformat__ = 'restructuredtext en'
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
28
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
29 def encode(iterator, method='xml', encoding='utf-8', out=None):
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
30 """Encode serializer output into a string.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
31
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
32 :param iterator: the iterator returned from serializing a stream (basically
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
33 any iterator that yields unicode objects)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
34 :param method: the serialization method; determines how characters not
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
35 representable in the specified encoding are treated
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
36 :param encoding: how the output string should be encoded; if set to `None`,
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
37 this method returns a `unicode` object
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
38 :param out: a file-like object that the output should be written to
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
39 instead of being returned as one big string; note that if
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
40 this is a file or socket (or similar), the `encoding` must
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
41 not be `None` (that is, the output must be encoded)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
42 :return: a `str` or `unicode` object (depending on the `encoding`
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
43 parameter), or `None` if the `out` parameter is provided
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
44
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
45 :since: version 0.4.1
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
46 :note: Changed in 0.5: added the `out` parameter
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
47 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
48 if encoding is not None:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
49 errors = 'replace'
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
50 if method != 'text' and not isinstance(method, TextSerializer):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
51 errors = 'xmlcharrefreplace'
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
52 _encode = lambda string: string.encode(encoding, errors)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
53 else:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
54 _encode = lambda string: string
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
55 if out is None:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
56 return _encode(u''.join(list(iterator)))
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
57 for chunk in iterator:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
58 out.write(_encode(chunk))
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
59
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
60 def get_serializer(method='xml', **kwargs):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
61 """Return a serializer object for the given method.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
62
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
63 :param method: the serialization method; can be either "xml", "xhtml",
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
64 "html", "text", or a custom serializer class
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
65
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
66 Any additional keyword arguments are passed to the serializer, and thus
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
67 depend on the `method` parameter value.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
68
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
69 :see: `XMLSerializer`, `XHTMLSerializer`, `HTMLSerializer`, `TextSerializer`
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
70 :since: version 0.4.1
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
71 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
72 if isinstance(method, basestring):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
73 method = {'xml': XMLSerializer,
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
74 'xhtml': XHTMLSerializer,
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
75 'html': HTMLSerializer,
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
76 'text': TextSerializer}[method.lower()]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
77 return method(**kwargs)
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
78
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
79
85
db8f2958c670 Improve handling of DOCTYPE declarations.
cmlenz
parents: 73
diff changeset
80 class DocType(object):
db8f2958c670 Improve handling of DOCTYPE declarations.
cmlenz
parents: 73
diff changeset
81 """Defines a number of commonly used DOCTYPE declarations as constants."""
db8f2958c670 Improve handling of DOCTYPE declarations.
cmlenz
parents: 73
diff changeset
82
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
83 HTML_STRICT = (
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
84 'html', '-//W3C//DTD HTML 4.01//EN',
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
85 'http://www.w3.org/TR/html4/strict.dtd'
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
86 )
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
87 HTML_TRANSITIONAL = (
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
88 'html', '-//W3C//DTD HTML 4.01 Transitional//EN',
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
89 'http://www.w3.org/TR/html4/loose.dtd'
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
90 )
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
91 HTML_FRAMESET = (
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
92 'html', '-//W3C//DTD HTML 4.01 Frameset//EN',
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
93 'http://www.w3.org/TR/html4/frameset.dtd'
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
94 )
85
db8f2958c670 Improve handling of DOCTYPE declarations.
cmlenz
parents: 73
diff changeset
95 HTML = HTML_STRICT
db8f2958c670 Improve handling of DOCTYPE declarations.
cmlenz
parents: 73
diff changeset
96
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
97 HTML5 = ('html', None, None)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
98
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
99 XHTML_STRICT = (
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
100 'html', '-//W3C//DTD XHTML 1.0 Strict//EN',
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
101 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
102 )
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
103 XHTML_TRANSITIONAL = (
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
104 'html', '-//W3C//DTD XHTML 1.0 Transitional//EN',
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
105 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
106 )
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
107 XHTML_FRAMESET = (
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
108 'html', '-//W3C//DTD XHTML 1.0 Frameset//EN',
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
109 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd'
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
110 )
85
db8f2958c670 Improve handling of DOCTYPE declarations.
cmlenz
parents: 73
diff changeset
111 XHTML = XHTML_STRICT
db8f2958c670 Improve handling of DOCTYPE declarations.
cmlenz
parents: 73
diff changeset
112
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
113 XHTML11 = (
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
114 'html', '-//W3C//DTD XHTML 1.1//EN',
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
115 'http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd'
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
116 )
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
117
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
118 SVG_FULL = (
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
119 'svg', '-//W3C//DTD SVG 1.1//EN',
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
120 'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd'
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
121 )
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
122 SVG_BASIC = (
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
123 'svg', '-//W3C//DTD SVG Basic 1.1//EN',
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
124 'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-basic.dtd'
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
125 )
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
126 SVG_TINY = (
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
127 'svg', '-//W3C//DTD SVG Tiny 1.1//EN',
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
128 'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd'
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
129 )
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
130 SVG = SVG_FULL
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
131
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
132 @classmethod
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
133 def get(cls, name):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
134 """Return the ``(name, pubid, sysid)`` tuple of the ``DOCTYPE``
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
135 declaration for the specified name.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
136
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
137 The following names are recognized in this version:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
138 * "html" or "html-strict" for the HTML 4.01 strict DTD
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
139 * "html-transitional" for the HTML 4.01 transitional DTD
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
140 * "html-frameset" for the HTML 4.01 frameset DTD
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
141 * "html5" for the ``DOCTYPE`` proposed for HTML5
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
142 * "xhtml" or "xhtml-strict" for the XHTML 1.0 strict DTD
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
143 * "xhtml-transitional" for the XHTML 1.0 transitional DTD
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
144 * "xhtml-frameset" for the XHTML 1.0 frameset DTD
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
145 * "xhtml11" for the XHTML 1.1 DTD
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
146 * "svg" or "svg-full" for the SVG 1.1 DTD
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
147 * "svg-basic" for the SVG Basic 1.1 DTD
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
148 * "svg-tiny" for the SVG Tiny 1.1 DTD
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
149
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
150 :param name: the name of the ``DOCTYPE``
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
151 :return: the ``(name, pubid, sysid)`` tuple for the requested
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
152 ``DOCTYPE``, or ``None`` if the name is not recognized
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
153 :since: version 0.4.1
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
154 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
155 return {
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
156 'html': cls.HTML, 'html-strict': cls.HTML_STRICT,
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
157 'html-transitional': DocType.HTML_TRANSITIONAL,
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
158 'html-frameset': DocType.HTML_FRAMESET,
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
159 'html5': cls.HTML5,
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
160 'xhtml': cls.XHTML, 'xhtml-strict': cls.XHTML_STRICT,
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
161 'xhtml-transitional': cls.XHTML_TRANSITIONAL,
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
162 'xhtml-frameset': cls.XHTML_FRAMESET,
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
163 'xhtml11': cls.XHTML11,
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
164 'svg': cls.SVG, 'svg-full': cls.SVG_FULL,
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
165 'svg-basic': cls.SVG_BASIC,
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
166 'svg-tiny': cls.SVG_TINY
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
167 }.get(name.lower())
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
168
85
db8f2958c670 Improve handling of DOCTYPE declarations.
cmlenz
parents: 73
diff changeset
169
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
170 class XMLSerializer(object):
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
171 """Produces XML text from an event stream.
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
172
230
24757b771651 Renamed Markup to Genshi in repository.
cmlenz
parents: 219
diff changeset
173 >>> from genshi.builder import tag
20
e3d3c1d8c98a Fix tests broken in [20].
cmlenz
parents: 19
diff changeset
174 >>> elem = tag.div(tag.a(href='foo'), tag.br, tag.hr(noshade=True))
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
175 >>> print ''.join(XMLSerializer()(elem.generate()))
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
176 <div><a href="foo"/><br/><hr noshade="True"/></div>
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
177 """
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
178
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
179 _PRESERVE_SPACE = frozenset()
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
180
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
181 def __init__(self, doctype=None, strip_whitespace=True,
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
182 namespace_prefixes=None, cache=True):
85
db8f2958c670 Improve handling of DOCTYPE declarations.
cmlenz
parents: 73
diff changeset
183 """Initialize the XML serializer.
db8f2958c670 Improve handling of DOCTYPE declarations.
cmlenz
parents: 73
diff changeset
184
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
185 :param doctype: a ``(name, pubid, sysid)`` tuple that represents the
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
186 DOCTYPE declaration that should be included at the top
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
187 of the generated output, or the name of a DOCTYPE as
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
188 defined in `DocType.get`
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
189 :param strip_whitespace: whether extraneous whitespace should be
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
190 stripped from the output
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
191 :param cache: whether to cache the text output per event, which
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
192 improves performance for repetitive markup
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
193 :note: Changed in 0.4.2: The `doctype` parameter can now be a string.
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
194 :note: Changed in 0.6: The `cache` parameter was added
85
db8f2958c670 Improve handling of DOCTYPE declarations.
cmlenz
parents: 73
diff changeset
195 """
212
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
196 self.filters = [EmptyTagFilter()]
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
197 if strip_whitespace:
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
198 self.filters.append(WhitespaceFilter(self._PRESERVE_SPACE))
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
199 self.filters.append(NamespaceFlattener(prefixes=namespace_prefixes,
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
200 cache=cache))
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
201 if doctype:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
202 self.filters.append(DocTypeInserter(doctype))
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
203 self.cache = cache
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
204
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
205 def __call__(self, stream):
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
206 have_decl = have_doctype = False
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
207 in_cdata = False
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
208
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
209 cache = {}
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
210 cache_get = cache.get
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
211 if self.cache:
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
212 def _emit(kind, input, output):
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
213 cache[kind, input] = output
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
214 return output
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
215 else:
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
216 def _emit(kind, input, output):
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
217 return output
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
218
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
219 for filter_ in self.filters:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
220 stream = filter_(stream)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
221 for kind, data, pos in stream:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
222 cached = cache_get((kind, data))
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
223 if cached is not None:
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
224 yield cached
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
225
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
226 elif kind is START or kind is EMPTY:
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
227 tag, attrib = data
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
228 buf = ['<', tag]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
229 for attr, value in attrib:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
230 buf += [' ', attr, '="', escape(value), '"']
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
231 buf.append(kind is EMPTY and '/>' or '>')
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
232 yield _emit(kind, data, Markup(u''.join(buf)))
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
233
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
234 elif kind is END:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
235 yield _emit(kind, data, Markup('</%s>' % data))
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
236
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
237 elif kind is TEXT:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
238 if in_cdata:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
239 yield _emit(kind, data, data)
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
240 else:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
241 yield _emit(kind, data, escape(data, quotes=False))
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
242
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
243 elif kind is COMMENT:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
244 yield _emit(kind, data, Markup('<!--%s-->' % data))
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
245
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
246 elif kind is XML_DECL and not have_decl:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
247 version, encoding, standalone = data
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
248 buf = ['<?xml version="%s"' % version]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
249 if encoding:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
250 buf.append(' encoding="%s"' % encoding)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
251 if standalone != -1:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
252 standalone = standalone and 'yes' or 'no'
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
253 buf.append(' standalone="%s"' % standalone)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
254 buf.append('?>\n')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
255 yield Markup(u''.join(buf))
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
256 have_decl = True
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
257
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
258 elif kind is DOCTYPE and not have_doctype:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
259 name, pubid, sysid = data
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
260 buf = ['<!DOCTYPE %s']
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
261 if pubid:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
262 buf.append(' PUBLIC "%s"')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
263 elif sysid:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
264 buf.append(' SYSTEM')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
265 if sysid:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
266 buf.append(' "%s"')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
267 buf.append('>\n')
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
268 yield Markup(u''.join(buf)) % filter(None, data)
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
269 have_doctype = True
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
270
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
271 elif kind is START_CDATA:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
272 yield Markup('<![CDATA[')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
273 in_cdata = True
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
274
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
275 elif kind is END_CDATA:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
276 yield Markup(']]>')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
277 in_cdata = False
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
278
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
279 elif kind is PI:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
280 yield _emit(kind, data, Markup('<?%s %s?>' % data))
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
281
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
282
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
283 class XHTMLSerializer(XMLSerializer):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
284 """Produces XHTML text from an event stream.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
285
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
286 >>> from genshi.builder import tag
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
287 >>> elem = tag.div(tag.a(href='foo'), tag.br, tag.hr(noshade=True))
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
288 >>> print ''.join(XHTMLSerializer()(elem.generate()))
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
289 <div><a href="foo"></a><br /><hr noshade="noshade" /></div>
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
290 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
291
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
292 _EMPTY_ELEMS = frozenset(['area', 'base', 'basefont', 'br', 'col', 'frame',
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
293 'hr', 'img', 'input', 'isindex', 'link', 'meta',
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
294 'param'])
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
295 _BOOLEAN_ATTRS = frozenset(['selected', 'checked', 'compact', 'declare',
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
296 'defer', 'disabled', 'ismap', 'multiple',
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
297 'nohref', 'noresize', 'noshade', 'nowrap'])
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
298 _PRESERVE_SPACE = frozenset([
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
299 QName('pre'), QName('http://www.w3.org/1999/xhtml}pre'),
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
300 QName('textarea'), QName('http://www.w3.org/1999/xhtml}textarea')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
301 ])
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
302
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
303 def __init__(self, doctype=None, strip_whitespace=True,
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
304 namespace_prefixes=None, drop_xml_decl=True, cache=True):
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
305 super(XHTMLSerializer, self).__init__(doctype, False)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
306 self.filters = [EmptyTagFilter()]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
307 if strip_whitespace:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
308 self.filters.append(WhitespaceFilter(self._PRESERVE_SPACE))
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
309 namespace_prefixes = namespace_prefixes or {}
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
310 namespace_prefixes['http://www.w3.org/1999/xhtml'] = ''
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
311 self.filters.append(NamespaceFlattener(prefixes=namespace_prefixes,
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
312 cache=cache))
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
313 if doctype:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
314 self.filters.append(DocTypeInserter(doctype))
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
315 self.drop_xml_decl = drop_xml_decl
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
316 self.cache = cache
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
317
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
318 def __call__(self, stream):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
319 boolean_attrs = self._BOOLEAN_ATTRS
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
320 empty_elems = self._EMPTY_ELEMS
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
321 drop_xml_decl = self.drop_xml_decl
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
322 have_decl = have_doctype = False
143
ef761afcedff CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24.
cmlenz
parents: 141
diff changeset
323 in_cdata = False
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
324
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
325 cache = {}
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
326 cache_get = cache.get
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
327 if self.cache:
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
328 def _emit(kind, input, output):
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
329 cache[kind, input] = output
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
330 return output
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
331 else:
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
332 def _emit(kind, input, output):
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
333 return output
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
334
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
335 for filter_ in self.filters:
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
336 stream = filter_(stream)
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
337 for kind, data, pos in stream:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
338 cached = cache_get((kind, data))
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
339 if cached is not None:
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
340 yield cached
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
341
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
342 elif kind is START or kind is EMPTY:
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
343 tag, attrib = data
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
344 buf = ['<', tag]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
345 for attr, value in attrib:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
346 if attr in boolean_attrs:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
347 value = attr
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
348 elif attr == u'xml:lang' and u'lang' not in attrib:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
349 buf += [' lang="', escape(value), '"']
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
350 elif attr == u'xml:space':
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
351 continue
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
352 buf += [' ', attr, '="', escape(value), '"']
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
353 if kind is EMPTY:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
354 if tag in empty_elems:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
355 buf.append(' />')
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
356 else:
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
357 buf.append('></%s>' % tag)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
358 else:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
359 buf.append('>')
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
360 yield _emit(kind, data, Markup(u''.join(buf)))
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
361
69
e9a3930f8823 A couple of minor performance improvements.
cmlenz
parents: 66
diff changeset
362 elif kind is END:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
363 yield _emit(kind, data, Markup('</%s>' % data))
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
364
69
e9a3930f8823 A couple of minor performance improvements.
cmlenz
parents: 66
diff changeset
365 elif kind is TEXT:
143
ef761afcedff CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24.
cmlenz
parents: 141
diff changeset
366 if in_cdata:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
367 yield _emit(kind, data, data)
143
ef761afcedff CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24.
cmlenz
parents: 141
diff changeset
368 else:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
369 yield _emit(kind, data, escape(data, quotes=False))
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
370
89
d4c7617900e3 Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output.
cmlenz
parents: 85
diff changeset
371 elif kind is COMMENT:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
372 yield _emit(kind, data, Markup('<!--%s-->' % data))
89
d4c7617900e3 Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output.
cmlenz
parents: 85
diff changeset
373
136
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
374 elif kind is DOCTYPE and not have_doctype:
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
375 name, pubid, sysid = data
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
376 buf = ['<!DOCTYPE %s']
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
377 if pubid:
398
49aa525b8f83 inline branch: Merged [480:486/trunk].
cmlenz
parents: 347
diff changeset
378 buf.append(' PUBLIC "%s"')
136
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
379 elif sysid:
398
49aa525b8f83 inline branch: Merged [480:486/trunk].
cmlenz
parents: 347
diff changeset
380 buf.append(' SYSTEM')
136
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
381 if sysid:
398
49aa525b8f83 inline branch: Merged [480:486/trunk].
cmlenz
parents: 347
diff changeset
382 buf.append(' "%s"')
49aa525b8f83 inline branch: Merged [480:486/trunk].
cmlenz
parents: 347
diff changeset
383 buf.append('>\n')
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
384 yield Markup(u''.join(buf)) % filter(None, data)
136
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
385 have_doctype = True
109
2de3f9d84a1c Reorder the conditional branches in the serializers so that the more common event kinds are on top.
cmlenz
parents: 105
diff changeset
386
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
387 elif kind is XML_DECL and not have_decl and not drop_xml_decl:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
388 version, encoding, standalone = data
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
389 buf = ['<?xml version="%s"' % version]
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
390 if encoding:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
391 buf.append(' encoding="%s"' % encoding)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
392 if standalone != -1:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
393 standalone = standalone and 'yes' or 'no'
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
394 buf.append(' standalone="%s"' % standalone)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
395 buf.append('?>\n')
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
396 yield Markup(u''.join(buf))
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
397 have_decl = True
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
398
143
ef761afcedff CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24.
cmlenz
parents: 141
diff changeset
399 elif kind is START_CDATA:
ef761afcedff CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24.
cmlenz
parents: 141
diff changeset
400 yield Markup('<![CDATA[')
ef761afcedff CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24.
cmlenz
parents: 141
diff changeset
401 in_cdata = True
ef761afcedff CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24.
cmlenz
parents: 141
diff changeset
402
ef761afcedff CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24.
cmlenz
parents: 141
diff changeset
403 elif kind is END_CDATA:
ef761afcedff CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24.
cmlenz
parents: 141
diff changeset
404 yield Markup(']]>')
ef761afcedff CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24.
cmlenz
parents: 141
diff changeset
405 in_cdata = False
ef761afcedff CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24.
cmlenz
parents: 141
diff changeset
406
105
334a338847af Include processing instructions in serialized streams.
cmlenz
parents: 96
diff changeset
407 elif kind is PI:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
408 yield _emit(kind, data, Markup('<?%s %s?>' % data))
105
334a338847af Include processing instructions in serialized streams.
cmlenz
parents: 96
diff changeset
409
96
35d681a94763 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module.
cmlenz
parents: 89
diff changeset
410
35d681a94763 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module.
cmlenz
parents: 89
diff changeset
411 class HTMLSerializer(XHTMLSerializer):
35d681a94763 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module.
cmlenz
parents: 89
diff changeset
412 """Produces HTML text from an event stream.
35d681a94763 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module.
cmlenz
parents: 89
diff changeset
413
230
24757b771651 Renamed Markup to Genshi in repository.
cmlenz
parents: 219
diff changeset
414 >>> from genshi.builder import tag
96
35d681a94763 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module.
cmlenz
parents: 89
diff changeset
415 >>> elem = tag.div(tag.a(href='foo'), tag.br, tag.hr(noshade=True))
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
416 >>> print ''.join(HTMLSerializer()(elem.generate()))
96
35d681a94763 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module.
cmlenz
parents: 89
diff changeset
417 <div><a href="foo"></a><br><hr noshade></div>
35d681a94763 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module.
cmlenz
parents: 89
diff changeset
418 """
35d681a94763 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module.
cmlenz
parents: 89
diff changeset
419
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
420 _NOESCAPE_ELEMS = frozenset([
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
421 QName('script'), QName('http://www.w3.org/1999/xhtml}script'),
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
422 QName('style'), QName('http://www.w3.org/1999/xhtml}style')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
423 ])
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
424
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
425 def __init__(self, doctype=None, strip_whitespace=True, cache=True):
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
426 """Initialize the HTML serializer.
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
427
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
428 :param doctype: a ``(name, pubid, sysid)`` tuple that represents the
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
429 DOCTYPE declaration that should be included at the top
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
430 of the generated output
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
431 :param strip_whitespace: whether extraneous whitespace should be
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
432 stripped from the output
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
433 :param cache: whether to cache the text output per event, which
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
434 improves performance for repetitive markup
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
435 :note: Changed in 0.6: The `cache` parameter was added
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
436 """
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
437 super(HTMLSerializer, self).__init__(doctype, False)
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
438 self.filters = [EmptyTagFilter()]
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
439 if strip_whitespace:
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
440 self.filters.append(WhitespaceFilter(self._PRESERVE_SPACE,
305
6e6950ac0e56 Various performance-oriented tweaks.
cmlenz
parents: 280
diff changeset
441 self._NOESCAPE_ELEMS))
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
442 self.filters.append(NamespaceFlattener(prefixes={
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
443 'http://www.w3.org/1999/xhtml': ''
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
444 }, cache=cache))
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
445 if doctype:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
446 self.filters.append(DocTypeInserter(doctype))
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
447 self.cache = True
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
448
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
449 def __call__(self, stream):
136
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
450 boolean_attrs = self._BOOLEAN_ATTRS
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
451 empty_elems = self._EMPTY_ELEMS
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
452 noescape_elems = self._NOESCAPE_ELEMS
96
35d681a94763 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module.
cmlenz
parents: 89
diff changeset
453 have_doctype = False
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
454 noescape = False
96
35d681a94763 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module.
cmlenz
parents: 89
diff changeset
455
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
456 cache = {}
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
457 cache_get = cache.get
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
458 if self.cache:
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
459 def _emit(kind, input, output):
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
460 cache[kind, input] = output
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
461 return output
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
462 else:
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
463 def _emit(kind, input, output):
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
464 return output
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
465
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
466 for filter_ in self.filters:
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
467 stream = filter_(stream)
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
468 for kind, data, _ in stream:
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
469 output = cache_get((kind, data))
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
470 if output is not None:
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
471 yield output
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
472 if kind is START or kind is EMPTY and data[0] in noescape_elems:
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
473 noescape = True
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
474 elif kind is END:
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
475 noescape = False
96
35d681a94763 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module.
cmlenz
parents: 89
diff changeset
476
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
477 elif kind is START or kind is EMPTY:
96
35d681a94763 Add an XHTML serialization method. Now really need to get rid of some code duplication in the `markup.output` module.
cmlenz
parents: 89
diff changeset
478 tag, attrib = data
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
479 buf = ['<', tag]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
480 for attr, value in attrib:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
481 if attr in boolean_attrs:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
482 if value:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
483 buf += [' ', attr]
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
484 elif ':' in attr:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
485 if attr == 'xml:lang' and u'lang' not in attrib:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
486 buf += [' lang="', escape(value), '"']
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
487 elif attr != 'xmlns':
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
488 buf += [' ', attr, '="', escape(value), '"']
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
489 buf.append('>')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
490 if kind is EMPTY:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
491 if tag not in empty_elems:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
492 buf.append('</%s>' % tag)
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
493 yield _emit(kind, data, Markup(u''.join(buf)))
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
494 if tag in noescape_elems:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
495 noescape = True
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
496
69
e9a3930f8823 A couple of minor performance improvements.
cmlenz
parents: 66
diff changeset
497 elif kind is END:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
498 yield _emit(kind, data, Markup('</%s>' % data))
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
499 noescape = False
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
500
69
e9a3930f8823 A couple of minor performance improvements.
cmlenz
parents: 66
diff changeset
501 elif kind is TEXT:
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
502 if noescape:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
503 yield _emit(kind, data, data)
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
504 else:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
505 yield _emit(kind, data, escape(data, quotes=False))
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
506
89
d4c7617900e3 Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output.
cmlenz
parents: 85
diff changeset
507 elif kind is COMMENT:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
508 yield _emit(kind, data, Markup('<!--%s-->' % data))
89
d4c7617900e3 Support comments in templates that are not included in the output, in the same way Kid does: if the comment text starts with a `!` character, it is stripped from the output.
cmlenz
parents: 85
diff changeset
509
136
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
510 elif kind is DOCTYPE and not have_doctype:
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
511 name, pubid, sysid = data
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
512 buf = ['<!DOCTYPE %s']
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
513 if pubid:
398
49aa525b8f83 inline branch: Merged [480:486/trunk].
cmlenz
parents: 347
diff changeset
514 buf.append(' PUBLIC "%s"')
136
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
515 elif sysid:
398
49aa525b8f83 inline branch: Merged [480:486/trunk].
cmlenz
parents: 347
diff changeset
516 buf.append(' SYSTEM')
136
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
517 if sysid:
398
49aa525b8f83 inline branch: Merged [480:486/trunk].
cmlenz
parents: 347
diff changeset
518 buf.append(' "%s"')
49aa525b8f83 inline branch: Merged [480:486/trunk].
cmlenz
parents: 347
diff changeset
519 buf.append('>\n')
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
520 yield Markup(u''.join(buf)) % filter(None, data)
136
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
521 have_doctype = True
109
2de3f9d84a1c Reorder the conditional branches in the serializers so that the more common event kinds are on top.
cmlenz
parents: 105
diff changeset
522
105
334a338847af Include processing instructions in serialized streams.
cmlenz
parents: 96
diff changeset
523 elif kind is PI:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
524 yield _emit(kind, data, Markup('<?%s %s?>' % data))
105
334a338847af Include processing instructions in serialized streams.
cmlenz
parents: 96
diff changeset
525
1
821114ec4f69 Initial import.
cmlenz
parents:
diff changeset
526
200
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
527 class TextSerializer(object):
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
528 """Produces plain text from an event stream.
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
529
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
530 Only text events are included in the output. Unlike the other serializer,
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
531 special XML characters are not escaped:
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
532
230
24757b771651 Renamed Markup to Genshi in repository.
cmlenz
parents: 219
diff changeset
533 >>> from genshi.builder import tag
200
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
534 >>> elem = tag.div(tag.a('<Hello!>', href='foo'), tag.br)
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
535 >>> print elem
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
536 <div><a href="foo">&lt;Hello!&gt;</a><br/></div>
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
537 >>> print ''.join(TextSerializer()(elem.generate()))
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
538 <Hello!>
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
539
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
540 If text events contain literal markup (instances of the `Markup` class),
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
541 that markup is by default passed through unchanged:
200
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
542
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
543 >>> elem = tag.div(Markup('<a href="foo">Hello &amp; Bye!</a><br/>'))
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
544 >>> print elem.generate().render(TextSerializer)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
545 <a href="foo">Hello &amp; Bye!</a><br/>
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
546
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
547 You can use the ``strip_markup`` to change this behavior, so that tags and
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
548 entities are stripped from the output (or in the case of entities,
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
549 replaced with the equivalent character):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
550
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
551 >>> print elem.generate().render(TextSerializer, strip_markup=True)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
552 Hello & Bye!
200
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
553 """
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
554
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
555 def __init__(self, strip_markup=False):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
556 """Create the serializer.
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
557
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
558 :param strip_markup: whether markup (tags and encoded characters) found
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
559 in the text should be removed
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
560 """
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
561 self.strip_markup = strip_markup
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
562
200
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
563 def __call__(self, stream):
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
564 strip_markup = self.strip_markup
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
565 for event in stream:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
566 if event[0] is TEXT:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
567 data = event[1]
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
568 if strip_markup and type(data) is Markup:
200
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
569 data = data.striptags().stripentities()
201
0f16c907077e The `TextSerializer` should produce `unicode` objects, not `Markup` objects.
cmlenz
parents: 200
diff changeset
570 yield unicode(data)
200
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
571
50eab0469148 Add serialization to plain text, based on cboos' patch. Closes #41.
cmlenz
parents: 178
diff changeset
572
212
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
573 class EmptyTagFilter(object):
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
574 """Combines `START` and `STOP` events into `EMPTY` events for elements that
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
575 have no contents.
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
576 """
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
577
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
578 EMPTY = StreamEventKind('EMPTY')
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
579
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
580 def __call__(self, stream):
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
581 prev = (None, None, None)
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
582 for ev in stream:
212
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
583 if prev[0] is START:
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
584 if ev[0] is END:
212
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
585 prev = EMPTY, prev[1], prev[2]
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
586 yield prev
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
587 continue
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
588 else:
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
589 yield prev
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
590 if ev[0] is not START:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
591 yield ev
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
592 prev = ev
212
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
593
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
594
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
595 EMPTY = EmptyTagFilter.EMPTY
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
596
e8c43127d9a9 Refactored the handling of empty tags in the serializer: use an `EmptyTagFilter` that combines adjacent start/end events, instead of the generic pushback-iterator.
cmlenz
parents: 201
diff changeset
597
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
598 class NamespaceFlattener(object):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
599 r"""Output stream filter that removes namespace information from the stream,
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
600 instead adding namespace attributes and prefixes as needed.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
601
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
602 :param prefixes: optional mapping of namespace URIs to prefixes
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
603
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
604 >>> from genshi.input import XML
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
605 >>> xml = XML('''<doc xmlns="NS1" xmlns:two="NS2">
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
606 ... <two:item/>
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
607 ... </doc>''')
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
608 >>> for kind, data, pos in NamespaceFlattener()(xml):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
609 ... print kind, repr(data)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
610 START (u'doc', Attrs([(u'xmlns', u'NS1'), (u'xmlns:two', u'NS2')]))
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
611 TEXT u'\n '
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
612 START (u'two:item', Attrs())
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
613 END u'two:item'
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
614 TEXT u'\n'
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
615 END u'doc'
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
616 """
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
617
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
618 def __init__(self, prefixes=None, cache=True):
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
619 self.prefixes = {XML_NAMESPACE.uri: 'xml'}
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
620 if prefixes is not None:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
621 self.prefixes.update(prefixes)
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
622 self.cache = cache
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
623
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
624 def __call__(self, stream):
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
625 cache = {}
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
626 cache_get = cache.get
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
627 if self.cache:
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
628 def _emit(kind, input, output, pos):
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
629 cache[kind, input] = output
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
630 return kind, output, pos
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
631 else:
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
632 def _emit(kind, input, output, pos):
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
633 return output
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
634
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
635 prefixes = dict([(v, [k]) for k, v in self.prefixes.items()])
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
636 namespaces = {XML_NAMESPACE.uri: ['xml']}
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
637 def _push_ns(prefix, uri):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
638 namespaces.setdefault(uri, []).append(prefix)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
639 prefixes.setdefault(prefix, []).append(uri)
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
640 cache.clear()
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
641 def _pop_ns(prefix):
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
642 uris = prefixes.get(prefix)
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
643 uri = uris.pop()
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
644 if not uris:
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
645 del prefixes[prefix]
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
646 if uri not in uris or uri != uris[-1]:
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
647 uri_prefixes = namespaces[uri]
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
648 uri_prefixes.pop()
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
649 if not uri_prefixes:
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
650 del namespaces[uri]
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
651 cache.clear()
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
652 return uri
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
653
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
654 ns_attrs = []
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
655 _push_ns_attr = ns_attrs.append
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
656 def _make_ns_attr(prefix, uri):
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
657 return u'xmlns%s' % (prefix and ':%s' % prefix or ''), uri
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
658
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
659 def _gen_prefix():
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
660 val = 0
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
661 while 1:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
662 val += 1
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
663 yield 'ns%d' % val
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
664 _gen_prefix = _gen_prefix().next
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
665
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
666 for kind, data, pos in stream:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
667 output = cache_get((kind, data))
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
668 if output is not None:
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
669 yield kind, output, pos
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
670
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
671 elif kind is START or kind is EMPTY:
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
672 tag, attrs = data
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
673
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
674 tagname = tag.localname
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
675 tagns = tag.namespace
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
676 if tagns:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
677 if tagns in namespaces:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
678 prefix = namespaces[tagns][-1]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
679 if prefix:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
680 tagname = u'%s:%s' % (prefix, tagname)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
681 else:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
682 _push_ns_attr((u'xmlns', tagns))
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
683 _push_ns('', tagns)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
684
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
685 new_attrs = []
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
686 for attr, value in attrs:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
687 attrname = attr.localname
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
688 attrns = attr.namespace
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
689 if attrns:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
690 if attrns not in namespaces:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
691 prefix = _gen_prefix()
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
692 _push_ns(prefix, attrns)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
693 _push_ns_attr(('xmlns:%s' % prefix, attrns))
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
694 else:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
695 prefix = namespaces[attrns][-1]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
696 if prefix:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
697 attrname = u'%s:%s' % (prefix, attrname)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
698 new_attrs.append((attrname, value))
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
699
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
700 yield _emit(kind, data, (tagname, Attrs(ns_attrs + new_attrs)), pos)
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
701 del ns_attrs[:]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
702
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
703 elif kind is END:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
704 tagname = data.localname
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
705 tagns = data.namespace
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
706 if tagns:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
707 prefix = namespaces[tagns][-1]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
708 if prefix:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
709 tagname = u'%s:%s' % (prefix, tagname)
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
710 yield _emit(kind, data, tagname, pos)
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
711
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
712 elif kind is START_NS:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
713 prefix, uri = data
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
714 if uri not in namespaces:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
715 prefix = prefixes.get(uri, [prefix])[-1]
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
716 _push_ns_attr(_make_ns_attr(prefix, uri))
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
717 _push_ns(prefix, uri)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
718
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
719 elif kind is END_NS:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
720 if data in prefixes:
830
de82830f8816 inline branch: synced with trunk@1038.
cmlenz
parents: 820
diff changeset
721 uri = _pop_ns(data)
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
722 if ns_attrs:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
723 attr = _make_ns_attr(data, uri)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
724 if attr in ns_attrs:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
725 ns_attrs.remove(attr)
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
726
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
727 else:
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
728 yield kind, data, pos
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
729
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
730
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
731 class WhitespaceFilter(object):
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
732 """A filter that removes extraneous ignorable white space from the
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
733 stream.
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
734 """
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
735
305
6e6950ac0e56 Various performance-oriented tweaks.
cmlenz
parents: 280
diff changeset
736 def __init__(self, preserve=None, noescape=None):
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
737 """Initialize the filter.
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
738
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
739 :param preserve: a set or sequence of tag names for which white-space
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
740 should be preserved
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
741 :param noescape: a set or sequence of tag names for which text content
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
742 should not be escaped
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
743
347
c0a4114786cc cspeedups branch: Merged [423:426/trunk].
cmlenz
parents: 305
diff changeset
744 The `noescape` set is expected to refer to elements that cannot contain
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
745 further child elements (such as ``<style>`` or ``<script>`` in HTML
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
746 documents).
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
747 """
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
748 if preserve is None:
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
749 preserve = []
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
750 self.preserve = frozenset(preserve)
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
751 if noescape is None:
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
752 noescape = []
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
753 self.noescape = frozenset(noescape)
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
754
219
0f897d319002 Minor improvements to `WhitespaceFilter`.
cmlenz
parents: 213
diff changeset
755 def __call__(self, stream, ctxt=None, space=XML_NAMESPACE['space'],
0f897d319002 Minor improvements to `WhitespaceFilter`.
cmlenz
parents: 213
diff changeset
756 trim_trailing_space=re.compile('[ \t]+(?=\n)').sub,
0f897d319002 Minor improvements to `WhitespaceFilter`.
cmlenz
parents: 213
diff changeset
757 collapse_lines=re.compile('\n{2,}').sub):
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
758 mjoin = Markup('').join
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
759 preserve_elems = self.preserve
347
c0a4114786cc cspeedups branch: Merged [423:426/trunk].
cmlenz
parents: 305
diff changeset
760 preserve = 0
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
761 noescape_elems = self.noescape
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
762 noescape = False
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
763
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
764 textbuf = []
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
765 push_text = textbuf.append
136
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
766 pop_text = textbuf.pop
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
767 for kind, data, pos in chain(stream, [(None, None, None)]):
500
0742f421caba Merged revisions 487-603 via svnmerge from
cmlenz
parents: 398
diff changeset
768
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
769 if kind is TEXT:
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
770 if noescape:
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
771 data = Markup(data)
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
772 push_text(data)
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
773 else:
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
774 if textbuf:
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
775 if len(textbuf) > 1:
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
776 text = mjoin(textbuf, escape_quotes=False)
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
777 del textbuf[:]
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
778 else:
136
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
779 text = escape(pop_text(), quotes=False)
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
780 if not preserve:
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
781 text = collapse_lines('\n', trim_trailing_space('', text))
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
782 yield TEXT, Markup(text), pos
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
783
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
784 if kind is START:
347
c0a4114786cc cspeedups branch: Merged [423:426/trunk].
cmlenz
parents: 305
diff changeset
785 tag, attrs = data
c0a4114786cc cspeedups branch: Merged [423:426/trunk].
cmlenz
parents: 305
diff changeset
786 if preserve or (tag in preserve_elems or
c0a4114786cc cspeedups branch: Merged [423:426/trunk].
cmlenz
parents: 305
diff changeset
787 attrs.get(space) == 'preserve'):
c0a4114786cc cspeedups branch: Merged [423:426/trunk].
cmlenz
parents: 305
diff changeset
788 preserve += 1
219
0f897d319002 Minor improvements to `WhitespaceFilter`.
cmlenz
parents: 213
diff changeset
789 if not noescape and tag in noescape_elems:
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
790 noescape = True
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
791
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
792 elif kind is END:
347
c0a4114786cc cspeedups branch: Merged [423:426/trunk].
cmlenz
parents: 305
diff changeset
793 noescape = False
c0a4114786cc cspeedups branch: Merged [423:426/trunk].
cmlenz
parents: 305
diff changeset
794 if preserve:
c0a4114786cc cspeedups branch: Merged [423:426/trunk].
cmlenz
parents: 305
diff changeset
795 preserve -= 1
141
b3ceaa35fb6b * No escaping of `<script>` or `<style>` tags in HTML output (see #24)
cmlenz
parents: 140
diff changeset
796
305
6e6950ac0e56 Various performance-oriented tweaks.
cmlenz
parents: 280
diff changeset
797 elif kind is START_CDATA:
143
ef761afcedff CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24.
cmlenz
parents: 141
diff changeset
798 noescape = True
ef761afcedff CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24.
cmlenz
parents: 141
diff changeset
799
305
6e6950ac0e56 Various performance-oriented tweaks.
cmlenz
parents: 280
diff changeset
800 elif kind is END_CDATA:
143
ef761afcedff CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24.
cmlenz
parents: 141
diff changeset
801 noescape = False
ef761afcedff CDATA sections in XML input now appear as CDATA sections in the output. This should address the problem with escaping the contents of `<style>` and `<script>` elements, which would only get interpreted correctly if the output was served as `application/xhtml+xml`. Closes #24.
cmlenz
parents: 141
diff changeset
802
136
636e0100fcaf Minor performance improvements in serialization.
cmlenz
parents: 123
diff changeset
803 if kind:
123
93bbdcf9428b Fix for #18: whitespace in space-sensitive elements such as `<pre>` and `<textarea>` is now preserved.
cmlenz
parents: 109
diff changeset
804 yield kind, data, pos
820
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
805
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
806
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
807 class DocTypeInserter(object):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
808 """A filter that inserts the DOCTYPE declaration in the correct location,
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
809 after the XML declaration.
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
810 """
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
811 def __init__(self, doctype):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
812 """Initialize the filter.
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
813
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
814 :param doctype: DOCTYPE as a string or DocType object.
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
815 """
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
816 if isinstance(doctype, basestring):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
817 doctype = DocType.get(doctype)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
818 self.doctype_event = (DOCTYPE, doctype, (None, -1, -1))
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
819
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
820 def __call__(self, stream):
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
821 doctype_inserted = False
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
822 for kind, data, pos in stream:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
823 if not doctype_inserted:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
824 doctype_inserted = True
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
825 if kind is XML_DECL:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
826 yield (kind, data, pos)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
827 yield self.doctype_event
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
828 continue
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
829 yield self.doctype_event
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
830
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
831 yield (kind, data, pos)
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
832
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
833 if not doctype_inserted:
1837f39efd6f Sync (old) experimental inline branch with trunk@1027.
cmlenz
parents: 500
diff changeset
834 yield self.doctype_event
Copyright (C) 2012-2017 Edgewall Software