src/stream/ZStrimW_ML.h

/*  @(#) $Id: ZStrimW_ML.h,v 1.21 2006/04/27 03:19:32 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 __ZStrimW_ML__
#define __ZStrimW_ML__ 1
#include "zconfig.h"

#include "ZCompat_NonCopyable.h"
#include "ZDebug.h"
#include "ZStrim.h"
#include "ZStrimmer.h"

#include <vector>

class ZTuple;
class ZTupleValue;

// =================================================================================================
#pragma mark -
#pragma mark * ZStrimW_ML


class ZStrimW_ML : public ZStrimW_NativeUTF8, ZooLib::NonCopyable
        {
public:
        // The copy constructor is deliberately not implemented. See docs for reason.
        ZStrimW_ML(const ZStrimW_ML&);

        explicit ZStrimW_ML(const ZStrimW& iStrimSink);

        ZStrimW_ML(bool iIndent, const ZStrimW& iStrimSink);
        ZStrimW_ML(const string8& iEOL, const string8& iIndent, const ZStrimW& iStrimSink);
        ~ZStrimW_ML();

// From ZStrimW
        virtual void Imp_WriteUTF8(const UTF8* iSource, size_t iCountCU, size_t* oCountCU);

        virtual void Imp_Flush();

// Our protocol

        const ZStrimW& Raw() const;

        void WriteNBSP() const;
        void NBSP() const { this->WriteNBSP(); }

        void WriteEntity(const string8& iEntity) const;
        void WriteEntity(const UTF8* iEntity) const;

        void Begin(const string8& iTag) const;

        void End(const string8& iTag) const;

        void End() const;

        void Empty(const string8& iTag) const;

        void PI(const string8& iTag) const;

        void Tag(const string8& iTag) const;

        void Attr(const string8& iValue) const;

        void Attr(const string8& iName, const string8& iValue) const;

        void Attr(const string8& iName, const UTF8* iValue) const;

        void Attr(const string8& iName, int iValue) const;

        void Attrf(const string8& iName, const UTF8* iValue, ...) const;

        void Attr(const string8& iName, const ZTupleValue& iValue) const;

        void Attrs(const ZTuple& iTuple) const;

        bool Indent(bool iIndent) const;

        void Abandon();

        void EndAll();

        void EndAll(const string8& iTag);

        void WritePending();

protected:
        enum ETagType
                { eTagTypeNone, eTagTypeNormal, eTagTypeEmpty, eTagTypePI, eTagTypeNoEnd };

        void pBegin(const string8& iTag, ETagType iTagType);
        void pWritePending();
        void pAttr(const string8& iName, string8* iValue);
        void pEnd();

        const ZStrimW& fStrimSink;
        
        ETagType fTagType;
        bool fWrittenSinceLastTag;
        bool fLastWasEOL;
        bool fIndentEnabled;
        string8 fString_EOL;
        string8 fString_Indent;
        std::vector<string8> fTags;
        std::vector<string8> fAttributeNames;
        std::vector<string8*> fAttributeValues;
        };

// =================================================================================================
#pragma mark -
#pragma mark * ZStrimmerW_ML


class ZStrimmerW_ML : public ZStrimmerW
        {
public:
        ZStrimmerW_ML(ZRef<ZStrimmerW> iStrimmer);
        ZStrimmerW_ML(bool iIndent, ZRef<ZStrimmerW> iStrimmer);
        ZStrimmerW_ML(const string8& iEOL, const string8& iIndent, ZRef<ZStrimmerW> iStrimmer);
        virtual ~ZStrimmerW_ML();

// From ZStrimmerW
        virtual const ZStrimW& GetStrimW();

protected:
        ZRef<ZStrimmerW> fStrimmer;
        ZStrimW_ML fStrim;
        };

#endif // __ZStrimW_ML__

---