Safe Haskell	Safe-Inferred
Language	Haskell2010

Brassica.SoundChange.Frontend.Internal

Description

Warning: This module is internal, and does not follow the Package Versioning Policy. It may be useful for extending Brassica, but be prepared to track development closely if you import this module.

Synopsis

data ApplicationMode
- = ApplyRules HighlightMode OutputMode String
- | ReportRulesApplied
data HighlightMode
- = NoHighlight
- | DifferentToLastRun
- | DifferentToInput
data OutputMode
data TokenisationMode
- = Normal
- | AddEtymons
tokenisationModeFor :: ApplicationMode -> TokenisationMode
data ApplicationOutput a r
- = HighlightedWords [Component (a, Bool)]
- | AppliedRulesTable [PWordLog r]
- | ParseError (ParseErrorBundle String Void)
- | ExpandError ExpandError
data InputLexiconFormat
- = Raw
- | MDF
data ParseOutput a
- = ParsedRaw [Component a]
- | ParsedMDF (MDF [Component a])
componentise :: OutputMode -> [a] -> ParseOutput a -> [Component a]
intersperseWords :: [a] -> [Component a] -> [Component a]
tokeniseAccordingToInputFormat :: InputLexiconFormat -> TokenisationMode -> SoundChanges Expanded [Grapheme] -> String -> Either (ParseErrorBundle String Void) (ParseOutput PWord)
getParsedWords :: ParseOutput a -> [a]
parseTokeniseAndApplyRules :: SoundChanges CategorySpec Directive -> String -> InputLexiconFormat -> ApplicationMode -> Maybe [Component PWord] -> ApplicationOutput PWord (Statement Expanded [Grapheme])

Documentation

data ApplicationMode Source #

Rule application mode of the SCA.

Constructors

ApplyRules HighlightMode OutputMode String
ReportRulesApplied

Instances

Instances details

Show ApplicationMode Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Methods showsPrec :: Int -> ApplicationMode -> ShowS # show :: ApplicationMode -> String # showList :: [ApplicationMode] -> ShowS #
Eq ApplicationMode Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Methods (==) :: ApplicationMode -> ApplicationMode -> Bool # (/=) :: ApplicationMode -> ApplicationMode -> Bool #

data HighlightMode Source #

Constructors

NoHighlight
DifferentToLastRun
DifferentToInput

Instances

Instances details

Enum HighlightMode Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Methods succ :: HighlightMode -> HighlightMode # pred :: HighlightMode -> HighlightMode # toEnum :: Int -> HighlightMode # fromEnum :: HighlightMode -> Int # enumFrom :: HighlightMode -> [HighlightMode] # enumFromThen :: HighlightMode -> HighlightMode -> [HighlightMode] # enumFromTo :: HighlightMode -> HighlightMode -> [HighlightMode] # enumFromThenTo :: HighlightMode -> HighlightMode -> HighlightMode -> [HighlightMode] #
Show HighlightMode Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Methods showsPrec :: Int -> HighlightMode -> ShowS # show :: HighlightMode -> String # showList :: [HighlightMode] -> ShowS #
Eq HighlightMode Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Methods (==) :: HighlightMode -> HighlightMode -> Bool # (/=) :: HighlightMode -> HighlightMode -> Bool #

data OutputMode Source #

Constructors

MDFOutput
WordsOnlyOutput
MDFOutputWithEtymons
WordsWithProtoOutput

Instances

Instances details

Enum OutputMode Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Methods succ :: OutputMode -> OutputMode # pred :: OutputMode -> OutputMode # toEnum :: Int -> OutputMode # fromEnum :: OutputMode -> Int # enumFrom :: OutputMode -> [OutputMode] # enumFromThen :: OutputMode -> OutputMode -> [OutputMode] # enumFromTo :: OutputMode -> OutputMode -> [OutputMode] # enumFromThenTo :: OutputMode -> OutputMode -> OutputMode -> [OutputMode] #
Show OutputMode Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Methods showsPrec :: Int -> OutputMode -> ShowS # show :: OutputMode -> String # showList :: [OutputMode] -> ShowS #
Eq OutputMode Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Methods (==) :: OutputMode -> OutputMode -> Bool # (/=) :: OutputMode -> OutputMode -> Bool #

data TokenisationMode Source #

Constructors

Normal
AddEtymons

Instances

Instances details

Enum TokenisationMode Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Methods succ :: TokenisationMode -> TokenisationMode # pred :: TokenisationMode -> TokenisationMode # toEnum :: Int -> TokenisationMode # fromEnum :: TokenisationMode -> Int # enumFrom :: TokenisationMode -> [TokenisationMode] # enumFromThen :: TokenisationMode -> TokenisationMode -> [TokenisationMode] # enumFromTo :: TokenisationMode -> TokenisationMode -> [TokenisationMode] # enumFromThenTo :: TokenisationMode -> TokenisationMode -> TokenisationMode -> [TokenisationMode] #
Show TokenisationMode Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Methods showsPrec :: Int -> TokenisationMode -> ShowS # show :: TokenisationMode -> String # showList :: [TokenisationMode] -> ShowS #
Eq TokenisationMode Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Methods (==) :: TokenisationMode -> TokenisationMode -> Bool # (/=) :: TokenisationMode -> TokenisationMode -> Bool #

