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