/**
 * 11/12/02 - MusicHangman1
 *
 * This class lets the user interact with a GUI to choose:
 * a) the basic 'flavour' (subject area) for the hangman game
 * b) which fields are to be guessed (and perhaps clued) within that flavour
 * c) the number of guesses allowed before hanging occurs
 *
 * Having resolved previous problems, this version is now ready to pull together
 * several custom classes in an all-embracing music hangman game.
 *
 * I've added audio files that play kill or reprieve music at the end of each game!
 */

 import java.awt.*;
 import java.awt.event.*;
 import java.applet.*;
 import HangmanData;
 import HangmanFlavours;
 import QwertyPanel;
 import ScaffoldCanvas;

 public class MusicHangman1 extends Applet implements ActionListener, ItemListener, AdjustmentListener
 {
 	//declare variables to do with overall layout structure
 	TextField peek = new TextField("peek",25);	//used in debugging only***************
 	CardLayout cards = new CardLayout(5,5);
 	Panel pnlDeck = new Panel(cards);
 	Panel pnlCard1, pnlCard2, pnlCard3;

 	//universal font variables
 	Font fntTitle = new Font("SansSerif", Font.BOLD, 20);
 	Font fntUserCue = new Font("SansSerif", Font.ITALIC, 16);
 	Font fntChoice = new Font("SansSerif", Font.PLAIN, 16);

 	//for card1 -choosing the flavour
 	Label lblTitle1, lblUserCue1;
 	Choice choFlavour;
 	Button btnFlavourChosen;
 	Panel pnlCenter1;

 	//for card2 -selecting guess and clue fields and number of guesses (lives) allowed
 	Label lblTitle2, lblUserCue2, lblGuesses;
 	Label[] lblField;
 	TextField tfGuesses;
 	Scrollbar sbGuesses;
	HangmanData data;
	Checkbox cbWantClue;
	Checkbox[] cbGuess, cbClue;
	CheckboxGroup cbgGuess, cbgClue;
	Panel pnlNorth2, pnlSouth2, pnlCenter2;
	Button btnFieldsChosen, btnBackTo1;
	int intSelectedGuess, intSelectedClue, intMaxGuesses;

	//for card 3 -playing the hangman game
	QwertyPanel qpKeys;
	ScaffoldCanvas scaffold;
	Label lblTitle3, lblUserCue3;
	TextField tfWordToGuess;
	Panel pnlLeft3Upper;

	String	strWordToFind,		//the word itself
			strWordSoFar;		//as displayed to user (recalc after every button press)
	String[] strSingleLetters;	//array of individual letters for checking
	boolean[] booCharFound;		//flag array indicating which chars have already been found
	AudioClip acKill, acReprieve, acThought;	//midi files

	/**
	 *Entry point of Applet
	 */
 	public void init()
 	{
 		this.setLayout(null); //use null layout for applet so that elements can be positioned
 		pnlDeck.setSize(450,300);
 		pnlDeck.setBackground(new Color(192,255,192));
 		this.add(pnlDeck);
 		this.setBackground(Color.blue);
 		this.setSize(450,300);
 		setCard1();

		acKill=getAudioClip(getDocumentBase(),"kill.MID");
 		acReprieve=getAudioClip(getDocumentBase(),"reprieve.MID");
 		acThought=getAudioClip(getDocumentBase(),"thought2.MID");
 	}

/////// CARD 1 ////////////////
 	private void setCard1()
 	{
 		//construct text elements
 		lblTitle1 = new Label("Music Hangman");
 		lblTitle1.setFont(fntTitle);
 		lblUserCue1 = new Label("Choose a subject:");
 		lblUserCue1.setFont(fntUserCue);
 		//construct drop-down for selection of flavour
 		choFlavour = new Choice();
 		choFlavour.setFont(fntChoice);
 		for (int i=0;i<HangmanFlavours.getNumFlavours();i++)
		{
			choFlavour.addItem(HangmanFlavours.getFlavourName(i));
		}
		//construct buttons
		btnFlavourChosen = new Button("Continue");
		btnFlavourChosen.addActionListener(this);

		//build card1
 		pnlCenter1 = new Panel();
 		pnlCenter1.add(lblUserCue1);
 		pnlCenter1.add(choFlavour);
 		pnlCenter1.add(btnFlavourChosen);

 		pnlCard1 = new Panel(new BorderLayout());
 		pnlCard1.add("North",lblTitle1);
		pnlCard1.add("Center",pnlCenter1);

		//add card to deck and show card
		pnlDeck.add("card1", pnlCard1);
 		cards.show(pnlDeck, "card1");
 	}

//////// CARD 2 ////////////////////
 	private void setCard2(int FLAVOUR)
 	{
		//construct north panel elements
		lblTitle2=new Label(lblTitle1.getText()+" - "+HangmanFlavours.getFlavourName(FLAVOUR));
		lblTitle2.setFont(fntTitle);
		lblUserCue2=new Label("Choose what to guess, clue, and number of guesses");
		lblUserCue2.setFont(fntUserCue);
		cbWantClue = new Checkbox("offer clue", true);
		cbWantClue.addItemListener(this);

		pnlNorth2 = new Panel(new GridLayout(3,1));
		pnlNorth2.add(lblTitle2);
		pnlNorth2.add(lblUserCue2);
		pnlNorth2.add(cbWantClue);

		//construct center panel elements
		data = new HangmanData(FLAVOUR);
		cbGuess = new Checkbox [data.getNumFields()];
		cbgGuess = new CheckboxGroup();
		cbClue = new Checkbox [data.getNumFields()];
		cbgClue = new CheckboxGroup();
		lblField = new Label [data.getNumFields()];

		//set up pnlCenter2
		pnlCenter2 = new Panel(new GridLayout(data.getNumFields(),3)); //for internal grid layout
		for (int i=0;i<data.getNumFields();i++)
		{
			lblField[i]=new Label(data.getFieldName(i).toUpperCase());
			pnlCenter2.add(lblField[i]);

			cbGuess[i]=new Checkbox("guess",cbgGuess,false);
			cbGuess[i].addItemListener(this);
			pnlCenter2.add(cbGuess[i]);

			cbClue[i]=new Checkbox("clue",cbgClue,false);
			cbClue[i].addItemListener(this);
			pnlCenter2.add(cbClue[i]);

			//consider guessable / clueable status
			if (HangmanFlavours.isGuessable(FLAVOUR, i)==false)
			{
				cbGuess[i].setEnabled(false);
				cbGuess[i].setLabel("n/a");
			}
			if (HangmanFlavours.isClueable(FLAVOUR, i)==false)
			{
				cbClue[i].setEnabled(false);
				cbClue[i].setLabel("n/a");
			}
		}

		//initially set first field as selected guess
		intSelectedGuess=0;
		//but in case that's not guessable...
		while (HangmanFlavours.isGuessable(FLAVOUR,intSelectedGuess)==false)
			{ intSelectedGuess++; }
		//check the 'selected guess'
		cbGuess[intSelectedGuess].setState(true);
		//and disable that field from being a clue
		cbClue[intSelectedGuess].setEnabled(false);

		intSelectedClue=-1;	//default, as no clue is pre-selected

		//build south panel (about guesses allowed & buttons)
		pnlSouth2 = new Panel();
		pnlSouth2.setLayout(null);

		btnBackTo1 = new Button("Go back");
		btnBackTo1.addActionListener(this);
		btnBackTo1.setSize(80,25);
		btnBackTo1.setLocation(10,30);

		lblGuesses = new Label("Guesses:");
		lblGuesses.setSize(60,20);
		lblGuesses.setLocation(60,5);

		intMaxGuesses=10;
		sbGuesses = new Scrollbar(Scrollbar.HORIZONTAL, intMaxGuesses, 1, 1, intMaxGuesses+1);
		sbGuesses.setSize(200,20);
		sbGuesses.setLocation(120,5);
		sbGuesses.addAdjustmentListener(this);
		sbGuesses.setBackground(Color.white);

		tfGuesses = new TextField(""+intMaxGuesses);
		tfGuesses.setSize(30,20);
		tfGuesses.setBackground(Color.white);
		tfGuesses.setLocation(320,5);
		tfGuesses.setEditable(false);

		btnFieldsChosen = new Button("Continue");
		btnFieldsChosen.addActionListener(this);
		btnFieldsChosen.setSize(80,25);
		btnFieldsChosen.setLocation(300,30);

		pnlSouth2.setSize(300,60);//this is important if null layout used!!!!!!
		pnlSouth2.add(btnBackTo1);
		pnlSouth2.add(lblGuesses);
		pnlSouth2.add(sbGuesses);
		pnlSouth2.add(tfGuesses);
		pnlSouth2.add(btnFieldsChosen);

		//add all to pnlCard2
		pnlCard2=new Panel(new BorderLayout());
		pnlCard2.add("North", pnlNorth2);
		pnlCard2.add("Center", pnlCenter2);
		pnlCard2.add("South", pnlSouth2);

		//add card2 to deck and show it
		pnlDeck.add("card2", pnlCard2);
		validate();
 		cards.show(pnlDeck, "card2");
	}


/////// EVENT STUFF ////////////////////////

 	public void actionPerformed(ActionEvent ae)
 	{
 		if ( ae.getSource().equals(btnFlavourChosen) )	//go on to card 2
 		{
// 			peek.setText(""+choFlavour.getSelectedIndex());	//************
 			setCard2(choFlavour.getSelectedIndex());
 		}

 		else if ( ae.getSource().equals(btnBackTo1) )	//go back to card 1
 		{
 			cards.show(pnlDeck, "card1");
 		}

 		else if ( ae.getSource().equals(btnFieldsChosen) )	//ready to go on to hangman game
 		{
 			intSelectedClue=getClueIndex();
 			intSelectedGuess=getGuessIndex();
//			peek.setText("guess = "+intSelectedGuess+"; clue = "+intSelectedClue+"; lives = "+intMaxGuesses);
 			//go on to play Hangman game
 			playTheGame();
 		}

 		else	//in all other cases it must be a QwertyPanel click while game in progress
 		{
 			String clicked=ae.getActionCommand();
 			if (clicked.length()==1)	//single letter
 			{
 				//check whether in word
 				boolean found=false;
 				for (int i=0;i<strWordToFind.length();i++)
 				{	//set char found flag if in word
 					if (strSingleLetters[i].equals(clicked)) {booCharFound[i]=true;found=true;}
 				}
 				//update word display if found
 				if (found) { showWordSoFar(); }
 				//otherwise dec lives remaining
 				else { scaffold.decLivesRemaining(); }
 				//disable letter button so it can't be clicked again
 				qpKeys.setKeyEnabled(clicked,false);
 				//test for end of game situations
 				if (scaffold.getLivesRemaining()==0)	//game lost
 				{
 					scaffold.setLivesRemaining(scaffold.KILL);
 					qpShowAnsOnly();
 					acThought.stop();
 					acKill.play();
 				}
 				else if (wordIsFound())	//game won
 				{
 					scaffold.setLivesRemaining(scaffold.REPRIEVE);
 					qpShowResetOnly();
 					acThought.stop();
 					acReprieve.play();
 				}
 			}

 			else if (clicked.equals("answer"))
 			{
 				//only play music if suicide (i.e. not played before)
 				if (scaffold.getLivesRemaining()>0) { acThought.stop(); acKill.play(); }
 				//show full word
 				for (int i=0;i<strWordToFind.length();i++) { booCharFound[i]=true; }
 				showWordSoFar();
 				//hang
 				scaffold.setLivesRemaining(scaffold.KILL);
 				//set keys
 				qpShowResetOnly();
 			}

 			else if (clicked.equals("reset"))
 			{
 				//set keys
 				qpShowKeysForGuessing();
 				//reset for new word
 				scaffold.setLivesRemaining(intMaxGuesses);
 				newRandomWord();
 			}
 		}
 	}

 	public void itemStateChanged(ItemEvent ie)
 	{
 		if (ie.getItem().equals("offer clue"))
 		{
 			boolean state = (ie.getStateChange()==ie.SELECTED);
			for (int i=0; i<data.getNumFields(); i++)
			{	//set visibility of entire clue column according to selected state
				cbClue[i].setVisible(state);
			}
			if (state==false) {cbgClue.setSelectedCheckbox(null);}
 		}

 		else if (ie.getItem().equals("guess"))
 		{
 			// must be one of the guess checkboxes
 			intSelectedGuess=getGuessIndex();
 			//nudge equivalent clue if nec
			if (intSelectedGuess==getClueIndex())
			{//if not guessable, clue label would be 'n/a'
				int start=getClueIndex();
				int test=(start+1)%data.getNumFields();
				while ( (cbClue[test].getLabel().equals("n/a")==true) && (test!=start) )
				{
					test=(test+1)%data.getNumFields();
				}
				if (test!=start)
				{
					cbClue[test].setState(true);
				}
				else intSelectedClue=-1;
			}
			//and then disable equivalent clue (plus any others not clueable)
			for (int i=0;i<data.getNumFields();i++)
			{
				cbClue[i].setEnabled((i!=intSelectedGuess)&&(cbClue[i].getLabel().equals("n/a")!=true));
			}
		}

		//new clue radio-button selected
		else if (ie.getItem().equals("clue"))
		{
			//nothing particular to do here - just let clue button get selected
		}
 	}

	/*
	 *returns index of selected guess
	 */
 	private int getGuessIndex()
 	{
 		int sel = -1;
		for (int i=0;i<data.getNumFields();i++) { if (cbGuess[i].getState()==true) sel= i; }
		return sel;
 	}

	/*
	 *returns index of selected clue
	 */
 	private int getClueIndex()
 	{
 		int sel = -1;
		for (int i=0;i<data.getNumFields();i++) { if (cbClue[i].getState()==true) sel= i; }
		return sel;
 	}

	/*
	 *detects changes to no of guesses scrollbar
	 */
 	public void adjustmentValueChanged(AdjustmentEvent ae)
 	{
 		intMaxGuesses=ae.getValue();
		tfGuesses.setText(""+intMaxGuesses);
 	}

 	////////\\\\\\\\\\\\\\\///////////////\\\\\\\\\\\\\\\///////////////\\\\\\\\\\\\

 	private void playTheGame()
 	{
 		//construct gui elements for card 3
 		qpKeys=new QwertyPanel(QwertyPanel.ALPHA_LAYOUT);
 		qpKeys.addActionListener(this);
 		qpKeys.setFkey(1,"");
 		qpKeys.setFkey(2,"");
 		qpKeys.setFkey(3,"reset");
 		qpKeys.setFkey(4,"answer");
 		qpShowKeysForGuessing();

 		lblTitle3=lblTitle2;
 		tfWordToGuess = new TextField(60);
 		tfWordToGuess.setEditable(false);
 		tfWordToGuess.setBackground(Color.white);
 		lblUserCue3 = new Label();

		pnlLeft3Upper=new Panel();
 		pnlLeft3Upper.add(lblTitle3);
 		pnlLeft3Upper.add(tfWordToGuess);
 		pnlLeft3Upper.add(lblUserCue3);

 		pnlCard3=new Panel();
 		pnlCard3.setLayout(null);
 		pnlCard3.add(pnlLeft3Upper);
 		pnlLeft3Upper.setSize(450,100);
 		pnlLeft3Upper.setLocation(0,0);

 		pnlCard3.add(qpKeys);
 		qpKeys.setSize(340,185);
 		qpKeys.setLocation(0,100);

 		scaffold=new ScaffoldCanvas(11);
 		pnlCard3.add(scaffold);
 		scaffold.setLocation(345,105);
 		scaffold.setLivesRemaining(intMaxGuesses);

		//add new card to deck and display it
 		pnlDeck.add("card3", pnlCard3);
 		cards.show(pnlDeck, "card3");

		//dimension working arrays
		strSingleLetters = new String[data.getMaxLength()];
		booCharFound = new boolean[data.getMaxLength()];

 		//generate random word-to-find
 		newRandomWord();
 	}

	/**
	 *shows word as guessed so far (incl cosmetic spacing)
	 */
	private void showWordSoFar()
	{
		strWordSoFar="";
		for (int i=0;i<strWordToFind.length();i++)
		{
			strWordSoFar+= (booCharFound[i]) ? strSingleLetters[i]+" " : "_ ";
		}
		tfWordToGuess.setText(strWordSoFar);
	}

	/**
	 *tests whether word has been completely found
	 */
	private boolean wordIsFound()
	{
		boolean found=true;
		for (int i=0;i<strWordToFind.length();i++)
		{
			if (booCharFound[i]==false) {found=false;}
		}
		return found;
	}

	//three sets of enabled QwertyPanel keys follow:
	private void qpShowResetOnly()
	{
		qpKeys.disableAllKeys();
		qpKeys.setKeyEnabled("reset",true);
	}

	private void qpShowAnsOnly()
	{
		qpKeys.disableAllKeys();
		qpKeys.setKeyEnabled("answer",true);
	}

	private void qpShowKeysForGuessing()
	{
		qpKeys.enableAllKeys();
		qpKeys.setKeyEnabled("Space",false);
 		qpKeys.setKeyEnabled("<<<",false);
 		qpKeys.setKeyEnabled("-",false);
 		qpKeys.setKeyEnabled(".",false);
 		qpKeys.setKeyEnabled("Enter",false);
 		qpKeys.setKeyEnabled("reset",false);
 	}

	/*
	 *generates a new random word to guess and sets up necessary variables accordingly
	 */
 	private void newRandomWord()
 	{
 		//generate random word-to-find
		int randIndex=(int)(Math.random()*data.getNumRecords());
		strWordToFind=data.getData(randIndex,intSelectedGuess).toUpperCase();
		//replace spaces with /
		strWordToFind=strWordToFind.replace(' ', '/');
		//initialise single letters and set found flags to false unless / or -
		for (int i=0;i<strWordToFind.length();i++)
		{
			strSingleLetters[i]=strWordToFind.substring(i,i+1);
			booCharFound[i]= ( (strSingleLetters[i].equals("/")) || (strSingleLetters[i].equals("-")) ) ? true : false;
		}
		//display for user
		showWordSoFar();
		//build and show user cue
		String lbl = "Give the "+data.getFieldName(intSelectedGuess)+". ";
		lbl += (getClueIndex()==-1) ? "(no clue)" : "Clue: "+data.getFieldName(intSelectedClue)+" = "+data.getData(randIndex,intSelectedClue);
		lblUserCue3.setText(lbl);
//		lblUserCue3.setFont(fntUserCue);	//often doesn't fit if this font applied!
		lblUserCue3.validate();		//to make sure clue is displayed properly
		pnlLeft3Upper.validate();	//to make sure clue is displayed properly
		//start playing background thought music
 		acThought.loop();
	}
 }