/******************************************************************************

 *

 * 

 *

 *

 * Copyright (C) 1997-2008 by Dimitri van Heesch.

 *

 * 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.

 *

 * Documents produced by Doxygen are derivative works derived from the

 * input used in their production; they are not affected by this license.

 *

 */

#include "mandocvisitor.h"

#include "docparser.h"

#include "language.h"

#include "doxygen.h"

#include "outputgen.h"

#include "code.h"

#include "dot.h"

#include "util.h"

#include "message.h"

#include <qfileinfo.h> 

#include "parserintf.h"

ManDocVisitor::ManDocVisitor(QTextStream &t,CodeOutputInterface &ci,

                             const char *langExt) 

  : DocVisitor(DocVisitor_Man), m_t(t), m_ci(ci), m_insidePre(FALSE), m_hide(FALSE), m_firstCol(TRUE),

    m_indent(0), m_langExt(langExt)

{

}

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

  // visitor functions for leaf nodes

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

void ManDocVisitor::visit(DocWord *w)

{

  if (m_hide) return;

  filter(w->word());

  m_firstCol=FALSE;

}

void ManDocVisitor::visit(DocLinkedWord *w)

{

  if (m_hide) return;

  m_t << "\\fB";

  filter(w->word());

  m_t << "\\fP";

  m_firstCol=FALSE;

}

void ManDocVisitor::visit(DocWhiteSpace *w)

{

  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)

{

  if (m_hide) return;

  switch(s->symbol())

  {

    case DocSymbol::BSlash:  m_t << "\\\\"; break;

    case DocSymbol::At:      m_t << "@"; break;

    case DocSymbol::Less:    m_t << "<"; break;

    case DocSymbol::Greater: m_t << ">"; break;

    case DocSymbol::Amp:     m_t << "&"; break;

    case DocSymbol::Dollar:  m_t << "$"; break;

    case DocSymbol::Hash:    m_t << "#"; break;

    case DocSymbol::Percent: m_t << "%"; break;

    case DocSymbol::Copy:    m_t << "(C)"; break;

    case DocSymbol::Tm:      m_t << "(TM)"; break;

    case DocSymbol::Reg:     m_t << "(R)"; break;

    case DocSymbol::Apos:    m_t << "'"; break;

    case DocSymbol::Quot:    m_t << "\""; break;

    case DocSymbol::Lsquo:   m_t << "`"; break;

    case DocSymbol::Rsquo:   m_t << "'"; break;

    case DocSymbol::Ldquo:   m_t << "``"; break;

    case DocSymbol::Rdquo:   m_t << "''"; break;

    case DocSymbol::Ndash:   m_t << "--"; break;

    case DocSymbol::Mdash:   m_t << "---"; break;

    case DocSymbol::Uml:     m_t << s->letter() << "\\*(4"; break;

    case DocSymbol::Acute:   m_t << s->letter() << "\\*(`"; break;

    case DocSymbol::Grave:   m_t << s->letter() << "\\*:"; break;

    case DocSymbol::Circ:    m_t << s->letter() << "\\*^"; break;

    case DocSymbol::Slash:   m_t << s->letter(); break; /* todo: implement this */

    case DocSymbol::Tilde:   m_t << s->letter() << "\\*~"; break;

    case DocSymbol::Szlig:   m_t << "s\\*:"; break;

    case DocSymbol::Cedil:   m_t << s->letter() << "\\*,"; break;

    case DocSymbol::Ring:    m_t << s->letter() << "\\*o"; break;

    case DocSymbol::Nbsp:    m_t << " "; break;

    default:

                             err("Error: unknown symbol found\n");

  }

  m_firstCol=FALSE;

}

void ManDocVisitor::visit(DocURL *u)

{

  if (m_hide) return;

  m_t << u->url();

  m_firstCol=FALSE;

}

void ManDocVisitor::visit(DocLineBreak *)

{

  if (m_hide) return;

  m_t << endl << ".br" << endl;

  m_firstCol=TRUE;

}

void ManDocVisitor::visit(DocHorRuler *)

{

  if (m_hide) return;

  if (!m_firstCol) m_t << endl;

  m_t << ".PP" << endl;

  m_firstCol=TRUE;

}

void ManDocVisitor::visit(DocStyleChange *s)

{

  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)

{

  if (m_hide) return;

  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(0/*TODO*/)

                            ->parseCode(m_ci,s->context(),s->text().latin1(),

                                        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::Dot: 

    case DocVerbatim::Msc: 

      /* nothing */ 

      break;

  }

}

void ManDocVisitor::visit(DocAnchor *)

{

  /* no support for anchors in man pages */

}

void ManDocVisitor::visit(DocInclude *inc)

{

  if (m_hide) return;

  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(), cfi.fileName() );

         Doxygen::parserManager->getParser(inc->extension())

                               ->parseCode(m_ci,inc->context(),

                                           inc->text().latin1(),

                                           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().latin1(),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::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;

  }

}

void ManDocVisitor::visit(DocIncOperator *op)

{

  //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(0/*TODO*/)

                            ->parseCode(m_ci,op->context(),op->text().latin1(),

                                        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)

{

  if (m_hide) return;

  m_t << f->text();

}

void ManDocVisitor::visit(DocIndexEntry *)

{

}

void ManDocVisitor::visit(DocSimpleSectSep *)

{

}

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

// visitor functions for compound nodes

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

void ManDocVisitor::visitPre(DocAutoList *)

{

  if (m_hide) return;

  m_indent+=2;

}

void ManDocVisitor::visitPost(DocAutoList *)

{

  if (m_hide) return;

  m_indent-=2;

  m_t << ".PP" << endl;

}

void ManDocVisitor::visitPre(DocAutoListItem *li)

{

  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::visitPost(DocAutoListItem *) 

{

  if (m_hide) return;

  m_t << endl;

  m_firstCol=TRUE;

}

void ManDocVisitor::visitPre(DocPara *) 

{

}

void ManDocVisitor::visitPost(DocPara *p)

{

  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::visitPre(DocRoot *)

{

}

void ManDocVisitor::visitPost(DocRoot *)

{

}

void ManDocVisitor::visitPre(DocSimpleSect *s)

{

  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::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::visitPost(DocSimpleSect *)

{

  if (m_hide) return;

  if (!m_firstCol) m_t << endl;

  m_t << ".RE" << endl;

  m_t << ".PP" << endl;

  m_firstCol=TRUE;

}

void ManDocVisitor::visitPre(DocTitle *)

{

}

void ManDocVisitor::visitPost(DocTitle *)

{

  if (m_hide) return;

  m_t << "\\fP";

  m_t << ".RS 4" << endl;

}

void ManDocVisitor::visitPre(DocSimpleList *)

{

  if (m_hide) return;

  m_indent+=2;

  if (!m_firstCol) m_t << endl;

  m_t << ".PD 0" << endl;

}

void ManDocVisitor::visitPost(DocSimpleList *)

{

  if (m_hide) return;

  m_indent-=2;

  m_t << ".PP" << endl;

}

void ManDocVisitor::visitPre(DocSimpleListItem *)

{

  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::visitPost(DocSimpleListItem *) 

{

  if (m_hide) return;

  m_t << endl;

  m_firstCol=TRUE;

}

void ManDocVisitor::visitPre(DocSection *s)

{

  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;

}