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

 *

 * 

 *

 *

 * 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 "rtfdocvisitor.h"

#include "docparser.h"

#include "language.h"

#include "doxygen.h"

#include "outputgen.h"

#include "dot.h"

#include "util.h"

#include "rtfstyle.h"

#include "message.h"

#include <qfileinfo.h> 

#include "parserintf.h"

#include "msc.h"

//#define DBG_RTF(x) m_t << x

#define DBG_RTF(x) do {} while(0)

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

                             const char *langExt) 

  : DocVisitor(DocVisitor_RTF), m_t(t), m_ci(ci), m_insidePre(FALSE), 

    m_hide(FALSE), m_indentLevel(0), m_lastIsPara(FALSE), m_langExt(langExt)

{

}

QString RTFDocVisitor::getStyle(const char *name)

{

  QString n;

  n.sprintf("%s%d",name,m_indentLevel);

  StyleData *sd = rtf_Style[n];

  ASSERT(sd!=0);

  return sd->reference;

}

void RTFDocVisitor::incIndentLevel()

{

  if (m_indentLevel<rtf_maxIndentLevels-1) m_indentLevel++;

}

void RTFDocVisitor::decIndentLevel()

{

  if (m_indentLevel>0) m_indentLevel--;

}

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

  // visitor functions for leaf nodes

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

void RTFDocVisitor::visit(DocWord *w)

{

  if (m_hide) return;

  DBG_RTF("{\\comment RTFDocVisitor::visit(DocWord)}\n");

  filter(w->word());

  m_lastIsPara=FALSE;

}

void RTFDocVisitor::visit(DocLinkedWord *w)

{

  if (m_hide) return;

  DBG_RTF("{\\comment RTFDocVisitor::visit(DocLinkedWord)}\n");

  startLink(w->ref(),w->file(),w->anchor());

  filter(w->word());

  endLink(w->ref());

  m_lastIsPara=FALSE;

}

void RTFDocVisitor::visit(DocWhiteSpace *w)

{

  if (m_hide) return;

  DBG_RTF("{\\comment RTFDocVisitor::visit(DocWhiteSpace)}\n");

  if (m_insidePre)

  {

    m_t << w->chars();

  }

  else

  {

    m_t << " ";

  }

  m_lastIsPara=FALSE;

}

void RTFDocVisitor::visit(DocSymbol *s)

