Text.Interpolation.Nyan.Core.Internal.Base

Documentation

import Data.Text
import Data.Text.Lazy

Interpolation data

data IntData

Information about single piece that is to be interpolated.

Constructors

IntData

Fields

• idMode :: Text

  How to use the value in the braces. This is some text before the brances, usually one letter or nothing.

• idCode :: Text

  The inserted code. This is what appears in braces.

Instances

Eq IntData

Defined in Text.Interpolation.Nyan.Core.Internal.Base

Methods

(==) :: IntData -> IntData -> Bool

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

Show IntData

Defined in Text.Interpolation.Nyan.Core.Internal.Base

Methods

showsPrec :: Int -> IntData -> ShowS

show :: IntData -> String

showList :: [IntData] -> ShowS

data ParsedIntPiece

Piece of interpolation string.

Constructors

PipString Text

Mere text.

PipNewline Text

Some line feed. This must be preferred over PipString.

PipLeadingWs Word

Whitespaces at the beginning of the line. This must be preferred over PipString.

PipEmptyLine

Line without any text. The line feed is not included here. This must be preferred over PipLeadingWs.

PipInt IntData

Interpolator piece.

Instances

Eq ParsedIntPiece

Defined in Text.Interpolation.Nyan.Core.Internal.Base

Methods

(==) :: ParsedIntPiece -> ParsedIntPiece -> Bool

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

Show ParsedIntPiece

Defined in Text.Interpolation.Nyan.Core.Internal.Base

Methods

showsPrec :: Int -> ParsedIntPiece -> ShowS

show :: ParsedIntPiece -> String

showList :: [ParsedIntPiece] -> ShowS

type ParsedInterpolatedString = [ParsedIntPiece]

data IntPiece

Finalized piece of interpolation string.

Constructors

IpString Text

Mere text.

IpInt IntData

Interpolator piece.

Instances

Eq IntPiece

Defined in Text.Interpolation.Nyan.Core.Internal.Base

Methods

(==) :: IntPiece -> IntPiece -> Bool

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

Show IntPiece

Defined in Text.Interpolation.Nyan.Core.Internal.Base

Methods

showsPrec :: Int -> IntPiece -> ShowS

show :: IntPiece -> String

showList :: [IntPiece] -> ShowS

type InterpolatedString = [IntPiece]

Switches

data ReturnType

Return type of the interpolator.

Constructors

AnyFromBuilder

FromBuilder a => a

ConcreteText

Text

ConcreteLText

Text

ConcreteBuilder

Builder

Instances

Eq ReturnType

Defined in Text.Interpolation.Nyan.Core.Internal.Base

Methods

(==) :: ReturnType -> ReturnType -> Bool

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

Show ReturnType

Defined in Text.Interpolation.Nyan.Core.Internal.Base

Methods

showsPrec :: Int -> ReturnType -> ShowS

show :: ReturnType -> String

showList :: [ReturnType] -> ShowS

data PreviewLevel

Requested preview level.

Constructors

PreviewNone

Do nothing special.

PreviewExact

Print the resulting text as-is (without substitutions).

PreviewInvisible

Print the text, replacing invisible characters with special symbols.

Instances

Bounded PreviewLevel

Defined in Text.Interpolation.Nyan.Core.Internal.Base

Methods

minBound :: PreviewLevel

maxBound :: PreviewLevel

Enum PreviewLevel

Defined in Text.Interpolation.Nyan.Core.Internal.Base

Methods

succ :: PreviewLevel -> PreviewLevel

pred :: PreviewLevel -> PreviewLevel

toEnum :: Int -> PreviewLevel

fromEnum :: PreviewLevel -> Int

enumFrom :: PreviewLevel -> [PreviewLevel]

enumFromThen :: PreviewLevel -> PreviewLevel -> [PreviewLevel]

enumFromTo :: PreviewLevel -> PreviewLevel -> [PreviewLevel]

enumFromThenTo :: PreviewLevel -> PreviewLevel -> PreviewLevel -> [PreviewLevel]

Eq PreviewLevel

Defined in Text.Interpolation.Nyan.Core.Internal.Base

Methods

(==) :: PreviewLevel -> PreviewLevel -> Bool

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

Show PreviewLevel

Defined in Text.Interpolation.Nyan.Core.Internal.Base

Methods

