1dac87e...master · vty

.gitignore+1

@@ -6,6 +6,7 @@ Setup

66dist

77dist-newstyle

88cabal.project.local

9+.ghc.environment.*

910test/benchmark

1011.hpc

1112.cabal-sandbox

.travis.yml+100−18

@@ -1,27 +1,109 @@

1−language: haskell

1+# This Travis job script has been generated by a script via

2+#

3+# runghc make_travis_yml_2.hs 'vty.cabal'

4+#

5+# For more information, see https://github.com/haskell-CI/haskell-ci

6+#

7+language: c

8+sudo: false

29

3−notifications:

4− email: false

10+git:

11+ submodules: false # whether to recursively clone submodules

12+

13+cache:

14+ directories:

15+ - $HOME/.cabal/packages

16+ - $HOME/.cabal/store

17+

18+before_cache:

19+ - rm -fv $HOME/.cabal/packages/hackage.haskell.org/build-reports.log

20+ # remove files that are regenerated by 'cabal update'

21+ - rm -fv $HOME/.cabal/packages/hackage.haskell.org/00-index.*

22+ - rm -fv $HOME/.cabal/packages/hackage.haskell.org/*.json

23+ - rm -fv $HOME/.cabal/packages/hackage.haskell.org/01-index.cache

24+ - rm -fv $HOME/.cabal/packages/hackage.haskell.org/01-index.tar

25+ - rm -fv $HOME/.cabal/packages/hackage.haskell.org/01-index.tar.idx

26+

27+ - rm -rfv $HOME/.cabal/packages/head.hackage

528

629matrix:

7− allow_failures:

8− - env: CABALVER=head GHCVER=head

30+ include:

31+ - compiler: "ghc-8.4.3"

32+ # env: TEST=--disable-tests BENCH=--disable-benchmarks

33+ addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.2,ghc-8.4.3], sources: [hvr-ghc]}}

34+ - compiler: "ghc-8.2.2"

35+ # env: TEST=--disable-tests BENCH=--disable-benchmarks

36+ addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.2,ghc-8.2.2], sources: [hvr-ghc]}}

37+ - compiler: "ghc-8.0.2"

38+ # env: TEST=--disable-tests BENCH=--disable-benchmarks

39+ addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.2,ghc-8.0.2], sources: [hvr-ghc]}}

40+ - compiler: "ghc-7.10.3"

41+ # env: TEST=--disable-tests BENCH=--disable-benchmarks

42+ addons: {apt: {packages: [ghc-ppa-tools,cabal-install-2.2,ghc-7.10.3], sources: [hvr-ghc]}}

943

10−env:

11− - CABALVER=1.20 GHCVER=7.6.3

12− - CABALVER=1.20 GHCVER=7.8.3

13− - CABALVER=1.22 GHCVER=7.10.1

14− - CABALVER=1.24 GHCVER=8.0.1

15− - CABALVER=head GHCVER=head

44+before_install:

45+ - HC=${CC}

46+ - HCPKG=${HC/ghc/ghc-pkg}

47+ - unset CC

48+ - ROOTDIR=$(pwd)

49+ - mkdir -p $HOME/.local/bin

50+ - "PATH=/opt/ghc/bin:/opt/ghc-ppa-tools/bin:$HOME/local/bin:$PATH"

51+ - HCNUMVER=$(( $(${HC} --numeric-version|sed -E 's/([0-9]+)\.([0-9]+)\.([0-9]+).*/\1 * 10000 + \2 * 100 + \3/') ))

52+ - echo $HCNUMVER

1653

1754install:

18− - ./ci/travis_ci_install

55+ - cabal --version

56+ - echo "$(${HC} --version) [$(${HC} --print-project-git-commit-id 2> /dev/null || echo '?')]"

57+ - BENCH=${BENCH---enable-benchmarks}

58+ - TEST=${TEST---enable-tests}

59+ - HADDOCK=${HADDOCK-true}

60+ - UNCONSTRAINED=${UNCONSTRAINED-true}

61+ - NOINSTALLEDCONSTRAINTS=${NOINSTALLEDCONSTRAINTS-false}

62+ - GHCHEAD=${GHCHEAD-false}

63+ - travis_retry cabal update -v

64+ - "sed -i.bak 's/^jobs:/-- jobs:/' ${HOME}/.cabal/config"

65+ - rm -fv cabal.project cabal.project.local

66+ - grep -Ev -- '^\s*--' ${HOME}/.cabal/config | grep -Ev '^\s*$'

67+ - "printf 'packages: \".\"\\n' > cabal.project"

68+ - touch cabal.project.local

69+ - "if ! $NOINSTALLEDCONSTRAINTS; then for pkg in $($HCPKG list --simple-output); do echo $pkg | grep -vw -- vty | sed 's/^/constraints: /' | sed 's/-[^-]*$/ installed/' >> cabal.project.local; done; fi"

70+ - cat cabal.project || true

71+ - cat cabal.project.local || true

72+ - if [ -f "./configure.ac" ]; then

73+ (cd "." && autoreconf -i);

74+ fi

75+ - rm -f cabal.project.freeze

76+ - cabal new-build -w ${HC} ${TEST} ${BENCH} --project-file="cabal.project" --dep -j2 all

77+ - cabal new-build -w ${HC} --disable-tests --disable-benchmarks --project-file="cabal.project" --dep -j2 all

78+ - rm -rf .ghc.environment.* "."/dist

79+ - DISTDIR=$(mktemp -d /tmp/dist-test.XXXX)

1980

81+# Here starts the actual work to be performed for the package under test;

82+# any command which exits with a non-zero exit code causes the build to fail.

2083script:

21− - ./ci/travis_ci_script

84+ # test that source-distributions can be generated

85+ - (cd "." && cabal sdist)

86+ - mv "."/dist/vty-*.tar.gz ${DISTDIR}/

87+ - cd ${DISTDIR} || false

88+ - find . -maxdepth 1 -name '*.tar.gz' -exec tar -xvf '{}' \;

89+ - "printf 'packages: vty-*/*.cabal\\n' > cabal.project"

90+ - touch cabal.project.local

91+ - "if ! $NOINSTALLEDCONSTRAINTS; then for pkg in $($HCPKG list --simple-output); do echo $pkg | grep -vw -- vty | sed 's/^/constraints: /' | sed 's/-[^-]*$/ installed/' >> cabal.project.local; done; fi"

92+ - cat cabal.project || true

93+ - cat cabal.project.local || true

94+ # this builds all libraries and executables (without tests/benchmarks)

95+ - cabal new-build -w ${HC} --disable-tests --disable-benchmarks all

2296

23−before_install:

24− - sudo add-apt-repository -y ppa:hvr/ghc

25− - sudo apt-get update

26− - sudo apt-get install cabal-install-$CABALVER ghc-$GHCVER

27− - export PATH=/opt/ghc/$GHCVER/bin:$PATH

97+ # build & run tests, build benchmarks

98+ - cabal new-build -w ${HC} ${TEST} ${BENCH} all

99+ - if [ "x$TEST" = "x--enable-tests" ]; then cabal new-test -w ${HC} ${TEST} ${BENCH} all; fi

100+

101+ # haddock

102+ - rm -rf ./dist-newstyle

103+ - if $HADDOCK; then cabal new-haddock -w ${HC} ${TEST} ${BENCH} all; else echo "Skipping haddock generation";fi

104+

105+ # Build without installed constraints for packages in global-db

106+ - if $UNCONSTRAINED; then rm -f cabal.project.local; echo cabal new-build -w ${HC} --disable-tests --disable-benchmarks all; else echo "Not building without installed constraints"; fi

107+

108+# REGENDATA ["vty.cabal"]

109+# EOF

CHANGELOG.md+782−329

@@ -1,408 +1,861 @@

1+

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+

229+5.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.

236+

237+5.24.1

238+------

239+

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

241+

242+5.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)

249+

250+5.23.1

251+------

252+

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

254+ modes (#155, thanks Eric Mertens)

255+

256+5.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.

265+

266+5.22

267+----

268+

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

270+ (thanks Brent Carmer)

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

272+

273+5.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

279+

280+5.20

281+----

282+

283+API changes:

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

285+ (thanks Ryan Scott)

286+

287+5.19.1

288+------

289+

290+API changes:

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

292+

293+5.19

294+----

295+

296+API 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.

302+

303+5.18.1

304+------

305+

306+Bug fixes:

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

308+

309+5.18

310+----

311+

312+API 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

316+

317+5.17.1

318+------

319+

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

321+ untouched if the input style is the null style

322+

323+5.17

324+----

325+

326+API 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)

336+

337+5.16

338+----

339+

340+API 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!

344+

345+Bug fixes:

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

347+

348+5.15.1

349+------

350+

351+Package changes:

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

353+ Suchánek)

354+

355+Bug fixes:

356+* translateX/Y: fix negative translations

357+

358+5.15

359+----

360+

361+Package 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).

368+

369+API 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.

379+

13805.14

2− - addMaybeClippedJoin: instead of raising an exception when the join

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

4− - addMaybeClipped: skip blit of joins when their primary dimension is

5− zero

6− - 'string' and related text functions no longer treat an empty string

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

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

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.

9390

103915.13

11− - Reverted changes in 5.12 due to disagreements between terminal

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

13− discussion at

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

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

15398

163995.12

17− - Replaced 'wcwidth' with a call to the utf8proc library's character

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

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

20− characters.

21− - Added a bundled version of the utf8proc C library.

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.

22407

234085.11.3

24− - Fix mouse event offsets in mouse-up events

409+------

410+

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

25412

264135.11.2

27− - Mouse events were modified so that the upper-left corner of the

28− window is (0,0) rather than (1,1).

414+------

415+

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

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

29418

304195.11.1

31− - Add Generic instance for Image

32− - nextEvent: stop trying to refresh on a resize event (fixes segfault

33− on refresh with normal cursor positioning mode)

34− - Remove redundant clause from clipForCharWidth (thanks Eric Mertens)

35− - Update maintainer

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

36427

374285.11

38− - Vty now raises a VtyConfigurationError exception when the TERM

39− evironment variable is missing (thanks Eric Mertens)

40− - Graphics.Vty.Config got an explicit export list to avoid accidentally

41− exporting internal types (thanks Eric Mertens)

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)

42435

434365.10

44− - Add absolute cursor positioning mode AbsoluteCursor to Cursor. This

45− mode provides greater control over cursor positioning by bypassing

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

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

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

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

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

51− - Fixed the MShift case in the configuration file parser (thanks Eric

52− Mertens)

53− - Fixed wcwidth import and matched safeWcswidth to its documented

54− behavior. Previously vty_mk_wcwidth was being imported with

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

56− wrong Int value. Additionally safeWcswidth was using the unsafe

57− character width function and only ensuring that the final result was

58− non-negative. (thanks Eric Mertens)

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)

59454

604555.9.1

61− - Vty now only emits UTF8 charset sequences in terminals without a

62− preexisting UTF8 declaration to avoid emitting garbage sequences

63− (fixes #89)

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)

64461

654625.9

66− - Added new Output methods supportsBell and ringTerminalBell to find

67− out whether the output device has an audio bell and to ring it (see

68− #102)

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)

69467

704685.8.1

71− - Fixed "refresh" to work as advertised (see #104)

469+-----

470+

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

72472

734735.8

74− - API change: EvPaste input event now provides paste data as a raw

75− ByteString rather than a String to allow the application to decode

76− how best to decode it

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

77479

784805.7.1

79− - ModeDemo: added an explicit Control.Applicative import for older

80− GHCs

481+-----

482+

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

81484

824855.7

83− - Mouse and paste modes are now off by default.

84− - The Config type got new fields: mouseMode and bracketedPasteMode.

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

86− terminals that support them).

