switch to version 2.11.0

take &scrolloff into account when restoring the window position when
recreating the nerd tree window

.gitignore

@@ -0,0 +1,3 @@
+*~
+*.swp
+tags

Rakefile

@@ -0,0 +1,18 @@
+desc "Copy the vim/doc files into ~/.vim"
+task :deploy_local do
+  run "cp plugin/NERD_tree.vim ~/.vim/plugin"
+  run "cp doc/NERD_tree.txt ~/.vim/doc"
+end
+
+
+desc "Create a zip archive for release to vim.org"
+task :zip do
+  abort "NERD_tree.zip already exists, aborting" if File.exist?("NERD_tree.zip")
+  run "zip NERD_tree.zip plugin/NERD_tree.vim doc/NERD_tree.txt"
+end
+
+def run(cmd)
+  puts "Executing: #{cmd}"
+  system cmd
+end
+

doc/NERD_tree.txt

@@ -2,7 +2,7 @@
 
 
 
-
+    omg its ... ~
 
     ________  ________   _   ____________  ____     __________  ____________~
    /_  __/ / / / ____/  / | / / ____/ __ \/ __ \   /_  __/ __ \/ ____/ ____/~
@@ -17,13 +17,14 @@
 
 
 ==============================================================================
-CONTENTS                                                   *NERDTree-contents* 
+CONTENTS                                                   *NERDTree-contents*
 
     1.Intro...................................|NERDTree|
     2.Functionality provided..................|NERDTreeFunctionality|
-        2.1 Commands..........................|NERDTreeCommands|
-        2.2 NERD tree mappings................|NERDTreeMappings|
-        2.3 The filesystem menu...............|NERDTreeFilesysMenu|
+        2.1 Global commands...................|NERDTreeGlobalCommands|
+        2.2 Bookmark commands.................|NERDTreeBookmarkCommands|
+        2.3 NERD tree mappings................|NERDTreeMappings|
+        2.4 The filesystem menu...............|NERDTreeFilesysMenu|
     3.Options.................................|NERDTreeOptions|
         3.1 Option summary....................|NERDTreeOptionSummary|
         3.2 Option details....................|NERDTreeOptionDetails|
@@ -32,6 +33,7 @@ CONTENTS                                                   *NERDTree-contents*
     6.The Author..............................|NERDTreeAuthor|
     7.Changelog...............................|NERDTreeChangelog|
     8.Credits.................................|NERDTreeCredits|
+    9.License.................................|NERDTreeLicense|
 
 ==============================================================================
 1. Intro                                                            *NERDTree*
@@ -41,7 +43,7 @@ What is this "NERD tree"??
 The NERD tree allows you to explore your filesystem and to open files and
 directories. It presents the filesystem to you in the form of a tree which you
 manipulate with the keyboard and/or mouse. It also allows you to perform
-simple filesystem operations so you can alter the tree dynamically.
+simple filesystem operations.
 
 The following features and functionality are provided by the NERD tree:
     * Files and directories are displayed in a hierarchical tree structure
@@ -51,52 +53,102 @@ The following features and functionality are provided by the NERD tree:
         * sym-links
         * windows .lnk files
         * read-only files
+        * executable files
     * Many (customisable) mappings are provided to manipulate the tree:
         * Mappings to open/close/explore directory nodes
-        * Mappings to open files in new/existing windows/tabs     
-        * Mappings to change the current root of the tree 
-        * Mappings to navigate around the tree 
+        * Mappings to open files in new/existing windows/tabs
+        * Mappings to change the current root of the tree
+        * Mappings to navigate around the tree
         * ...
-    * Most NERD tree navigation can also be done with the mouse  
+    * Directories and files can be bookmarked.
+    * Most NERD tree navigation can also be done with the mouse
     * Dynamic customisation of tree content
         * custom file filters to prevent e.g. vim backup files being displayed
         * optional displaying of hidden files (. files)
         * files can be "turned off" so that only directories are displayed
     * A textual filesystem menu is provided which allows you to
