Hum.Types

Types!

Documentation

data HumState

Describes the state of the app.

Constructors

HumState

Fields

• chan :: !(BChan HumEvent)

  The channel for MPD and time events

• hview :: !View

  The current view: Queue, Library, etc.

• status :: !(Maybe Status)

  MPD's status

• mode :: !Mode

  Input mode

• ex :: !ExState

  The state of the ex mode style prompt at the bottom

• currentSong :: !(Maybe Song)
• queue :: !SongList

  Also called the playlist in MPD

• library :: !LibraryState
• playlists :: !PlaylistsState
• clipboard :: !Clipboard
• focus :: !Focus

  The current focus in each view

• editable :: !Bool

  Whether the selected stored playlist is editable

• prompts :: !Prompts
• help :: !HelpState

  Help View

data LibraryState

Constructors

LibraryState

Fields

• artists :: !(List Name Value)

  All album artists

• yalbums :: !(List Name (Value, Value))

  Year-Album pairs of the selected artist

• yalbumSort :: !Bool

  Toggle sort of yalbums between years and alphabeitcal order

• songs :: !(List Name Song)

  Songs in selected album

data PlaylistsState

Stored playlists

Constructors

PlaylistsState

Fields

• plList :: !(List Name PlaylistName)

  List of stored playlists

• plSongs :: !SongList

  Songs in selected playlist

data HelpState

Constructors

HelpState

Fields

• helpText :: !Text

  Contents of help screen

• helpSearchInt :: !Int

  number of focused search match

data ExSubMode

Specific mode in the bottom prompt

Constructors

Cmd

Function commands

FSearch

Forward search

BSearch

Backwards search

Instances

Eq ExSubMode

Defined in Hum.Types

Methods

(==) :: ExSubMode -> ExSubMode -> Bool

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

Ord ExSubMode

Defined in Hum.Types

Methods

compare :: ExSubMode -> ExSubMode -> Ordering

(<) :: ExSubMode -> ExSubMode -> Bool

(<=) :: ExSubMode -> ExSubMode -> Bool

(>) :: ExSubMode -> ExSubMode -> Bool

(>=) :: ExSubMode -> ExSubMode -> Bool

max :: ExSubMode -> ExSubMode -> ExSubMode

min :: ExSubMode -> ExSubMode -> ExSubMode

Show ExSubMode

Defined in Hum.Types

Methods

showsPrec :: Int -> ExSubMode -> ShowS

show :: ExSubMode -> String

showList :: [ExSubMode] -> ShowS

data ExState

Constructors

ExState

Fields

• exPrefix :: !ExSubMode
• exEditor :: !(Editor Text Name)
• searchDirection :: !Bool

  Search direction of last search

• searchHistory :: ![Text]
• cmdHistory :: ![Text]

data Prompts

Constructors

Prompts

Fields

• currentPrompt :: !PromptType
• promptTitle :: Text
• plSelectPrompt :: !(List Name (Maybe PlaylistName))

  List to select playlist from

• textPrompt :: !(Editor Text Name)

  Editor if needed

• exitPromptFunc :: Bool -> HumState -> EventM Name HumState

  Executes on exit from prompt, True for execute and False for quit.

data PromptType

Constructors

PlSelectPrompt

Select playlist to add songs to

YNPrompt

General yes/no prompt

TextPrompt

General enter text and do stuff prompt

Instances

Eq PromptType

Defined in Hum.Types

Methods

(==) :: PromptType -> PromptType -> Bool

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

Show PromptType

Defined in Hum.Types

Methods

showsPrec :: Int -> PromptType -> ShowS

show :: PromptType -> String

showList :: [PromptType] -> ShowS

data Clipboard

Constructors

Clipboard

Fields

• clSongs :: !SongList

  Last list of songs copied

• clPlName :: !(Maybe PlaylistName)

  Last playlist name copied

data Mode

General input mode

Constructors

NormalMode

Vim normal mode style movement

ExMode

Type ex style commands or search

PromptMode

Interact with a prompt

Instances

Eq Mode

Defined in Hum.Types

Methods

(==) :: Mode -> Mode -> Bool

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

Show Mode

Defined in Hum.Types

