Copyright	© 2020 James Alexander Feldman-Crough © 2022 Mission Valley Software LLC
License	MPL-2.0
Safe Haskell	None
Language	Haskell2010

ProAbstract

Contents

Document
Blocks
- Paragraphs
- Tag blocks
Lines
- Plain text
Tags
- Traversal
- Withering
Prisms
- Plain/fork
- Tagged/bare
Metadata
Content
- Contents
Annotation
Tagless content

Description

Document

Document is the root of the tree.

Document = (metadata : Metadata) × (content : Blocks)

Tagged nodes

Tag = (name : Text) × (metadata : Metadata) × (annotation : Annotation)

Tagged nodes are branch points within a document.

TaggedBlocks = (tag : Tag) × (content : Blocks)
TaggedPlainBlock = (tag : Tag) × (content : PlainBlock)
TaggedLines = (tag : Tag) × (content : Lines)

Optics:

tag targets the tag at a node; it is either a lens or an affine traversal, depending on the node type.
The allTags traversal targets every tag at and below a node.
The allBlockTags and allInlineTags also target tags at or below a node, but are limited to tags at the block or inline level, respectively.
Since a tag has metadata, all of the optics for targeting parts of metadata (e.g. atSetting and hasProperty) are also available on Tag and on Tagged... nodes.

Operations for altering tags and/or removing tagged nodes in bulk:

Pure: mapMaybeTags, mapMaybeBlockTags, mapMaybeInlineTags
Monadic: witherTags, witherBlockTags, witherInlineTags

Example: mapMaybeTags (preview (filtered \x -> view name x /= "comment")) is an endofunction that removes all nodes having a tag name of "comment".

The Block level

Block-level content is everything that appears below the document level and above the paragraph level.

Block = (fork : TaggedBlocks) ∪ (plain : TaggedPlainBlock) ∪ (bare : Paragraph)

There are three kinds of block:

Fork blocks contain more blocks.
- TaggedBlocks = (tag : Tag) × (contents : Block)
Plain blocks contain text.
- TaggedPlainBlock = (tag : Tag) × (content : PlainBlock)
- PlainBlock = (contents : Fragment) × (annotation : Annotation)
Bare blocks (paragraphs) contain inline content.
- Paragraph = (contents : Line) × (annotation : Annotation)

Unenforced guideline: The Lines of a Paragraph should contain at least one Line.

BlockTag

A BlockTag is a non-paragraph Block.

BlockTag = (fork : TaggedBlocks) ∪ (plain : TaggedPlainBlock)

The Block type can be described in terms of BlockTag as:

Block = (tagged : BlockTag) ∪ (bare : Paragraph)

Example: tagged % filtered (x -> view name x == "h1") is an affine fold that targets blocks with a tag name of "h1".

The BlockTag type can also be described as:

BlockTag = (tag :: Tag) × (content : BlockTagContent)
BlockTagContent = (fork : Blocks) ∪ (plain : PlainBlock)

The Inline level

Inline-level content is everything below the paragraph level.

Inline content is grouped into lines; we specify no particular semantics of line breaks but suggest that a typical consumer of Lines will fold them together with a single space character interspersed between the lines.

Inline = (fork or tagged : TaggedLines) ∪ (plain or bare : Fragment)

There are two kinds of inline:

Fork or tag inlines contain more inlines.
- TaggedLines = (tag : Tag) × (content : Lines)
- Lines = (contents : Line)
- Line = (content : Seq Inline) × (annotation : Annotation)
Plain or bare inlines contain text.

Unenforced guideline: Each Line should contain at least one Inline.

Fragments

Fragments are all the little scraps of text that serve as the leaves of the document tree.

Fragment = (content : Text) × (annotation : Annotation)

A fragment may appear at the inline level as a plain Inline, or at the block level as a line of a PlainBlock.

Unenforced guidelines: Fragment text should be non-empty, and it should not contain any line break characters.

Metadata

Documents and tags both have metadata.

Metadata = (properties : Set Text) × (settings : Map Text Text)

Optics:

metadata targets the metadata of a node; it is either a lens or an affine traversal, depending on the node type.
atSetting and hasProperty target specific parts of metadata by name.
The allMetadata traversal targets every metadata at and under a node.
metaMap gives properties and settings combined into a single Map Text MetaValue
metaList gives properties and settings combined into a list of MetaItem

Content

The content of a node is whatever is nested directly under it in the document tree. The content lens is overloaded via the Content type family and HasContent class.

The contents of a node is the type of sequence element most directly nested under it. The contents lens is via the Contents type family and HasContents class.

List of nodes and their content types:

x	Content x	Contents x
`Document`	`Blocks`	`Block`
`TaggedBlocks`	`Blocks`	`Block`
`Blocks`	—	`Block`
`BlockTag`	`BlockTagContent`	—
`TaggedPlainBlock`	`PlainBlock`	`Fragment`
`PlainBlock`	—	`Fragment`
`Paragraph`	`Lines`	`Line`
`TaggedLines`	`Lines`	`Line`
`Lines`	—	`Line`
`Line`	—	`Inline`
`Fragment`	`Text`	—

HasContent and HasContents have type aliases HasContents' and HasContents' respectively for types that only support simple optics.

Tagged or bare

At both the block and inline level, a node is either tagged or bare, a fact manifested by the taggedOrBare isomorphism of the IsTaggedOrBare class.

The tagged prism is overloaded via the TaggedType type family, and the bare prism is overloaded via the BareType family.

List of nodes and their tagged/bare types:

x	TaggedType x	BareType x
`Block`	`BlockTag`	`Paragraph`
`Inline`	`TaggedLines`	`Fragment`

Fork or plain

At both the block and inline level, a node may be a fork that contains a sequence of more content at the same level, and a node may be plain node that just contains text.

The fork prism is overloaded via the Fork type family and CanFork class.

The plain prism is overloaded via the Plain type family and CanBePlain class.

List of nodes and their fork/plain types:

x	Fork x	Plain x
`Block`	`TaggedBlocks`	`TaggedPlainBlock`
`BlockTag`	`TaggedBlocks`	`TaggedPlainBlock`
`BlockTagContent`	`Blocks`	`PlainBlock`
`Inline`	`TaggedLines`	`Fragment`

(Block also has a third prism, bare, which is neither fork nor plain.)

Annotation

An annotation is attached to every Tag, PlainBlock, Paragraph, Line, and Fragment. The Annotation type may be anything, but its original purpose was to map each component of a document to the location where it appeared in a text file.

Optics:

The annotation lens targets a single annotation at a node
The allAnnotations traversal targets every annotation at and under a node.

Modules

The ProAbstract module provides everything in the pro-abstract package. There are also some smaller collections of reëxports.

Organized by topic:

Organized by kind of thing:

ProAbstract.Types — The essential types, exported abstractly. Includes type families and data families.
ProAbstract.Optics — Lenses, prisms, traversals, etc. Many of these are class methods, but are exported here without their classes.
ProAbstract.Datatypes — Datatypes including with their constructors and record fields
ProAbstract.Families — Type families and data families.
ProAbstract.Classes — Typeclasses, mostly for the polymorphic optics.

Synopsis

data Document ann = Document {
- documentMetadata :: Metadata
- documentContent :: Blocks ann
}
data Block ann
- = BlockPlain (TaggedPlainBlock ann)
- | BlockParagraph (Paragraph ann)
- | BlockFork (TaggedBlocks ann)
newtype Blocks ann = Blocks (Seq (Block ann))
data TaggedBlocks ann = TaggedBlocks {
- blocksTag :: Tag ann
- taggedBlocks :: Blocks ann
}
data Paragraph ann = Paragraph {
- paragraphContent :: Lines ann
- paragraphAnnotation :: ann
}
class HasManyParagraphs x where
- allParagraphs :: Traversal' x (Paragraph (Annotation x))
data BlockTag ann
- = BlockTagFork (TaggedBlocks ann)
- | BlockTagPlain (TaggedPlainBlock ann)
data BlockTagContent ann
- = BlockTagContent_Fork (Blocks ann)
- | BlockTagContent_Plain (PlainBlock ann)
data Inline ann
- = InlineFork (TaggedLines ann)
- | InlinePlain (Fragment ann)
data Line ann = Line {
- lineInlines :: Seq (Inline ann)
- lineAnnotation :: ann
}
newtype Lines ann = Lines (Seq (Line ann))
data TaggedLines ann = TaggedLines {
- linesTag :: Tag ann
- taggedLines :: Lines ann
}
data Fragment ann = Fragment {
- fragmentText :: Text
- fragmentAnnotation :: ann
}
data PlainBlock ann = PlainBlock {
- plainBlockLines :: Seq (Fragment ann)
- plainBlockAnnotation :: ann
}
data TaggedPlainBlock ann = TaggedPlainBlock {
- plaintextTag :: Tag ann
- taggedPlaintext :: PlainBlock ann
}
class HasManyPlainInlines x where
- allPlainInlines :: Traversal' x (Fragment (Annotation x))
class HasManyPlainBlocks x where
- allPlainBlocks :: Traversal' x (TaggedPlainBlock (Annotation x))
data Tag ann = Tag {
- tagName :: Text
- tagMetadata :: Metadata
- tagAnnotation :: ann
}
name :: (HasTag x, JoinKinds (TagOpticKind x) A_Lens k) => Optic' k NoIx x Text
class HasTag x where
- type TagOpticKind x :: OpticKind
- tag :: Optic' (TagOpticKind x) NoIx x (Tag (Annotation x))
class HasManyTags x where
- allTags :: Traversal' x (Tag (Annotation x))
- allInlineTags :: Traversal' x (Tag (Annotation x))
class HasManyTags x => HasManyBlockTags x where
- allBlockTags :: Traversal' x (Tag (Annotation x))
class HasWitherableTags x where
- witherTags :: Monad f => (Tag (Annotation x) -> f (Maybe (Tag (Annotation x)))) -> x -> f x
- mapMaybeTags :: (Tag (Annotation x) -> Maybe (Tag (Annotation x))) -> x -> x
class HasManyTags x => HasWitherableInlineTags x where
- witherInlineTags :: Monad f => (Tag (Annotation x) -> f (Maybe (Tag (Annotation x)))) -> x -> f x
- mapMaybeInlineTags :: (Tag (Annotation x) -> Maybe (Tag (Annotation x))) -> x -> x
class HasManyBlockTags x => HasWitherableBlockTags x where
- witherBlockTags :: Monad f => (Tag (Annotation x) -> f (Maybe (Tag (Annotation x)))) -> x -> f x
- mapMaybeBlockTags :: (Tag (Annotation x) -> Maybe (Tag (Annotation x))) -> x -> x
type family Plain a
class CanBePlain x where
- plain :: Prism' x (Plain x)
type family Fork a
class CanFork x where
- fork :: Prism' x (Fork x)
tagged :: IsTaggedOrBare a => Prism' a (TaggedType a)
bare :: IsTaggedOrBare a => Prism' a (BareType a)
class IsTaggedOrBare a where
- type TaggedType a
- type BareType a
- taggedOrBare :: Iso' a (TaggedOrBare a)
data TaggedOrBare a
- = IsTagged (TaggedType a)
- | IsBare (BareType a)
data Metadata = Metadata {
- metadataProperties :: Set Text
- metadataSettings :: Map Text Text
}
class HasMetadata x where
- type MetadataOpticKind x
- metadata :: Optic' (MetadataOpticKind x) NoIx x Metadata
class HasManyMetadata x where
- allMetadata :: Traversal' x Metadata
properties :: (HasMetadata m, JoinKinds (MetadataOpticKind m) A_Lens k) => Optic' k NoIx m (Set Text)
hasProperty :: (HasMetadata m, JoinKinds (MetadataOpticKind m) A_Lens k) => Text -> Optic' k NoIx m Bool
settings :: (HasMetadata m, JoinKinds (MetadataOpticKind m) A_Lens k) => Optic' k NoIx m (Map Text Text)
atSetting :: (HasMetadata m, JoinKinds (MetadataOpticKind m) A_Lens k) => Text -> Optic' k NoIx m (Maybe Text)
data MetaItem
- = Property Text
- | Setting Text Text
metaList :: (HasMetadata m, Is (MetadataOpticKind m) An_AffineFold) => Getter m [MetaItem]
data MetaValue
- = MetaValue_Property
- | MetaValue_Setting Text
- | MetaValue_PropertyAndSetting Text
metaMap :: (HasMetadata m, JoinKinds (MetadataOpticKind m) An_Iso k) => Optic' k NoIx m (Map Text MetaValue)
type family Content a
class HasContent x x' where
- content :: Lens x x' (Content x) (Content x')
type HasContent' x = HasContent x x
type family Contents a
class HasContents x x' where
- contents :: Lens x x' (Seq (Contents x)) (Seq (Contents x'))
type HasContents' x = HasContents x x
type family Annotation x
class HasAnnotation x x' where
- annotation :: Lens x x' (Annotation x) (Annotation x')
type HasAnnotation' x = HasAnnotation x x
class HasManyAnnotations x x' where
- allAnnotations :: Traversal x x' (Annotation x) (Annotation x')
class CanBeTagless a where
- tagless :: KindOfText txt -> AffineFold a txt
class CanHaveTaglessContent a where
- taglessContent :: KindOfText t -> AffineFold a t
data KindOfText txt where
- TextLine :: KindOfText Text
- TextStanza :: KindOfText (Seq Text)
- TextParagraphs :: KindOfText (Seq (Seq Text))

Document

data Document ann Source #

Constructors

Document
Fields documentMetadata :: Metadata `metadata` documentContent :: Blocks ann `content`

Instances

Instances details

