/usr/share/doc/libghc-glut-doc/html/src/Graphics-UI-GLUT-Begin.html is in libghc-glut-doc 2.7.0.1-3build1.
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 107 108 109 110 111 | <?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>src/Graphics/UI/GLUT/Begin.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.UI.GLUT.Begin</span>
<a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) Sven Panne 2002-2013</span>
<a name="line-5"></a><span class='hs-comment'>-- License : BSD3</span>
<a name="line-6"></a><span class='hs-comment'>--</span>
<a name="line-7"></a><span class='hs-comment'>-- Maintainer : Sven Panne <svenpanne@gmail.com></span>
<a name="line-8"></a><span class='hs-comment'>-- Stability : stable</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'>-- After a GLUT program has done initial setup such as creating windows and</span>
<a name="line-12"></a><span class='hs-comment'>-- menus, GLUT programs enter the GLUT event processing loop by calling</span>
<a name="line-13"></a><span class='hs-comment'>-- 'mainLoop' or handle events iteratively with 'mainLoopEvent'.</span>
<a name="line-14"></a><span class='hs-comment'>--</span>
<a name="line-15"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-16"></a>
<a name="line-17"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>UI</span><span class='hs-varop'>.</span><span class='hs-conid'>GLUT</span><span class='hs-varop'>.</span><span class='hs-conid'>Begin</span> <span class='hs-layout'>(</span>
<a name="line-18"></a> <span class='hs-comment'>-- * Handling events</span>
<a name="line-19"></a> <span class='hs-varid'>mainLoop</span><span class='hs-layout'>,</span> <span class='hs-varid'>mainLoopEvent</span><span class='hs-layout'>,</span> <span class='hs-varid'>leaveMainLoop</span><span class='hs-layout'>,</span>
<a name="line-20"></a>
<a name="line-21"></a> <span class='hs-comment'>-- * Controlling the behaviour when windows are closed</span>
<a name="line-22"></a> <span class='hs-conid'>ActionOnWindowClose</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>actionOnWindowClose</span>
<a name="line-23"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-24"></a>
<a name="line-25"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>Class</span> <span class='hs-layout'>(</span> <span class='hs-conid'>MonadIO</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span> <span class='hs-layout'>)</span>
<a name="line-26"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>StateVar</span> <span class='hs-layout'>(</span> <span class='hs-conid'>StateVar</span><span class='hs-layout'>,</span> <span class='hs-varid'>makeStateVar</span> <span class='hs-layout'>)</span>
<a name="line-27"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span> <span class='hs-layout'>(</span> <span class='hs-conid'>CInt</span> <span class='hs-layout'>)</span>
<a name="line-28"></a>
<a name="line-29"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>UI</span><span class='hs-varop'>.</span><span class='hs-conid'>GLUT</span><span class='hs-varop'>.</span><span class='hs-conid'>QueryUtils</span>
<a name="line-30"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>UI</span><span class='hs-varop'>.</span><span class='hs-conid'>GLUT</span><span class='hs-varop'>.</span><span class='hs-conid'>Raw</span>
<a name="line-31"></a>
<a name="line-32"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-33"></a>
<a name="line-34"></a><span class='hs-comment'>-- | Enter the GLUT event processing loop; it will call as necessary any</span>
<a name="line-35"></a><span class='hs-comment'>-- callbacks that have been registered. This routine should be called at most</span>
<a name="line-36"></a><span class='hs-comment'>-- once in a GLUT program.</span>
<a name="line-37"></a>
<a name="line-38"></a><a name="mainLoop"></a><span class='hs-definition'>mainLoop</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>MonadIO</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-39"></a><span class='hs-definition'>mainLoop</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>glutMainLoop</span>
<a name="line-40"></a>
<a name="line-41"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-42"></a>
<a name="line-43"></a><span class='hs-comment'>-- | (/freeglut only/) Process one iteration's worth of events in its event loop.</span>
<a name="line-44"></a><span class='hs-comment'>-- This allows the application to control its own event loop and still use the</span>
<a name="line-45"></a><span class='hs-comment'>-- GLUT package.</span>
<a name="line-46"></a>
<a name="line-47"></a><a name="mainLoopEvent"></a><span class='hs-definition'>mainLoopEvent</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>MonadIO</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-48"></a><span class='hs-definition'>mainLoopEvent</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>glutMainLoopEvent</span>
<a name="line-49"></a>
<a name="line-50"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-51"></a>
<a name="line-52"></a><span class='hs-comment'>-- | (/freeglut only/) Stop the event loop. If 'actionOnWindowClose' contains</span>
<a name="line-53"></a><span class='hs-comment'>-- 'Exit', the application will exit; otherwise control will return to the</span>
<a name="line-54"></a><span class='hs-comment'>-- function which called 'mainLoop'.</span>
<a name="line-55"></a><span class='hs-comment'>--</span>
<a name="line-56"></a><span class='hs-comment'>-- If the application has two nested calls to 'mainLoop' and calls</span>
<a name="line-57"></a><span class='hs-comment'>-- 'leaveMainLoop', the behaviour is undefined. It may leave only the inner</span>
<a name="line-58"></a><span class='hs-comment'>-- nested loop or it may leave both loops. If the reader has a strong preference</span>
<a name="line-59"></a><span class='hs-comment'>-- for one behaviour over the other he should contact the freeglut Programming</span>
<a name="line-60"></a><span class='hs-comment'>-- Consortium and ask for the code to be fixed.</span>
<a name="line-61"></a>
<a name="line-62"></a><a name="leaveMainLoop"></a><span class='hs-definition'>leaveMainLoop</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>MonadIO</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-63"></a><span class='hs-definition'>leaveMainLoop</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>glutLeaveMainLoop</span>
<a name="line-64"></a>
<a name="line-65"></a><span class='hs-comment'>--------------------------------------------------------------------------------</span>
<a name="line-66"></a>
<a name="line-67"></a><span class='hs-comment'>-- | The behaviour when the user closes a window.</span>
<a name="line-68"></a>
<a name="line-69"></a><a name="ActionOnWindowClose"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>ActionOnWindowClose</span>
<a name="line-70"></a> <span class='hs-keyglyph'>=</span> <span class='hs-comment'>-- | Exit the whole program when any window is closed or 'leaveMainLoop'</span>
<a name="line-71"></a> <span class='hs-comment'>-- is called (default).</span>
<a name="line-72"></a> <span class='hs-conid'>Exit</span>
<a name="line-73"></a> <span class='hs-keyglyph'>|</span> <span class='hs-comment'>-- | Return from mainLoop when any window is closed.</span>
<a name="line-74"></a> <span class='hs-conid'>MainLoopReturns</span>
<a name="line-75"></a> <span class='hs-keyglyph'>|</span> <span class='hs-comment'>-- | Return from mainLoop after the last window is closed.</span>
<a name="line-76"></a> <span class='hs-conid'>ContinueExecution</span>
<a name="line-77"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span> <span class='hs-conid'>Eq</span><span class='hs-layout'>,</span> <span class='hs-conid'>Ord</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span> <span class='hs-layout'>)</span>
<a name="line-78"></a>
<a name="line-79"></a><a name="marshalActionOnWindowClose"></a><span class='hs-definition'>marshalActionOnWindowClose</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ActionOnWindowClose</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>CInt</span>
<a name="line-80"></a><span class='hs-definition'>marshalActionOnWindowClose</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>x</span> <span class='hs-keyword'>of</span>
<a name="line-81"></a> <span class='hs-conid'>Exit</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>glut_ACTION_EXIT</span>
<a name="line-82"></a> <span class='hs-conid'>MainLoopReturns</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>glut_ACTION_GLUTMAINLOOP_RETURNS</span>
<a name="line-83"></a> <span class='hs-conid'>ContinueExecution</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>glut_ACTION_CONTINUE_EXECUTION</span>
<a name="line-84"></a>
<a name="line-85"></a><a name="unmarshalActionOnWindowClose"></a><span class='hs-definition'>unmarshalActionOnWindowClose</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>CInt</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ActionOnWindowClose</span>
<a name="line-86"></a><span class='hs-definition'>unmarshalActionOnWindowClose</span> <span class='hs-varid'>x</span>
<a name="line-87"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>x</span> <span class='hs-varop'>==</span> <span class='hs-varid'>glut_ACTION_EXIT</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Exit</span>
<a name="line-88"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>x</span> <span class='hs-varop'>==</span> <span class='hs-varid'>glut_ACTION_GLUTMAINLOOP_RETURNS</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>MainLoopReturns</span>
<a name="line-89"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>x</span> <span class='hs-varop'>==</span> <span class='hs-varid'>glut_ACTION_CONTINUE_EXECUTION</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ContinueExecution</span>
<a name="line-90"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>error</span> <span class='hs-layout'>(</span><span class='hs-str'>"unmarshalActionOnWindowClose: illegal value "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>show</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span>
<a name="line-91"></a>
<a name="line-92"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-93"></a>
<a name="line-94"></a><span class='hs-comment'>-- | (/freeglut only/) Controls the behaviour when the user closes a window.</span>
<a name="line-95"></a>
<a name="line-96"></a><a name="actionOnWindowClose"></a><span class='hs-definition'>actionOnWindowClose</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>StateVar</span> <span class='hs-conid'>ActionOnWindowClose</span>
<a name="line-97"></a><span class='hs-definition'>actionOnWindowClose</span> <span class='hs-keyglyph'>=</span>
<a name="line-98"></a> <span class='hs-varid'>makeStateVar</span>
<a name="line-99"></a> <span class='hs-layout'>(</span><span class='hs-varid'>simpleGet</span> <span class='hs-varid'>unmarshalActionOnWindowClose</span> <span class='hs-varid'>glut_ACTION_ON_WINDOW_CLOSE</span><span class='hs-layout'>)</span>
<a name="line-100"></a> <span class='hs-layout'>(</span><span class='hs-varid'>glutSetOption</span> <span class='hs-varid'>glut_ACTION_ON_WINDOW_CLOSE</span> <span class='hs-varop'>.</span> <span class='hs-varid'>marshalActionOnWindowClose</span><span class='hs-layout'>)</span>
</pre></body>
</html>
|