<?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/full/Agda/Interaction/Response.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'>-- | Data type for all interactive responses</span>
<a name="line-3"></a><span class='hs-comment'>------------------------------------------------------------------------</span>
<a name="line-4"></a><span class='hs-comment'>{-# LANGUAGE CPP, TypeSynonymInstances, FlexibleInstances #-}</span>
<a name="line-5"></a>
<a name="line-6"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Agda</span><span class='hs-varop'>.</span><span class='hs-conid'>Interaction</span><span class='hs-varop'>.</span><span class='hs-conid'>Response</span>
<a name="line-7"></a> <span class='hs-layout'>(</span> <span class='hs-conid'>Response</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-8"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>DisplayInfo</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-9"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Status</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-10"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>GiveResult</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-11"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>InteractionOutputCallback</span>
<a name="line-12"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>defaultInteractionOutputCallback</span>
<a name="line-13"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-14"></a>
<a name="line-15"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Agda</span><span class='hs-varop'>.</span><span class='hs-conid'>Interaction</span><span class='hs-varop'>.</span><span class='hs-conid'>Highlighting</span><span class='hs-varop'>.</span><span class='hs-conid'>Precise</span>
<a name="line-16"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Agda</span><span class='hs-varop'>.</span><span class='hs-conid'>Interaction</span><span class='hs-varop'>.</span><span class='hs-conid'>FindFile</span> <span class='hs-layout'>(</span><span class='hs-conid'>ModuleToSource</span><span class='hs-layout'>)</span>
<a name="line-17"></a><span class='hs-comment'>--import Agda.Interaction.MakeCase</span>
<a name="line-18"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Agda</span><span class='hs-varop'>.</span><span class='hs-conid'>TypeChecking</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span><span class='hs-varop'>.</span><span class='hs-conid'>Base</span>
<a name="line-19"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Agda</span><span class='hs-varop'>.</span><span class='hs-conid'>Syntax</span><span class='hs-varop'>.</span><span class='hs-conid'>Concrete</span> <span class='hs-layout'>(</span><span class='hs-conid'>Expr</span><span class='hs-layout'>)</span>
<a name="line-20"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Agda</span><span class='hs-varop'>.</span><span class='hs-conid'>Utils</span><span class='hs-varop'>.</span><span class='hs-conid'>Pretty</span>
<a name="line-21"></a>
<a name="line-22"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Int</span>
<a name="line-23"></a>
<a name="line-24"></a><span class='hs-cpp'>#include "../undefined.h"</span>
<a name="line-25"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Agda</span><span class='hs-varop'>.</span><span class='hs-conid'>Utils</span><span class='hs-varop'>.</span><span class='hs-conid'>Impossible</span>
<a name="line-26"></a>
<a name="line-27"></a><span class='hs-comment'>-- | Responses for any interactive interface</span>
<a name="line-28"></a><span class='hs-comment'>--</span>
<a name="line-29"></a><span class='hs-comment'>-- Note that the response is given in pieces and incrementally,</span>
<a name="line-30"></a><span class='hs-comment'>-- so the user can have timely response even during long computations.</span>
<a name="line-31"></a>
<a name="line-32"></a><a name="Response"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Response</span>
<a name="line-33"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Resp_HighlightingInfo</span> <span class='hs-conid'>HighlightingInfo</span> <span class='hs-conid'>ModuleToSource</span>
<a name="line-34"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Resp_Status</span> <span class='hs-conid'>Status</span>
<a name="line-35"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Resp_JumpToError</span> <span class='hs-conid'>FilePath</span> <span class='hs-conid'>Int32</span>
<a name="line-36"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Resp_InteractionPoints</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>InteractionId</span><span class='hs-keyglyph'>]</span>
<a name="line-37"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Resp_GiveAction</span> <span class='hs-conid'>InteractionId</span> <span class='hs-conid'>GiveResult</span>
<a name="line-38"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Resp_MakeCaseAction</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span>
<a name="line-39"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Resp_MakeCase</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span>
<a name="line-40"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Resp_SolveAll</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>InteractionId</span><span class='hs-layout'>,</span> <span class='hs-conid'>Expr</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-41"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Resp_DisplayInfo</span> <span class='hs-conid'>DisplayInfo</span>
<a name="line-42"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Resp_RunningInfo</span> <span class='hs-conid'>String</span>
<a name="line-43"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Resp_ClearRunningInfo</span>
<a name="line-44"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Resp_ClearHighlighting</span>
<a name="line-45"></a>
<a name="line-46"></a><span class='hs-comment'>-- | Info to display at the end of an interactive command</span>
<a name="line-47"></a>
<a name="line-48"></a><a name="DisplayInfo"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>DisplayInfo</span>
<a name="line-49"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Info_CompilationOk</span>
<a name="line-50"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Info_Constraints</span> <span class='hs-conid'>String</span>
<a name="line-51"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Info_AllGoals</span> <span class='hs-conid'>String</span>
<a name="line-52"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Info_Error</span> <span class='hs-conid'>String</span>
<a name="line-53"></a> <span class='hs-comment'>-- ^ When an error message is displayed this constructor should be</span>
<a name="line-54"></a> <span class='hs-comment'>-- used, if appropriate.</span>
<a name="line-55"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Info_Intro</span> <span class='hs-conid'>Doc</span>
<a name="line-56"></a> <span class='hs-comment'>-- ^ 'Info_Intro' denotes two different types of errors</span>
<a name="line-57"></a> <span class='hs-comment'>-- TODO: split these into separate constructors</span>
<a name="line-58"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Info_Auto</span> <span class='hs-conid'>String</span>
<a name="line-59"></a> <span class='hs-comment'>-- ^ 'Info_Auto' denotes either an error or a success (when 'Resp_GiveAction' is present)</span>
<a name="line-60"></a> <span class='hs-comment'>-- TODO: split these into separate constructors</span>
<a name="line-61"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Info_ModuleContents</span> <span class='hs-conid'>Doc</span>
<a name="line-62"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Info_NormalForm</span> <span class='hs-conid'>Doc</span>
<a name="line-63"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Info_GoalType</span> <span class='hs-conid'>Doc</span>
<a name="line-64"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Info_CurrentGoal</span> <span class='hs-conid'>Doc</span>
<a name="line-65"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Info_InferredType</span> <span class='hs-conid'>Doc</span>
<a name="line-66"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Info_Context</span> <span class='hs-conid'>Doc</span>
<a name="line-67"></a> <span class='hs-keyword'>deriving</span> <span class='hs-conid'>Show</span>
<a name="line-68"></a>
<a name="line-69"></a><span class='hs-comment'>-- | Status information.</span>
<a name="line-70"></a>
<a name="line-71"></a><a name="Status"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Status</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Status</span>
<a name="line-72"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>sShowImplicitArguments</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bool</span>
<a name="line-73"></a> <span class='hs-comment'>-- ^ Are implicit arguments displayed?</span>
<a name="line-74"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>sChecked</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bool</span>
<a name="line-75"></a> <span class='hs-comment'>-- ^ Has the module been successfully type checked?</span>
<a name="line-76"></a> <span class='hs-layout'>}</span>
<a name="line-77"></a>
<a name="line-78"></a><span class='hs-comment'>-- | Give action result</span>
<a name="line-79"></a><span class='hs-comment'>--</span>
<a name="line-80"></a><span class='hs-comment'>-- Comment derived from agda2-mode.el</span>
<a name="line-81"></a><span class='hs-comment'>--</span>
<a name="line-82"></a><span class='hs-comment'>-- If 'GiveResult' is 'Give_String s', then the goal is replaced by 's',</span>
<a name="line-83"></a><span class='hs-comment'>-- and otherwise the text inside the goal is retained (parenthesised</span>
<a name="line-84"></a><span class='hs-comment'>-- if 'GiveResult' is 'Give_Paren').</span>
<a name="line-85"></a>
<a name="line-86"></a><a name="GiveResult"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>GiveResult</span>
<a name="line-87"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Give_String</span> <span class='hs-conid'>String</span>
<a name="line-88"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Give_Paren</span>
<a name="line-89"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Give_NoParen</span>
<a name="line-90"></a>
<a name="line-91"></a><span class='hs-comment'>-- | Callback fuction to call when there is a response</span>
<a name="line-92"></a><span class='hs-comment'>-- to give to the interactive frontend.</span>
<a name="line-93"></a><span class='hs-comment'>--</span>
<a name="line-94"></a><span class='hs-comment'>-- Note that the response is given in pieces and incrementally,</span>
<a name="line-95"></a><span class='hs-comment'>-- so the user can have timely response even during long computations.</span>
<a name="line-96"></a><span class='hs-comment'>--</span>
<a name="line-97"></a><span class='hs-comment'>-- Typical 'InteractionOutputCallback' functions:</span>
<a name="line-98"></a><span class='hs-comment'>--</span>
<a name="line-99"></a><span class='hs-comment'>-- * Convert the response into a 'String' representation and</span>
<a name="line-100"></a><span class='hs-comment'>-- print it on standard output</span>
<a name="line-101"></a><span class='hs-comment'>-- (suitable for inter-process communication).</span>
<a name="line-102"></a><span class='hs-comment'>--</span>
<a name="line-103"></a><span class='hs-comment'>-- * Put the response into a mutable variable stored in the</span>
<a name="line-104"></a><span class='hs-comment'>-- closure of the 'InteractionOutputCallback' function.</span>
<a name="line-105"></a><span class='hs-comment'>-- (suitable for intra-process communication).</span>
<a name="line-106"></a>
<a name="line-107"></a><a name="InteractionOutputCallback"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>InteractionOutputCallback</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Response</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>TCM</span> <span class='hs-conid'>()</span>
<a name="line-108"></a>
<a name="line-109"></a><span class='hs-comment'>-- | The default 'InteractionOutputCallback' function</span>
<a name="line-110"></a><span class='hs-comment'>-- is set to @__@@IMPOSSIBLE__@ because in this way it is easier to</span>
<a name="line-111"></a><span class='hs-comment'>-- recognize that some response is lost due to an uninitialized</span>
<a name="line-112"></a><span class='hs-comment'>-- 'InteractionOutputCallback' function.</span>
<a name="line-113"></a>
<a name="line-114"></a><a name="defaultInteractionOutputCallback"></a><span class='hs-definition'>defaultInteractionOutputCallback</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>InteractionOutputCallback</span>
<a name="line-115"></a><span class='hs-definition'>defaultInteractionOutputCallback</span> <span class='hs-keyglyph'>=</span> <span class='hs-sel'>__IMPOSSIBLE__</span>
</pre></body>
</html>
