- Notifications
You must be signed in to change notification settings - Fork 5.8k
/
Copy pathMinimalHTMLWriter.java
745 lines (663 loc) · 21.8 KB
/
MinimalHTMLWriter.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
/*
* Copyright (c) 1998, 2010, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
packagejavax.swing.text.html;
importjava.io.Writer;
importjava.io.IOException;
importjava.util.*;
importjava.awt.Color;
importjavax.swing.text.*;
/**
* MinimalHTMLWriter is a fallback writer used by the
* HTMLEditorKit to write out HTML for a document that
* is a not produced by the EditorKit.
*
* The format for the document is:
* <pre>
* <html>
* <head>
* <style>
* <!-- list of named styles
* p.normal {
* font-family: SansSerif;
* margin-height: 0;
* font-size: 14
* }
* -->
* </style>
* </head>
* <body>
* <p style=normal>
* <b>Bold, italic, and underline attributes
* of the run are emitted as HTML tags.
* The remaining attributes are emitted as
* part of the style attribute of a <span> tag.
* The syntax is similar to inline styles.</b>
* </p>
* </body>
* </html>
* </pre>
*
* @author Sunita Mani
*/
publicclassMinimalHTMLWriterextendsAbstractWriter {
/**
* These static finals are used to
* tweak and query the fontMask about which
* of these tags need to be generated or
* terminated.
*/
privatestaticfinalintBOLD = 0x01;
privatestaticfinalintITALIC = 0x02;
privatestaticfinalintUNDERLINE = 0x04;
// Used to map StyleConstants to CSS.
privatestaticfinalCSScss = newCSS();
privateintfontMask = 0;
intstartOffset = 0;
intendOffset = 0;
/**
* Stores the attributes of the previous run.
* Used to compare with the current run's
* attributeset. If identical, then a
* <span> tag is not emitted.
*/
privateAttributeSetfontAttributes;
/**
* Maps from style name as held by the Document, to the archived
* style name (style name written out). These may differ.
*/
privateHashtable<String, String> styleNameMapping;
/**
* Creates a new MinimalHTMLWriter.
*
* @param w Writer
* @param doc StyledDocument
*
*/
publicMinimalHTMLWriter(Writerw, StyledDocumentdoc) {
super(w, doc);
}
/**
* Creates a new MinimalHTMLWriter.
*
* @param w Writer
* @param doc StyledDocument
* @param pos The location in the document to fetch the
* content.
* @param len The amount to write out.
*
*/
publicMinimalHTMLWriter(Writerw, StyledDocumentdoc, intpos, intlen) {
super(w, doc, pos, len);
}
/**
* Generates HTML output
* from a StyledDocument.
*
* @throws IOException on any I/O error
* @throws BadLocationException if pos represents an invalid
* location within the document.
*
*/
publicvoidwrite() throwsIOException, BadLocationException {
styleNameMapping = newHashtable<String, String>();
writeStartTag("<html>");
writeHeader();
writeBody();
writeEndTag("</html>");
}
/**
* Writes out all the attributes for the
* following types:
* StyleConstants.ParagraphConstants,
* StyleConstants.CharacterConstants,
* StyleConstants.FontConstants,
* StyleConstants.ColorConstants.
* The attribute name and value are separated by a colon.
* Each pair is separated by a semicolon.
*
* @throws IOException on any I/O error
*/
protectedvoidwriteAttributes(AttributeSetattr) throwsIOException {
Enumeration<?> attributeNames = attr.getAttributeNames();
while (attributeNames.hasMoreElements()) {
Objectname = attributeNames.nextElement();
if ((nameinstanceofStyleConstants.ParagraphConstants) ||
(nameinstanceofStyleConstants.CharacterConstants) ||
(nameinstanceofStyleConstants.FontConstants) ||
(nameinstanceofStyleConstants.ColorConstants)) {
indent();
write(name.toString());
write(':');
write(css.styleConstantsValueToCSSValue
((StyleConstants)name, attr.getAttribute(name)).
toString());
write(';');
write(NEWLINE);
}
}
}
/**
* Writes out text.
*
* @throws IOException on any I/O error
*/
protectedvoidtext(Elementelem) throwsIOException, BadLocationException {
StringcontentStr = getText(elem);
if ((contentStr.length() > 0) &&
(contentStr.charAt(contentStr.length()-1) == NEWLINE)) {
contentStr = contentStr.substring(0, contentStr.length()-1);
}
if (contentStr.length() > 0) {
write(contentStr);
}
}
/**
* Writes out a start tag appropriately
* indented. Also increments the indent level.
*
* @param tag a start tag
* @throws IOException on any I/O error
*/
protectedvoidwriteStartTag(Stringtag) throwsIOException {
indent();
write(tag);
write(NEWLINE);
incrIndent();
}
/**
* Writes out an end tag appropriately
* indented. Also decrements the indent level.
*
* @param endTag an end tag
* @throws IOException on any I/O error
*/
protectedvoidwriteEndTag(StringendTag) throwsIOException {
decrIndent();
indent();
write(endTag);
write(NEWLINE);
}
/**
* Writes out the <head> and <style>
* tags, and then invokes writeStyles() to write
* out all the named styles as the content of the
* <style> tag. The content is surrounded by
* valid HTML comment markers to ensure that the
* document is viewable in applications/browsers
* that do not support the tag.
*
* @throws IOException on any I/O error
*/
protectedvoidwriteHeader() throwsIOException {
writeStartTag("<head>");
writeStartTag("<style>");
writeStartTag("<!--");
writeStyles();
writeEndTag("-->");
writeEndTag("</style>");
writeEndTag("</head>");
}
/**
* Writes out all the named styles as the
* content of the <style> tag.
*
* @throws IOException on any I/O error
*/
protectedvoidwriteStyles() throwsIOException {
/*
* Access to DefaultStyledDocument done to workaround
* a missing API in styled document to access the
* stylenames.
*/
DefaultStyledDocumentstyledDoc = ((DefaultStyledDocument)getDocument());
Enumeration<?> styleNames = styledDoc.getStyleNames();
while (styleNames.hasMoreElements()) {
Styles = styledDoc.getStyle((String)styleNames.nextElement());
/** PENDING: Once the name attribute is removed
from the list we check check for 0. **/
if (s.getAttributeCount() == 1 &&
s.isDefined(StyleConstants.NameAttribute)) {
continue;
}
indent();
write("p." + addStyleName(s.getName()));
write(" {\n");
incrIndent();
writeAttributes(s);
decrIndent();
indent();
write("}\n");
}
}
/**
* Iterates over the elements in the document
* and processes elements based on whether they are
* branch elements or leaf elements. This method specially handles
* leaf elements that are text.
*
* @throws IOException on any I/O error
* @throws BadLocationException if we are in an invalid
* location within the document.
*/
protectedvoidwriteBody() throwsIOException, BadLocationException {
ElementIteratorit = getElementIterator();
/*
This will be a section element for a styled document.
We represent this element in HTML as the body tags.
Therefore we ignore it.
*/
it.current();
Elementnext;
writeStartTag("<body>");
booleaninContent = false;
while((next = it.next()) != null) {
if (!inRange(next)) {
continue;
}
if (nextinstanceofAbstractDocument.BranchElement) {
if (inContent) {
writeEndParagraph();
inContent = false;
fontMask = 0;
}
writeStartParagraph(next);
} elseif (isText(next)) {
writeContent(next, !inContent);
inContent = true;
} else {
writeLeaf(next);
inContent = true;
}
}
if (inContent) {
writeEndParagraph();
}
writeEndTag("</body>");
}
/**
* Emits an end tag for a <p>
* tag. Before writing out the tag, this method ensures
* that all other tags that have been opened are
* appropriately closed off.
*
* @throws IOException on any I/O error
*/
protectedvoidwriteEndParagraph() throwsIOException {
writeEndMask(fontMask);
if (inFontTag()) {
endSpanTag();
} else {
write(NEWLINE);
}
writeEndTag("</p>");
}
/**
* Emits the start tag for a paragraph. If
* the paragraph has a named style associated with it,
* then this method also generates a class attribute for the
* <p> tag and sets its value to be the name of the
* style.
*
* @param elem an element
* @throws IOException on any I/O error
*/
protectedvoidwriteStartParagraph(Elementelem) throwsIOException {
AttributeSetattr = elem.getAttributes();
ObjectresolveAttr = attr.getAttribute(StyleConstants.ResolveAttribute);
if (resolveAttrinstanceofStyleContext.NamedStyle) {
writeStartTag("<p class=" + mapStyleName(((StyleContext.NamedStyle)resolveAttr).getName()) + ">");
} else {
writeStartTag("<p>");
}
}
/**
* Responsible for writing out other non-text leaf
* elements.
*
* @param elem an element
* @throws IOException on any I/O error
*/
protectedvoidwriteLeaf(Elementelem) throwsIOException {
indent();
if (elem.getName() == StyleConstants.IconElementName) {
writeImage(elem);
} elseif (elem.getName() == StyleConstants.ComponentElementName) {
writeComponent(elem);
}
}
/**
* Responsible for handling Icon Elements;
* deliberately unimplemented. How to implement this method is
* an issue of policy. For example, if you're generating
* an <img> tag, how should you
* represent the src attribute (the location of the image)?
* In certain cases it could be a URL, in others it could
* be read from a stream.
*
* @param elem an element of type StyleConstants.IconElementName
* @throws IOException if I/O error occurred.
*/
protectedvoidwriteImage(Elementelem) throwsIOException {
}
/**
* Responsible for handling Component Elements;
* deliberately unimplemented.
* How this method is implemented is a matter of policy.
*
* @param elem an element of type StyleConstants.ComponentElementName
* @throws IOException if I/O error occurred.
*/
protectedvoidwriteComponent(Elementelem) throwsIOException {
}
/**
* Returns true if the element is a text element.
*
* @param elem an element
* @return {@code true} if the element is a text element.
*/
protectedbooleanisText(Elementelem) {
return (elem.getName() == AbstractDocument.ContentElementName);
}
/**
* Writes out the attribute set
* in an HTML-compliant manner.
*
* @param elem an element
* @param needsIndenting indentation will be added if {@code needsIndenting} is {@code true}
* @throws IOException on any I/O error
* @throws BadLocationException if pos represents an invalid
* location within the document.
*/
protectedvoidwriteContent(Elementelem, booleanneedsIndenting)
throwsIOException, BadLocationException {
AttributeSetattr = elem.getAttributes();
writeNonHTMLAttributes(attr);
if (needsIndenting) {
indent();
}
writeHTMLTags(attr);
text(elem);
}
/**
* Generates
* bold <b>, italic <i>, and <u> tags for the
* text based on its attribute settings.
*
* @param attr a set of attributes
* @throws IOException on any I/O error
*/
protectedvoidwriteHTMLTags(AttributeSetattr) throwsIOException {
intoldMask = fontMask;
setFontMask(attr);
intendMask = 0;
intstartMask = 0;
if ((oldMask & BOLD) != 0) {
if ((fontMask & BOLD) == 0) {
endMask |= BOLD;
}
} elseif ((fontMask & BOLD) != 0) {
startMask |= BOLD;
}
if ((oldMask & ITALIC) != 0) {
if ((fontMask & ITALIC) == 0) {
endMask |= ITALIC;
}
} elseif ((fontMask & ITALIC) != 0) {
startMask |= ITALIC;
}
if ((oldMask & UNDERLINE) != 0) {
if ((fontMask & UNDERLINE) == 0) {
endMask |= UNDERLINE;
}
} elseif ((fontMask & UNDERLINE) != 0) {
startMask |= UNDERLINE;
}
writeEndMask(endMask);
writeStartMask(startMask);
}
/**
* Tweaks the appropriate bits of fontMask
* to reflect whether the text is to be displayed in
* bold, italic, and/or with an underline.
*
*/
privatevoidsetFontMask(AttributeSetattr) {
if (StyleConstants.isBold(attr)) {
fontMask |= BOLD;
}
if (StyleConstants.isItalic(attr)) {
fontMask |= ITALIC;
}
if (StyleConstants.isUnderline(attr)) {
fontMask |= UNDERLINE;
}
}
/**
* Writes out start tags <u>, <i>, and <b> based on
* the mask settings.
*
* @throws IOException on any I/O error
*/
privatevoidwriteStartMask(intmask) throwsIOException {
if (mask != 0) {
if ((mask & UNDERLINE) != 0) {
write("<u>");
}
if ((mask & ITALIC) != 0) {
write("<i>");
}
if ((mask & BOLD) != 0) {
write("<b>");
}
}
}
/**
* Writes out end tags for <u>, <i>, and <b> based on
* the mask settings.
*
* @throws IOException on any I/O error
*/
privatevoidwriteEndMask(intmask) throwsIOException {
if (mask != 0) {
if ((mask & BOLD) != 0) {
write("</b>");
}
if ((mask & ITALIC) != 0) {
write("</i>");
}
if ((mask & UNDERLINE) != 0) {
write("</u>");
}
}
}
/**
* Writes out the remaining
* character-level attributes (attributes other than bold,
* italic, and underline) in an HTML-compliant way. Given that
* attributes such as font family and font size have no direct
* mapping to HTML tags, a <span> tag is generated and its
* style attribute is set to contain the list of remaining
* attributes just like inline styles.
*
* @param attr a set of attributes
* @throws IOException on any I/O error
*/
protectedvoidwriteNonHTMLAttributes(AttributeSetattr) throwsIOException {
Stringstyle = "";
Stringseparator = "; ";
if (inFontTag() && fontAttributes.isEqual(attr)) {
return;
}
booleanfirst = true;
Colorcolor = (Color)attr.getAttribute(StyleConstants.Foreground);
if (color != null) {
style += "color: " + css.styleConstantsValueToCSSValue
((StyleConstants)StyleConstants.Foreground,
color);
first = false;
}
Integersize = (Integer)attr.getAttribute(StyleConstants.FontSize);
if (size != null) {
if (!first) {
style += separator;
}
style += "font-size: " + size.intValue() + "pt";
first = false;
}
Stringfamily = (String)attr.getAttribute(StyleConstants.FontFamily);
if (family != null) {
if (!first) {
style += separator;
}
style += "font-family: " + family;
first = false;
}
if (style.length() > 0) {
if (fontMask != 0) {
writeEndMask(fontMask);
fontMask = 0;
}
startSpanTag(style);
fontAttributes = attr;
}
elseif (fontAttributes != null) {
writeEndMask(fontMask);
fontMask = 0;
endSpanTag();
}
}
/**
* Returns true if we are currently in a <font> tag.
*
* @return {@code true} if we are currently in a <font> tag.
*/
protectedbooleaninFontTag() {
return (fontAttributes != null);
}
/**
* This is no longer used, instead <span> will be written out.
* <p>
* Writes out an end tag for the <font> tag.
*
* @throws IOException on any I/O error
*/
protectedvoidendFontTag() throwsIOException {
write(NEWLINE);
writeEndTag("</font>");
fontAttributes = null;
}
/**
* This is no longer used, instead <span> will be written out.
* <p>
* Writes out a start tag for the <font> tag.
* Because font tags cannot be nested,
* this method closes out
* any enclosing font tag before writing out a
* new start tag.
*
* @param style a font style
* @throws IOException on any I/O error
*/
protectedvoidstartFontTag(Stringstyle) throwsIOException {
booleancallIndent = false;
if (inFontTag()) {
endFontTag();
callIndent = true;
}
writeStartTag("<font style=\"" + style + "\">");
if (callIndent) {
indent();
}
}
/**
* Writes out a start tag for the <font> tag.
* Because font tags cannot be nested,
* this method closes out
* any enclosing font tag before writing out a
* new start tag.
*
* @throws IOException on any I/O error
*/
privatevoidstartSpanTag(Stringstyle) throwsIOException {
booleancallIndent = false;
if (inFontTag()) {
endSpanTag();
callIndent = true;
}
writeStartTag("<span style=\"" + style + "\">");
if (callIndent) {
indent();
}
}
/**
* Writes out an end tag for the <span> tag.
*
* @throws IOException on any I/O error
*/
privatevoidendSpanTag() throwsIOException {
write(NEWLINE);
writeEndTag("</span>");
fontAttributes = null;
}
/**
* Adds the style named <code>style</code> to the style mapping. This
* returns the name that should be used when outputting. CSS does not
* allow the full Unicode set to be used as a style name.
*/
privateStringaddStyleName(Stringstyle) {
if (styleNameMapping == null) {
returnstyle;
}
StringBuildersb = null;
for (intcounter = style.length() - 1; counter >= 0; counter--) {
if (!isValidCharacter(style.charAt(counter))) {
if (sb == null) {
sb = newStringBuilder(style);
}
sb.setCharAt(counter, 'a');
}
}
StringmappedName = (sb != null) ? sb.toString() : style;
while (styleNameMapping.get(mappedName) != null) {
mappedName = mappedName + 'x';
}
styleNameMapping.put(style, mappedName);
returnmappedName;
}
/**
* Returns the mapped style name corresponding to <code>style</code>.
*/
privateStringmapStyleName(Stringstyle) {
if (styleNameMapping == null) {
returnstyle;
}
StringretValue = styleNameMapping.get(style);
return (retValue == null) ? style : retValue;
}
privatebooleanisValidCharacter(charcharacter) {
return ((character >= 'a' && character <= 'z') ||
(character >= 'A' && character <= 'Z'));
}
}
