Safe Haskell	None
Language	Haskell2010

Termonad.Types

Contents

Orphan instances

Synopsis

data TMTerm = TMTerm {
- term :: !Terminal
- pid :: !Int
- unique :: !Unique
}
data TMNotebookTab = TMNotebookTab {
- tmNotebookTabTermContainer :: !ScrolledWindow
- tmNotebookTabTerm :: !TMTerm
- tmNotebookTabLabel :: !Label
}
data TMNotebook = TMNotebook {
- tmNotebook :: !Notebook
- tmNotebookTabs :: !(FocusList TMNotebookTab)
}
data TMState' = TMState {
- tmStateApp :: !Application
- tmStateAppWin :: !ApplicationWindow
- tmStateNotebook :: !TMNotebook
- tmStateFontDesc :: !FontDescription
- tmStateConfig :: !TMConfig
}
type TMState = MVar TMState'
createTMTerm :: Terminal -> Int -> Unique -> TMTerm
newTMTerm :: Terminal -> Int -> IO TMTerm
getFocusedTermFromState :: TMState -> IO (Maybe Terminal)
createTMNotebookTab :: Label -> ScrolledWindow -> TMTerm -> TMNotebookTab
createTMNotebook :: Notebook -> FocusList TMNotebookTab -> TMNotebook
createEmptyTMNotebook :: Notebook -> TMNotebook
notebookToList :: Notebook -> IO [Widget]
newTMState :: TMConfig -> Application -> ApplicationWindow -> TMNotebook -> FontDescription -> IO TMState
newEmptyTMState :: TMConfig -> Application -> ApplicationWindow -> Notebook -> FontDescription -> IO TMState
newTMStateSingleTerm :: TMConfig -> Application -> ApplicationWindow -> Notebook -> Label -> ScrolledWindow -> Terminal -> Int -> FontDescription -> IO TMState
traceShowMTMState :: TMState -> IO ()
data FontSize
- = FontSizePoints Int
- | FontSizeUnits Double
defaultFontSize :: FontSize
modFontSize :: Int -> FontSize -> FontSize
data FontConfig = FontConfig {
- fontFamily :: !Text
- fontSize :: !FontSize
}
defaultFontConfig :: FontConfig
data Option a
- = Unset
- | Set !a
whenSet :: Monoid m => Option a -> (a -> m) -> m
data ShowScrollbar
- = ShowScrollbarNever
- | ShowScrollbarAlways
- | ShowScrollbarIfNeeded
data ShowTabBar
- = ShowTabBarNever
- | ShowTabBarAlways
- | ShowTabBarIfNeeded
data ConfigOptions = ConfigOptions {
- fontConfig :: !FontConfig
- showScrollbar :: !ShowScrollbar
- scrollbackLen :: !Integer
- confirmExit :: !Bool
- wordCharExceptions :: !Text
- showMenu :: !Bool
- showTabBar :: !ShowTabBar
- cursorBlinkMode :: !CursorBlinkMode
}
defaultConfigOptions :: ConfigOptions
data TMConfig = TMConfig {
- options :: !ConfigOptions
- hooks :: !ConfigHooks
}
defaultTMConfig :: TMConfig
data ConfigHooks = ConfigHooks {
- createTermHook :: TMState -> Terminal -> IO ()
}
defaultConfigHooks :: ConfigHooks
defaultCreateTermHook :: TMState -> Terminal -> IO ()
data FocusNotSameErr
- = FocusListFocusExistsButNoNotebookTabWidget
- | NotebookTabWidgetDiffersFromFocusListFocus
- | NotebookTabWidgetExistsButNoFocusListFocus
data TabsDoNotMatch
- = TabLengthsDifferent Int Int
- | TabAtIndexDifferent Int
data TMStateInvariantErr
- = FocusNotSame FocusNotSameErr Int
- | TabsDoNotMatch TabsDoNotMatch
invariantTMState' :: TMState' -> IO [TMStateInvariantErr]
assertInvariantTMState :: TMState -> IO ()
pPrintTMState :: TMState -> IO ()

Documentation

data TMTerm Source #

A wrapper around a VTE Terminal. This also stores the process ID of the process running on this terminal, as well as a Unique that can be used for comparing terminals.

Constructors

TMTerm
Fields term :: !Terminal The actual `Terminal`. pid :: !Int The process ID of the process running in `term`. unique :: !Unique A `Unique` for comparing different `TMTerm` for uniqueness.

Instances

Instances details

