[gbrainy] Makes Game class more easy to follow

[Jordi Mas <jmas src gnome org>]

commit 3bb5a1de9c8d218fcb917f32b70e0a74ccfbe9a5
Author: Jordi Mas <jmas softcatala org>
Date:   Tue May 25 21:04:14 2010 +0200

    Makes Game class more easy to follow

 src/Core/Main/Game.cs |  163 ++++++++++++++++++++++++-------------------------
 1 files changed, 80 insertions(+), 83 deletions(-)
---
diff --git a/src/Core/Main/Game.cs b/src/Core/Main/Game.cs
index f68418b..beda11d 100644
--- a/src/Core/Main/Game.cs
+++ b/src/Core/Main/Game.cs
@@ -32,6 +32,7 @@ namespace gbrainy.Core.Main
 {
 	abstract public class Game : IDrawable, IDrawRequest, IMouseEvent
 	{
+		[Flags]
 		public enum Difficulty
 		{
 			None			= 0,
@@ -87,23 +88,10 @@ namespace gbrainy.Core.Main
 			containers = new List <Toolkit.Container> ();
 		}
 
-		// Used by games to request a redraw of the view
-		protected void OnDrawRequest ()
-		{
-			if (DrawRequest == null)
-				return;
-
-			DrawRequest (this, EventArgs.Empty);
-		}
-
-		// Used by games to request a question repaint
-		protected void UpdateQuestion (string question)
-		{
-			if (UpdateUIElement == null)
-				return;
+#region Methods to override in your own games
 
-			UpdateUIElement (this, new UpdateUIStateEventArgs (UpdateUIStateEventArgs.EventUIType.QuestionText, 
-				question));
+		public abstract string Name {
+			get;
 		}
 
 		// The question text shown to the user
@@ -111,23 +99,32 @@ namespace gbrainy.Core.Main
 			get;
 		}
 
-		// Builds a text answer for the puzzle
-		public virtual string Answer {
-			get {
-				string str;
-		
-				str = String.Format (Catalog.GetString ("The correct answer is {0}."), AnswerValue);
+		// Text that explains why the right answer is valid
+		public virtual string Rationale {
+			get { return string.Empty; }
+		}
 
-				if (String.IsNullOrEmpty (Rationale))
-					return str;
+		public virtual string Tip {
+			get { return string.Empty;}
+		}
 
-				return str += " " + Rationale;				
-			}
+		public abstract void Initialize ();
+#endregion
+
+#region Methods that you can optionally override
+
+		// Default GameType
+		public virtual GameTypes Type {
+			get { return GameTypes.LogicPuzzle;}
 		}
 
-		// Text that explains why the right answer is valid
-		public virtual string Rationale {
-			get { return string.Empty; }
+		// How to check the answer
+		public virtual AnswerCheckAttributes CheckAttributes {
+			get { return AnswerCheckAttributes.Trim | AnswerCheckAttributes.IgnoreCase; }
+		}
+
+		public virtual string AnswerCheckExpression {
+			get { return ".+"; }
 		}
 
 		// Right answer as shown to the user. Usually equals to right_answer, can be different
@@ -136,52 +133,50 @@ namespace gbrainy.Core.Main
 			get { return right_answer; }
 		}
 
-		public ISynchronizeInvoke SynchronizingObject { 
-			set { 
-				synchronize = value;
-			}
-			get { return synchronize; }
+		// Indicates in which difficulty levels the game should be shown
+		public virtual Difficulty GameDifficulty {
+			get { return Difficulty.Master | Difficulty.Medium | Difficulty.Easy; }
 		}
 
-		public bool IsPreviewMode {
-			get {return preview; }
-			set {preview = value; }
+		// Indicates if the game should be excluded for color blind users
+		public virtual bool UsesColors {
+			get { return false;}
 		}
-
-		// Stores how difficult the game is
-		public virtual Difficulty GameDifficulty {
+#endregion
+		// Builds a text answer for the puzzle
+		public virtual string Answer {
 			get {
-				return Difficulty.Master | Difficulty.Medium | Difficulty.Easy;
-			}
-		}
+				string str;
 
-		// The level of difficulty selected for the current game
-		public virtual Difficulty CurrentDifficulty {
-			set {
-				difficulty = value;
-			}
-			get {
-				return difficulty;
+				str = String.Format (Catalog.GetString ("The correct answer is {0}."), AnswerValue);
+
+				if (String.IsNullOrEmpty (Rationale))
+					return str;
+
+				return str += " " + Rationale;
 			}
 		}
 
-		// How to check the answer
-		public virtual AnswerCheckAttributes CheckAttributes {
-			get { return AnswerCheckAttributes.Trim | AnswerCheckAttributes.IgnoreCase; }
+		public ISynchronizeInvoke SynchronizingObject {
+			set { synchronize = value; }
+			get { return synchronize; }
 		}
 
-		public virtual string AnswerCheckExpression {
-			get { return ".+"; }
+		public bool IsPreviewMode {
+			get {return preview; }
+			set {preview = value; }
 		}
 
-		public abstract string Name {
-			get;
+		// The level of difficulty selected for the current game
+		public Difficulty CurrentDifficulty {
+			set { difficulty = value; }
+			get { return difficulty; }
 		}
 
 		public string TipString {
-			get { 
+			get {
 				string tip = Tip;
-	
+
 				if (tip != string.Empty)
 					tip_used = true;
 
@@ -189,18 +184,10 @@ namespace gbrainy.Core.Main
 			}
 		}
 
-		public virtual string Tip {
-			get { return string.Empty;}
-		}
-	
 		public virtual bool ButtonsActive {
 			get { return true;}
 		}
 
-		public virtual GameTypes Type {
-			get { return GameTypes.LogicPuzzle;}
-		}
-
 		public bool DrawAnswer {
 			get { return draw_answer; }
 			set { draw_answer = value; }
@@ -211,10 +198,6 @@ namespace gbrainy.Core.Main
 			get { return true;}
 		}
 
-		public virtual bool UsesColors {
-			get { return false;}
-		}
-
 		public virtual double DrawAreaX {
 			get {return 0.1;}
 		}
@@ -246,18 +229,33 @@ namespace gbrainy.Core.Main
 
 		// Expected time in seconds that a player is expected to complete this game
 		public int ExpectedTime {
-			get { 
-				return Main.Score.GameExpectedTime (Type, CurrentDifficulty); 
-			}
+			get { return Main.Score.GameExpectedTime (Type, CurrentDifficulty); }
 		}
 
 		protected Widget [] Widgets {
 			get { return containers.ToArray (); }
 		}
 
-		//
+		// Used by games to request a redraw of the view
+		protected void OnDrawRequest ()
+		{
+			if (DrawRequest == null)
+				return;
+
+			DrawRequest (this, EventArgs.Empty);
+		}
+
+		// Used by games to request a question repaint
+		protected void UpdateQuestion (string question)
+		{
+			if (UpdateUIElement == null)
+				return;
+
+			UpdateUIElement (this, new UpdateUIStateEventArgs (UpdateUIStateEventArgs.EventUIType.QuestionText,
+				question));
+		}
+
 		// Score algorithm returns a value between 0 and 10
-		//
 		public virtual int Score (string answer)
 		{
 			return Main.Score.GameScore (CheckAnswer (answer), GameTime.TotalSeconds, ExpectedTime, tip_used);
@@ -291,8 +289,7 @@ namespace gbrainy.Core.Main
 
 			containers.Add (container);
 		}
-	
-		public abstract void Initialize ();
+
 		public virtual void Finish () {}
 
 		protected string GetPossibleAnswersExpression ()
@@ -313,7 +310,7 @@ namespace gbrainy.Core.Main
 				// The following series of answers may need to be adapted
 				// in cultures with alphabets different to the Latin one.
 				// The idea is to enumerate a sequence of possible answers
-				// For languages represented with the Latin alphabet use 
+				// For languages represented with the Latin alphabet use
 				// the same than English
 			case 0: // First possible answer for a series (e.g.: Figure A)
 				return Catalog.GetString ("A");
@@ -346,7 +343,7 @@ namespace gbrainy.Core.Main
 			gr.Scale (width, height);
 			gr.DrawBackground ();
 			gr.Color = default_color;
-			gr.LineWidth = LineWidth;		
+			gr.LineWidth = LineWidth;
 		}
 
 		public virtual void Draw (CairoContextEx gr, int width, int height, bool rtl)
@@ -413,7 +410,7 @@ namespace gbrainy.Core.Main
 								break;
 							}
 						}
-					} 
+					}
 					else //MatchAllInOrder
 					{
 						if (String.Compare (match.Value, right_answers[pos++], ignore_case) != 0)
@@ -435,7 +432,7 @@ namespace gbrainy.Core.Main
 
 				return true;
 			}
-			else // Any string from the list of possible answers (answer1 | answer2) present in the answer will do it 
+			else // Any string from the list of possible answers (answer1 | answer2) present in the answer will do it
 			{
 				foreach (string s in right_answers)
 				{
@@ -460,7 +457,7 @@ namespace gbrainy.Core.Main
 
 		public void DisableMouseEvents ()
 		{
-			foreach (Toolkit.Container container in containers) 
+			foreach (Toolkit.Container container in containers)
 				foreach (Widget widget in container.Children)
 					widget.Sensitive = false;
 		}