"{ Encoding: utf8 }"

"

 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' }"

"{ NameSpace: Smalltalk }"

NonPositionableExternalStream subclass:#PipeStream

	instanceVariableNames:'commandString osProcess'

	classVariableNames:'BrokenPipeSignal'

	poolDictionaries:''

	category:'Streams-External'

!

!PipeStream primitiveDefinitions!

%{

#include "stxOSDefs.h"

#if defined(__win32__)

# undef UNIX_LIKE

# define MSDOS_LIKE

#endif

#ifndef _STDIO_H_INCLUDED_

# include <stdio.h>

# define _STDIO_H_INCLUDED_

#endif

#ifndef _ERRNO_H_INCLUDED_

# include <errno.h>

# define _ERRNO_H_INCLUDED_

#endif

#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;

 * we're 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);

	console_fprintf(stderr, "PipeStream [warning]: execlp failed in popen\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 or dos 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 command's output can be read using the

    standard stream messages, such 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 -u -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

"

!

examples

"

  reading:

                                                    [exBegin]

    |p output|

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

    output := p upToEnd.

    p close.

    Transcript showCR:output

                                                    [exEnd]

  bidirectional:

  (must add a '-u' argument, because otherwise sed will read a big junk

  waiting for more input, before generating any output) 

  Notice: OSX sed does not support a '-u' option (sigh)

                                                    [exBegin]

    |p|

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

    p nextPutLine:'bla'.

    Transcript showCR:p nextLine.

    p nextPutLine:'foo Hello'.

    Transcript showCR:p nextLine.

    p nextPutLine:'bar'.

    Transcript showCR:p nextLine.

    p close.

                                                    [exEnd]

  error output is on my stderr:

                                                    [exBegin]

    |p|

    p := PipeStream readingFrom:'echo hello1; echo error>&2; echo hello2'.

    Transcript showCR:p upToEnd.

    p close.

                                                    [exEnd]

  error output is included:

                                                    [exBegin]

    |p|

    p := PipeStream readingFrom:'echo hello1; echo error>&2; echo hello2' errorDisposition:#stdout.

    Transcript showCR:p upToEnd.

    p close.

                                                    [exEnd]

  error output is separate:

                                                    [exBegin]

    |p errStream|

    errStream := '' writeStream.

    p := PipeStream readingFrom:'echo hello1; echo error>&2; echo hello2' errorDisposition:errStream.

    Transcript showCR:'output:'; showCR:p upToEnd; cr.

    p close.

    Transcript showCR:'error:'; showCR:errStream contents; cr.

                                                    [exEnd]

"

! !

!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 -u -e ''s/Hello/Greetings/'''.

        p nextPutAll:'Hello world'; cr.

        p shutDownOutput.

        Transcript showCR:p nextLine.

        p close

    "

    "

        |p|

        p := PipeStream bidirectionalFor:'wc'.

        p nextPutAll:'Hello world'; cr.

        p shutDownOutput.

        Transcript showCR:p nextLine.

        p close

    "

    "Modified (comment): / 22-05-2018 / 10:46:32 / Stefan Vogel"

!

bidirectionalFor:commandString errorDisposition:errorDispositionSymbolOrStream 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 a stream or one of #discard, #inline or #stderr (default).

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

     #inline causes it to be written to smalltalk's own stdout

     #stderr causes it to be written to smalltalk's own stderr.

     a stream causes stderr to be sent to that stream (internal or external)

     Nil is treated like #stderr"

    ^ self basicNew

        openPipeFor:commandString

        withMode:#'r+'

        errorDisposition:errorDispositionSymbolOrStream

        inDirectory:aDirectory

!

readingFrom:commandString

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

     given by commandString.

     The command's 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

    "

    "

        |p|

        p := PipeStream readingFrom:'echo error >&2'.

        Transcript showCR:p nextLine.

        p close

    "

    "

        |s|

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

        (Delay forSeconds:2) wait.

        s abortAndClose

    "

    "

        |p|

        p := PipeStream readingFrom:'dir'.

        Transcript showCR:p nextLine.

        p close

    "

    "Windows:

        PipeStream readingFrom:'dir'.

    "

    "

        |p|

        p := PipeStream readingFrom:'dir'.

        Transcript showCR:p nextLine.

        p close

    "

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

!

readingFrom:commandString environment:aShellEnvironmentOrNil

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

     given by commandString.

     The command's error output is send to my own error output."

    ^ self

        readingFrom:commandString

        errorDisposition:#stderr

        environment:aShellEnvironmentOrNil

        inDirectory:nil

    "unix:

        PipeStream readingFrom:'ls -l'.

    "

    "

        |p|

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

        Transcript showCR:p nextLine.

        p close

    "

    "

        |p|

        p := PipeStream readingFrom:'echo error >&2'.

        Transcript showCR:p nextLine.

        p close

    "

    "

        |s|

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

        (Delay forSeconds:2) wait.

        s abortAndClose

    "

    "

        |p|

        p := PipeStream readingFrom:'dir'.

        Transcript showCR:p nextLine.

        p close

    "

    "Windows:

        PipeStream readingFrom:'dir'.

    "

    "

        |p|

        p := PipeStream readingFrom:'dir'.

        Transcript showCR:p nextLine.

        p close

    "

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

!

readingFrom:commandString environment:aShellEnvironmentOrNil 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 command's error output is send to my own error output."

     ^ self

        readingFrom:commandString

        errorDisposition:#stderr

        environment:aShellEnvironmentOrNil

        inDirectory:aDirectory

    " UNIX:

        |p|

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

        Transcript showCR:p upToEnd.

        p close

    "

    "WINDOOF:

        |p|

        p := PipeStream readingFrom:'dir'.

        Transcript showCR:p upToEnd.

        p close

   "

!

readingFrom:commandString errorDisposition:errorDispositionSymbolOrStream

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

     given by commandString.

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

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