Debugger/DebuggerInterfacePython3.py

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

# Copyright (c) 2009 - 2016 Detlev Offenbach <detlev@die-offenbachs.de>
#

"""
Module implementing the Python3 debugger interface for the debug server.
"""

from __future__ import unicode_literals

import sys
import os

from PyQt5.QtCore import QObject, QTextCodec, QProcess, QProcessEnvironment, \
    QTimer
from PyQt5.QtWidgets import QInputDialog

from E5Gui.E5Application import e5App
from E5Gui import E5MessageBox

##from . import DebugProtocol
from . import DebugClientCapabilities

import Preferences
import Utilities

from eric6config import getConfig


ClientDefaultCapabilities = DebugClientCapabilities.HasAll
##EOT = '>EOT<\n'


class DebuggerInterfacePython3(QObject):
    """
    Class implementing the Python debugger interface for the debug server.
    """
    def __init__(self, debugServer, passive):
        """
        Constructor
        
        @param debugServer reference to the debug server (DebugServer)
        @param passive flag indicating passive connection mode (boolean)
        """
        super(DebuggerInterfacePython3, self).__init__()
        
        self.__isNetworked = True
        self.__autoContinue = False
        
        self.debugServer = debugServer
        self.passive = passive
        self.process = None
        
        self.qsock = None
        self.queue = []
        
        # set default values for capabilities of clients
        self.clientCapabilities = ClientDefaultCapabilities
        
        # set translation function
        self.translate = self.__identityTranslation
        
        self.codec = QTextCodec.codecForName(
            str(Preferences.getSystem("StringEncoding")))
        
        if passive:
            # set translation function
            if Preferences.getDebugger("PathTranslation"):
                self.translateRemote = \
                    Preferences.getDebugger("PathTranslationRemote")
                self.translateLocal = \
                    Preferences.getDebugger("PathTranslationLocal")
                self.translate = self.__remoteTranslation
            else:
                self.translate = self.__identityTranslation
        
        # attribute to remember the name of the executed script
        self.__scriptName = ""

    def __identityTranslation(self, fn, remote2local=True):
        """
        Private method to perform the identity path translation.
        
        @param fn filename to be translated (string)
        @param remote2local flag indicating the direction of translation
            (False = local to remote, True = remote to local [default])
        @return translated filename (string)
        """
        return fn
        
    def __remoteTranslation(self, fn, remote2local=True):
        """
        Private method to perform the path translation.
        
        @param fn filename to be translated (string)
        @param remote2local flag indicating the direction of translation
            (False = local to remote, True = remote to local [default])
        @return translated filename (string)
        """
        if remote2local:
            return fn.replace(self.translateRemote, self.translateLocal)
        else:
            return fn.replace(self.translateLocal, self.translateRemote)
        
    def __startProcess(self, program, arguments, environment=None):
        """
        Private method to start the debugger client process.
        
        @param program name of the executable to start (string)
        @param arguments arguments to be passed to the program (list of string)
        @param environment dictionary of environment settings to pass
            (dict of string)
        @return the process object (QProcess) or None
        """
        proc = QProcess()
        if environment is not None:
            env = QProcessEnvironment()
            for key, value in list(environment.items()):
                env.insert(key, value)
            proc.setProcessEnvironment(env)
        args = []
        for arg in arguments:
            args.append(arg)
        proc.start(program, args)
        if not proc.waitForStarted(10000):
            proc = None
        
        return proc
        
    def startRemote(self, port, runInConsole):
        """
        Public method to start a remote Python interpreter.
        
        @param port portnumber the debug server is listening on (integer)
        @param runInConsole flag indicating to start the debugger in a
            console window (boolean)
        @return client process object (QProcess), a flag to indicate
            a network connection (boolean) and the name of the interpreter
            in case of a local execution (string)
        """
        interpreter = Preferences.getDebugger("Python3Interpreter")
        if interpreter == "":
            E5MessageBox.critical(
                None,
                self.tr("Start Debugger"),
                self.tr(
                    """<p>No Python3 interpreter configured.</p>"""))
            return None, False, ""
        
        debugClientType = Preferences.getDebugger("DebugClientType3")
        if debugClientType == "standard":
            debugClient = os.path.join(getConfig('ericDir'),
                                       "DebugClients", "Python3",
                                       "DebugClient.py")
        elif debugClientType == "threaded":
            debugClient = os.path.join(getConfig('ericDir'),
                                       "DebugClients", "Python3",
                                       "DebugClientThreads.py")
        else:
            debugClient = Preferences.getDebugger("DebugClient3")
            if debugClient == "":
                debugClient = os.path.join(sys.path[0],
                                           "DebugClients", "Python3",
                                           "DebugClient.py")
        
        redirect = str(Preferences.getDebugger("Python3Redirect"))
        noencoding = Preferences.getDebugger("Python3NoEncoding") and \
            '--no-encoding' or ''
        
        if Preferences.getDebugger("RemoteDbgEnabled"):
            ipaddr = self.debugServer.getHostAddress(False)
            rexec = Preferences.getDebugger("RemoteExecution")
            rhost = Preferences.getDebugger("RemoteHost")
            if rhost == "":
                rhost = "localhost"
            if rexec:
                args = Utilities.parseOptionString(rexec) + \
                    [rhost, interpreter, debugClient,
                        noencoding, str(port), redirect, ipaddr]
                args[0] = Utilities.getExecutablePath(args[0])
                process = self.__startProcess(args[0], args[1:])
                if process is None:
                    E5MessageBox.critical(
                        None,
                        self.tr("Start Debugger"),
                        self.tr(
                            """<p>The debugger backend could not be"""
                            """ started.</p>"""))
                
                # set translation function
                if Preferences.getDebugger("PathTranslation"):
                    self.translateRemote = \
                        Preferences.getDebugger("PathTranslationRemote")
                    self.translateLocal = \
                        Preferences.getDebugger("PathTranslationLocal")
                    self.translate = self.__remoteTranslation
                else:
                    self.translate = self.__identityTranslation
                return process, self.__isNetworked, ""
        
        # set translation function
        self.translate = self.__identityTranslation
        
        # setup the environment for the debugger
        if Preferences.getDebugger("DebugEnvironmentReplace"):
            clientEnv = {}
        else:
            clientEnv = os.environ.copy()
        envlist = Utilities.parseEnvironmentString(
            Preferences.getDebugger("DebugEnvironment"))
        for el in envlist:
            try:
                key, value = el.split('=', 1)
                if value.startswith('"') or value.startswith("'"):
                    value = value[1:-1]
                clientEnv[str(key)] = str(value)
            except ValueError:
                pass
        
        ipaddr = self.debugServer.getHostAddress(True)
        if runInConsole or Preferences.getDebugger("ConsoleDbgEnabled"):
            ccmd = Preferences.getDebugger("ConsoleDbgCommand")
            if ccmd:
                args = Utilities.parseOptionString(ccmd) + \
                    [interpreter, os.path.abspath(debugClient),
                        noencoding, str(port), '0', ipaddr]
                args[0] = Utilities.getExecutablePath(args[0])
                process = self.__startProcess(args[0], args[1:], clientEnv)
                if process is None:
                    E5MessageBox.critical(
                        None,
                        self.tr("Start Debugger"),
                        self.tr(
                            """<p>The debugger backend could not be"""
                            """ started.</p>"""))
                return process, self.__isNetworked, interpreter
        
        process = self.__startProcess(
            interpreter,
            [debugClient, noencoding, str(port), redirect, ipaddr],
            clientEnv)
        if process is None:
            E5MessageBox.critical(
                None,
                self.tr("Start Debugger"),
                self.tr(
                    """<p>The debugger backend could not be started.</p>"""))
        return process, self.__isNetworked, interpreter

    def startRemoteForProject(self, port, runInConsole):
        """
        Public method to start a remote Python interpreter for a project.
        
        @param port portnumber the debug server is listening on (integer)
        @param runInConsole flag indicating to start the debugger in a
            console window (boolean)
        @return client process object (QProcess), a flag to indicate
            a network connection (boolean) and the name of the interpreter
            in case of a local execution (string)
        """
        project = e5App().getObject("Project")
        if not project.isDebugPropertiesLoaded():
            return None, self.__isNetworked, ""
        
        # start debugger with project specific settings
        interpreter = project.getDebugProperty("INTERPRETER")
        debugClient = project.getDebugProperty("DEBUGCLIENT")
        
        redirect = str(project.getDebugProperty("REDIRECT"))
        noencoding = \
            project.getDebugProperty("NOENCODING") and '--no-encoding' or ''
        
        if project.getDebugProperty("REMOTEDEBUGGER"):
            ipaddr = self.debugServer.getHostAddress(False)
            rexec = project.getDebugProperty("REMOTECOMMAND")
            rhost = project.getDebugProperty("REMOTEHOST")
            if rhost == "":
                rhost = "localhost"
            if rexec:
                args = Utilities.parseOptionString(rexec) + \
                    [rhost, interpreter, os.path.abspath(debugClient),
                        noencoding, str(port), redirect, ipaddr]
                args[0] = Utilities.getExecutablePath(args[0])
                process = self.__startProcess(args[0], args[1:])
                if process is None:
                    E5MessageBox.critical(
                        None,
                        self.tr("Start Debugger"),
                        self.tr(
                            """<p>The debugger backend could not be"""
                            """ started.</p>"""))
                # set translation function
                if project.getDebugProperty("PATHTRANSLATION"):
                    self.translateRemote = \
                        project.getDebugProperty("REMOTEPATH")
                    self.translateLocal = \
                        project.getDebugProperty("LOCALPATH")
                    self.translate = self.__remoteTranslation
                else:
                    self.translate = self.__identityTranslation
                return process, self.__isNetworked, ""
        
        # set translation function
        self.translate = self.__identityTranslation
        
        # setup the environment for the debugger
        if project.getDebugProperty("ENVIRONMENTOVERRIDE"):
            clientEnv = {}
        else:
            clientEnv = os.environ.copy()
        envlist = Utilities.parseEnvironmentString(
            project.getDebugProperty("ENVIRONMENTSTRING"))
        for el in envlist:
            try:
                key, value = el.split('=', 1)
                if value.startswith('"') or value.startswith("'"):
                    value = value[1:-1]
                clientEnv[str(key)] = str(value)
            except ValueError:
                pass
        
        ipaddr = self.debugServer.getHostAddress(True)
        if runInConsole or project.getDebugProperty("CONSOLEDEBUGGER"):
            ccmd = project.getDebugProperty("CONSOLECOMMAND") or \
                Preferences.getDebugger("ConsoleDbgCommand")
            if ccmd:
                args = Utilities.parseOptionString(ccmd) + \
                    [interpreter, os.path.abspath(debugClient),
                        noencoding, str(port), '0', ipaddr]
                args[0] = Utilities.getExecutablePath(args[0])
                process = self.__startProcess(args[0], args[1:], clientEnv)
                if process is None:
                    E5MessageBox.critical(
                        None,
                        self.tr("Start Debugger"),
                        self.tr(
                            """<p>The debugger backend could not be"""
                            """ started.</p>"""))
                return process, self.__isNetworked, interpreter
        
        process = self.__startProcess(
            interpreter,
            [debugClient, noencoding, str(port), redirect, ipaddr],
            clientEnv)
        if process is None:
            E5MessageBox.critical(
                None,
                self.tr("Start Debugger"),
                self.tr(
                    """<p>The debugger backend could not be started.</p>"""))
        return process, self.__isNetworked, interpreter

    def getClientCapabilities(self):
        """
        Public method to retrieve the debug clients capabilities.
        
        @return debug client capabilities (integer)
        """
        return self.clientCapabilities
    
    def newConnection(self, sock):
        """
        Public slot to handle a new connection.
        
        @param sock reference to the socket object (QTcpSocket)
        @return flag indicating success (boolean)
        """
        # If we already have a connection, refuse this one.  It will be closed
        # automatically.
        if self.qsock is not None:
            return False
        
        sock.disconnected.connect(self.debugServer.startClient)
        sock.readyRead.connect(self.__parseClientLine)
        
        self.qsock = sock
        
        # Get the remote clients capabilities
        self.remoteCapabilities()
        return True
    
    def flush(self):
        """
        Public slot to flush the queue.
        """
        # Send commands that were waiting for the connection.
        for cmd in self.queue:
            self.qsock.write(cmd.encode('utf8', 'backslashreplace'))
        
        self.queue = []
    
    def shutdown(self):
        """
        Public method to cleanly shut down.
        
        It closes our socket and shuts down
        the debug client. (Needed on Win OS)
        """
        if self.qsock is None:
            return
        
        # do not want any slots called during shutdown
        self.qsock.disconnected.disconnect(self.debugServer.startClient)
        self.qsock.readyRead.disconnect(self.__parseClientLine)
        
        # close down socket, and shut down client as well.
