Personal tools

GHC

From HaskellWiki

(Difference between revisions)
Jump to: navigation, search
(Collaborative documentation)
(Collaborative documentation)
 
(41 intermediate revisions by 18 users not shown)
Line 1: Line 1:
The '''Glasgow Haskell Compiler''' is a state-of-the-art, open source, compiler and interactive environment for the functional language Haskell.
+
The '''Glasgow Haskell Compiler''' is a state-of-the-art, open source compiler and interactive environment for the functional language Haskell.
   
 
* [http://www.haskell.org/ghc/ The GHC Home Page]
 
* [http://www.haskell.org/ghc/ The GHC Home Page]
Line 5: Line 5:
 
== Documentation ==
 
== Documentation ==
   
The documentation below relates to ''using'' GHC. For documentation about the internals of GHC, head over to the [http://hackage.haskell.org/trac/ghc GHC Developer Wiki].
+
The documentation below relates to ''using'' GHC. For documentation about GHC's internals and building GHC, head over to the [http://hackage.haskell.org/trac/ghc GHC Developer Wiki].
   
 
These documents relate to the ''latest released'' version of GHC.
 
These documents relate to the ''latest released'' version of GHC.
 
For ''earlier released'' versions click the relevant version on the
 
For ''earlier released'' versions click the relevant version on the
[http://www.haskell.org/ghc/download.html downloads page].
+
[http://www.haskell.org/ghc/download downloads page].
 
For the the ''current HEAD snapshot'' look at
 
For the the ''current HEAD snapshot'' look at
[http://www.haskell.org/ghc/download.html#snapshots the bottom of the downloads page].
+
[http://www.haskell.org/ghc/download.html#snapshots development snapshots].
   
   
 
; [http://www.haskell.org/ghc/docs/latest/html/users_guide/index.html The User's Guide]: The User's Guide has all you need to know about using GHC: command line options, language extensions, GHCi, etc.
 
; [http://www.haskell.org/ghc/docs/latest/html/users_guide/index.html The User's Guide]: The User's Guide has all you need to know about using GHC: command line options, language extensions, GHCi, etc.
: Download: | [http://www.haskell.org/ghc/docs/latest/users_guide.html.tar.gz HTML.tar.gz] | [http://www.haskell.org/ghc/docs/latest/users_guide.pdf PDF] | [http://www.haskell.org/ghc/docs/latest/users_guide.ps.gz A4 Postscript (gzipped)] |
+
: Download: | [http://www.haskell.org/ghc/docs/latest/users_guide.html.tar.bz2 HTML.tar.bz2] | [http://www.haskell.org/ghc/docs/latest/users_guide.pdf PDF] | [http://www.haskell.org/ghc/docs/latest/users_guide.ps PS] |
 
 
; [http://www.haskell.org/ghc/docs/latest/html/libraries/index.html Hierarchical Libraries]: Documentation for the hierarchical libraries that come with GHC.
+
; [http://www.haskell.org/ghc/docs/latest/html/libraries/index.html Standard Libraries]: Documentation for the libraries that come with GHC.
: Download: | [http://www.haskell.org/ghc/docs/latest/libraries.html.tar.gz HTML.tar.gz] |
+
: Download: | [http://www.haskell.org/ghc/docs/latest/libraries.html.tar.bz2 HTML.tar.bz2]
 
 
; [http://www.haskell.org/ghc/docs/latest/html/Cabal/index.html Cabal]: An infrastructure for building and distributing Haskell software.
+
; [http://www.haskell.org/cabal/users-guide/ Cabal]: An infrastructure for building and distributing Haskell software.
: Download: | [http://www.haskell.org/ghc/docs/latest/Cabal.html.tar.gz HTML.tar.gz] | [http://www.haskell.org/ghc/docs/latest/Cabal.pdf PDF] | [http://www.haskell.org/ghc/docs/latest/Cabal.ps.gz A4 Postscript (gzipped)] |
 
 
; [http://www.haskell.org/ghc/docs/latest/html/hslibs/index.html (Old) Haskell Libraries]: Previous versions of GHC (before version 5.04) came with a suite of libraries known as <tt>hslibs</tt>, aka the Hugs-GHC libraries. As we are in the process of moving towards using hierarchical libraries for everything, many of these libraries have moved over to the new packages in the hierarchical libraries above. We still provide the old <tt>hslibs</tt> libraries for backwards compatibility and also for those libraries which have yet to move into the hierarchy. For libraries which have moved, the documentation contains a pointer to the location in the new libraries. <em>NOTE: These libraries are scheduled for removal in GHC 6.6.</em> See also: [http://www.haskell.org/ghc/docs/edison/index.html Edison] (part of hslibs/data).
 
: Download: | [http://www.haskell.org/ghc/docs/latest/hslibs.html.tar.gz HTML.tar.gz] | [http://www.haskell.org/ghc/docs/latest/hslibs.pdf PDF] | [http://www.haskell.org/ghc/docs/latest/hslibs.ps.gz A4 Postscript (gzipped)] |
 
 
; [http://www.haskell.org/ghc/docs/latest/html/building/index.html GHC Building Guide]: Information on how to build GHC from sources, access the CVS repository, and port GHC to a new platform.
 
: Download: | [http://www.haskell.org/ghc/docs/latest/building.html.tar.gz HTML.tar.gz] | [http://www.haskell.org/ghc/docs/latest/building.pdf PDF] | [http://www.haskell.org/ghc/docs/latest/building.ps.gz A4 Postscript (gzipped)] |
 
   
 
== Collaborative documentation ==
 
== Collaborative documentation ==
Line 29: Line 29:
 
Please help by adding new sections, and by clarifying and improving existing ones.
 
Please help by adding new sections, and by clarifying and improving existing ones.
   
* [[/FAQ|GHC FAQ]]
+
* Using GHC
* The [[Performance|Haskell Performance Resource]], for advice on improving the performance of your code
+
** [[How_to_write_a_Haskell_program|How to write a Haskell program]]
* [[/As a library|Using GHC as a library]]
+
** [[/FAQ|GHC FAQ]]
* [[/Concurrency|Concurrent programming in GHC]]
+
** [[/Error messages|Error messages]]
* [[Template_Haskell|Template Haskell]] is a (GHC) extension to Haskell that adds compile-time metaprogramming facilities.
+
** [[Upgrading_packages|Guidelines for upgrading your GHC]]
* [http://www.cse.unsw.edu.au/~dons/hs-plugins Dynamically loaded Haskell modules]. <tt>hs-plugins</tt> is a Don Stewart's library for loading code written in Haskell into an application at runtime, in the form of plugins. It also provides a mechanism for (re-)compiling Haskell source at runtime. Thirdly, a combination of runtime compilation and dynamic loading provides a set of eval functions: a form of runtime metaprogramming. Values exported by Haskell plugins are transparently available to Haskell host applications, and bindings exist to use Haskell plugins from at least C and Objective C programs.
+
** [[/GHCi|Using GHCi]]
* [[/Using the FFI|Using the Foreign Function Interface]]
+
** [[/GHCi debugger| The GHCi debugger]]
* [[/GUI_Programming|GUI programming in GHC]]
+
** [[Cabal|Using Cabal]] (including with DLLs)
* [[/Using Rules|Using RULES in GHC]]
+
** The [[Performance|Haskell Performance Resource]], for advice on improving the performance of your code
  +
** [[Mutually recursive modules]]
  +
** [[/Memory_Management| Memory management and garbage collection]]
  +
** [[/Memory Footprint|Memory footprint on the heap of common data-structures]]
  +
  +
* Platform related matters
  +
** [[GHC under WINE|Running GHC under Wine]]
  +
** [[Mac OS X]]
  +
** [[Windows]]
  +
*** [http://haskell.forkio.com/dotnet Using GHC with .NET]
  +
*** [http://haskell.forkio.com/gmpwindows Dynamically linking GMP on Windows]
  +
  +
* GHC extensions
  +
** [[/Type system|Type system extensions in GHC]]
  +
** [[/As a library|Using GHC as a library]]
  +
** [[/Concurrency|Concurrent programming in GHC]]
  +
** [[Template Haskell]] is a (GHC) extension to Haskell that adds compile-time metaprogramming facilities.
  +
** [[Quasiquotation]] allows the ability for user-definable parsers to provide new concrete syntax for any datatype.
  +
** [http://www.cse.unsw.edu.au/~dons/hs-plugins Dynamically loaded Haskell modules]: Don Stewart's <tt>hs-plugins</tt> library
  +
** [[/Using the FFI|Using the Foreign Function Interface]]
  +
** [[/GUI programming|GUI programming in GHC]]
  +
** [[/Using rules|Using RULES in GHC]]
  +
** [[GHC/Data Parallel Haskell|Data Parallel Haskell: using nested data parallelism in GHC]]
  +
** [[Roles]] are GHC's way of discerning the difference between compile-time type equality (created by type synonyms and type families) and runtime type equality (created by newtypes).
  +
 
* [[Correctness of short cut fusion]]
 
* [[Correctness of short cut fusion]]
   
Line 43: Line 43:
   
 
See the [http://hackage.haskell.org/trac/ghc GHC Developer Wiki]. The latest snapshot of the documentation for the next version can be found [http://haskell.org/ghc/dist/current/docs/ here].
 
See the [http://hackage.haskell.org/trac/ghc GHC Developer Wiki]. The latest snapshot of the documentation for the next version can be found [http://haskell.org/ghc/dist/current/docs/ here].
  +
  +
* [[/SIMD|SIMD CPU operations]]
   
 
[[Category:Implementations]]
 
[[Category:Implementations]]
  +
[[Category:GHC]]

Latest revision as of 18:58, 8 April 2014

The Glasgow Haskell Compiler is a state-of-the-art, open source compiler and interactive environment for the functional language Haskell.

[edit] 1 Documentation

The documentation below relates to using GHC. For documentation about GHC's internals and building GHC, head over to the GHC Developer Wiki.

These documents relate to the latest released version of GHC. For earlier released versions click the relevant version on the downloads page. For the the current HEAD snapshot look at development snapshots.


The User's Guide
The User's Guide has all you need to know about using GHC: command line options, language extensions, GHCi, etc.
Download: | HTML.tar.bz2 | PDF | PS |
Standard Libraries
Documentation for the libraries that come with GHC.
Download: | HTML.tar.bz2
Cabal
An infrastructure for building and distributing Haskell software.

[edit] 2 Collaborative documentation

GHC is a big system. We try to document the core functionality (above), but you can help by writing documentation yourself. This section collects documentation written in a collaborative way, by users and developers together. Please help by adding new sections, and by clarifying and improving existing ones.

[edit] 3 Development of GHC

See the GHC Developer Wiki. The latest snapshot of the documentation for the next version can be found here.