blob: 360f7e6cec6e4ad19766a5f75eecca7d4b9893a2 [file] [log] [blame]
Bram Moolenaarf193fff2006-04-27 00:02:13 +00001" Vim OMNI completion script for SQL
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002" Language: SQL
Bram Moolenaar5c736222010-01-06 20:54:52 +01003" Maintainer: David Fishburn <dfishburn dot vim at gmail dot com>
Bram Moolenaardb7207e2012-02-22 17:30:19 +01004" Version: 12.0
5" Last Change: 2012 Feb 08
Bram Moolenaarf193fff2006-04-27 00:02:13 +00006" Usage: For detailed help
Bram Moolenaardb7207e2012-02-22 17:30:19 +01007" ":help sql.txt"
8" or ":help ft-sql-omni"
Bram Moolenaarf193fff2006-04-27 00:02:13 +00009" or read $VIMRUNTIME/doc/sql.txt
Bram Moolenaare2f98b92006-03-29 21:18:24 +000010
Bram Moolenaar5c736222010-01-06 20:54:52 +010011" History
Bram Moolenaardb7207e2012-02-22 17:30:19 +010012" Version 12.0
13" - Partial column name completion did not work when a table
14" name or table alias was provided (Jonas Enberg).
15" - Improved the handling of column completion. First we match any
16" columns from a previous completion. If not matches are found, we
17" consider the partial name to be a table or table alias for the
18" query and attempt to match on it.
19"
20" Version 11.0
21" Added g:omni_sql_default_compl_type variable
22" - You can specify which type of completion to default to
23" when pressing <C-X><C-O>. The entire list of available
24" choices can be found in the calls to sqlcomplete#Map in:
25" ftplugin/sql.vim
26"
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +020027" Version 10.0
Bram Moolenaardb7207e2012-02-22 17:30:19 +010028" Updated PreCacheSyntax()
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +020029" - Now returns a List of the syntax items it finds.
30" This allows other plugins / scripts to use this list for their own
31" purposes. In this case XPTemplate can use them for a Choose list.
32" - Verifies the parameters are the correct type and displays a
33" warning if not.
34" - Verifies the parameters are the correct type and displays a
35" warning if not.
Bram Moolenaardb7207e2012-02-22 17:30:19 +010036" Updated SQLCWarningMsg()
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +020037" - Prepends warning message with SQLComplete so you know who issued
38" the warning.
Bram Moolenaardb7207e2012-02-22 17:30:19 +010039" Updated SQLCErrorMsg()
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +020040" - Prepends error message with SQLComplete so you know who issued
41" the error.
Bram Moolenaardb7207e2012-02-22 17:30:19 +010042"
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043" Version 9.0
44" This change removes some of the support for tables with spaces in their
Bram Moolenaardb7207e2012-02-22 17:30:19 +010045" names in order to simplify the regexes used to pull out query table
Bram Moolenaar00a927d2010-05-14 23:24:24 +020046" aliases for more robust table name and column name code completion.
47" Full support for "table names with spaces" can be added in again
48" after 7.3.
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +020049"
Bram Moolenaar00a927d2010-05-14 23:24:24 +020050" Version 8.0
Bram Moolenaardb7207e2012-02-22 17:30:19 +010051" Incorrectly re-executed the g:ftplugin_sql_omni_key_right and g:ftplugin_sql_omni_key_left
Bram Moolenaar00a927d2010-05-14 23:24:24 +020052" when drilling in and out of a column list for a table.
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +020053"
Bram Moolenaar5c736222010-01-06 20:54:52 +010054" Version 7.0
55" Better handling of object names
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +020056"
Bram Moolenaar5c736222010-01-06 20:54:52 +010057" Version 6.0
58" Supports object names with spaces "my table name"
59"
Bram Moolenaare2f98b92006-03-29 21:18:24 +000060" Set completion with CTRL-X CTRL-O to autoloaded function.
61" This check is in place in case this script is
Bram Moolenaardb7207e2012-02-22 17:30:19 +010062" sourced directly instead of using the autoload feature.
Bram Moolenaare2f98b92006-03-29 21:18:24 +000063if exists('&omnifunc')
64 " Do not set the option if already set since this
65 " results in an E117 warning.
66 if &omnifunc == ""
67 setlocal omnifunc=sqlcomplete#Complete
68 endif
69endif
70
71if exists('g:loaded_sql_completion')
Bram Moolenaardb7207e2012-02-22 17:30:19 +010072 finish
Bram Moolenaare2f98b92006-03-29 21:18:24 +000073endif
Bram Moolenaardb7207e2012-02-22 17:30:19 +010074let g:loaded_sql_completion = 120
Bram Moolenaare2f98b92006-03-29 21:18:24 +000075
76" Maintains filename of dictionary
Bram Moolenaar910f66f2006-04-05 20:41:53 +000077let s:sql_file_table = ""
78let s:sql_file_procedure = ""
79let s:sql_file_view = ""
Bram Moolenaare2f98b92006-03-29 21:18:24 +000080
81" Define various arrays to be used for caching
Bram Moolenaar910f66f2006-04-05 20:41:53 +000082let s:tbl_name = []
83let s:tbl_alias = []
84let s:tbl_cols = []
85let s:syn_list = []
86let s:syn_value = []
Bram Moolenaardb7207e2012-02-22 17:30:19 +010087
Bram Moolenaare2f98b92006-03-29 21:18:24 +000088" Used in conjunction with the syntaxcomplete plugin
Bram Moolenaar910f66f2006-04-05 20:41:53 +000089let s:save_inc = ""
90let s:save_exc = ""
Bram Moolenaare2f98b92006-03-29 21:18:24 +000091if exists('g:omni_syntax_group_include_sql')
92 let s:save_inc = g:omni_syntax_group_include_sql
93endif
94if exists('g:omni_syntax_group_exclude_sql')
95 let s:save_exc = g:omni_syntax_group_exclude_sql
96endif
Bram Moolenaardb7207e2012-02-22 17:30:19 +010097
Bram Moolenaare2f98b92006-03-29 21:18:24 +000098" Used with the column list
Bram Moolenaar910f66f2006-04-05 20:41:53 +000099let s:save_prev_table = ""
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000100
101" Default the option to verify table alias
102if !exists('g:omni_sql_use_tbl_alias')
103 let g:omni_sql_use_tbl_alias = 'a'
104endif
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000105" Default syntax items to precache
106if !exists('g:omni_sql_precache_syntax_groups')
107 let g:omni_sql_precache_syntax_groups = [
108 \ 'syntax',
109 \ 'sqlKeyword',
110 \ 'sqlFunction',
111 \ 'sqlOption',
112 \ 'sqlType',
113 \ 'sqlStatement'
114 \ ]
115endif
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000116" Set ignorecase to the ftplugin standard
117if !exists('g:omni_sql_ignorecase')
118 let g:omni_sql_ignorecase = &ignorecase
119endif
120" During table completion, should the table list also
121" include the owner name
122if !exists('g:omni_sql_include_owner')
123 let g:omni_sql_include_owner = 0
124 if exists('g:loaded_dbext')
125 if g:loaded_dbext >= 300
126 " New to dbext 3.00, by default the table lists include the owner
127 " name of the table. This is used when determining how much of
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100128 " whatever has been typed should be replaced as part of the
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000129 " code replacement.
130 let g:omni_sql_include_owner = 1
131 endif
132 endif
133endif
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100134" Default type of completion used when <C-X><C-O> is pressed
135if !exists('g:omni_sql_default_compl_type')
136 let g:omni_sql_default_compl_type = 'table'
137endif
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000138
139" This function is used for the 'omnifunc' option.
140function! sqlcomplete#Complete(findstart, base)
141
142 " Default to table name completion
143 let compl_type = 'table'
144 " Allow maps to specify what type of object completion they want
145 if exists('b:sql_compl_type')
146 let compl_type = b:sql_compl_type
147 endif
148
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000149 " First pass through this function determines how much of the line should
150 " be replaced by whatever is chosen from the completion list
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000151 if a:findstart
152 " Locate the start of the item, including "."
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000153 let line = getline('.')
154 let start = col('.') - 1
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000155 let lastword = -1
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000156 let begindot = 0
157 " Check if the first character is a ".", for column completion
158 if line[start - 1] == '.'
159 let begindot = 1
160 endif
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000161 while start > 0
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100162 " Additional code was required to handle objects which
Bram Moolenaar5c736222010-01-06 20:54:52 +0100163 " can contain spaces like "my table name".
164 if line[start - 1] !~ '\(\w\|\.\)'
165 " If the previous character is not a period or word character
166 break
167 " elseif line[start - 1] =~ '\(\w\|\s\+\)'
168 " let start -= 1
169 elseif line[start - 1] =~ '\w'
170 " If the previous character is word character continue back
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000171 let start -= 1
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100172 elseif line[start - 1] =~ '\.' &&
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000173 \ compl_type =~ 'column\|table\|view\|procedure'
Bram Moolenaar5c736222010-01-06 20:54:52 +0100174 " If the previous character is a period and we are completing
175 " an object which can be specified with a period like this:
176 " table_name.column_name
177 " owner_name.table_name
178
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000179 " If lastword has already been set for column completion
180 " break from the loop, since we do not also want to pickup
181 " a table name if it was also supplied.
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100182 if lastword != -1 && compl_type == 'column'
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000183 break
184 endif
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000185 " If column completion was specified stop at the "." if
186 " a . was specified, otherwise, replace all the way up
187 " to the owner name (if included).
188 if lastword == -1 && compl_type == 'column' && begindot == 1
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000189 let lastword = start
190 endif
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000191 " If omni_sql_include_owner = 0, do not include the table
192 " name as part of the substitution, so break here
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100193 if lastword == -1 &&
194 \ compl_type =~ 'table\|view\|procedure\column_csv' &&
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000195 \ g:omni_sql_include_owner == 0
196 let lastword = start
197 break
198 endif
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000199 let start -= 1
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000200 else
201 break
202 endif
203 endwhile
204
205 " Return the column of the last word, which is going to be changed.
206 " Remember the text that comes before it in s:prepended.
207 if lastword == -1
208 let s:prepended = ''
209 return start
210 endif
211 let s:prepended = strpart(line, start, lastword - start)
212 return lastword
213 endif
214
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000215 " Second pass through this function will determine what data to put inside
216 " of the completion list
217 " s:prepended is set by the first pass
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000218 let base = s:prepended . a:base
219
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000220 " Default the completion list to an empty list
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000221 let compl_list = []
222
223 " Default to table name completion
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100224 let compl_type = g:omni_sql_default_compl_type
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000225 " Allow maps to specify what type of object completion they want
226 if exists('b:sql_compl_type')
227 let compl_type = b:sql_compl_type
228 unlet b:sql_compl_type
229 endif
230
231 if compl_type == 'tableReset'
232 let compl_type = 'table'
233 let base = ''
234 endif
235
236 if compl_type == 'table' ||
237 \ compl_type == 'procedure' ||
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100238 \ compl_type == 'view'
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000239
240 " This type of completion relies upon the dbext.vim plugin
241 if s:SQLCCheck4dbext() == -1
242 return []
243 endif
244
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000245 " Allow the user to override the dbext plugin to specify whether
246 " the owner/creator should be included in the list
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000247 if g:loaded_dbext >= 300
248 let saveSetting = DB_listOption('dict_show_owner')
249 exec 'DBSetOption dict_show_owner='.(g:omni_sql_include_owner==1?'1':'0')
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000250 endif
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000251
252 let compl_type_uc = substitute(compl_type, '\w\+', '\u&', '')
Bram Moolenaar5c736222010-01-06 20:54:52 +0100253 " Same call below, no need to do it twice
254 " if s:sql_file_{compl_type} == ""
255 " let s:sql_file_{compl_type} = DB_getDictionaryName(compl_type_uc)
256 " endif
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000257 let s:sql_file_{compl_type} = DB_getDictionaryName(compl_type_uc)
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000258 if s:sql_file_{compl_type} != ""
259 if filereadable(s:sql_file_{compl_type})
260 let compl_list = readfile(s:sql_file_{compl_type})
261 endif
262 endif
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000263
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000264 if g:loaded_dbext > 300
265 exec 'DBSetOption dict_show_owner='.saveSetting
266 endif
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000267 elseif compl_type =~? 'column'
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000268
269 " This type of completion relies upon the dbext.vim plugin
270 if s:SQLCCheck4dbext() == -1
271 return []
272 endif
273
274 if base == ""
275 " The last time we displayed a column list we stored
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100276 " the table name. If the user selects a column list
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000277 " without a table name of alias present, assume they want
278 " the previous column list displayed.
279 let base = s:save_prev_table
280 endif
281
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000282 let owner = ''
283 let column = ''
284
285 if base =~ '\.'
286 " Check if the owner/creator has been specified
287 let owner = matchstr( base, '^\zs.*\ze\..*\..*' )
288 let table = matchstr( base, '^\(.*\.\)\?\zs.*\ze\..*' )
289 let column = matchstr( base, '.*\.\zs.*' )
290
291 " It is pretty well impossible to determine if the user
292 " has entered:
293 " owner.table
294 " table.column_prefix
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100295 " So there are a couple of things we can do to mitigate
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000296 " this issue.
297 " 1. Check if the dbext plugin has the option turned
298 " on to even allow owners
299 " 2. Based on 1, if the user is showing a table list
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100300 " and the DrillIntoTable (using <Right>) then
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000301 " this will be owner.table. In this case, we can
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100302 " check to see the table.column exists in the
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000303 " cached table list. If it does, then we have
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100304 " determined the user has actually chosen
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000305 " owner.table, not table.column_prefix.
306 let found = -1
307 if g:omni_sql_include_owner == 1 && owner == ''
308 if filereadable(s:sql_file_table)
309 let tbl_list = readfile(s:sql_file_table)
310 let found = index( tbl_list, ((table != '')?(table.'.'):'').column)
311 endif
312 endif
313 " If the table.column was found in the table list, we can safely assume
314 " the owner was not provided and shift the items appropriately.
315 " OR
316 " If the user has indicated not to use table owners at all and
317 " the base ends in a '.' we know they are not providing a column
318 " name, so we can shift the items appropriately.
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100319 " if found != -1 || (g:omni_sql_include_owner == 0 && base !~ '\.$')
320 " let owner = table
321 " let table = column
322 " let column = ''
323 " endif
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000324 else
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100325 " If no "." was provided and the user asked for
326 " column level completion, first attempt the match
327 " on any previous column lists. If the user asked
328 " for a list of columns comma separated, continue as usual.
329 if compl_type == 'column' && s:save_prev_table != ''
330 " The last time we displayed a column list we stored
331 " the table name. If the user selects a column list
332 " without a table name of alias present, assume they want
333 " the previous column list displayed.
334 let table = s:save_prev_table
335 let list_type = ''
336
337 let compl_list = s:SQLCGetColumns(table, list_type)
338 if ! empty(compl_list)
339 " If no column prefix has been provided and the table
340 " name was provided, append it to each of the items
341 " returned.
342 let compl_list = filter(deepcopy(compl_list), 'v:val=~"^'.base.'"' )
343
344 " If not empty, we have a match on columns
345 " return the list
346 if ! empty(compl_list)
347 return compl_list
348 endif
349 endif
350 endif
351 " Since no columns were found to match the base supplied
352 " assume the user is trying to complete the column list
353 " for a table (and or an alias to a table).
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000354 let table = base
355 endif
356
357 " Get anything after the . and consider this the table name
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100358 " If an owner has been specified, then we must consider the
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000359 " base to be a partial column name
360 " let base = matchstr( base, '^\(.*\.\)\?\zs.*' )
361
362 if table != ""
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000363 let s:save_prev_table = base
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000364 let list_type = ''
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000365
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000366 if compl_type == 'column_csv'
367 " Return one array element, with a comma separated
368 " list of values instead of multiple array entries
369 " for each column in the table.
370 let list_type = 'csv'
371 endif
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000372
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000373 let compl_list = s:SQLCGetColumns(table, list_type)
374 if column != ''
375 " If no column prefix has been provided and the table
376 " name was provided, append it to each of the items
377 " returned.
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100378 let compl_list = map(compl_list, 'table.".".v:val')
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000379 if owner != ''
380 " If an owner has been provided append it to each of the
381 " items returned.
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100382 let compl_list = map(compl_list, 'owner.".".v:val')
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000383 endif
384 else
385 let base = ''
386 endif
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000387
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000388 if compl_type == 'column_csv'
389 " Join the column array into 1 single element array
390 " but make the columns column separated
391 let compl_list = [join(compl_list, ', ')]
392 endif
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000393 endif
394 elseif compl_type == 'resetCache'
395 " Reset all cached items
396 let s:tbl_name = []
397 let s:tbl_alias = []
398 let s:tbl_cols = []
399 let s:syn_list = []
400 let s:syn_value = []
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000401
402 let msg = "All SQL cached items have been removed."
403 call s:SQLCWarningMsg(msg)
404 " Leave time for the user to read the error message
405 :sleep 2
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000406 else
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000407 let compl_list = s:SQLCGetSyntaxList(compl_type)
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000408 endif
409
410 if base != ''
Bram Moolenaar5c736222010-01-06 20:54:52 +0100411 " Filter the list based on the first few characters the user entered.
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100412 " Check if the text matches at the beginning
413 " \\(^.base.'\\)
414 " or
Bram Moolenaar5c736222010-01-06 20:54:52 +0100415 " Match to a owner.table or alias.column type match
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100416 " ^\\(\\w\\+\\.\\)\\?'.base.'\\)
Bram Moolenaar5c736222010-01-06 20:54:52 +0100417 " or
418 " Handle names with spaces "my table name"
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100419 " "\\(^'.base.'\\|^\\(\\w\\+\\.\\)\\?'.base.'\\)"'
420 "
Bram Moolenaar5c736222010-01-06 20:54:52 +0100421 let expr = 'v:val '.(g:omni_sql_ignorecase==1?'=~?':'=~#').' "\\(^'.base.'\\|^\\(\\w\\+\\.\\)\\?'.base.'\\)"'
422 " let expr = 'v:val '.(g:omni_sql_ignorecase==1?'=~?':'=~#').' "\\(^'.base.'\\)"'
423 " let expr = 'v:val '.(g:omni_sql_ignorecase==1?'=~?':'=~#').' "\\(^'.base.'\\|\\(\\.\\)\\?'.base.'\\)"'
424 " let expr = 'v:val '.(g:omni_sql_ignorecase==1?'=~?':'=~#').' "\\(^'.base.'\\|\\([^.]*\\)\\?'.base.'\\)"'
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000425 let compl_list = filter(deepcopy(compl_list), expr)
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000426 endif
427
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000428 if exists('b:sql_compl_savefunc') && b:sql_compl_savefunc != ""
429 let &omnifunc = b:sql_compl_savefunc
430 endif
431
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000432 return compl_list
433endfunc
434
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000435function! sqlcomplete#PreCacheSyntax(...)
436 let syn_group_arr = []
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +0200437 let syn_items = []
438
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100439 if a:0 > 0
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +0200440 if type(a:1) != 3
441 call s:SQLCWarningMsg("Parameter is not a list. Example:['syntaxGroup1', 'syntaxGroup2']")
442 return ''
443 endif
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000444 let syn_group_arr = a:1
445 else
446 let syn_group_arr = g:omni_sql_precache_syntax_groups
447 endif
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000448 " For each group specified in the list, precache all
449 " the sytnax items.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000450 if !empty(syn_group_arr)
451 for group_name in syn_group_arr
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +0200452 let syn_items = extend( syn_items, s:SQLCGetSyntaxList(group_name) )
453 endfor
454 endif
455
456 return syn_items
457endfunction
458
459function! sqlcomplete#ResetCacheSyntax(...)
460 let syn_group_arr = []
461
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100462 if a:0 > 0
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +0200463 if type(a:1) != 3
464 call s:SQLCWarningMsg("Parameter is not a list. Example:['syntaxGroup1', 'syntaxGroup2']")
465 return ''
466 endif
467 let syn_group_arr = a:1
468 else
469 let syn_group_arr = g:omni_sql_precache_syntax_groups
470 endif
471 " For each group specified in the list, precache all
472 " the sytnax items.
473 if !empty(syn_group_arr)
474 for group_name in syn_group_arr
475 let list_idx = index(s:syn_list, group_name, 0, &ignorecase)
476 if list_idx > -1
477 " Remove from list of groups
478 call remove( s:syn_list, list_idx )
479 " Remove from list of keywords
480 call remove( s:syn_value, list_idx )
481 endif
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000482 endfor
483 endif
484endfunction
485
486function! sqlcomplete#Map(type)
487 " Tell the SQL plugin what you want to complete
488 let b:sql_compl_type=a:type
489 " Record previous omnifunc, if the SQL completion
490 " is being used in conjunction with other filetype
491 " completion plugins
492 if &omnifunc != "" && &omnifunc != 'sqlcomplete#Complete'
493 " Record the previous omnifunc, the plugin
494 " will automatically set this back so that it
495 " does not interfere with other ftplugins settings
496 let b:sql_compl_savefunc=&omnifunc
497 endif
498 " Set the OMNI func for the SQL completion plugin
499 let &omnifunc='sqlcomplete#Complete'
500endfunction
501
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000502function! sqlcomplete#DrillIntoTable()
503 " If the omni popup window is visible
504 if pumvisible()
505 call sqlcomplete#Map('column')
506 " C-Y, makes the currently highlighted entry active
507 " and trigger the omni popup to be redisplayed
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200508 call feedkeys("\<C-Y>\<C-X>\<C-O>", 'n')
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000509 else
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200510 " If the popup is not visible, simple perform the normal
511 " key behaviour.
512 " Must use exec since they key must be preceeded by "\"
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100513 " or feedkeys will simply push each character of the string
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200514 " rather than the "key press".
515 exec 'call feedkeys("\'.g:ftplugin_sql_omni_key_right.'", "n")'
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000516 endif
517 return ""
518endfunction
519
520function! sqlcomplete#DrillOutOfColumns()
521 " If the omni popup window is visible
522 if pumvisible()
523 call sqlcomplete#Map('tableReset')
524 " Trigger the omni popup to be redisplayed
525 call feedkeys("\<C-X>\<C-O>")
526 else
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200527 " If the popup is not visible, simple perform the normal
528 " key behaviour.
529 " Must use exec since they key must be preceeded by "\"
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100530 " or feedkeys will simply push each character of the string
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200531 " rather than the "key press".
532 exec 'call feedkeys("\'.g:ftplugin_sql_omni_key_left.'", "n")'
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000533 endif
534 return ""
535endfunction
536
537function! s:SQLCWarningMsg(msg)
538 echohl WarningMsg
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100539 echomsg 'SQLComplete:'.a:msg
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000540 echohl None
541endfunction
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100542
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000543function! s:SQLCErrorMsg(msg)
544 echohl ErrorMsg
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100545 echomsg 'SQLComplete:'.a:msg
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000546 echohl None
547endfunction
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100548
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000549function! s:SQLCGetSyntaxList(syn_group)
550 let syn_group = a:syn_group
551 let compl_list = []
552
553 " Check if we have already cached the syntax list
554 let list_idx = index(s:syn_list, syn_group, 0, &ignorecase)
555 if list_idx > -1
556 " Return previously cached value
557 let compl_list = s:syn_value[list_idx]
558 else
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100559 " Request the syntax list items from the
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000560 " syntax completion plugin
561 if syn_group == 'syntax'
562 " Handle this special case. This allows the user
563 " to indicate they want all the syntax items available,
564 " so do not specify a specific include list.
565 let g:omni_syntax_group_include_sql = ''
566 else
567 " The user has specified a specific syntax group
568 let g:omni_syntax_group_include_sql = syn_group
569 endif
570 let g:omni_syntax_group_exclude_sql = ''
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +0200571 let syn_value = syntaxcomplete#OmniSyntaxList()
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000572 let g:omni_syntax_group_include_sql = s:save_inc
573 let g:omni_syntax_group_exclude_sql = s:save_exc
574 " Cache these values for later use
575 let s:syn_list = add( s:syn_list, syn_group )
576 let s:syn_value = add( s:syn_value, syn_value )
577 let compl_list = syn_value
578 endif
579
580 return compl_list
581endfunction
582
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000583function! s:SQLCCheck4dbext()
584 if !exists('g:loaded_dbext')
585 let msg = "The dbext plugin must be loaded for dynamic SQL completion"
586 call s:SQLCErrorMsg(msg)
587 " Leave time for the user to read the error message
588 :sleep 2
589 return -1
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000590 elseif g:loaded_dbext < 600
591 let msg = "The dbext plugin must be at least version 5.30 " .
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000592 \ " for dynamic SQL completion"
593 call s:SQLCErrorMsg(msg)
594 " Leave time for the user to read the error message
595 :sleep 2
596 return -1
597 endif
598 return 1
599endfunction
600
601function! s:SQLCAddAlias(table_name, table_alias, cols)
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000602 " Strip off the owner if included
603 let table_name = matchstr(a:table_name, '\%(.\{-}\.\)\?\zs\(.*\)' )
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000604 let table_alias = a:table_alias
605 let cols = a:cols
606
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100607 if g:omni_sql_use_tbl_alias != 'n'
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000608 if table_alias == ''
609 if 'da' =~? g:omni_sql_use_tbl_alias
610 if table_name =~ '_'
611 " Treat _ as separators since people often use these
612 " for word separators
613 let save_keyword = &iskeyword
614 setlocal iskeyword-=_
615
616 " Get the first letter of each word
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100617 " [[:alpha:]] is used instead of \w
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000618 " to catch extended accented characters
619 "
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100620 let table_alias = substitute(
621 \ table_name,
622 \ '\<[[:alpha:]]\+\>_\?',
623 \ '\=strpart(submatch(0), 0, 1)',
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000624 \ 'g'
625 \ )
626 " Restore original value
627 let &iskeyword = save_keyword
628 elseif table_name =~ '\u\U'
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000629 let table_alias = substitute(
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000630 \ table_name, '\(\u\)\U*', '\1', 'g')
631 else
632 let table_alias = strpart(table_name, 0, 1)
633 endif
634 endif
635 endif
636 if table_alias != ''
637 " Following a word character, make sure there is a . and no spaces
638 let table_alias = substitute(table_alias, '\w\zs\.\?\s*$', '.', '')
639 if 'a' =~? g:omni_sql_use_tbl_alias && a:table_alias == ''
640 let table_alias = inputdialog("Enter table alias:", table_alias)
641 endif
642 endif
643 if table_alias != ''
644 let cols = substitute(cols, '\<\w', table_alias.'&', 'g')
645 endif
646 endif
647
648 return cols
649endfunction
650
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100651function! s:SQLCGetObjectOwner(object)
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000652 " The owner regex matches a word at the start of the string which is
653 " followed by a dot, but doesn't include the dot in the result.
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000654 " ^ - from beginning of line
655 " \("\|\[\)\? - ignore any quotes
656 " \zs - start the match now
657 " .\{-} - get owner name
658 " \ze - end the match
659 " \("\|\[\)\? - ignore any quotes
660 " \. - must by followed by a .
661 " let owner = matchstr( a:object, '^\s*\zs.*\ze\.' )
662 let owner = matchstr( a:object, '^\("\|\[\)\?\zs\.\{-}\ze\("\|\]\)\?\.' )
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000663 return owner
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100664endfunction
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000665
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000666function! s:SQLCGetColumns(table_name, list_type)
Bram Moolenaar83e138c2007-05-05 18:27:07 +0000667 " Check if the table name was provided as part of the column name
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000668 let table_name = matchstr(a:table_name, '^["\[\]a-zA-Z0-9_ ]\+\ze\.\?')
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000669 let table_cols = []
670 let table_alias = ''
671 let move_to_top = 1
672
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000673 let table_name = substitute(table_name, '\s*\(.\{-}\)\s*$', '\1', 'g')
674
675 " If the table name was given as:
676 " where c.
677 let table_name = substitute(table_name, '^\c\(WHERE\|AND\|OR\)\s\+', '', '')
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000678 if g:loaded_dbext >= 300
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000679 let saveSettingAlias = DB_listOption('use_tbl_alias')
680 exec 'DBSetOption use_tbl_alias=n'
681 endif
682
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000683 let table_name_stripped = substitute(table_name, '["\[\]]*', '', 'g')
684
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000685 " Check if we have already cached the column list for this table
686 " by its name
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000687 let list_idx = index(s:tbl_name, table_name_stripped, 0, &ignorecase)
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000688 if list_idx > -1
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000689 let table_cols = split(s:tbl_cols[list_idx], '\n')
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000690 else
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100691 " Check if we have already cached the column list for this table
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000692 " by its alias, assuming the table_name provided was actually
693 " the alias for the table instead
694 " select *
695 " from area a
696 " where a.
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000697 let list_idx = index(s:tbl_alias, table_name_stripped, 0, &ignorecase)
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000698 if list_idx > -1
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000699 let table_alias = table_name_stripped
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000700 let table_name = s:tbl_name[list_idx]
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000701 let table_cols = split(s:tbl_cols[list_idx], '\n')
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000702 endif
703 endif
704
705 " If we have not found a cached copy of the table
706 " And the table ends in a "." or we are looking for a column list
707 " if list_idx == -1 && (a:table_name =~ '\.' || b:sql_compl_type =~ 'column')
708 " if list_idx == -1 && (a:table_name =~ '\.' || a:list_type =~ 'csv')
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100709 if list_idx == -1
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000710 let saveY = @y
711 let saveSearch = @/
712 let saveWScan = &wrapscan
713 let curline = line(".")
714 let curcol = col(".")
715
716 " Do not let searchs wrap
717 setlocal nowrapscan
718 " If . was entered, look at the word just before the .
719 " We are looking for something like this:
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100720 " select *
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000721 " from customer c
722 " where c.
723 " So when . is pressed, we need to find 'c'
724 "
725
726 " Search backwards to the beginning of the statement
727 " and do NOT wrap
728 " exec 'silent! normal! v?\<\(select\|update\|delete\|;\)\>'."\n".'"yy'
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200729 exec 'silent! normal! ?\<\c\(select\|update\|delete\|;\)\>'."\n"
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000730
731 " Start characterwise visual mode
732 " Advance right one character
733 " Search foward until one of the following:
734 " 1. Another select/update/delete statement
735 " 2. A ; at the end of a line (the delimiter)
736 " 3. The end of the file (incase no delimiter)
737 " Yank the visually selected text into the "y register.
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200738 exec 'silent! normal! vl/\c\(\<select\>\|\<update\>\|\<delete\>\|;\s*$\|\%$\)'."\n".'"yy'
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000739
740 let query = @y
741 let query = substitute(query, "\n", ' ', 'g')
742 let found = 0
743
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200744 " if query =~? '^\c\(select\)'
745 if query =~? '^\(select\|update\|delete\)'
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000746 let found = 1
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100747 " \(\(\<\w\+\>\)\.\)\? -
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200748 " '\c\(from\|join\|,\).\{-}' - Starting at the from clause (case insensitive)
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000749 " '\zs\(\(\<\w\+\>\)\.\)\?' - Get the owner name (optional)
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100750 " '\<\w\+\>\ze' - Get the table name
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000751 " '\s\+\<'.table_name.'\>' - Followed by the alias
752 " '\s*\.\@!.*' - Cannot be followed by a .
753 " '\(\<where\>\|$\)' - Must be followed by a WHERE clause
754 " '.*' - Exclude the rest of the line in the match
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100755 " let table_name_new = matchstr(@y,
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200756 " \ '\c\(from\|join\|,\).\{-}'.
757 " \ '\zs\(\("\|\[\)\?.\{-}\("\|\]\)\.\)\?'.
758 " \ '\("\|\[\)\?.\{-}\("\|\]\)\?\ze'.
759 " \ '\s\+\%(as\s\+\)\?\<'.
760 " \ matchstr(table_name, '.\{-}\ze\.\?$').
761 " \ '\>'.
762 " \ '\s*\.\@!.*'.
763 " \ '\(\<where\>\|$\)'.
764 " \ '.*'
765 " \ )
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100766 "
767 "
768 " ''\c\(\<from\>\|\<join\>\|,\)\s*' - Starting at the from clause (case insensitive)
769 " '\zs\(\("\|\[\)\?\w\+\("\|\]\)\?\.\)\?' - Get the owner name (optional)
770 " '\("\|\[\)\?\w\+\("\|\]\)\?\ze' - Get the table name
771 " '\s\+\%(as\s\+\)\?\<'.matchstr(table_name, '.\{-}\ze\.\?$').'\>' - Followed by the alias
772 " '\s*\.\@!.*' - Cannot be followed by a .
773 " '\(\<where\>\|$\)' - Must be followed by a WHERE clause
774 " '.*' - Exclude the rest of the line in the match
775 let table_name_new = matchstr(@y,
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200776 \ '\c\(\<from\>\|\<join\>\|,\)\s*'.
777 \ '\zs\(\("\|\[\)\?\w\+\("\|\]\)\?\.\)\?'.
778 \ '\("\|\[\)\?\w\+\("\|\]\)\?\ze'.
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000779 \ '\s\+\%(as\s\+\)\?\<'.
780 \ matchstr(table_name, '.\{-}\ze\.\?$').
781 \ '\>'.
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000782 \ '\s*\.\@!.*'.
783 \ '\(\<where\>\|$\)'.
784 \ '.*'
785 \ )
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000786
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000787 if table_name_new != ''
788 let table_alias = table_name
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200789 let table_name = matchstr( table_name_new, '^\(.*\.\)\?\zs.*\ze' )
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000790
791 let list_idx = index(s:tbl_name, table_name, 0, &ignorecase)
792 if list_idx > -1
793 let table_cols = split(s:tbl_cols[list_idx])
794 let s:tbl_name[list_idx] = table_name
795 let s:tbl_alias[list_idx] = table_alias
796 else
797 let list_idx = index(s:tbl_alias, table_name, 0, &ignorecase)
798 if list_idx > -1
799 let table_cols = split(s:tbl_cols[list_idx])
800 let s:tbl_name[list_idx] = table_name
801 let s:tbl_alias[list_idx] = table_alias
802 endif
803 endif
804
805 endif
806 else
807 " Simply assume it is a table name provided with a . on the end
808 let found = 1
809 endif
810
811 let @y = saveY
812 let @/ = saveSearch
813 let &wrapscan = saveWScan
814
815 " Return to previous location
816 call cursor(curline, curcol)
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100817
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000818 if found == 0
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000819 if g:loaded_dbext > 300
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000820 exec 'DBSetOption use_tbl_alias='.saveSettingAlias
821 endif
822
823 " Not a SQL statement, do not display a list
824 return []
825 endif
Bram Moolenaardb7207e2012-02-22 17:30:19 +0100826 endif
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000827
828 if empty(table_cols)
829 " Specify silent mode, no messages to the user (tbl, 1)
830 " Specify do not comma separate (tbl, 1, 1)
831 let table_cols_str = DB_getListColumn(table_name, 1, 1)
832
833 if table_cols_str != ""
834 let s:tbl_name = add( s:tbl_name, table_name )
835 let s:tbl_alias = add( s:tbl_alias, table_alias )
836 let s:tbl_cols = add( s:tbl_cols, table_cols_str )
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000837 let table_cols = split(table_cols_str, '\n')
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000838 endif
839
840 endif
841
Bram Moolenaareb3593b2006-04-22 22:33:57 +0000842 if g:loaded_dbext > 300
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000843 exec 'DBSetOption use_tbl_alias='.saveSettingAlias
844 endif
845
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000846 " If the user has asked for a comma separate list of column
847 " values, ask the user if they want to prepend each column
848 " with a tablename alias.
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000849 if a:list_type == 'csv' && !empty(table_cols)
Bram Moolenaarf193fff2006-04-27 00:02:13 +0000850 let cols = join(table_cols, ', ')
851 let cols = s:SQLCAddAlias(table_name, table_alias, cols)
Bram Moolenaare2f98b92006-03-29 21:18:24 +0000852 let table_cols = [cols]
853 endif
854
855 return table_cols
856endfunction