Difference between revisions of "Cabal"

From HaskellWiki
Jump to navigation Jump to search
 
(→‎Information for package developers: Added a link to "Cabal/How to install a Cabal package remotely")
(26 intermediate revisions by 10 users not shown)
Line 1: Line 1:
−
The Haskell Cabal
 +
The Haskell Cabal:
  +
:The '''C'''ommon '''A'''rchitecture for '''B'''uilding '''A'''pplications and '''L'''ibraries
−
The Common Architecture for Building Applications and Libraries
  
   
 
http://www.haskell.org/cabal/
  
http://www.haskell.org/cabal/
   
  +
== Summary ==
−
= Building Dlls on Windows with Cabal =
  
  +
* Cabal is a package and build system. Cabal is only involved in the creation of packages and the building of their contents. It does not manage packages.
−
Cabal does not currently support building dlls on windows out of the box. Some details about why can be found here:
  
  +
* Cabal-Install installs cabal packages. It is distinct from Cabal (the build system). This often confuses new users. Furthermore, Cabal-Install is not a fully featured package manager. For example, it cannot install non cabal packaged dependencies, it cannot uninstall packages, nor can it automatically upgrade installations.
−
http://www.haskell.org/ghc/docs/6.4.2/html/users_guide/packages.html
  
−
http://www.haskell.org/ghc/docs/6.4.2/html/users_guide/win32-dlls.html
  
   
  +
== Information for package users ==
−
This means that we have to do a bit of hackery to get Cabal to build a dll from a library. As long as we build a single DLL from the entire project the dll should behave as expected.
  
  +
*[[Cabal/Survival | A short and transient survival guide for Cabal users]]
  +
*[[Cabal/How to install a Cabal package | How to install a Cabal package]]
  +
*[[Cabal/FAQ|FAQ: Frequently Asked Questions]]
  +
*[[Cabal-Install]] - tool that greatly simplifies installation of Cabal packages
  +
*[http://hackage.haskell.org/package/cabal-sort Cabal-Sort] - assistance with compilation of multiple cabal packages
  +
*[[CabalFind]] - finding Cabal packages on the web (now superseded by [http://hackage.haskell.org/ Hackage])
  +
* [http://www.vex.net/~trebla/haskell/sicp.xhtml Storage and Identification of Cabalized Packages]
  +
* [http://hackage.haskell.org/package/cabal-dev cabal-dev], a tool for managing development builds of Haskell projects. It supports maintaining sandboxed cabal-install repositories, and sandboxed ghc package databases. See [http://www.reddit.com/r/haskell/comments/f3ykj/psa_use_cabaldev_to_solve_dependency_problems/ PSA: Use cabal-dev to solve dependency problems] for an extensive description.
  +
* Blog article: [http://ivanmiljenovic.wordpress.com/2010/03/15/repeat-after-me-cabal-is-not-a-package-manager/ Repeat after me: “Cabal is not a Package Manager”]
  +
* [http://www.mew.org/~kazu/proj/cab/en/ cab], a maintenance command of Haskell cabal packages
   
  +
== Information for package developers ==
−
The following Setup.lhs should do the trick for most projects which consist of a single library which needs to be built as a dll. If you need to specify a dll export file you'll need to modify the function <tt>cmd</tt> to take this into account.
  
  +
*[[How to write a Haskell program]]
  +
*[[Cabal/Developer-FAQ|FAQ: Frequently Asked Questions of package authors]]
  +
*[[Cabal/How to install a Cabal package remotely | How to install a Cabal package remotely]]
  +
*[[Upgrading packages]]
  +
*[[Package versioning policy]]
  +
*[[Creating Debian packages from Cabal package]]
  +
*[http://neilmitchell.blogspot.com/2008/02/adding-data-files-using-cabal.html Adding data files using Cabal]
  +
*[http://www.moonloop.net/haskell/docs/cbs-custom.html Cabal Setup file examples]
  +
*[[Cabal-make]] - automation based on makefiles
  +
*[http://blog.ezyang.com/2010/06/setting-up-cabal-the-ffi-and-c2hs/ Setting up Cabal, the FFI and c2hs]
   
  +
[[Category:Tools]]
−
<haskell>
  
  +
[[Category:Cabal]]
−
#! /usr/bin/runghc
  
−  
−
> import Distribution.Simple
  
−
> import Distribution.Simple.LocalBuildInfo
  
−
> import Distribution.PackageDescription
  
−
> import System.Cmd
  
−
> import System.Directory
  
−
> import Data.List
  
−
>
  
−
>
  
−
> main = defaultMainWithHooks (defaultUserHooks { postBuild = buildDll })
  
−
> where
  
−
> buildDll _ _ pkg info = do putStrLn "Building Dll..."
  
−
> setCurrentDirectory (buildDir info)
  
−
> let buildCmd = cmd pkg info
  
−
> putStrLn buildCmd
  
−
> system buildCmd
  
−
> let cpCmd = "cp "++(dllFile pkg)++" "++(name pkg)++"\\"++(dllFile pkg)
  
−
> putStrLn cpCmd
  
−
> system cpCmd
  
−
> ghcExe :: LocalBuildInfo -> String
  
−
> ghcExe info = "\"" ++ (compilerPath (compiler info)) ++ "\""
  
−
> mainOFile :: PackageDescription -> String
  
−
> mainOFile pd = "HS" ++ (name pd) ++ "-" ++ (showVersion (pkgVersion (package pd))) ++ ".o"
  
−
> cmd :: PackageDescription -> LocalBuildInfo -> String
  
−
> cmd pd i = (ghcExe i) ++ " --mk-dll -o " ++ (dllFile pd) ++ " " ++ (mainOFile pd) ++ " " ++ (packages i)
  
−
> packages :: LocalBuildInfo -> String
  
−
> packages i = foldl1 (\x y -> x ++ " " ++ y) (map showPackage (packageDeps i))
  
−
> showPackage :: PackageIdentifier -> String
  
−
> showPackage pi = "-package " ++ showPackageId pi
  
−
> name :: PackageDescription -> String
  
−
> name = pkgName . package
 
−
> dllFile :: PackageDescription -> String
  
−
> dllFile pd = (name pd) ++ ".dll"
  
−
</haskell>
  

Revision as of 15:30, 11 October 2013

The Haskell Cabal:

The Common Architecture for Building Applications and Libraries

http://www.haskell.org/cabal/

Summary

  • Cabal is a package and build system. Cabal is only involved in the creation of packages and the building of their contents. It does not manage packages.
  • Cabal-Install installs cabal packages. It is distinct from Cabal (the build system). This often confuses new users. Furthermore, Cabal-Install is not a fully featured package manager. For example, it cannot install non cabal packaged dependencies, it cannot uninstall packages, nor can it automatically upgrade installations.

Information for package users

Information for package developers

Retrieved from "https://wiki.haskell.org/index.php?title=Cabal&oldid=56974"