OOP344 20102 TextEdit

From CDOT Wiki
Revision as of 13:36, 24 June 2010 by Takeiteasy (talk | contribs) (→‎Sample makefile for TextEdit)
Jump to: navigation, search

TextEdit , OOP344 Open Source Project 20102

Release 0.1


OOP344 | Weekly Schedule | Student List | Teams | Project | Student Resources

File Names

Save your work in separate files for each class, and name the files to the same name as the classes; each class should have a header file and a code file.

For example for the class IOField, create iofield.h and iofield.cpp. The header file should hold the class declaration, and any other possible declaration related to the class. The "cpp" file should hold the definition (implementation) of the class, and its methods and possible functions.


How to reuse your C code in C++ programs

Include your already existing C code into your C++ code as follows: 

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

This tells to C++ compiler, the included header file contains C functions and should be complied and called as such. Remember, you do not need and should not rename your iof.c to iof.cpp, since the compiler is already aware of the C functions in iof.c.

Header Files

General Definition Header file

create a file called: iotext.h. This file will contain any necessary definitions or possible inclusions for the project.

This file will be included to most of your project code to carry general definitions for your project.

For now add the following define statements in iotext.h.

Keep checking this section for additions during the development of the project 


 #ifndef __IO_TEXT_H__
 #define __IO_TEXT_H__

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

 #ifndef _CRT_SECURE_NO_DEPRECATE
 #define _CRT_SECURE_NO_DEPRECATE
 #endif
 #ifndef _CRT_SECURE_NO_WARNINGS
 #define _CRT_SECURE_NO_WARNINGS
 #endif
 #define MAX_NO_FIELDS 500
 #define FRAME_CHARS  "/-\\|/-\\|"
 #define _CLR_AND_DSPLY_ALL -1
 #define _DSPLY_ALL 0


enum MessageStatus{ClearMessage,SetMessage};

# ifdef NO_HFUNC
# undef NO_HFUNC
# endif
# define NO_HFUNC ((void(*)(MessageStatus, IOForm&))(0))
# ifdef NO_VFUNC
# undef NO_VFUNC
# endif
# define NO_VFUNC ((bool(*)(const char*, IOForm&))(0))

#endif

How to include header files to prevent circular inclusion

SVN Quick Notes

Mandatory Classes

To initiate development of the TextEdit application, we need to encapsulate the functions written in "IOF".

The main design is based on the input/output objects that can be positioned on a Form. Each input/output object is responsible to encapsulate a form of entry or display: a Label to display text, a Line Editor do display and edit a character string, a Check Box List to be able to select one or many of many options, and etc....

Also as mentioned above, A Form object is responsible to hold the input/output objects and display and edit them in an orderly fashion. A Form, so to speak, could be an array or list of input/output objects.

These objects by design, could be framed, which means they can have a border drawn around them. Because of this, a class needs to be designed (we call it IOFrame) to represent a Frame and this class should be inherited by all Framed objects.

Also, the input/output objects all have the same purpose (that is displaying or editing something). This "same purpose" will be encapsulated in a class called IOField that presents the idea of an input/output object in a form.


IOFrame

IOFrame is implemented in two files, ioframe.h and ioframe.cpp

IOFrame is a class encapsulating a Frame. It has a location on the Form that is its left, top coordinates (i.e. col and row) also a width and a height to specify how wide and tall the frame is.

IOFrame can be invisible, which means, it will have all the specs, but it does not draw any border around itself.

IOFrame can obviously draw itself on the screen at a specific location with specific offset. 

class IOFrame {
private:
  bool _visible;
  ?????
  int _row;
  int _col;
  int _height;
  int _width;
public:
  IOFrame(int row = -1, int col = -1,
         int height = -1, int width = -1
         ,bool visible = false
         );

  virtual ~IOFrame();
  void draw(int RowOffset = 0, int ColOffset = 0) const;
  void setVisible(bool visible);

  void setSize(int height, int width);
  virtual IOFrame& row(int val);
  virtual IOFrame& col(int val);
  virtual int row()const;
  virtual int col()const;
  virtual int height()const;
  virtual int width()const;
  bool IsVisible()const;
};

