def test_ConstructorFromInstance(self):
data = '\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09'
p = Palette(data)
p2 = Palette(p)
for i in range(1, 11):
assert p[i] == p2[i]
def getPalette(self):
blue = Palette(self.cpBlueWindow)
cyan = Palette(self.cpCyanWindow)
gray = Palette(self.cpGrayWindow)
palettes = (blue, cyan, gray)
return palettes[self.palette]
def getPalette(self):
return Palette(self.cpInfoPane)
def test_index(self):
data = '\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09'
p = Palette(data)
for i in range(1, 11):
assert p[i] == i - 1
def getPalette(self):
palette = Palette(self.cpStaticText)
return palette
def getPalette(self):
palette = Palette(self.cpMenuView)
return palette
def getPalette(self):
palette = Palette(self.cpMemo)
return palette
def getPalette(self):
return Palette(self.cpMsgList)
def getPalette(self):
palette = Palette(self.cpFrame)
return palette
def getPalette(self):
return Palette(self.cpProgressBar)
def getPalette(self):
return Palette(self.cpIndicator)
class Dialog(Window):
name = 'Dialog'
cpGrayDialog = (
'\x20\x21\x22\x23\x24\x25\x26\x27\x28\x29\x2A\x2B\x2C\x2D\x2E\x2F' +
'\x30\x31\x32\x33\x34\x35\x36\x37\x38\x39\x3A\x3B\x3C\x3D\x3E\x3F')
cpBlueDialog = (
'\x40\x41\x42\x43\x44\x45\x46\x47\x48\x49\x4a\x4b\x4c\x4d\x4e\x4f' +
'\x50\x51\x52\x53\x54\x55\x56\x57\x58\x59\x5a\x5b\x5c\x5d\x5e\x5f')
cpCyanDialog = (
'\x60\x61\x62\x63\x64\x65\x66\x67\x68\x69\x6a\x6b\x6c\x6d\x6e\x6f' +
'\x70\x71\x72\x73\x74\x75\x76\x77\x78\x79\x7a\x7b\x7c\x7d\x7e\x7f')
cpDialog = cpGrayDialog
paletteBlue = Palette(cpBlueDialog)
paletteCyan = Palette(cpCyanDialog)
paletteGray = Palette(cpGrayDialog)
_palettes = [paletteBlue, paletteCyan, paletteGray]
def __init__(self, bounds, title):
super().__init__(bounds, title, 0)
self.growMode = 0
self.flags = wfMove | wfClose
self.palette = dpGrayDialog
def getPalette(self):
return self._palettes[self.palette]
def handleEvent(self, event):
super().handleEvent(event)
if event.what == evKeyDown:
kc = event.keyDown.keyCode
if kc == kbEsc:
event.what = evCommand
event.message.command = cmCancel
event.message.infoPtr = None
self.putEvent(event)
self.clearEvent(event)
elif kc == kbEnter:
event.what = evBroadcast
event.message.command = cmDefault
event.message.infoPtr = None
self.putEvent(event)
self.clearEvent(event)
elif event.what == evCommand:
command = event.message.command
if command in {cmOK, cmCancel, cmYes, cmNo}:
if self.state & sfModal:
self.endModal(command)
self.clearEvent(event)
def valid(self, command):
if command == cmCancel:
return True
return super().valid(command)
def getPalette(self):
palette = Palette(self.cpListViewer)
return palette
def getPalette(self):
palette = Palette(self.cpEditor)
return palette
def getPalette(self):
return Palette(self.cpMessageWindow)
def getPalette(self):
return Palette(self.cpPuzzlePalette)
def getPalette(self):
palette = Palette(self.cpScrollBar)
return palette
def getPalette(self):
if isinstance(self.inputLine, StaticInputLine):
return Palette(self.cpSComboBox)
return Palette(self.cpComboBox)
def getPalette(self):
palette = Palette(self.cpInputLine)
return palette
class Program(Group):
"""
The mother of `Application`.
`Program` provides the basic template for all standard vindauga
applications. All programs must be derived from `Program` or its immediate
derived class, `Application`. `Application` differs from `Program`
only for its constructor and destructor. However most applications will
be derived from `Application`.
"""
exitText = _('~Alt+X~ Exit')
desktop = None
application = None
cpAppColor = "\x71\x70\x78\x74\x20\x28\x24\x17\x1F\x1A\x31\x31\x1E\x71\x1F" \
"\x37\x3F\x3A\x13\x13\x3E\x21\x3F\x70\x7F\x7A\x13\x13\x70\x7F\x7E" \
"\x70\x7F\x7A\x13\x13\x70\x70\x7F\x7E\x20\x2B\x2F\x78\x2E\x70\x30" \
"\x3F\x3E\x1F\x2F\x1A\x20\x72\x31\x31\x30\x2F\x3E\x31\x13\x38\x00" \
"\x17\x1F\x1A\x71\x71\x1E\x17\x1F\x1E\x20\x2B\x2F\x78\x2E\x10\x30" \
"\x3F\x3E\x70\x2F\x7A\x20\x12\x31\x31\x30\x2F\x3E\x31\x13\x38\x00" \
"\x37\x3F\x3A\x13\x13\x3E\x30\x3F\x3E\x20\x2B\x2F\x78\x2E\x30\x70" \
"\x7F\x7E\x1F\x2F\x1A\x20\x32\x31\x71\x70\x2F\x7E\x71\x13\x78\x00" \
"\x37\x3F\x3A\x13\x13\x30\x3E\x1E" # help colors
cpAppBlackWhite = "\x70\x70\x78\x7F\x07\x07\x0F\x07\x0F\x07\x70\x70\x07\x70\x0F" \
"\x07\x0F\x07\x70\x70\x07\x70\x0F\x70\x7F\x7F\x70\x07\x70\x07\x0F" \
"\x70\x7F\x7F\x70\x07\x70\x70\x7F\x7F\x07\x0F\x0F\x78\x0F\x78\x07" \
"\x0F\x0F\x0F\x70\x0F\x07\x70\x70\x70\x07\x70\x0F\x07\x07\x08\x00" \
"\x07\x0F\x0F\x07\x70\x07\x07\x0F\x0F\x70\x78\x7F\x08\x7F\x08\x70" \
"\x7F\x7F\x7F\x0F\x70\x70\x07\x70\x70\x70\x07\x7F\x70\x07\x78\x00" \
"\x70\x7F\x7F\x70\x07\x70\x70\x7F\x7F\x07\x0F\x0F\x78\x0F\x78\x07" \
"\x0F\x0F\x0F\x70\x0F\x07\x70\x70\x70\x07\x70\x0F\x07\x07\x08\x00" \
"\x07\x0F\x07\x70\x70\x07\x0F\x70" # Help colors
cpAppMonochrome = "\x70\x07\x07\x0F\x70\x70\x70\x07\x0F\x07\x70\x70\x07\x70\x00" \
"\x07\x0F\x07\x70\x70\x07\x70\x00\x70\x70\x70\x07\x07\x70\x07\x00" \
"\x70\x70\x70\x07\x07\x70\x70\x70\x0F\x07\x07\x0F\x70\x0F\x70\x07" \
"\x0F\x0F\x07\x70\x07\x07\x70\x07\x07\x07\x70\x0F\x07\x07\x70\x00" \
"\x70\x70\x70\x07\x07\x70\x70\x70\x0F\x07\x07\x0F\x70\x0F\x70\x07" \
"\x0F\x0F\x07\x70\x07\x07\x70\x07\x07\x07\x70\x0F\x07\x07\x01\x00" \
"\x70\x70\x70\x07\x07\x70\x70\x70\x0F\x07\x07\x0F\x70\x0F\x70\x07" \
"\x0F\x0F\x07\x70\x07\x07\x70\x07\x07\x07\x70\x0F\x07\x07\x01\x00" \
"\x07\x0F\x07\x70\x70\x07\x0F\x70"
color = Palette(cpAppColor)
blackWhite = Palette(cpAppBlackWhite)
monochrome = Palette(cpAppMonochrome)
palettes = [color, blackWhite, monochrome]
apColor = 0
apBlackWhite = 1
apMonochrome = 2
pending = queue.Queue()
def __init__(self):
w = Screen.screenWidth
h = Screen.screenHeight
super().__init__(Rect(0, 0, w, h))
self.appPalette = self.apColor
self.initScreen()
self.state = sfVisible | sfSelected | sfFocused | sfModal | sfExposed
self.options = 0
self.buffer = Screen.screenBuffer
self.statusLine = None
self.menuBar = None
Program.desktop = self.initDesktop(self.getExtent())
self.insert(Program.desktop)
self.statusLine = self.initStatusLine(self.getExtent())
self.insert(self.statusLine)
self.menuBar = self.initMenuBar(self.getExtent())
self.insert(self.menuBar)
Screen.doRepaint += 1
def shutdown(self):
self.statusLine = None
self.menuBar = None
Program.desktop = None
super().shutdown()
def canMoveFocus(self):
"""
Returns True if the focus can be moved from one (desktop) view to another
one.
It returns `deskTop.valid(cmReleasedFocus)`.
:return: True if the focus can be moved
"""
return self.desktop.valid(cmReleasedFocus)
def executeDialog(self, pD, data):
"""
Executes a dialog.
`pD` points to the dialog. The dialog is executed only if it is valid.
`data` is a data record which is set on the dialog before executing and
read afterwards. If `data` is None no data will be set.
This method calls `execView()` to execute the dialog. The
dialog is destroyed before returning from the function, so a call to
delete is not necessary. `executeDialog()` returns `cmCancel` if the view
is not valid, otherwise it returns the return value of `execView()`.
:param pD: Dialog to execute
:param data: Data to set on dialog
:return: tuple of `executeDate()` call and the data
"""
logger.info('executeDialog(%s)', pD)
c = cmCancel
if self.validView(pD):
if data:
pD.setData(data)
try:
c = Program.desktop.execView(pD)
except:
logger.exception('Dialog failed.')
c = cmCancel
if c != cmCancel:
data = pD.getData()
self.destroy(pD)
return c, data
def getEvent(self, event):
"""
Gets an event.
This method collects events from the system like key events, mouse
events and timer events and returns them in the `event` instance.
`getEvent()` first checks if `Program.putEvent()` has generated a
pending event. If so, `getEvent()` returns that event. If there is no
pending event, `getEvent()` calls `Screen.getEvent()`.
If both calls return `evNothing`, indicating that no user input is
available, `getEvent()` calls `Program.idle()` to allow "background"
tasks to be performed while the application is waiting for user input.
Before returning, `getEvent()` passes any `evKeyDown` and
`evMouseDown` events to the `statusLine` for it to map into
associated `evCommand` hot key events.
:param event: Event object to be modified
"""
if Program.pending.qsize():
event.setFrom(Program.pending.get())
else:
Screen.getEvent(event)
if event.what == evCommand:
c = event.message.command
if c == cmSysRepaint:
self.redraw()
self.clearEvent(event)
elif c == cmSysResize:
Screen.curX = Screen.curY = 0
self.buffer = Screen.screenBuffer
self.changeBounds(
Rect(0, 0, Screen.screenWidth, Screen.screenHeight))
self.setState(sfExposed, False)
self.setState(sfExposed, True)
self.redraw()
self.clearEvent(event)
elif c == cmSysWakeup:
self.idle()
self.clearEvent(event)
if self.statusLine:
if ((event.what & evKeyDown) or (event.what & evMouseDown) and
self.firstThat(self.hasMouse, event) is self.statusLine):
self.statusLine.handleEvent(event)
def putEvent(self, event):
"""
Sets a pending event.
Puts an event in the pending state, by storing a copy of the `event`
structure in the `pending` variable, a member of `Program`.
Only one event is allowed to be pending. The next call to
`getEvent()` will return this pending event even if there are
other events in the system queue to be handled.
:param event: Event to place in the queue
"""
e = Event(evNothing)
e.setFrom(event)
Program.pending.put(e)
def handleEvent(self, event):
"""
Standard `Program` event handler.
This method first checks for keyboard events. When it catches keys from
Alt-1 to Alt-9 it generates an `evBroadcast` event with the `command`
field equal to `cmSelectWindowNum` and the `infoPtr` field in the range 1
to 9.
Then it calls `Group.handleEvent()`.
Last it checks for a `cmQuit` command in a `evCommand` event. On
success it calls `Group.endModal(cmQuit)` to end the modal state. This
causes the `Program.run()` method to return. In most applications
this will result in program termination.
Method `handleEvent()` is almost always overridden to introduce handling
of commands that are specific to your own application.
:param event: Event to be handled
"""
if event.what == evKeyDown:
c = getAltChar(event.keyDown.keyCode)
if isinstance(c, int):
c = chr(c)
if '1' <= c <= '9':
if self.canMoveFocus():
if message(Program.desktop, evBroadcast, cmSelectWindowNum,
int(c)):
self.clearEvent(event)
else:
self.clearEvent(event)
super().handleEvent(event)
if event.what == evCommand and event.message.command == cmQuit:
self.endModal(cmQuit)
self.clearEvent(event)
def getPalette(self):
return self.palettes[self.appPalette]
def setPalette(self, palette):
self.palettes[self.appPalette] = palette
def idle(self):
"""
Called when in idle state.
This method is called whenever the library is in idle state, i.e. there
is not any event to serve. It allows the application to perform
background tasks while waiting for user input.
The default idle() calls `statusLine.update()` to allow the status line
to update itself according to the current help context. Then, if the
command set has changed since the last call to `idle()`, an
`evBroadcast` with a command value of `cmCommandSetChanged` is
generated to allow views that depend on the command set to enable or
disable themselves.
The user may redefine this method, for example, to update a clock in
like the `vindauga_demo` program does.
"""
if self.statusLine:
self.statusLine.update()
if View.commandSetChanged:
message(self, evBroadcast, cmCommandSetChanged, None)
View.commandSetChanged = False
def initDesktop(self, bounds):
"""
Creates a new desktop.
This method creates a standard `Desktop` view and returns it
`initDesktop()` should never be called directly. Few applications need to
redefine it to have a custom desktop, instead of the default empty
`Desktop`
:param bounds: Bounds of the screen.
:return: `Desktop` object
"""
bounds.bottomRight.y -= 1
bounds.topLeft.y += 1
return Desktop(bounds)
def initScreen(self):
"""
Initializes the screen.
This method is called by the `Program` constructor and
`setScreenMode()` every time the screen mode is initialized or
changed.
Performs the updating and adjustment of screen mode-dependent variables
for shadow size, markers and application palette (color, monochrome or
black & white). The shadows are usually painted in the right and bottom
sides of menus and windows.
"""
global showMarkers
if Screen.screenMode & 0x00FF != Display.smMono:
if Screen.screenMode & Display.smFont8x8:
SHADOW_SIZE.x = 1
else:
SHADOW_SIZE.x = 2
SHADOW_SIZE.y = 1
showMarkers = False
if Screen.screenMode & 0x00FF == Display.smBW80:
self.appPalette = self.apBlackWhite
else:
self.appPalette = self.apColor
else:
SHADOW_SIZE.x = 0
SHADOW_SIZE.y = 0
showMarkers = True
self.appPalette = self.apMonochrome
def initMenuBar(self, bounds):
"""
Creates a new menu bar.
This method creates a standard `MenuBar` view and returns it.
`initMenuBar()` should never be called directly. `initMenuBar()` is almost
always overridden to instantiate a user defined `MenuBar`
instead of the default empty `MenuBar`.
:param bounds: Bounds of the screen. Modify to be the top line...
:return: A MenuBar object.
"""
bounds.bottomRight.y = bounds.topLeft.y + 1
return MenuBar(bounds, [])
def initStatusLine(self, bounds):
"""
Creates a new status line.
This method creates a standard `StatusLine` view and returns it
`initStatusLine()` should never be called directly. `initStatusLine()` is
almost always overridden to instantiate a user defined `StatusLine`
instead of the default empty `StatusLine`.
:param bounds: Bounds of the screen. Modify to reduce to the bottom line...
:return: A `StatusLine` object
"""
bounds.topLeft.y = bounds.bottomRight.y - 1
return StatusLine(
bounds,
StatusDef(0, 0xFFFF) + StatusItem(self.exitText, kbAltX, cmQuit) +
StatusItem('', kbF10, cmMenu) + StatusItem('', kbCtrlW, cmClose) +
StatusItem('', kbF5, cmZoom) + StatusItem('', kbCtrlF5, cmResize))
def insertWindow(self, window):
"""
Inserts a window in the `Program`.
:param window: Window to insert
:return: The inserted window
"""
if self.validView(window):
if self.canMoveFocus():
Program.desktop.insert(window)
return window
else:
self.destroy(window)
return None
def outOfMemory(self):
raise Exception
def run(self):
"""
Runs `Program`.
Executes `Program` by calling its method `execute()`, which `Program`
inherits from `Group`.
"""
self.execute()
def setScreenMode(self, *_args):
"""
Resizes and redraws the screen.
:param _args: unused. Used to be screen mode.
"""
r = Rect(0, 0, Screen.screenWidth, Screen.screenHeight)
self.changeBounds(r)
self.setState(sfExposed, False)
self.setState(sfExposed, True)
self.redraw()
def validView(self, view):
"""
Checks if a view is valid.
Returns `view` if the view pointed by `view` is valid. Otherwise returns None.
First, if `view` is None the call returns None.
Last if a call to `view.valid(cmValid)` returns False the view pointed by
`view` is released and the function returns None.
Otherwise, the view is considered valid, and pointer `view` is returned.
:param view: View to test
:return: View or None
"""
if not view:
return None
if not view.valid(cmValid):
self.destroy(view)
return None
return view
def getPalette(self):
return Palette(self.cpButton)
def getPalette(self):
palette = Palette(self.cpHistoryViewer)
return palette
def getPalette(self):
return Palette(self.cpComboViewer)
def getPalette(self):
return Palette(self.cpComboWindow)
def getPalette(self):
palette = Palette(self.cpCluster)
return palette
def getPalette(self):
return Palette(self.cpStaticPrompt)
def getPalette(self):
palette = Palette(self.cpHistoryWindow)
return palette
def getPalette(self):
return Palette(self.cpMousePalette)
def getPalette(self):
palette = Palette(self.cpLabel)
return palette
def getPalette(self):
palette = Palette(self.cpStatusLine)
return palette
