Mercurial > urweb

annotate include/urweb.h @ 1085:ae885ad70d83

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