{

  if (m_hide) return;

  DBG_RTF("{\\comment RTFDocVisitor::visit(DocSymbol)}\n");

  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:     switch(s->letter())

                             {

                               case 'A' : m_t << '\304'; break;

                               case 'E' : m_t << '\313'; break;

                               case 'I' : m_t << '\317'; break;

                               case 'O' : m_t << '\326'; break;

                               case 'U' : m_t << '\334'; break;

                               case 'Y' : m_t << 'Y';    break;

                               case 'a' : m_t << '\344'; break;

                               case 'e' : m_t << '\353'; break;

                               case 'i' : m_t << '\357'; break;

                               case 'o' : m_t << '\366'; break;

                               case 'u' : m_t << '\374'; break;

                               case 'y' : m_t << '\377'; break;

                               default: m_t << '?'; break;

                             }

                             break;

    case DocSymbol::Acute:   switch(s->letter())

                             {

                               case 'A' : m_t << '\301'; break;

                               case 'E' : m_t << '\311'; break;

                               case 'I' : m_t << '\315'; break;

                               case 'O' : m_t << '\323'; break;

                               case 'U' : m_t << '\332'; break;

                               case 'Y' : m_t << '\335'; break;

                               case 'a' : m_t << '\341'; break;

                               case 'e' : m_t << '\351'; break;

                               case 'i' : m_t << '\355'; break;

                               case 'o' : m_t << '\363'; break;

                               case 'u' : m_t << '\372'; break;

                               case 'y' : m_t << '\375'; break;

                               default: m_t << '?'; break;

                             }

                             break;

    case DocSymbol::Grave:   switch(s->letter())

                             {

                               case 'A' : m_t << '\300'; break;

                               case 'E' : m_t << '\310'; break;

                               case 'I' : m_t << '\314'; break;

                               case 'O' : m_t << '\322'; break;

                               case 'U' : m_t << '\331'; break;

                               case 'a' : m_t << '\340'; break;

                               case 'e' : m_t << '\350'; break;

                               case 'i' : m_t << '\354'; break;

                               case 'o' : m_t << '\362'; break;

                               case 'u' : m_t << '\371'; break;

                               default: m_t << '?'; break;

                             }

                             break;

    case DocSymbol::Circ:    switch(s->letter())

                             {

                               case 'A' : m_t << '\302'; break;

                               case 'E' : m_t << '\312'; break;

                               case 'I' : m_t << '\316'; break;

                               case 'O' : m_t << '\324'; break;

                               case 'U' : m_t << '\333'; break;

                               case 'a' : m_t << '\342'; break;

                               case 'e' : m_t << '\352'; break;

                               case 'i' : m_t << '\356'; break;

                               case 'o' : m_t << '\364'; break;

                               case 'u' : m_t << '\373'; break;

                               default: m_t << '?'; break;

                             }

                             break;

    case DocSymbol::Tilde:   switch(s->letter())

                             {

                               case 'A' : m_t << '\303'; break;

                               case 'N' : m_t << '\321'; break;

                               case 'O' : m_t << '\325'; break;

                               case 'a' : m_t << '\343'; break;

                               case 'n' : m_t << '\361'; break;

                               case 'o' : m_t << '\365'; break;

                               default: m_t << '?'; break;

                             }

                             break;

    case DocSymbol::Cedil:   switch(s->letter())

                             {

                               case 'C' : m_t << '\307'; break;

                               case 'c' : m_t << '\347'; break;

                               default: m_t << '?'; break;

                             }

                             break;

    case DocSymbol::Slash:   switch(s->letter())

                             {

                               case 'O' : m_t << '\330'; break;

                               case 'o' : m_t << '\370'; break;

                               default: m_t << '?'; break;

                             }

                             break;

    case DocSymbol::Ring:    switch(s->letter())

                             {

                               case 'A' : m_t << '\305'; break;

                               case 'a' : m_t << '\345'; break;

                               default: m_t << '?'; break;

                             }

                             break;

    case DocSymbol::Szlig:   m_t << "\337"; break;

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

    case DocSymbol::Aelig:   m_t << "\346"; break;

    case DocSymbol::AElig:   m_t << "\306"; break;

    default:

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

  }

  m_lastIsPara=FALSE;

}

void RTFDocVisitor::visit(DocURL *u)

{

  if (m_hide) return;

  DBG_RTF("{\\comment RTFDocVisitor::visit(DocURL)}\n");

  if (Config_getBool("RTF_HYPERLINKS"))

  {

    m_t << "{\\field "

             "{\\*\\fldinst "

               "{ HYPERLINK  \\\\l \"";

    if (u->isEmail()) m_t << "mailto:";

    m_t << u->url();

    m_t <<  "\" }"

               "{}";

    m_t <<   "}"

             "{\\fldrslt "

               "{\\cs37\\ul\\cf2 ";

    filter(u->url());

    m_t <<     "}"

             "}"

           "}" << endl;

  }

  else

  {

    m_t << "{\\f2 ";

    filter(u->url());

    m_t << "}";

  }

  m_lastIsPara=FALSE;

}

void RTFDocVisitor::visit(DocLineBreak *)

{

  if (m_hide) return;

  DBG_RTF("{\\comment RTFDocVisitor::visit(DocLineBreak)}\n");

  m_t << "\\par";

  m_lastIsPara=TRUE;

}

void RTFDocVisitor::visit(DocHorRuler *)