Constructor: Sets the corresponding values to the incoming arguments. if any of the row, col, height or width is less than 0, then the frame will be set to full-screen, which means, row and col will be set to 0 and width and height will be set to the number of columns and rows of the screen, respectively.

Destructor: Does Nothing. This is an empty destructor.

void draw(int RowOffset = 0, int ColOffset = 0) const: , if the frame is visible, then it draws a rectangle on the screen with its left, top at col+ColOffset and row+RowOffset respectively. The width and height of the rectangle will be equal to the corresponding attributes in the class.

note: Make sure the rectangle is filled with spaces.

The frame is drawn using the characters specified in FRAME_CHARS in iotext.h as follows: 

 Index        Character
   0          left-top
   1          top border
   2          top-right
   3          right border
   4          right-bottom
   5          bottom border
   6          bottom-left
   7          left border

In full screen mode the four corners are not printed.

  • void setVisible(bool visible): Sets the visible attribute to the incoming argument.
  • void setSize(int height, int width); Sets the _height and _width to the incoming values
  • virtual IOFrame& row(int val); Sets the _row to incoming val and then returns a reference of IOFrame
  • virtual IOFrame& col(int val); Sets the _col to incoming val and then returns a reference of IOFrame
  • virtual int row()const; returns the value of _row
  • virtual int col()const; returns the value of _col
  • virtual int height()const; returns the value of _height
  • virtual int width()const; return the value of _width
  • bool IsVisible()const; returns the status of IOFrame, true, if the frame is visible and false if it is not

Here is how a IOFrame looks like when it is drawn:

BFrame.gif


A main() function to test IOFrame::draw Offsets

IOField

IOField represents an input/output object. It is a Framed object, which means it publicly inherits IOFrame.

IOField is what is common between all the input/output fields in this system. IOField is the base of every and each of the input/output fields.

An IOField is usually an element of a Form Entity (see IOForm). Because of this, for each Field to be able to post messages on the Form, it needs to have a reference to the Form it is on.

Each IOField gets its location (row and col) and its size (height and width) from its parent IOFrame.

Because IOField is to do input/output, it needs a general way to be able to hold/keep track of the data it is inputting or outputting.

To accommodate the above we create the following class: 

# include "ioframe.h"

class IOForm;

class IOField: public IOFrame{
private:
  IOForm* _owner;
protected:
  void* _data;
public:
  IOField(int row = 0, int col = 0,
         void* data = (void*) 0, bool framed = false
  );
  virtual ~IOField();
  virtual void display() const;
  virtual int edit() = 0;
  virtual bool editable() const = 0;
  virtual void* data();

  void set(IOForm* owner);
  int row()const;
  int col()const;
  int height()const;
  int width()const;

  virtual IOField& set(const void* data) = 0;

  IOForm* owner();

};
  • _owner Holds the address of the Form the IOField Belongs to. If null, it means the IOField does not belong to any Form and it is stand alone
  • _data Holds the address of the data being edited by this IO Field.
  • IOField(int row = 0, int col = 0, void* data = (void*) 0, bool framed = false); Passes row and col to IOFrame and also passes 0 to IOFrame for height and width. Then the constructor sets the _data address to incoming data address and sets the _owner to null.

Since a IOField has ONLY what is common between different IO Fields, it can not have the final say on several of its own values. For example, the height and width depends of type of the IO it is going to be.

  • virtual ~IOField(); Does nothing.
  • virtual void display() const; Depending to be an element of a Form (see IOForm) or be a stand alone IO Field, it does the following:

