Safe Haskell	Safe-Inferred
Language	Haskell2010

Patat.Presentation

Synopsis

data PresentationSettings = PresentationSettings {
- psRows :: !(Maybe (FlexibleNum Int))
- psColumns :: !(Maybe (FlexibleNum Int))
- psMargins :: !(Maybe MarginSettings)
- psWrap :: !(Maybe Wrap)
- psTabStop :: !(Maybe (FlexibleNum Int))
- psTheme :: !(Maybe Theme)
- psIncrementalLists :: !(Maybe Bool)
- psAutoAdvanceDelay :: !(Maybe (FlexibleNum Int))
- psSlideLevel :: !(Maybe Int)
- psPandocExtensions :: !(Maybe ExtensionList)
- psImages :: !(Maybe ImageSettings)
- psBreadcrumbs :: !(Maybe Bool)
- psEval :: !(Maybe EvalSettingsMap)
- psSlideNumber :: !(Maybe Bool)
- psSyntaxDefinitions :: !(Maybe [FilePath])
- psSpeakerNotes :: !(Maybe SpeakerNotesSettings)
- psTransition :: !(Maybe TransitionSettings)
}
defaultPresentationSettings :: PresentationSettings
data VarGen
data Var
zeroVarGen :: VarGen
data Presentation = Presentation {
- pFilePath :: !FilePath
- pEncodingFallback :: !EncodingFallback
- pTitle :: ![Inline]
- pAuthor :: ![Inline]
- pSettings :: !PresentationSettings
- pSlides :: !(Seq Slide)
- pBreadcrumbs :: !(Seq Breadcrumbs)
- pSlideSettings :: !(Seq PresentationSettings)
- pTransitionGens :: !(Seq (Maybe TransitionGen))
- pActiveFragment :: !Index
- pSyntaxMap :: !SyntaxMap
- pEvalBlocks :: !EvalBlocks
- pVarGen :: !VarGen
- pVars :: !(HashMap Var [Block])
}
readPresentation :: VarGen -> FilePath -> IO (Either String Presentation)
activeSpeakerNotes :: Presentation -> SpeakerNotes
activeVars :: Presentation -> HashSet Var
data Size
getPresentationSize :: Presentation -> IO Size
data Display
- = DisplayDoc Doc
- | DisplayImage FilePath
displayPresentation :: Size -> Presentation -> Display
displayPresentationError :: Size -> Presentation -> String -> Doc
dumpPresentation :: Presentation -> IO ()
data PresentationCommand
- = Exit
- | Forward
- | Backward
- | SkipForward
- | SkipBackward
- | First
- | Last
- | Reload
- | Seek Int
- | UpdateVar Var [Block]
- | UnknownCommand String
readPresentationCommand :: Handle -> IO PresentationCommand
data UpdatedPresentation
updatePresentation :: PresentationCommand -> Presentation -> IO UpdatedPresentation

Documentation

data PresentationSettings Source #

These are patat-specific settings. That is where they differ from more general metadata (author, title...)

Constructors

PresentationSettings

Fields

psRows :: !(Maybe (FlexibleNum Int))
psColumns :: !(Maybe (FlexibleNum Int))
psMargins :: !(Maybe MarginSettings)
psWrap :: !(Maybe Wrap)
psTabStop :: !(Maybe (FlexibleNum Int))
psTheme :: !(Maybe Theme)
psIncrementalLists :: !(Maybe Bool)
psAutoAdvanceDelay :: !(Maybe (FlexibleNum Int))
psSlideLevel :: !(Maybe Int)
psPandocExtensions :: !(Maybe ExtensionList)
psImages :: !(Maybe ImageSettings)
psBreadcrumbs :: !(Maybe Bool)
psEval :: !(Maybe EvalSettingsMap)
psSlideNumber :: !(Maybe Bool)
psSyntaxDefinitions :: !(Maybe [FilePath])
psSpeakerNotes :: !(Maybe SpeakerNotesSettings)
psTransition :: !(Maybe TransitionSettings)

Instances

Instances details

FromJSON PresentationSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods parseJSON :: Value -> Parser PresentationSettings # parseJSONList :: Value -> Parser [PresentationSettings] # omittedField :: Maybe PresentationSettings #
Monoid PresentationSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods mempty :: PresentationSettings # mappend :: PresentationSettings -> PresentationSettings -> PresentationSettings # mconcat :: [PresentationSettings] -> PresentationSettings #
Semigroup PresentationSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods (<>) :: PresentationSettings -> PresentationSettings -> PresentationSettings # sconcat :: NonEmpty PresentationSettings -> PresentationSettings # stimes :: Integral b => b -> PresentationSettings -> PresentationSettings #
Show PresentationSettings Source #
Instance details Defined in Patat.Presentation.Settings Methods showsPrec :: Int -> PresentationSettings -> ShowS # show :: PresentationSettings -> String # showList :: [PresentationSettings] -> ShowS #

