Attachment 3751 Details for Bug 33450 – StringLiteral.java

StringLiteral.java

StringLiteral.java (text/plain), 9.37 KB, created by Luc Bourlier

on 2003-02-27 11:43:21 EST

(hide)

Description:

Filename:

MIME Type:

Creator: Luc Bourlier

Created: 2003-02-27 11:43:21 EST

Size: 9.37 KB

patch

obsolete

>/*******************************************************************************
> * Copyright (c) 2001 International Business Machines Corp. and others.
> * All rights reserved. This program and the accompanying materials 
> * are made available under the terms of the Common Public License v0.5 
> * which accompanies this distribution, and is available at
> * http://www.eclipse.org/legal/cpl-v05.html
> * 
> * Contributors:
> * IBM Corporation - initial API and implementation
> ******************************************************************************/
>
>package org.eclipse.jdt.core.dom;
>
>import org.eclipse.jdt.core.compiler.InvalidInputException;
>import org.eclipse.jdt.internal.compiler.parser.Scanner;
>
>/**
> * String literal nodes.
> * 
> * @since 2.0
> */
>public class StringLiteral extends Expression {
>
>	/**
>	 * The literal string, including quotes and escapes; defaults to the 
>	 * literal for the empty string.
>	 */
>	private String escapedValue = "\"\"";//$NON-NLS-1$
>
>	/**
>	 * Creates a new unparented string literal node owned by the given AST.
>	 * By default, the string literal denotes the empty string.
>	 * 
>	 * N.B. This constructor is package-private.
>	 * 
>	 * 
>	 * @param ast the AST that is to own this node
>	 */
>	StringLiteral(AST ast) {
>		super(ast);
>	}
>
>	/* (omit javadoc for this method)
>	 * Method declared on ASTNode.
>	 */
>	public int getNodeType() {
>		return STRING_LITERAL;
>	}
>
>	/* (omit javadoc for this method)
>	 * Method declared on ASTNode.
>	 */
>	ASTNode clone(AST target) {
>		StringLiteral result = new StringLiteral(target);
>		result.setSourceRange(this.getStartPosition(), this.getLength());
>		result.setEscapedValue(getEscapedValue());
>		return result;
>	}
>
>	/* (omit javadoc for this method)
>	 * Method declared on ASTNode.
>	 */
>	public boolean subtreeMatch(ASTMatcher matcher, Object other) {
>		// dispatch to correct overloaded match method
>		return matcher.match(this, other);
>	}
>
>	/* (omit javadoc for this method)
>	 * Method declared on ASTNode.
>	 */
>	void accept0(ASTVisitor visitor) {
>		visitor.visit(this);
>		visitor.endVisit(this);
>	}
>	
>	/**
>	 * Returns the string value of this literal node to the given string
>	 * literal token. The token is the sequence of characters that would appear
>	 * in the source program, including enclosing double quotes and embedded
>	 * escapes.
>	 * 
>	 * @return the string literal token, including enclosing double
>	 * quotes and embedded escapes
>	 */ 
>	public String getEscapedValue() {
>		return escapedValue;
>	}
>		
>	/**
>	 * Sets the string value of this literal node to the given string literal
>	 * token. The token is the sequence of characters that would appear in the
>	 * source program, including enclosing double quotes and embedded escapes.
>	 * For example,
>	 * <ul>
>	 * <li><code>""</code> <code>setLiteral("\"\"")</code></li>
>	 * <li><code>"hello world"</code> <code>setLiteral("\"hello world\"")</code></li>
>	 * <li><code>"boo\nhoo"</code> <code>setLiteral("\"boo\\nhoo\"")</code></li>
>	 * </ul>
>	 * 
>	 * @param token the string literal token, including enclosing double
>	 * quotes and embedded escapes
>	 * @exception IllegalArgumentException if the argument is incorrect
>	 */ 
>	public void setEscapedValue(String token) {
>		if (token == null) {
>			throw new IllegalArgumentException();
>		}
>		Scanner scanner = getAST().scanner;
>		char[] source = token.toCharArray();
>		scanner.setSource(source);
>		scanner.resetTo(0, source.length);
>		try {
>			int tokenType = scanner.getNextToken();
>			switch(tokenType) {
>				case Scanner.TokenNameStringLiteral:
>					break;
>				default:
>					throw new IllegalArgumentException();
>			}
>		} catch(InvalidInputException e) {
>			throw new IllegalArgumentException();
>		}
>		modifying();
>		this.escapedValue = token;
>	}
>
>	/**
>	 * Returns the value of this literal node. 
>	 * 
>	 * For example,
>	 * <code>
>	 * <pre>
>	 * StringLiteral s;
>	 * s.setEscapedValue("\"hello\\nworld\"");
>	 * assert s.getLiteralValue().equals("hello\nworld");
>	 * </pre>
>	 * 
>	 * 
>	 * Note that this is a convenience method that converts from the stored 
>	 * string literal token returned by <code>getEscapedLiteral</code>.
>	 * 
>	 * 
>	 * @return the string value without enclosing double quotes and embedded
>	 * escapes
>	 * @exception IllegalArgumentException if the literal value cannot be converted
>	 */ 
>	public String getLiteralValue() {
>		String s = getEscapedValue();
>		int len = s.length();
>		if (len < 2 || s.charAt(0) != '\"' || s.charAt(len-1) != '\"' ) {
>			throw new IllegalArgumentException();
>		}
>		StringBuffer b = new StringBuffer(len - 2);
>		for (int i = 1; i< len - 1; i++) {
>			char c = s.charAt(i);
>			if (c == '\"') {
>				throw new IllegalArgumentException();
>			}
>			if (c == '\\') {
>				// legal: b, t, n, f, r, ", ', \, 0, 1, 2, 3, 4, 5, 6, or 7
>				char nextChar;
>				if ((i + 1) < len - 1) {
>					nextChar = s.charAt(i + 1);
>					i++;
>					switch(nextChar) {
>						case 'b' :
>							b.append('\b');
>							break;
>						case 't' :
>							b.append('\t');
>							break;
>						case 'n' :
>							b.append('\n');
>							break;
>						case 'f' :
>							b.append('\f');
>							break;
>						case 'r' :
>							b.append('\r');
>							break;
>						case '\"':
>							b.append('\"');
>							break;
>						case '\'':
>							b.append('\'');
>							break;
>						case '\\':
>							b.append('\\');
>							break;
>						case '0' :
>						case '1' :
>						case '2' :
>						case '3' :
>						case '4' :
>						case '5' :
>						case '6' :
>						case '7' :
>							int firstDigit= Character.getNumericValue(nextChar);
>							int secondDigit= Character.getNumericValue(s.charAt(i + 1));
>							int thirdDigit= Character.getNumericValue(s.charAt(i + 2));
>							if (secondDigit < 0 || secondDigit > 7) {
>								b.append((char)firstDigit);
>							} else if (thirdDigit < 0 || thirdDigit > 7) {
>								b.append((char)(firstDigit * 8 + secondDigit));
>								i++;
>							} else {
>								if (firstDigit > 3) {
>									throw new IllegalArgumentException("Invalid string literal");//$NON-NLS-1$
>								}
>								b.append((char)(firstDigit * 64 + secondDigit * 8 + thirdDigit));
>								i+= 2;
>							}
>							break;
>						case 'u' :
>							//handle the case of unicode.
>							int currentPosition = i + 1;
>							int c1 = 0, c2 = 0, c3 = 0, c4 = 0;
>							if ((c1 = Character.getNumericValue(s.charAt(currentPosition++))) > 15
>								|| c1 < 0
>								|| (c2 = Character.getNumericValue(s.charAt(currentPosition++))) > 15
>								|| c2 < 0
>								|| (c3 = Character.getNumericValue(s.charAt(currentPosition++))) > 15
>								|| c3 < 0
>								|| (c4 = Character.getNumericValue(s.charAt(currentPosition++))) > 15
>								|| c4 < 0){
>								throw new IllegalArgumentException("Invalid string literal"); //$NON-NLS-1$
>							} else {
>								b.append((char) (((c1 * 16 + c2) * 16 + c3) * 16 + c4));
>								i = currentPosition - 1;
>							}
>							break;
>						default:
>							throw new IllegalArgumentException("Invalid string literal");//$NON-NLS-1$
>					}
>				} else {
>					throw new IllegalArgumentException("Invalid string literal");//$NON-NLS-1$
>				}
>			} else {
>				b.append(c);
>			}
>		}
>		return b.toString();			
>	}
>
>	/**
>	 * Sets the value of this literal node. 
>	 * 
>	 * For example,
>	 * <code>
>	 * <pre>
>	 * StringLiteral s;
>	 * s.setLiteralValue("hello\nworld");
>	 * assert s.getEscapedValue("\"hello\\nworld\"");
>	 * assert s.getLiteralValue().equals("hello\nworld");
>	 * </pre>
>	 * 
>	 * 
>	 * Note that this is a convenience method that converts to the stored 
>	 * string literal token acceptable to <code>setEscapedLiteral</code>.
>	 * 
>	 * 
>	 * @param literal the string value without enclosing double quotes and 
>	 * embedded escapes
>	 * @exception IllegalArgumentException if the argument is incorrect
>	 */
>	public void setLiteralValue(String value) {
>		if (value == null) {
>			throw new IllegalArgumentException();
>		}
>		int len = value.length();
>		StringBuffer b = new StringBuffer(len + 2);
>		
>		b.append("\""); // opening delimiter //$NON-NLS-1$
>		for (int i = 0; i < len; i++) {
>			char c = value.charAt(i);
>			switch(c) {
>				case '\b' :
>					b.append("\\b"); //$NON-NLS-1$
>					break;
>				case '\t' :
>					b.append("\\t"); //$NON-NLS-1$
>					break;
>				case '\n' :
>					b.append("\\n"); //$NON-NLS-1$
>					break;
>				case '\f' :
>					b.append("\\f"); //$NON-NLS-1$
>					break;
>				case '\r' :
>					b.append("\\r"); //$NON-NLS-1$
>					break;
>				case '\"':
>					b.append("\\\""); //$NON-NLS-1$
>					break;
>				case '\'':
>					b.append("\\\'"); //$NON-NLS-1$
>					break;
>				case '\\':
>					b.append("\\\\"); //$NON-NLS-1$
>					break;
>				case '\0' :
>					b.append("\\0"); //$NON-NLS-1$
>					break;
>				case '\1' :
>					b.append("\\1"); //$NON-NLS-1$
>					break;
>				case '\2' :
>					b.append("\\2"); //$NON-NLS-1$
>					break;
>				case '\3' :
>					b.append("\\3"); //$NON-NLS-1$
>					break;
>				case '\4' :
>					b.append("\\4"); //$NON-NLS-1$
>					break;
>				case '\5' :
>					b.append("\\5"); //$NON-NLS-1$
>					break;
>				case '\6' :
>					b.append("\\6"); //$NON-NLS-1$
>					break;
>				case '\7' :
>					b.append("\\7"); //$NON-NLS-1$
>					break;			
>				default:
>					b.append(c);
>			}
>		}
>		b.append("\""); // closing delimiter //$NON-NLS-1$
>		setEscapedValue(b.toString());
>	}
>	/* (omit javadoc for this method)
>	 * Method declared on ASTNode.
>	 */
>	int memSize() {
>		int size = BASE_NODE_SIZE + 1 * 4;
>		if (escapedValue != null) {
>			size += HEADERS + 2 * 4 + HEADERS + 2 * escapedValue.length();
>		}
>		return size;
>	}
>	
>	/* (omit javadoc for this method)
>	 * Method declared on ASTNode.
>	 */
>	int treeSize() {
>		return memSize();
>	}
>}
>

Actions: View

Attachments on bug 33450: 3751