-      create/delete/rename file and directory nodes
-    * The position and size of the NERD tree window can be customised 
+      create/delete/move file and directory nodes as well as copy (for
+      supported OSs)
+    * The position and size of the NERD tree window can be customised
     * The order in which the nodes in the tree are listed can be customised.
     * A model of your filesystem is created/maintained as you explore it. This
       has several advantages:
         * All filesystem information is cached and is only re-read on demand
         * If you revisit a part of the tree that you left earlier in your
-          session, the directory nodes will be opened/closed as you left them       
+          session, the directory nodes will be opened/closed as you left them
     * The script remembers the cursor position and window position in the NERD
       tree so you can toggle it off (or just close the tree window) and then
       reopen it (with NERDTreeToggle) the NERD tree window will appear EXACTLY
       as you left it
-    * You can have a separate NERD tree for each tab   
+    * You can have a separate NERD tree for each tab
 
 ==============================================================================
-2. Functionality provided                              *NERDTreeFunctionality* 
+2. Functionality provided                              *NERDTreeFunctionality*
 
 ------------------------------------------------------------------------------
-2.1. Commands                                               *NERDTreeCommands*
+2.1. Global Commands                                  *NERDTreeGlobalCommands*
 
-:NERDTree [start-directory]                                 *:NERDTree*
-                Opens a fresh NERD tree in [start-directory] or the current
-                directory if [start-directory] isn't specified.
-                For example: >
-                    :NERDTree /home/marty/vim7/src
-<               will open a NERD tree in /home/marty/vim7/src.
+:NERDTree [<start-directory> | <bookmark>]                         *:NERDTree*
+    Opens a fresh NERD tree. The root of the tree depends on the argument
+    given. There are 3 cases: If no argument is given, the current directory
+    will be used.  If a directory is given, that will be used. If a bookmark
+    name is given, the corresponding directory will be used.  For example: >
+        :NERDTree /home/marty/vim7/src
+        :NERDTree foo   (foo is the name of a bookmark)
+<
+:NERDTreeFromBookmark <bookmark>                       *:NERDTreeFromBookmark*
+    Opens a fresh NERD tree with the root initialized to the dir for
+    <bookmark>.  This only reason to use this command over :NERDTree is for
+    the completion (which is for bookmarks rather than directories).
 
-:NERDTreeToggle [start-directory]                           *:NERDTreeToggle*
-                If a NERD tree already exists for this tab, it is reopened and
-                rendered again.  If no NERD tree exists for this tab then this
-                command acts the same as the |:NERDTree| command.
+:NERDTreeToggle [<start-directory> | <bookmark>]             *:NERDTreeToggle*
+    If a NERD tree already exists for this tab, it is reopened and rendered
+    again.  If no NERD tree exists for this tab then this command acts the
+    same as the |:NERDTree| command.
+
+:NERDTreeClose
+    Close the NERD tree in this tab.
 
 ------------------------------------------------------------------------------
-2.2. NERD tree Mappings                                     *NERDTreeMappings*
+2.2. Bookmark Commands                              *NERDTreeBookmarkCommands*
+
+Bookmarks in the NERD tree are a way to tag files or directories of interest.
+For example, you could use bookmarks to tag all of your project directories.
+See also |:NERDTree| and |:NERDTreeFromBookmark|.
+
+Note that the following commands are only available in the NERD tree buffer.
+
+:Bookmark <name>
+    Bookmark the current node as <name>. If there is already a <name>
+    bookmark, it is overwritten. <name> must consist of alphanumeric
+    characters and underscores.
+
+:BookmarkToRoot <bookmark>
+    Make the directory corresponding to <bookmark> the new root. If a treenode
+    corresponding to <bookmark> is already cached somewhere in the tree then
+    the current tree will be used, otherwise a fresh tree will be opened.
+    Note that if <bookmark> points to a file then its parent will be used
+    instead.
+
+:RevealBookmark <bookmark>
+    If the node is cached under the current root then it will be revealed
+    (i.e. directory nodes above it will be opened) and the cursor will be
+    placed on it.
+
+:OpenBookmark <bookmark>
+    <bookmark> must point to a file. The file is opened as though |NERDTree-o|
+    was applied. If the node is cached under the current root then it will be
+    revealed and the cursor will be placed on it.
+
+:ClearBookmarks [<bookmarks>]
+    Remove all the given bookmarks. If no bookmarks are given then remove all
+    bookmarks on the current node.
+
+:ClearAllBookmarks
+    Remove all bookmarks.
+
+------------------------------------------------------------------------------
+2.3. NERD tree Mappings                                     *NERDTreeMappings*
 
 Default  Description~                                             help-tag~
 Key~
