python: scripting: Port ntstatus and werror generators to Python 3 compatible form.
[sfrench/samba-autobuild/.git] / source4 / scripting / bin / gen_werror.py
1 #!/usr/bin/env python
2
3 #
4 # Unix SMB/CIFS implementation.
5 #
6 # WERROR error definition generation
7 #
8 # Copyright (C) Catalyst.Net Ltd. 2017
9 #
10 # This program is free software; you can redistribute it and/or modify
11 # it under the terms of the GNU General Public License as published by
12 # the Free Software Foundation; either version 3 of the License, or
13 # (at your option) any later version.
14 #
15 # This program is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 # GNU General Public License for more details.
19 #
20 # You should have received a copy of the GNU General Public License
21 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
22 #
23
24 import sys, os.path, io, string
25 from gen_error_common import parseErrorDescriptions, ErrorDef
26
27 def generateHeaderFile(out_file, errors):
28     out_file.write("/*\n")
29     out_file.write(" * Descriptions for errors generated from\n")
30     out_file.write(" * [MS-ERREF] https://msdn.microsoft.com/en-us/library/cc231199.aspx\n")
31     out_file.write(" */\n\n")
32     out_file.write("#ifndef _WERR_GEN_H\n")
33     out_file.write("#define _WERR_GEN_H\n")
34     for err in errors:
35         line = "#define %s W_ERROR(%s)\n" % (err.err_define, hex(err.err_code))
36         out_file.write(line)
37     out_file.write("\n#endif /* _WERR_GEN_H */\n")
38
39 def generateSourceFile(out_file, errors):
40     out_file.write("#include \"werror.h\"\n")
41
42     out_file.write("/*\n")
43     out_file.write(" * Names for errors generated from\n")
44     out_file.write(" * [MS-ERREF] https://msdn.microsoft.com/en-us/library/cc231199.aspx\n")
45     out_file.write(" */\n")
46
47     out_file.write("static const struct werror_code_struct dos_errs[] = \n")
48     out_file.write("{\n")
49     for err in errors:
50         out_file.write("\t{ \"%s\", %s },\n" % (err.err_define, err.err_define))
51     out_file.write("{ 0, W_ERROR(0) }\n")
52     out_file.write("};\n")
53
54     out_file.write("\n/*\n")
55     out_file.write(" * Descriptions for errors generated from\n")
56     out_file.write(" * [MS-ERREF] https://msdn.microsoft.com/en-us/library/cc231199.aspx\n")
57     out_file.write(" */\n")
58
59     out_file.write("static const struct werror_str_struct dos_err_strs[] = \n")
60     out_file.write("{\n")
61     for err in errors:
62         # Account for the possibility that some errors may not have descriptions
63         if err.err_string == "":
64             continue
65         out_file.write("\t{ %s, \"%s\" },\n"%(err.err_define, err.err_string))
66     out_file.write("\t{ W_ERROR(0), 0 }\n")
67     out_file.write("};")
68
69 def generatePythonFile(out_file, errors):
70     out_file.write("/*\n")
71     out_file.write(" * Errors generated from\n")
72     out_file.write(" * [MS-ERREF] https://msdn.microsoft.com/en-us/library/cc231199.aspx\n")
73     out_file.write(" */\n")
74     out_file.write("#include <Python.h>\n")
75     out_file.write("#include \"includes.h\"\n\n")
76     out_file.write("static inline PyObject *ndr_PyLong_FromUnsignedLongLong(unsigned long long v)\n");
77     out_file.write("{\n");
78     out_file.write("\tif (v > LONG_MAX) {\n");
79     out_file.write("\t\treturn PyLong_FromUnsignedLongLong(v);\n");
80     out_file.write("\t} else {\n");
81     out_file.write("\t\treturn PyInt_FromLong(v);\n");
82     out_file.write("\t}\n");
83     out_file.write("}\n\n");
84     # This is needed to avoid a missing prototype error from the C
85     # compiler. There is never a prototype for this function, it is a
86     # module loaded by python with dlopen() and found with dlsym().
87     out_file.write("void initwerror(void);\n")
88     out_file.write("void initwerror(void)\n")
89     out_file.write("{\n")
90     out_file.write("\tPyObject *m;\n\n")
91     out_file.write("\tm = Py_InitModule3(\"werror\", NULL, \"WERROR defines\");\n");
92     out_file.write("\tif (m == NULL)\n");
93     out_file.write("\t\treturn;\n\n");
94     for err in errors:
95         line = """\tPyModule_AddObject(m, \"%s\",
96                   \t\tndr_PyLong_FromUnsignedLongLong(W_ERROR_V(%s)));\n""" % (err.err_define, err.err_define)
97         out_file.write(line)
98     out_file.write("}\n");
99
100 def transformErrorName( error_name ):
101     if error_name.startswith("WERR_"):
102         error_name = error_name.replace("WERR_", "", 1)
103     elif error_name.startswith("ERROR_"):
104         error_name = error_name.replace("ERROR_", "", 1)
105     return "WERR_" + error_name.upper()
106
107 # Script to generate files werror_gen.h, doserr_gen.c and
108 # py_werror.c.
109 #
110 # These files contain generated definitions for WERRs and
111 # their descriptions/names.
112 #
113 # This script takes four inputs:
114 # [1]: The name of the text file which is the content of an HTML table
115 #      (e.g. the one found at https://msdn.microsoft.com/en-us/library/cc231199.aspx)
116 #      copied and pasted.
117 # [2]: [[output werror_gen.h]]
118 # [3]: [[output doserr_gen.c]]
119 # [4]: [[output py_werror.c]]
120 def main():
121     if len(sys.argv) == 5:
122         input_file_name = sys.argv[1]
123         gen_headerfile_name = sys.argv[2]
124         gen_sourcefile_name = sys.argv[3]
125         gen_pythonfile_name = sys.argv[4]
126     else:
127         print("usage: %s winerrorfile headerfile sourcefile pythonfile" % sys.argv[0])
128         sys.exit()
129
130     input_file = open(input_file_name, "r")
131     errors = parseErrorDescriptions(input_file, True, transformErrorName)
132     input_file.close()
133
134     print("writing new header file: %s" % gen_headerfile_name)
135     out_file = open(gen_headerfile_name, "w")
136     generateHeaderFile(out_file, errors)
137     out_file.close()
138     print("writing new source file: %s" % gen_sourcefile_name)
139     out_file = open(gen_sourcefile_name, "w")
140     generateSourceFile(out_file, errors)
141     out_file.close()
142     print("writing new python file: %s" % gen_pythonfile_name)
143     out_file = open(gen_pythonfile_name, "w")
144     generatePythonFile(out_file, errors)
145     out_file.close()
146
147 if __name__ == '__main__':
148
149     main()