scan_urlencoded_query.h

   1 /* This software was written by Dirk Engling <erdgeist@erdgeist.org>
   2    It is considered beerware. Prost. Skol. Cheers or whatever.
   3
   4    $id$ */
   5
   6 #ifndef SCAN_URLENCODED_QUERY_H__
   7 #define SCAN_URLENCODED_QUERY_H__
   8
   9 #include <sys/types.h>
  10
  11 typedef struct {
  12   char *key;
  13   int   value;
  14 } ot_keywords;
  15
  16 typedef enum {
  17   SCAN_PATH                  = 1,
  18   SCAN_SEARCHPATH_PARAM      = 2,
  19   SCAN_SEARCHPATH_VALUE      = 4,
  20   SCAN_SEARCHPATH_TERMINATOR = 8
  21 } SCAN_SEARCHPATH_FLAG;
  22
  23 /* string     in: pointer to source
  24               out: pointer to next scan position
  25    deststring pointer to destination
  26    flags      determines, what to parse
  27    returns    number of valid converted characters in deststring
  28               or -1 for parse error
  29               or -2 for terminator found
  30 */
  31 ssize_t scan_urlencoded_query(char **string, char *deststring, SCAN_SEARCHPATH_FLAG flags);
  32
  33 /* string     in: pointer to source
  34               out: pointer to next scan position
  35    flags      determines, what to parse
  36    returns    value for matched keyword
  37               or -1 for parse error
  38               or -2 for terminator found
  39               or -3 for no keyword matched
  40  */
  41 int     scan_find_keywords(const ot_keywords *keywords, char **string, SCAN_SEARCHPATH_FLAG flags);
  42
  43 /* string     in: pointer to value of a param=value pair to skip
  44               out: pointer to next scan position on return
  45 */
  46 void    scan_urlencoded_skipvalue(char **string);
  47
  48 /* data       pointer to len chars of string
  49  len        length of chars in data to parse
  50  number     number to receive result
  51  returns    number of bytes not parsed, mostly !=0 means fail
  52  */
  53 ssize_t scan_fixed_int(char *data, size_t len, int *number);
  54
  55 #endif