TweetFollow Us on Twitter

Puzzles as Resources
Volume Number:2
Issue Number:3
Column Tag:Developer's Forum

Puzzles as Resources in Aztec C

By David Levner, Sabaki Corp., Product: Polyomino Puzzles

Polyomino Puzzle Resources

Synopsis

Sam Loyd created polyomino puzzles 80 years ago. He didn't have a Macintosh, so he made his puzzles out of cardboard. I am lucky to own a Mac, so I wrote the game MacPoly to draw polyominoes on the screen.

MacPoly stores polyomino puzzles as resources, in a format described in this article. A method for creating these resources is presented, enabling you to add your own puzzles to MacPoly. The method may also be used to create other custom resources.

Introduction

The word 'polyomino' is a generalization of 'domino'. A domino is made of two squares, and a polyomino many squares. Here are some polyominoes:

Figure 1

An easy puzzle is shown below. The object is to cover the white square (the solution shape) with the four gray pieces. Most polyomino puzzles are much more difficult.

6 x 6 Square

Figure 2

Puzzle Source Files

The first step in creating a puzzle is to enter a puzzle source file. For example, this is the source file I used to generate figure 2:

6 x 6 Square Congratulations! Puzzle by David Levner.

..................
.a.a..SSSSSS..b.b.
.aaaa.SSSSSS.bbbb.
.aaa..SSSSSS..bbb.
......SSSSSS......
.c.c..SSSSSS..d.d.
.cccc.SSSSSS.dddd.
.ccc..SSSSSS..ddd.
..................

Figure 3

Use a mono-spaced font, like Monaco to make the columns line up, and save the file as text only. The first line of the file contains the puzzle name, followed by a congratulatory message that is displayed when the puzzle is solved. Then begins the puzzle grid.

The grid contains letters that stand for the squares of polyominoes. Lower case letters represent squares that are outside the solution shape, and upper case letters, except 'S', are squares covering the solution (none are shown in this example). Non-alphabetic characters (the dots) are empty spaces that are not part of the solution , and the letter 'S' denotes the squares of the solution that are not covered by any polyominoes.

Solution Source Files

The solution to a puzzle is represented by a very similar source file. The only difference is that there is no congratulatory message.

6 x 6 Square Solution

........
.AAABBB.
.AABBBB.
.AAABDB.
.CACDDD.
.CCCCDD.
.CCCDDD.
........

Figure 4

Puzzle and Solution Resources

A program could read these source files directly, but that would be less efficient than reading resources on the Mac. At the end of this article, a program is listed to convert puzzle and solution source files into resources.

MacPoly's puzzles are divided into 9 categories. Puzzle resources have type SBPn, where n is a digit from 1 to 9, and solutions have type SBSn.

Resource Type Puzzle Type

SBP1 Easy puzzles

SBP2 Rectangles

SBP3 Almost Rectangles

SBP4 Parallelograms

SBP5 Chess Boards

SBP6 Polyominoes

SBP7 Chess Pieces

SBP8 Objects

SBP9 Impossible Puzzles

Figure 5

The puzzle resource for 6 x 6 Square looks like this.

Congratulations! Puzzle by David Levner.

..................
.a.a..SSSSSS..b.b.
.aaaa.SSSSSS.bbbb.
.aaa..SSSSSS..bbb.
......SSSSSS......
.c.c..SSSSSS..d.d.
.cccc.SSSSSS.dddd.
.ccc..........ddd.
..................
..................
.a.a..SSSSSS..b.b.
.aaaa.SSSSSS.bbbb.
.aaa..SSSSSS..bbb.
......SSSSSS......
.c.c..SSSSSS..d.d.
.cccc.SSSSSS.dddd.
.ccc..........ddd.
..................
000000000
000000000
999999999
999999999
\0

Figure 6

The first line of the puzzle source file becomes the resource name. The second copy of the puzzle grid reserves space to store an arrangement of the pieces saved with MacPoly's save command.

Following the second grid are four nine digit numbers, representing (1) the time spent to arrive at the saved position, in seconds, (2) the number of operations performed to arrive at the saved position (MacPoly allows you to select a piece, drag it, flip it, and spin it), (3) the record time to solve the puzzle, in seconds, and (4) the record (fewest) number of operations to solve a puzzle. Initially, these numbers are set to 0, 0, 999999999, and 999999999. At the end of the resource is a binary zero.

