Assignment 1 Specification
Your task is to implement an abstract textbuffer data type that meets the given interface. In addition, you will have to code to test your implementation. Ensure that you also test for boundary conditions and for memory management bugs.
You will submit the C code implementing the textbuffer ADT and your testing code.
Below this page describes the interface of textbuffer ADT that you are to implement. For your implementation, download textbuffer.h below and implement the type TB as well as all the functions whose prototype is given in the header file. All your code should go into a file textbuffer.c, which you have to submit to complete the assignment.
Thursday 23rd August: Released to the poor poor students
Friday 24th August: Updated compilation flag from -std=c99 to std=gnu99
Saturday 25th August: Fixed typo in searchTB example, and in dumpTB comments in textbuffer.c and textbuffer.h. Updated addSuffix to addPrefix + added more examples
Monday 27th August: Added information on memory leak style marks. Added examples to formRichText, Updated FAQ, Clarified Empty/NULL Cases, Clarified SearchTB
Tuesday 28th August: Fixed mixedup terms in mergeTB empty case FAQ
Tuesday 28th August: Fixed empty case FAQ yet again. Clarified formRichTest spec. Added FAQ item for empty line input for newTB
Sunday 2nd September: Added case sensitive to searchTB behavior, fixed number to showLineNumbers in dumpTB, added formRichTextTB FAQ item, removed confusing term from formRichTestTB Outline.
Tuesday 4th September: Added formRichTextTB FAQ item.
Saturday 8th September: Updated blackbox text commenting FAQ item
Sunday 9th September: Made gcc line copy and pasteable
Monday 10th September: Fixed typo
Tuesday 11th September: Added test FAQ item
The assignment is worth 10 marks. The marks breakdown is as follows:
Autotesting of functionality 6
Subjective evaluation of style 2
Automarking – 6 Marks
We will run your textbuffer.c implementation on a number of tests. These will be much more comprehensive than the tests we run during submission. You get marks for each test you pass.
Testing – 2 Mark
You will create a suite of blackbox tests and whitebox tests. We will not actually be running your whitebox tests, your tutor will be marking them subjectively, but please make sure they compile. You should write your whitebox tests in your textbuffer.c file. These whitebox tests will be worth 1 mark.
You will also create a testTextBuffer.c file, that will contain your black box tests. These tests will be run against some of our own correct and also incorrect implemetations of textbuffers. Your test file should be able to pick up our errors, but pass our correct implementations. Your tutor will also subjectively assess your tests. All together your blackbox tests will be worth 1 mark.
Style – 2 Marks
Style marks will include comments, indentation, variable names etc and will also include marks for choosing an appropriate representation for your ADT a nd for efficiency of the algorithms you choose. For example, you will lose marks if your implementation of a function has work complexity of O(n^2) when there is a solution with O(n) or O(n * log n)
In addition style marks will reflect if your program has any memory leaks (memory you have allocated and have responsibility to free but never free’ed). Your program will be tested for memory leaks via valgrind
This is an individual assignment. Each student will have to develop their own solution without help from other people. In particular, it is not permitted to exchange code or pseudocode. You are not allowed to use code developed by persons other than yourself. If you have questions about the assignment, ask your tutor.
Plagiarism is defined as using the words or ideas of others and presenting them as your own. UNSW and CSE treat plagiarism as academic misconduct, which means that it carries penalties as severe as being excluded from further study at UNSW. There are several on-line sources to help you understand what plagiarism is and how it is dealt with at UNSW:
Plagiarism and Academic Integrity UNSW Plagiarism Procedure
Make sure that you read and understand these. Ignorance is not accepted as an excuse for plagiarism. In particular, you are also responsible that your assignment files are not accessible by anyone but you by setting the correct permissions in your CSE directory and code repository, if using. Note also that plagiarism includes paying or asking another person to do a piece of work for you and then submitting it as your own work.
UNSW has an ongoing commitment to fostering a culture of learning informed by academic integrity. All UNSW staff and students have a responsibility to adhere to this principle of academic integrity. Plagiarism undermines academic integrity and is not tolerated at UNSW. Plagiarism at UNSW is defined as using the words or ideas of others and passing them off as your own.
If you haven’t done so yet, please take the time to read the full text of
UNSW’s policy regarding academic honesty and plagiarism
The pages below describe the policies and procedures in more detail:
Student Code Policy
Student Misconduct Procedure Plagiarism Policy Statement Plagiarism Procedure
You should also read the following page which describes your rights and responsibilities in the CSE context:
Essential Advice for CSE Students
Deadline: 11^59pm, Friday 14 September 2018.
Submission Details: TBA
Note When we test your assignment it with be compiled with gcc and the following flags
gcc -Wall -Werror -std=gnu99 -O -lm -o textbuffer testTextBuffer.c textbuffer.c
The following is a description of the components of the interface.
As marks are awarded by an automated marking program, you must follow this specification precisely. Otherwise, you risk getting few or no marks! You must NOT modify the textbuffer.h file.
The ADT type
We represent the ADT by way of a handle of type TB. The handle type is declared in the header file, but you will have to provide an implementation of the handle representation – i.e. of struct textbuffer – as part of your implementation:
typedef struct textbuffer *TB;
Refer to the lecture about ADTs for examples of this construction.
Required properties of the implementation
A textbuffer is an ordered collection of strings, where each string represents one line of a text file. Your implementation must keep the lines of a textbuffer in a linked data structure (such as a linked list or a variant of that). Each line must be represented as a (dynamically allocated) character array. Adding, deleting, or moving of lines requires manipulation of the linked structure. Such a data structure may, for example, be used as part of a text editor.
Constructor and destructor
Make a new TB
The function newTB allocates a new textbuffer and initialises its contents with the text given in the array. The lines in the input array are all terminated by a ‘\n’. The whole text is terminated by a ‘\0’.
TB newTB (char text);
Destory a TB
The function releaseTB frees the memory occupied by the given textbuffer. It is an error to access a buffer after freeing it.
void releaseTB (TB tb);
The following functions do not alter their textbuffer argument.
Allocate and return an array containing the text in the given textbuffer
Each individual line of the textbuffer needs to be terminated by a ‘\n’ (this includes the last line). The whole text must be ‘\0’ terminated. It is the caller’s responsibility to free the memory occupied by the returned array. If there are no lines in the textbuffer, return the empty string. If and only if showLineNumbers is true additonally append to each line before writing to the return array the line number proceeding by a dot and a space. I.e hello world would be returned as 1. hello world
char *dumpTB (TB tb, int showLineNumbers);
Return the number of lines of the given textbuffer.
int linesTB (TB tb);
For all editing functions, if any of the arguments indicates a line number is out of range (i.e., smaller than zero or bigger than the number of lines in the buffer minus one), the function has to print a suitable error message and terminate the program with the standard function abort().
Add the supplied prefix to all lines between pos1 and pos2
The first line of a textbuffer is at position 0.
void addPrefixTB (TB tb, int pos1, int pos2, char* prefix);
If pos2 is less than pos1, abort
Consider calling addPrefixTB(tb,0,2,”goodnight “)
+ —————————- + + ———————————— +
| room | | goodnight room |
| moon | —> | goodnight moon |
| cow jumping over the moon | | goodnight cow jumping over the moon |
| light | | light |
+ —————————- + + ———————————— +
Remove the lines between and including from and to from the textbuffer tb. Free the memory of the deleted lines.
void deleteTB (TB tb, int from, int to);
If to is less than from, abort
For all combining functions, if any of the arguments indicates a line number is out of range, the function has to print a suitable error message and terminate the program with the standard function abort().
Note that in this case, if the number of lines in tb1 is n, then n is a valid argument for pos (the text is added after the end of the buffer).
Merge tb2 into tb1 at line pos
Afterwards what was line 0 of tb2 will be line pos of tb1. The old line pos of tb1 will follow after the last line of tb2. After this operation tb2 can not be used anymore (as if we had used releaseTB() on it).
void mergeTB (TB tb1, int pos, TB tb2);
Copy tb2 into tb1 at line pos
Like mergeTB(), but tb2 remains unmodified and is still usable independent of tb1.
void pasteTB (TB tb1, int pos, TB tb2);
For all extracting functions, if any of the arguments indicating a line number is out of range, the function has to print a suitable error message and terminate the program with the standard function abort().
The textbuffers returned by the extracting functions are as if they were newly created with newTB().
Cut the lines between and including from and to out of the textbuffer tb.
The cut lines will be deleted from tb. If to is less than from, return NULL. TB cutTB (TB tb, int from, int to);
Return a linked list of all matches in tb of a certain string
The search is case sensitive and the textbuffer tb must remain unmodified.
Match searchTB (TB tb, char* search);
consider calling searchTB(tb,”love”) on the following TB
Hello World My
name is jarred lovegood
and i love carley ray jepson
this would give us a list:
| lineNumber: 2, | | lineNumber: 3, |
| charIndex: 15, | | charIndex: 6, |
| next: ————->| next: ————-> NULL
Note that the line number is 1 indexed whereas the character index is 0 indexed and refers to the first character of the match string
Note that Match is a pointer to the first node in the list
The function formRichText searches every line of tb and performs the following substitutions
String Replacement Example
*some string* <b>some string</b> *hello* -> <b>hello</b>
_some string_ <i>some string</i> _hello_ -> <i>hello</i>
#some string … <h1>some string …</h1> #hello -> <h1>hello</h1>
The matching is simplistic in that you would begin scanning at the first special character and continue to consume characters (ignoring any further special characters) until the matching special character. If there is no matching character, nothing is done and the next special character is processed
Note that the # character must be the first character in a line or else it does nothing. In addition it matches until the end of the line and not until a matching #. See example below.
*some string *some string
*some string*lol* <b>some string</b>lol*
*some* _string_ <b>some</b> <i>string</i>
some *string_again_ some *string<i>again</i>
In the case of nested special characters, i.e
You may take the outermost element and ignore any nesting.
#some _string_ <h1>some _string_</h1>
void formRichText (TB tb);
Assignment 1 Bonus Challenges
Differences between two textbuffers (1 mark)
Given two text files, we sometimes want to know what changes are made from one file to another file. The function diffTB works out which lines of texts are added or deleted from tb1 to get tb2. The
returned string of the function is an edit solution consisting of a series of add and delete commands. Applying such commands on tb1 in sequence should result in tb2.
char* diffTB (TB tb1, TB tb2);
An edit solution should have one command per line to either add or delete a line of text at a specific line number. An example is given below. The first command adds a line of text ‘add this line please’ at line 2 of the current textbuffer (counting from 0). The existing line 2 is moved to line 3, and so on. The second command deletes the line 3 of the textbuffer. The last command adds the specified text at line 12 of the textbuffer.
+,2,add this line please
+,12,add this line as well please
A mark is given if your solution satisfies two criteria given below:
Correctness – applying your edit solution on tb1 results in tb2.
Compactness – the size of your edit solution (i.e. number of lines) is smaller than or equal to the size of our model solution. This is to avoid trivial solutions like delete all lines of tb1 and add all lines of tb2.
Undo and redo operations (1 mark)
The function undoTB should be able to reverse at most 10 recently called operations on tb. Applicable operations are, deleteTB, mergeTB, pasteTB, cutTB. Each time undoTB is called, one operation is reversed on tb. When the maximum number of allowable undo operations is reached, nothing is done on tb.
void undoTB (TB tb);
The function redoTB calls operations that are reversed by undoTB again in order. Similar to undoTB, this function should redo one operation on tb per function call. However, when a new operation is called on tb, any reversed operations cannot be executed again with redoTB.