TweetFollow Us on Twitter

Structures, Event Loop
Volume Number:2
Issue Number:6
Column Tag:The ABC's of C

Structures And The Event Loop

By Bob Gordon, Apropos Publications, Minneapolis, MN

Beginning this month, we will start following the chapters in the Using the Macintosh Toolbox with C book. This means we're will be learning about C and the Macintosh at the same time. While this is probably not the optimum way to learn a language, it means we can explore features of the language and the Mac and have a lot of time to play around and make mistakes. As you will see from this month's effort, I am not afraid to make lots of mistakes.

We are going to start right away with a program that demonstrates a bit about the Event Manager. Events are a critical component to the way Macintosh software functions. They are not visible like windows or pull-down menus, but they occupy a central location in most applications nonetheless.

From the point of view of the Event Manager, Macintosh program spend most of their time sitting around waiting for events. Events can come from the keyboard, the mouse, disk drives, the Window Manager, et cetera, as well as your application.

Structures

For the moment, we won't worry too much about how the Event Manager gives you an event. Instead, we'll use the event to examine an important C data construct called a structure. A structure is a collection of variables usually of different types organized under a single name (loosely paraphrased from K&R). An event from a software point of view is a structure:

 struct ER
 {short what;  /* kind of event */
  long  message; /* event info */
  long  when;  /* time of event */
  Point where; /* mouse location */
  short modifiers; /* other info */
 };

The variables collected together in the structure are members.

A structure declaration (as we have above) does not reserve any memory. We still need to define a variable:

 struct ER    event;

defines the variable, event, to be of type ER. Now, when the Event Manager gives us an event, we can examine its members to determine what to do. To access the members of a structure, use a period between the variable name and the member name:

 event.what

At this point, let us look more closely at the where member. It is obviously not one of the standard C types. It is in fact another structure:

 struct pt
 {short  v; /* vertical location */
  short  h; /* horizontal location */
 };

So structures may be nested in other structures (you can also have arrays of structures).

You noticed that I defined the structure "pt" not "Point." When we defined the event variable, above, we wrote struct ER event. C requires that you let it know each time you are dealing with a structure. Writing struct all over your programs can be a drag as well as making them less readable. C has a couple of ways to deal with this problem. One is the typedef, which is way of providing a new name for a type. Point then becomes:

 typdef struct pt   Point;

The other technique is to use the preprocessor define feature:

 #define EventRecord   struct ER

Both of these techniques will increase the clarity of our code. The typedef is preferred because it is actually a part of the compiler and can deal with certain situations that can confuse the lexical substitutions of the preprocessor. Some micro C compilers do not include typedefs, however.

Now that we have defined the EventRecord, we can get an event from the Event Manager and see what to do with it.

Switch Statement

The first thing to do is decide what kind of event it is (from the what member), and then take appropriate action. The clearest way to do this in C is with the switch or case statement (C calls it switch, but many C programmers call it a case statement). The switch is a multi-way branch:

 switch (integer expression)
 {
 case constant1 : code;
                                      break;
   case constant2 : more code;
                                      break;
 default                   : code;
                                      break;
 }

The break statements are needed to keep the code from falling through the cases. Without the break, if the expression matched constant2, it would continue execution with the default code. The break forces execution to continue after the closing }. The default is chosen if none of the other cases match. By the way, you can have several constants that match one section of code. Each is preceded by case and followed by a colon. In effect, they fall through to the first code to execute.

A Program that Demonstrates the Event Manager

/* Event Manager Demonstrator */
#include"stdio.h"
#include"MacCDefs.h"
#include"Events.h"

main()  /* This may look silly, but in      */
 { /* subsequent programs we will have */
 /* initialization routines up here. */
 mainloop();
 }
 
mainloop()
 {
 EventRecordevent; 
 while (True)
 {
 if (GetNextEvent(everyEvent,&event))
 switch (event.what)
 {
 case mouseDown:  printf("\nmouse down");
 break;
 case mouseUp:  printf("\nmouse up");
 break;
 case keyDown:   printf("\nkey down");
 break;
 case keyUp: printf("\nkey up");
 break;
 case autoKey:   printf("\nautokey");
 return;
  break;
 case updateEvt: break;
 case diskEvt:   printf("\ndisk event");
  break;
 case activateEvt: break;
 case networkEvt:  break;
 case driverEvt  : break;
 case nullEvent: break;
 }
 }
 }

GetNextEvent() is the Event Manager routine that returns the next event record each time its called. If there are no events to return, it returns the Null Event.

All the constants (nullEvent, mouseUp, et cetera) and the EventRecord structure are defined in Events.h. I recommend you take a look at the copy that comes with your compiler.

