FormEntry.h

Go to the documentation of this file.

/* -*-mode:c++; c-file-style: "gnu";-*- */
/*
 *  $Id: FormEntry_8h-source.html,v 1.3 2008/01/19 21:53:40 sebdiaz Exp $
 *
 *  Copyright (C) 1996 - 2004 Stephen F. Booth <sbooth@gnu.org>
 *                       2007 Sebastien DIAZ <sebastien.diaz@gmail.com>
 *  Part of the GNU cgicc library, http://www.gnu.org/software/cgicc
 *
 *  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 3 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110, 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"

namespace cgicc {
  
  // ============================================================
  // Class FormEntry
  // ============================================================
  
  class CGICC_API FormEntry
  {
  public:
    
    // ============================================================
    
    
    inline
    FormEntry()
    {}
    
    inline
    FormEntry(const std::string& name, 
              const std::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 std::string
    getName()                                           const
    { return fName; }
    
    inline std::string
    getValue()                                          const
    { return fValue; }
    
    inline std::string
    operator* ()                                        const
    { return getValue(); }
    
    inline std::string
    getValue(std::string::size_type maxChars)           const
    { return makeString(maxChars, true); }
    
    inline std::string
    getStrippedValue()                                  const
    { return getStrippedValue(INT_MAX); }
    
    inline std::string
    getStrippedValue(std::string::size_type maxChars)   const
    { return makeString(maxChars, false); }
    
    long
    getIntegerValue(long min = LONG_MIN, 
                    long max = LONG_MAX)                const;
    
    long
    getIntegerValue(long min, 
                    long max,
                    bool& bounded)                      const;
    
    double 
    getDoubleValue(double min = -DBL_MAX, 
                   double max = DBL_MAX)                const;
    
    double 
    getDoubleValue(double min, 
                   double max,
                   bool& bounded)                       const;
    
    
    inline std::string::size_type
    length()                                            const
    { return fValue.length(); }
    
    inline bool 
    isEmpty()                                           const
    { return (0 == length()); }
    
  private:  
    // utility function
    std::string
    makeString(std::string::size_type maxLen, 
               bool allowNewlines)                      const;
    
    std::string fName;          // the name of this form element
    std::string fValue;         // the value of this form element
  };
  
} // namespace cgicc

#endif /* ! _FORMENTRY_H_ */

---