ManDocVisitor Class Reference

Concrete visitor implementation for LaTeX output. More...

#include <mandocvisitor.h>

Inheritance diagram for ManDocVisitor:

Public Member Functions
	ManDocVisitor (FTextStream &t, CodeOutputInterface &ci, const char *langExt)
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 *s)
void	visitPost (DocSection *)
void	visitPre (DocHtmlList *s)
void	visitPost (DocHtmlList *s)
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 *t)
void	visitPost (DocHtmlTable *t)
void	visitPre (DocHtmlCaption *)
void	visitPost (DocHtmlCaption *)
void	visitPre (DocHtmlRow *)
void	visitPost (DocHtmlRow *)
void	visitPre (DocHtmlCell *)
void	visitPost (DocHtmlCell *)
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 *lnk)
void	visitPost (DocLink *)
void	visitPre (DocRef *ref)
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	pushEnabled ()
void	popEnabled ()

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

Detailed Description

Concrete visitor implementation for LaTeX output.

Definition at line 30 of file mandocvisitor.h.

Constructor & Destructor Documentation

ManDocVisitor::ManDocVisitor	(	FTextStream &	t,
		CodeOutputInterface &	ci,
		const char *	langExt
	)

Definition at line 34 of file mandocvisitor.cpp.

  : DocVisitor(DocVisitor_Man), m_t(t), m_ci(ci), m_insidePre(FALSE), m_hide(FALSE), m_firstCol(FALSE),
    m_indent(0), m_langExt(langExt)
{
}

Member Function Documentation

void ManDocVisitor::filter ( const char *  str )

private

Definition at line 1000 of file mandocvisitor.cpp.

{ 
  if (str)
  {
    const char *p=str;
    char c=0;
    while ((c=*p++)) 
    {
      switch(c)
      {
        case '.':  m_t << "\\&."; break; // see  bug652277
        case '\\': m_t << "\\\\"; break;
        case '"':  c = '\''; // fall through
        default: m_t << c; break;
      }
    }
  }
}

void ManDocVisitor::popEnabled ( )

private

Definition at line 1024 of file mandocvisitor.cpp.

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

void ManDocVisitor::pushEnabled ( )

private

Definition at line 1019 of file mandocvisitor.cpp.

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

void ManDocVisitor::visit ( DocWord *  w )

virtual

Implements DocVisitor.

Definition at line 45 of file mandocvisitor.cpp.

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

void ManDocVisitor::visit ( DocLinkedWord *  w )

virtual

Implements DocVisitor.

Definition at line 52 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fB";
  filter(w->word());
  m_t << "\\fP";
  m_firstCol=FALSE;
}

void ManDocVisitor::visit ( DocWhiteSpace *  w )

virtual

Implements DocVisitor.

Definition at line 61 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (m_insidePre)
  {
    m_t << w->chars();
    m_firstCol=w->chars().at(w->chars().length()-1)=='\n';
  }
  else
  {
    m_t << " ";
    m_firstCol=FALSE;
  }
}

void ManDocVisitor::visit ( DocSymbol *  s )

virtual

Implements DocVisitor.

Definition at line 76 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  const char *res = HtmlEntityMapper::instance()->man(s->symbol());
  if (res)
  {
    m_t << res;
  }
  else
  {
    // no error or warning to be supplied
    // err("man: non supported HTML-entity found: &%s;\n",get_symbol_item(s->symbol()));
  }
  m_firstCol=FALSE;
}

void ManDocVisitor::visit ( DocURL *  u )

virtual

Implements DocVisitor.

Definition at line 92 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << u->url();
  m_firstCol=FALSE;
}

void ManDocVisitor::visit ( DocLineBreak *  )

virtual

Implements DocVisitor.

Definition at line 99 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << endl << ".br" << endl;
  m_firstCol=TRUE;
}

void ManDocVisitor::visit ( DocHorRuler *  )

virtual

Implements DocVisitor.

Definition at line 106 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol) m_t << endl;
  m_t << ".PP" << endl;
  m_firstCol=TRUE;
}

void ManDocVisitor::visit ( DocStyleChange *  s )

virtual

Implements DocVisitor.