Eq ann => Eq (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Methods (==) :: Document ann -> Document ann -> Bool # (/=) :: Document ann -> Document ann -> Bool #
Show ann => Show (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Methods showsPrec :: Int -> Document ann -> ShowS # show :: Document ann -> String # showList :: [Document ann] -> ShowS #
Generic (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Associated Types type Rep (Document ann) :: Type -> Type # Methods from :: Document ann -> Rep (Document ann) x # to :: Rep (Document ann) x -> Document ann #
NFData ann => NFData (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Methods rnf :: Document ann -> () #
Hashable ann => Hashable (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Methods hashWithSalt :: Int -> Document ann -> Int # hash :: Document ann -> Int #
HasMetadata (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Associated Types type MetadataOpticKind (Document ann) Source # Methods metadata :: Optic' (MetadataOpticKind (Document ann)) NoIx (Document ann) Metadata Source #
HasManyMetadata (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Methods allMetadata :: Traversal' (Document ann) Metadata Source #
HasManyPlainInlines (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Methods allPlainInlines :: Traversal' (Document ann) (Fragment (Annotation (Document ann))) Source #
HasWitherableInlineTags (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Methods witherInlineTags :: Monad f => (Tag (Annotation (Document ann)) -> f (Maybe (Tag (Annotation (Document ann))))) -> Document ann -> f (Document ann) Source # mapMaybeInlineTags :: (Tag (Annotation (Document ann)) -> Maybe (Tag (Annotation (Document ann)))) -> Document ann -> Document ann Source #
HasWitherableBlockTags (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Methods witherBlockTags :: Monad f => (Tag (Annotation (Document ann)) -> f (Maybe (Tag (Annotation (Document ann))))) -> Document ann -> f (Document ann) Source # mapMaybeBlockTags :: (Tag (Annotation (Document ann)) -> Maybe (Tag (Annotation (Document ann)))) -> Document ann -> Document ann Source #
HasManyBlockTags (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Methods allBlockTags :: Traversal' (Document ann) (Tag (Annotation (Document ann))) Source #
HasWitherableTags (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Methods witherTags :: Monad f => (Tag (Annotation (Document ann)) -> f (Maybe (Tag (Annotation (Document ann))))) -> Document ann -> f (Document ann) Source # mapMaybeTags :: (Tag (Annotation (Document ann)) -> Maybe (Tag (Annotation (Document ann)))) -> Document ann -> Document ann Source #
HasManyTags (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Methods allTags :: Traversal' (Document ann) (Tag (Annotation (Document ann))) Source # allInlineTags :: Traversal' (Document ann) (Tag (Annotation (Document ann))) Source #
HasManyPlainBlocks (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Methods allPlainBlocks :: Traversal' (Document ann) (TaggedPlainBlock (Annotation (Document ann))) Source #
HasManyParagraphs (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Methods allParagraphs :: Traversal' (Document ann) (Paragraph (Annotation (Document ann))) Source #
CanHaveTaglessContent (Document ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (Document ann) t Source #
HasManyAnnotations (Document ann) (Document ann') Source #
Instance details Defined in ProAbstract.Structure.Document Methods allAnnotations :: Traversal (Document ann) (Document ann') (Annotation (Document ann)) (Annotation (Document ann')) Source #
HasContent (Document ann) (Document ann') Source #
Instance details Defined in ProAbstract.Structure.Document Methods content :: Lens (Document ann) (Document ann') (Content (Document ann)) (Content (Document ann')) Source #
HasContents (Document ann) (Document ann') Source #
Instance details Defined in ProAbstract.Structure.Document Methods contents :: Lens (Document ann) (Document ann') (Seq (Contents (Document ann))) (Seq (Contents (Document ann'))) Source #
type Rep (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document type Rep (Document ann) = D1 ('MetaData "Document" "ProAbstract.Structure.Document" "pro-abstract-0.3.0.0-CFjEApBZPUR1EoNCheWNFg" 'False) (C1 ('MetaCons "Document" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Metadata) :*: S1 ('MetaSel ('Just "documentContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Blocks ann))))
type Annotation (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document type Annotation (Document ann) = ann
type Content (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document type Content (Document ann) = Blocks ann
type Contents (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document type Contents (Document ann) = Block ann
type MetadataOpticKind (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document type MetadataOpticKind (Document ann) = A_Lens

Blocks

data Block ann Source #

Constructors

BlockPlain (TaggedPlainBlock ann)	`plain`
BlockParagraph (Paragraph ann)	`bare`
BlockFork (TaggedBlocks ann)	`fork`

Instances

Instances details

Eq ann => Eq (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods (==) :: Block ann -> Block ann -> Bool # (/=) :: Block ann -> Block ann -> Bool #
Show ann => Show (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods showsPrec :: Int -> Block ann -> ShowS # show :: Block ann -> String # showList :: [Block ann] -> ShowS #
Generic (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Associated Types type Rep (Block ann) :: Type -> Type # Methods from :: Block ann -> Rep (Block ann) x # to :: Rep (Block ann) x -> Block ann #
NFData ann => NFData (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods rnf :: Block ann -> () #
Hashable ann => Hashable (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods hashWithSalt :: Int -> Block ann -> Int # hash :: Block ann -> Int #
HasMetadata (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Associated Types type MetadataOpticKind (Block ann) Source # Methods metadata :: Optic' (MetadataOpticKind (Block ann)) NoIx (Block ann) Metadata Source #
HasManyMetadata (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allMetadata :: Traversal' (Block ann) Metadata Source #
CanFork (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods fork :: Prism' (Block ann) (Fork (Block ann)) Source #
HasManyPlainInlines (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allPlainInlines :: Traversal' (Block ann) (Fragment (Annotation (Block ann))) Source #
CanBePlain (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods plain :: Prism' (Block ann) (Plain (Block ann)) Source #
HasTag (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Associated Types type TagOpticKind (Block ann) Source # Methods tag :: Optic' (TagOpticKind (Block ann)) NoIx (Block ann) (Tag (Annotation (Block ann))) Source #
HasWitherableInlineTags (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods witherInlineTags :: Monad f => (Tag (Annotation (Block ann)) -> f (Maybe (Tag (Annotation (Block ann))))) -> Block ann -> f (Block ann) Source # mapMaybeInlineTags :: (Tag (Annotation (Block ann)) -> Maybe (Tag (Annotation (Block ann)))) -> Block ann -> Block ann Source #
HasManyBlockTags (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allBlockTags :: Traversal' (Block ann) (Tag (Annotation (Block ann))) Source #
HasManyTags (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allTags :: Traversal' (Block ann) (Tag (Annotation (Block ann))) Source # allInlineTags :: Traversal' (Block ann) (Tag (Annotation (Block ann))) Source #
HasManyPlainBlocks (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allPlainBlocks :: Traversal' (Block ann) (TaggedPlainBlock (Annotation (Block ann))) Source #
HasManyParagraphs (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allParagraphs :: Traversal' (Block ann) (Paragraph (Annotation (Block ann))) Source #
IsTaggedOrBare (Block ann) Source #
Instance details Defined in ProAbstract.Structure.IsTaggedOrBare Associated Types type TaggedType (Block ann) Source # type BareType (Block ann) Source # Methods taggedOrBare :: Iso' (Block ann) (TaggedOrBare (Block ann)) Source #
CanBeTagless (Block ann) Source #	Only a `bare` block is considered to be plain text, because `fork` and `plain` blocks have tags.
Instance details Defined in ProAbstract.Tagless.CanBeTagless Methods tagless :: KindOfText txt -> AffineFold (Block ann) txt Source #
CanHaveTaglessContent (Block ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (Block ann) t Source #
HasAnnotation (Block ann) (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods annotation :: Lens (Block ann) (Block ann) (Annotation (Block ann)) (Annotation (Block ann)) Source #
HasManyAnnotations (Block ann) (Block ann') Source #
Instance details Defined in ProAbstract.Structure.Block Methods allAnnotations :: Traversal (Block ann) (Block ann') (Annotation (Block ann)) (Annotation (Block ann')) Source #
type Rep (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Rep (Block ann) = D1 ('MetaData "Block" "ProAbstract.Structure.Block" "pro-abstract-0.3.0.0-CFjEApBZPUR1EoNCheWNFg" 'False) (C1 ('MetaCons "BlockPlain" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TaggedPlainBlock ann))) :+: (C1 ('MetaCons "BlockParagraph" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Paragraph ann))) :+: C1 ('MetaCons "BlockFork" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TaggedBlocks ann)))))
type Annotation (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Annotation (Block ann) = ann
type MetadataOpticKind (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block type MetadataOpticKind (Block ann) = An_AffineTraversal
type Fork (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Fork (Block ann) = TaggedBlocks ann
type Plain (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Plain (Block ann) = TaggedPlainBlock ann
type TagOpticKind (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block type TagOpticKind (Block ann) = An_AffineTraversal
type TaggedType (Block ann) Source #
Instance details Defined in ProAbstract.Structure.IsTaggedOrBare type TaggedType (Block ann) = BlockTag ann
type BareType (Block ann) Source #
Instance details Defined in ProAbstract.Structure.IsTaggedOrBare type BareType (Block ann) = Paragraph ann

newtype Blocks ann Source #

Constructors

Blocks (Seq (Block ann))

content

Instances

Instances details

IsList (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Associated Types type Item (Blocks ann) # Methods fromList :: [Item (Blocks ann)] -> Blocks ann # fromListN :: Int -> [Item (Blocks ann)] -> Blocks ann # toList :: Blocks ann -> [Item (Blocks ann)] #
Eq ann => Eq (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods (==) :: Blocks ann -> Blocks ann -> Bool # (/=) :: Blocks ann -> Blocks ann -> Bool #
Show ann => Show (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods showsPrec :: Int -> Blocks ann -> ShowS # show :: Blocks ann -> String # showList :: [Blocks ann] -> ShowS #
Generic (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Associated Types type Rep (Blocks ann) :: Type -> Type # Methods from :: Blocks ann -> Rep (Blocks ann) x # to :: Rep (Blocks ann) x -> Blocks ann #
Semigroup (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods (<>) :: Blocks ann -> Blocks ann -> Blocks ann # sconcat :: NonEmpty (Blocks ann) -> Blocks ann # stimes :: Integral b => b -> Blocks ann -> Blocks ann #
Monoid (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods mempty :: Blocks ann # mappend :: Blocks ann -> Blocks ann -> Blocks ann # mconcat :: [Blocks ann] -> Blocks ann #
NFData ann => NFData (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods rnf :: Blocks ann -> () #
Hashable ann => Hashable (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods hashWithSalt :: Int -> Blocks ann -> Int # hash :: Blocks ann -> Int #
HasManyMetadata (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allMetadata :: Traversal' (Blocks ann) Metadata Source #
HasManyPlainInlines (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allPlainInlines :: Traversal' (Blocks ann) (Fragment (Annotation (Blocks ann))) Source #
HasWitherableInlineTags (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods witherInlineTags :: Monad f => (Tag (Annotation (Blocks ann)) -> f (Maybe (Tag (Annotation (Blocks ann))))) -> Blocks ann -> f (Blocks ann) Source # mapMaybeInlineTags :: (Tag (Annotation (Blocks ann)) -> Maybe (Tag (Annotation (Blocks ann)))) -> Blocks ann -> Blocks ann Source #
HasWitherableBlockTags (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods witherBlockTags :: Monad f => (Tag (Annotation (Blocks ann)) -> f (Maybe (Tag (Annotation (Blocks ann))))) -> Blocks ann -> f (Blocks ann) Source # mapMaybeBlockTags :: (Tag (Annotation (Blocks ann)) -> Maybe (Tag (Annotation (Blocks ann)))) -> Blocks ann -> Blocks ann Source #
HasManyBlockTags (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allBlockTags :: Traversal' (Blocks ann) (Tag (Annotation (Blocks ann))) Source #
HasWitherableTags (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods witherTags :: Monad f => (Tag (Annotation (Blocks ann)) -> f (Maybe (Tag (Annotation (Blocks ann))))) -> Blocks ann -> f (Blocks ann) Source # mapMaybeTags :: (Tag (Annotation (Blocks ann)) -> Maybe (Tag (Annotation (Blocks ann)))) -> Blocks ann -> Blocks ann Source #
HasManyTags (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allTags :: Traversal' (Blocks ann) (Tag (Annotation (Blocks ann))) Source # allInlineTags :: Traversal' (Blocks ann) (Tag (Annotation (Blocks ann))) Source #
HasManyPlainBlocks (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allPlainBlocks :: Traversal' (Blocks ann) (TaggedPlainBlock (Annotation (Blocks ann))) Source #
HasManyParagraphs (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allParagraphs :: Traversal' (Blocks ann) (Paragraph (Annotation (Blocks ann))) Source #
CanBeTagless (Blocks ann) Source #
Instance details Defined in ProAbstract.Tagless.CanBeTagless Methods tagless :: KindOfText txt -> AffineFold (Blocks ann) txt Source #
CanHaveTaglessContent (Blocks ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (Blocks ann) t Source #
HasManyAnnotations (Blocks ann) (Blocks ann') Source #
Instance details Defined in ProAbstract.Structure.Block Methods allAnnotations :: Traversal (Blocks ann) (Blocks ann') (Annotation (Blocks ann)) (Annotation (Blocks ann')) Source #
HasContents (Blocks ann) (Blocks ann') Source #
Instance details Defined in ProAbstract.Structure.Block Methods contents :: Lens (Blocks ann) (Blocks ann') (Seq (Contents (Blocks ann))) (Seq (Contents (Blocks ann'))) Source #
type Rep (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Rep (Blocks ann) = D1 ('MetaData "Blocks" "ProAbstract.Structure.Block" "pro-abstract-0.3.0.0-CFjEApBZPUR1EoNCheWNFg" 'True) (C1 ('MetaCons "Blocks" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq (Block ann)))))
type Item (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Item (Blocks ann) = Block ann
type Annotation (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Annotation (Blocks ann) = ann
type Contents (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Contents (Blocks ann) = Block ann

data TaggedBlocks ann Source #

Constructors

TaggedBlocks
Fields blocksTag :: Tag ann `tag` taggedBlocks :: Blocks ann `content`

Instances

Instances details

Eq ann => Eq (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods (==) :: TaggedBlocks ann -> TaggedBlocks ann -> Bool # (/=) :: TaggedBlocks ann -> TaggedBlocks ann -> Bool #
Show ann => Show (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods showsPrec :: Int -> TaggedBlocks ann -> ShowS # show :: TaggedBlocks ann -> String # showList :: [TaggedBlocks ann] -> ShowS #
Generic (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Associated Types type Rep (TaggedBlocks ann) :: Type -> Type # Methods from :: TaggedBlocks ann -> Rep (TaggedBlocks ann) x # to :: Rep (TaggedBlocks ann) x -> TaggedBlocks ann #
NFData ann => NFData (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods rnf :: TaggedBlocks ann -> () #
Hashable ann => Hashable (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods hashWithSalt :: Int -> TaggedBlocks ann -> Int # hash :: TaggedBlocks ann -> Int #
HasMetadata (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Associated Types type MetadataOpticKind (TaggedBlocks ann) Source # Methods metadata :: Optic' (MetadataOpticKind (TaggedBlocks ann)) NoIx (TaggedBlocks ann) Metadata Source #
HasManyMetadata (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allMetadata :: Traversal' (TaggedBlocks ann) Metadata Source #
HasManyPlainInlines (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allPlainInlines :: Traversal' (TaggedBlocks ann) (Fragment (Annotation (TaggedBlocks ann))) Source #
HasTag (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Associated Types type TagOpticKind (TaggedBlocks ann) Source # Methods tag :: Optic' (TagOpticKind (TaggedBlocks ann)) NoIx (TaggedBlocks ann) (Tag (Annotation (TaggedBlocks ann))) Source #
HasWitherableInlineTags (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods witherInlineTags :: Monad f => (Tag (Annotation (TaggedBlocks ann)) -> f (Maybe (Tag (Annotation (TaggedBlocks ann))))) -> TaggedBlocks ann -> f (TaggedBlocks ann) Source # mapMaybeInlineTags :: (Tag (Annotation (TaggedBlocks ann)) -> Maybe (Tag (Annotation (TaggedBlocks ann)))) -> TaggedBlocks ann -> TaggedBlocks ann Source #
HasManyBlockTags (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allBlockTags :: Traversal' (TaggedBlocks ann) (Tag (Annotation (TaggedBlocks ann))) Source #
HasManyTags (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allTags :: Traversal' (TaggedBlocks ann) (Tag (Annotation (TaggedBlocks ann))) Source # allInlineTags :: Traversal' (TaggedBlocks ann) (Tag (Annotation (TaggedBlocks ann))) Source #
HasManyPlainBlocks (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allPlainBlocks :: Traversal' (TaggedBlocks ann) (TaggedPlainBlock (Annotation (TaggedBlocks ann))) Source #
HasManyParagraphs (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allParagraphs :: Traversal' (TaggedBlocks ann) (Paragraph (Annotation (TaggedBlocks ann))) Source #
CanHaveTaglessContent (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (TaggedBlocks ann) t Source #
HasAnnotation (TaggedBlocks ann) (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods annotation :: Lens (TaggedBlocks ann) (TaggedBlocks ann) (Annotation (TaggedBlocks ann)) (Annotation (TaggedBlocks ann)) Source #
HasManyAnnotations (TaggedBlocks ann) (TaggedBlocks ann') Source #
Instance details Defined in ProAbstract.Structure.Block Methods allAnnotations :: Traversal (TaggedBlocks ann) (TaggedBlocks ann') (Annotation (TaggedBlocks ann)) (Annotation (TaggedBlocks ann')) Source #
HasContent (TaggedBlocks ann) (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods content :: Lens (TaggedBlocks ann) (TaggedBlocks ann) (Content (TaggedBlocks ann)) (Content (TaggedBlocks ann)) Source #
HasContents (TaggedBlocks ann) (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods contents :: Lens (TaggedBlocks ann) (TaggedBlocks ann) (Seq (Contents (TaggedBlocks ann))) (Seq (Contents (TaggedBlocks ann))) Source #
type Rep (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Rep (TaggedBlocks ann) = D1 ('MetaData "TaggedBlocks" "ProAbstract.Structure.Block" "pro-abstract-0.3.0.0-CFjEApBZPUR1EoNCheWNFg" 'False) (C1 ('MetaCons "TaggedBlocks" 'PrefixI 'True) (S1 ('MetaSel ('Just "blocksTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Tag ann)) :*: S1 ('MetaSel ('Just "taggedBlocks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Blocks ann))))
type Annotation (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Annotation (TaggedBlocks ann) = ann
type Content (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Content (TaggedBlocks ann) = Blocks ann
type Contents (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Contents (TaggedBlocks ann) = Block ann
type MetadataOpticKind (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block type MetadataOpticKind (TaggedBlocks ann) = A_Lens
type TagOpticKind (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block type TagOpticKind (TaggedBlocks ann) = A_Lens

Paragraphs

data Paragraph ann Source #

A collection of Lines. 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 :: Lines ann `content` paragraphAnnotation :: ann `annotation`

Instances

Instances details

Eq ann => Eq (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph Methods (==) :: Paragraph ann -> Paragraph ann -> Bool # (/=) :: Paragraph ann -> Paragraph ann -> Bool #
Show ann => Show (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph Methods showsPrec :: Int -> Paragraph ann -> ShowS # show :: Paragraph ann -> String # showList :: [Paragraph ann] -> ShowS #
Generic (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph Associated Types type Rep (Paragraph ann) :: Type -> Type # Methods from :: Paragraph ann -> Rep (Paragraph ann) x # to :: Rep (Paragraph ann) x -> Paragraph ann #
NFData ann => NFData (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph Methods rnf :: Paragraph ann -> () #
Hashable ann => Hashable (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph Methods hashWithSalt :: Int -> Paragraph ann -> Int # hash :: Paragraph ann -> Int #
HasManyMetadata (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph Methods allMetadata :: Traversal' (Paragraph ann) Metadata Source #
HasManyPlainInlines (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph Methods allPlainInlines :: Traversal' (Paragraph ann) (Fragment (Annotation (Paragraph ann))) Source #
HasWitherableInlineTags (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph Methods witherInlineTags :: Monad f => (Tag (Annotation (Paragraph ann)) -> f (Maybe (Tag (Annotation (Paragraph ann))))) -> Paragraph ann -> f (Paragraph ann) Source # mapMaybeInlineTags :: (Tag (Annotation (Paragraph ann)) -> Maybe (Tag (Annotation (Paragraph ann)))) -> Paragraph ann -> Paragraph ann Source #
HasManyTags (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph Methods allTags :: Traversal' (Paragraph ann) (Tag (Annotation (Paragraph ann))) Source # allInlineTags :: Traversal' (Paragraph ann) (Tag (Annotation (Paragraph ann))) Source #
CanBeTagless (Paragraph ann) Source #
Instance details Defined in ProAbstract.Tagless.CanBeTagless Methods tagless :: KindOfText txt -> AffineFold (Paragraph ann) txt Source #
HasAnnotation (Paragraph ann) (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph Methods annotation :: Lens (Paragraph ann) (Paragraph ann) (Annotation (Paragraph ann)) (Annotation (Paragraph ann)) Source #
HasManyAnnotations (Paragraph ann) (Paragraph ann') Source #
Instance details Defined in ProAbstract.Structure.Paragraph Methods allAnnotations :: Traversal (Paragraph ann) (Paragraph ann') (Annotation (Paragraph ann)) (Annotation (Paragraph ann')) Source #
HasContent (Paragraph ann) (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph Methods content :: Lens (Paragraph ann) (Paragraph ann) (Content (Paragraph ann)) (Content (Paragraph ann)) Source #
HasContents (Paragraph ann) (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph Methods contents :: Lens (Paragraph ann) (Paragraph ann) (Seq (Contents (Paragraph ann))) (Seq (Contents (Paragraph ann))) Source #
type Rep (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph type Rep (Paragraph ann) = D1 ('MetaData "Paragraph" "ProAbstract.Structure.Paragraph" "pro-abstract-0.3.0.0-CFjEApBZPUR1EoNCheWNFg" 'False) (C1 ('MetaCons "Paragraph" 'PrefixI 'True) (S1 ('MetaSel ('Just "paragraphContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Lines ann)) :*: S1 ('MetaSel ('Just "paragraphAnnotation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ann)))
type Annotation (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph type Annotation (Paragraph ann) = ann
type Content (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph type Content (Paragraph ann) = Lines ann
type Contents (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph type Contents (Paragraph ann) = Line ann

class HasManyParagraphs x where Source #

Methods

allParagraphs :: Traversal' x (Paragraph (Annotation x)) Source #

Instances

Instances details

HasManyParagraphs (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allParagraphs :: Traversal' (TaggedBlocks ann) (Paragraph (Annotation (TaggedBlocks ann))) Source #
HasManyParagraphs (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allParagraphs :: Traversal' (Blocks ann) (Paragraph (Annotation (Blocks ann))) Source #
HasManyParagraphs (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allParagraphs :: Traversal' (Block ann) (Paragraph (Annotation (Block ann))) Source #
HasManyParagraphs (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Methods allParagraphs :: Traversal' (Document ann) (Paragraph (Annotation (Document ann))) Source #
HasManyParagraphs (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods allParagraphs :: Traversal' (BlockTagContent ann) (Paragraph (Annotation (BlockTagContent ann))) Source #
HasManyParagraphs (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods allParagraphs :: Traversal' (BlockTag ann) (Paragraph (Annotation (BlockTag ann))) Source #

Tag blocks

data BlockTag ann Source #

Constructors

BlockTagFork (TaggedBlocks ann)	`fork`
BlockTagPlain (TaggedPlainBlock ann)	`plain`

Instances

Instances details

Eq ann => Eq (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods (==) :: BlockTag ann -> BlockTag ann -> Bool # (/=) :: BlockTag ann -> BlockTag ann -> Bool #
Show ann => Show (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods showsPrec :: Int -> BlockTag ann -> ShowS # show :: BlockTag ann -> String # showList :: [BlockTag ann] -> ShowS #
Generic (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Associated Types type Rep (BlockTag ann) :: Type -> Type # Methods from :: BlockTag ann -> Rep (BlockTag ann) x # to :: Rep (BlockTag ann) x -> BlockTag ann #
NFData ann => NFData (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods rnf :: BlockTag ann -> () #
Hashable ann => Hashable (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods hashWithSalt :: Int -> BlockTag ann -> Int # hash :: BlockTag ann -> Int #
HasMetadata (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Associated Types type MetadataOpticKind (BlockTag ann) Source # Methods metadata :: Optic' (MetadataOpticKind (BlockTag ann)) NoIx (BlockTag ann) Metadata Source #
HasManyMetadata (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods allMetadata :: Traversal' (BlockTag ann) Metadata Source #
CanFork (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods fork :: Prism' (BlockTag ann) (Fork (BlockTag ann)) Source #
HasManyPlainInlines (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods allPlainInlines :: Traversal' (BlockTag ann) (Fragment (Annotation (BlockTag ann))) Source #
CanBePlain (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods plain :: Prism' (BlockTag ann) (Plain (BlockTag ann)) Source #
HasTag (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Associated Types type TagOpticKind (BlockTag ann) Source # Methods tag :: Optic' (TagOpticKind (BlockTag ann)) NoIx (BlockTag ann) (Tag (Annotation (BlockTag ann))) Source #
HasManyTags (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods allTags :: Traversal' (BlockTag ann) (Tag (Annotation (BlockTag ann))) Source # allInlineTags :: Traversal' (BlockTag ann) (Tag (Annotation (BlockTag ann))) Source #
HasManyPlainBlocks (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods allPlainBlocks :: Traversal' (BlockTag ann) (TaggedPlainBlock (Annotation (BlockTag ann))) Source #
HasManyParagraphs (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods allParagraphs :: Traversal' (BlockTag ann) (Paragraph (Annotation (BlockTag ann))) Source #
CanHaveTaglessContent (BlockTag ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (BlockTag ann) t Source #
HasAnnotation (BlockTag ann) (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods annotation :: Lens (BlockTag ann) (BlockTag ann) (Annotation (BlockTag ann)) (Annotation (BlockTag ann)) Source #
HasManyAnnotations (BlockTag ann) (BlockTag ann') Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods allAnnotations :: Traversal (BlockTag ann) (BlockTag ann') (Annotation (BlockTag ann)) (Annotation (BlockTag ann')) Source #
HasContent (BlockTag ann) (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods content :: Lens (BlockTag ann) (BlockTag ann) (Content (BlockTag ann)) (Content (BlockTag ann)) Source #
type Rep (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag type Rep (BlockTag ann) = D1 ('MetaData "BlockTag" "ProAbstract.Structure.BlockTag" "pro-abstract-0.3.0.0-CFjEApBZPUR1EoNCheWNFg" 'False) (C1 ('MetaCons "BlockTagFork" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TaggedBlocks ann))) :+: C1 ('MetaCons "BlockTagPlain" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TaggedPlainBlock ann))))
type Annotation (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag type Annotation (BlockTag ann) = ann
type Content (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag type Content (BlockTag ann) = BlockTagContent ann
type MetadataOpticKind (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag type MetadataOpticKind (BlockTag ann) = A_Lens
type Fork (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag type Fork (BlockTag ann) = TaggedBlocks ann
type Plain (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag type Plain (BlockTag ann) = TaggedPlainBlock ann
type TagOpticKind (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag type TagOpticKind (BlockTag ann) = A_Lens

data BlockTagContent ann Source #

Constructors

BlockTagContent_Fork (Blocks ann)	`fork`
BlockTagContent_Plain (PlainBlock ann)	`plain`

Instances

Instances details

Eq ann => Eq (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods (==) :: BlockTagContent ann -> BlockTagContent ann -> Bool # (/=) :: BlockTagContent ann -> BlockTagContent ann -> Bool #
Show ann => Show (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods showsPrec :: Int -> BlockTagContent ann -> ShowS # show :: BlockTagContent ann -> String # showList :: [BlockTagContent ann] -> ShowS #
Generic (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Associated Types type Rep (BlockTagContent ann) :: Type -> Type # Methods from :: BlockTagContent ann -> Rep (BlockTagContent ann) x # to :: Rep (BlockTagContent ann) x -> BlockTagContent ann #
NFData ann => NFData (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods rnf :: BlockTagContent ann -> () #
Hashable ann => Hashable (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods hashWithSalt :: Int -> BlockTagContent ann -> Int # hash :: BlockTagContent ann -> Int #
HasManyMetadata (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods allMetadata :: Traversal' (BlockTagContent ann) Metadata Source #
CanFork (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods fork :: Prism' (BlockTagContent ann) (Fork (BlockTagContent ann)) Source #
HasManyPlainInlines (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods allPlainInlines :: Traversal' (BlockTagContent ann) (Fragment (Annotation (BlockTagContent ann))) Source #
CanBePlain (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods plain :: Prism' (BlockTagContent ann) (Plain (BlockTagContent ann)) Source #
HasWitherableInlineTags (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods witherInlineTags :: Monad f => (Tag (Annotation (BlockTagContent ann)) -> f (Maybe (Tag (Annotation (BlockTagContent ann))))) -> BlockTagContent ann -> f (BlockTagContent ann) Source # mapMaybeInlineTags :: (Tag (Annotation (BlockTagContent ann)) -> Maybe (Tag (Annotation (BlockTagContent ann)))) -> BlockTagContent ann -> BlockTagContent ann Source #
HasWitherableBlockTags (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods witherBlockTags :: Monad f => (Tag (Annotation (BlockTagContent ann)) -> f (Maybe (Tag (Annotation (BlockTagContent ann))))) -> BlockTagContent ann -> f (BlockTagContent ann) Source # mapMaybeBlockTags :: (Tag (Annotation (BlockTagContent ann)) -> Maybe (Tag (Annotation (BlockTagContent ann)))) -> BlockTagContent ann -> BlockTagContent ann Source #
HasManyBlockTags (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods allBlockTags :: Traversal' (BlockTagContent ann) (Tag (Annotation (BlockTagContent ann))) Source #
HasWitherableTags (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods witherTags :: Monad f => (Tag (Annotation (BlockTagContent ann)) -> f (Maybe (Tag (Annotation (BlockTagContent ann))))) -> BlockTagContent ann -> f (BlockTagContent ann) Source # mapMaybeTags :: (Tag (Annotation (BlockTagContent ann)) -> Maybe (Tag (Annotation (BlockTagContent ann)))) -> BlockTagContent ann -> BlockTagContent ann Source #
HasManyTags (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods allTags :: Traversal' (BlockTagContent ann) (Tag (Annotation (BlockTagContent ann))) Source # allInlineTags :: Traversal' (BlockTagContent ann) (Tag (Annotation (BlockTagContent ann))) Source #
HasManyPlainBlocks (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods allPlainBlocks :: Traversal' (BlockTagContent ann) (TaggedPlainBlock (Annotation (BlockTagContent ann))) Source #
HasManyParagraphs (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods allParagraphs :: Traversal' (BlockTagContent ann) (Paragraph (Annotation (BlockTagContent ann))) Source #
CanBeTagless (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Tagless.CanBeTagless Methods tagless :: KindOfText txt -> AffineFold (BlockTagContent ann) txt Source #
CanHaveTaglessContent (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (BlockTagContent ann) t Source #
HasManyAnnotations (BlockTagContent ann) (BlockTagContent ann') Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods allAnnotations :: Traversal (BlockTagContent ann) (BlockTagContent ann') (Annotation (BlockTagContent ann)) (Annotation (BlockTagContent ann')) Source #
type Rep (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent type Rep (BlockTagContent ann) = D1 ('MetaData "BlockTagContent" "ProAbstract.Structure.BlockTagContent" "pro-abstract-0.3.0.0-CFjEApBZPUR1EoNCheWNFg" 'False) (C1 ('MetaCons "BlockTagContent_Fork" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Blocks ann))) :+: C1 ('MetaCons "BlockTagContent_Plain" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PlainBlock ann))))
type Annotation (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent type Annotation (BlockTagContent ann) = ann
type Fork (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent type Fork (BlockTagContent ann) = Blocks ann
type Plain (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent type Plain (BlockTagContent ann) = PlainBlock ann

Lines

data Inline ann Source #

Constructors

InlineFork (TaggedLines ann)	`fork`
InlinePlain (Fragment ann)	`plain`

Instances

Instances details

Eq ann => Eq (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods (==) :: Inline ann -> Inline ann -> Bool # (/=) :: Inline ann -> Inline ann -> Bool #
Show ann => Show (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods showsPrec :: Int -> Inline ann -> ShowS # show :: Inline ann -> String # showList :: [Inline ann] -> ShowS #
Generic (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Associated Types type Rep (Inline ann) :: Type -> Type # Methods from :: Inline ann -> Rep (Inline ann) x # to :: Rep (Inline ann) x -> Inline ann #
NFData ann => NFData (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods rnf :: Inline ann -> () #
Hashable ann => Hashable (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods hashWithSalt :: Int -> Inline ann -> Int # hash :: Inline ann -> Int #
HasMetadata (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Associated Types type MetadataOpticKind (Inline ann) Source # Methods metadata :: Optic' (MetadataOpticKind (Inline ann)) NoIx (Inline ann) Metadata Source #
HasManyMetadata (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allMetadata :: Traversal' (Inline ann) Metadata Source #
CanFork (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods fork :: Prism' (Inline ann) (Fork (Inline ann)) Source #
HasManyPlainInlines (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allPlainInlines :: Traversal' (Inline ann) (Fragment (Annotation (Inline ann))) Source #
CanBePlain (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods plain :: Prism' (Inline ann) (Plain (Inline ann)) Source #
HasTag (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Associated Types type TagOpticKind (Inline ann) Source # Methods tag :: Optic' (TagOpticKind (Inline ann)) NoIx (Inline ann) (Tag (Annotation (Inline ann))) Source #
HasManyTags (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allTags :: Traversal' (Inline ann) (Tag (Annotation (Inline ann))) Source # allInlineTags :: Traversal' (Inline ann) (Tag (Annotation (Inline ann))) Source #
IsTaggedOrBare (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.IsTaggedOrBare Associated Types type TaggedType (Inline ann) Source # type BareType (Inline ann) Source # Methods taggedOrBare :: Iso' (Inline ann) (TaggedOrBare (Inline ann)) Source #
CanBeTagless (Inline ann) Source #	Only a `plain` inline is considered to be plain text, because `fork` inlines have a tags.
Instance details Defined in ProAbstract.Tagless.CanBeTagless Methods tagless :: KindOfText txt -> AffineFold (Inline ann) txt Source #
CanHaveTaglessContent (Inline ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (Inline ann) t Source #
HasAnnotation (Inline ann) (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods annotation :: Lens (Inline ann) (Inline ann) (Annotation (Inline ann)) (Annotation (Inline ann)) Source #
HasManyAnnotations (Inline ann) (Inline ann') Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allAnnotations :: Traversal (Inline ann) (Inline ann') (Annotation (Inline ann)) (Annotation (Inline ann')) Source #
type Rep (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Rep (Inline ann) = D1 ('MetaData "Inline" "ProAbstract.Structure.Inline" "pro-abstract-0.3.0.0-CFjEApBZPUR1EoNCheWNFg" 'False) (C1 ('MetaCons "InlineFork" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TaggedLines ann))) :+: C1 ('MetaCons "InlinePlain" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Fragment ann))))
type Annotation (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Annotation (Inline ann) = ann
type MetadataOpticKind (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type MetadataOpticKind (Inline ann) = An_AffineTraversal
type Fork (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Fork (Inline ann) = TaggedLines ann
type Plain (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Plain (Inline ann) = Fragment ann
type TagOpticKind (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type TagOpticKind (Inline ann) = An_AffineTraversal
type TaggedType (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.IsTaggedOrBare type TaggedType (Inline ann) = TaggedLines ann
type BareType (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.IsTaggedOrBare type BareType (Inline ann) = Fragment ann

data Line ann Source #

Constructors

Line
Fields lineInlines :: Seq (Inline ann) `contentsSeq` lineAnnotation :: ann `annotation`

Instances

Instances details

IsList (Line ()) Source #
Instance details Defined in ProAbstract.Structure.Inline Associated Types type Item (Line ()) # Methods fromList :: [Item (Line ())] -> Line () # fromListN :: Int -> [Item (Line ())] -> Line () # toList :: Line () -> [Item (Line ())] #
Eq ann => Eq (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods (==) :: Line ann -> Line ann -> Bool # (/=) :: Line ann -> Line ann -> Bool #
Show ann => Show (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods showsPrec :: Int -> Line ann -> ShowS # show :: Line ann -> String # showList :: [Line ann] -> ShowS #
Generic (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Associated Types type Rep (Line ann) :: Type -> Type # Methods from :: Line ann -> Rep (Line ann) x # to :: Rep (Line ann) x -> Line ann #
NFData ann => NFData (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods rnf :: Line ann -> () #
Hashable ann => Hashable (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods hashWithSalt :: Int -> Line ann -> Int # hash :: Line ann -> Int #
HasManyMetadata (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allMetadata :: Traversal' (Line ann) Metadata Source #
HasManyPlainInlines (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allPlainInlines :: Traversal' (Line ann) (Fragment (Annotation (Line ann))) Source #
HasWitherableInlineTags (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods witherInlineTags :: Monad f => (Tag (Annotation (Line ann)) -> f (Maybe (Tag (Annotation (Line ann))))) -> Line ann -> f (Line ann) Source # mapMaybeInlineTags :: (Tag (Annotation (Line ann)) -> Maybe (Tag (Annotation (Line ann)))) -> Line ann -> Line ann Source #
HasWitherableTags (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods witherTags :: Monad f => (Tag (Annotation (Line ann)) -> f (Maybe (Tag (Annotation (Line ann))))) -> Line ann -> f (Line ann) Source # mapMaybeTags :: (Tag (Annotation (Line ann)) -> Maybe (Tag (Annotation (Line ann)))) -> Line ann -> Line ann Source #
HasManyTags (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allTags :: Traversal' (Line ann) (Tag (Annotation (Line ann))) Source # allInlineTags :: Traversal' (Line ann) (Tag (Annotation (Line ann))) Source #
CanBeTagless (Line ann) Source #
Instance details Defined in ProAbstract.Tagless.CanBeTagless Methods tagless :: KindOfText txt -> AffineFold (Line ann) txt Source #
CanHaveTaglessContent (Line ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (Line ann) t Source #
HasAnnotation (Line ann) (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods annotation :: Lens (Line ann) (Line ann) (Annotation (Line ann)) (Annotation (Line ann)) Source #
HasManyAnnotations (Line ann) (Line ann') Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allAnnotations :: Traversal (Line ann) (Line ann') (Annotation (Line ann)) (Annotation (Line ann')) Source #
HasContents (Line ann) (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods contents :: Lens (Line ann) (Line ann) (Seq (Contents (Line ann))) (Seq (Contents (Line ann))) Source #
type Rep (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Rep (Line ann) = D1 ('MetaData "Line" "ProAbstract.Structure.Inline" "pro-abstract-0.3.0.0-CFjEApBZPUR1EoNCheWNFg" 'False) (C1 ('MetaCons "Line" 'PrefixI 'True) (S1 ('MetaSel ('Just "lineInlines") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq (Inline ann))) :*: S1 ('MetaSel ('Just "lineAnnotation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ann)))
type Item (Line ()) Source #
Instance details Defined in ProAbstract.Structure.Inline type Item (Line ()) = Inline ()
type Annotation (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Annotation (Line ann) = ann
type Contents (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Contents (Line ann) = Inline ann

newtype Lines ann Source #

Constructors

Lines (Seq (Line ann))

contentsSeq

Instances

Instances details

IsList (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Associated Types type Item (Lines ann) # Methods fromList :: [Item (Lines ann)] -> Lines ann # fromListN :: Int -> [Item (Lines ann)] -> Lines ann # toList :: Lines ann -> [Item (Lines ann)] #
Eq ann => Eq (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods (==) :: Lines ann -> Lines ann -> Bool # (/=) :: Lines ann -> Lines ann -> Bool #
Show ann => Show (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods showsPrec :: Int -> Lines ann -> ShowS # show :: Lines ann -> String # showList :: [Lines ann] -> ShowS #
Generic (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Associated Types type Rep (Lines ann) :: Type -> Type # Methods from :: Lines ann -> Rep (Lines ann) x # to :: Rep (Lines ann) x -> Lines ann #
Semigroup (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods (<>) :: Lines ann -> Lines ann -> Lines ann # sconcat :: NonEmpty (Lines ann) -> Lines ann # stimes :: Integral b => b -> Lines ann -> Lines ann #
Monoid (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods mempty :: Lines ann # mappend :: Lines ann -> Lines ann -> Lines ann # mconcat :: [Lines ann] -> Lines ann #
NFData ann => NFData (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods rnf :: Lines ann -> () #
Hashable ann => Hashable (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods hashWithSalt :: Int -> Lines ann -> Int # hash :: Lines ann -> Int #
HasManyMetadata (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allMetadata :: Traversal' (Lines ann) Metadata Source #
HasManyPlainInlines (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allPlainInlines :: Traversal' (Lines ann) (Fragment (Annotation (Lines ann))) Source #
HasWitherableInlineTags (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods witherInlineTags :: Monad f => (Tag (Annotation (Lines ann)) -> f (Maybe (Tag (Annotation (Lines ann))))) -> Lines ann -> f (Lines ann) Source # mapMaybeInlineTags :: (Tag (Annotation (Lines ann)) -> Maybe (Tag (Annotation (Lines ann)))) -> Lines ann -> Lines ann Source #
HasWitherableTags (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods witherTags :: Monad f => (Tag (Annotation (Lines ann)) -> f (Maybe (Tag (Annotation (Lines ann))))) -> Lines ann -> f (Lines ann) Source # mapMaybeTags :: (Tag (Annotation (Lines ann)) -> Maybe (Tag (Annotation (Lines ann)))) -> Lines ann -> Lines ann Source #
HasManyTags (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allTags :: Traversal' (Lines ann) (Tag (Annotation (Lines ann))) Source # allInlineTags :: Traversal' (Lines ann) (Tag (Annotation (Lines ann))) Source #
CanBeTagless (Lines ann) Source #
Instance details Defined in ProAbstract.Tagless.CanBeTagless Methods tagless :: KindOfText txt -> AffineFold (Lines ann) txt Source #
CanHaveTaglessContent (Lines ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (Lines ann) t Source #
HasManyAnnotations (Lines ann) (Lines ann') Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allAnnotations :: Traversal (Lines ann) (Lines ann') (Annotation (Lines ann)) (Annotation (Lines ann')) Source #
HasContents (Lines ann) (Lines ann') Source #
Instance details Defined in ProAbstract.Structure.Inline Methods contents :: Lens (Lines ann) (Lines ann') (Seq (Contents (Lines ann))) (Seq (Contents (Lines ann'))) Source #
type Rep (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Rep (Lines ann) = D1 ('MetaData "Lines" "ProAbstract.Structure.Inline" "pro-abstract-0.3.0.0-CFjEApBZPUR1EoNCheWNFg" 'True) (C1 ('MetaCons "Lines" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq (Line ann)))))
type Item (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Item (Lines ann) = Line ann
type Annotation (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Annotation (Lines ann) = ann
type Contents (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Contents (Lines ann) = Line ann

data TaggedLines ann Source #

Constructors

TaggedLines
Fields linesTag :: Tag ann `tag` taggedLines :: Lines ann `content`

Instances

Instances details

Eq ann => Eq (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods (==) :: TaggedLines ann -> TaggedLines ann -> Bool # (/=) :: TaggedLines ann -> TaggedLines ann -> Bool #
Show ann => Show (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods showsPrec :: Int -> TaggedLines ann -> ShowS # show :: TaggedLines ann -> String # showList :: [TaggedLines ann] -> ShowS #
Generic (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Associated Types type Rep (TaggedLines ann) :: Type -> Type # Methods from :: TaggedLines ann -> Rep (TaggedLines ann) x # to :: Rep (TaggedLines ann) x -> TaggedLines ann #
NFData ann => NFData (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods rnf :: TaggedLines ann -> () #
Hashable ann => Hashable (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods hashWithSalt :: Int -> TaggedLines ann -> Int # hash :: TaggedLines ann -> Int #
HasMetadata (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Associated Types type MetadataOpticKind (TaggedLines ann) Source # Methods metadata :: Optic' (MetadataOpticKind (TaggedLines ann)) NoIx (TaggedLines ann) Metadata Source #
HasManyMetadata (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allMetadata :: Traversal' (TaggedLines ann) Metadata Source #
HasManyPlainInlines (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allPlainInlines :: Traversal' (TaggedLines ann) (Fragment (Annotation (TaggedLines ann))) Source #
HasTag (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Associated Types type TagOpticKind (TaggedLines ann) Source # Methods tag :: Optic' (TagOpticKind (TaggedLines ann)) NoIx (TaggedLines ann) (Tag (Annotation (TaggedLines ann))) Source #
HasWitherableInlineTags (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods witherInlineTags :: Monad f => (Tag (Annotation (TaggedLines ann)) -> f (Maybe (Tag (Annotation (TaggedLines ann))))) -> TaggedLines ann -> f (TaggedLines ann) Source # mapMaybeInlineTags :: (Tag (Annotation (TaggedLines ann)) -> Maybe (Tag (Annotation (TaggedLines ann)))) -> TaggedLines ann -> TaggedLines ann Source #
HasManyTags (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allTags :: Traversal' (TaggedLines ann) (Tag (Annotation (TaggedLines ann))) Source # allInlineTags :: Traversal' (TaggedLines ann) (Tag (Annotation (TaggedLines ann))) Source #
CanHaveTaglessContent (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (TaggedLines ann) t Source #
HasAnnotation (TaggedLines ann) (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods annotation :: Lens (TaggedLines ann) (TaggedLines ann) (Annotation (TaggedLines ann)) (Annotation (TaggedLines ann)) Source #
HasManyAnnotations (TaggedLines ann) (TaggedLines ann') Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allAnnotations :: Traversal (TaggedLines ann) (TaggedLines ann') (Annotation (TaggedLines ann)) (Annotation (TaggedLines ann')) Source #
HasContent (TaggedLines ann) (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods content :: Lens (TaggedLines ann) (TaggedLines ann) (Content (TaggedLines ann)) (Content (TaggedLines ann)) Source #
HasContents (TaggedLines ann) (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods contents :: Lens (TaggedLines ann) (TaggedLines ann) (Seq (Contents (TaggedLines ann))) (Seq (Contents (TaggedLines ann))) Source #
type Rep (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Rep (TaggedLines ann) = D1 ('MetaData "TaggedLines" "ProAbstract.Structure.Inline" "pro-abstract-0.3.0.0-CFjEApBZPUR1EoNCheWNFg" 'False) (C1 ('MetaCons "TaggedLines" 'PrefixI 'True) (S1 ('MetaSel ('Just "linesTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Tag ann)) :*: S1 ('MetaSel ('Just "taggedLines") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Lines ann))))
type Annotation (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Annotation (TaggedLines ann) = ann
type Content (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Content (TaggedLines ann) = Lines ann
type Contents (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Contents (TaggedLines ann) = Line ann
type MetadataOpticKind (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type MetadataOpticKind (TaggedLines ann) = A_Lens
type TagOpticKind (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type TagOpticKind (TaggedLines ann) = A_Lens

Plain text

data Fragment ann Source #

Constructors

Fragment
Fields fragmentText :: Text `content` fragmentAnnotation :: ann `annotation`

Instances

Instances details

Eq ann => Eq (Fragment ann) Source #
Instance details Defined in ProAbstract.Structure.Fragment Methods (==) :: Fragment ann -> Fragment ann -> Bool # (/=) :: Fragment ann -> Fragment ann -> Bool #
Show ann => Show (Fragment ann) Source #
Instance details Defined in ProAbstract.Structure.Fragment Methods showsPrec :: Int -> Fragment ann -> ShowS # show :: Fragment ann -> String # showList :: [Fragment ann] -> ShowS #
Generic (Fragment ann) Source #
Instance details Defined in ProAbstract.Structure.Fragment Associated Types type Rep (Fragment ann) :: Type -> Type # Methods from :: Fragment ann -> Rep (Fragment ann) x # to :: Rep (Fragment ann) x -> Fragment ann #
NFData ann => NFData (Fragment ann) Source #
Instance details Defined in ProAbstract.Structure.Fragment Methods rnf :: Fragment ann -> () #
Hashable ann => Hashable (Fragment ann) Source #
Instance details Defined in ProAbstract.Structure.Fragment Methods hashWithSalt :: Int -> Fragment ann -> Int # hash :: Fragment ann -> Int #
CanBeTagless (Fragment ann) Source #
Instance details Defined in ProAbstract.Tagless.CanBeTagless Methods tagless :: KindOfText txt -> AffineFold (Fragment ann) txt Source #
CanHaveTaglessContent (Fragment ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (Fragment ann) t Source #
HasAnnotation (Fragment ann) (Fragment ann') Source #
Instance details Defined in ProAbstract.Structure.Fragment Methods annotation :: Lens (Fragment ann) (Fragment ann') (Annotation (Fragment ann)) (Annotation (Fragment ann')) Source #
HasContent (Fragment ann) (Fragment ann) Source #
Instance details Defined in ProAbstract.Structure.Fragment Methods content :: Lens (Fragment ann) (Fragment ann) (Content (Fragment ann)) (Content (Fragment ann)) Source #
type Rep (Fragment ann) Source #
Instance details Defined in ProAbstract.Structure.Fragment type Rep (Fragment ann) = D1 ('MetaData "Fragment" "ProAbstract.Structure.Fragment" "pro-abstract-0.3.0.0-CFjEApBZPUR1EoNCheWNFg" 'False) (C1 ('MetaCons "Fragment" 'PrefixI 'True) (S1 ('MetaSel ('Just "fragmentText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "fragmentAnnotation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ann)))
type Annotation (Fragment ann) Source #
Instance details Defined in ProAbstract.Structure.Fragment type Annotation (Fragment ann) = ann
type Content (Fragment ann) Source #
Instance details Defined in ProAbstract.Structure.Fragment type Content (Fragment ann) = Text

data PlainBlock ann Source #

Constructors

PlainBlock
Fields plainBlockLines :: Seq (Fragment ann) `contentsSeq` plainBlockAnnotation :: ann `annotation`

Instances

Instances details

Eq ann => Eq (PlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods (==) :: PlainBlock ann -> PlainBlock ann -> Bool # (/=) :: PlainBlock ann -> PlainBlock ann -> Bool #
Show ann => Show (PlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods showsPrec :: Int -> PlainBlock ann -> ShowS # show :: PlainBlock ann -> String # showList :: [PlainBlock ann] -> ShowS #
Generic (PlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Associated Types type Rep (PlainBlock ann) :: Type -> Type # Methods from :: PlainBlock ann -> Rep (PlainBlock ann) x # to :: Rep (PlainBlock ann) x -> PlainBlock ann #
NFData ann => NFData (PlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods rnf :: PlainBlock ann -> () #
Hashable ann => Hashable (PlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods hashWithSalt :: Int -> PlainBlock ann -> Int # hash :: PlainBlock ann -> Int #
CanBeTagless (PlainBlock ann) Source #
Instance details Defined in ProAbstract.Tagless.CanBeTagless Methods tagless :: KindOfText txt -> AffineFold (PlainBlock ann) txt Source #
HasAnnotation (PlainBlock ann) (PlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods annotation :: Lens (PlainBlock ann) (PlainBlock ann) (Annotation (PlainBlock ann)) (Annotation (PlainBlock ann)) Source #
HasManyAnnotations (PlainBlock ann) (PlainBlock ann') Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods allAnnotations :: Traversal (PlainBlock ann) (PlainBlock ann') (Annotation (PlainBlock ann)) (Annotation (PlainBlock ann')) Source #
HasContents (PlainBlock ann) (PlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods contents :: Lens (PlainBlock ann) (PlainBlock ann) (Seq (Contents (PlainBlock ann))) (Seq (Contents (PlainBlock ann))) Source #
type Rep (PlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock type Rep (PlainBlock ann) = D1 ('MetaData "PlainBlock" "ProAbstract.Structure.PlainBlock" "pro-abstract-0.3.0.0-CFjEApBZPUR1EoNCheWNFg" 'False) (C1 ('MetaCons "PlainBlock" 'PrefixI 'True) (S1 ('MetaSel ('Just "plainBlockLines") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq (Fragment ann))) :*: S1 ('MetaSel ('Just "plainBlockAnnotation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ann)))
type Annotation (PlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock type Annotation (PlainBlock ann) = ann
type Contents (PlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock type Contents (PlainBlock ann) = Fragment ann

data TaggedPlainBlock ann Source #

Constructors

TaggedPlainBlock
Fields plaintextTag :: Tag ann `Tag` taggedPlaintext :: PlainBlock ann `content`

Instances

Instances details

Eq ann => Eq (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods (==) :: TaggedPlainBlock ann -> TaggedPlainBlock ann -> Bool # (/=) :: TaggedPlainBlock ann -> TaggedPlainBlock ann -> Bool #
Show ann => Show (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods showsPrec :: Int -> TaggedPlainBlock ann -> ShowS # show :: TaggedPlainBlock ann -> String # showList :: [TaggedPlainBlock ann] -> ShowS #
Generic (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Associated Types type Rep (TaggedPlainBlock ann) :: Type -> Type # Methods from :: TaggedPlainBlock ann -> Rep (TaggedPlainBlock ann) x # to :: Rep (TaggedPlainBlock ann) x -> TaggedPlainBlock ann #
NFData ann => NFData (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods rnf :: TaggedPlainBlock ann -> () #
Hashable ann => Hashable (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods hashWithSalt :: Int -> TaggedPlainBlock ann -> Int # hash :: TaggedPlainBlock ann -> Int #
HasMetadata (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Associated Types type MetadataOpticKind (TaggedPlainBlock ann) Source # Methods metadata :: Optic' (MetadataOpticKind (TaggedPlainBlock ann)) NoIx (TaggedPlainBlock ann) Metadata Source #
HasTag (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Associated Types type TagOpticKind (TaggedPlainBlock ann) Source # Methods tag :: Optic' (TagOpticKind (TaggedPlainBlock ann)) NoIx (TaggedPlainBlock ann) (Tag (Annotation (TaggedPlainBlock ann))) Source #
CanHaveTaglessContent (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (TaggedPlainBlock ann) t Source #
HasAnnotation (TaggedPlainBlock ann) (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods annotation :: Lens (TaggedPlainBlock ann) (TaggedPlainBlock ann) (Annotation (TaggedPlainBlock ann)) (Annotation (TaggedPlainBlock ann)) Source #
HasManyAnnotations (TaggedPlainBlock ann) (TaggedPlainBlock ann') Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods allAnnotations :: Traversal (TaggedPlainBlock ann) (TaggedPlainBlock ann') (Annotation (TaggedPlainBlock ann)) (Annotation (TaggedPlainBlock ann')) Source #
HasContent (TaggedPlainBlock ann) (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods content :: Lens (TaggedPlainBlock ann) (TaggedPlainBlock ann) (Content (TaggedPlainBlock ann)) (Content (TaggedPlainBlock ann)) Source #
HasContents (TaggedPlainBlock ann) (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods contents :: Lens (TaggedPlainBlock ann) (TaggedPlainBlock ann) (Seq (Contents (TaggedPlainBlock ann))) (Seq (Contents (TaggedPlainBlock ann))) Source #
type Rep (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock type Rep (TaggedPlainBlock ann) = D1 ('MetaData "TaggedPlainBlock" "ProAbstract.Structure.PlainBlock" "pro-abstract-0.3.0.0-CFjEApBZPUR1EoNCheWNFg" 'False) (C1 ('MetaCons "TaggedPlainBlock" 'PrefixI 'True) (S1 ('MetaSel ('Just "plaintextTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Tag ann)) :*: S1 ('MetaSel ('Just "taggedPlaintext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PlainBlock ann))))
type Annotation (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock type Annotation (TaggedPlainBlock ann) = ann
type Content (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock type Content (TaggedPlainBlock ann) = PlainBlock ann
type Contents (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock type Contents (TaggedPlainBlock ann) = Fragment ann
type MetadataOpticKind (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock type MetadataOpticKind (TaggedPlainBlock ann) = A_Lens
type TagOpticKind (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock type TagOpticKind (TaggedPlainBlock ann) = A_Lens

class HasManyPlainInlines x where Source #

Methods

allPlainInlines :: Traversal' x (Fragment (Annotation x)) Source #

Instances

Instances details

HasManyPlainInlines (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allPlainInlines :: Traversal' (TaggedLines ann) (Fragment (Annotation (TaggedLines ann))) Source #
HasManyPlainInlines (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allPlainInlines :: Traversal' (Lines ann) (Fragment (Annotation (Lines ann))) Source #
HasManyPlainInlines (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allPlainInlines :: Traversal' (Line ann) (Fragment (Annotation (Line ann))) Source #
HasManyPlainInlines (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allPlainInlines :: Traversal' (Inline ann) (Fragment (Annotation (Inline ann))) Source #
HasManyPlainInlines (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph Methods allPlainInlines :: Traversal' (Paragraph ann) (Fragment (Annotation (Paragraph ann))) Source #
HasManyPlainInlines (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allPlainInlines :: Traversal' (TaggedBlocks ann) (Fragment (Annotation (TaggedBlocks ann))) Source #
HasManyPlainInlines (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allPlainInlines :: Traversal' (Blocks ann) (Fragment (Annotation (Blocks ann))) Source #
HasManyPlainInlines (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allPlainInlines :: Traversal' (Block ann) (Fragment (Annotation (Block ann))) Source #
HasManyPlainInlines (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Methods allPlainInlines :: Traversal' (Document ann) (Fragment (Annotation (Document ann))) Source #
HasManyPlainInlines (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods allPlainInlines :: Traversal' (BlockTagContent ann) (Fragment (Annotation (BlockTagContent ann))) Source #
HasManyPlainInlines (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods allPlainInlines :: Traversal' (BlockTag ann) (Fragment (Annotation (BlockTag ann))) Source #

class HasManyPlainBlocks x where Source #

Methods

allPlainBlocks :: Traversal' x (TaggedPlainBlock (Annotation x)) Source #

Instances

Instances details

HasManyPlainBlocks (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allPlainBlocks :: Traversal' (TaggedBlocks ann) (TaggedPlainBlock (Annotation (TaggedBlocks ann))) Source #
HasManyPlainBlocks (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allPlainBlocks :: Traversal' (Blocks ann) (TaggedPlainBlock (Annotation (Blocks ann))) Source #
HasManyPlainBlocks (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allPlainBlocks :: Traversal' (Block ann) (TaggedPlainBlock (Annotation (Block ann))) Source #
HasManyPlainBlocks (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Methods allPlainBlocks :: Traversal' (Document ann) (TaggedPlainBlock (Annotation (Document ann))) Source #
HasManyPlainBlocks (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods allPlainBlocks :: Traversal' (BlockTagContent ann) (TaggedPlainBlock (Annotation (BlockTagContent ann))) Source #
HasManyPlainBlocks (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods allPlainBlocks :: Traversal' (BlockTag ann) (TaggedPlainBlock (Annotation (BlockTag ann))) Source #

Prisms

Plain/fork

type family Plain a Source #

Instances

Instances details

type Plain (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Plain (Inline ann) = Fragment ann
type Plain (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Plain (Block ann) = TaggedPlainBlock ann
type Plain (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent type Plain (BlockTagContent ann) = PlainBlock ann
type Plain (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag type Plain (BlockTag ann) = TaggedPlainBlock ann

class CanBePlain x where Source #

Methods

plain :: Prism' x (Plain x) Source #

Instances

Instances details

CanBePlain (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods plain :: Prism' (Inline ann) (Plain (Inline ann)) Source #
CanBePlain (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods plain :: Prism' (Block ann) (Plain (Block ann)) Source #
CanBePlain (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods plain :: Prism' (BlockTagContent ann) (Plain (BlockTagContent ann)) Source #
CanBePlain (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods plain :: Prism' (BlockTag ann) (Plain (BlockTag ann)) Source #

type family Fork a Source #

Instances

Instances details

type Fork (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Fork (Inline ann) = TaggedLines ann
type Fork (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Fork (Block ann) = TaggedBlocks ann
type Fork (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent type Fork (BlockTagContent ann) = Blocks ann
type Fork (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag type Fork (BlockTag ann) = TaggedBlocks ann

class CanFork x where Source #

Methods

fork :: Prism' x (Fork x) Source #

Instances

Instances details

CanFork (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods fork :: Prism' (Inline ann) (Fork (Inline ann)) Source #
CanFork (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods fork :: Prism' (Block ann) (Fork (Block ann)) Source #
CanFork (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods fork :: Prism' (BlockTagContent ann) (Fork (BlockTagContent ann)) Source #
CanFork (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods fork :: Prism' (BlockTag ann) (Fork (BlockTag ann)) Source #

Tagged/bare

tagged :: IsTaggedOrBare a => Prism' a (TaggedType a) Source #

bare :: IsTaggedOrBare a => Prism' a (BareType a) Source #

class IsTaggedOrBare a where Source #

Associated Types

type TaggedType a Source #

type BareType a Source #

Methods

taggedOrBare :: Iso' a (TaggedOrBare a) Source #

Instances

Instances details

IsTaggedOrBare (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.IsTaggedOrBare Associated Types type TaggedType (Inline ann) Source # type BareType (Inline ann) Source # Methods taggedOrBare :: Iso' (Inline ann) (TaggedOrBare (Inline ann)) Source #
IsTaggedOrBare (Block ann) Source #
Instance details Defined in ProAbstract.Structure.IsTaggedOrBare Associated Types type TaggedType (Block ann) Source # type BareType (Block ann) Source # Methods taggedOrBare :: Iso' (Block ann) (TaggedOrBare (Block ann)) Source #
IsTaggedOrBare (TaggedOrBare a) Source #
Instance details Defined in ProAbstract.Structure.IsTaggedOrBare Associated Types type TaggedType (TaggedOrBare a) Source # type BareType (TaggedOrBare a) Source # Methods taggedOrBare :: Iso' (TaggedOrBare a) (TaggedOrBare (TaggedOrBare a)) Source #

data TaggedOrBare a Source #

Constructors

IsTagged (TaggedType a)
IsBare (BareType a)

Instances

Instances details

IsTaggedOrBare (TaggedOrBare a) Source #
Instance details Defined in ProAbstract.Structure.IsTaggedOrBare Associated Types type TaggedType (TaggedOrBare a) Source # type BareType (TaggedOrBare a) Source # Methods taggedOrBare :: Iso' (TaggedOrBare a) (TaggedOrBare (TaggedOrBare a)) Source #
type TaggedType (TaggedOrBare a) Source #
Instance details Defined in ProAbstract.Structure.IsTaggedOrBare type TaggedType (TaggedOrBare a) = TaggedType a
type BareType (TaggedOrBare a) Source #
Instance details Defined in ProAbstract.Structure.IsTaggedOrBare type BareType (TaggedOrBare a) = BareType a

Metadata

data Metadata Source #

A set of properties and settings, associated with a document or tag.

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

Constructors

Metadata
Fields metadataProperties :: Set Text `properties` metadataSettings :: Map Text Text `settings`

Instances

Instances details

Eq Metadata Source #
Instance details Defined in ProAbstract.Metadata.MetadataType Methods (==) :: Metadata -> Metadata -> Bool # (/=) :: Metadata -> Metadata -> Bool #
Show Metadata Source #
Instance details Defined in ProAbstract.Metadata.MetadataType Methods showsPrec :: Int -> Metadata -> ShowS # show :: Metadata -> String # showList :: [Metadata] -> ShowS #
Generic Metadata Source #
Instance details Defined in ProAbstract.Metadata.MetadataType 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 ProAbstract.Metadata.MetadataType Methods (<>) :: Metadata -> Metadata -> Metadata # sconcat :: NonEmpty Metadata -> Metadata # stimes :: Integral b => b -> Metadata -> Metadata #
Monoid Metadata Source #
Instance details Defined in ProAbstract.Metadata.MetadataType Methods mempty :: Metadata # mappend :: Metadata -> Metadata -> Metadata # mconcat :: [Metadata] -> Metadata #
NFData Metadata Source #
Instance details Defined in ProAbstract.Metadata.MetadataType Methods rnf :: Metadata -> () #
Hashable Metadata Source #
Instance details Defined in ProAbstract.Metadata.MetadataType Methods hashWithSalt :: Int -> Metadata -> Int # hash :: Metadata -> Int #
HasMetadata Metadata Source #
Instance details Defined in ProAbstract.Metadata.HasMetadata Associated Types type MetadataOpticKind Metadata Source # Methods metadata :: Optic' (MetadataOpticKind Metadata) NoIx Metadata Metadata Source #
type Rep Metadata Source #
Instance details Defined in ProAbstract.Metadata.MetadataType type Rep Metadata = D1 ('MetaData "Metadata" "ProAbstract.Metadata.MetadataType" "pro-abstract-0.3.0.0-CFjEApBZPUR1EoNCheWNFg" 'False) (C1 ('MetaCons "Metadata" 'PrefixI 'True) (S1 ('MetaSel ('Just "metadataProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set Text)) :*: S1 ('MetaSel ('Just "metadataSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Text))))
type MetadataOpticKind Metadata Source #
Instance details Defined in ProAbstract.Metadata.HasMetadata type MetadataOpticKind Metadata = An_Iso

class HasMetadata x where Source #

Associated Types

type MetadataOpticKind x Source #

Methods

metadata :: Optic' (MetadataOpticKind x) NoIx x Metadata Source #

Instances

Instances details

HasMetadata Metadata Source #
Instance details Defined in ProAbstract.Metadata.HasMetadata Associated Types type MetadataOpticKind Metadata Source # Methods metadata :: Optic' (MetadataOpticKind Metadata) NoIx Metadata Metadata Source #
HasMetadata (Tag ann) Source #
Instance details Defined in ProAbstract.Tag.TagType Associated Types type MetadataOpticKind (Tag ann) Source # Methods metadata :: Optic' (MetadataOpticKind (Tag ann)) NoIx (Tag ann) Metadata Source #
HasMetadata (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Associated Types type MetadataOpticKind (TaggedPlainBlock ann) Source # Methods metadata :: Optic' (MetadataOpticKind (TaggedPlainBlock ann)) NoIx (TaggedPlainBlock ann) Metadata Source #
HasMetadata (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Associated Types type MetadataOpticKind (TaggedLines ann) Source # Methods metadata :: Optic' (MetadataOpticKind (TaggedLines ann)) NoIx (TaggedLines ann) Metadata Source #
HasMetadata (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Associated Types type MetadataOpticKind (Inline ann) Source # Methods metadata :: Optic' (MetadataOpticKind (Inline ann)) NoIx (Inline ann) Metadata Source #
HasMetadata (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Associated Types type MetadataOpticKind (TaggedBlocks ann) Source # Methods metadata :: Optic' (MetadataOpticKind (TaggedBlocks ann)) NoIx (TaggedBlocks ann) Metadata Source #
HasMetadata (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Associated Types type MetadataOpticKind (Block ann) Source # Methods metadata :: Optic' (MetadataOpticKind (Block ann)) NoIx (Block ann) Metadata Source #
HasMetadata (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Associated Types type MetadataOpticKind (Document ann) Source # Methods metadata :: Optic' (MetadataOpticKind (Document ann)) NoIx (Document ann) Metadata Source #
HasMetadata (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Associated Types type MetadataOpticKind (BlockTag ann) Source # Methods metadata :: Optic' (MetadataOpticKind (BlockTag ann)) NoIx (BlockTag ann) Metadata Source #

class HasManyMetadata x where Source #

Methods

allMetadata :: Traversal' x Metadata Source #

Instances

Instances details

HasManyMetadata (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allMetadata :: Traversal' (TaggedLines ann) Metadata Source #
HasManyMetadata (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allMetadata :: Traversal' (Lines ann) Metadata Source #
HasManyMetadata (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allMetadata :: Traversal' (Line ann) Metadata Source #
HasManyMetadata (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allMetadata :: Traversal' (Inline ann) Metadata Source #
HasManyMetadata (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph Methods allMetadata :: Traversal' (Paragraph ann) Metadata Source #
HasManyMetadata (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allMetadata :: Traversal' (TaggedBlocks ann) Metadata Source #
HasManyMetadata (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allMetadata :: Traversal' (Blocks ann) Metadata Source #
HasManyMetadata (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods allMetadata :: Traversal' (Block ann) Metadata Source #
HasManyMetadata (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document Methods allMetadata :: Traversal' (Document ann) Metadata Source #
HasManyMetadata (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods allMetadata :: Traversal' (BlockTagContent ann) Metadata Source #
HasManyMetadata (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods allMetadata :: Traversal' (BlockTag ann) Metadata Source #

Properties

properties :: (HasMetadata m, JoinKinds (MetadataOpticKind m) A_Lens k) => Optic' k NoIx m (Set Text) Source #

Fetch all properties from items which contain metadata.

hasProperty :: (HasMetadata m, JoinKinds (MetadataOpticKind m) A_Lens k) => Text -> Optic' k NoIx 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.

Settings

settings :: (HasMetadata m, JoinKinds (MetadataOpticKind m) A_Lens k) => Optic' k NoIx m (Map Text Text) Source #

Fetch all settings defined on items which contain metadata.

atSetting :: (HasMetadata m, JoinKinds (MetadataOpticKind m) A_Lens k) => Text -> Optic' k NoIx m (Maybe Text) Source #

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

Item list

data MetaItem Source #

Constructors

Property Text	key
Setting
Fields Text key Text value

Instances

Instances details

Eq MetaItem Source #
Instance details Defined in ProAbstract.Metadata.MetaItem Methods (==) :: MetaItem -> MetaItem -> Bool # (/=) :: MetaItem -> MetaItem -> Bool #
Ord MetaItem Source #
Instance details Defined in ProAbstract.Metadata.MetaItem Methods compare :: MetaItem -> MetaItem -> Ordering # (<) :: MetaItem -> MetaItem -> Bool # (<=) :: MetaItem -> MetaItem -> Bool # (>) :: MetaItem -> MetaItem -> Bool # (>=) :: MetaItem -> MetaItem -> Bool # max :: MetaItem -> MetaItem -> MetaItem # min :: MetaItem -> MetaItem -> MetaItem #
Show MetaItem Source #
Instance details Defined in ProAbstract.Metadata.MetaItem Methods showsPrec :: Int -> MetaItem -> ShowS # show :: MetaItem -> String # showList :: [MetaItem] -> ShowS #
Generic MetaItem Source #
Instance details Defined in ProAbstract.Metadata.MetaItem Associated Types type Rep MetaItem :: Type -> Type # Methods from :: MetaItem -> Rep MetaItem x # to :: Rep MetaItem x -> MetaItem #
NFData MetaItem Source #
Instance details Defined in ProAbstract.Metadata.MetaItem Methods rnf :: MetaItem -> () #
Hashable MetaItem Source #
Instance details Defined in ProAbstract.Metadata.MetaItem Methods hashWithSalt :: Int -> MetaItem -> Int # hash :: MetaItem -> Int #
type Rep MetaItem Source #
Instance details Defined in ProAbstract.Metadata.MetaItem type Rep MetaItem = D1 ('MetaData "MetaItem" "ProAbstract.Metadata.MetaItem" "pro-abstract-0.3.0.0-CFjEApBZPUR1EoNCheWNFg" 'False) (C1 ('MetaCons "Property" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "Setting" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

metaList :: (HasMetadata m, Is (MetadataOpticKind m) An_AffineFold) => Getter m [MetaItem] Source #

Value map

data MetaValue Source #

Constructors

MetaValue_Property
MetaValue_Setting Text	setting value
MetaValue_PropertyAndSetting Text	setting value

Instances

Instances details

Eq MetaValue Source #
Instance details Defined in ProAbstract.Metadata.MetaValue Methods (==) :: MetaValue -> MetaValue -> Bool # (/=) :: MetaValue -> MetaValue -> Bool #
Ord MetaValue Source #
Instance details Defined in ProAbstract.Metadata.MetaValue Methods compare :: MetaValue -> MetaValue -> Ordering # (<) :: MetaValue -> MetaValue -> Bool # (<=) :: MetaValue -> MetaValue -> Bool # (>) :: MetaValue -> MetaValue -> Bool # (>=) :: MetaValue -> MetaValue -> Bool # max :: MetaValue -> MetaValue -> MetaValue # min :: MetaValue -> MetaValue -> MetaValue #
Show MetaValue Source #
Instance details Defined in ProAbstract.Metadata.MetaValue Methods showsPrec :: Int -> MetaValue -> ShowS # show :: MetaValue -> String # showList :: [MetaValue] -> ShowS #
Generic MetaValue Source #
Instance details Defined in ProAbstract.Metadata.MetaValue Associated Types type Rep MetaValue :: Type -> Type # Methods from :: MetaValue -> Rep MetaValue x # to :: Rep MetaValue x -> MetaValue #
Semigroup MetaValue Source #
Instance details Defined in ProAbstract.Metadata.MetaValue Methods (<>) :: MetaValue -> MetaValue -> MetaValue # sconcat :: NonEmpty MetaValue -> MetaValue # stimes :: Integral b => b -> MetaValue -> MetaValue #
NFData MetaValue Source #
Instance details Defined in ProAbstract.Metadata.MetaValue Methods rnf :: MetaValue -> () #
Hashable MetaValue Source #
Instance details Defined in ProAbstract.Metadata.MetaValue Methods hashWithSalt :: Int -> MetaValue -> Int # hash :: MetaValue -> Int #
type Rep MetaValue Source #
Instance details Defined in ProAbstract.Metadata.MetaValue type Rep MetaValue = D1 ('MetaData "MetaValue" "ProAbstract.Metadata.MetaValue" "pro-abstract-0.3.0.0-CFjEApBZPUR1EoNCheWNFg" 'False) (C1 ('MetaCons "MetaValue_Property" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "MetaValue_Setting" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "MetaValue_PropertyAndSetting" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

metaMap :: (HasMetadata m, JoinKinds (MetadataOpticKind m) An_Iso k) => Optic' k NoIx m (Map Text MetaValue) Source #

Content

type family Content a Source #

Instances

Instances details

type Content (Fragment ann) Source #
Instance details Defined in ProAbstract.Structure.Fragment type Content (Fragment ann) = Text
type Content (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock type Content (TaggedPlainBlock ann) = PlainBlock ann
type Content (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Content (TaggedLines ann) = Lines ann
type Content (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph type Content (Paragraph ann) = Lines ann
type Content (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Content (TaggedBlocks ann) = Blocks ann
type Content (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document type Content (Document ann) = Blocks ann
type Content (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag type Content (BlockTag ann) = BlockTagContent ann

class HasContent x x' where Source #

Methods

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

Instances

Instances details

HasContent (Fragment ann) (Fragment ann) Source #
Instance details Defined in ProAbstract.Structure.Fragment Methods content :: Lens (Fragment ann) (Fragment ann) (Content (Fragment ann)) (Content (Fragment ann)) Source #
HasContent (TaggedPlainBlock ann) (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods content :: Lens (TaggedPlainBlock ann) (TaggedPlainBlock ann) (Content (TaggedPlainBlock ann)) (Content (TaggedPlainBlock ann)) Source #
HasContent (TaggedLines ann) (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods content :: Lens (TaggedLines ann) (TaggedLines ann) (Content (TaggedLines ann)) (Content (TaggedLines ann)) Source #
HasContent (Paragraph ann) (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph Methods content :: Lens (Paragraph ann) (Paragraph ann) (Content (Paragraph ann)) (Content (Paragraph ann)) Source #
HasContent (TaggedBlocks ann) (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods content :: Lens (TaggedBlocks ann) (TaggedBlocks ann) (Content (TaggedBlocks ann)) (Content (TaggedBlocks ann)) Source #
HasContent (Document ann) (Document ann') Source #
Instance details Defined in ProAbstract.Structure.Document Methods content :: Lens (Document ann) (Document ann') (Content (Document ann)) (Content (Document ann')) Source #
HasContent (BlockTag ann) (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods content :: Lens (BlockTag ann) (BlockTag ann) (Content (BlockTag ann)) (Content (BlockTag ann)) Source #

type HasContent' x = HasContent x x Source #

type Contents (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock type Contents (TaggedPlainBlock ann) = Fragment ann
type Contents (PlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock type Contents (PlainBlock ann) = Fragment ann
type Contents (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Contents (TaggedLines ann) = Line ann
type Contents (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Contents (Lines ann) = Line ann
type Contents (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Contents (Line ann) = Inline ann
type Contents (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph type Contents (Paragraph ann) = Line ann
type Contents (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Contents (TaggedBlocks ann) = Block ann
type Contents (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Contents (Blocks ann) = Block ann
type Contents (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document type Contents (Document ann) = Block ann

class HasContents x x' where Source #

Methods

contents :: Lens x x' (Seq (Contents x)) (Seq (Contents x')) Source #

Instances

Instances details

HasContents (TaggedPlainBlock ann) (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods contents :: Lens (TaggedPlainBlock ann) (TaggedPlainBlock ann) (Seq (Contents (TaggedPlainBlock ann))) (Seq (Contents (TaggedPlainBlock ann))) Source #
HasContents (PlainBlock ann) (PlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods contents :: Lens (PlainBlock ann) (PlainBlock ann) (Seq (Contents (PlainBlock ann))) (Seq (Contents (PlainBlock ann))) Source #
HasContents (TaggedLines ann) (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods contents :: Lens (TaggedLines ann) (TaggedLines ann) (Seq (Contents (TaggedLines ann))) (Seq (Contents (TaggedLines ann))) Source #
HasContents (Lines ann) (Lines ann') Source #
Instance details Defined in ProAbstract.Structure.Inline Methods contents :: Lens (Lines ann) (Lines ann') (Seq (Contents (Lines ann))) (Seq (Contents (Lines ann'))) Source #
HasContents (Line ann) (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods contents :: Lens (Line ann) (Line ann) (Seq (Contents (Line ann))) (Seq (Contents (Line ann))) Source #
HasContents (Paragraph ann) (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph Methods contents :: Lens (Paragraph ann) (Paragraph ann) (Seq (Contents (Paragraph ann))) (Seq (Contents (Paragraph ann))) Source #
HasContents (TaggedBlocks ann) (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods contents :: Lens (TaggedBlocks ann) (TaggedBlocks ann) (Seq (Contents (TaggedBlocks ann))) (Seq (Contents (TaggedBlocks ann))) Source #
HasContents (Blocks ann) (Blocks ann') Source #
Instance details Defined in ProAbstract.Structure.Block Methods contents :: Lens (Blocks ann) (Blocks ann') (Seq (Contents (Blocks ann))) (Seq (Contents (Blocks ann'))) Source #
HasContents (Document ann) (Document ann') Source #
Instance details Defined in ProAbstract.Structure.Document Methods contents :: Lens (Document ann) (Document ann') (Seq (Contents (Document ann))) (Seq (Contents (Document ann'))) Source #

type HasContents' x = HasContents x x Source #

Annotation

type family Annotation x Source #

Instances

Instances details

type Annotation (Fragment ann) Source #
Instance details Defined in ProAbstract.Structure.Fragment type Annotation (Fragment ann) = ann
type Annotation (Tag ann) Source #
Instance details Defined in ProAbstract.Tag.TagType type Annotation (Tag ann) = ann
type Annotation (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock type Annotation (TaggedPlainBlock ann) = ann
type Annotation (PlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock type Annotation (PlainBlock ann) = ann
type Annotation (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Annotation (TaggedLines ann) = ann
type Annotation (Lines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Annotation (Lines ann) = ann
type Annotation (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Annotation (Line ann) = ann
type Annotation (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline type Annotation (Inline ann) = ann
type Annotation (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph type Annotation (Paragraph ann) = ann
type Annotation (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Annotation (TaggedBlocks ann) = ann
type Annotation (Blocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Annotation (Blocks ann) = ann
type Annotation (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block type Annotation (Block ann) = ann
type Annotation (Document ann) Source #
Instance details Defined in ProAbstract.Structure.Document type Annotation (Document ann) = ann
type Annotation (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent type Annotation (BlockTagContent ann) = ann
type Annotation (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag type Annotation (BlockTag ann) = ann

class HasAnnotation x x' where Source #

Methods

annotation :: Lens x x' (Annotation x) (Annotation x') Source #

Instances

Instances details

HasAnnotation (Fragment ann) (Fragment ann') Source #
Instance details Defined in ProAbstract.Structure.Fragment Methods annotation :: Lens (Fragment ann) (Fragment ann') (Annotation (Fragment ann)) (Annotation (Fragment ann')) Source #
HasAnnotation (Tag ann) (Tag ann') Source #
Instance details Defined in ProAbstract.Tag.TagType Methods annotation :: Lens (Tag ann) (Tag ann') (Annotation (Tag ann)) (Annotation (Tag ann')) Source #
HasAnnotation (TaggedPlainBlock ann) (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods annotation :: Lens (TaggedPlainBlock ann) (TaggedPlainBlock ann) (Annotation (TaggedPlainBlock ann)) (Annotation (TaggedPlainBlock ann)) Source #
HasAnnotation (PlainBlock ann) (PlainBlock ann) Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods annotation :: Lens (PlainBlock ann) (PlainBlock ann) (Annotation (PlainBlock ann)) (Annotation (PlainBlock ann)) Source #
HasAnnotation (TaggedLines ann) (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods annotation :: Lens (TaggedLines ann) (TaggedLines ann) (Annotation (TaggedLines ann)) (Annotation (TaggedLines ann)) Source #
HasAnnotation (Line ann) (Line ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods annotation :: Lens (Line ann) (Line ann) (Annotation (Line ann)) (Annotation (Line ann)) Source #
HasAnnotation (Inline ann) (Inline ann) Source #
Instance details Defined in ProAbstract.Structure.Inline Methods annotation :: Lens (Inline ann) (Inline ann) (Annotation (Inline ann)) (Annotation (Inline ann)) Source #
HasAnnotation (Paragraph ann) (Paragraph ann) Source #
Instance details Defined in ProAbstract.Structure.Paragraph Methods annotation :: Lens (Paragraph ann) (Paragraph ann) (Annotation (Paragraph ann)) (Annotation (Paragraph ann)) Source #
HasAnnotation (TaggedBlocks ann) (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods annotation :: Lens (TaggedBlocks ann) (TaggedBlocks ann) (Annotation (TaggedBlocks ann)) (Annotation (TaggedBlocks ann)) Source #
HasAnnotation (Block ann) (Block ann) Source #
Instance details Defined in ProAbstract.Structure.Block Methods annotation :: Lens (Block ann) (Block ann) (Annotation (Block ann)) (Annotation (Block ann)) Source #
HasAnnotation (BlockTag ann) (BlockTag ann) Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods annotation :: Lens (BlockTag ann) (BlockTag ann) (Annotation (BlockTag ann)) (Annotation (BlockTag ann)) Source #

type HasAnnotation' x = HasAnnotation x x Source #

class HasManyAnnotations x x' where Source #

Methods

allAnnotations :: Traversal x x' (Annotation x) (Annotation x') Source #

Instances

Instances details

HasManyAnnotations (TaggedPlainBlock ann) (TaggedPlainBlock ann') Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods allAnnotations :: Traversal (TaggedPlainBlock ann) (TaggedPlainBlock ann') (Annotation (TaggedPlainBlock ann)) (Annotation (TaggedPlainBlock ann')) Source #
HasManyAnnotations (PlainBlock ann) (PlainBlock ann') Source #
Instance details Defined in ProAbstract.Structure.PlainBlock Methods allAnnotations :: Traversal (PlainBlock ann) (PlainBlock ann') (Annotation (PlainBlock ann)) (Annotation (PlainBlock ann')) Source #
HasManyAnnotations (TaggedLines ann) (TaggedLines ann') Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allAnnotations :: Traversal (TaggedLines ann) (TaggedLines ann') (Annotation (TaggedLines ann)) (Annotation (TaggedLines ann')) Source #
HasManyAnnotations (Lines ann) (Lines ann') Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allAnnotations :: Traversal (Lines ann) (Lines ann') (Annotation (Lines ann)) (Annotation (Lines ann')) Source #
HasManyAnnotations (Line ann) (Line ann') Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allAnnotations :: Traversal (Line ann) (Line ann') (Annotation (Line ann)) (Annotation (Line ann')) Source #
HasManyAnnotations (Inline ann) (Inline ann') Source #
Instance details Defined in ProAbstract.Structure.Inline Methods allAnnotations :: Traversal (Inline ann) (Inline ann') (Annotation (Inline ann)) (Annotation (Inline ann')) Source #
HasManyAnnotations (Paragraph ann) (Paragraph ann') Source #
Instance details Defined in ProAbstract.Structure.Paragraph Methods allAnnotations :: Traversal (Paragraph ann) (Paragraph ann') (Annotation (Paragraph ann)) (Annotation (Paragraph ann')) Source #
HasManyAnnotations (TaggedBlocks ann) (TaggedBlocks ann') Source #
Instance details Defined in ProAbstract.Structure.Block Methods allAnnotations :: Traversal (TaggedBlocks ann) (TaggedBlocks ann') (Annotation (TaggedBlocks ann)) (Annotation (TaggedBlocks ann')) Source #
HasManyAnnotations (Blocks ann) (Blocks ann') Source #
Instance details Defined in ProAbstract.Structure.Block Methods allAnnotations :: Traversal (Blocks ann) (Blocks ann') (Annotation (Blocks ann)) (Annotation (Blocks ann')) Source #
HasManyAnnotations (Block ann) (Block ann') Source #
Instance details Defined in ProAbstract.Structure.Block Methods allAnnotations :: Traversal (Block ann) (Block ann') (Annotation (Block ann)) (Annotation (Block ann')) Source #
HasManyAnnotations (Document ann) (Document ann') Source #
Instance details Defined in ProAbstract.Structure.Document Methods allAnnotations :: Traversal (Document ann) (Document ann') (Annotation (Document ann)) (Annotation (Document ann')) Source #
HasManyAnnotations (BlockTagContent ann) (BlockTagContent ann') Source #
Instance details Defined in ProAbstract.Structure.BlockTagContent Methods allAnnotations :: Traversal (BlockTagContent ann) (BlockTagContent ann') (Annotation (BlockTagContent ann)) (Annotation (BlockTagContent ann')) Source #
HasManyAnnotations (BlockTag ann) (BlockTag ann') Source #
Instance details Defined in ProAbstract.Structure.BlockTag Methods allAnnotations :: Traversal (BlockTag ann) (BlockTag ann') (Annotation (BlockTag ann)) (Annotation (BlockTag ann')) Source #

Tagless content

class CanBeTagless a where Source #

Methods

tagless :: KindOfText txt -> AffineFold a txt Source #

Instances

Instances details

CanBeTagless (Fragment ann) Source #
Instance details Defined in ProAbstract.Tagless.CanBeTagless Methods tagless :: KindOfText txt -> AffineFold (Fragment ann) txt Source #
CanBeTagless (PlainBlock ann) Source #
Instance details Defined in ProAbstract.Tagless.CanBeTagless Methods tagless :: KindOfText txt -> AffineFold (PlainBlock ann) txt Source #
CanBeTagless (Lines ann) Source #
Instance details Defined in ProAbstract.Tagless.CanBeTagless Methods tagless :: KindOfText txt -> AffineFold (Lines ann) txt Source #
CanBeTagless (Line ann) Source #
Instance details Defined in ProAbstract.Tagless.CanBeTagless Methods tagless :: KindOfText txt -> AffineFold (Line ann) txt Source #
CanBeTagless (Inline ann) Source #	Only a `plain` inline is considered to be plain text, because `fork` inlines have a tags.
Instance details Defined in ProAbstract.Tagless.CanBeTagless Methods tagless :: KindOfText txt -> AffineFold (Inline ann) txt Source #
CanBeTagless (Paragraph ann) Source #
Instance details Defined in ProAbstract.Tagless.CanBeTagless Methods tagless :: KindOfText txt -> AffineFold (Paragraph ann) txt Source #
CanBeTagless (Blocks ann) Source #
Instance details Defined in ProAbstract.Tagless.CanBeTagless Methods tagless :: KindOfText txt -> AffineFold (Blocks ann) txt Source #
CanBeTagless (Block ann) Source #	Only a `bare` block is considered to be plain text, because `fork` and `plain` blocks have tags.
Instance details Defined in ProAbstract.Tagless.CanBeTagless Methods tagless :: KindOfText txt -> AffineFold (Block ann) txt Source #
CanBeTagless (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Tagless.CanBeTagless Methods tagless :: KindOfText txt -> AffineFold (BlockTagContent ann) txt Source #

class CanHaveTaglessContent a where Source #

Methods

taglessContent :: KindOfText t -> AffineFold a t Source #

Instances

Instances details

CanHaveTaglessContent (Fragment ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (Fragment ann) t Source #
CanHaveTaglessContent (TaggedPlainBlock ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (TaggedPlainBlock ann) t Source #
CanHaveTaglessContent (TaggedLines ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (TaggedLines ann) t Source #
CanHaveTaglessContent (Lines ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (Lines ann) t Source #
CanHaveTaglessContent (Line ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (Line ann) t Source #
CanHaveTaglessContent (Inline ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (Inline ann) t Source #
CanHaveTaglessContent (TaggedBlocks ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (TaggedBlocks ann) t Source #
CanHaveTaglessContent (Blocks ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (Blocks ann) t Source #
CanHaveTaglessContent (Block ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (Block ann) t Source #
CanHaveTaglessContent (Document ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (Document ann) t Source #
CanHaveTaglessContent (BlockTagContent ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (BlockTagContent ann) t Source #
CanHaveTaglessContent (BlockTag ann) Source #
Instance details Defined in ProAbstract.Tagless.CanHaveTaglessContent Methods taglessContent :: KindOfText t -> AffineFold (BlockTag ann) t Source #

data KindOfText txt where Source #

Constructors

TextLine :: KindOfText Text
TextStanza :: KindOfText (Seq Text)
TextParagraphs :: KindOfText (Seq (Seq Text))

Eq ann => Eq (Tag ann) Source #
Instance details Defined in ProAbstract.Tag.TagType Methods (==) :: Tag ann -> Tag ann -> Bool # (/=) :: Tag ann -> Tag ann -> Bool #
Show ann => Show (Tag ann) Source #
Instance details Defined in ProAbstract.Tag.TagType Methods showsPrec :: Int -> Tag ann -> ShowS # show :: Tag ann -> String # showList :: [Tag ann] -> ShowS #
Generic (Tag ann) Source #
Instance details Defined in ProAbstract.Tag.TagType Associated Types type Rep (Tag ann) :: Type -> Type # Methods from :: Tag ann -> Rep (Tag ann) x # to :: Rep (Tag ann) x -> Tag ann #
NFData ann => NFData (Tag ann) Source #
Instance details Defined in ProAbstract.Tag.TagType Methods rnf :: Tag ann -> () #
Hashable ann => Hashable (Tag ann) Source #
Instance details Defined in ProAbstract.Tag.TagType Methods hashWithSalt :: Int -> Tag ann -> Int # hash :: Tag ann -> Int #
HasMetadata (Tag ann) Source #
Instance details Defined in ProAbstract.Tag.TagType Associated Types type MetadataOpticKind (Tag ann) Source # Methods metadata :: Optic' (MetadataOpticKind (Tag ann)) NoIx (Tag ann) Metadata Source #
HasTag (Tag ann) Source #
Instance details Defined in ProAbstract.Tag.HasTag Associated Types type TagOpticKind (Tag ann) Source # Methods tag :: Optic' (TagOpticKind (Tag ann)) NoIx (Tag ann) (Tag (Annotation (Tag ann))) Source #
HasAnnotation (Tag ann) (Tag ann') Source #
Instance details Defined in ProAbstract.Tag.TagType Methods annotation :: Lens (Tag ann) (Tag ann') (Annotation (Tag ann)) (Annotation (Tag ann')) Source #
type Rep (Tag ann) Source #
Instance details Defined in ProAbstract.Tag.TagType type Rep (Tag ann) = D1 ('MetaData "Tag" "ProAbstract.Tag.TagType" "pro-abstract-0.3.0.0-CFjEApBZPUR1EoNCheWNFg" 'False) (C1 ('MetaCons "Tag" 'PrefixI 'True) (S1 ('MetaSel ('Just "tagName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "tagMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Metadata) :: S1 ('MetaSel ('Just "tagAnnotation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ann))))
type Annotation (Tag ann) Source #
Instance details Defined in ProAbstract.Tag.TagType type Annotation (Tag ann) = ann
type MetadataOpticKind (Tag ann) Source #
Instance details Defined in ProAbstract.Tag.TagType type MetadataOpticKind (Tag ann) = A_Lens
type TagOpticKind (Tag ann) Source #
Instance details Defined in ProAbstract.Tag.HasTag type TagOpticKind (Tag ann) = A_Lens

Tag
Fields tagName :: Text `name` tagMetadata :: Metadata `metadata` tagAnnotation :: ann `annotation`

Document

Tagged nodes

The Block level

BlockTag

The Inline level

Fragments

Metadata

Content

Tagged or bare

Fork or plain

Annotation

Modules

Document

Instances

Blocks

Instances

Instances

Instances

Paragraphs

Instances

Instances

Tag blocks

Instances

Instances

Lines

Instances

Instances

Instances

Instances

Plain text

Instances

Instances

Instances

Instances

Instances

Tags

Instances

Instances

Traversal

Instances

Instances

Withering

Instances

Instances

Instances

Prisms

Plain/fork

Instances

Instances

Instances

Instances

Tagged/bare

Instances

Instances

Metadata

Instances

Instances

Instances

Properties

Settings

Item list

Instances

Value map

Instances

Content

Instances

Instances

Contents

Instances

Instances

Annotation

Instances

Instances

Instances

Tagless content

Instances

Instances