|
7
|
1 " Vim filetype plugin file
|
|
375
|
2 " Language: generic Changelog file
|
|
|
3 " Maintainer: Nikolai Weibull <nikolai+work.vim@bitwi.se>
|
|
|
4 " Latest Revision: 2005-06-29
|
|
7
|
5 " Variables:
|
|
|
6 " g:changelog_timeformat -
|
|
375
|
7 " description: the timeformat used in ChangeLog entries.
|
|
|
8 " default: "%Y-%m-%d".
|
|
7
|
9 " g:changelog_username -
|
|
375
|
10 " description: the username to use in ChangeLog entries
|
|
|
11 " default: try to deduce it from environment variables and system files.
|
|
7
|
12 " Local Mappings:
|
|
|
13 " <Leader>o -
|
|
375
|
14 " adds a new changelog entry for the current user for the current date.
|
|
7
|
15 " Global Mappings:
|
|
|
16 " <Leader>o -
|
|
375
|
17 " switches to the ChangeLog buffer opened for the current directory, or
|
|
|
18 " opens it in a new buffer if it exists in the current directory. Then
|
|
|
19 " it does the same as the local <Leader>o described above.
|
|
7
|
20 " Notes:
|
|
|
21 " run 'runtime ftplugin/changelog.vim' to enable the global mapping for
|
|
|
22 " changelog files.
|
|
|
23 " TODO:
|
|
|
24 " should we perhaps open the ChangeLog file even if it doesn't exist already?
|
|
|
25 " Problem is that you might end up with ChangeLog files all over the place.
|
|
|
26
|
|
|
27 " If 'filetype' isn't "changelog", we must have been to add ChangeLog opener
|
|
|
28 if &filetype == "changelog"
|
|
|
29 if exists("b:did_ftplugin")
|
|
|
30 finish
|
|
|
31 endif
|
|
|
32 let b:did_ftplugin = 1
|
|
|
33
|
|
375
|
34 let s:cpo_save = &cpo
|
|
|
35 set cpo&vim
|
|
7
|
36
|
|
|
37 " The format of the date-time field (should have been called dateformat)
|
|
|
38 if !exists("g:changelog_timeformat")
|
|
|
39 let g:changelog_timeformat = "%Y-%m-%d"
|
|
|
40 endif
|
|
|
41
|
|
|
42 " Try to figure out a reasonable username of the form:
|
|
|
43 " Full Name <user@host>
|
|
|
44 if !exists("g:changelog_username")
|
|
|
45 if exists("$EMAIL_ADDRESS")
|
|
|
46 let g:changelog_username = $EMAIL_ADDRESS
|
|
|
47 elseif exists("$EMAIL")
|
|
|
48 let g:changelog_username = $EMAIL
|
|
|
49 else
|
|
|
50 " Get the users login name
|
|
|
51 let login = system('whoami')
|
|
|
52 if v:shell_error
|
|
375
|
53 let login = 'unknown'
|
|
7
|
54 else
|
|
375
|
55 let newline = stridx(login, "\n")
|
|
|
56 if newline != -1
|
|
|
57 let login = strpart(login, 0, newline)
|
|
|
58 endif
|
|
7
|
59 endif
|
|
|
60
|
|
|
61 " Try to full name from gecos field in /etc/passwd
|
|
|
62 if filereadable('/etc/passwd')
|
|
375
|
63 let name = substitute(
|
|
|
64 \system('cat /etc/passwd | grep ^`whoami`'),
|
|
|
65 \'^\%([^:]*:\)\{4}\([^:]*\):.*$', '\1', '')
|
|
7
|
66 endif
|
|
|
67
|
|
|
68 " If there is no such file, or there was some other problem try
|
|
|
69 " others
|
|
|
70 if !filereadable('/etc/passwd') || v:shell_error
|
|
375
|
71 " Maybe the environment has something of interest
|
|
|
72 if exists("$NAME")
|
|
|
73 let name = $NAME
|
|
|
74 else
|
|
|
75 " No? well, use the login name and capitalize first
|
|
|
76 " character
|
|
|
77 let name = toupper(login[0]) . strpart(login, 1)
|
|
|
78 endif
|
|
7
|
79 endif
|
|
|
80
|
|
|
81 " Only keep stuff before the first comma
|
|
|
82 let comma = stridx(name, ',')
|
|
|
83 if comma != -1
|
|
375
|
84 let name = strpart(name, 0, comma)
|
|
7
|
85 endif
|
|
|
86
|
|
|
87 " And substitute & in the real name with the login of our user
|
|
|
88 let amp = stridx(name, '&')
|
|
|
89 if amp != -1
|
|
375
|
90 let name = strpart(name, 0, amp) . toupper(login[0]) .
|
|
|
91 \strpart(login, 1) . strpart(name, amp + 1)
|
|
7
|
92 endif
|
|
|
93
|
|
|
94 " Get our hostname
|
|
|
95 let hostname = system("hostname")
|
|
|
96 if v:shell_error
|
|
375
|
97 let hostname = 'unknownhost'
|
|
7
|
98 else
|
|
375
|
99 let newline = stridx(hostname, "\n")
|
|
|
100 if newline != -1
|
|
|
101 let hostname = strpart(hostname, 0, newline)
|
|
|
102 endif
|
|
7
|
103 endif
|
|
|
104
|
|
|
105 " And finally set the username
|
|
|
106 let g:changelog_username = name.' <'.login.'@'.hostname.'>'
|
|
|
107 endif
|
|
|
108 endif
|
|
|
109
|
|
|
110 " Format used for new date-entries
|
|
|
111 if !exists("g:changelog_new_date_format")
|
|
|
112 let g:changelog_new_date_format = "%d %u\n\n\t* %c\n\n"
|
|
|
113 endif
|
|
|
114
|
|
|
115 " Format used for new entries to current date-entry
|
|
|
116 if !exists("g:changelog_new_entry_format")
|
|
|
117 let g:changelog_new_entry_format = "\t* %c"
|
|
|
118 endif
|
|
|
119
|
|
|
120 if !exists("g:changelog_date_entry_search")
|
|
|
121 let g:changelog_date_entry_search = '^\s*%d\_s*%u'
|
|
|
122 endif
|
|
|
123
|
|
|
124 " Substitutes specific items in new date-entry formats and search strings
|
|
|
125 " Can be done with substitute of course, but unclean, and need \@! then
|
|
|
126 function! s:substitute_items(str, date, user)
|
|
|
127 let str = a:str
|
|
|
128 let i = stridx(str, '%')
|
|
|
129 while i != -1
|
|
|
130 let char = str[i + 1]
|
|
|
131 if char == '%'
|
|
375
|
132 let middle = '%'
|
|
7
|
133 elseif char == 'd'
|
|
375
|
134 let middle = a:date
|
|
7
|
135 elseif char == 'u'
|
|
375
|
136 let middle = a:user
|
|
7
|
137 elseif char == 'c'
|
|
375
|
138 let middle = '{cursor}'
|
|
7
|
139 else
|
|
375
|
140 let middle = char
|
|
7
|
141 endif
|
|
|
142 let str = strpart(str, 0, i) . middle . strpart(str, i + 2)
|
|
|
143 let i = stridx(str, '%')
|
|
|
144 endwhile
|
|
|
145 return str
|
|
|
146 endfunction
|
|
|
147
|
|
|
148 function! s:position_cursor()
|
|
|
149 if search('{cursor}') > 0
|
|
|
150 let pos = line('.')
|
|
|
151 let line = getline(pos)
|
|
|
152 let cursor = stridx(line, '{cursor}')
|
|
|
153 call setline(pos, substitute(line, '{cursor}', '', ''))
|
|
|
154 endif
|
|
|
155 startinsert!
|
|
|
156 endfunction
|
|
|
157
|
|
|
158 " Internal function to create a new entry in the ChangeLog
|
|
|
159 function! s:new_changelog_entry()
|
|
|
160 " Deal with 'paste' option
|
|
|
161 let save_paste = &paste
|
|
|
162 let &paste = 1
|
|
|
163 1
|
|
|
164 " Look for an entry for today by our user
|
|
|
165 let date = strftime(g:changelog_timeformat)
|
|
|
166 let search = s:substitute_items(g:changelog_date_entry_search, date,
|
|
375
|
167 \g:changelog_username)
|
|
7
|
168 if search(search) > 0
|
|
|
169 " Ok, now we look for the end of the date-entry, and add an entry
|
|
|
170 let pos = nextnonblank(line('.') + 1)
|
|
|
171 let line = getline(pos)
|
|
|
172 while line =~ '^\s\+\S\+'
|
|
375
|
173 let pos = pos + 1
|
|
|
174 let line = getline(pos)
|
|
7
|
175 endwhile
|
|
|
176 let insert = s:substitute_items(g:changelog_new_entry_format,
|
|
375
|
177 \'', '')
|
|
7
|
178 execute "normal! ".(pos - 1)."Go".insert
|
|
|
179 execute pos
|
|
|
180 else
|
|
|
181 " Flag for removing empty lines at end of new ChangeLogs
|
|
|
182 let remove_empty = line('$') == 1
|
|
|
183
|
|
|
184 " No entry today, so create a date-user header and insert an entry
|
|
|
185 let todays_entry = s:substitute_items(g:changelog_new_date_format,
|
|
375
|
186 \date, g:changelog_username)
|
|
7
|
187 " Make sure we have a cursor positioning
|
|
|
188 if stridx(todays_entry, '{cursor}') == -1
|
|
375
|
189 let todays_entry = todays_entry.'{cursor}'
|
|
7
|
190 endif
|
|
|
191
|
|
|
192 " Now do the work
|
|
|
193 execute "normal! i".todays_entry
|
|
|
194 if remove_empty
|
|
375
|
195 while getline('$') == ''
|
|
|
196 $delete
|
|
|
197 endwhile
|
|
7
|
198 endif
|
|
|
199
|
|
|
200 1
|
|
|
201 endif
|
|
|
202
|
|
|
203 call s:position_cursor()
|
|
|
204
|
|
|
205 " And reset 'paste' option
|
|
|
206 let &paste = save_paste
|
|
|
207 endfunction
|
|
|
208
|
|
|
209 if exists(":NewChangelogEntry") != 2
|
|
|
210 map <buffer> <silent> <Leader>o <Esc>:call <SID>new_changelog_entry()<CR>
|
|
|
211 command! -nargs=0 NewChangelogEntry call s:new_changelog_entry()
|
|
|
212 endif
|
|
|
213
|
|
375
|
214 let b:undo_ftplugin = "setl com< tw< fo< et< ai<"
|
|
7
|
215
|
|
|
216 if &textwidth == 0
|
|
|
217 setlocal textwidth=78
|
|
|
218 endif
|
|
|
219 setlocal comments=
|
|
|
220 setlocal formatoptions+=t
|
|
|
221 setlocal noexpandtab
|
|
375
|
222 setlocal autoindent
|
|
7
|
223
|
|
375
|
224 let &cpo = s:cpo_save
|
|
|
225 unlet s:cpo_save
|
|
7
|
226 else
|
|
|
227 " Add the Changelog opening mapping
|
|
|
228 nmap <silent> <Leader>o :call <SID>open_changelog()<CR>
|
|
|
229
|
|
|
230 function! s:open_changelog()
|
|
|
231 if filereadable('ChangeLog')
|
|
|
232 if bufloaded('ChangeLog')
|
|
375
|
233 let buf = bufnr('ChangeLog')
|
|
|
234 execute "normal! \<C-W>t"
|
|
|
235 while winbufnr(winnr()) != buf
|
|
|
236 execute "normal! \<C-W>w"
|
|
|
237 endwhile
|
|
7
|
238 else
|
|
375
|
239 split ChangeLog
|
|
7
|
240 endif
|
|
|
241
|
|
|
242 if exists("g:mapleader")
|
|
375
|
243 execute "normal " . g:mapleader . "o"
|
|
7
|
244 else
|
|
375
|
245 execute "normal \\o"
|
|
7
|
246 endif
|
|
|
247 startinsert!
|
|
|
248 endif
|
|
|
249 endfunction
|
|
|
250 endif
|