The program exits on an autokey event. To stop the program, simply hold a key down.

The first parameter to GetNextEvent() is the event mask. With it, you can select the events to which you wish to respond. It's a bit mapped mask; you can combine events by adding the constants defined in events.h together. EveryEvent is all 1 bits (-1 decimal).

You will probably not see the key up event. It is generated when you release a key. It took me awhile to find out why I wasn't seeing it, but I finally took a look at Inside Macintosh.

There is a second event mask that controls which events get entered into the event queue. Since GetNextEvent() gets events from the queue, if an event is masked out, GetNextEvent() will never be able to return it. This event mask is initialized to:

 everyEvent - keyUpMask

so it will not even post key up events. There is a function, SetEventMask(), that will set this, but it is apparently not included in Mac C.

Some Things to do

This program is very brief, but you can easily add a few lines to get a better feel of how the Event Manager works and how to use some C functions. Try examining the where field on each event. Remember this is a Point structure. The message and modifier fields provide essential information for some events, especially key events. Print these out as well.

There are a number of other functions in the Event Manager. They allow reading the mouse, keyboard, and time without waiting for an event. There is also a function to read the event queue that leaves the event in the queue.

We will not do any more with the Event Manager at this time, but we will use it in probably every program we write.

Finally, if anyone is reading along, I would appreciate hearing from you. Let me know if this is useful or if you have an idea for a short program we can do in the column.

 
AAPL
$99.80
Apple Inc.
-1.83
MSFT
$46.49
Microsoft Corpora
+0.25
GOOG
$576.89
Google Inc.
+3.79

MacTech Search:
Community Search:

Software Updates via MacUpdate

Adobe Acrobat Pro 11.0.09 - Powerful PDF...
Adobe Acrobat allows users to communicate and collaborate more effectively and securely. Unify a wide range of content in a single organized PDF Portfolio. Collaborate through electronic document... Read more
Adobe Reader 11.0.09 - View PDF document...
Adobe Reader allows users to view PDF documents. You may not know what a PDF file is, but you've probably come across one at some point. PDF files are used by companies and even the IRS to... Read more
iFFmpeg 4.6.1 - Convert multimedia files...
iFFmpeg is a graphical front-end for FFmpeg, a command-line tool used to convert multimedia files between formats. The command line instructions can be very hard to master/understand, so iFFmpeg does... Read more
NTFS 11.3.62 - Provides full read and wr...
Paragon NTFS breaks down the barriers between Windows and OS X. Paragon NTFS effectively solves the communication problems between the Mac system and NTFS, providing full read and write access to... Read more
OS X Yosemite 10.10 DP8 - Developer Prev...
Note: This is a Developer Preview. You must be a registered Apple Mac Developer to download this update. You can also sign up for the free OS X Beta Program to download and preview public beta... Read more
FotoMagico 4.5 - Powerful slideshow crea...
FotoMagico lets you create professional slideshows from your photos and music with just a few, simple mouse clicks. It sports a very clean and intuitive yet powerful user interface. High image... Read more
Screenshot Path 1.2.1 - Change the defau...
Screenshot Path lets you change the folder where OS X saves screenshots. Screenshots are saved by default to the user’s desktop. This is handy for the occasional screenshot but those looking to take... Read more
Fantastical 1.3.16 - Create calendar eve...
Fantastical is the Mac calendar you'll actually enjoy using. Creating an event with Fantastical is quick, easy, and fun: Open Fantastical with a single click or keystroke Type in your event details... Read more
GIMP 2.8.14 - Powerful, free image editi...
GIMP is a multi-platform photo manipulation tool. GIMP is an acronym for GNU Image Manipulation Program. The GIMP is suitable for a variety of image manipulation tasks, including photo retouching,... Read more
HoudahSpot 3.9.3 - Advanced front-end fo...
HoudahSpot is an advanced file search tool built upon MacOS X Spotlight. Spotlight unleashed Create detailed queries to locate the exact file you need Narrow down searches. Zero in on files Save... Read more

Latest Forum Discussions

See All

