lyx_mirror/src/paragraph_pimpl.C

/* This file is part of
 * ====================================================== 
 * 
 *           LyX, The Document Processor
 * 	 
 *           Copyright 1995 Matthias Ettrich
 *           Copyright 1995-2001 The LyX Team. 
 *
 * ====================================================== */

#include <config.h>

#ifdef __GNUG__
#pragma implementation
#endif

#include "paragraph_pimpl.h"
#include "texrow.h"
#include "bufferparams.h"
#include "encoding.h"
#include "lyxrc.h"
#include "debug.h"

extern int tex_code_break_column;


// Initialization of the counter for the paragraph id's,
unsigned int Paragraph::Pimpl::paragraph_id = 0;

// Initialize static member.
ShareContainer<LyXFont> Paragraph::Pimpl::FontTable::container;


Paragraph::Pimpl::Pimpl(Paragraph * owner)
	: owner_(owner)
{
	inset_owner = 0;
	id_ = paragraph_id++;
}


Paragraph::Pimpl::Pimpl(Paragraph::Pimpl const & p, Paragraph * owner)
	: owner_(owner)
{
	inset_owner = p.inset_owner;
	text = p.text;
	fontlist = p.fontlist;
}


void Paragraph::Pimpl::clear()
{
	text.clear();
}


void Paragraph::Pimpl::setContentsFromPar(Paragraph const * par)
{
	lyx::Assert(par);
	text = par->pimpl_->text;
}


Paragraph::value_type
Paragraph::Pimpl::getChar(Paragraph::size_type pos) const
{
	lyx::Assert(pos <= size());
	// This is stronger, and I belive that this is the assertion
	// that we should really use. (Lgb)
	//Assert(pos < size());

	// Then this has no meaning. (Lgb)
	if (!size() || pos == size()) return '\0';
	
	return text[pos];
}


void Paragraph::Pimpl::setChar(Paragraph::size_type pos,
			       Paragraph::value_type c)
{
	text[pos] = c;
}


void Paragraph::Pimpl::insertChar(Paragraph::size_type pos,
				  Paragraph::value_type c,
				  LyXFont const & font)
{
	lyx::Assert(pos <= size());

	text.insert(text.begin() + pos, c);

	// Update the font table.
	FontTable search_font(pos, LyXFont());
	for (FontList::iterator it = std::lower_bound(fontlist.begin(),
						      fontlist.end(),
						      search_font, matchFT());
	     it != fontlist.end(); ++it)
		(*it).pos((*it).pos() + 1);
   
	// Update the inset table.
	InsetTable search_inset(pos, 0);
	for (InsetList::iterator it = std::lower_bound(owner_->insetlist.begin(),
						       owner_->insetlist.end(),
						       search_inset, matchIT());
	     it != owner_->insetlist.end(); ++it)
		++(*it).pos;

	owner_->setFont(pos, font);
}


void Paragraph::Pimpl::insertInset(Paragraph::size_type pos,
				   Inset * inset, LyXFont const & font)
{
	lyx::Assert(inset);
	lyx::Assert(pos <= size());
	
	insertChar(pos, META_INSET, font);
	lyx::Assert(text[pos] == META_INSET);
	
	// Add a new entry in the inset table.
	InsetTable search_inset(pos, 0);
	InsetList::iterator it = std::lower_bound(owner_->insetlist.begin(),
						  owner_->insetlist.end(),
						  search_inset, matchIT());
	if (it != owner_->insetlist.end() && (*it).pos == pos) {
		lyxerr << "ERROR (Paragraph::InsertInset): "
			"there is an inset in position: " << pos << std::endl;
	} else {
		owner_->insetlist.insert(it, InsetTable(pos, inset));
	}
	
	if (inset_owner)
		inset->setOwner(inset_owner);
}


