Mercurial > urweb

annotate include/urweb.h @ 1297:41484478a32d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updating documentation
author Adam Chlipala <adam@chlipala.net>
date Tue, 07 Sep 2010 09:47:06 -0400
parents 929981850d9d
children 714e8b84221b
rev   line source
adamc@764 1 #ifndef URWEB_H
adamc@764 2 #define URWEB_H
adamc@764 3
adamc@117 4 #include <sys/types.h>
adamc@117 5
adamc@102 6 #include "types.h"
adamc@102 7
adamc@863 8 int uw_really_send(int sock, const void *buf, ssize_t len);
adamc@1083 9 int uw_really_write(int fd, const void *buf, size_t len);
adamc@117 10
adamc@311 11 extern uw_unit uw_unit_v;
adamc@102 12
adamc@667 13 void uw_global_init(void);
adamc@1094 14 void uw_app_init(uw_app*);
adamc@667 15
adamc@863 16 void uw_client_connect(unsigned id, int pass, int sock,
adamc@863 17 int (*send)(int sockfd, const void *buf, size_t len),
adamc@864 18 int (*close)(int fd),
adamc@864 19 void *logger_data, uw_logger log_error);
adamc@683 20 void uw_prune_clients(uw_context);
adamc@687 21 failure_kind uw_initialize(uw_context);
adamc@667 22
adamc@687 23 uw_context uw_init(void);
adamc@1118 24 void uw_close(uw_context);
adamc@1113 25 int uw_set_app(uw_context, uw_app*);
adamc@1121 26 uw_app *uw_get_app(uw_context);
adamc@311 27 void uw_set_db(uw_context, void*);
adamc@311 28 void *uw_get_db(uw_context);
adamc@311 29 void uw_free(uw_context);
adamc@311 30 void uw_reset(uw_context);
adamc@311 31 void uw_reset_keep_request(uw_context);
adamc@311 32 void uw_reset_keep_error_message(uw_context);
adamc@1094 33 const char *uw_get_url_prefix(uw_context);
adamc@272 34
adamc@311 35 failure_kind uw_begin_init(uw_context);
adamc@856 36 void uw_set_on_success(char *);
adamc@854 37 void uw_set_headers(uw_context, char *(*get_header)(void *, const char *), void *get_header_data);
adamc@458 38 failure_kind uw_begin(uw_context, char *path);
adam@1294 39 failure_kind uw_begin_onError(uw_context, char *msg);
adamc@682 40 void uw_login(uw_context);
adamc@671 41 void uw_commit(uw_context);
adamc@671 42 int uw_rollback(uw_context);
adamc@167 43
adamc@311 44 __attribute__((noreturn)) void uw_error(uw_context, failure_kind, const char *fmt, ...);
adamc@311 45 char *uw_error_message(uw_context);
adamc@1131 46 void uw_set_error_message(uw_context, const char *fmt, ...);
adam@1295 47 uw_Basis_string uw_dup_and_clear_error_message(uw_context);
adamc@1131 48 int uw_has_error(uw_context);
adamc@425 49 void uw_push_cleanup(uw_context, void (*func)(void *), void *arg);
adamc@425 50 void uw_pop_cleanup(uw_context);
adamc@167 51
adamc@311 52 void *uw_malloc(uw_context, size_t);
adamc@323 53 void uw_begin_region(uw_context);
adamc@323 54 void uw_end_region(uw_context);
adamc@324 55 void uw_memstats(uw_context);
adamc@323 56
adamc@311 57 int uw_send(uw_context, int sock);
adamc@856 58 int uw_print(uw_context, int fd);
adamc@863 59 int uw_output(uw_context ctx, int (*output)(void *data, const char *buf, size_t len), void *data);
adamc@117 60
adamc@801 61 int uw_set_input(uw_context, const char *name, char *value);
adamc@801 62 int uw_set_file_input(uw_context, char *name, uw_Basis_file);
adamc@756 63
adamc@311 64 char *uw_get_input(uw_context, int name);
adamc@311 65 char *uw_get_optional_input(uw_context, int name);
adamc@739 66 uw_Basis_file uw_get_file_input(uw_context, int name);
adamc@756 67 void uw_enter_subform(uw_context, int name);
adamc@756 68 void uw_leave_subform(uw_context);
adamc@759 69 int uw_enter_subforms(uw_context, int name);
adamc@759 70 int uw_next_entry(uw_context);
adamc@737 71
adamc@311 72 void uw_write(uw_context, const char*);
adamc@106 73
adamc@577 74 uw_Basis_int uw_Basis_new_client_source(uw_context, uw_Basis_string);
adamc@577 75 uw_unit uw_Basis_set_client_source(uw_context, uw_Basis_int, uw_Basis_string);
adamc@577 76
adamc@643 77 void uw_set_script_header(uw_context, const char*);
adamc@694 78 const char *uw_Basis_get_settings(uw_context, uw_unit);
adamc@645 79 const char *uw_Basis_get_script(uw_context, uw_unit);
adamc@562 80
adamc@695 81 uw_Basis_string uw_Basis_maybe_onload(uw_context, uw_Basis_string);
adamc@1042 82 uw_Basis_string uw_Basis_maybe_onunload(uw_context, uw_Basis_string);
adamc@695 83
adamc@693 84 void uw_set_needs_push(uw_context, int);
adamc@736 85 void uw_set_needs_sig(uw_context, int);
adamc@693 86
adamc@311 87 char *uw_Basis_htmlifyInt(uw_context, uw_Basis_int);
adamc@311 88 char *uw_Basis_htmlifyFloat(uw_context, uw_Basis_float);
adamc@311 89 char *uw_Basis_htmlifyString(uw_context, uw_Basis_string);
adamc@311 90 char *uw_Basis_htmlifyBool(uw_context, uw_Basis_bool);
adamc@436 91 char *uw_Basis_htmlifyTime(uw_context, uw_Basis_time);
adamc@120 92
adamc@425 93 uw_unit uw_Basis_htmlifyInt_w(uw_context, uw_Basis_int);
adamc@425 94 uw_unit uw_Basis_htmlifyFloat_w(uw_context, uw_Basis_float);
adamc@425 95 uw_unit uw_Basis_htmlifyString_w(uw_context, uw_Basis_string);
adamc@425 96 uw_unit uw_Basis_htmlifyBool_w(uw_context, uw_Basis_bool);
adamc@436 97 uw_unit uw_Basis_htmlifyTime_w(uw_context, uw_Basis_time);
adamc@135 98
adamc@311 99 char *uw_Basis_attrifyInt(uw_context, uw_Basis_int);
adamc@311 100 char *uw_Basis_attrifyFloat(uw_context, uw_Basis_float);
adamc@311 101 char *uw_Basis_attrifyString(uw_context, uw_Basis_string);
adamc@1011 102 char *uw_Basis_attrifyChar(uw_context, uw_Basis_char);
adamc@682 103 char *uw_Basis_attrifyTime(uw_context, uw_Basis_time);
adamc@678 104 char *uw_Basis_attrifyChannel(uw_context, uw_Basis_channel);
adamc@682 105 char *uw_Basis_attrifyClient(uw_context, uw_Basis_client);
adamc@721 106 char *uw_Basis_attrifyCss_class(uw_context, uw_Basis_css_class);
adamc@117 107
adamc@425 108 uw_unit uw_Basis_attrifyInt_w(uw_context, uw_Basis_int);
adamc@425 109 uw_unit uw_Basis_attrifyFloat_w(uw_context, uw_Basis_float);
adamc@425 110 uw_unit uw_Basis_attrifyString_w(uw_context, uw_Basis_string);
adamc@1011 111 uw_unit uw_Basis_attrifyChar_w(uw_context, uw_Basis_char);
adamc@120 112
adamc@311 113 char *uw_Basis_urlifyInt(uw_context, uw_Basis_int);
adamc@311 114 char *uw_Basis_urlifyFloat(uw_context, uw_Basis_float);
adamc@311 115 char *uw_Basis_urlifyString(uw_context, uw_Basis_string);
adamc@311 116 char *uw_Basis_urlifyBool(uw_context, uw_Basis_bool);
adamc@488 117 char *uw_Basis_urlifyTime(uw_context, uw_Basis_time);
adamc@679 118 char *uw_Basis_urlifyChannel(uw_context, uw_Basis_channel);
adamc@120 119
adamc@425 120 uw_unit uw_Basis_urlifyInt_w(uw_context, uw_Basis_int);
adamc@425 121 uw_unit uw_Basis_urlifyFloat_w(uw_context, uw_Basis_float);
adamc@425 122 uw_unit uw_Basis_urlifyString_w(uw_context, uw_Basis_string);
adamc@425 123 uw_unit uw_Basis_urlifyBool_w(uw_context, uw_Basis_bool);
adamc@679 124 uw_unit uw_Basis_urlifyChannel_w(uw_context, uw_Basis_channel);
adamc@120 125
adamc@1109 126 uw_Basis_unit uw_Basis_unurlifyUnit(uw_context ctx, char **s);
adamc@311 127 uw_Basis_int uw_Basis_unurlifyInt(uw_context, char **);
adamc@311 128 uw_Basis_float uw_Basis_unurlifyFloat(uw_context, char **);
adamc@311 129 uw_Basis_string uw_Basis_unurlifyString(uw_context, char **);
adamc@1023 130 uw_Basis_string uw_Basis_unurlifyString_fromClient(uw_context, char **);
adamc@311 131 uw_Basis_bool uw_Basis_unurlifyBool(uw_context, char **);
adamc@488 132 uw_Basis_time uw_Basis_unurlifyTime(uw_context, char **);
adamc@180 133
adamc@828 134 uw_Basis_int uw_Basis_strlen(uw_context, const char *);
adamc@821 135 uw_Basis_char uw_Basis_strsub(uw_context, const char *, uw_Basis_int);
adamc@821 136 uw_Basis_string uw_Basis_strsuffix(uw_context, const char *, uw_Basis_int);
adamc@648 137 uw_Basis_string uw_Basis_strcat(uw_context, const char *, const char *);
adamc@922 138 uw_Basis_string uw_Basis_mstrcat(uw_context ctx, ...);
adamc@829 139 uw_Basis_int *uw_Basis_strindex(uw_context, const char *, uw_Basis_char);
adamc@829 140 uw_Basis_string uw_Basis_strchr(uw_context, const char *, uw_Basis_char);
adamc@831 141 uw_Basis_int uw_Basis_strcspn(uw_context, const char *, const char *);
adamc@829 142 uw_Basis_string uw_Basis_substring(uw_context, const char *, uw_Basis_int, uw_Basis_int);
adamc@1023 143 uw_Basis_string uw_Basis_str1(uw_context, uw_Basis_char);
adamc@829 144
adamc@737 145 uw_Basis_string uw_strdup(uw_context, const char *);
adamc@737 146 uw_Basis_string uw_maybe_strdup(uw_context, const char *);
adamc@742 147 char *uw_memdup(uw_context, const char *, size_t);
adamc@280 148
adamc@311 149 uw_Basis_string uw_Basis_sqlifyInt(uw_context, uw_Basis_int);
adamc@311 150 uw_Basis_string uw_Basis_sqlifyFloat(uw_context, uw_Basis_float);
adamc@311 151 uw_Basis_string uw_Basis_sqlifyString(uw_context, uw_Basis_string);
adamc@1011 152 uw_Basis_string uw_Basis_sqlifyChar(uw_context, uw_Basis_char);
adamc@311 153 uw_Basis_string uw_Basis_sqlifyBool(uw_context, uw_Basis_bool);
adamc@439 154 uw_Basis_string uw_Basis_sqlifyTime(uw_context, uw_Basis_time);
adamc@737 155 uw_Basis_string uw_Basis_sqlifyBlob(uw_context, uw_Basis_blob);
adamc@678 156 uw_Basis_string uw_Basis_sqlifyChannel(uw_context, uw_Basis_channel);
adamc@682 157 uw_Basis_string uw_Basis_sqlifyClient(uw_context, uw_Basis_client);
adamc@282 158
adamc@467 159 uw_Basis_string uw_Basis_sqlifyIntN(uw_context, uw_Basis_int*);
adamc@467 160 uw_Basis_string uw_Basis_sqlifyFloatN(uw_context, uw_Basis_float*);
adamc@467 161 uw_Basis_string uw_Basis_sqlifyStringN(uw_context, uw_Basis_string);
adamc@467 162 uw_Basis_string uw_Basis_sqlifyBoolN(uw_context, uw_Basis_bool*);
adamc@467 163 uw_Basis_string uw_Basis_sqlifyTimeN(uw_context, uw_Basis_time*);
adamc@467 164
adamc@311 165 char *uw_Basis_ensqlBool(uw_Basis_bool);
adamc@284 166
adamc@566 167 char *uw_Basis_jsifyString(uw_context, uw_Basis_string);
adamc@1025 168 char *uw_Basis_jsifyChar(uw_context, uw_Basis_char);
adamc@682 169 char *uw_Basis_jsifyChannel(uw_context, uw_Basis_channel);
adamc@566 170
adamc@311 171 uw_Basis_string uw_Basis_intToString(uw_context, uw_Basis_int);
adamc@311 172 uw_Basis_string uw_Basis_floatToString(uw_context, uw_Basis_float);
adamc@821 173 uw_Basis_string uw_Basis_charToString(uw_context, uw_Basis_char);
adamc@311 174 uw_Basis_string uw_Basis_boolToString(uw_context, uw_Basis_bool);
adamc@436 175 uw_Basis_string uw_Basis_timeToString(uw_context, uw_Basis_time);
adamc@288 176
adamc@311 177 uw_Basis_int *uw_Basis_stringToInt(uw_context, uw_Basis_string);
adamc@311 178 uw_Basis_float *uw_Basis_stringToFloat(uw_context, uw_Basis_string);
adamc@821 179 uw_Basis_char *uw_Basis_stringToChar(uw_context, uw_Basis_string);
adamc@311 180 uw_Basis_bool *uw_Basis_stringToBool(uw_context, uw_Basis_string);
adamc@887 181 uw_Basis_time *uw_Basis_stringToTime(uw_context, const char *);
adamc@292 182
adamc@311 183 uw_Basis_int uw_Basis_stringToInt_error(uw_context, uw_Basis_string);
adamc@311 184 uw_Basis_float uw_Basis_stringToFloat_error(uw_context, uw_Basis_string);
adamc@821 185 uw_Basis_char uw_Basis_stringToChar_error(uw_context, uw_Basis_string);
adamc@311 186 uw_Basis_bool uw_Basis_stringToBool_error(uw_context, uw_Basis_string);
adamc@887 187 uw_Basis_time uw_Basis_stringToTime_error(uw_context, const char *);
adamc@742 188 uw_Basis_blob uw_Basis_stringToBlob_error(uw_context, uw_Basis_string, size_t);
adamc@678 189 uw_Basis_channel uw_Basis_stringToChannel_error(uw_context, uw_Basis_string);
adamc@682 190 uw_Basis_client uw_Basis_stringToClient_error(uw_context, uw_Basis_string);
adamc@457 191
adamc@939 192 uw_Basis_time uw_Basis_unsqlTime(uw_context, uw_Basis_string);
adamc@939 193
adamc@457 194 uw_Basis_string uw_Basis_requestHeader(uw_context, uw_Basis_string);
adamc@462 195
adamc@462 196 void uw_write_header(uw_context, uw_Basis_string);
adamc@1110 197 void uw_clear_headers(uw_context);
adamc@463 198
adamc@466 199 uw_Basis_string uw_Basis_get_cookie(uw_context, uw_Basis_string c);
adamc@1050 200 uw_unit uw_Basis_set_cookie(uw_context, uw_Basis_string prefix, uw_Basis_string c, uw_Basis_string v, uw_Basis_time *expires, uw_Basis_bool secure);
adamc@1050 201 uw_unit uw_Basis_clear_cookie(uw_context, uw_Basis_string prefix, uw_Basis_string c);
adamc@668 202
adamc@668 203 uw_Basis_channel uw_Basis_new_channel(uw_context, uw_unit);
adamc@668 204 uw_unit uw_Basis_send(uw_context, uw_Basis_channel, uw_Basis_string);
adamc@682 205
adamc@772 206 uw_Basis_client uw_Basis_self(uw_context);
adamc@717 207
adamc@717 208 uw_Basis_string uw_Basis_bless(uw_context, uw_Basis_string);
adamc@741 209 uw_Basis_string uw_Basis_blessMime(uw_context, uw_Basis_string);
adamc@734 210
adamc@770 211 uw_Basis_string uw_Basis_checkUrl(uw_context, uw_Basis_string);
adamc@770 212 uw_Basis_string uw_Basis_checkMime(uw_context, uw_Basis_string);
adamc@770 213
adamc@734 214 uw_Basis_string uw_unnull(uw_Basis_string);
adamc@734 215 uw_Basis_string uw_Basis_makeSigString(uw_context, uw_Basis_string);
adamc@734 216 uw_Basis_string uw_Basis_sigString(uw_context, uw_unit);
adamc@737 217
adamc@737 218 uw_Basis_string uw_Basis_fileName(uw_context, uw_Basis_file);
adamc@740 219 uw_Basis_string uw_Basis_fileMimeType(uw_context, uw_Basis_file);
adamc@737 220 uw_Basis_blob uw_Basis_fileData(uw_context, uw_Basis_file);
adamc@745 221 uw_Basis_int uw_Basis_blobSize(uw_context, uw_Basis_blob);
adamc@1119 222 uw_Basis_blob uw_Basis_textBlob(uw_context, uw_Basis_string);
adamc@739 223
adamc@741 224 __attribute__((noreturn)) void uw_return_blob(uw_context, uw_Basis_blob, uw_Basis_string mimeType);
adamc@1065 225 __attribute__((noreturn)) void uw_redirect(uw_context, uw_Basis_string url);
adamc@764 226
adamc@1006 227 uw_Basis_time uw_Basis_now(uw_context);
adamc@1138 228 uw_Basis_time uw_Basis_minusSeconds(uw_context, uw_Basis_time, uw_Basis_int);
adamc@1050 229 extern const uw_Basis_time uw_Basis_minTime;
adamc@1006 230
adamc@771 231 void uw_register_transactional(uw_context, void *data, uw_callback commit, uw_callback rollback, uw_callback free);
adamc@771 232
adamc@832 233 void uw_check_heap(uw_context, size_t extra);
adamc@832 234 char *uw_heap_front(uw_context);
adamc@832 235 void uw_set_heap_front(uw_context, char*);
adamc@832 236
adamc@874 237 uw_Basis_string uw_Basis_unAs(uw_context, uw_Basis_string);
adamc@874 238
adamc@879 239 extern char *uw_sqlfmtInt;
adamc@879 240 extern char *uw_sqlfmtFloat;
adamc@879 241 extern int uw_Estrings;
adamc@879 242 extern char *uw_sqlsuffixString;
adamc@1011 243 extern char *uw_sqlsuffixChar;
adamc@879 244 extern char *uw_sqlsuffixBlob;
adamc@879 245 extern char *uw_sqlfmtUint4;
adamc@879 246
adamc@1061 247 void *uw_get_global(uw_context, char *name);
adamc@1085 248 void uw_set_global(uw_context, char *name, void *data, uw_callback free);
adamc@1061 249
adamc@1061 250 uw_Basis_bool uw_Basis_isalnum(uw_context, uw_Basis_char);
adamc@1061 251 uw_Basis_bool uw_Basis_isalpha(uw_context, uw_Basis_char);
adamc@1061 252 uw_Basis_bool uw_Basis_isblank(uw_context, uw_Basis_char);
adamc@1061 253 uw_Basis_bool uw_Basis_iscntrl(uw_context, uw_Basis_char);
adamc@1061 254 uw_Basis_bool uw_Basis_isdigit(uw_context, uw_Basis_char);
adamc@1061 255 uw_Basis_bool uw_Basis_isgraph(uw_context, uw_Basis_char);
adamc@1061 256 uw_Basis_bool uw_Basis_islower(uw_context, uw_Basis_char);
adamc@1061 257 uw_Basis_bool uw_Basis_isprint(uw_context, uw_Basis_char);
adamc@1061 258 uw_Basis_bool uw_Basis_ispunct(uw_context, uw_Basis_char);
adamc@1061 259 uw_Basis_bool uw_Basis_isspace(uw_context, uw_Basis_char);
adamc@1061 260 uw_Basis_bool uw_Basis_isupper(uw_context, uw_Basis_char);
adamc@1061 261 uw_Basis_bool uw_Basis_isxdigit(uw_context, uw_Basis_char);
adamc@1061 262 uw_Basis_char uw_Basis_tolower(uw_context, uw_Basis_char);
adamc@1061 263 uw_Basis_char uw_Basis_toupper(uw_context, uw_Basis_char);
adamc@1061 264
adamc@1128 265 uw_Basis_int uw_Basis_ord(uw_context, uw_Basis_char);
adamc@1128 266 uw_Basis_char uw_Basis_chr(uw_context, uw_Basis_int);
adamc@1128 267
adamc@1066 268 uw_Basis_string uw_Basis_currentUrl(uw_context);
adamc@1066 269 void uw_set_currentUrl(uw_context, char *);
adamc@1066 270
adamc@1113 271 extern size_t uw_messages_max, uw_clients_max, uw_headers_max, uw_page_max, uw_heap_max, uw_script_max;
adamc@1113 272 extern size_t uw_inputs_max, uw_cleanup_max, uw_subinputs_max, uw_deltas_max, uw_transactionals_max, uw_globals_max;
adamc@1113 273
adamc@1115 274 extern size_t uw_database_max;
adamc@1115 275
adamc@1114 276 extern int uw_time;
adamc@1114 277
adamc@1114 278 void uw_set_deadline(uw_context, int);
adamc@1114 279 void uw_check_deadline(uw_context);
adamc@1114 280
adamc@1120 281 uw_Basis_unit uw_Basis_debug(uw_context, uw_Basis_string);
adamc@1120 282
adamc@1121 283 void uw_set_client_data(uw_context, void *);
adamc@1121 284
adamc@1250 285 uw_Basis_int uw_Basis_rand(uw_context);
adamc@1250 286
adamc@764 287 #endif