Personal tools

GHCi in colour

From HaskellWiki

(Difference between revisions)
Jump to: navigation, search
m (Prompt only: Corrected code markup)
(6 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
This page documents efforts to colourise GHCi output.
 
This page documents efforts to colourise GHCi output.
   
== Example ==
+
== Prompt only ==
  +
  +
The prompt can be colored by altering GHCi's <code>prompt</code> setting including ANSI terminal color codes. For example
  +
  +
:set prompt "\ESC[34m%s > \ESC[m"
  +
  +
will give the prompt blue color:
  +
  +
[[Image:Colored_ghci_prompt.png‎]]
  +
  +
As usual, adding this to <code>ghci.conf</code> will auto-execute the command when running GHCi, making the prompt colored by default.
  +
  +
== Full highlighting ==
  +
  +
=== Example ===
   
 
[[Image:Colour-ghci.png]]
 
[[Image:Colour-ghci.png]]
Line 9: Line 9:
 
[[Image:Coloured-error.png]]
 
[[Image:Coloured-error.png]]
   
== Implementation ==
+
Output like this would be the result of running, for example:
   
=== Using HsColour ===
+
ghci --colour
  +
  +
and would appear in the console/xterm as ansi terminal coloured output.
  +
  +
=== Implementation ===
  +
  +
==== Using sed and ghci.conf ====
  +
  +
You can use sed to color the non-prompt output, and color the prompt with ghci.conf. This works better than piping into HsColour for me. See [http://martijn.van.steenbergen.nl/journal/2010/02/27/colors-in-ghci/ this] blog post for details.
  +
  +
This allows you to colorize everything you can catch with a regexp. Note that when coloring GHCi prompt using ghci.conf one should, in ultimate escapity, escape the escape codes with \001..\002, otherwise readline will mess up when editing long lines. For a working example of how this can be done refer to [[:Image:Ghci 256color.tar.gz|this example]]. For what it can look like refer to [[:Image:GHCi 256color.jpg|this picture]].
  +
This approach doesn't work well if you try to output an infinite sequence and then hit CTRL+C, ideas on how to fix that are welcome.
  +
  +
==== Using HsColour ====
   
 
An existing tool, [http://www.cs.york.ac.uk/fp/darcs/hscolour/ HsColour],
 
An existing tool, [http://www.cs.york.ac.uk/fp/darcs/hscolour/ HsColour],
could be modified to operate interactively.
+
could be modified to operate interactively. In fact, HsColour is already interactive, and
  +
with a small patch added on 2006-12-14 to control ouput buffering better, this works
  +
relatively nicely:
  +
  +
ghci 2>&1 | HsColour -tty
  +
  +
[[Image:Tty.png|frame|HsColour in action]]
  +
  +
There are small delays however, when lexing certain tokens, and the
  +
interaction with readline isn't ideal.
  +
  +
==== GuiHaskell ====
  +
  +
Neil Mitchell has a prototype [http://community.haskell.org/~ndm/guihaskell/ gui haskell] wrapper, based on gtk. Does this contain a reasonable ghci wrapper we could steal?
   
   

Revision as of 12:29, 6 December 2012

This page documents efforts to colourise GHCi output.

Contents

1 Prompt only

The prompt can be colored by altering GHCi's prompt setting including ANSI terminal color codes. For example

   :set prompt "\ESC[34m%s > \ESC[m"

will give the prompt blue color:

   Colored ghci prompt.png

As usual, adding this to ghci.conf will auto-execute the command when running GHCi, making the prompt colored by default.

2 Full highlighting

2.1 Example

   Colour-ghci.png

Or a type error:

   Coloured-error.png

Output like this would be the result of running, for example:

   ghci --colour

and would appear in the console/xterm as ansi terminal coloured output.

2.2 Implementation

2.2.1 Using sed and ghci.conf

You can use sed to color the non-prompt output, and color the prompt with ghci.conf. This works better than piping into HsColour for me. See this blog post for details.

This allows you to colorize everything you can catch with a regexp. Note that when coloring GHCi prompt using ghci.conf one should, in ultimate escapity, escape the escape codes with \001..\002, otherwise readline will mess up when editing long lines. For a working example of how this can be done refer to this example. For what it can look like refer to this picture. This approach doesn't work well if you try to output an infinite sequence and then hit CTRL+C, ideas on how to fix that are welcome.

2.2.2 Using HsColour

An existing tool, HsColour, could be modified to operate interactively. In fact, HsColour is already interactive, and with a small patch added on 2006-12-14 to control ouput buffering better, this works relatively nicely:

   ghci 2>&1 | HsColour -tty
(thumbnail)
HsColour in action

There are small delays however, when lexing certain tokens, and the interaction with readline isn't ideal.

2.2.3 GuiHaskell

Neil Mitchell has a prototype gui haskell wrapper, based on gtk. Does this contain a reasonable ghci wrapper we could steal?


If you have an idea of how to do this nicely, add your proposal here.