Copyright	Copyright (c) 2021-2023 Travis Cardwell
License	MIT
Safe Haskell	Safe-Inferred
Language	Haskell2010

LiterateX.Types

Description

The type modules are generally imported qualified, so the types are re-exported by this module for convenience.

Synopsis

data CodeLanguage
data SourceFormat
data SourceLine
data TargetFormat

Documentation

data CodeLanguage Source #

Source code language

This string is used for syntax highlighting of source code.

When using Pandoc Markdown, run the following command to see a list of supported languages:

$ pandoc --list-highlight-languages

When using GitHub Flavored Markdown, check the following file for supported languages:

https://github.com/github/linguist/blob/master/lib/linguist/languages.yml

Since: 0.0.1.0

Instances

Instances details

IsString CodeLanguage Source #
Instance details Defined in LiterateX.Types.CodeLanguage Methods fromString :: String -> CodeLanguage #
Show CodeLanguage Source #
Instance details Defined in LiterateX.Types.CodeLanguage Methods showsPrec :: Int -> CodeLanguage -> ShowS # show :: CodeLanguage -> String # showList :: [CodeLanguage] -> ShowS #
Eq CodeLanguage Source #
Instance details Defined in LiterateX.Types.CodeLanguage Methods (==) :: CodeLanguage -> CodeLanguage -> Bool # (/=) :: CodeLanguage -> CodeLanguage -> Bool #
Ord CodeLanguage Source #
Instance details Defined in LiterateX.Types.CodeLanguage Methods compare :: CodeLanguage -> CodeLanguage -> Ordering # (<) :: CodeLanguage -> CodeLanguage -> Bool # (<=) :: CodeLanguage -> CodeLanguage -> Bool # (>) :: CodeLanguage -> CodeLanguage -> Bool # (>=) :: CodeLanguage -> CodeLanguage -> Bool # max :: CodeLanguage -> CodeLanguage -> CodeLanguage # min :: CodeLanguage -> CodeLanguage -> CodeLanguage #
Parse CodeLanguage Source #
Instance details Defined in LiterateX.Types.CodeLanguage Methods parse :: (Textual t, Textual e) => t -> Either e CodeLanguage #
Render CodeLanguage Source #
Instance details Defined in LiterateX.Types.CodeLanguage Methods render :: Textual t => CodeLanguage -> t #

data SourceFormat Source #

Source format

This sum type defines the supported source formats.

Since: 0.0.1.0

Instances

Instances details

Bounded SourceFormat Source #
Instance details Defined in LiterateX.Types.SourceFormat Methods minBound :: SourceFormat # maxBound :: SourceFormat #
Enum SourceFormat Source #
Instance details Defined in LiterateX.Types.SourceFormat Methods succ :: SourceFormat -> SourceFormat # pred :: SourceFormat -> SourceFormat # toEnum :: Int -> SourceFormat # fromEnum :: SourceFormat -> Int # enumFrom :: SourceFormat -> [SourceFormat] # enumFromThen :: SourceFormat -> SourceFormat -> [SourceFormat] # enumFromTo :: SourceFormat -> SourceFormat -> [SourceFormat] # enumFromThenTo :: SourceFormat -> SourceFormat -> SourceFormat -> [SourceFormat] #
Show SourceFormat Source #
Instance details Defined in LiterateX.Types.SourceFormat Methods showsPrec :: Int -> SourceFormat -> ShowS # show :: SourceFormat -> String # showList :: [SourceFormat] -> ShowS #
Eq SourceFormat Source #
Instance details Defined in LiterateX.Types.SourceFormat Methods (==) :: SourceFormat -> SourceFormat -> Bool # (/=) :: SourceFormat -> SourceFormat -> Bool #
Ord SourceFormat Source #
Instance details Defined in LiterateX.Types.SourceFormat Methods compare :: SourceFormat -> SourceFormat -> Ordering # (<) :: SourceFormat -> SourceFormat -> Bool # (<=) :: SourceFormat -> SourceFormat -> Bool # (>) :: SourceFormat -> SourceFormat -> Bool # (>=) :: SourceFormat -> SourceFormat -> Bool # max :: SourceFormat -> SourceFormat -> SourceFormat # min :: SourceFormat -> SourceFormat -> SourceFormat #
Parse SourceFormat Source #
Instance details Defined in LiterateX.Types.SourceFormat Methods parse :: (Textual t, Textual e) => t -> Either e SourceFormat #
Render SourceFormat Source #
Instance details Defined in LiterateX.Types.SourceFormat Methods render :: Textual t => SourceFormat -> t #

data SourceLine Source #

Parsed source line

Since: 0.0.1.0

Instances

Instances details

Show SourceLine Source #
Instance details Defined in LiterateX.Types.SourceLine Methods showsPrec :: Int -> SourceLine -> ShowS # show :: SourceLine -> String # showList :: [SourceLine] -> ShowS #

data TargetFormat Source #

Target format

This sum type defines the supported target formats.

Documentation:

Since: 0.2.1.0

Instances

Instances details

Bounded TargetFormat Source #
Instance details Defined in LiterateX.Types.TargetFormat Methods minBound :: TargetFormat # maxBound :: TargetFormat #
Enum TargetFormat Source #
Instance details Defined in LiterateX.Types.TargetFormat Methods succ :: TargetFormat -> TargetFormat # pred :: TargetFormat -> TargetFormat # toEnum :: Int -> TargetFormat # fromEnum :: TargetFormat -> Int # enumFrom :: TargetFormat -> [TargetFormat] # enumFromThen :: TargetFormat -> TargetFormat -> [TargetFormat] # enumFromTo :: TargetFormat -> TargetFormat -> [TargetFormat] # enumFromThenTo :: TargetFormat -> TargetFormat -> TargetFormat -> [TargetFormat] #
Show TargetFormat Source #
Instance details Defined in LiterateX.Types.TargetFormat Methods showsPrec :: Int -> TargetFormat -> ShowS # show :: TargetFormat -> String # showList :: [TargetFormat] -> ShowS #
Eq TargetFormat Source #
Instance details Defined in LiterateX.Types.TargetFormat Methods (==) :: TargetFormat -> TargetFormat -> Bool # (/=) :: TargetFormat -> TargetFormat -> Bool #
Ord TargetFormat Source #
Instance details Defined in LiterateX.Types.TargetFormat Methods compare :: TargetFormat -> TargetFormat -> Ordering # (<) :: TargetFormat -> TargetFormat -> Bool # (<=) :: TargetFormat -> TargetFormat -> Bool # (>) :: TargetFormat -> TargetFormat -> Bool # (>=) :: TargetFormat -> TargetFormat -> Bool # max :: TargetFormat -> TargetFormat -> TargetFormat # min :: TargetFormat -> TargetFormat -> TargetFormat #
Parse TargetFormat Source #
Instance details Defined in LiterateX.Types.TargetFormat Methods parse :: (Textual t, Textual e) => t -> Either e TargetFormat #
Render TargetFormat Source #
Instance details Defined in LiterateX.Types.TargetFormat Methods render :: Textual t => TargetFormat -> t #