scripts.database.Database Class Reference

Inheritance diagram for scripts.database.Database:

Public Member Functions
def	__init__ (self, root_dir)
def	Clone (self)
def	Delete (self)
def	Load (self)
def	Cache (self)
def	LoadFromCache (self)
def	Save (self)
def	HasInterface (self, interface_name)
def	GetInterface (self, interface_name)
def	AddInterface (self, interface)
def	GetInterfaces (self)
def	DeleteInterface (self, interface_name)
def	Hierarchy (self, interface)
def	HasEnum (self, enum_name)
def	GetEnum (self, enum_name)
def	AddEnum (self, enum)
def	HasDictionary (self, dictionary_name)
def	GetDictionary (self, dictionary_name)
def	AddDictionary (self, dictionary)
def	GetDictionaries (self)
def	HasTypeDef (self, type_def_name)
def	GetTypeDef (self, type_def_name)
def	AddTypeDef (self, type_def)
def	TransitiveSecondaryParents (self, interface, propagate_event_target)

Detailed Description

The Database class manages a collection of IDL files stored
inside a directory.

Each IDL is describing a single interface. The IDL files are written in the
FremontCut syntax, which is derived from the Web IDL syntax and includes
annotations.

Database operations include adding, updating and removing IDL files.

Definition at line 20 of file database.py.

Constructor & Destructor Documentation

__init__()

def scripts.database.Database.__init__	(		self,
			root_dir
	)

Initializes a Database over a given directory.

Args:
root_dir -- a directory. If directory does not exist, it will
be created.

Definition at line 31 of file database.py.

    def __init__(self, root_dir):
        """Initializes a Database over a given directory.
 
    Args:
      root_dir -- a directory. If directory does not exist, it will
      be created.
    """
        self._root_dir = root_dir
        if not os.path.exists(root_dir):
            _logger.debug('creating root directory %s' % root_dir)
            os.makedirs(root_dir)
        self._all_interfaces = {}
        self._interfaces_to_delete = []
        self._enums = {}
        self._all_dictionaries = {}
        # TODO(terry): Hack to remember all typedef unions.
        self._all_type_defs = {}
 

Member Function Documentation

AddDictionary()

def scripts.database.Database.AddDictionary	(		self,
			dictionary
	)

Returns an IDLDictionary corresponding to the dictionary_name
from memory.

Args:
dictionary -- the name of the dictionary.

Definition at line 269 of file database.py.

    def AddDictionary(self, dictionary):
        """Returns an IDLDictionary corresponding to the dictionary_name
    from memory.
 
    Args:
      dictionary -- the name of the dictionary.
    """
        dictionary_name = dictionary.id
        if dictionary_name in self._all_dictionaries:
            raise RuntimeError('Dictionary %s already exists' % dictionary_name)
        self._all_dictionaries[dictionary_name] = dictionary
 

AddEnum()

def scripts.database.Database.AddEnum	(		self,
			enum
	)

Definition at line 251 of file database.py.

    def AddEnum(self, enum):
        self._enums[enum.id] = enum
 

AddInterface()

def scripts.database.Database.AddInterface	(		self,
			interface
	)

Returns an IDLInterface corresponding to the interface_name
from memory.

Args:
interface -- the name of the interface.

Definition at line 197 of file database.py.

    def AddInterface(self, interface):
        """Returns an IDLInterface corresponding to the interface_name
    from memory.
 
    Args:
      interface -- the name of the interface.
    """
        interface_name = interface.id
        if interface_name in self._all_interfaces:
            raise RuntimeError('Interface %s already exists' % interface_name)
        self._all_interfaces[interface_name] = interface
 

AddTypeDef()

def scripts.database.Database.AddTypeDef	(		self,
			type_def
	)

Add only a typedef that a unions they map to any (no type).

Definition at line 303 of file database.py.

    def AddTypeDef(self, type_def):
        """Add only a typedef that a unions they map to any (no type)."""
        type_def_name = type_def.id
        if type_def_name in self._all_type_defs:
            raise RuntimeError('Typedef %s already exists' % type_def_name)
        self._all_type_defs[type_def_name] = type_def
        print('  Added typedef %s' % type_def_name)
 

Cache()

def scripts.database.Database.Cache

(

self

)

Serialize the database using pickle for faster startup in the future

Definition at line 131 of file database.py.

    def Cache(self):
        """Serialize the database using pickle for faster startup in the future
    """
        output_file = open(os.path.join(self._root_dir, 'cache.pickle'), 'wb')
        pickle.dump(self._all_interfaces, output_file)
        pickle.dump(self._interfaces_to_delete, output_file)
 

