Safe Haskell	None
Language	GHC2021

GTVM.SCP.TL

Description

We need sum types if we want to handle everything in one place. CSVs don't support sum types. YAML does. And with sum types, we can also generate comments from a source SCP -- to e.g. say when another SCP is loaded.

TODO * Aeson won't ever omit fields for generic parsing or serializing, except in the specific case where you have a concrete Maybe a. To work around that, I need to write a separate, structurally simplified type, which can be used for the JSON, and converted to the more powerful internal data type for operating on.

Synopsis

type Seg' = Seg 'Weak Text
type SCP' = [Seg']
type SCPTL (f :: Type -> Type) a = [TLSeg f a]
type SCPTL' = SCPTL Identity Text
data Env = Env {
- envPendingPlaceholder :: Text
- envSpeakerIDMap :: Natural -> Maybe Text
}
data TLSeg (f :: Type -> Type) a
- = TLSegTextbox' (TLSegTextbox f a)
- | TLSegChoice' [TLSegChoice f a]
- | TLSeg22Choice' (TLSeg22 f a)
- | TLSeg35Choice' (TLSegChoice f a)
- | TLSegComment' TLSegComment
jcTLSeg :: Options
data TLSegComment = TLSegComment {
- scpTLCommentCommentary :: [Text]
- scpTLCommentMeta :: Map Text Text
}
data TLSegTextbox (f :: Type -> Type) a = TLSegTextbox {
- tlSegTextboxSource :: f a
- tlSegTextboxTranslation :: a
- tlSegTextboxOverflow :: Maybe a
}
data TLSegChoice (f :: Type -> Type) a = TLSegChoice {
- tlSegChoiceSource :: f a
- tlSegChoiceTranslation :: a
}
data TLSeg22 (f :: Type -> Type) a = TLSeg22 {
- tlSeg22TopicSource :: f a
- tlSeg22TopicTranslation :: a
- tlSeg22Choices :: [TLSegChoice f a]
}
genTL :: Env -> SCP' -> [TLSeg Identity Text]
genTLTextbox :: Env -> Seg05Text 'Weak Text -> [TLSeg Identity Text]
genTLChoiceOuter :: Env -> Natural -> [Text] -> [TLSeg Identity Text]
genTLChoice :: Env -> Text -> TLSegChoice Identity Text
genTL22Choices :: Env -> Text -> [Text] -> TLSeg22 Identity Text
meta :: forall (c :: Type -> Type) s. [Text] -> [(Text, Text)] -> TLSeg c s
data Error
- = ErrorTLSegOverlong
- | ErrorSourceMismatch
- | ErrorTLSegTooShort
- | ErrorTypeMismatch
- | ErrorUnimplemented
apply :: SCP' -> [TLSeg Identity Text] -> Either Error SCP'
skipToNextTL :: forall (c :: Type -> Type) a. [TLSeg c a] -> [TLSeg c a]
applySeg :: MonadState [TLSeg Identity Text] m => Seg' -> m (Either Error [Seg'])
tryExtractTextbox :: forall (c :: Type -> Type) a. TLSeg c a -> Maybe (TLSegTextbox c a)
tryExtractChoice :: forall (c :: Type -> Type) a. TLSeg c a -> Maybe [TLSegChoice c a]
tryExtract22 :: forall (c :: Type -> Type) a. TLSeg c a -> Maybe (TLSeg22 c a)
tryExtract35 :: forall (c :: Type -> Type) a. TLSeg c a -> Maybe (TLSegChoice c a)
tryApplySeg :: MonadState [TLSeg Identity Text] m => (TLSeg Identity Text -> Maybe a) -> (a -> Either Error [Seg']) -> m (Either Error [Seg'])
tryApplySegTextbox :: Seg05Text 'Weak Text -> TLSegTextbox Identity Text -> Either Error [Seg']
tryApplySegChoice :: Natural -> [(Text, Natural)] -> [TLSegChoice Identity Text] -> Either Error [Seg']
tryApplySeg22 :: Text -> [(Text, Natural)] -> TLSeg22 Identity Text -> Either Error [Seg']
tryApplySeg35 :: Text -> TLSegChoice Identity Text -> Either Error [Seg']
traverseM :: (Traversable t, Applicative f, Monad m) => (v -> m (f v')) -> t v -> m (f (t v'))
tlSegFieldOrdering :: Text -> Text -> Ordering
segIsTlTarget :: forall (f :: Strength) a. Seg f a -> Bool
segDropMeta :: forall (f :: Type -> Type) a. TLSeg f a -> TLSeg (Const () :: Type -> Type) a

Documentation

type Seg' = Seg 'Weak Text Source #

type SCP' = [Seg'] Source #

type SCPTL (f :: Type -> Type) a = [TLSeg f a] Source #

type SCPTL' = SCPTL Identity Text Source #

data Env Source #

Constructors

Env
Fields envPendingPlaceholder :: Text envSpeakerIDMap :: Natural -> Maybe Text Attempt to obtain a pretty speaker name from an ID. This data isn't stored in the repo, and must instead be parsed at runtime.

Instances

Instances details

Generic Env Source #

Instance details

TLSegTextbox' (TLSegTextbox f a)
TLSegChoice' [TLSegChoice f a]
TLSeg22Choice' (TLSeg22 f a)
TLSeg35Choice' (TLSegChoice f a)
TLSegComment' TLSegComment

TLSegComment
Fields scpTLCommentCommentary :: [Text] scpTLCommentMeta :: Map Text Text

TLSegTextbox
Fields tlSegTextboxSource :: f a tlSegTextboxTranslation :: a tlSegTextboxOverflow :: Maybe a

TLSegChoice
Fields tlSegChoiceSource :: f a tlSegChoiceTranslation :: a

TLSeg22
Fields tlSeg22TopicSource :: f a tlSeg22TopicTranslation :: a tlSeg22Choices :: [TLSegChoice f a]

ErrorTLSegOverlong
ErrorSourceMismatch
ErrorTLSegTooShort
ErrorTypeMismatch
ErrorUnimplemented