##        self.__sendCommand('{0}\n'.format(DebugProtocol.RequestShutdown))
        self.__sendJsonCommand("RequestShutdown", {})
        self.qsock.flush()
        
        self.qsock.close()
        
        # reinitialize
        self.qsock = None
        self.queue = []
    
    def isConnected(self):
        """
        Public method to test, if a debug client has connected.
        
        @return flag indicating the connection status (boolean)
        """
        return self.qsock is not None
    
    def remoteEnvironment(self, env):
        """
        Public method to set the environment for a program to debug, run, ...
        
        @param env environment settings (dictionary)
        """
##        self.__sendCommand('{0}{1}\n'.format(
##            DebugProtocol.RequestEnv, str(env)))
        self.__sendJsonCommand("RequestEnvironment", {"environment": env})
    
    def remoteLoad(self, fn, argv, wd, traceInterpreter=False,
                   autoContinue=True, autoFork=False, forkChild=False):
        """
        Public method to load a new program to debug.
        
        @param fn the filename to debug (string)
        @param argv the commandline arguments to pass to the program (string)
        @param wd the working directory for the program (string)
        @keyparam traceInterpreter flag indicating if the interpreter library
            should be traced as well (boolean)
        @keyparam autoContinue flag indicating, that the debugger should not
            stop at the first executable line (boolean)
        @keyparam autoFork flag indicating the automatic fork mode (boolean)
        @keyparam forkChild flag indicating to debug the child after forking
            (boolean)
        """
        self.__autoContinue = autoContinue
        self.__scriptName = os.path.abspath(fn)
        
        wd = self.translate(wd, False)
        fn = self.translate(os.path.abspath(fn), False)
