[wxWidgets.git] / utils / tex2rtf / src / rtfutils.cpp

/////////////////////////////////////////////////////////////////////////////
// Name:        rtfutils.cpp
// Purpose:     Converts Latex to Word RTF/WinHelp RTF
// Author:      Julian Smart
// Modified by:
// Created:     7.9.93
// RCS-ID:      $Id$
// Copyright:   (c) Julian Smart
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifdef __GNUG__
#pragma implementation
#endif

// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"

#ifdef __BORLANDC__
#pragma hdrstop
#endif

#ifndef WX_PRECOMP
#include "wx/wx.h"
#endif

#include "tex2any.h"
#include "tex2rtf.h"
#include <ctype.h>
#include <stdlib.h>
#include <stdio.h>

#ifdef __WIN32__
#include <windows.h>
#endif

#include "bmputils.h"
#include "table.h"

wxList itemizeStack;
static int indentLevel = 0;
static int forbidParindent = 0; // if > 0, no parindent (e.g. in center environment)
int forbidResetPar = 0; // If > 0, don't reset memory of having output a new par

static char *contentsLineSection = NULL;
static char *contentsLineValue = NULL;
static TexChunk *descriptionItemArg = NULL;
static wxStringList environmentStack; // Stack of paragraph styles we need to remember
static int footnoteCount = 0;
static int citeCount = 1;
extern char *FileRoot;
extern bool winHelp;
extern bool startedSections;
extern FILE *Contents;
extern FILE *Chapters;
extern FILE *Popups;
extern FILE *WinHelpContentsFile;
extern char *RTFCharset;
// This is defined in the Tex2Any library and isn't in use after parsing
extern char *BigBuffer;

extern wxHashTable TexReferences;

// Are we in verbatim mode? If so, format differently.
static bool inVerbatim = FALSE;

// We're in a series of PopRef topics, so don't output section headings
bool inPopRefSection = FALSE;

// Green colour?
static bool hotSpotColour = TRUE;
static bool hotSpotUnderline = TRUE;

// Transparency (WHITE = transparent)
static bool bitmapTransparency = TRUE;

// Linear RTF requires us to set the style per section.
static char *currentNumberStyle = NULL;
static int currentItemSep = 8;
static int CurrentTextWidth = 8640; // Say, six inches
static int CurrentLeftMarginOdd = 400;
static int CurrentLeftMarginEven = 1440;
static int CurrentRightMarginOdd = 1440;
static int CurrentRightMarginEven = 400;
static int CurrentMarginParWidth = 2000;
static int CurrentMarginParSep = 400;  // Gap between marginpar and text
static int CurrentMarginParX = CurrentLeftMarginOdd + CurrentTextWidth + CurrentMarginParSep;
static int GutterWidth = 2300;

// Two-column table dimensions, in twips
static int TwoColWidthA = 1500;
static int TwoColWidthB = 3000;

const int PageWidth = 12242; // 8.25 inches wide for A4

// Remember the anchor in a helpref
static TexChunk *helpRefText = NULL;

/*
 * Flag to say we've just issued a \par\pard command, so don't
 * repeat this unnecessarily.
 *
 */

int issuedNewParagraph = 0;

// Need to know whether we're in a table or figure for benefit
// of listoffigures/listoftables
static bool inFigure = FALSE;
static bool inTable = FALSE;

/*
 * Current topics
 *
 */
static char *CurrentChapterName = NULL;
static char *CurrentSectionName = NULL;
static char *CurrentSubsectionName = NULL;
static char *CurrentTopic = NULL;

static bool InPopups()
{
  if (CurrentChapterName && (strcmp(CurrentChapterName, "popups") == 0))
    return TRUE;
  if (CurrentSectionName && (strcmp(CurrentSectionName, "popups") == 0))
    return TRUE;
  return FALSE;
}

static void SetCurrentTopic(char *s)
{
  if (CurrentTopic) delete[] CurrentTopic;
  CurrentTopic = copystring(s);
}

