Package com.intellij.formatting

Class CoreFormatterUtil

java.lang.Object

com.intellij.formatting.CoreFormatterUtil

public class CoreFormatterUtil
extends java.lang.Object

Contains utility methods for core formatter processing.

Method Summary

Modifier and Type	Method and Description
static boolean	allowBackwardAlignment(LeafBlockWrapper first, LeafBlockWrapper second, java.util.Map<AbstractBlockWrapper,java.util.Set<AbstractBlockWrapper>> alignmentMappings) It's possible to configure alignment in a way to allow AlignmentFactory.createAlignment(boolean, Alignment.Anchor) backward shift}.
static FormattingModel	buildModel(FormattingModelBuilder builder, PsiElement element, CodeStyleSettings settings, FormattingMode mode)
static FormattingModel	buildModel(FormattingModelBuilder builder, PsiElement element, TextRange range, CodeStyleSettings settings, FormattingMode mode)
static AlignmentImpl	getAlignment(AbstractBlockWrapper block) Checks if there is an AlignmentImpl object that should be used during adjusting white space of the given block.
static LeafBlockWrapper	getFirstLeaf(AbstractBlockWrapper block)
static IndentData	getIndent(CommonCodeStyleSettings.IndentOptions options, AbstractBlockWrapper block, int tokenBlockStartOffset) Calculates indent for the given block and target start offset according to the given indent options.
static AbstractBlockWrapper	getIndentedParentBlock(AbstractBlockWrapper block) Tries to find the closest block that starts before the given block and contains line feeds.
static int	getStartColumn(LeafBlockWrapper block) Calculates number of non-line feed symbols before the given wrapped block.

Methods inherited from class java.lang.Object

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

Method Detail

buildModel

public static FormattingModel buildModel(FormattingModelBuilder builder,
                                         PsiElement element,
                                         TextRange range,
                                         CodeStyleSettings settings,
                                         FormattingMode mode)

buildModel

public static FormattingModel buildModel(FormattingModelBuilder builder,
                                         PsiElement element,
                                         CodeStyleSettings settings,
                                         FormattingMode mode)

getAlignment

public static AlignmentImpl getAlignment(AbstractBlockWrapper block)

Checks if there is an AlignmentImpl object that should be used during adjusting white space of the given block.

Parameters:

block - target block

Returns:

alignment object to use during adjusting white space of the given block if any; null otherwise

getStartColumn

public static int getStartColumn(LeafBlockWrapper block)

Calculates number of non-line feed symbols before the given wrapped block.

Example:

      whitespace11 block11 whitespace12 block12
      whitespace21 block21 whitespace22 block22
 

Suppose this method is called with the wrapped 'block22' and 'whitespace21' contains line feeds but 'whitespace22' is not. This method returns number of symbols from 'whitespace21' after its last line feed symbol plus number of symbols at block21 plus number of symbols at whitespace22.

Parameters:

block - target wrapped block to be used at a boundary during counting non-line feed symbols to the left of it

Returns:

non-line feed symbols to the left of the given wrapped block

getIndentedParentBlock

public static AbstractBlockWrapper getIndentedParentBlock(AbstractBlockWrapper block)

Tries to find the closest block that starts before the given block and contains line feeds.

Returns:

closest block to the given block that contains line feeds if any; null otherwise

allowBackwardAlignment

public static boolean allowBackwardAlignment(LeafBlockWrapper first,
                                             LeafBlockWrapper second,
                                             java.util.Map<AbstractBlockWrapper,java.util.Set<AbstractBlockWrapper>> alignmentMappings)

It's possible to configure alignment in a way to allow AlignmentFactory.createAlignment(boolean, Alignment.Anchor) backward shift}.

Example:

     class Test {
         int i;
         StringBuilder buffer;
     }
 

It's possible that blocks 'i' and 'buffer' should be aligned. As formatter processes document from start to end that means that requirement to shift block 'i' to the right is discovered only during 'buffer' block processing. I.e. formatter returns to the previously processed block ('i'), modifies its white space and continues from that location (performs 'backward' shift).

Here is one very important moment - there is a possible case that formatting blocks are configured in a way that they are combined in explicit cyclic graph.

Example:

     blah(bleh(blih,
       bloh), bluh);
 

Consider that pairs of blocks 'blih'; 'bloh' and 'bleh', 'bluh' should be aligned and backward shift is possible for them. Here is how formatter works:

1. Processing reaches 'bloh' block. It's aligned to 'blih' block. Current document state:

             blah(bleh(blih,
                       bloh), bluh);
         

2. Processing reaches 'bluh' block. It's aligned to 'blih' block and backward shift is allowed, hence, 'blih' block is moved to the right and processing contnues from it. Current document state:

             blah(            bleh(blih,
                       bloh), bluh);
         

3. Processing reaches 'bloh' block. It's configured to be aligned to 'blih' block, hence, it's moved to the right:

             blah(            bleh(blih,
                                   bloh), bluh);
         

4. We have endless loop then;

So, that implies that we can't use backward alignment if the blocks are configured in a way that backward alignment appliance produces endless loop. This method encapsulates the logic for checking if backward alignment can be applied.

Parameters:

first - the first aligned block

second - the second aligned block

alignmentMappings - block aligned mappings info

Returns:

true if backward alignment is possible; false otherwise

getIndent

public static IndentData getIndent(CommonCodeStyleSettings.IndentOptions options,
                                   AbstractBlockWrapper block,
                                   int tokenBlockStartOffset)

Calculates indent for the given block and target start offset according to the given indent options.

Parameters:

options - indent options to use

block - target wrapped block

tokenBlockStartOffset - target wrapped block offset

Returns:

indent to use for the given parameters

getFirstLeaf

public static LeafBlockWrapper getFirstLeaf(AbstractBlockWrapper block)