Top Description Inners Fields Constructors Methods

uk.ac.ed.ph.snuggletex.utilities

public final Class LaTeXIndenter

Class Inheritance

extends Object

java.lang.Object
uk.ac.ed.ph.snuggletex.utilities.LaTeXIndenter

Imports

java.io.BufferedReader, .IOException, .Reader, .Writer, java.util.regex.Matcher, .Pattern

Simple utility class that does very basic indenting of LaTeX.

Note

This has not been properly tested yet so is to be assumed experimental for the time being...!

Author: David McKain
Version: $Revision$

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static enum	LaTeXIndenter.ParsingState Encapsulates the different states our parser can be in

Field Summary

Modifier and Type	Field and Description
private static final String	BEGIN
private static final Pattern	BEGIN_PATTERN
private int	blankLineCount Number of consecutive blank lines encountered
private boolean	compactingBlankLines Whether to compact >1 blank lines up as a single blank line
public static final int	DEFAULT_INDENT_WIDTH Default indent width
public static final int	DEFAULT_MAX_INDENT_LEVEL Default maximum indent level
private static final String	END
private static final Pattern	END_PATTERN
private int	indentLevel Current indent level
private int	indentWidth Current indent width
private static final String	LINE_SEPARATOR
private int	maxIndentLevel Current maximum indent level
private final Writer	outputWriter Writer that we are outputting to
private LaTeXIndenter.ParsingState	parsingState Current parsing state
private boolean	verbatimMode Set when we are in verbatim mode

Constructor Summary

Access	Constructor and Description
public	LaTeXIndenter(final Writer outputWriter) Creates a new indenter that will output to `outputWriter`.

Method Summary

Modifier and Type	Method and Description
private void	createIndent(int level)
public int	getIndentWidth()
public int	getMaxIndentLevel()
private void	handleLine(String line) Handles a single line, which may or may not end in a newline character
private void	handleLineFragmentInDefaultState(String line)
private void	handleLineInDefaultState(String line)
public boolean	isCompactingBlankLines()
public void	reset()
public void	run(Reader inputReader) Indents the TeX read from the given inputReader, sending the results to `outputWriter`.
public void	setCompactingBlankLines(boolean condenseBlankLines)
public void	setIndentWidth(int indentWidth)
public void	setMaxIndentLevel(int maxIndentLevel)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

BEGIN	back to summary
private static final String BEGIN

BEGIN_PATTERN	back to summary
private static final Pattern BEGIN_PATTERN

blankLineCount	back to summary
private int blankLineCount Number of consecutive blank lines encountered

compactingBlankLines	back to summary
private boolean compactingBlankLines Whether to compact >1 blank lines up as a single blank line

DEFAULT_INDENT_WIDTH	back to summary
public static final int DEFAULT_INDENT_WIDTH Default indent width

DEFAULT_MAX_INDENT_LEVEL	back to summary
public static final int DEFAULT_MAX_INDENT_LEVEL Default maximum indent level

END	back to summary
private static final String END

END_PATTERN	back to summary
private static final Pattern END_PATTERN

indentLevel	back to summary
private int indentLevel Current indent level

indentWidth	back to summary
private int indentWidth Current indent width

LINE_SEPARATOR	back to summary
private static final String LINE_SEPARATOR

maxIndentLevel	back to summary
private int maxIndentLevel Current maximum indent level

outputWriter	back to summary
private final Writer outputWriter Writer that we are outputting to

parsingState	back to summary
private LaTeXIndenter.ParsingState parsingState Current parsing state

verbatimMode	back to summary
private boolean verbatimMode Set when we are in verbatim mode

Constructor Detail

LaTeXIndenter	back to summary
public LaTeXIndenter(final Writer outputWriter) Creates a new indenter that will output to `outputWriter`. This will have default properties set and will compact blank lines by default.

Method Detail

createIndent	back to summary
private void createIndent(int level) throws IOException

getIndentWidth	back to summary
public int getIndentWidth()

getMaxIndentLevel	back to summary
public int getMaxIndentLevel()

handleLine	back to summary
private void handleLine(String line) throws IOException Handles a single line, which may or may not end in a newline character

handleLineFragmentInDefaultState	back to summary
private void handleLineFragmentInDefaultState(String line) throws IOException

handleLineInDefaultState	back to summary
private void handleLineInDefaultState(String line) throws IOException

isCompactingBlankLines	back to summary
public boolean isCompactingBlankLines()

reset	back to summary
public void reset()

run	back to summary
public void run(Reader inputReader) throws IOException Indents the TeX read from the given inputReader, sending the results to `outputWriter`. The inputReader will be closed afterwards; the `outputWriter` is left open so the caller should arrange to flush or close it as required.

setCompactingBlankLines	back to summary
public void setCompactingBlankLines(boolean condenseBlankLines)

setIndentWidth	back to summary
public void setIndentWidth(int indentWidth)

setMaxIndentLevel	back to summary
public void setMaxIndentLevel(int maxIndentLevel)

uk.ac.ed.ph.snuggletex.utilities back to summary

private final Enum LaTeXIndenter.ParsingState

Class Inheritance

extends Enum<LaTeXIndenter.ParsingState>

java.lang.Object
java.lang.Enum
uk.ac.ed.ph.snuggletex.utilities.LaTeXIndenter.ParsingState

Encapsulates the different states our parser can be in

Field Summary

Modifier and Type	Field and Description
public static final LaTeXIndenter.ParsingState	BEGIN_DECLARATION Waiting to resolve a \\begin that started on the previous line
public static final LaTeXIndenter.ParsingState	DEFAULT Normal TeX
public static final LaTeXIndenter.ParsingState	EMPTY_LINES Handling a run of empty lines
public static final LaTeXIndenter.ParsingState	END_DECLARATION Waiting to resolve a \\end that started on the previous line

Constructor Summary

Access	Constructor and Description
private	ParsingState()

Method Summary

Modifier and Type	Method and Description
public static LaTeXIndenter.ParsingState	valueOf(String name)
public static LaTeXIndenter.ParsingState[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BEGIN_DECLARATION	back to summary
public static final LaTeXIndenter.ParsingState BEGIN_DECLARATION Waiting to resolve a \\begin that started on the previous line

DEFAULT	back to summary
public static final LaTeXIndenter.ParsingState DEFAULT Normal TeX

EMPTY_LINES	back to summary
public static final LaTeXIndenter.ParsingState EMPTY_LINES Handling a run of empty lines

END_DECLARATION	back to summary
public static final LaTeXIndenter.ParsingState END_DECLARATION Waiting to resolve a \\end that started on the previous line

Constructor Detail

ParsingState	back to summary
private ParsingState()

Method Detail

valueOf	back to summary
public static LaTeXIndenter.ParsingState valueOf(String name)

values	back to summary
public static LaTeXIndenter.ParsingState[] values()