EmbeddedPkg: Extend NvVarStoreFormattedLib LIBRARY_CLASS

[mirror_edk2.git] / AppPkg / Applications / Python / Python-2.7.2 / Lib / distutils / sysconfig.py

"""Provide access to Python's configuration information.  The specific\r
configuration variables available depend heavily on the platform and\r
configuration.  The values may be retrieved using\r
get_config_var(name), and the list of variables is available via\r
get_config_vars().keys().  Additional convenience functions are also\r
available.\r
\r
Written by:   Fred L. Drake, Jr.\r
Email:        <fdrake@acm.org>\r
"""\r
\r
__revision__ = "$Id$"\r
\r
import os\r
import re\r
import string\r
import sys\r
\r
from distutils.errors import DistutilsPlatformError\r
\r
# These are needed in a couple of spots, so just compute them once.\r
PREFIX = os.path.normpath(sys.prefix)\r
EXEC_PREFIX = os.path.normpath(sys.exec_prefix)\r
\r
# Path to the base directory of the project. On Windows the binary may\r
# live in project/PCBuild9.  If we're dealing with an x64 Windows build,\r
# it'll live in project/PCbuild/amd64.\r
project_base = os.path.dirname(os.path.abspath(sys.executable))\r
if os.name == "nt" and "pcbuild" in project_base[-8:].lower():\r
    project_base = os.path.abspath(os.path.join(project_base, os.path.pardir))\r
# PC/VS7.1\r
if os.name == "nt" and "\\pc\\v" in project_base[-10:].lower():\r
    project_base = os.path.abspath(os.path.join(project_base, os.path.pardir,\r
                                                os.path.pardir))\r
# PC/AMD64\r
if os.name == "nt" and "\\pcbuild\\amd64" in project_base[-14:].lower():\r
    project_base = os.path.abspath(os.path.join(project_base, os.path.pardir,\r
                                                os.path.pardir))\r
\r
# python_build: (Boolean) if true, we're either building Python or\r
# building an extension with an un-installed Python, so we use\r
# different (hard-wired) directories.\r
# Setup.local is available for Makefile builds including VPATH builds,\r
# Setup.dist is available on Windows\r
def _python_build():\r
    for fn in ("Setup.dist", "Setup.local"):\r
        if os.path.isfile(os.path.join(project_base, "Modules", fn)):\r
            return True\r
    return False\r
python_build = _python_build()\r
\r
\r
def get_python_version():\r
    """Return a string containing the major and minor Python version,\r
    leaving off the patchlevel.  Sample return values could be '1.5'\r
    or '2.2'.\r
    """\r
    return sys.version[:3]\r
\r
\r
def get_python_inc(plat_specific=0, prefix=None):\r
    """Return the directory containing installed Python header files.\r
\r
    If 'plat_specific' is false (the default), this is the path to the\r
    non-platform-specific header files, i.e. Python.h and so on;\r
    otherwise, this is the path to platform-specific header files\r
    (namely pyconfig.h).\r
\r
    If 'prefix' is supplied, use it instead of sys.prefix or\r
    sys.exec_prefix -- i.e., ignore 'plat_specific'.\r
    """\r
    if prefix is None:\r
        prefix = plat_specific and EXEC_PREFIX or PREFIX\r
\r
    if os.name == "posix":\r
        if python_build:\r
            buildir = os.path.dirname(sys.executable)\r
            if plat_specific:\r
                # python.h is located in the buildir\r
                inc_dir = buildir\r
            else:\r
                # the source dir is relative to the buildir\r
                srcdir = os.path.abspath(os.path.join(buildir,\r
                                         get_config_var('srcdir')))\r
                # Include is located in the srcdir\r
                inc_dir = os.path.join(srcdir, "Include")\r
            return inc_dir\r
        return os.path.join(prefix, "include", "python" + get_python_version())\r
    elif os.name == "nt":\r
        return os.path.join(prefix, "include")\r
    elif os.name == "os2":\r
        return os.path.join(prefix, "Include")\r
    else:\r
        raise DistutilsPlatformError(\r
            "I don't know where Python installs its C header files "\r
            "on platform '%s'" % os.name)\r
