replaced un-commented version with commented one

ExaltedDice/src/com/TwentyCode/android/ExaltedDice/ExaltedDice.java

@@ -9,6 +9,7 @@ import android.content.Context;
 import android.content.DialogInterface;
 import android.os.Bundle;
 import android.os.Vibrator;
+import android.util.Log;
 import android.view.Menu;
 import android.view.MenuItem;
 import android.view.View;
@@ -24,41 +25,114 @@ import android.widget.AdapterView.OnItemClickListener;
 
 public class ExaltedDice extends Activity implements OnClickListener, OnLongClickListener, OnItemClickListener {
 
+	// view variables
 	private TextView dice;
 	private ListView listview;
 
+	// exalted dice variables
 	private int intSuccesses;
 	public int intDice;
 
 	private ArrayList<String> rollHistory = new ArrayList<String>();
 	private ArrayList<Integer> rolled = new ArrayList<Integer>();
 
+	/**
+	 * tag for LogCat
+	 */
+	private static final String tag = "ExaltedDice";
+
+	/**
+	 * set view id's
+	 */
 	private final int ADD_DICE = R.id.up;
 	private final int SUB_DICE = R.id.down;
 	private final int ROLL_DICE = R.id.roll;
 
+	/**
+	 * menu options
+	 */
 	private static final int MENU_QUIT = Menu.FIRST;
 	private static final int MENU_CLEAR = Menu.FIRST + 1;
 
 	protected PostMortemReportExceptionHandler mDamageReport = new PostMortemReportExceptionHandler(this);
-
+	
+	/**
+	 * adds one dice
+	 * 
+	 * @author ricky barrette 3-27-2010
+	 */
 	public void addDiceRolled() {
+		Log.i(tag, " addDiceRolled()");
+
+		// vibrate for 50 milliseconds
 		vibrate(50);
+
+		/**
+		 * get string from dice textfield it convert it into int, while checking
+		 * for user input errors
+		 */
 		intDice = checkForErrors((dice.getText()).toString());
+
+		// add 1 dice
 		intDice = moreDice(intDice, 1);
+
+		// set Dice textfield to finDice
 		dice.setText("" + intDice);
 		System.gc();
 	}
 
+	/**
+	 * add 10 dice 3-27-2010
+	 * 
+	 * @author ricky barrette
+	 */
 	public void addDiceRolledonLongClick() {
+		Log.i(tag, "addDiceRolledonLongClick()");
+
+		// vibrate for 75 milliseconds
 		vibrate(75);
+
+		/**
+		 * get string from dice textfield it convert it into int, while checking
+		 * for user input errors
+		 */
 		intDice = checkForErrors((dice.getText()).toString());
+
+		// add 10 dice
 		intDice = moreDice(intDice, 10);
+
+		// set Dice textfield to finDice
 		dice.setText("" + intDice);
 		System.gc();
 	}
 
+	
+	/**
+	 * checks for the following errors:
+	 * 
+	 * checks string if it is blank, if so changes string to "1"
+	 * 
+	 * look at each char in string individually to see if int or not if the char
+	 * is an in add it to stringDice, example: a string of "1.2-3" would result
+	 * in a stringDice of "123"
+	 * 
+	 * also if there are any zeros preceding an int, they will be removed
+	 * example: a string of "000102" would result in a stringDice of "102"
+	 * 
+	 * if there are any typos removed, use toast to inform the user that we
+	 * assumed that when they typed "0001.2-3" they meant to type "123"
+	 * 
+	 * limits stringDice to 3 chars (limiting the number of dice to 999) if
+	 * stringDice is longer than 3 chars, it is changed to "1" also toast is
+	 * displayed to inform user of the 999 dice rule.
+	 * 
+	 * @param String
+	 *            string
+	 * @return int numDice
+	 * @author ricky barrette
+	 */
 	public int checkForErrors(String string) {
+		Log.i(tag, "checkForErrors()");
 
 		int numDice = 0;
 		char charDice;
@@ -67,17 +141,43 @@ public class ExaltedDice extends Activity implements OnClickListener, OnLongClic
 		boolean zeroCheck = true;
 		boolean isNumber = false;
 
+		/**
+		 * if textField is left blank, change value to 1
+		 */
 		if (string.length() == 0)
 			string += "" + 1;
 
+		/**
+		 * look at each char in string individually to see if int or not if the
+		 * char is an in add it to stringDice, example: a string of "1.2-3"
+		 * would result in a stringDice of "123"
+		 * 
+		 * also if there are any zeros preceding an int, they also will be
+		 * removed example: a string of "00-01.02" would result in a stringDice
+		 * of "102"
+		 */
 		for (int i = 0; i < string.length(); i++) {
 			// get the char
 			charDice = string.charAt(i);
 
+			/**
+			 * try to parse the char, to see it it is an int or not.
+			 */
 			try {
 
+				/**
+				 * we are going to borrow numDice instead of creating another
+				 * addressing space
+				 */
+
 				numDice = Integer.parseInt(Character.toString(charDice));
 
+				// -------------------------------------------------------------------------------------
+
+				/**
+				 * zero check to remove any zeros preceding an int value. true =
+				 * zero check on, false = zero check off
+				 */
 				if (zeroCheck == true) {
 					if (numDice != 0) {
 						zeroCheck = false;
@@ -93,26 +193,42 @@ public class ExaltedDice extends Activity implements OnClickListener, OnLongClic
 
 		}
 
-
+		/**
+		 * notify user if there were no ints
+		 */
 		if (isNumber == false) {
 			toastLong("You inputed: \" "
 					+ string
 					+ " \", which contains no numbers, we will roll one dice for you.");
 			stringDice.append(1);
-
+			/**
+			 * prevent error message from displaying
+			 */
 			errors = false;
 		}
 
+		/**
+		 * notify user if there were typos
+		 */
 		if (errors == true)
 			toastLong("You inputed: \" " + string
 					+ " \", we are assuming you meant: "
 					+ stringDice.toString());
 
+		// -----------------------------------------------------------------------------------------
+
+		/**
+		 * limit number to 999
+		 */
+
 		if (stringDice.length() > 3) {
 
 			toastLong("Sorry, I can not roll " + stringDice
 					+ " dice. Try Rolling Between 1 - 999 dice.");
 
+			/**
+			 * set number of dice to 1
+			 */
 			numDice = 1;
 
 		} else
@@ -123,17 +239,36 @@ public class ExaltedDice extends Activity implements OnClickListener, OnLongClic
 		return numDice;
 	}
 
+	/**
+	 * clears the rollHistory List array and refreshes the listview
+	 * 
+	 * @author ricky barrette
+	 */
 	private void clearHistory() {
 		rollHistory.clear();
 		rolled.clear();
 		listview.setAdapter(new ArrayAdapter<String>(this, R.layout.list_row, rollHistory));
 	}
 
+	/**
+	 * Lower Dice Count By what ever lowerBy is, can't go lower than 1
+	 * 
+	 * @param int number
+	 * @return int number
+	 * @author ricky barrette
+	 */
 	public int lessDice(int number, int lowerBy) {
+		Log.i(tag, "lessDice()");
 
+		/**
+		 * make sure we are not going to go negative
+		 */
 		if (number <= lowerBy)
 			lowerBy = number - 1;
 
+		/**
+		 * cant roll less than 1 dice
+		 */
 		if (number > 1)
 			number = number - lowerBy;
 
@@ -141,10 +276,26 @@ public class ExaltedDice extends Activity implements OnClickListener, OnLongClic
 		return number;
 	}
 
+	/**
+	 * Raise Dice Count By what ever raiseBy is, can't go higher than 999
+	 * 
+	 * @param int number
+	 * @return int number
+	 * @author ricky barrette
+	 */
 	public int moreDice(int number, int raiseBy) {
+		Log.i(tag, "moreDice()");
+
+		/**
+		 * make sure we are not going to go higher than 999
+		 */
 		if (number > 989)
 			if (raiseBy > (number - 989))
 				raiseBy = 999 - number;
+
+		/**
+		 * Can not roll more than 999 dice
+		 */
 		if (number < 999)
 			number = number + raiseBy;
 
@@ -152,6 +303,12 @@ public class ExaltedDice extends Activity implements OnClickListener, OnLongClic
 		return number;
 	}
 
+	/**
+	 * also implemented OnClickListener
+	 * 
+	 * @author ricky barrette 3-27-2010
+	 * @author - WWPowers 3-26-2010
+	 */
 	@Override
 	public void onClick(View v) {
 
@@ -166,36 +323,85 @@ public class ExaltedDice extends Activity implements OnClickListener, OnLongClic
 		
 	}
 
+	/**
+	 * Called when the activity is first created. starts gui and sets up buttons
+	 * 
+	 * @author ricky barrette 3-27-2010
+	 */
 	@Override
 	public void onCreate(Bundle savedInstanceState) {
 		mDamageReport.run();
         Thread.setDefaultUncaughtExceptionHandler(mDamageReport);
+		
 		super.onCreate(savedInstanceState);
+		Log.i(tag, "onCreate()");
 		setContentView(R.layout.main);
+		
+		/**
+		 * TextViews
+		 */
 		dice = (TextView) findViewById(R.id.dice);
+
+		/**
+		 * ListViews
+		 */
 		listview = (ListView) findViewById(R.id.list);
+
+		/**
+		 * Buttons
+		 */
 		Button btAddDice = (Button) findViewById(R.id.up);
 		Button btSubtractDice = (Button) findViewById(R.id.down);
 		Button btRollDice = (Button) findViewById(R.id.roll);
+
+		/**
+		 * onClickListeners
+		 */
 		btAddDice.setOnClickListener(this);
 		btSubtractDice.setOnClickListener(this);
 		btRollDice.setOnClickListener(this);
 		listview.setOnItemClickListener(this);
+
+		/**
+		 * onLongClickListeners
+		 */
 		btAddDice.setOnLongClickListener(this);
 		btSubtractDice.setOnLongClickListener(this);
+
+		/**
+		 * shake Listener
+		 */
+//		ShakeListener mShaker = new ShakeListener(this);
+//		mShaker.setOnShakeListener(new ShakeListener.OnShakeListener() {
+//			public void onShake() {
+//				rollDice();
+//			}
+//		});
+
+		/**
+		 * display hello message
+		 */
 		listview.setAdapter(new ArrayAdapter<String>(this, R.layout.list_row, getResources().getStringArray(R.array.hello_msg)));
 		
 		System.gc();
 		
 	}
 
+	/**
+	 * creates a menu with a quit option
+	 * 
+	 * @author WWPowers 3-27-2010
+	 */
 	public boolean onCreateOptionsMenu(Menu menu) {
 		menu.add(1, MENU_CLEAR, 0, "Clear Roll History");
 		menu.add(1, MENU_QUIT, 0, "Quit");
 		return true;
 	}
 
-
+	/**
+	 * rolls same amount of dice as previous roll
+	 * @author ricky barrette
+	 */
 	@Override
 	public void onItemClick(AdapterView<?> arg0, View arg1, int arg2, long arg3) {
 		if(rolled.size() != 0){
@@ -204,6 +410,12 @@ public class ExaltedDice extends Activity implements OnClickListener, OnLongClic
 		}
 	}
 
+	/**
+	 * also implemented OnLongClickListener
+	 * 
+	 * @author ricky barrette 3-27-2010
+	 * @param v
+	 */
 	public boolean onLongClick(View v) {
 		if (v.getId() == ADD_DICE) {
 			addDiceRolledonLongClick();
@@ -217,6 +429,12 @@ public class ExaltedDice extends Activity implements OnClickListener, OnLongClic
 		return true;
 	}
 
+	/**
+	 * handles menu selection
+	 * 
+	 * @author WWPowers 3-27-2010
+	 * @author ricky barrette 3-27-2010
+	 */
 	public boolean onOptionsItemSelected(MenuItem item) {
 
 		switch (item.getItemId()) {
@@ -231,41 +449,79 @@ public class ExaltedDice extends Activity implements OnClickListener, OnLongClic
 
 	}
 
+	/**
+	 * pauses ShakeListener
+	 */
 	@Override
 	public void onPause() {
+		Log.i(tag, "onPause()");
 		super.onPause();
+//		ShakeListener mShaker = new ShakeListener(this);
+//		mShaker.pause();
 		System.gc();
 	}
 
+	/**
+	 * resorts application state after rotation
+	 * @author ricky barrette
+	 */
 	@Override
 	public void onRestoreInstanceState(Bundle savedInstanceState) {
 	  super.onRestoreInstanceState(savedInstanceState);
+	  // Restore UI state from the savedInstanceState.
+	  // This bundle has also been passed to onCreate.
 	  rollHistory = savedInstanceState.getStringArrayList("roll_history");
 	  dice.setText(savedInstanceState.getString("dice"));
 	  rolled = savedInstanceState.getIntegerArrayList("rolled");
 	  listview.setAdapter(new ArrayAdapter<String>(this, R.layout.list_row, rollHistory));
 	}
 
+	/**
+	 * resumes ShakeListener
+	 */
 	@Override
 	public void onResume() {
+		Log.i(tag, "onResume()");
 		super.onResume();
+//		ShakeListener mShaker = new ShakeListener(this);
+//		mShaker.resume();
 	}
 
+	/**
+	 * saves application state before rotatoin
+	 * @author ricky barrette
+	 */
 	@Override
 	public void onSaveInstanceState(Bundle savedInstanceState) {
+	  // Save UI state changes to the savedInstanceState.
+	  // This bundle will be passed to onCreate if the process is
+	  // killed and restarted.
 	  savedInstanceState.putStringArrayList("roll_history", rollHistory);
 	  savedInstanceState.putString("dice", dice.getText().toString());
 	  savedInstanceState.putIntegerArrayList("rolled", rolled);
 	  super.onSaveInstanceState(savedInstanceState);
 	}
 
-
+	/**
+	 * unregisters ShakeListener
+	 * 
+	 * @author ricky barrette 3-26-2010
+	 * @author WWPpwers 3-27-2010
+	 */
 	@Override
 	public void onStop() {
+		Log.i(tag, "onStop()");
 		super.onStop();
 		System.gc();
+//		ExaltedDice.this.finish();
 	}
 
+	/**
+	 * displays a quit dialog
+	 * 
+	 * @author ricky barrette 3-28-2010
+	 * @author WWPowers 3-27-2010
+	 */
 	public void quitDialog() {
 		AlertDialog.Builder builder = new AlertDialog.Builder(this);
 		builder.setMessage("Are you sure you want to quit?").setCancelable(
@@ -283,30 +539,75 @@ public class ExaltedDice extends Activity implements OnClickListener, OnLongClic
 		builder.show();
 	}
 
+	/**
+	 * returns a custom string containing dice rolls and number of successes
+	 * 
+	 * @param int times
+	 * @return String resultsString
+	 * @author ricky barrette
+	 */
 	public String results(int times) {
+		Log.i(tag, "results()");
 		StringBuffer resultsString = new StringBuffer();
 		resultsString.append("Rolled "+ times +" dice\n");
+
+		/**
+		 * roll the dice
+		 */
 		int[] roll = rollGen(times);
+
+		/**
+		 * add number of successes to resultsString
+		 */
 		resultsString.append("Successes: "+ successes(roll) +"\n");
+		
 		resultsString.append("Rolled: ");
+		/**
+		 * add rolled dice results to resultsString
+		 */
 		for (int i = 0; i < roll.length; i++) {
 			resultsString.append(roll[i] + ", ");
 		}
+
 		System.gc();
 		return resultsString.toString();
 	}
 
+	/**
+	 * Performs a dice roll
+	 * 
+	 * @author ricky barrette
+	 */
 	public void rollDice() {
+		// vibrate for 50 milliseconds
 		vibrate(50);
+
+		/**
+		 * get string from dice textfield it convert it into int, while checking
+		 * for user input errors
+		 */
 		intDice = checkForErrors((dice.getText()).toString());
+
+		// set Dice textfield to finDice
 		dice.setText("" + intDice);
+
 		rolled.add(0, intDice);
 		rollHistory.add(0, results(intDice));
+
 		listview.setAdapter(new ArrayAdapter<String>(this, R.layout.list_row, rollHistory));
+
 		System.gc();
 	}
 
+	/**
+	 * generates an array containing 10 sided dice rolls
+	 * 
+	 * @param int times
+	 * @return int[] roll
+	 * @author ricky barrette
+	 */
 	public int[] rollGen(int times) {
+		Log.i(tag, "rollGen()" + times);
 		int[] roll = new int[times];
 		Random random = new Random();
 		for (int i = 0; i < times; i++) {
@@ -316,25 +617,68 @@ public class ExaltedDice extends Activity implements OnClickListener, OnLongClic
 		return roll;
 	}
 
+	/**
+	 * subtracts one dice 3-27-2010
+	 * 
+	 * @author ricky barrette
+	 */
 	public void subtractDiceRolled() {
+		Log.i(tag, "subtractDice()");
+		;
+
+		// vibrate for 50 milliseconds
 		vibrate(50);
+
+		/**
+		 * get string from dice textfield it convert it into int, while checking
+		 * for user input errors
+		 */
 		intDice = checkForErrors((dice.getText()).toString());
+
+		// subtract 1 dice
 		intDice = lessDice(intDice, 1);
+
+		// set Dice textfield to finDice
 		dice.setText("" + intDice);
 		System.gc();
 	}
 
+	/**
+	 * subtracts 10 dice
+	 * 
+	 * @author ricky barrette
+	 */
 	public void subtractDiceRolledonLongClick() {
+		Log.i(tag, "subtractDiceonLongClick()");
+
+		// vibrate for 75 milliseconds
 		vibrate(75);
+
+		/**
+		 * get string from dice textfield it convert it into int, while checking
+		 * for user input errors
+		 */
 		intDice = checkForErrors((dice.getText()).toString());
+
+		// subtract 10 dice
 		intDice = lessDice(intDice, 10);
+
+		// set Dice textfield to finDice
 		dice.setText("" + intDice);
 		System.gc();
 
 	}
 
-
+	/**
+	 * counts each dice roll that is greater than or equal to 7 as a success. 10
+	 * gets another success (for a total of 2)
+	 * 
+	 * @param int[] roll
+	 * @return int successes
+	 * @author ricky barrette
+	 */
 	public int successes(int[] roll) {
+		Log.i(tag, "successes()");
 		intSuccesses = 0;
 		for (int i = 0; i < roll.length; i++) {
 			if (roll[i] >= 7)
@@ -346,15 +690,36 @@ public class ExaltedDice extends Activity implements OnClickListener, OnLongClic
 		return intSuccesses;
 	}
 
-
+	/**
+	 * displays toast message with a long duration
+	 * 
+	 * @param msg
+	 * @author ricky barrette 3-26-2010
+	 * @author WWPowers 3-26-2010
+	 */
 	public void toastLong(CharSequence msg) {
+		Log.i(tag, "toastLong()");
 		Toast toast = Toast.makeText(this, msg, Toast.LENGTH_LONG);
 		toast.show();
 	}
 
-
+	/**
+	 * starts Vibrator service and then vibrates for x milliseconds
+	 * 
+	 * @param Long
+	 *            milliseconds
+	 * @author ricky barrette
+	 */
 	public void vibrate(long milliseconds) {
+		Log.i(tag, "vibrate() for " + milliseconds);
+		/**
+		 * start vibrator service
+		 */
 		Vibrator vib = (Vibrator) getSystemService(Context.VIBRATOR_SERVICE);
+
+		/**
+		 * Vibrate for x milliseconds
+		 */
 		vib.vibrate(milliseconds);
 	}
 

ExaltedDice/src/com/TwentyCode/android/ExaltedDice/ShakeListener.java

@@ -0,0 +1,98 @@
+package com.TwentyCode.android.ExaltedDice;
+
+/* The following code was written by Matthew Wiggins
+ * and is released under the APACHE 2.0 license
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ */
+
+import android.hardware.SensorListener;
+import android.hardware.SensorManager;
+import android.content.Context;
+import java.lang.UnsupportedOperationException;
+
+@SuppressWarnings("deprecation")
+public class ShakeListener implements SensorListener 
+{
+  private static final int FORCE_THRESHOLD = 350;
+  private static final int TIME_THRESHOLD = 100;
+  private static final int SHAKE_TIMEOUT = 500;
+  private static final int SHAKE_DURATION = 1000;
+  private static final int SHAKE_COUNT = 3;
+
+  private SensorManager mSensorMgr;
+  private float mLastX=-1.0f, mLastY=-1.0f, mLastZ=-1.0f;
+  private long mLastTime;
+  private OnShakeListener mShakeListener;
+  private Context mContext;
+  private int mShakeCount = 0;
+  private long mLastShake;
+  private long mLastForce;
+
+  public interface OnShakeListener
+  {
+    public void onShake();
+  }
+
+  public ShakeListener(Context context) 
+  { 
+    mContext = context;
+    resume();
+  }
+
+  public void setOnShakeListener(OnShakeListener listener)
+  {
+    mShakeListener = listener;
+  }
+
+  public void resume() {
+    mSensorMgr = (SensorManager)mContext.getSystemService(Context.SENSOR_SERVICE);
+    if (mSensorMgr == null) {
+      throw new UnsupportedOperationException("Sensors not supported");
+    }
+    boolean supported = mSensorMgr.registerListener(this, SensorManager.SENSOR_ACCELEROMETER, SensorManager.SENSOR_DELAY_GAME);
+    if (!supported) {
+      mSensorMgr.unregisterListener(this, SensorManager.SENSOR_ACCELEROMETER);
+      throw new UnsupportedOperationException("Accelerometer not supported");
+    }
+  }
+
+  public void pause() {
+    if (mSensorMgr != null) {
+      mSensorMgr.unregisterListener(this, SensorManager.SENSOR_ACCELEROMETER);
+      mSensorMgr = null;
+    }
+  }
+
+  public void onAccuracyChanged(int sensor, int accuracy) { }
+
+  public void onSensorChanged(int sensor, float[] values) 
+  {
+    if (sensor != SensorManager.SENSOR_ACCELEROMETER) return;
+    long now = System.currentTimeMillis();
+
+    if ((now - mLastForce) > SHAKE_TIMEOUT) {
+      mShakeCount = 0;
+    }
+
+    if ((now - mLastTime) > TIME_THRESHOLD) {
+      long diff = now - mLastTime;
+      float speed = Math.abs(values[SensorManager.DATA_X] + values[SensorManager.DATA_Y] + values[SensorManager.DATA_Z] - mLastX - mLastY - mLastZ) / diff * 10000;
+      if (speed > FORCE_THRESHOLD) {
+        if ((++mShakeCount >= SHAKE_COUNT) && (now - mLastShake > SHAKE_DURATION)) {
+          mLastShake = now;
+          mShakeCount = 0;
+          if (mShakeListener != null) { 
+            mShakeListener.onShake(); 
+          }
+        }
+        mLastForce = now;
+      }
+      mLastTime = now;
+      mLastX = values[SensorManager.DATA_X];
+      mLastY = values[SensorManager.DATA_Y];
+      mLastZ = values[SensorManager.DATA_Z];
+    }
+  }
+
+}