"""Test convenience variables when you drop in from lldb prompt into an embedded interpreter."""

from __future__ import print_function


import os
import lldb
from lldbsuite.test.decorators import *
from lldbsuite.test.lldbtest import *
from lldbsuite.test import lldbutil


class ConvenienceVariablesCase(TestBase):

    mydir = TestBase.compute_mydir(__file__)

    def setUp(self):
        # Call super's setUp().
        TestBase.setUp(self)
        # Find the line number to break on inside main.cpp.
        self.line = line_number('main.c', 'Hello world.')

    @skipIfFreeBSD  # llvm.org/pr17228
    @skipIfRemote
    @expectedFailureAll(
        oslist=["windows"],
        bugnumber="llvm.org/pr22274: need a pexpect replacement for windows")
    def test_with_run_commands(self):
        """Test convenience variables lldb.debugger, lldb.target, lldb.process, lldb.thread, and lldb.frame."""
        self.build()
        import pexpect
        exe = self.getBuildArtifact("a.out")
        prompt = "(lldb) "
        python_prompt = ">>> "

        # So that the child gets torn down after the test.
        self.child = pexpect.spawn(
            '%s %s %s' %
            (lldbtest_config.lldbExec, self.lldbOption, exe))
        child = self.child
        # Turn on logging for what the child sends back.
        if self.TraceOn():
            child.logfile_read = sys.stdout

        # Set the breakpoint, run the inferior, when it breaks, issue print on
        # the various convenience variables.
        child.expect_exact(prompt)
        child.sendline('breakpoint set -f main.c -l %d' % self.line)
        child.expect_exact(prompt)
        child.sendline('run')
        child.expect_exact("stop reason = breakpoint 1.1")
        child.expect_exact(prompt)
        child.sendline('script')
        child.expect_exact(python_prompt)

        # Set a flag so that we know during teardown time, we need to exit the
        # Python interpreter, then the lldb interpreter.
        self.child_in_script_interpreter = True

        child.sendline('print(lldb.debugger)')
        child.expect_exact(python_prompt)
        self.expect(child.before, exe=False,
                    patterns=['Debugger \(instance: .*, id: \d\)'])

        child.sendline('print(lldb.target)')
        child.expect_exact(python_prompt)
        self.expect(child.before, exe=False,
                    substrs=['a.out'])

        child.sendline('print(lldb.process)')
        child.expect_exact(python_prompt)
        self.expect(child.before, exe=False, patterns=[
                    'SBProcess: pid = \d+, state = stopped, threads = \d, executable = a.out'])

        child.sendline('print(lldb.thread.GetStopDescription(100))')
        child.expect_exact(python_prompt)
        self.expect(
            child.before,
            exe=False,
            patterns=[
                'breakpoint 1\.1'])

        child.sendline('lldb.frame.GetLineEntry().GetLine()')
        child.expect_exact(python_prompt)
        line_number = "%d"%(self.line)
        self.expect(
            child.before,
            exe=False,
            substrs=[
                line_number])

        child.sendline('lldb.frame.GetLineEntry().GetFileSpec().GetFilename()')
        child.expect_exact(python_prompt)
        line_number = "%d"%(self.line)
        self.expect(
            child.before,
            exe=False,
            substrs=[
                "main.c"])

        child.sendline('lldb.frame.GetFunctionName()')
        child.expect_exact(python_prompt)
        line_number = "%d"%(self.line)
        self.expect(
            child.before,
            exe=False,
            substrs=[
                "main"])