Fix comments, add a missing const.
[shibboleth/cpp-opensaml.git] / saml / util / CGIParser.h
1 /*
2  *  Copyright 2001-2007 Internet2
3  * 
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 /**
18  * @file shibsp/util/CGIParser.h
19  * 
20  * CGI GET/POST parameter parsing
21  */
22
23 #ifndef __saml_cgi_h__
24 #define __saml_cgi_h__
25
26 #include <saml/binding/HTTPRequest.h>
27
28 namespace opensaml {
29
30     /**
31      * CGI GET/POST parameter parsing
32      */
33     class SAML_API CGIParser
34     {
35         MAKE_NONCOPYABLE(CGIParser);
36     public:
37         /**
38          * Constructor
39          * 
40          * @param request   HTTP request interface
41          */
42         CGIParser(const HTTPRequest& request);
43
44         ~CGIParser();
45
46         /** Alias for multimap iterator. */
47         typedef std::multimap<std::string,char*>::const_iterator walker;
48         
49         /**
50          * Returns a pair of bounded iterators around the values of a parameter.
51          * 
52          * @param name  name of parameter
53          * @return  a pair of multimap iterators surrounding the matching value(s)
54          */
55         std::pair<walker,walker> getParameters(const char* name) const;
56         
57     private:
58         char* fmakeword(char stop, unsigned int *cl, const char** ppch);
59         char* makeword(char *line, char stop);
60         void plustospace(char *str);
61
62         std::multimap<std::string,char*> kvp_map;
63     };
64 };
65
66 #endif /* __saml_cgi_h__ */