Safe Haskell	Safe-Inferred

Cmd.Msg

Contents

views

Synopsis

data Msg
- = Ui UiMsg.UiMsg
- | Midi Midi.ReadMessage
- | InputNote InputNote.Input
- | Transport Transport.Status
- | DeriveStatus Id.BlockId DeriveStatus
- | Socket IO.Handle ReplProtocol.Query
show_short :: Msg -> Text
data DeriveStatus
- = OutOfDate
- | Deriving
- | DeriveComplete !Performance !ImStarted
- | ImStatus !Id.BlockId !(Set Id.TrackId) !ImStatus
data ImStarted
- = ImStarted
- | ImUnnecessary
data ImStatus
- = ImRenderingRange !ScoreT.Instrument !RealTime !RealTime
- | ImWaveformsCompleted ![Track.WaveformChunk]
- | ImComplete !Bool !(Maybe ImGc.Stats)
data Performance = Performance {
- perf_derive_cache :: Cache
- perf_events :: Vector.Vector Score.Event
- perf_logs :: [Log.Msg]
- perf_logs_written :: Bool
- perf_track_dynamic :: TrackDynamic
- perf_integrated :: [Integrated]
- perf_damage :: ScoreDamage
- perf_warps :: [TrackWarp.TrackWarp]
- perf_track_signals :: Track.TrackSignals
- perf_block_deps :: BlockDeps
- perf_track_instruments :: Map Id.TrackId (Set ScoreT.Instrument)
- perf_ui_state :: Ui.State
}
force_performance :: Performance -> ()
mouse :: Msg -> Maybe UiMsg.MouseEvent
mouse_down :: Msg -> Bool
kbd :: Msg -> Maybe (UiMsg.KbdState, [Key.Modifier], Key.Key, Maybe Char)
key :: Msg -> Maybe (UiMsg.KbdState, Key.Key)
key_down :: Msg -> Maybe Key.Key
text :: Msg -> Maybe (Key.Key, Maybe Char)
key_mods :: Msg -> Maybe [Key.Modifier]
keycap :: Msg -> Maybe (UiMsg.KbdState, Char)
char :: Msg -> Maybe (UiMsg.KbdState, Char)
char_down :: Msg -> Maybe Char
midi :: Msg -> Maybe Midi.Message
context :: Msg -> Maybe UiMsg.Context
context_track :: Msg -> Maybe (TrackNum, UiMsg.Track)
context_track_pos :: Msg -> Maybe (TrackNum, ScoreTime)

Documentation

data Msg Source #

Constructors

Ui UiMsg.UiMsg	Message from the UI.
Midi Midi.ReadMessage	Incoming midi message.
InputNote InputNote.Input	Incoming abstract note. This is meant to enter a note and is not a MIDI NoteOn, though NoteOns may very well be translated into these. These are not generated from any subsystem, but instead translated from other msgs (such as Midi).
Transport Transport.Status	Message from the transport/play thread.
DeriveStatus Id.BlockId DeriveStatus	Message about the derivation status, from the background derivation threads.
Socket IO.Handle ReplProtocol.Query	Message from the REPL socket, includes the socket handle than can be used to write a response. Whoever responds to it should close the handle.

Instances

Instances details

Show Msg Source #
Instance details Defined in Cmd.Msg Methods showsPrec :: Int -> Msg -> ShowS # show :: Msg -> String # showList :: [Msg] -> ShowS #
Pretty.Pretty Msg Source #
Instance details Defined in Cmd.Msg Methods pretty :: Msg -> Text Source # format :: Msg -> Doc Source # formatList :: [Msg] -> Doc Source #

show_short :: Msg -> Text Source #

data DeriveStatus Source #

Constructors

OutOfDate	The current derivation is out of date, but work has not yet started on a replacement. The new Performance is already in `state_current_performance` but not in `state_performance` yet.
Deriving
DeriveComplete !Performance !ImStarted
ImStatus !Id.BlockId !(Set Id.TrackId) !ImStatus	The BlockId is the block to which this status applies, the BlockId in the containing DeriveStatus is the root block for the derivation. It's redundant for `ImComplete`, because only the root block gets one of those.

Instances

Instances details

Show DeriveStatus Source #
Instance details Defined in Cmd.Msg Methods showsPrec :: Int -> DeriveStatus -> ShowS # show :: DeriveStatus -> String # showList :: [DeriveStatus] -> ShowS #
Pretty.Pretty DeriveStatus Source #
Instance details Defined in Cmd.Msg Methods pretty :: DeriveStatus -> Text Source # format :: DeriveStatus -> Doc Source # formatList :: [DeriveStatus] -> Doc Source #

