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() */
 
AAPL
$100.58
Apple Inc.
+0.01
MSFT
$45.22
Microsoft Corpora
+0.27
GOOG
$583.37
Google Inc.
-1.12

MacTech Search:
Community Search:

Software Updates via MacUpdate

Pages 5.2.2 - Apple's word processo...
Apple Pages is a powerful word processor that gives you everything you need to create documents that look beautiful. And read beautifully. It lets you work seamlessly between Mac and iOS devices. And... Read more
Quicken 2015 2.0.1 - Complete personal f...
The new Quicken 2015 helps you manage all your personal finances in one place, so you can see where you're spending and where you can save. Quicken automatically categorizes your financial... Read more
CleanMyMac 2.2.7 - Delete files that was...
CleanMyMac makes space for the things you love. Sporting a range of ingenious new features, CleanMyMac 2 lets you safely and intelligently scan and clean your entire system, delete large, unused... Read more
MacFamilyTree 7.2.4 - Create and explore...
MacFamilyTree gives genealogy a facelift: it's modern, interactive, incredibly fast, and easy to use. We're convinced that generations of chroniclers would have loved to trade in their genealogy... Read more
Videobox 4.1.1 - Download Flash video th...
Videobox allows you to quickly and easily download Flash video from most all of the popular video sites on the internet. Videobox will convert the video into a native Quicktime format so it's ready... Read more
Web Snapper 3.3.5 - Capture entire Web p...
Web Snapper lets you capture Web pages exactly as they appear in your browser. You can send them to a file as images or vector-based, multi-page PDFs. It captures the whole Web page - eliminating... Read more
Picasa 3.9.138 - Organize, edit, and sha...
Picasa and Picasa Web Albums allows you to organize, edit, and upload your photos to the Web from your computer in quick, simple steps. Arrange your photos into folders and albums and erase their... Read more
Tidy Up 3.0.15.0 - Find duplicate files...
Tidy Up is a complete duplicate finder and disk-tidiness utility. With Tidy Up you can search for duplicate files and packages by the owner application, content, type, creator, extension, time... Read more
Parallels Desktop 10.0 - Run Windows app...
Parallels Desktop is simply the world's bestselling, top-rated, and most trusted solution for running Windows applications on your Mac. With Parallels Desktop for Mac, you can seamlessly run both... Read more
Apple Final Cut Pro X 10.1.3 - Professio...
Apple Final Cut Pro X is a professional video editing solution.Completely redesigned from the ground up, Final Cut Pro adds extraordinary speed, quality, and flexibility to every part of the post-... Read more

Latest Forum Discussions

See All

DotEmu Summer Sale Cuts Several Games’ P...
DotEmu Summer Sale Cuts Several Games’ Prices to $0.99 Posted by Ellis Spice on August 21st, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
King Announces its Newest “Saga” – Diamo...
King Announces its Newest “Saga” – Diamond Digger Saga Posted by Jessica Fisher on August 21st, 2014 [ permalink ] Diamond Digger Saga, by King Digital Entertainment, promises to be another addictive, adorable game in the “Saga” | Read more »
Spacetime Studios’ Greg Mueller Tells Al...
| Read more »
TourStar Review
TourStar Review By Rob Thomas on August 21st, 2014 Our Rating: :: BORING TOURINGUniversal App - Designed for iPhone and iPad When The Ramones sang “Touring, touring/It’s never boring,” they clearly weren’t referring to TourStar.... | Read more »
Track Your Pregnancy with Glow Nurture
Track Your Pregnancy with Glow Nurture Posted by Jessica Fisher on August 21st, 2014 [ permalink ] iPhone App - Designed for the iPhone, compatible with the iPad | Read more »
Outcast Odyssey – An Interview with the...
At this year’s San Diego Comic-Con, fans got the chance to meet and mingle with several of the artists behind Magic Pixel Games and Namco Bandai’s upcoming card battler, Outcast Odyssey. Considering many of these artists have worked on comics in the... | Read more »
BoxPop Review
BoxPop Review By Jennifer Allen on August 21st, 2014 Our Rating: :: UNTAXING PUZZLESUniversal App - Designed for iPhone and iPad Move from tile to tile to clear the board in this slightly too simple and easy puzzle game.   | Read more »
Breakdown Buddy Review
Breakdown Buddy Review By Jennifer Allen on August 21st, 2014 Our Rating: :: FLAWED CONCEPTiPhone App - Designed for the iPhone, compatible with the iPad There’s a good idea here, but Breakdown Buddy isn’t as useful as it tries to... | Read more »
jamstik, the Guitar You Can Take Everywh...
jamstik, the Guitar You Can Take Everywhere, is Now Available for Purchase Posted by Jessica Fisher on August 21st, 2014 [ permalink ] Zivix has announced that their guitar-in-your-pocket, | Read more »
Star Walk 2 - Guide to the Sky Day and N...
Star Walk 2 - Guide to the Sky Day and Night 1.0.0 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0.0 (iTunes) Description: The next generation of the best-selling Star Walk, winner of Apple Design Award, used by... | Read more »

