text_object.h

Go to the documentation of this file.

//                                                                          //
//    _               _               _      _              _       _       //
//   | |_  ___ __  __| |_       ___  | |__  (_)  ___   ___ | |_    | |__    //
//   | __|/ _ \\ \/ /| __|     / _ \ | '_ \ | | / _ \ / __|| __|   | '_ \   //
//   | |_|  __/ >  < | |_     | (_) || |_) || ||  __/| (__ | |_  _ | | | |  //
//    \__|\___|/_/\_\ \__|_____\___/ |_.__/_/ | \___| \___| \__|(_)|_| |_|  //
//                       |_____|          |__/                              //
//                                                                          //
//                                                                          //

/*****************************************************************************

    X11workbench - X11 programmer's 'work bench' application and toolkit
    Copyright (c) 2010-2019 by Bob Frazier (aka 'Big Bad Bombastic Bob')


  DISCLAIMER:  The X11workbench application and toolkit software are supplied
               'as-is', with no warranties, either implied or explicit.
               Any claims to alleged functionality or features should be
               considered 'preliminary', and might not function as advertised.

  MIT-like license:

  There is no restriction as to what you can do with this software, so long
  as you include the above copyright notice and DISCLAIMER for any distributed
  work that is equal to or derived from this one, along with this paragraph
  that explains the terms of the license if the source is also being made
  available.  A "derived work" describes a work that uses a significant portion
  of the source files or algorithms that are included with this one.
  Specifically excluded from this are files that were generated by the software,
  or anything that is included with the software that is part of another package
  (such as files that were created or added during the 'configure' process).
  Specifically included is the use of part or all of any of the X11 workbench
  toolkit source or header files in your distributed application.  If you do not
  ship the source, the above copyright statement is still required to be placed
  in a reasonably prominent place, such as documentation, splash screens, and/or
  'about the application' dialog boxes.

  Use and distribution are in accordance with GPL, LGPL, and/or the above
  MIT-like license.  See COPYING and README files for more information.


  Additional information at http://sourceforge.net/projects/X11workbench

******************************************************************************/


#ifndef _TEXT_OBJECT_H_INCLUDED_
#define _TEXT_OBJECT_H_INCLUDED_

#include "window_helper.h"