Clone()

def scripts.database.Database.Clone

(

self

)

Definition at line 49 of file database.py.

    def Clone(self):
        new_database = Database(self._root_dir)
        new_database._all_interfaces = copy.deepcopy(self._all_interfaces)
        new_database._interfaces_to_delete = copy.deepcopy(
            self._interfaces_to_delete)
        new_database._enums = copy.deepcopy(self._enums)
        new_database._all_dictionaries = copy.deepcopy(self._all_dictionaries)
        new_database._all_type_defs = copy.deepcopy(self._all_type_defs)
 
        return new_database
 

Delete()

def scripts.database.Database.Delete

(

self

)

Deletes the database by deleting its directory

Definition at line 60 of file database.py.

    def Delete(self):
        """Deletes the database by deleting its directory"""
        if os.path.exists(self._root_dir):
            shutil.rmtree(self._root_dir)
        # reset in-memory constructs
        self._all_interfaces = {}
 

DeleteInterface()

def scripts.database.Database.DeleteInterface	(		self,
			interface_name
	)

Deletes an interface from the database. File is deleted when
Save() is called.

Args:
interface_name -- the name of the interface.

Definition at line 216 of file database.py.

    def DeleteInterface(self, interface_name):
        """Deletes an interface from the database. File is deleted when
    Save() is called.
 
    Args:
      interface_name -- the name of the interface.
    """
        if interface_name not in self._all_interfaces:
            raise RuntimeError('Interface %s not found' % interface_name)
        self._interfaces_to_delete.append(interface_name)
        del self._all_interfaces[interface_name]
 

GetDictionaries()

def scripts.database.Database.GetDictionaries

(

self

)

Returns a list of all loaded dictionaries.

Definition at line 281 of file database.py.

    def GetDictionaries(self):
        """Returns a list of all loaded dictionaries."""
        res = []
        for _, dictionary in sorted(self._all_dictionaries.items()):
            res.append(dictionary)
        return res
 

GetDictionary()

def scripts.database.Database.GetDictionary	(		self,
			dictionary_name
	)

Returns an IDLDictionary corresponding to the dictionary_name
from memory.

Args:
dictionary_name -- the name of the dictionary.

Definition at line 258 of file database.py.

    def GetDictionary(self, dictionary_name):
        """Returns an IDLDictionary corresponding to the dictionary_name
    from memory.
 
    Args:
      dictionary_name -- the name of the dictionary.
    """
        if dictionary_name not in self._all_dictionaries:
            raise RuntimeError('Dictionary %s is not loaded' % dictionary_name)
        return self._all_dictionaries[dictionary_name]
 

GetEnum()

def scripts.database.Database.GetEnum	(		self,
			enum_name
	)

Definition at line 248 of file database.py.

    def GetEnum(self, enum_name):
        return self._enums[enum_name]
 

GetInterface()

def scripts.database.Database.GetInterface	(		self,
			interface_name
	)

Returns an IDLInterface corresponding to the interface_name
from memory.

Args:
interface_name -- the name of the interface.

Definition at line 186 of file database.py.

    def GetInterface(self, interface_name):
        """Returns an IDLInterface corresponding to the interface_name
    from memory.
 
    Args:
      interface_name -- the name of the interface.
    """
        if interface_name not in self._all_interfaces:
            raise RuntimeError('Interface %s is not loaded' % interface_name)
        return self._all_interfaces[interface_name]
 

GetInterfaces()

def scripts.database.Database.GetInterfaces

(

self

)

Returns a list of all loaded interfaces.

Definition at line 209 of file database.py.

    def GetInterfaces(self):
        """Returns a list of all loaded interfaces."""
        res = []
        for _, interface in sorted(self._all_interfaces.items()):
            res.append(interface)
        return res
 

GetTypeDef()

def scripts.database.Database.GetTypeDef	(		self,
			type_def_name
	)

Returns an IDLTypeDef corresponding to the type_def_name
from memory.

Args:
type_def_name -- the name of the typedef.

Definition at line 292 of file database.py.

    def GetTypeDef(self, type_def_name):
        """Returns an IDLTypeDef corresponding to the type_def_name
    from memory.
 
    Args:
      type_def_name -- the name of the typedef.
    """
        if type_def_name not in self._all_type_defs:
            raise RuntimeError('Typedef %s is not loaded' % type_def_name)
        return self._all_type_defs[type_def_name]
 

