EmbeddedPkg: Extend NvVarStoreFormattedLib LIBRARY_CLASS

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

"""Buffers are character arrays that may contain null bytes.\r
\r
There are a number of variants depending on:\r
- how the buffer is allocated (for output buffers), and\r
- whether and how the size is passed into and/or out of the called function.\r
"""\r
\r
\r
from bgenType import Type, InputOnlyMixIn, OutputOnlyMixIn, InputOnlyType, OutputOnlyType\r
from bgenOutput import *\r
\r
\r
# Map common types to their format characters\r
type2format = {\r
    'long': 'l',\r
    'int': 'i',\r
    'short': 'h',\r
    'char': 'b',\r
    'unsigned long': 'l',\r
    'unsigned int': 'i',\r
    'unsigned short': 'h',\r
    'unsigned char': 'b',\r
}\r
\r
\r
# ----- PART 1: Fixed character buffers -----\r
\r
\r
class FixedInputOutputBufferType(InputOnlyType):\r
\r
    """Fixed buffer -- passed as (inbuffer, outbuffer)."""\r
\r
    def __init__(self, size, datatype = 'char', sizetype = 'int', sizeformat = None):\r
        self.typeName = "Buffer"\r
        self.size = str(size)\r
        self.datatype = datatype\r
        self.sizetype = sizetype\r
        self.sizeformat = sizeformat or type2format[sizetype]\r
        self.label_needed = 0\r
\r
    def getArgDeclarations(self, name, reference=False, constmode=False, outmode=False):\r
        if reference:\r
            raise RuntimeError, "Cannot pass buffer types by reference"\r
        return (self.getBufferDeclarations(name, constmode, outmode) +\r
                self.getSizeDeclarations(name, outmode))\r
\r
    def getBufferDeclarations(self, name, constmode=False, outmode=False):\r
        return self.getInputBufferDeclarations(name, constmode) + \\r
                self.getOutputBufferDeclarations(name, constmode, outmode)\r
\r
    def getInputBufferDeclarations(self, name, constmode=False):\r
        if constmode:\r
            const = "const "\r
        else:\r
            const = ""\r
        return ["%s%s *%s__in__" % (const, self.datatype, name)]\r
\r
    def getOutputBufferDeclarations(self, name, constmode=False, outmode=False):\r
        if constmode:\r
            raise RuntimeError, "Cannot use const output buffer"\r
        if outmode:\r
            out = "*"\r
        else:\r
            out = ""\r
        return ["%s%s %s__out__[%s]" % (self.datatype, out, name, self.size)]\r
\r
    def getSizeDeclarations(self, name, outmode=False):\r
        if outmode:\r
            out = "*"\r
        else:\r
            out = ""\r
        return ["%s%s %s__len__" %(self.sizetype, out, name)]\r
\r
    def getAuxDeclarations(self, name):\r
        return ["int %s__in_len__" %(name)]\r
\r
    def getargsFormat(self):\r
        return "s#"\r
\r
    def getargsArgs(self, name):\r
        return "&%s__in__, &%s__in_len__" % (name, name)\r
\r
    def getargsCheck(self, name):\r
        Output("if (%s__in_len__ != %s)", name, self.size)\r
        OutLbrace()\r
        Output('PyErr_SetString(PyExc_TypeError, "buffer length should be %s");',\r
               self.size)\r
        Output("goto %s__error__;", name)\r
        self.label_needed = 1\r
        OutRbrace()\r
        self.transferSize(name)\r
\r
    def transferSize(self, name):\r
        Output("%s__len__ = %s__in_len__;", name, name)\r
\r
    def passOutput(self, name):\r
        return "%s__in__, %s__out__" % (name, name)\r
\r
    def mkvalueFormat(self):\r
        return "s#"\r
\r
    def mkvalueArgs(self, name):\r
        return "%s__out__, (int)%s" % (name, self.size)\r
\r
    def cleanup(self, name):\r
        if self.label_needed:\r
            DedentLevel()\r
            Output(" %s__error__: ;", name)\r
            IndentLevel()\r
\r
\r
class FixedCombinedInputOutputBufferType(FixedInputOutputBufferType):\r
\r
    """Like fixed buffer -- but same parameter is input and output."""\r
\r
    def passOutput(self, name):\r
        return "(%s *)memcpy(%s__out__, %s__in__, %s)" % \\r
            (self.datatype, name,   name,     self.size)\r
\r
\r
class InputOnlyBufferMixIn(InputOnlyMixIn):\r
\r
    def getOutputBufferDeclarations(self, name, constmode=False, outmode=False):\r
        return []\r
\r
\r
class OutputOnlyBufferMixIn(OutputOnlyMixIn):\r
\r
    def getInputBufferDeclarations(self, name, constmode=False):\r
        return []\r
\r
class OptionalInputBufferMixIn:\r
\r
    """Add to input buffers if the buffer may be omitted: pass None in Python\r
    and the C code will get a NULL pointer and zero size"""\r
\r
    def getargsFormat(self):\r
        return "z#"\r
\r
\r
class FixedInputBufferType(InputOnlyBufferMixIn, FixedInputOutputBufferType):\r
\r
    """Fixed size input buffer -- passed without size information.\r
\r
    Instantiate with the size as parameter.\r
    """\r