@@ -114,7 +166,7 @@ X.......Recursively close all children of the current node.......|NERDTree-X|
 e.......Open a netrw for the current dir.........................|NERDTree-e|
 
 double-click.......same as the |NERDTree-o| map.
-middle-click.......same as |NERDTree-tab| for files, same as 
+middle-click.......same as |NERDTree-tab| for files, same as
                    |NERDTree-e| for dirs.
 
 P.......Jump to the root node....................................|NERDTree-P|
@@ -215,9 +267,8 @@ Recursively opens the selelected directory.
 
 All files and directories are cached, but if a directory would not be
 displayed due to file filters (see |NERDTreeIgnore| |NERDTree-f|) or the
-hidden file filter (see |NERDTreeShowHidden|) then it is not opened. This is
-handy, especially if you have .svn directories.
-
+hidden file filter (see |NERDTreeShowHidden|) then its contents are not
+cached. This is handy, especially if you have .svn directories.
 
 ------------------------------------------------------------------------------
                                                                   *NERDTree-x*
@@ -293,8 +344,7 @@ Default key: <C-j>
 Map option: NERDTreeMapJumpNextSibling
 Applies to: files and directories.
 
-If a dir node is selected, jump to the next sibling of that node.
-If a file node is selected, jump to the next sibling of that nodes parent.
+Jump to the next sibling of the selected node.
 
 ------------------------------------------------------------------------------
                                                                 *NERDTree-c-k*
@@ -302,8 +352,7 @@ Default key: <C-k>
 Map option: NERDTreeMapJumpPrevSibling
 Applies to: files and directories.
 
-If a dir node is selected, jump to the previous sibling of that node.
-If a file node is selected, jump to the previous sibling of that nodes parent.
+Jump to the previous sibling of the selected node.
 
 ------------------------------------------------------------------------------
                                                                   *NERDTree-C*
@@ -311,7 +360,8 @@ Default key: C
 Map option: NERDTreeMapChdir
 Applies to: directories.
 
-Made the selected directory node the new tree root.
+Make the selected directory node the new tree root. If a file is selected, its
+parent is used.
 
 ------------------------------------------------------------------------------
                                                                   *NERDTree-u*
@@ -401,7 +451,7 @@ Toggles whether the quickhelp is displayed.
 2.3. The filesystem menu                                 *NERDTreeFilesysMenu*
 
 The purpose of the filesystem menu is to allow you to perform basic filesystem
-operations quickly from the NERD tree rather than the console.  
+operations quickly from the NERD tree rather than the console.
 
 The filesystem menu can be accessed with 'm' mapping and has four supported
 operations: >
@@ -428,7 +478,7 @@ on the renamed node.
 To delete a node put the cursor on it and select the 'delete' option from the
 filesystem menu. After confirmation the node will be deleted. If a file is
 deleted but still exists as a buffer you will be given the option to delete
-that buffer. 
+that buffer.
 
 4. Copying nodes:
 To copy a node put the cursor on it and select the 'copy' option from the
@@ -468,6 +518,8 @@ NERD tree. These options should be set in your vimrc.
 
 |NERDTreeIgnore|                Tells the NERD tree which files to ignore.
 
+|NERDTreeBookmarksFile|         Where the bookmarks are stored.
+
 |NERDTreeMouseMode|             Tells the NERD tree how to handle mouse
                                 clicks.
 
@@ -477,6 +529,9 @@ NERD tree. These options should be set in your vimrc.
 |NERDTreeShowHidden|            Tells the NERD tree whether to display hidden
                                 files on startup.
 
+|NERDTreeShowLineNumbers|       Tells the NERD tree whether to display line
+                                numbers in the tree window.
+
 |NERDTreeSortOrder|             Tell the NERD tree how to sort the nodes in
                                 the tree.
 
@@ -486,7 +541,7 @@ NERD tree. These options should be set in your vimrc.
 
 |NERDTreeWinPos|                Tells the script where to put the NERD tree
                                 window.
