Corrected ortograph of some core classes.

Author: stephanemagnenat

libgag/include/FormatableString.h

@@ -27,10 +27,10 @@ namespace GAGCore {
 	/*!
 	* string that can be used for argument substitution.
 	* Example :
-	* FormatableString fs("Hello %0");
+	* FormattableString fs("Hello %0");
 	* cout << fs.arg("World");
 	*/
-	class FormatableString : public std::string
+	class FormattableString : public std::string
 	{
 		private:
 			/*!
@@ -45,14 +45,14 @@ namespace GAGCore {
 
 		public:
 
-			FormatableString() : std::string(), argLevel(0) { }
+			FormattableString() : std::string(), argLevel(0) { }
 			/*!
-			* Creates a new FormatableString with format string set to s.
+			* Creates a new FormattableString with format string set to s.
 			* \param s A string with indicators for argument substitution.
 			* Each indicator is the % symbol followed by a number. The number
 			* is the index of the corresponding argument (starting at %0).
 			*/
-			FormatableString(const std::string &s)
+			FormattableString(const std::string &s)
 		: std::string(s), argLevel(0) { }
 
 			/*!
@@ -63,7 +63,7 @@ namespace GAGCore {
 			* \param fillChar Character used to pad the number to reach fieldWidth
 			* \see arg(const T& value)
 			*/
-			FormatableString &arg(int value, int fieldWidth = 0, int base = 10, char fillChar = ' ');
+			FormattableString &arg(int value, int fieldWidth = 0, int base = 10, char fillChar = ' ');
 
 			/*!
 			* Replace the next arg by an int value.
@@ -73,7 +73,7 @@ namespace GAGCore {
 			* \param fillChar Character used to pad the number to reach fieldWidth
 			* \see arg(const T& value)
 			*/
-			FormatableString &arg(unsigned value, int fieldWidth = 0, int base = 10, char fillChar = ' ');
+			FormattableString &arg(unsigned value, int fieldWidth = 0, int base = 10, char fillChar = ' ');
 
 			/*!
 			* Replace the next arg by a float value.
@@ -83,14 +83,14 @@ namespace GAGCore {
 			* \param fillChar Character used to pad the number to reach fieldWidth.
 			* \see arg(const T& value)
 			*/
-			FormatableString &arg(float value, int fieldWidth = 0, int precision = 6, char fillChar = ' ');
+			FormattableString &arg(float value, int fieldWidth = 0, int precision = 6, char fillChar = ' ');
 
 			/*!
 			* Replace the next arg by a value that can be passed to an ostringstream.
 			* The first call to arg replace %0, the second %1, and so on.
 			* \param value Value used to replace the current argument.
 			*/
-			template <typename T> FormatableString &arg(const T& value)
+			template <typename T> FormattableString &arg(const T& value)
 			{
 				// transform value into std::string
 				std::ostringstream oss;
@@ -107,7 +107,7 @@ namespace GAGCore {
 			* counter.
 			* \param str New format string.
 			*/
-			FormatableString& operator=(const std::string& str) ;
+			FormattableString& operator=(const std::string& str) ;
 
 			/*!
 			* Casts this string to a const char*

libgag/include/Toolkit.h

@@ -31,7 +31,7 @@ namespace GAGCore
 	class StringTable;
 	class GraphicContext;
 
-	//! Toolkit is a ressource server
+	//! Toolkit is a resource server
 	class Toolkit
 	{
 	private:

libgag/src/FormatableString.cpp

@@ -27,7 +27,7 @@
 #include <FormatableString.h>
 
 namespace GAGCore {
-	void FormatableString::proceedReplace(const std::string &replacement)
+	void FormattableString::proceedReplace(const std::string &replacement)
 	{
 		std::ostringstream search;
 		search << "%" << this->argLevel;
@@ -43,7 +43,7 @@ namespace GAGCore {
 		++argLevel;
 	}
 
-	FormatableString &FormatableString::arg(int value, int fieldWidth, int base, char fillChar)
+	FormattableString &FormattableString::arg(int value, int fieldWidth, int base, char fillChar)
 	{
 		std::ostringstream oss;
 		oss << std::setbase(base);
@@ -59,7 +59,7 @@ namespace GAGCore {
 		return *this;
 	}
 
-	FormatableString &FormatableString::arg(unsigned value, int fieldWidth, int base, char fillChar)
+	FormattableString &FormattableString::arg(unsigned value, int fieldWidth, int base, char fillChar)
 	{
 		std::ostringstream oss;
 		oss << std::setbase(base);
@@ -75,7 +75,7 @@ namespace GAGCore {
 		return *this;
 	}
 
-	FormatableString &FormatableString::arg(float value, int fieldWidth, int precision, char fillChar)
+	FormattableString &FormattableString::arg(float value, int fieldWidth, int precision, char fillChar)
 	{
 		std::ostringstream oss;
 		oss.precision(precision);
@@ -92,7 +92,7 @@ namespace GAGCore {
 		return *this;
 	}
 
-	FormatableString &FormatableString::operator=(const std::string& str)
+	FormattableString &FormattableString::operator=(const std::string& str)
 	{
 		this->assign(str);
 		this->argLevel = 0;

libgag/src/GUIProgressBar.cpp

@@ -75,7 +75,7 @@ namespace GAGGUI
 		Style::style->drawProgressBar(parent->getSurface(), x, y+hDec, w, value, range);
 		if (fontPtr)
 		{
-			FormatableString text = FormatableString(format).arg((value*100)/range);
+			FormattableString text = FormattableString(format).arg((value*100)/range);
 			int textW = fontPtr->getStringWidth(text.c_str());
 			int textH = fontPtr->getStringHeight(text.c_str());
 			parent->getSurface()->drawString(x + ((w-textW) >> 1), y + ((h-textH) >> 1), fontPtr, text);

libgag/src/KeyPress.cpp

@@ -162,7 +162,7 @@ std::string KeyPress::format() const
 		s+="<meta>";
 	if(shift)
 		s+="<shift>";
-	s+=FormatableString("<%0>").arg(key);
+	s+=FormattableString("<%0>").arg(key);
 	return s;
 }
 
@@ -248,13 +248,13 @@ std::string KeyPress::getTranslated() const
 	}
 	//Visual order, control always first. Rather than alt-control-a for example, its control-alt-a
 	if(alt)
-		str=FormatableString(table->getString("[alt %0]")).arg(str);
+		str=FormattableString(table->getString("[alt %0]")).arg(str);
 	if(meta)
-		str=FormatableString(table->getString("[meta %0]")).arg(str);
+		str=FormattableString(table->getString("[meta %0]")).arg(str);
 	if(shift)
-		str=FormatableString(table->getString("[shift %0]")).arg(str);
+		str=FormattableString(table->getString("[shift %0]")).arg(str);
 	if(control)
-		str=FormatableString(table->getString("[control %0]")).arg(str);
+		str=FormattableString(table->getString("[control %0]")).arg(str);
 	return str;
 }
 

libgag/src/StringTable.cpp

@@ -182,7 +182,7 @@ namespace GAGCore
 			bool lcwp=false;
 			int baseCount=0;
 			const std::string &s = it->first;
-			// we check that we only have valid format (from a FormatableString point of view)...
+			// we check that we only have valid format (from a FormattableString point of view)...
 			for (size_t j=0; j<s.length(); j++)
 			{
 				char c = s[j];

src/AI.cpp

@@ -40,15 +40,15 @@ using boost::shared_ptr;
 /*AI::AI(Player *player)
 {
 	aiImplementation=new AICastor(player);
-	this->implementitionID=NUMBI;
+	this->implementationID=NUMBI;
 	this->player=player;
 }*/
 
-AI::AI(ImplementitionID implementitionID, Player *player)
+AI::AI(ImplementationID implementationID, Player *player)
 {
 	aiImplementation=NULL;
 
-	switch (implementitionID)
+	switch (implementationID)
 	{
 		case NONE:
 			aiImplementation=new AINull();
@@ -65,7 +65,7 @@ AI::AI(ImplementitionID implementitionID, Player *player)
 		case WARRUSH:
 			aiImplementation=new AIWarrush(player);
 		break;
-		case REACHTOINFINITY:
+		case REACH_TO_INFINITY:
 			aiImplementation=new AIEcho::Echo(new AIEcho::ReachToInfinity, player);
 		break;
 		case TOUBIB:
@@ -76,14 +76,14 @@ AI::AI(ImplementitionID implementitionID, Player *player)
 		break;
 	}
 
-	this->implementitionID=implementitionID;
+	this->implementationID=implementationID;
 	this->player=player;
 }
 
 AI::AI(GAGCore::InputStream *stream, Player *player, Sint32 versionMinor)
 {
 	aiImplementation=NULL;
-	implementitionID=NONE;
+	implementationID=NONE;
 	this->player=player;
 	bool goodLoad=load(stream, versionMinor);
 	assert(goodLoad);
@@ -119,14 +119,14 @@ bool AI::load(GAGCore::InputStream *stream, Sint32 versionMinor)
 	stream->read(signature, 4, "signatureStart");
 	if (memcmp(signature,"AI b", 4)!=0)
 	{
-		fprintf(stderr, "AI::bad begining signature\n");
+		fprintf(stderr, "AI::bad beginning signature\n");
 		stream->readLeaveSection();
 		return false;
 	}
 
-	implementitionID=(ImplementitionID)stream->readUint32("implementitionID");
+	implementationID=(ImplementationID)stream->readUint32("implementitionID");
 
-	switch (implementitionID)
+	switch (implementationID)
 	{
 		case NONE:
 			aiImplementation=new AINull();
@@ -141,7 +141,7 @@ bool AI::load(GAGCore::InputStream *stream, Sint32 versionMinor)
 			aiImplementation=new AIEcho::Echo(new NewNicowar, player);
 			aiImplementation->load(stream, player, versionMinor);
 		break;
-		case REACHTOINFINITY:
+		case REACH_TO_INFINITY:
 			aiImplementation=new AIEcho::Echo(new AIEcho::ReachToInfinity, player);
 			aiImplementation->load(stream, player, versionMinor);
 		break;
@@ -152,7 +152,7 @@ bool AI::load(GAGCore::InputStream *stream, Sint32 versionMinor)
 			aiImplementation=new AIWarrush(stream, player, versionMinor);
 		break;
 		default:
-			fprintf(stderr, "AI id %d does not exist, you probably try to load a map from a more recent version of glob2.\n", implementitionID);
+			fprintf(stderr, "AI id %d does not exist, you probably try to load a map from a more recent version of glob2.\n", implementationID);
 			assert(false);
 		break;
 	}
@@ -173,7 +173,7 @@ void AI::save(GAGCore::OutputStream *stream)
 	stream->writeEnterSection("AI");
 	stream->write("AI b", 4, "signatureStart");
 
-	stream->writeUint32(static_cast<Uint32>(implementitionID), "implementitionID");
+	stream->writeUint32(static_cast<Uint32>(implementationID), "implementitionID");
 
 	assert(aiImplementation);
 	aiImplementation->save(stream);

src/AI.h

@@ -38,7 +38,7 @@ class AI
 {
 public:
 	///TODO: Explain
-	enum ImplementitionID
+	enum ImplementationID
 	{
 		///Reference to AINull
 		NONE=0,
@@ -49,7 +49,7 @@ class AI
 		///Reference to AIWarrush
 		WARRUSH=3,
 		///Reference to the AIEcho based AIReachToInfinity
-		REACHTOINFINITY=4,
+		REACH_TO_INFINITY=4,
 		///Reference to the AIEcho based AINicowar
 		NICOWAR=5,
 
@@ -58,17 +58,17 @@ class AI
 
 		EXPERIMENTAL_SIZE
 	};
-	static const ImplementitionID toggleAI=CASTOR;
+	static const ImplementationID toggleAI=CASTOR;
 
 public:
 	//AI(Player *player); //TODO: remove this constructor, and choose the AI the user wants.
-	AI(ImplementitionID implementitionID, Player *player);
+	AI(ImplementationID implementationID, Player *player);
 	AI(GAGCore::InputStream *stream, Player *player, Sint32 versionMinor);
 	~AI();
-	//void init(ImplementitionID ImplementitionID, Player *player);
+	//void init(ImplementationID ImplementationID, Player *player);
 
 	AIImplementation *aiImplementation;
-	ImplementitionID implementitionID;
+	ImplementationID implementationID;
 
 	Player *player;