qiangf / emacs-nav

Automatically exported from code.google.com/p/emacs-nav

emacs-nav: simple file-system navigation

Nav is a lightweight solution for Emacs users who want something like TextMate's file browser, or the Eclipse project view. Unlike these two, Nav only shows the contents of a single directory at a time. Nav can be run painlessly in terminals, where Speedbar either fails on its attempt to make a new frame or is hidden. Nav's terminal-friendliness comes from running in the frame where it was started, keeping window management simple. The Nav key bindings are also simple -- each key command is a single keystroke long.

Install

Put something like this in your ~/.emacs:

(add-to-list 'load-path "/directory/containing/nav/") (require 'nav) (nav-disable-overeager-window-splitting) ;; Optional: set up a quick key to toggle nav ;; (global-set-key [f8] 'nav-toggle)

Navigate!

Type M-x nav to start navigating.

In the nav window, hit ? to get help on keyboard shortcuts.

To set options for Nav, type M-x customize, then select Applications, Nav.

emacs-nav's Issues

Quit doesn't work if nav is the only window

What steps will reproduce the problem?
1. Open Nav
2. C-x 1
3. press q

What is the expected output? 
nav to close with the next buffer shown

What do you see instead?
Attempt to delete minibuffer or sole ordinary window

Other:
There has been a few instances of other programs closing the window and
leaving nav in a sole ordainary window. 

Original issue reported on code.google.com by [email protected] on 16 Aug 2009 at 10:56

everybody loves screenshots

Hi

You should put a screenshot in homepage.

Like this one (not from me):

http://www.flickr.com/photos/silent11/3364805876/sizes/o/

Original issue reported on code.google.com by [email protected] on 18 Mar 2009 at 10:24

Error on M-x nav twice

What steps will reproduce the problem?
1. M-x nav 
2. M-x nav
3.

I get the following backtrace in emacs22 -q

Debugger entered--Lisp error: (error "No other window to side of this one")
  shrink-window(60 t)
  shrink-window-horizontally(60)
  (if (> (window-width) n) (shrink-window-horizontally (- ... n)))
  nav-set-window-width(30)
  (let ((delay-mode-hooks t)) (kill-all-local-variables) (setq major-mode
(quote nav-mode)) (setq mode-name "Nav-mode is for IDE-like navigation of
directories.\n\n It's more IDEish than dired, not as heavy weight as
speedbar.") nil (use-local-map nav-mode-map) (set-syntax-table
nav-mode-syntax-table) (setq local-abbrev-table nav-mode-abbrev-table)
(nav-set-window-width nav-width) (setq mode-name "Navigation")
(use-local-map nav-mode-map) (turn-on-font-lock) (font-lock-add-keywords
(quote nav-mode) (quote ...)) (setq buffer-read-only t) (nav-refresh))
  (progn (make-local-variable (quote delay-mode-hooks)) (let (...)
(kill-all-local-variables) (setq major-mode ...) (setq mode-name "Nav-mode
is for IDE-like navigation of directories.\n\n It's more IDEish than dired,
not as heavy weight as speedbar.") nil (use-local-map nav-mode-map)
(set-syntax-table nav-mode-syntax-table) (setq local-abbrev-table
nav-mode-abbrev-table) (nav-set-window-width nav-width) (setq mode-name
"Navigation") (use-local-map nav-mode-map) (turn-on-font-lock)
(font-lock-add-keywords ... ...) (setq buffer-read-only t) (nav-refresh)))
  (delay-mode-hooks (kill-all-local-variables) (setq major-mode (quote
nav-mode)) (setq mode-name "Nav-mode is for IDE-like navigation of
directories.\n\n It's more IDEish than dired, not as heavy weight as
speedbar.") nil (use-local-map nav-mode-map) (set-syntax-table
nav-mode-syntax-table) (setq local-abbrev-table nav-mode-abbrev-table)
(nav-set-window-width nav-width) (setq mode-name "Navigation")
(use-local-map nav-mode-map) (turn-on-font-lock) (font-lock-add-keywords
(quote nav-mode) (quote ...)) (setq buffer-read-only t) (nav-refresh))
  nav-mode()
  nav()
  call-interactively(nav)
  execute-extended-command(nil)
  call-interactively(execute-extended-command)

in emacs 23 with my -emacs

Debugger entered--Lisp error: (error "No other window to side of this one")
  shrink-window(128 t)
  shrink-window-horizontally(128)
  (if (> (window-width) n) (shrink-window-horizontally (- ... n)))
  nav-set-window-width(30)
  (let ((delay-mode-hooks t)) (kill-all-local-variables) (setq major-mode
(quote nav-mode)) (setq mode-name "Nav-mode is for IDE-like navigation of
directories.\n\n It's more IDEish than dired, not as heavy weight as
speedbar.") nil (use-local-map nav-mode-map) (set-syntax-table
nav-mode-syntax-table) (setq local-abbrev-table nav-mode-abbrev-table)
(nav-set-window-width nav-width) (setq mode-name "Navigation")
(use-local-map nav-mode-map) (turn-on-font-lock) (font-lock-add-keywords
(quote nav-mode) (quote ...)) (setq buffer-read-only t) (nav-refresh))
  (progn (make-local-variable (quote delay-mode-hooks)) (let (...)
(kill-all-local-variables) (setq major-mode ...) (setq mode-name "Nav-mode
is for IDE-like navigation of directories.\n\n It's more IDEish than dired,
not as heavy weight as speedbar.") nil (use-local-map nav-mode-map)
(set-syntax-table nav-mode-syntax-table) (setq local-abbrev-table
nav-mode-abbrev-table) (nav-set-window-width nav-width) (setq mode-name
"Navigation") (use-local-map nav-mode-map) (turn-on-font-lock)
(font-lock-add-keywords ... ...) (setq buffer-read-only t) (nav-refresh)))
  (delay-mode-hooks (kill-all-local-variables) (setq major-mode (quote
nav-mode)) (setq mode-name "Nav-mode is for IDE-like navigation of
directories.\n\n It's more IDEish than dired, not as heavy weight as
speedbar.") nil (use-local-map nav-mode-map) (set-syntax-table
nav-mode-syntax-table) (setq local-abbrev-table nav-mode-abbrev-table)
(nav-set-window-width nav-width) (setq mode-name "Navigation")
(use-local-map nav-mode-map) (turn-on-font-lock) (font-lock-add-keywords
(quote nav-mode) (quote ...)) (setq buffer-read-only t) (nav-refresh))
  nav-mode()
  nav()
  call-interactively(nav nil nil)
  recursive-edit()
  byte-code("Æ�    @Ç=ƒ!


What is the expected output? What do you see instead?

The *nav* buffer is empty.
I know I should quit nav with key q. In fact I have to press q in the empty
*nav* do again M-x nav then it works again


What version of the product are you using? On what operating system?
xp

Please provide any additional information below.

Original issue reported on code.google.com by [email protected] on 23 Mar 2009 at 7:04

Help screen in tags mode is the same as the main one

The keybindings are different (almost a subset, but I'd like to have the 
freedom to have some differences).

Original issue reported on code.google.com by [email protected] on 12 Aug 2009 at 8:57

's' key does not unsort in tags mode

What steps will reproduce the problem?
1. Open tags mode.
2. Press 's'
3. Press 's' again.

What is the expected output? What do you see instead?
The tags should go back to their order in the file. Instead they remain sorted.

Original issue reported on code.google.com by [email protected] on 12 Aug 2009 at 6:33

Tags mode needs a refresh command

...

Original issue reported on code.google.com by [email protected] on 12 Aug 2009 at 7:29

Opening a file makes a new window in emacs 23

What steps will reproduce the problem?
1. Open emacs 23
2. Open nav
3. Choose a file by hitting enter or clicking with the mouse.

What is the expected output? What do you see instead?
The file should open in the already-existing window on the right.
Instead a new window is created and the file opens there.

Original issue reported on code.google.com by [email protected] on 10 Aug 2009 at 11:19

Quickfile button behaves different if nav not the current window

What steps will reproduce the problem?
1. Make current any window besides nav
2. Click quickfile button with mouse
3. Will open file in a new frame 

What is the expected output? 

The file should up in a new buffer under current window.


nav-quickdir-jump-button-action function needs to test if
nav is the current window. If not make it the current. 

Original issue reported on code.google.com by [email protected] on 29 Jul 2009 at 8:21

Bufs mode should go to tags on 't'

...

Original issue reported on code.google.com by [email protected] on 13 Aug 2009 at 12:29

Tags produces a error on files without tags

What steps will reproduce the problem?
1. Open file with no functions

What is the expected output? 
1. should switch tag mode
2. display filename header
3. report no tags

What do you see instead?
and: Wrong type argument: stringp, nil

Original issue reported on code.google.com by [email protected] on 17 Aug 2009 at 6:59

Cursor position is not preserved after deleting a buffer

What steps will reproduce the problem?
1. Go to bufs mode
2. Press d on a buffer.

Original issue reported on code.google.com by [email protected] on 17 Aug 2009 at 11:32

Shell command completion is inconsistent.

What steps will reproduce the problem?
1. Hit 's' to open a shell in a directory that we'll call A.
2. Go back to nav and change to a different directory (call it B).
3. Hit 's' again to go back to the shell, now in dir B.
4. Type ls and then part of the name of a file, then tab.

What is the expected output? What do you see instead?
The filename should be completed or a list of choices shown, in the context 
of directory B. Instead, the completion is done as though we were still in 
directory A. 

Original issue reported on code.google.com by [email protected] on 21 Mar 2009 at 7:35

Find results don't always respond to enter

What steps will reproduce the problem?
1. Hit the 'f' key in a directory
2. Type in a pattern to find.
3. Hit enter on one of the results.

What is the expected output? What do you see instead?
It should open the file, but that doesn't always work.

Original issue reported on code.google.com by [email protected] on 5 Apr 2009 at 6:14

Find-results window has too much vertical blank space

What steps will reproduce the problem?
1. Run a find that doesn't get a lot of results.

What is the expected output? What do you see instead?
The window should be short, but it is tall.

Please use labels and text to provide additional information.

Original issue reported on code.google.com by [email protected] on 16 Mar 2009 at 11:05

Running the 'g' and 'f' commands doesn't work well in trees containing filenames with spaces.

This problem should go away once we move to using an emacs lisp function to 
traverse directory 
trees instead of relying on the unix find command.

Original issue reported on code.google.com by [email protected] on 19 Mar 2009 at 6:55

Moving directories to other directories is not convenient

What steps will reproduce the problem?
1. Press 'm' on a directory, call it A.
2. Type the name of another directory, B, to move it to.

What is the expected output? What do you see instead?
Directory A should move to dir B. An error message appears instead.

Original issue reported on code.google.com by [email protected] on 7 Apr 2009 at 7:34

Temporary file buffers from find and grep stay around

What steps will reproduce the problem?
1. Hit 'g' to do a grep, and enter a pattern
2. Kill the grep buffer

What is the expected output? What do you see instead?
A buffer containing all the searched filenames shows up. It should not be there.

Original issue reported on code.google.com by [email protected] on 27 Mar 2009 at 5:32

Hitting enter on a quickdir does not jump nav there

...

Original issue reported on code.google.com by [email protected] on 16 Aug 2009 at 1:11

Directory contents are sorted case-sensitively

What steps will reproduce the problem?
1. Go to a directory containing files starting with lower case and upper case 
letters.

What is the expected output? What do you see instead?
The uppercase files show up first. They should be mixed together with the 
lowercase ones.

Original issue reported on code.google.com by [email protected] on 29 Mar 2009 at 7:14

Rotate buffers should skip mini-buffer

What steps will reproduce the problem?
1. Open two files - nav splits the window as expected
2. Use either '[' or ']'
3. The buffers are rotated but the mini-buffer is rotated as well

What is the expected output? What do you see instead?
I think you would not want to see the mini-buffer moved up and one of the
buffers moved down. 

What version of the product are you using? On what operating system?
v16 on Windows XP, Emacs 23

Please provide any additional information below.
One option is to control this behavior (include mini-buffer or not) using a
custom variable.

Original issue reported on code.google.com by [email protected] on 18 Mar 2009 at 7:54

Tags mode is cluttered by bracketed locations

We can build an assoc list or hash table instead of keeping these numbers in 
the buffer.

Original issue reported on code.google.com by [email protected] on 14 Aug 2009 at 8:01

Hitting enter on directories sometimes fails to open them

What steps will reproduce the problem?
1. Navigate through some directories, pressing u a few times.
2. At some point it may no longer be possible to move to a directory.

I think this may have been caused by my recent change to nav-push-dir. 

Original issue reported on code.google.com by [email protected] on 17 Aug 2009 at 8:40

Review Request

Purpose of code changes on this branch:

1. Fixed quick* buttons. They were not working because of
nav-make-filenames-clickable was voiding them.

2. Renamed directory bookmarks to "quickdir" so not to be confused with
emacs bookmark system. 

3. Removed erroneous comments.
What is the expected output? What do you see instead?

Notes:
Default review request does not work on google code with hg. This is a
known issue. 

Original issue reported on code.google.com by [email protected] on 29 Jul 2009 at 12:51

Attachments:

• nav.el

patch to toggle hidden files

small patch i use to toggle hidden files, against r43. Perhaps useful :)

Original issue reported on code.google.com by emptyvee on 29 Jun 2009 at 9:46

Attachments:

• nav_patch.txt

Tags do not show up for Python

What steps will reproduce the problem?
1. Open nav on a directory containing python files
2. Press t on a python file

What is the expected output? What do you see instead?
Tags should come up but they do not.

Original issue reported on code.google.com by [email protected] on 11 Aug 2009 at 9:29

let: Symbol's function definition is void: nav-assert

I'm getting this in my messages when I navigate to directories in the nav
buffer in a terminal.

What steps will reproduce the problem?
1. place cursor on ".."
2. press enter

It lists the top directory but I'm getting that message.

What is the expected output? What do you see instead?
No messages.

What version of the product are you using? On what operating system?
GNU Emacs 21.4.1 (i486-pc-linux-gnu, X toolkit, Xaw3d scroll bars) of
2007-06-19 on ninsei, modified by Debian


Please provide any additional information below.

I'm relatively new to emacs so perhaps this is a minor issue that I should
just ignore?

Original issue reported on code.google.com by [email protected] on 18 Mar 2009 at 6:17

[patch] nav-open-file-other-window-2: customize whether to open window vertically or horizontally

Hi, the attached patch lets you customize how to split the window on
`nav-open-file-other-window-2'.  On my narrow screen I prefer splitting
vertically.

Original issue reported on code.google.com by [email protected] on 18 Mar 2009 at 8:30

Attachments:

• nav-patch.patch

Cursor jumps to top after deleting files

This was observed on Emacs 23 on Linux using the GTK ui.

Original issue reported on code.google.com by [email protected] on 11 Aug 2009 at 6:52

Tags view needs spaces above classes

...

Original issue reported on code.google.com by [email protected] on 16 Aug 2009 at 1:11

Deleted directories stay in directory stack

What steps will reproduce the problem?
Go to a directory, then leave it, then delete it.

What is the expected output? What do you see instead?
The directory path remains in the stack, so when you pop using the p key it 
tries to put you back in 
the deleted directory.

Original issue reported on code.google.com by [email protected] on 19 Mar 2009 at 6:54

Can't go to tags mode in emacs 22 (in terminal at least)

What steps will reproduce the problem?
1. Press T with the cursor over a source code file.

What is the expected output? What do you see instead?
It should open tags mode. Instead it displays "Cannot switch buffers in a 
dedicated window."

Original issue reported on code.google.com by [email protected] on 11 Aug 2009 at 5:52

Class methods are not sorted in tags mode

...

Original issue reported on code.google.com by [email protected] on 16 Aug 2009 at 1:17

2 key fails on buffer list

What steps will reproduce the problem?
1. Go to buffer list.
2. Press 2 on one of the buffer names.

What is the expected output? What do you see instead?
The buffer should open in a second window on the right, but nothing shows up 
there.

Original issue reported on code.google.com by [email protected] on 31 Jul 2009 at 6:41

Find is hosed.

What steps will reproduce the problem?
1. Go to some directory, press 'f' and enter the name of some file.
2. In the find results, press enter on the file name.

What is the expected output? What do you see instead?
It should open that file. An error message appears instead.

Original issue reported on code.google.com by [email protected] on 12 Aug 2009 at 6:27

cursor movement horribly broken in terminals

This is due to control-p and n etc being mapped to forward-button and 
backward-button.

Original issue reported on code.google.com by [email protected] on 8 Aug 2009 at 7:57

Tags are not shown for files with one function

What steps will reproduce the problem?
1. Locate file with one function.
2. Open it with 't' or shift-left-mouse
3. tags display is empty

Original issue reported on code.google.com by [email protected] on 13 Aug 2009 at 5:31

Grep file list handling is buggy under windows (patch included)

What steps will reproduce the problem?
1. Point your global tmp directory at a path containing spaces.
2. attempt to run nav-recursive-grep

What is the expected output? What do you see instead?
I expect grep results, instead cat reports that it cannot read the file.

What version of the product are you using? On what operating system?
version 42, windows xp.

Please provide any additional information below.
I've attached a patch which seems to work.

The patch also addresses a second problem -- I typically run with
require-final-newline set to t, in which case the list of files ends up
with a final appended \r\n. I believe my patch addresses this issue as well.

Lang

Original issue reported on code.google.com by [email protected] on 13 Jul 2009 at 3:58

Attachments:

• nav.el-42.patch

Popping the directory stack doesn't work consistently

What steps will reproduce the problem?
1. Start in the emacs-nav dir
2. Hit the u key to go up
3. Hit the p key to pop

What is the expected output? What do you see instead?
It should go back to emacs-nav/, but it just stays where it is.

Original issue reported on code.google.com by [email protected] on 19 Mar 2009 at 10:02

Pressing d on a symlink asks you if you want to delete it as a directory

What steps will reproduce the problem?
1. Put the cursor on a symbolic link to a directory
2. Press d

What is the expected output? What do you see instead?
It should ask you something like "Do you want to delete this symbolic link", 
with a y or n response. 
Instead it asks if you want to delete the directory with a yes or no response.

Original issue reported on code.google.com by [email protected] on 24 Mar 2009 at 5:12

Find result buffer doesn't work with enter key.

What steps will reproduce the problem?
1. Hit 'f' and enter some pattern
2. In the result buffer hit enter on a filename

What is the expected output? What do you see instead?
Expected it to open the file. Instead it modified the result buffer.

Original issue reported on code.google.com by [email protected] on 16 Mar 2009 at 10:17

[patch] nav-resize-frame

It would be nice to preserve the width of existing buffers, for people who 
don't work with full-
screen emacs frames.  Patch attached.

Original issue reported on code.google.com by [email protected] on 19 Mar 2009 at 4:55

Attachments:

• nav-resize-frame.patch

grep fails on quotes and dashes

What steps will reproduce the problem?
1. Hit g
2. Type something with quotes like 'foo'  or something with dashes like --foo.

What is the expected output? What do you see instead?
It should show all the files containing these things, but instead it shows an 
error message.

Original issue reported on code.google.com by [email protected] on 15 Aug 2009 at 11:37

Quick buttons at bottom are cryptic

What steps will reproduce the problem?
1. Load nav.

At the bottom, the quick buttons don't say what they are about. I think it 
would be better to just 
show the names of the files and directories that they take you to, one per 
line. 

Original issue reported on code.google.com by [email protected] on 31 Jul 2009 at 8:03

[patch] nav-invoke-dired ends up in wrong directory

nav-invoke-dired ("e") ended up in the directory of the currently displayed
buffer, not in the current directory of the *nav* buffer.  Patch attached.

Original issue reported on code.google.com by [email protected] on 19 Mar 2009 at 3:47

Attachments:

• nav-dired.patch

There is no nice way to make nav jump to the directory of the file you're editing

What steps will reproduce the problem?
1. Open nav.
2. Open a file in a different directory in a another window

At this point you might want a one-step solution to make nav focus on the 
directory containing the file you're editing. There currently is none.

One possible solution would be to make M-x nav just open nav in the current 
directory, instead of toggling it on and off the way it does now.

Original issue reported on code.google.com by [email protected] on 16 Aug 2009 at 12:30

[Feature Request] Add support for tags

Maybe out of scope for nav, but something I found very useful in the
speedbar: support for listing etags.

Original issue reported on code.google.com by [email protected] on 28 Apr 2009 at 1:37

Tags mode shows a warning on startup on emacs 22

What steps will reproduce the problem?
1. Hit t on a file in nav mode.

What is the expected output? What do you see instead?
Nothing should appear in the message line, but a warning appears:

Toggling blink-cursor-mode off; better pass an explicit argument.

which is strange because an argument is being passed.

Original issue reported on code.google.com by [email protected] on 14 Aug 2009 at 6:00

Nav forgets the cursor's location when coming back to a directory

What steps will reproduce the problem?
1. Go to a directory d1 and put the cursor on line 10 say. 
2. Go to another directory, then come back to d1.

What is the expected output? What do you see instead?
The cursor should be on line 10, but it's often on some other line.

Original issue reported on code.google.com by [email protected] on 24 Mar 2009 at 5:42

Cannot open file when cursor is on last character

What steps will reproduce the problem?
1. Move the cursor to the last character in the Nav buffer
2. Hit enter

What is the expected output? What do you see instead?
Expected it to open the file. Instead it complains about being a read only 
buffer.

Original issue reported on code.google.com by [email protected] on 20 Mar 2009 at 7:30

Add a frame/window balance on quit

What steps will reproduce the problem?
1. Open nav
2. Use it
3. Quit

What is the expected output? What do you see instead?
I'd expect the frames to go back to a balanced state.


What version of the product are you using? On what operating system?
Emacs 23 (rc something) on Linux over SSH


Please provide any additional information below.
It would be nice if when nav quits, it would rebalance the frames (C-+). 

Original issue reported on code.google.com by [email protected] on 24 Mar 2009 at 7:26