Tools:SNavigator: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
Line 24: Line 24:
# Open a terminal.  
# Open a terminal.  
# Type <tt>snavigator</tt> followed by striking Enter.
# Type <tt>snavigator</tt> followed by striking Enter.
# This shows the "Source-Navigator Projects" dialog. Choose the project file that you've just created and then click "Open...". Source Navigator then loads the database and then display the following Symbols window:
# This shows the "Source-Navigator Projects" dialog. Choose the project file that you've just created and then click "Open...". Source Navigator then loads the database and then display the following Symbols window:<br/>[[Image:Snav-symbols|Source-Navigator Symbol Window]]
 
 


==Searching a method==
==Searching a method==

Revision as of 03:16, 11 June 2008

Note: This document is still in the draft state. I hope I can finish it within one day or two if I have more time. ;) --Kennykaiyinyu 19:04, 10 June 2008 (PDT)

Installing Source Navigator

In Ubuntu

Execute the following line in a terminal window:

sudo apt-get install sourcenav

This should install source-navigator. One can check whether the installation is complete by executing:

$ which snavigator
/usr/bin/snavigator

Importing the source

  1. Execute the following: snavigator This triggers a splash screen, followed by a "Source-Navigator Projects" dialog as the following: Source Navigator Dialog
    I've already created a new project bin.proj before documenting this. If this is your first time to open source navigator, the big white box on the left of the dialog should contain no lines.
  2. Click "New Project". This shows the "Auto-Create Project" dialog:
    Auto-Create-Project Dialog
    which allows you to decide your filename of the project file (which ends in .proj) and your source directory/directories that you want to import into the project. (You can always include more by pressing the "More" button.)
    • In my case, I inputted the followings:
      • Project File:
        ~/snav-mozilla
      • Add Directory (where your source files reside in -- I understand that the label here is not so self-explanatory...):
        ~/moz1.9/mozilla
        (because I saved my source at ~/moz1.9/mozilla.)
  3. Remember to ensure that "Include Subdirectories" and "Build Cross-reference database" are checked.
  4. Then click "OK". The snavigator then begins to scan your source directories. This takes a few minutes. Now you can enjoy searching the mozilla code in a faster speed.

Using Source Navigator (more later)

Opening a Project

  1. Open a terminal.
  2. Type snavigator followed by striking Enter.
  3. This shows the "Source-Navigator Projects" dialog. Choose the project file that you've just created and then click "Open...". Source Navigator then loads the database and then display the following Symbols window:
    Source-Navigator Symbol Window

Searching a method

by typing in the method name

viewing the definition/declaration by highlighting the method in the code

...

Displaying a inheritance hierarchy

  1. ...

Searching a string

  1. ...