EmbeddedPkg: Extend NvVarStoreFormattedLib LIBRARY_CLASS

[mirror_edk2.git] / AppPkg / Applications / Python / Python-2.7.2 / Tools / bgen / bgen / macsupport.py

"""\\r
Augment the "bgen" package with definitions that are useful on the Apple Macintosh.\r
\r
Intended usage is "from macsupport import *" -- this implies all bgen's goodies.\r
"""\r
\r
\r
# Import everything from bgen (for ourselves as well as for re-export)\r
from bgen import *\r
\r
\r
# Simple types\r
Boolean = Type("Boolean", "b")\r
SignedByte = Type("SignedByte", "b")\r
Size = Type("Size", "l")\r
Style = Type("Style", "b")\r
StyleParameter = Type("StyleParameter", "h")\r
CharParameter = Type("CharParameter", "h")\r
TextEncoding = Type("TextEncoding", "l")\r
ByteCount = Type("ByteCount", "l")\r
Duration = Type("Duration", "l")\r
ByteOffset = Type("ByteOffset", "l")\r
OptionBits = Type("OptionBits", "l")\r
ItemCount = Type("ItemCount", "l")\r
PBVersion = Type("PBVersion", "l")\r
ScriptCode = Type("ScriptCode", "h")\r
LangCode = Type("LangCode", "h")\r
RegionCode = Type("RegionCode", "h")\r
\r
UInt8 = Type("UInt8", "b")\r
SInt8 = Type("SInt8", "b")\r
UInt16 = Type("UInt16", "H")\r
SInt16 = Type("SInt16", "h")\r
UInt32 = Type("UInt32", "l")\r
SInt32 = Type("SInt32", "l")\r
Float32 = Type("Float32", "f")\r
\r
wide = OpaqueByValueType("wide", "PyMac_Buildwide", "PyMac_Getwide")\r
wide_ptr = OpaqueType("wide", "PyMac_Buildwide", "PyMac_Getwide")\r
\r
# Pascal strings\r
ConstStr255Param = OpaqueArrayType("Str255", "PyMac_BuildStr255", "PyMac_GetStr255")\r
Str255 = OpaqueArrayType("Str255", "PyMac_BuildStr255", "PyMac_GetStr255")\r
StringPtr = OpaqueByValueType("StringPtr", "PyMac_BuildStr255", "PyMac_GetStr255")\r
ConstStringPtr = StringPtr\r
\r
# File System Specifications\r
FSSpec_ptr = OpaqueType("FSSpec", "PyMac_BuildFSSpec", "PyMac_GetFSSpec")\r
FSSpec = OpaqueByValueStructType("FSSpec", "PyMac_BuildFSSpec", "PyMac_GetFSSpec")\r
FSRef_ptr = OpaqueType("FSRef", "PyMac_BuildFSRef", "PyMac_GetFSRef")\r
FSRef = OpaqueByValueStructType("FSRef", "PyMac_BuildFSRef", "PyMac_GetFSRef")\r
\r
# OSType and ResType: 4-byte character strings\r
def OSTypeType(typename):\r
    return OpaqueByValueType(typename, "PyMac_BuildOSType", "PyMac_GetOSType")\r
OSType = OSTypeType("OSType")\r
ResType = OSTypeType("ResType")\r
FourCharCode = OSTypeType("FourCharCode")\r
\r
# Version numbers\r
NumVersion = OpaqueByValueType("NumVersion", "PyMac_BuildNumVersion", "BUG")\r
\r
# Handles (always resources in our case)\r
Handle = OpaqueByValueType("Handle", "ResObj")\r
MenuHandle = OpaqueByValueType("MenuHandle", "MenuObj")\r
MenuRef = MenuHandle\r
ControlHandle = OpaqueByValueType("ControlHandle", "CtlObj")\r
ControlRef = ControlHandle\r
\r
# Windows and Dialogs\r
WindowPtr = OpaqueByValueType("WindowPtr", "WinObj")\r
WindowRef = WindowPtr\r
DialogPtr = OpaqueByValueType("DialogPtr", "DlgObj")\r
DialogRef = DialogPtr\r
ExistingWindowPtr = OpaqueByValueType("WindowPtr", "WinObj_WhichWindow", "BUG")\r
ExistingDialogPtr = OpaqueByValueType("DialogPtr", "DlgObj_WhichDialog", "BUG")\r
\r
# NULL pointer passed in as optional storage -- not present in Python version\r
NullStorage = FakeType("(void *)0")\r
\r
# More standard datatypes\r
Fixed = OpaqueByValueType("Fixed", "PyMac_BuildFixed", "PyMac_GetFixed")\r
\r
# Quickdraw data types\r
Rect = Rect_ptr = OpaqueType("Rect", "PyMac_BuildRect", "PyMac_GetRect")\r
Point = OpaqueByValueType("Point", "PyMac_BuildPoint", "PyMac_GetPoint")\r
Point_ptr = OpaqueType("Point", "PyMac_BuildPoint", "PyMac_GetPoint")\r
\r
# Event records\r
EventRecord = OpaqueType("EventRecord", "PyMac_BuildEventRecord", "PyMac_GetEventRecord")\r
EventRecord_ptr = EventRecord\r
\r
# CoreFoundation datatypes\r
CFTypeRef = OpaqueByValueType("CFTypeRef", "CFTypeRefObj")\r
CFStringRef = OpaqueByValueType("CFStringRef", "CFStringRefObj")\r
CFMutableStringRef = OpaqueByValueType("CFMutableStringRef", "CFMutableStringRefObj")\r
CFArrayRef = OpaqueByValueType("CFArrayRef", "CFArrayRefObj")\r
CFMutableArrayRef = OpaqueByValueType("CFMutableArrayRef", "CFMutableArrayRefObj")\r
CFDictionaryRef = OpaqueByValueType("CFDictionaryRef", "CFDictionaryRefObj")\r
CFMutableDictionaryRef = OpaqueByValueType("CFMutableDictionaryRef", "CFMutableDictionaryRefObj")\r
CFURLRef = OpaqueByValueType("CFURLRef", "CFURLRefObj")\r
OptionalCFURLRef = OpaqueByValueType("CFURLRef", "OptionalCFURLRefObj")\r
\r
# OSErr is special because it is turned into an exception\r
# (Could do this with less code using a variant of mkvalue("O&")?)\r
class OSErrType(Type):\r
    def errorCheck(self, name):\r
        Output("if (%s != noErr) return PyMac_Error(%s);", name, name)\r
        self.used = 1\r
