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() */

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

OmniOutliner Pro 4.6 - Pro version of th...
OmniOutliner Pro is a flexible program for creating, collecting, and organizing information. Give your creativity a kick start by using an application that's actually designed to help you think. It's... Read more
Alfred 3.1 - Quick launcher for apps and...
Alfred is an award-winning productivity application for OS X. Alfred saves you time when you search for files online or on your Mac. Be more productive with hotkeys, keywords, and file actions at... Read more
OmniOutliner 4.6 - Organize your ideas,...
OmniOutliner is a flexible program for creating, collecting, and organizing information. Give your creativity a kick start by using an application that's actually designed to help you think. It's... Read more
Default Folder X 5.0.6 - Enhances Open a...
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 on... Read more
Adobe Creative Cloud 3.8.0.310 - Access...
Adobe Creative Cloud costs $19.99/month for a single app, or $49.99/month for the entire suite. Introducing Adobe Creative Cloud desktop applications, including Adobe Photoshop CC and Illustrator CC... Read more
MYStuff Pro 2.0.25 - Create inventories...
MYStuff Pro is the most flexible way to create detail-rich inventories for your home or small business. Add items to MYStuff by dragging and dropping existing information, uploading new images, or... Read more
Viber 6.2.0 - Send messages and make cal...
Viber lets you send free messages and make free calls to other Viber users, on any device and network, in any country! Viber syncs your contacts, messages and call history with your mobile device, so... Read more
Data Rescue 4.2.3 - Powerful hard drive...
Use Data Rescue to recover: crashed, corrupted or non-mounting hard drive deleted, damaged, or lost files reformatted or erased hard drive One powerful new feature found in Data Rescue 4 is... Read more
Microsoft Remote Desktop 8.0.34 - Connec...
With Microsoft Remote Desktop, you can connect to a remote PC and your work resources from almost anywhere. Experience the power of Windows with RemoteFX in a Remote Desktop client designed to help... Read more
Microsoft Remote Desktop 8.0.34 - Connec...
With Microsoft Remote Desktop, you can connect to a remote PC and your work resources from almost anywhere. Experience the power of Windows with RemoteFX in a Remote Desktop client designed to help... Read more

Find out the story behind League of Ange...
If you’re looking for a new thrilling MMORPG to play with your friends then you’ll be excited to hear that there is a sequel to one of the most well known titles in the genre – namely League of Angels 2. With a brand new 3D engine offering... | Read more »
Naruto Shippuden: Ultimate Ninja Blazing...
I'm not sure if it's possible to say you are an anime fan but also never have seen one episode of Naruto. If it is, then I resemble that remark, and if not, I offer a hearty apology. [Read more] | Read more »
5 mobile games that let you explore spac...
No Man's Sky hasn't exactly turned out to be everything it was promised. Though its core concept of exploring an unimaginably vast universe of different planets is an intriguing one, the execution has left many PS4 and PC gamers feeling like they... | Read more »
Mummy madness in new action game Tomb He...
Hot on the tail of Bump Hero, ZPlay is giving gamers another reason to get screen bashing with a brand new release. Tomb Heroes is a challenging action game in which you battle enemies in various tombs around the world. You can select from nine... | Read more »
Siralim 2 (RPG / Roguelike) (Games)
Siralim 2 (RPG / Roguelike) 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: Siralim 2 is an old-school monster catching RPG. Summon and customize hundreds of creatures to fight for you as... | Read more »
Clean Text (Productivity)
Clean Text 1.0 Device: iOS Universal Category: Productivity Price: $3.99, Version: 1.0 (iTunes) Description: | Read more »
Gemini - A Journey of Two Stars (Games)
Gemini - A Journey of Two Stars 1.0.1 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.1 (iTunes) Description: *** SPECIAL LAUNCH SALE: $2.99 (25% off) *** "A mesmerizing and unexpectedly emotional journey." -- Los... | Read more »
How to get four NFL superstars for your...
Even though you're probably well on your way to building a top notch squad for the new season in Madden NFL Mobile, let's say you could beef it up by adding Rob Gronkowski, Antonio Brown, Von Miller, and Todd Gurley to your roster. That's... | Read more »
Cartoon Network Superstar Soccer: Goal!!...
Cartoon Network Superstar Soccer: Goal!!! – Multiplayer Sports Game Starring Your Favorite Characters 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Become a soccer superstar with your... | Read more »
NFL Huddle: What's new in Topps NFL...
Can you smell that? It's the scent of pigskin in the air, which either means that cliches be damned, pigs are flying in your neck of the woods, or the new NFL season is right around the corner. [Read more] | Read more »

