ndk/paths.py

#
# Copyright (C) 2016 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
"""Helper functions for NDK build and test paths."""
from __future__ import absolute_import

import contextlib
import os
import shutil
import sys

import ndk.abis
import ndk.config


THIS_DIR = os.path.realpath(os.path.dirname(__file__))


def android_path(*args):
    top = os.path.realpath(os.path.join(THIS_DIR, '../..'))
    return os.path.normpath(os.path.join(top, *args))


def ndk_path(*args):
    return android_path('ndk', *args)


def sysroot_path(toolchain):
    arch = ndk.abis.toolchain_to_arch(toolchain)
    # Only ARM has more than one ABI, and they both have the same minimum
    # platform level.
    abi = ndk.abis.arch_to_abis(arch)[0]
    version = ndk.abis.min_api_for_abi(abi)

    prebuilt_ndk = 'prebuilts/ndk/current'
    sysroot_subpath = 'platforms/android-{}/arch-{}'.format(version, arch)
    return android_path(prebuilt_ndk, sysroot_subpath)


def toolchain_path(*args):
    return android_path('toolchain', *args)


def _get_dir_from_env(default, env_var):
    path = os.path.realpath(os.getenv(env_var, default))
    if not os.path.isdir(path):
        os.makedirs(path)
    return path


def get_out_dir():
    return _get_dir_from_env(android_path('out'), 'OUT_DIR')


def get_dist_dir(out_dir):
    return _get_dir_from_env(os.path.join(out_dir, 'dist'), 'DIST_DIR')


def path_in_out(dirname, out_dir=None):
    """Returns a path within the out directory."

    Args:
        dirname: Name of the directory.
        out_dir: Optional base out directory. Inferred from $OUT_DIR if not
                 supplied. If None and $OUT_DIR is not set, will use ../out
                 relative to the NDK git project.

    Returns:
        Absolute path to the created directory.
    """
    if out_dir is None:
        out_dir = get_out_dir()
    return os.path.join(out_dir, dirname)


def get_install_path(out_dir=None):
    """Returns the built NDK install path.

    Note that the path returned might not actually contain the NDK. The NDK may
    not actually be present if:

    * The NDK hasn't been built yet.
    * The name of the release has changed since the NDK was built.
    * out_dir is not consistent with the build.

    Args:
        out_dir: Optional base out directory. Inferred from $OUT_DIR if not
                 supplied.

    Returns:
        Directory that the built NDK should be installed to.
    """
    release_name = 'android-ndk-{}'.format(ndk.config.release)
    return path_in_out(release_name, out_dir)


@contextlib.contextmanager
def temp_dir_in_out(dirname, out_dir=None):
    """Creates a well named temporary directory within the out directory.

    If the directory exists on context entry, RuntimeError will be raised. The
    directory is removed on context exit.

    Args:
        dirname: Name of the temporary directory.
        out_dir: Optional base out directory. Inferred from $OUT_DIR if not
                 supplied. If None and $OUT_DIR is not set, will use ../out
                 relative to the NDK git project.

    Returns:
        Absolute path to the created directory.

    Raises:
        RuntimeError: The requested directory already exists.
    """
    path = path_in_out(dirname, out_dir)
    if os.path.exists(path):
        raise RuntimeError('Directory already exists: ' + path)

    os.makedirs(path)
    try:
        abspath = os.path.abspath(path)
        yield abspath
    finally:
        shutil.rmtree(abspath)


def to_posix_path(path):
    if sys.platform == 'win32':
        return path.replace('\\', '/')
    else:
        return path