diff --git a/.hscolour b/.hscolour new file mode 100644 --- /dev/null +++ b/.hscolour @@ -0,0 +1,15 @@ +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] + , selection = [Bold, Foreground Magenta] + , variantselection = [Dim, Foreground Red, Underscore] + } diff --git a/HsColour.hs b/HsColour.hs new file mode 100644 --- /dev/null +++ b/HsColour.hs @@ -0,0 +1,44 @@ +module Main where + +import Language.Haskell.HsColour +import Language.Haskell.HsColour.Colourise (readColourPrefs) + +import System +import IO (hPutStrLn,hFlush,stdout,stderr,hSetBuffering,BufferMode(..)) + +version = "1.6" + +main :: IO () +main = do + prog <- System.getProgName + args <- System.getArgs + pref <- readColourPrefs + (ioWrapper,output,anchors) <- case args of + [] -> errorOut (help prog) + ["-h"] -> errorOut (help prog) + ["-help"] -> errorOut (help prog) + ["--help"] -> errorOut (help prog) + ["-v"] -> errorOut (prog++" "++version) + ["-version"] -> errorOut (prog++" "++version) + ["--version"] -> errorOut (prog++" "++version) + ["-tty"] -> return (ttyInteract, TTY, False) + ["-html"] -> return (ttyInteract, HTML, False) + ["-css"] -> return (ttyInteract, CSS, False) + ["-latex"] -> return (ttyInteract, LaTeX,False) + ["-anchorHTML"] -> return (ttyInteract, HTML, True) + ["-anchorCSS"] -> return (ttyInteract, CSS, True) + [a] -> return (fileInteract a, TTY, False) + ["-tty",a] -> return (fileInteract a, TTY, False) + ["-html",a] -> return (fileInteract a, HTML, False) + ["-css",a] -> return (fileInteract a, CSS, False) + ["-latex",a] -> return (fileInteract a, LaTeX,False) + ["-anchorHTML",a] -> return (fileInteract a, HTML, True) + ["-anchorCSS",a] -> return (fileInteract a, CSS, True) + _ -> errorOut (help prog) + ioWrapper (hscolour output pref anchors) + hFlush stdout + where + fileInteract f u = do readFile f >>= putStr . u + ttyInteract s = do hSetBuffering stdout NoBuffering >> Prelude.interact s + errorOut s = hPutStrLn stderr s >> hFlush stderr >> exitFailure + help p = "Usage: "++p++" [-tty|-html|-css|-latex|-anchorHTML|-anchorCSS] [file.hs]" diff --git a/LICENCE-GPL b/LICENCE-GPL new file mode 100644 --- /dev/null +++ b/LICENCE-GPL @@ -0,0 +1,342 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/Language/Haskell/HsColour.hs b/Language/Haskell/HsColour.hs new file mode 100644 --- /dev/null +++ b/Language/Haskell/HsColour.hs @@ -0,0 +1,36 @@ +-- | This is a library with colourises Haskell code. +-- It currently has three output formats: +-- +-- * ANSI terminal codes +-- +-- * LaTeX macros +-- +-- * HTML with font tags +-- +-- * HTML with CSS. +-- +module Language.Haskell.HsColour (Output(..), ColourPrefs(..), + hscolour) where + +import Language.Haskell.HsColour.Colourise (ColourPrefs(..)) +import qualified Language.Haskell.HsColour.TTY as TTY +import qualified Language.Haskell.HsColour.HTML as HTML +import qualified Language.Haskell.HsColour.CSS as CSS +import qualified Language.Haskell.HsColour.LaTeX as LaTeX + +-- | The supported output formats. +data Output = TTY -- ^ ANSI terminal codes + | LaTeX -- ^ TeX macros + | HTML -- ^ HTML with font tags + | CSS -- ^ HTML with CSS. + +-- | Colourise Haskell source code with the give output format. +hscolour :: Output -- ^ Output format. + -> ColourPrefs -- ^ Colour preferences for formats that support it. + -> Bool -- ^ Whether to include anchors. + -> String -- ^ Haskell source code. + -> String -- ^ Coloured Haskell source code. +hscolour TTY pref _ = TTY.hscolour pref +hscolour LaTeX pref _ = LaTeX.hscolour pref +hscolour HTML pref anchor = HTML.hscolour pref anchor +hscolour CSS _ anchor = CSS.hscolour anchor diff --git a/Language/Haskell/HsColour/ANSI.hs b/Language/Haskell/HsColour/ANSI.hs new file mode 100644 --- /dev/null +++ b/Language/Haskell/HsColour/ANSI.hs @@ -0,0 +1,93 @@ +-- Partially taken from Hugs AnsiScreen.hs library: +module Language.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 Language.Haskell.HsColour.ColourHighlight + +import List (intersperse,isPrefixOf) +import Char (isDigit) + + +-- Basic screen control codes: + +type Pos = (Int,Int) + +at :: Pos -> String -> String +goto :: Int -> Int -> String +home :: String +cls :: String + +at (x,y) s = goto x y ++ s +goto x y = '\ESC':'[':(show y ++(';':show x ++ "H")) +home = goto 1 1 + +cursorUp = "\ESC[A" +cursorDown = "\ESC[B" +cursorRight = "\ESC[C" +cursorLeft = "\ESC[D" + +cleareol = "\ESC[K" +clearbol = "\ESC[1K" +clearline = "\ESC[2K" +clearDown = "\ESC[J" +clearUp = "\ESC[1J" +-- Choose whichever of the following lines is suitable for your system: +cls = "\ESC[2J" -- for PC with ANSI.SYS +--cls = "\^L" -- for Sun window + +savePosition = "\ESC7" +restorePosition = "\ESC8" + + +-- data Colour -- imported from ColourHighlight +-- data Highlight -- imported from ColourHighlight + +instance Enum Highlight where + fromEnum Normal = 0 + fromEnum Bold = 1 + fromEnum Dim = 2 + fromEnum Underscore = 4 + fromEnum Blink = 5 + fromEnum ReverseVideo = 7 + fromEnum Concealed = 8 + fromEnum (Foreground c) = 30 + fromEnum c + fromEnum (Background c) = 40 + fromEnum c + +highlight :: [Highlight] -> String -> String +highlight attrs s = highlightOn attrs ++ s ++ highlightOff + +highlightOn [] = highlightOn [Normal] +highlightOn attrs = "\ESC[" + ++ concat (intersperse ";" (map (show.fromEnum) attrs)) + ++"m" +highlightOff = "\ESC[0m" + + +-- An infinite supply of colours. +colourCycle :: [Colour] +colourCycle = cycle [Red,Blue,Magenta,Green,Cyan] + + +-- Scrolling +enableScrollRegion :: Int -> Int -> String +enableScrollRegion start end = "\ESC["++show start++';':show end++"r" + +scrollDown = "\ESCD" +scrollUp = "\ESCM" + +-- Line-wrapping mode +lineWrap True = "\ESC[7h" +lineWrap False = "\ESC[7l" + diff --git a/Language/Haskell/HsColour/Anchors.hs b/Language/Haskell/HsColour/Anchors.hs new file mode 100644 --- /dev/null +++ b/Language/Haskell/HsColour/Anchors.hs @@ -0,0 +1,130 @@ +module Language.Haskell.HsColour.Anchors + ( insertAnchors + ) where + +import Language.Haskell.HsColour.Classify +import List + +-- 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 Anchor = 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. +insertAnchors :: [(TokenType,String)] -> [Either Anchor (TokenType,String)] +insertAnchors = anchor emptyST + +-- looks at first token in the left-most position of each line +-- precondition: have just seen a newline token. +anchor st s = case identifier st s of + Nothing -> emit st s + Just v -> Left v: emit (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 +emit st (t@(Space,"\n"):stream) = Right t: anchor st stream +emit st (t:stream) = Right t: emit st stream +emit _ [] = [] + +-- 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. +identifier st t@((Varid,v):stream) = + case skip stream of + ((Varop,v):_) | not (v`inST`st) -> Just (fix v) + notVarop -- | typesig stream -> Nothing -- not a defn + | v `inST` st -> Nothing -- already defined + | otherwise -> Just v +identifier st t@((Layout,"("):stream) = + case stream of + ((Varop,v):(Layout,")"):_) + -- | typesig stream -> Nothing + | v `inST` st -> Nothing + | otherwise -> Just (fix v) + notVarop -> case skip (munchParens stream) of + ((Varop,v):_) | not (v`inST`st) -> Just (fix v) + _ -> Nothing +identifier st t@((Keyword,"foreign"):stream) = Nothing -- not yet implemented +identifier st t@((Keyword,"data"):stream) = getConid stream +identifier st t@((Keyword,"type"):stream) = getConid stream +identifier st t@((Keyword,"class"):stream) = getConid stream +identifier st t@((Comment,_):(Space,"\n"):stream) = identifier st stream +identifier st stream = Nothing + +-- Is this really a type signature? (no longer used) +typesig :: [(TokenType,String)] -> Bool +typesig ((Keyglyph,"::"):_) = True +typesig ((Varid,_):stream) = typesig stream +typesig ((Layout,"("):(Varop,_):(Layout,")"):stream) = typesig stream +typesig ((Layout,","):stream) = typesig stream +typesig ((Space,_):stream) = typesig stream +typesig ((Comment,_):stream) = typesig stream +typesig _ = False + +-- throw away everything from opening paren to matching close +munchParens = munch (0::Int) -- already seen open paren + where munch 0 ((Layout,")"):rest) = rest + munch n ((Layout,")"):rest) = munch (n-1) rest + munch n ((Layout,"("):rest) = munch (n+1) rest + munch n (_:rest) = munch n rest + munch _ [] = [] -- source is ill-formed + +-- ensure anchor name is correct for a Varop +fix ('`':v) = init v +fix v = v + +-- look past whitespace and comments to next "real" token +skip ((Space,_):stream) = skip stream +skip ((Comment,_):stream) = skip stream +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) +getConid stream = + case skip stream of + ((Conid,c):rest) -> case context rest of + ((Keyglyph,"="):_) -> Just c + ((Keyglyph,"=>"):more) -> + case skip more of + ((Conid,c'):_) -> Just c' + v -> debug v ("Conid "++c++" =>") + v -> debug v ("Conid "++c++" no = or =>") + ((Layout,"("):rest) -> case context rest of + ((Keyglyph,"=>"):more) -> + case skip more of + ((Conid,c'):_) -> Just c' + v -> debug v ("(...) =>") + v -> debug v ("(...) no =>") + v -> debug v ("no Conid or (...)") + where debug (s:t) c = Nothing + -- debug (s:t) c = error ("HsColour: getConid failed: "++show s + -- ++"\n in the context of: "++c) + +-- jump past possible class context +context stream@((Keyglyph,"="):_) = stream +context stream@((Keyglyph,"=>"):_) = stream +context (_:stream) = context stream + +-- simple implementation of a string lookup table. +-- replace this with something more sophisticated if needed. +type ST = [String] + +emptyST :: ST +emptyST = [] + +insertST :: String -> ST -> ST +insertST k st = insert k st + +inST :: String -> ST -> Bool +inST k st = k `elem` st diff --git a/Language/Haskell/HsColour/CSS.hs b/Language/Haskell/HsColour/CSS.hs new file mode 100644 --- /dev/null +++ b/Language/Haskell/HsColour/CSS.hs @@ -0,0 +1,65 @@ +-- | Formats Haskell source code as HTML with CSS. +module Language.Haskell.HsColour.CSS (hscolour, hscolourFragment) where + +import Language.Haskell.HsColour.Anchors +import Language.Haskell.HsColour.Classify as Classify +import Language.Haskell.HsColour.HTML (renderAnchors, renderComment, escape) + +-- | Formats Haskell source code as a complete HTML document with CSS. +hscolour :: Bool -- ^ Whether to include anchors + -> String -- ^ Haskell source code. + -> String -- ^ An HTML document containing the coloured + -- Haskell source code. +hscolour anchor = top'n'tail . hscolourFragment anchor + +-- | Formats Haskell source code as an HTML fragment with CSS. +-- No stylesheet link is included in the output. +hscolourFragment :: Bool -- ^ Whether to include anchors + -> String -- ^ Haskell source code. + -> String -- ^ An HTML fragment containing the coloured + -- Haskell source code. +hscolourFragment anchor = + pre . (if anchor + then concatMap (renderAnchors renderToken) . insertAnchors + else concatMap renderToken) . tokenise + +top'n'tail :: String -> String +top'n'tail = (cssPrefix++) . (++cssSuffix) + +pre :: String -> String +pre = ("
"++) . (++"
") + +renderToken :: (TokenType,String) -> String +renderToken (Space,text) = text +renderToken (cls,text) = "" ++ + (if cls == Comment then renderComment text else escape text) ++ + "" + +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 Error = "sel" + +cssPrefix = unlines + ["" + ,"" + ,"" + ,"" + ,"Haskell Code by HsColour" + ,"" + ,"" + ,"" + ] + +cssSuffix = unlines + ["" + ,"" + ] diff --git a/Language/Haskell/HsColour/Classify.hs b/Language/Haskell/HsColour/Classify.hs new file mode 100644 --- /dev/null +++ b/Language/Haskell/HsColour/Classify.hs @@ -0,0 +1,99 @@ +module Language.Haskell.HsColour.Classify + ( TokenType(..) + , tokenise + ) where + +import Char +import List + +-- Lex Haskell source code into an annotated token stream, without +-- discarding any characters or layout. +tokenise :: String -> [(TokenType,String)] +tokenise = map (\s-> (classify s,s)) . glue . chunk + +-- Basic Haskell lexing, except we keep whitespace. +chunk :: String -> [String] +chunk [] = [] +chunk ('\r':s) = chunk s -- get rid of DOS newline stuff +chunk ('\n':s) = "\n": chunk s +chunk (c:s) | isLinearSpace c + = (c:ss): chunk rest where (ss,rest) = span isLinearSpace s +chunk ('{':'-':s) = let (com,s') = nestcomment 0 s + in ('{':'-':com) : chunk s' +chunk s = case Prelude.lex s of + [] -> [head s]: chunk (tail s) -- e.g. inside comment + ((tok@('-':'-':_),rest):_) + | all (=='-') tok -> (tok++com): chunk s' + where (com,s') = eolcomment rest + ((tok,rest):_) -> tok: chunk rest + +isLinearSpace c = c `elem` " \t" -- " \t\xa0" + +-- Glue sequences of tokens into more useful blobs +--glue (q:".":n:rest) | Char.isUpper (head q) -- qualified names +-- = glue ((q++"."++n): rest) +glue ("`":rest) = -- `varid` -> varop + case glue rest of + (qn:"`":rest) -> ("`"++qn++"`"): glue rest + _ -> ("`": rest) +glue (s:ss) | all (=='-') s && length s >=2 -- eol comment + = (s++concat c): glue rest + where (c,rest) = break ('\n'`elem`) ss +--glue ("{":"-":ss) = ("{-"++c): glue rest -- nested comment +-- where (c,rest) = nestcomment 0 ss +glue (s:ss) = s: glue ss +glue [] = [] + +-- Deal with comments. +nestcomment :: Int -> String -> (String,String) +nestcomment n ('{':'-':ss) | n>=0 = (("{-"++cs),rm) + where (cs,rm) = nestcomment (n+1) ss +nestcomment n ('-':'}':ss) | n>0 = (("-}"++cs),rm) + where (cs,rm) = nestcomment (n-1) ss +nestcomment n ('-':'}':ss) | n==0 = ("-}",ss) +nestcomment n (s:ss) | n>=0 = ((s:cs),rm) + where (cs,rm) = nestcomment n ss +nestcomment n [] = ([],[]) + +eolcomment :: String -> (String,String) +eolcomment s@('\n':_) = ([], s) +eolcomment (c:s) = (c:cs, s') where (cs,s') = eolcomment s +eolcomment [] = ([],[]) + +-- Classify tokens +data TokenType = + Space | Keyword | Keyglyph | Layout | Comment | Conid | Varid | + Conop | Varop | String | Char | Number | Error + deriving (Eq,Show) + +classify :: String -> TokenType +classify s@(h:_) + | 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 + | isLower h = Varid + | h `elem` symbols = Varop + | h==':' = Conop + | h=='`' = Varop + | h=='"' = String + | h=='\'' = Char + | isDigit h = Number + | otherwise = Error + +-- Haskell keywords +keywords = + ["case","class","data","default","deriving","do","else" + ,"if","import","in","infix","infixl","infixr","instance","let","module" + ,"newtype","of","then","type","where","_","foreign","ccall","as"] +keyglyphs = + ["..","::","=","\\","|","<-","->","@","~","=>","[","]"] +layoutchars = + map (:[]) ";{}()," +symbols = + "!#$%&*+./<=>?@\\^|-~" diff --git a/Language/Haskell/HsColour/ColourHighlight.hs b/Language/Haskell/HsColour/ColourHighlight.hs new file mode 100644 --- /dev/null +++ b/Language/Haskell/HsColour/ColourHighlight.hs @@ -0,0 +1,20 @@ +module Language.Haskell.HsColour.ColourHighlight + ( Colour(..) + , Highlight(..) + ) where + +data Colour = Black | Red | Green | Yellow | Blue | Magenta | Cyan | White + deriving (Eq,Show,Read,Enum) + +data Highlight = + Normal + | Bold + | Dim + | Underscore + | Blink + | ReverseVideo + | Concealed + | Foreground Colour + | Background Colour + deriving (Eq,Show,Read) + diff --git a/Language/Haskell/HsColour/Colourise.hs b/Language/Haskell/HsColour/Colourise.hs new file mode 100644 --- /dev/null +++ b/Language/Haskell/HsColour/Colourise.hs @@ -0,0 +1,64 @@ +module Language.Haskell.HsColour.Colourise + ( module Language.Haskell.HsColour.ColourHighlight + , ColourPrefs(..) + , readColourPrefs + , colourise + ) where + +import Language.Haskell.HsColour.ColourHighlight +import Language.Haskell.HsColour.Classify (TokenType(..)) + +import System (getEnv) +import Char +import List + +-- | Colour preferences. +data ColourPrefs = ColourPrefs + { keyword, keyglyph, layout, comment + , conid, varid, conop, varop + , string, char, number + , selection, variantselection :: [Highlight] + } deriving (Eq,Show,Read) + +defaultColourPrefs = ColourPrefs + { keyword = [Foreground Green,Underscore] + , keyglyph = [Foreground Red] + , layout = [Foreground Cyan] + , comment = [Foreground Blue] + , conid = [Normal] + , varid = [Normal] + , conop = [Foreground Red,Bold] + , varop = [Foreground Cyan] + , string = [Foreground Magenta] + , char = [Foreground Magenta] + , number = [Foreground Magenta] + , selection = [Bold, Foreground Magenta] + , variantselection = [Dim, Foreground Red, Underscore] + } + +readColourPrefs :: IO ColourPrefs +readColourPrefs = catch + (do val <- readFile ".hscolour" + return (read val)) + (\e-> catch + (do home <- getEnv "HOME" + val <- readFile (home++"/.hscolour") + return (read val)) + (\e-> return defaultColourPrefs)) + +-- Convert classification to colour highlights. +colourise :: ColourPrefs -> TokenType -> [Highlight] +colourise pref Space = [Normal] +colourise pref Comment = comment pref +colourise pref Keyword = keyword pref +colourise pref Keyglyph = keyglyph pref +colourise pref Layout = layout pref +colourise pref Conid = conid pref +colourise pref Varid = varid pref +colourise pref Conop = conop pref +colourise pref Varop = varop pref +colourise pref String = string pref +colourise pref Char = char pref +colourise pref Number = number pref +colourise pref Error = selection pref + diff --git a/Language/Haskell/HsColour/HTML.hs b/Language/Haskell/HsColour/HTML.hs new file mode 100644 --- /dev/null +++ b/Language/Haskell/HsColour/HTML.hs @@ -0,0 +1,68 @@ +-- | Formats Haskell source code using HTML with font tags. +module Language.Haskell.HsColour.HTML + (hscolour, + -- * Internals + renderAnchors, renderComment, escape) where + +import Language.Haskell.HsColour.Anchors +import Language.Haskell.HsColour.Classify as Classify +import Language.Haskell.HsColour.Colourise + +import Data.Char(isAlphaNum) + + +-- | Formats Haskell source code using HTML with font tags. +hscolour :: ColourPrefs -- ^ Colour preferences. + -> Bool -- ^ Whether to include anchors + -> String -- ^ Haskell source code. + -> String -- ^ Coloured Haskell source code. +hscolour pref anchor = + top'n'tail . (if anchor then concatMap (renderAnchors (renderToken pref)) + . insertAnchors + else concatMap (renderToken pref)) . tokenise + +top'n'tail :: String -> String +top'n'tail = ("
"++) . (++"
") + +renderToken :: ColourPrefs -> (TokenType,String) -> String +renderToken pref (t,s) = fontify (colourise pref t) + (if t == Comment then renderComment s else escape s) + +renderAnchors :: ((TokenType,String)->String) + -> Either String (TokenType,String) -> String +renderAnchors _ (Left v) = "" +renderAnchors render (Right r) = render r + +-- if there are http://links/ in a comment, turn them into +-- hyperlinks +renderComment :: String -> String +renderComment xs@('h':'t':'t':'p':':':'/':'/':_) = + renderLink a ++ renderComment b + where + -- see http://www.gbiv.com/protocols/uri/rfc/rfc3986.html#characters + isUrlChar x = isAlphaNum x || x `elem` ":/?#[]@!$&'()*+,;=-._~%" + (a,b) = span isUrlChar xs + renderLink link = "" ++ escape link ++ "" + +renderComment (x:xs) = escape [x] ++ renderComment xs +renderComment [] = [] + +-- Html stuff +fontify [] s = s +fontify (h:hs) s = font h (fontify hs s) + +font Normal s = s +font Bold s = ""++s++"" +font Dim s = ""++s++"" +font Underscore s = ""++s++"" +font Blink s = ""++s++"" +font ReverseVideo s = s +font Concealed s = s +font (Foreground c) s = ""++s++"" +font (Background c) s = ""++s++"" + +escape ('<':cs) = "<"++escape cs +escape ('>':cs) = ">"++escape cs +escape ('&':cs) = "&"++escape cs +escape (c:cs) = c: escape cs +escape [] = [] diff --git a/Language/Haskell/HsColour/LaTeX.hs b/Language/Haskell/HsColour/LaTeX.hs new file mode 100644 --- /dev/null +++ b/Language/Haskell/HsColour/LaTeX.hs @@ -0,0 +1,111 @@ +-- | Formats Haskell source code using LaTeX macros. +module Language.Haskell.HsColour.LaTeX (hscolour, hscolourFragment) where + +import Language.Haskell.HsColour.Classify as Classify +import Language.Haskell.HsColour.Colourise + +-- | Formats Haskell source code as a complete LaTeX document. +hscolour :: ColourPrefs -- ^ Colour preferences. + -> String -- ^ Haskell source code. + -> String -- ^ An LaTeX document containing the coloured + -- Haskell source code. +hscolour pref = top'n'tail . hscolourFragment pref + +-- | Formats Haskell source code as an LaTeX fragment. +hscolourFragment :: ColourPrefs -- ^ Colour preferences. + -> String -- ^ Haskell source code. + -> String -- ^ An LaTeX fragment containing the coloured + -- Haskell source code. +hscolourFragment pref = concatMap (renderToken pref) . tokenise + +top'n'tail :: String -> String +top'n'tail = (latexPrefix++) . (++latexSuffix) + +-- | Wrap each lexeme in the appropriate LaTeX macro. +-- TODO: filter dangerous characters like "{}_$" +renderToken :: ColourPrefs -> (TokenType,String) -> String +renderToken pref (Space,text) = filterSpace text +renderToken pref (cls,text) = let + symb = case cls of + String -> "``" ++ (reverse . tail . reverse . tail $ text) ++ "''" + _ -> text + style = colourise pref cls + (pre, post) = unzip $ map latexHighlight style in + (concat pre) ++ filterSpecial symb ++ (concat post) + +-- | Filter white space characters. +filterSpace :: String + -> String +filterSpace ('\n':ss) = '\\':'\\':(filterSpace ss) +filterSpace (' ':ss) = "\\hsspace "++(filterSpace ss) +filterSpace ('\t':ss) = "\\hstab "++(filterSpace ss) +filterSpace (c:ss) = c:(filterSpace ss) +filterSpace [] = [] + +-- | Filters the characters "#$%&~_^\{}" which are special +-- in LaTeX. +filterSpecial :: String -- ^ The string to filter. + -> String -- ^ The LaTeX-safe string. +filterSpecial ('#':cs) = '\\':'#':(filterSpecial cs) +filterSpecial ('$':cs) = '\\':'$':(filterSpecial cs) +filterSpecial ('%':cs) = '\\':'%':(filterSpecial cs) +filterSpecial ('&':cs) = '\\':'&':(filterSpecial cs) +filterSpecial ('~':cs) = "\\tilde{ }"++(filterSpecial cs) +filterSpecial ('_':cs) = '\\':'_':(filterSpecial cs) +filterSpecial ('^':cs) = "\\hat{ }"++(filterSpecial cs) +filterSpecial ('\\':cs) = "$\\backslash$"++(filterSpecial cs) +filterSpecial ('{':cs) = '\\':'{':(filterSpecial cs) +filterSpecial ('}':cs) = '\\':'}':(filterSpecial cs) +filterSpecial ('|':cs) = "\\ensuremath{|}"++(filterSpecial cs) +filterSpecial ('<':'-':cs) = "\\ensuremath{\\leftarrow}"++(filterSpecial cs) +filterSpecial ('<':cs) = "\\ensuremath{\\langle}"++(filterSpecial cs) +filterSpecial ('-':'>':cs) = "\\ensuremath{\\rightarrow}"++(filterSpecial cs) +filterSpecial ('>':cs) = "\\ensuremath{\\rangle}"++(filterSpecial cs) +filterSpecial (c:cs) = c:(filterSpecial cs) +filterSpecial [] = [] + + +-- | Constructs the appropriate LaTeX macro for the given style. +latexHighlight :: Highlight -> (String, String) +latexHighlight Normal = ("{\\rm{}", "}") +latexHighlight Bold = ("{\\bf{}", "}") +latexHighlight Dim = ("", "") +latexHighlight Underscore = ("\\underline{", "}") +latexHighlight Blink = ("", "") +latexHighlight ReverseVideo = ("", "") +latexHighlight Concealed = ("\\conceal{", "}") +latexHighlight (Foreground c) = ("\\textcolor{"++ latexColour c ++"}{", "}") +latexHighlight (Background c) = ("\\colorbox{"++ latexColour c ++"}{", "}") + +-- | Translate a 'Colour' into a LaTeX colour name. +latexColour :: Colour -> String +latexColour Black = "black" +latexColour Red = "red" +latexColour Green = "green" +latexColour Yellow = "yellow" +latexColour Blue = "blue" +latexColour Magenta = "magenta" +latexColour Cyan = "cyan" +latexColour White = "white" + +-- | Generic LaTeX document preamble. +latexPrefix = 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]{}" + ,"\\begin{document}" + ,"\\noindent" + ] + +-- | Generic LaTeX document postamble. +latexSuffix = unlines + ["" + ,"\\end{document}" + ] diff --git a/Language/Haskell/HsColour/TTY.hs b/Language/Haskell/HsColour/TTY.hs new file mode 100644 --- /dev/null +++ b/Language/Haskell/HsColour/TTY.hs @@ -0,0 +1,15 @@ +-- | Highlights Haskell code with ANSI terminal codes. +module Language.Haskell.HsColour.TTY (hscolour) where + +import Language.Haskell.HsColour.ANSI as ANSI +import Language.Haskell.HsColour.Classify +import Language.Haskell.HsColour.Colourise + +-- | Highlights Haskell code with ANSI terminal codes. +hscolour :: ColourPrefs -- ^ Colour preferences. + -> String -- ^ Haskell source code. + -> String -- ^ Coloured Haskell source code. +hscolour pref = concatMap (renderToken pref) . tokenise + +renderToken :: ColourPrefs -> (TokenType,String) -> String +renderToken pref (t,s) = ANSI.highlight (colourise pref t) s diff --git a/Makefile b/Makefile new file mode 100644 --- /dev/null +++ b/Makefile @@ -0,0 +1,47 @@ +LIBRARY = hscolour +VERSION = 1.6 + +DIRS = Language/Haskell/HsColour + +SRCS = Language/Haskell/HsColour.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/LaTeX.hs \ + Language/Haskell/HsColour/TTY.hs + +AUX = README LICENCE* $(LIBRARY).cabal Setup.hs Makefile \ + HsColour.hs hscolour.css .hscolour \ + index.html docs/* + +#all: $(LIBRARY) +executable: $(SRCS) HsColour.hs + ghc --make HsColour + mv a.out $(LIBRARY) +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 HsColour -anchorHTML $$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) $@ diff --git a/README b/README new file mode 100644 --- /dev/null +++ b/README @@ -0,0 +1,55 @@ +HsColour: A Haskell source-code colouriser. +------------------------------------------- +Copyright: 2003-2006, Malcolm Wallace, University of York +Licence: GPL + +Building: + hmake HsColour +or + ghc --make HsColour + +Usage: + HsColour [ -tty | -html | -css | -anchorHTML | -anchorCSS ] [file.hs] + +The program can colourise a Haskell source file for either terminal +output (option -tty) or HTML output with font tags (option -html), or +HTML output with CSS (option -css). 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 +always written to standard output. + +HsColour can add named anchors (with -anchorHTML or -anchorCSS) 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. + +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 + , 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 + +For CSS output, it is sufficient to edit the hscolour.css file, also in +the distribution. + diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,4 @@ +#!/usr/bin/env runghc + +import Distribution.Simple +main = defaultMain diff --git a/docs/hscolour/Language-Haskell-HsColour-ANSI.html b/docs/hscolour/Language-Haskell-HsColour-ANSI.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language-Haskell-HsColour-ANSI.html @@ -0,0 +1,532 @@ + + +Language.Haskell.HsColour.ANSI
hscolourSource codeContentsIndex
Language.Haskell.HsColour.ANSI
Documentation
highlight :: [Highlight] -> String -> StringSource
cls :: StringSource
goto :: Int -> Int -> StringSource
data Highlight Source
Constructors
Normal
Bold
Dim
Underscore
Blink
ReverseVideo
Concealed
Foreground Colour
Background Colour
show/hide Instances
data Colour Source
Constructors
Black
Red
Green
Yellow
Blue
Magenta
Cyan
White
show/hide Instances
Enum Colour
Eq Colour
Read Colour
Show Colour
colourCycle :: [Colour]Source
enableScrollRegion :: Int -> Int -> StringSource
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-Anchors.html b/docs/hscolour/Language-Haskell-HsColour-Anchors.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language-Haskell-HsColour-Anchors.html @@ -0,0 +1,155 @@ + + +Language.Haskell.HsColour.Anchors
hscolourSource codeContentsIndex
Language.Haskell.HsColour.Anchors
Synopsis
insertAnchors :: [(TokenType, String)] -> [Either Anchor (TokenType, String)]
Documentation
insertAnchors :: [(TokenType, String)] -> [Either Anchor (TokenType, String)]Source
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. +
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-CSS.html b/docs/hscolour/Language-Haskell-HsColour-CSS.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language-Haskell-HsColour-CSS.html @@ -0,0 +1,240 @@ + + +Language.Haskell.HsColour.CSS
hscolourSource codeContentsIndex
Language.Haskell.HsColour.CSS
Description
Formats Haskell source code as HTML with CSS. +
Synopsis
hscolour :: Bool -> String -> String
hscolourFragment :: Bool -> String -> String
Documentation
hscolourSource
:: BoolWhether to include anchors +
-> StringHaskell source code. +
-> StringAn HTML document containing the coloured + Haskell source code. +
Formats Haskell source code as a complete HTML document with CSS. +
hscolourFragmentSource
:: BoolWhether to include anchors +
-> StringHaskell source code. +
-> StringAn HTML fragment containing the coloured + Haskell source code. +
Formats Haskell source code as an HTML fragment with CSS. + No stylesheet link is included in the output. +
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-Classify.html b/docs/hscolour/Language-Haskell-HsColour-Classify.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language-Haskell-HsColour-Classify.html @@ -0,0 +1,309 @@ + + +Language.Haskell.HsColour.Classify
hscolourSource codeContentsIndex
Language.Haskell.HsColour.Classify
Documentation
data TokenType Source
Constructors
Space
Keyword
Keyglyph
Layout
Comment
Conid
Varid
Conop
Varop
String
Char
Number
Error
show/hide Instances
tokenise :: String -> [(TokenType, String)]Source
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-ColourHighlight.html b/docs/hscolour/Language-Haskell-HsColour-ColourHighlight.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language-Haskell-HsColour-ColourHighlight.html @@ -0,0 +1,418 @@ + + +Language.Haskell.HsColour.ColourHighlight
hscolourSource codeContentsIndex
Language.Haskell.HsColour.ColourHighlight
Documentation
data Colour Source
Constructors
Black
Red
Green
Yellow
Blue
Magenta
Cyan
White
show/hide Instances
Enum Colour
Eq Colour
Read Colour
Show Colour
data Highlight Source
Constructors
Normal
Bold
Dim
Underscore
Blink
ReverseVideo
Concealed
Foreground Colour
Background Colour
show/hide Instances
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-Colourise.html b/docs/hscolour/Language-Haskell-HsColour-Colourise.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language-Haskell-HsColour-Colourise.html @@ -0,0 +1,400 @@ + + +Language.Haskell.HsColour.Colourise
hscolourSource codeContentsIndex
Language.Haskell.HsColour.Colourise
Synopsis
module Language.Haskell.HsColour.ColourHighlight
data ColourPrefs = ColourPrefs {
keyword, keyglyph, layout, comment, conid, varid, conop, varop, string, char, number, selection, variantselection :: [Highlight]
}
readColourPrefs :: IO ColourPrefs
colourise :: ColourPrefs -> TokenType -> [Highlight]
Documentation
module Language.Haskell.HsColour.ColourHighlight
data ColourPrefs Source
Colour preferences. +
Constructors
ColourPrefs
keyword, keyglyph, layout, comment, conid, varid, conop, varop, string, char, number, selection, variantselection :: [Highlight]
show/hide Instances
readColourPrefs :: IO ColourPrefsSource
colourise :: ColourPrefs -> TokenType -> [Highlight]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 new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language-Haskell-HsColour-HTML.html @@ -0,0 +1,284 @@ + + +Language.Haskell.HsColour.HTML
hscolourSource codeContentsIndex
Language.Haskell.HsColour.HTML
Contents
Internals +
Description
Formats Haskell source code using HTML with font tags. +
Synopsis
hscolour :: ColourPrefs -> Bool -> String -> String
renderAnchors :: ((TokenType, String) -> String) -> Either String (TokenType, String) -> String
renderComment :: String -> String
Documentation
hscolourSource
:: ColourPrefsColour preferences. +
-> BoolWhether to include anchors +
-> StringHaskell source code. +
-> StringColoured Haskell source code. +
Formats Haskell source code using HTML with font tags. +
Internals +
renderAnchors :: ((TokenType, String) -> String) -> Either String (TokenType, String) -> StringSource
renderComment :: String -> StringSource
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language-Haskell-HsColour-TTY.html b/docs/hscolour/Language-Haskell-HsColour-TTY.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language-Haskell-HsColour-TTY.html @@ -0,0 +1,177 @@ + + +Language.Haskell.HsColour.TTY
hscolourSource codeContentsIndex
Language.Haskell.HsColour.TTY
Description
Highlights Haskell code with ANSI terminal codes. +
Synopsis
hscolour :: ColourPrefs -> String -> String
Documentation
hscolourSource
:: ColourPrefsColour preferences. +
-> StringHaskell source code. +
-> StringColoured 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 new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language-Haskell-HsColour.html @@ -0,0 +1,549 @@ + + +Language.Haskell.HsColour
hscolourSource codeContentsIndex
Language.Haskell.HsColour
Description

This is a library with colourises Haskell code. + It currently has three output formats: +

  • ANSI terminal codes +
  • LaTeX macros +
  • HTML with font tags +
  • HTML with CSS. +
Synopsis
data Output
= TTY
| LaTeX
| HTML
| CSS
data ColourPrefs = ColourPrefs {
keyword, keyglyph, layout, comment, conid, varid, conop, varop, string, char, number, selection, variantselection :: [Highlight]
}
hscolour :: Output -> ColourPrefs -> Bool -> String -> String
Documentation
data Output Source
The supported output formats. +
Constructors
TTYANSI terminal codes +
LaTeXTeX macros +
HTMLHTML with font tags +
CSSHTML with CSS. +
data ColourPrefs Source
Colour preferences. +
Constructors
ColourPrefs
keyword, keyglyph, layout, comment, conid, varid, conop, varop, string, char, number, selection, variantselection :: [Highlight]
show/hide Instances
hscolourSource
:: OutputOutput format. +
-> ColourPrefsColour preferences for formats that support it. +
-> BoolWhether to include anchors. +
-> StringHaskell source code. +
-> StringColoured Haskell source code. +
Colourise Haskell source code with the give output format. +
Produced by Haddock version 0.8
diff --git a/docs/hscolour/Language/Haskell/HsColour.html b/docs/hscolour/Language/Haskell/HsColour.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language/Haskell/HsColour.html @@ -0,0 +1,37 @@ +
-- | This is a library with colourises Haskell code. 
+--   It currently has three output formats: 
+--
+-- * ANSI terminal codes
+--
+-- * LaTeX macros
+--
+-- * HTML with font tags
+--
+-- * HTML with CSS.
+--
+module Language.Haskell.HsColour (Output(..), ColourPrefs(..),
+                                  hscolour) where
+
+import Language.Haskell.HsColour.Colourise (ColourPrefs(..))
+import qualified Language.Haskell.HsColour.TTY  as TTY
+import qualified Language.Haskell.HsColour.HTML as HTML
+import qualified Language.Haskell.HsColour.CSS  as CSS
+import qualified Language.Haskell.HsColour.LaTeX  as LaTeX
+
+-- | The supported output formats.
+data Output = TTY   -- ^ ANSI terminal codes
+            | LaTeX -- ^ TeX macros
+            | HTML  -- ^ HTML with font tags
+            | CSS   -- ^ HTML with CSS.
+
+-- | Colourise Haskell source code with the give output format.
+hscolour :: Output      -- ^ Output format.
+         -> ColourPrefs -- ^ Colour preferences for formats that support it.
+         -> Bool        -- ^ Whether to include anchors.
+         -> String      -- ^ Haskell source code.
+         -> String      -- ^ Coloured Haskell source code.
+hscolour TTY   pref _      = TTY.hscolour pref
+hscolour LaTeX pref _      = LaTeX.hscolour pref
+hscolour HTML  pref anchor = HTML.hscolour pref anchor
+hscolour CSS   _    anchor = CSS.hscolour anchor
+
diff --git a/docs/hscolour/Language/Haskell/HsColour/ANSI.html b/docs/hscolour/Language/Haskell/HsColour/ANSI.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language/Haskell/HsColour/ANSI.html @@ -0,0 +1,94 @@ +
-- Partially taken from Hugs AnsiScreen.hs library:
+module Language.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 Language.Haskell.HsColour.ColourHighlight
+
+import List (intersperse,isPrefixOf)
+import Char (isDigit)
+
+
+-- Basic screen control codes:
+
+type Pos           = (Int,Int)
+
+at        :: Pos -> String -> String
+goto      :: Int -> Int -> String
+home      :: String
+cls       :: String
+
+at (x,y) s  = goto x y ++ s
+goto x y    = '\ESC':'[':(show y ++(';':show x ++ "H"))
+home        = goto 1 1
+
+cursorUp    = "\ESC[A"
+cursorDown  = "\ESC[B"
+cursorRight = "\ESC[C"
+cursorLeft  = "\ESC[D"
+
+cleareol    = "\ESC[K"
+clearbol    = "\ESC[1K"
+clearline   = "\ESC[2K"
+clearDown   = "\ESC[J"
+clearUp     = "\ESC[1J"
+-- Choose whichever of the following lines is suitable for your system:
+cls         = "\ESC[2J"     -- for PC with ANSI.SYS
+--cls         = "\^L"         -- for Sun window
+
+savePosition    = "\ESC7"
+restorePosition = "\ESC8"
+
+
+-- data Colour    -- imported from ColourHighlight
+-- data Highlight -- imported from ColourHighlight
+
+instance Enum Highlight where
+  fromEnum Normal       = 0
+  fromEnum Bold         = 1
+  fromEnum Dim          = 2
+  fromEnum Underscore   = 4
+  fromEnum Blink        = 5
+  fromEnum ReverseVideo = 7
+  fromEnum Concealed    = 8
+  fromEnum (Foreground c) = 30 + fromEnum c
+  fromEnum (Background c) = 40 + fromEnum c
+
+highlight :: [Highlight] -> String -> String
+highlight attrs s = highlightOn attrs ++ s ++ highlightOff
+
+highlightOn []     = highlightOn [Normal]
+highlightOn attrs  = "\ESC["
+                     ++ concat (intersperse ";" (map (show.fromEnum) attrs))
+                     ++"m"
+highlightOff = "\ESC[0m"
+
+
+-- An infinite supply of colours.
+colourCycle :: [Colour]
+colourCycle = cycle [Red,Blue,Magenta,Green,Cyan]
+
+
+-- Scrolling
+enableScrollRegion :: Int -> Int -> String
+enableScrollRegion start end = "\ESC["++show start++';':show end++"r"
+
+scrollDown  = "\ESCD"
+scrollUp    = "\ESCM"
+
+-- Line-wrapping mode
+lineWrap True  = "\ESC[7h"
+lineWrap False = "\ESC[7l"
+
+
diff --git a/docs/hscolour/Language/Haskell/HsColour/Anchors.html b/docs/hscolour/Language/Haskell/HsColour/Anchors.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language/Haskell/HsColour/Anchors.html @@ -0,0 +1,131 @@ +
module Language.Haskell.HsColour.Anchors
+  ( insertAnchors
+  ) where
+
+import Language.Haskell.HsColour.Classify
+import List
+
+-- 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 Anchor = 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.
+insertAnchors :: [(TokenType,String)] -> [Either Anchor (TokenType,String)]
+insertAnchors = anchor emptyST
+
+-- looks at first token in the left-most position of each line
+-- precondition: have just seen a newline token.
+anchor st s = case identifier st s of
+                Nothing -> emit st s
+                Just v  -> Left v: emit (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
+emit st (t@(Space,"\n"):stream) = Right t: anchor st stream
+emit st (t:stream)              = Right t: emit st stream
+emit _  []                      = []
+
+-- 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.
+identifier st t@((Varid,v):stream) =
+    case skip stream of
+        ((Varop,v):_) | not (v`inST`st) -> Just (fix v)
+        notVarop  --  | typesig stream  -> Nothing    -- not a defn
+                      | v `inST` st     -> Nothing    -- already defined
+                      | otherwise       -> Just v
+identifier st t@((Layout,"("):stream) =
+    case stream of
+      ((Varop,v):(Layout,")"):_)
+                  --  | typesig stream  -> Nothing
+	              | v `inST` st     -> Nothing
+	              | otherwise	-> Just (fix v)
+      notVarop -> case skip (munchParens stream) of
+          ((Varop,v):_) | not (v`inST`st) -> Just (fix v)
+          _             -> Nothing
+identifier st t@((Keyword,"foreign"):stream) = Nothing -- not yet implemented
+identifier st t@((Keyword,"data"):stream)    = getConid stream
+identifier st t@((Keyword,"type"):stream)    = getConid stream
+identifier st t@((Keyword,"class"):stream)   = getConid stream
+identifier st t@((Comment,_):(Space,"\n"):stream) = identifier st stream
+identifier st stream = Nothing
+
+-- Is this really a type signature?  (no longer used)
+typesig :: [(TokenType,String)] -> Bool
+typesig ((Keyglyph,"::"):_)   = True
+typesig ((Varid,_):stream)    = typesig stream
+typesig ((Layout,"("):(Varop,_):(Layout,")"):stream)    = typesig stream
+typesig ((Layout,","):stream) = typesig stream
+typesig ((Space,_):stream)    = typesig stream
+typesig ((Comment,_):stream)  = typesig stream
+typesig _                     = False
+
+-- throw away everything from opening paren to matching close
+munchParens =  munch (0::Int)	-- already seen open paren
+  where munch 0 ((Layout,")"):rest) = rest
+        munch n ((Layout,")"):rest) = munch (n-1) rest
+        munch n ((Layout,"("):rest) = munch (n+1) rest
+        munch n (_:rest)            = munch n rest
+        munch _ []                  = []	-- source is ill-formed
+
+-- ensure anchor name is correct for a Varop
+fix ('`':v) = init v
+fix v       = v
+
+-- look past whitespace and comments to next "real" token
+skip ((Space,_):stream)   = skip stream
+skip ((Comment,_):stream) = skip stream
+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)
+getConid stream =
+    case skip stream of
+        ((Conid,c):rest) -> case context rest of
+                              ((Keyglyph,"="):_)     -> Just c
+                              ((Keyglyph,"=>"):more) ->
+                                  case skip more of
+                                      ((Conid,c'):_) -> Just c'
+                                      v -> debug v ("Conid "++c++" =>")
+                              v -> debug v ("Conid "++c++" no = or =>")
+        ((Layout,"("):rest) -> case context rest of
+                                   ((Keyglyph,"=>"):more) ->
+                                       case skip more of
+                                           ((Conid,c'):_) -> Just c'
+                                           v -> debug v ("(...) =>")
+                                   v -> debug v ("(...) no =>")
+        v -> debug v ("no Conid or (...)")
+    where debug (s:t) c = Nothing
+       -- debug (s:t) c = error ("HsColour: getConid failed: "++show s
+       --                       ++"\n  in the context of: "++c)
+
+-- jump past possible class context
+context stream@((Keyglyph,"="):_) = stream
+context stream@((Keyglyph,"=>"):_) = stream
+context (_:stream) = context stream
+
+-- simple implementation of a string lookup table.
+-- replace this with something more sophisticated if needed.
+type ST = [String]
+
+emptyST :: ST
+emptyST = []
+
+insertST :: String -> ST -> ST
+insertST k st = insert k st
+
+inST :: String -> ST -> Bool
+inST k st = k `elem` st
+
diff --git a/docs/hscolour/Language/Haskell/HsColour/CSS.html b/docs/hscolour/Language/Haskell/HsColour/CSS.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language/Haskell/HsColour/CSS.html @@ -0,0 +1,66 @@ +
-- | Formats Haskell source code as HTML with CSS.
+module Language.Haskell.HsColour.CSS (hscolour, hscolourFragment) where
+
+import Language.Haskell.HsColour.Anchors
+import Language.Haskell.HsColour.Classify as Classify
+import Language.Haskell.HsColour.HTML (renderAnchors, renderComment, escape)
+
+-- | Formats Haskell source code as a complete HTML document with CSS.
+hscolour :: Bool   -- ^ Whether to include anchors
+         -> String -- ^ Haskell source code.
+         -> String -- ^ An HTML document containing the coloured 
+                   --   Haskell source code.
+hscolour anchor = top'n'tail . hscolourFragment anchor
+
+-- | Formats Haskell source code as an HTML fragment with CSS.
+--   No stylesheet link is included in the output.
+hscolourFragment :: Bool   -- ^ Whether to include anchors
+                 -> String -- ^ Haskell source code.
+                 -> String -- ^ An HTML fragment containing the coloured 
+                           --   Haskell source code.
+hscolourFragment anchor = 
+    pre . (if anchor 
+           then concatMap (renderAnchors renderToken) . insertAnchors
+           else concatMap renderToken) . tokenise
+
+top'n'tail :: String -> String
+top'n'tail  = (cssPrefix++) . (++cssSuffix)
+
+pre :: String -> String
+pre = ("<pre>"++) . (++"</pre>")
+
+renderToken :: (TokenType,String) -> String
+renderToken (Space,text) = text
+renderToken (cls,text)   = "<span class='" ++ cssClass cls ++ "'>" ++
+                           (if cls == Comment then renderComment text else escape text) ++
+                           "</span>"
+
+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 Error    = "sel"
+
+cssPrefix = 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>Haskell Code by HsColour</title>"
+    ,"<link type='text/css' rel='stylesheet' href='hscolour.css' />"
+    ,"</head>"
+    ,"<body>"
+    ]
+    
+cssSuffix = unlines
+    ["</body>"
+    ,"</html>"
+    ]
+
diff --git a/docs/hscolour/Language/Haskell/HsColour/Classify.html b/docs/hscolour/Language/Haskell/HsColour/Classify.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language/Haskell/HsColour/Classify.html @@ -0,0 +1,100 @@ +
module Language.Haskell.HsColour.Classify
+  ( TokenType(..)
+  , tokenise
+  ) where
+
+import Char
+import List
+
+-- Lex Haskell source code into an annotated token stream, without
+-- discarding any characters or layout.
+tokenise :: String -> [(TokenType,String)]
+tokenise = map (\s-> (classify s,s)) . glue . chunk
+
+-- Basic Haskell lexing, except we keep whitespace.
+chunk :: String -> [String]
+chunk []    = []
+chunk ('\r':s) = chunk s -- get rid of DOS newline stuff
+chunk ('\n':s) = "\n": chunk s
+chunk (c:s) | isLinearSpace c
+            = (c:ss): chunk rest where (ss,rest) = span isLinearSpace s
+chunk ('{':'-':s) = let (com,s') = nestcomment 0 s
+                    in ('{':'-':com) : chunk s'
+chunk s = case Prelude.lex s of
+              []             -> [head s]: chunk (tail s) -- e.g. inside comment
+              ((tok@('-':'-':_),rest):_)
+                  | all (=='-') tok -> (tok++com): chunk s'
+                                       where (com,s') = eolcomment rest
+              ((tok,rest):_) -> tok: chunk rest
+
+isLinearSpace c = c `elem` " \t" -- " \t\xa0"
+
+-- Glue sequences of tokens into more useful blobs
+--glue (q:".":n:rest) | Char.isUpper (head q)	-- qualified names
+--                    = glue ((q++"."++n): rest)
+glue ("`":rest) =				-- `varid` -> varop
+  case glue rest of
+    (qn:"`":rest) -> ("`"++qn++"`"): glue rest
+    _             -> ("`": rest)
+glue (s:ss)       | all (=='-') s && length s >=2	-- eol comment
+                  = (s++concat c): glue rest
+                  where (c,rest) = break ('\n'`elem`) ss
+--glue ("{":"-":ss)  = ("{-"++c): glue rest	-- nested comment
+--                  where (c,rest) = nestcomment 0 ss
+glue (s:ss)       = s: glue ss
+glue []           = []
+
+-- Deal with comments.
+nestcomment :: Int -> String -> (String,String)
+nestcomment n ('{':'-':ss) | n>=0 = (("{-"++cs),rm)
+                                  where (cs,rm) = nestcomment (n+1) ss
+nestcomment n ('-':'}':ss) | n>0  = (("-}"++cs),rm)
+                                  where (cs,rm) = nestcomment (n-1) ss
+nestcomment n ('-':'}':ss) | n==0 = ("-}",ss)
+nestcomment n (s:ss)       | n>=0 = ((s:cs),rm)
+                                  where (cs,rm) = nestcomment n ss
+nestcomment n [] = ([],[])
+
+eolcomment :: String -> (String,String)
+eolcomment s@('\n':_) = ([], s)
+eolcomment (c:s)      = (c:cs, s') where (cs,s') = eolcomment s
+eolcomment []         = ([],[])
+
+-- Classify tokens
+data TokenType =
+  Space | Keyword | Keyglyph | Layout | Comment | Conid | Varid |
+  Conop | Varop   | String   | Char   | Number  | Error
+  deriving (Eq,Show)
+
+classify :: String -> TokenType
+classify s@(h:_)
+    | 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
+    | isLower h              = Varid
+    | h `elem` symbols       = Varop
+    | h==':'                 = Conop
+    | h=='`'                 = Varop
+    | h=='"'                 = String
+    | h=='\''                = Char
+    | isDigit h              = Number
+    | otherwise              = Error
+
+-- Haskell keywords
+keywords =
+  ["case","class","data","default","deriving","do","else"
+  ,"if","import","in","infix","infixl","infixr","instance","let","module"
+  ,"newtype","of","then","type","where","_","foreign","ccall","as"]
+keyglyphs =
+  ["..","::","=","\\","|","<-","->","@","~","=>","[","]"]
+layoutchars =
+  map (:[]) ";{}(),"
+symbols =
+  "!#$%&*+./<=>?@\\^|-~"
+
diff --git a/docs/hscolour/Language/Haskell/HsColour/ColourHighlight.html b/docs/hscolour/Language/Haskell/HsColour/ColourHighlight.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language/Haskell/HsColour/ColourHighlight.html @@ -0,0 +1,21 @@ +
module Language.Haskell.HsColour.ColourHighlight
+  ( Colour(..)
+  , Highlight(..)
+  ) where
+
+data Colour = Black | Red | Green | Yellow | Blue | Magenta | Cyan | White
+  deriving (Eq,Show,Read,Enum)
+
+data Highlight =
+    Normal
+  | Bold
+  | Dim
+  | Underscore
+  | Blink
+  | ReverseVideo
+  | Concealed
+  | Foreground Colour
+  | Background Colour
+  deriving (Eq,Show,Read)
+
+
diff --git a/docs/hscolour/Language/Haskell/HsColour/Colourise.html b/docs/hscolour/Language/Haskell/HsColour/Colourise.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language/Haskell/HsColour/Colourise.html @@ -0,0 +1,65 @@ +
module Language.Haskell.HsColour.Colourise
+  ( module Language.Haskell.HsColour.ColourHighlight
+  , ColourPrefs(..)
+  , readColourPrefs
+  , colourise
+  ) where
+
+import Language.Haskell.HsColour.ColourHighlight
+import Language.Haskell.HsColour.Classify (TokenType(..))
+
+import System (getEnv)
+import Char
+import List
+
+-- | Colour preferences.
+data ColourPrefs = ColourPrefs
+  { keyword, keyglyph, layout, comment
+  , conid, varid, conop, varop
+  , string, char, number
+  , selection, variantselection :: [Highlight]
+  } deriving (Eq,Show,Read)
+
+defaultColourPrefs = ColourPrefs
+  { keyword  = [Foreground Green,Underscore]
+  , keyglyph = [Foreground Red]
+  , layout   = [Foreground Cyan]
+  , comment  = [Foreground Blue]
+  , conid    = [Normal]
+  , varid    = [Normal]
+  , conop    = [Foreground Red,Bold]
+  , varop    = [Foreground Cyan]
+  , string   = [Foreground Magenta]
+  , char     = [Foreground Magenta]
+  , number   = [Foreground Magenta]
+  , selection = [Bold, Foreground Magenta]
+  , variantselection = [Dim, Foreground Red, Underscore]
+  }
+
+readColourPrefs :: IO ColourPrefs
+readColourPrefs = catch
+  (do val <- readFile ".hscolour"
+      return (read val))
+  (\e-> catch
+    (do home <- getEnv "HOME"
+        val <- readFile (home++"/.hscolour")
+        return (read val))
+    (\e-> return defaultColourPrefs))
+
+-- Convert classification to colour highlights.
+colourise :: ColourPrefs -> TokenType -> [Highlight]
+colourise pref Space    = [Normal]
+colourise pref Comment  = comment pref
+colourise pref Keyword  = keyword pref
+colourise pref Keyglyph = keyglyph pref
+colourise pref Layout   = layout pref
+colourise pref Conid    = conid pref
+colourise pref Varid    = varid pref
+colourise pref Conop    = conop pref
+colourise pref Varop    = varop pref
+colourise pref String   = string pref
+colourise pref Char     = char pref
+colourise pref Number   = number pref
+colourise pref Error    = selection pref
+
+
diff --git a/docs/hscolour/Language/Haskell/HsColour/HTML.html b/docs/hscolour/Language/Haskell/HsColour/HTML.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language/Haskell/HsColour/HTML.html @@ -0,0 +1,69 @@ +
-- | Formats Haskell source code using HTML with font tags.
+module Language.Haskell.HsColour.HTML 
+    (hscolour, 
+     -- * Internals
+     renderAnchors, renderComment, escape) where
+
+import Language.Haskell.HsColour.Anchors
+import Language.Haskell.HsColour.Classify as Classify
+import Language.Haskell.HsColour.Colourise
+
+import Data.Char(isAlphaNum)
+
+
+-- | Formats Haskell source code using HTML with font tags.
+hscolour :: ColourPrefs -- ^ Colour preferences.
+         -> Bool        -- ^ Whether to include anchors
+         -> String      -- ^ Haskell source code.
+         -> String      -- ^ Coloured Haskell source code.
+hscolour pref anchor = 
+    top'n'tail . (if anchor then concatMap (renderAnchors (renderToken pref)) 
+                                   . insertAnchors
+                            else concatMap (renderToken pref)) . tokenise
+
+top'n'tail :: String -> String
+top'n'tail = ("<pre>"++) . (++"</pre>")
+
+renderToken :: ColourPrefs -> (TokenType,String) -> String
+renderToken pref (t,s) = fontify (colourise pref t)
+                         (if t == Comment then renderComment s else escape s)
+
+renderAnchors :: ((TokenType,String)->String)
+                 -> Either String (TokenType,String) -> String
+renderAnchors _      (Left v) = "<a name=\""++v++"\"></a>"
+renderAnchors render (Right r) = render r
+
+-- if there are http://links/ in a comment, turn them into
+-- hyperlinks
+renderComment :: String -> String
+renderComment xs@('h':'t':'t':'p':':':'/':'/':_) =
+        renderLink a ++ renderComment b
+    where
+        -- see http://www.gbiv.com/protocols/uri/rfc/rfc3986.html#characters
+        isUrlChar x = isAlphaNum x || x `elem` ":/?#[]@!$&'()*+,;=-._~%"
+        (a,b) = span isUrlChar xs
+        renderLink link = "<a href=\"" ++ link ++ "\">" ++ escape link ++ "</a>"
+        
+renderComment (x:xs) = escape [x] ++ renderComment xs
+renderComment [] = []
+
+-- Html stuff
+fontify [] s     = s
+fontify (h:hs) s = font h (fontify hs s)
+
+font Normal         s = s
+font Bold           s = "<b>"++s++"</b>"
+font Dim            s = "<em>"++s++"</em>"
+font Underscore     s = "<u>"++s++"</u>"
+font Blink          s = "<blink>"++s++"</blink>"
+font ReverseVideo   s = s
+font Concealed      s = s
+font (Foreground c) s = "<font color="++show c++">"++s++"</font>"
+font (Background c) s = "<font bgcolor="++show c++">"++s++"</font>"
+
+escape ('<':cs) = "&lt;"++escape cs
+escape ('>':cs) = "&gt;"++escape cs
+escape ('&':cs) = "&amp;"++escape cs
+escape (c:cs)   = c: escape cs
+escape []       = []
+
diff --git a/docs/hscolour/Language/Haskell/HsColour/TTY.html b/docs/hscolour/Language/Haskell/HsColour/TTY.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/Language/Haskell/HsColour/TTY.html @@ -0,0 +1,16 @@ +
-- | Highlights Haskell code with ANSI terminal codes.
+module Language.Haskell.HsColour.TTY (hscolour) where
+
+import Language.Haskell.HsColour.ANSI as ANSI
+import Language.Haskell.HsColour.Classify
+import Language.Haskell.HsColour.Colourise
+
+-- | Highlights Haskell code with ANSI terminal codes.
+hscolour :: ColourPrefs -- ^ Colour preferences.
+         -> String      -- ^ Haskell source code.
+         -> String      -- ^ Coloured Haskell source code.
+hscolour pref = concatMap (renderToken pref) . tokenise
+
+renderToken :: ColourPrefs -> (TokenType,String) -> String
+renderToken pref (t,s) = ANSI.highlight (colourise pref t) s
+
diff --git a/docs/hscolour/doc-index-B.html b/docs/hscolour/doc-index-B.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-B.html @@ -0,0 +1,184 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (B)
BackgroundLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
BlackLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
BlinkLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
BlueLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
BoldLanguage.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 new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-C.html @@ -0,0 +1,364 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (C)
CSSLanguage.Haskell.HsColour
CharLanguage.Haskell.HsColour.Classify
ColourLanguage.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
CommentLanguage.Haskell.HsColour.Classify
ConcealedLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
ConidLanguage.Haskell.HsColour.Classify
ConopLanguage.Haskell.HsColour.Classify
CyanLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
charLanguage.Haskell.HsColour.Colourise, Language.Haskell.HsColour
clearDownLanguage.Haskell.HsColour.ANSI
clearUpLanguage.Haskell.HsColour.ANSI
clearbolLanguage.Haskell.HsColour.ANSI
cleareolLanguage.Haskell.HsColour.ANSI
clearlineLanguage.Haskell.HsColour.ANSI
clsLanguage.Haskell.HsColour.ANSI
colourCycleLanguage.Haskell.HsColour.ANSI
colouriseLanguage.Haskell.HsColour.Colourise
commentLanguage.Haskell.HsColour.Colourise, Language.Haskell.HsColour
conidLanguage.Haskell.HsColour.Colourise, Language.Haskell.HsColour
conopLanguage.Haskell.HsColour.Colourise, Language.Haskell.HsColour
cursorDownLanguage.Haskell.HsColour.ANSI
cursorLeftLanguage.Haskell.HsColour.ANSI
cursorRightLanguage.Haskell.HsColour.ANSI
cursorUpLanguage.Haskell.HsColour.ANSI
diff --git a/docs/hscolour/doc-index-D.html b/docs/hscolour/doc-index-D.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-D.html @@ -0,0 +1,144 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (D)
DimLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
diff --git a/docs/hscolour/doc-index-E.html b/docs/hscolour/doc-index-E.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-E.html @@ -0,0 +1,158 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (E)
ErrorLanguage.Haskell.HsColour.Classify
enableScrollRegionLanguage.Haskell.HsColour.ANSI
escapeLanguage.Haskell.HsColour.HTML
diff --git a/docs/hscolour/doc-index-F.html b/docs/hscolour/doc-index-F.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-F.html @@ -0,0 +1,144 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (F)
ForegroundLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
diff --git a/docs/hscolour/doc-index-G.html b/docs/hscolour/doc-index-G.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-G.html @@ -0,0 +1,152 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (G)
GreenLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
gotoLanguage.Haskell.HsColour.ANSI
diff --git a/docs/hscolour/doc-index-H.html b/docs/hscolour/doc-index-H.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-H.html @@ -0,0 +1,220 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (H)
HTMLLanguage.Haskell.HsColour
HighlightLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
highlightLanguage.Haskell.HsColour.ANSI
highlightOffLanguage.Haskell.HsColour.ANSI
highlightOnLanguage.Haskell.HsColour.ANSI
hscolour
1 (Function)Language.Haskell.HsColour
2 (Function)Language.Haskell.HsColour.CSS
3 (Function)Language.Haskell.HsColour.HTML
4 (Function)Language.Haskell.HsColour.TTY
hscolourFragmentLanguage.Haskell.HsColour.CSS
diff --git a/docs/hscolour/doc-index-I.html b/docs/hscolour/doc-index-I.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-I.html @@ -0,0 +1,142 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (I)
insertAnchorsLanguage.Haskell.HsColour.Anchors
diff --git a/docs/hscolour/doc-index-K.html b/docs/hscolour/doc-index-K.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-K.html @@ -0,0 +1,170 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (K)
KeyglyphLanguage.Haskell.HsColour.Classify
KeywordLanguage.Haskell.HsColour.Classify
keyglyphLanguage.Haskell.HsColour.Colourise, Language.Haskell.HsColour
keywordLanguage.Haskell.HsColour.Colourise, Language.Haskell.HsColour
diff --git a/docs/hscolour/doc-index-L.html b/docs/hscolour/doc-index-L.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-L.html @@ -0,0 +1,168 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (L)
LaTeXLanguage.Haskell.HsColour
LayoutLanguage.Haskell.HsColour.Classify
layoutLanguage.Haskell.HsColour.Colourise, Language.Haskell.HsColour
lineWrapLanguage.Haskell.HsColour.ANSI
diff --git a/docs/hscolour/doc-index-M.html b/docs/hscolour/doc-index-M.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-M.html @@ -0,0 +1,144 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (M)
MagentaLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
diff --git a/docs/hscolour/doc-index-N.html b/docs/hscolour/doc-index-N.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-N.html @@ -0,0 +1,162 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (N)
NormalLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
NumberLanguage.Haskell.HsColour.Classify
numberLanguage.Haskell.HsColour.Colourise, Language.Haskell.HsColour
diff --git a/docs/hscolour/doc-index-O.html b/docs/hscolour/doc-index-O.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-O.html @@ -0,0 +1,142 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (O)
OutputLanguage.Haskell.HsColour
diff --git a/docs/hscolour/doc-index-R.html b/docs/hscolour/doc-index-R.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-R.html @@ -0,0 +1,186 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (R)
RedLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
ReverseVideoLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
readColourPrefsLanguage.Haskell.HsColour.Colourise
renderAnchorsLanguage.Haskell.HsColour.HTML
renderCommentLanguage.Haskell.HsColour.HTML
restorePositionLanguage.Haskell.HsColour.ANSI
diff --git a/docs/hscolour/doc-index-S.html b/docs/hscolour/doc-index-S.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-S.html @@ -0,0 +1,194 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (S)
SpaceLanguage.Haskell.HsColour.Classify
StringLanguage.Haskell.HsColour.Classify
savePositionLanguage.Haskell.HsColour.ANSI
scrollDownLanguage.Haskell.HsColour.ANSI
scrollUpLanguage.Haskell.HsColour.ANSI
selectionLanguage.Haskell.HsColour.Colourise, Language.Haskell.HsColour
stringLanguage.Haskell.HsColour.Colourise, Language.Haskell.HsColour
diff --git a/docs/hscolour/doc-index-T.html b/docs/hscolour/doc-index-T.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-T.html @@ -0,0 +1,158 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (T)
TTYLanguage.Haskell.HsColour
TokenTypeLanguage.Haskell.HsColour.Classify
tokeniseLanguage.Haskell.HsColour.Classify
diff --git a/docs/hscolour/doc-index-U.html b/docs/hscolour/doc-index-U.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-U.html @@ -0,0 +1,144 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (U)
UnderscoreLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
diff --git a/docs/hscolour/doc-index-V.html b/docs/hscolour/doc-index-V.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-V.html @@ -0,0 +1,180 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (V)
VaridLanguage.Haskell.HsColour.Classify
VaropLanguage.Haskell.HsColour.Classify
variantselectionLanguage.Haskell.HsColour.Colourise, Language.Haskell.HsColour
varidLanguage.Haskell.HsColour.Colourise, Language.Haskell.HsColour
varopLanguage.Haskell.HsColour.Colourise, Language.Haskell.HsColour
diff --git a/docs/hscolour/doc-index-W.html b/docs/hscolour/doc-index-W.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-W.html @@ -0,0 +1,144 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (W)
WhiteLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
diff --git a/docs/hscolour/doc-index-Y.html b/docs/hscolour/doc-index-Y.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index-Y.html @@ -0,0 +1,144 @@ + + +hscolour (Index)
hscolourContentsIndex
BCDEFGHIKLMNORSTUVWY
Index (Y)
YellowLanguage.Haskell.HsColour.ColourHighlight, Language.Haskell.HsColour.Colourise, Language.Haskell.HsColour.ANSI
diff --git a/docs/hscolour/doc-index.html b/docs/hscolour/doc-index.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/doc-index.html @@ -0,0 +1,128 @@ + + +hscolour (Index)
hscolourContentsIndex
Index
BCDEFGHIKLMNORSTUVWY
diff --git a/docs/hscolour/haddock.css b/docs/hscolour/haddock.css new file mode 100644 --- /dev/null +++ b/docs/hscolour/haddock.css @@ -0,0 +1,260 @@ +/* -------- Global things --------- */ + +BODY { + background-color: #ffffff; + color: #000000; + font-family: sans-serif; + } + +A:link { color: #0000e0; text-decoration: none } +A:visited { color: #0000a0; text-decoration: none } +A:hover { background-color: #e0e0ff; text-decoration: none } + +TABLE.vanilla { + width: 100%; + border-width: 0px; + /* I can't seem to specify cellspacing or cellpadding properly using CSS... */ +} + +TABLE.vanilla2 { + border-width: 0px; +} + +/* 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 new file mode 100644 --- /dev/null +++ b/docs/hscolour/haddock.js @@ -0,0 +1,15 @@ +// 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 new file mode 100644 Binary files /dev/null and b/docs/hscolour/haskell_icon.gif differ diff --git a/docs/hscolour/index.html b/docs/hscolour/index.html new file mode 100644 --- /dev/null +++ b/docs/hscolour/index.html @@ -0,0 +1,185 @@ + + +hscolour
hscolourContentsIndex
Modules
show/hideLanguage
show/hideHaskell
show/hideLanguage.Haskell.HsColour
Language.Haskell.HsColour.ANSI
Language.Haskell.HsColour.Anchors
Language.Haskell.HsColour.CSS
Language.Haskell.HsColour.Classify
Language.Haskell.HsColour.ColourHighlight
Language.Haskell.HsColour.Colourise
Language.Haskell.HsColour.HTML
Language.Haskell.HsColour.TTY
Produced by Haddock version 0.8
diff --git a/docs/hscolour/minus.gif b/docs/hscolour/minus.gif new file mode 100644 Binary files /dev/null and b/docs/hscolour/minus.gif differ diff --git a/docs/hscolour/plus.gif b/docs/hscolour/plus.gif new file mode 100644 Binary files /dev/null and b/docs/hscolour/plus.gif differ diff --git a/hscolour.cabal b/hscolour.cabal new file mode 100644 --- /dev/null +++ b/hscolour.cabal @@ -0,0 +1,30 @@ +Name: hscolour +Version: 1.6 +Copyright: Malcolm Wallace, University of York, 2003-2005, Bjorn Bringert 2006 +Maintainer: Malcolm Wallace +Author: Malcolm Wallace +Homepage: http://www.cs.york.ac.uk/fp/darcs/hscolour/ +License: GPL +License-file: LICENCE-GPL +Build-depends: haskell98, base +Extensions: +Synopsis: Colourise Haskell code. +Description: + hscolour is a small Haskell script to colourise Haskell code. It currently + has four output formats: + ANSI terminal codes, HTML with tags, HTML with CSS, and LaTeX. +Exposed-Modules: + Language.Haskell.HsColour, + Language.Haskell.HsColour.ANSI, + Language.Haskell.HsColour.Anchors, + Language.Haskell.HsColour.Classify, + Language.Haskell.HsColour.ColourHighlight, + Language.Haskell.HsColour.Colourise, + Language.Haskell.HsColour.TTY, + Language.Haskell.HsColour.HTML, + Language.Haskell.HsColour.LaTeX, + Language.Haskell.HsColour.CSS +ghc-options: -O2 -W + +Executable: HsColour +Main-is: HsColour.hs diff --git a/hscolour.css b/hscolour.css new file mode 100644 --- /dev/null +++ b/hscolour.css @@ -0,0 +1,5 @@ + +.keyglyph, .layout {color: red;} +.keyword {color: blue;} +.comment, .comment a {color: green;} +.str, .chr {color: teal;} diff --git a/index.html b/index.html new file mode 100644 --- /dev/null +++ b/index.html @@ -0,0 +1,184 @@ + +hscolour + +
+ +
+

hscolour

+
+
+ +

+hscolour is a small Haskell script to colourise Haskell code. +It currently has four output formats: ANSI terminal codes, HTML with +<font> tags, HTML with CSS, and LaTeX. + +

Example

+

+Here's a little example of the HTML output:
+

    module Main (main) where
+    import Prelude 
+    
+    -- The notorious nfib "benchmark", but using Doubles.
+    main = print (nfib 30)
+    
+    nfib :: Double -> Double
+    nfib n = if n <= 1
+             then 1
+             else nfib (n`subtract`1) + nfib (n`subtract`2) + 1
+
+ +

Download

+

+

+ +

Build

+

+Just use one of the standard ways of building a Haskell program: +

    +
  • hmake HsColour +
  • ghc --make HsColour +
  • runhugs HsColour +
+ +

Use

+

+

    +
  • HsColour [ -tty | -html | -css | -latex | -anchorHTML | -anchorCSS ] [file.hs] +
+

+You can colourise a Haskell source file for either ANSI terminal codes +(option -tty), or HTML with font tags (option -html), or HTML output +with CSS (option -css), or for LaTeX. The default is for terminal output. +

+If no file argument is given, it reads standard input. Output is +always written to standard output. +

+HsColour can add named anchors (options -anchorHTML or -anchorCSS) 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. + + +

Configuration of colours

+

+If you use either -html, -tty, or -latex, 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 CSS output, it is sufficient to edit the +hscolour.css file, also in +the distribution. + +

+The .hscolour file format is 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
+    , 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
+
+ +

+

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 (1.8 onwards, currently only available in darcs) 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 -anchorHTML $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-2006. 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.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: 21st December 2006
+Malcolm Wallace
+ +

+ +