hascard-0.6.0.1: A TUI for reviewing notes using 'flashcards' written with markdown-like syntax.

Safe Haskell	Safe-Inferred
Language	Haskell2010

UI

Synopsis

getUseEscapeCode :: IO Bool
addRecent :: FilePath -> IO ()
cardSelectorState :: IO State
mainMenuState :: State
safeHead :: [a] -> Maybe a
cardsState :: Bool -> FilePath -> [Card] -> [Card] -> [Int] -> IO State
cardsWithOptionsStateM :: (MonadState GlobalState m, MonadIO m) => FilePath -> [Card] -> m State
cardsWithOptionsState :: GlobalState -> FilePath -> [Card] -> IO State
infoState :: State
fileBrowserState :: IO State
entryFilter :: Bool -> FileInfo -> Bool
parameterState :: Parameters -> FilePath -> [Card] -> State
runBrickFlashcards :: GlobalState -> IO ()
data GlobalState = GlobalState {
- _mwc :: GenIO
- _stack :: Stack Mode
- _states :: Map Mode State
- _parameters :: Parameters
}
type GenIO = Gen (PrimState IO)
data Chunk = Chunk Int Int
data Card
data External
data ImportType
- = Def
- | Open
data ImportOpts = ImportOpts {
- _optInput :: String
- _optOutput :: String
- _optImportType :: ImportType
- _optImportReverse :: Bool
- _optRowDelimiter :: String
- _optTermDefDelimiter :: String
- _optDefDelimiter :: Maybe String
}
data Parameters = Parameters {
- _pShuffle :: Bool
- _pSubset :: Maybe Int
- _pChunk :: Chunk
- _pReviewMode :: Bool
- _pOk :: Bool
}
goToState_ :: GlobalState -> State -> GlobalState
cardsToString :: [Card] -> String
parseImportInput :: ImportOpts -> String -> Either String [Card]
defaultParameters :: Parameters

Documentation

getUseEscapeCode :: IO Bool Source #

addRecent :: FilePath -> IO () Source #

cardSelectorState :: IO State Source #

mainMenuState :: State Source #

safeHead :: [a] -> Maybe a Source #

cardsState :: Bool -> FilePath -> [Card] -> [Card] -> [Int] -> IO State Source #

cardsWithOptionsStateM :: (MonadState GlobalState m, MonadIO m) => FilePath -> [Card] -> m State Source #

cardsWithOptionsState :: GlobalState -> FilePath -> [Card] -> IO State Source #

infoState :: State Source #

fileBrowserState :: IO State Source #

entryFilter :: Bool -> FileInfo -> Bool Source #

parameterState :: Parameters -> FilePath -> [Card] -> State Source #

runBrickFlashcards :: GlobalState -> IO () Source #

data GlobalState Source #

Constructors

GlobalState
Fields _mwc :: GenIO _stack :: Stack Mode _states :: Map Mode State _parameters :: Parameters

type GenIO = Gen (PrimState IO) #

A shorter name for PRNG state in the IO monad.

data Chunk Source #

Constructors

Instances

Instances details

Read Chunk Source #
Instance details Defined in States Methods readsPrec :: Int -> ReadS Chunk # readList :: ReadS [Chunk] # readPrec :: ReadPrec Chunk # readListPrec :: ReadPrec [Chunk] #
Show Chunk Source #
Instance details Defined in States Methods showsPrec :: Int -> Chunk -> ShowS # show :: Chunk -> String # showList :: [Chunk] -> ShowS #

data Card Source #

Instances

Instances details

Show Card Source #
Instance details Defined in Types Methods showsPrec :: Int -> Card -> ShowS # show :: Card -> String # showList :: [Card] -> ShowS #

data External Source #

Instances

Instances details

Show External Source #
Instance details Defined in Types Methods showsPrec :: Int -> External -> ShowS # show :: External -> String # showList :: [External] -> ShowS #

data ImportType Source #

Constructors

Def
Open

Instances

Instances details

Read ImportType Source #
Instance details Defined in Import Methods readsPrec :: Int -> ReadS ImportType # readList :: ReadS [ImportType] # readPrec :: ReadPrec ImportType # readListPrec :: ReadPrec [ImportType] #

data ImportOpts Source #

Constructors

ImportOpts
Fields _optInput :: String _optOutput :: String _optImportType :: ImportType _optImportReverse :: Bool _optRowDelimiter :: String _optTermDefDelimiter :: String _optDefDelimiter :: Maybe String

data Parameters Source #

Constructors

Parameters
Fields _pShuffle :: Bool _pSubset :: Maybe Int _pChunk :: Chunk _pReviewMode :: Bool _pOk :: Bool

goToState_ :: GlobalState -> State -> GlobalState Source #

cardsToString :: [Card] -> String Source #

parseImportInput :: ImportOpts -> String -> Either String [Card] Source #

defaultParameters :: Parameters Source #