X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=compiler%2Futils%2FOutputable.lhs;h=85b32e46c3bb0aa343a4f5b98989707e9c200f96;hp=cf99e12bcf1b8f95084038c8cece8645fee64e33;hb=1a7d1b77334529ca96ed4cbc03fcb5f55dc2de4a;hpb=0065d5ab628975892cea1ec7303f968c3338cbe1 diff --git a/compiler/utils/Outputable.lhs b/compiler/utils/Outputable.lhs index cf99e12..85b32e4 100644 --- a/compiler/utils/Outputable.lhs +++ b/compiler/utils/Outputable.lhs @@ -1,22 +1,22 @@ % +% (c) The University of Glasgow 2006 % (c) The GRASP Project, Glasgow University, 1992-1998 % -\section[Outputable]{Classes for pretty-printing} -Defines classes for pretty-printing and forcing, both forms of -``output.'' +Outputable: defines classes for pretty-printing and forcing, both +forms of ``output.'' \begin{code} - module Outputable ( Outputable(..), OutputableBndr(..), -- Class BindingSite(..), - PprStyle, CodeStyle(..), PrintUnqualified, alwaysQualify, - getPprStyle, withPprStyle, withPprStyleDoc, pprDeeper, pprSetDepth, + PprStyle, CodeStyle(..), PrintUnqualified, alwaysQualify, QualifyName(..), + getPprStyle, withPprStyle, withPprStyleDoc, + pprDeeper, pprDeeperList, pprSetDepth, codeStyle, userStyle, debugStyle, dumpStyle, asmStyle, - ifPprDebug, unqualStyle, + ifPprDebug, qualName, qualModule, mkErrStyle, defaultErrStyle, defaultDumpStyle, defaultUserStyle, SDoc, -- Abstract @@ -25,7 +25,7 @@ module Outputable ( empty, nest, text, char, ftext, ptext, int, integer, float, double, rational, - parens, brackets, braces, quotes, doubleQuotes, angleBrackets, + parens, cparen, brackets, braces, quotes, doubleQuotes, angleBrackets, semi, comma, colon, dcolon, space, equals, dot, arrow, lparen, rparen, lbrack, rbrack, lbrace, rbrace, underscore, (<>), (<+>), hcat, hsep, @@ -35,7 +35,7 @@ module Outputable ( hang, punctuate, speakNth, speakNTimes, speakN, speakNOf, plural, - printSDoc, printErrs, printDump, + printSDoc, printErrs, hPrintDump, printDump, printForC, printForAsm, printForUser, pprCode, mkCodeStyle, showSDoc, showSDocForUser, showSDocDebug, showSDocDump, @@ -51,20 +51,20 @@ module Outputable ( #include "HsVersions.h" -import {-# SOURCE #-} Module( Module ) +import {-# SOURCE #-} Module( Module, ModuleName, moduleName ) import {-# SOURCE #-} OccName( OccName ) import StaticFlags ( opt_PprStyle_Debug, opt_PprUserLength ) -import PackageConfig ( PackageId, packageIdString ) import FastString +import FastTypes +import GHC.Ptr import qualified Pretty import Pretty ( Doc, Mode(..) ) import Panic -import DATA_WORD ( Word32 ) - -import IO ( Handle, stderr, stdout, hFlush ) -import Char ( ord ) +import Data.Word ( Word32 ) +import System.IO ( Handle, stderr, stdout, hFlush ) +import Data.Char ( ord ) \end{code} @@ -75,6 +75,7 @@ import Char ( ord ) %************************************************************************ \begin{code} + data PprStyle = PprUser PrintUnqualified Depth -- Pretty-print in a way that will make sense to the @@ -99,33 +100,80 @@ data Depth = AllTheWay | PartWay Int -- 0 => stop -type PrintUnqualified = Module -> OccName -> Bool - -- This function tells when it's ok to print - -- a (Global) name unqualified +-- ----------------------------------------------------------------------------- +-- Printing original names + +-- When printing code that contains original names, we need to map the +-- original names back to something the user understands. This is the +-- purpose of the pair of functions that gets passed around +-- when rendering 'SDoc'. + +-- | given an /original/ name, this function tells you which module +-- name it should be qualified with when printing for the user, if +-- any. For example, given @Control.Exception.catch@, which is in scope +-- as @Exception.catch@, this fuction will return @Just "Exception"@. +-- Note that the return value is a ModuleName, not a Module, because +-- in source code, names are qualified by ModuleNames. +type QueryQualifyName = Module -> OccName -> QualifyName + +data QualifyName -- given P:M.T + = NameUnqual -- refer to it as "T" + | NameQual ModuleName -- refer to it as "X.T" for the supplied X + | NameNotInScope1 + -- it is not in scope at all, but M.T is not bound in the current + -- scope, so we can refer to it as "M.T" + | NameNotInScope2 + -- it is not in scope at all, and M.T is already bound in the + -- current scope, so we must refer to it as "P:M.T" + + +-- | For a given module, we need to know whether to print it with +-- a package name to disambiguate it. +type QueryQualifyModule = Module -> Bool + +type PrintUnqualified = (QueryQualifyName, QueryQualifyModule) + +alwaysQualifyNames :: QueryQualifyName +alwaysQualifyNames m _ = NameQual (moduleName m) + +neverQualifyNames :: QueryQualifyName +neverQualifyNames _ _ = NameUnqual + +alwaysQualifyModules :: QueryQualifyModule +alwaysQualifyModules _ = True + +neverQualifyModules :: QueryQualifyModule +neverQualifyModules _ = False -alwaysQualify,neverQualify :: PrintUnqualified -alwaysQualify m n = False -neverQualify m n = True +type QueryQualifies = (QueryQualifyName, QueryQualifyModule) + +alwaysQualify, neverQualify :: QueryQualifies +alwaysQualify = (alwaysQualifyNames, alwaysQualifyModules) +neverQualify = (neverQualifyNames, neverQualifyModules) + +defaultUserStyle, defaultDumpStyle :: PprStyle defaultUserStyle = mkUserStyle alwaysQualify AllTheWay defaultDumpStyle | opt_PprStyle_Debug = PprDebug | otherwise = PprDump +-- | Style for printing error messages mkErrStyle :: PrintUnqualified -> PprStyle --- Style for printing error messages -mkErrStyle print_unqual = mkUserStyle print_unqual (PartWay opt_PprUserLength) +mkErrStyle qual = mkUserStyle qual (PartWay opt_PprUserLength) defaultErrStyle :: PprStyle -- Default style for error messages -- It's a bit of a hack because it doesn't take into account what's in scope -- Only used for desugarer warnings, and typechecker errors in interface sigs defaultErrStyle - | opt_PprStyle_Debug = mkUserStyle alwaysQualify AllTheWay - | otherwise = mkUserStyle alwaysQualify (PartWay opt_PprUserLength) + | opt_PprStyle_Debug = mkUserStyle alwaysQualify AllTheWay + | otherwise = mkUserStyle alwaysQualify (PartWay opt_PprUserLength) -mkUserStyle unqual depth | opt_PprStyle_Debug = PprDebug - | otherwise = PprUser unqual depth +mkUserStyle :: QueryQualifies -> Depth -> PprStyle +mkUserStyle unqual depth + | opt_PprStyle_Debug = PprDebug + | otherwise = PprUser unqual depth \end{code} Orthogonal to the above printing styles are (possibly) some @@ -146,28 +194,45 @@ code (either C or assembly), or generating interface files. type SDoc = PprStyle -> Doc withPprStyle :: PprStyle -> SDoc -> SDoc -withPprStyle sty d sty' = d sty +withPprStyle sty d _sty' = d sty withPprStyleDoc :: PprStyle -> SDoc -> Doc withPprStyleDoc sty d = d sty pprDeeper :: SDoc -> SDoc -pprDeeper d (PprUser unqual (PartWay 0)) = Pretty.text "..." -pprDeeper d (PprUser unqual (PartWay n)) = d (PprUser unqual (PartWay (n-1))) -pprDeeper d other_sty = d other_sty +pprDeeper _ (PprUser _ (PartWay 0)) = Pretty.text "..." +pprDeeper d (PprUser q (PartWay n)) = d (PprUser q (PartWay (n-1))) +pprDeeper d other_sty = d other_sty + +pprDeeperList :: ([SDoc] -> SDoc) -> [SDoc] -> SDoc +-- Truncate a list that list that is longer than the current depth +pprDeeperList f ds (PprUser q (PartWay n)) + | n==0 = Pretty.text "..." + | otherwise = f (go 0 ds) (PprUser q (PartWay (n-1))) + where + go _ [] = [] + go i (d:ds) | i >= n = [text "...."] + | otherwise = d : go (i+1) ds + +pprDeeperList f ds other_sty + = f ds other_sty pprSetDepth :: Int -> SDoc -> SDoc -pprSetDepth n d (PprUser unqual _) = d (PprUser unqual (PartWay n)) -pprSetDepth n d other_sty = d other_sty +pprSetDepth n d (PprUser q _) = d (PprUser q (PartWay n)) +pprSetDepth _n d other_sty = d other_sty getPprStyle :: (PprStyle -> SDoc) -> SDoc getPprStyle df sty = df sty sty \end{code} \begin{code} -unqualStyle :: PprStyle -> PrintUnqualified -unqualStyle (PprUser unqual _) m n = unqual m n -unqualStyle other m n = False +qualName :: PprStyle -> QueryQualifyName +qualName (PprUser (qual_name,_) _) m n = qual_name m n +qualName _other m _n = NameQual (moduleName m) + +qualModule :: PprStyle -> QueryQualifyModule +qualModule (PprUser (_,qual_mod) _) m = qual_mod m +qualModule _other _m = True codeStyle :: PprStyle -> Bool codeStyle (PprCode _) = True @@ -175,23 +240,23 @@ codeStyle _ = False asmStyle :: PprStyle -> Bool asmStyle (PprCode AsmStyle) = True -asmStyle other = False +asmStyle _other = False dumpStyle :: PprStyle -> Bool dumpStyle PprDump = True -dumpStyle other = False +dumpStyle _other = False debugStyle :: PprStyle -> Bool debugStyle PprDebug = True -debugStyle other = False +debugStyle _other = False userStyle :: PprStyle -> Bool userStyle (PprUser _ _) = True -userStyle other = False +userStyle _other = False ifPprDebug :: SDoc -> SDoc -- Empty for non-debug style ifPprDebug d sty@PprDebug = d sty -ifPprDebug d sty = Pretty.empty +ifPprDebug _ _ = Pretty.empty \end{code} \begin{code} @@ -208,9 +273,12 @@ printErrs doc = do Pretty.printDoc PageMode stderr doc hFlush stderr printDump :: SDoc -> IO () -printDump doc = do - Pretty.printDoc PageMode stdout (better_doc defaultDumpStyle) - hFlush stdout +printDump doc = hPrintDump stdout doc + +hPrintDump :: Handle -> SDoc -> IO () +hPrintDump h doc = do + Pretty.printDoc PageMode h (better_doc defaultDumpStyle) + hFlush h where better_doc = doc $$ text "" @@ -258,16 +326,29 @@ showSDocDebug d = show (d PprDebug) docToSDoc :: Doc -> SDoc docToSDoc d = \_ -> d -empty sty = Pretty.empty -text s sty = Pretty.text s -char c sty = Pretty.char c -ftext s sty = Pretty.ftext s -ptext s sty = Pretty.ptext s -int n sty = Pretty.int n -integer n sty = Pretty.integer n -float n sty = Pretty.float n -double n sty = Pretty.double n -rational n sty = Pretty.rational n +empty :: SDoc +text :: String -> SDoc +char :: Char -> SDoc +ftext :: FastString -> SDoc +ptext :: Ptr t -> SDoc +int :: Int -> SDoc +integer :: Integer -> SDoc +float :: Float -> SDoc +double :: Double -> SDoc +rational :: Rational -> SDoc + +empty _sty = Pretty.empty +text s _sty = Pretty.text s +char c _sty = Pretty.char c +ftext s _sty = Pretty.ftext s +ptext s _sty = Pretty.ptext s +int n _sty = Pretty.int n +integer n _sty = Pretty.integer n +float n _sty = Pretty.float n +double n _sty = Pretty.double n +rational n _sty = Pretty.rational n + +parens, braces, brackets, quotes, doubleQuotes, angleBrackets :: SDoc -> SDoc parens d sty = Pretty.parens (d sty) braces d sty = Pretty.braces (d sty) @@ -275,30 +356,40 @@ brackets d sty = Pretty.brackets (d sty) doubleQuotes d sty = Pretty.doubleQuotes (d sty) angleBrackets d = char '<' <> d <> char '>' +cparen :: Bool -> SDoc -> SDoc + +cparen b d sty = Pretty.cparen b (d sty) + -- quotes encloses something in single quotes... -- but it omits them if the thing ends in a single quote -- so that we don't get `foo''. Instead we just have foo'. quotes d sty = case show pp_d of ('\'' : _) -> pp_d - other -> Pretty.quotes pp_d + _other -> Pretty.quotes pp_d where pp_d = d sty -semi sty = Pretty.semi -comma sty = Pretty.comma -colon sty = Pretty.colon -equals sty = Pretty.equals -space sty = Pretty.space -lparen sty = Pretty.lparen -rparen sty = Pretty.rparen -lbrack sty = Pretty.lbrack -rbrack sty = Pretty.rbrack -lbrace sty = Pretty.lbrace -rbrace sty = Pretty.rbrace -dcolon sty = Pretty.ptext SLIT("::") -arrow sty = Pretty.ptext SLIT("->") -underscore = char '_' -dot = char '.' +semi, comma, colon, equals, space, dcolon, arrow, underscore, dot :: SDoc +lparen, rparen, lbrack, rbrack, lbrace, rbrace :: SDoc + +semi _sty = Pretty.semi +comma _sty = Pretty.comma +colon _sty = Pretty.colon +equals _sty = Pretty.equals +space _sty = Pretty.space +dcolon _sty = Pretty.ptext SLIT("::") +arrow _sty = Pretty.ptext SLIT("->") +underscore = char '_' +dot = char '.' +lparen _sty = Pretty.lparen +rparen _sty = Pretty.rparen +lbrack _sty = Pretty.lbrack +rbrack _sty = Pretty.rbrack +lbrace _sty = Pretty.lbrace +rbrace _sty = Pretty.rbrace + +nest :: Int -> SDoc -> SDoc +(<>), (<+>), ($$), ($+$) :: SDoc -> SDoc -> SDoc nest n d sty = Pretty.nest n (d sty) (<>) d1 d2 sty = (Pretty.<>) (d1 sty) (d2 sty) @@ -306,6 +397,9 @@ nest n d sty = Pretty.nest n (d sty) ($$) d1 d2 sty = (Pretty.$$) (d1 sty) (d2 sty) ($+$) d1 d2 sty = (Pretty.$+$) (d1 sty) (d2 sty) +hcat, hsep, vcat, sep, cat, fsep, fcat :: [SDoc] -> SDoc + + hcat ds sty = Pretty.hcat [d sty | d <- ds] hsep ds sty = Pretty.hsep [d sty | d <- ds] vcat ds sty = Pretty.vcat [d sty | d <- ds] @@ -314,10 +408,12 @@ cat ds sty = Pretty.cat [d sty | d <- ds] fsep ds sty = Pretty.fsep [d sty | d <- ds] fcat ds sty = Pretty.fcat [d sty | d <- ds] +hang :: SDoc -> Int -> SDoc -> SDoc + hang d1 n d2 sty = Pretty.hang (d1 sty) n (d2 sty) punctuate :: SDoc -> [SDoc] -> [SDoc] -punctuate p [] = [] +punctuate _ [] = [] punctuate p (d:ds) = go d ds where go d [] = [d] @@ -357,6 +453,10 @@ instance Outputable a => Outputable (Maybe a) where ppr Nothing = ptext SLIT("Nothing") ppr (Just x) = ptext SLIT("Just") <+> ppr x +instance (Outputable a, Outputable b) => Outputable (Either a b) where + ppr (Left x) = ptext SLIT("Left") <+> ppr x + ppr (Right y) = ptext SLIT("Right") <+> ppr y + -- ToDo: may not be used instance (Outputable a, Outputable b, Outputable c) => Outputable (a, b, c) where ppr (x,y,z) = @@ -375,9 +475,6 @@ instance (Outputable a, Outputable b, Outputable c, Outputable d) => instance Outputable FastString where ppr fs = ftext fs -- Prints an unadorned string, -- no double quotes or anything - -instance Outputable PackageId where - ppr pid = text (packageIdString pid) \end{code} @@ -399,7 +496,7 @@ data BindingSite = LambdaBind | CaseBind | LetBind class Outputable a => OutputableBndr a where pprBndr :: BindingSite -> a -> SDoc - pprBndr b x = ppr x + pprBndr _b x = ppr x \end{code} @@ -492,8 +589,9 @@ speakNTimes t | t == 1 = ptext SLIT("once") | t == 2 = ptext SLIT("twice") | otherwise = speakN t <+> ptext SLIT("times") -plural [x] = empty -plural xs = char 's' +plural :: [a] -> SDoc +plural [_] = empty -- a bit frightening, but there you are +plural _ = char 's' \end{code} @@ -512,6 +610,7 @@ pprPgmError = pprAndThen pgmError -- Throw an exn saying "bug in pgm being compi -- (used for unusual pgm errors) pprTrace = pprAndThen trace +pprPanic# :: String -> SDoc -> FastInt pprPanic# heading pretty_msg = panic# (show (doc PprDebug)) where doc = text heading <+> pretty_msg @@ -531,8 +630,8 @@ assertPprPanic file line msg msg] warnPprTrace :: Bool -> String -> Int -> SDoc -> a -> a -warnPprTrace False file line msg x = x -warnPprTrace True file line msg x +warnPprTrace False _file _line _msg x = x +warnPprTrace True file line msg x = trace (show (doc PprDebug)) x where doc = sep [hsep [text "WARNING: file", text file, text "line", int line],