1 " Vim filetype plugin file
2 " Language: generic Changelog file
3 " Maintainer: Nikolai Weibull <now@bitwi.se>
4 " Latest Revision: 2011-05-02
6 " g:changelog_timeformat (deprecated: use g:changelog_dateformat instead) -
7 " description: the timeformat used in ChangeLog entries.
9 " g:changelog_dateformat -
10 " description: the format sent to strftime() to generate a date string.
11 " default: "%Y-%m-%d".
12 " g:changelog_username -
13 " description: the username to use in ChangeLog entries
14 " default: try to deduce it from environment variables and system files.
17 " adds a new changelog entry for the current user for the current date.
20 " switches to the ChangeLog buffer opened for the current directory, or
21 " opens it in a new buffer if it exists in the current directory. Then
22 " it does the same as the local <Leader>o described above.
24 " run 'runtime ftplugin/changelog.vim' to enable the global mapping for
27 " should we perhaps open the ChangeLog file even if it doesn't exist already?
28 " Problem is that you might end up with ChangeLog files all over the place.
30 " If 'filetype' isn't "changelog", we must have been to add ChangeLog opener
31 if &filetype == 'changelog'
32 if exists('b:did_ftplugin')
35 let b:did_ftplugin = 1
40 " Set up the format used for dates.
41 if !exists('g:changelog_dateformat')
42 if exists('g:changelog_timeformat')
43 let g:changelog_dateformat = g:changelog_timeformat
45 let g:changelog_dateformat = "%Y-%m-%d"
49 function! s:username()
50 if exists('g:changelog_username')
51 return g:changelog_username
54 elseif $EMAIL_ADDRESS != ""
59 return printf('%s <%s@%s>', s:name(login), login, s:hostname())
63 return s:trimmed_system_with_default('whoami', 'unknown')
66 function! s:trimmed_system_with_default(command, default)
67 return s:first_line(s:system_with_default(a:command, a:default))
70 function! s:system_with_default(command, default)
71 let output = system(a:command)
78 function! s:first_line(string)
79 return substitute(a:string, '\n.*$', "", "")
82 function! s:name(login)
83 for name in [s:gecos_name(a:login), $NAME, s:capitalize(a:login)]
90 function! s:gecos_name(login)
91 for line in s:try_reading_file('/etc/passwd')
92 if line =~ '^' . a:login . ':'
93 return substitute(s:passwd_field(line, 5), '&', s:capitalize(a:login), "")
99 function! s:try_reading_file(path)
101 return readfile(a:path)
107 function! s:passwd_field(line, field)
108 let fields = split(a:line, ':', 1)
109 if len(fields) < field
112 return fields[field - 1]
115 function! s:capitalize(word)
116 return toupper(a:word[0]) . strpart(a:word, 1)
119 function! s:hostname()
120 return s:trimmed_system_with_default('hostname', 'localhost')
123 " Format used for new date entries.
124 if !exists('g:changelog_new_date_format')
125 let g:changelog_new_date_format = "%d %u\n\n\t* %c\n\n"
128 " Format used for new entries to current date entry.
129 if !exists('g:changelog_new_entry_format')
130 let g:changelog_new_entry_format = "\t* %c"
133 " Regular expression used to find a given date entry.
134 if !exists('g:changelog_date_entry_search')
135 let g:changelog_date_entry_search = '^\s*%d\_s*%u'
138 " Regular expression used to find the end of a date entry
139 if !exists('g:changelog_date_end_entry_search')
140 let g:changelog_date_end_entry_search = '^\s*$'
144 " Substitutes specific items in new date-entry formats and search strings.
145 " Can be done with substitute of course, but unclean, and need \@! then.
146 function! s:substitute_items(str, date, user)
148 let middles = {'%': '%', 'd': a:date, 'u': a:user, 'c': '{cursor}'}
149 let i = stridx(str, '%')
152 if has_key(middles, str[i + 1])
153 let mid = middles[str[i + 1]]
154 let str = strpart(str, 0, i) . mid . strpart(str, i + 2)
155 let inc = strlen(mid)
157 let i = stridx(str, '%', i + 1 + inc)
162 " Position the cursor once we've done all the funky substitution.
163 function! s:position_cursor()
164 if search('{cursor}') > 0
166 let line = getline(lnum)
167 let cursor = stridx(line, '{cursor}')
168 call setline(lnum, substitute(line, '{cursor}', '', ''))
173 " Internal function to create a new entry in the ChangeLog.
174 function! s:new_changelog_entry()
175 " Deal with 'paste' option.
176 let save_paste = &paste
179 " Look for an entry for today by our user.
180 let date = strftime(g:changelog_dateformat)
181 let search = s:substitute_items(g:changelog_date_entry_search, date,
183 if search(search) > 0
184 " Ok, now we look for the end of the date entry, and add an entry.
185 call cursor(nextnonblank(line('.') + 1), 1)
186 if search(g:changelog_date_end_entry_search, 'W') > 0
187 let p = (line('.') == line('$')) ? line('.') : line('.') - 1
191 let ls = split(s:substitute_items(g:changelog_new_entry_format, '', ''),
194 call cursor(p + 1, 1)
196 " Flag for removing empty lines at end of new ChangeLogs.
197 let remove_empty = line('$') == 1
199 " No entry today, so create a date-user header and insert an entry.
200 let todays_entry = s:substitute_items(g:changelog_new_date_format,
201 \ date, s:username())
202 " Make sure we have a cursor positioning.
203 if stridx(todays_entry, '{cursor}') == -1
204 let todays_entry = todays_entry . '{cursor}'
208 call append(0, split(todays_entry, '\n'))
210 " Remove empty lines at end of file.
215 " Reposition cursor once we're done.
219 call s:position_cursor()
221 " And reset 'paste' option
222 let &paste = save_paste
225 if exists(":NewChangelogEntry") != 2
226 noremap <buffer> <silent> <Leader>o <Esc>:call <SID>new_changelog_entry()<CR>
227 command! -nargs=0 NewChangelogEntry call s:new_changelog_entry()
230 let b:undo_ftplugin = "setl com< fo< et< ai<"
233 setlocal formatoptions+=t
238 setlocal textwidth=78
239 let b:undo_ftplugin .= " tw<"
242 let &cpo = s:cpo_save
245 let s:cpo_save = &cpo
248 " Add the Changelog opening mapping
249 nnoremap <silent> <Leader>o :call <SID>open_changelog()<CR>
251 function! s:open_changelog()
252 let path = expand('%:p:h')
253 if exists('b:changelog_path')
254 let changelog = b:changelog_path
256 if exists('b:changelog_name')
257 let name = b:changelog_name
259 let name = 'ChangeLog'
261 while isdirectory(path)
262 let changelog = path . '/' . name
263 if filereadable(changelog)
266 let parent = substitute(path, '/\+[^/]*$', "", "")
273 if !filereadable(changelog)
277 if exists('b:changelog_entry_prefix')
278 let prefix = call(b:changelog_entry_prefix, [])
280 let prefix = substitute(strpart(expand('%:p'), strlen(path)), '^/\+', "", "") . ':'
283 let prefix = ' ' . prefix
286 let buf = bufnr(changelog)
288 if bufwinnr(buf) != -1
289 execute bufwinnr(buf) . 'wincmd w'
291 execute 'sbuffer' buf
294 execute 'split' fnameescape(changelog)
297 call s:new_changelog_entry(prefix)
300 let &cpo = s:cpo_save