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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
|
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#========================================================================================
# File: "macbuild/build4mac_util.py"
#
# Here are utility functions and classes ...
# for building KLayout (http://www.klayout.de/index.php)
# version 0.29.7 or later on different Apple Mac OSX platforms.
#
# This file is imported by 'build4mac.py' script.
#========================================================================================
import sys
import os
import re
import string
import subprocess
import shutil
import fnmatch
#----------------------------------------------------------------------------------------
## To import global dictionaries of different modules
#----------------------------------------------------------------------------------------
mydir = os.path.dirname(os.path.abspath(__file__))
sys.path.append( mydir )
from build4mac_env import *
#----------------------------------------------------------------------------------------
## To decompose strings obtained by 'otool -L <*.dylib>' command and to
# generate a dictionary of KLayout's inter-library dependency.
#
# @param[in] depstr strings that tell dependency such as:
#
# libklayout_edt.0.dylib:
# libklayout_edt.0.dylib (compatibility version 0.26.0, current version 0.26.1)
# libklayout_tl.0.dylib (compatibility version 0.26.0, current version 0.26.1)
# libklayout_gsi.0.dylib (compatibility version 0.26.0, current version 0.26.1)
# libklayout_laybasic.0.dylib (compatibility version 0.26.0, current version 0.26.1)
# libklayout_db.0.dylib (compatibility version 0.26.0, current version 0.26.1)
# :
# :
#
# @return a dictionary
#----------------------------------------------------------------------------------------
def DecomposeLibraryDependency( depstr ):
alllines = depstr.split('\n')
numlines = len(alllines)
dependent = alllines[0].split(':')[0].strip()
supporters = []
for line in alllines[1:]:
supporter = line.strip().split(' ')[0].strip()
if not supporter == '':
supporters.append(supporter)
return { dependent: supporters }
#----------------------------------------------------------------------------------------
## To print the contents of a library dependency dictionary
#
# @param[in] depdic dictionary
# @param[in] pathdic path dictionary
# @param[in] namedic dictionary name
#----------------------------------------------------------------------------------------
def PrintLibraryDependencyDictionary( depdic, pathdic, namedic ):
keys = depdic.keys()
print( "" )
print( "##### Contents of <%s> #####:" % namedic )
for key in keys:
supporters = depdic[key]
keyName = os.path.basename(key)
print( " %s: (%s)" % (key, pathdic[keyName]) )
for item in supporters:
itemName = os.path.basename(item)
if itemName != keyName and (itemName in pathdic):
print( " %s (%s)" % (item, pathdic[itemName]) )
#----------------------------------------------------------------------------------------
## To set and change identification name of KLayout's dylib
#
# @param[in] libdic inter-library dependency dictionary
#
# @return 0 on success; non-zero on failure
#----------------------------------------------------------------------------------------
def SetChangeIdentificationNameOfDyLib( libdic, pathDic ):
if len(libdic) == 0 or len(pathDic) == 0:
return 0
cmdNameId = XcodeToolChain['nameID']
cmdNameChg = XcodeToolChain['nameCH']
dependentLibs = libdic.keys()
for lib in dependentLibs:
#-----------------------------------------------------------
# [1] Set the identification name of each dependent library
#-----------------------------------------------------------
nameOld = "%s" % lib
libName = os.path.basename(lib)
nameNew = pathDic[libName]
command = "%s %s %s" % ( cmdNameId, nameNew, nameOld )
if subprocess.call( command, shell=True ) != 0:
msg = "!!! Failed to set the new identification name to <%s> !!!"
print( msg % lib, file=sys.stderr )
return 1
#-------------------------------------------------------------------------
# [2] Make the library aware of the new identifications of all supporters
#-------------------------------------------------------------------------
supporters = libdic[lib]
for supName in supporters:
if (libName != supName) and (supName in pathDic):
nameOld = "%s" % supName
nameNew = pathDic[supName]
command = "%s %s %s %s" % ( cmdNameChg, nameOld, nameNew, lib )
if subprocess.call( command, shell=True ) != 0:
msg = "!!! Failed to make the library aware of the new identification name <%s> of supporter <%s> !!!"
print( msg % (nameNew, sup), file=sys.stderr )
return 1
# for-lib
return 0
#----------------------------------------------------------------------------------------
## To set the identification names of KLayout's libraries to an executable
# and make the application aware of the library locations
#
# @param[in] executable path/to/executable -- (1)
# @param[in] relativedir directory of dylib relative to executable -- (2)
#
# Example: (1) "klayout.app/Contents/MacOS/klayout"
# (2) "../Frameworks"
#
# klayout.app/+
# +-- Contents/+
# +-- Info.plist
# +-- PkgInfo
# +-- Resources/+
# | +-- 'klayout.icns'
# +-- Frameworks/+
# | +-- '*.framework'
# | +-- '*.dylib'
# | +-- 'db_plugins' --sym.link--> ../MacOS/db_plugins/
# | +-- 'lay_plugins' --sym.link--> ../MacOS/lay_plugins/
# | +-- 'pymod' --sym.link--> ../MacOS/pymod/
# +-- MacOS/+
# | +-- 'klayout'
# | +-- db_plugins/
# | +-- lay_plugins/
# | +-- pymod/
# |
# +-- Buddy/+
# +-- 'strm2cif'
# +-- 'strm2dxf'
# :
# +-- 'strmxor'
#
# @return 0 on success; non-zero on failure
#----------------------------------------------------------------------------------------
def SetChangeLibIdentificationName( executable, relativedir ):
cmdNameId = XcodeToolChain['nameID']
cmdNameChg = XcodeToolChain['nameCH']
otoolCm = "otool -L %s | grep libklayout" % executable
otoolOut = os.popen( otoolCm ).read()
exedepdic = DecomposeLibraryDependency( executable + ":\n" + otoolOut )
keys = exedepdic.keys()
deplibs = exedepdic[ list(keys)[0] ]
for lib in deplibs:
#-----------------------------------------------------------
# [1] Set the identification names for the library
# $ install_name_tool [-id name] input
#-----------------------------------------------------------
nameOld = "klayout.app/Contents/Frameworks/%s" % lib # input file
nameNew = "@executable_path/%s/%s" % ( relativedir, lib )
command = "%s %s %s" % ( cmdNameId, nameNew, nameOld )
if subprocess.call( command, shell=True ) != 0:
msg = "!!! Failed to set the new identification name to <%s> !!!"
print( msg % lib, file=sys.stderr )
return 1
#-----------------------------------------------------------
# [2] Make the application aware of the new identification
# $ install_name_tool [-change old new] input
#-----------------------------------------------------------
nameOld = "%s" % lib
nameNew = "@executable_path/%s/%s" % ( relativedir, lib )
command = "%s %s %s %s" % ( cmdNameChg, nameOld, nameNew, executable )
if subprocess.call( command, shell=True ) != 0:
msg = "!!! Failed to make the application aware of the new identification name <%s> !!!"
print( msg % nameNew, file=sys.stderr )
return 1
# for-lib
return 0
#----------------------------------------------------------------------------------------
## To make a library dependency dictionary by recursively walk down the lib hierarchy
# Refer to "macbuild/build4mac_env.py" for HomebrewSearchPathFilter[1|2]
#
# @param[in] dylibPath: dylib path
# @param[in] depth: hierarchy depth (< 5)
# @param[in] filter_regex: filter regular expression
# @param[in] debug_level: debug level
#
# @return a dictionary
#----------------------------------------------------------------------------------------
def WalkLibDependencyTree( dylibPath,
depth=0,
filter_regex=r'%s' % HomebrewSearchPathFilter1,
debug_level=0 ):
otoolCm = 'otool -L %s | grep -E "%s"' % (dylibPath, filter_regex)
otoolOut = os.popen( otoolCm ).read()
exedepdic = DecomposeLibraryDependency( dylibPath + ":\n" + otoolOut )
keys = exedepdic.keys()
deplibs = exedepdic[ list(keys)[0] ]
if debug_level > 0:
print( "In WalkLibDependencyTree()" )
print( " 1) depth = %d" % depth )
print( " 2) dylibPath = %s" % dylibPath )
print( " 3) exedepdic = %s" % exedepdic )
print( " 4) key = %s" % list(keys)[0] )
print( " 5) deplibs = %s" % deplibs )
if depth < 5:
if len(deplibs) > 0:
for idx, lib in enumerate(deplibs):
lib = str(lib)
if lib != list(keys)[0]:
deplibs[idx] = WalkLibDependencyTree( lib, depth+1, filter_regex, debug_level )
if depth == 0:
return deplibs
return exedepdic
else:
raise RuntimeError( "Exceeded maximum recursion depth." )
#----------------------------------------------------------------------------------------
## To make a library dependency dictionary by recursively walk down the Framework
# Refer to "macbuild/build4mac_env.py" for HomebrewSearchPathFilter[1|2]
#
# @param[in] frameworkPaths: Framework path
# @param[in] filter_regex: filter regular expression
# @param[in] search_path_filter: search path filter regular expression
# @param[in] debug_level: debug level
#
# @return a dictionary
#----------------------------------------------------------------------------------------
def WalkFrameworkPaths( frameworkPaths,
filter_regex=r'\.(so|dylib)$',
search_path_filter=r'%s' % HomebrewSearchPathFilter1,
debug_level=0 ):
if isinstance( frameworkPaths, str ):
frameworkPathsIter = [frameworkPaths]
else:
frameworkPathsIter = frameworkPaths
dependency_dict = dict()
for frameworkPath in frameworkPathsIter:
# print("Calling:", 'find %s -type f | grep -E "%s"' % (frameworkPath, filter_regex))
find_grep_results = os.popen( 'find %s -type f | grep -E "%s"' % (frameworkPath, filter_regex) ).read().split('\n')
framework_files = filter( lambda x: x != '', map(lambda x: x.strip(), find_grep_results) )
dependency_dict[frameworkPath] = list()
for idx, file in enumerate(framework_files):
dict_dep = WalkLibDependencyTree( file, filter_regex=search_path_filter, debug_level=debug_level )
if debug_level > 0:
print( "" )
print( "Return of WalkLibDependencyTree() for <%s>" % file )
print( " *) %s" % dict_dep )
print( "" )
dict_file = { file: dict_dep }
dependency_dict[frameworkPath].append(dict_file)
return dependency_dict
#----------------------------------------------------------------------------------------
## To dump the contents of a dependency dictionary
#
# @param[in] title: title
# @param[in] depdic: dependency dictionary to dump
# @param[in] debug_level: debug level
#
# @return void
#----------------------------------------------------------------------------------------
def DumpDependencyDic( title, depdic, debug_level=0 ):
if not debug_level > 0:
return
print( "### Dependency Dictionary <%s> ###" % title )
count1 = 0
for key1 in sorted(depdic.keys()):
count1 += 1
diclist = depdic[key1]
print( " %3d:%s" % (count1, key1) )
count2 = 0
for dict_file in diclist:
for key2 in sorted(dict_file.keys()):
count2 += 1
val2 = dict_file[key2]
print( " %3d:%s:%s" % (count2, key2, val2) )
#----------------------------------------------------------------------------------------
## To make a list of libraries to change
#
# @param[in] dependencyDict: library dependency dictionary
# @param[in] visited_files: list of visited files
#
# @return a list
#----------------------------------------------------------------------------------------
def WalkDictTree( dependencyDict, visited_files ):
libNameChanges = list()
for lib, dependencies in dependencyDict.items():
if lib in visited_files:
continue
dependency_list = list()
if isinstance(dependencies, list):
for deplib in dependencies:
if isinstance(deplib, str):
dependency_list.append(deplib)
if deplib not in visited_files:
visited_files.append(deplib)
elif isinstance(deplib, dict):
dependency_list.append( next(iter(deplib)) )
libNameChanges.extend( WalkDictTree(deplib, visited_files) )
else:
#raise RuntimeError("Unexpected value: %s" % deplib)
pass
else:
raise RuntimeError( "Unexpected value: %s" % dependencies )
if len(dependency_list) > 0:
libNameChanges.append( (lib, dependency_list) )
else:
libNameChanges.append( (lib, ) )
visited_files.append(lib)
return libNameChanges
#----------------------------------------------------------------------------------------
## To find the Framework name from a library name
#
# @param[in] path: path to a library
# @param[in] root_path: root path
#
# @return the path to a Framework
#----------------------------------------------------------------------------------------
def FindFramework( path, root_path ):
relPath = os.path.relpath(path, root_path)
frmPath = os.path.join(root_path, relPath.split(os.sep)[0])
#print( "###", frmPath, path, root_path )
return frmPath
#----------------------------------------------------------------------------------------
## To resolve an executable path
#
# @param[in] path: a path to resolve
# @param[in] executable_path: an executable path
#
# @return the resolved path
#----------------------------------------------------------------------------------------
def ResolveExecutablePath( path, executable_path ):
""" Transforms @executable_path into executable_path"""
p = path.replace( "@executable_path", "/%s/" % executable_path )
return p
#----------------------------------------------------------------------------------------
## To detect the library names to change
#
# @param[in] frameworkDependencyDict: framework dependency dictionary
#
# @return a list of changes, each of which is stored in the form of
# * ('lib.dylib', ['dep1.dylib', ...])
# OR
# * ('lib.dylib',)
#----------------------------------------------------------------------------------------
def DetectChanges(frameworkDependencyDict):
visited_files = list()
libNameChanges = list()
for framework, libraries in frameworkDependencyDict.items():
for libraryDict in libraries:
libNameChanges.extend( WalkDictTree(libraryDict, visited_files) )
return libNameChanges
#----------------------------------------------------------------------------------------
## To perform the required changes
#
# @param[in] frameworkDependencyDict: framework dependency dictionary
# @param[in] replaceFromToPairs: (from, to)-pair for replacement
# @param[in] executable_path: executable path
# @param[in] debug_level: debug level
#
# @return 0 on success; > 0 on failure
#----------------------------------------------------------------------------------------
def PerformChanges( frameworkDependencyDict,
replaceFromToPairs=None,
executable_path="/tmp/klayout",
debug_level=0 ):
libNameChanges = DetectChanges(frameworkDependencyDict)
# eg libNameChanges = [ ('lib.dylib',), ('lib.dylib',), ('lib.dylib', ['dep1.dylib', ...]), ... ]
if debug_level > 0:
print( "" )
print( "PerformChanges() ---> DetectChanges()" )
for tuple_item in libNameChanges:
if len(tuple_item) == 1:
print( " %s" % tuple_item[0] )
elif len(tuple_item) == 2:
print( " %s, %s" % (tuple_item[0], tuple_item[1]) )
print( "" )
cmdNameId = XcodeToolChain['nameID']
cmdNameChg = XcodeToolChain['nameCH']
if replaceFromToPairs is None:
return 0
else:
for libNameChange in libNameChanges:
libNameChangeIterator = iter(libNameChange)
lib = next(libNameChangeIterator) # 'lib.dylib'
if debug_level > 0:
print( "PerformChanges():lib = %s" % lib )
try:
dependencies = next(libNameChangeIterator) # dependencies = ['dep1.dylib', ...] if any
except StopIteration:
# if libNameChange == ('lib.dylib',)
dependencies = list()
for replaceFrom, replaceTo, libdir in replaceFromToPairs:
fileName = ResolveExecutablePath(lib.replace(replaceFrom, replaceTo), executable_path)
if debug_level > 0:
print( "PerformChanges():fileName = %s" % fileName )
if fileName.startswith('/usr'):
# print(f'skipping fileName: {fileName}')
continue
if lib.find(replaceFrom) >= 0:
if libdir:
frameworkPath = FindFramework(lib, replaceFrom)
else:
frameworkPath = lib
destFrameworkPath = frameworkPath.replace(replaceFrom, replaceTo)
destFrameworkPath = ResolveExecutablePath(destFrameworkPath, executable_path)
if not os.path.exists(fileName):
print( " NOT FOUND:", lib.replace(replaceFrom, replaceTo) )
print( " COPYING:", frameworkPath, " -> ", destFrameworkPath )
shutil.copytree(frameworkPath, destFrameworkPath)
nameId = lib.replace(replaceFrom, replaceTo)
command = "%s %s %s" % ( cmdNameId, nameId, fileName )
if not os.access(fileName, os.W_OK):
command = "chmod u+w %s; %s; chmod u-w %s" % (fileName, command, fileName)
# print("\t%s" % command)
if subprocess.call( command, shell=True ) != 0:
msg = "!!! Failed to set the new identification name to <%s> !!!"
print( msg % fileName, file=sys.stderr )
return 1
for dependency in dependencies:
if dependency.find(replaceFrom) >= 0:
print( " IN:", fileName )
print( " RENAMING:", dependency, " -> ", dependency.replace(replaceFrom, replaceTo) )
# Try changing id first
nameId = dependency.replace(replaceFrom, replaceTo)
command = "%s %s %s" % ( cmdNameId, nameId, fileName)
if not os.access(str(fileName), os.W_OK):
command = "chmod u+w %s; %s; chmod u-w %s" % (fileName, command, fileName)
# print("\t%s" % command)
if subprocess.call( command, shell=True ) != 0:
msg = "!!! Failed to set the new identification name to <%s> !!!"
print( msg % fileName, file=sys.stderr )
return 1
# Rename dependencies
nameOld = dependency
nameNew = dependency.replace(replaceFrom, replaceTo)
command = "%s %s %s %s" % ( cmdNameChg, nameOld, nameNew, str(fileName) )
if not os.access(str(fileName), os.W_OK):
command = "chmod u+w %s; %s; chmod u-w %s" % (fileName, command, fileName)
# print("\t%s" % command)
if subprocess.call( command, shell=True ) != 0:
msg = "!!! Failed to set the new identification name to <%s> !!!"
print( msg % fileName, file=sys.stderr )
return 1
return 0
#----------------------------------------------------------------------------------------
## To get KLayout's version from a file; most likely from 'version.sh'
#
# @param[in] verfile version file from which version is retrieved
#
# @return version string
#----------------------------------------------------------------------------------------
def GetKLayoutVersionFrom( verfile='version.h' ):
version = "?.?.?"
try:
fd = open( verfile, "r" )
contents = fd.readlines()
fd.close()
except Exception as e:
return version
verReg = re.compile( r'(KLAYOUT_VERSION=\")([0-9A-Z_a-z\.]+)(\")' )
for line in contents:
m = verReg.match(line)
if m:
# print(m.group(0)) # KLAYOUT_VERSION="0.26.1"
# print(m.group(1)) # KLAYOUT_VERSION="
# print(m.group(2)) # 0.26.1
# print(m.group(3)) # "
version = m.group(2)
return version
return version
#----------------------------------------------------------------------------------------
## To generate the contents of "Info.plist" file from a template
#
# @param[in] keydic dictionary of four key words ['exe', 'icon', 'bname', 'ver']
# @param[in] templfile template file ("macbuild/Resources/Info.plist.template")
#
# @return generated strings
#----------------------------------------------------------------------------------------
def GenerateInfoPlist( keydic, templfile ):
val_exe = keydic['exe']
val_icon = keydic['icon']
val_bname = keydic['bname']
val_ver = keydic['ver']
try:
fd = open( templfile, "r" )
template = fd.read()
fd.close()
except Exception as e:
return "???"
t = string.Template(template)
s = t.substitute( EXECUTABLE = val_exe,
ICONFILE = val_icon,
BUNDLENAME = val_bname,
VERSION = val_ver )
return s
#----------------------------------------------------------------------------------------
## To patch 'Python' itself in Python Framework
#
# A relatively new Python 3.x may depend on other dylib(s) under /usr/local/opt/.
# This was first found in:
# Catalina0{kazzz-s} klayout (1)% python3
# Python 3.8.16 (default, Dec 12 2022, 14:07:09)
# [Clang 12.0.0 (clang-1200.0.32.29)] on darwin
# Type "help", "copyright", "credits" or "license" for more information.
# >>>
#
# Catalina0{kazzz-s} Current (2)% pwd
# /usr/local/opt/python@3.8/Frameworks/Python.framework/Versions/Current
#
# Catalina0{kazzz-s} Current (3)% ll
# total 5024
# drwxr-xr-x 7 kazzz-s admin 224 Dec 16 23:02 .
# drwxr-xr-x 4 kazzz-s admin 128 Dec 16 21:40 ..
# lrwxr-xr-x 1 kazzz-s admin 17 Dec 17 08:46 Headers -> include/python3.8
# -rwxr-xr-x 1 kazzz-s admin 2571960 Dec 12 23:08 Python
# drwxr-xr-x 3 kazzz-s admin 96 Dec 12 23:08 include
# drwxr-xr-x 5 kazzz-s admin 160 Dec 12 23:08 lib
# drwxr-xr-x 3 kazzz-s admin 96 Dec 12 23:08 share
#
# Catalina0{kazzz-s} Current (4)% otool -L Python
# Python:
# /usr/local/opt/python@3.8/Frameworks/Python.framework/Versions/3.8/Python (compatibility version 3.8.0, current version 3.8.0)
# /System/Library/Frameworks/CoreFoundation.framework/Versions/A/CoreFoundation (compatibility version 150.0.0, current version 1675.129.0)
# [*] /usr/local/opt/gettext/lib/libintl.8.dylib (compatibility version 12.0.0, current version 12.0.0)
# /usr/lib/libSystem.B.dylib (compatibility version 1.0.0, current version 1281.100.1)
#
# This library dependency [*] has to be changed as shown below:
# Catalina0{kazzz-s} Current (5)% install_name_tool -change \
# /usr/local/opt/gettext/lib/libintl.8.dylib \
# @executable_path/../Frameworks/libintl.8.dylib \
# Python
#
# Catalina0{kazzz-s} Current (6)% otool -L Python
# Python:
# /usr/local/opt/python@3.8/Frameworks/Python.framework/Versions/3.8/Python (compatibility version 3.8.0, current version 3.8.0)
# /System/Library/Frameworks/CoreFoundation.framework/Versions/A/CoreFoundation (compatibility version 150.0.0, current version 1675.129.0)
# [*] @executable_path/../Frameworks/libintl.8.dylib (compatibility version 12.0.0, current version 12.0.0)
# /usr/lib/libSystem.B.dylib (compatibility version 1.0.0, current version 1281.100.1)
#
#
# @param[in] pythonFrameworkPath: Python Framework path
# @param[in] filter_regex: filter regular expression
# @param[in] debug_level: debug level
#
# @return 0 on succcess; non-zero on failure
#----------------------------------------------------------------------------------------
def Patch_Python_In_PythonFramework( pythonFrameworkPath,
filter_regex=r'\t+%s/opt' % DefaultHomebrewRoot,
debug_level=0 ):
#----------------------------------------------------------------------
# [1] Get Python's dependency
#----------------------------------------------------------------------
target = "%s/Python" % pythonFrameworkPath
otoolCm = 'otool -L %s | grep -E "%s"' % (target, filter_regex)
otoolOut = os.popen( otoolCm ).read()
exedepdic = DecomposeLibraryDependency( target + ":\n" + otoolOut )
keys = exedepdic.keys()
deplibs = exedepdic[ list(keys)[0] ]
# print(deplibs)
# [ '/usr/local/opt/python@3.8/Frameworks/Python.framework/Versions/3.8/Python',
# '/usr/local/opt/gettext/lib/libintl.8.dylib'
# ]
#----------------------------------------------------------------------
# [2] Change the library name
#----------------------------------------------------------------------
cmdNameChg = XcodeToolChain['nameCH']
for lib in deplibs:
basename = os.path.basename(lib)
if basename == "Python": # self
continue
else:
nameOld = "%s" % lib
nameNew = "@executable_path/../Frameworks/%s" % basename
command = "%s %s %s %s" % ( cmdNameChg, nameOld, nameNew, target )
if subprocess.call( command, shell=True ) != 0:
msg = "!!! Failed to make 'Python' aware of the new identification name <%s> of supporter <%s> !!!"
print( msg % (nameNew, lib), file=sys.stderr )
return 1
# for-lib
return 0
#----------------------------------------------------------------------------------------
## To change the Python's relative library paths to the absolute paths
#
# 1: absolute path as seen in ~python@3.9.17
# BigSur{kazzz-s} lib-dynload (1)% otool -L _sqlite3.cpython-39-darwin.so
# _sqlite3.cpython-39-darwin.so:
# ===> /usr/local/opt/sqlite/lib/libsqlite3.0.dylib (compatibility version 9.0.0, current version 9.6.0)
# /usr/lib/libSystem.B.dylib (compatibility version 1.0.0, current version 1292.100.5)
#
# 2: relative path as seen in python@3.9.18
# Monterey{kazzz-s} lib-dynload (1)% otool -L _sqlite3.cpython-39-darwin.so
# _sqlite3.cpython-39-darwin.so:
# ===> @loader_path/../../../../../../../../../../opt/sqlite/lib/libsqlite3.0.dylib (compatibility version 9.0.0, current version 9.6.0)
# /usr/lib/libSystem.B.dylib (compatibility version 1.0.0, current version 1311.100.3)
#
# 3. absolute path again as seen in python@3.11
# Monterey{kazzz-s} lib-dynload (1)% otool -L _sqlite3.cpython-311-darwin.so
# _sqlite3.cpython-311-darwin.so:
# ===> /usr/local/opt/sqlite/lib/libsqlite3.0.dylib (compatibility version 9.0.0, current version 9.6.0)
# /usr/lib/libSystem.B.dylib (compatibility version 1.0.0, current version 1311.100.3)
#
# @param[in] frameworkPath: Python Framework path
# @param[in] debug_level: debug level
#
# @return 0 on success; non-zero on failure
#----------------------------------------------------------------------------------------
def Change_Python_LibPath_RelativeToAbsolute( frameworkPath, debug_level=0 ):
#----------------------------------------------------------------------
# [1] Populate a dependency dictionary
#----------------------------------------------------------------------
dependency_dict = dict()
filter_regex = r'\.(so|dylib)$'
patRel2 = r'(%s)(.+)' % HomebrewSearchPathFilter2 # = '\t+@loader_path/../../../../../../../../../../opt'
patRel3 = r'(%s)(.+)' % HomebrewSearchPathFilter3 # = '@loader_path/../../../../../../../../../../opt'
regRel3 = re.compile(patRel3)
#---------------------------------------------------------------------------------------------------
# (A) Collect *.[so|dylib] that the Python Frameworks depends on
#---------------------------------------------------------------------------------------------------
# Ref. https://formulae.brew.sh/formula/python@3.9
# as of 2023-09-22, python@3.9 depends on:
# gdbm 1.23 GNU database manager
# mpdecimal 2.5.1 Library for decimal floating point arithmetic
# openssl@3 3.1.2 Cryptography and SSL/TLS Toolkit
# readline 8.2.1 Library for command-line editing
# sqlite 3.43.1 Command-line interface for SQLite
# xz 5.4.4 General-purpose data compression with high compression ratio
#---------------------------------------------------------------------------------------------------
# https://formulae.brew.sh/formula/python@3.11
# as of 2023-10-24, python@3.11 depends on:
# mpdecimal 2.5.1 Library for decimal floating point arithmetic
# openssl@3 3.1.3 Cryptography and SSL/TLS Toolkit
# sqlite 3.43.2 Command-line interface for SQLite
# xz 5.4.4 General-purpose data compression with high compression ratio
#---------------------------------------------------------------------------------------------------
find_grep_results = os.popen( 'find %s -type f | grep -E "%s"' % (frameworkPath, filter_regex) ).read().split('\n')
framework_files = filter( lambda x: x != '', map(lambda x: x.strip(), find_grep_results) )
for idx, dylibPath in enumerate(framework_files):
otoolCm = 'otool -L %s | grep -E "%s"' % (dylibPath, patRel2)
otoolOut = os.popen( otoolCm ).read()
libdepdic = DecomposeLibraryDependency( dylibPath + ":\n" + otoolOut )
keys = libdepdic.keys()
deplibs = libdepdic[ list(keys)[0] ]
if len(deplibs) == 0:
continue
if debug_level > 0:
print( "In Change_Python_LibPath_RelativeToAbsolute()" )
print( " 1) dylibPath = %s" % dylibPath )
print( " 2) libdepdic = %s" % libdepdic )
print( " 3) key = %s" % list(keys)[0] )
print( " 4) deplibs = %s" % deplibs )
# @LOADER_PATH = @loader_path/../../../../../../../../../..
# dylibPath = /Abs/python3.9/lib-dynload/_hashlib.cpython-39-darwin.so
# libdepdic = {'/Abs/python3.9/lib-dynload/_hashlib.cpython-39-darwin.so':
# ['@LOADER_PATH/opt/openssl@3/lib/libssl.3.dylib',
# '@LOADER_PATH/opt/openssl@3/lib/libcrypto.3.dylib']}
# key = /Abs/python3.9/lib-dynload/_hashlib.cpython-39-darwin.so
# deplibs = ['@LOADER_PATH/opt/openssl@3/lib/libssl.3.dylib',
# '@LOADER_PATH/opt/openssl@3/lib/libcrypto.3.dylib']
for key in keys:
for file in libdepdic[key]:
if regRel3.match(file):
g1, g2 = regRel3.match(file).groups()
try:
container = dependency_dict[key]
except KeyError:
dependency_dict[key] = list() # new empty container
else:
pass
pathRel = "%s" % file
pathAbs = ("%s/opt" % DefaultHomebrewRoot) + g2
dependency_dict[key].append( {pathRel:pathAbs} )
if len(dependency_dict) == 0:
print( " ---> Change_Python_LibPath_RelativeToAbsolute(): No need to change the library paths." )
return 0
if debug_level > 0:
print( "In [1] of Change_Python_LibPath_RelativeToAbsolute()" )
for key in sorted(dependency_dict.keys()):
val = dependency_dict[key]
print( " key=%s" % key )
print( " val=%s" % val )
#----------------------------------------------------------------------
# [2] Perform the changes: relative paths ---> absolute paths
#----------------------------------------------------------------------
cmdNameId = XcodeToolChain['nameID']
cmdNameChg = XcodeToolChain['nameCH']
if debug_level > 0:
print( "In [2] of Change_Python_LibPath_RelativeToAbsolute()" )
for targetfile in sorted(dependency_dict.keys()):
for depdic in dependency_dict[targetfile]:
nameOld = list(depdic.keys())[0] # relative path
nameNew = depdic[nameOld] # absolute path
#-----------------------------------------------------------
# (A) Make the library aware of the new identification
# $ install_name_tool [-change old new] input
#-----------------------------------------------------------
command = "%s %s %s %s" % ( cmdNameChg, nameOld, nameNew, targetfile )
if debug_level > 0:
print( " executing: %s" % command )
if subprocess.call( command, shell=True ) != 0:
msg = "!!! Failed to make the library <%s> aware of the new identification name <%s> !!!"
print( msg % (targetfile, nameNew), file=sys.stderr )
return 1
# for-targetfile
print( " ---> Change_Python_LibPath_RelativeToAbsolute(): Changed the library paths." )
return 0
#----------------------------------------------------------------------------------------
## To generate the 'start-console.py' file from the template file
#
# @param[in] template: input template file (template-start-console.py)
# @param[in] pythonver: Python version string such as "3.11"
# @param[in] target: output target file (start-console.py)
#
# @return True on success, False on failure
#----------------------------------------------------------------------------------------
def Generate_Start_Console_Py( template, pythonver, target ):
try:
fd = open( template, "r" )
tmpl = fd.read()
fd.close()
except Exception as e:
print( "! Failed to read <%s>" % template, file=sys.stderr )
return False
else:
t = string.Template(tmpl)
startpy = t.safe_substitute( PYTHON_VER=pythonver )
try:
fd = open( target, "w" )
fd.write(startpy)
fd.close()
except Exception as e:
print( "! Failed to write <%s>" % target, file=sys.stderr )
return False
else:
return True
#----------------------------------------------------------------------------------------
## To deeply copy directory contents
#
# @param[in] src_dir : source directory
# @param[in] dest_dir : destination directory
# @param[in] excl_pat_list: exclude pattern list (default=[]])
#
# @return True on success, False on failure
#----------------------------------------------------------------------------------------
def Deeply_Copy_Dir( src_dir, dest_dir, excl_pat_list=[] ):
def FnameMatch(item):
for excl_pat in excl_pat_list:
if fnmatch.fnmatch( item, excl_pat ):
return True
return False
if os.path.isfile(dest_dir):
print( "! Destination <%s> is an existing file" % dest_dir, file=sys.stderr )
return False
if not os.path.exists(dest_dir):
os.makedirs(dest_dir)
for item in os.listdir(src_dir):
src_item = os.path.join(src_dir, item)
dest_item = os.path.join(dest_dir, item)
if os.path.isdir(src_item):
if FnameMatch(item):
continue # skip copying if directory name matches the exclusion pattern
Deeply_Copy_Dir( src_item, dest_item, excl_pat_list )
else:
if FnameMatch(item):
continue # skip copying if the file matches the exclusion pattern
shutil.copy2( src_item, dest_item )
return True
#----------------------------------------------------------------------------------------
## To dump the contents of a dependency dictionary
#
# @param[in] title: title
# @param[in] depDic: dependency dictionary to dump
# @param[in] pathDic: path dictionary to dump
#
# @return void
#----------------------------------------------------------------------------------------
def DumpDependencyDicPair( title, depDic, pathDic ):
print( "### Dependency Dictionary Pair <%s> ###" % title )
# depDic
count1 = 0
for key1 in sorted(depDic.keys()):
count1 += 1
diclist = depDic[key1]
print( " %3d:%s" % (count1, key1) )
count2 = 0
for dict_file in diclist:
count2 += 1
print( " %3d:%s" % (count2, dict_file) )
# pathDic
print( " ==========" )
count3 = 0
for key3 in sorted(pathDic.keys()):
count3 += 1
print( " %3d:%s: %s" % (count3, key3, pathDic[key3]) )
return
#----------------
# End of File
#----------------
|