#ifdef __cplusplus
extern "C" {
#endif // __cplusplus


// FILE TYPE CONSTANTS

enum e_FileType
{
  FileType_PLAIN_TEXT    = 0,       
  FileType_PROGRAM       = 1,       
  FileType_RESOURCE      = 2,       
  FileType_XML           = 3,       
  FileType_MAKEFILE      = 4,       

  FileType_CUSTOM_FLAG   = 0x80,    

  FileType_MASK          = 0xff,    

  // additional bits are reserved (for now)

  // and now the bit flags
  FileType_HARDTAB       = 0x10000, 
  FileType_RESERVED2     = 0x20000, 
  FileType_RESERVED3     = 0x40000, 
  FileType_RESERVED4     = 0x80000  
};

enum e_LineFeed
{
  LineFeed_NONE          = -1,  
  LineFeed_DEFAULT       = 0,   
  LineFeed_NEWLINE       = 1,   
  LineFeed_RETURN        = 2,   
  LineFeed_CRLF          = 3,   
  LineFeed_LFCR          = 4,   
  LineFeed_ENTRYCOUNT    = 5    
};

enum e_SelectMode
{
  SelectMode_DEFAULT    = 0,    
  SelectMode_CHAR       = 1,    
  SelectMode_LINE       = 2,    
  SelectMode_BOX        = 3     
};

enum e_InsertMode
{
  InsertMode_DEFAULT     = 0,   
  InsertMode_INSERT      = 1,   
  InsertMode_OVERWRITE   = 2    
};

enum e_DragState
{
  DragState_NONE         = 0,   
  DragState_CURSOR       = 1,   
  DragState_MOUSE        = 2    
};

#define HARD_TAB_CHAR '\xa0' 
#define DEFAULT_TAB_WIDTH 8 
#define AUTO_HSCROLL_SIZE 8 
#define MIN_LINE_SPACING 2 
#define MIN_BORDER_SPACING 2 
// define the interface for the object

//struct s_text_object; // forward declaration
typedef struct s_text_object TEXT_OBJECT; // forward declaration

struct s_text_object_vtable
{
  void (* destroy)(TEXT_OBJECT *pThis);

  void (* init)(TEXT_OBJECT *pThis);

  void (* highlight_colors)(TEXT_OBJECT *pThis, XColor clrHFG, XColor clrHBG);

  char * (* get_text)(TEXT_OBJECT *pThis);

  void (* set_text)(TEXT_OBJECT *pThis, const char *szText, unsigned long cbLen);

  int (* get_rows)(const TEXT_OBJECT *pThis);

  int (* get_cols)(TEXT_OBJECT *pThis);

  int (* get_filetype)(const TEXT_OBJECT *pThis);

  void (* set_filetype)(TEXT_OBJECT *pThis, int iLineFeed);

  int (* get_linefeed)(const TEXT_OBJECT *pThis);

  void (* set_linefeed)(TEXT_OBJECT *pThis, int iLineFeed);

  int (* get_insmode)(const TEXT_OBJECT *pThis);

  void (* set_insmode)(TEXT_OBJECT *pThis, int iInsMode);

  int (* get_selmode)(const TEXT_OBJECT *pThis);

  void (* set_selmode)(TEXT_OBJECT *pThis, int iSelMode);

  int (* get_tab)(const TEXT_OBJECT *pThis);

  void (* set_tab)(TEXT_OBJECT *pThis, int iTab);

  int (* get_scrollmode)(const TEXT_OBJECT *pThis);

  void (* set_scrollmode)(TEXT_OBJECT *pThis, int iScrollMode);

  void (* get_select)(const TEXT_OBJECT *pThis, WB_RECT *pRct);

  void (* set_select)(TEXT_OBJECT *pThis, const WB_RECT *pRct);

  int (* has_select)(const TEXT_OBJECT *pThis);

  char* (* get_sel_text)(const TEXT_OBJECT *pThis, const WB_RECT *pRct);

  int (* get_row)(const TEXT_OBJECT *pThis);

  void (* set_row)(TEXT_OBJECT *pThis, int iRow);

  int (* get_col)(const TEXT_OBJECT *pThis);

  void (* set_col)(TEXT_OBJECT *pThis, int iCol);

  void (* del_select)(TEXT_OBJECT *pThis);

  void (* replace_select)(TEXT_OBJECT *pThis, const char *szText, unsigned long cbLen);

  void (* del_chars)(TEXT_OBJECT *pThis, int nChar); // delete 1 or more chars, negative deletes BEFORE cursor, 0 does nothing

  void (* ins_chars)(TEXT_OBJECT *pThis, const char *pChar, int nChar);

  void (* indent)(TEXT_OBJECT *pThis, int nCol);

  int (* can_undo)(TEXT_OBJECT *pThis);

  void (* undo)(TEXT_OBJECT *pThis);

  int (* can_redo)(TEXT_OBJECT *pThis);

  void (* redo)(TEXT_OBJECT *pThis);

  void (* get_view)(const TEXT_OBJECT *pThis, WB_RECT *pRct);
  void (* set_view_orig)(TEXT_OBJECT *pThis, const WB_POINT *pOrig);

  void (* begin_highlight)(TEXT_OBJECT *pThis);
  void (* end_highlight)(TEXT_OBJECT *pThis);

  // mouse conversion

  void (* mouse_click)(TEXT_OBJECT *pThis, int iMouseXDelta, int iMouseYDelta, int iType, int iACS);

  void (* begin_mouse_drag)(TEXT_OBJECT *pThis);
  void (* end_mouse_drag)(TEXT_OBJECT *pThis);

  // cursor motion

  void (* cursor_up)(TEXT_OBJECT *pThis);

  void (* cursor_down)(TEXT_OBJECT *pThis);

  void (* cursor_left)(TEXT_OBJECT *pThis);

  void (* cursor_right)(TEXT_OBJECT *pThis);

  void (* page_up)(TEXT_OBJECT *pThis);

  void (* page_down)(TEXT_OBJECT *pThis);

  void (* page_left)(TEXT_OBJECT *pThis);

  void (* page_right)(TEXT_OBJECT *pThis);

  void (* cursor_home)(TEXT_OBJECT *pThis);

  void (* cursor_end)(TEXT_OBJECT *pThis);

  void (* cursor_top)(TEXT_OBJECT *pThis);

  void (* cursor_bottom)(TEXT_OBJECT *pThis);

  void (* scroll_vertical)(TEXT_OBJECT *pThis, int nRows);

  void (* scroll_horizontal)(TEXT_OBJECT *pThis, int nCols);


  // handling expose events for the text area

  void (* do_expose)(TEXT_OBJECT *pThis, Display *pDisplay, Window wID,
                     WBGC gc, const WB_GEOM *pPaintGeom, const WB_GEOM *pViewGeom,
                     WB_FONTC pFont);

  void (* cursor_blink)(TEXT_OBJECT *pThis, int bHasFocus);

  void (* set_save_point)(TEXT_OBJECT *pThis);

  int (* get_modified)(TEXT_OBJECT *pThis);


};

typedef struct s_text_object_vtable TEXT_OBJECT_VTABLE;



static __inline__ const TEXT_OBJECT_VTABLE *WBGetDefaultTextObjectVTable(void)
{
extern const TEXT_OBJECT_VTABLE WBDefaultTextObjectVTable;

 return &WBDefaultTextObjectVTable;
}


#define TEXT_OBJECT_TAG (*((const unsigned int *)"WBTX"))


struct s_text_object
{
  const TEXT_OBJECT_VTABLE *vtable;  

  unsigned int ulTag;        
  Window wIDOwner;           
  WB_RECT rctSel;            
  WB_RECT rctHighLight;      

  XColor clrHFG;             
  XColor clrHBG;             

  int iFileType;             
  enum e_LineFeed iLineFeed; 
  int iInsMode;              
  int iSelMode;              
  int iScrollMode;           
  int iTab;                  

  // cursor position
  int iRow;                  
  int iCol;                  
  int iPos;                  

  int iCursorX;              
  int iCursorY;              
  int iCursorHeight;         

  int iBlinkState;           
  int iDragState;            

  int iAsc;                  
  int iDesc;                 
  int iFontWidth;            
  int iMaxFontWidth;         

  // viewport

  WB_RECT rctView;           
  WB_RECT rctWinView;        

  // these are maintained internally - do not use
  WB_RECT rctViewOld;        
  WB_RECT rctWinViewOld;     

  // the data

  void *pText;               

  void *pUndo;               
  void *pRedo;               

  // special callback entries
  void *pColorContext;       
  unsigned long (*pColorContextCallback)(TEXT_OBJECT *,
                                         int, int); 
};

typedef struct s_text_object TEXT_OBJECT;

static __inline__ int WBIsValidTextObject(const TEXT_OBJECT *pObj)
{
  return pObj && pObj->ulTag == TEXT_OBJECT_TAG;
}

static __inline__ void WBInitializeInPlaceTextObject(TEXT_OBJECT *pTextObject, Window wIDOwner)
{
  if(pTextObject)
  {
    bzero(pTextObject, sizeof(*pTextObject)); // most contained things will accept 'nulling' as "unassigned"

    pTextObject->vtable = WBGetDefaultTextObjectVTable();
    pTextObject->vtable->init(pTextObject);

    pTextObject->wIDOwner = wIDOwner;
  }
}

static __inline__ void WBDestroyInPlaceTextObject(TEXT_OBJECT *pTextObject)
{
  if(pTextObject &&
     WBIsValidTextObject(pTextObject) &&
     pTextObject->vtable &&
     pTextObject->vtable->destroy)
  {
    pTextObject->vtable->destroy(pTextObject);
  }
}

#define TEXT_BUFFER_LINE_CACHE_SIZE 32

struct s_text_buffer
{
  unsigned long nArraySize; 
  unsigned long nEntries;   

  // cached information
  unsigned int nMaxCol;     
  unsigned int nMinMaxCol;  
  unsigned long aLineCache[TEXT_BUFFER_LINE_CACHE_SIZE];
  unsigned int aLineCacheLen[TEXT_BUFFER_LINE_CACHE_SIZE];

  char * aLines[2];         

};

typedef struct s_text_buffer TEXT_BUFFER;


TEXT_BUFFER * WBAllocTextBuffer(const char *pBuf, unsigned int cbBufSize);

int WBCheckReAllocTextBuffer(TEXT_BUFFER **ppBuf, int nLinesToAdd);

void WBFreeTextBuffer(TEXT_BUFFER *pBuf);

int WBTextBufferLineLength(TEXT_BUFFER *pBuf, unsigned long nLine);

void WBTextBufferLineChange(TEXT_BUFFER *pBuf, unsigned long nLine, int nNewLen);

void WBTextBufferRefreshCache(TEXT_BUFFER *pBuf);

void WBTextObjectSetColorContextCallback(TEXT_OBJECT *pThis,
                                         unsigned long (*callback)(TEXT_OBJECT *pThis, int nRow, int nCol),
                                         void *pColorContextPointer);


TEXT_OBJECT *WBTextObjectConstructor(unsigned long cbStructSize, const char *szText, unsigned long cbLen, Window wIDOwner);


void WBTextObjectDestructor(TEXT_OBJECT *pObj);


int WBTextObjectCalculateLineHeight(int iAscent, int iDescent);



// MBCS-related utilities

char * WBInsertMBChars(char *pString, int iCol, const char *pszMBString, int cbString,
                       int fTab, int fOverwrite, int *piNewCol, char **ppInserted);


char * WBSplitMBLine(char *pString, int iCol);


char * WBJoinMBLine(char *pString, int iCol, const char *pJoin);


int WBDelMBChars(char *pString, int iCol, int nDel, int *piNewCol, char **ppDeleted);


int WBGetMBLength(const char *pString);


char * WBGetMBCharPtr(char *pString, int iCol, int *pcbLen);

int WBGetMBColIndex(const char *pString, const char *pChar);


#ifdef __cplusplus
};
#endif // __cplusplus

#endif // _TEXT_OBJECT_H_INCLUDED_