// -*- C++ -*-
/**
 * \file insettext.h
 * This file is part of LyX, the document processor.
 * Licence details can be found in the file COPYING.
 *
 * \author Jürgen Vigna
 *
 * Full author contact details are available in file CREDITS.
 */

#ifndef INSETTEXT_H
#define INSETTEXT_H

#include "updatableinset.h"
#include "support/std_string.h"
#include "LColor.h"
#include "ParagraphList_fwd.h"
#include "RowList_fwd.h"
#include "dimension.h"
#include "lyxtext.h"

#include "support/types.h"

#include "frontends/mouse_state.h"

#include <boost/shared_ptr.hpp>

class Painter;
class BufferView;
class Buffer;
class BufferParams;
class LyXCursor;
class LyXText;
class Row;
class Paragraph;

/**
 A text inset is like a TeX box to write full text
 (including styles and other insets) in a given space.
 @author: Jürgen Vigna
 */
class InsetText : public UpdatableInset {
public:
	///
	enum DrawFrame {
		///
		NEVER = 0,
		///
		LOCKED,
		///
		ALWAYS
	};
	///
	InsetText(BufferParams const &);
	///
	explicit InsetText(InsetText const &);
	///
	virtual std::auto_ptr<InsetBase> clone() const;
	///
	InsetText & operator=(InsetText const & it);
	/// empty inset to empty par, or just mark as erased
	void clear(bool just_mark_erased);
	///
	void read(Buffer const &, LyXLex &);
	///
	void write(Buffer const &, std::ostream &) const;
	///
	void metrics(MetricsInfo &, Dimension &) const;
	///
	int textWidth() const;
	///
	void draw(PainterInfo & pi, int x, int y) const;
	///
	string const editMessage() const;
	///
	bool isTextInset() const { return true; }
	///
	void insetUnlock(BufferView *);
	///
	bool lockInsetInInset(BufferView *, UpdatableInset *);
	///
	bool unlockInsetInInset(BufferView *,
				UpdatableInset *, bool lr = false);
	///
	RESULT localDispatch(FuncRequest const &);
	///
	int latex(Buffer const &, std::ostream &,
		  LatexRunParams const &) const;
	///
	int ascii(Buffer const &, std::ostream &, int linelen) const;
	///
	int linuxdoc(Buffer const &, std::ostream &) const ;
	///
	int docbook(Buffer const &, std::ostream &, bool mixcont) const ;
	///
	void validate(LaTeXFeatures & features) const;
	///
	InsetOld::Code lyxCode() const { return InsetOld::TEXT_CODE; }
	/// FIXME, document
	void getCursorPos(BufferView *, int & x, int & y) const;
	/// Get the absolute document x,y of the cursor
	virtual void getCursor(BufferView &, int &, int &) const;
	///
	int insetInInsetY() const;
	///
	void fitInsetCursor(BufferView *) const;
	///
	bool insertInset(BufferView *, InsetOld *);
	///
	bool insetAllowed(InsetOld::Code) const;
	///
	UpdatableInset * getLockingInset() const;
	///
	UpdatableInset * getFirstLockingInsetOfType(InsetOld::Code);
	///
	void setFont(BufferView *, LyXFont const &,
		     bool toggleall = false,
		     bool selectall = false);
	///
	void init(InsetText const * ins);
	///
	void writeParagraphData(Buffer const &, std::ostream &) const;
	///
	void setText(string const &, LyXFont const &);
	///
	void setAutoBreakRows(bool);
	///
	bool getAutoBreakRows() const { return autoBreakRows; }
	///
	void setDrawFrame(DrawFrame);
	///
	void setFrameColor(LColor::color);
	///
	LyXText * getLyXText(BufferView const *,
			     bool const recursive = false) const;
	///
	void setViewCache(BufferView const * bv) const;
	///
	void deleteLyXText(BufferView *, bool recursive = true) const;
	///
	bool showInsetDialog(BufferView *) const;
	///
	void getLabelList(std::vector<string> &) const;
	///
	int scroll(bool recursive = true) const;
	///
	void scroll(BufferView * bv, float sx) const {
		UpdatableInset::scroll(bv, sx);
	}
	///
	void scroll(BufferView * bv, int offset) const {
		UpdatableInset::scroll(bv, offset);
	}
	///
	void clearSelection(BufferView * bv);
	///
	InsetOld * getInsetFromID(int id) const;
	///
	ParagraphList * getParagraphs(int) const;
	///
	LyXCursor const & cursor(BufferView *) const;
	///
	bool allowSpellcheck() const { return true; }
	///
	WordLangTuple const
	selectNextWordToSpellcheck(BufferView *, float & value) const;
	///
	void selectSelectedWord(BufferView *);

