cppconsui/TextEdit.h

   1 /*
   2  * Copyright (C) 2010-2013 by CenterIM developers
   3  *
   4  * This file is part of CenterIM.
   5  *
   6  * CenterIM is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * CenterIM is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  *
  19  */
  20
  21 /**
  22  * @file
  23  * TextEdit class
  24  *
  25  * @ingroup cppconsui
  26  */
  27
  28 #ifndef __TEXTEDIT_H__
  29 #define __TEXTEDIT_H__
  30
  31 #include "Widget.h"
  32
  33 #include <deque>
  34
  35 namespace CppConsUI
  36 {
  37
  38 class TextEdit
  39 : public Widget
  40 {
  41 public:
  42   enum Flag {
  43     FLAG_NUMERIC = 1 << 0,
  44     FLAG_NOSPACE = 1 << 1
  45   };
  46
  47   TextEdit(int w, int h, const char *text_ = NULL, int flags_ = 0,
  48       bool single_line = false, bool accept_tabs_ = true,
  49       bool masked_ = false);
  50   virtual ~TextEdit();
  51
  52   // InputProcessor
  53   virtual bool processInputText(const TermKeyKey &key);
  54
  55   // Widget
  56   virtual void draw(Curses::ViewPort area);
  57
  58   /**
  59    * Sets new text.
  60    */
  61   virtual void setText(const char *new_text);
  62   /**
  63    * Removes all text.
  64    */
  65   virtual void clear();
  66   /**
  67    * Returns inserted text.
  68    */
  69   virtual const char *getText() const;
  70
  71   virtual size_t getTextLength() const { return text_length; }
  72
  73   virtual void setFlags(int new_flags, bool revalidate = true);
  74   virtual int getFlags() const { return flags; }
  75
  76   virtual void setSingleLineMode(bool new_single_line_mode);
  77   virtual bool isSingleLineMode() const { return single_line_mode; }
  78
  79   virtual void setAcceptTabs(bool new_accept_tabs);
  80   virtual bool doesAcceptTabs() const { return accept_tabs; }
  81
  82   virtual void setMasked(bool new_masked);
  83   virtual bool isMasked() const { return masked; }
  84
  85   sigc::signal<void, TextEdit&> signal_text_change;
  86
  87 protected:
  88   enum Direction {
  89     DIR_BACK,
  90     DIR_FORWARD
  91   };
  92
  93   enum CursorMovement {
  94     MOVE_LOGICAL_POSITIONS,
  95     MOVE_VISUAL_POSITIONS,
  96     MOVE_WORDS,
  97     MOVE_DISPLAY_LINES,
  98     MOVE_DISPLAY_LINE_ENDS,
  99     MOVE_PARAGRAPHS,
 100     MOVE_PARAGRAPH_ENDS,
 101     MOVE_PAGES,
 102     MOVE_BUFFER_ENDS,
 103     MOVE_HORIZONTAL_PAGES
 104   };
 105
 106   enum DeleteType {
 107     DELETE_CHARS,
 108     DELETE_WORD_ENDS
 109   };
 110
 111   struct ScreenLine
 112   {
 113     /**
 114      * Pointer to the start of line (points into buffer).
 115      */
 116     const char *start;
 117     /**
 118      * Pointer to the first byte that is not part of this line.
 119      */
 120     const char *end;
 121     /**
 122      * Precalculated length.
 123      */
 124     size_t length;
 125
 126     ScreenLine(const char *start_, const char *end_, size_t length_)
 127       : start(start_), end(end_), length(length_) {}
 128     bool operator==(const ScreenLine& other) const;
 129   };
 130
 131   struct CmpScreenLineEnd
 132   {
 133     bool operator()(ScreenLine& sline, const char *tag);
 134   };
 135
 136   typedef std::deque<ScreenLine> ScreenLines;
 137
 138   ScreenLines screen_lines;
 139
 140   /**
 141    * Bitmask indicating which input is accepted.
 142    */
 143   int flags;
 144   bool editable;
 145   bool overwrite_mode;
 146   bool single_line_mode;
 147   bool accept_tabs;
 148   bool masked;
 149
 150   /**
 151    * Character position from the start of buffer.
 152    */
 153   size_t current_pos;
 154   /**
 155    * Cursor location in the buffer.
 156    */
 157   mutable char *point;
 158
 159   /**
 160    * Current cursor line (derived from current_pos and screen_lines).
 161    */
 162   size_t current_sc_line;
 163   /**
 164    * Current cursor character number (in the current line).
 165    */
 166   size_t current_sc_linepos;
 167   /**
 168    * Holds index into screen_lines that marks the first screen line.
 169    */
 170   size_t view_top;
 171
 172   /**
 173    * Start of text buffer.
 174    */
 175   char *buffer;
 176   /**
 177    * First location outside buffer.
 178    */
 179   char *bufend;
 180   /**
 181    * Start of gap.
 182    */
 183   mutable char *gapstart;
 184   /**
 185    * First location after the gap end.
 186    */
 187   mutable char *gapend;
 188   /**
 189    * Length in use, in chars.
 190    */
 191   size_t text_length;
 192
 193   mutable bool screen_lines_dirty;
 194
 195   // Widget
 196   virtual void updateArea();
 197
 198   virtual void initBuffer(size_t size);
 199   virtual size_t getGapSize() const;
 200   virtual void expandGap(size_t size);
 201   virtual void moveGapToCursor();
 202
 203   virtual char *getTextStart() const;
 204   virtual char *prevChar(const char *p) const;
 205   virtual char *nextChar(const char *p) const;
 206   virtual int width(const char *start, size_t chars) const;
 207   /**
 208    * Returns on-screen width of a given character in the same fashion as
 209    * Curses::onscreen_width() does but handles the tab character and wide
 210    * characters properly if the masked mode is active.
 211    */
 212   virtual int onScreenWidth(UTF8::UniChar uc, int w = 0) const;
 213
 214   virtual char *getScreenLine(const char *text, int max_width,
 215       size_t *res_length) const;
 216   /**
 217    * Recalculates all screen lines.
 218    */
 219   virtual void updateScreenLines();
 220   /**
 221    * Recalculates necessary amout of screen lines.
 222    */
 223   virtual void updateScreenLines(const char *begin, const char *end);
 224   virtual void assertUpdatedScreenLines();
 225
 226   /**
 227    * Recalculates screen cursor position based on current_pos and
 228    * screen_lines, sets current_sc_line and current_sc_linepos and handles
 229    * scrolling if necessary.
 230    */
 231   virtual void updateScreenCursor();
 232
 233   /**
 234    * Inserts given text at the current cursor position.
 235    */
 236   virtual void insertTextAtCursor(const char *new_text,
 237       size_t new_text_bytes);
 238   virtual void insertTextAtCursor(const char *new_text);
 239   virtual void deleteFromCursor(DeleteType type, Direction dir);
 240   virtual void moveCursor(CursorMovement step, Direction dir);
 241
 242   virtual void toggleOverwrite();
 243
 244   virtual size_t moveLogicallyFromCursor(Direction dir) const;
 245   virtual size_t moveWordFromCursor(Direction dir, bool word_end) const;
 246
 247 private:
 248   CONSUI_DISABLE_COPY(TextEdit);
 249
 250   void actionMoveCursor(CursorMovement step, Direction dir);
 251   void actionDelete(DeleteType type, Direction dir);
 252   void actionToggleOverwrite();
 253
 254   void declareBindables();
 255 };
 256
 257 } // namespace CppConsUI
 258
 259 #endif // __TEXTEDIT_H__
 260
 261 /* vim: set tabstop=2 shiftwidth=2 textwidth=78 expandtab : */