\r
\r
def get_python_lib(plat_specific=0, standard_lib=0, prefix=None):\r
    """Return the directory containing the Python library (standard or\r
    site additions).\r
\r
    If 'plat_specific' is true, return the directory containing\r
    platform-specific modules, i.e. any module from a non-pure-Python\r
    module distribution; otherwise, return the platform-shared library\r
    directory.  If 'standard_lib' is true, return the directory\r
    containing standard Python library modules; otherwise, return the\r
    directory for site-specific modules.\r
\r
    If 'prefix' is supplied, use it instead of sys.prefix or\r
    sys.exec_prefix -- i.e., ignore 'plat_specific'.\r
    """\r
    if prefix is None:\r
        prefix = plat_specific and EXEC_PREFIX or PREFIX\r
\r
    if os.name == "posix":\r
        libpython = os.path.join(prefix,\r
                                 "lib", "python" + get_python_version())\r
        if standard_lib:\r
            return libpython\r
        else:\r
            return os.path.join(libpython, "site-packages")\r
\r
    elif os.name == "nt":\r
        if standard_lib:\r
            return os.path.join(prefix, "Lib")\r
        else:\r
            if get_python_version() < "2.2":\r
                return prefix\r
            else:\r
                return os.path.join(prefix, "Lib", "site-packages")\r
\r
    elif os.name == "os2":\r
        if standard_lib:\r
            return os.path.join(prefix, "Lib")\r
        else:\r
            return os.path.join(prefix, "Lib", "site-packages")\r
\r
    else:\r
        raise DistutilsPlatformError(\r
            "I don't know where Python installs its library "\r
            "on platform '%s'" % os.name)\r
\r
\r
def customize_compiler(compiler):\r
    """Do any platform-specific customization of a CCompiler instance.\r
\r
    Mainly needed on Unix, so we can plug in the information that\r
    varies across Unices and is stored in Python's Makefile.\r
    """\r
    if compiler.compiler_type == "unix":\r
        (cc, cxx, opt, cflags, ccshared, ldshared, so_ext) = \\r
            get_config_vars('CC', 'CXX', 'OPT', 'CFLAGS',\r
                            'CCSHARED', 'LDSHARED', 'SO')\r
\r
        if 'CC' in os.environ:\r
            cc = os.environ['CC']\r
        if 'CXX' in os.environ:\r
            cxx = os.environ['CXX']\r
        if 'LDSHARED' in os.environ:\r
            ldshared = os.environ['LDSHARED']\r
        if 'CPP' in os.environ:\r
            cpp = os.environ['CPP']\r
        else:\r
            cpp = cc + " -E"           # not always\r
        if 'LDFLAGS' in os.environ:\r
            ldshared = ldshared + ' ' + os.environ['LDFLAGS']\r
        if 'CFLAGS' in os.environ:\r
            cflags = opt + ' ' + os.environ['CFLAGS']\r
            ldshared = ldshared + ' ' + os.environ['CFLAGS']\r
        if 'CPPFLAGS' in os.environ:\r
            cpp = cpp + ' ' + os.environ['CPPFLAGS']\r
            cflags = cflags + ' ' + os.environ['CPPFLAGS']\r
            ldshared = ldshared + ' ' + os.environ['CPPFLAGS']\r
\r
        cc_cmd = cc + ' ' + cflags\r
        compiler.set_executables(\r
            preprocessor=cpp,\r
            compiler=cc_cmd,\r
            compiler_so=cc_cmd + ' ' + ccshared,\r
            compiler_cxx=cxx,\r
            linker_so=ldshared,\r
            linker_exe=cc)\r
