[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
#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"

#if !WXWIN_COMPATIBILITY_2_4
static inline wxChar* copystring(const wxChar* s)
    { return wxStrcpy(new wxChar[wxStrlen(s) + 1], s); }
#endif

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(wxTex2RTFBuffer);
  
  unsigned int i;
  for (i = 0; i < strlen(wxTex2RTFBuffer); i++)
    if (wxTex2RTFBuffer[i] == ':')
      wxTex2RTFBuffer[i] = ' ';
    // Don't write to index if there's some RTF in the string
    else if ( wxTex2RTFBuffer[i] == '{' )
        return;

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