Eq TMTerm Source #
Instance details Defined in Termonad.Types Methods (==) :: TMTerm -> TMTerm -> Bool # (/=) :: TMTerm -> TMTerm -> Bool #
Show TMTerm Source #
Instance details Defined in Termonad.Types Methods showsPrec :: Int -> TMTerm -> ShowS # show :: TMTerm -> String # showList :: [TMTerm] -> ShowS #

data TMNotebookTab Source #

A container that holds everything in a given terminal window. The term in the TMTerm is inside the tmNotebookTabTermContainer ScrolledWindow. The notebook tab Label is also available.

Constructors

TMNotebookTab
Fields tmNotebookTabTermContainer :: !ScrolledWindow The `ScrolledWindow` holding the VTE `Terminal`. tmNotebookTabTerm :: !TMTerm The `Terminal` insidie the `ScrolledWindow`. tmNotebookTabLabel :: !Label The `Label` holding the title of the `Terminal` in the `Notebook` tab.

Instances

Instances details

Eq TMNotebookTab Source #
Instance details Defined in Termonad.Types Methods (==) :: TMNotebookTab -> TMNotebookTab -> Bool # (/=) :: TMNotebookTab -> TMNotebookTab -> Bool #
Show TMNotebookTab Source #
Instance details Defined in Termonad.Types Methods showsPrec :: Int -> TMNotebookTab -> ShowS # show :: TMNotebookTab -> String # showList :: [TMNotebookTab] -> ShowS #

data TMNotebook Source #

This holds the GTK Notebook containing multiple tabs of Terminals. We keep a separate list of terminals in tmNotebookTabs.

Constructors

TMNotebook
Fields tmNotebook :: !Notebook This is the GTK `Notebook` that holds multiple tabs of `Terminal`s. tmNotebookTabs :: !(FocusList TMNotebookTab) A `FocusList` containing references to each individual `TMNotebookTab`.

Instances

Instances details

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

data TMState' Source #

Constructors

TMState
Fields tmStateApp :: !Application tmStateAppWin :: !ApplicationWindow tmStateNotebook :: !TMNotebook tmStateFontDesc :: !FontDescription tmStateConfig :: !TMConfig

Instances

Instances details

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

type TMState = MVar TMState' Source #

createTMTerm :: Terminal -> Int -> Unique -> TMTerm Source #

newTMTerm :: Terminal -> Int -> IO TMTerm Source #

getFocusedTermFromState :: TMState -> IO (Maybe Terminal) Source #

createTMNotebookTab :: Label -> ScrolledWindow -> TMTerm -> TMNotebookTab Source #

createTMNotebook :: Notebook -> FocusList TMNotebookTab -> TMNotebook Source #

createEmptyTMNotebook :: Notebook -> TMNotebook Source #

notebookToList :: Notebook -> IO [Widget] Source #

newTMState :: TMConfig -> Application -> ApplicationWindow -> TMNotebook -> FontDescription -> IO TMState Source #

newEmptyTMState :: TMConfig -> Application -> ApplicationWindow -> Notebook -> FontDescription -> IO TMState Source #

newTMStateSingleTerm :: TMConfig -> Application -> ApplicationWindow -> Notebook -> Label -> ScrolledWindow -> Terminal -> Int -> FontDescription -> IO TMState Source #

traceShowMTMState :: TMState -> IO () Source #

data FontSize Source #

The font size for the Termonad terminal. There are two ways to set the fontsize, corresponding to the two different ways to set the font size in the Pango font rendering library.

If you're not sure which to use, try FontSizePoints first and see how it looks. It should generally correspond to font sizes you are used to from other applications.

Constructors

FontSizePoints Int	This sets the font size based on "points". The conversion between a point and an actual size depends on the system configuration and the output device. The function `fontDescriptionSetSize` is used to set the font size. See the documentation for that function for more info.
FontSizeUnits Double	This sets the font size based on "device units". In general, this can be thought of as one pixel. The function `fontDescriptionSetAbsoluteSize` is used to set the font size. See the documentation for that function for more info.

Instances

Instances details

