#  ___________________________________________________________________________
#
#  Pyomo: Python Optimization Modeling Objects
#  Copyright 2017 National Technology and Engineering Solutions of Sandia, LLC
#  Under the terms of Contract DE-NA0003525 with National Technology and 
#  Engineering Solutions of Sandia, LLC, the U.S. Government retains certain 
#  rights in this software.
#  This software is distributed under the 3-clause BSD License.
#  ___________________________________________________________________________


class Factory(object):
    """
    A class that is used to define a factory for objects.

    Factory objects may be cached for future use.
    """

    def __init__(self, description=None):
        self._description = description
        self._cls = {}
        self._doc = {}
        self._cached = False
        self._cache = {}

    def __call__(self, name, **kwds):
        if 'exception' in kwds:
            exception = kwds['exception']
            del kwds['exception']
        else:
            exception = False
        name = str(name)
        if not name in self._cls:
            if not exception:
                return None
            if self._description is None:
                raise ValueError("Unknown factory object type: '%s'" % name)
            raise ValueError("Unknown %s: '%s'" % (self._description, name))
        if self._cached:
            if name not in self._cache:
                self._cache[name] = self._cls[name](**kwds)
            return self._cache[name]
        return self._cls[name](**kwds)

    def __iter__(self):
        for name in self._cls:
            yield name

    def __contains__(self, name):
        return str(name) in self._cls

    def get_class(self, name):
        return self._cls[name]

    def doc(self, name):
        return self._doc[name]

    def unregister(self, name):
        name = str(name)
        if name in self._cls:
            del self._cls[name]
            del self._doc[name]
    
    def register(self, name, doc=None):
        def fn(cls):
            self._cls[name] = cls
            self._doc[name] = doc
            return cls
        return fn

    #
    # The following methods might be used by developers working
    # with factories defined using PyUtilib component plugins.  These methods
    # are deprecated.
    #
    def services(self):
        raise RuntimeError("ERROR: Factory.services() is not defined.  Use Factory.__iter__() instead.")

    def activate(self):
        raise RuntimeError("ERROR: Factory.activate() is not defined.")

    def deactivate(self):
        raise RuntimeError("ERROR: Factory.deactivate() is not defined.")


class CachedFactory(Factory):
    """
    A class that is used to define a factory for objects.

    Factory objects are cached for future use.
    """

    def __init__(self, description=None):
        Factory.__init__(self, description)
        self._cached = True