-                               
+
 
 |NERDTreeWinSize|               Sets the window size when the NERD tree is
                                 opened.
@@ -494,10 +549,10 @@ NERD tree. These options should be set in your vimrc.
 ------------------------------------------------------------------------------
 3.2. Customisation details                             *NERDTreeOptionDetails*
 
-To enable any of the below options you should put the given line in your 
+To enable any of the below options you should put the given line in your
 ~/.vimrc
 
-                                                            *loaded_nerd_tree*              
+                                                            *loaded_nerd_tree*
 If this plugin is making you feel homicidal, it may be a good idea to turn it
 off with this line in your vimrc: >
     let loaded_nerd_tree=1
@@ -513,21 +568,21 @@ added to the nerd tree to make it more colourful.
 Set it to 0 for a more vanilla looking tree.
 
 ------------------------------------------------------------------------------
-                                                          *NERDTreeAutoCenter*                
+                                                          *NERDTreeAutoCenter*
 Values: 0 or 1.
 Default: 1
 
 If set to 1, the NERD tree window will center around the cursor if it moves to
 within |NERDTreeAutoCenterThreshold| lines of the top/bottom of the window.
 
-This is ONLY done in response to tree navigation mappings, 
+This is ONLY done in response to tree navigation mappings,
 i.e. |NERDTree-J| |NERDTree-K| |NERDTree-C-J| |NERDTree-c-K| |NERDTree-p|
 |NERDTree-P|
 
 The centering is done with a |zz| operation.
 
 ------------------------------------------------------------------------------
-                                                 *NERDTreeAutoCenterThreshold*                
+                                                 *NERDTreeAutoCenterThreshold*
 Values: Any natural number.
 Default: 3
 
@@ -535,7 +590,7 @@ This option controls the "sensitivity" of the NERD tree auto centering. See
 |NERDTreeAutoCenter| for details.
 
 ------------------------------------------------------------------------------
-                                                   *NERDTreeCaseSensitiveSort*        
+                                                   *NERDTreeCaseSensitiveSort*
 Values: 0 or 1.
 Default: 0.
 
@@ -556,7 +611,7 @@ account. The above nodes would then be sorted like this: >
     boner.c
 <
 ------------------------------------------------------------------------------
-                                                           *NERDTreeChDirMode*                
+                                                           *NERDTreeChDirMode*
 
 Values: 0, 1 or 2.
 Default: 1.
@@ -578,10 +633,6 @@ the CWD is changed whenever the tree root is changed. For example, if the CWD
 is /home/marty/foobar and you make the node for /home/marty/foobar/baz the new
 root then the CWD will become /home/marty/foobar/baz.
 
-Note to windows users: it is highly recommended that you have this option set
-to either 1 or 2 or else the script wont function properly if you attempt to
-open a NERD tree on a different drive to the one vim is currently in.
-
 Authors note: at work i have this option set to 1 because i have a giant ctags
 file in the root dir of my project. This way i can initialise the NERD tree
 with the root dir of my project and always have ctags available to me --- no
@@ -596,18 +647,18 @@ If set to 1, the current cursor line in the NERD tree buffer will be
 highlighted. This is done using the |cursorline| option.
 
 ------------------------------------------------------------------------------
-                                                              *NERDTreeIgnore*                
+                                                              *NERDTreeIgnore*
 Values: a list of regular expressions.
 Default: ['\~$'].
 
 This option is used to specify which files the NERD tree should ignore.  It
 must be a list of regular expressions. When the NERD tree is rendered, any
-files/dirs that match any of the regex's in NERDTreeIgnore wont be displayed. 
+files/dirs that match any of the regex's in NERDTreeIgnore wont be displayed.
 
 For example if you put the following line in your vimrc: >
     let NERDTreeIgnore=['\.vim$', '\~$']
 <
-then all files ending in .vim or ~ will be ignored. 
+then all files ending in .vim or ~ will be ignored.
 
 Note: to tell the NERD tree not to ignore any files you must use the following
 line: >
@@ -618,11 +669,18 @@ The file filters can be turned on and off dynamically with the |NERDTree-f|
 mapping.
 
 ------------------------------------------------------------------------------
