Index

All
CeylonFormatTool
FormattingOptions

A bundle of options for the formatter that control how the code should be formatted.

FormattingVisitor

A Visitor that writes a formatted version of the element (typically a Tree.CompilationUnit) to a Writer.

FormattingWriter

Writes tokens to an underlying FormattingWriter.writer, respecting certain formatting settings and a maximum line width.

IndentMode

A mode to indent code based on levels of indentation.

LineBreak
LineBreakStrategy

A strategy to break a series of tokens into multiple lines to accomodate a maximum line length.

Mixed

Indent using tabs and spaces.

ParseOptionException
Spaces

Indent using spaces.

SparseFormattingOptions

A superclass of FormattingOptions where attributes are optional.

StackCondition

A condition that dictates when a token’s indentation stacks.

Tabs

Indent using tabs.

UnknownOptionException
Unlimited
VariableOptions

A subclass of SparseFormattingOptions that makes its attributes variable.

all
always

Indicates that an indentation should always be stacked.

combinedOptions()

A combination of several FormattingOptions, of which some may be Sparse.

commandLineOptions()
commonRoot()

Determines the common root of several paths. F

configProfileName()

Loads the profile name from the Ceylon configuration (key formattool.profile).

crlf
desire()

Parses a Boolean or Integer value into a desire in range minDesire..maxDesire.

format()

Format the given CompilationUnit and write it to the given Writer.

formattingFile()

Reads a file with formatting options.

help()

Returns a help string for the given topic, or null if no help is available for this topic.

ifApplied

Indicates that an indentation should be stacked if and only if it was applied, that is:

lf
loadProfile()

Loads formatting options from the given profile.

maxDesire

The maximum value that is safe to use as FormattingWriter.writeToken()’s space[Before|After] argument.

minDesire

The minimum value that is safe to use as FormattingWriter.writeToken()’s space[Before|After] argument.

never

Indicates that an indentation should never be stacked.

noLineBreak
os
parseIndentMode()

The IndentMode represented by the given String, or null if the string can't be parsed.

parseIntegerRange()
parseLineBreakStrategy()
parseTranslations()

Parses translations from the arguments.

run()

Run the module ceylon.formatter.

saveProfile()

Saves formatting options to the given profile.

unlimited