com.aptana.ide.editors.unified
Class BaseFormatter

java.lang.Object
  com.aptana.ide.editors.unified.BaseFormatter

All Implemented Interfaces:

ICodeFormatter

Direct Known Subclasses:

CSSCodeFormatter, HTMLCodeFormatter, JSCodeFormatter

public abstract class BaseFormatter
extends java.lang.Object
implements ICodeFormatter

Author:

Kevin Sawicki (ksawicki@aptana.com)

Constructor Summary

BaseFormatter()

Method Summary

protected java.lang.String	getEndLineBreaks(SourceWriter writer, java.lang.String source2, java.lang.String formatted)
protected java.lang.String	getStartLineBreaks(SourceWriter writer, java.lang.String source2, java.lang.String formatted)
boolean	isFormattingCorrect(LexemeList originalList, IParser parser, java.lang.String original, java.lang.String formatted, int[] ignorableSizeNodes, int[] ignorableCountNodes)
boolean	isLexemeOfType(Lexeme lexeme, int type) Is the lexeme of the specified type?
protected void	logError(java.lang.String original, java.lang.String formatted) Logs an error
java.lang.String	normalizeCarriageReturns(java.lang.String text) Strips carriage returns

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aptana.ide.editors.unified.ICodeFormatter

createNestedMark, format, handlesNested

Constructor Detail

BaseFormatter

public BaseFormatter()

Method Detail

isFormattingCorrect

public boolean isFormattingCorrect(LexemeList originalList,
                                   IParser parser,
                                   java.lang.String original,
                                   java.lang.String formatted,
                                   int[] ignorableSizeNodes,
                                   int[] ignorableCountNodes)

Parameters:

originalList -

parser -

original -

formatted -

ignorableSizeNodes -

ignorableCountNodes -

Returns:

- true if formatting correct, false otherwise

normalizeCarriageReturns

public java.lang.String normalizeCarriageReturns(java.lang.String text)

Strips carriage returns

Parameters:

text -

Returns:

- normalizes carraige returns to \n

logError

protected void logError(java.lang.String original,
                        java.lang.String formatted)

Logs an error

Parameters:

original -

formatted -

isLexemeOfType

public boolean isLexemeOfType(Lexeme lexeme,
                              int type)

Is the lexeme of the specified type?

Parameters:

lexeme -

type -

Returns:

lexeme type

getStartLineBreaks

protected java.lang.String getStartLineBreaks(SourceWriter writer,
                                              java.lang.String source2,
                                              java.lang.String formatted)

Parameters:

lexemes2 -

getEndLineBreaks

protected java.lang.String getEndLineBreaks(SourceWriter writer,
                                            java.lang.String source2,
                                            java.lang.String formatted)

Parameters:

lexemes2 -