"

 COPYRIGHT (c) 1990 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:libbasic2' }"

Stream subclass:#PrinterStream

	instanceVariableNames:'stream native pageFormat underline strikeout'

	classVariableNames:'DefaultPageFormat'

	poolDictionaries:''

	category:'Interface-Printing'

!

PrinterStream class instanceVariableNames:'PrintCommand PrintFilename DefaultCommands PageFormat DefaultPageFormats

	Landscape PrintDevice DefaultDevices'

"

 No other class instance variables are inherited by this class.

"

!

!PrinterStream class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1990 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

"

    a stream for printing; this (concrete or abstract) class can handle only

    very dumb printers. 

    No attributes (italic, bold etc) and no multiple fonts are supported 

    - just plain single font text printing.

    More intelligence is added by subclasses (see PostscriptPrinterStream among others.)

    These classes do not support graphics printing - they are only for

    text; although some limited font functionality (such as bold or italic printing)

    may be supported by some subclasses.

    [usage:]

    The concrete printer class is bound to the global variable Printer,

    which is either set to PrinterStream (for dumb printers) or to one of

    the subclasses (PostscriptPrinterStream etc.).

    To print:

        |p|

        p := Printer new.

        p notNil ifTrue:[

            p nextPutAll:'hello world'; cr.

            p nextPutAll:' ...'; cr.

            p close

        ].

    See users of the Printer global variable for more examples.

    [class variables:]

        PrintCommand    <String>        UNIX only: the operatingSystem command for printing.

                                        Usually something like 'lp' or 'lpr'

        PrintDevice     <String>        VMS only: the printers device.

                                        Usually something like 'sys$print:'

    [author:]

        Claus Gittinger

"

! !

!PrinterStream class methodsFor:'initialization'!

initialize

    "this is usually redefined by the startup-file"

    OperatingSystem isUNIXlike ifTrue:[

        DefaultCommands isNil ifTrue:[

            DefaultCommands := #(

                                 'lpr' 

                                 'lpr -P<your-printer>' 

                                 'rsh <printHost> lpr -h' 

                                 'cat >preview.ps ; gv preview.ps'

                                 'cat >printfile'

                                 'gs -q -DNOPAUSE -sDEVICE=pdfwrite -sOutputFile=/tmp/preview.pdf -'

                                 'a2ps'

                                 'a2ps | rsh <printHost> lpr -h' 

                                 'a2ps >printfile' 

                                ).

        ].

        PrintCommand isNil ifTrue:[

            (OperatingSystem canExecuteCommand:'lpr') ifTrue:[

                PrintCommand := 'lpr'

            ] ifFalse:[

                PrintCommand := 'lp'

            ]

        ]

    ].

    OperatingSystem isVMSlike ifTrue:[

        DefaultDevices isNil ifTrue:[

            DefaultDevices := #(

                                 'sys$print:'

                                ).

        ].

        PrintDevice isNil ifTrue:[

            PrintDevice := 'sys$print:'

        ]

    ].

    DefaultPageFormats isNil ifTrue:[

        "/ UnitConverter must support all of them.

        self defaultPageFormats:#(

                                    'a3'

                                    'a4'

                                    'a5'

                                    'a6'

                                    'b5'

                                    'letter'

                                    'legal'

                                    'ledger'

                               ).

    ].

    Landscape isNil ifTrue:[

        Landscape := false

    ].

    PageFormat isNil ifTrue:[

        Language == #us ifTrue:[

            PageFormat := #letter

        ] ifFalse:[

            PageFormat := #a4

        ]

    ]

    "

     DefaultPageFormats := nil.

     DefaultCommands := nil.

     PrintCommand := nil.

     PrinterStream initialize

    "

    "Modified: 4.6.1996 / 17:16:32 / cg"

!

reInitPage

    "nothing done here"

    "Created: 1.6.1996 / 00:49:40 / cg"

! !

!PrinterStream class methodsFor:'instance creation'!

