some small changes

Author: MCUmbrella

src/main/java/vip/floatationdevice/wordlehelper/Common.java

@@ -11,18 +11,22 @@ public class Common
 {
     public final static String PROGRAM_NAME = "WordleHelper 2.2.0";
 
-    //regex: 5 letters
+    /** regex: 5 letters */
     public final static Pattern validWord = Pattern.compile("^[a-zA-Z]{5}$");
-    //file: answer words file 'common.txt' in the jar
+
+    /** file: answer words file 'common.txt' in the jar */
     public final static String answerWordsFile = "/common.txt";
-    //file: all words file 'all.txt' in the jar
+
+    /** file: all words file 'all.txt' in the jar */
     public final static String allWordsFile = "/all.txt";
-    //possible answer words (from common.txt)
+
+    /** possible answer words (from common.txt) */
     public static LinkedList<String> answerWordsList = new LinkedList<>();
-    //all accepted words (from all.txt)
+
+    /** all accepted words (from all.txt) */
     public static LinkedList<String> allWordsList = new LinkedList<String>();
 
-    //read words from 'common.txt' and store them in answerWordsList
+    /** read words from 'common.txt' and store them in answerWordsList */
     public static void readAnswerWords() throws Exception
     {
         InputStream is = Common.class.getResourceAsStream(answerWordsFile);
@@ -38,7 +42,7 @@ public static void readAnswerWords() throws Exception
         System.out.println("Answer words dictionary size: " + answerWordsList.size());
     }
 
-    //read words from 'all.txt' and store them in allWordsList
+    /** read words from 'all.txt' and store them in allWordsList */
     public static void readAllWords() throws Exception
     {
         InputStream is = Common.class.getResourceAsStream(allWordsFile);
@@ -54,7 +58,7 @@ public static void readAllWords() throws Exception
         System.out.println("All words dictionary size: " + allWordsList.size());
     }
 
-    //calculate the possible words
+    /** calculate the possible words */
     public static void calculatePossibleWords(String inputWord, int[] result)
     {
         String inputWordLower = inputWord.toLowerCase();

src/main/java/vip/floatationdevice/wordlehelper/GUI.java

@@ -9,6 +9,7 @@
 import java.awt.event.ActionListener;
 import java.awt.event.KeyEvent;
 import java.util.Arrays;
+import java.util.Random;
 
 import static vip.floatationdevice.wordlehelper.Common.*;
 
@@ -32,74 +33,82 @@ public class GUI extends JFrame
      * +-------------------------------+
      */
 
-    //help message
+    /** help message */
     private final static String helpText =
             "Each line accepts first 5 letters and then 5 numbers from 0 to 2.\n" +
                     "After the 5th number is typed the possible words will be calculated.\n" +
                     "Clear a line by pressing the backspace key.\n\n" +
                     "· 0 means the letter is not in the word,\n" +
                     "· 1 means the letter is at the right position,\n" +
                     "· 2 means the letter is in the wrong position.";
-    //default text for possible words field
+
+    /** default text for possible words field */
     private final static String initText =
             "Possible words will be shown here\n" +
                     "Enter 5 letters and then 5 numbers to update them\n" +
                     "Press the '?' button to see help message\n" +
                     "Press the 'R' button to reset the program\n\n";
-    //acceptable chars: 0-2, a-z, backspace
+
+    /** acceptable chars: 0-2, a-z, backspace */
     private final static char[] acceptableChars = {
             'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j',
             'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't',
             'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2', '\b'
     };
-    //startup status
+
+    /** startup status */
     static boolean startupComplete = false;
-    //possible words field
+
+    /** possible words field */
     private final JTextArea possibleWordsField = new JTextArea(initText);
-    //all letter blocks for the result board, 6 lines, 5 letters each line
+
+    /** all letter blocks for the result board, 6 lines, 5 letters each line */
     private final LetterBlock[][] board = new LetterBlock[6][5];
-    //tries status
+
+    /** tries status: 'Try X / 6' */
     private final JLabel triesLabel = new JLabel("Try 0 / 6");
-    //'words left' status
+
+    /** 'words left' status */
     private final JLabel wordsLeftLabel = new JLabel();
-    //[?] button that shows the help message
+
+    /** [?] button that shows the help message */
     private final JButton helpButton = new JButton("?");
-    //[R] button that resets the board, the tries and the possible words
+
+    /** [R] button that resets the board, the tries and the possible words */
     private final JButton resetButton = new JButton("R");
-    //result board
-    JPanel resultBoard = new JPanel(null);
-    //current location of the letter input (1-25)
+
+    JPanel mainPanel = new JPanel(null);
+
+    // current location of the letter input
     private int letterIndexLine = 0;
     private int letterIndexColumn = 0;
-    //current location of the number input (1-25)
+    // current location of the number input
     private int numberIndexLine = 0;
     private int numberIndexColumn = 0;
-    //tries counter
+
+    /** tries counter */
     private int tries = 0;
 
-    //constructor
     public GUI()
     {
         StartupWindow startupWindow = new StartupWindow();
         if(!startupComplete)
         {
             //show a startup window
             startupWindow.setVisible(true);
-            /*try {Thread.sleep(1000); //magic, don't touch
-            }catch (InterruptedException e){e.printStackTrace();System.exit(-1);}*/
         }
         //load answer dictionary and all words dictionary
         try
         {
             readAnswerWords();
             readAllWords();
-            wordsLeftLabel.setText(answerWordsList.size() + " words left");
+            wordsLeftLabel.setText(answerWordsList.size() + " answer words loaded");
             //show all words at first
             possibleWordsField.append(answerWordsList.toString());
         }
         catch(Exception e)
         {
-            startupWindow.dispose();
+            startupWindow.dispose(); // close the startup window
             System.out.println("Error loading dictionary:");
             e.printStackTrace();
             //show error window
@@ -119,16 +128,16 @@ public GUI()
         setLocationRelativeTo(null);
         setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
         setLayout(null);
-        resultBoard.setBounds(0, 0, 640, 480);
-        resultBoard.setBackground(Color.DARK_GRAY);
-        add(resultBoard);
+        mainPanel.setBounds(0, 0, 640, 480);
+        mainPanel.setBackground(Color.DARK_GRAY);
+        add(mainPanel);
         //set result board
         initBoard();
         //set tries status
-        triesLabel.setBounds(10, 330, 100, 20);
+        triesLabel.setBounds(10, 320, 250, 20);
         triesLabel.setForeground(Color.WHITE);
         //set words left status
-        wordsLeftLabel.setBounds(110, 330, 100, 20);
+        wordsLeftLabel.setBounds(10, 350, 250, 20);
         wordsLeftLabel.setForeground(Color.WHITE);
         //set possible words field
         possibleWordsField.setBounds(270, 10, 360, 420);
@@ -139,7 +148,9 @@ public GUI()
         possibleWordsField.setForeground(Color.WHITE);
         //set help and reset button
         helpButton.setBounds(10, 400, 50, 30);
+        helpButton.setToolTipText("Show help message");
         resetButton.setBounds(70, 400, 50, 30);
+        resetButton.setToolTipText("Reset the program");
         //set global key event listener
         KeyboardFocusManager.getCurrentKeyboardFocusManager().addKeyEventDispatcher(keyEventDispatcher);
         //set help button's action listener
@@ -148,13 +159,15 @@ public GUI()
             @Override
             public void actionPerformed(ActionEvent e)
             {
-                //debug
+                KeyboardFocusManager.getCurrentKeyboardFocusManager().removeKeyEventDispatcher(keyEventDispatcher);
                 System.out.println("help button pressed");
                 //show help dialog
                 JOptionPane.showMessageDialog(GUI.this,
                         helpText,
                         "Help",
-                        JOptionPane.INFORMATION_MESSAGE);
+                        JOptionPane.INFORMATION_MESSAGE
+                );
+                KeyboardFocusManager.getCurrentKeyboardFocusManager().addKeyEventDispatcher(keyEventDispatcher);
             }
         });
         //set reset button's action listener
@@ -167,15 +180,15 @@ public void actionPerformed(ActionEvent e)
             }
         });
         //add components