If the the IOField's _owner attribute is null (it is not an element on a Form, or better to say it does not belong to a Form), it calls IOFrame::draw() with no arguments, otherwise(if _owner is not null) it calls the IOFrame::draw() passing its the _owner's row and col as offset arguments. By doing this, if IOField is an element on a form, its location becomes relative to the Form it is in and not the screen

  • virtual int edit() = 0; Enforces the children to have an edit method
  • virtual bool editable()const = 0; Enforces the children to specify if they are editable or not
  • virtual void* data(); Returns the value the _data attribute
  • void set(IOForm* owner); Sets the _owner attribute to incoming owner address. (this method will be used by IOForm to become the owner of the IOFields being added it)
  • int row()const; Returns the row of the IOFrame, but if the _owner is not null, the value of the row of the _owner will be added to returned value.
  • int col()const; Returns the col of the IOFrame, but if the _owner is not null, the value of the col of the _owner will be added to returned value.
  • int height()const; Returns the height of the IOFrame.
  • int width()const; Returns the width of the IOFrame.
  • R0.3: virtual IOField& set(const void* data) = 0; Enforces the children to have a set method for setting the value of _data.
  • R0.4: IOForm* owner(); returns the value of the _owner attribute.

IOLabel

IOLabel is a IOField to display a string of characters. It essentially encapsulates iof_display().

The only attribute IOLabel needs in addition to its parents is an integer to Hold the length of the string to be shown. 

 #include "IOField.h"
 class  IOLabel: public IOField{
   int _length;
 public:
    IOLabel(const char *str, int row, int col, int len = 0);
    IOLabel(int row, int col, int len);
   virtual ~ IOLabel();
   void display() const;
   int edit();
   bool editable()const;

   IOField& set(const void* str);
 };
  • IOLabel(const char *str, int row, int col, int len = 0); After passing row and col to its parent, it allocates memory to hold the contents of str.

Allocation should be done after setting the _length to the proper value; if len is less than or equal to zero, then _length will be set to the length of the str, otherwise, _length will be set to the value of incoming len.

After this, _length +1 chars should be allocated and it address should be kept in IOField::_data

Then the contents of str should be copied up to _legnth chars into IOField::_data. Make sure that the string is null terminated.

  • IOLabel(int row, int col, int len);

This constructor is used to create an empty IOLabel. It works exactly like the above constructor, with one difference; there is no string to initialize the newly allocated memory.

_length is set to incoming len and then IOField::_data is set to the address of the newly allocated _length +1 chars.

Set the first char of the _data to null to set the string to blank.

  • virtual ~ IOLabel(); Deletes the data held in IOField::_data
  • void display() const; Using iof_display, displays IOField::_data at IOField::row() and IOField::col(), up to _length characters
  • int edit(); Calls the display() method and returns 0.
  • bool editable()const; Always return false
  • IOField& set(const void* str); Copies the str into IOField::_data up to _length chars and then returns a reference of the IOLabel.

IOEdit

IOEdit is an IOField that is responsible to encapsulate the iof_edit.

To do so in addition to the attributes of its parents; row, col and width (that is fieldlen) it needs to have the following:

  • A flag to keep the status of memory allocation (if memory allocation is being used or not)
  • An integer to keep the maximum data len.
  • An integer to keep the cursor position.
  • An integer to keep the offset position.
  • An integer pointer to hold the address of the insert status.
class IOEdit: public IOField{
  bool _dyn;
  int _maxdatalen;
  int* _insertmode;
  int _curpos;
  int _offset;
public:
  IOEdit(char* str, int row, int col, int fieldlen,
    int maxdatalen, int* insertmode, 
    bool framed = false);
  IOEdit(int row, int col, int fieldlen,
    int maxdatalen, int* insertmode,
    bool framed = false);
  ~IOEdit();
  void display()const;
  
  int edit();
  bool editable()const;
  int row()const;
  int col()const;
  int fieldlen()const;

  //Modified in R0.3
  IOField& set(const void* str);
};
  • IOEdit(char* str, int row, int col, int fieldlen,int maxdatalen, int* insertmode,bool framed = false);

Edit, sets IOField::_data to value of str. If IOEdit is instantiated with this constructor then it will edit an external string provided by the caller function of IOEdit. IOEdit in this case is not creating any dynamic memory, therefore _dyn is set to false; The location (row and col) and framed are directly passed to the parent and str is passed as data to the parent constructor. Unlike IOLabel, IOEdit could be framed or not so depending on this (framed being true or false) the size (width and height) of IOEdit are set as follows:

