// -*- C++ -*-
/*
 *  File:        formulabase.h
 *  Purpose:     Common parts of the math LyX insets
 *  Author:      André Pönitz
 *  Created:     May 2001
 *  Description: Allows the edition of math paragraphs inside Lyx. 
 *
 *  Copyright: 2001, The LyX Project
 *
 *   You are free to use and modify this code under the terms of
 *   the GNU General Public Licence version 2 or later.
 */

#ifndef INSET_FORMULABASE_H 
#define INSET_FORMULABASE_H

#ifdef __GNUG__
#pragma interface
#endif

#include <iosfwd>
#include "insets/inset.h"

// only for getType():
#include "math_defs.h"

class Buffer;
class BufferView;
class MathInset;

///
class InsetFormulaBase : public UpdatableInset {
public:
	///
	InsetFormulaBase();
	///
	virtual int ascent(BufferView *, LyXFont const &) const = 0;
	///
	virtual int descent(BufferView *, LyXFont const &) const = 0;
	///
	virtual int width(BufferView *, LyXFont const &) const = 0;
	///
	virtual void draw(BufferView *,LyXFont const &, int, float &, bool) const = 0;

	/// These are just wrappers taking the unused Buffer * dummy parameter
	/// 
	virtual void write(Buffer const *, std::ostream &) const;
	///
	virtual void read(Buffer const *, LyXLex & lex);
	///
	virtual int latex(Buffer const *, std::ostream &,
		  bool fragile, bool free_spc) const;
	///
	virtual int ascii(Buffer const *, std::ostream &, int linelen) const;
	///
	virtual int linuxdoc(Buffer const *, std::ostream &) const;
	///
	virtual int docBook(Buffer const *, std::ostream &) const;
	///
	virtual MathInsetTypes getType() const = 0;

protected:
	/// the actual functions don't use the Buffer * parameter
	///
	virtual void write(std::ostream &) const = 0;
	///
	virtual void read(LyXLex & lex) = 0;
	///
	virtual int latex(std::ostream &, bool fragile, bool free_spc) const = 0;
	///
	virtual int ascii(std::ostream &, int linelen) const = 0;
	///
	virtual int linuxdoc(std::ostream &) const = 0;
	///
	virtual int docBook(std::ostream &) const = 0;

public:
	///
	virtual void validate(LaTeXFeatures &) const;
	///
	virtual Inset * clone(Buffer const &, bool same_id = false) const = 0;
	///
	virtual Inset::Code lyxCode() const;
	/// what appears in the minibuffer when opening
	virtual string const editMessage() const;
	///
	virtual void edit(BufferView *, int x, int y, unsigned int button);
	virtual void edit(BufferView *, bool front = true);
	///
	virtual void toggleInsetCursor(BufferView *);
	///
	virtual void showInsetCursor(BufferView *, bool show = true);
	///
	virtual void hideInsetCursor(BufferView *);
	///
	virtual void getCursorPos(BufferView *, int &, int &) const;
	///
	virtual void toggleInsetSelection(BufferView * bv);
	///
	virtual void insetButtonPress(BufferView *, int x, int y, int button);
	///
	virtual void insetButtonRelease(BufferView *, int x, int y, int button);
	///
	virtual void insetKeyPress(XKeyEvent * ev);
	///
	virtual void insetMotionNotify(BufferView *, int x, int y, int state);
	///
	virtual void insetUnlock(BufferView *);
   
	/// To allow transparent use of math editing functions
	virtual RESULT localDispatch(BufferView *, kb_action, string const &);
    
	///
	virtual std::vector<string> const getLabelList() const;
	///
	virtual MathInset const * par() const = 0;
	///
	virtual void metrics() const = 0;
protected:
	///
	virtual void updateLocal(BufferView * bv, bool mark_dirty);
private:
	/// unimplemented
	void operator=(const InsetFormulaBase &);
};

// We don't really mess want around with mathed stuff outside mathed.
// So do it here.
//
void mathDispatchCreation(BufferView *, string const &, bool);
//
void mathDispatchMathDisplay(BufferView *, string const &);
//
void mathDispatchMathMode(BufferView *, string const &);
//
void mathDispatchMathMacro(BufferView *, string const &);
//
void mathDispatchMathDelim(BufferView *, string const &);
//
void mathDispatchInsertMath(BufferView *, string const &);
//
void mathDispatchInsertMatrix(BufferView *, string const &);
//
void mathDispatchMathImportSelection(BufferView *, string const &);

#endif