HsDecls.lhs 10.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
%
% (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
%
\section[HsDecls]{Abstract syntax: global declarations}

Definitions for: @FixityDecl@, @TyDecl@ and @ConDecl@, @ClassDecl@,
@InstDecl@, @DefaultDecl@.

\begin{code}
#include "HsVersions.h"

module HsDecls where

import Ubiq{-uitous-}

-- friends:
import HsLoop		( nullMonoBinds, MonoBinds, Sig )
import HsPragmas	( DataPragmas, ClassPragmas,
			  InstancePragmas, ClassOpPragmas
			)
import HsTypes

-- others:
import Outputable
import Pretty
import ProtoName	( cmpProtoName, ProtoName )
import SrcLoc		( SrcLoc )
import Util		( cmpList, panic#{-ToDo:rm eventually-} )
\end{code}

%************************************************************************
%*									*
\subsection[FixityDecl]{A fixity declaration}
%*									*
%************************************************************************

These are only used in generating interfaces at the moment.  They are
not used in pretty-printing.

\begin{code}
data FixityDecl name
  = InfixL	name Int
  | InfixR	name Int
  | InfixN	name Int
\end{code}

\begin{code}
instance (NamedThing name, Outputable name)
     => Outputable (FixityDecl name) where
    ppr sty (InfixL var prec)	= print_it sty "l" prec var
    ppr sty (InfixR var prec)	= print_it sty "r" prec var
    ppr sty (InfixN var prec)	= print_it sty ""  prec var

print_it sty suff prec var
  = ppBesides [ppStr "infix", ppStr suff, ppSP, ppInt prec, ppSP, pprOp sty var]
\end{code}

%************************************************************************
%*									*
\subsection[TyDecl]{@data@, @newtype@ or @type@ (synonym) type declaration}
%*									*
%************************************************************************

\begin{code}
data TyDecl name
  = TyData	(Context name)	-- context
		name		-- type constructor
		[name]		-- type variables
		[ConDecl name]	-- data constructors (empty if abstract)
		(Maybe [name])	-- derivings; Nothing => not specified
				-- (i.e., derive default); Just [] => derive
				-- *nothing*; Just <list> => as you would
				-- expect...
		(DataPragmas name)
		SrcLoc

  | TyNew	(Context name)	-- context
		name		-- type constructor
		[name]		-- type variables
		[ConDecl name]	-- data constructor (empty if abstract)
		(Maybe [name])	-- derivings; as above
		(DataPragmas name)
		SrcLoc

  | TySynonym	name		-- type constructor
		[name]		-- type variables
		(MonoType name)	-- synonym expansion
		SrcLoc

\end{code}

\begin{code}
instance (NamedThing name, Outputable name)
	      => Outputable (TyDecl name) where

    ppr sty (TySynonym tycon tyvars mono_ty src_loc)
      = ppHang (pp_decl_head sty SLIT("type") ppNil tycon tyvars)
	     4 (ppCat [ppEquals, ppr sty mono_ty])

    ppr sty (TyData context tycon tyvars condecls derivings pragmas src_loc)
      = pp_tydecl sty
		  (pp_decl_head sty SLIT("data") (pprContext sty context) tycon tyvars)
		  (pp_condecls sty condecls)
		  derivings

    ppr sty (TyNew context tycon tyvars condecl derivings pragmas src_loc)
      = pp_tydecl sty
		  (pp_decl_head sty SLIT("newtype") (pprContext sty context) tycon tyvars)
		  (pp_condecls sty condecl)
		  derivings

pp_decl_head sty str pp_context tycon tyvars
  = ppCat [ppPStr str, pp_context, ppr sty tycon, interppSP sty tyvars]

pp_condecls sty [] = ppNil -- abstract datatype
pp_condecls sty (c:cs)
  = ppSep (ppBeside (ppStr "= ") (ppr sty c)
	   : map (\ x -> ppBeside (ppStr "| ") (ppr sty x)) cs)

pp_tydecl sty pp_head pp_decl_rhs derivings
  = ppHang pp_head 4 (ppSep [
	pp_decl_rhs,
	case derivings of
	  Nothing -> ppNil
	  Just ds -> ppBeside (ppPStr SLIT("deriving "))
			(ppParens (ppInterleave ppComma (map (ppr sty) ds)))])
\end{code}

A type for recording what types a datatype should be specialised to.
It's called a ``Sig'' because it's sort of like a ``type signature''
for an datatype declaration.

\begin{code}
data SpecDataSig name
  = SpecDataSig name		-- tycon to specialise
		(MonoType name)
		SrcLoc

instance (NamedThing name, Outputable name)
	      => Outputable (SpecDataSig name) where

    ppr sty (SpecDataSig tycon ty _)
      = ppCat [ppStr "{-# SPECIALIZE data", ppr sty ty, ppStr "#-}"]
\end{code}

%************************************************************************
%*									*
\subsection[ConDecl]{A data-constructor declaration}
%*									*
%************************************************************************

\begin{code}
data ConDecl name
  = ConDecl	name		-- prefix-style con decl
		[BangType name]
		SrcLoc

  | ConOpDecl	(BangType name)	-- infix-style con decl
		name
		(BangType name)
		SrcLoc

  | RecConDecl	name
		[(name, BangType name)]	-- list of "fields"
		SrcLoc

  | NewConDecl  name		-- newtype con decl
		(MonoType name)
		SrcLoc

data BangType name
  = Banged   (MonoType name)
  | Unbanged (MonoType name)
\end{code}

In checking interfaces, we need to ``compare'' @ConDecls@.  Use with care!
\begin{code}
eqConDecls cons1 cons2
  = case (cmpList cmp cons1 cons2) of { EQ_ -> True; _ -> False }
  where
    cmp (ConDecl n1 tys1 _) (ConDecl n2 tys2 _)
      = case cmpProtoName n1 n2 of
	  EQ_ -> cmpList cmp_bang_ty tys1 tys2
	  xxx -> xxx
    cmp (ConOpDecl _ _ _ _) _  = panic# "eqConDecls:ConOpDecl"
    cmp (RecConDecl _ _ _)  _  = panic# "eqConDecls:RecConDecl"
    cmp (NewConDecl _ _ _)  _  = panic# "eqConDecls:NewConDecl"
    -------------

    cmp_ty = cmpMonoType cmpProtoName
    -------------
    cmp_bang_ty (Banged   ty1) (Banged   ty2) = cmp_ty ty1 ty2
    cmp_bang_ty (Unbanged ty1) (Unbanged ty2) = cmp_ty ty1 ty2
    cmp_bang_ty (Banged   _)   _	      = LT_
    cmp_bang_ty _	       _	      = GT_
\end{code}

\begin{code}
instance (NamedThing name, Outputable name) => Outputable (ConDecl name) where

    ppr sty (ConDecl con tys _)
      = ppCat [pprNonOp sty con, ppInterleave ppNil (map (ppr_bang sty) tys)]
    ppr sty (ConOpDecl ty1 op ty2 _)
      = ppCat [ppr_bang sty ty1, pprOp sty op, ppr_bang sty ty2]
    ppr sty (NewConDecl con ty _)
      = ppCat [pprNonOp sty con, pprParendMonoType sty ty]
    ppr sty (RecConDecl con fields _)
      = ppCat [pprNonOp sty con, ppChar '{',
	       ppInterleave pp'SP (map pp_field fields), ppChar '}']
      where
	pp_field (n, ty) = ppCat [ppr sty n, ppPStr SLIT("::"), ppr_bang sty ty]

ppr_bang sty (Banged   ty) = ppBeside (ppChar '!') (pprParendMonoType sty ty)
ppr_bang sty (Unbanged ty) = pprParendMonoType sty ty
\end{code}

%************************************************************************
%*									*
\subsection[ClassDecl]{A class declaration}
%*									*
%************************************************************************

\begin{code}
data ClassDecl tyvar uvar name pat
  = ClassDecl	(Context name)	    		-- context...
		name		    		-- name of the class
		name		    		-- the class type variable
		[Sig name]			-- methods' signatures
		(MonoBinds tyvar uvar name pat)	-- default methods
		(ClassPragmas name)
		SrcLoc
\end{code}

\begin{code}
instance (NamedThing name, Outputable name, Outputable pat,
	  Eq tyvar, Outputable tyvar, Eq uvar, Outputable uvar)
		=> Outputable (ClassDecl tyvar uvar name pat) where

    ppr sty (ClassDecl context clas tyvar sigs methods pragmas src_loc)
     = ppAboves [ppCat [ppStr "class", pprContext sty context, ppr sty clas,
			ppr sty tyvar, ppStr "where"],
			-- ToDo: really shouldn't print "where" unless there are sigs
		 ppNest 4 (ppAboves (map (ppr sty) sigs)),
		 ppNest 4 (ppr sty methods),
		 ppNest 4 (ppr sty pragmas)]
\end{code}

%************************************************************************
%*									*
\subsection[InstDecl]{An instance declaration (also, @SpecInstSig@)}
%*									*
%************************************************************************

\begin{code}
data InstDecl tyvar uvar name pat
  = InstDecl	name		-- Class

		(PolyType name)	-- Context => Instance-type
				-- Using a polytype means that the renamer conveniently
				-- figures out the quantified type variables for us.

		(MonoBinds tyvar uvar name pat)

		Bool		-- True <=> This instance decl is from the
				-- module being compiled; False <=> It is from
				-- an imported interface.

		FAST_STRING	-- The name of the module where the instance decl
				-- originally came from; easy enough if it's
				-- the module being compiled; otherwise, the
				-- info comes from a pragma.

		[Sig name]		-- actually user-supplied pragmatic info
		(InstancePragmas name)	-- interface-supplied pragmatic info
		SrcLoc
\end{code}

\begin{code}
instance (NamedThing name, Outputable name, Outputable pat,
	  Eq tyvar, Outputable tyvar, Eq uvar, Outputable uvar)
	      => Outputable (InstDecl tyvar uvar name pat) where

    ppr sty (InstDecl clas ty binds local modname uprags pragmas src_loc)
      = let
	    (context, inst_ty)
	      = case ty of
		  HsPreForAllTy c t -> (c, t)
		  HsForAllTy  _ c t -> (c, t)

	    top_matter = ppCat [ppStr "instance", pprContext sty context,
			        ppr sty clas, pprParendMonoType sty inst_ty]
	in
	if nullMonoBinds binds && null uprags then
	    ppAbove top_matter (ppNest 4 (ppr sty pragmas))
	else
	    ppAboves [
	      ppCat [top_matter, ppStr "where"],
	      if null uprags then ppNil else ppNest 4 (ppr sty uprags),
	      ppNest 4 (ppr sty binds),
	      ppNest 4 (ppr sty pragmas) ]
\end{code}

A type for recording what instances the user wants to specialise;
called a ``Sig'' because it's sort of like a ``type signature'' for an
instance.
\begin{code}
data SpecInstSig name
  = SpecInstSig  name		    -- class
		 (MonoType name)    -- type to specialise to
		 SrcLoc

instance (NamedThing name, Outputable name)
	      => Outputable (SpecInstSig name) where

    ppr sty (SpecInstSig clas ty _)
      = ppCat [ppStr "{-# SPECIALIZE instance", ppr sty clas, ppr sty ty, ppStr "#-}"]
\end{code}

%************************************************************************
%*									*
\subsection[DefaultDecl]{A @default@ declaration}
%*									*
%************************************************************************

There can only be one default declaration per module, but it is hard
for the parser to check that; we pass them all through in the abstract
syntax, and that restriction must be checked in the front end.

\begin{code}
data DefaultDecl name
  = DefaultDecl	[MonoType name]
		SrcLoc

instance (NamedThing name, Outputable name)
	      => Outputable (DefaultDecl name) where

    ppr sty (DefaultDecl tys src_loc)
      = ppBeside (ppPStr SLIT("default ")) (ppParens (interpp'SP sty tys))
\end{code}