If framed is false, then there is no border around the editing line so the height of the frame should be set to 0 and the width of the frame should be equal to the value of fieldlen. How ever if the editing line is bordered, then it needs 3 for height and fieldlen + 2 as width: 


/-------------------\
|Editing line here  |
\-------------------/


  • IOEdit(int row, int col, int fieldlen,int maxdatalen, int* insertmode,bool framed = false); This Constructor works exactly like the above with respect to location and size, but for data, because no data is provided to edit, it will create a dynamic, blank char string to accommodate the editing.

the size of the allocation will be maxdatelen +1 and obviously _dyn is set to true, so the destructor knows the memory has to be deallocated at the time of destruction. The allocated memory should be pointed by IOField::_data.

  • ~IOEdit(); If _dyn is true it will delete the string pointed by IOField::_data.
  • void display()const; First it will call the display() method of its parent and then makes a direct call to iof_display using the row(), col() and fieldlen() accessors.
  • int edit(); makes a direct call to iof_edit passing the corresponding values from the attributes and accessor methods. the IsTextEditor is set to 0 and the readonly is set to 0 too (for now).
  • bool editable()const; returns true
  • int row()const; returns the IOField::row() but it will add one to it, if IOEdit is framed
  • int col()const; returns the IOField::col() but it will add one to it, if IOEdit is framed
  • int fieldlen()const; returns the IOFrame::width() but reduces it by 2 if IOEdit is framed
  • IOField& set(const void* str); copies the content of str into IOField::_data up to maxdatalen characters.


IOForm

IOForm is a collection of IOFields. IOForm organizes and groups the IOFields for user entry. 

# include "iotext.h"

class IOFrame;
class IOField;

class IOForm: public IOFrame{
private:
int _fnum;
int _curidx;
IOField* _fld[MAX_NO_FIELDS];
bool _dyn[MAX_NO_FIELDS];
bool _editable;
IOForm* _owner;
public:
IOForm(int row = -1, int col = -1, int width = -1,
int height = -1, bool framed = false);
virtual ~IOForm();
void display(int fn = OT_CLR_AND_DSPLY_ALL)const;
int edit(int fn = 0, IOForm* owner = (IOForm*)0);
IOForm& add(IOField* field, bool dynamic = true);
IOForm& add(IOField& field, bool dynamic = false);
bool editable();
int fieldNum()const;
int curField()const;
IOForm& set(IOForm* owner);

IOField& operator[](unsigned int index);
};
  • _fnum is the number of IOFields added to the IOForm
  • _curidx is the index of the current IOField being edited.
  • _fld is an array of IOField pointers. Initially all the elements of _fld is set to null. When a IOField is added to the form, it will be pointed by one of the elements of this array.
  • _dyn is an array of boolean values exactly to the number of elements of _fld. When IOField number "n" is added to IOForm and is pointed by _fld[n-1] , the corresponding _dyn[n-1] indicate if the IOField held in _fld[n-1] is dynamically allocated or not. the _dyn flags will be used in the destructor as deallocation condition for each _fld element.
  • _editable is set to true, if at least one of the IOFields in _fld is editable.
  • _owner, If a IOForm is being used by another IOForm, then the _owner of the used IOForm will be set to the user-IOForm.
  • IOForm(int row = -1, int col = -1, int width = -1, int height = -1, bool framed = false);, creates a IOForm. It passes the coordinates (row and col) and size (width and height) and also the framed flag to its parent IOFrame.

Then it will set all the _fld elements to null, _fnum to 0 (empty IOForm), _editable to false and _curidx to 0 and _owner to (IOForm*) 0;

  • ~IOForm() goes through all _fld elements from 0 to _fnum, if the corresponding _dyn element is true, it will then delete the IOField pointed by that _fld element.
  • void display(int fn = 0)const;

