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