---

Cgicc.h

Go to the documentation of this file.

/* -*-c++-*- */
/*
 *  $Id: Cgicc.h,v 1.11 2002/03/09 18:34:18 sbooth Exp $
 *
 *  Copyright (C) 1996 - 2002 Stephen F. Booth
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef _CGICC_H_
#define _CGICC_H_ 1

#ifdef __GNUG__
#  pragma interface
#endif

/*
 * The GNU cgicc library, by Stephen F. Booth <sbooth@gnu.org>
 * http://www.cgicc.org
 *
 * The latest version can be found on your closest GNU mirror site.
 * Please mail bug reports to <bug-cgicc@gnu.org>
 */

#include <vector>
#include <string>

#include "cgicc/CgiDefs.h"
#include "cgicc/FormEntry.h"
#include "cgicc/FormFile.h"
#include "cgicc/CgiInput.h"
#include "cgicc/CgiEnvironment.h"

CGICC_BEGIN_NAMESPACE

#ifdef WIN32
  template class CGICC_API STDNS vector<FormEntry>;
  template class CGICC_API STDNS vector<FormFile>;
#endif
  
class MultipartHeader;

// ============================================================
// Iterator typedefs
// ============================================================

typedef STDNS vector<FormEntry>::iterator       form_iterator;
typedef STDNS vector<FormEntry>::const_iterator const_form_iterator;

typedef STDNS vector<FormFile>::iterator        file_iterator;
typedef STDNS vector<FormFile>::const_iterator  const_file_iterator;

// ============================================================
// Class Cgicc
// ============================================================

class CGICC_API Cgicc {
public:

  // ============================================================


  Cgicc(CgiInput *input = 0);
  
  ~Cgicc();
  
  // ============================================================


  const char*
  getCompileDate()                                      const;
  
  const char*
  getCompileTime()                                      const;
  
  const char*
  getVersion()                                          const;

  const char*
  getHost()                                             const;
  
  // ============================================================


  bool 
  queryCheckbox(const STDNS string& elementName)        const;
  
  inline form_iterator 
  operator[] (const STDNS string& name)
    { return getElement(name); }

  inline const_form_iterator 
  operator[] (const STDNS string& name)                 const
    { return getElement(name); }
  
  form_iterator 
  getElement(const STDNS string& name);
  
  const_form_iterator 
  getElement(const STDNS string& name)                  const;
  
  bool 
  getElement(const STDNS string& name,
             STDNS vector<FormEntry>& result)           const;

  form_iterator 
  getElementByValue(const STDNS string& value);
  
  const_form_iterator 
  getElementByValue(const STDNS string& value)          const;
  
  bool 
  getElementByValue(const STDNS string& value,
                    STDNS vector<FormEntry>& result)    const;

  inline const STDNS vector<FormEntry>& 
  operator* ()                                          const
    { return fFormData; }
  
  inline const STDNS vector<FormEntry>&
  getElements()                                         const
    { return fFormData; }

  // ============================================================


  file_iterator 
  getFile(const STDNS string& name);
  
  const_file_iterator 
  getFile(const STDNS string& name)                     const;

  inline const STDNS vector<FormFile>&
  getFiles()                                            const
    { return fFormFiles; }
  
  // ============================================================


  inline const CgiEnvironment&
  getEnvironment()                                      const
    { return fEnvironment;}
  
  // ============================================================

  
  void 
  save(const STDNS string& filename)                    const;
  
  void 
  restore(const STDNS string& filename);
  
private:
  CgiEnvironment                fEnvironment;
  STDNS vector<FormEntry>       fFormData;
  STDNS vector<FormFile>        fFormFiles;
  
  // Convert query string into a list of FormEntries
  void 
  parseFormInput(const STDNS string& data);
  
  // Parse a multipart/form-data header
  MultipartHeader
  parseHeader(const STDNS string& data);
  
  // Parse a (name=value) form entry
  void 
  parsePair(const STDNS string& data);
  
  // Parse a MIME entry for ENCTYPE=""
  void
  parseMIME(const STDNS string& data);

  // Find elements in the list of entries
  bool 
  findEntries(const STDNS string& param, 
              bool byName,
              STDNS vector<FormEntry>& result)          const;
};

CGICC_END_NAMESPACE

#endif /* ! _CGICC_H_ */

---