1/* 2 * Copyright (c) 2010, 2017, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26package jdk.javadoc.internal.doclets.formats.html.markup; 27 28import java.io.IOException; 29import java.io.Writer; 30 31import jdk.javadoc.internal.doclets.toolkit.Content; 32import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants; 33 34/** 35 * Class for generating raw HTML content to be added to HTML pages of javadoc output. 36 * 37 * <p><b>This is NOT part of any supported API. 38 * If you write code that depends on this, you do so at your own risk. 39 * This code and its internal interfaces are subject to change or 40 * deletion without notice.</b> 41 * 42 * @author Bhavesh Patel 43 */ 44public class RawHtml extends Content { 45 46 private final String rawHtmlContent; 47 48 public static final Content nbsp = new RawHtml(" "); 49 50 public static final Content zws = new RawHtml("​"); 51 52 /** 53 * Constructor to construct a RawHtml object. 54 * 55 * @param rawHtml raw HTML text to be added 56 */ 57 public RawHtml(CharSequence rawHtml) { 58 rawHtmlContent = rawHtml.toString(); 59 } 60 61 /** 62 * This method is not supported by the class. 63 * 64 * @param content content that needs to be added 65 * @throws UnsupportedOperationException always 66 */ 67 public void addContent(Content content) { 68 throw new UnsupportedOperationException(); 69 } 70 71 /** 72 * This method is not supported by the class. 73 * 74 * @param stringContent string content that needs to be added 75 * @throws UnsupportedOperationException always 76 */ 77 @Override 78 public void addContent(CharSequence stringContent) { 79 throw new UnsupportedOperationException(); 80 } 81 82 /** 83 * {@inheritDoc} 84 */ 85 public boolean isEmpty() { 86 return rawHtmlContent.isEmpty(); 87 } 88 89 /** 90 * {@inheritDoc} 91 */ 92 @Override 93 public String toString() { 94 return rawHtmlContent; 95 } 96 97 private enum State { TEXT, ENTITY, TAG, STRING } 98 99 @Override 100 public int charCount() { 101 return charCount(rawHtmlContent); 102 } 103 104 static int charCount(CharSequence htmlText) { 105 State state = State.TEXT; 106 int count = 0; 107 for (int i = 0; i < htmlText.length(); i++) { 108 char c = htmlText.charAt(i); 109 switch (state) { 110 case TEXT: 111 switch (c) { 112 case '<': 113 state = State.TAG; 114 break; 115 case '&': 116 state = State.ENTITY; 117 count++; 118 break; 119 default: 120 count++; 121 } 122 break; 123 124 case ENTITY: 125 if (!Character.isLetterOrDigit(c)) 126 state = State.TEXT; 127 break; 128 129 case TAG: 130 switch (c) { 131 case '"': 132 state = State.STRING; 133 break; 134 case '>': 135 state = State.TEXT; 136 break; 137 } 138 break; 139 140 case STRING: 141 switch (c) { 142 case '"': 143 state = State.TAG; 144 break; 145 } 146 } 147 } 148 return count; 149 } 150 151 /** 152 * {@inheritDoc} 153 */ 154 @Override 155 public boolean write(Writer out, boolean atNewline) throws IOException { 156 out.write(rawHtmlContent); 157 return rawHtmlContent.endsWith(DocletConstants.NL); 158 } 159} 160