diff --git a/HsColour.hs b/HsColour.hs --- a/HsColour.hs +++ b/HsColour.hs @@ -93,9 +93,10 @@ -- Rather than have a separate .css file, define some reasonable defaults here. cssDefaults = "\ -\.keyglyph, .layout {color: red;}\n\ -\.keyword {color: blue;}\n\ -\.comment, .comment a {color: green;}\n\ -\.str, .chr {color: teal;}\n\ -\.keyword,.conid, .varid, .conop, .varop, .num, .cpp, .sel, .definition {}\n\ +\.hs-keyglyph, .hs-layout {color: red;}\n\ +\.hs-keyword {color: blue;}\n\ +\.hs-comment, .hs-comment a {color: green;}\n\ +\.hs-str, .hs-chr {color: teal;}\n\ +\.hs-keyword, .hs-conid, .hs-varid, .hs-conop, .hs-varop, .hs-num, \ +\.hs-cpp, .hs-sel, .hs-definition {}\n\ \" 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 @@ -39,20 +39,20 @@ cls2 = cssClass cls -cssClass Keyword = "keyword" -cssClass Keyglyph = "keyglyph" -cssClass Layout = "layout" -cssClass Comment = "comment" -cssClass Conid = "conid" -cssClass Varid = "varid" -cssClass Conop = "conop" -cssClass Varop = "varop" -cssClass String = "str" -cssClass Char = "chr" -cssClass Number = "num" -cssClass Cpp = "cpp" -cssClass Error = "sel" -cssClass Definition = "definition" +cssClass Keyword = "hs-keyword" +cssClass Keyglyph = "hs-keyglyph" +cssClass Layout = "hs-layout" +cssClass Comment = "hs-comment" +cssClass Conid = "hs-conid" +cssClass Varid = "hs-varid" +cssClass Conop = "hs-conop" +cssClass Varop = "hs-varop" +cssClass String = "hs-str" +cssClass Char = "hs-chr" +cssClass Number = "hs-num" +cssClass Cpp = "hs-cpp" +cssClass Error = "hs-sel" +cssClass Definition = "hs-definition" cssClass _ = "" diff --git a/Makefile b/Makefile --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ LIBRARY = hscolour -VERSION = 1.11 +VERSION = 1.12 DIRS = Language/Haskell/HsColour diff --git a/docs/hscolour/Language-Haskell-HsColour-Options.html b/docs/hscolour/Language-Haskell-HsColour-Options.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language-Haskell-HsColour-Options.html @@ -0,0 +1,659 @@ + + +Language.Haskell.HsColour.Options
hscolourSource codeContentsIndex
Language.Haskell.HsColour.Options
Synopsis
data Option
= Help
| Version
| Information
| Format Output
| LHS Literate
| Anchors Bool
| Partial Bool
| Input FilePath
| Output FilePath
data Output
= TTY
| LaTeX
| HTML
| CSS
| MIRC
data Literate
= NoLit
| Bird
| TeX
Documentation
data Option Source
Command-line options +
Constructors
Helpprint usage message +
Versionreport version +
Informationreport auxiliary information, e.g. CSS defaults +
Format Outputwhat type of output to produce +
LHS Literateliterate 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 +
show/hide Instances
data Output Source
The supported output formats. +
Constructors
TTYANSI terminal codes +
LaTeXTeX macros +
HTMLHTML with font tags +
CSSHTML with CSS. +
MIRCmIRC chat clients +
show/hide Instances
Eq Output
Show Output
data Literate Source
Constructors
NoLit
Bird
TeX
show/hide Instances
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-Output.html b/docs/hscolour/Language-Haskell-HsColour-Output.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language-Haskell-HsColour-Output.html @@ -0,0 +1,279 @@ + + +Language.Haskell.HsColour.Output
hscolourSource codeContentsIndex
Language.Haskell.HsColour.Output
Synopsis
data Output
= TTY
| LaTeX
| HTML
| CSS
| MIRC
Documentation
data Output Source
The supported output formats. +
Constructors
TTYANSI terminal codes +
LaTeXTeX macros +
HTMLHTML with font tags +
CSSHTML with CSS. +
MIRCmIRC chat clients +
show/hide Instances
Eq Output
Show Output
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour.html b/docs/hscolour/Language-Haskell-HsColour.html --- a/docs/hscolour/Language-Haskell-HsColour.html +++ b/docs/hscolour/Language-Haskell-HsColour.html @@ -220,7 +220,9 @@ >Output -> ColourPrefs -> Bool -> Bool -> Bool -> String -> String -> String -> Bool -> Bool -> Literate -> String -> String -> String-> Bool-> LiterateWhether input document is literate haskell or not import qualified Language.Haskell.HsColour.CSS as CSS import qualified Language.Haskell.HsColour.LaTeX as LaTeX import qualified Language.Haskell.HsColour.MIRC as MIRC - --- | The supported output formats. -data Output = TTY -- ^ ANSI terminal codes - | LaTeX -- ^ TeX macros - | HTML -- ^ HTML with font tags - | CSS -- ^ HTML with CSS. - | MIRC -- ^ mIRC chat clients - deriving (Eq,Show) - --- | Colourise Haskell source code with the given output format. -hscolour :: Output -- ^ Output format. - -> ColourPrefs -- ^ Colour preferences (for formats that support them). - -> Bool -- ^ Whether to include anchors. - -> Bool -- ^ Whether output document is partial or complete. - -> Bool -- ^ Whether input document is literate haskell or not - -> String -- ^ Title for output. - -> String -- ^ Haskell source code. - -> String -- ^ Coloured Haskell source code. -hscolour output pref anchor partial literate title - | literate = concatMap chunk . joinL . map lhsClassify . inlines - | otherwise = hscolour' output pref anchor partial title - where - chunk (Literate c) = c - chunk (Code c) = hscolour' output pref anchor True title c +import Data.List(mapAccumL, isPrefixOf) +import Data.Maybe +import Language.Haskell.HsColour.Output +import Language.Haskell.HsColour.Options (Literate(..)) +import Debug.Trace + +-- | Colourise Haskell source code with the given output format. +hscolour :: Output -- ^ Output format. + -> ColourPrefs -- ^ Colour preferences (for formats that support them). + -> Bool -- ^ Whether to include anchors. + -> Bool -- ^ Whether output document is partial or complete. + -> Literate -- ^ Whether input document is literate haskell or not + -> String -- ^ Title for output. + -> String -- ^ Haskell source code. + -> String -- ^ Coloured Haskell source code. +hscolour output pref anchor partial literate title = + case literate of + NoLit -> hscolour' output pref anchor partial title + Bird -> literateHandler (map lhsClassify) + TeX -> literateHandler (snd . mapAccumL decideTypeOfLine False) + where + literateHandler f = concatMap chunk . joinL . f . inlines + chunk (Lit c) = c + chunk (Code c) = hscolour' output pref anchor True title c hscolour' :: Output -- ^ Output format. -> ColourPrefs -- ^ Colour preferences (for formats that support them). @@ -65,8 +65,8 @@ hscolour' HTML pref anchor partial top = HTML.hscolour pref anchor partial top hscolour' CSS _ anchor partial top = CSS.hscolour anchor partial top --- | Separating literate files into code\/comment chunks. -data Literate = Code {unL :: String} | Literate {unL :: String} +-- | Separating literate files into code\/comment chunks. +data Lit = 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. @@ -82,16 +82,25 @@ -- Note, I just pass the > symbol to the colouriser, which assumes that -- it's token based and not parse-based!!! -lhsClassify :: String -> Literate +lhsClassify :: String -> Lit lhsClassify ('>':xs) = Code ('>':xs) -lhsClassify xs = Literate xs +lhsClassify xs = Lit xs -joinL :: [Literate] -> [Literate] -joinL [] = [] -joinL (Code c:Code c2:xs) = joinL (Code (c++c2):xs) -joinL (Literate c:Literate c2:xs) = joinL (Literate (c++c2):xs) -joinL (any:xs) = any: joinL xs - +-- texstyle is a bool indicating whether we are currently inside a code block +decideTypeOfLine texStyle current_line + | isPrefix "\\begin{code}" = codeLine + | texStyle = if not is_end then codeLine else (False, Code (current_line )) + | otherwise = (False, Lit current_line) + where isPrefix = flip isPrefixOf current_line + codeLine = (True, Code (current_line)) + is_end = isPrefix "\\end{code}" + +joinL :: [Lit] -> [Lit] +joinL [] = [] +joinL (Code c:Code c2:xs) = joinL (Code (c++c2):xs) +joinL (Lit c :Lit c2 :xs) = joinL (Lit (c++c2):xs) +joinL (any:xs) = any: joinL xs + diff --git a/docs/hscolour/Language/Haskell/HsColour/CSS.html b/docs/hscolour/Language/Haskell/HsColour/CSS.html --- a/docs/hscolour/Language/Haskell/HsColour/CSS.html +++ b/docs/hscolour/Language/Haskell/HsColour/CSS.html @@ -46,20 +46,20 @@ cls2 = cssClass cls -cssClass Keyword = "keyword" -cssClass Keyglyph = "keyglyph" -cssClass Layout = "layout" -cssClass Comment = "comment" -cssClass Conid = "conid" -cssClass Varid = "varid" -cssClass Conop = "conop" -cssClass Varop = "varop" -cssClass String = "str" -cssClass Char = "chr" -cssClass Number = "num" -cssClass Cpp = "cpp" -cssClass Error = "sel" -cssClass Definition = "definition" +cssClass Keyword = "hs-keyword" +cssClass Keyglyph = "hs-keyglyph" +cssClass Layout = "hs-layout" +cssClass Comment = "hs-comment" +cssClass Conid = "hs-conid" +cssClass Varid = "hs-varid" +cssClass Conop = "hs-conop" +cssClass Varop = "hs-varop" +cssClass String = "hs-str" +cssClass Char = "hs-chr" +cssClass Number = "hs-num" +cssClass Cpp = "hs-cpp" +cssClass Error = "hs-sel" +cssClass Definition = "hs-definition" cssClass _ = "" diff --git a/docs/hscolour/Language/Haskell/HsColour/Options.html b/docs/hscolour/Language/Haskell/HsColour/Options.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language/Haskell/HsColour/Options.html @@ -0,0 +1,32 @@ + + + + +Language/Haskell/HsColour/Options.hs + + +
module Language.Haskell.HsColour.Options
+  ( Option(..)
+  , Output(..)
+  , Literate(..)
+  ) where 
+
+import Language.Haskell.HsColour.Output
+
+-- | Command-line options
+data Option =
+    Help		-- ^ print usage message
+  | Version		-- ^ report version
+  | Information		-- ^ report auxiliary information, e.g. CSS defaults
+  | Format Output	-- ^ what type of output to produce
+  | LHS Literate	-- ^ 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 Eq
+
+data Literate = NoLit | Bird | TeX deriving Eq
+
+ + diff --git a/docs/hscolour/Language/Haskell/HsColour/Output.html b/docs/hscolour/Language/Haskell/HsColour/Output.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language/Haskell/HsColour/Output.html @@ -0,0 +1,19 @@ + + + + +Language/Haskell/HsColour/Output.hs + + +
module Language.Haskell.HsColour.Output where
+
+-- | The supported output formats.
+data Output = TTY   -- ^ ANSI terminal codes
+            | LaTeX -- ^ TeX macros
+            | HTML  -- ^ HTML with font tags
+            | CSS   -- ^ HTML with CSS.
+            | MIRC  -- ^ mIRC chat clients
+  deriving (Eq,Show)
+
+ + diff --git a/docs/hscolour/doc-index-A.html b/docs/hscolour/doc-index-A.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-A.html @@ -0,0 +1,150 @@ + + +hscolour (Index)
hscolourContentsIndex
ABCDEFGHIKLMNOPRSTUVWY
Index (A)
AnchorsLanguage.Haskell.HsColour.Options
diff --git a/docs/hscolour/doc-index-B.html b/docs/hscolour/doc-index-B.html --- a/docs/hscolour/doc-index-B.html +++ b/docs/hscolour/doc-index-B.html @@ -35,6 +35,10 @@ >OLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
ABPR
BirdLanguage.Haskell.HsColour.Options
O
ABPRCSSLanguage.Haskell.HsColour.Output, Language.Haskell.HsColour.Options, Language.Haskell.HsColour
ABOP
ABOPOLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
ABPR
FormatLanguage.Haskell.HsColour.Options
ABOPO
ABPRHTMLLanguage.Haskell.HsColour.Output, Language.Haskell.HsColour.Options, Language.Haskell.HsColour
HelpLanguage.Haskell.HsColour.Options
O
ABPR
InformationLanguage.Haskell.HsColour.Options
InputLanguage.Haskell.HsColour.Options
insertAnchors
ABOPO
ABPR
LHSLanguage.Haskell.HsColour.Options
LaTeXLanguage.Haskell.HsColour.Output, Language.Haskell.HsColour.Options, Language.Haskell.HsColour
Language.Haskell.HsColour.Classify
LiterateLanguage.Haskell.HsColour.Options
O
ABPRMIRCLanguage.Haskell.HsColour.Output, Language.Haskell.HsColour.Options, Language.Haskell.HsColour
O
ABPR
NoLitLanguage.Haskell.HsColour.Options
Normal
O
ABPR
+ +hscolour (Index)
OptionLanguage.Haskell.HsColour.Options
Output
1 (Data Constructor)Language.Haskell.HsColour.Options
2 (Type/Class)Language.Haskell.HsColour.Output, Language.Haskell.HsColour.Options, Language.Haskell.HsColour
hscolourContentsIndex
ABCDEFGHIKLMNOPRSTUVWY
Index (P)
PartialLanguage.Haskell.HsColour.Options
diff --git a/docs/hscolour/doc-index-R.html b/docs/hscolour/doc-index-R.html --- a/docs/hscolour/doc-index-R.html +++ b/docs/hscolour/doc-index-R.html @@ -35,6 +35,10 @@ >
ABOP
ABOPO
ABPRTTYLanguage.Haskell.HsColour.Output, Language.Haskell.HsColour.Options, Language.Haskell.HsColour
TeXLanguage.Haskell.HsColour.Options
ABOPO
ABPRLanguage.Haskell.HsColour.Classify
VersionLanguage.Haskell.HsColour.Options
ABOP
ABOP Download a tarfile package from: ftp://ftp.cs.york.ac.uk/pub/haskell/contrib/ + + http://www.cs.york.ac.uk/fp/darcs/hscolour/hscolour-1.11.tar.gz + + http://www.cs.york.ac.uk/fp/darcs/hscolour/hscolour-1.11.zip
  • Or use the darcs repository at
    darcs get http://www.cs.york.ac.uk/fp/darcs/hscolour
  • Sources and history are browsable on-line through @@ -101,9 +105,10 @@ called .hscolour in the current directory. (An example is included in the distribution.) For CSS output, it is sufficient to edit the -hscolour.css file, also in -the distribution. The -print-css option prints out the default -CSS definitions, in case you lose the .css file. +hscolour.css file, also in the +distribution. (An alternative choice is supplied as +emacs.css.) The -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 @@ -188,8 +193,10 @@

    History

    -
    1.11
    new literate input option -lit-tex -
    1.10.1
    reports the correct version with the --version flag +
    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 @@ -207,7 +214,7 @@

    -This page last modified: 19th Jan 2009
    +This page last modified: 2nd Feb 2009
    Malcolm Wallace

    • ABOP
    Language.Haskell.HsColour.Options
    Language.Haskell.HsColour.Output
    Language.Haskell.HsColour.TTY