Get the (possible cached) tokens for a given source span, and cache their being fetched. NOTE: The SrcSpan may be one introduced by HaRe, rather than GHC.

getTokensForNoIntros :: Bool -> Tree Entry -> SrcSpan -> (Tree Entry, [PosToken])Source

Get the (possible cached) tokens for a given source span, and cache their being fetched. NOTE: The SrcSpan may be one introduced by HaRe, rather than GHC.

getTokensBefore :: Tree Entry -> SrcSpan -> (Tree Entry, ReversedToks)Source

Get the tokens preceding a given SrcSpan

replaceTokenForSrcSpan :: Tree Entry -> SrcSpan -> PosToken -> Tree Entry Source

Replace a single token in a token tree, without changing the structure of the tree NOTE: the GHC.SrcSpan may have been used to select the appropriate forest in the first place, and is required to select the correct span in the tree, due to the ForestLine annotations that may be present

updateTokensForSrcSpan :: Tree Entry -> SrcSpan -> [PosToken] -> (Tree Entry, SrcSpan, Tree Entry)Source

Replace the tokens for a given SrcSpan with new ones. The SrcSpan will be inserted into the tree if it is not already there. If the SrcSpan changes size, replace the SrcSpan with a new one (marked), and return it, as well as the old one TODO: What about trailing comments? Preserve or replace?

insertSrcSpan :: Tree Entry -> ForestSpan -> Tree Entry Source

Insert a ForestSpan into the forest, if it is not there already. Assumes the forest was populated with the tokens containing the ForestSpan already

removeSrcSpan Source

Arguments

:: Tree Entry
-> ForestSpan
-> (Tree Entry, Tree Entry)	Updated forest, removed span

Removes a ForestSpan and its tokens from the forest.

getSrcSpanFor :: Tree Entry -> ForestSpan -> (Tree Entry, Tree Entry)Source

Retrieve a path to the tree containing a ForestSpan from the forest, inserting it if not already present

addNewSrcSpanAndToksAfter Source

Arguments

:: Tree Entry	The forest to update
-> SrcSpan	The new span comes after this one
-> SrcSpan	Existing span for the tokens
-> Positioning
-> [PosToken]	The new tokens belonging to the new SrcSpan
-> (Tree Entry, SrcSpan)	Unique SrcSpan allocated in the forest to identify this span in its position

Add a new SrcSpan and Tokens after a given one in the token stream and forest. This will be given a unique SrcSpan in return, which specifically indexes into the forest.

addToksAfterSrcSpan Source

Arguments

:: Tree Entry	TokenTree to be modified
-> SrcSpan	Preceding location for new tokens
-> Positioning
-> [PosToken]	New tokens to be added
-> (Tree Entry, SrcSpan)	updated TokenTree and SrcSpan location for the new tokens in the TokenTree

Add new tokens after the given SrcSpan, constructing a new SrcSpan in the process

addDeclToksAfterSrcSpan Source

Arguments

:: Data t
=> Tree Entry	TokenTree to be modified
-> SrcSpan	Preceding location for new tokens
-> Positioning
-> [PosToken]	New tokens to be added
-> Located t	Declaration the tokens belong to, to be synced
-> (Tree Entry, SrcSpan, Located t)	updated TokenTree ,SrcSpan location for -> (Tree Entry, GHC.SrcSpan,t) -- ^ updated TokenTree ,SrcSpan location for the new tokens in the TokenTree, and updated AST element

Add new tokens belonging to an AST fragment after a given SrcSpan, and re-sync the AST fragment to match the new location

syncAST Source

Arguments

:: Data t
=> Located t	The AST (or fragment)
-> SrcSpan	The SrcSpan created in the Tree Entry
-> Tree Entry	Existing token tree
-> (Located t, Tree Entry)	Updated AST and tokens

Synchronise a located AST fragment to use a newly created SrcSpan in the token tree. TODO: Should this indent the tokens as well?

indentDeclToks Source

Arguments

:: Data t
=> Located t	The AST (or fragment)
-> Tree Entry	Existing token tree
-> Int	(signed) number of columns to indent/dedent
-> (Located t, Tree Entry)	Updated AST and tokens

indent the tree and tokens by the given offset, and sync the AST to the tree too.

data Positioning Source

How new SrcSpans should be inserted in the Token tree, relative to the prior span

Constructors

PlaceAdjacent	Only a single space between the end of the prior span and the new one
PlaceAbsolute !Int !Int	Start at the specified line and col
PlaceAbsCol !Int !Int !Int	Line offset and absolute Col. Mainly for forcing start at left margin, number of lines to add at the end
PlaceOffset !Int !Int !Int	Line and Col offset for start, num lines to add at the end relative to the indent level of the prior span
PlaceIndent !Int !Int !Int	Line and Col offset for start, num lines to add at the end relative to the indent level of the prior line

Instances

Show Positioning

Retrieving tokens

retrieveTokensFinal :: Tree Entry -> [PosToken]Source

Retrieve all the tokens at the leaves of the tree, in order. Marked tokens are re-aligned, and gaps are closed.

retrieveTokensInterim :: Tree Entry -> [PosToken]Source

Retrieve all the tokens at the leaves of the tree, in order. No adjustments are made to address gaps or re-alignment of the tokens

retrieveTokens' :: Tree Entry -> [Entry]Source

Token Tree Selection

treeIdFromForestSpan :: ForestSpan -> TreeId Source

Token marking and re-alignment

