-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Convert between Haskell, Markdown, Literate Haskell, TeX -- -- See the README.md @package lima @version 0.2.0.0 -- |

Terms

-- --

format - specific encoding of some information. See -- Format.
document - Text in a specific format, e.g., -- Haskell (.hs) file.
document block - consecutive lines of a document.
Token - a representation of a document block as a -- Haskell type.
Tokens - a list of Tokens.
parser - a function that reads a document line by line -- and converts it to Tokens. Example: hsToTokens.
printer - a function that converts Tokens to a -- document. Example: hsFromTokens.
tag - a marker that affects how Tokens are -- parsed.
- Each parser recognizes tags of a specific -- form.
- Tags can be represented as a wrapper and a name.E.g., in -- '% LIMA_DISABLE some text', a TeX tag, the wrapper -- is '% ' and the name is 'LIMA_DISABLE some -- text'.
- Parsers recognize the tag names that start -- with tag names specified in a Config.E.g., in the example -- above, a parser will recognize the _disable tag and will become -- disabled.
- When a parser is disabled, it copies lines verbatim -- into a Disabled Token and doesn't recognize any tags -- until it finds an _enable tag.

-- --

Assumptions

-- -- The following assumptions must hold for outputs of parsers and inputs -- of printers: -- --

Tokens are in the same order as the corresponding blocks of -- document.

Lines inside Tokens are reversed compared to the document. -- Example:

Literate Haskell document:
```
line 1 line 2
--   % line 3 % line 4 
```

Corresponding Tokens:

[
--   Text {manyLines = ["line2","line 1"]}, Comment {someLines = "line 4"
--   :| ["", "line 3"]} ]

There are no leading or trailing empty lines inside of -- Tokens.

module Converter -- | Calculates the mode for data. type family Mode a b -- | Marks data supplied by a user. type User = 'User -- | Marks data for internal usage. type Internal = 'Internal -- | Configuration of tag names. -- -- Here are the default names. -- --

--   >>> pp (def :: Config User)
--   Config {
--     _disable = Just "LIMA_DISABLE",
--     _enable = Just "LIMA_ENABLE",
--     _indent = Just "LIMA_INDENT",
--     _dedent = Just "LIMA_DEDENT",
--     _mdHaskellCodeStart = Just "```haskell",
--     _mdHaskellCodeEnd = Just "```",
--     _texHaskellCodeStart = Just "\\begin{code}",
--     _texHaskellCodeEnd = Just "\\end{code}"
--   }
--

-- -- It's possible to override these names. -- --

--   >>> pp ((def :: Config User) & disable ?~ "off" & enable ?~ "on" & indent ?~ "indent" & dedent ?~ "dedent")
--   Config {
--     _disable = Just "off",
--     _enable = Just "on",
--     _indent = Just "indent",
--     _dedent = Just "dedent",
--     _mdHaskellCodeStart = Just "```haskell",
--     _mdHaskellCodeEnd = Just "```",
--     _texHaskellCodeStart = Just "\\begin{code}",
--     _texHaskellCodeEnd = Just "\\end{code}"
--   }
--

