1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# $Id: gen-sql-comments.py $
"""
Converts doxygen style comments in SQL script to COMMENT ON statements.
"""
__copyright__ = \
"""
Copyright (C) 2012-2023 Oracle and/or its affiliates.
This file is part of VirtualBox base platform packages, as
available from https://www.virtualbox.org.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation, in version 3 of the
License.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, see <https://www.gnu.org/licenses>.
The contents of this file may alternatively be used under the terms
of the Common Development and Distribution License Version 1.0
(CDDL), a copy of it is provided in the "COPYING.CDDL" file included
in the VirtualBox distribution, in which case the provisions of the
CDDL are applicable instead of those of the GPL.
You may elect to license modified versions of this file under the
terms and conditions of either the GPL or the CDDL or both.
SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
"""
import sys;
import re;
def errorMsg(sMsg):
sys.stderr.write('error: %s\n' % (sMsg,));
return 1;
class SqlDox(object):
"""
Class for parsing relevant comments out of a pgsql file
and emit COMMENT ON statements from it.
"""
def __init__(self, oFile, sFilename):
self.oFile = oFile;
self.sFilename = sFilename;
self.iLine = 0; # The current input line number.
self.sComment = None; # The current comment.
self.fCommentComplete = False; # Indicates that the comment has ended.
self.sCommentSqlObj = None; # SQL object indicated by the comment (@table).
self.sOuterSqlObj = None; # Like 'table yyyy' or 'type zzzz'.
self.sPrevSqlObj = None; # Like 'table xxxx'.
def error(self, sMsg):
return errorMsg('%s(%d): %s' % (self.sFilename, self.iLine, sMsg,));
def dprint(self, sMsg):
sys.stderr.write('debug: %s\n' % (sMsg,));
return True;
def resetComment(self):
self.sComment = None;
self.fCommentComplete = False;
self.sCommentSqlObj = None;
def quoteSqlString(self, s):
return s.replace("'", "''");
def commitComment2(self, sSqlObj):
if self.sComment is not None and sSqlObj is not None:
print("COMMENT ON %s IS\n '%s';\n" % (sSqlObj, self.quoteSqlString(self.sComment.strip())));
self.resetComment();
return True;
def commitComment(self):
return self.commitComment2(self.sCommentSqlObj);
def process(self):
for sLine in self.oFile:
self.iLine += 1;
sLine = sLine.strip();
self.dprint('line %d: %s\n' % (self.iLine, sLine));
if sLine.startswith('--'):
if sLine.startswith('--- '):
#
# New comment.
# The first list may have a @table, @type or similar that we're interested in.
#
self.commitComment();
sLine = sLine.lstrip('- ');
if sLine.startswith('@table '):
self.sCommentSqlObj = 'TABLE ' + (sLine[7:]).rstrip();
self.sComment = '';
elif sLine.startswith('@type '):
self.sCommentSqlObj = 'TYPE ' + (sLine[6:]).rstrip();
self.sComment = '';
elif sLine.startswith('@todo') \
or sLine.startswith('@file') \
or sLine.startswith('@page') \
or sLine.startswith('@name') \
or sLine.startswith('@{') \
or sLine.startswith('@}'):
# Ignore.
pass;
elif sLine.startswith('@'):
return self.error('Unknown tag: %s' % (sLine,));
else:
self.sComment = sLine;
elif (sLine.startswith('-- ') or sLine == '--') \
and self.sComment is not None and self.fCommentComplete is False:
#
# Append line to comment.
#
if sLine == '--':
sLine = '';
else:
sLine = (sLine[3:]);
if self.sComment == '':
self.sComment = sLine;
else:
self.sComment += "\n" + sLine;
elif sLine.startswith('--< '):
#
# Comment that starts on the same line as the object it describes.
#
sLine = (sLine[4:]).rstrip();
# => Later/never.
else:
#
# Not a comment that interests us. So, complete any open
# comment and commit it if we know which SQL object it
# applies to.
#
self.fCommentComplete = True;
if self.sCommentSqlObj is not None:
self.commitComment();
else:
#
# Not a comment. As above, we complete and optionally commit
# any open comment.
#
self.fCommentComplete = True;
if self.sCommentSqlObj is not None:
self.commitComment();
#
# Check for SQL (very fuzzy and bad).
#
asWords = sLine.split(' ');
if len(asWords) >= 3 \
and asWords[0] == 'CREATE':
# CREATE statement.
sType = asWords[1];
sName = asWords[2];
if sType == 'UNIQUE' and sName == 'INDEX' and len(asWords) >= 4:
sType = asWords[2];
sName = asWords[3];
if sType in ('TABLE', 'TYPE', 'INDEX', 'VIEW'):
self.sOuterSqlObj = sType + ' ' + sName;
self.sPrevSqlObj = self.sOuterSqlObj;
self.dprint('%s' % (self.sOuterSqlObj,));
self.commitComment2(self.sOuterSqlObj);
elif len(asWords) >= 1 \
and self.sOuterSqlObj is not None \
and self.sOuterSqlObj.startswith('TABLE ') \
and re.search("^(as|al|bm|c|enm|f|i|l|s|ts|uid|uuid)[A-Z][a-zA-Z0-9]*$", asWords[0]) is not None:
# Possibly a column name.
self.sPrevSqlObj = 'COLUMN ' + self.sOuterSqlObj[6:] + '.' + asWords[0];
self.dprint('column? %s' % (self.sPrevSqlObj));
self.commitComment2(self.sPrevSqlObj);
#
# Check for semicolon.
#
if sLine.find(");") >= 0:
self.sOuterSqlObj = None;
return 0;
def usage():
sys.stderr.write('usage: gen-sql-comments.py <filename.pgsql>\n'
'\n'
'The output goes to stdout.\n');
return 0;
def main(asArgs):
# Parse the argument. :-)
sInput = None;
if (len(asArgs) != 2):
sys.stderr.write('syntax error: expected exactly 1 argument, a psql file\n');
usage();
return 2;
sInput = asArgs[1];
# Do the job, outputting to standard output.
try:
oFile = open(sInput, 'r');
except:
return errorMsg("failed to open '%s' for reading" % (sInput,));
# header.
print("-- $" "Id" "$");
print("--- @file");
print("-- Autogenerated from %s. Do not edit!" % (sInput,));
print("--");
print("");
for sLine in __copyright__.split('\n'):
if len(sLine) > 0:
print("-- %s" % (sLine,));
else:
print("--");
print("");
print("");
me = SqlDox(oFile, sInput);
return me.process();
sys.exit(main(sys.argv));
|
