embedder_layering_check Namespace Reference

Functions
	CheckFile (sdk_root, path)
	CheckDir (sdk_root, dir)
	DoCheck (sdk_root)

Variables
	INCLUDE_DIRECTIVE_RE = re.compile(r'^#include "(.*)"')
	PLATFORM_LAYER_RE = re.compile(r'^runtime/platform/')
	VM_LAYER_RE = re.compile(r'^runtime/(vm|lib)/')
	BIN_LAYER_RE = re.compile(r'^runtime/bin/')
list	EXTRA_TEST_FILES
	errors = DoCheck('.')

Function Documentation

CheckDir()

embedder_layering_check.CheckDir	(		sdk_root,
			dir
	)

Definition at line 58 of file embedder_layering_check.py.

def CheckDir(sdk_root, dir):
    errors = []
    for file in os.listdir(dir):
        path = os.path.join(dir, file)
        if os.path.isdir(path):
            errors += CheckDir(sdk_root, path)
        elif path.endswith('test.cc') or path in EXTRA_TEST_FILES:
            None  # Tests may violate layering.
        elif path.endswith('.cc') or path.endswith('.h'):
            errors += CheckFile(sdk_root, os.path.relpath(path, sdk_root))
    return errors
 
 

CheckFile()

embedder_layering_check.CheckFile	(		sdk_root,
			path
	)

Definition at line 28 of file embedder_layering_check.py.

def CheckFile(sdk_root, path):
    includes = set()
    with open(os.path.join(sdk_root, path), encoding='utf-8') as file:
        for line in file:
            m = INCLUDE_DIRECTIVE_RE.match(line)
            if m is not None:
                header = os.path.join('runtime', m.group(1))
                if os.path.isfile(os.path.join(sdk_root, header)):
                    includes.add(header)
 
    errors = []
    for include in includes:
        if PLATFORM_LAYER_RE.match(path):
            if VM_LAYER_RE.match(include):
                errors.append(
                    'LAYERING ERROR: %s must not include %s' % (path, include))
            elif BIN_LAYER_RE.match(include):
                errors.append(
                    'LAYERING ERROR: %s must not include %s' % (path, include))
        elif VM_LAYER_RE.match(path):
            if BIN_LAYER_RE.match(include):
                errors.append(
                    'LAYERING ERROR: %s must not include %s' % (path, include))
        elif BIN_LAYER_RE.match(path):
            if VM_LAYER_RE.match(include):
                errors.append(
                    'LAYERING ERROR: %s must not include %s' % (path, include))
    return errors
 
 

DoCheck()

embedder_layering_check.DoCheck

(

sdk_root

)

Definition at line 71 of file embedder_layering_check.py.

def DoCheck(sdk_root):
    return CheckDir(sdk_root, 'runtime')
 
 

Variable Documentation

BIN_LAYER_RE

embedder_layering_check.BIN_LAYER_RE = re.compile(r'^runtime/bin/')

Definition at line 18 of file embedder_layering_check.py.

errors

embedder_layering_check.errors = DoCheck('.')

Definition at line 76 of file embedder_layering_check.py.

EXTRA_TEST_FILES

list embedder_layering_check.EXTRA_TEST_FILES

Initial value:

=  [
    'runtime/bin/run_vm_tests.cc',
    'runtime/bin/ffi_unit_test/run_ffi_unit_tests.cc',
    'runtime/vm/libfuzzer/dart_libfuzzer.cc'
]

Definition at line 21 of file embedder_layering_check.py.

INCLUDE_DIRECTIVE_RE

embedder_layering_check.INCLUDE_DIRECTIVE_RE = re.compile(r'^#include "(.*)"')

Definition at line 14 of file embedder_layering_check.py.

PLATFORM_LAYER_RE

embedder_layering_check.PLATFORM_LAYER_RE = re.compile(r'^runtime/platform/')

Definition at line 16 of file embedder_layering_check.py.

VM_LAYER_RE

embedder_layering_check.VM_LAYER_RE = re.compile(r'^runtime/(vm|lib)/')

Definition at line 17 of file embedder_layering_check.py.