Definition at line 114 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  switch (s->style())
  {
    case DocStyleChange::Bold:
      if (s->enable()) m_t << "\\fB";      else m_t << "\\fP";
      m_firstCol=FALSE;
      break;
    case DocStyleChange::Italic:
      if (s->enable()) m_t << "\\fI";     else m_t << "\\fP";
      m_firstCol=FALSE;
      break;
    case DocStyleChange::Code:
      if (s->enable()) m_t << "\\fC";   else m_t << "\\fP";
      m_firstCol=FALSE;
      break;
    case DocStyleChange::Subscript:
      if (s->enable()) m_t << "\\*<";    else m_t << "\\*> ";
      m_firstCol=FALSE;
      break;
    case DocStyleChange::Superscript:
      if (s->enable()) m_t << "\\*{";    else m_t << "\\*} ";
      m_firstCol=FALSE;
      break;
    case DocStyleChange::Center:
      /* not supported */
      break;
    case DocStyleChange::Small:
      /* not supported */
      break;
    case DocStyleChange::Preformatted:
      if (s->enable())
      {
        if (!m_firstCol) m_t << endl;
        m_t << ".PP" << endl;
        m_t << ".nf" << endl;
        m_insidePre=TRUE;
      }
      else
      {
        m_insidePre=FALSE;
        if (!m_firstCol) m_t << endl;
        m_t << ".fi" << endl;
        m_t << ".PP" << endl;
        m_firstCol=TRUE;
      }
      break;
    case DocStyleChange::Div:  /* HTML only */ break;
    case DocStyleChange::Span: /* HTML only */ break;
  }
}

void ManDocVisitor::visit ( DocVerbatim *  s )

virtual

Implements DocVisitor.

Definition at line 167 of file mandocvisitor.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
      if (!m_firstCol) m_t << endl;
      m_t << ".PP" << endl;
      m_t << ".nf" << endl;
      Doxygen::parserManager->getParser(lang)
                            ->parseCode(m_ci,s->context(),s->text(),
                                        langExt,
                                        s->isExample(),s->exampleFile());
      if (!m_firstCol) m_t << endl;
      m_t << ".fi" << endl;
      m_t << ".PP" << endl;
      m_firstCol=TRUE;
      break;
    case DocVerbatim::Verbatim: 
      if (!m_firstCol) m_t << endl;
      m_t << ".PP" << endl;
      m_t << ".nf" << endl;
      m_t << s->text();
      if (!m_firstCol) m_t << endl;
      m_t << ".fi" << endl;
      m_t << ".PP" << endl;
      m_firstCol=TRUE;
      break;
    case DocVerbatim::ManOnly: 
      m_t << s->text(); 
      break;
    case DocVerbatim::HtmlOnly: 
    case DocVerbatim::XmlOnly: 
    case DocVerbatim::LatexOnly: 
    case DocVerbatim::RtfOnly:
    case DocVerbatim::DocbookOnly:
    case DocVerbatim::Dot: 
    case DocVerbatim::Msc: 
    case DocVerbatim::PlantUML: 
      /* nothing */ 
      break;
  }
}

void ManDocVisitor::visit ( DocAnchor *  )

virtual

Implements DocVisitor.

Definition at line 217 of file mandocvisitor.cpp.

{
  /* no support for anchors in man pages */
}

void ManDocVisitor::visit ( DocInclude *  inc )

virtual

Implements DocVisitor.