tokenisationModeFor :: ApplicationMode -> TokenisationMode Source #

data ApplicationOutput a r Source #

Output of a single application of rules to a wordlist: either a list of possibly highlighted words, an applied rules table, or a parse error.

Constructors

HighlightedWords [Component (a, Bool)]
AppliedRulesTable [PWordLog r]
ParseError (ParseErrorBundle String Void)
ExpandError ExpandError

Instances

Instances details

Generic (ApplicationOutput a r) Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Associated Types type Rep (ApplicationOutput a r) :: Type -> Type # Methods from :: ApplicationOutput a r -> Rep (ApplicationOutput a r) x # to :: Rep (ApplicationOutput a r) x -> ApplicationOutput a r #
(Show a, Show r) => Show (ApplicationOutput a r) Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Methods showsPrec :: Int -> ApplicationOutput a r -> ShowS # show :: ApplicationOutput a r -> String # showList :: [ApplicationOutput a r] -> ShowS #
(NFData a, NFData r) => NFData (ApplicationOutput a r) Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Methods rnf :: ApplicationOutput a r -> () #
type Rep (ApplicationOutput a r) Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal type Rep (ApplicationOutput a r) = D1 ('MetaData "ApplicationOutput" "Brassica.SoundChange.Frontend.Internal" "brassica-0.2.0-6DYGqWgsRcQ5pGt1m6P3TU" 'False) ((C1 ('MetaCons "HighlightedWords" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Component (a, Bool)])) :+: C1 ('MetaCons "AppliedRulesTable" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PWordLog r]))) :+: (C1 ('MetaCons "ParseError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ParseErrorBundle String Void))) :+: C1 ('MetaCons "ExpandError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ExpandError))))

data InputLexiconFormat Source #

Kind of input: either a raw wordlist, or an MDF file.

Constructors

Raw
MDF

Instances

Instances details

Enum InputLexiconFormat Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Methods succ :: InputLexiconFormat -> InputLexiconFormat # pred :: InputLexiconFormat -> InputLexiconFormat # toEnum :: Int -> InputLexiconFormat # fromEnum :: InputLexiconFormat -> Int # enumFrom :: InputLexiconFormat -> [InputLexiconFormat] # enumFromThen :: InputLexiconFormat -> InputLexiconFormat -> [InputLexiconFormat] # enumFromTo :: InputLexiconFormat -> InputLexiconFormat -> [InputLexiconFormat] # enumFromThenTo :: InputLexiconFormat -> InputLexiconFormat -> InputLexiconFormat -> [InputLexiconFormat] #
Show InputLexiconFormat Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Methods showsPrec :: Int -> InputLexiconFormat -> ShowS # show :: InputLexiconFormat -> String # showList :: [InputLexiconFormat] -> ShowS #
Eq InputLexiconFormat Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Methods (==) :: InputLexiconFormat -> InputLexiconFormat -> Bool # (/=) :: InputLexiconFormat -> InputLexiconFormat -> Bool #

data ParseOutput a Source #

Constructors

ParsedRaw [Component a]
ParsedMDF (MDF [Component a])

Instances

Instances details

Functor ParseOutput Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Methods fmap :: (a -> b) -> ParseOutput a -> ParseOutput b # (<$) :: a -> ParseOutput b -> ParseOutput a #
Show a => Show (ParseOutput a) Source #
Instance details Defined in Brassica.SoundChange.Frontend.Internal Methods showsPrec :: Int -> ParseOutput a -> ShowS # show :: ParseOutput a -> String # showList :: [ParseOutput a] -> ShowS #

componentise :: OutputMode -> [a] -> ParseOutput a -> [Component a] Source #

intersperseWords :: [a] -> [Component a] -> [Component a] Source #

tokeniseAccordingToInputFormat :: InputLexiconFormat -> TokenisationMode -> SoundChanges Expanded [Grapheme] -> String -> Either (ParseErrorBundle String Void) (ParseOutput PWord) Source #

getParsedWords :: ParseOutput a -> [a] Source #

parseTokeniseAndApplyRules Source #

Arguments

:: SoundChanges CategorySpec Directive	changes
-> String	words
-> InputLexiconFormat
-> ApplicationMode
-> Maybe [Component PWord]	previous results
-> ApplicationOutput PWord (Statement Expanded [Grapheme])

Top-level dispatcher for an interactive frontend: given a textual wordlist and a list of sound changes, returns the result of running the changes in the specified mode.