A solution resources differs in several ways: there is no congratulations message or timing information, and only one puzzle grid.

Converting Source Files To Resources

I wrote a C program, called ftor, to convert puzzle source files to resources. Ftor is designed to run under a shell program; it cannot be run from the Macintosh desktop. If you try to recreate ftor, you should run it from the shell supplied with your C compiler.

Most shell programs are modeled on the Bourne shell from the Unix operating system. To use a shell, you type a command, which is interpreted as a program name followed by an argument list. All the C compilers I have seen for the Mac include a shell user interface. On the Amiga, Commodore supplies a shell called the Command Line Interface.

I have listed below some dialogs with the shell. The '$' is a prompt character, signifying that the shell is ready to accept a command. I typed the characters following the '$' to run the program ftor; the line below contains the program's output. In this case, I ran ftor without any arguments to remind me what arguments it expects.

 $ ftor
 usage: ftor TYPE outfile infile1 [infile2 ...]

Ftor's first argument is the four letter type of the resource(s) being created, followed by the output file, and one or more puzzle source files. Each source file is converted to a resource and stored in the output file.

 $ ftor SBP1 Puzzles epz

Assuming that the puzzle source file of figure 3 is named epz, the command above creates a resource called "6 x 6 Square" in the file Puzzles. The Puzzles file must already exist and contain at least one resource.

Ftor Program Source

I used Aztec C to compile and link ftor with the following two commands:

 $ cc ftor.c -o ftor.o
 $ ln -o ftor ftor.o -lc

Conclusion

This article demonstrates a method for creating custom resources from ascii source files. Owners of MacPoly can create and enter their own puzzles. Puzzles and solutions should be entered in pairs; otherwise the Solve feature of MacPoly will not work properly.

Custom resources are both bad and good: few toolbox functions can manipulate them, but they do exactly what you want. You must write your own code to deal with them, but porting the code to other computers will be easier.

/* The program ftor converts a puzzle source file into a  */
/* resource. Developed with Aztec C version 1.03.  */
/* Copyright Sabaki Corp.,1985, for MacTutor.  */
/* Note that this is not a stand alone application, but */
/* requires the Aztec C system to execute for the */
/* default Mac user interface. */

#include "stdio.h"       /* contains definition of NULL (0L) */
#include "ctype.h"       /* contains definition of isdigit */
                             
#include "quickdraw.h"   /* Quickdraw */
#include "memory.h"      /* Memory manager */
#include "resource.h"    /* Resource manager */

/*---------------------------------------------------------------*/

extern int errno;         /* error number variable */

/*---------------------------------------------------------------*/

static long long_type;    /* resource type */

static char flag_puzzle;  /* 1 for puzzles, 0 for solutions */

/*---------------------------------------------------------------*/

main(argc, argv) /* Entry point. */

int argc;         /* number of arguments */
char *argv[];    /* argument vector, an array of strings */
{
 int a;           /* argument counter */
 static char usage_msg[] =
 "usage: ftor TYPE outFile inFile1 [inFile2 ...]\n";
 long c4tol();   /* converts four bytes into a long */
 char *ctop(),   /* converts a C string to a PASCAL string */
      *ptoc();   /* converts a PASCAL string to a C string */

 if  (argc < 4)
    { printf(usage_msg); exit(1); }

 long_type = c4tol(argv[1][0], argv[1][1], argv[1][2], argv[1][3]);
 flag_puzzle = (argv[1][2] == 'P');

 close_application_resource_file();   /* For safety's sake. */

 if  (OpenResFile(ctop(argv[2])) < 0) /* Open the output file. */
    {
     printf("File %s open error %d\n", ptoc(argv[2]), ResError());
     exit(1);
    }   /* then */

 /* For each input file, add a resource to the output file. */
 for (a = 3; a < argc; a = a + 1)
     add_resource(argv[a]);

 exit(0);
}  /* main() */

/*---------------------------------------------------------------*/

static add_resource(filename)
/* Convert one input file to a resource in the output file. */

