cgicc::Cgicc

cgicc::Cgicc Class Reference

The main class of the GNU cgicc library. More...

#include <cgicc/Cgicc.h>

List of all members.

Public Member Functions

Overloaded Operators
bool operator== (const Cgicc &cgi) const
 Compare two Cgiccs for equality.
bool operator!= (const Cgicc &cgi) const
 Compare two Cgiccs for inequality.
Cgicc & operator= (const Cgicc &cgi)
 Assign one Cgicc to another.
Library Information
Information on this installation of cgicc

const char * getCompileDate () const
 Get the date on which this library was compiled.
const char * getCompileTime () const
 Get the time at which this library was compiled.
const char * getVersion () const
 Get the version number of cgicc.
const char * getHost () const
 Get the platform for which Cgicc was configured.
Form Element Access
Information on submitted form elements

bool queryCheckbox (const std::string &elementName) const
 Query whether a checkbox is checked.
form_iterator operator[] (const std::string &name)
 Find a radio button in a radio group, or a selected list item.
std::string operator() (const std::string &name) const
 Find a radio button in a radio group, or a selected list item.
const_form_iterator operator[] (const std::string &name) const
 Find a radio button in a radio group, or a selected list item.
form_iterator getElement (const std::string &name)
 Find a radio button in a radio group, or a selected list item.
const_form_iterator getElement (const std::string &name) const
 Find a radio button in a radio group, or a selected list item.
bool getElement (const std::string &name, std::vector< FormEntry > &result) const
 Find multiple checkboxes in a group or selected items in a list.
form_iterator getElementByValue (const std::string &value)
 Find a radio button in a radio group, or a selected list item.
const_form_iterator getElementByValue (const std::string &value) const
 Find a radio button in a radio group, or a selected list item.
bool getElementByValue (const std::string &value, std::vector< FormEntry > &result) const
 Find multiple checkboxes in a group or selected items in a list.
const std::vector< FormEntry > & operator * () const
 Get all the submitted form entries, excluding files.
const std::vector< FormEntry > & getElements () const
 Get all the submitted form elements, excluding files.
Uploaded File Access
file_iterator getFile (const std::string &name)
 Find an uploaded file.
const_file_iterator getFile (const std::string &name) const
 Find an uploaded file.
const std::vector< FormFile > & getFiles () const
Environment Access
const CgiEnvironment & getEnvironment () const
Save and Restore
void save (const std::string &filename) const
 Save the current CGI environment to a file.
void restore (const std::string &filename)
 Restore from a previously-saved CGI environment.

Detailed Description

The main class of the GNU cgicc library.

Cgicc is used to retrieve information on specific HTML form elements (such as checkboxes, radio buttons, and text fields), on uploaded files, and to save, restore, and retrieve information on the CGI environment.

Normally, you will instantiate an object of this type in main(): 

 int
 main(int argc, char **argv) {
   try {
     cgicc::Cgicc cgi;
     // do something with cgi
   }

   catch(const exception& e) {
    //handle the error
   }
 }

Definition at line 103 of file Cgicc.h.

Constructor & Destructor Documentation

cgicc::Cgicc::Cgicc ( CgiInput *  input = 0  ) 

Constructor.

If you are using cgicc with FastCGI, you will need to pass a CgiInput subclass that cgicc will use to read input. If input is omitted, standard input and environment variables will be used.

Parameters:
input A CgiInput object to use for reading input

cgicc::Cgicc::Cgicc ( const Cgicc &  cgi  )  [inline]

Copy constructor.

Sets the values of this Cgicc to those of cgi.

Parameters:
env The Cgicc to copy.

Definition at line 129 of file Cgicc.h.

cgicc::Cgicc::~Cgicc (  ) 

Destructor.

Delete this Cgicc object

cgicc::Cgicc::Cgicc ( CgiInput *  input = 0  ) 

Constructor.

If you are using cgicc with FastCGI, you will need to pass a CgiInput subclass that cgicc will use to read input. If input is omitted, standard input and environment variables will be used.

Parameters:
input A CgiInput object to use for reading input

cgicc::Cgicc::Cgicc ( const Cgicc &  cgi  )  [inline]

Copy constructor.

Sets the values of this Cgicc to those of cgi.

Parameters:
env The Cgicc to copy.

Definition at line 129 of file Cgicc.h.

cgicc::Cgicc::~Cgicc (  ) 

Destructor.

Delete this Cgicc object

Member Function Documentation

bool cgicc::Cgicc::operator== ( const Cgicc &  cgi  )  const [inline]

Compare two Cgiccs for equality.

Cgiccs are equal if they represent the same environment.

Parameters:
cgi The Cgicc to compare to this one.
Returns:
true if the two Cgiccs are equal, false otherwise.

Definition at line 154 of file Cgicc.h.

References fEnvironment.

bool cgicc::Cgicc::operator!= ( const Cgicc &  cgi  )  const [inline]

Compare two Cgiccs for inequality.

Cgiccs are equal if they represent the same environment.

Parameters:
cgi The Cgicc to compare to this one.
Returns:
false if the two Cgiccs are equal, true otherwise.

Definition at line 165 of file Cgicc.h.

Cgicc& cgicc::Cgicc::operator= ( const Cgicc &  cgi  ) 

Assign one Cgicc to another.

Sets the environment in this Cgicc to that of cgi.

Parameters:
cgi The Cgicc to copy.
Returns:
A reference to this.

const char* cgicc::Cgicc::getCompileDate (  )  const