new

    "return a new stream for printing.

     If printFilename is nonNil, printOut goes into that file.

     otherwise, it is piped through the printCommand OS-command."

    ^ self newForFile:(self printFilename).

!

newForFile:aFileNameOrNil

    "return a new stream for printing into aFileName"

    |str printer|

    printer := self basicNew initialize.

    aFileNameOrNil notNil ifTrue:[

        str := aFileNameOrNil asFilename writeStream.

        printer stream:str.

    ].

    printer startPrint.

    ^ printer

    "

     |p|

     p := PostscriptPrinterStream newForFile:'/tmp/out.ps'.

     True printOutOn:p.

     p close.

    "

!

newNative

    "return a new stream for untranslated printing

     (i.e. text should be sent via nextPutUntranslated in the printers native format).

     For example, this is used with PostScriptPrinterStream,

     if the application generates postscript."

    ^ self basicNew initialize setNative; startPrint.

! !

!PrinterStream class methodsFor:'accessing-defaults'!

bottomMargin

    "return the bottomMargin (in inches). Here, no margin is supported,

     but its redefined in some printer classes"

    ^ 0

    "Created: 5.9.1996 / 21:37:49 / cg"

!

defaultCommands

    "UNIX only: 

     return a list presented as possible commands for printing

     (in the launchers printer configuration).

     This list can be set from the startup script with:

        PrinterStream defaultCommands:#( ... )"

    DefaultCommands isNil ifTrue:[

        self == PrinterStream ifFalse:[

            ^ self superclass defaultCommands

        ]

    ].

    ^ DefaultCommands

    "Created: 23.4.1996 / 18:25:18 / cg"

!

defaultCommands:collectionOfCommandStrings

    "UNIX only: 

     set the list which will be presented as possible commands for printing.

     (shown in in the launchers printer configuration).

     This can be done from the startup script with:

        PrinterStream defaultCommands:#( ... )"

    DefaultCommands := collectionOfCommandStrings

    "Created: 23.4.1996 / 18:26:06 / cg"

!

defaultDevices

    "VMS only: 

     return a list presented as possible devices for printers.

     (in the launchers printer configuration).

     This list can be set from the startup script with:

        PrinterStream defaultDevices:#( ... )"

    DefaultDevices isNil ifTrue:[

        self == PrinterStream ifFalse:[

            ^ self superclass defaultDevices

        ]

    ].

    ^ DefaultDevices

!

defaultDevices:collectionOfDeviceNameStrings

    "VMS only:

     set the list which will be presented as possible devices for printing.

     (shown in in the launchers printer configuration).

     This can be done from the startup script with:

        PrinterStream defaultDevices:#( ... )"

    DefaultDevices := collectionOfDeviceNameStrings

!

defaultPageFormats

    "return a list of supported page formats.

     This list can be set from the startup script with:

        PrinterStream defaultPageFormats:#( ... )"

    DefaultPageFormats isNil ifTrue:[

        self == PrinterStream ifFalse:[

            ^ self superclass defaultPageFormats

        ]

    ].

    ^ DefaultPageFormats

    "Created: 23.4.1996 / 18:25:18 / cg"

    "Modified: 11.9.1996 / 11:17:44 / stefan"

!