char *filename;         /* name of the input file */
{
 int data_size,         /* length of the text in the source file */
     header_size,       /* length of text before the puzzle grid */
     resource_size, /* length of the resource being created */
     title_size;        /* length of the resource name */
 char *file_data,     /* text read from the source file */
      title[80];      /* resource name */
 Handle res_handle;   /* handle to resource being created */
 Ptr ptr;               /* pointer to the resource being created */

 /* Read the input file.  Note that if the second parameter  */
 /* passed to read_file() points to NULL, then read_file()  */
 /* allocates a block of storage big enough to hold the  */
 /*  input file. */

 file_data = NULL;
 if  (read_file(filename, &file_data) < 0)
    { printf("File %s error %d.\n", filename, errno); exit(1); }

 for (title_size = 0;     /* Determine the size of the title. */
      file_data[title_size] > '\r';
      title_size = title_size + 1)
     ;

 /* Copy title to a C string. */
 strncpy(title, file_data, title_size);
 title[title_size] = 0;

 /* Let the length of the title include the \r character. */
 title_size = title_size + 1;

 /* If a resource by this name already exists, remove it. */
 res_handle = GetNamedResource(long_type, ctop(title));
 if  (res_handle != NULL)
   RmveResource(res_handle);

 /* Determine the size of the header, the grid, and the */
/*  resource. The header includes the title and the  */
/*  congratulations message. */

 header_size = title_size;
 while  (file_data[header_size] > '\r')
     header_size = header_size + 1;
 header_size = header_size + 1;

 data_size = strlen(file_data);
 resource_size = data_size - title_size + 1;

 /* If it's a puzzle, allow room for a 2nd grid and timing info. */
 if  ( flag_puzzle )
   resource_size = resource_size + data_size - header_size + 40;

 /* Get a new handle for the resource. */
 res_handle = NewHandle((long) resource_size);
 if  (res_handle == NULL)
    { printf("Memory error %d\n", MemError()); exit(1); }

 HLock(res_handle);  /* Make sure  resource doesn't run off. */
 ptr = *res_handle;

 /* Move the header and the puzzle into the resource. */
 strncpy(ptr, &file_data[title_size], data_size - title_size);
 
 /* Puzzles include a second puzzle grid,  blank timing info. */
 ptr = ptr + data_size - title_size;
 if  ( flag_puzzle )
    {
     strncpy(ptr, &file_data[header_size],
             data_size - header_size);
     ptr = ptr + data_size - header_size;
     strcpy(ptr, "000000000\r000000000\r999999999\r999999999\r");
    } /* then */
   else  ptr[0] = 0;

 /* Add the resource to the output file. */
 AddResource(res_handle, long_type, UniqueID(long_type), title);

 HUnlock(res_handle);   /* Unlock the resource. */
 free(file_data);      /* Free memory allocated by read_file(). */
 return;
}  /* static add_resource() */

/*---------------------------------------------------------------*/

long c4tol(c0, c1, c2, c3)
/* Returns a long constructed from the four bytes. */

unsigned char c0, c1, c2, c3;
{
 return((c0 << 24L) + (c1 << 16L) + (c2 << 8L) + c3);
} /* long c4tol() */

/*---------------------------------------------------------------*/

char *ctop(string)
/* Converts a C string to a PASCAL string, which is returned. */

char *string;
{
 int length;
 char *pstring;

 length = strlen(string);
 for (pstring = &string[length];
      pstring != string;
      pstring = pstring - 1)
     *pstring = *(pstring - 1);
 *string = length;
 return(string);
}  /* char *ctop */

/*---------------------------------------------------------------*/
char *ptoc(string)
/* Converts a PASCAL string to a C string, which is returned. */

char *string;
{
 int i,
     length;

 length = *string;
 for (i = 1; i <= length; i = i + 1)
     string[i - 1] = string[i];
 string[length] = 0;
 return(string);
}  /* char *ptoc */

/*---------------------------------------------------------------*/
read_file(file_name, data)
/* Reads the data fork of a file. */

char *file_name,  /* name of the file to be read */
     **data;       /* pointer to where the file data should go */
{
 int fd,           /* file descriptor */
     size;         /* size of the file in bytes */
 extern long lseek();
 extern char *malloc();

 fd = open(file_name, 0);
 if  (fd < 0)
    return(-1);
  /* determine the size of the file */
 size = (int) lseek(fd, 0L, 2);
 lseek(fd, 0L, 0);

 if  (*data == NULL)
   *data = malloc(1 + size);  /* leave room for a trailing null */

 if  (*data == NULL)
    { close(fd); return(-1); }  /* malloc failed */

 if  (read(fd, *data, size) != size)
    { close(fd); return(-1); }  /* read failed */

 close(fd);
 (*data)[size] = 0;             /* add a trailing null */
 return(0);
}  /* read_file() */