Definition at line 222 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  SrcLangExt langExt = getLanguageFromFileName(inc->extension());
  switch(inc->type())
  {
    case DocInclude::IncWithLines:
      { 
         if (!m_firstCol) m_t << endl;
         m_t << ".PP" << endl;
         m_t << ".nf" << endl;
         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);
         if (!m_firstCol) m_t << endl;
         m_t << ".fi" << endl;
         m_t << ".PP" << endl;
         m_firstCol=TRUE;
      }
      break;
    case DocInclude::Include: 
      if (!m_firstCol) m_t << endl;
      m_t << ".PP" << endl;
      m_t << ".nf" << endl;
      Doxygen::parserManager->getParser(inc->extension())
                            ->parseCode(m_ci,inc->context(),
                                        inc->text(),
                                        langExt,
                                        inc->isExample(),
                                        inc->exampleFile());
      if (!m_firstCol) m_t << endl;
      m_t << ".fi" << endl;
      m_t << ".PP" << endl;
      m_firstCol=TRUE;
      break;
    case DocInclude::DontInclude: 
      break;
    case DocInclude::HtmlInclude: 
      break;
    case DocInclude::LatexInclude:
      break;
    case DocInclude::VerbInclude: 
      if (!m_firstCol) m_t << endl;
      m_t << ".PP" << endl;
      m_t << ".nf" << endl;
      m_t << inc->text();
      if (!m_firstCol) m_t << endl;
      m_t << ".fi" << endl;
      m_t << ".PP" << endl;
      m_firstCol=TRUE;
      break;
    case DocInclude::Snippet:
      if (!m_firstCol) m_t << endl;
      m_t << ".PP" << endl;
      m_t << ".nf" << endl;
      Doxygen::parserManager->getParser(inc->extension())
                            ->parseCode(m_ci,
                                        inc->context(),
                                        extractBlock(inc->text(),inc->blockId()),
                                        langExt,
                                        inc->isExample(),
                                        inc->exampleFile()
                                       );
      if (!m_firstCol) m_t << endl;
      m_t << ".fi" << endl;
      m_t << ".PP" << endl;
      m_firstCol=TRUE;
      break;
  }
}

void ManDocVisitor::visit ( DocIncOperator *  op )

virtual

Implements DocVisitor.

Definition at line 298 of file mandocvisitor.cpp.

{
  SrcLangExt langExt = getLanguageFromFileName(m_langExt);
  //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)
    {
      if (!m_firstCol) m_t << endl;
      m_t << ".PP" << endl;
      m_t << ".nf" << endl;
    }
    pushEnabled();
    m_hide = TRUE;
  }
  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)
    {
      if (!m_firstCol) m_t << endl;
      m_t << ".fi" << endl;
      m_t << ".PP" << endl;
      m_firstCol=TRUE;
    }
  }
  else
  {
    if (!m_hide) m_t << endl;
  }
}

void ManDocVisitor::visit ( DocFormula *  f )

virtual

Implements DocVisitor.

Definition at line 343 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << f->text();
}

void ManDocVisitor::visit ( DocIndexEntry *  )

virtual

Implements DocVisitor.

Definition at line 349 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visit ( DocSimpleSectSep *  )

virtual

Implements DocVisitor.

Definition at line 353 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visit ( DocCite *  cite )

virtual

Implements DocVisitor.

Definition at line 357 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fB";
  if (cite->file().isEmpty()) m_t << "[";
  filter(cite->text());
  if (cite->file().isEmpty()) m_t << "]";
  m_t << "\\fP";
}

void ManDocVisitor::visitPost ( DocAutoList *  )

virtual

Implements DocVisitor.

Definition at line 378 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_indent-=2;
  m_t << ".PP" << endl;
}

void ManDocVisitor::visitPost ( DocAutoListItem *  )

virtual

Implements DocVisitor.

Definition at line 404 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << endl;
  m_firstCol=TRUE;
}

void ManDocVisitor::visitPost ( DocPara *  p )

virtual

Implements DocVisitor.

Definition at line 415 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!p->isLast() &&            // omit <p> for last paragraph
      !(p->parent() &&           // and for parameter sections
        p->parent()->kind()==DocNode::Kind_ParamSect
       )
     ) 
  {
    if (!m_firstCol) m_t << endl;
    m_t << ".PP" << endl;
    m_firstCol=TRUE;
  }
}

void ManDocVisitor::visitPost ( DocRoot *  )

virtual

Implements DocVisitor.

Definition at line 434 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPost ( DocSimpleSect *  )

virtual

Implements DocVisitor.

Definition at line 492 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol) m_t << endl;
  m_t << ".RE" << endl;
  m_t << ".PP" << endl;
  m_firstCol=TRUE;
}

void ManDocVisitor::visitPost ( DocTitle *  )

virtual

Implements DocVisitor.

Definition at line 505 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fP" << endl;
  m_t << ".RS 4" << endl;
}

void ManDocVisitor::visitPost ( DocSimpleList *  )

virtual

Implements DocVisitor.

Definition at line 520 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_indent-=2;
  m_t << ".PP" << endl;
}