showsPrec :: Int -> PreviewLevel -> ShowS

show :: PreviewLevel -> String

showList :: [PreviewLevel] -> ShowS

data SwitchesOptions

All switches options.

Constructors

SwitchesOptions

Fields

• spacesTrimming :: Bool
• indentationStripping :: Bool
• leadingNewlineStripping :: Bool
• trailingSpacesStripping :: Bool
• returnType :: ReturnType
• reducedNewlines :: Bool
• monadic :: Bool
• previewLevel :: PreviewLevel

Instances

Eq SwitchesOptions

Defined in Text.Interpolation.Nyan.Core.Internal.Base

Methods

(==) :: SwitchesOptions -> SwitchesOptions -> Bool

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

Show SwitchesOptions

Defined in Text.Interpolation.Nyan.Core.Internal.Base

Methods

showsPrec :: Int -> SwitchesOptions -> ShowS

show :: SwitchesOptions -> String

showList :: [SwitchesOptions] -> ShowS

data DefaultSwitchesOptions

Default switches options set in the interpolator, those that are used in [int||...|].

When no default value for a switch is specified, this switch is left mandatory for specifying in the interpolator.

Constructors

DefaultSwitchesOptions

Fields

• defSpacesTrimming :: Maybe Bool
• defIndentationStripping :: Maybe Bool
• defLeadingNewlineStripping :: Maybe Bool
• defTrailingSpacesStripping :: Maybe Bool
• defReducedNewlines :: Maybe Bool
• defReturnType :: Maybe ReturnType
• defMonadic :: Maybe Bool

Instances

Show DefaultSwitchesOptions

Defined in Text.Interpolation.Nyan.Core.Internal.Base

Methods

showsPrec :: Int -> DefaultSwitchesOptions -> ShowS

show :: DefaultSwitchesOptions -> String

showList :: [DefaultSwitchesOptions] -> ShowS

basicDefaultSwitchesOptions :: DefaultSwitchesOptions

Default DefaultSwitchesOptions.

This set of switches tries to leave the text as much unmodified as possible.

It does not define default switches used by Text.Interpolation.Nyan module, and you will likely want to enable at least some options here.

recommendedDefaultSwitchesOptions :: DefaultSwitchesOptions

DefaultSwitchesOptions used in the Text.Interpolation.Nyan module in the default interpolator.

newtype ValueInterpolator

How to expand values in #{} into Haskell AST.

Constructors

ValueInterpolator

Fields

• runValueInterpolator :: Text -> ExpQ

newtype InvisibleCharsPreview

Transformation that describes how to mark the invisible characters.

Use Monoid instance to sequence multiple such transformations.

Constructors

InvisibleCharsPreview

Fields

• replaceInvisibleChars :: String -> String

Instances

Semigroup InvisibleCharsPreview

Defined in Text.Interpolation.Nyan.Core.Internal.Base

Methods

(<>) :: InvisibleCharsPreview -> InvisibleCharsPreview -> InvisibleCharsPreview

sconcat :: NonEmpty InvisibleCharsPreview -> InvisibleCharsPreview

stimes :: Integral b => b -> InvisibleCharsPreview -> InvisibleCharsPreview

Monoid InvisibleCharsPreview

Defined in Text.Interpolation.Nyan.Core.Internal.Base

Methods

mempty :: InvisibleCharsPreview

mappend :: InvisibleCharsPreview -> InvisibleCharsPreview -> InvisibleCharsPreview

mconcat :: [InvisibleCharsPreview] -> InvisibleCharsPreview

data InterpolatorOptions

Options set when creating an interpolator.

Constructors

InterpolatorOptions

Fields

• defaultSwitchesOptions :: DefaultSwitchesOptions

  Default switches options.

• valueInterpolator :: ValueInterpolator

  Expands text in #{} into AST.

  We have to leave this changeable because there is no "perfect" expander. Using the most appropriate one would require relying on haskell-src-exts package which is quite a heavy-weight dependency. Some users would prefer a simpler solution which would only allow variables in #{}.

  Interpreting the passed text in tricky ways is valid. For instance, for specialized interpolators #{var} could be expanded to local'var, view varLens, or more complex Haskell code.

• invisibleCharsPreview :: InvisibleCharsPreview

  In case, when the switches are set to preview the resulting text with invisibles being marked specially (!!), how to update the pieces of text.