TweetFollow Us on Twitter

Doodats
Volume Number:5
Issue Number:9
Column Tag:C Workshop

Three Doodats

By Lee A. Neuse, Manassas, VA

Note: Source code files accompanying article are located on MacTech CD-ROM or source code disks.

[Lee Neuse started in the days you built them before programmed them. He was lured away from IBM compatibles to the Mac in 1982 and been there ever since. Currently, he is working for Computer Science Corporation designing and implementing Mac software as part of CSC research. His Mousehole handle is "Noisy".]

Three Doodats

Doodat -- a trivial problem guaranteed to make a programmer’s life miserable; from the expression “How did he do dat?”.

It seems like every programmer, at one time or another, is faced with the same dilemma: wanting to use a feature in a program, but not wanting to spend the time to figure out the technique. For example, we all know that a Balanced B-Tree index is wonderfully efficient, but how many of us really want to sit down and write the code? One solution is to start reading back issues of MacTutor, hoping that some kind soul has already published useable source code. Another is to scour public domain software for an author willing to impart knowledge in exchange for a shareware donation. Either way, it’s usually faster (and easier) to find and adapt someone else’s code instead of doing it yourself.

The purpose of ‘Doodats’ is to provide generic solutions to the little problems, so the programmer can spend his or her time working on the big problems (like what the program does).

Doodat #1

Problem: how to determine if the user has tried to abort something by pressing the Cmd-’.’ keys. EventAvail() returns only the first keystroke event in the queue, and the user may have pressed some other keys since the last keystroke event was read by the application. Either GetNextEvent() or WaitNextEvent() return all keystroke events, forcing the application to store them or ignore them (a Bad Thing). Moreover, if MultiFinder is running, calling any of these event-related traps may cause the application to be switched out, which could cause problems.

Solution: Doodat #1 is a routine called check_abort(), which directly scans the ToolBox’s internal event queue for Cmd-’.’ abort events.

The routine starts by setting a pointer to head of the event queue (stored in the system global EventQueue), then examining the next event in the queue. If the event is a Cmd-’.’ event, it is removed by calling Dequeue(), and the ‘found’ flag set. If the pointer does not match the event queue tail, it is advanced to the next event, otherwise, the function returns. This technique solves all of the problems posed by normal event processing:

1. It doesn’t affect any other keystroke events in the queue.

2. If the user has generated multiple aborts (by holding the keys down), it removes all of them.

3. It does not call EventAvail() or WaitNextEvent(), so no chance of being switched in or out under MultiFinder.

To use check_abort(), call it from within any place where the user might want to abort. For example:

/* 1 */

for (page = 1; page < last_page; page++)
 {
 /* print a page */
 if (check_abort())
 break;
 }

/*************************************************
**
** check_abort() - Lightspeed C Version
**
** This routine returns scans the low-level
** event queue in search of a Cmd-’.’ key event
** Each one found is removed from the event
** queue.
**
** In:  N/A
**
** Out: TRUE if Cmd-’.’ found, FALSE otherwise.
**
*/

