1 /*
   2  * Copyright (c) 2010, 2019, 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 
  26 package jdk.javadoc.internal.doclets.formats.html.markup;
  27 
  28 import java.io.IOException;
  29 import java.io.Writer;
  30 
  31 import jdk.javadoc.internal.doclets.toolkit.Content;
  32 import 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  */
  44 public class RawHtml extends Content {
  45 
  46     private final String rawHtmlContent;
  47 
  48     /**
  49      * Constructor to construct a RawHtml object.
  50      *
  51      * @param rawHtml raw HTML text to be added
  52      */
  53     public RawHtml(CharSequence rawHtml) {
  54         rawHtmlContent = rawHtml.toString();
  55     }
  56 
  57     /**
  58      * This method is not supported by the class.
  59      *
  60      * @param content content that needs to be added
  61      * @throws UnsupportedOperationException always
  62      */
  63     public void add(Content content) {
  64         throw new UnsupportedOperationException();
  65     }
  66 
  67     /**
  68      * This method is not supported by the class.
  69      *
  70      * @param stringContent string content that needs to be added
  71      * @throws UnsupportedOperationException always
  72      */
  73     @Override
  74     public void add(CharSequence stringContent) {
  75         throw new UnsupportedOperationException();
  76     }
  77 
  78     /**
  79      * {@inheritDoc}
  80      */
  81     public boolean isEmpty() {
  82         return rawHtmlContent.isEmpty();
  83     }
  84 
  85     /**
  86      * {@inheritDoc}
  87      */
  88     @Override
  89     public String toString() {
  90         return rawHtmlContent;
  91     }
  92 
  93     private enum State { TEXT, ENTITY, TAG, STRING }
  94 
  95     @Override
  96     public int charCount() {
  97         return charCount(rawHtmlContent);
  98     }
  99 
 100     static int charCount(CharSequence htmlText) {
 101         State state = State.TEXT;
 102         int count = 0;
 103         for (int i = 0; i < htmlText.length(); i++) {
 104             char c = htmlText.charAt(i);
 105             switch (state) {
 106                 case TEXT:
 107                     switch (c) {
 108                         case '<':
 109                             state = State.TAG;
 110                             break;
 111                         case '&':
 112                             state = State.ENTITY;
 113                             count++;
 114                             break;
 115                         case '\r':
 116                         case '\n':
 117                             // Windows uses "\r\n" as line separator while UNIX uses "\n".
 118                             // Ignore line separators to get consistent results across platforms.
 119                             break;
 120                         default:
 121                             count++;
 122                     }
 123                     break;
 124 
 125                 case ENTITY:
 126                     if (!Character.isLetterOrDigit(c))
 127                         state = State.TEXT;
 128                     break;
 129 
 130                 case TAG:
 131                     switch (c) {
 132                         case '"':
 133                             state = State.STRING;
 134                             break;
 135                         case '>':
 136                             state = State.TEXT;
 137                             break;
 138                     }
 139                     break;
 140 
 141                 case STRING:
 142                     switch (c) {
 143                         case '"':
 144                             state = State.TAG;
 145                             break;
 146                     }
 147             }
 148         }
 149         return count;
 150     }
 151 
 152     /**
 153      * {@inheritDoc}
 154      */
 155     @Override
 156     public boolean write(Writer out, boolean atNewline) throws IOException {
 157         out.write(rawHtmlContent);
 158         return rawHtmlContent.endsWith(DocletConstants.NL);
 159     }
 160 }