##        self.__sendCommand('{0}{1}\n'.format(
##            DebugProtocol.RequestForkMode, repr((autoFork, forkChild))))
##        self.__sendCommand('{0}{1}|{2}|{3}|{4:d}\n'.format(
##            DebugProtocol.RequestLoad, wd, fn,
##            str(Utilities.parseOptionString(argv)),
##            traceInterpreter))
        self.__sendJsonCommand("RequestLoad", {
            "workdir": wd,
            "filename": fn,
            "argv": Utilities.parseOptionString(argv),
            "traceInterpreter": traceInterpreter,
            "autofork": autoFork,
            "forkChild": forkChild,
        })
    
    def remoteRun(self, fn, argv, wd, autoFork=False, forkChild=False):
        """
        Public method to load a new program to run.
        
        @param fn the filename to run (string)
        @param argv the commandline arguments to pass to the program (string)
        @param wd the working directory for the program (string)
        @keyparam autoFork flag indicating the automatic fork mode (boolean)
        @keyparam forkChild flag indicating to debug the child after forking
            (boolean)
        """
        self.__scriptName = os.path.abspath(fn)
        
        wd = self.translate(wd, False)
        fn = self.translate(os.path.abspath(fn), False)
##        self.__sendCommand('{0}{1}\n'.format(
##            DebugProtocol.RequestForkMode, repr((autoFork, forkChild))))
##        self.__sendCommand('{0}{1}|{2}|{3}\n'.format(
##            DebugProtocol.RequestRun, wd, fn,
##            str(Utilities.parseOptionString(argv))))
        self.__sendJsonCommand("RequestRun", {
            "workdir": wd,
            "filename": fn,
            "argv": Utilities.parseOptionString(argv),
            "autofork": autoFork,
            "forkChild": forkChild,
        })
    
    def remoteCoverage(self, fn, argv, wd, erase=False):
        """
        Public method to load a new program to collect coverage data.
        
        @param fn the filename to run (string)
        @param argv the commandline arguments to pass to the program (string)
        @param wd the working directory for the program (string)
        @keyparam erase flag indicating that coverage info should be
            cleared first (boolean)
        """
        self.__scriptName = os.path.abspath(fn)
        
        wd = self.translate(wd, False)
        fn = self.translate(os.path.abspath(fn), False)
##        self.__sendCommand('{0}{1}@@{2}@@{3}@@{4:d}\n'.format(
##            DebugProtocol.RequestCoverage, wd, fn,
##            str(Utilities.parseOptionString(argv)),
##            erase))
        self.__sendJsonCommand("RequestCoverage", {
            "workdir": wd,
            "filename": fn,
            "argv": Utilities.parseOptionString(argv),
            "erase": erase,
        })

    def remoteProfile(self, fn, argv, wd, erase=False):
        """
        Public method to load a new program to collect profiling data.
        
        @param fn the filename to run (string)
        @param argv the commandline arguments to pass to the program (string)
        @param wd the working directory for the program (string)
        @keyparam erase flag indicating that timing info should be cleared
            first (boolean)
        """
        self.__scriptName = os.path.abspath(fn)
        
        wd = self.translate(wd, False)
        fn = self.translate(os.path.abspath(fn), False)