Boolean
check_abort()
{
EvQElPtreq_p;
Boolean f_found = false;

/* start at head of internal queue */
eq_p = (EvQElPtr)(EventQueue.qHead);

while (true)
 {
 if ((eq_p->evtQWhat == keyDown ||
 (eq_p->evtQWhat == autoKey) &&
 (eq_p->evtQModifiers & cmdKey) &&
 (eq_p->evtQMessage & charCodeMask) == ‘.’)
 {
/* remove the event from the queue */
 Dequeue((QElemPtr)eq_p, &EventQueue);
 f_found = true;
 }
/* test for end of queue */
 if (eq_p == (EvQElPtr)EventQueue.qTail)
 break;

/* continue with next queue entry */
 eq_p = (EvQEl *)(eq_p->qLink);
 }
return(f_found);
}/* end of check_abort() */

Doodat #2

Problem: Many windows contain items such as lines, icons, pictures, or text strings that are there for decoration; these items don’t change in appearance, and clicking on them has no effect. While the code to draw these items is relatively simple, it is also very boring to write, and frequently quite lengthy. In addition, trying to figure out exactly which horizontal and vertical co-ordinates to use can be time-consuming and frustrating.

Solution: Doodat #2 is an attempt to save time (and code!) by making ResEdit and the Resource Manager do most of the work. This involves a two-step approach:

Step 1 is to use ResEdit (or any other Resource tool) to create a ‘DITL’ resource (Dialog Item List) that contains all of the items desired. ResEdit is particularly handy, as the items can be arranged visually within the window. The DITL resource may be created and edited normally, with all items being set to disabled. No Control or EditText items should be included (they will be ignored if you do), and the items may be in any order. The finished DITL resource is then included in the application’s resources for later use.

UserItems in the item list are handled in one of two ways: either as a dividing line or as frame. If the horizontal or vertical co-ordinates are equal, i.e. the boundary rectangle is empty, it is drawn as a 50% gray line. If the rectangle is not empty, it is drawn as a black frame.

Text items are drawn (left-justified) in whatever font the window’s port is using when draw_ditl() is called. Different text characteristics could be supplied by reserving the first few characters of the text string but that’s for another time.

Step 2 is to use the routine below called draw_ditl() to actually read in and draw the items within the window. This routine accepts the ID number of a DITL resource, reads the resource into memory, then traverses the item list, drawing each item accordingly. For draw_ditl() to work properly, the DITL resource must be present in the application’s resource fork (or in an open resource file), and the port set to the desired window.

draw_ditl() uses the following definitions and structure:

/* 2 */

#define NIL 0L

/* Test a pointer for validity */
#define VALID_PTR(p) ((long)(p) &&
 ((long)(p) & 1L) == NIL)

/* Test a handle for validity */
#define VALID_HNDL(h)(VALID_PTR(h) &&
 VALID_PTR((long)(*(h)) & 0x00FFFFFF))

typedef struct
 {
 Handle hndl;
 Rect   frame;
 unsigned char   type;
 unsigned char   length;
 short  data[];
 } ditl_list;

/*************************************************
**
** draw_ditl() - Lightspeed C Version
**
** This routine reads in and draws the items in a
** Dialog Item List (DITL) resource.
**
** In:  resource id of DITL
**
** Out: N/A
**
*/

void
draw_ditl(ditl_id)
short   ditl_id;
{
Handle  ditl_h;
ditl_list *ditl_p;
PenStatesave_pen;
short   d_type, offset, num_items;

ditl_h = GetResource(‘DITL’, ditl_id);
if (ResError() != noErr || !VALID_HNDL(ditl_h))
 return;

HLock(ditl_h);
/* don’t change pen behind the window’s back */
GetPenState(&save_pen);
PenNormal();
/* get the number of items in list */
num_items = *((short *)(*ditl_h)) + 1;
/* set pointer to first item in list */
ditl_p = (ditl_list *)((*ditl_h) + sizeof(short));
while  (num_items--)
 {
/* mask out the item disabled bit */
 switch (ditl_p->type & 0x7F)
 {
 case statText:
 TextBox((char *)ditl_p->data,
 ditl_p->length, &(ditl_p->frame),
 teJustLeft);
 break;
 
 case iconItem:
 ditl_p->hndl =
 GetIcon(ditl_p->data[0]);
 if (VALID_HNDL(ditl_p->hndl))
 {
 PlotIcon(&(ditl_p->frame),
 ditl_p->hndl);
 ReleaseResource(ditl_p->hndl);
 }
 break;
 
 case picItem:
 ditl_p->hndl = GetResource(‘PICT’,
 ditl_p->data[0]);
 if (VALID_HNDL(ditl_p->hndl))
 {
 DrawPicture((PicHandle)ditl_p->hndl,
 &(ditl_p->frame));
 ReleaseReource(ditl_p->hndl);
 }
 break;
 
 case userItem:
 if (EmptyRect(&(ditl_p->frame)))
 {
 PenPat(gray);
 MoveTo(ditl_p->frame.left,
 ditl_p->frame.top);
 LineTo(ditl_p->frame.right,
 ditl_p->frame.bottom);
 PenPat(black);
 }
 else
 FrameRect(&(ditl_p->frame));
 break;
 }
/* force offset to a word (even) boundary */
 if ((offset = ditl_p->length) & 1)
 offset++;
/* advance pointer to next item */
 ditl_p = (ditl_list *)((char *)ditl_p +
 sizeof(ditl_list) + offset);
 }

HUnlock(ditl_h);
ReleaseResource(ditl_h);
/* restore pen to original condition */
SetPenState(&save_pen);
}/* end of draw_ditl() */