\r
        compiler.shared_lib_extension = so_ext\r
\r
\r
def get_config_h_filename():\r
    """Return full pathname of installed pyconfig.h file."""\r
    if python_build:\r
        if os.name == "nt":\r
            inc_dir = os.path.join(project_base, "PC")\r
        else:\r
            inc_dir = project_base\r
    else:\r
        inc_dir = get_python_inc(plat_specific=1)\r
    if get_python_version() < '2.2':\r
        config_h = 'config.h'\r
    else:\r
        # The name of the config.h file changed in 2.2\r
        config_h = 'pyconfig.h'\r
    return os.path.join(inc_dir, config_h)\r
\r
\r
def get_makefile_filename():\r
    """Return full pathname of installed Makefile from the Python build."""\r
    if python_build:\r
        return os.path.join(os.path.dirname(sys.executable), "Makefile")\r
    lib_dir = get_python_lib(plat_specific=1, standard_lib=1)\r
    return os.path.join(lib_dir, "config", "Makefile")\r
\r
\r
def parse_config_h(fp, g=None):\r
    """Parse a config.h-style file.\r
\r
    A dictionary containing name/value pairs is returned.  If an\r
    optional dictionary is passed in as the second argument, it is\r
    used instead of a new dictionary.\r
    """\r
    if g is None:\r
        g = {}\r
    define_rx = re.compile("#define ([A-Z][A-Za-z0-9_]+) (.*)\n")\r
    undef_rx = re.compile("/[*] #undef ([A-Z][A-Za-z0-9_]+) [*]/\n")\r
    #\r
    while 1:\r
        line = fp.readline()\r
        if not line:\r
            break\r
        m = define_rx.match(line)\r
        if m:\r
            n, v = m.group(1, 2)\r
            try: v = int(v)\r
            except ValueError: pass\r
            g[n] = v\r
        else:\r
            m = undef_rx.match(line)\r
            if m:\r
                g[m.group(1)] = 0\r
    return g\r
\r
\r
# Regexes needed for parsing Makefile (and similar syntaxes,\r
# like old-style Setup files).\r
_variable_rx = re.compile("([a-zA-Z][a-zA-Z0-9_]+)\s*=\s*(.*)")\r
_findvar1_rx = re.compile(r"\$\(([A-Za-z][A-Za-z0-9_]*)\)")\r
_findvar2_rx = re.compile(r"\${([A-Za-z][A-Za-z0-9_]*)}")\r
\r
def parse_makefile(fn, g=None):\r
    """Parse a Makefile-style file.\r
\r
    A dictionary containing name/value pairs is returned.  If an\r
    optional dictionary is passed in as the second argument, it is\r
    used instead of a new dictionary.\r
    """\r
    from distutils.text_file import TextFile\r
    fp = TextFile(fn, strip_comments=1, skip_blanks=1, join_lines=1)\r
\r
    if g is None:\r
        g = {}\r
    done = {}\r
    notdone = {}\r
\r
    while 1:\r
        line = fp.readline()\r
        if line is None:  # eof\r
            break\r
        m = _variable_rx.match(line)\r
        if m:\r
            n, v = m.group(1, 2)\r
            v = v.strip()\r
            # `$$' is a literal `$' in make\r
            tmpv = v.replace('$$', '')\r
\r
            if "$" in tmpv:\r
                notdone[n] = v\r
            else:\r
                try:\r
                    v = int(v)\r
                except ValueError:\r
                    # insert literal `$'\r
                    done[n] = v.replace('$$', '$')\r
                else:\r
                    done[n] = v\r