void SetCurrentChapterName(char *s)
{
  if (CurrentChapterName) delete[] CurrentChapterName;
  CurrentChapterName = copystring(s);
  SetCurrentTopic(s);
}
void SetCurrentSectionName(char *s)
{
  if (CurrentSectionName) delete[] CurrentSectionName;
  CurrentSectionName = copystring(s);
  SetCurrentTopic(s);
}
void SetCurrentSubsectionName(char *s)
{
  if (CurrentSubsectionName) delete[] CurrentSubsectionName;
  CurrentSubsectionName = copystring(s);
  SetCurrentTopic(s);
}

// Indicate that a parent topic at level 'level' has children.
// Level 1 is a chapter, 2 is a section, etc.
void NotifyParentHasChildren(int parentLevel)
{
  char *parentTopic = NULL;
  switch (parentLevel)
  {
    case 1:
    {
      parentTopic = CurrentChapterName;
      break;
    }
    case 2:
    {
      parentTopic = CurrentSectionName;
      break;
    }
    case 3:
    {
      parentTopic = CurrentSubsectionName;
      break;
    }
    default:
    {
      break;
    }
  }
  if (parentTopic)
  {
    TexTopic *texTopic = (TexTopic *)TopicTable.Get(parentTopic);
    if (!texTopic)
    {
      texTopic = new TexTopic;
      TopicTable.Put(parentTopic, texTopic);
    }
    texTopic->hasChildren = TRUE;
  }
}

// Have to keep a count of what levels are books, what are pages,
// in order to correct for a Win95 bug which means that if you
// have a book at level n, and then a page at level n, the page
// ends up on level n + 1.

bool ContentsLevels[5];

// Reset below this level (starts from 1)
void ResetContentsLevels(int l)
{
  int i;
  for (i = l; i < 5; i++)
    ContentsLevels[i] = FALSE;
    
  // There are always books on the top level
  ContentsLevels[0] = TRUE;
}

// Output a WinHelp section as a keyword, substituting
// : for space.
void OutputSectionKeyword(FILE *fd)
{
  OutputCurrentSectionToString(wxBuffer);
  
  unsigned int i;
  for (i = 0; i < strlen(wxBuffer); i++)
    if (wxBuffer[i] == ':')
      wxBuffer[i] = ' ';
    // Don't write to index if there's some RTF in the string
    else if ( wxBuffer[i] == '{' )
        return;

  fprintf(fd, "K{\\footnote {K} ");
  fprintf(fd, "%s", wxBuffer);
  
  fprintf(fd, "}\n");
}