Methods

showsPrec :: Int -> Mode -> ShowS

show :: Mode -> String

showList :: [Mode] -> ShowS

type Highlight = Bool

type SongList = List Name (Song, Highlight)

type HumEvent = Either Tick (Response [Subsystem])

data Name

Brick widget names

Constructors

NowPlaying

ClSongs

Queue

QueueList

Library

ArtistsList

LibraryLeft

AlbumsList

YalbumsList

LibraryMid

SongsList

LibraryRight

PlaylistList

PlaylistLeft

PlaylistSongs

PlaylistRight

Help

ExEditor

TextPromptEditor

Instances

Eq Name

Defined in Hum.Types

Methods

(==) :: Name -> Name -> Bool

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

Ord Name

Defined in Hum.Types

Methods

compare :: Name -> Name -> Ordering

(<) :: Name -> Name -> Bool

(<=) :: Name -> Name -> Bool

(>) :: Name -> Name -> Bool

(>=) :: Name -> Name -> Bool

max :: Name -> Name -> Name

min :: Name -> Name -> Name

Show Name

Defined in Hum.Types

Methods

showsPrec :: Int -> Name -> ShowS

show :: Name -> String

showList :: [Name] -> ShowS

data Focus

Constructors

Focus

Fields

• focQueue :: FocQueue
• focLib :: FocLib
• focPlay :: FocPlay
• focEx :: Bool

Instances

Eq Focus

Defined in Hum.Types

Methods

(==) :: Focus -> Focus -> Bool

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

Ord Focus

Defined in Hum.Types

Methods

compare :: Focus -> Focus -> Ordering

(<) :: Focus -> Focus -> Bool

(<=) :: Focus -> Focus -> Bool

(>) :: Focus -> Focus -> Bool

(>=) :: Focus -> Focus -> Bool

max :: Focus -> Focus -> Focus

min :: Focus -> Focus -> Focus

Show Focus

Defined in Hum.Types

Methods

showsPrec :: Int -> Focus -> ShowS

show :: Focus -> String

showList :: [Focus] -> ShowS

data FocQueue

Constructors

FocQueue

Instances

Eq FocQueue

Defined in Hum.Types

Methods

(==) :: FocQueue -> FocQueue -> Bool

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

Ord FocQueue

Defined in Hum.Types

Methods

compare :: FocQueue -> FocQueue -> Ordering

(<) :: FocQueue -> FocQueue -> Bool

(<=) :: FocQueue -> FocQueue -> Bool

(>) :: FocQueue -> FocQueue -> Bool

(>=) :: FocQueue -> FocQueue -> Bool

max :: FocQueue -> FocQueue -> FocQueue

min :: FocQueue -> FocQueue -> FocQueue

Show FocQueue

Defined in Hum.Types

Methods

showsPrec :: Int -> FocQueue -> ShowS

show :: FocQueue -> String

showList :: [FocQueue] -> ShowS

data FocLib

Constructors

FocArtists

FocAlbums

FocSongs

Instances

Enum FocLib

Defined in Hum.Types

Methods

succ :: FocLib -> FocLib

pred :: FocLib -> FocLib

toEnum :: Int -> FocLib

fromEnum :: FocLib -> Int

enumFrom :: FocLib -> [FocLib]

enumFromThen :: FocLib -> FocLib -> [FocLib]

enumFromTo :: FocLib -> FocLib -> [FocLib]

enumFromThenTo :: FocLib -> FocLib -> FocLib -> [FocLib]

Eq FocLib

Defined in Hum.Types

Methods

(==) :: FocLib -> FocLib -> Bool

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

Ord FocLib

Defined in Hum.Types

Methods

compare :: FocLib -> FocLib -> Ordering

(<) :: FocLib -> FocLib -> Bool

(<=) :: FocLib -> FocLib -> Bool

(>) :: FocLib -> FocLib -> Bool

(>=) :: FocLib -> FocLib -> Bool

max :: FocLib -> FocLib -> FocLib

min :: FocLib -> FocLib -> FocLib

Show FocLib

Defined in Hum.Types

Methods

showsPrec :: Int -> FocLib -> ShowS

show :: FocLib -> String