HasDictionary()

def scripts.database.Database.HasDictionary	(		self,
			dictionary_name
	)

Returns True if the dictionary is in memory

Definition at line 254 of file database.py.

    def HasDictionary(self, dictionary_name):
        """Returns True if the dictionary is in memory"""
        return dictionary_name in self._all_dictionaries
 

HasEnum()

def scripts.database.Database.HasEnum	(		self,
			enum_name
	)

Definition at line 245 of file database.py.

    def HasEnum(self, enum_name):
        return enum_name in self._enums
 

HasInterface()

def scripts.database.Database.HasInterface	(		self,
			interface_name
	)

Returns True if the interface is in memory

Definition at line 182 of file database.py.

    def HasInterface(self, interface_name):
        """Returns True if the interface is in memory"""
        return interface_name in self._all_interfaces
 

HasTypeDef()

def scripts.database.Database.HasTypeDef	(		self,
			type_def_name
	)

Returns True if the typedef is in memory

Definition at line 288 of file database.py.

    def HasTypeDef(self, type_def_name):
        """Returns True if the typedef is in memory"""
        return type_def_name in self._all_type_defs
 

Hierarchy()

def scripts.database.Database.Hierarchy	(		self,
			interface
	)

Definition at line 235 of file database.py.

    def Hierarchy(self, interface):
        yield interface
        for parent in interface.parents:
            parent_name = parent.type.id
            if not self.HasInterface(parent.type.id):
                continue
            for parent_interface in self.Hierarchy(
                    self.GetInterface(parent.type.id)):
                yield parent_interface
 

Load()

def scripts.database.Database.Load

(

self

)

Loads all interfaces into memory.

Definition at line 123 of file database.py.

    def Load(self):
        """Loads all interfaces into memory.
    """
        # FIXME: Speed this up by multi-threading.
        for (interface_name) in self._ScanForInterfaces():
            self._LoadInterfaceFile(interface_name)
        self.Cache()
 

LoadFromCache()

def scripts.database.Database.LoadFromCache

(

self

)

Deserialize the database using pickle for fast startup

Definition at line 138 of file database.py.

    def LoadFromCache(self):
        """Deserialize the database using pickle for fast startup
    """
        input_file_name = os.path.join(self._root_dir, 'cache.pickle')
        if not os.path.isfile(input_file_name):
            self.Load()
            return
        input_file = open(input_file_name, 'rb')
        self._all_interfaces = pickle.load(input_file)
        self._interfaces_to_delete = pickle.load(input_file)
        input_file.close()
 

Save()

def scripts.database.Database.Save

(

self

)

Saves all in-memory interfaces into files.

Definition at line 150 of file database.py.

    def Save(self):
        """Saves all in-memory interfaces into files."""
        for interface in list(self._all_interfaces.values()):
            self._SaveInterfaceFile(interface)
        for interface_name in self._interfaces_to_delete:
            self._DeleteInterfaceFile(interface_name)
 

TransitiveSecondaryParents()

def scripts.database.Database.TransitiveSecondaryParents	(		self,
			interface,
			propagate_event_target
	)

Returns a list of all non-primary parents.

The list contains the interface objects for interfaces defined in the
database, and the name for undefined interfaces.

Definition at line 311 of file database.py.

    def TransitiveSecondaryParents(self, interface, propagate_event_target):
        """Returns a list of all non-primary parents.
 
    The list contains the interface objects for interfaces defined in the
    database, and the name for undefined interfaces.
    """
 
        def walk(parents, walk_result):
            for parent in parents:
                parent_name = parent.type.id
                if IsDartCollectionType(parent_name):
                    if not (parent_name in walk_result):
                        walk_result.append(parent_name)
                    continue
                if self.HasInterface(parent_name):
                    parent_interface = self.GetInterface(parent_name)
                    if not (parent_interface in walk_result):
                        # Interface has multi-inherited don't add interfaces more than once
                        # to our parent result list.
                        walk_result.append(parent_interface)
                    walk(parent_interface.parents, walk_result)
            return walk_result
 
        result = []
        if interface.parents:
            parent = interface.parents[0]
            if (IsPureInterface(parent.type.id, self) or
                (propagate_event_target and parent.type.id == 'EventTarget')):
                result = walk(interface.parents, [])
            else:
                result = walk(interface.parents[1:], [])
 
        return result

---

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

• third_party/dart-lang/sdk/tools/dom/scripts/database.py