\r
    def passInput(self, name):\r
        return "%s__in__" % name\r
\r
class OptionalFixedInputBufferType(OptionalInputBufferMixIn, FixedInputBufferType):\r
    pass\r
\r
class FixedOutputBufferType(OutputOnlyBufferMixIn, FixedInputOutputBufferType):\r
\r
    """Fixed size output buffer -- passed without size information.\r
\r
    Instantiate with the size as parameter.\r
    """\r
\r
    def passOutput(self, name):\r
        return "%s__out__" % name\r
\r
\r
class VarInputBufferType(FixedInputBufferType):\r
\r
    """Variable size input buffer -- passed as (buffer, size).\r
\r
    Instantiate without size parameter.\r
    """\r
\r
    def __init__(self, datatype = 'char', sizetype = 'int', sizeformat = None):\r
        FixedInputBufferType.__init__(self, "0", datatype, sizetype, sizeformat)\r
\r
    def getargsCheck(self, name):\r
        Output("%s__len__ = %s__in_len__;", name, name)\r
\r
    def passInput(self, name):\r
        return "%s__in__, %s__len__" % (name, name)\r
\r
class ReverseInputBufferMixin:\r
    """ Mixin for input buffers that are passed as (size, buffer) """\r
\r
    def passInput(self, name):\r
        return "%s__len__, %s__in__" % (name, name)\r
\r
class OptionalVarInputBufferType(OptionalInputBufferMixIn, VarInputBufferType):\r
    pass\r
\r
# ----- PART 2: Structure buffers -----\r
\r
\r
class StructInputOutputBufferType(FixedInputOutputBufferType):\r
\r
    """Structure buffer -- passed as a structure pointer.\r
\r
    Instantiate with the struct type as parameter.\r
    """\r
\r
    def __init__(self, type):\r
        FixedInputOutputBufferType.__init__(self, "sizeof(%s)" % type)\r
        self.typeName = self.type = type\r
\r
    def getInputBufferDeclarations(self, name, constmode=False):\r
        if constmode:\r
            const = "const "\r
        else:\r
            const = ""\r
        return ["%s%s *%s__in__" % (const, self.type, name)]\r
\r
    def getSizeDeclarations(self, name, outmode=False):\r
        return []\r
\r
    def getAuxDeclarations(self, name):\r
        return ["int %s__in_len__" % (name)]\r
\r
    def getOutputBufferDeclarations(self, name, constmode=False, outmode=False):\r
        if constmode:\r
            raise RuntimeError, "Cannot use const output buffer"\r
        if outmode:\r
            out = "*"\r
        else:\r
            out = ""\r
        return ["%s%s %s__out__" % (self.type, out, name)]\r
\r
    def getargsArgs(self, name):\r
        return "(char **)&%s__in__, &%s__in_len__" % (name, name)\r
\r
    def transferSize(self, name):\r
        pass\r
\r
    def passInput(self, name):\r
        return "%s__in__" % name\r
\r
    def passOutput(self, name):\r
        return "%s__in__, &%s__out__" % (name, name)\r
\r
    def mkvalueArgs(self, name):\r
        return "(char *)&%s__out__, (int)%s" % (name, self.size)\r
\r
\r
class StructCombinedInputOutputBufferType(StructInputOutputBufferType):\r
\r
    """Like structure buffer -- but same parameter is input and output."""\r
\r
    def passOutput(self, name):\r
        return "(%s *)memcpy((char *)%s__out__, (char *)%s__in__, %s)" % \\r
            (self.type,          name,              name,     self.size)\r
\r
\r
class StructInputBufferType(InputOnlyBufferMixIn, StructInputOutputBufferType):\r
\r
    """Fixed size input buffer -- passed as a pointer to a structure.\r
\r
    Instantiate with the struct type as parameter.\r
    """\r
\r
\r
class StructByValueBufferType(StructInputBufferType):\r
\r
    """Fixed size input buffer -- passed as a structure BY VALUE.\r
\r
    Instantiate with the struct type as parameter.\r
    """\r
\r
    def passInput(self, name):\r
        return "*%s__in__" % name\r
\r
\r
class StructOutputBufferType(OutputOnlyBufferMixIn, StructInputOutputBufferType):\r
\r
    """Fixed size output buffer -- passed as a pointer to a structure.\r
\r
    Instantiate with the struct type as parameter.\r
    """\r
\r
    def getSizeDeclarations(self, name, outmode=False):\r
        return []\r
\r
    def getAuxDeclarations(self, name):\r
        return []\r
\r
    def passOutput(self, name):\r
        return "&%s__out__" % name\r
\r
\r
class ArrayOutputBufferType(OutputOnlyBufferMixIn, StructInputOutputBufferType):\r
\r
    """Fixed size output buffer -- declared as a typedef, passed as an array.\r
\r
    Instantiate with the struct type as parameter.\r
    """\r
\r
    def getSizeDeclarations(self, name, outmode=False):\r
        return []\r
\r
    def getAuxDeclarations(self, name):\r
        return []\r
\r
    def passOutput(self, name):\r
        return "%s__out__" % name\r