Documentation

This is just the combination of a line number and a column number.

A BufSpan is simply defined by two times a BufLoc.

This is a file/text portion buffered as list of lines.

Line buffers are used to avoid repeated IO operations and to describe line-oriented content (for example at assembling the TTree).

Returns the start location of a BufSpan

Returns the end location of a BufSpan

Deconstructs a RealSrcSpan to the types more often used in libhbb.

This function converts a location in the form libhbb uses it into a string. The string has the format that is used by 'occurrences-of' and locate to report locations to the client.

This is an auxiliary function that splits a string at all newlines.

Note that lines from Prelude cannot be used here. The reason is following example:

   lines       "|  ->\n" = ["|  ->"]
   str2LineBuf "|  ->\n" = ["|  ->",""]

Converts a line buffer to a string.

Note that unlines doesn't work here because it doesn't treat the last line correctly.

This alias can be used to have a meaningful name for indentations.

For a line buffer this function returns the number of spaces charachters of the line with the smallest indentation.

Compares two non-overlapping RealSrcSpan elements by their starting location.

Converts a RealSrcLoc into a BufLoc effectively throwing away the filename.

Converts a RealSrcSpan into a BufSpan effectively throwing away the filename.

Creates a BufSpan where the first and the last BufLoc is the same.

The first parameter is the line and the second one is the column.

This function splits the passed lines (of a file-cache) at the position passed as second parameter.

Note that the line- and column-counts start with 1 (this is GHC behaviour). The split contains the character pointed to by the BufLoc in the right part of the tuple.

This means that (in case of line=1 and column=1) following applies:

 splitAtBufLoc "hello world" loc == ([""],["hello world"])

This function splits a number of input lines in a way so that the area located to by the passed source span is isolated.

The three areas in the return tuple are:

• Initial lines (they come first)
• Subject lines (they are between the locations)
• Trailing lines (they come after the last location)

The last line of initLines and the first line of subjLines must be joined to reproduce the output. The same applies to subjLines and traiLines...

This function returns true if the first RealSrcSpan points to a region that is located before the one pointed to by the second RealSrcSpan.

The two spans must be disjoint otherwise the results are undefined (can be checked with the function disjoint)!

This function returns true when the two passed RealSrcSpans do not overlap.

This means that the end of the first RealSrcSpan is smaller or equal to the start of the second RealSrcSpan and vice versa.

This function is the opposite of splitAtBufLoc.

It can rejoin a split concerning that the last and the first line in the frist respective second element of the split tuple must be joined by string concatenation. This function has been designed to run with linear time complexity.

This function combines two times joinSplit to be able to join lines that have been split by a SrcSpan.