XmlDocVisitor Class Reference

Concrete visitor implementation for XML output. More...

#include <xmldocvisitor.h>

Inheritance diagram for XmlDocVisitor:

Public Member Functions
	XmlDocVisitor (FTextStream &t, CodeOutputInterface &ci)
void	visit (DocWord *)
void	visit (DocLinkedWord *)
void	visit (DocWhiteSpace *)
void	visit (DocSymbol *)
void	visit (DocURL *)
void	visit (DocLineBreak *)
void	visit (DocHorRuler *)
void	visit (DocStyleChange *)
void	visit (DocVerbatim *)
void	visit (DocAnchor *)
void	visit (DocInclude *)
void	visit (DocIncOperator *)
void	visit (DocFormula *)
void	visit (DocIndexEntry *)
void	visit (DocSimpleSectSep *)
void	visit (DocCite *)
void	visitPre (DocAutoList *)
void	visitPost (DocAutoList *)
void	visitPre (DocAutoListItem *)
void	visitPost (DocAutoListItem *)
void	visitPre (DocPara *)
void	visitPost (DocPara *)
void	visitPre (DocRoot *)
void	visitPost (DocRoot *)
void	visitPre (DocSimpleSect *)
void	visitPost (DocSimpleSect *)
void	visitPre (DocTitle *)
void	visitPost (DocTitle *)
void	visitPre (DocSimpleList *)
void	visitPost (DocSimpleList *)
void	visitPre (DocSimpleListItem *)
void	visitPost (DocSimpleListItem *)
void	visitPre (DocSection *)
void	visitPost (DocSection *)
void	visitPre (DocHtmlList *)
void	visitPost (DocHtmlList *)
void	visitPre (DocHtmlListItem *)
void	visitPost (DocHtmlListItem *)
void	visitPre (DocHtmlDescList *)
void	visitPost (DocHtmlDescList *)
void	visitPre (DocHtmlDescTitle *)
void	visitPost (DocHtmlDescTitle *)
void	visitPre (DocHtmlDescData *)
void	visitPost (DocHtmlDescData *)
void	visitPre (DocHtmlTable *)
void	visitPost (DocHtmlTable *)
void	visitPre (DocHtmlRow *)
void	visitPost (DocHtmlRow *)
void	visitPre (DocHtmlCell *)
void	visitPost (DocHtmlCell *)
void	visitPre (DocHtmlCaption *)
void	visitPost (DocHtmlCaption *)
void	visitPre (DocInternal *)
void	visitPost (DocInternal *)
void	visitPre (DocHRef *)
void	visitPost (DocHRef *)
void	visitPre (DocHtmlHeader *)
void	visitPost (DocHtmlHeader *)
void	visitPre (DocImage *)
void	visitPost (DocImage *)
void	visitPre (DocDotFile *)
void	visitPost (DocDotFile *)
void	visitPre (DocMscFile *)
void	visitPost (DocMscFile *)
void	visitPre (DocDiaFile *)
void	visitPost (DocDiaFile *)
void	visitPre (DocLink *)
void	visitPost (DocLink *)
void	visitPre (DocRef *)
void	visitPost (DocRef *)
void	visitPre (DocSecRefItem *)
void	visitPost (DocSecRefItem *)
void	visitPre (DocSecRefList *)
void	visitPost (DocSecRefList *)
void	visitPre (DocParamSect *)
void	visitPost (DocParamSect *)
void	visitPre (DocParamList *)
void	visitPost (DocParamList *)
void	visitPre (DocXRefItem *)
void	visitPost (DocXRefItem *)
void	visitPre (DocInternalRef *)
void	visitPost (DocInternalRef *)
void	visitPre (DocCopy *)
void	visitPost (DocCopy *)
void	visitPre (DocText *)
void	visitPost (DocText *)
void	visitPre (DocHtmlBlockQuote *)
void	visitPost (DocHtmlBlockQuote *)
void	visitPre (DocVhdlFlow *)
void	visitPost (DocVhdlFlow *)
void	visitPre (DocParBlock *)
void	visitPost (DocParBlock *)
Public Member Functions inherited from DocVisitor
	DocVisitor (int id)
virtual	~DocVisitor ()
int	id () const

Private Member Functions
void	filter (const char *str)
void	startLink (const QCString &ref, const QCString &file, const QCString &anchor)
void	endLink ()
void	pushEnabled ()
void	popEnabled ()

Private Attributes
FTextStream &	m_t
CodeOutputInterface &	m_ci
bool	m_insidePre
bool	m_hide
QStack< bool >	m_enabled
QCString	m_langExt

