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.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Firetask Pro 4.2.2 - Innovative task man...
Firetask Pro uniquely combines the advantages of classical priority-and-due-date-based task management with GTD. Stay focused and on top of your commitments - Firetask Pro's "Today" view shows all... Read more
Bookends 13.4.3 - Reference management a...
Bookends is a full-featured bibliography/reference and information-management system for students and professionals. Bookends uses the cloud to sync reference libraries on all the Macs you use.... Read more
LibreOffice 6.4.5.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
Thunderbird 68.10.0 - Email client from...
As of July 2012, Thunderbird has transitioned to a new governance model, with new features being developed by the broader free software and open source community, and security fixes and improvements... Read more
Firefox 78.0.1 - Fast, safe Web browser.
Firefox offers a fast, safe Web browsing experience. Browse quickly, securely, and effortlessly. With its industry-leading features, Firefox is the choice of Web development professionals and casual... Read more
BetterTouchTool 3.389 - Customize multi-...
BetterTouchTool adds many new, fully customizable gestures to the Magic Mouse, Multi-Touch MacBook trackpad, and Magic Trackpad. These gestures are customizable: Magic Mouse: Pinch in / out (zoom)... Read more
Slack 4.7.0 - Collaborative communicatio...
Slack brings team communication and collaboration into one place so you can get more work done, whether you belong to a large enterprise or a small business. Check off your to-do list and move your... Read more
OsiriX Lite 11.0.3 - 3D medical image pr...
OsiriX Lite is an image processing software dedicated to DICOM images (".dcm" / ".DCM" extension) produced by medical equipment (MRI, CT, PET, PET-CT, ...) and confocal microscopy (LSM and BioRAD-PIC... Read more
Wireshark 3.2.5 - Network protocol analy...
Wireshark is one of the world's foremost network protocol analyzers, and is the standard in many parts of the industry. It is the continuation of a project that started in 1998. Hundreds of... Read more
Dabble 1.6.1 - Organize your manuscript,...
Dabble organizes your manuscript, story notes, and plot. Dabble simplifies the story, leaving more room in your brain to create, which is what being a writer is really about. Organize your story.... Read more

Latest Forum Discussions

See All

Pokemon Go's July Community Day wil...
Pokemon Go developers have announced the details concerning the upcoming Gastly Community Day. This particular event was selected by the players of the game after the Gas Pokemon came in second place after a poll that decided which Pokemon would... | Read more »
Clash Royale: The Road to Legendary Aren...
Supercell recently celebrated its 10th anniversary and their best title, Clash Royale, is as good as it's ever been. Even for lapsed players, returning to the game is as easy as can be. If you want to join us in picking the game back up, we've put... | Read more »
Detective Di is a point-and-click murder...
Detective Di is a point-and-click murder mystery set in Tang Dynasty-era China. You'll take on the role of China's best-known investigator, Di Renjie, as he solves a series of grisly murders that will ultimately lead him on a collision course with... | Read more »
Dissidia Final Fantasy Opera Omnia is se...
Dissidia Final Fantasy Opera Omnia, one of Square Enix's many popular mobile RPGs, has announced a plethora of in-game events that are set to take place over the summer. This will include several rewards, Free Multi Draws and more. [Read more] | Read more »
Sphaze is a neat-looking puzzler where y...
Sphaze is a neat-looking puzzler where you'll work to guide robots through increasingly elaborate mazes. It's set in a visually distinct world that's equal parts fantasy and sci-fi, and it's finally launched today for iOS and Android devices. [... | Read more »
Apple Arcade is in trouble
Yesterday, Bloomberg reported that Apple is disappointed in the performance of Apple Arcade and will be shifting their approach to the service by focusing on games that can retain subscribers and canceling other upcoming releases that don't fit... | Read more »
Pixel Petz, an inventive platform for de...
Pixel Petz has built up a sizeable player base thanks to its layered, easy-to-understand creative tools and friendly social experience. It revolves around designing, trading, and playing with a unique collection of pixel art pets, and it's out now... | Read more »
The King of Fighters Allstar's late...
The King of Fighters ALLSTAR, Netmarble's popular action RPG, has once again been updated with a plethora of new content. This includes battle cards, events and 21 new fighters, which increases the already sizeable roster even more. [Read more] | Read more »
Romancing SaGa Re;univerSe, the mobile s...
Square Enix latest mobile spin-off Romancing SaGa Re;univerSe is available now globally for both iOS and Android. It initially launched in Japan back in 2018 where it's proven to be incredibly popular, so now folks in the West can finally see what... | Read more »
Away: Journey to the Unexpected is a sto...
Away: Journey to the Unexpected looks really quite lovely. Stylish, cute, and clearly heavily inspired by Japanese animation, it's amongst the best-looking mobile games on the horizon. Developed by a two-person team, this story-driven rogue-lite... | Read more »

Price Scanner via MacPrices.net

July 4th Sale: Woot offers wide range of Macs...
Amazon-owned Woot is blowing out a wide range of Apple Macs and iPads for July 4th staring at $279 and ranging up to just over $1000. Models vary from older iPads and 11″ MacBook Airs to some newer... Read more
Apple Pro Display XDR with Nano-Texture Glass...
Abt Electronics has Apple’s new 32″ Pro Display XDR model with the nano-texture glass in stock and on sale today for up to $144 off MSRP. Shipping is free: – Pro Display XDR (nano-texture glass): $... Read more
New 2020 Mac mini on sale for up to $100 off...
Amazon has Apple’s new 2020 Mac minis on sale today for $40-$100 off MSRP with prices starting at $759. Shipping is free: – 2020 4-Core Mac mini: $759 $40 off MSRP – 2020 6-Core Mac mini: $998.99 $... Read more
July 4th Sale: $100 off every 2020 13″ MacBoo...
Apple resellers have new 2020 13″ MacBook Airs on sale for $100 off Apple’s MSRP as part of their July 4th sales. Starting at $899, these are the cheapest new 2020 MacBooks for sale anywhere: (1) B... Read more
This hidden deal on Apple’s site can save you...
Are you a local, state, or federal government employee? If so, Apple offers special government pricing on their products, including AirPods, for you as well as immediate family members. Here’s how... Read more
Apple Watch Series 3 models on sale for new l...
Amazon has Apple Watch Series 3 GPS models on sale for $30 off MSRP, starting at only $169. Their prices are the lowest available for these models from any Apple reseller. Choose Amazon as the seller... Read more
Deal Alert! Get these refurbished 2018 13″ Ma...
Apple has restocked and lowered prices on select Certified Refurbished 2018 13″ MacBook Airs, starting at only $679. Each MacBook features a new outer case, comes with a standard Apple one-year... Read more
July 4th Sale: 13″ 2.0GHz MacBook Pros for $2...
B&H Photo has new 2020 13″ 2.0GHz MacBook Pros on sale for $200 off Apple’s MSRP as part of their July 4th sale. Prices start at $1599. These are the same MacBook Pros sold by Apple in their... Read more
July 1 only: $100 off Apple iPhone 11, 11 Pro...
Boost Mobile is offering Apple iPhone 11, 11 Pro, and iPhone 11 Pro Max models for $100 off MSRP with service. Their discount reduces the cost of an iPhone 11/64GB to $599, iPhone 11 Pro to $899 for... Read more
Apple offers $50-$100 Education discount on i...
Purchase a new 12.9″ or 11″ iPad Pro at Apple using your Education discount, and Apple will take $50-$100 off their MSRP. All teachers, students, and staff of any educational institution with a .edu... Read more

Jobs Board

Operating Room Assistant, *Apple* Hill Surg...
Operating Room Assistant, Apple Hill Surgical Center - Full Time, Day Shift, Monday - Saturday availability required Tracking Code 62363 Job Description Operating Read more
Perioperative RN - ( *Apple* Hill Surgical C...
Perioperative RN - ( Apple Hill Surgical Center) Tracking Code 60593 Job Description Monday - Friday - Full Time Days Possible Saturdays General Summary: Under the Read more
Product Manager, *Apple* Commercial Sales -...
Product Manager, Apple Commercial Sales Austin, TX, US Requisition Number:77652 As an Apple Product Manager for the Commercial Sales team at Insight, you Read more
*Apple* Mac Product Engineer - Barclays (Uni...
Apple Mac EngineerWhippany, NJ Support the development and delivery of solutions, products, and capabilities into the Barclays environment working across technical Read more
Blue *Apple* Cafe Student Worker - Pennsylv...
…enhance your work experience. Student positions are available at the Blue Apple Cafe. Employee meal discount during working hours. Duties include food preparation, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.