dochandler.h 41.2 KB
Newer Older
dimitri's avatar
dimitri committed
1 2 3 4 5
/******************************************************************************
 *
 * $Id$
 *
 *
dimitri's avatar
dimitri committed
6
 * Copyright (C) 1997-2005 by Dimitri van Heesch.
dimitri's avatar
dimitri committed
7 8 9 10 11 12 13 14 15
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation under the terms of the GNU General Public License is hereby 
 * granted. No representations are made about the suitability of this software 
 * for any purpose. It is provided "as is" without express or implied warranty.
 * See the GNU General Public License for more details.
 *
 */

dimitri's avatar
dimitri committed
16 17 18 19 20 21 22
#ifndef _DOCHANDLER_H
#define _DOCHANDLER_H

#include <qstring.h>
#include <qlist.h>
#include <qxml.h>

dimitri's avatar
dimitri committed
23
#include <doxmlintf.h>
dimitri's avatar
dimitri committed
24
#include "stringimpl.h"
dimitri's avatar
dimitri committed
25
#include "basehandler.h"
dimitri's avatar
dimitri committed
26
#include "baseiterator.h"
dimitri's avatar
dimitri committed
27

dimitri's avatar
dimitri committed
28
class ParagraphHandler;
dimitri's avatar
dimitri committed
29
class DocInternalHandler;
dimitri's avatar
dimitri committed
30 31
class LinkedTextImpl;
class LinkedTextHandler;
dimitri's avatar
dimitri committed
32 33 34

//-----------------------------------------------------------------------------

dimitri's avatar
dimitri committed
35 36 37 38 39 40 41 42 43 44 45 46 47
class DocImpl : public IDoc { public: virtual ~DocImpl() {} };

#define DEFINE_CLS_IMPL(cls) \
  class cls##Impl : public I##cls, public DocImpl { public: virtual ~cls##Impl() {} }

DEFINE_CLS_IMPL(DocMarkup);
DEFINE_CLS_IMPL(DocPara);
DEFINE_CLS_IMPL(DocText);
DEFINE_CLS_IMPL(DocMarkupModifier);
DEFINE_CLS_IMPL(DocItemizedList);
DEFINE_CLS_IMPL(DocOrderedList);
DEFINE_CLS_IMPL(DocListItem);
DEFINE_CLS_IMPL(DocParameterList);
dimitri's avatar
dimitri committed
48
DEFINE_CLS_IMPL(DocParameterItem);
dimitri's avatar
dimitri committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
DEFINE_CLS_IMPL(DocParameter);
DEFINE_CLS_IMPL(DocTitle);
DEFINE_CLS_IMPL(DocSimpleSect);
DEFINE_CLS_IMPL(DocRef);
DEFINE_CLS_IMPL(DocVariableList);
DEFINE_CLS_IMPL(DocVariableListEntry);
DEFINE_CLS_IMPL(DocHRuler);
DEFINE_CLS_IMPL(DocLineBreak);
DEFINE_CLS_IMPL(DocULink);
DEFINE_CLS_IMPL(DocEMail);
DEFINE_CLS_IMPL(DocLink);
DEFINE_CLS_IMPL(DocProgramListing);
DEFINE_CLS_IMPL(DocCodeLine);
DEFINE_CLS_IMPL(DocHighlight);
DEFINE_CLS_IMPL(DocFormula);
DEFINE_CLS_IMPL(DocImage);
DEFINE_CLS_IMPL(DocDotFile);
DEFINE_CLS_IMPL(DocIndexEntry);
DEFINE_CLS_IMPL(DocTable);
DEFINE_CLS_IMPL(DocRow);
DEFINE_CLS_IMPL(DocEntry);
DEFINE_CLS_IMPL(DocSection);
dimitri's avatar
dimitri committed
71
DEFINE_CLS_IMPL(DocVerbatim);
dimitri's avatar
dimitri committed
72 73 74 75
DEFINE_CLS_IMPL(DocCopy);
DEFINE_CLS_IMPL(DocTocList);
DEFINE_CLS_IMPL(DocTocItem);
DEFINE_CLS_IMPL(DocAnchor);
dimitri's avatar
dimitri committed
76
DEFINE_CLS_IMPL(DocSymbol);
dimitri's avatar
dimitri committed
77
DEFINE_CLS_IMPL(DocInternal);
dimitri's avatar
dimitri committed
78 79 80 81
DEFINE_CLS_IMPL(DocRoot);

//-----------------------------------------------------------------------------

dimitri's avatar
dimitri committed
82 83 84 85

/*! \brief Node representing a piece of text.
 *
 */
dimitri's avatar
dimitri committed
86
class TextNode : public DocTextImpl
dimitri's avatar
dimitri committed
87 88
{
  public:
dimitri's avatar
dimitri committed
89 90
    TextNode(const QString &t,int markup,int level) 
      : m_text(t), m_markup(markup), m_headingLevel(level) {}
dimitri's avatar
dimitri committed
91 92 93
    virtual ~TextNode() {}

    // IDocText
dimitri's avatar
dimitri committed
94
    virtual Kind kind() const { return DocImpl::Text; }
dimitri's avatar
dimitri committed
95
    virtual const IString *text() const { return &m_text; }
dimitri's avatar
dimitri committed
96
    virtual int markup() const { return m_markup; }
dimitri's avatar
dimitri committed
97
    virtual int headingLevel() const { return m_headingLevel; }
dimitri's avatar
dimitri committed
98 99
  
  private:  
dimitri's avatar
dimitri committed
100
    StringImpl m_text;
dimitri's avatar
dimitri committed
101
    int m_markup;
dimitri's avatar
dimitri committed
102
    int m_headingLevel;
dimitri's avatar
dimitri committed
103 104
};

dimitri's avatar
dimitri committed
105 106 107 108 109
//-----------------------------------------------------------------------------

/*! \brief Node representing a change in the markup style.
 *
 */
dimitri's avatar
dimitri committed
110
class MarkupModifierNode : public DocMarkupModifierImpl
dimitri's avatar
dimitri committed
111 112
{
  public:
dimitri's avatar
dimitri committed
113 114
    MarkupModifierNode(int markup,bool enabled,int level=0) 
      : m_markup(markup), m_enabled(enabled), m_headingLevel(level) {}
dimitri's avatar
dimitri committed
115
    virtual ~MarkupModifierNode() {}
dimitri's avatar
dimitri committed
116
  
dimitri's avatar
dimitri committed
117
    // IDocMarkupModifier
dimitri's avatar
dimitri committed
118
    virtual Kind kind() const { return DocImpl::MarkupModifier; }
dimitri's avatar
dimitri committed
119 120
    virtual bool enabled() const { return m_enabled; }
    virtual int markup() const { return m_markup; }
dimitri's avatar
dimitri committed
121
    virtual int headingLevel() const { return m_headingLevel; }
dimitri's avatar
dimitri committed
122

dimitri's avatar
dimitri committed
123 124 125
  private:
    int m_markup;
    bool m_enabled;
dimitri's avatar
dimitri committed
126
    int m_headingLevel;
dimitri's avatar
dimitri committed
127 128
};

dimitri's avatar
dimitri committed
129 130 131 132 133 134

//-----------------------------------------------------------------------------

/*! \brief Handles markup commands in the XML input. 
 *
 */
dimitri's avatar
dimitri committed
135 136 137
class MarkupHandler : public BaseFallBackHandler<MarkupHandler>
{
  public:
dimitri's avatar
dimitri committed
138
    MarkupHandler(QList<DocImpl> &children,QString &curString);
dimitri's avatar
dimitri committed
139 140
    virtual ~MarkupHandler();
    int markup() const { return m_curMarkup; }
dimitri's avatar
dimitri committed
141
    int headingLevel() const { return m_headingLevel; }
dimitri's avatar
dimitri committed
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156