Detailed Description

Concrete visitor implementation for XML output.

Definition at line 31 of file xmldocvisitor.h.

Constructor & Destructor Documentation

XmlDocVisitor::XmlDocVisitor	(	FTextStream &	t,
		CodeOutputInterface &	ci
	)

Definition at line 86 of file xmldocvisitor.cpp.

  : DocVisitor(DocVisitor_XML), m_t(t), m_ci(ci), m_insidePre(FALSE), m_hide(FALSE) 
{
}

Member Function Documentation

void XmlDocVisitor::endLink ( )

private

Definition at line 1049 of file xmldocvisitor.cpp.

{
  m_t << "</ref>";
}

void XmlDocVisitor::filter ( const char *  str )

private

Definition at line 1032 of file xmldocvisitor.cpp.

{ 
  m_t << convertToXML(str);
}

void XmlDocVisitor::popEnabled ( )

private

Definition at line 1059 of file xmldocvisitor.cpp.

{
  bool *v=m_enabled.pop();
  ASSERT(v!=0);
  m_hide = *v;
  delete v;
}

void XmlDocVisitor::pushEnabled ( )

private

Definition at line 1054 of file xmldocvisitor.cpp.

{
  m_enabled.push(new bool(m_hide));
}

void XmlDocVisitor::startLink ( const QCString &  ref, const QCString &  file, const QCString &  anchor  )

private

Definition at line 1037 of file xmldocvisitor.cpp.

{
  //printf("XmlDocVisitor: file=%s anchor=%s\n",file.data(),anchor.data());
  m_t << "<ref refid=\"" << file;
  if (!anchor.isEmpty()) m_t << "_1" << anchor;
  m_t << "\" kindref=\"";
  if (!anchor.isEmpty()) m_t << "member"; else m_t << "compound";
  m_t << "\"";
  if (!ref.isEmpty()) m_t << " external=\"" << ref << "\"";
  m_t << ">";
}

void XmlDocVisitor::visit ( DocWord *  w )

virtual

Implements DocVisitor.

Definition at line 95 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  filter(w->word());
}

void XmlDocVisitor::visit ( DocLinkedWord *  w )

virtual

Implements DocVisitor.

Definition at line 101 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  startLink(w->ref(),w->file(),w->anchor());
  filter(w->word());
  endLink();
}

void XmlDocVisitor::visit ( DocWhiteSpace *  w )

virtual

Implements DocVisitor.

Definition at line 109 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  if (m_insidePre)
  {
    m_t << w->chars();
  }
  else
  {
    m_t << " ";
  }
}

void XmlDocVisitor::visit ( DocSymbol *  s )

virtual

Implements DocVisitor.

Definition at line 122 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  const char *res = HtmlEntityMapper::instance()->xml(s->symbol());
  if (res)
  {
    m_t << res;
  }
  else
  {
    err("XML: non supported HTML-entity found: %s\n",HtmlEntityMapper::instance()->html(s->symbol(),TRUE));
  }
}

void XmlDocVisitor::visit ( DocURL *  u )

virtual

Implements DocVisitor.

Definition at line 136 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<ulink url=\""; 
  if (u->isEmail()) m_t << "mailto:";
  filter(u->url());
  m_t << "\">";
  filter(u->url());
  m_t << "</ulink>";
}

void XmlDocVisitor::visit ( DocLineBreak *  )

virtual

Implements DocVisitor.

Definition at line 147 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<linebreak/>\n";
}

void XmlDocVisitor::visit ( DocHorRuler *  )

virtual

Implements DocVisitor.

Definition at line 153 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<hruler/>\n";
}

void XmlDocVisitor::visit ( DocStyleChange *  s )

virtual

Implements DocVisitor.

Definition at line 159 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  switch (s->style())
  {
    case DocStyleChange::Bold:
      if (s->enable()) m_t << "<bold>";      else m_t << "</bold>";
      break;
    case DocStyleChange::Italic:
      if (s->enable()) m_t << "<emphasis>";     else m_t << "</emphasis>";
      break;
    case DocStyleChange::Code:
      if (s->enable()) m_t << "<computeroutput>";   else m_t << "</computeroutput>";
      break;
    case DocStyleChange::Subscript:
      if (s->enable()) m_t << "<subscript>";    else m_t << "</subscript>";
      break;
    case DocStyleChange::Superscript:
      if (s->enable()) m_t << "<superscript>";    else m_t << "</superscript>";
      break;
    case DocStyleChange::Center:
      if (s->enable()) m_t << "<center>"; else m_t << "</center>";
      break;
    case DocStyleChange::Small:
      if (s->enable()) m_t << "<small>";  else m_t << "</small>";
      break;
    case DocStyleChange::Preformatted:
      if (s->enable()) 
      {
        m_t << "<preformatted>";  
        m_insidePre=TRUE;
      }
      else 
      {
        m_t << "</preformatted>";
        m_insidePre=FALSE;
      }
      break;
    case DocStyleChange::Div:  /* HTML only */ break;
    case DocStyleChange::Span: /* HTML only */ break;
  }
}

