Copyright	©2020 James Alexander Feldman-Crough
License	MPL-2.0
Maintainer	alex@fldcr.com
Safe Haskell	None
Language	Haskell2010

Prosidy

Description

Synopsis

data Offset
data Column
data Line
data Location
data Source
newtype Assoc k v = Assoc (HashMap k v)
data InvalidCharacter
data KeyError
- = InvalidCharacterError InvalidCharacter
- | EmptyKeyError
data Key
makeKey :: Text -> Either KeyError Key
rawKey :: Key -> Text
data SeriesNE a
newtype Series a = Series (Seq a)
newtype Set a = Set (HashSet a)
type LiteralRegion = Region Text
type LiteralTag = Tag Text
type InlineRegion = Region (Series Inline)
type InlineTag = Tag (Series Inline)
type BlockRegion = Region (Series Block)
type BlockTag = Tag (Series Block)
data Tag a = Tag {
- tagName :: Key
- tagMetadata :: Metadata
- tagContent :: a
- tagLocation :: Maybe Location
}
data Region a = Region {
- regionMetadata :: Metadata
- regionContent :: a
- regionLocation :: Maybe Location
}
data Paragraph = Paragraph {
- paragraphContent :: SeriesNE Inline
- paragraphLocation :: Maybe Location
}
data Metadata = Metadata {
- metadataProperties :: Set Key
- metadataSettings :: Assoc Key Text
}
data Inline
- = Break
- | InlineTag InlineTag
- | InlineText Fragment
data Fragment = Fragment {
- fragmentText :: Text
- fragmentLocation :: Maybe Location
}
data Document = Document {
- documentMetadata :: Metadata
- documentContent :: Series Block
}
data Block
- = BlockLiteral LiteralTag
- | BlockParagraph Paragraph
- | BlockTag BlockTag
documentToRegion :: Document -> Region (Series Block)
regionToDocument :: Region (Series Block) -> Document
tagToRegion :: Tag a -> Region a
regionToTag :: Key -> Region a -> Tag a
newtype Failure = Failure (ParseErrorBundle Text Void)
parseDocument :: FilePath -> Text -> Either Failure Document
readDocument :: FilePath -> IO Document
parseDocumentMetadata :: FilePath -> Text -> Either Failure Metadata
readDocumentMetadata :: FilePath -> IO Metadata
prettyFailure :: Failure -> String
class HasLocation t where
- location :: Affine' t Location
offset :: HasLocation l => Affine' l Offset
column :: (HasLocation l, Contravariant f, Applicative f) => Optic' (->) f l Column
line :: (HasLocation l, Contravariant f, Applicative f) => Optic' (->) f l Line
source :: (HasLocation l, Contravariant f, Applicative f) => Optic' (->) f l Source
sparse :: Iso' Location SparseLocation
class HasContent t where
- type Content t
- content :: Lens' t (Content t)
class HasMetadata t where
- metadata :: Lens' t Metadata
properties :: HasMetadata m => Lens' m (Set Key)
settings :: HasMetadata m => Lens' m (Assoc Key Text)
hasProperty :: HasMetadata m => Key -> Lens' m Bool
atSetting :: HasMetadata m => Key -> Lens' m (Maybe Text)
tag :: Lens' (Tag a) Key
fragment :: Lens' Fragment Text
tagged :: Key -> Prism' (Tag a) (Region a)
_BlockTag :: Prism' Block BlockTag
_BlockParagraph :: Prism' Block Paragraph
_BlockLiteral :: Prism' Block LiteralTag
_InlineTag :: Prism' Inline InlineTag
_Text :: Prism' Inline Fragment
_Break :: Prism' Inline ()
key :: Prism' Text Key
_Assoc :: Iso (Assoc k v) (Assoc k' v') (HashMap k v) (HashMap k' v')
_NonEmpty :: Prism' (Series a) (SeriesNE a)
_Series :: Iso (Series a) (Series b) (Seq a) (Seq b)
_SeriesNE :: Prism' (Seq a) (SeriesNE a)
_Set :: Iso (Set a) (Set b) (HashSet a) (HashSet b)

Documentation

data Offset Source #

An offset into a Source, counted by UTF-8 codepoint.

Instances

Instances details