    virtual void startBold(const QXmlAttributes &attrib);
    virtual void endBold();
    virtual void startEmphasis(const QXmlAttributes &attrib);
    virtual void endEmphasis();
    virtual void startComputerOutput(const QXmlAttributes &attrib);
    virtual void endComputerOutput();
    virtual void startCenter(const QXmlAttributes &attrib);
    virtual void endCenter();
    virtual void startSmallFont(const QXmlAttributes &attrib);
    virtual void endSmallFont();
    virtual void startSubscript(const QXmlAttributes &attrib);
    virtual void endSubscript();
    virtual void startSuperscript(const QXmlAttributes &attrib);
    virtual void endSuperscript();
dimitri's avatar
dimitri committed
157 158 159 160 161 162 163 164 165 166 167 168 169 170
    virtual void startPreformatted(const QXmlAttributes &attrib);
    virtual void endPreformatted();
    virtual void startHeading1(const QXmlAttributes &attrib);
    virtual void endHeading1();
    virtual void startHeading2(const QXmlAttributes &attrib);
    virtual void endHeading2();
    virtual void startHeading3(const QXmlAttributes &attrib);
    virtual void endHeading3();
    virtual void startHeading4(const QXmlAttributes &attrib);
    virtual void endHeading4();
    virtual void startHeading5(const QXmlAttributes &attrib);
    virtual void endHeading5();
    virtual void startHeading6(const QXmlAttributes &attrib);
    virtual void endHeading6();
dimitri's avatar
dimitri committed
171 172 173 174 175


  private:
    void addTextNode();

dimitri's avatar
dimitri committed
176 177
    QList<DocImpl>  &m_children;
    QString         &m_curString;
dimitri's avatar
dimitri committed
178
    int             m_curMarkup;
dimitri's avatar
dimitri committed
179
    int             m_headingLevel;
dimitri's avatar
dimitri committed
180 181
};

dimitri's avatar
dimitri committed
182 183 184 185 186 187 188 189 190 191 192 193 194 195
//-----------------------------------------------------------------------------

/*! \brief Node representing a paragraph of text and commands.
 *
 */
// children: itemizedlist, orderedlist, parameterlist, simplesect, ref,
//           variablelist, hruler, linebreak, ulink, email, link
//           programlisting, formula, image, dotfile, indexentry,
//           table
//
// children handled by MarkupHandler: 
//           bold, computeroutput, emphasis, center,
//           small, subscript, superscript. 
//
dimitri's avatar
dimitri committed
196
class ParagraphHandler : public DocParaImpl, 
dimitri's avatar
dimitri committed
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
                         public BaseHandler<ParagraphHandler>
{
    friend class ParagraphIterator;

  public:
    virtual void startParagraph(const QXmlAttributes& attrib);
    virtual void endParagraph();
    virtual void startItemizedList(const QXmlAttributes& attrib);
    virtual void startOrderedList(const QXmlAttributes& attrib);
    virtual void startParameterList(const QXmlAttributes& attrib);
    virtual void startSimpleSect(const QXmlAttributes& attrib);
    virtual void startRef(const QXmlAttributes& attrib);
    virtual void startVariableList(const QXmlAttributes& attrib);
    virtual void startHRuler(const QXmlAttributes& attrib);
    virtual void startLineBreak(const QXmlAttributes& attrib);
    virtual void startULink(const QXmlAttributes& attrib);
    virtual void startEMail(const QXmlAttributes& attrib);
    virtual void startLink(const QXmlAttributes& attrib);
    virtual void startProgramListing(const QXmlAttributes& attrib);
    virtual void startFormula(const QXmlAttributes& attrib);
    virtual void startImage(const QXmlAttributes& attrib);
    virtual void startDotFile(const QXmlAttributes& attrib);
    virtual void startIndexEntry(const QXmlAttributes& attrib);
    virtual void startTable(const QXmlAttributes& attrib);
dimitri's avatar
dimitri committed
221
    virtual void startVerbatim(const QXmlAttributes& attrib);
dimitri's avatar
dimitri committed
222 223
    virtual void startHtmlOnly(const QXmlAttributes& attrib);
    virtual void startLatexOnly(const QXmlAttributes& attrib);
dimitri's avatar
dimitri committed
224 225 226 227 228 229 230 231 232 233
    virtual void startUmlaut(const QXmlAttributes& attrib);
    virtual void startAcute(const QXmlAttributes& attrib);
    virtual void startGrave(const QXmlAttributes& attrib);
    virtual void startCirc(const QXmlAttributes& attrib);
    virtual void startTilde(const QXmlAttributes& attrib);
    virtual void startSzlig(const QXmlAttributes& attrib);
    virtual void startCedil(const QXmlAttributes& attrib);
    virtual void startRing(const QXmlAttributes& attrib);
    virtual void startNbsp(const QXmlAttributes& attrib);
    virtual void startCopy(const QXmlAttributes& attrib);
dimitri's avatar
dimitri committed
234 235 236
    virtual void startAnchor(const QXmlAttributes& attrib);
    virtual void startCopyDoc(const QXmlAttributes& attrib);
    virtual void startTocList(const QXmlAttributes& attrib);
dimitri's avatar
dimitri committed
237 238 239 240 241

    ParagraphHandler(IBaseHandler *parent);
    virtual ~ParagraphHandler();

    // IDocPara
dimitri's avatar
dimitri committed
242
    virtual Kind kind() const { return DocImpl::Para; }
dimitri's avatar
dimitri committed
243 244 245 246 247
    virtual IDocIterator *contents() const;

  private:
    void addTextNode();
    IBaseHandler   *m_parent;
dimitri's avatar
dimitri committed
248
    QList<DocImpl>  m_children;
dimitri's avatar
dimitri committed
249 250
    MarkupHandler  *m_markupHandler;
};
dimitri's avatar
dimitri committed
251

dimitri's avatar
dimitri committed
252
class ParagraphIterator : public BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>
dimitri's avatar
dimitri committed
253 254 255
{
  public:
    ParagraphIterator(const ParagraphHandler &handler) : 
dimitri's avatar
dimitri committed
256
      BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>(handler.m_children) {}
dimitri's avatar
dimitri committed
257 258
};

dimitri's avatar
dimitri committed
259 260 261 262 263
//-----------------------------------------------------------------------------

/*! \brief Node representing a list item.
 *
 */
dimitri's avatar
dimitri committed
264
class ListItemHandler : public DocListItemImpl, public BaseHandler<ListItemHandler>
dimitri's avatar
dimitri committed
265
{
dimitri's avatar
dimitri committed
266
    friend class ListItemIterator;
dimitri's avatar
dimitri committed
267 268 269 270 271 272 273
  public:
    ListItemHandler(IBaseHandler *parent);
    virtual ~ListItemHandler();
    virtual void startListItem(const QXmlAttributes& attrib);
    virtual void endListItem();
    virtual void startParagraph(const QXmlAttributes& attrib);

dimitri's avatar
dimitri committed
274
    // IDocItem
dimitri's avatar
dimitri committed
275
    virtual Kind kind() const { return DocImpl::ListItem; }
dimitri's avatar
dimitri committed
276
    virtual IDocIterator *contents() const;
dimitri's avatar
dimitri committed
277

dimitri's avatar
dimitri committed
278 279
  private:
    IBaseHandler   *m_parent;
dimitri's avatar
dimitri committed
280
    QList<DocImpl>  m_children;
dimitri's avatar
dimitri committed
281 282
};

dimitri's avatar
dimitri committed
283
class ListItemIterator : public BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>
dimitri's avatar
dimitri committed
284 285 286
{
  public:
    ListItemIterator(const ListItemHandler &handler) : 
dimitri's avatar
dimitri committed
287
      BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>(handler.m_children) {}
dimitri's avatar
dimitri committed
288 289
};

dimitri's avatar
dimitri committed
290 291 292 293 294 295

//-----------------------------------------------------------------------------

/*! \brief Node representing list of items.
 *
 */
dimitri's avatar
dimitri committed
296
class OrderedListHandler : public DocOrderedListImpl, public BaseHandler<OrderedListHandler>
dimitri's avatar
dimitri committed
297
{
dimitri's avatar
dimitri committed
298
    friend class OrderedListIterator;
dimitri's avatar
dimitri committed
299
  public:
dimitri's avatar
dimitri committed
300 301 302 303 304
    OrderedListHandler(IBaseHandler *parent);
    virtual ~OrderedListHandler();
    virtual void startOrderedList(const QXmlAttributes& attrib);
    virtual void endOrderedList();
    virtual void startOrderedListItem(const QXmlAttributes& attrib);
dimitri's avatar
dimitri committed
305

dimitri's avatar
dimitri committed
306
    // IDocOrderedList
dimitri's avatar
dimitri committed
307
    virtual Kind kind() const { return DocImpl::OrderedList; }
dimitri's avatar
dimitri committed
308
    virtual IDocIterator *elements() const;
dimitri's avatar
dimitri committed
309

dimitri's avatar
dimitri committed
310 311
  private:
    IBaseHandler   *m_parent;
dimitri's avatar
dimitri committed
312
    QList<DocImpl>  m_children;
dimitri's avatar
dimitri committed
313 314
};