##        self.__sendCommand('{0}{1}|{2}|{3}|{4:d}\n'.format(
##            DebugProtocol.RequestProfile, wd, fn,
##            str(Utilities.parseOptionString(argv)), erase))
        self.__sendJsonCommand("RequestProfile", {
            "workdir": wd,
            "filename": fn,
            "argv": Utilities.parseOptionString(argv),
            "erase": erase,
        })

    def remoteStatement(self, stmt):
        """
        Public method to execute a Python statement.
        
        @param stmt the Python statement to execute (string). It
              should not have a trailing newline.
        """
##        self.__sendCommand('{0}\n'.format(stmt))
##        self.__sendCommand(DebugProtocol.RequestOK + '\n')
        self.__sendJsonCommand("ExecuteStatement", {
            "statement": stmt,
        })

    def remoteStep(self):
        """
        Public method to single step the debugged program.
        """
##        self.__sendCommand(DebugProtocol.RequestStep + '\n')
        self.__sendJsonCommand("RequestStep", {})

    def remoteStepOver(self):
        """
        Public method to step over the debugged program.
        """
##        self.__sendCommand(DebugProtocol.RequestStepOver + '\n')
        self.__sendJsonCommand("RequestStepOver", {})

    def remoteStepOut(self):
        """
        Public method to step out the debugged program.
        """
##        self.__sendCommand(DebugProtocol.RequestStepOut + '\n')
        self.__sendJsonCommand("RequestStepOut", {})

    def remoteStepQuit(self):
        """
        Public method to stop the debugged program.
        """
##        self.__sendCommand(DebugProtocol.RequestStepQuit + '\n')
        self.__sendJsonCommand("RequestStepQuit", {})

    def remoteContinue(self, special=False):
        """
        Public method to continue the debugged program.
        
        @param special flag indicating a special continue operation
        """
##        self.__sendCommand('{0}{1:d}\n'.format(
##            DebugProtocol.RequestContinue, special))
        self.__sendJsonCommand("RequestContinue", {
            "special": special,
        })

    def remoteBreakpoint(self, fn, line, setBreakpoint, cond=None, temp=False):
        """
        Public method to set or clear a breakpoint.
        
        @param fn filename the breakpoint belongs to (string)
        @param line linenumber of the breakpoint (int)
        @param setBreakpoint flag indicating setting or resetting a
            breakpoint (boolean)
        @param cond condition of the breakpoint (string)
        @param temp flag indicating a temporary breakpoint (boolean)
        """
##        fn = self.translate(fn, False)
##        self.__sendCommand('{0}{1}@@{2:d}@@{3:d}@@{4:d}@@{5}\n'.format(
##            DebugProtocol.RequestBreak, fn, line, temp, set, cond))
        self.__sendJsonCommand("RequestBreakpoint", {
            "filename": self.translate(fn, False),
            "line": line,
            "temporary": temp,
            "setBreakpoint": setBreakpoint,
            "condition": cond,
        })
    
    def remoteBreakpointEnable(self, fn, line, enable):
        """
        Public method to enable or disable a breakpoint.
        
        @param fn filename the breakpoint belongs to (string)
        @param line linenumber of the breakpoint (int)
        @param enable flag indicating enabling or disabling a breakpoint
            (boolean)
        """
##        fn = self.translate(fn, False)
##        self.__sendCommand('{0}{1},{2:d},{3:d}\n'.format(
##            DebugProtocol.RequestBreakEnable, fn, line, enable))
        self.__sendJsonCommand("RequestBreakpointEnable", {
            "filename": self.translate(fn, False),
            "line": line,
            "enable": enable,
        })
    
    def remoteBreakpointIgnore(self, fn, line, count):
        """
        Public method to ignore a breakpoint the next couple of occurrences.
        
        @param fn filename the breakpoint belongs to (string)
        @param line linenumber of the breakpoint (int)
        @param count number of occurrences to ignore (int)
        """
##        fn = self.translate(fn, False)
##        self.__sendCommand('{0}{1},{2:d},{3:d}\n'.format(
##            DebugProtocol.RequestBreakIgnore, fn, line, count))
        self.__sendJsonCommand("RequestBreakpointIgnore", {
            "filename": self.translate(fn, False),
            "line": line,
            "count": count,
        })
    
    def remoteWatchpoint(self, cond, setWatch, temp=False):
        """
        Public method to set or clear a watch expression.
        
        @param cond expression of the watch expression (string)
        @param setWatch flag indicating setting or resetting a watch expression
            (boolean)
        @param temp flag indicating a temporary watch expression (boolean)
        """
        # cond is combination of cond and special (s. watch expression viewer)
##        self.__sendCommand('{0}{1}@@{2:d}@@{3:d}\n'.format(
##            DebugProtocol.RequestWatch, cond, temp, set))
        self.__sendJsonCommand("RequestWatch", {
            "temporary": temp,
            "setWatch": setWatch,
            "condition": cond,
        })
    
    def remoteWatchpointEnable(self, cond, enable):
        """
        Public method to enable or disable a watch expression.
        
        @param cond expression of the watch expression (string)
        @param enable flag indicating enabling or disabling a watch expression
            (boolean)
        """
        # cond is combination of cond and special (s. watch expression viewer)
##        self.__sendCommand('{0}{1},{2:d}\n'.format(
##            DebugProtocol.RequestWatchEnable, cond, enable))
        self.__sendJsonCommand("RequestWatchEnable", {
            "condition": cond,
            "enable": enable,
        })
    
    def remoteWatchpointIgnore(self, cond, count):
        """
        Public method to ignore a watch expression the next couple of
        occurrences.
        
        @param cond expression of the watch expression (string)
        @param count number of occurrences to ignore (int)
        """
        # cond is combination of cond and special (s. watch expression viewer)
##        self.__sendCommand('{0}{1},{2:d}\n'.format(
##            DebugProtocol.RequestWatchIgnore, cond, count))
        self.__sendJsonCommand("RequestWatchIgnore", {
            "condition": cond,
            "count": count,
        })
    
    def remoteRawInput(self, s):
        """
        Public method to send the raw input to the debugged program.
        
        @param s the raw input (string)
        """
