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

 *

 * 

 *

 *

 * Style sheet additions by Alexander Bartolich

 *

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

#include "qtbc.h"

#include <qdir.h>

#include <qregexp.h>

#include "rtfgen.h"

#include "config.h"

#include "message.h"

#include "doxygen.h"

#include "util.h"

#include "diagram.h"

#include "language.h"

#include "dot.h"

#include "version.h"

#include "pagedef.h"

#include "rtfstyle.h"

#include "rtfdocvisitor.h"

#include "docparser.h"

#include "dirdef.h"

#include "vhdldocgen.h"

//#define DBG_RTF(x) x;

#define DBG_RTF(x)

static QCString dateToRTFDateString()

{

  const QDateTime &d = QDateTime::currentDateTime();

  QCString result;

  result.sprintf("\\yr%d\\mo%d\\dy%d\\hr%d\\min%d\\sec%d",

      d.date().year(), d.date().month(), d.date().day(),

      d.time().hour(),d.time().minute(),d.time().second());

  return result;

} 

RTFGenerator::RTFGenerator() : OutputGenerator()

{

  dir=Config_getString("RTF_OUTPUT");

  col=0;

  //insideTabbing=FALSE;

  m_listLevel = 0;

  m_bstartedBody = FALSE;

  m_omitParagraph = FALSE;

  m_numCols = 0;

}

RTFGenerator::~RTFGenerator()

{

}

//void RTFGenerator::append(const OutputGenerator *g)

//{

//  t << g->getContents();

//  col+=((RTFGenerator *)g)->col;

//  //insideTabbing=insideTabbing || ((RTFGenerator *)g)->insideTabbing;

//  m_listLevel=((RTFGenerator *)g)->m_listLevel;

//  m_omitParagraph=((RTFGenerator *)g)->m_omitParagraph;

//  //printf("RTFGenerator::append(%s) insideTabbing=%s\n", g->getContents().data(),

//  //    insideTabbing ? "TRUE" : "FALSE" );

//}

//OutputGenerator *RTFGenerator::copy()

//{

//  RTFGenerator *result = new RTFGenerator;

//  //result->insideTabbing=insideTabbing;

//  result->m_listLevel=m_listLevel;

//  result->m_omitParagraph=m_omitParagraph;

//  return result;

//}

void RTFGenerator::writeStyleSheetFile(QFile &file)

{

  QTextStream t(&file);

  t << "# Generated by doxygen " << versionString << "\n\n";

  t << "# This file describes styles used for generating RTF output.\n";

  t << "# All text after a hash (#) is considered a comment and will be ignored.\n";

  t << "# Remove a hash to activate a line.\n\n";

  int i;

  for ( i=0 ; rtf_Style_Default[i].reference!=0 ; i++ )

  {

    t << "# " << rtf_Style_Default[i].name << " = "

              << rtf_Style_Default[i].reference

              << rtf_Style_Default[i].definition << endl;

  }

}

void RTFGenerator::writeExtensionsFile(QFile &file)

{

  QTextStream t(&file);

  t << "# Generated by doxygen " << versionString << "\n\n";

  t << "# This file describes extensions used for generating RTF output.\n";

  t << "# All text after a hash (#) is considered a comment and will be ignored.\n";

  t << "# Remove a hash to activate a line.\n\n";

  t << "# Overrides the project title.\n";

  t << "#Title           = \n\n";

  t << "# Name of the company that produced this document.\n";

  t << "#Company         = \n\n";

  t << "# Filename of a company or project logo.\n";

  t << "#LogoFilename    = \n\n";

  t << "# Author of the document.\n";

  t << "#Author          = \n\n";

  t << "# Type of document (e.g. Design Specification, User Manual, etc.).\n";

  t << "#DocumentType    = \n\n";

  t << "# Document tracking number.\n";

  t << "#DocumentId      = \n\n";

  t << "# Name of the author's manager.\n";

  t << "# This field is not displayed in the document itself, but it is \n";

  t << "# available in the information block of the rtf file.  In Microsoft \n";

  t << "# Word, it is available under File:Properties.\n";

  t << "#Manager         = \n\n";

  t << "# Subject of the document.\n";

  t << "# This field is not displayed in the document itself, but it is \n";

  t << "# available in the information block of the rtf file.  In Microsoft \n";

  t << "# Word, it is available under File:Properties.\n";

  t << "#Subject         = \n\n";

  t << "# Comments regarding the document.\n";

  t << "# This field is not displayed in the document itself, but it is \n";

  t << "# available in the information block of the rtf file.  In Microsoft \n";

  t << "# Word, it is available under File:Properties.\n";

  t << "#Comments        = \n\n";

  t << "# Keywords associated with the document.\n";

  t << "# This field is not displayed in the document itself, but it is \n";

  t << "# available in the information block of the rtf file.  In Microsoft \n";

  t << "# Word, it is available under File:Properties.\n";

  t << "#Keywords        = \n\n";

}

