TweetFollow Us on Twitter

Template Application
Volume Number:1
Issue Number:2
Column Tag: C Workshop

“Template” Application

By Robert B. Denny

This month’s C Workshop presents a “template” application. Most Macintosh programs share a common overall structure, dictated by the operating system environment. The purpose of the template program is to give you a framework for developing your own applications. It will also be used as the basis for topics discussed in future C Workshops. The functions that do the actual work of the program have been “stubbed”.

Since “a program is worth a thousand words”, most of this month’s column is the program itself, sprinkled liberally with comments. Please take the time to study the program. But first, a few introductory words.

Some C Basics for the Macintosh

Many data structures that you’ll be working with are stored in the “heap”, dynamic memory. Most of these struc- tures are accessed by a “handle” rather than a pointer. A handle is a pointer to a pointer. Why this extra level of indirection?

The heap is used for almost everything. Code goes there. Resources go there (code is really a resource). Data structures allocated at run time go there. Nothing is preallocated. The memory manager is rather dumb about allocating and deallocating blocks of space in the heap.

As a result, the heap can (and does) get chopped up into small pieces. When someone makes a request for a block of space that exceeds the size of the largest free block, the memory manager compacts the heap. It moves blocks of data around in an effort to collect enough contiguous space to satisfy the request. Blocks that are eligible to be moved are called relocatable. Most Mac data structures fall into this class. You can control whether or not your own data structures are relocatable. The tradeoff should be obvious.

Relocatable data structures are accessed via handles so that your references remain valid if the structure is moved. The handle points to a master pointer which in turn points to the relocatable structure. If the structure is moved, the memory manager updates the master pointer and your handle reference remains valid. Obviously, the area containing the master pointers is not relocatable.

Accessing data structures defined by struct statements via handles isn’t too difficult. The example is shown in figure 1 below:

The expression assigns the value contained in the relocatable structure via its handle to “intval”. The only safe way to access relocatable structures is to use the double-indirect access shown above at all times. Do not attempt to cache the pointer (*foo_handle) at any time. To do so is to defeat the purpose of handle access.

Template Application

Now to the template application. It is written for the Consulair Mac C system and Toolkit. Changes to the details of the program will probably be necessary for other languages since there is little consistency in the toolbox interface.

/*
 * *************
 * *  TEMPL.H  *
 * *************
 *
 * Common stuff for template program
 *  (C) 1984, MacTech  by Robert B. Denny
 *
 * NOTE:Dependent on the menu                 
 *   structure defined in the resources.
 */

// Toolbox traps must start with ‘#’ now.
#Options -N

//
// Include Macintosh data structure 
// definitions.  These files are included 
// with the Mac C Toolkit, or from the 
// Stanford University Macintosh C 
//  Programming system (SuMacC).
//

#include  <MacDefs.H>
#include<QuickDraw.H>
#include<Control.H>
#include<Events.H>
#include<Menu.H>
#include<TextEdit.H>

#define MAX_WINDOWS8
#define MAX_MENUS8

#define TRUE1
#define FALSE    0
#define NULL0

/*
*  Each window requires a window                
*  control block to define it’s structure. 
*  Note which things are handles and           
*  which are pointers.
*
* wcb = Window Control Block
 */
struct wcb
 {
 WindowPtrwp;  // Pointer to window rec in heap
 Rect drag_rect; // Dragging limits
 Rect grow_rect; // Window size limits
 TEHandle te_handle; // Handle to textEdit rec in heap
 Point  te_origin; // Text origin
 ControlHandle vs_handle; // Vert scroller’s handle
 ControlHandle hs_handle; // Horiz scroller’s handle
 };

//
// Supress extern declarations in module 
// containing the real declarations.
//
#ifndef GLOB_DATA
extern struct wcb dw[MAX_WINDOWS];
extern struct wcb *dwp;   // --> Current doc-window
extern unsigned n_windows;// No. of open windows
extern EventRecord Event; // Our event record (duh)
extern short EvType; // Event result type
extern WindowPtr EvWindow;// Event window
/*
 * Array of menu handles 
 */