void XmlDocVisitor::visit ( DocVerbatim *  s )

virtual

Implements DocVisitor.

Definition at line 202 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  QCString lang = m_langExt;
  if (!s->language().isEmpty()) // explicit language setting
  {
    lang = s->language();
  }
  SrcLangExt langExt = getLanguageFromFileName(lang);
  switch(s->type())
  {
    case DocVerbatim::Code: // fall though
      m_t << "<programlisting>"; 
      Doxygen::parserManager->getParser(lang)
                            ->parseCode(m_ci,s->context(),s->text(),langExt,
                                        s->isExample(),s->exampleFile());
      m_t << "</programlisting>"; 
      break;
    case DocVerbatim::Verbatim: 
      m_t << "<verbatim>";
      filter(s->text());
      m_t << "</verbatim>"; 
      break;
    case DocVerbatim::HtmlOnly: 
    case DocVerbatim::RtfOnly: 
    case DocVerbatim::ManOnly: 
    case DocVerbatim::LatexOnly: 
    case DocVerbatim::DocbookOnly:
      /* nothing */ 
      break;
    case DocVerbatim::XmlOnly: 
      m_t << s->text();
      break;
    case DocVerbatim::Dot:
      visitPreStart(m_t, "dot", s->hasCaption(), this, s->children(), QCString(""), FALSE, DocImage::Html, s->width(), s->height());
      filter(s->text());
      visitPostEnd(m_t, "dot");
      break;
    case DocVerbatim::Msc:
      visitPreStart(m_t, "msc", s->hasCaption(), this, s->children(),  QCString(""), FALSE, DocImage::Html, s->width(), s->height());
      filter(s->text());
      visitPostEnd(m_t, "msc");
      break;
    case DocVerbatim::PlantUML:
      visitPreStart(m_t, "plantuml", s->hasCaption(), this, s->children(),  QCString(""), FALSE, DocImage::Html, s->width(), s->height());
      filter(s->text());
      visitPostEnd(m_t, "plantuml");
      break;
  }
}

void XmlDocVisitor::visit ( DocAnchor *  anc )

virtual

Implements DocVisitor.

Definition at line 253 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<anchor id=\"" << anc->file() << "_1" << anc->anchor() << "\"/>";
}

void XmlDocVisitor::visit ( DocInclude *  inc )

virtual

Implements DocVisitor.

Definition at line 259 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  SrcLangExt langExt = getLanguageFromFileName(inc->extension());
  switch(inc->type())
  {
    case DocInclude::IncWithLines:
      { 
         m_t << "<programlisting>";
         QFileInfo cfi( inc->file() );
         FileDef fd( cfi.dirPath().utf8(), cfi.fileName().utf8() );
         Doxygen::parserManager->getParser(inc->extension())
                               ->parseCode(m_ci,inc->context(),
                                           inc->text(),
                                           langExt,
                                           inc->isExample(),
                                           inc->exampleFile(), &fd);
         m_t << "</programlisting>"; 
      }
      break;    
    case DocInclude::Include: 
      m_t << "<programlisting>";
      Doxygen::parserManager->getParser(inc->extension())
                            ->parseCode(m_ci,inc->context(),
                                        inc->text(),
                                        langExt,
                                        inc->isExample(),
                                        inc->exampleFile());
      m_t << "</programlisting>"; 
      break;
    case DocInclude::DontInclude: 
      break;
    case DocInclude::HtmlInclude: 
      m_t << "<htmlonly>";
      filter(inc->text());
      m_t << "</htmlonly>";
      break;
    case DocInclude::LatexInclude:
      m_t << "<latexonly>";
      filter(inc->text());
      m_t << "</latexonly>";
      break;
    case DocInclude::VerbInclude: 
      m_t << "<verbatim>";
      filter(inc->text());
      m_t << "</verbatim>"; 
      break;
    case DocInclude::Snippet:
      m_t << "<programlisting>";
      Doxygen::parserManager->getParser(inc->extension())
                            ->parseCode(m_ci,
                                        inc->context(),
                                        extractBlock(inc->text(),inc->blockId()),
                                        langExt,
                                        inc->isExample(),
                                        inc->exampleFile()
                                       );
      m_t << "</programlisting>"; 
      break;
  }
}