##        self.__sendCommand(s + '\n')
        self.__sendJsonCommand("RawInput", {
            "input": s,
        })
    
    def remoteThreadList(self):
        """
        Public method to request the list of threads from the client.
        """
##        self.__sendCommand('{0}\n'.format(DebugProtocol.RequestThreadList))
        self.__sendJsonCommand("RequestThreadList", {})
        
    def remoteSetThread(self, tid):
        """
        Public method to request to set the given thread as current thread.
        
        @param tid id of the thread (integer)
        """
##        self.__sendCommand('{0}{1:d}\n'.format(
##            DebugProtocol.RequestThreadSet, tid))
        self.__sendJsonCommand("RequestThreadSet", {
            "threadID": tid,
        })
        
    def remoteClientVariables(self, scope, filter, framenr=0):
        """
        Public method to request the variables of the debugged program.
        
        @param scope the scope of the variables (0 = local, 1 = global)
        @param filter list of variable types to filter out (list of int)
        @param framenr framenumber of the variables to retrieve (int)
        """
##        self.__sendCommand('{0}{1:d}, {2:d}, {3}\n'.format(
##            DebugProtocol.RequestVariables, framenr, scope, str(filter)))
        self.__sendJsonCommand("RequestVariables", {
            "frameNumber": framenr,
            "scope": scope,
            "filters": filter,
        })
    
    def remoteClientVariable(self, scope, filter, var, framenr=0):
        """
        Public method to request the variables of the debugged program.
        
        @param scope the scope of the variables (0 = local, 1 = global)
        @param filter list of variable types to filter out (list of int)
        @param var list encoded name of variable to retrieve (string)
        @param framenr framenumber of the variables to retrieve (int)
        """
##        self.__sendCommand('{0}{1}, {2:d}, {3:d}, {4}\n'.format(
##            DebugProtocol.RequestVariable, str(var), framenr, scope,
##            str(filter)))
        self.__sendJsonCommand("RequestVariable", {
            "variable": var,
            "frameNumber": framenr,
            "scope": scope,
            "filters": filter,
        })
    
    def remoteClientSetFilter(self, scope, filter):
        """
        Public method to set a variables filter list.
        
        @param scope the scope of the variables (0 = local, 1 = global)
        @param filter regexp string for variable names to filter out (string)
        """
##        self.__sendCommand('{0}{1:d}, "{2}"\n'.format(
##            DebugProtocol.RequestSetFilter, scope, filter))
        self.__sendJsonCommand("RequestSetFilter", {
            "scope": scope,
            "filter": filter,
        })
    
    def setCallTraceEnabled(self, on):
        """
        Public method to set the call trace state.
        
        @param on flag indicating to enable the call trace function (boolean)
        """
##        if on:
##            cmd = "on"
##        else:
##            cmd = "off"
##        self.__sendCommand('{0}{1}\n'.format(
##            DebugProtocol.RequestCallTrace, cmd))
        self.__sendJsonCommand("RequestCallTrace", {
            "enable": on,
        })
    
##    def remoteEval(self, arg):
##        """
##        Public method to evaluate arg in the current context of the debugged
##        program.
##        
##        @param arg the arguments to evaluate (string)
##        """
####        self.__sendCommand('{0}{1}\n'.format(DebugProtocol.RequestEval, arg))
##        self.__sendJsonCommand("RequestEval", {
##            "argument": arg,
##        })
##    
##    def remoteExec(self, stmt):
##        """
##        Public method to execute stmt in the current context of the debugged
##        program.
##        
##        @param stmt statement to execute (string)
##        """
##        self.__sendCommand('{0}{1}\n'.format(DebugProtocol.RequestExec, stmt))
##    
    def remoteBanner(self):
        """
        Public slot to get the banner info of the remote client.
        """
##        self.__sendCommand(DebugProtocol.RequestBanner + '\n')
        self.__sendJsonCommand("RequestBanner", {})
    
    def remoteCapabilities(self):
        """
        Public slot to get the debug clients capabilities.
        """
##        self.__sendCommand(DebugProtocol.RequestCapabilities + '\n')
        self.__sendJsonCommand("RequestCapabilities", {})
    
    def remoteCompletion(self, text):
        """
        Public slot to get the a list of possible commandline completions
        from the remote client.
        
        @param text the text to be completed (string)
        """
##        self.__sendCommand("{0}{1}\n".format(
##            DebugProtocol.RequestCompletion, text))
        self.__sendJsonCommand("RequestCompletion", {
            "text": text,
        })
    
    def remoteUTPrepare(self, fn, tn, tfn, failed, cov, covname, coverase):
        """
        Public method to prepare a new unittest run.
        
        @param fn the filename to load (string)
        @param tn the testname to load (string)
        @param tfn the test function name to load tests from (string)
        @param failed list of failed test, if only failed test should be run
            (list of strings)
        @param cov flag indicating collection of coverage data is requested
            (boolean)
        @param covname filename to be used to assemble the coverage caches
            filename (string)
        @param coverase flag indicating erasure of coverage data is requested
            (boolean)
        """
        self.__scriptName = os.path.abspath(fn)
        
        fn = self.translate(os.path.abspath(fn), False)
##        self.__sendCommand('{0}{1}|{2}|{3}|{4}|{5:d}|{6}|{7:d}\n'.format(
##            DebugProtocol.RequestUTPrepare, fn, tn, tfn, str(failed),
##            cov, covname, coverase))
        self.__sendJsonCommand("RequestUTPrepare", {
            "filename": fn,
            "testname": tn,
            "testfunctionname": tfn,
            "failed": failed,
            "coverage": cov,
            "coveragefile": covname,
            "coverageerase": coverase,
        })
    
    def remoteUTRun(self):
        """
        Public method to start a unittest run.
        """
##        self.__sendCommand('{0}\n'.format(DebugProtocol.RequestUTRun))
        self.__sendJsonCommand("RequestUTRun", {})
    
    def remoteUTStop(self):
        """
        Public method to stop a unittest run.
        """
