Functionality for keyboard and mouse in puzzle area
[wordblah.git] / wordblox.h
index cabda97..2978e0d 100644 (file)
@@ -2,13 +2,18 @@
 #define __WORDBLOX_H
 #define _XOPEN_SOURCE
 #include <unistd.h>
+#include <stdbool.h>
+#include <string.h>
+#include <ctype.h>
 #include <gd.h>
 #include <gdfontmb.h>
 #include <gdfontg.h>
+#include <zlib.h>
 #include "constantstrings.h"
 
-#define MAX_PUZZLE_SIZE 20
+#define MAX_PUZZLE_SIZE 25
 #define MAX_CLUE_LENGTH 150
+#define GRID_PIXELS 37
 
 /* Enum to define terminal colours */
 enum COLOR {
@@ -32,6 +37,12 @@ enum ORIENTATION {
        DOWN=2
 };
 
+/* for use with the player */
+enum DIRECTION {
+       DIR_FORWARD = 1,
+       DIR_BACK = -1
+};
+
 typedef char String[MAX_CLUE_LENGTH];
 
 /* The main puzzle struct type */
@@ -47,6 +58,17 @@ typedef struct {
        char salt[256];
 } Puzzle;
 
+/* The player data struct type - for the player app */
+typedef struct {
+       Puzzle puzzle;
+       char filename[65535];
+       bool is_loaded;
+       char char_ans[MAX_PUZZLE_SIZE][MAX_PUZZLE_SIZE];
+       int cur_row;
+       int cur_col;
+} MainPlayerData;
+
+
 /* get a number from the user */
 int get_num ()
 {
@@ -129,7 +151,7 @@ void export_clues (Puzzle *p, const char *filename)
 /* Output the grid to image - if answerkey is true export filled grid */
 void export_grid_image  (Puzzle *p, const char *filename, bool answerkey) 
 {
-       int img_size = p->grid_size * 40;
+       int img_size = p->grid_size * GRID_PIXELS;
        FILE * outfile = fopen (filename, "wb");
        if (outfile == NULL)
        {
@@ -138,7 +160,7 @@ void export_grid_image  (Puzzle *p, const char *filename, bool answerkey)
        }
        
        gdImagePtr img = gdImageCreate (img_size, img_size);
-       int white = gdImageColorAllocate (img, 255,255,255);
+       gdImageColorAllocate (img, 255,255,255);
        int black = gdImageColorAllocate (img, 0, 0, 0);
        int blue = gdImageColorAllocate (img, 0, 0, 216);
        gdFontPtr sm_fnt = gdFontGetMediumBold ();
@@ -150,13 +172,15 @@ void export_grid_image  (Puzzle *p, const char *filename, bool answerkey)
                {
                        /* if it is a block, draw the black square */
                        if (p->chars[i][j] == '#')
-                               gdImageFilledRectangle (img, j*40, i*40, j*40+40, 
-                                                                                       i*40+40,black);
+                               gdImageFilledRectangle (img, j*GRID_PIXELS, i*GRID_PIXELS, 
+                                                                               j*GRID_PIXELS+GRID_PIXELS, 
+                                                                               i*GRID_PIXELS+GRID_PIXELS,black);
                        else
                        {
                                /* draw a regular square */
-                               gdImageRectangle (img, j*40, i*40, j*40+40, 
-                                                                       i*40+40, black);
+                               gdImageRectangle (img, j*GRID_PIXELS, i*GRID_PIXELS, 
+                                                                               j*GRID_PIXELS+GRID_PIXELS, 
+                                                                       i*GRID_PIXELS+GRID_PIXELS, black);
                                
                                /* print the numers, if it is either start across word or 
                                a down word */
@@ -167,22 +191,24 @@ void export_grid_image  (Puzzle *p, const char *filename, bool answerkey)
                                        {
                                                char str[5];
                                                sprintf (str, "%d", p->start_across_word[i][j]);
-                                               gdImageString (img,  sm_fnt, j*40+2, i*40+2,
-                                                                       (unsigned char *)str, blue);   
+                                               gdImageString (img,  sm_fnt, j*GRID_PIXELS+2, 
+                                                                               i*GRID_PIXELS+2, 
+                                                                               (unsigned char *)str, blue);   
                                        }
                                        else 
                                        {
                                                char str[5];
                                                sprintf (str, "%d", p->start_down_word[i][j]);
-                                               gdImageString (img,  sm_fnt, j*40+2, i*40+2,
-                                                                       (unsigned char *)str, blue);                                    
+                                               gdImageString (img,  sm_fnt, j*GRID_PIXELS+2, 
+                                                                               i*GRID_PIXELS+2,
+                                                                               (unsigned char *)str, blue);                                    
                                        }
                                }
                                /* if answerkey is true, draw the character in the cell */
                                if (answerkey)
                                {
-                                       gdImageChar (img, lg_fnt, j*40+15, i*40+15, 
-                                               p->chars[i][j], black);
+                                       gdImageChar (img, lg_fnt, j*GRID_PIXELS+15, 
+                                                                       i*GRID_PIXELS+10, p->chars[i][j], black);
                                }
                        }
                }
@@ -232,7 +258,7 @@ bool next_col_blank (Puzzle *p, int r, int c)
        return false;
 }
 
-/* unfreeze the grid - mak editing possible to change words */
+/* unfreeze the grid - make editing possible to change words */
 void unfreeze_puzzle (Puzzle *p)
 {
        for (int i = 0; i < p->grid_size; i ++)
@@ -252,7 +278,7 @@ void unfreeze_puzzle (Puzzle *p)
 /* freeze the grid - make editing impossible because it finalizes the
    across and down words in the grid */
 void freeze_puzzle (Puzzle *p)
-{
+{              
        int word_num = 1;
        bool across_word_start, down_word_start;
        for (int i = 0; i < p->grid_size; i ++)
@@ -262,7 +288,7 @@ void freeze_puzzle (Puzzle *p)
                        across_word_start = false; 
                        down_word_start = false;
                        /* if it is a blank cell - cover it with a block */
-                       if (p->chars[i][j] == ' ')
+                       if (p->chars[i][j] == ' ' || p->chars[i][j] == '#')
                                p->chars[i][j] = '#';
                        /* it is not a blank cell - check all possibilities */
                        else 
@@ -316,22 +342,31 @@ void init_puzzle (Puzzle *p, int grid_size)
 /* save the puzzle to a file */
 void save_puzzle (Puzzle *puzzle, const char* file) {
        FILE *outfile;
-       outfile = fopen (file, "w");
+       /* First output the uncompressed contents to a temp file */
+       outfile = tmpfile ();
        if (outfile == NULL)
        {
                fprintf (stderr, "%s\n", ERROR_WRITING_FILE);
                exit (1);
        }
+       /* grid size is the first field */
        fprintf (outfile, "%d\n", puzzle->grid_size);
+       /* whether grid is frozen or not */
        fprintf (outfile, "%d\n", puzzle->grid_frozen);
+       /* the hashed password */
        fprintf (outfile, "%s\n", puzzle->hashed_password);
+       /* the salt */
        fprintf (outfile, "%s\n", puzzle->salt);
+       
+       /* First output the grid characters columns/rows */
        for (int i = 0; i < puzzle->grid_size; i ++)
        {
                for (int j = 0; j < puzzle->grid_size; j ++)
                        fprintf (outfile, "%c", puzzle->chars[i][j]);
                fprintf (outfile, "\n");
        }
+       
+       /* Next output the start across/down numbers */
        for (int i = 0; i < puzzle->grid_size; i ++)
        {
                for (int j = 0; j < puzzle->grid_size; j++)
@@ -341,40 +376,108 @@ void save_puzzle (Puzzle *puzzle, const char* file) {
                }
                fprintf (outfile, "\n");
        }
+       
+       /* Output the across clues */
        fprintf (outfile, "ACROSS\n");
+       /* Search the grid for across words */
        for (int i = 0; i < puzzle->grid_size; i ++)
        {
                for (int j = 0; j < puzzle->grid_size; j++)
                {
+                       /* if it is an across word, then put the word index followed by
+                       tab character (as separator) and the clue */
                        if (puzzle->start_across_word[i][j] != -1)
                                fprintf (outfile, "%d\t%s\n", puzzle->start_across_word[i][j], 
                                        puzzle->clue_across[i][j]);
                }
        }
+       
+       /* Output the down clues */
        fprintf (outfile, "DOWN\n");
+       /* Search the grid for down words */
        for (int i = 0; i < puzzle->grid_size; i ++)
        {
                for (int j = 0; j < puzzle->grid_size; j++)
                {
+                       /* same as across word, put the word index followed by the tab
+                       character and then the clue */
                        if (puzzle->start_down_word[i][j] != -1)
                                fprintf (outfile, "%d\t%s\n", puzzle->start_down_word[i][j], 
                                        puzzle->clue_down[i][j]);
                }
        }
-
+       
+       /* Flush the buffer and rewind to beginning - to read and save into 
+       gzip compressed file */
+       fflush (outfile);
+       fseek (outfile, 0, 0);
+                       
+       /* now compress the file and save it to destination file */
+       gzFile outdestfile = gzopen (file, "wb");
+       if (outdestfile == NULL)
+       {
+               fprintf (stderr, "%s\n", ERROR_WRITING_FILE);
+               fclose (outfile);
+               exit (1);
+       }
+       char buf[128];
+       int num = fread (buf, sizeof(char), sizeof(char)*128, outfile);
+       while (num > 0)
+       {
+               int res = gzwrite (outdestfile, buf, num*sizeof(char) );
+               if (res == 0)
+               {
+                       fprintf (stderr, "%s %s\n", ERROR_WRITING_FILE, COMPRESSED);
+                       fclose (outfile);
+                       exit (1);
+               }
+               num = fread (buf, sizeof(char), sizeof(char)*128, outfile);
+       }
+       gzclose (outdestfile);
        fclose (outfile);
+
 }
 
 /* read the puzzle from a file */
 Puzzle load_puzzle (const char* file) {
-       FILE *infile;
-       Puzzle p;
-       infile = fopen (file, "rb");
+       /* First open the GZip file */
+       gzFile insourcefile = gzopen (file, "rb");
+       if (insourcefile == NULL)
+       {
+               fprintf (stderr, "%s %s\n", ERROR_READING_FILE, COMPRESSED);
+               exit (1);
+       }
+       /* Open a temporary file to uncompress the contents */
+       FILE *infile = tmpfile ();
        if (infile == NULL)
        {
                fprintf (stderr, "%s\n", ERROR_READING_FILE);
-               exit (1);
+               exit (1);       
+       }
+       /* Put the uncompressed content to the temp file */
+       char buf[128];
+       int num = 0;
+       num = gzread (insourcefile, buf, 128);
+       while (num > 0)
+       {
+               int res = fwrite (buf, 1, num, infile);
+               if (res == 0)
+               {
+                       fprintf (stderr, "%s\n", ERROR_READING_FILE);
+                       fclose (infile);
+                       gzclose (insourcefile);
+                       exit (1);
+               }
+               num = gzread (insourcefile, buf, 128);
        }
+       /* Close the gzip file */
+       gzclose (insourcefile);
+       /* Flush the temp file buffer and rewind to beginning */
+       fflush (infile);
+       fseek (infile, 0, 0);
+
+       /* Read the temporary file contents to the structure Puzzle */
+       Puzzle p;
        char line[MAX_CLUE_LENGTH+10];
        fgets (line, MAX_CLUE_LENGTH + 10, infile);
        p.grid_size = atoi (line);
@@ -600,6 +703,7 @@ void print_menu (enum COLOR fg, enum COLOR bg, const char* title,
                        printf ("\u2550");
                printf ("\u2557"); 
                reset_color (); printf ("\n");
+               set_color (fg, bg, NORMAL);
                printf ("\u2551");
                set_color (fg, bg, BOLD);
                printf ("%-*s", padding, title);
@@ -627,4 +731,86 @@ void print_menu (enum COLOR fg, enum COLOR bg, const char* title,
                reset_color (); printf ("\n");
 }
 
+/* reset the player data, from the new file */
+void reset_player_data (MainPlayerData *app_data, const char *filename)
+{
+       app_data->puzzle = load_puzzle (filename);
+
+       app_data->is_loaded = app_data->puzzle.grid_frozen;
+       app_data->cur_col = -1;
+       app_data->cur_row = -1;
+       strcpy (app_data->filename, filename);
+       /* reset the answer keys */
+       for (int i = 0; i < app_data->puzzle.grid_size; i ++)
+               for (int j = 0; j < app_data->puzzle.grid_size; j ++)
+                       app_data->char_ans[i][j] = ' ';
+       
+}
+
+/* in the player app, move the current selection index left or right */
+void move_current_col (MainPlayerData *app_data, enum DIRECTION dir)
+{
+       int r = app_data->cur_row;
+       int c = app_data->cur_col;
+       if (dir == DIR_FORWARD)
+       {
+               c ++;
+               while (c < app_data->puzzle.grid_size)
+               {
+                       if (app_data->puzzle.chars[r][c] == '#')
+                               c ++;
+                       else
+                               break;
+               }
+               if (c < app_data->puzzle.grid_size)
+                       app_data->cur_col = c;
+       }
+       else 
+       {
+               c --;
+               while (c >= 0)
+               {
+                       if (app_data->puzzle.chars[r][c] == '#')
+                               c --;
+                       else
+                               break;
+               }
+               if (c >= 0)
+                       app_data->cur_col = c;
+       }
+}
+
+/* in the player app move the current selection index up or down */
+void move_current_row (MainPlayerData *app_data, enum DIRECTION dir)
+{
+       int r = app_data->cur_row;
+       int c = app_data->cur_col;
+       if (dir == DIR_FORWARD)
+       {
+               r ++;
+               while (r < app_data->puzzle.grid_size)
+               {
+                       if (app_data->puzzle.chars[r][c] == '#')
+                               r ++;
+                       else
+                               break;
+               }
+               if (r < app_data->puzzle.grid_size)
+                       app_data->cur_row = r;
+       }
+       else 
+       {
+               r --;
+               while (r >= 0)
+               {
+                       if (app_data->puzzle.chars[r][c] == '#')
+                               r --;
+                       else
+                               break;
+               }
+               if (r >= 0)
+                       app_data->cur_row = r;
+       }
+}
+
 #endif