Eq FontSize Source #
Instance details Defined in Termonad.Types Methods (==) :: FontSize -> FontSize -> Bool # (/=) :: FontSize -> FontSize -> Bool #
Show FontSize Source #
Instance details Defined in Termonad.Types Methods showsPrec :: Int -> FontSize -> ShowS # show :: FontSize -> String # showList :: [FontSize] -> ShowS #
Generic FontSize Source #
Instance details Defined in Termonad.Types Associated Types type Rep FontSize :: Type -> Type Methods from :: FontSize -> Rep FontSize x to :: Rep FontSize x -> FontSize
FromJSON FontSize Source #
Instance details Defined in Termonad.Types Methods parseJSON :: Value -> Parser FontSize parseJSONList :: Value -> Parser [FontSize]
ToJSON FontSize Source #
Instance details Defined in Termonad.Types Methods toJSON :: FontSize -> Value toEncoding :: FontSize -> Encoding toJSONList :: [FontSize] -> Value toEncodingList :: [FontSize] -> Encoding
type Rep FontSize Source #
Instance details Defined in Termonad.Types type Rep FontSize = D1 ('MetaData "FontSize" "Termonad.Types" "termonad-4.0.0.1-kD3vSPWTY257BsxzCDQmK" 'False) (C1 ('MetaCons "FontSizePoints" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: C1 ('MetaCons "FontSizeUnits" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)))

defaultFontSize :: FontSize Source #

The default FontSize used if not specified.

>>> defaultFontSize
FontSizePoints 12

modFontSize :: Int -> FontSize -> FontSize Source #

Modify a FontSize by adding some value.

>>> modFontSize 1 (FontSizePoints 13)
FontSizePoints 14
>>> modFontSize 1 (FontSizeUnits 9.0)
FontSizeUnits 10.0

You can reduce the font size by passing a negative value.

>>> modFontSize (-2) (FontSizePoints 13)
FontSizePoints 11

If you try to create a font size less than 1, then the old font size will be used.

>>> modFontSize (-10) (FontSizePoints 5)
FontSizePoints 5
>>> modFontSize (-1) (FontSizeUnits 1.0)
FontSizeUnits 1.0

data FontConfig Source #

Settings for the font to be used in Termonad.

Constructors

FontConfig
Fields fontFamily :: !Text The font family to use. Example: `"DejaVu Sans Mono"` or `"Source Code Pro"` fontSize :: !FontSize The font size.

Instances

Instances details