dimitri's avatar
dimitri committed
315
class OrderedListIterator : public BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>
dimitri's avatar
dimitri committed
316 317 318
{
  public:
    OrderedListIterator(const OrderedListHandler &handler) : 
dimitri's avatar
dimitri committed
319
      BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>(handler.m_children) {}
dimitri's avatar
dimitri committed
320 321
};

dimitri's avatar
dimitri committed
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
//-----------------------------------------------------------------------------

/*! \brief Node representing table of contents list.
 *
 */
class TocListHandler : public DocTocListImpl, public BaseHandler<TocListHandler>
{
    friend class TocListIterator;
  public:
    TocListHandler(IBaseHandler *parent);
    virtual ~TocListHandler();
    virtual void startTocList(const QXmlAttributes& attrib);
    virtual void endTocList();
    virtual void startTocItem(const QXmlAttributes& attrib);

    // IDocTocList
    virtual Kind kind() const { return DocImpl::TocList; }
    virtual IDocIterator *elements() const;

  private:
    IBaseHandler   *m_parent;
    QList<DocImpl>  m_children;
};

class TocListIterator : public BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>
{
  public:
    TocListIterator(const TocListHandler &handler) : 
      BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>(handler.m_children) {}
};

//-----------------------------------------------------------------------------

/*! \brief Node representing a table of contents item.
 *
 */
class TocItemHandler : public DocTocItemImpl, public BaseHandler<TocItemHandler>
{
    friend class TocItemIterator;
  public:
    TocItemHandler(IBaseHandler *parent);
    virtual ~TocItemHandler();
    virtual void startTocItem(const QXmlAttributes& attrib);
    virtual void endTocItem();

    // IDocItem
    virtual Kind kind() const { return DocImpl::TocItem; }
    virtual const IString *id() const { return &m_id; }
    virtual const IString *title() const { return &m_title; }

  private:
    IBaseHandler   *m_parent;
    StringImpl      m_id;
    StringImpl      m_title;
};
dimitri's avatar
dimitri committed
377 378 379

//-----------------------------------------------------------------------------

dimitri's avatar
dimitri committed
380 381 382
/*! \brief Node representing list of items.
 *
 */
dimitri's avatar
dimitri committed
383
class ItemizedListHandler : public DocItemizedListImpl, public BaseHandler<ItemizedListHandler>
dimitri's avatar
dimitri committed
384 385 386 387 388 389 390 391 392 393
{
    friend class ItemizedListIterator;
  public:
    ItemizedListHandler(IBaseHandler *parent);
    virtual ~ItemizedListHandler();
    virtual void startItemizedList(const QXmlAttributes& attrib);
    virtual void endItemizedList();
    virtual void startItemizedListItem(const QXmlAttributes& attrib);

    // IDocItemizedList
dimitri's avatar
dimitri committed
394
    virtual Kind kind() const { return DocImpl::ItemizedList; }
dimitri's avatar
dimitri committed
395 396 397 398
    virtual IDocIterator *elements() const;

  private:
    IBaseHandler   *m_parent;
dimitri's avatar
dimitri committed
399
    QList<DocImpl>  m_children;
dimitri's avatar
dimitri committed
400 401
};

dimitri's avatar
dimitri committed
402
class ItemizedListIterator : public BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>
dimitri's avatar
dimitri committed
403 404 405
{
  public:
    ItemizedListIterator(const ItemizedListHandler &handler) : 
dimitri's avatar
dimitri committed
406
      BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>(handler.m_children) {}
dimitri's avatar
dimitri committed
407 408 409 410
};


//-----------------------------------------------------------------------------
dimitri's avatar
dimitri committed
411 412 413
/*! \brief Node representing a parameter.
 *
 */
dimitri's avatar
dimitri committed
414
class ParameterHandler : public DocParameterImpl, 
dimitri's avatar
dimitri committed
415 416 417 418 419
                         public BaseHandler<ParameterHandler>
{
  public:
    ParameterHandler(IBaseHandler *parent);
    virtual ~ParameterHandler();
dimitri's avatar
dimitri committed
420 421
    virtual void startParameterName(const QXmlAttributes& attrib);
    virtual void endParameterName();
dimitri's avatar
dimitri committed
422

dimitri's avatar
dimitri committed
423
    // IDocParameter
dimitri's avatar
dimitri committed
424
    virtual Kind kind() const { return DocImpl::Parameter; }
dimitri's avatar
dimitri committed
425
    virtual const IString *name() const { return &m_name; }
dimitri's avatar
dimitri committed
426

dimitri's avatar
dimitri committed
427 428
  private:
    IBaseHandler     *m_parent;
dimitri's avatar
dimitri committed
429
    StringImpl        m_name;
dimitri's avatar
dimitri committed
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
};

//-----------------------------------------------------------------------------

/* \brief Node representing a list of param names with a single description.
 *
 */
class ParameterItemHandler : public DocParameterItemImpl, 
                             public BaseHandler<ParameterItemHandler>
{
    friend class ParameterItemIterator;
  public:
    ParameterItemHandler(IBaseHandler *parent);
    virtual ~ParameterItemHandler();
    virtual void startParameterItem(const QXmlAttributes& attrib);
    virtual void endParameterItem();
    virtual void startParameterName(const QXmlAttributes& attrib);
    virtual void startParagraph(const QXmlAttributes& attrib);

    // IDocParameterItem
    virtual Kind kind() const { return DocImpl::ParameterItem; }
    virtual IDocIterator *paramNames() const;
    virtual IDocPara *description() const { return m_description; }

  private:
    IBaseHandler            *m_parent;
    QList<ParameterHandler>  m_parameters;
dimitri's avatar
dimitri committed
457 458 459
    ParagraphHandler *m_description;
};

dimitri's avatar
dimitri committed
460 461 462 463 464 465 466
class ParameterItemIterator : public BaseIteratorVia<IDocIterator,IDoc,ParameterHandler,DocImpl>
{
  public:
    ParameterItemIterator(const ParameterItemHandler &handler) : 
      BaseIteratorVia<IDocIterator,IDoc,ParameterHandler,DocImpl>(handler.m_parameters) {}
};

dimitri's avatar
dimitri committed
467 468
//-----------------------------------------------------------------------------

dimitri's avatar
dimitri committed
469
/* \brief Node representing a parameter section.
dimitri's avatar
dimitri committed
470 471
 *
 */
dimitri's avatar
dimitri committed
472
class ParameterListHandler : public DocParameterListImpl, 
dimitri's avatar
dimitri committed
473 474
                             public BaseHandler<ParameterListHandler>
{
dimitri's avatar
dimitri committed
475
    friend class ParameterListIterator;
dimitri's avatar
dimitri committed
476 477 478 479 480
  public:
    ParameterListHandler(IBaseHandler *parent);
    virtual ~ParameterListHandler();
    virtual void startParameterList(const QXmlAttributes& attrib);
    virtual void endParameterList();
dimitri's avatar
dimitri committed
481
    virtual void startParameterItem(const QXmlAttributes& attrib);
dimitri's avatar
dimitri committed
482

dimitri's avatar
dimitri committed
483
    // IDocParameterList
dimitri's avatar
dimitri committed
484
    virtual Kind kind() const { return DocImpl::ParameterList; }
dimitri's avatar
dimitri committed
485
    virtual Types sectType() const { return m_type; }
dimitri's avatar
dimitri committed
486
    virtual IDocIterator *params() const;
dimitri's avatar
dimitri committed
487

dimitri's avatar
dimitri committed
488 489
  private:
    IBaseHandler            *m_parent;
dimitri's avatar
dimitri committed
490
    QList<ParameterItemHandler>  m_paramItems;
dimitri's avatar
dimitri committed
491 492 493
    Types                    m_type;
};

dimitri's avatar
dimitri committed
494
class ParameterListIterator : public BaseIteratorVia<IDocIterator,IDoc,ParameterItemHandler,DocImpl>
dimitri's avatar
dimitri committed
495 496 497
{
  public:
    ParameterListIterator(const ParameterListHandler &handler) : 
dimitri's avatar
dimitri committed
498
      BaseIteratorVia<IDocIterator,IDoc,ParameterItemHandler,DocImpl>(handler.m_paramItems) {}
dimitri's avatar
dimitri committed
499 500
};

dimitri's avatar
dimitri committed
501 502
//-----------------------------------------------------------------------------

dimitri's avatar
dimitri committed
503 504 505
/* \brief Node representing a horizontal ruler
 *
 */
