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