---

FormEntry.h

Go to the documentation of this file.

/* -*-c++-*- */
/*
 *  $Id: FormEntry.h,v 1.5 2002/03/06 02:49:55 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 _FORMENTRY_H_
#define _FORMENTRY_H_ 1

#ifdef __GNUG__
#  pragma interface
#endif

#include <iostream>
#include <string>
#include <climits>
#include <cfloat>

#include "cgicc/CgiDefs.h"
#include "cgicc/CgiUtils.h"

CGICC_BEGIN_NAMESPACE

// ============================================================
// Class FormEntry
// ============================================================

class CGICC_API FormEntry
{
public:
  
  // ============================================================


  inline
  FormEntry()
    {}
  
  inline
  FormEntry(const STDNS string& name, 
            const STDNS string& value)
    : fName(name), fValue(value)
    {}
  
  inline
  FormEntry(const FormEntry& entry)
    { operator=(entry); }
  
  inline
  ~FormEntry()
    {}

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


  inline bool 
  operator== (const FormEntry& entry)                   const
    { return stringsAreEqual(fName, entry.fName); }
  
  inline bool
  operator!= (const FormEntry& entry)                   const
    { return ! operator==(entry); }

#ifdef WIN32
  /* Dummy operator for MSVC++ */
  inline bool
  operator< (const FormEntry& entry)                    const
  { return false; }
#endif

  FormEntry& 
  operator= (const FormEntry& entry);
  
  // ============================================================


  inline STDNS string
  getName()                                             const
    { return fName; }
  
  inline STDNS string
  getValue()                                            const
    { return fValue; }
  
  inline STDNS string
  operator* ()                                          const
    { return getValue(); }
  
  inline STDNS string
  getValue(STDNS string::size_type maxChars)                    const
    { return makeString(maxChars, true); }
  
  inline STDNS string
  getStrippedValue()                                    const
    { return getStrippedValue(INT_MAX); }
  
  inline STDNS string
  getStrippedValue(STDNS string::size_type maxChars)            const
    { return makeString(maxChars, false); }
  
  long
  getIntegerValue(long min = LONG_MIN, 
                  long max = LONG_MAX)                  const;
  
  double 
  getDoubleValue(double min = DBL_MIN, 
                 double max = DBL_MAX)                  const;
  
  inline STDNS string::size_type
  length()                                              const
    { return fValue.length(); }
  
  inline bool 
  isEmpty()                                             const
    { return (length() == 0); }

private:  
  // utility function
  STDNS string
  makeString(STDNS string::size_type maxLen, 
             bool allowNewlines)                        const;
  
  STDNS string fName;           // the name of this form element
  STDNS string fValue;          // the value of this form element
};

CGICC_END_NAMESPACE

#endif /* ! _FORMENTRY_H_ */

---