dimitri's avatar
dimitri committed
506
class LineBreakHandler : public DocLineBreakImpl, public BaseHandler<LineBreakHandler>
dimitri's avatar
dimitri committed
507 508 509 510 511 512 513 514
{
  public:
    LineBreakHandler(IBaseHandler *parent);
    virtual ~LineBreakHandler();

    void startLineBreak(const QXmlAttributes& attrib);
    void endLineBreak();

dimitri's avatar
dimitri committed
515
    // IDocLineBreak
dimitri's avatar
dimitri committed
516
    virtual Kind kind() const { return DocImpl::LineBreak; }
dimitri's avatar
dimitri committed
517

dimitri's avatar
dimitri committed
518 519 520 521 522 523
  private:
    IBaseHandler   *m_parent;
};

//-----------------------------------------------------------------------------

dimitri's avatar
dimitri committed
524 525 526
/* \brief Node representing a link to section
 *
 */
dimitri's avatar
dimitri committed
527
class LinkHandler : public DocLinkImpl, public BaseHandler<LinkHandler>
dimitri's avatar
dimitri committed
528 529 530 531 532 533 534 535
{
  public:
    LinkHandler(IBaseHandler *parent);
    virtual ~LinkHandler();

    void startLink(const QXmlAttributes& attrib);
    void endLink();

dimitri's avatar
dimitri committed
536
    // IDocLink
dimitri's avatar
dimitri committed
537
    virtual Kind kind() const { return DocImpl::Link; }
dimitri's avatar
dimitri committed
538 539
    virtual const IString *refId() const { return &m_ref; }
    virtual const IString *text() const { return &m_text; }
dimitri's avatar
dimitri committed
540

dimitri's avatar
dimitri committed
541 542
  private:
    IBaseHandler   *m_parent;
dimitri's avatar
dimitri committed
543 544
    StringImpl      m_ref;
    StringImpl      m_text;
dimitri's avatar
dimitri committed
545 546 547 548 549 550 551 552
};


//-----------------------------------------------------------------------------

/* \brief Node representing a link to an email address
 *
 */
dimitri's avatar
dimitri committed
553
class EMailHandler : public DocEMailImpl, public BaseHandler<EMailHandler>
dimitri's avatar
dimitri committed
554 555 556 557 558 559 560 561
{
  public:
    EMailHandler(IBaseHandler *parent);
    virtual ~EMailHandler();

    void startEMail(const QXmlAttributes& attrib);
    void endEMail();

dimitri's avatar
dimitri committed
562
    // IDocEMail
dimitri's avatar
dimitri committed
563
    virtual Kind kind() const { return DocImpl::EMail; }
dimitri's avatar
dimitri committed
564
    virtual const IString *address() const { return &m_address; }
dimitri's avatar
dimitri committed
565

dimitri's avatar
dimitri committed
566 567
  private:
    IBaseHandler   *m_parent;
dimitri's avatar
dimitri committed
568
    StringImpl      m_address;
dimitri's avatar
dimitri committed
569 570 571 572 573 574 575 576
};


//-----------------------------------------------------------------------------

/* \brief Node representing a link to an URL
 *
 */
dimitri's avatar
dimitri committed
577
class ULinkHandler : public DocULinkImpl, public BaseHandler<ULinkHandler>
dimitri's avatar
dimitri committed
578 579 580 581 582 583 584 585
{
  public:
    ULinkHandler(IBaseHandler *parent);
    virtual ~ULinkHandler();

    void startULink(const QXmlAttributes& attrib);
    void endULink();

dimitri's avatar
dimitri committed
586
    // IDocULink
dimitri's avatar
dimitri committed
587
    virtual Kind kind() const { return DocImpl::ULink; }
dimitri's avatar
dimitri committed
588 589
    virtual const IString * url() const { return &m_url; }
    virtual const IString * text() const { return &m_text; }
dimitri's avatar
dimitri committed
590

dimitri's avatar
dimitri committed
591 592
  private:
    IBaseHandler   *m_parent;
dimitri's avatar
dimitri committed
593 594
    StringImpl      m_url;
    StringImpl      m_text;
dimitri's avatar
dimitri committed
595 596 597 598
};

//-----------------------------------------------------------------------------

dimitri's avatar
dimitri committed
599 600 601
/* \brief Node representing a horizontal ruler
 *
 */
dimitri's avatar
dimitri committed
602
class HRulerHandler : public DocHRulerImpl, public BaseHandler<HRulerHandler>
dimitri's avatar
dimitri committed
603 604 605 606 607 608 609 610
{
  public:
    HRulerHandler(IBaseHandler *parent);
    virtual ~HRulerHandler();

    void startHRuler(const QXmlAttributes& attrib);
    void endHRuler();

dimitri's avatar
dimitri committed
611
    // IDocHRuler
dimitri's avatar
dimitri committed
612
    virtual Kind kind() const { return DocImpl::HRuler; }
dimitri's avatar
dimitri committed
613

dimitri's avatar
dimitri committed
614 615 616 617 618 619 620 621 622
  private:
    IBaseHandler   *m_parent;
};

//-----------------------------------------------------------------------------

/* \brief Node representing a reference to another item
 *
 */
dimitri's avatar
dimitri committed
623
class RefHandler : public DocRefImpl, public BaseHandler<RefHandler>
dimitri's avatar
dimitri committed
624 625 626 627 628 629
{
  public:
    RefHandler(IBaseHandler *parent);
    virtual ~RefHandler();
    void startRef(const QXmlAttributes& attrib);
    void endRef();
dimitri's avatar
dimitri committed
630 631

    // IDocRef
dimitri's avatar
dimitri committed
632
    virtual Kind kind() const { return DocImpl::Ref; }
dimitri's avatar
dimitri committed
633
    virtual const IString *refId() const { return &m_refId; }
dimitri's avatar
dimitri committed
634
    virtual TargetKind targetKind() const { return m_targetKind; }
dimitri's avatar
dimitri committed
635 636
    virtual const IString *external() const { return &m_extId; }
    virtual const IString *text() const { return &m_linkText; }
dimitri's avatar
dimitri committed
637

dimitri's avatar
dimitri committed
638 639
  private:
    IBaseHandler   *m_parent;
dimitri's avatar
dimitri committed
640 641 642
    StringImpl      m_refId;
    StringImpl      m_extId;
    StringImpl      m_linkText;
dimitri's avatar
dimitri committed
643
    TargetKind      m_targetKind;
dimitri's avatar
dimitri committed
644 645 646 647 648 649 650 651 652 653 654
};

//-----------------------------------------------------------------------------

/* \brief Node representing the title of a section
 *
 */
// children: text, ref
// children handled by MarkupHandler: 
//           bold, computeroutput, emphasis, center,
//           small, subscript, superscript. 
dimitri's avatar
dimitri committed
655
class TitleHandler : public DocTitleImpl, public BaseHandler<TitleHandler>
dimitri's avatar
dimitri committed
656
{
dimitri's avatar
dimitri committed
657
    friend class TitleIterator;
dimitri's avatar
dimitri committed
658 659 660 661 662 663 664
  public:
    TitleHandler(IBaseHandler *parent);
    virtual ~TitleHandler();
    virtual void startTitle(const QXmlAttributes& attrib);
    virtual void endTitle();
    virtual void startRef(const QXmlAttributes& attrib);
    void addTextNode();
dimitri's avatar
dimitri committed
665 666

    // IDocTitle
dimitri's avatar
dimitri committed
667
    virtual Kind kind() const { return DocImpl::Title; }
dimitri's avatar
dimitri committed
668 669
    virtual IDocIterator *title() const;

dimitri's avatar
dimitri committed
670 671
  private:
    IBaseHandler   *m_parent;
dimitri's avatar
dimitri committed
672
    QList<DocImpl>  m_children;
dimitri's avatar
dimitri committed
673 674 675
    MarkupHandler  *m_markupHandler;
};

dimitri's avatar
dimitri committed
676
class TitleIterator : public BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>
dimitri's avatar
dimitri committed
677 678 679
{
  public:
    TitleIterator(const TitleHandler &handler) : 
dimitri's avatar
dimitri committed
680
      BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>(handler.m_children) {}
dimitri's avatar
dimitri committed
681 682
};

dimitri's avatar
dimitri committed
683 684
//-----------------------------------------------------------------------------

dimitri's avatar
dimitri committed
685 686 687
/* \brief Node representing a simple section with an unnumbered header.
 *
 */
