<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Distribution.Simple.PackageIndex</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
><SCRIPT TYPE="text/javascript"
>window.onload = function () {setSynopsis("mini_Distribution-Simple-PackageIndex.html")};</SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>Cabal-1.6.0.3: A framework for packaging Haskell software</TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Distribution.Simple.PackageIndex</FONT
></TD
><TD ALIGN="right"
><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="infohead"
>Portability</TD
><TD CLASS="infoval"
>portable</TD
></TR
><TR
><TD CLASS="infohead"
>Maintainer</TD
><TD CLASS="infoval"
>cabal-devel@haskell.org</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="section4"
><B
>Contents</B
></TD
></TR
><TR
><TD
><DL
><DT
><A HREF="#1"
>Package index data type
</A
></DT
><DT
><A HREF="#2"
>Creating an index
</A
></DT
><DT
><A HREF="#3"
>Updates
</A
></DT
><DT
><A HREF="#4"
>Queries
</A
></DT
><DD
><DL
><DT
><A HREF="#5"
>Precise lookups
</A
></DT
><DT
><A HREF="#6"
>Case-insensitive searches
</A
></DT
><DT
><A HREF="#7"
>Bulk queries
</A
></DT
><DT
><A HREF="#8"
>Special queries
</A
></DT
></DL
></DD
></DL
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
>An index of packages.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
> <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="#t%3APackageIndex"
>PackageIndex</A
> pkg</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfromList"
>fromList</A
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => [pkg] -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Amerge"
>merge</A
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Ainsert"
>insert</A
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => pkg -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AdeletePackageName"
>deletePackageName</A
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Package.html#t%3APackageName"
>PackageName</A
> -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AdeletePackageId"
>deletePackageId</A
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Package.html#t%3APackageIdentifier"
>PackageIdentifier</A
> -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AdeleteDependency"
>deleteDependency</A
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Package.html#t%3ADependency"
>Dependency</A
> -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AlookupPackageName"
>lookupPackageName</A
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="Distribution-Package.html#t%3APackageName"
>PackageName</A
> -> [pkg]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AlookupPackageId"
>lookupPackageId</A
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="Distribution-Package.html#t%3APackageIdentifier"
>PackageIdentifier</A
> -> <A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> pkg</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AlookupDependency"
>lookupDependency</A
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="Distribution-Package.html#t%3ADependency"
>Dependency</A
> -> [pkg]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsearchByName"
>searchByName</A
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="../base/Data-Char.html#t%3AString"
>String</A
> -> <A HREF="Distribution-Simple-PackageIndex.html#t%3ASearchResult"
>SearchResult</A
> [pkg]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
> <A HREF="#t%3ASearchResult"
>SearchResult</A
> a </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
>= <A HREF="#v%3ANone"
>None</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AUnambiguous"
>Unambiguous</A
> a</TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AAmbiguous"
>Ambiguous</A
> [a]</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsearchByNameSubstring"
>searchByNameSubstring</A
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="../base/Data-Char.html#t%3AString"
>String</A
> -> [pkg]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AallPackages"
>allPackages</A
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> [pkg]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AallPackagesByName"
>allPackagesByName</A
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> [[pkg]]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AbrokenPackages"
>brokenPackages</A
> :: <A HREF="Distribution-Package.html#t%3APackageFixedDeps"
>PackageFixedDeps</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> [(pkg, [<A HREF="Distribution-Package.html#t%3APackageIdentifier"
>PackageIdentifier</A
>])]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AdependencyClosure"
>dependencyClosure</A
> :: <A HREF="Distribution-Package.html#t%3APackageFixedDeps"
>PackageFixedDeps</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> [<A HREF="Distribution-Package.html#t%3APackageIdentifier"
>PackageIdentifier</A
>] -> <A HREF="../base/Data-Either.html#t%3AEither"
>Either</A
> (<A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg) [(pkg, [<A HREF="Distribution-Package.html#t%3APackageIdentifier"
>PackageIdentifier</A
>])]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AreverseDependencyClosure"
>reverseDependencyClosure</A
> :: <A HREF="Distribution-Package.html#t%3APackageFixedDeps"
>PackageFixedDeps</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> [<A HREF="Distribution-Package.html#t%3APackageIdentifier"
>PackageIdentifier</A
>] -> [pkg]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AtopologicalOrder"
>topologicalOrder</A
> :: <A HREF="Distribution-Package.html#t%3APackageFixedDeps"
>PackageFixedDeps</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> [pkg]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AreverseTopologicalOrder"
>reverseTopologicalOrder</A
> :: <A HREF="Distribution-Package.html#t%3APackageFixedDeps"
>PackageFixedDeps</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> [pkg]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AdependencyInconsistencies"
>dependencyInconsistencies</A
> :: <A HREF="Distribution-Package.html#t%3APackageFixedDeps"
>PackageFixedDeps</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> [(<A HREF="Distribution-Package.html#t%3APackageName"
>PackageName</A
>, [(<A HREF="Distribution-Package.html#t%3APackageIdentifier"
>PackageIdentifier</A
>, <A HREF="../base/Data-Version.html#t%3AVersion"
>Version</A
>)])]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AdependencyCycles"
>dependencyCycles</A
> :: <A HREF="Distribution-Package.html#t%3APackageFixedDeps"
>PackageFixedDeps</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> [[pkg]]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AdependencyGraph"
>dependencyGraph</A
> :: <A HREF="Distribution-Package.html#t%3APackageFixedDeps"
>PackageFixedDeps</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> (<A HREF="../containers/Data-Graph.html#t%3AGraph"
>Graph</A
>, <A HREF="../containers/Data-Graph.html#t%3AVertex"
>Vertex</A
> -> pkg, <A HREF="Distribution-Package.html#t%3APackageIdentifier"
>PackageIdentifier</A
> -> <A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="../containers/Data-Graph.html#t%3AVertex"
>Vertex</A
>)</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="1"
><A NAME="1"
>Package index data type
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
> <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A NAME="t:PackageIndex"
><A NAME="t%3APackageIndex"
></A
></A
><B
>PackageIndex</B
> pkg </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
><P
>The collection of information about packages from one or more PackageDBs.
</P
><P
>It can be searched effeciently by package name and version.
</P
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:PackageIndex')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:PackageIndex" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
>(<A HREF="../base/Text-Read.html#t%3ARead"
>Read</A
> pkg, <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg) => <A HREF="../base/Text-Read.html#t%3ARead"
>Read</A
> (<A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg)</TD
></TR
><TR
><TD CLASS="decl"
>(<A HREF="../base/Text-Show.html#t%3AShow"
>Show</A
> pkg, <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg) => <A HREF="../base/Text-Show.html#t%3AShow"
>Show</A
> (<A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg)</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="../base/Data-Monoid.html#t%3AMonoid"
>Monoid</A
> (<A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg)</TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="2"
><A NAME="2"
>Creating an index
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:fromList"
><A NAME="v%3AfromList"
></A
></A
><B
>fromList</B
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => [pkg] -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg</TD
></TR
><TR
><TD CLASS="doc"
><P
>Build an index out of a bunch of packages.
</P
><P
>If there are duplicates, later ones mask earlier ones.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="3"
><A NAME="3"
>Updates
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:merge"
><A NAME="v%3Amerge"
></A
></A
><B
>merge</B
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg</TD
></TR
><TR
><TD CLASS="doc"
><P
>Merge two indexes.
</P
><P
>Packages from the second mask packages of the same exact name
(case-sensitively) from the first.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:insert"
><A NAME="v%3Ainsert"
></A
></A
><B
>insert</B
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => pkg -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg</TD
></TR
><TR
><TD CLASS="doc"
><P
>Inserts a single package into the index.
</P
><P
>This is equivalent to (but slightly quicker than) using <TT
><A HREF="../base/Data-Monoid.html#v%3Amappend"
>mappend</A
></TT
> or
<TT
><A HREF="Distribution-Simple-PackageIndex.html#v%3Amerge"
>merge</A
></TT
> with a singleton index.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:deletePackageName"
><A NAME="v%3AdeletePackageName"
></A
></A
><B
>deletePackageName</B
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Package.html#t%3APackageName"
>PackageName</A
> -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg</TD
></TR
><TR
><TD CLASS="doc"
>Removes all packages with this (case-sensitive) name from the index.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:deletePackageId"
><A NAME="v%3AdeletePackageId"
></A
></A
><B
>deletePackageId</B
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Package.html#t%3APackageIdentifier"
>PackageIdentifier</A
> -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg</TD
></TR
><TR
><TD CLASS="doc"
>Removes a single package from the index.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:deleteDependency"
><A NAME="v%3AdeleteDependency"
></A
></A
><B
>deleteDependency</B
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Package.html#t%3ADependency"
>Dependency</A
> -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg</TD
></TR
><TR
><TD CLASS="doc"
>Removes all packages satisfying this dependency from the index.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="4"
><A NAME="4"
>Queries
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="5"
><A NAME="5"
>Precise lookups
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:lookupPackageName"
><A NAME="v%3AlookupPackageName"
></A
></A
><B
>lookupPackageName</B
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="Distribution-Package.html#t%3APackageName"
>PackageName</A
> -> [pkg]</TD
></TR
><TR
><TD CLASS="doc"
>Does a case-sensitive search by package name.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:lookupPackageId"
><A NAME="v%3AlookupPackageId"
></A
></A
><B
>lookupPackageId</B
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="Distribution-Package.html#t%3APackageIdentifier"
>PackageIdentifier</A
> -> <A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> pkg</TD
></TR
><TR
><TD CLASS="doc"
><P
>Does a lookup by package id (name & version).
</P
><P
>Since multiple package DBs mask each other case-sensitively by package name,
then we get back at most one package.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:lookupDependency"
><A NAME="v%3AlookupDependency"
></A
></A
><B
>lookupDependency</B
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="Distribution-Package.html#t%3ADependency"
>Dependency</A
> -> [pkg]</TD
></TR
><TR
><TD CLASS="doc"
><P
>Does a case-sensitive search by package name and a range of versions.
</P
><P
>We get back any number of versions of the specified package name, all
satisfying the version range constraint.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="6"
><A NAME="6"
>Case-insensitive searches
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:searchByName"
><A NAME="v%3AsearchByName"
></A
></A
><B
>searchByName</B
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="../base/Data-Char.html#t%3AString"
>String</A
> -> <A HREF="Distribution-Simple-PackageIndex.html#t%3ASearchResult"
>SearchResult</A
> [pkg]</TD
></TR
><TR
><TD CLASS="doc"
><P
>Does a case-insensitive search by package name.
</P
><P
>If there is only one package that compares case-insentiviely to this name
then the search is unambiguous and we get back all versions of that package.
If several match case-insentiviely but one matches exactly then it is also
unambiguous.
</P
><P
>If however several match case-insentiviely and none match exactly then we
have an ambiguous result, and we get back all the versions of all the
packages. The list of ambiguous results is split by exact package name. So
it is a non-empty list of non-empty lists.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
> <A NAME="t:SearchResult"
><A NAME="t%3ASearchResult"
></A
></A
><B
>SearchResult</B
> a </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:None"
><A NAME="v%3ANone"
></A
></A
><B
>None</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:Unambiguous"
><A NAME="v%3AUnambiguous"
></A
></A
><B
>Unambiguous</B
> a</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:Ambiguous"
><A NAME="v%3AAmbiguous"
></A
></A
><B
>Ambiguous</B
> [a]</TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:searchByNameSubstring"
><A NAME="v%3AsearchByNameSubstring"
></A
></A
><B
>searchByNameSubstring</B
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> <A HREF="../base/Data-Char.html#t%3AString"
>String</A
> -> [pkg]</TD
></TR
><TR
><TD CLASS="doc"
><P
>Does a case-insensitive substring search by package name.
</P
><P
>That is, all packages that contain the given string in their name.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="7"
><A NAME="7"
>Bulk queries
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:allPackages"
><A NAME="v%3AallPackages"
></A
></A
><B
>allPackages</B
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> [pkg]</TD
></TR
><TR
><TD CLASS="doc"
>Get all the packages from the index.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:allPackagesByName"
><A NAME="v%3AallPackagesByName"
></A
></A
><B
>allPackagesByName</B
> :: <A HREF="Distribution-Package.html#t%3APackage"
>Package</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> [[pkg]]</TD
></TR
><TR
><TD CLASS="doc"
><P
>Get all the packages from the index.
</P
><P
>They are grouped by package name, case-sensitively.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="8"
><A NAME="8"
>Special queries
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:brokenPackages"
><A NAME="v%3AbrokenPackages"
></A
></A
><B
>brokenPackages</B
> :: <A HREF="Distribution-Package.html#t%3APackageFixedDeps"
>PackageFixedDeps</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> [(pkg, [<A HREF="Distribution-Package.html#t%3APackageIdentifier"
>PackageIdentifier</A
>])]</TD
></TR
><TR
><TD CLASS="doc"
><P
>All packages that have dependencies that are not in the index.
</P
><P
>Returns such packages along with the dependencies that they're missing.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:dependencyClosure"
><A NAME="v%3AdependencyClosure"
></A
></A
><B
>dependencyClosure</B
> :: <A HREF="Distribution-Package.html#t%3APackageFixedDeps"
>PackageFixedDeps</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> [<A HREF="Distribution-Package.html#t%3APackageIdentifier"
>PackageIdentifier</A
>] -> <A HREF="../base/Data-Either.html#t%3AEither"
>Either</A
> (<A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg) [(pkg, [<A HREF="Distribution-Package.html#t%3APackageIdentifier"
>PackageIdentifier</A
>])]</TD
></TR
><TR
><TD CLASS="doc"
><P
>Tries to take the transative closure of the package dependencies.
</P
><P
>If the transative closure is complete then it returns that subset of the
index. Otherwise it returns the broken packages as in <TT
><A HREF="Distribution-Simple-PackageIndex.html#v%3AbrokenPackages"
>brokenPackages</A
></TT
>.
</P
><UL
><LI
> Note that if the result is <TT
>Right []</TT
> it is because at least one of
the original given <TT
><A HREF="Distribution-Package.html#t%3APackageIdentifier"
>PackageIdentifier</A
></TT
>s do not occur in the index.
</LI
></UL
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:reverseDependencyClosure"
><A NAME="v%3AreverseDependencyClosure"
></A
></A
><B
>reverseDependencyClosure</B
> :: <A HREF="Distribution-Package.html#t%3APackageFixedDeps"
>PackageFixedDeps</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> [<A HREF="Distribution-Package.html#t%3APackageIdentifier"
>PackageIdentifier</A
>] -> [pkg]</TD
></TR
><TR
><TD CLASS="doc"
><P
>Takes the transative closure of the packages reverse dependencies.
</P
><UL
><LI
> The given <TT
><A HREF="Distribution-Package.html#t%3APackageIdentifier"
>PackageIdentifier</A
></TT
>s must be in the index.
</LI
></UL
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:topologicalOrder"
><A NAME="v%3AtopologicalOrder"
></A
></A
><B
>topologicalOrder</B
> :: <A HREF="Distribution-Package.html#t%3APackageFixedDeps"
>PackageFixedDeps</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> [pkg]</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:reverseTopologicalOrder"
><A NAME="v%3AreverseTopologicalOrder"
></A
></A
><B
>reverseTopologicalOrder</B
> :: <A HREF="Distribution-Package.html#t%3APackageFixedDeps"
>PackageFixedDeps</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> [pkg]</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:dependencyInconsistencies"
><A NAME="v%3AdependencyInconsistencies"
></A
></A
><B
>dependencyInconsistencies</B
> :: <A HREF="Distribution-Package.html#t%3APackageFixedDeps"
>PackageFixedDeps</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> [(<A HREF="Distribution-Package.html#t%3APackageName"
>PackageName</A
>, [(<A HREF="Distribution-Package.html#t%3APackageIdentifier"
>PackageIdentifier</A
>, <A HREF="../base/Data-Version.html#t%3AVersion"
>Version</A
>)])]</TD
></TR
><TR
><TD CLASS="doc"
><P
>Given a package index where we assume we want to use all the packages
(use <TT
><A HREF="Distribution-Simple-PackageIndex.html#v%3AdependencyClosure"
>dependencyClosure</A
></TT
> if you need to get such a index subset) find out
if the dependencies within it use consistent versions of each package.
Return all cases where multiple packages depend on different versions of
some other package.
</P
><P
>Each element in the result is a package name along with the packages that
depend on it and the versions they require. These are guaranteed to be
distinct.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:dependencyCycles"
><A NAME="v%3AdependencyCycles"
></A
></A
><B
>dependencyCycles</B
> :: <A HREF="Distribution-Package.html#t%3APackageFixedDeps"
>PackageFixedDeps</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> [[pkg]]</TD
></TR
><TR
><TD CLASS="doc"
><P
>Find if there are any cycles in the dependency graph. If there are no
cycles the result is <TT
>[]</TT
>.
</P
><P
>This actually computes the strongly connected components. So it gives us a
list of groups of packages where within each group they all depend on each
other, directly or indirectly.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:dependencyGraph"
><A NAME="v%3AdependencyGraph"
></A
></A
><B
>dependencyGraph</B
> :: <A HREF="Distribution-Package.html#t%3APackageFixedDeps"
>PackageFixedDeps</A
> pkg => <A HREF="Distribution-Simple-PackageIndex.html#t%3APackageIndex"
>PackageIndex</A
> pkg -> (<A HREF="../containers/Data-Graph.html#t%3AGraph"
>Graph</A
>, <A HREF="../containers/Data-Graph.html#t%3AVertex"
>Vertex</A
> -> pkg, <A HREF="Distribution-Package.html#t%3APackageIdentifier"
>PackageIdentifier</A
> -> <A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="../containers/Data-Graph.html#t%3AVertex"
>Vertex</A
>)</TD
></TR
><TR
><TD CLASS="doc"
><P
>Builds a graph of the package dependencies.
</P
><P
>Dependencies on other packages that are not in the index are discarded.
You can check if there are any such dependencies with <TT
><A HREF="Distribution-Simple-PackageIndex.html#v%3AbrokenPackages"
>brokenPackages</A
></TT
>.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.4.2</TD
></TR
></TABLE
></BODY
></HTML
>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
70ec89744a04da80369b4702b2c37256
>
files
>
39
