org.apache.jasper.compiler.TextOptimizer Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jasper.compiler;
import org.apache.jasper.JasperException;
import org.apache.jasper.Options;
/**
*/
public class TextOptimizer {
/**
* A visitor to concatenate contiguous template texts.
*/
static class TextCatVisitor extends Node.Visitor {
private int textNodeCount = 0;
private Node.TemplateText firstTextNode = null;
private StringBuilder textBuffer;
private final String emptyText = new String("");
private boolean prePass;
private boolean trim;
public TextCatVisitor(boolean prePass, boolean trim){
this.prePass = prePass;
this.trim = trim;
}
public void doVisit(Node n) throws JasperException {
collectText();
}
/*
* The following directives are ignored in text concatenation
* except in the pre pass phase.
*/
public void visit(Node.PageDirective n) throws JasperException {
if (prePass) {
collectText();
}
}
public void visit(Node.TagDirective n) throws JasperException {
if (prePass) {
collectText();
}
}
public void visit(Node.TaglibDirective n) throws JasperException {
if (prePass) {
collectText();
}
}
public void visit(Node.AttributeDirective n) throws JasperException {
if (prePass) {
collectText();
}
}
public void visit(Node.VariableDirective n) throws JasperException {
if (prePass) {
collectText();
}
}
/*
* Don't concatenate text across body boundaries
*/
public void visitBody(Node n) throws JasperException {
super.visitBody(n);
collectText();
}
public void visit(Node.TemplateText n) throws JasperException {
if ((trim) && ! prePass && n.isAllSpace()) {
n.setText(emptyText);
return;
}
if (textNodeCount++ == 0) {
firstTextNode = n;
textBuffer = new StringBuilder(n.getText());
} else {
// Append text to text buffer
textBuffer.append(n.getText());
n.setText(emptyText);
}
}
/**
* This method breaks concatenation mode. As a side effect it copies
* the concatenated string to the first text node
*/
private void collectText() {
if (textNodeCount > 1) {
// Copy the text in buffer into the first template text node.
firstTextNode.setText(textBuffer.toString());
}
textNodeCount = 0;
}
}
public static void concatenate(Compiler compiler, Node.Nodes page)
throws JasperException {
Options options = compiler.getCompilationContext().getOptions();
PageInfo pageInfo = compiler.getPageInfo();
boolean trim =
options.getTrimSpaces() || pageInfo.isTrimDirectiveWhitespaces();
if (trim) {
TextCatVisitor v = new TextCatVisitor(true, trim);
page.visit(v);
v.collectText();
}
TextCatVisitor v = new TextCatVisitor(false, trim);
page.visit(v);
// Cleanup, in case the page ends with a template text
v.collectText();
}
}