Console UI Core Classes - OOP344 20111

OOP344 | Weekly Schedule | Student List | Teams | Project | Student Resources
Under Construction!

Release 0.5

Before anything, go to your repository/branches/fardad/bio_additions and open bio.c and bio.h, then copy and apply the additional functions and changes to your own bio.c and bio.h in trunk. Make sure it compiles and runs properly. These changes add buffering support to be able to prevent flickering. The functionalities added will not change the console behavior or the bio functions. After applying the changes, everything should work they way they worked before.

Your objective at this stage is to create series of core classes designed to interact with the user. These Core Classes then can be used in development of any interactive application.

Please note that the class definitions here are minimum requirement for the Core Classes and you are free to add any enhancements or features you find useful. However make sure that you discuss these enhancements with your professor to make sure they are feasible before implementation.

It is highly recommended to develop the classes in the order they are stated here. You must create your won tester programs fore each class (if possible); However, close to due date of each release, a tester program is provided to help you verify the functionality of your classes. Executables of the test programs are available on matrix to show you how it is supposed to run.

Start by creating mock-up classes (class declaration and definition with empty methods that only compiles and don't do anything). Each class MUST have its own header file to hold its declaration and "cpp" file to hold its implementation. To make sure you do not do circular includes follow these simple guidelines:

• Add recompilation safeguards to all your header files.
• Always use forward declaration if possible instead of including a class header-file.
• Use includes only in files in which the actual header file code is used.
• Avoid "just in case" includes.

Due Dates

• Sat March 19

  Merge the bio additions to your bio.c and bio.h

  Add all the files for mock-up classes

  1. create .h and .cpp files for all classes

     the name of the file is all lower case and is the same as class name (i.e CFrame class: cframe.h and cframe.cpp)

  2. copy the class definitions into .h files
  3. create mock-up methods for the class defs

  Tag it in Release 0.3

• Tue March 22

  merge the code for CFrame and CField from tags/fardad/coreclasses into your project and compile, run and test it with Test1Frame.cpp

  Tag it in Release 0.35

General Internal Header file (cgh.h R0.1)

The general header file holds the common setting and definition between all the Core Classes.

#ifndef ___CGH_H__
#define ___CGH_H__
 
#ifndef _CRT_SECURE_NO_DEPRECATE
#define _CRT_SECURE_NO_DEPRECATE
#endif
#ifndef _CRT_SECURE_NO_WARNINGS
#define _CRT_SECURE_NO_WARNINGS
#endif
 
#define C_MAX_NO_FIELDS 100
#define C_BUTTON_HIT 1
#define C_MAX_LINE_CHARS  (1024u)

#define C_FULL_FRAME -1
#define C_NO_FRAME 0

#define C_BORDER_CHARS  "/-\\|/-\\|"
enum CDirection {bio_centre, bio_left, bio_right, bio_up, bio_down};

extern "C"{
#include "bio.h"
};

enum MessageStatus{ClearMessage,SetMessage};


#ifdef NO_HELPFUNC
# undef NO_HELPFUNC
#endif
#define NO_HELPFUNC ((void(*)(MessageStatus, CDialog&))(0))
#ifdef NO_VALDFUNC
# undef NO_VALDFUNC
#endif
#define NO_VALDFUNC ((bool(*)(const char*, CDialog&))(0))


#define C_MAX_LINE_CHARS  (1024u)
#define C_INITIAL_NUM_OF_LINES (100u)

#endif

File Names

Use the following rules to create filenames for your class.

• Each class MUST have its own header file and cpp file for implementation
• Use the class name for the name of the file but make sure it is all lowercase.

  For example CFrame class should have cframe.h and cframe.cpp files for its implementation.

Hierarchy

CFrame
 |
 |---CDialog
 |
 |
 |---CField
       |
       |-------- CLabel
       |
       |
       |-------- CButton
       |
       |
       |-------- CLineEdit
       |         |
       |         |-------CValEdit
       |
       |-------- CText
       |
       |
       |-------- CCheck
       |
       |
       |-------- CCheckList
       |
       |
       |-------- CMenuItem 
       |
       |
       |-------- CMenu 

Basic (BIO) Encapsulating Classes

CFrame

The code for this class is provided. You must understand and use it to develop your core classes.

CFrame class is responsible to create a frame or structure in which all user interface classes contain themselves in. It can draw a border around it self or be border-less. CFrame also, before displaying itself on the screen, will save the area it is about to cover, so it can redisplay them to hide itself.

CFrame is base of all objects in our user interface system.

#pragma once
#include "cgh.h"

class CFrame{
  int _row;      // relative row of left top corner to the container frame or the screen if _frame is null
  int _col;      // relative col of left top corner to the container frame or the screen if _frame is null
  int _height;   
  int _width;
  char _border[9];  // border characters
  bool _visible;    // is bordered or not
  CFrame* _frame;   // pointer to the container of the frame (the frame, surrounding this frame)
  char* _covered;   // pointer to the characters of the screen which are covered by this frame, when displayed
  void capture();   // captures and saves the characters in the area covered by this frame when displayed and sets 
                    // _covered to point to it
protected:
  int absRow()const;    
  int absCol()const;    
public:
  CFrame(int Row=-1, int Col=-1, int Width=-1,int Height=-1,
    bool Visible = false,
    const char* Border=C_BORDER_CHARS,
    CFrame* Frame = (CFrame*)0);
  
  virtual void draw(int fn=C_FULL_FRAME);
  virtual void move(CDirection dir);
  virtual void hide();

  virtual ~CFrame();
  
  /* setters and getters: */

  bool fullscreen()const;

  void visible(bool val);
  bool visible()const;

  void frame(CFrame* theContainer);
  CFrame* frame();
  
  void row(int val);
  int row()const;

  void col(int val);
  int col()const;

  void height(int val);
  int height()const;

  void width(int val);
  int width()const;

  void refresh();
};

Properties

int _row, holds the relative coordinate of top row of this border with respect to its container.
int _col, same as _row, but for _col.
int _height, height of the entity.
int _width, width of the entity.
char _border[9], characters used to draw the border:

_border[0], left top

_border[1], top side

_border[2], right top

_border[3], right side

_border[4], right bottom

_border[5], bottom side

_border[6], bottom left

_border[7], left side

bool _visible; Indicates if the border surrounding the entity is to be drawn or not.
CFrame* _frame; holds the container (another CFrame) which has opened this one (owner or container of the current CFrame). _frame will be NULL if this CFrame does not have a container, in which case, it will be full screen and no matter what the values of row, col, width and height are, CFrame will be Full Screen (no border will be drawn)
char* _covered; is a pointer to a character array that hold what was under this frame before being drawn. When the CFrame wants to hides itself, it simple copies the content of this array back on the screen on its own coordinates.

Methods and Constructors

Private Methods

void capture();

if _covered pointer is not pointing to any allocated memory, it will call the bio_capture function to capture the area that is going to be covered by this frame and keeps its address in _covered.

Protected Methods

• int absRow()const; calculates the absolute row (relative to the left top corner of the screen) and returns it.

  it returns the sum of row() of this border plus all the row()s of the _frames

• int absCol()const; calculates the absolute column(relative to the left top corner of the screen) and returns it.

  it returns the sum of col() of this border plus all the col()s of the _frames

Public Methods

  CFrame(int Row=-1, int Col=-1, int Width=-1,int Height=-1,
    bool Visible = false,
    const char* Border=C_BORDER_CHARS,
    CFrame* Frame = (CFrame*)0);

Sets the corresponding attributes to the incoming values in the argument list and set _covered to null

  virtual void draw(int fn=C_FULL_FRAME);

• First it will capture() the coordinates it is supposed to cover
• If frame is fullscreen() then it just clears the screen and exits.
  

Otherwise:

• If the _visible flag is true, it will draw a box at _row and _col, with size of _width and _height using the _border characters and fills it with spaces. Otherwise it will just draw a box using spaces at the same location and same size.

  virtual void move(CDirection dir);

First it will hide the Frame, then adjust the row and col to more to the "dir" direction and then draws the Frame back on screen.

  virtual void hide();

using bio_restore()it restores the characters behind the Frame back on screen. It will also free the memory pointed by _covered;

  virtual ~CFrame();

It will make sure allocated memories are freed.

  bool fullscreen()const;
  void visible(bool val);
  bool visible()const;
  void frame(CFrame* theContainer);
  CFrame* frame();
  void row(int val);
  int row()const;
  void col(int val);
  int col()const;
  void height(int val);
  int height()const;
  void width(int val);
  int width()const;

These functions set and get the attributes of the CFrame.

CFrame.cpp & Test1Frame.cpp Bug Fix for R0.3.5

Please visit my blog for the description and solution of the bug during the CFrame

• CFrame.cpp & Test1Frame.cpp Bug Fix for R0.3.5 by Ashkan

CField

The code for this class is provided. You must understand and use it to develop your core classes.

CField is an abstract base class that encapsulates the commonalities of all Input Outputs Console Fields which are placeable on a CDialog. All Fields could be Framed, therefore a CField is int

#include "cframe.h"
class CDialog;
class CField : public CFrame{
protected:
  void* _data;
public:
  CField(int Row = 0, int Col = 0,
         int Width = 0, int Height =0,
         void* Data = (void*) 0,
         bool Bordered = false,
         const char* Border=C_BORDER_CHARS);
  ~CField();
  virtual int edit() = 0;
  virtual bool editable() const = 0;
 
 
  virtual void set(const void* data) = 0;
  virtual void* data();
 
  void container(CDialog* theContainer);
  CDialog* container();
};

Attributes

  void* _data;

Will hold the address of any type of data a CField can hold.

Constructors and Methods

  CField(int Row = 0, int Col = 0,
         int Width = 0, int Height =0,
         void* Data = (void*) 0,
         bool Bordered = false,
         const char* Border=C_BORDER_CHARS);

Passes the corresponding attributes to it's parents constructor and then sets the _data attribute to the incoming Data argument.

  ~CField();

Empty Destructor

  virtual int edit() = 0;
  virtual bool editable() const = 0;
  virtual void set(const void* data) = 0;

Enforce the children to implement;

• an edit() method
• an editable() method that returns true if the class is to edit data and false if the class is to only display data.
• a set() method to set the _data attribute to the data the class is to work with.

  virtual void* data();

Returns _data.

  void container(CDialog* theContainer);
  CDialog* container();

Sets and Gets the _frame attribute of CFrame by calling CFrame::frame() method. Make sure to cast The CDialog to CFrame when setting and cast CFrame to CDialog when getting

CLabel

A readonly Field that encapsulates bio_display() function. (i.e it is responsible to display a short character string on the display) CLable although, by inheritance is Frame, but it is never bordered.

#include "cfield.h"
class CLabel :  public CField{
   int _length;
 public:
   CLabel(const char *Str, int Row, int Col,
     int Len = -1);
   CLabel(int Row, int Col, int Len);
   CLabel(const CLabel& L);
   ~CLabel();
   void draw(int fn=C_NO_FRAME) ;
   int edit();
   bool editable()const;
   void set(const void* str);
};

Attributes

   int _length;

Holds the Length of the label, this will be stored to be passed to bio_display function.

Constructors / Destructor

   CLabel(const char *Str, int Row, int Col,
     int Len = 0);

passes the Row and Col to the CField constructor and then; if len is zero, it will allocate enough memory to store the string pointed by Str and then copies the Str into it. if len > 0, then it will allocate enough memory to store len chars in a string. In any way, the allocated memory is pointed by _data

   CLabel(int Row, int Col, int Len);

Works exactly like the previous constructor, but len in this case can not be zero. (no validation required) and the string pointed by _data will be set to an empty string.

   CLabel(const CLabel& L);

Copy Constructor

   ~CLabel();

makes sure that memory pointed by _data is deallocated before the object is destroyed.

Methods

   void draw(int fn=C_NO_FRAME) ;

makes a direct call to bio_display, passing _data for the string to be printed and absRow() and absCol() for row and cal and _length for len. this function ignores the argument fn.

   int edit();

calls draw, returning 0.

   bool editable()const;

always return false.

   void set(const void* str);

if _length is greater than zero, it will copy the string pointed by str into the string pointed by _data upto _length characters. if _length is zero, it will delete the memory pointed by _data and reallocates enough memory for str and copies the string pointed by str into the newly allocated memory pointed by _data.

CDialog

#include "cgh.h"
#include "cframe.h"
class CField;
 
class CDialog: public CFrame{
  private:
  int _fnum;
/* Suggestion: */
  int _curidx;
  CField* _fld[C_MAX_NO_FIELDS];
  bool _dyn[C_MAX_NO_FIELDS];
/* you can do this part any way you like only if it covers the minimum requirements of the assignment*/
/* talk to your professor if you want to do it differently */
  bool _editable;
  public:
  CDialog(CFrame *Container = (CFrame*)0,
           int Row = -1, int Col = -1, 
           int Width = -1, int Height = -1, 
           bool Borderd = false,
           const char* Border=C_BORDER_CHARS);
  virtual ~CDialog();
  void draw(int fn = C_FULL_FRAME);
  int edit(int fn = C_FULL_FRAME);
  int add(CField* field, bool dynamic = true);
  int add(CField& field, bool dynamic = false);
  CDialog& operator<<(CField* field);
  CDialog& operator<<(CField& field);
  bool editable();
  int fieldNum()const;
  int curIndex()const;
  CField& operator[](unsigned int index);
  CField& curField();
};

CLineEdit

#pragma once
#include "cfield.h"

class CLineEdit: public CField{
  bool _dyn;
  int _maxdatalen;
  int* _insertmode;
  int _curpos;
  int _offset;
public:
  CLineEdit(char* Str, int Row, int Col, int Width,
    int Maxdatalen, int* Insertmode, 
    bool Bordered = false,
          const char* Border=C_BORDER_CHARS);
  CLineEdit(int Row, int Col, int Width,
    int Maxdatalen, int* Insertmode, 
    bool Bordered = false,
          const char* Border=C_BORDER_CHARS);
  ~CLineEdit();
  void draw(int Refresh = C_FULL_FRAME);
  int edit();
  bool editable()const;
  void  set(const void* Str);
};

CButton

#pragma once
#include "cfield.h"
 class  CButton: public CField{
   int _length;
 public:
   CButton(const char *Str, int Row, int Col, 
            bool Bordered = true,
            const char* Border=C_BORDER_CHARS);
   virtual ~CButton();
   void draw(int rn=C_FULL_FRAME);
   int edit();
   bool editable()const;
   void set(const void* str);
 };

CCheck

#include "cfield.h"
#include "clabel.h"
class CCheck : public CField{
  int _flag;
  int _radio;
  char _format[4];
  CLabel Label;
public:
  CCheck(bool Checked,const char* Format, const char* Text, int Row, int Col, int Width, bool IsRadio = false);
  CCheck(const CCheck& C);
  void draw(int fn = C_NO_FRAME) ;
  int edit();
  bool editable()const;
  void set(const void* flag);
  void *data();
  bool checked()const;
  void checked(bool val);
};

CMenuItem

#include "cfield.h"
class CMenuItem:public CField{
  int  _selected;
  char _format[3];
  char* _text;
public:
  CMenuItem(bool Selected,const char* Format, const char* Text, int Row, int Col, int Width);
  CMenuItem(const CMenuItem &CM);
  virtual ~CMenuItem(void);
  void draw(int fn = C_NO_FRAME) ;
  int edit();
  bool editable()const;
  void set(const void* Selected);
  bool selected()const;
  void selected(bool val);
  const char* Text();
};

Complex Core User Interface classes

CValEdit

#include "clineedit.h"

class CValEdit: public CLineEdit{
  void (*_help)(MessageStatus, CDialog&);
  bool (*_validate)(const char*, CDialog&);
public:
  CValEdit(char* Str, int Row, int Col, int Width,
        int Maxdatalen, int* Insertmode,
        bool (*Validate)(const char* , CDialog&) = NO_VALDFUNC, 
        void (*Help)(MessageStatus, CDialog&) = NO_HELPFUNC,
        bool Bordered = false,
        const char* Border=C_BORDER_CHARS);
  CValEdit(int Row, int Col, int Width,
        int Maxdatalen, int* Insertmode,
        bool (*Validate)(const char* , CDialog&) = NO_VALDFUNC, 
        void (*Help)(MessageStatus, CDialog&) = NO_HELPFUNC,
        bool Bordered = false,
        const char* Border=C_BORDER_CHARS);
  int edit();
};

CText

#include "cfield.h"


class CText:public CField{
 // WHATEVER _lines;  // a collection of lines (will be set later) 
  bool _readOnly;
  int _curpos;
  int _fieldlen;
  int _maxdatalen; 
  int* _insertmode;
  int _offset;
  int _lcurpos;
  int _loffset;
 // bool _dynamic;
public:
  CText(int Row, int Col, int Width, int Height, bool Readonly,
    int* Insertmode, const char* Border=C_BORDER_CHARS);
  CText(const char* Str, int Row, int Col, int Width, int Height, bool Readonly,
    int* Insertmode, const char* Border=C_BORDER_CHARS);
  void draw(int fn = C_FULL_FRAME);

  void set(const void *Str);
  void *data();

  int edit();
  bool  editable()const;
  bool readOnly();
  void readOnly(bool val);
  ~CText();
};

CCheckList

#include "cfield.h"
#include "ccheck.h"

class CCheckList;
class CCheckList : public CField{
  ?????? 
  bool _radio;
  char _format[4];
  int _cnt;
  unsigned int _flags;
public:
  CCheckList(const char* Format, int Row, int Col, int Width,bool radio, bool Bordered = true,const char* Border=C_BORDER_CHARS);
  CCheckList& add(const char* Text, bool selected = false);
  void draw(int fn = C_FULL_FRAME);
  int edit();
  void* data();
  void set(const void* data);
  bool& operator[](unsigned int index);
  bool editable()const;
  bool radio();
  void radio(bool val);
  ~CCheckList(void);
};

CMenu

#include "cfield.h"
#include "cmenuitem.h"
class Cmenu;

class CMenu : public CField{
  ????? 
public:
  CMenu(const char* Format, int Row, int Col, int Width, bool Bordered = true,const char* Border=C_BORDER_CHARS);
  CMenu& add(const char* Text, bool selected = false);
  void draw(int fn = C_FULL_FRAME);
  int edit();
  void* data();
  void set(const void* data);
  int selectedIndex();
  int selectedIndex(unsigned int index);
  const char* selectedText();
  void selectedText(char *text);
  bool editable()const;
  ~CMenu(void);
};

Make File

Not complete, under construction

prj: iol.o cframe.o cfield.o cdialog.o clabel.o clineedit.o cmenuitem.h cbutton.o  ccheck.o cvaledit.o  ctext.o strarr.o testmains.o
	c++  iol.o cframe.o cfield.o cdialog.o clabel.o clineedit.o cmenuitem.h cbutton.o  ccheck.o cvaledit.o  ctext.o strarr.o testmains.o \
	-lncurses -oprjexe

iol.o: iol.c iol.h
	cc -c iol.c

cframe.o: cframe.cpp cfield.h cgh.h
	c++ -c cfield.cpp 

cfield.o: cfield.cpp cfield.h cgh.h
	c++ -c cfield.cpp 

cdialog.o: cdialog.cpp cdialog.h cfield.h cgh.h
	c++ -c cdialog.cpp 

clabel.o: clabel.cpp clabel.h cfield.h cgh.h
	c++ -c clabel.cpp 

clineedit.o: clineedit.cpp clineedit.h cfield.h cgh.h
	c++ -c clineedit.cpp 

cbutton.o: cbutton.cpp cbutton.h cfield.h cgh.h
	c++ -c cbutton.cpp 

ccheck.o: ccheck.cpp ccheck.h clabel.h cfield.h cfield.h conc.h iol.h
	c++ -c ccheck.cpp 

cveditline.o: cveditline.cpp cveditline.h clineedit.h cfield.h cfield.h conc.h iol.h
	c++ -c cveditline.cpp 
	 
ctext.o: ctext.cpp ctext.h clineedit.h strarr.h cfield.h cfield.h conc.h iol.h
	c++ -c ctext.cpp          
      	 
testmains.o: testmains.cpp cdialog.h ctext.h cveditline.h ccheck.h cbutton.h clineedit.h clabel.h cfield.h cfield.h iol.h
	c++ -c testmains.cpp