data Config (a :: Mode') Config :: Mode a Text -> Mode a Text -> Mode a Text -> Mode a Text -> Mode a Text -> Mode a Text -> Mode a Text -> Mode a Text -> Config (a :: Mode') -- | Make parser ignore tags and just copy the following lines verbatim. -- -- Set indentation to 0. [$sel:_disable:Config] :: Config (a :: Mode') -> Mode a Text -- | Stop parser from ignoring tags. [$sel:_enable:Config] :: Config (a :: Mode') -> Mode a Text -- | Set code indentation to a given Int. [$sel:_indent:Config] :: Config (a :: Mode') -> Mode a Text -- | Set code indentation to 0. [$sel:_dedent:Config] :: Config (a :: Mode') -> Mode a Text -- | Mark the start of a Haskell code block in Markdown. [$sel:_mdHaskellCodeStart:Config] :: Config (a :: Mode') -> Mode a Text -- | Mark the end of a Haskell code block in Markdown. [$sel:_mdHaskellCodeEnd:Config] :: Config (a :: Mode') -> Mode a Text -- | Mark the start of a Haskell code block in TeX. [$sel:_texHaskellCodeStart:Config] :: Config (a :: Mode') -> Mode a Text -- | Mark the end of a Haskell code block in TeX. [$sel:_texHaskellCodeEnd:Config] :: Config (a :: Mode') -> Mode a Text -- | The default value for this type. def :: Default a => a -- | Convert a user Config to an internal Config with -- user-supplied values. toInternalConfig :: Config User -> Config Internal -- | Make a user Config with default values from an internal -- Config. fromInternalConfig :: Config Internal -> Config User disable :: forall a_a70q. Lens' (Config a_a70q) (Mode a_a70q Text) enable :: forall a_a70q. Lens' (Config a_a70q) (Mode a_a70q Text) indent :: forall a_a70q. Lens' (Config a_a70q) (Mode a_a70q Text) dedent :: forall a_a70q. Lens' (Config a_a70q) (Mode a_a70q Text) mdHaskellCodeStart :: forall a_a70q. Lens' (Config a_a70q) (Mode a_a70q Text) mdHaskellCodeEnd :: forall a_a70q. Lens' (Config a_a70q) (Mode a_a70q Text) texHaskellCodeStart :: forall a_a70q. Lens' (Config a_a70q) (Mode a_a70q Text) texHaskellCodeEnd :: forall a_a70q. Lens' (Config a_a70q) (Mode a_a70q Text) -- | & is a reverse application operator. This provides -- notational convenience. Its precedence is one higher than that of the -- forward application operator $, which allows & to be -- nested in $. -- --

--   >>> 5 & (+1) & show
--   "6"
--

(&) :: a -> (a -> b) -> b infixl 1 & -- | (?~) is a version of (.~) that wraps the value into -- Just before setting. -- --

--   l ?~ b = l .~ Just b
--

-- -- It can be useful in combination with at: -- --

--   >>> Map.empty & at 3 ?~ x
--   fromList [(3,x)]
--

(?~) :: ASetter s t a (Maybe b) -> b -> s -> t infixr 4 ?~ -- | A format of a document. data Format -- |

--   Haskell
--

Hs :: Format -- |

--   Literate Haskell
--

Lhs :: Format -- |

--   Markdown
--

Md :: Format -- |

--   TeX
--

TeX :: Format -- | Compose a function that converts a document in one Format to a -- document in another Format. convertTo :: Format -> Format -> Config User -> Text -> Text -- | Show a Format as a file extension. -- --

--   >>> showFormatExtension Lhs
--   "lhs"
--

showFormatExtension :: Format -> String -- | Show a Format as a full name. -- --

--   >>> showFormatName Lhs
--   "Literate Haskell"
--

showFormatName :: Format -> String -- | Internal representation of a document. -- -- A printer processes a list of Tokens one by one. -- -- A Token can have: -- --

Action - how this Token affects the subsequent -- Tokens.
Target - a type of Tokens that are affected by this -- Token.
Range - the nearest Token until which this Token -- affects the subsequent Tokens.

data Token -- |

Action: set indentation to n.
Target: HaskellCode.
Range: until Indent, Dedent, or -- Disabled.

Indent :: Int -> Token [$sel:n:Indent] :: Token -> Int -- |

Action: set indentation to 0.
Target: HaskellCode.
Range: until Indent, Dedent, or -- Disabled.

Dedent :: Token -- | A block that should be invisible when rendered outside of -- .hs. -- --

Action: set indentation to 0.
Target: HaskellCode.
Range: until Indent, Dedent, or -- Disabled.

