home · contact · privacy
Serve: Minor stylistic/cosmetic improvemenets to update_map_memory().
[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 FOR PERFORMANCE REASONS TO libplomrogue.so:
479         # ord_v = ord("v")
480         # ord_0 = ord("0")
481         # ord_9 = ord("9")
482         # for pos in [pos for pos in range(world_db["MAP_LENGTH"] ** 2)
483         #             if not ord_v == t["fovmap"][pos]
484         #             if ord_0 <= t["T_MEMDEPTHMAP"][pos]
485         #             if ord_9 > t["T_MEMDEPTHMAP"][pos]
486         #             if not rand.next() % (2 **
487         #                                   (t["T_MEMDEPTHMAP"][pos] - 48))]:
488         #     t["T_MEMDEPTHMAP"][pos] += 1
489         memdepthmap = c_pointer_to_bytearray(t["T_MEMDEPTHMAP"])
490         fovmap = c_pointer_to_bytearray(t["fovmap"])
491         libpr.age_some_memdepthmap_on_nonfov_cells(memdepthmap, fovmap)
492     if not t["T_MEMMAP"]:
493         t["T_MEMMAP"] = bytearray(b' ' * (world_db["MAP_LENGTH"] ** 2))
494     if not t["T_MEMDEPTHMAP"]:
495         t["T_MEMDEPTHMAP"] = bytearray(b' ' * (world_db["MAP_LENGTH"] ** 2))
496     ord_v = ord("v")
497     ord_0 = ord("0")
498     ord_space = ord(" ")
499     for pos in [pos for pos in range(world_db["MAP_LENGTH"] ** 2)
500                 if ord_v == t["fovmap"][pos]]:
501         t["T_MEMDEPTHMAP"][pos] = ord_0
502         if ord_space == t["T_MEMMAP"][pos]:
503             t["T_MEMMAP"][pos] = world_db["MAP"][pos]
504     if age_map:
505         age_some_memdepthmap_on_nonfov_cells()
506     for mt in [mt for mt in t["T_MEMTHING"]
507                if ord_v == t["fovmap"][(mt[1] * world_db["MAP_LENGTH"])
508                                        + mt[2]]]:
509         t["T_MEMTHING"].remove(mt)
510     for id in [id for id in world_db["Things"]
511                if not world_db["Things"][id]["carried"]]:
512         type = world_db["Things"][id]["T_TYPE"]
513         if not world_db["ThingTypes"][type]["TT_LIFEPOINTS"]:
514             y = world_db["Things"][id]["T_POSY"]
515             x = world_db["Things"][id]["T_POSX"]
516             if ord_v == t["fovmap"][(y * world_db["MAP_LENGTH"]) + x]:
517                 t["T_MEMTHING"].append((type, y, x))
518
519
520 def set_world_inactive():
521     """Set world_db["WORLD_ACTIVE"] to 0 and remove worldstate file."""
522     server_test()
523     if os.access(io_db["path_worldstate"], os.F_OK):
524         os.remove(io_db["path_worldstate"])
525     world_db["WORLD_ACTIVE"] = 0
526
527
528 def integer_test(val_string, min, max=None):
529     """Return val_string if possible integer >= min and <= max, else None."""
530     try:
531         val = int(val_string)
532         if val < min or (max is not None and val > max):
533             raise ValueError
534         return val
535     except ValueError:
536         msg = "Ignoring: Please use integer >= " + str(min)
537         if max is not None:
538             msg += " and <= " + str(max)
539         msg += "."
540         print(msg)
541         return None
542
543
544 def setter(category, key, min, max=None):
545     """Build setter for world_db([category + "s"][id])[key] to >=min/<=max."""
546     if category is None:
547         def f(val_string):
548             val = integer_test(val_string, min, max)
549             if None != val:
550                 world_db[key] = val
551     else:
552         if category == "Thing":
553             id_store = command_tid
554             decorator = test_Thing_id
555         elif category == "ThingType":
556             id_store = command_ttid
557             decorator = test_ThingType_id
558         elif category == "ThingAction":
559             id_store = command_taid
560             decorator = test_ThingAction_id
561
562         @decorator
563         def f(val_string):
564             val = integer_test(val_string, min, max)
565             if None != val:
566                 world_db[category + "s"][id_store.id][key] = val
567     return f
568
569
570 def build_fov_map(t):
571     """Build Thing's FOV map."""
572     t["fovmap"] = bytearray(b'v' * (world_db["MAP_LENGTH"] ** 2))
573     fovmap = c_pointer_to_bytearray(t["fovmap"])
574     map = c_pointer_to_bytearray(world_db["MAP"])
575     if libpr.build_fov_map(t["T_POSY"], t["T_POSX"], fovmap, map):
576         raise RuntimeError("Malloc error in build_fov_Map().")
577
578
579 def decrement_lifepoints(t):
580     """Decrement t's lifepoints by 1, and if to zero, corpse it.
581
582     If t is the player avatar, only blank its fovmap, so that the client may
583     still display memory data. On non-player things, erase fovmap and memory.
584     """
585     t["T_LIFEPOINTS"] -= 1
586     if 0 == t["T_LIFEPOINTS"]:
587         t["T_TYPE"] = world_db["ThingTypes"][t["T_TYPE"]]["TT_CORPSE_ID"]
588         if world_db["Things"][0] == t:
589             t["fovmap"] = bytearray(b' ' * (world_db["MAP_LENGTH"] ** 2))
590             strong_write(io_db["file_out"], "LOG You die.\n")
591         else:
592             t["fovmap"] = False
593             t["T_MEMMAP"] = False
594             t["T_MEMDEPTHMAP"] = False
595             t["T_MEMTHING"] = []
596             strong_write(io_db["file_out"], "LOG It dies.\n")
597
598
599 def mv_yx_in_dir_legal(dir, y, x):
600     """Wrapper around libpr.mv_yx_in_dir_legal to simplify its use."""
601     dir_c = dir.encode("ascii")[0]
602     test = libpr.mv_yx_in_dir_legal_wrap(dir_c, y, x)
603     if -1 == test:
604         raise RuntimeError("Too much wrapping in mv_yx_in_dir_legal_wrap()!")
605     return (test, libpr.result_y(), libpr.result_x())
606
607
608 def actor_wait(t):
609     """Make t do nothing (but loudly, if player avatar)."""
610     if t == world_db["Things"][0]:
611         strong_write(io_db["file_out"], "LOG You wait.\n")
612
613
614 def actor_move(t):
615     """If passable, move/collide(=attack) thing into T_ARGUMENT's direction."""
616     passable = False
617     move_result = mv_yx_in_dir_legal(chr(t["T_ARGUMENT"]),
618                                      t["T_POSY"], t["T_POSX"])
619     if 1 == move_result[0]:
620         pos = (move_result[1] * world_db["MAP_LENGTH"]) + move_result[2]
621         passable = "." == chr(world_db["MAP"][pos])
622         hitted = [id for id in world_db["Things"]
623                   if world_db["Things"][id] != t
624                   if world_db["Things"][id]["T_LIFEPOINTS"]
625                   if world_db["Things"][id]["T_POSY"] == move_result[1]
626                   if world_db["Things"][id]["T_POSX"] == move_result[2]]
627         if len(hitted):
628             hit_id = hitted[0]
629             hitter_name = world_db["ThingTypes"][t["T_TYPE"]]["TT_NAME"]
630             hitter = "You" if t == world_db["Things"][0] else hitter_name
631             hitted_type = world_db["Things"][hit_id]["T_TYPE"]
632             hitted_name = world_db["ThingTypes"][hitted_type]["TT_NAME"]
633             hitted = "you" if hit_id == 0 else hitted_name
634             verb = " wound " if hitter == "You" else " wounds "
635             strong_write(io_db["file_out"], "LOG " + hitter + verb + hitted +
636                                             ".\n")
637             decrement_lifepoints(world_db["Things"][hit_id])
638             return
639     dir = [dir for dir in directions_db
640            if directions_db[dir] == chr(t["T_ARGUMENT"])][0]
641     if passable:
642         t["T_POSY"] = move_result[1]
643         t["T_POSX"] = move_result[2]
644         for id in t["T_CARRIES"]:
645             world_db["Things"][id]["T_POSY"] = move_result[1]
646             world_db["Things"][id]["T_POSX"] = move_result[2]
647         build_fov_map(t)
648         if t == world_db["Things"][0]:
649             strong_write(io_db["file_out"], "LOG You move " + dir + ".\n")
650     elif t == world_db["Things"][0]:
651         strong_write(io_db["file_out"], "LOG You fail to move " + dir + ".\n")
652
653
654 def actor_pick_up(t):
655     """Make t pick up (topmost?) Thing from ground into inventory."""
656     # Topmostness is actually not defined so far. Picks Thing with highest ID.
657     ids = [id for id in world_db["Things"] if world_db["Things"][id] != t
658            if not world_db["Things"][id]["carried"]
659            if world_db["Things"][id]["T_POSY"] == t["T_POSY"]
660            if world_db["Things"][id]["T_POSX"] == t["T_POSX"]]
661     if len(ids):
662         highest_id = 0
663         for id in ids:
664             if id > highest_id:
665                 highest_id = id
666         world_db["Things"][highest_id]["carried"] = True
667         t["T_CARRIES"].append(highest_id)
668         if t == world_db["Things"][0]:
669             strong_write(io_db["file_out"], "LOG You pick up an object.\n")
670     elif t == world_db["Things"][0]:
671         err = "You try to pick up an object, but there is none."
672         strong_write(io_db["file_out"], "LOG " + err + "\n")
673
674
675 def actor_drop(t):
676     """Make t rop Thing from inventory to ground indexed by T_ARGUMENT."""
677     # TODO: Handle case where T_ARGUMENT matches nothing.
678     if len(t["T_CARRIES"]):
679         id = t["T_CARRIES"][t["T_ARGUMENT"]]
680         t["T_CARRIES"].remove(id)
681         world_db["Things"][id]["carried"] = False
682         if t == world_db["Things"][0]:
683             strong_write(io_db["file_out"], "LOG You drop an object.\n")
684     elif t == world_db["Things"][0]:
685         err = "You try to drop an object, but you own none."
686         strong_write(io_db["file_out"], "LOG " + err + "\n")
687
688
689 def actor_use(t):
690     """Make t use (for now: consume) T_ARGUMENT-indexed Thing in inventory."""
691     # TODO: Handle case where T_ARGUMENT matches nothing.
692     if len(t["T_CARRIES"]):
693         id = t["T_CARRIES"][t["T_ARGUMENT"]]
694         type = world_db["Things"][id]["T_TYPE"]
695         if world_db["ThingTypes"][type]["TT_CONSUMABLE"]:
696             t["T_CARRIES"].remove(id)
697             del world_db["Things"][id]
698             t["T_SATIATION"] += world_db["ThingTypes"][type]["TT_CONSUMABLE"]
699             if t == world_db["Things"][0]:
700                 strong_write(io_db["file_out"],
701                              "LOG You consume this object.\n")
702         elif t == world_db["Things"][0]:
703             strong_write(io_db["file_out"],
704                          "LOG You try to use this object, but fail.\n")
705     elif t == world_db["Things"][0]:
706         strong_write(io_db["file_out"],
707                      "LOG You try to use an object, but you own none.\n")
708
709
710 def thingproliferation(t):
711     """To chance of 1/TT_PROLIFERATE, create t offspring in neighbor cell.
712
713     Naturally only works with TT_PROLIFERATE > 0. The neighbor cell must be
714     passable and not be inhabited by a Thing of the same type, or, if Thing is
715     animate, any other animate Thing. If there are several map cell candidates,
716     one is selected randomly.
717     """
718     def test_cell(t, y, x):
719         if "." == chr(world_db["MAP"][(y * world_db["MAP_LENGTH"]) + x]):
720             for id in [id for id in world_db["Things"]
721                        if y == world_db["Things"][id]["T_POSY"]
722                        if x == world_db["Things"][id]["T_POSX"]
723                        if (t["T_TYPE"] == world_db["Things"][id]["T_TYPE"])
724                        or (t["T_LIFEPOINTS"] and
725                            world_db["Things"][id]["T_LIFEPOINTS"])]:
726                 return False
727             return True
728         return False
729     prolscore = world_db["ThingTypes"][t["T_TYPE"]]["TT_PROLIFERATE"]
730     if prolscore and (1 == prolscore or 1 == (rand.next() % prolscore)):
731         candidates = []
732         for dir in [directions_db[key] for key in directions_db]:
733             mv_result = mv_yx_in_dir_legal(dir, t["T_POSY"], t["T_POSX"])
734             if mv_result[0] and test_cell(t, mv_result[1], mv_result[2]):
735                 candidates.append((mv_result[1], mv_result[2]))
736         if len(candidates):
737             i = rand.next() % len(candidates)
738             id = id_setter(-1, "Things")
739             newT = new_Thing(t["T_TYPE"], (candidates[i][0], candidates[i][1]))
740             world_db["Things"][id] = newT
741
742
743 def try_healing(t):
744     """Grow t's HP to a 1/32 chance if < HP max, satiation > 0, and waiting.
745
746     On success, decrease satiation score by 32.
747     """
748     if t["T_SATIATION"] > 0 \
749        and t["T_LIFEPOINTS"] < \
750            world_db["ThingTypes"][t["T_TYPE"]]["TT_LIFEPOINTS"] \
751        and 0 == (rand.next() % 31) \
752        and t["T_COMMAND"] == [id for id in world_db["ThingActions"]
753                               if world_db["ThingActions"][id]["TA_NAME"] ==
754                                  "wait"][0]:
755         t["T_LIFEPOINTS"] += 1
756         t["T_SATIATION"] -= 32
757         if t == world_db["Things"][0]:
758             strong_write(io_db["file_out"], "LOG You heal.\n")
759         else:
760             name = world_db["ThingTypes"][t["T_TYPE"]]["TT_NAME"]
761             strong_write(io_db["file_out"], "LOG " + name + "heals.\n")
762
763
764 def hunger(t):
765     """Decrement t's satiation,dependent on it trigger lifepoint dec chance."""
766     if t["T_SATIATION"] > -32768:
767         t["T_SATIATION"] -= 1
768     testbase = t["T_SATIATION"] if t["T_SATIATION"] >= 0 else -t["T_SATIATION"]
769     if not world_db["ThingTypes"][t["T_TYPE"]]["TT_LIFEPOINTS"]:
770         raise RuntimeError("A thing that should not hunger is hungering.")
771     stomach = int(32767 / world_db["ThingTypes"][t["T_TYPE"]]["TT_LIFEPOINTS"])
772     if int(int(testbase / stomach) / ((rand.next() % stomach) + 1)):
773         if t == world_db["Things"][0]:
774             strong_write(io_db["file_out"], "LOG You suffer from hunger.\n")
775         else:
776             name = world_db["ThingTypes"][t["T_TYPE"]]["TT_NAME"]
777             strong_write(io_db["file_out"], "LOG " + name +
778                                             " suffers from hunger.\n")
779         decrement_lifepoints(t)
780
781
782 def get_dir_to_target(t, filter):
783     """Try to set T_COMMAND/T_ARGUMENT for move to "filter"-determined target.
784
785     The path-wise nearest target is chosen, via the shortest available path.
786     Target must not be t. On succcess, return positive value, else False.
787     Filters:
788     "a": Thing in FOV is below a certain distance, animate, but of ThingType
789          that is not t's, and starts out weaker than t is; build path as
790          avoiding things of t's ThingType
791     "f": neighbor cell (not inhabited by any animate Thing) further away from
792          animate Thing not further than x steps away and in FOV and of a
793          ThingType that is not t's, and starts out stronger or as strong as t
794          is currently; or (cornered), if no such flight cell, but Thing of
795          above criteria is too near,1 a cell closer to it, or, if less near,
796          just wait
797     "c": Thing in memorized map is consumable
798     "s": memory map cell with greatest-reachable degree of unexploredness
799     """
800
801     def zero_score_map_where_char_on_memdepthmap(c):
802         # OUTSOURCED FOR PERFORMANCE REASONS TO libplomrogue.so:
803         # for i in [i for i in range(world_db["MAP_LENGTH"] ** 2)
804         #           if t["T_MEMDEPTHMAP"][i] == mem_depth_c[0]]:
805         #     set_map_score(i, 0)
806         map = c_pointer_to_bytearray(t["T_MEMDEPTHMAP"])
807         if libpr.zero_score_map_where_char_on_memdepthmap(c, map):
808             raise RuntimeError("No score map allocated for "
809                                "zero_score_map_where_char_on_memdepthmap().")
810
811     def set_map_score(pos, score):
812         test = libpr.set_map_score(pos, score)
813         if test:
814             raise RuntimeError("No score map allocated for set_map_score().")
815
816     def get_map_score(pos):
817         result = libpr.get_map_score(pos)
818         if result < 0:
819             raise RuntimeError("No score map allocated for get_map_score().")
820         return result
821
822     def seeing_thing():
823         if t["fovmap"] and ("a" == filter or "f" == filter):
824             for id in world_db["Things"]:
825                 Thing = world_db["Things"][id]
826                 if Thing != t and Thing["T_LIFEPOINTS"] and \
827                    t["T_TYPE"] != Thing["T_TYPE"] and \
828                    'v' == chr(t["fovmap"][(Thing["T_POSY"]
829                                           * world_db["MAP_LENGTH"])
830                                           + Thing["T_POSX"]]):
831                     ThingType = world_db["ThingTypes"][Thing["T_TYPE"]]
832                     if ("f" == filter and ThingType["TT_LIFEPOINTS"] >=
833                                           t["T_LIFEPOINTS"]) \
834                        or ("a" == filter and ThingType["TT_LIFEPOINTS"] <
835                                              t["T_LIFEPOINTS"]):
836                         return True
837         elif t["T_MEMMAP"] and "c" == filter:
838             for mt in t["T_MEMTHING"]:
839                 if ' ' != chr(t["T_MEMMAP"][(mt[1] * world_db["MAP_LENGTH"])
840                                          + mt[2]]) \
841                    and world_db["ThingTypes"][mt[0]]["TT_CONSUMABLE"]:
842                     return True
843         return False
844
845     def set_cells_passable_on_memmap_to_65534_on_scoremap():
846         # OUTSOURCED FOR PERFORMANCE REASONS TO libplomrogue.so:
847         # ord_dot = ord(".")
848         # memmap = t["T_MEMMAP"]
849         # for i in [i for i in range(world_db["MAP_LENGTH"] ** 2)
850         #            if ord_dot == memmap[i]]:
851         #     set_map_score(i, 65534) # i.e. 65535-1
852         map = c_pointer_to_bytearray(t["T_MEMMAP"])
853         if libpr.set_cells_passable_on_memmap_to_65534_on_scoremap(map):
854             raise RuntimeError("No score map allocated for "
855                         "set_cells_passable_on_memmap_to_65534_on_scoremap().")
856
857     def init_score_map():
858         test = libpr.init_score_map()
859         if test:
860             raise RuntimeError("Malloc error in init_score_map().")
861         ord_v = ord("v")
862         ord_blank = ord(" ")
863         set_cells_passable_on_memmap_to_65534_on_scoremap()
864         if "a" == filter:
865             for id in world_db["Things"]:
866                 Thing = world_db["Things"][id]
867                 pos = Thing["T_POSY"] * world_db["MAP_LENGTH"] \
868                       + Thing["T_POSX"]
869                 if t != Thing and Thing["T_LIFEPOINTS"] and \
870                    t["T_TYPE"] != Thing["T_TYPE"] and \
871                    ord_v == t["fovmap"][pos] and \
872                    t["T_LIFEPOINTS"] > \
873                    world_db["ThingTypes"][Thing["T_TYPE"]]["TT_LIFEPOINTS"]:
874                     set_map_score(pos, 0)
875                 elif t["T_TYPE"] == Thing["T_TYPE"]:
876                     set_map_score(pos, 65535)
877         elif "f" == filter:
878             for id in [id for id in world_db["Things"]
879                        if world_db["Things"][id]["T_LIFEPOINTS"]]:
880                 Thing = world_db["Things"][id]
881                 pos = Thing["T_POSY"] * world_db["MAP_LENGTH"] \
882                       + Thing["T_POSX"]
883                 if t["T_TYPE"] != Thing["T_TYPE"] and \
884                    ord_v == t["fovmap"][pos] and \
885                    t["T_LIFEPOINTS"] <= \
886                    world_db["ThingTypes"][Thing["T_TYPE"]]["TT_LIFEPOINTS"]:
887                     set_map_score(pos, 0)
888         elif "c" == filter:
889             for mt in [mt for mt in t["T_MEMTHING"]
890                        if ord_blank != t["T_MEMMAP"][mt[1]
891                                                     * world_db["MAP_LENGTH"]
892                                                     + mt[2]]
893                        if world_db["ThingTypes"][mt[0]]["TT_CONSUMABLE"]]:
894                 set_map_score(mt[1] * world_db["MAP_LENGTH"] + mt[2], 0)
895         elif "s" == filter:
896             zero_score_map_where_char_on_memdepthmap(mem_depth_c[0])
897
898     def rand_target_dir(neighbors, cmp, dirs):
899         candidates = []
900         n_candidates = 0
901         for i in range(len(dirs)):
902             if cmp == neighbors[i]:
903                 candidates.append(dirs[i])
904                 n_candidates += 1
905         return candidates[rand.next() % n_candidates] if n_candidates else 0
906
907     def get_neighbor_scores(dirs, eye_pos):
908         scores = []
909         if libpr.ready_neighbor_scores(eye_pos):
910             raise RuntimeError("No score map allocated for " +
911                                "ready_neighbor_scores.()")
912         for i in range(len(dirs)):
913             scores.append(libpr.get_neighbor_score(i))
914         return scores
915
916     def get_dir_from_neighbors():
917         dir_to_target = False
918         dirs = "edcxsw"
919         eye_pos = t["T_POSY"] * world_db["MAP_LENGTH"] + t["T_POSX"]
920         neighbors = get_neighbor_scores(dirs, eye_pos)
921         if "f" == filter:
922             inhabited = [world_db["Things"][id]["T_POSY"]
923                          * world_db["MAP_LENGTH"]
924                          + world_db["Things"][id]["T_POSX"]
925                          for id in world_db["Things"]
926                          if world_db["Things"][id]["T_LIFEPOINTS"]]
927             for i in range(len(dirs)):
928                 mv_yx_in_dir_legal(dirs[i], t["T_POSY"], t["T_POSX"])
929                 pos_cmp = libpr.result_y() * world_db["MAP_LENGTH"] \
930                           + libpr.result_x()
931                 for pos in [pos for pos in inhabited if pos == pos_cmp]:
932                     neighbors[i] = 65535
933                     break
934         minmax_start = 0 if "f" == filter else 65535 - 1
935         minmax_neighbor = minmax_start
936         for i in range(len(dirs)):
937             if ("f" == filter and get_map_score(eye_pos) < neighbors[i] and
938                 minmax_neighbor < neighbors[i] and 65535 != neighbors[i]) \
939                or ("f" != filter and minmax_neighbor > neighbors[i]):
940                 minmax_neighbor = neighbors[i]
941         if minmax_neighbor != minmax_start:
942             dir_to_target = rand_target_dir(neighbors, minmax_neighbor, dirs)
943         if "f" == filter:
944             if not dir_to_target:
945                 if 1 == get_map_score(eye_pos):
946                     dir_to_target = rand_target_dir(neighbors, 0, dirs)
947                 elif 3 >= get_map_score(eye_pos):
948                     t["T_COMMAND"] = [id for id in world_db["ThingActions"]
949                                       if
950                                       world_db["ThingActions"][id]["TA_NAME"]
951                                          == "wait"][0]
952                     return 1
953             elif dir_to_target and 3 < get_map_score(eye_pos):
954                 dir_to_target = 0
955         elif "a" == filter and 10 <= get_map_score(eye_pos):
956             dir_to_target = 0
957         return dir_to_target
958
959     dir_to_target = False
960     mem_depth_c = b' '
961     run_i = 9 + 1 if "s" == filter else 1
962     while run_i and not dir_to_target and ("s" == filter or seeing_thing()):
963         run_i -= 1
964         init_score_map()
965         mem_depth_c = b'9' if b' ' == mem_depth_c \
966                            else bytes([mem_depth_c[0] - 1])
967         if libpr.dijkstra_map():
968             raise RuntimeError("No score map allocated for dijkstra_map().")
969         dir_to_target = get_dir_from_neighbors()
970         libpr.free_score_map()
971         if dir_to_target and str == type(dir_to_target):
972             t["T_COMMAND"] = [id for id in world_db["ThingActions"]
973                               if world_db["ThingActions"][id]["TA_NAME"]
974                                  == "move"][0]
975             t["T_ARGUMENT"] = ord(dir_to_target)
976     return dir_to_target
977
978
979 def standing_on_consumable(t):
980     """Return True/False whether t is standing on a consumable."""
981     for id in [id for id in world_db["Things"] if world_db["Things"][id] != t
982                if world_db["Things"][id]["T_POSY"] == t["T_POSY"]
983                if world_db["Things"][id]["T_POSX"] == t["T_POSX"]
984                if world_db["ThingTypes"][world_db["Things"][id]["T_TYPE"]]
985                           ["TT_CONSUMABLE"]]:
986         return True
987     return False
988
989
990 def get_inventory_slot_to_consume(t):
991     """Return slot Id of strongest consumable in t's inventory, else -1."""
992     cmp_consumability = 0
993     selection = -1
994     i = 0
995     for id in t["T_CARRIES"]:
996         type = world_db["Things"][id]["T_TYPE"]
997         if world_db["ThingTypes"][type]["TT_CONSUMABLE"] > cmp_consumability:
998             cmp_consumability = world_db["ThingTypes"][type]["TT_CONSUMABLE"]
999             selection = i
1000         i += 1
1001     return selection
1002
1003
1004 def ai(t):
1005     """Determine next command/argment for actor t via AI algorithms.
1006
1007     AI will look for, and move towards, enemies (animate Things not of their
1008     own ThingType); if they see none, they will consume consumables in their
1009     inventory; if there are none, they will pick up what they stand on if they
1010     stand on consumables; if they stand on none, they will move towards the
1011     next consumable they see or remember on the map; if they see or remember
1012     none, they will explore parts of the map unseen since ever or for at least
1013     one turn; if there is nothing to explore, they will simply wait.
1014     """
1015     t["T_COMMAND"] = [id for id in world_db["ThingActions"]
1016                       if world_db["ThingActions"][id]["TA_NAME"] == "wait"][0]
1017     if not get_dir_to_target(t, "f"):
1018         sel = get_inventory_slot_to_consume(t)
1019         if -1 != sel:
1020             t["T_COMMAND"] = [id for id in world_db["ThingActions"]
1021                               if world_db["ThingActions"][id]["TA_NAME"]
1022                                  == "use"][0]
1023             t["T_ARGUMENT"] = sel
1024         elif standing_on_consumable(t):
1025             t["T_COMMAND"] = [id for id in world_db["ThingActions"]
1026                               if world_db["ThingActions"][id]["TA_NAME"]
1027                                  == "pick_up"][0]
1028         elif (not get_dir_to_target(t, "c")) and \
1029              (not get_dir_to_target(t, "a")):
1030             get_dir_to_target(t, "s")
1031
1032
1033 def turn_over():
1034     """Run game world and its inhabitants until new player input expected."""
1035     id = 0
1036     whilebreaker = False
1037     while world_db["Things"][0]["T_LIFEPOINTS"]:
1038         for id in [id for id in world_db["Things"]]:  # Only what's from start!
1039             if not id in world_db["Things"] or \
1040                world_db["Things"][id]["carried"]:   # May have been consumed or
1041                 continue                            # picked up during turn …
1042             Thing = world_db["Things"][id]
1043             if Thing["T_LIFEPOINTS"]:
1044                 if not Thing["T_COMMAND"]:
1045                     update_map_memory(Thing)
1046                     if 0 == id:
1047                         whilebreaker = True
1048                         break
1049                     ai(Thing)
1050                 try_healing(Thing)
1051                 Thing["T_PROGRESS"] += 1
1052                 taid = [a for a in world_db["ThingActions"]
1053                           if a == Thing["T_COMMAND"]][0]
1054                 ThingAction = world_db["ThingActions"][taid]
1055                 if Thing["T_PROGRESS"] == ThingAction["TA_EFFORT"]:
1056                     eval("actor_" + ThingAction["TA_NAME"])(Thing)
1057                     Thing["T_COMMAND"] = 0
1058                     Thing["T_PROGRESS"] = 0
1059                 hunger(Thing)
1060             thingproliferation(Thing)
1061         if whilebreaker:
1062             break
1063         world_db["TURN"] += 1
1064
1065
1066 def new_Thing(type, pos=(0, 0)):
1067     """Return Thing of type T_TYPE, with fovmap if alive and world active."""
1068     thing = {
1069         "T_LIFEPOINTS": world_db["ThingTypes"][type]["TT_LIFEPOINTS"],
1070         "T_ARGUMENT": 0,
1071         "T_PROGRESS": 0,
1072         "T_SATIATION": 0,
1073         "T_COMMAND": 0,
1074         "T_TYPE": type,
1075         "T_POSY": pos[0],
1076         "T_POSX": pos[1],
1077         "T_CARRIES": [],
1078         "carried": False,
1079         "T_MEMTHING": [],
1080         "T_MEMMAP": False,
1081         "T_MEMDEPTHMAP": False,
1082         "fovmap": False
1083     }
1084     if world_db["WORLD_ACTIVE"] and thing["T_LIFEPOINTS"]:
1085         build_fov_map(thing)
1086     return thing
1087
1088
1089 def id_setter(id, category, id_store=False, start_at_1=False):
1090     """Set ID of object of category to manipulate ID unused? Create new one.
1091
1092     The ID is stored as id_store.id (if id_store is set). If the integer of the
1093     input is valid (if start_at_1, >= 0, else >= -1), but <0 or (if start_at_1)
1094     <1, calculate new ID: lowest unused ID >=0 or (if start_at_1) >= 1. None is
1095     always returned when no new object is created, otherwise the new object's
1096     ID.
1097     """
1098     min = 0 if start_at_1 else -1
1099     if str == type(id):
1100         id = integer_test(id, min)
1101     if None != id:
1102         if id in world_db[category]:
1103             if id_store:
1104                 id_store.id = id
1105             return None
1106         else:
1107             if (start_at_1 and 0 == id) \
1108                or ((not start_at_1) and (id < 0)):
1109                 id = 0 if start_at_1 else -1
1110                 while 1:
1111                     id = id + 1
1112                     if id not in world_db[category]:
1113                         break
1114             if id_store:
1115                 id_store.id = id
1116     return id
1117
1118
1119 def command_ping():
1120     """Send PONG line to server output file."""
1121     strong_write(io_db["file_out"], "PONG\n")
1122
1123
1124 def command_quit():
1125     """Abort server process."""
1126     save_world()
1127     atomic_write(io_db["path_record"], io_db["record_chunk"], do_append=True)
1128     raise SystemExit("received QUIT command")
1129
1130
1131 def command_thingshere(str_y, str_x):
1132     """Write to out file list of Things known to player at coordinate y, x."""
1133     if world_db["WORLD_ACTIVE"]:
1134         y = integer_test(str_y, 0, 255)
1135         x = integer_test(str_x, 0, 255)
1136         length = world_db["MAP_LENGTH"]
1137         if None != y and None != x and y < length and x < length:
1138             pos = (y * world_db["MAP_LENGTH"]) + x
1139             strong_write(io_db["file_out"], "THINGS_HERE START\n")
1140             if "v" == chr(world_db["Things"][0]["fovmap"][pos]):
1141                 for id in world_db["Things"]:
1142                     if y == world_db["Things"][id]["T_POSY"] \
1143                        and x == world_db["Things"][id]["T_POSX"] \
1144                        and not world_db["Things"][id]["carried"]:
1145                         type = world_db["Things"][id]["T_TYPE"]
1146                         name = world_db["ThingTypes"][type]["TT_NAME"]
1147                         strong_write(io_db["file_out"], name + "\n")
1148             else:
1149                 for mt in world_db["Things"][0]["T_MEMTHING"]:
1150                     if y == mt[1] and x == mt[2]:
1151                         name = world_db["ThingTypes"][mt[0]]["TT_NAME"]
1152                         strong_write(io_db["file_out"], name + "\n")
1153             strong_write(io_db["file_out"], "THINGS_HERE END\n")
1154         else:
1155             print("Ignoring: Invalid map coordinates.")
1156     else:
1157         print("Ignoring: Command only works on existing worlds.")
1158
1159
1160 def play_commander(action, args=False):
1161     """Setter for player's T_COMMAND and T_ARGUMENT, then calling turn_over().
1162
1163     T_ARGUMENT is set to direction char if action=="wait",or 8-bit int if args.
1164     """
1165
1166     def set_command():
1167         id = [x for x in world_db["ThingActions"]
1168                 if world_db["ThingActions"][x]["TA_NAME"] == action][0]
1169         world_db["Things"][0]["T_COMMAND"] = id
1170         turn_over()
1171
1172     def set_command_and_argument_int(str_arg):
1173         val = integer_test(str_arg, 0, 255)
1174         if None != val:
1175             world_db["Things"][0]["T_ARGUMENT"] = val
1176             set_command()
1177
1178     def set_command_and_argument_movestring(str_arg):
1179         if str_arg in directions_db:
1180             world_db["Things"][0]["T_ARGUMENT"] = ord(directions_db[str_arg])
1181             set_command()
1182         else:
1183             print("Ignoring: Argument must be valid direction string.")
1184
1185     if action == "move":
1186         return set_command_and_argument_movestring
1187     elif args:
1188         return set_command_and_argument_int
1189     else:
1190         return set_command
1191
1192
1193 def command_seedrandomness(seed_string):
1194     """Set rand seed to int(seed_string)."""
1195     val = integer_test(seed_string, 0, 4294967295)
1196     if None != val:
1197         rand.seed = val
1198
1199
1200 def command_seedmap(seed_string):
1201     """Set world_db["SEED_MAP"] to int(seed_string), then (re-)make map."""
1202     setter(None, "SEED_MAP", 0, 4294967295)(seed_string)
1203     remake_map()
1204
1205
1206 def command_makeworld(seed_string):
1207     """(Re-)build game world, i.e. map, things, to a new turn 1 from seed.
1208
1209     Seed rand with seed, fill it into world_db["SEED_MAP"]. Do more only with a
1210     "wait" ThingAction and world["PLAYER_TYPE"] matching ThingType of
1211     TT_START_NUMBER > 0. Then, world_db["Things"] emptied, call remake_map()
1212     and set world_db["WORLD_ACTIVE"], world_db["TURN"] to 1. Build new Things
1213     according to ThingTypes' TT_START_NUMBERS, with Thing of ID 0 to ThingType
1214     of ID = world["PLAYER_TYPE"]. Place Things randomly, and actors not on each
1215     other. Init player's memory map. Write "NEW_WORLD" line to out file.
1216     """
1217
1218     def free_pos():
1219         i = 0
1220         while 1:
1221             err = "Space to put thing on too hard to find. Map too small?"
1222             while 1:
1223                 y = rand.next() % world_db["MAP_LENGTH"]
1224                 x = rand.next() % world_db["MAP_LENGTH"]
1225                 if "." == chr(world_db["MAP"][y * world_db["MAP_LENGTH"] + x]):
1226                     break
1227                 i += 1
1228                 if i == 65535:
1229                     raise SystemExit(err)
1230             # Replica of C code, wrongly ignores animatedness of new Thing.
1231             pos_clear = (0 == len([id for id in world_db["Things"]
1232                                    if world_db["Things"][id]["T_LIFEPOINTS"]
1233                                    if world_db["Things"][id]["T_POSY"] == y
1234                                    if world_db["Things"][id]["T_POSX"] == x]))
1235             if pos_clear:
1236                 break
1237         return (y, x)
1238
1239     val = integer_test(seed_string, 0, 4294967295)
1240     if None == val:
1241         return
1242     rand.seed = val
1243     world_db["SEED_MAP"] = val
1244     player_will_be_generated = False
1245     playertype = world_db["PLAYER_TYPE"]
1246     for ThingType in world_db["ThingTypes"]:
1247         if playertype == ThingType:
1248             if 0 < world_db["ThingTypes"][ThingType]["TT_START_NUMBER"]:
1249                 player_will_be_generated = True
1250             break
1251     if not player_will_be_generated:
1252         print("Ignoring beyond SEED_MAP: " +
1253               "No player type with start number >0 defined.")
1254         return
1255     wait_action = False
1256     for ThingAction in world_db["ThingActions"]:
1257         if "wait" == world_db["ThingActions"][ThingAction]["TA_NAME"]:
1258             wait_action = True
1259     if not wait_action:
1260         print("Ignoring beyond SEED_MAP: " +
1261               "No thing action with name 'wait' defined.")
1262         return
1263     world_db["Things"] = {}
1264     remake_map()
1265     world_db["WORLD_ACTIVE"] = 1
1266     world_db["TURN"] = 1
1267     for i in range(world_db["ThingTypes"][playertype]["TT_START_NUMBER"]):
1268         id = id_setter(-1, "Things")
1269         world_db["Things"][id] = new_Thing(playertype, free_pos())
1270     update_map_memory(world_db["Things"][0])
1271     for type in world_db["ThingTypes"]:
1272         for i in range(world_db["ThingTypes"][type]["TT_START_NUMBER"]):
1273             if type != playertype:
1274                 id = id_setter(-1, "Things")
1275                 world_db["Things"][id] = new_Thing(type, free_pos())
1276     strong_write(io_db["file_out"], "NEW_WORLD\n")
1277
1278
1279 def command_maplength(maplength_string):
1280     """Redefine map length. Invalidate map, therefore lose all things on it."""
1281     val = integer_test(maplength_string, 1, 256)
1282     if None != val:
1283         world_db["MAP_LENGTH"] = val
1284         set_world_inactive()
1285         world_db["Things"] = {}
1286         libpr.set_maplength(val)
1287
1288
1289 def command_worldactive(worldactive_string):
1290     """Toggle world_db["WORLD_ACTIVE"] if possible.
1291
1292     An active world can always be set inactive. An inactive world can only be
1293     set active with a "wait" ThingAction, and a player Thing (of ID 0). On
1294     activation, rebuild all Things' FOVs, and the player's map memory.
1295     """
1296     # In original version, map existence was also tested (unnecessarily?).
1297     val = integer_test(worldactive_string, 0, 1)
1298     if val:
1299         if 0 != world_db["WORLD_ACTIVE"]:
1300             if 0 == val:
1301                 set_world_inactive()
1302             else:
1303                 print("World already active.")
1304         elif 0 == world_db["WORLD_ACTIVE"]:
1305             wait_exists = False
1306             for ThingAction in world_db["ThingActions"]:
1307                 if "wait" == world_db["ThingActions"][ThingAction]["TA_NAME"]:
1308                     wait_exists = True
1309                     break
1310             player_exists = False
1311             for Thing in world_db["Things"]:
1312                 if 0 == Thing:
1313                     player_exists = True
1314                     break
1315             if wait_exists and player_exists:
1316                 for id in world_db["Things"]:
1317                     if world_db["Things"][id]["T_LIFEPOINTS"]:
1318                         build_fov_map(world_db["Things"][id])
1319                         if 0 == id:
1320                             update_map_memory(world_db["Things"][id], False)
1321                 world_db["WORLD_ACTIVE"] = 1
1322
1323
1324 def test_for_id_maker(object, category):
1325     """Return decorator testing for object having "id" attribute."""
1326     def decorator(f):
1327         def helper(*args):
1328             if hasattr(object, "id"):
1329                 f(*args)
1330             else:
1331                 print("Ignoring: No " + category +
1332                       " defined to manipulate yet.")
1333         return helper
1334     return decorator
1335
1336
1337 def command_tid(id_string):
1338     """Set ID of Thing to manipulate. ID unused? Create new one.
1339
1340     Default new Thing's type to the first available ThingType, others: zero.
1341     """
1342     id = id_setter(id_string, "Things", command_tid)
1343     if None != id:
1344         if world_db["ThingTypes"] == {}:
1345             print("Ignoring: No ThingType to settle new Thing in.")
1346             return
1347         type = list(world_db["ThingTypes"].keys())[0]
1348         world_db["Things"][id] = new_Thing(type)
1349
1350
1351 test_Thing_id = test_for_id_maker(command_tid, "Thing")
1352
1353
1354 @test_Thing_id
1355 def command_tcommand(str_int):
1356     """Set T_COMMAND of selected Thing."""
1357     val = integer_test(str_int, 0)
1358     if None != val:
1359         if 0 == val or val in world_db["ThingActions"]:
1360             world_db["Things"][command_tid.id]["T_COMMAND"] = val
1361         else:
1362             print("Ignoring: ThingAction ID belongs to no known ThingAction.")
1363
1364
1365 @test_Thing_id
1366 def command_ttype(str_int):
1367     """Set T_TYPE of selected Thing."""
1368     val = integer_test(str_int, 0)
1369     if None != val:
1370         if val in world_db["ThingTypes"]:
1371             world_db["Things"][command_tid.id]["T_TYPE"] = val
1372         else:
1373             print("Ignoring: ThingType ID belongs to no known ThingType.")
1374
1375
1376 @test_Thing_id
1377 def command_tcarries(str_int):
1378     """Append int(str_int) to T_CARRIES of selected Thing.
1379
1380     The ID int(str_int) must not be of the selected Thing, and must belong to a
1381     Thing with unset "carried" flag. Its "carried" flag will be set on owning.
1382     """
1383     val = integer_test(str_int, 0)
1384     if None != val:
1385         if val == command_tid.id:
1386             print("Ignoring: Thing cannot carry itself.")
1387         elif val in world_db["Things"] \
1388              and not world_db["Things"][val]["carried"]:
1389             world_db["Things"][command_tid.id]["T_CARRIES"].append(val)
1390             world_db["Things"][val]["carried"] = True
1391         else:
1392             print("Ignoring: Thing not available for carrying.")
1393     # Note that the whole carrying structure is different from the C version:
1394     # Carried-ness is marked by a "carried" flag, not by Things containing
1395     # Things internally.
1396
1397
1398 @test_Thing_id
1399 def command_tmemthing(str_t, str_y, str_x):
1400     """Add (int(str_t), int(str_y), int(str_x)) to selected Thing's T_MEMTHING.
1401
1402     The type must fit to an existing ThingType, and the position into the map.
1403     """
1404     type = integer_test(str_t, 0)
1405     posy = integer_test(str_y, 0, 255)
1406     posx = integer_test(str_x, 0, 255)
1407     if None != type and None != posy and None != posx:
1408         if type not in world_db["ThingTypes"] \
1409            or posy >= world_db["MAP_LENGTH"] or posx >= world_db["MAP_LENGTH"]:
1410             print("Ignoring: Illegal value for thing type or position.")
1411         else:
1412             memthing = (type, posy, posx)
1413             world_db["Things"][command_tid.id]["T_MEMTHING"].append(memthing)
1414
1415
1416 def setter_map(maptype):
1417     """Set selected Thing's map of maptype's int(str_int)-th line to mapline.
1418
1419     If Thing has no map of maptype yet, initialize it with ' ' bytes first.
1420     """
1421     @test_Thing_id
1422     def helper(str_int, mapline):
1423         val = integer_test(str_int, 0, 255)
1424         if None != val:
1425             if val >= world_db["MAP_LENGTH"]:
1426                 print("Illegal value for map line number.")
1427             elif len(mapline) != world_db["MAP_LENGTH"]:
1428                 print("Map line length is unequal map width.")
1429             else:
1430                 length = world_db["MAP_LENGTH"]
1431                 map = None
1432                 if not world_db["Things"][command_tid.id][maptype]:
1433                     map = bytearray(b' ' * (length ** 2))
1434                 else:
1435                     map = world_db["Things"][command_tid.id][maptype]
1436                 map[val * length:(val * length) + length] = mapline.encode()
1437                 world_db["Things"][command_tid.id][maptype] = map
1438     return helper
1439
1440
1441 def setter_tpos(axis):
1442     """Generate setter for T_POSX or  T_POSY of selected Thing.
1443
1444     If world is active, rebuilds animate things' fovmap, player's memory map.
1445     """
1446     @test_Thing_id
1447     def helper(str_int):
1448         val = integer_test(str_int, 0, 255)
1449         if None != val:
1450             if val < world_db["MAP_LENGTH"]:
1451                 world_db["Things"][command_tid.id]["T_POS" + axis] = val
1452                 if world_db["WORLD_ACTIVE"] \
1453                    and world_db["Things"][command_tid.id]["T_LIFEPOINTS"]:
1454                     build_fov_map(world_db["Things"][command_tid.id])
1455                     if 0 == command_tid.id:
1456                         update_map_memory(world_db["Things"][command_tid.id])
1457             else:
1458                 print("Ignoring: Position is outside of map.")
1459     return helper
1460
1461
1462 def command_ttid(id_string):
1463     """Set ID of ThingType to manipulate. ID unused? Create new one.
1464
1465     Default new ThingType's TT_SYMBOL to "?", TT_CORPSE_ID to self, others: 0.
1466     """
1467     id = id_setter(id_string, "ThingTypes", command_ttid)
1468     if None != id:
1469         world_db["ThingTypes"][id] = {
1470             "TT_NAME": "(none)",
1471             "TT_CONSUMABLE": 0,
1472             "TT_LIFEPOINTS": 0,
1473             "TT_PROLIFERATE": 0,
1474             "TT_START_NUMBER": 0,
1475             "TT_SYMBOL": "?",
1476             "TT_CORPSE_ID": id
1477         }
1478
1479
1480 test_ThingType_id = test_for_id_maker(command_ttid, "ThingType")
1481
1482
1483 @test_ThingType_id
1484 def command_ttname(name):
1485     """Set TT_NAME of selected ThingType."""
1486     world_db["ThingTypes"][command_ttid.id]["TT_NAME"] = name
1487
1488
1489 @test_ThingType_id
1490 def command_ttsymbol(char):
1491     """Set TT_SYMBOL of selected ThingType. """
1492     if 1 == len(char):
1493         world_db["ThingTypes"][command_ttid.id]["TT_SYMBOL"] = char
1494     else:
1495         print("Ignoring: Argument must be single character.")
1496
1497
1498 @test_ThingType_id
1499 def command_ttcorpseid(str_int):
1500     """Set TT_CORPSE_ID of selected ThingType."""
1501     val = integer_test(str_int, 0)
1502     if None != val:
1503         if val in world_db["ThingTypes"]:
1504             world_db["ThingTypes"][command_ttid.id]["TT_CORPSE_ID"] = val
1505         else:
1506             print("Ignoring: Corpse ID belongs to no known ThignType.")
1507
1508
1509 def command_taid(id_string):
1510     """Set ID of ThingAction to manipulate. ID unused? Create new one.
1511
1512     Default new ThingAction's TA_EFFORT to 1, its TA_NAME to "wait".
1513     """
1514     id = id_setter(id_string, "ThingActions", command_taid, True)
1515     if None != id:
1516         world_db["ThingActions"][id] = {
1517             "TA_EFFORT": 1,
1518             "TA_NAME": "wait"
1519         }
1520
1521
1522 test_ThingAction_id = test_for_id_maker(command_taid, "ThingAction")
1523
1524
1525 @test_ThingAction_id
1526 def command_taname(name):
1527     """Set TA_NAME of selected ThingAction.
1528
1529     The name must match a valid thing action function. If after the name
1530     setting no ThingAction with name "wait" remains, call set_world_inactive().
1531     """
1532     if name == "wait" or name == "move" or name == "use" or name == "drop" \
1533        or name == "pick_up":
1534         world_db["ThingActions"][command_taid.id]["TA_NAME"] = name
1535         if 1 == world_db["WORLD_ACTIVE"]:
1536             wait_defined = False
1537             for id in world_db["ThingActions"]:
1538                 if "wait" == world_db["ThingActions"][id]["TA_NAME"]:
1539                     wait_defined = True
1540                     break
1541             if not wait_defined:
1542                 set_world_inactive()
1543     else:
1544         print("Ignoring: Invalid action name.")
1545     # In contrast to the original,naming won't map a function to a ThingAction.
1546
1547
1548 def command_ai():
1549     """Call ai() on player Thing, then turn_over()."""
1550     ai(world_db["Things"][0])
1551     turn_over()
1552
1553
1554 """Commands database.
1555
1556 Map command start tokens to ([0]) number of expected command arguments, ([1])
1557 the command's meta-ness (i.e. is it to be written to the record file, is it to
1558 be ignored in replay mode if read from server input file), and ([2]) a function
1559 to be called on it.
1560 """
1561 commands_db = {
1562     "QUIT": (0, True, command_quit),
1563     "PING": (0, True, command_ping),
1564     "THINGS_HERE": (2, True, command_thingshere),
1565     "MAKE_WORLD": (1, False, command_makeworld),
1566     "SEED_MAP": (1, False, command_seedmap),
1567     "SEED_RANDOMNESS": (1, False, command_seedrandomness),
1568     "TURN": (1, False, setter(None, "TURN", 0, 65535)),
1569     "GOD_MOOD": (1, False, setter(None, "GOD_MOOD", -32768, 32767)),  # #
1570     "GOD_FAVOR": (1, False, setter(None, "GOD_FAVOR", -32768, 32767)),  # #
1571     "PLAYER_TYPE": (1, False, setter(None, "PLAYER_TYPE", 0)),
1572     "MAP_LENGTH": (1, False, command_maplength),
1573     "WORLD_ACTIVE": (1, False, command_worldactive),
1574     "TA_ID": (1, False, command_taid),
1575     "TA_EFFORT": (1, False, setter("ThingAction", "TA_EFFORT", 0, 255)),
1576     "TA_NAME": (1, False, command_taname),
1577     "TT_ID": (1, False, command_ttid),
1578     "TT_NAME": (1, False, command_ttname),
1579     "TT_SYMBOL": (1, False, command_ttsymbol),
1580     "TT_CORPSE_ID": (1, False, command_ttcorpseid),
1581     "TT_CONSUMABLE": (1, False, setter("ThingType", "TT_CONSUMABLE",
1582                                        0, 65535)),
1583     "TT_START_NUMBER": (1, False, setter("ThingType", "TT_START_NUMBER",
1584                                          0, 255)),
1585     "TT_PROLIFERATE": (1, False, setter("ThingType", "TT_PROLIFERATE",
1586                                         0, 255)),
1587     "TT_LIFEPOINTS": (1, False, setter("ThingType", "TT_LIFEPOINTS", 0, 255)),
1588     "T_ID": (1, False, command_tid),
1589     "T_ARGUMENT": (1, False, setter("Thing", "T_ARGUMENT", 0, 255)),
1590     "T_PROGRESS": (1, False, setter("Thing", "T_PROGRESS", 0, 255)),
1591     "T_LIFEPOINTS": (1, False, setter("Thing", "T_LIFEPOINTS", 0, 255)),
1592     "T_SATIATION": (1, False, setter("Thing", "T_SATIATION", -32768, 32767)),
1593     "T_COMMAND": (1, False, command_tcommand),
1594     "T_TYPE": (1, False, command_ttype),
1595     "T_CARRIES": (1, False, command_tcarries),
1596     "T_MEMMAP": (2, False, setter_map("T_MEMMAP")),
1597     "T_MEMDEPTHMAP": (2, False, setter_map("T_MEMDEPTHMAP")),
1598     "T_MEMTHING": (3, False, command_tmemthing),
1599     "T_POSY": (1, False, setter_tpos("Y")),
1600     "T_POSX": (1, False, setter_tpos("X")),
1601     "wait": (0, False, play_commander("wait")),
1602     "move": (1, False, play_commander("move")),
1603     "pick_up": (0, False, play_commander("pick_up")),
1604     "drop": (1, False, play_commander("drop", True)),
1605     "use": (1, False, play_commander("use", True)),
1606     "ai": (0, False, command_ai)
1607 }
1608
1609
1610 """World state database. With sane default values. (Randomness is in rand.)"""
1611 world_db = {
1612     "TURN": 0,
1613     "MAP_LENGTH": 64,
1614     "SEED_MAP": 0,
1615     "PLAYER_TYPE": 0,
1616     "WORLD_ACTIVE": 0,
1617     "GOD_MOOD": 0,  # #
1618     "GOD_FAVOR": 0,  # #
1619     "ThingActions": {},
1620     "ThingTypes": {},
1621     "Things": {}
1622 }
1623
1624 """Mapping of direction names to internal direction chars."""
1625 directions_db = {"east": "d", "south-east": "c", "south-west": "x",
1626                  "west": "s", "north-west": "w", "north-east": "e"}
1627
1628 """File IO database."""
1629 io_db = {
1630     "path_save": "save",
1631     "path_record": "record_save",
1632     "path_worldconf": "confserver/world",
1633     "path_server": "server/",
1634     "path_in": "server/in",
1635     "path_out": "server/out",
1636     "path_worldstate": "server/worldstate",
1637     "tmp_suffix": "_tmp",
1638     "kicked_by_rival": False,
1639     "worldstate_updateable": False
1640 }
1641
1642
1643 try:
1644     libpr = prep_library()
1645     rand = RandomnessIO()
1646     opts = parse_command_line_arguments()
1647     if opts.savefile:
1648         io_db["path_save"] = opts.savefile
1649         io_db["path_record"] = "record_" + opts.savefile
1650     setup_server_io()
1651     if opts.verbose:
1652         io_db["verbose"] = True
1653     if None != opts.replay:
1654         replay_game()
1655     else:
1656         play_game()
1657 except SystemExit as exit:
1658     print("ABORTING: " + exit.args[0])
1659 except:
1660     print("SOMETHING WENT WRONG IN UNEXPECTED WAYS")
1661     raise
1662 finally:
1663     cleanup_server_io()