Hyper Trip Review
Hyper Trip Review By Jennifer Allen on September 16th, 2014 Our Rating: :: HYPER TWITCHYUniversal App - Designed for iPhone and iPad Tough and unforgiving, Hyper Trip is a bit like Snake – if Snake was really harsh.   | Read more »
Collectible Card Game Earthcore: Shatter...
Collectible Card Game Earthcore: Shattered Elements is Set to Arrive on iOS in 2015 Posted by Ellis Spice on September 16th, 2014 [ permalink ] Polish developers | Read more »
Boogey Boy Review
Boogey Boy Review By Jennifer Allen on September 16th, 2014 Our Rating: :: PRETTY BUT BASICUniversal App - Designed for iPhone and iPad It looks delightful but lack of Game Center support and more variety really affects the fun... | Read more »
Vizzywig 4K (Photography)
Vizzywig 4K 1.0 Device: iOS iPhone Category: Photography Price: $999.99, Version: 1.0 (iTunes) Description: REQUIRES: iOS 7 on iPhone 5S with 32GB or 64GB. (Do not use iOS 8)The world's FIRST mobile 4K video capture, editing and... | Read more »
The Sleeping Prince Review
The Sleeping Prince Review By Jennifer Allen on September 15th, 2014 Our Rating: :: RESTRICTIVE KINGDOM SAVINGUniversal App - Designed for iPhone and iPad The Sleeping Prince looks and feels great to play, but its lack of peril and... | Read more »
It Came From Canada: Terra Battle
In some way or another, most Japanese RPGs owe something to Final Fantasy. But with Terra Battle, the now-common mix of Western medieval fantasy with Eastern anime aesthetic feels earned. After all, its developer, Mistwalker, was founded by the... | Read more »
Five Nights at Freddy’s Review
Five Nights at Freddy’s Review By Rob Thomas on September 15th, 2014 Our Rating: :: FIVE FRIGHTS AT FREDDY'SUniversal App - Designed for iPhone and iPad Can you survive five nights as the new night watchman of Freddy Fazbear’s... | Read more »
Phantom Rift Review
Phantom Rift Review By Nadia Oxford on September 15th, 2014 Our Rating: :: FRIENDLY PHANTOMUniversal App - Designed for iPhone and iPad Despite a snag here and there, Phantom Rift is a well-crafted and imaginative adventure RPG.   | Read more »
Phantom Rift – Tips, Tricks, Strategies,...
Hello, Wanderers: | Read more »
Meet the Newest Character for Temple Run...
Meet the Newest Character for Temple Run 2, from National Geographic Kids’ Action-Adventure Book Posted by Jessica Fisher on September 15th, 2014 [ | Read more »

Price Scanner via MacPrices.net

Free GIMP Professional Grade Graphics App Ver...
The latest 2.8.14 version of the oddly-named GIMP (acronym for: GNU Image Manipulation Program) open source, high-end image editing and creation alternative to Adobe’s Photoshop and refuge from... Read more
10% off iPhone 6 and 6 Plus Otterbox cases
Get 10% off on popular Otterbox iPhone 6 and iPhone 6 Plus cases at MacMall through September 19th. Use code OTTERBOX10 to see the discount. Read more
15-inch MacBook Pros on sale for up to $125 o...
Amazon has the new 2014 15″ Retina MacBook Pros on sale for up to $125 off MSRP including free shipping: - 15″ 2.2GHz Retina MacBook Pro: $1899.99 save $100 - 15″ 2.5GHz Retina MacBook Pro: $2374... Read more
27-inch 3.2GHz iMac on sale for $1698, $101 o...
Abt has the 27″ 3.2GHz iMac on sale for $1698 including free shipping. Their price is $101 off MSRP. Read more
More To Making A Larger iPad Than Expanded Sc...
CNET’s Ross Rubin has posted a thoughtful analysis of prospects for a larger display iPad Pro, noting that Microsoft and Samsung currently have the large-display touchscreen tablet category to... Read more
SwiftKey Keyboard Finally Coming To iPhone An...
At the TechCrunch Disrupt event in San Francisco, Swiftkey unveiled the first details about SwiftKey Keyboard for iPhone, iPad & iPod touch. SwiftKey’s philosophy is that you should be able to... Read more
Save $75 on the 16GB iPad mini with Retina Di...
Best Buy has the 16GB iPad mini with Retina Display on sale for $324.99 on their online store for a limited time. Their price is $75 off MSRP, and it’s the lowest price available for this mini.... Read more
21-inch 1.4GHz iMac on sale for $979, $120 of...
B&H Photo has the new 21″ 1.4GHz iMac on sale for $979.99 including free shipping plus NY sales tax only. Their price is $120 off MSRP. B&H will also include free copies of Parallels Desktop... Read more
Apple restocks refurbished 21-inch 1.4GHz iMa...
The Apple Store has restocked Apple Certified Refurbished 21″ 1.4GHz iMacs for $929 including free shipping plus Apple’s standard one-year warranty. Their price is $170 off the cost of new models,... Read more
13-inch 2.6GHz/256GB Retina MacBook Pro on sa...
Adorama has the 13″ 2.6GHz/256GB Retina MacBook Pro on sale for $1379 including free shipping plus NY & NJ sales tax only. Their price is $120 off MSRP, and it’s the lowest price available for... Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*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* 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* 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* 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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.