QGIS/python/plugins/processing/gui/NumberInputPanel.py

# -*- coding: utf-8 -*-

"""
***************************************************************************
    NumberInputPanel.py
    ---------------------
    Date                 : August 2012
    Copyright            : (C) 2012 by Victor Olaya
    Email                : volayaf at gmail dot com
***************************************************************************
*                                                                         *
*   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 2 of the License, or     *
*   (at your option) any later version.                                   *
*                                                                         *
***************************************************************************
"""
from builtins import str
from builtins import range

__author__ = 'Victor Olaya'
__date__ = 'August 2012'
__copyright__ = '(C) 2012, Victor Olaya'

# This will get replaced with a git SHA1 when you do a git archive

__revision__ = '$Format:%H$'

import os

from qgis.PyQt import uic
from qgis.PyQt.QtCore import pyqtSignal
from qgis.PyQt.QtWidgets import QDialog

from qgis.core import (QgsDataSourceUri,
                       QgsCredentials,
                       QgsExpression,
                       QgsRasterLayer,
                       QgsExpressionContextScope)
from qgis.gui import QgsEncodingFileDialog, QgsExpressionBuilderDialog
from qgis.utils import iface
from processing.core.parameters import ParameterNumber, ParameterVector, ParameterRaster
from processing.core.outputs import OutputNumber, OutputVector, OutputRaster
from processing.modeler.ModelerAlgorithm import ValueFromInput, ValueFromOutput, CompoundValue

pluginPath = os.path.split(os.path.dirname(__file__))[0]
WIDGET, BASE = uic.loadUiType(
    os.path.join(pluginPath, 'ui', 'widgetBaseSelector.ui'))


class NumberInputPanel(BASE, WIDGET):

    hasChanged = pyqtSignal()

    def __init__(self, param, modelParametersDialog=None):
        super(NumberInputPanel, self).__init__(None)
        self.setupUi(self)

        self.param = param
        self.modelParametersDialog = modelParametersDialog
        if param.default:
            self.setValue(param.default)
        self.btnSelect.clicked.connect(self.showExpressionsBuilder)
        self.leText.textChanged.connect(lambda: self.hasChanged.emit())

    def showExpressionsBuilder(self):
        context = self.param.expressionContext()
        if self.modelParametersDialog is not None:
            context.popScope()
            values = self.modelParametersDialog.getAvailableValuesOfType(ParameterNumber, OutputNumber)
            variables = {}
            for value in values:
                if isinstance(value, ValueFromInput):
                    name = value.name
                    element = self.modelParametersDialog.model.inputs[name].param
                    desc = element.description
                else:
                    name = "%s_%s" % (value.alg, value.output)
                    alg = self.modelParametersDialog.model.algs[value.alg]
                    out = alg.algorithm.getOutputFromName(value.output)
                    desc = "Output '%s' from algorithm '%s" % (out.description, alg.description)
                variables[name] = desc
            values = self.modelParametersDialog.getAvailableValuesOfType(ParameterVector, OutputVector)
            values.extend(self.modelParametersDialog.getAvailableValuesOfType(ParameterRaster, OutputRaster))
            for value in values:
                if isinstance(value, ValueFromInput):
                    name = value.name
                    element = self.modelParametersDialog.model.inputs[name].param
                    desc = element.description
                else:
                    name = "%s_%s" % (value.alg, value.output)
                    alg = self.modelParametersDialog.model.algs[value.alg]
                    element = alg.algorithm.getOutputFromName(value.output)
                    desc = "Output '%s' from algorithm '%s" % (element.description, alg.description)
                variables['%s_minx' % name] = "Minimum X of %s" % desc
                variables['%s_miny' % name] = "Maximum X of %s" % desc
                variables['%s_maxx' % name] = "Minimum Y of %s" % desc
                variables['%s_maxy' % name] = "Maximum Y of %s" % desc
                if isinstance(element, (ParameterRaster, OutputRaster)):
                    variables['%s_min' % name] = "Minimum value of %s" % desc
                    variables['%s_max' % name] = "Maximum value of %s" % desc
                    variables['%s_avg' % name] = "Mean value of %s" % desc
                    variables['%s_stddev' % name] = "Standard deviation of %s" % desc

        dlg = QgsExpressionBuilderDialog(None, self.leText.text(), self, 'generic', context)
        for variable, desc in list(variables.items()):
            dlg.expressionBuilder().registerItem("Modeler", variable, "@" + variable, desc, highlightedItem=True)
        dlg.setWindowTitle(self.tr('Expression based input'))
        if dlg.exec_() == QDialog.Accepted:
            exp = QgsExpression(dlg.expressionText())
            if not exp.hasParserError():
                self.setValue(dlg.expressionText())

    def getValue(self):
        if self.modelParametersDialog:
            value = self.leText.text()
            values = []
            for param in self.modelParametersDialog.model.parameters:
                if isinstance(param, ParameterNumber):
                    if "@" + param.name in value:
                        values.append(ValueFromInput(param.name))
            for alg in list(self.modelParametersDialog.model.algs.values()):
                for out in alg.algorithm.outputs:
                    if isinstance(out, OutputNumber) and "@%s_%s" % (alg.name, out.name) in value:
                        values.append(ValueFromOutput(alg.name, out.name))
            if values:
                return CompoundValue(values, value)
            else:
                return value
        else:
            return self.leText.text()

    def setValue(self, value):
        self.leText.setText(str(value))