Enum Offset Source #
Instance details Defined in Prosidy.Source Methods succ :: Offset -> Offset # pred :: Offset -> Offset # toEnum :: Int -> Offset # fromEnum :: Offset -> Int # enumFrom :: Offset -> [Offset] # enumFromThen :: Offset -> Offset -> [Offset] # enumFromTo :: Offset -> Offset -> [Offset] # enumFromThenTo :: Offset -> Offset -> Offset -> [Offset] #
Eq Offset Source #
Instance details Defined in Prosidy.Source Methods (==) :: Offset -> Offset -> Bool # (/=) :: Offset -> Offset -> Bool #
Ord Offset Source #
Instance details Defined in Prosidy.Source Methods compare :: Offset -> Offset -> Ordering # (<) :: Offset -> Offset -> Bool # (<=) :: Offset -> Offset -> Bool # (>) :: Offset -> Offset -> Bool # (>=) :: Offset -> Offset -> Bool # max :: Offset -> Offset -> Offset # min :: Offset -> Offset -> Offset #
Show Offset Source #
Instance details Defined in Prosidy.Source Methods showsPrec :: Int -> Offset -> ShowS # show :: Offset -> String # showList :: [Offset] -> ShowS #
Generic Offset Source #
Instance details Defined in Prosidy.Source Associated Types type Rep Offset :: Type -> Type # Methods from :: Offset -> Rep Offset x # to :: Rep Offset x -> Offset #
Hashable Offset Source #
Instance details Defined in Prosidy.Source Methods hashWithSalt :: Int -> Offset -> Int # hash :: Offset -> Int #
ToJSON Offset Source #
Instance details Defined in Prosidy.Source Methods toJSON :: Offset -> Value # toEncoding :: Offset -> Encoding # toJSONList :: [Offset] -> Value # toEncodingList :: [Offset] -> Encoding #
FromJSON Offset Source #
Instance details Defined in Prosidy.Source Methods parseJSON :: Value -> Parser Offset # parseJSONList :: Value -> Parser [Offset] #
Binary Offset Source #
Instance details Defined in Prosidy.Source Methods put :: Offset -> Put # get :: Get Offset # putList :: [Offset] -> Put #
NFData Offset Source #
Instance details Defined in Prosidy.Source Methods rnf :: Offset -> () #
Unbox Offset Source #
Instance details Defined in Prosidy.Source
Vector Vector Offset Source #
Instance details Defined in Prosidy.Source Methods basicUnsafeFreeze :: PrimMonad m => Mutable Vector (PrimState m) Offset -> m (Vector Offset) # basicUnsafeThaw :: PrimMonad m => Vector Offset -> m (Mutable Vector (PrimState m) Offset) # basicLength :: Vector Offset -> Int # basicUnsafeSlice :: Int -> Int -> Vector Offset -> Vector Offset # basicUnsafeIndexM :: Monad m => Vector Offset -> Int -> m Offset # basicUnsafeCopy :: PrimMonad m => Mutable Vector (PrimState m) Offset -> Vector Offset -> m () # elemseq :: Vector Offset -> Offset -> b -> b #
MVector MVector Offset Source #
Instance details Defined in Prosidy.Source Methods basicLength :: MVector s Offset -> Int # basicUnsafeSlice :: Int -> Int -> MVector s Offset -> MVector s Offset # basicOverlaps :: MVector s Offset -> MVector s Offset -> Bool # basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) Offset) # basicInitialize :: PrimMonad m => MVector (PrimState m) Offset -> m () # basicUnsafeReplicate :: PrimMonad m => Int -> Offset -> m (MVector (PrimState m) Offset) # basicUnsafeRead :: PrimMonad m => MVector (PrimState m) Offset -> Int -> m Offset # basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) Offset -> Int -> Offset -> m () # basicClear :: PrimMonad m => MVector (PrimState m) Offset -> m () # basicSet :: PrimMonad m => MVector (PrimState m) Offset -> Offset -> m () # basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) Offset -> MVector (PrimState m) Offset -> m () # basicUnsafeMove :: PrimMonad m => MVector (PrimState m) Offset -> MVector (PrimState m) Offset -> m () # basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) Offset -> Int -> m (MVector (PrimState m) Offset) #
type Rep Offset Source #
Instance details Defined in Prosidy.Source type Rep Offset = D1 ('MetaData "Offset" "Prosidy.Source" "prosidy-1.6.0.1-inplace" 'True) (C1 ('MetaCons "Offset" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)))
newtype Vector Offset Source #
Instance details Defined in Prosidy.Source newtype Vector Offset = V_Offset (Vector Word)
newtype MVector s Offset Source #
Instance details Defined in Prosidy.Source newtype MVector s Offset = MV_Offset (MVector s Word)

data Column Source #

A column number.

Instances

Instances details

Enum Column Source #
Instance details Defined in Prosidy.Source Methods succ :: Column -> Column # pred :: Column -> Column # toEnum :: Int -> Column # fromEnum :: Column -> Int # enumFrom :: Column -> [Column] # enumFromThen :: Column -> Column -> [Column] # enumFromTo :: Column -> Column -> [Column] # enumFromThenTo :: Column -> Column -> Column -> [Column] #
Eq Column Source #
Instance details Defined in Prosidy.Source Methods (==) :: Column -> Column -> Bool # (/=) :: Column -> Column -> Bool #
Ord Column Source #
Instance details Defined in Prosidy.Source Methods compare :: Column -> Column -> Ordering # (<) :: Column -> Column -> Bool # (<=) :: Column -> Column -> Bool # (>) :: Column -> Column -> Bool # (>=) :: Column -> Column -> Bool # max :: Column -> Column -> Column # min :: Column -> Column -> Column #
Show Column Source #
Instance details Defined in Prosidy.Source Methods showsPrec :: Int -> Column -> ShowS # show :: Column -> String # showList :: [Column] -> ShowS #
Generic Column Source #
Instance details Defined in Prosidy.Source Associated Types type Rep Column :: Type -> Type # Methods from :: Column -> Rep Column x # to :: Rep Column x -> Column #
Hashable Column Source #
Instance details Defined in Prosidy.Source Methods hashWithSalt :: Int -> Column -> Int # hash :: Column -> Int #
ToJSON Column Source #
Instance details Defined in Prosidy.Source Methods toJSON :: Column -> Value # toEncoding :: Column -> Encoding # toJSONList :: [Column] -> Value # toEncodingList :: [Column] -> Encoding #
FromJSON Column Source #
Instance details Defined in Prosidy.Source Methods parseJSON :: Value -> Parser Column # parseJSONList :: Value -> Parser [Column] #
Binary Column Source #
Instance details Defined in Prosidy.Source Methods put :: Column -> Put # get :: Get Column # putList :: [Column] -> Put #
NFData Column Source #
Instance details Defined in Prosidy.Source Methods rnf :: Column -> () #
type Rep Column Source #
Instance details Defined in Prosidy.Source type Rep Column = D1 ('MetaData "Column" "Prosidy.Source" "prosidy-1.6.0.1-inplace" 'True) (C1 ('MetaCons "Column" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)))

data Line Source #

A line number.

The Show instance for Line counts from one, while the internal implementation counts from zero.

Instances

Instances details

Enum Line Source #
Instance details Defined in Prosidy.Source Methods succ :: Line -> Line # pred :: Line -> Line # toEnum :: Int -> Line # fromEnum :: Line -> Int # enumFrom :: Line -> [Line] # enumFromThen :: Line -> Line -> [Line] # enumFromTo :: Line -> Line -> [Line] # enumFromThenTo :: Line -> Line -> Line -> [Line] #
Eq Line Source #
Instance details Defined in Prosidy.Source Methods (==) :: Line -> Line -> Bool # (/=) :: Line -> Line -> Bool #
Ord Line Source #
Instance details Defined in Prosidy.Source Methods compare :: Line -> Line -> Ordering # (<) :: Line -> Line -> Bool # (<=) :: Line -> Line -> Bool # (>) :: Line -> Line -> Bool # (>=) :: Line -> Line -> Bool # max :: Line -> Line -> Line # min :: Line -> Line -> Line #
Show Line Source #
Instance details Defined in Prosidy.Source Methods showsPrec :: Int -> Line -> ShowS # show :: Line -> String # showList :: [Line] -> ShowS #
Generic Line Source #
Instance details Defined in Prosidy.Source Associated Types type Rep Line :: Type -> Type # Methods from :: Line -> Rep Line x # to :: Rep Line x -> Line #
Hashable Line Source #
Instance details Defined in Prosidy.Source Methods hashWithSalt :: Int -> Line -> Int # hash :: Line -> Int #
ToJSON Line Source #
Instance details Defined in Prosidy.Source Methods toJSON :: Line -> Value # toEncoding :: Line -> Encoding # toJSONList :: [Line] -> Value # toEncodingList :: [Line] -> Encoding #
FromJSON Line Source #
Instance details Defined in Prosidy.Source Methods parseJSON :: Value -> Parser Line # parseJSONList :: Value -> Parser [Line] #
Binary Line Source #
Instance details Defined in Prosidy.Source Methods put :: Line -> Put # get :: Get Line # putList :: [Line] -> Put #
NFData Line Source #
Instance details Defined in Prosidy.Source Methods rnf :: Line -> () #
type Rep Line Source #
Instance details Defined in Prosidy.Source type Rep Line = D1 ('MetaData "Line" "Prosidy.Source" "prosidy-1.6.0.1-inplace" 'True) (C1 ('MetaCons "Line" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)))

data Location Source #

A location in a Source, with the line and column number computed lazily.

Instances

Instances details

Eq Location Source #
Instance details Defined in Prosidy.Source Methods (==) :: Location -> Location -> Bool # (/=) :: Location -> Location -> Bool #
Show Location Source #
Instance details Defined in Prosidy.Source Methods showsPrec :: Int -> Location -> ShowS # show :: Location -> String # showList :: [Location] -> ShowS #
Generic Location Source #
Instance details Defined in Prosidy.Source Associated Types type Rep Location :: Type -> Type # Methods from :: Location -> Rep Location x # to :: Rep Location x -> Location #
Hashable Location Source #
Instance details Defined in Prosidy.Source Methods hashWithSalt :: Int -> Location -> Int # hash :: Location -> Int #
Binary Location Source #
Instance details Defined in Prosidy.Source Methods put :: Location -> Put # get :: Get Location # putList :: [Location] -> Put #
NFData Location Source #
Instance details Defined in Prosidy.Source Methods rnf :: Location -> () #
HasLocation Location Source #
Instance details Defined in Prosidy.Optics.Source Methods location :: Affine' Location Location Source #
type Rep Location Source #
Instance details Defined in Prosidy.Source type Rep Location = D1 ('MetaData "Location" "Prosidy.Source" "prosidy-1.6.0.1-inplace" 'False) (C1 ('MetaCons "Location" 'PrefixI 'True) ((S1 ('MetaSel ('Just "locationSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Source) :: S1 ('MetaSel ('Just "locationOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Offset)) :: (S1 ('MetaSel ('Just "locationLine") 'NoSourceUnpackedness 'SourceLazy 'DecidedLazy) (Rec0 Line) :*: S1 ('MetaSel ('Just "locationColumn") 'NoSourceUnpackedness 'SourceLazy 'DecidedLazy) (Rec0 Column))))

data Source Source #

Information about Prosidy source file.

The Show instance for ths class does not include the LineMap or Text fields, as those are rather noisy.

Instances

Instances details

Eq Source Source #
Instance details Defined in Prosidy.Source Methods (==) :: Source -> Source -> Bool # (/=) :: Source -> Source -> Bool #
Show Source Source #
Instance details Defined in Prosidy.Source Methods showsPrec :: Int -> Source -> ShowS # show :: Source -> String # showList :: [Source] -> ShowS #
Generic Source Source #
Instance details Defined in Prosidy.Source Associated Types type Rep Source :: Type -> Type # Methods from :: Source -> Rep Source x # to :: Rep Source x -> Source #
Hashable Source Source #
Instance details Defined in Prosidy.Source Methods hashWithSalt :: Int -> Source -> Int # hash :: Source -> Int #
Binary Source Source #
Instance details Defined in Prosidy.Source Methods put :: Source -> Put # get :: Get Source # putList :: [Source] -> Put #
NFData Source Source #
Instance details Defined in Prosidy.Source Methods rnf :: Source -> () #
type Rep Source Source #
Instance details Defined in Prosidy.Source type Rep Source = D1 ('MetaData "Source" "Prosidy.Source" "prosidy-1.6.0.1-inplace" 'False) (C1 ('MetaCons "Source" 'PrefixI 'True) (S1 ('MetaSel ('Just "sourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String) :: (S1 ('MetaSel ('Just "sourceText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "sourceLineMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LineMap))))

newtype Assoc k v Source #

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

Instances details

Functor (Assoc k) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Prosidy.Types.Assoc Methods rnf :: Assoc k v -> () #
type Rep (Assoc k v) Source #
Instance details Defined in Prosidy.Types.Assoc type Rep (Assoc k v) = D1 ('MetaData "Assoc" "Prosidy.Types.Assoc" "prosidy-1.6.0.1-inplace" 'True) (C1 ('MetaCons "Assoc" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashMap k v))))

data InvalidCharacter Source #

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

Instances

Instances details

Eq InvalidCharacter Source #
Instance details Defined in Prosidy.Types.Key Methods (==) :: InvalidCharacter -> InvalidCharacter -> Bool # (/=) :: InvalidCharacter -> InvalidCharacter -> Bool #
Show InvalidCharacter Source #
Instance details Defined in Prosidy.Types.Key Methods showsPrec :: Int -> InvalidCharacter -> ShowS # show :: InvalidCharacter -> String # showList :: [InvalidCharacter] -> ShowS #

data KeyError Source #

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

Instances details

Eq KeyError Source #
Instance details Defined in Prosidy.Types.Key Methods (==) :: KeyError -> KeyError -> Bool # (/=) :: KeyError -> KeyError -> Bool #
Show KeyError Source #
Instance details Defined in Prosidy.Types.Key Methods showsPrec :: Int -> KeyError -> ShowS # show :: KeyError -> String # showList :: [KeyError] -> ShowS #
Exception KeyError Source #
Instance details Defined in Prosidy.Types.Key Methods toException :: KeyError -> SomeException # fromException :: SomeException -> Maybe KeyError # displayException :: KeyError -> String #

data Key Source #

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

Instances

Instances details

Eq Key Source #
Instance details Defined in Prosidy.Types.Key Methods (==) :: Key -> Key -> Bool # (/=) :: Key -> Key -> Bool #
Ord Key Source #
Instance details 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 Source #
Instance details Defined in Prosidy.Types.Key Methods showsPrec :: Int -> Key -> ShowS # show :: Key -> String # showList :: [Key] -> ShowS #
IsString Key Source #	`Key` exposes an `IsString` instance, but beware! Invalid strings will throw a pure exception.
Instance details Defined in Prosidy.Types.Key Methods fromString :: String -> Key #
Generic Key Source #
Instance details 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 Source #
Instance details Defined in Prosidy.Types.Key Methods hashWithSalt :: Int -> Key -> Int # hash :: Key -> Int #
ToJSON Key Source #
Instance details Defined in Prosidy.Types.Key Methods toJSON :: Key -> Value # toEncoding :: Key -> Encoding # toJSONList :: [Key] -> Value # toEncodingList :: [Key] -> Encoding #
ToJSONKey Key Source #
Instance details Defined in Prosidy.Types.Key Methods toJSONKey :: ToJSONKeyFunction Key # toJSONKeyList :: ToJSONKeyFunction [Key] #
FromJSON Key Source #
Instance details Defined in Prosidy.Types.Key Methods parseJSON :: Value -> Parser Key # parseJSONList :: Value -> Parser [Key] #
FromJSONKey Key Source #
Instance details Defined in Prosidy.Types.Key Methods fromJSONKey :: FromJSONKeyFunction Key # fromJSONKeyList :: FromJSONKeyFunction [Key] #
Binary Key Source #
Instance details Defined in Prosidy.Types.Key Methods put :: Key -> Put # get :: Get Key # putList :: [Key] -> Put #
NFData Key Source #
Instance details Defined in Prosidy.Types.Key Methods rnf :: Key -> () #
type Rep Key Source #
Instance details Defined in Prosidy.Types.Key type Rep Key = D1 ('MetaData "Key" "Prosidy.Types.Key" "prosidy-1.6.0.1-inplace" 'True) (C1 ('MetaCons "Key" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

makeKey :: Text -> Either KeyError Key Source #

Create a new Key, checking its validity.

rawKey :: Key -> Text Source #

Convert a Key into its Text representation.

data SeriesNE a Source #

A non-empty Series.

Instances

Instances details

Functor SeriesNE Source #
Instance details Defined in Prosidy.Types.Series Methods fmap :: (a -> b) -> SeriesNE a -> SeriesNE b # (<$) :: a -> SeriesNE b -> SeriesNE a #
Applicative SeriesNE Source #
Instance details 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 Source #
Instance details 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 Source #
Instance details 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) Source #
Instance details Defined in Prosidy.Types.Series Methods (==) :: SeriesNE a -> SeriesNE a -> Bool # (/=) :: SeriesNE a -> SeriesNE a -> Bool #
Show a => Show (SeriesNE a) Source #
Instance details Defined in Prosidy.Types.Series Methods showsPrec :: Int -> SeriesNE a -> ShowS # show :: SeriesNE a -> String # showList :: [SeriesNE a] -> ShowS #
Generic (SeriesNE a) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Prosidy.Types.Series Methods hashWithSalt :: Int -> SeriesNE a -> Int # hash :: SeriesNE a -> Int #
ToJSON a => ToJSON (SeriesNE a) Source #
Instance details 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) Source #
Instance details Defined in Prosidy.Types.Series Methods parseJSON :: Value -> Parser (SeriesNE a) # parseJSONList :: Value -> Parser [SeriesNE a] #
Binary a => Binary (SeriesNE a) Source #
Instance details Defined in Prosidy.Types.Series Methods put :: SeriesNE a -> Put # get :: Get (SeriesNE a) # putList :: [SeriesNE a] -> Put #
NFData a => NFData (SeriesNE a) Source #
Instance details Defined in Prosidy.Types.Series Methods rnf :: SeriesNE a -> () #
type Rep (SeriesNE a) Source #
Instance details Defined in Prosidy.Types.Series type Rep (SeriesNE a) = D1 ('MetaData "SeriesNE" "Prosidy.Types.Series" "prosidy-1.6.0.1-inplace" 'True) (C1 ('MetaCons "SeriesNE" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq a))))

newtype Series a Source #

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

Instances details

Functor Series Source #
Instance details Defined in Prosidy.Types.Series Methods fmap :: (a -> b) -> Series a -> Series b # (<$) :: a -> Series b -> Series a #
Applicative Series Source #
Instance details 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 Source #
Instance details 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 Source #
Instance details 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) Source #
Instance details Defined in Prosidy.Types.Series Methods (==) :: Series a -> Series a -> Bool # (/=) :: Series a -> Series a -> Bool #
Show a => Show (Series a) Source #
Instance details Defined in Prosidy.Types.Series Methods showsPrec :: Int -> Series a -> ShowS # show :: Series a -> String # showList :: [Series a] -> ShowS #
Generic (Series a) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Prosidy.Types.Series Methods hashWithSalt :: Int -> Series a -> Int # hash :: Series a -> Int #
ToJSON a => ToJSON (Series a) Source #
Instance details 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) Source #
Instance details Defined in Prosidy.Types.Series Methods parseJSON :: Value -> Parser (Series a) # parseJSONList :: Value -> Parser [Series a] #
Binary a => Binary (Series a) Source #
Instance details Defined in Prosidy.Types.Series Methods put :: Series a -> Put # get :: Get (Series a) # putList :: [Series a] -> Put #
NFData a => NFData (Series a) Source #
Instance details Defined in Prosidy.Types.Series Methods rnf :: Series a -> () #
type Rep (Series a) Source #
Instance details Defined in Prosidy.Types.Series type Rep (Series a) = D1 ('MetaData "Series" "Prosidy.Types.Series" "prosidy-1.6.0.1-inplace" 'True) (C1 ('MetaCons "Series" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq a))))

newtype Set a Source #

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

Instances details

Foldable Set Source #
Instance details 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) Source #
Instance details Defined in Prosidy.Types.Set Methods (==) :: Set a -> Set a -> Bool # (/=) :: Set a -> Set a -> Bool #
Show a => Show (Set a) Source #
Instance details Defined in Prosidy.Types.Set Methods showsPrec :: Int -> Set a -> ShowS # show :: Set a -> String # showList :: [Set a] -> ShowS #
Generic (Set a) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Prosidy.Types.Set Methods hashWithSalt :: Int -> Set a -> Int # hash :: Set a -> Int #
(Hashable a, Eq a, ToJSONKey a) => ToJSON (Set a) Source #
Instance details Defined in Prosidy.Types.Set 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) Source #
Instance details Defined in Prosidy.Types.Set Methods parseJSON :: Value -> Parser (Set a) # parseJSONList :: Value -> Parser [Set a] #
(Eq a, Hashable a, Binary a) => Binary (Set a) Source #
Instance details Defined in Prosidy.Types.Set Methods put :: Set a -> Put # get :: Get (Set a) # putList :: [Set a] -> Put #
NFData a => NFData (Set a) Source #
Instance details Defined in Prosidy.Types.Set Methods rnf :: Set a -> () #
type Rep (Set a) Source #
Instance details Defined in Prosidy.Types.Set type Rep (Set a) = D1 ('MetaData "Set" "Prosidy.Types.Set" "prosidy-1.6.0.1-inplace" 'True) (C1 ('MetaCons "Set" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashSet a))))

type LiteralRegion = Region Text Source #

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

type LiteralTag = Tag Text Source #

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

type InlineRegion = Region (Series Inline) Source #

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

type InlineTag = Tag (Series Inline) Source #

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

type BlockRegion = Region (Series Block) Source #

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

type BlockTag = Tag (Series Block) Source #

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

data Tag a Source #

A Region, annotated with a tag name.

Constructors

Tag
Fields tagName :: Key tagMetadata :: Metadata tagContent :: a tagLocation :: Maybe Location

Instances

Instances details

Functor Tag Source #
Instance details Defined in Prosidy.Types Methods fmap :: (a -> b) -> Tag a -> Tag b # (<$) :: a -> Tag b -> Tag a #
Foldable Tag Source #
Instance details 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 Source #
Instance details 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) Source #
Instance details Defined in Prosidy.Types Methods (==) :: Tag a -> Tag a -> Bool # (/=) :: Tag a -> Tag a -> Bool #
Show a => Show (Tag a) Source #
Instance details Defined in Prosidy.Types Methods showsPrec :: Int -> Tag a -> ShowS # show :: Tag a -> String # showList :: [Tag a] -> ShowS #
Generic (Tag a) Source #
Instance details 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) Source #
Instance details Defined in Prosidy.Types Methods hashWithSalt :: Int -> Tag a -> Int # hash :: Tag a -> Int #
ToJSON a => ToJSON (Tag a) Source #
Instance details Defined in Prosidy.Types Methods toJSON :: Tag a -> Value # toEncoding :: Tag a -> Encoding # toJSONList :: [Tag a] -> Value # toEncodingList :: [Tag a] -> Encoding #
FromJSON a => FromJSON (Tag a) Source #
Instance details Defined in Prosidy.Types Methods parseJSON :: Value -> Parser (Tag a) # parseJSONList :: Value -> Parser [Tag a] #
Binary a => Binary (Tag a) Source #
Instance details Defined in Prosidy.Types Methods put :: Tag a -> Put # get :: Get (Tag a) # putList :: [Tag a] -> Put #
NFData a => NFData (Tag a) Source #
Instance details Defined in Prosidy.Types Methods rnf :: Tag a -> () #
HasLocation (Tag a) Source #
Instance details Defined in Prosidy.Optics.Source Methods location :: Affine' (Tag a) Location Source #
HasContent (Tag a) Source #
Instance details Defined in Prosidy.Optics.Types Associated Types type Content (Tag a) Source # Methods content :: Lens' (Tag a) (Content (Tag a)) Source #
HasMetadata (Tag a) Source #
Instance details Defined in Prosidy.Optics.Types Methods metadata :: Lens' (Tag a) Metadata Source #
type Rep (Tag a) Source #
Instance details Defined in Prosidy.Types type Rep (Tag a) = D1 ('MetaData "Tag" "Prosidy.Types" "prosidy-1.6.0.1-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) Source #
Instance details Defined in Prosidy.Optics.Types type Content (Tag a) = a

data Region a Source #

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

Instances details

Functor Region Source #
Instance details Defined in Prosidy.Types Methods fmap :: (a -> b) -> Region a -> Region b # (<$) :: a -> Region b -> Region a #
Foldable Region Source #
Instance details 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 Source #
Instance details 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) Source #
Instance details Defined in Prosidy.Types Methods (==) :: Region a -> Region a -> Bool # (/=) :: Region a -> Region a -> Bool #
Show a => Show (Region a) Source #
Instance details Defined in Prosidy.Types Methods showsPrec :: Int -> Region a -> ShowS # show :: Region a -> String # showList :: [Region a] -> ShowS #
Generic (Region a) Source #
Instance details 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) Source #
Instance details Defined in Prosidy.Types Methods hashWithSalt :: Int -> Region a -> Int # hash :: Region a -> Int #
ToJSON a => ToJSON (Region a) Source #
Instance details Defined in Prosidy.Types Methods toJSON :: Region a -> Value # toEncoding :: Region a -> Encoding # toJSONList :: [Region a] -> Value # toEncodingList :: [Region a] -> Encoding #
Binary a => Binary (Region a) Source #
Instance details Defined in Prosidy.Types Methods put :: Region a -> Put # get :: Get (Region a) # putList :: [Region a] -> Put #
NFData a => NFData (Region a) Source #
Instance details Defined in Prosidy.Types Methods rnf :: Region a -> () #
HasLocation (Region a) Source #
Instance details Defined in Prosidy.Optics.Source Methods location :: Affine' (Region a) Location Source #
HasContent (Region a) Source #
Instance details Defined in Prosidy.Optics.Types Associated Types type Content (Region a) Source # Methods content :: Lens' (Region a) (Content (Region a)) Source #
HasMetadata (Region a) Source #
Instance details Defined in Prosidy.Optics.Types Methods metadata :: Lens' (Region a) Metadata Source #
type Rep (Region a) Source #
Instance details Defined in Prosidy.Types type Rep (Region a) = D1 ('MetaData "Region" "Prosidy.Types" "prosidy-1.6.0.1-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) Source #
Instance details Defined in Prosidy.Optics.Types type Content (Region a) = a

data Paragraph Source #

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

Instances details

Eq Paragraph Source #
Instance details Defined in Prosidy.Types Methods (==) :: Paragraph -> Paragraph -> Bool # (/=) :: Paragraph -> Paragraph -> Bool #
Show Paragraph Source #
Instance details Defined in Prosidy.Types Methods showsPrec :: Int -> Paragraph -> ShowS # show :: Paragraph -> String # showList :: [Paragraph] -> ShowS #
Generic Paragraph Source #
Instance details Defined in Prosidy.Types Associated Types type Rep Paragraph :: Type -> Type # Methods from :: Paragraph -> Rep Paragraph x # to :: Rep Paragraph x -> Paragraph #
Hashable Paragraph Source #
Instance details Defined in Prosidy.Types Methods hashWithSalt :: Int -> Paragraph -> Int # hash :: Paragraph -> Int #
ToJSON Paragraph Source #
Instance details Defined in Prosidy.Types Methods toJSON :: Paragraph -> Value # toEncoding :: Paragraph -> Encoding # toJSONList :: [Paragraph] -> Value # toEncodingList :: [Paragraph] -> Encoding #
FromJSON Paragraph Source #
Instance details Defined in Prosidy.Types Methods parseJSON :: Value -> Parser Paragraph # parseJSONList :: Value -> Parser [Paragraph] #
Binary Paragraph Source #
Instance details Defined in Prosidy.Types Methods put :: Paragraph -> Put # get :: Get Paragraph # putList :: [Paragraph] -> Put #
NFData Paragraph Source #
Instance details Defined in Prosidy.Types Methods rnf :: Paragraph -> () #
HasLocation Paragraph Source #
Instance details Defined in Prosidy.Optics.Source Methods location :: Affine' Paragraph Location Source #
HasContent Paragraph Source #
Instance details Defined in Prosidy.Optics.Types Associated Types type Content Paragraph Source # Methods content :: Lens' Paragraph (Content Paragraph) Source #
type Rep Paragraph Source #
Instance details Defined in Prosidy.Types type Rep Paragraph = D1 ('MetaData "Paragraph" "Prosidy.Types" "prosidy-1.6.0.1-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 Source #
Instance details Defined in Prosidy.Optics.Types type Content Paragraph = SeriesNE Inline

data Metadata Source #

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 `Key`s with no associated value. metadataSettings :: Assoc Key Text Settings are `Key`s with an attached value.

Instances

Instances details

Eq Metadata Source #
Instance details Defined in Prosidy.Types Methods (==) :: Metadata -> Metadata -> Bool # (/=) :: Metadata -> Metadata -> Bool #
Show Metadata Source #
Instance details Defined in Prosidy.Types Methods showsPrec :: Int -> Metadata -> ShowS # show :: Metadata -> String # showList :: [Metadata] -> ShowS #
Generic Metadata Source #
Instance details Defined in Prosidy.Types Associated Types type Rep Metadata :: Type -> Type # Methods from :: Metadata -> Rep Metadata x # to :: Rep Metadata x -> Metadata #
Semigroup Metadata Source #
Instance details Defined in Prosidy.Types Methods (<>) :: Metadata -> Metadata -> Metadata # sconcat :: NonEmpty Metadata -> Metadata # stimes :: Integral b => b -> Metadata -> Metadata #
Monoid Metadata Source #
Instance details Defined in Prosidy.Types Methods mempty :: Metadata # mappend :: Metadata -> Metadata -> Metadata # mconcat :: [Metadata] -> Metadata #
Hashable Metadata Source #
Instance details Defined in Prosidy.Types Methods hashWithSalt :: Int -> Metadata -> Int # hash :: Metadata -> Int #
ToJSON Metadata Source #
Instance details Defined in Prosidy.Types Methods toJSON :: Metadata -> Value # toEncoding :: Metadata -> Encoding # toJSONList :: [Metadata] -> Value # toEncodingList :: [Metadata] -> Encoding #
FromJSON Metadata Source #
Instance details Defined in Prosidy.Types Methods parseJSON :: Value -> Parser Metadata # parseJSONList :: Value -> Parser [Metadata] #
Binary Metadata Source #
Instance details Defined in Prosidy.Types Methods put :: Metadata -> Put # get :: Get Metadata # putList :: [Metadata] -> Put #
NFData Metadata Source #
Instance details Defined in Prosidy.Types Methods rnf :: Metadata -> () #
HasMetadata Metadata Source #
Instance details Defined in Prosidy.Optics.Types Methods metadata :: Lens' Metadata Metadata Source #
type Rep Metadata Source #
Instance details Defined in Prosidy.Types type Rep Metadata = D1 ('MetaData "Metadata" "Prosidy.Types" "prosidy-1.6.0.1-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))))

data Inline Source #

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

Instances details

Eq Inline Source #
Instance details Defined in Prosidy.Types Methods (==) :: Inline -> Inline -> Bool # (/=) :: Inline -> Inline -> Bool #
Show Inline Source #
Instance details Defined in Prosidy.Types Methods showsPrec :: Int -> Inline -> ShowS # show :: Inline -> String # showList :: [Inline] -> ShowS #
Generic Inline Source #
Instance details Defined in Prosidy.Types Associated Types type Rep Inline :: Type -> Type # Methods from :: Inline -> Rep Inline x # to :: Rep Inline x -> Inline #
Hashable Inline Source #
Instance details Defined in Prosidy.Types Methods hashWithSalt :: Int -> Inline -> Int # hash :: Inline -> Int #
ToJSON Inline Source #
Instance details Defined in Prosidy.Types Methods toJSON :: Inline -> Value # toEncoding :: Inline -> Encoding # toJSONList :: [Inline] -> Value # toEncodingList :: [Inline] -> Encoding #
FromJSON Inline Source #
Instance details Defined in Prosidy.Types Methods parseJSON :: Value -> Parser Inline # parseJSONList :: Value -> Parser [Inline] #
Binary Inline Source #
Instance details Defined in Prosidy.Types Methods put :: Inline -> Put # get :: Get Inline # putList :: [Inline] -> Put #
NFData Inline Source #
Instance details Defined in Prosidy.Types Methods rnf :: Inline -> () #
HasLocation Inline Source #
Instance details Defined in Prosidy.Optics.Source Methods location :: Affine' Inline Location Source #
type Rep Inline Source #
Instance details Defined in Prosidy.Types type Rep Inline = D1 ('MetaData "Inline" "Prosidy.Types" "prosidy-1.6.0.1-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))))

data Fragment Source #

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

Instances details

Eq Fragment Source #
Instance details Defined in Prosidy.Types Methods (==) :: Fragment -> Fragment -> Bool # (/=) :: Fragment -> Fragment -> Bool #
Show Fragment Source #
Instance details Defined in Prosidy.Types Methods showsPrec :: Int -> Fragment -> ShowS # show :: Fragment -> String # showList :: [Fragment] -> ShowS #
Generic Fragment Source #
Instance details Defined in Prosidy.Types Associated Types type Rep Fragment :: Type -> Type # Methods from :: Fragment -> Rep Fragment x # to :: Rep Fragment x -> Fragment #
Hashable Fragment Source #
Instance details Defined in Prosidy.Types Methods hashWithSalt :: Int -> Fragment -> Int # hash :: Fragment -> Int #
ToJSON Fragment Source #
Instance details Defined in Prosidy.Types Methods toJSON :: Fragment -> Value # toEncoding :: Fragment -> Encoding # toJSONList :: [Fragment] -> Value # toEncodingList :: [Fragment] -> Encoding #
FromJSON Fragment Source #
Instance details Defined in Prosidy.Types Methods parseJSON :: Value -> Parser Fragment # parseJSONList :: Value -> Parser [Fragment] #
Binary Fragment Source #
Instance details Defined in Prosidy.Types Methods put :: Fragment -> Put # get :: Get Fragment # putList :: [Fragment] -> Put #
NFData Fragment Source #
Instance details Defined in Prosidy.Types Methods rnf :: Fragment -> () #
HasLocation Fragment Source #
Instance details Defined in Prosidy.Optics.Source Methods location :: Affine' Fragment Location Source #
type Rep Fragment Source #
Instance details Defined in Prosidy.Types type Rep Fragment = D1 ('MetaData "Fragment" "Prosidy.Types" "prosidy-1.6.0.1-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))))

data Document Source #

A full Prosidy document.

Constructors

Document
Fields documentMetadata :: Metadata documentContent :: Series Block

Instances

Instances details

Eq Document Source #
Instance details Defined in Prosidy.Types Methods (==) :: Document -> Document -> Bool # (/=) :: Document -> Document -> Bool #
Show Document Source #
Instance details Defined in Prosidy.Types Methods showsPrec :: Int -> Document -> ShowS # show :: Document -> String # showList :: [Document] -> ShowS #
Generic Document Source #
Instance details Defined in Prosidy.Types Associated Types type Rep Document :: Type -> Type # Methods from :: Document -> Rep Document x # to :: Rep Document x -> Document #
Hashable Document Source #
Instance details Defined in Prosidy.Types Methods hashWithSalt :: Int -> Document -> Int # hash :: Document -> Int #
ToJSON Document Source #
Instance details Defined in Prosidy.Types Methods toJSON :: Document -> Value # toEncoding :: Document -> Encoding # toJSONList :: [Document] -> Value # toEncodingList :: [Document] -> Encoding #
FromJSON Document Source #
Instance details Defined in Prosidy.Types Methods parseJSON :: Value -> Parser Document # parseJSONList :: Value -> Parser [Document] #
Binary Document Source #
Instance details Defined in Prosidy.Types Methods put :: Document -> Put # get :: Get Document # putList :: [Document] -> Put #
NFData Document Source #
Instance details Defined in Prosidy.Types Methods rnf :: Document -> () #
HasContent Document Source #
Instance details Defined in Prosidy.Optics.Types Associated Types type Content Document Source # Methods content :: Lens' Document (Content Document) Source #
HasMetadata Document Source #
Instance details Defined in Prosidy.Optics.Types Methods metadata :: Lens' Document Metadata Source #
type Rep Document Source #
Instance details Defined in Prosidy.Types type Rep Document = D1 ('MetaData "Document" "Prosidy.Types" "prosidy-1.6.0.1-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 Source #
Instance details Defined in Prosidy.Optics.Types type Content Document = Series Block

data Block Source #

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

Constructors

BlockLiteral LiteralTag
BlockParagraph Paragraph
BlockTag BlockTag

Instances

Instances details

Eq Block Source #
Instance details Defined in Prosidy.Types Methods (==) :: Block -> Block -> Bool # (/=) :: Block -> Block -> Bool #
Show Block Source #
Instance details Defined in Prosidy.Types Methods showsPrec :: Int -> Block -> ShowS # show :: Block -> String # showList :: [Block] -> ShowS #
Generic Block Source #
Instance details Defined in Prosidy.Types Associated Types type Rep Block :: Type -> Type # Methods from :: Block -> Rep Block x # to :: Rep Block x -> Block #
Hashable Block Source #
Instance details Defined in Prosidy.Types Methods hashWithSalt :: Int -> Block -> Int # hash :: Block -> Int #
ToJSON Block Source #
Instance details Defined in Prosidy.Types Methods toJSON :: Block -> Value # toEncoding :: Block -> Encoding # toJSONList :: [Block] -> Value # toEncodingList :: [Block] -> Encoding #
FromJSON Block Source #
Instance details Defined in Prosidy.Types Methods parseJSON :: Value -> Parser Block # parseJSONList :: Value -> Parser [Block] #
Binary Block Source #
Instance details Defined in Prosidy.Types Methods put :: Block -> Put # get :: Get Block # putList :: [Block] -> Put #
NFData Block Source #
Instance details Defined in Prosidy.Types Methods rnf :: Block -> () #
HasLocation Block Source #
Instance details Defined in Prosidy.Optics.Source Methods location :: Affine' Block Location Source #
type Rep Block Source #
Instance details Defined in Prosidy.Types type Rep Block = D1 ('MetaData "Block" "Prosidy.Types" "prosidy-1.6.0.1-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))))

documentToRegion :: Document -> Region (Series Block) Source #

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

regionToDocument :: Region (Series Block) -> Document Source #

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

tagToRegion :: Tag a -> Region a Source #

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

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

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

newtype Failure Source #

A parsing error.

Constructors

Failure (ParseErrorBundle Text Void)

Instances

Instances details

Show Failure Source #
Instance details Defined in Prosidy.Parse Methods showsPrec :: Int -> Failure -> ShowS # show :: Failure -> String # showList :: [Failure] -> ShowS #
Exception Failure Source #
Instance details Defined in Prosidy.Parse Methods toException :: Failure -> SomeException # fromException :: SomeException -> Maybe Failure # displayException :: Failure -> String #

parseDocument :: FilePath -> Text -> Either Failure Document Source #

Parses a Prosidy Document from its source.

The FilePath parameter is only used for error reporting.

readDocument :: FilePath -> IO Document Source #

Reads a Prosidy Document from the given FilePath.

Errors will be thrown as exceptions. Use parseDocument for a pure implementation.

parseDocumentMetadata :: FilePath -> Text -> Either Failure Metadata Source #

Parses a Prosidy document's header Metadata from source, stopping when the header ends.

The FilePath parameter is only used for error reporting.

readDocumentMetadata :: FilePath -> IO Metadata Source #

Reads a Prosidy document's Metadata header from the given FilePath.

Errors will be thrown as exceptions. Use parseDocumentMetadata for a pure implementation.

prettyFailure :: Failure -> String Source #

Pretty-print a Failure into a message acceptable for displaying to users.

class HasLocation t where Source #

A classy optic for selecting the Location from a value. Note that location is affine: a Location can't be attached to a value which does not -- already have one, and not all values with an instance of HasLocation have a location.

Methods

location :: Affine' t Location Source #

Instances

Instances details

HasLocation Location Source #
Instance details Defined in Prosidy.Optics.Source Methods location :: Affine' Location Location Source #
HasLocation Paragraph Source #
Instance details Defined in Prosidy.Optics.Source Methods location :: Affine' Paragraph Location Source #
HasLocation Inline Source #
Instance details Defined in Prosidy.Optics.Source Methods location :: Affine' Inline Location Source #
HasLocation Fragment Source #
Instance details Defined in Prosidy.Optics.Source Methods location :: Affine' Fragment Location Source #
HasLocation Block Source #
Instance details Defined in Prosidy.Optics.Source Methods location :: Affine' Block Location Source #
HasLocation (Tag a) Source #
Instance details Defined in Prosidy.Optics.Source Methods location :: Affine' (Tag a) Location Source #
HasLocation (Region a) Source #
Instance details Defined in Prosidy.Optics.Source Methods location :: Affine' (Region a) Location Source #

offset :: HasLocation l => Affine' l Offset Source #

Focus on the Offset from a value parsed from a source file. If the Offset is modified, note that the resulting column and line will also be modified as they are denormalizations of this value.

column :: (HasLocation l, Contravariant f, Applicative f) => Optic' (->) f l Column Source #

Fetch the Column from a value parsed from a source file. Modifications are not allowed as the offset and line may become inconsistent.

line :: (HasLocation l, Contravariant f, Applicative f) => Optic' (->) f l Line Source #

Fetch the Line from a value parsed from a source file. Modifications are not allowed as the offset and column may become inconsistent.

source :: (HasLocation l, Contravariant f, Applicative f) => Optic' (->) f l Source Source #

Fetch the Source a value was parsed from. Modifications are not allowed as the line, offset, and column may become inconsistent.

sparse :: Iso' Location SparseLocation Source #

An isomorphism between Location and SparseLocation. This is allowed because although a Location has strictly more data than a SparseLocation, those values are denormalizations of values within SparseLocation.

class HasContent t where Source #

An optic for selecting children of an item in a recursive structure.

Associated Types

type Content t Source #

The type of all of the children collectively. For instance, type Content Document = Series Block, as Document has zero or more contained Blocks.

Methods

content :: Lens' t (Content t) Source #

Instances

Instances details

HasContent Paragraph Source #
Instance details Defined in Prosidy.Optics.Types Associated Types type Content Paragraph Source # Methods content :: Lens' Paragraph (Content Paragraph) Source #
HasContent Document Source #
Instance details Defined in Prosidy.Optics.Types Associated Types type Content Document Source # Methods content :: Lens' Document (Content Document) Source #
HasContent (Tag a) Source #
Instance details Defined in Prosidy.Optics.Types Associated Types type Content (Tag a) Source # Methods content :: Lens' (Tag a) (Content (Tag a)) Source #
HasContent (Region a) Source #
Instance details Defined in Prosidy.Optics.Types Associated Types type Content (Region a) Source # Methods content :: Lens' (Region a) (Content (Region a)) Source #

class HasMetadata t where Source #

A classy optic for focusing on items with Metadata, including Tags, Regions, and Documents.

Methods

metadata :: Lens' t Metadata Source #

Instances

Instances details

HasMetadata Metadata Source #
Instance details Defined in Prosidy.Optics.Types Methods metadata :: Lens' Metadata Metadata Source #
HasMetadata Document Source #
Instance details Defined in Prosidy.Optics.Types Methods metadata :: Lens' Document Metadata Source #
HasMetadata (Tag a) Source #
Instance details Defined in Prosidy.Optics.Types Methods metadata :: Lens' (Tag a) Metadata Source #
HasMetadata (Region a) Source #
Instance details Defined in Prosidy.Optics.Types Methods metadata :: Lens' (Region a) Metadata Source #

properties :: HasMetadata m => Lens' m (Set Key) Source #

Fetch all properties from items which contain metadata.

settings :: HasMetadata m => Lens' m (Assoc Key Text) Source #

Fetch all settings defined on items which contain metadata.

hasProperty :: HasMetadata m => Key -> Lens' m Bool Source #

Check if a property is attached to an item with metadata. Using this optic as a setter will add a property if set to True and remove the property when set to False.

atSetting :: HasMetadata m => Key -> Lens' m (Maybe Text) Source #

Select a setting from an item attached to metadata. Returns Nothing if no value is set.

tag :: Lens' (Tag a) Key Source #

Focus on the name of a Tag.

fragment :: Lens' Fragment Text Source #

Get the contents of a Fragment.

tagged :: Key -> Prism' (Tag a) (Region a) Source #

Focus on the inner Region of Tags with a name. This can be used to filter Tags to a specific subset for manipulation.

_BlockTag :: Prism' Block BlockTag Source #

Focus only on block tags.

_BlockParagraph :: Prism' Block Paragraph Source #

Focus only on paragraphs'