hscolour: Colourise Haskell code.

[ language, library, program ] [ Propose Tags ]

hscolour is a small Haskell script to colourise Haskell code. It currently has six output formats: ANSI terminal codes, HTML 3.2 with font tags, HTML 4.01 with CSS, XHTML 1.0 with inline CSS styling, LaTeX, and mIRC chat codes.


[Skip to Readme]
Versions 1.6, 1.9, 1.10, 1.10.1, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18, 1.19, 1.20, 1.20.1, 1.20.2, 1.20.3, 1.21, 1.22, 1.23, 1.24, 1.24.1, 1.24.2, 1.24.3, 1.24.4 (info)
Dependencies base (<4.4), haskell98 [details]
License LicenseRef-GPL
Copyright 2003-2010 Malcolm Wallace, University of York; 2006 Bjorn Bringert
Author Malcolm Wallace
Maintainer Malcolm Wallace
Revised Revision 1 made by HerbertValerioRiedel at Fri Jan 2 22:37:51 UTC 2015
Category Language
Home page http://www.cs.york.ac.uk/fp/darcs/hscolour/
Uploaded by MalcolmWallace at Mon Feb 1 17:37:54 UTC 2010
Distributions Arch:1.24.4, Debian:1.23, Fedora:1.24.2, FreeBSD:1.23, LTSHaskell:1.24.4, NixOS:1.24.4, Stackage:1.24.4
Executables HsColour
Downloads 95684 total (487 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]
Hackage Matrix CI

Modules

[Index]

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees


Readme for hscolour-1.16

[back to package description]
HsColour: A Haskell source-code colouriser.
-------------------------------------------
Copyright:  2003-2010, Malcolm Wallace, University of York
Licence:    GPL

Building:
    hmake HsColour
or
    ghc --make HsColour

Usage:
    HsColour [-Ofile]
             [ -tty | -html | -css | -icss | -latex | -mirc ]
             [ -lit | -lit-tex | -anchor  | -partial ]
             [ -nolit          | -noanchor| -nopartial ]
             [file.hs]

The program can colourise a Haskell source file for either terminal
output (option -tty), or HTML 3.2 output with font tags (option -html),
or HTML 4.01 output with CSS (option -css), or XHTML 1.0 output with
inline styling (option -icss) or LaTeX output (option -latex), or IRC
chat client (option -mirc).  The default is for terminal output, which
uses standard ANSI screen codes for the colours.

If no file argument is given, it reads standard input.  Output is
written to the file specified by the -O option, or by default, stdout.

HsColour can add named anchors in HTML or CSS or ICSS (option -anchor) to
top-level definitions in the source file (functions, datatypes,
classes).  This enables you to make links to a specific location in the
generated file with the standard "file.html#anchor" notation.

If an input file is literate, that is, it has a suffix ".lhs" or ".ly"
or ".lx", then only the code fragments will be colourised, leaving the
commentary untouched.  You can explicitly override this
filename-guessing of literate status: use the -lit option to
force literate colouring, or -nolit to force all text to be
colourised.  (-lit-tex is an obsolete synonym for -lit)

For more advanced usage, if you are building documents in parts, and you
want to embed several individually colourised fragments into a larger
document, use the <tt>-partial</tt> option with each fragment, to omit
the HTML DOCTYPE header, CSS stylesheet link, or LaTeX prologue.

You can configure the colours for different lexical entities by
editing a configuration file called .hscolour in the current directory.
(An example is included in the distribution.)  The file format is as
a simple Haskell value of type ColourPrefs, constructed using named
fields, as follows:

  data ColourPrefs = ColourPrefs
    { keyword, keyglyph, layout, comment
    , conid, varid, conop, varop
    , string, char, number, cpp
    , selection, variantselection :: [Highlight]
    }

  data Colour = Black | Red | Green | Yellow | Blue | Magenta | Cyan | White

  data Highlight =
      Normal
    | Bold
    | Dim
    | Underscore
    | Blink
    | ReverseVideo
    | Concealed
    | Foreground Colour
    | Background Colour
    | Italic

For CSS output, it is sufficient to edit the hscolour.css file, also in
the distribution.