// Write a line for the .cnt file, if we're doing this.
void WriteWinHelpContentsFileLine(char *topicName, char *xitle, int level)
{
  // First, convert any RTF characters to ASCII
  char title[255];
  int s=0;
  int d=0;
  while ( (xitle[s]!=0)&&(d<255) )
  {
	  char ch=xitle[s]&0xff;
	  if (ch==0x5c) {
		  char ch1=xitle[s+1]&0xff;
		  char ch2=xitle[s+2]&0xff;
		  char ch3=xitle[s+3]&0xff;
		  char ch4=xitle[s+4]&0xff;
		  s+=4; // next character		  
		  char a=0;
Commit	Line	Data
9a29912f JS	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: rtfutils.cpp
	3	// Purpose: Converts Latex to Word RTF/WinHelp RTF
	4	// Author: Julian Smart
	5	// Modified by:
	6	// Created: 7.9.93
	7	// RCS-ID: $Id$
	8	// Copyright: (c) Julian Smart
	9	// Licence: wxWindows licence
	10	/////////////////////////////////////////////////////////////////////////////
	11
	12	#ifdef __GNUG__
	13	#pragma implementation
	14	#endif
	15
	16	// For compilers that support precompilation, includes "wx.h".
	17	#include "wx/wxprec.h"
	18
	19	#ifdef __BORLANDC__
	20	#pragma hdrstop
	21	#endif
	22
	23	#ifndef WX_PRECOMP
	24	#include "wx/wx.h"
	25	#endif
	26
	27	#include "tex2any.h"
	28	#include "tex2rtf.h"
	29	#include <ctype.h>
	30	#include <stdlib.h>
	31	#include <stdio.h>
	32
	33	#ifdef __WIN32__
	34	#include <windows.h>
	35	#endif
	36
	37	#include "bmputils.h"
	38	#include "table.h"
	39
	40	wxList itemizeStack;
	41	static int indentLevel = 0;
	42	static int forbidParindent = 0; // if > 0, no parindent (e.g. in center environment)
	43	int forbidResetPar = 0; // If > 0, don't reset memory of having output a new par
	44
	45	static char *contentsLineSection = NULL;
	46	static char *contentsLineValue = NULL;
	47	static TexChunk *descriptionItemArg = NULL;
	48	static wxStringList environmentStack; // Stack of paragraph styles we need to remember
	49	static int footnoteCount = 0;
	50	static int citeCount = 1;
	51	extern char *FileRoot;
	52	extern bool winHelp;
	53	extern bool startedSections;
	54	extern FILE *Contents;
	55	extern FILE *Chapters;
	56	extern FILE *Popups;
	57	extern FILE *WinHelpContentsFile;
	58	extern char *RTFCharset;
	59	// This is defined in the Tex2Any library and isn't in use after parsing
	60	extern char *BigBuffer;
3924dd22	61
3924dd22 GT	62	extern wxHashTable TexReferences;
3924dd22 GT	63
9a29912f JS	64	// Are we in verbatim mode? If so, format differently.
	65	static bool inVerbatim = FALSE;
	66
	67	// We're in a series of PopRef topics, so don't output section headings
	68	bool inPopRefSection = FALSE;
	69
	70	// Green colour?
	71	static bool hotSpotColour = TRUE;
	72	static bool hotSpotUnderline = TRUE;
	73
	74	// Transparency (WHITE = transparent)
	75	static bool bitmapTransparency = TRUE;
	76
	77	// Linear RTF requires us to set the style per section.
	78	static char *currentNumberStyle = NULL;
	79	static int currentItemSep = 8;
	80	static int CurrentTextWidth = 8640; // Say, six inches
	81	static int CurrentLeftMarginOdd = 400;
	82	static int CurrentLeftMarginEven = 1440;
	83	static int CurrentRightMarginOdd = 1440;
	84	static int CurrentRightMarginEven = 400;
	85	static int CurrentMarginParWidth = 2000;
	86	static int CurrentMarginParSep = 400; // Gap between marginpar and text
	87	static int CurrentMarginParX = CurrentLeftMarginOdd + CurrentTextWidth + CurrentMarginParSep;
	88	static int GutterWidth = 2300;
	89
	90	// Two-column table dimensions, in twips
	91	static int TwoColWidthA = 1500;
	92	static int TwoColWidthB = 3000;
	93
	94	const int PageWidth = 12242; // 8.25 inches wide for A4
	95
bf16085d JS	96	// Remember the anchor in a helpref
bf16085d JS	97	static TexChunk *helpRefText = NULL;
9a29912f JS	98
	99	/*
	100	* Flag to say we've just issued a \par\pard command, so don't
	101	* repeat this unnecessarily.
	102	*
	103	*/
	104
	105	int issuedNewParagraph = 0;
	106
	107	// Need to know whether we're in a table or figure for benefit
	108	// of listoffigures/listoftables
	109	static bool inFigure = FALSE;
	110	static bool inTable = FALSE;
	111
	112	/*
	113	* Current topics
	114	*
	115	*/
	116	static char *CurrentChapterName = NULL;
	117	static char *CurrentSectionName = NULL;
	118	static char *CurrentSubsectionName = NULL;
	119	static char *CurrentTopic = NULL;
	120
	121	static bool InPopups()
	122	{
	123	if (CurrentChapterName && (strcmp(CurrentChapterName, "popups") == 0))
	124	return TRUE;
	125	if (CurrentSectionName && (strcmp(CurrentSectionName, "popups") == 0))
	126	return TRUE;
	127	return FALSE;
	128	}
	129
	130	static void SetCurrentTopic(char *s)
	131	{
	132	if (CurrentTopic) delete[] CurrentTopic;
	133	CurrentTopic = copystring(s);
	134	}
	135
	136	void SetCurrentChapterName(char *s)
	137	{
	138	if (CurrentChapterName) delete[] CurrentChapterName;
	139	CurrentChapterName = copystring(s);
	140	SetCurrentTopic(s);
	141	}
	142	void SetCurrentSectionName(char *s)
	143	{
	144	if (CurrentSectionName) delete[] CurrentSectionName;
	145	CurrentSectionName = copystring(s);
	146	SetCurrentTopic(s);
	147	}
	148	void SetCurrentSubsectionName(char *s)
	149	{
	150	if (CurrentSubsectionName) delete[] CurrentSubsectionName;
	151	CurrentSubsectionName = copystring(s);
	152	SetCurrentTopic(s);
	153	}
	154
	155	// Indicate that a parent topic at level 'level' has children.
	156	// Level 1 is a chapter, 2 is a section, etc.
	157	void NotifyParentHasChildren(int parentLevel)
	158	{
	159	char *parentTopic = NULL;
	160	switch (parentLevel)
	161	{
162	case 1:
163	{
164	parentTopic = CurrentChapterName;
165	break;
166	}
167	case 2:
168	{
169	parentTopic = CurrentSectionName;
170	break;
171	}
172	case 3:
173	{
174	parentTopic = CurrentSubsectionName;
175	break;
176	}
177	default:
178	{
179	break;
180	}
181	}
182	if (parentTopic)
183	{
184	TexTopic texTopic = (TexTopic )TopicTable.Get(parentTopic);
185	if (!texTopic)
186	{
187	texTopic = new TexTopic;
188	TopicTable.Put(parentTopic, texTopic);
189	}
190	texTopic->hasChildren = TRUE;
191	}
192	}
193
194	// Have to keep a count of what levels are books, what are pages,
195	// in order to correct for a Win95 bug which means that if you
196	// have a book at level n, and then a page at level n, the page
197	// ends up on level n + 1.
198
199	bool ContentsLevels[5];
200
201	// Reset below this level (starts from 1)
202	void ResetContentsLevels(int l)
203	{
204	int i;
205	for (i = l; i < 5; i++)
206	ContentsLevels[i] = FALSE;
207
208	// There are always books on the top level
209	ContentsLevels[0] = TRUE;
210	}
211
212	// Output a WinHelp section as a keyword, substituting
213	// : for space.
214	void OutputSectionKeyword(FILE *fd)
215	{
216	OutputCurrentSectionToString(wxBuffer);
217
241c426c	218	unsigned int i;
9a29912f JS	219	for (i = 0; i < strlen(wxBuffer); i++)
	220	if (wxBuffer[i] == ':')
	221	wxBuffer[i] = ' ';
	222	// Don't write to index if there's some RTF in the string
	223	else if ( wxBuffer[i] == '{' )
	224	return;
	225
	226	fprintf(fd, "K{\\footnote {K} ");
	227	fprintf(fd, "%s", wxBuffer);
	228
	229	fprintf(fd, "}\n");
	230	}
	231
	232	// Write a line for the .cnt file, if we're doing this.
	233	void WriteWinHelpContentsFileLine(char topicName, char xitle, int level)
	234	{
	235	// First, convert any RTF characters to ASCII
	236	char title[255];
	237	int s=0;
	238	int d=0;
	239	while ( (xitle[s]!=0)&&(d<255) )
	240	{
	241	char ch=xitle[s]&0xff;
	242	if (ch==0x5c) {
	243	char ch1=xitle[s+1]&0xff;
	244	char ch2=xitle[s+2]&0xff;
	245	char ch3=xitle[s+3]&0xff;
	246	char ch4=xitle[s+4]&0xff;
	247	s+=4; // next character
	248	char a=0;
	249