<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>src/Data/Bits/Utils.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{- arch-tag: Bit utilities main file
<a name="line-2"></a>Copyright (C) 2004-2005 John Goerzen <jgoerzen@complete.org>
<a name="line-3"></a>
<a name="line-4"></a>This program is free software; you can redistribute it and/or modify
<a name="line-5"></a>it under the terms of the GNU General Public License as published by
<a name="line-6"></a>the Free Software Foundation; either version 2 of the License, or
<a name="line-7"></a>(at your option) any later version.
<a name="line-8"></a>
<a name="line-9"></a>This program is distributed in the hope that it will be useful,
<a name="line-10"></a>but WITHOUT ANY WARRANTY; without even the implied warranty of
<a name="line-11"></a>MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
<a name="line-12"></a>GNU General Public License for more details.
<a name="line-13"></a>
<a name="line-14"></a>You should have received a copy of the GNU General Public License
<a name="line-15"></a>along with this program; if not, write to the Free Software
<a name="line-16"></a>Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<a name="line-17"></a>-}</span>
<a name="line-18"></a>
<a name="line-19"></a><span class='hs-comment'>{- |
<a name="line-20"></a> Module : Data.Bits.Utils
<a name="line-21"></a> Copyright : Copyright (C) 2004-2005 John Goerzen
<a name="line-22"></a> License : GNU GPL, version 2 or above
<a name="line-23"></a>
<a name="line-24"></a> Maintainer : John Goerzen <jgoerzen@complete.org>
<a name="line-25"></a> Stability : provisional
<a name="line-26"></a> Portability: portable to platforms with rawSystem
<a name="line-27"></a>
<a name="line-28"></a> Bit-related utilities
<a name="line-29"></a>
<a name="line-30"></a>Written by John Goerzen, jgoerzen\@complete.org
<a name="line-31"></a>-}</span>
<a name="line-32"></a>
<a name="line-33"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Bits</span><span class='hs-varop'>.</span><span class='hs-conid'>Utils</span><span class='hs-layout'>(</span><span class='hs-varid'>getBytes</span><span class='hs-layout'>,</span> <span class='hs-varid'>fromBytes</span><span class='hs-layout'>,</span>
<a name="line-34"></a> <span class='hs-varid'>c2w8</span><span class='hs-layout'>,</span> <span class='hs-varid'>s2w8</span><span class='hs-layout'>,</span> <span class='hs-varid'>w82c</span><span class='hs-layout'>,</span> <span class='hs-varid'>w82s</span><span class='hs-layout'>)</span>
<a name="line-35"></a><span class='hs-keyword'>where</span>
<a name="line-36"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Bits</span>
<a name="line-37"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Word</span>
<a name="line-38"></a>
<a name="line-39"></a><a name="getBytes"></a><span class='hs-comment'>{- | Returns a list representing the bytes that comprise a data type.
<a name="line-40"></a>
<a name="line-41"></a>Example:
<a name="line-42"></a>
<a name="line-43"></a>> getBytes (0x12345678::Int) -> [0x12, 0x34, 0x56, 0x78]
<a name="line-44"></a>-}</span>
<a name="line-45"></a><span class='hs-definition'>getBytes</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Integral</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>Bounded</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>Bits</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span>
<a name="line-46"></a><span class='hs-definition'>getBytes</span> <span class='hs-varid'>input</span> <span class='hs-keyglyph'>=</span>
<a name="line-47"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>getByte</span> <span class='hs-keyword'>_</span> <span class='hs-num'>0</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>[]</span>
<a name="line-48"></a> <span class='hs-varid'>getByte</span> <span class='hs-varid'>x</span> <span class='hs-varid'>remaining</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>x</span> <span class='hs-varop'>.&.</span> <span class='hs-num'>0xff</span><span class='hs-layout'>)</span> <span class='hs-conop'>:</span> <span class='hs-varid'>getByte</span> <span class='hs-layout'>(</span><span class='hs-varid'>shiftR</span> <span class='hs-varid'>x</span> <span class='hs-num'>8</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>remaining</span> <span class='hs-comment'>-</span> <span class='hs-num'>1</span><span class='hs-layout'>)</span>
<a name="line-49"></a> <span class='hs-keyword'>in</span>
<a name="line-50"></a> <span class='hs-keyword'>if</span> <span class='hs-layout'>(</span><span class='hs-varid'>bitSize</span> <span class='hs-varid'>input</span> <span class='hs-varop'>`mod`</span> <span class='hs-num'>8</span><span class='hs-layout'>)</span> <span class='hs-varop'>/=</span> <span class='hs-num'>0</span>
<a name="line-51"></a> <span class='hs-keyword'>then</span> <span class='hs-varid'>error</span> <span class='hs-str'>"Input data bit size must be a multiple of 8"</span>
<a name="line-52"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>reverse</span> <span class='hs-varop'>$</span> <span class='hs-varid'>getByte</span> <span class='hs-varid'>input</span> <span class='hs-layout'>(</span><span class='hs-varid'>bitSize</span> <span class='hs-varid'>input</span> <span class='hs-varop'>`div`</span> <span class='hs-num'>8</span><span class='hs-layout'>)</span>
<a name="line-53"></a>
<a name="line-54"></a><span class='hs-comment'>{- | The opposite of 'getBytes', this function builds a number based on
<a name="line-55"></a>its component bytes.
<a name="line-56"></a>
<a name="line-57"></a>Results are undefined if any components of the input list are > 0xff!
<a name="line-58"></a>
<a name="line-59"></a>-}</span>
<a name="line-60"></a>
<a name="line-61"></a><a name="fromBytes"></a><span class='hs-definition'>fromBytes</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Bits</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span>
<a name="line-62"></a><span class='hs-definition'>fromBytes</span> <span class='hs-varid'>input</span> <span class='hs-keyglyph'>=</span>
<a name="line-63"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>dofb</span> <span class='hs-varid'>accum</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>accum</span>
<a name="line-64"></a> <span class='hs-varid'>dofb</span> <span class='hs-varid'>accum</span> <span class='hs-layout'>(</span><span class='hs-varid'>x</span><span class='hs-conop'>:</span><span class='hs-varid'>xs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>dofb</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varid'>shiftL</span> <span class='hs-varid'>accum</span> <span class='hs-num'>8</span><span class='hs-layout'>)</span> <span class='hs-varop'>.|.</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span> <span class='hs-varid'>xs</span>
<a name="line-65"></a> <span class='hs-keyword'>in</span>
<a name="line-66"></a> <span class='hs-varid'>dofb</span> <span class='hs-num'>0</span> <span class='hs-varid'>input</span>
<a name="line-67"></a>
<a name="line-68"></a><a name="c2w8"></a><span class='hs-comment'>{- | Converts a Char to a Word8. -}</span>
<a name="line-69"></a><span class='hs-definition'>c2w8</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Char</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Word8</span>
<a name="line-70"></a><span class='hs-definition'>c2w8</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varop'>.</span> <span class='hs-varid'>fromEnum</span>
<a name="line-71"></a>
<a name="line-72"></a><a name="s2w8"></a><span class='hs-comment'>{- | Converts a String to a [Word8]. -}</span>
<a name="line-73"></a><span class='hs-definition'>s2w8</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Word8</span><span class='hs-keyglyph'>]</span>
<a name="line-74"></a><span class='hs-definition'>s2w8</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>map</span> <span class='hs-varid'>c2w8</span>
<a name="line-75"></a>
<a name="line-76"></a><a name="w82c"></a><span class='hs-comment'>{- | Converts a Word8 to a Char. -}</span>
<a name="line-77"></a><span class='hs-definition'>w82c</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Word8</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Char</span>
<a name="line-78"></a><span class='hs-definition'>w82c</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>toEnum</span> <span class='hs-varop'>.</span> <span class='hs-varid'>fromIntegral</span>
<a name="line-79"></a>
<a name="line-80"></a><a name="w82s"></a><span class='hs-comment'>{- | Converts a [Word8] to a String. -}</span>
<a name="line-81"></a><span class='hs-definition'>w82s</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Word8</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span>
<a name="line-82"></a><span class='hs-definition'>w82s</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>map</span> <span class='hs-varid'>w82c</span>
</pre></body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
ec5844e219498f2057da8f8f3070d4a1
>
files
>
265