/*---------------------------------------------------------------*/

close_application_resource_file()
/* Close the application resource file. */

{
 DetachResource( GetResource('CODE', 1) );
 CloseResFile( CurResFile() );
 return;
}             /* close_application_resource_file() */
 

Community Search:
MacTech Search:

Software Updates via MacUpdate

DaisyDisk 4.4 - $9.99
DaisyDisk allows you to visualize your disk usage and free up disk space by quickly finding and deleting big unused files. The program scans your disk and displays its content as a sector diagram... Read more
BetterTouchTool 2.07 - Customize Multi-T...
BetterTouchTool adds many new, fully customizable gestures to the Magic Mouse, Multi-Touch MacBook trackpad, and Magic Trackpad. These gestures are customizable: Magic Mouse: Pinch in / out (zoom... Read more
BetterTouchTool 2.07 - Customize Multi-T...
BetterTouchTool adds many new, fully customizable gestures to the Magic Mouse, Multi-Touch MacBook trackpad, and Magic Trackpad. These gestures are customizable: Magic Mouse: Pinch in / out (zoom... Read more
PDFpen 8.3.2 - $74.95
PDFpen allows users to easily edit PDF's. Add text, images and signatures. Fill out PDF forms. Merge or split PDF documents. Reorder and delete pages. Even correct text and edit graphics! Features... Read more
DiskCatalogMaker 6.5.20 - Catalog your d...
DiskCatalogMaker is a simple disk management tool which catalogs disks. Simple, light-weight, and fast Finder-like intuitive look and feel Super-fast search algorithm Can compress catalog data for... Read more
Things 2.8.9 - Elegant personal task man...
Things is a task management solution that helps to organize your tasks in an elegant and intuitive way. Things combines powerful features with simplicity through the use of tags and its intelligent... Read more
PDFpenPro 8.3.2 - $124.95
PDFpenPro allows users to edit PDF's easily. Add text, images and signatures. Fill out PDF forms. Merge or split PDF documents. Reorder and delete pages. Create fillable forms and tables of content... Read more
Things 2.8.9 - Elegant personal task man...
Things is a task management solution that helps to organize your tasks in an elegant and intuitive way. Things combines powerful features with simplicity through the use of tags and its intelligent... Read more
DiskCatalogMaker 6.5.20 - Catalog your d...
DiskCatalogMaker is a simple disk management tool which catalogs disks. Simple, light-weight, and fast Finder-like intuitive look and feel Super-fast search algorithm Can compress catalog data for... Read more
PDFpenPro 8.3.2 - $124.95
PDFpenPro allows users to edit PDF's easily. Add text, images and signatures. Fill out PDF forms. Merge or split PDF documents. Reorder and delete pages. Create fillable forms and tables of content... Read more

Latest Forum Discussions

See All

Pokémon GO Generation 2 evolution guide
At long last, Niantic Labs finally unleashed the Generation 2 Pokémon into the wild. Pokémon GO trainers are scrambling to grab up this new set of 80 Pokémon. There are some special new tricks required to catch all of these new beasties, though.... | Read more »
The best new games we played this week
It feels as though the New Year got off to a creaking start as far as mobile games go, but that's changed over the past few weeks. The last few days alone have seen the debut of a number of wonderful games, so we thought we'd take the time to... | Read more »
Recruit more scallywags and discover new...
Get ready to show off your sea legs all over again in Oceans & Empires’ new grand update, which aims to make the act of rising to the role of seven seas ruler even more fresh and appealing, thanks to a richness of new content on both iOS and... | Read more »
Mage the Ascension: Refuge (Games)
Mage the Ascension: Refuge 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: The groundbreaking roleplaying game Mage: The Ascension manifests in our turbulent present with Refuge, an... | Read more »
Vampire: Prelude (Games)
Vampire: Prelude 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: The classic roleplaying game Vampire: The Masquerade returns to digital games with a Prelude of things to come. Experience a... | Read more »
Digby Forever Guide: How to dig to the d...
Digby Forever is a sparkling homage to arcade classics, and while you may be tiring of the number of arcade games being thrown at you, this endless digger finds many ways to stand out from the rest of the pack. The game manages to be challenging... | Read more »
The best sales on the App Store this wee...
It's been quite the week in mobile games, but if the latest releases(there were some pretty darn good ones, in case you missed out) aren't really doing the trick, perhaps some of these discounted games will. Many of these premium games had their... | Read more »
Why the new Fire Emblem Heroes update sh...
It’s exciting to see Nintendo delving into the mobile sphere, regardless of whether it’s to give fans another platform to enjoy their fans or simply a sound business venture. Two of the company's announced mobile games have finally come to... | Read more »
New Fire Emblem Heroes update adds new h...
Fire Emblem Heroes received a sizeable update first thing this morning. The update features a batch of fresh content along with a few updates to the game's systems. [Read more] | Read more »
The Deep Paths (Games)
The Deep Paths 1.0 Device: iOS iPhone Category: Games Price: $3.99, Version: 1.0 (iTunes) Description: 25% off launch sale!!! The Deep Paths: Labyrinth Of Andokost is a first-person, dungeon crawling RPG, with traditional grid-based... | Read more »

Price Scanner via MacPrices.net

15-inch Touch Bar MacBook Pros on sale for up...
Amazon has 15″ Touch Bar MacBook Pros in stock today and on sale for up to $150 off MSRP including free shipping: - 15″ 2.7GHz Touch Bar MacBook Pro Space Gray: $2720.38 $79 off MSRP - 15″ 2.7GHz... Read more
Apple’s Education discount saves up to $300 o...
Purchase a new Mac or iPad using Apple’s Education Store and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free: -... Read more
13-inch 1.6GHz/256GB MacBook Air on sale for...
Newegg has the 13″ 1.6GHz/256GB MacBook Air (MMGG2LL/A) on sale for $1029.99 including free shipping. Their price is $170 off MSRP, and it’s the lowest price available for this model. Choose Newegg... Read more
Save up to $600 with Apple refurbished Mac Pr...
Apple has Certified Refurbished Mac Pros available for up to $600 off the cost of new models. An Apple one-year warranty is included with each Mac Pro, and shipping is free. The following... Read more
12-inch 1.1GHz Retina MacBooks on sale for $1...
B&H has 12″ 1.1GHz Retina MacBooks on sale for $150 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 12″ 1.1GHz Space Gray Retina MacBook: $1149 $150 off MSRP - 12″ 1.1GHz... Read more
InTouch Health Expands iOS And Windows Produc...
Specialty telehealth enterprise provider InTouch Health has announced an expanded range of FDA Class I listed medical devices and software solutions for ambulatory, non-acute and non-emergent... Read more
iMobie Airs World’s 1st iCloud Manager with M...
iMobie Inc., an Apple-related software company, announced their newly-updated iPhone manager AnyTrans with exclusive feature to sync and manage contents across multiple iCloud accounts. With it,... Read more
New Proactive Apple Support Professional Cert...
Watchman Monitoring has announced Proactive Support Professional Certification at MacTech Pro. Watchman Monitoring is a premier Proactive Support Software as a Service (SaaS) tool for IT... Read more
13-inch 2.7GHz Retina MacBook Pro on sale for...
B&H Photo has the 2015 13″ 2.7GHz/128GB Retina Apple MacBook Pro on sale for $100 off MSRP. Shipping is free, and B&H charges NY tax only: - 13″ 2.7GHz/128GB Retina MacBook Pro (MF839LL/A): $... Read more
Back in stock: Apple refurbished 13-inch Reti...
Apple has Certified Refurbished 2015 13″ Retina MacBook Pros available for up to $360 off original MSRP, starting at $1099. An Apple one-year warranty is included with each model, and shipping is... Read more

Jobs Board

*Apple* Retail - Multiple Positions - Apple,...
SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* macOS Systems Integration Administra...
…most exceptional support available in the industry. SCI is seeking an Junior Apple macOS systems integration administrator that will be responsible for providing Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Lead Senior *Apple* (Mac) Administrator - S...
…but also to protect them. Position Summary: SC3 is actively seeking a Senior Apple (Mac) Administrator that will be responsible for providing Apple Mac Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.