cscope.py

import sublime, sublime_plugin
import os
import re
import subprocess

class CscopeCommand(sublime_plugin.TextCommand):
    def __init__(self, view):
        self.view = view
        self.database = None

        self.settings = sublime.load_settings("Cscope.sublime-settings")
        self.verbose = self.settings.get("verbose", False)

        self.panel  = self.view.window().get_output_panel("cscope")
    
    def run(self, edit, mode):
        self.log("Called: %d" % mode)
        # self.word_separators = self.view.settings().get('word_separators')
        # print self.view.sel()
        # self.view.insert(edit, 0, "Hello, World!")
        one = self.view.sel()[0].a
        two = self.view.sel()[0].b
        self.view.sel().add(sublime.Region(one,
                                           two))
        for sel in self.view.sel():
            word = self.view.substr(self.view.word(sel))
            self.log("running cscope on %s" % word)
            options = self.run_cscope(mode, word)
            self.view.window().show_quick_panel(options, self.on_done)
    
    def on_done(self, picked):
        self.log("Selection: %d" % picked)
        if picked == -1:
            return
        
        line = self.matches[picked]["line"]
        filepath = os.path.join(self.root, self.matches[picked]["file"])
        if os.path.isfile(filepath):
            sublime.active_window().open_file(filepath + ":" + line, sublime.ENCODED_POSITION)

    def log(self, text):
        if self.verbose:
            print "Cscope: " + text

    def find_database(self):
        cdir = os.path.dirname(self.view.file_name())
        while cdir != os.path.dirname(cdir):
            if ("cscope.out" in os.listdir(cdir)):
                self.database = os.path.join(cdir, "cscope.out")
                self.root = cdir
                #print "Database found: ", self.database
                break
            cdir = os.path.dirname(cdir)
        
        if self.database == None:
            sublime.status_message("Could not find cscope database: cscope.out")
    
    def run_cscope(self, mode, word):
        # 0 ==> C symbol
        # 1 ==> function definition
        # 2 ==> functions called by this function
        # 3 ==> functions calling this function
        # 4 ==> text string
        # 5 ==> egrep pattern
        # 6 ==> files

        if self.database == None:
            self.find_database()

        newline = ''
        if sublime.platform() == "windows":
            newline = '\r\n'
        else:
            newline = '\n'

        cscope_arg_list = ['cscope', '-dL', '-f', self.database, '-' + str(mode) + word]
        popen_arg_list = {
                          "shell": False,
                          "stdout": subprocess.PIPE,
                          "stderr": subprocess.PIPE
                          }
        if (sublime.platform() == "windows"):
            popen_arg_list["creationflags"] = 0x08000000

        proc = subprocess.Popen(cscope_arg_list, **popen_arg_list)
        output = proc.communicate()[0].split(newline)
        #print output
        self.matches = []
        for i in output:
            match = self.match_output_line(i, mode)
            if match != None:
                self.matches.append(match)
                #print "File ", match.group(1), ", Line ", match.group(2), ", Instance ", match.group(3)

        #self.view.window().run_command("show_overlay", {"overlay": "goto", "text": "@"})
        options = []
        for match in self.matches:
            options.append("%(file)s:%(line)s - %(instance)s" % match)
        
        return options
    
    def match_output_line(self, line, mode):
        match = None

        if mode == 0:
            match = re.match('(\S+?)\s+?(<global>)?\s+(\d+)\s+(.+)', line)
        elif mode == 1:
            match = re.match('(\S+?)\s+?\S+\s+(\d+)\s+(.+)', line)
 
        if match != None:
            if match.lastindex == 4:
                return {
                        "file": match.group(1),
                        "line": match.group(3),
                        "instance": match.group(4)
                        }
            else:
                return {
                        "file": match.group(1),
                        "line": match.group(2),
                        "instance": match.group(3)
                        }
        return None