Doodat #3

Problem: Sooner or later, an application is going to need to access a data file of some sort, with fixed-length or variable-length records, keys, and so forth. Using the Resource Manager as a Poor Man’s Database is a Bad Thing according to Apple, and not everyone can afford (or write) a full ISAM (Indexed Sequential Access Method) utility.

Solution: Doodat #3, which includes some primitive (but useful) indexing routines. If used properly, they can be used for indexing files, arrays, or be used for look-up tables, etc.

All of the routines are based on the idea of a simple index, made up of 1-n index entries. Each index entry is a key value and it’s associated data value, and is defined in the index_entry structure below. The key and data values are always handled in pairs: for any given key, there is only one data value (provided it exists). Duplicate keys are not allowed, and both key and data values are limited to numeric values. What the key and data values actually represent depends on the application, an obvious example would be relating a part number to an offset into a file.

Several different indices can be manipulated using the same routines, it is the application’s responsibility to determine which index to use. If the indexes are small and/or few in number, they could be manually rebuilt each time the application is executed. Alternately, they could be saved between sessions, either as data files, or as resources: all that is needed the memory block referenced by the index handle (use GetHandleSize() to find it’s size). An elegant solution would be to save any or all data file indices as resources in the data file’s resource fork, but that would limit the index size to 32K.

Adding a new key to an index (or updating an existing key) is done by the db_insert_key() function: a pointer to the index handle, a key value, and the data value associated with the key are all passed as parameters. If the index handle is NIL, a new handle is allocated, otherwise, the index is expanded by one index entry, and the new key added to the index in ascending order. If the key value already exists in the index, the data value is updated with the new value.

Once an index has keys inserted into it, db_get_key() can be used to search the index for a given key value. The routine expects an index handle and a key value, then performs a binary search on the index. If the key value is found, the data value associated with the key is returned, otherwise -1 is returned to signal failure.

There may be times when it is necessary to find a key’s location in the index, thus db_get_seq_key() accepts an index handle and an entry number, then returns the key value found at that entry. Once again, -1 is returned to signal failure if the entry number is less than 1 or greater than the number of keys. This routine can be used to sequentially read through an index (in ascending order), using the following code:

/* 3 */

long  w_key, key_value;

w_key = 1L;
while (true)
 {
 key_value = db_get_seq_key(my_index, w_key++);
 if (key_value == -1L)
 break;

 my_data = db_get_key(my_index, key_value);
/*
** process my_data here
*/
 }

Some possible extensions to these routines include modifying them to store a character pointer as the key, providing non-numeric keys. For small indexes, the entire data record could be embedded as part of the index_entry structure, and a pointer to the structure returned by db_get_key().

The routines db_get_key(), db_get_seq_key(), and db_insert_key() all utilize the following definitions and structure:

/* 4 */

#define NIL 0L
/* Test a pointer for validity */
#define VALID_PTR(p) ((long)(p) &&
 ((long)(p) & 1L) == NIL)

/* Test a handle for validity */
#define VALID_HNDL(h)(VALID_PTR(h) &&
 VALID_PTR((long)(*(h)) & 0x00FFFFFF))

typedef struct
 {
 unsigned long   key;
 unsigned long   data;
 } index_entry;

/************************************************
**
** db_get_key()
**
** This routine performs a binary search on a
** list of index entries
**
** In:  index_hndl Handle to index
** target key value to find
**
** Out: -1 if NOT found, data value otherwise
**
*/