void ManDocVisitor::visitPost ( DocSimpleListItem *  )

virtual

Implements DocVisitor.

Definition at line 537 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << endl;
  m_firstCol=TRUE;
}

void ManDocVisitor::visitPost ( DocSection *  )

virtual

Implements DocVisitor.

Definition at line 556 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPost ( DocHtmlList *  s )

virtual

Implements DocVisitor.

Definition at line 568 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_indent-=2;
  if (!m_firstCol) m_t << endl;
  m_t << ".PP" << endl;
}

void ManDocVisitor::visitPost ( DocHtmlListItem *  )

virtual

Implements DocVisitor.

Definition at line 595 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << endl;
  m_firstCol=TRUE;
}

void ManDocVisitor::visitPost ( DocHtmlDescList *  )

virtual

Implements DocVisitor.

Definition at line 623 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol) m_t << endl;
  m_t << ".PP" << endl;
  m_firstCol=TRUE;
}

void ManDocVisitor::visitPost ( DocHtmlDescTitle *  )

virtual

Implements DocVisitor.

Definition at line 639 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fP\" 1c" << endl;
  m_firstCol=TRUE;
}

void ManDocVisitor::visitPost ( DocHtmlDescData *  )

virtual

Implements DocVisitor.

Definition at line 650 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPost ( DocHtmlTable *  t )

virtual

Implements DocVisitor.

Definition at line 658 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPost ( DocHtmlCaption *  )

virtual

Implements DocVisitor.

Definition at line 666 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPost ( DocHtmlRow *  )

virtual

Implements DocVisitor.

Definition at line 674 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPost ( DocHtmlCell *  )

virtual

Implements DocVisitor.

Definition at line 682 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPost ( DocInternal *  )

virtual

Implements DocVisitor.

Definition at line 695 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  //if (!m_firstCol) m_t << endl;
  //m_t << ".RE" << endl;
  //m_t << ".PP" << endl;
  //m_firstCol=TRUE;
}

void ManDocVisitor::visitPost ( DocHRef *  )

virtual

Implements DocVisitor.

Definition at line 710 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fP";
}

void ManDocVisitor::visitPost ( DocHtmlHeader *  header )

virtual

Implements DocVisitor.

Definition at line 724 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\"" << endl;
  if (header->level()==1) m_t << ".PP" << endl;
  m_firstCol=TRUE;
}

void ManDocVisitor::visitPost ( DocImage *  )

virtual

Implements DocVisitor.

Definition at line 736 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPost ( DocDotFile *  )

virtual

Implements DocVisitor.

Definition at line 744 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPost ( DocMscFile *  )

virtual

Implements DocVisitor.

Definition at line 751 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPost ( DocDiaFile *  )

virtual

Implements DocVisitor.

Definition at line 759 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPost ( DocLink *  )

virtual

Implements DocVisitor.

Definition at line 769 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fP";
}

void ManDocVisitor::visitPost ( DocRef *  )

virtual

Implements DocVisitor.

Definition at line 782 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fP";
}

void ManDocVisitor::visitPost ( DocSecRefItem *  )

virtual

Implements DocVisitor.

Definition at line 798 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << endl;
  m_firstCol=TRUE;
}

void ManDocVisitor::visitPost ( DocSecRefList *  )

virtual

Implements DocVisitor.

Definition at line 811 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_indent-=2;
  if (!m_firstCol) m_t << endl;
  m_t << ".PP" << endl;
}

void ManDocVisitor::visitPost ( DocParamSect *  )

virtual

Implements DocVisitor.

Definition at line 867 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol) m_t << endl;
  m_t << ".RE" << endl;
  m_t << ".PP" << endl;
  m_firstCol=TRUE;
}

void ManDocVisitor::visitPost ( DocParamList *  pl )

virtual

Implements DocVisitor.

Definition at line 900 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!pl->isLast())
  {
    if (!m_firstCol) m_t << endl;
    m_t << ".br" << endl;
  }
}

void ManDocVisitor::visitPost ( DocXRefItem *  x )

virtual

Implements DocVisitor.

Definition at line 925 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (x->title().isEmpty()) return;
  if (!m_firstCol) m_t << endl;
  m_t << ".RE" << endl;
  m_t << ".PP" << endl;
  m_firstCol=TRUE;
}

