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

calibre 3.1.1 - Complete e-book library...
Calibre is a complete e-book library manager. Organize your collection, convert your books to multiple formats, and sync with all of your devices. Let Calibre be your multi-tasking digital librarian... Read more
Sparkle Pro 2.2 - $79.99
Sparkle Pro will change your mind if you thought building websites wasn't for you. Sparkle is the intuitive site builder that lets you create sites for your online portfolio, team or band pages, or... Read more
Spotify 1.0.57.474. - Stream music, crea...
Spotify is a streaming music service that gives you on-demand access to millions of songs. Whether you like driving rock, silky R&B, or grandiose classical music, Spotify's massive catalogue puts... Read more
beaTunes 5.0.1 - Organize your music col...
beaTunes is a full-featured music player and organizational tool for music collections. How well organized is your music library? Are your artists always spelled the same way? Any R.E.M. vs REM?... Read more
LibreOffice 5.3.4.2 - Free, open-source...
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
VOX 2.8.26 - Music player that supports...
VOX just sounds better! The beauty is in its simplicity, yet behind the minimal exterior lies a powerful music player with a ton of features and support for all audio formats you should ever need.... Read more
iFFmpeg 6.4.0 - Convert multimedia files...
iFFmpeg is a comprehensive media tool to convert movie, audio and media files between formats. The FFmpeg command line instructions can be very hard to master/understand, so iFFmpeg does all the hard... Read more
Beamer 3.3 - Stream any movie file from...
Beamer streams to your Apple TV.... Plays any movie file - Just like the popular desktop movie players, Beamer accepts all common formats, codecs and resolutions. AVI, MKV, MOV, MP4, WMV, FLV. To... Read more
jAlbum Pro 14.0 - Organize your digital...
jAlbum Pro has all the features you love in jAlbum, but comes with a commercial license. You can create gorgeous custom photo galleries for the Web without writing a line of code! Beginner-friendly... Read more
Apple Remote Desktop Client 3.9.3 - Clie...
Apple Remote Desktop Client is the best way to manage the Mac computers on your network. Distribute software, provide real-time online help to end users, create detailed software and hardware reports... Read more

Latest Forum Discussions

See All

This War of Mine gets a new ending and m...
This War of Mine just got a big new update, featuring free DLC that adds a new ending to the game, among other exciting changes. The update is celebrating the game's two-year release anniversary. Apart from the new ending, which will be quite... | Read more »
Summon eight new heroes in Fire Emblem H...
Nintendo keeps coming at us with Fire Emblem Heroes updates, and it doesn't look like that trend is stopping anytime soon. The folks behind the game have just announced the new War of the Clerics Voting Gauntlet, expected to start next Tuesday. [... | Read more »
The best deals on the App Store this wee...
iOS publishers are pulling out all the stops this week -- there's a huge number of seriously great games at discounted prices this week. Let's not waste any time and get right down to business. [Read more] | Read more »
The House of da Vinci (Games)
The House of da Vinci 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: Enter The House of Da Vinci, a new must-try 3D puzzle adventure game. Solve mechanical puzzles, discover hidden... | Read more »
Solve the disappearance of history’s gre...
Blue Brain Games invites you to indulge in an immersive hands-on 3D puzzle adventure in similar vein to The Room series, with its debut release The House of Da Vinci. Set during the historic period of the Italian Renaissance (when Leonardo himself... | Read more »
Age of Rivals (Games)
Age of Rivals 3.3 Device: iOS Universal Category: Games Price: $.99, Version: 3.3 (iTunes) Description: Deep civilization-building strategy in a fast-paced card game! | Read more »
Panthera Frontier (Games)
Panthera Frontier 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: | Read more »
Angry Birds Evolution beginner's gu...
Angry Birds changes things up a fair bit in its latest iteration, Angry Birds Evolution. The familiar sling-shot physics mechanics are still there, but the game now features team-based gameplay, RPG elements, and a new top-down view. With all of... | Read more »
Sega Forever is for the retro game fans
Sega is launching a new retro games service titled Sega Forever, in a move that's sure to delight games enthusiasts with a bit of nostalgia. Sega's releasing five classic games for free. The titles include Sonic the Hedgehog, Phantasy Star II,... | Read more »
The Little Acre (Games)
The Little Acre 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: | Read more »

Price Scanner via MacPrices.net

ABBYY TextGrabber 6 for iOS Implements Instan...
ABBYY has announced the release of TextGrabber 6.0.0, an important feature update to the company’s productivity app developed for iOS and Android devices. TextGrabber 6.0 now offers Real-Time... Read more
vPhone, First Smartphone That Can’t Be Lost,...
Austin, Texas based Hypori has introduced the vPhone, a virtual smartphone that affords every business user the benefits of separate work and personal phones, conveniently delivered on a single... Read more
Save this weekend with 2016 refurbished MacBo...
Apple has dropped prices on Certified Refurbished 2016 15″ and 13″ MacBook Pros by as much as $590 off original MSRP. An Apple one-year warranty is included with each model, and shipping is free: -... Read more
New 27-inch 3.4GHz iMac on sale for $1699, sa...
MacMall has the new 2017 27″ 3.4GHz iMac (MNE92LL/A) in stock and on sale for $1699 including free shipping. Their price is $100 off MSRP. Read more
Clearance 2016 MacBook Pros available for up...
B&H Photo has clearance 2016 13″ and 15″ MacBook Pros in stock today and on sale for up to $400 off original MSRP. Shipping is free, and B&H charges NY & NJ sales tax only: - 15″ 2.7GHz... Read more
Apple Ranks 9th In comScore Top 50 U.S. Digit...
comScore, Inc. has released its monthly ranking of U.S. online activity at the top digital media properties for May 2017 based on data from comScore Media Metrix Multi-Platform. * Entity has... Read more
10.5-inch iPad Pros available for up to $20 o...
B&H Photo has the new 2017 10.5″ iPad Pros available for up to $20 off MSRP including free shipping plus NY & NJ sales tax only: - 64GB iPad Pro WiFi: $649 - 256GB iPad Pro WiFi: $749 - 512GB... Read more
Three Off-The-Beaten-Track iOS Apps That Dese...
One of the great things about using iPads and iPhones is the vast selection of apps available for most anything you want or need to do. The three outlined in this article have been in my core app... Read more
Apple No. 1 Spot In Gartner Top 100 Vendors i...
Gartner, Inc. has unveiled the top global 100 vendors in IT in 2016 based on their revenue across IT (excluding communication services) and component market segments. In the Gartner Global Top 100:... Read more
Clearance iMacs available for up to $300 off...
B&H Photo has clearance 21″ and 27″ Apple iMacs available starting at $949, each including free shipping plus NY & NJ sales tax only: - 27″ 3.3GHz iMac 5K: $1999 $300 off original MSRP - 27″... Read more

Jobs Board

*Apple* News Product Marketing Mgr., Publish...
…organizational consensus on strategy and vision for publisher tools, authoring, and Apple News Format.Carries this strategy and vision across the organization to 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
Security Data Analyst - *Apple* Information...
…data sources need to be collected to allow Information Security to better protect Apple employees and customers from a wide range of threats.Act as the subject matter Read more
Lead *Apple* Solutions Consultant - Apple I...
…integrity, and trust.Success Metrics/Key Performance Indicators:Quantitative* Year over Year growth in Apple Product and Beyond the Box sales in the assigned Point of Read more
*Apple* Solutions Consultant till v%u00E5r...
…ethics, integrity, and trust.Success Metrics/Key Performance Indicators:QuantitativeYear over Year growth in Apple Product and Beyond the Box sales in the assigned Point Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.