doc/project.txt0100644000425700003600000004360407363553545013204 0ustar aricalchemy*project.txt* Plugin for managing multiple projects with multiple sources For Vim version 6.0. Last Change: Thu 18 Oct 2001 09:21:41 AM EDT By Aric Blumer Aric.Blumer@marconi.com *project* *project-plugin* You can use this plugin's basic functionality to set up a list of frequently-accessed files for easy navigation. The list of files will be displayed in a window on the left side of the Vim window, and you can press or double-click on filenames in the list to open the files. I find this easier to use than having to navigate a directory hierarchy with the |file-explorer|. You can also instruct the Plugin to change to a directory and to run scripts when you select a file. These scripts can, for example, modify the environment to include compilers in $PATH. This makes it very easy to use quickfix with multiple projects that use different environments. Other features include: o Loading/Unloading all the files in a Project (\l, \L, \w, and \W) o Grepping all the files in a Project (\g and \G) o Running a user-specified script on a file (can be used to launch an external program on the file) (\1 through \9) o Running a user-specified script on all the files in a Project (\f1-\f9 and \F1-\F9) o High degree of user-configurability o Also works with |netrw| using the XXXX://... notation where XXXX is ftp, rcp, scp, or http. All of this is specified within a simple text file and a few global variables in your vimrc file. You must set 'nocompatible' in your |vimrc| file to use this plugin. You can stop the plugin from being loaded by setting the "loaded_project" variable: > :let loaded_project = 1 ============================================================================== COMMANDS *project-invoking* You can use the plugin by placing it in your plugin directory (e.g., ~/.vim/plugin). See |add-global-plugin|. When you start vim the next time, you then enter the command > :Project or > :Project {file} If you do not specify the filename, $HOME/.vimprojects is used. To have Vim come up with the Project Window enabled automatically (say, from a GUI launcher), run Vim like this: [g]vim +Project Note that you can invoke :Project on only one file at a time. If you wish to change the Project File, do a :bwipe in the Project Buffer, then re-invoke the Plugin as described above. Several Projects can be kept and displayed in the same file, each in a fold delimited by { and } (see |fold.txt|). There can be any number of nested folds to provide you with a Project hierarchy. Any line without a { or a } in the file is considered to be a filename. Blank lines are ignored, and any text after a # is ignored. Because the plugin uses standard Vim folds, you can use any of the |fold-commands|. You can double-click on the first line of a fold to open and close it. You can select a file to open by putting the cursor on its name and pressing or by double-clicking on it. The plugin will create a new window to the right or use the |CTRL-W_p| equivalent if it exists. *project-syntax* Each Project Entry has this form: project_entry ::= ={projpath} [{options}] { [ filename ] [ project_entry ] } {options} is one or more of the following (on the same line): CD={path} in={filename} out={filename} filter="{pat}" flags={flag} Note that a project_entry can reside within a project_entry. This allows you to set up a hierarchy within your Project. The will be displayed in the foldtext and cannot contain "=". There can be no space character directly on either side of the =. The {projpath} is the path in which the files listed in the Project's fold will be found. If the path is a relative path, then the plugin constructs the whole path from the Project's parent, grandparent, etc., all the way up the hierarchy. An outermost project_entry must have an absolute path. See the |project-inheritance| example below. CD= provides the directory that Vim will change to when you select a file in that fold (using |:cd|). This allows you, for example, to enter |:make| to use the local Makefile. A CD=. means that Vim will make {projpath} or its inherited equivalent the current working directory. When CD is omitted, the directory is not changed. There can be no space on either side of the =. The value of CD can also be a relative path from a parent's CD. See the |project-inheritance| example below. in= and out= provide the means to run arbitrary Vim scripts whenever you enter or leave a file's buffer (see the |BufEnter| and |BufLeave| autocommand events). The idea is to have a Vim script that sets up or tears down the environment for the Project like this: in.vim: > let $PROJECT_HOME='~/my_project' " Put the compiler in $PATH if $PATH !~ '/path/to/my/compiler' let $PATH=$PATH.':/path/to/my/compiler' endif out.vim: > " Remove compiler from $PATH if $PATH =~ '/path/to/my/compiler' let $PATH=substitute($PATH, ':/path/to/my/compiler', '', 'g') endif Then you can use :make with the proper environment depending on what file you are currently editing. If the path to the script is relative, then it is relative from {projpath}. These directives are inherited by Subprojects unless the Subproject specifies its own. filter= specifies a |glob()| file pattern. It is used to regenerate the list of files in a Project fold when using the \r (r) map in the Project Window. The filter value must be in quotes because it can contain multiple file patterns. If filter is omitted, then the * pattern is used. There can be no space on either side of the =. A Subproject will inherit the filter of its parent unless it specifies its own filter. flags= provides the means to enable/disable features for a particular fold. The general mnemonic scheme is for lower case to turn something off and upper case to turn something on. {flag} can contain any of the following characters: l Turn off recursion for this fold for \L. Subfolds are also blocked from the recursion. r Turn off refresh. When present, do not refresh this fold when \r or \R is used. This does not affect subfolds. S Turn on sorting for refresh and create. s Turn off sorting for refresh and create. T Turn on top gravity. Forces folds to the top of the current fold when refreshing. It has the same affect as the 'T' flag in g:proj_flags, but controls the feature on a per-fold basis. t Turn off top gravity. Forces folds to the bottom of the current fold when refreshing. w Turn off recursion for this fold for \W. Subfolds are also blocked from the recursion. Flags are not inherited by Subprojects. Any text outside a fold is ignored. ============================================================================== INHERITANCE *project-inheritance* It's best to show inheritance by comparing these two Project Files: > Parent=~/my_project CD=. filter="Make* *.mk" flags=r { Child1=c_code { } Child2=include CD=. filter="*.h" { } } Child1's path is "~/my_project/c_code" because ~/my_project is inherited. It also inherits the CD from Parent. Since Parent has CD=., the Parent's cwd is "~/my_project". Child1 therefore inherits a CD of "~/my_project". Finally, Child1 inherits the filter from Parent. The flags are not inherited. Child2 only inherits the "~/my_project" from Parent. Thus, the example above is exactly equivalent to this: > Parent=~/my_project CD=. filter="Make* *.mk" flags=r { Child1=~/my_project/c_code CD=~/my_project filter="Make* *.mk" { } Child2=~/my_project/include CD=~/my_project/include filter="*.h" { } } (For a real Project, Child1 would not want to inherit its parent's filter, but this example shows the concept.) You can always enter \i to display what the cursor's project inherits. ============================================================================== MAPPINGS *project-mappings* \r Refreshes the Project fold that the cursor is in by placing in the fold all the files that match the filter. The Project is refreshed using an indent of one space for every foldlevel in the hierarchy. Note that this mapping is actually r, and the default of || is \. This does not work for Projects using |netwr|. \R Executes \r recursively in the current fold and all folds below. This does not work for Projects using |netwr|. \c Creates a Project fold entry. It asks for the description, the path to the files, and the filename |glob()| pattern. From this information, it will create the Project Entry below the cursor. Note that \c does not ask for the value of CD, but uses a default of "CD=.". This does not work for Projects using |netwr|. Select a file to open in the |CTRL-W_p| window or in a new window. If the cursor is on a fold, open or close it. \s Same as but horizontally split the target window. s is provided for those terminals that don't recognize . \o Same as but ensure that the opened file is the only other window. o is provided for those terminals that don't recognize . \v Same as but only display the file--the cursor stays in the Project Window. <2-LeftMouse> (Double-click) If on a closed fold, open it. If on an open fold boundary, close it. If on a filename, open the file in the |CTRL-W_p| window or in a new window. Same as . Same as . Increase the width of the Project Window by g:proj_window_increment or toggle between a width of g:proj_window_width + g:proj_window_increment and g:proj_window_width. Whether you toggle or monotonically increase the width is determined by the 't' flag of the g:proj_flags variable (see |project-flags|). Note that a Right Mouse click will not automatically place the cursor in the Project Window if it is in a different window. The window will go back to the g:proj_window_width width when you leave the window. Same as \ Move the text or fold under the cursor up one row. This may not work in a terminal because the terminal is unaware of this key combination. is provided for those terminals that don't recognize . \ Move the text or fold under the cursor down one row. This may not work in a terminal because the terminal is unaware of this key combination. is provided for those terminals that don't recognize . \i Show in the status line the completely resolved and inherited parameters for the fold the cursor is in. This is intended for debugging your relative path and inherited parameters for manually entered Projects. \1 - \9 Run the command specified in g:proj_run{x} where {x} is the number of the key. See the documentation of g:proj_run1 below. \f1-\f9 Run the command specified in g:proj_run_fold{x} where {x} is the number of the key. The command is run on the files at the current fold level. \F1-\F9 Run the command specified in g:proj_run_fold{x} where {x} is the number of the key. The command is run on the files at the current fold level and all Subprojects. \0 Display the commands that are defined for \1 through \9. \l Load all the files in the current Project level into Vim. \L Load all the files in the current Project and all Subprojects into Vim. Use this mapping with caution--I wouldn't suggest using \L to load a Project with thousands of files. (BTW, my Project file has more than 2,800 files in it!) \w Wipe all the files in the current Project level from Vim. (If files are modified, they will be saved first.) \W Wipe all the files in the current Project and all Subprojects from Vim. (If files are modified, they will be saved first.) \g Grep all the files in the current Project level. \G Grep all the files in the current Project level and all Subprojects. Note that the Project Plugin remaps :help because the Help Window and the Project Window get into a fight over placement. The mapping avoids the problem. ============================================================================== SETTINGS *project-settings* You can set these variables in your vimrc file before the plugin is loaded to change its default behavior g:proj_window_width The width of the Project Window that the plugin attempts to maintain. Default: 24 The Project Plugin is not always successful in keeping the window where I want it with the size specified here, but it does a decent job. g:proj_window_increment The increment by which to increase the width of the Project Window when pressing or clicking the . Default: 100 (See |project-mappings|.) *project-flags* g:proj_flags Default: "imst" Various flags to control the behavior of the Project Plugin. This variable can contain any of the following character flags. i When present, display the filename and the current working directory in the command line when a file is selected for opening. l When present, the Project Plugin will use the |:lcd| command rather than |:cd| to change directories when you select a file to open. L Similar to l, but install a BufEnter/Leave |:autocommand| to ensure that the current working directory is changed to the one specified in the fold CD specification whenever that buffer is active. (|:lcd| only changes the CWD for a window, not a buffer.) m Turn on mapping of the |CTRL-W_o| and |CTRL-W_CTRL_O| normal mode commands to make the current buffer the only visible buffer, but keep the Project Window visible, too. s When present, the Project Plugin will use syntax highlighting in the Project Window. S Turn on sorting for refresh and create. t When present, toggle the size of the window rather than just increase the size when pressing or right-clicking. See the entry for in |project-mappings|. T When present, put Subproject folds at the top of the fold when refreshing. g:proj_run1 ... g:proj_run9 Contains a Vim command to execute on the file. The characters %s are replaced with the absolute path of the filename. See the mappings of \1 to \9 above. For example, gvim will be launched on the file under the cursor when you enter \3 if the following is in your vimrc file: > let g:proj_run3='silent !gvim %s' < Here are a few other examples: > let g:proj_run1='!p4 edit %s' let g:proj_run2='!p4 add %s' let g:proj_run4='echo "Viewing %s"|sil !xterm -e less %s &' < g:proj_run_fold1 ... g:proj_run_fold9 Contains a Vim command to execute on the files in a fold. See the mappings of \f1 to \f9 and \F1 to \F9 above. The characters %s are replaced with the absolute path of the filenames, but multiple filenames can be handled in two ways. The first (default) way is to have %s replaced with all the filenames, and the command is run once. The second is to have the command run for each of the filenames (%s is replaced with one filename at a time). To select the second behavior, put an '*' character at the beginning of the g:proj_run_fold{x} variable. (The '*' is stripped before the command is run.) For example, note the difference between the following: > let g:proj_run_fold3='*echo "%s"' let g:proj_run_fold4='echo "%s"' ============================================================================== PROJECT EXAMPLE FILE *project-example* Here is an example ~/.vimprojects file: > 1 My Project=~/c/project CD=. in=in.vim out=out.vim flags=r { 2 Makefile 3 in.vim 4 out.vim 5 GUI Files=. filter="gui*.c gui*.h" { 6 gui_window.c 7 gui_dialog.c 8 gui_list.c 9 gui.h # Header file 10 } 11 Database Files=. filter="data*.c data*.h" { 12 data_read.c 13 data_write.c 14 data.h 15 } 16 OS-Specific Files { 17 Win32=. filter="os_win32*.c os_win32*.h" { 18 os_win32_gui.c 19 os_win32_io.c 20 } 21 Unix=. filter="os_unix*.c os_unix*.h" { 22 os_unix_gui.c 23 os_unix_io.c 24 } 25 } 26 } (Don't type in the line numbers, of course.) ============================================================================== TIPS ON USING PROJECT PLUGIN *project-tips* 1. You can create a Project Entry by entering this: > Label=~/wherever CD=. filter="*.c *.h" { } < Then you can put the cursor in the fold and press \r. The script will fill in the files (C files in this case) from this directory for you. This is equivalent to \c without any dialogs. 2. You can edit the Project File at any time to add, remove, or reorder files in the Project list. 3. If the Project Window ever gets closed, you can just enter > :Project < to bring it back again. If you have the 'm' flag set in g:proj_flags, then you get the Project Window to show up again by pressing |CTRL-W_o|. This, of course, will close any other windows that may be open that the cursor is not in. 4. Adding files to a Project is very easy. To add, for example, the 'more.c' file to the Project, just insert the filename in the Project Entry then hit on it. 5. When |quickfix| loads files, it is not equivalent to pressing on a filename, so the directory will not be changed and the scripts will not be run. (If I could make this otherwise, I would.) The solution is to use the \L key to load all of the files in the Project before running quickfix. 6. If the Project window gets a bit cluttered with folds partially open/closed, you can press |zM| to close everything and tidy it up. 7. For advanced users, I am exporting the function Project_GetAllFnames() which returns all the filenames within a fold and optionally all its Subprojects. See the code for examples on how to use this. ============================================================================== THANKS The following people have sent me patches to help with the Project Plugin development: Tomas Zellerin Lawrence Kesteloot vim:ts=8 sw=8 noexpandtab tw=78 ft=help: plugin/project.vim0100644000425700003600000013264107363605417013705 0ustar aricalchemy"============================================================================= " File: project.vim " Author: Aric Blumer (Aric.Blumer@marconi.com) " Last Change: Thu 18 Oct 2001 01:02:07 PM EDT " Version: 1.0pre4 "============================================================================= " See documentation in accompanying help file if exists('loaded_project') || &cp finish endif let loaded_project=1 function! s:Project(filename) " <<< " Initialization <<< if exists("g:proj_running") let filename=bufname(g:proj_running) else if strlen(a:filename) == 0 " Default project filename let filename ='~/.vimprojects' else let filename = a:filename endif endif if !exists('g:proj_window_width') " Default project window width let g:proj_window_width=24 endif if !exists('g:proj_window_increment') " Project Window width increment let g:proj_window_increment=100 endif if !exists('g:proj_flags') " Project default flags let g:proj_flags='imst' endif " Open the Project Window if !exists("g:proj_running") || (bufwinnr(g:proj_running) == -1) exec 'silent vertical new '.filename silent! wincmd H exec 'vertical resize '.g:proj_window_width let b:maxwinheight = winheight('.') else silent! 99wincmd h return endif " Process the flags let b:proj_cd_cmd='cd' if match(g:proj_flags, '\Cl') != -1 let b:proj_cd_cmd = 'lcd' endif ">>>------------------------------------------------------------------ " ProjFoldText() <<< " The foldtext function for displaying just the description. function! ProjFoldText() let line=substitute(getline(v:foldstart),'^[ \t#]*\([^=]*\).*', '\1', '') let line=strpart(' ', 0, (v:foldlevel - 1)).substitute(line,'\s*{\+\s*', '', '') return line endfunction ">>>------------------------------------------------------------------ " s:DoSetup() <<< " Ensure everything is set up function! s:DoSetup() setlocal foldmethod=marker setlocal foldmarker={,} setlocal commentstring=%s setlocal foldcolumn=0 setlocal nonumber setlocal noswapfile setlocal shiftwidth=1 setlocal foldtext=ProjFoldText() setlocal nobuflisted setlocal nowrap endfunction ">>>------------------------------------------------------------------ call s:DoSetup() " Syntax Stuff <<< if match(g:proj_flags, '\Cs')!=-1 && has('syntax') && exists('g:syntax_on') && !has('syntax_items') syntax match projectDescriptionDir '^\s*\S.\{-}=\s*\(\f\|:\)\+' contains=projectDescription,projectWhiteError syntax match projectDescription '\S[^=]\{-}\S='he=e-1,me=e-1 contained nextgroup=projectDirectory,projectWhiteError syntax match projectDescription '{\|}' syntax match projectDirectory '=\(\f\|:\)\+' contained syntax match projectScriptinout '\>>------------------------------------------------------------------ " s:SortR(start, end) <<< " Sort lines. SortR() is called recursively. " from ":help eval-examples" by Robert Webb, slightly modified function! s:SortR(start, end) if (a:start >= a:end) return endif let partition = a:start - 1 let middle = partition let partStr = getline((a:start + a:end) / 2) let i = a:start while (i <= a:end) let str = getline(i) if str < partStr let result = -1 elseif str > partStr let result = 1 else let result = 0 endif if (result <= 0) let partition = partition + 1 if (result == 0) let middle = partition endif if (i != partition) let str2 = getline(partition) call setline(i, str2) call setline(partition, str) endif endif let i = i + 1 endwhile if (middle != partition) let str = getline(middle) let str2 = getline(partition) call setline(middle, str2) call setline(partition, str) endif call s:SortR(a:start, partition - 1) call s:SortR(partition + 1, a:end) endfunc ">>> " s:IsAbsolutePath(path) <<< " Returns true if filename has an absolute path. function! s:IsAbsolutePath(path) if a:path[0] == '/' || a:path[0] == '~' || a:path[0] == '\\' || a:path[1] == ':' return 1 endif if a:path =~ '^ftp:' || a:path =~ '^rcp:' || a:path =~ '^scp:' || a:path =~ '^http:' return 2 endif return 0; endfunction " >>> " s:DoSetupAndSplit() <<< " Call DoSetup to ensure the settings are correct. Split to the next " file. function! s:DoSetupAndSplit() " Ensure that all the settings are right call s:DoSetup() " Determine if there is a CTRL_W-p window let n = winnr() silent! wincmd p if n == winnr() silent! wincmd l endif if n == winnr() " If n == winnr(), then there is no CTRL_W-p window " So we have to create a new one exec 'silent vertical new '.bufname('#') " Go back to the Project Window and ensire it is the right width wincmd p silent! wincmd H exec 'vertical resize '.g:proj_window_width wincmd p endif endfunction ">>>------------------------------------------------------------------ " s:RecursivelyConstructDirectives(lineno) <<< " Construct the inherited directives function! s:RecursivelyConstructDirectives(lineno) let lineno=s:FindFoldTop(a:lineno) let foldlineno = lineno let foldlev=foldlevel(lineno) if foldlev > 1 " Go to parent fold while foldlevel(lineno) >= foldlev let lineno = lineno - 1 endwhile let parent_infoline = s:RecursivelyConstructDirectives(lineno) let parent_home = substitute(parent_infoline, '^[^=]*=\(\(\f\|:\)\+\).*', '\1', '') let parent_c_d = substitute(parent_infoline, '.*\>>------------------------------------------------------------------ " s:DoSetupAndSplit_au() <<< " Same as above but ensure that the Project window is the current " window. Only called from an autocommand function! s:DoSetupAndSplit_au() call s:DoSetupAndSplit() silent! wincmd p endfunction ">>>------------------------------------------------------------------ " s:OpenEntry(line, precmd, editcmd, buffcmd) <<< " Get the filename under the cursor, and open a window with it. function! s:OpenEntry(line, precmd, editcmd, buffcmd) let savelz=&lz set lz silent exec a:precmd " Ensure the window is the right width exec 'vertical resize '.g:proj_window_width if foldlevel(a:line) == 0 " If we're outside a fold, do nothing return 0 endif " Get rid of comments let fname=substitute(getline(a:line), '#.*', '', '') " Get rid of leading whitespace let fname=substitute(fname, '^\s*\(.*\)', '\1', '') if strlen(fname) == 0 " The line is blank. Do nothing. return 0 endif let infoline = s:RecursivelyConstructDirectives(a:line) " Extract the home directory of this fold let home=substitute(infoline, '^[^=]*=\(\(\f\|:\)\+\).*', '\1', '').'/' "Save the cd command let cd_cmd = b:proj_cd_cmd call s:DoSetupAndSplit() " If it is an absolute path, don't prepend home if !s:IsAbsolutePath(fname) let fname=home.fname endif if bufnr(fname) == -1 " The buffer doesn't exist. Execute the editcmd on the filename to " load the buffer. if s:IsAbsolutePath(fname) == 2 exec a:editcmd.' '.fname else silent exec a:editcmd.' '.fname endif else " The buffer does exist. Just use the buffcmd on the buffer to " display it. if s:IsAbsolutePath(fname) == 2 exec a:buffcmd.' '.fname else silent exec a:buffcmd.' '.fname endif endif " Extract any CD information if infoline =~ 'CD=' let c_d = substitute(infoline, '.*\>>------------------------------------------------------------------ " s:DoFoldOrOpenEntry(cmd0, cmd1, cmd2) <<< " Used for double clicking. If the mouse is on a fold, open/close it. If " not, try to open the file. function! s:DoFoldOrOpenEntry(cmd0, cmd1, cmd2) if getline('.')=~'{\|}' || foldclosed('.') != -1 normal! za else call s:OpenEntry(line('.'), a:cmd0, a:cmd1, a:cmd2) endif endfunction ">>>------------------------------------------------------------------ " s:VimDirListing(filter, padding, sort) <<< function! s:VimDirListing(filter, padding, sort) let end = 0 let files='' let filter = a:filter " Chop up the filter " Apparently glob() cannot take something like this: glob('*.c *.h') let while_var = 1 while while_var let end = stridx(filter, ' ') if end == -1 let end = strlen(filter) let while_var = 0 endif let single=glob(strpart(filter, 0, end)) if strlen(single) != 0 let files = files.single."\n" endif let filter = strpart(filter, end + 1) endwhile " files now contains a list of everything in the directory. We need to " weed out the directories. put =files let line=getline('.') let startline=line('.') " This 'while' loop looks at each directory entry and deletes the line " to the black hole register if it is a directory name. When we reach " a fold boundary marked by { or }, exit the loop while line !~ '\({\|}\)' if isdirectory(glob(line)) d _ else " It is not a directory, so prepend the padding " (Skip comments) if line !~ '^\s*#' call setline('.', a:padding.line) endif normal! j endif " Get the next line let line=getline('.') endwhile if a:sort call s:SortR(startline, line('.')-1) endif endfunction ">>>------------------------------------------------------------------ " s:DoEntryFromDir(line, name, absolute_dir, dir, c_d, filter_directive, filter, foldlev, sort) <<< " Places a fold in the buffer consisting of files from the given " directory. The indention is controlled by foldlev. function! s:DoEntryFromDir(line, name, absolute_dir, dir, c_d, filter_directive, filter, foldlev, sort) " Calculate the number of spaces for the indent let spaces=strpart(' ', 0, a:foldlev) " Put in the fold with two append() call append(a:line, spaces.'}') if strlen(a:c_d) > 0 let c_d='CD='.a:c_d.' ' else let c_d='' endif if strlen(a:filter_directive) > 0 let c_d=c_d.'filter="'.a:filter_directive.'" ' endif call append(a:line, spaces.a:name.'='.a:dir.' '.c_d.'{') " Move down one line and open the fold normal! jzo " Save the current working directory let cwd=getcwd() " Change to the dir specified exec 'cd '.a:absolute_dir " Get the files from Vim glob() call s:VimDirListing(a:filter, spaces.' ', a:sort) " Go to the top of the fold and close it normal! [zzc " Restore the previous directory. This can be simplified with a :cd - exec 'cd '.cwd endfunction ">>>------------------------------------------------------------------ " s:CreateEntriesFromDir() <<< " Prompts user for information and then calls s:DoEntryFromDir() function! s:CreateEntriesFromDir() " Save a mark for the current cursor position normal! mk let line=line('.') let name = inputdialog('Enter the Name of the Entry: ') if strlen(name) == 0 return endif let foldlev=foldlevel(line) if (foldclosed(line) != -1) || (getline(line) =~ '}') let foldlev=foldlev - 1 endif if foldlev <= 0 let absolute = 'Absolute ' else let absolute = '' endif let home="" let filter="*" if has('browse') && !has('win32') " Note that browse() is inconsistent: On Win32 you can't select a " directory, and it gives you a relative path. let dir = browse(0, 'Enter the '.absolute.'Directory to Load: ', '', '') else let dir = inputdialog('Enter the '.absolute.'Directory to Load: ', '') endif if (dir[strlen(dir)-1] == '/') || (dir[strlen(dir)-1] == '\\') let dir=strpart(dir, 0, strlen(dir)-1) endif if (foldlev > 0) " Cursor is now on the parent's fold let parent_directive=s:RecursivelyConstructDirectives(line('.')) let filter = substitute(parent_directive, '.*\ /dev/null' else call confirm('"'.home.dir.'" is not a valid directory.', "&OK", 1) return endif endif let c_d = inputdialog('Enter the CD parameter: ', '') let filter_directive = inputdialog('Enter the File Filter: ', '') if strlen(filter_directive) != 0 let filter = filter_directive endif " If I'm on a closed fold, go to the bottom of it if foldclosedend(line) != -1 let line = foldclosedend(line) endif let foldlev = foldlevel(line) " If we're at the end of a fold . . . if getline(line) =~ '}' " . . . decrease the indentation by 1. let foldlev = foldlev - 1 endif " Do the work call s:DoEntryFromDir(line, name, home.dir, dir, c_d, filter_directive, filter, foldlev, 0) " Restore the cursor position normal! `k endfunction ">>>------------------------------------------------------------------ " s:RefreshEntriesFromDir(recursive) <<< " Finds metadata at the top of the fold, and then replaces all files " with the contents of the directory. Works recursively if recursive is " 1. function! s:RefreshEntriesFromDir(recursive) " Open the fold. The ]z[z guarantees that we are on the first line of " the fold. The [z is not sufficient because it can jump to the " beginning of the previous fold if the cursor is on the first line of " a fold already. normal! zo]z[z let just_a_fold=0 let infoline = s:RecursivelyConstructDirectives(line('.')) let immediate_infoline = getline('.') " Extract the home directory of the fold let dir = substitute(infoline, '[^=]*=\(\(\f\|:\)*\).*', '\1', '') if strlen(substitute(immediate_infoline, '[^=]*=\(\(\f\|:\)*\).*', '\1', '')) == strlen(immediate_infoline) let just_a_fold = 1 endif if strlen(dir) == strlen(infoline) " No Match. This means that this is just a label with no " directory entry. if a:recursive == 0 " We're done--nothing to do return endif " Mark that it is just a fold, so later we don't delete filenames " that aren't there. let just_a_fold = 1 endif if just_a_fold == 0 " Extract the filter between quotes (we don't care what CD is). let filter = substitute(infoline, '.*\>>------------------------------------------------------------------ " s:MoveUp() <<< " Moves the entity under the cursor up a line. function! s:MoveUp() let lineno=line('.') if lineno == 1 return endif let fc=foldclosed('.') let a_reg=@a if lineno == line('$') normal! "add"aP else normal! "addk"aP endif let @a=a_reg if fc != -1 normal! zc endif endfunction ">>>------------------------------------------------------------------ " s:MoveDown() <<< " Moves the entity under the cursor down a line. function! s:MoveDown() let fc=foldclosed('.') let a_reg=@a normal! "add"ap let @a=a_reg if fc != -1 if foldclosed('.') == -1 normal! zc endif endif endfunction " >>> " s:DisplayInfo() <<< " Displays filename and current working directory when i (info) is in " the flags. function! s:DisplayInfo() if match(g:proj_flags, '\Ci') != -1 echo 'file: '.expand('%').', cwd: '.getcwd().', lines: '.line('$') endif endfunction " >>> " s:SetupAutoCommand(cwd) <<< " Sets up an autocommand to ensure that the cwd is set to the one " desired for the fold regardless. :lcd only does this on a per-window " basis, not a per-buffer basis. function! s:SetupAutoCommand(cwd) if !exists("b:proj_has_autocommand") let b:proj_cwd_save = getcwd() let b:proj_has_autocommand = 1 let bufname=substitute(expand('%:p', 0), '\\', '/', 'g') exec 'au BufEnter '.bufname.' let b:proj_cwd_save=getcwd() | cd '.a:cwd exec 'au BufLeave '.bufname.' exec "cd ".b:proj_cwd_save' endif endfunction ">>> " s:SetupScriptAutoCommand(inout, script) <<< " Sets up an autocommand to run the scriptin script. function! s:SetupScriptAutoCommand(inout, script) if !exists("b:proj_has_".a:inout) let b:proj_has_{a:inout} = 1 exec 'au '.a:inout.' '.substitute(expand('%:p', 0), '\\', '/', 'g').' source '.a:script endif endfunction " >>> " s:DoEnsurePlacementSize_au() <<< " Ensure that the Project window is on the left of the window and has " the correct size. Only called from an autocommand function! s:DoEnsurePlacementSize_au() if exists("g:proj_doinghelp") if g:proj_doinghelp > 0 let g:proj_doinghelp = g:proj_doinghelp - 1 return endif unlet g:proj_doinghelp return endif if (winnr() != 1) || (winheight('.') != b:maxwinheight) " This if statement avoids the flicker when wincmd H is executed " (set lz doesn't help with this flicker) silent! wincmd H endif exec 'vertical resize ' . g:proj_window_width endfunction ">>>------------------------------------------------------------------ " s:Spawn(number) <<< " Spawn an external command on the file function! s:Spawn(number) if exists("g:proj_run".a:number) let fname=getline('.') if fname!~'{\|}' let fname=substitute(fname, '#.*', '', '') let fname=substitute(fname, '^\s*\(.*\)\s*', '\1', '') if strlen(fname) == 0 " The line is blank. Do nothing. return endif let parent_infoline = s:RecursivelyConstructDirectives(line('.')) let parent_home = substitute(parent_infoline, '^[^=]*=\(\(\f\|:\)\+\).*', '\1', '') exec substitute(g:proj_run{a:number}, '%s', parent_home.'/'.fname, 'g') endif endif endfunction ">>>------------------------------------------------------------------ " s:ListSpawn(varnamesegment) <<< " List external commands function! s:ListSpawn(varnamesegment) let number = 1 while number < 10 if exists("g:proj_run".a:varnamesegment.number) echohl LineNr | echo number.':' | echohl None | echon ' '.g:proj_run{a:varnamesegment}{number} else echohl LineNr | echo number.':' | echohl None endif let number=number + 1 endwhile endfunction ">>>------------------------------------------------------------------ " s:FindFoldTop(line) <<< " Return the line number of the directive line function! s:FindFoldTop(line) let lineno=a:line while getline(lineno) !~ '{' && lineno > 1 if getline(lineno) =~ '}' let lineno=s:FindFoldTop(lineno - 1) endif let lineno = lineno - 1 endwhile return lineno endfunction ">>>------------------------------------------------------------------ " s:FindFoldBottom(line) <<< " Return the line number of the directive line function! s:FindFoldBottom(line) let lineno=a:line if getline(lineno) =~ '{' let lineno=lineno + 1 endif while getline(lineno) !~ '}' && lineno < line('$') if getline(lineno) =~ '{' let lineno=s:FindFoldBottom(lineno) endif let lineno = lineno + 1 endwhile return lineno endfunction ">>>------------------------------------------------------------------ " s:LoadAll(recurse, line) <<< " Load all files in a project function! s:LoadAll(recurse, line) let lineno=s:FindFoldTop(a:line) + 1 while getline(lineno) !~ '}' if getline(lineno) =~ '{' if a:recurse let flags = substitute(getline(lineno), '.*\>>------------------------------------------------------------------ " s:WipeAll(recurse, line) <<< " Wipe all files in a project function! s:WipeAll(recurse, line) let lineno=s:FindFoldTop(a:line) + 1 let home=s:RecursivelyConstructDirectives(lineno) let home=substitute(home, '^[^=]*=\(\(\f\|:\)\+\).*', '\1', '') if strlen(home) != 0 let home=home.'/' endif while getline(lineno) !~ '}' if getline(lineno) =~ '{' if a:recurse let flags = substitute(getline(lineno), '.*\>>------------------------------------------------------------------ " s:GrepAll(recurse, lineno, pattern) <<< " Grep all files in a project, optionally recursively function! s:GrepAll(recurse, lineno, pattern) if strlen(a:pattern) == 0 let pattern=input("GREP Pattern: ") else let pattern=a:pattern endif let fnames=Project_GetAllFnames(a:recurse, a:lineno, ' ') cclose " Make sure grep window is closed call s:DoSetupAndSplit() silent! exec 'silent! grep '.pattern.' '.fnames copen endfunction ">>> " Project_GetAllFnames(recurse, lineno, separator) <<< " Grep all files in a project, optionally recursively function! Project_GetAllFnames(recurse, lineno, separator) let home=s:RecursivelyConstructDirectives(a:lineno) let home=substitute(home, '^[^=]*=\(\(\f\|:\)\+\).*', '\1', '') if strlen(home) != 0 let home=home.'/' endif let lineno=s:FindFoldTop(a:lineno) + 1 let curline=getline(lineno) let retval="" while curline !~ '}' && curline < line('$') if curline =~ '{' if a:recurse if retval != "" let retval=retval.a:separator.Project_GetAllFnames(a:recurse+1, lineno, a:separator) else let retval=Project_GetAllFnames(a:recurse+1, lineno, a:separator) endif endif let lineno = s:FindFoldBottom(lineno) else let fname=substitute(curline, '#.*', '', '') let fname=substitute(fname, '^\s*\(.*\)', '\1', '') if strlen(fname) != strlen(curline) && strlen(fname) > 0 if !s:IsAbsolutePath(fname) let fname=home.fname endif if retval != "" let retval=retval.a:separator.fname else let retval=fname endif endif endif let lineno=lineno + 1 let curline=getline(lineno) endwhile return retval endfunction ">>>------------------------------------------------------------------ " s:SpawnAll(recurse, number) <<< " Spawn an external command on the files of a project function! s:SpawnAll(recurse, number) if exists("g:proj_run_fold".a:number) if g:proj_run_fold{a:number}[0] == '*' let fnames=Project_GetAllFnames(a:recurse, line('.'), "\010")."\010" while strlen(fnames) > 0 let fname = substitute(fnames, '\(\(\f\|:\)*\).*', '\1', '') let fnames = substitute(fnames, '\(\f\|:\)*.\(.*\)', '\2', '') exec substitute(strpart(g:proj_run_fold{a:number}, 1), '%s', fname, 'g') endwhile else let fnames=Project_GetAllFnames(a:recurse, line('.'), ' ') exec substitute(g:proj_run_fold{a:number}, '%s', fnames, 'g') endif endif endfunction ">>>------------------------------------------------------------------ if !exists("g:proj_running") " Mappings <<< nnoremap \|:call DoFoldOrOpenEntry('', 'e', 'bu') nnoremap \|:call DoFoldOrOpenEntry('', 'sp', 'sbu') nnoremap \|:call DoFoldOrOpenEntry('silent! only', 'e', 'bu') nmap s nmap o nmap i :echo RecursivelyConstructDirectives(line('.')) nmap p nmap v nmap l \|:call LoadAll(0, line('.')) nmap L \|:call LoadAll(1, line('.')) nmap w \|:silent call WipeAll(0, line('.')) nmap W \|:silent call WipeAll(1, line('.')) nmap g \|:call GrepAll(0, line('.'), "") nmap G \|:call GrepAll(1, line('.'), "") nnoremap <2-LeftMouse> \|:call DoFoldOrOpenEntry('', 'e', 'bu') nnoremap \|:call DoFoldOrOpenEntry('', 'sp', 'sbu') nnoremap nnoremap nmap nnoremap nnoremap <3-LeftMouse> \| nmap nmap <2-RightMouse> nmap <3-RightMouse> nmap <4-RightMouse> nnoremap \|:silent exec 'vertical resize '.(match(g:proj_flags, '\Ct')!=-1 && winwidth('.') > g:proj_window_width?(g:proj_window_width):(winwidth('.') + g:proj_window_increment)) nnoremap \|:silent call MoveUp() nnoremap \|:silent call MoveDown() nmap nmap let k=1 while k < 10 exec 'nmap '.k.' \|:call Spawn('.k.')' exec 'nmap f'.k.' \|:call SpawnAll(0, '.k.')' exec 'nmap F'.k.' \|:call SpawnAll(1, '.k.')' let k=k+1 endwhile nmap 0 \|:call ListSpawn("") nmap f0 \|:call ListSpawn("_fold") nmap F0 \|:call ListSpawn("_fold") nnoremap c :call CreateEntriesFromDir() nnoremap r :call RefreshEntriesFromDir(0) nnoremap R :call RefreshEntriesFromDir(1) " The :help command stomps on the Project Window. Try to avoid that. " This is not perfect, but it is alot better than without the " mappings. cnoremap help let g:proj_doinghelp = 1:help nnoremap :let g:proj_doinghelp = 1 " This is to avoid changing the buffer, but it is not fool-proof. nnoremap \| if match(g:proj_flags, '\Cm') != -1 nnoremap o :let lzsave=&lz:set lzo:Project:silent! wincmd p:let &lz=lzsave:unlet lzsave nmap o endif " >>> " Autocommands <<< " Autocommands to clean up if we do a buffer wipe " These don't work unless we substitute \ for / for Windows let bufname=substitute(expand('%:p', 0), '\\', '/', 'g') exec 'au BufWipeout '.bufname.' au! * '.bufname exec 'au BufWipeout '.bufname.' unlet g:proj_running' " Autocommands to keep the window the specified size exec 'au WinEnter,WinLeave '.bufname.' call s:DoEnsurePlacementSize_au()' exec 'au BufWinEnter '.bufname.' call s:DoSetupAndSplit_au()' " >>> setlocal buflisted let g:proj_running = bufnr(bufname) if g:proj_running == -1 call confirm('Project/Vim error. Please Enter :Project again and report this bug.', "&OK", 1) unlet g:proj_running endif setlocal nobuflisted endif endfunction " >>> if !exists(':Project') command -nargs=? -complete=file Project call Project('') endif finish " vim600: set foldmethod=marker foldmarker=<<<,>>> foldlevel=1: