content: {-# LANGUAGE FlexibleContexts #-}
  {-# LANGUAGE TypeFamilies #-}
  
  -- |
  -- Statistics for per-module compilations
  --
  -- (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
  --
  
  module GHC.Hs.Stats ( ppSourceStats ) where
  
  import GHC.Prelude
  
  import GHC.Hs
  import GHC.Types.SrcLoc
  
  import GHC.Utils.Outputable
  import GHC.Utils.Misc
  import GHC.Utils.Panic
  
  import Data.Char
  
  -- | Source Statistics
  ppSourceStats :: Bool -> Located (HsModule GhcPs) -> SDoc
  ppSourceStats short (L _ (HsModule{ hsmodExports = exports, hsmodImports = imports, hsmodDecls = ldecls }))
    = (if short then hcat else vcat)
          (map pp_val
              [("ExportAll        ", export_all), -- 1 if no export list
               ("ExportDecls      ", export_ds),
               ("ExportModules    ", export_ms),
               ("Imports          ", imp_no),
               ("  ImpSafe        ", imp_safe),
               ("  ImpQual        ", imp_qual),
               ("  ImpAs          ", imp_as),
               ("  ImpAll         ", imp_all),
               ("  ImpPartial     ", imp_partial),
               ("  ImpHiding      ", imp_hiding),
               ("FixityDecls      ", fixity_sigs),
               ("DefaultDecls     ", default_ds),
               ("TypeDecls        ", type_ds),
               ("DataDecls        ", data_ds),
               ("NewTypeDecls     ", newt_ds),
               ("TypeFamilyDecls  ", type_fam_ds),
               ("DataConstrs      ", data_constrs),
               ("DataDerivings    ", data_derivs),
               ("ClassDecls       ", class_ds),
               ("ClassMethods     ", class_method_ds),
               ("DefaultMethods   ", default_method_ds),
               ("InstDecls        ", inst_ds),
               ("InstMethods      ", inst_method_ds),
               ("InstType         ", inst_type_ds),
               ("InstData         ", inst_data_ds),
               ("TypeSigs         ", bind_tys),
               ("ClassOpSigs      ", generic_sigs),
               ("ValBinds         ", val_bind_ds),
               ("FunBinds         ", fn_bind_ds),
               ("PatSynBinds      ", patsyn_ds),
               ("InlineMeths      ", method_inlines),
               ("InlineBinds      ", bind_inlines),
               ("SpecialisedMeths ", method_specs),
               ("SpecialisedBinds ", bind_specs)
              ])
    where
      decls = map unLoc ldecls
  
      pp_val (_, 0) = empty
      pp_val (str, n)
        | not short   = hcat [text str, int n]
        | otherwise   = hcat [text (trim str), equals, int n, semi]
  
      trim ls    = takeWhile (not.isSpace) (dropWhile isSpace ls)
  
      (fixity_sigs, bind_tys, bind_specs, bind_inlines, generic_sigs)
          = count_sigs [d | SigD _ d <- decls]
                  -- NB: this omits fixity decls on local bindings and
                  -- in class decls. ToDo
  
      tycl_decls = [d | TyClD _ d <- decls]
      (class_ds, type_ds, data_ds, newt_ds, type_fam_ds) =
        countTyClDecls tycl_decls
  
      inst_decls = [d | InstD _ d <- decls]
      inst_ds    = length inst_decls
      default_ds = count (\ x -> case x of { DefD{} -> True; _ -> False}) decls
      val_decls  = [d | ValD _ d <- decls]
  
      real_exports = case exports of { Nothing -> []; Just (L _ es) -> es }
      n_exports    = length real_exports
      export_ms    = count (\ e -> case unLoc e of { IEModuleContents{} -> True
                                                   ; _ -> False})
                           real_exports
      export_ds    = n_exports - export_ms
      export_all   = case exports of { Nothing -> 1; _ -> 0 }
  
      (val_bind_ds, fn_bind_ds, patsyn_ds)
          = sum3 (map count_bind val_decls)
  
      (imp_no, imp_safe, imp_qual, imp_as, imp_all, imp_partial, imp_hiding)
          = sum7 (map import_info imports)
      (data_constrs, data_derivs)
          = sum2 (map data_info tycl_decls)
      (class_method_ds, default_method_ds)
          = sum2 (map class_info tycl_decls)
      (inst_method_ds, method_specs, method_inlines, inst_type_ds, inst_data_ds)
          = sum5 (map inst_info inst_decls)
  
      count_bind (PatBind { pat_lhs = L _ (VarPat{}) }) = (1,0,0)
      count_bind (PatBind {})                           = (0,1,0)
      count_bind (FunBind {})                           = (0,1,0)
      count_bind (PatSynBind {})                        = (0,0,1)
      count_bind b = pprPanic "count_bind: Unhandled binder" (ppr b)
  
      count_sigs sigs = sum5 (map sig_info sigs)
  
      sig_info (FixSig {})     = (1,0,0,0,0)
      sig_info (TypeSig {})    = (0,1,0,0,0)
      sig_info (SpecSig {})    = (0,0,1,0,0)
      sig_info (SpecSigE {})   = (0,0,1,0,0)
      sig_info (InlineSig {})  = (0,0,0,1,0)
      sig_info (ClassOpSig {}) = (0,0,0,0,1)
      sig_info _               = (0,0,0,0,0)
  
      import_info :: LImportDecl GhcPs -> (Int, Int, Int, Int, Int, Int, Int)
      import_info (L _ (ImportDecl { ideclSafe = safe, ideclQualified = qual
                                   , ideclAs = as, ideclImportList = spec }))
          = add7 (1, safe_info safe, qual_info qual, as_info as, 0,0,0) (spec_info spec)
  
      safe_info False = 0
      safe_info True = 1
      qual_info NotQualified = 0
      qual_info _  = 1
      as_info Nothing  = 0
      as_info (Just _) = 1
      spec_info Nothing           = (0,0,0,0,1,0,0)
      spec_info (Just (Exactly, _)) = (0,0,0,0,0,1,0)
      spec_info (Just (EverythingBut, _))  = (0,0,0,0,0,0,1)
  
      data_info (DataDecl { tcdDataDefn = dd :: HsDataDefn GhcPs })
          | HsDataDefn { dd_cons = cs, dd_derivs = derivs} <- dd
          = ( length cs
            , foldl' (\s dc -> length (deriv_clause_tys $ unLoc dc) + s)
                     0 derivs )
      data_info _ = (0,0)
  
      class_info decl@(ClassDecl {})
          = (classops, addpr (sum3 (map count_bind methods)))
        where
          methods = map unLoc $ tcdMeths decl
          (_, classops, _, _, _) = count_sigs (map unLoc (tcdSigs decl))
      class_info _ = (0,0)
  
      inst_info :: InstDecl GhcPs -> (Int, Int, Int, Int, Int)
      inst_info (TyFamInstD {}) = (0,0,0,1,0)
      inst_info (DataFamInstD {}) = (0,0,0,0,1)
      inst_info (ClsInstD { cid_inst = ClsInstDecl {cid_binds = inst_meths
                                                   , cid_sigs = inst_sigs
                                                   , cid_tyfam_insts = ats
                                                   , cid_datafam_insts = adts } })
          = case count_sigs (map unLoc inst_sigs) of
              (_,_,ss,is,_) ->
                    (addpr (sum3 (map count_bind methods)),
                     ss, is, length ats, length adts)
        where
          methods = map unLoc inst_meths
  
      -- TODO: use Sum monoid
      addpr :: (Int,Int,Int) -> Int
      sum2 :: [(Int, Int)] -> (Int, Int)
      sum3 :: [(Int, Int, Int)] -> (Int, Int, Int)
      sum5 :: [(Int, Int, Int, Int, Int)] -> (Int, Int, Int, Int, Int)
      sum7 :: [(Int, Int, Int, Int, Int, Int, Int)] -> (Int, Int, Int, Int, Int, Int, Int)
      add7 :: (Int, Int, Int, Int, Int, Int, Int) -> (Int, Int, Int, Int, Int, Int, Int)
           -> (Int, Int, Int, Int, Int, Int, Int)
  
      addpr (x,y,z) = x+y+z
      sum2 = foldr add2 (0,0)
        where
          add2 (x1,x2) (y1,y2) = (x1+y1,x2+y2)
      sum3 = foldr add3 (0,0,0)
        where
          add3 (x1,x2,x3) (y1,y2,y3) = (x1+y1,x2+y2,x3+y3)
      sum5 = foldr add5 (0,0,0,0,0)
        where
          add5 (x1,x2,x3,x4,x5) (y1,y2,y3,y4,y5) = (x1+y1,x2+y2,x3+y3,x4+y4,x5+y5)
      sum7 = foldr add7 (0,0,0,0,0,0,0)
  
      add7 (x1,x2,x3,x4,x5,x6,x7) (y1,y2,y3,y4,y5,y6,y7) = (x1+y1,x2+y2,x3+y3,x4+y4,x5+y5,x6+y6,x7+y7)
  