Exon.Class.Exon

Documentation

newtype SkipWs a

Wrapping a quote type with this causes whitespace to be ignored.

Since: 1.0.0.0

Constructors

SkipWs a

Instances

IsString a => IsString (SkipWs a)

Defined in Exon.Class.Exon

Methods

fromString :: String -> SkipWs a

Generic (SkipWs a)

Defined in Exon.Class.Exon

Associated Types

type Rep (SkipWs a) :: Type -> Type

Methods

from :: SkipWs a -> Rep (SkipWs a) x

to :: Rep (SkipWs a) x -> SkipWs a

Show a => Show (SkipWs a)

Defined in Exon.Class.Exon

Methods

showsPrec :: Int -> SkipWs a -> ShowS

show :: SkipWs a -> String

showList :: [SkipWs a] -> ShowS

Eq a => Eq (SkipWs a)

Defined in Exon.Class.Exon

Methods

(==) :: SkipWs a -> SkipWs a -> Bool

(/=) :: SkipWs a -> SkipWs a -> Bool

IsString builder => ExonString (SkipWs result) builder

The instance used when the result type is wrapped in SkipWs, which is done by intron.

It returns Empty for any whitespace.

Defined in Exon.Class.Exon

Methods

exonString :: String -> Result builder

exonWhitespace :: String -> Result builder

type Rep (SkipWs a)

Defined in Exon.Class.Exon

