home · contact · privacy
Minor optimization in update_map_memory().
[plomrogue] / roguelike-server
1 #!/usr/bin/python3
2
3 # This file is part of PlomRogue. PlomRogue is licensed under the GPL version 3
4 # or any later version. For details on its copyright, license, and warranties,
5 # see the file NOTICE in the root directory of the PlomRogue source package.
6
7
8 import argparse
9 import errno
10 import os
11 import shlex
12 import shutil
13 import time
14 import ctypes
15
16
17 class RandomnessIO:
18     """"Interface to libplomrogue's pseudo-randomness generator."""
19
20     def set_seed(self, seed):
21         libpr.seed_rrand(1, seed)
22
23     def get_seed(self):
24         return libpr.seed_rrand(0, 0)
25
26     def next(self):
27         return libpr.rrand()
28
29     seed = property(get_seed, set_seed)
30
31
32 def prep_library():
33     """Prepare ctypes library at ./libplomrogue.so"""
34     libpath = ("./libplomrogue.so")
35     if not os.access(libpath, os.F_OK):
36         raise SystemExit("No library " + libpath + ", run ./redo first?")
37     libpr = ctypes.cdll.LoadLibrary(libpath)
38     libpr.seed_rrand.restype = ctypes.c_uint32
39     return libpr
40
41
42 def c_pointer_to_bytearray(ba):
43     """Return C char * pointer to ba."""
44     type = ctypes.c_char * len(ba)
45     return type.from_buffer(ba)
46
47
48 def strong_write(file, string):
49     """Apply write(string), then flush()."""
50     file.write(string)
51     file.flush()
52
53
54 def setup_server_io():
55     """Fill IO files DB with proper file( path)s. Write process IO test string.
56
57     Ensure IO files directory at server/. Remove any old input file if found.
58     Set up new input file for reading, and new output file for writing. Start
59     output file with process hash line of format PID + " " + floated UNIX time
60     (io_db["teststring"]). Raise SystemExit if file is found at path of either
61     record or save file plus io_db["tmp_suffix"].
62     """
63     def detect_atomic_leftover(path, tmp_suffix):
64         path_tmp = path + tmp_suffix
65         msg = "Found file '" + path_tmp + "' that may be a leftover from an " \
66               "aborted previous attempt to write '" + path + "'. Aborting " \
67               "until matter is resolved by removing it from its current path."
68         if os.access(path_tmp, os.F_OK):
69             raise SystemExit(msg)
70     io_db["teststring"] = str(os.getpid()) + " " + str(time.time())
71     io_db["save_wait"] = 0
72     io_db["verbose"] = False
73     io_db["record_chunk"] = ""
74     os.makedirs(io_db["path_server"], exist_ok=True)
75     io_db["file_out"] = open(io_db["path_out"], "w")
76     strong_write(io_db["file_out"], io_db["teststring"] + "\n")
77     if os.access(io_db["path_in"], os.F_OK):
78         os.remove(io_db["path_in"])
79     io_db["file_in"] = open(io_db["path_in"], "w")
80     io_db["file_in"].close()
81     io_db["file_in"] = open(io_db["path_in"], "r")
82     detect_atomic_leftover(io_db["path_save"], io_db["tmp_suffix"])
83     detect_atomic_leftover(io_db["path_record"], io_db["tmp_suffix"])
84
85
86 def cleanup_server_io():
87     """Close and (if io_db["kicked_by_rival"] false) remove files in io_db."""
88     def helper(file_key, path_key):
89         if file_key in io_db:
90             io_db[file_key].close()
91         if not io_db["kicked_by_rival"] \
92            and os.access(io_db[path_key], os.F_OK):
93             os.remove(io_db[path_key])
94     helper("file_in", "path_in")
95     helper("file_out", "path_out")
96     helper("file_worldstate", "path_worldstate")
97     if "file_record" in io_db:
98         io_db["file_record"].close()
99
100
101 def obey(command, prefix, replay=False, do_record=False):
102     """Call function from commands_db mapped to command's first token.
103
104     Tokenize command string with shlex.split(comments=True). If replay is set,
105     a non-meta command from the commands_db merely triggers obey() on the next
106     command from the records file. If not, non-meta commands set
107     io_db["worldstate_updateable"] to world_db["WORLD_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):
716     """To chance of 1/TT_PROLIFERATE, create t offspring in neighbor cell.
717
718     Naturally only works with TT_PROLIFERATE > 0. The neighbor cell must be
719     passable and not be inhabited by a Thing of the same type, or, if Thing is
720     animate, any other animate Thing. If there are several map cell candidates,
721     one is selected randomly.
722     """
723     def test_cell(t, y, x):
724         if "." == chr(world_db["MAP"][(y * world_db["MAP_LENGTH"]) + x]):
725             for id in [id for id in world_db["Things"]
726                        if y == world_db["Things"][id]["T_POSY"]
727                        if x == world_db["Things"][id]["T_POSX"]
728                        if (t["T_TYPE"] == world_db["Things"][id]["T_TYPE"])
729                        or (t["T_LIFEPOINTS"] and
730                            world_db["Things"][id]["T_LIFEPOINTS"])]:
731                 return False
732             return True
733         return False
734     prolscore = world_db["ThingTypes"][t["T_TYPE"]]["TT_PROLIFERATE"]
735     if prolscore and (1 == prolscore or 1 == (rand.next() % prolscore)):
736         candidates = []
737         for dir in [directions_db[key] for key in directions_db]:
738             mv_result = mv_yx_in_dir_legal(dir, t["T_POSY"], t["T_POSX"])
739             if mv_result[0] and test_cell(t, mv_result[1], mv_result[2]):
740                 candidates.append((mv_result[1], mv_result[2]))
741         if len(candidates):
742             i = rand.next() % len(candidates)
743             id = id_setter(-1, "Things")
744             newT = new_Thing(t["T_TYPE"], (candidates[i][0], candidates[i][1]))
745             world_db["Things"][id] = newT
746
747
748 def try_healing(t):
749     """Grow t's HP to a 1/32 chance if < HP max, satiation > 0, and waiting.
750
751     On success, decrease satiation score by 32.
752     """
753     if t["T_SATIATION"] > 0 \
754        and t["T_LIFEPOINTS"] < \
755         world_db["ThingTypes"][t["T_TYPE"]]["TT_LIFEPOINTS"] \
756        and 0 == (rand.next() % 31) \
757        and t["T_COMMAND"] == [id for id in world_db["ThingActions"]
758                               if world_db["ThingActions"][id]["TA_NAME"] ==
759                               "wait"][0]:
760         t["T_LIFEPOINTS"] += 1
761         t["T_SATIATION"] -= 32
762         if t == world_db["Things"][0]:
763             strong_write(io_db["file_out"], "LOG You heal.\n")
764
765
766 def hunger(t):
767     """Decrement t's satiation,dependent on it trigger lifepoint dec chance."""
768     if t["T_SATIATION"] > -32768:
769         t["T_SATIATION"] -= 1
770     testbase = t["T_SATIATION"] if t["T_SATIATION"] >= 0 else -t["T_SATIATION"]
771     if not world_db["ThingTypes"][t["T_TYPE"]]["TT_LIFEPOINTS"]:
772         raise RuntimeError("A thing that should not hunger is hungering.")
773     stomach = int(32767 / world_db["ThingTypes"][t["T_TYPE"]]["TT_LIFEPOINTS"])
774     if int(int(testbase / stomach) / ((rand.next() % stomach) + 1)):
775         if t == world_db["Things"][0]:
776             strong_write(io_db["file_out"], "LOG You suffer from hunger.\n")
777         decrement_lifepoints(t)
778
779
780 def get_dir_to_target(t, filter):
781     """Try to set T_COMMAND/T_ARGUMENT for move to "filter"-determined target.
782
783     The path-wise nearest target is chosen, via the shortest available path.
784     Target must not be t. On succcess, return positive value, else False.
785     Filters:
786     "a": Thing in FOV is below a certain distance, animate, but of ThingType
787          that is not t's, and starts out weaker than t is; build path as
788          avoiding things of t's ThingType
789     "f": neighbor cell (not inhabited by any animate Thing) further away from
790          animate Thing not further than x steps away and in FOV and of a
791          ThingType that is not t's, and starts out stronger or as strong as t
792          is currently; or (cornered), if no such flight cell, but Thing of
793          above criteria is too near,1 a cell closer to it, or, if less near,
794          just wait
795     "c": Thing in memorized map is consumable
796     "s": memory map cell with greatest-reachable degree of unexploredness
797     """
798
799     def zero_score_map_where_char_on_memdepthmap(c):
800         # OUTSOURCED FOR PERFORMANCE REASONS TO libplomrogue.so:
801         # for i in [i for i in range(world_db["MAP_LENGTH"] ** 2)
802         #           if t["T_MEMDEPTHMAP"][i] == mem_depth_c[0]]:
803         #     set_map_score(i, 0)
804         map = c_pointer_to_bytearray(t["T_MEMDEPTHMAP"])
805         if libpr.zero_score_map_where_char_on_memdepthmap(c, map):
806             raise RuntimeError("No score map allocated for "
807                                "zero_score_map_where_char_on_memdepthmap().")
808
809     def set_map_score(pos, score):
810         test = libpr.set_map_score(pos, score)
811         if test:
812             raise RuntimeError("No score map allocated for set_map_score().")
813
814     def get_map_score(pos):
815         result = libpr.get_map_score(pos)
816         if result < 0:
817             raise RuntimeError("No score map allocated for get_map_score().")
818         return result
819
820     def seeing_thing():
821         if t["fovmap"] and ("a" == filter or "f" == filter):
822             for id in world_db["Things"]:
823                 Thing = world_db["Things"][id]
824                 if Thing != t and Thing["T_LIFEPOINTS"] and \
825                    t["T_TYPE"] != Thing["T_TYPE"] and \
826                    'v' == chr(t["fovmap"][(Thing["T_POSY"]
827                                           * world_db["MAP_LENGTH"])
828                                           + Thing["T_POSX"]]):
829                     ThingType = world_db["ThingTypes"][Thing["T_TYPE"]]
830                     if ("f" == filter and ThingType["TT_LIFEPOINTS"] >=
831                         t["T_LIFEPOINTS"]) \
832                        or ("a" == filter and ThingType["TT_LIFEPOINTS"] <
833                             t["T_LIFEPOINTS"]):
834                         return True
835         elif t["T_MEMMAP"] and "c" == filter:
836             for mt in t["T_MEMTHING"]:
837                 if ' ' != chr(t["T_MEMMAP"][(mt[1] * world_db["MAP_LENGTH"])
838                                             + mt[2]]) \
839                    and world_db["ThingTypes"][mt[0]]["TT_CONSUMABLE"]:
840                     return True
841         return False
842
843     def set_cells_passable_on_memmap_to_65534_on_scoremap():
844         # OUTSOURCED FOR PERFORMANCE REASONS TO libplomrogue.so:
845         # ord_dot = ord(".")
846         # memmap = t["T_MEMMAP"]
847         # for i in [i for i in range(world_db["MAP_LENGTH"] ** 2)
848         #            if ord_dot == memmap[i]]:
849         #     set_map_score(i, 65534) # i.e. 65535-1
850         map = c_pointer_to_bytearray(t["T_MEMMAP"])
851         if libpr.set_cells_passable_on_memmap_to_65534_on_scoremap(map):
852             raise RuntimeError("No score map allocated for set_cells_passable"
853                                "_on_memmap_to_65534_on_scoremap().")
854
855     def init_score_map():
856         test = libpr.init_score_map()
857         if test:
858             raise RuntimeError("Malloc error in init_score_map().")
859         ord_v = ord("v")
860         ord_blank = ord(" ")
861         set_cells_passable_on_memmap_to_65534_on_scoremap()
862         if "a" == filter:
863             for id in world_db["Things"]:
864                 Thing = world_db["Things"][id]
865                 pos = Thing["T_POSY"] * world_db["MAP_LENGTH"] \
866                     + Thing["T_POSX"]
867                 if t != Thing and Thing["T_LIFEPOINTS"] and \
868                    t["T_TYPE"] != Thing["T_TYPE"] and \
869                    ord_v == t["fovmap"][pos] and \
870                    t["T_LIFEPOINTS"] > \
871                    world_db["ThingTypes"][Thing["T_TYPE"]]["TT_LIFEPOINTS"]:
872                     set_map_score(pos, 0)
873                 elif t["T_TYPE"] == Thing["T_TYPE"]:
874                     set_map_score(pos, 65535)
875         elif "f" == filter:
876             for id in [id for id in world_db["Things"]
877                        if world_db["Things"][id]["T_LIFEPOINTS"]]:
878                 Thing = world_db["Things"][id]
879                 pos = Thing["T_POSY"] * world_db["MAP_LENGTH"] \
880                     + Thing["T_POSX"]
881                 if t["T_TYPE"] != Thing["T_TYPE"] and \
882                    ord_v == t["fovmap"][pos] and \
883                    t["T_LIFEPOINTS"] <= \
884                    world_db["ThingTypes"][Thing["T_TYPE"]]["TT_LIFEPOINTS"]:
885                     set_map_score(pos, 0)
886         elif "c" == filter:
887             for mt in [mt for mt in t["T_MEMTHING"]
888                        if ord_blank != t["T_MEMMAP"][mt[1]
889                                                      * world_db["MAP_LENGTH"]
890                                                      + mt[2]]
891                        if world_db["ThingTypes"][mt[0]]["TT_CONSUMABLE"]]:
892                 set_map_score(mt[1] * world_db["MAP_LENGTH"] + mt[2], 0)
893         elif "s" == filter:
894             zero_score_map_where_char_on_memdepthmap(mem_depth_c[0])
895
896     def rand_target_dir(neighbors, cmp, dirs):
897         candidates = []
898         n_candidates = 0
899         for i in range(len(dirs)):
900             if cmp == neighbors[i]:
901                 candidates.append(dirs[i])
902                 n_candidates += 1
903         return candidates[rand.next() % n_candidates] if n_candidates else 0
904
905     def get_neighbor_scores(dirs, eye_pos):
906         scores = []
907         if libpr.ready_neighbor_scores(eye_pos):
908             raise RuntimeError("No score map allocated for " +
909                                "ready_neighbor_scores.()")
910         for i in range(len(dirs)):
911             scores.append(libpr.get_neighbor_score(i))
912         return scores
913
914     def get_dir_from_neighbors():
915         dir_to_target = False
916         dirs = "edcxsw"
917         eye_pos = t["T_POSY"] * world_db["MAP_LENGTH"] + t["T_POSX"]
918         neighbors = get_neighbor_scores(dirs, eye_pos)
919         if "f" == filter:
920             inhabited = [world_db["Things"][id]["T_POSY"]
921                          * world_db["MAP_LENGTH"]
922                          + world_db["Things"][id]["T_POSX"]
923                          for id in world_db["Things"]
924                          if world_db["Things"][id]["T_LIFEPOINTS"]]
925             for i in range(len(dirs)):
926                 mv_yx_in_dir_legal(dirs[i], t["T_POSY"], t["T_POSX"])
927                 pos_cmp = libpr.result_y() * world_db["MAP_LENGTH"] \
928                     + libpr.result_x()
929                 for pos in [pos for pos in inhabited if pos == pos_cmp]:
930                     neighbors[i] = 65535
931                     break
932         minmax_start = 0 if "f" == filter else 65535 - 1
933         minmax_neighbor = minmax_start
934         for i in range(len(dirs)):
935             if ("f" == filter and get_map_score(eye_pos) < neighbors[i] and
936                 minmax_neighbor < neighbors[i] and 65535 != neighbors[i]) \
937                or ("f" != filter and minmax_neighbor > neighbors[i]):
938                 minmax_neighbor = neighbors[i]
939         if minmax_neighbor != minmax_start:
940             dir_to_target = rand_target_dir(neighbors, minmax_neighbor, dirs)
941         if "f" == filter:
942             if not dir_to_target:
943                 if 1 == get_map_score(eye_pos):
944                     dir_to_target = rand_target_dir(neighbors, 0, dirs)
945                 elif 3 >= get_map_score(eye_pos):
946                     t["T_COMMAND"] = [id for id in world_db["ThingActions"]
947                                       if
948                                       world_db["ThingActions"][id]["TA_NAME"]
949                                       == "wait"][0]
950                     return 1
951             elif dir_to_target and 3 < get_map_score(eye_pos):
952                 dir_to_target = 0
953         elif "a" == filter and 10 <= get_map_score(eye_pos):
954             dir_to_target = 0
955         return dir_to_target
956
957     dir_to_target = False
958     mem_depth_c = b' '
959     run_i = 9 + 1 if "s" == filter else 1
960     while run_i and not dir_to_target and ("s" == filter or seeing_thing()):
961         run_i -= 1
962         init_score_map()
963         mem_depth_c = b'9' if b' ' == mem_depth_c \
964             else bytes([mem_depth_c[0] - 1])
965         if libpr.dijkstra_map():
966             raise RuntimeError("No score map allocated for dijkstra_map().")
967         dir_to_target = get_dir_from_neighbors()
968         libpr.free_score_map()
969         if dir_to_target and str == type(dir_to_target):
970             t["T_COMMAND"] = [id for id in world_db["ThingActions"]
971                               if world_db["ThingActions"][id]["TA_NAME"]
972                               == "move"][0]
973             t["T_ARGUMENT"] = ord(dir_to_target)
974     return dir_to_target
975
976
977 def standing_on_consumable(t):
978     """Return True/False whether t is standing on a consumable."""
979     for id in [id for id in world_db["Things"] if world_db["Things"][id] != t
980                if world_db["Things"][id]["T_POSY"] == t["T_POSY"]
981                if world_db["Things"][id]["T_POSX"] == t["T_POSX"]
982                if world_db["ThingTypes"][world_db["Things"][id]["T_TYPE"]]
983                           ["TT_CONSUMABLE"]]:
984         return True
985     return False
986
987
988 def get_inventory_slot_to_consume(t):
989     """Return slot Id of strongest consumable in t's inventory, else -1."""
990     cmp_consumability = 0
991     selection = -1
992     i = 0
993     for id in t["T_CARRIES"]:
994         type = world_db["Things"][id]["T_TYPE"]
995         if world_db["ThingTypes"][type]["TT_CONSUMABLE"] > cmp_consumability:
996             cmp_consumability = world_db["ThingTypes"][type]["TT_CONSUMABLE"]
997             selection = i
998         i += 1
999     return selection
1000
1001
1002 def ai(t):
1003     """Determine next command/argment for actor t via AI algorithms.
1004
1005     AI will look for, and move towards, enemies (animate Things not of their
1006     own ThingType); if they see none, they will consume consumables in their
1007     inventory; if there are none, they will pick up what they stand on if they
1008     stand on consumables; if they stand on none, they will move towards the
1009     next consumable they see or remember on the map; if they see or remember
1010     none, they will explore parts of the map unseen since ever or for at least
1011     one turn; if there is nothing to explore, they will simply wait.
1012     """
1013     t["T_COMMAND"] = [id for id in world_db["ThingActions"]
1014                       if world_db["ThingActions"][id]["TA_NAME"] == "wait"][0]
1015     if not get_dir_to_target(t, "f"):
1016         sel = get_inventory_slot_to_consume(t)
1017         if -1 != sel:
1018             t["T_COMMAND"] = [id for id in world_db["ThingActions"]
1019                               if world_db["ThingActions"][id]["TA_NAME"]
1020                               == "use"][0]
1021             t["T_ARGUMENT"] = sel
1022         elif standing_on_consumable(t):
1023             t["T_COMMAND"] = [id for id in world_db["ThingActions"]
1024                               if world_db["ThingActions"][id]["TA_NAME"]
1025                               == "pick_up"][0]
1026         elif (not get_dir_to_target(t, "c")) and \
1027              (not get_dir_to_target(t, "a")):
1028             get_dir_to_target(t, "s")
1029
1030
1031 def turn_over():
1032     """Run game world and its inhabitants until new player input expected."""
1033     id = 0
1034     whilebreaker = False
1035     while world_db["Things"][0]["T_LIFEPOINTS"]:
1036         for id in [id for id in world_db["Things"]]:  # Only what's from start!
1037             if not id in world_db["Things"] or \
1038                world_db["Things"][id]["carried"]:   # May have been consumed or
1039                 continue                            # picked up during turn …
1040             Thing = world_db["Things"][id]
1041             if Thing["T_LIFEPOINTS"]:
1042                 if not Thing["T_COMMAND"]:
1043                     update_map_memory(Thing)
1044                     if 0 == id:
1045                         whilebreaker = True
1046                         break
1047                     ai(Thing)
1048                 try_healing(Thing)
1049                 Thing["T_PROGRESS"] += 1
1050                 taid = [a for a in world_db["ThingActions"]
1051                         if a == Thing["T_COMMAND"]][0]
1052                 ThingAction = world_db["ThingActions"][taid]
1053                 if Thing["T_PROGRESS"] == ThingAction["TA_EFFORT"]:
1054                     eval("actor_" + ThingAction["TA_NAME"])(Thing)
1055                     Thing["T_COMMAND"] = 0
1056                     Thing["T_PROGRESS"] = 0
1057                 hunger(Thing)
1058             thingproliferation(Thing)
1059         if whilebreaker:
1060             break
1061         world_db["TURN"] += 1
1062
1063
1064 def new_Thing(type, pos=(0, 0)):
1065     """Return Thing of type T_TYPE, with fovmap if alive and world active."""
1066     thing = {
1067         "T_LIFEPOINTS": world_db["ThingTypes"][type]["TT_LIFEPOINTS"],
1068         "T_ARGUMENT": 0,
1069         "T_PROGRESS": 0,
1070         "T_SATIATION": 0,
1071         "T_COMMAND": 0,
1072         "T_TYPE": type,
1073         "T_POSY": pos[0],
1074         "T_POSX": pos[1],
1075         "T_CARRIES": [],
1076         "carried": False,
1077         "T_MEMTHING": [],
1078         "T_MEMMAP": False,
1079         "T_MEMDEPTHMAP": False,
1080         "fovmap": False
1081     }
1082     if world_db["WORLD_ACTIVE"] and thing["T_LIFEPOINTS"]:
1083         build_fov_map(thing)
1084     return thing
1085
1086
1087 def id_setter(id, category, id_store=False, start_at_1=False):
1088     """Set ID of object of category to manipulate ID unused? Create new one.
1089     The ID is stored as id_store.id (if id_store is set). If the integer of the
1090     input is valid (if start_at_1, >= 0, else >= -1), but <0 or (if start_at_1)
1091     <1, calculate new ID: lowest unused ID >=0 or (if start_at_1) >= 1. None is
1092     always returned when no new object is created, else the new object's ID.
1093     """
1094     min = 0 if start_at_1 else -1
1095     if str == type(id):
1096         id = integer_test(id, min)
1097     if None != id:
1098         if id in world_db[category]:
1099             if id_store:
1100                 id_store.id = id
1101             return None
1102         else:
1103             if (start_at_1 and 0 == id) \
1104                or ((not start_at_1) and (id < 0)):
1105                 id = 0 if start_at_1 else -1
1106                 while 1:
1107                     id = id + 1
1108                     if id not in world_db[category]:
1109                         break
1110             if id_store:
1111                 id_store.id = id
1112     return id
1113
1114
1115 def command_ping():
1116     """Send PONG line to server output file."""
1117     strong_write(io_db["file_out"], "PONG\n")
1118
1119
1120 def command_quit():
1121     """Abort server process."""
1122     if None == opts.replay:
1123         save_world()
1124         atomic_write(io_db["path_record"], io_db["record_chunk"], do_append=True)
1125     raise SystemExit("received QUIT command")
1126
1127
1128 def command_thingshere(str_y, str_x):
1129     """Write to out file list of Things known to player at coordinate y, x."""
1130     if world_db["WORLD_ACTIVE"]:
1131         y = integer_test(str_y, 0, 255)
1132         x = integer_test(str_x, 0, 255)
1133         length = world_db["MAP_LENGTH"]
1134         if None != y and None != x and y < length and x < length:
1135             pos = (y * world_db["MAP_LENGTH"]) + x
1136             strong_write(io_db["file_out"], "THINGS_HERE START\n")
1137             if "v" == chr(world_db["Things"][0]["fovmap"][pos]):
1138                 for id in world_db["Things"]:
1139                     if y == world_db["Things"][id]["T_POSY"] \
1140                        and x == world_db["Things"][id]["T_POSX"] \
1141                        and not world_db["Things"][id]["carried"]:
1142                         type = world_db["Things"][id]["T_TYPE"]
1143                         name = world_db["ThingTypes"][type]["TT_NAME"]
1144                         strong_write(io_db["file_out"], name + "\n")
1145             else:
1146                 for mt in world_db["Things"][0]["T_MEMTHING"]:
1147                     if y == mt[1] and x == mt[2]:
1148                         name = world_db["ThingTypes"][mt[0]]["TT_NAME"]
1149                         strong_write(io_db["file_out"], name + "\n")
1150             strong_write(io_db["file_out"], "THINGS_HERE END\n")
1151         else:
1152             print("Ignoring: Invalid map coordinates.")
1153     else:
1154         print("Ignoring: Command only works on existing worlds.")
1155
1156
1157 def play_commander(action, args=False):
1158     """Setter for player's T_COMMAND and T_ARGUMENT, then calling turn_over().
1159
1160     T_ARGUMENT is set to direction char if action=="wait",or 8-bit int if args.
1161     """
1162
1163     def set_command():
1164         id = [x for x in world_db["ThingActions"]
1165               if world_db["ThingActions"][x]["TA_NAME"] == action][0]
1166         world_db["Things"][0]["T_COMMAND"] = id
1167         turn_over()
1168
1169     def set_command_and_argument_int(str_arg):
1170         val = integer_test(str_arg, 0, 255)
1171         if None != val:
1172             world_db["Things"][0]["T_ARGUMENT"] = val
1173             set_command()
1174
1175     def set_command_and_argument_movestring(str_arg):
1176         if str_arg in directions_db:
1177             world_db["Things"][0]["T_ARGUMENT"] = ord(directions_db[str_arg])
1178             set_command()
1179         else:
1180             print("Ignoring: Argument must be valid direction string.")
1181
1182     if action == "move":
1183         return set_command_and_argument_movestring
1184     elif args:
1185         return set_command_and_argument_int
1186     else:
1187         return set_command
1188
1189
1190 def command_seedrandomness(seed_string):
1191     """Set rand seed to int(seed_string)."""
1192     val = integer_test(seed_string, 0, 4294967295)
1193     if None != val:
1194         rand.seed = val
1195
1196
1197 def command_seedmap(seed_string):
1198     """Set world_db["SEED_MAP"] to int(seed_string), then (re-)make map."""
1199     setter(None, "SEED_MAP", 0, 4294967295)(seed_string)
1200     remake_map()
1201
1202
1203 def command_makeworld(seed_string):
1204     """(Re-)build game world, i.e. map, things, to a new turn 1 from seed.
1205
1206     Seed rand with seed, fill it into world_db["SEED_MAP"]. Do more only with a
1207     "wait" ThingAction and world["PLAYER_TYPE"] matching ThingType of
1208     TT_START_NUMBER > 0. Then, world_db["Things"] emptied, call remake_map()
1209     and set world_db["WORLD_ACTIVE"], world_db["TURN"] to 1. Build new Things
1210     according to ThingTypes' TT_START_NUMBERS, with Thing of ID 0 to ThingType
1211     of ID = world["PLAYER_TYPE"]. Place Things randomly, and actors not on each
1212     other. Init player's memory map. Write "NEW_WORLD" line to out file.
1213     """
1214
1215     def free_pos():
1216         i = 0
1217         while 1:
1218             err = "Space to put thing on too hard to find. Map too small?"
1219             while 1:
1220                 y = rand.next() % world_db["MAP_LENGTH"]
1221                 x = rand.next() % world_db["MAP_LENGTH"]
1222                 if "." == chr(world_db["MAP"][y * world_db["MAP_LENGTH"] + x]):
1223                     break
1224                 i += 1
1225                 if i == 65535:
1226                     raise SystemExit(err)
1227             # Replica of C code, wrongly ignores animatedness of new Thing.
1228             pos_clear = (0 == len([id for id in world_db["Things"]
1229                                    if world_db["Things"][id]["T_LIFEPOINTS"]
1230                                    if world_db["Things"][id]["T_POSY"] == y
1231                                    if world_db["Things"][id]["T_POSX"] == x]))
1232             if pos_clear:
1233                 break
1234         return (y, x)
1235
1236     val = integer_test(seed_string, 0, 4294967295)
1237     if None == val:
1238         return
1239     rand.seed = val
1240     world_db["SEED_MAP"] = val
1241     player_will_be_generated = False
1242     playertype = world_db["PLAYER_TYPE"]
1243     for ThingType in world_db["ThingTypes"]:
1244         if playertype == ThingType:
1245             if 0 < world_db["ThingTypes"][ThingType]["TT_START_NUMBER"]:
1246                 player_will_be_generated = True
1247             break
1248     if not player_will_be_generated:
1249         print("Ignoring beyond SEED_MAP: " +
1250               "No player type with start number >0 defined.")
1251         return
1252     wait_action = False
1253     for ThingAction in world_db["ThingActions"]:
1254         if "wait" == world_db["ThingActions"][ThingAction]["TA_NAME"]:
1255             wait_action = True
1256     if not wait_action:
1257         print("Ignoring beyond SEED_MAP: " +
1258               "No thing action with name 'wait' defined.")
1259         return
1260     world_db["Things"] = {}
1261     remake_map()
1262     world_db["WORLD_ACTIVE"] = 1
1263     world_db["TURN"] = 1
1264     for i in range(world_db["ThingTypes"][playertype]["TT_START_NUMBER"]):
1265         id = id_setter(-1, "Things")
1266         world_db["Things"][id] = new_Thing(playertype, free_pos())
1267     update_map_memory(world_db["Things"][0])
1268     for type in world_db["ThingTypes"]:
1269         for i in range(world_db["ThingTypes"][type]["TT_START_NUMBER"]):
1270             if type != playertype:
1271                 id = id_setter(-1, "Things")
1272                 world_db["Things"][id] = new_Thing(type, free_pos())
1273     strong_write(io_db["file_out"], "NEW_WORLD\n")
1274
1275
1276 def command_maplength(maplength_string):
1277     """Redefine map length. Invalidate map, therefore lose all things on it."""
1278     val = integer_test(maplength_string, 1, 256)
1279     if None != val:
1280         world_db["MAP_LENGTH"] = val
1281         set_world_inactive()
1282         world_db["Things"] = {}
1283         libpr.set_maplength(val)
1284
1285
1286 def command_worldactive(worldactive_string):
1287     """Toggle world_db["WORLD_ACTIVE"] if possible.
1288
1289     An active world can always be set inactive. An inactive world can only be
1290     set active with a "wait" ThingAction, and a player Thing (of ID 0). On
1291     activation, rebuild all Things' FOVs, and the player's map memory.
1292     """
1293     # In original version, map existence was also tested (unnecessarily?).
1294     val = integer_test(worldactive_string, 0, 1)
1295     if val:
1296         if 0 != world_db["WORLD_ACTIVE"]:
1297             if 0 == val:
1298                 set_world_inactive()
1299             else:
1300                 print("World already active.")
1301         elif 0 == world_db["WORLD_ACTIVE"]:
1302             wait_exists = False
1303             for ThingAction in world_db["ThingActions"]:
1304                 if "wait" == world_db["ThingActions"][ThingAction]["TA_NAME"]:
1305                     wait_exists = True
1306                     break
1307             player_exists = False
1308             for Thing in world_db["Things"]:
1309                 if 0 == Thing:
1310                     player_exists = True
1311                     break
1312             if wait_exists and player_exists:
1313                 for id in world_db["Things"]:
1314                     if world_db["Things"][id]["T_LIFEPOINTS"]:
1315                         build_fov_map(world_db["Things"][id])
1316                         if 0 == id:
1317                             update_map_memory(world_db["Things"][id], False)
1318                 world_db["WORLD_ACTIVE"] = 1
1319
1320
1321 def test_for_id_maker(object, category):
1322     """Return decorator testing for object having "id" attribute."""
1323     def decorator(f):
1324         def helper(*args):
1325             if hasattr(object, "id"):
1326                 f(*args)
1327             else:
1328                 print("Ignoring: No " + category +
1329                       " defined to manipulate yet.")
1330         return helper
1331     return decorator
1332
1333
1334 def command_tid(id_string):
1335     """Set ID of Thing to manipulate. ID unused? Create new one.
1336
1337     Default new Thing's type to the first available ThingType, others: zero.
1338     """
1339     id = id_setter(id_string, "Things", command_tid)
1340     if None != id:
1341         if world_db["ThingTypes"] == {}:
1342             print("Ignoring: No ThingType to settle new Thing in.")
1343             return
1344         type = list(world_db["ThingTypes"].keys())[0]
1345         world_db["Things"][id] = new_Thing(type)
1346
1347
1348 test_Thing_id = test_for_id_maker(command_tid, "Thing")
1349
1350
1351 @test_Thing_id
1352 def command_tcommand(str_int):
1353     """Set T_COMMAND of selected Thing."""
1354     val = integer_test(str_int, 0)
1355     if None != val:
1356         if 0 == val or val in world_db["ThingActions"]:
1357             world_db["Things"][command_tid.id]["T_COMMAND"] = val
1358         else:
1359             print("Ignoring: ThingAction ID belongs to no known ThingAction.")
1360
1361
1362 @test_Thing_id
1363 def command_ttype(str_int):
1364     """Set T_TYPE of selected Thing."""
1365     val = integer_test(str_int, 0)
1366     if None != val:
1367         if val in world_db["ThingTypes"]:
1368             world_db["Things"][command_tid.id]["T_TYPE"] = val
1369         else:
1370             print("Ignoring: ThingType ID belongs to no known ThingType.")
1371
1372
1373 @test_Thing_id
1374 def command_tcarries(str_int):
1375     """Append int(str_int) to T_CARRIES of selected Thing.
1376
1377     The ID int(str_int) must not be of the selected Thing, and must belong to a
1378     Thing with unset "carried" flag. Its "carried" flag will be set on owning.
1379     """
1380     val = integer_test(str_int, 0)
1381     if None != val:
1382         if val == command_tid.id:
1383             print("Ignoring: Thing cannot carry itself.")
1384         elif val in world_db["Things"] \
1385                 and not world_db["Things"][val]["carried"]:
1386             world_db["Things"][command_tid.id]["T_CARRIES"].append(val)
1387             world_db["Things"][val]["carried"] = True
1388         else:
1389             print("Ignoring: Thing not available for carrying.")
1390     # Note that the whole carrying structure is different from the C version:
1391     # Carried-ness is marked by a "carried" flag, not by Things containing
1392     # Things internally.
1393
1394
1395 @test_Thing_id
1396 def command_tmemthing(str_t, str_y, str_x):
1397     """Add (int(str_t), int(str_y), int(str_x)) to selected Thing's T_MEMTHING.
1398
1399     The type must fit to an existing ThingType, and the position into the map.
1400     """
1401     type = integer_test(str_t, 0)
1402     posy = integer_test(str_y, 0, 255)
1403     posx = integer_test(str_x, 0, 255)
1404     if None != type and None != posy and None != posx:
1405         if type not in world_db["ThingTypes"] \
1406            or posy >= world_db["MAP_LENGTH"] or posx >= world_db["MAP_LENGTH"]:
1407             print("Ignoring: Illegal value for thing type or position.")
1408         else:
1409             memthing = (type, posy, posx)
1410             world_db["Things"][command_tid.id]["T_MEMTHING"].append(memthing)
1411
1412
1413 def setter_map(maptype):
1414     """Set selected Thing's map of maptype's int(str_int)-th line to mapline.
1415
1416     If Thing has no map of maptype yet, initialize it with ' ' bytes first.
1417     """
1418     @test_Thing_id
1419     def helper(str_int, mapline):
1420         val = integer_test(str_int, 0, 255)
1421         if None != val:
1422             if val >= world_db["MAP_LENGTH"]:
1423                 print("Illegal value for map line number.")
1424             elif len(mapline) != world_db["MAP_LENGTH"]:
1425                 print("Map line length is unequal map width.")
1426             else:
1427                 length = world_db["MAP_LENGTH"]
1428                 map = None
1429                 if not world_db["Things"][command_tid.id][maptype]:
1430                     map = bytearray(b' ' * (length ** 2))
1431                 else:
1432                     map = world_db["Things"][command_tid.id][maptype]
1433                 map[val * length:(val * length) + length] = mapline.encode()
1434                 world_db["Things"][command_tid.id][maptype] = map
1435     return helper
1436
1437
1438 def setter_tpos(axis):
1439     """Generate setter for T_POSX or  T_POSY of selected Thing.
1440
1441     If world is active, rebuilds animate things' fovmap, player's memory map.
1442     """
1443     @test_Thing_id
1444     def helper(str_int):
1445         val = integer_test(str_int, 0, 255)
1446         if None != val:
1447             if val < world_db["MAP_LENGTH"]:
1448                 world_db["Things"][command_tid.id]["T_POS" + axis] = val
1449                 if world_db["WORLD_ACTIVE"] \
1450                    and world_db["Things"][command_tid.id]["T_LIFEPOINTS"]:
1451                     build_fov_map(world_db["Things"][command_tid.id])
1452                     if 0 == command_tid.id:
1453                         update_map_memory(world_db["Things"][command_tid.id])
1454             else:
1455                 print("Ignoring: Position is outside of map.")
1456     return helper
1457
1458
1459 def command_ttid(id_string):
1460     """Set ID of ThingType to manipulate. ID unused? Create new one.
1461
1462     Default new ThingType's TT_SYMBOL to "?", TT_CORPSE_ID to self, others: 0.
1463     """
1464     id = id_setter(id_string, "ThingTypes", command_ttid)
1465     if None != id:
1466         world_db["ThingTypes"][id] = {
1467             "TT_NAME": "(none)",
1468             "TT_CONSUMABLE": 0,
1469             "TT_LIFEPOINTS": 0,
1470             "TT_PROLIFERATE": 0,
1471             "TT_START_NUMBER": 0,
1472             "TT_SYMBOL": "?",
1473             "TT_CORPSE_ID": id
1474         }
1475
1476
1477 test_ThingType_id = test_for_id_maker(command_ttid, "ThingType")
1478
1479
1480 @test_ThingType_id
1481 def command_ttname(name):
1482     """Set TT_NAME of selected ThingType."""
1483     world_db["ThingTypes"][command_ttid.id]["TT_NAME"] = name
1484
1485
1486 @test_ThingType_id
1487 def command_ttsymbol(char):
1488     """Set TT_SYMBOL of selected ThingType. """
1489     if 1 == len(char):
1490         world_db["ThingTypes"][command_ttid.id]["TT_SYMBOL"] = char
1491     else:
1492         print("Ignoring: Argument must be single character.")
1493
1494
1495 @test_ThingType_id
1496 def command_ttcorpseid(str_int):
1497     """Set TT_CORPSE_ID of selected ThingType."""
1498     val = integer_test(str_int, 0)
1499     if None != val:
1500         if val in world_db["ThingTypes"]:
1501             world_db["ThingTypes"][command_ttid.id]["TT_CORPSE_ID"] = val
1502         else:
1503             print("Ignoring: Corpse ID belongs to no known ThignType.")
1504
1505
1506 def command_taid(id_string):
1507     """Set ID of ThingAction to manipulate. ID unused? Create new one.
1508
1509     Default new ThingAction's TA_EFFORT to 1, its TA_NAME to "wait".
1510     """
1511     id = id_setter(id_string, "ThingActions", command_taid, True)
1512     if None != id:
1513         world_db["ThingActions"][id] = {
1514             "TA_EFFORT": 1,
1515             "TA_NAME": "wait"
1516         }
1517
1518
1519 test_ThingAction_id = test_for_id_maker(command_taid, "ThingAction")
1520
1521
1522 @test_ThingAction_id
1523 def command_taname(name):
1524     """Set TA_NAME of selected ThingAction.
1525
1526     The name must match a valid thing action function. If after the name
1527     setting no ThingAction with name "wait" remains, call set_world_inactive().
1528     """
1529     if name == "wait" or name == "move" or name == "use" or name == "drop" \
1530        or name == "pick_up":
1531         world_db["ThingActions"][command_taid.id]["TA_NAME"] = name
1532         if 1 == world_db["WORLD_ACTIVE"]:
1533             wait_defined = False
1534             for id in world_db["ThingActions"]:
1535                 if "wait" == world_db["ThingActions"][id]["TA_NAME"]:
1536                     wait_defined = True
1537                     break
1538             if not wait_defined:
1539                 set_world_inactive()
1540     else:
1541         print("Ignoring: Invalid action name.")
1542     # In contrast to the original,naming won't map a function to a ThingAction.
1543
1544
1545 def command_ai():
1546     """Call ai() on player Thing, then turn_over()."""
1547     ai(world_db["Things"][0])
1548     turn_over()
1549
1550
1551 """Commands database.
1552
1553 Map command start tokens to ([0]) number of expected command arguments, ([1])
1554 the command's meta-ness (i.e. is it to be written to the record file, is it to
1555 be ignored in replay mode if read from server input file), and ([2]) a function
1556 to be called on it.
1557 """
1558 commands_db = {
1559     "QUIT": (0, True, command_quit),
1560     "PING": (0, True, command_ping),
1561     "THINGS_HERE": (2, True, command_thingshere),
1562     "MAKE_WORLD": (1, False, command_makeworld),
1563     "SEED_MAP": (1, False, command_seedmap),
1564     "SEED_RANDOMNESS": (1, False, command_seedrandomness),
1565     "TURN": (1, False, setter(None, "TURN", 0, 65535)),
1566     "PLAYER_TYPE": (1, False, setter(None, "PLAYER_TYPE", 0)),
1567     "MAP_LENGTH": (1, False, command_maplength),
1568     "WORLD_ACTIVE": (1, False, command_worldactive),
1569     "TA_ID": (1, False, command_taid),
1570     "TA_EFFORT": (1, False, setter("ThingAction", "TA_EFFORT", 0, 255)),
1571     "TA_NAME": (1, False, command_taname),
1572     "TT_ID": (1, False, command_ttid),
1573     "TT_NAME": (1, False, command_ttname),
1574     "TT_SYMBOL": (1, False, command_ttsymbol),
1575     "TT_CORPSE_ID": (1, False, command_ttcorpseid),
1576     "TT_CONSUMABLE": (1, False, setter("ThingType", "TT_CONSUMABLE",
1577                                        0, 65535)),
1578     "TT_START_NUMBER": (1, False, setter("ThingType", "TT_START_NUMBER",
1579                                          0, 255)),
1580     "TT_PROLIFERATE": (1, False, setter("ThingType", "TT_PROLIFERATE",
1581                                         0, 255)),
1582     "TT_LIFEPOINTS": (1, False, setter("ThingType", "TT_LIFEPOINTS", 0, 255)),
1583     "T_ID": (1, False, command_tid),
1584     "T_ARGUMENT": (1, False, setter("Thing", "T_ARGUMENT", 0, 255)),
1585     "T_PROGRESS": (1, False, setter("Thing", "T_PROGRESS", 0, 255)),
1586     "T_LIFEPOINTS": (1, False, setter("Thing", "T_LIFEPOINTS", 0, 255)),
1587     "T_SATIATION": (1, False, setter("Thing", "T_SATIATION", -32768, 32767)),
1588     "T_COMMAND": (1, False, command_tcommand),
1589     "T_TYPE": (1, False, command_ttype),
1590     "T_CARRIES": (1, False, command_tcarries),
1591     "T_MEMMAP": (2, False, setter_map("T_MEMMAP")),
1592     "T_MEMDEPTHMAP": (2, False, setter_map("T_MEMDEPTHMAP")),
1593     "T_MEMTHING": (3, False, command_tmemthing),
1594     "T_POSY": (1, False, setter_tpos("Y")),
1595     "T_POSX": (1, False, setter_tpos("X")),
1596     "wait": (0, False, play_commander("wait")),
1597     "move": (1, False, play_commander("move")),
1598     "pick_up": (0, False, play_commander("pick_up")),
1599     "drop": (1, False, play_commander("drop", True)),
1600     "use": (1, False, play_commander("use", True)),
1601     "ai": (0, False, command_ai)
1602 }
1603
1604
1605 """World state database. With sane default values. (Randomness is in rand.)"""
1606 world_db = {
1607     "TURN": 0,
1608     "MAP_LENGTH": 64,
1609     "SEED_MAP": 0,
1610     "PLAYER_TYPE": 0,
1611     "WORLD_ACTIVE": 0,
1612     "ThingActions": {},
1613     "ThingTypes": {},
1614     "Things": {}
1615 }
1616
1617 """Mapping of direction names to internal direction chars."""
1618 directions_db = {"east": "d", "south-east": "c", "south-west": "x",
1619                  "west": "s", "north-west": "w", "north-east": "e"}
1620
1621 """File IO database."""
1622 io_db = {
1623     "path_save": "save",
1624     "path_record": "record_save",
1625     "path_worldconf": "confserver/world",
1626     "path_server": "server/",
1627     "path_in": "server/in",
1628     "path_out": "server/out",
1629     "path_worldstate": "server/worldstate",
1630     "tmp_suffix": "_tmp",
1631     "kicked_by_rival": False,
1632     "worldstate_updateable": False
1633 }
1634
1635
1636 try:
1637     libpr = prep_library()
1638     rand = RandomnessIO()
1639     opts = parse_command_line_arguments()
1640     if opts.savefile:
1641         io_db["path_save"] = opts.savefile
1642         io_db["path_record"] = "record_" + opts.savefile
1643     setup_server_io()
1644     if opts.verbose:
1645         io_db["verbose"] = True
1646     if None != opts.replay:
1647         replay_game()
1648     else:
1649         play_game()
1650 except SystemExit as exit:
1651     print("ABORTING: " + exit.args[0])
1652 except:
1653     print("SOMETHING WENT WRONG IN UNEXPECTED WAYS")
1654     raise
1655 finally:
1656     cleanup_server_io()