Safe Haskell	None
Language	Haskell2010

Mikan.Syntax.Parser.Literate

Description

Preprocessors for literate code formats.

Synopsis

literateProcessors :: Bool -> [(String, Processor, FileType)]
literateTeX :: Processor
literateRsT :: Processor
literateMd :: Bool -> Processor
literateOrg :: Processor
illiterate :: [Layer] -> Text
atomizeLayers :: Layers -> [(LayerRole, Char)]
type Processor = PositionWithoutFile -> Text -> [Layer]
type Layers = [Layer]
data Layer = Layer {
- layerRole :: LayerRole
- interval :: IntervalWithoutFile
- layerContent :: Text
}
data LayerRole
- = Markup
- | Comment
- | Code
isCode :: LayerRole -> Bool
isCodeLayer :: Layer -> Bool

Documentation

literateProcessors Source #

Arguments

:: Bool	The value of `optMdOnlyAgdaBlocks`.
-> [(String, Processor, FileType)]

List of valid extensions for literate Agda files, and their corresponding preprocessors. If you add new extensions, remember to update test/Utils.hs so that test cases ending in the new extensions are found.

literateTeX :: Processor Source #

Preprocessor for literate TeX.

literateRsT :: Processor Source #

Preprocessor for reStructuredText.

literateMd Source #

Arguments

:: Bool

The value of optMdOnlyAgdaBlocks.

Controls whether code blocks with no class are interpreted as code (False) or as comments (True).

-> Processor

Preprocessor for Markdown.

literateOrg :: Processor Source #

Preprocessor for Org mode documents.

illiterate :: [Layer] -> Text Source #

Blanks the non-code parts of a given file, preserving positions of characters corresponding to code. This way, there is a direct correspondence between source positions and positions in the processed result.

atomizeLayers :: Layers -> [(LayerRole, Char)] Source #

type Processor = PositionWithoutFile -> Text -> [Layer] Source #

Type of a literate preprocessor: Invariants:

f : Processor

proposition> f pos s /= []

proposition> f pos s >>= layerContent == s

type Layers = [Layer] Source #

A list of contiguous layers.

data Layer Source #

A sequence of characters in a file playing the same role.

Constructors

Layer
Fields layerRole :: LayerRole interval :: IntervalWithoutFile layerContent :: Text

Instances

Instances details

HasRangeWithoutFile Layer Source #
Instance details Defined in Mikan.Syntax.Parser.Literate Methods getRangeWithoutFile :: Layer -> RangeWithoutFile Source #
Show Layer Source #
Instance details Defined in Mikan.Syntax.Parser.Literate Methods showsPrec :: Int -> Layer -> ShowS # show :: Layer -> String # showList :: [Layer] -> ShowS #

data LayerRole Source #

Role of a character in the file.

Constructors

Markup
Comment
Code

Instances

Instances details

Show LayerRole Source #
Instance details Defined in Mikan.Syntax.Parser.Literate Methods showsPrec :: Int -> LayerRole -> ShowS # show :: LayerRole -> String # showList :: [LayerRole] -> ShowS #
Eq LayerRole Source #
Instance details Defined in Mikan.Syntax.Parser.Literate Methods (==) :: LayerRole -> LayerRole -> Bool # (/=) :: LayerRole -> LayerRole -> Bool #

isCode :: LayerRole -> Bool Source #

Returns True if the role corresponds to Agda code.

isCodeLayer :: Layer -> Bool Source #

Returns True if the layer contains Agda code.