lyx_mirror/src/mathed/math_parser.h

// -*- C++ -*-
/*
 *  File:        math_parser.h
 *  Purpose:     Declaration of parsing utilities for mathed
 *  Author:      Alejandro Aguilar Sierra <asierra@servidor.unam.mx> 
 *  Created:     January 1996
 *  Description: Parse LaTeX2e math mode code.
 *
 *  Dependencies: Xlib, XForms
 *
 *  Copyright: 1996, Alejandro Aguilar Sierra
 *
 *   Version: 0.8beta.
 *
 *   You are free to use and modify this code under the terms of
 *   the GNU General Public Licence version 2 or later.
 */

#ifndef MATH_PARSER_H
#define MATH_PARSER_H

#ifdef __GNUG__
#pragma interface
#endif

#include "LString.h"
#include "math_defs.h"

class MathAtom;
class MathArray;
class LyXLex;

///
enum MathTokenEnum
{
	///
	LM_TK_SYM = 256,
	///
	LM_TK_BOX,
	///
	LM_TK_CHOOSE,
	///
	LM_TK_BINOM,
	///
	LM_TK_ATOP,
	///
	LM_TK_OVER,
	///
	LM_TK_FRAC,
	///
	LM_TK_SQRT,
	///
	LM_TK_ROOT,
	///
	LM_TK_LEFTEQN,
	///
	LM_TK_BEGIN,
	///
	LM_TK_END,
	/// mathcal, mathrm...
	LM_TK_OLDFONT,
	/// cal,...
	LM_TK_FONT,
	///
	LM_TK_LEFT,
	///
	LM_TK_RIGHT,
	///
	LM_TK_DECORATION,
	///
	LM_TK_FUNC,
	///
	LM_TK_FUNCLIM,
	///
	LM_TK_CMR,
	///
	LM_TK_CMSY,
	///
	LM_TK_CMM,
	///
	LM_TK_CMEX,
	///
	LM_TK_MSA,
	///
	LM_TK_MSB,
	///
	LM_TK_LABEL,
	///
	LM_TK_NONUM,
	///
	LM_TK_SPACE,
	///
	LM_TK_DOTS,
	///
	LM_TK_LIMIT,
	///
	LM_TK_PROTECT,
	///
	LM_TK_STY,
	///
	LM_TK_SPECIAL,
	///
	LM_TK_ARGUMENT, 
	///
	LM_TK_NEWCOMMAND,
	///
	LM_TK_MATH,
	///
	LM_TK_NOT,
	///
	LM_TK_KERN,
	///
	LM_TK_UNDERSET,
	///
	LM_TK_STACK
};


///
struct latexkeys {
	/// name of the macro or primitive
	string name;
	/// one of the categories above
	MathTokenEnum token;
	/// an id within a category if needed (only for spaces?)
	unsigned int id;
	/// which font to use (optional)
	unsigned int latex_font_id;
	/// operator/...
	string type;
	/// how is this called as XML entity?
	string xmlname;
};


/// check whether this is a well-known (La)TeX macro or primitive
latexkeys const * in_word_set(string const & str);

/// parse formula from a string
bool mathed_parse_normal(MathAtom &, string const &);
/// ... a stream
bool mathed_parse_normal(MathAtom &, std::istream &);
/// ... the LyX lexxer
bool mathed_parse_normal(MathAtom &, LyXLex &);

/// parse a macro definition from a string, enter it into the macro table
bool mathed_parse_macro(string &, string const &);
/// ... a stream
bool mathed_parse_macro(string &, std::istream &);
/// ... the LyX lexxer
bool mathed_parse_macro(string &, LyXLex &);

/// parse a single cell from a string
void mathed_parse_cell(MathArray & ar, string const &);
/// ... a stream
void mathed_parse_cell(MathArray & ar, std::istream &);

#endif