void ManDocVisitor::visitPost ( DocInternalRef *  )

virtual

Implements DocVisitor.

Definition at line 941 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fP";
}

void ManDocVisitor::visitPost ( DocCopy *  )

virtual

Implements DocVisitor.

Definition at line 951 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPost ( DocText *  )

virtual

Implements DocVisitor.

Definition at line 959 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPost ( DocHtmlBlockQuote *  )

virtual

Implements DocVisitor.

Definition at line 974 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol) m_t << endl;
  m_t << ".RE" << endl;
  m_t << ".PP" << endl;
  m_firstCol=TRUE;
}

void ManDocVisitor::visitPost ( DocVhdlFlow *  )

virtual

Implements DocVisitor.

Definition at line 987 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPost ( DocParBlock *  )

virtual

Implements DocVisitor.

Definition at line 995 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPre ( DocAutoList *  )

virtual

Implements DocVisitor.

Definition at line 372 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_indent+=2;
}

void ManDocVisitor::visitPre ( DocAutoListItem *  li )

virtual

Implements DocVisitor.

Definition at line 385 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  QCString ws;
  ws.fill(' ',m_indent-2);
  if (!m_firstCol) m_t << endl;
  m_t << ".IP \"" << ws; 
  if (((DocAutoList *)li->parent())->isEnumList())
  {
    m_t << li->itemNumber() << ".\" " << m_indent+2;
  }
  else // bullet list
  {
    m_t << "\\(bu\" " << m_indent;
  }
  m_t << endl;
  m_firstCol=TRUE;
}

void ManDocVisitor::visitPre ( DocPara *  )

virtual

Implements DocVisitor.

Definition at line 411 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPre ( DocRoot *  )

virtual

Implements DocVisitor.

Definition at line 430 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPre ( DocSimpleSect *  s )

virtual

Implements DocVisitor.

Definition at line 438 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol)
  { 
    m_t << endl;
    m_t << ".PP" << endl;
  }
  m_t << "\\fB";
  switch(s->type())
  {
    case DocSimpleSect::See: 
      m_t << theTranslator->trSeeAlso(); break;
    case DocSimpleSect::Return: 
      m_t << theTranslator->trReturns(); break;
    case DocSimpleSect::Author: 
      m_t << theTranslator->trAuthor(TRUE,TRUE); break;
    case DocSimpleSect::Authors: 
      m_t << theTranslator->trAuthor(TRUE,FALSE); break;
    case DocSimpleSect::Version: 
      m_t << theTranslator->trVersion(); break;
    case DocSimpleSect::Since: 
      m_t << theTranslator->trSince(); break;
    case DocSimpleSect::Date: 
      m_t << theTranslator->trDate(); break;
    case DocSimpleSect::Note: 
      m_t << theTranslator->trNote(); break;
    case DocSimpleSect::Warning:
      m_t << theTranslator->trWarning(); break;
    case DocSimpleSect::Pre:
      m_t << theTranslator->trPrecondition(); break;
    case DocSimpleSect::Post:
      m_t << theTranslator->trPostcondition(); break;
    case DocSimpleSect::Copyright:
      m_t << theTranslator->trCopyright(); break;
    case DocSimpleSect::Invar:
      m_t << theTranslator->trInvariant(); break;
    case DocSimpleSect::Remark:
      m_t << theTranslator->trRemarks(); break;
    case DocSimpleSect::Attention:
      m_t << theTranslator->trAttention(); break;
    case DocSimpleSect::User: break;
    case DocSimpleSect::Rcs: break;
    case DocSimpleSect::Unknown:  break;
  }

  // special case 1: user defined title
  if (s->type()!=DocSimpleSect::User && s->type()!=DocSimpleSect::Rcs)
  {
    m_t << ":\\fP" << endl;
    m_t << ".RS 4" << endl;
  }
}

void ManDocVisitor::visitPre ( DocTitle *  )

virtual

Implements DocVisitor.

Definition at line 501 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPre ( DocSimpleList *  )

virtual

Implements DocVisitor.

Definition at line 512 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_indent+=2;
  if (!m_firstCol) m_t << endl;
  m_t << ".PD 0" << endl;
}

