aboutsummaryrefslogblamecommitdiff
path: root/src/Haddock/GHC/Utils.hs
blob: cfe0a83b21941fefeef757c7e41a0b40d1bd3311 (plain) (tree)
1
2
3
4
5
6
7
8
9




                                         
 
                              
 
 
                  
                
                                
          
             
                 

               
 

























                                                                      

                                                





                                                                       
       
 
                                               
                                                     
 


                                              
                            

                                                                     
                                                           
                             
 
 

                                                   
 

                                        
 
                                          
--
-- Haddock - A Haskell Documentation Tool
--
-- (c) Simon Marlow 2003
--


module Haddock.GHC.Utils where


import Debug.Trace
import Data.Char
import qualified Data.Map as Map

import GHC
import HsSyn
import SrcLoc
import HscTypes
import Outputable
import Packages
import UniqFM
import Name


-- names

nameOccString = occNameString . nameOccName 


nameSetMod n newMod = 
  mkExternalName (nameUnique n) newMod (nameOccName n) (nameSrcSpan n)


nameSetPkg pkgId n = 
  mkExternalName (nameUnique n) (mkModule pkgId (moduleName mod)) 
	               (nameOccName n) (nameSrcSpan n)
  where mod = nameModule n


-- modules


moduleString :: Module -> String
moduleString = moduleNameString . moduleName 


mkModuleNoPkg :: String -> Module
mkModuleNoPkg str = mkModule (stringToPackageId "") (mkModuleName str)


modulePkgStr = packageIdString . modulePackageId


-- Instances


instance (Outputable a, Outputable b) => Outputable (Map.Map a b) where
  ppr m = ppr (Map.toList m)


-- misc


isNameSym n  = isNameVarSym n || isNameConSym n
isNameVarSym = isLexVarSym . occNameFS . nameOccName 
isNameConSym = isLexConSym . occNameFS . nameOccName 


getMainDeclBinder :: HsDecl name -> Maybe name
getMainDeclBinder (TyClD d) = Just (tcdName d)
getMainDeclBinder (ValD d)
   = case collectAcc d [] of
        []       -> Nothing 
        (name:_) -> Just (unLoc name)
getMainDeclBinder (SigD d) = sigNameNoLoc d
getMainDeclBinder (ForD (ForeignImport name _ _)) = Just (unLoc name)
getMainDeclBinder (ForD (ForeignExport name _ _)) = Nothing
getMainDeclBinder _ = Nothing


-- To keep if if minf_iface is re-introduced
--modInfoName = moduleName . mi_module . minf_iface
--modInfoMod  = mi_module . minf_iface 

pretty :: Outputable a => a -> String
pretty x = show (ppr x defaultUserStyle)


trace_ppr x y = trace (showSDoc (ppr x)) y