dimitri's avatar
dimitri committed
688
// children: title, para
dimitri's avatar
dimitri committed
689
class SimpleSectHandler : public DocSimpleSectImpl, 
dimitri's avatar
dimitri committed
690 691 692 693 694 695 696
                          public BaseHandler<SimpleSectHandler>
{
  public:
    SimpleSectHandler(IBaseHandler *parent);
    virtual ~SimpleSectHandler();
    virtual void startSimpleSect(const QXmlAttributes& attrib);
    virtual void endSimpleSect();
dimitri's avatar
dimitri committed
697 698
    virtual void startTitle(const QXmlAttributes& attrib);
    virtual void startParagraph(const QXmlAttributes& attrib);
dimitri's avatar
dimitri committed
699

dimitri's avatar
dimitri committed
700
    // IDocSimpleSect
dimitri's avatar
dimitri committed
701 702
    virtual Kind kind() const { return DocImpl::SimpleSect; }
    virtual Types type() const { return m_type; }
dimitri's avatar
dimitri committed
703
    virtual const IString *typeString() const { return &m_typeString; }
dimitri's avatar
dimitri committed
704 705
    virtual IDocTitle *title() const { return m_title; }
    virtual IDocPara *description() const { return m_paragraph; }
dimitri's avatar
dimitri committed
706

dimitri's avatar
dimitri committed
707 708
  private:
    IBaseHandler            *m_parent;
dimitri's avatar
dimitri committed
709
    ParagraphHandler        *m_paragraph;
dimitri's avatar
dimitri committed
710
    Types                    m_type;
dimitri's avatar
dimitri committed
711
    StringImpl               m_typeString;
dimitri's avatar
dimitri committed
712 713 714 715 716
    TitleHandler            *m_title;
};

//-----------------------------------------------------------------------------

dimitri's avatar
dimitri committed
717 718 719
/* \brief Node representing an named item of a VariableList.
 *
 */
dimitri's avatar
dimitri committed
720
class VariableListEntryHandler : public DocVariableListEntryImpl, 
dimitri's avatar
dimitri committed
721
                                 public BaseHandler<VariableListEntryHandler>
dimitri's avatar
dimitri committed
722 723 724 725 726 727 728 729 730 731 732 733 734
{
  public:
    virtual void startVarListEntry(const QXmlAttributes& attrib);
    virtual void endVarListEntry();
    virtual void startListItem(const QXmlAttributes& attrib);
    virtual void endListItem();
    virtual void startTerm(const QXmlAttributes& attrib);
    virtual void endTerm();
    virtual void startParagraph(const QXmlAttributes& attrib);

    VariableListEntryHandler(IBaseHandler *parent);
    virtual ~VariableListEntryHandler();

dimitri's avatar
dimitri committed
735
    // IDocVariableListEntry
dimitri's avatar
dimitri committed
736
    virtual Kind kind() const { return DocImpl::VariableListEntry; }
dimitri's avatar
dimitri committed
737
    virtual ILinkedTextIterator *term() const;
dimitri's avatar
dimitri committed
738
    virtual IDocPara *description() const { return m_description; }
dimitri's avatar
dimitri committed
739

dimitri's avatar
dimitri committed
740
  private:
dimitri's avatar
dimitri committed
741 742 743 744
    IBaseHandler*         m_parent;
    QList<LinkedTextImpl> m_term;
    ParagraphHandler*     m_description;
    LinkedTextHandler*    m_linkedTextHandler;
dimitri's avatar
dimitri committed
745 746 747 748 749 750 751 752
};

//-----------------------------------------------------------------------------

/*! \brief Node representing a list of named items.
 *
 */
// children: varlistentry, listitem
dimitri's avatar
dimitri committed
753
class VariableListHandler : public DocVariableListImpl, 
dimitri's avatar
dimitri committed
754
                            public BaseHandler<VariableListHandler>
dimitri's avatar
dimitri committed
755
{
dimitri's avatar
dimitri committed
756 757
    friend class VariableListIterator;
    
dimitri's avatar
dimitri committed
758 759 760 761 762 763 764 765 766
  public:
    virtual void startVariableList(const QXmlAttributes& attrib);
    virtual void endVariableList();
    virtual void startVarListEntry(const QXmlAttributes& attrib);
    virtual void startListItem(const QXmlAttributes& attrib);
    
    VariableListHandler(IBaseHandler *parent);
    virtual ~VariableListHandler();

dimitri's avatar
dimitri committed
767
    // IDocVariableList
dimitri's avatar
dimitri committed
768
    virtual Kind kind() const { return DocImpl::VariableList; }
dimitri's avatar
dimitri committed
769
    virtual IDocIterator *entries() const;
dimitri's avatar
dimitri committed
770

dimitri's avatar
dimitri committed
771 772 773 774
  private:
    IBaseHandler   *m_parent;
    QList<VariableListEntryHandler> m_entries;
    VariableListEntryHandler *m_curEntry;
dimitri's avatar
dimitri committed
775 776
};

dimitri's avatar
dimitri committed
777
class VariableListIterator : public BaseIteratorVia<IDocIterator,IDoc,VariableListEntryHandler,DocImpl>
dimitri's avatar
dimitri committed
778 779 780
{
  public:
    VariableListIterator(const VariableListHandler &handler) : 
dimitri's avatar
dimitri committed
781
      BaseIteratorVia<IDocIterator,IDoc,VariableListEntryHandler,DocImpl>(handler.m_entries) {}
dimitri's avatar
dimitri committed
782 783
};

dimitri's avatar
dimitri committed
784 785
//-----------------------------------------------------------------------------

dimitri's avatar
dimitri committed
786 787 788
/*! \brief Node representing a highlighted text fragment.
 *
 */
dimitri's avatar
dimitri committed
789
// children: ref
dimitri's avatar
dimitri committed
790
class HighlightHandler : public DocHighlightImpl, public BaseHandler<HighlightHandler>
dimitri's avatar
dimitri committed
791
{
dimitri's avatar
dimitri committed
792
    friend class HighlightIterator;
dimitri's avatar
dimitri committed
793 794 795 796 797
  public:
    HighlightHandler(IBaseHandler *parent);
    virtual ~HighlightHandler();
    void startHighlight(const QXmlAttributes& attrib);
    void endHighlight();
dimitri's avatar
dimitri committed
798
    virtual void startRef(const QXmlAttributes&);
dimitri's avatar
dimitri committed
799
    virtual void startSpace(const QXmlAttributes&);
dimitri's avatar
dimitri committed
800

dimitri's avatar
dimitri committed
801
    // IDocHighlight
dimitri's avatar
dimitri committed
802
    virtual Kind kind() const { return DocImpl::Highlight; }
dimitri's avatar
dimitri committed
803 804
    virtual HighlightKind highlightKind() const { return m_hl; }
    virtual IDocIterator *codeElements() const;
dimitri's avatar
dimitri committed
805

dimitri's avatar
dimitri committed
806
  private:
dimitri's avatar
dimitri committed
807 808
    void addTextNode();
    
dimitri's avatar
dimitri committed
809
    IBaseHandler   *m_parent;
dimitri's avatar
dimitri committed
810 811
    HighlightKind  m_hl;
    QString        m_hlString;
dimitri's avatar
dimitri committed
812
    QList<DocImpl> m_children;
dimitri's avatar
dimitri committed
813 814
};

dimitri's avatar
dimitri committed
815
class HighlightIterator : public BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>
dimitri's avatar
dimitri committed
816 817 818
{
  public:
    HighlightIterator(const HighlightHandler &handler) : 
dimitri's avatar
dimitri committed
819
      BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>(handler.m_children) {}
dimitri's avatar
dimitri committed
820 821 822 823 824 825 826 827
};

//-----------------------------------------------------------------------------

/*! \brief Node representing a line of code.
 *
 */