void XmlDocVisitor::visit ( DocIncOperator *  op )

virtual

Implements DocVisitor.

Definition at line 321 of file xmldocvisitor.cpp.

{
  //printf("DocIncOperator: type=%d first=%d, last=%d text=`%s'\n",
  //    op->type(),op->isFirst(),op->isLast(),op->text().data());
  if (op->isFirst()) 
  {
    if (!m_hide)
    {
      m_t << "<programlisting>";
    }
    pushEnabled();
    m_hide = TRUE;
  }
  SrcLangExt langExt = getLanguageFromFileName(m_langExt);
  if (op->type()!=DocIncOperator::Skip) 
  {
    popEnabled();
    if (!m_hide) 
    {
      Doxygen::parserManager->getParser(m_langExt)
                            ->parseCode(m_ci,op->context(),
                                        op->text(),langExt,op->isExample(),
                                        op->exampleFile());
    }
    pushEnabled();
    m_hide=TRUE;
  }
  if (op->isLast())  
  {
    popEnabled();
    if (!m_hide) m_t << "</programlisting>"; 
  }
  else
  {
    if (!m_hide) m_t << endl;
  }
}

void XmlDocVisitor::visit ( DocFormula *  f )

virtual

Implements DocVisitor.

Definition at line 359 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<formula id=\"" << f->id() << "\">";
  filter(f->text());
  m_t << "</formula>";
}

void XmlDocVisitor::visit ( DocIndexEntry *  ie )

virtual

Implements DocVisitor.

Definition at line 367 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<indexentry>"
           "<primaryie>";
  filter(ie->entry());
  m_t << "</primaryie>"
           "<secondaryie></secondaryie>"
         "</indexentry>";
}

void XmlDocVisitor::visit ( DocSimpleSectSep *  sep )

virtual

Implements DocVisitor.

Definition at line 378 of file xmldocvisitor.cpp.

{
  if (sep->parent() && sep->parent()->kind()==DocNode::Kind_SimpleSect)
  {
    visitPost((DocSimpleSect*)sep->parent()); // end current section
    visitPre((DocSimpleSect*)sep->parent());  // start new section
  }
}

void XmlDocVisitor::visit ( DocCite *  cite )

virtual

Implements DocVisitor.

Definition at line 387 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  if (!cite->file().isEmpty()) startLink(cite->ref(),cite->file(),cite->anchor());
  filter(cite->text());
  if (!cite->file().isEmpty()) endLink();
}

void XmlDocVisitor::visitPost ( DocAutoList *  l )

virtual

Implements DocVisitor.

Definition at line 412 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  if (l->isEnumList())
  {
    m_t << "</orderedlist>\n";
  }
  else
  {
    m_t << "</itemizedlist>\n";
  }
}

void XmlDocVisitor::visitPost ( DocAutoListItem *  )

virtual

Implements DocVisitor.

Definition at line 431 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</listitem>";
}

void XmlDocVisitor::visitPost ( DocPara *  )

virtual

Implements DocVisitor.

Definition at line 443 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</para>";
}

void XmlDocVisitor::visitPost ( DocRoot *  )

virtual

Implements DocVisitor.

Definition at line 454 of file xmldocvisitor.cpp.

{
  //m_t << "<hr><h4><font color=\"red\">Old parser:</font></h4>\n";
}

void XmlDocVisitor::visitPost ( DocSimpleSect *  )

virtual

Implements DocVisitor.

Definition at line 504 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</simplesect>\n";
}

void XmlDocVisitor::visitPost ( DocTitle *  )

virtual

Implements DocVisitor.

Definition at line 516 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</title>";
}

void XmlDocVisitor::visitPost ( DocSimpleList *  )

virtual

Implements DocVisitor.

Definition at line 528 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</itemizedlist>\n";
}

void XmlDocVisitor::visitPost ( DocSimpleListItem *  )

virtual

Implements DocVisitor.

Definition at line 540 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</listitem>\n";
}

void XmlDocVisitor::visitPost ( DocSection *  s )

virtual

Implements DocVisitor.

Definition at line 557 of file xmldocvisitor.cpp.

{
  m_t << "</sect" << s->level() << ">\n";
}

void XmlDocVisitor::visitPost ( DocHtmlList *  s )

virtual

Implements DocVisitor.

