ncurses 5.9 - patch 20110924
[ncurses.git] / Ada95 / samples / ncurses2-trace_set.adb
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                       GNAT ncurses Binding Samples                       --
4 --                                                                          --
5 --                            ncurses2.trace_set                            --
6 --                                                                          --
7 --                                 B O D Y                                  --
8 --                                                                          --
9 ------------------------------------------------------------------------------
10 -- Copyright (c) 2000-2008,2011 Free Software Foundation, Inc.              --
11 --                                                                          --
12 -- Permission is hereby granted, free of charge, to any person obtaining a  --
13 -- copy of this software and associated documentation files (the            --
14 -- "Software"), to deal in the Software without restriction, including      --
15 -- without limitation the rights to use, copy, modify, merge, publish,      --
16 -- distribute, distribute with modifications, sublicense, and/or sell       --
17 -- copies of the Software, and to permit persons to whom the Software is    --
18 -- furnished to do so, subject to the following conditions:                 --
19 --                                                                          --
20 -- The above copyright notice and this permission notice shall be included  --
21 -- in all copies or substantial portions of the Software.                   --
22 --                                                                          --
23 -- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  --
24 -- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               --
25 -- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   --
26 -- IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   --
27 -- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    --
28 -- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    --
29 -- THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               --
30 --                                                                          --
31 -- Except as contained in this notice, the name(s) of the above copyright   --
32 -- holders shall not be used in advertising or otherwise to promote the     --
33 -- sale, use or other dealings in this Software without prior written       --
34 -- authorization.                                                           --
35 ------------------------------------------------------------------------------
36 --  Author: Eugene V. Melaragno <aldomel@ix.netcom.com> 2000
37 --  Version Control
38 --  $Revision: 1.5 $
39 --  $Date: 2011/03/23 00:40:33 $
40 --  Binding Version 01.00
41 ------------------------------------------------------------------------------
42 with ncurses2.util; use ncurses2.util;
43 with Terminal_Interface.Curses; use Terminal_Interface.Curses;
44 with Terminal_Interface.Curses.Trace; use Terminal_Interface.Curses.Trace;
45 with Terminal_Interface.Curses.Menus; use Terminal_Interface.Curses.Menus;
46
47 with Ada.Strings.Bounded;
48
49 --  interactively set the trace level
50
51 procedure ncurses2.trace_set is
52
53    function menu_virtualize (c : Key_Code) return Key_Code;
54    function subset (super, sub : Trace_Attribute_Set) return Boolean;
55    function trace_or (a, b : Trace_Attribute_Set) return Trace_Attribute_Set;
56    function trace_num (tlevel : Trace_Attribute_Set) return String;
57    function tracetrace (tlevel : Trace_Attribute_Set) return String;
58    function run_trace_menu (m : Menu; count : Integer) return Boolean;
59
60    function menu_virtualize (c : Key_Code) return Key_Code is
61    begin
62       case c is
63          when Character'Pos (newl) | Key_Exit =>
64             return Menu_Request_Code'Last + 1; --  MAX_COMMAND? TODO
65          when Character'Pos ('u') =>
66             return M_ScrollUp_Line;
67          when Character'Pos ('d') =>
68             return M_ScrollDown_Line;
69          when Character'Pos ('b') | Key_Next_Page =>
70             return M_ScrollUp_Page;
71          when Character'Pos ('f') | Key_Previous_Page =>
72             return M_ScrollDown_Page;
73          when Character'Pos ('n') | Key_Cursor_Down =>
74             return M_Next_Item;
75          when Character'Pos ('p') | Key_Cursor_Up =>
76             return M_Previous_Item;
77          when Character'Pos (' ') =>
78             return M_Toggle_Item;
79          when Key_Mouse =>
80             return c;
81          when others =>
82             Beep;
83             return c;
84       end case;
85    end menu_virtualize;
86
87    type string_a is access String;
88    type tbl_entry is record
89       name : string_a;
90       mask : Trace_Attribute_Set;
91    end record;
92
93    t_tbl : constant array (Positive range <>) of tbl_entry :=
94      (
95       (new String'("Disable"),
96        Trace_Disable),
97       (new String'("Times"),
98        Trace_Attribute_Set'(Times => True, others => False)),
99       (new String'("Tputs"),
100        Trace_Attribute_Set'(Tputs => True, others => False)),
101       (new String'("Update"),
102        Trace_Attribute_Set'(Update => True, others => False)),
103       (new String'("Cursor_Move"),
104        Trace_Attribute_Set'(Cursor_Move => True, others => False)),
105       (new String'("Character_Output"),
106        Trace_Attribute_Set'(Character_Output => True, others => False)),
107       (new String'("Ordinary"),
108        Trace_Ordinary),
109       (new String'("Calls"),
110        Trace_Attribute_Set'(Calls => True, others => False)),
111       (new String'("Virtual_Puts"),
112        Trace_Attribute_Set'(Virtual_Puts => True, others => False)),
113       (new String'("Input_Events"),
114        Trace_Attribute_Set'(Input_Events => True, others => False)),
115       (new String'("TTY_State"),
116        Trace_Attribute_Set'(TTY_State => True, others => False)),
117       (new String'("Internal_Calls"),
118        Trace_Attribute_Set'(Internal_Calls => True, others => False)),
119       (new String'("Character_Calls"),
120        Trace_Attribute_Set'(Character_Calls => True, others => False)),
121       (new String'("Termcap_TermInfo"),
122        Trace_Attribute_Set'(Termcap_TermInfo => True, others => False)),
123       (new String'("Maximium"),
124        Trace_Maximum)
125       );
126
127    package BS is new Ada.Strings.Bounded.Generic_Bounded_Length (300);
128
129    function subset (super, sub : Trace_Attribute_Set) return Boolean is
130    begin
131       if
132         (super.Times or not sub.Times) and
133         (super.Tputs or not sub.Tputs) and
134         (super.Update or not sub.Update) and
135         (super.Cursor_Move or not sub.Cursor_Move) and
136         (super.Character_Output or not sub.Character_Output) and
137         (super.Calls or not sub.Calls) and
138         (super.Virtual_Puts or not sub.Virtual_Puts) and
139         (super.Input_Events or not sub.Input_Events) and
140         (super.TTY_State or not sub.TTY_State) and
141         (super.Internal_Calls or not sub.Internal_Calls) and
142         (super.Character_Calls or not sub.Character_Calls) and
143         (super.Termcap_TermInfo or not sub.Termcap_TermInfo) and
144         True then
145          return True;
146       else
147          return False;
148       end if;
149    end subset;
150
151    function trace_or (a, b : Trace_Attribute_Set) return Trace_Attribute_Set is
152       retval : Trace_Attribute_Set := Trace_Disable;
153    begin
154       retval.Times := (a.Times or b.Times);
155       retval.Tputs := (a.Tputs or b.Tputs);
156       retval.Update := (a.Update or b.Update);
157       retval.Cursor_Move := (a.Cursor_Move or b.Cursor_Move);
158       retval.Character_Output := (a.Character_Output or b.Character_Output);
159       retval.Calls := (a.Calls or b.Calls);
160       retval.Virtual_Puts := (a.Virtual_Puts or b.Virtual_Puts);
161       retval.Input_Events := (a.Input_Events or b.Input_Events);
162       retval.TTY_State := (a.TTY_State or b.TTY_State);
163       retval.Internal_Calls := (a.Internal_Calls or b.Internal_Calls);
164       retval.Character_Calls := (a.Character_Calls or b.Character_Calls);
165       retval.Termcap_TermInfo := (a.Termcap_TermInfo or b.Termcap_TermInfo);
166
167       return retval;
168    end trace_or;
169
170    --  Print the hexadecimal value of the mask so
171    --  users can set it from the command line.
172
173    function trace_num (tlevel : Trace_Attribute_Set) return String is
174       result : Integer := 0;
175       m : Integer := 1;
176    begin
177
178       if tlevel.Times then
179          result := result + m;
180       end if;
181       m := m * 2;
182
183       if tlevel.Tputs then
184          result := result + m;
185       end if;
186       m := m * 2;
187
188       if tlevel.Update then
189          result := result + m;
190       end if;
191       m := m * 2;
192
193       if tlevel.Cursor_Move then
194          result := result + m;
195       end if;
196       m := m * 2;
197
198       if tlevel.Character_Output then
199          result := result + m;
200       end if;
201       m := m * 2;
202
203       if tlevel.Calls then
204          result := result + m;
205       end if;
206       m := m * 2;
207
208       if tlevel.Virtual_Puts then
209          result := result + m;
210       end if;
211       m := m * 2;
212
213       if tlevel.Input_Events then
214          result := result + m;
215       end if;
216       m := m * 2;
217
218       if tlevel.TTY_State then
219          result := result + m;
220       end if;
221       m := m * 2;
222
223       if tlevel.Internal_Calls then
224          result := result + m;
225       end if;
226       m := m * 2;
227
228       if tlevel.Character_Calls then
229          result := result + m;
230       end if;
231       m := m * 2;
232
233       if tlevel.Termcap_TermInfo then
234          result := result + m;
235       end if;
236       m := m * 2;
237       return result'Img;
238    end trace_num;
239
240    function tracetrace (tlevel : Trace_Attribute_Set) return String is
241
242       use BS;
243       buf : Bounded_String := To_Bounded_String ("");
244    begin
245       --  The C version prints the hexadecimal value of the mask, we
246       --  won't do that here because this is Ada.
247
248       if tlevel = Trace_Disable then
249          Append (buf, "Trace_Disable");
250       else
251
252          if subset (tlevel,
253                     Trace_Attribute_Set'(Times => True, others => False)) then
254             Append (buf, "Times");
255             Append (buf, ", ");
256          end if;
257
258          if subset (tlevel,
259                     Trace_Attribute_Set'(Tputs => True, others => False)) then
260             Append (buf, "Tputs");
261             Append (buf, ", ");
262          end if;
263
264          if subset (tlevel,
265                     Trace_Attribute_Set'(Update => True, others => False)) then
266             Append (buf, "Update");
267             Append (buf, ", ");
268          end if;
269
270          if subset (tlevel,
271                     Trace_Attribute_Set'(Cursor_Move => True,
272                                          others => False)) then
273             Append (buf, "Cursor_Move");
274             Append (buf, ", ");
275          end if;
276
277          if subset (tlevel,
278                     Trace_Attribute_Set'(Character_Output => True,
279                                          others => False)) then
280             Append (buf, "Character_Output");
281             Append (buf, ", ");
282          end if;
283
284          if subset (tlevel,
285                     Trace_Ordinary) then
286             Append (buf, "Ordinary");
287             Append (buf, ", ");
288          end if;
289
290          if subset (tlevel,
291                     Trace_Attribute_Set'(Calls => True, others => False)) then
292             Append (buf, "Calls");
293             Append (buf, ", ");
294          end if;
295
296          if subset (tlevel,
297                     Trace_Attribute_Set'(Virtual_Puts => True,
298                                          others => False)) then
299             Append (buf, "Virtual_Puts");
300             Append (buf, ", ");
301          end if;
302
303          if subset (tlevel,
304                     Trace_Attribute_Set'(Input_Events => True,
305                                          others => False)) then
306             Append (buf, "Input_Events");
307             Append (buf, ", ");
308          end if;
309
310          if subset (tlevel,
311                     Trace_Attribute_Set'(TTY_State => True,
312                                          others => False)) then
313             Append (buf, "TTY_State");
314             Append (buf, ", ");
315          end if;
316
317          if subset (tlevel,
318                     Trace_Attribute_Set'(Internal_Calls => True,
319                                          others => False)) then
320             Append (buf, "Internal_Calls");
321             Append (buf, ", ");
322          end if;
323
324          if subset (tlevel,
325                     Trace_Attribute_Set'(Character_Calls => True,
326                                          others => False)) then
327             Append (buf, "Character_Calls");
328             Append (buf, ", ");
329          end if;
330
331          if subset (tlevel,
332                     Trace_Attribute_Set'(Termcap_TermInfo => True,
333                                          others => False)) then
334             Append (buf, "Termcap_TermInfo");
335             Append (buf, ", ");
336          end if;
337
338          if subset (tlevel,
339                     Trace_Maximum) then
340             Append (buf, "Maximium");
341             Append (buf, ", ");
342          end if;
343       end if;
344
345       if To_String (buf) (Length (buf) - 1) = ',' then
346          Delete (buf, Length (buf) - 1, Length (buf));
347       end if;
348
349       return To_String (buf);
350    end tracetrace;
351
352    function run_trace_menu (m : Menu; count : Integer) return Boolean is
353       i, p : Item;
354       changed : Boolean;
355       c, v : Key_Code;
356    begin
357       loop
358          changed := (count /= 0);
359          c := Getchar (Get_Window (m));
360          v := menu_virtualize (c);
361          case Driver (m, v) is
362             when Unknown_Request =>
363                return False;
364             when others =>
365                i := Current (m);
366                if i = Menus.Items (m, 1) then -- the first item
367                   for n in t_tbl'First + 1 .. t_tbl'Last loop
368                      if Value (i) then
369                         Set_Value (i, False);
370                         changed := True;
371                      end if;
372                   end loop;
373                else
374                   for n in t_tbl'First + 1 .. t_tbl'Last loop
375                      p := Menus.Items (m, n);
376                      if Value (p) then
377                         Set_Value (Menus.Items (m, 1), False);
378                         changed := True;
379                         exit;
380                      end if;
381                   end loop;
382                end if;
383                if not changed then
384                   return True;
385                end if;
386          end case;
387       end loop;
388    end run_trace_menu;
389
390    nc_tracing, mask : Trace_Attribute_Set;
391    pragma Import (C, nc_tracing, "_nc_tracing");
392    items_a : constant Item_Array_Access :=
393      new Item_Array (t_tbl'First .. t_tbl'Last + 1);
394    mrows : Line_Count;
395    mcols : Column_Count;
396    menuwin : Window;
397    menu_y : constant Line_Position := 8;
398    menu_x : constant Column_Position := 8;
399    ip : Item;
400    m : Menu;
401    count : Integer;
402    newtrace : Trace_Attribute_Set;
403 begin
404    Add (Line => 0, Column => 0, Str => "Interactively set trace level:");
405    Add (Line => 2, Column => 0,
406         Str => "  Press space bar to toggle a selection.");
407    Add (Line => 3, Column => 0,
408         Str => "  Use up and down arrow to move the select bar.");
409    Add (Line => 4, Column => 0,
410         Str => "  Press return to set the trace level.");
411    Add (Line => 6, Column => 0, Str => "(Current trace level is ");
412    Add (Str => tracetrace (nc_tracing) & " numerically: " &
413         trace_num (nc_tracing));
414    Add (Ch => ')');
415
416    Refresh;
417
418    for n in t_tbl'Range loop
419       items_a.all (n) := New_Item (t_tbl (n).name.all);
420    end loop;
421    items_a.all (t_tbl'Last + 1) := Null_Item;
422
423    m := New_Menu (items_a);
424
425    Set_Format (m, 16, 2);
426    Scale (m, mrows, mcols);
427
428    Switch_Options (m, (One_Valued => True, others => False), On => False);
429    menuwin := New_Window (mrows + 2, mcols + 2, menu_y, menu_x);
430    Set_Window (m, menuwin);
431    Set_KeyPad_Mode (menuwin, SwitchOn => True);
432    Box (menuwin);
433
434    Set_Sub_Window (m, Derived_Window (menuwin, mrows, mcols, 1, 1));
435
436    Post (m);
437
438    for n in t_tbl'Range loop
439       ip := Items (m, n);
440       mask := t_tbl (n).mask;
441       if mask = Trace_Disable then
442          Set_Value (ip, nc_tracing = Trace_Disable);
443       elsif subset (sub => mask, super => nc_tracing) then
444          Set_Value (ip, True);
445       end if;
446    end loop;
447
448    count := 1;
449    while run_trace_menu (m, count) loop
450       count := count + 1;
451    end loop;
452
453    newtrace := Trace_Disable;
454    for n in t_tbl'Range loop
455       ip := Items (m, n);
456       if Value (ip) then
457          mask := t_tbl (n).mask;
458          newtrace := trace_or (newtrace, mask);
459       end if;
460    end loop;
461
462    Trace_On (newtrace);
463    Trace_Put ("trace level interactively set to " &
464               tracetrace (nc_tracing));
465
466    Move_Cursor (Line => Lines - 4, Column => 0);
467    Add (Str => "Trace level is ");
468    Add (Str => tracetrace (nc_tracing));
469    Add (Ch => newl);
470    Pause; -- was just Add(); Getchar
471
472    Post (m, False);
473    --  menuwin has subwindows I think, which makes an error.
474    declare begin
475       Delete (menuwin);
476    exception when Curses_Exception => null; end;
477
478    --  free_menu(m);
479    --  free_item()
480 end ncurses2.trace_set;