/usr/share/doc/libghc-x11-doc/html/src/Graphics-X11-Xlib.html is in libghc-x11-doc 1.6.1.2-1.
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 | <?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>Graphics/X11/Xlib.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-2"></a><span class='hs-comment'>-- |</span>
<a name="line-3"></a><span class='hs-comment'>-- Module : Graphics.X11.Xlib</span>
<a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) Alastair Reid, 1999-2003</span>
<a name="line-5"></a><span class='hs-comment'>-- License : BSD-style (see the file libraries/base/LICENSE)</span>
<a name="line-6"></a><span class='hs-comment'>-- </span>
<a name="line-7"></a><span class='hs-comment'>-- Maintainer : libraries@haskell.org</span>
<a name="line-8"></a><span class='hs-comment'>-- Stability : provisional</span>
<a name="line-9"></a><span class='hs-comment'>-- Portability : portable</span>
<a name="line-10"></a><span class='hs-comment'>--</span>
<a name="line-11"></a><span class='hs-comment'>-- A collection of FFI declarations for interfacing with Xlib.</span>
<a name="line-12"></a><span class='hs-comment'>--</span>
<a name="line-13"></a><span class='hs-comment'>-- The library aims to provide a direct translation of the X</span>
<a name="line-14"></a><span class='hs-comment'>-- binding into Haskell so the most important documentation you</span>
<a name="line-15"></a><span class='hs-comment'>-- should read is /The Xlib Programming Manual/, available online at</span>
<a name="line-16"></a><span class='hs-comment'>-- <<a href="http://tronche.com/gui/x/xlib/">http://tronche.com/gui/x/xlib/</a>>. Let me say that again because</span>
<a name="line-17"></a><span class='hs-comment'>-- it is very important. Get hold of this documentation and read it:</span>
<a name="line-18"></a><span class='hs-comment'>-- it tells you almost everything you need to know to use this library.</span>
<a name="line-19"></a><span class='hs-comment'>--</span>
<a name="line-20"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-21"></a>
<a name="line-22"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span>
<a name="line-23"></a> <span class='hs-layout'>(</span> <span class='hs-comment'>-- * Conventions</span>
<a name="line-24"></a> <span class='hs-comment'>-- $conventions</span>
<a name="line-25"></a>
<a name="line-26"></a> <span class='hs-comment'>-- * Types</span>
<a name="line-27"></a> <span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span><span class='hs-layout'>,</span>
<a name="line-28"></a> <span class='hs-comment'>-- module Graphics.X11.Xlib.Types,</span>
<a name="line-29"></a> <span class='hs-conid'>Display</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>Screen</span><span class='hs-layout'>,</span> <span class='hs-conid'>Visual</span><span class='hs-layout'>,</span> <span class='hs-conid'>GC</span><span class='hs-layout'>,</span> <span class='hs-conid'>SetWindowAttributes</span><span class='hs-layout'>,</span> <span class='hs-conid'>VisualInfo</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-30"></a> <span class='hs-conid'>Point</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>Rectangle</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>Arc</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>Segment</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>Color</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-31"></a> <span class='hs-conid'>Pixel</span><span class='hs-layout'>,</span> <span class='hs-conid'>Position</span><span class='hs-layout'>,</span> <span class='hs-conid'>Dimension</span><span class='hs-layout'>,</span> <span class='hs-conid'>Angle</span><span class='hs-layout'>,</span> <span class='hs-conid'>ScreenNumber</span><span class='hs-layout'>,</span> <span class='hs-conid'>Buffer</span><span class='hs-layout'>,</span>
<a name="line-32"></a>
<a name="line-33"></a> <span class='hs-comment'>-- * X11 library functions</span>
<a name="line-34"></a> <span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Event</span><span class='hs-layout'>,</span>
<a name="line-35"></a> <span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Display</span><span class='hs-layout'>,</span>
<a name="line-36"></a> <span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Screen</span><span class='hs-layout'>,</span>
<a name="line-37"></a> <span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Window</span><span class='hs-layout'>,</span>
<a name="line-38"></a> <span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Context</span><span class='hs-layout'>,</span>
<a name="line-39"></a> <span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Color</span><span class='hs-layout'>,</span>
<a name="line-40"></a> <span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Cursor</span><span class='hs-layout'>,</span>
<a name="line-41"></a> <span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Font</span><span class='hs-layout'>,</span>
<a name="line-42"></a> <span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Atom</span><span class='hs-layout'>,</span>
<a name="line-43"></a> <span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Region</span><span class='hs-layout'>,</span>
<a name="line-44"></a> <span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Image</span><span class='hs-layout'>,</span>
<a name="line-45"></a> <span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Misc</span><span class='hs-layout'>,</span>
<a name="line-46"></a>
<a name="line-47"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-48"></a>
<a name="line-49"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span>
<a name="line-50"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span>
<a name="line-51"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Event</span>
<a name="line-52"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Display</span>
<a name="line-53"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Screen</span>
<a name="line-54"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Window</span>
<a name="line-55"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Context</span>
<a name="line-56"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Color</span>
<a name="line-57"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Cursor</span>
<a name="line-58"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Font</span>
<a name="line-59"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Atom</span>
<a name="line-60"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Region</span>
<a name="line-61"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Image</span>
<a name="line-62"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Misc</span>
<a name="line-63"></a>
<a name="line-64"></a><span class='hs-comment'>{- $conventions
<a name="line-65"></a>
<a name="line-66"></a>In translating the library, we had to change names to conform with
<a name="line-67"></a>Haskell's lexical syntax: function names and names of constants must start
<a name="line-68"></a>with a lowercase letter; type names must start with an uppercase letter.
<a name="line-69"></a>The case of the remaining letters is unchanged.
<a name="line-70"></a>
<a name="line-71"></a>In addition, we chose to take advantage of Haskell's module system to
<a name="line-72"></a>allow us to drop common prefixes (@X@, @XA_@, etc.) attached to X11
<a name="line-73"></a>identifiers.
<a name="line-74"></a>
<a name="line-75"></a>We named enumeration types so that function types would be easier
<a name="line-76"></a>to understand. For example, we added 'Status', 'WindowClass', etc.
<a name="line-77"></a>Note that the types are synonyms for 'Int' so no extra typesafety was
<a name="line-78"></a>obtained.
<a name="line-79"></a>
<a name="line-80"></a>We consistently raise exceptions when a function returns an error code.
<a name="line-81"></a>In practice, this only affects the following functions because most Xlib
<a name="line-82"></a>functions do not return error codes: 'allocColor', 'allocNamedColor',
<a name="line-83"></a>'fetchBuffer', 'fetchBytes', 'fontFromGC', 'getGeometry', 'getIconName',
<a name="line-84"></a>'iconifyWindow', 'loadQueryFont', 'lookupColor', 'openDisplay',
<a name="line-85"></a>'parseColor', 'queryBestCursor', 'queryBestSize', 'queryBestStipple',
<a name="line-86"></a>'queryBestTile', 'rotateBuffers', 'selectInput', 'storeBuffer',
<a name="line-87"></a>'storeBytes', 'withdrawWindow'.
<a name="line-88"></a>
<a name="line-89"></a>-}</span>
<a name="line-90"></a>
<a name="line-91"></a><span class='hs-comment'>----------------------------------------------------------------</span>
<a name="line-92"></a><span class='hs-comment'>-- End</span>
<a name="line-93"></a><span class='hs-comment'>----------------------------------------------------------------</span>
</pre></body>
</html>
|