defaultPresentationSettings :: PresentationSettings Source #

data VarGen Source #

Used to generate fresh variables.

Instances

Instances details

Show VarGen Source #
Instance details Defined in Patat.Presentation.Instruction Methods showsPrec :: Int -> VarGen -> ShowS # show :: VarGen -> String # showList :: [VarGen] -> ShowS #

data Var Source #

A variable is like a placeholder in the instructions, something we don't know yet, dynamic content. Currently this is only used for code evaluation.

Instances

Instances details

Show Var Source #
Instance details Defined in Patat.Presentation.Instruction Methods showsPrec :: Int -> Var -> ShowS # show :: Var -> String # showList :: [Var] -> ShowS #
Eq Var Source #
Instance details Defined in Patat.Presentation.Instruction Methods (==) :: Var -> Var -> Bool # (/=) :: Var -> Var -> Bool #
Ord Var Source #
Instance details Defined in Patat.Presentation.Instruction Methods compare :: Var -> Var -> Ordering # (<) :: Var -> Var -> Bool # (<=) :: Var -> Var -> Bool # (>) :: Var -> Var -> Bool # (>=) :: Var -> Var -> Bool # max :: Var -> Var -> Var # min :: Var -> Var -> Var #
Hashable Var Source #
Instance details Defined in Patat.Presentation.Instruction Methods hashWithSalt :: Int -> Var -> Int # hash :: Var -> Int #

zeroVarGen :: VarGen Source #

data Presentation Source #

Constructors

Presentation

Fields

pFilePath :: !FilePath
pEncodingFallback :: !EncodingFallback
pTitle :: ![Inline]
pAuthor :: ![Inline]
pSettings :: !PresentationSettings
pSlides :: !(Seq Slide)
pBreadcrumbs :: !(Seq Breadcrumbs)
pSlideSettings :: !(Seq PresentationSettings)
pTransitionGens :: !(Seq (Maybe TransitionGen))
pActiveFragment :: !Index
pSyntaxMap :: !SyntaxMap
pEvalBlocks :: !EvalBlocks
pVarGen :: !VarGen
pVars :: !(HashMap Var [Block])

readPresentation :: VarGen -> FilePath -> IO (Either String Presentation) Source #

activeSpeakerNotes :: Presentation -> SpeakerNotes Source #

activeVars :: Presentation -> HashSet Var Source #

data Size Source #

Instances

Instances details

Show Size Source #
Instance details Defined in Patat.Size Methods showsPrec :: Int -> Size -> ShowS # show :: Size -> String # showList :: [Size] -> ShowS #

getPresentationSize :: Presentation -> IO Size Source #

data Display Source #

Constructors

DisplayDoc Doc
DisplayImage FilePath

Instances

Instances details

Show Display Source #
Instance details Defined in Patat.Presentation.Display Methods showsPrec :: Int -> Display -> ShowS # show :: Display -> String # showList :: [Display] -> ShowS #

displayPresentation :: Size -> Presentation -> Display Source #

displayPresentationError :: Size -> Presentation -> String -> Doc Source #

Displays an error in the place of the presentation. This is useful if we want to display an error but keep the presentation running.

dumpPresentation :: Presentation -> IO () Source #

data PresentationCommand Source #

Constructors

Exit
Forward
Backward
SkipForward
SkipBackward
First
Last
Reload
Seek Int
UpdateVar Var [Block]
UnknownCommand String

Instances

Instances details

Show PresentationCommand Source #
Instance details Defined in Patat.Presentation.Interactive Methods showsPrec :: Int -> PresentationCommand -> ShowS # show :: PresentationCommand -> String # showList :: [PresentationCommand] -> ShowS #
Eq PresentationCommand Source #
Instance details Defined in Patat.Presentation.Interactive Methods (==) :: PresentationCommand -> PresentationCommand -> Bool # (/=) :: PresentationCommand -> PresentationCommand -> Bool #

readPresentationCommand :: Handle -> IO PresentationCommand Source #

data UpdatedPresentation Source #

Constructors

UpdatedPresentation !Presentation
ExitedPresentation
ErroredPresentation String

updatePresentation :: PresentationCommand -> Presentation -> IO UpdatedPresentation Source #