org.eclipse.xtext.serializer.sequencer

Class HiddenTokenSequencer

java.lang.Object

org.eclipse.xtext.serializer.sequencer.HiddenTokenSequencer

All Implemented Interfaces:

ISemanticSequenceAcceptor, ISyntacticSequenceAcceptor, IHiddenTokenSequencer

public class HiddenTokenSequencer
extends Object
implements IHiddenTokenSequencer, ISyntacticSequenceAcceptor

Author:

Moritz Eysholdt - Initial contribution and API

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.xtext.serializer.sequencer.IHiddenTokenSequencer

IHiddenTokenSequencer.IHiddenTokenSequencerOwner

Field Summary

Fields

Modifier and Type	Field and Description
protected ISequenceAcceptor	delegate
protected IHiddenTokenHelper	hiddenTokenHelper
protected INode	lastEmittedNode
protected INode	lastNode
protected INode	rootNode
protected ISyntacticSequencer	sequencer
protected TokenUtil	tokenUtil

Fields inherited from interface org.eclipse.xtext.serializer.acceptor.ISemanticSequenceAcceptor

NO_INDEX

Constructor Summary

Constructors

Constructor and Description
HiddenTokenSequencer()

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptAssignedCrossRefDatatype(RuleCall rc, String tkn, org.eclipse.emf.ecore.EObject val, int index, ICompositeNode node)
void	acceptAssignedCrossRefEnum(RuleCall rc, String token, org.eclipse.emf.ecore.EObject value, int index, ICompositeNode node)
void	acceptAssignedCrossRefKeyword(Keyword kw, String token, org.eclipse.emf.ecore.EObject value, int index, ILeafNode node)
void	acceptAssignedCrossRefTerminal(RuleCall rc, String token, org.eclipse.emf.ecore.EObject value, int index, ILeafNode node)
void	acceptAssignedDatatype(RuleCall rc, String token, Object value, int index, ICompositeNode node)
void	acceptAssignedEnum(RuleCall enumRC, String token, Object value, int index, ICompositeNode node)
void	acceptAssignedKeyword(Keyword keyword, String token, Object value, int index, ILeafNode node)
void	acceptAssignedTerminal(RuleCall terminalRC, String token, Object value, int index, ILeafNode node)
void	acceptUnassignedAction(Action action)
void	acceptUnassignedDatatype(RuleCall datatypeRC, String token, ICompositeNode node)
void	acceptUnassignedEnum(RuleCall enumRC, String token, ICompositeNode node)
void	acceptUnassignedKeyword(Keyword keyword, String token, ILeafNode node)
void	acceptUnassignedTerminal(RuleCall terminalRC, String token, ILeafNode node)
protected boolean	belongsToDeletedElement(INode node)
protected void	emitHiddenTokens(List<INode> hiddens)
boolean	enterAssignedAction(Action action, org.eclipse.emf.ecore.EObject semanticChild, ICompositeNode node)
boolean	enterAssignedParserRuleCall(RuleCall rc, org.eclipse.emf.ecore.EObject semanticChild, ICompositeNode node)
void	enterUnassignedParserRuleCall(RuleCall rc)
protected List<INode>	filterNodesOfDeletedElements(List<INode> allNodes, Set<org.eclipse.emf.ecore.EObject> deletedElements)
void	finish()
protected Set<INode>	getHiddenNodesBelongingTo(org.eclipse.emf.ecore.EObject semanticElement)
protected List<INode>	getHiddenNodesBetween(INode from, INode to)
protected INode	getLastLeaf(INode node)
protected Set<INode>	getLeadingCommentsIncludingWhitespace(ICompositeNode node)
protected Set<INode>	getLeadingCommentsIncludingWhitespace(ILeafNode node)
protected List<INode>	getRemainingHiddenNodesInContainer(INode from, INode root)
protected Set<INode>	getTrailingCommentsIncludingWhitespace(ICompositeNode node)
protected Set<INode>	getTrailingCommentsIncludingWhitespace(ILeafNode node)
protected void	handleDeletedElement(List<INode> out, Set<org.eclipse.emf.ecore.EObject> deletedSemanticElements, INode nodeOfDeletedElement)
void	init(org.eclipse.emf.ecore.EObject context, org.eclipse.emf.ecore.EObject semanticObject, ISequenceAcceptor sequenceAcceptor, ISerializationDiagnostic.Acceptor errorAcceptor) Deprecated.
void	init(ISerializationContext context, org.eclipse.emf.ecore.EObject semanticObject, ISequenceAcceptor sequenceAcceptor, ISerializationDiagnostic.Acceptor errorAcceptor)
protected boolean	isLeadingCommentFor(INode comment, INode node)
protected boolean	isTrailingCommentFor(INode comment, INode node)
void	leaveAssignedAction(Action action, org.eclipse.emf.ecore.EObject semanticChild)
void	leaveAssignedParserRuleCall(RuleCall rc, org.eclipse.emf.ecore.EObject semanticChild)
void	leaveUnssignedParserRuleCall(RuleCall rc)

