OSDN Git Service

* 5ataprop.adb, 5atpopsp.adb, 5ftaprop.adb, 5gmastop.adb,
[pf3gnuchains/gcc-fork.git] / gcc / ada / g-expect.ads
1 ------------------------------------------------------------------------------
2 --                                                                          --
3 --                         GNAT LIBRARY COMPONENTS                          --
4 --                                                                          --
5 --                          G N A T . E X P E C T                           --
6 --                                                                          --
7 --                                 S p e c                                  --
8 --                                                                          --
9 --                            $Revision: 1.1 $
10 --                                                                          --
11 --           Copyright (C) 2000-2001 Ada Core Technologies, Inc.            --
12 --                                                                          --
13 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
14 -- terms of the  GNU General Public License as published  by the Free Soft- --
15 -- ware  Foundation;  either version 2,  or (at your option) any later ver- --
16 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
17 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
18 -- or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License --
19 -- for  more details.  You should have  received  a copy of the GNU General --
20 -- Public License  distributed with GNAT;  see file COPYING.  If not, write --
21 -- to  the Free Software Foundation,  59 Temple Place - Suite 330,  Boston, --
22 -- MA 02111-1307, USA.                                                      --
23 --                                                                          --
24 -- As a special exception,  if other files  instantiate  generics from this --
25 -- unit, or you link  this unit with other files  to produce an executable, --
26 -- this  unit  does not  by itself cause  the resulting  executable  to  be --
27 -- covered  by the  GNU  General  Public  License.  This exception does not --
28 -- however invalidate  any other reasons why  the executable file  might be --
29 -- covered by the  GNU Public License.                                      --
30 --                                                                          --
31 -- GNAT is maintained by Ada Core Technologies Inc (http://www.gnat.com).   --
32 --                                                                          --
33 ------------------------------------------------------------------------------
34
35 --  Currently this package is implemented on all native GNAT ports except
36 --  for VMS. It is not yet implemented for any of the cross-ports (e.g. it
37 --  is not available for VxWorks or LynxOS).
38 --
39 --  Usage
40 --  =====
41 --
42 --  This package provides a set of subprograms similar to what is available
43 --  with the standard Tcl Expect tool.
44
45 --  It allows you to easily spawn and communicate with an external process.
46 --  You can send commands or inputs to the process, and compare the output
47 --  with some expected regular expression.
48 --
49 --  Usage example:
50 --
51 --      Non_Blocking_Spawn (Fd, "ftp machine@domaine");
52 --      Timeout := 10000;  --  10 seconds
53 --      Expect (Fd, Result, Regexp_Array'(+"\(user\)", +"\(passwd\)"),
54 --              Timeout);
55 --      case Result is
56 --         when 1 => Send (Fd, "my_name");   --  matched "user"
57 --         when 2 => Send (Fd, "my_passwd"); --  matched "passwd"
58 --         when Expect_Timeout => null;      --  timeout
59 --         when others => null;
60 --      end case;
61 --      Close (Fd);
62 --
63 --  You can also combine multiple regular expressions together, and get the
64 --  specific string matching a parenthesis pair by doing something like. If you
65 --  expect either "lang=optional ada" or "lang=ada" from the external process,
66 --  you can group the two together, which is more efficient, and simply get the
67 --  name of the language by doing:
68 --
69 --      declare
70 --         Matched : Regexp_Array (0 .. 2);
71 --      begin
72 --         Expect (Fd, Result, "lang=(optional)? ([a-z]+)", Matched);
73 --         Put_Line ("Seen: " &
74 --                   Expect_Out (Fd) (Matched (2).First .. Matched (2).Last));
75 --      end;
76 --
77 --  Alternatively, you might choose to use a lower-level interface to the
78 --  processes, where you can give your own input and output filters every
79 --  time characters are read from or written to the process.
80 --
81 --      procedure My_Filter (Descriptor : Process_Descriptor; Str : String) is
82 --      begin
83 --         Put_Line (Str);
84 --      end;
85 --
86 --      Fd := Non_Blocking_Spawn ("tail -f a_file");
87 --      Add_Filter (Fd, My_Filter'Access, Output);
88 --      Expect (Fd, Result, "", 0);  --  wait forever
89 --
90 --  The above example should probably be run in a separate task, since it is
91 --  blocking on the call to Expect.
92 --
93 --  Both examples can be combined, for instance to systematically print the
94 --  output seen by expect, even though you still want to let Expect do the
95 --  filtering. You can use the Trace_Filter subprogram for such a filter.
96 --
97 --  If you want to get the output of a simple command, and ignore any previous
98 --  existing output, it is recommended to do something like:
99 --
100 --      Expect (Fd, Result, ".*", Timeout => 0);
101 --            -- empty the buffer, by matching everything (after checking
102 --            -- if there was any input).
103 --      Send (Fd, "command");
104 --      Expect (Fd, Result, ".."); -- match only on the output of command
105 --
106 --  Task Safety
107 --  ===========
108 --
109 --  This package is not task-safe. However, you can easily make is task safe
110 --  by encapsulating the type Process_Descriptor in a protected record.
111 --  There should not be concurrent calls to Expect.
112
113 with System;
114 with GNAT.OS_Lib;
115 with GNAT.Regpat;
116
117 package GNAT.Expect is
118
119    type Process_Id is new Integer;
120    Invalid_Pid : constant Process_Id := -1;
121    Null_Pid    : constant Process_Id := 0;
122
123    type Filter_Type is (Output, Input, Died);
124    --  The signals that are emitted by the Process_Descriptor upon state
125    --  changed in the child. One can connect to any of this signal through
126    --  the Add_Filter subprograms.
127    --
128    --     Output => Every time new characters are read from the process
129    --               associated with Descriptor, the filter is called with
130    --               these new characters in argument.
131    --
132    --               Note that output is only generated when the program is
133    --               blocked in a call to Expect.
134    --
135    --     Input  => Every time new characters are written to the process
136    --               associated with Descriptor, the filter is called with
137    --               these new characters in argument.
138    --               Note that input is only generated by calls to Send.
139    --
140    --     Died   => The child process has died, or was explicitly killed
141
142    type Process_Descriptor is tagged private;
143    --  Contains all the components needed to describe a process handled
144    --  in this package, including a process identifier, file descriptors
145    --  associated with the standard input, output and error, and the buffer
146    --  needed to handle the expect calls.
147
148    type Process_Descriptor_Access is access Process_Descriptor'Class;
149
150    ------------------------
151    -- Spawning a process --
152    ------------------------
153
154    procedure Non_Blocking_Spawn
155      (Descriptor  : out Process_Descriptor'Class;
156       Command     : String;
157       Args        : GNAT.OS_Lib.Argument_List;
158       Buffer_Size : Natural := 4096;
159       Err_To_Out  : Boolean := False);
160    --  This call spawns a new process and allows sending commands to
161    --  the process and/or automatic parsing of the output.
162    --
163    --  The expect buffer associated with that process can contain at most
164    --  Buffer_Size characters. Older characters are simply discarded when
165    --  this buffer is full. Beware that if the buffer is too big, this could
166    --  slow down the Expect calls if not output is matched, since Expect has
167    --  to match all the regexp against all the characters in the buffer.
168    --  If Buffer_Size is 0, there is no limit (ie all the characters are kept
169    --  till Expect matches), but this is slower.
170    --
171    --  If Err_To_Out is True, then the standard error of the spawned process is
172    --  connected to the standard output. This is the only way to get the
173    --  Except subprograms also match on output on standard error.
174    --
175    --  Invalid_Process is raised if the process could not be spawned.
176
177    procedure Close (Descriptor : in out Process_Descriptor);
178    --  Terminate the process and close the pipes to it. It implicitly
179    --  does the 'wait' command required to clean up the process table.
180    --  This also frees the buffer associated with the process id.
181
182    procedure Send_Signal
183      (Descriptor : Process_Descriptor;
184       Signal     : Integer);
185    --  Send a given signal to the process.
186
187    procedure Interrupt (Descriptor : in out Process_Descriptor);
188    --  Interrupt the process (the equivalent of Ctrl-C on unix and windows)
189    --  and call close if the process dies.
190
191    function Get_Input_Fd
192      (Descriptor : Process_Descriptor)
193       return       GNAT.OS_Lib.File_Descriptor;
194    --  Return the input file descriptor associated with Descriptor.
195
196    function Get_Output_Fd
197      (Descriptor : Process_Descriptor)
198       return       GNAT.OS_Lib.File_Descriptor;
199    --  Return the output file descriptor associated with Descriptor.
200
201    function Get_Error_Fd
202      (Descriptor : Process_Descriptor)
203       return       GNAT.OS_Lib.File_Descriptor;
204    --  Return the error output file descriptor associated with Descriptor.
205
206    function Get_Pid
207      (Descriptor : Process_Descriptor)
208       return       Process_Id;
209    --  Return the process id associated with a given process descriptor.
210
211    --------------------
212    -- Adding filters --
213    --------------------
214
215    --  This is a rather low-level interface to subprocesses, since basically
216    --  the filtering is left entirely to the user. See the Expect subprograms
217    --  below for higher level functions.
218
219    type Filter_Function is access
220      procedure
221        (Descriptor : Process_Descriptor'Class;
222         Str        : String;
223         User_Data  : System.Address := System.Null_Address);
224    --  Function called every time new characters are read from or written
225    --  to the process.
226    --
227    --  Str is a string of all these characters.
228    --
229    --  User_Data, if specified, is a user specific data that will be passed to
230    --  the filter. Note that no checks are done on this parameter that should
231    --  be used with cautiousness.
232
233    procedure Add_Filter
234      (Descriptor : in out Process_Descriptor;
235       Filter     : Filter_Function;
236       Filter_On  : Filter_Type := Output;
237       User_Data  : System.Address := System.Null_Address;
238       After      : Boolean := False);
239    --  Add a new filter for one of the filter type. This filter will be
240    --  run before all the existing filters, unless After is set True,
241    --  in which case it will be run after existing filters. User_Data
242    --  is passed as is to the filter procedure.
243
244    procedure Remove_Filter
245      (Descriptor : in out Process_Descriptor;
246       Filter     : Filter_Function);
247    --  Remove a filter from the list of filters (whatever the type of the
248    --  filter).
249
250    procedure Trace_Filter
251      (Descriptor : Process_Descriptor'Class;
252       Str        : String;
253       User_Data  : System.Address := System.Null_Address);
254    --  Function that can be used a filter and that simply outputs Str on
255    --  Standard_Output. This is mainly used for debugging purposes.
256    --  User_Data is ignored.
257
258    procedure Lock_Filters (Descriptor : in out Process_Descriptor);
259    --  Temporarily disables all output and input filters. They will be
260    --  reactivated only when Unlock_Filters has been called as many times as
261    --  Lock_Filters;
262
263    procedure Unlock_Filters (Descriptor : in out Process_Descriptor);
264    --  Unlocks the filters. They are reactivated only if Unlock_Filters
265    --  has been called as many times as Lock_Filters.
266
267    ------------------
268    -- Sending data --
269    ------------------
270
271    procedure Send
272      (Descriptor   : in out Process_Descriptor;
273       Str          : String;
274       Add_LF       : Boolean := True;
275       Empty_Buffer : Boolean := False);
276    --  Send a string to the file descriptor.
277    --
278    --  The string is not formatted in any way, except if Add_LF is True,
279    --  in which case an ASCII.LF is added at the end, so that Str is
280    --  recognized as a command by the external process.
281    --
282    --  If Empty_Buffer is True, any input waiting from the process (or in the
283    --  buffer) is first discarded before the command is sent. The output
284    --  filters are of course called as usual.
285
286    -----------------------------------------------------------
287    -- Working on the output (single process, simple regexp) --
288    -----------------------------------------------------------
289
290    type Expect_Match is new Integer;
291    Expect_Full_Buffer : constant Expect_Match := -1;
292    --  If the buffer was full and some characters were discarded.
293
294    Expect_Timeout : constant Expect_Match := -2;
295    --  If not output matching the regexps was found before the timeout.
296
297    function "+" (S : String) return GNAT.OS_Lib.String_Access;
298    --  Allocate some memory for the string. This is merely a convenience
299    --  convenience function to help create the array of regexps in the
300    --  call to Expect.
301
302    procedure Expect
303      (Descriptor  : in out Process_Descriptor;
304       Result      : out Expect_Match;
305       Regexp      : String;
306       Timeout     : Integer := 10000;
307       Full_Buffer : Boolean := False);
308    --  Wait till a string matching Fd can be read from Fd, and return 1
309    --  if a match was found.
310    --
311    --  It consumes all the characters read from Fd until a match found, and
312    --  then sets the return values for the subprograms Expect_Out and
313    --  Expect_Out_Match.
314    --
315    --  The empty string "" will never match, and can be used if you only want
316    --  to match after a specific timeout. Beware that if Timeout is -1 at the
317    --  time, the current task will be blocked forever.
318    --
319    --  This command times out after Timeout milliseconds (or never if Timeout
320    --  is -1). In that case, Expect_Timeout is returned. The value returned by
321    --  Expect_Out and Expect_Out_Match are meaningless in that case.
322    --
323    --  Note that using a timeout of 0ms leads to unpredictable behavior, since
324    --  the result depends on whether the process has already sent some output
325    --  the first time Expect checks, and this depends on the operating system.
326    --
327    --  The regular expression must obey the syntax described in GNAT.Regpat.
328    --
329    --  If Full_Buffer is True, then Expect will match if the buffer was too
330    --  small and some characters were about to be discarded. In that case,
331    --  Expect_Full_Buffer is returned.
332
333    procedure Expect
334      (Descriptor  : in out Process_Descriptor;
335       Result      : out Expect_Match;
336       Regexp      : GNAT.Regpat.Pattern_Matcher;
337       Timeout     : Integer := 10000;
338       Full_Buffer : Boolean := False);
339    --  Same as the previous one, but with a precompiled regular expression.
340    --  This is more efficient however, especially if you are using this
341    --  expression multiple times, since this package won't need to recompile
342    --  the regexp every time.
343
344    procedure Expect
345      (Descriptor  : in out Process_Descriptor;
346       Result      : out Expect_Match;
347       Regexp      : String;
348       Matched     : out GNAT.Regpat.Match_Array;
349       Timeout     : Integer := 10000;
350       Full_Buffer : Boolean := False);
351    --  Same as above, but it is now possible to get the indexes of the
352    --  substrings for the parentheses in the regexp (see the example at the
353    --  top of this package, as well as the documentation in the package
354    --  GNAT.Regpat).
355    --
356    --  Matched'First should be 0, and this index will contain the indexes for
357    --  the whole string that was matched. The index 1 will contain the indexes
358    --  for the first parentheses-pair, and so on.
359
360    ------------
361    -- Expect --
362    ------------
363
364    procedure Expect
365      (Descriptor  : in out Process_Descriptor;
366       Result      : out Expect_Match;
367       Regexp      : GNAT.Regpat.Pattern_Matcher;
368       Matched     : out GNAT.Regpat.Match_Array;
369       Timeout     : Integer := 10000;
370       Full_Buffer : Boolean := False);
371    --  Same as above, but with a precompiled regular expression.
372
373    -------------------------------------------------------------
374    -- Working on the output (single process, multiple regexp) --
375    -------------------------------------------------------------
376
377    type Regexp_Array is array (Positive range <>) of GNAT.OS_Lib.String_Access;
378
379    type Pattern_Matcher_Access is access GNAT.Regpat.Pattern_Matcher;
380    type Compiled_Regexp_Array is array (Positive range <>)
381      of Pattern_Matcher_Access;
382
383    function "+"
384      (P    : GNAT.Regpat.Pattern_Matcher)
385       return Pattern_Matcher_Access;
386    --  Allocate some memory for the pattern matcher.
387    --  This is only a convenience function to help create the array of
388    --  compiled regular expressoins.
389
390    procedure Expect
391      (Descriptor  : in out Process_Descriptor;
392       Result      : out Expect_Match;
393       Regexps     : Regexp_Array;
394       Timeout     : Integer := 10000;
395       Full_Buffer : Boolean := False);
396    --  Wait till a string matching one of the regular expressions in Regexps
397    --  is found. This function returns the index of the regexp that matched.
398    --  This command is blocking, but will timeout after Timeout milliseconds.
399    --  In that case, Timeout is returned.
400
401    procedure Expect
402      (Descriptor  : in out Process_Descriptor;
403       Result      : out Expect_Match;
404       Regexps     : Compiled_Regexp_Array;
405       Timeout     : Integer := 10000;
406       Full_Buffer : Boolean := False);
407    --  Same as the previous one, but with precompiled regular expressions.
408    --  This can be much faster if you are using them multiple times.
409
410    procedure Expect
411      (Descriptor  : in out Process_Descriptor;
412       Result      : out Expect_Match;
413       Regexps     : Regexp_Array;
414       Matched     : out GNAT.Regpat.Match_Array;
415       Timeout     : Integer := 10000;
416       Full_Buffer : Boolean := False);
417    --  Same as above, except that you can also access the parenthesis
418    --  groups inside the matching regular expression.
419    --  The first index in Matched must be 0, or Constraint_Error will be
420    --  raised. The index 0 contains the indexes for the whole string that was
421    --  matched, the index 1 contains the indexes for the first parentheses
422    --  pair, and so on.
423
424    procedure Expect
425      (Descriptor  : in out Process_Descriptor;
426       Result      : out Expect_Match;
427       Regexps     : Compiled_Regexp_Array;
428       Matched     : out GNAT.Regpat.Match_Array;
429       Timeout     : Integer := 10000;
430       Full_Buffer : Boolean := False);
431    --  Same as above, but with precompiled regular expressions.
432    --  The first index in Matched must be 0, or Constraint_Error will be
433    --  raised.
434
435    -------------------------------------------
436    -- Working on the output (multi-process) --
437    -------------------------------------------
438
439    type Multiprocess_Regexp is record
440       Descriptor : Process_Descriptor_Access;
441       Regexp     : Pattern_Matcher_Access;
442    end record;
443    type Multiprocess_Regexp_Array is array (Positive range <>)
444      of Multiprocess_Regexp;
445
446    procedure Expect
447      (Result      : out Expect_Match;
448       Regexps     : Multiprocess_Regexp_Array;
449       Matched     : out GNAT.Regpat.Match_Array;
450       Timeout     : Integer := 10000;
451       Full_Buffer : Boolean := False);
452    --  Same as above, but for multi processes.
453
454    procedure Expect
455      (Result      : out Expect_Match;
456       Regexps     : Multiprocess_Regexp_Array;
457       Timeout     : Integer := 10000;
458       Full_Buffer : Boolean := False);
459    --  Same as the previous one, but for multiple processes.
460    --  This procedure finds the first regexp that match the associated process.
461
462    ------------------------
463    -- Getting the output --
464    ------------------------
465
466    procedure Flush
467      (Descriptor : in out Process_Descriptor;
468       Timeout    : Integer := 0);
469    --  Discard all output waiting from the process.
470    --
471    --  This output is simply discarded, and no filter is called. This output
472    --  will also not be visible by the next call to Expect, nor will any
473    --  output currently buffered.
474    --
475    --  Timeout is the delay for which we wait for output to be available from
476    --  the process. If 0, we only get what is immediately available.
477
478    function Expect_Out (Descriptor : Process_Descriptor) return String;
479    --  Return the string matched by the last Expect call.
480    --
481    --  The returned string is in fact the concatenation of all the strings
482    --  read from the file descriptor up to, and including, the characters
483    --  that matched the regular expression.
484    --
485    --  For instance, with an input "philosophic", and a regular expression
486    --  "hi" in the call to expect, the strings returned the first and second
487    --  time would be respectively "phi" and "losophi".
488
489    function Expect_Out_Match (Descriptor : Process_Descriptor) return String;
490    --  Return the string matched by the last Expect call.
491    --
492    --  The returned string includes only the character that matched the
493    --  specific regular expression. All the characters that came before are
494    --  simply discarded.
495    --
496    --  For instance, with an input "philosophic", and a regular expression
497    --  "hi" in the call to expect, the strings returned the first and second
498    --  time would both be "hi".
499
500    ----------------
501    -- Exceptions --
502    ----------------
503
504    Invalid_Process : exception;
505    --  Raised by most subprograms above when the parameter Descriptor is not a
506    --  valid process or is a closed process.
507
508    Process_Died : exception;
509    --  Raised by all the expect subprograms if Descriptor was originally a
510    --  valid process that died while Expect was executing. It is also raised
511    --  when Expect receives an end-of-file.
512
513    ------------------------
514    -- Internal functions --
515    ------------------------
516
517    --  The following subprograms are provided so that it is easy to write
518    --  extensions to this package. However, clients should not use these
519    --  routines directly.
520
521    procedure Portable_Execvp (Cmd : String; Args : System.Address);
522    --  Executes, in a portable way, the command Cmd (full path must be
523    --  specified), with the given Args. Note that the first element in Args
524    --  must be the executable name, and the last element must be a null
525    --  pointer
526
527 private
528    type Filter_List_Elem;
529    type Filter_List is access Filter_List_Elem;
530    type Filter_List_Elem is record
531       Filter    : Filter_Function;
532       User_Data : System.Address;
533       Filter_On : Filter_Type;
534       Next      : Filter_List;
535    end record;
536
537    type Pipe_Type is record
538       Input, Output : GNAT.OS_Lib.File_Descriptor;
539    end record;
540    --  This type represents a pipe, used to communicate between two processes.
541
542    procedure Set_Up_Communications
543      (Pid        : in out Process_Descriptor;
544       Err_To_Out : Boolean;
545       Pipe1      : access Pipe_Type;
546       Pipe2      : access Pipe_Type;
547       Pipe3      : access Pipe_Type);
548    --  Set up all the communication pipes and file descriptors prior to
549    --  spawning the child process.
550
551    procedure Set_Up_Parent_Communications
552      (Pid   : in out Process_Descriptor;
553       Pipe1 : in out Pipe_Type;
554       Pipe2 : in out Pipe_Type;
555       Pipe3 : in out Pipe_Type);
556    --  Finish the set up of the pipes while in the parent process
557
558    procedure Set_Up_Child_Communications
559      (Pid   : in out Process_Descriptor;
560       Pipe1 : in out Pipe_Type;
561       Pipe2 : in out Pipe_Type;
562       Pipe3 : in out Pipe_Type;
563       Cmd   : String;
564       Args  : System.Address);
565    --  Finish the set up of the pipes while in the child process
566    --  This also spawns the child process (based on Cmd).
567    --  On systems that support fork, this procedure is executed inside the
568    --  newly created process.
569
570    type Process_Descriptor is tagged record
571       Pid              : Process_Id := Invalid_Pid;
572       Input_Fd         : GNAT.OS_Lib.File_Descriptor := GNAT.OS_Lib.Invalid_FD;
573       Output_Fd        : GNAT.OS_Lib.File_Descriptor := GNAT.OS_Lib.Invalid_FD;
574       Error_Fd         : GNAT.OS_Lib.File_Descriptor := GNAT.OS_Lib.Invalid_FD;
575       Filters_Lock     : Integer := 0;
576
577       Filters          : Filter_List := null;
578
579       Buffer           : GNAT.OS_Lib.String_Access := null;
580       Buffer_Size      : Natural := 0;
581       Buffer_Index     : Natural := 0;
582
583       Last_Match_Start : Natural := 0;
584       Last_Match_End   : Natural := 0;
585    end record;
586
587    pragma Import (C, Portable_Execvp, "__gnat_expect_portable_execvp");
588
589 end GNAT.Expect;