If fn is OT_CLR_AND_DSPLY_ALL, then it will check to see if _owner is not null. If _owner is not null, it will call the _owner's display() with OT_CLR_AND_DSPLY_ALL, otherwise it will just clear the screen.

Then it first call IOFrame::draw() and then it will display all the _fld elements, one by one.

If fn is OT_DSPLY_ALL then it will just call IOFrame::draw() and then it will display all the _fld elements, one by one.
If fn is greater than 0 then it will only display _fld number fn (_fld[fn-1])

  • int edit(int fn = 0, IOForm* owner = (IOForm*)0); Edits First it will set _owner to incoming owner argument.

If IOForm is not editable (all fields are non-editable), it will just display the IOForm and then waits for the user to enter a key and then terminates the function returning the key.
If fn is 0 then before editing, the whole form is displayed and editing begins from the first editable IOField.

If fn is greater than 0 then editing begins from the first editable key on or after IOField number fn.

Note that fn is the sequence number of field and not the index.

Start editing from field number fn;

Call the edit of each field and depending on the value returned, do the following:

  1. For ENTER_KEY, TAB_KEY and DOWN_KEY, go to next editable IOField , if this is the last editable IOField then restart from IOField number one.
  2. For UP_KEY go to the previous editable IOField, if there is no previous editable IOField, go to the last editable IOField in the IOForm.
  3. For any other key, terminate the edit function returning the character which caused the termination.
  • IOForm& add(IOField* field, bool dynamic = true); adds value of the field pointer to the _fld array , sets the corresponding _dyn element to the value of dynamic argument and then increases _fnum by one.

By doing this a IOField is added to the collection of IOFields in IOForm::_fld. It also sets the _owner of the added IOField to this IOForm. Note that this IOField is dynamic by default

  • IOForm& add(IOField& field, bool dynamic = false); adds address of the field pointer to the _fld array , sets the corresponding _dyn element to the value of dynamic argument and then increases _fnum by one.

By doing this a IOField is added to the collection of IOFields in IOForm::_fld. It also sets the _owner of the added IOField to this IOForm. Note that this IOField is non-dynamic by default.

  • bool editable(); Returns true if at least one of the IOFields added to the IOForm is editable.
  • int fieldNum()const; returns _fnum
  • int curField()const; returns _curidx
  • IOForm& set(IOForm* owner); Sets the _owner to the incoming owner argument
  • IOField& operator[](unsigned int index); returns the reference of the _fld[index], if index is larger than _fnum, then circle back from the beginning.

Executable sample for optext Release 0.3: ~fardad.soleimanloo/optext0.3


IOVEdit

Inherit IOEdit class to a Validated line editor class called IOVEdit.

IOVEdit, works exactly like a IOEdit, with two differences; 1- It supports Help messages. 2- Supports data validation

IOVEdit has two extra attributes that are pointers to Validation and Help functions: 

  void (*_help)(MessageStatus, IOForm&);
  bool (*_validate)(const char*, IOForm&);

Constructors


  IOVEdit(int row, int col, int fieldlen,
    int maxdatalen, int* insertmode,
    bool (*validate)(const char* , IOForm&) = NO_VFUNC,
    void (*help)(MessageStatus, IOForm&) = NO_HFUNC,
    bool framed = false);
  IOVEdit(char* str, int row, int col, int fieldlen,
    int maxdatalen, int* insertmode,
    bool (*validate)(const char* , IOForm&) = NO_VFUNC,
    void (*help)(MessageStatus, IOForm&) = NO_HFUNC,
   bool framed = false);

These two constructors pass all the information directly to IOEdit's constructor and then set the "function pointers" attributes to their corresponding arguments.

