-- --
-- B o d y --
-- --
--- Copyright (C) 2000-2007, AdaCore --
+-- Copyright (C) 2000-2011, AdaCore --
-- --
-- GNAT is free software; you can redistribute it and/or modify it under --
-- terms of the GNU General Public License as published by the Free Soft- --
--- ware Foundation; either version 2, or (at your option) any later ver- --
+-- ware Foundation; either version 3, or (at your option) any later ver- --
-- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
-- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
--- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
--- for more details. You should have received a copy of the GNU General --
--- Public License distributed with GNAT; see file COPYING. If not, write --
--- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
--- Boston, MA 02110-1301, USA. --
+-- or FITNESS FOR A PARTICULAR PURPOSE. --
-- --
--- As a special exception, if other files instantiate generics from this --
--- unit, or you link this unit with other files to produce an executable, --
--- this unit does not by itself cause the resulting executable to be --
--- covered by the GNU General Public License. This exception does not --
--- however invalidate any other reasons why the executable file might be --
--- covered by the GNU Public License. --
+-- As a special exception under Section 7 of GPL version 3, you are granted --
+-- additional permissions described in the GCC Runtime Library Exception, --
+-- version 3.1, as published by the Free Software Foundation. --
+-- --
+-- You should have received a copy of the GNU General Public License and --
+-- a copy of the GCC Runtime Library Exception along with this program; --
+-- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
+-- <http://www.gnu.org/licenses/>. --
-- --
-- GNAT was originally developed by the GNAT team at New York University. --
-- Extensive contributions were provided by Ada Core Technologies Inc. --
-- --
------------------------------------------------------------------------------
-with System; use System;
-with Ada.Calendar; use Ada.Calendar;
+with System; use System;
+with System.OS_Constants; use System.OS_Constants;
+with Ada.Calendar; use Ada.Calendar;
with GNAT.IO;
with GNAT.OS_Lib; use GNAT.OS_Lib;
type Array_Of_Pd is array (Positive range <>) of Process_Descriptor_Access;
+ Expect_Process_Died : constant Expect_Match := -100;
+ Expect_Internal_Error : constant Expect_Match := -101;
+ -- Additional possible outputs of Expect_Internal. These are not visible in
+ -- the spec because the user will never see them.
+
procedure Expect_Internal
(Descriptors : in out Array_Of_Pd;
Result : out Expect_Match;
Full_Buffer : Boolean);
-- Internal function used to read from the process Descriptor.
--
- -- Three outputs are possible:
+ -- Several outputs are possible:
-- Result=Expect_Timeout, if no output was available before the timeout
-- expired.
-- Result=Expect_Full_Buffer, if Full_Buffer is True and some characters
-- had to be discarded from the internal buffer of Descriptor.
+ -- Result=Express_Process_Died if one of the processes was terminated.
+ -- That process's Input_Fd is set to Invalid_FD
+ -- Result=Express_Internal_Error
-- Result=<integer>, indicates how many characters were added to the
-- internal buffer. These characters are from indexes
-- Descriptor.Buffer_Index - Result + 1 .. Descriptor.Buffer_Index
Next_Filter : Filter_List;
begin
- Close (Descriptor.Input_Fd);
+ if Descriptor.Input_Fd /= Invalid_FD then
+ Close (Descriptor.Input_Fd);
+ end if;
if Descriptor.Error_Fd /= Descriptor.Output_Fd then
Close (Descriptor.Error_Fd);
(Descriptor : in out Process_Descriptor;
Result : out Expect_Match;
Regexp : String;
- Timeout : Integer := 10000;
+ Timeout : Integer := 10_000;
Full_Buffer : Boolean := False)
is
begin
Result : out Expect_Match;
Regexp : String;
Matched : out GNAT.Regpat.Match_Array;
- Timeout : Integer := 10000;
+ Timeout : Integer := 10_000;
Full_Buffer : Boolean := False)
is
begin
(Descriptor : in out Process_Descriptor;
Result : out Expect_Match;
Regexp : GNAT.Regpat.Pattern_Matcher;
- Timeout : Integer := 10000;
+ Timeout : Integer := 10_000;
Full_Buffer : Boolean := False)
is
Matched : GNAT.Regpat.Match_Array (0 .. 0);
Result : out Expect_Match;
Regexp : GNAT.Regpat.Pattern_Matcher;
Matched : out GNAT.Regpat.Match_Array;
- Timeout : Integer := 10000;
+ Timeout : Integer := 10_000;
Full_Buffer : Boolean := False)
is
N : Expect_Match;
Expect_Internal (Descriptors, N, Timeout_Tmp, Full_Buffer);
- if N = Expect_Timeout or else N = Expect_Full_Buffer then
- Result := N;
- return;
- end if;
+ case N is
+ when Expect_Internal_Error | Expect_Process_Died =>
+ raise Process_Died;
+
+ when Expect_Timeout | Expect_Full_Buffer =>
+ Result := N;
+ return;
+
+ when others =>
+ null; -- See below
+ end case;
-- Calculate the timeout for the next turn
(Descriptor : in out Process_Descriptor;
Result : out Expect_Match;
Regexps : Regexp_Array;
- Timeout : Integer := 10000;
+ Timeout : Integer := 10_000;
Full_Buffer : Boolean := False)
is
Patterns : Compiled_Regexp_Array (Regexps'Range);
(Descriptor : in out Process_Descriptor;
Result : out Expect_Match;
Regexps : Compiled_Regexp_Array;
- Timeout : Integer := 10000;
+ Timeout : Integer := 10_000;
Full_Buffer : Boolean := False)
is
Matched : GNAT.Regpat.Match_Array (0 .. 0);
procedure Expect
(Result : out Expect_Match;
Regexps : Multiprocess_Regexp_Array;
- Timeout : Integer := 10000;
+ Timeout : Integer := 10_000;
Full_Buffer : Boolean := False)
is
Matched : GNAT.Regpat.Match_Array (0 .. 0);
Result : out Expect_Match;
Regexps : Regexp_Array;
Matched : out GNAT.Regpat.Match_Array;
- Timeout : Integer := 10000;
+ Timeout : Integer := 10_000;
Full_Buffer : Boolean := False)
is
Patterns : Compiled_Regexp_Array (Regexps'Range);
Result : out Expect_Match;
Regexps : Compiled_Regexp_Array;
Matched : out GNAT.Regpat.Match_Array;
- Timeout : Integer := 10000;
+ Timeout : Integer := 10_000;
Full_Buffer : Boolean := False)
is
N : Expect_Match;
Expect_Internal (Descriptors, N, Timeout, Full_Buffer);
- if N = Expect_Timeout or else N = Expect_Full_Buffer then
- Result := N;
- return;
- end if;
+ case N is
+ when Expect_Internal_Error | Expect_Process_Died =>
+ raise Process_Died;
+
+ when Expect_Timeout | Expect_Full_Buffer =>
+ Result := N;
+ return;
+
+ when others =>
+ null; -- Continue
+ end case;
end loop;
end Expect;
(Result : out Expect_Match;
Regexps : Multiprocess_Regexp_Array;
Matched : out GNAT.Regpat.Match_Array;
- Timeout : Integer := 10000;
+ Timeout : Integer := 10_000;
Full_Buffer : Boolean := False)
is
N : Expect_Match;
for J in Descriptors'Range loop
Descriptors (J) := Regexps (J).Descriptor;
- Reinitialize_Buffer (Regexps (J).Descriptor.all);
+
+ if Descriptors (J) /= null then
+ Reinitialize_Buffer (Regexps (J).Descriptor.all);
+ end if;
end loop;
loop
-- checking the regexps).
for J in Regexps'Range loop
- Match (Regexps (J).Regexp.all,
- Regexps (J).Descriptor.Buffer
- (1 .. Regexps (J).Descriptor.Buffer_Index),
- Matched);
-
- if Matched (0) /= No_Match then
- Result := Expect_Match (J);
- Regexps (J).Descriptor.Last_Match_Start := Matched (0).First;
- Regexps (J).Descriptor.Last_Match_End := Matched (0).Last;
- return;
+ if Regexps (J).Regexp /= null
+ and then Regexps (J).Descriptor /= null
+ then
+ Match (Regexps (J).Regexp.all,
+ Regexps (J).Descriptor.Buffer
+ (1 .. Regexps (J).Descriptor.Buffer_Index),
+ Matched);
+
+ if Matched (0) /= No_Match then
+ Result := Expect_Match (J);
+ Regexps (J).Descriptor.Last_Match_Start := Matched (0).First;
+ Regexps (J).Descriptor.Last_Match_End := Matched (0).Last;
+ return;
+ end if;
end if;
end loop;
Expect_Internal (Descriptors, N, Timeout, Full_Buffer);
- if N = Expect_Timeout or else N = Expect_Full_Buffer then
- Result := N;
- return;
- end if;
+ case N is
+ when Expect_Internal_Error | Expect_Process_Died =>
+ raise Process_Died;
+
+ when Expect_Timeout | Expect_Full_Buffer =>
+ Result := N;
+ return;
+
+ when others =>
+ null; -- Continue
+ end case;
end loop;
end Expect;
N : Integer;
type File_Descriptor_Array is
- array (Descriptors'Range) of File_Descriptor;
+ array (0 .. Descriptors'Length - 1) of File_Descriptor;
Fds : aliased File_Descriptor_Array;
+ Fds_Count : Natural := 0;
- type Integer_Array is array (Descriptors'Range) of Integer;
+ Fds_To_Descriptor : array (Fds'Range) of Integer;
+ -- Maps file descriptor entries from Fds to entries in Descriptors.
+ -- They do not have the same index when entries in Descriptors are null.
+
+ type Integer_Array is array (Fds'Range) of Integer;
Is_Set : aliased Integer_Array;
begin
for J in Descriptors'Range loop
- Fds (J) := Descriptors (J).Output_Fd;
+ if Descriptors (J) /= null then
+ Fds (Fds'First + Fds_Count) := Descriptors (J).Output_Fd;
+ Fds_To_Descriptor (Fds'First + Fds_Count) := J;
+ Fds_Count := Fds_Count + 1;
- if Descriptors (J).Buffer_Size = 0 then
- Buffer_Size := Integer'Max (Buffer_Size, 4096);
- else
- Buffer_Size :=
- Integer'Max (Buffer_Size, Descriptors (J).Buffer_Size);
+ if Descriptors (J).Buffer_Size = 0 then
+ Buffer_Size := Integer'Max (Buffer_Size, 4096);
+ else
+ Buffer_Size :=
+ Integer'Max (Buffer_Size, Descriptors (J).Buffer_Size);
+ end if;
end if;
end loop;
-- Buffer used for input. This is allocated only once, not for
-- every iteration of the loop
+ D : Integer;
+ -- Index in Descriptors
+
begin
-- Loop until we match or we have a timeout
loop
Num_Descriptors :=
- Poll (Fds'Address, Fds'Length, Timeout, Is_Set'Address);
+ Poll (Fds'Address, Fds_Count, Timeout, Is_Set'Address);
case Num_Descriptors is
-- Error?
when -1 =>
- raise Process_Died;
+ Result := Expect_Internal_Error;
+ return;
-- Timeout?
-- Some input
when others =>
- for J in Descriptors'Range loop
- if Is_Set (J) = 1 then
- Buffer_Size := Descriptors (J).Buffer_Size;
+ for F in Fds'Range loop
+ if Is_Set (F) = 1 then
+ D := Fds_To_Descriptor (F);
+
+ Buffer_Size := Descriptors (D).Buffer_Size;
if Buffer_Size = 0 then
Buffer_Size := 4096;
end if;
- N := Read (Descriptors (J).Output_Fd, Buffer'Address,
+ N := Read (Descriptors (D).Output_Fd, Buffer'Address,
Buffer_Size);
-- Error or End of file
if N <= 0 then
-- ??? Note that ddd tries again up to three times
-- in that case. See LiterateA.C:174
- raise Process_Died;
+
+ Descriptors (D).Input_Fd := Invalid_FD;
+ Result := Expect_Process_Died;
+ return;
else
-- If there is no limit to the buffer size
- if Descriptors (J).Buffer_Size = 0 then
+ if Descriptors (D).Buffer_Size = 0 then
declare
- Tmp : String_Access := Descriptors (J).Buffer;
+ Tmp : String_Access := Descriptors (D).Buffer;
begin
if Tmp /= null then
- Descriptors (J).Buffer :=
+ Descriptors (D).Buffer :=
new String (1 .. Tmp'Length + N);
- Descriptors (J).Buffer (1 .. Tmp'Length) :=
+ Descriptors (D).Buffer (1 .. Tmp'Length) :=
Tmp.all;
- Descriptors (J).Buffer
+ Descriptors (D).Buffer
(Tmp'Length + 1 .. Tmp'Length + N) :=
Buffer (1 .. N);
Free (Tmp);
- Descriptors (J).Buffer_Index :=
- Descriptors (J).Buffer'Last;
+ Descriptors (D).Buffer_Index :=
+ Descriptors (D).Buffer'Last;
else
- Descriptors (J).Buffer :=
+ Descriptors (D).Buffer :=
new String (1 .. N);
- Descriptors (J).Buffer.all :=
+ Descriptors (D).Buffer.all :=
Buffer (1 .. N);
- Descriptors (J).Buffer_Index := N;
+ Descriptors (D).Buffer_Index := N;
end if;
end;
else
-- Add what we read to the buffer
- if Descriptors (J).Buffer_Index + N - 1 >
- Descriptors (J).Buffer_Size
+ if Descriptors (D).Buffer_Index + N >
+ Descriptors (D).Buffer_Size
then
-- If the user wants to know when we have
-- read more than the buffer can contain.
-- Keep as much as possible from the buffer,
-- and forget old characters.
- Descriptors (J).Buffer
- (1 .. Descriptors (J).Buffer_Size - N) :=
- Descriptors (J).Buffer
- (N - Descriptors (J).Buffer_Size +
- Descriptors (J).Buffer_Index + 1 ..
- Descriptors (J).Buffer_Index);
- Descriptors (J).Buffer_Index :=
- Descriptors (J).Buffer_Size - N;
+ Descriptors (D).Buffer
+ (1 .. Descriptors (D).Buffer_Size - N) :=
+ Descriptors (D).Buffer
+ (N - Descriptors (D).Buffer_Size +
+ Descriptors (D).Buffer_Index + 1 ..
+ Descriptors (D).Buffer_Index);
+ Descriptors (D).Buffer_Index :=
+ Descriptors (D).Buffer_Size - N;
end if;
-- Keep what we read in the buffer
- Descriptors (J).Buffer
- (Descriptors (J).Buffer_Index + 1 ..
- Descriptors (J).Buffer_Index + N) :=
+ Descriptors (D).Buffer
+ (Descriptors (D).Buffer_Index + 1 ..
+ Descriptors (D).Buffer_Index + N) :=
Buffer (1 .. N);
- Descriptors (J).Buffer_Index :=
- Descriptors (J).Buffer_Index + N;
+ Descriptors (D).Buffer_Index :=
+ Descriptors (D).Buffer_Index + N;
end if;
-- Call each of the output filter with what we
-- read.
Call_Filters
- (Descriptors (J).all, Buffer (1 .. N), Output);
+ (Descriptors (D).all, Buffer (1 .. N), Output);
- Result := Expect_Match (N);
+ Result := Expect_Match (D);
return;
end if;
end if;
(Descriptor.Last_Match_Start .. Descriptor.Last_Match_End);
end Expect_Out_Match;
+ ------------------------
+ -- First_Dead_Process --
+ ------------------------
+
+ function First_Dead_Process
+ (Regexp : Multiprocess_Regexp_Array) return Natural is
+ begin
+ for R in Regexp'Range loop
+ if Regexp (R).Descriptor /= null
+ and then Regexp (R).Descriptor.Input_Fd = GNAT.OS_Lib.Invalid_FD
+ then
+ return R;
+ end if;
+ end loop;
+
+ return 0;
+ end First_Dead_Process;
+
-----------
-- Flush --
-----------
end loop;
end Flush;
+ ----------
+ -- Free --
+ ----------
+
+ procedure Free (Regexp : in out Multiprocess_Regexp) is
+ procedure Unchecked_Free is new Ada.Unchecked_Deallocation
+ (Process_Descriptor'Class, Process_Descriptor_Access);
+ begin
+ Unchecked_Free (Regexp.Descriptor);
+ Free (Regexp.Regexp);
+ end Free;
+
------------------------
-- Get_Command_Output --
------------------------
Send (Process, Input);
end if;
- GNAT.OS_Lib.Close (Get_Input_Fd (Process));
+ Close (Process.Input_Fd);
+ Process.Input_Fd := Invalid_FD;
declare
Result : Expect_Match;
NOutput (Output'Range) := Output.all;
Free (Output);
- -- Here if current buffer size is OK
+ -- Here if current buffer size is OK
else
NOutput := Output;
end;
if Last = 0 then
+ Free (Output);
return "";
end if;
return Descriptor.Pid;
end Get_Pid;
+ -----------------
+ -- Has_Process --
+ -----------------
+
+ function Has_Process (Regexp : Multiprocess_Regexp_Array) return Boolean is
+ begin
+ return Regexp /= (Regexp'Range => (null, null));
+ end Has_Process;
+
---------------
-- Interrupt --
---------------
-- Prepare low-level argument list from the normalized arguments
for K in Arg_List'Range loop
- if Arg_List (K) /= null then
- C_Arg_List (K) := Arg_List (K).all'Address;
- else
- C_Arg_List (K) := System.Null_Address;
- end if;
+ C_Arg_List (K) :=
+ (if Arg_List (K) /= null
+ then Arg_List (K).all'Address
+ else System.Null_Address);
end loop;
-- This does not return on Unix systems
Expect_Internal
(Descriptors, Result, Timeout => 0, Full_Buffer => False);
+
+ if Result = Expect_Internal_Error
+ or else Result = Expect_Process_Died
+ then
+ raise Process_Died;
+ end if;
+
Descriptor.Last_Match_End := Descriptor.Buffer_Index;
-- Empty the buffer
Args : System.Address)
is
pragma Warnings (Off, Pid);
+ pragma Warnings (Off, Pipe1);
+ pragma Warnings (Off, Pipe2);
+ pragma Warnings (Off, Pipe3);
Input : File_Descriptor;
Output : File_Descriptor;
Error : File_Descriptor;
+ No_Fork_On_Target : constant Boolean := Target_OS = Windows;
+
begin
- -- Since Windows does not have a separate fork/exec, we need to
- -- perform the following actions:
- -- - save stdin, stdout, stderr
- -- - replace them by our pipes
- -- - create the child with process handle inheritance
- -- - revert to the previous stdin, stdout and stderr.
+ if No_Fork_On_Target then
- Input := Dup (GNAT.OS_Lib.Standin);
- Output := Dup (GNAT.OS_Lib.Standout);
- Error := Dup (GNAT.OS_Lib.Standerr);
+ -- Since Windows does not have a separate fork/exec, we need to
+ -- perform the following actions:
+
+ -- - save stdin, stdout, stderr
+ -- - replace them by our pipes
+ -- - create the child with process handle inheritance
+ -- - revert to the previous stdin, stdout and stderr.
+
+ Input := Dup (GNAT.OS_Lib.Standin);
+ Output := Dup (GNAT.OS_Lib.Standout);
+ Error := Dup (GNAT.OS_Lib.Standerr);
+ end if;
-- Since we are still called from the parent process, there is no way
-- currently we can cleanly close the unneeded ends of the pipes, but
-- this doesn't really matter.
- -- We could close Pipe1.Output, Pipe2.Input, Pipe3.Input.
+
+ -- We could close Pipe1.Output, Pipe2.Input, Pipe3.Input
Dup2 (Pipe1.Input, GNAT.OS_Lib.Standin);
Dup2 (Pipe2.Output, GNAT.OS_Lib.Standout);
Dup2 (Pipe3.Output, GNAT.OS_Lib.Standerr);
- Portable_Execvp (Pid.Pid'Access, Cmd & ASCII.Nul, Args);
+ Portable_Execvp (Pid.Pid'Access, Cmd & ASCII.NUL, Args);
- -- The following commands are not executed on Unix systems, and are
- -- only required for Windows systems. We are now in the parent process.
+ -- The following commands are not executed on Unix systems, and are only
+ -- required for Windows systems. We are now in the parent process.
-- Restore the old descriptors
-- Reuse the standard output pipe for standard error
Pipe3.all := Pipe2.all;
- else
+ else
-- Create a separate pipe for standard error
if Create_Pipe (Pipe3) /= 0 then
Pipe3 : in out Pipe_Type)
is
pragma Warnings (Off, Pid);
+ pragma Warnings (Off, Pipe1);
+ pragma Warnings (Off, Pipe2);
+ pragma Warnings (Off, Pipe3);
+
begin
Close (Pipe1.Input);
Close (Pipe2.Output);
- Close (Pipe3.Output);
+
+ if Pipe3.Output /= Pipe2.Output then
+ Close (Pipe3.Output);
+ end if;
end Set_Up_Parent_Communications;
------------------