Definition at line 571 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  if (s->type()==DocHtmlList::Ordered) 
    m_t << "</orderedlist>\n"; 
  else 
    m_t << "</itemizedlist>\n";
}

void XmlDocVisitor::visitPost ( DocHtmlListItem *  )

virtual

Implements DocVisitor.

Definition at line 586 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</listitem>\n";
}

void XmlDocVisitor::visitPost ( DocHtmlDescList *  )

virtual

Implements DocVisitor.

Definition at line 598 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</variablelist>\n";
}

void XmlDocVisitor::visitPost ( DocHtmlDescTitle *  )

virtual

Implements DocVisitor.

Definition at line 610 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</term></varlistentry>\n";
}

void XmlDocVisitor::visitPost ( DocHtmlDescData *  )

virtual

Implements DocVisitor.

Definition at line 622 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</listitem>\n";
}

void XmlDocVisitor::visitPost ( DocHtmlTable *  )

virtual

Implements DocVisitor.

Definition at line 635 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</table>\n";
}

void XmlDocVisitor::visitPost ( DocHtmlRow *  )

virtual

Implements DocVisitor.

Definition at line 647 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</row>\n";
}

void XmlDocVisitor::visitPost ( DocHtmlCell *  )

virtual

Implements DocVisitor.

Definition at line 659 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</entry>"; 
}

void XmlDocVisitor::visitPost ( DocHtmlCaption *  )

virtual

Implements DocVisitor.

Definition at line 671 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</caption>\n";
}

void XmlDocVisitor::visitPost ( DocInternal *  )

virtual

Implements DocVisitor.

Definition at line 683 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</internal>" << endl;
}

void XmlDocVisitor::visitPost ( DocHRef *  )

virtual

Implements DocVisitor.

Definition at line 697 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</ulink>";
}

void XmlDocVisitor::visitPost ( DocHtmlHeader *  )

virtual

Implements DocVisitor.

Definition at line 709 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</heading>\n";
}

void XmlDocVisitor::visitPost ( DocImage *  )

virtual

Implements DocVisitor.

Definition at line 743 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  visitPostEnd(m_t, "image");
}

void XmlDocVisitor::visitPost ( DocDotFile *  )

virtual

Implements DocVisitor.

Definition at line 755 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  visitPostEnd(m_t, "dotfile");
}

void XmlDocVisitor::visitPost ( DocMscFile *  )

virtual

Implements DocVisitor.

Definition at line 767 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  visitPostEnd(m_t, "mscfile");
}

void XmlDocVisitor::visitPost ( DocDiaFile *  )

virtual

Implements DocVisitor.

Definition at line 779 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  visitPostEnd(m_t, "diafile");
}

void XmlDocVisitor::visitPost ( DocLink *  )

virtual

Implements DocVisitor.

Definition at line 791 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  endLink();
}

void XmlDocVisitor::visitPost ( DocRef *  ref )

virtual

Implements DocVisitor.

Definition at line 807 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  if (!ref->file().isEmpty()) endLink();
  //m_t << " ";
}

void XmlDocVisitor::visitPost ( DocSecRefItem *  )

virtual

Implements DocVisitor.

Definition at line 820 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</tocitem>" << endl;
}

void XmlDocVisitor::visitPost ( DocSecRefList *  )

virtual

Implements DocVisitor.

Definition at line 832 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</toclist>" << endl;
}

void XmlDocVisitor::visitPost ( DocParamSect *  )

virtual

Implements DocVisitor.

Definition at line 870 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</parameterlist>" << endl;
}

void XmlDocVisitor::visitPost ( DocParamList *  )

virtual

Implements DocVisitor.

Definition at line 938 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</parameterdescription>" << endl;
  m_t << "</parameteritem>" << endl;
}

void XmlDocVisitor::visitPost ( DocXRefItem *  x )

virtual

Implements DocVisitor.

Definition at line 958 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  if (x->title().isEmpty()) return;
  m_t << "</xrefdescription>";
  m_t << "</xrefsect>";
}

void XmlDocVisitor::visitPost ( DocInternalRef *  )

virtual

Implements DocVisitor.

Definition at line 972 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  endLink();
  m_t << " ";
}

void XmlDocVisitor::visitPost ( DocCopy *  )

virtual

Implements DocVisitor.

Definition at line 985 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</copydoc>" << endl;
}

void XmlDocVisitor::visitPost ( DocText *  )

virtual

Implements DocVisitor.

Definition at line 995 of file xmldocvisitor.cpp.

{
}

void XmlDocVisitor::visitPost ( DocHtmlBlockQuote *  )

