packages feed

hark-0.2: html/Helpers-Common.html

<!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
>Helpers.Common</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_Helpers-Common.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"
></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"
>Helpers.Common</FONT
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
>this module contains some common function used by other modules
 that don't (yet) have their own category
</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"
><A HREF="#v%3AdefaultVersionToken"
>defaultVersionToken</A
> :: <A HREF="Helpers-Common.html#t%3AVersionToken"
>VersionToken</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Afind_package_paths"
>find_package_paths</A
> :: String -&gt; [FilePath] -&gt; IO [FilePath]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aget_categories"
>get_categories</A
> :: FilePath -&gt; IO [FilePath]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Ashow_version"
>show_version</A
> :: IO ()</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Astrip_category"
>strip_category</A
> :: String -&gt; [FilePath] -&gt; (String, [FilePath])</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Asplit_version_BS"
>split_version_BS</A
> :: ByteString -&gt; <A HREF="Helpers-Common.html#t%3AVersionToken"
>VersionToken</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AVersionToken"
>VersionToken</A
>  = <A HREF="#v%3AVersionToken"
>VersionToken</A
> {<TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="recfield"
><A HREF="#v%3AdName"
>dName</A
> :: ByteString</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AdVersion"
>dVersion</A
> :: ByteString</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AdSlot"
>dSlot</A
> :: ByteString</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AdUseDeps"
>dUseDeps</A
> :: ByteString</TD
></TR
></TABLE
>}</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Documentation</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:defaultVersionToken"
><A NAME="v%3AdefaultVersionToken"
></A
></A
><B
>defaultVersionToken</B
> :: <A HREF="Helpers-Common.html#t%3AVersionToken"
>VersionToken</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:find_package_paths"
><A NAME="v%3Afind_package_paths"
></A
></A
><B
>find_package_paths</B
> :: String -&gt; [FilePath] -&gt; IO [FilePath]</TD
></TR
><TR
><TD CLASS="doc"
>look for packages matching the searched for name in database
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:get_categories"
><A NAME="v%3Aget_categories"
></A
></A
><B
>get_categories</B
> :: FilePath -&gt; IO [FilePath]</TD
></TR
><TR
><TD CLASS="doc"
>filter all category directories from main database 
 directory
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:show_version"
><A NAME="v%3Ashow_version"
></A
></A
><B
>show_version</B
> :: IO ()</TD
></TR
><TR
><TD CLASS="doc"
>function printing out the current version information
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:strip_category"
><A NAME="v%3Astrip_category"
></A
></A
><B
>strip_category</B
> :: String -&gt; [FilePath] -&gt; (String, [FilePath])</TD
></TR
><TR
><TD CLASS="doc"
>given a pattern and a list of search paths, try to strip
 the category of the pattern. If one exists, restrict
 the search to the single path in the list of filepaths
 corresponding to the category.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:split_version_BS"
><A NAME="v%3Asplit_version_BS"
></A
></A
><B
>split_version_BS</B
> :: ByteString -&gt; <A HREF="Helpers-Common.html#t%3AVersionToken"
>VersionToken</A
></TD
></TR
><TR
><TD CLASS="doc"
>splits off the version string from the package name 
 via regular expression
 NOTE: This is a specialized version for ByteString
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:VersionToken"
><A NAME="t%3AVersionToken"
></A
></A
><B
>VersionToken</B
>  </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>data structure holding the pieces of an EAPI
 version string, i.e. name-version:slot[useDep]
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="5" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:VersionToken"
><A NAME="v%3AVersionToken"
></A
></A
><B
>VersionToken</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="body" COLSPAN="2"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:dName"
><A NAME="v%3AdName"
></A
></A
><B
>dName</B
> :: ByteString</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:dVersion"
><A NAME="v%3AdVersion"
></A
></A
><B
>dVersion</B
> :: ByteString</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:dSlot"
><A NAME="v%3AdSlot"
></A
></A
><B
>dSlot</B
> :: ByteString</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:dUseDeps"
><A NAME="v%3AdUseDeps"
></A
></A
><B
>dUseDeps</B
> :: ByteString</TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></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
>