void Paragraph::Pimpl::erase(Paragraph::size_type pos)
{
	lyx::Assert(pos < size());
	// if it is an inset, delete the inset entry 
	if (text[pos] == Paragraph::META_INSET) {
		// find the entry
		InsetTable search_inset(pos, 0);
		InsetList::iterator it =
			std::lower_bound(owner_->insetlist.begin(),
					 owner_->insetlist.end(),
					 search_inset, matchIT());
		if (it != owner_->insetlist.end() && (*it).pos == pos) {
			delete (*it).inset;
			owner_->insetlist.erase(it);
		}
	}
	
	text.erase(text.begin() + pos);
	
	// Erase entries in the tables.
	FontTable search_font(pos, LyXFont());
	
	FontList::iterator it =
		std::lower_bound(fontlist.begin(),
			    fontlist.end(),
			    search_font, matchFT());
	if (it != fontlist.end() && (*it).pos() == pos &&
	    (pos == 0 || 
	     (it != fontlist.begin() 
	      && (*(it - 1)).pos() == pos - 1))) {
		// If it is a multi-character font
		// entry, we just make it smaller
		// (see update below), otherwise we
		// should delete it.
		unsigned int const i = it - fontlist.begin();
		fontlist.erase(fontlist.begin() + i);
		it = fontlist.begin() + i;
		if (i > 0 && i < fontlist.size() &&
		    fontlist[i - 1].font() == fontlist[i].font()) {
			fontlist.erase(fontlist.begin() + i - 1);
			it = fontlist.begin() + i - 1;
		}
	}
	
	// Update all other entries.
	FontList::iterator fend = fontlist.end();
	for (; it != fend; ++it)
		(*it).pos((*it).pos() - 1);
	
	// Update the inset table.
	InsetTable search_inset(pos, 0);
	InsetList::iterator lend = owner_->insetlist.end();
	for (InsetList::iterator it =
		     std::upper_bound(owner_->insetlist.begin(),
				      lend,
				      search_inset, matchIT());
	     it != lend; ++it)
		--(*it).pos;
}


void Paragraph::Pimpl::simpleTeXBlanks(std::ostream & os, TexRow & texrow,
				       Paragraph::size_type const i,
				       int & column, LyXFont const & font,
				       LyXLayout const & style)
{
	if (column > tex_code_break_column
	    && i 
	    && owner_->getChar(i - 1) != ' '
	    && (i < owner_->size() - 1)
#ifndef NO_LATEX
	    // In LaTeX mode, we don't want to
	    // break lines since some commands
	    // do not like this
	    && ! (font.latex() == LyXFont::ON)
#endif
	    // same in FreeSpacing mode
	    && !style.free_spacing
	    // In typewriter mode, we want to avoid 
	    // ! . ? : at the end of a line
	    && !(font.family() == LyXFont::TYPEWRITER_FAMILY
		 && (owner_->getChar(i-1) == '.'
		     || owner_->getChar(i-1) == '?' 
		     || owner_->getChar(i-1) == ':'
		     || owner_->getChar(i-1) == '!'))) {
		if (tex_code_break_column == 0) {
			// in batchmode we need LaTeX to still
			// see it as a space not as an extra '\n'
			os << " %\n";
		} else {
			os << '\n';
		}
		texrow.newline();
		texrow.start(owner_, i + 1);
		column = 0;
	} else
#ifndef NO_LATEX
		if (font.latex() == LyXFont::OFF) {
#endif
		if (style.free_spacing) {
			os << '~';
		} else {
			os << ' ';
		}
#ifndef NO_LATEX
	}
#endif
}


