annotate include/urweb.h @ 1094:db52c32dbe42

All three current protocols work with move to using uw_app
author Adam Chlipala <adamc@hcoop.net>
date Sun, 27 Dec 2009 10:37:24 -0500
parents ae885ad70d83
children 631a3597c065
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@1094 24 void uw_set_app(uw_context, uw_app*);
adamc@311 25 void uw_set_db(uw_context, void*);
adamc@311 26 void *uw_get_db(uw_context);
adamc@311 27 void uw_free(uw_context);
adamc@311 28 void uw_reset(uw_context);
adamc@311 29 void uw_reset_keep_request(uw_context);
adamc@311 30 void uw_reset_keep_error_message(uw_context);
adamc@1094 31 const char *uw_get_url_prefix(uw_context);
adamc@272 32
adamc@311 33 failure_kind uw_begin_init(uw_context);
adamc@856 34 void uw_set_on_success(char *);
adamc@854 35 void uw_set_headers(uw_context, char *(*get_header)(void *, const char *), void *get_header_data);
adamc@458 36 failure_kind uw_begin(uw_context, char *path);
adamc@682 37 void uw_login(uw_context);
adamc@671 38 void uw_commit(uw_context);
adamc@671 39 int uw_rollback(uw_context);
adamc@167 40
adamc@311 41 __attribute__((noreturn)) void uw_error(uw_context, failure_kind, const char *fmt, ...);
adamc@311 42 char *uw_error_message(uw_context);
adamc@425 43 void uw_push_cleanup(uw_context, void (*func)(void *), void *arg);
adamc@425 44 void uw_pop_cleanup(uw_context);
adamc@167 45
adamc@311 46 void *uw_malloc(uw_context, size_t);
adamc@323 47 void uw_begin_region(uw_context);
adamc@323 48 void uw_end_region(uw_context);
adamc@324 49 void uw_memstats(uw_context);
adamc@323 50
adamc@311 51 int uw_send(uw_context, int sock);
adamc@856 52 int uw_print(uw_context, int fd);
adamc@863 53 int uw_output(uw_context ctx, int (*output)(void *data, const char *buf, size_t len), void *data);
adamc@117 54
adamc@801 55 int uw_set_input(uw_context, const char *name, char *value);
adamc@801 56 int uw_set_file_input(uw_context, char *name, uw_Basis_file);
adamc@756 57
adamc@311 58 char *uw_get_input(uw_context, int name);
adamc@311 59 char *uw_get_optional_input(uw_context, int name);
adamc@739 60 uw_Basis_file uw_get_file_input(uw_context, int name);
adamc@756 61 void uw_enter_subform(uw_context, int name);
adamc@756 62 void uw_leave_subform(uw_context);
adamc@759 63 int uw_enter_subforms(uw_context, int name);
adamc@759 64 int uw_next_entry(uw_context);
adamc@737 65
adamc@311 66 void uw_write(uw_context, const char*);
adamc@106 67
adamc@577 68 uw_Basis_int uw_Basis_new_client_source(uw_context, uw_Basis_string);
adamc@577 69 uw_unit uw_Basis_set_client_source(uw_context, uw_Basis_int, uw_Basis_string);
adamc@577 70
adamc@643 71 void uw_set_script_header(uw_context, const char*);
adamc@694 72 const char *uw_Basis_get_settings(uw_context, uw_unit);
adamc@645 73 const char *uw_Basis_get_script(uw_context, uw_unit);
adamc@562 74
adamc@695 75 uw_Basis_string uw_Basis_maybe_onload(uw_context, uw_Basis_string);
adamc@1042 76 uw_Basis_string uw_Basis_maybe_onunload(uw_context, uw_Basis_string);
adamc@695 77
adamc@693 78 void uw_set_needs_push(uw_context, int);
adamc@736 79 void uw_set_needs_sig(uw_context, int);
adamc@693 80
adamc@311 81 char *uw_Basis_htmlifyInt(uw_context, uw_Basis_int);
adamc@311 82 char *uw_Basis_htmlifyFloat(uw_context, uw_Basis_float);
adamc@311 83 char *uw_Basis_htmlifyString(uw_context, uw_Basis_string);
adamc@311 84 char *uw_Basis_htmlifyBool(uw_context, uw_Basis_bool);
adamc@436 85 char *uw_Basis_htmlifyTime(uw_context, uw_Basis_time);
adamc@120 86
adamc@425 87 uw_unit uw_Basis_htmlifyInt_w(uw_context, uw_Basis_int);
adamc@425 88 uw_unit uw_Basis_htmlifyFloat_w(uw_context, uw_Basis_float);
adamc@425 89 uw_unit uw_Basis_htmlifyString_w(uw_context, uw_Basis_string);
adamc@425 90 uw_unit uw_Basis_htmlifyBool_w(uw_context, uw_Basis_bool);
adamc@436 91 uw_unit uw_Basis_htmlifyTime_w(uw_context, uw_Basis_time);
adamc@135 92
adamc@311 93 char *uw_Basis_attrifyInt(uw_context, uw_Basis_int);
adamc@311 94 char *uw_Basis_attrifyFloat(uw_context, uw_Basis_float);
adamc@311 95 char *uw_Basis_attrifyString(uw_context, uw_Basis_string);
adamc@1011 96 char *uw_Basis_attrifyChar(uw_context, uw_Basis_char);
adamc@682 97 char *uw_Basis_attrifyTime(uw_context, uw_Basis_time);
adamc@678 98 char *uw_Basis_attrifyChannel(uw_context, uw_Basis_channel);
adamc@682 99 char *uw_Basis_attrifyClient(uw_context, uw_Basis_client);
adamc@721 100 char *uw_Basis_attrifyCss_class(uw_context, uw_Basis_css_class);
adamc@117 101
adamc@425 102 uw_unit uw_Basis_attrifyInt_w(uw_context, uw_Basis_int);
adamc@425 103 uw_unit uw_Basis_attrifyFloat_w(uw_context, uw_Basis_float);
adamc@425 104 uw_unit uw_Basis_attrifyString_w(uw_context, uw_Basis_string);
adamc@1011 105 uw_unit uw_Basis_attrifyChar_w(uw_context, uw_Basis_char);
adamc@120 106
adamc@311 107 char *uw_Basis_urlifyInt(uw_context, uw_Basis_int);
adamc@311 108 char *uw_Basis_urlifyFloat(uw_context, uw_Basis_float);
adamc@311 109 char *uw_Basis_urlifyString(uw_context, uw_Basis_string);
adamc@311 110 char *uw_Basis_urlifyBool(uw_context, uw_Basis_bool);
adamc@488 111 char *uw_Basis_urlifyTime(uw_context, uw_Basis_time);
adamc@679 112 char *uw_Basis_urlifyChannel(uw_context, uw_Basis_channel);
adamc@120 113
adamc@425 114 uw_unit uw_Basis_urlifyInt_w(uw_context, uw_Basis_int);
adamc@425 115 uw_unit uw_Basis_urlifyFloat_w(uw_context, uw_Basis_float);
adamc@425 116 uw_unit uw_Basis_urlifyString_w(uw_context, uw_Basis_string);
adamc@425 117 uw_unit uw_Basis_urlifyBool_w(uw_context, uw_Basis_bool);
adamc@679 118 uw_unit uw_Basis_urlifyChannel_w(uw_context, uw_Basis_channel);
adamc@120 119
adamc@311 120 uw_Basis_int uw_Basis_unurlifyInt(uw_context, char **);
adamc@311 121 uw_Basis_float uw_Basis_unurlifyFloat(uw_context, char **);
adamc@311 122 uw_Basis_string uw_Basis_unurlifyString(uw_context, char **);
adamc@1023 123 uw_Basis_string uw_Basis_unurlifyString_fromClient(uw_context, char **);
adamc@311 124 uw_Basis_bool uw_Basis_unurlifyBool(uw_context, char **);
adamc@488 125 uw_Basis_time uw_Basis_unurlifyTime(uw_context, char **);
adamc@180 126
adamc@828 127 uw_Basis_int uw_Basis_strlen(uw_context, const char *);
adamc@821 128 uw_Basis_char uw_Basis_strsub(uw_context, const char *, uw_Basis_int);
adamc@821 129 uw_Basis_string uw_Basis_strsuffix(uw_context, const char *, uw_Basis_int);
adamc@648 130 uw_Basis_string uw_Basis_strcat(uw_context, const char *, const char *);
adamc@922 131 uw_Basis_string uw_Basis_mstrcat(uw_context ctx, ...);
adamc@829 132 uw_Basis_int *uw_Basis_strindex(uw_context, const char *, uw_Basis_char);
adamc@829 133 uw_Basis_string uw_Basis_strchr(uw_context, const char *, uw_Basis_char);
adamc@831 134 uw_Basis_int uw_Basis_strcspn(uw_context, const char *, const char *);
adamc@829 135 uw_Basis_string uw_Basis_substring(uw_context, const char *, uw_Basis_int, uw_Basis_int);
adamc@1023 136 uw_Basis_string uw_Basis_str1(uw_context, uw_Basis_char);
adamc@829 137
adamc@737 138 uw_Basis_string uw_strdup(uw_context, const char *);
adamc@737 139 uw_Basis_string uw_maybe_strdup(uw_context, const char *);
adamc@742 140 char *uw_memdup(uw_context, const char *, size_t);
adamc@280 141
adamc@311 142 uw_Basis_string uw_Basis_sqlifyInt(uw_context, uw_Basis_int);
adamc@311 143 uw_Basis_string uw_Basis_sqlifyFloat(uw_context, uw_Basis_float);
adamc@311 144 uw_Basis_string uw_Basis_sqlifyString(uw_context, uw_Basis_string);
adamc@1011 145 uw_Basis_string uw_Basis_sqlifyChar(uw_context, uw_Basis_char);
adamc@311 146 uw_Basis_string uw_Basis_sqlifyBool(uw_context, uw_Basis_bool);
adamc@439 147 uw_Basis_string uw_Basis_sqlifyTime(uw_context, uw_Basis_time);
adamc@737 148 uw_Basis_string uw_Basis_sqlifyBlob(uw_context, uw_Basis_blob);
adamc@678 149 uw_Basis_string uw_Basis_sqlifyChannel(uw_context, uw_Basis_channel);
adamc@682 150 uw_Basis_string uw_Basis_sqlifyClient(uw_context, uw_Basis_client);
adamc@282 151
adamc@467 152 uw_Basis_string uw_Basis_sqlifyIntN(uw_context, uw_Basis_int*);
adamc@467 153 uw_Basis_string uw_Basis_sqlifyFloatN(uw_context, uw_Basis_float*);
adamc@467 154 uw_Basis_string uw_Basis_sqlifyStringN(uw_context, uw_Basis_string);
adamc@467 155 uw_Basis_string uw_Basis_sqlifyBoolN(uw_context, uw_Basis_bool*);
adamc@467 156 uw_Basis_string uw_Basis_sqlifyTimeN(uw_context, uw_Basis_time*);
adamc@467 157
adamc@311 158 char *uw_Basis_ensqlBool(uw_Basis_bool);
adamc@284 159
adamc@566 160 char *uw_Basis_jsifyString(uw_context, uw_Basis_string);
adamc@1025 161 char *uw_Basis_jsifyChar(uw_context, uw_Basis_char);
adamc@682 162 char *uw_Basis_jsifyChannel(uw_context, uw_Basis_channel);
adamc@566 163
adamc@311 164 uw_Basis_string uw_Basis_intToString(uw_context, uw_Basis_int);
adamc@311 165 uw_Basis_string uw_Basis_floatToString(uw_context, uw_Basis_float);
adamc@821 166 uw_Basis_string uw_Basis_charToString(uw_context, uw_Basis_char);
adamc@311 167 uw_Basis_string uw_Basis_boolToString(uw_context, uw_Basis_bool);
adamc@436 168 uw_Basis_string uw_Basis_timeToString(uw_context, uw_Basis_time);
adamc@288 169
adamc@311 170 uw_Basis_int *uw_Basis_stringToInt(uw_context, uw_Basis_string);
adamc@311 171 uw_Basis_float *uw_Basis_stringToFloat(uw_context, uw_Basis_string);
adamc@821 172 uw_Basis_char *uw_Basis_stringToChar(uw_context, uw_Basis_string);
adamc@311 173 uw_Basis_bool *uw_Basis_stringToBool(uw_context, uw_Basis_string);
adamc@887 174 uw_Basis_time *uw_Basis_stringToTime(uw_context, const char *);
adamc@292 175
adamc@311 176 uw_Basis_int uw_Basis_stringToInt_error(uw_context, uw_Basis_string);
adamc@311 177 uw_Basis_float uw_Basis_stringToFloat_error(uw_context, uw_Basis_string);
adamc@821 178 uw_Basis_char uw_Basis_stringToChar_error(uw_context, uw_Basis_string);
adamc@311 179 uw_Basis_bool uw_Basis_stringToBool_error(uw_context, uw_Basis_string);
adamc@887 180 uw_Basis_time uw_Basis_stringToTime_error(uw_context, const char *);
adamc@742 181 uw_Basis_blob uw_Basis_stringToBlob_error(uw_context, uw_Basis_string, size_t);
adamc@678 182 uw_Basis_channel uw_Basis_stringToChannel_error(uw_context, uw_Basis_string);
adamc@682 183 uw_Basis_client uw_Basis_stringToClient_error(uw_context, uw_Basis_string);
adamc@457 184
adamc@939 185 uw_Basis_time uw_Basis_unsqlTime(uw_context, uw_Basis_string);
adamc@939 186
adamc@457 187 uw_Basis_string uw_Basis_requestHeader(uw_context, uw_Basis_string);
adamc@462 188
adamc@462 189 void uw_write_header(uw_context, uw_Basis_string);
adamc@463 190
adamc@466 191 uw_Basis_string uw_Basis_get_cookie(uw_context, uw_Basis_string c);
adamc@1050 192 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 193 uw_unit uw_Basis_clear_cookie(uw_context, uw_Basis_string prefix, uw_Basis_string c);
adamc@668 194
adamc@668 195 uw_Basis_channel uw_Basis_new_channel(uw_context, uw_unit);
adamc@668 196 uw_unit uw_Basis_send(uw_context, uw_Basis_channel, uw_Basis_string);
adamc@682 197
adamc@772 198 uw_Basis_client uw_Basis_self(uw_context);
adamc@717 199
adamc@717 200 uw_Basis_string uw_Basis_bless(uw_context, uw_Basis_string);
adamc@741 201 uw_Basis_string uw_Basis_blessMime(uw_context, uw_Basis_string);
adamc@734 202
adamc@770 203 uw_Basis_string uw_Basis_checkUrl(uw_context, uw_Basis_string);
adamc@770 204 uw_Basis_string uw_Basis_checkMime(uw_context, uw_Basis_string);
adamc@770 205
adamc@734 206 uw_Basis_string uw_unnull(uw_Basis_string);
adamc@734 207 uw_Basis_string uw_Basis_makeSigString(uw_context, uw_Basis_string);
adamc@734 208 uw_Basis_string uw_Basis_sigString(uw_context, uw_unit);
adamc@737 209
adamc@737 210 uw_Basis_string uw_Basis_fileName(uw_context, uw_Basis_file);
adamc@740 211 uw_Basis_string uw_Basis_fileMimeType(uw_context, uw_Basis_file);
adamc@737 212 uw_Basis_blob uw_Basis_fileData(uw_context, uw_Basis_file);
adamc@745 213 uw_Basis_int uw_Basis_blobSize(uw_context, uw_Basis_blob);
adamc@739 214
adamc@741 215 __attribute__((noreturn)) void uw_return_blob(uw_context, uw_Basis_blob, uw_Basis_string mimeType);
adamc@1065 216 __attribute__((noreturn)) void uw_redirect(uw_context, uw_Basis_string url);
adamc@764 217
adamc@1006 218 uw_Basis_time uw_Basis_now(uw_context);
adamc@1050 219 extern const uw_Basis_time uw_Basis_minTime;
adamc@1006 220
adamc@771 221 void uw_register_transactional(uw_context, void *data, uw_callback commit, uw_callback rollback, uw_callback free);
adamc@771 222
adamc@832 223 void uw_check_heap(uw_context, size_t extra);
adamc@832 224 char *uw_heap_front(uw_context);
adamc@832 225 void uw_set_heap_front(uw_context, char*);
adamc@832 226
adamc@874 227 uw_Basis_string uw_Basis_unAs(uw_context, uw_Basis_string);
adamc@874 228
adamc@879 229 extern char *uw_sqlfmtInt;
adamc@879 230 extern char *uw_sqlfmtFloat;
adamc@879 231 extern int uw_Estrings;
adamc@879 232 extern char *uw_sqlsuffixString;
adamc@1011 233 extern char *uw_sqlsuffixChar;
adamc@879 234 extern char *uw_sqlsuffixBlob;
adamc@879 235 extern char *uw_sqlfmtUint4;
adamc@879 236
adamc@1061 237 void *uw_get_global(uw_context, char *name);
adamc@1085 238 void uw_set_global(uw_context, char *name, void *data, uw_callback free);
adamc@1061 239
adamc@1061 240 uw_Basis_bool uw_Basis_isalnum(uw_context, uw_Basis_char);
adamc@1061 241 uw_Basis_bool uw_Basis_isalpha(uw_context, uw_Basis_char);
adamc@1061 242 uw_Basis_bool uw_Basis_isblank(uw_context, uw_Basis_char);
adamc@1061 243 uw_Basis_bool uw_Basis_iscntrl(uw_context, uw_Basis_char);
adamc@1061 244 uw_Basis_bool uw_Basis_isdigit(uw_context, uw_Basis_char);
adamc@1061 245 uw_Basis_bool uw_Basis_isgraph(uw_context, uw_Basis_char);
adamc@1061 246 uw_Basis_bool uw_Basis_islower(uw_context, uw_Basis_char);
adamc@1061 247 uw_Basis_bool uw_Basis_isprint(uw_context, uw_Basis_char);
adamc@1061 248 uw_Basis_bool uw_Basis_ispunct(uw_context, uw_Basis_char);
adamc@1061 249 uw_Basis_bool uw_Basis_isspace(uw_context, uw_Basis_char);
adamc@1061 250 uw_Basis_bool uw_Basis_isupper(uw_context, uw_Basis_char);
adamc@1061 251 uw_Basis_bool uw_Basis_isxdigit(uw_context, uw_Basis_char);
adamc@1061 252 uw_Basis_char uw_Basis_tolower(uw_context, uw_Basis_char);
adamc@1061 253 uw_Basis_char uw_Basis_toupper(uw_context, uw_Basis_char);
adamc@1061 254
adamc@1066 255 uw_Basis_string uw_Basis_currentUrl(uw_context);
adamc@1066 256 void uw_set_currentUrl(uw_context, char *);
adamc@1066 257
adamc@764 258 #endif