src_other/tuplebase/ZTBSpec.h

/*  @(#) $Id: ZTBSpec.h,v 1.31 2006/11/02 22:47:47 agreen Exp $ */

/* ------------------------------------------------------------
Copyright (c) 2003 Andrew Green and Learning in Motion, Inc.
http://www.zoolib.org

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
------------------------------------------------------------ */

#ifndef __ZTBSpec__
#define __ZTBSpec__ 1
#include "zconfig.h"

#include "ZCompare.h"
#include "ZRegex.h"
#include "ZTextCollator.h"
#include "ZTuple.h"

#include <set>
#include <vector>

// =================================================================================================
#pragma mark -
#pragma mark * ZTBSpec


class ZTBSpec
        {
        ZOOLIB_DEFINE_OPERATOR_BOOL_TYPES(ZTBSpec,
                operator_bool_generator_type, operator_bool_type);
public:
        class Comparator;
        class Criterion;
        class Rep;

        typedef std::vector<Criterion> CriterionSect;

        typedef std::vector<CriterionSect> CriterionUnion;

        enum ERel
                {
                eRel_Invalid,
                eRel_Less,
                eRel_LessEqual,
                eRel_Equal,
                eRel_GreaterEqual,
                eRel_Greater,
                eRel_Has,
                eRel_HasOfType,
                eRel_Lacks,
                eRel_LacksOfType,
                eRel_VectorContains,
                eRel_StringContains,
                eRel_Regex
                };
        //@{
        ZTBSpec();

        ZTBSpec(const ZTBSpec& iOther);

        ZTBSpec& operator=(const ZTBSpec& iOther);

        ~ZTBSpec();

        //@{
        explicit ZTBSpec(bool iAny);

        explicit ZTBSpec(const Criterion& iCriterion);
        ZTBSpec(const ZTuplePropName& iPropName, ERel iRel, const ZTupleValue& iTV);
        ZTBSpec(const ZTuplePropName& iPropName, ERel iRel, int iStrength, const ZTupleValue& iTV);
        ZTBSpec(const ZTuplePropName& iPropName, Comparator iComparator, const ZTupleValue& iTV);

        explicit ZTBSpec(const CriterionSect& iCriterionSect);

        //@{
        explicit ZTBSpec(const ZTuple& iTuple);

        explicit ZTBSpec(const ZStreamR& iStreamR);

        ZTuple AsTuple() const;

        void ToStream(const ZStreamW& iStreamW) const;

        //@{
        operator operator_bool_type() const;

        int Compare(const ZTBSpec& iOther) const;

        bool operator==(const ZTBSpec& iOther) const;
        bool operator!=(const ZTBSpec& iOther) const;

        bool operator<(const ZTBSpec& iOther) const;
        bool operator<=(const ZTBSpec& iOther) const;
        bool operator>(const ZTBSpec& iOther) const;
        bool operator>=(const ZTBSpec& iOther) const;

        //@{
        ZTBSpec operator&(const ZTBSpec& iOther) const;

        ZTBSpec& operator&=(const ZTBSpec& iOther);

        ZTBSpec operator|(const ZTBSpec& iOther) const;

        ZTBSpec& operator|=(const ZTBSpec& iOther);

        bool Matches(const ZTuple& iTuple) const;

        bool IsAny() const;

        bool IsNone() const;

        //@{
        const CriterionUnion& GetCriterionUnion() const;

        void GetPropNames(std::set<std::string>& oNames) const;
        void GetPropNames(std::set<ZTuplePropName>& oNames) const;

        //@{
        static ZTBSpec sAny();

        static ZTBSpec sNone();

        static ZTBSpec sHas(const ZTuplePropName& iPropName);

        static ZTBSpec sHas(const ZTuplePropName& iPropName, ZType iType);

        static ZTBSpec sLacks(const ZTuplePropName& iPropName);

        static ZTBSpec sLacks(const ZTuplePropName& iPropName, ZType iType);

        static ZTBSpec sEquals(const ZTuplePropName& iPropName, const ZTupleValue& iValue);

        static ZTBSpec sNotEqual(const ZTuplePropName& iPropName, const ZTupleValue& iValue);

        static ZTBSpec sLess(const ZTuplePropName& iPropName, const ZTupleValue& iValue);

        static ZTBSpec sLessEqual(const ZTuplePropName& iPropName, const ZTupleValue& iValue);

        static ZTBSpec sGreater(const ZTuplePropName& iPropName, const ZTupleValue& iValue);

        static ZTBSpec sGreaterEqual(const ZTuplePropName& iPropName, const ZTupleValue& iValue);

        static ZTBSpec sStringContains(
                const ZTuplePropName& iPropName, const std::string& iString, int iStrength);

        static ZTBSpec sVectorContains(const ZTuplePropName& iPropName, const ZTupleValue& iValue);

        static ZTBSpec sRegex(const ZTuplePropName& iPropName, const std::string& iRegex, int iStrength);

private:
        ZTBSpec(CriterionUnion& ioCriterionUnion, bool iKnowWhatIAmDoing);

        void MakeFresh();
        ZRef<Rep> fRep;
        };

