Initial commit

Author: Micah Carrick

README.markdown

@@ -0,0 +1,111 @@
+Gedit Source Code Browser
+=========================
+
+A source code class and function browser plugin for Gedit 3. 
+
+* Author: Micah Carrick
+* Version: 3.0.0
+* Date: 2011-05-06
+
+This plugin will add a new tab to the side pane in the Gedit text editor which
+shows symbols (functions, classes, variables, etc.) for the active document. 
+Clicking a symbol in the list wil jump to the line on which that symbol is 
+defined.
+
+See the [ctags supported languages](http://ctags.sourceforge.net/languages.html)
+for a list of the 41 programming languages supported by this plugin.
+
+
+Requirements
+------------
+
+This plugins is for Gedit 3 and is **not compatible with Gedit 2.x**. 
+
+The Gedit Source Code Browser plugin uses 
+[Exuberant Ctags](http://ctags.sourceforge.net/) to parse symbols
+out of source code. Exuberant Ctags is avaialable in the software repository for
+many distributions. To make sure you have ctags correctly installed, issue
+the following command:
+
+    ctags --version
+    
+Make sure that you see *Exuberant* Ctags in the version output.
+
+
+Installation
+------------
+
+1. Download this repository by clicking the Downloads button at the top of the 
+   github page or issue the following command in a terminal:
+
+    git clone git://github.com/Quixotix/gedit-source-code-browser.git
+
+2. Copy the file `sourcecodebrowser.plugin` and the folder `sourcecodebrowser` to
+   `~/.local/share/gedit/plugins/`.
+
+3. Restart Gedit.
+
+4. Activate the plugin in Gedit by choosing 'Edit > Preferences', the selecting
+   the 'Plugins' tab, and checking the box next to 'Soucre Code Browser'.
+   
+
+Screenshots
+-----------
+
+![Python code in Source Code Browser](http://www.micahcarrick.com/images/gedit-source-code-browser/python.png)
+
+
+Changes
+-------
+
+
+
+Known Issues
+------------
+
+* CSS is not supported. This issue is about ctags and not this plugin. You can
+  [extend ctags](http://ctags.sourceforge.net/EXTENDING.html) to add support for 
+  any language you like. Many people have provided their fixes to on internet 
+  such as this [patch for CSS support](http://scie.nti.st/2006/12/22/how-to-add-css-support-to-ctags).
+  
+* PHP is supported, however, PHP5 classes are not well supported. This is again
+  an issue with ctags. There are numerous fixes to be found onn the internet
+  such as these 
+  [patches for better PHP5 support](http://www.jejik.com/articles/2008/11/patching_exuberant-ctags_for_better_php5_support_in_vim/).
+  
+* A configure dialog has not yet been implemented. Until the configuration dialog
+  is added, a few settings are available for those who want to poke around in 
+  the code. The `__init__` method of the `SourceCodeBrowserPlugin` class contains 
+  a few properties that can be changed.
+
+
+BSD License
+-----------
+
+Copyright (c) 2011, Micah Carrick
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this 
+list of conditions and the following disclaimer.
+      
+* Redistributions in binary form must reproduce the above copyright notice, 
+this list of conditions and the following disclaimer in the documentation 
+and/or other materials provided with the distribution.
+    
+* Neither the name of Quixotix Software, LLC nor the names of its 
+contributors may be used to endorse or promote products derived from this 
+software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR 
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON 
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

sourcecodebrowser.plugin

@@ -0,0 +1,10 @@
+[Plugin]
+Loader=python
+Module=sourcecodebrowser
+IAge=3
+Name=Source Code Browser
+Description=A source code class and function browser for Gedit 3.
+Authors=Micah Carrick <[email protected]>
+Copyright=Copyright © 2011 Micah Carrick
+Website=https://github.com/Quixotix/gedit-source-code-browser
+Version=3.0.0

sourcecodebrowser/__init__.py

@@ -0,0 +1,3 @@
+import plugin
+from plugin import SourceCodeBrowserPlugin
+

sourcecodebrowser/ctags.py

@@ -0,0 +1,148 @@
+import os
+import subprocess
+import shlex
+
+def get_ctags_version(executable=None):
+    """
+    Return the text output from the --version option to ctags or None if ctags
+    executable cannot be found. Use executable for custom ctags builds and/or
+    path.
+    """
+    args = shlex.split("ctags --version")
+    try:
+        p = subprocess.Popen(args, 0, shell=False, stdout=subprocess.PIPE, executable=executable)
+        version = p.communicate()[0]
+    except:
+        version = None
+    return version
+
+class Tag(object):
+    """
+    Represents a ctags "tag" found in some source code. 
+    """
+    def __init__(self, name):
+        self.name = name
+        self.file = None
+        self.ex_command = None
+        self.kind = None
+        self.fields = {}
+
+class Kind(object):
+    """
+    Represents a ctags "kind" found in some source code such as "member" or 
+    "class". 
+    """
+    def __init__(self, name):
+        self.name = name
+        self.language = None
+        
+    def group_name(self):
+        """
+        Return the kind name as a group name. For example, 'variable' would
+        be 'Variables'. Pluralization is complex but this method is not. It
+        works more often than not.
+        """
+        group = self.name
+        
+        if self.name[-1] == 's': 
+            group += 'es'
+        elif self.name[-1] == 'y':
+            group = self.name[0:-1] + 'ies'
+        else:
+            group += 's'
+            
+        return group.capitalize()
+    
+    def icon_name(self):
+        """
+        Return the icon name in the form of 'source-<kind>'.
+        """
+        return 'source-' + self.name
+                
+class Parser(object):
+    """
+    Ctags Parser
+    
+    Parses the output of a ctags command into a list of tags and a dictionary
+    of kinds.
+    """
+    def has_kind(self, kind_name):
+        """
+        Return true if kind_name is found in the list of kinds.
+        """
+        if kind_name in self.kinds:
+            return True
+        else:
+            return False
+    
+    def __init__(self):
+        self.tags = []
+        self.kinds = {}
+        self.tree = {}
+    
+    def parse(self, command, executable=None):
+        """
+        Parse ctags tags from the output of a ctags command. For example:
+        ctags -n --fields=fiKmnsSzt -f - some_file.php
+        """
+        args = shlex.split(command)
+        p = subprocess.Popen(args, 0, shell=False, stdout=subprocess.PIPE, executable=executable)
+        symbols = self._parse_text(p.communicate()[0])
+    
+    def _parse_text(self, text):
+        """
+        Parses ctags text which may have come from a TAG file or from raw output
+        from a ctags command.
+        """
+        for line in text.splitlines():
+            name = None
+            file = None
+            ex_command = None
+            kind = None
+            for i, field in enumerate(line.split("\t")):
+                if i == 0: tag = Tag(field)
+                elif i == 1: tag.file = field
+                elif i == 2: tag.ex_command = field
+                elif i > 2:
+                    if ":" in field:
+                        key, value = field.split(":")
+                        tag.fields[key] = value
+                        if key == 'kind':
+                            kind = Kind(value)
+                            if not kind in self.kinds:
+                                self.kinds[value] = kind
+                            
+            if kind is not None:
+                if 'language' in tag.fields:
+                    kind.language = tag.fields['language']
+                tag.kind = kind
+            
+            self.tags.append(tag)  
+    """
+    def get_tree(self):
+        tree = {}
+        for tag in self.tags:
+            if 'class' in tag.fields:
+                parent = tag.fields['class']
+                if "." in parent:
+                    parents = parent.split(".")
+                    node = tree
+                    for p in parents:
+                        if not p in node:
+                            node[p] = {'tag':None, 'children':{}}
+                        node = node[p]
+                    print node
+                    node['tag'] = tag                        
+                else:
+                    if not parent in self.tree:
+                        tree[parent] = {'tag':None, 'children':{}}
+                    tree[parent]['children'][tag.name] = {'tag':tag, 'children':{}}
+            else:
+                if tag.name in self.tree:
+                    tree[tag.name]['tag'] = tag
+                else:
+                    tree[tag.name] = {'tag': tag, 'children':{}}
+        return tree
+    """
+            
+