MoreIsBetter parts/MoreSetup.h

/*
    File:       MoreSetup.h
 
    Contains:   Sets up conditions etc for MoreIsBetter.
 
    DRI:        Pete Gontier
 
    Copyright:  Copyright (c) 1998-2001 by Apple Computer, Inc., All Rights Reserved.
 
    Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple Computer, Inc.
                ("Apple") in consideration of your agreement to the following terms, and your
                use, installation, modification or redistribution of this Apple software
                constitutes acceptance of these terms.  If you do not agree with these terms,
                please do not use, install, modify or redistribute this Apple software.
 
                In consideration of your agreement to abide by the following terms, and subject
                to these terms, Apple grants you a personal, non-exclusive license, under AppleÕs
                copyrights in this original Apple software (the "Apple Software"), to use,
                reproduce, modify and redistribute the Apple Software, with or without
                modifications, in source and/or binary forms; provided that if you redistribute
                the Apple Software in its entirety and without modifications, you must retain
                this notice and the following text and disclaimers in all such redistributions of
                the Apple Software.  Neither the name, trademarks, service marks or logos of
                Apple Computer, Inc. may be used to endorse or promote products derived from the
                Apple Software without specific prior written permission from Apple.  Except as
                expressly stated in this notice, no other rights or licenses, express or implied,
                are granted by Apple herein, including but not limited to any patent rights that
                may be infringed by your derivative works or by other works in which the Apple
                Software may be incorporated.
 
                The Apple Software is provided by Apple on an "AS IS" basis.  APPLE MAKES NO
                WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
                WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
                PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
                COMBINATION WITH YOUR PRODUCTS.
 
                IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
                CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
                GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION
                OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT
                (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN
                ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
    Change History (most recent first):
 
$Log: MoreSetup.h,v $
Revision 1.13  2001/11/07 15:55:15  eskimo1
Tidy up headers, add CVS logs, update copyright.
 
 
        <12>     21/9/01    Quinn   Fix CF framework includes workaround.
        <11>     21/9/01    Quinn   Changes for CWPro7 Mach-O build.
        <10>     15/2/01    Quinn   MoreIsBetter now requires UI 3.4 (pre-release) or later.
         <9>      8/2/01    Quinn   Modern versions of MIB require UI 3.3.2 or higher.
         <8>    22/11/00    Quinn   Switch to "MacErrors.h".
         <7>     22/4/99    Quinn   Add a check for the Universal Interfaces version.  MoreIsBetter
                                    requires Universal Interfaces 3.2 or higher (because many of its
                                    component parts do).
         <6>     2/11/99    PCG     add comments because Andy rightfully pointed out my original
                                    attempts sucked; also, remove some excessive TARGET_CARBON
                                    gymnastics
         <5>     1/22/99    PCG     TARGET_CARBON
         <4>    11/11/98    PCG     fix header
         <3>    11/10/98    PCG     separate change histories
         <2>    10/11/98    Quinn   Convert "MorePrefix.h" to "MoreSetup.h".
         <1>    10/11/98    Quinn   Changed name from "MorePrefix.h" to "MoreSetup.h".
 
    Start of "MorePrefix.h" change history (most recent first):
 
         <3>     5/11/98    Quinn   Use MoreAssertQ instead of MoreAssert.
         <2>     7/24/98    PCG     rid of triplet #includes
         <2>     6/23/98    PCG     add copyright disclaimer stuff
         <1>     6/23/98    PCG     initial checkin
*/
 
#pragma once
 
    //
    //  We never want to use old names or locations.
    //  Since these settings must be consistent all the way through
    //  a compilation unit, and since we don't want to silently
    //  change them out from under a developer who uses a prefix
    //  file (C/C++ panel of Target Settings), we simply complain
    //  if they are already set in a way we don't like.
    //
 
#ifndef OLDROUTINELOCATIONS
    #define OLDROUTINELOCATIONS 0
#elif OLDROUTINELOCATIONS
    #error OLDROUTINELOCATIONS must be FALSE when compiling MoreIsBetter.
#endif
 
#ifndef OLDROUTINENAMES
    #define OLDROUTINENAMES 0
#elif OLDROUTINENAMES
    #error OLDROUTINENAMES must be FALSE when compiling MoreIsBetter.
#endif
 
    //
    //  We need a master conditional to determine whether to use 
    //  framework notation to reference include files.  Normally 
    //  you would define this in terms of the various TARGET_xxx
    //  variables defined in <ConditionalMacros.h>.  However, you 
    //  can't include <ConditionalMacros.h> until you know 
    //  whether you're supposed to be using framework includes or 
    //  not.  So, we have to pull this conditional out of thin 
    //  air.  Right now the best way to do this is with the 
    //  __MACH__ compiler variable.
    //
 
#if defined(__MACH__)
    #define MORE_FRAMEWORK_INCLUDES 1
#else
    #define MORE_FRAMEWORK_INCLUDES 0
#endif
 
    //
    //  The next statement sets up the various TARGET_xxx 
    //  variables needed later in this file.  In the framework 
    //  include case we just include <Carbon/Carbon.h>, which 
    //  brings everything in, including <ConditionalMacros.h>.
    //  In the non-framework include case we just bring in the 
    //  specific file.
    //
    
#if MORE_FRAMEWORK_INCLUDES
 
    //
    //  This define works around a problem in <CoreFoundation/CFBase.h>
    //  in Mac OS X 10.1.  CF is assuming that the CW Mach-O compiler 
    //  would not use framework includes, which is not the case for the 
    //  CWPro7 compiler.  We only do this for the CW build because 
    //  otherwise the presence of the define prevents Project Builder 
    //  from using Carbon's precompiled header.
    //
    
    #if defined(__MWERKS__)
        #define __CF_USE_FRAMEWORK_INCLUDES__ 1
    #endif
 
    #include <Carbon/Carbon.h>
#else
    #include <ConditionalMacros.h>
#endif
    
    // 
    //  Previouly we would bring in <MacErrors.h> at this point.
    //  However, that's somewhat counter to the idea behind flat 
    //  includes, so I've eliminated it.
    //
 
 
    //
    //  Now that we've included a Mac OS interface file,
    //  we know that the Universal Interfaces environment
    //  is set up.  MoreIsBetter requires Universal Interfaces
    //  3.4 or higher.  Check for it.
    //
 
#if !defined(UNIVERSAL_INTERFACES_VERSION) || UNIVERSAL_INTERFACES_VERSION < 0x0340
    #error MoreIsBetter requires Universal Interfaces 3.4 or higher.
#endif
 
    //
    //  We usually want assertions and other debugging code
    //  turned on, but you can turn it all off if you like
    //  by setting MORE_DEBUG to 0.
    //
 
#ifndef MORE_DEBUG
    #define MORE_DEBUG 1
#endif
 
    //
    //  Our assertion macros compile down to nothing if
    //  MORE_DEBUG is not true. MoreAssert produces a
    //  value indicating whether the assertion succeeded
    //  or failed. MoreAssertQ is Quinn's flavor of
    //  MoreAssert which does not produce a value.
    //
 
#if MORE_DEBUG
    #define MoreAssert(x) \
        ((x) ? true : (DebugStr ("\pMoreAssert failure: " #x), false))
    #define MoreAssertQ(x) \
        do { if (!(x)) DebugStr ("\pMoreAssertQ failure: " #x); } while (false)
#else
    #define MoreAssert(x) (true)
    #define MoreAssertQ(x)
#endif