long
db_get_key(index_hndl, target)
Handle  index_hndl;
register long  target;
{
register index_entry *i_ptr;
register long    mid, low, high;

if (VALID_HNDL(index_hndl))
 {
 low = 1L;
 high = GetHandleSize(index_hndl) /
 sizeof(index_entry);

 while (low <= high)
 {
/* calculate the mid point of list */
 mid = ((low + high) >> 1) - 1;
 i_ptr = *index_hndl + (mid *
 sizeof(index_entry));

 if (i_ptr->key > target)
/* too big, so look in lower half  */
 high = mid;
 else if (i_ptr->key < target)
/* too small, so look in upper half */
 low = mid + 2;
 else
/* hmmm, guess we found it  */
 return(i_ptr->data);
 }
 }
return(-1L);
}/* end of db_get_key() */

/************************************************
**
** db_get_seq_key()
**
** This routine reads a list of index entries,
** returning a key based on a sequential number
**
** In:  index_hndl Handle to index
** key_numkey number to return
**
** Out: -1 if NOT found, key value otherwise
**
*/

long db_get_seq_key(index_hndl, key_num)
Handle  index_hndl;
short   key_num;
{
index_entry *i_ptr;
long    result = -1L;
short   num_keys;

if (VALID_HNDL(index_hndl)
 {
/* count number of keys in index */
 num_keys = GetHandleSize(index_hndl) /
 sizeof(index_entry);
 if (--key_num < num_keys)
 {
/* calculate offset into the index */
 i_ptr = *index_hndl + (key_num *
 sizeof(index_entry));
 result = i_ptr->key;
 }
 }

return(result);
}/* end of db_get_seq_key() */

/************************************************
**
** db_insert_key()
**
** This routine inserts a key into an index.
**
** In:  index_hndl Handle to index
** target key value to insert
** data data value associated
** with the key
**
** Out: N/A
*/

void
db_insert_key(index_hndl, target, data)
Handle  *index_hndl;
long    target;
long    data;
{
register index_entry *i_ptr, *n_ptr;
register long    mid, low, high, i_size;

/* empty list is special case! */
if (!VALID_HNDL(*index_hndl))
 {
/* allocate new handle */
 *index_hndl = NewHandle(sizeof(index_entry));
 ((index_entry *)(**index_hndl))->key = target;
 ((index_entry *)(**index_hndl))->data = data;
 }
else
 {
 low = 1L;
 high = i_size = GetHandleSize(*index_hndl) /
 sizeof(index_entry);

 while (low <= high)
 {
/* calculate the mid point of list */
 mid = ((low + high) >> 1) - 1;
 i_ptr = *index_hndl + (mid *
 sizeof(index_entry));

 if (i_ptr->key > target)
/* too big, so look in lower half */
 high = mid;
 else if (i_ptr->key < target)
/* too small, so look in upper half */
 low = mid + 2;
 else
/* found it, so store new key value */
 i_ptr->data = data;
 }

/* extend handle by size of one entry*/
 SetHandleSize(*index_hndl, (i_size + 1) *
 sizeof(index_entry));
/* test for memory error here */
 n_ptr = i_ptr = **index_hndl + (mid * 
 sizeof(index_entry));
 memcpy(++n_ptr, i_ptr, (i_size - mid) *
 sizeof(index_entry));
/* do we insert as right or left? */
 if (i_ptr->key < target)
 i_ptr = n_ptr;
/* and move in the new key and data value */
 i_ptr->key = target;
 i_ptr->data = data;
 }
}/* end of db_insert_key() */

 
AAPL
$107.18
Apple Inc.
-0.16
MSFT
$46.18
Microsoft Corpora
-0.44
GOOG
$551.43
Google Inc.
+2.10

MacTech Search:
Community Search:

Software Updates via MacUpdate

Cocktail 8.0.1 - General maintenance and...
Cocktail is a general purpose utility for OS X that lets you clean, repair and optimize your Mac. It is a powerful digital toolset that helps hundreds of thousands of Mac users around the world get... Read more
LibreOffice 4.3.3.2 - Free Open Source o...
LibreOffice is an office suite (word processor, spreadsheet, presentations, drawing tool) compatible with other major office suites. The Document Foundation is coordinating development and... Read more
VMware Fusion 7.0.1 - Run Windows apps a...
VMware Fusion allows you to create a Virtual Machine on your Mac and run Windows (including Windows 8.1) and Windows software on your Mac. Run your favorite Windows applications alongside Mac... Read more
OneNote 15.3.2 - Free digital notebook f...
OneNote is your very own digital notebook. With OneNote, you can capture that flash of genius, that moment of inspiration, or that list of errands that's too important to forget. Whether you're at... Read more
Audio Hijack Pro 2.11.4 - Record and enh...
Audio Hijack Pro drastically changes the way you use audio on your computer, giving you the freedom to listen to audio when you want and how you want. Record and enhance any audio with Audio Hijack... Read more
Iridient Developer 3.0.0 beta 3 - Powerf...
Iridient Developer (was RAW Developer) is a powerful image conversion application designed specifically for OS X. Iridient Developer gives advanced photographers total control over every aspect of... Read more
TextWrangler 4.5.11 - Free general purpo...
TextWrangler is the powerful general purpose text editor, and Unix and server administrator's tool. Oh, and also, like the best things in life, it's free. TextWrangler is the "little brother" to... Read more
NeoFinder 6.6 - Catalog your external me...
NeoFinder (formerly CDFinder) rapidly organizes your data, either on external or internal disks, or any other volumes. It catalogs all your data, so you stay in control of your data archive or disk... Read more
Chromium 38.0.2125.111 - Fast and stable...
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all Internet users to experience the web. FreeSMUG-Free OpenSource Mac User Group build is... Read more
Default Folder X 4.6.11 - Enhances Open...
Default Folder X attaches a toolbar to the right side of the Open and Save dialogs in any OS X-native application. The toolbar gives you fast access to various folders and commands. You just click... Read more

Latest Forum Discussions

See All

Naailde the Witch Review
Naailde the Witch Review By Amy Solomon on October 30th, 2014 Our Rating: :: PITCH-PERFECT STORYTELLINGUniversal App - Designed for iPhone and iPad Marvelous storytelling, narration, and moving illustrations make this storybook... | Read more »
1st & Goal Review
1st & Goal Review By Andrew Fisher on October 30th, 2014 Our Rating: :: FOR THE D&D LOVING QBUniversal App - Designed for iPhone and iPad 1st & Goal is a board gamer’s football game, a football fan’s board game, and... | Read more »
French Developer Pated Unveils Seashine
French Developer Pated Unveils Seashine Posted by Ellis Spice on October 30th, 2014 [ permalink ] French one-man studio Pated has unveiled Seashine, “a poetic journey into the abyss.” Players take on the role of a jellyfish strugglin | Read more »
Agents of Storm: Tips, Tricks, and Strat...
Calling all agents: Would you like to see what we thought of this rather pretty base builder? Check out our Agents of Storm review! Have you downloaded Agents of Storm, been bowled over by the graphics, and aren’t quite sure what to do next? Never... | Read more »
Any.DO 2.0 Hopes to Help Manage Producti...
Any.DO 2.0 Hopes to Help Manage Productivity Posted by Ellis Spice on October 30th, 2014 [ permalink ] iPhone App - Designed for the iPhone, compatible with the iPad | Read more »
Base Busters Review
Base Busters Review By Jennifer Allen on October 30th, 2014 Our Rating: :: FUN BUT RESTRICTED MIXUniversal App - Designed for iPhone and iPad Mixing up two forms of tower defense gaming and collectible cards, Base Busters is a fun... | Read more »
Sumptus - Personal Expense Tracker in Yo...
Sumptus - Personal Expense Tracker in Your Pocket 1.0 Device: iOS iPhone Category: Finance Price: $3.99, Version: 1.0 (iTunes) Description: Sumptus - a personal finance assistant in your pocket. It’s an ultimate expense tracker... | Read more »
Meat Factory (Games)
Meat Factory 0.1 Device: iOS Universal Category: Games Price: $.99, Version: 0.1 (iTunes) Description: Meat factory harks back to the old days of the game and watch. Easy to pick up and play, but hard to score big. With cute visuals... | Read more »
Medford Asylum: Paranormal Case - Hidden...
Medford Asylum: Paranormal Case - Hidden Object Adventure (Full) 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: Uncover the mystery of Medford City asylum! | Read more »
Secret Files Sam Peters (Games)
Secret Files Sam Peters 1.0.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.0 (iTunes) Description: [ After the successful iOS release of Secret Files Tunguska, the acclaimed point and click adventure Secret Files... | Read more »

Price Scanner via MacPrices.net

Apple now offering refurbished 2014 15-inch M...
The Apple Store is now offering Apple Certified Refurbished 2014 15″ Retina MacBook Pros for up to $400 off the cost of new models. An Apple one-year warranty is included with each model, and... Read more
Apple drops prices on refurbished 2013 Retina...
The Apple Store has dropped prices on 2013 Apple Certified Refurbished 13″ and 15″ Retina MacBook Pros, with Retina models now available starting at $999. Apple’s one-year warranty is standard, and... Read more
New 2.8GHz Mac mini on sale for $949, save $5...
Abt Electronics has the new 2.8GHz Mac mini in stock and on sale for $949.05 including free shipping. Their price is $50 off MSRP, and it’s the lowest price available for this model from any reseller... Read more
Sale! 3.7GHz Quad Core Mac Pro available for...
 B&H Photo has the 3.7GHz Quad Core Mac Pro on sale for $2649 including free shipping plus NY sales tax only. Their price is $350 off MSRP, and it’s the lowest price for this model from any... Read more
Mujjo Steps Up The Game With Refined Touchscr...
Netherlands based Mujjo have just launched their Refined Touchscreen Gloves, stepping up their game. The gloves feature a updated elegant design that takes these knitted gloves to the next level. A... Read more
Sale! Preorder the new 27-inch 5K iMac for $2...
 Abt Electronics has the new 27″ 3.5GHz 5K iMac on sale and available for preorder for $2374.05 including free shipping. Their price is $125 off MSRP, and it’s the lowest price available for this... Read more
Simplex Solutions Inc. Brings Secure Web Surf...
New York based Simplex Solutions Inc. has announced the release and immediate availability of Private Browser 1.0, its revolutionary new secure web browser developed for iPhone, iPad and iPod touch... Read more
Save up to $180 off MSRP with an Apple refurb...
The Apple Store has Apple Certified Refurbished 2014 MacBook Airs available for up to $180 off the cost of new models. An Apple one-year warranty is included with each MacBook, and shipping is free.... Read more
Apple refurbished 2013 MacBook Pros available...
The Apple Store has Apple Certified Refurbished 13″ and 15″ MacBook Pros available starting at $929. Apple’s one-year warranty is standard, and shipping is free: - 13″ 2.5GHz MacBook Pros (4GB RAM/... Read more
What Post PC Era? – The Mac Bounces Back, Big...
Apple’s fiscal Q4 2014 was an all-time record quarter for Mac sales, with 5.5 million units shipped, representing nearly one million more sales (+21 percent, + 25 percent sequentially) than Apple... Read more

Jobs Board

*Apple* Solutions Consultant (ASC) - Apple I...
…important role that the ASC serves is that of providing an excellent Apple Customer Experience. Responsibilities include: * Promoting Apple products and solutions Read more
*Apple* Solutions Consultant (ASC) - Apple I...
…important role that the ASC serves is that of providing an excellent Apple Customer Experience. Responsibilities include: * Promoting Apple products and solutions Read more
*Apple* Solutions Consultant (ASC) - Apple I...
…important role that the ASC serves is that of providing an excellent Apple Customer Experience. Responsibilities include: * Promoting Apple products and solutions Read more
*Apple* Solutions Consultant - Apple Inc. (U...
…important role that the ASC serves is that of providing an excellent Apple Customer Experience. Responsibilities include: * Promoting Apple products and solutions Read more
*Apple* Solutions Consultant - Apple Inc. (U...
…important role that the ASC serves is that of providing an excellent Apple Customer Experience. Responsibilities include: * Promoting Apple products and solutions Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.