Added ResourceTile serialization and serialization framework

Author: Databean

Makefile

@@ -21,3 +21,8 @@ $(EXECUTABLE): $(ALLFILES)
 tests:
 	cd UnitTest++ && $(MAKE) libUnitTest++.a
 	cd tests && $(MAKE)
+
+.PHONY: clean
+clean:
+	rm -f $(EXECUTABLE)
+	rm -f obj/*.o

include/GameBoard.h

@@ -24,16 +24,15 @@ class GameBoard {
 	std::map<Coordinate, std::unique_ptr<GamePiece>> resources;
 	std::vector<std::unique_ptr<Road>> roads;
 
-	int constructBoardFromFile(std::ifstream &file);
-	int constructFileFromBoard(std::ofstream &file);
 public:
 	GameBoard();
+	GameBoard(std::istream& in);
 	GameBoard(GameBoard&) = delete;
 	~GameBoard();
 	GameBoard& operator=(GameBoard&) = delete;
 
-	int save_Board(std::string filename);
-	int load_Board(std::string filename);
+	void save(std::ostream& out);
+	
 	const std::map<Coordinate, std::unique_ptr<GamePiece>>& getResources() const;
 
 	std::vector<Settlement*> GetNeighboringSettlements(Coordinate location);

include/XMLVisitor.h include/Serialization.hinclude/XMLVisitor.h renamed to include/Serialization.h

@@ -1,5 +1,5 @@
-#ifndef XML_VISITOR_H
-#define XML_VISITOR_H
+#ifndef SERIALIZATION_H
+#define SERIALIZATION_H
 
 #include "GameVisitor.h"
 #include "Util.h"
@@ -25,4 +25,6 @@ class XMLVisitor : public GameVisitor {
 	const tinyxml2::XMLDocument& getXMLDoc() const;
 };
 
+Coordinate xmlElementToCoord(const tinyxml2::XMLElement& element);
+
 #endif

include/Util.h

@@ -2,7 +2,23 @@
 #define UTIL_H
 
 #include <utility>
+#include <sstream>
 
 typedef std::pair<int, int> Coordinate;
 
+template<class T> 
+T fromString(const std::string& s) {
+	std::stringstream stream(s);
+	T ret;
+	stream >> ret;
+	return ret;
+}
+
+template<class T>
+std::string toString(T t) {
+	std::stringstream stream;
+	stream << t;
+	return stream.str();
+}
+
 #endif

src/GameBoard.cpp

@@ -2,78 +2,73 @@
 
 #include <map>
 #include <memory>
-
-using std::map;
-using std::unique_ptr;
-
 #include <ctime>
 #include <algorithm>
+#include <iostream>
 
 #include "GameVisitor.h"
+#include "Serialization.h"
+#include "tinyxml2.h"
 
 #define ADD_RESOURCE(x, y, res, val) (this->resources[Coordinate(x,y)] = \
 std::unique_ptr<GamePiece>(new ResourceTile(*this, Coordinate(x,y), res, val)))
 #define DUMMY_BOARD //define to instantiate dummy board for debugging 
 
 using std::random_shuffle;
 using std::time;
+using std::string;
+using std::map;
+using std::unique_ptr;
+using std::istream;
+using std::ostream;
 
 GameBoard::GameBoard() {
 	init_resources();
 }
 
-GameBoard::~GameBoard() {
+GameBoard::GameBoard(istream& in) {
+	std::string gameXML;
+	std::getline(in, gameXML, '\0'); //Read until the null character (end of file) and put in the string
 
-}
-
-
-int GameBoard::save_Board(std::string filename){
-	std::ofstream file;
-	file.exceptions(std::ofstream::failbit | std::ofstream::badbit);
-	try {
-		filename = filename + ".wocs";
-		file.open(filename.c_str());
-		constructFileFromBoard(file);
-		file.close();
-		return 0;
-	} catch (std::ofstream::failure e) {
-		std::cerr << "Exception opening/closing/writing file: " << e.what();
-	}
-	return -1;
-}
-
-int GameBoard::load_Board(std::string filename){
-	std::ifstream file;
-	try {
-		filename = filename + ".wocs";
-		file.open(filename.c_str());
-		constructBoardFromFile(file);
-		file.close();
-		return 0;
-	} catch (std::ifstream::failure e) {
-		std::cerr << "Exception opening/closing/reading file: " << e.what();
-	}
-	return -1;
-}
-
-int GameBoard::constructBoardFromFile(std::ifstream &file){
-	//Parse and construct the board from the file
-	//@ TODO
-	std::string line;
-	if (file.is_open()) {
-		while (getline(file, line)) {
-			std::cout << line << '\n';
+	tinyxml2::XMLDocument doc;
+	doc.Parse(gameXML.c_str());
+	
+	auto hexTiles = doc.RootElement()->FirstChildElement("tiles");
+	
+	for(tinyxml2::XMLElement* tileElement = hexTiles->FirstChildElement(); tileElement; tileElement = tileElement->NextSiblingElement()) {
+		static const map<std::string, resourceType> textToType = {
+			std::make_pair("wheat", WHEAT),
+			std::make_pair("sheep", SHEEP),
+			std::make_pair("stone", STONE),
+			std::make_pair("brick", BRICK),
+			std::make_pair("wood", WOOD),
+			std::make_pair("desert", DESERT),
+		};
+		std::string typeString = tileElement->FirstChildElement("type")->FirstChild()->Value();
+		auto it = textToType.find(typeString);
+		if(it == textToType.end()) {
+			throw std::runtime_error("Invalid type string");
 		}
+		resourceType type = it->second;
+		
+		int diceValue = fromString<int>(tileElement->FirstChildElement("value")->FirstChild()->Value());
+		
+		Coordinate coord = xmlElementToCoord(*(tileElement->FirstChildElement("coordinate")));
+		
+		resources[coord] = unique_ptr<ResourceTile>(new ResourceTile(*this, coord, type, diceValue));
 	}
-	return 0;
 }
 
+GameBoard::~GameBoard() {
+	
+}
 
-int GameBoard::constructFileFromBoard(std::ofstream &file){
-	//Construct the file based on the structure of the board
-	//@ TODO
-	file << "Hello World!";
-	return 0;
+void GameBoard::save(ostream& out) {
+	XMLVisitor saver;
+	accept(saver);
+	tinyxml2::XMLPrinter printer;
+	saver.getXMLDoc().Print(&printer);
+	out << printer.CStr();
 }
 
 const map<Coordinate, unique_ptr<GamePiece>>& GameBoard::getResources() const {

src/XMLVisitor.cpp src/Serialization.cppsrc/XMLVisitor.cpp renamed to src/Serialization.cpp

@@ -1,4 +1,4 @@
-#include "XMLVisitor.h"
+#include "Serialization.h"
 
 #include <map>
 #include <utility>
@@ -89,6 +89,10 @@ void XMLVisitor::visit(ResourceTile& tile) {
 
 	newTileElement->InsertEndChild(coordinateElement(tile.getCoordinates()));
 
+	XMLElement* tileValueElement = xmldoc.NewElement("value");
+	tileValueElement->InsertEndChild(xmldoc.NewText(toString(tile.getDiceValue()).c_str()));
+	newTileElement->InsertEndChild(tileValueElement);
+	
 	tilesElement->InsertEndChild(newTileElement);
 }
 
@@ -103,3 +107,7 @@ const tinyxml2::XMLDocument& XMLVisitor::getXMLDoc() const {
 	return xmldoc;
 }
 
+Coordinate xmlElementToCoord(const XMLElement& elem) {
+	return Coordinate(elem.IntAttribute("u"), elem.IntAttribute("v"));
+}
+

tests/Makefile

@@ -7,7 +7,7 @@ OBJECTS_NO_MAIN := $(subst $(OBJ_HOME)/main.o,,$(OBJECTS))
 run: $(TEST_FILE)
 	./$(TEST_FILE)
 
-$(TEST_FILE): ../$(EXECUTABLE) $(TEST_LINK_FILES)
+$(TEST_FILE): ../$(EXECUTABLE) $(TEST_LINK_FILES) $(wildcard *.cpp)
 	$(CXX) $(CXXFLAGS) -I$(TEST_INCLUDE) $(wildcard *.cpp) -o $@ $(TEST_LINK_FILES) $(OBJECTS_NO_MAIN) $(LDFLAGS)
 
 .PHONY: clean

tests/testSerialization.cpp

@@ -1,21 +1,22 @@
 #include <UnitTest++.h>
 
-#include "XMLVisitor.h"
+#include "Serialization.h"
 #include "GameBoard.h"
 #include "Player.h"
 
 #include "tinyxml2.h"
 
 #include <iostream>
+#include <sstream>
+
+using std::stringstream;
 
 TEST(xmlPrint) {
 	GameBoard testBoard;
 
-	XMLVisitor vs;
-	testBoard.accept(vs);
+	stringstream stream;
+	testBoard.save(stream);
 
-	tinyxml2::XMLPrinter printer;
-	vs.getXMLDoc().Print( &printer );
+	GameBoard copyBoard(stream);
 
-	std::cout << printer.CStr() << std::endl;
 }

tests/test_GameBoard.cpp

@@ -7,16 +7,3 @@
 
 #include "GameBoard.h"
 #include "UnitTest++.h"
-
-
-TEST(saveFile_simple){
-	GameBoard * test_board = new GameBoard;
-	CHECK(test_board->save_Board("test_1") == 0);
-	delete(test_board);
-}
-
-TEST(loadFile_simple){
-	GameBoard * test_board = new GameBoard;
-	CHECK(test_board->load_Board("test_1") == 0);
-	delete(test_board);
-}