" Copyright (c) 1998-2004 " Michael Sharpe " " We grant permission to use, copy modify, distribute, and sell this " software for any purpose without fee, provided that the above copyright " notice and this text are not removed. We make no guarantee about the " suitability of this software for any purpose and we are not liable " for any damages resulting from its use. Further, we are under no " obligation to maintain or extend this software. It is provided on an " "as is" basis without any expressed or implied warranty. " Directory & regex enhancements added by Bindu Wavell who is well known on " vim.sf.net " TODO: a) :AN command "next alternate" " b) Priorities for search paths " c) Error instead of defaulting when alternate does not exist " d) A on a #include line should go to that header if exists("loaded_alternateFile") finish endif let loaded_alternateFile = 1 " setup the default set of alternate extensions. The user can override in thier " .vimrc if the defaults are not suitable. To override in a .vimrc simply set a " g:alternateExtensions_ variable to a comma separated list of alternates, " where is the extension to map. " E.g. let g:alternateExtensions_CPP = "inc,h,H,HPP,hpp" " Function : AddAlternateExtensionMapping (PRIVATE) " Purpose : simple helper function to add the default alternate extension " mappings. " Args : extension -- the extension to map " alternates -- comma separated list of alternates extensions " Returns : nothing " Author : Michael Sharpe function! AddAlternateExtensionMapping(extension, alternates) let varName = "g:alternateExtensions_" . a:extension if (!exists(varName)) let g:alternateExtensions_{a:extension} = a:alternates endif endfunction " Add all the default extensions " Mappings for C and C++ call AddAlternateExtensionMapping('h',"c,cpp,cxx,cc,CC") call AddAlternateExtensionMapping('H',"C,CPP,CXX,CC") call AddAlternateExtensionMapping('hpp',"cpp,c") call AddAlternateExtensionMapping('HPP',"CPP,C") call AddAlternateExtensionMapping('c',"h") call AddAlternateExtensionMapping('C',"H") call AddAlternateExtensionMapping('cpp',"h,hpp") call AddAlternateExtensionMapping('CPP',"H,HPP") call AddAlternateExtensionMapping('cc',"h") call AddAlternateExtensionMapping('CC',"H,h") call AddAlternateExtensionMapping('cxx',"h") call AddAlternateExtensionMapping('CXX',"H") " Mappings for PSL7 call AddAlternateExtensionMapping('psl',"ph") call AddAlternateExtensionMapping('ph',"psl") " Mappings for ADA call AddAlternateExtensionMapping('adb',"ads") call AddAlternateExtensionMapping('ads',"adb") " Mappings for lex and yacc files call AddAlternateExtensionMapping('l',"y,yacc,ypp") call AddAlternateExtensionMapping('lex',"yacc,y,ypp") call AddAlternateExtensionMapping('lpp',"ypp,y,yacc") call AddAlternateExtensionMapping('y',"l,lex,lpp") call AddAlternateExtensionMapping('yacc',"lex,l,lpp") call AddAlternateExtensionMapping('ypp',"lpp,l,lex") " Setup default search path, unless the user has specified " a path in their [._]vimrc. if !exists('g:alternateSearchPath') let g:alternateSearchPath = 'sfr:../source,sfr:../src,sfr:../include,sfr:../inc' endif " Function : GetNthItemFromList (PRIVATE) " Purpose : Support reading items from a comma seperated list " Used to iterate all the extensions in an extension spec " Used to iterate all path prefixes " Args : list -- the list (extension spec, file paths) to iterate " n -- the extension to get " Returns : the nth item (extension, path) from the list (extension " spec), or "" for failure " Author : Michael Sharpe " History : Renamed from GetNthExtensionFromSpec to GetNthItemFromList " to reflect a more generic use of this function. -- Bindu function! GetNthItemFromList(list, n) let itemStart = 0 let itemEnd = -1 let pos = 0 let item = "" let i = 0 while (i != a:n) let itemStart = itemEnd + 1 let itemEnd = match(a:list, ",", itemStart) let i = i + 1 if (itemEnd == -1) if (i == a:n) let itemEnd = strlen(a:list) endif break endif endwhile if (itemEnd != -1) let item = strpart(a:list, itemStart, itemEnd - itemStart) endif return item endfunction " Function : ExpandAlternatePath (PRIVATE) " Purpose : Expand path info. A path with a prefix of "wdr:" will be " treated as relative to the working directory (i.e. the " directory where vim was started.) A path prefix of "abs:" will " be treated as absolute. No prefix or "sfr:" will result in the " path being treated as relative to the source file (see sfPath " argument). " " A prefix of "reg:" will treat the pathSpec as a regular " expression substitution that is applied to the source file " path. The format is: " " reg: " " seperator character, we often use one of [/|%#] " is what you are looking for " is the output pattern " can be g for global replace or empty " " EXAMPLE: 'reg:/inc/src/g/' will replace every instance " of 'inc' with 'src' in the source file path. It is possible " to use match variables so you could do something like: " 'reg:|src/\([^/]*\)|inc/\1||' (see 'help :substitute', " 'help pattern' and 'help sub-replace-special' for more details " " NOTE: a.vim uses ',' (comma) internally so DON'T use it " in your regular expressions or other pathSpecs unless you update " the rest of the a.vim code to use some other seperator. " " Args : pathSpec -- path component (or substitution patterns) " sfPath -- source file path " Returns : a path that can be used by AlternateFile() " Author : Bindu Wavell function! ExpandAlternatePath(pathSpec, sfPath) let prfx = strpart(a:pathSpec, 0, 4) if (prfx == "wdr:" || prfx == "abs:") let path = strpart(a:pathSpec, 4) elseif (prfx == "reg:") let re = strpart(a:pathSpec, 4) let sep = strpart(re, 0, 1) let patend = match(re, sep, 1) let pat = strpart(re, 1, patend - 1) let subend = match(re, sep, patend + 1) let sub = strpart(re, patend+1, subend - patend - 1) let flag = strpart(re, strlen(re) - 2) if (flag == sep) let flag = '' endif let path = substitute(a:sfPath, pat, sub, flag) "call confirm('PAT: [' . pat . '] SUB: [' . sub . ']') "call confirm(a:sfPath . ' => ' . path) else let path = a:pathSpec if (prfx == "sfr:") let path = strpart(path, 4) endif let path = a:sfPath . "/" . path endif return path endfunction " Function : FindFileInSearchPath (PRIVATE) " Purpose : Searches for a file in the search path list " Args : filename -- name of the file to search for " pathList -- the path list to search " relPathBase -- the path which relative paths are expanded from " Returns : An expanded filename if found, the empty string otherwise " Author : Michael Sharpe (feline@irendi.com) " History : inline code written by Bindu Wavell originally function! FindFileInSearchPath(filename, pathList, relPathBase) let filepath = "" let m = 1 let pathListLen = strlen(a:pathList) if (pathListLen > 0) while (1) let pathSpec = GetNthItemFromList(a:pathList, m) if (pathSpec != "") let path = ExpandAlternatePath(pathSpec, a:relPathBase) let fullname = path . "/" . a:filename let foundMatch = BufferOrFileExists(fullname) if (foundMatch) let filepath = fullname break endif else break endif let m = m + 1 endwhile endif return filepath endfunction " Function : EnumerateFilesByExtension (PRIVATE) " Purpose : enumerates all files by a particular list of alternate extensions. " Args : path -- path of a file (not including the file) " baseName -- base name of the file to be expanded " extension -- extension whose alternates are to be enumerated " Returns : comma separated list of files with extensions " Author : Michael Sharpe function! EnumerateFilesByExtension(path, baseName, extension) let enumeration = "" let extSpec = "" silent! let extSpec = g:alternateExtensions_{a:extension} if (extSpec != "") let n = 1 let done = 0 while (!done) let ext = GetNthItemFromList(extSpec, n) if (ext != "") if (a:path != "") let newFilename = a:path . "/" . a:baseName . "." . ext else let newFilename = a:baseName . "." . ext endif if (enumeration == "") let enumeration = newFilename else let enumeration = enumeration . "," . newFilename endif else let done = 1 endif let n = n + 1 endwhile endif return enumeration endfunction " Function : EnumerateFilesByExtensionInPath (PRIVATE) " Purpose : enumerates all files by expanding the path list and the extension " list. " Args : baseName -- base name of the file " extension -- extension whose alternates are to be enumerated " pathList -- the list of paths to enumerate " relPath -- the path of the current file for expansion of relative " paths in the path list. " Returns : A comma separated list of paths with extensions " Author : Michael Sharpe function! EnumerateFilesByExtensionInPath(baseName, extension, pathList, relPathBase) let enumeration = "" let filepath = "" let m = 1 let pathListLen = strlen(a:pathList) if (pathListLen > 0) while (1) let pathSpec = GetNthItemFromList(a:pathList, m) if (pathSpec != "") let path = ExpandAlternatePath(pathSpec, a:relPathBase) let pe = EnumerateFilesByExtension(path, a:baseName, a:extension) if (enumeration == "") let enumeration = pe else let enumeration = enumeration . "," . pe endif else break endif let m = m + 1 endwhile endif return enumeration endfunction " Function : DetermineExtension (PRIVATE) " Purpose : Determines the extension of a filename based on the register " alternate extension. This allow extension which contain dots to " be considered. E.g. foo.aspx.cs to foo.aspx where an alternate " exists for the aspx.cs extension. Note that this will only accept " extensions which contain less than 5 dots. This is only " implemented in this manner for simplicity...it is doubtful that " this will be a restriction in non-contrived situations. " Args : The path to the file to find the extension in " Returns : The matched extension if any " Author : Michael Sharpe (feline@irendi.com) " History : idea from Tom-Erik Duestad " Notes : there is some magic occuring here. The exists() function does not " work well when the curly brace variable has dots in it. And why " should it, dots are no valid in variable names. But the exists " function is wierd too. Lets say foo_c does exist. Then " exists("foo_c.e.f") will be true...even though the variable does " not exist. However the curly brace variables do work when the " variable has dots in it. E.g foo_{'c'} is different from " foo_{'c.d.e'}...and foo_{'c'} is identical to foo_c and " foo_{'c.d.e'} is identical to foo_c.d.e right? Yes in the current " implementation of vim. To trick vim to test for existence of such " variables echo the curly brace variable and look for an error " message. function! DetermineExtension(path) let extension = expand("%:t:e") let v:errmsg = "" silent! echo g:alternateExtensions_{extension} if (v:errmsg != "") let extension = expand("%:t:e:e") let v:errmsg = "" silent! echo g:alternateExtensions_{extension} if (v:errmsg != "") let extension = expand("%:t:e:e:e") let v:errmsg = "" silent! echo g:alternateExtensions_{extension} if (v:errmsg != "") let extension = expand("%:t:e:e:e:e") let v:errmsg = "" silent! echo g:alternateExtensions_{extension} if (v:errmsg != "") let extension = expand("%:t:e:e:e:e:e") let v:errmsg = "" silent! echo g:alternateExtensions_{extension} if (v:errmsg != "") let extension = "" endif endif endif endif endif return extension endfunction " Function : AlternateFile (PUBLIC) " Purpose : Opens a new buffer by looking at the extension of the current " buffer and finding the corresponding file. E.g. foo.c <--> foo.h " Args : accepts one argument. If present it used the argument as the new " extension. " Returns : nothing " Author : Michael Sharpe " History : + When an alternate can't be found in the same directory as the " source file, a search path will be traversed looking for the " alternates. " + Moved some code into a separate function, minor optimization " + rework to favor files in memory based on complete enumeration of " all files extensions and paths function! AlternateFile(splitWindow, ...) let extension = DetermineExtension(expand("%:p")) let baseName = substitute(expand("%:t"), "\." . extension . '$', "", "") let currentPath = expand("%:p:h") let newFullname = "" if (a:0 != 0) let newFullname = baseName . "." . a:1 else let allfiles = "" if (extension != "") let allfiles1 = EnumerateFilesByExtension("", baseName, extension) let allfiles2 = EnumerateFilesByExtensionInPath(baseName, extension, g:alternateSearchPath, currentPath) if (allfiles1 != "") if (allfiles2 != "") let allfiles = allfiles1 . ',' . allfiles2 else let allfiles = allfiles1 endif else let allfiles = allfiles2 endif endif if (allfiles != "") let bestFile = "" let bestScore = 0 let score = 0 let n = 1 let onefile = GetNthItemFromList(allfiles, n) let bestFile = onefile while (onefile != "" && score < 2) let score = BufferOrFileExists(onefile) if (score > bestScore) let bestScore = score let bestFile = onefile endif let n = n + 1 let onefile = GetNthItemFromList(allfiles, n) endwhile call FindOrCreateBuffer(bestFile, a:splitWindow) else echo "No alternate file available" endif endif endfunction comm! -nargs=? -bang A call AlternateFile("n", ) comm! -nargs=? -bang AS call AlternateFile("h", ) comm! -nargs=? -bang AV call AlternateFile("v", ) " Function : BufferOrFileExists (PRIVATE) " Purpose : determines if a buffer or a readable file exists " Args : fileName (IN) - name of the file to check " Returns : 2 if it exists in memory, 1 if it exists, 0 otherwise " Author : Michael Sharpe " History : Updated code to handle buffernames using just the " filename and not the path. function! BufferOrFileExists(fileName) let result = 0 let bufName = fnamemodify(a:fileName,":t") let memBufName = bufname(bufName) if (memBufName != "") let memBufBasename = fnamemodify(memBufName, ":t") if (bufName == memBufBasename) let result = 2 endif endif if (!result) let result = bufexists(bufName) || bufexists(a:fileName) || filereadable(a:fileName) endif return result endfunction " Function : FindOrCreateBuffer (PRIVATE) " Purpose : searches the buffer list (:ls) for the specified filename. If " found, checks the window list for the buffer. If the buffer is in " an already open window, it switches to the window. If the buffer " was not in a window, it switches to that buffer. If the buffer did " not exist, it creates it. " Args : filename (IN) -- the name of the file " doSplit (IN) -- indicates whether the window should be split " ("v", "h", "n", "v!", "h!", "n!") " Returns : nothing " Author : Michael Sharpe " History : + bufname() was not working very well with the possibly strange " paths that can abound with the search path so updated this " slightly. -- Bindu " + updated window switching code to make it more efficient -- Bindu " Allow ! to be applied to buffer/split/editing commands for more " vim/vi like consistency " + implemented fix from Matt Perry function! FindOrCreateBuffer(filename, doSplit) " Check to see if the buffer is already open before re-opening it. let bufName = bufname(a:filename) let bufFilename = fnamemodify(a:filename,":t") if (bufName == "") let bufName = bufname(bufFilename) endif if (bufName != "") let tail = fnamemodify(bufName, ":t") if (tail != bufFilename) let bufName = "" endif endif let splitType = a:doSplit[0] let bang = a:doSplit[1] if (bufName == "") " Buffer did not exist....create it let v:errmsg="" if (splitType == "h") silent! execute ":split".bang." " . a:filename elseif (splitType == "v") silent! execute ":vsplit".bang." " . a:filename else silent! execute ":e".bang." " . a:filename endif if (v:errmsg != "") echo v:errmsg endif else " Buffer was already open......check to see if it is in a window let bufWindow = bufwinnr(bufName) if (bufWindow == -1) " Buffer was not in a window so open one let v:errmsg="" if (splitType == "h") silent! execute ":sbuffer".bang." " . bufName elseif (splitType == "v") silent! execute ":vert sbuffer " . bufName else silent! execute ":buffer".bang." " . bufName endif if (v:errmsg != "") echo v:errmsg endif else " Buffer is already in a window so switch to the window execute bufWindow."wincmd w" if (bufWindow != winnr()) " something wierd happened...open the buffer let v:errmsg="" if (splitType == "h") silent! execute ":split".bang." " . bufName elseif (splitType == "v") silent! execute ":vsplit".bang." " . bufName else silent! execute ":e".bang." " . bufName endif if (v:errmsg != "") echo v:errmsg endif endif endif endif endfunction