defaultPageFormats:aList

    "set the list of supported page formats.

     (shown in in the launchers printer configuration).

     This list can be set from the startup script with:

        PrinterStream defaultPageFormats:#( ... ).

     All symbols must be known by UnitConverter"

    DefaultPageFormats := aList.

    "/ validate the list

    aList do:[:name |

        |unit ok|

        ok := true.

        #('W' 'H' 'lW' 'lH') do:[:what |

            unit := (name , what) asSymbolIfInterned.

            (unit isNil 

            or:[(UnitConverter convert:1 from:unit to:#millimeter) isNil]) ifTrue:[

                ok := false

            ]

        ].

        ok ifFalse:[

            ('PRINTER: UnitConverter has no size-info for ''' , name , '''-format') errorPrintCR

        ]

    ].

    "

     PrinterStream

        defaultPageFormats:#(

                                'letter'

                                'a4'

                                'a5'

                                'a6'

                            )

    "

    "Created: 23.4.1996 / 18:25:18 / cg"

    "Modified: 11.9.1996 / 11:19:01 / stefan"

!

defaultPrinter

    OperatingSystem isMSWINDOWSlike ifTrue:[

        WinPrinterStream notNil ifTrue:[

            ^ WinPrinterStream

        ].

    ].

    ^ PrinterStream

    "

     self defaultPrinter

    "

    "Created: / 25-10-2006 / 17:36:21 / cg"

!

landscape

    "return the landscape setting"

    Landscape isNil ifTrue:[

        self == PrinterStream ifFalse:[

            ^ self superclass landscape

        ]

    ].

    ^ Landscape

!

landscape:aBoolean

    "set/clear landscape printing"

    Landscape := aBoolean.

    self reInitPage.

    "Modified: 1.6.1996 / 00:49:22 / cg"

!

leftMargin

    "return the leftMargin (in inches). Here, no margin is supported,

     but its redefined in some printer classes"

    ^ 0

    "Created: 5.9.1996 / 21:37:49 / cg"

    "Modified: 5.9.1996 / 21:39:55 / cg"

!

pageFormat

    "return a symbol describing the default page format.

     This can be set from the startup script with:

        PrinterStream pageFormat:#...

     or via the launchers settings menu."

    PageFormat isNil ifTrue:[

        self == PrinterStream ifFalse:[

            ^ self superclass pageFormat

        ]

    ].

    ^ PageFormat

    "Created: 23.4.1996 / 18:25:18 / cg"

    "Modified: 11.9.1996 / 11:16:51 / stefan"

!

pageFormat:aSymbol

    "set the the default page format to be aSymbol.

     Valid symbols are #letter, #a4, #a5 etc.

     The UnitConverter must contain width/height information on

     that symbol, in order for printing to be correct.

    "

    PageFormat := aSymbol.

    self reInitPage.

    "Created: 23.4.1996 / 18:25:18 / cg"

    "Modified: 1.6.1996 / 00:49:06 / cg"

    "Modified: 11.9.1996 / 11:16:04 / stefan"

!

printCommand

    "UNIX only: 

     return the command used for printing (usually 'lp' or 'lpr').

     This is either set from the startup file, or via the launchers

     settings menu."

    PrintCommand isNil ifTrue:[

        self ~~ PrinterStream ifTrue:[

            ^ self superclass printCommand

        ]

    ].

    ^ PrintCommand

    "Modified: 18.5.1996 / 09:12:35 / cg"

!

printCommand:aString

    "UNIX only:

     set the command for printing (usually 'lp' or 'lpr').

     This is either set from the startup file, or via the launchers

     settings menu."

    PrintCommand := aString

    "

     PrinterStream printCommand:'lpr'

     PrinterStream printCommand:'lpr -h'

     PrinterStream printCommand:'rsh ibm lpr -h'

     PrinterStream printCommand:'gs -sDEVICE=djet500 -sOutputFile=/tmp/stx.ps -sPAPERSIZE=a4 -q -; cat /tmp/stx.ps | rsh ibm lpr -h'

    "

    "Modified: 18.5.1996 / 09:12:48 / cg"

!

printDevice

    "VMS only: return the device for printing (usually 'sys$print:')

     This is either set from the startup file, or via the launchers

     settings menu."

    PrintDevice isNil ifTrue:[

        self == PrinterStream ifFalse:[

            ^ self superclass printDevice

        ]

    ].

    ^ PrintDevice

!

printDevice:aString

    "VMS only:

     set the device for printing (usually 'sys$print:').

     This is either set from the startup file, or via the launchers

     settings menu."

    PrintCommand := aString

    "

     PrinterStream printDevice:'lta1739:'

    "

!

printFilename

    "UNIX only: 

     return the file into which the print-document should be generated.

     If nil (the default), printOut is piped through printCommand, 

     which is usually a variant of the lpr-command."

    ^ PrintFilename

    "

     PrinterStream printFilename

    "

!

printFilename:aString