"

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

"

Object subclass:#DeviceWorkstation

       instanceVariableNames:'displayId

                              visualType monitorType

                              depth ncells bitsPerRGB

                              hasColors hasGreyscales 

                              width height widthMM heightMM resolutionHor resolutionVer

                              knownViews knownIds knownBitmaps knownBitmapIds

                              dispatching

                              controlDown shiftDown metaDown altDown

                              motionEventCompression

                              lastId lastView

                              keyboardMap

       classVariableNames:   'ButtonTranslation MultiClickTimeDelta

                              DeviceErrorSignal'

       poolDictionaries:''

       category:'Interface-Graphics'

!

DeviceWorkstation comment:'

COPYRIGHT (c) 1993 by Claus Gittinger

              All Rights Reserved

written jan 93 by claus

'!

!DeviceWorkstation class methodsFor:'documentation'!

documentation

"

    this abstract class defines common protocol to all Display types.

    instance variables:

    displayId       <Number>        the device id of the display

    visualType      <Symbol>        one of #StaticGray, #PseudoColor, ... #TrueColor

    monitorType     <Symbol>        one of #monochrome, #color, #unknown

    depth           <Integer>       bits per color

    ncells          <Integer>       number of colors (i.e. colormap size; not always == 2^depth)

    bitsPerRGB      <Integer>       number of valid bits per rgb component

                                    (actual number taken in A/D converter; not all devices report the true value)

    hasColors       <Boolean>       true, if display supports colors

    hasGreyscales   <Boolean>       true, if display supports grey-scales (i.e is not b/w display)

    width           <Integer>       number of horizontal pixels

    height          <Integer>       number of vertical pixels 

    heightMM        <Number>        screen height in millimeter

    widthMM         <Number>        screen width in millimeter

    resolutionHor   <Number>        pixels per horizontal millimeter

    resolutionVer   <Number>        pixels per vertical millimeter

    knownViews      <Collection>    all views known

    knownIds        <Collection>    corresponding device-view ids

    knownBitmaps    <Collection>    all known device bitmaps

    knownBitmapIds  <Collection>    corresponding device-bitmap ids

    dispatching     <Boolean>       true, if currently in dispatch loop

    controlDown     <Boolean>       true, if control key currently pressed

    shiftDown       <Boolean>       true, if shift key currently pressed

    metaDown        <Boolean>       true, if meta key (cmd-key) is currently pressed

    altDown         <Boolean>       true, if alt key is currently pressed

    motionEventCompression

    keyboardMap     <KeyBdMap>      mapping for keys

    isSlow          <Boolean>       set/cleared from startup - used to turn off

                                    things like popup-shadows etc.

"

! !

!DeviceWorkstation class methodsFor:'initialization'!

initialize

    DeviceErrorSignal isNil ifTrue:[

        DeviceErrorSignal := (Signal new) mayProceed:true.

        DeviceErrorSignal notifierString:'device error'.

    ].

!

initializeConstants

    "initialize some (soft) constants"

    ButtonTranslation := #(1 2 3)     "identity translation"

! !

!DeviceWorkstation class methodsFor:'signal access'!

deviceErrorSignal

    "return the signal used for device error reporting"

    ^ DeviceErrorSignal

! !

!DeviceWorkstation class methodsFor:'accessing'!

buttonTranslation:anArray

    "set the button translation, #(1 2 3) is no-translation,

     #(3 2 1) is ok for left-handers"

    ButtonTranslation := anArray

! !

!DeviceWorkstation methodsFor:'initialize / release'!

initialize

    "initialize the receiver for a connection to the default display"

    ^ self initializeFor:nil

!

initializeFor:aDisplayOrNilForAny

    "initialize the receiver for a connection to a display. If the

     argument is non-nil, it should specify which workstation should be

     connected to (in a device specific manner). For X displays, this is

     to be the display-string i.e. hostname:displayNr.

     If the argument is nil,  connect to the default display."

    self subclassResponsibility

!

close

    "close down connection to Display - usually never done"

    ^ self subclassResponsibility

!

reinitialize

    "reinit after snapin"

    |prevKnownViews|

    displayId := nil.

    prevKnownViews := knownViews.

    knownViews := nil.

    knownIds := nil.

    self initializeFor:nil.

    Form reinitializeAllOn:self.

    prevKnownViews notNil ifTrue:[

        "

         first round: flush all device specific stuff

        "

        prevKnownViews do:[:aView |

            aView notNil ifTrue:[

                aView prepareForReinit

            ]

        ].

        "

         2nd round: all views should reinstall themself

                    on the new display

        "

        prevKnownViews do:[:aView |

            aView notNil ifTrue:[

                "have to re-create the view"

                aView reinitialize

            ]

        ].

        "

         3rd round: all views get a chance to handle

                    changed environment (colors, font sizes etc)

        "

        prevKnownViews do:[:aView |

            aView notNil ifTrue:[

                aView reAdjustGeometry

            ]

        ]

    ].

    dispatching := false.

!

initializeKeyboardMap

    "keystrokes from the server are translated via the keyboard map.

     Untranslated keystrokes arrive either as characters, or symbols

     (which are the keySyms as symbol). The mapping table which is

     setup here, is used in sendKeyPress:... later.

    "

    keyboardMap := KeyboardMap new.

    "

     no more setup here - moved everything out into 'display.rc' file

    "

! !

!DeviceWorkstation class methodsFor:'error handling'!

resourceIdOfLastError

    "return the resource id responsible for the last error"

    ^ self subclassResponsibility

!

lastError

    "return a string descibing the last error"

    ^ self subclassResponsibility

!

