lyx_mirror/src/lyxtext.h
Lars Gullik Bjønnes c46b7d8955 Merge the unicode branch into trunk.
- src/support/unicode.[Ch]: new files with functions for converting
  to and fro ucs4, ucs2 and utf8.
- src/support/docstring.h: specialization of basic_string that
  holds a uint32_t internally.
- Several functions changed to use char_type instead of char or unsigned char.
- Qt3 and Qt4 sends ucs2 on to core
- Gtk sends ucs4 on to core
- Read and write utf-8 .lyx files.
- font_metrics and painter updated to handle ucs4 chars as input.
- Quite a bit of ugly compability code, conversion string->docstring, etc.
- Have fun...


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@14661 a592a061-630c-0410-9148-cb99ea01b6c8
2006-08-13 22:54:59 +00:00

405 lines
11 KiB
C++

// -*- C++ -*-
/**
* \file lyxtext.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author unknown
* \author Lars Gullik Bjønnes
* \author John Levon
*
* Full author contact details are available in file CREDITS.
*/
#ifndef LYXTEXT_H
#define LYXTEXT_H
#include "bufferview_funcs.h"
#include "Bidi.h"
#include "dispatchresult.h"
#include "dimension.h"
#include "lyxfont.h"
#include "layout.h"
#include "lyxlayout_ptr_fwd.h"
#include "ParagraphList.h"
#include <iosfwd>
class Buffer;
class BufferParams;
class BufferView;
class CursorSlice;
class Dimension;
class ErrorList;
class InsetBase;
class InsetBase_code;
class FuncRequest;
class FuncStatus;
class LColor_color;
class LCursor;
class LyXTextClass;
class MetricsInfo;
class PainterInfo;
class Row;
class RowMetrics;
class Spacing;
/// This class encapsulates the main text data and operations in LyX
class LyXText {
public:
///
typedef lyx::pos_type pos_type;
///
typedef lyx::char_type char_type;
///
typedef lyx::pit_type pit_type;
/// constructor
explicit LyXText(BufferView *);
///
void init(BufferView *);
///
LyXFont getFont(Paragraph const & par, pos_type pos) const;
///
void applyOuterFont(LyXFont &) const;
///
LyXFont getLayoutFont(pit_type pit) const;
///
LyXFont getLabelFont(Paragraph const & par) const;
///
void setCharFont(pit_type pit, pos_type pos, LyXFont const & font);
///
void setCharFont(pit_type pit, pos_type pos, LyXFont const & font,
bool toggleall);
/// what you expect when pressing <enter> at cursor position
void breakParagraph(LCursor & cur, bool keep_layout = false);
/// set layout over selection
void setLayout(pit_type start, pit_type end,
std::string const & layout);
///
void setLayout(LCursor & cur, std::string const & layout);
/// what type of depth change to make
enum DEPTH_CHANGE {
INC_DEPTH,
DEC_DEPTH
};
/// Increase or decrease the nesting depth of the selected paragraph(s)
void changeDepth(LCursor & cur, DEPTH_CHANGE type);
/// Returns whether something would be changed by changeDepth
bool changeDepthAllowed(LCursor & cur, DEPTH_CHANGE type) const;
/// Set font over selection paragraphs and rebreak.
void setFont(LCursor & cur, LyXFont const &, bool toggleall = false);
/// rebreaks the given par
bool redoParagraph(pit_type pit);
/// returns pos in given par at given x coord
pos_type x2pos(pit_type pit, int row, int x) const;
int pos2x(pit_type pit, pos_type pos) const;
///
void toggleFree(LCursor & cur, LyXFont const &, bool toggleall = false);
///
std::string getStringToIndex(LCursor const & cur);
/// insert a character at cursor position
void insertChar(LCursor & cur, lyx::char_type c);
/// insert an inset at cursor position
void insertInset(LCursor & cur, InsetBase * inset);
/// compute text metrics
void metrics(MetricsInfo & mi, Dimension & dim);
/// draw text (only used for insets)
void draw(PainterInfo & pi, int x, int y) const;
/// draw textselection
void drawSelection(PainterInfo & pi, int x, int y) const;
/// try to handle that request
void dispatch(LCursor & cur, FuncRequest & cmd);
/// do we want to handle this event?
bool getStatus(LCursor & cur, FuncRequest const & cmd,
FuncStatus & status) const;
/// access to out BufferView. This should go...
BufferView * bv() const;
/// read-only access to individual paragraph
Paragraph const & getPar(pit_type pit) const { return pars_[pit]; }
/// read-write access to individual paragraph
Paragraph & getPar(pit_type pit) { return pars_[pit]; }
// Returns the current font and depth as a message.
std::string currentState(LCursor & cur);
/** returns row near the specified
* y-coordinate in given paragraph (relative to the screen).
*/
Row const & getRowNearY(int y, pit_type pit) const;
pit_type getPitNearY(int y) const;
/** returns the column near the specified x-coordinate of the row
x is set to the real beginning of this column
*/
pos_type getColumnNearX(pit_type pit,
Row const & row, int & x, bool & boundary) const;
/** Find the word under \c from in the relative location
* defined by \c word_location.
* @param from return here the start of the word
* @param to return here the end of the word
*/
void getWord(CursorSlice & from, CursorSlice & to, lyx::word_location const);
/// just selects the word the cursor is in
void selectWord(LCursor & cur, lyx::word_location loc);
/// accept selected change
void acceptChange(LCursor & cur);
/// reject selected change
void rejectChange(LCursor & cur);
/// returns true if par was empty and was removed
bool setCursor(LCursor & cur, pit_type par, pos_type pos,
bool setfont = true, bool boundary = false);
///
void setCursor(CursorSlice &, pit_type par, pos_type pos);
///
void setCursorIntern(LCursor & cur, pit_type par,
pos_type pos, bool setfont = true, bool boundary = false);
///
void setCurrentFont(LCursor & cur);
///
void recUndo(pit_type first, pit_type last) const;
///
void recUndo(pit_type first) const;
/// returns true if par was empty and was removed
bool setCursorFromCoordinates(LCursor & cur, int x, int y);
///
InsetBase * editXY(LCursor & cur, int x, int y);
/// Move cursor one line up.
/**
* Returns true if an update is needed after the move.
*/
bool cursorUp(LCursor & cur);
/// Move cursor one line down.
/**
* Returns true if an update is needed after the move.
*/
bool cursorDown(LCursor & cur);
/// Move cursor one position left
/**
* Returns true if an update is needed after the move.
*/
bool cursorLeft(LCursor & cur);
/// Move cursor one position right
/**
* Returns true if an update is needed after the move.
*/
bool cursorRight(LCursor & cur);
///
bool cursorLeftOneWord(LCursor & cur);
///
bool cursorRightOneWord(LCursor & cur);
///
bool cursorUpParagraph(LCursor & cur);
///
bool cursorDownParagraph(LCursor & cur);
///
bool cursorHome(LCursor & cur);
///
bool cursorEnd(LCursor & cur);
///
bool cursorPrevious(LCursor & cur);
///
bool cursorNext(LCursor & cur);
///
bool cursorTop(LCursor & cur);
///
bool cursorBottom(LCursor & cur);
/// Erase character at cursor. Honour change tracking
bool erase(LCursor & cur);
/** At cursor position 0, merge paragraph with the one before it.
* Ignore CT (this is used in \c acceptChange, \c rejectChange for
* physical deletion of paragraph break)
*/
bool backspacePos0(LCursor & cur);
/// Delete character before cursor. Honour CT
bool backspace(LCursor & cur);
///
bool selectWordWhenUnderCursor(LCursor & cur, lyx::word_location);
///
enum TextCase {
///
text_lowercase = 0,
///
text_capitalization = 1,
///
text_uppercase = 2
};
/// Change the case of the word at cursor position.
void changeCase(LCursor & cur, TextCase action);
/** the DTP switches for paragraphs. LyX will store the top settings
always in the first physical paragraph, the bottom settings in the
last. When a paragraph is broken, the top settings rest, the bottom
settings are given to the new one.
*/
void setParagraph(LCursor & cur,
Spacing const & spacing,
LyXAlignment align,
std::string const & labelwidthstring,
bool noindent);
/* these things are for search and replace */
/// needed to insert the selection
void insertStringAsLines(LCursor & cur, std::string const & str);
/// needed to insert the selection
void insertStringAsParagraphs(LCursor & cur, std::string const & str);
/// current text width
int width() const;
/// current text heigth
int height() const;
/// Returns an inset if inset was hit, or 0 if not.
InsetBase * checkInsetHit(int x, int y) const;
///
int singleWidth(Paragraph const & par, pos_type pos) const;
///
int singleWidth(Paragraph const & par,
pos_type pos, char_type c, LyXFont const & Font) const;
/// return the color of the canvas
LColor_color backgroundColor() const;
/**
* Returns the left beginning of the text.
* This information cannot be taken from the layout object, because
* in LaTeX the beginning of the text fits in some cases
* (for example sections) exactly the label-width.
*/
int leftMargin(pit_type pit, pos_type pos) const;
int leftMargin(pit_type pit) const;
///
int rightMargin(Paragraph const & par) const;
/** this calculates the specified parameters. needed when setting
* the cursor and when creating a visible row */
RowMetrics computeRowMetrics(pit_type pit, Row const & row) const;
/// access to our paragraphs
ParagraphList const & paragraphs() const { return pars_; }
ParagraphList & paragraphs() { return pars_; }
/// return true if this is the main text
bool isMainText() const;
/// return first row of text
Row const & firstRow() const;
/// is this row the last in the text?
bool isLastRow(pit_type pit, Row const & row) const;
/// is this row the first in the text?
bool isFirstRow(pit_type pit, Row const & row) const;
///
double spacing(Paragraph const & par) const;
/// make a suggestion for a label
std::string getPossibleLabel(LCursor & cur) const;
/// is this paragraph right-to-left?
bool isRTL(Paragraph const & par) const;
///
bool checkAndActivateInset(LCursor & cur, bool front);
///
void write(Buffer const & buf, std::ostream & os) const;
/// returns whether we've seen our usual 'end' marker
bool read(Buffer const & buf, LyXLex & lex, ErrorList & errorList);
///
int ascent() const;
///
int descent() const;
///
int cursorX(CursorSlice const & cursor, bool boundary) const;
///
int cursorY(CursorSlice const & cursor, bool boundary) const;
/// delete double space or empty paragraphs around old cursor
bool deleteEmptyParagraphMechanism(LCursor & cur, LCursor & old);
public:
///
Dimension dim_;
///
int maxwidth_;
/// the current font settings
LyXFont current_font;
/// the current font
LyXFont real_current_font;
///
int background_color_;
/// only the top-level LyXText has this non-zero
BufferView * bv_owner;
///
mutable Bidi bidi;
///
ParagraphList pars_;
/// our 'outermost' font. This is handed down from the surrounding
// inset through the pi/mi parameter (pi.base.font)
LyXFont font_;
///
bool autoBreakRows_;
private:
/// return past-the-last paragraph influenced by a layout
/// change on pit
pit_type undoSpan(pit_type pit);
/// Calculate and set the height of the row
void setHeightOfRow(pit_type, Row & row);
// fix the cursor `cur' after a characters has been deleted at `where'
// position. Called by deleteEmptyParagraphMechanism
void fixCursorAfterDelete(CursorSlice & cur, CursorSlice const & where);
///
void deleteWordForward(LCursor & cur);
///
void deleteWordBackward(LCursor & cur);
///
void deleteLineForward(LCursor & cur);
/// sets row.end to the pos value *after* which a row should break.
/// for example, the pos after which isNewLine(pos) == true
void rowBreakPoint(pit_type pit, Row & row) const;
/// sets row.width to the minimum space a row needs on the screen in pixel
void setRowWidth(pit_type pit, Row & row) const;
/// the minimum space a manual label needs on the screen in pixels
int labelFill(Paragraph const & par, Row const & row) const;
/// FIXME
int labelEnd(pit_type pit) const;
///
void charInserted();
/// set 'number' font property
void number(LCursor & cur);
};
/// return the default height of a row in pixels, considering font zoom
int defaultRowHeight();
#endif // LYXTEXT_H