"

 COPYRIGHT (c) 1989 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

"{ Package: 'stx:libbasic' }"

NonPositionableExternalStream subclass:#PipeStream

	instanceVariableNames:'commandString pid exitStatus exitSema exitAction'

	classVariableNames:'BrokenPipeSignal'

	poolDictionaries:''

	category:'Streams-External'

!

!PipeStream primitiveDefinitions!

%{

#if defined(WIN32)

# undef UNIX_LIKE

# define MSDOS_LIKE

#endif

#include <stdio.h>

#define _STDIO_H_INCLUDED_

#include <errno.h>

#define _ERRNO_H_INCLUDED_

#ifndef transputer

# include <sys/types.h>

# include <sys/stat.h>

#endif

/*

 * on some systems errno is a macro ... check for it here

 */

#ifndef errno

 extern errno;

#endif

#ifdef LINUX

# define BUGGY_STDIO_LIB

#endif

%}

! !

!PipeStream primitiveFunctions!

%{

/*

 * no longer needed - popen is useless ...

 */

#undef NEED_POPEN_WITH_VFORK

/*

 * some systems (i.e. ultrix) use fork;

 * were better off with a popen based on vfork ...

 */

#ifdef NEED_POPEN_WITH_VFORK

static int popen_pid = 0;

FILE *

popen(command, type)

/* const */ char *command;

/* const */ char *type;

{

    int pipes[2];

    int itype = (strcmp(type, "w") == 0 ? 1 : 0);

    if (pipe(pipes) == -1)

	return NULL;

    switch (popen_pid = vfork()) {

    case -1:

	(void)close(pipes[0]);

	(void)close(pipes[1]);

	return NULL;

    case 0:

	if (itype) {

	    dup2(pipes[0], fileno(stdin));

	    close(pipes[1]);

	} else {

	    dup2(pipes[1], fileno(stdout));

	    close(pipes[0]);

	}

	execl("/bin/sh", "/bin/sh", "-c", command, 0);

	fprintf(stderr, "XRN Error: failed the execlp\n");

	_exit(-1);

	/* NOTREACHED */

    default:

	    if (itype) {

		close(pipes[0]);

		return fdopen(pipes[1], "w");

	    } else {

		close(pipes[1]);

		return fdopen(pipes[0], "r");

	    }

    }

}

int

pclose(str)

FILE *str;

{

    int pd = 0;

    int status;

    int err;

    err = fclose(str);

    do {

	if ((pd = wait(&status)) == -1)

	{

		err = EOF;

		break;

	}

    } while (pd !=  popen_pid);

    if (err == EOF)

	return  -1;

    if (status)

	status >>= 8;   /* exit status in high byte */

    return status;

}

#endif /* NEED_POPEN_WITH_VFORK */

%}

! !

!PipeStream class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1989 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

    Pipestreams allow reading or writing from/to a unix command.

    For example, to get a stream reading the output of an 'ls -l'

    command, a PipeStream can be created with:

        PipeStream readingFrom:'ls -l'

    the characters of the commands output can be read using the

    standard stream messages as next, nextLine etc.

    Example for writing to a command:

        PipeStream writingTo:'cat >/tmp/x'

    Bidirectional pipestreams (supporting both reading an writing) may be used for filters:

        PipeStream bidirectionalFor:'sed -e ''s/Hello/Greetings/'''

    Buffered pipes do not work with Linux - the stdio library seems to be

    buggy (trying to restart the read ...)

    [author:]

        Claus Gittinger

    [see also:]

        ExternalStream FileStream Socket

        OperatingSystem

"

! !

!PipeStream class methodsFor:'initialization'!

initialize

    "setup the signal"

    BrokenPipeSignal isNil ifTrue:[

        BrokenPipeSignal := WriteError newSignalMayProceed:true.

        BrokenPipeSignal nameClass:self message:#brokenPipeSignal.

        BrokenPipeSignal notifierString:'write on a pipe with no one to read'.

    ]

! !

!PipeStream class methodsFor:'instance creation'!

bidirectionalFor:commandString

    "create and return a new bidirectonal pipeStream which can both be written to 

     and read from the unix command given by commandString. 

     The commands error output is send to my own error output."

    ^ self 

        bidirectionalFor:commandString 

        errorDisposition:#stderr 

        inDirectory:nil

    "

        |p|

        p := PipeStream bidirectionalFor:'cat -u'.

        p nextPutAll:'Wer ist der Bürgermeister von Wesel'; cr.

        Transcript showCR:p nextLine.

        p close

    "

    "

        |p|

        p := PipeStream bidirectionalFor:'sed -e ''s/Hello/Greetings/'''.

        p nextPutAll:'Hello world'; cr.

        p shutDownOutput.

        Transcript showCR:p nextLine.

        p close

    "

!

bidirectionalFor:commandString errorDisposition:errorDisposition inDirectory:aDirectory

    "create and return a new bidirectonal pipeStream which can both be written to 

     and read from the unix command given by commandString. 

     The directory will be changed to aDirectory while

     executing the command. Use this if a command is to be

     executed in another directory, to avoid any OS dependencies

     in your code.

     errorDisposition may be one of #discard, #inline or #stderr (default).

     #discard causes stderr to be discarded (/dev/null), 

     #inline causes it to be written to smalltalks own stdout and

     #stderr causes it to be written to smalltalks own stderr.

     Nil is treated like #stderr"

    ^ self basicNew

        openPipeFor:commandString 

        withMode:#'r+' 

        errorDisposition:errorDisposition 

        inDirectory:aDirectory

!

