ghc/compiler/basicTypes/FieldLabel.lhs

   1 %
   2 % (c) The AQUA Project, Glasgow University, 1996-1998
   3 %
   4 \section[FieldLabel]{The @FieldLabel@ type}
   5
   6 \begin{code}
   7 module FieldLabel where
   8
   9 #include "HsVersions.h"
  10
  11 import {-# SOURCE #-}   TypeRep( Type ) -- FieldLabel is compiled very early
  12
  13 import Name             ( Name{-instance Eq/Outputable-}, NamedThing(..), nameUnique )
  14 import Outputable
  15 import Unique           ( Uniquable(..) )
  16 \end{code}
  17
  18 \begin{code}
  19 data FieldLabel
  20   = FieldLabel  Name            -- Also used as the Name of the field selector Id
  21                 Type            -- Type of the field; may have free type variables that
  22                                 -- are the tyvars of its parent *data* constructor, and
  23                                 -- those will be the same as the tyvars of its parent *type* constructor
  24                                 -- e.g.  data T a = MkT { op1 :: a -> a, op2 :: a -> Int }
  25                                 -- The type in the FieldLabel for op1 will be simply (a->a).
  26
  27                 FieldLabelTag   -- Indicates position within constructor
  28                                 -- (starting with firstFieldLabelTag)
  29                                 --
  30                                 -- If the same field occurs in more than one constructor
  31                                 -- then it'll have a separate FieldLabel on each occasion,
  32                                 -- but with a single name (and presumably the same type!)
  33
  34 type FieldLabelTag = Int
  35
  36 mkFieldLabel = FieldLabel
  37
  38 firstFieldLabelTag :: FieldLabelTag
  39 firstFieldLabelTag = 1
  40
  41 allFieldLabelTags :: [FieldLabelTag]
  42 allFieldLabelTags = [firstFieldLabelTag..]
  43
  44 fieldLabelName (FieldLabel n _  _)   = n
  45 fieldLabelType (FieldLabel _ ty _)   = ty
  46 fieldLabelTag  (FieldLabel _ _  tag) = tag
  47
  48 instance Eq FieldLabel where
  49     (FieldLabel n1 _ _) == (FieldLabel n2 _ _) = n1 == n2
  50
  51 instance Outputable FieldLabel where
  52     ppr (FieldLabel n _ _) = ppr n
  53
  54 instance NamedThing FieldLabel where
  55     getName (FieldLabel n _ _) = n
  56
  57 instance Uniquable FieldLabel where
  58     getUnique (FieldLabel n _ _) = nameUnique n
  59 \end{code}