<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> <html lang="en" dir="LTR"> <head> <!-- $Id: header.html,v 1.5 2004/06/12 01:58:25 sbooth Exp $ --> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <title>cgicc: Cgicc.h Source File</title> <link rev="made" href="mailto:bug-cgicc@gnu.org" /> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="cgicc-doc.css" rel="stylesheet" type="text/css" /> </head> <body> <!-- Generated by Doxygen 1.5.9 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <h1>Cgicc.h</h1><a href="Cgicc_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*-mode:c++; c-file-style: "gnu";-*- */</span> <a name="l00002"></a>00002 <span class="comment">/*</span> <a name="l00003"></a>00003 <span class="comment"> * $Id: Cgicc.h,v 1.19 2009/01/03 17:12:07 sebdiaz Exp $</span> <a name="l00004"></a>00004 <span class="comment"> *</span> <a name="l00005"></a>00005 <span class="comment"> * Copyright (C) 1996 - 2004 Stephen F. Booth <sbooth@gnu.org></span> <a name="l00006"></a>00006 <span class="comment"> * 2007 Sebastien DIAZ <sebastien.diaz@gmail.com></span> <a name="l00007"></a>00007 <span class="comment"> * Part of the GNU cgicc library, http://www.gnu.org/software/cgicc</span> <a name="l00008"></a>00008 <span class="comment"> *</span> <a name="l00009"></a>00009 <span class="comment"> * This library is free software; you can redistribute it and/or</span> <a name="l00010"></a>00010 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span> <a name="l00011"></a>00011 <span class="comment"> * License as published by the Free Software Foundation; either</span> <a name="l00012"></a>00012 <span class="comment"> * version 3 of the License, or (at your option) any later version.</span> <a name="l00013"></a>00013 <span class="comment"> *</span> <a name="l00014"></a>00014 <span class="comment"> * This library is distributed in the hope that it will be useful,</span> <a name="l00015"></a>00015 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00016"></a>00016 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span> <a name="l00017"></a>00017 <span class="comment"> * Lesser General Public License for more details.</span> <a name="l00018"></a>00018 <span class="comment"> *</span> <a name="l00019"></a>00019 <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span> <a name="l00020"></a>00020 <span class="comment"> * License along with this library; if not, write to the Free Software</span> <a name="l00021"></a>00021 <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA</span> <a name="l00022"></a>00022 <span class="comment"> */</span> <a name="l00023"></a>00023 <a name="l00024"></a>00024 <span class="preprocessor">#ifndef _CGICC_H_</span> <a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define _CGICC_H_ 1</span> <a name="l00026"></a>00026 <span class="preprocessor"></span> <a name="l00027"></a>00027 <span class="preprocessor">#ifdef __GNUG__</span> <a name="l00028"></a>00028 <span class="preprocessor"></span><span class="preprocessor"># pragma interface</span> <a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#endif</span> <a name="l00030"></a>00030 <span class="preprocessor"></span> <a name="l00035"></a>00035 <span class="comment">/*</span> <a name="l00036"></a>00036 <span class="comment"> * The GNU cgicc library, by Stephen F. Booth <sbooth@gnu.org></span> <a name="l00037"></a>00037 <span class="comment"> * http://www.cgicc.org</span> <a name="l00038"></a>00038 <span class="comment"> *</span> <a name="l00039"></a>00039 <span class="comment"> * The latest version can be found on your closest GNU mirror site.</span> <a name="l00040"></a>00040 <span class="comment"> * Please mail bug reports to <bug-cgicc@gnu.org></span> <a name="l00041"></a>00041 <span class="comment"> */</span> <a name="l00042"></a>00042 <a name="l00043"></a>00043 <span class="preprocessor">#include <vector></span> <a name="l00044"></a>00044 <span class="preprocessor">#include <string></span> <a name="l00045"></a>00045 <a name="l00046"></a>00046 <span class="preprocessor">#include "<a class="code" href="CgiDefs_8h.html" title="Platform and operating system specific macro definitions.">cgicc/CgiDefs.h</a>"</span> <a name="l00047"></a>00047 <span class="preprocessor">#include "<a class="code" href="FormEntry_8h.html" title="Class representing a single HTML form entry.">cgicc/FormEntry.h</a>"</span> <a name="l00048"></a>00048 <span class="preprocessor">#include "<a class="code" href="FormFile_8h.html" title="Class representing a file submitted via an HTML form.">cgicc/FormFile.h</a>"</span> <a name="l00049"></a>00049 <span class="preprocessor">#include "<a class="code" href="CgiInput_8h.html" title="Class that abstracts a data source.">cgicc/CgiInput.h</a>"</span> <a name="l00050"></a>00050 <span class="preprocessor">#include "<a class="code" href="CgiEnvironment_8h.html" title="Class encapsulating the CGI runtime environment.">cgicc/CgiEnvironment.h</a>"</span> <a name="l00051"></a>00051 <a name="l00052"></a><a class="code" href="namespacecgicc.html">00052</a> <span class="keyword">namespace </span>cgicc { <a name="l00053"></a>00053 <a name="l00054"></a>00054 <span class="preprocessor">#ifdef WIN32</span> <a name="l00055"></a>00055 <span class="preprocessor"></span> <span class="keyword">template</span> <span class="keyword">class </span>CGICC_API std::vector<FormEntry>; <a name="l00056"></a>00056 <span class="keyword">template</span> <span class="keyword">class </span>CGICC_API std::vector<FormFile>; <a name="l00057"></a>00057 <span class="preprocessor">#endif</span> <a name="l00058"></a>00058 <span class="preprocessor"></span> <a name="l00059"></a><a class="code" href="namespacecgicc.html#2a771be8dbb16cf3bfe01cb422dbc449">00059</a> <span class="keyword">class </span>MultipartHeader; <a name="l00060"></a>00060 <a name="l00061"></a>00061 <span class="comment">// ============================================================</span> <a name="l00062"></a>00062 <span class="comment">// Iterator typedefs</span> <a name="l00063"></a>00063 <span class="comment">// ============================================================</span> <a name="l00064"></a>00064 <a name="l00066"></a>00066 <span class="keyword">typedef</span> std::vector<FormEntry>::iterator <a class="code" href="namespacecgicc.html#2a771be8dbb16cf3bfe01cb422dbc449" title="A vector of FormEntry objects.">form_iterator</a>; <a name="l00068"></a><a class="code" href="namespacecgicc.html#ab5af84fc8730636ea852cf2eccc4a09">00068</a> <span class="keyword">typedef</span> std::vector<FormEntry>::const_iterator <a class="code" href="namespacecgicc.html#ab5af84fc8730636ea852cf2eccc4a09" title="A vector of const FormEntry objects.">const_form_iterator</a>; <a name="l00069"></a>00069 <a name="l00071"></a><a class="code" href="namespacecgicc.html#f6784762af5b1f8654eff509d6e07ee5">00071</a> <span class="keyword">typedef</span> std::vector<FormFile>::iterator <a class="code" href="namespacecgicc.html#f6784762af5b1f8654eff509d6e07ee5" title="A vector of FormFile objects.">file_iterator</a>; <a name="l00073"></a><a class="code" href="namespacecgicc.html#8b5e92290b294ee9d8801e5848154100">00073</a> <span class="keyword">typedef</span> std::vector<FormFile>::const_iterator <a class="code" href="namespacecgicc.html#8b5e92290b294ee9d8801e5848154100" title="A vector of const FormFile objects.">const_file_iterator</a>; <a name="l00074"></a>00074 <a name="l00075"></a>00075 <span class="comment">// ============================================================</span> <a name="l00076"></a>00076 <span class="comment">// Class Cgicc</span> <a name="l00077"></a>00077 <span class="comment">// ============================================================</span> <a name="l00078"></a>00078 <a name="l00103"></a><a class="code" href="classcgicc_1_1Cgicc.html">00103</a> <span class="keyword">class </span>CGICC_API <a class="code" href="classcgicc_1_1Cgicc.html" title="The main class of the GNU cgicc library.">Cgicc</a> { <a name="l00104"></a>00104 <span class="keyword">public</span>: <a name="l00105"></a>00105 <a name="l00106"></a>00106 <span class="comment">// ============================================================</span> <a name="l00107"></a>00107 <a name="l00110"></a>00110 <a name="l00120"></a>00120 <a class="code" href="classcgicc_1_1Cgicc.html" title="The main class of the GNU cgicc library.">Cgicc</a>(<a class="code" href="classcgicc_1_1CgiInput.html" title="Class that abstracts a data source.">CgiInput</a> *input = 0); <a name="l00121"></a>00121 <a name="l00128"></a>00128 <span class="keyword">inline</span> <a name="l00129"></a><a class="code" href="classcgicc_1_1Cgicc.html#1cba55f521d272a05a9de487eec1b161">00129</a> <a class="code" href="classcgicc_1_1Cgicc.html" title="The main class of the GNU cgicc library.">Cgicc</a>(<span class="keyword">const</span> <a class="code" href="classcgicc_1_1Cgicc.html" title="The main class of the GNU cgicc library.">Cgicc</a>& cgi) <a name="l00130"></a>00130 : fEnvironment(cgi.fEnvironment) <a name="l00131"></a>00131 { operator=(cgi); } <a name="l00132"></a>00132 <a name="l00138"></a>00138 ~<a class="code" href="classcgicc_1_1Cgicc.html" title="The main class of the GNU cgicc library.">Cgicc</a>(); <a name="l00140"></a>00140 <a name="l00141"></a>00141 <span class="comment">// ============================================================</span> <a name="l00142"></a>00142 <a name="l00145"></a>00145 <a name="l00153"></a>00153 <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a name="l00154"></a><a class="code" href="classcgicc_1_1Cgicc.html#e2de9cb742029800a0ddc0a4eb698dc0">00154</a> operator== (<span class="keyword">const</span> <a class="code" href="classcgicc_1_1Cgicc.html" title="The main class of the GNU cgicc library.">Cgicc</a>& cgi)<span class="keyword"> const</span> <a name="l00155"></a>00155 <span class="keyword"> </span>{ <span class="keywordflow">return</span> this->fEnvironment == cgi.fEnvironment; } <a name="l00156"></a>00156 <a name="l00164"></a>00164 <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a name="l00165"></a><a class="code" href="classcgicc_1_1Cgicc.html#55ac7ef99bcfa050c3ecaf36b647516f">00165</a> operator!= (<span class="keyword">const</span> <a class="code" href="classcgicc_1_1Cgicc.html" title="The main class of the GNU cgicc library.">Cgicc</a>& cgi)<span class="keyword"> const</span> <a name="l00166"></a>00166 <span class="keyword"> </span>{ <span class="keywordflow">return</span> ! operator==(cgi); } <a name="l00167"></a>00167 <a name="l00168"></a>00168 <span class="preprocessor">#ifdef WIN32</span> <a name="l00169"></a>00169 <span class="preprocessor"></span> <span class="comment">/* Dummy operator for MSVC++ */</span> <a name="l00170"></a>00170 <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a name="l00171"></a>00171 operator< (<span class="keyword">const</span> <a class="code" href="classcgicc_1_1Cgicc.html" title="The main class of the GNU cgicc library.">Cgicc</a>& cgi)<span class="keyword"> const</span> <a name="l00172"></a>00172 <span class="keyword"> </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; } <a name="l00173"></a>00173 <span class="preprocessor">#endif</span> <a name="l00174"></a>00174 <span class="preprocessor"></span> <a name="l00182"></a>00182 Cgicc& <a name="l00183"></a>00183 operator= (<span class="keyword">const</span> Cgicc& cgi); <a name="l00185"></a>00185 <a name="l00186"></a>00186 <span class="comment">// ============================================================</span> <a name="l00187"></a>00187 <a name="l00192"></a>00192 <a name="l00199"></a>00199 <span class="keyword">const</span> <span class="keywordtype">char</span>* <a name="l00200"></a>00200 getCompileDate() <span class="keyword">const</span>; <a name="l00201"></a>00201 <a name="l00208"></a>00208 <span class="keyword">const</span> <span class="keywordtype">char</span>* <a name="l00209"></a>00209 getCompileTime() <span class="keyword">const</span>; <a name="l00210"></a>00210 <a name="l00217"></a>00217 <span class="keyword">const</span> <span class="keywordtype">char</span>* <a name="l00218"></a>00218 getVersion() <span class="keyword">const</span>; <a name="l00219"></a>00219 <a name="l00226"></a>00226 <span class="keyword">const</span> <span class="keywordtype">char</span>* <a name="l00227"></a>00227 getHost() <span class="keyword">const</span>; <a name="l00229"></a>00229 <a name="l00230"></a>00230 <span class="comment">// ============================================================</span> <a name="l00231"></a>00231 <a name="l00236"></a>00236 <a name="l00243"></a>00243 <span class="keywordtype">bool</span> <a name="l00244"></a>00244 queryCheckbox(<span class="keyword">const</span> std::string& elementName) <span class="keyword">const</span>; <a name="l00245"></a>00245 <a name="l00252"></a>00252 <span class="keyword">inline</span> <a class="code" href="namespacecgicc.html#2a771be8dbb16cf3bfe01cb422dbc449" title="A vector of FormEntry objects.">form_iterator</a> <a name="l00253"></a><a class="code" href="classcgicc_1_1Cgicc.html#7c510bf180a5bf36ac90b8c537724b1a">00253</a> operator[] (<span class="keyword">const</span> std::string& name) <a name="l00254"></a>00254 { <span class="keywordflow">return</span> getElement(name); } <a name="l00255"></a>00255 <a name="l00262"></a>00262 std::string <a name="l00263"></a>00263 operator() (<span class="keyword">const</span> std::string& name) <span class="keyword">const</span>; <a name="l00264"></a>00264 <a name="l00271"></a>00271 <span class="keyword">inline</span> <a class="code" href="namespacecgicc.html#ab5af84fc8730636ea852cf2eccc4a09" title="A vector of const FormEntry objects.">const_form_iterator</a> <a name="l00272"></a><a class="code" href="classcgicc_1_1Cgicc.html#1e66519fbabff9208b80a437d330223a">00272</a> operator[] (<span class="keyword">const</span> std::string& name)<span class="keyword"> const</span> <a name="l00273"></a>00273 <span class="keyword"> </span>{ <span class="keywordflow">return</span> getElement(name); } <a name="l00274"></a>00274 <a name="l00281"></a>00281 <a class="code" href="namespacecgicc.html#2a771be8dbb16cf3bfe01cb422dbc449" title="A vector of FormEntry objects.">form_iterator</a> <a name="l00282"></a>00282 getElement(<span class="keyword">const</span> std::string& name); <a name="l00283"></a>00283 <a name="l00290"></a>00290 <a class="code" href="namespacecgicc.html#ab5af84fc8730636ea852cf2eccc4a09" title="A vector of const FormEntry objects.">const_form_iterator</a> <a name="l00291"></a>00291 getElement(<span class="keyword">const</span> std::string& name) <span class="keyword">const</span>; <a name="l00292"></a>00292 <a name="l00300"></a>00300 <span class="keywordtype">bool</span> <a name="l00301"></a>00301 getElement(<span class="keyword">const</span> std::string& name, <a name="l00302"></a>00302 std::vector<FormEntry>& result) <span class="keyword">const</span>; <a name="l00303"></a>00303 <a name="l00310"></a>00310 <a class="code" href="namespacecgicc.html#2a771be8dbb16cf3bfe01cb422dbc449" title="A vector of FormEntry objects.">form_iterator</a> <a name="l00311"></a>00311 getElementByValue(<span class="keyword">const</span> std::string& value); <a name="l00312"></a>00312 <a name="l00319"></a>00319 <a class="code" href="namespacecgicc.html#ab5af84fc8730636ea852cf2eccc4a09" title="A vector of const FormEntry objects.">const_form_iterator</a> <a name="l00320"></a>00320 getElementByValue(<span class="keyword">const</span> std::string& value) <span class="keyword">const</span>; <a name="l00321"></a>00321 <a name="l00329"></a>00329 <span class="keywordtype">bool</span> <a name="l00330"></a>00330 getElementByValue(<span class="keyword">const</span> std::string& value, <a name="l00331"></a>00331 std::vector<FormEntry>& result) <span class="keyword">const</span>; <a name="l00332"></a>00332 <a name="l00338"></a>00338 <span class="keyword">inline</span> <span class="keyword">const</span> std::vector<FormEntry>& <a name="l00339"></a><a class="code" href="classcgicc_1_1Cgicc.html#6bbafd3dfeab2c521d4437d541618fbf">00339</a> operator* ()<span class="keyword"> const</span> <a name="l00340"></a>00340 <span class="keyword"> </span>{ <span class="keywordflow">return</span> fFormData; } <a name="l00341"></a>00341 <a name="l00347"></a>00347 <span class="keyword">inline</span> <span class="keyword">const</span> std::vector<FormEntry>& <a name="l00348"></a><a class="code" href="classcgicc_1_1Cgicc.html#021d316e1727c9a334614796db506d14">00348</a> getElements()<span class="keyword"> const</span> <a name="l00349"></a>00349 <span class="keyword"> </span>{ <span class="keywordflow">return</span> fFormData; } <a name="l00351"></a>00351 <a name="l00352"></a>00352 <span class="comment">// ============================================================</span> <a name="l00353"></a>00353 <a name="l00356"></a>00356 <a name="l00363"></a>00363 <a class="code" href="namespacecgicc.html#f6784762af5b1f8654eff509d6e07ee5" title="A vector of FormFile objects.">file_iterator</a> <a name="l00364"></a>00364 getFile(<span class="keyword">const</span> std::string& name); <a name="l00365"></a>00365 <a name="l00372"></a>00372 <a class="code" href="namespacecgicc.html#8b5e92290b294ee9d8801e5848154100" title="A vector of const FormFile objects.">const_file_iterator</a> <a name="l00373"></a>00373 getFile(<span class="keyword">const</span> std::string& name) <span class="keyword">const</span>; <a name="l00374"></a>00374 <a name="l00379"></a>00379 <span class="keyword">inline</span> <span class="keyword">const</span> std::vector<FormFile>& <a name="l00380"></a><a class="code" href="classcgicc_1_1Cgicc.html#973695a02d64f321ab1d243425b11107">00380</a> getFiles()<span class="keyword"> const</span> <a name="l00381"></a>00381 <span class="keyword"> </span>{ <span class="keywordflow">return</span> fFormFiles; } <a name="l00383"></a>00383 <a name="l00384"></a>00384 <span class="comment">// ============================================================</span> <a name="l00385"></a>00385 <a name="l00388"></a>00388 <a name="l00393"></a>00393 <span class="keyword">inline</span> <span class="keyword">const</span> <a class="code" href="classcgicc_1_1CgiEnvironment.html" title="Class encapsulating the CGI runtime environment.">CgiEnvironment</a>& <a name="l00394"></a><a class="code" href="classcgicc_1_1Cgicc.html#61a5da400eca7803f33cddd23dca862e">00394</a> getEnvironment()<span class="keyword"> const</span> <a name="l00395"></a>00395 <span class="keyword"> </span>{ <span class="keywordflow">return</span> fEnvironment;} <a name="l00397"></a>00397 <a name="l00398"></a>00398 <span class="comment">// ============================================================</span> <a name="l00399"></a>00399 <a name="l00402"></a>00402 <a name="l00409"></a>00409 <span class="keywordtype">void</span> <a name="l00410"></a>00410 save(<span class="keyword">const</span> std::string& filename) <span class="keyword">const</span>; <a name="l00411"></a>00411 <a name="l00418"></a>00418 <span class="keywordtype">void</span> <a name="l00419"></a>00419 restore(<span class="keyword">const</span> std::string& filename); <a name="l00421"></a>00421 <a name="l00422"></a>00422 <span class="keyword">private</span>: <a name="l00423"></a>00423 <a class="code" href="classcgicc_1_1CgiEnvironment.html" title="Class encapsulating the CGI runtime environment.">CgiEnvironment</a> fEnvironment; <a name="l00424"></a>00424 std::vector<FormEntry> fFormData; <a name="l00425"></a>00425 std::vector<FormFile> fFormFiles; <a name="l00426"></a>00426 <a name="l00427"></a>00427 <span class="comment">// Convert query string into a list of FormEntries</span> <a name="l00428"></a>00428 <span class="keywordtype">void</span> <a name="l00429"></a>00429 parseFormInput(<span class="keyword">const</span> std::string& data, <span class="keyword">const</span> std::string& content_type = <span class="stringliteral">"application/x-www-form-urlencoded"</span>); <a name="l00430"></a>00430 <a name="l00431"></a>00431 <span class="comment">// Parse a multipart/form-data header</span> <a name="l00432"></a>00432 MultipartHeader <a name="l00433"></a>00433 parseHeader(<span class="keyword">const</span> std::string& data); <a name="l00434"></a>00434 <a name="l00435"></a>00435 <span class="comment">// Parse a (name=value) form entry</span> <a name="l00436"></a>00436 <span class="keywordtype">void</span> <a name="l00437"></a>00437 parsePair(<span class="keyword">const</span> std::string& data); <a name="l00438"></a>00438 <a name="l00439"></a>00439 <span class="comment">// Parse a MIME entry for ENCTYPE=""</span> <a name="l00440"></a>00440 <span class="keywordtype">void</span> <a name="l00441"></a>00441 parseMIME(<span class="keyword">const</span> std::string& data); <a name="l00442"></a>00442 <a name="l00443"></a>00443 <span class="comment">// Find elements in the list of entries</span> <a name="l00444"></a>00444 <span class="keywordtype">bool</span> <a name="l00445"></a>00445 findEntries(<span class="keyword">const</span> std::string& param, <a name="l00446"></a>00446 <span class="keywordtype">bool</span> byName, <a name="l00447"></a>00447 std::vector<FormEntry>& result) <span class="keyword">const</span>; <a name="l00448"></a>00448 }; <a name="l00449"></a>00449 <a name="l00450"></a>00450 } <span class="comment">// namespace cgicc</span> <a name="l00451"></a>00451 <a name="l00452"></a>00452 <span class="preprocessor">#endif </span><span class="comment">/* ! _CGICC_H_ */</span> </pre></div></div> <!-- $Id: footer.html,v 1.7 2004/06/12 01:58:25 sbooth Exp $ --> <hr> <address><small> <a href="http://www.cgicc.org">GNU cgicc</a> - A C++ class library for writing CGI applications<br /> Copyright © 1996 - 2004 <a href="mailto:sboothATgnuDOTorg">Stephen F. Booth</a><br /> Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front Cover Texts, and with no Back-Cover Texts.<br /> Documentation generated Tue Jun 9 15:30:16 2009 for cgicc by <a HREF="http://www.doxygen.org/index.html">doxygen</a> 1.5.9 </small></address> </body> </html>