// children: linenumber, highlight, anchor, ref
dimitri's avatar
dimitri committed
828
class CodeLineHandler : public DocCodeLineImpl, public BaseHandler<CodeLineHandler>
dimitri's avatar
dimitri committed
829
{
dimitri's avatar
dimitri committed
830
    friend class CodeLineIterator;
dimitri's avatar
dimitri committed
831 832 833 834 835 836
  public:

    virtual void startCodeLine(const QXmlAttributes&);
    virtual void endCodeLine();
    virtual void startLineNumber(const QXmlAttributes&);
    virtual void endLineNumber();
dimitri's avatar
dimitri committed
837 838
    virtual void startHighlight(const QXmlAttributes&);
    virtual void startRef(const QXmlAttributes&);
dimitri's avatar
dimitri committed
839 840 841
    
    CodeLineHandler(IBaseHandler *parent);
    virtual ~CodeLineHandler();
dimitri's avatar
dimitri committed
842

dimitri's avatar
dimitri committed
843
    // IDocCodeLine
dimitri's avatar
dimitri committed
844
    virtual Kind kind() const { return DocImpl::CodeLine; }
dimitri's avatar
dimitri committed
845
    virtual int lineNumber() const { return m_lineNumber; }
dimitri's avatar
dimitri committed
846
    virtual const IString *refId() const { return &m_refId; }
dimitri's avatar
dimitri committed
847
    virtual IDocIterator *codeElements() const;
dimitri's avatar
dimitri committed
848

dimitri's avatar
dimitri committed
849
  private:
dimitri's avatar
dimitri committed
850 851
    void addTextNode();

dimitri's avatar
dimitri committed
852 853
    IBaseHandler   *m_parent;
    int            m_lineNumber;
dimitri's avatar
dimitri committed
854
    StringImpl     m_refId;
dimitri's avatar
dimitri committed
855
    QList<DocImpl> m_children;
dimitri's avatar
dimitri committed
856 857
};

dimitri's avatar
dimitri committed
858
class CodeLineIterator : public BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>
dimitri's avatar
dimitri committed
859 860 861
{
  public:
    CodeLineIterator(const CodeLineHandler &handler) : 
dimitri's avatar
dimitri committed
862
      BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>(handler.m_children) {}
dimitri's avatar
dimitri committed
863 864
};

dimitri's avatar
dimitri committed
865 866 867 868 869
//-----------------------------------------------------------------------------

/*! \brief Node representing a program listing
 *
 */
dimitri's avatar
dimitri committed
870
// children: codeline, linenumber
dimitri's avatar
dimitri committed
871
class ProgramListingHandler : public DocProgramListingImpl, public BaseHandler<ProgramListingHandler>
dimitri's avatar
dimitri committed
872
{
dimitri's avatar
dimitri committed
873
    friend class ProgramListingIterator;
dimitri's avatar
dimitri committed
874 875 876 877 878 879 880 881
  public:
    virtual void startProgramListing(const QXmlAttributes& attrib);
    virtual void endProgramListing();
    virtual void startCodeLine(const QXmlAttributes&);
    virtual void startLineNumber(const QXmlAttributes&);

    ProgramListingHandler(IBaseHandler *parent);
    virtual ~ProgramListingHandler();
dimitri's avatar
dimitri committed
882 883

    // IDocProgramListing
dimitri's avatar
dimitri committed
884
    virtual Kind kind() const { return DocImpl::ProgramListing; }
dimitri's avatar
dimitri committed
885
    virtual IDocIterator *codeLines() const;
dimitri's avatar
dimitri committed
886

dimitri's avatar
dimitri committed
887
  private:
dimitri's avatar
dimitri committed
888 889
    IBaseHandler           *m_parent;
    QList<CodeLineHandler>  m_children;
dimitri's avatar
dimitri committed
890 891 892 893 894
    bool m_hasLineNumber;
};

//-----------------------------------------------------------------------------

dimitri's avatar
dimitri committed
895
class ProgramListingIterator : public BaseIteratorVia<IDocIterator,IDoc,CodeLineHandler,DocImpl>
dimitri's avatar
dimitri committed
896 897 898
{
  public:
    ProgramListingIterator(const ProgramListingHandler &handler) : 
dimitri's avatar
dimitri committed
899
      BaseIteratorVia<IDocIterator,IDoc,CodeLineHandler,DocImpl>(handler.m_children) {}
dimitri's avatar
dimitri committed
900 901 902 903
};

//-----------------------------------------------------------------------------

dimitri's avatar
dimitri committed
904 905 906 907
/*! \brief Node representing a formula.
 *
 */
// children: -
dimitri's avatar
dimitri committed
908
class FormulaHandler : public DocFormulaImpl, public BaseHandler<FormulaHandler>
dimitri's avatar
dimitri committed
909 910 911 912 913 914 915
{
  public:
    FormulaHandler(IBaseHandler *parent);
    virtual ~FormulaHandler();
    void startFormula(const QXmlAttributes& attrib);
    void endFormula();

dimitri's avatar
dimitri committed
916
    // IDocFormula
dimitri's avatar
dimitri committed
917
    virtual Kind kind() const { return DocImpl::Formula; }
dimitri's avatar
dimitri committed
918 919
    virtual const IString *id() const { return &m_id; }
    virtual const IString *text() const { return &m_text; }
dimitri's avatar
dimitri committed
920

dimitri's avatar
dimitri committed
921 922
  private:
    IBaseHandler  *m_parent;
dimitri's avatar
dimitri committed
923 924
    StringImpl     m_id;
    StringImpl     m_text;
dimitri's avatar
dimitri committed
925 926 927 928 929 930 931 932
};

//-----------------------------------------------------------------------------

/*! \brief Node representing an image.
 *
 */
// children: -
dimitri's avatar
dimitri committed
933
class ImageHandler : public DocImageImpl, public BaseHandler<ImageHandler>
dimitri's avatar
dimitri committed
934 935 936 937 938 939 940
{
  public:
    ImageHandler(IBaseHandler *parent);
    virtual ~ImageHandler();
    void startImage(const QXmlAttributes& attrib);
    void endImage();

dimitri's avatar
dimitri committed
941
    // IDocImage
dimitri's avatar
dimitri committed
942
    virtual Kind kind() const { return DocImpl::Image; }
dimitri's avatar
dimitri committed
943 944
    virtual const IString *name() const { return &m_name; }
    virtual const IString *caption() const { return &m_caption; }
dimitri's avatar
dimitri committed
945

dimitri's avatar
dimitri committed
946 947
  private:
    IBaseHandler  *m_parent;
dimitri's avatar
dimitri committed
948 949
    StringImpl     m_name;
    StringImpl     m_caption;
dimitri's avatar
dimitri committed
950 951
};

dimitri's avatar
dimitri committed
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974

//-----------------------------------------------------------------------------
/*! \brief Node representing an anchor.
 *
 */
// children: -
class AnchorHandler : public DocAnchorImpl, public BaseHandler<AnchorHandler>
{
  public:
    AnchorHandler(IBaseHandler *parent);
    virtual ~AnchorHandler();
    void startAnchor(const QXmlAttributes& attrib);
    void endAnchor();

    // IDocAnchor
    virtual Kind kind() const { return DocImpl::Anchor; }
    virtual const IString *id() const { return &m_id; }

  private:
    IBaseHandler  *m_parent;
    StringImpl     m_id;
};

dimitri's avatar
dimitri committed
975 976 977 978 979 980
//-----------------------------------------------------------------------------

/*! \brief Node representing a dot file.
 *
 */
// children: -
dimitri's avatar
dimitri committed
981
class DotFileHandler : public DocDotFileImpl, public BaseHandler<DotFileHandler>
dimitri's avatar
dimitri committed
982 983 984 985 986 987 988
{
  public:
    DotFileHandler(IBaseHandler *parent);
    virtual ~DotFileHandler();
    void startDotFile(const QXmlAttributes& attrib);
    void endDotFile();

dimitri's avatar
dimitri committed
989
    // IDocDotFile
dimitri's avatar
dimitri committed
990
    virtual Kind kind() const { return DocImpl::DotFile; }
dimitri's avatar
dimitri committed
991 992
    virtual const IString *name() const { return &m_name; }
    virtual const IString *caption() const { return &m_caption; }
dimitri's avatar
dimitri committed
993

dimitri's avatar
dimitri committed
994 995
  private:
    IBaseHandler  *m_parent;
dimitri's avatar
dimitri committed
996 997
    StringImpl     m_name;
    StringImpl     m_caption;
dimitri's avatar
dimitri committed
998 999 1000 1001 1002 1003 1004 1005
};

//-----------------------------------------------------------------------------

/*! \brief Node representing an entry in the index.
 *
 */
