pro-abstract-0.3.0.0: Abstract syntax for writing documents
Safe HaskellNone
LanguageHaskell2010

ProAbstract.Metadata

Synopsis

Documentation

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

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

Fetch all properties from items which contain metadata.

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.

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.

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.

data MetaItem Source #

Constructors

Property Text

key

Setting 

Fields

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)))

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 #

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