master..8f32f8e · vty · git.iko.soy

git.iko.soy/vty

59 files changed+1282−2973

unifiedsplit

CHANGELOG.md+397−732

@@ -1,861 +1,526 @@

2−5.35.1

3−------

4−

5−Bug fixes:

6− * Fixed a build issue with a test program.

7−

8−5.35

9−----

10−

11−New features:

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.

20−

21−API changes:

22− * All types in `Graphics.Vty.Input.Events` now have strict constructor

23− fields.

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`.

32−

33−Other enhancements:

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)

39−

40−5.34

41−----

42−

43−API changes:

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

49− change,

50−```

51−(defAttr `withForeColor` blue) <> (defAttr `withBackColor` green)

52−```

53− would result in just

54−```

55− (defAttr `withBackColor` green)

56−```

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

66− just removed.

67−

68−

69−5.33

70−----

71−

72−API changes:

73−* The `Cursor` type got a new `PositionOnly` constructor for cursor

74− placement without visibility.

75−

76−Package changes:

77−* Relaxed upper bound for `random`

78−* Updated `microlens` bounds to allow 0.4.12

79−

80−Other improvements:

81−* Various hlint-driven improvements (thanks Willem Van Onsem)

82−* The implementation of `color240` was improved (thanks (Willem Van

83− Onsem)

84−

85−5.32

86−----

87−

88−New features:

89− * Meta-PageUp and Meta-PageDown are now supported (#193)

90− * Added `supportsItalics` and `supportsStrikethrough` functions to

91− check for feature support in terminfo

92−

93−Bug fixes:

94− * Detect utf-8 mode in `LANG` regardless of case (thanks Emeka

95− Nkurumeh)

96−

97−5.31

98−----

99−

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.

109−

110−Other changes:

111− * The C prototype for `vty_c_get_window_size` in `gwinsz.h` was fixed.

112−

113−5.30

114−----

115−

116−New features:

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

121−

122−5.29

123−----

124−

125−API changes:

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

135− called.

136−

137−Other changes:

138− * attributeControl: explicitly enable the ICRNL terminal mode flag (see

139− #187 and c572ad).

140−

141−5.28.2

142−------

143−

144−Bug fixes:

145− * Added a package dependency on `semigroups` for the

146− `vty-build-width-table` tool on older GHCs (#185)

147−

148−5.28.1

149−------

150−

151−Bug fixes:

152− * `installUnicodeWidthTable`: use `throwIO`, not `throw`

153−

154−5.28

155−----

156−

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).

164−

165−API changes:

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.

174−

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.

182−

183−Other changes:

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.

193−

194−5.27

195−----

196−

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.

201−

202−5.26

203−----

204−

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

212− Colby Jenn)

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`:

218− * `safeWctwidth`

219− * `safeWctlwidth`

220− * `wctwidth`

221− * `wctlwidth`

222−

223−5.25.1

224−------

225−

226−* Avoided a conflict with a Microlens 0.4.10 operator and added an

227− upper bound on Microlens of 0.4.11.

228−

22925.25

230−----

231−

232−* The Vty type got a new field, isShutdown, that returns whether the

233− Vty handle has had its 'shutdown' function called (thanks Ian

234− Jeffries)

235−* Vty's shutdown function is now thread-safe.

3+ - The Vty type got a new field, isShutdown, that returns whether the

4+ Vty handle has had its 'shutdown' function called (thanks Ian

5+ Jeffries)

6+ - Vty's shutdown function is now thread-safe.

2367

23785.24.1

238−------

239−

