Language.Fortran.Rewriter.Internal

Documentation

data SourceLocation

Represents location in source code.

Note that, SourceLocation indicates space between characters, i.e the following example:

 SourceLocation 0 1

indicates position between first and second characters in a file.

Constructors

SourceLocation Int Int

Instances

Show SourceLocation

Defined in Language.Fortran.Rewriter.Internal

Methods

showsPrec :: Int -> SourceLocation -> ShowS

show :: SourceLocation -> String

showList :: [SourceLocation] -> ShowS

Eq SourceLocation

Defined in Language.Fortran.Rewriter.Internal

Methods

(==) :: SourceLocation -> SourceLocation -> Bool

(/=) :: SourceLocation -> SourceLocation -> Bool

Ord SourceLocation

Defined in Language.Fortran.Rewriter.Internal

Methods

compare :: SourceLocation -> SourceLocation -> Ordering

(<) :: SourceLocation -> SourceLocation -> Bool

(<=) :: SourceLocation -> SourceLocation -> Bool

(>) :: SourceLocation -> SourceLocation -> Bool

(>=) :: SourceLocation -> SourceLocation -> Bool

max :: SourceLocation -> SourceLocation -> SourceLocation

min :: SourceLocation -> SourceLocation -> SourceLocation

data SourceRange

Represents range in source code.

Constructors

SourceRange SourceLocation SourceLocation

Instances

Show SourceRange

Defined in Language.Fortran.Rewriter.Internal

Methods

showsPrec :: Int -> SourceRange -> ShowS

show :: SourceRange -> String

showList :: [SourceRange] -> ShowS

Eq SourceRange

Defined in Language.Fortran.Rewriter.Internal

Methods

(==) :: SourceRange -> SourceRange -> Bool

(/=) :: SourceRange -> SourceRange -> Bool

data RChar

Represents a character in the original source text along with any replacement operations applied to the character in place.