type Rep (SkipWs a) = D1 ('MetaData "SkipWs" "Exon.Class.Exon" "exon-1.1.0.0-FaDJAaYUpCcmICmdLf4NV" 'True) (C1 ('MetaCons "SkipWs" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

skipWs :: SkipWs a -> a

Defined separately because TH chokes on the selector.

Since: 1.0.0.0

newtype ExonUse a

Wrapping a quote type with this causes a to be used irrespective of whether it is an unwrappable newtype.

Since: 1.0.0.0

Constructors

ExonUse

Fields

• exonUse :: a

Instances

IsString a => IsString (ExonUse a)

Defined in Exon.Class.Exon

Methods

fromString :: String -> ExonUse a

Show a => Show (ExonUse a)

Defined in Exon.Class.Exon

Methods

showsPrec :: Int -> ExonUse a -> ShowS

show :: ExonUse a -> String

showList :: [ExonUse a] -> ShowS

Eq a => Eq (ExonUse a)

Defined in Exon.Class.Exon

Methods

(==) :: ExonUse a -> ExonUse a -> Bool

(/=) :: ExonUse a -> ExonUse a -> Bool

ExonBuilder a builder => ExonBuilder (ExonUse a) builder

Defined in Exon.Class.Exon

Methods

exonBuilder :: ExonUse a -> builder

exonBuilderExtract :: Result builder -> ExonUse a

class ExonBuilder (inner :: Type) (builder :: Type) | inner -> builder where

This class converts a segment into a builder.

A builder is an auxiliary data type that may improve performance when concatenating segments, like Builder. The default instance uses no builder and is implemented as id.

Since: 1.0.0.0

Methods

exonBuilder :: inner -> builder

Construct a builder from the newtype-unwrapped result type.

exonBuilderExtract :: Result builder -> inner

Convert the result of the builder concatenation back to the newtype-unwrapped result type.

Instances

ExonBuilder ByteString Builder

Defined in Exon.Class.Exon

Methods

exonBuilder :: ByteString -> Builder

exonBuilderExtract :: Result Builder -> ByteString

ExonBuilder LByteString Builder

Defined in Exon.Class.Exon

Methods

exonBuilder :: LByteString -> Builder

exonBuilderExtract :: Result Builder -> LByteString

ExonBuilder LText Builder

Defined in Exon.Class.Exon

Methods

exonBuilder :: LText -> Builder

exonBuilderExtract :: Result Builder -> LText

ExonBuilder Text Builder

Defined in Exon.Class.Exon

Methods

exonBuilder :: Text -> Builder

exonBuilderExtract :: Result Builder -> Text

(Monoid builder, result ~ builder) => ExonBuilder result builder

Defined in Exon.Class.Exon

Methods

exonBuilder :: result -> builder

exonBuilderExtract :: Result builder -> result

ExonBuilder a builder => ExonBuilder (ExonUse a) builder

Defined in Exon.Class.Exon

Methods

exonBuilder :: ExonUse a -> builder

exonBuilderExtract :: Result builder -> ExonUse a

class ExonString (result :: Type) (builder :: Type) where

This class generalizes IsString for use in ExonSegment.

When a plain text segment (not interpolated) is processed, it is converted to the result type, which usually happens via fromString.

For the type of showsPrec (String -> String), there is no instance of IsString, so this class provides an instance that works around that by calling showString.

Since: 1.0.0.0

Minimal complete definition

Nothing

Methods

exonString :: String -> Result builder

Convert a String to the builder type.

default exonString :: IsString builder => String -> Result builder

exonWhitespace :: String -> Result builder

Convert a String containing whitespace to the builder type. This is only used by whitespace-aware quoters, like exonws or intron.

default exonWhitespace :: String -> Result builder

Instances

IsString a => ExonString result a

Defined in Exon.Class.Exon

Methods

exonString :: String -> Result a

exonWhitespace :: String -> Result a

ExonString result (String -> String)

The instance for the type used by showsPrec.

Defined in Exon.Class.Exon

Methods

exonString :: String -> Result (String -> String)

exonWhitespace :: String -> Result (String -> String)

IsString builder => ExonString (SkipWs result) builder

The instance used when the result type is wrapped in SkipWs, which is done by intron.

It returns Empty for any whitespace.

Defined in Exon.Class.Exon

Methods

exonString :: String -> Result builder

exonWhitespace :: String -> Result builder

class ExonSegment (result :: Type) (builder :: Type) where

This class converts a Segment to a builder.

The default implementation performs the following conversions for the differnet segment variants:

• Segment.String and Segment.Whitespace are plain Strings parsed literally from the quasiquote. They are converted to the builder type by fromString (handled by ExonString).
• Segment.Whitespace is ignored when the quoter intron was used.
• Segment.Expression contains a value of the builder type, which is returned as-is.

Since: 1.0.0.0

Methods

exonSegment :: Segment builder -> Result builder

Convert literal string segments to the result type.

Instances

ExonString result builder => ExonSegment result builder

Defined in Exon.Class.Exon

Methods

exonSegment :: Segment builder -> Result builder

class ExonAppend (result :: Type) (builder :: Type) where

This class handles concatenation of segments, which might be a builder or the result type.

The default instance simply uses (<>), and there is only one special instance for String -> String, the type used by showsPrec.

Since: 1.0.0.0

Minimal complete definition

exonAppend

Methods

exonAppend :: builder -> builder -> Result builder

Concatenate two segments of the builder type.

exonConcat :: NonEmpty (Result builder) -> Result builder

Concatenate a list of segments of the result type.

Folds the list over exonAppend, skipping over Empty segments.

A possible overload may implement lookahead to skip whitespace.

Since: 1.1.0.0

Instances

Semigroup builder => ExonAppend result builder

Defined in Exon.Class.Exon

Methods

exonAppend :: builder -> builder -> Result builder

exonConcat :: NonEmpty (Result builder) -> Result builder

ExonAppend result (String -> String)

Defined in Exon.Class.Exon

Methods

exonAppend :: (String -> String) -> (String -> String) -> Result (String -> String)

exonConcat :: NonEmpty (Result (String -> String)) -> Result (String -> String)

class ExonBuild (result :: Type) (inner :: Type) where

This class implements the Segment concatenation logic.

1. Each Expression is converted to the builder type by ExonBuilder.
2. Each String and Whitespace is converted to the builder type by ExonSegment and ExonString.
3. The segments are folded over ExonAppend.
4. The result is converted from the builder type to the original type by ExonBuilder.

Each step may be overridden individually

Since: 1.0.0.0

Methods

exonBuild :: NonEmpty (Segment inner) -> inner

Concatenate a list of Segments.

Instances

(ExonAppend result builder, ExonSegment result builder, ExonBuilder inner builder) => ExonBuild result inner

Defined in Exon.Class.Exon

Methods

exonBuild :: NonEmpty (Segment inner) -> inner

class Exon (result :: Type) where

This class is the main entry point for Exon.

The default instance unwraps all newtypes that are Generic and passes the innermost type to ExonBuild.

The original type is also used as a parameter to ExonBuild, so customizations can be based on it.

Methods

exonProcess :: NonEmpty (Segment result) -> result

Concatenate a list of Segments.

Since: 1.0.0.0

Instances

(OverNewtypes result inner, ExonBuild result inner) => Exon result

Defined in Exon.Class.Exon

Methods

exonProcess :: NonEmpty (Segment result) -> result

exonProcessWith :: forall wrapped result. Exon wrapped => (result -> wrapped) -> (wrapped -> result) -> NonEmpty (Segment result) -> result

Call exonProcess, but unwrap the arguments and rewrap the result using the supplied functions.

Since: 1.0.0.0