	/// mark as erased for change tracking
	void markErased() { clear(true); };
	/**
	 * Mark as new. Used when pasting in tabular, and adding rows
	 * or columns. Note that pasting will ensure that tracking already
	 * happens, and this just resets the changes for the copied text,
	 * whereas for row/col add, we need to start tracking changes
	 * for the (empty) paragraph contained.
	 */
	void markNew(bool track_changes = false);
	/// find next change
	bool nextChange(BufferView *, lyx::pos_type & length);

	///
	bool searchForward(BufferView *, string const &,
			   bool = true, bool = false);
	///
	bool searchBackward(BufferView *, string const &,
			    bool = true, bool = false);
	///
	bool checkInsertChar(LyXFont &);
	///
	void getDrawFont(LyXFont &) const;
	/// append text onto the existing text
	void appendParagraphs(Buffer * bp, ParagraphList &);

	///
	void addPreview(lyx::graphics::PreviewLoader &) const;

	///
	bool haveParagraphs() const {
		return true;
	}
	///
	mutable ParagraphList paragraphs;
protected:
	///
	void updateLocal(BufferView *, bool mark_dirty);
	/// set parameters for an initial lock of this inset
	void lockInset(BufferView *);
	/// lock an inset inside this one
	void lockInset(BufferView *, UpdatableInset *);
	///
	mutable int drawTextXOffset;
	///
	mutable int drawTextYOffset;
	///
	bool autoBreakRows;
	///
	DrawFrame drawFrame_;
	///
	LColor::color frame_color;

private:
	///
	void lfunMousePress(FuncRequest const &);
	///
	bool lfunMouseRelease(FuncRequest const &);
	///
	void lfunMouseMotion(FuncRequest const &);

	///
	RESULT moveRight(BufferView *);
	///
	RESULT moveLeft(BufferView *);
	///
	RESULT moveRightIntern(BufferView *, bool front,
					       bool activate_inset = true,
					       bool selecting = false);
	///
	RESULT moveLeftIntern(BufferView *, bool front,
					      bool activate_inset = true,
					      bool selecting = false);

	///
	RESULT moveUp(BufferView *);
	///
	RESULT moveDown(BufferView *);
	///
	void setCharFont(Buffer const &, int pos, LyXFont const & font);
	///
	bool checkAndActivateInset(BufferView * bv, bool front);
	///
	bool checkAndActivateInset(BufferView * bv, int x = 0, int y = 0,
				   mouse_button::state button = mouse_button::none);
	///
	void removeNewlines();
	///
	int cx() const;
	///
	int cy() const;
	///
	lyx::pos_type cpos() const;
	///
	ParagraphList::iterator cpar() const;
	///
	bool cboundary() const;
	///
	RowList::iterator crow() const;
	///
	void drawFrame(Painter &, int x) const;
	///
	void clearInset(BufferView *, int start_x, int baseline) const;
	///
	void collapseParagraphs(BufferView *);

	/* Private structures and variables */
	///
	mutable bool locked;
	///
	mutable int top_y;
	///
	ParagraphList::iterator inset_par;
	///
	lyx::pos_type inset_pos;
	///
	bool inset_boundary;
	///
	mutable int inset_x;
	///
	mutable int inset_y;
	///
	bool no_selection;
	///
	UpdatableInset * the_locking_inset;
	///
	mutable ParagraphList::iterator old_par;

	///
	// to remember old painted frame dimensions to clear it on the right spot!
	///
	mutable bool in_insetAllowed;
	///
	// these are used to check for mouse movement in Motion selection code
	///
	int mouse_x;
	int mouse_y;
public:
	///
	mutable LyXText text_;
	///
	mutable int textwidth_;
};
#endif