inline bool ZTBSpec::operator==(const ZTBSpec& iOther) const
        { return this->Compare(iOther) == 0; }

inline bool ZTBSpec::operator<(const ZTBSpec& iOther) const
        { return this->Compare(iOther) < 0; }

namespace ZooLib {
template <>
inline int sCompare_T(const ZTBSpec& iL, const ZTBSpec& iR)
        { return iL.Compare(iR); }
}

// =================================================================================================
#pragma mark -
#pragma mark * ZTBSpec::Comparator


class ZTBSpec::Comparator
        {
public:
        explicit Comparator(const ZStreamR& iStreamR);
        Comparator();

        Comparator(ERel iRel, int iStrength);

        Comparator(ERel iRel);
        //@{
        int Compare(const Comparator& iOther) const;
        bool operator<(const Comparator& iOther) const;

        void ToStream(const ZStreamW& iStreamW) const;

        ERel fRel;

        int fStrength;
        };

inline int ZTBSpec::Comparator::Compare(const Comparator& iOther) const
        {
        if (int compare = fRel - iOther.fRel)
                return compare;

        return fStrength - iOther.fStrength;
        }

inline bool ZTBSpec::Comparator::operator<(const Comparator& iOther) const
        {
        return fRel < iOther.fRel || (fRel == iOther.fRel && fStrength < iOther.fStrength);
        }

namespace ZooLib {
template <>
inline int sCompare_T(const ZTBSpec::Comparator& iL, const ZTBSpec::Comparator& iR)
        { return iL.Compare(iR); }
}

// =================================================================================================
#pragma mark -
#pragma mark * ZTBSpec::Criterion


class ZTBSpec::Criterion
        {
private:
        // An unitialized Criterion has no meaning.
        Criterion();

public:
        explicit Criterion(const ZTuple& iTuple);
        explicit Criterion(const ZStreamR& iStreamR);

        Criterion(const ZTuplePropName& iPropName, const Comparator& iComparator, const ZTupleValue& iTV);

        Criterion(const ZTuplePropName& iPropName);

        Criterion(const ZTuplePropName& iPropName, ZType iType);

        Criterion(const ZTuplePropName& iPropName, ERel iRel, const ZTupleValue& iTV);

        Criterion(const ZTuplePropName& iPropName, ERel iRel, int iStrength, const ZTupleValue& iTV);

        ZTuple AsTuple() const;

        void ToStream(const ZStreamW& iStreamW) const;

        bool Matches(const ZTuple& iTuple) const;
        //@{
        int Compare(const Criterion& iOther) const;
        bool operator<(const Criterion& iOther) const;

        const ZTuplePropName& GetPropName() const;
        const Comparator& GetComparator() const;
        const ZTupleValue& GetTupleValue() const;

private:
        class Rep;
        ZRef<Rep> fRep;
        };

namespace ZooLib {
template <>
inline int sCompare_T(const ZTBSpec::Criterion& iL, const ZTBSpec::Criterion& iR)
        { return iL.Compare(iR); }
}

// =================================================================================================
#pragma mark -
#pragma mark * ZTBSpec::Criterion::Rep

class ZTBSpec::Criterion::Rep : public ZRefCounted
        {
private:
        Rep();

public:
        static bool sCheckAccessEnabled() { return false; }

        explicit Rep(const ZTuple& iTuple);
        explicit Rep(const ZStreamR& iStreamR);

        Rep(const ZTuplePropName& iPropName, const Comparator& iComparator, const ZTupleValue& iTV);
        Rep(const ZTuplePropName& iPropName);
        Rep(const ZTuplePropName& iPropName, ZType iType);
        Rep(const ZTuplePropName& iPropName, ERel iRel, const ZTupleValue& iTV);
        Rep(const ZTuplePropName& iPropName, ERel iRel, int iStrength, const ZTupleValue& iTV);

        ZTuple AsTuple() const;
        void ToStream(const ZStreamW& iStreamW) const;

private:
        friend class Criterion;

        // It is essential that these fields remain in this order,
        // as they may be initialized from a stream.
        
        ZTuplePropName fPropName;
        Comparator fComparator;
        ZTupleValue fTupleValue;

        #if ZCONFIG_API_Enabled(Regex)
                mutable ZRegex fRegex;
        #endif
        mutable ZTextCollator fTextCollator;
        };

