diff --git a/.hscolour b/.hscolour
deleted file mode 100644
--- a/.hscolour
+++ /dev/null
@@ -1,17 +0,0 @@
-ColourPrefs
- { keyword = [Underscore,Foreground Green]
- , keyglyph = [Foreground Red]
- , layout = [Foreground Cyan]
- , comment = [Foreground Blue]
- , conid = [Normal]
- , varid = [Normal]
- , conop = [Bold,Foreground Red]
- , varop = [Foreground Cyan]
- , string = [Foreground Magenta]
- , char = [Foreground Magenta]
- , number = [Foreground Magenta]
- , cpp = [Dim,Foreground Magenta]
- , selection = [Bold, Foreground Magenta]
- , variantselection = [Dim, Foreground Red, Underscore]
- , definition = [Normal]
- }
diff --git a/HsColour.hs b/HsColour.hs
--- a/HsColour.hs
+++ b/HsColour.hs
@@ -7,10 +7,9 @@
import Language.Haskell.HsColour.Options
import System
import IO
-import System.IO (withFile)
import Monad (when)
import List (intersperse, isSuffixOf)
-import Debug.Trace
+--import Debug.Trace
-- Deal with UTF-8 I/O.
#if __GLASGOW_HASKELL__ > 611
@@ -18,7 +17,7 @@
import System.IO (hSetEncoding, utf8)
#endif
-version = "1.16"
+version = "1.17"
optionTable :: [(String,Option)]
optionTable = [ ("help", Help)
@@ -156,3 +155,7 @@
readUTF8File name = openFile name ReadMode >>=
set_utf8_io_enc >>=
hGetContents
+
+withFile :: FilePath -> IOMode -> (Handle -> IO r) -> IO r
+withFile name mode = bracket (openFile name mode) hClose
+
diff --git a/Language/Haskell/HsColour.hs b/Language/Haskell/HsColour.hs
--- a/Language/Haskell/HsColour.hs
+++ b/Language/Haskell/HsColour.hs
@@ -23,10 +23,10 @@
import qualified Language.Haskell.HsColour.InlineCSS as ICSS
import qualified Language.Haskell.HsColour.LaTeX as LaTeX
import qualified Language.Haskell.HsColour.MIRC as MIRC
-import Data.List(mapAccumL, isPrefixOf)
-import Data.Maybe
+import List(mapAccumL, isPrefixOf)
+import Maybe
import Language.Haskell.HsColour.Output
-import Debug.Trace
+--import Debug.Trace
-- | Colourise Haskell source code with the given output format.
hscolour :: Output -- ^ Output format.
diff --git a/Language/Haskell/HsColour/CSS.hs b/Language/Haskell/HsColour/CSS.hs
--- a/Language/Haskell/HsColour/CSS.hs
+++ b/Language/Haskell/HsColour/CSS.hs
@@ -53,7 +53,8 @@
cssPrefix title = unlines
- [""
+ [""
+ ,""
,""
,""
,""
diff --git a/Language/Haskell/HsColour/Classify.hs b/Language/Haskell/HsColour/Classify.hs
--- a/Language/Haskell/HsColour/Classify.hs
+++ b/Language/Haskell/HsColour/Classify.hs
@@ -11,9 +11,23 @@
tokenise :: String -> [(TokenType,String)]
tokenise str =
let chunks = glue . chunk $ str
- newline = True : (map ("\n" `isPrefixOf`) chunks)
- in map (\(s,n)-> (classify s n,s)) (zip chunks newline)
+ in markDefs $ map (\s-> (classify s,s)) chunks
+markDefs :: [(TokenType, String)] -> [(TokenType, String)]
+markDefs [] = []
+markDefs ((Varid, s) : rest) = (Definition, s) : continue rest
+markDefs ((Varop, ">") : (Space, " ") : (Varid, d) : rest) =
+ (Varop, ">") : (Space, " ") : (Definition, d) : continue rest
+markDefs rest = continue rest
+
+continue rest
+ = let (thisLine, nextLine) = span (/= (Space, "\n")) rest
+ in
+ case nextLine of
+ [] -> thisLine
+ ((Space, "\n"):nextLine') -> (thisLine ++ ((Space, "\n") : (markDefs nextLine')))
+
+
-- Basic Haskell lexing, except we keep whitespace.
chunk :: String -> [String]
chunk [] = []
@@ -78,8 +92,8 @@
Definition
deriving (Eq,Show)
-classify :: String -> Bool -> TokenType
-classify s@(h:t) newline
+classify :: String -> TokenType
+classify s@(h:t)
| isSpace h = Space
| all (=='-') s = Comment
| "--" `isPrefixOf` s
@@ -92,7 +106,7 @@
| s == "[]" = Conid
| h == '(' && isTupleTail t = Conid
| h == '#' = Cpp
- | isLower h = if newline then Definition else Varid
+ | isLower h = Varid
| h `elem` symbols = Varop
| h==':' = Conop
| h=='`' = Varop
@@ -100,7 +114,7 @@
| h=='\'' = Char
| isDigit h = Number
| otherwise = Error
-classify _ _ = Space
+classify _ = Space
isTupleTail [')'] = True
isTupleTail (',':xs) = isTupleTail xs
diff --git a/Language/Haskell/HsColour/HTML.hs b/Language/Haskell/HsColour/HTML.hs
--- a/Language/Haskell/HsColour/HTML.hs
+++ b/Language/Haskell/HsColour/HTML.hs
@@ -10,7 +10,7 @@
import Language.Haskell.HsColour.Classify as Classify
import Language.Haskell.HsColour.Colourise
-import Data.Char(isAlphaNum)
+import Char(isAlphaNum)
-- | Formats Haskell source code using HTML with font tags.
diff --git a/Language/Haskell/HsColour/InlineCSS.hs b/Language/Haskell/HsColour/InlineCSS.hs
--- a/Language/Haskell/HsColour/InlineCSS.hs
+++ b/Language/Haskell/HsColour/InlineCSS.hs
@@ -38,7 +38,8 @@
stylise hs s = "" ++s++ " "
cssPrefix title = unlines
- [""
+ [""
+ ,""
,""
,""
,""
diff --git a/Language/Haskell/HsColour/MIRC.hs b/Language/Haskell/HsColour/MIRC.hs
--- a/Language/Haskell/HsColour/MIRC.hs
+++ b/Language/Haskell/HsColour/MIRC.hs
@@ -5,7 +5,7 @@
import Language.Haskell.HsColour.Classify as Classify
import Language.Haskell.HsColour.Colourise
-import Data.Char(isAlphaNum)
+import Char(isAlphaNum)
-- | Formats Haskell source code using mIRC codes.
diff --git a/Makefile b/Makefile
deleted file mode 100644
--- a/Makefile
+++ /dev/null
@@ -1,70 +0,0 @@
-LIBRARY = hscolour
-VERSION = 1.16
-
-DIRS = Language/Haskell/HsColour
-
-SRCS = Language/Haskell/HsColour.hs \
- Language/Haskell/HsColour/General.hs \
- Language/Haskell/HsColour/ANSI.hs \
- Language/Haskell/HsColour/Anchors.hs \
- Language/Haskell/HsColour/CSS.hs \
- Language/Haskell/HsColour/Classify.hs \
- Language/Haskell/HsColour/ColourHighlight.hs \
- Language/Haskell/HsColour/Colourise.hs \
- Language/Haskell/HsColour/HTML.hs \
- Language/Haskell/HsColour/InlineCSS.hs \
- Language/Haskell/HsColour/LaTeX.hs \
- Language/Haskell/HsColour/TTY.hs \
- Language/Haskell/HsColour/MIRC.hs \
- Language/Haskell/HsColour/Output.hs \
- Language/Haskell/HsColour/Options.hs
-
-AUX = README LICENCE* $(LIBRARY).cabal Setup.hs Makefile \
- HsColour.hs hscolour.css .hscolour \
- index.html docs/*
-
-GHC = ghc
-
-#all: $(LIBRARY)
-executable: $(SRCS) HsColour.hs
- $(GHC) --make -o $(LIBRARY) HsColour
-package:
- tar cf tmp.tar $(SRCS) $(AUX)
- mkdir $(LIBRARY)-$(VERSION)
- cd $(LIBRARY)-$(VERSION); tar xf ../tmp.tar
- tar zcf $(LIBRARY)-$(VERSION).tar.gz $(LIBRARY)-$(VERSION)
- zip -r $(LIBRARY)-$(VERSION).zip $(LIBRARY)-$(VERSION)
- rm -r tmp.tar $(LIBRARY)-$(VERSION)
-haddock: $(SRCS)
- mkdir -p docs/$(LIBRARY)
- for dir in $(DIRS); do mkdir -p docs/$(LIBRARY)/$$dir; done
- for file in $(SRCS); \
- do ./$(LIBRARY) -html -anchor $$file \
- >docs/$(LIBRARY)/`dirname $$file`/`basename $$file .hs`.html;\
- done
- haddock --html --title=$(LIBRARY) --odir=docs/$(LIBRARY) \
- --package=$(LIBRARY) \
- --source-module="%{MODULE/.//}.html" \
- --source-entity="%{MODULE/.//}.html#%{NAME}" \
- $(SRCS)
-
-#$(LIBRARY): $(SRCS)
-# $(HC) $(HFLAGS) $(HEAP) -o $@ $(SRCS)
-# $(STRIP) $@
-
-docs: haddock
-
-install:
- install -D $(LIBRARY) $(DESTDIR)/usr/bin/$(LIBRARY)
- install -D $(LIBRARY).css $(DESTDIR)/usr/share/doc/$(LIBRARY)/examples/$(LIBRARY).css
-
-install-docs:
- install -D index.html $(DESTDIR)/usr/share/doc/$(LIBRARY)/index.html
- cp -a docs/$(LIBRARY)/Language/Haskell/* $(DESTDIR)/usr/share/doc/$(LIBRARY)/
-
-clean:
- rm -f $(DIRS)/*.o $(DIRS)/*.hi
- rm -f Language/Haskell/HsColour.o Language/Haskell/HsColour.hi
- rm -f *.o *.hi
- rm -f $(LIBRARY)
- rm -rf docs
diff --git a/README b/README
deleted file mode 100644
--- a/README
+++ /dev/null
@@ -1,74 +0,0 @@
-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 -partial 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.
-
diff --git a/docs/hscolour/Language-Haskell-HsColour-ANSI.html b/docs/hscolour/Language-Haskell-HsColour-ANSI.html
deleted file mode 100644
--- a/docs/hscolour/Language-Haskell-HsColour-ANSI.html
+++ /dev/null
@@ -1,810 +0,0 @@
-
-
-Language.Haskell.HsColour.ANSI Language.Haskell.HsColour.ANSI
Description Partially taken from Hugs AnsiScreen.hs library:
- Synopsis Documentation Make the given string appear with all of the listed highlights
- Clear the screen.
- goto :: Int -> Int -> StringSource
Move the screen cursor to the given position.
- Types of highlighting supported by ANSI codes (and some extra styles).
- Constructors Normal Bold Dim Underscore Blink ReverseVideo Concealed Foreground Colour Background Colour Italic
Colours supported by ANSI codes.
- Constructors Black Red Green Yellow Blue Magenta Cyan White
An infinite supply of colours.
- enableScrollRegion :: Int -> Int -> StringSource
Scrolling
- Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-Anchors.html b/docs/hscolour/Language-Haskell-HsColour-Anchors.html
deleted file mode 100644
--- a/docs/hscolour/Language-Haskell-HsColour-Anchors.html
+++ /dev/null
@@ -1,155 +0,0 @@
-
-
-Language.Haskell.HsColour.Anchors Language.Haskell.HsColour.Anchors
Synopsis Documentation insertAnchors before means
- immediately preceding its type signature, or preceding a (haddock)
- comment that comes immediately before the type signature, or failing
- either of those, before the first equation.
-Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-CSS.html b/docs/hscolour/Language-Haskell-HsColour-CSS.html
deleted file mode 100644
--- a/docs/hscolour/Language-Haskell-HsColour-CSS.html
+++ /dev/null
@@ -1,206 +0,0 @@
-
-
-Language.Haskell.HsColour.CSS Language.Haskell.HsColour.CSS
Description Formats Haskell source code as HTML with CSS.
- Synopsis Documentation :: Bool Whether to include anchors.
- -> String Haskell source code.
- -> String An HTML document containing the coloured
- Haskell source code.
- Formats Haskell source code as a complete HTML document with CSS.
-
top'n'tail :: String -> String -> StringSource
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-Classify.html b/docs/hscolour/Language-Haskell-HsColour-Classify.html
deleted file mode 100644
--- a/docs/hscolour/Language-Haskell-HsColour-Classify.html
+++ /dev/null
@@ -1,476 +0,0 @@
-
-
-Language.Haskell.HsColour.Classify Language.Haskell.HsColour.Classify
Synopsis Documentation Classification of tokens as lexical entities
- Constructors Space Keyword Keyglyph Layout Comment Conid Varid Conop Varop String Char Number Cpp Error Definition
Lex Haskell source code into an annotated token stream, without
- discarding any characters or layout.
- Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-ColourHighlight.html b/docs/hscolour/Language-Haskell-HsColour-ColourHighlight.html
deleted file mode 100644
--- a/docs/hscolour/Language-Haskell-HsColour-ColourHighlight.html
+++ /dev/null
@@ -1,608 +0,0 @@
-
-
-Language.Haskell.HsColour.ColourHighlight Language.Haskell.HsColour.ColourHighlight
Synopsis Documentation Colours supported by ANSI codes.
- Constructors Black Red Green Yellow Blue Magenta Cyan White
Types of highlighting supported by ANSI codes (and some extra styles).
- Constructors Normal Bold Dim Underscore Blink ReverseVideo Concealed Foreground Colour Background Colour Italic
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-Colourise.html b/docs/hscolour/Language-Haskell-HsColour-Colourise.html
deleted file mode 100644
--- a/docs/hscolour/Language-Haskell-HsColour-Colourise.html
+++ /dev/null
@@ -1,423 +0,0 @@
-
-
-Language.Haskell.HsColour.Colourise Language.Haskell.HsColour.Colourise
Synopsis module Language.Haskell.HsColour.ColourHighlight data ColourPrefs = ColourPrefs {keyword , keyglyph , layout , comment , conid , varid , conop , varop , string , char , number , cpp , selection , variantselection , definition :: [Highlight ]
}readColourPrefs :: IO ColourPrefs colourise :: ColourPrefs -> TokenType -> [Highlight ]
Documentation module Language.Haskell.HsColour.ColourHighlight Colour preferences.
- Constructors ColourPrefs keyword , keyglyph , layout , comment , conid , varid , conop , varop , string , char , number , cpp , selection , variantselection , definition :: [Highlight ]
Read colour preferences from .hscolour file in the current directory, or failing that,
- from $HOME/.hscolour, and failing that, returns a default set of prefs.
- Convert token classification to colour highlights.
- Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-General.html b/docs/hscolour/Language-Haskell-HsColour-General.html
deleted file mode 100644
--- a/docs/hscolour/Language-Haskell-HsColour-General.html
+++ /dev/null
@@ -1,134 +0,0 @@
-
-
-Language.Haskell.HsColour.General Language.Haskell.HsColour.General
Documentation dropLast :: Eq a => a -> [a] -> [a]Source
dropFirst :: Eq a => a -> [a] -> [a]Source
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-HTML.html b/docs/hscolour/Language-Haskell-HsColour-HTML.html
deleted file mode 100644
--- a/docs/hscolour/Language-Haskell-HsColour-HTML.html
+++ /dev/null
@@ -1,348 +0,0 @@
-
-
-Language.Haskell.HsColour.HTML Language.Haskell.HsColour.HTML
Description Formats Haskell source code using HTML with font tags.
- Synopsis Documentation :: ColourPrefs Colour preferences.
- -> Bool Whether to include anchors.
- -> String Haskell source code.
- -> String Coloured Haskell source code.
- Formats Haskell source code using HTML with font tags.
-
top'n'tail :: String -> String -> StringSource
Internals
- renderComment :: String -> StringSource
renderNewLinesAnchors :: String -> StringSource
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-InlineCSS.html b/docs/hscolour/Language-Haskell-HsColour-InlineCSS.html
deleted file mode 100644
--- a/docs/hscolour/Language-Haskell-HsColour-InlineCSS.html
+++ /dev/null
@@ -1,217 +0,0 @@
-
-
-Language.Haskell.HsColour.InlineCSS Language.Haskell.HsColour.InlineCSS
Description Formats Haskell source code as HTML with inline CSS.
- Synopsis Documentation :: ColourPrefs Preferences for styling.
- -> Bool Whether to include anchors.
- -> String Haskell source code.
- -> String An HTML document containing the coloured
- Haskell source code.
- Formats Haskell source code as a complete HTML document with inline styling
-
top'n'tail :: String -> String -> StringSource
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-LaTeX.html b/docs/hscolour/Language-Haskell-HsColour-LaTeX.html
deleted file mode 100644
--- a/docs/hscolour/Language-Haskell-HsColour-LaTeX.html
+++ /dev/null
@@ -1,210 +0,0 @@
-
-
-Language.Haskell.HsColour.LaTeX Language.Haskell.HsColour.LaTeX
Description Formats Haskell source code using LaTeX macros.
- Synopsis Documentation :: ColourPrefs Colour preferences.
- -> String Haskell source code.
- -> String A LaTeX document/fragment containing the coloured
- Haskell source code.
- Formats Haskell source code as a complete LaTeX document.
-
top'n'tail :: String -> String -> StringSource
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-MIRC.html b/docs/hscolour/Language-Haskell-HsColour-MIRC.html
deleted file mode 100644
--- a/docs/hscolour/Language-Haskell-HsColour-MIRC.html
+++ /dev/null
@@ -1,178 +0,0 @@
-
-
-Language.Haskell.HsColour.MIRC Language.Haskell.HsColour.MIRC
Description Formats Haskell source code using mIRC codes.
- (see http://irssi.org/documentation/formats)
- Synopsis Documentation :: ColourPrefs Colour preferences.
- -> String Haskell source code.
- -> String Coloured Haskell source code.
- Formats Haskell source code using mIRC codes.
-
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-Options.html b/docs/hscolour/Language-Haskell-HsColour-Options.html
deleted file mode 100644
--- a/docs/hscolour/Language-Haskell-HsColour-Options.html
+++ /dev/null
@@ -1,541 +0,0 @@
-
-
-Language.Haskell.HsColour.Options Language.Haskell.HsColour.Options
Synopsis Documentation Command-line options
- Constructors Help print usage message
- Version report version
- Information report auxiliary information, e.g. CSS defaults
- Format Output what type of output to produce
- LHS Boolliterate input (i.e. multiple embedded fragments)
- Anchors Boolwhether to add anchors
- Partial Boolwhether to produce a full document or partial
- Input FilePathinput source file
- Output FilePathoutput source file
-
The supported output formats.
- Constructors TTY ANSI terminal codes
- LaTeX TeX macros
- HTML HTML with font tags
- CSS HTML with CSS.
- ICSS HTML with inline CSS.
- MIRC mIRC chat clients
-
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-Output.html b/docs/hscolour/Language-Haskell-HsColour-Output.html
deleted file mode 100644
--- a/docs/hscolour/Language-Haskell-HsColour-Output.html
+++ /dev/null
@@ -1,296 +0,0 @@
-
-
-Language.Haskell.HsColour.Output Language.Haskell.HsColour.Output
Synopsis Documentation The supported output formats.
- Constructors TTY ANSI terminal codes
- LaTeX TeX macros
- HTML HTML with font tags
- CSS HTML with CSS.
- ICSS HTML with inline CSS.
- MIRC mIRC chat clients
-
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-TTY.html b/docs/hscolour/Language-Haskell-HsColour-TTY.html
deleted file mode 100644
--- a/docs/hscolour/Language-Haskell-HsColour-TTY.html
+++ /dev/null
@@ -1,177 +0,0 @@
-
-
-Language.Haskell.HsColour.TTY Language.Haskell.HsColour.TTY
Description Highlights Haskell code with ANSI terminal codes.
- Synopsis Documentation :: ColourPrefs Colour preferences.
- -> String Haskell source code.
- -> String Coloured Haskell source code.
- Highlights Haskell code with ANSI terminal codes.
-
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour.html b/docs/hscolour/Language-Haskell-HsColour.html
deleted file mode 100644
--- a/docs/hscolour/Language-Haskell-HsColour.html
+++ /dev/null
@@ -1,647 +0,0 @@
-
-
-Language.Haskell.HsColour Language.Haskell.HsColour
Description This is a library which colourises Haskell code.
- It currently has six output formats:
-
ANSI terminal codes
- LaTeX macros
- HTML 3.2 with font tags
- HTML 4.01 with external CSS.
- XHTML 1.0 with internal CSS.
- mIRC chat client colour codes.
- Synopsis data ColourPrefs = ColourPrefs {keyword , keyglyph , layout , comment , conid , varid , conop , varop , string , char , number , cpp , selection , variantselection , definition :: [Highlight ]
}hscolour :: Output -> ColourPrefs -> Bool -> Bool -> String -> Bool -> String -> String
Documentation The supported output formats.
- Constructors TTY ANSI terminal codes
- LaTeX TeX macros
- HTML HTML with font tags
- CSS HTML with CSS.
- ICSS HTML with inline CSS.
- MIRC mIRC chat clients
-
Colour preferences.
- Constructors ColourPrefs keyword , keyglyph , layout , comment , conid , varid , conop , varop , string , char , number , cpp , selection , variantselection , definition :: [Highlight ]
:: Output Output format.
- -> ColourPrefs Colour preferences (for formats that support them).
- -> Bool Whether to include anchors.
- -> Bool Whether output document is partial or complete.
- -> String Title for output.
- -> Bool Whether input document is literate haskell or not
- -> String Haskell source code.
- -> String Coloured Haskell source code.
- Colourise Haskell source code with the given output format.
-
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language/Haskell/HsColour.html b/docs/hscolour/Language/Haskell/HsColour.html
deleted file mode 100644
--- a/docs/hscolour/Language/Haskell/HsColour.html
+++ /dev/null
@@ -1,118 +0,0 @@
-
-
-
-
-Language/Haskell/HsColour.hs
-
-
--- | This is a library which colourises Haskell code.
--- It currently has six output formats:
---
--- * ANSI terminal codes
---
--- * LaTeX macros
---
--- * HTML 3.2 with font tags
---
--- * HTML 4.01 with external CSS.
---
--- * XHTML 1.0 with internal CSS.
---
--- * mIRC chat client colour codes.
---
-module . Haskell. HsColour ( Output( .. ) , ColourPrefs( .. ) ,
-) where import . Haskell. HsColour. Colourise ( ColourPrefs( .. ) )
-import qualified . Haskell. HsColour. TTY as import qualified . Haskell. HsColour. HTML as import qualified . Haskell. HsColour. CSS as import qualified . Haskell. HsColour. InlineCSS as import qualified . Haskell. HsColour. LaTeX as import qualified . Haskell. HsColour. MIRC as import . List( mapAccumL, isPrefixOf)
-import . Maybe
-import . Haskell. HsColour. Output
-import . Trace
--- | Colourise Haskell source code with the given output format.
-:: Output -- ^ Output format.
--> ColourPrefs -- ^ Colour preferences (for formats that support them).
--> Bool -- ^ Whether to include anchors.
--> Bool -- ^ Whether output document is partial or complete.
--> String -- ^ Title for output.
--> Bool -- ^ Whether input document is literate haskell or not
--> String -- ^ Haskell source code.
--> String -- ^ Coloured Haskell source code.
-=
-( if then else ) .
-=
-( if then else ) .
-. joinL . classify . inlines
-where ( Code c) = hscolour' output pref anchor c
-( Lit c) = c
--- | The actual colourising worker, despatched on the chosen output format.
-:: Output -- ^ Output format.
--> ColourPrefs -- ^ Colour preferences (for formats that support them)
--> Bool -- ^ Whether to include anchors.
--> String -- ^ Haskell source code.
--> String -- ^ Coloured Haskell source code.
-_ = TTY. hscolour pref
-_ = MIRC. hscolour pref
-_ = LaTeX. hscolour pref
-= HTML. hscolour pref anchor
-_ = CSS. hscolour anchor
-= ICSS. hscolour pref anchor
--- | Choose the right headers\/footers, depending on the output format.
-:: Output -- ^ Output format
--> String -- ^ Title for output
--> ( String-> String) -- ^ Output transformer
-_ = id
-_ = id
-= LaTeX. top'n'tail title
-= HTML. top'n'tail title
-= CSS. top'n'tail title
-= ICSS. top'n'tail title
--- | Separating literate files into code\/comment chunks.
-data = Code { unL :: String} | Lit { unL :: String} deriving ( Show)
--- Re-implementation of 'lines', for better efficiency (but decreased laziness).
--- Also, importantly, accepts non-standard DOS and Mac line ending characters.
--- And retains the trailing '\n' character in each resultant string.
-:: String -> [ String]
-= lines' s id
-where = [ acc []]
-( '\^M' : '\n' : ) acc = acc [ '\n' ] : -- DOS
---lines' ('\^M':s) acc = acc ['\n'] : lines' s id -- MacOS
-( '\n' : ) acc = acc [ '\n' ] : -- Unix
-( c: ) acc = lines' s ( acc . ( c: ) )
--- | The code for classify is largely stolen from Language.Preprocessor.Unlit.
-= []
-( x: ) | "\\begin{code}" `isPrefixOf` x
-= Lit x: where = [] -- Should give an error message,
--- but I have no good position information.
-( x: ) | "\\end{code}" `isPrefixOf` x
-= Lit x: ( x: ) = Code x: ( ( '>' : ) : ) = Code ( '>' : ) : ( x: ) = Lit x: -- | Join up chunks of code\/comment that are next to each other.
-:: [ Lit] -> [ Lit]
-= []
-( Code c: : ) = joinL ( Code ( c++ c2) : )
-( Lit c : : ) = joinL ( Lit ( c++ c2) : )
-( any: ) = any: Language/Haskell/HsColour/ANSI.hs
-
-
--- | Partially taken from Hugs AnsiScreen.hs library:
-module . Haskell. HsColour. ANSI
-( highlightOn
-, highlightOff
-, highlight
-, cleareol, clearbol, clearline, clearDown, clearUp, cls
-, goto
-, cursorUp, cursorDown, cursorLeft, cursorRight
-, savePosition, restorePosition
-, Highlight( .. )
-, Colour( .. )
-, colourCycle
-, enableScrollRegion, scrollUp, scrollDown
-, lineWrap
-) where import . Haskell. HsColour. ColourHighlight
-import ( intersperse, isPrefixOf)
-import ( isDigit)
--- Basic screen control codes:
-type = ( Int, Int)
-:: Pos -> String -> String
--- | Move the screen cursor to the given position.
-:: Int -> Int -> String
-:: String
--- | Clear the screen.
-:: String
-( x, y) s = goto x y ++ s
-= '\ESC' : '[' : ( show y ++ ( ';' : ++ "H" ) )
-= goto 1 1
-= "\ESC[A"
-= "\ESC[B"
-= "\ESC[C"
-= "\ESC[D"
-= "\ESC[K"
-= "\ESC[1K"
-= "\ESC[2K"
-= "\ESC[J"
-= "\ESC[1J"
--- Choose whichever of the following lines is suitable for your system:
-= "\ESC[2J" -- for PC with ANSI.SYS
---cls = "\^L" -- for Sun window
-= "\ESC7"
-= "\ESC8"
--- data Colour -- imported from ColourHighlight
--- data Highlight -- imported from ColourHighlight
-instance where = 0
-= 1
-= 2
-= 4
-= 5
-= 7
-= 8
-( Foreground c) = 30 + fromEnum c
-( Background c) = 40 + fromEnum c
-= 2
--- | Make the given string appear with all of the listed highlights
-:: [ Highlight] -> String -> String
-= highlightOn attrs ++ s ++ highlightOff
-= highlightOn [ Normal]
-= "\ESC["
-++ concat ( intersperse ";" ( map ( show. fromEnum) attrs) )
-++ "m"
-= "\ESC[0m"
--- | An infinite supply of colours.
-:: [ Colour]
-= cycle [ Red, Blue, Magenta, Green, Cyan]
--- | Scrolling
-:: Int -> Int -> String
-= "\ESC[" ++ show start++ ';' : ++ "r"
-= "\ESCD"
-= "\ESCM"
--- Line-wrapping mode
-= "\ESC[7h"
-= "\ESC[7l"
-Language/Haskell/HsColour/Anchors.hs
-
-
-module . Haskell. HsColour. Anchors
-( insertAnchors
-) where import . Haskell. HsColour. Classify
-import . Haskell. HsColour. General
-import -- This is an attempt to find the first defining occurrence of an
--- identifier (function, datatype, class) in a Haskell source file.
--- Rather than parse the module properly, we try to get by with just
--- a finite state automaton. Keeping a record of identifiers we
--- have already seen, we look at the beginning of every line to see
--- if it starts with the right tokens to introduce a defn. If so,
--- we look a little bit further until we can be certain. Then plonk
--- (or not) an anchor at the beginning of the line.
-type = String
--- | 'insertAnchors' places an anchor marker in the token stream before the
--- first defining occurrence of any identifier. Here, /before/ means
--- immediately preceding its type signature, or preceding a (haddock)
--- comment that comes immediately before the type signature, or failing
--- either of those, before the first equation.
-:: [ ( TokenType, String) ] -> [ Either Anchor ( TokenType, String) ]
-= anchor emptyST
--- looks at first token in the left-most position of each line
--- precondition: have just seen a newline token.
-= case of -> emit st s
--> Left v: ( insertST v st) s
--- emit passes stuff through until the next newline has been encountered,
--- then jumps back into the anchor function
--- pre-condition: newlines are explicitly single tokens
-( t@ ( Space, "\n" ) : ) = Right t: ( t: ) = Right t: _ = []
--- Given that we are at the beginning of a line, determine whether there
--- is an identifier defined here, and if so, return it.
--- precondition: have just seen a newline token.
-@ ( ( kind, v) : ) | kind`elem` [ Varid, Definition] =
-case of ( ( Varop, v) : _ ) | not ( v`inST` st) -> Just ( fix v)
--- | typesig stream -> Nothing -- not a defn
-| v `inST` st -> Nothing -- already defined
-| otherwise -> Just v
-@ ( ( Layout, "(" ) : ) =
-case of ( ( Varop, v) : ( Layout, ")" ) : _ )
--- | typesig stream -> Nothing
-| v `inST` st -> Nothing
-| otherwise -> Just ( fix v)
--> case ( munchParens stream) of ( ( Varop, v) : _ ) | not ( v`inST` st) -> Just ( fix v)
-_ -> Nothing
-@ ( ( Keyword, "foreign" ) : ) = Nothing -- not yet implemented
-@ ( ( Keyword, "data" ) : ) = getConid stream
-@ ( ( Keyword, "newtype" ) : ) = getConid stream
-@ ( ( Keyword, "type" ) : ) = getConid stream
-@ ( ( Keyword, "class" ) : ) = getConid stream
-@ ( ( Comment, _ ) : ( Space, "\n" ) : ) = identifier st stream
-= Nothing
--- Is this really a type signature? (no longer used)
-:: [ ( TokenType, String) ] -> Bool
-( ( Keyglyph, "::" ) : _ ) = True
-( ( Varid, _ ) : ) = typesig stream
-( ( Layout, "(" ) : ( Varop, _ ) : ( Layout, ")" ) : ) = typesig stream
-( ( Layout, "," ) : ) = typesig stream
-( ( Space, _ ) : ) = typesig stream
-( ( Comment, _ ) : ) = typesig stream
-_ = False
--- throw away everything from opening paren to matching close
-= munch ( 0 :: Int) -- already seen open paren
-where 0 ( ( Layout, ")" ) : ) = rest
-( ( Layout, ")" ) : ) = munch ( n- 1 ) rest
-( ( Layout, "(" ) : ) = munch ( n+ 1 ) rest
-( _ : ) = munch n rest
-_ = [] -- source is ill-formed
--- ensure anchor name is correct for a Varop
-( '`' : ) = dropLast '`' v
-= v
--- look past whitespace and comments to next "real" token
-( ( Space, _ ) : ) = skip stream
-( ( Comment, _ ) : ) = skip stream
-= stream
--- skip possible context up to and including "=>", returning next Conid token
--- (this function is highly partial - relies on source being parse-correct)
-=
-case of ( ( Conid, c) : ) -> case of ( ( Keyglyph, "=" ) : _ ) -> Just c
-( ( Keyglyph, "=>" ) : ) ->
-case of ( ( Conid, c') : _ ) -> Just c'
--> debug v ( "Conid " ++ c++ " =>" )
--> debug v ( "Conid " ++ c++ " no = or =>" )
-( ( Layout, "(" ) : ) -> case of ( ( Keyglyph, "=>" ) : ) ->
-case of ( ( Conid, c') : _ ) -> Just c'
--> debug v ( "(...) =>" )
--> debug v ( "(...) no =>" )
--> debug v ( "no Conid or (...)" )
-where _ _ = Nothing
--- debug (s:t) c = error ("HsColour: getConid failed: "++show s
--- ++"\n in the context of: "++c)
--- jump past possible class context
-@ ( ( Keyglyph, "=" ) : _ ) = stream
-@ ( ( Keyglyph, "=>" ) : _ ) = stream
-( _ : ) = context stream
-= []
--- simple implementation of a string lookup table.
--- replace this with something more sophisticated if needed.
-type = [ String]
-:: ST
-= []
-:: String -> ST -> ST
-= insert k st
-:: String -> ST -> Bool
-= k `elem` st
-Language/Haskell/HsColour/CSS.hs
-
-
--- | Formats Haskell source code as HTML with CSS.
-module . Haskell. HsColour. CSS ( hscolour, top'n'tail) where import . Haskell. HsColour. Anchors
-import . Haskell. HsColour. Classify as import . Haskell. HsColour. HTML ( renderAnchors, renderComment,
-, escape)
--- | Formats Haskell source code as a complete HTML document with CSS.
-:: Bool -- ^ Whether to include anchors.
--> String -- ^ Haskell source code.
--> String -- ^ An HTML document containing the coloured
--- Haskell source code.
-=
-. ( if then . concatMap ( renderAnchors renderToken)
-. insertAnchors
-else )
-. tokenise
-:: String -> String -> String
-= ( cssPrefix title ++ ) . ( ++ cssSuffix)
-:: String -> String
-= ( "<pre>" ++ ) . ( ++ "</pre>" )
-:: ( TokenType, String) -> String
-( cls, text) =
-++ ( if == Comment then else ) ++ after
-where = if then "" else "<span class='" ++ cls2 ++ "'>"
-= if then "" else "</span>"
-= cssClass cls
-= "hs-keyword"
-= "hs-keyglyph"
-= "hs-layout"
-= "hs-comment"
-= "hs-conid"
-= "hs-varid"
-= "hs-conop"
-= "hs-varop"
-= "hs-str"
-= "hs-chr"
-= "hs-num"
-= "hs-cpp"
-= "hs-sel"
-= "hs-definition"
-_ = ""
-= unlines
-[ "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">"
-, "<html>"
-, "<head>"
-, "<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->"
-, "<title>" ++ title++ "</title>"
-, "<link type='text/css' rel='stylesheet' href='hscolour.css' />"
-, "</head>"
-, "<body>"
-]
-= unlines
-[ "</body>"
-, "</html>"
-]
-Language/Haskell/HsColour/Classify.hs
-
-
-module . Haskell. HsColour. Classify
-( TokenType( .. )
-, tokenise
-) where import import -- | Lex Haskell source code into an annotated token stream, without
--- discarding any characters or layout.
-:: String -> [ ( TokenType, String) ]
-=
-let = glue . chunk $ str
-= True : ( map ( "\n" `isPrefixOf` ) chunks)
-in ( \ ( s, n) -> ( classify s n, s) ) ( zip chunks newline)
--- Basic Haskell lexing, except we keep whitespace.
-:: String -> [ String]
-= []
-( '\r' : ) = chunk s -- get rid of DOS newline stuff
-( '\n' : ) = "\n" : ( c: ) | isLinearSpace c
-= ( c: ) : where ( ss, rest) = span isLinearSpace s
-( '{' : '-' : ) = let ( com, s') = nestcomment 0 s
-in ( '{' : '-' : ) : = case . lex s of -> [ head s] : ( tail s) -- e.g. inside comment
-( ( tok@ ( '-' : '-' : _ ) , rest) : _ )
-| all ( == '-' ) tok -> ( tok++ com) : where ( com, s') = eolcomment rest
-( ( tok, rest) : _ ) -> tok: = c `elem` " \t\f" -- " \t\xa0"
--- Glue sequences of tokens into more useful blobs
---glue (q:".":n:rest) | Char.isUpper (head q) -- qualified names
--- = glue ((q++"."++n): rest)
-( "`" : ) = -- `varid` -> varop
-case of ( qn: "`" : ) -> ( "`" ++ qn++ "`" ) : _ -> "`" : ( s: ) | all ( == '-' ) s && length s >= 2 -- eol comment
-= ( s++ concat c) : where ( c, rest) = break ( '\n' `elem` ) ss
---glue ("{":"-":ss) = ("{-"++c): glue rest -- nested comment
--- where (c,rest) = nestcomment 0 ss
-( "(" : ) = case of ")" : -> ( "(" ++ concat tuple ++ ")" ) : _ -> "(" : where ( tuple, rest) = span ( == "," ) ss
-( "[" : "]" : ) = "[]" : ( "\n" : "#" : ) = "\n" : ( '#' : ) : where ( line, rest) = break ( '\n' `elem` ) ss
-( s: ) = s: = []
--- Deal with comments.
-:: Int -> String -> ( String, String)
-( '{' : '-' : ) | n>= 0 = ( ( "{-" ++ cs) , rm)
-where ( cs, rm) = nestcomment ( n+ 1 ) ss
-( '-' : '}' : ) | n> 0 = ( ( "-}" ++ cs) , rm)
-where ( cs, rm) = nestcomment ( n- 1 ) ss
-( '-' : '}' : ) | n== 0 = ( "-}" , ss)
-( s: ) | n>= 0 = ( ( s: ) , rm)
-where ( cs, rm) = nestcomment n ss
-= ( [], [])
-:: String -> ( String, String)
-@ ( '\n' : _ ) = ( [], s)
-( '\r' : ) = eolcomment s
-( c: ) = ( c: , s') where ( cs, s') = eolcomment s
-= ( [], [])
--- | Classification of tokens as lexical entities
-data =
-| Keyword | Keyglyph | Layout | Comment | Conid | Varid |
-| Varop | String | Char | Number | Cpp | Error |
-deriving ( Eq, Show)
-:: String -> Bool -> TokenType
-@ ( h: ) newline
-| isSpace h = Space
-| all ( == '-' ) s = Comment
-| "--" `isPrefixOf` s
-&& any isSpace s = Comment -- not fully correct
-| "{-" `isPrefixOf` s = Comment
-| s `elem` keywords = Keyword
-| s `elem` keyglyphs = Keyglyph
-| s `elem` layoutchars = Layout
-| isUpper h = Conid
-| s == "[]" = Conid
-| h == '(' && isTupleTail t = Conid
-| h == '#' = Cpp
-| isLower h = if then else | h `elem` symbols = Varop
-| h== ':' = Conop
-| h== '`' = Varop
-| h== '"' = String
-| h== '\'' = Char
-| isDigit h = Number
-| otherwise = Error
-_ _ = Space
-[ ')' ] = True
-( ',' : ) = isTupleTail xs
-_ = False
--- Haskell keywords
-=
-[ "case" , "class" , "data" , "default" , "deriving" , "do" , "else" , "forall"
-, "if" , "import" , "in" , "infix" , "infixl" , "infixr" , "instance" , "let" , "module"
-, "newtype" , "of" , "qualified" , "then" , "type" , "where" , "_"
-, "foreign" , "ccall" , "as" , "safe" , "unsafe" ]
-=
-[ ".." , "::" , "=" , "\\" , "|" , "<-" , "->" , "@" , "~" , "=>" , "[" , "]" ]
-=
-( : ) ";{}(),"
-=
-"!#$%&*+./<=>?@\\^|-~"
-Language/Haskell/HsColour/ColourHighlight.hs
-
-
-module . Haskell. HsColour. ColourHighlight
-( Colour( .. )
-, Highlight( .. )
-) where -- | Colours supported by ANSI codes.
-data = Black | Red | Green | Yellow | Blue | Magenta | Cyan | White
-deriving ( Eq, Show, Read, Enum)
--- | Types of highlighting supported by ANSI codes (and some extra styles).
-data =
-| Bold
-| Dim
-| Underscore
-| Blink
-| ReverseVideo
-| Concealed
-| Foreground Colour
-| Background Colour
--- Above are ANSI-only. Below are extra styles.
-| Italic
-deriving ( Eq, Show, Read)
-Language/Haskell/HsColour/Colourise.hs
-
-
-module . Haskell. HsColour. Colourise
-( module . Haskell. HsColour. ColourHighlight
-, ColourPrefs( .. )
-, readColourPrefs
-, defaultColourPrefs
-, colourise
-) where import . Haskell. HsColour. ColourHighlight
-import . Haskell. HsColour. Classify ( TokenType( .. ) )
-import ( hPutStrLn, stderr)
-import ( getEnv)
-import -- | Colour preferences.
-data = ColourPrefs
-{ keyword, keyglyph, layout, comment
-, conid, varid, conop, varop
-, string, char, number, cpp
-, selection, variantselection, definition :: [ Highlight]
-} deriving ( Eq, Show, Read)
-= ColourPrefs
-{ keyword = [ Foreground Green, Underscore]
-, keyglyph = [ Foreground Red]
-, layout = [ Foreground Cyan]
-, comment = [ Foreground Blue, Italic]
-, conid = [ Normal]
-, varid = [ Normal]
-, conop = [ Foreground Red, Bold]
-, varop = [ Foreground Cyan]
-, string = [ Foreground Magenta]
-, char = [ Foreground Magenta]
-, number = [ Foreground Magenta]
-, cpp = [ Foreground Magenta, Dim]
-, selection = [ Bold, Foreground Magenta]
-, variantselection = [ Dim, Foreground Red, Underscore]
-, definition = [ Foreground Blue]
-}
--- NOTE, should we give a warning message on a failed reading?
-:: String -> String -> IO ColourPrefs
-=
-case of ( res, _ ) : _ -> return res
-_ -> do ( "Could not parse colour prefs from " ++ file
-++ ": reverting to defaults" )
--- | Read colour preferences from .hscolour file in the current directory, or failing that,
--- from \$HOME\/.hscolour, and failing that, returns a default set of prefs.
-:: IO ColourPrefs
-= catch
-( do <- readFile ".hscolour"
-".hscolour" val)
-( \ _ -> catch
-( do <- getEnv "HOME"
-<- readFile ( home++ "/.hscolour" )
-( home++ "/.hscolour" ) val)
-( \ _ -> return defaultColourPrefs) )
--- | Convert token classification to colour highlights.
-:: ColourPrefs -> TokenType -> [ Highlight]
-= [ Normal]
-= comment pref
-= keyword pref
-= keyglyph pref
-= layout pref
-= conid pref
-= varid pref
-= conop pref
-= varop pref
-= string pref
-= char pref
-= number pref
-= cpp pref
-= selection pref
-= definition pref
-Language/Haskell/HsColour/General.hs
-
-
-module . Haskell. HsColour. General(
-, dropFirst
-) where :: Eq a => a -> [ a] -> [ a]
-[ y] | x == y = []
-( y: ) = y : = []
-:: Eq a => a -> [ a] -> [ a]
-( y: ) | x == y = ys
-= ys
-Language/Haskell/HsColour/HTML.hs
-
-
--- | Formats Haskell source code using HTML with font tags.
-module . Haskell. HsColour. HTML
-( hscolour
-, top'n'tail
--- * Internals
-, renderAnchors, renderComment, renderNewLinesAnchors, escape
-) where import . Haskell. HsColour. Anchors
-import . Haskell. HsColour. Classify as import . Haskell. HsColour. Colourise
-import . Char( isAlphaNum)
--- | Formats Haskell source code using HTML with font tags.
-:: ColourPrefs -- ^ Colour preferences.
--> Bool -- ^ Whether to include anchors.
--> String -- ^ Haskell source code.
--> String -- ^ Coloured Haskell source code.
-=
-. ( if then . concatMap ( renderAnchors ( renderToken pref) )
-. insertAnchors
-else ( renderToken pref) )
-. tokenise
-:: String -> String -> String
-= ( htmlHeader title ++ ) . ( ++ htmlClose)
-:: String -> String
-= ( "<pre>" ++ ) . ( ++ "</pre>" )
-:: ColourPrefs -> ( TokenType, String) -> String
-( t, s) = fontify ( colourise pref t)
-( if == Comment then else )
-:: ( ( TokenType, String) -> String)
--> Either String ( TokenType, String) -> String
-_ ( Left v) = "<a name=\"" ++ v++ "\"></a>"
-( Right r) = render r
--- if there are http://links/ in a comment, turn them into
--- hyperlinks
-:: String -> String
-@ ( 'h' : 't' : 't' : 'p' : ':' : '/' : '/' : _ ) =
-++ renderComment b
-where -- see http://www.gbiv.com/protocols/uri/rfc/rfc3986.html#characters
-= isAlphaNum x || x `elem` ":/?#[]@!$&'()*+,;=-._~%"
-( a, b) = span isUrlChar xs
-= "<a href=\"" ++ link ++ "\">" ++ escape link ++ "</a>"
-( x: ) = escape [ x] ++ renderComment xs
-= []
-:: String -> String
-= unlines . map render . zip [ 1 .. ] . lines
-where ( line, s) = "<a name=\"line-" ++ show line ++ "\"></a>" ++ s
--- Html stuff
-= s
-( h: ) s = font h ( fontify hs s)
-= s
-= "<b>" ++ s++ "</b>"
-= "<em>" ++ s++ "</em>"
-= "<u>" ++ s++ "</u>"
-= "<blink>" ++ s++ "</blink>"
-= s
-= s
-( Foreground c) s = "<font color=" ++ show c++ ">" ++ s++ "</font>"
-( Background c) s = "<font bgcolor=" ++ show c++ ">" ++ s++ "</font>"
-= "<i>" ++ s++ "</i>"
-( '<' : ) = "<" ++ escape cs
-( '>' : ) = ">" ++ escape cs
-( '&' : ) = "&" ++ escape cs
-( c: ) = c: = []
-= unlines
-[ "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 3.2 Final//EN\">"
-, "<html>"
-, "<head>"
-, "<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->"
-, "<title>" ++ title++ "</title>"
-, "</head>"
-, "<body>"
-]
-= "\n</body>\n</html>"
-Language/Haskell/HsColour/InlineCSS.hs
-
-
--- | Formats Haskell source code as HTML with inline CSS.
-module . Haskell. HsColour. InlineCSS ( hscolour, top'n'tail) where import . Haskell. HsColour. Anchors
-import . Haskell. HsColour. Classify as import . Haskell. HsColour. Colourise
-import . Haskell. HsColour. HTML ( renderAnchors, renderComment,
-, escape)
--- | Formats Haskell source code as a complete HTML document with inline styling
-:: ColourPrefs -- ^ Preferences for styling.
--> Bool -- ^ Whether to include anchors.
--> String -- ^ Haskell source code.
--> String -- ^ An HTML document containing the coloured
--- Haskell source code.
-=
-. ( if then . concatMap ( renderAnchors ( renderToken prefs) )
-. insertAnchors
-else ( renderToken prefs) )
-. tokenise
-:: String -> String -> String
-= ( cssPrefix title ++ ) . ( ++ cssSuffix)
-:: String -> String
-= ( "<pre style=\"font-family:Consolas, Monaco, Monospace;\">" ++ )
-. ( ++ "</pre>" )
-:: ColourPrefs -> ( TokenType, String) -> String
-( cls, text) =
-( colourise prefs cls) $
-if == Comment then else :: [ Highlight] -> String -> String
-= "<span style=\"" ++ concatMap style hs ++ "\">" ++ s++ "</span>"
-= unlines
-[ "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">"
-, "<html>"
-, "<head>"
-, "<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->"
-, "<title>" ++ title++ "</title>"
-, "</head>"
-, "<body style=\"background-color: #131313; color: #ffffff;\">"
-]
-= unlines
-[ "</body>"
-, "</html>"
-]
-:: Highlight -> String
-= ""
-= "font-weight: bold;"
-= "font-weight: lighter;"
-= "text-decoration: underline;"
-= "text-decoration: blink;"
-= ""
-= "text-decoration: line-through;"
-( Foreground c) = "color: " ++ csscolour c++ ";"
-( Background c) = "background-colour: " ++ csscolour c++ ";"
-= "font-style: italic;"
-:: Colour -> String
-= "#000000"
-= "#ff0000"
-= "#00ff00"
-= "#ffff00"
-= "#0000ff"
-= "#ff00ff"
-= "#00ffff"
-= "#ffffff"
-Language/Haskell/HsColour/LaTeX.hs
-
-
--- | Formats Haskell source code using LaTeX macros.
-module . Haskell. HsColour. LaTeX ( hscolour, top'n'tail) where import . Haskell. HsColour. Classify as import . Haskell. HsColour. Colourise
-import . Haskell. HsColour. General
--- | Formats Haskell source code as a complete LaTeX document.
-:: ColourPrefs -- ^ Colour preferences.
--> String -- ^ Haskell source code.
--> String -- ^ A LaTeX document\/fragment containing the coloured
--- Haskell source code.
-= concatMap ( renderToken pref) . tokenise
-:: String -> String -> String
-= ( latexPrefix title++ ) . ( ++ latexSuffix)
--- | Wrap each lexeme in the appropriate LaTeX macro.
--- TODO: filter dangerous characters like "{}_$"
-:: ColourPrefs -> ( TokenType, String) -> String
-( Space, text) = filterSpace text
-( cls, text) =
-let = case of -> "``" ++ ( dropFirst '\"' $ dropLast '\"' $ text) ++ "''"
-_ -> text
-= colourise pref cls
-( pre, post) = unzip $ map latexHighlight style
-in ++ filterSpecial symb ++ concat post
--- | Filter white space characters.
-:: String
--> String
-( '\n' : ) = '\\' : '\\' : ( filterSpace ss)
-( ' ' : ) = "\\hsspace " ++ ( filterSpace ss)
-( '\t' : ) = "\\hstab " ++ ( filterSpace ss)
-( c: ) = c: ( filterSpace ss)
-= []
--- | Filters the characters "#$%&~_^\{}" which are special
--- in LaTeX.
-:: String -- ^ The string to filter.
--> String -- ^ The LaTeX-safe string.
-( '#' : ) = '\\' : '#' : ( filterSpecial cs)
-( '$' : ) = '\\' : '$' : ( filterSpecial cs)
-( '%' : ) = '\\' : '%' : ( filterSpecial cs)
-( '&' : ) = '\\' : '&' : ( filterSpecial cs)
-( '~' : ) = "\\tilde{ }" ++ ( filterSpecial cs)
-( '_' : ) = '\\' : '_' : ( filterSpecial cs)
-( '^' : ) = "\\ensuremath{\\hat{ }}" ++ ( filterSpecial cs)
-( '\\' : ) = "$\\backslash$" ++ ( filterSpecial cs)
-( '{' : ) = '\\' : '{' : ( filterSpecial cs)
-( '}' : ) = '\\' : '}' : ( filterSpecial cs)
-( '|' : ) = "\\ensuremath{|}" ++ ( filterSpecial cs)
-( '<' : '-' : ) = "\\ensuremath{\\leftarrow}" ++ ( filterSpecial cs)
-( '<' : ) = "\\ensuremath{\\langle}" ++ ( filterSpecial cs)
-( '-' : '>' : ) = "\\ensuremath{\\rightarrow}" ++ ( filterSpecial cs)
-( '>' : ) = "\\ensuremath{\\rangle}" ++ ( filterSpecial cs)
-( c: ) = c: ( filterSpecial cs)
-= []
--- | Constructs the appropriate LaTeX macro for the given style.
-:: Highlight -> ( String, String)
-= ( "{\\rm{}" , "}" )
-= ( "{\\bf{}" , "}" )
-= ( "" , "" )
-= ( "\\underline{" , "}" )
-= ( "" , "" )
-= ( "" , "" )
-= ( "\\conceal{" , "}" )
-( Foreground c) = ( "\\textcolor{" ++ latexColour c ++ "}{" , "}" )
-( Background c) = ( "\\colorbox{" ++ latexColour c ++ "}{" , "}" )
-= ( "{\\it{}" , "}" )
--- | Translate a 'Colour' into a LaTeX colour name.
-:: Colour -> String
-= "black"
-= "red"
-= "green"
-= "yellow"
-= "blue"
-= "magenta"
-= "cyan"
-= "white"
--- | Generic LaTeX document preamble.
-= unlines
-[ "\\documentclass[a4paper, 12pt]{article}"
-, "\\usepackage[usenames]{color}"
-, "\\usepackage{hyperref}"
-, "\\newsavebox{\\spaceb}"
-, "\\newsavebox{\\tabb}"
-, "\\savebox{\\spaceb}[1ex]{~}"
-, "\\savebox{\\tabb}[4ex]{~}"
-, "\\newcommand{\\hsspace}{\\usebox{\\spaceb}}"
-, "\\newcommand{\\hstab}{\\usebox{\\tabb}}"
-, "\\newcommand{\\conceal}[1]{}"
-, "\\title{" ++ title++ "}"
-, "%% Generated by HsColour"
-, "\\begin{document}"
-, "\\maketitle"
-, "\\noindent"
-]
--- | Generic LaTeX document postamble.
-= unlines
-[ ""
-, "\\end{document}"
-]
-Language/Haskell/HsColour/MIRC.hs
-
-
--- | Formats Haskell source code using mIRC codes.
--- (see http:\/\/irssi.org\/documentation\/formats)
-module . Haskell. HsColour. MIRC ( hscolour) where import . Haskell. HsColour. Classify as import . Haskell. HsColour. Colourise
-import . Char( isAlphaNum)
--- | Formats Haskell source code using mIRC codes.
-:: ColourPrefs -- ^ Colour preferences.
--> String -- ^ Haskell source code.
--> String -- ^ Coloured Haskell source code.
-= concatMap ( renderToken pref) . tokenise
-:: ColourPrefs -> ( TokenType, String) -> String
-( t, s) = fontify ( colourise pref t) s
--- mIRC stuff
-=
-( joinColours hs)
-. highlight ( filter ( `elem` [ Normal, Bold, Underscore, ReverseVideo] ) hs)
-where = s
-( h: ) s = font h ( highlight hs s)
-= s
-= '\^B' : ++ "\^B"
-= '\^_' : ++ "\^_"
-= '\^V' : ++ "\^V"
--- mIRC combines colour codes in a non-modular way
-data = Mirc { fg:: Colour, dim:: Bool, bg:: Maybe Colour, blink:: Bool}
-:: [ Highlight] -> MircColour
-= foldr join ( Mirc { fg= Black, dim= False, bg= Nothing, blink= False} )
-where = mirc { blink= True}
-= mirc { dim= True}
-( Foreground fg) mirc = mirc { fg= fg}
-( Background bg) mirc = mirc { bg= Just bg}
-= mirc { fg= Black, bg= Just Black}
-_ = mirc
-:: MircColour -> String -> String
-( Mirc fg dim Nothing blink) s = '\^C' : ++ s++ "\^O"
-( Mirc fg dim ( Just bg) blink) s = '\^C' : ++ ','
-: ++ s++ "\^O"
-:: Colour -> Bool -> String
-= "1"
-= "5"
-= "3"
-= "7"
-= "2"
-= "6"
-= "10"
-= "0"
-= "14"
-= "4"
-= "9"
-= "8"
-= "12"
-= "13"
-= "11"
-= "15"
-Language/Haskell/HsColour/Options.hs
-
-
-module . Haskell. HsColour. Options
-( Option( .. )
-, Output( .. )
-) where import . Haskell. HsColour. Output
--- | Command-line options
-data =
--- ^ print usage message
-| Version -- ^ report version
-| Information -- ^ report auxiliary information, e.g. CSS defaults
-| Format Output -- ^ what type of output to produce
-| LHS Bool -- ^ literate input (i.e. multiple embedded fragments)
-| Anchors Bool -- ^ whether to add anchors
-| Partial Bool -- ^ whether to produce a full document or partial
-| Input FilePath -- ^ input source file
-| Output FilePath -- ^ output source file
-deriving Language/Haskell/HsColour/Output.hs
-
-
-module . Haskell. HsColour. Output where -- | The supported output formats.
-data = TTY -- ^ ANSI terminal codes
-| LaTeX -- ^ TeX macros
-| HTML -- ^ HTML with font tags
-| CSS -- ^ HTML with CSS.
-| ICSS -- ^ HTML with inline CSS.
-| MIRC -- ^ mIRC chat clients
-deriving ( Eq, Show)
-Language/Haskell/HsColour/TTY.hs
-
-
--- | Highlights Haskell code with ANSI terminal codes.
-module . Haskell. HsColour. TTY ( hscolour) where import . Haskell. HsColour. ANSI as import . Haskell. HsColour. Classify
-import . Haskell. HsColour. Colourise
--- | Highlights Haskell code with ANSI terminal codes.
-:: ColourPrefs -- ^ Colour preferences.
--> String -- ^ Haskell source code.
--> String -- ^ Coloured Haskell source code.
-= concatMap ( renderToken pref) . tokenise
-:: ColourPrefs -> ( TokenType, String) -> String
-( t, s) = ANSI. highlight ( colourise pref t) s
-hscolour (Index) hscolour (Index) Index (B) Background Language.Haskell.HsColour.ColourHighlight , Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI Black Language.Haskell.HsColour.ColourHighlight , Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI Blink Language.Haskell.HsColour.ColourHighlight , Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI Blue Language.Haskell.HsColour.ColourHighlight , Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI Bold Language.Haskell.HsColour.ColourHighlight , Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
diff --git a/docs/hscolour/doc-index-C.html b/docs/hscolour/doc-index-C.html
deleted file mode 100644
--- a/docs/hscolour/doc-index-C.html
+++ /dev/null
@@ -1,394 +0,0 @@
-
-
-hscolour (Index) Index (C) CSS Language.Haskell.HsColour.Output , Language.Haskell.HsColour.Options , Language.Haskell.HsColour Char Language.Haskell.HsColour.Classify Colour Language.Haskell.HsColour.ColourHighlight , Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI ColourPrefs 1 (Type/Class) Language.Haskell.HsColour.Colourise , Language.Haskell.HsColour 2 (Data Constructor) Language.Haskell.HsColour.Colourise , Language.Haskell.HsColour Comment Language.Haskell.HsColour.Classify Concealed Language.Haskell.HsColour.ColourHighlight , Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI Conid Language.Haskell.HsColour.Classify Conop Language.Haskell.HsColour.Classify Cpp Language.Haskell.HsColour.Classify Cyan Language.Haskell.HsColour.ColourHighlight , Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI char Language.Haskell.HsColour.Colourise , Language.Haskell.HsColour clearDown Language.Haskell.HsColour.ANSI clearUp Language.Haskell.HsColour.ANSI clearbol Language.Haskell.HsColour.ANSI cleareol Language.Haskell.HsColour.ANSI clearline Language.Haskell.HsColour.ANSI cls Language.Haskell.HsColour.ANSI colourCycle Language.Haskell.HsColour.ANSI colourise Language.Haskell.HsColour.Colourise comment Language.Haskell.HsColour.Colourise , Language.Haskell.HsColour conid Language.Haskell.HsColour.Colourise , Language.Haskell.HsColour conop Language.Haskell.HsColour.Colourise , Language.Haskell.HsColour cpp Language.Haskell.HsColour.Colourise , Language.Haskell.HsColour cursorDown Language.Haskell.HsColour.ANSI cursorLeft Language.Haskell.HsColour.ANSI cursorRight Language.Haskell.HsColour.ANSI cursorUp Language.Haskell.HsColour.ANSI
diff --git a/docs/hscolour/doc-index-D.html b/docs/hscolour/doc-index-D.html
deleted file mode 100644
--- a/docs/hscolour/doc-index-D.html
+++ /dev/null
@@ -1,194 +0,0 @@
-
-
-hscolour (Index) hscolour (Index) hscolour (Index) hscolour (Index) hscolour (Index) hscolour (Index) hscolour (Index) hscolour (Index) hscolour (Index) hscolour (Index) hscolour (Index) hscolour (Index) hscolour (Index) hscolour (Index) hscolour (Index) hscolour (Index) hscolour (Index) hscolour (Index) hscolour (Index) hscolour (Index) font is a little too small in MSIE */
-TT { font-size: 100%; }
-PRE { font-size: 100%; }
-
-LI P { margin: 0pt }
-
-TD {
- border-width: 0px;
-}
-
-TABLE.narrow {
- border-width: 0px;
-}
-
-TD.s8 { height: 8px; }
-TD.s15 { height: 15px; }
-
-SPAN.keyword { text-decoration: underline; }
-
-/* Resize the buttom image to match the text size */
-IMG.coll { width : 0.75em; height: 0.75em; margin-bottom: 0; margin-right: 0.5em }
-
-/* --------- Contents page ---------- */
-
-DIV.node {
- padding-left: 3em;
-}
-
-DIV.cnode {
- padding-left: 1.75em;
-}
-
-SPAN.pkg {
- position: absolute;
- left: 50em;
-}
-
-/* --------- Documentation elements ---------- */
-
-TD.children {
- padding-left: 25px;
- }
-
-TD.synopsis {
- padding: 2px;
- background-color: #f0f0f0;
- font-family: monospace
- }
-
-TD.decl {
- padding: 2px;
- background-color: #f0f0f0;
- font-family: monospace;
- vertical-align: top;
- }
-
-TD.topdecl {
- padding: 2px;
- background-color: #f0f0f0;
- font-family: monospace;
- vertical-align: top;
-}
-
-TABLE.declbar {
- border-spacing: 0px;
- }
-
-TD.declname {
- width: 100%;
- }
-
-TD.declbut {
- padding-left: 5px;
- padding-right: 5px;
- border-left-width: 1px;
- border-left-color: #000099;
- border-left-style: solid;
- white-space: nowrap;
- font-size: small;
- }
-
-/*
- arg is just like decl, except that wrapping is not allowed. It is
- used for function and constructor arguments which have a text box
- to the right, where if wrapping is allowed the text box squashes up
- the declaration by wrapping it.
-*/
-TD.arg {
- padding: 2px;
- background-color: #f0f0f0;
- font-family: monospace;
- vertical-align: top;
- white-space: nowrap;
- }
-
-TD.recfield { padding-left: 20px }
-
-TD.doc {
- padding-top: 2px;
- padding-left: 10px;
- }
-
-TD.ndoc {
- padding: 2px;
- }
-
-TD.rdoc {
- padding: 2px;
- padding-left: 10px;
- width: 100%;
- }
-
-TD.body {
- padding-left: 10px
- }
-
-TD.pkg {
- width: 100%;
- padding-left: 10px
-}
-
-TD.indexentry {
- vertical-align: top;
- padding-right: 10px
- }
-
-TD.indexannot {
- vertical-align: top;
- padding-left: 20px;
- white-space: nowrap
- }
-
-TD.indexlinks {
- width: 100%
- }
-
-/* ------- Section Headings ------- */
-
-TD.section1 {
- padding-top: 15px;
- font-weight: bold;
- font-size: 150%
- }
-
-TD.section2 {
- padding-top: 10px;
- font-weight: bold;
- font-size: 130%
- }
-
-TD.section3 {
- padding-top: 5px;
- font-weight: bold;
- font-size: 110%
- }
-
-TD.section4 {
- font-weight: bold;
- font-size: 100%
- }
-
-/* -------------- The title bar at the top of the page */
-
-TD.infohead {
- color: #ffffff;
- font-weight: bold;
- padding-right: 10px;
- text-align: left;
-}
-
-TD.infoval {
- color: #ffffff;
- padding-right: 10px;
- text-align: left;
-}
-
-TD.topbar {
- background-color: #000099;
- padding: 5px;
-}
-
-TD.title {
- color: #ffffff;
- padding-left: 10px;
- width: 100%
- }
-
-TD.topbut {
- padding-left: 5px;
- padding-right: 5px;
- border-left-width: 1px;
- border-left-color: #ffffff;
- border-left-style: solid;
- white-space: nowrap;
- }
-
-TD.topbut A:link {
- color: #ffffff
- }
-
-TD.topbut A:visited {
- color: #ffff00
- }
-
-TD.topbut A:hover {
- background-color: #6060ff;
- }
-
-TD.topbut:hover {
- background-color: #6060ff
- }
-
-TD.modulebar {
- background-color: #0077dd;
- padding: 5px;
- border-top-width: 1px;
- border-top-color: #ffffff;
- border-top-style: solid;
- }
-
-/* --------- The page footer --------- */
-
-TD.botbar {
- background-color: #000099;
- color: #ffffff;
- padding: 5px
- }
-TD.botbar A:link {
- color: #ffffff;
- text-decoration: underline
- }
-TD.botbar A:visited {
- color: #ffff00
- }
-TD.botbar A:hover {
- background-color: #6060ff
- }
-
diff --git a/docs/hscolour/haddock.js b/docs/hscolour/haddock.js
deleted file mode 100644
--- a/docs/hscolour/haddock.js
+++ /dev/null
@@ -1,15 +0,0 @@
-// Haddock JavaScript utilities
-function toggle(button,id)
-{
- var n = document.getElementById(id).style;
- if (n.display == "none")
- {
- button.src = "minus.gif";
- n.display = "block";
- }
- else
- {
- button.src = "plus.gif";
- n.display = "none";
- }
-}
diff --git a/docs/hscolour/haskell_icon.gif b/docs/hscolour/haskell_icon.gif
deleted file mode 100644
Binary files a/docs/hscolour/haskell_icon.gif and /dev/null differ
diff --git a/docs/hscolour/index.html b/docs/hscolour/index.html
deleted file mode 100644
--- a/docs/hscolour/index.html
+++ /dev/null
@@ -1,245 +0,0 @@
-
-
-hscolour Modules
Produced by Haddock version 0.8
diff --git a/docs/hscolour/minus.gif b/docs/hscolour/minus.gif
deleted file mode 100644
Binary files a/docs/hscolour/minus.gif and /dev/null differ
diff --git a/docs/hscolour/plus.gif b/docs/hscolour/plus.gif
deleted file mode 100644
Binary files a/docs/hscolour/plus.gif and /dev/null differ
diff --git a/hscolour.cabal b/hscolour.cabal
--- a/hscolour.cabal
+++ b/hscolour.cabal
@@ -1,5 +1,5 @@
Name: hscolour
-Version: 1.16
+Version: 1.17
Copyright: 2003-2010 Malcolm Wallace, University of York; 2006 Bjorn Bringert
Maintainer: Malcolm Wallace
Author: Malcolm Wallace
diff --git a/index.html b/index.html
deleted file mode 100644
--- a/index.html
+++ /dev/null
@@ -1,234 +0,0 @@
-
-hscolour
-
-
-
-
- hscolour
-
-
-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 client codes.
-
-
Example
-
-Here's a little example of the HTML output:
module ( main) where import -- The notorious nfib "benchmark", but using Doubles.
- main = print ( nfib 30 )
-
- nfib :: Double -> Double
- nfib n = if <= 1
- then 1
- else ( n`subtract` 1 ) + nfib ( n`subtract` 2 ) + 1
-
-
-Download
-
-
-
-Build
-
-Just use one of the standard ways of building a Haskell program:
-
-cabal install hscolour
-hmake HsColour
-ghc --make HsColour
-runhugs HsColour
-runhaskell Setup.hs configure/build/install
-
-
-Use
-
-
-
-You can colourise a Haskell source file for either ANSI terminal codes
-(option -tty ), or HTML 3.2 with font tags (option
--html ), or HTML 4.01 output with CSS (option -css ), or
-for XHTML 1.0 with inline CSS styling (option -icss ), or for
-LaTeX (option -latex ), or for IRC (option -mirc ). The
-default is for terminal output.
-
-If no file argument is given, it reads standard input. Output is
-written to file OUTPUT (option -o), defaulting to stdout. Multiple input
-files will be concatenated to the same output.
-
-HsColour can add named anchors in HTML (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
-(e.g. from haddock -generated
-library documentation). See below for details.
-
-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 individual colourised fragments into a
-larger document, use the -partial option with each
-fragment, to omit the HTML DOCTYPE header, CSS stylesheet link, or LaTeX
-prologue.
-
-
-
Configuration of colours
-
-If you use any output-format choice except -css , 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.)
-For (non-inline) CSS output, it is sufficient to edit the
-hscolour.css emacs.css -print-css option
-prints out the default CSS definitions, in case you lose the .css file.
-
-
-The .hscolour file format is a simple Haskell value of type
-ColourPrefs, constructed using named fields, as follows:
-
-
data = ColourPrefs
- { keyword, keyglyph, layout, comment
- , conid, varid, conop, varop
- , string, char, number , cpp
- , selection, variantselection
- , definition :: [ Highlight]
- }
-
- data = Black | Red | Green | Yellow | Blue | Magenta | Cyan | White
-
- data =
- Normal
- | Bold
- | Dim
- | Underscore
- | Blink
- | ReverseVideo
- | Concealed
- | Foreground Colour
- | Background Colour
- | Italic
-
-
-
-
Use it as a library
-If you want to incorporate hscolour-like functionality into your own
-Haskell program, it is now (from 1.4) also available as a library,
-thanks to Björn Bringert. The library is Cabal-ised, so just do
-the usual thing to install it as a package:
-
-runhaskell Setup.hs configure
-runhaskell Setup.hs build
-runhaskell Setup.hs install
-
-There is
-haddock documentation of the API .
-
-
-
Using HsColour with Haddock
-Let's say you want to generate some pretty-coloured HTML versions of
-your source files, at the same time as you are generating library
-documentation using Haddock .
-Haddock (0.8 onwards) has options to link the API docs to the source
-code itself. Here is a quick summary of the shell commands to use:
-
-for file in $(SRCS)
-do HsColour -html -anchor $file >docs/`dirname $file`/`basename $file .hs`.html
-done
-haddock --html --title="My Library" --odir=docs $(SRCS) \
- --source-module="src/%{MODULE/.//}.html" \
- --source-entity="src/%{MODULE/.//}.html#%{NAME}"
-
-
-
-
Copyright and licence
-hscolour is © Malcolm Wallace 2003-2009. It is distributed
-under the Gnu GPL, which can be found in the file
-LICENCE-GPL .
-
-Shortcomings
-
-HsColour is not yet able to add anchors to class methods, nor to
-foreign decls.
-
-
Alternatives
-
-The
-Programatica project has a more sophisticated HTML
-syntax-highlighter. It hyperlinks every usage of an identifier to its
-definition, which is highly useful for browsing large amounts of code.
-However, it is a more heavyweight solution as well - requiring the
-entire front-end of a compiler not only to parse the Haskell code, but
-to chase all its module dependencies as well. As a consequence, you need
-source access to every definition used in your program, including the
-Prelude and all library packages...
-
-
History
-
-
-1.16 deal with UTF-8 sources in ghc-6.12.x
-1.15 makes -nopartial the default for literate files
-1.14 merges the -lit and -lit-tex options, adds -lit guessing,
- and permits multiple input files
-1.13 added the new -icss output format, and italic highlights
-1.12 changed the CSS class names to avoid clashes with other
- web tools
-1.11 new literate input option -lit-tex
-1.10.1 reports the correct version with the --version flag
-1.10 the title of HTML output is now the filename
-1.9 added the -mirc and -lit options, and -print-css
-1.8 added highlights for cpp lines
-
-1.7 renamed -anchorHTML -anchorCSS options to -anchor,
- added -partial option
-1.6 added -latex output mode
-1.5 move generated HTML anchors to before comments/typesigs
-1.4 made available as a Cabal-ised library
-1.3 added HTML and CSS anchors
-1.2 added CSS output mode (from Neil Mitchell)
-1.1 fixed compatibility with ghc-6.4
-1.0 first release
-
-
-
-This page last modified: 1st February 2010
-
-
Instances