/*
* Copyright (c) 2003, 2019, 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.
*/
package jdk.javadoc.internal.doclets.formats.html.markup;
import java.io.IOException;
import java.io.Writer;
import jdk.javadoc.internal.doclets.toolkit.Content;
import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;
A builder for HTML script elements.
This is NOT part of any supported API.
If you write code that depends on this, you do so at your own risk.
This code and its internal interfaces are subject to change or
deletion without notice.
/**
* A builder for HTML script elements.
*
* <p><b>This is NOT part of any supported API.
* If you write code that depends on this, you do so at your own risk.
* This code and its internal interfaces are subject to change or
* deletion without notice.</b>
*/
public class Script {
private final StringBuilder sb;
Creates an empty script.
/**
* Creates an empty script.
*/
public Script() {
sb = new StringBuilder();
}
Creates a new script containing the specified code.
Params: - code – the code
/**
* Creates a new script containing the specified code.
*
* @param code the code
*/
public Script(String code) {
this();
append(code);
}
Appends the given code to the script.
Params: - code – the code
Returns: this object
/**
* Appends the given code to the script.
*
* @param code the code
* @return this object
*/
public Script append(CharSequence code) {
sb.append(code);
return this;
}
Appends the given text as a string constant to the string.
Characters within the string will be escaped as needed.
Params: - text – the text
Returns: this object
/**
* Appends the given text as a string constant to the string.
* Characters within the string will be escaped as needed.
*
* @param text the text
* @return this object
*/
public Script appendStringLiteral(CharSequence text) {
sb.append(stringLiteral(text, '"'));
return this;
}
Appends the given text as a string constant to the string.
Characters within the string will be escaped as needed.
Params: - text – the text
- quoteChar – the quote character to use
Returns: this object
/**
* Appends the given text as a string constant to the string.
* Characters within the string will be escaped as needed.
*
* @param text the text
* @param quoteChar the quote character to use
* @return this object
*/
// The ability to specify the quote character is for backwards
// compatibility. Ideally, we should simplify the code so that
// the same quote character is always used.
public Script appendStringLiteral(CharSequence text, char quoteChar) {
sb.append(stringLiteral(text, quoteChar));
return this;
}
Returns a "live" view of the script as a Content object. Any later modifications to the script will be reflected in the object that is returned. Returns: the script, as a Content object.
/**
* Returns a "live" view of the script as a {@code Content} object.
* Any later modifications to the script will be reflected in the
* object that is returned.
* @return the script, as a {@code Content} object.
*/
public Content asContent() {
ScriptContent scriptContent = new ScriptContent(sb);
HtmlTree tree = new HtmlTree(TagName.SCRIPT) {
@Override
public HtmlTree add(Content c) {
if (c != scriptContent) {
throw new IllegalArgumentException();
}
return super.add(scriptContent);
}
};
tree.put(HtmlAttr.TYPE, "text/javascript");
tree.add(scriptContent);
return tree;
}
Returns a JavaScript string literal containing a specified string,
escaping the characters of that string as needed.
Params: - s – the string
Returns: a string literal containing the string
/**
* Returns a JavaScript string literal containing a specified string,
* escaping the characters of that string as needed.
*
* @param s the string
* @return a string literal containing the string
*/
public static String stringLiteral(CharSequence s) {
return stringLiteral(s, '"');
}
Returns a JavaScript string literal containing a specified string,
escaping the characters of that string as needed.
Params: - s – the string
- quoteChar – the quote character to use for the literal
Returns: a string literal containing the string
/**
* Returns a JavaScript string literal containing a specified string,
* escaping the characters of that string as needed.
*
* @param s the string
* @param quoteChar the quote character to use for the literal
* @return a string literal containing the string
*/
// The ability to specify the quote character is for backwards
// compatibility. Ideally, we should simplify the code so that
// the same quote character is always used.
public static String stringLiteral(CharSequence s, char quoteChar) {
if (quoteChar != '"' && quoteChar != '\'') {
throw new IllegalArgumentException();
}
StringBuilder sb = new StringBuilder();
sb.append(quoteChar);
for (int i = 0; i < s.length(); i++) {
char ch = s.charAt(i);
switch (ch) {
case '\b':
sb.append("\\b");
break;
case '\t':
sb.append("\\t");
break;
case '\n':
sb.append("\\n");
break;
case '\f':
sb.append("\\f");
break;
case '\r':
sb.append("\\r");
break;
case '"':
sb.append("\\\"");
break;
case '\'':
sb.append("\\\'");
break;
case '\\':
sb.append("\\\\");
break;
default:
if (ch < 32 || ch >= 127) {
sb.append(String.format("\\u%04X", (int)ch));
} else {
sb.append(ch);
}
break;
}
}
sb.append(quoteChar);
return sb.toString();
}
private static class ScriptContent extends Content {
private final StringBuilder sb;
ScriptContent(StringBuilder sb) {
this.sb = sb;
}
@Override
public ScriptContent add(CharSequence code) {
sb.append(code);
return this;
}
@Override
public boolean write(Writer writer, boolean atNewline) throws IOException {
String s = sb.toString();
writer.write(s.replace("\n", DocletConstants.NL));
return s.endsWith("\n");
}
@Override
public boolean isEmpty() {
return false;
}
}
}