readingFrom:commandString

    "create and return a new pipeStream which can read from the unix command

     given by commandString. 

     The commands error output is send to my own error output."

    ^ self 

        readingFrom:commandString 

        errorDisposition:#stderr 

        inDirectory:nil

    "unix:

        PipeStream readingFrom:'ls -l'.

    "

    "

        |p|

        p := PipeStream readingFrom:'ls -l'.

        Transcript showCR:p nextLine.

        p close

    "

    "

        |s|

        s := PipeStream readingFrom:'sh -c sleep\ 600'.

        (Delay forSeconds:2) wait.

        s shutDown

    "

    "vms:

        PipeStream readingFrom:'dir'.

    "

    "

        |p|

        p := PipeStream readingFrom:'dir'.

        Transcript showCR:p nextLine.

        p close

    "

    "msdos:

        PipeStream readingFrom:'dir'.

    "

    "

        |p|

        p := PipeStream readingFrom:'dir'.

        Transcript showCR:p nextLine.

        p close

    "

    "Modified: 24.4.1996 / 09:09:25 / stefan"

!

readingFrom:commandString errorDisposition:errorDisposition inDirectory:aDirectory

    "similar to #readingFrom, but changes the directory while

     executing the command. Use this if a command is to be

     executed in another directory, to avoid any OS dependencies

     in your code.

     errorDisposition may be one of #discard, #inline or #stderr (default).

     #discard causes stderr to be discarded (/dev/null), 

     #inline causes it to be merged into the PipeStream and

     #stderr causes it to be written to smalltalks own stderr.

     Nil is treated like #stderr"

    ^ self basicNew

        openPipeFor:commandString 

        withMode:#r 

        errorDisposition:errorDisposition 

        inDirectory:aDirectory

!

readingFrom:commandString inDirectory:aDirectory

    "similar to #readingFrom, but changes the directory while

     executing the command. Use this if a command is to be

     executed in another directory, to avoid any OS dependencies

     in your code.

     The commands error output is send to my own error output."

     ^ self 

        readingFrom:commandString

        errorDisposition:#stderr 

        inDirectory:aDirectory

    "        

        |p|

        p := PipeStream readingFrom:'ls -l' inDirectory:'/etc'.

        Transcript showCR:p upToEnd.

        p close

   "

!

writingTo:commandString

    "create and return a new pipeStream which can write to the unix command

     given by command."

    ^ self 

	writingTo:commandString errorDisposition:#stderr inDirectory:nil

    "unix:

	 PipeStream writingTo:'sort'

    "

!

writingTo:commandString errorDisposition:errorDisposition inDirectory:aDirectory

    "similar to #writingTo, but changes the directory while

     executing the command. Use this if a command is to be

     executed in another directory, to avoid any OS dependencies

     in your code.

     errorDisposition may be one of #discard, #inline or #stderr (default).

     #discard causes stderr to be discarded (/dev/null), 

     #inline causes it to be written to smalltalks own stdout and

     #stderr causes it to be written to smalltalks own stderr.

     Nil is treated like #stderr"

    ^ self basicNew

        openPipeFor:commandString 

        withMode:#w 

        errorDisposition:errorDisposition 

        inDirectory:aDirectory

!

writingTo:commandString inDirectory:aDirectory

    "create and return a new pipeStream which can write to the unix command

     given by commandString. The command is executed in the given directory."

    ^ self 

        writingTo:commandString errorDisposition:#stderr inDirectory:aDirectory

    "unix:

         PipeStream writingTo:'sort'

    "

! !

!PipeStream class methodsFor:'Signal constants'!

brokenPipeSignal

    "return the signal used to handle SIGPIPE unix-signals.

     Since SIGPIPE is asynchronous, we can't decide which smalltalk process

     should handle BrokenPipeSignal. So the system doesn't raise 

     BrokenPipeSignal for SIGPIPE any longer."

    ^ BrokenPipeSignal

    "Modified: 24.9.1997 / 09:43:23 / stefan"

! !

!PipeStream methodsFor:'accessing'!

commandString

    "return the command string"

    ^ commandString

!

exitStatus

    "return exitStatus"

    ^ exitStatus

    "Created: 28.12.1995 / 14:54:41 / stefan"

!

pid

    "return pid"

    ^ pid

    "Created: 28.12.1995 / 14:54:30 / stefan"

! !

!PipeStream methodsFor:'closing'!

shutDown

    "close the Stream and terminate the command"

    Lobby unregister:self.

    "terminate first under windows"

    OperatingSystem isMSDOSlike ifTrue:[

        self terminatePipeCommand.

        self closeFileDescriptor.

        ^ self.

    ].

    "terminate last under unix"

    self closeFileDescriptor.

    self terminatePipeCommand.

!

shutDownOutput

    "signal to the pipestream's command, that no more data will be sent"

    OperatingSystem shutdownBidirectionalPipeOutput:self fileDescriptor

! !

!PipeStream methodsFor:'finalization'!

finalize

    "redefined to avoid blocking in close."

    self shutDown

! !

!PipeStream protectedMethodsFor:'private'!

closeFile

    "low level close

     This waits for the command to finish. 

     Use shutDown for a fast (nonBlocking) close."

    filePointer notNil ifTrue:[

        super closeFile.

        OperatingSystem isMSDOSlike ifTrue:[

            self terminatePipeCommand.

        ].

        filePointer := nil.

        pid notNil ifTrue:[

            "/ wait for the pipe-command to terminate.

            self waitForPipeCommandWithTimeout:nil.

        ].

    ].

    "Modified: / 12.9.1998 / 16:51:04 / cg"

!

closeFileDescriptor

    "alternative very low level close 

     This closes the underlying OS-fileDescriptor 

     - and will NOT write any buffered data to the stream.

     You have been warned."