Brassica.SoundChange.Frontend.Internal

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.

This module exists primarily as an internal common interface for Brassica’s two ‘official’ GUI frontends (desktop and web). If you wish to make your own frontend to Brassica, it is probably easier to write it yourself rather than trying to use this.

Documentation

data ApplicationMode

Rule application mode of the SCA.

Constructors

ApplyRules HighlightMode OutputMode String

Apply sound changes as normal, with the given modes and separator

ReportRulesApplied

Apply reporting the rules which were applied (as HTML)

Instances

Show ApplicationMode

Defined in Brassica.SoundChange.Frontend.Internal

Methods

showsPrec :: Int -> ApplicationMode -> ShowS

show :: ApplicationMode -> String

showList :: [ApplicationMode] -> ShowS

Eq ApplicationMode

Defined in Brassica.SoundChange.Frontend.Internal

Methods

(==) :: ApplicationMode -> ApplicationMode -> Bool

(/=) :: ApplicationMode -> ApplicationMode -> Bool

getOutputMode :: ApplicationMode -> OutputMode

Get the OutputMode if one is set, otherwise default to WordsOnlyOutput.

data HighlightMode

Mode for highlighting output words

Constructors

NoHighlight

DifferentToLastRun

DifferentToInput

NB. now labeled ‘any rule applied’ in GUI

Instances

Enum HighlightMode

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

Defined in Brassica.SoundChange.Frontend.Internal

Methods

showsPrec :: Int -> HighlightMode -> ShowS

show :: HighlightMode -> String

showList :: [HighlightMode] -> ShowS

Eq HighlightMode

Defined in Brassica.SoundChange.Frontend.Internal

Methods

(==) :: HighlightMode -> HighlightMode -> Bool

(/=) :: HighlightMode -> HighlightMode -> Bool

data OutputMode

Mode for reporting output words (and sometimes intermediate and input words too)

Constructors

MDFOutput

WordsOnlyOutput

MDFOutputWithEtymons

WordsWithProtoOutput

WordsWithProtoOutputPreserve

Instances

Enum OutputMode

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

Defined in Brassica.SoundChange.Frontend.Internal

Methods

showsPrec :: Int -> OutputMode -> ShowS

show :: OutputMode -> String

showList :: [OutputMode] -> ShowS

Eq OutputMode

Defined in Brassica.SoundChange.Frontend.Internal

Methods

(==) :: OutputMode -> OutputMode -> Bool

(/=) :: OutputMode -> OutputMode -> Bool

data ApplicationOutput a r

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 [Log r]

ParseError (ParseErrorBundle String Void)

Instances

Generic (ApplicationOutput a r)

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)

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)

Defined in Brassica.SoundChange.Frontend.Internal

Methods

rnf :: ApplicationOutput a r -> ()

type Rep (ApplicationOutput a r)

Defined in Brassica.SoundChange.Frontend.Internal

type Rep (ApplicationOutput a r) = D1 ('MetaData "ApplicationOutput" "Brassica.SoundChange.Frontend.Internal" "brassica-1.0.0-23v7eBGV3gz5i0Q0Z9IDsG" '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 [Log r])) :+: C1 ('MetaCons "ParseError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ParseErrorBundle String Void)))))

data MDFHierarchy

For MDF input, the hierarchy used

Constructors

Standard

Alternate

Instances

Show MDFHierarchy

Defined in Brassica.SoundChange.Frontend.Internal

Methods

showsPrec :: Int -> MDFHierarchy -> ShowS

show :: MDFHierarchy -> String

showList :: [MDFHierarchy] -> ShowS

Eq MDFHierarchy

Defined in Brassica.SoundChange.Frontend.Internal

Methods

(==) :: MDFHierarchy -> MDFHierarchy -> Bool

(/=) :: MDFHierarchy -> MDFHierarchy -> Bool

data InputLexiconFormat

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

Constructors

Raw

MDF MDFHierarchy

Instances

Enum InputLexiconFormat

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

Defined in Brassica.SoundChange.Frontend.Internal

Methods

showsPrec :: Int -> InputLexiconFormat -> ShowS

show :: InputLexiconFormat -> String

showList :: [InputLexiconFormat] -> ShowS

Eq InputLexiconFormat

Defined in Brassica.SoundChange.Frontend.Internal

Methods

(==) :: InputLexiconFormat -> InputLexiconFormat -> Bool

(/=) :: InputLexiconFormat -> InputLexiconFormat -> Bool

data ParseOutput a

Either a list of Components for a Brassica wordlist file, or a list of SFM fields for an MDF file

Constructors

ParsedRaw [Component a]

ParsedMDF SFM

Instances

Foldable ParseOutput

Defined in Brassica.SoundChange.Frontend.Internal

Methods

fold :: Monoid m => ParseOutput m -> m

foldMap :: Monoid m => (a -> m) -> ParseOutput a -> m

foldMap' :: Monoid m => (a -> m) -> ParseOutput a -> m

foldr :: (a -> b -> b) -> b -> ParseOutput a -> b

foldr' :: (a -> b -> b) -> b -> ParseOutput a -> b

foldl :: (b -> a -> b) -> b -> ParseOutput a -> b

foldl' :: (b -> a -> b) -> b -> ParseOutput a -> b

foldr1 :: (a -> a -> a) -> ParseOutput a -> a

foldl1 :: (a -> a -> a) -> ParseOutput a -> a

toList :: ParseOutput a -> [a]

null :: ParseOutput a -> Bool

length :: ParseOutput a -> Int

elem :: Eq a => a -> ParseOutput a -> Bool

maximum :: Ord a => ParseOutput a -> a

minimum :: Ord a => ParseOutput a -> a

sum :: Num a => ParseOutput a -> a

product :: Num a => ParseOutput a -> a

Traversable ParseOutput

Defined in Brassica.SoundChange.Frontend.Internal

Methods

traverse :: Applicative f => (a -> f b) -> ParseOutput a -> f (ParseOutput b)

sequenceA :: Applicative f => ParseOutput (f a) -> f (ParseOutput a)

mapM :: Monad m => (a -> m b) -> ParseOutput a -> m (ParseOutput b)

sequence :: Monad m => ParseOutput (m a) -> m (ParseOutput a)

Functor ParseOutput

Defined in Brassica.SoundChange.Frontend.Internal

Methods

fmap :: (a -> b) -> ParseOutput a -> ParseOutput b

(<$) :: a -> ParseOutput b -> ParseOutput a

Show a => Show (ParseOutput a)

Defined in Brassica.SoundChange.Frontend.Internal

Methods

showsPrec :: Int -> ParseOutput a -> ShowS

show :: ParseOutput a -> String

showList :: [ParseOutput a] -> ShowS

tokeniseAccordingToInputFormat :: InputLexiconFormat -> OutputMode -> SoundChanges Expanded GraphemeList -> String -> Either (ParseErrorBundle String Void) [Component PWord]

Given the selected input and output modes, and the expanded sound changes, tokenise the input according to the format which was selected

parseTokeniseAndApplyRules

Arguments

:: (forall a b. (a -> b) -> [Component a] -> [Component b])

mapping function to use (for parallelism)

-> SoundChanges Expanded GraphemeList

changes

-> String

words

-> InputLexiconFormat

-> ApplicationMode

-> Maybe [Component PWord]

previous results

-> ApplicationOutput PWord (Statement Expanded GraphemeList)

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.