bundles/org.eclipse.jst.jsp.core/src/org/eclipse/jst/jsp/core/internal/java/XMLJSPRegionHelper.java - sourceediting/webtools.sourceediting - Git at Google

 /*******************************************************************************
  * Copyright (c) 2004 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  *     IBM Corporation - initial API and implementation
  *******************************************************************************/
 package org.eclipse.jst.jsp.core.internal.java;

 import java.io.InputStream;
 import java.util.Iterator;
 import java.util.List;

 import org.eclipse.core.resources.IFile;
 import org.eclipse.core.resources.ResourcesPlugin;
 import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.Path;
 import org.eclipse.jst.jsp.core.internal.Logger;
 import org.eclipse.jst.jsp.core.internal.parser.JSPSourceParser;
 import org.eclipse.jst.jsp.core.internal.provisional.JSP11Namespace;
 import org.eclipse.jst.jsp.core.internal.regions.DOMJSPRegionContexts;
 import org.eclipse.wst.sse.core.internal.ltk.parser.BlockMarker;
 import org.eclipse.wst.sse.core.internal.ltk.parser.StructuredDocumentRegionHandler;
 import org.eclipse.wst.sse.core.internal.provisional.text.IStructuredDocumentRegion;
 import org.eclipse.wst.sse.core.internal.provisional.text.ITextRegion;
 import org.eclipse.wst.sse.core.internal.provisional.text.ITextRegionCollection;
 import org.eclipse.wst.sse.core.internal.provisional.text.ITextRegionList;
 import org.eclipse.wst.sse.core.internal.util.Debug;
 import org.eclipse.wst.sse.core.utils.StringUtils;
 import org.eclipse.wst.xml.core.internal.contentmodel.CMDocument;
 import org.eclipse.wst.xml.core.internal.contentmodel.CMNode;
 import org.eclipse.wst.xml.core.internal.regions.DOMRegionContext;


 /**
  * Parser/helper class for JSPTranslator.  Used for parsing XML-JSP regions (in a script block)
  * A lot of logic borrowed from TLDCMDocumentManager.  There should be only one XMLJSPRegionHelper per text file
  *
  * @author pavery
  */
 class XMLJSPRegionHelper implements StructuredDocumentRegionHandler {
 	private final JSPTranslator fTranslator;
 	protected JSPSourceParser fLocalParser = null;
 	protected String fTextToParse = null;
 	// need this if not at the start of the document (eg. parsing just a script block)
 	protected int fStartOfTextToParse = 0;
 	// name of the open tag that was last handled (if we are interested in it)
 	protected String fTagname = null;
 	protected String fTextBefore = ""; //$NON-NLS-1$
 	protected String fUnescapedText = ""; //$NON-NLS-1$
 	protected String fStrippedText = ""; //$NON-NLS-1$
 	// for reconciling cursor position later
 	int fPossibleOwner = JSPTranslator.SCRIPTLET;

 	public XMLJSPRegionHelper(JSPTranslator translator) {
 		getLocalParser().addStructuredDocumentRegionHandler(this);
 		this.fTranslator = translator;
 	}

 	protected JSPSourceParser getLocalParser() {
 		if (fLocalParser == null)
 			fLocalParser = new JSPSourceParser();
 		return fLocalParser;
 	}

 	public void addBlockMarker(BlockMarker marker) {
 		fLocalParser.addBlockMarker(marker);
 	}

 	public void reset(String textToParse) {
 		reset(textToParse, 0);
 	}

 	public void reset(String textToParse, int start) {
 		fStartOfTextToParse = start;
 		getLocalParser().reset(textToParse);
 		fTextToParse = textToParse;
 	}

 	public void forceParse() {
 		getLocalParser().getDocumentRegions();
 		fLocalParser = null;
 	}

 	/*
 	 * parse an entire file
 	 */
 	public void parse(String filename) {
 		// from outer class
 		List blockMarkers = this.fTranslator.getBlockMarkers();
 		reset(getContents(filename));
 		// this adds the current markers from the outer class list
 		// to this parser so parsing works correctly
 		for (int i = 0; i < blockMarkers.size(); i++) {
 			addBlockMarker((BlockMarker) blockMarkers.get(i));
 		}
 		forceParse();
 	}


 	/*
 	 * listens to parser node parsed events
 	 * adds to local scriplet, expression, declaration buffers
 	 * determines which type of region the cursor is in, and adjusts cursor offset accordingly
 	 */
 	public void nodeParsed(IStructuredDocumentRegion sdRegion) {

 		try {

 			handleScopingIfNecessary(sdRegion);

 			if (isJSPStartRegion(sdRegion)) {
 				String nameStr = getRegionName(sdRegion);
 				if (isJSPRegion(nameStr))
 					fTagname = nameStr;
 				else
 					fTagname = null;


 				// this section assumes important content (to translate)
 				// IS the opening tag

 				// handle include and directive
 				if(fTagname != null && sdRegion.getFirstRegion().getType() == DOMJSPRegionContexts.JSP_DIRECTIVE_OPEN) {
 					processOtherRegions(sdRegion);
 				}
 				// handle jsp:useBean
 				if(fTagname != null && fTagname.equals(JSP11Namespace.ElementName.USEBEAN)) {
 					processUseBean(sdRegion);
 				}
 			}
 			else if (sdRegion.getFirstRegion().getType() == DOMJSPRegionContexts.JSP_CONTENT || sdRegion.getFirstRegion().getType() == DOMRegionContext.XML_CONTENT) {
 				// this section assumes important content (to translate)
 				// is AFTER the opening tag
 				if (fTagname != null) {
 					// assign contents to one of the tables
 					if (isScriptlet(fTagname)) {
 						processScriptlet(sdRegion);
 					}
 					else if (isExpression(fTagname)) {
 						processExpression(sdRegion);
 					}
 					else if (isDeclaration(fTagname)) {
 						processDeclaration(sdRegion);
 					}
 				}
 			}
 			else {
 				fTagname = null;
 			}
 			// this updates cursor position
 			checkCursorInRegion(sdRegion);
 		}
 		catch (NullPointerException e) {
 			// logging this exception that I've seen a couple of times...
 			// seems to happen during shutdown of unit tests, at which
 			// point Logger has already been unloaded
 			try {
 			Logger.logException("XMLJSPRegionHelper: exception in node parsing", e); //$NON-NLS-1$
 			}
 			catch (NoClassDefFoundError ex) {
 				// do nothing, since we're just ending
 			}
 		}
 	}

 	private void handleScopingIfNecessary(IStructuredDocumentRegion sdRegion) {

 		// fix to make sure custom tag block have their own scope
 		// we add '{' for custom tag open and '}' for custom tag close
 		// in the translation
 		if(sdRegion.getFirstRegion().getType() == DOMRegionContext.XML_TAG_OPEN) {
 			if(!isSelfClosingTag(sdRegion)) {
 				String nameStr = getRegionName(sdRegion);
 				if(isPossibleCustomTag(nameStr)) {
 					startScope(nameStr);
 				}
 			}
 		}
 		else if(sdRegion.getFirstRegion().getType() == DOMRegionContext.XML_END_TAG_OPEN) {
 			String nameStr = getRegionName(sdRegion);
 			if(isPossibleCustomTag(nameStr)) {
 				endScope(nameStr);
 			}
 		}
 	}

 	private boolean isSelfClosingTag(ITextRegionCollection containerRegion) {

 		if(containerRegion == null)
 			return false;

 		ITextRegionList regions = containerRegion.getRegions();
 		ITextRegion r = regions.get(regions.size()-1);
 		return r.getType() == DOMRegionContext.XML_EMPTY_TAG_CLOSE;
 	}

 	private void startScope(String tagName) {
 		IStructuredDocumentRegion currentNode = fTranslator.getCurrentNode();
 		StringBuffer text = new StringBuffer();
 		text.append("{ // <"); //$NON-NLS-1$
 		text.append(tagName);
 		text.append(">\n"); //$NON-NLS-1$
 		this.fTranslator.translateScriptletString(text.toString(), currentNode, currentNode.getStartOffset(), currentNode.getLength()); //$NON-NLS-1$

 	}

 	private void endScope(String tagName) {
 		IStructuredDocumentRegion currentNode = fTranslator.getCurrentNode();
 		StringBuffer text = new StringBuffer();
 		text.append("} // </"); //$NON-NLS-1$
 		text.append(tagName);
 		text.append(">\n"); //$NON-NLS-1$
 		this.fTranslator.translateScriptletString(text.toString(), currentNode, currentNode.getStartOffset(), currentNode.getLength()); //$NON-NLS-1$

 	}

 	public void resetNodes() {
 		// do nothing
 	}

 	private void checkCursorInRegion(IStructuredDocumentRegion sdRegion) {
 		// if cursor is in this region...
 		if (this.fTranslator.getSourcePosition() >= fStartOfTextToParse + sdRegion.getStartOffset() && this.fTranslator.getSourcePosition() <= fStartOfTextToParse + sdRegion.getEndOffset()) {
 			int endOfNameTag = sdRegion.getStartOffset();
 			int offset = fTextBefore.length() - fStrippedText.length();
 			// offset in addtion to what's already in the buffer
 			this.fTranslator.setRelativeOffset(this.fTranslator.getSourcePosition() - (fStartOfTextToParse + endOfNameTag) - offset);
 			// outer class method
 			this.fTranslator.setCursorOwner(fPossibleOwner);
 			// add length of what's already in the buffer
 			this.fTranslator.setRelativeOffset(this.fTranslator.getRelativeOffset() + this.fTranslator.getCursorOwner().length());
 			if (fPossibleOwner == JSPTranslator.EXPRESSION) {
 				// add length of expression prefix if necessary...
 				this.fTranslator.setRelativeOffset(this.fTranslator.getRelativeOffset() + JSPTranslator.EXPRESSION_PREFIX.length());
 			}
 		}
 	}

 	protected void processDeclaration(IStructuredDocumentRegion sdRegion) {
 		prepareText(sdRegion);
 		IStructuredDocumentRegion currentNode = fTranslator.getCurrentNode();
 		this.fTranslator.translateDeclarationString(fStrippedText, currentNode, currentNode.getStartOffset(), currentNode.getLength());
 		fPossibleOwner = JSPTranslator.DECLARATION;
 	}

 	protected void processExpression(IStructuredDocumentRegion sdRegion) {
 		prepareText(sdRegion);
 		IStructuredDocumentRegion currentNode = fTranslator.getCurrentNode();
 		this.fTranslator.translateExpressionString(fStrippedText, currentNode, currentNode.getStartOffset(), currentNode.getLength());
 		fPossibleOwner = JSPTranslator.EXPRESSION;
 	}

 	protected void processScriptlet(IStructuredDocumentRegion sdRegion) {
 		prepareText(sdRegion);
 		IStructuredDocumentRegion currentNode = fTranslator.getCurrentNode();
 		this.fTranslator.translateScriptletString(fStrippedText, currentNode, currentNode.getStartOffset(), currentNode.getLength());
 		fPossibleOwner = JSPTranslator.SCRIPTLET;
 	}

 	/*
 	 * Substitutes values for entity references, strips CDATA tags, and keeps
 	 * track of string length(s) for cursor position calculation later.
 	 * @param sdRegion
 	 */
 	protected void prepareText(IStructuredDocumentRegion sdRegion) {
 		fTextBefore = fTextToParse.substring(sdRegion.getStartOffset(), sdRegion.getEndOffset());
 		fUnescapedText = EscapedTextUtil.getUnescapedText(fTextBefore);
 		fStrippedText = this.fTranslator.stripCDATA(fUnescapedText);
 	}

 	protected void processUseBean(IStructuredDocumentRegion sdRegion) {
 		if (fTagname != null && isUseBean(fTagname)) {

 			String beanClass, beanType, beanId, beanDecl = ""; //$NON-NLS-1$
 			beanClass = getAttributeValue("class", sdRegion); //$NON-NLS-1$
 			beanType = getAttributeValue("type", sdRegion); //$NON-NLS-1$
 			beanId = getAttributeValue("id", sdRegion); //$NON-NLS-1$

 			if (beanId != null && (beanType != null || beanClass != null)) {
 				if (beanType.equals("")) //$NON-NLS-1$
 				    beanType = beanClass;
 				String prefix = beanType + " " + beanId + " = "; //$NON-NLS-1$ //$NON-NLS-2$
 				String suffix = "null;\n"; //$NON-NLS-1$
 				if (beanClass != null)
 					suffix = "new " + beanClass + "();\n"; //$NON-NLS-1$ //$NON-NLS-2$
 				beanDecl = prefix + suffix;
 			}

 			IStructuredDocumentRegion currentNode = fTranslator.getCurrentNode();
 			this.fTranslator.translateScriptletString(beanDecl, currentNode, currentNode.getStartOffset(), currentNode.getLength());
 			fPossibleOwner = JSPTranslator.SCRIPTLET;
 		}
 	}

 	protected void processOtherRegions(IStructuredDocumentRegion sdRegion) {
 		processIncludeDirective(sdRegion);
 		processPageDirective(sdRegion);
 	}

 	protected void processIncludeDirective(IStructuredDocumentRegion sdRegion) {
 		if (isIncludeDirective(fTagname)) {
 			// the directive name region itself contains the attrs...
 			if (sdRegion.getRegions().get(0).getType() == DOMRegionContext.XML_CONTENT)
 				sdRegion = sdRegion.getPrevious();
 			String fileLocation = getAttributeValue("file", sdRegion); //$NON-NLS-1$
 			this.fTranslator.handleIncludeFile(fileLocation);
 		}
 		else if (isPossibleCustomTag(fTagname)) {
 			// this custom tag may define variables
 			this.fTranslator.addTaglibVariables(fTagname);
 		}
 		else if (isTaglibDirective(fTagname)) {
 			// also add the ones created here to the parent document
 			String prefix = getAttributeValue("prefix", sdRegion); //$NON-NLS-1$
 			List docs = this.fTranslator.getTLDCMDocumentManager().getCMDocumentTrackers(prefix, this.fTranslator.getCurrentNode().getEnd());
 			Iterator it = docs.iterator();
 			Iterator elements = null;
 			CMNode node = null;
 			CMDocument doc = null;
 			BlockMarker marker = null;
 			while (it.hasNext()) {
 				doc = (CMDocument) it.next();
 				elements = doc.getElements().iterator();
 				while (elements.hasNext()) {
 					node = (CMNode) elements.next();
 					marker = new BlockMarker(node.getNodeName(), null, DOMJSPRegionContexts.JSP_CONTENT, true);
 					// global scope is OK because we have encountered this <@taglib> directive
 					// so it all markers from it should will be in scope
 					// add to this local parser
 					addBlockMarker(marker);
 					// add to outer class marker list, for
 					this.fTranslator.getBlockMarkers().add(marker);
 				}
 			}
 		}
 	}

 	protected void processPageDirective(IStructuredDocumentRegion sdRegion) {
 		if (isPageDirective(fTagname)) {
 			while (sdRegion != null) {
 				if (sdRegion.getType() == DOMJSPRegionContexts.JSP_DIRECTIVE_NAME)
 					break;
 				sdRegion = sdRegion.getPrevious();
 			}
 			String importValue = getAttributeValue("import", sdRegion); //$NON-NLS-1$
 			if (importValue != "") { //$NON-NLS-1$
 				// had to add "false" parameter to ensure these
 				// imports don't get added to jsp <-> java map (since they are from an included file)
 				// https://bugs.eclipse.org/bugs/show_bug.cgi?id=81687
 				this.fTranslator.addImports(importValue, false);
 			}
 		}
 	}

 	/*
 	 * convenience method to get an attribute value from attribute name
 	 */
 	protected String getAttributeValue(String attrName, IStructuredDocumentRegion sdRegion) {
 		String sdRegionText = fTextToParse.substring(sdRegion.getStartOffset(), sdRegion.getEndOffset());
 		String textRegionText, attrValue = ""; //$NON-NLS-1$
 		Iterator it = sdRegion.getRegions().iterator();
 		ITextRegion nameRegion, valueRegion = null;
 		while (it.hasNext()) {
 			nameRegion = (ITextRegion) it.next();
 			if (nameRegion.getType() == DOMRegionContext.XML_TAG_ATTRIBUTE_NAME) {
 				textRegionText = sdRegionText.substring(nameRegion.getStart(), nameRegion.getTextEnd());
 				if (textRegionText.equalsIgnoreCase(attrName)) {
 					while (it.hasNext()) {
 						valueRegion = (ITextRegion) it.next();
 						if (valueRegion.getType() == DOMRegionContext.XML_TAG_ATTRIBUTE_VALUE) {
 							attrValue = sdRegionText.substring(valueRegion.getStart(), valueRegion.getEnd());
 							break; // inner
 						}
 					}
 					break; // outer
 				}
 			}
 		}
 		return StringUtils.stripQuotes(attrValue);
 	}

 	// these methods determine what content gets added to the local scriplet, expression, declaration buffers
 	/*
 	 * return true for elements whose contents we might want to add to the java file we are building
 	 */
 	protected boolean isJSPStartRegion(IStructuredDocumentRegion sdRegion) {
 		return (sdRegion.getFirstRegion().getType() == DOMRegionContext.XML_TAG_OPEN || sdRegion.getFirstRegion().getType() == DOMJSPRegionContexts.JSP_DIRECTIVE_OPEN);
 	}

 	protected boolean isJSPRegion(String tagName) {
 		return isDeclaration(tagName) || isExpression(tagName) || isScriptlet(tagName) || isUseBean(tagName) || isIncludeDirective(tagName) || isPossibleCustomTag(tagName) || isTaglibDirective(tagName) || isPageDirective(tagName);
 	}

 	protected boolean isDeclaration(String tagName) {
 		return tagName.equalsIgnoreCase("jsp:declaration"); //$NON-NLS-1$
 	}

 	protected boolean isExpression(String tagName) {
 		return tagName.equalsIgnoreCase("jsp:expression"); //$NON-NLS-1$
 	}

 	protected boolean isScriptlet(String tagName) {
 		return tagName.equalsIgnoreCase("jsp:scriptlet"); //$NON-NLS-1$
 	}

 	protected boolean isUseBean(String tagName) {
 		return tagName.equalsIgnoreCase("jsp:useBean"); //$NON-NLS-1$
 	}

 	protected boolean isIncludeDirective(String tagName) {
 		return tagName.equalsIgnoreCase("jsp:directive.include"); //$NON-NLS-1$
 	}

 	protected boolean isPossibleCustomTag(String tagName) {
 		return tagName.indexOf(":") > 0 && !tagName.startsWith("jsp"); //$NON-NLS-1$  //$NON-NLS-2$
 	}

 	protected boolean isTaglibDirective(String tagName) {
 		return tagName.equalsIgnoreCase("jsp:directive.taglib"); //$NON-NLS-1$
 	}

 	protected boolean isPageDirective(String tagName) {
 		return tagName.equalsIgnoreCase("jsp:directive.page"); //$NON-NLS-1$
 	}

 	protected String getRegionName(IStructuredDocumentRegion sdRegion) {

 		String nameStr = ""; //$NON-NLS-1$
 		ITextRegionList regions = sdRegion.getRegions();
 		for(int i=0; i<regions.size(); i++) {
 			ITextRegion r = regions.get(i);
 			if(r.getType() == DOMRegionContext.XML_TAG_NAME) {
 				nameStr = fTextToParse.substring(sdRegion.getStartOffset(r), sdRegion.getTextEndOffset(r));
 				break;
 			}
 		}
 		return nameStr.trim();
 	}

 	/*
 	 * get the contents of a file as a String
 	 */
 	protected String getContents(String fileName) {
 		StringBuffer s = new StringBuffer();
 		int c = 0;
 		int count = 0;
 		InputStream is = null;
 		try {
 			IPath filePath = new Path(fileName);
 			IFile f = ResourcesPlugin.getWorkspace().getRoot().getFile(filePath);
 			if(f != null && !f.exists()) {
 				f = ResourcesPlugin.getWorkspace().getRoot().getFileForLocation(filePath);
 			}
             if (f != null && f.exists()) {
     			is = f.getContents();
     			while ((c = is.read()) != -1) {
     				count++;
     				s.append((char) c);
     			}
             }
 		}
 		catch (Exception e) {
 			if (Debug.debugStructuredDocument)
 				e.printStackTrace();
 		}
 		finally {
 			try {
 				if (is != null) {
 					is.close();
 				}
 			}
 			catch (Exception e) {
 				// nothing to do
 			}
 		}
 		return s.toString();
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2004 IBM Corporation and others.
	* All rights reserved. This program and the accompanying materials
	* are made available under the terms of the Eclipse Public License v1.0
	* which accompanies this distribution, and is available at
	* http://www.eclipse.org/legal/epl-v10.html
	*
	* Contributors:
	* IBM Corporation - initial API and implementation
	*******************************************************************************/
	package org.eclipse.jst.jsp.core.internal.java;

	import java.io.InputStream;
	import java.util.Iterator;
	import java.util.List;

	import org.eclipse.core.resources.IFile;
	import org.eclipse.core.resources.ResourcesPlugin;
	import org.eclipse.core.runtime.IPath;
	import org.eclipse.core.runtime.Path;
	import org.eclipse.jst.jsp.core.internal.Logger;
	import org.eclipse.jst.jsp.core.internal.parser.JSPSourceParser;
	import org.eclipse.jst.jsp.core.internal.provisional.JSP11Namespace;
	import org.eclipse.jst.jsp.core.internal.regions.DOMJSPRegionContexts;
	import org.eclipse.wst.sse.core.internal.ltk.parser.BlockMarker;
	import org.eclipse.wst.sse.core.internal.ltk.parser.StructuredDocumentRegionHandler;
	import org.eclipse.wst.sse.core.internal.provisional.text.IStructuredDocumentRegion;
	import org.eclipse.wst.sse.core.internal.provisional.text.ITextRegion;
	import org.eclipse.wst.sse.core.internal.provisional.text.ITextRegionCollection;
	import org.eclipse.wst.sse.core.internal.provisional.text.ITextRegionList;
	import org.eclipse.wst.sse.core.internal.util.Debug;
	import org.eclipse.wst.sse.core.utils.StringUtils;
	import org.eclipse.wst.xml.core.internal.contentmodel.CMDocument;
	import org.eclipse.wst.xml.core.internal.contentmodel.CMNode;
	import org.eclipse.wst.xml.core.internal.regions.DOMRegionContext;


	/**
	* Parser/helper class for JSPTranslator. Used for parsing XML-JSP regions (in a script block)
	* A lot of logic borrowed from TLDCMDocumentManager. There should be only one XMLJSPRegionHelper per text file
	*
	* @author pavery
	*/
	class XMLJSPRegionHelper implements StructuredDocumentRegionHandler {
	private final JSPTranslator fTranslator;
	protected JSPSourceParser fLocalParser = null;
	protected String fTextToParse = null;
	// need this if not at the start of the document (eg. parsing just a script block)
	protected int fStartOfTextToParse = 0;
	// name of the open tag that was last handled (if we are interested in it)
	protected String fTagname = null;
	protected String fTextBefore = ""; //$NON-NLS-1$
	protected String fUnescapedText = ""; //$NON-NLS-1$
	protected String fStrippedText = ""; //$NON-NLS-1$
	// for reconciling cursor position later
	int fPossibleOwner = JSPTranslator.SCRIPTLET;

	public XMLJSPRegionHelper(JSPTranslator translator) {
	getLocalParser().addStructuredDocumentRegionHandler(this);
	this.fTranslator = translator;
	}

	protected JSPSourceParser getLocalParser() {
	if (fLocalParser == null)
	fLocalParser = new JSPSourceParser();
	return fLocalParser;
	}

	public void addBlockMarker(BlockMarker marker) {
	fLocalParser.addBlockMarker(marker);
	}

	public void reset(String textToParse) {
	reset(textToParse, 0);
	}

	public void reset(String textToParse, int start) {
	fStartOfTextToParse = start;
	getLocalParser().reset(textToParse);
	fTextToParse = textToParse;
	}

	public void forceParse() {
	getLocalParser().getDocumentRegions();
	fLocalParser = null;
	}

	/*
	* parse an entire file
	*/
	public void parse(String filename) {
	// from outer class
	List blockMarkers = this.fTranslator.getBlockMarkers();
	reset(getContents(filename));
	// this adds the current markers from the outer class list
	// to this parser so parsing works correctly
	for (int i = 0; i < blockMarkers.size(); i++) {
	addBlockMarker((BlockMarker) blockMarkers.get(i));
	}
	forceParse();
	}


	/*
	* listens to parser node parsed events
	* adds to local scriplet, expression, declaration buffers
	* determines which type of region the cursor is in, and adjusts cursor offset accordingly
	*/
	public void nodeParsed(IStructuredDocumentRegion sdRegion) {

	try {

	handleScopingIfNecessary(sdRegion);

	if (isJSPStartRegion(sdRegion)) {
	String nameStr = getRegionName(sdRegion);
	if (isJSPRegion(nameStr))
	fTagname = nameStr;
	else
	fTagname = null;


	// this section assumes important content (to translate)
	// IS the opening tag

	// handle include and directive
	if(fTagname != null && sdRegion.getFirstRegion().getType() == DOMJSPRegionContexts.JSP_DIRECTIVE_OPEN) {
	processOtherRegions(sdRegion);
	}
	// handle jsp:useBean
	if(fTagname != null && fTagname.equals(JSP11Namespace.ElementName.USEBEAN)) {
	processUseBean(sdRegion);
	}
	}
	else if (sdRegion.getFirstRegion().getType() == DOMJSPRegionContexts.JSP_CONTENT \|\| sdRegion.getFirstRegion().getType() == DOMRegionContext.XML_CONTENT) {
	// this section assumes important content (to translate)
	// is AFTER the opening tag
	if (fTagname != null) {
	// assign contents to one of the tables
	if (isScriptlet(fTagname)) {
	processScriptlet(sdRegion);
	}
	else if (isExpression(fTagname)) {
	processExpression(sdRegion);
	}
	else if (isDeclaration(fTagname)) {
	processDeclaration(sdRegion);
	}
	}
	}
	else {
	fTagname = null;
	}
	// this updates cursor position
	checkCursorInRegion(sdRegion);
	}
	catch (NullPointerException e) {
	// logging this exception that I've seen a couple of times...
	// seems to happen during shutdown of unit tests, at which
	// point Logger has already been unloaded
	try {
	Logger.logException("XMLJSPRegionHelper: exception in node parsing", e); //$NON-NLS-1$
	}
	catch (NoClassDefFoundError ex) {
	// do nothing, since we're just ending
	}
	}
	}

	private void handleScopingIfNecessary(IStructuredDocumentRegion sdRegion) {

	// fix to make sure custom tag block have their own scope
	// we add '{' for custom tag open and '}' for custom tag close
	// in the translation
	if(sdRegion.getFirstRegion().getType() == DOMRegionContext.XML_TAG_OPEN) {
	if(!isSelfClosingTag(sdRegion)) {
	String nameStr = getRegionName(sdRegion);
	if(isPossibleCustomTag(nameStr)) {
	startScope(nameStr);
	}
	}
	}
	else if(sdRegion.getFirstRegion().getType() == DOMRegionContext.XML_END_TAG_OPEN) {
	String nameStr = getRegionName(sdRegion);
	if(isPossibleCustomTag(nameStr)) {
	endScope(nameStr);
	}
	}
	}

	private boolean isSelfClosingTag(ITextRegionCollection containerRegion) {

	if(containerRegion == null)
	return false;

	ITextRegionList regions = containerRegion.getRegions();
	ITextRegion r = regions.get(regions.size()-1);
	return r.getType() == DOMRegionContext.XML_EMPTY_TAG_CLOSE;
	}

	private void startScope(String tagName) {
	IStructuredDocumentRegion currentNode = fTranslator.getCurrentNode();
	StringBuffer text = new StringBuffer();
	text.append("{ // <"); //$NON-NLS-1$
	text.append(tagName);
	text.append(">\n"); //$NON-NLS-1$
	this.fTranslator.translateScriptletString(text.toString(), currentNode, currentNode.getStartOffset(), currentNode.getLength()); //$NON-NLS-1$

	}

	private void endScope(String tagName) {
	IStructuredDocumentRegion currentNode = fTranslator.getCurrentNode();
	StringBuffer text = new StringBuffer();
	text.append("} // </"); //$NON-NLS-1$
	text.append(tagName);
	text.append(">\n"); //$NON-NLS-1$
	this.fTranslator.translateScriptletString(text.toString(), currentNode, currentNode.getStartOffset(), currentNode.getLength()); //$NON-NLS-1$

	}

	public void resetNodes() {
	// do nothing
	}

	private void checkCursorInRegion(IStructuredDocumentRegion sdRegion) {
	// if cursor is in this region...
	if (this.fTranslator.getSourcePosition() >= fStartOfTextToParse + sdRegion.getStartOffset() && this.fTranslator.getSourcePosition() <= fStartOfTextToParse + sdRegion.getEndOffset()) {
	int endOfNameTag = sdRegion.getStartOffset();
	int offset = fTextBefore.length() - fStrippedText.length();
	// offset in addtion to what's already in the buffer
	this.fTranslator.setRelativeOffset(this.fTranslator.getSourcePosition() - (fStartOfTextToParse + endOfNameTag) - offset);
	// outer class method
	this.fTranslator.setCursorOwner(fPossibleOwner);
	// add length of what's already in the buffer
	this.fTranslator.setRelativeOffset(this.fTranslator.getRelativeOffset() + this.fTranslator.getCursorOwner().length());
	if (fPossibleOwner == JSPTranslator.EXPRESSION) {
	// add length of expression prefix if necessary...
	this.fTranslator.setRelativeOffset(this.fTranslator.getRelativeOffset() + JSPTranslator.EXPRESSION_PREFIX.length());
	}
	}
	}

	protected void processDeclaration(IStructuredDocumentRegion sdRegion) {
	prepareText(sdRegion);
	IStructuredDocumentRegion currentNode = fTranslator.getCurrentNode();
	this.fTranslator.translateDeclarationString(fStrippedText, currentNode, currentNode.getStartOffset(), currentNode.getLength());
	fPossibleOwner = JSPTranslator.DECLARATION;
	}

	protected void processExpression(IStructuredDocumentRegion sdRegion) {
	prepareText(sdRegion);
	IStructuredDocumentRegion currentNode = fTranslator.getCurrentNode();
	this.fTranslator.translateExpressionString(fStrippedText, currentNode, currentNode.getStartOffset(), currentNode.getLength());
	fPossibleOwner = JSPTranslator.EXPRESSION;
	}

	protected void processScriptlet(IStructuredDocumentRegion sdRegion) {
	prepareText(sdRegion);
	IStructuredDocumentRegion currentNode = fTranslator.getCurrentNode();
	this.fTranslator.translateScriptletString(fStrippedText, currentNode, currentNode.getStartOffset(), currentNode.getLength());
	fPossibleOwner = JSPTranslator.SCRIPTLET;
	}

	/*
	* Substitutes values for entity references, strips CDATA tags, and keeps
	* track of string length(s) for cursor position calculation later.
	* @param sdRegion
	*/
	protected void prepareText(IStructuredDocumentRegion sdRegion) {
	fTextBefore = fTextToParse.substring(sdRegion.getStartOffset(), sdRegion.getEndOffset());
	fUnescapedText = EscapedTextUtil.getUnescapedText(fTextBefore);
	fStrippedText = this.fTranslator.stripCDATA(fUnescapedText);
	}

	protected void processUseBean(IStructuredDocumentRegion sdRegion) {
	if (fTagname != null && isUseBean(fTagname)) {

	String beanClass, beanType, beanId, beanDecl = ""; //$NON-NLS-1$
	beanClass = getAttributeValue("class", sdRegion); //$NON-NLS-1$
	beanType = getAttributeValue("type", sdRegion); //$NON-NLS-1$
	beanId = getAttributeValue("id", sdRegion); //$NON-NLS-1$

	if (beanId != null && (beanType != null \|\| beanClass != null)) {
	if (beanType.equals("")) //$NON-NLS-1$
	beanType = beanClass;
	String prefix = beanType + " " + beanId + " = "; //$NON-NLS-1$ //$NON-NLS-2$
	String suffix = "null;\n"; //$NON-NLS-1$
	if (beanClass != null)
	suffix = "new " + beanClass + "();\n"; //$NON-NLS-1$ //$NON-NLS-2$
	beanDecl = prefix + suffix;
	}

	IStructuredDocumentRegion currentNode = fTranslator.getCurrentNode();
	this.fTranslator.translateScriptletString(beanDecl, currentNode, currentNode.getStartOffset(), currentNode.getLength());
	fPossibleOwner = JSPTranslator.SCRIPTLET;
	}
	}

	protected void processOtherRegions(IStructuredDocumentRegion sdRegion) {
	processIncludeDirective(sdRegion);
	processPageDirective(sdRegion);
	}

	protected void processIncludeDirective(IStructuredDocumentRegion sdRegion) {
	if (isIncludeDirective(fTagname)) {
	// the directive name region itself contains the attrs...
	if (sdRegion.getRegions().get(0).getType() == DOMRegionContext.XML_CONTENT)
	sdRegion = sdRegion.getPrevious();
	String fileLocation = getAttributeValue("file", sdRegion); //$NON-NLS-1$
	this.fTranslator.handleIncludeFile(fileLocation);
	}
	else if (isPossibleCustomTag(fTagname)) {
	// this custom tag may define variables
	this.fTranslator.addTaglibVariables(fTagname);
	}
	else if (isTaglibDirective(fTagname)) {
	// also add the ones created here to the parent document
	String prefix = getAttributeValue("prefix", sdRegion); //$NON-NLS-1$
	List docs = this.fTranslator.getTLDCMDocumentManager().getCMDocumentTrackers(prefix, this.fTranslator.getCurrentNode().getEnd());
	Iterator it = docs.iterator();
	Iterator elements = null;
	CMNode node = null;
	CMDocument doc = null;
	BlockMarker marker = null;
	while (it.hasNext()) {
	doc = (CMDocument) it.next();
	elements = doc.getElements().iterator();
	while (elements.hasNext()) {
	node = (CMNode) elements.next();
	marker = new BlockMarker(node.getNodeName(), null, DOMJSPRegionContexts.JSP_CONTENT, true);
	// global scope is OK because we have encountered this <@taglib> directive
	// so it all markers from it should will be in scope
	// add to this local parser
	addBlockMarker(marker);
	// add to outer class marker list, for
	this.fTranslator.getBlockMarkers().add(marker);
	}
	}
	}
	}

	protected void processPageDirective(IStructuredDocumentRegion sdRegion) {
	if (isPageDirective(fTagname)) {
	while (sdRegion != null) {
	if (sdRegion.getType() == DOMJSPRegionContexts.JSP_DIRECTIVE_NAME)
	break;
	sdRegion = sdRegion.getPrevious();
	}
	String importValue = getAttributeValue("import", sdRegion); //$NON-NLS-1$
	if (importValue != "") { //$NON-NLS-1$
	// had to add "false" parameter to ensure these
	// imports don't get added to jsp <-> java map (since they are from an included file)
	// https://bugs.eclipse.org/bugs/show_bug.cgi?id=81687
	this.fTranslator.addImports(importValue, false);
	}
	}
	}

	/*
	* convenience method to get an attribute value from attribute name
	*/
	protected String getAttributeValue(String attrName, IStructuredDocumentRegion sdRegion) {
	String sdRegionText = fTextToParse.substring(sdRegion.getStartOffset(), sdRegion.getEndOffset());
	String textRegionText, attrValue = ""; //$NON-NLS-1$
	Iterator it = sdRegion.getRegions().iterator();
	ITextRegion nameRegion, valueRegion = null;
	while (it.hasNext()) {
	nameRegion = (ITextRegion) it.next();
	if (nameRegion.getType() == DOMRegionContext.XML_TAG_ATTRIBUTE_NAME) {
	textRegionText = sdRegionText.substring(nameRegion.getStart(), nameRegion.getTextEnd());
	if (textRegionText.equalsIgnoreCase(attrName)) {
	while (it.hasNext()) {
	valueRegion = (ITextRegion) it.next();
	if (valueRegion.getType() == DOMRegionContext.XML_TAG_ATTRIBUTE_VALUE) {
	attrValue = sdRegionText.substring(valueRegion.getStart(), valueRegion.getEnd());
	break; // inner
	}
	}
	break; // outer
	}
	}
	}
	return StringUtils.stripQuotes(attrValue);
	}

	// these methods determine what content gets added to the local scriplet, expression, declaration buffers
	/*
	* return true for elements whose contents we might want to add to the java file we are building
	*/
	protected boolean isJSPStartRegion(IStructuredDocumentRegion sdRegion) {
	return (sdRegion.getFirstRegion().getType() == DOMRegionContext.XML_TAG_OPEN \|\| sdRegion.getFirstRegion().getType() == DOMJSPRegionContexts.JSP_DIRECTIVE_OPEN);
	}

	protected boolean isJSPRegion(String tagName) {
	return isDeclaration(tagName) \|\| isExpression(tagName) \|\| isScriptlet(tagName) \|\| isUseBean(tagName) \|\| isIncludeDirective(tagName) \|\| isPossibleCustomTag(tagName) \|\| isTaglibDirective(tagName) \|\| isPageDirective(tagName);
	}

	protected boolean isDeclaration(String tagName) {
	return tagName.equalsIgnoreCase("jsp:declaration"); //$NON-NLS-1$
	}

	protected boolean isExpression(String tagName) {
	return tagName.equalsIgnoreCase("jsp:expression"); //$NON-NLS-1$
	}

	protected boolean isScriptlet(String tagName) {
	return tagName.equalsIgnoreCase("jsp:scriptlet"); //$NON-NLS-1$
	}

	protected boolean isUseBean(String tagName) {
	return tagName.equalsIgnoreCase("jsp:useBean"); //$NON-NLS-1$
	}

	protected boolean isIncludeDirective(String tagName) {
	return tagName.equalsIgnoreCase("jsp:directive.include"); //$NON-NLS-1$
	}

	protected boolean isPossibleCustomTag(String tagName) {
	return tagName.indexOf(":") > 0 && !tagName.startsWith("jsp"); //$NON-NLS-1$ //$NON-NLS-2$
	}

	protected boolean isTaglibDirective(String tagName) {
	return tagName.equalsIgnoreCase("jsp:directive.taglib"); //$NON-NLS-1$
	}

	protected boolean isPageDirective(String tagName) {
	return tagName.equalsIgnoreCase("jsp:directive.page"); //$NON-NLS-1$
	}

	protected String getRegionName(IStructuredDocumentRegion sdRegion) {

	String nameStr = ""; //$NON-NLS-1$
	ITextRegionList regions = sdRegion.getRegions();
	for(int i=0; i<regions.size(); i++) {
	ITextRegion r = regions.get(i);
	if(r.getType() == DOMRegionContext.XML_TAG_NAME) {
	nameStr = fTextToParse.substring(sdRegion.getStartOffset(r), sdRegion.getTextEndOffset(r));
	break;
	}
	}
	return nameStr.trim();
	}

	/*
	* get the contents of a file as a String
	*/
	protected String getContents(String fileName) {
	StringBuffer s = new StringBuffer();
	int c = 0;
	int count = 0;
	InputStream is = null;
	try {
	IPath filePath = new Path(fileName);
	IFile f = ResourcesPlugin.getWorkspace().getRoot().getFile(filePath);
	if(f != null && !f.exists()) {
	f = ResourcesPlugin.getWorkspace().getRoot().getFileForLocation(filePath);
	}
	if (f != null && f.exists()) {
	is = f.getContents();
	while ((c = is.read()) != -1) {
	count++;
	s.append((char) c);
	}
	}
	}
	catch (Exception e) {
	if (Debug.debugStructuredDocument)
	e.printStackTrace();
	}
	finally {
	try {
	if (is != null) {
	is.close();
	}
	}
	catch (Exception e) {
	// nothing to do
	}
	}
	return s.toString();
	}
	}