/*******************************************************************************
* Copyright (c) 2000, 2008 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.wst.jsdt.core.formatter;
import org.eclipse.text.edits.TextEdit;
import org.eclipse.wst.jsdt.internal.compiler.util.Util;
/**
* Specification for a generic source code formatter.
*
*
* Provisional API: This class/interface is part of an interim API that is still under development and expected to
* change significantly before reaching stability. It is being made available at this early stage to solicit feedback
* from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
* (repeatedly) as the API evolves.
*/
public abstract class CodeFormatter {
/**
* Unknown kind
*/
public static final int K_UNKNOWN = 0x00;
/**
* Kind used to format an expression
*/
public static final int K_EXPRESSION = 0x01;
/**
* Kind used to format a set of statements
*/
public static final int K_STATEMENTS = 0x02;
/**
* Kind used to format a set of class body declarations
*/
public static final int K_CLASS_BODY_DECLARATIONS = 0x04;
/**
* Kind used to format a javascript unit
*/
public static final int K_JAVASCRIPT_UNIT = 0x08;
/**
* Kind used to format a single-line comment
*
*/
public static final int K_SINGLE_LINE_COMMENT = 0x10;
/**
* Kind used to format a multi-line comment
*
*/
public static final int K_MULTI_LINE_COMMENT = 0x20;
/**
* Kind used to format a jsdoc comment
*
*/
public static final int K_JAVA_DOC = 0x40;
/**
* Format <code>source</code>,
* and returns a text edit that correspond to the difference between the given string and the formatted string.
* <p>It returns null if the given string cannot be formatted.</p>
*
* <p>If the offset position is matching a whitespace, the result can include whitespaces. It would be up to the
* caller to get rid of preceeding whitespaces.</p>
*
* @param kind Use to specify the kind of the code snippet to format. It can be any of these:
* K_EXPRESSION, K_STATEMENTS, K_CLASS_BODY_DECLARATIONS, K_JAVASCRIPT_UNIT, K_UNKNOWN,
* K_SINGLE_LINE_COMMENT, K_MULTI_LINE_COMMENT, K_JAVA_DOC
* @param source the source to format
* @param offset the given offset to start recording the edits (inclusive).
* @param length the given length to stop recording the edits (exclusive).
* @param indentationLevel the initial indentation level, used
* to shift left/right the entire source fragment. An initial indentation
* level of zero or below has no effect.
* @param lineSeparator the line separator to use in formatted source,
* if set to <code>null</code>, then the platform default one will be used.
* @return the text edit
* @throws IllegalArgumentException if offset is lower than 0, length is lower than 0 or
* length is greater than source length.
*/
public abstract TextEdit format(int kind, String source, int offset, int length, int indentationLevel, String lineSeparator);
/**
* Answers the string that corresponds to the indentation to the given indentation level or an empty string
* if the indentation cannot be computed.
* <p>This method needs to be overriden in a subclass.</p>
*
* <p>The default implementation returns an empty string.</p>
*
* @param indentationLevel the given indentation level
* @return the string corresponding to the right indentation level
* @exception IllegalArgumentException if the given indentation level is lower than zero
*
*/
public String createIndentationString(int indentationLevel) {
return Util.EMPTY_STRING;
}
}