内省GHC模块中的函数名称

时间:2015-03-12 11:08:02

标签: haskell reflection ghc

格拉斯哥Haskell编译器中是否有一种方法可以内省模块中所有函数的名称?

我正在尝试创建一个自动数据库迁移系统,根据迁移模块的名称,内省函数的名称并一次调用它们。

这样的东西
doMigrations("Migrations.M_2015")
doMigrations("Migrations.M_2016")
-- ...

Migration.M_2015包含

module Migration.M_2015
where

migration_2015_01_02 :: DbConnection -> Status
migration_2015_01_02 connection =
    -- ...

每个doMigration将反映其模块中迁移函数的名称,并且只调用之前未运行的名称(名称保存在数据库表中)。这只会在应用程序启动时调用,因此性能不是一个大问题。反射可以在编译时或运行时发生。

1 个答案:

答案 0 :(得分:1)

为了做到这一点,你需要使用GHC API - 它包含在ghc包中(隐藏) - 并且记录很少。

我在这里附上一个简单的程序,它将打印出模块中导出的顶级项目列表。这应该作为一个起点。这是一个小命令行实用程序,它接受两个参数 - 模块名称和单词“class”,“data”,“function”。所以,例如:

test Prelude function

将打印模块导出的函数列表(那些不是构造函数或在类中定义的函数)。

为了编译它(假设它在test.hs中),你需要这样做:

ghc -package ghc test

为了使GHC API包可用。

以下是代码:

import Data.List ( (\\) )
import Data.Maybe (fromJust, catMaybes)
import System.Environment (getArgs)

-- the GHC API stuff

import GHC
import GHC.Paths (libdir)
import ConLike ( ConLike(..) )
import Outputable (showPpr, showSDocUnqual)
import Var (tyVarName)

showU dfs = showSDocUnqual dfs . pprParenSymName

main = do
   (mn : ty : _) <- getArgs
   a <- runGhc (Just libdir) $ do 
     dflags <- getSessionDynFlags
     setSessionDynFlags dflags
     mm <- lookupModule (mkModuleName mn) Nothing
     mi <- fmap fromJust $ getModuleInfo mm
     res <- fmap catMaybes $ mapM lookupName (modInfoExports mi)
     return $ case ty of
       "class" -> [showU dflags c' | c@(ATyCon c') <- res, isClassTyCon c']
       "data" -> [showU dflags c' | c@(ATyCon c') <- res, (not . isClassTyCon) c']
       "function" -> let cf = map getName $ concat [(classMethods . fromJust . tyConClass_maybe) c' | c@(ATyCon c') <- res, isClassTyCon c']
                         df = map getName $ concat [ tyConDataCons c' | c@(ATyCon c') <- res, (not . isClassTyCon) c']
                         ff = [ getName c | c@(AnId{}) <- res] \\ cf
                         fd = [ getName c | c@(AConLike (RealDataCon{})) <- res] \\ df
                     in [showU dflags x | x <- ff ++ fd]
       _ -> ["need to specify: class, data, or function"]
  print a

类和定义数据的列表非常简单。已定义函数的列表包括在类和构造函数中定义的函数。上述代码,对于函数,不包括这些代码(使用\\ cf\\ df)。

a是生成的函数(或类或数据)名称列表。

调用这些函数的代码将成为不同问题(和答案)的主题。

lookupModule是加载模块进行分析的函数。

getModuleInfomodInfoExports的组合获取“stuff”列表,其中包括从模块导出的函数列表。

其余代码是关于以可用的形式获取这些名称。