textdocument/lib/markupdirector.h

/*
  This file is part of the Grantlee template system.

  Copyright (c) 2008 Stephen Kelly <steveire@gmail.com>

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either version
  2.1 of the Licence, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef GRANTLEE_MARKUPDIRECTOR_H
#define GRANTLEE_MARKUPDIRECTOR_H

#include "abstractmarkupbuilder.h"
#include "grantlee_textdocument_export.h"

#include <QtGui/QTextDocument>
#include <QtGui/QTextFrame>

class QTextTable;
class QTextTableCell;
class QTextList;
class QTextCharFormat;

namespace Grantlee
{

class MarkupDirectorPrivate;


class GRANTLEE_TEXTDOCUMENT_EXPORT MarkupDirector
{
public:
  MarkupDirector(AbstractMarkupBuilder *builder);

  virtual ~MarkupDirector();

  virtual void processDocument(QTextDocument *doc);

  virtual QTextFrame::iterator processFrame(QTextFrame::iterator it,
                                            QTextFrame *frame);

  virtual QTextFrame::iterator processBlock(QTextFrame::iterator it,
                                            const QTextBlock &block);

  virtual QTextFrame::iterator processObject(QTextFrame::iterator it,
                                             const QTextBlock &block,
                                             QTextObject *textObject);

  virtual QPair<QTextFrame::iterator, QTextBlock>
  processBlockGroup(QTextFrame::iterator it, const QTextBlock &block,
                    QTextBlockGroup *textBlockGroup);

  virtual QPair<QTextFrame::iterator, QTextBlock>
  processList(QTextFrame::iterator it, const QTextBlock &block,
              QTextList *textList);

  virtual QTextFrame::iterator processBlockContents(QTextFrame::iterator it,
                                                    const QTextBlock &block);

  virtual void processCustomFragment(const QTextFragment &fragment,
                                     QTextDocument const *doc);

  virtual QTextBlock::iterator processFragment(QTextBlock::iterator it,
                                               const QTextFragment &fragment,
                                               QTextDocument const *doc);

  virtual QTextBlock::iterator
  processCharTextObject(QTextBlock::iterator it, const QTextFragment &fragment,
                        QTextObject *textObject);

  virtual QTextBlock::iterator processImage(QTextBlock::iterator it,
                                            const QTextImageFormat &imageFormat,
                                            QTextDocument *doc);

  virtual QTextFrame::iterator processTable(QTextFrame::iterator it,
                                            QTextTable *table);

  virtual void processTableCell(const QTextTableCell &tableCell,
                                QTextTable *table);

protected:
  void processDocumentContents(QTextFrame::iterator begin,
                               QTextFrame::iterator end);

  QPair<QTextFrame::iterator, QTextBlock>
  skipBlockGroup(QTextFrame::iterator it, const QTextBlock &_block,
                 QTextBlockGroup *blockGroup);

  QList<int> sortOpeningOrder(QSet<int> openingTags,
                              QTextBlock::iterator it) const;

  virtual void processClosingElements(QTextBlock::iterator it);

  virtual void processOpeningElements(QTextBlock::iterator it);

  virtual QSet<int> getElementsToClose(QTextBlock::iterator it) const;

  virtual QList<int> getElementsToOpen(QTextBlock::iterator it);

  enum OpenElementValues {
    None = 0x0,               
    SuperScript = 0x01,       
    SubScript = 0x02,         
    Anchor = 0x04,            
    SpanForeground = 0x08,    
    SpanBackground = 0x10,    
    SpanFontFamily = 0x20,    
    SpanFontPointSize = 0x40, 
    Strong = 0x80,            
    Emph = 0x100,             
    Underline = 0x200,        
    StrikeOut = 0x400         
  };

protected:
#ifndef Q_QDOC
  MarkupDirectorPrivate *const d_ptr;
#endif

  AbstractMarkupBuilder *m_builder;

#ifndef Q_QDOC
private:
  Q_DECLARE_PRIVATE(MarkupDirector)
#endif
};
}

#endif