Disabled :: [Text] -> Token [$sel:manyLines:Indent] :: Token -> [Text] -- | Lines copied verbatim while a parser was in a Haskell code -- block. HaskellCode :: [Text] -> Token [$sel:manyLines:Indent] :: Token -> [Text] -- | Lines copied verbatim while a parser was in a text block. Text :: NonEmpty Text -> Token [$sel:someLines:Indent] :: Token -> NonEmpty Text -- | Lines copied verbatim while a parser was in a comment block. Comment :: NonEmpty Text -> Token [$sel:someLines:Indent] :: Token -> NonEmpty Text -- | A list of Tokens. type Tokens = [Token] -- | Select a printer function based on a given format. selectFromTokens :: Config User -> Format -> Tokens -> Text -- | Select a parser function based on a given format. selectToTokens :: Config User -> Format -> Text -> Tokens -- | Merge specific consecutive Tokens. -- --

--   >>> pp exampleNonTexTokens'
--   [
--     Indent {n = 3},
--     Disabled {manyLines = ["-- What's the answer?"]},
--     Indent {n = 1},
--     Indent {n = 2},
--     Text {someLines = "- Intermediate results" :| []},
--     HaskellCode {manyLines = ["   b = a 4","   a = const 3"]},
--     Dedent,
--     HaskellCode {manyLines = ["answer = b * 14"]},
--     Comment {someLines = "Hello from comments," :| []},
--     Comment {someLines = "world!" :| []},
--     Text {someLines = "world!" :| ["Hello from text,"]},
--     Text {someLines = "here!" :| ["And from"]}
--   ]
--

-- --

--   >>> pp $ mergeTokens exampleNonTexTokens'
--   [
--     Indent {n = 3},
--     Disabled {manyLines = ["-- What's the answer?"]},
--     Indent {n = 1},
--     Indent {n = 2},
--     Text {someLines = "- Intermediate results" :| []},
--     HaskellCode {manyLines = ["   b = a 4","   a = const 3"]},
--     Dedent,
--     HaskellCode {manyLines = ["answer = b * 14"]},
--     Comment {someLines = "world!" :| ["","Hello from comments,"]},
--     Text {someLines = "here!" :| ["And from","","world!","Hello from text,"]}
--   ]
--

mergeTokens :: Tokens -> Tokens -- | Strip empty lines an leading spaces in Tokens. -- --

Remove empty lines in Tokens.
Shift lines in HaskellCode to the left by the minimal -- number of leading spaces in nonempty lines.

-- --

--   >>> pp exampleNonTexTokens'
--   [
--     Indent {n = 3},
--     Disabled {manyLines = ["-- What's the answer?"]},
--     Indent {n = 1},
--     Indent {n = 2},
--     Text {someLines = "- Intermediate results" :| []},
--     HaskellCode {manyLines = ["   b = a 4","   a = const 3"]},
--     Dedent,
--     HaskellCode {manyLines = ["answer = b * 14"]},
--     Comment {someLines = "Hello from comments," :| []},
--     Comment {someLines = "world!" :| []},
--     Text {someLines = "world!" :| ["Hello from text,"]},
--     Text {someLines = "here!" :| ["And from"]}
--   ]
--

-- --

--   >>> pp $ stripTokens exampleNonTexTokens'
--   [
--     Indent {n = 3},
--     Disabled {manyLines = ["-- What's the answer?"]},
--     Indent {n = 1},
--     Indent {n = 2},
--     Text {someLines = "- Intermediate results" :| []},
--     HaskellCode {manyLines = ["b = a 4","a = const 3"]},
--     Dedent,
--     HaskellCode {manyLines = ["answer = b * 14"]},
--     Comment {someLines = "Hello from comments," :| []},
--     Comment {someLines = "world!" :| []},
--     Text {someLines = "world!" :| ["Hello from text,"]},
--     Text {someLines = "here!" :| ["And from"]}
--   ]
--

stripTokens :: Tokens -> Tokens -- | mergeTokens and stripTokens. -- --

--   >>> pp $ normalizeTokens exampleNonTexTokens
--   [
--     Indent {n = 3},
--     Disabled {manyLines = ["-- What's the answer?"]},
--     Indent {n = 1},
--     Indent {n = 2},
--     Text {someLines = "- Intermediate results" :| []},
--     HaskellCode {manyLines = ["b = a 4","a = const 3"]},
--     Dedent,
--     HaskellCode {manyLines = ["answer = b * 14"]},
--     Comment {someLines = "world!" :| ["","Hello from comments,"]},
--     Text {someLines = "here!" :| ["And from","","world!","Hello from text,"]}
--   ]
--