Price Scanner via MacPrices.net

RESCUECOM 2016 Semi-Annual Computer Reliabili...
The beginning of a new school year is upon us again, in which students and parents have some very important choices to make, often including the purchase of a computer or tablet. Whether you are... Read more
VRS Design Damda Glide Series iPhone 7 and 7...
What makes the Damda Glide Series for the iPhone 7 and iPhone 7 Plus special? Case maker VRS Design says its Damda Glide Series is the first mobile case to incorporate a semi-automatic mechanism for... Read more
Apple refurbished iMacs available for up to $...
Apple has Certified Refurbished 2015 21″ & 27″ iMacs available for up to $350 off MSRP. Apple’s one-year warranty is standard, and shipping is free. The following models are available: - 21″ 3.... Read more
Clearance 2015 13-inch MacBook Airs available...
B&H Photo has clearance 2015 13″ MacBook Airs available for $350 off original MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 1.6GHz/4GB/128GB MacBook Air (MJVE2LL/A): $829... Read more
Check Apple prices on any device with the iTr...
MacPrices is proud to offer readers a free iOS app (iPhones, iPads, & iPod touch) and Android app (Google Play and Amazon App Store) called iTracx, which allows you to glance at today’s lowest... Read more
Save $120 with Apple refurbished Time Capsule...
Apple has certified refurbished Time Capsules available for $120 off MSRP. Apple’s one-year warranty is included with each Time Capsule, and shipping is free: - 2TB Time Capsule: $179, $120 off (not... Read more
9-inch 32GB iPad Pros on sale for $70 off MSR...
B&H Photo has 9″ 32GB WiFi Apple iPad Pros on sale for $70 off MSRP, each including free shipping. B&H charges sales tax in NY only: - 9″ Space Gray 32GB WiFi iPad Pro: $529 $70 off MSRP - 9... Read more
Mac minis on sale for up to $140 off MSRP
Adorama has Mac minis on sale for up to $100 off MSRP including free shipping plus NY & NJ sales tax only: - 1.4GHz Mac mini: $449 $50 off MSRP - 2.6GHz Mac mini: $649 $50 off MSRP Amazon has the... Read more
Back To School with OtterBox Essentials
Back to school means back to an environment that is tough on tech. OtterBox has the back to school essentials you need to keep tech safe from drops, bumps, scratches and hallway havoc. Check out the... Read more
VRS Design Releases New iPhone 7 Plus Case Li...
With a device as large and costly as the iPhone 7 Plus, it is primal instinct to protect it from potential damage. According to a study by SquareTrade in 2012, iPhone damages cost Americans roughly $... Read more

Jobs Board

*Apple* Solutions Consultant - Apple (United...
# Apple Solutions Consultant Job Number: 51218354 Fredericksburg, Virginia, United States Posted: Aug. 18, 2016 Weekly Hours: 40.00 **Job Summary** As an Apple Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* /Mac Support Engineer - GFI Digital,...
FI Digital, Inc. is currently seeking candidates for a full time Apple Support Engineer to add to our Maryland Heights, Missouri IT team. Candidates must be dynamic Read more
*Apple* Solutions Consultant - Apple (United...
Apple Solutions ConsultantJob Number: 51218534Pleasant Hill, California, United StatesPosted: Aug. 18, 2016Weekly Hours: 40.00Job SummaryAs an Apple Solutions Read more
*Apple* Solutions Consultant - Apple (United...
# Apple Solutions Consultant Job Number: 51443201 Mishawaka, Indiana, United States Posted: Aug. 25, 2016 Weekly Hours: 40.00 **Job Summary** As an Apple Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.