/usr/share/doc/libghc-bmp-doc/html/src/Codec-BMP-FileHeader.html is in libghc-bmp-doc 1.2.3.4-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 | <?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://code.haskell.org/~malcolm/hscolour/ -->
<title>Codec/BMP/FileHeader.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# OPTIONS_HADDOCK hide #-}</span>
<a name="line-2"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Codec</span><span class='hs-varop'>.</span><span class='hs-conid'>BMP</span><span class='hs-varop'>.</span><span class='hs-conid'>FileHeader</span>
<a name="line-3"></a> <span class='hs-layout'>(</span> <span class='hs-conid'>FileHeader</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-4"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>bmpMagic</span>
<a name="line-5"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>sizeOfFileHeader</span>
<a name="line-6"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>checkFileHeader</span><span class='hs-layout'>)</span>
<a name="line-7"></a><span class='hs-keyword'>where</span>
<a name="line-8"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Codec</span><span class='hs-varop'>.</span><span class='hs-conid'>BMP</span><span class='hs-varop'>.</span><span class='hs-conid'>BitmapInfoV3</span>
<a name="line-9"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Codec</span><span class='hs-varop'>.</span><span class='hs-conid'>BMP</span><span class='hs-varop'>.</span><span class='hs-conid'>Error</span>
<a name="line-10"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Binary</span>
<a name="line-11"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Binary</span><span class='hs-varop'>.</span><span class='hs-conid'>Get</span>
<a name="line-12"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Binary</span><span class='hs-varop'>.</span><span class='hs-conid'>Put</span>
<a name="line-13"></a>
<a name="line-14"></a>
<a name="line-15"></a><a name="FileHeader"></a><span class='hs-comment'>-- | BMP file header.</span>
<a name="line-16"></a><a name="FileHeader"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>FileHeader</span>
<a name="line-17"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>FileHeader</span>
<a name="line-18"></a> <span class='hs-layout'>{</span> <span class='hs-comment'>-- | (+0) Magic numbers 0x42 0x4d</span>
<a name="line-19"></a> <span class='hs-varid'>fileHeaderType</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Word16</span>
<a name="line-20"></a>
<a name="line-21"></a> <span class='hs-comment'>-- | (+2) Size of the file, in bytes.</span>
<a name="line-22"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fileHeaderFileSize</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Word32</span>
<a name="line-23"></a>
<a name="line-24"></a> <span class='hs-comment'>-- | (+6) Reserved, must be zero.</span>
<a name="line-25"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fileHeaderReserved1</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Word16</span>
<a name="line-26"></a>
<a name="line-27"></a> <span class='hs-comment'>-- | (+8) Reserved, must be zero.</span>
<a name="line-28"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fileHeaderReserved2</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Word16</span>
<a name="line-29"></a>
<a name="line-30"></a> <span class='hs-comment'>-- | (+10) Offset in bytes to the start of the pixel data.</span>
<a name="line-31"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fileHeaderOffset</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Word32</span>
<a name="line-32"></a> <span class='hs-layout'>}</span>
<a name="line-33"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Show</span><span class='hs-layout'>)</span>
<a name="line-34"></a>
<a name="line-35"></a>
<a name="line-36"></a><a name="sizeOfFileHeader"></a><span class='hs-comment'>-- | Size of a file header (in bytes).</span>
<a name="line-37"></a><span class='hs-definition'>sizeOfFileHeader</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span>
<a name="line-38"></a><span class='hs-definition'>sizeOfFileHeader</span> <span class='hs-keyglyph'>=</span> <span class='hs-num'>14</span>
<a name="line-39"></a>
<a name="line-40"></a>
<a name="line-41"></a><a name="bmpMagic"></a><span class='hs-comment'>-- | Magic number that should come at the start of a BMP file.</span>
<a name="line-42"></a><span class='hs-definition'>bmpMagic</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Word16</span>
<a name="line-43"></a><span class='hs-definition'>bmpMagic</span> <span class='hs-keyglyph'>=</span> <span class='hs-num'>0x4d42</span>
<a name="line-44"></a>
<a name="line-45"></a>
<a name="line-46"></a><a name="instance%20Binary%20FileHeader"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Binary</span> <span class='hs-conid'>FileHeader</span> <span class='hs-keyword'>where</span>
<a name="line-47"></a> <span class='hs-varid'>get</span>
<a name="line-48"></a> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getWord16le</span>
<a name="line-49"></a> <span class='hs-varid'>size</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getWord32le</span>
<a name="line-50"></a> <span class='hs-varid'>res1</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getWord16le</span>
<a name="line-51"></a> <span class='hs-varid'>res2</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getWord16le</span>
<a name="line-52"></a> <span class='hs-varid'>offset</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getWord32le</span>
<a name="line-53"></a>
<a name="line-54"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>FileHeader</span>
<a name="line-55"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>fileHeaderType</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>t</span>
<a name="line-56"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fileHeaderFileSize</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>size</span>
<a name="line-57"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fileHeaderReserved1</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>res1</span>
<a name="line-58"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fileHeaderReserved2</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>res2</span>
<a name="line-59"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fileHeaderOffset</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>offset</span> <span class='hs-layout'>}</span>
<a name="line-60"></a>
<a name="line-61"></a> <span class='hs-varid'>put</span> <span class='hs-varid'>header</span>
<a name="line-62"></a> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>putWord16le</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fileHeaderType</span> <span class='hs-varid'>header</span>
<a name="line-63"></a> <span class='hs-varid'>putWord32le</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fileHeaderFileSize</span> <span class='hs-varid'>header</span>
<a name="line-64"></a> <span class='hs-varid'>putWord16le</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fileHeaderReserved1</span> <span class='hs-varid'>header</span>
<a name="line-65"></a> <span class='hs-varid'>putWord16le</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fileHeaderReserved2</span> <span class='hs-varid'>header</span>
<a name="line-66"></a> <span class='hs-varid'>putWord32le</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fileHeaderOffset</span> <span class='hs-varid'>header</span>
<a name="line-67"></a>
<a name="line-68"></a>
<a name="line-69"></a><a name="checkFileHeader"></a><span class='hs-comment'>-- | Check a file header for problems and unsupported features.</span>
<a name="line-70"></a><span class='hs-definition'>checkFileHeader</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FileHeader</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>Error</span>
<a name="line-71"></a><span class='hs-definition'>checkFileHeader</span> <span class='hs-varid'>header</span>
<a name="line-72"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>fileHeaderType</span> <span class='hs-varid'>header</span> <span class='hs-varop'>/=</span> <span class='hs-varid'>bmpMagic</span>
<a name="line-73"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Just</span> <span class='hs-varop'>$</span> <span class='hs-conid'>ErrorBadMagic</span> <span class='hs-layout'>(</span><span class='hs-varid'>fileHeaderType</span> <span class='hs-varid'>header</span><span class='hs-layout'>)</span>
<a name="line-74"></a>
<a name="line-75"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>fileHeaderFileSize</span> <span class='hs-varid'>header</span>
<a name="line-76"></a> <span class='hs-varop'><</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>sizeOfFileHeader</span>
<a name="line-77"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Just</span> <span class='hs-varop'>$</span> <span class='hs-conid'>ErrorFileHeaderTruncated</span>
<a name="line-78"></a>
<a name="line-79"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>fileHeaderFileSize</span> <span class='hs-varid'>header</span>
<a name="line-80"></a> <span class='hs-varop'><</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-layout'>(</span><span class='hs-varid'>sizeOfFileHeader</span> <span class='hs-varop'>+</span> <span class='hs-varid'>sizeOfBitmapInfoV3</span><span class='hs-layout'>)</span>
<a name="line-81"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Just</span> <span class='hs-varop'>$</span> <span class='hs-conid'>ErrorImageHeaderTruncated</span>
<a name="line-82"></a>
<a name="line-83"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>fileHeaderReserved1</span> <span class='hs-varid'>header</span> <span class='hs-varop'>/=</span> <span class='hs-num'>0</span>
<a name="line-84"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Just</span> <span class='hs-varop'>$</span> <span class='hs-conid'>ErrorReservedFieldNotZero</span>
<a name="line-85"></a>
<a name="line-86"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>fileHeaderReserved2</span> <span class='hs-varid'>header</span> <span class='hs-varop'>/=</span> <span class='hs-num'>0</span>
<a name="line-87"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Just</span> <span class='hs-varop'>$</span> <span class='hs-conid'>ErrorReservedFieldNotZero</span>
<a name="line-88"></a>
<a name="line-89"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-layout'>(</span><span class='hs-varid'>fileHeaderOffset</span> <span class='hs-varid'>header</span><span class='hs-layout'>)</span>
<a name="line-90"></a> <span class='hs-varop'>/=</span> <span class='hs-varid'>sizeOfFileHeader</span> <span class='hs-varop'>+</span> <span class='hs-varid'>sizeOfBitmapInfoV3</span>
<a name="line-91"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Just</span> <span class='hs-varop'>$</span> <span class='hs-conid'>ErrorDodgyFileHeaderFieldOffset</span>
<a name="line-92"></a> <span class='hs-varop'>$</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varop'>$</span> <span class='hs-varid'>fileHeaderOffset</span> <span class='hs-varid'>header</span>
<a name="line-93"></a>
<a name="line-94"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span>
<a name="line-95"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Nothing</span>
</pre></body>
</html>
|