From b25edc0a0fe217e9a3fd4cc5cd07780cbe32da21 Mon Sep 17 00:00:00 2001 From: Austen Adler Date: Thu, 18 Feb 2016 23:58:35 -0500 Subject: [PATCH] Added plugin --- doc/project.txt | 710 ++++++++++++++++++++++++ plugin/project.vim | 1293 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 2003 insertions(+) create mode 100644 doc/project.txt create mode 100644 plugin/project.vim diff --git a/doc/project.txt b/doc/project.txt new file mode 100644 index 0000000..8f85c23 --- /dev/null +++ b/doc/project.txt @@ -0,0 +1,710 @@ +*project.txt* Plugin for managing multiple projects with multiple sources + For Vim version 6.x and Vim version 7.x. + Last Change: Fri 13 Oct 2006 10:20:13 AM EDT + + + By Aric Blumer + aricvim email-at-sign charter.net + + *project* *project-plugin* + Contents: + + Commands...................|project-invoking| + Inheritance.............|project-inheritance| + Mappings...................|project-mappings| + Adding Mappings.....|project-adding-mappings| + Settings...................|project-settings| + Example File................|project-example| + Tips...........................|project-tips| + + +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 Vim +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, and it may contain environment variables. 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. {projpath} may contain spaces, but they must be escaped like +normal Vim escapes. Here are two examples of the same directory: +> + Example=/my/directory/with\ spaces { + } + Example="/my/directory/with spaces" { + } + +I recommend this for Windows®: > + + Example="c:\My Documents" { + } + +But Vim is smart enough to do this, too: > + + Example=c:\My\ Documents { + } + +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. This directive is ignored for |netrw| +projects. Spaces are allowed in the path as for {projpath}. + +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. For use with |netrw| projects, the +paths specified for in= and out= must be absolute and local. + +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: + + flag Description ~ + + 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 subfold recursion. + + 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* + +Map Action ~ + +\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. + + You may place a "# pragma keep" (without the quotes) at the end of a + line, and the file entry on that line will not be removed when you + refresh. This is useful, for example, when you have . as an entry so + you can easily browse the directory. + + Note that this mapping is actually r, and the default of + || is \. + + This does not work for Projects using |netrw|. + +\R Executes \r recursively in the current fold and all folds below. + This does not work for Projects using |netrw|. + +\c Creates a Project fold entry. It asks for the description, the path + to the files, the CD parameter, and the filename |glob()| pattern. + From this information, it will create the Project Entry below the + cursor. + + This does not work for Projects using |netrw|. + +\C Creates a Project fold entry like \c, but recursively includes all the + subdirectories. + + + 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 + . + +\S + Load all files in a project by doing horizontal splits. + + +\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. + +\I Show in the status line the completely resolved filename. Uses the + Project_GetFname(line('.')) function. + +\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 + Project level. See the |project-settings| 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 + Project level and all Subprojects. See the |project-settings| below. + +\0 Display the commands that are defined for \1 through \9. + +\f0 Display the commands that are defined for \f1 through \f9 and \F1 + through \F0. Same as \F0. + +\l Load all the files in the current Project level into Vim. While files + are being loaded, you may press any key to stop. + +\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 5,300 files in it!) While files are being loaded, you may press + any key to stop. + +\w Wipe all the files in the current Project level from Vim. (If files + are modified, they will be saved first.) While files are being wiped, + you may press any key to stop. + +\W Wipe all the files in the current Project and all Subprojects from + Vim. (If files are modified, they will be saved first.) While files + are being wiped, you may press any key to stop. + +\g Grep all the files in the current Project level. + +\G Grep all the files in the current Project level and all Subprojects. + +\e Set up the Environment for the Project File as though you had selected + it with . This allows you to do a \e and a :make without + having to open any files in the project. + +\E Explore (using |file-explorer|) the directory of the project the + cursor is in. Does not work with netrw. + + When the 'g' flag is present in g:proj_flags (see |project-flags|) + this key toggles the Project Window open and closed. You may remap + this toggle function by putting the following in your vimrc and + replacing P with whatever key combination you wish: + + nmap P ToggleProject + +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. + +============================================================================== +ADDING MAPPINGS *project-adding-mappings* + +You can add your own mappings or change the mappings of the plugin by placing +them in the file $HOME/.vimproject_mappings. This file, if it exists, will be +sourced when the plugin in loaded. Here is an example that will count the +number of entries in a project when you press \K (Kount, C is taken :-): > + + function! s:Wc() + let b:loadcount=0 + function! SpawnExec(infoline, fname, lineno, data) + let b:loadcount = b:loadcount + 1 + if getchar(0) != 0 | let b:stop_everything=1 | endif + endfunction + call Project_ForEach(1, line('.'), "*SpawnExec", 0, '') + delfunction SpawnExec + echon b:loadcount." Files\r" + unlet b:loadcount + if exists("b:stop_everything") + unlet b:stop_everything + echon "Aborted.\r" + endif + endfunction + + nnoremap K :call Wc() + +Here's another example of how I integrated the use of perforce with the plugin +in my $HOME/.vimproject_mappings: +> + function! s:DoP4(cmd) + let name=Project_GetFname(line('.')) + let dir=substitute(name, '\(.*\)/.*', '\1', 'g') + exec 'cd '.dir + exec "!".a:cmd.' '.Project_GetFname(line('.')) + cd - + endfunction + + nmap \pa :call DoP4("p4add") + nmap \pe :call DoP4("p4edit") +< +(Note that I CD to the directory the file is in so I can pick of the $P4CONFIG +file. See the perforce documentation.) + +This creates the mappings \pe to check out the file for edit and \pa to add +the file to the depot. + +Here is another example where I remap the mapping to use an external +program to launch a special kind of file (in this case, it launches ee to view +a jpg file). It is a bit contrived, but it works. +> + let s:sid = substitute(maparg('', 'n'), '.*\(.\{-}\)_.*', '\1', '') + function! s:LaunchOrWhat() + let fname=Project_GetFname(line('.')) + if fname =~ '\.jpg$' + exec 'silent! !ee "'.fname.'"&' + else + call {s:sid}_DoFoldOrOpenEntry('', 'e') + endif + endfunction + nnoremap \|:call LaunchOrWhat() +< +If the file ends in .jpg, the external program is launched, otherwise the +original mapping of is run. + +============================================================================== +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. + + flag Description ~ + + b When present, use the |browse()| when selecting directories + for \c and \C. This is off by default for Windows, because + the windows browser does not allow you to select directories. + + c When present, the Project Window will automatically close when + you select a file. + + F Float the Project Window. That is, turn off automatic + resizing and placement. This allows placement between other + windows that wish to share similar placement at the side of + the screen. It is also particularly helpful for external + window managers. + + g When present, the mapping for will be created to toggle + the Project Window open and closed. + + 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. This flag is really obsolete and not of much use + because of L below. + + 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. + + n When present, numbers will be turned on for the project + window. + + 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. + + v When present, use :vimgrep rather than :grep when using \G. + +g:proj_run1 ... g:proj_run9 + Contains a Vim command to execute on the file. See the + mappings of \1 to \9 above. + + %f is replaced with the full path and filename + %F is replaced with the full path and filename with spaces + quoted + %n is replaced with the filename alone + %N is replaced with the filename alone with spaces quoted + %h is replaced with the home directory + %H is replaced with the home directory with spaces quoted + %r is replaced with the directory relative to the CD path + %R is replaced with the directory relative to the CD path + with spaces quoted + %d is replaced with the CD directory. + %D is replaced with the CD directory.with spaces quoted + %% is replaced with a single % that is not used in + expansion. + + (Deprecated: %s is also replaced with the full path and + filename for backward compatibility.) + + 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 %f' +< Here are a few other examples: > + let g:proj_run1='!p4 edit %f' + let g:proj_run2='!p4 add %f' + let g:proj_run4="echo 'Viewing %f'|sil !xterm -e less %f &" +< + On Windows systems you will want to put the %f, %h, and %d in + single quotes to avoid \ escaping. + +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. + + %f is the filename, %h is replaced with the project home + directory, and %d is replaced with the CD directory. Multiple + filenames can be handled in two ways: + + The first (default) way is to have %f replaced with all the + absolute filenames, and the command is run once. The second + is to have the command run for each of the non-absolute + filenames (%f 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 '%h/%f'" + let g:proj_run_fold4="echo '%f'" +< + Note that on Windows systems, you will want the %f, %h, and %c + within single quotes, or the \ in the paths will cause + problems. The alternative is to put them in |escape()|. + + +============================================================================== +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. (You don't need to give it the filename; the + plugin remembers.) + + 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. Also, I export Project_ForEach() for running a function for + each filename in the project. See the code for examples on how to use + these. Finally, I export Project_GetFname(line_number) so that you can + write your own mappings and get the filename for it. + +8. Some people have asked how to do a global mapping to take the cursor to + the Project window. One of my goals for the plugin is for it to be as + self-contained as possible, so I'm not going to add it by default. But you + can put this in your vimrc: +> + nmap P :Project + +< +9. You can put the . entry in a project, and it will launch the + |file-explorer| plugin on the directory. To avoid removal when you + refresh, make the entry look like this: +> + . # pragma keep +< +============================================================================== +THANKS + + The following people have sent me patches to help with the Project + Plugin development: + + Tomas Zellerin + Lawrence Kesteloot + Dave Eggum + A Harrison + Thomas Link + Richard Bair + Eric Arnold + Peter Jones + Eric Van Dewoestine + + + vim:ts=8 sw=8 noexpandtab tw=78 ft=help: diff --git a/plugin/project.vim b/plugin/project.vim new file mode 100644 index 0000000..47bd379 --- /dev/null +++ b/plugin/project.vim @@ -0,0 +1,1293 @@ +"============================================================================= +" File: project.vim +" Author: Aric Blumer (Aric.Blumer at aricvim@charter.net) +" Last Change: Fri 13 Oct 2006 09:47:08 AM EDT +" Version: 1.4.1 +"============================================================================= +" See documentation in accompanying help file +" You may use this code in whatever way you see fit. + +if exists('loaded_project') || &cp + finish +endif +let loaded_project=1 + +function! s:Project(filename) " <<< + " Initialization <<< + if exists("g:proj_running") + if strlen(a:filename) != 0 + call confirm('Project already loaded; ignoring filename "'.a:filename."\".\n".'See ":help project-invoking" for information about changing project files.', "&OK", 1) + endif + let filename=bufname(g:proj_running) + else + if strlen(a:filename) == 0 + let filename ='~/.vimprojects' " Default project filename + else + let filename = a:filename + endif + endif + if !exists('g:proj_window_width') + let g:proj_window_width=24 " Default project window width + endif + if !exists('g:proj_window_increment') + let g:proj_window_increment=100 " Project Window width increment + endif + if !exists('g:proj_flags') + if has("win32") || has("mac") + let g:proj_flags='imst' " Project default flags for windows/mac + else + let g:proj_flags='imstb' " Project default flags for everything else + endif + endif + if !exists("g:proj_running") || (bufwinnr(g:proj_running) == -1) " Open the Project Window + exec 'silent vertical new '.filename + if match(g:proj_flags, '\CF') == -1 " We're floating + silent! wincmd H + exec 'vertical resize '.g:proj_window_width + endif + setlocal nomodeline + else + silent! 99wincmd h + if bufwinnr(g:proj_running) == -1 + vertical split + let v:errmsg="nothing" + silent! bnext + if 'nothing' != v:errmsg + enew + endif + endif + 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 + + let b:proj_locate_command='silent! wincmd H' + let b:proj_resize_command='exec ''vertical resize ''.g:proj_window_width' + if match(g:proj_flags, '\CF') != -1 " Set the resize commands to nothing + let b:proj_locate_command='' + let b:proj_resize_command='' + endif + + let g:proj_last_buffer = -1 + ">>> + " 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 foldenable foldmethod=marker foldmarker={,} commentstring=%s foldcolumn=0 nonumber noswapfile shiftwidth=1 + setlocal foldtext=ProjFoldText() nobuflisted nowrap + setlocal winwidth=1 + if match(g:proj_flags, '\Cn') != -1 + setlocal number + endif + 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*\(\\ \|\f\|:\|"\)\+' contains=projectDescription,projectWhiteError + syntax match projectDescription '\<.\{-}='he=e-1,me=e-1 contained nextgroup=projectDirectory contains=projectWhiteError + syntax match projectDescription '{\|}' + syntax match projectDirectory '=\(\\ \|\f\|:\)\+' contained + syntax match projectDirectory '=".\{-}"' 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 =~ '^ftp:' || a:path =~ '^rcp:' || a:path =~ '^scp:' || a:path =~ '^http:' + return 2 + endif + if a:path =~ '\$' + let path=expand(a:path) " Expand any environment variables that might be in the path + else + let path=a:path + endif + if path[0] == '/' || path[0] == '~' || path[0] == '\\' || path[1] == ':' + return 1 + endif + return 0 + endfunction " >>> + " s:DoSetupAndSplit() <<< + " Call DoSetup to ensure the settings are correct. Split to the next + " file. + function! s:DoSetupAndSplit() + call s:DoSetup() " Ensure that all the settings are right + let n = winnr() " Determine if there is a CTRL_W-p window + 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 + if bufnr('%') == g:proj_running + exec 'silent vertical new' + else + exec 'silent vertical split | silent! bnext' + endif + wincmd p " Go back to the Project Window and ensure it is the right width + exec b:proj_locate_command + exec b:proj_resize_command + wincmd p + endif + endfunction ">>> + " 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() + if winbufnr(0) != g:proj_running + return + endif + call s:DoSetup() " Ensure that all the settings are right + if winbufnr(2) == -1 " We're the only window right now. + exec 'silent vertical split | bnext' + if bufnr('%') == g:proj_running + enew + endif + if bufnr('%') == g:proj_last_buffer | bnext | bprev | bnext | endif + wincmd p " Go back to the Project Window and ensure it is the right width + exec b:proj_locate_command + exec b:proj_resize_command + elseif(winnr() != 1) + exec b:proj_locate_command + exec b:proj_resize_command + endif + endfunction + function! s:RecordPrevBuffer_au() + let g:proj_last_buffer = bufnr('%') + 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) + let parent_infoline = '' + if foldlev > 1 + while foldlevel(lineno) >= foldlev " Go to parent fold + if lineno < 1 + echoerr 'Some kind of fold error. Check your syntax.' + return + endif + let lineno = lineno - 1 + endwhile + let parent_infoline = s:RecursivelyConstructDirectives(lineno) + endif + let parent_home = s:GetHome(parent_infoline, '') + let parent_c_d = s:GetCd(parent_infoline, parent_home) + let parent_scriptin = s:GetScriptin(parent_infoline, parent_home) + let parent_scriptout = s:GetScriptout(parent_infoline, parent_home) + let parent_filter = s:GetFilter(parent_infoline, '*') + let infoline = getline(foldlineno) + " Extract the home directory of this fold + let home=s:GetHome(infoline, parent_home) + if home != '' + if (foldlevel(foldlineno) == 1) && !s:IsAbsolutePath(home) + call confirm('Outermost Project Fold must have absolute path! Or perhaps the path does not exist.', "&OK", 1) + let home = '~' " Some 'reasonable' value + endif + endif + " Extract any CD information + let c_d = s:GetCd(infoline, home) + if c_d != '' + if (foldlevel(foldlineno) == 1) && !s:IsAbsolutePath(c_d) + call confirm('Outermost Project Fold must have absolute CD path! Or perhaps the path does not exist.', "&OK", 1) + let c_d = '.' " Some 'reasonable' value + endif + else + let c_d=parent_c_d + endif + " Extract scriptin + let scriptin = s:GetScriptin(infoline, home) + if scriptin == '' + let scriptin = parent_scriptin + endif + " Extract scriptout + let scriptout = s:GetScriptout(infoline, home) + if scriptout == '' + let scriptout = parent_scriptout + endif + " Extract filter + let filter = s:GetFilter(infoline, parent_filter) + if filter == '' | let filter = parent_filter | endif + return s:ConstructInfo(home, c_d, scriptin, scriptout, '', filter) + endfunction ">>> + " s:ConstructInfo(home, c_d, scriptin, scriptout, flags, filter) <<< + function! s:ConstructInfo(home, c_d, scriptin, scriptout, flags, filter) + let retval='Directory='.a:home + if a:c_d[0] != '' + let retval=retval.' CD='.a:c_d + endif + if a:scriptin[0] != '' + let retval=retval.' in='.a:scriptin + endif + if a:scriptout[0] != '' + let retval=retval.' out='.a:scriptout + endif + if a:filter[0] != '' + let retval=retval.' filter="'.a:filter.'"' + endif + return retval + endfunction ">>> + " s:OpenEntry(line, precmd, editcmd) <<< + " Get the filename under the cursor, and open a window with it. + function! s:OpenEntry(line, precmd, editcmd, dir) + silent exec a:precmd + if (a:editcmd[0] != '') + if a:dir + let fname='.' + else + if (foldlevel(a:line) == 0) && (a:editcmd[0] != '') + return 0 " If we're outside a fold, do nothing + endif + let fname=substitute(getline(a:line), '\s*#.*', '', '') " Get rid of comments and whitespace before comment + let fname=substitute(fname, '^\s*\(.*\)', '\1', '') " Get rid of leading whitespace + if strlen(fname) == 0 + return 0 " The line is blank. Do nothing. + endif + endif + else + let fname='.' + endif + let infoline = s:RecursivelyConstructDirectives(a:line) + let retval=s:OpenEntry2(a:line, infoline, fname, a:editcmd) + call s:DisplayInfo() + return retval + endfunction + ">>> + " s:OpenEntry2(line, infoline, precmd, editcmd) <<< + " Get the filename under the cursor, and open a window with it. + function! s:OpenEntry2(line, infoline, fname, editcmd) + let fname=escape(a:fname, ' %#') " Thanks to Thomas Link for cluing me in on % and # + let home=s:GetHome(a:infoline, '').'/' + if home=='/' + echoerr 'Project structure error. Check your syntax.' + return + endif + "Save the cd command + let cd_cmd = b:proj_cd_cmd + if a:editcmd[0] != '' " If editcmd is '', then just set up the environment in the Project Window + call s:DoSetupAndSplit() + " If it is an absolute path, don't prepend home + if !s:IsAbsolutePath(fname) + let fname=home.fname + endif + if s:IsAbsolutePath(fname) == 2 + exec a:editcmd.' '.fname + else + silent exec 'silent '.a:editcmd.' '.fname + endif + else " only happens in the Project File + exec 'au! BufEnter,BufLeave '.expand('%:p') + endif + " Extract any CD information + let c_d = s:GetCd(a:infoline, home) + if c_d != '' && (s:IsAbsolutePath(home) != 2) + if match(g:proj_flags, '\CL') != -1 + call s:SetupAutoCommand(c_d) + endif + if !isdirectory(glob(c_d)) + call confirm("From this fold's entry,\nCD=".'"'.c_d.'" is not a valid directory.', "&OK", 1) + else + silent exec cd_cmd.' '.c_d + endif + endif + " Extract any scriptin information + let scriptin = s:GetScriptin(a:infoline, home) + if scriptin != '' + if !filereadable(glob(scriptin)) + call confirm('"'.scriptin.'" not found. Ignoring.', "&OK", 1) + else + call s:SetupScriptAutoCommand('BufEnter', scriptin) + exec 'source '.scriptin + endif + endif + let scriptout = s:GetScriptout(a:infoline, home) + if scriptout != '' + if !filereadable(glob(scriptout)) + call confirm('"'.scriptout.'" not found. Ignoring.', "&OK", 1) + else + call s:SetupScriptAutoCommand('BufLeave', scriptout) + endif + endif + return 1 + endfunction + ">>> + " s:DoFoldOrOpenEntry(cmd0, cmd1) <<< + " 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) + if getline('.')=~'{\|}' || foldclosed('.') != -1 + normal! za + else + call s:DoEnsurePlacementSize_au() + call s:OpenEntry(line('.'), a:cmd0, a:cmd1, 0) + if (match(g:proj_flags, '\Cc') != -1) + let g:proj_mywinnumber = winbufnr(0) + Project + hide + if(g:proj_mywinnumber != winbufnr(0)) + wincmd p + endif + wincmd = + endif + endif + endfunction ">>> + " s:VimDirListing(filter, padding, separator, filevariable, filecount, dirvariable, dircount) <<< + function! s:VimDirListing(filter, padding, separator, filevariable, filecount, dirvariable, dircount) + 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."\010" + 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. + let fnames=files + let {a:filevariable}='' + let {a:dirvariable}='' + let {a:filecount}=0 + let {a:dircount}=0 + while strlen(fnames) > 0 + let fname = substitute(fnames, '\(\(\f\|[ :\[\]]\)*\).*', '\1', '') + let fnames = substitute(fnames, '\(\f\|[ :\[\]]\)*.\(.*\)', '\2', '') + if isdirectory(glob(fname)) + let {a:dirvariable}={a:dirvariable}.a:padding.fname.a:separator + let {a:dircount}={a:dircount} + 1 + else + let {a:filevariable}={a:filevariable}.a:padding.fname.a:separator + let {a:filecount}={a:filecount} + 1 + endif + endwhile + endfunction ">>> + " s:GenerateEntry(recursive, name, absolute_dir, dir, c_d, filter_directive, filter, foldlev, sort) <<< + function! s:GenerateEntry(recursive, line, name, absolute_dir, dir, c_d, filter_directive, filter, foldlev, sort) + let line=a:line + if a:dir =~ '\\ ' + let dir='"'.substitute(a:dir, '\\ ', ' ', 'g').'"' + else + let dir=a:dir + endif + let spaces=strpart(' ', 0, a:foldlev) + let c_d=(strlen(a:c_d) > 0) ? 'CD='.a:c_d.' ' : '' + let c_d=(strlen(a:filter_directive) > 0) ? c_d.'filter="'.a:filter_directive.'" ': c_d + call append(line, spaces.'}') + call append(line, spaces.a:name.'='.dir.' '.c_d.'{') + if a:recursive + exec 'cd '.a:absolute_dir + call s:VimDirListing("*", '', "\010", 'b:files', 'b:filecount', 'b:dirs', 'b:dircount') + cd - + let dirs=b:dirs + let dcount=b:dircount + unlet b:files b:filecount b:dirs b:dircount + while dcount > 0 + let dname = substitute(dirs, '\(\( \|\f\|:\)*\).*', '\1', '') + let edname = escape(dname, ' ') + let dirs = substitute(dirs, '\( \|\f\|:\)*.\(.*\)', '\2', '') + let line=s:GenerateEntry(1, line + 1, dname, a:absolute_dir.'/'.edname, edname, '', '', a:filter, a:foldlev+1, a:sort) + let dcount=dcount-1 + endwhile + endif + return line+1 + endfunction " >>> + " s:DoEntryFromDir(line, name, absolute_dir, dir, c_d, filter_directive, filter, foldlev, sort) <<< + " Generate the fold from the directory hierarchy (if recursive), then + " fill it in with RefreshEntriesFromDir() + function! s:DoEntryFromDir(recursive, line, name, absolute_dir, dir, c_d, filter_directive, filter, foldlev, sort) + call s:GenerateEntry(a:recursive, a:line, a:name, escape(a:absolute_dir, ' '), escape(a:dir, ' '), escape(a:c_d, ' '), a:filter_directive, a:filter, a:foldlev, a:sort) + normal! j + call s:RefreshEntriesFromDir(1) + endfunction ">>> + " s:CreateEntriesFromDir(recursive) <<< + " Prompts user for information and then calls s:DoEntryFromDir() + function! s:CreateEntriesFromDir(recursive) + " 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 + let absolute = (foldlev <= 0)?'Absolute ': '' + let home='' + let filter='*' + if (match(g:proj_flags, '\Cb') != -1) && has('browse') + " 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: ', '', '') + let dir = fnamemodify(dir, ':p') + 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) " Remove trailing / or \ + endif + let dir = substitute(dir, '^\~', $HOME, 'g') + if (foldlev > 0) + let parent_directive=s:RecursivelyConstructDirectives(line) + let filter = s:GetFilter(parent_directive, '*') + let home=s:GetHome(parent_directive, '') + if home[strlen(home)-1] != '/' && home[strlen(home)-1] != '\\' + let home=home.'/' + endif + unlet parent_directive + if s:IsAbsolutePath(dir) + " It is not a relative path Try to make it relative + let hend=matchend(dir, '\C'.glob(home)) + if hend != -1 + let dir=strpart(dir, hend) " The directory can be a relative path + else + let home="" + endif + endif + endif + if strlen(home.dir) == 0 + return + endif + if !isdirectory(home.dir) + if has("unix") + silent exec '!mkdir '.home.dir.' > /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) =~ '}' + let foldlev = foldlev - 1 " . . . decrease the indentation by 1. + endif + " Do the work + call s:DoEntryFromDir(a:recursive, 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) + if foldlevel('.') == 0 + echo 'Nothing to refresh.' + return + endif + " Open the fold. + if getline('.') =~ '}' + normal! zo[z + else + normal! zo]z[z + endif + let just_a_fold=0 + let infoline = s:RecursivelyConstructDirectives(line('.')) + let immediate_infoline = getline('.') + if strlen(substitute(immediate_infoline, '[^=]*=\(\(\f\|:\|\\ \)*\).*', '\1', '')) == strlen(immediate_infoline) + let just_a_fold = 1 + endif + " Extract the home directory of the fold + let home = s:GetHome(infoline, '') + if home == '' + " No Match. This means that this is just a label with no + " directory entry. + if a:recursive == 0 + return " We're done--nothing to do + 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 = s:GetFilter(infoline, '*') + " Extract the description (name) of the fold + let name = substitute(infoline, '^[#\t ]*\([^=]*\)=.*', '\1', '') + if strlen(name) == strlen(infoline) + return " If there's no name, we're done. + endif + if (home == '') || (name == '') + return + endif + " Extract the flags + let flags = s:GetFlags(immediate_infoline) + let sort = (match(g:proj_flags, '\CS') != -1) + if flags != '' + if match(flags, '\Cr') != -1 + " If the flags do not contain r (refresh), then treat it just + " like a fold + let just_a_fold = 1 + endif + if match(flags, '\CS') != -1 + let sort = 1 + endif + if match(flags, '\Cs') != -1 + let sort = 0 + endif + else + let flags='' + endif + endif + " Move to the first non-fold boundary line + normal! j + " Delete filenames until we reach the end of the fold + while getline('.') !~ '}' + if line('.') == line('$') + break + endif + if getline('.') !~ '{' + " We haven't reached a sub-fold, so delete what's there. + if (just_a_fold == 0) && (getline('.') !~ '^\s*#') && (getline('.') !~ '#.*pragma keep') + d _ + else + " Skip lines only in a fold and comment lines + normal! j + endif + else + " We have reached a sub-fold. If we're doing recursive, then + " call this function again. If not, find the end of the fold. + if a:recursive == 1 + call s:RefreshEntriesFromDir(1) + normal! ]zj + else + if foldclosed('.') == -1 + normal! zc + endif + normal! j + endif + endif + endwhile + if just_a_fold == 0 + " We're not just in a fold, and we have deleted all the filenames. + " Now it is time to regenerate what is in the directory. + if !isdirectory(glob(home)) + call confirm('"'.home.'" is not a valid directory.', "&OK", 1) + else + let foldlev=foldlevel('.') + " T flag. Thanks Tomas Z. + if (match(flags, '\Ct') != -1) || ((match(g:proj_flags, '\CT') == -1) && (match(flags, '\CT') == -1)) + " Go to the top of the fold (force other folds to the + " bottom) + normal! [z + normal! j + " Skip any comments + while getline('.') =~ '^\s*#' + normal! j + endwhile + endif + normal! k + let cwd=getcwd() + let spaces=strpart(' ', 0, foldlev) + exec 'cd '.home + if match(g:proj_flags, '\Ci') != -1 + echon home."\r" + endif + call s:VimDirListing(filter, spaces, "\n", 'b:files', 'b:filecount', 'b:dirs', 'b:dircount') + if b:filecount > 0 + normal! mk + silent! put =b:files + normal! `kj + if sort + call s:SortR(line('.'), line('.') + b:filecount - 1) + endif + else + normal! j + endif + unlet b:files b:filecount b:dirs b:dircount + exec 'cd '.cwd + endif + endif + " Go to the top of the refreshed fold. + normal! [z + endfunction ">>> + " 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) && (foldclosed('.') == -1) + normal! zc + 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 = escape(getcwd(), ' ') + let b:proj_has_autocommand = 1 + let bufname=escape(substitute(expand('%:p', 0), '\\', '/', 'g'), ' ') + exec 'au BufEnter '.bufname." let b:proj_cwd_save=escape(getcwd(), ' ') | cd ".a:cwd + exec 'au BufLeave '.bufname.' exec "cd ".b:proj_cwd_save' + exec 'au BufWipeout '.bufname.' au! * '.bufname + endif + endfunction ">>> + " s:SetupScriptAutoCommand(bufcmd, script) <<< + " Sets up an autocommand to run the scriptin script. + function! s:SetupScriptAutoCommand(bufcmd, script) + if !exists("b:proj_has_".a:bufcmd) + let b:proj_has_{a:bufcmd} = 1 + exec 'au '.a:bufcmd.' '.escape(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 (winbufnr(0) != g:proj_running) || (winnr() != 1) + 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 + exec b:proj_locate_command + endif + exec b:proj_resize_command + endfunction ">>> + " s:Spawn(number) <<< + " Spawn an external command on the file + function! s:Spawn(number) + echo | if exists("g:proj_run".a:number) + let fname=getline('.') + if fname!~'{\|}' + let fname=substitute(fname, '\s*#.*', '', '') + let fname=substitute(fname, '^\s*\(.*\)\s*', '\1', '') + if fname == '' | return | endif + let parent_infoline = s:RecursivelyConstructDirectives(line('.')) + let home=expand(s:GetHome(parent_infoline, '')) + let c_d=expand(s:GetCd(parent_infoline, '')) + let command=substitute(g:proj_run{a:number}, '%%', "\010", 'g') + let command=substitute(command, '%f', escape(home.'/'.fname, '\'), 'g') + let command=substitute(command, '%F', substitute(escape(home.'/'.fname, '\'), ' ', '\\\\ ', 'g'), 'g') + let command=substitute(command, '%s', escape(home.'/'.fname, '\'), 'g') + let command=substitute(command, '%n', escape(fname, '\'), 'g') + let command=substitute(command, '%N', substitute(fname, ' ', '\\\\ ', 'g'), 'g') + let command=substitute(command, '%h', escape(home, '\'), 'g') + let command=substitute(command, '%H', substitute(escape(home, '\'), ' ', '\\\\ ', 'g'), 'g') + if c_d != '' + if c_d == home + let percent_r='.' + else + let percent_r=substitute(home, escape(c_d.'/', '\'), '', 'g') + endif + else + let percent_r=home + endif + let command=substitute(command, '%r', percent_r, 'g') + let command=substitute(command, '%R', substitute(percent_r, ' ', '\\\\ ', 'g'), 'g') + let command=substitute(command, '%d', escape(c_d, '\'), 'g') + let command=substitute(command, '%D', substitute(escape(c_d, '\'), ' ', '\\\\ ', 'g'), 'g') + let command=substitute(command, "\010", '%', 'g') + exec command + 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 ' '.substitute(escape(g:proj_run{a:varnamesegment}{number}, '\'), "\n", '\\n', 'g') + 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 + if getline(lineno) =~ '}' + let lineno = lineno - 1 + endif + while getline(lineno) !~ '{' && lineno > 1 + if getline(lineno) =~ '}' + let lineno=s:FindFoldTop(lineno) + 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 b:loadcount=0 + function! s:SpawnExec(infoline, fname, lineno, data) + if s:OpenEntry2(a:lineno, a:infoline, a:fname, 'e') + wincmd p + let b:loadcount=b:loadcount+1 + echon b:loadcount."\r" + if getchar(0) != 0 + let b:stop_everything=1 + endif + endif + endfunction + call Project_ForEach(a:recurse, line('.'), "*SpawnExec", 0, '^\(.*l\)\@!') + delfunction s:SpawnExec + echon b:loadcount." Files Loaded\r" + unlet b:loadcount + if exists("b:stop_everything") | unlet b:stop_everything | endif + endfunction ">>> + " s:WipeAll(recurse, line) <<< + " Wipe all files in a project + function! s:WipeAll(recurse, line) + let b:wipecount=0 + let b:totalcount=0 + function! s:SpawnExec(home, c_d, fname, lineno, data) + let fname=escape(a:fname, ' ') + if s:IsAbsolutePath(fname) + let fname=fnamemodify(fname, ':n') " :n is coming, won't break anything now + else + let fname=fnamemodify(a:home.'/'.fname, ':n') " :n is coming, won't break anything now + endif + let b:totalcount=b:totalcount+1 + let fname=substitute(fname, '^\~', $HOME, 'g') + if bufloaded(substitute(fname, '\\ ', ' ', 'g')) + if getbufvar(fname.'\>', '&modified') == 1 + exec 'sb '.fname + wincmd L + w + wincmd p + endif + let b:wipecount=b:wipecount+1 + exec 'bwipe! '.fname + endif + if b:totalcount % 5 == 0 + echon b:wipecount.' of '.b:totalcount."\r" + redraw + endif + if getchar(0) != 0 + let b:stop_everything=1 + endif + endfunction + call Project_ForEach(a:recurse, line('.'), "SpawnExec", 0, '^\(.*w\)\@!') + delfunction s:SpawnExec + echon b:wipecount.' of '.b:totalcount." Files Wiped\r" + unlet b:wipecount b:totalcount + if exists("b:stop_everything") | unlet b:stop_everything | endif + endfunction ">>> + " s:LoadAllSplit(recurse, line) <<< + " Load all files in a project using split windows. + " Contributed by A. Harrison + function! s:LoadAllSplit(recurse, line) + let b:loadcount=0 + function! s:SpawnExec(infoline, fname, lineno, data) + let winNr = winnr() "get ProjectWindow number + if s:OpenEntry2(a:lineno, a:infoline, a:fname, 'sp') + exec winNr."wincmd w" + let b:loadcount=b:loadcount+1 + echon b:loadcount."\r" + if getchar(0) != 0 + let b:stop_everything=1 + endif + endif + endfunction + call Project_ForEach(a:recurse, line('.'), "*SpawnExec", 0, '^\(.*l\)\@!') + delfunction s:SpawnExec + echon b:loadcount." Files Loaded\r" + unlet b:loadcount + if exists("b:stop_everything") | unlet b:stop_everything | endif + endfunction ">>> + " s:GrepAll(recurse, lineno, pattern) <<< + " Grep all files in a project, optionally recursively + function! s:GrepAll(recurse, lineno, pattern) + cunmap help + let pattern=(a:pattern[0] == '')?input("GREP options and pattern: "):a:pattern + cnoremap help let g:proj_doinghelp = 1:help + if pattern[0] == '' + return + endif + let b:escape_spaces=1 + let fnames=Project_GetAllFnames(a:recurse, a:lineno, ' ') + unlet b:escape_spaces + cclose " Make sure grep window is closed + call s:DoSetupAndSplit() + if match(g:proj_flags, '\Cv') == -1 + silent! exec 'silent! grep '.pattern.' '.fnames + if v:shell_error != 0 + echo 'GREP error. Perhaps there are too many filenames.' + else + copen + endif + else + silent! exec 'silent! vimgrep '.pattern.' '.fnames + copen + endif + endfunction ">>> + " GetXXX Functions <<< + function! s:GetHome(info, parent_home) + " Thanks to Adam Montague for pointing out the need for @ in urls. + let home=substitute(a:info, '^[^=]*=\(\(\\ \|\f\|:\|@\)\+\).*', '\1', '') + if strlen(home) == strlen(a:info) + let home=substitute(a:info, '.\{-}"\(.\{-}\)".*', '\1', '') + if strlen(home) != strlen(a:info) | let home=escape(home, ' ') | endif + endif + if strlen(home) == strlen(a:info) + let home=a:parent_home + elseif home=='.' + let home=a:parent_home + elseif !s:IsAbsolutePath(home) + let home=a:parent_home.'/'.home + endif + return home + endfunction + function! s:GetFilter(info, parent_filter) + let filter = substitute(a:info, '.*\>> + " Project_GetAllFnames(recurse, lineno, separator) <<< + " Grep all files in a project, optionally recursively + function! Project_GetAllFnames(recurse, lineno, separator) + let b:fnamelist='' + function! s:SpawnExec(home, c_d, fname, lineno, data) + if exists('b:escape_spaces') + let fname=escape(a:fname, ' ') + else + let fname=a:fname + endif + if !s:IsAbsolutePath(a:fname) + let fname=a:home.'/'.fname + endif + let b:fnamelist=b:fnamelist.a:data.fname + endfunction + call Project_ForEach(a:recurse, line('.'), "SpawnExec", a:separator, '') + delfunction s:SpawnExec + let retval=b:fnamelist + unlet b:fnamelist + return retval + endfunction ">>> + " Project_GetAllFnames(recurse, lineno, separator) <<< + " Grep all files in a project, optionally recursively + function! Project_GetFname(line) + if (foldlevel(a:line) == 0) + return '' + endif + let fname=substitute(getline(a:line), '\s*#.*', '', '') " Get rid of comments and whitespace before comment + let fname=substitute(fname, '^\s*\(.*\)', '\1', '') " Get rid of leading whitespace + if strlen(fname) == 0 + return '' " The line is blank. Do nothing. + endif + if s:IsAbsolutePath(fname) + return fname + endif + let infoline = s:RecursivelyConstructDirectives(a:line) + return s:GetHome(infoline, '').'/'.fname + endfunction ">>> + " Project_ForEach(recurse, lineno, cmd, data, match) <<< + " Grep all files in a project, optionally recursively + function! Project_ForEach(recurse, lineno, cmd, data, match) + let info=s:RecursivelyConstructDirectives(a:lineno) + let lineno=s:FindFoldTop(a:lineno) + 1 + let flags=s:GetFlags(getline(lineno - 1)) + if (flags == '') || (a:match=='') || (match(flags, a:match) != -1) + call s:Project_ForEachR(a:recurse, lineno, info, a:cmd, a:data, a:match) + endif + endfunction + function! s:Project_ForEachR(recurse, lineno, info, cmd, data, match) + let home=s:GetHome(a:info, '') + let c_d=s:GetCd(a:info, home) + let scriptin = s:GetScriptin(a:info, home) + let scriptout = s:GetScriptout(a:info, home) + let filter = s:GetFilter(a:info, '') + let lineno = a:lineno + let curline=getline(lineno) + while (curline !~ '}') && (curline < line('$')) + if exists("b:stop_everything") && b:stop_everything | return 0 | endif + if curline =~ '{' + if a:recurse + let flags=s:GetFlags(curline) + if (flags == '') || (a:match=='') || (match(flags, a:match) != -1) + let this_home=s:GetHome(curline, home) + let this_cd=s:GetCd(curline, this_home) + if this_cd=='' | let this_cd=c_d | endif + let this_scriptin=s:GetScriptin(curline, this_home) + if this_scriptin == '' | let this_scriptin=scriptin | endif + let this_scriptout=s:GetScriptin(curline, this_home) + if this_scriptout == '' | let this_scriptout=scriptout | endif + let this_filter=s:GetFilter(curline, filter) + let lineno=s:Project_ForEachR(1, lineno+1, + \s:ConstructInfo(this_home, this_cd, this_scriptin, this_scriptout, flags, this_filter), a:cmd, a:data, a:match) + else + let lineno=s:FindFoldBottom(lineno) + endif + else + let lineno=s:FindFoldBottom(lineno) + endif + else + let fname=substitute(curline, '\s*#.*', '', '') + let fname=substitute(fname, '^\s*\(.*\)', '\1', '') + if (strlen(fname) != strlen(curline)) && (fname[0] != '') + if a:cmd[0] == '*' + call {strpart(a:cmd, 1)}(a:info, fname, lineno, a:data) + else + call {a:cmd}(home, c_d, fname, lineno, a:data) + endif + endif + endif + let lineno=lineno + 1 + let curline=getline(lineno) + endwhile + return lineno + endfunction ">>> + " s:SpawnAll(recurse, number) <<< + " Spawn an external command on the files of a project + function! s:SpawnAll(recurse, number) + echo | if exists("g:proj_run_fold".a:number) + if g:proj_run_fold{a:number}[0] == '*' + function! s:SpawnExec(home, c_d, fname, lineno, data) + let command=substitute(strpart(g:proj_run_fold{a:data}, 1), '%s', escape(a:fname, ' \'), 'g') + let command=substitute(command, '%f', escape(a:fname, '\'), 'g') + let command=substitute(command, '%h', escape(a:home, '\'), 'g') + let command=substitute(command, '%d', escape(a:c_d, '\'), 'g') + let command=substitute(command, '%F', substitute(escape(a:fname, '\'), ' ', '\\\\ ', 'g'), 'g') + exec command + endfunction + call Project_ForEach(a:recurse, line('.'), "SpawnExec", a:number, '.') + delfunction s:SpawnExec + else + let info=s:RecursivelyConstructDirectives(line('.')) + let home=s:GetHome(info, '') + let c_d=s:GetCd(info, '') + let b:escape_spaces=1 + let fnames=Project_GetAllFnames(a:recurse, line('.'), ' ') + unlet b:escape_spaces + let command=substitute(g:proj_run_fold{a:number}, '%f', substitute(escape(fnames, '\'), '\\ ', ' ', 'g'), 'g') + let command=substitute(command, '%s', escape(fnames, '\'), 'g') + let command=substitute(command, '%h', escape(home, '\'), 'g') + let command=substitute(command, '%d', escape(c_d, '\'), 'g') + let command=substitute(command, '%F', escape(fnames, '\'), 'g') + exec command + if v:shell_error != 0 + echo 'Shell error. Perhaps there are too many filenames.' + endif + endif + endif + endfunction ">>> + if !exists("g:proj_running") + " s:DoProjectOnly(void) <<< + " Make the file window the only one. + function! s:DoProjectOnly() + if winbufnr(0) != g:proj_running + let lzsave=&lz + set lz + only + Project + silent! wincmd p + let &lz=lzsave + unlet lzsave + endif + endfunction + " >>> + + " Mappings <<< + nnoremap \|:call DoFoldOrOpenEntry('', 'e') + nnoremap \|:call DoFoldOrOpenEntry('', 'sp') + nnoremap \|:call DoFoldOrOpenEntry('silent! only', 'e') + nnoremap T \|:call DoFoldOrOpenEntry('', 'tabe') + nmap s + nnoremap S \|:call LoadAllSplit(0, line('.')) + nmap o + nnoremap i :echo RecursivelyConstructDirectives(line('.')) + nnoremap I :echo Project_GetFname(line('.')) + nmap p + nmap v + nnoremap l \|:call LoadAll(0, line('.')) + nnoremap L \|:call LoadAll(1, line('.')) + nnoremap w \|:call WipeAll(0, line('.')) + nnoremap W \|:call WipeAll(1, line('.')) + nnoremap W \|:call WipeAll(1, line('.')) + nnoremap g \|:call GrepAll(0, line('.'), "") + nnoremap G \|:call GrepAll(1, line('.'), "") + nnoremap <2-LeftMouse> \|:call DoFoldOrOpenEntry('', 'e') + nnoremap \|:call DoFoldOrOpenEntry('', 'sp') + 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 'nnoremap '.k.' \|:call Spawn('.k.')' + exec 'nnoremap f'.k.' \|:call SpawnAll(0, '.k.')' + exec 'nnoremap F'.k.' \|:call SpawnAll(1, '.k.')' + let k=k+1 + endwhile + nnoremap 0 \|:call ListSpawn("") + nnoremap f0 \|:call ListSpawn("_fold") + nnoremap F0 \|:call ListSpawn("_fold") + nnoremap c :call CreateEntriesFromDir(0) + nnoremap C :call CreateEntriesFromDir(1) + nnoremap r :call RefreshEntriesFromDir(0) + nnoremap R :call RefreshEntriesFromDir(1) + " For Windows users: same as \R + nnoremap :call RefreshEntriesFromDir(1) + nnoremap e :call OpenEntry(line('.'), '', '', 0) + nnoremap E :call OpenEntry(line('.'), '', 'e', 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 + "nnoremap