#!/usr/bin/env python3
-
import urwid
import plom_socket_io
import socket
import threading
+from parser import ArgError, Parser
+
+
+class Game:
+ turn = 0
+ log_text = ''
+ map_size = (0, 0)
+ terrain_map = ''
+ things = []
+
+ class Thing:
+ def __init__(self, id_, position, symbol):
+ self.id_ = id_
+ self.position = position
+ self.symbol = symbol
+
+ def log(self, msg):
+ """Prefix msg plus newline to self.log_text."""
+ self.log_text = msg + '\n' + self.log_text
+
+ def get_thing(self, i):
+ for thing in self.things:
+ if i == thing.id_:
+ return thing
+ t = self.Thing(i, [0,0], '?')
+ self.things += [t]
+ return t
+
+ def cmd_THING_TYPE(self, i, type_):
+ t = self.get_thing(i)
+ symbol = '?'
+ if type_ == 'human':
+ symbol = '@'
+ elif type_ == 'monster':
+ symbol = 'm'
+ t.symbol = symbol
+ cmd_THING_TYPE.argtypes = 'int:nonneg string'
+
+ def cmd_THING_POS(self, i, yx):
+ t = self.get_thing(i)
+ t.position = list(yx)
+ cmd_THING_POS.argtypes = 'int:nonneg yx_tuple:nonneg'
+
+ def cmd_THING_POS(self, i, yx):
+ t = self.get_thing(i)
+ t.position = list(yx)
+ cmd_THING_POS.argtypes = 'int:nonneg yx_tuple:nonneg'
+
+ def cmd_MAP_SIZE(self, yx):
+ """Set self.map_size to yx, redraw self.terrain_map as '?' cells."""
+ y, x = yx
+ self.map_size = (y, x)
+ self.terrain_map = ''
+ for y in range(self.map_size[0]):
+ self.terrain_map += '?' * self.map_size[1]
+ cmd_MAP_SIZE.argtypes = 'yx_tuple:nonneg'
+
+ def cmd_TURN_FINISHED(self, n):
+ """Do nothing. (This may be extended later.)"""
+ pass
+ cmd_TURN_FINISHED.argtypes = 'int:nonneg'
+
+ def cmd_NEW_TURN(self, n):
+ """Set self.turn to n, empty self.things."""
+ self.turn = n
+ self.things = []
+ cmd_NEW_TURN.argtypes = 'int:nonneg'
+
+ def cmd_TERRAIN_LINE(self, y, terrain_line):
+ width_map = self.map_size[1]
+ if y >= self.map_size[0]:
+ raise ArgError('too large row number %s' % y)
+ width_line = len(terrain_line)
+ if width_line > width_map:
+ raise ArgError('too large map line width %s' % width_line)
+ self.terrain_map = self.terrain_map[:y * width_map] + \
+ terrain_line + self.terrain_map[(y + 1) * width_map:]
+ cmd_TERRAIN_LINE.argtypes = 'int:nonneg string'
+
+
+class WidgetManager:
+
+ def __init__(self, socket, game):
+ """Set up all urwid widgets we want on the screen."""
+ self.game = game
+ edit_widget = self.EditToSocketWidget(socket, 'SEND: ')
+ self.map_widget = urwid.Text('', wrap='clip')
+ self.turn_widget = urwid.Text('')
+ self.log_widget = urwid.Text('')
+ map_box = urwid.Padding(self.map_widget, width=50)
+ widget_pile = urwid.Pile([edit_widget, map_box, self.turn_widget,
+ self.log_widget])
+ self.top = urwid.Filler(widget_pile, valign='top')
+
+ def draw_map(self):
+ """Draw map view from .game.terrain_map, .game.things."""
+ map_lines = []
+ map_size = len(self.game.terrain_map)
+ start_cut = 0
+ while start_cut < map_size:
+ limit = start_cut + self.game.map_size[1]
+ map_lines += [self.game.terrain_map[start_cut:limit]]
+ start_cut = limit
+ for t in self.game.things:
+ line_as_list = list(map_lines[t.position[0]])
+ line_as_list[t.position[1]] = t.symbol
+ map_lines[t.position[0]] = ''.join(line_as_list)
+ return "\n".join(map_lines)
+
+ def update(self):
+ """Redraw all non-edit widgets."""
+ self.turn_widget.set_text('TURN: ' + str(self.game.turn))
+ self.log_widget.set_text(self.game.log_text)
+ self.map_widget.set_text(self.draw_map())
+
+ class EditToSocketWidget(urwid.Edit):
+ """Extends urwid.Edit with socket to send input on 'enter' to."""
+ def __init__(self, socket, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+ self.socket = socket
-class ArgumentError(Exception):
- pass
+ def keypress(self, size, key):
+ """Extend super(): on Enter, send .edit_text, and empty it."""
+ if key != 'enter':
+ return super().keypress(size, key)
+ plom_socket_io.send(self.socket, self.edit_text)
+ self.edit_text = ''
-class UrwidSetup:
+class PlomRogueClient:
- def __init__(self, socket):
+ def __init__(self, game, socket):
"""Build client urwid interface around socket communication.
Sets up all widgets for writing to the socket and representing data
- from it. Sending via a self.EditToSocket widget is straightforward;
- polling the socket for input from the server in parallel to the urwid
- main loop not so much:
+ from it. Sending via a WidgetManager.EditToSocket widget is
+ straightforward; polling the socket for input from the server in
+ parallel to the urwid main loop not so much:
The urwid developers warn against sharing urwid resources among
threads, so having a socket polling thread for writing to an urwid
write socket.recv output to an object that is then linked to by
self.server_output (which is known to the urwid thread), then use the
pipe to urwid to trigger it pulling new data from self.server_output to
- handle via self.InputHandler. (We *could* pipe socket.recv output
+ handle via self.handle_input. (We *could* pipe socket.recv output
directly, but then we get complicated buffering situations here as well
as in the urwid code that receives the pipe output. It's easier to just
tell the urwid code where it finds full new server messages to handle.)
"""
+ self.game = game
+ self.parser = Parser(self.game)
self.socket = socket
- self.main_loop = urwid.MainLoop(self.setup_widgets())
+ self.widget_manager = WidgetManager(self.socket, self.game)
self.server_output = []
- input_handler = getattr(self.InputHandler(self.reply_widget,
- self.map_widget,
- self.server_output),
- 'handle_input')
- self.urwid_pipe_write_fd = self.main_loop.watch_pipe(input_handler)
+ self.urwid_loop = urwid.MainLoop(self.widget_manager.top)
+ self.urwid_pipe_write_fd = self.urwid_loop.watch_pipe(self.
+ handle_input)
self.recv_loop_thread = threading.Thread(target=self.recv_loop)
- def setup_widgets(self):
- """Return container widget with all widgets we want on our screen.
+ def handle_input(self, trigger):
+ """On input from recv_loop thread, parse and enact commands.
- Sets up an urwid.Pile inside a returned urwid.Filler; top to bottom:
- - an EditToSocketWidget, prefixing self.socket input with 'SEND: '
- - a 50-col wide urwid.Padding container for self.map_widget, which is
- to print clipped map representations
- - self.reply_widget, a urwid.Text widget printing self.socket replies
- """
- edit_widget = self.EditToSocketWidget(self.socket, 'SEND: ')
- self.reply_widget = self.LogWidget('')
- self.map_widget = self.MapWidget('', wrap='clip')
- map_box = urwid.Padding(self.map_widget, width=50)
- widget_pile = urwid.Pile([edit_widget, map_box, self.reply_widget])
- return urwid.Filler(widget_pile, valign='top')
+ Serves as a receiver to urwid's watch_pipe mechanism, with trigger the
+ data that a pipe defined by watch_pipe delivers. To avoid buffering
+ trouble, we don't care for that data beyond the fact that its receival
+ triggers this function: The sender is to write the data it wants to
+ deliver into the container referenced by self.server_output, and just
+ pipe the trigger to inform us about this.
- class EditToSocketWidget(urwid.Edit):
- """Extends urwid.Edit with socket to send input on 'enter' to."""
-
- def __init__(self, socket, *args, **kwargs):
- super().__init__(*args, **kwargs)
- self.socket = socket
-
- def keypress(self, size, key):
- """Extend super(): on Enter, send .edit_text, and empty it."""
- if key != 'enter':
- return super().keypress(size, key)
- plom_socket_io.send(self.socket, self.edit_text)
- self.edit_text = ''
-
- class LogWidget(urwid.Text):
- """Display client log, newest message on top."""
-
- def add(self, text):
- """Add text to (top of) log."""
- self.set_text(text + '\n' + self.text)
-
- class MapWidget(urwid.Text):
- """Stores/updates/draws game map."""
- map_size = (5, 5)
- terrain_map = ' ' * 25
- position = (0, 0)
-
- def draw_map(self):
- """Draw map view from .map_size, .terrain_map, .position."""
- whole_map = []
- for c in self.terrain_map:
- whole_map += [c]
- pos_i = self.position[0] * (self.map_size[1] + 1) + self.position[1]
- whole_map[pos_i] = '@'
- self.set_text(''.join(whole_map))
-
- def get_yx(self, yx_string):
-
- def get_axis_position_from_argument(axis, token):
- if len(token) < 3 or token[:2] != axis + ':' or \
- not token[2:].isdigit():
- raise ArgumentError('Bad arg for ' + axis + ' position.')
- return int(token[2:])
-
- tokens = yx_string.split(',')
- if len(tokens) != 2:
- raise ArgumentError('wrong number of ","-separated arguments')
- y = get_axis_position_from_argument('Y', tokens[0])
- x = get_axis_position_from_argument('X', tokens[1])
- return (y, x)
-
- def update_map_size(self, size_string):
- """Set map size, redo self.terrain_map in new size, '?'-filled."""
- new_map_size = self.get_yx(size_string)
- if 0 in new_map_size:
- raise ArgumentError('size value for either axis must be >0')
- self.map_size = new_map_size
- self.terrain_map = ''
- for y in range(self.map_size[0]):
- self.terrain_map += '?' * self.map_size[1] + '\n'
- self.draw_map()
-
- def update_terrain(self, terrain_map):
- """Update self.terrain_map. Ensure size matching self.map_size."""
- lines = terrain_map.split('\n')
- if len(lines) != self.map_size[0]:
- raise ArgumentError('wrong map height')
- for line in lines:
- if len(line) != self.map_size[1]:
- raise ArgumentError('wrong map width')
- self.terrain_map = terrain_map
- self.draw_map()
-
- def update_position(self, position_string):
- """Update self.position, ensure it's within map bounds."""
-
- def get_axis_position_from_argument(axis, token):
- if len(token) < 3 or token[:2] != axis + ':' or \
- not token[2:].isdigit():
- raise ArgumentError('Bad arg for ' + axis + ' position.')
- return int(token[2:])
-
- new_position = self.get_yx(position_string)
- if new_position[0] >= self.map_size[0] or \
- new_position[1] >= self.map_size[1]:
- raise ArgumentError('Position outside of map size bounds.')
- self.position = new_position
- self.draw_map()
-
- class InputHandler:
- """Delivers data from other thread to widget via message_container.
-
- The class only exists to provide handle_input as a bound method, with
- widget and message_container pre-set, as (bound) handle_input is used
- as a callback in urwid's watch_pipe – which merely provides its
- callback target with one parameter for a pipe to read data from an
- urwid-external thread.
+ If the message delivered is 'BYE', quits Urwid. Otherwise tries to
+ parse it as a command, and enact it. In all cases but the 'BYE', calls
+ self.widget_manager.update.
"""
-
- def __init__(self, log_widget, map_widget, message_container):
- self.log_widget = log_widget
- self.map_widget = map_widget
- self.message_container = message_container
-
- def handle_input(self, trigger):
- """On input from other thread, either quit or write to widget text.
-
- Serves as a receiver to urwid's watch_pipe mechanism, with trigger
- the data that a pipe defined by watch_pipe delivers. To avoid
- buffering trouble, we don't care for that data beyond the fact that
- its receival triggers this function: The sender is to write the
- data it wants to deliver into the container referenced by
- self.message_container, and just pipe the trigger to inform us
- about this.
-
- If the message delivered is 'BYE', quits Urwid.
- """
-
- def mapdraw_command(prefix, func):
- n = len(prefix)
- if len(msg) > n and msg[:n] == prefix:
- m = getattr(self.map_widget, func)
- m(msg[n:])
- return True
- return False
-
- msg = self.message_container[0]
- if msg == 'BYE':
- raise urwid.ExitMainLoop()
- return
- found_command = False
- try:
- found_command = (
- mapdraw_command('TERRAIN\n', 'update_terrain') or
- mapdraw_command('POSITION ', 'update_position') or
- mapdraw_command('MAP_SIZE ', 'update_map_size'))
- except ArgumentError as e:
- self.log_widget.add('ARGUMENT ERROR: ' + msg + '\n' + str(e))
+ msg = self.server_output[0]
+ if msg == 'BYE':
+ raise urwid.ExitMainLoop()
+ try:
+ command = self.parser.parse(msg)
+ if command is None:
+ self.game.log('UNHANDLED INPUT: ' + msg)
else:
- if not found_command:
- self.log_widget.add('UNHANDLED INPUT: ' + msg)
- del self.message_container[0]
+ command()
+ except ArgError as e:
+ self.game.log('ARGUMENT ERROR: ' + msg + '\n' + str(e))
+ self.widget_manager.update()
+ del self.server_output[0]
def recv_loop(self):
- """Loop to receive messages from socket and deliver them to urwid.
+ """Loop to receive messages from socket, deliver them to urwid thread.
Waits for self.server_output to become empty (this signals that the
input handler is finished / ready to receive new input), then writes
"""
import os
for msg in plom_socket_io.recv(self.socket):
- while len(self.server_output) > 0:
- pass
+ while len(self.server_output) > 0: # Wait until self.server_output
+ pass # is emptied by input handler.
self.server_output += [msg]
os.write(self.urwid_pipe_write_fd, b' ')
def run(self):
- """Run in parallel main and recv_loop thread."""
+ """Run in parallel urwid_loop and recv_loop threads."""
self.recv_loop_thread.start()
- self.main_loop.run()
+ self.urwid_loop.run()
self.recv_loop_thread.join()
-s = socket.create_connection(('127.0.0.1', 5000))
-u = UrwidSetup(s)
-u.run()
-s.close()
+if __name__ == '__main__':
+ game = Game()
+ s = socket.create_connection(('127.0.0.1', 5000))
+ p = PlomRogueClient(game, s)
+ p.run()
+ s.close()
projects / plomrogue2-experiments / blobdiff