void RTFGenerator::init()

{

  QCString dir=Config_getString("RTF_OUTPUT");

  QDir d(dir);

  if (!d.exists() && !d.mkdir(dir))

  {

    err("Could not create output directory %s\n",dir.data());

    exit(1);

  }

  rtf_Style.setAutoDelete(TRUE);

  // first duplicate strings of rtf_Style_Default

  const struct Rtf_Style_Default* def = rtf_Style_Default;

  while(def->reference != 0)

  {

    if (def->definition == 0)

      err("Internal error: rtf_Style_Default[%s] has no definition.\n", def->name);

    StyleData* styleData = new StyleData(def->reference, def->definition);

    rtf_Style.insert(def->name, styleData);

    def++;

  }

  // overwrite some (or all) definitions from file

  QCString &rtfStyleSheetFile = Config_getString("RTF_STYLESHEET_FILE");

  if (!rtfStyleSheetFile.isEmpty())

  {

    loadStylesheet(rtfStyleSheetFile, rtf_Style);

  }

  // If user has defined an extension file, load its contents.

  QCString &rtfExtensionsFile = Config_getString("RTF_EXTENSIONS_FILE");

  if (!rtfExtensionsFile.isEmpty())

  {

    loadExtensions(rtfExtensionsFile);

  }

  createSubDirs(d);

}

static QCString makeIndexName(const char *s,int i)

{

  QCString result=s;

  result+=(char)(i+'0');

  return result;

}

void RTFGenerator::beginRTFDocument()

{

  /* all the included RTF files should begin with the

   * same header

   */

  t <<"{\\rtf1\\ansi\\ansicpg" << theTranslator->trRTFansicp();

  t <<"\\uc1 \\deff0\\deflang1033\\deflangfe1033\n";

  DBG_RTF(t <<"{\\comment Begining font list}\n")

  t <<"{\\fonttbl ";

  t <<"{\\f0\\froman\\fcharset" << theTranslator->trRTFCharSet();

  t <<"\\fprq2{\\*\\panose 02020603050405020304}Times New Roman;}\n";

  t <<"{\\f1\\fswiss\\fcharset" << theTranslator->trRTFCharSet();

  t <<"\\fprq2{\\*\\panose 020b0604020202020204}Arial;}\n";

  t <<"{\\f2\\fmodern\\fcharset" << theTranslator->trRTFCharSet();

  t <<"\\fprq1{\\*\\panose 02070309020205020404}Courier New;}\n";

  t <<"{\\f3\\froman\\fcharset2\\fprq2{\\*\\panose 05050102010706020507}Symbol;}\n";

  t <<"}\n";

  DBG_RTF(t <<"{\\comment begin colors}\n")

  t <<"{\\colortbl;";

  t <<"\\red0\\green0\\blue0;";

  t <<"\\red0\\green0\\blue255;";

  t <<"\\red0\\green255\\blue255;";

  t <<"\\red0\\green255\\blue0;";

  t <<"\\red255\\green0\\blue255;";

  t <<"\\red255\\green0\\blue0;";

  t <<"\\red255\\green255\\blue0;";

  t <<"\\red255\\green255\\blue255;";

  t <<"\\red0\\green0\\blue128;";

  t <<"\\red0\\green128\\blue128;";

  t <<"\\red0\\green128\\blue0;";

  t <<"\\red128\\green0\\blue128;";

  t <<"\\red128\\green0\\blue0;";

  t <<"\\red128\\green128\\blue0;";

  t <<"\\red128\\green128\\blue128;";

  t <<"\\red192\\green192\\blue192;}" << endl;

  DBG_RTF(t <<"{\\comment Beginning style list}\n")

  t <<"{\\stylesheet\n";

  t <<"{\\widctlpar\\adjustright \\fs20\\cgrid \\snext0 Normal;}\n";

  // sort styles ascending by \s-number via an intermediate QArray

  QArray<const StyleData*> array(128);

  array.fill(0);

  QDictIterator<StyleData> iter(rtf_Style);

  const StyleData* style;

  for(; (style = iter.current()); ++iter)

  {

    unsigned index = style->index;

    unsigned size = array.size();

    if (index >= size)

    {

      // +1 to add at least one element, then align up to multiple of 8

      array.resize((index + 1 + 7) & ~7);

      array.fill(0, size);

      ASSERT(index < array.size());

    }

    if (array.at(index) != 0)

    {

      QCString key(convertToQCString(iter.currentKey()));

      msg("Style '%s' redefines \\s%d.\n", key.data(), index);

    }

    array.at(index) = style;

  }

  // write array elements

  unsigned size = array.size();

  for(unsigned i = 0; i < size; i++)

  {

    const StyleData* style = array.at(i);

    if (style != 0)

      t <<"{" << style->reference << style->definition << ";}\n";

  }

  t <<"}" << endl;

  // this comment is needed for postprocessing!

  t <<"{\\comment begin body}" << endl;

}