// children: -
dimitri's avatar
dimitri committed
1006
class IndexEntryHandler : public DocIndexEntryImpl, public BaseHandler<IndexEntryHandler>
dimitri's avatar
dimitri committed
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
{
  public:
    IndexEntryHandler(IBaseHandler *parent);
    virtual ~IndexEntryHandler();
    void startIndexEntry(const QXmlAttributes& attrib);
    void endIndexEntry();
    void startPrimaryIE(const QXmlAttributes& attrib);
    void endPrimaryIE();
    void startSecondaryIE(const QXmlAttributes& attrib);
    void endSecondaryIE();

dimitri's avatar
dimitri committed
1018
    // IDocIndexEntry
dimitri's avatar
dimitri committed
1019
    virtual Kind kind() const { return DocImpl::IndexEntry; }
dimitri's avatar
dimitri committed
1020 1021
    virtual const IString *primary() const { return &m_primary; }
    virtual const IString *secondary() const { return &m_secondary; }
dimitri's avatar
dimitri committed
1022

dimitri's avatar
dimitri committed
1023 1024
  private:
    IBaseHandler  *m_parent;
dimitri's avatar
dimitri committed
1025 1026
    StringImpl     m_primary;
    StringImpl     m_secondary;
dimitri's avatar
dimitri committed
1027 1028 1029 1030
};

//-----------------------------------------------------------------------------

dimitri's avatar
dimitri committed
1031 1032 1033 1034
/*! \brief Node representing an entry in the table entry.
 *
 */
// children: para
dimitri's avatar
dimitri committed
1035
class EntryHandler : public DocEntryImpl, public BaseHandler<EntryHandler>
dimitri's avatar
dimitri committed
1036
{
dimitri's avatar
dimitri committed
1037
    friend class EntryIterator;
dimitri's avatar
dimitri committed
1038 1039 1040 1041 1042 1043 1044
  public:
    EntryHandler(IBaseHandler *parent);
    virtual ~EntryHandler();
    void startEntry(const QXmlAttributes& attrib);
    void endEntry();
    void startParagraph(const QXmlAttributes& attrib);

dimitri's avatar
dimitri committed
1045
    // IDocEntry
dimitri's avatar
dimitri committed
1046
    virtual Kind kind() const { return DocImpl::Entry; }
dimitri's avatar
dimitri committed
1047
    virtual IDocIterator *contents() const;
dimitri's avatar
dimitri committed
1048

dimitri's avatar
dimitri committed
1049 1050
  private:
    IBaseHandler   *m_parent;
dimitri's avatar
dimitri committed
1051
    QList<DocImpl>  m_children;
dimitri's avatar
dimitri committed
1052 1053
};

dimitri's avatar
dimitri committed
1054
class EntryIterator : public BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>
dimitri's avatar
dimitri committed
1055 1056 1057
{
  public:
    EntryIterator(const EntryHandler &handler) : 
dimitri's avatar
dimitri committed
1058
      BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>(handler.m_children) {}
dimitri's avatar
dimitri committed
1059 1060
};

dimitri's avatar
dimitri committed
1061 1062 1063 1064 1065 1066
//-----------------------------------------------------------------------------

/*! \brief Node representing an entry in the table row.
 *
 */
// children: entry
dimitri's avatar
dimitri committed
1067
class RowHandler : public DocRowImpl, public BaseHandler<RowHandler>
dimitri's avatar
dimitri committed
1068
{
dimitri's avatar
dimitri committed
1069
    friend class RowIterator;
dimitri's avatar
dimitri committed
1070 1071 1072 1073 1074 1075 1076
  public:
    RowHandler(IBaseHandler *parent);
    virtual ~RowHandler();
    void startRow(const QXmlAttributes& attrib);
    void endRow();
    void startEntry(const QXmlAttributes& attrib);

dimitri's avatar
dimitri committed
1077
    // IDocRow
dimitri's avatar
dimitri committed
1078
    virtual Kind kind() const { return DocImpl::Row; }
dimitri's avatar
dimitri committed
1079
    virtual IDocIterator *entries() const;
dimitri's avatar
dimitri committed
1080

dimitri's avatar
dimitri committed
1081 1082 1083 1084 1085
  private:
    IBaseHandler        *m_parent;
    QList<EntryHandler>  m_children;
};

dimitri's avatar
dimitri committed
1086
class RowIterator : public BaseIteratorVia<IDocIterator,IDoc,EntryHandler,DocImpl>
dimitri's avatar
dimitri committed
1087 1088 1089
{
  public:
    RowIterator(const RowHandler &handler) : 
dimitri's avatar
dimitri committed
1090
      BaseIteratorVia<IDocIterator,IDoc,EntryHandler,DocImpl>(handler.m_children) {}
dimitri's avatar
dimitri committed
1091 1092
};

dimitri's avatar
dimitri committed
1093 1094 1095 1096 1097
//-----------------------------------------------------------------------------

/*! \brief Node representing an entry in the table.
 *
 */
dimitri's avatar
dimitri committed
1098
// children: row, caption
dimitri's avatar
dimitri committed
1099
class TableHandler : public DocTableImpl, public BaseHandler<TableHandler>
dimitri's avatar
dimitri committed
1100
{
dimitri's avatar
dimitri committed
1101
    friend class TableIterator;
dimitri's avatar
dimitri committed
1102 1103 1104 1105 1106 1107
  public:
    TableHandler(IBaseHandler *parent);
    virtual ~TableHandler();
    void startTable(const QXmlAttributes& attrib);
    void endTable();
    void startRow(const QXmlAttributes& attrib);
dimitri's avatar
dimitri committed
1108 1109
    void startCaption(const QXmlAttributes& attrib);
    void endCaption();
dimitri's avatar
dimitri committed
1110

dimitri's avatar
dimitri committed
1111
    // IDocTable
dimitri's avatar
dimitri committed
1112
    virtual Kind kind() const { return DocImpl::Table; }
dimitri's avatar
dimitri committed
1113 1114
    virtual IDocIterator *rows() const;
    virtual int numColumns() const { return m_numColumns; }
dimitri's avatar
dimitri committed
1115
    virtual const IString *caption() const { return &m_caption; }
dimitri's avatar
dimitri committed
1116

dimitri's avatar
dimitri committed
1117 1118 1119 1120
  private:
    IBaseHandler      *m_parent;
    QList<RowHandler>  m_children;
    int                m_numColumns;
dimitri's avatar
dimitri committed
1121
    StringImpl         m_caption;
dimitri's avatar
dimitri committed
1122 1123
};

dimitri's avatar
dimitri committed
1124
class TableIterator : public BaseIteratorVia<IDocIterator,IDoc,RowHandler,DocImpl>
dimitri's avatar
dimitri committed
1125 1126
{
  public:
dimitri's avatar
dimitri committed
1127
    TableIterator(const TableHandler &handler) : 
dimitri's avatar
dimitri committed
1128
      BaseIteratorVia<IDocIterator,IDoc,RowHandler,DocImpl>(handler.m_children) {}
dimitri's avatar
dimitri committed
1129 1130
};

dimitri's avatar
dimitri committed
1131 1132
//-----------------------------------------------------------------------------

dimitri's avatar
dimitri committed
1133 1134
/*! \brief Node representing a copied piece of documentation.
 *
dimitri's avatar
dimitri committed
1135
 */
dimitri's avatar
dimitri committed
1136
class CopyHandler : public DocCopyImpl, public BaseHandler<CopyHandler>
dimitri's avatar
dimitri committed
1137
{
dimitri's avatar
dimitri committed
1138
    friend class CopyIterator;
dimitri's avatar
dimitri committed
1139
  public:
dimitri's avatar
dimitri committed
1140 1141 1142 1143 1144
    CopyHandler(IBaseHandler *parent);
    virtual ~CopyHandler();
    virtual void startCopy(const QXmlAttributes& attrib);
    virtual void endCopy();
    virtual void startParagraph(const QXmlAttributes& attrib);
dimitri's avatar
dimitri committed
1145

dimitri's avatar
dimitri committed
1146 1147
    // IDocCopy
    virtual Kind kind() const { return DocImpl::Copy; }
dimitri's avatar
dimitri committed
1148 1149 1150 1151 1152 1153 1154
    virtual IDocIterator *contents() const;

  private:
    IBaseHandler   *m_parent;
    QList<DocImpl>  m_children;
};

dimitri's avatar
dimitri committed
1155
class CopyIterator : public BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>
dimitri's avatar
dimitri committed
1156 1157
{
  public:
dimitri's avatar
dimitri committed
1158
    CopyIterator(const CopyHandler &handler) : 
dimitri's avatar
dimitri committed
1159 1160 1161
      BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>(handler.m_children) {}
};

dimitri's avatar
dimitri committed
1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
//-----------------------------------------------------------------------------

/*! \brief Node representing an preformatted section
 */