87− - Added a Mode type for modal terminal features (mouse events,

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

89− functions:

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

91− mode

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

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

94− off

95− - Added a new demo program, ModeDemo.hs, to demonstrate usage of modes

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

96501

975025.6

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

99− terminals via the MouseDown and MouseUp Event constructors

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

101− the EvPaste event constructor

102− - Added derived Show instances for Event and Button (thanks Felix

103− Hirn)

104− - Now TERM values containing "screen" will automatically use the

105− XtermColor driver rather than just TerminfoBased

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

106513

1075145.5.0

108− - Replaced lens dependency with microlens, microlens-mtl, microlens-th

109− dependencies. Issue #90

110− - Thanks Jonathan Daugherty

111− - Cabal corrections.

112− - Thanks Lennart Spitzner

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

113522

1145235.4.0

115− - Changed eventChannel of Graphics.Vty.Input from Chan to TChan.

116− This enables clients to query if there are no pending events. The

117− Graphics.Vty interface nextEvent is unchanged. Clients that use

118− eventChannel directly will require updating.

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

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+

1205325.3.1

121− - Reverted cabal file to depend on Cabal >= 1.18 instead of 1.20 due

122− to possibly breaking this on reasonable GHC versions

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

123537

1245385.3

125− - Upgraded QuickCheck dependency to 2.7

126− - The standard IO Config (standardIOConfig) was overriding any

127− provided application config. In addition, the inputFd and outputFd

128− could not be changed if mkVty was used. Fixed.

129− - Correct handling of display attributes at end of line. The output

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

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

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

133− and was the cause of https://github.com/coreyoconnor/vty/issues/76

134− IIRC Yi requires the old behavior to display the selection region

135− correctly.

136− - shutdown of the input thread is now performed using killThread and

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

138− read vmin and vtime the read must be a blocking read on an OS

139− thread. This places a threadWaitRead, which will be interrupted by

140− the killThread, prior to the uninterruptable read. An alternative

141− would be to re-import the read foreign call as interruptable.

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.

142557

1435585.2.11

144− - deepseq bounds increased for tests.

145− - Clean up warnings when compiling on 7.10

146− - Thanks Eric Mertens

147− - Avoid discarding input bytes after multi-byte encoded codepoint

148− - Thanks Eric Mertens

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

149566

1505675.2.10

151− - "str" now returns EmptyImage for empty strings to match behavior of

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

153− - Thanks Jonathan Daugherty

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

154573

1555745.2.9

156− - dependency version bumps

157− - https://github.com/coreyoconnor/vty/pull/71

158− - https://github.com/coreyoconnor/vty/pull/70

159− - Correct/Simplify the example code

160− - Thanks glguy

161− - https://github.com/coreyoconnor/vty/pull/69

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

162583

1635845.2.8

164− - blaze-builder, lens, utf8-string version constraint bump

165− - Thanks glguy

166− - https://github.com/coreyoconnor/vty/pull/67

167− - Do not differentiate based on TERM_PROGRAM

168− - https://github.com/coreyoconnor/vty/issues/68

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

169592

1705935.2.7

171− - lens and deepseq constraint bump + misc

172− - Thanks ethercrow

173− - https://github.com/coreyoconnor/vty/pull/66

594+-----

595+

596+* lens and deepseq constraint bump + misc

597+ * Thanks ethercrow

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

174599

1756005.2.6

176− - lens constraint bump

177− - Thanks alexander-b!

178− - https://github.com/coreyoconnor/vty/pull/64

601+-----

602+

603+* lens constraint bump

604+ * Thanks alexander-b!

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

179606

1806075.2.5

181− - lens and random version constraint bump.

182− - Thanks RyanGlScott!

183− - https://github.com/coreyoconnor/vty/pull/62

608+-----

609+

610+* lens and random version constraint bump.

611+ * Thanks RyanGlScott!

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

184613

1856145.2.4

186− - removed -fpic from cc-options. No longer required.

187− - https://github.com/coreyoconnor/vty/issues/61

188− - https://ghc.haskell.org/trac/ghc/ticket/9657

189− - Thanks Fuuzetsu!

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!

190621

1916225.2.3

192− - evaluate/compile the input parsing table once instead of each

193− keystroke.

194− - https://github.com/coreyoconnor/vty/pull/59

195− - Thanks ethercrow!

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!

196629

1976305.2.2

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

199− - https://github.com/coreyoconnor/vty/pull/57

200− - Thanks ethercrow!

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!

201636

2026375.2.1

203− - Bump upper version bound for lens to 4.5. Thanks markus1189!

638+-----

639+

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

204641

2056425.2.0

206− - Config structure now specifies file descriptor to use. The default

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

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

209− - hDuplicate stdout >>= handleToFd >>= (`hSetBuffering`

210− NoBuffering)

211− - the difference was required by Vty.Inline. Now, Vty.Inline uses

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

213− - removed: derivedVtime, derivedVmin, inputForCurrentTerminal,

214− inputForNameAndIO, outputForCurrentTerminal, outputForNameAndIO

215− - added: inputForConfig, outputForConfig

216− - updates to vty-rogue from jtdaugherty. Thanks!

217− - the oldest version of GHC tested to support vty is 7.6.2.

218− - the oldest version of GHC that vty compiles under is 7.4.2

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

219658

2206595.1.4

221− - merged https://github.com/coreyoconnor/vty/pull/51 thanks trofi!

660+-----

661+

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

222663

2236645.1.1

224− - merged https://github.com/coreyoconnor/vty/pull/48 thanks sjmielke!

225− - jtdaugherty resolved a number of compiler warnings. Thanks!

665+-----

666+

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

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

226669

2276705.1.0

228− - vmin and vtime can be specified however the application requires.

229− See Graphics.Vty.Config.

230− - fixed the processing of input when vmin is set > 1.

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.

231676

2326775.0.0

233− - The naming convention now matches:

234− - http://www.haskell.org/haskellwiki/Programming_guidelines#Naming_Conventions

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

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

237− - mkVtyEscDelay has been removed. Use "mkVty def". Which initialized

238− vty with the default configuration.

239− - input handling changes

240− - KASCII is now KChar

241− - KPN5 is now KCenter

242− - tests exist.

243− - Applications can add to the input tables by setting inputMap of

244− the Config. See Graphics.Vty.Config

245− - Users can define input table extensions that will apply to all vty

246− applications. See Graphics.Vty.Config

247− - terminal timing is now handled by selecting an appropriate VTIME.

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

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

250− implies a requirement on -threaded.

251− - The time vty will wait to verify an ESC byte means a single ESC

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

253− - removed the typeclass based terminal and display context interface

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

255− - renamed the Terminal interface to Output

256− - The default picture for an image now uses the "clear" background.

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

258− line.

259− - Previously the background defaulted to the space character. This

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

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

262− - Layer support

263− - Each layer is an image.

264− - The layers for a picture are a list of images.

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

266− top to bottom.

267− - The transparent areas for a layer are the backgroundFill areas.

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

269− sizes are joined.

270− - If the background is clear there is no background layer.

271− - If there is a background character then the bottom layer is the

272− background layer.

273− - emptyPicture is a Picture with no layers and no cursor

274− - addToTop and addToBottom add a layer to the top and bottom of the

275− given Picture.

276− - compatibility improvements:

277− - terminfo based terminals with no cursor support are silently

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

279− no effect.

280− - alternate (setf/setb) color maps supported. Though colors beyond

281− the first 8 are just a guess.

282− - added "rgbColor" for easy support of RGB specified colors.

283− - Both applications and users can add to the mapping used to

284− translate from input bytes to events.

285− - Additional information about input and output process can be

286− appended to a debug log

287− - Set environment variable VTY_DEBUG_LOG to path of debug log

288− - Or use "debugLog <path>" config directive

289− - Or set 'debugLog' property of the Config provided to mkVty.

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

291− file.

292− - vty-interactive-terminal-test

293− - interactive test. Useful for building a bug report for vty's

294− author.

295− - test/interactive_terminal_test.hs

296− - vty-event-echo

297− - view a input event log for vty. Example of interacting with

298− user.

299− - test/EventEcho.hs

300− - vty-rogue

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

302− build operations.

303− - test/Rogue.hs

304− - vty-benchmark

305− - benchmarks vty. A series of tests that push random pictures to

306− the terminal. The random pictures are generated using

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

308− - test/benchmark.hs

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

309756

3107574.7.0.0

311− - API changes:

312− - Added Graphics.Vty.Image.crop: Ensure an image is no larger

313− than the specified size.

314− - Added Graphics.Vty.Image.pad: Ensure an image is no smaller

315− than the specified size.

316− - Added Graphics.Vty.Image.translate: Offset an image.

317− - Thanks Ben Boeckel <MathStuf@gmail.com> for these features.

758+-------

318759

319−4.3.0.0

760+API changes:

761+* Added Graphics.Vty.Image.crop: Ensure an image is no larger

762+ than the specified size.

763+* Added Graphics.Vty.Image.pad: Ensure an image is no smaller

764+ than the specified size.

765+* Added Graphics.Vty.Image.translate: Offset an image.

766+* Thanks Ben Boeckel <MathStuf@gmail.com> for these features.

320767

3217684.2.1.0

322− - API changes:

323− - Attr record accessor fore_color changed to attr_fore_color

324− - Attr record accessor back_color changed to attr_back_color

325− - Attr record accessor style changed to attr_style

326− - Added an "inline" display attribute changing DSL:

327− - put_attr_change applies a display attribute change

328− immediately to a terminal

329− - For instance, can be used to change the display attrbiutes

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

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

332− color to red.

333− - Changes do not apply to a Picture output via output_picture.

334− - See Graphics.Vty.Inline

335− - Moved all IO actions into any monad an instance of MonadIO

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

336785

3377864.0.0.1

338− - binding for mk_wcswidth was incorrect. Most platforms just

339− magically worked due to coincidence.

787+-------

788+

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

790+ magically worked due to coincidence.

340791

3417924.0.0

342− - API changes:

343− - "getSize" has been removed. Use "terminal vty >>= display_bounds"

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

345− - added a "terminal" field to the Vty data structure. Accesses the

346− TerminalHandle associated with the Vty instance.

347− - Graphics.Vty.Types has undergone a number of changes. Summary:

348− - Partitioned into Graphics.Vty.Attributes for display attributes.

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

350− for final picture construction.

351− - Graphics.Vty.Attributes:

352− - "setFG" and "setBG" are now "with_fore_color" and

353− "with_back_color"

354− - All other "set.." equations similarly replaced.

355− - "attr" is now "def_attr", short for "default display attributes"

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

357− attributes"

358− - Graphics.Vty.Image:

359− - "horzcat" is now "horiz_cat"

360− - "vertcat" is now "vert_cat"

361− - "renderBS" is now "utf8_bytestring"

362− - "renderChar" is now "char"

363− - "renderFill" is now "char_fill"

364− - added a "utf8_string" and "string" (AKA "iso_10464_string") for

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

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

367− - Graphics.Vty.Picture:

368− - exports Graphics.Vty.Image

369− - "pic" is now "pic_for_image"

370− - added API for setting background fill pattern.

371− - Completely rewritten output backend.

372− - Efficient, scanline style output span generator. Has not been

373− fully optimized, but good enough.

374− - The details required to display the desired picture on a

375− terminal are well encapsulated.

376− - Terminfo based display terminal implementation. With specialized

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

378− - Attempts to robustly handle even terminals that don't

379− support all display attributes.

380− - I've tested the following terminals with success: iTerm.app,

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

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

383− successfull.

384− - Improved unicode support. Double wide characters will display as

385− expected.

386− - 256 color support. See Graphics.Vty.Attributes.Color240. The actual

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

388− terminal supports.

389− - The Graphics.Vty.Image combinators no longer require matching

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

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

392− - output images are always cropped to display size.

393− - Significant code coverage by QuickCheck tests. An interactive test

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

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.

395848

396849Issues resolved:

397− - "gnome terminal displays non-basic attributes as strikethrough"

398− - http://trac.haskell.org/vty/ticket/14

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

400− - http://trac.haskell.org/vty/ticket/10

401− - "Redraw does not handle rendering a line that extends beyond screen

402− width characters"

403− - http://trac.haskell.org/vty/ticket/13

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

405− dimensions"

406− - http://trac.haskell.org/vty/ticket/9

407− - "256-color support"

408− - http://trac.haskell.org/vty/ticket/19

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

LICENSE+2

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

1+BSD 3-Clause License

2+

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

24

35All rights reserved.

README.md+137−58

@@ -1,12 +1,13 @@

11[![Build Status](https://travis-ci.org/jtdaugherty/vty.png)](https://travis-ci.org/jtdaugherty/vty)

22

33`vty` is a terminal interface library. It provides a high-level

4−interface for doing terminal I/O.

4+interface for doing terminal I/O. Vty is supported on GHC versions

5+7.10.1 and up.

56

67Install via `git` with:

78

89```

9−git clone git://github.com/coreyoconnor/vty.git

10+git clone git://github.com/jtdaugherty/vty.git

1011```

1112

1213Install via `cabal` with:

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

1718

1819# Features

1920

20−* Supports a large number of terminals. vt100, ansi, hurd, linux,

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

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

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

2223

23−* Automatic handling of window resizes.

24+* Automatically handles window resizes.

2425

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

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

2627

27−* Handles multi-column glyphs. (Requires user to properly configure

28− terminal.)

29−

30−* Efficient output. Output buffering and terminal state changes are

31− minimized.

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

29+ state changes are minimized.

3230

3331* Minimizes repaint area, which virtually eliminates the flicker

3432 problems that plague ncurses programs.

3533

36−* A pure, compositional interface for efficiently constructing display

37− images.

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

35+ display images.

3836

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

4038

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

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

4442 customizable.

4543

46−* The interface is designed for easy extension.

44+* Provides extensible input and output interfaces.

4745

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

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

@@ -53,70 +51,151 @@ cabal install vty

5351

5452* Provides a comprehensive test suite.

5553

56−# Known Issues

57−

58−* Terminals have numerous quirks and bugs. Vty picks what works best for

59− the author in ambiguous or buggy situations.

60−

61−* Signal handling of STOP, TERM and INT are nonexistent.

62−

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

64− unicode is used.

65−

66−* Terminfo is assumed to be correct unless there is an override

67− configured. Some terminals will not have correct special key support

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

69− particular terminal.

70−

71−* Uses the `TIOCGWINSZ` ioctl to find the current window size, which

72− appears to be limited to Linux and BSD.

73−

7454* Supports "normal" and "extended" (SGR) mouse modes as described at

7555 http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Mouse-Tracking

7656

7757* Supports bracketed paste mode as described at

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

7959

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+

66+# Development Notes

67+

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

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

70+

8071# Platform Support

8172

8273## Posix Terminals

8374

84−Uses terminfo to determine terminal protocol. With some special rules to

85−handle some omissions from terminfo.

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

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

8677

8778## Windows

8879

89−Unsupported (but contributions and testing here are very welcome!)

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

90124

91−# Development Notes

125+```

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

127+```

92128

93−## Under NixOS

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.

160+

161+# Contributing

162+

163+If you decide to contribute, that's great! Here are some guidelines you

164+should consider to make submitting patches easier for all concerned:

165+

166+ - If you want to take on big things, talk to me first; let's have a

167+ design/vision discussion before you start coding. Create a GitHub

168+ issue and we can use that as the place to hash things out.

169+ - If you make changes, make them consistent with the syntactic

170+ conventions already used in the codebase.

171+ - Please provide Haddock documentation for any changes you make.

94172

95−### Using cabal

173+# Known Issues

96174

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

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.

98178

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−~~~

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

104180

105−## Code Coverage

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

182+ unicode is used.

106183

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

108−To evaluate coverage, configure as follows:

184+* Terminfo is assumed to be correct unless there is an override

185+ configured. Some terminals will not have correct special key support

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

187+ particular terminal.

188+

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

190+ appears to be limited to Linux and BSD.

109191

110−~~~

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

112− --disable-library-profiling \

113− --disable-executable-profiling

114−~~~

192+# Further Reading

115193

116−## Profiling

194+Good sources of documentation for terminal programming are:

117195

118−~~~

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

120− --enable-library-profiling \

121− --enable-executable-profiling

122−~~~

196+* https://github.com/b4winckler/vim/blob/master/src/term.c

197+* http://invisible-island.net/xterm/ctlseqs/ctlseqs.html

198+* http://ulisse.elettra.trieste.it/services/doc/serial/config.html

199+* http://www.leonerd.org.uk/hacks/hints/xterm-8bit.html

200+* http://www.unixwiz.net/techtips/termios-vmin-vtime.html

201+* http://vt100.net/docs/vt100-ug/chapter3.html

cbits/get_tty_erase.cnew file+18

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

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+14−5

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

11#include <sys/ioctl.h>

22

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;

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+ }

918}

cbits/gwinsz.h+2−1

@@ -1 +1,2 @@

1−unsigned long vty_c_get_window_size(void);

1+unsigned long vty_c_get_window_size(int fd);

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

cbits/mk_wcwidth.c+136−2

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

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;

6385

6486struct interval {

6587 int first;

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

119141 * in ISO 10646.

120142 */

121143

122−HsInt vty_mk_wcwidth(HsChar ucs)

144+static HsInt builtin_wcwidth(HsChar ucs)

123145{

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

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

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

182204

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

184206 if (vty_bisearch(ucs, combining,

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

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

186208 return 0;

187209

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

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

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

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

204226}

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+14−8

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

11{-# LANGUAGE FlexibleContexts #-}

2−

32module Main where

43

54import Graphics.Vty

@@ -8,7 +7,6 @@ import Control.Applicative hiding ((<|>))

87import Control.Arrow

98import Control.Monad.RWS

109

11−import Data.Default (def)

1210import Data.Sequence (Seq, (<|) )

1311import qualified Data.Sequence as Seq

1412import Data.Foldable

@@ -19,8 +17,8 @@ type App = RWST Vty () (Seq String) IO

1917

2018main = do

2119 vty <- if True -- change to false for emacs-like input processing

22− then mkVty def

23− else mkVty (def { vmin = Just 2, vtime = Just 300 } )

20+ then mkVty defaultConfig

21+ else mkVty (defaultConfig { vmin = Just 2, vtime = Just 300 } )

2422 _ <- execRWST (vtyInteract False) vty Seq.empty

2523 shutdown vty

2624

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

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

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

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

36− , "Followed by a description of the 16 color pallete."

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

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

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

3837 , "claims 240 colors are not supported."

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

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

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

4544 ]

4645

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+

4755colorbox_240 :: Image

4856colorbox_240 = vertCat $ map horizCat $ splitColorImages colorImages

4957 where

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

51− splitColorImages [] = []

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

5359

5460colorbox_16 :: Image

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

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

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

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

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

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

7682 vty <- ask

7783 liftIO $ update vty pic

7884

demos/ModeDemo.hs+2

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

22

33import Control.Applicative

44import Data.Monoid

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

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

57

68import Graphics.Vty

79

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

@@ -1,7 +1,6 @@

11{-# OPTIONS_HADDOCK hide #-}

3−module Codec.Binary.UTF8.Debug

4− where

3+module Codec.Binary.UTF8.Debug where

54

65import Codec.Binary.UTF8.String ( encode )

76

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

1514utf8FromIso = encode . map toEnum

1615

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

18−ppUtf8 = print . map (\f -> f "") . map showHex . utf8FromIso

19−

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

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

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

77import Control.Parallel.Strategies

88

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

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

10+ rnf = rnf' . viewl

1111 where

1212 rnf' EmptyL = ()

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

src/Data/Terminfo/Eval.hs+9−18

@@ -1,19 +1,14 @@

1−{-# LANGUAGE CPP #-}

21{-# LANGUAGE BangPatterns #-}

32{-# LANGUAGE NoMonomorphismRestriction #-}

43{-# OPTIONS_GHC -funbox-strict-fields #-}

54{-# OPTIONS_HADDOCK hide #-}

65

7−#ifndef MIN_VERSION_base

8−#defined MIN_VERSION_base(x,y,z) 1

9−#endif

10−

11−{- Evaluates the paramaterized terminfo string capability with the given

12− - parameters.

13− -

14− -}

15−module Data.Terminfo.Eval (writeCapExpr)

16− where

6+-- | Evaluates the paramaterized terminfo string capability with the

7+-- given parameters.

8+module Data.Terminfo.Eval

9+ ( writeCapExpr

10+ )

11+where

1712

1813import Blaze.ByteString.Builder.Word

1914import Blaze.ByteString.Builder

@@ -28,10 +23,6 @@ import Data.List

2823

2924import qualified Data.Vector.Unboxed as Vector

3025

31−#if !(MIN_VERSION_base(4,8,0))

32−import Data.Word

33−#endif

34−

3526-- | capability evaluator state

3627data EvalState = EvalState

3728 { evalStack :: ![CapParam]

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

5142

5243readParam :: Word -> Eval CapParam

5344readParam pn = do

54− !params <- get >>= return . evalParams

45+ !params <- evalParams <$> get

5546 return $! genericIndex params pn

5647

5748push :: CapParam -> Eval ()

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

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

7465

7566writeCapOps :: CapOps -> Eval ()

76−writeCapOps ops = mapM_ writeCapOp ops

67+writeCapOps = mapM_ writeCapOp

7768

7869writeCapOp :: CapOp -> Eval ()

7970writeCapOp (Bytes !offset !count) = do

80− !cap <- get >>= return . evalExpression

71+ !cap <- evalExpression <$> get

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

8273 Vector.forM_ bytes $ tell.writeWord8

8374writeCapOp DecOut = do

src/Data/Terminfo/Parse.hs+27−28

@@ -1,22 +1,22 @@

1−{-# LANGUAGE CPP #-}

21{-# LANGUAGE BangPatterns #-}

3−{-# OPTIONS_HADDOCK hide #-}

2+{-# LANGUAGE CPP #-}

43{-# LANGUAGE NoMonomorphismRestriction #-}

5−{-# LANGUAGE NamedFieldPuns #-}

4+{-# LANGUAGE ScopedTypeVariables #-}

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

6+{-# OPTIONS_HADDOCK hide #-}

77

8−#ifndef MIN_VERSION_base

9−#defined MIN_VERSION_base(x,y,z) 1

10−#endif

11−

12−module Data.Terminfo.Parse ( module Data.Terminfo.Parse

13− , Text.Parsec.ParseError

14− )

15− where

8+module Data.Terminfo.Parse

9+ ( module Data.Terminfo.Parse

10+ , Text.Parsec.ParseError

11+ )

12+where

1613

1714import Control.Monad ( liftM )

1815import Control.DeepSeq

1916

17+#if !(MIN_VERSION_base(4,11,0))

18+import Data.Semigroup (Semigroup(..))

19+#endif

2020import Data.Word

2121import qualified Data.Vector.Unboxed as Vector

2222

@@ -24,10 +24,6 @@ import Numeric (showHex)

2424

2525import Text.Parsec

2626

27−#if !(MIN_VERSION_base(4,8,0))

28−import Data.Monoid

29−#endif

30−

3127data CapExpression = CapExpression

3228 { capOps :: !CapOps

3329 , capBytes :: !(Vector.Vector Word8)

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

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

4440 where

4541 hexDump :: [Word8] -> String

46− hexDump = foldr (\b s -> showHex b s) ""

42+ hexDump = foldr showHex ""

4743

4844instance NFData CapExpression where

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

@@ -103,14 +99,12 @@ parseCapExpression capString =

10399 Left e -> Left e

104100 Right buildResults -> Right $ constructCapExpression capString buildResults

105101

106−constructCapExpression :: [Char] -> BuildResults -> CapExpression

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

107103constructCapExpression capString buildResults =

108104 let expr = CapExpression

109105 { capOps = outCapOps buildResults

110106 -- The cap bytes are the lower 8 bits of the input

111107 -- string's characters.

112− -- \todo Verify the input string actually contains an

113− -- 8bit byte per character.

114108 , capBytes = Vector.fromList $ map (toEnum.fromEnum) capString

115109 , sourceString = capString

116110 , paramCount = outParamCount buildResults

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

134128literalPercentParser :: CapParser BuildResults

135129literalPercentParser = do

136130 _ <- char '%'

137− startOffset <- getState >>= return . nextOffset

131+ startOffset <- nextOffset <$> getState

138132 incOffset 1

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

140134

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

160154pushOpParser :: CapParser BuildResults

161155pushOpParser = do

162156 _ <- char 'p'

163− paramN <- digit >>= return . (\d -> read [d])

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

164158 incOffset 2

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

166160

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

305299bytesOpParser :: CapParser BuildResults

306300bytesOpParser = do

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

308− startOffset <- getState >>= return . nextOffset

302+ startOffset <- nextOffset <$> getState

309303 let !c = length bytes

310304 !s <- getState

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

@@ -339,11 +333,16 @@ data BuildResults = BuildResults

339333 , outParamOps :: !ParamOps

340334 }

341335

342−instance Monoid BuildResults where

343− mempty = BuildResults 0 [] []

344− v0 `mappend` v1

336+instance Semigroup BuildResults where

337+ v0 <> v1

345338 = BuildResults

346− { outParamCount = (outParamCount v0) `max` (outParamCount v1)

347− , outCapOps = (outCapOps v0) `mappend` (outCapOps v1)

348− , outParamOps = (outParamOps v0) `mappend` (outParamOps v1)

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

340+ , outCapOps = outCapOps v0 <> outCapOps v1

341+ , outParamOps = outParamOps v0 <> outParamOps v1

349342 }

343+

344+instance Monoid BuildResults where

345+ mempty = BuildResults 0 [] []

346+#if !(MIN_VERSION_base(4,11,0))

347+ mappend = (<>)

348+#endif

src/Graphics/Text/Width.hs+49−17

@@ -1,32 +1,64 @@

22{-# OPTIONS_GHC -D_XOPEN_SOURCE #-}

33{-# LANGUAGE ForeignFunctionInterface #-}

4−module Graphics.Text.Width ( wcwidth

5− , wcswidth

6− , safeWcwidth

7− , safeWcswidth

8− )

9− where

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

13+module Graphics.Text.Width

14+ ( wcwidth

15+ , wcswidth

16+ , wctwidth

17+ , wctlwidth

18+ , safeWcwidth

19+ , safeWcswidth

20+ , safeWctwidth

21+ , safeWctlwidth

22+ )

23+where

24+

25+import Data.List (foldl')

26+import qualified Data.Text as T

27+import qualified Data.Text.Lazy as TL

1028

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

1230

1331wcswidth :: String -> Int

14−wcswidth = sum . map wcwidth

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

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

1534

16−-- XXX: Characters with unknown widths occupy 1 column?

17−--

18−-- Not sure if this is actually correct. I presume there is a

19−-- replacement character that is output by the terminal instead of the

20−-- character and this replacement character is 1 column wide. If this is

21−-- not true for all terminals then a per-terminal replacement character

22−-- width needs to be implemented.

35+wctwidth :: T.Text -> Int

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

37+

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+ #-}

2345

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

25−-- with unknown widths are 0 width

47+-- with unknown widths are 0 width.

2648safeWcwidth :: Char -> Int

2749safeWcwidth = max 0 . wcwidth

2850

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

30−-- unknown widths are 0 width

52+-- unknown widths are 0 width.

3153safeWcswidth :: String -> Int

32−safeWcswidth = sum . map safeWcwidth

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

src/Graphics/Vty.hs+179−106

@@ -1,21 +1,20 @@

1−-- | Vty supports input and output to terminal devices.

2−--

3−-- - Input to the terminal is provided to the app as a sequence of

4−-- 'Event's.

5−--

6−-- - The output is defined by a 'Picture'. Which is one or more layers

7−-- of 'Image's.

8−--

9−-- - The module "Graphics.Vty.Image" provides a number of

10−-- constructor equations that will build correct 'Image' values.

11−-- See 'string', '<|>', and '<->' for starters.

1+{-# LANGUAGE CPP #-}

2+{-# LANGUAGE ScopedTypeVariables #-}

3+

4+-- | Vty provides interfaces for both terminal input and terminal

5+-- output.

126--

13−-- - The constructors in "Graphics.Vty.Image.Internal" should not

14−-- be used.

7+-- - Input to the terminal is provided to the Vty application as a

8+-- sequence of 'Event's.

159--

16−-- - 'Image's can be styled using 'Attr'. See "Graphics.Vty.Attributes".

10+-- - Output is provided to Vty by the application in the form of a

11+-- 'Picture'. A 'Picture' is one or more layers of 'Image's.

12+-- 'Image' values can be built by the various constructors in

13+-- "Graphics.Vty.Image". Output can be syled using 'Attr' (attribute)

14+-- values in the "Graphics.Vty.Attributes" module.

1715--

18−-- See the vty-examples package for a number of examples.

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

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

1918--

2019-- @

2120-- import "Graphics.Vty"

@@ -23,10 +22,8 @@

2322-- main = do

2423-- cfg <- 'standardIOConfig'

2524-- vty <- 'mkVty' cfg

26−-- let line0 = 'string' ('defAttr' ` 'withForeColor' ` 'green')

27−-- \"first line\"

28−-- line1 = 'string' ('defAttr' ` 'withBackColor' ` 'blue')

29−-- \"second line\"

25+-- let line0 = 'string' ('defAttr' ` 'withForeColor' ` 'green') \"first line\"

26+-- line1 = 'string' ('defAttr' ` 'withBackColor' ` 'blue') \"second line\"

3027-- img = line0 '<->' line1

3128-- pic = 'picForImage' img

3229-- 'update' vty pic

@@ -34,108 +31,153 @@

3431-- 'shutdown' vty

3532-- 'print' (\"Last event was: \" '++' 'show' e)

3633-- @

37−--

38−-- Good sources of documentation for terminal programming are:

39−--

40−-- - <https://github.com/b4winckler/vim/blob/master/src/term.c>

41−--

42−-- - <http://invisible-island.net/xterm/ctlseqs/ctlseqs.html>

43−--

44−-- - <http://ulisse.elettra.trieste.it/services/doc/serial/config.html>

45−--

46−-- - <http://www.leonerd.org.uk/hacks/hints/xterm-8bit.html>

47−--

48−-- - <http://www.unixwiz.net/techtips/termios-vmin-vtime.html>

49−--

50−-- - <http://vt100.net/docs/vt100-ug/chapter3.html vt100 control sequences>

51−module Graphics.Vty ( Vty(..)

52− , mkVty

53− , module Graphics.Vty.Config

54− , module Graphics.Vty.Input

55− , module Graphics.Vty.Output

56− , module Graphics.Vty.Picture

57− , DisplayRegion

58− , Mode(..)

59− )

60− where

61−

62−import Graphics.Vty.Prelude

34+module Graphics.Vty

35+ ( Vty(..)

36+ , mkVty

37+ , setWindowTitle

38+ , Mode(..)

39+ , module Graphics.Vty.Config

40+ , module Graphics.Vty.Input

41+ , module Graphics.Vty.Output

42+ , module Graphics.Vty.Output.Interface

43+ , module Graphics.Vty.Picture

44+ , module Graphics.Vty.Image

45+ , module Graphics.Vty.Attributes

46+ )

47+where

6348

6449import Graphics.Vty.Config

6550import Graphics.Vty.Input

51+import Graphics.Vty.Input.Events

6652import Graphics.Vty.Output

6753import Graphics.Vty.Output.Interface

6854import Graphics.Vty.Picture

55+import Graphics.Vty.Image

56+import Graphics.Vty.Attributes

57+import Graphics.Vty.UnicodeWidthTable.IO

58+import Graphics.Vty.UnicodeWidthTable.Install

59+

60+import Data.Char (isPrint, showLitChar)

61+import qualified Data.ByteString.Char8 as BS8

6962

63+import qualified Control.Exception as E

64+import Control.Monad (when)

7065import Control.Concurrent.STM

7166

7267import Data.IORef

73−import Data.Monoid

68+#if !(MIN_VERSION_base(4,11,0))

69+import Data.Semigroup ((<>))

70+#endif

7471

75−-- | The main object. At most one should be created.

72+-- | A Vty value represents a handle to the Vty library that the

73+-- application must create in order to use Vty.

7674--

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

7876--

79−-- 0. initialize vty

80−--

81−-- 1. use the update equation of Vty to display a picture

82−--

83−-- 2. repeat

84−--

85−-- 3. shutdown vty.

86−--

87−-- An alternative to tracking the Vty instance is to use 'withVty' in

88−-- "Graphics.Vty.Inline.Unsafe".

89−--

90−-- This does not assure any thread safety. In theory, as long as an

91−-- update action is not executed when another update action is already

92−-- then it's safe to call this on multiple threads.

93−--

94−-- \todo Remove explicit `shutdown` requirement.

95−data Vty = Vty

96− { -- | Outputs the given Picture. Equivalent to 'outputPicture'

97− -- applied to a display context implicitly managed by Vty. The

98− -- managed display context is reset on resize.

99− update :: Picture -> IO ()

100− -- | Get one Event object, blocking if necessary. This will

101− -- refresh the terminal if the event is a 'EvResize'.

102− , nextEvent :: IO Event

103− -- | The input interface. See 'Input'

104− , inputIface :: Input

105− -- | The output interface. See 'Output'

106− , outputIface :: Output

107− -- | Refresh the display. 'nextEvent' will refresh the display if

108− -- a resize occurs. If other programs output to the terminal and

109− -- mess up the display then the application might want to force a

110− -- refresh.

111− , refresh :: IO ()

112− -- | Clean up after vty.

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

114− -- this is executed.

115− , shutdown :: IO ()

116− }

117−

118−-- | Set up the state object for using vty. At most one state object

119−-- should be created at a time for a given terminal device.

120−--

121−-- The specified config is added to the 'userConfig'. With the

122−-- 'userConfig' taking precedence. See "Graphics.Vty.Config"

123−--

124−-- For most applications @mkVty def@ is sufficient.

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

78+--

79+-- 2. Use 'update' to display a picture.

80+--

81+-- 3. Use 'nextEvent' to get the next input event.

82+--

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

84+--

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

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

87+--

88+-- 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+ }

112+

113+-- | Create a Vty handle. At most one handle should be created at a time

114+-- for a given terminal device.

115+--

116+-- The specified configuration is added to the the configuration

117+-- loaded by 'userConfig' with the 'userConfig' configuration taking

118+-- precedence. See "Graphics.Vty.Config".

119+--

120+-- For most applications @mkVty defaultConfig@ is sufficient.

125121mkVty :: Config -> IO Vty

126122mkVty appConfig = do

127123 config <- (<> appConfig) <$> userConfig

128− input <- inputForConfig config

129− out <- outputForConfig config

130− intMkVty input out

131124

132−intMkVty :: Input -> Output -> IO Vty

133−intMkVty input out = do

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

134169 reserveDisplay out

170+

171+ shutdownVar <- newTVarIO False

135172 let shutdownIo = do

136− shutdownInput input

137− releaseDisplay out

138− releaseTerminal out

173+ alreadyShutdown <- atomically $ swapTVar shutdownVar True

174+ when (not alreadyShutdown) $ do

175+ shutdownInput input

176+ releaseDisplay out

177+ releaseTerminal out

178+

179+ let shutdownStatus = readTVarIO shutdownVar

180+

139181 lastPicRef <- newIORef Nothing

140182 lastUpdateRef <- newIORef Nothing

141183

@@ -167,16 +209,47 @@ intMkVty input out = do

167209 mPic <- readIORef lastPicRef

168210 maybe (return ()) innerUpdate mPic

169211

170− let gkey = do k <- atomically $ readTChan $ _eventChannel input

171− case k of

172− (EvResize _ _) -> displayBounds out

173− >>= return . (\(w,h)-> EvResize w h)

174− _ -> return k

212+ let mkResize = uncurry EvResize <$> displayBounds out

213+

214+ translateInternalEvent ResumeAfterSignal = mkResize

215+ translateInternalEvent (InputEvent e) = return e

216+

217+ gkey = do

218+ e <- atomically $ readTChan $ _eventChannel input

219+ translateInternalEvent e

220+ gkey' = do

221+ mEv <- atomically $ tryReadTChan $ _eventChannel input

222+ case mEv of

223+ Just e -> Just <$> translateInternalEvent e

224+ Nothing -> return Nothing

175225

176226 return $ Vty { update = innerUpdate

177227 , nextEvent = gkey

228+ , nextEventNonblocking = gkey'

178229 , inputIface = input

179230 , outputIface = out

180231 , refresh = innerRefresh

181232 , shutdown = shutdownIo

233+ , isShutdown = shutdownStatus

182234 }

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+88−95

@@ -1,56 +1,71 @@

11{-# LANGUAGE CPP #-}

2−{-# LANGUAGE StandaloneDeriving #-}

3−{-# LANGUAGE GADTs #-}

4−{-# LANGUAGE RankNTypes #-}

5−

6−#ifndef MIN_VERSION_base

7−#defined MIN_VERSION_base(x,y,z) 1

8−#endif

2+{-# LANGUAGE DeriveGeneric #-}

3+{-# LANGUAGE DeriveAnyClass #-}

94

105-- | Display attributes

116--

12−-- Typically the values 'defAttr' or 'currentAttr' are modified to form

13−-- attributes:

7+-- Attributes have three components: a foreground color, a background

8+-- color, and a style mask. The simplest attribute is the default

9+-- attribute, or 'defAttr'. Attributes can be modified with

10+-- 'withForeColor', 'withBackColor', and 'withStyle', e.g.,

1411--

1512-- @

16−-- defAttr `withForeColor` red

13+-- defAttr \`withForeColor\` red

1714-- @

1815--

19−-- Is the attribute that will set the foreground color to red and the

20−-- background color to the default.

21−--

22−-- This can then be used to build an image with a red foreground like

23−-- so:

16+-- 'Image' constructors often require an 'Attr' to indicate the

17+-- attributes used in the image, e.g.,

2418--

2519-- @

26−-- string (defAttr `withForeColor` red) "this text will be red"

20+-- string (defAttr \`withForeColor\` red) "this text will be red"

2721-- @

2822--

29−-- The default attributes set by 'defAttr' have a presentation

30−-- determined by the terminal. This is not something VTY can control.

31−-- The user is free to define the color scheme of the terminal as they

32−-- see fit. Up to the limits of the terminal anyways.

23+-- The appearance of 'Image's using 'defAttr' is determined by the The

24+-- terminal, so this is not something VTY can control. The user is free

25+-- to The define the color scheme of the terminal as they see fit.

3326--

3427-- The value 'currentAttr' will keep the attributes of whatever was

3528-- output previously.

36−--

37−-- \todo This API is very verbose IMO. I'd like something more succinct.

38−module Graphics.Vty.Attributes ( module Graphics.Vty.Attributes

39− , module Graphics.Vty.Attributes.Color

40− , module Graphics.Vty.Attributes.Color240

41− )

42− where

43−

29+module Graphics.Vty.Attributes

30+ ( module Graphics.Vty.Attributes.Color

31+

32+ , Attr(..)

33+ , FixedAttr(..)

34+ , MaybeDefault(..)

35+ , defAttr

36+ , currentAttr

37+

38+ -- * Styles

39+ , Style

40+ , withStyle

41+ , standout

42+ , italic

43+ , strikethrough

44+ , underline

45+ , reverseVideo

46+ , blink

47+ , dim

48+ , bold

49+ , defaultStyleMask

50+ , styleMask

51+ , hasStyle

52+

53+ -- * Setting attribute colors

54+ , withForeColor

55+ , withBackColor

56+

57+ -- * Setting hyperlinks

58+ , withURL

59+ )

60+where

61+

62+import Control.DeepSeq

4463import Data.Bits

45−import Data.Default

64+import Data.Text (Text)

4665import Data.Word

66+import GHC.Generics

4767

4868import Graphics.Vty.Attributes.Color

49−import Graphics.Vty.Attributes.Color240

50−

51−#if !(MIN_VERSION_base(4,8,0))

52−import Data.Monoid

53−#endif

5469

5570-- | A display attribute defines the Color and Style of all the

5671-- characters rendered after the attribute is applied.

@@ -63,7 +78,8 @@ data Attr = Attr

6378 { attrStyle :: !(MaybeDefault Style)

6479 , attrForeColor :: !(MaybeDefault Color)

6580 , attrBackColor :: !(MaybeDefault Color)

66− } deriving ( Eq, Show, Read )

81+ , attrURL :: !(MaybeDefault Text)

82+ } deriving ( Eq, Show, Read, Generic, NFData )

6783

6884-- This could be encoded into a single 32 bit word. The 32 bit word is

6985-- first divided into 4 groups of 8 bits where: The first group codes

@@ -84,25 +100,19 @@ data Attr = Attr

84100-- __ - unused

85101--

86102-- Next is the style flags

87−-- SURBDO__

103+-- SURBDOI_

88104-- S - standout

89105-- U - underline

90106-- R - reverse video

91107-- B - blink

92108-- D - dim

93109-- O - bold

94−-- __ - unused

110+-- I - italic

111+-- _ - unused

95112--

96113-- Then the foreground color encoded into 8 bits.

97114-- Then the background color encoded into 8 bits.

98115

99−instance Monoid Attr where

100− mempty = Attr mempty mempty mempty

101− mappend attr0 attr1 =

102− Attr ( attrStyle attr0 `mappend` attrStyle attr1 )

103− ( attrForeColor attr0 `mappend` attrForeColor attr1 )

104− ( attrBackColor attr0 `mappend` attrBackColor attr1 )

105−

106116-- | Specifies the display attributes such that the final style and

107117-- color values do not depend on the previously applied display

108118-- attribute. The display attributes can still depend on the terminal's

@@ -111,61 +121,26 @@ data FixedAttr = FixedAttr

111121 { fixedStyle :: !Style

112122 , fixedForeColor :: !(Maybe Color)

113123 , fixedBackColor :: !(Maybe Color)

124+ , fixedURL :: !(Maybe Text)

114125 } deriving ( Eq, Show )

115126

116127-- | The style and color attributes can either be the terminal defaults.

117128-- Or be equivalent to the previously applied style. Or be a specific

118129-- value.

119−data MaybeDefault v where

120− Default :: MaybeDefault v

121− KeepCurrent :: MaybeDefault v

122− SetTo :: forall v . ( Eq v, Show v, Read v ) => !v -> MaybeDefault v

123−

124−deriving instance Eq v => Eq (MaybeDefault v)

125−deriving instance Eq v => Show (MaybeDefault v)

126−deriving instance (Eq v, Show v, Read v) => Read (MaybeDefault v)

127−

128−instance Eq v => Monoid ( MaybeDefault v ) where

129− mempty = KeepCurrent

130− mappend Default Default = Default

131− mappend Default KeepCurrent = Default

132− mappend Default ( SetTo v ) = SetTo v

133− mappend KeepCurrent Default = Default

134− mappend KeepCurrent KeepCurrent = KeepCurrent

135− mappend KeepCurrent ( SetTo v ) = SetTo v

136− mappend ( SetTo _v ) Default = Default

137− mappend ( SetTo v ) KeepCurrent = SetTo v

138− mappend ( SetTo _ ) ( SetTo v ) = SetTo v

139−

140−-- | Standard 8-color ANSI terminal color codes.

141−black, red, green, yellow, blue, magenta, cyan, white :: Color

142−black = ISOColor 0

143−red = ISOColor 1

144−green = ISOColor 2

145−yellow = ISOColor 3

146−blue = ISOColor 4

147−magenta= ISOColor 5

148−cyan = ISOColor 6

149−white = ISOColor 7

150−

151−-- | Bright/Vivid variants of the standard 8-color ANSI

152−brightBlack, brightRed, brightGreen, brightYellow :: Color

153−brightBlue, brightMagenta, brightCyan, brightWhite :: Color

154−brightBlack = ISOColor 8

155−brightRed = ISOColor 9

156−brightGreen = ISOColor 10

157−brightYellow = ISOColor 11

158−brightBlue = ISOColor 12

159−brightMagenta= ISOColor 13

160−brightCyan = ISOColor 14

161−brightWhite = ISOColor 15

130+data MaybeDefault v = Default | KeepCurrent | SetTo !v

131+ deriving (Eq, Read, Show)

132+

133+instance (NFData v) => NFData (MaybeDefault v) where

134+ rnf Default = ()

135+ rnf KeepCurrent = ()

136+ rnf (SetTo v) = rnf v

162137

163138-- | Styles are represented as an 8 bit word. Each bit in the word is 1

164139-- if the style attribute assigned to that bit should be applied and 0

165140-- if the style attribute should not be applied.

166141type Style = Word8

167142

168−-- | The 6 possible style attributes:

143+-- | Valid style attributes include:

169144--

170145-- * standout

171146--

@@ -179,15 +154,21 @@ type Style = Word8

179154--

180155-- * bold/bright

181156--

157+-- * italic

158+--

159+-- * strikethrough (via the smxx/rmxx terminfo capabilities)

160+--

182161-- (The invisible, protect, and altcharset display attributes some

183162-- terminals support are not supported via VTY.)

184−standout, underline, reverseVideo, blink, dim, bold :: Style

163+standout, underline, reverseVideo, blink, dim, bold, italic, strikethrough :: Style

185164standout = 0x01

186165underline = 0x02

187−reverseVideo = 0x04

166+reverseVideo = 0x04

188167blink = 0x08

189168dim = 0x10

190169bold = 0x20

170+italic = 0x40

171+strikethrough = 0x80

191172

192173defaultStyleMask :: Style

193174defaultStyleMask = 0x00

@@ -213,16 +194,28 @@ withBackColor attr c = attr { attrBackColor = SetTo c }

213194

214195-- | Add the given style attribute

215196withStyle :: Attr -> Style -> Attr

197+withStyle attr 0 = attr

216198withStyle attr styleFlag = attr { attrStyle = SetTo $ styleMask attr .|. styleFlag }

217199

200+-- | Add a hyperlinked URL using the proposed [escape sequences for

201+-- hyperlinked

202+-- URLs](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda).

203+-- These escape sequences are comparatively new and aren't widely

204+-- supported in terminal emulators yet, but most terminal emulators

205+-- that don't know about these sequences will ignore these sequences,

206+-- and therefore this should fall back sensibly. In some cases they

207+-- won't and this will result in garbage, so this is why hyperlinking is

208+-- disabled by default, in which case this combinator has no observable

209+-- effect. To enable it, enable 'Hyperlink' mode on your Vty output

210+-- interface.

211+withURL :: Attr -> Text -> Attr

212+withURL attr url = attr { attrURL = SetTo url }

213+

218214-- | Sets the style, background color and foreground color to the

219215-- default values for the terminal. There is no easy way to determine

220216-- what the default background and foreground colors are.

221217defAttr :: Attr

222−defAttr = Attr Default Default Default

223−

224−instance Default Attr where

225− def = defAttr

218+defAttr = Attr Default Default Default Default

226219

227220-- | Keeps the style, background color and foreground color that was

228221-- previously set. Used to override some part of the previous style.

@@ -232,4 +225,4 @@ instance Default Attr where

232225-- Would be the currently applied style (be it underline, bold, etc) but

233226-- with the foreground color set to brightMagenta.

234227currentAttr :: Attr

235−currentAttr = Attr KeepCurrent KeepCurrent KeepCurrent

228+currentAttr = Attr KeepCurrent KeepCurrent KeepCurrent KeepCurrent

src/Graphics/Vty/Attributes/Color.hs+138−4

@@ -1,5 +1,61 @@

1−module Graphics.Vty.Attributes.Color where

1+{-# LANGUAGE DeriveGeneric #-}

2+{-# LANGUAGE DeriveAnyClass #-}

3+{-# LANGUAGE MultiWayIf #-}

4+{-# LANGUAGE ScopedTypeVariables #-}

5+

6+module Graphics.Vty.Attributes.Color

7+ ( 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`

22+ , black

23+ , red

24+ , green

25+ , yellow

26+ , blue

27+ , magenta

28+ , cyan

29+ , white

30+

31+ -- | Bright/Vivid variants of the standard 8-color ANSI

32+ , brightBlack

33+ , brightRed

34+ , brightGreen

35+ , brightYellow

36+ , brightBlue

37+ , brightMagenta

38+ , brightCyan

39+ , brightWhite

40+ -- ** Creating Colors From RGB

41+ , linearColor

42+ , srgbColor

43+ , rgbColor

44+ , color240

45+ , module Graphics.Vty.Attributes.Color240

46+ )

47+where

48+

249import Data.Word

50+import GHC.Generics

51+import 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

359

460-- | Abstract data type representing a color.

561--

@@ -39,7 +95,7 @@ import Data.Word

3995-- reported then the color reproduction will be incorrect.

4096--

4197-- If the terminal reports <= 16 colors then the 240 color palette

42−-- points are only mapped to the 8 color pallete. I'm not sure of

98+-- points are only mapped to the 8 color palette. I'm not sure of

4399-- the RGB points for the "bright" colors which is why they are not

44100-- addressable via the 240 color palette.

45101--

@@ -53,5 +109,83 @@ import Data.Word

53109-- terminfo but I don't know it.

54110--

55111-- Seriously, terminal color support is INSANE.

56−data Color = ISOColor !Word8 | Color240 !Word8

57− deriving ( Eq, Show, Read )

112+data Color = ISOColor !Word8 | Color240 !Word8 | RGBColor !Word8 !Word8 !Word8

113+ deriving ( Eq, Show, Read, Generic, NFData )

114+

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+

139+black, red, green, yellow, blue, magenta, cyan, white :: Color

140+black = ISOColor 0

141+red = ISOColor 1

142+green = ISOColor 2

143+yellow = ISOColor 3

144+blue = ISOColor 4

145+magenta= ISOColor 5

146+cyan = ISOColor 6

147+white = ISOColor 7

148+

149+brightBlack, brightRed, brightGreen, brightYellow :: Color

150+brightBlue, brightMagenta, brightCyan, brightWhite :: Color

151+brightBlack = ISOColor 8

152+brightRed = ISOColor 9

153+brightGreen = ISOColor 10

154+brightYellow = ISOColor 11

155+brightBlue = ISOColor 12

156+brightMagenta= ISOColor 13

157+brightCyan = ISOColor 14

158+brightWhite = 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+291−254

@@ -1,261 +1,298 @@

1−{-

2− - This header file was generated by ./256colres.pl

3− -}

4−module Graphics.Vty.Attributes.Color240 where

5−

6−import Graphics.Vty.Attributes.Color

1+-- This header file was generated by ./256colres.pl

2+module Graphics.Vty.Attributes.Color240

3+ ( rgbColorToColor240

4+ , color240CodeToRGB

5+ )

6+where

77

8+import Data.Word (Word8)

89import Text.Printf

910

10−-- | RGB color to 240 color palette.

11−--

12−-- generated from 256colres.pl which is forked from xterm 256colres.pl

13−-- todo: all values get clamped high.

14−rgbColor :: Integral i => i -> i -> i -> Color

15−rgbColor r g b

11+-- Note: rgbColor's mapping from RGB to 240 colors was generated from

12+-- 256colres.pl which is forked from xterm 256colres.pl.

13+

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

1617 | r < 0 && g < 0 && b < 0 = error "rgbColor with negative color component intensity"

17− | r == 8 && g == 8 && b == 8 = Color240 216

18− | r == 18 && g == 18 && b == 18 = Color240 217

19− | r == 28 && g == 28 && b == 28 = Color240 218

20− | r == 38 && g == 38 && b == 38 = Color240 219

21− | r == 48 && g == 48 && b == 48 = Color240 220

22− | r == 58 && g == 58 && b == 58 = Color240 221

23− | r == 68 && g == 68 && b == 68 = Color240 222

24− | r == 78 && g == 78 && b == 78 = Color240 223

25− | r == 88 && g == 88 && b == 88 = Color240 224

26− | r == 98 && g == 98 && b == 98 = Color240 225

27− | r == 108 && g == 108 && b == 108 = Color240 226

28− | r == 118 && g == 118 && b == 118 = Color240 227

29− | r == 128 && g == 128 && b == 128 = Color240 228

30− | r == 138 && g == 138 && b == 138 = Color240 229

31− | r == 148 && g == 148 && b == 148 = Color240 230

32− | r == 158 && g == 158 && b == 158 = Color240 231

33− | r == 168 && g == 168 && b == 168 = Color240 232

34− | r == 178 && g == 178 && b == 178 = Color240 233

35− | r == 188 && g == 188 && b == 188 = Color240 234

36− | r == 198 && g == 198 && b == 198 = Color240 235

37− | r == 208 && g == 208 && b == 208 = Color240 236

38− | r == 218 && g == 218 && b == 218 = Color240 237

39− | r == 228 && g == 228 && b == 228 = Color240 238

40− | r == 238 && g == 238 && b == 238 = Color240 239

41− | r <= 0 && g <= 0 && b <= 0 = Color240 0

42− | r <= 0 && g <= 0 && b <= 95 = Color240 1

43− | r <= 0 && g <= 0 && b <= 135 = Color240 2

44− | r <= 0 && g <= 0 && b <= 175 = Color240 3

45− | r <= 0 && g <= 0 && b <= 215 = Color240 4

46− | r <= 0 && g <= 0 && b <= 255 = Color240 5

47− | r <= 0 && g <= 95 && b <= 0 = Color240 6

48− | r <= 0 && g <= 95 && b <= 95 = Color240 7

49− | r <= 0 && g <= 95 && b <= 135 = Color240 8

50− | r <= 0 && g <= 95 && b <= 175 = Color240 9

51− | r <= 0 && g <= 95 && b <= 215 = Color240 10

52− | r <= 0 && g <= 95 && b <= 255 = Color240 11

53− | r <= 0 && g <= 135 && b <= 0 = Color240 12

54− | r <= 0 && g <= 135 && b <= 95 = Color240 13

55− | r <= 0 && g <= 135 && b <= 135 = Color240 14

56− | r <= 0 && g <= 135 && b <= 175 = Color240 15

57− | r <= 0 && g <= 135 && b <= 215 = Color240 16

58− | r <= 0 && g <= 135 && b <= 255 = Color240 17

59− | r <= 0 && g <= 175 && b <= 0 = Color240 18

60− | r <= 0 && g <= 175 && b <= 95 = Color240 19

61− | r <= 0 && g <= 175 && b <= 135 = Color240 20

62− | r <= 0 && g <= 175 && b <= 175 = Color240 21

63− | r <= 0 && g <= 175 && b <= 215 = Color240 22

64− | r <= 0 && g <= 175 && b <= 255 = Color240 23

65− | r <= 0 && g <= 215 && b <= 0 = Color240 24

66− | r <= 0 && g <= 215 && b <= 95 = Color240 25

67− | r <= 0 && g <= 215 && b <= 135 = Color240 26

68− | r <= 0 && g <= 215 && b <= 175 = Color240 27

69− | r <= 0 && g <= 215 && b <= 215 = Color240 28

70− | r <= 0 && g <= 215 && b <= 255 = Color240 29

71− | r <= 0 && g <= 255 && b <= 0 = Color240 30

72− | r <= 0 && g <= 255 && b <= 95 = Color240 31

73− | r <= 0 && g <= 255 && b <= 135 = Color240 32

74− | r <= 0 && g <= 255 && b <= 175 = Color240 33

75− | r <= 0 && g <= 255 && b <= 215 = Color240 34

76− | r <= 0 && g <= 255 && b <= 255 = Color240 35

77− | r <= 95 && g <= 0 && b <= 0 = Color240 36

78− | r <= 95 && g <= 0 && b <= 95 = Color240 37

79− | r <= 95 && g <= 0 && b <= 135 = Color240 38

80− | r <= 95 && g <= 0 && b <= 175 = Color240 39

81− | r <= 95 && g <= 0 && b <= 215 = Color240 40

82− | r <= 95 && g <= 0 && b <= 255 = Color240 41

83− | r <= 95 && g <= 95 && b <= 0 = Color240 42

84− | r <= 95 && g <= 95 && b <= 95 = Color240 43

85− | r <= 95 && g <= 95 && b <= 135 = Color240 44

86− | r <= 95 && g <= 95 && b <= 175 = Color240 45

87− | r <= 95 && g <= 95 && b <= 215 = Color240 46

88− | r <= 95 && g <= 95 && b <= 255 = Color240 47

89− | r <= 95 && g <= 135 && b <= 0 = Color240 48

90− | r <= 95 && g <= 135 && b <= 95 = Color240 49

91− | r <= 95 && g <= 135 && b <= 135 = Color240 50

92− | r <= 95 && g <= 135 && b <= 175 = Color240 51

93− | r <= 95 && g <= 135 && b <= 215 = Color240 52

94− | r <= 95 && g <= 135 && b <= 255 = Color240 53

95− | r <= 95 && g <= 175 && b <= 0 = Color240 54

96− | r <= 95 && g <= 175 && b <= 95 = Color240 55

97− | r <= 95 && g <= 175 && b <= 135 = Color240 56

98− | r <= 95 && g <= 175 && b <= 175 = Color240 57

99− | r <= 95 && g <= 175 && b <= 215 = Color240 58

100− | r <= 95 && g <= 175 && b <= 255 = Color240 59

101− | r <= 95 && g <= 215 && b <= 0 = Color240 60

102− | r <= 95 && g <= 215 && b <= 95 = Color240 61

103− | r <= 95 && g <= 215 && b <= 135 = Color240 62

104− | r <= 95 && g <= 215 && b <= 175 = Color240 63

105− | r <= 95 && g <= 215 && b <= 215 = Color240 64

106− | r <= 95 && g <= 215 && b <= 255 = Color240 65

107− | r <= 95 && g <= 255 && b <= 0 = Color240 66

108− | r <= 95 && g <= 255 && b <= 95 = Color240 67

109− | r <= 95 && g <= 255 && b <= 135 = Color240 68

110− | r <= 95 && g <= 255 && b <= 175 = Color240 69

111− | r <= 95 && g <= 255 && b <= 215 = Color240 70

112− | r <= 95 && g <= 255 && b <= 255 = Color240 71

113− | r <= 135 && g <= 0 && b <= 0 = Color240 72

114− | r <= 135 && g <= 0 && b <= 95 = Color240 73

115− | r <= 135 && g <= 0 && b <= 135 = Color240 74

116− | r <= 135 && g <= 0 && b <= 175 = Color240 75

117− | r <= 135 && g <= 0 && b <= 215 = Color240 76

118− | r <= 135 && g <= 0 && b <= 255 = Color240 77

119− | r <= 135 && g <= 95 && b <= 0 = Color240 78

120− | r <= 135 && g <= 95 && b <= 95 = Color240 79

121− | r <= 135 && g <= 95 && b <= 135 = Color240 80

122− | r <= 135 && g <= 95 && b <= 175 = Color240 81

123− | r <= 135 && g <= 95 && b <= 215 = Color240 82

124− | r <= 135 && g <= 95 && b <= 255 = Color240 83

125− | r <= 135 && g <= 135 && b <= 0 = Color240 84

126− | r <= 135 && g <= 135 && b <= 95 = Color240 85

127− | r <= 135 && g <= 135 && b <= 135 = Color240 86

128− | r <= 135 && g <= 135 && b <= 175 = Color240 87

129− | r <= 135 && g <= 135 && b <= 215 = Color240 88

130− | r <= 135 && g <= 135 && b <= 255 = Color240 89

131− | r <= 135 && g <= 175 && b <= 0 = Color240 90

132− | r <= 135 && g <= 175 && b <= 95 = Color240 91

133− | r <= 135 && g <= 175 && b <= 135 = Color240 92

134− | r <= 135 && g <= 175 && b <= 175 = Color240 93

135− | r <= 135 && g <= 175 && b <= 215 = Color240 94

136− | r <= 135 && g <= 175 && b <= 255 = Color240 95

137− | r <= 135 && g <= 215 && b <= 0 = Color240 96

138− | r <= 135 && g <= 215 && b <= 95 = Color240 97

139− | r <= 135 && g <= 215 && b <= 135 = Color240 98

140− | r <= 135 && g <= 215 && b <= 175 = Color240 99

141− | r <= 135 && g <= 215 && b <= 215 = Color240 100

142− | r <= 135 && g <= 215 && b <= 255 = Color240 101

143− | r <= 135 && g <= 255 && b <= 0 = Color240 102

144− | r <= 135 && g <= 255 && b <= 95 = Color240 103

145− | r <= 135 && g <= 255 && b <= 135 = Color240 104

146− | r <= 135 && g <= 255 && b <= 175 = Color240 105

147− | r <= 135 && g <= 255 && b <= 215 = Color240 106

148− | r <= 135 && g <= 255 && b <= 255 = Color240 107

149− | r <= 175 && g <= 0 && b <= 0 = Color240 108

150− | r <= 175 && g <= 0 && b <= 95 = Color240 109

151− | r <= 175 && g <= 0 && b <= 135 = Color240 110

152− | r <= 175 && g <= 0 && b <= 175 = Color240 111

153− | r <= 175 && g <= 0 && b <= 215 = Color240 112

154− | r <= 175 && g <= 0 && b <= 255 = Color240 113

155− | r <= 175 && g <= 95 && b <= 0 = Color240 114

156− | r <= 175 && g <= 95 && b <= 95 = Color240 115

157− | r <= 175 && g <= 95 && b <= 135 = Color240 116

158− | r <= 175 && g <= 95 && b <= 175 = Color240 117

159− | r <= 175 && g <= 95 && b <= 215 = Color240 118

160− | r <= 175 && g <= 95 && b <= 255 = Color240 119

161− | r <= 175 && g <= 135 && b <= 0 = Color240 120

162− | r <= 175 && g <= 135 && b <= 95 = Color240 121

163− | r <= 175 && g <= 135 && b <= 135 = Color240 122

164− | r <= 175 && g <= 135 && b <= 175 = Color240 123

165− | r <= 175 && g <= 135 && b <= 215 = Color240 124

166− | r <= 175 && g <= 135 && b <= 255 = Color240 125

167− | r <= 175 && g <= 175 && b <= 0 = Color240 126

168− | r <= 175 && g <= 175 && b <= 95 = Color240 127

169− | r <= 175 && g <= 175 && b <= 135 = Color240 128

170− | r <= 175 && g <= 175 && b <= 175 = Color240 129

171− | r <= 175 && g <= 175 && b <= 215 = Color240 130

172− | r <= 175 && g <= 175 && b <= 255 = Color240 131

173− | r <= 175 && g <= 215 && b <= 0 = Color240 132

174− | r <= 175 && g <= 215 && b <= 95 = Color240 133

175− | r <= 175 && g <= 215 && b <= 135 = Color240 134

176− | r <= 175 && g <= 215 && b <= 175 = Color240 135

177− | r <= 175 && g <= 215 && b <= 215 = Color240 136

178− | r <= 175 && g <= 215 && b <= 255 = Color240 137

179− | r <= 175 && g <= 255 && b <= 0 = Color240 138

180− | r <= 175 && g <= 255 && b <= 95 = Color240 139

181− | r <= 175 && g <= 255 && b <= 135 = Color240 140

182− | r <= 175 && g <= 255 && b <= 175 = Color240 141

183− | r <= 175 && g <= 255 && b <= 215 = Color240 142

184− | r <= 175 && g <= 255 && b <= 255 = Color240 143

185− | r <= 215 && g <= 0 && b <= 0 = Color240 144

186− | r <= 215 && g <= 0 && b <= 95 = Color240 145

187− | r <= 215 && g <= 0 && b <= 135 = Color240 146

188− | r <= 215 && g <= 0 && b <= 175 = Color240 147

189− | r <= 215 && g <= 0 && b <= 215 = Color240 148

190− | r <= 215 && g <= 0 && b <= 255 = Color240 149

191− | r <= 215 && g <= 95 && b <= 0 = Color240 150

192− | r <= 215 && g <= 95 && b <= 95 = Color240 151

193− | r <= 215 && g <= 95 && b <= 135 = Color240 152

194− | r <= 215 && g <= 95 && b <= 175 = Color240 153

195− | r <= 215 && g <= 95 && b <= 215 = Color240 154

196− | r <= 215 && g <= 95 && b <= 255 = Color240 155

197− | r <= 215 && g <= 135 && b <= 0 = Color240 156

198− | r <= 215 && g <= 135 && b <= 95 = Color240 157

199− | r <= 215 && g <= 135 && b <= 135 = Color240 158

200− | r <= 215 && g <= 135 && b <= 175 = Color240 159

201− | r <= 215 && g <= 135 && b <= 215 = Color240 160

202− | r <= 215 && g <= 135 && b <= 255 = Color240 161

203− | r <= 215 && g <= 175 && b <= 0 = Color240 162

204− | r <= 215 && g <= 175 && b <= 95 = Color240 163

205− | r <= 215 && g <= 175 && b <= 135 = Color240 164

206− | r <= 215 && g <= 175 && b <= 175 = Color240 165

207− | r <= 215 && g <= 175 && b <= 215 = Color240 166

208− | r <= 215 && g <= 175 && b <= 255 = Color240 167

209− | r <= 215 && g <= 215 && b <= 0 = Color240 168

210− | r <= 215 && g <= 215 && b <= 95 = Color240 169

211− | r <= 215 && g <= 215 && b <= 135 = Color240 170

212− | r <= 215 && g <= 215 && b <= 175 = Color240 171

213− | r <= 215 && g <= 215 && b <= 215 = Color240 172

214− | r <= 215 && g <= 215 && b <= 255 = Color240 173

215− | r <= 215 && g <= 255 && b <= 0 = Color240 174

216− | r <= 215 && g <= 255 && b <= 95 = Color240 175

217− | r <= 215 && g <= 255 && b <= 135 = Color240 176

218− | r <= 215 && g <= 255 && b <= 175 = Color240 177

219− | r <= 215 && g <= 255 && b <= 215 = Color240 178

220− | r <= 215 && g <= 255 && b <= 255 = Color240 179

221− | r <= 255 && g <= 0 && b <= 0 = Color240 180

222− | r <= 255 && g <= 0 && b <= 95 = Color240 181

223− | r <= 255 && g <= 0 && b <= 135 = Color240 182

224− | r <= 255 && g <= 0 && b <= 175 = Color240 183

225− | r <= 255 && g <= 0 && b <= 215 = Color240 184

226− | r <= 255 && g <= 0 && b <= 255 = Color240 185

227− | r <= 255 && g <= 95 && b <= 0 = Color240 186

228− | r <= 255 && g <= 95 && b <= 95 = Color240 187

229− | r <= 255 && g <= 95 && b <= 135 = Color240 188

230− | r <= 255 && g <= 95 && b <= 175 = Color240 189

231− | r <= 255 && g <= 95 && b <= 215 = Color240 190

232− | r <= 255 && g <= 95 && b <= 255 = Color240 191

233− | r <= 255 && g <= 135 && b <= 0 = Color240 192

234− | r <= 255 && g <= 135 && b <= 95 = Color240 193

235− | r <= 255 && g <= 135 && b <= 135 = Color240 194

236− | r <= 255 && g <= 135 && b <= 175 = Color240 195

237− | r <= 255 && g <= 135 && b <= 215 = Color240 196

238− | r <= 255 && g <= 135 && b <= 255 = Color240 197

239− | r <= 255 && g <= 175 && b <= 0 = Color240 198

240− | r <= 255 && g <= 175 && b <= 95 = Color240 199

241− | r <= 255 && g <= 175 && b <= 135 = Color240 200

242− | r <= 255 && g <= 175 && b <= 175 = Color240 201

243− | r <= 255 && g <= 175 && b <= 215 = Color240 202

244− | r <= 255 && g <= 175 && b <= 255 = Color240 203

245− | r <= 255 && g <= 215 && b <= 0 = Color240 204

246− | r <= 255 && g <= 215 && b <= 95 = Color240 205

247− | r <= 255 && g <= 215 && b <= 135 = Color240 206

248− | r <= 255 && g <= 215 && b <= 175 = Color240 207

249− | r <= 255 && g <= 215 && b <= 215 = Color240 208

250− | r <= 255 && g <= 215 && b <= 255 = Color240 209

251− | r <= 255 && g <= 255 && b <= 0 = Color240 210

252− | r <= 255 && g <= 255 && b <= 95 = Color240 211

253− | r <= 255 && g <= 255 && b <= 135 = Color240 212

254− | r <= 255 && g <= 255 && b <= 175 = Color240 213

255− | r <= 255 && g <= 255 && b <= 215 = Color240 214

256− | r <= 255 && g <= 255 && b <= 255 = Color240 215

257− | otherwise = error (printf "RGB color %d %d %d does not map to 240 palette."

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

25844 (fromIntegral r :: Int)

25945 (fromIntegral g :: Int)

260− (fromIntegral b :: 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

26154

55+-- | Create a RGB triple from a value in the Color240 set.

56+color240CodeToRGB :: Word8 -> Maybe (Int, Int, Int)

57+color240CodeToRGB n = case n of

58+ 0 -> Just (0, 0, 0)

59+ 1 -> Just (0, 0, 95)

60+ 2 -> Just (0, 0, 135)

61+ 3 -> Just (0, 0, 175)

62+ 4 -> Just (0, 0, 215)

63+ 5 -> Just (0, 0, 255)

64+ 6 -> Just (0, 95, 0)

65+ 7 -> Just (0, 95, 95)

66+ 8 -> Just (0, 95, 135)

67+ 9 -> Just (0, 95, 175)

68+ 10 -> Just (0, 95, 215)

69+ 11 -> Just (0, 95, 255)

70+ 12 -> Just (0, 135, 0)

71+ 13 -> Just (0, 135, 95)

72+ 14 -> Just (0, 135, 135)

73+ 15 -> Just (0, 135, 175)

74+ 16 -> Just (0, 135, 215)

75+ 17 -> Just (0, 135, 255)

76+ 18 -> Just (0, 175, 0)

77+ 19 -> Just (0, 175, 95)

78+ 20 -> Just (0, 175, 135)

79+ 21 -> Just (0, 175, 175)

80+ 22 -> Just (0, 175, 215)

81+ 23 -> Just (0, 175, 255)

82+ 24 -> Just (0, 215, 0)

83+ 25 -> Just (0, 215, 95)

84+ 26 -> Just (0, 215, 135)

85+ 27 -> Just (0, 215, 175)

86+ 28 -> Just (0, 215, 215)

87+ 29 -> Just (0, 215, 255)

88+ 30 -> Just (0, 255, 0)

89+ 31 -> Just (0, 255, 95)

90+ 32 -> Just (0, 255, 135)

91+ 33 -> Just (0, 255, 175)

92+ 34 -> Just (0, 255, 215)

93+ 35 -> Just (0, 255, 255)

94+ 36 -> Just (95, 0, 0)

95+ 37 -> Just (95, 0, 95)

96+ 38 -> Just (95, 0, 135)

97+ 39 -> Just (95, 0, 175)

98+ 40 -> Just (95, 0, 215)

99+ 41 -> Just (95, 0, 255)

100+ 42 -> Just (95, 95, 0)

101+ 43 -> Just (95, 95, 95)

102+ 44 -> Just (95, 95, 135)

103+ 45 -> Just (95, 95, 175)

104+ 46 -> Just (95, 95, 215)

105+ 47 -> Just (95, 95, 255)

106+ 48 -> Just (95, 135, 0)

107+ 49 -> Just (95, 135, 95)

108+ 50 -> Just (95, 135, 135)

109+ 51 -> Just (95, 135, 175)

110+ 52 -> Just (95, 135, 215)

111+ 53 -> Just (95, 135, 255)

112+ 54 -> Just (95, 175, 0)

113+ 55 -> Just (95, 175, 95)

114+ 56 -> Just (95, 175, 135)

115+ 57 -> Just (95, 175, 175)

116+ 58 -> Just (95, 175, 215)

117+ 59 -> Just (95, 175, 255)

118+ 60 -> Just (95, 215, 0)

119+ 61 -> Just (95, 215, 95)

120+ 62 -> Just (95, 215, 135)

121+ 63 -> Just (95, 215, 175)

122+ 64 -> Just (95, 215, 215)

123+ 65 -> Just (95, 215, 255)

124+ 66 -> Just (95, 255, 0)

125+ 67 -> Just (95, 255, 95)

126+ 68 -> Just (95, 255, 135)

127+ 69 -> Just (95, 255, 175)

128+ 70 -> Just (95, 255, 215)

129+ 71 -> Just (95, 255, 255)

130+ 72 -> Just (135, 0, 0)

131+ 73 -> Just (135, 0, 95)

132+ 74 -> Just (135, 0, 135)

133+ 75 -> Just (135, 0, 175)

134+ 76 -> Just (135, 0, 215)

135+ 77 -> Just (135, 0, 255)

136+ 78 -> Just (135, 95, 0)

137+ 79 -> Just (135, 95, 95)

138+ 80 -> Just (135, 95, 135)

139+ 81 -> Just (135, 95, 175)

140+ 82 -> Just (135, 95, 215)

141+ 83 -> Just (135, 95, 255)

142+ 84 -> Just (135, 135, 0)

143+ 85 -> Just (135, 135, 95)

144+ 86 -> Just (135, 135, 135)

145+ 87 -> Just (135, 135, 175)

146+ 88 -> Just (135, 135, 215)

147+ 89 -> Just (135, 135, 255)

148+ 90 -> Just (135, 175, 0)

149+ 91 -> Just (135, 175, 95)

150+ 92 -> Just (135, 175, 135)

151+ 93 -> Just (135, 175, 175)

152+ 94 -> Just (135, 175, 215)

153+ 95 -> Just (135, 175, 255)

154+ 96 -> Just (135, 215, 0)

155+ 97 -> Just (135, 215, 95)

156+ 98 -> Just (135, 215, 135)

157+ 99 -> Just (135, 215, 175)

158+ 100 -> Just (135, 215, 215)

159+ 101 -> Just (135, 215, 255)

160+ 102 -> Just (135, 255, 0)

161+ 103 -> Just (135, 255, 95)

162+ 104 -> Just (135, 255, 135)

163+ 105 -> Just (135, 255, 175)

164+ 106 -> Just (135, 255, 215)

165+ 107 -> Just (135, 255, 255)

166+ 108 -> Just (175, 0, 0)

167+ 109 -> Just (175, 0, 95)

168+ 110 -> Just (175, 0, 135)

169+ 111 -> Just (175, 0, 175)

170+ 112 -> Just (175, 0, 215)

171+ 113 -> Just (175, 0, 255)

172+ 114 -> Just (175, 95, 0)

173+ 115 -> Just (175, 95, 95)

174+ 116 -> Just (175, 95, 135)

175+ 117 -> Just (175, 95, 175)

176+ 118 -> Just (175, 95, 215)

177+ 119 -> Just (175, 95, 255)

178+ 120 -> Just (175, 135, 0)

179+ 121 -> Just (175, 135, 95)

180+ 122 -> Just (175, 135, 135)

181+ 123 -> Just (175, 135, 175)

182+ 124 -> Just (175, 135, 215)

183+ 125 -> Just (175, 135, 255)

184+ 126 -> Just (175, 175, 0)

185+ 127 -> Just (175, 175, 95)

186+ 128 -> Just (175, 175, 135)

187+ 129 -> Just (175, 175, 175)

188+ 130 -> Just (175, 175, 215)

189+ 131 -> Just (175, 175, 255)

190+ 132 -> Just (175, 215, 0)

191+ 133 -> Just (175, 215, 95)

192+ 134 -> Just (175, 215, 135)

193+ 135 -> Just (175, 215, 175)

194+ 136 -> Just (175, 215, 215)

195+ 137 -> Just (175, 215, 255)

196+ 138 -> Just (175, 255, 0)

197+ 139 -> Just (175, 255, 95)

198+ 140 -> Just (175, 255, 135)

199+ 141 -> Just (175, 255, 175)

200+ 142 -> Just (175, 255, 215)

201+ 143 -> Just (175, 255, 255)

202+ 144 -> Just (215, 0, 0)

203+ 145 -> Just (215, 0, 95)

204+ 146 -> Just (215, 0, 135)

205+ 147 -> Just (215, 0, 175)

206+ 148 -> Just (215, 0, 215)

207+ 149 -> Just (215, 0, 255)

208+ 150 -> Just (215, 95, 0)

209+ 151 -> Just (215, 95, 95)

210+ 152 -> Just (215, 95, 135)

211+ 153 -> Just (215, 95, 175)

212+ 154 -> Just (215, 95, 215)

213+ 155 -> Just (215, 95, 255)

214+ 156 -> Just (215, 135, 0)

215+ 157 -> Just (215, 135, 95)

216+ 158 -> Just (215, 135, 135)

217+ 159 -> Just (215, 135, 175)

218+ 160 -> Just (215, 135, 215)

219+ 161 -> Just (215, 135, 255)

220+ 162 -> Just (215, 175, 0)

221+ 163 -> Just (215, 175, 95)

222+ 164 -> Just (215, 175, 135)

223+ 165 -> Just (215, 175, 175)

224+ 166 -> Just (215, 175, 215)

225+ 167 -> Just (215, 175, 255)

226+ 168 -> Just (215, 215, 0)

227+ 169 -> Just (215, 215, 95)

228+ 170 -> Just (215, 215, 135)

229+ 171 -> Just (215, 215, 175)

230+ 172 -> Just (215, 215, 215)

231+ 173 -> Just (215, 215, 255)

232+ 174 -> Just (215, 255, 0)

233+ 175 -> Just (215, 255, 95)

234+ 176 -> Just (215, 255, 135)

235+ 177 -> Just (215, 255, 175)

236+ 178 -> Just (215, 255, 215)

237+ 179 -> Just (215, 255, 255)

238+ 180 -> Just (255, 0, 0)

239+ 181 -> Just (255, 0, 95)

240+ 182 -> Just (255, 0, 135)

241+ 183 -> Just (255, 0, 175)

242+ 184 -> Just (255, 0, 215)

243+ 185 -> Just (255, 0, 255)

244+ 186 -> Just (255, 95, 0)

245+ 187 -> Just (255, 95, 95)

246+ 188 -> Just (255, 95, 135)

247+ 189 -> Just (255, 95, 175)

248+ 190 -> Just (255, 95, 215)

249+ 191 -> Just (255, 95, 255)

250+ 192 -> Just (255, 135, 0)

251+ 193 -> Just (255, 135, 95)

252+ 194 -> Just (255, 135, 135)

253+ 195 -> Just (255, 135, 175)

254+ 196 -> Just (255, 135, 215)

255+ 197 -> Just (255, 135, 255)

256+ 198 -> Just (255, 175, 0)

257+ 199 -> Just (255, 175, 95)

258+ 200 -> Just (255, 175, 135)

259+ 201 -> Just (255, 175, 175)

260+ 202 -> Just (255, 175, 215)

261+ 203 -> Just (255, 175, 255)

262+ 204 -> Just (255, 215, 0)

263+ 205 -> Just (255, 215, 95)

264+ 206 -> Just (255, 215, 135)

265+ 207 -> Just (255, 215, 175)

266+ 208 -> Just (255, 215, 215)

267+ 209 -> Just (255, 215, 255)

268+ 210 -> Just (255, 255, 0)

269+ 211 -> Just (255, 255, 95)

270+ 212 -> Just (255, 255, 135)

271+ 213 -> Just (255, 255, 175)

272+ 214 -> Just (255, 255, 215)

273+ 215 -> Just (255, 255, 255)

274+ 216 -> Just (8, 8, 8)

275+ 217 -> Just (18, 18, 18)

276+ 218 -> Just (28, 28, 28)

277+ 219 -> Just (38, 38, 38)

278+ 220 -> Just (48, 48, 48)

279+ 221 -> Just (58, 58, 58)

280+ 222 -> Just (68, 68, 68)

281+ 223 -> Just (78, 78, 78)

282+ 224 -> Just (88, 88, 88)

283+ 225 -> Just (98, 98, 98)

284+ 226 -> Just (108, 108, 108)

285+ 227 -> Just (118, 118, 118)

286+ 228 -> Just (128, 128, 128)

287+ 229 -> Just (138, 138, 138)

288+ 230 -> Just (148, 148, 148)

289+ 231 -> Just (158, 158, 158)

290+ 232 -> Just (168, 168, 168)

291+ 233 -> Just (178, 178, 178)

292+ 234 -> Just (188, 188, 188)

293+ 235 -> Just (198, 198, 198)

294+ 236 -> Just (208, 208, 208)

295+ 237 -> Just (218, 218, 218)

296+ 238 -> Just (228, 228, 228)

297+ 239 -> Just (238, 238, 238)

298+ _ -> Nothing

src/Graphics/Vty/Config.hs+278−107

@@ -3,23 +3,13 @@

33{-# LANGUAGE FlexibleContexts, FlexibleInstances #-}

44{-# LANGUAGE TypeOperators #-}

55{-# LANGUAGE ScopedTypeVariables #-}

6−-- | A 'Config' can be provided to mkVty to customize the applications

7−-- use of vty. A config file can be used to customize vty for a user's

8−-- system.

9−--

10−-- The 'Config' provided is mappend'd to 'Config's loaded from

11−-- @'getAppUserDataDirectory'/config@ and @$VTY_CONFIG_FILE@. The

12−-- @$VTY_CONFIG_FILE@ takes precedence over the @config@ file or the

13−-- application provided 'Config'.

6+{-# LANGUAGE LambdaCase, MultiWayIf #-}

7+-- | Vty supports a configuration file format and associated 'Config'

8+-- data type. The 'Config' can be provided to 'mkVty' to customize the

9+-- application's use of Vty.

1410--

1511-- Lines in config files that fail to parse are ignored. Later entries

16−-- take precedence over earlier.

17−--

18−-- For all directives:

19−--

20−-- @

21−-- string := \"\\\"\" chars+ \"\\\"\"

22−-- @

12+-- take precedence over earlier ones.

2313--

2414-- = Debug

2515--

@@ -49,7 +39,7 @@

4939-- term := "_" | string

5040-- @

5141--

52−-- EG: If the contents are

42+-- E.g., if the contents are

5343--

5444-- @

5545-- map _ \"\\ESC[B\" KUp []

@@ -63,11 +53,35 @@

6353-- result in the KLeft event when @TERM@ is @xterm@.

6454--

6555-- If a debug log is requested then vty will output the current input

66−-- table to the log in the above format.

56+-- table to the log in the above format. A workflow for using this is

57+-- 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.,

6771--

68−-- Set VTY_DEBUG_LOG. Run vty. Check debug log for incorrect mappings.

69−-- Add corrected mappings to .vty/config

72+-- @

73+-- widthMap \"xterm\" \"\/home\/user\/.vty\/xterm\_map.dat\"

74+-- @

7075--

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.

7185module Graphics.Vty.Config

7286 ( InputMap

7387 , Config(..)

@@ -77,13 +91,22 @@ module Graphics.Vty.Config

7791 , standardIOConfig

7892 , runParseConfig

7993 , parseConfigFile

80− ) where

94+ , defaultConfig

95+ , getTtyEraseChar

96+ , currentTerminalName

97+

98+ , vtyConfigPath

99+ , widthTableFilename

100+ , vtyDataDirectory

101+ , terminalWidthTablePath

102+ , vtyConfigFileEnvName

103+

104+ , ConfigUpdateResult(..)

105+ , addConfigWidthMap

106+ )

107+where

81108

82−#if __GLASGOW_HASKELL__ > 704

83109import Prelude

84−#else

85−import Prelude hiding (catch)

86−#endif

87110

88111import Control.Applicative hiding (many)

89112

@@ -91,118 +114,186 @@ import Control.Exception (catch, IOException, Exception(..), throwIO)

91114import Control.Monad (liftM, guard, void)

92115

93116import qualified Data.ByteString as BS

94−import Data.Default

95−import Data.Monoid

117+#if !(MIN_VERSION_base(4,8,0))

118+import Data.Monoid (Monoid(..))

119+#endif

120+#if !(MIN_VERSION_base(4,11,0))

121+import Data.Semigroup (Semigroup(..))

122+#endif

96123import Data.Typeable (Typeable)

97124

98125import Graphics.Vty.Input.Events

126+import Graphics.Vty.Attributes.Color (ColorMode(..), detectColorMode)

99127

100128import GHC.Generics

101129

102−import System.Directory (getAppUserDataDirectory)

103−import System.Posix.Env (getEnv)

130+import System.Directory ( getAppUserDataDirectory, doesFileExist

131+ , createDirectoryIfMissing

132+ )

133+import System.Environment (lookupEnv)

134+import System.FilePath ((</>), takeDirectory)

104135import System.Posix.IO (stdInput, stdOutput)

105136import System.Posix.Types (Fd(..))

137+import Foreign.C.Types (CInt(..), CChar(..))

106138

107139import Text.Parsec hiding ((<|>))

108140import Text.Parsec.Token ( GenLanguageDef(..) )

109141import qualified Text.Parsec.Token as P

110142

111143-- | Type of errors that can be thrown when configuring VTY

112−data VtyConfigurationError

113− = VtyMissingTermEnvVar -- ^ TERM environment variable not set

114− deriving (Show, Eq, Typeable)

144+data VtyConfigurationError =

145+ VtyMissingTermEnvVar

146+ -- ^ TERM environment variable not set

147+ deriving (Show, Eq, Typeable)

115148

116149instance Exception VtyConfigurationError where

117−#if MIN_VERSION_base(4,8,0)

118− displayException VtyMissingTermEnvVar = "TERM environment variable not set"

119−#endif

150+ displayException VtyMissingTermEnvVar = "TERM environment variable not set"

120151

121152-- | Mappings from input bytes to event in the order specified. Later

122153-- entries take precedence over earlier in the case multiple entries

123154-- have the same byte string.

124155type InputMap = [(Maybe String, String, Event)]

125156

126−data Config = Config

127− {

128− -- | The default is 1 character.

129− vmin :: Maybe Int

130− -- | The default is 100 milliseconds, 0.1 seconds.

131− , vtime :: Maybe Int

132− -- | The default is False.

133− , mouseMode :: Maybe Bool

134− -- | The default is False.

135− , bracketedPasteMode :: Maybe Bool

136− -- | Debug information is appended to this file if not Nothing.

137− , debugLog :: Maybe FilePath

138− -- | The (input byte, output event) pairs extend the internal input

139− -- table of VTY and the table from terminfo.

140− --

141− -- See "Graphics.Vty.Config" module documentation for documentation

142− -- of the @map@ directive.

143− , inputMap :: InputMap

144− -- | The input file descriptor to use. The default is

145− -- 'System.Posix.IO.stdInput'

146− , inputFd :: Maybe Fd

147− -- | The output file descriptor to use. The default is

148− -- 'System.Posix.IO.stdOutput'

149− , outputFd :: Maybe Fd

150− -- | The terminal name used to look up terminfo capabilities.

151− -- The default is the value of the TERM environment variable.

152− , termName :: Maybe String

153− } deriving (Show, Eq)

154−

155−instance Default Config where

156− def = mempty

157+-- | 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)

203+

204+defaultConfig :: Config

205+defaultConfig = mempty

206+

207+instance Semigroup Config where

208+ c0 <> c1 =

209+ -- 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+ }

157224

158225instance Monoid Config where

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− }

170− mappend c0 c1 = Config

171− -- latter config takes priority for everything but inputMap

172− { vmin = vmin c1 <|> vmin c0

173− , vtime = vtime c1 <|> vtime c0

174− , mouseMode = mouseMode c1

175− , bracketedPasteMode = bracketedPasteMode c1

176− , debugLog = debugLog c1 <|> debugLog c0

177− , inputMap = inputMap c0 <> inputMap c1

178− , inputFd = inputFd c1 <|> inputFd c0

179− , outputFd = outputFd c1 <|> outputFd c0

180− , termName = termName c1 <|> termName c0

181− }

182−

183−-- | Config from @'getAppUserDataDirectory'/config@ and

184−-- @$VTY_CONFIG_FILE@

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+ }

240+#if !(MIN_VERSION_base(4,11,0))

241+ mappend = (<>)

242+#endif

243+

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

185256userConfig :: IO Config

186257userConfig = do

187− configFile <- (mappend <$> getAppUserDataDirectory "vty" <*> pure "/config") >>= parseConfigFile

188− overrideConfig <- maybe (return def) parseConfigFile =<< getEnv "VTY_CONFIG_FILE"

258+ configFile <- vtyConfigPath >>= parseConfigFile

259+ overrideConfig <- maybe (return defaultConfig) parseConfigFile =<<

260+ lookupEnv vtyConfigFileEnvName

189261 let base = configFile <> overrideConfig

190262 mappend base <$> overrideEnvConfig

191263

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+

192282overrideEnvConfig :: IO Config

193283overrideEnvConfig = do

194− d <- getEnv "VTY_DEBUG_LOG"

195− return $ def { debugLog = d }

284+ d <- lookupEnv "VTY_DEBUG_LOG"

285+ return $ defaultConfig { debugLog = d }

196286

197−-- | Configures VTY using defaults suitable for terminals. This action

287+-- | Configures VTY using defaults suitable for terminals. This function

198288-- can raise 'VtyConfigurationError'.

199289standardIOConfig :: IO Config

200290standardIOConfig = do

201− mb <- getEnv "TERM"

291+ mb <- lookupEnv termVariable

202292 case mb of

203293 Nothing -> throwIO VtyMissingTermEnvVar

204− Just t ->

205− return def

294+ Just t -> do

295+ mcolorMode <- detectColorMode t

296+ return defaultConfig

206297 { vmin = Just 1

207298 , mouseMode = Just False

208299 , bracketedPasteMode = Just False

@@ -210,25 +301,24 @@ standardIOConfig = do

210301 , inputFd = Just stdInput

211302 , outputFd = Just stdOutput

212303 , termName = Just t

304+ , colorMode = Just mcolorMode

213305 }

214306

215307parseConfigFile :: FilePath -> IO Config

216308parseConfigFile path = do

217309 catch (runParseConfig path <$> BS.readFile path)

218− (\(_ :: IOException) -> return def)

310+ (\(_ :: IOException) -> return defaultConfig)

219311

220312runParseConfig :: String -> BS.ByteString -> Config

221313runParseConfig name cfgTxt =

222314 case runParser parseConfig () name cfgTxt of

223315 Right cfg -> cfg

224− Left{} -> def

316+ Left{} -> defaultConfig

225317

226318------------------------------------------------------------------------

227319

228320type Parser = Parsec BS.ByteString ()

229321

230−-- I tried to use the haskellStyle here but that was specialized

231−-- (without requirement?) to the String stream type.

232322configLanguage :: Monad m => P.GenLanguageDef BS.ByteString () m

233323configLanguage = LanguageDef

234324 { commentStart = "{-"

@@ -255,13 +345,20 @@ mapDecl = do

255345 bytes <- P.stringLiteral configLexer

256346 key <- parseValue

257347 modifiers <- parseValue

258− return def { inputMap = [(termIdent, bytes, EvKey key modifiers)] }

348+ return defaultConfig { inputMap = [(termIdent, bytes, EvKey key modifiers)] }

259349

260350debugLogDecl :: Parser Config

261351debugLogDecl = do

262352 "debugLog" <- P.identifier configLexer

263353 path <- P.stringLiteral configLexer

264− return def { debugLog = Just path }

354+ return defaultConfig { debugLog = Just path }

355+

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)] }

265362

266363ignoreLine :: Parser ()

267364ignoreLine = void $ manyTill anyChar newline

@@ -269,8 +366,8 @@ ignoreLine = void $ manyTill anyChar newline

269366parseConfig :: Parser Config

270367parseConfig = liftM mconcat $ many $ do

271368 P.whiteSpace configLexer

272− let directives = [try mapDecl, try debugLogDecl]

273− choice directives <|> (ignoreLine >> return def)

369+ let directives = [try mapDecl, try debugLogDecl, try widthMapDecl]

370+ choice directives <|> (ignoreLine >> return defaultConfig)

274371

275372class Parse a where parseValue :: Parser a

276373instance Parse Char where parseValue = P.charLiteral configLexer

@@ -315,3 +412,77 @@ instance (GParseAlts f, GParseAlts g) => GParseAlts (f :+: g) where

315412 gparseAlts con = L1 <$> gparseAlts con <|> R1 <$> gparseAlts con

316413

317414instance 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+11−11

@@ -1,27 +1,27 @@

2−module Graphics.Vty.Debug ( module Graphics.Vty.Debug

3− , module Graphics.Vty.Debug.Image

4− )

2+module Graphics.Vty.Debug

3+ ( module Graphics.Vty.Debug

4+ , module Graphics.Vty.Debug.Image

5+ )

56where

67

7−import Graphics.Vty.Prelude

8−

98import Graphics.Vty.Attributes

9+import Graphics.Vty.Image (DisplayRegion)

1010import Graphics.Vty.Debug.Image

1111import Graphics.Vty.Span

1212

1313import qualified Data.Vector as Vector

1414

15−rowOpsEffectedColumns :: DisplayOps -> [Int]

16−rowOpsEffectedColumns ops

17− = Vector.toList $ Vector.map spanOpsEffectedColumns ops

15+rowOpsAffectedColumns :: DisplayOps -> [Int]

16+rowOpsAffectedColumns ops

17+ = Vector.toList $ Vector.map spanOpsAffectedColumns ops

1818

1919allSpansHaveWidth :: DisplayOps -> Int -> Bool

2020allSpansHaveWidth ops expected

21− = all (== expected) $ Vector.toList $ Vector.map spanOpsEffectedColumns ops

21+ = all (== expected) $ Vector.toList $ Vector.map spanOpsAffectedColumns ops

2222

23−spanOpsEffectedRows :: DisplayOps -> Int

24−spanOpsEffectedRows ops

23+spanOpsAffectedRows :: DisplayOps -> Int

24+spanOpsAffectedRows ops

2525 = toEnum $ length (filter (not . null . Vector.toList) (Vector.toList ops))

2626

2727type SpanConstructLog = [SpanConstructEvent]

src/Graphics/Vty/DisplayAttributes.hs+47−18

@@ -1,21 +1,18 @@

2−{-# LANGUAGE CPP #-}

32{-# LANGUAGE BangPatterns #-}

3+{-# LANGUAGE CPP #-}

44

5−#ifndef MIN_VERSION_base

6−#defined MIN_VERSION_base(x,y,z) 1

7−#endif

8−

9−module Graphics.Vty.DisplayAttributes

10− where

5+module Graphics.Vty.DisplayAttributes where

116

127import Graphics.Vty.Attributes

138

149import Data.Bits ((.&.))

15−

16−#if !(MIN_VERSION_base(4,8,0))

17−import Data.Monoid (Monoid(..), mconcat)

10+import Data.ByteString (ByteString)

11+#if !(MIN_VERSION_base(4,11,0))

12+import Data.Semigroup (Semigroup(..))

1813#endif

14+import Data.Text (Text)

15+import Data.Text.Encoding (encodeUtf8)

1916

2017-- | Given the previously applied display attributes as a FixedAttr and

2118-- the current display attributes as an Attr produces a FixedAttr that

@@ -27,6 +24,7 @@ fixDisplayAttr fattr attr

2724 = FixedAttr (fixStyle (fixedStyle fattr) (attrStyle attr))

2825 (fixColor (fixedForeColor fattr) (attrForeColor attr))

2926 (fixColor (fixedBackColor fattr) (attrBackColor attr))

27+ (fixURL (fixedURL fattr) (attrURL attr))

3028 where

3129 fixStyle _s Default = defaultStyleMask

3230 fixStyle s KeepCurrent = s

@@ -34,6 +32,9 @@ fixDisplayAttr fattr attr

3432 fixColor _c Default = Nothing

3533 fixColor c KeepCurrent = c

3634 fixColor _c (SetTo c) = Just c

35+ fixURL c KeepCurrent = c

36+ fixURL _c (SetTo n) = Just n

37+ fixURL _c Default = Nothing

3738

3839-- | difference between two display attributes. Used in the calculation

3940-- of the operations required to go from one display attribute to the

@@ -46,32 +47,41 @@ data DisplayAttrDiff = DisplayAttrDiff

4647 { styleDiffs :: [StyleStateChange]

4748 , foreColorDiff :: DisplayColorDiff

4849 , backColorDiff :: DisplayColorDiff

50+ , urlDiff :: URLDiff

4951 }

5052 deriving (Show)

5153

52−instance Monoid DisplayAttrDiff where

53− mempty = DisplayAttrDiff [] NoColorChange NoColorChange

54− mappend d0 d1 =

54+instance Semigroup DisplayAttrDiff where

55+ d0 <> d1 =

5556 let ds = simplifyStyleDiffs (styleDiffs d0) (styleDiffs d1)

5657 fcd = simplifyColorDiffs (foreColorDiff d0) (foreColorDiff d1)

5758 bcd = simplifyColorDiffs (backColorDiff d0) (backColorDiff d1)

58− in DisplayAttrDiff ds fcd bcd

59+ ud = simplifyUrlDiffs (urlDiff d0) (urlDiff d1)

60+ in DisplayAttrDiff ds fcd bcd ud

61+

62+instance Monoid DisplayAttrDiff where

63+ mempty = DisplayAttrDiff [] NoColorChange NoColorChange NoLinkChange

64+#if !(MIN_VERSION_base(4,11,0))

65+ mappend = (<>)

66+#endif

5967

6068-- | Used in the computation of a final style attribute change.

61−--

62−-- TODO(corey): not really a simplify but a monoid instance.

6369simplifyStyleDiffs :: [StyleStateChange] -> [StyleStateChange] -> [StyleStateChange]

6470simplifyStyleDiffs cs0 cs1 = cs0 `mappend` cs1

6571

6672-- | Consider two display color attributes diffs. What display color

6773-- attribute diff are these equivalent to?

68−--

69−-- TODO(corey): not really a simplify but a monoid instance.

7074simplifyColorDiffs :: DisplayColorDiff -> DisplayColorDiff -> DisplayColorDiff

7175simplifyColorDiffs _cd ColorToDefault = ColorToDefault

7276simplifyColorDiffs cd NoColorChange = cd

7377simplifyColorDiffs _cd (SetColor !c) = SetColor c

7478

79+-- | Consider two URL changes, which are mostly going to be the latter

80+-- unless the latter specifies no change.

81+simplifyUrlDiffs :: URLDiff -> URLDiff -> URLDiff

82+simplifyUrlDiffs ud NoLinkChange = ud

83+simplifyUrlDiffs _ ud = ud

84+

7585-- | Difference between two display color attribute changes.

7686data DisplayColorDiff

7787 = ColorToDefault

@@ -84,6 +94,10 @@ data DisplayColorDiff

8494data StyleStateChange

8595 = ApplyStandout

8696 | RemoveStandout

97+ | ApplyItalic

98+ | RemoveItalic

99+ | ApplyStrikethrough

100+ | RemoveStrikethrough

87101 | ApplyUnderline

88102 | RemoveUnderline

89103 | ApplyReverseVideo

@@ -96,6 +110,13 @@ data StyleStateChange

96110 | RemoveBold

97111 deriving (Show, Eq)

98112

113+-- Setting and unsetting hyperlinks

114+data URLDiff

115+ = LinkTo !ByteString

116+ | NoLinkChange

117+ | EndLink

118+ deriving (Show, Eq)

119+

99120-- | Determines the diff between two display&color attributes. This diff

100121-- determines the operations that actually get output to the terminal.

101122displayAttrDiffs :: FixedAttr -> FixedAttr -> DisplayAttrDiff

@@ -103,8 +124,14 @@ displayAttrDiffs attr attr' = DisplayAttrDiff

103124 { styleDiffs = diffStyles (fixedStyle attr) (fixedStyle attr')

104125 , foreColorDiff = diffColor (fixedForeColor attr) (fixedForeColor attr')

105126 , backColorDiff = diffColor (fixedBackColor attr) (fixedBackColor attr')

127+ , urlDiff = diffURL (fixedURL attr) (fixedURL attr')

106128 }

107129

130+diffURL :: Maybe Text -> Maybe Text -> URLDiff

131+diffURL Nothing Nothing = NoLinkChange

132+diffURL (Just _) Nothing = EndLink

133+diffURL _ (Just url) = LinkTo (encodeUtf8 url)

134+

108135diffColor :: Maybe Color -> Maybe Color -> DisplayColorDiff

109136diffColor Nothing (Just c') = SetColor c'

110137diffColor (Just c) (Just c')

@@ -118,6 +145,8 @@ diffStyles prev cur

118145 = mconcat

119146 [ styleDiff standout ApplyStandout RemoveStandout

120147 , styleDiff underline ApplyUnderline RemoveUnderline

148+ , styleDiff italic ApplyItalic RemoveItalic

149+ , styleDiff strikethrough ApplyStrikethrough RemoveStrikethrough

121150 , styleDiff reverseVideo ApplyReverseVideo RemoveReverseVideo

122151 , styleDiff blink ApplyBlink RemoveBlink

123152 , styleDiff dim ApplyDim RemoveDim

src/Graphics/Vty/Error.hs+1−2

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

1−module Graphics.Vty.Error

2− where

1+module Graphics.Vty.Error where

32

43-- | The type of exceptions specific to vty.

54--

src/Graphics/Vty/Image.hs+178−107

@@ -1,49 +1,63 @@

2−{-# LANGUAGE BangPatterns #-}

32{-# LANGUAGE NamedFieldPuns #-}

43{-# LANGUAGE DisambiguateRecordFields #-}

5−module Graphics.Vty.Image ( DisplayText

6− , Image

7− , imageWidth

8− , imageHeight

9− , horizJoin

10− , (<|>)

11− , vertJoin

12− , (<->)

13− , horizCat

14− , vertCat

15− , backgroundFill

16− , text

17− , text'

18− , char

19− , string

20− , iso10646String

21− , utf8String

22− , utf8Bytestring

23− , utf8Bytestring'

24− , charFill

25− , emptyImage

26− , safeWcwidth

27− , safeWcswidth

28− , wcwidth

29− , wcswidth

30− , crop

31− , cropRight

32− , cropLeft

33− , cropBottom

34− , cropTop

35− , pad

36− , resize

37− , resizeWidth

38− , resizeHeight

39− , translate

40− , translateX

41− , translateY

42− -- | The possible display attributes used in

43− -- constructing an `Image`.

44− , module Graphics.Vty.Attributes

45− )

46− where

4+-- | A Vty program makes 'Picture's from 'Image's. This module provides

5+-- the core constructors for creating, combining, and modifying

6+-- 'Image's.

7+module Graphics.Vty.Image

8+ (

9+ -- * Images

10+ Image

11+ , imageWidth

12+ , imageHeight

13+ -- * Image constructors

14+ , emptyImage

15+ , char

16+ , string

17+ , iso10646String

18+ , utf8String

19+ , text

20+ , text'

21+ , backgroundFill

22+ , utf8Bytestring

23+ , utf8Bytestring'

24+ , charFill

25+ -- * Combinators

26+ , horizJoin

27+ , (<|>)

28+ , vertJoin

29+ , (<->)

30+ , horizCat

31+ , vertCat

32+ -- * Image modifications

33+ , crop

34+ , cropRight

35+ , cropLeft

36+ , cropBottom

37+ , cropTop

38+ , pad

39+ , resize

40+ , resizeWidth

41+ , resizeHeight

42+ , translate

43+ , translateX

44+ , translateY

45+ -- * Character width functions

46+ , safeWcwidth

47+ , safeWcswidth

48+ , safeWctwidth

49+ , safeWctlwidth

50+ , wcwidth

51+ , wcswidth

52+ , wctwidth

53+ , wctlwidth

54+ -- * Display Regions

55+ , DisplayText

56+ , DisplayRegion

57+ , regionWidth

58+ , regionHeight

59+ )

60+where

4761

4862import Graphics.Vty.Attributes

4963import Graphics.Vty.Image.Internal

@@ -57,60 +71,80 @@ import qualified Data.Text.Lazy as TL

5771import qualified Data.Text.Lazy.Encoding as TL

5872import Data.Word

5973

74+-- | A region of the display (first width, then height)

75+type DisplayRegion = (Int,Int)

76+

77+regionWidth :: DisplayRegion -> Int

78+regionWidth = fst

79+

80+regionHeight :: DisplayRegion -> Int

81+regionHeight = snd

82+

6083infixr 5 <|>

6184infixr 4 <->

6285

63−-- | An area of the picture's bacground (See Background) of w columns

64−-- and h rows.

65−backgroundFill :: Int -> Int -> Image

86+-- | An area of the picture's background (See 'Background').

87+backgroundFill :: Int

88+ -- ^ Fill width in columns

89+ -> Int

90+ -- ^ Fill height in rows

91+ -> Image

6692backgroundFill w h

6793 | w == 0 = EmptyImage

6894 | h == 0 = EmptyImage

6995 | otherwise = BGFill w h

7096

71−-- | Combines two images horizontally. Alias for horizJoin

97+-- | Combines two images horizontally. This is an alias for 'horizJoin'.

7298--

7399-- infixr 5

74100(<|>) :: Image -> Image -> Image

75101(<|>) = horizJoin

76102

77−-- | Combines two images vertically. Alias for vertJoin

103+-- | Combines two images vertically. This is an alias for 'vertJoin'.

78104--

79105-- infixr 4

80106(<->) :: Image -> Image -> Image

81107(<->) = vertJoin

82108

83−-- | Compose any number of images horizontally.

109+-- | Compose any number of images together horizontally, with the first

110+-- in the list being leftmost.

84111horizCat :: [Image] -> Image

85112horizCat = foldr horizJoin EmptyImage

86113

87−-- | Compose any number of images vertically.

114+-- | Compose any number of images vertically, with the first in the list

115+-- being topmost.

88116vertCat :: [Image] -> Image

89117vertCat = foldr vertJoin EmptyImage

90118

91−-- | A Data.Text.Lazy value

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.

92122text :: Attr -> TL.Text -> Image

93−text a txt = let displayWidth = safeWcswidth (TL.unpack txt)

123+text a txt = let displayWidth = safeWctlwidth txt

94124 in HorizText a txt displayWidth (fromIntegral $! TL.length txt)

95125

96−-- | A Data.Text value

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.

97129text' :: Attr -> T.Text -> Image

98−text' a txt = let displayWidth = safeWcswidth (T.unpack txt)

130+text' a txt = let displayWidth = safeWctwidth txt

99131 in HorizText a (TL.fromStrict txt) displayWidth (T.length txt)

100132

101−-- | An image of a single character. This is a standard Haskell 31-bit

102−-- character assumed to be in the ISO-10646 encoding.

133+-- | Make an image from a single character. This is a standard Haskell

134+-- 31-bit character assumed to be in the ISO-10646 encoding.

103135char :: Attr -> Char -> Image

104136char a c =

105137 let displayWidth = safeWcwidth c

106138 in HorizText a (TL.singleton c) displayWidth 1

107139

108−-- | A string of characters layed out on a single row with the same

109−-- display attribute. The string is assumed to be a sequence of

110−-- ISO-10646 characters.

140+-- | Make an image from a string of characters laid out on a single

141+-- 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.

111145--

112146-- Note: depending on how the Haskell compiler represents string

113−-- literals a string literal in a UTF-8 encoded source file, for

147+-- literals, a string literal in a UTF-8 encoded source file, for

114148-- example, may be represented as a ISO-10646 string. That is, I think,

115149-- the case with GHC 6.10. This means, for the most part, you don't need

116150-- to worry about the encoding format when outputting string literals.

@@ -120,9 +154,11 @@ iso10646String a str =

120154 let displayWidth = safeWcswidth str

121155 in HorizText a (TL.pack str) displayWidth (length str)

122156

123−-- | Alias for iso10646String. Since the usual case is that a literal

124−-- string like "foo" is represented internally as a list of ISO 10646 31

125−-- bit characters.

157+-- | Make an 'Image' from a 'String'.

158+--

159+-- This is an alias for iso10646String since the usual case is that a

160+-- literal string like "foo" is represented internally as a list of ISO

161+-- 10646 31 bit characters.

126162--

127163-- Note: Keep in mind that GHC will compile source encoded as UTF-8

128164-- but the literal strings, while UTF-8 encoded in the source, will be

@@ -130,46 +166,68 @@ iso10646String a str =

130166string :: Attr -> String -> Image

131167string = iso10646String

132168

133−-- | A string of characters layed out on a single row. The input is

134−-- assumed to be the bytes for UTF-8 encoded text.

169+-- | Make an 'Image' from a string of characters layed out on a single

170+-- row. The input is assumed to be the bytes for UTF-8 encoded text.

135171utf8String :: Attr -> [Word8] -> Image

136172utf8String a bytes = utf8Bytestring a (BL.pack bytes)

137173

138−-- | Renders a UTF-8 encoded lazy bytestring.

174+-- | Make an 'Image' from a UTF-8 encoded lazy bytestring.

139175utf8Bytestring :: Attr -> BL.ByteString -> Image

140176utf8Bytestring a bs = text a (TL.decodeUtf8 bs)

141177

142−-- | Renders a UTF-8 encoded strict bytestring.

178+-- | Make an 'Image' from a UTF-8 encoded strict bytestring.

143179utf8Bytestring' :: Attr -> B.ByteString -> Image

144180utf8Bytestring' a bs = text' a (T.decodeUtf8 bs)

145181

146−-- | Creates a fill of the specified character. The dimensions are in

147−-- number of characters wide and number of rows high.

148−charFill :: Integral d => Attr -> Char -> d -> d -> Image

149−charFill _a _c 0 _h = EmptyImage

150−charFill _a _c _w 0 = EmptyImage

151−charFill a c w h =

152− vertCat $ replicate (fromIntegral h) $ HorizText a txt displayWidth charWidth

153− where

154− txt = TL.replicate (fromIntegral w) (TL.singleton c)

155− displayWidth = safeWcwidth c * (fromIntegral w)

156− charWidth = fromIntegral w

182+-- | Make an image filling a region with the specified character.

183+--

184+-- If either the width or height are less than or equal to 0, then

185+-- the result is the empty image.

186+charFill :: Integral d

187+ => Attr

188+ -- ^ The attribute to use.

189+ -> Char

190+ -- ^ The character to use in filling the region.

191+ -> d

192+ -- ^ The region width.

193+ -> d

194+ -- ^ The region height.

195+ -> Image

196+charFill a c w h

197+ | w <= 0 || h <= 0 = EmptyImage

198+ | otherwise = vertCat

199+ $ replicate (fromIntegral h)

200+ $ HorizText a txt displayWidth charWidth

201+ where

202+ txt = TL.replicate charWidth (TL.singleton c)

203+ displayWidth = safeWcwidth c * charWidth

204+

205+ charWidth :: Num a => a

206+ charWidth = fromIntegral w

157207

158208-- | The empty image. Useful for fold combinators. These occupy no space

159−-- nor define any display attributes.

209+-- and do not affect display attributes.

160210emptyImage :: Image

161211emptyImage = EmptyImage

162212

163213-- | Pad the given image. This adds background character fills to the

164−-- left, top, right, bottom. The pad values are how many display columns

165−-- or rows to add.

166−pad :: Int -> Int -> Int -> Int -> Image -> Image

214+-- left, top, right, bottom.

215+pad :: Int

216+ -- ^ How much padding to add to the left side of the image.

217+ -> Int

218+ -- ^ How much padding to add to the top of the image.

219+ -> Int

220+ -- ^ How much padding to add to the right side of the image.

221+ -> Int

222+ -- ^ How much padding to add to the bottom of the image.

223+ -> Image

224+ -- ^ The image to pad.

225+ -> Image

167226pad 0 0 0 0 i = i

168227pad inL inT inR inB inImage

169228 | inL < 0 || inT < 0 || inR < 0 || inB < 0 = error "cannot pad by negative amount"

170229 | otherwise = go inL inT inR inB inImage

171230 where

172− -- TODO: uh.

173231 go 0 0 0 0 i = i

174232 go 0 0 0 b i = VertJoin i (BGFill w b) w h

175233 where w = imageWidth i

@@ -185,24 +243,29 @@ pad inL inT inR inB inImage

185243 h = imageHeight i

186244

187245-- | Translates an image by padding or cropping the left and top.

188−-- First param is amount to translate left. Second param is amount to

189−-- translate top.

190246--

191−-- This can have an unexpected effect: Translating an image to less than

192−-- (0,0) then to greater than (0,0) will crop the image.

193−translate :: Int -> Int -> Image -> Image

247+-- If translation offsets are negative then the image is cropped.

248+translate :: Int

249+ -- ^ The horizontal translation offset (can be negative)

250+ -> Int

251+ -- ^ The vertical translation offset (can be negative)

252+ -> Image

253+ -- ^ The image to translate.

254+ -> Image

194255translate x y i = translateX x (translateY y i)

195256

196−-- | translates an image by padding or cropping the left

257+-- | Translates an image by padding or cropping its left side.

197258translateX :: Int -> Image -> Image

198259translateX x i

260+ | x < 0 && (abs x > imageWidth i) = emptyImage

199261 | x < 0 = let s = abs x in CropLeft i s (imageWidth i - s) (imageHeight i)

200262 | x == 0 = i

201263 | otherwise = let h = imageHeight i in HorizJoin (BGFill x h) i (imageWidth i + x) h

202264

203−-- | translates an image by padding or cropping the top

265+-- | Translates an image by padding or cropping its top.

204266translateY :: Int -> Image -> Image

205267translateY y i

268+ | y < 0 && (abs y > imageHeight i) = emptyImage

206269 | y < 0 = let s = abs y in CropTop i s (imageWidth i) (imageHeight i - s)

207270 | y == 0 = i

208271 | otherwise = let w = imageWidth i in VertJoin (BGFill w y) i w (imageHeight i + y)

@@ -210,16 +273,22 @@ translateY y i

210273-- | Ensure an image is no larger than the provided size. If the image

211274-- is larger then crop the right or bottom.

212275--

213−-- This is transformed to a vertical crop from the bottom followed by

276+-- This is equivalent to a vertical crop from the bottom followed by

214277-- horizontal crop from the right.

215−crop :: Int -> Int -> Image -> Image

278+crop :: Int

279+ -- ^ Cropping width

280+ -> Int

281+ -- ^ Cropping height

282+ -> Image

283+ -- ^ The image to crop

284+ -> Image

216285crop 0 _ _ = EmptyImage

217286crop _ 0 _ = EmptyImage

218287crop w h i = cropBottom h (cropRight w i)

219288

220−-- | crop the display height. If the image is less than or equal in

221−-- height then this operation has no effect. Otherwise the image is

222−-- cropped from the bottom.

289+-- | Crop an image's height. If the image's height is less than or equal

290+-- to the specified height then this operation has no effect. Otherwise

291+-- the image is cropped from the bottom.

223292cropBottom :: Int -> Image -> Image

224293cropBottom 0 _ = EmptyImage

225294cropBottom h inI

@@ -234,8 +303,9 @@ cropBottom h inI

234303 | h >= imageHeight i = i

235304 | otherwise = CropBottom i (imageWidth i) h

236305

237−-- | ensure the image is no wider than the given width. If the image is

238−-- wider then crop the right side.

306+-- | Crop an image's width. If the image's width is less than or equal

307+-- to the specified width then this operation has no effect. Otherwise

308+-- the image is cropped from the right.

239309cropRight :: Int -> Image -> Image

240310cropRight 0 _ = EmptyImage

241311cropRight w inI

@@ -250,8 +320,9 @@ cropRight w inI

250320 | w >= imageWidth i = i

251321 | otherwise = CropRight i w (imageHeight i)

252322

253−-- | ensure the image is no wider than the given width. If the image is

254−-- wider then crop the left side.

323+-- | Crop an image's width. If the image's width is less than or equal

324+-- to the specified width then this operation has no effect. Otherwise

325+-- the image is cropped from the left.

255326cropLeft :: Int -> Image -> Image

256327cropLeft 0 _ = EmptyImage

257328cropLeft w inI

@@ -268,9 +339,9 @@ cropLeft w inI

268339 | imageWidth i <= w = i

269340 | otherwise = CropLeft i (imageWidth i - w) w (imageHeight i)

270341

271−-- | crop the display height. If the image is less than or equal in

272−-- height then this operation has no effect. Otherwise the image is

273−-- cropped from the top.

342+-- | Crop an image's height. If the image's height is less than or equal

343+-- to the specified height then this operation has no effect. Otherwise

344+-- the image is cropped from the top.

274345cropTop :: Int -> Image -> Image

275346cropTop 0 _ = EmptyImage

276347cropTop h inI

@@ -287,14 +358,14 @@ cropTop h inI

287358 | imageHeight i <= h = i

288359 | otherwise = CropTop i (imageHeight i - h) (imageWidth i) h

289360

290−-- | Generic resize. Pads and crops as required to assure the given

291−-- display width and height. This is biased to pad/crop the right and

292−-- bottom.

361+-- | Generic resize. Pads and crops are added to ensure that the

362+-- resulting image matches the specified dimensions. This is biased to

363+-- pad/crop the right and bottom.

293364resize :: Int -> Int -> Image -> Image

294365resize w h i = resizeHeight h (resizeWidth w i)

295366

296367-- | Resize the width. Pads and crops as required to assure the given

297−-- display width. This is biased to pad/crop the right.

368+-- display width. This is biased to pad/crop on the right.

298369resizeWidth :: Int -> Image -> Image

299370resizeWidth w i = case w `compare` imageWidth i of

300371 LT -> cropRight w i

@@ -302,7 +373,7 @@ resizeWidth w i = case w `compare` imageWidth i of

302373 GT -> i <|> BGFill (w - imageWidth i) (imageHeight i)

303374

304375-- | Resize the height. Pads and crops as required to assure the given

305−-- display height. This is biased to pad/crop the bottom.

376+-- display height. This is biased to pad/crop on the bottom.

306377resizeHeight :: Int -> Image -> Image

307378resizeHeight h i = case h `compare` imageHeight i of

308379 LT -> cropBottom h i

src/Graphics/Vty/Image/Internal.hs+16−55

@@ -3,10 +3,6 @@

33{-# LANGUAGE DeriveGeneric #-}

44{-# OPTIONS_HADDOCK hide #-}

55

6−#ifndef MIN_VERSION_base

7−#defined MIN_VERSION_base(x,y,z) 1

8−#endif

9−

106module Graphics.Vty.Image.Internal where

117

128import Graphics.Vty.Attributes

@@ -16,25 +12,14 @@ import GHC.Generics

1612

1713import Control.DeepSeq

1814

19−import qualified Data.Text.Lazy as TL

20−

21−#if !(MIN_VERSION_base(4,8,0))

22−import Data.Monoid

15+#if !(MIN_VERSION_base(4,11,0))

16+import Data.Semigroup (Semigroup(..))

2317#endif

18+import qualified Data.Text.Lazy as TL

2419

2520-- | A display text is a Data.Text.Lazy

26−--

27−-- TODO(corey): hm. there is an explicit equation for each type which

28−-- goes to a lazy text. Each application probably uses a single type.

29−-- Perhaps parameterize the entire vty interface by the input text type?

30−-- TODO: Try using a builder instead of a TL.Text instance directly.

31−-- That might improve performance for the usual case of appending a

32−-- bunch of characters with the same attribute together.

3321type DisplayText = TL.Text

3422

35−-- TODO: store a skip list in HorizText(?)

36−-- TODO: represent display strings containing chars that are not 1

37−-- column chars as a separate display string value?

3823clipText :: DisplayText -> Int -> Int -> DisplayText

3924clipText txt leftSkip rightClip =

4025 -- CPS would clarify this I think

@@ -157,37 +142,11 @@ data Image =

157142 --

158143 -- Any image of zero size equals the empty image.

159144 | EmptyImage

160− deriving (Eq, Generic)

161−

162−instance Show Image where

163− show ( HorizText { attr, displayText, outputWidth, charWidth } )

164− = "HorizText " ++ show displayText

165− ++ "@(" ++ show attr ++ ","

166− ++ show outputWidth ++ ","

167− ++ show charWidth ++ ")"

168− show ( BGFill { outputWidth, outputHeight } )

169− = "BGFill (" ++ show outputWidth ++ "," ++ show outputHeight ++ ")"

170− show ( HorizJoin { partLeft = l, partRight = r, outputWidth = c } )

171− = "HorizJoin " ++ show c ++ " (" ++ show l ++ " <|> " ++ show r ++ ")"

172− show ( VertJoin { partTop = t, partBottom = b, outputWidth = c, outputHeight = r } )

173− = "VertJoin [" ++ show c ++ ", " ++ show r ++ "] (" ++ show t ++ ") <-> (" ++ show b ++ ")"

174− show ( CropRight { croppedImage, outputWidth, outputHeight } )

175− = "CropRight [" ++ show outputWidth ++ "," ++ show outputHeight ++ "]"

176− ++ " (" ++ show croppedImage ++ ")"

177− show ( CropLeft { croppedImage, leftSkip, outputWidth, outputHeight } )

178− = "CropLeft [" ++ show leftSkip ++ "," ++ show outputWidth ++ "," ++ show outputHeight ++ "]"

179− ++ " (" ++ show croppedImage ++ ")"

180− show ( CropBottom { croppedImage, outputWidth, outputHeight } )

181− = "CropBottom [" ++ show outputWidth ++ "," ++ show outputHeight ++ "]"

182− ++ " (" ++ show croppedImage ++ ")"

183− show ( CropTop { croppedImage, topSkip, outputWidth, outputHeight } )

184− = "CropTop [" ++ show topSkip ++ "," ++ show outputWidth ++ "," ++ show outputHeight ++ "]"

185− ++ " (" ++ show croppedImage ++ ")"

186− show ( EmptyImage ) = "EmptyImage"

145+ deriving (Eq, Generic, Show, Read)

187146

188147-- | pretty print just the structure of an image.

189148ppImageStructure :: Image -> String

190−ppImageStructure inImg = go 0 inImg

149+ppImageStructure = go 0

191150 where

192151 go indent img = tab indent ++ pp indent img

193152 tab indent = concat $ replicate indent " "

@@ -251,10 +210,16 @@ imageHeight CropBottom { outputHeight = h } = h

251210imageHeight CropTop { outputHeight = h } = h

252211imageHeight EmptyImage = 0

253212

254−-- | Append in the Monoid instance is equivalent to <->.

213+-- | Append in the 'Semigroup' instance is equivalent to '<->'.

214+instance Semigroup Image where

215+ (<>) = vertJoin

216+

217+-- | Append in the 'Monoid' instance is equivalent to '<->'.

255218instance Monoid Image where

256219 mempty = EmptyImage

257− mappend = vertJoin

220+#if !(MIN_VERSION_base(4,11,0))

221+ mappend = (<>)

222+#endif

258223

259224-- | combines two images side by side

260225--

@@ -263,16 +228,14 @@ instance Monoid Image where

263228--

264229-- The result image will have a width equal to the sum of the two images

265230-- width. And the height will equal the largest height of the two

266−-- images. The area not defined in one image due to a height missmatch

231+-- images. The area not defined in one image due to a height mismatch

267232-- will be filled with the background pattern.

268−--

269−-- TODO: the bg fill is biased towards top to bottom languages(?)

270233horizJoin :: Image -> Image -> Image

271234horizJoin EmptyImage i = i

272235horizJoin i EmptyImage = i

273236horizJoin i0@(HorizText a0 t0 w0 cw0) i1@(HorizText a1 t1 w1 cw1)

274237 | a0 == a1 = HorizText a0 (TL.append t0 t1) (w0 + w1) (cw0 + cw1)

275− -- TODO: assumes horiz text height is always 1

238+ -- assumes horiz text height is always 1

276239 | otherwise = HorizJoin i0 i1 (w0 + w1) 1

277240horizJoin i0 i1

278241 -- If the images are of the same height then no padding is required

@@ -296,10 +259,8 @@ horizJoin _ _ = error "horizJoin applied to undefined values."

296259--

297260-- The result image will have a height equal to the sum of the heights

298261-- of both images. The width will equal the largest width of the two

299−-- images. The area not defined in one image due to a width missmatch

262+-- images. The area not defined in one image due to a width mismatch

300263-- will be filled with the background pattern.

301−--

302−-- TODO: the bg fill is biased towards right to left languages(?)

303264vertJoin :: Image -> Image -> Image

304265vertJoin EmptyImage i = i

305266vertJoin i EmptyImage = i

src/Graphics/Vty/Inline.hs+47−47

@@ -3,10 +3,10 @@

33-- used inline with other output systems.

44--

55-- The changes specified by the InlineM monad are applied to the

6−-- terminals display attributes. These display attributes effect the

6+-- terminal's display attributes. These display attributes affect the

77-- display of all following text output to the terminal file descriptor.

88--

9−-- For example, in an IO monad the following code with print the text

9+-- For example, in an IO monad the following code will print the text

1010-- \"Not styled. \" Followed by the text \" Styled! \" drawn over a red

1111-- background and underlined.

1212--

@@ -20,29 +20,22 @@

2020-- putStrLn \"Not styled.\"

2121-- @

2222--

23−-- 'putAttrChange' outputs the control codes to the terminal device

24−-- 'Handle'. This is a duplicate of the 'stdout' handle when the

25−-- 'terminalHandle' was (first) acquired. If 'stdout' has since been

26−-- changed then 'putStr', 'putStrLn', 'print' etc.. will output to a

27−-- different 'Handle' than 'putAttrChange'

23+-- 'putAttrChange' emits the control codes to the terminal device

24+-- attached to 'Handle'. This is a duplicate of the 'stdout' handle when

25+-- the 'terminalHandle' was (first) acquired. If 'stdout' has since been

26+-- changed then 'putStr', 'putStrLn', 'print' etc. will output to a

27+-- different 'Handle' than 'putAttrChange'.

2828--

30−{-# LANGUAGE CPP #-}

31−{-# LANGUAGE BangPatterns #-}

32−

33−#ifndef MIN_VERSION_base

34−#defined MIN_VERSION_base(x,y,z) 1

35−#endif

36−

37−module Graphics.Vty.Inline ( module Graphics.Vty.Inline

38− , withVty

39− )

40− where

30+module Graphics.Vty.Inline

31+ ( module Graphics.Vty.Inline

32+ , withVty

33+ )

34+where

4135

4236import Graphics.Vty

4337import Graphics.Vty.DisplayAttributes

4438import Graphics.Vty.Inline.Unsafe

45−import Graphics.Vty.Output.Interface

4639

4740import Blaze.ByteString.Builder (writeToByteString)

4841

@@ -53,44 +46,52 @@ import Data.IORef

5346

5447import System.IO

5548

56−#if !(MIN_VERSION_base(4,8,0))

57−import Control.Applicative

58−import Data.Monoid ( mappend )

59−#endif

49+type InlineM v = State InlineState v

6050

61−type InlineM v = State Attr v

51+data InlineState =

52+ InlineState { inlineAttr :: Attr

53+ , inlineUrlsEnabled :: Bool

54+ }

6255

63−-- | Set the background color to the provided 'Color'

56+-- | Set the background color to the provided 'Color'.

6457backColor :: Color -> InlineM ()

65−backColor c = modify $ flip mappend ( currentAttr `withBackColor` c )

58+backColor c = modify $ \s ->

59+ s { inlineAttr = inlineAttr s `withBackColor` c

60+ }

6661

67−-- | Set the foreground color to the provided 'Color'

62+-- | Set the foreground color to the provided 'Color'.

6863foreColor :: Color -> InlineM ()

69−foreColor c = modify $ flip mappend ( currentAttr `withForeColor` c )

64+foreColor c = modify $ \s ->

65+ s { inlineAttr = inlineAttr s `withForeColor` c

66+ }

7067

71−-- | Attempt to change the 'Style' of the following text.

68+-- | Attempt to change the 'Style' of the following text..

7269--

73−-- If the terminal does not support the style change no error is

70+-- If the terminal does not support the style change then no error is

7471-- produced. The style can still be removed.

7572applyStyle :: Style -> InlineM ()

76−applyStyle s = modify $ flip mappend ( currentAttr `withStyle` s )

73+applyStyle st = modify $ \s ->

74+ s { inlineAttr = inlineAttr s `withStyle` st

75+ }

7776

7877-- | Attempt to remove the specified 'Style' from the display of the

7978-- following text.

8079--

81−-- This will fail if applyStyle for the given style has not been

80+-- This will fail if 'applyStyle' for the given style has not been

8281-- previously called.

8382removeStyle :: Style -> InlineM ()

84−removeStyle sMask = modify $ \attr ->

85− let style' = case attrStyle attr 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− SetTo s -> s .&. complement sMask

89− in attr { attrStyle = SetTo style' }

90−

91−-- | Reset the display attributes

83+removeStyle sMask = modify $ \s ->

84+ s { inlineAttr =

85+ 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+ SetTo st -> st .&. complement sMask

89+ in (inlineAttr s) { attrStyle = SetTo style' }

90+ }

91+

92+-- | Reset the display attributes.

9293defaultAll :: InlineM ()

93−defaultAll = put defAttr

94+defaultAll = modify $ \s -> s { inlineAttr = defAttr }

9495

9596-- | Apply the provided display attribute changes to the given terminal

9697-- output device.

@@ -103,20 +104,19 @@ putAttrChange out c = liftIO $ do

103104 mfattr <- prevFattr <$> readIORef (assumedStateRef out)

104105 fattr <- case mfattr of

105106 Nothing -> do

106− liftIO $ outputByteBuffer out $ writeToByteString $ writeDefaultAttr dc

107− return $ FixedAttr defaultStyleMask Nothing Nothing

107+ liftIO $ outputByteBuffer out $ writeToByteString $ writeDefaultAttr dc False

108+ return $ FixedAttr defaultStyleMask Nothing Nothing Nothing

108109 Just v -> return v

109− let attr = execState c currentAttr

110+ let InlineState attr urlsEnabled = execState c (InlineState currentAttr False)

110111 attr' = limitAttrForDisplay out attr

111112 fattr' = fixDisplayAttr fattr attr'

112113 diffs = displayAttrDiffs fattr fattr'

113− outputByteBuffer out $ writeToByteString $ writeSetAttr dc fattr attr' diffs

114+ outputByteBuffer out $ writeToByteString $ writeSetAttr dc urlsEnabled fattr attr' diffs

114115 modifyIORef (assumedStateRef out) $ \s -> s { prevFattr = Just fattr' }

115116 inlineHack dc

116117

117118-- | Apply the provided display attributes changes to the terminal

118−-- output device that was current at the time this was first used.

119−-- Which, for most use cases, is the current terminal.

119+-- output device.

120120--

121121-- This will flush the terminal output.

122122putAttrChange_ :: ( Applicative m, MonadIO m ) => InlineM () -> m ()

src/Graphics/Vty/Inline/Unsafe.hs+1−12

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

1−{-# LANGUAGE CPP #-}

21{-# OPTIONS_HADDOCK hide #-}

32

4−#ifndef MIN_VERSION_base

5−#defined MIN_VERSION_base(x,y,z) 1

6−#endif

7−

83module Graphics.Vty.Inline.Unsafe where

94

105import Graphics.Vty

116

12−import Data.Default

13−import Data.Monoid

147import Data.IORef

158

169import GHC.IO.Handle (hDuplicate)

@@ -21,10 +14,6 @@ import System.IO.Unsafe

2114

2215import System.Posix.IO (handleToFd)

2316

24−#if !(MIN_VERSION_base(4,8,0))

25−import Control.Applicative

26−#endif

27−

2817globalVty :: IORef (Maybe Vty)

2918{-# NOINLINE globalVty #-}

3019globalVty = unsafePerformIO $ newIORef Nothing

@@ -39,7 +28,7 @@ mkDupeConfig = do

3928 hSetBuffering stdin NoBuffering

4029 stdinDupe <- hDuplicate stdin >>= handleToFd

4130 stdoutDupe <- hDuplicate stdout >>= handleToFd

42− return $ def { inputFd = Just stdinDupe, outputFd = Just stdoutDupe }

31+ return $ defaultConfig { inputFd = Just stdinDupe, outputFd = Just stdoutDupe }

4332

4433-- | This will create a Vty instance using 'mkVty' and execute an IO

4534-- action provided that instance. The created Vty instance will be

src/Graphics/Vty/Input.hs+76−131

@@ -1,155 +1,125 @@

1−{-# LANGUAGE CPP #-}

2−{-# LANGUAGE RecordWildCards #-}

1+{-# LANGUAGE RecordWildCards, CPP #-}

32

4−#ifndef MIN_VERSION_base

5−#defined MIN_VERSION_base(x,y,z) 1

6−#endif

7−

8−-- | The input layer for VTY. This provides methods for initializing an

9−-- 'Input' structure which can then be used to read 'Event's from the

3+-- | This module provides the input layer for Vty, including methods

4+-- for initializing an 'Input' structure and reading 'Event's from the

105-- terminal.

116--

12−-- The history of terminals has resulted in a broken input process. Some

13−-- keys and combinations will not reliably map to the expected events

14−-- by any terminal program. Even those not using vty. There is no 1:1

15−-- mapping from key events to bytes read from the terminal input device.

16−-- In very limited cases the terminal and vty's input process can be

17−-- customized to resolve these issues.

18−--

19−-- See "Graphics.Vty.Config" for how to configure vty's input

20−-- processing. Customizing terminfo and the terminal is beyond the scope

21−-- of this documentation.

7+-- Note that due to the evolution of terminal emulators, some keys

8+-- and combinations will not reliably map to the expected events by

9+-- any terminal program. There is no 1:1 mapping from key events to

10+-- bytes read from the terminal input device. In very limited cases the

11+-- terminal and vty's input process can be customized to resolve these

12+-- issues; see "Graphics.Vty.Config" for how to configure vty's input

13+-- processing.

2214--

2315-- = VTY's Implementation

2416--

2517-- There are two input modes:

2618--

27−-- 1. 7 bit

19+-- 1. 7-bit

2820--

29−-- 2. 8 bit

21+-- 2. 8-bit

3022--

31−-- 7 bit input is the default and the expected in most use cases. This

32−-- is what vty uses.

23+-- The 7-bit input mode is the default and the expected mode in most use

24+-- cases. This is what Vty uses.

3325--

34−-- == 7 bit input encoding

26+-- == 7-bit input encoding

3527--

3628-- Control key combinations are represented by masking the two high bits

37−-- of the 7bit input. Back in the day the control key actually grounded

38−-- the two high bit wires: 6 and 7. This is why control key combos map

39−-- to single character events: The input bytes are identical. The input

40−-- byte is the bit encoding of the character with bits 6 and 7 masked.

41−-- Bit 6 is set by shift. Bit 6 and 7 are masked by control. EG:

29+-- of the 7-bit input. Historically the control key actually grounded

30+-- the two high bit wires: 6 and 7. This is why control key combos

31+-- map to single character events: the input bytes are identical. The

32+-- input byte is the bit encoding of the character with bits 6 and 7

33+-- masked. Bit 6 is set by shift. Bit 6 and 7 are masked by control. For

34+-- example,

4235--

43−-- * Control-I is 'i', `01101001`, has bit 6 and 7 masked to become

44−-- `00001001`. Which is the ASCII and UTF-8 encoding of the tab key.

36+-- * Control-I is 'i', `01101001`, and has bit 6 and 7 masked to become

37+-- `00001001`, which is the ASCII and UTF-8 encoding of the Tab key.

4538--

4639-- * Control+Shift-C is 'C', `01000011`, with bit 6 and 7 set to zero

47−-- which makes `0000011` and is the "End of Text" code.

40+-- which is `0000011` and is the "End of Text" code.

4841--

49−-- * Hypothesis: This is why capital-A, 'A', has value 65 in ASCII: This

42+-- * Hypothesis: This is why capital-A, 'A', has value 65 in ASCII: this

5043-- is the value 1 with bit 7 set and 6 unset.

5144--

5245-- * Hypothesis: Bit 6 is unset by upper case letters because,

5346-- initially, there were only upper case letters used and a 5 bit

5447-- encoding.

5548--

56−-- == 8 bit encoding

49+-- == 8-bit encoding

5750--

58−-- The 8th bit was originally used for parity checking. Useless for

59−-- emulators. Some terminal emulators support a 8 bit input encoding.

60−-- While this provides some advantages the actual usage is low. Most

61−-- systems use 7bit mode but recognize 8bit control characters when

62−-- escaped. This is what vty does.

51+-- The 8th bit was originally used for parity checking which is useless

52+-- for terminal emulators. Some terminal emulators support an 8-bit

53+-- input encoding. While this provides some advantages, the actual usage

54+-- is low. Most systems use 7-bit mode but recognize 8-bit control

55+-- characters when escaped. This is what Vty does.

6356--

6457-- == Escaped Control Keys

6558--

66−-- Using 7 bit input encoding the @ESC@ byte can signal the start of

67−-- an encoded control key. To differentiate a single @ESC@ eventfrom a

68−-- control key the timing of the input is used.

59+-- Using 7-bit input encoding, the @ESC@ byte can signal the start of

60+-- an encoded control key. To differentiate a single @ESC@ event from a

61+-- control key, the timing of the input is used.

6962--

70−-- 1. @ESC@ individually: @ESC@ byte; no bytes for 'singleEscPeriod'.

63+-- 1. @ESC@ individually: @ESC@ byte; no bytes following for a period of

64+-- 'VMIN' milliseconds.

7165--

72−-- 2. control keys that contain @ESC@ in their encoding: The @ESC byte;

73−-- followed by more bytes read within 'singleEscPeriod'. All bytes up

74−-- until the next valid input block are passed to the classifier.

66+-- 2. Control keys that contain @ESC@ in their encoding: The @ESC byte

67+-- is followed by more bytes read within 'VMIN' milliseconds. All bytes

68+-- up until the next valid input block are passed to the classifier.

7569--

7670-- If the current runtime is the threaded runtime then the terminal's

7771-- @VMIN@ and @VTIME@ behavior reliably implement the above rules. If

78−-- the current runtime does not support forkOS then there is currently

72+-- the current runtime does not support 'forkOS' then there is currently

7973-- no implementation.

8074--

81−-- Vty used to emulate @VMIN@ and @VTIME@. This was a input loop

82−-- which did tricky things with non-blocking reads and timers. The

83−-- implementation was not reliable. A reliable implementation is

84−-- possible, but there are no plans to implement this.

85−--

8675-- == Unicode Input and Escaped Control Key Sequences

8776--

8877-- The input encoding determines how UTF-8 encoded characters are

89−-- recognize.

78+-- recognized.

9079--

91−-- * 7 bit mode: UTF-8 can be input unambiguiously. UTF-8 input is

80+-- * 7-bit mode: UTF-8 can be input unambiguously. UTF-8 input is

9281-- a superset of ASCII. UTF-8 does not overlap escaped control key

9382-- sequences. However, the escape key must be differentiated from

9483-- escaped control key sequences by the timing of the input bytes.

9584--

96−-- * 8 bit mode: UTF-8 cannot be input unambiguously. This does not

85+-- * 8-bit mode: UTF-8 cannot be input unambiguously. This does not

9786-- require using the timing of input bytes to differentiate the escape

98−-- key. Many terminals do not support 8 bit mode.

87+-- key. Many terminals do not support 8-bit mode.

9988--

10089-- == Terminfo

10190--

10291-- The terminfo system is used to determine how some keys are encoded.

103−-- Terminfo is incomplete. In some cases terminfo is incorrect. Vty

92+-- Terminfo is incomplete and in some cases terminfo is incorrect. Vty

10493-- assumes terminfo is correct but provides a mechanism to override

105−-- terminfo. See "Graphics.Vty.Config" specifically 'inputOverrides'.

94+-- terminfo; see "Graphics.Vty.Config", specifically 'inputOverrides'.

10695--

10796-- == Terminal Input is Broken

10897--

109−-- Clearly terminal input has fundemental issues. There is no easy way

98+-- Clearly terminal input has fundamental issues. There is no easy way

11099-- to reliably resolve these issues.

111100--

112101-- One resolution would be to ditch standard terminal interfaces

113−-- entirely and just go directly to scancodes. A reasonable option for

114−-- vty if everybody used the linux kernel console. I hear GUIs are

115−-- popular these days. Sadly, GUI terminal emulators don't provide

116−-- access to scancodes AFAIK.

117−--

118−-- All is lost? Not really. "Graphics.Vty.Config" supports customizing

119−-- the input byte to event mapping and xterm supports customizing the

120−-- scancode to input byte mapping. With a lot of work a user's system

121−-- can be set up to encode all the key combos in an almost-sane manner.

102+-- entirely and just go directly to scancodes. This would be a

103+-- reasonable option for Vty if everybody used the linux kernel console

104+-- but for obvious reasons this is not possible.

122105--

123−-- There are other tricky work arounds that can be done. I have no

124−-- interest in implementing most of these. They are not really worth the

125−-- time.

126−--

127−-- == Terminal Output is Also Broken

128−--

129−-- This isn't the only odd aspect of terminals due to historical

130−-- aspects that no longer apply. EG: Some terminfo capabilities specify

131−-- millisecond delays. (Capabilities are how terminfo describes the

132−-- control sequence to output red, for instance) This is to account for

133−-- the slow speed of hardcopy teletype interfaces. Cause, uh, we totally

134−-- still use those.

135−--

136−-- The output encoding of colors and attributes are also rife with

137−-- issues.

106+-- The "Graphics.Vty.Config" module supports customizing the

107+-- input-byte-to-event mapping and xterm supports customizing the

108+-- scancode-to-input-byte mapping. With a lot of work a user's system

109+-- can be set up to encode all the key combos in an almost-sane manner.

138110--

139111-- == See also

140112--

141113-- * http://www.leonerd.org.uk/hacks/fixterms/

142−--

143−-- In my experience this cannot resolve the issues without changes to

144−-- the terminal emulator and device.

145−module Graphics.Vty.Input ( Key(..)

146− , Modifier(..)

147− , Button(..)

148− , Event(..)

149− , Input(..)

150− , inputForConfig

151− )

152− where

114+module Graphics.Vty.Input

115+ ( Key(..)

116+ , Modifier(..)

117+ , Button(..)

118+ , Event(..)

119+ , Input(..)

120+ , inputForConfig

121+ )

122+where

153123

154124import Graphics.Vty.Config

155125import Graphics.Vty.Input.Events

@@ -162,47 +132,19 @@ import Lens.Micro

162132import qualified System.Console.Terminfo as Terminfo

163133import System.Posix.Signals.Exts

164134

165−#if !(MIN_VERSION_base(4,8,0))

166−import Data.Functor ((<$>))

167−import Data.Monoid

168−#else

135+#if !MIN_VERSION_base(4,11,0)

169136import Data.Monoid ((<>))

170137#endif

171138

172139-- | Set up the terminal with file descriptor `inputFd` for input.

173−-- Returns a 'Input'.

140+-- Returns an 'Input'.

174141--

175142-- The table used to determine the 'Events' to produce for the input

176−-- bytes comes from 'classifyMapForTerm'. Which is then overridden by

177−-- the the applicable entries from 'inputMap'.

178−--

179−-- The terminal device is configured with the attributes:

180−--

181−-- * IXON disabled

182−-- - disables software flow control on outgoing data. This stops

183−-- the process from being suspended if the output terminal cannot

184−-- keep up. I presume this has little effect these days. I hope

185−-- this means that output will be buffered if the terminal cannot

186−-- keep up. In the old days the output might of been dropped?

187−--

188−-- "raw" mode is used for input.

189−--

190−-- * ISIG disabled

191−-- - enables keyboard combinations that result in signals. TODO:

192−-- should probably be a dynamic option.

193−--

194−-- * ECHO disabled

195−-- - input is not echod to the output. TODO: should be a

196−-- dynamic option.

197−--

198−-- * ICANON disabled

199−-- - canonical mode (line mode) input is not used. TODO: should

200−-- be a dynamic option.

201−--

202−-- * IEXTEN disabled

203−-- - extended functions are disabled. TODO: I don't know what

204−-- those are.

143+-- bytes comes from 'classifyMapForTerm' which is then overridden by

144+-- the the applicable entries from the configuration's 'inputMap'.

205145--

146+-- The terminal device's mode flags are configured by the

147+-- 'attributeControl' function.

206148inputForConfig :: Config -> IO Input

207149inputForConfig config@Config{ termName = Just termName

208150 , inputFd = Just termFd

@@ -212,20 +154,23 @@ inputForConfig config@Config{ termName = Just termName

212154 terminal <- Terminfo.setupTerm termName

213155 let inputOverrides = [(s,e) | (t,s,e) <- inputMap, t == Nothing || t == Just termName]

214156 activeInputMap = classifyMapForTerm termName terminal `mappend` inputOverrides

215− (setAttrs,unsetAttrs) <- attributeControl termFd

157+ (setAttrs, unsetAttrs) <- attributeControl termFd

216158 setAttrs

217159 input <- initInput config activeInputMap

218160 let pokeIO = Catch $ do

219− let e = error "vty internal failure: this value should not propagate to users"

220161 setAttrs

221− atomically $ writeTChan (input^.eventChannel) (EvResize e e)

162+ atomically $ writeTChan (input^.eventChannel) ResumeAfterSignal

222163 _ <- installHandler windowChange pokeIO Nothing

223164 _ <- installHandler continueProcess pokeIO Nothing

165+

166+ let restore = unsetAttrs

167+

224168 return $ input

225169 { shutdownInput = do

226170 shutdownInput input

227171 _ <- installHandler windowChange Ignore Nothing

228172 _ <- installHandler continueProcess Ignore Nothing

229− unsetAttrs

173+ restore

174+ , restoreInputState = restoreInputState input >> restore

230175 }

231176inputForConfig config = (<> config) <$> standardIOConfig >>= inputForConfig

src/Graphics/Vty/Input/Classify.hs+58−34

@@ -1,40 +1,55 @@

11{-# OPTIONS_HADDOCK hide #-}

2−-- This makes a kind of tri. Has space efficiency issues with large

2+-- This makes a kind of trie. Has space efficiency issues with large

33-- input blocks. Likely building a parser and just applying that would

44-- be better.

5−-- TODO: The ClassifyMap interface requires this code to always assure

6−-- later entries override earlier.

75module Graphics.Vty.Input.Classify

8− ( classify

9− , KClass(..)

10− ) where

6+ ( classify

7+ , KClass(..)

8+ , ClassifierState(..)

9+ )

10+where

1111

1212import Graphics.Vty.Input.Events

1313import Graphics.Vty.Input.Mouse

14+import Graphics.Vty.Input.Focus

1415import Graphics.Vty.Input.Paste

1516import Graphics.Vty.Input.Classify.Types

1617

1718import Codec.Binary.UTF8.Generic (decode)

1819

19−import Data.List (inits)

20+import Control.Arrow (first)

2021import qualified Data.Map as M( fromList, lookup )

2122import Data.Maybe ( mapMaybe )

2223import qualified Data.Set as S( fromList, member )

2324

24−import Data.Char

2525import Data.Word

2626

27−compile :: ClassifyMap -> [Char] -> KClass

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

2843compile table = cl' where

2944 -- take all prefixes and create a set of these

30− prefixSet = S.fromList $ concatMap (init . inits . fst) $ table

45+ prefixSet = S.fromList $ concatMap (init . BS.inits . BS8.pack . fst) table

3146 maxValidInputLength = maximum (map (length . fst) table)

32− eventForInput = M.fromList table

33− cl' [] = Prefix

47+ eventForInput = M.fromList $ map (first BS8.pack) table

48+ cl' inputBlock | BS8.null inputBlock = Prefix

3449 cl' inputBlock = case M.lookup inputBlock eventForInput of

3550 -- if the inputBlock is exactly what is expected for an

3651 -- event then consume the whole block and return the event

37− Just e -> Valid e []

52+ Just e -> Valid e BS8.empty

3853 Nothing -> case S.member inputBlock prefixSet of

3954 True -> Prefix

4055 -- look up progressively smaller tails of the input

@@ -45,40 +60,49 @@ compile table = cl' where

4560 -- H: There will always be one match. The prefixSet

4661 -- contains, by definition, all prefixes of an event.

4762 False ->

48− let inputPrefixes = reverse $ take maxValidInputLength $ tail $ inits inputBlock

63+ let inputPrefixes = reverse . take maxValidInputLength . tail . BS8.inits $ inputBlock

4964 in case mapMaybe (\s -> (,) s `fmap` M.lookup s eventForInput) inputPrefixes of

50− (s,e) : _ -> Valid e (drop (length s) inputBlock)

65+ (s,e) : _ -> Valid e (BS8.drop (BS8.length s) inputBlock)

5166 -- neither a prefix or a full event.

52− -- TODO: debug log

5367 [] -> Invalid

5468

55−classify :: ClassifyMap -> [Char] -> KClass

56−classify table =

57− let standardClassifier = compile table

58− in \s -> case s of

59− _ | bracketedPasteStarted s ->

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 =

6086 if bracketedPasteFinished s

61− then parseBracketedPaste s

62− else Prefix

63− _ | isMouseEvent s -> classifyMouseEvent s

64− c:cs | ord c >= 0xC2 -> classifyUtf8 c cs

65− _ -> standardClassifier s

87+ then parseBracketedPaste $ BS.concat $ p:reverse (s:ps)

88+ else Chunk

89+ process ClassifierInChunk{} _ = Invalid

6690

67−classifyUtf8 :: Char -> [Char] -> KClass

91+classifyUtf8 :: Word8 -> ByteString -> KClass

6892classifyUtf8 c cs =

69− let n = utf8Length (ord c)

70− (codepoint,rest) = splitAt n (c:cs)

93+ let n = utf8Length c

94+ (codepoint,rest) = BS8.splitAt (n - 1) cs

7195

7296 codepoint8 :: [Word8]

73− codepoint8 = map (fromIntegral . ord) codepoint

97+ codepoint8 = c:BS.unpack codepoint

7498

7599 in case decode codepoint8 of

76− _ | n < length codepoint -> Prefix

77− Just (unicodeChar, _) -> Valid (EvKey (KChar unicodeChar) []) rest

100+ _ | n < BS.length codepoint + 1 -> Prefix

101+ Just (unicodeChar, _) -> Valid (EvKey (KChar unicodeChar) []) rest

78102 -- something bad happened; just ignore and continue.

79− Nothing -> Invalid

103+ Nothing -> Invalid

80104

81−utf8Length :: (Num t, Ord a, Num a) => a -> t

105+utf8Length :: Word8 -> Int

82106utf8Length c

83107 | c < 0x80 = 1

84108 | c < 0xE0 = 2

src/Graphics/Vty/Input/Classify/Parse.hs+18−14

@@ -1,13 +1,14 @@

11-- | This module provides a simple parser for parsing input event

22-- control sequences.

33module Graphics.Vty.Input.Classify.Parse

4− ( Parser

5− , runParser

6− , failParse

7− , readInt

8− , readChar

9− , expectChar

10− ) where

4+ ( Parser

5+ , runParser

6+ , failParse

7+ , readInt

8+ , readChar

9+ , expectChar

10+ )

11+where

1112

1213import Graphics.Vty.Input.Events

1314import Graphics.Vty.Input.Classify.Types

@@ -15,12 +16,15 @@ import Graphics.Vty.Input.Classify.Types

1516import Control.Monad.Trans.Maybe

1617import Control.Monad.State

1718

18−type Parser a = MaybeT (State String) a

19+import qualified Data.ByteString.Char8 as BS8

20+import Data.ByteString.Char8 (ByteString)

21+

22+type Parser a = MaybeT (State ByteString) a

1923

2024-- | Run a parser on a given input string. If the parser fails, return

2125-- 'Invalid'. Otherwise return the valid event ('Valid') and the

2226-- remaining unparsed characters.

23−runParser :: String -> Parser Event -> KClass

27+runParser :: ByteString -> Parser Event -> KClass

2428runParser s parser =

2529 case runState (runMaybeT parser) s of

2630 (Nothing, _) -> Invalid

@@ -35,9 +39,9 @@ failParse = fail "invalid parse"

3539-- return '123' and consume those characters.

3640readInt :: Parser Int

3741readInt = do

38− s <- get

42+ s <- BS8.unpack <$> get

3943 case (reads :: ReadS Int) s of

40− [(i, rest)] -> put rest >> return i

44+ [(i, rest)] -> put (BS8.pack rest) >> return i

4145 _ -> failParse

4246

4347-- | Read a character from the input stream. If one cannot be read (e.g.

@@ -45,9 +49,9 @@ readInt = do

4549readChar :: Parser Char

4650readChar = do

4751 s <- get

48− case s of

49− c:rest -> put rest >> return c

50− _ -> failParse

52+ case BS8.uncons s of

53+ Just (c,rest) -> put rest >> return c

54+ Nothing -> failParse

5155

5256-- | Read a character from the input stream and fail parsing if it is

5357-- not the specified character.

src/Graphics/Vty/Input/Classify/Types.hs+10−3

@@ -1,13 +1,17 @@

11-- | This module exports the input classification type to avoid import

22-- cycles between other modules that need this.

3+{-# LANGUAGE StrictData #-}

34module Graphics.Vty.Input.Classify.Types

4− ( KClass(..)

5− ) where

5+ ( KClass(..)

6+ )

7+where

68

79import Graphics.Vty.Input.Events

810

11+import Data.ByteString.Char8 (ByteString)

12+

913data KClass

10− = Valid Event [Char]

14+ = Valid Event ByteString

1115 -- ^ A valid event was parsed. Any unused characters from the input

1216 -- stream are also provided.

1317 | Invalid

@@ -15,4 +19,7 @@ data KClass

1519 | Prefix

1620 -- ^ The input characters form the prefix of a valid event character

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

1825 deriving(Show, Eq)

src/Graphics/Vty/Input/Events.hs+29−7

@@ -1,6 +1,8 @@

11{-# Language DeriveGeneric #-}

2+{-# Language StrictData #-}

23module Graphics.Vty.Input.Events where

34

5+import Control.DeepSeq

46import Data.ByteString

57import GHC.Generics

68

@@ -14,23 +16,29 @@ import GHC.Generics

1416--

1517-- * Actually, support for most of these but KEsc, KChar, KBS, and

1618-- KEnter vary by terminal and keyboard.

17−data Key = KEsc | KChar Char | KBS | KEnter

19+data Key = KEsc | KChar {-# UNPACK #-} Char | KBS | KEnter

1820 | KLeft | KRight | KUp | KDown

22+ | KFun {-# UNPACK #-} Int | KBackTab | KPrtScr | KPause | KIns

2224 deriving (Eq,Show,Read,Ord,Generic)

2325

26+instance NFData Key

27+

2428-- | Modifier keys. Key codes are interpreted such that users are more

2529-- likely to have Meta than Alt; for instance on the PC Linux console,

2630-- 'MMeta' will generally correspond to the physical Alt key.

2731data Modifier = MShift | MCtrl | MMeta | MAlt

2832 deriving (Eq,Show,Read,Ord,Generic)

2933

34+instance NFData Modifier

35+

3036-- | Mouse buttons.

31−data Button = BLeft | BMiddle | BRight

37+data Button = BLeft | BMiddle | BRight | BScrollUp | BScrollDown

3238 deriving (Eq,Show,Read,Ord,Generic)

3339

40+instance NFData Button

41+

3442-- | Events.

3543data Event

3644 = EvKey Key [Modifier]

@@ -44,10 +52,8 @@ data Event

4452 -- without specifying which one; in that case, Nothing is provided.

4553 -- Otherwise Just the button released is included in the event.

4654 | EvResize Int Int

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.

55+ -- The terminal window was resized and the size is provided in the

56+ -- integer fields (width, height).

5157 | EvPaste ByteString

5258 -- ^ A paste event occurs when a bracketed paste input sequence is

5359 -- received. For terminals that support bracketed paste mode, these

@@ -56,6 +62,22 @@ data Event

5662 -- input (which is probably bad, so beware!) Note that the data is

5763 -- provided in raw form and you'll have to decode (e.g. as UTF-8) if

5864 -- that's what your application expects.

65+ | EvLostFocus

66+ -- ^ The terminal running the application lost input focus.

67+ | EvGainedFocus

68+ -- ^ The terminal running the application gained input focus.

5969 deriving (Eq,Show,Read,Ord,Generic)

6070

71+instance NFData Event

72+

6173type 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.hsnew file+49

@@ -0,0 +1,49 @@

1+module Graphics.Vty.Input.Focus

2+ ( requestFocusEvents

3+ , disableFocusEvents

4+ , isFocusEvent

5+ , classifyFocusEvent

6+ )

7+where

8+

9+import Graphics.Vty.Input.Events

10+import Graphics.Vty.Input.Classify.Types

11+import Graphics.Vty.Input.Classify.Parse

12+

13+import Control.Monad.State

14+

15+import qualified Data.ByteString.Char8 as BS8

16+import Data.ByteString.Char8 (ByteString)

17+

18+-- | These sequences set xterm-based terminals to send focus event

19+-- sequences.

20+requestFocusEvents :: ByteString

21+requestFocusEvents = BS8.pack "\ESC[?1004h"

22+

23+-- | These sequences disable focus events.

24+disableFocusEvents :: ByteString

25+disableFocusEvents = BS8.pack "\ESC[?1004l"

26+

27+-- | 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

31+

32+focusIn :: ByteString

33+focusIn = BS8.pack "\ESC[I"

34+

35+focusOut :: ByteString

36+focusOut = BS8.pack "\ESC[O"

37+

38+-- | Attempt to classify an input string as a focus event.

39+classifyFocusEvent :: ByteString -> KClass

40+classifyFocusEvent s = runParser s $ do

41+ when (not $ isFocusEvent s) failParse

42+

43+ expectChar '\ESC'

44+ expectChar '['

45+ ty <- readChar

46+ case ty of

47+ 'I' -> return EvGainedFocus

48+ 'O' -> return EvLostFocus

49+ _ -> failParse

src/Graphics/Vty/Input/Loop.hs+87−32

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

1−{-# LANGUAGE RecordWildCards #-}

2−{-# OPTIONS_HADDOCK hide #-}

1+{-# LANGUAGE CPP #-}

32{-# LANGUAGE NoMonomorphismRestriction #-}

3+{-# LANGUAGE RecordWildCards #-}

4+{-# LANGUAGE ScopedTypeVariables #-}

45{-# LANGUAGE TemplateHaskell #-}

5−{-# LANGUAGE CPP #-}

6+{-# OPTIONS_HADDOCK hide #-}

67-- | The input layer used to be a single function that correctly

78-- accounted for the non-threaded runtime by emulating the terminal

89-- VMIN adn VTIME handling. This has been removed and replace with a

@@ -24,8 +25,7 @@ import Control.Applicative

2425import Control.Concurrent

2526import Control.Concurrent.STM

2627import Control.Exception (mask, try, SomeException)

27−import Data.Monoid

28−import Lens.Micro

28+import Lens.Micro hiding ((<>~))

2929import Lens.Micro.Mtl

3030import Lens.Micro.TH

3131import Control.Monad (when, mzero, forM_)

@@ -34,12 +34,15 @@ import Control.Monad.Trans.State (StateT(..), evalStateT)

3434import Control.Monad.State.Class (MonadState, modify)

3535import Control.Monad.Trans.Reader (ReaderT(..))

3636

37−import Data.Char

37+import qualified Data.ByteString.Char8 as BS8

38+import qualified Data.ByteString as BS

39+import Data.ByteString.Char8 (ByteString)

3840import Data.IORef

3941import Data.Word (Word8)

4042

41−import Foreign ( allocaArray, peekArray, Ptr )

43+import Foreign (allocaArray)

4244import Foreign.C.Types (CInt(..))

45+import Foreign.Ptr (Ptr, castPtr)

4346

4447import System.IO

4548import System.Posix.IO (fdReadBuf, setFdOption, FdOption(..))

@@ -52,10 +55,15 @@ data Input = Input

5255 { -- | Channel of events direct from input processing. Unlike

5356 -- 'nextEvent' this will not refresh the display if the next event

5457 -- is an 'EvResize'.

55− _eventChannel :: TChan Event

56− -- | Shuts down the input processing. This should return the

57− -- terminal input state to before he input initialized.

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.

5861 , 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 ()

5967 -- | Changes to this value are reflected after the next event.

6068 , _configRef :: IORef Config

6169 -- | input debug log

@@ -72,10 +80,11 @@ data InputBuffer = InputBuffer

7280makeLenses ''InputBuffer

7381

7482data InputState = InputState

75− { _unprocessedBytes :: String

83+ { _unprocessedBytes :: ByteString

84+ , _classifierState :: ClassifierState

7685 , _appliedConfig :: Config

7786 , _inputBuffer :: InputBuffer

78− , _classifier :: String -> KClass

87+ , _classifier :: ClassifierState -> ByteString -> KClass

7988 }

8089

8190makeLenses ''InputState

@@ -100,21 +109,20 @@ loopInputProcessor = do

100109 dropInvalid

101110 loopInputProcessor

102111

103−addBytesToProcess :: String -> InputM ()

112+addBytesToProcess :: ByteString -> InputM ()

104113addBytesToProcess block = unprocessedBytes <>= block

105114

106115emit :: Event -> InputM ()

107116emit event = do

108117 logMsg $ "parsed event: " ++ show event

109− view eventChannel >>= liftIO . atomically . flip writeTChan event

118+ view eventChannel >>= liftIO . atomically . flip writeTChan (InputEvent event)

110119

111120-- The timing requirements are assured by the VMIN and VTIME set for the

112121-- device.

113122--

114123-- Precondition: Under the threaded runtime. Only current use is from a

115124-- forkOS thread. That case satisfies precondition.

116−-- TODO: When under the non-threaded runtime emulate VMIN and VTIME

117−readFromDevice :: InputM String

125+readFromDevice :: InputM ByteString

118126readFromDevice = do

119127 newConfig <- view configRef >>= liftIO . readIORef

120128 oldConfig <- use appliedConfig

@@ -134,9 +142,10 @@ readFromDevice = do

134142 threadWaitRead fd

135143 bytesRead <- fdReadBuf fd bufferPtr (fromIntegral maxBytes)

136144 if bytesRead > 0

137− then fmap (map $ chr . fromIntegral) $ peekArray (fromIntegral bytesRead) bufferPtr

138− else return []

139− when (not $ null stringRep) $ logMsg $ "input bytes: " ++ show stringRep

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)

140149 return stringRep

141150

142151applyConfig :: Fd -> Config -> IO ()

@@ -147,41 +156,86 @@ applyConfig _ _ = fail "(vty) applyConfig was not provided a complete configurat

147156parseEvent :: InputM Event

148157parseEvent = do

149158 c <- use classifier

159+ s <- use classifierState

150160 b <- use unprocessedBytes

151− case c b of

161+ case c s b of

152162 Valid e remaining -> do

153163 logMsg $ "valid parse: " ++ show e

154164 logMsg $ "remaining: " ++ show remaining

165+ classifierState .= ClassifierStart

155166 unprocessedBytes .= remaining

156167 return e

157− _ -> mzero

168+ _ -> mzero

158169

159170dropInvalid :: InputM ()

160171dropInvalid = do

161172 c <- use classifier

173+ s <- use classifierState

162174 b <- use unprocessedBytes

163− when (c b == Invalid) $ do

164− logMsg "dropping input bytes"

165− 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 ()

166187

167188runInputProcessorLoop :: ClassifyMap -> Input -> IO ()

168189runInputProcessorLoop classifyTable input = do

169190 let bufferSize = 1024

170191 allocaArray bufferSize $ \(bufferPtr :: Ptr Word8) -> do

171− s0 <- InputState [] <$> readIORef (_configRef input)

172− <*> pure (InputBuffer bufferPtr bufferSize)

173− <*> pure (classify classifyTable)

192+ s0 <- InputState BS8.empty ClassifierStart

193+ <$> readIORef (_configRef input)

194+ <*> pure (InputBuffer bufferPtr bufferSize)

195+ <*> pure (classify classifyTable)

174196 runReaderT (evalStateT loopInputProcessor s0) input

175197

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)

176223attributeControl :: Fd -> IO (IO (), IO ())

177224attributeControl fd = do

178225 original <- getTerminalAttributes fd

179− let vtyMode = foldl withoutMode original [ StartStopOutput, KeyboardInterrupts

180− , EnableEcho, ProcessInput, ExtendedFunctions

181− ]

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+ ]

182236 let setAttrs = setTerminalAttributes fd vtyMode Immediately

183237 unsetAttrs = setTerminalAttributes fd original Immediately

184− return (setAttrs,unsetAttrs)

238+ return (setAttrs, unsetAttrs)

185239

186240logInitialInputState :: Input -> ClassifyMap -> IO()

187241logInitialInputState input classifyTable = case _inputDebug input of

@@ -189,7 +243,7 @@ logInitialInputState input classifyTable = case _inputDebug input of

189243 Just h -> do

190244 Config{ vmin = Just theVmin

191245 , vtime = Just theVtime

192− , termName = Just theTerm, .. } <- readIORef $ _configRef input

246+ , termName = Just theTerm } <- readIORef $ _configRef input

193247 _ <- hPrintf h "initial (vmin,vtime): %s\n" (show (theVmin, theVtime))

194248 forM_ classifyTable $ \i -> case i of

195249 (inBytes, EvKey k mods) -> hPrintf h "map %s %s %s %s\n" (show theTerm)

@@ -205,6 +259,7 @@ initInput config classifyTable = do

205259 applyConfig fd config

206260 stopSync <- newEmptyMVar

207261 input <- Input <$> atomically newTChan

262+ <*> pure (return ())

208263 <*> pure (return ())

209264 <*> newIORef config

210265 <*> maybe (return Nothing)

src/Graphics/Vty/Input/Mouse.hs+34−23

@@ -3,21 +3,24 @@

33--

44-- http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Mouse-Tracking

55module Graphics.Vty.Input.Mouse

6− ( requestMouseEvents

7− , disableMouseEvents

8− , isMouseEvent

9− , classifyMouseEvent

10− ) where

6+ ( requestMouseEvents

7+ , disableMouseEvents

8+ , isMouseEvent

9+ , classifyMouseEvent

10+ )

11+where

1112

1213import Graphics.Vty.Input.Events

1314import Graphics.Vty.Input.Classify.Types

1415import Graphics.Vty.Input.Classify.Parse

1516

1617import Control.Monad.State

17−import Data.List (isPrefixOf)

1818import Data.Maybe (catMaybes)

1919import Data.Bits ((.&.))

2020

21+import qualified Data.ByteString.Char8 as BS8

22+import Data.ByteString.Char8 (ByteString)

23+

2124-- A mouse event in SGR extended mode is

2225--

2326-- '\ESC' '[' '<' B ';' X ';' Y ';' ('M'|'m')

@@ -31,28 +34,28 @@ import Data.Bits ((.&.))

3134

3235-- | These sequences set xterm-based terminals to send mouse event

3336-- sequences.

34−requestMouseEvents :: String

35−requestMouseEvents = "\ESC[?1000h\ESC[?1002h\ESC[?1006h\ESC[?1005h"

37+requestMouseEvents :: ByteString

38+requestMouseEvents = BS8.pack "\ESC[?1000h\ESC[?1002h\ESC[?1006h"

3639

3740-- | These sequences disable mouse events.

38−disableMouseEvents :: String

39−disableMouseEvents = "\ESC[?1000l\ESC[?1002l\ESC[?1006l\ESC[?1005l"

41+disableMouseEvents :: ByteString

42+disableMouseEvents = BS8.pack "\ESC[?1000l\ESC[?1002l\ESC[?1006l"

4043

4144-- | Does the specified string begin with a mouse event?

42−isMouseEvent :: String -> Bool

45+isMouseEvent :: ByteString -> Bool

4346isMouseEvent s = isSGREvent s || isNormalEvent s

4447

45−isSGREvent :: String -> Bool

46−isSGREvent = isPrefixOf sgrPrefix

48+isSGREvent :: ByteString -> Bool

49+isSGREvent = BS8.isPrefixOf sgrPrefix

4750

48−sgrPrefix :: String

49−sgrPrefix = "\ESC[M"

51+sgrPrefix :: ByteString

52+sgrPrefix = BS8.pack "\ESC[M"

5053

51−isNormalEvent :: String -> Bool

52−isNormalEvent = isPrefixOf normalPrefix

54+isNormalEvent :: ByteString -> Bool

55+isNormalEvent = BS8.isPrefixOf normalPrefix

5356

54−normalPrefix :: String

55−normalPrefix = "\ESC[<"

57+normalPrefix :: ByteString

58+normalPrefix = BS8.pack "\ESC[<"

5659

5760-- Modifier bits:

5861shiftBit :: Int

@@ -66,7 +69,7 @@ ctrlBit = 16

6669

6770-- These bits indicate the buttons involved:

6871buttonMask :: Int

69−buttonMask = 3

72+buttonMask = 67

7073

7174leftButton :: Int

7275leftButton = 0

@@ -77,11 +80,17 @@ middleButton = 1

7780rightButton :: Int

7881rightButton = 2

7982

83+scrollUp :: Int

84+scrollUp = 64

85+

86+scrollDown :: Int

87+scrollDown = 65

88+

8089hasBitSet :: Int -> Int -> Bool

8190hasBitSet val bit = val .&. bit > 0

8291

83−-- | Attempt to lassify an input string as a mouse event.

84−classifyMouseEvent :: String -> KClass

92+-- | Attempt to classify an input string as a mouse event.

93+classifyMouseEvent :: ByteString -> KClass

8594classifyMouseEvent s = runParser s $ do

8695 when (not $ isMouseEvent s) failParse

8796

@@ -93,12 +102,14 @@ classifyMouseEvent s = runParser s $ do

93102 'M' -> classifyNormalMouseEvent

94103 _ -> failParse

95104

96−-- Given a modifer/button value, determine which button was indicated

105+-- Given a modifier/button value, determine which button was indicated

97106getSGRButton :: Int -> Parser Button

98107getSGRButton mods =

99108 let buttonMap = [ (leftButton, BLeft)

100109 , (middleButton, BMiddle)

101110 , (rightButton, BRight)

111+ , (scrollUp, BScrollUp)

112+ , (scrollDown, BScrollDown)

102113 ]

103114 in case lookup (mods .&. buttonMask) buttonMap of

104115 Nothing -> failParse

src/Graphics/Vty/Input/Paste.hs+21−28

@@ -2,47 +2,40 @@

22--

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

44module Graphics.Vty.Input.Paste

5− ( parseBracketedPaste

6− , bracketedPasteStarted

7− , bracketedPasteFinished

8− ) where

5+ ( parseBracketedPaste

6+ , bracketedPasteStarted

7+ , bracketedPasteFinished

8+ )

9+where

910

1011import qualified Data.ByteString.Char8 as BS8

12+import Data.ByteString.Char8 (ByteString)

1113

1214import Graphics.Vty.Input.Events

1315import Graphics.Vty.Input.Classify.Types

1416

15−import Data.List (isPrefixOf, isInfixOf)

17+bracketedPasteStart :: ByteString

18+bracketedPasteStart = BS8.pack "\ESC[200~"

1619

17−bracketedPasteStart :: String

18−bracketedPasteStart = "\ESC[200~"

19−

20−bracketedPasteEnd :: String

21−bracketedPasteEnd = "\ESC[201~"

20+bracketedPasteEnd :: ByteString

21+bracketedPasteEnd = BS8.pack "\ESC[201~"

2222

2323-- | Does the input start a bracketed paste?

24−bracketedPasteStarted :: String -> Bool

25−bracketedPasteStarted = isPrefixOf bracketedPasteStart

24+bracketedPasteStarted :: ByteString -> Bool

25+bracketedPasteStarted = BS8.isPrefixOf bracketedPasteStart

2626

2727-- | Does the input contain a complete bracketed paste?

28−bracketedPasteFinished :: String -> Bool

29−bracketedPasteFinished = isInfixOf bracketedPasteEnd

28+bracketedPasteFinished :: ByteString -> Bool

29+bracketedPasteFinished = BS8.isInfixOf bracketedPasteEnd

3030

3131-- | Parse a bracketed paste. This should only be called on a string if

3232-- both 'bracketedPasteStarted' and 'bracketedPasteFinished' return

3333-- 'True'.

34−parseBracketedPaste :: String -> KClass

34+parseBracketedPaste :: ByteString -> KClass

3535parseBracketedPaste s =

36− let (p, rest) = takeUntil (drop (length bracketedPasteStart) s) bracketedPasteEnd

37− rest' = if bracketedPasteEnd `isPrefixOf` rest

38− then drop (length bracketedPasteEnd) rest

39− else rest

40− in Valid (EvPaste $ BS8.pack p) rest'

41−

42−takeUntil :: (Eq a) => [a] -> [a] -> ([a],[a])

43−takeUntil [] _ = ([], [])

44−takeUntil cs sub

45− | length cs < length sub = (cs, [])

46− | take (length sub) cs == sub = ([], drop (length sub) cs)

47− | otherwise = let (pre, suf) = takeUntil (tail cs) sub

48− in (head cs:pre, suf)

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

src/Graphics/Vty/Input/Terminfo.hs+27−29

@@ -7,8 +7,8 @@ import qualified Graphics.Vty.Input.Terminfo.ANSIVT as ANSIVT

77import Control.Arrow

88import System.Console.Terminfo

99

10−-- | Queries the terminal for all capability based input sequences then

11−-- adds on a terminal dependent input sequence mapping.

10+-- | Queries the terminal for all capability-based input sequences and

11+-- then adds on a terminal-dependent input sequence mapping.

1212--

1313-- For reference see:

1414--

@@ -20,30 +20,29 @@ import System.Console.Terminfo

2020--

2121-- * http://aperiodic.net/phil/archives/Geekery/term-function-keys.html

2222--

23−-- This is painful. Terminfo is incomplete. The vim source implies that

24−-- terminfo is also incorrect. Vty assumes that the an internal terminfo

25−-- table added to the system provided terminfo table is correct.

23+-- Terminfo is incomplete. The vim source implies that terminfo is also

24+-- incorrect. Vty assumes that the internal terminfo table added to the

25+-- system-provided terminfo table is correct.

2626--

27−-- 1. build terminfo table for all caps. Missing caps are not added.

27+-- The procedure used here is:

2828--

29−-- 2. add tables for visible chars, esc, del plus ctrl and meta

29+-- 1. Build terminfo table for all caps. Missing caps are not added.

3030--

31−-- 3. add internally defined table for given terminal type.

31+-- 2. Add tables for visible chars, esc, del, ctrl, and meta.

3232--

33−-- Precedence is currently implicit in the 'compile' algorithm. Which is

34−-- a bit odd.

33+-- 3. Add internally-defined table for given terminal type.

3534--

36−-- \todo terminfo meta is not supported.

37−-- \todo no 8bit

35+-- Precedence is currently implicit in the 'compile' algorithm.

3836classifyMapForTerm :: String -> Terminal -> ClassifyMap

3937classifyMapForTerm termName term =

4038 concat $ capsClassifyMap term keysFromCapsTable

4139 : universalTable

4240 : termSpecificTables termName

4341

44−-- | key table applicable to all terminals.

42+-- | The key table applicable to all terminals.

4543--

46−-- TODO: some probably only applicable to ANSI/VT100 terminals.

44+-- Note that some of these entries are probably only applicable to

45+-- ANSI/VT100 terminals.

4746universalTable :: ClassifyMap

4847universalTable = concat [visibleChars, ctrlChars, ctrlMetaChars, specialSupportKeys]

4948

@@ -54,7 +53,8 @@ capsClassifyMap terminal table = [(x,y) | (Just x,y) <- map extractCap table]

5453-- | Tables specific to a given terminal that are not derivable from

5554-- terminfo.

5655--

57−-- TODO: Adds the ANSI/VT100/VT50 tables regardless of term identifier.

56+-- Note that this adds the ANSI/VT100/VT50 tables regardless of term

57+-- identifier.

5858termSpecificTables :: String -> [ClassifyMap]

5959termSpecificTables _termName = ANSIVT.classifyTable

6060

@@ -62,22 +62,19 @@ termSpecificTables _termName = ANSIVT.classifyTable

6262--

6363-- We limit to < 0xC1. The UTF8 sequence detector will catch all values

6464-- 0xC2 and above before this classify table is reached.

65−--

66−-- TODO: resolve

67−-- 1. start at ' '. The earlier characters are all 'ctrlChar'

6865visibleChars :: ClassifyMap

6966visibleChars = [ ([x], EvKey (KChar x) [])

7067 | x <- [' ' .. toEnum 0xC1]

7168 ]

7269

73−-- | Non visible characters in the ISO-8859-1 and UTF-8 common set

70+-- | Non-printable characters in the ISO-8859-1 and UTF-8 common set

7471-- translated to ctrl + char.

7572--

76−-- \todo resolve CTRL-i is the same as tab

73+-- This treats CTRL-i the same as tab.

7774ctrlChars :: ClassifyMap

7875ctrlChars =

7976 [ ([toEnum x],EvKey (KChar y) [MCtrl])

80− | (x,y) <- zip ([0..31]) ('@':['a'..'z']++['['..'_'])

77+ | (x,y) <- zip [0..31] ('@':['a'..'z']++['['..'_'])

8178 , y /= 'i' -- Resolve issue #3 where CTRL-i hides TAB.

8279 , y /= 'h' -- CTRL-h should not hide BS

8380 ]

@@ -86,22 +83,23 @@ ctrlChars =

8683ctrlMetaChars :: ClassifyMap

8784ctrlMetaChars = map (\(s,EvKey c m) -> ('\ESC':s, EvKey c (MMeta:m))) ctrlChars

8885

89−-- | esc, meta esc, delete, meta delete, enter, meta enter

86+-- | Esc, meta-esc, delete, meta-delete, enter, meta-enter.

9087specialSupportKeys :: ClassifyMap

9188specialSupportKeys =

92− [ -- special support for ESC

93− ("\ESC",EvKey KEsc []), ("\ESC\ESC",EvKey KEsc [MMeta])

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

9493 -- Special support for backspace

95− , ("\DEL",EvKey KBS []), ("\ESC\DEL",EvKey KBS [MMeta])

94+ , ("\DEL",EvKey KBS []), ("\ESC\DEL",EvKey KBS [MMeta]), ("\b",EvKey KBS [])

9695 -- Special support for Enter

9796 , ("\ESC\^J",EvKey KEnter [MMeta]), ("\^J",EvKey KEnter [])

9897 -- explicit support for tab

9998 , ("\t", EvKey (KChar '\t') [])

10099 ]

101100

102−-- | classify table directly generated from terminfo cap strings

103−--

104−-- these are:

101+-- | A classification table directly generated from terminfo cap

102+-- strings. These are:

105103--

106104-- * ka1 - keypad up-left

107105--

@@ -183,6 +181,6 @@ keysFromCapsTable =

183181 , ("kcuu1", EvKey KUp [])

184182 ] ++ functionKeyCapsTable

185183

186−-- | cap names for function keys

184+-- | Cap names for function keys.

187185functionKeyCapsTable :: ClassifyMap

188186functionKeyCapsTable = flip map [0..63] $ \n -> ("kf" ++ show n, EvKey (KFun n) [])

src/Graphics/Vty/Input/Terminfo/ANSIVT.hs+1−6

@@ -10,9 +10,6 @@ module Graphics.Vty.Input.Terminfo.ANSIVT where

1010import Graphics.Vty.Input.Events

1111

1212-- | Encoding for navigation keys.

13−--

14−-- TODO: This is not the same as the input bytes pulled from teh caps

15−-- table.

1613navKeys0 :: ClassifyMap

1714navKeys0 =

1815 [ k "G" KCenter

@@ -62,13 +59,11 @@ navKeys3 =

6259-- This encoding depends on the terminal.

6360functionKeys1 :: ClassifyMap

6461functionKeys1 =

65− let f ff nrs m = [ ("\ESC["++show n++"~",EvKey (KFun $ n-(nrs!!0)+ff) m) | n <- nrs ] in

62+ let f ff nrs m = [ ("\ESC["++show n++"~",EvKey (KFun $ n-head nrs+ff) m) | n <- nrs ] in

6663 concat [f 1 [25,26] [MShift], f 3 [28,29] [MShift], f 5 [31..34] [MShift] ]

6764

6865-- | encoding for meta plus char

6966--

70−-- TODO: resolve -

71−--

7267-- 1. removed 'ESC' from second list due to duplication with

7368-- "special_support_keys".

7469-- 2. removed '[' from second list due to conflict with 7-bit encoding

src/Graphics/Vty/Output.hs+38−46

@@ -1,77 +1,69 @@

1−{-# LANGUAGE RecordWildCards #-}

2−{-# LANGUAGE NamedFieldPuns #-}

3−-- | Output interface.

4−--

5−-- Access to the current terminal or a specific terminal device.

1+{-# LANGUAGE RecordWildCards, CPP #-}

2+-- | This module provides functions for accessing the current terminal

3+-- or a specific terminal device.

64--

75-- See also:

86--

9−-- 1. "Graphics.Vty.Output": This instantiates an abtract interface to

10−-- the terminal interface based on the TERM and COLORTERM environment

7+-- 1. "Graphics.Vty.Output": This instantiates an abtract interface

8+-- to the terminal based on the @TERM@ and @COLORTERM@ environment

119-- variables.

1210--

1311-- 2. "Graphics.Vty.Output.Interface": Defines the generic interface all

14−-- terminals need to implement.

12+-- terminal modules need to implement.

1513--

1614-- 3. "Graphics.Vty.Output.TerminfoBased": Defines a terminal instance

1715-- that uses terminfo for all control strings. No attempt is made to

18−-- change the character set to UTF-8 for these terminals. I don't know a

19−-- way to reliably determine if that is required or how to do so.

16+-- change the character set to UTF-8 for these terminals.

2017--

2118-- 4. "Graphics.Vty.Output.XTermColor": This module contains an

2219-- interface suitable for xterm-like terminals. These are the terminals

23−-- where TERM == xterm. This does use terminfo for as many control codes

24−-- as possible.

25−module Graphics.Vty.Output ( module Graphics.Vty.Output

26− , Output(..) -- \todo hide constructors

27− , AssumedState(..)

28− , DisplayContext(..) -- \todo hide constructors

29− , outputPicture

30− , displayContext

31− )

32− where

20+-- where @TERM@ begins with @xterm@. This does use terminfo for as many

21+-- control codes as possible.

22+module Graphics.Vty.Output

23+ ( outputForConfig

24+ , setCursorPos

25+ , hideCursor

26+ , showCursor

27+ )

28+where

3329

34−import Graphics.Vty.Prelude

30+import Control.Monad (when)

3531

3632import Graphics.Vty.Config

37−

33+import Graphics.Vty.Image (regionWidth, regionHeight)

3834import Graphics.Vty.Output.Interface

3935import Graphics.Vty.Output.XTermColor as XTermColor

4036import Graphics.Vty.Output.TerminfoBased as TerminfoBased

4137

4238import Blaze.ByteString.Builder (writeToByteString)

4339

44−import Control.Monad.Trans

45−

4640import Data.List (isPrefixOf)

41+

42+#if !MIN_VERSION_base(4,11,0)

4743import Data.Monoid ((<>))

44+#endif

4845

49−-- | Returns a `Output` for the terminal specified in `Config`

46+-- | Returns an `Output` for the terminal specified in `Config`.

5047--

5148-- The specific Output implementation used is hidden from the API user.

5249-- All terminal implementations are assumed to perform more, or less,

5350-- the same. Currently, all implementations use terminfo for at least

5451-- some terminal specific information.

5552--

56−-- Specifics about it being based on terminfo are hidden from the API

57−-- user. If a terminal implementation is developed for a terminal

58−-- without terminfo support then Vty should work as expected on that

59−-- terminal.

53+-- If a terminal implementation is developed for a terminal without

54+-- terminfo support then Vty should work as expected on that terminal.

6055--

6156-- Selection of a terminal is done as follows:

6257--

6358-- * If TERM contains "xterm" or "screen", use XTermColor.

6459-- * otherwise use the TerminfoBased driver.

65−--

66−-- \todo add an implementation for windows that does not depend on

67−-- terminfo. Should be installable with only what is provided in the

68−-- haskell platform. Use ansi-terminal

6960outputForConfig :: Config -> IO Output

70−outputForConfig Config{ outputFd = Just fd, termName = Just termName, .. } = do

61+outputForConfig Config{ outputFd = Just fd, termName = Just termName

62+ , colorMode = Just colorMode, .. } = do

7163 t <- if "xterm" `isPrefixOf` termName || "screen" `isPrefixOf` termName

72− then XTermColor.reserveTerminal termName fd

64+ then XTermColor.reserveTerminal termName fd colorMode

7365 -- Not an xterm-like terminal. try for generic terminfo.

74− else TerminfoBased.reserveTerminal termName fd

66+ else TerminfoBased.reserveTerminal termName fd colorMode

7567

7668 case mouseMode of

7769 Just s -> setMode t Mouse s

@@ -86,30 +78,30 @@ outputForConfig config = (<> config) <$> standardIOConfig >>= outputForConfig

8678

8779-- | Sets the cursor position to the given output column and row.

8880--

89−-- This is not necessarially the same as the character position with the

81+-- This is not necessarily the same as the character position with the

9082-- same coordinates. Characters can be a variable number of columns in

9183-- width.

9284--

9385-- Currently, the only way to set the cursor position to a given

9486-- character coordinate is to specify the coordinate in the Picture

95−-- instance provided to outputPicture or refresh.

96−setCursorPos :: MonadIO m => Output -> Int -> Int -> m ()

87+-- instance provided to 'outputPicture' or 'refresh'.

88+setCursorPos :: Output -> Int -> Int -> IO ()

9789setCursorPos t x y = do

9890 bounds <- displayBounds t

9991 when (x >= 0 && x < regionWidth bounds && y >= 0 && y < regionHeight bounds) $ do

10092 dc <- displayContext t bounds

101− liftIO $ outputByteBuffer t $ writeToByteString $ writeMoveCursor dc x y

93+ outputByteBuffer t $ writeToByteString $ writeMoveCursor dc x y

10294

103−-- | Hides the cursor

104−hideCursor :: MonadIO m => Output -> m ()

95+-- | Hides the cursor.

96+hideCursor :: Output -> IO ()

10597hideCursor t = do

10698 bounds <- displayBounds t

10799 dc <- displayContext t bounds

108− liftIO $ outputByteBuffer t $ writeToByteString $ writeHideCursor dc

100+ outputByteBuffer t $ writeToByteString $ writeHideCursor dc

109101

110−-- | Shows the cursor

111−showCursor :: MonadIO m => Output -> m ()

102+-- | Shows the cursor.

103+showCursor :: Output -> IO ()

112104showCursor t = do

113105 bounds <- displayBounds t

114106 dc <- displayContext t bounds

115− liftIO $ outputByteBuffer t $ writeToByteString $ writeShowCursor dc

107+ outputByteBuffer t $ writeToByteString $ writeShowCursor dc

src/Graphics/Vty/Output/Interface.hs+146−114

@@ -1,21 +1,25 @@

11-- Copyright Corey O'Connor

2−-- General philosophy is: MonadIO is for equations exposed to clients.

3−{-# LANGUAGE CPP #-}

4−{-# LANGUAGE BangPatterns #-}

52{-# LANGUAGE RankNTypes #-}

63{-# LANGUAGE ExistentialQuantification #-}

74{-# LANGUAGE GADTs #-}

85{-# LANGUAGE FlexibleContexts #-}

9−

10−#ifndef MIN_VERSION_base

11−#defined MIN_VERSION_base(x,y,z) 1

12−#endif

13−

6+{-# LANGUAGE ScopedTypeVariables #-}

7+-- | This module provides an abstract interface for performing terminal

8+-- output. The only user-facing part of this API is 'Output'.

149module Graphics.Vty.Output.Interface

10+ ( Output(..)

11+ , AssumedState(..)

12+ , DisplayContext(..)

13+ , Mode(..)

14+ , displayContext

15+ , outputPicture

16+ , initialAssumedState

17+ , limitAttrForDisplay

18+ )

1519where

1620

17−import Graphics.Vty.Prelude

18−

21+import Graphics.Vty.Attributes

22+import Graphics.Vty.Image (DisplayRegion, regionHeight)

1923import Graphics.Vty.Picture

2024import Graphics.Vty.PictureToSpans

2125import Graphics.Vty.Span

@@ -25,77 +29,97 @@ import Graphics.Vty.DisplayAttributes

2529import Blaze.ByteString.Builder (Write, writeToByteString)

2630import Blaze.ByteString.Builder.ByteString (writeByteString)

2731

28−import Control.Monad.Trans

29−

3032import qualified Data.ByteString as BS

3133import Data.IORef

3234import qualified Data.Text.Encoding as T

3335import qualified Data.Text.Lazy as TL

3436import qualified Data.Vector as Vector

3537

36−#if !(MIN_VERSION_base(4,8,0))

37−import Data.Monoid (mempty, mappend)

38−#endif

39−

4038-- | Modal terminal features that can be enabled and disabled.

4139data Mode = Mouse

40+ -- ^ Mouse mode (whether the terminal is configured to provide

41+ -- mouse input events)

4242 | BracketedPaste

43+ -- ^ Paste mode (whether the terminal is configured to provide

44+ -- events on OS pastes)

45+ | Focus

46+ -- ^ Focus-in/focus-out events (whether the terminal is

47+ -- configured to provide events on focus change)

48+ | Hyperlink

49+ -- ^ Hyperlink mode via the 'withURL' attribute modifier (see

50+ -- https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda).

51+ -- Note that this may not work gracefully in all terminal

52+ -- emulators so be sure to test this mode with the terminals

53+ -- you intend to support. It is off by default.

4354 deriving (Eq, Read, Show)

4455

56+-- | The Vty terminal output interface.

4557data Output = Output

4658 { -- | Text identifier for the output device. Used for debugging.

4759 terminalID :: String

48− , releaseTerminal :: forall m. MonadIO m => m ()

49− -- | Clear the display and initialize the terminal to some initial

50− -- display state.

51− --

52− -- The expectation of a program is that the display starts in some

53− -- The initial state. initial state would consist of fixed values:

54− --

55− -- - cursor at top left

56− -- - UTF-8 character encoding

57− -- - drawing characteristics are the default

58− --

59− -- The abstract operation I think all these behaviors are instances

60− -- of is reserving exclusive access to a display such that:

61− --

62− -- - The previous state cannot be determined

63− -- - When exclusive access to a display is released the display

64− -- returns to the previous state.

65− , reserveDisplay :: forall m. MonadIO m => m ()

66− -- | Return the display to the state before `reserveDisplay`

67− -- If no previous state then set the display state to the initial

68− -- state.

69− , releaseDisplay :: forall m. MonadIO m => m ()

70− -- | Returns the current display bounds.

71− , displayBounds :: forall m. MonadIO m => m DisplayRegion

72− -- | Output the byte string to the terminal device.

60+ -- | Release the terminal just prior to application exit and reset

61+ -- it to its state prior to application startup.

62+ , releaseTerminal :: IO ()

63+ -- | Clear the display and initialize the terminal to some initial

64+ -- display state.

65+ --

66+ -- The expectation of a program is that the display starts in some

67+ -- The initial state. initial state would consist of fixed values:

68+ --

69+ -- - cursor at top left

70+ -- - UTF-8 character encoding

71+ -- - drawing characteristics are the default

72+ , reserveDisplay :: IO ()

73+ -- | Return the display to the state before `reserveDisplay` If no

74+ -- 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 ()

78+ -- | Returns the current display bounds.

79+ , displayBounds :: IO DisplayRegion

80+ -- | Output the bytestring to the terminal device.

7381 , outputByteBuffer :: BS.ByteString -> IO ()

74− -- | Maximum number of colors supported by the context.

75− , contextColorCount :: Int

76− -- | if the cursor can be shown / hidden

82+ -- | Specifies whether the cursor can be shown / hidden.

7783 , supportsCursorVisibility :: Bool

78− -- | Indicates support for terminal modes for this output device

84+ -- | Indicates support for terminal modes for this output device.

7985 , supportsMode :: Mode -> Bool

80− -- | Enables or disables a mode (does nothing if the mode is

81− -- unsupported)

82− , setMode :: forall m. MonadIO m => Mode -> Bool -> m ()

83− -- | Returns whether a mode is enabled

84− , getModeStatus :: forall m. MonadIO m => Mode -> m Bool

86+ -- | Enables or disables a mode (does nothing if the mode is

87+ -- unsupported).

88+ , setMode :: Mode -> Bool -> IO ()

89+ -- | Returns whether a mode is enabled.

90+ , getModeStatus :: Mode -> IO Bool

8591 , assumedStateRef :: IORef AssumedState

86− -- | Acquire display access to the given region of the display.

87− -- Currently all regions have the upper left corner of (0,0) and

88− -- the lower right corner at (max displayWidth providedWidth, max

89− -- displayHeight providedHeight)

90− , mkDisplayContext :: forall m. MonadIO m => Output -> DisplayRegion -> m DisplayContext

91− -- | Ring the terminal bell if supported.

92− , ringTerminalBell :: forall m. MonadIO m => m ()

93− -- | Returns whether the terminal has an audio bell feature.

94− , supportsBell :: forall m. MonadIO m => m Bool

92+ -- | Acquire display access to the given region of the display.

93+ -- Currently all regions have the upper left corner of (0,0) and

94+ -- the lower right corner at (max displayWidth providedWidth, max

95+ -- displayHeight providedHeight)

96+ , mkDisplayContext :: Output -> DisplayRegion -> IO DisplayContext

97+ -- | Ring the terminal bell if supported.

98+ , ringTerminalBell :: IO ()

99+ -- | 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

95119 }

96120

97−displayContext :: MonadIO m => Output -> DisplayRegion -> m DisplayContext

98−displayContext t = liftIO . mkDisplayContext t t

121+displayContext :: Output -> DisplayRegion -> IO DisplayContext

122+displayContext t = mkDisplayContext t t

99123

100124data AssumedState = AssumedState

101125 { prevFattr :: Maybe FixedAttr

@@ -109,16 +133,16 @@ data DisplayContext = DisplayContext

109133 { contextDevice :: Output

110134 -- | Provide the bounds of the display context.

111135 , contextRegion :: DisplayRegion

112− -- | sets the output position to the specified row and column.

113− -- Where the number of bytes required for the control codes can be

136+ -- | Sets the output position to the specified row and column

137+ -- where the number of bytes required for the control codes can be

114138 -- specified seperate from the actual byte sequence.

115139 , writeMoveCursor :: Int -> Int -> Write

116140 , writeShowCursor :: Write

117141 , writeHideCursor :: Write

118− -- | Assure the specified output attributes will be applied to

119− -- all the following text until the next output attribute change.

120− -- Where the number of bytes required for the control codes can be

121− -- specified seperate from the actual byte sequence. The required

142+ -- Ensure that the specified output attributes will be applied to

143+ -- all the following text until the next output attribute change

144+ -- where the number of bytes required for the control codes can be

145+ -- specified seperately from the actual byte sequence. The required

122146 -- number of bytes must be at least the maximum number of bytes

123147 -- required by any attribute changes. The serialization equations

124148 -- must provide the ptr to the next byte to be specified in the

@@ -130,9 +154,9 @@ data DisplayContext = DisplayContext

130154 -- to support this the currently applied display attributes are

131155 -- required. In addition it may be possible to optimize the state

132156 -- changes based off the currently applied display attributes.

133− , writeSetAttr :: FixedAttr -> Attr -> DisplayAttrDiff -> Write

134− -- | Reset the display attributes to the default display attributes

135− , writeDefaultAttr :: Write

157+ , writeSetAttr :: Bool -> FixedAttr -> Attr -> DisplayAttrDiff -> Write

158+ -- | Reset the display attributes to the default display attributes.

159+ , writeDefaultAttr :: Bool -> Write

136160 , writeRowEnd :: Write

137161 -- | See `Graphics.Vty.Output.XTermColor.inlineHack`

138162 , inlineHack :: IO ()

@@ -145,37 +169,33 @@ writeUtf8Text = writeByteString

145169

146170-- | Displays the given `Picture`.

147171--

148−-- 0. The image is cropped to the display size.

149−--

150−-- 1. Converted into a sequence of attribute changes and text spans.

172+-- 1. The image is cropped to the display size.

151173--

152−-- 2. The cursor is hidden.

174+-- 2. Converted into a sequence of attribute changes and text spans.

153175--

154−-- 3. Serialized to the display.

176+-- 3. The cursor is hidden.

155177--

156−-- 4. The cursor is then shown and positioned or kept hidden.

178+-- 4. Serialized to the display.

157179--

158−-- todo: specify possible IO exceptions.

159−-- abstract from IO monad to a MonadIO instance.

160−outputPicture :: MonadIO m => DisplayContext -> Picture -> m ()

161−outputPicture dc pic = liftIO $ do

180+-- 5. The cursor is then shown and positioned or kept hidden.

181+outputPicture :: DisplayContext -> Picture -> IO ()

182+outputPicture dc pic = do

183+ urlsEnabled <- getModeStatus (contextDevice dc) Hyperlink

162184 as <- readIORef (assumedStateRef $ contextDevice dc)

163185 let manipCursor = supportsCursorVisibility (contextDevice dc)

164186 r = contextRegion dc

165187 ops = displayOpsForPic pic r

166− initialAttr = FixedAttr defaultStyleMask Nothing Nothing

188+ initialAttr = FixedAttr defaultStyleMask Nothing Nothing Nothing

167189 -- Diff the previous output against the requested output.

168190 -- Differences are currently on a per-row basis.

169− -- \todo handle resizes that crop the dominate directions better.

170191 diffs :: [Bool] = case prevOutputOps as of

171− Nothing -> replicate (fromEnum $ regionHeight $ effectedRegion ops) True

172− Just previousOps -> if effectedRegion previousOps /= effectedRegion ops

192+ Nothing -> replicate (fromEnum $ regionHeight $ affectedRegion ops) True

193+ Just previousOps -> if affectedRegion previousOps /= affectedRegion ops

173194 then replicate (displayOpsRows ops) True

174− else zipWith (/=) (Vector.toList previousOps)

175− (Vector.toList ops)

195+ else Vector.toList $ Vector.zipWith (/=) previousOps ops

176196 -- build the Write corresponding to the output image

177197 out = (if manipCursor then writeHideCursor dc else mempty)

178− `mappend` writeOutputOps dc initialAttr diffs ops

198+ `mappend` writeOutputOps urlsEnabled dc initialAttr diffs ops

179199 `mappend`

180200 (let (w,h) = contextRegion dc

181201 clampX = max 0 . min (w-1)

@@ -186,9 +206,15 @@ outputPicture dc pic = liftIO $ do

186206 AbsoluteCursor x y ->

187207 writeShowCursor dc `mappend`

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

189215 Cursor x y ->

190216 let m = cursorOutputMap ops $ picCursor pic

191− (ox, oy) = charToOutputPos m (x,y)

217+ (ox, oy) = charToOutputPos m (clampX x, clampY y)

192218 in writeShowCursor dc `mappend`

193219 writeMoveCursor dc (clampX ox) (clampY oy)

194220 )

@@ -198,15 +224,15 @@ outputPicture dc pic = liftIO $ do

198224 let as' = as { prevOutputOps = Just ops }

199225 writeIORef (assumedStateRef $ contextDevice dc) as'

200226

201−writeOutputOps :: DisplayContext -> FixedAttr -> [Bool] -> DisplayOps -> Write

202−writeOutputOps dc initialAttr diffs ops =

227+writeOutputOps :: Bool -> DisplayContext -> FixedAttr -> [Bool] -> DisplayOps -> Write

228+writeOutputOps urlsEnabled dc initialAttr diffs ops =

203229 let (_, out, _) = Vector.foldl' writeOutputOps'

204230 (0, mempty, diffs)

205231 ops

206232 in out

207233 where

208234 writeOutputOps' (y, out, True : diffs') spanOps

209− = let spanOut = writeSpanOps dc y initialAttr spanOps

235+ = let spanOut = writeSpanOps urlsEnabled dc y initialAttr spanOps

210236 out' = out `mappend` spanOut

211237 in (y+1, out', diffs')

212238 writeOutputOps' (y, out, False : diffs') _spanOps

@@ -214,27 +240,27 @@ writeOutputOps dc initialAttr diffs ops =

214240 writeOutputOps' (_y, _out, []) _spanOps

215241 = error "vty - output spans without a corresponding diff."

216242

217−writeSpanOps :: DisplayContext -> Int -> FixedAttr -> SpanOps -> Write

218−writeSpanOps dc y initialAttr spanOps =

243+writeSpanOps :: Bool -> DisplayContext -> Int -> FixedAttr -> SpanOps -> Write

244+writeSpanOps urlsEnabled dc y initialAttr spanOps =

219245 -- The first operation is to set the cursor to the start of the row

220− let start = writeMoveCursor dc 0 y `mappend` writeDefaultAttr dc

246+ let start = writeMoveCursor dc 0 y `mappend` writeDefaultAttr dc urlsEnabled

221247 -- then the span ops are serialized in the order specified

222− in fst $ Vector.foldl' (\(out, fattr) op -> case writeSpanOp dc op fattr of

248+ in fst $ Vector.foldl' (\(out, fattr) op -> case writeSpanOp urlsEnabled dc op fattr of

223249 (opOut, fattr') -> (out `mappend` opOut, fattr')

224250 )

225251 (start, initialAttr)

226252 spanOps

227253

228−writeSpanOp :: DisplayContext -> SpanOp -> FixedAttr -> (Write, FixedAttr)

229−writeSpanOp dc (TextSpan attr _ _ str) fattr =

254+writeSpanOp :: Bool -> DisplayContext -> SpanOp -> FixedAttr -> (Write, FixedAttr)

255+writeSpanOp urlsEnabled dc (TextSpan attr _ _ str) fattr =

230256 let attr' = limitAttrForDisplay (contextDevice dc) attr

231257 fattr' = fixDisplayAttr fattr attr'

232258 diffs = displayAttrDiffs fattr fattr'

233− out = writeSetAttr dc fattr attr' diffs

259+ out = writeSetAttr dc urlsEnabled fattr attr' diffs

234260 `mappend` writeUtf8Text (T.encodeUtf8 $ TL.toStrict str)

235261 in (out, fattr')

236−writeSpanOp _dc (Skip _) _fattr = error "writeSpanOp for Skip"

237−writeSpanOp dc (RowEnd _) fattr = (writeDefaultAttr dc `mappend` writeRowEnd dc, fattr)

262+writeSpanOp _ _ (Skip _) _fattr = error "writeSpanOp for Skip"

263+writeSpanOp urlsEnabled dc (RowEnd _) fattr = (writeDefaultAttr dc urlsEnabled `mappend` writeRowEnd dc, fattr)

238264

239265-- | The cursor position is given in X,Y character offsets. Due to

240266-- multi-column characters this needs to be translated to column, row

@@ -283,17 +309,23 @@ limitAttrForDisplay t attr

283309 where

284310 clampColor Default = Default

285311 clampColor KeepCurrent = KeepCurrent

286− clampColor (SetTo c) = clampColor' c

287− clampColor' (ISOColor v)

288− | contextColorCount t < 8 = Default

289− | contextColorCount t < 16 && v >= 8 = SetTo $ ISOColor (v - 8)

290− | otherwise = SetTo $ ISOColor v

291− clampColor' (Color240 v)

292− -- TODO: Choose closes ISO color?

293− | contextColorCount t < 8 = Default

294− | contextColorCount t < 16 = Default

295− | contextColorCount t <= 256 = SetTo $ Color240 v

296− | otherwise

297− = let p :: Double = fromIntegral v / 240.0

298− v' = floor $ p * (fromIntegral $ contextColorCount t)

299− in SetTo $ Color240 v'

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

src/Graphics/Vty/Output/Mock.hs+16−10

@@ -2,13 +2,16 @@

22{-# LANGUAGE FlexibleInstances #-}

33{-# LANGUAGE TypeFamilies #-}

44-- | This provides a mock terminal implementation that is nice for

5−-- testing. This transforms the output operations to visible characters.

6−-- Which is nice for some tests.

7−module Graphics.Vty.Output.Mock ( MockData, mockTerminal )

8− where

9−

10−import Graphics.Vty.Prelude

5+-- testing. This transforms the output operations to visible characters

6+-- which is useful for testing.

7+module Graphics.Vty.Output.Mock

8+ ( MockData

9+ , mockTerminal

10+ )

11+where

1112

13+import Graphics.Vty.Image (DisplayRegion)

14+import Graphics.Vty.Attributes.Color (ColorMode(ColorMode16))

1215import Graphics.Vty.Output.Interface

1316

1417import Blaze.ByteString.Builder.Word (writeWord8)

@@ -28,7 +31,7 @@ type MockData = IORef (UTF8.UTF8 BS.ByteString)

2831-- without considering terminal specific issues.

2932--

3033-- The mock implementation is useful in manually determining if the

31−-- sequence of terminal operations matches the expected sequence. So

34+-- sequence of terminal operations matches the expected sequence. The

3235-- requirement of the produced representation is simplicity in parsing

3336-- the text representation and determining how the picture was mapped to

3437-- terminal operations.

@@ -46,16 +49,19 @@ mockTerminal r = liftIO $ do

4649 , releaseDisplay = return ()

4750 , ringTerminalBell = return ()

4851 , supportsBell = return False

52+ , supportsItalics = return False

53+ , supportsStrikethrough = return False

54+ , setDisplayBounds = const $ return ()

4955 , displayBounds = return r

5056 , outputByteBuffer = \bytes -> do

5157 putStrLn $ "mock outputByteBuffer of " ++ show (BS.length bytes) ++ " bytes"

5258 writeIORef outRef $ UTF8.fromRep bytes

53− , contextColorCount = 16

5459 , supportsCursorVisibility = True

5560 , supportsMode = const False

5661 , setMode = const $ const $ return ()

5762 , getModeStatus = const $ return False

5863 , assumedStateRef = newAssumedStateRef

64+ , outputColorMode = ColorMode16

5965 , mkDisplayContext = \tActual rActual -> return $ DisplayContext

6066 { contextRegion = rActual

6167 , contextDevice = tActual

@@ -70,10 +76,10 @@ mockTerminal r = liftIO $ do

7076 , writeHideCursor = writeWord8 $ toEnum $ fromEnum 'H'

7177 -- An attr change is always visualized as the single

7278 -- character 'A'

73− , writeSetAttr = \_fattr _diffs _attr -> writeWord8 $ toEnum $ fromEnum 'A'

79+ , writeSetAttr = \_ _fattr _diffs _attr -> writeWord8 $ toEnum $ fromEnum 'A'

7480 -- default attr is always visualized as the single

7581 -- character 'D'

76− , writeDefaultAttr = writeWord8 $ toEnum $ fromEnum 'D'

82+ , writeDefaultAttr = const $ writeWord8 $ toEnum $ fromEnum 'D'

7783 -- row end is always visualized as the single character

7884 -- 'E'

7985 , writeRowEnd = writeWord8 $ toEnum $ fromEnum 'E'

src/Graphics/Vty/Output/TerminfoBased.hs+213−102

@@ -1,42 +1,40 @@

1−{-# LANGUAGE RecordWildCards #-}

2−{-# LANGUAGE CPP #-}

31{-# LANGUAGE FlexibleInstances #-}

2+{-# LANGUAGE OverloadedStrings #-}

3+{-# LANGUAGE CPP #-}

44{-# OPTIONS_GHC -D_XOPEN_SOURCE=500 -fno-warn-warnings-deprecations #-}

55{-# CFILES gwinsz.c #-}

66

7−#ifndef MIN_VERSION_base

8−#defined MIN_VERSION_base(x,y,z) 1

9−#endif

10−

11−-- | Terminfo based terminal handling.

12−--

13−-- The color handling assumes tektronix like. No HP support provided. If

14−-- the terminal is not one I have easy access to then color support is

15−-- entirely based of the docs. Probably with some assumptions mixed in.

7+-- | Terminfo-based terminal output driver.

168--

179-- Copyright Corey O'Connor (coreyoconnor@gmail.com)

18−module Graphics.Vty.Output.TerminfoBased ( reserveTerminal )

19− where

20−

21−import Graphics.Vty.Prelude

22−

10+module Graphics.Vty.Output.TerminfoBased

11+ ( reserveTerminal

12+ , setWindowSize

13+ )

14+where

15+

16+import Control.Monad (when)

17+import Data.Bits (shiftL, (.&.))

18+import qualified Data.ByteString as BS

2319import Data.ByteString.Internal (toForeignPtr)

2420import Data.Terminfo.Parse

2521import Data.Terminfo.Eval

2622

2723import Graphics.Vty.Attributes

24+import Graphics.Vty.Image (DisplayRegion)

2825import Graphics.Vty.DisplayAttributes

2926import Graphics.Vty.Output.Interface

3027

31−import Blaze.ByteString.Builder (Write, writeToByteString)

32−

33−import Control.Monad.Trans

28+import Blaze.ByteString.Builder (Write, writeToByteString, writeStorable, writeWord8)

3429

35−import Data.Bits ((.&.))

3630import Data.IORef

3731import Data.Maybe (isJust, isNothing, fromJust)

3832import Data.Word

3933

34+#if !MIN_VERSION_base(4,8,0)

35+import Data.Foldable (foldMap)

36+#endif

37+

4038import Foreign.C.Types ( CInt(..), CLong(..) )

4139import Foreign.ForeignPtr (withForeignPtr)

4240import Foreign.Ptr (Ptr, plusPtr)

@@ -45,18 +43,12 @@ import qualified System.Console.Terminfo as Terminfo

4543import System.Posix.IO (fdWriteBuf)

4644import System.Posix.Types (Fd(..))

4745

48−#if !(MIN_VERSION_base(4,8,0))

49−import Data.Foldable (foldMap)

50−import Data.Monoid

51−#endif

52−

5346data TerminfoCaps = TerminfoCaps

5447 { smcup :: Maybe CapExpression

5548 , rmcup :: Maybe CapExpression

5649 , cup :: CapExpression

5750 , cnorm :: Maybe CapExpression

5851 , civis :: Maybe CapExpression

59− , supportsNoColors :: Bool

6052 , useAltColorMap :: Bool

6153 , setForeColor :: CapExpression

6254 , setBackColor :: CapExpression

@@ -71,6 +63,10 @@ data DisplayAttrCaps = DisplayAttrCaps

7163 { setAttrStates :: Maybe CapExpression

7264 , enterStandout :: Maybe CapExpression

7365 , exitStandout :: Maybe CapExpression

66+ , enterItalic :: Maybe CapExpression

67+ , exitItalic :: Maybe CapExpression

68+ , enterStrikethrough :: Maybe CapExpression

69+ , exitStrikethrough :: Maybe CapExpression

7470 , enterUnderline :: Maybe CapExpression

7571 , exitUnderline :: Maybe CapExpression

7672 , enterReverseVideo :: Maybe CapExpression

@@ -97,75 +93,95 @@ sendCapToTerminal :: Output -> CapExpression -> [CapParam] -> IO ()

9793sendCapToTerminal t cap capParams = do

9894 outputByteBuffer t $ writeToByteString $ writeCapExpr cap capParams

9995

100−{- | Uses terminfo for all control codes. While this should provide the

101− - most compatible terminal terminfo does not support some features that

102− - would increase efficiency and improve compatibility:

103− -

104− - * determine the character encoding supported by the terminal. Should

105− - this be taken from the LANG environment variable?

106− -

107− - * Provide independent string capabilities for all display attributes.

108− -

109− - todo: Some display attributes like underline and bold have

110− - independent string capabilities that should be used instead of the

111− - generic "sgr" string capability.

112− -}

113−reserveTerminal :: ( Applicative m, MonadIO m ) => String -> Fd -> m Output

114−reserveTerminal termName outFd = liftIO $ do

96+-- | Constructs an output driver that uses terminfo for all control

97+-- codes. While this should provide the most compatible terminal,

98+-- terminfo does not support some features that would increase

99+-- efficiency and improve compatibility:

100+--

101+-- * determining the character encoding supported by the terminal.

102+-- Should this be taken from the LANG environment variable?

103+--

104+-- * Providing independent string capabilities for all display

105+-- attributes.

106+reserveTerminal :: String -> Fd -> ColorMode -> IO Output

107+reserveTerminal termName outFd colorMode = do

115108 ti <- Terminfo.setupTerm termName

116109 -- assumes set foreground always implies set background exists.

117110 -- if set foreground is not set then all color changing style

118111 -- attributes are filtered.

119112 msetaf <- probeCap ti "setaf"

120113 msetf <- probeCap ti "setf"

121− let (noColors, useAlt, setForeCap)

114+ let (useAlt, setForeCap)

122115 = case msetaf of

123− Just setaf -> (False, False, setaf)

116+ Just setaf -> (False, setaf)

124117 Nothing -> case msetf of

125− Just setf -> (False, True, setf)

126− Nothing -> (True, True, error $ "no fore color support for terminal " ++ termName)

118+ Just setf -> (True, setf)

119+ Nothing -> (True, error $ "no fore color support for terminal " ++ termName)

127120 msetab <- probeCap ti "setab"

128121 msetb <- probeCap ti "setb"

129− let set_back_cap

122+ let setBackCap

130123 = case msetab of

124+ Just setab -> setab

131125 Nothing -> case msetb of

132126 Just setb -> setb

133127 Nothing -> error $ "no back color support for terminal " ++ termName

134− Just setab -> setab

128+

129+ hyperlinkModeStatus <- newIORef False

130+ newAssumedStateRef <- newIORef initialAssumedState

131+

132+ let terminfoSetMode m newStatus = do

133+ curStatus <- terminfoModeStatus m

134+ when (newStatus /= curStatus) $

135+ case m of

136+ Hyperlink -> do

137+ writeIORef hyperlinkModeStatus newStatus

138+ writeIORef newAssumedStateRef initialAssumedState

139+ _ -> return ()

140+ terminfoModeStatus m =

141+ case m of

142+ Hyperlink -> readIORef hyperlinkModeStatus

143+ _ -> return False

144+ terminfoModeSupported Hyperlink = True

145+ terminfoModeSupported _ = False

146+

135147 terminfoCaps <- pure TerminfoCaps

136148 <*> probeCap ti "smcup"

137149 <*> probeCap ti "rmcup"

138150 <*> requireCap ti "cup"

139151 <*> probeCap ti "cnorm"

140152 <*> probeCap ti "civis"

141− <*> pure noColors

142153 <*> pure useAlt

143154 <*> pure setForeCap

144− <*> pure set_back_cap

155+ <*> pure setBackCap

145156 <*> requireCap ti "sgr0"

146157 <*> requireCap ti "clear"

147158 <*> requireCap ti "el"

148159 <*> currentDisplayAttrCaps ti

149160 <*> probeCap ti "bel"

150− newAssumedStateRef <- newIORef initialAssumedState

151161 let t = Output

152162 { terminalID = termName

153− , releaseTerminal = liftIO $ do

163+ , releaseTerminal = do

154164 sendCap setDefaultAttr []

155165 maybeSendCap cnorm []

156166 , supportsBell = return $ isJust $ ringBellAudio terminfoCaps

157− , ringTerminalBell = liftIO $ maybeSendCap ringBellAudio []

158− , reserveDisplay = liftIO $ do

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

159173 -- If there is no support for smcup: Clear the screen

160174 -- and then move the mouse to the home position to

161175 -- approximate the behavior.

162176 maybeSendCap smcup []

163177 sendCap clearScreen []

164− , releaseDisplay = liftIO $ do

178+ , releaseDisplay = do

165179 maybeSendCap rmcup []

166180 maybeSendCap cnorm []

181+ , setDisplayBounds = \(w, h) ->

182+ setWindowSize outFd (w, h)

167183 , displayBounds = do

168− rawSize <- liftIO $ getWindowSize outFd

184+ rawSize <- getWindowSize outFd

169185 case rawSize of

170186 (w, h) | w < 0 || h < 0 -> fail $ "getwinsize returned < 0 : " ++ show rawSize

171187 | otherwise -> return (w,h)

@@ -176,51 +192,48 @@ reserveTerminal termName outFd = liftIO $ do

176192 when (toEnum len /= actualLen) $ fail $ "Graphics.Vty.Output: outputByteBuffer "

177193 ++ "length mismatch. " ++ show len ++ " /= " ++ show actualLen

178194 ++ " Please report this bug to vty project."

179− , contextColorCount

180− = case supportsNoColors terminfoCaps of

181− False -> case Terminfo.getCapability ti (Terminfo.tiGetNum "colors" ) of

182− Nothing -> 8

183− Just v -> toEnum v

184− True -> 1

185195 , supportsCursorVisibility = isJust $ civis terminfoCaps

186− , supportsMode = const False

187− , setMode = const $ const $ return ()

188− , getModeStatus = const $ return False

196+ , supportsMode = terminfoModeSupported

197+ , setMode = terminfoSetMode

198+ , getModeStatus = terminfoModeStatus

189199 , assumedStateRef = newAssumedStateRef

200+ , outputColorMode = colorMode

190201 -- I think fix would help assure tActual is the only

191202 -- reference. I was having issues tho.

192− , mkDisplayContext = \tActual -> liftIO . terminfoDisplayContext tActual terminfoCaps

203+ , mkDisplayContext = (`terminfoDisplayContext` terminfoCaps)

193204 }

194205 sendCap s = sendCapToTerminal t (s terminfoCaps)

195206 maybeSendCap s = when (isJust $ s terminfoCaps) . sendCap (fromJust . s)

196207 return t

197208

198−requireCap :: (Applicative m, MonadIO m) => Terminfo.Terminal -> String -> m CapExpression

209+requireCap :: Terminfo.Terminal -> String -> IO CapExpression

199210requireCap ti capName

200211 = case Terminfo.getCapability ti (Terminfo.tiGetStr capName) of

201212 Nothing -> fail $ "Terminal does not define required capability \"" ++ capName ++ "\""

202213 Just capStr -> parseCap capStr

203214

204−probeCap :: (Applicative m, MonadIO m) => Terminfo.Terminal -> String -> m (Maybe CapExpression)

215+probeCap :: Terminfo.Terminal -> String -> IO (Maybe CapExpression)

205216probeCap ti capName

206217 = case Terminfo.getCapability ti (Terminfo.tiGetStr capName) of

207218 Nothing -> return Nothing

208219 Just capStr -> Just <$> parseCap capStr

209220

210−parseCap :: (Applicative m, MonadIO m) => String -> m CapExpression

221+parseCap :: String -> IO CapExpression

211222parseCap capStr = do

212223 case parseCapExpression capStr of

213224 Left e -> fail $ show e

214225 Right cap -> return cap

215226

216−currentDisplayAttrCaps :: ( Applicative m, MonadIO m )

217− => Terminfo.Terminal

218− -> m DisplayAttrCaps

227+currentDisplayAttrCaps :: Terminfo.Terminal -> IO DisplayAttrCaps

219228currentDisplayAttrCaps ti

220229 = pure DisplayAttrCaps

221230 <*> probeCap ti "sgr"

222231 <*> probeCap ti "smso"

223232 <*> probeCap ti "rmso"

233+ <*> probeCap ti "sitm"

234+ <*> probeCap ti "ritm"

235+ <*> probeCap ti "smxx"

236+ <*> probeCap ti "rmxx"

224237 <*> probeCap ti "smul"

225238 <*> probeCap ti "rmul"

226239 <*> probeCap ti "rev"

@@ -234,6 +247,13 @@ getWindowSize fd = do

234247 (a,b) <- (`divMod` 65536) `fmap` c_getWindowSize fd

235248 return (fromIntegral b, fromIntegral a)

236249

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+

237257terminfoDisplayContext :: Output -> TerminfoCaps -> DisplayRegion -> IO DisplayContext

238258terminfoDisplayContext tActual terminfoCaps r = return dc

239259 where dc = DisplayContext

@@ -247,15 +267,35 @@ terminfoDisplayContext tActual terminfoCaps r = return dc

247267 Nothing -> error "this terminal does not support hide cursor"

248268 Just c -> writeCapExpr c []

249269 , writeSetAttr = terminfoWriteSetAttr dc terminfoCaps

250− , writeDefaultAttr = writeCapExpr (setDefaultAttr terminfoCaps) []

270+ , writeDefaultAttr = \urlsEnabled ->

271+ 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+ )

251277 , writeRowEnd = writeCapExpr (clearEol terminfoCaps) []

252278 , inlineHack = return ()

253279 }

254280

281+-- | Write the escape sequences that are used in some terminals to

282+-- include embedded hyperlinks. As of yet, this information isn't

283+-- included in termcap or terminfo, so this writes them directly

284+-- instead of looking up the appropriate capabilities.

285+writeURLEscapes :: URLDiff -> Write

286+writeURLEscapes (LinkTo url) =

287+ foldMap writeStorable (BS.unpack "\x1b]8;;") `mappend`

288+ foldMap writeStorable (BS.unpack url) `mappend`

289+ writeStorable (0x07 :: Word8)

290+writeURLEscapes EndLink =

291+ foldMap writeStorable (BS.unpack "\x1b]8;;\a")

292+writeURLEscapes NoLinkChange =

293+ mempty

294+

255295-- | Portably setting the display attributes is a giant pain in the ass.

256296--

257297-- If the terminal supports the sgr capability (which sets the on/off

258−-- state of each style directly ; and, for no good reason, resets the

298+-- state of each style directly; and, for no good reason, resets the

259299-- colors to the default) this procedure is used:

260300--

261301-- 0. set the style attributes. This resets the fore and back color.

@@ -282,37 +322,36 @@ terminfoDisplayContext tActual terminfoCaps r = return dc

282322--

283323-- This equation implements the above logic.

284324--

285−-- \todo This assumes the removal of color changes in the display

286−-- attributes is done as expected with noColors == True. See

287−-- `limitAttrForDisplay`

325+-- Note that this assumes the removal of color changes in the

326+-- display attributes is done as expected with noColors == True. See

327+-- `limitAttrForDisplay`.

288328--

289−-- \todo This assumes that fewer state changes, followed by fewer

290−-- bytes, is what to optimize. I haven't measured this or even examined

291−-- terminal implementations. *shrug*

292−terminfoWriteSetAttr :: DisplayContext -> TerminfoCaps -> FixedAttr -> Attr -> DisplayAttrDiff -> Write

293−terminfoWriteSetAttr dc terminfoCaps prevAttr reqAttr diffs = do

294− case (foreColorDiff diffs == ColorToDefault) || (backColorDiff diffs == ColorToDefault) of

329+-- Note that this optimizes for fewer state changes followed by fewer

330+-- bytes.

331+terminfoWriteSetAttr :: DisplayContext -> TerminfoCaps -> Bool -> FixedAttr -> Attr -> DisplayAttrDiff -> Write

332+terminfoWriteSetAttr dc terminfoCaps urlsEnabled prevAttr reqAttr diffs =

333+ urlAttrs urlsEnabled `mappend` case (foreColorDiff diffs == ColorToDefault) || (backColorDiff diffs == ColorToDefault) of

295334 -- The only way to reset either color, portably, to the default

296335 -- is to use either the set state capability or the set default

297336 -- capability.

298− True -> do

337+ True -> do

299338 case reqDisplayCapSeqFor (displayAttrCaps terminfoCaps)

300− (fixedStyle attr )

339+ (fixedStyle attr)

301340 (styleToApplySeq $ fixedStyle attr) of

302341 -- only way to reset a color to the defaults

303− EnterExitSeq caps -> writeDefaultAttr dc

342+ EnterExitSeq caps -> writeDefaultAttr dc urlsEnabled

304343 `mappend`

305344 foldMap (\cap -> writeCapExpr cap []) caps

306345 `mappend`

307346 setColors

308347 -- implicitly resets the colors to the defaults

309348 SetState state -> writeCapExpr (fromJust $ setAttrStates

310− $ displayAttrCaps

311− $ terminfoCaps

349+ $ displayAttrCaps terminfoCaps

312350 )

313351 (sgrArgsForState state)

314− `mappend`

315− setColors

352+ `mappend` setItalics

353+ `mappend` setStrikethrough

354+ `mappend` setColors

316355 -- Otherwise the display colors are not changing or changing

317356 -- between two non-default points.

318357 False -> do

@@ -330,45 +369,99 @@ terminfoWriteSetAttr dc terminfoCaps prevAttr reqAttr diffs = do

330369 -- applied states.

331370 EnterExitSeq caps -> foldMap (\cap -> writeCapExpr cap []) caps

332371 `mappend`

333− writeColorDiff setForeColor (foreColorDiff diffs)

372+ writeColorDiff Foreground (foreColorDiff diffs)

334373 `mappend`

335− writeColorDiff setBackColor (backColorDiff diffs)

374+ writeColorDiff Background (backColorDiff diffs)

336375 -- implicitly resets the colors to the defaults

337376 SetState state -> writeCapExpr (fromJust $ setAttrStates

338377 $ displayAttrCaps terminfoCaps

339378 )

340379 (sgrArgsForState state)

380+ `mappend` setItalics

381+ `mappend` setStrikethrough

341382 `mappend` setColors

342383 where

384+ urlAttrs True = writeURLEscapes (urlDiff diffs)

385+ urlAttrs False = mempty

343386 colorMap = case useAltColorMap terminfoCaps of

344387 False -> ansiColorIndex

345388 True -> altColorIndex

346389 attr = fixDisplayAttr prevAttr reqAttr

390+

391+ -- italics can't be set via SGR, so here we manually

392+ -- apply the enter and exit sequences as needed after

393+ -- changing the SGR

394+ setItalics

395+ | hasStyle (fixedStyle attr) italic

396+ , Just sitm <- enterItalic (displayAttrCaps terminfoCaps)

397+ = writeCapExpr sitm []

398+ | otherwise = mempty

399+ setStrikethrough

400+ | hasStyle (fixedStyle attr) strikethrough

401+ , Just smxx <- enterStrikethrough (displayAttrCaps terminfoCaps)

402+ = writeCapExpr smxx []

403+ | otherwise = mempty

347404 setColors =

348405 (case fixedForeColor attr of

349− Just c -> writeCapExpr (setForeColor terminfoCaps)

350− [toEnum $ colorMap c]

406+ Just c -> writeColor Foreground c

351407 Nothing -> mempty)

352408 `mappend`

353409 (case fixedBackColor attr of

354− Just c -> writeCapExpr (setBackColor terminfoCaps)

355− [toEnum $ colorMap c]

410+ Just c -> writeColor Background c

356411 Nothing -> mempty)

357− writeColorDiff _f NoColorChange

412+ writeColorDiff _side NoColorChange

358413 = mempty

359− writeColorDiff _f ColorToDefault

414+ writeColorDiff _side ColorToDefault

360415 = error "ColorToDefault is not a possible case for applyColorDiffs"

361− writeColorDiff f (SetColor c)

362− = writeCapExpr (f terminfoCaps) [toEnum $ colorMap c]

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"

363452

364453-- | The color table used by a terminal is a 16 color set followed by a

365454-- 240 color set that might not be supported by the terminal.

366455--

367−-- This takes a Color which clearly identifies which pallete to use and

368−-- computes the index into the full 256 color pallete.

456+-- This takes a Color which clearly identifies which palette to use and

457+-- computes the index into the full 256 color palette.

369458ansiColorIndex :: Color -> Int

370459ansiColorIndex (ISOColor v) = fromEnum v

371460ansiColorIndex (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+ ]

372465

373466-- | For terminals without setaf/setab

374467--

@@ -385,6 +478,10 @@ altColorIndex (ISOColor 6) = 3

385478altColorIndex (ISOColor 7) = 7

386479altColorIndex (ISOColor v) = fromEnum v

387480altColorIndex (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+ ]

388485

389486{- | The sequence of terminfo caps to apply a given style are determined

390487 - according to these rules.

@@ -411,6 +508,8 @@ data DisplayAttrSeq

411508data DisplayAttrState = DisplayAttrState

412509 { applyStandout :: Bool

413510 , applyUnderline :: Bool

511+ , applyItalic :: Bool

512+ , applyStrikethrough :: Bool

414513 , applyReverseVideo :: Bool

415514 , applyBlink :: Bool

416515 , applyDim :: Bool

@@ -447,6 +546,10 @@ reqDisplayCapSeqFor caps s diffs

447546 -- set state cap then just use the set state cap.

448547 ( True, True ) -> SetState $ stateForStyle s

449548 where

549+ noEnterExitCap ApplyStrikethrough = isNothing $ enterStrikethrough caps

550+ noEnterExitCap RemoveStrikethrough = isNothing $ exitStrikethrough caps

551+ noEnterExitCap ApplyItalic = isNothing $ enterItalic caps

552+ noEnterExitCap RemoveItalic = isNothing $ exitItalic caps

450553 noEnterExitCap ApplyStandout = isNothing $ enterStandout caps

451554 noEnterExitCap RemoveStandout = isNothing $ exitStandout caps

452555 noEnterExitCap ApplyUnderline = isNothing $ enterUnderline caps

@@ -459,6 +562,10 @@ reqDisplayCapSeqFor caps s diffs

459562 noEnterExitCap RemoveDim = True

460563 noEnterExitCap ApplyBold = isNothing $ enterBoldMode caps

461564 noEnterExitCap RemoveBold = True

565+ enterExitCap ApplyStrikethrough = fromJust $ enterStrikethrough caps

566+ enterExitCap RemoveStrikethrough = fromJust $ exitStrikethrough caps

567+ enterExitCap ApplyItalic = fromJust $ enterItalic caps

568+ enterExitCap RemoveItalic = fromJust $ exitItalic caps

462569 enterExitCap ApplyStandout = fromJust $ enterStandout caps

463570 enterExitCap RemoveStandout = fromJust $ exitStandout caps

464571 enterExitCap ApplyUnderline = fromJust $ enterUnderline caps

@@ -472,6 +579,8 @@ stateForStyle :: Style -> DisplayAttrState

472579stateForStyle s = DisplayAttrState

473580 { applyStandout = isStyleSet standout

474581 , applyUnderline = isStyleSet underline

582+ , applyItalic = isStyleSet italic

583+ , applyStrikethrough = isStyleSet strikethrough

475584 , applyReverseVideo = isStyleSet reverseVideo

476585 , applyBlink = isStyleSet blink

477586 , applyDim = isStyleSet dim

@@ -483,10 +592,12 @@ styleToApplySeq :: Style -> [StyleStateChange]

483592styleToApplySeq s = concat

484593 [ applyIfRequired ApplyStandout standout

485594 , applyIfRequired ApplyUnderline underline

595+ , applyIfRequired ApplyItalic italic

596+ , applyIfRequired ApplyStrikethrough strikethrough

486597 , applyIfRequired ApplyReverseVideo reverseVideo

487598 , applyIfRequired ApplyBlink blink

488599 , applyIfRequired ApplyDim dim

489− , applyIfRequired ApplyBlink bold

600+ , applyIfRequired ApplyBold bold

490601 ]

491602 where

492603 applyIfRequired op flag

src/Graphics/Vty/Output/XTermColor.hs+51−34

@@ -1,40 +1,50 @@

1−{-# LANGUAGE CPP #-}

2−

3−#ifndef MIN_VERSION_base

4−#defined MIN_VERSION_base(x,y,z) 1

5−#endif

6−

1+{-# Language CPP #-}

8−module Graphics.Vty.Output.XTermColor ( reserveTerminal )

9− where

3+-- | Xterm output driver. This uses the Terminfo driver with some

4+-- extensions for Xterm.

5+module Graphics.Vty.Output.XTermColor

6+ ( reserveTerminal

7+ )

8+where

109

1110import Graphics.Vty.Output.Interface

1211import Graphics.Vty.Input.Mouse

12+import Graphics.Vty.Input.Focus

13+import Graphics.Vty.Attributes.Color (ColorMode)

1314import qualified Graphics.Vty.Output.TerminfoBased as TerminfoBased

1415

1516import Blaze.ByteString.Builder (writeToByteString)

1617import Blaze.ByteString.Builder.Word (writeWord8)

1718

19+import qualified Data.ByteString.Char8 as BS8

20+import Data.ByteString.Char8 (ByteString)

21+import Foreign.Ptr (castPtr)

22+

1823import Control.Monad (void, when)

1924import Control.Monad.Trans

25+import Data.Char (toLower)

2026import Data.IORef

2127

22−import System.Posix.IO (fdWrite)

23−import System.Posix.Types (Fd)

28+import System.Posix.IO (fdWriteBuf)

29+import System.Posix.Types (ByteCount, Fd)

2430import System.Posix.Env (getEnv)

2531

26−#if !(MIN_VERSION_base(4,8,0))

27−import Control.Applicative

28−import Data.Foldable (foldMap)

29−#endif

30−

3132import Data.List (isInfixOf)

3233import Data.Maybe (catMaybes)

34+

35+#if !MIN_VERSION_base(4,11,0)

3336import 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)

3444

35−-- | Initialize the display to UTF-8.

36−reserveTerminal :: ( Applicative m, MonadIO m ) => String -> Fd -> m Output

37−reserveTerminal variant outFd = liftIO $ do

45+-- | 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

3848 let flushedPut = void . fdWrite outFd

3949 -- If the terminal variant is xterm-color use xterm instead since,

4050 -- more often than not, xterm-color is broken.

@@ -42,15 +52,21 @@ reserveTerminal variant outFd = liftIO $ do

4252

4353 utf8a <- utf8Active

4454 when (not utf8a) $ flushedPut setUtf8CharSet

45− t <- TerminfoBased.reserveTerminal variant' outFd

55+ t <- TerminfoBased.reserveTerminal variant' outFd colorMode

4656

4757 mouseModeStatus <- newIORef False

58+ focusModeStatus <- newIORef False

4859 pasteModeStatus <- newIORef False

4960

5061 let xtermSetMode t' m newStatus = do

5162 curStatus <- getModeStatus t' m

5263 when (newStatus /= curStatus) $

5364 case m of

65+ Focus -> liftIO $ do

66+ case newStatus of

67+ True -> flushedPut requestFocusEvents

68+ False -> flushedPut disableFocusEvents

69+ writeIORef focusModeStatus newStatus

5470 Mouse -> liftIO $ do

5571 case newStatus of

5672 True -> flushedPut requestMouseEvents

@@ -61,9 +77,12 @@ reserveTerminal variant outFd = liftIO $ do

6177 True -> flushedPut enableBracketedPastes

6278 False -> flushedPut disableBracketedPastes

6379 writeIORef pasteModeStatus newStatus

80+ Hyperlink -> setMode t Hyperlink newStatus

6481

6582 xtermGetMode Mouse = liftIO $ readIORef mouseModeStatus

83+ xtermGetMode Focus = liftIO $ readIORef focusModeStatus

6684 xtermGetMode BracketedPaste = liftIO $ readIORef pasteModeStatus

85+ xtermGetMode Hyperlink = getModeStatus t Hyperlink

6786

6887 let t' = t

6988 { terminalID = terminalID t ++ " (xterm-color)"

@@ -71,6 +90,7 @@ reserveTerminal variant outFd = liftIO $ do

7190 when (not utf8a) $ liftIO $ flushedPut setDefaultCharSet

7291 setMode t' BracketedPaste False

7392 setMode t' Mouse False

93+ setMode t' Focus False

7494 releaseTerminal t

7595 , mkDisplayContext = \tActual r -> do

7696 dc <- mkDisplayContext t tActual r

@@ -84,30 +104,27 @@ reserveTerminal variant outFd = liftIO $ do

84104utf8Active :: IO Bool

85105utf8Active = do

86106 let vars = ["LC_ALL", "LANG", "LC_CTYPE"]

87− results <- catMaybes <$> mapM getEnv vars

88− let matches = filter ("UTF8" `isInfixOf`) results <>

89− filter ("UTF-8" `isInfixOf`) results

107+ results <- map (toLower <$>) . catMaybes <$> mapM getEnv vars

108+ let matches = filter ("utf8" `isInfixOf`) results <>

109+ filter ("utf-8" `isInfixOf`) results

90110 return $ not $ null matches

91111

92112-- | Enable bracketed paste mode:

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

94−enableBracketedPastes :: String

95−enableBracketedPastes = "\ESC[?2004h"

114+enableBracketedPastes :: ByteString

115+enableBracketedPastes = BS8.pack "\ESC[?2004h"

96116

97117-- | Disable bracketed paste mode:

98−disableBracketedPastes :: String

99−disableBracketedPastes = "\ESC[?2004l"

118+disableBracketedPastes :: ByteString

119+disableBracketedPastes = BS8.pack "\ESC[?2004l"

100120

101121-- | These sequences set xterm based terminals to UTF-8 output.

102122--

103−-- \todo I don't know of a terminfo cap that is equivalent to this.

104−setUtf8CharSet, setDefaultCharSet :: String

105−setUtf8CharSet = "\ESC%G"

106−setDefaultCharSet = "\ESC%@"

107−

108−-- | I think xterm is broken: Reseting the background color as the first

109−-- bytes serialized on a new line does not effect the background color

110−-- xterm uses to clear the line. Which is used *after* the next newline.

123+-- There is no known terminfo capability equivalent to this.

124+setUtf8CharSet, setDefaultCharSet :: ByteString

125+setUtf8CharSet = BS8.pack "\ESC%G"

126+setDefaultCharSet = BS8.pack "\ESC%@"

127+

111128xtermInlineHack :: Output -> IO ()

112129xtermInlineHack t = do

113130 let writeReset = foldMap (writeWord8.toEnum.fromEnum) "\ESC[K"

src/Graphics/Vty/Picture.hs+62−48

@@ -1,27 +1,36 @@

1−{-# LANGUAGE BangPatterns #-}

2−-- | The 'Picture' data structure is representative of the final

3−-- terminal view.

4−--

5−-- A 'Picture' is a background paired with a layer of 'Image's.

6−module Graphics.Vty.Picture ( module Graphics.Vty.Picture

7− , module Graphics.Vty.Image

8− )

9− where

1+-- A 'Picture' is a background paired with a set of 'Image' layers. The

2+-- 'Picture' data structure is representative of the final terminal

3+-- view.

4+module Graphics.Vty.Picture

5+ ( Picture(..)

6+ , Cursor(..)

7+ , Background(..)

8+ , emptyPicture

9+ , addToTop

10+ , addToBottom

11+ , picForImage

12+ , picForLayers

13+ , picImage

14+ )

15+where

1016

1117import Graphics.Vty.Image

18+import Graphics.Vty.Attributes

1219

1320import Control.DeepSeq

1421

15−-- | The type of images to be displayed using 'update'.

22+-- | A Vty picture.

1623--

17−-- Can be constructed directly or using `picForImage`. Which provides

18−-- an initial instance with reasonable defaults for picCursor and

19−-- picBackground.

24+-- These can be constructed directly or using `picForImage`.

2025data Picture = Picture

2126 { picCursor :: Cursor

27+ -- ^ The picture's cursor.

2228 , picLayers :: [Image]

29+ -- ^ The picture's image layers (top-most first).

2330 , picBackground :: Background

24− }

31+ -- ^ The picture's background to be displayed in locations with no

32+ -- Image data.

33+ } deriving Eq

2534

2635instance Show Picture where

2736 show (Picture _ layers _ ) = "Picture ?? " ++ show layers ++ " ??"

@@ -29,21 +38,21 @@ instance Show Picture where

2938instance NFData Picture where

3039 rnf (Picture c l b) = c `deepseq` l `deepseq` b `deepseq` ()

3140

32−-- | a picture with no cursor, background or image layers

41+-- | A picture with no cursor, background or image layers.

3342emptyPicture :: Picture

3443emptyPicture = Picture NoCursor [] ClearBackground

3544

36−-- | The given 'Image' is added as the top layer of the 'Picture'

45+-- | Add an 'Image' as the top-most layer of a 'Picture'.

3746addToTop :: Picture -> Image -> Picture

3847addToTop p i = p {picLayers = i : picLayers p}

3948

40−-- | The given 'Image' is added as the bottom layer of the 'Picture'

49+-- | Add an 'Image' as the bottom-most layer of a 'Picture'.

4150addToBottom :: Picture -> Image -> Picture

4251addToBottom p i = p {picLayers = picLayers p ++ [i]}

4352

44−-- | Create a picture for display for the given image. The picture

45−-- will not have a displayed cursor and no background pattern

46−-- (ClearBackground) will be used.

53+-- | Create a picture from the given image. The picture will not have a

54+-- displayed cursor and no background pattern (ClearBackground) will be

55+-- used.

4756picForImage :: Image -> Picture

4857picForImage i = Picture

4958 { picCursor = NoCursor

@@ -51,13 +60,10 @@ picForImage i = Picture

5160 , picBackground = ClearBackground

5261 }

5362

54−-- | Create a picture for display with the given layers. Ordered top to

55−-- bottom.

63+-- | Create a picture with the given layers, top-most first.

5664--

5765-- The picture will not have a displayed cursor and no background

58−-- apttern (ClearBackgroun) will be used.

59−--

60−-- The first 'Image' is the top layer.

66+-- pattern (ClearBackgroun) will be used.

6167picForLayers :: [Image] -> Picture

6268picForLayers is = Picture

6369 { picCursor = NoCursor

@@ -65,36 +71,40 @@ picForLayers is = Picture

6571 , picBackground = ClearBackground

6672 }

6773

68−-- | A picture can be configured either to not show the cursor or show

69−-- the cursor at the specified character position.

74+-- | A picture can be configured to hide the cursor or to show the

75+-- cursor at the specified character position.

7076--

71−-- There is not a 1 to 1 map from character positions to a row and

72−-- column on the screen due to characters that take more than 1 column.

73−--

74−-- todo: The Cursor can be given a (character,row) offset outside of the

75−-- visible bounds of the output region. In this case the cursor will not

76−-- be shown.

77+-- There is not a 1:1 map from character positions to a row and column

78+-- on the screen due to characters that take more than 1 column.

7779data Cursor =

78− -- | Hide the cursor

79− NoCursor

80− -- | Show the cursor at the given logical column accounting for

81− -- char width and row

80+ -- | Hide the cursor

81+ 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

90+ -- | Show the cursor at the given logical column accounting for

91+ -- character width in the presence of multi-column characters.

8292 | Cursor !Int !Int

83− -- | Show the cursor at the given absolute terminal column and row

93+ -- | Show the cursor at the given absolute terminal column and row

8494 | AbsoluteCursor !Int !Int

95+ deriving Eq

8596

8697instance NFData Cursor where

8798 rnf c = c `seq` ()

8899

89−-- | A 'Picture' has a background pattern. The background is either

90−-- ClearBackground. Which shows the layer below or is blank if the

91−-- bottom layer. Or the background pattern is a character and a display

92−-- attribute. If the display attribute used previously should be used

93−-- for a background fill then use `currentAttr` for the background

94−-- attribute.

100+-- | A 'Picture' has a background pattern. The background is either:

101+--

102+-- * ClearBackground, which shows the layer below or is blank if the

103+-- bottom layer

104+-- * A character and a display attribute

95105--

96−-- \todo The current attribute is always set to the default attributes

97−-- at the start of updating the screen to a picture.

106+-- If the display attribute used previously should be used for a

107+-- background fill then use `currentAttr` for the background attribute.

98108data Background

99109 = Background

100110 { backgroundChar :: Char

@@ -106,12 +116,16 @@ data Background

106116 --

107117 -- * End of line if there are no remaining non-skip ops.

108118 | ClearBackground

119+ deriving Eq

109120

110121instance NFData Background where

111122 rnf (Background c a) = c `seq` a `seq` ()

112123 rnf ClearBackground = ()

113124

114−-- | Compatibility with applications that do not use more than a single

115−-- layer.

125+-- | Return the top-most 'Image' layer for a picture. This is unsafe for

126+-- 'Picture's without at least one layer.

127+--

128+-- This is provided for compatibility with applications that do not use

129+-- more than a single layer.

116130picImage :: Picture -> Image

117131picImage = head . picLayers

src/Graphics/Vty/PictureToSpans.hs+16−50

@@ -1,21 +1,14 @@

11-- Copyright Corey O'Connor<coreyoconnor@gmail.com>

22{-# LANGUAGE BangPatterns #-}

3−{-# LANGUAGE CPP #-}

43{-# LANGUAGE ExistentialQuantification #-}

54{-# LANGUAGE NamedFieldPuns #-}

65{-# LANGUAGE RankNTypes #-}

76{-# LANGUAGE TemplateHaskell #-}

87

9−#ifndef MIN_VERSION_base

10−#defined MIN_VERSION_base(x,y,z) 1

11−#endif

12−

13−{- | Transforms an image into rows of operations.

14− -}

8+-- | Transforms an image into rows of operations.

159module Graphics.Vty.PictureToSpans where

1610

17−import Graphics.Vty.Prelude

18−

11+import Graphics.Vty.Attributes (Attr, currentAttr)

1912import Graphics.Vty.Image

2013import Graphics.Vty.Image.Internal

2114import Graphics.Vty.Picture

@@ -26,12 +19,7 @@ import Lens.Micro.Mtl

2619import Lens.Micro.TH

2720import Control.Monad.Reader

2821import Control.Monad.State.Strict hiding ( state )

29−

30−#if __GLASGOW_HASKELL__ < 708

31−import Control.Monad.ST.Strict hiding ( unsafeIOToST )

32−#else

3322import Control.Monad.ST.Strict

34−#endif

3523

3624import qualified Data.Vector as Vector hiding ( take, replicate )

3725import Data.Vector.Mutable ( MVector(..))

@@ -39,10 +27,6 @@ import qualified Data.Vector.Mutable as MVector

3927

4028import qualified Data.Text.Lazy as TL

4129

42−#if !(MIN_VERSION_base(4,8,0))

43−import Data.Monoid (mappend)

44−#endif

45−

4630type MRowOps s = MVector s SpanOps

4731

4832type MSpanOps s = MVector s SpanOp

@@ -88,19 +72,16 @@ displayOpsForPic pic r = Vector.create (combinedOpsForLayers pic r)

8872-- | Returns the DisplayOps for an image rendered to a window the size

8973-- of the image.

9074--

91−-- largerly used only for debugging.

75+-- largely used only for debugging.

9276displayOpsForImage :: Image -> DisplayOps

9377displayOpsForImage i = displayOpsForPic (picForImage i) (imageWidth i, imageHeight i)

9478

9579-- | Produces the span ops for each layer then combines them.

96−--

97−-- TODO: a fold over a builder function. start with span ops that are a

98−-- bg fill of the entire region.

9980combinedOpsForLayers :: Picture -> DisplayRegion -> ST s (MRowOps s)

10081combinedOpsForLayers pic r

10182 | regionWidth r == 0 || regionHeight r == 0 = MVector.new 0

10283 | otherwise = do

103− layerOps <- mapM (\layer -> buildSpans layer r) (picLayers pic)

84+ layerOps <- mapM (`buildSpans` r) (picLayers pic)

10485 case layerOps of

10586 [] -> fail "empty picture"

10687 [ops] -> substituteSkips (picBackground pic) ops

@@ -120,7 +101,6 @@ substituteSkips ClearBackground ops = do

120101 -- but only by the insertion of a non skip. all this combines to

121102 -- mean we can check the last operation and remove it if it's a

122103 -- skip

123− -- todo: or does it?

124104 let rowOps' = case Vector.last rowOps of

125105 Skip w -> Vector.init rowOps `Vector.snoc` RowEnd w

126106 _ -> rowOps

@@ -156,8 +136,8 @@ mergeUnder upper lower = do

156136 return upper

157137

158138mergeRowUnder :: SpanOps -> SpanOps -> SpanOps

159−mergeRowUnder upperRowOps lowerRowOps =

160− onUpperOp Vector.empty (Vector.head upperRowOps) (Vector.tail upperRowOps) lowerRowOps

139+mergeRowUnder upperRowOps =

140+ onUpperOp Vector.empty (Vector.head upperRowOps) (Vector.tail upperRowOps)

161141 where

162142 -- H: it will never be the case that we are out of upper ops

163143 -- before lower ops.

@@ -199,17 +179,12 @@ swapSkipsForCharSpan w c a = Vector.map f

199179-- picture to the terminal.

200180--

201181-- Crops to the given display region.

202−--

203−-- \todo I'm pretty sure there is an algorithm that does not require a

204−-- mutable buffer.

205182buildSpans :: Image -> DisplayRegion -> ST s (MRowOps s)

206183buildSpans image outRegion = do

207184 -- First we create a mutable vector for each rows output operations.

208185 outOps <- MVector.replicate (regionHeight outRegion) Vector.empty

209− -- \todo I think building the span operations in display order

210− -- would provide better performance. However, I got stuck trying to

211− -- implement an algorithm that did this. This will be considered as

212− -- a possible future optimization.

186+ -- It's possible that building the span operations in display order

187+ -- would provide better performance.

213188 --

214189 -- A depth first traversal of the image is performed. ordered

215190 -- according to the column range defined by the image from least

@@ -257,12 +232,10 @@ isOutOfBounds i s

257232-- This is a very touchy algorithm. Too touchy. For instance, the

258233-- CropRight and CropBottom implementations are odd. They pass the

259234-- current tests but something seems terribly wrong about all this.

260−--

261−-- \todo prove this cannot be called in an out of bounds case.

262235addMaybeClipped :: forall s . Image -> BlitM s ()

263236addMaybeClipped EmptyImage = return ()

264237addMaybeClipped (HorizText a textStr ow _cw) = do

265− -- TODO: assumption that text spans are only 1 row high.

238+ -- This assumes that text spans are only 1 row high.

266239 s <- use skipRows

267240 when (s < 1) $ do

268241 leftClip <- use skipColumns

@@ -325,12 +298,11 @@ addMaybeClippedJoin name skip remaining offset i0Dim i0 i1 size = do

325298 state <- get

326299 when (state^.remaining <= 0) $ fail $ name ++ " with remaining <= 0"

327300 case state^.skip of

328− s -- TODO: check if clipped in other dim. if not use addUnclipped

329− | s > size -> put $ state & skip -~ size

301+ s | s > size -> put $ state & skip %~ subtract size

330302 | s == 0 -> if state^.remaining > i0Dim

331303 then do

332304 addMaybeClipped i0

333− put $ state & offset +~ i0Dim & remaining -~ i0Dim

305+ put $ state & offset %~ (+ i0Dim) & remaining %~ subtract i0Dim

334306 addMaybeClipped i1

335307 else addMaybeClipped i0

336308 | s < i0Dim ->

@@ -339,10 +311,10 @@ addMaybeClippedJoin name skip remaining offset i0Dim i0 i1 size = do

339311 then addMaybeClipped i0

340312 else do

341313 addMaybeClipped i0

342− put $ state & offset +~ i0Dim' & remaining -~ i0Dim' & skip .~ 0

314+ put $ state & offset %~ (+ i0Dim') & remaining %~ subtract i0Dim' & skip .~ 0

343315 addMaybeClipped i1

344316 | s >= i0Dim -> do

345− put $ state & skip -~ i0Dim

317+ put $ state & skip %~ subtract i0Dim

346318 addMaybeClipped i1

347319 _ -> fail $ name ++ " has unhandled skip class"

348320

@@ -351,14 +323,14 @@ addUnclippedText a txt = do

351323 let op = TextSpan a usedDisplayColumns

352324 (fromIntegral $ TL.length txt)

353325 txt

354− usedDisplayColumns = wcswidth $ TL.unpack txt

326+ usedDisplayColumns = wctlwidth txt

355327 use rowOffset >>= snocOp op

356328

357329addRowCompletion :: DisplayRegion -> Int -> BlitM s ()

358330addRowCompletion displayRegion row = do

359331 allRowOps <- view mrowOps

360332 rowOps <- lift $ lift $ MVector.read allRowOps row

361− let endX = spanOpsEffectedColumns rowOps

333+ let endX = spanOpsAffectedColumns rowOps

362334 when (endX < regionWidth displayRegion) $ do

363335 let ow = regionWidth displayRegion - endX

364336 snocOp (Skip ow) row

@@ -371,12 +343,6 @@ snocOp !op !row = do

371343 lift $ lift $ do

372344 ops <- MVector.read theMrowOps row

373345 let ops' = Vector.snoc ops op

374− when (spanOpsEffectedColumns ops' > regionWidth theRegion)

346+ when (spanOpsAffectedColumns ops' > regionWidth theRegion)

375347 $ fail $ "row " ++ show row ++ " now exceeds region width"

376348 MVector.write theMrowOps row ops'

377−

378−(-~) :: Num a => ASetter s t a a -> a -> s -> t

379−l -~ n = over l (subtract n)

380−

381−(+~) :: Num a => ASetter s t a a -> a -> s -> t

382−l +~ n = over l (n +)

src/Graphics/Vty/Prelude.hsdeleted−18

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

1−-- | Prelude for Vty modules. Not particularly useful outside of Vty.

2−module Graphics.Vty.Prelude ( module Graphics.Vty.Prelude

3− , module Control.Applicative

4− , module Control.Monad

5− )

6−where

7−

8−import Control.Applicative hiding ((<|>))

9−import Control.Monad

10−

11−-- | Named alias for a Int pair

12−type DisplayRegion = (Int,Int)

13−

14−regionWidth :: DisplayRegion -> Int

15−regionWidth = fst

16−

17−regionHeight :: DisplayRegion -> Int

18−regionHeight = snd

src/Graphics/Vty/Span.hs+38−53

@@ -1,24 +1,15 @@

11-- Copyright Corey O'Connor

2−{-# LANGUAGE BangPatterns #-}

3−{-# LANGUAGE NamedFieldPuns #-}

42{-# LANGUAGE GADTs #-}

5−{- | A picture is translated into a sequences of state changes and

6− - character spans. State changes are currently limited to new attribute

7− - values. The attribute is applied to all following spans. Including

8− - spans of the next row. The nth element of the sequence represents the

9− - nth row (from top to bottom) of the picture to render.

10− -

11− - A span op sequence will be defined for all rows and columns (and no

12− - more) of the region provided with the picture to `spansForPic`.

13− -

14− - todo: Partition attribute changes into multiple categories according

15− - to the serialized representation of the various attributes.

16− -}

17−module Graphics.Vty.Span

18− where

19−

20−import Graphics.Vty.Prelude

3+-- | A picture is translated into a sequences of state changes and

4+-- character spans. The attribute is applied to all following spans,

5+-- including spans of the next row. The nth element of the sequence

6+-- represents the nth row (from top to bottom) of the picture to render.

7+--

8+-- A span op sequence will be defined for all rows and columns (and no

9+-- more) of the region provided with the picture to 'spansForPic'.

10+module Graphics.Vty.Span where

2111

12+import Graphics.Vty.Attributes (Attr)

2213import Graphics.Vty.Image

2314import Graphics.Vty.Image.Internal ( clipText )

2415

@@ -26,44 +17,40 @@ import qualified Data.Text.Lazy as TL

2617import Data.Vector (Vector)

2718import qualified Data.Vector as Vector

2819

29−-- | This represents an operation on the terminal. Either an attribute

20+-- | This represents an operation on the terminal: either an attribute

3021-- change or the output of a text string.

3122data SpanOp =

32− -- | a span of UTF-8 text occupies a specific number of screen space

33− -- columns. A single UTF character does not necessarially represent

34− -- 1 colunm. See Codec.Binary.UTF8.Width TextSpan [Attr] [output

35− -- width in columns] [number of characters] [data]

23+ -- | A span of UTF-8 text occupies a specific number of screen space

24+ -- columns. A single UTF character does not necessarily represent 1

25+ -- colunm. See Codec.Binary.UTF8.Width TextSpan [Attr] [output width

26+ -- in columns] [number of characters] [data]

3627 TextSpan

3728 { textSpanAttr :: !Attr

3829 , textSpanOutputWidth :: !Int

3930 , textSpanCharWidth :: !Int

4031 , textSpanText :: DisplayText

4132 }

42− -- | Skips the given number of columns

43− -- A skip is transparent.... maybe? I am not sure how attribute

44− -- changes interact.

45− -- todo: separate from this type.

33+ -- | Skips the given number of columns.

4634 | Skip !Int

47− -- | Marks the end of a row. specifies how many columns are

35+ -- | Marks the end of a row. Specifies how many columns are

4836 -- remaining. These columns will not be explicitly overwritten with

4937 -- the span ops. The terminal is require to assure the remaining

5038 -- columns are clear.

51− -- todo: separate from this type.

5239 | RowEnd !Int

5340 deriving Eq

5441

55−-- | vector of span operations. executed in succession. This represents

42+-- | A vector of span operations executed in succession. This represents

5643-- the operations required to render a row of the terminal. The

57−-- operations in one row may effect subsequent rows.

58−-- EG: Setting the foreground color in one row will effect all

59−-- subsequent rows until the foreground color is changed.

44+-- operations in one row may affect subsequent rows. For example,

45+-- setting the foreground color in one row will affect all subsequent

46+-- rows until the foreground color is changed.

6047type SpanOps = Vector SpanOp

6148

6249dropOps :: Int -> SpanOps -> SpanOps

6350dropOps w = snd . splitOpsAt w

6451

6552splitOpsAt :: Int -> SpanOps -> (SpanOps, SpanOps)

66−splitOpsAt inW inOps = splitOpsAt' inW inOps

53+splitOpsAt = splitOpsAt'

6754 where

6855 splitOpsAt' 0 ops = (Vector.empty, ops)

6956 splitOpsAt' remainingColumns ops = case Vector.head ops of

@@ -95,7 +82,7 @@ splitOpsAt inW inOps = splitOpsAt' inW inOps

9582 )

9683 RowEnd _ -> error "cannot split ops containing a row end"

9784

98−-- | vector of span operation vectors for display. One per row of the

85+-- | A vector of span operation vectors for display, one per row of the

9986-- output region.

10087type DisplayOps = Vector SpanOps

10188

@@ -104,41 +91,39 @@ instance Show SpanOp where

10491 show (Skip ow) = "Skip(" ++ show ow ++ ")"

10592 show (RowEnd ow) = "RowEnd(" ++ show ow ++ ")"

10693

107−-- | Number of columns the DisplayOps are defined for

94+-- | The number of columns the DisplayOps are defined for.

10895--

109−-- All spans are verified to define same number of columns. See:

110−-- VerifySpanOps

96+-- All spans are verified to define same number of columns.

11197displayOpsColumns :: DisplayOps -> Int

11298displayOpsColumns ops

11399 | Vector.length ops == 0 = 0

114100 | otherwise = Vector.length $ Vector.head ops

115101

116−-- | Number of rows the DisplayOps are defined for

102+-- | The number of rows the DisplayOps are defined for.

117103displayOpsRows :: DisplayOps -> Int

118−displayOpsRows ops = Vector.length ops

104+displayOpsRows = Vector.length

119105

120−effectedRegion :: DisplayOps -> DisplayRegion

121−effectedRegion ops = (displayOpsColumns ops, displayOpsRows ops)

106+affectedRegion :: DisplayOps -> DisplayRegion

107+affectedRegion ops = (displayOpsColumns ops, displayOpsRows ops)

122108

123−-- | The number of columns a SpanOps effects.

124−spanOpsEffectedColumns :: SpanOps -> Int

125−spanOpsEffectedColumns inOps = Vector.foldl' spanOpsEffectedColumns' 0 inOps

109+-- | The number of columns a SpanOps affects.

110+spanOpsAffectedColumns :: SpanOps -> Int

111+spanOpsAffectedColumns inOps = Vector.foldl' spanOpsAffectedColumns' 0 inOps

126112 where

127− spanOpsEffectedColumns' t (TextSpan _ w _ _ ) = t + w

128− spanOpsEffectedColumns' t (Skip w) = t + w

129− spanOpsEffectedColumns' t (RowEnd w) = t + w

113+ spanOpsAffectedColumns' t (TextSpan _ w _ _ ) = t + w

114+ spanOpsAffectedColumns' t (Skip w) = t + w

115+ spanOpsAffectedColumns' t (RowEnd w) = t + w

130116

131−-- | The width of a single SpanOp in columns

117+-- | The width of a single SpanOp in columns.

132118spanOpHasWidth :: SpanOp -> Maybe (Int, Int)

133119spanOpHasWidth (TextSpan _ ow cw _) = Just (cw, ow)

134120spanOpHasWidth (Skip ow) = Just (ow,ow)

135121spanOpHasWidth (RowEnd ow) = Just (ow,ow)

136122

137−-- | returns the number of columns to the character at the given

138−-- position in the span op

123+-- | The number of columns to the character at the given position in the

124+-- span op.

139125columnsToCharOffset :: Int -> SpanOp -> Int

140126columnsToCharOffset cx (TextSpan _ _ _ utf8Str) =

141− let str = TL.unpack utf8Str

142− in wcswidth (take cx str)

127+ wctlwidth (TL.take (fromIntegral cx) utf8Str)

143128columnsToCharOffset cx (Skip _) = cx

144129columnsToCharOffset cx (RowEnd _) = cx

src/Graphics/Vty/UnicodeWidthTable/IO.hsnew file+105

@@ -0,0 +1,105 @@

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.hsnew file+129

@@ -0,0 +1,129 @@

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.hsnew file+79

@@ -0,0 +1,79 @@

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.hsnew file+29

@@ -0,0 +1,29 @@

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/BenchImageFuzz.hs+1−3

@@ -8,8 +8,6 @@ import Verify

88import Control.Applicative

99import Control.Monad

1010

11−import Data.Default (def)

12−

1311import System.Random

1412

1513rand :: Arbitrary a => IO a

@@ -21,7 +19,7 @@ randomImage = rand

2119randomPicture = picForImage <$> randomImage

2220

2321bench0 = do

24− vty <- mkVty def

22+ vty <- mkVty defaultConfig

2523 (w,h) <- displayBounds $ outputIface vty

2624 let pictures = replicateM 3000 randomPicture

2725 bench ps = do

test/BenchNoDiffOpt.hs+1−2

@@ -9,7 +9,6 @@ import Control.Concurrent( threadDelay )

99import Control.Monad( liftM2 )

1010

1111import qualified Data.ByteString.Char8 as B

12−import Data.Default (def)

1312import Data.List

1413

1514import System.Environment( getArgs )

@@ -19,7 +18,7 @@ import System.Random

1918bench0 = do

2019 let fixedGen = mkStdGen 0

2120 setStdGen fixedGen

22− vty <- mkVty def

21+ vty <- mkVty defaultConfig

2322 (w,h) <- displayBounds $ outputIface vty

2423 let images = return $ (image0, image1)

2524 image0 = charFill defAttr 'X' w h

test/BenchRenderChar.hs+6−8

@@ -1,7 +1,7 @@

1−{- benchmarks composing images using the renderChar operation.

2− - This is what Yi uses in Yi.UI.Vty.drawText. Ideally a sequence of renderChar images horizontally

3− - composed should provide no worse performance than a fill render op.

4− -}

1+-- benchmarks composing images using the renderChar operation. This is

2+-- what Yi uses in Yi.UI.Vty.drawText. Ideally a sequence of renderChar

3+-- images horizontally composed should provide no worse performance than

4+-- a fill render op.

55module BenchRenderChar where

66

77import Graphics.Vty

@@ -9,10 +9,8 @@ import Verify

99

1010import Control.Monad ( forM_ )

1111

12−import Data.Default (def)

13−

1412bench0 = do

15− vty <- mkVty def

13+ vty <- mkVty defaultConfig

1614 (w,h) <- displayBounds $ outputIface vty

1715 let testChars = return $ take 500 $ cycle $ [ c | c <- ['a'..'z']]

1816 bench d = do

@@ -28,7 +26,7 @@ testImageUsingChar c w h

2826 $ horizCat $ map (char defAttr) (replicate (fromIntegral w) c)

2927

3028bench1 = do

31− vty <- mkVty def

29+ vty <- mkVty defaultConfig

3230 (w,h) <- displayBounds $ outputIface vty

3331 let testChars = return $ take 500 $ cycle $ [ c | c <- ['a'..'z']]

3432 bench d = do

test/BenchVerticalScroll.hs+1−2

@@ -6,7 +6,6 @@ import Verify

66import Control.Concurrent( threadDelay )

77import Control.Monad( liftM2 )

88

9−import Data.Default (def)

109import Data.List

1110import Data.Word

1211

@@ -17,7 +16,7 @@ import System.Random

1716bench0 = do

1817 let fixedGen = mkStdGen 0

1918 setStdGen fixedGen

20− return $ Bench (return ()) (\() -> mkVty def >>= liftM2 (>>) run shutdown)

19+ return $ Bench (return ()) (\() -> mkVty defaultConfig >>= liftM2 (>>) run shutdown)

2120

2221run vt = mapM_ (\p -> update vt p) . benchgen =<< displayBounds (outputIface vt)

2322

test/EventEcho.hs+1−2

@@ -6,7 +6,6 @@ import Control.Applicative

66import Control.Arrow

77import Control.Monad.RWS

88

9−import Data.Default (def)

109import Data.Sequence (Seq, (<|) )

1110import qualified Data.Sequence as Seq

1211import Data.Foldable

@@ -16,7 +15,7 @@ eventBufferSize = 1000

1615type App = RWST Vty () (Seq String) IO

1716

1817main = do

19− vty <- mkVty def

18+ vty <- mkVty defaultConfig

2019 _ <- execRWST (vtyInteract False) vty Seq.empty

2120 shutdown vty

2221

test/HereDoc.hs+2−4

@@ -1,8 +1,7 @@

11{-# LANGUAGE QuasiQuotes #-}

22{-# LANGUAGE TemplateHaskell #-}

3−{- From http://www.reddit.com/r/haskell/comments/8ereh/a_here_document_syntax/

4− - copyright unknown?

5− -}

3+-- From http://www.reddit.com/r/haskell/comments/8ereh/a_here_document_syntax/

4+-- copyright unknown?

65module HereDoc (heredoc) where

76

87import Language.Haskell.TH.Quote

@@ -11,4 +10,3 @@ import Language.Haskell.TH.Lib

1110

1211heredoc :: QuasiQuoter

1312heredoc = QuasiQuoter (litE . stringL) (litP . stringL) undefined undefined

14−

test/Issue18.hs+1−2

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

1−module Main

2− where

1+module Main where

32

43import Graphics.Vty

54import Graphics.Vty.Debug

test/MinimalExample.hs+1−3

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

22

33import Graphics.Vty

44

5−import Data.Default

6−

75main = do

8− vty <- mkVty def

6+ vty <- mkVty defaultConfig

97 let line0 = string (def `withForeColor` green) "first line"

108 line1 = string (def `withBackColor` blue) "second line"

119 img = line0 <-> line1

test/Rogue.hs+1−3

@@ -1,10 +1,8 @@

1−{-# LANGUAGE TemplateHaskell #-}

21module Main where

32

43import Graphics.Vty

54

65import Data.Array

7−import Data.Default (def)

86

97import Control.Applicative

108import Control.Monad

@@ -43,7 +41,7 @@ type Coord = (Int, Int)

4341

4442main :: IO ()

4543main = do

46− vty <- mkVty def

44+ vty <- mkVty defaultConfig

4745 level0 <- mkLevel 1

4846 let world0 = World (Player (levelStart level0)) level0

4947 (_finalWorld, ()) <- execRWST play vty world0

test/Test2.hs+1

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

11module Main where

2+

23import Graphics.Vty

34

45main = do

test/Verify.hs+18−28

@@ -1,29 +1,29 @@

11{-# LANGUAGE RankNTypes #-}

22{-# LANGUAGE GADTs #-}

33{-# LANGUAGE RecordWildCards #-}

4−{-# LANGUAGE CPP #-}

54{-# LANGUAGE TypeSynonymInstances #-}

65{-# LANGUAGE FlexibleInstances #-}

76{-# LANGUAGE StandaloneDeriving #-}

87{-# LANGUAGE DisambiguateRecordFields #-}

98{-# LANGUAGE NamedFieldPuns #-}

10−module Verify ( module Verify

11− , module Control.Applicative

12− , module Control.DeepSeq

13− , module Control.Exception

14− , module Control.Monad

15− , module Test.QuickCheck

16− , module Test.QuickCheck.Modifiers

17− , module Text.Printf

18− , succeeded

19− , failed

20− , monadicIO

21− , liftIO

22− , liftBool

23− , Test(..)

24− , Prop.Result(..)

25− )

26− where

9+module Verify

10+ ( module Verify

11+ , module Control.Applicative

12+ , module Control.DeepSeq

13+ , module Control.Exception

14+ , module Control.Monad

15+ , module Test.QuickCheck

16+ , module Test.QuickCheck.Modifiers

17+ , module Text.Printf

18+ , succeeded

19+ , failed

20+ , monadicIO

21+ , liftIO

22+ , liftBool

23+ , Test(..)

24+ , Prop.Result(..)

25+ )

26+where

2727

2828import Control.Exception ( bracket, try, SomeException(..) )

2929

@@ -85,15 +85,5 @@ instance Arbitrary DoubleColumnChar where

8585liftIOResult :: Testable prop => IO prop -> Property

8686liftIOResult = ioProperty

8787

88−#if __GLASGOW_HASKELL__ <= 701

89−instance Random Word where

90− random g =

91− let (i :: Int, g') = random g

92− in (toEnum i, g')

93− randomR (l,h) g =

94− let (i :: Int, g') = randomR (fromEnum l,fromEnum h) g

95− in (toEnum i, g')

96−#endif

97−

9888data Bench where

9989 Bench :: forall v . NFData v => IO v -> (v -> IO ()) -> Bench

test/Verify/Data/Terminfo/Parse.hs+5−4

@@ -1,7 +1,8 @@

1−module Verify.Data.Terminfo.Parse ( module Verify.Data.Terminfo.Parse

2− , module Data.Terminfo.Parse

3− )

4− where

1+module Verify.Data.Terminfo.Parse

2+ ( module Verify.Data.Terminfo.Parse

3+ , module Data.Terminfo.Parse

4+ )

5+where

56

67import Data.Terminfo.Parse

78import Data.Terminfo.Eval

test/Verify/Graphics/Vty/Attributes.hs+5−4

@@ -1,7 +1,8 @@

1−module Verify.Graphics.Vty.Attributes ( module Verify.Graphics.Vty.Attributes

2− , module Graphics.Vty.Attributes

3− )

4− where

1+module Verify.Graphics.Vty.Attributes

2+ ( module Verify.Graphics.Vty.Attributes

3+ , module Graphics.Vty.Attributes

4+ )

5+where

56

67import Graphics.Vty.Attributes

78import Verify

test/Verify/Graphics/Vty/DisplayAttributes.hs+5−5

@@ -1,8 +1,8 @@

1−module Verify.Graphics.Vty.DisplayAttributes ( module Verify.Graphics.Vty.DisplayAttributes

2− , module Graphics.Vty.DisplayAttributes

3− )

4− where

1+module Verify.Graphics.Vty.DisplayAttributes

2+ ( module Verify.Graphics.Vty.DisplayAttributes

3+ , module Graphics.Vty.DisplayAttributes

4+ )

5+where

56

67import Graphics.Vty.DisplayAttributes

78import Verify

8−

test/Verify/Graphics/Vty/Image.hs+5−4

@@ -1,10 +1,11 @@

11{-# LANGUAGE BangPatterns #-}

22{-# LANGUAGE NamedFieldPuns #-}

33{-# LANGUAGE DisambiguateRecordFields #-}

4−module Verify.Graphics.Vty.Image ( module Verify.Graphics.Vty.Image

5− , module Graphics.Vty.Image

6− )

7− where

4+module Verify.Graphics.Vty.Image

5+ ( module Verify.Graphics.Vty.Image

6+ , module Graphics.Vty.Image

7+ )

8+where

89

910import Verify.Graphics.Vty.Attributes

1011import Graphics.Vty.Image

test/Verify/Graphics/Vty/Output.hs−1

@@ -4,7 +4,6 @@ import Control.Applicative ((<$>))

44

55import Graphics.Vty.Output.Mock

66

7−import qualified Data.ByteString as BS

87import Data.IORef

98import qualified Data.String.UTF8 as UTF8

109

test/Verify/Graphics/Vty/Picture.hs+5−4

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

11{-# LANGUAGE DisambiguateRecordFields #-}

2−module Verify.Graphics.Vty.Picture ( module Verify.Graphics.Vty.Picture

3− , module Graphics.Vty.Picture

4− )

5− where

2+module Verify.Graphics.Vty.Picture

3+ ( module Verify.Graphics.Vty.Picture

4+ , module Graphics.Vty.Picture

5+ )

6+where

67

78import Verify.Graphics.Vty.Prelude

89

test/Verify/Graphics/Vty/Prelude.hs+5−7

@@ -1,10 +1,8 @@

1−module Verify.Graphics.Vty.Prelude ( module Verify.Graphics.Vty.Prelude

2− , module Graphics.Vty.Prelude

3− , MockWindow(..)

4− )

5− where

6−

7−import Graphics.Vty.Prelude

1+module Verify.Graphics.Vty.Prelude

2+ ( module Verify.Graphics.Vty.Prelude

3+ , MockWindow(..)

4+ )

5+where

86

97import Graphics.Vty.Debug

108

test/Verify/Graphics/Vty/Span.hs+6−5

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

11{-# LANGUAGE FlexibleInstances #-}

2−module Verify.Graphics.Vty.Span ( module Verify.Graphics.Vty.Span

3− , module Graphics.Vty.Span

4− )

5− where

2+module Verify.Graphics.Vty.Span

3+ ( module Verify.Graphics.Vty.Span

4+ , module Graphics.Vty.Span

5+ )

6+where

67

78import Graphics.Vty.Debug

89import Graphics.Vty.Span

@@ -19,7 +20,7 @@ isAttrSpanOp TextSpan {} = True

1920isAttrSpanOp _ = False

2021

2122verifyAllSpansHaveWidth i spans w

22− = let v = map (\s -> (spanOpsEffectedColumns s /= w, s)) (Vector.toList spans)

23+ = let v = map (\s -> (spanOpsAffectedColumns s /= w, s)) (Vector.toList spans)

2324 in case any ((== True) . fst) v of

2425 False -> succeeded

2526 True -> failed { reason = "Not all spans contained operations defining exactly "

test/VerifyAttributeOps.hsdeleted−9

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

1−module VerifyAttributeOps where

2−

3−import Verify.Graphics.Vty.Attributes

4−

5−import Verify

6−

7−tests :: IO [Test]

8−tests = return []

9−

test/VerifyColor240.hsnew file+269

@@ -0,0 +1,269 @@

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/VerifyConfig.hs+1−3

@@ -4,7 +4,6 @@ module Main where

44import Graphics.Vty.Config

55import Graphics.Vty.Input.Events

66

7−import Data.Default

87import Data.String.QQ

98import qualified Data.ByteString.Char8 as B

109

@@ -24,7 +23,7 @@ debugLog "/tmp/vty-debug.txt"

2423|]

2524

2625exampleConfigConfig :: Config

27−exampleConfigConfig = def

26+exampleConfigConfig = defaultConfig

2827 { debugLog = Just "/tmp/vty-debug.txt"

2928 , inputMap = [ (Nothing, "\ESC[B", EvKey KUp [])

3029 , (Nothing, "\ESC[1;3B", EvKey KDown [MAlt])

@@ -43,4 +42,3 @@ main :: IO ()

4342main = defaultMain

4443 [ testCase "example config parses" $ exampleConfigParses

4544 ]

46−

test/VerifyEmptyImageProps.hs+2−1

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

1+{-# LANGUAGE ScopedTypeVariables #-}

12module VerifyEmptyImageProps where

23

34import Verify

45

56-- should be exported by Graphics.Vty.Picture

6−import Graphics.Vty.Picture ( Image, emptyImage )

7+import Graphics.Vty.Image ( Image, emptyImage )

78

89tests :: IO [Test]

910tests = do

test/VerifyEvalTerminfoCaps.hs+1

@@ -1,5 +1,6 @@

11{-# LANGUAGE BangPatterns #-}

22{-# LANGUAGE NamedFieldPuns #-}

3+{-# LANGUAGE ScopedTypeVariables #-}

34module VerifyEvalTerminfoCaps where

45

56import Blaze.ByteString.Builder.Internal.Write (runWrite, getBound)

test/VerifyImageOps.hs+2−1

@@ -1,3 +1,4 @@

1+{-# LANGUAGE ScopedTypeVariables #-}

12module VerifyImageOps where

23

34import Graphics.Vty.Attributes

@@ -136,7 +137,7 @@ cropBottomLimitsHeight :: Image -> Int -> Property

136137cropBottomLimitsHeight i v = v >= 0 ==>

137138 v >= imageHeight (cropBottom v i)

138139

139−-- rediculous tests just to satisfy my desire for nice code coverage :-P

140+-- ridiculous tests just to satisfy my desire for nice code coverage :-P

140141canShowImage :: Image -> Bool

141142canShowImage i = length (show i) > 0

142143

test/VerifyLayersSpanGeneration.hs+1

@@ -4,6 +4,7 @@ module VerifyLayersSpanGeneration where

44

55import Verify.Graphics.Vty.Prelude

66

7+import Verify.Graphics.Vty.Attributes

78import Verify.Graphics.Vty.Image

89import Verify.Graphics.Vty.Picture

910import Verify.Graphics.Vty.Span

test/VerifyOutput.hs+10−8

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

1−{- We setup the environment to envoke certain terminals of interest.

2− - This assumes appropriate definitions exist in the current environment

3− - for the terminals of interest.

4− -}

1+-- We setup the environment to invoke certain terminals of interest.

2+-- This assumes appropriate definitions exist in the current environment

3+-- for the terminals of interest.

4+{-# LANGUAGE ScopedTypeVariables #-}

55module VerifyOutput where

6+

67import Verify

78

89import Graphics.Vty

@@ -12,10 +13,7 @@ import Verify.Graphics.Vty.Output

1213

1314import Control.Monad

1415

15−import Data.Default

16−

1716import qualified System.Console.Terminfo as Terminfo

18−import System.Posix.Env

1917import System.Posix.IO

2018

2119tests :: IO [Test]

@@ -37,7 +35,11 @@ smokeTestTermNonMac termName i = liftIOResult $ do

3735smokeTestTerm :: String -> Image -> IO Result

3836smokeTestTerm termName i = do

3937 nullOut <- openFd "/dev/null" WriteOnly Nothing defaultFileFlags

40− t <- outputForConfig $ def { outputFd = Just nullOut, termName = Just termName }

38+ t <- outputForConfig $ defaultConfig

39+ { outputFd = Just nullOut

40+ , termName = Just termName

41+ , colorMode = Just NoColor

42+ }

4143 -- putStrLn $ "context color count: " ++ show (contextColorCount t)

4244 reserveDisplay t

4345 dc <- displayContext t (100,100)

test/VerifyParseTerminfoCaps.hs+1

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

11{-# LANGUAGE NamedFieldPuns #-}

2+{-# LANGUAGE ScopedTypeVariables #-}

23module VerifyParseTerminfoCaps where

34

45import 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 ( spanOpsEffectedRows ops == 0 ) && ( allSpansHaveWidth ops 0 )

28+ in ( spanOpsAffectedRows 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 ( spanOpsEffectedRows ops == 0 ) && ( allSpansHaveWidth ops 0 )

40+ in ( spanOpsAffectedRows 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 spanOpsEffectedRows ops == 1

54+ in spanOpsAffectedRows 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 = spanOpsEffectedRows ops

77+ actualRowCount = spanOpsAffectedRows 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 = spanOpsEffectedRows ops

93+ actualRowCount = spanOpsAffectedRows 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 = spanOpsEffectedRows ops

110+ actualRowCount = spanOpsAffectedRows 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 ( spanOpsEffectedRows ops == h ) && ( allSpansHaveWidth ops w )

126+ in ( spanOpsAffectedRows 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 = spanOpsEffectedRows ops

132+ actualRowCount = spanOpsAffectedRows ops

133133 in expectedRowCount == actualRowCount

134134

135135spanOpsActuallyFillColumns :: DefaultPic -> Bool

test/VerifyUsingMockInput.hs+19−19

@@ -1,8 +1,8 @@

11{-# LANGUAGE MultiParamTypeClasses #-}

22{-# LANGUAGE FlexibleInstances #-}

3−{- Generate some input bytes and delays between blocks of input bytes.

4− - Verify the events produced are as expected.

5− -}

3+{-# LANGUAGE ScopedTypeVariables #-}

4+-- Generate some input bytes and delays between blocks of input bytes.

5+-- Verify the events produced are as expected.

66module Main where

77

88import Verify.Graphics.Vty.Output

@@ -12,14 +12,12 @@ import Graphics.Vty.Input.Events

1212import Graphics.Vty.Input.Loop

1313import Graphics.Vty.Input.Terminfo

1414

15−import Control.Applicative

1615import Control.Concurrent

1716import Control.Concurrent.STM

1817import Control.Exception

1918import Lens.Micro ((^.))

2019import Control.Monad

2120

22−import Data.Default

2321import Data.IORef

2422import Data.List (intersperse, reverse, nubBy)

2523

@@ -115,11 +113,11 @@ assertEventsFromSynInput table inputSpec expectedEvents = do

115113 (writeFd, readFd) <- openPseudoTerminal

116114 (setTermAttr,_) <- attributeControl readFd

117115 setTermAttr

118− let testConfig = def { inputFd = Just readFd

119− , termName = Just "dummy"

120− , vmin = Just 1

121− , vtime = Just 100

122− }

116+ let testConfig = defaultConfig { inputFd = Just readFd

117+ , termName = Just "dummy"

118+ , vmin = Just 1

119+ , vtime = Just 100

120+ }

123121 input <- initInput testConfig table

124122 eventsRef <- newIORef []

125123 let writeWaitClose = do

@@ -134,7 +132,9 @@ assertEventsFromSynInput table inputSpec expectedEvents = do

134132 readLoop 0 = return ()

135133 readLoop n = do

136134 e <- atomically $ readTChan $ input^.eventChannel

137− modifyIORef eventsRef ((:) e)

135+ case e of

136+ InputEvent ev -> modifyIORef eventsRef ((:) ev)

137+ ResumeAfterSignal -> return ()

138138 readLoop (n - 1)

139139 genEventsUsingIoActions maxDuration writeWaitClose readEvents

140140 outEvents <- reverse <$> readIORef eventsRef

@@ -167,8 +167,8 @@ verifyVisibleSynInputToEvent = forAll $ \(InputBlocksUsingTable gen) -> monadic

167167

168168verifyCapsSynInputToEvent :: Property IO

169169verifyCapsSynInputToEvent = forAll $ \(InputBlocksUsingTable gen) ->

170− forEachOf terminalsOfInterest $ \termName -> monadic $ do

171− term <- setupTerm termName

170+ forEachOf terminalsOfInterest $ \terminalName -> monadic $ do

171+ term <- setupTerm terminalName

172172 let table = capsClassifyMap term keysFromCapsTable

173173 inputSeq = gen table

174174 events = map snd inputSeq

@@ -187,9 +187,9 @@ verifySpecialSynInputToEvent = forAll $ \(InputBlocksUsingTable gen) -> monadic

187187

188188verifyFullSynInputToEvent :: Property IO

189189verifyFullSynInputToEvent = forAll $ \(InputBlocksUsingTable gen) ->

190− forEachOf terminalsOfInterest $ \termName -> monadic $ do

191− term <- setupTerm termName

192− let table = classifyMapForTerm termName term

190+ forEachOf terminalsOfInterest $ \terminalName -> monadic $ do

191+ term <- setupTerm terminalName

192+ let table = classifyMapForTerm terminalName term

193193 inputSeq = gen table

194194 events = map snd inputSeq

195195 keydowns = map (Bytes . fst) inputSeq

@@ -198,9 +198,9 @@ verifyFullSynInputToEvent = forAll $ \(InputBlocksUsingTable gen) ->

198198

199199verifyFullSynInputToEvent_2x :: Property IO

200200verifyFullSynInputToEvent_2x = forAll $ \(InputBlocksUsingTable gen) ->

201− forEachOf terminalsOfInterest $ \termName -> monadic $ do

202− term <- setupTerm termName

203− let table = classifyMapForTerm termName term

201+ forEachOf terminalsOfInterest $ \terminalName -> monadic $ do

202+ term <- setupTerm terminalName

203+ let table = classifyMapForTerm terminalName term

204204 inputSeq = gen table

205205 events = concatMap ((\s -> [s,s]) . snd) inputSeq

206206 keydowns = map (Bytes . (\s -> s ++ s) . fst) inputSeq

test/VerifyUsingMockTerminal.hs+2

@@ -4,9 +4,11 @@ import Verify.Graphics.Vty.Prelude

44

55import Verify.Graphics.Vty.Picture

66import Verify.Graphics.Vty.Image

7+import Verify.Graphics.Vty.Attributes

78import Verify.Graphics.Vty.Span

89import Verify.Graphics.Vty.Output

910import Graphics.Vty.Output

11+import Graphics.Vty.Output.Interface

1012import Graphics.Vty.Output.Mock

1113

1214import Graphics.Vty.Debug

test/VerifyUtf8Width.hs+2

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

11module VerifyUtf8Width where

2+

23import Verify

34

45import Graphics.Text.Width

56import Graphics.Vty.Attributes

67import Graphics.Vty.Picture

8+import Graphics.Vty.Image

79

810swIs1Column :: SingleColumnChar -> Bool

911swIs1Column (SingleColumnChar c) = imageWidth (char defAttr c) == 1

test/YiIssue264.hs+1

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

11module Main where

2+

23import Graphics.Vty

34import Control.Exception

45

test/interactive_terminal_test.hs+2−3

@@ -12,7 +12,6 @@ import Control.Concurrent (threadDelay)

1212import Control.Exception

1313import Control.Monad

1414

15−import Data.Default (def)

1615import Data.List ( lookup )

1716import Data.Maybe ( isJust, fromJust )

1817import Data.Monoid

@@ -365,7 +364,7 @@ Did the test output match the description?

365364|]

366365 defaultSuccessConfirmResults

367366

368−-- Explicitely definethe bytes that encode each example text.

367+-- Explicitly define the bytes that encode each example text.

369368-- This avoids any issues with how the compiler represents string literals.

370369--

371370-- This document is UTF-8 encoded so the UTF-8 string is still included for

@@ -938,7 +937,7 @@ cursorHideTest0 = Test

938937 { testName = "Verify the cursor is hid and re-shown. issue #7"

939938 , testID = "cursorHideTest0"

940939 , testAction = do

941− vty <- mkVty def

940+ vty <- mkVty defaultConfig

942941 showCursor $ outputIface vty

943942 setCursorPos (outputIface vty) 5 5

944943 nextEvent vty

test/vty-examples.cabal+5−5

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

11name: vty-examples

2−version: 5.6

2+version: 5.7

33license: BSD3

44license-file: LICENSE

55author: AUTHORS

@@ -41,7 +41,7 @@ executable vty-interactive-terminal-test

4141 default-extensions: ScopedTypeVariables

4242 ghc-options: -threaded

4343

44− build-depends: vty >= 5.2.11,

44+ build-depends: vty >= 5.15,

4545 base >= 4 && < 5,

4646 bytestring,

4747 containers,

@@ -69,7 +69,7 @@ executable vty-event-echo

6969 FlexibleContexts

7070 ghc-options: -threaded

7171

72− build-depends: vty >= 5.2.11,

72+ build-depends: vty >= 5.15,

7373 base >= 4 && < 5,

7474 array,

7575 bytestring,

@@ -89,7 +89,7 @@ executable vty-rogue

8989 default-extensions: ScopedTypeVariables

9090 ghc-options: -threaded

9191

92− build-depends: vty >= 5.2.11,

92+ build-depends: vty >= 5.15,

9393 base >= 4 && < 5,

9494 array,

9595 bytestring,

@@ -110,7 +110,7 @@ executable vty-benchmark

110110 default-extensions: ScopedTypeVariables

111111 ghc-options: -threaded

112112

113− build-depends: vty >= 5.2.11,

113+ build-depends: vty >= 5.15,

114114 base >= 4 && < 5,

115115 bytestring,

116116 Cabal,

tools/BuildWidthTable.hsnew file+144

@@ -0,0 +1,144 @@

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+100−98

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

11name: vty

2−version: 5.14

2+version: 5.35.1

33license: BSD3

44license-file: LICENSE

55author: AUTHORS

@@ -12,26 +12,25 @@ description:

1212 be easy to use, have no confusing corner cases, and good support for

1313 common terminal types.

1414 .

15− Included in the source distribution is a program

16− test/interactive_terminal_test.hs that demonstrates the various

17− features.

15+ See the @vty-examples@ package as well as the program

16+ @test/interactive_terminal_test.hs@ included in the @vty@ package for

17+ examples on how to use the library.

1818 .

19− Developers: See the "Graphics.Vty" module.

20− .

21− Users: See the "Graphics.Vty.Config" module.

19+ Import the "Graphics.Vty" convenience module to get access to the core

20+ parts of the library.

2221 .

2423 .

2625 .

28−cabal-version: >= 1.18

27+cabal-version: 1.18

2928build-type: Simple

30−data-files: README.md,

29+extra-doc-files: README.md,

3130 AUTHORS,

3231 CHANGELOG.md,

3332 LICENSE

34−tested-with: GHC >= 7.6.2

33+tested-with: GHC==7.10.3, GHC==8.0.2, GHC==8.2.2, GHC==8.4.3, GHC==8.6.5

3534

3635source-repository head

3736 type: git

@@ -39,18 +38,16 @@ source-repository head

3938

4039library

4140 default-language: Haskell2010

42− build-depends: base >= 4.6 && < 5,

41+ build-depends: base >= 4.8 && < 5,

4342 blaze-builder >= 0.3.3.2 && < 0.5,

4443 bytestring,

4544 containers,

46− data-default >= 0.5.3,

4745 deepseq >= 1.1 && < 1.5,

4846 directory,

4947 filepath >= 1.0 && < 2.0,

50− microlens,

48+ microlens < 0.4.13,

5149 microlens-mtl,

5250 microlens-th,

53− -- required for nice installation with yi

5451 hashable >= 1.2,

5552 mtl >= 1.1.1.0 && < 2.3,

5653 parallel >= 2.2 && < 3.3,

@@ -61,10 +58,18 @@ library

6158 text >= 0.11.3,

6259 unix,

6360 utf8-string >= 0.3 && < 1.1,

64− vector >= 0.7

61+ vector >= 0.7,

62+ binary,

63+ ansi-terminal >= 0.10.3

64+

65+ if !impl(ghc >= 8.0)

66+ build-depends: semigroups >= 0.16,

67+ fail

6568

6669 exposed-modules: Graphics.Vty

6770 Graphics.Vty.Attributes

71+ Graphics.Vty.Attributes.Color

72+ Graphics.Vty.Attributes.Color240

6873 Graphics.Vty.Config

6974 Graphics.Vty.Error

7075 Graphics.Vty.Image

@@ -73,10 +78,8 @@ library

7378 Graphics.Vty.Input

7479 Graphics.Vty.Input.Events

7580 Graphics.Vty.Picture

76− Graphics.Vty.Prelude

7781 Graphics.Vty.Output

7882 Graphics.Text.Width

79− -- the modules below are only meant to be used by the tests.

8083 Codec.Binary.UTF8.Debug

8184 Data.Terminfo.Parse

8285 Data.Terminfo.Eval

@@ -88,6 +91,7 @@ library

8891 Graphics.Vty.Input.Classify.Parse

8992 Graphics.Vty.Input.Loop

9093 Graphics.Vty.Input.Mouse

94+ Graphics.Vty.Input.Focus

9195 Graphics.Vty.Input.Paste

9296 Graphics.Vty.Input.Terminfo

9397 Graphics.Vty.PictureToSpans

@@ -96,41 +100,52 @@ library

96100 Graphics.Vty.Output.Interface

97101 Graphics.Vty.Output.XTermColor

98102 Graphics.Vty.Output.TerminfoBased

103+ Graphics.Vty.UnicodeWidthTable.Types

104+ Graphics.Vty.UnicodeWidthTable.IO

105+ Graphics.Vty.UnicodeWidthTable.Query

106+ Graphics.Vty.UnicodeWidthTable.Install

99107

100− other-modules: Graphics.Vty.Attributes.Color

101− Graphics.Vty.Attributes.Color240

102− Graphics.Vty.Debug.Image

108+ other-modules: Graphics.Vty.Debug.Image

103109 Graphics.Vty.Input.Terminfo.ANSIVT

104110

105111 c-sources: cbits/gwinsz.c

106112 cbits/set_term_timing.c

113+ cbits/get_tty_erase.c

107114 cbits/mk_wcwidth.c

108115

109116 include-dirs: cbits

110117

111118 hs-source-dirs: src

112119

113− default-extensions: ScopedTypeVariables

114− ForeignFunctionInterface

115−

116120 ghc-options: -O2 -funbox-strict-fields -Wall -fspec-constr -fspec-constr-count=10

117121

118122 ghc-prof-options: -O2 -funbox-strict-fields -caf-all -Wall -fspec-constr -fspec-constr-count=10

119123

120− cc-options: -O2

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

121138

122139executable vty-mode-demo

123140 main-is: ModeDemo.hs

124141 hs-source-dirs: demos

125142

126143 default-language: Haskell2010

127− default-extensions: ScopedTypeVariables

128144 ghc-options: -threaded

129145

130146 build-depends: vty,

131− base >= 4.6 && < 5,

147+ base >= 4.8 && < 5,

132148 containers,

133− data-default >= 0.5.3,

134149 microlens,

135150 microlens-mtl,

136151 mtl >= 1.1.1.0 && < 2.3

@@ -140,40 +155,17 @@ executable vty-demo

140155 hs-source-dirs: demos

141156

142157 default-language: Haskell2010

143− default-extensions: ScopedTypeVariables

144158 ghc-options: -threaded

145159

146160 build-depends: vty,

147− base >= 4.6 && < 5,

161+ base >= 4.8 && < 5,

148162 containers,

149− data-default >= 0.5.3,

150163 microlens,

151164 microlens-mtl,

152165 mtl >= 1.1.1.0 && < 2.3

153166

154−test-suite verify-attribute-ops

155− default-language: Haskell2010

156− default-extensions: ScopedTypeVariables

157− type: detailed-0.9

158− hs-source-dirs: test

159− test-module: VerifyAttributeOps

160− build-depends: vty,

161− Cabal >= 1.20,

162− QuickCheck >= 2.7,

163− random >= 1.0 && < 1.2,

164− base >= 4.6 && < 5,

165− bytestring,

166− containers,

167− deepseq >= 1.1 && < 1.5,

168− mtl >= 1.1.1.0 && < 2.3,

169− text >= 0.11.3,

170− unix,

171− utf8-string >= 0.3 && < 1.1,

172− vector >= 0.7

173−

174167test-suite verify-using-mock-terminal

175168 default-language: Haskell2010

176− default-extensions: ScopedTypeVariables

177169

178170 type: detailed-0.9

179171

@@ -192,8 +184,8 @@ test-suite verify-using-mock-terminal

192184 build-depends: vty,

193185 Cabal >= 1.20,

194186 QuickCheck >= 2.7,

195− random >= 1.0 && < 1.2,

196− base >= 4.6 && < 5,

187+ random >= 1.0 && < 1.3,

188+ base >= 4.8 && < 5,

197189 bytestring,

198190 containers,

199191 deepseq >= 1.1 && < 1.5,

@@ -206,7 +198,6 @@ test-suite verify-using-mock-terminal

206198

207199test-suite verify-terminal

208200 default-language: Haskell2010

209− default-extensions: ScopedTypeVariables

210201

211202 type: detailed-0.9

212203

@@ -225,11 +216,10 @@ test-suite verify-terminal

225216 build-depends: vty,

226217 Cabal >= 1.20,

227218 QuickCheck >= 2.7,

228− random >= 1.0 && < 1.2,

229− base >= 4.6 && < 5,

219+ random >= 1.0 && < 1.3,

220+ base >= 4.8 && < 5,

230221 bytestring,

231222 containers,

232− data-default >= 0.5.3,

233223 deepseq >= 1.1 && < 1.5,

234224 mtl >= 1.1.1.0 && < 2.3,

235225 terminfo >= 0.3 && < 0.5,

@@ -240,7 +230,6 @@ test-suite verify-terminal

240230

241231test-suite verify-display-attributes

242232 default-language: Haskell2010

243− default-extensions: ScopedTypeVariables

244233

245234 type: detailed-0.9

246235

@@ -259,8 +248,8 @@ test-suite verify-display-attributes

259248 build-depends: vty,

260249 Cabal >= 1.20,

261250 QuickCheck >= 2.7,

262− random >= 1.0 && < 1.2,

263− base >= 4.6 && < 5,

251+ random >= 1.0 && < 1.3,

252+ base >= 4.8 && < 5,

264253 bytestring,

265254 containers,

266255 deepseq >= 1.1 && < 1.5,

@@ -272,7 +261,6 @@ test-suite verify-display-attributes

272261

273262test-suite verify-empty-image-props

274263 default-language: Haskell2010

275− default-extensions: ScopedTypeVariables

276264

277265 type: detailed-0.9

278266

@@ -285,8 +273,8 @@ test-suite verify-empty-image-props

285273 build-depends: vty,

286274 Cabal >= 1.20,

287275 QuickCheck >= 2.7,

288− random >= 1.0 && < 1.2,

289− base >= 4.6 && < 5,

276+ random >= 1.0 && < 1.3,

277+ base >= 4.8 && < 5,

290278 bytestring,

291279 containers,

292280 deepseq >= 1.1 && < 1.5,

@@ -298,7 +286,6 @@ test-suite verify-empty-image-props

298286

299287test-suite verify-eval-terminfo-caps

300288 default-language: Haskell2010

301− default-extensions: ScopedTypeVariables

302289

303290 type: detailed-0.9

304291

@@ -312,8 +299,8 @@ test-suite verify-eval-terminfo-caps

312299 build-depends: vty,

313300 Cabal >= 1.20,

314301 QuickCheck >= 2.7,

315− random >= 1.0 && < 1.2,

316− base >= 4.6 && < 5,

302+ random >= 1.0 && < 1.3,

303+ base >= 4.8 && < 5,

317304 blaze-builder >= 0.3.3.2 && < 0.5,

318305 bytestring,

319306 containers,

@@ -327,7 +314,6 @@ test-suite verify-eval-terminfo-caps

327314

328315test-suite verify-image-ops

329316 default-language: Haskell2010

330− default-extensions: ScopedTypeVariables

331317

332318 type: detailed-0.9

333319

@@ -342,8 +328,8 @@ test-suite verify-image-ops

342328 build-depends: vty,

343329 Cabal >= 1.20,

344330 QuickCheck >= 2.7,

345− random >= 1.0 && < 1.2,

346− base >= 4.6 && < 5,

331+ random >= 1.0 && < 1.3,

332+ base >= 4.8 && < 5,

347333 bytestring,

348334 containers,

349335 deepseq >= 1.1 && < 1.5,

@@ -355,7 +341,6 @@ test-suite verify-image-ops

355341

356342test-suite verify-image-trans

357343 default-language: Haskell2010

358− default-extensions: ScopedTypeVariables

359344

360345 type: detailed-0.9

361346

@@ -370,8 +355,8 @@ test-suite verify-image-trans

370355 build-depends: vty,

371356 Cabal >= 1.20,

372357 QuickCheck >= 2.7,

373− random >= 1.0 && < 1.2,

374− base >= 4.6 && < 5,

358+ random >= 1.0 && < 1.3,

359+ base >= 4.8 && < 5,

375360 bytestring,

376361 containers,

377362 deepseq >= 1.1 && < 1.5,

@@ -383,7 +368,6 @@ test-suite verify-image-trans

383368

384369test-suite verify-inline

385370 default-language: Haskell2010

386− default-extensions: ScopedTypeVariables

387371

388372 type: detailed-0.9

389373

@@ -397,8 +381,8 @@ test-suite verify-inline

397381 build-depends: vty,

398382 Cabal >= 1.20,

399383 QuickCheck >= 2.7,

400− random >= 1.0 && < 1.2,

401− base >= 4.6 && < 5,

384+ random >= 1.0 && < 1.3,

385+ base >= 4.8 && < 5,

402386 bytestring,

403387 containers,

404388 deepseq >= 1.1 && < 1.5,

@@ -410,7 +394,6 @@ test-suite verify-inline

410394

411395test-suite verify-parse-terminfo-caps

412396 default-language: Haskell2010

413− default-extensions: ScopedTypeVariables

414397

415398 type: detailed-0.9

416399

@@ -425,8 +408,8 @@ test-suite verify-parse-terminfo-caps

425408 build-depends: vty,

426409 Cabal >= 1.20,

427410 QuickCheck >= 2.7,

428− random >= 1.0 && < 1.2,

429− base >= 4.6 && < 5,

411+ random >= 1.0 && < 1.3,

412+ base >= 4.8 && < 5,

430413 bytestring,

431414 containers,

432415 deepseq >= 1.1 && < 1.5,

@@ -439,7 +422,6 @@ test-suite verify-parse-terminfo-caps

439422

440423test-suite verify-simple-span-generation

441424 default-language: Haskell2010

442− default-extensions: ScopedTypeVariables

443425

444426 type: detailed-0.9

445427

@@ -457,8 +439,8 @@ test-suite verify-simple-span-generation

457439 build-depends: vty,

458440 Cabal >= 1.20,

459441 QuickCheck >= 2.7,

460− random >= 1.0 && < 1.2,

461− base >= 4.6 && < 5,

442+ random >= 1.0 && < 1.3,

443+ base >= 4.8 && < 5,

462444 bytestring,

463445 containers,

464446 deepseq >= 1.1 && < 1.5,

@@ -471,7 +453,6 @@ test-suite verify-simple-span-generation

471453

472454test-suite verify-crop-span-generation

473455 default-language: Haskell2010

474− default-extensions: ScopedTypeVariables

475456

476457 type: detailed-0.9

477458

@@ -489,8 +470,8 @@ test-suite verify-crop-span-generation

489470 build-depends: vty,

490471 Cabal >= 1.20,

491472 QuickCheck >= 2.7,

492− random >= 1.0 && < 1.2,

493− base >= 4.6 && < 5,

473+ random >= 1.0 && < 1.3,

474+ base >= 4.8 && < 5,

494475 bytestring,

495476 containers,

496477 deepseq >= 1.1 && < 1.5,

@@ -503,7 +484,6 @@ test-suite verify-crop-span-generation

503484

504485test-suite verify-layers-span-generation

505486 default-language: Haskell2010

506− default-extensions: ScopedTypeVariables

507487

508488 type: detailed-0.9

509489

@@ -521,8 +501,33 @@ test-suite verify-layers-span-generation

521501 build-depends: vty,

522502 Cabal >= 1.20,

523503 QuickCheck >= 2.7,

524− random >= 1.0 && < 1.2,

525− base >= 4.6 && < 5,

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,

530+ base >= 4.8 && < 5,

526531 bytestring,

527532 containers,

528533 deepseq >= 1.1 && < 1.5,

@@ -534,7 +539,6 @@ test-suite verify-layers-span-generation

534539

535540test-suite verify-utf8-width

536541 default-language: Haskell2010

537− default-extensions: ScopedTypeVariables

538542

539543 type: detailed-0.9

540544

@@ -547,8 +551,8 @@ test-suite verify-utf8-width

547551 build-depends: vty,

548552 Cabal >= 1.20,

549553 QuickCheck >= 2.7,

550− random >= 1.0 && < 1.2,

551− base >= 4.6 && < 5,

554+ random >= 1.0 && < 1.3,

555+ base >= 4.8 && < 5,

552556 bytestring,

553557 containers,

554558 deepseq >= 1.1 && < 1.5,

@@ -560,7 +564,6 @@ test-suite verify-utf8-width

560564

561565test-suite verify-using-mock-input

562566 default-language: Haskell2010

563− default-extensions: ScopedTypeVariables

564567

565568 type: exitcode-stdio-1.0

566569

@@ -568,16 +571,17 @@ test-suite verify-using-mock-input

568571

569572 main-is: VerifyUsingMockInput.hs

570573

574+ other-modules: Verify.Graphics.Vty.Output

575+

571576 build-depends: vty,

572577 Cabal >= 1.20,

573− data-default >= 0.5.3,

574578 QuickCheck >= 2.7,

575579 smallcheck == 1.*,

576580 quickcheck-assertions >= 0.1.1,

577581 test-framework == 0.8.*,

578582 test-framework-smallcheck == 0.2.*,

579− random >= 1.0 && < 1.2,

580− base >= 4.6 && < 5,

583+ random >= 1.0 && < 1.3,

584+ base >= 4.8 && < 5,

581585 bytestring,

582586 containers,

583587 deepseq >= 1.1 && < 1.5,

@@ -595,7 +599,6 @@ test-suite verify-using-mock-input

595599

596600test-suite verify-config

597601 default-language: Haskell2010

598− default-extensions: ScopedTypeVariables

599602

600603 type: exitcode-stdio-1.0

601604

@@ -605,7 +608,6 @@ test-suite verify-config

605608

606609 build-depends: vty,

607610 Cabal >= 1.20,

608− data-default >= 0.5.3,

609611 HUnit,

610612 QuickCheck >= 2.7,

611613 smallcheck == 1.*,

@@ -613,8 +615,8 @@ test-suite verify-config

613615 test-framework == 0.8.*,

614616 test-framework-smallcheck == 0.2.*,

615617 test-framework-hunit,

616− random >= 1.0 && < 1.2,

617− base >= 4.6 && < 5,

618+ random >= 1.0 && < 1.3,

619+ base >= 4.8 && < 5,

618620 bytestring,

619621 containers,

620622 deepseq >= 1.1 && < 1.5,