Annotation of parser3/src/include/pa_common.h, revision 1.203

1.15      paf         1: /** @file
1.16      paf         2:        Parser: commonly used functions.
                      3: 
1.198     moko        4:        Copyright (c) 2001-2026 Art. Lebedev Studio (https://www.artlebedev.com)
1.192     moko        5:        Authors: Konstantin Morshnev <moko@design.ru>, Alexandr Petrosian <paf@design.ru>
1.1       paf         6: */
                      7: 
                      8: #ifndef PA_COMMON_H
                      9: #define PA_COMMON_H
1.78      paf        10: 
1.203   ! moko       11: #define IDENT_PA_COMMON_H "$Id: pa_common.h,v 1.202 2026/10/01 11:48:37 moko Exp $"
1.1       paf        12: 
1.33      paf        13: #include "pa_string.h"
1.93      paf        14: #include "pa_hash.h"
1.1       paf        15: 
1.128     misha      16: class Request;
                     17: 
1.120     misha      18: // defines
1.164     moko       19: #define HTTP_STATUS            "status"
1.140     misha      20: #define HTTP_STATUS_CAPITALIZED        "Status"
                     21: 
1.164     moko       22: #define HTTP_CONTENT_LENGTH            "content-length"
1.136     misha      23: 
1.159     moko       24: #define HTTP_CONTENT_TYPE              "content-type"
                     25: #define HTTP_CONTENT_TYPE_UPPER                "CONTENT-TYPE"
1.138     misha      26: #define HTTP_CONTENT_TYPE_CAPITALIZED  "Content-Type"
1.120     misha      27: 
1.159     moko       28: #define CONTENT_DISPOSITION            "content-disposition"
                     29: #define CONTENT_DISPOSITION_UPPER      "CONTENT-DISPOSITION"
1.138     misha      30: #define CONTENT_DISPOSITION_CAPITALIZED        "Content-Disposition"
1.164     moko       31: 
                     32: #define CONTENT_DISPOSITION_ATTACHMENT "attachment"
                     33: #define CONTENT_DISPOSITION_INLINE     "inline"
1.134     misha      34: #define CONTENT_DISPOSITION_FILENAME_NAME "filename"
                     35: 
1.164     moko       36: #define HTTP_CONTENT_TYPE_FORM_URLENCODED      "application/x-www-form-urlencoded"
                     37: #define HTTP_CONTENT_TYPE_MULTIPART_FORMDATA   "multipart/form-data"
                     38: #define HTTP_CONTENT_TYPE_MULTIPART_RELATED    "multipart/related"
                     39: #define HTTP_CONTENT_TYPE_MULTIPART_MIXED      "multipart/mixed"
                     40: 
1.193     moko       41: extern const String content_disposition_filename_name;
1.134     misha      42: 
1.132     misha      43: #define HASH_ORDER
                     44: 
                     45: #ifdef HASH_ORDER
                     46: #undef PA_HASH_CLASS
                     47: #include "pa_hash.h"
                     48: #endif
                     49: 
1.87      paf        50: class Value;
1.132     misha      51: typedef HASH_STRING<Value*> HashStringValue;
1.64      paf        52: 
1.203   ! moko       53: /// use instead of system *snprintf: zero-terminated, returns the real length (<= size-1)
1.167     moko       54: int pa_vsnprintf(char *, size_t, const char* , va_list);
                     55: int pa_snprintf(char *, size_t, const char* , ...);
1.63      paf        56: 
1.153     moko       57: #ifdef _MSC_VER
1.17      paf        58: 
1.20      paf        59: #ifndef strcasecmp
                     60: #      define strcasecmp _stricmp
                     61: #endif
1.2       paf        62: 
1.157     moko       63: #ifndef strncasecmp
                     64: #      define strncasecmp _strnicmp
                     65: #endif
                     66: 
1.17      paf        67: #endif
1.59      paf        68: 
1.17      paf        69: /**
1.154     moko       70:        String related functions
                     71: */
                     72: 
1.200     moko       73: // Under WIN32 "t" mode fixes DOS chars OK, can't say that about other systems/ line break styles
1.154     moko       74: void fix_line_breaks(char *str,        size_t& length /* < may change! used to speedup next actions */);
                     75: 
1.7       paf        76: char *getrow(char **row_ref,char delim='\n');
1.199     moko       77: 
                     78: // Return the last occurrence of any character in chars or NULL if absent
                     79: const char *strrpbrk(const char *string, const char *chars);
                     80: inline char *strrpbrk(char *string, const char *chars) {
                     81:        return (char*)strrpbrk((const char*)string, chars);
                     82: }
                     83: 
                     84: // Split at the first occurrence of delimiter; return the suffix or NULL if absent