##        self.__sendCommand('{0}\n'.format(DebugProtocol.RequestUTStop))
        self.__sendJsonCommand("RequestUTStop", {})
    
    def __askForkTo(self):
        """
        Private method to ask the user which branch of a fork to follow.
        """
        selections = [self.tr("Parent Process"),
                      self.tr("Child process")]
        res, ok = QInputDialog.getItem(
            None,
            self.tr("Client forking"),
            self.tr("Select the fork branch to follow."),
            selections,
            0, False)
        if not ok or res == selections[0]:
##            self.__sendCommand(DebugProtocol.ResponseForkTo + 'parent\n')
            self.__sendJsonCommand("ResponseForkTo", {
                "target": "parent",
            })
        else:
##            self.__sendCommand(DebugProtocol.ResponseForkTo + 'child\n')
            self.__sendJsonCommand("ResponseForkTo", {
                "target": "child",
            })
    
    def __parseClientLine(self):
        """
        Private method to handle data from the client.
        """
        while self.qsock and self.qsock.canReadLine():
            qs = self.qsock.readLine()
            if self.codec is not None:
                line = self.codec.toUnicode(qs)
            else:
                line = bytes(qs).decode()
##            if line.endswith(EOT):
##                line = line[:-len(EOT)]
##                if not line:
##                    continue
            
##            print("Server: ", line)          ##debug
            
##            if line.startswith("{") and "jsonrpc" in line:
            self.__handleJsonCommand(line)
            continue