class VerbatimHandler : public DocVerbatimImpl, 
                        public BaseHandler<VerbatimHandler>
{
  public:
    VerbatimHandler(IBaseHandler *parent);
    virtual ~VerbatimHandler();
dimitri's avatar
dimitri committed
1172
    void startVerbatim(const QXmlAttributes& attrib,Types type);
dimitri's avatar
dimitri committed
1173 1174 1175 1176 1177
    void endVerbatim();

    // IDocVerbatim
    virtual Kind kind() const { return DocImpl::Verbatim; }
    virtual const IString *text() const { return &m_text; }
dimitri's avatar
dimitri committed
1178
    virtual Types type() const { return m_type; }
dimitri's avatar
dimitri committed
1179 1180

  private:
dimitri's avatar
dimitri committed
1181 1182 1183
    IBaseHandler *m_parent;
    StringImpl    m_text;
    Types         m_type;
dimitri's avatar
dimitri committed
1184 1185 1186
};


dimitri's avatar
dimitri committed
1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
//-----------------------------------------------------------------------------

/*! \brief Node representing an special symbol.
 *
 */
// children: -
class SymbolHandler : public DocSymbolImpl, public BaseHandler<SymbolHandler>
{
  public:
    SymbolHandler(IBaseHandler *parent,Types type);
    virtual ~SymbolHandler();
    void startSymbol(const QXmlAttributes& attrib);
    void endSymbol();

    // IDocSymbol
    virtual Kind kind() const   { return DocImpl::Symbol; }
    virtual Types type() const  { return m_type; }
    virtual const IString *typeString() const { return &m_typeString; }
    virtual char letter() const { return m_letter; }

  private:
    IBaseHandler  *m_parent;
    char           m_letter;
    Types          m_type;
    StringImpl     m_typeString;
};

dimitri's avatar
dimitri committed
1214 1215 1216 1217 1218 1219

//-----------------------------------------------------------------------------

/*! \brief Node representing a section.
 *
 */
dimitri's avatar
dimitri committed
1220
// children: title, para, sect(n+1)
dimitri's avatar
dimitri committed
1221
class DocSectionHandler : public DocSectionImpl, public BaseHandler<DocSectionHandler>
dimitri's avatar
dimitri committed
1222
{
dimitri's avatar
dimitri committed
1223 1224
    friend class DocSectionParaIterator;
    friend class DocSectionSubIterator;
dimitri's avatar
dimitri committed
1225 1226 1227 1228 1229
  public:
    DocSectionHandler(IBaseHandler *parent,int level);
    virtual ~DocSectionHandler();
    virtual void startDocSection(const QXmlAttributes& attrib);
    virtual void endDocSection();
dimitri's avatar
dimitri committed
1230 1231 1232 1233
    virtual void startTitle(const QXmlAttributes& attrib);
    virtual void startSubSection(const QXmlAttributes& attrib);
    virtual void startParagraph(const QXmlAttributes& attrib);
    virtual void startInternal(const QXmlAttributes& attrib);
dimitri's avatar
dimitri committed
1234 1235

    // IDocSection
dimitri's avatar
dimitri committed
1236
    virtual Kind kind() const { return DocImpl::Section; }
dimitri's avatar
dimitri committed
1237
    virtual const IString *id() const { return &m_id; }
dimitri's avatar
dimitri committed
1238
    virtual int level() const { return m_level; }
dimitri's avatar
dimitri committed
1239 1240 1241 1242
    virtual IDocTitle *title() const { return m_title; }
    virtual IDocIterator *paragraphs() const;
    virtual IDocIterator *subSections() const;
    virtual IDocInternal *internal() const;
dimitri's avatar
dimitri committed
1243 1244

  private:
dimitri's avatar
dimitri committed
1245 1246 1247 1248 1249 1250 1251
    IBaseHandler    *m_parent;
    QList<DocImpl>   m_paragraphs;
    QList<DocImpl>   m_subsections;
    DocInternalHandler *m_internal;
    StringImpl       m_id;
    int              m_level;
    TitleHandler    *m_title;
dimitri's avatar
dimitri committed
1252 1253
};

dimitri's avatar
dimitri committed
1254
class DocSectionParaIterator : public BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>
dimitri's avatar
dimitri committed
1255 1256
{
  public:
dimitri's avatar
dimitri committed
1257 1258 1259 1260 1261 1262 1263 1264 1265
    DocSectionParaIterator(const DocSectionHandler &handler) : 
      BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>(handler.m_paragraphs) {}
};

class DocSectionSubIterator : public BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>
{
  public:
    DocSectionSubIterator(const DocSectionHandler &handler) : 
      BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>(handler.m_subsections) {}
dimitri's avatar
dimitri committed
1266 1267
};

dimitri's avatar
dimitri committed
1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308
//-----------------------------------------------------------------------------

class DocInternalHandler : public DocInternalImpl, public BaseHandler<DocInternalHandler>
{
  public:
    friend class DocInternalParaIterator;
    friend class DocInternalSubIterator;
    DocInternalHandler(IBaseHandler *parent,int level);
    virtual ~DocInternalHandler();
    virtual void startInternal(const QXmlAttributes& attrib);
    virtual void endInternal();
    virtual void startSubSection(const QXmlAttributes& attrib);
    virtual void startParagraph(const QXmlAttributes& attrib);

    // IDocInternal
    virtual Kind kind() const { return DocImpl::Internal; }
    virtual IDocIterator *paragraphs() const;
    virtual IDocIterator *subSections() const;

  private:
    IBaseHandler    *m_parent;
    QList<DocImpl>   m_paragraphs;
    QList<DocImpl>   m_subsections;
    int              m_level;
};

class DocInternalParaIterator : public BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>
{
  public:
    DocInternalParaIterator(const DocInternalHandler &handler) : 
      BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>(handler.m_paragraphs) {}
};

class DocInternalSubIterator : public BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>
{
  public:
    DocInternalSubIterator(const DocInternalHandler &handler) : 
      BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>(handler.m_subsections) {}
};


dimitri's avatar
dimitri committed
1309
//-----------------------------------------------------------------------------
dimitri's avatar
dimitri committed
1310

dimitri's avatar
dimitri committed
1311 1312 1313
/*! \brief Node representing a documentation block.
 *
 */
dimitri's avatar
dimitri committed
1314
// children: para, title, sect1, internal
dimitri's avatar
dimitri committed
1315
class DocHandler : public DocRootImpl, public BaseHandler<DocHandler>
dimitri's avatar
dimitri committed
1316
{
dimitri's avatar
dimitri committed
1317
    friend class DocIterator;
dimitri's avatar
dimitri committed
1318 1319 1320 1321
  public:
    virtual void startDoc(const QXmlAttributes& attrib);
    virtual void endDoc();
    virtual void startParagraph(const QXmlAttributes& attrib);
dimitri's avatar
dimitri committed
1322 1323
    virtual void startSect1(const QXmlAttributes& attrib);
    virtual void startTitle(const QXmlAttributes& attrib);
dimitri's avatar
dimitri committed
1324
    virtual void startInternal(const QXmlAttributes& attrib);
dimitri's avatar
dimitri committed
1325 1326 1327

    DocHandler(IBaseHandler *parent);
    virtual ~DocHandler();
dimitri's avatar
dimitri committed
1328
    
dimitri's avatar
dimitri committed
1329
    // IDocRoot
dimitri's avatar
dimitri committed
1330
    virtual Kind kind() const { return DocImpl::Root; }
dimitri's avatar
dimitri committed
1331
    virtual IDocIterator *contents() const;
dimitri's avatar
dimitri committed
1332
    virtual IDocInternal *internal() const;
dimitri's avatar
dimitri committed
1333

dimitri's avatar
dimitri committed
1334 1335
  private:
    IBaseHandler *m_parent;
dimitri's avatar
dimitri committed
1336
    QList<DocImpl> m_children;
dimitri's avatar
dimitri committed
1337
    DocInternalHandler *m_internal;
dimitri's avatar
dimitri committed
1338 1339
};

dimitri's avatar
dimitri committed
1340
class DocIterator : public BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>
dimitri's avatar
dimitri committed
1341 1342 1343
{
  public:
    DocIterator(const DocHandler &handler) : 
dimitri's avatar
dimitri committed
1344
      BaseIteratorVia<IDocIterator,IDoc,DocImpl,DocImpl>(handler.m_children) {}
dimitri's avatar
dimitri committed
1345 1346
};

dimitri's avatar
dimitri committed
1347 1348
//-----------------------------------------------------------------------------

dimitri's avatar
dimitri committed
1349 1350 1351
void dochandler_init();
void dochandler_exit();

dimitri's avatar
dimitri committed
1352
#endif