root/slw/abs_text_console.h

/*  Abstract text console class
 *
 *  (C) Copyright 2004-2006 Denis Rojo <jaromil@dyne.org>
 *
 * This source code is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Public License as published 
 * by the Free Software Foundation; either version 2 of the License,
 * or (at your option) any later version.
 *
 * This source code is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * Please refer to the GNU Public License for more details.
 *
 * You should have received a copy of the GNU Public License along with
 * this source code; if not, write to:
 * Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * =========
 * This class provides abstract functionalities for a text console with
 * full editing scrolling and history. It makes use of linked lists and
 * it is optimized for speed. It still misses word wrapping.
 *
 * It is a pure virtual class and as such needs to be inherited by a
 * class implementing init() feed(int key) and refresh().
 *
 */

#ifndef __TEXT_CONSOLE_H__
#define __TEXT_CONSOLE_H__

#include <linklist.h>

#include <keycodes.h>

#define ROWCHUNK 128




class Row;

class TextConsole {

 public:
  TextConsole();
  virtual ~TextConsole();
  
  
  bool feed(int key);
  
  bool refresh(); ///< refresh all visible rows
  void refresh_current(); ///< refresh row at current cursor position
  
  // pure virtual functions to be overloaded by the implementation
  
  virtual void blank() =0; ///< blank the whole screeen
  virtual void blank_row(int r) =0; ///< blank screen at row

  virtual int putnch(CHAR *str, int x, int y, int nchars) =0;
  ///< draw a string of certain length at given x,y position
  
  ////////////////////////
  
  
  int move_string(Row *dest, Row *src, int len);
  ///< move a string from a row to another
  
  bool scroll; ///< if true we have vertical scrolling
  
  int w, h; ///< geometry
  
  int cur_x, cur_y; ///< cursor positioning
  
  Linklist rows;
  Row *cur_row;
  Row *vis_row_in;
  
  
  // void refresh_row(int y);
  ///< refresh row at position y
  
  
  // void refresh_below();
  ///< refresh all lines below the current cursor position
  
};


class Row : public Entry {
        
 public:
  Row();
  ~Row();
  
  /** this class implements a couple of methods to insert and
   * delete text in each row
   * the property 'pos' in each row is the current position,
   * meaning that operations are executed in that point
   * call it 'procedural pointer?'
   * it's just a way to save an argument in functions :)
   */
  
  int insert_char(CHAR ch);
  ///< insert a single char at current pos
  
  int insert_string(CHAR *str, int inlen);
  ///< instert string at pos
  
  int delete_string(int dlen);
  ///< delete a string right of current pos
  
  int backspace(); // deletes one char left of pos
  
  //            clear_right(int p); // clear all chars right of pos
  //            clear_left(int p); // clear all chars left of pos
  
  int len;
  int pos;
  
  CHAR *text;
  
  
 private:
  bool fit(int l); ///< realloc if necess. to fit in +len
  int max; // current allocated maximum
};


 

#endif