extern MenuHandle menus[];// Our menu contexts
#define APPLE    1
#define FILE2
#define EDIT3
#define OPTIONS  4
#endif

/*
 * Resource ID’s of menus in rsrc file.
 */
#define APPLE_ID 1
#define FILE_ID  256 
#define EDIT_ID  257
#define OPTIONS_ID 258 //Add more menu resource ID’s here

/*
 * File menu item numbers
 */

#define FM_EXIT  // This should reflect file menu rsrc

/*
 * Edit menu item numbers
 *
 * Note that SystemEdit expects the Edit    
 *  menu items as follows:
 *
 * 0: undo (** YES, zero-based **)
 * 1: --------
 * 2: cut 
 * 3:  copy
 * 4: paste
 *
 * The rest of the items may be chosen 
 *    at will by the application.
 */

#define EM_UNDO  1
#define EM_CUT 3
#define EM_COPY  4
#define EM_PASTE 5
#define EM_CLEAR 6

/*
 * Options menu assignments
 */
#define MM_EDIT_WINDOW  1
#define MM_SCRAWL_WINDOW  2
#define MM_MUSIC  4

/*
 *   Other resource ID’s
 */
#define ABOUT_ID 256
#define WINDOW_ID256

/*
 * Macro to hack the Point struct,               
 * composed of 2 short (16-bit) ints
 * into a long, which can be passed by         
 * value to toolbox routines.
 * Takes address of a Point and turns it      
 * into a scalar long.  NOTE
 * this generates NO runtime code.
 */
#define PtLong(ptr) *((long *)ptr)

MAIN PROGRAM

A Template Application in C

Template program for the C Workshop. Has hooks for multiple dynamically allocated windows (to be added in future columns), supports desk accessories, has a menu bar with 4 menus and an “about” dialog in the Apple menu. The program will eventually support multiple dynamically allocated text edit and drawing windows. The text edit windows will have scroll bar controls and resizing (“grow”) capability. Also, an interface to the sound system will be added. The components of this program are:

TMAIN.C This module, the main program & global data.

TMENU.C Menu handling functions, fig. 6.

TEMPL.H Common “include” file of definitions, fig. 4.

TEMPL.R RMAKER source for program resources, fig. 5.

TEMPL.LINK Linker command file, fig. 3.

TEMPL.JOB Exec command procedure to build template, fig. 2.

Additional modules will be added in future C Workshop columns. This program was written for the MAC C system by Consulair Corp. Changes will be needed for other C systems. Also, prerelease versions of MAC C and RMAKER may not work with this program. [Note: one or two obscure Mac C statements may have been changed in the current Mac C so that a change may be needed to fully compile this program using present Mac C systems. This program was written with an early version of Mac C. Any offending lines should be obvious at compile time. -Ed.]

/*
 * TMAIN.C - Template application
 * (c) 1984 MacTech by Robert B. Denny
 */
 *     GLOBALS DEFINITIONS
#define GLOB_DATA
#include <Templ.H>
/*
 Define window control block for window   management. See Templ.H file.
 */
struct wcb dw[MAX_WINDOWS];  // our windows
struct wcb *dwp = NULL; // --> Current window
unsigned n_windows = 0; // Number of open windows
EventRecord Event; // Our event record
short EvType;    // Event result type
WindowPtr EvWindow;// Event window
MenuHandle menus[MAX_MENUS]; // Our menus
 
/*
 *   MAIN PROGRAM  
 *
 * Link with MacCLib, which does 
 * Quickdraw and Window initialization.
 *
 */
