Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

apreq_params.h

Go to the documentation of this file.
00001 /* ====================================================================
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 2003 The Apache Software Foundation.  All rights
00005  * reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  *
00026  * 4. The names "Apache" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written
00029  *    permission, please contact apache@apache.org.
00030  *
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  *
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  *
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation.  For more
00051  * information on the Apache Software Foundation, please see
00052  * <http://www.apache.org/>.
00053  *
00054  * Portions of this software are based upon public domain software
00055  * originally written at the National Center for Supercomputing Applications,
00056  * University of Illinois, Urbana-Champaign.
00057  */
00058 
00059 #ifndef APREQ_PARAM_H
00060 #define APREQ_PARAM_H
00061 
00062 #include "apreq.h"
00063 #include "apreq_parsers.h"
00064 
00065 #ifdef __cplusplus
00066 extern "C" {
00067 #endif /* __cplusplus */
00068 
00069 
00082 typedef struct apreq_param_t {
00083     apr_table_t         *info; 
00084     apr_bucket_brigade  *bb;   
00085     apreq_value_t        v;    
00086 } apreq_param_t;
00087 
00089 #define apreq_value_to_param(ptr) apreq_attr_to_type(apreq_param_t, v, ptr)
00090 #define apreq_param_name(p)      ((p)->v.name)
00091 #define apreq_param_value(p)     ((p)->v.data)
00092 #define apreq_param_info(p)      ((p)->info)
00093 #define apreq_param_status(p)    ((p)->v.status)
00094 #define apreq_param_brigade(p) ((p)->bb ? apreq_copy_brigade((p)->bb) : NULL)
00095 
00097 APREQ_DECLARE(apreq_param_t *) apreq_make_param(apr_pool_t *p, 
00098                                                 const char *name, 
00099                                                 const apr_size_t nlen, 
00100                                                 const char *val, 
00101                                                 const apr_size_t vlen);
00102 
00104 typedef struct apreq_request_t {
00105     apr_table_t        *args;         
00106     apr_table_t        *body;         
00107     apreq_parser_t     *parser;       
00108     apreq_cfg_t        *cfg;          
00109     void               *env;          
00110 } apreq_request_t;
00111 
00112 
00129 APREQ_DECLARE(apreq_request_t *)apreq_request(void *env, const char *qs);
00130 
00131 
00141 APREQ_DECLARE(apreq_param_t *) apreq_param(const apreq_request_t *req, 
00142                                            const char *name); 
00143 
00153 APREQ_DECLARE(apr_table_t *) apreq_params(apr_pool_t *p,
00154                                           const apreq_request_t *req);
00155 
00156 
00165 #define apreq_params_as_string(req,key,pool, mode) \
00166  apreq_join(pool, ", ", apreq_params(req,pool,key), mode)
00167 
00168 
00180 APREQ_DECLARE(apreq_param_t *) apreq_decode_param(apr_pool_t *pool, 
00181                                                   const char *word,
00182                                                   const apr_size_t nlen, 
00183                                                   const apr_size_t vlen);
00188 APREQ_DECLARE(char *) apreq_encode_param(apr_pool_t *pool, 
00189                                          const apreq_param_t *param);
00190 
00202 APREQ_DECLARE(apr_status_t) apreq_parse_query_string(apr_pool_t *pool,
00203                                                      apr_table_t *t, 
00204                                                      const char *qs);
00205 
00221 APREQ_DECLARE(apr_status_t)apreq_parse_request(apreq_request_t *req, 
00222                                                apr_bucket_brigade *bb);
00229 APREQ_DECLARE(apr_table_t *) apreq_uploads(apr_pool_t *pool,
00230                                            const apreq_request_t *req);
00231 
00237 APREQ_DECLARE(apreq_param_t *) apreq_upload(const apreq_request_t *req,
00238                                             const char *key);
00239 
00240 APREQ_DECLARE(apr_status_t) 
00241     apreq_request_config(apreq_request_t *req, 
00242                          const char *attr, apr_size_t alen,
00243                          const char *val, apr_size_t vlen);
00244 
00246 #ifdef __cplusplus
00247 }
00248 #endif
00249 
00250 
00251 #endif /* APREQ_PARAM_H */
00252 
00253 
00254 

Generated on Sat Nov 15 23:04:48 2003 for libapreq2 by doxygen1.3