Mercurial > hg > orthanc-webviewer
annotate Orthanc/Resources/EmbedResources.py @ 167:bd5597966b3d
sync
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 22 Aug 2017 21:46:50 +0200 |
parents | 5dc54316d68b |
children | dd1ad819ca33 |
rev | line source |
---|---|
78 | 1 #!/usr/bin/python |
2 | |
3 # Orthanc - A Lightweight, RESTful DICOM Store | |
122 | 4 # Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics |
78 | 5 # Department, University Hospital of Liege, Belgium |
159
5dc54316d68b
shared copyright with osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
6 # Copyright (C) 2017 Osimis, Belgium |
78 | 7 # |
8 # This program is free software: you can redistribute it and/or | |
9 # modify it under the terms of the GNU General Public License as | |
10 # published by the Free Software Foundation, either version 3 of the | |
11 # License, or (at your option) any later version. | |
12 # | |
13 # In addition, as a special exception, the copyright holders of this | |
14 # program give permission to link the code of its release with the | |
15 # OpenSSL project's "OpenSSL" library (or with modified versions of it | |
16 # that use the same license as the "OpenSSL" library), and distribute | |
17 # the linked executables. You must obey the GNU General Public License | |
18 # in all respects for all of the code used other than "OpenSSL". If you | |
19 # modify file(s) with this exception, you may extend this exception to | |
20 # your version of the file(s), but you are not obligated to do so. If | |
21 # you do not wish to do so, delete this exception statement from your | |
22 # version. If you delete this exception statement from all source files | |
23 # in the program, then also delete it here. | |
24 # | |
25 # This program is distributed in the hope that it will be useful, but | |
26 # WITHOUT ANY WARRANTY; without even the implied warranty of | |
27 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
28 # General Public License for more details. | |
29 # | |
30 # You should have received a copy of the GNU General Public License | |
31 # along with this program. If not, see <http://www.gnu.org/licenses/>. | |
32 | |
33 | |
34 import sys | |
35 import os | |
36 import os.path | |
37 import pprint | |
38 import re | |
39 | |
40 UPCASE_CHECK = True | |
41 USE_SYSTEM_EXCEPTION = False | |
42 EXCEPTION_CLASS = 'OrthancException' | |
43 OUT_OF_RANGE_EXCEPTION = 'OrthancException(ErrorCode_ParameterOutOfRange)' | |
44 INEXISTENT_PATH_EXCEPTION = 'OrthancException(ErrorCode_InexistentItem)' | |
45 NAMESPACE = 'Orthanc' | |
46 | |
47 ARGS = [] | |
48 for i in range(len(sys.argv)): | |
49 if not sys.argv[i].startswith('--'): | |
50 ARGS.append(sys.argv[i]) | |
51 elif sys.argv[i].lower() == '--no-upcase-check': | |
52 UPCASE_CHECK = False | |
53 elif sys.argv[i].lower() == '--system-exception': | |
54 USE_SYSTEM_EXCEPTION = True | |
55 EXCEPTION_CLASS = '::std::runtime_error' | |
56 OUT_OF_RANGE_EXCEPTION = '%s("Parameter out of range")' % EXCEPTION_CLASS | |
57 INEXISTENT_PATH_EXCEPTION = '%s("Unknown path in a directory resource")' % EXCEPTION_CLASS | |
58 elif sys.argv[i].startswith('--namespace='): | |
59 NAMESPACE = sys.argv[i][sys.argv[i].find('=') + 1 : ] | |
60 | |
61 if len(ARGS) < 2 or len(ARGS) % 2 != 0: | |
62 print ('Usage:') | |
63 print ('python %s [--no-upcase-check] [--system-exception] [--namespace=<Namespace>] <TargetBaseFilename> [ <Name> <Source> ]*' % sys.argv[0]) | |
64 exit(-1) | |
65 | |
66 TARGET_BASE_FILENAME = ARGS[1] | |
67 SOURCES = ARGS[2:] | |
68 | |
69 try: | |
70 # Make sure the destination directory exists | |
71 os.makedirs(os.path.normpath(os.path.join(TARGET_BASE_FILENAME, '..'))) | |
72 except: | |
73 pass | |
74 | |
75 | |
76 ##################################################################### | |
77 ## Read each resource file | |
78 ##################################################################### | |
79 | |
80 def CheckNoUpcase(s): | |
81 global UPCASE_CHECK | |
82 if (UPCASE_CHECK and | |
83 re.search('[A-Z]', s) != None): | |
84 raise Exception("Path in a directory with an upcase letter: %s" % s) | |
85 | |
86 resources = {} | |
87 | |
88 counter = 0 | |
89 i = 0 | |
90 while i < len(SOURCES): | |
91 resourceName = SOURCES[i].upper() | |
92 pathName = SOURCES[i + 1] | |
93 | |
94 if not os.path.exists(pathName): | |
95 raise Exception("Non existing path: %s" % pathName) | |
96 | |
97 if resourceName in resources: | |
98 raise Exception("Twice the same resource: " + resourceName) | |
99 | |
100 if os.path.isdir(pathName): | |
101 # The resource is a directory: Recursively explore its files | |
102 content = {} | |
103 for root, dirs, files in os.walk(pathName): | |
104 base = os.path.relpath(root, pathName) | |
105 | |
106 # Fix issue #24 (Build fails on OSX when directory has .DS_Store files): | |
107 # Ignore folders whose name starts with a dot (".") | |
108 if base.find('/.') != -1: | |
109 print('Ignoring folder: %s' % root) | |
110 continue | |
111 | |
112 for f in files: | |
113 if f.find('~') == -1: # Ignore Emacs backup files | |
114 if base == '.': | |
115 r = f | |
116 else: | |
117 r = os.path.join(base, f) | |
118 | |
119 CheckNoUpcase(r) | |
120 r = '/' + r.replace('\\', '/') | |
121 if r in content: | |
122 raise Exception("Twice the same filename (check case): " + r) | |
123 | |
124 content[r] = { | |
125 'Filename' : os.path.join(root, f), | |
126 'Index' : counter | |
127 } | |
128 counter += 1 | |
129 | |
130 resources[resourceName] = { | |
131 'Type' : 'Directory', | |
132 'Files' : content | |
133 } | |
134 | |
135 elif os.path.isfile(pathName): | |
136 resources[resourceName] = { | |
137 'Type' : 'File', | |
138 'Index' : counter, | |
139 'Filename' : pathName | |
140 } | |
141 counter += 1 | |
142 | |
143 else: | |
144 raise Exception("Not a regular file, nor a directory: " + pathName) | |
145 | |
146 i += 2 | |
147 | |
148 #pprint.pprint(resources) | |
149 | |
150 | |
151 ##################################################################### | |
152 ## Write .h header | |
153 ##################################################################### | |
154 | |
155 header = open(TARGET_BASE_FILENAME + '.h', 'w') | |
156 | |
157 header.write(""" | |
158 #pragma once | |
159 | |
160 #include <string> | |
161 #include <list> | |
162 | |
155 | 163 #if defined(_MSC_VER) |
164 # pragma warning(disable: 4065) // "Switch statement contains 'default' but no 'case' labels" | |
165 #endif | |
166 | |
78 | 167 namespace %s |
168 { | |
169 namespace EmbeddedResources | |
170 { | |
171 enum FileResourceId | |
172 { | |
173 """ % NAMESPACE) | |
174 | |
175 isFirst = True | |
176 for name in resources: | |
177 if resources[name]['Type'] == 'File': | |
178 if isFirst: | |
179 isFirst = False | |
180 else: | |
181 header.write(',\n') | |
182 header.write(' %s' % name) | |
183 | |
184 header.write(""" | |
185 }; | |
186 | |
187 enum DirectoryResourceId | |
188 { | |
189 """) | |
190 | |
191 isFirst = True | |
192 for name in resources: | |
193 if resources[name]['Type'] == 'Directory': | |
194 if isFirst: | |
195 isFirst = False | |
196 else: | |
197 header.write(',\n') | |
198 header.write(' %s' % name) | |
199 | |
200 header.write(""" | |
201 }; | |
202 | |
203 const void* GetFileResourceBuffer(FileResourceId id); | |
204 size_t GetFileResourceSize(FileResourceId id); | |
205 void GetFileResource(std::string& result, FileResourceId id); | |
206 | |
207 const void* GetDirectoryResourceBuffer(DirectoryResourceId id, const char* path); | |
208 size_t GetDirectoryResourceSize(DirectoryResourceId id, const char* path); | |
209 void GetDirectoryResource(std::string& result, DirectoryResourceId id, const char* path); | |
210 | |
211 void ListResources(std::list<std::string>& result, DirectoryResourceId id); | |
212 } | |
213 } | |
214 """) | |
215 header.close() | |
216 | |
217 | |
218 | |
219 ##################################################################### | |
220 ## Write the resource content in the .cpp source | |
221 ##################################################################### | |
222 | |
223 PYTHON_MAJOR_VERSION = sys.version_info[0] | |
224 | |
225 def WriteResource(cpp, item): | |
226 cpp.write(' static const uint8_t resource%dBuffer[] = {' % item['Index']) | |
227 | |
228 f = open(item['Filename'], "rb") | |
229 content = f.read() | |
230 f.close() | |
231 | |
232 # http://stackoverflow.com/a/1035360 | |
233 pos = 0 | |
234 for b in content: | |
235 if PYTHON_MAJOR_VERSION == 2: | |
236 c = ord(b[0]) | |
237 else: | |
238 c = b | |
239 | |
240 if pos > 0: | |
241 cpp.write(', ') | |
242 | |
243 if (pos % 16) == 0: | |
244 cpp.write('\n ') | |
245 | |
246 if c < 0: | |
247 raise Exception("Internal error") | |
248 | |
249 cpp.write("0x%02x" % c) | |
250 pos += 1 | |
251 | |
252 # Zero-size array are disallowed, so we put one single void character in it. | |
253 if pos == 0: | |
254 cpp.write(' 0') | |
255 | |
256 cpp.write(' };\n') | |
257 cpp.write(' static const size_t resource%dSize = %d;\n' % (item['Index'], pos)) | |
258 | |
259 | |
260 cpp = open(TARGET_BASE_FILENAME + '.cpp', 'w') | |
261 | |
262 cpp.write('#include "%s.h"\n' % os.path.basename(TARGET_BASE_FILENAME)) | |
263 | |
264 if USE_SYSTEM_EXCEPTION: | |
265 cpp.write('#include <stdexcept>') | |
266 else: | |
267 cpp.write('#include "%s/Core/OrthancException.h"' % os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))) | |
268 | |
269 cpp.write(""" | |
270 #include <stdint.h> | |
271 #include <string.h> | |
272 | |
273 namespace %s | |
274 { | |
275 namespace EmbeddedResources | |
276 { | |
277 """ % NAMESPACE) | |
278 | |
279 | |
280 for name in resources: | |
281 if resources[name]['Type'] == 'File': | |
282 WriteResource(cpp, resources[name]) | |
283 else: | |
284 for f in resources[name]['Files']: | |
285 WriteResource(cpp, resources[name]['Files'][f]) | |
286 | |
287 | |
288 | |
289 ##################################################################### | |
290 ## Write the accessors to the file resources in .cpp | |
291 ##################################################################### | |
292 | |
293 cpp.write(""" | |
294 const void* GetFileResourceBuffer(FileResourceId id) | |
295 { | |
296 switch (id) | |
297 { | |
298 """) | |
299 for name in resources: | |
300 if resources[name]['Type'] == 'File': | |
301 cpp.write(' case %s:\n' % name) | |
302 cpp.write(' return resource%dBuffer;\n' % resources[name]['Index']) | |
303 | |
304 cpp.write(""" | |
305 default: | |
306 throw %s; | |
307 } | |
308 } | |
309 | |
310 size_t GetFileResourceSize(FileResourceId id) | |
311 { | |
312 switch (id) | |
313 { | |
314 """ % OUT_OF_RANGE_EXCEPTION) | |
315 | |
316 for name in resources: | |
317 if resources[name]['Type'] == 'File': | |
318 cpp.write(' case %s:\n' % name) | |
319 cpp.write(' return resource%dSize;\n' % resources[name]['Index']) | |
320 | |
321 cpp.write(""" | |
322 default: | |
323 throw %s; | |
324 } | |
325 } | |
326 """ % OUT_OF_RANGE_EXCEPTION) | |
327 | |
328 | |
329 | |
330 ##################################################################### | |
331 ## Write the accessors to the directory resources in .cpp | |
332 ##################################################################### | |
333 | |
334 cpp.write(""" | |
335 const void* GetDirectoryResourceBuffer(DirectoryResourceId id, const char* path) | |
336 { | |
337 switch (id) | |
338 { | |
339 """) | |
340 | |
341 for name in resources: | |
342 if resources[name]['Type'] == 'Directory': | |
343 cpp.write(' case %s:\n' % name) | |
344 isFirst = True | |
345 for path in resources[name]['Files']: | |
346 cpp.write(' if (!strcmp(path, "%s"))\n' % path) | |
347 cpp.write(' return resource%dBuffer;\n' % resources[name]['Files'][path]['Index']) | |
348 cpp.write(' throw %s;\n\n' % INEXISTENT_PATH_EXCEPTION) | |
349 | |
350 cpp.write(""" default: | |
351 throw %s; | |
352 } | |
353 } | |
354 | |
355 size_t GetDirectoryResourceSize(DirectoryResourceId id, const char* path) | |
356 { | |
357 switch (id) | |
358 { | |
359 """ % OUT_OF_RANGE_EXCEPTION) | |
360 | |
361 for name in resources: | |
362 if resources[name]['Type'] == 'Directory': | |
363 cpp.write(' case %s:\n' % name) | |
364 isFirst = True | |
365 for path in resources[name]['Files']: | |
366 cpp.write(' if (!strcmp(path, "%s"))\n' % path) | |
367 cpp.write(' return resource%dSize;\n' % resources[name]['Files'][path]['Index']) | |
368 cpp.write(' throw %s;\n\n' % INEXISTENT_PATH_EXCEPTION) | |
369 | |
370 cpp.write(""" default: | |
371 throw %s; | |
372 } | |
373 } | |
374 """ % OUT_OF_RANGE_EXCEPTION) | |
375 | |
376 | |
377 | |
378 | |
379 ##################################################################### | |
380 ## List the resources in a directory | |
381 ##################################################################### | |
382 | |
383 cpp.write(""" | |
384 void ListResources(std::list<std::string>& result, DirectoryResourceId id) | |
385 { | |
386 result.clear(); | |
387 | |
388 switch (id) | |
389 { | |
390 """) | |
391 | |
392 for name in resources: | |
393 if resources[name]['Type'] == 'Directory': | |
394 cpp.write(' case %s:\n' % name) | |
395 for path in sorted(resources[name]['Files']): | |
396 cpp.write(' result.push_back("%s");\n' % path) | |
397 cpp.write(' break;\n\n') | |
398 | |
399 cpp.write(""" default: | |
400 throw %s; | |
401 } | |
402 } | |
403 """ % OUT_OF_RANGE_EXCEPTION) | |
404 | |
405 | |
406 | |
407 | |
408 ##################################################################### | |
409 ## Write the convenience wrappers in .cpp | |
410 ##################################################################### | |
411 | |
412 cpp.write(""" | |
413 void GetFileResource(std::string& result, FileResourceId id) | |
414 { | |
415 size_t size = GetFileResourceSize(id); | |
416 result.resize(size); | |
417 if (size > 0) | |
418 memcpy(&result[0], GetFileResourceBuffer(id), size); | |
419 } | |
420 | |
421 void GetDirectoryResource(std::string& result, DirectoryResourceId id, const char* path) | |
422 { | |
423 size_t size = GetDirectoryResourceSize(id, path); | |
424 result.resize(size); | |
425 if (size > 0) | |
426 memcpy(&result[0], GetDirectoryResourceBuffer(id, path), size); | |
427 } | |
428 } | |
429 } | |
430 """) | |
431 cpp.close() |