#include "client.h"
#include <ctype.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/wait.h>
#include <signal.h>
#include "external.h"
#include "mapdata.h"
#include "p_cmd.h"
#include "script.h"

Include dependency graph for script.c:

Data Structures
struct	script

Functions
static int	script_by_name (const char *name)

static void	script_dead (int i)

void	script_fdset (int maxfd, fd_set set)

void	script_init (const char *cparams)

void	script_kill (const char *params)

void	script_killall (void)

void	script_killall_wrapper (const char *params)

void	script_list (void)

void	script_monitor (const char *command, int repeat, int must_send)

void	script_monitor_str (const char *command)

void	script_process (fd_set *set)

static void	script_process_cmd (int i)

static void	script_send_item (int i, const char head, const item it)

void	script_sync (int commdiff)

void	script_tell (const char *params)

void	script_watch (const char cmd, const guint8 data_initial, const int data_len, const enum CmdFormat format)

static void	send_map (int i, int x, int y)

Variables
static int	num_scripts = 0

static struct script *	scripts = NULL

Detailed Description

Handles the client-side scripting interface.

Each script is an external process that keeps two pipes open between the client and the script (one in each direction). When the script starts, it defaults to receiving no data from the client. Normally, the first command it sends to the client will be a request to have certain types of data sent to the script as the client receives them from the server (such as drawinfo commands). The script can also request current information from the client, such as the contents of the inventory or the map data (either live or last viewed "fog-of-war" data). The script can also send commands for the client to pass to the server.

Script Commands:

watch {command type} whenever the server sends the given command type to the client, also send a copy to the script. Note that this checked before the client processes the command, so it will automatically handle new options that may be added in the future. If the command type is NULL, all commands are watched.

unwatch {command type} turn off a previous watch command. There may be a slight delay in response before the command is processed, so some unwanted data may still be sent to the script.

request {data type} have the client send the given data to the script.

issue [{repeat} {must_send}] {command} issue the specified command to the server. if {repeat} isn't numeric then the command is sent directly For "lock" and "mark" only, the parameters are converted to binary.

draw {color} {text} display the text in the specified color as if the server had sent a drawinfo command.

monitor send the script a copy of every command that is sent to the server.

unmonitor turn off monitoring.

sync {#} wait until the server has acknowledged all but {#} commands have been received

To implement this:

Processing script commands: gtk/gx11.c:do_network() and x11/x11.c:event_loop() are modified to also watch for input from scripts in the select() call, in which case script_process(fd) in this file is called.

Handling watches: common/client.c:DoClient() is modified to pass a copy of each command to script_watch() before checking for it in the table.

Handling of monitor: common/player.c:send_command() is modified to pass a copy of each command to script_monitor() before sending to the server.

Handling of requests: global variables are directly accessed from within this file.

Handling of issues: send_command() is called directly. Note that this command will be sent to any scripts that are monitoring output.

Launching new scripts: common/player.c:extended_command() is extended to add a check for "script <scriptname>" as an additional command, calling script_init(). Also added is the "scripts" command to list all running scripts, the "scriptkill" command to terminate a script (close the pipes and assume it takes the hint), and the "scripttell" command to send a message to a running script.

Definition in file script.c.