-                                                           *NERDTreeMouseMode*                
+                                                       *NERDTreeBookmarksFile*
+Values: a path
+Default: $HOME/.NERDTreeBookmarks
+
+This is where bookmarks are saved. See |NERDTreeBookmarkCommands|.
+
+------------------------------------------------------------------------------
+                                                           *NERDTreeMouseMode*
 Values: 1, 2 or 3.
 Default: 1.
 
-If set to 1 then a double click on a node is required to open it. 
+If set to 1 then a double click on a node is required to open it.
 If set to 2 then a single click will open directory nodes, while a double
 click will still be required for file nodes.
 If set to 3 then a single click will open any node.
@@ -636,7 +694,7 @@ then (to single click activate it) you must click somewhere in
 'application.rb'.
 
 ------------------------------------------------------------------------------
-                                                           *NERDTreeShowFiles*            
+                                                           *NERDTreeShowFiles*
 Values: 0 or 1.
 Default: 1.
 
@@ -648,7 +706,7 @@ useful for drastically shrinking the tree when you are navigating to a
 different part of the tree.
 
 ------------------------------------------------------------------------------
-                                                          *NERDTreeShowHidden*            
+                                                          *NERDTreeShowHidden*
 Values: 0 or 1.
 Default: 0.
 
@@ -658,7 +716,18 @@ Use one of the follow lines to set this option: >
     let NERDTreeShowHidden=0
     let NERDTreeShowHidden=1
 <
-                                                       
+
+------------------------------------------------------------------------------
+                                                     *NERDTreeShowLineNumbers*
+Values: 0 or 1.
+Default: 0.
+
+This option tells vim whether to display line numbers for the NERD tree
+window.  Use one of the follow lines to set this option: >
+    let NERDTreeShowLineNumbers=0
+    let NERDTreeShowLineNumbers=1
+<
+
 ------------------------------------------------------------------------------
                                                            *NERDTreeSortOrder*
 Values: a list of regular expressions.
@@ -688,7 +757,7 @@ Other examples: >
     (3) ['\/$', '\.rb$', '\.php$', '*', '\.swp$',  '\.bak$', '\~$']
 <
 1. Directories will appear last, everything else will appear above.
-2. Every will simply appear in alphabetical order.
+2. Everything will simply appear in alphabetical order.
 3. Dirs will appear first, then ruby and php. Swap files, bak files and vim
    backup files will appear last with everything else preceding them.
 
@@ -698,7 +767,7 @@ Values: 0 or 1.
 Default: 1.
 
 This option, along with |NERDTreeWinPos|, is used to determine where the NERD
-tree window appears. 
+tree window appears.
 
 If it is set to 1 then the NERD tree window will appear on either the left or
 right side of the screen (depending on the |NERDTreeWinPos| option).
@@ -715,7 +784,7 @@ determine where NERD tree window is placed on the screen.
 
 If the option is set to 1 then the NERD tree will appear on the left or top of
 the screen (depending on the value of |NERDTreeSplitVertical|). If set to 0,
-the window will appear on the right or bottom of the screen. 
+the window will appear on the right or bottom of the screen.
 
 This option is makes it possible to use two different explorer type
 plugins simultaneously. For example, you could have the taglist plugin on the
@@ -757,10 +826,7 @@ Window manager integration?
 6. The Author                                                 *NERDTreeAuthor*
 
 The author of the NERD tree is a terrible terrible monster called Martyzilla
-who gobbles up small children with milk and sugar for breakfast. He has an odd
-love/hate relationship with computers (but monsters hate everything by nature
-you know...) which can be awkward for him since he is a pro computer nerd for
-a living.
+who gobbles up small children with milk and sugar for breakfast.
 
 He can be reached at martin_grenfell at msn.com. He would love to hear from
 you, so feel free to send him suggestions and/or comments about this plugin.
@@ -768,7 +834,47 @@ Don't be shy --- the worst he can do is slaughter you and stuff you in the
 fridge for later ;)
 
 ==============================================================================