240−* The "shutdown" method of Vty handles is now idempotent (#159)

9+ - The "shutdown" method of Vty handles is now idempotent (#159)

24110

242115.24

243−----

244−

245−* Add Generic and NFData instances for some types

246−* Image: remove custom Show instance, add derived Show and Read

247− instances

248−* Updated Travis build settings (thanks Eric Mertens)

12+ - Add Generic and NFData instances for some types

13+ - Image: remove custom Show instance, add derived Show and Read instances

14+ - Updated Travis build settings (thanks Eric Mertens)

24915

250165.23.1

251−------

252−

253−* Fixed a bug where italics did not combine properly with other display

254− modes (#155, thanks Eric Mertens)

17+ - Fixed a bug where italics did not combine properly with other

18+ display modes (#155, thanks Eric Mertens)

25519

256205.23

257−----

258−

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.

21+ - Added support for italicized output when terminfo supports it. This

22+ takes the form of a new Style, "italic". Note that most terminfo

23+ descriptors do not report capabilities for italics, so support for

24+ this will be very spotty.

25+ - Updateed text/string function documentation to indicate that escapes

26+ are not permitted in their inputs.

26527

266285.22

267−----

268−

269−* Added Graphics.Vty.Attributes.Color240.color240CodeToRGB function

270− (thanks Brent Carmer)

271−* Added nextEventNonblocking function (field) to Vty type (#87)

29+ - Added Graphics.Vty.Attributes.Color240.color240CodeToRGB function

30+ (thanks Brent Carmer)

31+ - Added nextEventNonblocking function (field) to Vty type (#87)

27232

273335.21

274−----

275−

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

34+ - Picture and Background now provide Eq instances (thanks Jaro Reinders)

35+ - #145: vty builds with microlens 0.4.9 (thanks Daniel Wagner)

36+ - #142: note requirement of threaded RTS

27937

280385.20

281−----

282−

28339API changes:

284−* Split up Monoid instances into Monoid and Semigroup for newer GHCs

285− (thanks Ryan Scott)

40+ - Split up Monoid instances into Monoid and Semigroup for newer GHCs

41+ (thanks Ryan Scott)

28642

287435.19.1

288−------

289−

29044API changes:

291−* Cursor now provides an Eq instance (thanks Jaro Reinders)

45+ * Cursor now provides an Eq instance (thanks Jaro Reinders)

29246

293475.19

294−----

295−

29648API changes:

297−* URL hyperlinking (via 'withURL') is now optional and disabled by

298− default due to poor support on some common terminals. A new 'Mode'

299− constructor, 'Hyperlink', has been added to enable this feature. To

300− change the hyperlinking mode, use 'setMode' on the 'outputIface' of a

301− Vty handle.

49+ - URL hyperlinking (via 'withURL') is now optional and disabled by

50+ default due to poor support on some common terminals. A new 'Mode'

51+ constructor, 'Hyperlink', has been added to enable this feature. To

52+ change the hyperlinking mode, use 'setMode' on the 'outputIface' of a

53+ Vty handle.

30254

303555.18.1

304−------

305−

30656Bug fixes:

307−* Reset the hyperlink state on line endings to avoid run-on hyperlinks

57+ - Reset the hyperlink state on line endings to avoid run-on hyperlinks

30858

309595.18

310−----

311−

31260API changes:

313−* Added support for hyperlinking attributes (thanks Getty Ritter). This

314− change adds a new Attr field for containing the hyperlink to apply,

315− as per https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda

61+ - Added support for hyperlinking attributes (thanks Getty Ritter). This

62+ change adds a new Attr field for containing the hyperlink to apply,

63+ as per https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda

31664

317655.17.1

318−------

319−

320−* withStyle now ignores zero arguments, leaving attribute styles

321− untouched if the input style is the null style

66+ - withStyle now ignores zero arguments, leaving attribute styles

67+ untouched if the input style is the null style

32268

323695.17

324−----

325−

32670API changes:

327−* Add support for terminal focus events. This change adds a new mode

328− usable with setMode, Focus, that requests that the terminal send

329− events on focus lose/gain. This change also adds two new Event

330− constructors, EvLostFocus and EvGainedFocus.

331−* No longer enable UTF8 mouse event encoding. This encoding was not

332− working properly with Terminal.app, and using the other modes (SGR,

333− etc.) work.

334−* Graphics.Vty.Attributes: escape backticks in Haddock comment (fixes

335− #131)

71+ - Add support for terminal focus events. This change adds a new mode

72+ usable with setMode, Focus, that requests that the terminal send

73+ events on focus lose/gain. This change also adds two new Event

74+ constructors, EvLostFocus and EvGainedFocus.

75+ - No longer enable UTF8 mouse event encoding. This encoding was not

76+ working properly with Terminal.app, and using the other modes (SGR,

77+ etc.) work.

78+ - Graphics.Vty.Attributes: escape backticks in Haddock comment (fixes

79+ #131)

33680

337815.16

338−----

339−

34082API changes:

341−* Added support for mouse wheel events while in mouse mode. The Button

342− type got two new constructors as a result: BScrollUp and BScrollDown.

343− Thanks to doublescale@tutanota.com for this contribution!

83+ - Added support for mouse wheel events while in mouse mode. The Button

84+ type got two new constructors as a result: BScrollUp and BScrollDown.

85+ Thanks to doublescale@tutanota.com for this contribution!

34486

34587Bug fixes:

346−* charFill now clamps negative arguments to zero (thanks Eric Mertens!)

88+ - charFill now clamps negative arguments to zero (thanks Eric

89+ Mertens!)

34790

348915.15.1

349−------

350−

35192Package changes:

352−* Documentation files are now marked accordingly (thanks Michal

353− Suchánek)

93+ - Documentation files are now marked accordingly (thanks Michal

94+ Suchánek)

35495

35596Bug fixes:

356−* translateX/Y: fix negative translations

97+ - translateX/Y: fix negative translations

35798

358995.15

359−----

360−

361100Package changes:

362−* Discontinued support for GHC versions prior to 7.10.1.

363−* Removed instructions and configuration for Stack builds since they

364− are no longer supported.

365−* Clarified README mention of (lack of) Windows support (contributors

366− wanted, though!)

367−* Removed dependency on data-default (see below).

101+ - Discontinued support for GHC versions prior to 7.10.1.

102+ - Removed instructions and configuration for Stack builds since they

103+ are no longer supported.

104+ - Clarified README mention of (lack of) Windows support (contributors

105+ wanted, though!)

106+ - Removed dependency on data-default (see below).

368107

369108API changes:

370−* Moved color definitions from Attributes to Color module.

371−* In lieu of data-default (Default) instances for Attr and Config, use

372− 'defAttr' and the new 'defaultConfig' (or 'mempty') instead of 'def'.

373−* Graphics.Vty.Output no longer re-exports

374− Graphics.Vty.Output.Interface.

375−* Removed Graphics.Vty.Prelude module and moved DisplayRegion and its

376− accessors to Graphics.Vty.Image.

377−* Graphics.Vty.Image no longer re-exports Graphics.Vty.Attributes.

378−* Graphics.Vty.Picture no longer re-exports Graphics.Vty.Image.

109+ - Moved color definitions from Attributes to Color module.

110+ - In lieu of data-default (Default) instances for Attr and Config, use

111+ 'defAttr' and the new 'defaultConfig' (or 'mempty') instead of 'def'.

112+ - Graphics.Vty.Output no longer re-exports

113+ Graphics.Vty.Output.Interface.

114+ - Removed Graphics.Vty.Prelude module and moved DisplayRegion and its

115+ accessors to Graphics.Vty.Image.

116+ - Graphics.Vty.Image no longer re-exports Graphics.Vty.Attributes.

117+ - Graphics.Vty.Picture no longer re-exports Graphics.Vty.Image.

379118

3801195.14

381−----

382−

383−* addMaybeClippedJoin: instead of raising an exception when the join

384− is totally clipped, just reduce the clip amount and continue

385−* addMaybeClipped: skip blit of joins when their primary dimension is

386− zero

387−* 'string' and related text functions no longer treat an empty string

388− as an empty image (thanks Chris Penner). This means that now it is

389− possible to use 'str ""' as a non-empty image with height 1.

120+ - addMaybeClippedJoin: instead of raising an exception when the join

121+ is totally clipped, just reduce the clip amount and continue

122+ - addMaybeClipped: skip blit of joins when their primary dimension is

123+ zero

124+ - 'string' and related text functions no longer treat an empty string

125+ as an empty image (thanks Chris Penner). This means that now it is

126+ possible to use 'str ""' as a non-empty image with height 1.

390127

3911285.13

392−----

393−

394−* Reverted changes in 5.12 due to disagreements between terminal

395− emulators and utf8proc; for more details, please see the ticket

396− discussion at

397− https://github.com/coreyoconnor/vty/issues/115

129+ - Reverted changes in 5.12 due to disagreements between terminal

130+ emulators and utf8proc; for more details, please see the ticket

131+ discussion at

132+ https://github.com/coreyoconnor/vty/issues/115

398133

3991345.12

400−----

401−

402−* Replaced 'wcwidth' with a call to the utf8proc library's character

403− width function, which is much more up to date (by several Unicode

404− versions) and returns the right width for a much larger set of

405− characters.

406−* Added a bundled version of the utf8proc C library.

135+ - Replaced 'wcwidth' with a call to the utf8proc library's character

136+ width function, which is much more up to date (by several Unicode

137+ versions) and returns the right width for a much larger set of

138+ characters.

139+ - Added a bundled version of the utf8proc C library.

407140

4081415.11.3

409−------

410−

411−* Fix mouse event offsets in mouse-up events

142+ - Fix mouse event offsets in mouse-up events

412143

4131445.11.2

414−------

415−

416−* Mouse events were modified so that the upper-left corner of the window

417− is (0,0) rather than (1,1).

145+ - Mouse events were modified so that the upper-left corner of the

146+ window is (0,0) rather than (1,1).

418147

4191485.11.1

420−------

421−

422−* Add Generic instance for Image

423−* nextEvent: stop trying to refresh on a resize event (fixes segfault

424− on refresh with normal cursor positioning mode)

425−* Remove redundant clause from clipForCharWidth (thanks Eric Mertens)

426−* Update maintainer

149+ - Add Generic instance for Image

150+ - nextEvent: stop trying to refresh on a resize event (fixes segfault

151+ on refresh with normal cursor positioning mode)

152+ - Remove redundant clause from clipForCharWidth (thanks Eric Mertens)

153+ - Update maintainer

427154

4281555.11

429−----

430−

431−* Vty now raises a VtyConfigurationError exception when the TERM

432− evironment variable is missing (thanks Eric Mertens)

433−* Graphics.Vty.Config got an explicit export list to avoid accidentally

434− exporting internal types (thanks Eric Mertens)

156+ - Vty now raises a VtyConfigurationError exception when the TERM

157+ evironment variable is missing (thanks Eric Mertens)

158+ - Graphics.Vty.Config got an explicit export list to avoid accidentally

159+ exporting internal types (thanks Eric Mertens)

435160

4361615.10

437−----

438−

439−* Add absolute cursor positioning mode AbsoluteCursor to Cursor. This

440− mode provides greater control over cursor positioning by bypassing

441− the logical positioning provided by default. Rather than positioning

442− the cursor by looking at the widths of characters involved, this

443− constructor lets you provide a physical row and column instead. This

444− is useful in more sophisticated programs. (thanks Eric Mertens)

445−* Added a new Generic-derived config parser (thanks Eric Mertens)

446−* Fixed the MShift case in the configuration file parser (thanks Eric

447− Mertens)

448−* Fixed wcwidth import and matched safeWcswidth to its documented

449− behavior. Previously vty_mk_wcwidth was being imported with the

450− wrong type causing the -1 return value to be mapped to the wrong Int

451− value. Additionally safeWcswidth was using the unsafe character width

452− function and only ensuring that the final result was non-negative.

453− (thanks Eric Mertens)

162+ - Add absolute cursor positioning mode AbsoluteCursor to Cursor. This

163+ mode provides greater control over cursor positioning by bypassing

164+ the logical positioning provided by default. Rather than positioning

165+ the cursor by looking at the widths of characters involved, this

166+ constructor lets you provide a physical row and column instead. This

167+ is useful in more sophisticated programs. (thanks Eric Mertens)

168+ - Added a new Generic-derived config parser (thanks Eric Mertens)

169+ - Fixed the MShift case in the configuration file parser (thanks Eric

170+ Mertens)

171+ - Fixed wcwidth import and matched safeWcswidth to its documented

172+ behavior. Previously vty_mk_wcwidth was being imported with

173+ the wrong type causing the -1 return value to be mapped to the

174+ wrong Int value. Additionally safeWcswidth was using the unsafe

175+ character width function and only ensuring that the final result was

176+ non-negative. (thanks Eric Mertens)

454177

4551785.9.1

456−-----

457−

458−* Vty now only emits UTF8 charset sequences in terminals without a

459− preexisting UTF8 declaration to avoid emitting garbage sequences

460− (fixes #89)

179+ - Vty now only emits UTF8 charset sequences in terminals without a

180+ preexisting UTF8 declaration to avoid emitting garbage sequences

181+ (fixes #89)

461182

4621835.9

463−---

464−

465−* Added new Output methods supportsBell and ringTerminalBell to find out

466− whether the output device has an audio bell and to ring it (see #102)

184+ - Added new Output methods supportsBell and ringTerminalBell to find

185+ out whether the output device has an audio bell and to ring it (see

186+ #102)

467187

4681885.8.1

469−-----

470−

471−* Fixed "refresh" to work as advertised (see #104)

189+ - Fixed "refresh" to work as advertised (see #104)

472190

4731915.8

474−---

475−

476−* API change: EvPaste input event now provides paste data as a raw

477− ByteString rather than a String to allow the application to decode how

478− best to decode it

192+ - API change: EvPaste input event now provides paste data as a raw

193+ ByteString rather than a String to allow the application to decode

194+ how best to decode it

479195

4801965.7.1

481−-----

482−

483−* ModeDemo: added an explicit Control.Applicative import for older GHCs

197+ - ModeDemo: added an explicit Control.Applicative import for older

198+ GHCs

484199

4852005.7

486−---

487−

488−* Mouse and paste modes are now off by default.

489−* The Config type got new fields: mouseMode and bracketedPasteMode.

490− These determine whether these modes are enabled initially (for

491− terminals that support them).

492−* Added a Mode type for modal terminal features (mouse events,

493− bracketed paste mode) that is used with new Output interface

494− functions:

495− * supportsMode :: Mode -> Bool tells whether the device supports a

496− mode

497− * setMode :: Mode -> Bool -> IO () turns a mode on or off

498− * getModeStatus :: Mode -> IO Bool tells you whether a mode is on or

499− off

500−* Added a new demo program, ModeDemo.hs, to demonstrate usage of modes

201+ - Mouse and paste modes are now off by default.

202+ - The Config type got new fields: mouseMode and bracketedPasteMode.

203+ These determine whether these modes are enabled initially (for

204+ terminals that support them).

205+ - Added a Mode type for modal terminal features (mouse events,

206+ bracketed paste mode) that is used with new Output interface

207+ functions:

208+ * supportsMode :: Mode -> Bool tells whether the device supports a

209+ mode

210+ * setMode :: Mode -> Bool -> IO () turns a mode on or off

211+ * getModeStatus :: Mode -> IO Bool tells you whether a mode is on or

212+ off

213+ - Added a new demo program, ModeDemo.hs, to demonstrate usage of modes

501214

5022155.6

503−---

504−

505−* Added support for normal and extended mouse modes in Xterm-like

506− terminals via the MouseDown and MouseUp Event constructors

507−* Added support for bracketed paste mode in Xterm-like terminals via

508− the EvPaste event constructor

509−* Added derived Show instances for Event and Button (thanks Felix

510− Hirn)

511−* Now TERM values containing "screen" will automatically use the

512− XtermColor driver rather than just TerminfoBased

216+ - Added support for normal and extended mouse modes in Xterm-like

217+ terminals via the MouseDown and MouseUp Event constructors

218+ - Added support for bracketed paste mode in Xterm-like terminals via

219+ the EvPaste event constructor

220+ - Added derived Show instances for Event and Button (thanks Felix

221+ Hirn)

222+ - Now TERM values containing "screen" will automatically use the

223+ XtermColor driver rather than just TerminfoBased

513224

5142255.5.0

515−-----

516−

517−* Replaced lens dependency with microlens, microlens-mtl, microlens-th

518− dependencies. Issue #90

519− * Thanks Jonathan Daugherty

520−* Cabal corrections.

521− * Thanks Lennart Spitzner

226+ - Replaced lens dependency with microlens, microlens-mtl, microlens-th

227+ dependencies. Issue #90

228+ - Thanks Jonathan Daugherty

229+ - Cabal corrections.

230+ - Thanks Lennart Spitzner

522231

5232325.4.0

524−-----

525−

526−* Changed eventChannel of Graphics.Vty.Input from Chan to

527− TChan. This enables clients to query if there are no pending

528− events. The Graphics.Vty interface nextEvent is unchanged.

529− Clients that use eventChannel directly will require updating.

530− https://github.com/coreyoconnor/vty/issues/60

531−

233+ - Changed eventChannel of Graphics.Vty.Input from Chan to TChan.

234+ This enables clients to query if there are no pending events. The

235+ Graphics.Vty interface nextEvent is unchanged. Clients that use

236+ eventChannel directly will require updating.

237+ https://github.com/coreyoconnor/vty/issues/60

5322385.3.1

533−-----

534−

535−* Reverted cabal file to depend on Cabal >= 1.18 instead of 1.20 due to

536− possibly breaking this on reasonable GHC versions

239+ - Reverted cabal file to depend on Cabal >= 1.18 instead of 1.20 due

240+ to possibly breaking this on reasonable GHC versions

537241

5382425.3

539−---

540−

541−* Upgraded QuickCheck dependency to 2.7

542−* The standard IO Config (standardIOConfig) was overriding any provided

543− application config. In addition, the inputFd and outputFd could not be

544− changed if mkVty was used. Fixed.

545−* Correct handling of display attributes at end of line. The output

546− attributes are set to default at the end of content for the line and

547− at the start of a new line. Previously the current attribute would

548− extend to the next start of content. This was odd to reason about and

549− was the cause of https://github.com/coreyoconnor/vty/issues/76 IIRC Yi

550− requires the old behavior to display the selection region correctly.

551−* shutdown of the input thread is now performed using killThread and

552− synchronization on an MVar. For correct handling of the terminal read

553− vmin and vtime the read must be a blocking read on an OS thread.

554− This places a threadWaitRead, which will be interrupted by the

555− killThread, prior to the uninterruptable read. An alternative would be

556− to re-import the read foreign call as interruptable.

243+ - Upgraded QuickCheck dependency to 2.7

244+ - The standard IO Config (standardIOConfig) was overriding any

245+ provided application config. In addition, the inputFd and outputFd

246+ could not be changed if mkVty was used. Fixed.

247+ - Correct handling of display attributes at end of line. The output

248+ attributes are set to default at the end of content for the line and

249+ at the start of a new line. Previously the current attribute would

250+ extend to the next start of content. This was odd to reason about

251+ and was the cause of https://github.com/coreyoconnor/vty/issues/76

252+ IIRC Yi requires the old behavior to display the selection region

253+ correctly.

254+ - shutdown of the input thread is now performed using killThread and

255+ synchronization on an MVar. For correct handling of the terminal

256+ read vmin and vtime the read must be a blocking read on an OS

257+ thread. This places a threadWaitRead, which will be interrupted by

258+ the killThread, prior to the uninterruptable read. An alternative

259+ would be to re-import the read foreign call as interruptable.

557260

5582615.2.11

559−------

560−

561−* deepseq bounds increased for tests.

562−* Clean up warnings when compiling on 7.10

563− * Thanks Eric Mertens

564−* Avoid discarding input bytes after multi-byte encoded codepoint

565− * Thanks Eric Mertens

262+ - deepseq bounds increased for tests.

263+ - Clean up warnings when compiling on 7.10

264+ - Thanks Eric Mertens

265+ - Avoid discarding input bytes after multi-byte encoded codepoint

266+ - Thanks Eric Mertens

566267

5672685.2.10

568−------

569−

570−* "str" now returns EmptyImage for empty strings to match behavior of

571− other string-like Image constructors (fixes #74)

572− * Thanks Jonathan Daugherty

269+ - "str" now returns EmptyImage for empty strings to match behavior of

270+ other string-like Image constructors (fixes #74)

271+ - Thanks Jonathan Daugherty

573272

5742735.2.9

575−-----

576−

577−* dependency version bumps

578− * https://github.com/coreyoconnor/vty/pull/71

579− * https://github.com/coreyoconnor/vty/pull/70

580−* Correct/Simplify the example code

581− * Thanks glguy

582− * https://github.com/coreyoconnor/vty/pull/69

274+ - dependency version bumps

275+ - https://github.com/coreyoconnor/vty/pull/71

276+ - https://github.com/coreyoconnor/vty/pull/70

277+ - Correct/Simplify the example code

278+ - Thanks glguy

279+ - https://github.com/coreyoconnor/vty/pull/69

583280

5842815.2.8

585−-----

586−

587−* blaze-builder, lens, utf8-string version constraint bump

588− * Thanks glguy

589− * https://github.com/coreyoconnor/vty/pull/67

590−* Do not differentiate based on TERM_PROGRAM

591− * https://github.com/coreyoconnor/vty/issues/68

282+ - blaze-builder, lens, utf8-string version constraint bump

283+ - Thanks glguy

284+ - https://github.com/coreyoconnor/vty/pull/67

285+ - Do not differentiate based on TERM_PROGRAM

286+ - https://github.com/coreyoconnor/vty/issues/68

592287

5932885.2.7

594−-----

595−

596−* lens and deepseq constraint bump + misc

597− * Thanks ethercrow

598− * https://github.com/coreyoconnor/vty/pull/66

289+ - lens and deepseq constraint bump + misc

290+ - Thanks ethercrow

291+ - https://github.com/coreyoconnor/vty/pull/66

599292

6002935.2.6

601−-----

602−

603−* lens constraint bump

604− * Thanks alexander-b!

605− * https://github.com/coreyoconnor/vty/pull/64

294+ - lens constraint bump

295+ - Thanks alexander-b!

296+ - https://github.com/coreyoconnor/vty/pull/64

606297

6072985.2.5

608−-----

609−

610−* lens and random version constraint bump.

611− * Thanks RyanGlScott!

612− * https://github.com/coreyoconnor/vty/pull/62

299+ - lens and random version constraint bump.

300+ - Thanks RyanGlScott!

301+ - https://github.com/coreyoconnor/vty/pull/62

613302

6143035.2.4

615−-----

616−

617−* removed -fpic from cc-options. No longer required.

618− * https://github.com/coreyoconnor/vty/issues/61

619− * https://ghc.haskell.org/trac/ghc/ticket/9657

620− * Thanks Fuuzetsu!

304+ - removed -fpic from cc-options. No longer required.

305+ - https://github.com/coreyoconnor/vty/issues/61

306+ - https://ghc.haskell.org/trac/ghc/ticket/9657

307+ - Thanks Fuuzetsu!

621308

6223095.2.3

623−-----

624−

625−* evaluate/compile the input parsing table once instead of each

626− keystroke.

627− * https://github.com/coreyoconnor/vty/pull/59

628− * Thanks ethercrow!

310+ - evaluate/compile the input parsing table once instead of each

311+ keystroke.

312+ - https://github.com/coreyoconnor/vty/pull/59

313+ - Thanks ethercrow!

629314

6303155.2.2

631−-----

632−

633−* When looking at input for an event, don't look too deep.

634− * https://github.com/coreyoconnor/vty/pull/57

635− * Thanks ethercrow!

316+ - When looking at input for an event, don't look too deep.

317+ - https://github.com/coreyoconnor/vty/pull/57

318+ - Thanks ethercrow!

636319

6373205.2.1

638−-----

639−

640−* Bump upper version bound for lens to 4.5. Thanks markus1189!

321+ - Bump upper version bound for lens to 4.5. Thanks markus1189!

641322

6423235.2.0

643−-----

644−

645−* Config structure now specifies file descriptor to use. The default

646− is stdInput and stdOutput file descriptors. Previously Vty used

647− stdInput for input and the follow code for output:

648− * hDuplicate stdout >>= handleToFd >>= (`hSetBuffering`

649− NoBuffering)

650− * the difference was required by Vty.Inline. Now, Vty.Inline uses

651− the Config structure options to acheive the same effect.

652−* removed: derivedVtime, derivedVmin, inputForCurrentTerminal,

653− inputForNameAndIO, outputForCurrentTerminal, outputForNameAndIO

654−* added: inputForConfig, outputForConfig

655−* updates to vty-rogue from jtdaugherty. Thanks!

656−* the oldest version of GHC tested to support vty is 7.6.2.

657−* the oldest version of GHC that vty compiles under is 7.4.2

324+ - Config structure now specifies file descriptor to use. The default

325+ is stdInput and stdOutput file descriptors. Previously Vty used

326+ stdInput for input and the follow code for output:

327+ - hDuplicate stdout >>= handleToFd >>= (`hSetBuffering`

328+ NoBuffering)

329+ - the difference was required by Vty.Inline. Now, Vty.Inline uses

330+ the Config structure options to acheive the same effect.

331+ - removed: derivedVtime, derivedVmin, inputForCurrentTerminal,

332+ inputForNameAndIO, outputForCurrentTerminal, outputForNameAndIO

333+ - added: inputForConfig, outputForConfig

334+ - updates to vty-rogue from jtdaugherty. Thanks!

335+ - the oldest version of GHC tested to support vty is 7.6.2.

336+ - the oldest version of GHC that vty compiles under is 7.4.2

658337

6593385.1.4

660−-----

661−

662−* merged https://github.com/coreyoconnor/vty/pull/51 thanks trofi!

339+ - merged https://github.com/coreyoconnor/vty/pull/51 thanks trofi!

663340

6643415.1.1

665−-----

666−

667−* merged https://github.com/coreyoconnor/vty/pull/48 thanks sjmielke!

668−* jtdaugherty resolved a number of compiler warnings. Thanks!

342+ - merged https://github.com/coreyoconnor/vty/pull/48 thanks sjmielke!

343+ - jtdaugherty resolved a number of compiler warnings. Thanks!

669344

6703455.1.0

671−-----

672−

673−* vmin and vtime can be specified however the application requires.

674− See Graphics.Vty.Config.

675−* fixed the processing of input when vmin is set > 1.

346+ - vmin and vtime can be specified however the application requires.

347+ See Graphics.Vty.Config.

348+ - fixed the processing of input when vmin is set > 1.

676349

6773505.0.0

678−-----

679−

680−* The naming convention now matches:

681− * http://www.haskell.org/haskellwiki/Programming_guidelines#Naming_Conventions

682−* all projects using vty for input must be compiled with -threaded.

683− Please notify vty author if this is not acceptable.

684−* mkVtyEscDelay has been removed. Use "mkVty def". Which initialized

685− vty with the default configuration.

686−* input handling changes

687− * KASCII is now KChar

688− * KPN5 is now KCenter

689− * tests exist.

690− * Applications can add to the input tables by setting inputMap of

691− the Config. See Graphics.Vty.Config

692− * Users can define input table extensions that will apply to all vty

693− applications. See Graphics.Vty.Config

694− * terminal timing is now handled by selecting an appropriate VTIME.

695− Previously this was implemented within Vty itself. This reduced

696− complexity in vty but provides a different meta key behavior and

697− implies a requirement on -threaded.

698− * The time vty will wait to verify an ESC byte means a single ESC

699− key is the singleEscPeriod of the Input Config structure.

700−* removed the typeclass based terminal and display context interface

701− in favor of a data structure of properties interface.

702−* renamed the Terminal interface to Output

703−* The default picture for an image now uses the "clear" background.

704− This background fills background spans with spaces or just ends the

705− line.

706− * Previously the background defaulted to the space character. This

707− causes issues copying text from a text editor. The text would end

708− up with extra spaces at the end of the line.

709−* Layer support

710− * Each layer is an image.

711− * The layers for a picture are a list of images.

712− * The first image is the top-most layer. The images are ordered from

713− top to bottom.

714− * The transparent areas for a layer are the backgroundFill areas.

715− backgroundFill is added to pad images when images of different

716− sizes are joined.

717− * If the background is clear there is no background layer.

718− * If there is a background character then the bottom layer is the

719− background layer.

720− * emptyPicture is a Picture with no layers and no cursor

721− * addToTop and addToBottom add a layer to the top and bottom of the

722− given Picture.

723−* compatibility improvements:

724− * terminfo based terminals with no cursor support are silently

725− accepted. The cursor visibility changes in the Picture will have

726− no effect.

727− * alternate (setf/setb) color maps supported. Though colors beyond

728− the first 8 are just a guess.

729− * added "rgbColor" for easy support of RGB specified colors.

730− * Both applications and users can add to the mapping used to

731− translate from input bytes to events.

732−* Additional information about input and output process can be

733− appended to a debug log

734− * Set environment variable VTY_DEBUG_LOG to path of debug log

735− * Or use "debugLog <path>" config directive

736− * Or set 'debugLog' property of the Config provided to mkVty.

737−* examples moved to vty-examples package. See test directory for cabal

738− file.

739− * vty-interactive-terminal-test

740− * interactive test. Useful for building a bug report for vty's

741− author.

742− * test/interactive_terminal_test.hs

743− * vty-event-echo

744− * view a input event log for vty. Example of interacting with

745− user.

746− * test/EventEcho.hs

747− * vty-rogue

748− * The start of a rogue-like game. Example of layers and image

749− build operations.

750− * test/Rogue.hs

751− * vty-benchmark

752− * benchmarks vty. A series of tests that push random pictures to

753− the terminal. The random pictures are generated using

754− QuickCheck. The same generators used in the automated tests.

755− * test/benchmark.hs

351+ - The naming convention now matches:

352+ - http://www.haskell.org/haskellwiki/Programming_guidelines#Naming_Conventions

353+ - all projects using vty for input must be compiled with -threaded.

354+ Please notify vty author if this is not acceptable.

355+ - mkVtyEscDelay has been removed. Use "mkVty def". Which initialized

356+ vty with the default configuration.

357+ - input handling changes

358+ - KASCII is now KChar

359+ - KPN5 is now KCenter

360+ - tests exist.

361+ - Applications can add to the input tables by setting inputMap of

362+ the Config. See Graphics.Vty.Config

363+ - Users can define input table extensions that will apply to all vty

364+ applications. See Graphics.Vty.Config

365+ - terminal timing is now handled by selecting an appropriate VTIME.

366+ Previously this was implemented within Vty itself. This reduced

367+ complexity in vty but provides a different meta key behavior and

368+ implies a requirement on -threaded.

369+ - The time vty will wait to verify an ESC byte means a single ESC

370+ key is the singleEscPeriod of the Input Config structure.

371+ - removed the typeclass based terminal and display context interface

372+ in favor of a data structure of properties interface.

373+ - renamed the Terminal interface to Output

374+ - The default picture for an image now uses the "clear" background.

375+ This background fills background spans with spaces or just ends the

376+ line.

377+ - Previously the background defaulted to the space character. This

378+ causes issues copying text from a text editor. The text would end

379+ up with extra spaces at the end of the line.

380+ - Layer support

381+ - Each layer is an image.

382+ - The layers for a picture are a list of images.

383+ - The first image is the top-most layer. The images are ordered from

384+ top to bottom.

385+ - The transparent areas for a layer are the backgroundFill areas.

386+ backgroundFill is added to pad images when images of different

387+ sizes are joined.

388+ - If the background is clear there is no background layer.

389+ - If there is a background character then the bottom layer is the

390+ background layer.

391+ - emptyPicture is a Picture with no layers and no cursor

392+ - addToTop and addToBottom add a layer to the top and bottom of the

393+ given Picture.

394+ - compatibility improvements:

395+ - terminfo based terminals with no cursor support are silently

396+ accepted. The cursor visibility changes in the Picture will have

397+ no effect.

398+ - alternate (setf/setb) color maps supported. Though colors beyond

399+ the first 8 are just a guess.

400+ - added "rgbColor" for easy support of RGB specified colors.

401+ - Both applications and users can add to the mapping used to

402+ translate from input bytes to events.

403+ - Additional information about input and output process can be

404+ appended to a debug log

405+ - Set environment variable VTY_DEBUG_LOG to path of debug log

406+ - Or use "debugLog <path>" config directive

407+ - Or set 'debugLog' property of the Config provided to mkVty.

408+ - examples moved to vty-examples package. See test directory for cabal

409+ file.

410+ - vty-interactive-terminal-test

411+ - interactive test. Useful for building a bug report for vty's

412+ author.

413+ - test/interactive_terminal_test.hs

414+ - vty-event-echo

415+ - view a input event log for vty. Example of interacting with

416+ user.

417+ - test/EventEcho.hs

418+ - vty-rogue

419+ - The start of a rogue-like game. Example of layers and image

420+ build operations.

421+ - test/Rogue.hs

422+ - vty-benchmark

423+ - benchmarks vty. A series of tests that push random pictures to

424+ the terminal. The random pictures are generated using

425+ QuickCheck. The same generators used in the automated tests.

426+ - test/benchmark.hs

756427

7574284.7.0.0

758−-------

429+ - API changes:

430+ - Added Graphics.Vty.Image.crop: Ensure an image is no larger

431+ than the specified size.

432+ - Added Graphics.Vty.Image.pad: Ensure an image is no smaller

433+ than the specified size.

434+ - Added Graphics.Vty.Image.translate: Offset an image.

435+ - Thanks Ben Boeckel <MathStuf@gmail.com> for these features.

759436

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.

437+4.3.0.0

767438

7684394.2.1.0

769−-------

770−

771−API changes:

772−* Attr record accessor fore_color changed to attr_fore_color

773−* Attr record accessor back_color changed to attr_back_color

774−* Attr record accessor style changed to attr_style

775−* Added an "inline" display attribute changing DSL:

776− * put_attr_change applies a display attribute change

777− immediately to a terminal

778− * For instance, can be used to change the display attrbiutes

779− of text output via putStrLn and putStr. EX:

780− "put_attr_change $ back_color red" will set the background

781− color to red.

782− * Changes do not apply to a Picture output via output_picture.

783− * See Graphics.Vty.Inline

784−* Moved all IO actions into any monad an instance of MonadIO

440+ - API changes:

441+ - Attr record accessor fore_color changed to attr_fore_color

442+ - Attr record accessor back_color changed to attr_back_color

443+ - Attr record accessor style changed to attr_style

444+ - Added an "inline" display attribute changing DSL:

445+ - put_attr_change applies a display attribute change

446+ immediately to a terminal

447+ - For instance, can be used to change the display attrbiutes

448+ of text output via putStrLn and putStr. EX:

449+ "put_attr_change $ back_color red" will set the background

450+ color to red.

451+ - Changes do not apply to a Picture output via output_picture.

452+ - See Graphics.Vty.Inline

453+ - Moved all IO actions into any monad an instance of MonadIO

785454

7864554.0.0.1

787−-------

788−

789−* binding for mk_wcswidth was incorrect. Most platforms just

790− magically worked due to coincidence.

456+ - binding for mk_wcswidth was incorrect. Most platforms just

457+ magically worked due to coincidence.

791458

7924594.0.0

793−-----

794−

795−API changes:

796−* "getSize" has been removed. Use "terminal vty >>= display_bounds"

797− where "vty" is an instance of the Vty data structure.

798−* added a "terminal" field to the Vty data structure. Accesses the

799− TerminalHandle associated with the Vty instance.

800−* Graphics.Vty.Types has undergone a number of changes. Summary:

801− * Partitioned into Graphics.Vty.Attributes for display attributes.

802− Graphics.Vty.Image for image combinators. Graphics.Vty.Picture

803− for final picture construction.

804−* Graphics.Vty.Attributes:

805− * "setFG" and "setBG" are now "with_fore_color" and

806− "with_back_color"

807− * All other "set.." equations similarly replaced.

808− * "attr" is now "def_attr", short for "default display attributes"

809− Also added a "current_attr" for "currently applied display

810− attributes"

811−* Graphics.Vty.Image:

812− * "horzcat" is now "horiz_cat"

813− * "vertcat" is now "vert_cat"

814− * "renderBS" is now "utf8_bytestring"

815− * "renderChar" is now "char"

816− * "renderFill" is now "char_fill"

817− * added a "utf8_string" and "string" (AKA "iso_10464_string") for

818− UTF-8 encoded Strings and ISO-10464 encoded Strings. String

819− literals in GHC have an ISO-10464 runtime representation.

820−* Graphics.Vty.Picture:

821− * exports Graphics.Vty.Image

822− * "pic" is now "pic_for_image"

823− * added API for setting background fill pattern.

824−* Completely rewritten output backend.

825− * Efficient, scanline style output span generator. Has not been

826− fully optimized, but good enough.

827− * The details required to display the desired picture on a

828− terminal are well encapsulated.

829− * Terminfo based display terminal implementation. With specialized

830− derivitives for xterm, Terminal.app, and iTerm.app.

831− * Attempts to robustly handle even terminals that don't

832− support all display attributes.

833− * I've tested the following terminals with success: iTerm.app,

834− Terminal.app, xterm, rxvt, mlterm, Eterm, gnome-terminal,

835− konsole, screen, linux vty. Hopefully you will be as

836− successfull.

837− * Improved unicode support. Double wide characters will display as

838− expected.

839−* 256 color support. See Graphics.Vty.Attributes.Color240. The actual

840− output color is adjusted according to the number of colors the

841− terminal supports.

842−* The Graphics.Vty.Image combinators no longer require matching

843− dimensions to arguments. Unspecified areas are filled in with a

844− user-customizable background pattern. See Graphics.Vty.Picture.

845−* output images are always cropped to display size.

846−* Significant code coverage by QuickCheck tests. An interactive test

847− for those final properties that couldn't be automatically verified.

460+ - API changes:

461+ - "getSize" has been removed. Use "terminal vty >>= display_bounds"

462+ where "vty" is an instance of the Vty data structure.

463+ - added a "terminal" field to the Vty data structure. Accesses the

464+ TerminalHandle associated with the Vty instance.

465+ - Graphics.Vty.Types has undergone a number of changes. Summary:

466+ - Partitioned into Graphics.Vty.Attributes for display attributes.

467+ Graphics.Vty.Image for image combinators. Graphics.Vty.Picture

468+ for final picture construction.

469+ - Graphics.Vty.Attributes:

470+ - "setFG" and "setBG" are now "with_fore_color" and

471+ "with_back_color"

472+ - All other "set.." equations similarly replaced.

473+ - "attr" is now "def_attr", short for "default display attributes"

474+ Also added a "current_attr" for "currently applied display

475+ attributes"

476+ - Graphics.Vty.Image:

477+ - "horzcat" is now "horiz_cat"

478+ - "vertcat" is now "vert_cat"

479+ - "renderBS" is now "utf8_bytestring"

480+ - "renderChar" is now "char"

481+ - "renderFill" is now "char_fill"

482+ - added a "utf8_string" and "string" (AKA "iso_10464_string") for

483+ UTF-8 encoded Strings and ISO-10464 encoded Strings. String

484+ literals in GHC have an ISO-10464 runtime representation.

485+ - Graphics.Vty.Picture:

486+ - exports Graphics.Vty.Image

487+ - "pic" is now "pic_for_image"

488+ - added API for setting background fill pattern.

489+ - Completely rewritten output backend.

490+ - Efficient, scanline style output span generator. Has not been

491+ fully optimized, but good enough.

492+ - The details required to display the desired picture on a

493+ terminal are well encapsulated.

494+ - Terminfo based display terminal implementation. With specialized

495+ derivitives for xterm, Terminal.app, and iTerm.app.

496+ - Attempts to robustly handle even terminals that don't

497+ support all display attributes.

498+ - I've tested the following terminals with success: iTerm.app,

499+ Terminal.app, xterm, rxvt, mlterm, Eterm, gnome-terminal,

500+ konsole, screen, linux vty. Hopefully you will be as

501+ successfull.

502+ - Improved unicode support. Double wide characters will display as

503+ expected.

504+ - 256 color support. See Graphics.Vty.Attributes.Color240. The actual

505+ output color is adjusted according to the number of colors the

506+ terminal supports.

507+ - The Graphics.Vty.Image combinators no longer require matching

508+ dimensions to arguments. Unspecified areas are filled in with a

509+ user-customizable background pattern. See Graphics.Vty.Picture.

510+ - output images are always cropped to display size.

511+ - Significant code coverage by QuickCheck tests. An interactive test

512+ for those final properties that couldn't be automatically verified.

848513

849514Issues resolved:

850−* "gnome terminal displays non-basic attributes as strikethrough"

851− * http://trac.haskell.org/vty/ticket/14

852−* "Multi-byte characters are not displayed correctly on update"

853− * http://trac.haskell.org/vty/ticket/10

854−* "Redraw does not handle rendering a line that extends beyond screen

855− width characters"

856− * http://trac.haskell.org/vty/ticket/13

857−* "The <|> and <-> combinators should be more forgiving of mismatched

858− dimensions"

859− * http://trac.haskell.org/vty/ticket/9

860−* "256-color support"

861− * http://trac.haskell.org/vty/ticket/19

515+ - "gnome terminal displays non-basic attributes as strikethrough"

516+ - http://trac.haskell.org/vty/ticket/14

517+ - "Multi-byte characters are not displayed correctly on update"

518+ - http://trac.haskell.org/vty/ticket/10

519+ - "Redraw does not handle rendering a line that extends beyond screen

520+ width characters"

521+ - http://trac.haskell.org/vty/ticket/13

522+ - "The <|> and <-> combinators should be more forgiving of mismatched

523+ dimensions"

524+ - http://trac.haskell.org/vty/ticket/9

525+ - "256-color support"

526+ - http://trac.haskell.org/vty/ticket/19

LICENSE−2

@@ -1,5 +1,3 @@

1−BSD 3-Clause License

2−

31Copyright Stefan O'Rear 2006, Corey O'Connor 2008, Corey O'Connor 2009

53All rights reserved.

README.md+53−103

@@ -18,21 +18,24 @@ cabal install vty

1818

1919# Features

2020

21−* Supports a large number of terminals, i.e., vt100, ansi, hurd, linux,

22− `screen`, etc., or anything with a sufficient terminfo entry.

21+* Supports a large number of terminals. vt100, ansi, hurd, linux,

22+ screen, etc., or anything with a sufficient terminfo entry.

2323

24−* Automatically handles window resizes.

24+* Automatic handling of window resizes.

2525

26−* Supports Unicode output on terminals with UTF-8 support.

26+* Unicode output on terminals with UTF-8 support.

2727

28−* Provides an efficient output algorithm. Output buffering and terminal

29− state changes are minimized.

28+* Handles multi-column glyphs. (Requires user to properly configure

29+ terminal.)

30+

31+* Efficient output. Output buffering and terminal state changes are

32+ minimized.

3033

3134* Minimizes repaint area, which virtually eliminates the flicker

3235 problems that plague ncurses programs.

3336

34−* Provides a pure, compositional interface for efficiently constructing

35− display images.

37+* A pure, compositional interface for efficiently constructing display

38+ images.

3639

3740* Automatically decodes keyboard keys into (key,[modifier]) tuples.

3841

@@ -41,7 +44,7 @@ cabal install vty

4144* Supports a keypress timeout after for lone ESC. The timeout is

4245 customizable.

4346

44−* Provides extensible input and output interfaces.

47+* The interface is designed for easy extension.

4548

4649* Supports ANSI graphics modes (SGR as defined in `console_codes(4)`)

4750 with a type-safe interface and graceful fallback for terminals

@@ -57,12 +60,6 @@ cabal install vty

5760* Supports bracketed paste mode as described at

5861 http://cirw.in/blog/bracketed-paste

5962

60−* Supports multi-column Unicode characters such as emoji characters. In

61− cases where Vty and your terminal emulator disagree on character

62− widths, Vty provides a tool `vty-build-width-table` and library

63− functionality to build a width table that will work for your terminal

64− and load it on application startup.

65−

6663# Development Notes

6764

6865Vty uses threads internally, so programs made with Vty need to be

@@ -72,91 +69,12 @@ compiled with the threaded runtime using the GHC `-threaded` option.

7269

7370## Posix Terminals

7471

75−For the most part, Vty uses `terminfo` to determine terminal protocol

76−with some special rules to handle some omissions from `terminfo`.

72+Uses terminfo to determine terminal protocol. With some special rules to

73+handle some omissions from terminfo.

7774

7875## Windows

7976

80−Windows is not supported.

81−

82−# Multi-Column Character Support

83−

84−Vty supports rendering of multi-column characters such as two-column

85−Asian characters and Emoji characters. This section details how to

86−take advantage of this feature, since its behavior will depend on the

87−terminal emulator in use.

88−

89−Terminal emulators support Unicode to varying degrees, and each terminal

90−emulator relies on a table of column widths for each supported Unicode

91−character. Vty also needs to rely on such a table to compute the width

92−of Vty images to do image layout. Since those tables can disagree if

93−Vty and the terminal emulator support different versions of Unicode,

94−and since different terminal emulators will support different versions

95−of Unicode, it's likely that for some wide characters, Vty applications

96−will exhibit rendering problems. Those rendering problems arise from Vty

97−and the terminal emulator coming to different conclusions about how wide

98−some characters are.

99−

100−To address this, Vty supports loading custom character width tables

101−that are based on the terminal's behavior in order to eliminate these

102−disagreements. By default, though, Vty will use its built-in Unicode

103−character width table. Since the built-in table is likely to eventually

104−disagree with your terminal, Vty provides an API and a command-line tool

105−to generate and install custom tables.

106−

107−Custom Unicode width tables based on your terminal emulator can be

108−built by running Vty's built-in tool, `vty-build-width-table`. The tool

109−works by querying the current terminal emulator to obtain its width

110−measurements for the entire supported Unicode range. The

111−results are then saved to a disk file. These custom tables

112−can also be generated programmatically by using the API in

113−`Graphics.Vty.UnicodeWidthTable.Query`.

114−

115−Saved width tables can then be loaded in one of two ways:

116−

117−* Via the library API in `Graphics.Vty.UnicodeWidthTable.IO`

118−* By adding a `widthMap` directive to your Vty configuration file and

119− then invoking `mkVty` to initialize Vty

120−

121−The Vty configuration file supports the `widthMap` directive to allow

122−users to specify which custom width table should be loaded for a given

123−terminal type. This is done by specifying, e.g.,

124−

125−```

126−widthMap "xterm" "/path/to/map.dat"

127−```

128−

129−where the first argument is the value that `TERM` must have in order for

130−the table to be loaded, and the second argument is the path to the table

131−file itself as generated by the two alternatives listed above. If the

132−Vty configuration file contains multiple matching `widthMap` directives

133−for the current value of `TERM`, the last one listed in the file is

134−used.

135−

136−The tables declared in the configuration file are only ever

137−automatically loaded when applications set up Vty by calling

138−`Graphics.Vty.mkVty`.

139−

140−Before a custom table has been loaded, calls to the library's character

141−width functions (e.g. `wcwidth`) will use the default built-in table.

142−Once a custom table has been loaded, the functions will use the new

143−custom table. Only one custom table load can be performed in a Vty

144−program. Once a custom table has been loaded, it cannot be replaced or

145−removed.

146−

147−Without using a custom width table, users of Vty-based applications

148−are likely to eventually experience rendering problems with with wide

149−characters. We recommend that developers of Vty-based applications either:

150−

151−* Provide the `vty-build-width-table` tool and documentation for running

152− it and updating the Vty configuration, or

153−* Have the application invoke the Vty library's table-building

154− functionality and load the table at startup without using the Vty

155− configuration.

156−

157−The best option will depend on a number of factors: the user audience,

158−the amount of risk posed by wide character rendering, the terminal

159−emulators in use, etc.

77+Unsupported (but contributions and testing here are very welcome!)

16078

16179# Contributing

16280

@@ -170,13 +88,45 @@ should consider to make submitting patches easier for all concerned:

17088 conventions already used in the codebase.

17189 - Please provide Haddock documentation for any changes you make.

17290

91+# Development Notes

92+

93+## Under NixOS

94+

95+### Using cabal

96+

97+After installing `ncurses` to the user environment:

98+

99+~~~

100+LIBRARY_PATH=$HOME/.nix-profile/lib/ cabal configure --enable-tests --extra-lib-dirs=$HOME/.nix-profile/lib

101+LIBRARY_PATH=$HOME/.nix-profile/lib/ cabal build

102+LIBRARY_PATH=$HOME/.nix-profile/lib/ cabal test

103+~~~

104+

105+## Code Coverage

106+

107+As of last testing, profiling causes issues with coverage when enabled.

108+To evaluate coverage, configure as follows:

109+

110+~~~

111+rm -rf dist ; cabal configure --enable-tests --enable-library-coverage \

112+ --disable-library-profiling \

113+ --disable-executable-profiling

114+~~~

115+

116+## Profiling

117+

118+~~~

119+rm -rf dist ; cabal configure --enable-tests --disable-library-coverage \

120+ --enable-library-profiling \

121+ --enable-executable-profiling

122+~~~

123+

173124# Known Issues

174125

175−* Terminals have numerous quirks and bugs, so mileage may vary. Please

176− report issues as you encounter them and provide details on your

177− terminal emulator, operating system, etc.

126+* Terminals have numerous quirks and bugs. Vty picks what works best for

127+ the author in ambiguous or buggy situations.

178128

179−* STOP, TERM and INT signals are not handled.

129+* Signal handling of STOP, TERM and INT are nonexistent.

180130

181131* The character encoding of the terminal is assumed to be UTF-8 if

182132 unicode is used.

@@ -186,10 +136,10 @@ should consider to make submitting patches easier for all concerned:

186136 (shifted F10 etc). See `Config` for customizing vty's behavior for a

187137 particular terminal.

188138

189−* Vty uses the `TIOCGWINSZ` ioctl to find the current window size, which

139+* Uses the `TIOCGWINSZ` ioctl to find the current window size, which

190140 appears to be limited to Linux and BSD.

191141

192−# Further Reading

142+# Sources

193143

194144Good sources of documentation for terminal programming are:

195145

cbits/get_tty_erase.cdeleted−18

@@ -1,18 +0,0 @@

1−#include <termios.h>

2−#include <stdio.h>

3−#include <unistd.h>

4−#include <stdlib.h>

5−

6−// Given a file descriptor for a terminal, get the ERASE character for

7−// the terminal. If the terminal info cannot be obtained, this returns

8−// zero.

9−char vty_get_tty_erase(int fd)

10−{

11− struct termios trm;

12−

13− if (0 == tcgetattr(fd, &trm)) {

14− return (char) trm.c_cc[VERASE];

15− } else {

16− return (char) 0;

17− }

18−}

cbits/gwinsz.c+5−14

@@ -1,18 +1,9 @@

11#include <sys/ioctl.h>

33unsigned long vty_c_get_window_size(int fd) {

4− struct winsize w;

5− if (ioctl (fd, TIOCGWINSZ, &w) >= 0)

6− return (w.ws_row << 16) + w.ws_col;

7− else

8− return 0x190050;

9−}

10−

11−void vty_c_set_window_size(int fd, unsigned long val) {

12− struct winsize w;

13− if (ioctl(fd, TIOCGWINSZ, &w) >= 0) {

14− w.ws_row = val >> 16;

15− w.ws_col = val & 0xFFFF;

16− ioctl(fd, TIOCSWINSZ, &w);

17− }

4+ struct winsize w;

5+ if (ioctl (fd, TIOCGWINSZ, &w) >= 0)

6+ return (w.ws_row << 16) + w.ws_col;

7+ else

8+ return 0x190050;

189}

cbits/gwinsz.h+1−2

@@ -1,2 +1 @@

1−unsigned long vty_c_get_window_size(int fd);

2−unsigned long vty_c_set_window_size(int fd, unsigned long val);

1+unsigned long vty_c_get_window_size(void);

cbits/mk_wcwidth.c+2−136

@@ -60,28 +60,6 @@

6060 */

6161

6262#include <HsFFI.h>

63−#include <stdlib.h>

64−#include <string.h>

65−

66−// The maximum size for a custom character width table is the total

67−// number of possible characters as dictated by the compiler.

68−#define MAX_CUSTOM_TABLE_SIZE (HS_CHAR_MAX + 1)

69−

70−// The pointer to the start of the custom character width table, if

71−// any. If this is NULL or this is set but the ready flag is false, the

72−// built-in tree search logic is used.

73−static uint8_t* custom_table = NULL;

74−

75−// The size of the custom table, in entries. This should only be set

76−// if custom_table is not NULL. Its value should be the size of the

77−// custom_table array.

78−static uint32_t custom_table_size = 0;

79−

80−// A flag indicating whether the custom table is ready for

81−// use. This should only be set once the table has been

82−// allocated with vty_init_custom_table and initialized with

83−// vty_set_custom_table_range.

84−static uint8_t custom_table_ready = 0;

8563

8664struct interval {

8765 int first;

@@ -141,7 +119,7 @@ static int vty_bisearch(HsChar ucs, const struct interval *table, int max) {

141119 * in ISO 10646.

142120 */

143121

144−static HsInt builtin_wcwidth(HsChar ucs)

122+HsInt vty_mk_wcwidth(HsChar ucs)

145123{

146124 /* sorted list of non-overlapping intervals of non-spacing characters */

147125 /* generated by "uniset +cat=Me +cat=Mn +cat=Cf -00AD +1160-11FF +200B c" */

@@ -204,7 +182,7 @@ static HsInt builtin_wcwidth(HsChar ucs)

204182

205183 /* binary search in table of non-spacing characters */

206184 if (vty_bisearch(ucs, combining,

207− sizeof(combining) / sizeof(struct interval) - 1))

185+ sizeof(combining) / sizeof(struct interval) - 1))

208186 return 0;

209187

210188 /* if we arrive here, ucs is not a combining or C0/C1 control character */

@@ -224,115 +202,3 @@ static HsInt builtin_wcwidth(HsChar ucs)

224202 (ucs >= 0x20000 && ucs <= 0x2fffd) ||

225203 (ucs >= 0x30000 && ucs <= 0x3fffd)));

226204}

227−

228−// Return the width, in terminal cells, of the specified character.

229−//

230−// If the global custom width table is present, that table will be

231−// consulted for the character's width. If the character is not in

232−// the table, zero will be returned. If the custom width table is not

233−// present, the built-in width table will be used.

234−HsInt vty_mk_wcwidth(HsChar ch)

235−{

236− if (custom_table_ready) {

237− if ((ch >= 0) && (ch < custom_table_size)) {

238− return custom_table[ch];

239− } else {

240− return -1;

241− }

242− } else {

243− return builtin_wcwidth(ch);

244− }

245−}

246−

247−// Initialize a custom character width table.

248−//

249−// This allocates a new character width table of the specified size

250−// (in characters). If a custom table has already been allocated, this

251−// returns 1. Otherwise it allocates a new table, initializes all of its

252−// entries to 1, and returns zero.

253−//

254−// Note that this does *not* mark the table as ready for use. Until the

255−// table is marked ready, it will not be used by vty_mk_wcwidth. To mark

256−// the table as ready, call vty_activate_custom_table() after the table

257−// has been set up with calls to vty_set_custom_table_range.

258−int vty_init_custom_table(int size)

259−{

260− if (custom_table == NULL) {

261− if (size > 0 && size <= MAX_CUSTOM_TABLE_SIZE) {

262− custom_table_ready = 0;

263− custom_table = malloc(size);

264− memset(custom_table, 1, size);

265− custom_table_size = size;

266− return 0;

267− } else {

268− return 1;

269− }

270− } else {

271− return 1;

272− }

273−}

274−

275−// Set the specified character range in the custom width table to the

276−// specified width.

277−//

278−// This function sets 'width' as the character width for all entries

279−// in the custom character table starting at the 'start' entry and

280−// including all entries up to and including 'start + size - 1'.

281−//

282−// If this succeeds, it returns zero. If it fails, it returns 1. It

283−// fails if the table is not allocated, marked as ready (i.e. it is in

284−// use and has already been populated), or if the start or size values

285−// are not in bounds for the table.

286−int vty_set_custom_table_range(uint32_t start, uint32_t size, uint8_t width)

287−{

288− if ((custom_table == NULL) ||

289− (size >= custom_table_size) ||

290− (start >= custom_table_size) ||

291− ((start + 1) >= (custom_table_size - size)) ||

292− custom_table_ready) {

293− return 1;

294− } else {

295− memset(custom_table + start, width, size);

296− return 0;

297− }

298−}

299−

300−// Mark the allocated custom character width table as ready for use.

301−//

302−// After this call, further calls to vty_set_custom_table_range will

303−// fail.

304−//

305−// This function returns 0 if it succeeds. If it fails, it returns 1.

306−// It fails if the custom table is already ready or if it has not been

307−// allocated.

308−int vty_activate_custom_table()

309−{

310− if (custom_table_ready || (custom_table == NULL)) {

311− return 1;

312− } else {

313− custom_table_ready = 1;

314− return 0;

315− }

316−}

317−

318−// Returns whether a custom character width table has been marked ready.

319−int vty_custom_table_ready()

320−{

321− return custom_table_ready;

322−}

323−

324−// Deallocate the custom width table.

325−//

326−// This does nothing if there is no allocated custom width table, or if

327−// there is one but it is in use (marked ready). This is only useful if

328−// an initial allocation succeeds, but range population fails, after

329−// which point the application may want to deallocate the table to avoid

330−// leaving it in an intermediate state.

331−void vty_deallocate_custom_table()

332−{

333− if ((custom_table != NULL) && (!custom_table_ready)) {

334− free(custom_table);

335− custom_table = NULL;

336− custom_table_size = 0;

337− }

338−}

demos/Demo.hs+4−12

@@ -31,8 +31,7 @@ introText = vertCat $ map (string defAttr)

3131 [ "this line is hidden by the top layer"

3232 , "The vty demo program will echo the events generated by the pressed keys."

3333 , "Below there is a 240 color box."

34− , "Followed by a description of the 16 color palette."

35− , "Followed by tones of red using a 24-bit palette."

34+ , "Followed by a description of the 16 color pallete."

3635 , "If the 240 color box is not visible then the terminal"

3736 , "claims 240 colors are not supported."

3837 , "Try setting TERM to xterm-256color"

@@ -43,19 +42,12 @@ introText = vertCat $ map (string defAttr)

4342 , "¯\\_(ツ)_/¯ ¯\\_(ツ)_/¯ ¯\\_(ツ)_/¯ ¯\\_(ツ)_/¯"

4443 ]

4544

46−splitColorImages :: [Image] -> [[Image]]

47−splitColorImages [] = []

48−splitColorImages is = (take 20 is ++ [string defAttr " "]) : (splitColorImages (drop 20 is))

49−

50−fullcolorbox :: Image

51−fullcolorbox = vertCat $ map horizCat $ splitColorImages colorImages

52− where

53− colorImages = map (\i -> string (currentAttr `withBackColor` linearColor i 0 0) " ") [0..255]

54−

5545colorbox_240 :: Image

5646colorbox_240 = vertCat $ map horizCat $ splitColorImages colorImages

5747 where

5848 colorImages = map (\i -> string (currentAttr `withBackColor` Color240 i) " ") [0..239]

49+ splitColorImages [] = []

50+ splitColorImages is = (take 20 is ++ [string defAttr " "]) : (splitColorImages (drop 20 is))

5951

6052colorbox_16 :: Image

@@ -78,7 +70,7 @@ updateDisplay = do

7870 "Press ESC to exit. Events for keys below."

7971 eventLog <- foldMap (string defAttr) <$> get

8072 let pic = picForImage (info <-> eventLog)

81− `addToBottom` (introText <-> colorbox_240 <|> colorbox_16 <|> fullcolorbox)

73+ `addToBottom` (introText <-> colorbox_240 <|> colorbox_16)

8274 vty <- ask

8375 liftIO $ update vty pic

8476

demos/ModeDemo.hs−2

@@ -2,8 +2,6 @@ module Main where

33import Control.Applicative

44import Data.Monoid

5−import Foreign.C.Types (CInt(..), CChar(..))

6−import System.Posix.Types (Fd(..))

86import Graphics.Vty

src/Codec/Binary/UTF8/Debug.hs+2−1

@@ -14,4 +14,5 @@ utf8FromIso :: [Int] -> [Word8]

1414utf8FromIso = encode . map toEnum

1515

1616ppUtf8 :: [Int] -> IO ()

17−ppUtf8 = print . map (`showHex` "") . utf8FromIso

17+ppUtf8 = print . map (\f -> f "") . map showHex . utf8FromIso

18+

src/Data/Sequence/Extra.hs+1−1

@@ -7,7 +7,7 @@ import Data.Sequence

77import Control.Parallel.Strategies

99instance NFData a => NFData (Seq a) where

10− rnf = rnf' . viewl

10+ rnf = \v -> rnf' (viewl v)

1111 where

1212 rnf' EmptyL = ()

1313 rnf' (a :< r) = rnf a >| rnf' (viewl r)

src/Data/Terminfo/Eval.hs+3−3

@@ -42,7 +42,7 @@ pop = do

4242

4343readParam :: Word -> Eval CapParam

4444readParam pn = do

45− !params <- evalParams <$> get

45+ !params <- get >>= return . evalParams

4646 return $! genericIndex params pn

4747

4848push :: CapParam -> Eval ()

@@ -64,11 +64,11 @@ writeCapExpr cap params =

6464 in snd $ runWriter (runStateT (writeCapOps (capOps cap)) s0)

6565

6666writeCapOps :: CapOps -> Eval ()

67−writeCapOps = mapM_ writeCapOp

67+writeCapOps ops = mapM_ writeCapOp ops

6868

6969writeCapOp :: CapOp -> Eval ()

7070writeCapOp (Bytes !offset !count) = do

71− !cap <- evalExpression <$> get

71+ !cap <- get >>= return . evalExpression

7272 let bytes = Vector.take count $ Vector.drop offset (capBytes cap)

7373 Vector.forM_ bytes $ tell.writeWord8

7474writeCapOp DecOut = do

src/Data/Terminfo/Parse.hs+10−10

@@ -1,9 +1,9 @@

11{-# LANGUAGE BangPatterns #-}

22{-# LANGUAGE CPP #-}

3+{-# OPTIONS_HADDOCK hide #-}

34{-# LANGUAGE NoMonomorphismRestriction #-}

4−{-# LANGUAGE ScopedTypeVariables #-}

5+{-# LANGUAGE NamedFieldPuns #-}

56{-# OPTIONS_GHC -funbox-strict-fields -O #-}

6−{-# OPTIONS_HADDOCK hide #-}

88module Data.Terminfo.Parse

99 ( module Data.Terminfo.Parse

@@ -39,7 +39,7 @@ instance Show CapExpression where

3939 ++ " <= " ++ show (sourceString c)

4040 where

4141 hexDump :: [Word8] -> String

42− hexDump = foldr showHex ""

42+ hexDump = foldr (\b s -> showHex b s) ""

4343

4444instance NFData CapExpression where

4545 rnf (CapExpression ops !_bytes !str !c !pOps)

@@ -99,7 +99,7 @@ parseCapExpression capString =

9999 Left e -> Left e

100100 Right buildResults -> Right $ constructCapExpression capString buildResults

101101

102−constructCapExpression :: String -> BuildResults -> CapExpression

102+constructCapExpression :: [Char] -> BuildResults -> CapExpression

103103constructCapExpression capString buildResults =

104104 let expr = CapExpression

105105 { capOps = outCapOps buildResults

@@ -128,7 +128,7 @@ paramEscapeParser = do

128128literalPercentParser :: CapParser BuildResults

129129literalPercentParser = do

130130 _ <- char '%'

131− startOffset <- nextOffset <$> getState

131+ startOffset <- getState >>= return . nextOffset

132132 incOffset 1

133133 return $ BuildResults 0 [Bytes startOffset 1] []

134134

@@ -154,7 +154,7 @@ incrementOpParser = do

154154pushOpParser :: CapParser BuildResults

155155pushOpParser = do

156156 _ <- char 'p'

157− paramN <- read . pure <$> digit

157+ paramN <- digit >>= return . (\d -> read [d])

158158 incOffset 2

159159 return $ BuildResults (fromEnum paramN) [PushParam $ paramN - 1] []

160160

@@ -299,7 +299,7 @@ compareOpParser

299299bytesOpParser :: CapParser BuildResults

300300bytesOpParser = do

301301 bytes <- many1 $ satisfy (/= '%')

302− startOffset <- nextOffset <$> getState

302+ startOffset <- getState >>= return . nextOffset

303303 let !c = length bytes

304304 !s <- getState

305305 let s' = s { nextOffset = startOffset + c }

@@ -336,9 +336,9 @@ data BuildResults = BuildResults

336336instance Semigroup BuildResults where

337337 v0 <> v1

338338 = BuildResults

339− { outParamCount = outParamCount v0 `max` outParamCount v1

340− , outCapOps = outCapOps v0 <> outCapOps v1

341− , outParamOps = outParamOps v0 <> outParamOps v1

339+ { outParamCount = (outParamCount v0) `max` (outParamCount v1)

340+ , outCapOps = (outCapOps v0) <> (outCapOps v1)

341+ , outParamOps = (outParamOps v0) <> (outParamOps v1)

342342 }

343343

344344instance Monoid BuildResults where

src/Graphics/Text/Width.hs+9−40

@@ -1,47 +1,26 @@

22{-# OPTIONS_GHC -D_XOPEN_SOURCE #-}

33{-# LANGUAGE ForeignFunctionInterface #-}

4−-- | This module provides functions to measure the terminal column width

5−-- of characters and strings.

6−--

7−-- The functions provided in this module all ultimately make calls to

8−-- the C implementation in @cbits/mk_wcwidth.c@. That code manages some

9−-- global state that carries a table of Unicode character widths. For

10−-- more details, see 'Graphics.Vty.UnicodeWidthTable.Install', the C

11−-- code, and the "Multi-Column Character Support" section of the project

12−-- @README@.

134module Graphics.Text.Width

145 ( wcwidth

156 , wcswidth

16− , wctwidth

17− , wctlwidth

187 , safeWcwidth

198 , safeWcswidth

20− , safeWctwidth

21− , safeWctlwidth

229 )

2310where

2411

25−import Data.List (foldl')

26−import qualified Data.Text as T

27−import qualified Data.Text.Lazy as TL

28−

2912foreign import ccall unsafe "vty_mk_wcwidth" wcwidth :: Char -> Int

3013

3114wcswidth :: String -> Int

32−wcswidth = foldl' (\l c -> wcwidth c + l) 0

33−{-# INLINE [1] wcswidth #-}

34−

35−wctwidth :: T.Text -> Int

36−wctwidth = T.foldl' (\l c -> wcwidth c + l) 0

15+wcswidth = sum . map wcwidth

3716

38−wctlwidth :: TL.Text -> Int

39−wctlwidth = TL.foldl' (\l c -> wcwidth c + l) 0

40−

41−{-# RULES

42−"wcswidth/unpack" forall x. wcswidth (T.unpack x) = wctwidth x

43−"wcswidth/lazy-unpack" forall x. wcswidth (TL.unpack x) = wctlwidth x

44− #-}

17+-- XXX: Characters with unknown widths occupy 1 column?

18+--

19+-- Not sure if this is actually correct. I presume there is a

20+-- replacement character that is output by the terminal instead of the

21+-- character and this replacement character is 1 column wide. If this is

22+-- not true for all terminals then a per-terminal replacement character

23+-- width needs to be implemented.

4524

4625-- | Returns the display width of a character. Assumes all characters

4726-- with unknown widths are 0 width.

@@ -51,14 +30,4 @@ safeWcwidth = max 0 . wcwidth

5130-- | Returns the display width of a string. Assumes all characters with

5231-- unknown widths are 0 width.

5332safeWcswidth :: String -> Int

54−safeWcswidth = foldl' (\l c -> safeWcwidth c + l) 0

55−

56−-- | Returns the display width of a text. Assumes all characters with

57−-- unknown widths are 0 width.

58−safeWctwidth :: T.Text -> Int

59−safeWctwidth = T.foldl' (\l c -> safeWcwidth c + l) 0

60−

61−-- | Returns the display width of a lazy text. Assumes all characters

62−-- with unknown widths are 0 width.

63−safeWctlwidth :: TL.Text -> Int

64−safeWctlwidth = TL.foldl' (\l c -> safeWcwidth c + l) 0

33+safeWcswidth = sum . map safeWcwidth

src/Graphics/Vty.hs+40−113

@@ -1,5 +1,4 @@

11{-# LANGUAGE CPP #-}

2−{-# LANGUAGE ScopedTypeVariables #-}

43-- | Vty provides interfaces for both terminal input and terminal

54-- output.

@@ -14,7 +13,7 @@

1413-- values in the "Graphics.Vty.Attributes" module.

1514--

1615-- Vty uses threads internally, so programs made with Vty need to be

17−-- compiled with the threaded runtime using the GHC @-threaded@ option.

16+-- compiled with the threaded runtime using the GHC `-threaded` option.

1817--

1918-- @

2019-- import "Graphics.Vty"

@@ -34,7 +33,6 @@

3433module Graphics.Vty

3534 ( Vty(..)

3635 , mkVty

37− , setWindowTitle

3836 , Mode(..)

3937 , module Graphics.Vty.Config

4038 , module Graphics.Vty.Input

@@ -48,19 +46,12 @@ where

4846

4947import Graphics.Vty.Config

5048import Graphics.Vty.Input

51−import Graphics.Vty.Input.Events

5249import Graphics.Vty.Output

5350import Graphics.Vty.Output.Interface

5451import Graphics.Vty.Picture

5552import Graphics.Vty.Image

5653import Graphics.Vty.Attributes

57−import Graphics.Vty.UnicodeWidthTable.IO

58−import Graphics.Vty.UnicodeWidthTable.Install

5954

60−import Data.Char (isPrint, showLitChar)

61−import qualified Data.ByteString.Char8 as BS8

62−

63−import qualified Control.Exception as E

6455import Control.Monad (when)

6556import Control.Concurrent.STM

6657

@@ -74,7 +65,7 @@ import Data.Semigroup ((<>))

7465--

7566-- The use of Vty typically follows this process:

7667--

77−-- 1. Initialize vty with 'mkVty' (this takes control of the terminal).

68+-- 1. Initialize vty

7869--

7970-- 2. Use 'update' to display a picture.

8071--

@@ -82,33 +73,31 @@ import Data.Semigroup ((<>))

8273--

8374-- 4. Depending on the event, go to 2 or 5.

8475--

85−-- 5. Shutdown vty and restore the terminal state with 'shutdown'. At

86−-- this point the 'Vty' handle cannot be used again.

76+-- 5. Shutdown vty.

8777--

8878-- Operations on Vty handles are not thread-safe.

89−data Vty =

90− Vty { update :: Picture -> IO ()

91− -- ^ Outputs the given 'Picture'.

92− , nextEvent :: IO Event

93− -- ^ Return the next 'Event' or block until one becomes

94− -- available.

95− , nextEventNonblocking :: IO (Maybe Event)

96− -- ^ Non-blocking version of 'nextEvent'.

97− , inputIface :: Input

98− -- ^ The input interface. See 'Input'.

99− , outputIface :: Output

100− -- ^ The output interface. See 'Output'.

101− , refresh :: IO ()

102− -- ^ Refresh the display. If other programs output to the

103− -- terminal and mess up the display then the application might

104− -- want to force a refresh using this function.

105− , shutdown :: IO ()

106− -- ^ Clean up after vty. A call to this function is necessary to

107− -- cleanly restore the terminal state before application exit.

108− -- The above methods will throw an exception if executed after

109− -- this is executed. Idempotent.

110− , isShutdown :: IO Bool

111− }

79+data Vty = Vty

80+ { -- | Outputs the given 'Picture'.

81+ update :: Picture -> IO ()

82+ -- | Return the next 'Event' or block until one becomes available.

83+ , nextEvent :: IO Event

84+ -- | Non-blocking version of 'nextEvent'.

85+ , nextEventNonblocking :: IO (Maybe Event)

86+ -- | The input interface. See 'Input'.

87+ , inputIface :: Input

88+ -- | The output interface. See 'Output'.

89+ , outputIface :: Output

90+ -- | Refresh the display. If other programs output to the terminal

91+ -- and mess up the display then the application might want to

92+ -- force a refresh using this function.

93+ , refresh :: IO ()

94+ -- | Clean up after vty. A call to this function is necessary to

95+ -- cleanly restore the terminal state before application exit. The

96+ -- above methods will throw an exception if executed after this is

97+ -- executed. Idempotent.

98+ , shutdown :: IO ()

99+ , isShutdown :: IO Bool

100+ }

112101

113102-- | Create a Vty handle. At most one handle should be created at a time

114103-- for a given terminal device.

@@ -121,54 +110,15 @@ data Vty =

121110mkVty :: Config -> IO Vty

122111mkVty appConfig = do

123112 config <- (<> appConfig) <$> userConfig

113+ input <- inputForConfig config

114+ out <- outputForConfig config

115+ intMkVty input out

124116

125− when (allowCustomUnicodeWidthTables config /= Just False) $

126− installCustomWidthTable config

127−

128− input <- inputForConfig config

129− out <- outputForConfig config

130− internalMkVty input out

131−

132−installCustomWidthTable :: Config -> IO ()

133−installCustomWidthTable c = do

134− let doLog s = case debugLog c of

135− Nothing -> return ()

136− Just path -> appendFile path $ "installWidthTable: " <> s <> "\n"

137−

138− customInstalled <- isCustomTableReady

139− when (not customInstalled) $ do

140− mTerm <- currentTerminalName

141− case mTerm of

142− Nothing ->

143− doLog "No current terminal name available"

144− Just currentTerm ->

145− case lookup currentTerm (termWidthMaps c) of

146− Nothing ->

147− doLog "Current terminal not found in custom character width mapping list"

148− Just path -> do

149− tableResult <- E.try $ readUnicodeWidthTable path

150− case tableResult of

151− Left (e::E.SomeException) ->

152− doLog $ "Error reading custom character width table " <>

153− "at " <> show path <> ": " <> show e

154− Right (Left msg) ->

155− doLog $ "Error reading custom character width table " <>

156− "at " <> show path <> ": " <> msg

157− Right (Right table) -> do

158− installResult <- E.try $ installUnicodeWidthTable table

159− case installResult of

160− Left (e::E.SomeException) ->

161− doLog $ "Error installing unicode table (" <>

162− show path <> ": " <> show e

163− Right () ->

164− doLog $ "Successfully installed Unicode width table " <>

165− " from " <> show path

166−

167−internalMkVty :: Input -> Output -> IO Vty

168−internalMkVty input out = do

117+intMkVty :: Input -> Output -> IO Vty

118+intMkVty input out = do

169119 reserveDisplay out

170120

171− shutdownVar <- newTVarIO False

121+ shutdownVar <- atomically $ newTVar False

172122 let shutdownIo = do

173123 alreadyShutdown <- atomically $ swapTVar shutdownVar True

174124 when (not alreadyShutdown) $ do

@@ -176,7 +126,7 @@ internalMkVty input out = do

176126 releaseDisplay out

177127 releaseTerminal out

178128

179− let shutdownStatus = readTVarIO shutdownVar

129+ let shutdownStatus = atomically $ readTVar shutdownVar

180130

181131 lastPicRef <- newIORef Nothing

182132 lastUpdateRef <- newIORef Nothing

@@ -210,18 +160,16 @@ internalMkVty input out = do

210160 maybe (return ()) innerUpdate mPic

211161

212162 let mkResize = uncurry EvResize <$> displayBounds out

213−

214− translateInternalEvent ResumeAfterSignal = mkResize

215− translateInternalEvent (InputEvent e) = return e

216−

217163 gkey = do

218− e <- atomically $ readTChan $ _eventChannel input

219− translateInternalEvent e

164+ k <- atomically $ readTChan $ _eventChannel input

165+ case k of

166+ (EvResize _ _) -> mkResize

167+ _ -> return k

220168 gkey' = do

221− mEv <- atomically $ tryReadTChan $ _eventChannel input

222− case mEv of

223− Just e -> Just <$> translateInternalEvent e

224− Nothing -> return Nothing

169+ k <- atomically $ tryReadTChan $ _eventChannel input

170+ case k of

171+ (Just (EvResize _ _)) -> Just <$> mkResize

172+ _ -> return k

225173

226174 return $ Vty { update = innerUpdate

227175 , nextEvent = gkey

@@ -232,24 +180,3 @@ internalMkVty input out = do

232180 , shutdown = shutdownIo

233181 , isShutdown = shutdownStatus

234182 }

235−

236−-- | Set the terminal window title string.

237−--

238−-- This function emits an Xterm-compatible escape sequence that we

239−-- anticipate will work for essentially all modern terminal emulators.

240−-- Ideally we'd use a terminal capability for this, but there does not

241−-- seem to exist a termcap for setting window titles. If you find that

242−-- this function does not work for a given terminal emulator, please

243−-- report the issue.

244−--

245−-- For details, see:

246−--

247−-- https://tldp.org/HOWTO/Xterm-Title-3.html

248−setWindowTitle :: Vty -> String -> IO ()

249−setWindowTitle vty title = do

250− let sanitize :: String -> String

251− sanitize = concatMap sanitizeChar

252− sanitizeChar c | not (isPrint c) = showLitChar c ""

253− | otherwise = [c]

254− let buf = BS8.pack $ "\ESC]2;" <> sanitize title <> "\007"

255− outputByteBuffer (outputIface vty) buf

src/Graphics/Vty/Attributes.hs+52−11

@@ -1,4 +1,7 @@

11{-# LANGUAGE CPP #-}

2+{-# LANGUAGE StandaloneDeriving #-}

3+{-# LANGUAGE GADTs #-}

4+{-# LANGUAGE RankNTypes #-}

25{-# LANGUAGE DeriveGeneric #-}

36{-# LANGUAGE DeriveAnyClass #-}

@@ -27,9 +30,7 @@

2730-- The value 'currentAttr' will keep the attributes of whatever was

2831-- output previously.

2932module Graphics.Vty.Attributes

30− ( module Graphics.Vty.Attributes.Color

31−

32− , Attr(..)

33+ ( Attr(..)

3334 , FixedAttr(..)

3435 , MaybeDefault(..)

3536 , defAttr

@@ -40,7 +41,6 @@ module Graphics.Vty.Attributes

4041 , withStyle

4142 , standout

4243 , italic

43− , strikethrough

4444 , underline

4545 , reverseVideo

4646 , blink

@@ -56,16 +56,24 @@ module Graphics.Vty.Attributes

5656

5757 -- * Setting hyperlinks

5858 , withURL

59+

60+ -- * Colors

61+ , module Graphics.Vty.Attributes.Color

62+ , module Graphics.Vty.Attributes.Color240

5963 )

6064where

6165

6266import Control.DeepSeq

6367import Data.Bits

68+#if !(MIN_VERSION_base(4,11,0))

69+import Data.Semigroup

70+#endif

6471import Data.Text (Text)

6572import Data.Word

6673import GHC.Generics

6774

6875import Graphics.Vty.Attributes.Color

76+import Graphics.Vty.Attributes.Color240

6977

7078-- | A display attribute defines the Color and Style of all the

7179-- characters rendered after the attribute is applied.

@@ -113,6 +121,19 @@ data Attr = Attr

113121-- Then the foreground color encoded into 8 bits.

114122-- Then the background color encoded into 8 bits.

115123

124+instance Semigroup Attr where

125+ attr0 <> attr1 =

126+ Attr ( attrStyle attr0 <> attrStyle attr1 )

127+ ( attrForeColor attr0 <> attrForeColor attr1 )

128+ ( attrBackColor attr0 <> attrBackColor attr1 )

129+ ( attrURL attr0 <> attrURL attr1 )

130+

131+instance Monoid Attr where

132+ mempty = Attr mempty mempty mempty mempty

133+#if !(MIN_VERSION_base(4,11,0))

134+ mappend = (<>)

135+#endif

136+

116137-- | Specifies the display attributes such that the final style and

117138-- color values do not depend on the previously applied display

118139-- attribute. The display attributes can still depend on the terminal's

@@ -127,20 +148,43 @@ data FixedAttr = FixedAttr

127148-- | The style and color attributes can either be the terminal defaults.

128149-- Or be equivalent to the previously applied style. Or be a specific

129150-- value.

130−data MaybeDefault v = Default | KeepCurrent | SetTo !v

131− deriving (Eq, Read, Show)

151+data MaybeDefault v where

152+ Default :: MaybeDefault v

153+ KeepCurrent :: MaybeDefault v

154+ SetTo :: forall v . ( Eq v, Show v, Read v ) => !v -> MaybeDefault v

132155

133156instance (NFData v) => NFData (MaybeDefault v) where

134157 rnf Default = ()

135158 rnf KeepCurrent = ()

136159 rnf (SetTo v) = rnf v

137160

161+deriving instance Eq v => Eq (MaybeDefault v)

162+deriving instance Eq v => Show (MaybeDefault v)

163+deriving instance (Eq v, Show v, Read v) => Read (MaybeDefault v)

164+

165+instance Eq v => Semigroup (MaybeDefault v) where

166+ Default <> Default = Default

167+ Default <> KeepCurrent = Default

168+ Default <> SetTo v = SetTo v

169+ KeepCurrent <> Default = Default

170+ KeepCurrent <> KeepCurrent = KeepCurrent

171+ KeepCurrent <> SetTo v = SetTo v

172+ SetTo _v <> Default = Default

173+ SetTo v <> KeepCurrent = SetTo v

174+ SetTo _ <> SetTo v = SetTo v

175+

176+instance Eq v => Monoid ( MaybeDefault v ) where

177+ mempty = KeepCurrent

178+#if !(MIN_VERSION_base(4,11,0))

179+ mappend = (<>)

180+#endif

181+

138182-- | Styles are represented as an 8 bit word. Each bit in the word is 1

139183-- if the style attribute assigned to that bit should be applied and 0

140184-- if the style attribute should not be applied.

141185type Style = Word8

142186

143−-- | Valid style attributes include:

187+-- | The 7 possible style attributes:

144188--

145189-- * standout

146190--

@@ -156,11 +200,9 @@ type Style = Word8

156200--

157201-- * italic

158202--

159−-- * strikethrough (via the smxx/rmxx terminfo capabilities)

160−--

161203-- (The invisible, protect, and altcharset display attributes some

162204-- terminals support are not supported via VTY.)

163−standout, underline, reverseVideo, blink, dim, bold, italic, strikethrough :: Style

205+standout, underline, reverseVideo, blink, dim, bold, italic :: Style

164206standout = 0x01

165207underline = 0x02

166208reverseVideo = 0x04

@@ -168,7 +210,6 @@ blink = 0x08

168210dim = 0x10

169211bold = 0x20

170212italic = 0x40

171−strikethrough = 0x80

172213

173214defaultStyleMask :: Style

174215defaultStyleMask = 0x00

src/Graphics/Vty/Attributes/Color.hs+4−91

@@ -1,24 +1,7 @@

11{-# LANGUAGE DeriveGeneric #-}

22{-# LANGUAGE DeriveAnyClass #-}

3−{-# LANGUAGE MultiWayIf #-}

4−{-# LANGUAGE ScopedTypeVariables #-}

5−

63module Graphics.Vty.Attributes.Color

74 ( Color(..)

8− , ColorMode(..)

9−

10− -- * Detecting Terminal Color Support

11− , detectColorMode

12−

13− -- ** Fixed Colors

14− -- | Standard 8-color ANSI terminal color codes.

15− --

16− -- Note that these map to colors in the terminal's custom palette. For

17− -- instance, `white` maps to whatever the terminal color theme uses for

18− -- white.

19− --

20− -- Use these functions if you want to make apps that fit the terminal theme.

21− -- If you want access to more/stronger colors use `rgbColor`

225 , black

236 , red

247 , green

@@ -27,8 +10,6 @@ module Graphics.Vty.Attributes.Color

2710 , magenta

2811 , cyan

2912 , white

30−

31− -- | Bright/Vivid variants of the standard 8-color ANSI

3213 , brightBlack

3314 , brightRed

3415 , brightGreen

@@ -37,25 +18,12 @@ module Graphics.Vty.Attributes.Color

3718 , brightMagenta

3819 , brightCyan

3920 , brightWhite

40− -- ** Creating Colors From RGB

41− , linearColor

42− , srgbColor

43− , rgbColor

44− , color240

45− , module Graphics.Vty.Attributes.Color240

4621 )

4722where

4823

4924import Data.Word

5025import GHC.Generics

5126import Control.DeepSeq

52−import System.Environment (lookupEnv)

53−

54−import qualified System.Console.Terminfo as Terminfo

55−import Control.Exception (catch)

56−import Data.Maybe

57−

58−import Graphics.Vty.Attributes.Color240

5927

6028-- | Abstract data type representing a color.

6129--

@@ -95,7 +63,7 @@ import Graphics.Vty.Attributes.Color240

9563-- reported then the color reproduction will be incorrect.

9664--

9765-- If the terminal reports <= 16 colors then the 240 color palette

98−-- points are only mapped to the 8 color palette. I'm not sure of

66+-- points are only mapped to the 8 color pallete. I'm not sure of

9967-- the RGB points for the "bright" colors which is why they are not

10068-- addressable via the 240 color palette.

10169--

@@ -109,33 +77,10 @@ import Graphics.Vty.Attributes.Color240

10977-- terminfo but I don't know it.

11078--

11179-- Seriously, terminal color support is INSANE.

112−data Color = ISOColor !Word8 | Color240 !Word8 | RGBColor !Word8 !Word8 !Word8

80+data Color = ISOColor !Word8 | Color240 !Word8

11381 deriving ( Eq, Show, Read, Generic, NFData )

11482

115−data ColorMode

116− = NoColor

117− | ColorMode8

118− | ColorMode16

119− | ColorMode240 !Word8

120− | FullColor

121− deriving ( Eq, Show )

122−

123−detectColorMode :: String -> IO ColorMode

124−detectColorMode termName' = do

125− term <- catch (Just <$> Terminfo.setupTerm termName')

126− (\(_ :: Terminfo.SetupTermError) -> return Nothing)

127− let getCap cap = term >>= \t -> Terminfo.getCapability t cap

128− termColors = fromMaybe 0 $ getCap (Terminfo.tiGetNum "colors")

129− colorterm <- lookupEnv "COLORTERM"

130− return $ if

131− | termColors < 8 -> NoColor

132− | termColors < 16 -> ColorMode8

133− | termColors == 16 -> ColorMode16

134− | termColors < 256 -> ColorMode240 (fromIntegral termColors - 16)

135− | colorterm == Just "truecolor" -> FullColor

136− | colorterm == Just "24bit" -> FullColor

137− | otherwise -> ColorMode240 240

138−

83+-- | Standard 8-color ANSI terminal color codes.

13984black, red, green, yellow, blue, magenta, cyan, white :: Color

14085black = ISOColor 0

14186red = ISOColor 1

@@ -146,6 +91,7 @@ magenta= ISOColor 5

14691cyan = ISOColor 6

14792white = ISOColor 7

14893

94+-- | Bright/Vivid variants of the standard 8-color ANSI

14995brightBlack, brightRed, brightGreen, brightYellow :: Color

15096brightBlue, brightMagenta, brightCyan, brightWhite :: Color

15197brightBlack = ISOColor 8

@@ -156,36 +102,3 @@ brightBlue = ISOColor 12

156102brightMagenta= ISOColor 13

157103brightCyan = ISOColor 14

158104brightWhite = ISOColor 15

159−

160−linearColor :: Integral i => i -> i -> i -> Color

161−linearColor r g b = RGBColor r' g' b'

162− where

163− r' = fromIntegral (clamp r) :: Word8

164− g' = fromIntegral (clamp g) :: Word8

165− b' = fromIntegral (clamp b) :: Word8

166− clamp = min 255 . max 0

167−

168−srgbColor :: Integral i => i -> i -> i -> Color

169−srgbColor r g b =

170− -- srgb to rgb transformation as described at

171− -- https://en.wikipedia.org/wiki/SRGB#The_reverse_transformation

172− --

173− -- TODO: it may be worth translating this to a lookup table, as with color240

174− let shrink n = fromIntegral n / 255 :: Double

175− -- called gamma^-1 in wiki

176− gamma u

177− | u <= 0.04045 = u/12.92

178− | otherwise = ((u + 0.055) / 1.055) ** 2.4

179− -- TODO: this is a slightly inaccurate conversion. is it worth doing proterly?

180− expand n = round (255 * n)

181− convert = expand . gamma . shrink

182− in RGBColor (convert r) (convert g) (convert b)

183−

184−color240 :: Integral i => i -> i -> i -> Color

185−color240 r g b = Color240 (rgbColorToColor240 r g b)

186−

187−-- | Create a Vty 'Color' (in the 240 color set) from an RGB triple.

188−-- This function is lossy in the sense that we only internally support 240 colors but the

189−-- #RRGGBB format supports 16^3 colors.

190−rgbColor :: Integral i => i -> i -> i -> Color

191−rgbColor = color240

src/Graphics/Vty/Attributes/Color240.hs+250−38

@@ -1,56 +1,268 @@

11-- This header file was generated by ./256colres.pl

22module Graphics.Vty.Attributes.Color240

3− ( rgbColorToColor240

3+ ( rgbColor

44 , color240CodeToRGB

55 )

66where

8+import Graphics.Vty.Attributes.Color

810import Data.Word (Word8)

911import Text.Printf

1012

1113-- Note: rgbColor's mapping from RGB to 240 colors was generated from

1214-- 256colres.pl which is forked from xterm 256colres.pl.

1315

14−-- | Create a value in the Color240 set from an RGB triple

15−rgbColorToColor240 :: Integral i => i -> i -> i -> Word8

16−rgbColorToColor240 r g b

16+-- | Create a Vty 'Color' (in the 240 color set) from an RGB triple.

17+-- This function is lossy in the sense that we only internally support 240 colors but the

18+-- #RRGGBB format supports 16^3 colors.

19+rgbColor :: Integral i => i -> i -> i -> Color

20+rgbColor r g b

1721 | r < 0 && g < 0 && b < 0 = error "rgbColor with negative color component intensity"

18− | r == 8 && g == 8 && b == 8 = 216

19− | r == 18 && g == 18 && b == 18 = 217

20− | r == 28 && g == 28 && b == 28 = 218

21− | r == 38 && g == 38 && b == 38 = 219

22− | r == 48 && g == 48 && b == 48 = 220

23− | r == 58 && g == 58 && b == 58 = 221

24− | r == 68 && g == 68 && b == 68 = 222

25− | r == 78 && g == 78 && b == 78 = 223

26− | r == 88 && g == 88 && b == 88 = 224

27− | r == 98 && g == 98 && b == 98 = 225

28− | r == 108 && g == 108 && b == 108 = 226

29− | r == 118 && g == 118 && b == 118 = 227

30− | r == 128 && g == 128 && b == 128 = 228

31− | r == 138 && g == 138 && b == 138 = 229

32− | r == 148 && g == 148 && b == 148 = 230

33− | r == 158 && g == 158 && b == 158 = 231

34− | r == 168 && g == 168 && b == 168 = 232

35− | r == 178 && g == 178 && b == 178 = 233

36− | r == 188 && g == 188 && b == 188 = 234

37− | r == 198 && g == 198 && b == 198 = 235

38− | r == 208 && g == 208 && b == 208 = 236

39− | r == 218 && g == 218 && b == 218 = 237

40− | r == 228 && g == 228 && b == 228 = 238

41− | r == 238 && g == 238 && b == 238 = 239

42− | otherwise = 36 * go r + 6 * go g + go b

43− where go = simpleColor_ (error (printf "RGB color %d %d %d does not map to 240 palette."

22+ | r == 8 && g == 8 && b == 8 = Color240 216

23+ | r == 18 && g == 18 && b == 18 = Color240 217

24+ | r == 28 && g == 28 && b == 28 = Color240 218

25+ | r == 38 && g == 38 && b == 38 = Color240 219

26+ | r == 48 && g == 48 && b == 48 = Color240 220

27+ | r == 58 && g == 58 && b == 58 = Color240 221

28+ | r == 68 && g == 68 && b == 68 = Color240 222

29+ | r == 78 && g == 78 && b == 78 = Color240 223

30+ | r == 88 && g == 88 && b == 88 = Color240 224

31+ | r == 98 && g == 98 && b == 98 = Color240 225

32+ | r == 108 && g == 108 && b == 108 = Color240 226

33+ | r == 118 && g == 118 && b == 118 = Color240 227

34+ | r == 128 && g == 128 && b == 128 = Color240 228

35+ | r == 138 && g == 138 && b == 138 = Color240 229

36+ | r == 148 && g == 148 && b == 148 = Color240 230

37+ | r == 158 && g == 158 && b == 158 = Color240 231

38+ | r == 168 && g == 168 && b == 168 = Color240 232

39+ | r == 178 && g == 178 && b == 178 = Color240 233

40+ | r == 188 && g == 188 && b == 188 = Color240 234

41+ | r == 198 && g == 198 && b == 198 = Color240 235

42+ | r == 208 && g == 208 && b == 208 = Color240 236

43+ | r == 218 && g == 218 && b == 218 = Color240 237

44+ | r == 228 && g == 228 && b == 228 = Color240 238

45+ | r == 238 && g == 238 && b == 238 = Color240 239

46+ | r <= 0 && g <= 0 && b <= 0 = Color240 0

47+ | r <= 0 && g <= 0 && b <= 95 = Color240 1

48+ | r <= 0 && g <= 0 && b <= 135 = Color240 2

49+ | r <= 0 && g <= 0 && b <= 175 = Color240 3

50+ | r <= 0 && g <= 0 && b <= 215 = Color240 4

51+ | r <= 0 && g <= 0 && b <= 255 = Color240 5

52+ | r <= 0 && g <= 95 && b <= 0 = Color240 6

53+ | r <= 0 && g <= 95 && b <= 95 = Color240 7

54+ | r <= 0 && g <= 95 && b <= 135 = Color240 8

55+ | r <= 0 && g <= 95 && b <= 175 = Color240 9

56+ | r <= 0 && g <= 95 && b <= 215 = Color240 10

57+ | r <= 0 && g <= 95 && b <= 255 = Color240 11

58+ | r <= 0 && g <= 135 && b <= 0 = Color240 12

59+ | r <= 0 && g <= 135 && b <= 95 = Color240 13

60+ | r <= 0 && g <= 135 && b <= 135 = Color240 14

61+ | r <= 0 && g <= 135 && b <= 175 = Color240 15

62+ | r <= 0 && g <= 135 && b <= 215 = Color240 16

63+ | r <= 0 && g <= 135 && b <= 255 = Color240 17

64+ | r <= 0 && g <= 175 && b <= 0 = Color240 18

65+ | r <= 0 && g <= 175 && b <= 95 = Color240 19

66+ | r <= 0 && g <= 175 && b <= 135 = Color240 20

67+ | r <= 0 && g <= 175 && b <= 175 = Color240 21

68+ | r <= 0 && g <= 175 && b <= 215 = Color240 22

69+ | r <= 0 && g <= 175 && b <= 255 = Color240 23

70+ | r <= 0 && g <= 215 && b <= 0 = Color240 24

71+ | r <= 0 && g <= 215 && b <= 95 = Color240 25

72+ | r <= 0 && g <= 215 && b <= 135 = Color240 26

73+ | r <= 0 && g <= 215 && b <= 175 = Color240 27

74+ | r <= 0 && g <= 215 && b <= 215 = Color240 28

75+ | r <= 0 && g <= 215 && b <= 255 = Color240 29

76+ | r <= 0 && g <= 255 && b <= 0 = Color240 30

77+ | r <= 0 && g <= 255 && b <= 95 = Color240 31

78+ | r <= 0 && g <= 255 && b <= 135 = Color240 32

79+ | r <= 0 && g <= 255 && b <= 175 = Color240 33

80+ | r <= 0 && g <= 255 && b <= 215 = Color240 34

81+ | r <= 0 && g <= 255 && b <= 255 = Color240 35

82+ | r <= 95 && g <= 0 && b <= 0 = Color240 36

83+ | r <= 95 && g <= 0 && b <= 95 = Color240 37

84+ | r <= 95 && g <= 0 && b <= 135 = Color240 38

85+ | r <= 95 && g <= 0 && b <= 175 = Color240 39

86+ | r <= 95 && g <= 0 && b <= 215 = Color240 40

87+ | r <= 95 && g <= 0 && b <= 255 = Color240 41

88+ | r <= 95 && g <= 95 && b <= 0 = Color240 42

89+ | r <= 95 && g <= 95 && b <= 95 = Color240 43

90+ | r <= 95 && g <= 95 && b <= 135 = Color240 44

91+ | r <= 95 && g <= 95 && b <= 175 = Color240 45

92+ | r <= 95 && g <= 95 && b <= 215 = Color240 46

93+ | r <= 95 && g <= 95 && b <= 255 = Color240 47

94+ | r <= 95 && g <= 135 && b <= 0 = Color240 48

95+ | r <= 95 && g <= 135 && b <= 95 = Color240 49

96+ | r <= 95 && g <= 135 && b <= 135 = Color240 50

97+ | r <= 95 && g <= 135 && b <= 175 = Color240 51

98+ | r <= 95 && g <= 135 && b <= 215 = Color240 52

99+ | r <= 95 && g <= 135 && b <= 255 = Color240 53

100+ | r <= 95 && g <= 175 && b <= 0 = Color240 54

101+ | r <= 95 && g <= 175 && b <= 95 = Color240 55

102+ | r <= 95 && g <= 175 && b <= 135 = Color240 56

103+ | r <= 95 && g <= 175 && b <= 175 = Color240 57

104+ | r <= 95 && g <= 175 && b <= 215 = Color240 58

105+ | r <= 95 && g <= 175 && b <= 255 = Color240 59

106+ | r <= 95 && g <= 215 && b <= 0 = Color240 60

107+ | r <= 95 && g <= 215 && b <= 95 = Color240 61

108+ | r <= 95 && g <= 215 && b <= 135 = Color240 62

109+ | r <= 95 && g <= 215 && b <= 175 = Color240 63

110+ | r <= 95 && g <= 215 && b <= 215 = Color240 64

111+ | r <= 95 && g <= 215 && b <= 255 = Color240 65

112+ | r <= 95 && g <= 255 && b <= 0 = Color240 66

113+ | r <= 95 && g <= 255 && b <= 95 = Color240 67

114+ | r <= 95 && g <= 255 && b <= 135 = Color240 68

115+ | r <= 95 && g <= 255 && b <= 175 = Color240 69

116+ | r <= 95 && g <= 255 && b <= 215 = Color240 70

117+ | r <= 95 && g <= 255 && b <= 255 = Color240 71

118+ | r <= 135 && g <= 0 && b <= 0 = Color240 72

119+ | r <= 135 && g <= 0 && b <= 95 = Color240 73

120+ | r <= 135 && g <= 0 && b <= 135 = Color240 74

121+ | r <= 135 && g <= 0 && b <= 175 = Color240 75

122+ | r <= 135 && g <= 0 && b <= 215 = Color240 76

123+ | r <= 135 && g <= 0 && b <= 255 = Color240 77

124+ | r <= 135 && g <= 95 && b <= 0 = Color240 78

125+ | r <= 135 && g <= 95 && b <= 95 = Color240 79

126+ | r <= 135 && g <= 95 && b <= 135 = Color240 80

127+ | r <= 135 && g <= 95 && b <= 175 = Color240 81

128+ | r <= 135 && g <= 95 && b <= 215 = Color240 82

129+ | r <= 135 && g <= 95 && b <= 255 = Color240 83

130+ | r <= 135 && g <= 135 && b <= 0 = Color240 84

131+ | r <= 135 && g <= 135 && b <= 95 = Color240 85

132+ | r <= 135 && g <= 135 && b <= 135 = Color240 86

133+ | r <= 135 && g <= 135 && b <= 175 = Color240 87

134+ | r <= 135 && g <= 135 && b <= 215 = Color240 88

135+ | r <= 135 && g <= 135 && b <= 255 = Color240 89

136+ | r <= 135 && g <= 175 && b <= 0 = Color240 90

137+ | r <= 135 && g <= 175 && b <= 95 = Color240 91

138+ | r <= 135 && g <= 175 && b <= 135 = Color240 92

139+ | r <= 135 && g <= 175 && b <= 175 = Color240 93

140+ | r <= 135 && g <= 175 && b <= 215 = Color240 94

141+ | r <= 135 && g <= 175 && b <= 255 = Color240 95

142+ | r <= 135 && g <= 215 && b <= 0 = Color240 96

143+ | r <= 135 && g <= 215 && b <= 95 = Color240 97

144+ | r <= 135 && g <= 215 && b <= 135 = Color240 98

145+ | r <= 135 && g <= 215 && b <= 175 = Color240 99

146+ | r <= 135 && g <= 215 && b <= 215 = Color240 100

147+ | r <= 135 && g <= 215 && b <= 255 = Color240 101

148+ | r <= 135 && g <= 255 && b <= 0 = Color240 102

149+ | r <= 135 && g <= 255 && b <= 95 = Color240 103

150+ | r <= 135 && g <= 255 && b <= 135 = Color240 104

151+ | r <= 135 && g <= 255 && b <= 175 = Color240 105

152+ | r <= 135 && g <= 255 && b <= 215 = Color240 106

153+ | r <= 135 && g <= 255 && b <= 255 = Color240 107

154+ | r <= 175 && g <= 0 && b <= 0 = Color240 108

155+ | r <= 175 && g <= 0 && b <= 95 = Color240 109

156+ | r <= 175 && g <= 0 && b <= 135 = Color240 110

157+ | r <= 175 && g <= 0 && b <= 175 = Color240 111

158+ | r <= 175 && g <= 0 && b <= 215 = Color240 112

159+ | r <= 175 && g <= 0 && b <= 255 = Color240 113

160+ | r <= 175 && g <= 95 && b <= 0 = Color240 114

161+ | r <= 175 && g <= 95 && b <= 95 = Color240 115

162+ | r <= 175 && g <= 95 && b <= 135 = Color240 116

163+ | r <= 175 && g <= 95 && b <= 175 = Color240 117

164+ | r <= 175 && g <= 95 && b <= 215 = Color240 118

165+ | r <= 175 && g <= 95 && b <= 255 = Color240 119

166+ | r <= 175 && g <= 135 && b <= 0 = Color240 120

167+ | r <= 175 && g <= 135 && b <= 95 = Color240 121

168+ | r <= 175 && g <= 135 && b <= 135 = Color240 122

169+ | r <= 175 && g <= 135 && b <= 175 = Color240 123

170+ | r <= 175 && g <= 135 && b <= 215 = Color240 124

171+ | r <= 175 && g <= 135 && b <= 255 = Color240 125

172+ | r <= 175 && g <= 175 && b <= 0 = Color240 126

173+ | r <= 175 && g <= 175 && b <= 95 = Color240 127

174+ | r <= 175 && g <= 175 && b <= 135 = Color240 128

175+ | r <= 175 && g <= 175 && b <= 175 = Color240 129

176+ | r <= 175 && g <= 175 && b <= 215 = Color240 130

177+ | r <= 175 && g <= 175 && b <= 255 = Color240 131

178+ | r <= 175 && g <= 215 && b <= 0 = Color240 132

179+ | r <= 175 && g <= 215 && b <= 95 = Color240 133

180+ | r <= 175 && g <= 215 && b <= 135 = Color240 134

181+ | r <= 175 && g <= 215 && b <= 175 = Color240 135

182+ | r <= 175 && g <= 215 && b <= 215 = Color240 136

183+ | r <= 175 && g <= 215 && b <= 255 = Color240 137

184+ | r <= 175 && g <= 255 && b <= 0 = Color240 138

185+ | r <= 175 && g <= 255 && b <= 95 = Color240 139

186+ | r <= 175 && g <= 255 && b <= 135 = Color240 140

187+ | r <= 175 && g <= 255 && b <= 175 = Color240 141

188+ | r <= 175 && g <= 255 && b <= 215 = Color240 142

189+ | r <= 175 && g <= 255 && b <= 255 = Color240 143

190+ | r <= 215 && g <= 0 && b <= 0 = Color240 144

191+ | r <= 215 && g <= 0 && b <= 95 = Color240 145

192+ | r <= 215 && g <= 0 && b <= 135 = Color240 146

193+ | r <= 215 && g <= 0 && b <= 175 = Color240 147

194+ | r <= 215 && g <= 0 && b <= 215 = Color240 148

195+ | r <= 215 && g <= 0 && b <= 255 = Color240 149

196+ | r <= 215 && g <= 95 && b <= 0 = Color240 150

197+ | r <= 215 && g <= 95 && b <= 95 = Color240 151

198+ | r <= 215 && g <= 95 && b <= 135 = Color240 152

199+ | r <= 215 && g <= 95 && b <= 175 = Color240 153

200+ | r <= 215 && g <= 95 && b <= 215 = Color240 154

201+ | r <= 215 && g <= 95 && b <= 255 = Color240 155

202+ | r <= 215 && g <= 135 && b <= 0 = Color240 156

203+ | r <= 215 && g <= 135 && b <= 95 = Color240 157

204+ | r <= 215 && g <= 135 && b <= 135 = Color240 158

205+ | r <= 215 && g <= 135 && b <= 175 = Color240 159

206+ | r <= 215 && g <= 135 && b <= 215 = Color240 160

207+ | r <= 215 && g <= 135 && b <= 255 = Color240 161

208+ | r <= 215 && g <= 175 && b <= 0 = Color240 162

209+ | r <= 215 && g <= 175 && b <= 95 = Color240 163

210+ | r <= 215 && g <= 175 && b <= 135 = Color240 164

211+ | r <= 215 && g <= 175 && b <= 175 = Color240 165

212+ | r <= 215 && g <= 175 && b <= 215 = Color240 166

213+ | r <= 215 && g <= 175 && b <= 255 = Color240 167

214+ | r <= 215 && g <= 215 && b <= 0 = Color240 168

215+ | r <= 215 && g <= 215 && b <= 95 = Color240 169

216+ | r <= 215 && g <= 215 && b <= 135 = Color240 170

217+ | r <= 215 && g <= 215 && b <= 175 = Color240 171

218+ | r <= 215 && g <= 215 && b <= 215 = Color240 172

219+ | r <= 215 && g <= 215 && b <= 255 = Color240 173

220+ | r <= 215 && g <= 255 && b <= 0 = Color240 174

221+ | r <= 215 && g <= 255 && b <= 95 = Color240 175

222+ | r <= 215 && g <= 255 && b <= 135 = Color240 176

223+ | r <= 215 && g <= 255 && b <= 175 = Color240 177

224+ | r <= 215 && g <= 255 && b <= 215 = Color240 178

225+ | r <= 215 && g <= 255 && b <= 255 = Color240 179

226+ | r <= 255 && g <= 0 && b <= 0 = Color240 180

227+ | r <= 255 && g <= 0 && b <= 95 = Color240 181

228+ | r <= 255 && g <= 0 && b <= 135 = Color240 182

229+ | r <= 255 && g <= 0 && b <= 175 = Color240 183

230+ | r <= 255 && g <= 0 && b <= 215 = Color240 184

231+ | r <= 255 && g <= 0 && b <= 255 = Color240 185

232+ | r <= 255 && g <= 95 && b <= 0 = Color240 186

233+ | r <= 255 && g <= 95 && b <= 95 = Color240 187

234+ | r <= 255 && g <= 95 && b <= 135 = Color240 188

235+ | r <= 255 && g <= 95 && b <= 175 = Color240 189

236+ | r <= 255 && g <= 95 && b <= 215 = Color240 190

237+ | r <= 255 && g <= 95 && b <= 255 = Color240 191

238+ | r <= 255 && g <= 135 && b <= 0 = Color240 192

239+ | r <= 255 && g <= 135 && b <= 95 = Color240 193

240+ | r <= 255 && g <= 135 && b <= 135 = Color240 194

241+ | r <= 255 && g <= 135 && b <= 175 = Color240 195

242+ | r <= 255 && g <= 135 && b <= 215 = Color240 196

243+ | r <= 255 && g <= 135 && b <= 255 = Color240 197

244+ | r <= 255 && g <= 175 && b <= 0 = Color240 198

245+ | r <= 255 && g <= 175 && b <= 95 = Color240 199

246+ | r <= 255 && g <= 175 && b <= 135 = Color240 200

247+ | r <= 255 && g <= 175 && b <= 175 = Color240 201

248+ | r <= 255 && g <= 175 && b <= 215 = Color240 202

249+ | r <= 255 && g <= 175 && b <= 255 = Color240 203

250+ | r <= 255 && g <= 215 && b <= 0 = Color240 204

251+ | r <= 255 && g <= 215 && b <= 95 = Color240 205

252+ | r <= 255 && g <= 215 && b <= 135 = Color240 206

253+ | r <= 255 && g <= 215 && b <= 175 = Color240 207

254+ | r <= 255 && g <= 215 && b <= 215 = Color240 208

255+ | r <= 255 && g <= 215 && b <= 255 = Color240 209

256+ | r <= 255 && g <= 255 && b <= 0 = Color240 210

257+ | r <= 255 && g <= 255 && b <= 95 = Color240 211

258+ | r <= 255 && g <= 255 && b <= 135 = Color240 212

259+ | r <= 255 && g <= 255 && b <= 175 = Color240 213

260+ | r <= 255 && g <= 255 && b <= 215 = Color240 214

261+ | r <= 255 && g <= 255 && b <= 255 = Color240 215

262+ | otherwise = error (printf "RGB color %d %d %d does not map to 240 palette."

44263 (fromIntegral r :: Int)

45264 (fromIntegral g :: Int)

46− (fromIntegral b :: Int)))

47−

48−simpleColor_ :: Integral i => Word8 -> i -> Word8

49−simpleColor_ e c

50− | c <= 0 = 0

51− | c <= 95 = 1

52− | c <= 255 = fromIntegral ((c-16) `div` 40)

53− | otherwise = e

265+ (fromIntegral b :: Int))

54266

55267-- | Create a RGB triple from a value in the Color240 set.

56268color240CodeToRGB :: Word8 -> Maybe (Int, Int, Int)

src/Graphics/Vty/Config.hs+65−247

@@ -3,7 +3,6 @@

33{-# LANGUAGE FlexibleContexts, FlexibleInstances #-}

44{-# LANGUAGE TypeOperators #-}

55{-# LANGUAGE ScopedTypeVariables #-}

6−{-# LANGUAGE LambdaCase, MultiWayIf #-}

76-- | Vty supports a configuration file format and associated 'Config'

87-- data type. The 'Config' can be provided to 'mkVty' to customize the

98-- application's use of Vty.

@@ -55,33 +54,7 @@

5554-- If a debug log is requested then vty will output the current input

5655-- table to the log in the above format. A workflow for using this is

5756-- to set @VTY_DEBUG_LOG@. Run the application. Check the debug log for

58−-- incorrect mappings. Add corrected mappings to @$HOME\/.vty\/config@.

59−--

60−-- = Unicode Character Width Maps

61−--

62−-- == @widthMap@

63−--

64−-- Format:

65−--

66−-- @

67−-- \"widthMap\" string string

68−-- @

69−--

70−-- E.g.,

71−--

72−-- @

73−-- widthMap \"xterm\" \"\/home\/user\/.vty\/xterm\_map.dat\"

74−-- @

75−--

76−-- This directive specifies the path to a Unicode character width

77−-- map (the second argument) that should be loaded and used when

78−-- the value of TERM matches the first argument. Unicode character

79−-- width maps can be produced either by running the provided binary

80−-- @vty-build-width-table@ or by calling the library routine

81−-- 'Graphics.Vty.UnicodeWidthTable.Query.buildUnicodeWidthTable'. The

82−-- 'Graphics.Vty.mkVty' function will use these configuration settings

83−-- to attempt to load and install the specified width map. See the

84−-- documentation for 'Graphics.Vty.mkVty' for details.

57+-- incorrect mappings. Add corrected mappings to @$HOME/.vty/config@.

8558module Graphics.Vty.Config

8659 ( InputMap

8760 , Config(..)

@@ -92,17 +65,6 @@ module Graphics.Vty.Config

9265 , runParseConfig

9366 , parseConfigFile

9467 , defaultConfig

95− , getTtyEraseChar

96− , currentTerminalName

97−

98− , vtyConfigPath

99− , widthTableFilename

100− , vtyDataDirectory

101− , terminalWidthTablePath

102− , vtyConfigFileEnvName

103−

104− , ConfigUpdateResult(..)

105− , addConfigWidthMap

10668 )

10769where

10870

@@ -114,40 +76,32 @@ import Control.Exception (catch, IOException, Exception(..), throwIO)

11476import Control.Monad (liftM, guard, void)

11577

11678import qualified Data.ByteString as BS

117−#if !(MIN_VERSION_base(4,8,0))

11879import Data.Monoid (Monoid(..))

119−#endif

12080#if !(MIN_VERSION_base(4,11,0))

12181import Data.Semigroup (Semigroup(..))

12282#endif

12383import Data.Typeable (Typeable)

12484

12585import Graphics.Vty.Input.Events

126−import Graphics.Vty.Attributes.Color (ColorMode(..), detectColorMode)

12786

12887import GHC.Generics

12988

130−import System.Directory ( getAppUserDataDirectory, doesFileExist

131− , createDirectoryIfMissing

132− )

133−import System.Environment (lookupEnv)

134−import System.FilePath ((</>), takeDirectory)

89+import System.Directory (getAppUserDataDirectory)

90+import System.Posix.Env (getEnv)

13591import System.Posix.IO (stdInput, stdOutput)

13692import System.Posix.Types (Fd(..))

137−import Foreign.C.Types (CInt(..), CChar(..))

13893

13994import Text.Parsec hiding ((<|>))

14095import Text.Parsec.Token ( GenLanguageDef(..) )

14196import qualified Text.Parsec.Token as P

14297

14398-- | Type of errors that can be thrown when configuring VTY

144−data VtyConfigurationError =

145− VtyMissingTermEnvVar

146− -- ^ TERM environment variable not set

147− deriving (Show, Eq, Typeable)

99+data VtyConfigurationError

100+ = VtyMissingTermEnvVar -- ^ TERM environment variable not set

101+ deriving (Show, Eq, Typeable)

148102

149103instance Exception VtyConfigurationError where

150− displayException VtyMissingTermEnvVar = "TERM environment variable not set"

104+ displayException VtyMissingTermEnvVar = "TERM environment variable not set"

151105

152106-- | Mappings from input bytes to event in the order specified. Later

153107-- entries take precedence over earlier in the case multiple entries

@@ -155,144 +109,90 @@ instance Exception VtyConfigurationError where

155109type InputMap = [(Maybe String, String, Event)]

156110

157111-- | A Vty configuration.

158−data Config =

159− Config { vmin :: Maybe Int

160− -- ^ The default is 1 character.

161− , vtime :: Maybe Int

162− -- ^ The default is 100 milliseconds, 0.1 seconds.

163− , mouseMode :: Maybe Bool

164− -- ^ The default is False.

165− , bracketedPasteMode :: Maybe Bool

166− -- ^ The default is False.

167− , debugLog :: Maybe FilePath

168− -- ^ Debug information is appended to this file if not

169− -- Nothing.

170− , inputMap :: InputMap

171− -- ^ The (input byte, output event) pairs extend the internal

172− -- input table of VTY and the table from terminfo.

173− --

174− -- See "Graphics.Vty.Config" module documentation for

175− -- documentation of the @map@ directive.

176− , inputFd :: Maybe Fd

177− -- ^ The input file descriptor to use. The default is

178− -- 'System.Posix.IO.stdInput'

179− , outputFd :: Maybe Fd

180− -- ^ The output file descriptor to use. The default is

181− -- 'System.Posix.IO.stdOutput'

182− , termName :: Maybe String

183− -- ^ The terminal name used to look up terminfo capabilities.

184− -- The default is the value of the TERM environment variable.

185− , termWidthMaps :: [(String, FilePath)]

186− -- ^ Terminal width map files.

187− , allowCustomUnicodeWidthTables :: Maybe Bool

188− -- ^ Whether to permit custom Unicode width table loading by

189− -- 'Graphics.Vty.mkVty'. @'Just' 'False'@ indicates that

190− -- table loading should not be performed. Other values permit

191− -- table loading.

192− --

193− -- If a table load is attempted and fails, information

194− -- about the failure will be logged to the debug log if the

195− -- configuration specifies one. If no custom table is loaded

196− -- (or if a load fails), the built-in character width table

197− -- will be used.

198− , colorMode :: Maybe ColorMode

199− -- ^ The color mode used to know how many colors the terminal

200− -- supports.

201− }

202− deriving (Show, Eq)

112+data Config = Config

113+ {

114+ -- | The default is 1 character.

115+ vmin :: Maybe Int

116+ -- | The default is 100 milliseconds, 0.1 seconds.

117+ , vtime :: Maybe Int

118+ -- | The default is False.

119+ , mouseMode :: Maybe Bool

120+ -- | The default is False.

121+ , bracketedPasteMode :: Maybe Bool

122+ -- | Debug information is appended to this file if not Nothing.

123+ , debugLog :: Maybe FilePath

124+ -- | The (input byte, output event) pairs extend the internal input

125+ -- table of VTY and the table from terminfo.

126+ --

127+ -- See "Graphics.Vty.Config" module documentation for documentation

128+ -- of the @map@ directive.

129+ , inputMap :: InputMap

130+ -- | The input file descriptor to use. The default is

131+ -- 'System.Posix.IO.stdInput'

132+ , inputFd :: Maybe Fd

133+ -- | The output file descriptor to use. The default is

134+ -- 'System.Posix.IO.stdOutput'

135+ , outputFd :: Maybe Fd

136+ -- | The terminal name used to look up terminfo capabilities.

137+ -- The default is the value of the TERM environment variable.

138+ , termName :: Maybe String

139+ } deriving (Show, Eq)

203140

204141defaultConfig :: Config

205142defaultConfig = mempty

206143

207144instance Semigroup Config where

208− c0 <> c1 =

145+ c0 <> c1 = Config

209146 -- latter config takes priority for everything but inputMap

210− Config { vmin = vmin c1 <|> vmin c0

211− , vtime = vtime c1 <|> vtime c0

212− , mouseMode = mouseMode c1

213− , bracketedPasteMode = bracketedPasteMode c1

214− , debugLog = debugLog c1 <|> debugLog c0

215− , inputMap = inputMap c0 <> inputMap c1

216− , inputFd = inputFd c1 <|> inputFd c0

217− , outputFd = outputFd c1 <|> outputFd c0

218− , termName = termName c1 <|> termName c0

219− , termWidthMaps = termWidthMaps c1 <|> termWidthMaps c0

220− , allowCustomUnicodeWidthTables =

221− allowCustomUnicodeWidthTables c1 <|> allowCustomUnicodeWidthTables c0

222− , colorMode = colorMode c1 <|> colorMode c0

223− }

147+ { vmin = vmin c1 <|> vmin c0

148+ , vtime = vtime c1 <|> vtime c0

149+ , mouseMode = mouseMode c1

150+ , bracketedPasteMode = bracketedPasteMode c1

151+ , debugLog = debugLog c1 <|> debugLog c0

152+ , inputMap = inputMap c0 <> inputMap c1

153+ , inputFd = inputFd c1 <|> inputFd c0

154+ , outputFd = outputFd c1 <|> outputFd c0

155+ , termName = termName c1 <|> termName c0

156+ }

224157

225158instance Monoid Config where

226− mempty =

227− Config { vmin = Nothing

228− , vtime = Nothing

229− , mouseMode = Nothing

230− , bracketedPasteMode = Nothing

231− , debugLog = mempty

232− , inputMap = mempty

233− , inputFd = Nothing

234− , outputFd = Nothing

235− , termName = Nothing

236− , termWidthMaps = []

237− , allowCustomUnicodeWidthTables = Nothing

238− , colorMode = Nothing

239− }

159+ mempty = Config

160+ { vmin = Nothing

161+ , vtime = Nothing

162+ , mouseMode = Nothing

163+ , bracketedPasteMode = Nothing

164+ , debugLog = mempty

165+ , inputMap = mempty

166+ , inputFd = Nothing

167+ , outputFd = Nothing

168+ , termName = Nothing

169+ }

240170#if !(MIN_VERSION_base(4,11,0))

241171 mappend = (<>)

242172#endif

243173

244−vtyDataDirectory :: IO FilePath

245−vtyDataDirectory = getAppUserDataDirectory "vty"

246−

247−vtyConfigPath :: IO FilePath

248−vtyConfigPath = do

249− dir <- vtyDataDirectory

250− return $ dir </> "config"

251−

252−vtyConfigFileEnvName :: String

253−vtyConfigFileEnvName = "VTY_CONFIG_FILE"

254−

255−-- | Load a configuration from 'vtyConfigPath' and @$VTY_CONFIG_FILE@.

174+-- | Load a configuration from @'getAppUserDataDirectory'/config@ and

175+-- @$VTY_CONFIG_FILE@.

256176userConfig :: IO Config

257177userConfig = do

258− configFile <- vtyConfigPath >>= parseConfigFile

259− overrideConfig <- maybe (return defaultConfig) parseConfigFile =<<

260− lookupEnv vtyConfigFileEnvName

178+ configFile <- (mappend <$> getAppUserDataDirectory "vty" <*> pure "/config") >>= parseConfigFile

179+ overrideConfig <- maybe (return defaultConfig) parseConfigFile =<< getEnv "VTY_CONFIG_FILE"

261180 let base = configFile <> overrideConfig

262181 mappend base <$> overrideEnvConfig

263182

264−widthTableFilename :: String -> String

265−widthTableFilename term = "width_table_" <> term <> ".dat"

266−

267−termVariable :: String

268−termVariable = "TERM"

269−

270−currentTerminalName :: IO (Maybe String)

271−currentTerminalName = lookupEnv termVariable

272−

273−terminalWidthTablePath :: IO (Maybe FilePath)

274−terminalWidthTablePath = do

275− dataDir <- vtyDataDirectory

276− result <- lookupEnv termVariable

277− case result of

278− Nothing -> return Nothing

279− Just term -> do

280− return $ Just $ dataDir </> widthTableFilename term

281−

282183overrideEnvConfig :: IO Config

283184overrideEnvConfig = do

284− d <- lookupEnv "VTY_DEBUG_LOG"

185+ d <- getEnv "VTY_DEBUG_LOG"

285186 return $ defaultConfig { debugLog = d }

286187

287188-- | Configures VTY using defaults suitable for terminals. This function

288189-- can raise 'VtyConfigurationError'.

289190standardIOConfig :: IO Config

290191standardIOConfig = do

291− mb <- lookupEnv termVariable

192+ mb <- getEnv "TERM"

292193 case mb of

293194 Nothing -> throwIO VtyMissingTermEnvVar

294− Just t -> do

295− mcolorMode <- detectColorMode t

195+ Just t ->

296196 return defaultConfig

297197 { vmin = Just 1

298198 , mouseMode = Just False

@@ -301,7 +201,6 @@ standardIOConfig = do

301201 , inputFd = Just stdInput

302202 , outputFd = Just stdOutput

303203 , termName = Just t

304− , colorMode = Just mcolorMode

305204 }

306205

307206parseConfigFile :: FilePath -> IO Config

@@ -353,20 +252,13 @@ debugLogDecl = do

353252 path <- P.stringLiteral configLexer

354253 return defaultConfig { debugLog = Just path }

355254

356−widthMapDecl :: Parser Config

357−widthMapDecl = do

358− "widthMap" <- P.identifier configLexer

359− tName <- P.stringLiteral configLexer

360− path <- P.stringLiteral configLexer

361− return defaultConfig { termWidthMaps = [(tName, path)] }

362−

363255ignoreLine :: Parser ()

364256ignoreLine = void $ manyTill anyChar newline

365257

366258parseConfig :: Parser Config

367259parseConfig = liftM mconcat $ many $ do

368260 P.whiteSpace configLexer

369− let directives = [try mapDecl, try debugLogDecl, try widthMapDecl]

261+ let directives = [try mapDecl, try debugLogDecl]

370262 choice directives <|> (ignoreLine >> return defaultConfig)

371263

372264class Parse a where parseValue :: Parser a

@@ -412,77 +304,3 @@ instance (GParseAlts f, GParseAlts g) => GParseAlts (f :+: g) where

412304 gparseAlts con = L1 <$> gparseAlts con <|> R1 <$> gparseAlts con

413305

414306instance GParseAlts V1 where gparseAlts _ = fail "GParse: V1"

415−

416−foreign import ccall "vty_get_tty_erase" cGetTtyErase :: Fd -> IO CChar

417−

418−-- | Get the "erase" character for the terminal attached to the

419−-- specified file descriptor. This is the character configured by 'stty

420−-- erase'. If the call to 'tcgetattr' fails, this will return 'Nothing'.

421−-- Otherwise it will return the character that has been configured to

422−-- indicate the canonical mode ERASE behavior. That character can then

423−-- be added to the table of strings that we interpret to mean Backspace.

424−--

425−-- For more details, see:

426−--

427−-- * https://www.gnu.org/software/libc/manual/html_node/Canonical-or-Not.html

428−-- * https://www.gsp.com/cgi-bin/man.cgi?section=1&topic=stty

429−-- * https://github.com/matterhorn-chat/matterhorn/issues/565

430−getTtyEraseChar :: Fd -> IO (Maybe Char)

431−getTtyEraseChar fd = do

432− c <- cGetTtyErase fd

433− if c /= 0

434− then return $ Just $ toEnum $ fromEnum c

435− else return Nothing

436−

437−data ConfigUpdateResult =

438− ConfigurationCreated

439− | ConfigurationModified

440− | ConfigurationConflict String

441− | ConfigurationRedundant

442− deriving (Eq, Show)

443−

444−-- | Add a @widthMap@ directive to the Vty configuration file at the

445−-- specified path.

446−--

447−-- If the configuration path refers to a configuration that already

448−-- contains the directive for the specified map and terminal type, the

449−-- configuration file will not be modified. If the file does not contain

450−-- the directive, it will be appended to the file.

451−--

452−-- If the configuration path does not exist, a new configuration file

453−-- will be created and any directories in the path will also be created.

454−--

455−-- This returns @True@ if the configuration was created or modified and

456−-- @False@ otherwise. This does not handle exceptions raised by file or

457−-- directory permissions issues.

458−addConfigWidthMap :: FilePath

459− -- ^ The configuration file path of the configuration

460− -- to modify or create.

461− -> String

462− -- ^ The @TERM@ value for the @widthMap@ directive.

463− -> FilePath

464− -- ^ The width table file path for the directive.

465− -> IO ConfigUpdateResult

466−addConfigWidthMap configPath term tablePath = do

467− configEx <- doesFileExist configPath

468− if configEx

469− then updateConfig

470− else createConfig >> return ConfigurationCreated

471−

472− where

473− directive = "widthMap " <> show term <> " " <> show tablePath <> "\n"

474−

475− createConfig = do

476− let dir = takeDirectory configPath

477− createDirectoryIfMissing True dir

478− writeFile configPath directive

479−

480− updateConfig = do

481− config <- parseConfigFile configPath

482− if (term, tablePath) `elem` termWidthMaps config

483− then return ConfigurationRedundant

484− else case lookup term (termWidthMaps config) of

485− Just other -> return $ ConfigurationConflict other

486− Nothing -> do

487− appendFile configPath directive

488− return ConfigurationModified

src/Graphics/Vty/Debug.hs+6−6

@@ -12,16 +12,16 @@ import Graphics.Vty.Span

1212

1313import qualified Data.Vector as Vector

1414

15−rowOpsAffectedColumns :: DisplayOps -> [Int]

16−rowOpsAffectedColumns ops

17− = Vector.toList $ Vector.map spanOpsAffectedColumns ops

15+rowOpsEffectedColumns :: DisplayOps -> [Int]

16+rowOpsEffectedColumns ops

17+ = Vector.toList $ Vector.map spanOpsEffectedColumns ops

1818

1919allSpansHaveWidth :: DisplayOps -> Int -> Bool

2020allSpansHaveWidth ops expected

21− = all (== expected) $ Vector.toList $ Vector.map spanOpsAffectedColumns ops

21+ = all (== expected) $ Vector.toList $ Vector.map spanOpsEffectedColumns ops

2222

23−spanOpsAffectedRows :: DisplayOps -> Int

24−spanOpsAffectedRows ops

23+spanOpsEffectedRows :: DisplayOps -> Int

24+spanOpsEffectedRows ops

2525 = toEnum $ length (filter (not . null . Vector.toList) (Vector.toList ops))

2626

2727type SpanConstructLog = [SpanConstructEvent]

src/Graphics/Vty/DisplayAttributes.hs−3

@@ -96,8 +96,6 @@ data StyleStateChange

9696 | RemoveStandout

9797 | ApplyItalic

9898 | RemoveItalic

99− | ApplyStrikethrough

100− | RemoveStrikethrough

10199 | ApplyUnderline

102100 | RemoveUnderline

103101 | ApplyReverseVideo

@@ -146,7 +144,6 @@ diffStyles prev cur

146144 [ styleDiff standout ApplyStandout RemoveStandout

147145 , styleDiff underline ApplyUnderline RemoveUnderline

148146 , styleDiff italic ApplyItalic RemoveItalic

149− , styleDiff strikethrough ApplyStrikethrough RemoveStrikethrough

150147 , styleDiff reverseVideo ApplyReverseVideo RemoveReverseVideo

151148 , styleDiff blink ApplyBlink RemoveBlink

152149 , styleDiff dim ApplyDim RemoveDim

src/Graphics/Vty/Image.hs+13−18

@@ -1,4 +1,5 @@

2+{-# LANGUAGE BangPatterns #-}

23{-# LANGUAGE NamedFieldPuns #-}

34{-# LANGUAGE DisambiguateRecordFields #-}

45-- | A Vty program makes 'Picture's from 'Image's. This module provides

@@ -45,12 +46,8 @@ module Graphics.Vty.Image

4546 -- * Character width functions

4647 , safeWcwidth

4748 , safeWcswidth

48− , safeWctwidth

49− , safeWctlwidth

5049 , wcwidth

5150 , wcswidth

52− , wctwidth

53− , wctlwidth

5451 -- * Display Regions

5552 , DisplayText

5653 , DisplayRegion

@@ -116,18 +113,16 @@ horizCat = foldr horizJoin EmptyImage

116113vertCat :: [Image] -> Image

117114vertCat = foldr vertJoin EmptyImage

118115

119−-- | Make an 'Image' from a lazy text value. The text value should be

120−-- sanitized of escape sequences (ASCII 27) and carriage returns;

121−-- otherwise layout and attribute problems may result.

116+-- | Make an 'Image' from a lazy text value. This function should not be

117+-- given a text value containing escapes.

122118text :: Attr -> TL.Text -> Image

123−text a txt = let displayWidth = safeWctlwidth txt

119+text a txt = let displayWidth = safeWcswidth (TL.unpack txt)

124120 in HorizText a txt displayWidth (fromIntegral $! TL.length txt)

125121

126−-- | Make an 'Image' from a text value. The text value should be

127−-- sanitized of escape sequences (ASCII 27) and carriage returns;

128−-- otherwise layout and attribute problems may result.

122+-- | Make an 'Image' from a text value. This function should not be

123+-- given a text value containing escapes.

129124text' :: Attr -> T.Text -> Image

130−text' a txt = let displayWidth = safeWctwidth txt

125+text' a txt = let displayWidth = safeWcswidth (T.unpack txt)

131126 in HorizText a (TL.fromStrict txt) displayWidth (T.length txt)

132127

133128-- | Make an image from a single character. This is a standard Haskell

@@ -137,11 +132,10 @@ char a c =

137132 let displayWidth = safeWcwidth c

138133 in HorizText a (TL.singleton c) displayWidth 1

139134

140−-- | Make an image from a string of characters laid out on a single

135+-- | Make an image from a string of characters layed out on a single

141136-- row with the same display attribute. The string is assumed to be a

142−-- sequence of ISO-10646 characters. The input string should be

143−-- sanitized of escape sequences (ASCII 27) and carriage returns;

144−-- otherwise layout and attribute problems may result.

137+-- sequence of ISO-10646 characters. This function should not be given a

138+-- string containing escapes.

145139--

146140-- Note: depending on how the Haskell compiler represents string

147141-- literals, a string literal in a UTF-8 encoded source file, for

@@ -158,7 +152,8 @@ iso10646String a str =

158152--

159153-- This is an alias for iso10646String since the usual case is that a

160154-- literal string like "foo" is represented internally as a list of ISO

161−-- 10646 31 bit characters.

155+-- 10646 31 bit characters. This function should not be given a string

156+-- containing escapes.

162157--

163158-- Note: Keep in mind that GHC will compile source encoded as UTF-8

164159-- but the literal strings, while UTF-8 encoded in the source, will be

@@ -175,7 +170,7 @@ utf8String a bytes = utf8Bytestring a (BL.pack bytes)

175170utf8Bytestring :: Attr -> BL.ByteString -> Image

176171utf8Bytestring a bs = text a (TL.decodeUtf8 bs)

177172

178−-- | Make an 'Image' from a UTF-8 encoded strict bytestring.

173+-- | Make an 'Image' from a UTF-8 encoded lazy bytestring.

179174utf8Bytestring' :: Attr -> B.ByteString -> Image

180175utf8Bytestring' a bs = text' a (T.decodeUtf8 bs)

181176

src/Graphics/Vty/Image/Internal.hs+3−3

@@ -146,7 +146,7 @@ data Image =

146146

147147-- | pretty print just the structure of an image.

148148ppImageStructure :: Image -> String

149−ppImageStructure = go 0

149+ppImageStructure inImg = go 0 inImg

150150 where

151151 go indent img = tab indent ++ pp indent img

152152 tab indent = concat $ replicate indent " "

@@ -228,7 +228,7 @@ instance Monoid Image where

228228--

229229-- The result image will have a width equal to the sum of the two images

230230-- width. And the height will equal the largest height of the two

231−-- images. The area not defined in one image due to a height mismatch

231+-- images. The area not defined in one image due to a height missmatch

232232-- will be filled with the background pattern.

233233horizJoin :: Image -> Image -> Image

234234horizJoin EmptyImage i = i

@@ -259,7 +259,7 @@ horizJoin _ _ = error "horizJoin applied to undefined values."

259259--

260260-- The result image will have a height equal to the sum of the heights

261261-- of both images. The width will equal the largest width of the two

262−-- images. The area not defined in one image due to a width mismatch

262+-- images. The area not defined in one image due to a width missmatch

263263-- will be filled with the background pattern.

264264vertJoin :: Image -> Image -> Image

265265vertJoin EmptyImage i = i

src/Graphics/Vty/Inline.hs+7−5

@@ -1,3 +1,5 @@

1+{-# LANGUAGE BangPatterns #-}

13-- | The inline module provides a limited interface to changing the

24-- style of terminal output. The intention is for this interface to be

35-- used inline with other output systems.

@@ -56,13 +58,13 @@ data InlineState =

5658-- | Set the background color to the provided 'Color'.

5759backColor :: Color -> InlineM ()

5860backColor c = modify $ \s ->

59− s { inlineAttr = inlineAttr s `withBackColor` c

61+ s { inlineAttr = inlineAttr s `mappend` (currentAttr `withBackColor` c)

6062 }

6163

6264-- | Set the foreground color to the provided 'Color'.

6365foreColor :: Color -> InlineM ()

6466foreColor c = modify $ \s ->

65− s { inlineAttr = inlineAttr s `withForeColor` c

67+ s { inlineAttr = inlineAttr s `mappend` (currentAttr `withForeColor` c)

6668 }

6769

6870-- | Attempt to change the 'Style' of the following text..

@@ -71,7 +73,7 @@ foreColor c = modify $ \s ->

7173-- produced. The style can still be removed.

7274applyStyle :: Style -> InlineM ()

7375applyStyle st = modify $ \s ->

74− s { inlineAttr = inlineAttr s `withStyle` st

76+ s { inlineAttr = inlineAttr s `mappend` (currentAttr `withStyle` st)

7577 }

7678

7779-- | Attempt to remove the specified 'Style' from the display of the

@@ -83,8 +85,8 @@ removeStyle :: Style -> InlineM ()

8385removeStyle sMask = modify $ \s ->

8486 s { inlineAttr =

8587 let style' = case attrStyle (inlineAttr s) of

86− Default -> error "Graphics.Vty.Inline: Cannot removeStyle if applyStyle never used."

87− KeepCurrent -> error "Graphics.Vty.Inline: Cannot removeStyle if applyStyle never used."

88+ Default -> error $ "Graphics.Vty.Inline: Cannot removeStyle if applyStyle never used."

89+ KeepCurrent -> error $ "Graphics.Vty.Inline: Cannot removeStyle if applyStyle never used."

8890 SetTo st -> st .&. complement sMask

8991 in (inlineAttr s) { attrStyle = SetTo style' }

9092 }

src/Graphics/Vty/Input.hs+23−14

@@ -1,4 +1,4 @@

1−{-# LANGUAGE RecordWildCards, CPP #-}

1+{-# LANGUAGE RecordWildCards #-}

33-- | This module provides the input layer for Vty, including methods

44-- for initializing an 'Input' structure and reading 'Event's from the

@@ -77,7 +77,7 @@

7777-- The input encoding determines how UTF-8 encoded characters are

7878-- recognized.

7979--

80−-- * 7-bit mode: UTF-8 can be input unambiguously. UTF-8 input is

80+-- * 7-bit mode: UTF-8 can be input unambiguiously. UTF-8 input is

8181-- a superset of ASCII. UTF-8 does not overlap escaped control key

8282-- sequences. However, the escape key must be differentiated from

8383-- escaped control key sequences by the timing of the input bytes.

@@ -95,7 +95,7 @@

9595--

9696-- == Terminal Input is Broken

9797--

98−-- Clearly terminal input has fundamental issues. There is no easy way

98+-- Clearly terminal input has fundemental issues. There is no easy way

9999-- to reliably resolve these issues.

100100--

101101-- One resolution would be to ditch standard terminal interfaces

@@ -132,9 +132,7 @@ import Lens.Micro

132132import qualified System.Console.Terminfo as Terminfo

133133import System.Posix.Signals.Exts

134134

135−#if !MIN_VERSION_base(4,11,0)

136135import Data.Monoid ((<>))

137−#endif

138136

139137-- | Set up the terminal with file descriptor `inputFd` for input.

140138-- Returns an 'Input'.

@@ -143,8 +141,22 @@ import Data.Monoid ((<>))

143141-- bytes comes from 'classifyMapForTerm' which is then overridden by

144142-- the the applicable entries from the configuration's 'inputMap'.

145143--

146−-- The terminal device's mode flags are configured by the

147−-- 'attributeControl' function.

144+-- The terminal device is configured with the attributes:

145+--

146+-- * IXON disabled: disables software flow control on outgoing data.

147+-- This stops the process from being suspended if the output terminal

148+-- cannot keep up.

149+--

150+-- * Raw mode is used for input.

151+--

152+-- * ISIG disabled (enables keyboard combinations that result in

153+-- signals)

154+--

155+-- * ECHO disabled (input is not echoed to the output)

156+--

157+-- * ICANON disabled (canonical mode (line mode) input is not used)

158+--

159+-- * IEXTEN disabled (extended functions are disabled)

148160inputForConfig :: Config -> IO Input

149161inputForConfig config@Config{ termName = Just termName

150162 , inputFd = Just termFd

@@ -154,23 +166,20 @@ inputForConfig config@Config{ termName = Just termName

154166 terminal <- Terminfo.setupTerm termName

155167 let inputOverrides = [(s,e) | (t,s,e) <- inputMap, t == Nothing || t == Just termName]

156168 activeInputMap = classifyMapForTerm termName terminal `mappend` inputOverrides

157− (setAttrs, unsetAttrs) <- attributeControl termFd

169+ (setAttrs,unsetAttrs) <- attributeControl termFd

158170 setAttrs

159171 input <- initInput config activeInputMap

160172 let pokeIO = Catch $ do

173+ let e = error "vty internal failure: this value should not propagate to users"

161174 setAttrs

162− atomically $ writeTChan (input^.eventChannel) ResumeAfterSignal

175+ atomically $ writeTChan (input^.eventChannel) (EvResize e e)

163176 _ <- installHandler windowChange pokeIO Nothing

164177 _ <- installHandler continueProcess pokeIO Nothing

165−

166− let restore = unsetAttrs

167−

168178 return $ input

169179 { shutdownInput = do

170180 shutdownInput input

171181 _ <- installHandler windowChange Ignore Nothing

172182 _ <- installHandler continueProcess Ignore Nothing

173− restore

174− , restoreInputState = restoreInputState input >> restore

183+ unsetAttrs

175184 }

176185inputForConfig config = (<> config) <$> standardIOConfig >>= inputForConfig

src/Graphics/Vty/Input/Classify.hs+29−53

@@ -1,11 +1,10 @@

11{-# OPTIONS_HADDOCK hide #-}

2−-- This makes a kind of trie. Has space efficiency issues with large

2+-- This makes a kind of tri. Has space efficiency issues with large

33-- input blocks. Likely building a parser and just applying that would

44-- be better.

55module Graphics.Vty.Input.Classify

66 ( classify

77 , KClass(..)

8− , ClassifierState(..)

98 )

109where

1110

@@ -17,39 +16,25 @@ import Graphics.Vty.Input.Classify.Types

1716

1817import Codec.Binary.UTF8.Generic (decode)

1918

20−import Control.Arrow (first)

19+import Data.List (inits)

2120import qualified Data.Map as M( fromList, lookup )

2221import Data.Maybe ( mapMaybe )

2322import qualified Data.Set as S( fromList, member )

2423

24+import Data.Char

2525import Data.Word

2626

27−import qualified Data.ByteString as BS

28−import qualified Data.ByteString.Char8 as BS8

29−import Data.ByteString.Char8 (ByteString)

30−

31−-- | Whether the classifier is currently processing a chunked format.

32−-- Currently, only bracketed pastes use this.

33−data ClassifierState

34− = ClassifierStart

35− -- ^ Not processing a chunked format.

36− | ClassifierInChunk ByteString [ByteString]

37− -- ^ Currently processing a chunked format. The initial chunk is in the

38− -- first argument and a reversed remainder of the chunks is collected in

39− -- the second argument. At the end of the processing, the chunks are

40− -- reversed and concatenated with the final chunk.

41−

42−compile :: ClassifyMap -> ByteString -> KClass

27+compile :: ClassifyMap -> [Char] -> KClass

4328compile table = cl' where

4429 -- take all prefixes and create a set of these

45− prefixSet = S.fromList $ concatMap (init . BS.inits . BS8.pack . fst) table

30+ prefixSet = S.fromList $ concatMap (init . inits . fst) $ table

4631 maxValidInputLength = maximum (map (length . fst) table)

47− eventForInput = M.fromList $ map (first BS8.pack) table

48− cl' inputBlock | BS8.null inputBlock = Prefix

32+ eventForInput = M.fromList table

33+ cl' [] = Prefix

4934 cl' inputBlock = case M.lookup inputBlock eventForInput of

5035 -- if the inputBlock is exactly what is expected for an

5136 -- event then consume the whole block and return the event

52− Just e -> Valid e BS8.empty

37+ Just e -> Valid e []

5338 Nothing -> case S.member inputBlock prefixSet of

5439 True -> Prefix

5540 -- look up progressively smaller tails of the input

@@ -60,49 +45,40 @@ compile table = cl' where

6045 -- H: There will always be one match. The prefixSet

6146 -- contains, by definition, all prefixes of an event.

6247 False ->

63− let inputPrefixes = reverse . take maxValidInputLength . tail . BS8.inits $ inputBlock

48+ let inputPrefixes = reverse $ take maxValidInputLength $ tail $ inits inputBlock

6449 in case mapMaybe (\s -> (,) s `fmap` M.lookup s eventForInput) inputPrefixes of

65− (s,e) : _ -> Valid e (BS8.drop (BS8.length s) inputBlock)

50+ (s,e) : _ -> Valid e (drop (length s) inputBlock)

6651 -- neither a prefix or a full event.

6752 [] -> Invalid

6853

69−classify :: ClassifyMap -> ClassifierState -> ByteString -> KClass

70−classify table = process

71− where

72− standardClassifier = compile table

73−

74− process ClassifierStart s =

75− case BS.uncons s of

76− _ | bracketedPasteStarted s ->

77− if bracketedPasteFinished s

78− then parseBracketedPaste s

79− else Chunk

80− _ | isMouseEvent s -> classifyMouseEvent s

81− _ | isFocusEvent s -> classifyFocusEvent s

82− Just (c,cs) | c >= 0xC2 -> classifyUtf8 c cs

83− _ -> standardClassifier s

84−

85− process (ClassifierInChunk p ps) s | bracketedPasteStarted p =

54+classify :: ClassifyMap -> [Char] -> KClass

55+classify table =

56+ let standardClassifier = compile table

57+ in \s -> case s of

58+ _ | bracketedPasteStarted s ->

8659 if bracketedPasteFinished s

87− then parseBracketedPaste $ BS.concat $ p:reverse (s:ps)

88− else Chunk

89− process ClassifierInChunk{} _ = Invalid

60+ then parseBracketedPaste s

61+ else Prefix

62+ _ | isMouseEvent s -> classifyMouseEvent s

63+ _ | isFocusEvent s -> classifyFocusEvent s

64+ c:cs | ord c >= 0xC2 -> classifyUtf8 c cs

65+ _ -> standardClassifier s

9066

91−classifyUtf8 :: Word8 -> ByteString -> KClass

67+classifyUtf8 :: Char -> [Char] -> KClass

9268classifyUtf8 c cs =

93− let n = utf8Length c

94− (codepoint,rest) = BS8.splitAt (n - 1) cs

69+ let n = utf8Length (ord c)

70+ (codepoint,rest) = splitAt n (c:cs)

9571

9672 codepoint8 :: [Word8]

97− codepoint8 = c:BS.unpack codepoint

73+ codepoint8 = map (fromIntegral . ord) codepoint

9874

9975 in case decode codepoint8 of

100− _ | n < BS.length codepoint + 1 -> Prefix

101− Just (unicodeChar, _) -> Valid (EvKey (KChar unicodeChar) []) rest

76+ _ | n < length codepoint -> Prefix

77+ Just (unicodeChar, _) -> Valid (EvKey (KChar unicodeChar) []) rest

10278 -- something bad happened; just ignore and continue.

103− Nothing -> Invalid

79+ Nothing -> Invalid

10480

105−utf8Length :: Word8 -> Int

81+utf8Length :: (Num t, Ord a, Num a) => a -> t

10682utf8Length c

10783 | c < 0x80 = 1

10884 | c < 0xE0 = 2

src/Graphics/Vty/Input/Classify/Parse.hs+7−10

@@ -16,15 +16,12 @@ import Graphics.Vty.Input.Classify.Types

1616import Control.Monad.Trans.Maybe

1717import Control.Monad.State

1818

19−import qualified Data.ByteString.Char8 as BS8

20−import Data.ByteString.Char8 (ByteString)

21−

22−type Parser a = MaybeT (State ByteString) a

19+type Parser a = MaybeT (State String) a

2320

2421-- | Run a parser on a given input string. If the parser fails, return

2522-- 'Invalid'. Otherwise return the valid event ('Valid') and the

2623-- remaining unparsed characters.

27−runParser :: ByteString -> Parser Event -> KClass

24+runParser :: String -> Parser Event -> KClass

2825runParser s parser =

2926 case runState (runMaybeT parser) s of

3027 (Nothing, _) -> Invalid

@@ -39,9 +36,9 @@ failParse = fail "invalid parse"

3936-- return '123' and consume those characters.

4037readInt :: Parser Int

4138readInt = do

42− s <- BS8.unpack <$> get

39+ s <- get

4340 case (reads :: ReadS Int) s of

44− [(i, rest)] -> put (BS8.pack rest) >> return i

41+ [(i, rest)] -> put rest >> return i

4542 _ -> failParse

4643

4744-- | Read a character from the input stream. If one cannot be read (e.g.

@@ -49,9 +46,9 @@ readInt = do

4946readChar :: Parser Char

5047readChar = do

5148 s <- get

52− case BS8.uncons s of

53− Just (c,rest) -> put rest >> return c

54− Nothing -> failParse

49+ case s of

50+ c:rest -> put rest >> return c

51+ _ -> failParse

5552

5653-- | Read a character from the input stream and fail parsing if it is

5754-- not the specified character.

src/Graphics/Vty/Input/Classify/Types.hs+1−7

@@ -1,6 +1,5 @@

11-- | This module exports the input classification type to avoid import

22-- cycles between other modules that need this.

3−{-# LANGUAGE StrictData #-}

43module Graphics.Vty.Input.Classify.Types

54 ( KClass(..)

65 )

@@ -8,10 +7,8 @@ where

98import Graphics.Vty.Input.Events

109

11−import Data.ByteString.Char8 (ByteString)

12−

1310data KClass

14− = Valid Event ByteString

11+ = Valid Event [Char]

1512 -- ^ A valid event was parsed. Any unused characters from the input

1613 -- stream are also provided.

1714 | Invalid

@@ -19,7 +16,4 @@ data KClass

1916 | Prefix

2017 -- ^ The input characters form the prefix of a valid event character

2118 -- sequence.

22− | Chunk

23− -- ^ The input characters are either start of a bracketed paste chunk

24− -- or in the middle of a bracketed paste chunk.

2519 deriving(Show, Eq)

src/Graphics/Vty/Input/Events.hs+6−24

@@ -1,8 +1,6 @@

11{-# Language DeriveGeneric #-}

2−{-# Language StrictData #-}

32module Graphics.Vty.Input.Events where

5−import Control.DeepSeq

64import Data.ByteString

75import GHC.Generics

@@ -16,29 +14,23 @@ import GHC.Generics

1614--

1715-- * Actually, support for most of these but KEsc, KChar, KBS, and

1816-- KEnter vary by terminal and keyboard.

19−data Key = KEsc | KChar {-# UNPACK #-} Char | KBS | KEnter

17+data Key = KEsc | KChar Char | KBS | KEnter

2018 | KLeft | KRight | KUp | KDown

22− | KFun {-# UNPACK #-} Int | KBackTab | KPrtScr | KPause | KIns

2422 deriving (Eq,Show,Read,Ord,Generic)

2523

26−instance NFData Key

27−

2824-- | Modifier keys. Key codes are interpreted such that users are more

2925-- likely to have Meta than Alt; for instance on the PC Linux console,

3026-- 'MMeta' will generally correspond to the physical Alt key.

3127data Modifier = MShift | MCtrl | MMeta | MAlt

3228 deriving (Eq,Show,Read,Ord,Generic)

3329

34−instance NFData Modifier

35−

3630-- | Mouse buttons.

3731data Button = BLeft | BMiddle | BRight | BScrollUp | BScrollDown

3832 deriving (Eq,Show,Read,Ord,Generic)

3933

40−instance NFData Button

41−

4234-- | Events.

4335data Event

4436 = EvKey Key [Modifier]

@@ -52,8 +44,10 @@ data Event

5244 -- without specifying which one; in that case, Nothing is provided.

5345 -- Otherwise Just the button released is included in the event.

5446 | EvResize Int Int

55− -- The terminal window was resized and the size is provided in the

56− -- integer fields (width, height).

47+ -- ^ If read from 'eventChannel' this is the size at the time of the

48+ -- signal. If read from 'nextEvent' this is the size at the time the

49+ -- event was processed by Vty. Typically these are the same, but if

50+ -- somebody is resizing the terminal quickly they can be different.

5751 | EvPaste ByteString

5852 -- ^ A paste event occurs when a bracketed paste input sequence is

5953 -- received. For terminals that support bracketed paste mode, these

@@ -68,16 +62,4 @@ data Event

6862 -- ^ The terminal running the application gained input focus.

6963 deriving (Eq,Show,Read,Ord,Generic)

7064

71−instance NFData Event

72−

7365type ClassifyMap = [(String,Event)]

74−

75−-- | The type of internal events that drive the internal Vty event

76−-- dispatching to the application.

77−data InternalEvent =

78− ResumeAfterSignal

79− -- ^ Vty resumed operation after the process was interrupted with a

80− -- signal. In practice this translates into a screen redraw in the

81− -- input event loop.

82− | InputEvent Event

83− -- ^ An input event was received.

src/Graphics/Vty/Input/Focus.hs+13−15

@@ -11,32 +11,30 @@ import Graphics.Vty.Input.Classify.Types

1111import Graphics.Vty.Input.Classify.Parse

1212

1313import Control.Monad.State

14−

15−import qualified Data.ByteString.Char8 as BS8

16−import Data.ByteString.Char8 (ByteString)

14+import Data.List (isPrefixOf)

1715

1816-- | These sequences set xterm-based terminals to send focus event

1917-- sequences.

20−requestFocusEvents :: ByteString

21−requestFocusEvents = BS8.pack "\ESC[?1004h"

18+requestFocusEvents :: String

19+requestFocusEvents = "\ESC[?1004h"

2220

2321-- | These sequences disable focus events.

24−disableFocusEvents :: ByteString

25−disableFocusEvents = BS8.pack "\ESC[?1004l"

22+disableFocusEvents :: String

23+disableFocusEvents = "\ESC[?1004l"

2624

2725-- | Does the specified string begin with a focus event?

28−isFocusEvent :: ByteString -> Bool

29−isFocusEvent s = BS8.isPrefixOf focusIn s ||

30− BS8.isPrefixOf focusOut s

26+isFocusEvent :: String -> Bool

27+isFocusEvent s = isPrefixOf focusIn s ||

28+ isPrefixOf focusOut s

3129

32−focusIn :: ByteString

33−focusIn = BS8.pack "\ESC[I"

30+focusIn :: String

31+focusIn = "\ESC[I"

3432

35−focusOut :: ByteString

36−focusOut = BS8.pack "\ESC[O"

33+focusOut :: String

34+focusOut = "\ESC[O"

3735

3836-- | Attempt to classify an input string as a focus event.

39−classifyFocusEvent :: ByteString -> KClass

37+classifyFocusEvent :: String -> KClass

4038classifyFocusEvent s = runParser s $ do

4139 when (not $ isFocusEvent s) failParse

4240

src/Graphics/Vty/Input/Loop.hs+29−86

@@ -1,9 +1,8 @@

1−{-# LANGUAGE CPP #-}

2−{-# LANGUAGE NoMonomorphismRestriction #-}

31{-# LANGUAGE RecordWildCards #-}

4−{-# LANGUAGE ScopedTypeVariables #-}

5−{-# LANGUAGE TemplateHaskell #-}

62{-# OPTIONS_HADDOCK hide #-}

3+{-# LANGUAGE NoMonomorphismRestriction #-}

4+{-# LANGUAGE TemplateHaskell #-}

5+{-# LANGUAGE CPP #-}

76-- | The input layer used to be a single function that correctly

87-- accounted for the non-threaded runtime by emulating the terminal

98-- VMIN adn VTIME handling. This has been removed and replace with a

@@ -34,15 +33,12 @@ import Control.Monad.Trans.State (StateT(..), evalStateT)

3433import Control.Monad.State.Class (MonadState, modify)

3534import Control.Monad.Trans.Reader (ReaderT(..))

3635

37−import qualified Data.ByteString.Char8 as BS8

38−import qualified Data.ByteString as BS

39−import Data.ByteString.Char8 (ByteString)

36+import Data.Char

4037import Data.IORef

4138import Data.Word (Word8)

4239

43−import Foreign (allocaArray)

40+import Foreign ( allocaArray, peekArray, Ptr )

4441import Foreign.C.Types (CInt(..))

45−import Foreign.Ptr (Ptr, castPtr)

4642

4743import System.IO

4844import System.Posix.IO (fdReadBuf, setFdOption, FdOption(..))

@@ -55,15 +51,10 @@ data Input = Input

5551 { -- | Channel of events direct from input processing. Unlike

5652 -- 'nextEvent' this will not refresh the display if the next event

5753 -- is an 'EvResize'.

58− _eventChannel :: TChan InternalEvent

59− -- | Shuts down the input processing. As part of shutting down the

60− -- input, this should also restore the input state.

54+ _eventChannel :: TChan Event

55+ -- | Shuts down the input processing. This should return the

56+ -- terminal input state to before he input initialized.

6157 , shutdownInput :: IO ()

62− -- | Restore the terminal's input state to what it was prior

63− -- to configuring input for Vty. This should be done as part of

64− -- 'shutdownInput' but is exposed in case you need to access it

65− -- directly.

66− , restoreInputState :: IO ()

6758 -- | Changes to this value are reflected after the next event.

6859 , _configRef :: IORef Config

6960 -- | input debug log

@@ -80,11 +71,10 @@ data InputBuffer = InputBuffer

8071makeLenses ''InputBuffer

8172

8273data InputState = InputState

83− { _unprocessedBytes :: ByteString

84− , _classifierState :: ClassifierState

74+ { _unprocessedBytes :: String

8575 , _appliedConfig :: Config

8676 , _inputBuffer :: InputBuffer

87− , _classifier :: ClassifierState -> ByteString -> KClass

77+ , _classifier :: String -> KClass

8878 }

8979

9080makeLenses ''InputState

@@ -109,20 +99,20 @@ loopInputProcessor = do

10999 dropInvalid

110100 loopInputProcessor

111101

112−addBytesToProcess :: ByteString -> InputM ()

102+addBytesToProcess :: String -> InputM ()

113103addBytesToProcess block = unprocessedBytes <>= block

114104

115105emit :: Event -> InputM ()

116106emit event = do

117107 logMsg $ "parsed event: " ++ show event

118− view eventChannel >>= liftIO . atomically . flip writeTChan (InputEvent event)

108+ view eventChannel >>= liftIO . atomically . flip writeTChan event

119109

120110-- The timing requirements are assured by the VMIN and VTIME set for the

121111-- device.

122112--

123113-- Precondition: Under the threaded runtime. Only current use is from a

124114-- forkOS thread. That case satisfies precondition.

125−readFromDevice :: InputM ByteString

115+readFromDevice :: InputM String

126116readFromDevice = do

127117 newConfig <- view configRef >>= liftIO . readIORef

128118 oldConfig <- use appliedConfig

@@ -142,10 +132,9 @@ readFromDevice = do

142132 threadWaitRead fd

143133 bytesRead <- fdReadBuf fd bufferPtr (fromIntegral maxBytes)

144134 if bytesRead > 0

145− then BS.packCStringLen (castPtr bufferPtr, fromIntegral bytesRead)

146− else return BS.empty

147− when (not $ BS.null stringRep) $

148− logMsg $ "input bytes: " ++ show (BS8.unpack stringRep)

135+ then fmap (map $ chr . fromIntegral) $ peekArray (fromIntegral bytesRead) bufferPtr

136+ else return []

137+ when (not $ null stringRep) $ logMsg $ "input bytes: " ++ show stringRep

149138 return stringRep

150139

151140applyConfig :: Fd -> Config -> IO ()

@@ -156,86 +145,41 @@ applyConfig _ _ = fail "(vty) applyConfig was not provided a complete configurat

156145parseEvent :: InputM Event

157146parseEvent = do

158147 c <- use classifier

159− s <- use classifierState

160148 b <- use unprocessedBytes

161− case c s b of

149+ case c b of

162150 Valid e remaining -> do

163151 logMsg $ "valid parse: " ++ show e

164152 logMsg $ "remaining: " ++ show remaining

165− classifierState .= ClassifierStart

166153 unprocessedBytes .= remaining

167154 return e

168− _ -> mzero

155+ _ -> mzero

169156

170157dropInvalid :: InputM ()

171158dropInvalid = do

172159 c <- use classifier

173− s <- use classifierState

174160 b <- use unprocessedBytes

175− case c s b of

176− Chunk -> do

177− classifierState .=

178− case s of

179− ClassifierStart -> ClassifierInChunk b []

180− ClassifierInChunk p bs -> ClassifierInChunk p (b:bs)

181− unprocessedBytes .= BS8.empty

182− Invalid -> do

183− logMsg "dropping input bytes"

184− classifierState .= ClassifierStart

185− unprocessedBytes .= BS8.empty

186− _ -> return ()

161+ when (c b == Invalid) $ do

162+ logMsg "dropping input bytes"

163+ unprocessedBytes .= []

187164

188165runInputProcessorLoop :: ClassifyMap -> Input -> IO ()

189166runInputProcessorLoop classifyTable input = do

190167 let bufferSize = 1024

191168 allocaArray bufferSize $ \(bufferPtr :: Ptr Word8) -> do

192− s0 <- InputState BS8.empty ClassifierStart

193− <$> readIORef (_configRef input)

194− <*> pure (InputBuffer bufferPtr bufferSize)

195− <*> pure (classify classifyTable)

169+ s0 <- InputState [] <$> readIORef (_configRef input)

170+ <*> pure (InputBuffer bufferPtr bufferSize)

171+ <*> pure (classify classifyTable)

196172 runReaderT (evalStateT loopInputProcessor s0) input

197173

198−-- | Construct two IO actions: one to configure the terminal for Vty and

199−-- one to restore the terminal mode flags to the values they had at the

200−-- time this function was called.

201−--

202−-- This function constructs a configuration action to clear the

203−-- following terminal mode flags:

204−--

205−-- * IXON disabled: disables software flow control on outgoing data.

206−-- This stops the process from being suspended if the output terminal

207−-- cannot keep up.

208−--

209−-- * Raw mode is used for input.

210−--

211−-- * ISIG (enables keyboard combinations that result in

212−-- signals)

213−--

214−-- * ECHO (input is not echoed to the output)

215−--

216−-- * ICANON (canonical mode (line mode) input is not used)

217−--

218−-- * IEXTEN (extended functions are disabled)

219−--

220−-- The configuration action also explicitly sets these flags:

221−--

222−-- * ICRNL (input carriage returns are mapped to newlines)

223174attributeControl :: Fd -> IO (IO (), IO ())

224175attributeControl fd = do

225176 original <- getTerminalAttributes fd

226− let vtyMode = foldl withMode clearedFlags flagsToSet

227− clearedFlags = foldl withoutMode original flagsToUnset

228− flagsToSet = [ MapCRtoLF -- ICRNL

229− ]

230− flagsToUnset = [ StartStopOutput -- IXON

231− , KeyboardInterrupts -- ISIG

232− , EnableEcho -- ECHO

233− , ProcessInput -- ICANON

234− , ExtendedFunctions -- IEXTEN

235− ]

177+ let vtyMode = foldl withoutMode original [ StartStopOutput, KeyboardInterrupts

178+ , EnableEcho, ProcessInput, ExtendedFunctions

179+ ]

236180 let setAttrs = setTerminalAttributes fd vtyMode Immediately

237181 unsetAttrs = setTerminalAttributes fd original Immediately

238− return (setAttrs, unsetAttrs)

182+ return (setAttrs,unsetAttrs)

239183

240184logInitialInputState :: Input -> ClassifyMap -> IO()

241185logInitialInputState input classifyTable = case _inputDebug input of

@@ -243,7 +187,7 @@ logInitialInputState input classifyTable = case _inputDebug input of

243187 Just h -> do

244188 Config{ vmin = Just theVmin

245189 , vtime = Just theVtime

246− , termName = Just theTerm } <- readIORef $ _configRef input

190+ , termName = Just theTerm, .. } <- readIORef $ _configRef input

247191 _ <- hPrintf h "initial (vmin,vtime): %s\n" (show (theVmin, theVtime))

248192 forM_ classifyTable $ \i -> case i of

249193 (inBytes, EvKey k mods) -> hPrintf h "map %s %s %s %s\n" (show theTerm)

@@ -259,7 +203,6 @@ initInput config classifyTable = do

259203 applyConfig fd config

260204 stopSync <- newEmptyMVar

261205 input <- Input <$> atomically newTChan

262− <*> pure (return ())

263206 <*> pure (return ())

264207 <*> newIORef config

265208 <*> maybe (return Nothing)

src/Graphics/Vty/Input/Mouse.hs+17−19

@@ -15,12 +15,10 @@ import Graphics.Vty.Input.Classify.Types

1515import Graphics.Vty.Input.Classify.Parse

1616

1717import Control.Monad.State

18+import Data.List (isPrefixOf)

1819import Data.Maybe (catMaybes)

1920import Data.Bits ((.&.))

2021

21−import qualified Data.ByteString.Char8 as BS8

22−import Data.ByteString.Char8 (ByteString)

23−

2422-- A mouse event in SGR extended mode is

2523--

2624-- '\ESC' '[' '<' B ';' X ';' Y ';' ('M'|'m')

@@ -34,28 +32,28 @@ import Data.ByteString.Char8 (ByteString)

3432

3533-- | These sequences set xterm-based terminals to send mouse event

3634-- sequences.

37−requestMouseEvents :: ByteString

38−requestMouseEvents = BS8.pack "\ESC[?1000h\ESC[?1002h\ESC[?1006h"

35+requestMouseEvents :: String

36+requestMouseEvents = "\ESC[?1000h\ESC[?1002h\ESC[?1006h"

3937

4038-- | These sequences disable mouse events.

41−disableMouseEvents :: ByteString

42−disableMouseEvents = BS8.pack "\ESC[?1000l\ESC[?1002l\ESC[?1006l"

39+disableMouseEvents :: String

40+disableMouseEvents = "\ESC[?1000l\ESC[?1002l\ESC[?1006l"

4341

4442-- | Does the specified string begin with a mouse event?

45−isMouseEvent :: ByteString -> Bool

43+isMouseEvent :: String -> Bool

4644isMouseEvent s = isSGREvent s || isNormalEvent s

4745

48−isSGREvent :: ByteString -> Bool

49−isSGREvent = BS8.isPrefixOf sgrPrefix

46+isSGREvent :: String -> Bool

47+isSGREvent = isPrefixOf sgrPrefix

5048

51−sgrPrefix :: ByteString

52−sgrPrefix = BS8.pack "\ESC[M"

49+sgrPrefix :: String

50+sgrPrefix = "\ESC[M"

5351

54−isNormalEvent :: ByteString -> Bool

55−isNormalEvent = BS8.isPrefixOf normalPrefix

52+isNormalEvent :: String -> Bool

53+isNormalEvent = isPrefixOf normalPrefix

5654

57−normalPrefix :: ByteString

58−normalPrefix = BS8.pack "\ESC[<"

55+normalPrefix :: String

56+normalPrefix = "\ESC[<"

5957

6058-- Modifier bits:

6159shiftBit :: Int

@@ -89,8 +87,8 @@ scrollDown = 65

8987hasBitSet :: Int -> Int -> Bool

9088hasBitSet val bit = val .&. bit > 0

9189

92−-- | Attempt to classify an input string as a mouse event.

93−classifyMouseEvent :: ByteString -> KClass

90+-- | Attempt to lassify an input string as a mouse event.

91+classifyMouseEvent :: String -> KClass

9492classifyMouseEvent s = runParser s $ do

9593 when (not $ isMouseEvent s) failParse

9694

@@ -102,7 +100,7 @@ classifyMouseEvent s = runParser s $ do

102100 'M' -> classifyNormalMouseEvent

103101 _ -> failParse

104102

105−-- Given a modifier/button value, determine which button was indicated

103+-- Given a modifer/button value, determine which button was indicated

106104getSGRButton :: Int -> Parser Button

107105getSGRButton mods =

108106 let buttonMap = [ (leftButton, BLeft)

src/Graphics/Vty/Input/Paste.hs+24−16

@@ -9,33 +9,41 @@ module Graphics.Vty.Input.Paste

99where

1010

1111import qualified Data.ByteString.Char8 as BS8

12−import Data.ByteString.Char8 (ByteString)

1312

1413import Graphics.Vty.Input.Events

1514import Graphics.Vty.Input.Classify.Types

1615

17−bracketedPasteStart :: ByteString

18−bracketedPasteStart = BS8.pack "\ESC[200~"

16+import Data.List (isPrefixOf, isInfixOf)

1917

20−bracketedPasteEnd :: ByteString

21−bracketedPasteEnd = BS8.pack "\ESC[201~"

18+bracketedPasteStart :: String

19+bracketedPasteStart = "\ESC[200~"

20+

21+bracketedPasteEnd :: String

22+bracketedPasteEnd = "\ESC[201~"

2223

2324-- | Does the input start a bracketed paste?

24−bracketedPasteStarted :: ByteString -> Bool

25−bracketedPasteStarted = BS8.isPrefixOf bracketedPasteStart

25+bracketedPasteStarted :: String -> Bool

26+bracketedPasteStarted = isPrefixOf bracketedPasteStart

2627

2728-- | Does the input contain a complete bracketed paste?

28−bracketedPasteFinished :: ByteString -> Bool

29−bracketedPasteFinished = BS8.isInfixOf bracketedPasteEnd

29+bracketedPasteFinished :: String -> Bool

30+bracketedPasteFinished = isInfixOf bracketedPasteEnd

3031

3132-- | Parse a bracketed paste. This should only be called on a string if

3233-- both 'bracketedPasteStarted' and 'bracketedPasteFinished' return

3334-- 'True'.

34−parseBracketedPaste :: ByteString -> KClass

35+parseBracketedPaste :: String -> KClass

3536parseBracketedPaste s =

36− Valid (EvPaste p) (BS8.drop endLen rest')

37− where

38− startLen = BS8.length bracketedPasteStart

39− endLen = BS8.length bracketedPasteEnd

40− (_, rest ) = BS8.breakSubstring bracketedPasteStart s

41− (p, rest') = BS8.breakSubstring bracketedPasteEnd . BS8.drop startLen $ rest

37+ let (p, rest) = takeUntil (drop (length bracketedPasteStart) s) bracketedPasteEnd

38+ rest' = if bracketedPasteEnd `isPrefixOf` rest

39+ then drop (length bracketedPasteEnd) rest

40+ else rest

41+ in Valid (EvPaste $ BS8.pack p) rest'

42+

43+takeUntil :: (Eq a) => [a] -> [a] -> ([a],[a])

44+takeUntil [] _ = ([], [])

45+takeUntil cs sub

46+ | length cs < length sub = (cs, [])

47+ | take (length sub) cs == sub = ([], drop (length sub) cs)

48+ | otherwise = let (pre, suf) = takeUntil (tail cs) sub

49+ in (head cs:pre, suf)

src/Graphics/Vty/Input/Terminfo.hs+4−6

@@ -74,7 +74,7 @@ visibleChars = [ ([x], EvKey (KChar x) [])

7474ctrlChars :: ClassifyMap

7575ctrlChars =

7676 [ ([toEnum x],EvKey (KChar y) [MCtrl])

77− | (x,y) <- zip [0..31] ('@':['a'..'z']++['['..'_'])

77+ | (x,y) <- zip ([0..31]) ('@':['a'..'z']++['['..'_'])

7878 , y /= 'i' -- Resolve issue #3 where CTRL-i hides TAB.

7979 , y /= 'h' -- CTRL-h should not hide BS

8080 ]

@@ -86,12 +86,10 @@ ctrlMetaChars = map (\(s,EvKey c m) -> ('\ESC':s, EvKey c (MMeta:m))) ctrlChars

8686-- | Esc, meta-esc, delete, meta-delete, enter, meta-enter.

8787specialSupportKeys :: ClassifyMap

8888specialSupportKeys =

89− [ ("\ESC\ESC[5~",EvKey KPageUp [MMeta])

90− , ("\ESC\ESC[6~",EvKey KPageDown [MMeta])

91− -- special support for ESC

92− , ("\ESC",EvKey KEsc []), ("\ESC\ESC",EvKey KEsc [MMeta])

89+ [ -- special support for ESC

90+ ("\ESC",EvKey KEsc []), ("\ESC\ESC",EvKey KEsc [MMeta])

9391 -- Special support for backspace

94− , ("\DEL",EvKey KBS []), ("\ESC\DEL",EvKey KBS [MMeta]), ("\b",EvKey KBS [])

92+ , ("\DEL",EvKey KBS []), ("\ESC\DEL",EvKey KBS [MMeta])

9593 -- Special support for Enter

9694 , ("\ESC\^J",EvKey KEnter [MMeta]), ("\^J",EvKey KEnter [])

9795 -- explicit support for tab

src/Graphics/Vty/Input/Terminfo/ANSIVT.hs+1−1

@@ -59,7 +59,7 @@ navKeys3 =

5959-- This encoding depends on the terminal.

6060functionKeys1 :: ClassifyMap

6161functionKeys1 =

62− let f ff nrs m = [ ("\ESC["++show n++"~",EvKey (KFun $ n-head nrs+ff) m) | n <- nrs ] in

62+ let f ff nrs m = [ ("\ESC["++show n++"~",EvKey (KFun $ n-(nrs!!0)+ff) m) | n <- nrs ] in

6363 concat [f 1 [25,26] [MShift], f 3 [28,29] [MShift], f 5 [31..34] [MShift] ]

6464

6565-- | encoding for meta plus char

src/Graphics/Vty/Output.hs+14−15

@@ -1,4 +1,5 @@

1−{-# LANGUAGE RecordWildCards, CPP #-}

1+{-# LANGUAGE RecordWildCards #-}

2+{-# LANGUAGE NamedFieldPuns #-}

23-- | This module provides functions for accessing the current terminal

34-- or a specific terminal device.

45--

@@ -37,11 +38,10 @@ import Graphics.Vty.Output.TerminfoBased as TerminfoBased

3738

3839import Blaze.ByteString.Builder (writeToByteString)

3940

40−import Data.List (isPrefixOf)

41+import Control.Monad.Trans

4142

42−#if !MIN_VERSION_base(4,11,0)

43+import Data.List (isPrefixOf)

4344import Data.Monoid ((<>))

44−#endif

4545

4646-- | Returns an `Output` for the terminal specified in `Config`.

4747--

@@ -58,12 +58,11 @@ import Data.Monoid ((<>))

5858-- * If TERM contains "xterm" or "screen", use XTermColor.

5959-- * otherwise use the TerminfoBased driver.

6060outputForConfig :: Config -> IO Output

61−outputForConfig Config{ outputFd = Just fd, termName = Just termName

62− , colorMode = Just colorMode, .. } = do

61+outputForConfig Config{ outputFd = Just fd, termName = Just termName, .. } = do

6362 t <- if "xterm" `isPrefixOf` termName || "screen" `isPrefixOf` termName

64− then XTermColor.reserveTerminal termName fd colorMode

63+ then XTermColor.reserveTerminal termName fd

6564 -- Not an xterm-like terminal. try for generic terminfo.

66− else TerminfoBased.reserveTerminal termName fd colorMode

65+ else TerminfoBased.reserveTerminal termName fd

6766

6867 case mouseMode of

6968 Just s -> setMode t Mouse s

@@ -78,30 +77,30 @@ outputForConfig config = (<> config) <$> standardIOConfig >>= outputForConfig

7877

7978-- | Sets the cursor position to the given output column and row.

8079--

81−-- This is not necessarily the same as the character position with the

80+-- This is not necessarially the same as the character position with the

8281-- same coordinates. Characters can be a variable number of columns in

8382-- width.

8483--

8584-- Currently, the only way to set the cursor position to a given

8685-- character coordinate is to specify the coordinate in the Picture

8786-- instance provided to 'outputPicture' or 'refresh'.

88−setCursorPos :: Output -> Int -> Int -> IO ()

87+setCursorPos :: MonadIO m => Output -> Int -> Int -> m ()

8988setCursorPos t x y = do

9089 bounds <- displayBounds t

9190 when (x >= 0 && x < regionWidth bounds && y >= 0 && y < regionHeight bounds) $ do

9291 dc <- displayContext t bounds

93− outputByteBuffer t $ writeToByteString $ writeMoveCursor dc x y

92+ liftIO $ outputByteBuffer t $ writeToByteString $ writeMoveCursor dc x y

9493

9594-- | Hides the cursor.

96−hideCursor :: Output -> IO ()

95+hideCursor :: MonadIO m => Output -> m ()

9796hideCursor t = do

9897 bounds <- displayBounds t

9998 dc <- displayContext t bounds

100− outputByteBuffer t $ writeToByteString $ writeHideCursor dc

99+ liftIO $ outputByteBuffer t $ writeToByteString $ writeHideCursor dc

101100

102101-- | Shows the cursor.

103−showCursor :: Output -> IO ()

102+showCursor :: MonadIO m => Output -> m ()

104103showCursor t = do

105104 bounds <- displayBounds t

106105 dc <- displayContext t bounds

107− outputByteBuffer t $ writeToByteString $ writeShowCursor dc

106+ liftIO $ outputByteBuffer t $ writeToByteString $ writeShowCursor dc

src/Graphics/Vty/Output/Interface.hs+33−60

@@ -1,9 +1,9 @@

11-- Copyright Corey O'Connor

2+{-# LANGUAGE BangPatterns #-}

23{-# LANGUAGE RankNTypes #-}

34{-# LANGUAGE ExistentialQuantification #-}

45{-# LANGUAGE GADTs #-}

56{-# LANGUAGE FlexibleContexts #-}

6−{-# LANGUAGE ScopedTypeVariables #-}

77-- | This module provides an abstract interface for performing terminal

88-- output. The only user-facing part of this API is 'Output'.

99module Graphics.Vty.Output.Interface

@@ -29,6 +29,8 @@ import Graphics.Vty.DisplayAttributes

2929import Blaze.ByteString.Builder (Write, writeToByteString)

3030import Blaze.ByteString.Builder.ByteString (writeByteString)

3131

32+import Control.Monad.Trans

33+

3234import qualified Data.ByteString as BS

3335import Data.IORef

3436import qualified Data.Text.Encoding as T

@@ -59,7 +61,7 @@ data Output = Output

5961 terminalID :: String

6062 -- | Release the terminal just prior to application exit and reset

6163 -- it to its state prior to application startup.

62− , releaseTerminal :: IO ()

64+ , releaseTerminal :: forall m. MonadIO m => m ()

6365 -- | Clear the display and initialize the terminal to some initial

6466 -- display state.

6567 --

@@ -69,57 +71,40 @@ data Output = Output

6971 -- - cursor at top left

7072 -- - UTF-8 character encoding

7173 -- - drawing characteristics are the default

72− , reserveDisplay :: IO ()

74+ , reserveDisplay :: forall m. MonadIO m => m ()

7375 -- | Return the display to the state before `reserveDisplay` If no

7476 -- previous state then set the display state to the initial state.

75− , releaseDisplay :: IO ()

76− -- | Sets the current display bounds (width, height).

77− , setDisplayBounds :: (Int, Int) -> IO ()

77+ , releaseDisplay :: forall m. MonadIO m => m ()

7878 -- | Returns the current display bounds.

79− , displayBounds :: IO DisplayRegion

79+ , displayBounds :: forall m. MonadIO m => m DisplayRegion

8080 -- | Output the bytestring to the terminal device.

8181 , outputByteBuffer :: BS.ByteString -> IO ()

82+ -- | Specifies the maximum number of colors supported by the

83+ -- context.

84+ , contextColorCount :: Int

8285 -- | Specifies whether the cursor can be shown / hidden.

8386 , supportsCursorVisibility :: Bool

8487 -- | Indicates support for terminal modes for this output device.

8588 , supportsMode :: Mode -> Bool

8689 -- | Enables or disables a mode (does nothing if the mode is

8790 -- unsupported).

88− , setMode :: Mode -> Bool -> IO ()

91+ , setMode :: forall m. MonadIO m => Mode -> Bool -> m ()

8992 -- | Returns whether a mode is enabled.

90− , getModeStatus :: Mode -> IO Bool

93+ , getModeStatus :: forall m. MonadIO m => Mode -> m Bool

9194 , assumedStateRef :: IORef AssumedState

9295 -- | Acquire display access to the given region of the display.

9396 -- Currently all regions have the upper left corner of (0,0) and

9497 -- the lower right corner at (max displayWidth providedWidth, max

9598 -- displayHeight providedHeight)

96− , mkDisplayContext :: Output -> DisplayRegion -> IO DisplayContext

99+ , mkDisplayContext :: forall m. MonadIO m => Output -> DisplayRegion -> m DisplayContext

97100 -- | Ring the terminal bell if supported.

98− , ringTerminalBell :: IO ()

101+ , ringTerminalBell :: forall m. MonadIO m => m ()

99102 -- | Returns whether the terminal has an audio bell feature.

100− , supportsBell :: IO Bool

101− -- | Returns whether the terminal supports italicized text.

102− --

103− -- This is terminal-dependent and should make a best effort to

104− -- determine whether this feature is supported, but even if the

105− -- terminal advertises support (e.g. via terminfo) that might not

106− -- be a reliable indicator of whether the feature will work as

107− -- desired.

108− , supportsItalics :: IO Bool

109− -- | Returns whether the terminal supports strikethrough text.

110− --

111− -- This is terminal-dependent and should make a best effort to

112− -- determine whether this feature is supported, but even if the

113− -- terminal advertises support (e.g. via terminfo) that might not

114− -- be a reliable indicator of whether the feature will work as

115− -- desired.

116− , supportsStrikethrough :: IO Bool

117− -- | Returns how many colors the terminal supports.

118− , outputColorMode :: ColorMode

103+ , supportsBell :: forall m. MonadIO m => m Bool

119104 }

120105

121−displayContext :: Output -> DisplayRegion -> IO DisplayContext

122−displayContext t = mkDisplayContext t t

106+displayContext :: MonadIO m => Output -> DisplayRegion -> m DisplayContext

107+displayContext t = liftIO . mkDisplayContext t t

123108

124109data AssumedState = AssumedState

125110 { prevFattr :: Maybe FixedAttr

@@ -178,8 +163,8 @@ writeUtf8Text = writeByteString

178163-- 4. Serialized to the display.

179164--

180165-- 5. The cursor is then shown and positioned or kept hidden.

181−outputPicture :: DisplayContext -> Picture -> IO ()

182−outputPicture dc pic = do

166+outputPicture :: MonadIO m => DisplayContext -> Picture -> m ()

167+outputPicture dc pic = liftIO $ do

183168 urlsEnabled <- getModeStatus (contextDevice dc) Hyperlink

184169 as <- readIORef (assumedStateRef $ contextDevice dc)

185170 let manipCursor = supportsCursorVisibility (contextDevice dc)

@@ -206,12 +191,6 @@ outputPicture dc pic = do

206191 AbsoluteCursor x y ->

207192 writeShowCursor dc `mappend`

208193 writeMoveCursor dc (clampX x) (clampY y)

209− PositionOnly isAbs x y ->

210− if isAbs

211− then writeMoveCursor dc (clampX x) (clampY y)

212− else let (ox, oy) = charToOutputPos m (clampX x, clampY y)

213− m = cursorOutputMap ops $ picCursor pic

214− in writeMoveCursor dc (clampX ox) (clampY oy)

215194 Cursor x y ->

216195 let m = cursorOutputMap ops $ picCursor pic

217196 (ox, oy) = charToOutputPos m (clampX x, clampY y)

@@ -309,23 +288,17 @@ limitAttrForDisplay t attr

309288 where

310289 clampColor Default = Default

311290 clampColor KeepCurrent = KeepCurrent

312− clampColor (SetTo c) = clampColor' (outputColorMode t) c

313−

314− clampColor' NoColor _ = Default

315−

316− clampColor' ColorMode8 (ISOColor v)

317− | v >= 8 = SetTo $ ISOColor (v - 8)

318− | otherwise = SetTo $ ISOColor v

319− clampColor' ColorMode8 _ = Default

320−

321− clampColor' ColorMode16 c@(ISOColor _) = SetTo c

322− clampColor' ColorMode16 _ = Default

323−

324− clampColor' (ColorMode240 _) c@(ISOColor _) = SetTo c

325− clampColor' (ColorMode240 colorCount) c@(Color240 n)

326− | n <= colorCount = SetTo c

327− | otherwise = Default

328− clampColor' colorMode@(ColorMode240 _) (RGBColor r g b) =

329− clampColor' colorMode (color240 r g b)

330−

331− clampColor' FullColor c = SetTo c

291+ clampColor (SetTo c) = clampColor' c

292+ clampColor' (ISOColor v)

293+ | contextColorCount t < 8 = Default

294+ | contextColorCount t < 16 && v >= 8 = SetTo $ ISOColor (v - 8)

295+ | otherwise = SetTo $ ISOColor v

296+ clampColor' (Color240 v)

297+ -- Should we choose closest ISO color?

298+ | contextColorCount t < 8 = Default

299+ | contextColorCount t < 16 = Default

300+ | contextColorCount t <= 256 = SetTo $ Color240 v

301+ | otherwise

302+ = let p :: Double = fromIntegral v / 240.0

303+ v' = floor $ p * (fromIntegral $ contextColorCount t)

304+ in SetTo $ Color240 v'

src/Graphics/Vty/Output/Mock.hs+2−6

@@ -11,7 +11,6 @@ module Graphics.Vty.Output.Mock

1111where

1212

1313import Graphics.Vty.Image (DisplayRegion)

14−import Graphics.Vty.Attributes.Color (ColorMode(ColorMode16))

1514import Graphics.Vty.Output.Interface

1615

1716import Blaze.ByteString.Builder.Word (writeWord8)

@@ -31,7 +30,7 @@ type MockData = IORef (UTF8.UTF8 BS.ByteString)

3130-- without considering terminal specific issues.

3231--

3332-- The mock implementation is useful in manually determining if the

34−-- sequence of terminal operations matches the expected sequence. The

33+-- sequence of terminal operations matche the expected sequence. The

3534-- requirement of the produced representation is simplicity in parsing

3635-- the text representation and determining how the picture was mapped to

3736-- terminal operations.

@@ -49,19 +48,16 @@ mockTerminal r = liftIO $ do

4948 , releaseDisplay = return ()

5049 , ringTerminalBell = return ()

5150 , supportsBell = return False

52− , supportsItalics = return False

53− , supportsStrikethrough = return False

54− , setDisplayBounds = const $ return ()

5551 , displayBounds = return r

5652 , outputByteBuffer = \bytes -> do

5753 putStrLn $ "mock outputByteBuffer of " ++ show (BS.length bytes) ++ " bytes"

5854 writeIORef outRef $ UTF8.fromRep bytes

55+ , contextColorCount = 16

5956 , supportsCursorVisibility = True

6057 , supportsMode = const False

6158 , setMode = const $ const $ return ()

6259 , getModeStatus = const $ return False

6360 , assumedStateRef = newAssumedStateRef

64− , outputColorMode = ColorMode16

6561 , mkDisplayContext = \tActual rActual -> return $ DisplayContext

6662 { contextRegion = rActual

6763 , contextDevice = tActual

src/Graphics/Vty/Output/TerminfoBased.hs+55−122

@@ -1,6 +1,6 @@

1+{-# LANGUAGE RecordWildCards #-}

12{-# LANGUAGE FlexibleInstances #-}

23{-# LANGUAGE OverloadedStrings #-}

3−{-# LANGUAGE CPP #-}

44{-# OPTIONS_GHC -D_XOPEN_SOURCE=500 -fno-warn-warnings-deprecations #-}

55{-# CFILES gwinsz.c #-}

@@ -9,12 +9,10 @@

99-- Copyright Corey O'Connor (coreyoconnor@gmail.com)

1010module Graphics.Vty.Output.TerminfoBased

1111 ( reserveTerminal

12− , setWindowSize

1312 )

1413where

1514

1615import Control.Monad (when)

17−import Data.Bits (shiftL, (.&.))

1816import qualified Data.ByteString as BS

1917import Data.ByteString.Internal (toForeignPtr)

2018import Data.Terminfo.Parse

@@ -25,16 +23,16 @@ import Graphics.Vty.Image (DisplayRegion)

2523import Graphics.Vty.DisplayAttributes

2624import Graphics.Vty.Output.Interface

2725

28−import Blaze.ByteString.Builder (Write, writeToByteString, writeStorable, writeWord8)

26+import Blaze.ByteString.Builder (Write, writeToByteString, writeStorable)

2927

28+import Control.Monad.Trans

29+

30+import Data.Bits ((.&.))

31+import Data.Foldable (foldMap)

3032import Data.IORef

3133import Data.Maybe (isJust, isNothing, fromJust)

3234import Data.Word

3335

34−#if !MIN_VERSION_base(4,8,0)

35−import Data.Foldable (foldMap)

36−#endif

37−

3836import Foreign.C.Types ( CInt(..), CLong(..) )

3937import Foreign.ForeignPtr (withForeignPtr)

4038import Foreign.Ptr (Ptr, plusPtr)

@@ -49,6 +47,7 @@ data TerminfoCaps = TerminfoCaps

4947 , cup :: CapExpression

5048 , cnorm :: Maybe CapExpression

5149 , civis :: Maybe CapExpression

50+ , supportsNoColors :: Bool

5251 , useAltColorMap :: Bool

5352 , setForeColor :: CapExpression

5453 , setBackColor :: CapExpression

@@ -65,8 +64,6 @@ data DisplayAttrCaps = DisplayAttrCaps

6564 , exitStandout :: Maybe CapExpression

6665 , enterItalic :: Maybe CapExpression

6766 , exitItalic :: Maybe CapExpression

68− , enterStrikethrough :: Maybe CapExpression

69− , exitStrikethrough :: Maybe CapExpression

7067 , enterUnderline :: Maybe CapExpression

7168 , exitUnderline :: Maybe CapExpression

7269 , enterReverseVideo :: Maybe CapExpression

@@ -103,28 +100,28 @@ sendCapToTerminal t cap capParams = do

103100--

104101-- * Providing independent string capabilities for all display

105102-- attributes.

106−reserveTerminal :: String -> Fd -> ColorMode -> IO Output

107−reserveTerminal termName outFd colorMode = do

103+reserveTerminal :: ( Applicative m, MonadIO m ) => String -> Fd -> m Output

104+reserveTerminal termName outFd = liftIO $ do

108105 ti <- Terminfo.setupTerm termName

109106 -- assumes set foreground always implies set background exists.

110107 -- if set foreground is not set then all color changing style

111108 -- attributes are filtered.

112109 msetaf <- probeCap ti "setaf"

113110 msetf <- probeCap ti "setf"

114− let (useAlt, setForeCap)

111+ let (noColors, useAlt, setForeCap)

115112 = case msetaf of

116− Just setaf -> (False, setaf)

113+ Just setaf -> (False, False, setaf)

117114 Nothing -> case msetf of

118− Just setf -> (True, setf)

119− Nothing -> (True, error $ "no fore color support for terminal " ++ termName)

115+ Just setf -> (False, True, setf)

116+ Nothing -> (True, True, error $ "no fore color support for terminal " ++ termName)

120117 msetab <- probeCap ti "setab"

121118 msetb <- probeCap ti "setb"

122− let setBackCap

119+ let set_back_cap

123120 = case msetab of

124− Just setab -> setab

125121 Nothing -> case msetb of

126122 Just setb -> setb

127123 Nothing -> error $ "no back color support for terminal " ++ termName

124+ Just setab -> setab

128125

129126 hyperlinkModeStatus <- newIORef False

130127 newAssumedStateRef <- newIORef initialAssumedState

@@ -133,13 +130,13 @@ reserveTerminal termName outFd colorMode = do

133130 curStatus <- terminfoModeStatus m

134131 when (newStatus /= curStatus) $

135132 case m of

136− Hyperlink -> do

133+ Hyperlink -> liftIO $ do

137134 writeIORef hyperlinkModeStatus newStatus

138135 writeIORef newAssumedStateRef initialAssumedState

139136 _ -> return ()

140137 terminfoModeStatus m =

141138 case m of

142− Hyperlink -> readIORef hyperlinkModeStatus

139+ Hyperlink -> liftIO $ readIORef hyperlinkModeStatus

143140 _ -> return False

144141 terminfoModeSupported Hyperlink = True

145142 terminfoModeSupported _ = False

@@ -150,9 +147,10 @@ reserveTerminal termName outFd colorMode = do

150147 <*> requireCap ti "cup"

151148 <*> probeCap ti "cnorm"

152149 <*> probeCap ti "civis"

150+ <*> pure noColors

153151 <*> pure useAlt

154152 <*> pure setForeCap

155− <*> pure setBackCap

153+ <*> pure set_back_cap

156154 <*> requireCap ti "sgr0"

157155 <*> requireCap ti "clear"

158156 <*> requireCap ti "el"

@@ -160,28 +158,22 @@ reserveTerminal termName outFd colorMode = do

160158 <*> probeCap ti "bel"

161159 let t = Output

162160 { terminalID = termName

163− , releaseTerminal = do

161+ , releaseTerminal = liftIO $ do

164162 sendCap setDefaultAttr []

165163 maybeSendCap cnorm []

166164 , supportsBell = return $ isJust $ ringBellAudio terminfoCaps

167− , supportsItalics = return $ (isJust $ enterItalic (displayAttrCaps terminfoCaps)) &&

168− (isJust $ exitItalic (displayAttrCaps terminfoCaps))

169− , supportsStrikethrough = return $ (isJust $ enterStrikethrough (displayAttrCaps terminfoCaps)) &&

170− (isJust $ exitStrikethrough (displayAttrCaps terminfoCaps))

171− , ringTerminalBell = maybeSendCap ringBellAudio []

172− , reserveDisplay = do

165+ , ringTerminalBell = liftIO $ maybeSendCap ringBellAudio []

166+ , reserveDisplay = liftIO $ do

173167 -- If there is no support for smcup: Clear the screen

174168 -- and then move the mouse to the home position to

175169 -- approximate the behavior.

176170 maybeSendCap smcup []

177171 sendCap clearScreen []

178− , releaseDisplay = do

172+ , releaseDisplay = liftIO $ do

179173 maybeSendCap rmcup []

180174 maybeSendCap cnorm []

181− , setDisplayBounds = \(w, h) ->

182− setWindowSize outFd (w, h)

183175 , displayBounds = do

184− rawSize <- getWindowSize outFd

176+ rawSize <- liftIO $ getWindowSize outFd

185177 case rawSize of

186178 (w, h) | w < 0 || h < 0 -> fail $ "getwinsize returned < 0 : " ++ show rawSize

187179 | otherwise -> return (w,h)

@@ -192,39 +184,46 @@ reserveTerminal termName outFd colorMode = do

192184 when (toEnum len /= actualLen) $ fail $ "Graphics.Vty.Output: outputByteBuffer "

193185 ++ "length mismatch. " ++ show len ++ " /= " ++ show actualLen

194186 ++ " Please report this bug to vty project."

187+ , contextColorCount

188+ = case supportsNoColors terminfoCaps of

189+ False -> case Terminfo.getCapability ti (Terminfo.tiGetNum "colors" ) of

190+ Nothing -> 8

191+ Just v -> toEnum v

192+ True -> 1

195193 , supportsCursorVisibility = isJust $ civis terminfoCaps

196194 , supportsMode = terminfoModeSupported

197195 , setMode = terminfoSetMode

198196 , getModeStatus = terminfoModeStatus

199197 , assumedStateRef = newAssumedStateRef

200− , outputColorMode = colorMode

201198 -- I think fix would help assure tActual is the only

202199 -- reference. I was having issues tho.

203− , mkDisplayContext = (`terminfoDisplayContext` terminfoCaps)

200+ , mkDisplayContext = \tActual -> liftIO . terminfoDisplayContext tActual terminfoCaps

204201 }

205202 sendCap s = sendCapToTerminal t (s terminfoCaps)

206203 maybeSendCap s = when (isJust $ s terminfoCaps) . sendCap (fromJust . s)

207204 return t

208205

209−requireCap :: Terminfo.Terminal -> String -> IO CapExpression

206+requireCap :: (Applicative m, MonadIO m) => Terminfo.Terminal -> String -> m CapExpression

210207requireCap ti capName

211208 = case Terminfo.getCapability ti (Terminfo.tiGetStr capName) of

212209 Nothing -> fail $ "Terminal does not define required capability \"" ++ capName ++ "\""

213210 Just capStr -> parseCap capStr

214211

215−probeCap :: Terminfo.Terminal -> String -> IO (Maybe CapExpression)

212+probeCap :: (Applicative m, MonadIO m) => Terminfo.Terminal -> String -> m (Maybe CapExpression)

216213probeCap ti capName

217214 = case Terminfo.getCapability ti (Terminfo.tiGetStr capName) of

218215 Nothing -> return Nothing

219216 Just capStr -> Just <$> parseCap capStr

220217

221−parseCap :: String -> IO CapExpression

218+parseCap :: (Applicative m, MonadIO m) => String -> m CapExpression

222219parseCap capStr = do

223220 case parseCapExpression capStr of

224221 Left e -> fail $ show e

225222 Right cap -> return cap

226223

227−currentDisplayAttrCaps :: Terminfo.Terminal -> IO DisplayAttrCaps

224+currentDisplayAttrCaps :: ( Applicative m, MonadIO m )

225+ => Terminfo.Terminal

226+ -> m DisplayAttrCaps

228227currentDisplayAttrCaps ti

229228 = pure DisplayAttrCaps

230229 <*> probeCap ti "sgr"

@@ -232,8 +231,6 @@ currentDisplayAttrCaps ti

232231 <*> probeCap ti "rmso"

233232 <*> probeCap ti "sitm"

234233 <*> probeCap ti "ritm"

235− <*> probeCap ti "smxx"

236− <*> probeCap ti "rmxx"

237234 <*> probeCap ti "smul"

238235 <*> probeCap ti "rmul"

239236 <*> probeCap ti "rev"

@@ -247,13 +244,6 @@ getWindowSize fd = do

247244 (a,b) <- (`divMod` 65536) `fmap` c_getWindowSize fd

248245 return (fromIntegral b, fromIntegral a)

249246

250−foreign import ccall "gwinsz.h vty_c_set_window_size" c_setWindowSize :: Fd -> CLong -> IO ()

251−

252−setWindowSize :: Fd -> (Int, Int) -> IO ()

253−setWindowSize fd (w, h) = do

254− let val = (h `shiftL` 16) + w

255− c_setWindowSize fd $ fromIntegral val

256−

257247terminfoDisplayContext :: Output -> TerminfoCaps -> DisplayRegion -> IO DisplayContext

258248terminfoDisplayContext tActual terminfoCaps r = return dc

259249 where dc = DisplayContext

@@ -269,11 +259,7 @@ terminfoDisplayContext tActual terminfoCaps r = return dc

269259 , writeSetAttr = terminfoWriteSetAttr dc terminfoCaps

270260 , writeDefaultAttr = \urlsEnabled ->

271261 writeCapExpr (setDefaultAttr terminfoCaps) [] `mappend`

272− (if urlsEnabled then writeURLEscapes EndLink else mempty) `mappend`

273− (case exitStrikethrough $ displayAttrCaps terminfoCaps of

274− Just cap -> writeCapExpr cap []

275− Nothing -> mempty

276− )

262+ (if urlsEnabled then writeURLEscapes EndLink else mempty)

277263 , writeRowEnd = writeCapExpr (clearEol terminfoCaps) []

278264 , inlineHack = return ()

279265 }

@@ -295,7 +281,7 @@ writeURLEscapes NoLinkChange =

295281-- | Portably setting the display attributes is a giant pain in the ass.

296282--

297283-- If the terminal supports the sgr capability (which sets the on/off

298−-- state of each style directly; and, for no good reason, resets the

284+-- state of each style directly ; and, for no good reason, resets the

299285-- colors to the default) this procedure is used:

300286--

301287-- 0. set the style attributes. This resets the fore and back color.

@@ -334,9 +320,9 @@ terminfoWriteSetAttr dc terminfoCaps urlsEnabled prevAttr reqAttr diffs =

334320 -- The only way to reset either color, portably, to the default

335321 -- is to use either the set state capability or the set default

336322 -- capability.

337− True -> do

323+ True -> do

338324 case reqDisplayCapSeqFor (displayAttrCaps terminfoCaps)

339− (fixedStyle attr)

325+ (fixedStyle attr )

340326 (styleToApplySeq $ fixedStyle attr) of

341327 -- only way to reset a color to the defaults

342328 EnterExitSeq caps -> writeDefaultAttr dc urlsEnabled

@@ -346,11 +332,11 @@ terminfoWriteSetAttr dc terminfoCaps urlsEnabled prevAttr reqAttr diffs =

346332 setColors

347333 -- implicitly resets the colors to the defaults

348334 SetState state -> writeCapExpr (fromJust $ setAttrStates

349− $ displayAttrCaps terminfoCaps

335+ $ displayAttrCaps

336+ $ terminfoCaps

350337 )

351338 (sgrArgsForState state)

352339 `mappend` setItalics

353− `mappend` setStrikethrough

354340 `mappend` setColors

355341 -- Otherwise the display colors are not changing or changing

356342 -- between two non-default points.

@@ -369,16 +355,15 @@ terminfoWriteSetAttr dc terminfoCaps urlsEnabled prevAttr reqAttr diffs =

369355 -- applied states.

370356 EnterExitSeq caps -> foldMap (\cap -> writeCapExpr cap []) caps

371357 `mappend`

372− writeColorDiff Foreground (foreColorDiff diffs)

358+ writeColorDiff setForeColor (foreColorDiff diffs)

373359 `mappend`

374− writeColorDiff Background (backColorDiff diffs)

360+ writeColorDiff setBackColor (backColorDiff diffs)

375361 -- implicitly resets the colors to the defaults

376362 SetState state -> writeCapExpr (fromJust $ setAttrStates

377363 $ displayAttrCaps terminfoCaps

378364 )

379365 (sgrArgsForState state)

380366 `mappend` setItalics

381− `mappend` setStrikethrough

382367 `mappend` setColors

383368 where

384369 urlAttrs True = writeURLEscapes (urlDiff diffs)

@@ -396,72 +381,31 @@ terminfoWriteSetAttr dc terminfoCaps urlsEnabled prevAttr reqAttr diffs =

396381 , Just sitm <- enterItalic (displayAttrCaps terminfoCaps)

397382 = writeCapExpr sitm []

398383 | otherwise = mempty

399− setStrikethrough

400− | hasStyle (fixedStyle attr) strikethrough

401− , Just smxx <- enterStrikethrough (displayAttrCaps terminfoCaps)

402− = writeCapExpr smxx []

403− | otherwise = mempty

404384 setColors =

405385 (case fixedForeColor attr of

406− Just c -> writeColor Foreground c

386+ Just c -> writeCapExpr (setForeColor terminfoCaps)

387+ [toEnum $ colorMap c]

407388 Nothing -> mempty)

408389 `mappend`

409390 (case fixedBackColor attr of

410− Just c -> writeColor Background c

391+ Just c -> writeCapExpr (setBackColor terminfoCaps)

392+ [toEnum $ colorMap c]

411393 Nothing -> mempty)

412− writeColorDiff _side NoColorChange

394+ writeColorDiff _f NoColorChange

413395 = mempty

414− writeColorDiff _side ColorToDefault

396+ writeColorDiff _f ColorToDefault

415397 = error "ColorToDefault is not a possible case for applyColorDiffs"

416− writeColorDiff side (SetColor c)

417− = writeColor side c

418−

419− writeColor side (RGBColor r g b) =

420− case outputColorMode (contextDevice dc) of

421− FullColor ->

422− hardcodeColor side (r, g, b)

423− _ ->

424− error "clampColor should remove rgb colors in standard mode"

425− writeColor side c =

426− writeCapExpr (setSideColor side terminfoCaps) [toEnum $ colorMap c]

427−

428−-- a color can either be in the foreground or the background

429−data ColorSide = Foreground | Background

430−

431−-- get the capability for drawing a color on a specific side

432−setSideColor :: ColorSide -> TerminfoCaps -> CapExpression

433−setSideColor Foreground = setForeColor

434−setSideColor Background = setBackColor

435−

436−hardcodeColor :: ColorSide -> (Word8, Word8, Word8) -> Write

437−hardcodeColor side (r, g, b) =

438− -- hardcoded color codes are formatted as "\x1b[{side};2;{r};{g};{b}m"

439− mconcat [ writeStr "\x1b[", sideCode, delimiter, writeChar '2', delimiter

440− , writeColor r, delimiter, writeColor g, delimiter, writeColor b

441− , writeChar 'm']

442− where

443− writeChar = writeWord8 . fromIntegral . fromEnum

444− writeStr = mconcat . map writeChar

445− writeColor = writeStr . show

446− delimiter = writeChar ';'

447− -- 38/48 are used to set whether we should write to the

448− -- foreground/background. I really don't want to know why.

449− sideCode = case side of

450− Foreground -> writeStr "38"

451− Background -> writeStr "48"

398+ writeColorDiff f (SetColor c)

399+ = writeCapExpr (f terminfoCaps) [toEnum $ colorMap c]

452400

453401-- | The color table used by a terminal is a 16 color set followed by a

454402-- 240 color set that might not be supported by the terminal.

455403--

456−-- This takes a Color which clearly identifies which palette to use and

457−-- computes the index into the full 256 color palette.

404+-- This takes a Color which clearly identifies which pallete to use and

405+-- computes the index into the full 256 color pallete.

458406ansiColorIndex :: Color -> Int

459407ansiColorIndex (ISOColor v) = fromEnum v

460408ansiColorIndex (Color240 v) = 16 + fromEnum v

461−ansiColorIndex (RGBColor _ _ _) =

462− error $ unlines [ "Attempted to create color index from rgb color."

463− , "This is currently unsupported, and shouldn't ever happen"

464− ]

465409

466410-- | For terminals without setaf/setab

467411--

@@ -478,10 +422,6 @@ altColorIndex (ISOColor 6) = 3

478422altColorIndex (ISOColor 7) = 7

479423altColorIndex (ISOColor v) = fromEnum v

480424altColorIndex (Color240 v) = 16 + fromEnum v

481−altColorIndex (RGBColor _ _ _) =

482− error $ unlines [ "Attempted to create color index from rgb color."

483− , "This is currently unsupported, and shouldn't ever happen"

484− ]

485425

486426{- | The sequence of terminfo caps to apply a given style are determined

487427 - according to these rules.

@@ -509,7 +449,6 @@ data DisplayAttrState = DisplayAttrState

509449 { applyStandout :: Bool

510450 , applyUnderline :: Bool

511451 , applyItalic :: Bool

512− , applyStrikethrough :: Bool

513452 , applyReverseVideo :: Bool

514453 , applyBlink :: Bool

515454 , applyDim :: Bool

@@ -546,8 +485,6 @@ reqDisplayCapSeqFor caps s diffs

546485 -- set state cap then just use the set state cap.

547486 ( True, True ) -> SetState $ stateForStyle s

548487 where

549− noEnterExitCap ApplyStrikethrough = isNothing $ enterStrikethrough caps

550− noEnterExitCap RemoveStrikethrough = isNothing $ exitStrikethrough caps

551488 noEnterExitCap ApplyItalic = isNothing $ enterItalic caps

552489 noEnterExitCap RemoveItalic = isNothing $ exitItalic caps

553490 noEnterExitCap ApplyStandout = isNothing $ enterStandout caps

@@ -562,8 +499,6 @@ reqDisplayCapSeqFor caps s diffs

562499 noEnterExitCap RemoveDim = True

563500 noEnterExitCap ApplyBold = isNothing $ enterBoldMode caps

564501 noEnterExitCap RemoveBold = True

565− enterExitCap ApplyStrikethrough = fromJust $ enterStrikethrough caps

566− enterExitCap RemoveStrikethrough = fromJust $ exitStrikethrough caps

567502 enterExitCap ApplyItalic = fromJust $ enterItalic caps

568503 enterExitCap RemoveItalic = fromJust $ exitItalic caps

569504 enterExitCap ApplyStandout = fromJust $ enterStandout caps

@@ -580,7 +515,6 @@ stateForStyle s = DisplayAttrState

580515 { applyStandout = isStyleSet standout

581516 , applyUnderline = isStyleSet underline

582517 , applyItalic = isStyleSet italic

583− , applyStrikethrough = isStyleSet strikethrough

584518 , applyReverseVideo = isStyleSet reverseVideo

585519 , applyBlink = isStyleSet blink

586520 , applyDim = isStyleSet dim

@@ -593,7 +527,6 @@ styleToApplySeq s = concat

593527 [ applyIfRequired ApplyStandout standout

594528 , applyIfRequired ApplyUnderline underline

595529 , applyIfRequired ApplyItalic italic

596− , applyIfRequired ApplyStrikethrough strikethrough

597530 , applyIfRequired ApplyReverseVideo reverseVideo

598531 , applyIfRequired ApplyBlink blink

599532 , applyIfRequired ApplyDim dim

src/Graphics/Vty/Output/XTermColor.hs+18−31

@@ -1,4 +1,3 @@

1−{-# Language CPP #-}

32-- | Xterm output driver. This uses the Terminfo driver with some

43-- extensions for Xterm.

@@ -10,41 +9,26 @@ where

109import Graphics.Vty.Output.Interface

1110import Graphics.Vty.Input.Mouse

1211import Graphics.Vty.Input.Focus

13−import Graphics.Vty.Attributes.Color (ColorMode)

1412import qualified Graphics.Vty.Output.TerminfoBased as TerminfoBased

1513

1614import Blaze.ByteString.Builder (writeToByteString)

1715import Blaze.ByteString.Builder.Word (writeWord8)

1816

19−import qualified Data.ByteString.Char8 as BS8

20−import Data.ByteString.Char8 (ByteString)

21−import Foreign.Ptr (castPtr)

22−

2317import Control.Monad (void, when)

2418import Control.Monad.Trans

25−import Data.Char (toLower)

2619import Data.IORef

2720

28−import System.Posix.IO (fdWriteBuf)

29−import System.Posix.Types (ByteCount, Fd)

21+import System.Posix.IO (fdWrite)

22+import System.Posix.Types (Fd)

3023import System.Posix.Env (getEnv)

3124

3225import Data.List (isInfixOf)

3326import Data.Maybe (catMaybes)

34−

35−#if !MIN_VERSION_base(4,11,0)

3627import Data.Monoid ((<>))

37−#endif

38−

39−-- | Write a 'ByteString' to an 'Fd'.

40−fdWrite :: Fd -> ByteString -> IO ByteCount

41−fdWrite fd s =

42− BS8.useAsCStringLen s $ \(buf,len) -> do

43− fdWriteBuf fd (castPtr buf) (fromIntegral len)

4428

4529-- | Construct an Xterm output driver. Initialize the display to UTF-8.

46−reserveTerminal :: ( Applicative m, MonadIO m ) => String -> Fd -> ColorMode -> m Output

47−reserveTerminal variant outFd colorMode = liftIO $ do

30+reserveTerminal :: ( Applicative m, MonadIO m ) => String -> Fd -> m Output

31+reserveTerminal variant outFd = liftIO $ do

4832 let flushedPut = void . fdWrite outFd

4933 -- If the terminal variant is xterm-color use xterm instead since,

5034 -- more often than not, xterm-color is broken.

@@ -52,7 +36,7 @@ reserveTerminal variant outFd colorMode = liftIO $ do

5236

5337 utf8a <- utf8Active

5438 when (not utf8a) $ flushedPut setUtf8CharSet

55− t <- TerminfoBased.reserveTerminal variant' outFd colorMode

39+ t <- TerminfoBased.reserveTerminal variant' outFd

5640

5741 mouseModeStatus <- newIORef False

5842 focusModeStatus <- newIORef False

@@ -104,27 +88,30 @@ reserveTerminal variant outFd colorMode = liftIO $ do

10488utf8Active :: IO Bool

10589utf8Active = do

10690 let vars = ["LC_ALL", "LANG", "LC_CTYPE"]

107− results <- map (toLower <$>) . catMaybes <$> mapM getEnv vars

108− let matches = filter ("utf8" `isInfixOf`) results <>

109− filter ("utf-8" `isInfixOf`) results

91+ results <- catMaybes <$> mapM getEnv vars

92+ let matches = filter ("UTF8" `isInfixOf`) results <>

93+ filter ("UTF-8" `isInfixOf`) results

11094 return $ not $ null matches

11195

11296-- | Enable bracketed paste mode:

11397-- http://cirw.in/blog/bracketed-paste

114−enableBracketedPastes :: ByteString

115−enableBracketedPastes = BS8.pack "\ESC[?2004h"

98+enableBracketedPastes :: String

99+enableBracketedPastes = "\ESC[?2004h"

116100

117101-- | Disable bracketed paste mode:

118−disableBracketedPastes :: ByteString

119−disableBracketedPastes = BS8.pack "\ESC[?2004l"

102+disableBracketedPastes :: String

103+disableBracketedPastes = "\ESC[?2004l"

120104

121105-- | These sequences set xterm based terminals to UTF-8 output.

122106--

123107-- There is no known terminfo capability equivalent to this.

124−setUtf8CharSet, setDefaultCharSet :: ByteString

125−setUtf8CharSet = BS8.pack "\ESC%G"

126−setDefaultCharSet = BS8.pack "\ESC%@"

108+setUtf8CharSet, setDefaultCharSet :: String

109+setUtf8CharSet = "\ESC%G"

110+setDefaultCharSet = "\ESC%@"

127111

112+-- | I think xterm is broken: Reseting the background color as the first

113+-- bytes serialized on a new line does not effect the background color

114+-- xterm uses to clear the line. Which is used *after* the next newline.

128115xtermInlineHack :: Output -> IO ()

129116xtermInlineHack t = do

130117 let writeReset = foldMap (writeWord8.toEnum.fromEnum) "\ESC[K"

src/Graphics/Vty/Picture.hs+1−8

@@ -1,3 +1,4 @@

1+{-# LANGUAGE BangPatterns #-}

12-- A 'Picture' is a background paired with a set of 'Image' layers. The

23-- 'Picture' data structure is representative of the final terminal

34-- view.

@@ -79,14 +80,6 @@ picForLayers is = Picture

7980data Cursor =

8081 -- | Hide the cursor

8182 NoCursor

82− -- | Set the terminal's cursor position without displaying a cursor

83− -- character. This is important for accessibility with screen

84− -- readers where a cursor position needs to be reported but we may

85− -- not want to show a block cursor in that location for cosmetic

86− -- reasons. The boolean argument indicates whether the positioning

87− -- should be absolute as with 'AbsoluteCursor' ('True') or logical

88− -- as with 'Cursor' ('False').

89− | PositionOnly !Bool !Int !Int

9083 -- | Show the cursor at the given logical column accounting for

9184 -- character width in the presence of multi-column characters.

9285 | Cursor !Int !Int

src/Graphics/Vty/PictureToSpans.hs+7−7

@@ -72,7 +72,7 @@ displayOpsForPic pic r = Vector.create (combinedOpsForLayers pic r)

7272-- | Returns the DisplayOps for an image rendered to a window the size

7373-- of the image.

7474--

75−-- largely used only for debugging.

75+-- largerly used only for debugging.

7676displayOpsForImage :: Image -> DisplayOps

7777displayOpsForImage i = displayOpsForPic (picForImage i) (imageWidth i, imageHeight i)

7878

@@ -81,7 +81,7 @@ combinedOpsForLayers :: Picture -> DisplayRegion -> ST s (MRowOps s)

8181combinedOpsForLayers pic r

8282 | regionWidth r == 0 || regionHeight r == 0 = MVector.new 0

8383 | otherwise = do

84− layerOps <- mapM (`buildSpans` r) (picLayers pic)

84+ layerOps <- mapM (\layer -> buildSpans layer r) (picLayers pic)

8585 case layerOps of

8686 [] -> fail "empty picture"

8787 [ops] -> substituteSkips (picBackground pic) ops

@@ -136,8 +136,8 @@ mergeUnder upper lower = do

136136 return upper

137137

138138mergeRowUnder :: SpanOps -> SpanOps -> SpanOps

139−mergeRowUnder upperRowOps =

140− onUpperOp Vector.empty (Vector.head upperRowOps) (Vector.tail upperRowOps)

139+mergeRowUnder upperRowOps lowerRowOps =

140+ onUpperOp Vector.empty (Vector.head upperRowOps) (Vector.tail upperRowOps) lowerRowOps

141141 where

142142 -- H: it will never be the case that we are out of upper ops

143143 -- before lower ops.

@@ -323,14 +323,14 @@ addUnclippedText a txt = do

323323 let op = TextSpan a usedDisplayColumns

324324 (fromIntegral $ TL.length txt)

325325 txt

326− usedDisplayColumns = wctlwidth txt

326+ usedDisplayColumns = wcswidth $ TL.unpack txt

327327 use rowOffset >>= snocOp op

328328

329329addRowCompletion :: DisplayRegion -> Int -> BlitM s ()

330330addRowCompletion displayRegion row = do

331331 allRowOps <- view mrowOps

332332 rowOps <- lift $ lift $ MVector.read allRowOps row

333− let endX = spanOpsAffectedColumns rowOps

333+ let endX = spanOpsEffectedColumns rowOps

334334 when (endX < regionWidth displayRegion) $ do

335335 let ow = regionWidth displayRegion - endX

336336 snocOp (Skip ow) row

@@ -343,6 +343,6 @@ snocOp !op !row = do

343343 lift $ lift $ do

344344 ops <- MVector.read theMrowOps row

345345 let ops' = Vector.snoc ops op

346− when (spanOpsAffectedColumns ops' > regionWidth theRegion)

346+ when (spanOpsEffectedColumns ops' > regionWidth theRegion)

347347 $ fail $ "row " ++ show row ++ " now exceeds region width"

348348 MVector.write theMrowOps row ops'

src/Graphics/Vty/Span.hs+11−8

@@ -1,4 +1,6 @@

11-- Copyright Corey O'Connor

2+{-# LANGUAGE BangPatterns #-}

3+{-# LANGUAGE NamedFieldPuns #-}

24{-# LANGUAGE GADTs #-}

35-- | A picture is translated into a sequences of state changes and

46-- character spans. The attribute is applied to all following spans,

@@ -50,7 +52,7 @@ dropOps :: Int -> SpanOps -> SpanOps

5052dropOps w = snd . splitOpsAt w

5153

5254splitOpsAt :: Int -> SpanOps -> (SpanOps, SpanOps)

53−splitOpsAt = splitOpsAt'

55+splitOpsAt inW inOps = splitOpsAt' inW inOps

5456 where

5557 splitOpsAt' 0 ops = (Vector.empty, ops)

5658 splitOpsAt' remainingColumns ops = case Vector.head ops of

@@ -101,18 +103,18 @@ displayOpsColumns ops

101103

102104-- | The number of rows the DisplayOps are defined for.

103105displayOpsRows :: DisplayOps -> Int

104−displayOpsRows = Vector.length

106+displayOpsRows ops = Vector.length ops

105107

106108affectedRegion :: DisplayOps -> DisplayRegion

107109affectedRegion ops = (displayOpsColumns ops, displayOpsRows ops)

108110

109111-- | The number of columns a SpanOps affects.

110−spanOpsAffectedColumns :: SpanOps -> Int

111−spanOpsAffectedColumns inOps = Vector.foldl' spanOpsAffectedColumns' 0 inOps

112+spanOpsEffectedColumns :: SpanOps -> Int

113+spanOpsEffectedColumns inOps = Vector.foldl' spanOpsEffectedColumns' 0 inOps

112114 where

113− spanOpsAffectedColumns' t (TextSpan _ w _ _ ) = t + w

114− spanOpsAffectedColumns' t (Skip w) = t + w

115− spanOpsAffectedColumns' t (RowEnd w) = t + w

115+ spanOpsEffectedColumns' t (TextSpan _ w _ _ ) = t + w

116+ spanOpsEffectedColumns' t (Skip w) = t + w

117+ spanOpsEffectedColumns' t (RowEnd w) = t + w

116118

117119-- | The width of a single SpanOp in columns.

118120spanOpHasWidth :: SpanOp -> Maybe (Int, Int)

@@ -124,6 +126,7 @@ spanOpHasWidth (RowEnd ow) = Just (ow,ow)

124126-- span op.

125127columnsToCharOffset :: Int -> SpanOp -> Int

126128columnsToCharOffset cx (TextSpan _ _ _ utf8Str) =

127− wctlwidth (TL.take (fromIntegral cx) utf8Str)

129+ let str = TL.unpack utf8Str

130+ in wcswidth (take cx str)

128131columnsToCharOffset cx (Skip _) = cx

129132columnsToCharOffset cx (RowEnd _) = cx

src/Graphics/Vty/UnicodeWidthTable/IO.hsdeleted−105

@@ -1,105 +0,0 @@

1−{-# LANGUAGE CPP #-}

2−module Graphics.Vty.UnicodeWidthTable.IO

3− ( readUnicodeWidthTable

4− , parseUnicodeWidthTable

5− , writeUnicodeWidthTable

6− )

7−where

8−

9−import Control.Monad (when, forM)

10−import Data.Binary

11−import Data.Binary.Get

12−import Data.Binary.Put

13−import qualified Data.ByteString.Lazy as BSL

14−#if !(MIN_VERSION_base(4,11,0))

15−import Data.Semigroup ((<>))

16−#endif

17−

18−import Graphics.Vty.UnicodeWidthTable.Types

19−

20−-- | Load a binary unicode width table from the specified file.

21−--

22−-- This either returns a successfully parsed table or a table parsing

23−-- error message. This does not handle I/O exceptions.

24−readUnicodeWidthTable :: FilePath -> IO (Either String UnicodeWidthTable)

25−readUnicodeWidthTable path = parseUnicodeWidthTable <$> BSL.readFile path

26−

27−-- | Parse a binary unicode width table.

28−parseUnicodeWidthTable :: BSL.ByteString -> Either String UnicodeWidthTable

29−parseUnicodeWidthTable bs =

30− case runGetOrFail tableParser bs of

31− Left (_, _, msg) ->

32− Left msg

33−

34− -- Even if we parsed a table, leftover bytes indicate something

35− -- could be wrong.

36− Right (remainingBytes, _, _) | not (BSL.null remainingBytes) ->

37− Left $ "Error: " <> show (BSL.length remainingBytes) <>

38− " byte(s) left unconsumed"

39−

40− Right (_, _, table) ->

41− Right table

42−

43−-- | Write the unicode width table to the specified path.

44−--

45−-- This does not handle I/O exceptions.

46−writeUnicodeWidthTable :: FilePath -> UnicodeWidthTable -> IO ()

47−writeUnicodeWidthTable path table = do

48− let body = runPut (tableV1Writer table)

49− BSL.writeFile path body

50−

51−-- | Width table magic bytes for use in the binary format.

52−widthTableMagic :: Word32

53−widthTableMagic = 0xc1a9f7e0

54−

55−tableParser :: Get UnicodeWidthTable

56−tableParser = do

57− magic <- getWord32le

58−

59− when (magic /= widthTableMagic) $

60− fail "Table magic number invalid"

61−

62− version <- getWord8

63−

64− case version of

65− 1 -> tableV1Parser

66− _ -> fail "Table version invalid"

67−

68−tableV1Parser :: Get UnicodeWidthTable

69−tableV1Parser = do

70− numRanges <- getWord32le

71−

72− let parseRange = do

73− start <- getWord32le

74− size <- getWord32le

75− cols <- getWord8

76− return WidthTableRange { rangeStart = start

77− , rangeSize = size

78− , rangeColumns = cols

79− }

80−

81− ranges <- forM [1..numRanges] $ const parseRange

82−

83− return UnicodeWidthTable { unicodeWidthTableRanges = ranges

84− }

85−

86−tableV1Writer :: UnicodeWidthTable -> Put

87−tableV1Writer table = do

88− -- Magic bytes

89− putWord32le widthTableMagic

90−

91− -- Version

92− putWord8 1

93−

94− -- Number of ranges

95− let ranges = unicodeWidthTableRanges table

96− let numRanges = length ranges

97− putWord32le (fromIntegral numRanges)

98−

99− -- Ranges

100− let putRange r = do

101− putWord32le $ rangeStart r

102− putWord32le $ rangeSize r

103− putWord8 $ rangeColumns r

104−

105− mapM_ putRange ranges

src/Graphics/Vty/UnicodeWidthTable/Install.hsdeleted−129

@@ -1,129 +0,0 @@

1−{-# LANGUAGE CPP #-}

2−{-# LANGUAGE ForeignFunctionInterface #-}

3−module Graphics.Vty.UnicodeWidthTable.Install

4− ( TableInstallException(..)

5− , installUnicodeWidthTable

6− , isCustomTableReady

7− )

8−where

9−

10−import Control.Monad (when, forM_)

11−import qualified Control.Exception as E

12−import GHC.Conc.Sync (withMVar)

13−import Control.Concurrent.MVar (MVar, newMVar)

14−import Data.Word (Word8, Word32)

15−#if !(MIN_VERSION_base(4,11,0))

16−import Data.Semigroup ((<>))

17−#endif

18−import System.IO.Unsafe (unsafePerformIO)

19−

20−import Graphics.Vty.UnicodeWidthTable.Types

21−

22−-- | The lock used to make functions in this module thread-safe.

23−installLock :: MVar ()

24−{-# NOINLINE installLock #-}

25−installLock = unsafePerformIO $ newMVar ()

26−

27−-- | Returns True if and only if a custom table has been allocated and

28−-- marked as ready for use.

29−--

30−-- This function is thread-safe.

31−isCustomTableReady :: IO Bool

32−isCustomTableReady = withInstallLock $ (== 1) <$> c_isCustomTableReady

33−

34−withInstallLock :: IO a -> IO a

35−withInstallLock act = withMVar installLock $ const act

36−

37−-- This is the size of the allocated custom character width table, in

38−-- character slots. It's important that this be large enough to hold all

39−-- possible Unicode character values. At the time of this writing, the

40−-- valid Unicode range is 0 - 0x10ffff, hence this value.

41−tableSize :: Int

42−tableSize = 0x110000

43−

44−-- | Exception type raised by 'installUnicodeWidthTable'.

45−data TableInstallException =

46− TableInitFailure Int Int

47− -- ^ The width table could not be initialized. Args: failure status,

48− -- requested table size.

49− | TableRangeFailure Int WidthTableRange

50− -- ^ A code point range could not be configured. Args: failure

51− -- status, offending range.

52− | TableActivationFailure Int

53− -- ^ The table could not be activated. Args: failure status.

54− deriving (Eq, Show)

55−

56−instance E.Exception TableInstallException

57−

58−-- | Install a custom unicode character width

59−-- table. Such tables are obtained with

60−-- 'Graphics.Vty.UnicodeWidthTable.Query.buildUnicodeWidthTable' and

61−-- 'Graphics.Vty.UnicodeWidthTable.IO.readUnicodeWidthTable'.

62−--

63−-- ALERT! This function is probably not what you want to use because

64−-- it is automatically called by 'Graphics.Vty.mkVty'. You will only

65−-- ever need to call this function if you want to use functions

66−-- in 'Graphics.Text.Width' without controlling the terminal with

67−-- 'Graphics.Vty.mkVty'.

68−--

69−-- This affects the behavior of the 'Graphics.Vty.Image.wcwidth'

70−-- function and functions that call it. It does so by

71−-- changing global state available to the C implementation

72−-- of 'Graphics.Vty.Image.wcwidth'. To ensure that your

73−-- program gets consistent results from evaluating calls to

74−-- 'Graphics.Vty.Image.wcwidth', the installation of a custom table

75−-- should be performed before you call 'Graphics.Vty.Image.wcwidth' in

76−-- your program.

77−--

78−-- This is best done at Vty startup, and if you use

79−-- 'Graphics.Vty.mkVty', that function calls this automatically based on

80−-- the Vty configuration's declared width tables. It is exposed as part

81−-- of the public API so that applications can call this as needed if

82−-- they don't want to control the terminal with 'mkVty' but do want to

83−-- make calls to 'Graphics.Vty.Image.wcwidth'.

84−--

85−-- It's also important to note that once a custom table has been

86−-- installed, it is permanent for the life of the process. No new table

87−-- can be installed, and the new custom table cannot be removed.

88−--

89−-- If this function fails for any reason -- if the table cannot be

90−-- installed or is invalid, or if a custom table already exists -- this

91−-- will raise a 'TableInstallException' exception.

92−--

93−-- This function is thread-safe.

94−installUnicodeWidthTable :: UnicodeWidthTable -> IO ()

95−installUnicodeWidthTable table = withInstallLock $ do

96− initResult <- initCustomTable tableSize

97− when (initResult /= 0) $

98− E.throwIO $ TableInitFailure initResult tableSize

99−

100− forM_ (unicodeWidthTableRanges table) $ \r -> do

101− result <- setCustomTableRange (rangeStart r)

102− (rangeSize r)

103− (rangeColumns r)

104−

105− when (result /= 0) $ do

106− deallocateCustomTable

107− E.throwIO $ TableRangeFailure result r

108−

109− actResult <- activateCustomTable

110− when (actResult /= 0) $

111− E.throwIO $ TableActivationFailure actResult

112−

113−------------------------------------------------------------------------

114−-- C imports

115−

116−foreign import ccall unsafe "vty_init_custom_table"

117− initCustomTable :: Int -> IO Int

118−

119−foreign import ccall unsafe "vty_set_custom_table_range"

120− setCustomTableRange :: Word32 -> Word32 -> Word8 -> IO Int

121−

122−foreign import ccall unsafe "vty_activate_custom_table"

123− activateCustomTable :: IO Int

124−

125−foreign import ccall unsafe "vty_custom_table_ready"

126− c_isCustomTableReady :: IO Int

127−

128−foreign import ccall unsafe "vty_deallocate_custom_table"

129− deallocateCustomTable :: IO ()

src/Graphics/Vty/UnicodeWidthTable/Query.hsdeleted−79

@@ -1,79 +0,0 @@

1−{-# LANGUAGE TupleSections #-}

2−module Graphics.Vty.UnicodeWidthTable.Query

3− ( buildUnicodeWidthTable

4− , defaultUnicodeTableUpperBound

5− )

6−where

7−

8−import Control.Monad (forM)

9−import Data.Char (generalCategory, GeneralCategory(..))

10−import System.Console.ANSI (getCursorPosition)

11−import Text.Printf (printf)

12−

13−import Graphics.Vty.UnicodeWidthTable.Types

14−

15−shouldConsider :: Char -> Bool

16−shouldConsider c =

17− case generalCategory c of

18− Control -> False

19− NotAssigned -> False

20− Surrogate -> False

21− _ -> True

22−

23−charWidth :: Char -> IO Int

24−charWidth c = do

25− printf "\r"

26− putChar c

27− Just (_, col) <- getCursorPosition

28− return col

29−

30−-- | Convert a sequence of character/width pairs into a list of

31−-- run-length encoded ranges. This function assumes the pairs come

32−-- sorted by character ordinal value. It does not require that the

33−-- character range is fully covered by the sequence.

34−--

35−-- The result of this function is a list of ranges in reverse order

36−-- relative to the input sequence.

37−mkRanges :: [(Char, Int)] -> [WidthTableRange]

38−mkRanges pairs =

39− let convertedPairs = convert <$> pairs

40− convert (c, i) = (fromIntegral $ fromEnum c, fromIntegral i)

41−

42− go Nothing finishedRanges [] = finishedRanges

43− go (Just r) finishedRanges [] = r:finishedRanges

44−

45− go Nothing finishedRanges ((c, width):rest) =

46− go (Just $ WidthTableRange c 1 width) finishedRanges rest

47−

48− go (Just r@(WidthTableRange prevCh sz prevWidth)) finishedRanges ((c, width):rest) =

49− if c == prevCh + sz && prevWidth == width

50− then go (Just (WidthTableRange prevCh (sz + 1) prevWidth)) finishedRanges rest

51− else go (Just (WidthTableRange c 1 width)) (r:finishedRanges) rest

52−

53− in go Nothing [] convertedPairs

54−

55−-- The uppermost code point to consider when building Unicode width

56−-- tables.

57−defaultUnicodeTableUpperBound :: Char

58−defaultUnicodeTableUpperBound = '\xe0000'

59−

60−-- | Construct a unicode character width table by querying the terminal

61−-- connected to stdout. This works by emitting characters to stdout

62−-- and then querying the terminal to determine the resulting cursor

63−-- position in order to measure character widths. Consequently this will

64−-- generate a lot of output and may take a while, depending on your

65−-- system performance. This should not be run in a terminal while it is

66−-- controlled by Vty.

67−--

68−-- The argument specifies the upper bound code point to test when

69−-- building the table. This allows callers to decide how much of the

70−-- Unicode code point space to scan when building the table.

71−--

72−-- This does not handle exceptions.

73−buildUnicodeWidthTable :: Char -> IO UnicodeWidthTable

74−buildUnicodeWidthTable tableUpperBound = do

75− pairs <- forM (filter shouldConsider ['\0'..tableUpperBound]) $ \i ->

76− (i,) <$> charWidth i

77−

78− return UnicodeWidthTable { unicodeWidthTableRanges = reverse $ mkRanges pairs

79− }

src/Graphics/Vty/UnicodeWidthTable/Types.hsdeleted−29

@@ -1,29 +0,0 @@

1−module Graphics.Vty.UnicodeWidthTable.Types

2− ( UnicodeWidthTable(..)

3− , WidthTableRange(..)

4− )

5−where

6−

7−import Data.Word (Word8, Word32)

8−

9−-- | A range of code points in a width table.

10−data WidthTableRange =

11− WidthTableRange { rangeStart :: Word32

12− -- ^ The range's starting code point.

13− , rangeSize :: Word32

14− -- ^ The number of code points in the contiguous

15− -- range, beginning with the starting code point

16− -- ('rangeStart').

17− , rangeColumns :: Word8

18− -- ^ The terminal width, in columns, of all of the

19− -- characters corresponding to the code points in

20− -- this range.

21− }

22− deriving (Eq, Show)

23−

24−-- | A run-length-encoded table of Unicode character widths.

25−data UnicodeWidthTable =

26− UnicodeWidthTable { unicodeWidthTableRanges :: [WidthTableRange]

27− -- ^ The ranges in the table.

28− }

29− deriving (Show)

test/Verify/Graphics/Vty/Span.hs+1−1

@@ -20,7 +20,7 @@ isAttrSpanOp TextSpan {} = True

2020isAttrSpanOp _ = False

2121

2222verifyAllSpansHaveWidth i spans w

23− = let v = map (\s -> (spanOpsAffectedColumns s /= w, s)) (Vector.toList spans)

23+ = let v = map (\s -> (spanOpsEffectedColumns s /= w, s)) (Vector.toList spans)

2424 in case any ((== True) . fst) v of

2525 False -> succeeded

2626 True -> failed { reason = "Not all spans contained operations defining exactly "

test/VerifyColor240.hsdeleted−269

@@ -1,269 +0,0 @@

1−module VerifyColor240 where

2−

3−import Data.Word(Word8)

4−import Verify

5−

6−import Graphics.Vty.Attributes.Color240(rgbColorToColor240)

7−

8−oldRgbColorToColor240 :: Integral i => i -> i -> i -> Word8

9−oldRgbColorToColor240 r g b

10− | r < 0 && g < 0 && b < 0 = error "rgbColor with negative color component intensity"

11− | r == 8 && g == 8 && b == 8 = 216

12− | r == 18 && g == 18 && b == 18 = 217

13− | r == 28 && g == 28 && b == 28 = 218

14− | r == 38 && g == 38 && b == 38 = 219

15− | r == 48 && g == 48 && b == 48 = 220

16− | r == 58 && g == 58 && b == 58 = 221

17− | r == 68 && g == 68 && b == 68 = 222

18− | r == 78 && g == 78 && b == 78 = 223

19− | r == 88 && g == 88 && b == 88 = 224

20− | r == 98 && g == 98 && b == 98 = 225

21− | r == 108 && g == 108 && b == 108 = 226

22− | r == 118 && g == 118 && b == 118 = 227

23− | r == 128 && g == 128 && b == 128 = 228

24− | r == 138 && g == 138 && b == 138 = 229

25− | r == 148 && g == 148 && b == 148 = 230

26− | r == 158 && g == 158 && b == 158 = 231

27− | r == 168 && g == 168 && b == 168 = 232

28− | r == 178 && g == 178 && b == 178 = 233

29− | r == 188 && g == 188 && b == 188 = 234

30− | r == 198 && g == 198 && b == 198 = 235

31− | r == 208 && g == 208 && b == 208 = 236

32− | r == 218 && g == 218 && b == 218 = 237

33− | r == 228 && g == 228 && b == 228 = 238

34− | r == 238 && g == 238 && b == 238 = 239

35− | r <= 0 && g <= 0 && b <= 0 = 0

36− | r <= 0 && g <= 0 && b <= 95 = 1

37− | r <= 0 && g <= 0 && b <= 135 = 2

38− | r <= 0 && g <= 0 && b <= 175 = 3

39− | r <= 0 && g <= 0 && b <= 215 = 4

40− | r <= 0 && g <= 0 && b <= 255 = 5

41− | r <= 0 && g <= 95 && b <= 0 = 6

42− | r <= 0 && g <= 95 && b <= 95 = 7

43− | r <= 0 && g <= 95 && b <= 135 = 8

44− | r <= 0 && g <= 95 && b <= 175 = 9

45− | r <= 0 && g <= 95 && b <= 215 = 10

46− | r <= 0 && g <= 95 && b <= 255 = 11

47− | r <= 0 && g <= 135 && b <= 0 = 12

48− | r <= 0 && g <= 135 && b <= 95 = 13

49− | r <= 0 && g <= 135 && b <= 135 = 14

50− | r <= 0 && g <= 135 && b <= 175 = 15

51− | r <= 0 && g <= 135 && b <= 215 = 16

52− | r <= 0 && g <= 135 && b <= 255 = 17

53− | r <= 0 && g <= 175 && b <= 0 = 18

54− | r <= 0 && g <= 175 && b <= 95 = 19

55− | r <= 0 && g <= 175 && b <= 135 = 20

56− | r <= 0 && g <= 175 && b <= 175 = 21

57− | r <= 0 && g <= 175 && b <= 215 = 22

58− | r <= 0 && g <= 175 && b <= 255 = 23

59− | r <= 0 && g <= 215 && b <= 0 = 24

60− | r <= 0 && g <= 215 && b <= 95 = 25

61− | r <= 0 && g <= 215 && b <= 135 = 26

62− | r <= 0 && g <= 215 && b <= 175 = 27

63− | r <= 0 && g <= 215 && b <= 215 = 28

64− | r <= 0 && g <= 215 && b <= 255 = 29

65− | r <= 0 && g <= 255 && b <= 0 = 30

66− | r <= 0 && g <= 255 && b <= 95 = 31

67− | r <= 0 && g <= 255 && b <= 135 = 32

68− | r <= 0 && g <= 255 && b <= 175 = 33

69− | r <= 0 && g <= 255 && b <= 215 = 34

70− | r <= 0 && g <= 255 && b <= 255 = 35

71− | r <= 95 && g <= 0 && b <= 0 = 36

72− | r <= 95 && g <= 0 && b <= 95 = 37

73− | r <= 95 && g <= 0 && b <= 135 = 38

74− | r <= 95 && g <= 0 && b <= 175 = 39

75− | r <= 95 && g <= 0 && b <= 215 = 40

76− | r <= 95 && g <= 0 && b <= 255 = 41

77− | r <= 95 && g <= 95 && b <= 0 = 42

78− | r <= 95 && g <= 95 && b <= 95 = 43

79− | r <= 95 && g <= 95 && b <= 135 = 44

80− | r <= 95 && g <= 95 && b <= 175 = 45

81− | r <= 95 && g <= 95 && b <= 215 = 46

82− | r <= 95 && g <= 95 && b <= 255 = 47

83− | r <= 95 && g <= 135 && b <= 0 = 48

84− | r <= 95 && g <= 135 && b <= 95 = 49

85− | r <= 95 && g <= 135 && b <= 135 = 50

86− | r <= 95 && g <= 135 && b <= 175 = 51

87− | r <= 95 && g <= 135 && b <= 215 = 52

88− | r <= 95 && g <= 135 && b <= 255 = 53

89− | r <= 95 && g <= 175 && b <= 0 = 54

90− | r <= 95 && g <= 175 && b <= 95 = 55

91− | r <= 95 && g <= 175 && b <= 135 = 56

92− | r <= 95 && g <= 175 && b <= 175 = 57

93− | r <= 95 && g <= 175 && b <= 215 = 58

94− | r <= 95 && g <= 175 && b <= 255 = 59

95− | r <= 95 && g <= 215 && b <= 0 = 60

96− | r <= 95 && g <= 215 && b <= 95 = 61

97− | r <= 95 && g <= 215 && b <= 135 = 62

98− | r <= 95 && g <= 215 && b <= 175 = 63

99− | r <= 95 && g <= 215 && b <= 215 = 64

100− | r <= 95 && g <= 215 && b <= 255 = 65

101− | r <= 95 && g <= 255 && b <= 0 = 66

102− | r <= 95 && g <= 255 && b <= 95 = 67

103− | r <= 95 && g <= 255 && b <= 135 = 68

104− | r <= 95 && g <= 255 && b <= 175 = 69

105− | r <= 95 && g <= 255 && b <= 215 = 70

106− | r <= 95 && g <= 255 && b <= 255 = 71

107− | r <= 135 && g <= 0 && b <= 0 = 72

108− | r <= 135 && g <= 0 && b <= 95 = 73

109− | r <= 135 && g <= 0 && b <= 135 = 74

110− | r <= 135 && g <= 0 && b <= 175 = 75

111− | r <= 135 && g <= 0 && b <= 215 = 76

112− | r <= 135 && g <= 0 && b <= 255 = 77

113− | r <= 135 && g <= 95 && b <= 0 = 78

114− | r <= 135 && g <= 95 && b <= 95 = 79

115− | r <= 135 && g <= 95 && b <= 135 = 80

116− | r <= 135 && g <= 95 && b <= 175 = 81

117− | r <= 135 && g <= 95 && b <= 215 = 82

118− | r <= 135 && g <= 95 && b <= 255 = 83

119− | r <= 135 && g <= 135 && b <= 0 = 84

120− | r <= 135 && g <= 135 && b <= 95 = 85

121− | r <= 135 && g <= 135 && b <= 135 = 86

122− | r <= 135 && g <= 135 && b <= 175 = 87

123− | r <= 135 && g <= 135 && b <= 215 = 88

124− | r <= 135 && g <= 135 && b <= 255 = 89

125− | r <= 135 && g <= 175 && b <= 0 = 90

126− | r <= 135 && g <= 175 && b <= 95 = 91

127− | r <= 135 && g <= 175 && b <= 135 = 92

128− | r <= 135 && g <= 175 && b <= 175 = 93

129− | r <= 135 && g <= 175 && b <= 215 = 94

130− | r <= 135 && g <= 175 && b <= 255 = 95

131− | r <= 135 && g <= 215 && b <= 0 = 96

132− | r <= 135 && g <= 215 && b <= 95 = 97

133− | r <= 135 && g <= 215 && b <= 135 = 98

134− | r <= 135 && g <= 215 && b <= 175 = 99

135− | r <= 135 && g <= 215 && b <= 215 = 100

136− | r <= 135 && g <= 215 && b <= 255 = 101

137− | r <= 135 && g <= 255 && b <= 0 = 102

138− | r <= 135 && g <= 255 && b <= 95 = 103

139− | r <= 135 && g <= 255 && b <= 135 = 104

140− | r <= 135 && g <= 255 && b <= 175 = 105

141− | r <= 135 && g <= 255 && b <= 215 = 106

142− | r <= 135 && g <= 255 && b <= 255 = 107

143− | r <= 175 && g <= 0 && b <= 0 = 108

144− | r <= 175 && g <= 0 && b <= 95 = 109

145− | r <= 175 && g <= 0 && b <= 135 = 110

146− | r <= 175 && g <= 0 && b <= 175 = 111

147− | r <= 175 && g <= 0 && b <= 215 = 112

148− | r <= 175 && g <= 0 && b <= 255 = 113

149− | r <= 175 && g <= 95 && b <= 0 = 114

150− | r <= 175 && g <= 95 && b <= 95 = 115

151− | r <= 175 && g <= 95 && b <= 135 = 116

152− | r <= 175 && g <= 95 && b <= 175 = 117

153− | r <= 175 && g <= 95 && b <= 215 = 118

154− | r <= 175 && g <= 95 && b <= 255 = 119

155− | r <= 175 && g <= 135 && b <= 0 = 120

156− | r <= 175 && g <= 135 && b <= 95 = 121

157− | r <= 175 && g <= 135 && b <= 135 = 122

158− | r <= 175 && g <= 135 && b <= 175 = 123

159− | r <= 175 && g <= 135 && b <= 215 = 124

160− | r <= 175 && g <= 135 && b <= 255 = 125

161− | r <= 175 && g <= 175 && b <= 0 = 126

162− | r <= 175 && g <= 175 && b <= 95 = 127

163− | r <= 175 && g <= 175 && b <= 135 = 128

164− | r <= 175 && g <= 175 && b <= 175 = 129

165− | r <= 175 && g <= 175 && b <= 215 = 130

166− | r <= 175 && g <= 175 && b <= 255 = 131

167− | r <= 175 && g <= 215 && b <= 0 = 132

168− | r <= 175 && g <= 215 && b <= 95 = 133

169− | r <= 175 && g <= 215 && b <= 135 = 134

170− | r <= 175 && g <= 215 && b <= 175 = 135

171− | r <= 175 && g <= 215 && b <= 215 = 136

172− | r <= 175 && g <= 215 && b <= 255 = 137

173− | r <= 175 && g <= 255 && b <= 0 = 138

174− | r <= 175 && g <= 255 && b <= 95 = 139

175− | r <= 175 && g <= 255 && b <= 135 = 140

176− | r <= 175 && g <= 255 && b <= 175 = 141

177− | r <= 175 && g <= 255 && b <= 215 = 142

178− | r <= 175 && g <= 255 && b <= 255 = 143

179− | r <= 215 && g <= 0 && b <= 0 = 144

180− | r <= 215 && g <= 0 && b <= 95 = 145

181− | r <= 215 && g <= 0 && b <= 135 = 146

182− | r <= 215 && g <= 0 && b <= 175 = 147

183− | r <= 215 && g <= 0 && b <= 215 = 148

184− | r <= 215 && g <= 0 && b <= 255 = 149

185− | r <= 215 && g <= 95 && b <= 0 = 150

186− | r <= 215 && g <= 95 && b <= 95 = 151

187− | r <= 215 && g <= 95 && b <= 135 = 152

188− | r <= 215 && g <= 95 && b <= 175 = 153

189− | r <= 215 && g <= 95 && b <= 215 = 154

190− | r <= 215 && g <= 95 && b <= 255 = 155

191− | r <= 215 && g <= 135 && b <= 0 = 156

192− | r <= 215 && g <= 135 && b <= 95 = 157

193− | r <= 215 && g <= 135 && b <= 135 = 158

194− | r <= 215 && g <= 135 && b <= 175 = 159

195− | r <= 215 && g <= 135 && b <= 215 = 160

196− | r <= 215 && g <= 135 && b <= 255 = 161

197− | r <= 215 && g <= 175 && b <= 0 = 162

198− | r <= 215 && g <= 175 && b <= 95 = 163

199− | r <= 215 && g <= 175 && b <= 135 = 164

200− | r <= 215 && g <= 175 && b <= 175 = 165

201− | r <= 215 && g <= 175 && b <= 215 = 166

202− | r <= 215 && g <= 175 && b <= 255 = 167

203− | r <= 215 && g <= 215 && b <= 0 = 168

204− | r <= 215 && g <= 215 && b <= 95 = 169

205− | r <= 215 && g <= 215 && b <= 135 = 170

206− | r <= 215 && g <= 215 && b <= 175 = 171

207− | r <= 215 && g <= 215 && b <= 215 = 172

208− | r <= 215 && g <= 215 && b <= 255 = 173

209− | r <= 215 && g <= 255 && b <= 0 = 174

210− | r <= 215 && g <= 255 && b <= 95 = 175

211− | r <= 215 && g <= 255 && b <= 135 = 176

212− | r <= 215 && g <= 255 && b <= 175 = 177

213− | r <= 215 && g <= 255 && b <= 215 = 178

214− | r <= 215 && g <= 255 && b <= 255 = 179

215− | r <= 255 && g <= 0 && b <= 0 = 180

216− | r <= 255 && g <= 0 && b <= 95 = 181

217− | r <= 255 && g <= 0 && b <= 135 = 182

218− | r <= 255 && g <= 0 && b <= 175 = 183

219− | r <= 255 && g <= 0 && b <= 215 = 184

220− | r <= 255 && g <= 0 && b <= 255 = 185

221− | r <= 255 && g <= 95 && b <= 0 = 186

222− | r <= 255 && g <= 95 && b <= 95 = 187

223− | r <= 255 && g <= 95 && b <= 135 = 188

224− | r <= 255 && g <= 95 && b <= 175 = 189

225− | r <= 255 && g <= 95 && b <= 215 = 190

226− | r <= 255 && g <= 95 && b <= 255 = 191

227− | r <= 255 && g <= 135 && b <= 0 = 192

228− | r <= 255 && g <= 135 && b <= 95 = 193

229− | r <= 255 && g <= 135 && b <= 135 = 194

230− | r <= 255 && g <= 135 && b <= 175 = 195

231− | r <= 255 && g <= 135 && b <= 215 = 196

232− | r <= 255 && g <= 135 && b <= 255 = 197

233− | r <= 255 && g <= 175 && b <= 0 = 198

234− | r <= 255 && g <= 175 && b <= 95 = 199

235− | r <= 255 && g <= 175 && b <= 135 = 200

236− | r <= 255 && g <= 175 && b <= 175 = 201

237− | r <= 255 && g <= 175 && b <= 215 = 202

238− | r <= 255 && g <= 175 && b <= 255 = 203

239− | r <= 255 && g <= 215 && b <= 0 = 204

240− | r <= 255 && g <= 215 && b <= 95 = 205

241− | r <= 255 && g <= 215 && b <= 135 = 206

242− | r <= 255 && g <= 215 && b <= 175 = 207

243− | r <= 255 && g <= 215 && b <= 215 = 208

244− | r <= 255 && g <= 215 && b <= 255 = 209

245− | r <= 255 && g <= 255 && b <= 0 = 210

246− | r <= 255 && g <= 255 && b <= 95 = 211

247− | r <= 255 && g <= 255 && b <= 135 = 212

248− | r <= 255 && g <= 255 && b <= 175 = 213

249− | r <= 255 && g <= 255 && b <= 215 = 214

250− | r <= 255 && g <= 255 && b <= 255 = 215

251− | otherwise = error (printf "RGB color %d %d %d does not map to 240 palette."

252− (fromIntegral r :: Int)

253− (fromIntegral g :: Int)

254− (fromIntegral b :: Int))

255−

256−sameColor :: Int -> Int -> Int -> Bool

257−sameColor r g b = oldRgbColorToColor240 r g b == rgbColorToColor240 r g b

258−

259−genVal :: Gen Int

260−genVal = chooseInt (0, 255)

261−

262−sameColorCheck :: Property

263−sameColorCheck = forAll genVal (\r -> forAll genVal (\g -> forAll genVal (sameColor r g)))

264−

265−tests :: IO [Test]

266−tests = return

267− [ verify "check rgbColorToColor240 optimization is correct" sameColorCheck

268− ]

269−

test/VerifyEmptyImageProps.hs−1

@@ -1,4 +1,3 @@

1−{-# LANGUAGE ScopedTypeVariables #-}

21module VerifyEmptyImageProps where

43import Verify

test/VerifyEvalTerminfoCaps.hs−1

@@ -1,6 +1,5 @@

11{-# LANGUAGE BangPatterns #-}

22{-# LANGUAGE NamedFieldPuns #-}

3−{-# LANGUAGE ScopedTypeVariables #-}

43module VerifyEvalTerminfoCaps where

65import Blaze.ByteString.Builder.Internal.Write (runWrite, getBound)

test/VerifyImageOps.hs+1−2

@@ -1,4 +1,3 @@

1−{-# LANGUAGE ScopedTypeVariables #-}

21module VerifyImageOps where

43import Graphics.Vty.Attributes

@@ -137,7 +136,7 @@ cropBottomLimitsHeight :: Image -> Int -> Property

137136cropBottomLimitsHeight i v = v >= 0 ==>

138137 v >= imageHeight (cropBottom v i)

139138

140−-- ridiculous tests just to satisfy my desire for nice code coverage :-P

139+-- rediculous tests just to satisfy my desire for nice code coverage :-P

141140canShowImage :: Image -> Bool

142141canShowImage i = length (show i) > 0

143142

test/VerifyOutput.hs+3−7

@@ -1,7 +1,6 @@

1−-- We setup the environment to invoke certain terminals of interest.

1+-- We setup the environment to envoke certain terminals of interest.

22-- This assumes appropriate definitions exist in the current environment

33-- for the terminals of interest.

4−{-# LANGUAGE ScopedTypeVariables #-}

54module VerifyOutput where

76import Verify

@@ -14,6 +13,7 @@ import Verify.Graphics.Vty.Output

1413import Control.Monad

1514

1615import qualified System.Console.Terminfo as Terminfo

16+import System.Posix.Env

1717import System.Posix.IO

1818

1919tests :: IO [Test]

@@ -35,11 +35,7 @@ smokeTestTermNonMac termName i = liftIOResult $ do

3535smokeTestTerm :: String -> Image -> IO Result

3636smokeTestTerm termName i = do

3737 nullOut <- openFd "/dev/null" WriteOnly Nothing defaultFileFlags

38− t <- outputForConfig $ defaultConfig

39− { outputFd = Just nullOut

40− , termName = Just termName

41− , colorMode = Just NoColor

42− }

38+ t <- outputForConfig $ defaultConfig { outputFd = Just nullOut, termName = Just termName }

4339 -- putStrLn $ "context color count: " ++ show (contextColorCount t)

4440 reserveDisplay t

4541 dc <- displayContext t (100,100)

test/VerifyParseTerminfoCaps.hs−1

@@ -1,5 +1,4 @@

11{-# LANGUAGE NamedFieldPuns #-}

2−{-# LANGUAGE ScopedTypeVariables #-}

32module VerifyParseTerminfoCaps where

54import Prelude hiding ( catch )

test/VerifySimpleSpanGeneration.hs+8−8

@@ -25,7 +25,7 @@ unitImageAndZeroWindow1 :: UnitImage -> EmptyWindow -> Bool

2525unitImageAndZeroWindow1 (UnitImage _ i) (EmptyWindow w) =

2626 let p = picForImage i

2727 ops = displayOpsForPic p (regionForWindow w)

28− in ( spanOpsAffectedRows ops == 0 ) && ( allSpansHaveWidth ops 0 )

28+ in ( spanOpsEffectedRows ops == 0 ) && ( allSpansHaveWidth ops 0 )

2929

3030horizSpanImageAndZeroWindow0 :: SingleRowSingleAttrImage -> EmptyWindow -> Bool

3131horizSpanImageAndZeroWindow0 (SingleRowSingleAttrImage { rowImage = i }) (EmptyWindow w) =

@@ -37,7 +37,7 @@ horizSpanImageAndZeroWindow1 :: SingleRowSingleAttrImage -> EmptyWindow -> Bool

3737horizSpanImageAndZeroWindow1 (SingleRowSingleAttrImage { rowImage = i }) (EmptyWindow w) =

3838 let p = picForImage i

3939 ops = displayOpsForPic p (regionForWindow w)

40− in ( spanOpsAffectedRows ops == 0 ) && ( allSpansHaveWidth ops 0 )

40+ in ( spanOpsEffectedRows ops == 0 ) && ( allSpansHaveWidth ops 0 )

4141

4242horizSpanImageAndEqualWindow0 :: SingleRowSingleAttrImage -> Result

4343horizSpanImageAndEqualWindow0 (SingleRowSingleAttrImage { rowImage = i, expectedColumns = c }) =

@@ -51,7 +51,7 @@ horizSpanImageAndEqualWindow1 (SingleRowSingleAttrImage { rowImage = i, expected

5151 let p = picForImage i

5252 w = MockWindow c 1

5353 ops = displayOpsForPic p (regionForWindow w)

54− in spanOpsAffectedRows ops == 1

54+ in spanOpsEffectedRows ops == 1

5555

5656horizSpanImageAndLesserWindow0 :: SingleRowSingleAttrImage -> Result

5757horizSpanImageAndLesserWindow0 (SingleRowSingleAttrImage { rowImage = i, expectedColumns = c }) =

@@ -74,7 +74,7 @@ singleAttrSingleSpanStackCropped1 stack =

7474 expectedRowCount = stackHeight stack `div` 2

7575 w = MockWindow (stackWidth stack) expectedRowCount

7676 ops = displayOpsForPic p (regionForWindow w)

77− actualRowCount = spanOpsAffectedRows ops

77+ actualRowCount = spanOpsEffectedRows ops

7878 in expectedRowCount == actualRowCount

7979

8080singleAttrSingleSpanStackCropped2 :: SingleAttrSingleSpanStack -> SingleAttrSingleSpanStack -> Result

@@ -90,7 +90,7 @@ singleAttrSingleSpanStackCropped3 stack0 stack1 =

9090 w = MockWindow (imageWidth (picImage p)) expectedRowCount

9191 ops = displayOpsForPic p (regionForWindow w)

9292 expectedRowCount = imageHeight (picImage p) `div` 2

93− actualRowCount = spanOpsAffectedRows ops

93+ actualRowCount = spanOpsEffectedRows ops

9494 in expectedRowCount == actualRowCount

9595

9696singleAttrSingleSpanStackCropped4 :: SingleAttrSingleSpanStack -> SingleAttrSingleSpanStack -> Result

@@ -107,7 +107,7 @@ singleAttrSingleSpanStackCropped5 stack0 stack1 =

107107 w = MockWindow (imageWidth (picImage p)) (stackHeight stack0)

108108 ops = displayOpsForPic p (regionForWindow w)

109109 expectedRowCount = stackHeight stack0

110− actualRowCount = spanOpsAffectedRows ops

110+ actualRowCount = spanOpsEffectedRows ops

111111 in expectedRowCount == actualRowCount

112112

113113horizSpanImageAndGreaterWindow0 :: SingleRowSingleAttrImage -> Result

@@ -123,13 +123,13 @@ arbImageIsCropped :: DefaultImage -> MockWindow -> Bool

123123arbImageIsCropped (DefaultImage image) win@(MockWindow w h) =

124124 let pic = picForImage image

125125 ops = displayOpsForPic pic (regionForWindow win)

126− in ( spanOpsAffectedRows ops == h ) && ( allSpansHaveWidth ops w )

126+ in ( spanOpsEffectedRows ops == h ) && ( allSpansHaveWidth ops w )

127127

128128spanOpsActuallyFillRows :: DefaultPic -> Bool

129129spanOpsActuallyFillRows (DefaultPic pic win) =

130130 let ops = displayOpsForPic pic (regionForWindow win)

131131 expectedRowCount = regionHeight (regionForWindow win)

132− actualRowCount = spanOpsAffectedRows ops

132+ actualRowCount = spanOpsEffectedRows ops

133133 in expectedRowCount == actualRowCount

134134

135135spanOpsActuallyFillColumns :: DefaultPic -> Bool

test/VerifyUsingMockInput.hs+1−4

@@ -1,6 +1,5 @@

11{-# LANGUAGE MultiParamTypeClasses #-}

22{-# LANGUAGE FlexibleInstances #-}

3−{-# LANGUAGE ScopedTypeVariables #-}

43-- Generate some input bytes and delays between blocks of input bytes.

54-- Verify the events produced are as expected.

65module Main where

@@ -132,9 +131,7 @@ assertEventsFromSynInput table inputSpec expectedEvents = do

132131 readLoop 0 = return ()

133132 readLoop n = do

134133 e <- atomically $ readTChan $ input^.eventChannel

135− case e of

136− InputEvent ev -> modifyIORef eventsRef ((:) ev)

137− ResumeAfterSignal -> return ()

134+ modifyIORef eventsRef ((:) e)

138135 readLoop (n - 1)

139136 genEventsUsingIoActions maxDuration writeWaitClose readEvents

140137 outEvents <- reverse <$> readIORef eventsRef

test/interactive_terminal_test.hs+1−1

@@ -364,7 +364,7 @@ Did the test output match the description?

364364|]

365365 defaultSuccessConfirmResults

366366

367−-- Explicitly define the bytes that encode each example text.

367+-- Explicitely definethe bytes that encode each example text.

368368-- This avoids any issues with how the compiler represents string literals.

369369--

370370-- This document is UTF-8 encoded so the UTF-8 string is still included for

tools/BuildWidthTable.hsdeleted−144

@@ -1,144 +0,0 @@

1−{-# LANGUAGE ScopedTypeVariables #-}

2−{-# LANGUAGE CPP #-}

3−module Main where

4−

5−import qualified Control.Exception as E

6−import Control.Monad (when)

7−import Data.Maybe (fromMaybe)

8−#if !(MIN_VERSION_base(4,11,0))

9−import Data.Semigroup ((<>))

10−#endif

11−import System.Directory (createDirectoryIfMissing)

12−import System.Environment (getArgs, getProgName)

13−import System.FilePath (takeDirectory)

14−import System.Exit (exitFailure)

15−import System.Console.GetOpt

16−import Text.Read (readMaybe)

17−

18−import Graphics.Vty.Config ( terminalWidthTablePath, currentTerminalName

19− , vtyConfigPath, addConfigWidthMap

20− , ConfigUpdateResult(..)

21− )

22−import Graphics.Vty.UnicodeWidthTable.IO

23−import Graphics.Vty.UnicodeWidthTable.Query

24−

25−data Arg = Help

26− | OutputPath String

27− | TableUpperBound String

28− | UpdateConfig

29− | VtyConfigPath String

30− deriving (Eq, Show)

31−

32−options :: Config -> [OptDescr Arg]

33−options config =

34− [ Option "h" ["help"] (NoArg Help)

35− "This help output"

36− , Option "b" ["bound"] (ReqArg TableUpperBound "MAX_CHAR")

37− ("The maximum Unicode code point to test when building the table " <>

38− "(default: " <> (show $ fromEnum $ configBound config) <> ")")

39− , Option "p" ["path"] (ReqArg OutputPath "PATH")

40− ("The output path to write to (default: " <>

41− fromMaybe "<none>" (configOutputPath config) <> ")")

42− , Option "u" ["update-config"] (NoArg UpdateConfig)

43− "Create or update the Vty configuration file to use the new table (default: no)"

44− , Option "c" ["config-path"] (ReqArg VtyConfigPath "PATH")

45− ("Update the specified Vty configuration file path when -u is set (default: " <>

46− configPath config <> ")")

47− ]

48−

49−data Config =

50− Config { configOutputPath :: Maybe FilePath

51− , configBound :: Char

52− , configUpdate :: Bool

53− , configPath :: FilePath

54− }

55− deriving (Show)

56−

57−mkDefaultConfig :: IO Config

58−mkDefaultConfig = do

59− Config <$> terminalWidthTablePath

60− <*> pure defaultUnicodeTableUpperBound

61− <*> pure False

62− <*> vtyConfigPath

63−

64−usage :: IO ()

65−usage = do

66− config <- mkDefaultConfig

67− pn <- getProgName

68− putStrLn $ "Usage: " <> pn <> " [options]"

69− putStrLn ""

70− putStrLn "This tool queries the terminal on stdout to determine the widths"

71− putStrLn "of Unicode characters rendered to the terminal. The resulting data"

72− putStrLn "is written to a table at the specified output path for later"

73− putStrLn "loading by Vty-based applications."

74− putStrLn ""

75−

76− putStrLn $ usageInfo pn (options config)

77−

78−updateConfigFromArg :: Arg -> Config -> Config

79−updateConfigFromArg Help c =

80− c

81−updateConfigFromArg UpdateConfig c =

82− c { configUpdate = True }

83−updateConfigFromArg (VtyConfigPath p) c =

84− c { configPath = p }

85−updateConfigFromArg (TableUpperBound s) c =

86− case readMaybe s of

87− Nothing -> error $ "Invalid table upper bound: " <> show s

88− Just v -> c { configBound = toEnum v }

89−updateConfigFromArg (OutputPath p) c =

90− c { configOutputPath = Just p }

91−

92−main :: IO ()

93−main = do

94− defConfig <- mkDefaultConfig

95− strArgs <- getArgs

96− let (args, unused, errors) = getOpt Permute (options defConfig) strArgs

97−

98− when (not $ null errors) $ do

99− mapM_ putStrLn errors

100− exitFailure

101−

102− when ((not $ null unused) || (Help `elem` args)) $ do

103− usage

104− exitFailure

105−

106− let config = foldr updateConfigFromArg defConfig args

107−

108− outputPath <- case configOutputPath config of

109− Nothing -> do

110− putStrLn "Error: could not obtain terminal width table path"

111− exitFailure

112− Just path -> return path

113−

114− putStrLn "Querying terminal:"

115− builtTable <- buildUnicodeWidthTable $ configBound config

116−

117− let dir = takeDirectory outputPath

118− createDirectoryIfMissing True dir

119− writeUnicodeWidthTable outputPath builtTable

120−

121− putStrLn $ "\nOutput table written to " <> outputPath

122−

123− when (configUpdate config) $ do

124− let cPath = configPath config

125− Just tName <- currentTerminalName

126−

127− result <- E.try $ addConfigWidthMap cPath tName outputPath

128−

129− case result of

130− Left (e::E.SomeException) -> do

131− putStrLn $ "Error updating Vty configuration at " <> cPath <> ": " <>

132− show e

133− exitFailure

134− Right ConfigurationCreated -> do

135− putStrLn $ "Configuration file created: " <> cPath

136− Right ConfigurationModified -> do

137− putStrLn $ "Configuration file updated: " <> cPath

138− Right (ConfigurationConflict other) -> do

139− putStrLn $ "Configuration file not updated: uses a different table " <>

140− "for TERM=" <> tName <> ": " <> other

141− Right ConfigurationRedundant -> do

142− putStrLn $ "Configuration file not updated: configuration " <>

143− cPath <> " already uses table " <> outputPath <>

144− " for TERM=" <> tName

vty.cabal+45−73

@@ -1,5 +1,5 @@

11name: vty

2−version: 5.35.1

2+version: 5.25

33license: BSD3

44license-file: LICENSE

55author: AUTHORS

@@ -30,7 +30,7 @@ extra-doc-files: README.md,

3030 AUTHORS,

3131 CHANGELOG.md,

3232 LICENSE

33−tested-with: GHC==7.10.3, GHC==8.0.2, GHC==8.2.2, GHC==8.4.3, GHC==8.6.5

33+tested-with: GHC==7.10.3, GHC==8.0.2, GHC==8.2.2, GHC==8.4.3

3434

3535source-repository head

3636 type: git

@@ -45,9 +45,10 @@ library

4545 deepseq >= 1.1 && < 1.5,

4646 directory,

4747 filepath >= 1.0 && < 2.0,

48− microlens < 0.4.13,

48+ microlens < 0.4.11,

4949 microlens-mtl,

5050 microlens-th,

51+ -- required for nice installation with yi

5152 hashable >= 1.2,

5253 mtl >= 1.1.1.0 && < 2.3,

5354 parallel >= 2.2 && < 3.3,

@@ -58,18 +59,13 @@ library

5859 text >= 0.11.3,

5960 unix,

6061 utf8-string >= 0.3 && < 1.1,

61− vector >= 0.7,

62− binary,

63− ansi-terminal >= 0.10.3

62+ vector >= 0.7

6463

6564 if !impl(ghc >= 8.0)

66− build-depends: semigroups >= 0.16,

67− fail

65+ build-depends: semigroups >= 0.16

6866

6967 exposed-modules: Graphics.Vty

7068 Graphics.Vty.Attributes

71− Graphics.Vty.Attributes.Color

72− Graphics.Vty.Attributes.Color240

7369 Graphics.Vty.Config

7470 Graphics.Vty.Error

7571 Graphics.Vty.Image

@@ -80,6 +76,7 @@ library

8076 Graphics.Vty.Picture

8177 Graphics.Vty.Output

8278 Graphics.Text.Width

79+ -- the modules below are only meant to be used by the tests.

8380 Codec.Binary.UTF8.Debug

8481 Data.Terminfo.Parse

8582 Data.Terminfo.Eval

@@ -100,47 +97,33 @@ library

10097 Graphics.Vty.Output.Interface

10198 Graphics.Vty.Output.XTermColor

10299 Graphics.Vty.Output.TerminfoBased

103− Graphics.Vty.UnicodeWidthTable.Types

104− Graphics.Vty.UnicodeWidthTable.IO

105− Graphics.Vty.UnicodeWidthTable.Query

106− Graphics.Vty.UnicodeWidthTable.Install

107100

108− other-modules: Graphics.Vty.Debug.Image

101+ other-modules: Graphics.Vty.Attributes.Color

102+ Graphics.Vty.Attributes.Color240

103+ Graphics.Vty.Debug.Image

109104 Graphics.Vty.Input.Terminfo.ANSIVT

110105

111106 c-sources: cbits/gwinsz.c

112107 cbits/set_term_timing.c

113− cbits/get_tty_erase.c

114108 cbits/mk_wcwidth.c

115109

116110 include-dirs: cbits

117111

118112 hs-source-dirs: src

119113

114+ default-extensions: ScopedTypeVariables

115+ ForeignFunctionInterface

116+

120117 ghc-options: -O2 -funbox-strict-fields -Wall -fspec-constr -fspec-constr-count=10

121118

122119 ghc-prof-options: -O2 -funbox-strict-fields -caf-all -Wall -fspec-constr -fspec-constr-count=10

123120

124−executable vty-build-width-table

125− main-is: BuildWidthTable.hs

126− hs-source-dirs: tools

127−

128− default-language: Haskell2010

129− ghc-options: -threaded -Wall

130−

131− if !impl(ghc >= 8.0)

132− build-depends: semigroups >= 0.16

133−

134− build-depends: vty,

135− directory,

136− filepath,

137− base >= 4.8 && < 5

138−

139121executable vty-mode-demo

140122 main-is: ModeDemo.hs

141123 hs-source-dirs: demos

142124

143125 default-language: Haskell2010

126+ default-extensions: ScopedTypeVariables

144127 ghc-options: -threaded

145128

146129 build-depends: vty,

@@ -155,6 +138,7 @@ executable vty-demo

155138 hs-source-dirs: demos

156139

157140 default-language: Haskell2010

141+ default-extensions: ScopedTypeVariables

158142 ghc-options: -threaded

159143

160144 build-depends: vty,

@@ -166,6 +150,7 @@ executable vty-demo

166150

167151test-suite verify-using-mock-terminal

168152 default-language: Haskell2010

153+ default-extensions: ScopedTypeVariables

169154

170155 type: detailed-0.9

171156

@@ -184,7 +169,7 @@ test-suite verify-using-mock-terminal

184169 build-depends: vty,

185170 Cabal >= 1.20,

186171 QuickCheck >= 2.7,

187− random >= 1.0 && < 1.3,

172+ random >= 1.0 && < 1.2,

188173 base >= 4.8 && < 5,

189174 bytestring,

190175 containers,

@@ -198,6 +183,7 @@ test-suite verify-using-mock-terminal

198183

199184test-suite verify-terminal

200185 default-language: Haskell2010

186+ default-extensions: ScopedTypeVariables

201187

202188 type: detailed-0.9

203189

@@ -216,7 +202,7 @@ test-suite verify-terminal

216202 build-depends: vty,

217203 Cabal >= 1.20,

218204 QuickCheck >= 2.7,

219− random >= 1.0 && < 1.3,

205+ random >= 1.0 && < 1.2,

220206 base >= 4.8 && < 5,

221207 bytestring,

222208 containers,

@@ -230,6 +216,7 @@ test-suite verify-terminal

230216

231217test-suite verify-display-attributes

232218 default-language: Haskell2010

219+ default-extensions: ScopedTypeVariables

233220

234221 type: detailed-0.9

235222

@@ -248,7 +235,7 @@ test-suite verify-display-attributes

248235 build-depends: vty,

249236 Cabal >= 1.20,

250237 QuickCheck >= 2.7,

251− random >= 1.0 && < 1.3,

238+ random >= 1.0 && < 1.2,

252239 base >= 4.8 && < 5,

253240 bytestring,

254241 containers,

@@ -261,6 +248,7 @@ test-suite verify-display-attributes

261248

262249test-suite verify-empty-image-props

263250 default-language: Haskell2010

251+ default-extensions: ScopedTypeVariables

264252

265253 type: detailed-0.9

266254

@@ -273,7 +261,7 @@ test-suite verify-empty-image-props

273261 build-depends: vty,

274262 Cabal >= 1.20,

275263 QuickCheck >= 2.7,

276− random >= 1.0 && < 1.3,

264+ random >= 1.0 && < 1.2,

277265 base >= 4.8 && < 5,

278266 bytestring,

279267 containers,

@@ -286,6 +274,7 @@ test-suite verify-empty-image-props

286274

287275test-suite verify-eval-terminfo-caps

288276 default-language: Haskell2010

277+ default-extensions: ScopedTypeVariables

289278

290279 type: detailed-0.9

291280

@@ -299,7 +288,7 @@ test-suite verify-eval-terminfo-caps

299288 build-depends: vty,

300289 Cabal >= 1.20,

301290 QuickCheck >= 2.7,

302− random >= 1.0 && < 1.3,

291+ random >= 1.0 && < 1.2,

303292 base >= 4.8 && < 5,

304293 blaze-builder >= 0.3.3.2 && < 0.5,

305294 bytestring,

@@ -314,6 +303,7 @@ test-suite verify-eval-terminfo-caps

314303

315304test-suite verify-image-ops

316305 default-language: Haskell2010

306+ default-extensions: ScopedTypeVariables

317307

318308 type: detailed-0.9

319309

@@ -328,7 +318,7 @@ test-suite verify-image-ops

328318 build-depends: vty,

329319 Cabal >= 1.20,

330320 QuickCheck >= 2.7,

331− random >= 1.0 && < 1.3,

321+ random >= 1.0 && < 1.2,

332322 base >= 4.8 && < 5,

333323 bytestring,

334324 containers,

@@ -341,6 +331,7 @@ test-suite verify-image-ops

341331

342332test-suite verify-image-trans

343333 default-language: Haskell2010

334+ default-extensions: ScopedTypeVariables

344335

345336 type: detailed-0.9

346337

@@ -355,7 +346,7 @@ test-suite verify-image-trans

355346 build-depends: vty,

356347 Cabal >= 1.20,

357348 QuickCheck >= 2.7,

358− random >= 1.0 && < 1.3,

349+ random >= 1.0 && < 1.2,

359350 base >= 4.8 && < 5,

360351 bytestring,

361352 containers,

@@ -368,6 +359,7 @@ test-suite verify-image-trans

368359

369360test-suite verify-inline

370361 default-language: Haskell2010

362+ default-extensions: ScopedTypeVariables

371363

372364 type: detailed-0.9

373365

@@ -381,7 +373,7 @@ test-suite verify-inline

381373 build-depends: vty,

382374 Cabal >= 1.20,

383375 QuickCheck >= 2.7,

384− random >= 1.0 && < 1.3,

376+ random >= 1.0 && < 1.2,

385377 base >= 4.8 && < 5,

386378 bytestring,

387379 containers,

@@ -394,6 +386,7 @@ test-suite verify-inline

394386

395387test-suite verify-parse-terminfo-caps

396388 default-language: Haskell2010

389+ default-extensions: ScopedTypeVariables

397390

398391 type: detailed-0.9

399392

@@ -408,7 +401,7 @@ test-suite verify-parse-terminfo-caps

408401 build-depends: vty,

409402 Cabal >= 1.20,

410403 QuickCheck >= 2.7,

411− random >= 1.0 && < 1.3,

404+ random >= 1.0 && < 1.2,

412405 base >= 4.8 && < 5,

413406 bytestring,

414407 containers,

@@ -422,6 +415,7 @@ test-suite verify-parse-terminfo-caps

422415

423416test-suite verify-simple-span-generation

424417 default-language: Haskell2010

418+ default-extensions: ScopedTypeVariables

425419

426420 type: detailed-0.9

427421

@@ -439,7 +433,7 @@ test-suite verify-simple-span-generation

439433 build-depends: vty,

440434 Cabal >= 1.20,

441435 QuickCheck >= 2.7,

442− random >= 1.0 && < 1.3,

436+ random >= 1.0 && < 1.2,

443437 base >= 4.8 && < 5,

444438 bytestring,

445439 containers,

@@ -453,6 +447,7 @@ test-suite verify-simple-span-generation

453447

454448test-suite verify-crop-span-generation

455449 default-language: Haskell2010

450+ default-extensions: ScopedTypeVariables

456451

457452 type: detailed-0.9

458453

@@ -470,7 +465,7 @@ test-suite verify-crop-span-generation

470465 build-depends: vty,

471466 Cabal >= 1.20,

472467 QuickCheck >= 2.7,

473− random >= 1.0 && < 1.3,

468+ random >= 1.0 && < 1.2,

474469 base >= 4.8 && < 5,

475470 bytestring,

476471 containers,

@@ -484,6 +479,7 @@ test-suite verify-crop-span-generation

484479

485480test-suite verify-layers-span-generation

486481 default-language: Haskell2010

482+ default-extensions: ScopedTypeVariables

487483

488484 type: detailed-0.9

489485

@@ -501,32 +497,7 @@ test-suite verify-layers-span-generation

501497 build-depends: vty,

502498 Cabal >= 1.20,

503499 QuickCheck >= 2.7,

504− random >= 1.0 && < 1.3,

505− base >= 4.8 && < 5,

506− bytestring,

507− containers,

508− deepseq >= 1.1 && < 1.5,

509− mtl >= 1.1.1.0 && < 2.3,

510− text >= 0.11.3,

511− unix,

512− utf8-string >= 0.3 && < 1.1,

513− vector >= 0.7

514−

515−test-suite verify-color-mapping

516− default-language: Haskell2010

517−

518− type: detailed-0.9

519−

520− hs-source-dirs: test

521−

522− test-module: VerifyColor240

523−

524− other-modules: Verify

525−

526− build-depends: vty,

527− Cabal >= 1.20,

528− QuickCheck >= 2.7,

529− random >= 1.0 && < 1.3,

500+ random >= 1.0 && < 1.2,

530501 base >= 4.8 && < 5,

531502 bytestring,

532503 containers,

@@ -539,6 +510,7 @@ test-suite verify-color-mapping

539510

540511test-suite verify-utf8-width

541512 default-language: Haskell2010

513+ default-extensions: ScopedTypeVariables

542514

543515 type: detailed-0.9

544516

@@ -551,7 +523,7 @@ test-suite verify-utf8-width

551523 build-depends: vty,

552524 Cabal >= 1.20,

553525 QuickCheck >= 2.7,

554− random >= 1.0 && < 1.3,

526+ random >= 1.0 && < 1.2,

555527 base >= 4.8 && < 5,

556528 bytestring,

557529 containers,

@@ -564,6 +536,7 @@ test-suite verify-utf8-width

564536

565537test-suite verify-using-mock-input

566538 default-language: Haskell2010

539+ default-extensions: ScopedTypeVariables

567540

568541 type: exitcode-stdio-1.0

569542

@@ -571,8 +544,6 @@ test-suite verify-using-mock-input

571544

572545 main-is: VerifyUsingMockInput.hs

573546

574− other-modules: Verify.Graphics.Vty.Output

575−

576547 build-depends: vty,

577548 Cabal >= 1.20,

578549 QuickCheck >= 2.7,

@@ -580,7 +551,7 @@ test-suite verify-using-mock-input

580551 quickcheck-assertions >= 0.1.1,

581552 test-framework == 0.8.*,

582553 test-framework-smallcheck == 0.2.*,

583− random >= 1.0 && < 1.3,

554+ random >= 1.0 && < 1.2,

584555 base >= 4.8 && < 5,

585556 bytestring,

586557 containers,

@@ -599,6 +570,7 @@ test-suite verify-using-mock-input

599570

600571test-suite verify-config

601572 default-language: Haskell2010

573+ default-extensions: ScopedTypeVariables

602574

603575 type: exitcode-stdio-1.0

604576

@@ -615,7 +587,7 @@ test-suite verify-config

615587 test-framework == 0.8.*,

616588 test-framework-smallcheck == 0.2.*,

617589 test-framework-hunit,

618− random >= 1.0 && < 1.3,

590+ random >= 1.0 && < 1.2,

619591 base >= 4.8 && < 5,

620592 bytestring,

621593 containers,