Get the date on which this library was compiled.

This is a string of the form mmm dd yyyy.

Returns:
The compile date

Referenced by main().

const char* cgicc::Cgicc::getCompileTime (  )  const

Get the time at which this library was compiled.

This is a string of the form hh:mm:ss in 24-hour time.

Returns:
The compile time

Referenced by main().

const char* cgicc::Cgicc::getVersion (  )  const

Get the version number of cgicc.

The version number is a string of the form #.#.

Returns:
The version number

Referenced by main().

const char* cgicc::Cgicc::getHost (  )  const

Get the platform for which Cgicc was configured.

The host is a string of the form processor-manufacturer-os return The host triplet.

Referenced by main().

bool cgicc::Cgicc::queryCheckbox ( const std::string &  elementName  )  const

Query whether a checkbox is checked.

Parameters:
elementName The name of the element to query
Returns:
true if the desired checkbox was checked, false if not

Referenced by main(), and showForm().

form_iterator cgicc::Cgicc::operator[] ( const std::string &  name  )  [inline]

Find a radio button in a radio group, or a selected list item.

Parameters:
name The name of the radio button or list item to find.
Returns:
An iterator referring to the desired element, if found.

Definition at line 253 of file Cgicc.h.

std::string cgicc::Cgicc::operator() ( const std::string &  name  )  const

Find a radio button in a radio group, or a selected list item.

Parameters:
name The name of the radio button or list item to find.
Returns:
The desired element, or an empty string if not found.

const_form_iterator cgicc::Cgicc::operator[] ( const std::string &  name  )  const [inline]

Find a radio button in a radio group, or a selected list item.

Parameters:
name The name of the radio button or list item to find.
Returns:
An iterator referring to the desired element, if found.

Definition at line 272 of file Cgicc.h.

form_iterator cgicc::Cgicc::getElement ( const std::string &  name  ) 

Find a radio button in a radio group, or a selected list item.

Parameters:
name The name of the radio button or list item to find.
Returns:
An iterator referring to the desired element, if found.

Referenced by main(), and showForm().

const_form_iterator cgicc::Cgicc::getElement ( const std::string &  name  )  const

Find a radio button in a radio group, or a selected list item.

Parameters:
name The name of the radio button or list item to find.
Returns:
A const_iterator referring to the desired element, if found.

bool cgicc::Cgicc::getElement ( const std::string &  name,
std::vector< FormEntry > &  result 
) const

Find multiple checkboxes in a group or selected items in a list.

Parameters:
name The name of the checkboxes or list to find.
result A vector to hold the result.
Returns:
true if any elements were found, false if not.

form_iterator cgicc::Cgicc::getElementByValue ( const std::string &  value  ) 

Find a radio button in a radio group, or a selected list item.

Parameters:
value The value of the radio button or list item to find.
Returns:
An iterator referring to the desired element, if found.

const_form_iterator cgicc::Cgicc::getElementByValue ( const std::string &  value  )  const

Find a radio button in a radio group, or a selected list item.

Parameters:
value The value of the radio button or list item to find.
Returns:
A const_iterator referring to the desired element, if found.

bool cgicc::Cgicc::getElementByValue ( const std::string &  value,
std::vector< FormEntry > &  result 
) const

Find multiple checkboxes in a group or selected items in a list.

Parameters:
value The value of the checkboxes or list to find.
result A vector to hold the result.
Returns:
true if any elements were found, false if not.

const std::vector<FormEntry>& cgicc::Cgicc::operator * (  )  const [inline]

Get all the submitted form entries, excluding files.

Returns:
A vector containing all the submitted elements.

Definition at line 339 of file Cgicc.h.

const std::vector<FormEntry>& cgicc::Cgicc::getElements (  )  const [inline]

Get all the submitted form elements, excluding files.

Returns:
A vector containing all the submitted elements.

Definition at line 348 of file Cgicc.h.

Referenced by dumpList(), and main().

file_iterator cgicc::Cgicc::getFile ( const std::string &  name  ) 

Find an uploaded file.

Parameters:
name The name of the file.
Returns:
An iterator referring to the desired file, if found.

Referenced by main().

const_file_iterator cgicc::Cgicc::getFile ( const std::string &  name  )  const

Find an uploaded file.

Parameters:
name The name of the file.
Returns:
An iterator referring to the desired file, if found.

const std::vector<FormFile>& cgicc::Cgicc::getFiles (  )  const [inline]

Get all uploaded files.

Returns:
A vector containing all the uploaded files.

Definition at line 380 of file Cgicc.h.

Referenced by main().

const CgiEnvironment& cgicc::Cgicc::getEnvironment (  )  const [inline]

Get the current runtime environment.

Returns:
The current CGI environment.

Definition at line 394 of file Cgicc.h.

Referenced by main(), and printForm().

void cgicc::Cgicc::save ( const std::string &  filename  )  const

Save the current CGI environment to a file.

This is useful for debugging CGI applications.

Parameters:
filename The name of the file to which to save.

Referenced by main().

void cgicc::Cgicc::restore ( const std::string &  filename  ) 

Restore from a previously-saved CGI environment.

This is useful for debugging CGI applications.

Parameters:
filename The name of the file from which to restore.

Referenced by main().

The documentation for this class was generated from the following file:
GNU cgicc - A C++ class library for writing CGI applications
Copyright © 1996 - 2004 Stephen F. Booth
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.
Documentation generated Sat Jan 19 21:16:00 2008 for cgicc by doxygen 1.5.1