Prosidy.Types

Documents

data Document

A full Prosidy document.

Constructors

Document

Fields

• documentMetadata :: Metadata
• documentContent :: Series Block

Instances

Eq Document

Defined in Prosidy.Types

Methods

(==) :: Document -> Document -> Bool

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

Show Document

Defined in Prosidy.Types

Methods

showsPrec :: Int -> Document -> ShowS

show :: Document -> String

showList :: [Document] -> ShowS

Generic Document

Defined in Prosidy.Types

Associated Types

type Rep Document :: Type -> Type

Methods

from :: Document -> Rep Document x

to :: Rep Document x -> Document

Hashable Document

Defined in Prosidy.Types

Methods

hashWithSalt :: Int -> Document -> Int

hash :: Document -> Int

ToJSON Document

Defined in Prosidy.Internal.JSON

Methods

toJSON :: Document -> Value

toEncoding :: Document -> Encoding

toJSONList :: [Document] -> Value

toEncodingList :: [Document] -> Encoding

FromJSON Document

Defined in Prosidy.Internal.JSON

Methods

parseJSON :: Value -> Parser Document

parseJSONList :: Value -> Parser [Document]

Binary Document

Defined in Prosidy.Types

Methods

put :: Document -> Put

get :: Get Document

putList :: [Document] -> Put

NFData Document

Defined in Prosidy.Types

Methods

rnf :: Document -> ()

Pretty Document

Defined in Prosidy.Types

Methods

pretty :: Document -> Doc ann

prettyList :: [Document] -> Doc ann

HasContent Document

Defined in Prosidy.Optics.Types

Associated Types

type Content Document

Methods

content :: Lens' Document (Content Document)

HasMetadata Document

Defined in Prosidy.Optics.Types

Methods

metadata :: Lens' Document Metadata

type Rep Document

Defined in Prosidy.Types

