annotate include/urweb.h @ 1080:a4979e31e4bf

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