\r
    # do variable interpolation here\r
    while notdone:\r
        for name in notdone.keys():\r
            value = notdone[name]\r
            m = _findvar1_rx.search(value) or _findvar2_rx.search(value)\r
            if m:\r
                n = m.group(1)\r
                found = True\r
                if n in done:\r
                    item = str(done[n])\r
                elif n in notdone:\r
                    # get it on a subsequent round\r
                    found = False\r
                elif n in os.environ:\r
                    # do it like make: fall back to environment\r
                    item = os.environ[n]\r
                else:\r
                    done[n] = item = ""\r
                if found:\r
                    after = value[m.end():]\r
                    value = value[:m.start()] + item + after\r
                    if "$" in after:\r
                        notdone[name] = value\r
                    else:\r
                        try: value = int(value)\r
                        except ValueError:\r
                            done[name] = value.strip()\r
                        else:\r
                            done[name] = value\r
                        del notdone[name]\r
            else:\r
                # bogus variable reference; just drop it since we can't deal\r
                del notdone[name]\r
\r
    fp.close()\r
\r
    # strip spurious spaces\r
    for k, v in done.items():\r
        if isinstance(v, str):\r
            done[k] = v.strip()\r
\r
    # save the results in the global dictionary\r
    g.update(done)\r
    return g\r
\r
\r
def expand_makefile_vars(s, vars):\r
    """Expand Makefile-style variables -- "${foo}" or "$(foo)" -- in\r
    'string' according to 'vars' (a dictionary mapping variable names to\r
    values).  Variables not present in 'vars' are silently expanded to the\r
    empty string.  The variable values in 'vars' should not contain further\r
    variable expansions; if 'vars' is the output of 'parse_makefile()',\r
    you're fine.  Returns a variable-expanded version of 's'.\r
    """\r
\r
    # This algorithm does multiple expansion, so if vars['foo'] contains\r
    # "${bar}", it will expand ${foo} to ${bar}, and then expand\r
    # ${bar}... and so forth.  This is fine as long as 'vars' comes from\r
    # 'parse_makefile()', which takes care of such expansions eagerly,\r
    # according to make's variable expansion semantics.\r
\r
    while 1:\r
        m = _findvar1_rx.search(s) or _findvar2_rx.search(s)\r
        if m:\r
            (beg, end) = m.span()\r
            s = s[0:beg] + vars.get(m.group(1)) + s[end:]\r
        else:\r
            break\r
    return s\r
\r
\r
_config_vars = None\r
\r
def _init_posix():\r
    """Initialize the module as appropriate for POSIX systems."""\r
    g = {}\r
    # load the installed Makefile:\r
    try:\r
        filename = get_makefile_filename()\r
        parse_makefile(filename, g)\r
    except IOError, msg:\r
        my_msg = "invalid Python installation: unable to open %s" % filename\r
        if hasattr(msg, "strerror"):\r
            my_msg = my_msg + " (%s)" % msg.strerror\r
\r
        raise DistutilsPlatformError(my_msg)\r
\r
    # load the installed pyconfig.h:\r
    try:\r
        filename = get_config_h_filename()\r
        parse_config_h(file(filename), g)\r
    except IOError, msg:\r
        my_msg = "invalid Python installation: unable to open %s" % filename\r
        if hasattr(msg, "strerror"):\r
            my_msg = my_msg + " (%s)" % msg.strerror\r
\r
        raise DistutilsPlatformError(my_msg)\r
\r
    # On MacOSX we need to check the setting of the environment variable\r
    # MACOSX_DEPLOYMENT_TARGET: configure bases some choices on it so\r
    # it needs to be compatible.\r
    # If it isn't set we set it to the configure-time value\r
    if sys.platform == 'darwin' and 'MACOSX_DEPLOYMENT_TARGET' in g:\r
        cfg_target = g['MACOSX_DEPLOYMENT_TARGET']\r
        cur_target = os.getenv('MACOSX_DEPLOYMENT_TARGET', '')\r
        if cur_target == '':\r
            cur_target = cfg_target\r
            os.environ['MACOSX_DEPLOYMENT_TARGET'] = cfg_target\r
        elif map(int, cfg_target.split('.')) > map(int, cur_target.split('.')):\r
            my_msg = ('$MACOSX_DEPLOYMENT_TARGET mismatch: now "%s" but "%s" during configure'\r
                % (cur_target, cfg_target))\r
            raise DistutilsPlatformError(my_msg)\r