void ManDocVisitor::visitPre ( DocSimpleListItem *  )

virtual

Implements DocVisitor.

Definition at line 527 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  QCString ws;
  ws.fill(' ',m_indent-2);
  if (!m_firstCol) m_t << endl;
  m_t << ".IP \"" << ws << "\\(bu\" " << m_indent << endl;
  m_firstCol=TRUE;
}

void ManDocVisitor::visitPre ( DocSection *  s )

virtual

Implements DocVisitor.

Definition at line 544 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol) m_t << endl;
  if (s->level()==1) m_t << ".SH"; else m_t << ".SS";
  m_t << " \"";
  filter(s->title());
  m_t << "\"" << endl;
  if (s->level()==1) m_t << ".PP" << endl;
  m_firstCol=TRUE;
}

void ManDocVisitor::visitPre ( DocHtmlList *  s )

virtual

Implements DocVisitor.

Definition at line 560 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_indent+=2;
  if (!m_firstCol) m_t << endl;
  m_t << ".PD 0" << endl;
}

void ManDocVisitor::visitPre ( DocHtmlListItem *  li )

virtual

Implements DocVisitor.

Definition at line 576 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  QCString ws;
  ws.fill(' ',m_indent-2);
  if (!m_firstCol) m_t << endl;
  m_t << ".IP \"" << ws; 
  if (((DocHtmlList *)li->parent())->type()==DocHtmlList::Ordered)
  {
    m_t << li->itemNumber() << ".\" " << m_indent+2;
  }
  else // bullet list
  {
    m_t << "\\(bu\" " << m_indent;
  }
  m_t << endl;
  m_firstCol=TRUE;
}

void ManDocVisitor::visitPre ( DocHtmlDescList *  )

virtual

Implements DocVisitor.

Definition at line 619 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPre ( DocHtmlDescTitle *  )

virtual

Implements DocVisitor.

Definition at line 631 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol) m_t << endl;
  m_t << ".IP \"\\fB";
  m_firstCol=FALSE;
}

void ManDocVisitor::visitPre ( DocHtmlDescData *  )

virtual

Implements DocVisitor.

Definition at line 646 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPre ( DocHtmlTable *  t )

virtual

Implements DocVisitor.

Definition at line 654 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPre ( DocHtmlCaption *  )

virtual

Implements DocVisitor.

Definition at line 662 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPre ( DocHtmlRow *  )

virtual

Implements DocVisitor.

Definition at line 670 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPre ( DocHtmlCell *  )

virtual

Implements DocVisitor.

Definition at line 678 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPre ( DocInternal *  )

virtual

Implements DocVisitor.

Definition at line 686 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  //if (!m_firstCol) m_t << endl;
  //m_t << ".PP" << endl;
  //m_t << "\\fB" << theTranslator->trForInternalUseOnly() << "\\fP" << endl;
  //m_t << ".RS 4" << endl;
}

void ManDocVisitor::visitPre ( DocHRef *  )

virtual

Implements DocVisitor.

Definition at line 704 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fC";
}

void ManDocVisitor::visitPre ( DocHtmlHeader *  header )

virtual

Implements DocVisitor.

Definition at line 716 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol) m_t << endl;
  if (header->level()==1) m_t << ".SH"; else m_t << ".SS";
  m_t << " \"";
}

void ManDocVisitor::visitPre ( DocImage *  )

virtual

Implements DocVisitor.

Definition at line 732 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPre ( DocDotFile *  )

virtual

Implements DocVisitor.

Definition at line 740 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPre ( DocMscFile *  )

virtual

Implements DocVisitor.

Definition at line 747 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPre ( DocDiaFile *  )

virtual

Implements DocVisitor.

Definition at line 755 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPre ( DocLink *  lnk )

virtual

Implements DocVisitor.

Definition at line 763 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fB";
}

void ManDocVisitor::visitPre ( DocRef *  ref )

virtual

Implements DocVisitor.

Definition at line 775 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fB";
  if (!ref->hasLinkText()) filter(ref->targetTitle());
}

void ManDocVisitor::visitPre ( DocSecRefItem *  )

virtual

Implements DocVisitor.

