<!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 >Data.CaseInsensitive</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_Data-CaseInsensitive.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" >case-insensitive-0.2.0.2: Case insensitive string comparison</TD ><TD CLASS="topbut" ><A HREF="src/Data-CaseInsensitive.html" >Source code</A ></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" >Data.CaseInsensitive</FONT ></TD ><TD ALIGN="right" ><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="infohead" >Maintainer</TD ><TD CLASS="infoval" >Bas van Dijk <v.dijk.bas@gmail.com></TD ></TR ></TABLE ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" >Description</TD ></TR ><TR ><TD CLASS="doc" ><P >This module is intended to be imported qualified. May I suggest: </P ><PRE > import Data.CaseInsensitive ( CI ) import qualified Data.CaseInsensitive as CI </PRE ></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="#t%3ACI" >CI</A > s</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3Amk" >mk</A > :: <A HREF="Data-CaseInsensitive.html#t%3AFoldCase" >FoldCase</A > s => s -> <A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A > s</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3Aoriginal" >original</A > :: <A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A > s -> s</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AfoldedCase" >foldedCase</A > :: <A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A > s -> s</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3Amap" >map</A > :: <A HREF="Data-CaseInsensitive.html#t%3AFoldCase" >FoldCase</A > s2 => (s1 -> s2) -> <A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A > s1 -> <A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A > s2</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><SPAN CLASS="keyword" >class</SPAN > <A HREF="#t%3AFoldCase" >FoldCase</A > s <SPAN CLASS="keyword" >where</SPAN ></TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="decl" ><A HREF="#v%3AfoldCase" >foldCase</A > :: s -> s</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="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><SPAN CLASS="keyword" >data</SPAN > <A NAME="t:CI" ><A NAME="t%3ACI" ></A ></A ><B >CI</B > s </TD ><TD CLASS="declbut" ><A HREF="src/Data-CaseInsensitive.html#CI" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="ndoc" ><P >A <TT >CI s</TT > provides <EM >C</EM >ase <EM >I</EM >nsensitive comparison for the string-like type <TT >s</TT > (for example: <TT ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A ></TT >, <TT ><A HREF="/usr/share/doc/ghc/html/libraries/text-0.10.0.0/Data-Text.html#t%3AText" >Text</A ></TT >, <TT ><A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString.html#t%3AByteString" >ByteString</A ></TT >, <TT ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Text-Show.html#t%3AShowS" >ShowS</A ></TT >, etc.). </P ><P >Note that <TT >CI s</TT > has an instance for <TT ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-String.html#t%3AIsString" >IsString</A ></TT > which together with the <TT >OverloadedStrings</TT > language extension allows you to write case insensitive string literals as in: </P ><PRE > > ("Content-Type" :: <TT ><A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A ></TT > <TT ><A HREF="/usr/share/doc/ghc/html/libraries/text-0.10.0.0/Data-Text.html#t%3AText" >Text</A ></TT >) == ("CONTENT-TYPE" :: <TT ><A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A ></TT > <TT ><A HREF="/usr/share/doc/ghc/html/libraries/text-0.10.0.0/Data-Text.html#t%3AText" >Text</A ></TT >) True </PRE ></TD ></TR ><TR ><TD CLASS="section4" ><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:CI')" ALT="show/hide" > Instances</TD ></TR ><TR ><TD CLASS="body" ><DIV ID="i:CI" STYLE="display:block;" ><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0" ><TR ><TD CLASS="decl" ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Typeable.html#t%3ATypeable1" >Typeable1</A > <A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Eq.html#t%3AEq" >Eq</A > s => <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Eq.html#t%3AEq" >Eq</A > (<A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A > s)</TD ></TR ><TR ><TD CLASS="decl" ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Ord.html#t%3AOrd" >Ord</A > s => <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Ord.html#t%3AOrd" >Ord</A > (<A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A > s)</TD ></TR ><TR ><TD CLASS="decl" >(<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Text-Read.html#t%3ARead" >Read</A > s, <A HREF="Data-CaseInsensitive.html#t%3AFoldCase" >FoldCase</A > s) => <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Text-Read.html#t%3ARead" >Read</A > (<A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A > s)</TD ></TR ><TR ><TD CLASS="decl" ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Text-Show.html#t%3AShow" >Show</A > s => <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Text-Show.html#t%3AShow" >Show</A > (<A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A > s)</TD ></TR ><TR ><TD CLASS="decl" >(<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-String.html#t%3AIsString" >IsString</A > s, <A HREF="Data-CaseInsensitive.html#t%3AFoldCase" >FoldCase</A > s) => <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-String.html#t%3AIsString" >IsString</A > (<A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A > s)</TD ></TR ><TR ><TD CLASS="decl" ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Monoid.html#t%3AMonoid" >Monoid</A > s => <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Monoid.html#t%3AMonoid" >Monoid</A > (<A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A > s)</TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-CaseInsensitive.html#t%3AFoldCase" >FoldCase</A > (<A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A > s)</TD ></TR ></TABLE ></DIV ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><A NAME="v:mk" ><A NAME="v%3Amk" ></A ></A ><B >mk</B > :: <A HREF="Data-CaseInsensitive.html#t%3AFoldCase" >FoldCase</A > s => s -> <A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A > s</TD ><TD CLASS="declbut" ><A HREF="src/Data-CaseInsensitive.html#mk" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="doc" >Make the given string-like value case insensitive. </TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><A NAME="v:original" ><A NAME="v%3Aoriginal" ></A ></A ><B >original</B > :: <A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A > s -> s</TD ><TD CLASS="declbut" ><A HREF="src/Data-CaseInsensitive.html#original" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="doc" >Retrieve the original string-like value. </TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><A NAME="v:foldedCase" ><A NAME="v%3AfoldedCase" ></A ></A ><B >foldedCase</B > :: <A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A > s -> s</TD ><TD CLASS="declbut" ><A HREF="src/Data-CaseInsensitive.html#foldedCase" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="doc" >Retrieve the case folded string-like value. (Also see <TT ><A HREF="Data-CaseInsensitive.html#v%3AfoldCase" >foldCase</A ></TT >). </TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><A NAME="v:map" ><A NAME="v%3Amap" ></A ></A ><B >map</B > :: <A HREF="Data-CaseInsensitive.html#t%3AFoldCase" >FoldCase</A > s2 => (s1 -> s2) -> <A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A > s1 -> <A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A > s2</TD ><TD CLASS="declbut" ><A HREF="src/Data-CaseInsensitive.html#map" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="doc" >Transform the original string-like value but keep it case insensitive. </TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><SPAN CLASS="keyword" >class</SPAN > <A NAME="t:FoldCase" ><A NAME="t%3AFoldCase" ></A ></A ><B >FoldCase</B > s <SPAN CLASS="keyword" >where</SPAN ></TD ><TD CLASS="declbut" ><A HREF="src/Data-CaseInsensitive.html#FoldCase" >Source</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="ndoc" ><P >Class of string-like types that support folding cases. </P ><P >Note that the instances for <TT ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AChar" >Char</A ></TT >, <TT ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A ></TT >, <TT ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Text-Show.html#t%3AShowS" >ShowS</A ></TT > and the <TT ><A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString.html#t%3AByteString" >ByteString</A ></TT > types do <EM >not</EM > perform fully correct Unicode-aware case folding, they simply <TT ><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#v%3AtoLower" >toLower</A ></TT > their characters! This is of course more than suitable for ASCII encoded strings. </P ><P >The instances for the <TT ><A HREF="/usr/share/doc/ghc/html/libraries/text-0.10.0.0/Data-Text.html#t%3AText" >Text</A ></TT > types use <TT ><A HREF="/usr/share/doc/ghc/html/libraries/text-0.10.0.0/Data-Text.html#v%3AtoCaseFold" >toCaseFold</A ></TT > which performs a better Unicode-aware case fold which is more suitable for case insensitive string comparisons. </P ></TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="section4" >Methods</TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="topdecl" ><TABLE CLASS="declbar" ><TR ><TD CLASS="declname" ><A NAME="v:foldCase" ><A NAME="v%3AfoldCase" ></A ></A ><B >foldCase</B > :: s -> s</TD ><TD CLASS="declbut" ><A HREF="src/Data-CaseInsensitive.html#foldCase" >Source</A ></TD ></TR ></TABLE ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="section4" ><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:FoldCase')" ALT="show/hide" > Instances</TD ></TR ><TR ><TD CLASS="body" ><DIV ID="i:FoldCase" STYLE="display:block;" ><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0" ><TR ><TD CLASS="decl" ><A HREF="Data-CaseInsensitive.html#t%3AFoldCase" >FoldCase</A > <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AChar" >Char</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-CaseInsensitive.html#t%3AFoldCase" >FoldCase</A > <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString" >String</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-CaseInsensitive.html#t%3AFoldCase" >FoldCase</A > <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Text-Show.html#t%3AShowS" >ShowS</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-CaseInsensitive.html#t%3AFoldCase" >FoldCase</A > <A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString-Lazy.html#t%3AByteString" >ByteString</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-CaseInsensitive.html#t%3AFoldCase" >FoldCase</A > <A HREF="/usr/share/doc/ghc/html/libraries/bytestring-0.9.1.7/Data-ByteString.html#t%3AByteString" >ByteString</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-CaseInsensitive.html#t%3AFoldCase" >FoldCase</A > <A HREF="/usr/share/doc/ghc/html/libraries/text-0.10.0.0/Data-Text-Lazy.html#t%3AText" >Text</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-CaseInsensitive.html#t%3AFoldCase" >FoldCase</A > <A HREF="/usr/share/doc/ghc/html/libraries/text-0.10.0.0/Data-Text.html#t%3AText" >Text</A ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="Data-CaseInsensitive.html#t%3AFoldCase" >FoldCase</A > (<A HREF="Data-CaseInsensitive.html#t%3ACI" >CI</A > s)</TD ></TR ></TABLE ></DIV ></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.6.1</TD ></TR ></TABLE ></BODY ></HTML >