compiler_layering_check.LayeringChecker Class Reference

Inheritance diagram for compiler_layering_check.LayeringChecker:

Public Member Functions
	__init__ (self, root)
	Check (self)
	CheckNotInRuntime (self, files)
	BuildIncludesGraph (self)
	PropagateLayers (self)
	AddAllSourcesToWorklist (self, dir)
	ExtractIncludes (self, file)

Public Attributes
	root
	worklist
	included_into
	loaded
	file_layers

Detailed Description

Definition at line 32 of file compiler_layering_check.py.

Constructor & Destructor Documentation

__init__()

compiler_layering_check.LayeringChecker.__init__	(		self,
			root
	)

Definition at line 34 of file compiler_layering_check.py.

    def __init__(self, root):
        self.root = root
        self.worklist = set()
        # Mapping from header to a set of files it is included into.
        self.included_into = dict()
        # Set of files that were parsed to avoid double parsing.
        self.loaded = set()
        # Mapping from headers to their layer.
        self.file_layers = {file: 'runtime' for file in RUNTIME_LAYER_HEADERS}
 

Member Function Documentation

AddAllSourcesToWorklist()

compiler_layering_check.LayeringChecker.AddAllSourcesToWorklist	(		self,
			dir
	)

Add all *.cc and *.h files from dir recursively into worklist.

Definition at line 97 of file compiler_layering_check.py.

    def AddAllSourcesToWorklist(self, dir):
        """Add all *.cc and *.h files from dir recursively into worklist."""
        for file in os.listdir(dir):
            path = os.path.join(dir, file)
            if os.path.isdir(path):
                self.AddAllSourcesToWorklist(path)
            elif path.endswith('.cc') or path.endswith('.h'):
                self.worklist.add(os.path.relpath(path, self.root))
 

BuildIncludesGraph()

compiler_layering_check.LayeringChecker.BuildIncludesGraph

(

self

)

Definition at line 63 of file compiler_layering_check.py.

    def BuildIncludesGraph(self):
        while self.worklist:
            file = self.worklist.pop()
            deps = self.ExtractIncludes(file)
            self.loaded.add(file)
            for d in deps:
                if d not in self.included_into:
                    self.included_into[d] = set()
                self.included_into[d].add(file)
                if d not in self.loaded:
                    self.worklist.add(d)
 

Check()

compiler_layering_check.LayeringChecker.Check

(

self

)

Definition at line 44 of file compiler_layering_check.py.

    def Check(self):
        self.AddAllSourcesToWorklist(os.path.join(self.root, 'runtime/vm'))
        self.BuildIncludesGraph()
        errors = self.PropagateLayers()
        errors += self.CheckNotInRuntime(SHOULD_NOT_DEPEND_ON_RUNTIME)
        return errors
 

CheckNotInRuntime()

compiler_layering_check.LayeringChecker.CheckNotInRuntime	(		self,
			files
	)

Check that given files do not depend on runtime layer.

Definition at line 51 of file compiler_layering_check.py.

    def CheckNotInRuntime(self, files):
        """Check that given files do not depend on runtime layer."""
        errors = []
        for file in files:
            if not os.path.exists(os.path.join(self.root, file)):
                errors.append('File %s does not exist.' % (file))
            if self.file_layers.get(file) is not None:
                errors.append(
                    'LAYERING ERROR: %s includes object.h or raw_object.h' %
                    (file))
        return errors
 

ExtractIncludes()

compiler_layering_check.LayeringChecker.ExtractIncludes	(		self,
			file
	)

Extract the list of includes from the given file.

Definition at line 106 of file compiler_layering_check.py.

    def ExtractIncludes(self, file):
        """Extract the list of includes from the given file."""
        deps = set()
        with open(os.path.join(self.root, file), encoding='utf-8') as file:
            for line in file:
                if line.startswith('namespace dart {'):
                    break
 
                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(self.root, header)):
                        deps.add(header)
        return deps
 
 

PropagateLayers()

compiler_layering_check.LayeringChecker.PropagateLayers

(

self

)

Propagate layering information through include graph.

If A is in layer L and A is included into B then B is in layer L.

Definition at line 75 of file compiler_layering_check.py.

    def PropagateLayers(self):
        """Propagate layering information through include graph.
 
    If A is in layer L and A is included into B then B is in layer L.
    """
        errors = []
        self.worklist = set(self.file_layers.keys())
        while self.worklist:
            file = self.worklist.pop()
            if file not in self.included_into:
                continue
            file_layer = self.file_layers[file]
            for tgt in self.included_into[file]:
                if tgt in self.file_layers:
                    if self.file_layers[tgt] != file_layer:
                        errors.add(
                            'Layer mismatch: %s (%s) is included into %s (%s)' %
                            (file, file_layer, tgt, self.file_layers[tgt]))
                self.file_layers[tgt] = file_layer
                self.worklist.add(tgt)
        return errors
 

Member Data Documentation

file_layers

compiler_layering_check.LayeringChecker.file_layers

Definition at line 42 of file compiler_layering_check.py.

included_into

compiler_layering_check.LayeringChecker.included_into

Definition at line 38 of file compiler_layering_check.py.

loaded

compiler_layering_check.LayeringChecker.loaded

Definition at line 40 of file compiler_layering_check.py.

root

compiler_layering_check.LayeringChecker.root

Definition at line 35 of file compiler_layering_check.py.

worklist

compiler_layering_check.LayeringChecker.worklist

Definition at line 36 of file compiler_layering_check.py.

---

The documentation for this class was generated from the following file:

• third_party/dart-lang/sdk/runtime/tools/compiler_layering_check.py