home · contact · privacy
Server, plugin: Refactor thingproliferation (plugin integration).
[plomrogue] / client / window_management.py
1 # This file is part of PlomRogue. PlomRogue is licensed under the GPL version 3
2 # or any later version. For details on its copyright, license, and warranties,
3 # see the file NOTICE in the root directory of the PlomRogue source package.
4
5
6 import curses
7 import types
8
9
10 from client.config.windows import windows_config
11
12
13 redraw_windows = False
14 sep_size = 1  # Width of inter-window borders and title bars.
15 windows = []
16 stdscr = None
17 screen_size = [0,0]
18
19
20 class Window:
21     def __init__(self, title, draw_function, size):
22         self.title = title
23         self.draw = types.MethodType(draw_function, self)
24         self.size = size
25
26
27 def set_windows():
28
29     def size_window(config):
30         size = [0, 0]
31         size[0] = config[0]
32         if (config[0] == 0):
33             size[0] = screen_size[0] - sep_size
34         elif (config[0] < 0):
35             size[0] = screen_size[0] + config[0] - sep_size
36         size[1] = config[1]
37         if (config[1] == 0):
38             size[1] = screen_size[1]
39         elif (config[1] < 0):
40             size[1] = screen_size[1] + config[1]
41         return size
42
43     def place_window(win):
44         win_i = windows.index(win)
45
46         # If win is first window, it goes into the top left corner.
47         win.start = [0 + sep_size, 0]
48         if (win_i > 0):
49
50             # If not, get win's closest predecessor starting a new stack on the
51             # screen top,fit win's top left to that win_top's top right corner.
52             win_top = None
53             for i in range(win_i - 1, -1, -1):
54                 win_top = windows[i]
55                 if (win_top.start[0] == 0 + sep_size):
56                     break
57             win.start[1] = win_top.start[1] + win_top.size[1] + sep_size
58
59             # If enough space is found below win's predecessor, fit win's top
60             # left corner to that predecessor's bottom left corner.
61             win_prev = windows[win_i - 1]
62             next_free_y = win_prev.start[0] + win_prev.size[0] + sep_size
63             if (win.size[1] <= win_prev.size[1] and
64                     win.size[0] <= screen_size[0] - next_free_y):
65                 win.start[1] = win_prev.start[1]
66                 win.start[0] = next_free_y
67
68             # If that fails, try to fit win's top left corner to the top right
69             # corner of its closest predecessor win_test 1) below win_top (see
70             # above) 2) and with enough space open to its right between its
71             # right edge and the lower edge of a win_high located directly
72             # above win_test to fit win there (without growing further to the
73             # right than win_high does or surpassing the screen's lower edge).
74             else:
75                 win_test = win_prev
76                 win_high = None
77                 while (win_test != win_top):
78                     for i in range(win_i - 2, -1, -1):
79                         win_high = windows[i]
80                         if win_test.start[0] > win_high.start[0]:
81                             break
82                     next_free_y = win_high.start[0] + win_high.size[0] \
83                         + sep_size
84                     first_free_x = win_test.start[1] + win_test.size[1] \
85                         + sep_size
86                     last_free_x = win_high.start[1] + win_high.size[1]
87                     if (win.size[0] <= screen_size[0] - next_free_y and
88                             win.size[1] <= last_free_x - first_free_x):
89                         win.start[1] = first_free_x
90                         win.start[0] = next_free_y
91                         break
92                     win_test = win_high
93
94     global screen_size, stdscr
95     curses.endwin()
96     stdscr = curses.initscr()
97     screen_size = stdscr.getmaxyx()
98     global windows
99     windows = []
100     for config in windows_config:
101         size = size_window(config["config"])
102         window = Window(config["title"], config["func"], size)
103         windows.append(window)
104         place_window(window)
105     redraw_windows = True
106
107
108 def draw_screen():
109
110     def healthy_addch(y, x, char, attr=0):
111         """Workaround for <http://stackoverflow.com/questions/7063128/>."""
112         if y == screen_size[0] - 1 and x == screen_size[1] - 1:
113             char_before = stdscr.inch(y, x - 1)
114             stdscr.addch(y, x - 1, char, attr)
115             stdscr.insstr(y, x - 1, " ")
116             stdscr.addch(y, x - 1, char_before)
117         else:
118             stdscr.addch(y, x, char, attr)
119
120     def draw_window_border_lines():
121         for win in windows:
122             for k in range(2):
123                 j = win.start[int(k == 0)] - sep_size
124                 if (j >= 0 and j < screen_size[int(k == 0)]):
125                     start = win.start[k]
126                     end = win.start[k] + win.size[k]
127                     end = end if end < screen_size[k] else screen_size[k]
128                     if k:
129                         [healthy_addch(j, i, '-') for i in range(start, end)]
130                     else:
131                         [healthy_addch(i, j, '|') for i in range(start, end)]
132
133     def draw_window_border_corners():
134         for win in windows:
135             up = win.start[0] - sep_size
136             down = win.start[0] + win.size[0]
137             left = win.start[1] - sep_size
138             right = win.start[1] + win.size[1]
139             if (up >= 0 and up < screen_size[0]):
140                 if (left >= 0 and left < screen_size[1]):
141                     healthy_addch(up, left, '+')
142                 if (right >= 0 and right < screen_size[1]):
143                     healthy_addch(up, right, '+')
144             if (down >= 0 and down < screen_size[0]):
145                 if (left >= 0 and left < screen_size[1]):
146                     healthy_addch(down, left, '+')
147                 if (right >= 0 and right < screen_size[1]):
148                     healthy_addch(down, right, '+')
149
150     def draw_window_titles():
151         for win in windows:
152             title = " " + win.title + " "
153             if len(title) <= win.size[1]:
154                 y = win.start[0] - 1
155                 start_x = win.start[1] + int((win.size[1] - len(title))/2)
156                 for x in range(len(title)):
157                     healthy_addch(y, start_x + x, title[x])
158
159     def draw_window_contents():
160         def draw_winmap():
161             """Draw winmap in area delimited by offset, winmap_size.
162
163             The individuall cell of a winmap is interpreted as either a single
164             character element, or as a tuple of character and attribute,
165             depending on the size len(cell) spits out.
166             """
167             stop = [0, 0]
168             for i in range(2):
169                 stop[i] = win.size[i] + offset[i]
170                 if stop[i] >= winmap_size[i]:
171                     stop[i] = winmap_size[i]
172             for y in range(offset[0], stop[0]):
173                 for x in range(offset[1], stop[1]):
174                     cell = winmap[y * winmap_size[1] + x]
175                     attr = 0
176                     if len(cell) > 1:
177                         attr = cell[1]
178                         cell = cell[0]
179                     y_in_screen = win.start[0] + (y - offset[0])
180                     x_in_screen = win.start[1] + (x - offset[1])
181                     if (y_in_screen < screen_size[0]
182                             and x_in_screen < screen_size[1]):
183                         healthy_addch(y_in_screen, x_in_screen, cell, attr)
184         def draw_scroll_hints():
185             def draw_scroll_string(n_lines_outside):
186                 hint = ' ' + str(n_lines_outside + 1) + ' more ' + unit + ' '
187                 if len(hint) <= win.size[ni]:
188                     non_hint_space = win.size[ni] - len(hint)
189                     hint_offset = int(non_hint_space / 2)
190                     for j in range(win.size[ni] - non_hint_space):
191                         pos_2 = win.start[ni] + hint_offset + j
192                         x, y = (pos_2, pos_1) if ni else (pos_1, pos_2)
193                         healthy_addch(y, x, hint[j], curses.A_REVERSE)
194             def draw_scroll_arrows(ar1, ar2):
195                 for j in range(win.size[ni]):
196                     pos_2 = win.start[ni] + j
197                     x, y = (pos_2, pos_1) if ni else (pos_1, pos_2)
198                     healthy_addch(y, x, ar1 if ni else ar2, curses.A_REVERSE)
199             for i in range(2):
200                 ni = int(i == 0)
201                 unit = 'rows' if ni else 'columns'
202                 if (offset[i] > 0):
203                     pos_1 = win.start[i]
204                     draw_scroll_arrows('^', '<')
205                     draw_scroll_string(offset[i])
206                 if (winmap_size[i] > offset[i] + win.size[i]):
207                     pos_1 = win.start[i] + win.size[i] - 1
208                     draw_scroll_arrows('v', '>')
209                     draw_scroll_string(winmap_size[i] - offset[i]
210                         - win.size[i])
211         for win in windows:
212             offset, winmap_size, winmap = win.draw()
213             draw_winmap()
214             draw_scroll_hints()
215
216     stdscr.erase()
217     draw_window_border_lines()
218     draw_window_border_corners()
219     draw_window_titles()
220     draw_window_contents()
221     stdscr.refresh()