-        resultBoard.add(triesLabel);
-        resultBoard.add(wordsLeftLabel);
-        resultBoard.add(possibleWordsField);
-        resultBoard.add(helpButton);
-        resultBoard.add(resetButton);
+        mainPanel.add(triesLabel);
+        mainPanel.add(wordsLeftLabel);
+        mainPanel.add(possibleWordsField);
+        mainPanel.add(helpButton);
+        mainPanel.add(resetButton);
         for(int i = 0; i < 6; i++)
             for(int j = 0; j < 5; j++)
             {
-                resultBoard.add(board[i][j]);
+                mainPanel.add(board[i][j]);
                 board[i][j].setBounds(j * 50 + 10, i * 50 + 10, 50, 50);
             }
         //show magic
@@ -195,7 +208,7 @@ public static void main(String[] args)
         System.out.println("Startup time: " + (System.currentTimeMillis() - Launcher.startTime) + "ms");
     }
 
-    //set every JLabel in the board with '_'
+    /** initialize every JLabel in the input board */
     private void initBoard()
     {
         for(int i = 0; i < 6; i++)
@@ -205,7 +218,7 @@ private void initBoard()
             }
     }
 
-    //get the word of the current line
+    /** get the word of the current line */
     private String getWord(int line)
     {
         StringBuilder sb = new StringBuilder();
@@ -218,7 +231,7 @@ private String getWord(int line)
         return sb.toString().toLowerCase();
     }
 