Methods inherited from class java.lang.Object

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

Field Detail

delegate

protected ISequenceAcceptor delegate

hiddenTokenHelper

@Inject
protected IHiddenTokenHelper hiddenTokenHelper

lastNode

protected INode lastNode

lastEmittedNode

protected INode lastEmittedNode

rootNode

protected INode rootNode

sequencer

protected ISyntacticSequencer sequencer

tokenUtil

@Inject
protected TokenUtil tokenUtil

Constructor Detail

HiddenTokenSequencer

public HiddenTokenSequencer()

Method Detail

acceptAssignedCrossRefDatatype

public void acceptAssignedCrossRefDatatype(RuleCall rc,
                                  String tkn,
                                  org.eclipse.emf.ecore.EObject val,
                                  int index,
                                  ICompositeNode node)

Specified by:

acceptAssignedCrossRefDatatype in interface ISemanticSequenceAcceptor

acceptAssignedCrossRefEnum

public void acceptAssignedCrossRefEnum(RuleCall rc,
                              String token,
                              org.eclipse.emf.ecore.EObject value,
                              int index,
                              ICompositeNode node)

Specified by:

acceptAssignedCrossRefEnum in interface ISemanticSequenceAcceptor

acceptAssignedCrossRefKeyword

public void acceptAssignedCrossRefKeyword(Keyword kw,
                                 String token,
                                 org.eclipse.emf.ecore.EObject value,
                                 int index,
                                 ILeafNode node)

Specified by:

acceptAssignedCrossRefKeyword in interface ISemanticSequenceAcceptor

acceptAssignedCrossRefTerminal

public void acceptAssignedCrossRefTerminal(RuleCall rc,
                                  String token,
                                  org.eclipse.emf.ecore.EObject value,
                                  int index,
                                  ILeafNode node)

Specified by:

acceptAssignedCrossRefTerminal in interface ISemanticSequenceAcceptor

acceptAssignedDatatype

public void acceptAssignedDatatype(RuleCall rc,
                          String token,
                          Object value,
                          int index,
                          ICompositeNode node)

Specified by:

acceptAssignedDatatype in interface ISemanticSequenceAcceptor

acceptAssignedEnum

public void acceptAssignedEnum(RuleCall enumRC,
                      String token,
                      Object value,
                      int index,
                      ICompositeNode node)

Specified by:

acceptAssignedEnum in interface ISemanticSequenceAcceptor

acceptAssignedKeyword

public void acceptAssignedKeyword(Keyword keyword,
                         String token,
                         Object value,
                         int index,
                         ILeafNode node)

Specified by:

acceptAssignedKeyword in interface ISemanticSequenceAcceptor

acceptAssignedTerminal

public void acceptAssignedTerminal(RuleCall terminalRC,
                          String token,
                          Object value,
                          int index,
                          ILeafNode node)

Specified by:

acceptAssignedTerminal in interface ISemanticSequenceAcceptor

acceptUnassignedAction

public void acceptUnassignedAction(Action action)

Specified by:

acceptUnassignedAction in interface ISyntacticSequenceAcceptor

acceptUnassignedDatatype

public void acceptUnassignedDatatype(RuleCall datatypeRC,
                            String token,
                            ICompositeNode node)

Specified by:

acceptUnassignedDatatype in interface ISyntacticSequenceAcceptor

acceptUnassignedEnum

public void acceptUnassignedEnum(RuleCall enumRC,
                        String token,
                        ICompositeNode node)

Specified by:

acceptUnassignedEnum in interface ISyntacticSequenceAcceptor

acceptUnassignedKeyword

public void acceptUnassignedKeyword(Keyword keyword,
                           String token,
                           ILeafNode node)