{

  if (m_hide) return;

  DBG_RTF("{\\comment RTFDocVisitor::visit(DocHorRuler)}\n");

  m_t << "{\\pard\\widctlpar\\brdrb\\brdrs\\brdrw5\\brsp20 \\adjustright \\par}" << endl;

  m_lastIsPara=TRUE;

}

void RTFDocVisitor::visit(DocStyleChange *s)

{

  if (m_hide) return;

  m_lastIsPara=FALSE;

  DBG_RTF("{\\comment RTFDocVisitor::visit(DocStyleChange)}\n");

  switch (s->style())

  {

    case DocStyleChange::Bold:

      if (s->enable()) m_t << "{\\b ";      else m_t << "} ";

      break;

    case DocStyleChange::Italic:

      if (s->enable()) m_t << "{\\i ";     else m_t << "} ";

      break;

    case DocStyleChange::Code:

      if (s->enable()) m_t << "{\\f2 ";   else m_t << "} ";

      break;

    case DocStyleChange::Subscript:

      if (s->enable()) m_t << "{\\sub ";    else m_t << "} ";

      break;

    case DocStyleChange::Superscript:

      if (s->enable()) m_t << "{\\super ";    else m_t << "} ";

      break;

    case DocStyleChange::Center:

      if (s->enable()) m_t << "{\\qc "; else m_t << "} ";

      break;

    case DocStyleChange::Small:

      if (s->enable()) m_t << "{\\sub ";  else m_t << "} ";

      break;

    case DocStyleChange::Preformatted:

      if (s->enable())

      {

        m_t << "{" << endl;

        m_t << "\\par" << endl;

        m_t << rtf_Style_Reset << getStyle("CodeExample");

        m_insidePre=TRUE;

      }

      else

      {

        m_insidePre=FALSE;

        m_t << "\\par";

        m_t << "}" << endl;

      }

      m_lastIsPara=TRUE;

      break;

    case DocStyleChange::Div:  /* HTML only */ break;

    case DocStyleChange::Span: /* HTML only */ break;

  }

}

void RTFDocVisitor::visit(DocVerbatim *s)

{

  if (m_hide) return;

  DBG_RTF("{\\comment RTFDocVisitor::visit(DocVerbatim)}\n");

  switch(s->type())

  {

    case DocVerbatim::Code: // fall though

      m_t << "{" << endl;

      m_t << "\\par" << endl;

      m_t << rtf_Style_Reset << getStyle("CodeExample");

      Doxygen::parserManager->getParser(m_langExt)

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

                                        s->isExample(),s->exampleFile());

      //m_t << "\\par" << endl; 

      m_t << "}" << endl;

      break;

    case DocVerbatim::Verbatim: 

      m_t << "{" << endl;

      m_t << "\\par" << endl;

      m_t << rtf_Style_Reset << getStyle("CodeExample");

      filter(s->text(),TRUE);

      //m_t << "\\par" << endl; 

      m_t << "}" << endl;

      break;

    case DocVerbatim::HtmlOnly: 

    case DocVerbatim::LatexOnly: 

    case DocVerbatim::XmlOnly: 

    case DocVerbatim::ManOnly: 

      /* nothing */

      break;

    case DocVerbatim::Dot: 

      {

        static int dotindex = 1;

        QCString fileName(4096);

        fileName.sprintf("%s%d%s", 

            (Config_getString("RTF_OUTPUT")+"/inline_dotgraph_").data(), 

            dotindex++,

            ".dot"

           );

        QFile file(fileName);

        if (!file.open(IO_WriteOnly))

        {

          err("Could not open file %s for writing\n",fileName.data());

        }

        file.writeBlock( s->text(), s->text().length() );

        file.close();

        m_t << "\\par{\\qc "; // center picture

        writeDotFile(fileName);

        m_t << "} ";

        if (Config_getBool("DOT_CLEANUP")) file.remove();

      }

      break;

    case DocVerbatim::Msc: 

      {

        static int mscindex = 1;

        QCString baseName(4096);

        baseName.sprintf("%s%d", 

            (Config_getString("RTF_OUTPUT")+"/inline_mscgraph_").data(), 

            mscindex++

           );

        QFile file(baseName+".msc");

        if (!file.open(IO_WriteOnly))

        {

          err("Could not open file %s for writing\n",baseName.data());

        }

        QCString text = "msc {";

        text+=s->text();

        text+="}";

        file.writeBlock( text, text.length() );

        file.close();

        m_t << "\\par{\\qc "; // center picture

        writeMscFile(baseName);

        m_t << "} ";

        if (Config_getBool("DOT_CLEANUP")) file.remove();

      }

      break;

  }

  m_lastIsPara=FALSE;

}