-    //get the numbers of the current line
+    /** get the numbers of the current line */
     private int[] getResultNumbers(int line)
     {
         int[] result = new int[5];
@@ -229,7 +242,7 @@ private int[] getResultNumbers(int line)
         return result;
     }
 
-    //reset a line
+    /** reset a line */
     private void resetLine(int line)
     {
         for(int i = 0; i != 5; i++)
@@ -241,15 +254,40 @@ private void resetLine(int line)
             letterIndexColumn = 0;
             numberIndexColumn = 0;
         }
-    }    //global key event dispatcher
+    }
 
+    /** global key event dispatcher */
     KeyEventDispatcher keyEventDispatcher = new KeyEventDispatcher()
     {
         @Override
         public boolean dispatchKeyEvent(KeyEvent e)
         {
             if(e.getID() == KeyEvent.KEY_PRESSED)
+            {
+                if(e.getKeyCode() == KeyEvent.VK_F3) // turn on debug mode
+                {
+                    mainPanel.setBorder(BorderFactory.createLineBorder(Color.red));
+                    possibleWordsField.setBorder(BorderFactory.createLineBorder(Color.red));
+                    triesLabel.setBorder(BorderFactory.createLineBorder(Color.red));
+                    wordsLeftLabel.setBorder(BorderFactory.createLineBorder(Color.red));
+                    for(LetterBlock[] t : board)
+                        for(LetterBlock tt : t)
+                            tt.setBorder(BorderFactory.createLineBorder(Color.red));
+                    helpButton.setBorder(BorderFactory.createLineBorder(Color.red));
+                    resetButton.setBorder(BorderFactory.createLineBorder(Color.red));
+                    System.out.println(answerWordsList);
+                    JOptionPane.showMessageDialog(GUI.this,
+                            "Created by MCUmbrella (https://github.com/MCUmbrella)\n" +
+                                    "This software is licensed under the MIT license and provided with absolutely no warranty.\n" +
+                                    "You can go to https://github.com/MCUmbrella/WordleHelper to check out the source code,\n" +
+                                    "submit code changes or initiate any issues.",
+                            DBG_TITLE[new Random().nextInt(DBG_TITLE.length)],
+                            JOptionPane.INFORMATION_MESSAGE
+                    );
+                    return true;
+                }
                 for(char c : acceptableChars)
+                {
                     if(e.getKeyChar() == c)
                     {
                         switch(e.getKeyChar())
@@ -272,10 +310,12 @@ public boolean dispatchKeyEvent(KeyEvent e)
                                         System.out.println("update possible words: " + getWord(letterIndexLine) + " " + Arrays.toString(getResultNumbers(numberIndexLine)));
                                         calculatePossibleWords(getWord(letterIndexLine), getResultNumbers(numberIndexLine));
                                         possibleWordsField.setText("Possible words:\n" + answerWordsList);
-                                        wordsLeftLabel.setText("Words left: " + answerWordsList.size());
+                                        wordsLeftLabel.setText(answerWordsList.size() + " answer words left");
                                         //if ArrayList is empty, the game is over
                                         if(answerWordsList.size() == 0)
                                         {
+                                            KeyboardFocusManager.getCurrentKeyboardFocusManager().removeKeyEventDispatcher(keyEventDispatcher);
+                                            triesLabel.setText("Try " + ++tries + " / 6");
                                             System.out.println("no words left");
                                             JOptionPane.showMessageDialog(null,
                                                     "No words left!\n\n" +
@@ -289,7 +329,8 @@ public boolean dispatchKeyEvent(KeyEvent e)
                                         //if ArrayList has only one word, that word is the result
                                         else if(answerWordsList.size() == 1)
                                         {
-                                            triesLabel.setText("Try " + ++tries + " / " + "6");
+                                            KeyboardFocusManager.getCurrentKeyboardFocusManager().removeKeyEventDispatcher(keyEventDispatcher);
+                                            triesLabel.setText("Try " + ++tries + " / 6");
                                             System.out.println("only one word left: " + answerWordsList.get(0));
                                             JOptionPane.showMessageDialog(null,
                                                     "The word we are finding is:\n\n  · " + answerWordsList.get(0) + "\n\nThe program will reset",
@@ -304,12 +345,13 @@ else if(answerWordsList.size() == 1)
                                             letterIndexColumn = 0;
                                             numberIndexLine++;
                                             letterIndexLine++;
-                                            triesLabel.setText("Try " + ++tries + " / " + "6");
+                                            triesLabel.setText("Try " + ++tries + " / 6");
                                             //tries++;
                                         }
                                         //if the last line is reached, the game is over
                                         if(numberIndexLine == 6)
                                         {
+                                            KeyboardFocusManager.getCurrentKeyboardFocusManager().removeKeyEventDispatcher(keyEventDispatcher);
                                             System.out.println("last line reached");
                                             JOptionPane.showMessageDialog(null,
                                                     "Last line reached!\nThe program will reset",
@@ -360,11 +402,13 @@ else if(answerWordsList.size() == 1)
                             }
                         }
                     }
+                }
+            }
             return false;
         }
     };
 
-    //this is what the 'R' button does
+    /** this is what the 'R' button does */
     void resetGUI()
     {
         System.out.println("resetting");
@@ -374,4 +418,34 @@ void resetGUI()
         dispose();
         new GUI();
     }
+
+    private static final String[] DBG_TITLE = {
+            PROGRAM_NAME,
+            "[object Object]",
+            "Hello world!",
+            "8412wg5d",
+            "Also try Minecraft!",
+            "ok",
+            "YEEEEEEEEEEEHAW!",
+            "undefined",
+            "1145141919810",
+            "Kid named debug window:",
+            "LIVE DEBUG WINDOW REACTION",
+            "Absolutely, 100% Lambda-free!",
+            "bruh",
+            "waltuh, put your f3 away waltuh",
+            "",
+            "@Wish-+U-&Have-#A-@Nice-~Day!",
+            "*vine boom sound effect*",
+            "DBG_TITLE[new Random().nextInt(DBG_TITLE.length)]",
+            "null",
+            "owo whats this?",
+            "F**K NYT!",
+            "Also try Guilded4J!",
+            "Never gonna give you up",
+            "The funny",
+            "???? ?? ???? ?? ??? ???",
+            "wo ak le",
+            "A wild debug window appears!"
+    };
 }