type Rep Document = D1 ('MetaData "Document" "Prosidy.Types" "prosidy-1.6.0.2-inplace" 'False) (C1 ('MetaCons "Document" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Metadata) :*: S1 ('MetaSel ('Just "documentContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Series Block))))

type Content Document

Defined in Prosidy.Optics.Types

type Content Document = Series Block

documentToRegion :: Document -> Region (Series Block)

Convert a Document to a Region. The resulting Region will never have a Location attached.

regionToDocument :: Region (Series Block) -> Document

Convert a Region to a Document. Any Location on the Region will be discarded.

Tags

data Tag a

A Region, annotated with a tag name.

Constructors

Tag

Fields

• tagName :: Key
• tagMetadata :: Metadata
• tagContent :: a
• tagLocation :: Maybe Location

Instances

Functor Tag

Defined in Prosidy.Types

Methods

fmap :: (a -> b) -> Tag a -> Tag b

(<$) :: a -> Tag b -> Tag a

Foldable Tag

Defined in Prosidy.Types

Methods

fold :: Monoid m => Tag m -> m

foldMap :: Monoid m => (a -> m) -> Tag a -> m

foldMap' :: Monoid m => (a -> m) -> Tag a -> m

foldr :: (a -> b -> b) -> b -> Tag a -> b

foldr' :: (a -> b -> b) -> b -> Tag a -> b

foldl :: (b -> a -> b) -> b -> Tag a -> b

foldl' :: (b -> a -> b) -> b -> Tag a -> b

foldr1 :: (a -> a -> a) -> Tag a -> a

foldl1 :: (a -> a -> a) -> Tag a -> a

toList :: Tag a -> [a]

null :: Tag a -> Bool

length :: Tag a -> Int

elem :: Eq a => a -> Tag a -> Bool

maximum :: Ord a => Tag a -> a

minimum :: Ord a => Tag a -> a

sum :: Num a => Tag a -> a

product :: Num a => Tag a -> a

Traversable Tag

Defined in Prosidy.Types

Methods

traverse :: Applicative f => (a -> f b) -> Tag a -> f (Tag b)

sequenceA :: Applicative f => Tag (f a) -> f (Tag a)

mapM :: Monad m => (a -> m b) -> Tag a -> m (Tag b)

sequence :: Monad m => Tag (m a) -> m (Tag a)

Eq a => Eq (Tag a)

Defined in Prosidy.Types

Methods

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

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

Show a => Show (Tag a)

Defined in Prosidy.Types

Methods

showsPrec :: Int -> Tag a -> ShowS

show :: Tag a -> String

showList :: [Tag a] -> ShowS

Generic (Tag a)

Defined in Prosidy.Types

Associated Types

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

Methods

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

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

Hashable a => Hashable (Tag a)

Defined in Prosidy.Types

Methods

hashWithSalt :: Int -> Tag a -> Int

hash :: Tag a -> Int

ToJSON a => ToJSON (Tag a)

Defined in Prosidy.Internal.JSON

Methods

toJSON :: Tag a -> Value

toEncoding :: Tag a -> Encoding

toJSONList :: [Tag a] -> Value

toEncodingList :: [Tag a] -> Encoding

FromJSON a => FromJSON (Tag a)

Defined in Prosidy.Internal.JSON

Methods

parseJSON :: Value -> Parser (Tag a)

parseJSONList :: Value -> Parser [Tag a]

Binary a => Binary (Tag a)

Defined in Prosidy.Types

Methods

put :: Tag a -> Put

get :: Get (Tag a)

putList :: [Tag a] -> Put

NFData a => NFData (Tag a)

Defined in Prosidy.Types

Methods

rnf :: Tag a -> ()

Pretty a => Pretty (Tag a)

Defined in Prosidy.Types

Methods

pretty :: Tag a -> Doc ann

prettyList :: [Tag a] -> Doc ann

HasLocation (Tag a)

Defined in Prosidy.Optics.Source

Methods

location :: Affine' (Tag a) Location

HasContent (Tag a)

Defined in Prosidy.Optics.Types

Associated Types

type Content (Tag a)

Methods

content :: Lens' (Tag a) (Content (Tag a))

HasMetadata (Tag a)

Defined in Prosidy.Optics.Types

Methods

metadata :: Lens' (Tag a) Metadata

type Rep (Tag a)

Defined in Prosidy.Types

type Rep (Tag a) = D1 ('MetaData "Tag" "Prosidy.Types" "prosidy-1.6.0.2-inplace" 'False) (C1 ('MetaCons "Tag" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tagName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Key) :*: S1 ('MetaSel ('Just "tagMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Metadata)) :*: (S1 ('MetaSel ('Just "tagContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Just "tagLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Location)))))

type Content (Tag a)

Defined in Prosidy.Optics.Types

type Content (Tag a) = a

type BlockTag = Tag (Series Block)

A Tag containing zero or more Block items. Specified in Prosidy source with the #- sigil.

type InlineTag = Tag (Series Inline)

A Tag containing zero or more Inline items. Specified in Prosidy source with the # sigil.

type LiteralTag = Tag Text

A Tag containing a single plain-text item. Specified in Prosidy source with the #= sigil.

tagToRegion :: Tag a -> Region a

Convert a Tag to a Region by discarding the tag's name.

regionToTag :: Key -> Region a -> Tag a

Convert a Region to a Tag by providing a tag name.

Regions

data Region a

An untagged structural grouping of items with type a. Regions do not occur in parsing.

Constructors

Region

Fields

• regionMetadata :: Metadata
• regionContent :: a
• regionLocation :: Maybe Location

Instances

Functor Region

Defined in Prosidy.Types

Methods

fmap :: (a -> b) -> Region a -> Region b

(<$) :: a -> Region b -> Region a

Foldable Region

Defined in Prosidy.Types

Methods

fold :: Monoid m => Region m -> m

foldMap :: Monoid m => (a -> m) -> Region a -> m

foldMap' :: Monoid m => (a -> m) -> Region a -> m

foldr :: (a -> b -> b) -> b -> Region a -> b

foldr' :: (a -> b -> b) -> b -> Region a -> b

foldl :: (b -> a -> b) -> b -> Region a -> b

foldl' :: (b -> a -> b) -> b -> Region a -> b

foldr1 :: (a -> a -> a) -> Region a -> a

foldl1 :: (a -> a -> a) -> Region a -> a

toList :: Region a -> [a]

null :: Region a -> Bool

length :: Region a -> Int

elem :: Eq a => a -> Region a -> Bool

maximum :: Ord a => Region a -> a

minimum :: Ord a => Region a -> a

sum :: Num a => Region a -> a

product :: Num a => Region a -> a

Traversable Region

Defined in Prosidy.Types

Methods

traverse :: Applicative f => (a -> f b) -> Region a -> f (Region b)

sequenceA :: Applicative f => Region (f a) -> f (Region a)

mapM :: Monad m => (a -> m b) -> Region a -> m (Region b)

sequence :: Monad m => Region (m a) -> m (Region a)

Eq a => Eq (Region a)

Defined in Prosidy.Types

Methods

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

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

Show a => Show (Region a)

Defined in Prosidy.Types

Methods

showsPrec :: Int -> Region a -> ShowS

show :: Region a -> String

showList :: [Region a] -> ShowS

Generic (Region a)

Defined in Prosidy.Types

Associated Types

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

Methods

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

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

Hashable a => Hashable (Region a)

Defined in Prosidy.Types

Methods

hashWithSalt :: Int -> Region a -> Int

hash :: Region a -> Int

ToJSON a => ToJSON (Region a)

Defined in Prosidy.Internal.JSON

Methods

toJSON :: Region a -> Value

toEncoding :: Region a -> Encoding

toJSONList :: [Region a] -> Value

toEncodingList :: [Region a] -> Encoding

Binary a => Binary (Region a)

Defined in Prosidy.Types

Methods

put :: Region a -> Put

get :: Get (Region a)

putList :: [Region a] -> Put

NFData a => NFData (Region a)

Defined in Prosidy.Types

Methods

rnf :: Region a -> ()

Pretty a => Pretty (Region a)

Defined in Prosidy.Types

Methods

pretty :: Region a -> Doc ann

prettyList :: [Region a] -> Doc ann

HasLocation (Region a)

Defined in Prosidy.Optics.Source

Methods

location :: Affine' (Region a) Location

HasContent (Region a)

Defined in Prosidy.Optics.Types

Associated Types

type Content (Region a)

Methods

content :: Lens' (Region a) (Content (Region a))

HasMetadata (Region a)

Defined in Prosidy.Optics.Types

Methods

metadata :: Lens' (Region a) Metadata

type Rep (Region a)

Defined in Prosidy.Types

type Rep (Region a) = D1 ('MetaData "Region" "Prosidy.Types" "prosidy-1.6.0.2-inplace" 'False) (C1 ('MetaCons "Region" 'PrefixI 'True) (S1 ('MetaSel ('Just "regionMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Metadata) :*: (S1 ('MetaSel ('Just "regionContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Just "regionLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Location)))))

type Content (Region a)

Defined in Prosidy.Optics.Types

type Content (Region a) = a

type BlockRegion = Region (Series Block)

A Region containing a zero or more Block items. Like BlockTag, without a tag name.

type InlineRegion = Region (Series Inline)

A Region containing a zero or more Inline items. Like InlineTag, without a tag name.

type LiteralRegion = Region Text

A Region containing a single plain-text item. Like LiteralTag, without a tag name.

Contextual enumerations

data Block

A sum type enumerating allowed types inside of a block context.

Constructors

BlockLiteral LiteralTag

BlockParagraph Paragraph

BlockTag BlockTag

Instances

Eq Block

Defined in Prosidy.Types

Methods

(==) :: Block -> Block -> Bool

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

Show Block

Defined in Prosidy.Types

Methods

showsPrec :: Int -> Block -> ShowS

show :: Block -> String

showList :: [Block] -> ShowS

Generic Block

Defined in Prosidy.Types

Associated Types

type Rep Block :: Type -> Type

Methods

from :: Block -> Rep Block x

to :: Rep Block x -> Block

Hashable Block

Defined in Prosidy.Types

Methods

hashWithSalt :: Int -> Block -> Int

hash :: Block -> Int

ToJSON Block

Defined in Prosidy.Internal.JSON

Methods

toJSON :: Block -> Value

toEncoding :: Block -> Encoding

toJSONList :: [Block] -> Value

toEncodingList :: [Block] -> Encoding

FromJSON Block

Defined in Prosidy.Internal.JSON

Methods

parseJSON :: Value -> Parser Block

parseJSONList :: Value -> Parser [Block]

Binary Block

Defined in Prosidy.Types

Methods

put :: Block -> Put

get :: Get Block

putList :: [Block] -> Put

NFData Block

Defined in Prosidy.Types

Methods

rnf :: Block -> ()

Pretty Block

Defined in Prosidy.Types

Methods

pretty :: Block -> Doc ann

prettyList :: [Block] -> Doc ann

HasLocation Block

Defined in Prosidy.Optics.Source

Methods

location :: Affine' Block Location

type Rep Block

Defined in Prosidy.Types

type Rep Block = D1 ('MetaData "Block" "Prosidy.Types" "prosidy-1.6.0.2-inplace" 'False) (C1 ('MetaCons "BlockLiteral" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LiteralTag)) :+: (C1 ('MetaCons "BlockParagraph" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Paragraph)) :+: C1 ('MetaCons "BlockTag" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BlockTag))))

data Inline

A sum type enumerating allowed types inside of an inline context.

Constructors

Break

Spacing recorded between lines or on either side of an Inline Tag. Although we could represent this as Text, Prosidy defines a special node for this case so that authors in CJK languages (or other languages without explicit spaces between words) may simply ignore these spaces in their output.

InlineTag InlineTag

A Tag which contains only Inline items. These tags begin with the # sigil in source.

InlineText Fragment

A fragment of plain text.

Instances

Eq Inline

Defined in Prosidy.Types

Methods

(==) :: Inline -> Inline -> Bool

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

Show Inline

Defined in Prosidy.Types

Methods

showsPrec :: Int -> Inline -> ShowS

show :: Inline -> String

showList :: [Inline] -> ShowS

Generic Inline

Defined in Prosidy.Types

Associated Types

type Rep Inline :: Type -> Type

Methods

from :: Inline -> Rep Inline x

to :: Rep Inline x -> Inline

Hashable Inline

Defined in Prosidy.Types

Methods

hashWithSalt :: Int -> Inline -> Int

hash :: Inline -> Int

ToJSON Inline

Defined in Prosidy.Internal.JSON

Methods

toJSON :: Inline -> Value

toEncoding :: Inline -> Encoding

toJSONList :: [Inline] -> Value

toEncodingList :: [Inline] -> Encoding

FromJSON Inline

Defined in Prosidy.Internal.JSON

Methods

parseJSON :: Value -> Parser Inline

parseJSONList :: Value -> Parser [Inline]

Binary Inline

Defined in Prosidy.Types

Methods

put :: Inline -> Put

get :: Get Inline

putList :: [Inline] -> Put

NFData Inline

Defined in Prosidy.Types

Methods

rnf :: Inline -> ()

Pretty Inline

Defined in Prosidy.Types

Methods

pretty :: Inline -> Doc ann

prettyList :: [Inline] -> Doc ann

HasLocation Inline

Defined in Prosidy.Optics.Source

Methods

location :: Affine' Inline Location

type Rep Inline

Defined in Prosidy.Types

type Rep Inline = D1 ('MetaData "Inline" "Prosidy.Types" "prosidy-1.6.0.2-inplace" 'False) (C1 ('MetaCons "Break" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "InlineTag" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InlineTag)) :+: C1 ('MetaCons "InlineText" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Fragment))))

Paragraphs

data Paragraph

A non-empty collection of Inline items. A Paragraph represents the border between block and inline contexts. All ancestors of a paragraph are block items or a document, and all children are inline items.

Constructors

Paragraph

Fields

• paragraphContent :: SeriesNE Inline
• paragraphLocation :: Maybe Location

Instances

Eq Paragraph

Defined in Prosidy.Types

Methods

(==) :: Paragraph -> Paragraph -> Bool

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

Show Paragraph

Defined in Prosidy.Types

Methods

showsPrec :: Int -> Paragraph -> ShowS

show :: Paragraph -> String

showList :: [Paragraph] -> ShowS

Generic Paragraph

Defined in Prosidy.Types

Associated Types

type Rep Paragraph :: Type -> Type

Methods

from :: Paragraph -> Rep Paragraph x

to :: Rep Paragraph x -> Paragraph

Hashable Paragraph

Defined in Prosidy.Types

Methods

hashWithSalt :: Int -> Paragraph -> Int

hash :: Paragraph -> Int

ToJSON Paragraph

Defined in Prosidy.Internal.JSON

Methods

toJSON :: Paragraph -> Value

toEncoding :: Paragraph -> Encoding

toJSONList :: [Paragraph] -> Value

toEncodingList :: [Paragraph] -> Encoding

FromJSON Paragraph

Defined in Prosidy.Internal.JSON

Methods

parseJSON :: Value -> Parser Paragraph

parseJSONList :: Value -> Parser [Paragraph]

Binary Paragraph

Defined in Prosidy.Types

Methods

put :: Paragraph -> Put

get :: Get Paragraph

putList :: [Paragraph] -> Put

NFData Paragraph

Defined in Prosidy.Types

Methods

rnf :: Paragraph -> ()

Pretty Paragraph

Defined in Prosidy.Types

Methods

pretty :: Paragraph -> Doc ann

prettyList :: [Paragraph] -> Doc ann

HasLocation Paragraph

Defined in Prosidy.Optics.Source

Methods

location :: Affine' Paragraph Location

HasContent Paragraph

Defined in Prosidy.Optics.Types

Associated Types

type Content Paragraph

Methods

content :: Lens' Paragraph (Content Paragraph)

type Rep Paragraph

Defined in Prosidy.Types

type Rep Paragraph = D1 ('MetaData "Paragraph" "Prosidy.Types" "prosidy-1.6.0.2-inplace" 'False) (C1 ('MetaCons "Paragraph" 'PrefixI 'True) (S1 ('MetaSel ('Just "paragraphContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (SeriesNE Inline)) :*: S1 ('MetaSel ('Just "paragraphLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Location))))

type Content Paragraph

Defined in Prosidy.Optics.Types

type Content Paragraph = SeriesNE Inline

Common structures

data Metadata

A set of properties and settings, associated with a Region.

The namespaces of properties and settings are distinct; a property can share a name with a setting without conflict.

Constructors

Metadata

Fields

• metadataProperties :: Set Key

  Properties are a set of Keys with no associated value.

• metadataSettings :: Assoc Key Text

  Settings are Keys with an attached value.

Instances

Eq Metadata

Defined in Prosidy.Types

Methods

(==) :: Metadata -> Metadata -> Bool

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

Show Metadata

Defined in Prosidy.Types

Methods

showsPrec :: Int -> Metadata -> ShowS

show :: Metadata -> String

showList :: [Metadata] -> ShowS

Generic Metadata

Defined in Prosidy.Types

Associated Types

type Rep Metadata :: Type -> Type

Methods

from :: Metadata -> Rep Metadata x

to :: Rep Metadata x -> Metadata

Semigroup Metadata

Defined in Prosidy.Types

Methods

(<>) :: Metadata -> Metadata -> Metadata

sconcat :: NonEmpty Metadata -> Metadata

stimes :: Integral b => b -> Metadata -> Metadata

Monoid Metadata

Defined in Prosidy.Types

Methods

mempty :: Metadata

mappend :: Metadata -> Metadata -> Metadata

mconcat :: [Metadata] -> Metadata

Hashable Metadata

Defined in Prosidy.Types

Methods

hashWithSalt :: Int -> Metadata -> Int

hash :: Metadata -> Int

ToJSON Metadata

Defined in Prosidy.Internal.JSON

Methods

toJSON :: Metadata -> Value

toEncoding :: Metadata -> Encoding

toJSONList :: [Metadata] -> Value

toEncodingList :: [Metadata] -> Encoding

FromJSON Metadata

Defined in Prosidy.Internal.JSON

Methods

parseJSON :: Value -> Parser Metadata

parseJSONList :: Value -> Parser [Metadata]

Binary Metadata

Defined in Prosidy.Types

Methods

put :: Metadata -> Put

get :: Get Metadata

putList :: [Metadata] -> Put

NFData Metadata

Defined in Prosidy.Types

Methods

rnf :: Metadata -> ()

Pretty Metadata

Defined in Prosidy.Types

Methods

pretty :: Metadata -> Doc ann

prettyList :: [Metadata] -> Doc ann

HasMetadata Metadata

Defined in Prosidy.Optics.Types

Methods

metadata :: Lens' Metadata Metadata

type Rep Metadata

Defined in Prosidy.Types

type Rep Metadata = D1 ('MetaData "Metadata" "Prosidy.Types" "prosidy-1.6.0.2-inplace" 'False) (C1 ('MetaCons "Metadata" 'PrefixI 'True) (S1 ('MetaSel ('Just "metadataProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Set Key)) :*: S1 ('MetaSel ('Just "metadataSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Assoc Key Text))))

Textual fragments

data Fragment

Plain text, possibly annotated with a Location.

Constructors

Fragment

Fields

• fragmentText :: Text

  Access the underlying Text.

• fragmentLocation :: Maybe Location

  The location of the Text in the source code.

Instances

Eq Fragment

Defined in Prosidy.Types

Methods

(==) :: Fragment -> Fragment -> Bool

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

Show Fragment

Defined in Prosidy.Types

Methods

showsPrec :: Int -> Fragment -> ShowS

show :: Fragment -> String

showList :: [Fragment] -> ShowS

Generic Fragment

Defined in Prosidy.Types

Associated Types

type Rep Fragment :: Type -> Type

Methods

from :: Fragment -> Rep Fragment x

to :: Rep Fragment x -> Fragment

Hashable Fragment

Defined in Prosidy.Types

Methods

hashWithSalt :: Int -> Fragment -> Int

hash :: Fragment -> Int

ToJSON Fragment

Defined in Prosidy.Internal.JSON

Methods

toJSON :: Fragment -> Value

toEncoding :: Fragment -> Encoding

toJSONList :: [Fragment] -> Value

toEncodingList :: [Fragment] -> Encoding

FromJSON Fragment

Defined in Prosidy.Internal.JSON

Methods

parseJSON :: Value -> Parser Fragment

parseJSONList :: Value -> Parser [Fragment]

Binary Fragment

Defined in Prosidy.Types

Methods

put :: Fragment -> Put

get :: Get Fragment

putList :: [Fragment] -> Put

NFData Fragment

Defined in Prosidy.Types

Methods

rnf :: Fragment -> ()

Pretty Fragment

Defined in Prosidy.Types

Methods

pretty :: Fragment -> Doc ann

prettyList :: [Fragment] -> Doc ann

HasLocation Fragment

Defined in Prosidy.Optics.Source

Methods

location :: Affine' Fragment Location

type Rep Fragment

Defined in Prosidy.Types

type Rep Fragment = D1 ('MetaData "Fragment" "Prosidy.Types" "prosidy-1.6.0.2-inplace" 'False) (C1 ('MetaCons "Fragment" 'PrefixI 'True) (S1 ('MetaSel ('Just "fragmentText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "fragmentLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Location))))

Utility wrappers

newtype Assoc k v

An associative mapping of keys to values.

Currently implemented as a HashMap, this newtype wrapper allows us to:

1) Add non-orphan instances to the underlying structure. 2) Change the underlying type if needed.

Constructors

Assoc (HashMap k v)

Instances

Functor (Assoc k)

Defined in Prosidy.Types.Assoc

Methods

fmap :: (a -> b) -> Assoc k a -> Assoc k b

(<$) :: a -> Assoc k b -> Assoc k a

Foldable (Assoc k)

Defined in Prosidy.Types.Assoc

Methods

fold :: Monoid m => Assoc k m -> m

foldMap :: Monoid m => (a -> m) -> Assoc k a -> m

foldMap' :: Monoid m => (a -> m) -> Assoc k a -> m

foldr :: (a -> b -> b) -> b -> Assoc k a -> b

foldr' :: (a -> b -> b) -> b -> Assoc k a -> b

foldl :: (b -> a -> b) -> b -> Assoc k a -> b

foldl' :: (b -> a -> b) -> b -> Assoc k a -> b

foldr1 :: (a -> a -> a) -> Assoc k a -> a

foldl1 :: (a -> a -> a) -> Assoc k a -> a

toList :: Assoc k a -> [a]

null :: Assoc k a -> Bool

length :: Assoc k a -> Int

elem :: Eq a => a -> Assoc k a -> Bool

maximum :: Ord a => Assoc k a -> a

minimum :: Ord a => Assoc k a -> a

sum :: Num a => Assoc k a -> a

product :: Num a => Assoc k a -> a

(Eq k, Eq v) => Eq (Assoc k v)

Defined in Prosidy.Types.Assoc

Methods

(==) :: Assoc k v -> Assoc k v -> Bool

(/=) :: Assoc k v -> Assoc k v -> Bool

(Show k, Show v) => Show (Assoc k v)

Defined in Prosidy.Types.Assoc

Methods

showsPrec :: Int -> Assoc k v -> ShowS

show :: Assoc k v -> String

showList :: [Assoc k v] -> ShowS

Generic (Assoc k v)

Defined in Prosidy.Types.Assoc

Associated Types

type Rep (Assoc k v) :: Type -> Type

Methods

from :: Assoc k v -> Rep (Assoc k v) x

to :: Rep (Assoc k v) x -> Assoc k v

(Eq k, Hashable k) => Semigroup (Assoc k v)

Defined in Prosidy.Types.Assoc

Methods

(<>) :: Assoc k v -> Assoc k v -> Assoc k v

sconcat :: NonEmpty (Assoc k v) -> Assoc k v

stimes :: Integral b => b -> Assoc k v -> Assoc k v

(Eq k, Hashable k) => Monoid (Assoc k v)

Defined in Prosidy.Types.Assoc

Methods

mempty :: Assoc k v

mappend :: Assoc k v -> Assoc k v -> Assoc k v

mconcat :: [Assoc k v] -> Assoc k v

(Hashable k, Hashable v) => Hashable (Assoc k v)

Defined in Prosidy.Types.Assoc

Methods

hashWithSalt :: Int -> Assoc k v -> Int

hash :: Assoc k v -> Int

(ToJSON v, ToJSONKey k) => ToJSON (Assoc k v)

Defined in Prosidy.Types.Assoc

Methods

toJSON :: Assoc k v -> Value

toEncoding :: Assoc k v -> Encoding

toJSONList :: [Assoc k v] -> Value

toEncodingList :: [Assoc k v] -> Encoding

(FromJSON v, FromJSONKey k, Eq k, Hashable k) => FromJSON (Assoc k v)

Defined in Prosidy.Types.Assoc

Methods

parseJSON :: Value -> Parser (Assoc k v)

parseJSONList :: Value -> Parser [Assoc k v]

(Eq k, Hashable k, Binary k, Binary v) => Binary (Assoc k v)

Defined in Prosidy.Types.Assoc

Methods

put :: Assoc k v -> Put

get :: Get (Assoc k v)

putList :: [Assoc k v] -> Put

(NFData k, NFData v) => NFData (Assoc k v)

Defined in Prosidy.Types.Assoc

Methods

rnf :: Assoc k v -> ()

(Pretty k, Pretty v) => Pretty (Assoc k v)

Defined in Prosidy.Types.Assoc

Methods

pretty :: Assoc k v -> Doc ann

prettyList :: [Assoc k v] -> Doc ann

type Rep (Assoc k v)

Defined in Prosidy.Types.Assoc

type Rep (Assoc k v) = D1 ('MetaData "Assoc" "Prosidy.Types.Assoc" "prosidy-1.6.0.2-inplace" 'True) (C1 ('MetaCons "Assoc" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashMap k v))))

data InvalidCharacter

Details for errors thrown when creating Keys with one or more invalid characters.

Instances

Eq InvalidCharacter

Defined in Prosidy.Types.Key

Methods

(==) :: InvalidCharacter -> InvalidCharacter -> Bool

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

Show InvalidCharacter

Defined in Prosidy.Types.Key

Methods

showsPrec :: Int -> InvalidCharacter -> ShowS

show :: InvalidCharacter -> String

showList :: [InvalidCharacter] -> ShowS

data KeyError

Errors returned when creating invalid keys.

Constructors

InvalidCharacterError InvalidCharacter

A character provided as a Key's name was invalid.

EmptyKeyError

A string of length 0 was provided as a Key's name.

Instances

Eq KeyError

Defined in Prosidy.Types.Key

Methods

(==) :: KeyError -> KeyError -> Bool

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

Show KeyError

Defined in Prosidy.Types.Key

Methods

showsPrec :: Int -> KeyError -> ShowS

show :: KeyError -> String

showList :: [KeyError] -> ShowS

Exception KeyError

Defined in Prosidy.Types.Key

Methods

toException :: KeyError -> SomeException

fromException :: SomeException -> Maybe KeyError

displayException :: KeyError -> String

data Key

A Key is an identifier used in tags, properties, and setting names.

Instances

Eq Key

Defined in Prosidy.Types.Key

Methods

(==) :: Key -> Key -> Bool

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

Ord Key

Defined in Prosidy.Types.Key

Methods

compare :: Key -> Key -> Ordering

(<) :: Key -> Key -> Bool

(<=) :: Key -> Key -> Bool

(>) :: Key -> Key -> Bool

(>=) :: Key -> Key -> Bool

max :: Key -> Key -> Key

min :: Key -> Key -> Key

Show Key

Defined in Prosidy.Types.Key

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

IsString Key

Key exposes an IsString instance, but beware! Invalid strings will throw a pure exception.

Defined in Prosidy.Types.Key

Methods

fromString :: String -> Key

Generic Key

Defined in Prosidy.Types.Key

Associated Types

type Rep Key :: Type -> Type

Methods

from :: Key -> Rep Key x

to :: Rep Key x -> Key

Hashable Key

Defined in Prosidy.Types.Key

Methods

hashWithSalt :: Int -> Key -> Int

hash :: Key -> Int

ToJSON Key

Defined in Prosidy.Types.Key

Methods

toJSON :: Key -> Value

toEncoding :: Key -> Encoding

toJSONList :: [Key] -> Value

toEncodingList :: [Key] -> Encoding

ToJSONKey Key

Defined in Prosidy.Types.Key

Methods

toJSONKey :: ToJSONKeyFunction Key

toJSONKeyList :: ToJSONKeyFunction [Key]

FromJSON Key

Defined in Prosidy.Types.Key

Methods

parseJSON :: Value -> Parser Key

parseJSONList :: Value -> Parser [Key]

FromJSONKey Key

Defined in Prosidy.Internal.JSON

Methods

fromJSONKey :: FromJSONKeyFunction Key

fromJSONKeyList :: FromJSONKeyFunction [Key]

Binary Key

Defined in Prosidy.Types.Key

Methods

put :: Key -> Put

get :: Get Key

putList :: [Key] -> Put

NFData Key

Defined in Prosidy.Types.Key

Methods

rnf :: Key -> ()

Pretty Key

Defined in Prosidy.Types.Key

Methods

pretty :: Key -> Doc ann

prettyList :: [Key] -> Doc ann

type Rep Key

Defined in Prosidy.Types.Key

type Rep Key = D1 ('MetaData "Key" "Prosidy.Types.Key" "prosidy-1.6.0.2-inplace" 'True) (C1 ('MetaCons "Key" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

makeKey :: Text -> Either KeyError Key

Create a new Key, checking its validity.

rawKey :: Key -> Text

Convert a Key into its Text representation.

data SeriesNE a

A non-empty Series.

Instances

Functor SeriesNE

Defined in Prosidy.Types.Series

Methods

fmap :: (a -> b) -> SeriesNE a -> SeriesNE b

(<$) :: a -> SeriesNE b -> SeriesNE a

Applicative SeriesNE

Defined in Prosidy.Types.Series

Methods

pure :: a -> SeriesNE a

(<*>) :: SeriesNE (a -> b) -> SeriesNE a -> SeriesNE b

liftA2 :: (a -> b -> c) -> SeriesNE a -> SeriesNE b -> SeriesNE c

(*>) :: SeriesNE a -> SeriesNE b -> SeriesNE b

(<*) :: SeriesNE a -> SeriesNE b -> SeriesNE a

Foldable SeriesNE

Defined in Prosidy.Types.Series

Methods

fold :: Monoid m => SeriesNE m -> m

foldMap :: Monoid m => (a -> m) -> SeriesNE a -> m

foldMap' :: Monoid m => (a -> m) -> SeriesNE a -> m

foldr :: (a -> b -> b) -> b -> SeriesNE a -> b

foldr' :: (a -> b -> b) -> b -> SeriesNE a -> b

foldl :: (b -> a -> b) -> b -> SeriesNE a -> b

foldl' :: (b -> a -> b) -> b -> SeriesNE a -> b

foldr1 :: (a -> a -> a) -> SeriesNE a -> a

foldl1 :: (a -> a -> a) -> SeriesNE a -> a

toList :: SeriesNE a -> [a]

null :: SeriesNE a -> Bool

length :: SeriesNE a -> Int

elem :: Eq a => a -> SeriesNE a -> Bool

maximum :: Ord a => SeriesNE a -> a

minimum :: Ord a => SeriesNE a -> a

sum :: Num a => SeriesNE a -> a

product :: Num a => SeriesNE a -> a

Traversable SeriesNE

Defined in Prosidy.Types.Series

Methods

traverse :: Applicative f => (a -> f b) -> SeriesNE a -> f (SeriesNE b)

sequenceA :: Applicative f => SeriesNE (f a) -> f (SeriesNE a)

mapM :: Monad m => (a -> m b) -> SeriesNE a -> m (SeriesNE b)

sequence :: Monad m => SeriesNE (m a) -> m (SeriesNE a)

Eq a => Eq (SeriesNE a)

Defined in Prosidy.Types.Series

Methods

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

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

Show a => Show (SeriesNE a)

Defined in Prosidy.Types.Series

Methods

showsPrec :: Int -> SeriesNE a -> ShowS

show :: SeriesNE a -> String

showList :: [SeriesNE a] -> ShowS

Generic (SeriesNE a)

Defined in Prosidy.Types.Series

Associated Types

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

Methods

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

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

Semigroup (SeriesNE a)

Defined in Prosidy.Types.Series

Methods

(<>) :: SeriesNE a -> SeriesNE a -> SeriesNE a

sconcat :: NonEmpty (SeriesNE a) -> SeriesNE a

stimes :: Integral b => b -> SeriesNE a -> SeriesNE a

Hashable a => Hashable (SeriesNE a)

Defined in Prosidy.Types.Series

Methods

hashWithSalt :: Int -> SeriesNE a -> Int

hash :: SeriesNE a -> Int

ToJSON a => ToJSON (SeriesNE a)

Defined in Prosidy.Types.Series

Methods

toJSON :: SeriesNE a -> Value

toEncoding :: SeriesNE a -> Encoding

toJSONList :: [SeriesNE a] -> Value

toEncodingList :: [SeriesNE a] -> Encoding

FromJSON a => FromJSON (SeriesNE a)

Defined in Prosidy.Types.Series

Methods

parseJSON :: Value -> Parser (SeriesNE a)

parseJSONList :: Value -> Parser [SeriesNE a]

Binary a => Binary (SeriesNE a)

Defined in Prosidy.Types.Series

Methods

put :: SeriesNE a -> Put

get :: Get (SeriesNE a)

putList :: [SeriesNE a] -> Put

NFData a => NFData (SeriesNE a)

Defined in Prosidy.Types.Series

Methods

rnf :: SeriesNE a -> ()

Pretty a => Pretty (SeriesNE a)

Defined in Prosidy.Types.Series

Methods

pretty :: SeriesNE a -> Doc ann

prettyList :: [SeriesNE a] -> Doc ann

type Rep (SeriesNE a)

Defined in Prosidy.Types.Series

type Rep (SeriesNE a) = D1 ('MetaData "SeriesNE" "Prosidy.Types.Series" "prosidy-1.6.0.2-inplace" 'True) (C1 ('MetaCons "SeriesNE" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq a))))

newtype Series a

A newtype wrapper around a sequential collection.

Currently, Series is implemented as a Seq, but this is not guarenteed to be true.

Constructors

Series (Seq a)

Instances

Functor Series

Defined in Prosidy.Types.Series

Methods

fmap :: (a -> b) -> Series a -> Series b

(<$) :: a -> Series b -> Series a

Applicative Series

Defined in Prosidy.Types.Series

Methods

pure :: a -> Series a

(<*>) :: Series (a -> b) -> Series a -> Series b

liftA2 :: (a -> b -> c) -> Series a -> Series b -> Series c

(*>) :: Series a -> Series b -> Series b

(<*) :: Series a -> Series b -> Series a

Foldable Series

Defined in Prosidy.Types.Series

Methods

fold :: Monoid m => Series m -> m

foldMap :: Monoid m => (a -> m) -> Series a -> m

foldMap' :: Monoid m => (a -> m) -> Series a -> m

foldr :: (a -> b -> b) -> b -> Series a -> b

foldr' :: (a -> b -> b) -> b -> Series a -> b

foldl :: (b -> a -> b) -> b -> Series a -> b

foldl' :: (b -> a -> b) -> b -> Series a -> b

foldr1 :: (a -> a -> a) -> Series a -> a

foldl1 :: (a -> a -> a) -> Series a -> a

toList :: Series a -> [a]

null :: Series a -> Bool

length :: Series a -> Int

elem :: Eq a => a -> Series a -> Bool

maximum :: Ord a => Series a -> a

minimum :: Ord a => Series a -> a

sum :: Num a => Series a -> a

product :: Num a => Series a -> a

Traversable Series

Defined in Prosidy.Types.Series

Methods

traverse :: Applicative f => (a -> f b) -> Series a -> f (Series b)

sequenceA :: Applicative f => Series (f a) -> f (Series a)

mapM :: Monad m => (a -> m b) -> Series a -> m (Series b)

sequence :: Monad m => Series (m a) -> m (Series a)

Eq a => Eq (Series a)

Defined in Prosidy.Types.Series

Methods

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

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

Show a => Show (Series a)

Defined in Prosidy.Types.Series

Methods

showsPrec :: Int -> Series a -> ShowS

show :: Series a -> String

showList :: [Series a] -> ShowS

Generic (Series a)

Defined in Prosidy.Types.Series

Associated Types

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

Methods

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

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

Semigroup (Series a)

Defined in Prosidy.Types.Series

Methods

(<>) :: Series a -> Series a -> Series a

sconcat :: NonEmpty (Series a) -> Series a

stimes :: Integral b => b -> Series a -> Series a

Monoid (Series a)

Defined in Prosidy.Types.Series

Methods

mempty :: Series a

mappend :: Series a -> Series a -> Series a

mconcat :: [Series a] -> Series a

Hashable a => Hashable (Series a)

Defined in Prosidy.Types.Series

Methods

hashWithSalt :: Int -> Series a -> Int

hash :: Series a -> Int

ToJSON a => ToJSON (Series a)

Defined in Prosidy.Types.Series

Methods

toJSON :: Series a -> Value

toEncoding :: Series a -> Encoding

toJSONList :: [Series a] -> Value

toEncodingList :: [Series a] -> Encoding

FromJSON a => FromJSON (Series a)

Defined in Prosidy.Types.Series

Methods

parseJSON :: Value -> Parser (Series a)

parseJSONList :: Value -> Parser [Series a]

Binary a => Binary (Series a)

Defined in Prosidy.Types.Series

Methods

put :: Series a -> Put

get :: Get (Series a)

putList :: [Series a] -> Put

NFData a => NFData (Series a)

Defined in Prosidy.Types.Series

Methods

rnf :: Series a -> ()

Pretty a => Pretty (Series a)

Defined in Prosidy.Types.Series

Methods

pretty :: Series a -> Doc ann

prettyList :: [Series a] -> Doc ann

type Rep (Series a)

Defined in Prosidy.Types.Series

type Rep (Series a) = D1 ('MetaData "Series" "Prosidy.Types.Series" "prosidy-1.6.0.2-inplace" 'True) (C1 ('MetaCons "Series" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq a))))

newtype Set a

A newtype wrapper around an unordered collection of unique elements.

Currently, this is implemented as a wrapper around a HashSet.

Constructors

Set (HashSet a)

Instances

Foldable Set

Defined in Prosidy.Types.Set

Methods

fold :: Monoid m => Set m -> m

foldMap :: Monoid m => (a -> m) -> Set a -> m

foldMap' :: Monoid m => (a -> m) -> Set a -> m

foldr :: (a -> b -> b) -> b -> Set a -> b

foldr' :: (a -> b -> b) -> b -> Set a -> b

foldl :: (b -> a -> b) -> b -> Set a -> b

foldl' :: (b -> a -> b) -> b -> Set a -> b

foldr1 :: (a -> a -> a) -> Set a -> a

foldl1 :: (a -> a -> a) -> Set a -> a

toList :: Set a -> [a]

null :: Set a -> Bool

length :: Set a -> Int

elem :: Eq a => a -> Set a -> Bool

maximum :: Ord a => Set a -> a

minimum :: Ord a => Set a -> a

sum :: Num a => Set a -> a

product :: Num a => Set a -> a

Eq a => Eq (Set a)

Defined in Prosidy.Types.Set

Methods

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

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

Show a => Show (Set a)

Defined in Prosidy.Types.Set

Methods

showsPrec :: Int -> Set a -> ShowS

show :: Set a -> String

showList :: [Set a] -> ShowS

Generic (Set a)

Defined in Prosidy.Types.Set

Associated Types

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

Methods

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

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

(Hashable a, Eq a) => Semigroup (Set a)

Defined in Prosidy.Types.Set

Methods

(<>) :: Set a -> Set a -> Set a

sconcat :: NonEmpty (Set a) -> Set a

stimes :: Integral b => b -> Set a -> Set a

(Hashable a, Eq a) => Monoid (Set a)

Defined in Prosidy.Types.Set

Methods

mempty :: Set a

mappend :: Set a -> Set a -> Set a

mconcat :: [Set a] -> Set a

Hashable a => Hashable (Set a)

Defined in Prosidy.Types.Set

Methods

hashWithSalt :: Int -> Set a -> Int

hash :: Set a -> Int

(Hashable a, Eq a, ToJSONKey a) => ToJSON (Set a)

Defined in Prosidy.Internal.JSON

Methods

toJSON :: Set a -> Value

toEncoding :: Set a -> Encoding

toJSONList :: [Set a] -> Value

toEncodingList :: [Set a] -> Encoding

(Hashable a, Eq a, FromJSONKey a) => FromJSON (Set a)

Defined in Prosidy.Internal.JSON

Methods

parseJSON :: Value -> Parser (Set a)

parseJSONList :: Value -> Parser [Set a]

(Eq a, Hashable a, Binary a) => Binary (Set a)

Defined in Prosidy.Types.Set

Methods

put :: Set a -> Put

get :: Get (Set a)

putList :: [Set a] -> Put

NFData a => NFData (Set a)

Defined in Prosidy.Types.Set

Methods

rnf :: Set a -> ()

Pretty a => Pretty (Set a)

Defined in Prosidy.Types.Set

Methods

pretty :: Set a -> Doc ann

prettyList :: [Set a] -> Doc ann

type Rep (Set a)

Defined in Prosidy.Types.Set

type Rep (Set a) = D1 ('MetaData "Set" "Prosidy.Types.Set" "prosidy-1.6.0.2-inplace" 'True) (C1 ('MetaCons "Set" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashSet a))))