OSErr = OSErrType("OSErr", 'h')\r
OSStatus = OSErrType("OSStatus", 'l')\r
\r
\r
# Various buffer types\r
\r
InBuffer = VarInputBufferType('char', 'long', 'l')      # (buf, len)\r
UcharInBuffer  = VarInputBufferType('unsigned char', 'long', 'l')       # (buf, len)\r
OptionalInBuffer = OptionalVarInputBufferType('char', 'long', 'l')      # (buf, len)\r
\r
InOutBuffer = HeapInputOutputBufferType('char', 'long', 'l')    # (inbuf, outbuf, len)\r
VarInOutBuffer = VarHeapInputOutputBufferType('char', 'long', 'l') # (inbuf, outbuf, &len)\r
\r
OutBuffer = HeapOutputBufferType('char', 'long', 'l')       # (buf, len)\r
VarOutBuffer = VarHeapOutputBufferType('char', 'long', 'l') # (buf, &len)\r
VarVarOutBuffer = VarVarHeapOutputBufferType('char', 'long', 'l') # (buf, len, &len)\r
\r
# Unicode arguments sometimes have reversed len, buffer (don't understand why Apple did this...)\r
class VarUnicodeInputBufferType(VarInputBufferType):\r
\r
    def getargsFormat(self):\r
        return "u#"\r
\r
class VarUnicodeReverseInputBufferType(ReverseInputBufferMixin, VarUnicodeInputBufferType):\r
    pass\r
\r
UnicodeInBuffer = VarUnicodeInputBufferType('UniChar', 'UniCharCount', 'l')\r
UnicodeReverseInBuffer = VarUnicodeReverseInputBufferType('UniChar', 'UniCharCount', 'l')\r
UniChar_ptr = InputOnlyType("UniCharPtr", "u")\r
\r
\r
# Predefine various pieces of program text to be passed to Module() later:\r
\r
# Stuff added immediately after the system include files\r
includestuff = """\r
#include "pymactoolbox.h"\r
\r
/* Macro to test whether a weak-loaded CFM function exists */\r
#define PyMac_PRECHECK(rtn) do { if ( &rtn == NULL )  {\\\r
        PyErr_SetString(PyExc_NotImplementedError, \\\r
        "Not available in this shared library/OS version"); \\\r
        return NULL; \\\r
    }} while(0)\r
\r
"""\r
\r
# Stuff added just before the module's init function\r
finalstuff = """\r
"""\r
\r
# Stuff added inside the module's init function\r
initstuff = """\r
"""\r
\r
\r
# Generator classes with a twist -- if the function returns OSErr,\r
# its mode is manipulated so that it turns into an exception or disappears\r
# (and its name is changed to _err, for documentation purposes).\r
# This requires that the OSErr type (defined above) has a non-trivial\r
# errorCheck method.\r
class OSErrMixIn:\r
    "Mix-in class to treat OSErr/OSStatus return values special"\r
    def makereturnvar(self):\r
        if self.returntype.__class__ == OSErrType:\r
            return Variable(self.returntype, "_err", ErrorMode)\r
        else:\r
            return Variable(self.returntype, "_rv", OutMode)\r
\r
class OSErrFunctionGenerator(OSErrMixIn, FunctionGenerator): pass\r
class OSErrMethodGenerator(OSErrMixIn, MethodGenerator): pass\r
\r
class WeakLinkMixIn:\r
    "Mix-in to test the function actually exists (!= NULL) before calling"\r
\r
    def precheck(self):\r
        Output('#ifndef %s', self.name)\r
        Output('PyMac_PRECHECK(%s);', self.name)\r
        Output('#endif')\r
\r
class WeakLinkFunctionGenerator(WeakLinkMixIn, FunctionGenerator): pass\r
class WeakLinkMethodGenerator(WeakLinkMixIn, MethodGenerator): pass\r
class OSErrWeakLinkFunctionGenerator(OSErrMixIn, WeakLinkMixIn, FunctionGenerator): pass\r
class OSErrWeakLinkMethodGenerator(OSErrMixIn, WeakLinkMixIn, MethodGenerator): pass\r
\r
class MacModule(Module):\r
    "Subclass which gets the exception initializer from macglue.c"\r
    def exceptionInitializer(self):\r
        return "PyMac_GetOSErrException()"\r