1.76      paf        85: char *lsplit(char *string, char delim);
1.199     moko       86: // Return the prefix; advance *string_ref to the suffix or set it to NULL if delimiter is absent
                     87: char *lsplit(char **string_ref, char delim);
                     88: 
                     89: // Split at the last occurrence of delimiter(s); return the suffix or NULL if absent
1.8       paf        90: char *rsplit(char *string, char delim);
1.199     moko       91: char *rsplit(char *string, const char *delims);
1.165     moko       92: 
1.142     misha      93: char* unescape_chars(const char* cp, int len, Charset* client_charset=0, bool js=false/*true==decode \uXXXX and don't convert '+' to space*/);
1.23      paf        94: 
1.148     misha      95: char *search_stop(char*& current, char cstop_at);
                     96: 
1.157     moko       97: inline int pa_strncasecmp(const char* str, const char* substr, size_t count=0) {
                     98:        return strncasecmp(str, substr, count ? count : strlen(substr));
                     99: }
                    100: 
1.201     moko      101: // copy of the path with '/' only
                    102: char* backslashes_to_slashes(const char* path);
1.202     moko      103: // same, keeping the original languages
1.201     moko      104: const String& backslashes_to_slashes(const String& path);
1.23      paf       105: 
1.121     misha     106: size_t strpos(const char *str, const char *substr);
                    107: 
1.191     moko      108: size_t remove_crlf(char *start, char *end);
1.90      paf       109: 
1.165     moko      110: inline bool pa_isalpha(unsigned char c) { return (((c>='A') && (c<='Z')) || ((c>='a') && (c<='z'))); }
                    111: inline bool pa_isalnum(unsigned char c) { return (((c>='0') && (c<='9')) || pa_isalpha(c)); }
1.144     misha     112: 
1.201     moko      113: void pa_strncpy(char *dst, const char *src, size_t dst_size);
1.182     moko      114: char *pa_strcat(const char *a, const char *b, const char *c = 0);
                    115: 
1.165     moko      116: const char* capitalize(const char* s);
1.189     moko      117: char *str_lower(const char *s, size_t length);
                    118: char *str_upper(const char *s, size_t length);
                    119: inline char *str_lower(const char *s) { return str_lower(s, strlen(s)); }
                    120: inline char *str_upper(const char *s) { return str_upper(s, strlen(s)); }
1.144     misha     121: 
1.154     moko      122: const char* hex_string(unsigned char* bytes, size_t size, bool upcase);
1.155     moko      123: extern const char* hex_digits;
1.99      paf       124: 
1.158     moko      125: const char *pa_idna_encode(const char *in, Charset &source);
                    126: const char *pa_idna_decode(const char *in, Charset &source);
                    127: 
1.169     moko      128: unsigned long pa_crc32(const char *in, size_t in_size);
                    129: unsigned long pa_crc32(const String& file_spec);
1.93      paf       130: 
1.200     moko      131: /**
1.154     moko      132:        Mix functions
                    133: */
1.106     paf       134: 
1.164     moko      135: #define PA_DEFAULT(A,B) ((A) ? (A):(B) )
                    136: 
1.154     moko      137: Charset* detect_charset(const char* content_type);
                    138: 
1.93      paf       139: // globals
                    140: 
                    141: extern const String file_status_name;
1.1       paf       142: 
1.103     paf       143: // global defines for file options which are handled but not checked elsewhere, we check them
                    144: 
                    145: #define PA_COLUMN_SEPARATOR_NAME "separator"
                    146: #define PA_COLUMN_ENCLOSER_NAME "encloser"
1.113     misha     147: #define PA_CHARSET_NAME "charset"
1.150     moko      148: #define PA_RESPONSE_CHARSET_NAME "response-charset"
1.103     paf       149: 
1.115     misha     150: // globals defines for sql options
                    151: 
                    152: #define SQL_BIND_NAME "bind"
1.175     moko      153: #define PA_SQL_LIMIT_NAME "limit"
                    154: #define PA_SQL_OFFSET_NAME "offset"
1.115     misha     155: #define SQL_DEFAULT_NAME "default"
                    156: #define SQL_DISTINCT_NAME "distinct"
                    157: #define SQL_VALUE_TYPE_NAME "type"
                    158: 
1.175     moko      159: extern String sql_bind_name;
                    160: extern String sql_limit_name;
                    161: extern String sql_offset_name;
                    162: extern String sql_default_name;
                    163: extern String sql_distinct_name;
                    164: extern String sql_value_type_name;
                    165: 
1.115     misha     166: #ifndef DOXYGEN
                    167: enum Table2hash_distint { D_ILLEGAL, D_FIRST };
1.166     moko      168: enum Table2hash_value_type { C_HASH, C_STRING, C_TABLE, C_CODE };
1.115     misha     169: #endif
                    170: 
1.1       paf       171: #endif

E-mail: