* Copyright (c) 2004, 2011 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

*     Frits Jalvingh - contributions for bug 150794

*******************************************************************************/

* Translates a JSP document into a HttpServlet subclass. Keeps two way mapping from

* Java translation to the original JSP source, which can be obtained through

* getJava2JspRanges() and getJsp2JavaRanges().

*/

  /**

   * <p>This value should be incremented if any of the following methods change:

   * <ul>

   * <li>{@link #writeExternal(ObjectOutput)}</li>

   * <li>{@link #readExternal(ObjectInput)}</li>

   * <li>{@link #writeString(ObjectOutput, String)}</li>

   * <li>{@link #readString(ObjectInput)}</li>

   * <li>{@link #writeRanges(ObjectOutput, HashMap)}</li>

   * <li>{@link #readRanges(ObjectInput)}</li>

   * </ul>

   *

   * This is because if any of these change then previously externalized {@link JSPTranslator}s

   * will no longer be able to be read by the new implementation.  This value is used by

   * the {@link Externalizable} API automatically to determine if the file being read is of the

   * correct version to be read by the current implementation of the {@link JSPTranslator}</p>

   *

   * @see #writeExternal(ObjectOutput)

   * @see #readExternal(ObjectInput)

   * @see #writeString(ObjectOutput, String)

   * @see #readString(ObjectInput)

   * @see #writeRanges(ObjectOutput, HashMap)

   * @see #readRanges(ObjectInput)

   */

  private static final long serialVersionUID = 2L;

 

  /** for debugging */

  private static final boolean DEBUG = Boolean.valueOf(Platform.getDebugOption("org.eclipse.jst.jsp.core/debug/jspjavamapping")).booleanValue(); //$NON-NLS-1$

 

  /** handy plugin ID constant */

  private static final String JSP_CORE_PLUGIN_ID = "org.eclipse.jst.jsp.core"; //$NON-NLS-1$

 

  // constants for reading extension point

  /** Default EL Translator extension ID */

  private static final String DEFAULT_JSP_EL_TRANSLATOR_ID = "org.eclipse.jst.jsp.defaultJSP20"; //$NON-NLS-1$

 

  /** the name of the element in the extension point */

  private static final String EL_TRANSLATOR_EXTENSION_NAME = "elTranslator"; //$NON-NLS-1$

 

  /** the name of the property in the extension point */

  private static final String ELTRANSLATOR_PROP_NAME = "ELTranslator"; //$NON-NLS-1$

 

  // these constants are commonly used strings during translation

  /** end line characters */

  public static final String ENDL = "\n"; //$NON-NLS-1$

 

  /** session variable declaration */

  private static final String SESSION_VARIABLE_DECLARATION = "javax.servlet.http.HttpSession session = pageContext.getSession();" + ENDL; //$NON-NLS-1$

 

  /** footer text */

  private static final String FOOTER = "}}"; //$NON-NLS-1$

 

  /** exception declaration */

  private static final String EXCEPTION = "Throwable exception = null;"; //$NON-NLS-1$

 

  /** expression prefix */

  public static final String EXPRESSION_PREFIX = "out.print("; //$NON-NLS-1$

 

  /** expression suffix */

  public static final String EXPRESSION_SUFFIX = ");"; //$NON-NLS-1$

 

  /** try/catch start */

  private static final String TRY_CATCH_START = ENDL + "try {" + ENDL; //$NON-NLS-1$

 

  /** try/catch end */

  private static final String TRY_CATCH_END = " } catch (java.lang.Exception e) {} " + ENDL; //$NON-NLS-1$

 

  /** JSP tag name prefix */

  static final String JSP_PREFIX = "jsp:"; //$NON-NLS-1$

 

 

  // these constants are to keep track of what type of code is currently being translated

  /** code in question is standard JSP */

  protected final static int STANDARD_JSP = 0;

 

  /** code in question is embedded (JSP as an attribute or within comment tags) */

  protected final static int EMBEDDED_JSP = 1;

 

  /** code in question is a JSP declaration */

  protected final static int DECLARATION = 2;

 

  /** code in question is a JSP expression */

  protected final static int EXPRESSION = 4;

 

  /** code in question is a JSP scriptlet */

  protected final static int SCRIPTLET = 8;

 

 

  // strings specific to this translation

  /** translated class header */

  String fClassHeader = null;

 

  /** translated class name */

  String fClassname = null;

 

  /** translated class super class */

  String fSuperclass = null;

  /** translated class imports */

  String fImplicitImports = null;

  /** translated class service header */

  String fServiceHeader = null;

 

  /** translated user defined imports */

  private StringBuffer fUserImports = new StringBuffer();

 

  //translation specific state

  /** {@link IDOMModel} for the JSP file being translated */

  IDOMModel fStructuredModel = null;

 

  /** {@link IStructuredDocument} for the JSP file being translated */

  IStructuredDocument fStructuredDocument = null;

 

  /** the EL translator */

  private IJSPELTranslator fELTranslator = null;

 

  /** reported translation problems */

  private List fTranslationProblems = new ArrayList();

 

  /** fSourcePosition = position in JSP source */

  private int fSourcePosition = -1;

 

  /** fRelativeOffest = offset in the buffer there the cursor is */

  private int fRelativeOffset = -1;

 

  /** fCursorPosition = offset in the translated java document */

  private int fCursorPosition = -1;

  /** some page directive attributes */

  private boolean fIsErrorPage = false;

  private boolean fCursorInExpression = false;

  private boolean fIsInASession = true;

  /** user java code in body of the service method */

  private StringBuffer fUserCode = new StringBuffer();

  /** user EL Expression */

  private StringBuffer fUserELExpressions = new StringBuffer();

  /** user defined vars declared in the beginning of the class */

  private StringBuffer fUserDeclarations = new StringBuffer();

  /**

   * A map of tag names to tag library variable information; used to store

   * the ones needed for AT_END variable support.

   */

  private StackMap fTagToVariableMap = null;

  private Stack fUseBeansStack = new Stack();

  /** the final translated java document */

  private StringBuffer fResult;

 

  /** the buffer where the cursor is */

  private StringBuffer fCursorOwner = null;

  private IStructuredDocumentRegion fCurrentNode;

 

  /** flag for if the cursor is in the current regionb eing translated */

  private boolean fInCodeRegion = false;