1 /* 2 * Copyright 1987, 1988 by MIT Student Information Processing Board 3 * 4 * Permission to use, copy, modify, and distribute this software and 5 * its documentation for any purpose is hereby granted, provided that 6 * the names of M.I.T. and the M.I.T. S.I.P.B. not be used in 7 * advertising or publicity pertaining to distribution of the software 8 * without specific, written prior permission. M.I.T. and the 9 * M.I.T. S.I.P.B. make no representations about the suitability of 10 * this software for any purpose. It is provided "as is" without 11 * express or implied warranty. 12 * 13 * This quote is just too good to not pass on: 14 * 15 * "BTW, I would have rejected the name Story Server because its 16 * initials are SS, the name of the secret police in Nazi 17 * Germany, probably the most despised pair of letters in western 18 * culture." --- http://scriptingnewsarchive.userland.com/1999/12/13 19 * 20 * Let no one say political correctness isn't dead.... 21 */ 22 23 #ifndef _ss_h 24 #define _ss_h __FILE__ 25 26 #include <ss/ss_err.h> 27 28 #define __SS_CONST const 29 #define __SS_PROTO (int, const char * const *, int, void *) 30 31 #ifdef __GNUC__ 32 #define __SS_ATTR(x) __attribute__(x) 33 #else 34 #define __SS_ATTR(x) 35 #endif 36 37 38 typedef __SS_CONST struct _ss_request_entry { 39 __SS_CONST char * __SS_CONST *command_names; /* whatever */ 40 void (* __SS_CONST function) __SS_PROTO; /* foo */ 41 __SS_CONST char * __SS_CONST info_string; /* NULL */ 42 int flags; /* 0 */ 43 } ss_request_entry; 44 45 typedef __SS_CONST struct _ss_request_table { 46 int version; 47 ss_request_entry *requests; 48 } ss_request_table; 49 50 #define SS_RQT_TBL_V2 2 51 52 typedef struct _ss_rp_options { /* DEFAULT VALUES */ 53 int version; /* SS_RP_V1 */ 54 void (*unknown) __SS_PROTO; /* call for unknown command */ 55 int allow_suspend; 56 int catch_int; 57 } ss_rp_options; 58 59 #define SS_RP_V1 1 60 61 #define SS_OPT_DONT_LIST 0x0001 62 #define SS_OPT_DONT_SUMMARIZE 0x0002 63 64 void ss_help __SS_PROTO; 65 #if 0 66 char *ss_current_request(); /* This is actually a macro */ 67 #endif 68 69 char *ss_name(int sci_idx); 70 void ss_error (int, long, char const *, ...) 71 __SS_ATTR((format(printf, 3, 4))); 72 void ss_perror (int, long, char const *); 73 74 int ss_create_invocation(const char *, const char *, void *, 75 ss_request_table *, int *); 76 void ss_delete_invocation(int); 77 int ss_listen(int); 78 int ss_execute_line(int, char *); 79 void ss_add_request_table(int, ss_request_table *, int, int *); 80 void ss_delete_request_table(int, ss_request_table *, int *); 81 void ss_abort_subsystem(int sci_idx, int code); 82 void ss_quit(int argc, const char * const *argv, int sci_idx, void *infop); 83 void ss_self_identify(int argc, const char * const *argv, int sci_idx, void *infop); 84 void ss_subsystem_name(int argc, const char * const *argv, 85 int sci_idx, void *infop); 86 void ss_subsystem_version(int argc, const char * const *argv, 87 int sci_idx, void *infop); 88 void ss_unimplemented(int argc, const char * const *argv, 89 int sci_idx, void *infop); 90 void ss_set_prompt(int sci_idx, char *new_prompt); 91 char *ss_get_prompt(int sci_idx); 92 void ss_get_readline(int sci_idx); 93 char *ss_safe_getenv(const char *arg); 94 95 extern ss_request_table ss_std_requests; 96 #endif /* _ss_h */ 97