Public Function


 int edit();
  • if owner() of IOVEdit is null, then it simply calls the IOEdit's edit() and terminates (returning the same value as IOEdit::edit())
  • if owner() is not null
    • if the help function pointer attribute is not NULL, it will call it passing SetMesssage , and *owner()' as arguments (This will show the help message for this field, before editing begins.)
    • if the validation function pointer is not null then it will call the IOEdit::edit() and validate the data with it by keep repeating the IOEdit::edit() until either validation function return true or the IOEdit::edit() was terminated by a non navigation key.
      • Navigation keys are: UP_KEY DOWN_KEY TAB_KEY and ENTER_KEY
    • Right before the IOVEdit::edit() Terminates, if the help function pointer attribute is not NULL, it will call it again passing ClearMesssage , and owner()' as arguments (this will clear the help message after editing is done.)
    • IOVEdit::edit() will return the return value of IOEdit::edit().

IOTextEdit

IOTextEdit is inherited from IOField and edits a multi-line text as a text editor.

Constructors

  IOTextEdit(int row, int col,  int height,int width,
      bool readonly, int* insertmode);
  IOTextEdit(const char* str,
            int row, int col,  int height,int width,
      bool readonly, int* insertmode);

IOTextEdit is created using its coordinates on the IOForm (row, col) and the height and width of the text area, for editing the text.

The maximum width of the text could be considered constant that is defined in OT_MAX_LINE_CHARS.

There is no limit to the number for lines in the text.

The first constructor creates the class with an empty text that is edited by the user.The second constructor creates the class and then initializes the text with incoming str argument.

If readonly is true then text can be browsed but not edited.


Public Methods

  void display()const;

Displays the text within the text area. 

  void *data();

Returns the address of a single dimension char array holding the edited text. 

  int edit();

Edits the text. Use a simple text editor like NLED to get an idea what capabilities you can add to your text editor. Minimum requirement:

  • Full scroll and edit capability
  • Inserting new line (when enter is hit in a line, a new line is added after the current line)
  • Removing a line (when backspace is hit at the beginning of a line

If you have doubts about the behavior of edit method, check any text editor and replicate its behavior. 

  bool  editable()const;

returns true; 

  IOField& set(const void *str);

Sets the data of IOTextEdit to the incomming data in the character array pointed by str. 

  bool readOnly();

Returns, if IOTextEdit is read-only or not. 

  virtual ~IOTextEdit();

Deallocates the dynamic memory used by the class before IOTextEdit is destroyed.


The Application

Using the above classes, create a Text Editor that is capable of creating a new text file or opening an already existing one for edit and save or save with new name.

Test Programs

TextEdit Test Programs

Class Hierarchy


IOFrame
 |
 |---IOForm
 |
 |
 |---IOField
       |
       |-------- IOLabel
       |
       |--------IOEdit
       |         |
       |         |-------IOVEdit
       |
       |--------IOTextEdit

Due Dates

Executable Samples on Matrix

  • Bframe test: ~fardad.soleimanloo/bframetest
  • optext Release 0.3: ~fardad.soleimanloo/optext0.3

compiling under Linux

To compile in matrix, use: g++ yada.cpp yadoo.cpp -x c biof.c -lncurses If you have many cpp's, you may also do g++ *.cpp -x c biof.c -lncurses

Sample makefile for TextEdit

textedit: iof.o ioframe.o iofield.o iolabel.o ioedit.o ioform.o optext.o
        c++ iof.o ioframe.o iofield.o iolabel.o ioedit.o ioform.o optext.o \
   -lncurses -otextedit

iof.o: iof.c iof.h
        cc -c iof.c

ioframe.o: ioframe.cpp ioframe.h iotext.h
        c++ -c ioframe.cpp 

iofield.o: iofield.cpp iofield.h ioframe.h bform.h   
        c++ -c iofield.cpp 

iolabel.o: iolabel.cpp iolabel.h IOField.h iotext.h
        c++ -c iolabel.cpp 

ioedit.o: ioedit.cpp ioedit.h IOField.h iotext.h
        c++ -c ioedit.cpp 

ioform.o: ioform.cpp ioform.h iotext.h IOField.h
         c++ -c ioform.cpp 

optext.o: optext.cpp iotext.h iolabel.h ioedit.h ioform.h IOField.h
         c++ -c optext.cpp
Retrieved from "https://wiki.cdot.senecapolytechnic.ca/w/index.php?title=OOP344_20102_TextEdit&oldid=41624"