void RTFGenerator::beginRTFChapter()

{

  t <<"\n";

  DBG_RTF(t << "{\\comment BeginRTFChapter}\n")

  t << rtf_Style_Reset;

  // if we are compact, no extra page breaks...

  if (Config_getBool("COMPACT_RTF"))

  {

    //      t <<"\\sect\\sectd\\sbknone\n";

    t <<"\\sect\\sbknone\n";

    rtfwriteRuler_thick();

  }

  else

    t <<"\\sect\\sbkpage\n";

  //t <<"\\sect\\sectd\\sbkpage\n";

  t << rtf_Style["Heading1"]->reference << "\n";

}

void RTFGenerator::beginRTFSection()

{

  t <<"\n";

  DBG_RTF(t << "{\\comment BeginRTFSection}\n")

  t << rtf_Style_Reset;

  // if we are compact, no extra page breaks...

  if (Config_getBool("COMPACT_RTF"))

  {

    //      t <<"\\sect\\sectd\\sbknone\n";

    t <<"\\sect\\sbknone\n";

    rtfwriteRuler_emboss();

  }

  else

    t <<"\\sect\\sbkpage\n";

  //t <<"\\sect\\sectd\\sbkpage\n";

  t << rtf_Style["Heading2"]->reference << "\n";

}

void RTFGenerator::startFile(const char *name,const char *,const char *)

{

  setEncoding(QCString().sprintf("CP%s",theTranslator->trRTFansicp().data()));

  QCString fileName=name;

  relPath = relativePathToRoot(fileName);

  if (fileName.right(4)!=".rtf" ) fileName+=".rtf";

  startPlainFile(fileName);

  beginRTFDocument();

}

void RTFGenerator::endFile()

{

  DBG_RTF(t << "{\\comment endFile}\n")

  t << "}";

  endPlainFile();

}

void RTFGenerator::startProjectNumber()

{

  DBG_RTF(t <<"{\\comment startProjectNumber }" << endl)

  t << " ";

}

void RTFGenerator::endProjectNumber()

{

  DBG_RTF(t <<"{\\comment endProjectNumber }" << endl)

}

void RTFGenerator::startIndexSection(IndexSections is)

