xrb_characterfilter.hpp

// ///////////////////////////////////////////////////////////////////////////
// xrb_characterfilter.hpp by Victor Dods, created 2005/02/23
// ///////////////////////////////////////////////////////////////////////////
// Unless a different license was explicitly granted in writing by the
// copyright holder (Victor Dods), this software is freely distributable under
// the terms of the GNU General Public License, version 2.  Any works deriving
// from this work must also be released under the GNU GPL.  See the included
// file LICENSE for details.
// ///////////////////////////////////////////////////////////////////////////

#if !defined(_XRB_CHARACTERFILTER_HPP_)
#define _XRB_CHARACTERFILTER_HPP_

#include "xrb.hpp"

#include <string>

namespace Xrb
{

class CharacterFilter
{
public:

    enum FilterType
    {
        ALLOW = 0, 
        DENY       
    }; // end of enum FilterType

    inline CharacterFilter ()
    {
        m_filter_type = DENY;
    }
    inline CharacterFilter (
        FilterType const filter_type,
        std::string const &filter)
    {
        m_filter_type = filter_type;
        m_filter = filter;
    }
    inline ~CharacterFilter () { }

    inline FilterType GetFilterType () const
    {
        return m_filter_type;
    }
    inline std::string const &Filter () const
    {
        return m_filter;
    }
    char FilteredCharacter (char c) const;

    inline void SetFilterType (FilterType const filter_type)
    {
        m_filter_type = filter_type;
    }
    inline void SetFilter (std::string const &filter)
    {
        m_filter = filter;
    }

private:

    // indicates if the characters in the filter will be allowed or denied
    FilterType m_filter_type;
    // contains the filtered characters
    std::string m_filter;
}; // end of class CharacterFilter

// convenience defines for character filtering
#define SIGNED_INTEGER_CHARACTER_FILTER           "0123456789-"
#define SIGNED_INTEGER_CHARACTER_FILTER_TYPE      (CharacterFilter::ALLOW)
#define UNSIGNED_INTEGER_CHARACTER_FILTER         "0123456789"
#define UNSIGNED_INTEGER_CHARACTER_FILTER_TYPE    (CharacterFilter::ALLOW)
#define DECIMAL_NOTATION_CHARACTER_FILTER         "0123456789-."
#define DECIMAL_NOTATION_CHARACTER_FILTER_TYPE    (CharacterFilter::ALLOW)
#define SCIENTIFIC_NOTATION_CHARACTER_FILTER      "0123456789-.eE+"
#define SCIENTIFIC_NOTATION_CHARACTER_FILTER_TYPE (CharacterFilter::ALLOW)

} // end of namespace Xrb

#endif // !defined(_XRB_CHARACTERFILTER_HPP_)

---