home · contact · privacy
Remove unused variable.
[plomrogue] / roguelike-server
1 #!/usr/bin/python3
2
3 # This file is part of PlomRogue. PlomRogue is licensed under the GPL version 3
4 # or any later version. For details on its copyright, license, and warranties,
5 # see the file NOTICE in the root directory of the PlomRogue source package.
6
7
8 import argparse
9 import errno
10 import os
11 import shlex
12 import shutil
13 import time
14 import ctypes
15
16
17 class RandomnessIO:
18     """"Interface to libplomrogue's pseudo-randomness generator."""
19
20     def set_seed(self, seed):
21         libpr.seed_rrand(1, seed)
22
23     def get_seed(self):
24         return libpr.seed_rrand(0, 0)
25
26     def next(self):
27         return libpr.rrand()
28
29     seed = property(get_seed, set_seed)
30
31
32 def prep_library():
33     """Prepare ctypes library at ./libplomrogue.so"""
34     libpath = ("./libplomrogue.so")
35     if not os.access(libpath, os.F_OK):
36         raise SystemExit("No library " + libpath + ", run ./redo first?")
37     libpr = ctypes.cdll.LoadLibrary(libpath)
38     libpr.seed_rrand.restype = ctypes.c_uint32
39     return libpr
40
41
42 def c_pointer_to_bytearray(ba):
43     """Return C char * pointer to ba."""
44     type = ctypes.c_char * len(ba)
45     return type.from_buffer(ba)
46
47
48 def strong_write(file, string):
49     """Apply write(string), then flush()."""
50     file.write(string)
51     file.flush()
52
53
54 def setup_server_io():
55     """Fill IO files DB with proper file( path)s. Write process IO test string.
56
57     Ensure IO files directory at server/. Remove any old input file if found.
58     Set up new input file for reading, and new output file for writing. Start
59     output file with process hash line of format PID + " " + floated UNIX time
60     (io_db["teststring"]). Raise SystemExit if file is found at path of either
61     record or save file plus io_db["tmp_suffix"].
62     """
63     def detect_atomic_leftover(path, tmp_suffix):
64         path_tmp = path + tmp_suffix
65         msg = "Found file '" + path_tmp + "' that may be a leftover from an " \
66               "aborted previous attempt to write '" + path + "'. Aborting " \
67              "until matter is resolved by removing it from its current path."
68         if os.access(path_tmp, os.F_OK):
69             raise SystemExit(msg)
70     io_db["teststring"] = str(os.getpid()) + " " + str(time.time())
71     io_db["save_wait"] = 0
72     io_db["verbose"] = False
73     io_db["record_chunk"] = ""
74     os.makedirs(io_db["path_server"], exist_ok=True)
75     io_db["file_out"] = open(io_db["path_out"], "w")
76     strong_write(io_db["file_out"], io_db["teststring"] + "\n")
77     if os.access(io_db["path_in"], os.F_OK):
78         os.remove(io_db["path_in"])
79     io_db["file_in"] = open(io_db["path_in"], "w")
80     io_db["file_in"].close()
81     io_db["file_in"] = open(io_db["path_in"], "r")
82     detect_atomic_leftover(io_db["path_save"], io_db["tmp_suffix"])
83     detect_atomic_leftover(io_db["path_record"], io_db["tmp_suffix"])
84
85
86 def cleanup_server_io():
87     """Close and (if io_db["kicked_by_rival"] false) remove files in io_db."""
88     def helper(file_key, path_key):
89         if file_key in io_db:
90             io_db[file_key].close()
91         if not io_db["kicked_by_rival"] \
92            and os.access(io_db[path_key], os.F_OK):
93             os.remove(io_db[path_key])
94     helper("file_in", "path_in")
95     helper("file_out", "path_out")
96     helper("file_worldstate", "path_worldstate")
97     if "file_record" in io_db:
98         io_db["file_record"].close()
99
100
101 def obey(command, prefix, replay=False, do_record=False):
102     """Call function from commands_db mapped to command's first token.
103
104     Tokenize command string with shlex.split(comments=True). If replay is set,
105     a non-meta command from the commands_db merely triggers obey() on the next
106     command from the records file. If not, non-meta commands set
107     io_db["worldstate_updateable"] to world_db["WORLD_EXISTS"], and, if
108     do_record is set, are recorded to io_db["record_chunk"], and save_world()
109     is called (and io_db["record_chunk"] written) if 15 seconds have passed
110     since the last time it was called. The prefix string is inserted into the
111     server's input message between its beginning 'input ' and ':'. All activity
112     is preceded by a server_test() call.
113     """
114     server_test()
115     if io_db["verbose"]:
116         print("input " + prefix + ": " + command)
117     try:
118         tokens = shlex.split(command, comments=True)
119     except ValueError as err:
120         print("Can't tokenize command string: " + str(err) + ".")
121         return
122     if len(tokens) > 0 and tokens[0] in commands_db \
123        and len(tokens) == commands_db[tokens[0]][0] + 1:
124         if commands_db[tokens[0]][1]:
125             commands_db[tokens[0]][2](*tokens[1:])
126         elif replay:
127             print("Due to replay mode, reading command as 'go on in record'.")
128             line = io_db["file_record"].readline()
129             if len(line) > 0:
130                 obey(line.rstrip(), io_db["file_record"].prefix
131                      + str(io_db["file_record"].line_n))
132                 io_db["file_record"].line_n = io_db["file_record"].line_n + 1
133             else:
134                 print("Reached end of record file.")
135         else:
136             commands_db[tokens[0]][2](*tokens[1:])
137             if do_record:
138                 io_db["record_chunk"] += command + "\n"
139                 if time.time() > io_db["save_wait"] + 15:
140                     atomic_write(io_db["path_record"], io_db["record_chunk"],
141                                  do_append=True)
142                     save_world()
143                     io_db["record_chunk"] = ""
144                     io_db["save_wait"] = time.time()
145             io_db["worldstate_updateable"] = world_db["WORLD_ACTIVE"]
146     elif 0 != len(tokens):
147         print("Invalid command/argument, or bad number of tokens.")
148
149
150 def atomic_write(path, text, do_append=False, delete=True):
151     """Atomic write of text to file at path, appended if do_append is set."""
152     path_tmp = path + io_db["tmp_suffix"]
153     mode = "w"
154     if do_append:
155         mode = "a"
156         if os.access(path, os.F_OK):
157             shutil.copyfile(path, path_tmp)
158     file = open(path_tmp, mode)
159     strong_write(file, text)
160     file.close()
161     if delete and os.access(path, os.F_OK):
162         os.remove(path)
163     os.rename(path_tmp, path)
164
165
166 def save_world():
167     """Save all commands needed to reconstruct current world state."""
168
169     def quote(string):
170         string = string.replace("\u005C", '\u005C\u005C')
171         return '"' + string.replace('"', '\u005C"') + '"'
172
173     def mapsetter(key):
174         def helper(id):
175             string = ""
176             if world_db["Things"][id][key]:
177                 map = world_db["Things"][id][key]
178                 length = world_db["MAP_LENGTH"]
179                 for i in range(length):
180                     line = map[i * length:(i * length) + length].decode()
181                     string = string + key + " " + str(i) + " " + quote(line) \
182                              + "\n"
183             return string
184         return helper
185
186     def memthing(id):
187         string = ""
188         for memthing in world_db["Things"][id]["T_MEMTHING"]:
189             string = string + "T_MEMTHING " + str(memthing[0]) + " " + \
190                      str(memthing[1]) + " " + str(memthing[2]) + "\n"
191         return string
192
193     def helper(category, id_string, special_keys={}):
194         string = ""
195         for id in world_db[category]:
196             string = string + id_string + " " + str(id) + "\n"
197             for key in world_db[category][id]:
198                 if not key in special_keys:
199                     x = world_db[category][id][key]
200                     argument = quote(x) if str == type(x) else str(x)
201                     string = string + key + " " + argument + "\n"
202                 elif special_keys[key]:
203                     string = string + special_keys[key](id)
204         return string
205
206     string = ""
207     for key in world_db:
208         if dict != type(world_db[key]) and key != "MAP" and \
209            key != "WORLD_ACTIVE" and key != "SEED_MAP":
210             string = string + key + " " + str(world_db[key]) + "\n"
211     string = string + "SEED_MAP " + str(world_db["SEED_MAP"]) + "\n"
212     string = string + helper("ThingActions", "TA_ID")
213     string = string + helper("ThingTypes", "TT_ID", {"TT_CORPSE_ID": False})
214     for id in world_db["ThingTypes"]:
215         string = string + "TT_ID " + str(id) + "\n" + "TT_CORPSE_ID " + \
216                  str(world_db["ThingTypes"][id]["TT_CORPSE_ID"]) + "\n"
217     string = string + helper("Things", "T_ID",
218                              {"T_CARRIES": False, "carried": False,
219                               "T_MEMMAP": mapsetter("T_MEMMAP"),
220                               "T_MEMTHING": memthing, "fovmap": False,
221                               "T_MEMDEPTHMAP": mapsetter("T_MEMDEPTHMAP")})
222     for id in world_db["Things"]:
223         if [] != world_db["Things"][id]["T_CARRIES"]:
224             string = string + "T_ID " + str(id) + "\n"
225             for carried_id in world_db["Things"][id]["T_CARRIES"]:
226                 string = string + "T_CARRIES " + str(carried_id) + "\n"
227     string = string + "SEED_RANDOMNESS " + str(rand.seed) + "\n" + \
228              "WORLD_ACTIVE " + str(world_db["WORLD_ACTIVE"])
229     atomic_write(io_db["path_save"], string)
230
231
232 def obey_lines_in_file(path, name, do_record=False):
233     """Call obey() on each line of path's file, use name in input prefix."""
234     file = open(path, "r")
235     line_n = 1
236     for line in file.readlines():
237         obey(line.rstrip(), name + "file line " + str(line_n),
238              do_record=do_record)
239         line_n = line_n + 1
240     file.close()
241
242
243 def parse_command_line_arguments():
244     """Return settings values read from command line arguments."""
245     parser = argparse.ArgumentParser()
246     parser.add_argument('-s', nargs='?', type=int, dest='replay', const=1,
247                         action='store')
248     parser.add_argument('-l', nargs="?", const="save", dest='savefile',
249                         action="store")
250     parser.add_argument('-v', dest='verbose', action='store_true')
251     opts, unknown = parser.parse_known_args()
252     return opts
253
254
255 def server_test():
256     """Ensure valid server out file belonging to current process.
257
258     This is done by comparing io_db["teststring"] to what's found at the start
259     of the current file at io_db["path_out"]. On failure, set
260     io_db["kicked_by_rival"] and raise SystemExit.
261     """
262     if not os.access(io_db["path_out"], os.F_OK):
263         raise SystemExit("Server output file has disappeared.")
264     file = open(io_db["path_out"], "r")
265     test = file.readline().rstrip("\n")
266     file.close()
267     if test != io_db["teststring"]:
268         io_db["kicked_by_rival"] = True
269         msg = "Server test string in server output file does not match. This" \
270               " indicates that the current server process has been " \
271               "superseded by another one."
272         raise SystemExit(msg)
273
274
275 def read_command():
276     """Return next newline-delimited command from server in file.
277
278     Keep building return string until a newline is encountered. Pause between
279     unsuccessful reads, and after too much waiting, run server_test().
280     """
281     wait_on_fail = 0.03333
282     max_wait = 5
283     now = time.time()
284     command = ""
285     while True:
286         add = io_db["file_in"].readline()
287         if len(add) > 0:
288             command = command + add
289             if len(command) > 0 and "\n" == command[-1]:
290                 command = command[:-1]
291                 break
292         else:
293             time.sleep(wait_on_fail)
294             if now + max_wait < time.time():
295                 server_test()
296                 now = time.time()
297     return command
298
299
300 def try_worldstate_update():
301     """Write worldstate file if io_db["worldstate_updateable"] is set."""
302     if io_db["worldstate_updateable"]:
303
304         def draw_visible_Things(map, run):
305             for id in world_db["Things"]:
306                 type = world_db["Things"][id]["T_TYPE"]
307                 consumable = world_db["ThingTypes"][type]["TT_CONSUMABLE"]
308                 alive = world_db["ThingTypes"][type]["TT_LIFEPOINTS"]
309                 if (0 == run and not consumable and not alive) \
310                    or (1 == run and consumable and not alive) \
311                    or (2 == run and alive):
312                     y = world_db["Things"][id]["T_POSY"]
313                     x = world_db["Things"][id]["T_POSX"]
314                     fovflag = world_db["Things"][0]["fovmap"][(y * length) + x]
315                     if 'v' == chr(fovflag):
316                         c = world_db["ThingTypes"][type]["TT_SYMBOL"]
317                         map[(y * length) + x] = ord(c)
318
319         def write_map(string, map):
320             for i in range(length):
321                 line = map[i * length:(i * length) + length].decode()
322                 string = string + line + "\n"
323             return string
324
325         inventory = ""
326         if [] == world_db["Things"][0]["T_CARRIES"]:
327             inventory = "(none)\n"
328         else:
329             for id in world_db["Things"][0]["T_CARRIES"]:
330                 type_id = world_db["Things"][id]["T_TYPE"]
331                 name = world_db["ThingTypes"][type_id]["TT_NAME"]
332                 inventory = inventory + name + "\n"
333         ## 7DRL additions:  GOD_MOOD, GOD_FAVOR
334         string = str(world_db["TURN"]) + "\n" + \
335                  str(world_db["GOD_MOOD"]) + "\n" + \
336                  str(world_db["GOD_FAVOR"]) + "\n" + \
337                  str(world_db["Things"][0]["T_LIFEPOINTS"]) + "\n" + \
338                  str(world_db["Things"][0]["T_SATIATION"]) + "\n" + \
339                  inventory + "%\n" + \
340                  str(world_db["Things"][0]["T_POSY"]) + "\n" + \
341                  str(world_db["Things"][0]["T_POSX"]) + "\n" + \
342                  str(world_db["MAP_LENGTH"]) + "\n"
343         length = world_db["MAP_LENGTH"]
344         fov = bytearray(b' ' * (length ** 2))
345         for pos in range(length ** 2):
346             if 'v' == chr(world_db["Things"][0]["fovmap"][pos]):
347                 fov[pos] = world_db["MAP"][pos]
348         for i in range(3):
349             draw_visible_Things(fov, i)
350         string = write_map(string, fov)
351         mem = world_db["Things"][0]["T_MEMMAP"][:]
352         for i in range(2):
353             for mt in world_db["Things"][0]["T_MEMTHING"]:
354                 consumable = world_db["ThingTypes"][mt[0]]["TT_CONSUMABLE"]
355                 if (i == 0 and not consumable) or (i == 1 and consumable):
356                     c = world_db["ThingTypes"][mt[0]]["TT_SYMBOL"]
357                     mem[(mt[1] * length) + mt[2]] = ord(c)
358         string = write_map(string, mem)
359         atomic_write(io_db["path_worldstate"], string, delete=False)
360         strong_write(io_db["file_out"], "WORLD_UPDATED\n")
361         io_db["worldstate_updateable"] = False
362
363
364 def replay_game():
365     """Replay game from record file.
366
367     Use opts.replay as breakpoint turn to which to replay automatically before
368     switching to manual input by non-meta commands in server input file
369     triggering further reads of record file. Ensure opts.replay is at least 1.
370     Run try_worldstate_update() before each interactive obey()/read_command().
371     """
372     if opts.replay < 1:
373         opts.replay = 1
374     print("Replay mode. Auto-replaying up to turn " + str(opts.replay) +
375           " (if so late a turn is to be found).")
376     if not os.access(io_db["path_record"], os.F_OK):
377         raise SystemExit("No record file found to replay.")
378     io_db["file_record"] = open(io_db["path_record"], "r")
379     io_db["file_record"].prefix = "record file line "
380     io_db["file_record"].line_n = 1
381     while world_db["TURN"] < opts.replay:
382         line = io_db["file_record"].readline()
383         if "" == line:
384             break
385         obey(line.rstrip(), io_db["file_record"].prefix
386              + str(io_db["file_record"].line_n))
387         io_db["file_record"].line_n = io_db["file_record"].line_n + 1
388     while True:
389         try_worldstate_update()
390         obey(read_command(), "in file", replay=True)
391
392
393 def play_game():
394     """Play game by server input file commands. Before, load save file found.
395
396     If no save file is found, a new world is generated from the commands in the
397     world config plus a 'MAKE WORLD [current Unix timestamp]'. Record this
398     command and all that follow via the server input file. Run
399     try_worldstate_update() before each interactive obey()/read_command().
400     """
401     if os.access(io_db["path_save"], os.F_OK):
402         obey_lines_in_file(io_db["path_save"], "save")
403     else:
404         if not os.access(io_db["path_worldconf"], os.F_OK):
405             msg = "No world config file from which to start a new world."
406             raise SystemExit(msg)
407         obey_lines_in_file(io_db["path_worldconf"], "world config ",
408                            do_record=True)
409         obey("MAKE_WORLD " + str(int(time.time())), "in file", do_record=True)
410     while True:
411         try_worldstate_update()
412         obey(read_command(), "in file", do_record=True)
413
414
415 def remake_map():
416     """(Re-)make island map.
417
418     Let "~" represent water, "." land, "X" trees: Build island shape randomly,
419     start with one land cell in the middle, then go into cycle of repeatedly
420     selecting a random sea cell and transforming it into land if it is neighbor
421     to land. The cycle ends when a land cell is due to be created at the map's
422     border. Then put some trees on the map (TODO: more precise algorithm desc).
423     """
424     def is_neighbor(coordinates, type):
425         y = coordinates[0]
426         x = coordinates[1]
427         length = world_db["MAP_LENGTH"]
428         ind = y % 2
429         diag_west = x + (ind > 0)
430         diag_east = x + (ind < (length - 1))
431         pos = (y * length) + x
432         if (y > 0 and diag_east
433             and type == chr(world_db["MAP"][pos - length + ind])) \
434            or (x < (length - 1)
435                and type == chr(world_db["MAP"][pos + 1])) \
436            or (y < (length - 1) and diag_east
437                and type == chr(world_db["MAP"][pos + length + ind])) \
438            or (y > 0 and diag_west
439                and type == chr(world_db["MAP"][pos - length - (not ind)])) \
440            or (x > 0
441                and type == chr(world_db["MAP"][pos - 1])) \
442            or (y < (length - 1) and diag_west
443                and type == chr(world_db["MAP"][pos + length - (not ind)])):
444             return True
445         return False
446     store_seed = rand.seed
447     rand.seed = world_db["SEED_MAP"]
448     world_db["MAP"] = bytearray(b'~' * (world_db["MAP_LENGTH"] ** 2))
449     length = world_db["MAP_LENGTH"]
450     add_half_width = (not (length % 2)) * int(length / 2)
451     world_db["MAP"][int((length ** 2) / 2) + add_half_width] = ord(".")
452     while (1):
453         y = rand.next() % length
454         x = rand.next() % length
455         pos = (y * length) + x
456         if "~" == chr(world_db["MAP"][pos]) and is_neighbor((y, x), "."):
457             if y == 0 or y == (length - 1) or x == 0 or x == (length - 1):
458                 break
459             world_db["MAP"][pos] = ord(".")
460     n_trees = int((length ** 2) / 16)
461     i_trees = 0
462     while (i_trees <= n_trees):
463         single_allowed = rand.next() % 32
464         y = rand.next() % length
465         x = rand.next() % length
466         pos = (y * length) + x
467         if "." == chr(world_db["MAP"][pos]) \
468           and ((not single_allowed) or is_neighbor((y, x), "X")):
469             world_db["MAP"][pos] = ord("X")
470             i_trees += 1
471     rand.seed = store_seed
472     # This all-too-precise replica of the original C code misses iter_limit().
473
474
475 def update_map_memory(t, age_map=True):
476     """Update t's T_MEMMAP with what's in its FOV now,age its T_MEMMEPTHMAP."""
477     def age_some_memdepthmap_on_nonfov_cells():
478         # OUTSOURCED TO libplomrogue.so:
479         # for pos in [pos for pos in range(world_db["MAP_LENGTH"] ** 2)
480         #             if not ord_v == t["fovmap"][pos]
481         #             if ord_0 <= t["T_MEMDEPTHMAP"][pos]
482         #             if ord_9 > t["T_MEMDEPTHMAP"][pos]
483         #             if not rand.next() % (2 **
484         #                                   (t["T_MEMDEPTHMAP"][pos] - 48))]:
485         #     t["T_MEMDEPTHMAP"][pos] += 1
486         memdepthmap = c_pointer_to_bytearray(t["T_MEMDEPTHMAP"])
487         fovmap = c_pointer_to_bytearray(t["fovmap"])
488         libpr.age_some_memdepthmap_on_nonfov_cells(memdepthmap, fovmap)
489     if not t["T_MEMMAP"]:
490         t["T_MEMMAP"] = bytearray(b' ' * (world_db["MAP_LENGTH"] ** 2))
491     if not t["T_MEMDEPTHMAP"]:
492         t["T_MEMDEPTHMAP"] = bytearray(b' ' * (world_db["MAP_LENGTH"] ** 2))
493     ord_v = ord("v")
494     ord_0 = ord("0")
495     ord_space = ord(" ")
496     for pos in [pos for pos in range(world_db["MAP_LENGTH"] ** 2)
497                 if ord_v == t["fovmap"][pos]]:
498         t["T_MEMDEPTHMAP"][pos] = ord_0
499         if ord_space == t["T_MEMMAP"][pos]:
500             t["T_MEMMAP"][pos] = world_db["MAP"][pos]
501     if age_map:
502         age_some_memdepthmap_on_nonfov_cells()
503     for mt in [mt for mt in t["T_MEMTHING"]
504                if "v" == chr(t["fovmap"][(mt[1] * world_db["MAP_LENGTH"])
505                                          + mt[2]])]:
506         t["T_MEMTHING"].remove(mt)
507     for id in [id for id in world_db["Things"]
508                if not world_db["Things"][id]["carried"]]:
509         type = world_db["Things"][id]["T_TYPE"]
510         if not world_db["ThingTypes"][type]["TT_LIFEPOINTS"]:
511             y = world_db["Things"][id]["T_POSY"]
512             x = world_db["Things"][id]["T_POSX"]
513             if "v" == chr(t["fovmap"][(y * world_db["MAP_LENGTH"]) + x]):
514                 t["T_MEMTHING"].append((type, y, x))
515
516
517 def set_world_inactive():
518     """Set world_db["WORLD_ACTIVE"] to 0 and remove worldstate file."""
519     server_test()
520     if os.access(io_db["path_worldstate"], os.F_OK):
521         os.remove(io_db["path_worldstate"])
522     world_db["WORLD_ACTIVE"] = 0
523
524
525 def integer_test(val_string, min, max=None):
526     """Return val_string if possible integer >= min and <= max, else None."""
527     try:
528         val = int(val_string)
529         if val < min or (max is not None and val > max):
530             raise ValueError
531         return val
532     except ValueError:
533         msg = "Ignoring: Please use integer >= " + str(min)
534         if max is not None:
535             msg += " and <= " + str(max)
536         msg += "."
537         print(msg)
538         return None
539
540
541 def setter(category, key, min, max=None):
542     """Build setter for world_db([category + "s"][id])[key] to >=min/<=max."""
543     if category is None:
544         def f(val_string):
545             val = integer_test(val_string, min, max)
546             if None != val:
547                 world_db[key] = val
548     else:
549         if category == "Thing":
550             id_store = command_tid
551             decorator = test_Thing_id
552         elif category == "ThingType":
553             id_store = command_ttid
554             decorator = test_ThingType_id
555         elif category == "ThingAction":
556             id_store = command_taid
557             decorator = test_ThingAction_id
558
559         @decorator
560         def f(val_string):
561             val = integer_test(val_string, min, max)
562             if None != val:
563                 world_db[category + "s"][id_store.id][key] = val
564     return f
565
566
567 def build_fov_map(t):
568     """Build Thing's FOV map."""
569     t["fovmap"] = bytearray(b'v' * (world_db["MAP_LENGTH"] ** 2))
570     fovmap = c_pointer_to_bytearray(t["fovmap"])
571     map = c_pointer_to_bytearray(world_db["MAP"])
572     if libpr.build_fov_map(t["T_POSY"], t["T_POSX"], fovmap, map):
573         raise RuntimeError("Malloc error in build_fov_Map().")
574
575
576 def decrement_lifepoints(t):
577     """Decrement t's lifepoints by 1, and if to zero, corpse it.
578
579     If t is the player avatar, only blank its fovmap, so that the client may
580     still display memory data. On non-player things, erase fovmap and memory.
581     """
582     t["T_LIFEPOINTS"] -= 1
583     if 0 == t["T_LIFEPOINTS"]:
584         t["T_TYPE"] = world_db["ThingTypes"][t["T_TYPE"]]["TT_CORPSE_ID"]
585         if world_db["Things"][0] == t:
586             t["fovmap"] = bytearray(b' ' * (world_db["MAP_LENGTH"] ** 2))
587             strong_write(io_db["file_out"], "LOG You die.\n")
588         else:
589             t["fovmap"] = False
590             t["T_MEMMAP"] = False
591             t["T_MEMDEPTHMAP"] = False
592             t["T_MEMTHING"] = []
593             strong_write(io_db["file_out"], "LOG It dies.\n")
594
595
596 def mv_yx_in_dir_legal(dir, y, x):
597     """Wrapper around libpr.mv_yx_in_dir_legal to simplify its use."""
598     dir_c = dir.encode("ascii")[0]
599     test = libpr.mv_yx_in_dir_legal_wrap(dir_c, y, x)
600     if -1 == test:
601         raise RuntimeError("Too much wrapping in mv_yx_in_dir_legal_wrap()!")
602     return (test, libpr.result_y(), libpr.result_x())
603
604
605 def actor_wait(t):
606     """Make t do nothing (but loudly, if player avatar)."""
607     if t == world_db["Things"][0]:
608         strong_write(io_db["file_out"], "LOG You wait.\n")
609
610
611 def actor_move(t):
612     """If passable, move/collide(=attack) thing into T_ARGUMENT's direction."""
613     passable = False
614     move_result = mv_yx_in_dir_legal(chr(t["T_ARGUMENT"]),
615                                      t["T_POSY"], t["T_POSX"])
616     if 1 == move_result[0]:
617         pos = (move_result[1] * world_db["MAP_LENGTH"]) + move_result[2]
618         passable = "." == chr(world_db["MAP"][pos])
619         hitted = [id for id in world_db["Things"]
620                   if world_db["Things"][id] != t
621                   if world_db["Things"][id]["T_LIFEPOINTS"]
622                   if world_db["Things"][id]["T_POSY"] == move_result[1]
623                   if world_db["Things"][id]["T_POSX"] == move_result[2]]
624         if len(hitted):
625             hit_id = hitted[0]
626             hitter_name = world_db["ThingTypes"][t["T_TYPE"]]["TT_NAME"]
627             hitter = "You" if t == world_db["Things"][0] else hitter_name
628             hitted_type = world_db["Things"][hit_id]["T_TYPE"]
629             hitted_name = world_db["ThingTypes"][hitted_type]["TT_NAME"]
630             hitted = "you" if hit_id == 0 else hitted_name
631             verb = " wound " if hitter == "You" else " wounds "
632             strong_write(io_db["file_out"], "LOG " + hitter + verb + hitted +
633                                             ".\n")
634             decrement_lifepoints(world_db["Things"][hit_id])
635             return
636     dir = [dir for dir in directions_db
637            if directions_db[dir] == chr(t["T_ARGUMENT"])][0]
638     if passable:
639         t["T_POSY"] = move_result[1]
640         t["T_POSX"] = move_result[2]
641         for id in t["T_CARRIES"]:
642             world_db["Things"][id]["T_POSY"] = move_result[1]
643             world_db["Things"][id]["T_POSX"] = move_result[2]
644         build_fov_map(t)
645         if t == world_db["Things"][0]:
646             strong_write(io_db["file_out"], "LOG You move " + dir + ".\n")
647     elif t == world_db["Things"][0]:
648         strong_write(io_db["file_out"], "LOG You fail to move " + dir + ".\n")
649
650
651 def actor_pick_up(t):
652     """Make t pick up (topmost?) Thing from ground into inventory."""
653     # Topmostness is actually not defined so far. Picks Thing with highest ID.
654     ids = [id for id in world_db["Things"] if world_db["Things"][id] != t
655            if not world_db["Things"][id]["carried"]
656            if world_db["Things"][id]["T_POSY"] == t["T_POSY"]
657            if world_db["Things"][id]["T_POSX"] == t["T_POSX"]]
658     if len(ids):
659         highest_id = 0
660         for id in ids:
661             if id > highest_id:
662                 highest_id = id
663         world_db["Things"][highest_id]["carried"] = True
664         t["T_CARRIES"].append(highest_id)
665         if t == world_db["Things"][0]:
666             strong_write(io_db["file_out"], "LOG You pick up an object.\n")
667     elif t == world_db["Things"][0]:
668         err = "You try to pick up an object, but there is none."
669         strong_write(io_db["file_out"], "LOG " + err + "\n")
670
671
672 def actor_drop(t):
673     """Make t rop Thing from inventory to ground indexed by T_ARGUMENT."""
674     # TODO: Handle case where T_ARGUMENT matches nothing.
675     if len(t["T_CARRIES"]):
676         id = t["T_CARRIES"][t["T_ARGUMENT"]]
677         t["T_CARRIES"].remove(id)
678         world_db["Things"][id]["carried"] = False
679         if t == world_db["Things"][0]:
680             strong_write(io_db["file_out"], "LOG You drop an object.\n")
681     elif t == world_db["Things"][0]:
682         err = "You try to drop an object, but you own none."
683         strong_write(io_db["file_out"], "LOG " + err + "\n")
684
685
686 def actor_use(t):
687     """Make t use (for now: consume) T_ARGUMENT-indexed Thing in inventory."""
688     # TODO: Handle case where T_ARGUMENT matches nothing.
689     if len(t["T_CARRIES"]):
690         id = t["T_CARRIES"][t["T_ARGUMENT"]]
691         type = world_db["Things"][id]["T_TYPE"]
692         if world_db["ThingTypes"][type]["TT_CONSUMABLE"]:
693             t["T_CARRIES"].remove(id)
694             del world_db["Things"][id]
695             t["T_SATIATION"] += world_db["ThingTypes"][type]["TT_CONSUMABLE"]
696             if t == world_db["Things"][0]:
697                 strong_write(io_db["file_out"],
698                              "LOG You consume this object.\n")
699         elif t == world_db["Things"][0]:
700             strong_write(io_db["file_out"],
701                          "LOG You try to use this object, but fail.\n")
702     elif t == world_db["Things"][0]:
703         strong_write(io_db["file_out"],
704                      "LOG You try to use an object, but you own none.\n")
705
706
707 def thingproliferation(t):
708     """To chance of 1/TT_PROLIFERATE, create t offspring in neighbor cell.
709
710     Naturally only works with TT_PROLIFERATE > 0. The neighbor cell must be
711     passable and not be inhabited by a Thing of the same type, or, if Thing is
712     animate, any other animate Thing. If there are several map cell candidates,
713     one is selected randomly.
714     """
715     def test_cell(t, y, x):
716         if "." == chr(world_db["MAP"][(y * world_db["MAP_LENGTH"]) + x]):
717             for id in [id for id in world_db["Things"]
718                        if y == world_db["Things"][id]["T_POSY"]
719                        if x == world_db["Things"][id]["T_POSX"]
720                        if (t["T_TYPE"] == world_db["Things"][id]["T_TYPE"])
721                        or (t["T_LIFEPOINTS"] and
722                            world_db["Things"][id]["T_LIFEPOINTS"])]:
723                 return False
724             return True
725         return False
726     prolscore = world_db["ThingTypes"][t["T_TYPE"]]["TT_PROLIFERATE"]
727     if prolscore and (1 == prolscore or 1 == (rand.next() % prolscore)):
728         candidates = []
729         for dir in [directions_db[key] for key in directions_db]:
730             mv_result = mv_yx_in_dir_legal(dir, t["T_POSY"], t["T_POSX"])
731             if mv_result[0] and test_cell(t, mv_result[1], mv_result[2]):
732                 candidates.append((mv_result[1], mv_result[2]))
733         if len(candidates):
734             i = rand.next() % len(candidates)
735             id = id_setter(-1, "Things")
736             newT = new_Thing(t["T_TYPE"], (candidates[i][0], candidates[i][1]))
737             world_db["Things"][id] = newT
738
739
740 def try_healing(t):
741     """Grow t's HP to a 1/32 chance if < HP max, satiation > 0, and waiting.
742
743     On success, decrease satiation score by 32.
744     """
745     if t["T_SATIATION"] > 0 \
746        and t["T_LIFEPOINTS"] < \
747            world_db["ThingTypes"][t["T_TYPE"]]["TT_LIFEPOINTS"] \
748        and 0 == (rand.next() % 31) \
749        and t["T_COMMAND"] == [id for id in world_db["ThingActions"]
750                               if world_db["ThingActions"][id]["TA_NAME"] ==
751                                  "wait"][0]:
752         t["T_LIFEPOINTS"] += 1
753         t["T_SATIATION"] -= 32
754         if t == world_db["Things"][0]:
755             strong_write(io_db["file_out"], "LOG You heal.\n")
756         else:
757             name = world_db["ThingTypes"][t["T_TYPE"]]["TT_NAME"]
758             strong_write(io_db["file_out"], "LOG " + name + "heals.\n")
759
760
761 def hunger(t):
762     """Decrement t's satiation,dependent on it trigger lifepoint dec chance."""
763     if t["T_SATIATION"] > -32768:
764         t["T_SATIATION"] -= 1
765     testbase = t["T_SATIATION"] if t["T_SATIATION"] >= 0 else -t["T_SATIATION"]
766     if not world_db["ThingTypes"][t["T_TYPE"]]["TT_LIFEPOINTS"]:
767         raise RuntimeError("A thing that should not hunger is hungering.")
768     stomach = int(32767 / world_db["ThingTypes"][t["T_TYPE"]]["TT_LIFEPOINTS"])
769     if int(int(testbase / stomach) / ((rand.next() % stomach) + 1)):
770         if t == world_db["Things"][0]:
771             strong_write(io_db["file_out"], "LOG You suffer from hunger.\n")
772         else:
773             name = world_db["ThingTypes"][t["T_TYPE"]]["TT_NAME"]
774             strong_write(io_db["file_out"], "LOG " + name +
775                                             " suffers from hunger.\n")
776         decrement_lifepoints(t)
777
778
779 def get_dir_to_target(t, filter):
780     """Try to set T_COMMAND/T_ARGUMENT for move to "filter"-determined target.
781
782     The path-wise nearest target is chosen, via the shortest available path.
783     Target must not be t. On succcess, return positive value, else False.
784     Filters:
785     "a": Thing in FOV is below a certain distance, animate, but of ThingType
786          that is not t's, and starts out weaker than t is; build path as
787          avoiding things of t's ThingType
788     "f": neighbor cell (not inhabited by any animate Thing) further away from
789          animate Thing not further than x steps away and in FOV and of a
790          ThingType that is not t's, and starts out stronger or as strong as t
791          is currently; or (cornered), if no such flight cell, but Thing of
792          above criteria is too near,1 a cell closer to it, or, if less near,
793          just wait
794     "c": Thing in memorized map is consumable
795     "s": memory map cell with greatest-reachable degree of unexploredness
796     """
797
798     def zero_score_map_where_char_on_memdepthmap(c):
799         # OUTSOURCED TO libplomrogue.so:
800         # for i in [i for i in range(world_db["MAP_LENGTH"] ** 2)
801         #           if t["T_MEMDEPTHMAP"][i] == mem_depth_c[0]]:
802         #     set_map_score(i, 0)
803         map = c_pointer_to_bytearray(t["T_MEMDEPTHMAP"])
804         if libpr.zero_score_map_where_char_on_memdepthmap(c, map):
805             raise RuntimeError("No score map allocated for "
806                                "zero_score_map_where_char_on_memdepthmap().")
807
808     def set_map_score(pos, score):
809         test = libpr.set_map_score(pos, score)
810         if test:
811             raise RuntimeError("No score map allocated for set_map_score().")
812
813     def get_map_score(pos):
814         result = libpr.get_map_score(pos)
815         if result < 0:
816             raise RuntimeError("No score map allocated for get_map_score().")
817         return result
818
819     def seeing_thing():
820         if t["fovmap"] and ("a" == filter or "f" == filter):
821             for id in world_db["Things"]:
822                 Thing = world_db["Things"][id]
823                 if Thing != t and Thing["T_LIFEPOINTS"] and \
824                    t["T_TYPE"] != Thing["T_TYPE"] and \
825                    'v' == chr(t["fovmap"][(Thing["T_POSY"]
826                                           * world_db["MAP_LENGTH"])
827                                           + Thing["T_POSX"]]):
828                     ThingType = world_db["ThingTypes"][Thing["T_TYPE"]]
829                     if ("f" == filter and ThingType["TT_LIFEPOINTS"] >=
830                                           t["T_LIFEPOINTS"]) \
831                        or ("a" == filter and ThingType["TT_LIFEPOINTS"] <
832                                              t["T_LIFEPOINTS"]):
833                         return True
834         elif t["T_MEMMAP"] and "c" == filter:
835             for mt in t["T_MEMTHING"]:
836                 if ' ' != chr(t["T_MEMMAP"][(mt[1] * world_db["MAP_LENGTH"])
837                                          + mt[2]]) \
838                    and world_db["ThingTypes"][mt[0]]["TT_CONSUMABLE"]:
839                     return True
840         return False
841
842     def set_cells_passable_on_memmap_to_65534_on_scoremap():
843         # OUTSOURCED TO libplomrogue.so:
844         # ord_dot = ord(".")
845         # memmap = t["T_MEMMAP"]
846         # for i in [i for i in range(world_db["MAP_LENGTH"] ** 2)
847         #            if ord_dot == memmap[i]]:
848         #     set_map_score(i, 65534) # i.e. 65535-1
849         map = c_pointer_to_bytearray(t["T_MEMMAP"])
850         if libpr.set_cells_passable_on_memmap_to_65534_on_scoremap(map):
851             raise RuntimeError("No score map allocated for "
852                         "set_cells_passable_on_memmap_to_65534_on_scoremap().")
853
854     def init_score_map():
855         test = libpr.init_score_map()
856         if test:
857             raise RuntimeError("Malloc error in init_score_map().")
858         ord_v = ord("v")
859         ord_blank = ord(" ")
860         set_cells_passable_on_memmap_to_65534_on_scoremap()
861         if "a" == filter:
862             for id in world_db["Things"]:
863                 Thing = world_db["Things"][id]
864                 pos = Thing["T_POSY"] * world_db["MAP_LENGTH"] \
865                       + Thing["T_POSX"]
866                 if t != Thing and Thing["T_LIFEPOINTS"] and \
867                    t["T_TYPE"] != Thing["T_TYPE"] and \
868                    ord_v == t["fovmap"][pos] and \
869                    t["T_LIFEPOINTS"] > \
870                    world_db["ThingTypes"][Thing["T_TYPE"]]["TT_LIFEPOINTS"]:
871                     set_map_score(pos, 0)
872                 elif t["T_TYPE"] == Thing["T_TYPE"]:
873                     set_map_score(pos, 65535)
874         elif "f" == filter:
875             for id in [id for id in world_db["Things"]
876                        if world_db["Things"][id]["T_LIFEPOINTS"]]:
877                 Thing = world_db["Things"][id]
878                 pos = Thing["T_POSY"] * world_db["MAP_LENGTH"] \
879                       + Thing["T_POSX"]
880                 if t["T_TYPE"] != Thing["T_TYPE"] and \
881                    ord_v == t["fovmap"][pos] and \
882                    t["T_LIFEPOINTS"] <= \
883                    world_db["ThingTypes"][Thing["T_TYPE"]]["TT_LIFEPOINTS"]:
884                     set_map_score(pos, 0)
885         elif "c" == filter:
886             for mt in [mt for mt in t["T_MEMTHING"]
887                        if ord_blank != t["T_MEMMAP"][mt[1]
888                                                     * world_db["MAP_LENGTH"]
889                                                     + mt[2]]
890                        if world_db["ThingTypes"][mt[0]]["TT_CONSUMABLE"]]:
891                 set_map_score(mt[1] * world_db["MAP_LENGTH"] + mt[2], 0)
892         elif "s" == filter:
893             zero_score_map_where_char_on_memdepthmap(mem_depth_c[0])
894
895     def rand_target_dir(neighbors, cmp, dirs):
896         candidates = []
897         n_candidates = 0
898         for i in range(len(dirs)):
899             if cmp == neighbors[i]:
900                 candidates.append(dirs[i])
901                 n_candidates += 1
902         return candidates[rand.next() % n_candidates] if n_candidates else 0
903
904     def get_neighbor_scores(dirs, eye_pos):
905         scores = []
906         if libpr.ready_neighbor_scores(eye_pos):
907             raise RuntimeError("No score map allocated for " +
908                                "ready_neighbor_scores.()")
909         for i in range(len(dirs)):
910             scores.append(libpr.get_neighbor_score(i))
911         return scores
912
913     def get_dir_from_neighbors():
914         dir_to_target = False
915         dirs = "edcxsw"
916         eye_pos = t["T_POSY"] * world_db["MAP_LENGTH"] + t["T_POSX"]
917         neighbors = get_neighbor_scores(dirs, eye_pos)
918         if "f" == filter:
919             inhabited = [world_db["Things"][id]["T_POSY"]
920                          * world_db["MAP_LENGTH"]
921                          + world_db["Things"][id]["T_POSX"]
922                          for id in world_db["Things"]
923                          if world_db["Things"][id]["T_LIFEPOINTS"]]
924             for i in range(len(dirs)):
925                 mv_yx_in_dir_legal(dirs[i], t["T_POSY"], t["T_POSX"])
926                 pos_cmp = libpr.result_y() * world_db["MAP_LENGTH"] \
927                           + libpr.result_x()
928                 for pos in [pos for pos in inhabited if pos == pos_cmp]:
929                     neighbors[i] = 65535
930                     break
931         minmax_start = 0 if "f" == filter else 65535 - 1
932         minmax_neighbor = minmax_start
933         for i in range(len(dirs)):
934             if ("f" == filter and get_map_score(eye_pos) < neighbors[i] and
935                 minmax_neighbor < neighbors[i] and 65535 != neighbors[i]) \
936                or ("f" != filter and minmax_neighbor > neighbors[i]):
937                 minmax_neighbor = neighbors[i]
938         if minmax_neighbor != minmax_start:
939             dir_to_target = rand_target_dir(neighbors, minmax_neighbor, dirs)
940         if "f" == filter:
941             if not dir_to_target:
942                 if 1 == get_map_score(eye_pos):
943                     dir_to_target = rand_target_dir(neighbors, 0, dirs)
944                 elif 3 >= get_map_score(eye_pos):
945                     t["T_COMMAND"] = [id for id in world_db["ThingActions"]
946                                       if
947                                       world_db["ThingActions"][id]["TA_NAME"]
948                                          == "wait"][0]
949                     return 1
950             elif dir_to_target and 3 < get_map_score(eye_pos):
951                 dir_to_target = 0
952         elif "a" == filter and 10 <= get_map_score(eye_pos):
953             dir_to_target = 0
954         return dir_to_target
955
956     dir_to_target = False
957     mem_depth_c = b' '
958     run_i = 9 + 1 if "s" == filter else 1
959     while run_i and not dir_to_target and ("s" == filter or seeing_thing()):
960         run_i -= 1
961         init_score_map()
962         mem_depth_c = b'9' if b' ' == mem_depth_c \
963                            else bytes([mem_depth_c[0] - 1])
964         if libpr.dijkstra_map():
965             raise RuntimeError("No score map allocated for dijkstra_map().")
966         dir_to_target = get_dir_from_neighbors()
967         libpr.free_score_map()
968         if dir_to_target and str == type(dir_to_target):
969             t["T_COMMAND"] = [id for id in world_db["ThingActions"]
970                               if world_db["ThingActions"][id]["TA_NAME"]
971                                  == "move"][0]
972             t["T_ARGUMENT"] = ord(dir_to_target)
973     return dir_to_target
974
975
976 def standing_on_consumable(t):
977     """Return True/False whether t is standing on a consumable."""
978     for id in [id for id in world_db["Things"] if world_db["Things"][id] != t
979                if world_db["Things"][id]["T_POSY"] == t["T_POSY"]
980                if world_db["Things"][id]["T_POSX"] == t["T_POSX"]
981                if world_db["ThingTypes"][world_db["Things"][id]["T_TYPE"]]
982                           ["TT_CONSUMABLE"]]:
983         return True
984     return False
985
986
987 def get_inventory_slot_to_consume(t):
988     """Return slot Id of strongest consumable in t's inventory, else -1."""
989     cmp_consumability = 0
990     selection = -1
991     i = 0
992     for id in t["T_CARRIES"]:
993         type = world_db["Things"][id]["T_TYPE"]
994         if world_db["ThingTypes"][type]["TT_CONSUMABLE"] > cmp_consumability:
995             cmp_consumability = world_db["ThingTypes"][type]["TT_CONSUMABLE"]
996             selection = i
997         i += 1
998     return selection
999
1000
1001 def ai(t):
1002     """Determine next command/argment for actor t via AI algorithms.
1003
1004     AI will look for, and move towards, enemies (animate Things not of their
1005     own ThingType); if they see none, they will consume consumables in their
1006     inventory; if there are none, they will pick up what they stand on if they
1007     stand on consumables; if they stand on none, they will move towards the
1008     next consumable they see or remember on the map; if they see or remember
1009     none, they will explore parts of the map unseen since ever or for at least
1010     one turn; if there is nothing to explore, they will simply wait.
1011     """
1012     t["T_COMMAND"] = [id for id in world_db["ThingActions"]
1013                       if world_db["ThingActions"][id]["TA_NAME"] == "wait"][0]
1014     if not get_dir_to_target(t, "f"):
1015         sel = get_inventory_slot_to_consume(t)
1016         if -1 != sel:
1017             t["T_COMMAND"] = [id for id in world_db["ThingActions"]
1018                               if world_db["ThingActions"][id]["TA_NAME"]
1019                                  == "use"][0]
1020             t["T_ARGUMENT"] = sel
1021         elif standing_on_consumable(t):
1022             t["T_COMMAND"] = [id for id in world_db["ThingActions"]
1023                               if world_db["ThingActions"][id]["TA_NAME"]
1024                                  == "pick_up"][0]
1025         elif (not get_dir_to_target(t, "c")) and \
1026              (not get_dir_to_target(t, "a")):
1027             get_dir_to_target(t, "s")
1028
1029
1030 def turn_over():
1031     """Run game world and its inhabitants until new player input expected."""
1032     id = 0
1033     whilebreaker = False
1034     while world_db["Things"][0]["T_LIFEPOINTS"]:
1035         for id in [id for id in world_db["Things"]]:  # Only what's from start!
1036             if not id in world_db["Things"] or \
1037                world_db["Things"][id]["carried"]:   # May have been consumed or
1038                 continue                            # picked up during turn …
1039             Thing = world_db["Things"][id]
1040             if Thing["T_LIFEPOINTS"]:
1041                 if not Thing["T_COMMAND"]:
1042                     update_map_memory(Thing)
1043                     if 0 == id:
1044                         whilebreaker = True
1045                         break
1046                     ai(Thing)
1047                 try_healing(Thing)
1048                 Thing["T_PROGRESS"] += 1
1049                 taid = [a for a in world_db["ThingActions"]
1050                           if a == Thing["T_COMMAND"]][0]
1051                 ThingAction = world_db["ThingActions"][taid]
1052                 if Thing["T_PROGRESS"] == ThingAction["TA_EFFORT"]:
1053                     eval("actor_" + ThingAction["TA_NAME"])(Thing)
1054                     Thing["T_COMMAND"] = 0
1055                     Thing["T_PROGRESS"] = 0
1056                 hunger(Thing)
1057             thingproliferation(Thing)
1058         if whilebreaker:
1059             break
1060         world_db["TURN"] += 1
1061
1062
1063 def new_Thing(type, pos=(0, 0)):
1064     """Return Thing of type T_TYPE, with fovmap if alive and world active."""
1065     thing = {
1066         "T_LIFEPOINTS": world_db["ThingTypes"][type]["TT_LIFEPOINTS"],
1067         "T_ARGUMENT": 0,
1068         "T_PROGRESS": 0,
1069         "T_SATIATION": 0,
1070         "T_COMMAND": 0,
1071         "T_TYPE": type,
1072         "T_POSY": pos[0],
1073         "T_POSX": pos[1],
1074         "T_CARRIES": [],
1075         "carried": False,
1076         "T_MEMTHING": [],
1077         "T_MEMMAP": False,
1078         "T_MEMDEPTHMAP": False,
1079         "fovmap": False
1080     }
1081     if world_db["WORLD_ACTIVE"] and thing["T_LIFEPOINTS"]:
1082         build_fov_map(thing)
1083     return thing
1084
1085
1086 def id_setter(id, category, id_store=False, start_at_1=False):
1087     """Set ID of object of category to manipulate ID unused? Create new one.
1088
1089     The ID is stored as id_store.id (if id_store is set). If the integer of the
1090     input is valid (if start_at_1, >= 0, else >= -1), but <0 or (if start_at_1)
1091     <1, calculate new ID: lowest unused ID >=0 or (if start_at_1) >= 1. None is
1092     always returned when no new object is created, otherwise the new object's
1093     ID.
1094     """
1095     min = 0 if start_at_1 else -1
1096     if str == type(id):
1097         id = integer_test(id, min)
1098     if None != id:
1099         if id in world_db[category]:
1100             if id_store:
1101                 id_store.id = id
1102             return None
1103         else:
1104             if (start_at_1 and 0 == id) \
1105                or ((not start_at_1) and (id < 0)):
1106                 id = 0 if start_at_1 else -1
1107                 while 1:
1108                     id = id + 1
1109                     if id not in world_db[category]:
1110                         break
1111             if id_store:
1112                 id_store.id = id
1113     return id
1114
1115
1116 def command_ping():
1117     """Send PONG line to server output file."""
1118     strong_write(io_db["file_out"], "PONG\n")
1119
1120
1121 def command_quit():
1122     """Abort server process."""
1123     save_world()
1124     atomic_write(io_db["path_record"], io_db["record_chunk"], do_append=True)
1125     raise SystemExit("received QUIT command")
1126
1127
1128 def command_thingshere(str_y, str_x):
1129     """Write to out file list of Things known to player at coordinate y, x."""
1130     if world_db["WORLD_ACTIVE"]:
1131         y = integer_test(str_y, 0, 255)
1132         x = integer_test(str_x, 0, 255)
1133         length = world_db["MAP_LENGTH"]
1134         if None != y and None != x and y < length and x < length:
1135             pos = (y * world_db["MAP_LENGTH"]) + x
1136             strong_write(io_db["file_out"], "THINGS_HERE START\n")
1137             if "v" == chr(world_db["Things"][0]["fovmap"][pos]):
1138                 for id in world_db["Things"]:
1139                     if y == world_db["Things"][id]["T_POSY"] \
1140                        and x == world_db["Things"][id]["T_POSX"] \
1141                        and not world_db["Things"][id]["carried"]:
1142                         type = world_db["Things"][id]["T_TYPE"]
1143                         name = world_db["ThingTypes"][type]["TT_NAME"]
1144                         strong_write(io_db["file_out"], name + "\n")
1145             else:
1146                 for mt in world_db["Things"][0]["T_MEMTHING"]:
1147                     if y == mt[1] and x == mt[2]:
1148                         name = world_db["ThingTypes"][mt[0]]["TT_NAME"]
1149                         strong_write(io_db["file_out"], name + "\n")
1150             strong_write(io_db["file_out"], "THINGS_HERE END\n")
1151         else:
1152             print("Ignoring: Invalid map coordinates.")
1153     else:
1154         print("Ignoring: Command only works on existing worlds.")
1155
1156
1157 def play_commander(action, args=False):
1158     """Setter for player's T_COMMAND and T_ARGUMENT, then calling turn_over().
1159
1160     T_ARGUMENT is set to direction char if action=="wait",or 8-bit int if args.
1161     """
1162
1163     def set_command():
1164         id = [x for x in world_db["ThingActions"]
1165                 if world_db["ThingActions"][x]["TA_NAME"] == action][0]
1166         world_db["Things"][0]["T_COMMAND"] = id
1167         turn_over()
1168
1169     def set_command_and_argument_int(str_arg):
1170         val = integer_test(str_arg, 0, 255)
1171         if None != val:
1172             world_db["Things"][0]["T_ARGUMENT"] = val
1173             set_command()
1174
1175     def set_command_and_argument_movestring(str_arg):
1176         if str_arg in directions_db:
1177             world_db["Things"][0]["T_ARGUMENT"] = ord(directions_db[str_arg])
1178             set_command()
1179         else:
1180             print("Ignoring: Argument must be valid direction string.")
1181
1182     if action == "move":
1183         return set_command_and_argument_movestring
1184     elif args:
1185         return set_command_and_argument_int
1186     else:
1187         return set_command
1188
1189
1190 def command_seedrandomness(seed_string):
1191     """Set rand seed to int(seed_string)."""
1192     val = integer_test(seed_string, 0, 4294967295)
1193     if None != val:
1194         rand.seed = val
1195
1196
1197 def command_seedmap(seed_string):
1198     """Set world_db["SEED_MAP"] to int(seed_string), then (re-)make map."""
1199     setter(None, "SEED_MAP", 0, 4294967295)(seed_string)
1200     remake_map()
1201
1202
1203 def command_makeworld(seed_string):
1204     """(Re-)build game world, i.e. map, things, to a new turn 1 from seed.
1205
1206     Seed rand with seed, fill it into world_db["SEED_MAP"]. Do more only with a
1207     "wait" ThingAction and world["PLAYER_TYPE"] matching ThingType of
1208     TT_START_NUMBER > 0. Then, world_db["Things"] emptied, call remake_map()
1209     and set world_db["WORLD_ACTIVE"], world_db["TURN"] to 1. Build new Things
1210     according to ThingTypes' TT_START_NUMBERS, with Thing of ID 0 to ThingType
1211     of ID = world["PLAYER_TYPE"]. Place Things randomly, and actors not on each
1212     other. Init player's memory map. Write "NEW_WORLD" line to out file.
1213     """
1214
1215     def free_pos():
1216         i = 0
1217         while 1:
1218             err = "Space to put thing on too hard to find. Map too small?"
1219             while 1:
1220                 y = rand.next() % world_db["MAP_LENGTH"]
1221                 x = rand.next() % world_db["MAP_LENGTH"]
1222                 if "." == chr(world_db["MAP"][y * world_db["MAP_LENGTH"] + x]):
1223                     break
1224                 i += 1
1225                 if i == 65535:
1226                     raise SystemExit(err)
1227             # Replica of C code, wrongly ignores animatedness of new Thing.
1228             pos_clear = (0 == len([id for id in world_db["Things"]
1229                                    if world_db["Things"][id]["T_LIFEPOINTS"]
1230                                    if world_db["Things"][id]["T_POSY"] == y
1231                                    if world_db["Things"][id]["T_POSX"] == x]))
1232             if pos_clear:
1233                 break
1234         return (y, x)
1235
1236     val = integer_test(seed_string, 0, 4294967295)
1237     if None == val:
1238         return
1239     rand.seed = val
1240     world_db["SEED_MAP"] = val
1241     player_will_be_generated = False
1242     playertype = world_db["PLAYER_TYPE"]
1243     for ThingType in world_db["ThingTypes"]:
1244         if playertype == ThingType:
1245             if 0 < world_db["ThingTypes"][ThingType]["TT_START_NUMBER"]:
1246                 player_will_be_generated = True
1247             break
1248     if not player_will_be_generated:
1249         print("Ignoring beyond SEED_MAP: " +
1250               "No player type with start number >0 defined.")
1251         return
1252     wait_action = False
1253     for ThingAction in world_db["ThingActions"]:
1254         if "wait" == world_db["ThingActions"][ThingAction]["TA_NAME"]:
1255             wait_action = True
1256     if not wait_action:
1257         print("Ignoring beyond SEED_MAP: " +
1258               "No thing action with name 'wait' defined.")
1259         return
1260     world_db["Things"] = {}
1261     remake_map()
1262     world_db["WORLD_ACTIVE"] = 1
1263     world_db["TURN"] = 1
1264     for i in range(world_db["ThingTypes"][playertype]["TT_START_NUMBER"]):
1265         id = id_setter(-1, "Things")
1266         world_db["Things"][id] = new_Thing(playertype, free_pos())
1267     update_map_memory(world_db["Things"][0])
1268     for type in world_db["ThingTypes"]:
1269         for i in range(world_db["ThingTypes"][type]["TT_START_NUMBER"]):
1270             if type != playertype:
1271                 id = id_setter(-1, "Things")
1272                 world_db["Things"][id] = new_Thing(type, free_pos())
1273     strong_write(io_db["file_out"], "NEW_WORLD\n")
1274
1275
1276 def command_maplength(maplength_string):
1277     """Redefine map length. Invalidate map, therefore lose all things on it."""
1278     val = integer_test(maplength_string, 1, 256)
1279     if None != val:
1280         world_db["MAP_LENGTH"] = val
1281         set_world_inactive()
1282         world_db["Things"] = {}
1283         libpr.set_maplength(val)
1284
1285
1286 def command_worldactive(worldactive_string):
1287     """Toggle world_db["WORLD_ACTIVE"] if possible.
1288
1289     An active world can always be set inactive. An inactive world can only be
1290     set active with a "wait" ThingAction, and a player Thing (of ID 0). On
1291     activation, rebuild all Things' FOVs, and the player's map memory.
1292     """
1293     # In original version, map existence was also tested (unnecessarily?).
1294     val = integer_test(worldactive_string, 0, 1)
1295     if val:
1296         if 0 != world_db["WORLD_ACTIVE"]:
1297             if 0 == val:
1298                 set_world_inactive()
1299             else:
1300                 print("World already active.")
1301         elif 0 == world_db["WORLD_ACTIVE"]:
1302             wait_exists = False
1303             for ThingAction in world_db["ThingActions"]:
1304                 if "wait" == world_db["ThingActions"][ThingAction]["TA_NAME"]:
1305                     wait_exists = True
1306                     break
1307             player_exists = False
1308             for Thing in world_db["Things"]:
1309                 if 0 == Thing:
1310                     player_exists = True
1311                     break
1312             if wait_exists and player_exists:
1313                 for id in world_db["Things"]:
1314                     if world_db["Things"][id]["T_LIFEPOINTS"]:
1315                         build_fov_map(world_db["Things"][id])
1316                         if 0 == id:
1317                             update_map_memory(world_db["Things"][id], False)
1318                 world_db["WORLD_ACTIVE"] = 1
1319
1320
1321 def test_for_id_maker(object, category):
1322     """Return decorator testing for object having "id" attribute."""
1323     def decorator(f):
1324         def helper(*args):
1325             if hasattr(object, "id"):
1326                 f(*args)
1327             else:
1328                 print("Ignoring: No " + category +
1329                       " defined to manipulate yet.")
1330         return helper
1331     return decorator
1332
1333
1334 def command_tid(id_string):
1335     """Set ID of Thing to manipulate. ID unused? Create new one.
1336
1337     Default new Thing's type to the first available ThingType, others: zero.
1338     """
1339     id = id_setter(id_string, "Things", command_tid)
1340     if None != id:
1341         if world_db["ThingTypes"] == {}:
1342             print("Ignoring: No ThingType to settle new Thing in.")
1343             return
1344         type = list(world_db["ThingTypes"].keys())[0]
1345         world_db["Things"][id] = new_Thing(type)
1346
1347
1348 test_Thing_id = test_for_id_maker(command_tid, "Thing")
1349
1350
1351 @test_Thing_id
1352 def command_tcommand(str_int):
1353     """Set T_COMMAND of selected Thing."""
1354     val = integer_test(str_int, 0)
1355     if None != val:
1356         if 0 == val or val in world_db["ThingActions"]:
1357             world_db["Things"][command_tid.id]["T_COMMAND"] = val
1358         else:
1359             print("Ignoring: ThingAction ID belongs to no known ThingAction.")
1360
1361
1362 @test_Thing_id
1363 def command_ttype(str_int):
1364     """Set T_TYPE of selected Thing."""
1365     val = integer_test(str_int, 0)
1366     if None != val:
1367         if val in world_db["ThingTypes"]:
1368             world_db["Things"][command_tid.id]["T_TYPE"] = val
1369         else:
1370             print("Ignoring: ThingType ID belongs to no known ThingType.")
1371
1372
1373 @test_Thing_id
1374 def command_tcarries(str_int):
1375     """Append int(str_int) to T_CARRIES of selected Thing.
1376
1377     The ID int(str_int) must not be of the selected Thing, and must belong to a
1378     Thing with unset "carried" flag. Its "carried" flag will be set on owning.
1379     """
1380     val = integer_test(str_int, 0)
1381     if None != val:
1382         if val == command_tid.id:
1383             print("Ignoring: Thing cannot carry itself.")
1384         elif val in world_db["Things"] \
1385              and not world_db["Things"][val]["carried"]:
1386             world_db["Things"][command_tid.id]["T_CARRIES"].append(val)
1387             world_db["Things"][val]["carried"] = True
1388         else:
1389             print("Ignoring: Thing not available for carrying.")
1390     # Note that the whole carrying structure is different from the C version:
1391     # Carried-ness is marked by a "carried" flag, not by Things containing
1392     # Things internally.
1393
1394
1395 @test_Thing_id
1396 def command_tmemthing(str_t, str_y, str_x):
1397     """Add (int(str_t), int(str_y), int(str_x)) to selected Thing's T_MEMTHING.
1398
1399     The type must fit to an existing ThingType, and the position into the map.
1400     """
1401     type = integer_test(str_t, 0)
1402     posy = integer_test(str_y, 0, 255)
1403     posx = integer_test(str_x, 0, 255)
1404     if None != type and None != posy and None != posx:
1405         if type not in world_db["ThingTypes"] \
1406            or posy >= world_db["MAP_LENGTH"] or posx >= world_db["MAP_LENGTH"]:
1407             print("Ignoring: Illegal value for thing type or position.")
1408         else:
1409             memthing = (type, posy, posx)
1410             world_db["Things"][command_tid.id]["T_MEMTHING"].append(memthing)
1411
1412
1413 def setter_map(maptype):
1414     """Set selected Thing's map of maptype's int(str_int)-th line to mapline.
1415
1416     If Thing has no map of maptype yet, initialize it with ' ' bytes first.
1417     """
1418     @test_Thing_id
1419     def helper(str_int, mapline):
1420         val = integer_test(str_int, 0, 255)
1421         if None != val:
1422             if val >= world_db["MAP_LENGTH"]:
1423                 print("Illegal value for map line number.")
1424             elif len(mapline) != world_db["MAP_LENGTH"]:
1425                 print("Map line length is unequal map width.")
1426             else:
1427                 length = world_db["MAP_LENGTH"]
1428                 map = None
1429                 if not world_db["Things"][command_tid.id][maptype]:
1430                     map = bytearray(b' ' * (length ** 2))
1431                 else:
1432                     map = world_db["Things"][command_tid.id][maptype]
1433                 map[val * length:(val * length) + length] = mapline.encode()
1434                 world_db["Things"][command_tid.id][maptype] = map
1435     return helper
1436
1437
1438 def setter_tpos(axis):
1439     """Generate setter for T_POSX or  T_POSY of selected Thing.
1440
1441     If world is active, rebuilds animate things' fovmap, player's memory map.
1442     """
1443     @test_Thing_id
1444     def helper(str_int):
1445         val = integer_test(str_int, 0, 255)
1446         if None != val:
1447             if val < world_db["MAP_LENGTH"]:
1448                 world_db["Things"][command_tid.id]["T_POS" + axis] = val
1449                 if world_db["WORLD_ACTIVE"] \
1450                    and world_db["Things"][command_tid.id]["T_LIFEPOINTS"]:
1451                     build_fov_map(world_db["Things"][command_tid.id])
1452                     if 0 == command_tid.id:
1453                         update_map_memory(world_db["Things"][command_tid.id])
1454             else:
1455                 print("Ignoring: Position is outside of map.")
1456     return helper
1457
1458
1459 def command_ttid(id_string):
1460     """Set ID of ThingType to manipulate. ID unused? Create new one.
1461
1462     Default new ThingType's TT_SYMBOL to "?", TT_CORPSE_ID to self, others: 0.
1463     """
1464     id = id_setter(id_string, "ThingTypes", command_ttid)
1465     if None != id:
1466         world_db["ThingTypes"][id] = {
1467             "TT_NAME": "(none)",
1468             "TT_CONSUMABLE": 0,
1469             "TT_LIFEPOINTS": 0,
1470             "TT_PROLIFERATE": 0,
1471             "TT_START_NUMBER": 0,
1472             "TT_SYMBOL": "?",
1473             "TT_CORPSE_ID": id
1474         }
1475
1476
1477 test_ThingType_id = test_for_id_maker(command_ttid, "ThingType")
1478
1479
1480 @test_ThingType_id
1481 def command_ttname(name):
1482     """Set TT_NAME of selected ThingType."""
1483     world_db["ThingTypes"][command_ttid.id]["TT_NAME"] = name
1484
1485
1486 @test_ThingType_id
1487 def command_ttsymbol(char):
1488     """Set TT_SYMBOL of selected ThingType. """
1489     if 1 == len(char):
1490         world_db["ThingTypes"][command_ttid.id]["TT_SYMBOL"] = char
1491     else:
1492         print("Ignoring: Argument must be single character.")
1493
1494
1495 @test_ThingType_id
1496 def command_ttcorpseid(str_int):
1497     """Set TT_CORPSE_ID of selected ThingType."""
1498     val = integer_test(str_int, 0)
1499     if None != val:
1500         if val in world_db["ThingTypes"]:
1501             world_db["ThingTypes"][command_ttid.id]["TT_CORPSE_ID"] = val
1502         else:
1503             print("Ignoring: Corpse ID belongs to no known ThignType.")
1504
1505
1506 def command_taid(id_string):
1507     """Set ID of ThingAction to manipulate. ID unused? Create new one.
1508
1509     Default new ThingAction's TA_EFFORT to 1, its TA_NAME to "wait".
1510     """
1511     id = id_setter(id_string, "ThingActions", command_taid, True)
1512     if None != id:
1513         world_db["ThingActions"][id] = {
1514             "TA_EFFORT": 1,
1515             "TA_NAME": "wait"
1516         }
1517
1518
1519 test_ThingAction_id = test_for_id_maker(command_taid, "ThingAction")
1520
1521
1522 @test_ThingAction_id
1523 def command_taname(name):
1524     """Set TA_NAME of selected ThingAction.
1525
1526     The name must match a valid thing action function. If after the name
1527     setting no ThingAction with name "wait" remains, call set_world_inactive().
1528     """
1529     if name == "wait" or name == "move" or name == "use" or name == "drop" \
1530        or name == "pick_up":
1531         world_db["ThingActions"][command_taid.id]["TA_NAME"] = name
1532         if 1 == world_db["WORLD_ACTIVE"]:
1533             wait_defined = False
1534             for id in world_db["ThingActions"]:
1535                 if "wait" == world_db["ThingActions"][id]["TA_NAME"]:
1536                     wait_defined = True
1537                     break
1538             if not wait_defined:
1539                 set_world_inactive()
1540     else:
1541         print("Ignoring: Invalid action name.")
1542     # In contrast to the original,naming won't map a function to a ThingAction.
1543
1544
1545 def command_ai():
1546     """Call ai() on player Thing, then turn_over()."""
1547     ai(world_db["Things"][0])
1548     turn_over()
1549
1550
1551 """Commands database.
1552
1553 Map command start tokens to ([0]) number of expected command arguments, ([1])
1554 the command's meta-ness (i.e. is it to be written to the record file, is it to
1555 be ignored in replay mode if read from server input file), and ([2]) a function
1556 to be called on it.
1557 """
1558 commands_db = {
1559     "QUIT": (0, True, command_quit),
1560     "PING": (0, True, command_ping),
1561     "THINGS_HERE": (2, True, command_thingshere),
1562     "MAKE_WORLD": (1, False, command_makeworld),
1563     "SEED_MAP": (1, False, command_seedmap),
1564     "SEED_RANDOMNESS": (1, False, command_seedrandomness),
1565     "TURN": (1, False, setter(None, "TURN", 0, 65535)),
1566     "GOD_MOOD": (1, False, setter(None, "GOD_MOOD", -32768, 32767)),  # #
1567     "GOD_FAVOR": (1, False, setter(None, "GOD_FAVOR", -32768, 32767)),  # #
1568     "PLAYER_TYPE": (1, False, setter(None, "PLAYER_TYPE", 0)),
1569     "MAP_LENGTH": (1, False, command_maplength),
1570     "WORLD_ACTIVE": (1, False, command_worldactive),
1571     "TA_ID": (1, False, command_taid),
1572     "TA_EFFORT": (1, False, setter("ThingAction", "TA_EFFORT", 0, 255)),
1573     "TA_NAME": (1, False, command_taname),
1574     "TT_ID": (1, False, command_ttid),
1575     "TT_NAME": (1, False, command_ttname),
1576     "TT_SYMBOL": (1, False, command_ttsymbol),
1577     "TT_CORPSE_ID": (1, False, command_ttcorpseid),
1578     "TT_CONSUMABLE": (1, False, setter("ThingType", "TT_CONSUMABLE",
1579                                        0, 65535)),
1580     "TT_START_NUMBER": (1, False, setter("ThingType", "TT_START_NUMBER",
1581                                          0, 255)),
1582     "TT_PROLIFERATE": (1, False, setter("ThingType", "TT_PROLIFERATE",
1583                                         0, 255)),
1584     "TT_LIFEPOINTS": (1, False, setter("ThingType", "TT_LIFEPOINTS", 0, 255)),
1585     "T_ID": (1, False, command_tid),
1586     "T_ARGUMENT": (1, False, setter("Thing", "T_ARGUMENT", 0, 255)),
1587     "T_PROGRESS": (1, False, setter("Thing", "T_PROGRESS", 0, 255)),
1588     "T_LIFEPOINTS": (1, False, setter("Thing", "T_LIFEPOINTS", 0, 255)),
1589     "T_SATIATION": (1, False, setter("Thing", "T_SATIATION", -32768, 32767)),
1590     "T_COMMAND": (1, False, command_tcommand),
1591     "T_TYPE": (1, False, command_ttype),
1592     "T_CARRIES": (1, False, command_tcarries),
1593     "T_MEMMAP": (2, False, setter_map("T_MEMMAP")),
1594     "T_MEMDEPTHMAP": (2, False, setter_map("T_MEMDEPTHMAP")),
1595     "T_MEMTHING": (3, False, command_tmemthing),
1596     "T_POSY": (1, False, setter_tpos("Y")),
1597     "T_POSX": (1, False, setter_tpos("X")),
1598     "wait": (0, False, play_commander("wait")),
1599     "move": (1, False, play_commander("move")),
1600     "pick_up": (0, False, play_commander("pick_up")),
1601     "drop": (1, False, play_commander("drop", True)),
1602     "use": (1, False, play_commander("use", True)),
1603     "ai": (0, False, command_ai)
1604 }
1605
1606
1607 """World state database. With sane default values. (Randomness is in rand.)"""
1608 world_db = {
1609     "TURN": 0,
1610     "MAP_LENGTH": 64,
1611     "SEED_MAP": 0,
1612     "PLAYER_TYPE": 0,
1613     "WORLD_ACTIVE": 0,
1614     "GOD_MOOD": 0,  # #
1615     "GOD_FAVOR": 0,  # #
1616     "ThingActions": {},
1617     "ThingTypes": {},
1618     "Things": {}
1619 }
1620
1621 """Mapping of direction names to internal direction chars."""
1622 directions_db = {"east": "d", "south-east": "c", "south-west": "x",
1623                  "west": "s", "north-west": "w", "north-east": "e"}
1624
1625 """File IO database."""
1626 io_db = {
1627     "path_save": "save",
1628     "path_record": "record_save",
1629     "path_worldconf": "confserver/world",
1630     "path_server": "server/",
1631     "path_in": "server/in",
1632     "path_out": "server/out",
1633     "path_worldstate": "server/worldstate",
1634     "tmp_suffix": "_tmp",
1635     "kicked_by_rival": False,
1636     "worldstate_updateable": False
1637 }
1638
1639
1640 try:
1641     libpr = prep_library()
1642     rand = RandomnessIO()
1643     opts = parse_command_line_arguments()
1644     if opts.savefile:
1645         io_db["path_save"] = opts.savefile
1646         io_db["path_record"] = "record_" + opts.savefile
1647     setup_server_io()
1648     if opts.verbose:
1649         io_db["verbose"] = True
1650     if None != opts.replay:
1651         replay_game()
1652     else:
1653         play_game()
1654 except SystemExit as exit:
1655     print("ABORTING: " + exit.args[0])
1656 except:
1657     print("SOMETHING WENT WRONG IN UNEXPECTED WAYS")
1658     raise
1659 finally:
1660     cleanup_server_io()