##            
##            eoc = line.find('<') + 1
##            
##            # Deal with case where user has written directly to stdout
##            # or stderr, but not line terminated and we stepped over the
##            # write call, in that case the >line< will not be the first
##            # string read from the socket...
##            boc = line.find('>')
##            if boc > 0 and eoc > boc:
##                self.debugServer.signalClientOutput(line[:boc])
##                line = line[boc:]
##                eoc = line.find('<') + 1
##                boc = line.find('>')
##            
##            self.debugServer.signalClientOutput(line)
##            if boc >= 0 and eoc > boc:
##                resp = line[boc:eoc]
##                
##                if resp == DebugProtocol.ResponseLine or \
##                   resp == DebugProtocol.ResponseStack:
##                    stack = eval(line[eoc:-1])
##                    for s in stack:
##                        s[0] = self.translate(s[0], True)
##                    cf = stack[0]
##                    if self.__autoContinue:
##                        self.__autoContinue = False
##                        QTimer.singleShot(0, self.remoteContinue)
##                    else:
##                        self.debugServer.signalClientLine(
##                            cf[0], int(cf[1]),
##                            resp == DebugProtocol.ResponseStack)
##                        self.debugServer.signalClientStack(stack)
##                    continue
##                
##                if resp == DebugProtocol.CallTrace:
##                    event, fromStr, toStr = line[eoc:-1].split("@@")
##                    isCall = event.lower() == "c"
##                    fromFile, fromLineno, fromFunc = fromStr.rsplit(":", 2)
##                    toFile, toLineno, toFunc = toStr.rsplit(":", 2)
##                    self.debugServer.signalClientCallTrace(
##                        isCall,
##                        fromFile, fromLineno, fromFunc,
##                        toFile, toLineno, toFunc)
##                    continue
##                
##                if resp == DebugProtocol.ResponseThreadList:
##                    currentId, threadList = eval(line[eoc:-1])
##                    self.debugServer.signalClientThreadList(
##                        currentId, threadList)
##                    continue
##                
##                if resp == DebugProtocol.ResponseThreadSet:
##                    self.debugServer.signalClientThreadSet()
##                    continue
##                
##                if resp == DebugProtocol.ResponseVariables:
##                    vlist = eval(line[eoc:-1])
##                    scope = vlist[0]
##                    try:
##                        variables = vlist[1:]
##                    except IndexError:
##                        variables = []
##                    self.debugServer.signalClientVariables(scope, variables)
##                    continue
##                
##                if resp == DebugProtocol.ResponseVariable:
##                    vlist = eval(line[eoc:-1])
##                    scope = vlist[0]
##                    try:
##                        variables = vlist[1:]
##                    except IndexError:
##                        variables = []
##                    self.debugServer.signalClientVariable(scope, variables)
##                    continue
##                
##                if resp == DebugProtocol.ResponseOK:
##                    self.debugServer.signalClientStatement(False)
##                    continue
##                
##                if resp == DebugProtocol.ResponseContinue:
##                    self.debugServer.signalClientStatement(True)
##                    continue
##                
##                if resp == DebugProtocol.ResponseException:
##                    exc = line[eoc:-1]
##                    exc = self.translate(exc, True)
##                    try:
##                        exclist = eval(exc)
##                        exctype = exclist[0]
##                        excmessage = exclist[1]
##                        stack = exclist[2:]
##                        if stack and stack[0] and stack[0][0] == "<string>":
##                            for stackEntry in stack:
##                                if stackEntry[0] == "<string>":
##                                    stackEntry[0] = self.__scriptName
##                                else:
##                                    break
##                    except (IndexError, ValueError, SyntaxError):
##                        exctype = None
##                        excmessage = ''
##                        stack = []
##                    self.debugServer.signalClientException(
##                        exctype, excmessage, stack)
##                    continue
##                
##                if resp == DebugProtocol.ResponseSyntax:
##                    exc = line[eoc:-1]
##                    exc = self.translate(exc, True)
##                    try:
##                        message, (fn, ln, cn) = eval(exc)
##                        if fn is None:
##                            fn = ''
##                    except (IndexError, ValueError):
##                        message = None
##                        fn = ''
##                        ln = 0
##                        cn = 0
##                    if cn is None:
##                        cn = 0
##                    self.debugServer.signalClientSyntaxError(
##                        message, fn, ln, cn)
##                    continue
##                
##                if resp == DebugProtocol.ResponseSignal:
##                    sig = line[eoc:-1]
##                    sig = self.translate(sig, True)
##                    message, (fn, ln, func, args) = eval(sig)
##                    self.debugServer.signalClientSignal(
##                        message, fn, ln, func, args)
##                    continue
##                
##                if resp == DebugProtocol.ResponseExit:
##                    self.__scriptName = ""
##                    self.debugServer.signalClientExit(line[eoc:-1])
##                    continue
##                
##                if resp == DebugProtocol.ResponseClearBreak:
##                    fn, lineno = line[eoc:-1].split(',')
##                    lineno = int(lineno)
##                    fn = self.translate(fn, True)
##                    self.debugServer.signalClientClearBreak(fn, lineno)
##                    continue
##                
##                if resp == DebugProtocol.ResponseBPConditionError:
##                    fn, lineno = line[eoc:-1].split(',')
##                    lineno = int(lineno)
##                    fn = self.translate(fn, True)
##                    self.debugServer.signalClientBreakConditionError(
##                        fn, lineno)
##                    continue
##                
##                if resp == DebugProtocol.ResponseClearWatch:
##                    cond = line[eoc:-1]
##                    self.debugServer.signalClientClearWatch(cond)
##                    continue
##                
##                if resp == DebugProtocol.ResponseWPConditionError:
##                    cond = line[eoc:-1]
##                    self.debugServer.signalClientWatchConditionError(cond)
##                    continue
##                
##                if resp == DebugProtocol.ResponseRaw:
##                    prompt, echo = eval(line[eoc:-1])
##                    self.debugServer.signalClientRawInput(prompt, echo)
##                    continue
##                
##                if resp == DebugProtocol.ResponseBanner:
##                    version, platform, dbgclient = eval(line[eoc:-1])
##                    self.debugServer.signalClientBanner(
##                        version, platform, dbgclient)
##                    continue
##                
##                if resp == DebugProtocol.ResponseCapabilities:
##                    cap, clType = eval(line[eoc:-1])
##                    self.clientCapabilities = cap
##                    self.debugServer.signalClientCapabilities(cap, clType)
##                    continue
##                
##                if resp == DebugProtocol.ResponseCompletion:
##                    clstring, text = line[eoc:-1].split('||')
##                    cl = eval(clstring)
##                    self.debugServer.signalClientCompletionList(cl, text)
##                    continue
##                
##                if resp == DebugProtocol.PassiveStartup:
##                    fn, exc = line[eoc:-1].split('|')
##                    exc = bool(exc)
##                    fn = self.translate(fn, True)
##                    self.debugServer.passiveStartUp(fn, exc)
##                    continue
##                
##                if resp == DebugProtocol.ResponseUTPrepared:
##                    res, exc_type, exc_value = eval(line[eoc:-1])
##                    self.debugServer.clientUtPrepared(res, exc_type, exc_value)
##                    continue
##                
##                if resp == DebugProtocol.ResponseUTStartTest:
##                    testname, doc = eval(line[eoc:-1])
##                    self.debugServer.clientUtStartTest(testname, doc)
##                    continue
##                
##                if resp == DebugProtocol.ResponseUTStopTest:
##                    self.debugServer.clientUtStopTest()
##                    continue
##                
##                if resp == DebugProtocol.ResponseUTTestFailed:
##                    testname, traceback, id = eval(line[eoc:-1])
##                    self.debugServer.clientUtTestFailed(
##                        testname, traceback, id)
##                    continue
##                
##                if resp == DebugProtocol.ResponseUTTestErrored:
##                    testname, traceback, id = eval(line[eoc:-1])
##                    self.debugServer.clientUtTestErrored(
##                        testname, traceback, id)
##                    continue
##                
##                if resp == DebugProtocol.ResponseUTTestSkipped:
##                    testname, reason, id = eval(line[eoc:-1])
##                    self.debugServer.clientUtTestSkipped(testname, reason, id)
##                    continue
##                
##                if resp == DebugProtocol.ResponseUTTestFailedExpected:
##                    testname, traceback, id = eval(line[eoc:-1])
##                    self.debugServer.clientUtTestFailedExpected(
##                        testname, traceback, id)
##                    continue
##                
##                if resp == DebugProtocol.ResponseUTTestSucceededUnexpected:
##                    testname, id = eval(line[eoc:-1])
##                    self.debugServer.clientUtTestSucceededUnexpected(
##                        testname, id)
##                    continue
##                
##                if resp == DebugProtocol.ResponseUTFinished:
##                    self.debugServer.clientUtFinished()
##                    continue
##                
##                if resp == DebugProtocol.RequestForkTo:
##                    self.__askForkTo()
##                    continue
##            
##            self.debugServer.signalClientOutput(line)
    
    def __handleJsonCommand(self, jsonStr):
        """
        Private method to handle a command serialized as a JSON string.
        """
        import json
        
        try:
            commandDict = json.loads(jsonStr.strip())
        except json.JSONDecodeError as err:
            # TODO: implement real error handling