Eq FontConfig Source #
Instance details Defined in Termonad.Types Methods (==) :: FontConfig -> FontConfig -> Bool # (/=) :: FontConfig -> FontConfig -> Bool #
Show FontConfig Source #
Instance details Defined in Termonad.Types Methods showsPrec :: Int -> FontConfig -> ShowS # show :: FontConfig -> String # showList :: [FontConfig] -> ShowS #
Generic FontConfig Source #
Instance details Defined in Termonad.Types Associated Types type Rep FontConfig :: Type -> Type Methods from :: FontConfig -> Rep FontConfig x to :: Rep FontConfig x -> FontConfig
FromJSON FontConfig Source #
Instance details Defined in Termonad.Types Methods parseJSON :: Value -> Parser FontConfig parseJSONList :: Value -> Parser [FontConfig]
ToJSON FontConfig Source #
Instance details Defined in Termonad.Types Methods toJSON :: FontConfig -> Value toEncoding :: FontConfig -> Encoding toJSONList :: [FontConfig] -> Value toEncodingList :: [FontConfig] -> Encoding
type Rep FontConfig Source #
Instance details Defined in Termonad.Types type Rep FontConfig = D1 ('MetaData "FontConfig" "Termonad.Types" "termonad-4.0.0.1-kD3vSPWTY257BsxzCDQmK" 'False) (C1 ('MetaCons "FontConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "fontFamily") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "fontSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FontSize)))

defaultFontConfig :: FontConfig Source #

The default FontConfig to use if not specified.

>>> defaultFontConfig == FontConfig {fontFamily = "Monospace", fontSize = defaultFontSize}
True

data Option a Source #

This data type represents an option that can either be Set or Unset.

This data type is used in situations where leaving an option unset results in a special state that is not representable by setting any specific value.

Examples of this include the cursorFgColour and cursorBgColour options supplied by the ColourConfig ConfigExtension. By default, cursorFgColour and cursorBgColour are both Unset. However, when cursorBgColour is Set, cursorFgColour defaults to the color of the text underneath. There is no way to represent this by setting cursorFgColour.

Constructors

Unset
Set !a

Instances

Instances details

Functor Option Source #
Instance details Defined in Termonad.Types Methods fmap :: (a -> b) -> Option a -> Option b # (<$) :: a -> Option b -> Option a #
Foldable Option Source #
Instance details Defined in Termonad.Types Methods fold :: Monoid m => Option m -> m foldMap :: Monoid m => (a -> m) -> Option a -> m foldMap' :: Monoid m => (a -> m) -> Option a -> m foldr :: (a -> b -> b) -> b -> Option a -> b foldr' :: (a -> b -> b) -> b -> Option a -> b foldl :: (b -> a -> b) -> b -> Option a -> b foldl' :: (b -> a -> b) -> b -> Option a -> b foldr1 :: (a -> a -> a) -> Option a -> a foldl1 :: (a -> a -> a) -> Option a -> a toList :: Option a -> [a] null :: Option a -> Bool length :: Option a -> Int # elem :: Eq a => a -> Option a -> Bool maximum :: Ord a => Option a -> a minimum :: Ord a => Option a -> a sum :: Num a => Option a -> a product :: Num a => Option a -> a
Eq a => Eq (Option a) Source #
Instance details Defined in Termonad.Types Methods (==) :: Option a -> Option a -> Bool # (/=) :: Option a -> Option a -> Bool #
Ord a => Ord (Option a) Source #
Instance details Defined in Termonad.Types Methods compare :: Option a -> Option a -> Ordering # (<) :: Option a -> Option a -> Bool # (<=) :: Option a -> Option a -> Bool # (>) :: Option a -> Option a -> Bool # (>=) :: Option a -> Option a -> Bool # max :: Option a -> Option a -> Option a # min :: Option a -> Option a -> Option a #
Read a => Read (Option a) Source #
Instance details Defined in Termonad.Types Methods readsPrec :: Int -> ReadS (Option a) readList :: ReadS [Option a] readPrec :: ReadPrec (Option a) readListPrec :: ReadPrec [Option a]
Show a => Show (Option a) Source #
Instance details Defined in Termonad.Types Methods showsPrec :: Int -> Option a -> ShowS # show :: Option a -> String # showList :: [Option a] -> ShowS #

whenSet :: Monoid m => Option a -> (a -> m) -> m Source #

Run a function over the value contained in an Option. Return mempty when Option is Unset.

>>> whenSet (Set [1,2,3]) (++ [4,5,6]) :: [Int]
[1,2,3,4,5,6]
>>> whenSet Unset (++ [4,5,6]) :: [Int]
[]

data ShowScrollbar Source #

Whether or not to show the scroll bar in a terminal.

Constructors

ShowScrollbarNever	Never show the scroll bar, even if there are too many lines on the terminal to show all at once. You should still be able to scroll with the mouse wheel.
ShowScrollbarAlways	Always show the scrollbar, even if it is not needed.
ShowScrollbarIfNeeded	Only show the scrollbar if there are too many lines on the terminal to show all at once.

Instances

Instances details

Enum ShowScrollbar Source #
Instance details Defined in Termonad.Types Methods succ :: ShowScrollbar -> ShowScrollbar # pred :: ShowScrollbar -> ShowScrollbar # toEnum :: Int -> ShowScrollbar # fromEnum :: ShowScrollbar -> Int # enumFrom :: ShowScrollbar -> [ShowScrollbar] # enumFromThen :: ShowScrollbar -> ShowScrollbar -> [ShowScrollbar] # enumFromTo :: ShowScrollbar -> ShowScrollbar -> [ShowScrollbar] # enumFromThenTo :: ShowScrollbar -> ShowScrollbar -> ShowScrollbar -> [ShowScrollbar] #
Eq ShowScrollbar Source #
Instance details Defined in Termonad.Types Methods (==) :: ShowScrollbar -> ShowScrollbar -> Bool # (/=) :: ShowScrollbar -> ShowScrollbar -> Bool #
Show ShowScrollbar Source #
Instance details Defined in Termonad.Types Methods showsPrec :: Int -> ShowScrollbar -> ShowS # show :: ShowScrollbar -> String # showList :: [ShowScrollbar] -> ShowS #
Generic ShowScrollbar Source #
Instance details Defined in Termonad.Types Associated Types type Rep ShowScrollbar :: Type -> Type Methods from :: ShowScrollbar -> Rep ShowScrollbar x to :: Rep ShowScrollbar x -> ShowScrollbar
FromJSON ShowScrollbar Source #
Instance details Defined in Termonad.Types Methods parseJSON :: Value -> Parser ShowScrollbar parseJSONList :: Value -> Parser [ShowScrollbar]
ToJSON ShowScrollbar Source #
Instance details Defined in Termonad.Types Methods toJSON :: ShowScrollbar -> Value toEncoding :: ShowScrollbar -> Encoding toJSONList :: [ShowScrollbar] -> Value toEncodingList :: [ShowScrollbar] -> Encoding
type Rep ShowScrollbar Source #
Instance details Defined in Termonad.Types type Rep ShowScrollbar = D1 ('MetaData "ShowScrollbar" "Termonad.Types" "termonad-4.0.0.1-kD3vSPWTY257BsxzCDQmK" 'False) (C1 ('MetaCons "ShowScrollbarNever" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ShowScrollbarAlways" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ShowScrollbarIfNeeded" 'PrefixI 'False) (U1 :: Type -> Type)))

data ShowTabBar Source #

Whether or not to show the tab bar for switching tabs.

Constructors

ShowTabBarNever	Never show the tab bar, even if there are multiple tabs open. This may be confusing if you plan on using multiple tabs.
ShowTabBarAlways	Always show the tab bar, even if you only have one tab open.
ShowTabBarIfNeeded	Only show the tab bar if you have multiple tabs open.

Instances

Instances details

Enum ShowTabBar Source #
Instance details Defined in Termonad.Types Methods succ :: ShowTabBar -> ShowTabBar # pred :: ShowTabBar -> ShowTabBar # toEnum :: Int -> ShowTabBar # fromEnum :: ShowTabBar -> Int # enumFrom :: ShowTabBar -> [ShowTabBar] # enumFromThen :: ShowTabBar -> ShowTabBar -> [ShowTabBar] # enumFromTo :: ShowTabBar -> ShowTabBar -> [ShowTabBar] # enumFromThenTo :: ShowTabBar -> ShowTabBar -> ShowTabBar -> [ShowTabBar] #
Eq ShowTabBar Source #
Instance details Defined in Termonad.Types Methods (==) :: ShowTabBar -> ShowTabBar -> Bool # (/=) :: ShowTabBar -> ShowTabBar -> Bool #
Show ShowTabBar Source #
Instance details Defined in Termonad.Types Methods showsPrec :: Int -> ShowTabBar -> ShowS # show :: ShowTabBar -> String # showList :: [ShowTabBar] -> ShowS #
Generic ShowTabBar Source #
Instance details Defined in Termonad.Types Associated Types type Rep ShowTabBar :: Type -> Type Methods from :: ShowTabBar -> Rep ShowTabBar x to :: Rep ShowTabBar x -> ShowTabBar
FromJSON ShowTabBar Source #
Instance details Defined in Termonad.Types Methods parseJSON :: Value -> Parser ShowTabBar parseJSONList :: Value -> Parser [ShowTabBar]
ToJSON ShowTabBar Source #
Instance details Defined in Termonad.Types Methods toJSON :: ShowTabBar -> Value toEncoding :: ShowTabBar -> Encoding toJSONList :: [ShowTabBar] -> Value toEncodingList :: [ShowTabBar] -> Encoding
type Rep ShowTabBar Source #
Instance details Defined in Termonad.Types type Rep ShowTabBar = D1 ('MetaData "ShowTabBar" "Termonad.Types" "termonad-4.0.0.1-kD3vSPWTY257BsxzCDQmK" 'False) (C1 ('MetaCons "ShowTabBarNever" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ShowTabBarAlways" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ShowTabBarIfNeeded" 'PrefixI 'False) (U1 :: Type -> Type)))

data ConfigOptions Source #

Configuration options for Termonad.

See defaultConfigOptions for the default values.

Constructors

ConfigOptions

Fields

fontConfig :: !FontConfig
Specific options for fonts.
showScrollbar :: !ShowScrollbar
When to show the scroll bar.
scrollbackLen :: !Integer
The number of lines to keep in the scroll back history for each terminal.
confirmExit :: !Bool
Whether or not to ask you for confirmation when closing individual terminals or Termonad itself. It is generally safer to keep this as True.
wordCharExceptions :: !Text
When double-clicking on text in the terminal with the mouse, Termonad will use this value to determine what to highlight. The individual characters in this list will be counted as part of a word.
For instance if wordCharExceptions is "", then when you double-click on the text http://, only the http portion will be highlighted. If wordCharExceptions is ":", then the http: portion will be highlighted.
showMenu :: !Bool
Whether or not to show the File Edit etc menu.
showTabBar :: !ShowTabBar
When to show the tab bar.
cursorBlinkMode :: !CursorBlinkMode
How to handle cursor blink.

Instances

Instances details

Eq ConfigOptions Source #
Instance details Defined in Termonad.Types Methods (==) :: ConfigOptions -> ConfigOptions -> Bool # (/=) :: ConfigOptions -> ConfigOptions -> Bool #
Show ConfigOptions