blob: fa9edcdcc6b205fae42d131a18cf6a7c7b2728c0 [file] [log] [blame]
drh9ccd8652013-09-13 16:36:46 +00001#!/usr/bin/tclsh
2#
3# Run this script to generate the pragma name lookup table C code.
4#
5# To add new pragmas, first add the name and other relevant attributes
6# of the pragma to the "pragma_def" object below. Then run this script
drh67e65e52015-02-02 21:34:54 +00007# to generate the ../src/pragma.h header file that contains macros and
8# the lookup table needed for pragma name lookup in the pragma.c module.
drh9ccd8652013-09-13 16:36:46 +00009# Then add the extra "case PragTyp_XXXXX:" and subsequent code for the
drh67e65e52015-02-02 21:34:54 +000010# new pragma in ../src/pragma.c.
drh9ccd8652013-09-13 16:36:46 +000011#
12
drhc232aca2016-12-15 16:01:17 +000013# Flag meanings:
14set flagMeaning(NeedSchema) {Force schema load before running}
15set flagMeaning(ReadOnly) {Read-only HEADER_VALUE}
16set flagMeaning(Result0) {Acts as query when no argument}
17set flagMeaning(Result1) {Acts as query when has one argument}
18set flagMeaning(SchemaReq) {Schema required - "main" is default}
19set flagMeaning(SchemaOpt) {Schema restricts name search if present}
20set flagMeaning(NoColumns) {OP_ResultRow called with zero columns}
dan9e1ab1a2017-01-05 19:32:48 +000021set flagMeaning(NoColumns1) {zero columns if RHS argument is present}
drhc232aca2016-12-15 16:01:17 +000022
drh9ccd8652013-09-13 16:36:46 +000023set pragma_def {
24 NAME: full_column_names
25 TYPE: FLAG
26 ARG: SQLITE_FullColNames
mistachkindd197832013-10-21 23:17:23 +000027 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +000028
29 NAME: short_column_names
30 TYPE: FLAG
31 ARG: SQLITE_ShortColNames
mistachkindd197832013-10-21 23:17:23 +000032 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +000033
34 NAME: count_changes
35 TYPE: FLAG
36 ARG: SQLITE_CountRows
mistachkindd197832013-10-21 23:17:23 +000037 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +000038
39 NAME: empty_result_callbacks
40 TYPE: FLAG
41 ARG: SQLITE_NullCallback
mistachkindd197832013-10-21 23:17:23 +000042 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +000043
drh9ccd8652013-09-13 16:36:46 +000044 NAME: fullfsync
45 TYPE: FLAG
46 ARG: SQLITE_FullFSync
mistachkindd197832013-10-21 23:17:23 +000047 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +000048
49 NAME: checkpoint_fullfsync
50 TYPE: FLAG
51 ARG: SQLITE_CkptFullFSync
mistachkindd197832013-10-21 23:17:23 +000052 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +000053
54 NAME: cache_spill
dan9e1ab1a2017-01-05 19:32:48 +000055 FLAG: Result0 SchemaReq NoColumns1
mistachkindd197832013-10-21 23:17:23 +000056 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +000057
58 NAME: reverse_unordered_selects
59 TYPE: FLAG
60 ARG: SQLITE_ReverseOrder
mistachkindd197832013-10-21 23:17:23 +000061 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +000062
63 NAME: query_only
64 TYPE: FLAG
65 ARG: SQLITE_QueryOnly
mistachkindd197832013-10-21 23:17:23 +000066 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +000067
68 NAME: automatic_index
69 TYPE: FLAG
70 ARG: SQLITE_AutoIndex
mistachkindd197832013-10-21 23:17:23 +000071 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +000072 IF: !defined(SQLITE_OMIT_AUTOMATIC_INDEX)
73
74 NAME: sql_trace
75 TYPE: FLAG
76 ARG: SQLITE_SqlTrace
mistachkindd197832013-10-21 23:17:23 +000077 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +000078 IF: defined(SQLITE_DEBUG)
79
80 NAME: vdbe_listing
81 TYPE: FLAG
82 ARG: SQLITE_VdbeListing
mistachkindd197832013-10-21 23:17:23 +000083 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +000084 IF: defined(SQLITE_DEBUG)
85
86 NAME: vdbe_trace
87 TYPE: FLAG
88 ARG: SQLITE_VdbeTrace
mistachkindd197832013-10-21 23:17:23 +000089 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +000090 IF: defined(SQLITE_DEBUG)
91
92 NAME: vdbe_addoptrace
93 TYPE: FLAG
94 ARG: SQLITE_VdbeAddopTrace
mistachkindd197832013-10-21 23:17:23 +000095 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +000096 IF: defined(SQLITE_DEBUG)
97
98 NAME: vdbe_debug
99 TYPE: FLAG
100 ARG: SQLITE_SqlTrace|SQLITE_VdbeListing|SQLITE_VdbeTrace
mistachkindd197832013-10-21 23:17:23 +0000101 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +0000102 IF: defined(SQLITE_DEBUG)
103
drh84e55a82013-11-13 17:58:23 +0000104 NAME: vdbe_eqp
105 TYPE: FLAG
106 ARG: SQLITE_VdbeEQP
107 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
108 IF: defined(SQLITE_DEBUG)
109
drh9ccd8652013-09-13 16:36:46 +0000110 NAME: ignore_check_constraints
111 TYPE: FLAG
112 ARG: SQLITE_IgnoreChecks
mistachkindd197832013-10-21 23:17:23 +0000113 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +0000114 IF: !defined(SQLITE_OMIT_CHECK)
115
116 NAME: writable_schema
117 TYPE: FLAG
drhfd748c62018-10-30 16:25:35 +0000118 ARG: SQLITE_WriteSchema|SQLITE_NoSchemaError
mistachkindd197832013-10-21 23:17:23 +0000119 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +0000120
121 NAME: read_uncommitted
122 TYPE: FLAG
drh169dd922017-06-26 13:57:49 +0000123 ARG: SQLITE_ReadUncommit
mistachkindd197832013-10-21 23:17:23 +0000124 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +0000125
126 NAME: recursive_triggers
127 TYPE: FLAG
128 ARG: SQLITE_RecTriggers
mistachkindd197832013-10-21 23:17:23 +0000129 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +0000130
131 NAME: foreign_keys
132 TYPE: FLAG
133 ARG: SQLITE_ForeignKeys
mistachkindd197832013-10-21 23:17:23 +0000134 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +0000135 IF: !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
136
137 NAME: defer_foreign_keys
138 TYPE: FLAG
139 ARG: SQLITE_DeferFKs
mistachkindd197832013-10-21 23:17:23 +0000140 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +0000141 IF: !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
142
drh1421d982015-05-27 03:46:18 +0000143 NAME: cell_size_check
144 TYPE: FLAG
145 ARG: SQLITE_CellSizeCk
146
drh9ccd8652013-09-13 16:36:46 +0000147 NAME: default_cache_size
dan9e1ab1a2017-01-05 19:32:48 +0000148 FLAG: NeedSchema Result0 SchemaReq NoColumns1
drhc232aca2016-12-15 16:01:17 +0000149 COLS: cache_size
drh01996da2019-02-06 00:11:13 +0000150 IF: !defined(SQLITE_OMIT_PAGER_PRAGMAS) && !defined(SQLITE_OMIT_DEPRECATED)
drh9ccd8652013-09-13 16:36:46 +0000151
152 NAME: page_size
dan9e1ab1a2017-01-05 19:32:48 +0000153 FLAG: Result0 SchemaReq NoColumns1
drh9ccd8652013-09-13 16:36:46 +0000154 IF: !defined(SQLITE_OMIT_PAGER_PRAGMAS)
155
156 NAME: secure_delete
drhc232aca2016-12-15 16:01:17 +0000157 FLAG: Result0
drh9ccd8652013-09-13 16:36:46 +0000158 IF: !defined(SQLITE_OMIT_PAGER_PRAGMAS)
159
160 NAME: page_count
drhc232aca2016-12-15 16:01:17 +0000161 FLAG: NeedSchema Result0 SchemaReq
drh9ccd8652013-09-13 16:36:46 +0000162 IF: !defined(SQLITE_OMIT_PAGER_PRAGMAS)
163
164 NAME: max_page_count
165 TYPE: PAGE_COUNT
drhc232aca2016-12-15 16:01:17 +0000166 FLAG: NeedSchema Result0 SchemaReq
drh9ccd8652013-09-13 16:36:46 +0000167 IF: !defined(SQLITE_OMIT_PAGER_PRAGMAS)
168
169 NAME: locking_mode
drhc232aca2016-12-15 16:01:17 +0000170 FLAG: Result0 SchemaReq
drh9ccd8652013-09-13 16:36:46 +0000171 IF: !defined(SQLITE_OMIT_PAGER_PRAGMAS)
172
173 NAME: journal_mode
drhc232aca2016-12-15 16:01:17 +0000174 FLAG: NeedSchema Result0 SchemaReq
drh9ccd8652013-09-13 16:36:46 +0000175 IF: !defined(SQLITE_OMIT_PAGER_PRAGMAS)
176
177 NAME: journal_size_limit
drhc232aca2016-12-15 16:01:17 +0000178 FLAG: Result0 SchemaReq
drh9ccd8652013-09-13 16:36:46 +0000179 IF: !defined(SQLITE_OMIT_PAGER_PRAGMAS)
180
181 NAME: cache_size
dan9e1ab1a2017-01-05 19:32:48 +0000182 FLAG: NeedSchema Result0 SchemaReq NoColumns1
drh9ccd8652013-09-13 16:36:46 +0000183 IF: !defined(SQLITE_OMIT_PAGER_PRAGMAS)
184
185 NAME: mmap_size
186 IF: !defined(SQLITE_OMIT_PAGER_PRAGMAS)
187
188 NAME: auto_vacuum
dan9e1ab1a2017-01-05 19:32:48 +0000189 FLAG: NeedSchema Result0 SchemaReq NoColumns1
drh9ccd8652013-09-13 16:36:46 +0000190 IF: !defined(SQLITE_OMIT_AUTOVACUUM)
191
192 NAME: incremental_vacuum
drhc232aca2016-12-15 16:01:17 +0000193 FLAG: NeedSchema NoColumns
drh9ccd8652013-09-13 16:36:46 +0000194 IF: !defined(SQLITE_OMIT_AUTOVACUUM)
195
196 NAME: temp_store
dan9e1ab1a2017-01-05 19:32:48 +0000197 FLAG: Result0 NoColumns1
drh9ccd8652013-09-13 16:36:46 +0000198 IF: !defined(SQLITE_OMIT_PAGER_PRAGMAS)
199
200 NAME: temp_store_directory
dan9e1ab1a2017-01-05 19:32:48 +0000201 FLAG: NoColumns1
drh9ccd8652013-09-13 16:36:46 +0000202 IF: !defined(SQLITE_OMIT_PAGER_PRAGMAS)
203
204 NAME: data_store_directory
dan9e1ab1a2017-01-05 19:32:48 +0000205 FLAG: NoColumns1
drh9ccd8652013-09-13 16:36:46 +0000206 IF: !defined(SQLITE_OMIT_PAGER_PRAGMAS) && SQLITE_OS_WIN
207
208 NAME: lock_proxy_file
dan9e1ab1a2017-01-05 19:32:48 +0000209 FLAG: NoColumns1
drh9ccd8652013-09-13 16:36:46 +0000210 IF: !defined(SQLITE_OMIT_PAGER_PRAGMAS) && SQLITE_ENABLE_LOCKING_STYLE
211
212 NAME: synchronous
dan9e1ab1a2017-01-05 19:32:48 +0000213 FLAG: NeedSchema Result0 SchemaReq NoColumns1
drh9ccd8652013-09-13 16:36:46 +0000214 IF: !defined(SQLITE_OMIT_PAGER_PRAGMAS)
215
216 NAME: table_info
drhc232aca2016-12-15 16:01:17 +0000217 FLAG: NeedSchema Result1 SchemaOpt
drh15fc9882018-09-29 19:38:42 +0000218 ARG: 0
219 COLS: cid name type notnull dflt_value pk
220 IF: !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
221
drhbdc97442018-10-01 21:26:30 +0000222 NAME: table_xinfo
drh15fc9882018-09-29 19:38:42 +0000223 TYPE: TABLE_INFO
224 FLAG: NeedSchema Result1 SchemaOpt
225 ARG: 1
drhd7dc0a32018-10-01 18:28:42 +0000226 COLS: cid name type notnull dflt_value pk hidden
drh9ccd8652013-09-13 16:36:46 +0000227 IF: !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
228
drh3ef26152013-10-12 20:22:00 +0000229 NAME: stats
drhc232aca2016-12-15 16:01:17 +0000230 FLAG: NeedSchema Result0 SchemaReq
drha3928dd2017-02-17 15:26:36 +0000231 COLS: tbl idx wdth hght flgs
drh33bec3f2017-02-17 13:38:15 +0000232 IF: !defined(SQLITE_OMIT_SCHEMA_PRAGMAS) && defined(SQLITE_DEBUG)
drh3ef26152013-10-12 20:22:00 +0000233
drh9ccd8652013-09-13 16:36:46 +0000234 NAME: index_info
drhc228be52015-01-31 02:00:01 +0000235 TYPE: INDEX_INFO
236 ARG: 0
drhc232aca2016-12-15 16:01:17 +0000237 FLAG: NeedSchema Result1 SchemaOpt
238 COLS: seqno cid name
drhc228be52015-01-31 02:00:01 +0000239 IF: !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
240
241 NAME: index_xinfo
242 TYPE: INDEX_INFO
243 ARG: 1
drhc232aca2016-12-15 16:01:17 +0000244 FLAG: NeedSchema Result1 SchemaOpt
245 COLS: seqno cid name desc coll key
drh9ccd8652013-09-13 16:36:46 +0000246 IF: !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
247
248 NAME: index_list
drhc232aca2016-12-15 16:01:17 +0000249 FLAG: NeedSchema Result1 SchemaOpt
250 COLS: seq name unique origin partial
drh9ccd8652013-09-13 16:36:46 +0000251 IF: !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
252
253 NAME: database_list
drhc232aca2016-12-15 16:01:17 +0000254 FLAG: NeedSchema Result0
255 COLS: seq name file
drh9ccd8652013-09-13 16:36:46 +0000256 IF: !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
257
drhab53bb62017-07-07 15:43:22 +0000258 NAME: function_list
259 FLAG: Result0
260 COLS: name builtin
261 IF: !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
drhcc3f3d12019-08-17 15:27:58 +0000262 IF: !defined(SQLITE_OMIT_INTROSPECTION_PRAGMAS)
drhab53bb62017-07-07 15:43:22 +0000263
264 NAME: module_list
265 FLAG: Result0
266 COLS: name
267 IF: !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
268 IF: !defined(SQLITE_OMIT_VIRTUALTABLE)
drhcc3f3d12019-08-17 15:27:58 +0000269 IF: !defined(SQLITE_OMIT_INTROSPECTION_PRAGMAS)
drh8ae11aa2017-07-07 17:33:07 +0000270
271 NAME: pragma_list
272 FLAG: Result0
273 COLS: name
drhcc3f3d12019-08-17 15:27:58 +0000274 IF: !defined(SQLITE_OMIT_INTROSPECTION_PRAGMAS)
drhab53bb62017-07-07 15:43:22 +0000275
drh9ccd8652013-09-13 16:36:46 +0000276 NAME: collation_list
drhc232aca2016-12-15 16:01:17 +0000277 FLAG: Result0
278 COLS: seq name
drh9ccd8652013-09-13 16:36:46 +0000279 IF: !defined(SQLITE_OMIT_SCHEMA_PRAGMAS)
280
281 NAME: foreign_key_list
drhc232aca2016-12-15 16:01:17 +0000282 FLAG: NeedSchema Result1 SchemaOpt
283 COLS: id seq table from to on_update on_delete match
drh9ccd8652013-09-13 16:36:46 +0000284 IF: !defined(SQLITE_OMIT_FOREIGN_KEY)
285
286 NAME: foreign_key_check
drhc45fdb22017-06-21 01:36:30 +0000287 FLAG: NeedSchema Result0
drhc232aca2016-12-15 16:01:17 +0000288 COLS: table rowid parent fkid
drh9ccd8652013-09-13 16:36:46 +0000289 IF: !defined(SQLITE_OMIT_FOREIGN_KEY) && !defined(SQLITE_OMIT_TRIGGER)
290
291 NAME: parser_trace
drh9b747062019-01-31 01:39:01 +0000292 TYPE: FLAG
293 ARG: SQLITE_ParserTrace
294 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
295 IF: defined(SQLITE_DEBUG)
drh9ccd8652013-09-13 16:36:46 +0000296
297 NAME: case_sensitive_like
dane1ff3f52017-01-06 13:49:40 +0000298 FLAG: NoColumns
drh08652b52019-05-08 17:27:18 +0000299 IF: !defined(SQLITE_OMIT_CASE_SENSITIVE_LIKE_PRAGMA)
drh9ccd8652013-09-13 16:36:46 +0000300
301 NAME: integrity_check
drhc45fdb22017-06-21 01:36:30 +0000302 FLAG: NeedSchema Result0 Result1
drh9ccd8652013-09-13 16:36:46 +0000303 IF: !defined(SQLITE_OMIT_INTEGRITY_CHECK)
304
305 NAME: quick_check
306 TYPE: INTEGRITY_CHECK
drhc45fdb22017-06-21 01:36:30 +0000307 FLAG: NeedSchema Result0 Result1
drh9ccd8652013-09-13 16:36:46 +0000308 IF: !defined(SQLITE_OMIT_INTEGRITY_CHECK)
309
310 NAME: encoding
dan9e1ab1a2017-01-05 19:32:48 +0000311 FLAG: Result0 NoColumns1
drh9ccd8652013-09-13 16:36:46 +0000312 IF: !defined(SQLITE_OMIT_UTF16)
313
314 NAME: schema_version
315 TYPE: HEADER_VALUE
drh8e755e72014-12-19 18:49:55 +0000316 ARG: BTREE_SCHEMA_VERSION
dan9e1ab1a2017-01-05 19:32:48 +0000317 FLAG: NoColumns1 Result0
drh9ccd8652013-09-13 16:36:46 +0000318 IF: !defined(SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS)
319
320 NAME: user_version
321 TYPE: HEADER_VALUE
drh8e755e72014-12-19 18:49:55 +0000322 ARG: BTREE_USER_VERSION
dan9e1ab1a2017-01-05 19:32:48 +0000323 FLAG: NoColumns1 Result0
drh9ccd8652013-09-13 16:36:46 +0000324 IF: !defined(SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS)
325
drh91618562014-12-19 19:28:02 +0000326 NAME: data_version
327 TYPE: HEADER_VALUE
328 ARG: BTREE_DATA_VERSION
dan9e1ab1a2017-01-05 19:32:48 +0000329 FLAG: ReadOnly Result0
drh91618562014-12-19 19:28:02 +0000330 IF: !defined(SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS)
331
drh9ccd8652013-09-13 16:36:46 +0000332 NAME: freelist_count
333 TYPE: HEADER_VALUE
drh8e755e72014-12-19 18:49:55 +0000334 ARG: BTREE_FREE_PAGE_COUNT
dan9e1ab1a2017-01-05 19:32:48 +0000335 FLAG: ReadOnly Result0
drh9ccd8652013-09-13 16:36:46 +0000336 IF: !defined(SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS)
337
338 NAME: application_id
339 TYPE: HEADER_VALUE
drh8e755e72014-12-19 18:49:55 +0000340 ARG: BTREE_APPLICATION_ID
dan9e1ab1a2017-01-05 19:32:48 +0000341 FLAG: NoColumns1 Result0
drh9ccd8652013-09-13 16:36:46 +0000342 IF: !defined(SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS)
343
344 NAME: compile_options
drhc232aca2016-12-15 16:01:17 +0000345 FLAG: Result0
drh9ccd8652013-09-13 16:36:46 +0000346 IF: !defined(SQLITE_OMIT_COMPILEOPTION_DIAGS)
347
348 NAME: wal_checkpoint
drhf63936e2013-10-03 14:08:07 +0000349 FLAG: NeedSchema
drhc232aca2016-12-15 16:01:17 +0000350 COLS: busy log checkpointed
drh9ccd8652013-09-13 16:36:46 +0000351 IF: !defined(SQLITE_OMIT_WAL)
352
353 NAME: wal_autocheckpoint
354 IF: !defined(SQLITE_OMIT_WAL)
355
356 NAME: shrink_memory
dane1ff3f52017-01-06 13:49:40 +0000357 FLAG: NoColumns
drh9ccd8652013-09-13 16:36:46 +0000358
359 NAME: busy_timeout
drhc232aca2016-12-15 16:01:17 +0000360 FLAG: Result0
361 COLS: timeout
drh9ccd8652013-09-13 16:36:46 +0000362
363 NAME: lock_status
drhc232aca2016-12-15 16:01:17 +0000364 FLAG: Result0
365 COLS: database status
drh9ccd8652013-09-13 16:36:46 +0000366 IF: defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
367
368 NAME: key
drhfa5c62e2018-10-11 18:41:50 +0000369 TYPE: KEY
370 ARG: 0
drh9ccd8652013-09-13 16:36:46 +0000371 IF: defined(SQLITE_HAS_CODEC)
372
373 NAME: rekey
drhfa5c62e2018-10-11 18:41:50 +0000374 TYPE: KEY
375 ARG: 1
drh9ccd8652013-09-13 16:36:46 +0000376 IF: defined(SQLITE_HAS_CODEC)
377
378 NAME: hexkey
drh51e441d2019-05-21 17:04:27 +0000379 TYPE: KEY
drhfa5c62e2018-10-11 18:41:50 +0000380 ARG: 2
drh9ccd8652013-09-13 16:36:46 +0000381 IF: defined(SQLITE_HAS_CODEC)
382
drh8ab88322013-10-07 00:36:01 +0000383 NAME: hexrekey
drh51e441d2019-05-21 17:04:27 +0000384 TYPE: KEY
drhfa5c62e2018-10-11 18:41:50 +0000385 ARG: 3
386 IF: defined(SQLITE_HAS_CODEC)
387
388 NAME: textkey
389 TYPE: KEY
390 ARG: 4
391 IF: defined(SQLITE_HAS_CODEC)
392
393 NAME: textrekey
394 TYPE: KEY
395 ARG: 5
drh8ab88322013-10-07 00:36:01 +0000396 IF: defined(SQLITE_HAS_CODEC)
397
drh9ccd8652013-09-13 16:36:46 +0000398 NAME: activate_extensions
399 IF: defined(SQLITE_HAS_CODEC) || defined(SQLITE_ENABLE_CEROD)
drh55e85ca2013-09-13 21:01:56 +0000400
401 NAME: soft_heap_limit
drhc232aca2016-12-15 16:01:17 +0000402 FLAG: Result0
drh03459612014-08-25 15:13:22 +0000403
drh10c0e712019-04-25 18:15:38 +0000404 NAME: hard_heap_limit
405 FLAG: Result0
406
drh03459612014-08-25 15:13:22 +0000407 NAME: threads
drhc232aca2016-12-15 16:01:17 +0000408 FLAG: Result0
drh72052a72017-02-17 16:26:34 +0000409
drh2ead47c2017-02-22 20:24:10 +0000410 NAME: optimize
drh761f6912017-04-03 13:33:51 +0000411 FLAG: Result1 NeedSchema
dan674b8942018-09-20 08:28:01 +0000412
413 NAME: legacy_alter_table
414 TYPE: FLAG
415 ARG: SQLITE_LegacyAlter
416 IF: !defined(SQLITE_OMIT_FLAG_PRAGMAS)
drh9ccd8652013-09-13 16:36:46 +0000417}
drh67e65e52015-02-02 21:34:54 +0000418
419# Open the output file
420#
421set destfile "[file dir [file dir [file normal $argv0]]]/src/pragma.h"
422puts "Overwriting $destfile with new pragma table..."
423set fd [open $destfile wb]
424puts $fd {/* DO NOT EDIT!
425** This file is automatically generated by the script at
426** ../tool/mkpragmatab.tcl. To update the set of pragmas, edit
427** that script and rerun it.
428*/}
429
430# Parse the PRAGMA table above.
431#
drh9ccd8652013-09-13 16:36:46 +0000432set name {}
433set type {}
434set if {}
drhf63936e2013-10-03 14:08:07 +0000435set flags {}
drhc232aca2016-12-15 16:01:17 +0000436set cols {}
437set cols_list {}
drh9ccd8652013-09-13 16:36:46 +0000438set arg 0
439proc record_one {} {
drhbdc97442018-10-01 21:26:30 +0000440 global name type if arg allbyname typebyif flags cols all_cols
drhc232aca2016-12-15 16:01:17 +0000441 global cols_list colUsedBy
drh9ccd8652013-09-13 16:36:46 +0000442 if {$name==""} return
drhc232aca2016-12-15 16:01:17 +0000443 if {$cols!=""} {
drhbdc97442018-10-01 21:26:30 +0000444 if {![info exists all_cols($cols)]} {
445 set all_cols($cols) 1
drhc232aca2016-12-15 16:01:17 +0000446 lappend cols_list $cols
drhc232aca2016-12-15 16:01:17 +0000447 }
drhbdc97442018-10-01 21:26:30 +0000448 set cx $cols
drhc232aca2016-12-15 16:01:17 +0000449 lappend colUsedBy($cols) $name
450 } else {
451 set cx 0
452 }
drhbdc97442018-10-01 21:26:30 +0000453 set allbyname($name) [list $type $arg $if $flags $cols]
drh9ccd8652013-09-13 16:36:46 +0000454 set name {}
455 set type {}
456 set if {}
drhf63936e2013-10-03 14:08:07 +0000457 set flags {}
drhc232aca2016-12-15 16:01:17 +0000458 set cols {}
drh9ccd8652013-09-13 16:36:46 +0000459 set arg 0
460}
461foreach line [split $pragma_def \n] {
462 set line [string trim $line]
463 if {$line==""} continue
464 foreach {id val} [split $line :] break
465 set val [string trim $val]
466 if {$id=="NAME"} {
467 record_one
468 set name $val
469 set type [string toupper $val]
470 } elseif {$id=="TYPE"} {
471 set type $val
drhc232aca2016-12-15 16:01:17 +0000472 if {$type=="FLAG"} {
dan9e1ab1a2017-01-05 19:32:48 +0000473 lappend flags Result0 NoColumns1
drhc232aca2016-12-15 16:01:17 +0000474 }
drh9ccd8652013-09-13 16:36:46 +0000475 } elseif {$id=="ARG"} {
476 set arg $val
drhc232aca2016-12-15 16:01:17 +0000477 } elseif {$id=="COLS"} {
478 set cols $val
drh9ccd8652013-09-13 16:36:46 +0000479 } elseif {$id=="IF"} {
mistachkindd197832013-10-21 23:17:23 +0000480 lappend if $val
drhf63936e2013-10-03 14:08:07 +0000481 } elseif {$id=="FLAG"} {
482 foreach term [split $val] {
483 lappend flags $term
484 set allflags($term) 1
485 }
drh9ccd8652013-09-13 16:36:46 +0000486 } else {
487 error "bad pragma_def line: $line"
488 }
489}
490record_one
491set allnames [lsort [array names allbyname]]
492
493# Generate #defines for all pragma type names. Group the pragmas that are
494# omit in default builds (defined(SQLITE_DEBUG) and defined(SQLITE_HAS_CODEC))
495# at the end.
496#
drhc232aca2016-12-15 16:01:17 +0000497puts $fd "\n/* The various pragma types */"
drh9ccd8652013-09-13 16:36:46 +0000498set pnum 0
499foreach name $allnames {
500 set type [lindex $allbyname($name) 0]
501 if {[info exists seentype($type)]} continue
502 set if [lindex $allbyname($name) 2]
503 if {[regexp SQLITE_DEBUG $if] || [regexp SQLITE_HAS_CODEC $if]} continue
504 set seentype($type) 1
drh67e65e52015-02-02 21:34:54 +0000505 puts $fd [format {#define %-35s %4d} PragTyp_$type $pnum]
drh9ccd8652013-09-13 16:36:46 +0000506 incr pnum
507}
508foreach name $allnames {
509 set type [lindex $allbyname($name) 0]
510 if {[info exists seentype($type)]} continue
511 set if [lindex $allbyname($name) 2]
512 if {[regexp SQLITE_DEBUG $if]} continue
513 set seentype($type) 1
drh67e65e52015-02-02 21:34:54 +0000514 puts $fd [format {#define %-35s %4d} PragTyp_$type $pnum]
drh9ccd8652013-09-13 16:36:46 +0000515 incr pnum
516}
517foreach name $allnames {
518 set type [lindex $allbyname($name) 0]
519 if {[info exists seentype($type)]} continue
520 set seentype($type) 1
drh67e65e52015-02-02 21:34:54 +0000521 puts $fd [format {#define %-35s %4d} PragTyp_$type $pnum]
drh9ccd8652013-09-13 16:36:46 +0000522 incr pnum
523}
524
drhf63936e2013-10-03 14:08:07 +0000525# Generate #defines for flags
526#
drhc232aca2016-12-15 16:01:17 +0000527puts $fd "\n/* Property flags associated with various pragma. */"
drhf63936e2013-10-03 14:08:07 +0000528set fv 1
529foreach f [lsort [array names allflags]] {
drhc232aca2016-12-15 16:01:17 +0000530 puts $fd [format {#define PragFlg_%-10s 0x%02x /* %s */} \
531 $f $fv $flagMeaning($f)]
drhf63936e2013-10-03 14:08:07 +0000532 set fv [expr {$fv*2}]
533}
534
drhbdc97442018-10-01 21:26:30 +0000535# Sort the column lists so that longer column lists occur first
536#
537proc colscmp {a b} {
538 return [expr {[llength $b] - [llength $a]}]
539}
540set cols_list [lsort -command colscmp $cols_list]
541
drhc232aca2016-12-15 16:01:17 +0000542# Generate the array of column names used by pragmas that act like
543# queries.
544#
545puts $fd "\n/* Names of columns for pragmas that return multi-column result"
546puts $fd "** or that return single-column results where the name of the"
547puts $fd "** result column is different from the name of the pragma\n*/"
548puts $fd "static const char *const pragCName\[\] = {"
549set offset 0
drhbdc97442018-10-01 21:26:30 +0000550set allcollist {}
drhc232aca2016-12-15 16:01:17 +0000551foreach cols $cols_list {
drhbdc97442018-10-01 21:26:30 +0000552 set n [llength $cols]
553 set limit [expr {[llength $allcollist] - $n}]
554 for {set i 0} {$i<$limit} {incr i} {
555 set sublist [lrange $allcollist $i [expr {$i+$n-1}]]
556 if {$sublist==$cols} {
557 puts $fd [format "%27s/* $colUsedBy($cols) reuses $i */" ""]
558 set cols_offset($cols) $i
559 break
560 }
561 }
562 if {$i<$limit} continue
563 set cols_offset($cols) $offset
drhc232aca2016-12-15 16:01:17 +0000564 set ub " /* Used by: $colUsedBy($cols) */"
565 foreach c $cols {
drhbdc97442018-10-01 21:26:30 +0000566 lappend allcollist $c
drhc232aca2016-12-15 16:01:17 +0000567 puts $fd [format " /* %3d */ %-14s%s" $offset \"$c\", $ub]
568 set ub ""
569 incr offset
570 }
571}
572puts $fd "\175;"
573
drh9ccd8652013-09-13 16:36:46 +0000574# Generate the lookup table
575#
drhc232aca2016-12-15 16:01:17 +0000576puts $fd "\n/* Definitions of all built-in pragmas */"
drh2fcc1592016-12-15 20:59:03 +0000577puts $fd "typedef struct PragmaName \173"
drhc232aca2016-12-15 16:01:17 +0000578puts $fd " const char *const zName; /* Name of pragma */"
579puts $fd " u8 ePragTyp; /* PragTyp_XXX value */"
580puts $fd " u8 mPragFlg; /* Zero or more PragFlg_XXX values */"
581puts $fd { u8 iPragCName; /* Start of column names in pragCName[] */}
582puts $fd " u8 nPragCName; \
583/* Num of col names. 0 means use pragma name */"
drhfd748c62018-10-30 16:25:35 +0000584puts $fd " u64 iArg; /* Extra argument */"
drh2fcc1592016-12-15 20:59:03 +0000585puts $fd "\175 PragmaName;"
586puts $fd "static const PragmaName aPragmaName\[\] = \173"
drh9ccd8652013-09-13 16:36:46 +0000587
588set current_if {}
589set spacer [format { %26s } {}]
590foreach name $allnames {
drhc232aca2016-12-15 16:01:17 +0000591 foreach {type arg if flag cx} $allbyname($name) break
drhbdc97442018-10-01 21:26:30 +0000592 if {$cx==0 || $cx==""} {
drhc232aca2016-12-15 16:01:17 +0000593 set cy 0
594 set nx 0
595 } else {
596 set cy $cols_offset($cx)
drhbdc97442018-10-01 21:26:30 +0000597 set nx [llength $cx]
drhc232aca2016-12-15 16:01:17 +0000598 }
drh9ccd8652013-09-13 16:36:46 +0000599 if {$if!=$current_if} {
mistachkindd197832013-10-21 23:17:23 +0000600 if {$current_if!=""} {
601 foreach this_if $current_if {
drh67e65e52015-02-02 21:34:54 +0000602 puts $fd "#endif"
mistachkindd197832013-10-21 23:17:23 +0000603 }
604 }
drh9ccd8652013-09-13 16:36:46 +0000605 set current_if $if
mistachkindd197832013-10-21 23:17:23 +0000606 if {$current_if!=""} {
607 foreach this_if $current_if {
drh67e65e52015-02-02 21:34:54 +0000608 puts $fd "#if $this_if"
mistachkindd197832013-10-21 23:17:23 +0000609 }
610 }
drh9ccd8652013-09-13 16:36:46 +0000611 }
drh9ccd8652013-09-13 16:36:46 +0000612 set typex [format PragTyp_%-23s $type,]
drhf63936e2013-10-03 14:08:07 +0000613 if {$flag==""} {
614 set flagx "0"
drh9ccd8652013-09-13 16:36:46 +0000615 } else {
drhc232aca2016-12-15 16:01:17 +0000616 set flagx PragFlg_[join $flag {|PragFlg_}]
drh9ccd8652013-09-13 16:36:46 +0000617 }
drhc232aca2016-12-15 16:01:17 +0000618 puts $fd " \173/* zName: */ \"$name\","
619 puts $fd " /* ePragTyp: */ PragTyp_$type,"
620 puts $fd " /* ePragFlg: */ $flagx,"
621 puts $fd " /* ColNames: */ $cy, $nx,"
622 puts $fd " /* iArg: */ $arg \175,"
drh9ccd8652013-09-13 16:36:46 +0000623}
mistachkindd197832013-10-21 23:17:23 +0000624if {$current_if!=""} {
625 foreach this_if $current_if {
drh67e65e52015-02-02 21:34:54 +0000626 puts $fd "#endif"
mistachkindd197832013-10-21 23:17:23 +0000627 }
628}
drh67e65e52015-02-02 21:34:54 +0000629puts $fd "\175;"
drh6bb64f62013-09-13 16:56:17 +0000630
631# count the number of pragmas, for information purposes
632#
633set allcnt 0
634set dfltcnt 0
635foreach name $allnames {
636 incr allcnt
637 set if [lindex $allbyname($name) 2]
638 if {[regexp {^defined} $if] || [regexp {[^!]defined} $if]} continue
639 incr dfltcnt
640}
drh67e65e52015-02-02 21:34:54 +0000641puts $fd "/* Number of pragmas: $dfltcnt on by default, $allcnt total. */"