modulespection: Template Haskell for introspecting a module's declarations

[ bsd3, language, library ] [ Propose Tags ] [ Report a vulnerability ]

Collect all of the declarations in a module using Template Haskell (via the GHC API).

One can either get all the names, or just the declarations (only type declarations are supported right now).

Here is a quick example:

import Language.Haskell.TH.Module.Magic (names)

data Test = Test Int
newtype OtherTest = OtherTest Test

someFunction :: String -> String
someFunction = id

-- 'names' is Template Haskell function that will collect all of the
-- toplevel declaration names of the current file.
names >>= runIO . print >> return []

Which will spew the following when compiling:

[Test,OtherTest,someFunction]

There is also declarations which can be used, for example, to make sure that all types have ToJSON/FromJSON instances.

import Data.Aeson.TH (deriveJSON, defaultOptions)
import MonadUtils (concatMapM)
import Language.Haskell.TH.Module.Magic (declarations)

data Test = Test Int
newtype OtherTest = OtherTest Test

concatMapM (deriveJSON defaultOptions) =<< declarations

Which will make JSON instances for Test, OtherTest and any other types added to the file.

You can also do the same thing for an existing module.

import Data.Aeson.TH (deriveJSON, defaultOptions)
import MonadUtils (concatMapM)
import Language.Haskell.TH.Module.Magic (moduleDeclarations)
import Data.Monoid

concatMapM (deriveJSON defaultOptions) =<< moduleDeclarations "Data.Monoid"

Which will build instances for all the types in Data.Monoid.

Modules

[Last Documentation]

  • Language
    • Haskell
      • TH
        • Module
          • Language.Haskell.TH.Module.Magic

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.1.0.4, 0.1.0.5, 0.1.0.6, 0.1.0.7, 0.1.1.0, 0.1.2.0, 0.1.2.1, 0.1.2.2
Dependencies base (>=4.6 && <666), exceptions (>=0.3 && <0.6), filepath (>=1.3 && <1.4), ghc, ghc-paths (>=0.1 && <0.2), template-haskell (>=2.7), temporary (>=1.2 && <1.3), transformers (>=0.3 && <0.4) [details]
License BSD-3-Clause
Author Jonathan Fischoff
Maintainer jonathangfischoff@gmail.com
Category Language
Home page https://github.com/jfischoff/modulespection
Uploaded by JonathanFischoff at 2014-04-28T06:41:05Z
Distributions
Reverse Dependencies 2 direct, 0 indirect [details]
Downloads 7960 total (25 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
All reported builds failed as of 2016-12-15 [all 7 reports]