\r
    # On AIX, there are wrong paths to the linker scripts in the Makefile\r
    # -- these paths are relative to the Python source, but when installed\r
    # the scripts are in another directory.\r
    if python_build:\r
        g['LDSHARED'] = g['BLDSHARED']\r
\r
    elif get_python_version() < '2.1':\r
        # The following two branches are for 1.5.2 compatibility.\r
        if sys.platform == 'aix4':          # what about AIX 3.x ?\r
            # Linker script is in the config directory, not in Modules as the\r
            # Makefile says.\r
            python_lib = get_python_lib(standard_lib=1)\r
            ld_so_aix = os.path.join(python_lib, 'config', 'ld_so_aix')\r
            python_exp = os.path.join(python_lib, 'config', 'python.exp')\r
\r
            g['LDSHARED'] = "%s %s -bI:%s" % (ld_so_aix, g['CC'], python_exp)\r
\r
        elif sys.platform == 'beos':\r
            # Linker script is in the config directory.  In the Makefile it is\r
            # relative to the srcdir, which after installation no longer makes\r
            # sense.\r
            python_lib = get_python_lib(standard_lib=1)\r
            linkerscript_path = string.split(g['LDSHARED'])[0]\r
            linkerscript_name = os.path.basename(linkerscript_path)\r
            linkerscript = os.path.join(python_lib, 'config',\r
                                        linkerscript_name)\r
\r
            # XXX this isn't the right place to do this: adding the Python\r
            # library to the link, if needed, should be in the "build_ext"\r
            # command.  (It's also needed for non-MS compilers on Windows, and\r
            # it's taken care of for them by the 'build_ext.get_libraries()'\r
            # method.)\r
            g['LDSHARED'] = ("%s -L%s/lib -lpython%s" %\r
                             (linkerscript, PREFIX, get_python_version()))\r
\r
    global _config_vars\r
    _config_vars = g\r
\r
\r
def _init_nt():\r
    """Initialize the module as appropriate for NT"""\r
    g = {}\r
    # set basic install directories\r
    g['LIBDEST'] = get_python_lib(plat_specific=0, standard_lib=1)\r
    g['BINLIBDEST'] = get_python_lib(plat_specific=1, standard_lib=1)\r
\r
    # XXX hmmm.. a normal install puts include files here\r
    g['INCLUDEPY'] = get_python_inc(plat_specific=0)\r
\r
    g['SO'] = '.pyd'\r
    g['EXE'] = ".exe"\r
    g['VERSION'] = get_python_version().replace(".", "")\r
    g['BINDIR'] = os.path.dirname(os.path.abspath(sys.executable))\r
\r
    global _config_vars\r
    _config_vars = g\r
\r
\r
def _init_os2():\r
    """Initialize the module as appropriate for OS/2"""\r
    g = {}\r
    # set basic install directories\r
    g['LIBDEST'] = get_python_lib(plat_specific=0, standard_lib=1)\r
    g['BINLIBDEST'] = get_python_lib(plat_specific=1, standard_lib=1)\r
\r
    # XXX hmmm.. a normal install puts include files here\r
    g['INCLUDEPY'] = get_python_inc(plat_specific=0)\r
\r
    g['SO'] = '.pyd'\r
    g['EXE'] = ".exe"\r
\r
    global _config_vars\r
    _config_vars = g\r
\r
\r
def get_config_vars(*args):\r
    """With no arguments, return a dictionary of all configuration\r
    variables relevant for the current platform.  Generally this includes\r
    everything needed to build extensions and install both pure modules and\r
    extensions.  On Unix, this means every variable defined in Python's\r
    installed Makefile; on Windows and Mac OS it's a much smaller set.\r
\r
    With arguments, return a list of values that result from looking up\r
    each argument in the configuration variable dictionary.\r
    """\r
    global _config_vars\r
    if _config_vars is None:\r
        func = globals().get("_init_" + os.name)\r
        if func:\r
            func()\r
        else:\r
            _config_vars = {}\r