virtual

Implements DocVisitor.

Definition at line 1005 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</blockquote>";
}

void XmlDocVisitor::visitPost ( DocVhdlFlow *  )

virtual

Implements DocVisitor.

Definition at line 1015 of file xmldocvisitor.cpp.

{
}

void XmlDocVisitor::visitPost ( DocParBlock *  )

virtual

Implements DocVisitor.

Definition at line 1025 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "</parblock>";
}

void XmlDocVisitor::visitPre ( DocAutoList *  l )

virtual

Implements DocVisitor.

Definition at line 399 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  if (l->isEnumList())
  {
    m_t << "<orderedlist>\n";
  }
  else
  {
    m_t << "<itemizedlist>\n";
  }
}

void XmlDocVisitor::visitPre ( DocAutoListItem *  )

virtual

Implements DocVisitor.

Definition at line 425 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<listitem>";
}

void XmlDocVisitor::visitPre ( DocPara *  )

virtual

Implements DocVisitor.

Definition at line 437 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<para>";
}

void XmlDocVisitor::visitPre ( DocRoot *  )

virtual

Implements DocVisitor.

Definition at line 449 of file xmldocvisitor.cpp.

{
  //m_t << "<hr><h4><font color=\"red\">New parser:</font></h4>\n";
}

void XmlDocVisitor::visitPre ( DocSimpleSect *  s )

virtual

Implements DocVisitor.

Definition at line 459 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<simplesect kind=\"";
  switch(s->type())
  {
    case DocSimpleSect::See: 
      m_t << "see"; break;
    case DocSimpleSect::Return: 
      m_t << "return"; break;
    case DocSimpleSect::Author: 
      m_t << "author"; break;
    case DocSimpleSect::Authors: 
      m_t << "authors"; break;
    case DocSimpleSect::Version: 
      m_t << "version"; break;
    case DocSimpleSect::Since: 
      m_t << "since"; break;
    case DocSimpleSect::Date: 
      m_t << "date"; break;
    case DocSimpleSect::Note: 
      m_t << "note"; break;
    case DocSimpleSect::Warning:
      m_t << "warning"; break;
    case DocSimpleSect::Pre:
      m_t << "pre"; break;
    case DocSimpleSect::Post:
      m_t << "post"; break;
    case DocSimpleSect::Copyright:
      m_t << "copyright"; break;
    case DocSimpleSect::Invar:
      m_t << "invariant"; break;
    case DocSimpleSect::Remark:
      m_t << "remark"; break;
    case DocSimpleSect::Attention:
      m_t << "attention"; break;
    case DocSimpleSect::User: 
      m_t << "par"; break;
    case DocSimpleSect::Rcs: 
      m_t << "rcs"; break;
    case DocSimpleSect::Unknown:  break;
  }
  m_t << "\">";
}

void XmlDocVisitor::visitPre ( DocTitle *  )

virtual

Implements DocVisitor.

Definition at line 510 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<title>";
}

void XmlDocVisitor::visitPre ( DocSimpleList *  )

virtual

Implements DocVisitor.

Definition at line 522 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<itemizedlist>\n";
}

void XmlDocVisitor::visitPre ( DocSimpleListItem *  )

virtual

Implements DocVisitor.

Definition at line 534 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<listitem>";
}

void XmlDocVisitor::visitPre ( DocSection *  s )

virtual

Implements DocVisitor.

Definition at line 546 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<sect" << s->level() << " id=\"" << s->file();
  if (!s->anchor().isEmpty()) m_t << "_1" << s->anchor();
  m_t << "\">" << endl;
  m_t << "<title>";
  filter(convertCharEntitiesToUTF8(s->title()));
  m_t << "</title>" << endl;
}

void XmlDocVisitor::visitPre ( DocHtmlList *  s )

virtual

Implements DocVisitor.

Definition at line 562 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  if (s->type()==DocHtmlList::Ordered) 
    m_t << "<orderedlist>\n"; 
  else 
    m_t << "<itemizedlist>\n";
}

void XmlDocVisitor::visitPre ( DocHtmlListItem *  )

virtual

Implements DocVisitor.

Definition at line 580 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<listitem>\n";
}

void XmlDocVisitor::visitPre ( DocHtmlDescList *  )

virtual

Implements DocVisitor.

Definition at line 592 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<variablelist>\n";
}

void XmlDocVisitor::visitPre ( DocHtmlDescTitle *  )

virtual

Implements DocVisitor.

Definition at line 604 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<varlistentry><term>";
}

void XmlDocVisitor::visitPre ( DocHtmlDescData *  )

