@@ -1,480 +1,861 @@
6+ * Fixed a build issue with a test program.
12+ * Add support for 24-bit color (thanks @u-quark). This change
13+ updates Vty to look at the `COLORTERM` environment variable that is
14+ conventionally used to advertise support for truecolor escape
15+ sequences. The change also updates the Vty demo to demonstrate
16+ 24-bit colors. This change also adds a new data type, `ColorMode`,
17+ to represent the color mode in use, as well as an `Output` interface
18+ field, `outputColorMode`, to track the active color mode and use it
19+ to clamp emitted color escape sequences to the active color range.
22+ * All types in `Graphics.Vty.Input.Events` now have strict constructor
24+ * Internal events are now wrapped in a new `InternalEvent` type to
25+ improve how signal handling is done. This change modifies the `Input`
26+ type's event channel API to produce `InternalEvents`, not `Events`.
27+ The new `InternalEvent` either wraps `Event` with the `InputEvent`
28+ constructor (the previous behavior) or indicates that Vty resumed
29+ after handling a signal using the `ResumeAfterSignal` constructor.
30+ This change avoids the previous use of `EvResize` with lazy exception
31+ arguments as a sentinel value for `ResumeAfterSignal`.
34+ * Bracketed paste parsing performance has been greatly improved thanks
35+ to benchmarking and optimization work by @iphydf. As part of that
36+ work, Vty now uses bytestrings rather than Strings internally when
37+ parsing input to look for events.
38+ * The `\b` value is now interpreted as `KBS` (thanks @vglfr)
44+ * Added an `NFData` instance for `Event` (thanks Mario Lang)
45+ * Removed `Monoid` and `Semigroup` instances for `Attr` and
46+ `MaybeDefault`. This change removed the instances because they were
47+ misbehaved; merging `Attr` and `MaybeDefault` values with these
48+ instances resulted in field value losses. For example, before this
51+(defAttr `withForeColor` blue) <> (defAttr `withBackColor` green)
55+ (defAttr `withBackColor` green)
57+ because the instances were designed to favor the right-hand
58+ arguments' fields even if they had not been explicitly set
59+ (a consequence of the `MaybeDefault` `Semigroup` instance).
60+ While that behavior was sensible specifically in the context of
61+ `Graphics.Vty.Inline`, it wasn't a useful user-facing API and it made
62+ for surprising instance behavior. Since there is actually no good way
63+ to handle this in a `Semigroup` instance for `Attr` -- some choices
64+ have to be made about how to merge two attributes' foreground colors,
65+ and that won't be much better than what we had -- the instance was
73+* The `Cursor` type got a new `PositionOnly` constructor for cursor
74+ placement without visibility.
77+* Relaxed upper bound for `random`
78+* Updated `microlens` bounds to allow 0.4.12
81+* Various hlint-driven improvements (thanks Willem Van Onsem)
82+* The implementation of `color240` was improved (thanks (Willem Van
89+ * Meta-PageUp and Meta-PageDown are now supported (#193)
90+ * Added `supportsItalics` and `supportsStrikethrough` functions to
91+ check for feature support in terminfo
94+ * Detect utf-8 mode in `LANG` regardless of case (thanks Emeka
100+New features and API changes:
101+ * Added support for strikethrough mode. This change adds a new
102+ `strikethrough` `Style` value and uses the `smxx` and `rmxx`
103+ Terminfo capabilities to activate and deactivate strikethrough mode,
104+ respectively. If the terminfo does not report those capabilities,
105+ this style is ignored.
106+ * `Output`: added the `setDisplayBounds` field to set the output
107+ dimensions of the output handle; added an implementation of this for
108+ the `TerminfoBased` backend.
111+ * The C prototype for `vty_c_get_window_size` in `gwinsz.h` was fixed.
117+ * Added `Graphics.Vty.setWindowTitle` to emit an escape
118+ sequence to set the window title, provide the terminal emulator
119+ accepts Xterm-style title sequences. For details, see:
120+ https://tldp.org/HOWTO/Xterm-Title-3.html
126+ * The Input type got a new field, 'restoreInputState'. This field
127+ allows the end user to have direct access to the logic needed to
128+ restore the terminal's input state flags. Prior to having this field,
129+ this state restoration logic could only be invoked as part of calling
130+ 'shutdownInput', but since that function does other things (like
131+ killing threads) it is not advisable to call it repeatedly (which is
132+ necessary in the use case this change is intended to support). This
133+ can be called directly to restore the input state flags as needed,
134+ although this is not required if 'shutdown' (or 'shutdownInput') is
138+ * attributeControl: explicitly enable the ICRNL terminal mode flag (see
145+ * Added a package dependency on `semigroups` for the
146+ `vty-build-width-table` tool on older GHCs (#185)
152+ * `installUnicodeWidthTable`: use `throwIO`, not `throw`
157+This release improves Vty's support for multi-column Unicode characters
158+and provides greater compatibility with a wider array of terminal
159+emulators. The following sections summarize the relevant changes, but an
160+overview of the new functionality is motivated and detailed in the new
161+"Multi-Column Character Support" README section. For
162+historical context, please also consider reading over
163+[#175](https://github.com/jtdaugherty/vty/issues/175).
166+ * New modules were added:
167+ * `Graphics.Vty.UnicodeWidthTable.Types`
168+ * `Graphics.Vty.UnicodeWidthTable.IO`
169+ * `Graphics.Vty.UnicodeWidthTable.Query`
170+ * `Graphics.Vty.UnicodeWidthTable.Install`
171+ * The `Config` type got a new field, `allowCustomUnicodeWidthTables`,
172+ that controls whether `mkVty` will attempt to load a Unicode width
173+ table if specified in the configuration.
175+Configuration file changes:
176+ * A new syntax was added to support specifying Unicode width tables on
177+ a per-`TERM` basis. The syntax is `widthMap <TERM> <PATH>`. See the
178+ documentation for `Graphics.Vty.Config` for details. Since prior
179+ versions of this library will silently ignore any configuration file
180+ lines they cannot parse, this change to user configuration files is
181+ at least non-breaking for older versions of Vty.
184+ * The `mkVty` function now automatically attempts to load a custom
185+ Unicode width table if one is specified in the configuration,
186+ provided `allowCustomUnicodeWidthTables` is not set to `Just False`.
187+ See the documentation for `Graphics.Vty.mkVty` for details.
188+ * Vty now includes a command line tool, `vty-build-width-table`, that
189+ queries the terminal emulator to construct a custom Unicode width
190+ table and optionally update the Vty configuration file to use it.
191+ Programs that want to use that tool's functionality may also do so
192+ via the API exposed in the various modules listed above.
197+* Added `Graphics.Vty.Config.getTtyEraseChar` to support querying the
198+ kernel for the current terminal's settings to obtain the character
199+ assigned by the `stty erase` command. That can then be added to the
200+ Vty configuration's input map to map to `KBS` (backspace) if desired.
205+* Resolved various import warnings (thanks @glguy)
206+* Removed the `MonadIO` constraint from the Output type's fields and
207+ removed `MonadFail` uses (PR #177, thanks @glguy)
208+* Clarified documentation for ANSI colors (thanks Colby Jenn)
209+* `Graphics.Vty.Attributes` no longer re-exports
210+ `Graphics.Vty.Attributes.Color`
211+* The `Graphics.Vty.Attributes.Color` module is now exposed (thanks
213+* Raised upper bound for `microlens` to 0.4.12 (thanks Artyom Kazak)
214+* Changed from using `System.Posix.Env.getEnv` to
215+ `System.Environment.lookupEnv` (thanks Jonathan Osser)
216+* Added `Graphics.Vty.Image` functions for dealing with character width
217+ computations on `Text` values instead of `Strings`:
226+* Avoided a conflict with a Microlens 0.4.10 operator and added an
227+ upper bound on Microlens of 0.4.11.
232+* The Vty type got a new field, isShutdown, that returns whether the
233+ Vty handle has had its 'shutdown' function called (thanks Ian
235+* Vty's shutdown function is now thread-safe.
240+* The "shutdown" method of Vty handles is now idempotent (#159)
245+* Add Generic and NFData instances for some types
246+* Image: remove custom Show instance, add derived Show and Read
248+* Updated Travis build settings (thanks Eric Mertens)
253+* Fixed a bug where italics did not combine properly with other display
254+ modes (#155, thanks Eric Mertens)
259+* Added support for italicized output when terminfo supports it. This
260+ takes the form of a new Style, "italic". Note that most terminfo
261+ descriptors do not report capabilities for italics, so support for
262+ this will be very spotty.
263+* Updateed text/string function documentation to indicate that escapes
264+ are not permitted in their inputs.
269+* Added Graphics.Vty.Attributes.Color240.color240CodeToRGB function
270+ (thanks Brent Carmer)
271+* Added nextEventNonblocking function (field) to Vty type (#87)
276+* Picture and Background now provide Eq instances (thanks Jaro Reinders)
277+* #145: vty builds with microlens 0.4.9 (thanks Daniel Wagner)
278+* #142: note requirement of threaded RTS
284+* Split up Monoid instances into Monoid and Semigroup for newer GHCs
291+* Cursor now provides an Eq instance (thanks Jaro Reinders)
2API changes:
296API changes:
3− - URL hyperlinking (via 'withURL') is now optional and disabled by
297+* URL hyperlinking (via 'withURL') is now optional and disabled by
4− default due to poor support on some common terminals. A new 'Mode'
298+ default due to poor support on some common terminals. A new 'Mode'
5− constructor, 'Hyperlink', has been added to enable this feature. To
299+ constructor, 'Hyperlink', has been added to enable this feature. To
6− change the hyperlinking mode, use 'setMode' on the 'outputIface' of a
300+ change the hyperlinking mode, use 'setMode' on the 'outputIface' of a
7− Vty handle.
301+ Vty handle.
10Bug fixes:
306Bug fixes:
11− - Reset the hyperlink state on line endings to avoid run-on hyperlinks
307+* Reset the hyperlink state on line endings to avoid run-on hyperlinks
14API changes:
312API changes:
15− - Added support for hyperlinking attributes (thanks Getty Ritter). This
313+* Added support for hyperlinking attributes (thanks Getty Ritter). This
16− change adds a new Attr field for containing the hyperlink to apply,
314+ change adds a new Attr field for containing the hyperlink to apply,
17− as per https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
315+ as per https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
20− - withStyle now ignores zero arguments, leaving attribute styles
320+* withStyle now ignores zero arguments, leaving attribute styles
21− untouched if the input style is the null style
321+ untouched if the input style is the null style
24API changes:
326API changes:
25− - Add support for terminal focus events. This change adds a new mode
327+* Add support for terminal focus events. This change adds a new mode
26− usable with setMode, Focus, that requests that the terminal send
328+ usable with setMode, Focus, that requests that the terminal send
27− events on focus lose/gain. This change also adds two new Event
329+ events on focus lose/gain. This change also adds two new Event
28− constructors, EvLostFocus and EvGainedFocus.
330+ constructors, EvLostFocus and EvGainedFocus.
29− - No longer enable UTF8 mouse event encoding. This encoding was not
331+* No longer enable UTF8 mouse event encoding. This encoding was not
30− working properly with Terminal.app, and using the other modes (SGR,
332+ working properly with Terminal.app, and using the other modes (SGR,
31− etc.) work.
333+ etc.) work.
32− - Graphics.Vty.Attributes: escape backticks in Haddock comment (fixes
334+* Graphics.Vty.Attributes: escape backticks in Haddock comment (fixes
36API changes:
340API changes:
37− - Added support for mouse wheel events while in mouse mode. The Button
341+* Added support for mouse wheel events while in mouse mode. The Button
38− type got two new constructors as a result: BScrollUp and BScrollDown.
342+ type got two new constructors as a result: BScrollUp and BScrollDown.
39− Thanks to doublescale@tutanota.com for this contribution!
343+ Thanks to doublescale@tutanota.com for this contribution!
41Bug fixes:
345Bug fixes:
42− - charFill now clamps negative arguments to zero (thanks Eric
346+* charFill now clamps negative arguments to zero (thanks Eric Mertens!)
46Package changes:
351Package changes:
47− - Documentation files are now marked accordingly (thanks Michal
352+* Documentation files are now marked accordingly (thanks Michal
48− Suchánek)
353+ Suchánek)
50Bug fixes:
355Bug fixes:
51− - translateX/Y: fix negative translations
356+* translateX/Y: fix negative translations
54Package changes:
361Package changes:
55− - Discontinued support for GHC versions prior to 7.10.1.
362+* Discontinued support for GHC versions prior to 7.10.1.
56− - Removed instructions and configuration for Stack builds since they
363+* Removed instructions and configuration for Stack builds since they
57− are no longer supported.
364+ are no longer supported.
58− - Clarified README mention of (lack of) Windows support (contributors
365+* Clarified README mention of (lack of) Windows support (contributors
59− wanted, though!)
366+ wanted, though!)
60− - Removed dependency on data-default (see below).
367+* Removed dependency on data-default (see below).
62API changes:
369API changes:
63− - Moved color definitions from Attributes to Color module.
370+* Moved color definitions from Attributes to Color module.
64− - In lieu of data-default (Default) instances for Attr and Config, use
371+* In lieu of data-default (Default) instances for Attr and Config, use
65− 'defAttr' and the new 'defaultConfig' (or 'mempty') instead of 'def'.
372+ 'defAttr' and the new 'defaultConfig' (or 'mempty') instead of 'def'.
66− - Graphics.Vty.Output no longer re-exports
373+* Graphics.Vty.Output no longer re-exports
67− Graphics.Vty.Output.Interface.
374+ Graphics.Vty.Output.Interface.
68− - Removed Graphics.Vty.Prelude module and moved DisplayRegion and its
375+* Removed Graphics.Vty.Prelude module and moved DisplayRegion and its
69− accessors to Graphics.Vty.Image.
376+ accessors to Graphics.Vty.Image.
70− - Graphics.Vty.Image no longer re-exports Graphics.Vty.Attributes.
377+* Graphics.Vty.Image no longer re-exports Graphics.Vty.Attributes.
71− - Graphics.Vty.Picture no longer re-exports Graphics.Vty.Image.
378+* Graphics.Vty.Picture no longer re-exports Graphics.Vty.Image.
74− - addMaybeClippedJoin: instead of raising an exception when the join
383+* addMaybeClippedJoin: instead of raising an exception when the join
75− is totally clipped, just reduce the clip amount and continue
384+ is totally clipped, just reduce the clip amount and continue
76− - addMaybeClipped: skip blit of joins when their primary dimension is
385+* addMaybeClipped: skip blit of joins when their primary dimension is
78− - 'string' and related text functions no longer treat an empty string
387+* 'string' and related text functions no longer treat an empty string
79− as an empty image (thanks Chris Penner). This means that now it is
388+ as an empty image (thanks Chris Penner). This means that now it is
80− possible to use 'str ""' as a non-empty image with height 1.
389+ possible to use 'str ""' as a non-empty image with height 1.
83− - Reverted changes in 5.12 due to disagreements between terminal
394+* Reverted changes in 5.12 due to disagreements between terminal
84− emulators and utf8proc; for more details, please see the ticket
395+ emulators and utf8proc; for more details, please see the ticket
85− discussion at
396+ discussion at
86− https://github.com/coreyoconnor/vty/issues/115
397+ https://github.com/coreyoconnor/vty/issues/115
89− - Replaced 'wcwidth' with a call to the utf8proc library's character
402+* Replaced 'wcwidth' with a call to the utf8proc library's character
90− width function, which is much more up to date (by several Unicode
403+ width function, which is much more up to date (by several Unicode
91− versions) and returns the right width for a much larger set of
404+ versions) and returns the right width for a much larger set of
92− characters.
405+ characters.
93− - Added a bundled version of the utf8proc C library.
406+* Added a bundled version of the utf8proc C library.
96− - Fix mouse event offsets in mouse-up events
411+* Fix mouse event offsets in mouse-up events
99− - Mouse events were modified so that the upper-left corner of the
416+* Mouse events were modified so that the upper-left corner of the window
100− window is (0,0) rather than (1,1).
417+ is (0,0) rather than (1,1).
103− - Add Generic instance for Image
422+* Add Generic instance for Image
104− - nextEvent: stop trying to refresh on a resize event (fixes segfault
423+* nextEvent: stop trying to refresh on a resize event (fixes segfault
105− on refresh with normal cursor positioning mode)
424+ on refresh with normal cursor positioning mode)
106− - Remove redundant clause from clipForCharWidth (thanks Eric Mertens)
425+* Remove redundant clause from clipForCharWidth (thanks Eric Mertens)
107− - Update maintainer
426+* Update maintainer
110− - Vty now raises a VtyConfigurationError exception when the TERM
431+* Vty now raises a VtyConfigurationError exception when the TERM
111− evironment variable is missing (thanks Eric Mertens)
432+ evironment variable is missing (thanks Eric Mertens)
112− - Graphics.Vty.Config got an explicit export list to avoid accidentally
433+* Graphics.Vty.Config got an explicit export list to avoid accidentally
113− exporting internal types (thanks Eric Mertens)
434+ exporting internal types (thanks Eric Mertens)
116− - Add absolute cursor positioning mode AbsoluteCursor to Cursor. This
439+* Add absolute cursor positioning mode AbsoluteCursor to Cursor. This
117− mode provides greater control over cursor positioning by bypassing
440+ mode provides greater control over cursor positioning by bypassing
118− the logical positioning provided by default. Rather than positioning
441+ the logical positioning provided by default. Rather than positioning
119− the cursor by looking at the widths of characters involved, this
442+ the cursor by looking at the widths of characters involved, this
120− constructor lets you provide a physical row and column instead. This
443+ constructor lets you provide a physical row and column instead. This
121− is useful in more sophisticated programs. (thanks Eric Mertens)
444+ is useful in more sophisticated programs. (thanks Eric Mertens)
122− - Added a new Generic-derived config parser (thanks Eric Mertens)
445+* Added a new Generic-derived config parser (thanks Eric Mertens)
123− - Fixed the MShift case in the configuration file parser (thanks Eric
446+* Fixed the MShift case in the configuration file parser (thanks Eric
124− Mertens)
447+ Mertens)
125− - Fixed wcwidth import and matched safeWcswidth to its documented
448+* Fixed wcwidth import and matched safeWcswidth to its documented
126− behavior. Previously vty_mk_wcwidth was being imported with
449+ behavior. Previously vty_mk_wcwidth was being imported with the
127− the wrong type causing the -1 return value to be mapped to the
450+ wrong type causing the -1 return value to be mapped to the wrong Int
128− wrong Int value. Additionally safeWcswidth was using the unsafe
451+ value. Additionally safeWcswidth was using the unsafe character width
129− character width function and only ensuring that the final result was
452+ function and only ensuring that the final result was non-negative.
130− non-negative. (thanks Eric Mertens)
453+ (thanks Eric Mertens)
133− - Vty now only emits UTF8 charset sequences in terminals without a
458+* Vty now only emits UTF8 charset sequences in terminals without a
134− preexisting UTF8 declaration to avoid emitting garbage sequences
459+ preexisting UTF8 declaration to avoid emitting garbage sequences
135− (fixes #89)
460+ (fixes #89)
138− - Added new Output methods supportsBell and ringTerminalBell to find
465+* Added new Output methods supportsBell and ringTerminalBell to find out
139− out whether the output device has an audio bell and to ring it (see
466+ whether the output device has an audio bell and to ring it (see #102)
143− - Fixed "refresh" to work as advertised (see #104)
471+* Fixed "refresh" to work as advertised (see #104)
146− - API change: EvPaste input event now provides paste data as a raw
476+* API change: EvPaste input event now provides paste data as a raw
147− ByteString rather than a String to allow the application to decode
477+ ByteString rather than a String to allow the application to decode how
148− how best to decode it
478+ best to decode it
151− - ModeDemo: added an explicit Control.Applicative import for older
483+* ModeDemo: added an explicit Control.Applicative import for older GHCs
155− - Mouse and paste modes are now off by default.
488+* Mouse and paste modes are now off by default.
156− - The Config type got new fields: mouseMode and bracketedPasteMode.
489+* The Config type got new fields: mouseMode and bracketedPasteMode.
157− These determine whether these modes are enabled initially (for
490+ These determine whether these modes are enabled initially (for
158− terminals that support them).
491+ terminals that support them).
159− - Added a Mode type for modal terminal features (mouse events,
492+* Added a Mode type for modal terminal features (mouse events,
160− bracketed paste mode) that is used with new Output interface
493+ bracketed paste mode) that is used with new Output interface
161− functions:
494+ functions:
162− * supportsMode :: Mode -> Bool tells whether the device supports a
495+ * supportsMode :: Mode -> Bool tells whether the device supports a
164− * setMode :: Mode -> Bool -> IO () turns a mode on or off
497+ * setMode :: Mode -> Bool -> IO () turns a mode on or off
165− * getModeStatus :: Mode -> IO Bool tells you whether a mode is on or
498+ * getModeStatus :: Mode -> IO Bool tells you whether a mode is on or
167− - Added a new demo program, ModeDemo.hs, to demonstrate usage of modes
500+* Added a new demo program, ModeDemo.hs, to demonstrate usage of modes
170− - Added support for normal and extended mouse modes in Xterm-like
505+* Added support for normal and extended mouse modes in Xterm-like
171− terminals via the MouseDown and MouseUp Event constructors
506+ terminals via the MouseDown and MouseUp Event constructors
172− - Added support for bracketed paste mode in Xterm-like terminals via
507+* Added support for bracketed paste mode in Xterm-like terminals via
173− the EvPaste event constructor
508+ the EvPaste event constructor
174− - Added derived Show instances for Event and Button (thanks Felix
509+* Added derived Show instances for Event and Button (thanks Felix
176− - Now TERM values containing "screen" will automatically use the
511+* Now TERM values containing "screen" will automatically use the
177− XtermColor driver rather than just TerminfoBased
512+ XtermColor driver rather than just TerminfoBased
180− - Replaced lens dependency with microlens, microlens-mtl, microlens-th
517+* Replaced lens dependency with microlens, microlens-mtl, microlens-th
181− dependencies. Issue #90
518+ dependencies. Issue #90
182− - Thanks Jonathan Daugherty
519+ * Thanks Jonathan Daugherty
183− - Cabal corrections.
520+* Cabal corrections.
184− - Thanks Lennart Spitzner
521+ * Thanks Lennart Spitzner
187− - Changed eventChannel of Graphics.Vty.Input from Chan to TChan.
526+* Changed eventChannel of Graphics.Vty.Input from Chan to
188− This enables clients to query if there are no pending events. The
527+ TChan. This enables clients to query if there are no pending
189− Graphics.Vty interface nextEvent is unchanged. Clients that use
528+ events. The Graphics.Vty interface nextEvent is unchanged.
190− eventChannel directly will require updating.
529+ Clients that use eventChannel directly will require updating.
191− https://github.com/coreyoconnor/vty/issues/60
530+ https://github.com/coreyoconnor/vty/issues/60
193− - Reverted cabal file to depend on Cabal >= 1.18 instead of 1.20 due
535+* Reverted cabal file to depend on Cabal >= 1.18 instead of 1.20 due to
194− to possibly breaking this on reasonable GHC versions
536+ possibly breaking this on reasonable GHC versions
197− - Upgraded QuickCheck dependency to 2.7
541+* Upgraded QuickCheck dependency to 2.7
198− - The standard IO Config (standardIOConfig) was overriding any
542+* The standard IO Config (standardIOConfig) was overriding any provided
199− provided application config. In addition, the inputFd and outputFd
543+ application config. In addition, the inputFd and outputFd could not be
200− could not be changed if mkVty was used. Fixed.
544+ changed if mkVty was used. Fixed.
201− - Correct handling of display attributes at end of line. The output
545+* Correct handling of display attributes at end of line. The output
202− attributes are set to default at the end of content for the line and
546+ attributes are set to default at the end of content for the line and
203− at the start of a new line. Previously the current attribute would
547+ at the start of a new line. Previously the current attribute would
204− extend to the next start of content. This was odd to reason about
548+ extend to the next start of content. This was odd to reason about and
205− and was the cause of https://github.com/coreyoconnor/vty/issues/76
549+ was the cause of https://github.com/coreyoconnor/vty/issues/76 IIRC Yi
206− IIRC Yi requires the old behavior to display the selection region
550+ requires the old behavior to display the selection region correctly.
208− - shutdown of the input thread is now performed using killThread and
551+* shutdown of the input thread is now performed using killThread and
209− synchronization on an MVar. For correct handling of the terminal
552+ synchronization on an MVar. For correct handling of the terminal read
210− read vmin and vtime the read must be a blocking read on an OS
553+ vmin and vtime the read must be a blocking read on an OS thread.
211− thread. This places a threadWaitRead, which will be interrupted by
554+ This places a threadWaitRead, which will be interrupted by the
212− the killThread, prior to the uninterruptable read. An alternative
555+ killThread, prior to the uninterruptable read. An alternative would be
213− would be to re-import the read foreign call as interruptable.
556+ to re-import the read foreign call as interruptable.
216− - deepseq bounds increased for tests.
561+* deepseq bounds increased for tests.
217− - Clean up warnings when compiling on 7.10
562+* Clean up warnings when compiling on 7.10
218− - Thanks Eric Mertens
563+ * Thanks Eric Mertens
219− - Avoid discarding input bytes after multi-byte encoded codepoint
564+* Avoid discarding input bytes after multi-byte encoded codepoint
220− - Thanks Eric Mertens
565+ * Thanks Eric Mertens
223− - "str" now returns EmptyImage for empty strings to match behavior of
570+* "str" now returns EmptyImage for empty strings to match behavior of
224− other string-like Image constructors (fixes #74)
571+ other string-like Image constructors (fixes #74)
225− - Thanks Jonathan Daugherty
572+ * Thanks Jonathan Daugherty
228− - dependency version bumps
577+* dependency version bumps
229− - https://github.com/coreyoconnor/vty/pull/71
578+ * https://github.com/coreyoconnor/vty/pull/71
230− - https://github.com/coreyoconnor/vty/pull/70
579+ * https://github.com/coreyoconnor/vty/pull/70
231− - Correct/Simplify the example code
580+* Correct/Simplify the example code
232− - Thanks glguy
581+ * Thanks glguy
233− - https://github.com/coreyoconnor/vty/pull/69
582+ * https://github.com/coreyoconnor/vty/pull/69
236− - blaze-builder, lens, utf8-string version constraint bump
587+* blaze-builder, lens, utf8-string version constraint bump
237− - Thanks glguy
588+ * Thanks glguy
238− - https://github.com/coreyoconnor/vty/pull/67
589+ * https://github.com/coreyoconnor/vty/pull/67
239− - Do not differentiate based on TERM_PROGRAM
590+* Do not differentiate based on TERM_PROGRAM
240− - https://github.com/coreyoconnor/vty/issues/68
591+ * https://github.com/coreyoconnor/vty/issues/68
243− - lens and deepseq constraint bump + misc
596+* lens and deepseq constraint bump + misc
244− - Thanks ethercrow
597+ * Thanks ethercrow
245− - https://github.com/coreyoconnor/vty/pull/66
598+ * https://github.com/coreyoconnor/vty/pull/66
248− - lens constraint bump
603+* lens constraint bump
249− - Thanks alexander-b!
604+ * Thanks alexander-b!
250− - https://github.com/coreyoconnor/vty/pull/64
605+ * https://github.com/coreyoconnor/vty/pull/64
253− - lens and random version constraint bump.
610+* lens and random version constraint bump.
254− - Thanks RyanGlScott!
611+ * Thanks RyanGlScott!
255− - https://github.com/coreyoconnor/vty/pull/62
612+ * https://github.com/coreyoconnor/vty/pull/62
258− - removed -fpic from cc-options. No longer required.
617+* removed -fpic from cc-options. No longer required.
259− - https://github.com/coreyoconnor/vty/issues/61
618+ * https://github.com/coreyoconnor/vty/issues/61
260− - https://ghc.haskell.org/trac/ghc/ticket/9657
619+ * https://ghc.haskell.org/trac/ghc/ticket/9657
261− - Thanks Fuuzetsu!
620+ * Thanks Fuuzetsu!
264− - evaluate/compile the input parsing table once instead of each
625+* evaluate/compile the input parsing table once instead of each
265− keystroke.
626+ keystroke.
266− - https://github.com/coreyoconnor/vty/pull/59
627+ * https://github.com/coreyoconnor/vty/pull/59
267− - Thanks ethercrow!
628+ * Thanks ethercrow!
270− - When looking at input for an event, don't look too deep.
633+* When looking at input for an event, don't look too deep.
271− - https://github.com/coreyoconnor/vty/pull/57
634+ * https://github.com/coreyoconnor/vty/pull/57
272− - Thanks ethercrow!
635+ * Thanks ethercrow!
275− - Bump upper version bound for lens to 4.5. Thanks markus1189!
640+* Bump upper version bound for lens to 4.5. Thanks markus1189!
278− - Config structure now specifies file descriptor to use. The default
645+* Config structure now specifies file descriptor to use. The default
279− is stdInput and stdOutput file descriptors. Previously Vty used
646+ is stdInput and stdOutput file descriptors. Previously Vty used
280− stdInput for input and the follow code for output:
647+ stdInput for input and the follow code for output:
281− - hDuplicate stdout >>= handleToFd >>= (`hSetBuffering`
648+ * hDuplicate stdout >>= handleToFd >>= (`hSetBuffering`
282− NoBuffering)
649+ NoBuffering)
283− - the difference was required by Vty.Inline. Now, Vty.Inline uses
650+ * the difference was required by Vty.Inline. Now, Vty.Inline uses
284− the Config structure options to acheive the same effect.
651+ the Config structure options to acheive the same effect.
285− - removed: derivedVtime, derivedVmin, inputForCurrentTerminal,
652+* removed: derivedVtime, derivedVmin, inputForCurrentTerminal,
286− inputForNameAndIO, outputForCurrentTerminal, outputForNameAndIO
653+ inputForNameAndIO, outputForCurrentTerminal, outputForNameAndIO
287− - added: inputForConfig, outputForConfig
654+* added: inputForConfig, outputForConfig
288− - updates to vty-rogue from jtdaugherty. Thanks!
655+* updates to vty-rogue from jtdaugherty. Thanks!
289− - the oldest version of GHC tested to support vty is 7.6.2.
656+* the oldest version of GHC tested to support vty is 7.6.2.
290− - the oldest version of GHC that vty compiles under is 7.4.2
657+* the oldest version of GHC that vty compiles under is 7.4.2
293− - merged https://github.com/coreyoconnor/vty/pull/51 thanks trofi!
662+* merged https://github.com/coreyoconnor/vty/pull/51 thanks trofi!
296− - merged https://github.com/coreyoconnor/vty/pull/48 thanks sjmielke!
667+* merged https://github.com/coreyoconnor/vty/pull/48 thanks sjmielke!
297− - jtdaugherty resolved a number of compiler warnings. Thanks!
668+* jtdaugherty resolved a number of compiler warnings. Thanks!
300− - vmin and vtime can be specified however the application requires.
673+* vmin and vtime can be specified however the application requires.
301− See Graphics.Vty.Config.
674+ See Graphics.Vty.Config.
302− - fixed the processing of input when vmin is set > 1.
675+* fixed the processing of input when vmin is set > 1.
305− - The naming convention now matches:
680+* The naming convention now matches:
306− - http://www.haskell.org/haskellwiki/Programming_guidelines#Naming_Conventions
681+ * http://www.haskell.org/haskellwiki/Programming_guidelines#Naming_Conventions
307− - all projects using vty for input must be compiled with -threaded.
682+* all projects using vty for input must be compiled with -threaded.
308− Please notify vty author if this is not acceptable.
683+ Please notify vty author if this is not acceptable.
309− - mkVtyEscDelay has been removed. Use "mkVty def". Which initialized
684+* mkVtyEscDelay has been removed. Use "mkVty def". Which initialized
310− vty with the default configuration.
685+ vty with the default configuration.
311− - input handling changes
686+* input handling changes
312− - KASCII is now KChar
687+ * KASCII is now KChar
313− - KPN5 is now KCenter
688+ * KPN5 is now KCenter
314− - tests exist.
689+ * tests exist.
315− - Applications can add to the input tables by setting inputMap of
690+ * Applications can add to the input tables by setting inputMap of
316− the Config. See Graphics.Vty.Config
691+ the Config. See Graphics.Vty.Config
317− - Users can define input table extensions that will apply to all vty
692+ * Users can define input table extensions that will apply to all vty
318− applications. See Graphics.Vty.Config
693+ applications. See Graphics.Vty.Config
319− - terminal timing is now handled by selecting an appropriate VTIME.
694+ * terminal timing is now handled by selecting an appropriate VTIME.
320− Previously this was implemented within Vty itself. This reduced
695+ Previously this was implemented within Vty itself. This reduced
321− complexity in vty but provides a different meta key behavior and
696+ complexity in vty but provides a different meta key behavior and
322− implies a requirement on -threaded.
697+ implies a requirement on -threaded.
323− - The time vty will wait to verify an ESC byte means a single ESC
698+ * The time vty will wait to verify an ESC byte means a single ESC
324− key is the singleEscPeriod of the Input Config structure.
699+ key is the singleEscPeriod of the Input Config structure.
325− - removed the typeclass based terminal and display context interface
700+* removed the typeclass based terminal and display context interface
326− in favor of a data structure of properties interface.
701+ in favor of a data structure of properties interface.
327− - renamed the Terminal interface to Output
702+* renamed the Terminal interface to Output
328− - The default picture for an image now uses the "clear" background.
703+* The default picture for an image now uses the "clear" background.
329− This background fills background spans with spaces or just ends the
704+ This background fills background spans with spaces or just ends the
331− - Previously the background defaulted to the space character. This
706+ * Previously the background defaulted to the space character. This
332− causes issues copying text from a text editor. The text would end
707+ causes issues copying text from a text editor. The text would end
333− up with extra spaces at the end of the line.
708+ up with extra spaces at the end of the line.
334− - Layer support
709+* Layer support
335− - Each layer is an image.
710+ * Each layer is an image.
336− - The layers for a picture are a list of images.
711+ * The layers for a picture are a list of images.
337− - The first image is the top-most layer. The images are ordered from
712+ * The first image is the top-most layer. The images are ordered from
338− top to bottom.
713+ top to bottom.
339− - The transparent areas for a layer are the backgroundFill areas.
714+ * The transparent areas for a layer are the backgroundFill areas.
340− backgroundFill is added to pad images when images of different
715+ backgroundFill is added to pad images when images of different
341− sizes are joined.
716+ sizes are joined.
342− - If the background is clear there is no background layer.
717+ * If the background is clear there is no background layer.
343− - If there is a background character then the bottom layer is the
718+ * If there is a background character then the bottom layer is the
344− background layer.
719+ background layer.
345− - emptyPicture is a Picture with no layers and no cursor
720+ * emptyPicture is a Picture with no layers and no cursor
346− - addToTop and addToBottom add a layer to the top and bottom of the
721+ * addToTop and addToBottom add a layer to the top and bottom of the
347− given Picture.
722+ given Picture.
348− - compatibility improvements:
723+* compatibility improvements:
349− - terminfo based terminals with no cursor support are silently
724+ * terminfo based terminals with no cursor support are silently
350− accepted. The cursor visibility changes in the Picture will have
725+ accepted. The cursor visibility changes in the Picture will have
351− no effect.
726+ no effect.
352− - alternate (setf/setb) color maps supported. Though colors beyond
727+ * alternate (setf/setb) color maps supported. Though colors beyond
353− the first 8 are just a guess.
728+ the first 8 are just a guess.
354− - added "rgbColor" for easy support of RGB specified colors.
729+ * added "rgbColor" for easy support of RGB specified colors.
355− - Both applications and users can add to the mapping used to
730+ * Both applications and users can add to the mapping used to
356− translate from input bytes to events.
731+ translate from input bytes to events.
357− - Additional information about input and output process can be
732+* Additional information about input and output process can be
358− appended to a debug log
733+ appended to a debug log
359− - Set environment variable VTY_DEBUG_LOG to path of debug log
734+ * Set environment variable VTY_DEBUG_LOG to path of debug log
360− - Or use "debugLog <path>" config directive
735+ * Or use "debugLog <path>" config directive
361− - Or set 'debugLog' property of the Config provided to mkVty.
736+ * Or set 'debugLog' property of the Config provided to mkVty.
362− - examples moved to vty-examples package. See test directory for cabal
737+* examples moved to vty-examples package. See test directory for cabal
364− - vty-interactive-terminal-test
739+ * vty-interactive-terminal-test
365− - interactive test. Useful for building a bug report for vty's
740+ * interactive test. Useful for building a bug report for vty's
367− - test/interactive_terminal_test.hs
742+ * test/interactive_terminal_test.hs
368− - vty-event-echo
743+ * vty-event-echo
369− - view a input event log for vty. Example of interacting with
744+ * view a input event log for vty. Example of interacting with
371− - test/EventEcho.hs
746+ * test/EventEcho.hs
372− - vty-rogue
747+ * vty-rogue
373− - The start of a rogue-like game. Example of layers and image
748+ * The start of a rogue-like game. Example of layers and image
374− build operations.
749+ build operations.
375− - test/Rogue.hs
750+ * test/Rogue.hs
376− - vty-benchmark
751+ * vty-benchmark
377− - benchmarks vty. A series of tests that push random pictures to
752+ * benchmarks vty. A series of tests that push random pictures to
378− the terminal. The random pictures are generated using
753+ the terminal. The random pictures are generated using
379− QuickCheck. The same generators used in the automated tests.
754+ QuickCheck. The same generators used in the automated tests.
380− - test/benchmark.hs
755+ * test/benchmark.hs
383− - API changes:
758+-------
384− - Added Graphics.Vty.Image.crop: Ensure an image is no larger
385− than the specified size.
386− - Added Graphics.Vty.Image.pad: Ensure an image is no smaller
387− than the specified size.
388− - Added Graphics.Vty.Image.translate: Offset an image.
389− - Thanks Ben Boeckel <MathStuf@gmail.com> for these features.
391−4.3.0.0
760+API changes:
761+* Added Graphics.Vty.Image.crop: Ensure an image is no larger
762+ than the specified size.
763+* Added Graphics.Vty.Image.pad: Ensure an image is no smaller
764+ than the specified size.
765+* Added Graphics.Vty.Image.translate: Offset an image.
766+* Thanks Ben Boeckel <MathStuf@gmail.com> for these features.
394− - API changes:
771+API changes:
395− - Attr record accessor fore_color changed to attr_fore_color
772+* Attr record accessor fore_color changed to attr_fore_color
396− - Attr record accessor back_color changed to attr_back_color
773+* Attr record accessor back_color changed to attr_back_color
397− - Attr record accessor style changed to attr_style
774+* Attr record accessor style changed to attr_style
398− - Added an "inline" display attribute changing DSL:
775+* Added an "inline" display attribute changing DSL:
399− - put_attr_change applies a display attribute change
776+ * put_attr_change applies a display attribute change
400− immediately to a terminal
777+ immediately to a terminal
401− - For instance, can be used to change the display attrbiutes
778+ * For instance, can be used to change the display attrbiutes
402− of text output via putStrLn and putStr. EX:
779+ of text output via putStrLn and putStr. EX:
403− "put_attr_change $ back_color red" will set the background
780+ "put_attr_change $ back_color red" will set the background
404− color to red.
781+ color to red.
405− - Changes do not apply to a Picture output via output_picture.
782+ * Changes do not apply to a Picture output via output_picture.
406− - See Graphics.Vty.Inline
783+ * See Graphics.Vty.Inline
407− - Moved all IO actions into any monad an instance of MonadIO
784+* Moved all IO actions into any monad an instance of MonadIO
410− - binding for mk_wcswidth was incorrect. Most platforms just
789+* binding for mk_wcswidth was incorrect. Most platforms just
411− magically worked due to coincidence.
790+ magically worked due to coincidence.
414− - API changes:
795+API changes:
415− - "getSize" has been removed. Use "terminal vty >>= display_bounds"
796+* "getSize" has been removed. Use "terminal vty >>= display_bounds"
416− where "vty" is an instance of the Vty data structure.
797+ where "vty" is an instance of the Vty data structure.
417− - added a "terminal" field to the Vty data structure. Accesses the
798+* added a "terminal" field to the Vty data structure. Accesses the
418− TerminalHandle associated with the Vty instance.
799+ TerminalHandle associated with the Vty instance.
419− - Graphics.Vty.Types has undergone a number of changes. Summary:
800+* Graphics.Vty.Types has undergone a number of changes. Summary:
420− - Partitioned into Graphics.Vty.Attributes for display attributes.
801+ * Partitioned into Graphics.Vty.Attributes for display attributes.
421− Graphics.Vty.Image for image combinators. Graphics.Vty.Picture
802+ Graphics.Vty.Image for image combinators. Graphics.Vty.Picture
422− for final picture construction.
803+ for final picture construction.
423− - Graphics.Vty.Attributes:
804+* Graphics.Vty.Attributes:
424− - "setFG" and "setBG" are now "with_fore_color" and
805+ * "setFG" and "setBG" are now "with_fore_color" and
425− "with_back_color"
806+ "with_back_color"
426− - All other "set.." equations similarly replaced.
807+ * All other "set.." equations similarly replaced.
427− - "attr" is now "def_attr", short for "default display attributes"
808+ * "attr" is now "def_attr", short for "default display attributes"
428− Also added a "current_attr" for "currently applied display
809+ Also added a "current_attr" for "currently applied display
429− attributes"
810+ attributes"
430− - Graphics.Vty.Image:
811+* Graphics.Vty.Image:
431− - "horzcat" is now "horiz_cat"
812+ * "horzcat" is now "horiz_cat"
432− - "vertcat" is now "vert_cat"
813+ * "vertcat" is now "vert_cat"
433− - "renderBS" is now "utf8_bytestring"
814+ * "renderBS" is now "utf8_bytestring"
434− - "renderChar" is now "char"
815+ * "renderChar" is now "char"
435− - "renderFill" is now "char_fill"
816+ * "renderFill" is now "char_fill"
436− - added a "utf8_string" and "string" (AKA "iso_10464_string") for
817+ * added a "utf8_string" and "string" (AKA "iso_10464_string") for
437− UTF-8 encoded Strings and ISO-10464 encoded Strings. String
818+ UTF-8 encoded Strings and ISO-10464 encoded Strings. String
438− literals in GHC have an ISO-10464 runtime representation.
819+ literals in GHC have an ISO-10464 runtime representation.
439− - Graphics.Vty.Picture:
820+* Graphics.Vty.Picture:
440− - exports Graphics.Vty.Image
821+ * exports Graphics.Vty.Image
441− - "pic" is now "pic_for_image"
822+ * "pic" is now "pic_for_image"
442− - added API for setting background fill pattern.
823+ * added API for setting background fill pattern.
443− - Completely rewritten output backend.
824+* Completely rewritten output backend.
444− - Efficient, scanline style output span generator. Has not been
825+ * Efficient, scanline style output span generator. Has not been
445− fully optimized, but good enough.
826+ fully optimized, but good enough.
446− - The details required to display the desired picture on a
827+ * The details required to display the desired picture on a
447− terminal are well encapsulated.
828+ terminal are well encapsulated.
448− - Terminfo based display terminal implementation. With specialized
829+ * Terminfo based display terminal implementation. With specialized
449− derivitives for xterm, Terminal.app, and iTerm.app.
830+ derivitives for xterm, Terminal.app, and iTerm.app.
450− - Attempts to robustly handle even terminals that don't
831+ * Attempts to robustly handle even terminals that don't
451− support all display attributes.
832+ support all display attributes.
452− - I've tested the following terminals with success: iTerm.app,
833+ * I've tested the following terminals with success: iTerm.app,
453− Terminal.app, xterm, rxvt, mlterm, Eterm, gnome-terminal,
834+ Terminal.app, xterm, rxvt, mlterm, Eterm, gnome-terminal,
454− konsole, screen, linux vty. Hopefully you will be as
835+ konsole, screen, linux vty. Hopefully you will be as
455− successfull.
836+ successfull.
456− - Improved unicode support. Double wide characters will display as
837+ * Improved unicode support. Double wide characters will display as
457− expected.
838+ expected.
458− - 256 color support. See Graphics.Vty.Attributes.Color240. The actual
839+* 256 color support. See Graphics.Vty.Attributes.Color240. The actual
459− output color is adjusted according to the number of colors the
840+ output color is adjusted according to the number of colors the
460− terminal supports.
841+ terminal supports.
461− - The Graphics.Vty.Image combinators no longer require matching
842+* The Graphics.Vty.Image combinators no longer require matching
462− dimensions to arguments. Unspecified areas are filled in with a
843+ dimensions to arguments. Unspecified areas are filled in with a
463− user-customizable background pattern. See Graphics.Vty.Picture.
844+ user-customizable background pattern. See Graphics.Vty.Picture.
464− - output images are always cropped to display size.
845+* output images are always cropped to display size.
465− - Significant code coverage by QuickCheck tests. An interactive test
846+* Significant code coverage by QuickCheck tests. An interactive test
466− for those final properties that couldn't be automatically verified.
847+ for those final properties that couldn't be automatically verified.
468Issues resolved:
849Issues resolved:
469− - "gnome terminal displays non-basic attributes as strikethrough"
850+* "gnome terminal displays non-basic attributes as strikethrough"
470− - http://trac.haskell.org/vty/ticket/14
851+ * http://trac.haskell.org/vty/ticket/14
471− - "Multi-byte characters are not displayed correctly on update"
852+* "Multi-byte characters are not displayed correctly on update"
472− - http://trac.haskell.org/vty/ticket/10
853+ * http://trac.haskell.org/vty/ticket/10
473− - "Redraw does not handle rendering a line that extends beyond screen
854+* "Redraw does not handle rendering a line that extends beyond screen
474− width characters"
855+ width characters"
475− - http://trac.haskell.org/vty/ticket/13
856+ * http://trac.haskell.org/vty/ticket/13
476− - "The <|> and <-> combinators should be more forgiving of mismatched
857+* "The <|> and <-> combinators should be more forgiving of mismatched
477− dimensions"
858+ dimensions"
478− - http://trac.haskell.org/vty/ticket/9
859+ * http://trac.haskell.org/vty/ticket/9
479− - "256-color support"
860+* "256-color support"
480− - http://trac.haskell.org/vty/ticket/19
861+ * http://trac.haskell.org/vty/ticket/19