showList :: [FocLib] -> ShowS

data FocPlay

Constructors

FocPlaylists

FocPSongs

Instances

Enum FocPlay

Defined in Hum.Types

Methods

succ :: FocPlay -> FocPlay

pred :: FocPlay -> FocPlay

toEnum :: Int -> FocPlay

fromEnum :: FocPlay -> Int

enumFrom :: FocPlay -> [FocPlay]

enumFromThen :: FocPlay -> FocPlay -> [FocPlay]

enumFromTo :: FocPlay -> FocPlay -> [FocPlay]

enumFromThenTo :: FocPlay -> FocPlay -> FocPlay -> [FocPlay]

Eq FocPlay

Defined in Hum.Types

Methods

(==) :: FocPlay -> FocPlay -> Bool

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

Ord FocPlay

Defined in Hum.Types

Methods

compare :: FocPlay -> FocPlay -> Ordering

(<) :: FocPlay -> FocPlay -> Bool

(<=) :: FocPlay -> FocPlay -> Bool

(>) :: FocPlay -> FocPlay -> Bool

(>=) :: FocPlay -> FocPlay -> Bool

max :: FocPlay -> FocPlay -> FocPlay

min :: FocPlay -> FocPlay -> FocPlay

Show FocPlay

Defined in Hum.Types

Methods

showsPrec :: Int -> FocPlay -> ShowS

show :: FocPlay -> String

showList :: [FocPlay] -> ShowS

data View

Constructors

QueueView

LibraryView

PlaylistsView

HelpView

Instances

Eq View

Defined in Hum.Types

Methods

(==) :: View -> View -> Bool

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

Ord View

Defined in Hum.Types

Methods

compare :: View -> View -> Ordering

(<) :: View -> View -> Bool

(<=) :: View -> View -> Bool

(>) :: View -> View -> Bool

(>=) :: View -> View -> Bool

max :: View -> View -> View

min :: View -> View -> View

Show View

Defined in Hum.Types

Methods

showsPrec :: Int -> View -> ShowS

show :: View -> String

showList :: [View] -> ShowS

data Tick

Constructors

Tick

statusL :: Lens' HumState (Maybe Status)

queueL :: Lens' HumState SongList

promptsL :: Lens' HumState Prompts

playlistsL :: Lens' HumState PlaylistsState

modeL :: Lens' HumState Mode

libraryL :: Lens' HumState LibraryState

hviewL :: Lens' HumState View

helpL :: Lens' HumState HelpState

focusL :: Lens' HumState Focus

exL :: Lens' HumState ExState

editableL :: Lens' HumState Bool

currentSongL :: Lens' HumState (Maybe Song)

clipboardL :: Lens' HumState Clipboard

chanL :: Lens' HumState (BChan HumEvent)

focQueueL :: Lens' Focus FocQueue

focPlayL :: Lens' Focus FocPlay

focLibL :: Lens' Focus FocLib

focExL :: Lens' Focus Bool

yalbumsL :: Lens' LibraryState (List Name (Value, Value))

yalbumSortL :: Lens' LibraryState Bool

songsL :: Lens' LibraryState (List Name Song)

artistsL :: Lens' LibraryState (List Name Value)

plSongsL :: Lens' PlaylistsState SongList

plListL :: Lens' PlaylistsState (List Name PlaylistName)

helpTextL :: Lens' HelpState Text

helpSearchIntL :: Lens' HelpState Int

searchHistoryL :: Lens' ExState [Text]

searchDirectionL :: Lens' ExState Bool

exPrefixL :: Lens' ExState ExSubMode

exEditorL :: Lens' ExState (Editor Text Name)

cmdHistoryL :: Lens' ExState [Text]

textPromptL :: Lens' Prompts (Editor Text Name)

promptTitleL :: Lens' Prompts Text

plSelectPromptL :: Lens' Prompts (List Name (Maybe PlaylistName))

exitPromptFuncL :: Lens' Prompts (Bool -> HumState -> EventM Name HumState)

currentPromptL :: Lens' Prompts PromptType

clSongsL :: Lens' Clipboard SongList

clPlNameL :: Lens' Clipboard (Maybe PlaylistName)