helper.py

import ast
import configparser
import os
import re
import subprocess
from subprocess import PIPE
import sys
import tempfile

def getFileName(filename: str):
    return os.path.splitext(os.path.basename(filename))[0]

def loadConfig(baseDtsFile):

    baseAbsPath = os.path.abspath(baseDtsFile)
    baseRealPath = os.path.realpath(baseDtsFile)

    baseDirPaths = set()
    result_abspath = re.search('^.*(?=arch\/)', baseAbsPath)
    result_realpath = re.search('^.*(?=arch\/)', baseRealPath)

    if result_abspath:
        baseDirPaths.add(result_abspath.group(0))
    if result_realpath:
        baseDirPaths.add(result_realpath.group(0))

    # Load configuration for the conf file
    config = configparser.ConfigParser()
    config.read('dtv.conf')

    # Add or remove projects from this list
    # Only the gerrit-events of changes to projects in this list will be processed.
    includeDirStubs =  ast.literal_eval(config.get('dtv', 'include_dir_stubs'))

    incIncludes = list()

    for includeDirStub in includeDirStubs:
        for baseDirPath in baseDirPaths:
            if os.path.exists(baseDirPath + includeDirStub):
                incIncludes.append(baseDirPath + includeDirStub)

    return incIncludes

def annotateDTS(dtsFile, incIncludes, out_dir = None, level = 2):

    if out_dir:
        if not os.path.exists(out_dir):
            print("Path '{}' not found!".format(out_dir))
            exit(1)
    else:
        out_dir = os.path.dirname(os.path.realpath(__file__))

    # force include dir of dtsFile
    cppIncludes = ' -I ' + os.path.dirname(dtsFile)
    dtcIncludes = ' -i ' + os.path.dirname(dtsFile)

    for includeDir in incIncludes:
        cppIncludes += ' -I ' + includeDir
        dtcIncludes += ' -i ' + includeDir

    # cpp ${cpp_flags} ${cpp_includes} ${dtx} | ${DTC} ${dtc_flags} ${dtc_include} -I dts
    try:
        cpp = 'cpp'
        cppFlags = ' -nostdinc -undef -D__DTS__ -x assembler-with-cpp '
        cppResult = subprocess.run(cpp + cppIncludes + cppFlags + dtsFile,
                                   stdout=PIPE, stderr=PIPE, shell=True, check=True)
    except subprocess.CalledProcessError as e:
        print('EXCEPTION!', e)
        print('stdout: {}'.format(e.output.decode(sys.getfilesystemencoding())))
        print('stderr: {}'.format(e.stderr.decode(sys.getfilesystemencoding())))
        exit(e.returncode)

    dtsPlugin = True if re.findall(r'\s*\/plugin\/\s*;', cppResult.stdout.decode('utf-8')) else False
    if dtsPlugin:
        print('DTS file is plugin')

    dtsShowDeletedSupport = True
    try:
        subprocess.run('dtc --comment-deleted -h', stdout=PIPE, stderr=PIPE, shell=True, check=True)
    except subprocess.CalledProcessError as e:
        print('WARNING!', 'dtc version doesn\'t support "comment-deleted" option')
        dtsShowDeletedSupport = False

    try:
        dtc = 'dtc'
        dtcFlags = ' -@ -I dts -O dts -f -s ' + (' -T ' * level) + ' -o - '
        if dtsShowDeletedSupport:
            dtcFlags += '--comment-deleted '
        dtcResult = subprocess.run(dtc + dtcIncludes + dtcFlags,
                                   stdout=PIPE, stderr=PIPE, input=cppResult.stdout, shell=True, check=True)

    except subprocess.CalledProcessError as e:
        print('EXCEPTION!', e)
        print('stdout: {}'.format(e.output.decode(sys.getfilesystemencoding())))
        print('stderr: {}'.format(e.stderr.decode(sys.getfilesystemencoding())))
        exit(e.returncode)

    # Create a temporary file in the current working directory
    (tmpAnnotatedFile, tmpAnnotatedFileName) = tempfile.mkstemp(dir=out_dir,
                                                                prefix=getFileName(dtsFile) + '-annotated-',
                                                                suffix='.dts')
    with os.fdopen(tmpAnnotatedFile, 'w') as output:
        output.write(dtcResult.stdout.decode('utf-8') )

    return tmpAnnotatedFileName