litex/migen/fhdl/autofragment.py

import collections

from migen.fhdl.structure import *
from migen.fhdl.specials import Special
from migen.fhdl.tools import flat_iteration

def flat_list(e):
	if isinstance(e, collections.Iterable):
		return flat_iteration(e)
	else:
		return [e]

class _FModuleProxy:
	def __init__(self, fm):
		object.__setattr__(self, "_fm", fm)

class _FModuleComb(_FModuleProxy):
	def __iadd__(self, other):
		self._fm._fragment.comb += flat_list(other)
		return self

def _cd_append(d, key, statements):
	try:
		l = d[key]
	except KeyError:
		l = []
		d[key] = l
	l += flat_list(statements)

class _FModuleSyncCD:
	def __init__(self, fm, cd):
		self._fm = fm
		self._cd = cd

	def __iadd__(self, other):
		_cd_append(self._fm._fragment.sync, self._cd, other)
		return self

class _FModuleSync(_FModuleProxy):
	def __iadd__(self, other):
		_cd_append(self._fm._fragment.sync, "sys", other)
		return self

	def __getattr__(self, name):
		return _FModuleSyncCD(self._fm, name)

	def __setattr__(self, name, value):
		if not isinstance(value, _FModuleSyncCD):
			raise AttributeError("Attempted to assign sync property - use += instead")

class _FModuleSpecials(_FModuleProxy):
	def __iadd__(self, other):
		self._fm._fragment.specials |= set(flat_list(other))
		return self

class _FModuleSubmodules(_FModuleProxy):
	def __iadd__(self, other):
		self._fm._submodules += flat_list(other)
		return self

class FModule:
	auto_attr = True

	def get_fragment(self):
		assert(not hasattr(self, "_fragment"))
		self._fragment = Fragment()
		self._submodules = []
		self.build_fragment()
		if hasattr(self, "do_simulation"):
			self._fragment.sim.append(self.do_simulation)
		for submodule in self._submodules:
			self._fragment += submodule.get_fragment()
		if self.auto_attr:
			for x in self.__dict__.values():
				if isinstance(x, Special):
					self._fragment.specials.add(x)
				elif hasattr(x, "get_fragment"):
					self._fragment += x.get_fragment()
		return self._fragment

	def __getattr__(self, name):
		if name == "comb":
			return _FModuleComb(self)
		elif name == "sync":
			return _FModuleSync(self)
		elif name == "specials":
			return _FModuleSpecials(self)
		elif name == "submodules":
			return _FModuleSubmodules(self)
		else:
			raise AttributeError("'"+self.__class__.__name__+"' object has no attribute '"+name+"'")

	def __setattr__(self, name, value):
		if name in ["comb", "sync", "specials", "submodules"]:
			if not isinstance(value, _FModuleProxy):
				raise AttributeError("Attempted to assign special FModule property - use += instead")
		else:
			object.__setattr__(self, name, value)

	def build_fragment(self):
		pass # do nothing (e.g. module has only submodules)