ncurses 5.7 - patch 20090321
[ncurses.git] / Ada95 / gen / terminal_interface-curses-mouse.ads.m4
index f4a5928fe2bab0cef30b565b4145b91eaa0f658b..b59ebbf032c16a29875af920e18ee4c5e7328f53 100644 (file)
@@ -1,5 +1,5 @@
 --  -*- ada -*-
-define(`HTMLNAME',`terminal_interface-curses-mouse_s.html')dnl
+define(`HTMLNAME',`terminal_interface-curses-mouse__ads.htm')dnl
 include(M4MACRO)dnl
 ------------------------------------------------------------------------------
 --                                                                          --
@@ -9,34 +9,56 @@ include(M4MACRO)dnl
 --                                                                          --
 --                                 S P E C                                  --
 --                                                                          --
---  Version 00.92                                                           --
+------------------------------------------------------------------------------
+-- Copyright (c) 1998-2004,2006 Free Software Foundation, Inc.              --
+--                                                                          --
+-- Permission is hereby granted, free of charge, to any person obtaining a  --
+-- copy of this software and associated documentation files (the            --
+-- "Software"), to deal in the Software without restriction, including      --
+-- without limitation the rights to use, copy, modify, merge, publish,      --
+-- distribute, distribute with modifications, sublicense, and/or sell       --
+-- copies of the Software, and to permit persons to whom the Software is    --
+-- furnished to do so, subject to the following conditions:                 --
 --                                                                          --
---  The ncurses Ada95 binding is copyrighted 1996 by                        --
---  Juergen Pfeifer, Email: Juergen.Pfeifer@T-Online.de                     --
+-- The above copyright notice and this permission notice shall be included  --
+-- in all copies or substantial portions of the Software.                   --
 --                                                                          --
---  Permission is hereby granted to reproduce and distribute this           --
---  binding by any means and for any fee, whether alone or as part          --
---  of a larger distribution, in source or in binary form, PROVIDED         --
---  this notice is included with any such distribution, and is not          --
---  removed from any of its header files. Mention of ncurses and the        --
---  author of this binding in any applications linked with it is            --
---  highly appreciated.                                                     --
+-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  --
+-- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               --
+-- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   --
+-- IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   --
+-- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    --
+-- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    --
+-- THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               --
 --                                                                          --
---  This binding comes AS IS with no warranty, implied or expressed.        --
+-- Except as contained in this notice, the name(s) of the above copyright   --
+-- holders shall not be used in advertising or otherwise to promote the     --
+-- sale, use or other dealings in this Software without prior written       --
+-- authorization.                                                           --
 ------------------------------------------------------------------------------
+--  Author:  Juergen Pfeifer, 1996
 --  Version Control:
---  $Revision: 1.6 $
+--  $Revision: 1.27 $
+--  $Date: 2006/06/25 14:30:22 $
+--  Binding Version 01.00
 ------------------------------------------------------------------------------
 include(`Mouse_Base_Defs')
 with System;
 
 package Terminal_Interface.Curses.Mouse is
+   pragma Preelaborate (Terminal_Interface.Curses.Mouse);
 
    --  MANPAGE(`curs_mouse.3x')
    --  Please note, that in ncurses-1.9.9e documentation mouse support
    --  is still marked as experimental. So also this binding will change
    --  if the ncurses methods change.
    --
+   --  mouse_trafo, wmouse_trafo are implemented as Transform_Coordinates
+   --  in the parent package.
+   --
+   --  Not implemented:
+   --  REPORT_MOUSE_POSITION (i.e. as a parameter to Register_Reportable_Event
+   --  or Start_Mouse)
    type Event_Mask is private;
    No_Events  : constant Event_Mask;
    All_Events : constant Event_Mask;
@@ -49,36 +71,64 @@ package Terminal_Interface.Curses.Mouse is
                          Shift,    -- Shift Key
                          Alt);     -- ALT Key
 
+   subtype Real_Buttons  is Mouse_Button range Left .. Button4;
+   subtype Modifier_Keys is Mouse_Button range Control .. Alt;
+
    type Button_State is (Released,
                          Pressed,
                          Clicked,
                          Double_Clicked,
                          Triple_Clicked);
 
+   type Button_States is array (Button_State) of Boolean;
+   pragma Pack (Button_States);
+
+   All_Clicks : constant Button_States := (Clicked .. Triple_Clicked => True,
+                                           others => False);
+   All_States : constant Button_States := (others => True);
+
    type Mouse_Event is private;
 
    --  MANPAGE(`curs_mouse.3x')
 
+   function Has_Mouse return Boolean;
+   --  Return true if a mouse device is supported, false otherwise.
+
    procedure Register_Reportable_Event
-     (B    : in Mouse_Button;
-      S    : in Button_State;
-      Mask : in out Event_Mask);
+     (Button : in Mouse_Button;
+      State  : in Button_State;
+      Mask   : in out Event_Mask);
    --  Stores the event described by the button and the state in the mask.
    --  Before you call this the first time, you should init the mask
    --  with the Empty_Mask constant
+   pragma Inline (Register_Reportable_Event);
+
+   procedure Register_Reportable_Events
+     (Button : in Mouse_Button;
+      State  : in Button_States;
+      Mask   : in out Event_Mask);
+   --  Register all events described by the Button and the State bitmap.
+   --  Before you call this the first time, you should init the mask
+   --  with the Empty_Mask constant
 
    --  ANCHOR(`mousemask()',`Start_Mouse')
+   --  There is one difference to mousmask(): we return the value of the
+   --  old mask, that means the event mask value before this call.
+   --  Not Implemented: The library version
+   --  returns a Mouse_Mask that tells which events are reported.
    function Start_Mouse (Mask : Event_Mask := All_Events)
                          return Event_Mask;
    --  AKA
+   pragma Inline (Start_Mouse);
 
-   procedure End_Mouse;
-   pragma Import (C, End_Mouse, "_nc_ada_unregister_mouse");
-   --  Terminates the mouse
+   procedure End_Mouse (Mask : in Event_Mask := No_Events);
+   --  Terminates the mouse, restores the specified event mask
+   pragma Inline (End_Mouse);
 
    --  ANCHOR(`getmouse()',`Get_Mouse')
    function Get_Mouse return Mouse_Event;
    --  AKA
+   pragma Inline (Get_Mouse);
 
    procedure Get_Event (Event  : in  Mouse_Event;
                         Y      : out Line_Position;
@@ -87,39 +137,46 @@ package Terminal_Interface.Curses.Mouse is
                         State  : out Button_State);
    --  !!! Warning: X and Y are screen coordinates. Due to ripped of lines they
    --  may not be identical to window coordinates.
+   --  Not Implemented: Get_Event only reports one event, the C library
+   --  version supports multiple events, e.g. {click-1, click-3}
+   pragma Inline (Get_Event);
 
    --  ANCHOR(`ungetmouse()',`Unget_Mouse')
    procedure Unget_Mouse (Event : in Mouse_Event);
    --  AKA
+   pragma Inline (Unget_Mouse);
 
    --  ANCHOR(`wenclose()',`Enclosed_In_Window')
    function Enclosed_In_Window (Win    : Window := Standard_Window;
                                 Event  : Mouse_Event) return Boolean;
    --  AKA
    --  But : use event instead of screen coordinates.
+   pragma Inline (Enclosed_In_Window);
 
    --  ANCHOR(`mouseinterval()',`Mouse_Interval')
    function Mouse_Interval (Msec : Natural := 200) return Natural;
    --  AKA
+   pragma Inline (Mouse_Interval);
 
 private
-   type Event_Mask is new Interfaces.C.int;
-   No_Events  : constant Event_Mask := 0;
-   All_Events : constant Event_Mask := -1;
+   type Event_Mask is new Interfaces.C.unsigned_long;
 
    type Mouse_Event is
       record
          Id      : Integer range Integer (Interfaces.C.short'First) ..
-                                 Integer (Interfaces.C.Short'Last);
+                                 Integer (Interfaces.C.short'Last);
          X, Y, Z : Integer range Integer (Interfaces.C.int'First) ..
                                  Integer (Interfaces.C.int'Last);
          Bstate  : Event_Mask;
       end record;
    pragma Convention (C, Mouse_Event);
-   pragma Pack (Mouse_Event);
 
 include(`Mouse_Event_Rep')
    Generation_Bit_Order : constant System.Bit_Order := System.M4_BIT_ORDER;
    --  This constant may be different on your system.
 
+include(`Mouse_Events')
+   No_Events  : constant Event_Mask := 0;
+   All_Events : constant Event_Mask := ALL_MOUSE_EVENTS;
+
 end Terminal_Interface.Curses.Mouse;