It expects a character (in case it's empty, Nothing should be used), whether it should be removed, its SourceLocation and a string that should be put in place of it.

Constructors

RChar (Maybe Char) Bool SourceLocation ByteString

Instances

Show RChar

Defined in Language.Fortran.Rewriter.Internal

Methods

showsPrec :: Int -> RChar -> ShowS

show :: RChar -> String

showList :: [RChar] -> ShowS

Eq RChar

Defined in Language.Fortran.Rewriter.Internal

Methods

(==) :: RChar -> RChar -> Bool

(/=) :: RChar -> RChar -> Bool

data Replacement

Represents the intent to replace content in the file.

The content in Replacement will be used in place of what is in the range described. Note that the replacement text can be shorter or larger than the original span, and it can also be multi-line.

Constructors

Replacement SourceRange String

Instances

Show Replacement

Defined in Language.Fortran.Rewriter.Internal

Methods

showsPrec :: Int -> Replacement -> ShowS

show :: Replacement -> String

showList :: [Replacement] -> ShowS

Eq Replacement

Defined in Language.Fortran.Rewriter.Internal

Methods

(==) :: Replacement -> Replacement -> Bool

(/=) :: Replacement -> Replacement -> Bool

Ord Replacement

Defined in Language.Fortran.Rewriter.Internal

Methods

compare :: Replacement -> Replacement -> Ordering

(<) :: Replacement -> Replacement -> Bool

(<=) :: Replacement -> Replacement -> Bool

(>) :: Replacement -> Replacement -> Bool

(>=) :: Replacement -> Replacement -> Bool

max :: Replacement -> Replacement -> Replacement

min :: Replacement -> Replacement -> Replacement

data ReplacementError

Exception raised when two Replacement objects overlap (OverlappingError) or Replacement points at invalid locations (InvalidRangeError).

Constructors

OverlappingError [(Replacement, Replacement)]

InvalidRangeError

Instances

Exception ReplacementError

Defined in Language.Fortran.Rewriter.Internal

Methods

toException :: ReplacementError -> SomeException

fromException :: SomeException -> Maybe ReplacementError

displayException :: ReplacementError -> String

Show ReplacementError

Defined in Language.Fortran.Rewriter.Internal

Methods

showsPrec :: Int -> ReplacementError -> ShowS

show :: ReplacementError -> String

showList :: [ReplacementError] -> ShowS

Eq ReplacementError

Defined in Language.Fortran.Rewriter.Internal

Methods

(==) :: ReplacementError -> ReplacementError -> Bool

(/=) :: ReplacementError -> ReplacementError -> Bool

type Chunk = [RChar]

As we advance through the [RChar] list, we consider "chunks" as the unit of text written out. A chunk is either:

1. original source text up to a newline character, end of file or RChar described in 2.
2. a single RChar that has non-empty replacement string or is deleted.

type ReplacementMap = Map String [Replacement]

Represents map of files and replacements that will be done.

toRCharList :: ByteString -> [RChar]

Parses input string into a list of annotated characters.

markRChars :: [RChar] -> SourceRange -> [RChar]

Marks RChars in a given range to be removed later.

markRChars_ :: [RChar] -> SourceRange -> SourceLocation -> [RChar]

setReplacementStringSL :: [RChar] -> SourceLocation -> ByteString -> Bool -> [RChar]

Sets replacement string to be prepended to the given location.

setReplacementStringSR :: [RChar] -> SourceRange -> ByteString -> Bool -> [RChar]

Sets replacement string to be prepended to the begining of the given range.

evaluateRChars :: [RChar] -> ByteString

Applies all deletions and additions and transforms RChars back to a string.

evaluateRChar :: RChar -> ByteString

If RChar is marked as deleted, it'll be evaluated to its replacement string, otherwise original character will be returned.

nextChunk :: [RChar] -> (Chunk, [RChar])

From [RChar], obtain a (Chunk, [RChars]) where the Chunk is the next Chunk and the [RChar] are the remaining RChars.

nextChunk_ :: [RChar] -> (Chunk, [RChar])

allChunks :: [RChar] -> [Chunk]

Splits [RChar] into Chunks.

evaluateChunks :: [Chunk] -> ByteString

Transform a list of Chunks into a single string, applying continuation lines when neccessary.

evaluateChunks_ :: [Chunk] -> Int64 -> Maybe Char -> ByteString

This expands the chunks from the left to right. If the length of what has already been put into the current line exceeds the limit of 72 characters (excluding inline comments starting with ! and implicit comments starting at column 73) then it ends the current line with a continuation, otherwise it simply adds the line as-is. It also calculates if the chunk is inside or outside of a string literal, using that to determine where explicit comments are if any.

In either case, we make sure that we are padding implicit comments *from the original source* even if the tail of that line has been moved onto a continuation line.

isMarkedForRemoval :: [RChar] -> Bool

isInsertion :: Replacement -> Bool

Return TRUE iff the Replacement constitutes a character insertion.

insertionSR :: SourceRange -> SourceRange

setReplacement :: [RChar] -> Replacement -> [RChar]

Sets a single Replacement given a list of RChars.

setReplacements :: [RChar] -> [Replacement] -> [RChar]

Sets a list of Replacements given a list of RChars.

adjustLineWrap :: [RChar] -> [RChar]

heuristic to wrap line after comma or right parenthesis if applicable

adjustLineWrapAux :: RChar -> [RChar] -> [RChar] -> [RChar]

deleteRC :: RChar -> RChar

Mark removal for the input RChar

appendRC :: RChar -> Char -> RChar

Append the input character to the replacement string

areDisjoint :: Replacement -> Replacement -> Bool

Checks whether two Replacements are not overlapping.

isValidRange :: SourceRange -> [RChar] -> Bool

Checks whether:

1. the start is before the end of the range and
2. both start and end locations are within the code.

isValidLocation :: SourceLocation -> [RChar] -> Bool

checkRanges :: [RChar] -> [Replacement] -> [RChar]

checkOverlapping :: [Replacement] -> [Replacement]

applyReplacements :: ByteString -> [Replacement] -> ByteString

Applies Replacements to a string and return it.

Firstly, it transforms the string into a list of RChars.

After that, it validates the SourceRange of each Replacement.

In the end, it splits up RChars in Chunks, set the Replacements and evaluates the Chunks.

applyReplacements_ :: [RChar] -> [Replacement] -> ByteString