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