src/foundation/ZTrail.h

/*  @(#) $Id: ZTrail.h,v 1.7 2007/01/10 01:15:36 agreen Exp $ */

/* ------------------------------------------------------------
Copyright (c) 2004 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 __ZTrail__
#define __ZTrail__ 1
#include "zconfig.h"

#include "ZUnicode.h"

#include <string>
#include <vector>

#include "ZCompat_operator_bool.h"

// =================================================================================================
#pragma mark -
#pragma mark * ZTrail

class ZTrail
        {
    ZOOLIB_DEFINE_OPERATOR_BOOL_TYPES(ZTrail, operator_bool_generator_type, operator_bool_type);
public:
        ZTrail();
        ZTrail(bool iValid);

        ZTrail(const ZTrail& iTrail);

        ZTrail(const std::string& iPOSIXTrail);
        ZTrail(const char* iPOSIXTrail);
        ZTrail(const char* iPOSIXTrail, size_t iSize);

        ZTrail(const std::string& iSeparator, const std::string& iIgnore, const std::string& iBounce, const std::string& iTrail);

        template <class I>
        ZTrail(const I& iBegin, const I& iEnd)
        :       fComps(iBegin, iEnd),
                fValid(true)
                {}

        ~ZTrail();

        operator operator_bool_type() const;

        ZTrail& operator=(const ZTrail& iTrail);

        ZTrail operator+(const ZTrail& iTrail) const;
        ZTrail& operator+=(const ZTrail& iTrail);

        template <class I>
        void AppendTrail(const I& iBegin, const I& iEnd)
                { fComps.insert(fComps.end(), iBegin, iEnd); }
        void AppendTrail(const ZTrail& iTrail);
        void AppendComp(const std::string& iComp);
        void AppendBounce();
        void AppendBounces(size_t iCount);

        template <class I>
        void PrependTrail(const I& iBegin, const I& iEnd)
                { fComps.insert(fComps.begin(), iBegin, iEnd);}
        void PrependTrail(const ZTrail& iTrail);
        void PrependComp(const std::string& iComp);
        void PrependBounce();
        void PrependBounces(size_t iCount);

        std::string AsString() const;
        std::string AsString(const std::string& iSeparator, const std::string& iBounce) const;

        ZTrail Branch() const;
        std::string Leaf() const;

        size_t Count() const;
        std::string At(size_t iIndex) const;
        ZTrail SubTrail(size_t iBegin, size_t iEnd) const;
        ZTrail SubTrail(size_t iBegin) const;

        ZTrail Normalized() const;
        ZTrail& Normalize();
        bool IsNormalized() const;

        const std::vector<std::string>& GetComps() const
                { return fComps; }

        static ZTrail sTrailFromTo(const std::vector<std::string>& iSource,
                const std::vector<std::string>& iDest);

        static void sParseStringAndAppend(const UTF8* iSeparator,
                                                        const char* iIgnore,
                                                        const char* iBounce,
                                                        const char* iPath, size_t iPathSize,
                                                        std::vector<std::string>& ioComps);

        static void sParseStringAndAppend(const UTF16* iSeparator,
                                                        const UTF16* iIgnore,
                                                        const UTF16* iBounce,
                                                        const UTF16* iPath, size_t iPathSize,
                                                        std::vector<string16>& ioComps);

        static size_t sNormalize_ReturnLeadingBounces(const std::vector<std::string>& iComps,
                std::vector<std::string>& oComps);

private:
        std::vector<std::string> fComps;
        bool fValid;
        };

#endif // __ZTrail__

---