pl_ListenerCoupleCloser.h

Go to the documentation of this file.

/* AbiWord
 * Copyright (C) 2011 Ben Martin
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 */

#ifndef PL_LISTENERCOUPLECLOSER_H
#define PL_LISTENERCOUPLECLOSER_H

#include "ut_types.h"
#include "pt_Types.h"
class PX_ChangeRecord;
#include "pl_Listener.h"

#include <list>
#include <string>

class fl_ContainerLayout;

struct ABI_EXPORT PL_FinishingListener : public PL_Listener
{
    virtual bool isFinished() = 0;

    virtual bool        change(fl_ContainerLayout* /*sfh*/,
                               const PX_ChangeRecord * /*pcr*/)
    {return true;}
    virtual bool        insertStrux(fl_ContainerLayout* /*sfh*/,
                                    const PX_ChangeRecord * /*pcr*/,
                                    pf_Frag_Strux* /*sdhNew*/,
                                    PL_ListenerId /*lid*/,
                                    void (* /*pfnBindHandles*/)(pf_Frag_Strux* sdhNew,
                                                                PL_ListenerId lid,
                                                                fl_ContainerLayout* sfhNew))
    { return true;}
    virtual bool        signal(UT_uint32 /*iSignal*/)
    { return true;}
};


class ABI_EXPORT PL_ListenerCoupleCloser : public PL_Listener
{
  protected:
    PD_Document* m_pDocument;
    PL_Listener* m_delegate;
    typedef std::list< std::string > stringlist_t;
    stringlist_t m_rdfUnclosedAnchorStack;
    stringlist_t m_rdfUnopenedAnchorStack;
    stringlist_t m_bookmarkUnclosedStack;
    stringlist_t m_bookmarkUnopenedStack;

    bool shouldClose( const std::string& id, bool isEnd, stringlist_t& sl );
    bool shouldOpen( const std::string& id,  bool isEnd, stringlist_t& sl );
    void trackOpenClose( const std::string& id, bool isEnd,
                         stringlist_t& unclosed, stringlist_t& unopened );


    struct ABI_EXPORT AfterContentListener : public PL_FinishingListener
    {
        PL_ListenerCoupleCloser* m_self;
        AfterContentListener( PL_ListenerCoupleCloser* self )
            : m_self(self)
        {}

        virtual bool isFinished();
        virtual bool populate( fl_ContainerLayout* sfh,
                               const PX_ChangeRecord * pcr );
        virtual bool populateStrux( pf_Frag_Strux* sdh,
                                    const PX_ChangeRecord * pcr,
                                    fl_ContainerLayout* * psfh);
    };
    AfterContentListener m_AfterContentListener;

    struct ABI_EXPORT BeforeContentListener : public PL_FinishingListener
    {
        PL_ListenerCoupleCloser* m_self;
        BeforeContentListener( PL_ListenerCoupleCloser* self )
            : m_self(self)
        {}

        virtual bool isFinished();
        virtual bool populate( fl_ContainerLayout* sfh,
                               const PX_ChangeRecord * pcr );
        virtual bool populateStrux( pf_Frag_Strux* sdh,
                                    const PX_ChangeRecord * pcr,
                                    fl_ContainerLayout* * psfh);
    };
    BeforeContentListener m_BeforeContentListener;

    struct ABI_EXPORT NullContentListener : public PL_FinishingListener
    {
        PL_ListenerCoupleCloser* m_self;
        NullContentListener( PL_ListenerCoupleCloser* self )
            : m_self(self)
        {}

        virtual bool isFinished()
        {
            return true;
        }
        virtual bool populate( fl_ContainerLayout*,
                               const PX_ChangeRecord* )
        {
            return false;
        }
        virtual bool populateStrux( pf_Frag_Strux*,
                                    const PX_ChangeRecord*,
                                    fl_ContainerLayout**)
        {
            return false;
        }
    };
    NullContentListener m_NullContentListener;


  public:
    PL_ListenerCoupleCloser();
    virtual ~PL_ListenerCoupleCloser();
    void setDelegate( PL_Listener* delegate );
    PD_Document*  getDocument(void);
    void          setDocument(PD_Document * pDoc);
    void          reset();

    virtual bool populate( fl_ContainerLayout* sfh,
                           const PX_ChangeRecord * pcr );
    virtual bool populateStrux( pf_Frag_Strux* sdh,
                                const PX_ChangeRecord * pcr,
                                fl_ContainerLayout* * psfh);

    PL_FinishingListener* getAfterContentListener();
    PL_FinishingListener* getBeforeContentListener();
    PL_FinishingListener* getNullContentListener();


    virtual bool        change(fl_ContainerLayout* /*sfh*/,
                               const PX_ChangeRecord * /*pcr*/)
    {return true;}

    virtual bool        insertStrux(fl_ContainerLayout* /*sfh*/,
                                    const PX_ChangeRecord * /*pcr*/,
                                    pf_Frag_Strux* /*sdhNew*/,
                                    PL_ListenerId /*lid*/,
                                    void (* /*pfnBindHandles*/)(pf_Frag_Strux* sdhNew,
                                                                PL_ListenerId lid,
                                                                fl_ContainerLayout* sfhNew))
    { return true;}

    virtual bool        signal(UT_uint32 /*iSignal*/)
    { return true;}

  private:

    virtual bool populateAfter( fl_ContainerLayout* sfh,
                                const PX_ChangeRecord * pcr );
    virtual bool populateStruxAfter( pf_Frag_Strux* sdh,
                                     const PX_ChangeRecord * pcr,
                                     fl_ContainerLayout* * psfh);


    virtual bool populateBefore( fl_ContainerLayout* sfh,
                                 const PX_ChangeRecord * pcr );
    virtual bool populateStruxBefore( pf_Frag_Strux* sdh,
                                      const PX_ChangeRecord * pcr,
                                      fl_ContainerLayout* * psfh);



};

#endif