virtual

Implements DocVisitor.

Definition at line 616 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<listitem>";
}

void XmlDocVisitor::visitPre ( DocHtmlTable *  t )

virtual

Implements DocVisitor.

Definition at line 628 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<table rows=\"" << t->numRows() 
      << "\" cols=\"" << t->numColumns() << "\">" ;
}

void XmlDocVisitor::visitPre ( DocHtmlRow *  )

virtual

Implements DocVisitor.

Definition at line 641 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<row>\n";
}

void XmlDocVisitor::visitPre ( DocHtmlCell *  c )

virtual

Implements DocVisitor.

Definition at line 653 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  if (c->isHeading()) m_t << "<entry thead=\"yes\">"; else m_t << "<entry thead=\"no\">";
}

void XmlDocVisitor::visitPre ( DocHtmlCaption *  )

virtual

Implements DocVisitor.

Definition at line 665 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<caption>";
}

void XmlDocVisitor::visitPre ( DocInternal *  )

virtual

Implements DocVisitor.

Definition at line 677 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<internal>";
}

void XmlDocVisitor::visitPre ( DocHRef *  href )

virtual

Implements DocVisitor.

Definition at line 689 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<ulink url=\"";
  filter(href->url());
  m_t << "\">";
}

void XmlDocVisitor::visitPre ( DocHtmlHeader *  header )

virtual

Implements DocVisitor.

Definition at line 703 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<heading level=\"" << header->level() << "\">";
}

void XmlDocVisitor::visitPre ( DocImage *  img )

virtual

Implements DocVisitor.

Definition at line 715 of file xmldocvisitor.cpp.

{
  if (m_hide) return;

  QCString baseName=img->name();
  int i;
  if ((i=baseName.findRev('/'))!=-1 || (i=baseName.findRev('\\'))!=-1)
  {
    baseName=baseName.right(baseName.length()-i-1);
  }
  visitPreStart(m_t, "image", FALSE, this, img->children(), baseName, TRUE, img->type(), img->width(), img->height());

  // copy the image to the output dir
  QFile inImage(img->name());
  QFile outImage(Config_getString("XML_OUTPUT")+"/"+baseName.data());
  if (inImage.open(IO_ReadOnly))
  {
    if (outImage.open(IO_WriteOnly))
    {
      char *buffer = new char[inImage.size()];
      inImage.readBlock(buffer,inImage.size());
      outImage.writeBlock(buffer,inImage.size());
      outImage.flush();
      delete[] buffer;
    }
  }
}

void XmlDocVisitor::visitPre ( DocDotFile *  df )

virtual

Implements DocVisitor.

Definition at line 749 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  visitPreStart(m_t, "dotfile", FALSE, this, df->children(), df->file(), FALSE, DocImage::Html, df->width(), df->height());
}

void XmlDocVisitor::visitPre ( DocMscFile *  df )

virtual

Implements DocVisitor.

Definition at line 761 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  visitPreStart(m_t, "mscfile", FALSE, this, df->children(), df->file(), FALSE, DocImage::Html, df->width(), df->height());
}

void XmlDocVisitor::visitPre ( DocDiaFile *  df )

virtual

Implements DocVisitor.

Definition at line 773 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  visitPreStart(m_t, "diafile", FALSE, this, df->children(), df->file(), FALSE, DocImage::Html, df->width(), df->height());
}

void XmlDocVisitor::visitPre ( DocLink *  lnk )

virtual

Implements DocVisitor.

Definition at line 785 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  startLink(lnk->ref(),lnk->file(),lnk->anchor());
}

void XmlDocVisitor::visitPre ( DocRef *  ref )

virtual

Implements DocVisitor.

Definition at line 797 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  if (!ref->file().isEmpty()) 
  {
    startLink(ref->ref(),ref->file(),ref->isSubPage() ? QCString() : ref->anchor());
  }
  if (!ref->hasLinkText()) filter(ref->targetTitle());
}

void XmlDocVisitor::visitPre ( DocSecRefItem *  ref )

virtual

Implements DocVisitor.

Definition at line 814 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<tocitem id=\"" << ref->file() << "_1" << ref->anchor() << "\">";
}

void XmlDocVisitor::visitPre ( DocSecRefList *  )

virtual

Implements DocVisitor.

Definition at line 826 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<toclist>" << endl;
}

void XmlDocVisitor::visitPre ( DocParamSect *  s )

virtual

Implements DocVisitor.