Definition at line 788 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  QCString ws;
  ws.fill(' ',m_indent-2);
  if (!m_firstCol) m_t << endl;
  m_t << ".IP \"" << ws << "\\(bu\" " << m_indent << endl;
  m_firstCol=TRUE;
}

void ManDocVisitor::visitPre ( DocSecRefList *  )

virtual

Implements DocVisitor.

Definition at line 805 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_indent+=2;
}

void ManDocVisitor::visitPre ( DocParamSect *  s )

virtual

Implements DocVisitor.

Definition at line 838 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol)
  { 
    m_t << endl;
    m_t << ".PP" << endl;
  }
  m_t << "\\fB";
  switch(s->type())
  {
    case DocParamSect::Param: 
      m_t << theTranslator->trParameters(); break;
    case DocParamSect::RetVal: 
      m_t << theTranslator->trReturnValues(); break;
    case DocParamSect::Exception: 
      m_t << theTranslator->trExceptions(); break;
    case DocParamSect::TemplateParam: 
      /* TODO: add this 
      m_t << theTranslator->trTemplateParam(); break;
      */
      m_t << "Template Parameters"; break;
    default:
      ASSERT(0);
  }
  m_t << ":\\fP" << endl;
  m_t << ".RS 4" << endl;
}

void ManDocVisitor::visitPre ( DocParamList *  pl )

virtual

Implements DocVisitor.

Definition at line 876 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fI";
  //QStrListIterator li(pl->parameters());
  //const char *s;
  QListIterator<DocNode> li(pl->parameters());
  DocNode *param;
  bool first=TRUE;
  for (li.toFirst();(param=li.current());++li)
  {
    if (!first) m_t << ","; else first=FALSE;
    if (param->kind()==DocNode::Kind_Word)
    {
      visit((DocWord*)param); 
    }
    else if (param->kind()==DocNode::Kind_LinkedWord)
    {
      visit((DocLinkedWord*)param); 
    }
  }
  m_t << "\\fP ";
}

void ManDocVisitor::visitPre ( DocXRefItem *  x )

virtual

Implements DocVisitor.

Definition at line 910 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (x->title().isEmpty()) return;
  if (!m_firstCol)
  { 
    m_t << endl;
    m_t << ".PP" << endl;
  }
  m_t << "\\fB";
  filter(x->title());
  m_t << "\\fP" << endl;
  m_t << ".RS 4" << endl;
}

void ManDocVisitor::visitPre ( DocInternalRef *  )

virtual

Implements DocVisitor.

Definition at line 935 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fB";
}

void ManDocVisitor::visitPre ( DocCopy *  )

virtual

Implements DocVisitor.

Definition at line 947 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPre ( DocText *  )

virtual

Implements DocVisitor.

Definition at line 955 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPre ( DocHtmlBlockQuote *  )

virtual

Implements DocVisitor.

Definition at line 963 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol)
  { 
    m_t << endl;
    m_t << ".PP" << endl;
  }
  m_t << ".RS 4" << endl; // TODO: add support for nested block quotes
}

void ManDocVisitor::visitPre ( DocVhdlFlow *  )

virtual

Implements DocVisitor.

Definition at line 983 of file mandocvisitor.cpp.

{
}

void ManDocVisitor::visitPre ( DocParBlock *  )

virtual

Implements DocVisitor.

Definition at line 991 of file mandocvisitor.cpp.

{
}

Member Data Documentation

CodeOutputInterface& ManDocVisitor::m_ci

private

Definition at line 157 of file mandocvisitor.h.

QStack<bool> ManDocVisitor::m_enabled

private

Definition at line 162 of file mandocvisitor.h.

bool ManDocVisitor::m_firstCol

private

Definition at line 160 of file mandocvisitor.h.

bool ManDocVisitor::m_hide

private

Definition at line 159 of file mandocvisitor.h.

int ManDocVisitor::m_indent

private

Definition at line 161 of file mandocvisitor.h.

bool ManDocVisitor::m_insidePre

private

Definition at line 158 of file mandocvisitor.h.

QCString ManDocVisitor::m_langExt

private

Definition at line 163 of file mandocvisitor.h.

FTextStream& ManDocVisitor::m_t

private

Definition at line 156 of file mandocvisitor.h.

---

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

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