reAlignMarked :: [PosToken] -> [PosToken]Source

Utility

posToSrcSpan :: Tree Entry -> (SimpPos, SimpPos) -> SrcSpan Source

Convert a simple (start,end) position to a SrcSpan belonging to the file in the tree

posToSrcSpanTok :: PosToken -> (SimpPos, SimpPos) -> SrcSpan Source

Convert a simple (start,end) position to a SrcSpan belonging to the file in the given token

fileNameFromTok :: PosToken -> FastString Source

treeStartEnd :: Tree Entry -> ForestSpan Source

Get the start and end position of a Tree treeStartEnd :: Tree Entry -> (SimpPos,SimpPos) treeStartEnd (Node (Entry sspan _) _) = (getGhcLoc sspan,getGhcLocEnd sspan)

spanStartEnd :: SrcSpan -> ForestSpan Source

Get the start and end position of a SrcSpan spanStartEnd :: GHC.SrcSpan -> (SimpPos,SimpPos) spanStartEnd sspan = (getGhcLoc sspan,getGhcLocEnd sspan)

A token stream with last tokens first, and functions to manipulate it

data ReversedToks Source

Keep track of when tokens are reversed, to avoid confusion

Constructors

RT [PosToken]

Instances

Show ReversedToks

reverseToks :: [PosToken] -> ReversedToks Source

unReverseToks :: ReversedToks -> [PosToken]Source

reversedToks :: ReversedToks -> [PosToken]Source

Internal, for testing

placeToksForSpan :: Tree Entry -> SrcSpan -> Tree Entry -> Positioning -> [PosToken] -> [PosToken]Source

limitPrevToks :: ReversedToks -> SrcSpan -> ReversedToks Source

reIndentToks :: Positioning -> [PosToken] -> [PosToken] -> [PosToken]Source

reAlignOneLine :: [PosToken] -> [PosToken]Source

Some tokens are marked if they belong to identifiers which have been renamed. When the renaming takes place, no layout adjustment is done. This function adjusts the spacing for the rest of the line to match as far as possible the original spacing, except for the name change.

reAlignToks :: [PosToken] -> [PosToken]Source

splitForestOnSpan :: Forest Entry -> ForestSpan -> ([Tree Entry], [Tree Entry], [Tree Entry])Source

Split a forest of trees into a (begin,middle,end) according to a ForestSpan, such that no tokens are included in begin or end belonging to the ForestSpan, and all of middle has some part of the ForestSpan

spanContains :: ForestSpan -> ForestSpan -> Bool Source

Does the first span contain the second? Takes cognisance of the various flags a ForestSpan can have. NOTE: This function relies on the Eq instance for ForestLine

containsStart :: ForestSpan -> ForestSpan -> Bool Source

True if the start of the second param lies in the span of the first

containsMiddle :: ForestSpan -> ForestSpan -> Bool Source

True if the start of the second param lies before the first, and ends after or on the second

containsEnd :: ForestSpan -> ForestSpan -> Bool Source

True if the end of the second param lies in the span of the first

doSplitTree :: Tree Entry -> ForestSpan -> ([Tree Entry], [Tree Entry], [Tree Entry])Source

splitSubtree :: Tree Entry -> ForestSpan -> ([Tree Entry], [Tree Entry], [Tree Entry])Source

Split a given tree into a possibly empty part that lies before the srcspan, the part that is wholly included in the srcspan and the part the lies outside of it at the end.

splitSubToks :: Tree Entry -> (ForestPos, ForestPos) -> ([Tree Entry], [Tree Entry], [Tree Entry])Source

nonCommentSpan :: [PosToken] -> (SimpPos, SimpPos)Source

Extract the start and end position of a span, without any leading or trailing comments

invariantOk :: Tree Entry -> Bool Source

Utility function to either return True or throw an error to report the problem

invariant :: Tree Entry -> [String]Source

Check the invariant for the token cache. Returns list of any errors found. Invariants: 1. For each tree, either the rootLabel has a SrcSpan only, or the subForest /= []. 2a. The trees making up the subForest of a given node fully include the parent SrcSpan. i.e. the leaves contain all the tokens for a given SrcSpan. 2b. The subForest is in SrcSpan order 3. A given SrcSpan can only appear (or be included) in a single tree of the forest. 4. The parent link for all sub-trees does exist, and actually points to the parent. 5. There are no nullSpan entries in the tree NOTE: the tokens may extend before or after the SrcSpan, due to comments only NOTE2: this will have to be revisited when edits to the tokens are made

showForest :: [Tree Entry] -> [String]Source

showTree :: Tree Entry -> String Source

showSrcSpan :: SrcSpan -> String Source

showSrcSpanF :: SrcSpan -> String Source

ghcSpanStartEnd :: SrcSpan -> ((Int, Int), (Int, Int))Source

insertNodeAfter :: Tree Entry -> Tree Entry -> Tree Entry -> Tree Entry Source

Insert a new node after the designated one in the tree

retrievePrevLineToks :: TreePos Full Entry -> ReversedToks Source

Starting from a point in the zipper, retrieve all tokens backwards until the line changes for a non-comment/non-empty token or beginning of file.

openZipperToNode :: Tree Entry -> TreePos Full Entry -> TreePos Full Entry Source

Open a zipper so that its focus is the given node NOTE: the node must already be in the tree

openZipperToSpan :: ForestSpan -> TreePos Full Entry -> TreePos Full Entry Source