Definition at line 850 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<parameterlist kind=\"";
  switch(s->type())
  {
    case DocParamSect::Param: 
      m_t << "param"; break;
    case DocParamSect::RetVal: 
      m_t << "retval"; break;
    case DocParamSect::Exception: 
      m_t << "exception"; break;
    case DocParamSect::TemplateParam: 
      m_t << "templateparam"; break;
    default:
      ASSERT(0);
  }
  m_t << "\">";
}

void XmlDocVisitor::visitPre ( DocParamList *  pl )

virtual

Implements DocVisitor.

Definition at line 876 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<parameteritem>" << endl;
  m_t << "<parameternamelist>" << endl;
  //QStrListIterator li(pl->parameters());
  //const char *s;
  QListIterator<DocNode> li(pl->parameters());
  DocNode *param;
  for (li.toFirst();(param=li.current());++li)
  {
    if (pl->paramTypes().count()>0)
    {
      QListIterator<DocNode> li(pl->paramTypes());
      DocNode *type;
      for (li.toFirst();(type=li.current());++li)
      {
        m_t << "<parametertype>";
        if (type->kind()==DocNode::Kind_Word)
        {
          visit((DocWord*)type); 
        }
        else if (type->kind()==DocNode::Kind_LinkedWord)
        {
          visit((DocLinkedWord*)type); 
        }
        m_t << "</parametertype>" << endl;
      }
    }
    m_t << "<parametername";
    if (pl->direction()!=DocParamSect::Unspecified)
    {
      m_t << " direction=\"";
      if (pl->direction()==DocParamSect::In)
      {
        m_t << "in";
      }
      else if (pl->direction()==DocParamSect::Out)
      {
        m_t << "out";
      }
      else if (pl->direction()==DocParamSect::InOut)
      {
        m_t << "inout";
      }
      m_t << "\"";
    }
    m_t << ">";
    if (param->kind()==DocNode::Kind_Word)
    {
      visit((DocWord*)param); 
    }
    else if (param->kind()==DocNode::Kind_LinkedWord)
    {
      visit((DocLinkedWord*)param); 
    }
    m_t << "</parametername>" << endl;
  }
  m_t << "</parameternamelist>" << endl;
  m_t << "<parameterdescription>" << endl;
}

void XmlDocVisitor::visitPre ( DocXRefItem *  x )

virtual

Implements DocVisitor.

Definition at line 945 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  if (x->title().isEmpty()) return;
  m_t << "<xrefsect id=\"";
  m_t << x->file() << "_1" << x->anchor();
  m_t << "\">";
  m_t << "<xreftitle>";
  filter(x->title());
  m_t << "</xreftitle>";
  m_t << "<xrefdescription>";
}

void XmlDocVisitor::visitPre ( DocInternalRef *  ref )

virtual

Implements DocVisitor.

Definition at line 966 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  startLink(0,ref->file(),ref->anchor());
}

void XmlDocVisitor::visitPre ( DocCopy *  c )

virtual

Implements DocVisitor.

Definition at line 979 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<copydoc link=\"" << convertToXML(c->link()) << "\">";
}

void XmlDocVisitor::visitPre ( DocText *  )

virtual

Implements DocVisitor.

Definition at line 991 of file xmldocvisitor.cpp.

{
}

void XmlDocVisitor::visitPre ( DocHtmlBlockQuote *  )

virtual

Implements DocVisitor.

Definition at line 999 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<blockquote>";
}

void XmlDocVisitor::visitPre ( DocVhdlFlow *  )

virtual

Implements DocVisitor.

Definition at line 1011 of file xmldocvisitor.cpp.

{
}

void XmlDocVisitor::visitPre ( DocParBlock *  )

virtual

Implements DocVisitor.

Definition at line 1019 of file xmldocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "<parblock>";
}

Member Data Documentation

CodeOutputInterface& XmlDocVisitor::m_ci

private

Definition at line 162 of file xmldocvisitor.h.

QStack<bool> XmlDocVisitor::m_enabled

private

Definition at line 165 of file xmldocvisitor.h.

bool XmlDocVisitor::m_hide

private

Definition at line 164 of file xmldocvisitor.h.

bool XmlDocVisitor::m_insidePre

private

Definition at line 163 of file xmldocvisitor.h.

QCString XmlDocVisitor::m_langExt

private

Definition at line 166 of file xmldocvisitor.h.

FTextStream& XmlDocVisitor::m_t

private

Definition at line 161 of file xmldocvisitor.h.

---

The documentation for this class was generated from the following files:

• doxygen-1.8.11/src/xmldocvisitor.h
• doxygen-1.8.11/src/xmldocvisitor.cpp