Price Scanner via MacPrices.net

21-inch iMacs on sale for up to $150 off MSRP
B&H Photo has 21″ iMacs on sale for up to $150 off MSRP including free shipping plus NY sales tax only. B&H will also include a free copy of Parallels Desktop software: - 21″ 2.7GHz iMac: $... Read more
27-inch 3.2GHz iMac on sale for $1698, save $...
Abt has the 27″ 3.2GHz iMac on sale for $1698 including free shipping. Their price is $101 off MSRP. Read more
Mac Backup Guru 2.0 Drive Backup/Cloneing Uti...
Mac Backup Guru developer MacDaddy has released Mac Backup Guru 2.0, offering new and enhanced advanced features, such as bootable backups, synchronised volumes and folders, and a Snapshot mode that... Read more
Operate GE’s New Free-Standing KItchen Range...
Think you accidentally left the oven on? Switch it off while on the go. The new free-standing Profile™ Series gas and electric ranges are GE’s second cooking appliances, following their wall oven, to... Read more
Parallels Announces Parallels Desktop 10 for...
The no. 1-selling software for running Windows applications on a Mac becomes an even easier choice for millions of consumers and IT professionals worldwide with the launch of the most powerful... Read more
Apple now offering certified refurbished 2014...
 The Apple Store is now offering Apple Certified Refurbished 2014 MacBook Airs for up to $180 off the cost of new models. An Apple one-year warranty is included with each MacBook, and shipping is... Read more
Best Buy’s College Student Deals: $100 off Ma...
Take an additional $100 off all MacBooks and iMacs, $50 off iPad Airs and iPad minis, at Best Buy Online with their College Students Deals Savings, valid through September 6th. Anyone with a valid .... Read more
MacBook Airs on sale for $100 off MSRP, free...
B&H Photo has three 2014 MacBook Airs on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only. They also include free copies of Parallels Desktop and LoJack for Laptops... Read more
Razer Taipan Mouse For Gamers And Non-Gamers...
If you’re a serious gamer on either Mac or Windows PCs, a serious gaming mouse is a necessity for first-tier performance. However, even if like me you’re not much of a gamer, there’s still a strong... Read more
15-inch 2.2GHz MacBook Pro on sale for $1899,...
Adorama has the new 15″ 2.2GHz Retina MacBook Pro on sale for $1899 including free shipping plus NY & NJ sales tax only. Their price is $100 off MSRP, and it’s the lowest price available for this... Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** As more and more people discover Apple , they visit our stores seeking ways to incorporate our products into their lives. It's your job, as a Store Read more
Position Opening at *Apple* - Apple (United...
…Summary** As a Specialist, you help create the energy and excitement around Apple products, providing the right solutions and getting products into customers' hands. You Read more
Project Manager, *Apple* Financial Services...
**Job Summary** Apple Financial Services (AFS) offers consumers, businesses and educational institutions ways to finance Apple purchases. We work with national and Read more
*Apple* Solutions Consultant (ASC)- Retail S...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.