main()
 {
 register WindowPtr wp; // Try to save space/time
 int i;
 #InitFonts();   // Not done in MacCLib ...
 #InitDialogs(0);// No restart function
 #OpenResFile(“\011TemplRsrc”);// Open resfile (Pstring)
 setup_menu();   // Set up our menus
 #TEInit(); // Initialize TextEdit
 #FlushEvents(-1,0); // Flush all events
 #InitCursor();  // Make arrow cursor
 for(i=0; i<MAX_WINDOWS; i++) // Mark all WCB’s free
 dw[i].wp = NULL;
 dwp = NULL;// No windows
 n_windows = 0;

 //   -- EVENT LOOP --
 // This is the “outer loop” of a typical    // application.  All event 
types
 // are dequeued, most are processed.  // Those not processed are ignored.
 // 
 while(TRUE)// Loop here forever
 {
 #SystemTask();  // Handle desk accessories
 // dwp always points to the WCB   //for the active (front) window.
 // If dwp = NULL, than it’s not   //”our” window.
 // (Is this possible??)

dwp = (struct wcb *)find_wcb(#FrontWindow());
if(dwp != NULL && dwp->te_handle != 0) // If active wind & text
#TEIdle(dwp->te_handle);  // Flash the insertion mark
if(!#GetNextEvent(-1, &Event)) // Process only our events
continue;
 switch(Event.what)// Dispatch on event type
 {
 case mouseDown: // Mouse click
 do_mouse();// Dispatch on mouse location
 break;
 case keyDown: // Keypress
 case autoKey:  // Repeat-key generator
 do_key();
 break;
 case updateEvt: // window needs refresh
EvWindow = (WindowPtr)Event.message; // Which window?
 upd_wind(EvWindow); // Do the update
 break;
 case activateEvt: // Activate/deactivate
EvWindow = (WindowPtr)Event.message; // Which window?
 if(Event.modifiers & 1) // If Activate
 act_wind(EvWindow); // Activate window
 else // If Deactivate
 deact_wind(EvWindow); // Deactivate window
 
// Additional cases for other event types 
 default: // Do nothing for other events
 }
 }
 //
 // -- END OF EVENT LOOP --
 //
 }

/*
 * *  LOCAL FUNCTIONS  *
 *     Handle mouse-down events
 */
do_mouse()
 {
 short window_part;// FindWindow result code //
 // Following fills in EvWindow with //--> window in which the click
 // occurred (or NULL if none).
 //
 window_part = #FindWindow(PtLong(&Event.where), &EvWindow);
 
 switch(window_part) // Dispatch on where clicked
 {
 case inMenuBar: do_menu(#MenuSelect(PtLong(&Event.where))); 
 break;
 case inSysWindow:
 #SystemClick(&Event, EvWindow);
 break;
 case inContent: // Click in content of a window
 #SelectWindow(EvWindow); // Activate window
 #SetPort(EvWindow); // Hook QuickDraw up
 break;
 case inDrag:
 #SelectWindow(EvWindow); // Activate 
 #SetPort(EvWindow); // Hook QuickDraw up 
 break;
 case inGoAway:  // Go-away handling
 break;
 case inGrow:  // Grow handling
 break;
// Add dispatches for other area types
 default:
 }
 }

/*
 *  - Handle keypress and command keys
 *     Handles edit command keys 
 */
do_key()
 {
 unsigned short ch;
 ch = (unsigned short)Event.message; // Isolate key codes
 if(Event.modifiers & cmdKey) // If command character
 do_menu(#MenuKey(ch)); // Try menu shortcut cmd
 }
// Stub functions
upd_wind(wp)
WindowPtr wp;
 {
 return(0);
 }
act_wind(wp)
WindowPtr wp;
 {
 return(0);
 }
deact_wind(wp)
WindowPtr wp;
 {
 return(0);
 }
find_wcb(wp)// Never one of our windows
WindowPtr wp;
 {
 return(0);
 }

MENU SUB-PROGRAM IN C

/*
 * TMenu.C - Handle menu selections for 
 * template program
 *
 *  (c) 1984, MacTutor  by Bob Denny
 */
#include<Templ.H>
/*
 * SETUP_MENU() - Initialize menu system 
 *
 * Fills in an array of menu handles.  Not     
*  used in this version of the program. 
 */
setup_menu()
 {
 #InitMenus();
 #InsertMenu(menus[APPLE] = (MenuHandle)#GetMenu(APPLE_ID), 0);
 #AddResMenu(menus[APPLE], ‘DRVR’);
 #InsertMenu(menus[FILE] = (MenuHandle)#GetMenu(FILE_ID), 0);
 #InsertMenu(menus[EDIT] = (MenuHandle)#GetMenu(EDIT_ID), 0);
 #InsertMenu(menus[OPTIONS] = (MenuHandle)#GetMenu(OPTIONS_ID), 0);
 #DrawMenuBar();
 }
 
/*
 * DO_MENU() - Handle menu selection
 *
 * Input:
 * Result longword from MenuSelect       
 *        or MenuKey
 */
do_menu(result)
unsigned result;
 {
 unsigned short menu_id; // Resource ID of selected menu
 unsigned short item_no; // Item number selected
 char item_name[64]; // Item name (for desk acc.)
 Ptr dp;// Dialog pointer for “about ...”
 unsigned short item_hit; // Dialog item that was hit 
 if(result == 0) // Just for safety with MenuKey
 return;// Ignore zero results
 menu_id = (short)#HiWord(result); // Use toolbox 
 item_no = (short)#LoWord(result);
 
 switch(menu_id)
 {
 case APPLE_ID: // “Apple” menu
 if(item_no > 1) // If desk accessory
 {
 #GetItem(menus[APPLE], item_no, item_name);
 #OpenDeskAcc(item_name);
 }
 else  // Our About ... dialog
 {
 dp = #GetNewDialog(ABOUT_ID, 0, -1); 
 // Bring in dialog to front
 #SetPort(dp); // Hook QuickDraw up to dialog
 #ModalDialog(0, &item_hit); // dialog item hit
 #DisposeDialog(dp); // Close & free heap 
 }
 break;

 case FILE_ID: // File menu
 if(item_no == FM_EXIT)
 #ExitToShell(); // Ugly exit
 break;
 
 case EDIT_ID:
 //
 // First we must hand off any   // desk-accessory edit commands.
 // Note the comments in Demo.H 
 // regarding implicit assumptions
 // in numbering items in Edit menu.
 //
 if(#SystemEdit(item_no - 1)) // Relies on item no.!!
 break;
 //
 // Do the requested edit function only      // if this is an editing 
window and there // is a window open.  For now, we have  // no windows, 
so we just return.
 //
 break;
 
 case OPTIONS_ID: // Options menu.
 switch(item_no)
 {
 case MM_MUSIC:
 play_tune();
 break;
 case MM_EDIT_WINDOW:
 edit_window();
 break;
 case MM_SCRAWL_WINDOW:
 scrawl_window();
 break;
 
 default:
 }
 break;
 
 default:
 }
 #HiliteMenu(0); // Turn off highlighted title
 }
// Stub functions
play_tune() // Make crude music -- demo driver 
 {
 return(0);
 }
edit_window()  // Create a new editing window
 {
 return(0);
 }
scrawl_window()  // Create a new “scrawling” window
 {
 return(0);
 }

Resource File

This is the RMAKER source for the Mac C template application. The dialog box will not come out right with the version of the RMAKER that I have. The \0D entries in the staticText item are supposed to be “hard” carriage returns in the text. Instead, they come out as “D”. To fix this, use the AlertDialog Editor on the file after building it to put the 2 carriage returns in and remove the “D”s. Perhaps RMAKER (or it’s successor) will work some day ...

The menu items for things that aren’t in the template (yet) have been dimmed. As things are filled in, you’ll have to edit this file to un-dim & thus activate the corresponding menu items. Note that the Edit menu is enabled to support SystemEdit editing in desk accessories.

* Templ.R  --  Resources for the 
*                     template program
*
*  (C) 1984, MacTech by R. B. Denny 

TemplRsrc
RSRCXXXX

TYPE WIND
  ,256
Please Wait ...
50 50 250 250
Visible GoAway
0
0

TYPE MENU
  ,1
\14
About Template ...
(-

  ,256
File
Quit

  ,257
Edit
(Can’t Undo
(-
Cut/X
Copy/C
Paste/V
Clear/D

  ,258
Options
(New Edit Window
(New Scrawl Window
(-
(Play a tune

TYPE DLOG
  ,256

54 145 203 376
Visible NoGoAway
1
0
256


TYPE DITL
  ,256
2

button
116 58 142 174
RESUME DEMO

staticText Disabled
9 9 105 228
This program was written as an example of native Macintosh ++ 
application programming in the C language, using Mac C. 
\0D \0D ++ 
Bob Denny            October, 1984

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Cocktail 8.3.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
QuarkXPress 11.0.0.0 - Desktop publishin...
With QuarkXPress, you can communicate in all the ways you need to -- and always look professional -- in print and digital media, all in a single tool. Features include: Easy to Use -- QuarkXPress is... Read more
A Better Finder Rename 9.50 - File, phot...
A Better Finder Rename is the most complete renaming solution available on the market today. That's why, since 1996, tens of thousands of hobbyists, professionals and businesses depend on A Better... Read more
PDFpenPro 7.1.1 - Advanced PDF toolkit f...
PDFpenPro allows users to edit PDF's easily. Add text, images and signatures. Fill out PDF forms. Merge or split PDF documents. Reorder and delete pages. Create fillable forms and tables of content... Read more
Garmin Express 4.0.18.0 - Manage your Ga...
Garmin Express is your essential tool for managing your Garmin devices. Update maps, golf courses and device software. You can even register your device. Update maps Update software Register your... Read more
jAlbum Pro 12.6.4 - Organize your digita...
jAlbum Pro has all the features you love in jAlbum, but comes with a commercial license. With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code!... Read more
jAlbum 12.6.4 - Create custom photo gall...
With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code! Beginner-friendly, with pro results Simply drag and drop photos into groups, choose a design... Read more
Microsoft Remote Desktop 8.0.16 - 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
Spotify 1.0.4.90. - Stream music, create...
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
djay Pro 1.1 - Transform your Mac into a...
djay Pro provides a complete toolkit for performing DJs. Its unique modern interface is built around a sophisticated integration with iTunes and Spotify, giving you instant access to millions of... Read more

Create Your Perfect Vacation Day With Ma...
The Make My Day app, by Lonely Planet, gives you access to a new series of mobile guidebooks that focus on some of the worlds most famous cities. [Read more] | Read more »
Jelly Reef (Games)
Jelly Reef 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: You are the ocean. Touch the sea with your fingers and guide jellyfish through a roguelike underwater world. | Read more »
This Week at 148Apps: April 20-24, 2015
The Apps of April How do you know what apps are worth your time and money? Just look to the review team at 148Apps. We sort through the chaos and find the apps you're looking for. The ones we love become Editor’s Choice, standing out above the many... | Read more »
The Dynamic Duo of Tile and Your Apple W...
If you often lose things like your wallet, keys, purse, or pants, Tile could be your new best friend. [Read more] | Read more »
Desktop Dungeons: Enhanced Edition is Co...
Desktop Dungeons, the puzzle roguelike game, is adventuring onto your mobile devices soon, giving you all the excitement of Desktop Dungeons wherever you go. [Read more] | Read more »
Now You Can Control ProCamera 8 With You...
ProCamera 8 + HDR, the photo, video, and editing app by Cocologics, recently updated to add Apple Watch controls and a few other fun functions. [Read more] | Read more »
Discover Your Reflexes With Minimalist G...
Discover O, BYOF Studios, may look simple at first with its' color matching premise and swipe controls, but as you speed up the task becomes more daunting. [Read more] | Read more »
Here's Another Roundup of Notable A...
Now that the Apple Watch is publically available (kind of), even more apps and games have been popping up for it. Some of them are updates to existing software, others are brand new. The main thing is that they're all for the Apple Watch, and if you... | Read more »
Use Batting Average and the Apple Watch...
Batting Average, by Pixolini, is designed to help you manage your statistics. Every time you go to bat, you can use your Apple Watch to track  your swings, strikes, and hits. [Read more] | Read more »
Celebrate Studio Pango's 3rd Annive...
It is time to party, Pangoland pals! Studio Pango is celebrating their 3rd birthday and their gift to you is a new update to Pangoland. [Read more] | Read more »

Price Scanner via MacPrices.net

Sale! New 11-inch 128GB MacBook Air for $799,...
Best Buy has the new 2015 11″ 1.6GHz/128GB MacBook Air on sale for $799.99. That’s $100 off MSRP, and it’s the lowest price available for this new model from any reseller. Choose free home shipping... Read more
Final day for Best Buy’s 4 Day Sale: Up to $3...
Best Buy has the new 2015 13″ 1.6GHz/128GB MacBook Air on sale for $799.99 through April 27th. That’s $200 off MSRP, and it’s the lowest price available for this new model from any reseller. Choose... Read more
College Student Deals: Additional $50 off Mac...
Take an additional $50 off all MacBooks and iMacs at Best Buy Online with their College Students Deals Savings, valid through May 9, 2015. Anyone with a valid .EDU email address can take advantage of... Read more
Save up to $300 on a new Mac, $30 on an iPad,...
Purchase a new Mac or iPad at The Apple Store for Education and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free,... Read more
Zoho Business Apps for Apple Watch Put Select...
Pleasanton, California based Zoho has launched Zoho Business Apps for Apple Watch, a line of apps that extends Zoho business applications to let users perform select functions from an Apple Watch.... Read more
Universal Stylus Initiative Launched to Creat...
OEMs, stylus and touch controller manufacturers have announced the launch of Universal Stylus Initiative (USI), a new organization formed to develop and promote an industry specification for an... Read more
Amazon Shopping App for Apple Watch
With the new Amazon shopping app for Apple Watch, Amazon customers with one of the wearable devices can simply tap the app on the watch to purchase items in seconds, or save an idea for later. The... Read more
Mac Pros on sale for up to $260 off MSRP
B&H Photo has Mac Pros on sale for up to $260 off MSRP. Shipping is free, and B&H charges sales tax in NY only: - 3.7GHz 4-core Mac Pro: $2799, $200 off MSRP - 3.5GHz 6-core Mac Pro: $3719.99... Read more
Apple refurbished Time Capsules available for...
The Apple Store has certified refurbished Time Capsules available for $100 off MSRP. Apple’s one-year warranty is included with each Time Capsule, and shipping is free: - 2TB Time Capsule: $199, $100... Read more
Intel Compute Stick: A New Mini-Computing For...
The Intel Compute Stick, a new pocket-sized computer based on a quad-core Intel Atom processor running Windows 8.1 with Bing, is available now through Intel Authorized Dealers across much of the... Read more

Jobs Board

*Apple* Support Technician IV - Jack Henry a...
Job Description Jack Henry & Associates is seeking an Apple Support Technician. This position while acting independently, ensures the proper day-to-day control of Read more
*Apple* iOS Specialist - TCML (United States...
AppleiOS Specialist Senior Apple /iOS Administrator/Engineer responsible for configuration and distribution of desktop, laptop and mobile devices to State Employees Read more
*Apple* Client Systems Solution Specialist -...
…drive revenue and profit in assigned sales segment and/or region specific to the Apple brand and product sets. This person will work directly with CDW Account Managers Read more
*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
*Apple* Support Technician IV - Jack Henry a...
Job Description Jack Henry & Associates is seeking an Apple Support Technician. This position while acting independently, ensures the proper day-to-day control of Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.