CDEF Messages
Volume Number: | | 5
|
Issue Number: | | 8
|
Column Tag: | | TechNotes
|
Related Info: Control Manager
New CDEF Messages
By James Plamondon, Berkeley, CA
System 7.0 will present all Macintosh programmers with new opportunities and new challenges. One of the challenges will be making your code 32-bit clean. This can be particularly difficult if your code uses parts of the Toolbox that are not 32-bit clean. Some of the routines in the Control Manager, for example, are at best only 31-bit clean -- thats close, but not close enough for System 7.0. This article will answer the challenge by explaining both the problem with, and the solution to, the Control Managers unclean habits.
The specific problem that this article addresses lies in the calcCRgns CDEF message sent to all CDEFs. The message is sent to a controls CDEF to calculate the controls enclosing region, or the enclosing region of its indicator (if any). In Inside Macintosh [IM v1 p330], the calcCRgns CDEF message is explained as follows: Param is a QuickDraw region handle . If the high-order bit of param is set, the region requested is that of the controls indicator rather than the control as a whole. The definition function should clear the high byte (not just the high bit) of the region handle before attempting to update the region.
You can see that its pretty hard to be 32-bit clean when youre supposed to go around clearing bytes in handles. The handle could contain a perfectly valid 32-bit address; clearing the high byte would change the address to something entirely different -- and accessing or changing anything via that address would be a terrible mistake. Yet, it is required by the Control Manager, so what is a programmer to do?
First, one can at least improve the situation by not clearing the whole high byte, as directed. Instead, just interrogate the high bit to see what region needs to be calculated, and then clear it -- leaving the rest of the bits alone. This makes the code 31-bit clean; thats not good enough for System 7.0, but itll do for the old systems.
For System 7.0, Apple has defined two new CDEF messages: calcCntlRgn (10) and calcThumbRgn (11). Instead of sending a calcCRgns message and having the CDEF figure out whether the system wants the control region or the indicator (thumb) region, the system will figure out which it wants, and send the CDEF the appropriate (new) message. The CDEF can then treat the region handle like a region handle, instead of like a secret message that has to be decoded.
To make sure the world is a happy place, and that backward compatibility is maintained, a CDEF should always implement both the calcCRgns message and the new CDEF messages. That way, whether the CDEF finds itself in use under either System 7.0 or a pre-7.0 system (which is pretty likely for the next year or two), it will respond in the manner the system expects.
There are a couple of related issues. First, a controls variation code used to be stored in the high byte of the control records contrlDefProc field. To get the variation code, the programmer would mask it out of the high byte. This is unclean, since the contrlDefProc field may contain a valid 32-bit address. A new routine, GetCVariant(), was provided a couple of years ago (IM v5 p222) to return the controls variation code. Be sure to use it.
Also, whenever writing custom CDEFs or/and other DEFs, remember that The Management Reserves the Right to Add New Messages at Any Time. Therefore, be sure that if your DEF receives a message it doesnt recognize, it just returns what it was given without doing anything (and without blowing up).
Lastly, if youre going to add any custom messages to your custom DEF, set the new message numbers to constants greater than 128. This gives Apple the freedom it needs to add new messages, without tromping on your custom messages.
Thats about all the discussion this issue will bear. See the revision to Tech Note #212 for the official version of this same information. Below, I have appended the old, unclean calcCRgns implementation, the new and improved 31-bit clean calcCRgns implementation, and a shell CDEF entry-point function that shows how all these messages should be handled. Note that the param actual argument is a valid handle to an empty region, so the content of the region indicated by param needs to be changed, not the value of param itself. You couldnt make any change to param stick anyway, since its not a var parameter (i.e., the CDEF gets a copy of params value, not its address). Also, Im assuming the existence of some routines, such as MyCalcThumbRgn() and MyCalcCtlRgn(), that are different for each different CDEF, and which are therefore not given here.
Id like to thank Andrew Shebanow, Larry Tesler, Charlie Oppenheimer, and Steve Goldberg at Apple -- way to go, guys!
(*****************************************************
MyControl: Main entry point. Call appropriate
message-handling routine.
*****************************************************)
FUNCTION MyControl(varCode: INTEGER;
theCntl: ControlHandle;
message: INTEGER;
param: LONGINT): LONGINT;
BEGIN
MyControl := 0; { default }
CASE message OF
drawCntl:
doDrawCntl(theCntl, varCode, param);
testCntl:
MyControl := doTestCntl(theCntl, param);
initCntl:
doInitCntl(theCntl, varCode);
dispCntl:
doDispCntl(theCntl, varCode);
autoTrack:
doAutoTrack(theCntl, varCode, param);
calcCRgns: { support for pre-7.0 }
doCalcCRgnsNew(theCntl, param);
calcCntlRgn: { new in System 7.0 }
MyCalcCtlRgn(theCntl, RgnHandle(param));
calcThumbRgn:{ new in System 7.0 }
MyCalcThumbRgn(theCntl, RgnHandle(param));
OTHERWISE
; { ignore all other messages }
END; { case }
END; { MyControl }
(*****************************************************
doCalcCRgnsOld: Calculate the region the
control or its indicator occupies in its
window. Old method: Only 24-bit clean
-- dont use this method anymore; use
doCalcCRgnsNew(), below.
*****************************************************)
PROCEDURE doCalcCRgnsOld(theCntl: ControlHandle;
param: LONGINT);
BEGIN
if (param < 0) then { high bit is sign bit }
begin
{ clear high BYTE and set thumb rgn }
param := BitAnd(param, $0FFFFFFF);
MyCalcThumbRgn(theCntl, RgnHandle(param));
end
else
begin
{ clear high BYTE and set control rgn }
param := BitAnd(param, $0FFFFFFF);
MyCalcCtlRgn(theCntl,
RgnHandle(param));
end;
END; { doCalcCRgnsOld }
(*****************************************************
doCalcCRgnsNew: New method: Only 31-bit
clean, but thats the best we can do.
*****************************************************)
PROCEDURE doCalcCRgnsNew(theCntl: ControlHandle;
param: LONGINT);
BEGIN
if (param < 0) then { high bit is sign bit }
begin
{ clear high BIT and set thumb rgn }
param := BitAnd(param, $7FFFFFFF);
MyCalcThumbRgn(theCntl, RgnHandle(param));
end
else
begin
{ clear high BIT and set controls rgn }
param := BitAnd(param, $7FFFFFFF);
MyCalcCtlRgn(theCntl, RgnHandle(param));
end;
END; { doCalcCRgnsNew }