\r
        # Normalized versions of prefix and exec_prefix are handy to have;\r
        # in fact, these are the standard versions used most places in the\r
        # Distutils.\r
        _config_vars['prefix'] = PREFIX\r
        _config_vars['exec_prefix'] = EXEC_PREFIX\r
\r
        if sys.platform == 'darwin':\r
            kernel_version = os.uname()[2] # Kernel version (8.4.3)\r
            major_version = int(kernel_version.split('.')[0])\r
\r
            if major_version < 8:\r
                # On Mac OS X before 10.4, check if -arch and -isysroot\r
                # are in CFLAGS or LDFLAGS and remove them if they are.\r
                # This is needed when building extensions on a 10.3 system\r
                # using a universal build of python.\r
                for key in ('LDFLAGS', 'BASECFLAGS', 'LDSHARED',\r
                        # a number of derived variables. These need to be\r
                        # patched up as well.\r
                        'CFLAGS', 'PY_CFLAGS', 'BLDSHARED'):\r
                    flags = _config_vars[key]\r
                    flags = re.sub('-arch\s+\w+\s', ' ', flags)\r
                    flags = re.sub('-isysroot [^ \t]*', ' ', flags)\r
                    _config_vars[key] = flags\r
\r
            else:\r
\r
                # Allow the user to override the architecture flags using\r
                # an environment variable.\r
                # NOTE: This name was introduced by Apple in OSX 10.5 and\r
                # is used by several scripting languages distributed with\r
                # that OS release.\r
\r
                if 'ARCHFLAGS' in os.environ:\r
                    arch = os.environ['ARCHFLAGS']\r
                    for key in ('LDFLAGS', 'BASECFLAGS', 'LDSHARED',\r
                        # a number of derived variables. These need to be\r
                        # patched up as well.\r
                        'CFLAGS', 'PY_CFLAGS', 'BLDSHARED'):\r
\r
                        flags = _config_vars[key]\r
                        flags = re.sub('-arch\s+\w+\s', ' ', flags)\r
                        flags = flags + ' ' + arch\r
                        _config_vars[key] = flags\r
\r
                # If we're on OSX 10.5 or later and the user tries to\r
                # compiles an extension using an SDK that is not present\r
                # on the current machine it is better to not use an SDK\r
                # than to fail.\r
                #\r
                # The major usecase for this is users using a Python.org\r
                # binary installer  on OSX 10.6: that installer uses\r
                # the 10.4u SDK, but that SDK is not installed by default\r
                # when you install Xcode.\r
                #\r
                m = re.search('-isysroot\s+(\S+)', _config_vars['CFLAGS'])\r
                if m is not None:\r
                    sdk = m.group(1)\r
                    if not os.path.exists(sdk):\r
                        for key in ('LDFLAGS', 'BASECFLAGS', 'LDSHARED',\r
                             # a number of derived variables. These need to be\r
                             # patched up as well.\r
                            'CFLAGS', 'PY_CFLAGS', 'BLDSHARED'):\r
\r
                            flags = _config_vars[key]\r
                            flags = re.sub('-isysroot\s+\S+(\s|$)', ' ', flags)\r
                            _config_vars[key] = flags\r
\r
    if args:\r
        vals = []\r
        for name in args:\r
            vals.append(_config_vars.get(name))\r
        return vals\r
    else:\r
        return _config_vars\r
\r
def get_config_var(name):\r
    """Return the value of a single variable using the dictionary\r
    returned by 'get_config_vars()'.  Equivalent to\r
    get_config_vars().get(name)\r
    """\r
    return get_config_vars().get(name)\r