print_command_options.py

#!/usr/bin/python
'''
The MIT License (MIT)

Copyright (c) 2014 Fabian Guerra Soto @fabiangrra

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
'''
import lldb
import commands
import optparse
import shlex

def create_print_frame_options():
    usage = "usage: %prog [options]"
    description='''This command uses two parameters to filter frame printing.
'''
    parser = optparse.OptionParser(description=description, prog='print_frame',usage=usage)
    parser.add_option('-p', '--prefix', type='string', dest='prefix', help='Class prefix to filter.')
    parser.add_option('-m', '--message', type='string', dest='message', help='Message to print at the beggining.')

    return parser


def print_frame(debugger, command, result, internal_dict):
    target = debugger.GetSelectedTarget()
    process = target.GetProcess()
    thread = process.GetSelectedThread()

    command_args = shlex.split(command)
    parser = create_print_frame_options()

    try:
        (options, args) = parser.parse_args(command_args)

    except:
        # if you don't handle exceptions, passing an incorrect argument to the OptionParser will cause LLDB to exit
        result.SetError ("option parsing failed")
        return

    if options.message:
        print >>result, "************************** Tracing: %s %s" % (options.message," **************************")

    if options.prefix:
      for frame in thread:
        if str(frame.GetFunctionName()).find(options.prefix) != -1:
          print >>result, str(frame)

    else:
      for frame in thread:
        print >>result, str(frame)




def __lldb_init_module(debugger, internal_dict):
    debugger.HandleCommand('command script add -f print_command_options.print_frame print_frame')
    print 'The "print_frame" python command has been installed and is ready for use.'