Cabal/FAQ

From HaskellWiki

1 What is this hidden package?

You build a package and get a message like:

Could not find module `Data.Map': it is a member of package
containers-0.1.0.0, which is hidden.

This is because the package has not been updated for ghc-6.8 which has split the base package into lots of smaller packages. The package needs to be updated to say that it depends on these new split base packages, like containers, process and several others.

If you just want to get the package to build, add the missing package names to the build-depends: line in the .cabal file. For example given the above error message we would add the 'containers' package to the build-depends.

Developers of packages who want to know how to update their package properly so that it will continue to work with old and new compilers should see Upgrading_packages.

2 How do I handle extensions?

If your code uses some of the advanced Haskell extensions, you have a number of options.

You can use the OPTIONS_GHC pragma to supply the -fglasgow-exts on a per-file basis (as opposed to in the cabal file which would apply to every file), like thus:

{-# OPTIONS_GHC -fglasgow-exts #-}

.

The best way to do it, if you know your users are on GHC 6.8.x are the new LANGUAGE pragmas. ie, each extension has a name, and you only list those which you are using (you can find the list in Distribution.Extension). So you can enable only those extensions you are using. Like before, you enable them in the cabal file, mention them like extensions: CPP, ForeignFunctionInterface.

Of course, even better is specifying them in only the file using them. A pragma might look like:

{-# LANGUAGE CPP, ForeignFunctionInterface #-}

(You'll probably still want to use the extensions field just to make clear at the top level what extensions the project uses.)

3 [Windows] I tried to install a Haskell binding to (some external C library), but I get build errors

Check that the external C library is actually installed on your system. (Cabal does not do this for you.)

Check the package contents, package home page, etc., to see if the author has told you how to get this package to work on Windows.

If those two fail to get you any further, proceed as follows:

Cabal probably needs to be able to find header files in order to compile the package. In future there will be some switches for the 'configure' step to allow you to specify the path to these. For now, you'll have to manually hack the Cabal information file to tell Cabal where to look. Try adding a line in the 'library' section saying something like include-dirs: "C:\\Program Files\\My External Library\\include" (Note carefully the quotes and double backslashes!) Obviously the actual path varies depending on where you installed the thing.

Cabal may also need to find object files that need to be statically linked. Again, a future Cabal release will allow you to specify these during the configure state with switches, but for now try adding extra-lib-dirs: "C:\\Program Files\\My External Library\\lib" or similar.

Assuming you get your library to compile, you may still need to add DLLs or other resources to your PATH variable to get any programs using the package to actually run. (But the installer for the external library might have done this for you already.)