Added files from project 2 (mirror)

10 files changed, 961 insertions, 0 deletions

diff --git a/Year 1/Object-oriented Programming/Project 2/src/Generic/ConsoleInterface/Command.cpp b/Year 1/Object-oriented Programming/Project 2/src/Generic/ConsoleInterface/Command.cpp
new file mode 100644
index 0000000..d05dc8d
--- /dev/null
+++ b/Year 1/Object-oriented Programming/Project 2/src/Generic/ConsoleInterface/Command.cpp
@@ -0,0 +1,24 @@
+#include "Command.h"
+#include <cstring>
+
+Command::Command() : Command("", nullptr) {}
+
+/*! \param name C-style string, class stores at most 255 characters (last character is always terminating zero)
+ *  \param exec Function pointer that will be executed when run() is called. Can be nullptr.
+ */
+Command::Command(const char* name, void (*exec)(const char* params)) {
+	strncpy(this->name, name, 255);
+	this->name[255] = '\0';
+	this->exec = exec;
+}
+
+/*! Executes the stored function pointer, when it's not nullptr. Otherwise does nothing.
+ */
+void Command::run(const char* params) const {
+	if (exec != nullptr)
+		exec(params);
+}
+
+const char* Command::get_name() const {
+	return name;
+}
diff --git a/Year 1/Object-oriented Programming/Project 2/src/Generic/ConsoleInterface/Command.h b/Year 1/Object-oriented Programming/Project 2/src/Generic/ConsoleInterface/Command.h
new file mode 100644
index 0000000..393d705
--- /dev/null
+++ b/Year 1/Object-oriented Programming/Project 2/src/Generic/ConsoleInterface/Command.h
@@ -0,0 +1,27 @@
+#ifndef HEADER_CONSOLEINTERFACE_COMMAND
+#define HEADER_CONSOLEINTERFACE_COMMAND
+
+/*! \file Command.h
+ *  \brief Stores the declaration of class Command
+ */
+
+/*! \brief Stores a 256 character name and a function pointer to be executed when calling run()
+ *
+ * Menu uses this class for a more generic implementation of it's navigate function.
+ */
+class Command {
+	char name[256];
+	void (*exec)(const char* params);
+
+public:
+	//! Leaves name empty and exec function pointer to nullptr
+	Command();
+	//! Copies contents of nameInMenu and stores exec
+	Command(const char* name, void (*exec)(const char* params));
+	//! Executes the stored function pointer
+	void run(const char* params) const;
+
+	const char* get_name() const;
+};
+
+#endif
diff --git a/Year 1/Object-oriented Programming/Project 2/src/Generic/ConsoleInterface/Menu.cpp b/Year 1/Object-oriented Programming/Project 2/src/Generic/ConsoleInterface/Menu.cpp
new file mode 100644
index 0000000..9c2fca5
--- /dev/null
+++ b/Year 1/Object-oriented Programming/Project 2/src/Generic/ConsoleInterface/Menu.cpp
@@ -0,0 +1,72 @@
+#include "Menu.h"
+#include "Toolbox.hpp"
+#include <cstring>
+
+Menu::Menu() : menuOptions() {}
+
+unsigned indexOfCommandEnd(char* str) {
+	unsigned ind = 0;
+	std::cout << str[ind] << std::endl;
+	
+	return ind;
+}
+
+void Menu::addCommand(const Command& command) {
+	menuOptions.add(command);
+}
+
+/*!
+ * Prints the title, then an Error/Warning/Sucess message (if set),
+ * prints all command names as an ordered list (starting from 1),
+ * waits for user input to select one of those commands (by list number)
+ * and finally executes the appropriate command's run() function.
+ *
+ * After the run() function exists, everything is reprinted.
+ * The 0 list index is always "Go Back"/"Exit" and it always stops the reprinting loop.
+ *
+ * If there are no commands, prints "Menu is empty!".
+ * If user input doesn't correspond to any command, registers an error message and reprints.
+ */
+void Menu::navigate() const {
+	if (menuOptions.get_count() == 0) {
+		printLine("Menu is empty!");
+		return;
+	}
+
+	char buffer[MAX_LINE_WIDTH];
+
+	unsigned startIndex, commandEnd, paramsStart, index;
+	bool hasThrown = false;
+	while (!hasThrown) {
+		startIndex = 0;
+		inputLineBox(buffer, MAX_LINE_WIDTH, false);
+
+		while (buffer[startIndex] == ' ') startIndex++;
+
+		commandEnd = startIndex;
+		while (buffer[commandEnd] != ' ' && buffer[commandEnd] != '\n' && buffer[commandEnd] != '\0')
+			commandEnd++;
+
+		index = menuOptions.get_count();
+		for (unsigned i = 0; i < menuOptions.get_count() && index == menuOptions.get_count(); i++) {
+			if (strncmp(buffer + startIndex, menuOptions[i].get_name(), commandEnd - startIndex) == 0)
+				index = i;
+		}
+
+		paramsStart = startIndex + commandEnd;
+		while (buffer[paramsStart] == ' ') paramsStart++;
+
+		if (index == menuOptions.get_count()) {
+			printLine("Invalid menu option!");
+			continue;
+		}
+
+		try {
+			menuOptions[index].run(buffer + paramsStart);
+		}
+		catch (std::logic_error err) {
+			hasThrown = true;
+			printLine(err.what());
+		}
+	}
+}
diff --git a/Year 1/Object-oriented Programming/Project 2/src/Generic/ConsoleInterface/Menu.h b/Year 1/Object-oriented Programming/Project 2/src/Generic/ConsoleInterface/Menu.h
new file mode 100644
index 0000000..faadba9
--- /dev/null
+++ b/Year 1/Object-oriented Programming/Project 2/src/Generic/ConsoleInterface/Menu.h
@@ -0,0 +1,33 @@
+#ifndef HEADER_CONSOLEINTERFACE_MENU
+#define HEADER_CONSOLEINTERFACE_MENU
+
+/*! \file Menu.h
+ *  \brief Stores the declaration of class Menu
+ */
+
+#include "Command.h"
+#include "../List/List.hpp"
+
+/*! \brief Handles navigation between multiple commands
+ *
+ * Shows the title, then below it an Error/Warning/Success message if set,
+ * lists all command options as an enumerated list, takes command index
+ * and calls the chosen command's run() function.
+ */
+class Menu {
+	List<Command> menuOptions;
+
+public:
+	//! Sets name as "Menu", leaves all flags to false and creates an empty Command list
+	Menu();
+	//! Copies commands
+	Menu(const Command* commands, unsigned commandCount);
+
+	//! Adds a command to the internal Command list
+	void addCommand(const Command& command);
+
+	//! Lists commands and after user input executes an appropriate command run() function
+	void navigate() const;
+};
+
+#endif
diff --git a/Year 1/Object-oriented Programming/Project 2/src/Generic/ConsoleInterface/Toolbox.cpp b/Year 1/Object-oriented Programming/Project 2/src/Generic/ConsoleInterface/Toolbox.cpp
new file mode 100644
index 0000000..ca739f0
--- /dev/null
+++ b/Year 1/Object-oriented Programming/Project 2/src/Generic/ConsoleInterface/Toolbox.cpp
@@ -0,0 +1,88 @@
+#include "Toolbox.hpp"
+
+/* Input line boxes */
+
+void __inputLineBoxGetInput(char* output, unsigned maxWidth, bool ignore) {
+	if (ignore)
+		std::cin.ignore();
+	std::cin.getline(output, maxWidth);
+}
+
+/*! \param label C-style string, there are no size check so it could wrap
+ *  \param output Pointer to a char array
+ *  \param maxWidth Maximum count of characters to read from user input. output MUST be able to hold that many characters!
+ *  \param ignore Whether or not to ignore the first new-line delimiter.
+ *         true by default, should be set to false only when an inputLineBox/SubBox has been issued directly prior or when it's the very first issued box command.
+ *
+ *  Prints "(+)" before the label.
+ */
+void inputLineBox(char* output, unsigned maxWidth, bool ignore) {
+	print("> ");
+	__inputLineBoxGetInput(output, maxWidth, ignore);
+}
+
+/* Table */
+
+void __printTableHeaderNumber(unsigned number) {
+	std::cout << ":" << ((number < 100) ? " " : "") << number << ((number < 10) ? " " : "");
+}
+
+void __printTableColumnHeader(unsigned count, unsigned start = 1) {
+	std::cout << ":   ";
+	for (unsigned i = 0; i < count; i++)
+		__printTableHeaderNumber(start++);
+	std::cout << ":" << std::endl;
+
+	for (unsigned i = 0; i <= count; i++)
+		std::cout << "====";
+	std::cout << "=" << std::endl;
+}
+
+void __printTableLine(unsigned columns) {
+	std::cout << ":===";
+	for (unsigned i = 0; i < columns; i++)
+		std::cout << "+---";
+	std::cout << ":" << std::endl;
+}
+
+void __printPadded(const String& str, unsigned width) {
+	while (width - str.get_length() > 0) {
+		width--;
+		print(" ");
+	}
+	print(str.get_cstr());
+}
+
+/*! \param startNumber The number by which column and row enumeration begins
+ *  \param columns How many columns the table should have
+ *  \param items C-style string, each cell is a single character from the string
+ *
+ * Prints a string as a grid/table of characters from top to bottom, left to right.
+ * The first character is on the top left, the last one is on the bottom right.
+ *
+ * Table is printed until a terminating zero is encountered.
+ * The rows are "calculated" from the columns count and the items length.
+ */
+void printTable(const List<String>& items, unsigned columns) {
+	unsigned *colWidths = new unsigned[columns];
+	for (unsigned i = 0; i < columns; i++)
+		colWidths[i] = 0;
+
+	for (unsigned i = 0; i < items.get_count(); i++) {
+		if (colWidths[i % columns] < items[i].get_length())
+			colWidths[i % columns] = items[i].get_length();
+	}
+
+	// __printTableColumnHeader(columns);
+
+	for (unsigned i = 0; i < items.get_count(); i++) {
+		__printPadded(items[i], colWidths[i % columns]);
+		if (i % columns == columns - 1)
+			printLine("");
+		else
+			print("|");
+	}
+
+	delete[] colWidths;
+}
+
diff --git a/Year 1/Object-oriented Programming/Project 2/src/Generic/ConsoleInterface/Toolbox.hpp b/Year 1/Object-oriented Programming/Project 2/src/Generic/ConsoleInterface/Toolbox.hpp
new file mode 100644
index 0000000..4b59626
--- /dev/null
+++ b/Year 1/Object-oriented Programming/Project 2/src/Generic/ConsoleInterface/Toolbox.hpp
@@ -0,0 +1,60 @@
+#ifndef HEADER_CONSOLEINTERFACE_TOOLBOX
+#define HEADER_CONSOLEINTERFACE_TOOLBOX
+
+#include <iostream>
+#include "../List/List.hpp"
+#include "../String/String.h"
+
+/*! \file Toolbox.hpp
+ *  \brief Stores a wide range of functions for simpler/more automated printing.
+ *
+ * Adds a lot of functions for printing.
+ *
+ * \remark iostream is included by necessity (templated functions), you should only use the provided functions, if you can.
+ */
+
+#define MAX_LINE_WIDTH 1024
+
+//! Prints label, gets a whole line of input and stores it to output
+void inputLineBox(char* output, unsigned maxWidth, bool ignore = true);
+
+//! Prints a string list as a table
+void printTable(const List<String>& items, unsigned columns);
+
+//! Reads user input and stores it
+template <typename T>
+void read(T* storage) {
+	std::cin >> storage;
+}
+
+//! Reads user input and stores it
+template <typename T>
+void read(T& storage) {
+	std::cin >> storage;
+}
+
+//! Prints given item
+template <typename T>
+void print(const T* item) {
+	std::cout << item;
+}
+
+//! Prints given item
+template <typename T>
+void print(const T& item) {
+	std::cout << item;
+}
+
+//! Prints given item and an endline character
+template <typename T>
+void printLine(const T* item) {
+	std::cout << item << std::endl;
+}
+
+//! Prints given item and an endline character
+template <typename T>
+void printLine(const T& item) {
+	std::cout << item << std::endl;
+}
+
+#endif
diff --git a/Year 1/Object-oriented Programming/Project 2/src/Generic/List/List.hpp b/Year 1/Object-oriented Programming/Project 2/src/Generic/List/List.hpp
new file mode 100644
index 0000000..e0ae8e3
--- /dev/null
+++ b/Year 1/Object-oriented Programming/Project 2/src/Generic/List/List.hpp
@@ -0,0 +1,372 @@
+#ifndef HEADER_LIST
+#define HEADER_LIST
+
+/*! \file List.hpp
+ *  \brief Stores declaration and definition of templated class List
+ */
+
+#include <istream>
+#include <ostream>
+
+/*! \brief Templated class that stores an array of elements in dynamic memory
+ *
+ * \warning findIndex(), contain(), read(), write(), operator<<() and operator>>() require the type to have defined a couple of functions.
+ * \sa findIndex()
+ * \sa contain()
+ * \sa read()
+ * \sa write()
+ * \sa operator<<()
+ * \sa operator>>()
+ */
+template <typename T>
+class List {
+protected:
+	T* elements;
+	unsigned length;
+	unsigned count;
+
+	void resize();
+	void free();
+	void copyFrom(const List& other);
+
+public:
+	//! Copies all elements in given array
+	List(const T* elements, unsigned elementsCount);
+	//! Allocates memory for the given length
+	List(unsigned length);
+	//! Adds an element
+	void add(const T& element);
+	//! Inserts element at given index
+	void insertAt(const T& element, unsigned index);
+	//! Removes element at index
+	bool removeAt(unsigned index);
+	//! Finds the index of element
+	unsigned findIndex(const T& element) const;
+	bool contain(const T& element) const;
+	//! Returns reference to element at index
+	T& operator[](unsigned index);
+	//! Returns constant reference to element at index
+	const T& operator[](unsigned index) const;
+	//! Returns raw array of data
+	const T* raw_data() const;
+	//! Removes all data
+	void clear();
+
+	//! Appends elements from other list
+	List<T>& operator+=(const List<T> other);
+
+	//! Reads from stream
+	std::istream& read(std::istream& istr);
+	//! Writes to stream
+	std::ostream& write(std::ostream& ostr) const;
+
+	//! Returns the length
+	unsigned get_length() const;
+	//! Returns the count
+	unsigned get_count() const;
+
+	List();
+	List& operator=(const List& other);
+	List(const List& other);
+	~List();
+
+	List(List&& other);
+	List& operator=(List&& other);
+};
+
+//! Reads List from stream with >> operator
+template <typename T>
+std::istream& operator>>(std::istream& istr, List<T>& obj);
+//! Writes List to stream with << operator
+template <typename T>
+std::ostream& operator<<(std::ostream& ostr, const List<T>& obj);
+
+/* Private */
+
+template <typename T>
+void List<T>::resize() {
+	length = (length == 0) ? 8 : length << 1;
+	T* temp = new T[length];
+	for (int i = 0; i < count; i++)
+		temp[i] = elements[i];
+	delete[] elements;
+	elements = temp;
+}
+
+template <typename T>
+void List<T>::free() {
+	delete[] elements;
+}
+
+template <typename T>
+void List<T>::copyFrom(const List& other) {
+	elements = new T[other.length];
+	for (int i = 0; i < other.count; i++)
+		elements[i] = other.elements[i];
+	length = other.length;
+	count = other.count;
+}
+
+/* Public */
+
+template <typename T>
+List<T>::List(const T* elements, unsigned elementsCount) {
+	length = 8;
+	count = elementsCount;
+	this->elements = new T[length];
+	for (unsigned i = 0; i < count; i++)
+		this->elements[i] = elements[i];
+}
+
+template <typename T>
+List<T>::List(unsigned length) {
+	this->length = count = length;
+	this->elements = new T[length];
+	for (unsigned i = 0; i < count; i++)
+		this->elements[i] = elements[i];
+}
+
+/*!
+ * Resizes internal array if there is no space for additional elements.
+ */
+template <typename T>
+void List<T>::add(const T& element) {
+	if (length == count) resize();
+
+	elements[count++] = element;
+}
+
+/*!
+ * If index is after the last element, the element is just added.
+ * Otherwise all elements after the index are shifted right and element is put in place.
+ *
+ * Resizes internal array if there is no space for additional elements.
+ */
+template <typename T>
+void List<T>::insertAt(const T& element, unsigned index) {
+	if (index >= count) {
+		add(element);
+		return;
+	}
+	if (length == count) resize();
+
+	for (unsigned i = count; i > index; i--)
+		elements[i] = elements[i - 1];
+
+	elements[index] = element;
+	count++;
+}
+
+/*! \returns Wether element could be removed
+ *
+ * If index is after that of the last element, nothing is done and false is returned.
+ * Otherwise elements after index are shifted right and count is reduced.
+ */
+template <typename T>
+bool List<T>::removeAt(unsigned index) {
+	if (index >= count) return false;
+
+	for (int i = index; i < count; i++)
+		elements[i] = elements[i + 1];
+	count--;
+	return true;
+}
+
+/*! \returns Index of element. If element isn't found, returns the count of element.
+ *
+ * \warning The function depends on the type having a function "compare" defined, which takes two elements and returns a number <0 if elem1 < elem2, >0 if elem1 > elem2, 0 if elem1 == elem2
+ * \note Searching is done linearly
+ */
+template <typename T>
+unsigned List<T>::findIndex(const T& element) const {
+	unsigned ind = 0;
+	while (ind < count && elements[ind].compare(element) != 0)
+		ind++;
+	return ind;
+}
+
+/*! \returns Whether the element is contained in the current List
+ *
+ * \warning Function depends on findIndex(), which means the same "compare" function must be defined in the type
+ * \sa findIndex()
+ */
+template <typename T>
+bool List<T>::contain(const T& element) const {
+	return findIndex(element) < count;
+}
+
+template <typename T>
+T& List<T>::operator[](unsigned index) {
+	return elements[index];
+}
+
+template <typename T>
+const T& List<T>::operator[](unsigned index) const {
+	return elements[index];
+}
+
+template <typename T>
+const T* List<T>::raw_data() const {
+	return elements;
+}
+
+template <typename T>
+void List<T>::clear() {
+	free();
+	length = 8;
+	count = 0;
+	this->elements = new T[length];
+}
+
+template <typename T>
+List<T>& List<T>::operator+=(const List<T> other) {
+	for (unsigned i = 0; i < other.length; i++)
+		add(other[i]);
+	return *this;
+}
+
+/*! \param istr An input stream
+ *
+ * Directly reads bytes from stream (calls read() function).
+ * Any stored values are deleted and replaced with those from the stream.
+ * 
+ * \warning The function depends on the type having a function "read" defined, which takes an std::istream& and writes it's data to it. Return type doesn't matter.
+ * \remark Doesn't alter the stream in any other way.
+ * \note Best used with binary ifstream
+ */
+template <typename T>
+std::istream& List<T>::read(std::istream& istr) {
+	istr.read((char*)&length, sizeof(length));
+	istr.read((char*)&count, sizeof(count));
+
+	delete[] elements;
+	elements = new T[length];
+
+	for (int i = 0; i < count; i++)
+		elements[i].read(istr);
+
+	return istr;
+}
+
+/*! \param ostr An output stream
+ *
+ * Directly writes bytes to stream (calls write() function).
+ * 
+ * \warning The function depends on the type having a function "write" defined, which takes an std::ostream& and writes it's data to it. Return type doesn't matter.
+ * \remark Doesn't alter the stream in any other way.
+ * \note Best used with binary ofstream
+ */
+template <typename T>
+std::ostream& List<T>::write(std::ostream& ostr) const {
+	ostr.write((const char*)&length, sizeof(length));
+	ostr.write((const char*)&count, sizeof(count));
+
+	for (int i = 0; i < count; i++)
+		elements[i].write(ostr);
+
+	return ostr;
+}
+
+/*!
+ * Length is the size of the underlying array (allocated memory).
+ */
+template <typename T>
+unsigned List<T>::get_length() const {
+	return length;
+}
+
+/*!
+ * Count is the amount of elements that are stored.
+ */
+template <typename T>
+unsigned List<T>::get_count() const {
+	return count;
+}
+
+// Rule of 4
+
+template <typename T>
+List<T>::List() : List(nullptr, 0) {}
+
+template <typename T>
+List<T>& List<T>::operator=(const List& other) {
+	if (this != &other) {
+		free();
+		copyFrom(other);
+	}
+	return *this;
+}
+
+template <typename T>
+List<T>::List(const List& other) {
+	copyFrom(other);
+}
+
+template <typename T>
+List<T>::~List() {
+	free();
+}
+
+// Move semantics
+
+template <typename T>
+List<T>::List(List&& other) {
+	length = other.length;
+	count = other.count;
+	elements = other.elements;
+	other.elements = nullptr;
+}
+
+template <typename T>
+List<T>& List<T>::operator=(List&& other) {
+	if (this != &other) {
+		free();
+		length = other.length;
+		count = other.count;
+		elements = other.elements;
+		other.elements = nullptr;
+	}
+	return *this;
+}
+
+/* Outside of class */
+
+/*!
+ * Uses the stream's >> operator to read and parse the elements.
+ * The first item in the stream should be the count.
+ *
+ * \warning The function depends on the type having the operator >> defined, which takes an std::istream& and writes it's data to it. Return type doesn't matter.
+ * \note Best used with std::cin or text std::ifstream
+ */
+template <typename T>
+std::istream& operator>>(std::istream& istr, List<T>& obj) {
+	List<T> newObj;
+	unsigned count;
+	istr >> count;
+
+	T temp;
+	for (int i = 0; i < count; i++) {
+		istr >> temp;
+		obj.add(temp);
+	}
+
+	return istr;
+}
+
+/*!
+ * Uses the stream's << operator to write the count and then all objects.
+ *
+ * \warning The function depends on the type having the operator << defined, which takes an std::ostream& and writes it's data to it. Return type doesn't matter.
+ * \note Best used with std::cout or text std::ofstream
+ */
+template <typename T>
+std::ostream& operator<<(std::ostream& ostr, const List<T>& obj) {
+	ostr << obj.get_count() << std::endl;
+	for (int i = 0; i < obj.get_count(); i++)
+		ostr << obj[i];
+
+	return ostr;
+}
+
+
+#endif
diff --git a/Year 1/Object-oriented Programming/Project 2/src/Generic/Pair/Pair.hpp b/Year 1/Object-oriented Programming/Project 2/src/Generic/Pair/Pair.hpp
new file mode 100644
index 0000000..64614ca
--- /dev/null
+++ b/Year 1/Object-oriented Programming/Project 2/src/Generic/Pair/Pair.hpp
@@ -0,0 +1,28 @@
+#ifndef PAIR
+#define PAIR
+
+/*! \file Pair.hpp
+ *  \brief Stores the declaration of struct Pair
+ */
+
+/*! \brief Stores two values of any types
+ *
+ * Values are public, so no explicit getters or setters are made.
+ */
+template <typename T, typename U>
+struct Pair {
+	T left;
+	U right;
+
+	Pair();
+	Pair(const T& left, const U& right);
+};
+
+template <typename T, typename U>
+Pair<T, U>::Pair() : left(), right() {}
+
+
+template <typename T, typename U>
+Pair<T, U>::Pair(const T& left, const U& right) : left(left), right(right) {}
+
+#endif
diff --git a/Year 1/Object-oriented Programming/Project 2/src/Generic/String/String.cpp b/Year 1/Object-oriented Programming/Project 2/src/Generic/String/String.cpp
new file mode 100644
index 0000000..57e5d58
--- /dev/null
+++ b/Year 1/Object-oriented Programming/Project 2/src/Generic/String/String.cpp
@@ -0,0 +1,191 @@
+#include "String.h"
+#include <cstring>
+
+/* Private */
+
+void String::free() {
+	delete[] str;
+}
+
+void String::copyFrom(const String& other) {
+	str = new char[other.length + 1];
+	strncpy(str, other.str, other.length + 1);
+	length = other.length;
+}
+
+/* Public */
+
+/*!
+ * Allocated with length + 1 size, so there is a terminating zero at the end.
+ */
+String::String(unsigned length) {
+	this->length = length;
+	str = new char[length + 1];
+	str[length] = '\0';
+}
+
+/*! \params str C-style string
+ */
+String::String(const char* str) {
+	length = strlen(str);
+	this->str = new char[length + 1]; // capture terminating zero
+	strncpy(this->str, str, length + 1);
+}
+
+const char* String::get_cstr() const {
+	return str;
+}
+
+unsigned String::get_length() const {
+	return length;
+}
+
+char& String::operator[](unsigned index) {
+	return str[index];
+}
+
+/*! \params str C-style string
+ */
+String& String::operator+=(const char* str) {
+	unsigned strLen = strlen(str);
+	char* newStr = new char[length + strLen + 1];
+	strncpy(newStr, this->str, length + 1);
+	strncat(newStr, str, strLen + 1);
+
+	delete[] this->str;
+	this->str = newStr;
+	length += strLen;
+
+	return *this;
+}
+
+/*!
+ * Converts the number to a C-style string and then uses += to append it.
+ */
+String& String::operator+=(int number) {
+	if (number < 0) {
+		*this += "-";
+		number *= -1;
+	}
+	return *this += (unsigned)number;
+}
+
+/*!
+ * Converts the number to a C-style string and then uses += to append it.
+ */
+String& String::operator+=(unsigned number) {
+	unsigned tempLen = 0;
+	for (unsigned tmp = number; tmp > 0 || tempLen == 0; tmp /= 10)
+		tempLen++;
+
+	char* tmp = new char[tempLen + 1];
+	tmp[tempLen] = '\0';
+	for (unsigned i = tempLen - 1; i < tempLen; i--, number /= 10)
+		tmp[i] = number % 10 + '0';
+
+	*this += tmp;
+	delete[] tmp;
+	return *this;
+}
+
+/*!
+ * Converts the number to a C-style string and then uses += to append it.
+ */
+String& String::operator+=(double number) {
+	if (number < 0) {
+		*this += "-";
+		number *= -1;
+	}
+	number += 1.0 / (DOUBLE_PRECISION * 10); // bump up the number, in cases it becomes something like 8.59999999999...
+	return ((*this += (unsigned)number) += ".")
+				   += (unsigned)((number - (unsigned)number) * DOUBLE_PRECISION);
+}
+
+String::String() : String("") {}
+
+String::String(const String& other) {
+	copyFrom(other);
+}
+
+String& String::operator=(const String& other) {
+	if (this != &other) {
+		free();
+		copyFrom(other);
+	}
+	return *this;
+}
+
+String::~String() {
+	free();
+}
+
+String::String(String&& other) {
+	str = other.str;
+	other.str = nullptr;
+	length = other.length;
+}
+
+String& String::operator=(String&& other) {
+	if (this != &other) {
+		delete[] str;
+		str = other.str;
+		other.str = nullptr;
+		length = other.length;
+	}
+	return *this;
+}
+
+/*! \param istr An input stream
+ *
+ * Directly reads bytes from stream (calls read() function).
+ * First reads the string length, then the underlying C-style string (including terminating zero).
+ * 
+ * \remark Doesn't alter the stream in any other way.
+ * \note Best used with binary ifstream
+ */
+void String::read(std::istream& istr) {
+	istr.read((char*)&length, sizeof(length));
+	istr.read(str, sizeof(char) * (length + 1));
+}
+
+/*! \param ostr An output stream
+ *
+ * Directly writes bytes to stream (calls write() function).
+ * First writes the string length, then the underlying C-style string (including terminating zero).
+ * 
+ * \remark Doesn't alter the stream in any other way.
+ * \note Best used with binary ofstream
+ */
+void String::write(std::ostream& ostr) const {
+	ostr.write((char*)&length, sizeof(length));
+	ostr.write(str, sizeof(char) * (length + 1));
+}
+
+/*! \params other C-style string
+ *  \returns strcmp between underlying C-style string and "other"
+ */
+int String::compare(const String& other) const {
+	return strcmp(str, other.str);
+}
+
+/*!
+ * Uses the stream's getline function to read the data.
+ *
+ * \warning It takes at most 1024 characters from the stream!
+ * \note Best used with std::cin or text std::ifstream
+ */
+std::istream& operator>>(std::istream& istr, String& str) {
+	istr.getline(str.str, 1024);
+	str.length = strlen(str.str);
+
+	return istr;
+}
+
+/*!
+ * Uses the stream's << operator to write the underlying C-style string
+ *
+ * \note Best used with std::cout or text std::ofstream
+ */
+std::ostream& operator<<(std::ostream& ostr, const String& str) {
+	return ostr << str.str;
+}
diff --git a/Year 1/Object-oriented Programming/Project 2/src/Generic/String/String.h b/Year 1/Object-oriented Programming/Project 2/src/Generic/String/String.h
new file mode 100644
index 0000000..93534fe
--- /dev/null
+++ b/Year 1/Object-oriented Programming/Project 2/src/Generic/String/String.h
@@ -0,0 +1,66 @@
+#ifndef HEADER_STRING
+#define HEADER_STRING
+
+/*! \file String.h
+ *  \brief Stores declaration of class String
+ */
+
+#include <istream>
+#include <ostream>
+
+#define DOUBLE_PRECISION 100
+
+/*! \brief A dynamically-allocated C-style string with extra features
+ *
+ * \remark There is no buffer allocation, meaning each String takes only the amount of memory it needs and every append operation juggles around memory.
+ */
+class String {
+	char* str;
+	unsigned length;
+
+	void free();
+	void copyFrom(const String& other);
+
+public:
+	//! The underlying array is allocated with length (+ 1) size
+	String(unsigned length);
+	//! Copies str
+	String(const char* str);
+	//! Returns internal C-style string
+	const char* get_cstr() const;
+	//! Returns number of characters in string
+	unsigned get_length() const;
+	//! Returns a character reference (from the underlying C-style string) at the given index
+	char& operator[](unsigned index);
+
+	//! Appends a C-style string
+	String& operator+=(const char* str);
+	//! Appends a number
+	String& operator+=(int number);
+	//! Appends a number
+	String& operator+=(unsigned number);
+	//! Appends a number
+	String& operator+=(double number);
+
+	String();
+	String(const String& other);
+	String& operator=(const String& other);
+	~String();
+
+	String(String&& other);
+	String& operator=(String&& other);
+
+	//! Reads String from stream
+	void read(std::istream& istr);
+	//! Writes String to stream
+	void write(std::ostream& ostr) const;
+	//! Compares two strings
+	int compare(const String& other) const;
+
+	//! Reads String from stream with >> operator
+	friend std::istream& operator>>(std::istream& istr, String& str);
+	//! Writes String to stream with << operator
+	friend std::ostream& operator<<(std::ostream& ostr, const String& str);
+};
+
+#endif