1a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)# Copyright 2013 The Chromium Authors. All rights reserved. 2a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)# Use of this source code is governed by a BSD-style license that can be 3a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)# found in the LICENSE file. 4a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 5a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)"""A module for the Debugger base class.""" 6a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 7a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)import cr 8a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 9a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 10a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)class Debugger(cr.Action, cr.Plugin.Type): 11a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) """Base class for implementing debuggers. 12a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 13a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) Implementations must override the Invoke and Attach methods. 14a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) """ 15a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 16a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) SELECTOR_ARG = '--debugger' 17a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) SELECTOR = 'CR_DEBUGGER' 18a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) SELECTOR_HELP = 'Sets the debugger to use for debug commands.' 19a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 20a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) @classmethod 21a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) def AddArguments(cls, command, parser): 22a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) cr.Runner.AddSelectorArg(command, parser) 23a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 24a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) @classmethod 25effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch def ShouldInvoke(cls): 26a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) """Checks if the debugger is attaching or launching.""" 27effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch return not cr.Runner.Skipping() 28a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 29a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) @cr.Plugin.activemethod 30effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch def Restart(self, targets, arguments): 31a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) """Ask the debugger to restart. 32a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 33a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) Defaults to a Kill Invoke sequence. 34a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) """ 35effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch self.Kill(targets, []) 36effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch self.Invoke(targets, arguments) 37a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 38a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) @cr.Plugin.activemethod 39effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch def Kill(self, targets, arguments): 40a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) """Kill the running debugger.""" 41effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch cr.Runner.Kill(targets, arguments) 42a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 43a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) @cr.Plugin.activemethod 44effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch def Invoke(self, targets, arguments): 45a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) """Invoke the program within a debugger.""" 46a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) raise NotImplementedError('Must be overridden.') 47a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 48a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) @cr.Plugin.activemethod 49effb81e5f8246d0db0270817048dc992db66e9fbBen Murdoch def Attach(self, targets, arguments): 50a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) """Attach a debugger to a running program.""" 51a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) raise NotImplementedError('Must be overridden.') 52