##            print(str(err))
            return
        
        method = commandDict["method"]
        params = commandDict["params"]
        
        if method == "ClientOutput":
            self.debugServer.signalClientOutput(params["text"])
        
        elif method in ["ResponseLine", "ResponseStack"]:
            for s in params["stack"]:
                s[0] = self.translate(s[0], True)
            cf = params["stack"][0]
            if self.__autoContinue:
                self.__autoContinue = False
                QTimer.singleShot(0, self.remoteContinue)
            else:
                self.debugServer.signalClientLine(
                    cf[0], int(cf[1]),
                    method == "ResponseStack")
                self.debugServer.signalClientStack(params["stack"])
        
        elif method == "CallTrace":
            isCall = params["event"].lower() == "c"
            fromFile, fromLineno, fromFunc = params["from"].rsplit(":", 2)
            toFile, toLineno, toFunc = params["to"].rsplit(":", 2)
            self.debugServer.signalClientCallTrace(
                isCall,
                fromFile, fromLineno, fromFunc,
                toFile, toLineno, toFunc)
        
        elif method == "ResponseVariables":
            self.debugServer.signalClientVariables(
                params["scope"], params["variables"])
        
        elif method == "ResponseVariable":
            self.debugServer.signalClientVariable(
                params["scope"], [params["variable"]] + params["variables"])
        
        elif method == "ResponseThreadList":
            self.debugServer.signalClientThreadList(
                params["currentID"], params["threadList"])
        
        elif method == "ResponseThreadSet":
            self.debugServer.signalClientThreadSet()
        
        elif method == "ResponseCapabilities":
            self.clientCapabilities = params["capabilities"]
            self.debugServer.signalClientCapabilities(
                params["capabilities"], params["clientType"])
        
        elif method == "ResponseBanner":
            self.debugServer.signalClientBanner(
                params["version"],
                params["platform"],
                params["dbgclient"])
        
        elif method == "ResponseOK":
            self.debugServer.signalClientStatement(False)
        
        elif method == "ResponseContinue":
            self.debugServer.signalClientStatement(True)
        
        elif method == "RequestRaw":
            self.debugServer.signalClientRawInput(
                params["prompt"], params["echo"])
        
        elif method == "ResponseBPConditionError":
            params["filename"] = self.translate(params["filename"], True)
            self.debugServer.signalClientBreakConditionError(
                params["filename"], params["line"])
        
        elif method == "ResponseClearBreakpoint":
            params["filename"] = self.translate(params["filename"], True)
            self.debugServer.signalClientClearBreak(
                params["filename"], params["line"])
        
        elif method == "ResponseWatchConditionError":
            self.debugServer.signalClientWatchConditionError(
                params["condition"])
        
        elif method == "ResponseClearWatch":
            self.debugServer.signalClientClearWatch(params["condition"])
        
        elif method == "ResponseException":
            if params:
                exctype = params["type"]
                excmessage = params["message"]
                stack = params["stack"]
                if stack:
                    for stackEntry in stack:
                        stackEntry[0] = self.translate(stackEntry[0], True)
                    if stack[0] and stack[0][0] == "<string>":
                        for stackEntry in stack:
                            if stackEntry[0] == "<string>":
                                stackEntry[0] = self.__scriptName
                            else:
                                break
            else:
                exctype = ''
                excmessage = ''
                stack = []
            
            self.debugServer.signalClientException(
                exctype, excmessage, stack)
        
        elif method == "ResponseSyntax":
            self.debugServer.signalClientSyntaxError(
                params["message"], self.translate(params["filename"], True),
                params["linenumber"], params["characternumber"])
        
        elif method == "ResponseSignal":
            self.debugServer.signalClientSignal(
                params["message"], self.translate(params["filename"], True),
                params["linenumber"], params["function"], params["arguments"])
        
        elif method == "ResponseExit":
            self.__scriptName = ""
            self.debugServer.signalClientExit(params["status"])
            if params["message"]:
                self.debugServer.signalClientOutput(params["message"])
        
        elif method == "PassiveStartup":
            self.debugServer.passiveStartUp(
                self.translate(params["filename"], True), params["exceptions"])
        
        elif method == "ResponseCompletion":
            self.debugServer.signalClientCompletionList(
                params["completions"], params["text"])
        
        elif method == "ResponseUTPrepared":
            self.debugServer.clientUtPrepared(
                params["count"], params["exception"], params["message"])
        
        elif method == "ResponseUTFinished":
            self.debugServer.clientUtFinished()
        
        elif method == "ResponseUTStartTest":
            self.debugServer.clientUtStartTest(
                params["testname"], params["description"])
        
        elif method == "ResponseUTStopTest":
            self.debugServer.clientUtStopTest()
        
        elif method == "ResponseUTTestFailed":
            self.debugServer.clientUtTestFailed(
                params["testname"], params["traceback"], params["id"])
        
        elif method == "ResponseUTTestErrored":
            self.debugServer.clientUtTestErrored(
                params["testname"], params["traceback"], params["id"])
        
        elif method == "ResponseUTTestSkipped":
            self.debugServer.clientUtTestSkipped(
                params["testname"], params["reason"], params["id"])
        
        elif method == "ResponseUTTestFailedExpected":
            self.debugServer.clientUtTestFailedExpected(
                params["testname"], params["traceback"], params["id"])
        
        elif method == "ResponseUTTestSucceededUnexpected":
            self.debugServer.clientUtTestSucceededUnexpected(
                params["testname"], params["id"])
        
        elif method == "RequestForkTo":
            self.__askForkTo()
    
    def __sendCommand(self, cmd):
        """
        Private method to send a single line command to the client.
        
        @param cmd command to send to the debug client (string)
        """
        if self.qsock is not None:
            self.qsock.write(cmd.encode('utf8', 'backslashreplace'))
        else:
            self.queue.append(cmd)
    
    def __sendJsonCommand(self, command, params):
        """
        Private method to send a single command to the client.
        
        @param command command name to be sent
        @type str
        @param params dictionary of named parameters for the command
        @type dict
        """
        import json
        
        commandDict = {
            "jsonrpc": "2.0",
            "method": command,
            "params": params,
        }
        cmd = json.dumps(commandDict) + '\n'
        if self.qsock is not None:
            self.qsock.write(cmd.encode('utf8', 'backslashreplace'))
        else:
            self.queue.append(cmd)
    

def createDebuggerInterfacePython3(debugServer, passive):
    """
    Module function to create a debugger interface instance.
    
        
    @param debugServer reference to the debug server
    @type DebugServer
    @param passive flag indicating passive connection mode
    @type bool
    @return instantiated debugger interface
    @rtype DebuggerInterfacePython
    """
    return DebuggerInterfacePython3(debugServer, passive)


def getRegistryData():
    """
    Module function to get characterizing data for the debugger interface.
    
    @return tuple containing  client type, client capabilities, client file
        type associations and reference to creation function
    @rtype tuple of (str, int, list of str, function)
    """
    exts = []
    for ext in Preferences.getDebugger("Python3Extensions").split():
        if ext.startswith("."):
            exts.append(ext)
        else:
            exts.append(".{0}".format(ext))
    
    if exts:
        return ["Python3", ClientDefaultCapabilities, exts,
                createDebuggerInterfacePython3]
    else:
        return ["", 0, [], None]