void RTFDocVisitor::visit(DocAnchor *anc)

{

  if (m_hide) return;

  DBG_RTF("{\\comment RTFDocVisitor::visit(DocAnchor)}\n");

  QString anchor;

  if (!anc->file().isEmpty())

  {

    anchor+=anc->file();

  }

  if (!anc->file().isEmpty() && !anc->anchor().isEmpty())

  {

    anchor+="_";

  }

  if (!anc->anchor().isEmpty())

  {

    anchor+=anc->anchor();

  }

  m_t << "{\\bkmkstart " << rtfFormatBmkStr(anchor) << "}" << endl;

  m_t << "{\\bkmkend " << rtfFormatBmkStr(anchor) << "}" << endl;

  m_lastIsPara=FALSE;

}

void RTFDocVisitor::visit(DocInclude *inc)

{

  if (m_hide) return;

  DBG_RTF("{\\comment RTFDocVisitor::visit(DocInclude)}\n");

  switch(inc->type())

  {

   case DocInclude::IncWithLines:

      { 

         m_t << "{" << endl;

         m_t << "\\par" << endl;

         m_t << rtf_Style_Reset << getStyle("CodeExample");

         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);

         m_t << "\\par";

         m_t << "}" << endl;

      }

      break;

   case DocInclude::Include: 

      m_t << "{" << endl;

      m_t << "\\par" << endl;

      m_t << rtf_Style_Reset << getStyle("CodeExample");

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

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

                                        inc->text().latin1(),inc->isExample(),

                                        inc->exampleFile());

      m_t << "\\par";

      m_t << "}" << endl;

      break;

    case DocInclude::DontInclude: 

      break;

    case DocInclude::HtmlInclude: 

      break;

    case DocInclude::VerbInclude: 

      m_t << "{" << endl;

      m_t << "\\par" << endl;

      m_t << rtf_Style_Reset << getStyle("CodeExample");

      filter(inc->text());

      m_t << "\\par";

      m_t << "}" << endl;

      break;

  }

  m_lastIsPara=TRUE;

}

void RTFDocVisitor::visit(DocIncOperator *op)

{

  //printf("DocIncOperator: type=%d first=%d, last=%d text=`%s'\n",

  //    op->type(),op->isFirst(),op->isLast(),op->text().data());

  DBG_RTF("{\\comment RTFDocVisitor::visit(DocIncOperator)}\n");

  if (op->isFirst()) 

  {

    if (!m_hide)

    {

      m_t << "{" << endl;

      m_t << "\\par" << endl;

      m_t << rtf_Style_Reset << getStyle("CodeExample");

    }

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

                                        op->isExample(),op->exampleFile());

    }

    pushEnabled();

    m_hide=TRUE;

  }

  if (op->isLast())  

  {

    popEnabled();

    if (!m_hide)

    {

      m_t << "\\par";

      m_t << "}" << endl;

    }

    m_lastIsPara=TRUE;

  }

  else

  {

    if (!m_hide) m_t << endl;

    m_lastIsPara=FALSE;

  }

}

void RTFDocVisitor::visit(DocFormula *f)

{

  if (m_hide) return;

  // TODO: do something sensible here, like including a bitmap

  DBG_RTF("{\\comment RTFDocVisitor::visit(DocFormula)}\n");

  m_t << f->text();