// =================================================================================================
#pragma mark -
#pragma mark * ZTBSpec inlines

inline ZTBSpec::operator operator_bool_type() const
        { return operator_bool_generator_type::translate(!this->IsNone()); }

inline bool ZTBSpec::operator!=(const ZTBSpec& iOther) const
        { return !(*this == iOther); }

inline bool ZTBSpec::operator<=(const ZTBSpec& iOther) const
        { return !(iOther < *this); }

inline bool ZTBSpec::operator>(const ZTBSpec& iOther) const
        { return iOther < *this; }

inline bool ZTBSpec::operator>=(const ZTBSpec& iOther) const
        { return !(*this < iOther); }

inline ZTBSpec ZTBSpec::sAny()
        { return ZTBSpec(true); }

inline ZTBSpec ZTBSpec::sNone()
        { return ZTBSpec(); }

inline ZTBSpec ZTBSpec::sHas(const ZTuplePropName& iPropName)
        { return ZTBSpec(iPropName, eRel_Has, ZTupleValue()); }

inline ZTBSpec ZTBSpec::sHas(const ZTuplePropName& iPropName, ZType iType)
        { return ZTBSpec(iPropName, eRel_HasOfType, iType); }

inline ZTBSpec ZTBSpec::sLacks(const ZTuplePropName& iPropName)
        { return ZTBSpec(iPropName, eRel_Lacks, ZTupleValue()); }

inline ZTBSpec ZTBSpec::sLacks(const ZTuplePropName& iPropName, ZType iType)
        { return ZTBSpec(iPropName, eRel_LacksOfType, iType); }

inline ZTBSpec ZTBSpec::sEquals(const ZTuplePropName& iPropName, const ZTupleValue& iValue)
        { return ZTBSpec(iPropName, eRel_Equal, iValue); }

inline ZTBSpec ZTBSpec::sNotEqual(const ZTuplePropName& iPropName, const ZTupleValue& iValue)
        { return ZTBSpec(iPropName, eRel_Less, iValue) | ZTBSpec(iPropName, eRel_Greater, iValue); }

inline ZTBSpec ZTBSpec::sLess(const ZTuplePropName& iPropName, const ZTupleValue& iValue)
        { return ZTBSpec(iPropName, eRel_Less, iValue); }

inline ZTBSpec ZTBSpec::sLessEqual(const ZTuplePropName& iPropName, const ZTupleValue& iValue)
        { return ZTBSpec(iPropName, eRel_LessEqual, iValue); }

inline ZTBSpec ZTBSpec::sGreater(const ZTuplePropName& iPropName, const ZTupleValue& iValue)
        { return ZTBSpec(iPropName, eRel_Greater, iValue); }

inline ZTBSpec ZTBSpec::sGreaterEqual(const ZTuplePropName& iPropName, const ZTupleValue& iValue)
        { return ZTBSpec(iPropName, eRel_GreaterEqual, iValue); }

inline ZTBSpec ZTBSpec::sStringContains(
        const ZTuplePropName& iPropName, const std::string& iString, int iStrength)
        { return ZTBSpec(iPropName, eRel_StringContains, iStrength, iString); }

inline ZTBSpec ZTBSpec::sVectorContains(const ZTuplePropName& iPropName, const ZTupleValue& iValue)
        { return ZTBSpec(iPropName, eRel_VectorContains, iValue); }

inline ZTBSpec ZTBSpec::sRegex(
        const ZTuplePropName& iPropName, const std::string& iRegex, int iStrength)
        { return ZTBSpec(iPropName, eRel_Regex, iStrength, iRegex); }

// =================================================================================================
#pragma mark -
#pragma mark * ZTBSpec::Criterion inlines

inline bool ZTBSpec::Criterion::operator<(const Criterion& iOther) const
        { return this->Compare(iOther) < 0; }

inline const ZTuplePropName& ZTBSpec::Criterion::GetPropName() const
        { return fRep->fPropName; }

inline const ZTBSpec::Comparator& ZTBSpec::Criterion::GetComparator() const
        { return fRep->fComparator; }

inline const ZTupleValue& ZTBSpec::Criterion::GetTupleValue() const
        { return fRep->fTupleValue; }

#endif // __ZTBSpec__

---