What is HaXml?|
How do I use it?
Note! The new stable version (1.20 onwards) significantly changes the API of some modules over the previous stable version (1.13). (If you have already been using the development versions (1.14-1.19.x), then you are probably OK.)
Notes for migrating code from the old 2006 stable (1.13) version of HaXml to the 2009 stable (1.20) version.
HaXml is a collection of many utilities for parsing, filtering, transforming, and generating XML documents using Haskell. In summary, its facilities include:
For high-level processing of XML documents, the following components are provided:
Detailed documentation of the HaXml APIs is generated automatically by Haddock directly from the source code.
An introduction to HaXml for people who know more about XML than about Haskell can be found at IBM DeveloperWorks. Please note that the DeveloperWorks article was based on an older version of HaXml. If you try to use the examples given there, you will need a couple of minor but important edits, given as a diff patch here.
A paper describing and comparing the generic Combinators with the typed representation (DtdToHaskell/XmlContent) is available here: (12 pages of double-column A4)
Some additional info about using the various facilities is here:
HaXml-1.24.1, release date 2014.03.18
By HTTP: .tar.gz.
The development version of HaXml is also available through
darcs get http://code.haskell.org/HaXml
To install HaXml, you must have a Haskell compiler: ghc-6.2 or later, and/or nhc98-1.16/hmake-3.06 or later, and/or Hugs98 (Sept 2003) or later. You must also first download and install the polyparse package as a pre-requisite.
Then, for more recent compilers, use the standard Cabal method of installation:
cabal update cabal install HaXml-1.24or
runhaskell Setup.hs configure [--prefix=...] [--buildwith=...] runhaskell Setup.hs build runhaskell Setup.hs installFor older compilers, use:
./configure [--prefix=...] [--buildwith=...] make make installto configure, build, and install HaXml as a package for your compiler(s). You need write permission on the library installation directories of your compiler(s). Afterwards, to gain access to the HaXml libraries, you only need to add the option -package HaXml to your compiler commandline (no option required for Hugs). Various stand-alone tools are also built - DtdToHaskell, XsdToHaskell, Xtract, Validate, MkOneOf - and copied to the final installation location specified by the --prefix=... option to configure.
To build/install on a Windows system without the Cygwin shell and utilities, you can avoid the configure/make steps by simply using the minimal Build.bat script. Edit it first for the location of your compiler etc.
Version 1.24.1 changes the cpp for transmitting version numbers into src.
Version 1.24 bumps the dependency on polyparse to 1.9 or later, and adds some better handling of incorrectly unescaped ampersand characters.
Version 1.23.3 fixes another haddock documentation bug.
Version 1.23.2 fixes a haddock documentation bug.
Version 1.23.1 fixes a packaging bug Version 1.23 improves the XSD to Haskell translation, focussed mainly on FpML as the driving application.
Version 1.22.3 fixes another haddock documentation bug.
Version 1.22.2 fixes a haddock documentation bug.
Version 1.22.1 fixes a packaging bug.
Version 1.22 is compatible with ghc-7 and improves the new XsdToHaskell tool.
Version 1.21 adds better support for XML namespaces,
and introduces the new XsdToHaskell tool.
Version 1.20.2 adds --version and --help arguments to all executables.
Version 1.20.1 fixes a small bug in DtdToHaskell.
Version 1.20 is the new stable version.
Version 1.19.7 requires package polyparse-1.2 (previous versions require
Version 1.19.6 has some bugfixes to XmlContent, to ensure that types created via DtdToHaskell get converted back to XML correctly.
Version 1.19.5 has some bugfixes to DtdToHaskell, to cope with especially large datatypes.
Version 1.19.4 has some minor bugfixes to increase compatibility with the ByteString package.
Version 1.19.2 updates the Cabal file to enable HaXml to build with both ghc-6.6.x and ghc-6.8.x.
Version 1.19.1 fixes a build error in 1.19.
Version 1.19 improved the lazy XML parsing, and fixed some space leaks in the XtractLazy tool.
Version 1.18 pulled out the parser combinator libraries as a separate package (called polyparse), which must now be downloaded and installed before installing HaXml.
Version 1.17 essentially just fixes compatibility with ghc-6.6. However, it also include a lazier pretty-printer to use in conjunction with the lazy parser, to save running out of memory on large datasets.
Version 1.16 adds laziness to the parser combinator libraries, such that they can start to return partial results before a whole entity has been parsed. Partial is also used in the sense that the returned value can contain bottom - an error which gets thrown as an exception when you try to explore the inner regions of the value. In terms of XML, it means you get an element back as soon as its start-tag has been consumed, but if there are parse errors later on, BOOM. However, if there are no errors, it does mean that your processing will be (a) faster and (b) less memory hungry. Another cool thing is that, even in the presence of errors, you still might get enough output to satisfy your processing task before the error is noticed.
Use Text.XML.HaXml.ParseLazy and Text.XML.HaXml.Html.ParseLazy to try it out. There are also lazy versions of the supplied demo programs: CanonicaliseLazy and XtractLazy.
Version 1.15 is essentially 1.14 with some bugfixes, and some new functionality, especially in the parser combinator libraries. DrIFT now supports deriving the XmlContent class, and DtdToHaskell now also derives the XmlContent class, in addition to determining a collection of Haskell datatypes equivalent to a given DTD.
Error messages from parsing are much improved in 1.15 - they should locate any error far more specifically and accurately. Let me know about examples which do not report correctly.
Prior to 1.14, there were two separate classes, Xml2Haskell and Haskell2Xml. They are now combined into the single class XmlContent. Make sure you get a recent version of DrIFT if you want to derive this class from Haskell datatypes - the included version of DtdToHaskell has not yet been updated for deriving the class the other way, from an XML DTD.
Version 1.14 also contains a new SAX-like stream parser.
A while back, Graham Klyne extended the 1.12 version of HaXml significantly, in particular to ensure that the parser passes a large XML acceptance test suite, and to deal more correctly with Unicode, namespaces, and parameter entity expansion. His modifications will eventually be merged back in to the main CVS tree, but in the meantime, you can get his version here: http://www.ninebynine.org/Software/HaskellUtils/
The previous stable version (1.13) had the following features and fixes:
We are interested in hearing your feedback on these XML facilities - suggestions for improvements, comments, criticisms, bug reports. Please mail
Development of these XML libraries was originally funded by Canon Research Europe Ltd, in 1998-1999. Subsequent maintenance and development has been indirectly supported by the EPSRC, the University of York, QinetiQ, BAE Systems, and Standard Chartered Bank.
Licence: The library is Free and Open Source Software, i.e., the bits we wrote are copyright to us, but freely licensed for your use, modification, and re-distribution, provided you don't restrict anyone else's use of it. The HaXml library is distributed under the GNU Lesser General Public Licence (LGPL) - see file LICENCE-LGPL for more details. We allow one special exception to the LGPL - see COPYRIGHT. The HaXml tools are distributed under the GNU General Public Licence (GPL) - see LICENCE-GPL. (If you don't like any of these licensing conditions, please contact us to discuss your requirements.)