void Paragraph::Pimpl::simpleTeXSpecialChars(Buffer const * buf,
					     BufferParams const & bparams,
					     std::ostream & os,
					     TexRow & texrow,
					     bool moving_arg,
					     LyXFont & font,
					     LyXFont & running_font,
					     LyXFont & basefont,
					     bool & open_font,
					     LyXLayout const & style,
					     Paragraph::size_type & i,
					     int & column,
					     Paragraph::value_type const c)
{
	// Two major modes:  LaTeX or plain
	// Handle here those cases common to both modes
	// and then split to handle the two modes separately.
	switch (c) {
	case Paragraph::META_INSET: {
		Inset * inset = owner_->getInset(i);
		if (inset) {
			bool close = false;
			int const len = os.tellp();
			//ostream::pos_type const len = os.tellp();
			if ((inset->lyxCode() == Inset::GRAPHICS_CODE
			     || inset->lyxCode() == Inset::MATH_CODE
			     || inset->lyxCode() == Inset::URL_CODE)
			    && running_font.isRightToLeft()) {
				os << "\\L{";
				close = true;
			}

			int tmp = inset->latex(buf, os, moving_arg,
					       style.free_spacing);

			if (close)
				os << "}";

			if (tmp) {
				column = 0;
			} else {
				column += int(os.tellp()) - len;
			}
			for (; tmp--;) {
				texrow.newline();
			}
		}
	}
	break;

	case Paragraph::META_NEWLINE:
		if (open_font) {
			column += running_font.latexWriteEndChanges(os,
								    basefont,
								    basefont);
			open_font = false;
		}
		basefont = owner_->getFont(bparams, -1);
		running_font = basefont;
		break;

	case Paragraph::META_HFILL: 
		os << "\\hfill{}";
		column += 7;
		break;

	default:
		// And now for the special cases within each mode
#ifndef NO_LATEX
		// Are we in LaTeX mode?
		if (font.latex() == LyXFont::ON) {
			// at present we only have one option
			// but I'll leave it as a switch statement
			// so its simpler to extend. (ARRae)
			switch (c) {
			default:
				// make sure that we will not print
				// error generating chars to the tex
				// file. This test would not be needed
				// if it were done in the buffer
				// itself.
				if (c != '\0') {
					os << c;
				}
				break;
			}
		} else {
#endif
			// Plain mode (i.e. not LaTeX)
			switch (c) {
			case '\\': 
				os << "\\textbackslash{}";
				column += 15;
				break;
		
			case '<EFBFBD>': case '<EFBFBD>': case '<EFBFBD>': case '<EFBFBD>':  
			case '<EFBFBD>': case '<EFBFBD>': case '<EFBFBD>': case '<EFBFBD>':
			case '<EFBFBD>': case '<EFBFBD>': case '<EFBFBD>':
				if (bparams.inputenc == "latin1" ||
				    (bparams.inputenc == "auto" &&
				     font.language()->encoding()->LatexName()
				     == "latin1")) {
					os << "\\ensuremath{"
					   << c
					   << '}';
					column += 13;
				} else {
					os << c;
				}
				break;

			case '|': case '<': case '>':
				// In T1 encoding, these characters exist
				if (lyxrc.fontenc == "T1") {
					os << c;
					//... but we should avoid ligatures
					if ((c == '>' || c == '<')
					    && i <= owner_->size() - 2
					    && owner_->getChar(i + 1) == c) {
						//os << "\\textcompwordmark{}";
						// Jean-Marc, have a look at
						// this. I<>think this works
						// equally well:
						os << "\\,{}";
						// Lgb
						column += 19;
					}
					break;
				}
				// Typewriter font also has them
				if (font.family() == LyXFont::TYPEWRITER_FAMILY) {
					os << c;
					break;
				} 
				// Otherwise, we use what LaTeX
				// provides us.
				switch (c) {
				case '<':
					os << "\\textless{}";
					column += 10;
					break;
				case '>':
					os << "\\textgreater{}";
					column += 13;
					break;
				case '|':
					os << "\\textbar{}";
					column += 9;
					break;
				}
				break;

			case '-': // "--" in Typewriter mode -> "-{}-"
				if (i <= owner_->size() - 2
				    && owner_->getChar(i + 1) == '-'
				    && font.family() == LyXFont::TYPEWRITER_FAMILY) {
					os << "-{}";
					column += 2;
				} else {
					os << '-';
				}
				break;

			case '\"': 
				os << "\\char`\\\"{}";
				column += 9;
				break;

			case '<EFBFBD>':
				if (bparams.inputenc == "default") {
					os << "\\pounds{}";
					column += 8;
				} else {
					os << c;
				}
				break;

			case '$': case '&':
			case '%': case '#': case '{':
			case '}': case '_':
				os << '\\' << c;
				column += 1;
				break;

			case '~':
				os << "\\textasciitilde{}";
				column += 16;
				break;

			case '^':
				os << "\\textasciicircum{}";
				column += 17;
				break;

			case '*': case '[': case ']':
				// avoid being mistaken for optional arguments
				os << '{' << c << '}';
				column += 2;
				break;

			case ' ':
				// Blanks are printed before font switching.
				// Sure? I am not! (try nice-latex)
				// I am sure it's correct. LyX might be smarter
				// in the future, but for now, nothing wrong is
				// written. (Asger)
				break;

			default:
				/* idea for labels --- begin*/
				// Check for "LyX"
				if (c ==  'L'
				    && i <= owner_->size() - 3
				    && font.family() != LyXFont::TYPEWRITER_FAMILY
				    && owner_->getChar(i + 1) == 'y'
				    && owner_->getChar(i + 2) == 'X') {
					os << "\\LyX{}";
					i += 2;
					column += 5;
				}
				// Check for "TeX"
				else if (c == 'T'
					 && i <= owner_->size() - 3
					 && font.family() != LyXFont::TYPEWRITER_FAMILY
					 && owner_->getChar(i + 1) == 'e'
					 && owner_->getChar(i + 2) == 'X') {
					os << "\\TeX{}";
					i += 2;
					column += 5;
				}
				// Check for "LaTeX2e"
				else if (c == 'L'
					 && i <= owner_->size() - 7
					 && font.family() != LyXFont::TYPEWRITER_FAMILY
					 && owner_->getChar(i + 1) == 'a'
					 && owner_->getChar(i + 2) == 'T'
					 && owner_->getChar(i + 3) == 'e'
					 && owner_->getChar(i + 4) == 'X'
					 && owner_->getChar(i + 5) == '2'
					 && owner_->getChar(i + 6) == 'e') {
					os << "\\LaTeXe{}";
					i += 6;
					column += 8;
				}
				// Check for "LaTeX"
				else if (c == 'L'
					 && i <= owner_->size() - 5
					 && font.family() != LyXFont::TYPEWRITER_FAMILY
					 && owner_->getChar(i + 1) == 'a'
					 && owner_->getChar(i + 2) == 'T'
					 && owner_->getChar(i + 3) == 'e'
					 && owner_->getChar(i + 4) == 'X') {
					os << "\\LaTeX{}";
					i += 4;
					column += 7;
					/* idea for labels --- end*/ 
				} else if (c != '\0') {
					os << c;
				}
				break;
			}
#ifndef NO_LATEX
		}
#endif
	}
}



Paragraph * Paragraph::Pimpl::TeXDeeper(Buffer const * buf,
					BufferParams const & bparams,
					std::ostream & os, TexRow & texrow)
{
	lyxerr[Debug::LATEX] << "TeXDeeper...     " << this << std::endl;
	Paragraph * par = owner_;

	while (par && par->params().depth() == owner_->params().depth()) {
		if (textclasslist.Style(bparams.textclass, 
					par->layout).isEnvironment()) {
			par = par->TeXEnvironment(buf, bparams,
						  os, texrow);
		} else {
			par = par->TeXOnePar(buf, bparams,
					     os, texrow, false);
		}
	}
	lyxerr[Debug::LATEX] << "TeXDeeper...done " << par << std::endl;

	return par;
}