normalizeTokens :: Tokens -> Tokens -- | Convert Tokens to Haskell code. -- -- Rules -- --

Certain assumptions must hold for inputs.
These are the relations between document blocks and tokens when -- the default Config values are used.
- '{- LIMA_INDENT -- N -}' (N is an Int) ~ -- Indent.
- '{- LIMA_DEDENT -}' ~ -- Dedent.
- Lines between and including '{- -- LIMA_DISABLE -}' and '{- LIMA_ENABLE -}' ~ -- Disabled.
- Multiline comment starting with -- '{-\n' ~ Text.
```
{- line 1 -}
--   
```
  - Consecutive Texts are merged into a single -- Text.
  - There must be at list one nonempty line inside -- this comment.
- Multiline comment starting with -- '{- ' where text is nonempty text ~ -- Comment.
```
{- line 1 line 2 -} 
```
  - Consecutive -- Comments are merged into a single -- Comment.
- Other lines ~ -- HaskellCode.
```
a = 42 
```

-- --

Example

-- --

--   >>> pp $ hsFromTokens def exampleNonTexTokens
--   {- LIMA_INDENT 3 -}
--   
--   {- LIMA_DISABLE -}
--   
--   -- What's the answer?
--   
--   {- LIMA_ENABLE -}
--   
--   {- LIMA_INDENT 1 -}
--   
--   {- LIMA_INDENT 2 -}
--   
--   {-
--   - Intermediate results
--   -}
--   
--   a = const 3
--   b = a 4
--   
--   {- LIMA_DEDENT -}
--   
--   answer = b * 14
--   
--   {- Hello from comments,
--   
--   world!
--   -}
--   
--   {-
--   Hello from text,
--   world!
--   
--   And from
--   here!
--   -}
--

hsFromTokens :: Config User -> Tokens -> Text -- | Convert Tokens to Haskell code. -- -- Each Token becomes a Text in a list. -- -- These Texts are concatenated in hsFromTokens. hsFromTokens' :: Config User -> Tokens -> [Text] -- | Convert Tokens to Literate Haskell code. -- -- Rules -- --

Certain assumptions must hold for inputs.
These are the relations between document blocks and tokens when -- the default Config values are used.
- '% LIMA_INDENT -- N' (N is an Int) ~ Indent.
- '% -- LIMA_DEDENT' ~ Dedent.
- Lines between and including -- '% LIMA_DISABLE' and '% LIMA_ENABLE' ~ -- Disabled.
  - There must be at least one nonempty line -- between these tags.
- Consecutive lines, either empty -- or starting with '% ' ~ Comment.
```
% Hello, % world!
--   % Hello, % user! 
```
  - At least one line must have nonempty -- text after '% '
- Consecutive lines starting -- with '> ' ~ HaskellCode.
```
> a4 = 4 > a2 =
--   2 
```
- Other lines ~ Text.

-- --

Example

-- --

--   >>> pp $ lhsFromTokens def exampleNonTexTokens
--   % LIMA_INDENT 3
--   
--   % LIMA_DISABLE
--   
--   % -- What's the answer?
--   
--   % LIMA_ENABLE
--   
--   % LIMA_INDENT 1
--   
--   % LIMA_INDENT 2
--   
--   - Intermediate results
--   >   a = const 3
--   >   b = a 4
--   
--   % LIMA_DEDENT
--   
--   > answer = b * 14
--   
--   % Hello from comments,
--   
--   % world!
--   
--   Hello from text,
--   world!
--   
--   And from
--   here!
--

lhsFromTokens :: Config User -> Tokens -> Text -- | Convert Tokens to Literate Haskell code. -- -- Each Token becomes a Text in a list. -- -- These Texts are concatenated in lhsFromTokens. lhsFromTokens' :: Config User -> Tokens -> [Text] -- | Convert Tokens to Markdown code. -- -- Rules -- --

