EmbeddedPkg: Extend NvVarStoreFormattedLib LIBRARY_CLASS

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

"""Buffers used to hold null-terminated strings."""\r
\r
\r
from bgenBuffer import FixedOutputBufferType\r
from bgenStackBuffer import StackOutputBufferType\r
from bgenHeapBuffer import HeapOutputBufferType\r
\r
\r
class StringBufferMixIn:\r
\r
    """Mix-in class to create various string buffer types.\r
\r
    Strings are character arrays terminated by a null byte.\r
    (For input, this is also covered by stringptr.)\r
    For output, there are again three variants:\r
    - Fixed: size is a constant given in the documentation; or\r
    - Stack: size is passed to the C function but we decide on a size at\r
      code generation time so we can still allocate on the heap); or\r
    - Heap: size is passed to the C function and we let the Python caller\r
      pass a size.\r
    (Note that this doesn't cover output parameters in which a string\r
    pointer is returned.  These are actually easier (no allocation) but far\r
    less common.  I'll write the classes when there is demand.)\r
    """\r
\r
    def getSizeDeclarations(self, name):\r
        return []\r
\r
    def getAuxDeclarations(self, name):\r
        return []\r
\r
    def getargsFormat(self):\r
        return "s"\r
\r
    def getargsArgs(self, name):\r
        return "&%s__in__" % name\r
\r
    def mkvalueFormat(self):\r
        return "s"\r
\r
    def mkvalueArgs(self, name):\r
        return "%s__out__" % name\r
\r
\r
class FixedOutputStringType(StringBufferMixIn, FixedOutputBufferType):\r
\r
    """Null-terminated output string -- passed without size.\r
\r
    Instantiate with buffer size as parameter.\r
    """\r
\r
\r
class StackOutputStringType(StringBufferMixIn, StackOutputBufferType):\r
\r
    """Null-terminated output string -- passed as (buffer, size).\r
\r
    Instantiate with buffer size as parameter.\r
    """\r
\r
\r
class HeapOutputStringType(StringBufferMixIn, HeapOutputBufferType):\r
\r
    """Null-terminated output string -- passed as (buffer, size).\r
\r
    Instantiate without parameters.\r
    Call from Python with buffer size.\r
    """\r