Specified by:

acceptUnassignedKeyword in interface ISyntacticSequenceAcceptor

acceptUnassignedTerminal

public void acceptUnassignedTerminal(RuleCall terminalRC,
                            String token,
                            ILeafNode node)

Specified by:

acceptUnassignedTerminal in interface ISyntacticSequenceAcceptor

emitHiddenTokens

protected void emitHiddenTokens(List<INode> hiddens)

enterAssignedAction

public boolean enterAssignedAction(Action action,
                          org.eclipse.emf.ecore.EObject semanticChild,
                          ICompositeNode node)

Specified by:

enterAssignedAction in interface ISemanticSequenceAcceptor

enterAssignedParserRuleCall

public boolean enterAssignedParserRuleCall(RuleCall rc,
                                  org.eclipse.emf.ecore.EObject semanticChild,
                                  ICompositeNode node)

Specified by:

enterAssignedParserRuleCall in interface ISemanticSequenceAcceptor

enterUnassignedParserRuleCall

public void enterUnassignedParserRuleCall(RuleCall rc)

Specified by:

enterUnassignedParserRuleCall in interface ISyntacticSequenceAcceptor

finish

public void finish()

Specified by:

finish in interface ISemanticSequenceAcceptor

getHiddenNodesBetween

protected List<INode> getHiddenNodesBetween(INode from,
                                INode to)

Returns:

null if the whitespace between these nodes is unknown. In this case, the formatter needs to decide.

belongsToDeletedElement

protected boolean belongsToDeletedElement(INode node)

handleDeletedElement

protected void handleDeletedElement(List<INode> out,
                        Set<org.eclipse.emf.ecore.EObject> deletedSemanticElements,
                        INode nodeOfDeletedElement)

filterNodesOfDeletedElements

protected List<INode> filterNodesOfDeletedElements(List<INode> allNodes,
                                       Set<org.eclipse.emf.ecore.EObject> deletedElements)

getHiddenNodesBelongingTo

protected Set<INode> getHiddenNodesBelongingTo(org.eclipse.emf.ecore.EObject semanticElement)

getLeadingCommentsIncludingWhitespace

protected Set<INode> getLeadingCommentsIncludingWhitespace(ICompositeNode node)

getTrailingCommentsIncludingWhitespace

protected Set<INode> getTrailingCommentsIncludingWhitespace(ICompositeNode node)

getLeadingCommentsIncludingWhitespace

protected Set<INode> getLeadingCommentsIncludingWhitespace(ILeafNode node)

getTrailingCommentsIncludingWhitespace

protected Set<INode> getTrailingCommentsIncludingWhitespace(ILeafNode node)

isLeadingCommentFor

protected boolean isLeadingCommentFor(INode comment,
                          INode node)

isTrailingCommentFor

protected boolean isTrailingCommentFor(INode comment,
                           INode node)

getLastLeaf

protected INode getLastLeaf(INode node)

getRemainingHiddenNodesInContainer

protected List<INode> getRemainingHiddenNodesInContainer(INode from,
                                             INode root)

init

@Deprecated
public void init(org.eclipse.emf.ecore.EObject context,
                   org.eclipse.emf.ecore.EObject semanticObject,
                   ISequenceAcceptor sequenceAcceptor,
                   ISerializationDiagnostic.Acceptor errorAcceptor)

Deprecated.

Specified by:

init in interface IHiddenTokenSequencer

init

public void init(ISerializationContext context,
        org.eclipse.emf.ecore.EObject semanticObject,
        ISequenceAcceptor sequenceAcceptor,
        ISerializationDiagnostic.Acceptor errorAcceptor)

Specified by:

init in interface IHiddenTokenSequencer

leaveAssignedAction

public void leaveAssignedAction(Action action,
                       org.eclipse.emf.ecore.EObject semanticChild)

Specified by:

leaveAssignedAction in interface ISemanticSequenceAcceptor

leaveAssignedParserRuleCall

public void leaveAssignedParserRuleCall(RuleCall rc,
                               org.eclipse.emf.ecore.EObject semanticChild)

Specified by:

leaveAssignedParserRuleCall in interface ISemanticSequenceAcceptor

leaveUnssignedParserRuleCall

public void leaveUnssignedParserRuleCall(RuleCall rc)

Specified by:

leaveUnssignedParserRuleCall in interface ISyntacticSequenceAcceptor