errorInterrupt

    "x-error interrupt"

    |badId badResource|

    badId := self resourceIdOfLastError.

    badId ~~ 0 ifTrue:[

        badResource := self resourceOfId:badId.

    ].

    ^ DeviceErrorSignal

            raiseRequestWith:badResource

            errorString: 'Display error: ' , (self lastError)

!

resourceOfId:id

    "search thru all device stuff for a resource.

     Needed for error handling"

    Form allInstances do:[:f |

        f id == id ifTrue:[^ f]

    ].

    self allInstances do:[:aDisplay |

        |views|

        views := aDisplay knownViews.

        views notNil ifTrue:[

            views do:[:v |

                v id == id ifTrue:[^ v].

                v gcId == id ifTrue:[^ v]

            ].

        ].

    ].

    Color allInstances do:[:c |

        c colorId == id ifTrue:[^ c]

    ].

    Font allInstances do:[:f |

        f fontId == id ifTrue:[^ f]

    ].

    ^ nil

! !

!DeviceWorkstation methodsFor:'misc'!

metaDown

    "return true, if the meta-key (alt-key on systems without meta)

    ^ metaDown

!

altDown

    ^ altDown

!

controlDown

    ^ controlDown

!

shiftDown

    ^ shiftDown

!

unBuffered

    "make all drawing be sent immediately to the display"

    ^ self

!

buffered

    "buffer drawing - do not send it immediately to the display"

    ^ self

!

synchronizeOutput

    "send all buffered drawing to the display"

    ^ self

!

compressMotionEvents:aBoolean

    "turn on/off motion event compression 

     - compressions makes always sense except in free-hand drawing of curves"

    motionEventCompression := aBoolean

!

hasColors:aBoolean

    "set the hasColors flag - needed since some servers dont tell the

     truth if a monochrome monitor is connected to a color server"

    hasColors := aBoolean

!

hasGreyscales:aBoolean

    "set the hasGreyscales flag - can be used to simulate b&w behavior"

    hasGreyscales := aBoolean

!

ignoreBackingStore:aBoolean

    "if the argument is true, the views backingStore setting will be ignored, and

     no backing store used - this can be used on servers where backing store is

     very slow (from rc-file)"

    ^ self

!

isSlow:aBoolean

    "set/clear the slow flag"

    isSlow := aBoolean

!

beep

    "output an audible beep or bell"

    Stdout nextPut:(Character bell)

!

setInputFocusTo:aWindowId

    ^ self subclassResponsibility

! !

!DeviceWorkstation methodsFor:'enumeration'!

allViewsDo:aBlock

    "evaluate the argument, aBlock for all known views"

    knownViews notNil ifTrue:[

        knownViews do:[:aView |

            aView notNil ifTrue:[

                aBlock value:aView

            ]

        ]

    ]

    "

     View defaultStyle:#iris.

     Display allViewsDo:[:v | v initStyle. v redraw]

    "

    "

     View defaultStyle:#next.

     Display allViewsDo:[:v | v initStyle. v redraw]

    "

    "

     View defaultStyle:#normal.

     Display allViewsDo:[:v | v initStyle. v redraw]

    "

! !

!DeviceWorkstation methodsFor:'accessing & queries'!

displayFileDescriptor

    "return the file descriptor associated with the display

     if any. If there is no underlying filedescriptor, return nil.

     (used for event select/polling)"

    ^ nil

!

serverVendor

    "return a string describing the server vendor

     - returns a dummy here"

    ^ 'generic'

!

vendorRelease

    "return a workstation release number

     - returns a dummy here"

    ^ 0

!

protocolVersion

    "return a protocol version number

     - returns a dummy here"

    ^ 0

!

blackpixel

    "return the colorId of black"

    ^ self subclassResponsibility

!

whitepixel

    "return the colorId of white"

    ^ self subclassResponsibility

!

viewIdFromPoint:aPoint in:windowId

    "given a point in rootWindow, return the viewId of the subview of windowId

     hit by this coordinate. Return nil if no view was hit.

     - use to find window to drop objects after a cross-view drag"

    "returning nil here actually makes drag&drop impossible

     - could also be reimplemented to make a search over all knownViews here"

    ^ nil

!

translatePoint:aPoint from:windowId1 to:windowId2

    "given a point in window1, return the coordinate in window2

     - use to xlate points from a window to rootwindow"

    "could be reimplemented to make a search over all knownViews here"

    ^ self subclassResponsibility

!

id

    "return the displayId"

    ^ displayId

!

ncells

    "return the number of usable color cells, the display has 

     - this is not always the 2 to the power of depth."

    ^ ncells

    "Display ncells"

!

depth

    "return the depth in pixels of the display"

    ^ depth

    "Display depth"

!

bitsPerRGB

    "return the number of valid bits per rgb component"

    ^ bitsPerRGB

    "Display bitsPerRGB"

!

visualType:aSymbol

    "set the visual type. The only situation, where this makes sense,

     is with my plasma-display, which ignores the palette and spits out

     grey scales, independent of LUT definitions. 

     (of which the server knows nothing).

     So, this should be used from a display-specific startup file only."

    visualType := aSymbol.

    (visualType == #StaticGray or:[visualType == #GrayScale]) ifTrue:[

        hasColors := false

    ] ifFalse:[

        hasColors := true

    ]

!

visualType

    "return a symbol representing the visual type of the display"

    ^ visualType

    "Display visualType"

!

monitorType

    "return a symbol representing the monitor type of the display.

     It is usually set to #unknown, #color or #monochrome.

     But it can be set to any value from the startup file, for later

     testing from anywhere. For example the startup for plasma-displays