gstreamer/subprojects/gst-devtools/debug-viewer/GstDebugViewer/Plugins/__init__.py

# -*- coding: utf-8; mode: python; -*-
#
#  GStreamer Debug Viewer - View and analyze GStreamer debug log files
#
#  Copyright (C) 2007 René Stadler <mail@renestadler.de>
#
#  This program is free software; you can redistribute it and/or modify it
#  under the terms of the GNU General Public License as published by the Free
#  Software Foundation; either version 3 of the License, or (at your option)
#  any later version.
#
#  This program is distributed in the hope that it will be useful, but WITHOUT
#  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
#  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
#  more details.
#
#  You should have received a copy of the GNU General Public License along with
#  this program.  If not, see <http://www.gnu.org/licenses/>.

"""GStreamer Debug Viewer Plugins package."""

__all__ = ["_", "_N", "FeatureBase", "PluginBase"]

import os.path


def _N(s):
    return s


def load(paths=()):

    for path in paths:
        for plugin_module in _load_plugins(path):
            yield plugin_module.Plugin


def _load_plugins(path):

    import importlib
    import glob

    files = glob.glob(os.path.join(path, "*.py"))

    for filename in files:

        name = os.path.basename(os.path.splitext(filename)[0])
        if name == "__init__":
            continue

        finder = importlib.machinery.PathFinder()
        spec = finder.find_spec(
            name,
            os.environ.get('_GI_OVERRIDES_PATH', '').split(os.pathsep)
        )
        if spec is None:
            raise ModuleNotFoundError(name)
        module = importlib.util.module_from_spec(spec)

        yield module


class FeatureBase (object):

    def __init__(self, app):

        pass

    def handle_attach_window(self, window):
        """
        window: GstDebugViewer.GUI.window.Window
        """

        pass

    def handle_attach_log_file(self, window, log_file):
        """
        window: GstDebugViewer.GUI.window.Window
        log_file: GstDebugViewer.Data.LogFile
        """

        pass

    def handle_detach_log_file(self, window, log_file):
        """
        window: GstDebugViewer.GUI.window.Window
        log_file: GstDebugViewer.Data.LogFile
        """

        pass

    def handle_detach_window(self, window):
        """
        window: GstDebugViewer.GUI.window.Window
        """

        pass


class PluginBase (object):
    """
    All plugins must implement a class called Plugin inheriting from PluginBase.
    They should place a tuple of features they export into 'features'. Each
    feature should be a subclass of FeatureBase.
    """

    features = ()

    def __init__(self, app):

        pass