# -*- python -*-
# -*- coding: utf8 -*-
#
# OpenAlea.OALab: Multi-Paradigm GUI
#
# Copyright 2013 INRIA - CIRAD - INRA
#
# File author(s): Julien Coste <julien.coste@inria.fr>
#
# File contributor(s): Guillaume Bâty <guillaume.baty@inria.fr>
#
# Distributed under the Cecill-C License.
# See accompanying file LICENSE.txt or copy at
# http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.html
#
# OpenAlea WebSite : http://openalea.gforge.inria.fr
#
###############################################################################
__revision__ = ""
from openalea.core import logger
from openalea.core import settings
from openalea.core.model import Model
from openalea.core.path import path
from openalea.core.project import Project
from openalea.core.service.data import DataFactory, DataClass, DataType, MimeType
from openalea.core.service.plugin import debug_plugin, plugins, plugin_instance_exists
from openalea.oalab.paradigm.creator import ParadigmCreator
from openalea.oalab.project.dialog import SelectCategory
from openalea.oalab.service.applet import get_applet
from openalea.oalab.utils import ModalDialog
from openalea.oalab.utils import qicon
from openalea.oalab.widget import resources_rc # do not remove this import else icon are not drawn
from openalea.oalab.widget.pages import WelcomePage
from openalea.vpltk.qt import QtCore, QtGui
from openalea.vpltk.qt.compat import getopenfilename, getsavefilename
[docs]class ParadigmContainer(QtGui.QTabWidget):
"""
Widget to edit and run models.
Contains paradigm applets (oalab.paradigm_applet)
"""
identifier = "WidgetEditorContainer"
name = "Editor Container"
def __init__(self, parent=None):
super(ParadigmContainer, self).__init__(parent=parent)
self.setTabsClosable(True)
self.applets = []
self._open_tabs = {}
self.paradigm = ParadigmCreator()
self.paradigm.paradigm_clicked.connect(self.new_paradigm)
self.welcome_actions = self.paradigm.actions()
self._open_objects = {}
self.connect(self, QtCore.SIGNAL('tabCloseRequested(int)'), self.auto_close)
self.connect(self, QtCore.SIGNAL('currentChanged(int)'), self.safe_display_help)
self.add_default_tab()
self.fine_tune()
[docs] def fine_tune(self):
self.setDocumentMode(True)
# self.setMinimumSize(100, 100)
self.setAccessibleName("Container")
self.setElideMode(QtCore.Qt.ElideLeft)
[docs] def initialize(self):
self.reset()
def _on_text_changed(self, *args):
tab = self.sender()
idx = self.indexOf(tab)
if idx >= 0:
self._set_tab_red(idx)
###########################################################################
# Convenience method
###########################################################################
def _data_label(self, obj):
if hasattr(obj, 'category'):
return '%s/%s' % (obj.category, obj.filename)
elif hasattr(obj, 'path'):
return '%s/%s' % (obj.path.parent.name, obj.filename)
else:
return obj.filename
def _tab(self, tab):
if tab:
return tab
if tab is None:
tab = self.currentWidget()
if tab in self._open_tabs:
return tab
else:
return None
def _data(self, tab=None):
return self._open_tabs[self._tab(tab)]
###########################################################################
# Open/Close data
###########################################################################
[docs] def open_file(self, filepath=None):
if filepath in(None, True, False):
filepath, filters = getopenfilename(self, u"Select file")
if filepath is None:
return
filepath = path(filepath).normpath().abspath()
# check if a data in container yet correspond to this path
found = None
for data in self._open_objects:
if filepath == data.path.normpath().abspath():
found = data
# If not, create a new data
if found:
data = found
else:
data = DataFactory(filepath)
self.open_data(data)
return data
[docs] def open_data(self, obj):
# Check if object is yet open else create applet
if obj in self._open_objects:
tab = self._open_objects[obj]
self.setCurrentWidget(tab)
else:
applet = self.paradigm.applet(obj, obj.default_name)
if hasattr(applet, 'textChanged'):
applet.textChanged.connect(self._on_text_changed)
self.remove_tab("Welcome")
idx = self.addTab(applet, self._data_label(obj))
if obj.path:
self.setTabToolTip(idx, obj.path)
self.setCurrentIndex(idx)
self._open_objects[obj] = applet
self._open_tabs[applet] = obj
[docs] def close(self, tab=None):
if tab is None:
tab = self.currentWidget()
idx = self.indexOf(tab)
self.removeTab(idx)
if tab in self._open_tabs:
obj = self._open_tabs[tab]
del self._open_objects[obj]
del self._open_tabs[tab]
tab.close()
if self.count() == 0:
self.add_default_tab()
[docs] def close_current(self):
self.close()
[docs] def close_data(self, obj):
if obj in self._open_objects:
tab = self._open_objects[obj]
self.close(tab)
[docs] def auto_close(self, n_tab):
self.close(self.widget(n_tab))
[docs] def close_all(self):
n = self.count()
for i in range(n):
self.close_current()
###########################################################################
# New
###########################################################################
[docs] def new_paradigm(self, dtype):
p, filters = getsavefilename(self, "New file")
if p:
if p.exists():
p.remove()
data = DataFactory(p, dtype=dtype)
self.open_data(data)
###########################################################################
# Apply
###########################################################################
[docs] def apply(self, tab=None):
tab = self._tab(tab)
try:
applet = tab.applet
except AttributeError:
return
applet.apply()
[docs] def apply_all(self):
"""
Save all opened files
"""
n = self.count()
for i in range(n):
self.apply(tab=self.widget(i))
###########################################################################
# Save
###########################################################################
[docs] def save(self, tab=None):
tab = self._tab(tab)
self.apply(tab)
obj = self._data(tab)
obj.save()
self._set_tab_black(self.indexOf(tab))
[docs] def save_current(self):
self.save()
[docs] def save_all(self):
"""
Save all opened files
"""
n = self.count()
for i in range(n):
self.save(tab=self.widget(i))
###########################################################################
# Tab coloration
###########################################################################
def _set_tab_red(self, index=None):
if index is None:
index = self.currentIndex()
if index != -1:
self.tabBar().setTabTextColor(index, QtCore.Qt.red)
def _set_tab_black(self, index=None):
if index is None:
index = self.currentIndex()
if index != -1:
self.tabBar().setTabTextColor(index, QtCore.Qt.black)
[docs] def set_all_tab_black(self):
for index in range(self.count()):
self._set_tab_black(index)
###########################################################################
# Tab management
###########################################################################
[docs] def remove_tab(self, tabname="Welcome"):
"""
Remove the tab named "tabname"
:param tabname: name of the tab to remove. Default: "Welcome"
"""
for i in range(self.count()):
if self.tabText(i) == tabname:
self.removeTab(i)
[docs] def reset(self):
"""
Delete all tabs
"""
self.close_all()
[docs] def set_welcome_actions(self, actions=[]):
self.welcome_actions = actions
[docs] def add_welcome_tab(self, actions):
self.remove_tab("Welcome")
welcomePage = WelcomePage(actions=actions, parent=self.parent(), style=WelcomePage.STYLE_MEDIUM)
self.addTab(welcomePage, "Welcome")
[docs] def add_default_tab(self):
self.add_welcome_tab(self.welcome_actions)
[docs] def safe_display_help(self):
"""
Call focus_change method on widget.applet safely (if it exists well).
"""
widget = self.currentWidget()
if widget is not None:
if hasattr(widget, "display_help"):
widget.display_help()
###########################################################################
# Run models
###########################################################################
[docs] def execute(self):
self.currentWidget().applet.execute()
logger.debug("Execute selected part " + self.currentWidget().applet.name)
[docs] def run(self):
self.currentWidget().applet.run()
logger.debug("Run " + self.currentWidget().applet.name)
[docs] def run_in_shell(self):
self.currentWidget().applet.run(run_in_shell=True)
logger.debug("Run " + self.currentWidget().applet.name)
[docs] def animate(self):
self.currentWidget().applet.animate()
logger.debug("Animate " + self.currentWidget().applet.name)
[docs] def step(self):
self.currentWidget().applet.step()
logger.debug("Step " + self.currentWidget().applet.name)
[docs] def stop(self):
self.currentWidget().applet.stop()
logger.debug("Stop " + self.currentWidget().applet.name)
[docs] def init(self):
self.currentWidget().applet.init()
logger.debug("Init " + self.currentWidget().applet.name)
[docs]class ModelEditorApplet(ParadigmContainer):
def __init__(self, parent=None):
ParadigmContainer.__init__(self, parent=parent)
self._create_actions()
self._create_connections()
def _create_actions(self):
# Create actions
self.actionRun = QtGui.QAction(qicon("run.png"), "Run", self)
self.actionRunInShell = QtGui.QAction(qicon("run.png"), "Run in shell", self)
menu_run = QtGui.QMenu("Run", self)
menu_run.addActions([self.actionRun, self.actionRunInShell])
self.toolbutton_run = QtGui.QToolButton(self)
self.toolbutton_run.setMenu(menu_run)
self.toolbutton_run.setDefaultAction(self.actionRun)
self.actionAnimate = QtGui.QAction(qicon("play.png"), "Animate", self)
self.actionStep = QtGui.QAction(qicon("step.png"), "Step", self)
self.actionStop = QtGui.QAction(qicon("pause.png"), "Stop", self)
self.actionInit = QtGui.QAction(qicon("rewind.png"), "Init", self)
self.actionRunSelection = QtGui.QAction(qicon("run.png"), "Run subpart", self)
# File I/O
self.actionCloseCurrent = QtGui.QAction(qicon("close_file.png"), "Close current tab", self)
self.actionOpenFile = QtGui.QAction(qicon("open_file.png"), "Open file", self)
self.actionSave = QtGui.QAction(qicon("save_file.png"), "Save File", self)
self.actionSaveAs = QtGui.QAction(qicon("save_file.png"), "Save As", self)
# Add shortcuts
#self.actionInit.setShortcut("F1")
self.actionAnimate.setShortcut("F2")
self.actionRun.setShortcuts(["F1", "Ctrl+R"])
self.actionRunSelection.setShortcut(self.tr("Ctrl+E"))
self.actionStep.setShortcut("F3")
self.actionStop.setShortcut("F4")
self.actionCloseCurrent.setShortcut(self.tr("Ctrl+W"))
self.actionOpenFile.setShortcut(self.tr("Ctrl+O"))
self.actionSave.setShortcut(self.tr("Ctrl+S"))
#self.actionSaveAs.setShortcut(self.tr("Ctrl+Shift+S"))
# Store actions
self._run_actions = [
self.actionAnimate,
self.actionInit,
self.toolbutton_run,
self.actionRunSelection,
self.actionStep,
self.actionStop,
]
self._actions = [
["Project", "Play", self.actionRun, 0],
["Project", "Play", self.actionAnimate, 0],
["Project", "Play", self.actionStep, 0],
["Project", "Play", self.actionStop, 0],
["Project", "Play", self.actionInit, 0],
]
def _create_connections(self):
self.currentChanged.connect(self.on_current_tab_changed)
self.actionAnimate.triggered.connect(self.animate)
self.actionInit.triggered.connect(self.init)
self.actionRun.triggered.connect(self.run)
self.actionRunInShell.triggered.connect(self.run_in_shell)
self.actionRunSelection.triggered.connect(self.execute)
self.actionStep.triggered.connect(self.step)
self.actionStop.triggered.connect(self.stop)
self.actionCloseCurrent.triggered.connect(self.close_current)
self.actionOpenFile.triggered.connect(self.open_file)
self.actionSave.triggered.connect(self.save_current)
[docs] def actions(self):
"""
:return: list of actions to set in the menu.
"""
return self._actions
[docs] def on_current_tab_changed(self):
try:
runnable = self.currentWidget().applet.runnable()
except AttributeError:
runnable = False
self._set_run_mode(runnable)
def _set_run_mode(self, mode=True):
for action in self._run_actions:
action.setEnabled(mode)
if isinstance(action, QtGui.QToolButton):
for act in action.actions():
act.setEnabled(mode)