Certain assumptions must hold for inputs.
These are the relations between document blocks and tokens when -- the default Config values are used.
- '' (N is an Int) ~ -- Indent
- '' ~ -- Dedent.
- Multiline comment starting with '' ~ -- Disabled.
```
 
```
- Multiline comments starting with '
--   
```
  - Consecutive Comments are merged into a single -- Comment.
- Possibly indented block starting -- with '```haskell' and ending with '```' ~ -- HaskellCode.
```
 ```haskell a4 = 2 ``` 
```
- Other -- lines ~ Text.
```
Hello, world! 
```

-- --

Example

-- --

--   >>> pp $ mdFromTokens def exampleNonTexTokens
--      <!-- LIMA_INDENT 3 -->
--   
--   <!-- LIMA_DISABLE
--   
--   -- What's the answer?
--   
--   LIMA_ENABLE -->
--   
--    <!-- LIMA_INDENT 1 -->
--   
--     <!-- LIMA_INDENT 2 -->
--   
--   - Intermediate results
--   
--     ```haskell
--     a = const 3
--     b = a 4
--     ```
--   
--   <!-- LIMA_DEDENT -->
--   
--   ```haskell
--   answer = b * 14
--   ```
--   
--   <!-- Hello from comments,
--   
--   world!
--   -->
--   
--   Hello from text,
--   world!
--   
--   And from
--   here!
--

mdFromTokens :: Config User -> Tokens -> Text -- | Convert Tokens to Haskell code. -- -- Each Token becomes a Text in a list. -- -- These Texts are concatenated in mdFromTokens. mdFromTokens' :: Config User -> Tokens -> [Text] -- | Convert Tokens to TeX code. -- -- Rules -- --

Certain assumptions must hold for inputs.
These are the relations between document blocks and tokens when -- the default Config values are used.
- '% LIMA_INDENT -- N' (N is an Int) ~ Indent
- '% -- LIMA_DEDENT' ~ Dedent.
- Lines between and including -- '% LIMA_DISABLE' and '% LIMA_ENABLE' ~ -- Disabled.
- Consecutive lines, either empty or starting -- with '% ' ~ Comment.
```
% Hello, % world! % Hello, %
--   user! 
```
  - At least one line must have nonempty text after -- '% '
- Lines between possibly indented tags -- '\begin{code}' and '\end{code}' ~ -- HaskellCode.
- Other lines ~ Text.

-- --

Example

-- --

--   >>> pp $ texFromTokens def exampleTexTokens
--   % LIMA_DISABLE
--   
--   % -- What's the answer?
--   
--   % LIMA_ENABLE
--   
--   % LIMA_INDENT 1
--   
--   % LIMA_INDENT 2
--   
--   Intermediate results
--   
--   \begin{code}
--     a = const 3
--     b = a 4
--   \end{code}
--   
--   % LIMA_DEDENT
--   
--   \begin{code}
--   answer = b * 14
--   \end{code}
--   
--   % Hello from comments,
--   
--   % world!
--   
--   Hello from text,
--   world!
--

texFromTokens :: Config User -> Tokens -> Text -- | Convert Tokens to TeX code. -- -- Each Token becomes a Text in a list. -- -- These Texts are concatenated in texFromTokens. texFromTokens' :: Config User -> Tokens -> [Text] -- | Convert Tokens to Markdown code. -- -- Inverse of lhsFromTokens. -- --

--   >>> (lhsToTokens def $ lhsFromTokens def exampleNonTexTokens) == exampleNonTexTokens
--   True
--

lhsToTokens :: Config User -> Text -> Tokens -- | Convert Tokens to Haskell code. -- -- Inverse of hsFromTokens. -- --

--   >>> (hsToTokens def $ hsFromTokens def exampleNonTexTokens) == exampleNonTexTokens
--   True
--

hsToTokens :: Config User -> Text -> Tokens -- | Convert Tokens to TeX code. -- -- Inverse of texFromTokens. -- --

--   >>> (texToTokens def $ texFromTokens def exampleTexTokens) == exampleTexTokens
--   True
--

texToTokens :: Config User -> Text -> Tokens -- | Convert Tokens to Markdown code. -- -- Inverse of mdFromTokens. -- --

--   >>> (mdToTokens def $ mdFromTokens def exampleNonTexTokens) == exampleNonTexTokens
--   True
--

mdToTokens :: Config User -> Text -> Tokens -- | Example non-TeX Tokens. See exampleTexTokens. -- -- When printed to a TeX document, these Tokens can't be -- correctly parsed. This is because they don't have necessary tags -- surrounding Haskell code blocks. -- --

--   >>> pp $ exampleNonTexTokens'
--   [
--     Indent {n = 3},
--     Disabled {manyLines = ["-- What's the answer?"]},
--     Indent {n = 1},
--     Indent {n = 2},
--     Text {someLines = "- Intermediate results" :| []},
--     HaskellCode {manyLines = ["   b = a 4","   a = const 3"]},
--     Dedent,
--     HaskellCode {manyLines = ["answer = b * 14"]},
--     Comment {someLines = "Hello from comments," :| []},
--     Comment {someLines = "world!" :| []},
--     Text {someLines = "world!" :| ["Hello from text,"]},
--     Text {someLines = "here!" :| ["And from"]}
--   ]
--

exampleNonTexTokens' :: Tokens -- | Normalized exampleNonTexTokens'. -- --

--   >>> pp $ exampleNonTexTokens
--   [
--     Indent {n = 3},
--     Disabled {manyLines = ["-- What's the answer?"]},
--     Indent {n = 1},
--     Indent {n = 2},
--     Text {someLines = "- Intermediate results" :| []},
--     HaskellCode {manyLines = ["b = a 4","a = const 3"]},
--     Dedent,
--     HaskellCode {manyLines = ["answer = b * 14"]},
--     Comment {someLines = "world!" :| ["","Hello from comments,"]},
--     Text {someLines = "here!" :| ["And from","","world!","Hello from text,"]}
--   ]
--

exampleNonTexTokens :: Tokens -- | same as exampleNonTexTokens, but with TeX-specific -- tags that make Haskell code blocks correctly parsable. -- --

--   >>> pp $ exampleTexTokens
--   [
--     Disabled {manyLines = ["-- What's the answer?"]},
--     Indent {n = 1},
--     Indent {n = 2},
--     Text {someLines = "\\begin{code}" :| ["","Intermediate results"]},
--     HaskellCode {manyLines = ["b = a 4","a = const 3"]},
--     Text {someLines = "\\end{code}" :| []},
--     Dedent,
--     Text {someLines = "\\begin{code}" :| []},
--     HaskellCode {manyLines = ["answer = b * 14"]},
--     Text {someLines = "\\end{code}" :| []},
--     Comment {someLines = "world!" :| ["","Hello from comments,"]},
--     Text {someLines = "world!" :| ["Hello from text,"]}
--   ]
--

exampleTexTokens :: Tokens -- | Remove empty lines from the beginning and the end of a list. stripEmpties :: [Text] -> [Text] -- | A class for prettyprinting data on multiple lines in haddocks. -- -- It's not meant to be used outside of this library. class Show a => PrettyPrint a pp :: PrettyPrint a => a -> Pretty String instance GHC.Classes.Eq Converter.Token instance Data.Data.Data Converter.Token instance GHC.Show.Show Converter.Token instance GHC.Generics.Generic Converter.State instance GHC.Show.Show (Converter.Config Converter.User) instance GHC.Classes.Eq (Converter.Config Converter.User) instance GHC.Show.Show (Converter.Config Converter.Internal) instance Data.Default.Class.Default Converter.State instance Converter.PrettyPrint Converter.Tokens instance Converter.PrettyPrint GHC.Base.String instance Converter.PrettyPrint Data.Text.Internal.Text instance Converter.PrettyPrint (Converter.Config Converter.User) instance GHC.Show.Show a => GHC.Show.Show (Converter.Pretty a) instance Data.Default.Class.Default (Converter.Config Converter.Internal) instance Data.Default.Class.Default (Converter.Config Converter.User) instance GHC.Generics.Generic (Converter.Config a)