data ImStarted Source #

Constructors

ImStarted	im subprocess in progress
ImUnnecessary	no im notes, so no subprocesses started

Instances

Instances details

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

data ImStatus Source #

Constructors

ImRenderingRange !ScoreT.Instrument !RealTime !RealTime	start--end currently being rendered.
ImWaveformsCompleted ![Track.WaveformChunk]	Waveforms written for these chunks.
ImComplete !Bool !(Maybe ImGc.Stats)	True if the im subprocess had a failure. The error will have been logged, and this flag will leave a visual indicator on the track that something went wrong.

Instances

Instances details

Show ImStatus Source #
Instance details Defined in Cmd.Msg Methods showsPrec :: Int -> ImStatus -> ShowS # show :: ImStatus -> String # showList :: [ImStatus] -> ShowS #
Pretty.Pretty ImStatus Source #
Instance details Defined in Cmd.Msg Methods pretty :: ImStatus -> Text Source # format :: ImStatus -> Doc Source # formatList :: [ImStatus] -> Doc Source #

data Performance Source #

This holds the final performance for a given block. It is used to actually play music, and poked and prodded in a separate thread to control its evaluation.

This is basically the same as Result. I could make them be the same, but Performance wasn't always the same and may not be the same in the future.

Unlike other records, the fields here are all lazy. This is because I need to put an unevaluated Performance into Cmd.state_current_performances, and then force the fields in a separate thread. Also I need to modify perf_damage without forcing any of the others.

Constructors

Performance

Fields

perf_derive_cache :: Cache
perf_events :: Vector.Vector Score.Event
This is the forced result of a derivation.
perf_logs :: [Log.Msg]
Logs from the derivation are written separately.
perf_logs_written :: Bool
The logs are only written on the first play, to minimize error spam. So there's a flag which says whether these logs have been written or not. I don't clear the logs, so cache_stats can inspect them.
perf_track_dynamic :: TrackDynamic
perf_integrated :: [Integrated]
perf_damage :: ScoreDamage
ScoreDamage is normally calculated automatically from the UI diff, but Cmds can also intentionally inflict damage to cause a rederive.
perf_warps :: [TrackWarp.TrackWarp]
perf_track_signals :: Track.TrackSignals
perf_block_deps :: BlockDeps
perf_track_instruments :: Map Id.TrackId (Set ScoreT.Instrument)
Map each track to the instruments on it. This tries to remain lazy, since it's only used by muted_im_instruments.
perf_ui_state :: Ui.State
This is the score state at the time of the performance. It's needed to interpret perf_track_signals, because at the time signals are sent (in cmd_play_msg), the Ui.State may have unsynced changes.

Instances

Instances details

Show Performance Source #
Instance details Defined in Cmd.Msg Methods showsPrec :: Int -> Performance -> ShowS # show :: Performance -> String # showList :: [Performance] -> ShowS #
Pretty.Pretty Performance Source #
Instance details Defined in Cmd.Msg Methods pretty :: Performance -> Text Source # format :: Performance -> Doc Source # formatList :: [Performance] -> Doc Source #

force_performance :: Performance -> () Source #

Force a Performance so that it can be used without a lag.

views

mouse :: Msg -> Maybe UiMsg.MouseEvent Source #

mouse_down :: Msg -> Bool Source #

kbd :: Msg -> Maybe (UiMsg.KbdState, [Key.Modifier], Key.Key, Maybe Char) Source #

key :: Msg -> Maybe (UiMsg.KbdState, Key.Key) Source #

key_down :: Msg -> Maybe Key.Key Source #

text :: Msg -> Maybe (Key.Key, Maybe Char) Source #

The text that this keydown wants to enter, if any.

key_mods :: Msg -> Maybe [Key.Modifier] Source #

keycap :: Msg -> Maybe (UiMsg.KbdState, Char) Source #

A key action by keycap. This is different from text because it should be just the keycap, not taking shift or alt or anything into account.

char :: Msg -> Maybe (UiMsg.KbdState, Char) Source #

This is like keycap, but it takes shift into account. This is because it's convenient to bind to a single Char including shifted, and not have to pass around a ([Key.Modifier], Char) or (Bool, Char).

char_down :: Msg -> Maybe Char Source #

midi :: Msg -> Maybe Midi.Message Source #

context :: Msg -> Maybe UiMsg.Context Source #

context_track :: Msg -> Maybe (TrackNum, UiMsg.Track) Source #

context_track_pos :: Msg -> Maybe (TrackNum, ScoreTime) Source #