{

  //QCString paperName;

  m_listLevel = 0;

  switch (is)

  {

    case isTitlePageStart:

      // basic RTFstart

      // get readyfor author etc

      t << "{\\info \n";

      t << "{\\title {\\comment ";

      break;

    case isTitlePageAuthor:

      t << "}\n";

      if (rtf_subject)      t << "{\\subject "  << rtf_subject      << "}\n";

      if (rtf_comments)     t << "{\\comment "  << rtf_comments     << "}\n";

      if (rtf_company)      t << "{\\company "  << rtf_company      << "}\n";

      if (rtf_author)       t << "{\\author "   << rtf_author       << "}\n";

      if (rtf_manager)      t << "{\\manager "  << rtf_manager      << "}\n";

      if (rtf_documentType) t << "{\\category " << rtf_documentType << "}\n";

      if (rtf_keywords)     t << "{\\keywords " << rtf_keywords     << "}\n";

      t << "{\\comment ";

      break;

    case isMainPage:

      //Introduction

      beginRTFChapter();

      break;

    //case isPackageIndex:

    //  //Package Index

    //  beginRTFChapter();

    //  break;

    case isModuleIndex:

      //Module Index

      beginRTFChapter();

      break;

    case isDirIndex:

      //Directory Index

      beginRTFChapter();

      break;

    case isNamespaceIndex:

      //Namespace Index

      beginRTFChapter();

      break;

    case isClassHierarchyIndex:

      //Hierarchical Index

      DBG_RTF(t << "{\\comment start classhierarchy}\n")

      beginRTFChapter();

      break;

    case isCompoundIndex:

      //Annotated Compound Index

      beginRTFChapter();

      break;

    case isFileIndex:

      //Annotated File Index

      beginRTFChapter();

      break;

    case isPageIndex:

      //Related Page Index

      beginRTFChapter();

      break;

    case isModuleDocumentation:

      {

        //Module Documentation

        GroupSDict::Iterator gli(*Doxygen::groupSDict);

        GroupDef *gd;

        bool found=FALSE;

        for (gli.toFirst();(gd=gli.current()) && !found;++gli)

        {

          if (!gd->isReference())

          {

            beginRTFChapter();

            found=TRUE;

          }

        }

      }

      break;

    case isDirDocumentation:

      {

        //Directory Documentation

        SDict<DirDef>::Iterator dli(*Doxygen::directories);

        DirDef *dd;

        bool found=FALSE;

        for (dli.toFirst();(dd=dli.current()) && !found;++dli)

        {

          if (dd->isLinkableInProject())

          {

            beginRTFChapter();

            found=TRUE;

          }

        }

      }

      break;

    case isNamespaceDocumentation:

      {

        // Namespace Documentation

        NamespaceSDict::Iterator nli(*Doxygen::namespaceSDict);

        NamespaceDef *nd;

        bool found=FALSE;

        for (nli.toFirst();(nd=nli.current()) && !found;++nli)

        {

          if (nd->isLinkableInProject())

          {

            beginRTFChapter();

            found=TRUE;

          }

        }

      }

      break;

    case isClassDocumentation:

      {

        //Compound Documentation

        ClassSDict::Iterator cli(*Doxygen::classSDict);

        ClassDef *cd=0;

        bool found=FALSE;

        for (cli.toFirst();(cd=cli.current()) && !found;++cli)

        {

          if (cd->isLinkableInProject() && cd->templateMaster()==0)

          {

            beginRTFChapter();

            found=TRUE;

          }

        }

      }

      break;

    case isFileDocumentation:

      {

        //File Documentation

        bool isFirst=TRUE;

        FileName *fn=Doxygen::inputNameList->first();

        while (fn)

        {

          FileDef *fd=fn->first();

          while (fd)

          {

            if (fd->isLinkableInProject())

            {

              if (isFirst)

              {

                beginRTFChapter();

                isFirst=FALSE;

                break;

              }

            }

            fd=fn->next();

          }

          fn=Doxygen::inputNameList->next();

        }

      }

      break;

    case isExampleDocumentation:

      {

        //Example Documentation

        beginRTFChapter();

      }

      break;

    case isPageDocumentation:

      {

        //Page Documentation

        beginRTFChapter();

      }

      break;

    case isPageDocumentation2:

      {

        t << "{\\tc \\v ";

      }

      break;

    case isEndIndex:

      break;

  }

}