-7. Changelog                                               *NERDTreeChangelog* 
+7. Changelog                                               *NERDTreeChangelog*
+
+2.11.0
+    - changes to the 'o' mapping when opening files:
+      - dont clobber "special" windows (eg taglist/quickfix/etc). This should
+        make the NERD tree play nicer with other explorer plugins. Thanks to
+        Yuan Jiang for the suggestion.
+      - if the file is already open in the current tab, just move the cursor
+        to that window
+    - highlight executable files, made some slight changes to other
+      highlighting
+    - if the user resizes the tree window, keep that new size. Dont reset to
+      the default during the <tab> mapping, or :NERDTreeToggle command. Only
+      reset the size if a fresh tree is started with :NERDTree.
+    - remove the "magic" functionality from the <c-j>/<c-k> mappings (it was
+      more confusing than helpful)
+    - other minor fixes
+
+2.10.0
+    - added bookmarks, see :help NERDTreeBookmarkCommands for details. Thanks
+      to Piotr Czachur for all his testing and suggestions.
+    - fixed screen jumping bug with when &scrolloff != 0
+    - fixed some bugs with copying nodes
+    - other random fixes
+    - change license to wtfpl
+
+2.9.0
+
+    - path handling improvements, thanks to Zhang Shuhan for heaps of
+      testing/bug reports
+        * improved how paths are stored, now the script will no longer get
+          confused about drives on MF Windows
+        * made the script way better at handling paths with strange characters
+          in them (eg '$@; etc)
+    - applied a patch from Cory Echols
+        * add the command :NERDTreeClose to close the tree for the current tab
+        * set the filetype for the NERD tree buffer to "nerdtree"
+
+2.8.0
+    - added an option to enable/disable line numbers in the NERD tree window,
+      thanks to Olivier Yiptong for the email.
 
 2.7.1
     - Changed the keys for the filesystem menu to be mnemonic rather than
@@ -778,7 +884,7 @@ fridge for later ;)
 2.7.0
     - Bug fix: Now when you have the tree on the right and you open it with
       multiple windows stacked, it will take up the full height of the vim
-      window. 
+      window.
     - Now line numbers always turned off in the tree by default
     - Implemented copying of nodes (via the filesystem menu) for *nix/macosx
     - took the help doc out of the script and repackaged the whole thing as a
@@ -853,13 +959,13 @@ fridge for later ;)
     - Made the quickhelp correctly display the current single/double click
       mappings for opening nodes as specified by the NERDTreeMouseMode option.
     - Fixed a bug where the script was spazzing after prompting you to delete
-      a modified buffer when using the filesystem menu.  
+      a modified buffer when using the filesystem menu.
     - Refactoring
 2.2.3
     - Refactored the :echo output from the script.
     - Fixed some minor typos in the doc.
     - Made some minor changes to the output of the 'Tree filtering mappings'
-      part of the quickhelp 
+      part of the quickhelp
 
 2.2.2
     - More bugfixes... doh.
@@ -964,7 +1070,7 @@ Thanks to Michael Madsen for emailing me about making case sensitivity
 optional when sorting nodes.
 
 Thanks to AOYAMA Shotaro for suggesting that i echo a "please wait" message
-when opening large directories. 
+when opening large directories.
 
 Thanks to Michael Madsen for requesting the NERDTreeCaseSensitiveSort option.
 
@@ -978,3 +1084,24 @@ in 2.6.0
 Thanks to  Niels Aan de Brugh for the suggestion that the script now split the
 window if you try to open a file in a window containing a modified buffer when
 the &hidden option is set.
+
+Thanks to Olivier Yiptong for prompting me to make line numbers in the
+NERD tree window optional.
+
+Thanks to Zhang Shuhan for all of his emails and testing to help improve the
+NERD tree path handling.
+
+Thanks to Cory Echols for sending a patch to add the :NERDTreeClose command and
+set the NERD tree buffers filetype to 'nerdtree'
+
+Thanks to Piotr Czachur for all his suggestions and testing for the bookmarks
+feature.
+
+Thanks to Yuan Jiang for suggesting the "o" mapping shouldnt clobber "special"
+windows, like taglist.
+
+==============================================================================
+9. License                                                   *NERDTreeLicense*
+
+The NERD tree is released under the wtfpl.
+See http://sam.zoy.org/wtfpl/COPYING.