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
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
|
"""scons.Node.FS
File system nodes.
These Nodes represent the canonical external objects that people think
of when they think of building software: files and directories.
This initializes a "default_fs" Node with an FS at the current directory
for its own purposes, and for use by scripts or modules looking for the
canonical default.
"""
#
# Copyright (c) 2001, 2002, 2003 Steven Knight
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
import os
import os.path
import string
from UserDict import UserDict
import SCons.Action
import SCons.Errors
import SCons.Node
import SCons.Warnings
#
# SCons.Action objects for interacting with the outside world.
#
# The Node.FS methods in this module should use these actions to
# create and/or remove files and directories; they should *not* use
# os.{link,symlink,unlink,mkdir}(), etc., directly.
#
# Using these SCons.Action objects ensures that descriptions of these
# external activities are properly displayed, that the displays are
# suppressed when the -s (silent) option is used, and (most importantly)
# the actions are disabled when the the -n option is used, in which case
# there should be *no* changes to the external file system(s)...
#
if hasattr(os, 'symlink'):
def _existsp(p):
return os.path.exists(p) or os.path.islink(p)
else:
_existsp = os.path.exists
def LinkFunc(target, source, env):
src = source[0].path
dest = target[0].path
dir, file = os.path.split(dest)
if dir and not os.path.isdir(dir):
os.makedirs(dir)
# Now actually link the files. First try to make a hard link. If that
# fails, try a symlink. If that fails then just copy it.
try :
os.link(src, dest)
except (AttributeError, OSError):
try :
os.symlink(src, dest)
except (AttributeError, OSError):
import shutil
import stat
shutil.copy2(src, dest)
st=os.stat(src)
os.chmod(dest, stat.S_IMODE(st[stat.ST_MODE]) | stat.S_IWRITE)
return 0
Link = SCons.Action.Action(LinkFunc, None)
def LocalString(target, source):
return 'Local copy of %s from %s' % (target[0], source[0])
LocalCopy = SCons.Action.Action(LinkFunc, LocalString)
def UnlinkFunc(target, source, env):
os.unlink(target[0].path)
return 0
Unlink = SCons.Action.Action(UnlinkFunc, None)
def MkdirFunc(target, source, env):
os.mkdir(target[0].path)
return 0
Mkdir = SCons.Action.Action(MkdirFunc, None)
#
class ParentOfRoot:
"""
An instance of this class is used as the parent of the root of a
filesystem (POSIX) or drive (Win32). This isn't actually a node,
but it looks enough like one so that we don't have to have
special purpose code everywhere to deal with dir being None.
This class is an instance of the Null object pattern.
"""
def __init__(self):
self.abspath = ''
self.path = ''
self.abspath_ = ''
self.path_ = ''
self.name=''
self.duplicate=0
self.srcdir=None
def is_under(self, dir):
return 0
def up(self):
return None
def getRepositories(self):
return []
def get_dir(self):
return None
if os.path.normcase("TeSt") == os.path.normpath("TeSt"):
def _my_normcase(x):
return x
else:
def _my_normcase(x):
return string.upper(x)
class Entry(SCons.Node.Node):
"""A generic class for file system entries. This class is for
when we don't know yet whether the entry being looked up is a file
or a directory. Instances of this class can morph into either
Dir or File objects by a later, more precise lookup.
Note: this class does not define __cmp__ and __hash__ for efficiency
reasons. SCons does a lot of comparing of Entry objects, and so that
operation must be as fast as possible, which means we want to use
Python's built-in object identity comparison.
"""
def __init__(self, name, directory, fs):
"""Initialize a generic file system Entry.
Call the superclass initialization, take care of setting up
our relative and absolute paths, identify our parent
directory, and indicate that this node should use
signatures."""
SCons.Node.Node.__init__(self)
self.name = name
self.fs = fs
assert directory, "A directory must be provided"
self.abspath = directory.abspath_ + name
if directory.path == '.':
self.path = name
else:
self.path = directory.path_ + name
self.path_ = self.path
self.abspath_ = self.abspath
self.dir = directory
self.cwd = None # will hold the SConscript directory for target nodes
self.duplicate = directory.duplicate
def get_dir(self):
return self.dir
def __str__(self):
"""A FS node's string representation is its path name."""
if self.duplicate or self.has_builder():
return self.path
return self.srcnode().path
def get_contents(self):
"""Fetch the contents of the entry.
Since this should return the real contents from the file
system, we check to see into what sort of subclass we should
morph this Entry."""
if os.path.isfile(self.abspath):
self.__class__ = File
self._morph()
return File.get_contents(self)
if os.path.isdir(self.abspath):
self.__class__ = Dir
self._morph()
return Dir.get_contents(self)
raise AttributeError
def exists(self):
try:
return self._exists
except AttributeError:
self._exists = os.path.exists(self.abspath)
return self._exists
def rexists(self):
if not hasattr(self, '_rexists'):
self._rexists = self.rfile().exists()
return self._rexists
def get_parents(self):
parents = SCons.Node.Node.get_parents(self)
if self.dir and not isinstance(self.dir, ParentOfRoot):
parents.append(self.dir)
return parents
def current(self, calc):
"""If the underlying path doesn't exist, we know the node is
not current without even checking the signature, so return 0.
Otherwise, return None to indicate that signature calculation
should proceed as normal to find out if the node is current."""
bsig = calc.bsig(self)
if not self.exists():
return 0
return calc.current(self, bsig)
def is_under(self, dir):
if self is dir:
return 1
else:
return self.dir.is_under(dir)
def set_local(self):
self._local = 1
def srcnode(self):
"""If this node is in a build path, return the node
corresponding to its source file. Otherwise, return
ourself."""
try:
return self._srcnode
except AttributeError:
dir=self.dir
name=self.name
while dir:
if dir.srcdir:
self._srcnode = self.fs.Entry(name, dir.srcdir,
klass=self.__class__)
return self._srcnode
name = dir.name + os.sep + name
dir=dir.get_dir()
self._srcnode = self
return self._srcnode
# This is for later so we can differentiate between Entry the class and Entry
# the method of the FS class.
_classEntry = Entry
class FS:
def __init__(self, path = None):
"""Initialize the Node.FS subsystem.
The supplied path is the top of the source tree, where we
expect to find the top-level build file. If no path is
supplied, the current directory is the default.
The path argument must be a valid absolute path.
"""
if path == None:
self.pathTop = os.getcwd()
else:
self.pathTop = path
self.Root = {}
self.Top = None
def set_toplevel_dir(self, path):
assert not self.Top, "You can only set the top-level path on an FS object that has not had its File, Dir, or Entry methods called yet."
self.pathTop = path
def __setTopLevelDir(self):
if not self.Top:
self.Top = self.__doLookup(Dir, os.path.normpath(self.pathTop))
self.Top.path = '.'
self.Top.path_ = '.' + os.sep
self._cwd = self.Top
def getcwd(self):
self.__setTopLevelDir()
return self._cwd
def __checkClass(self, node, klass):
if klass == Entry:
return node
if node.__class__ == Entry:
node.__class__ = klass
node._morph()
return node
if not isinstance(node, klass):
raise TypeError, "Tried to lookup %s '%s' as a %s." % \
(node.__class__.__name__, node.path, klass.__name__)
return node
def __doLookup(self, fsclass, name, directory = None, create = 1):
"""This method differs from the File and Dir factory methods in
one important way: the meaning of the directory parameter.
In this method, if directory is None or not supplied, the supplied
name is expected to be an absolute path. If you try to look up a
relative path with directory=None, then an AssertionError will be
raised."""
if not name:
# This is a stupid hack to compensate for the fact
# that the POSIX and Win32 versions of os.path.normpath()
# behave differently. In particular, in POSIX:
# os.path.normpath('./') == '.'
# in Win32
# os.path.normpath('./') == ''
# os.path.normpath('.\\') == ''
#
# This is a definite bug in the Python library, but we have
# to live with it.
name = '.'
path_comp = string.split(name, os.sep)
drive, path_first = os.path.splitdrive(path_comp[0])
if not path_first:
# Absolute path
drive = _my_normcase(drive)
try:
directory = self.Root[drive]
except KeyError:
if not create:
raise SCons.Errors.UserError
dir = Dir(drive, ParentOfRoot(), self)
dir.path = dir.path + os.sep
dir.abspath = dir.abspath + os.sep
self.Root[drive] = dir
directory = dir
path_comp = path_comp[1:]
else:
path_comp = [ path_first, ] + path_comp[1:]
# Lookup the directory
for path_name in path_comp[:-1]:
path_norm = _my_normcase(path_name)
try:
directory = self.__checkClass(directory.entries[path_norm],
Dir)
except KeyError:
if not create:
raise SCons.Errors.UserError
# look at the actual filesystem and make sure there isn't
# a file already there
path = directory.path_ + path_name
if os.path.isfile(path):
raise TypeError, \
"File %s found where directory expected." % path
dir_temp = Dir(path_name, directory, self)
directory.entries[path_norm] = dir_temp
directory.add_wkid(dir_temp)
directory = dir_temp
file_name = _my_normcase(path_comp[-1])
try:
ret = self.__checkClass(directory.entries[file_name], fsclass)
except KeyError:
if not create:
raise SCons.Errors.UserError
# make sure we don't create File nodes when there is actually
# a directory at that path on the disk, and vice versa
path = directory.path_ + path_comp[-1]
if fsclass == File:
if os.path.isdir(path):
raise TypeError, \
"Directory %s found where file expected." % path
elif fsclass == Dir:
if os.path.isfile(path):
raise TypeError, \
"File %s found where directory expected." % path
ret = fsclass(path_comp[-1], directory, self)
directory.entries[file_name] = ret
directory.add_wkid(ret)
return ret
def __transformPath(self, name, directory):
"""Take care of setting up the correct top-level directory,
usually in preparation for a call to doLookup().
If the path name is prepended with a '#', then it is unconditionally
interpreted as relative to the top-level directory of this FS.
If directory is None, and name is a relative path,
then the same applies.
"""
self.__setTopLevelDir()
if name and name[0] == '#':
directory = self.Top
name = name[1:]
if name and (name[0] == os.sep or name[0] == '/'):
# Correct such that '#/foo' is equivalent
# to '#foo'.
name = name[1:]
name = os.path.join('.', os.path.normpath(name))
elif not directory:
directory = self._cwd
return (os.path.normpath(name), directory)
def chdir(self, dir):
"""Change the current working directory for lookups.
"""
self.__setTopLevelDir()
if not dir is None:
self._cwd = dir
def Entry(self, name, directory = None, create = 1, klass=None):
"""Lookup or create a generic Entry node with the specified name.
If the name is a relative path (begins with ./, ../, or a file
name), then it is looked up relative to the supplied directory
node, or to the top level directory of the FS (supplied at
construction time) if no directory is supplied.
"""
if not klass:
klass = Entry
if isinstance(name, Entry):
return self.__checkClass(name, klass)
else:
if directory and not isinstance(directory, Dir):
directory = self.Dir(directory)
name, directory = self.__transformPath(name, directory)
return self.__doLookup(klass, name, directory, create)
def File(self, name, directory = None, create = 1):
"""Lookup or create a File node with the specified name. If
the name is a relative path (begins with ./, ../, or a file name),
then it is looked up relative to the supplied directory node,
or to the top level directory of the FS (supplied at construction
time) if no directory is supplied.
This method will raise TypeError if a directory is found at the
specified path.
"""
return self.Entry(name, directory, create, File)
def Dir(self, name, directory = None, create = 1):
"""Lookup or create a Dir node with the specified name. If
the name is a relative path (begins with ./, ../, or a file name),
then it is looked up relative to the supplied directory node,
or to the top level directory of the FS (supplied at construction
time) if no directory is supplied.
This method will raise TypeError if a normal file is found at the
specified path.
"""
return self.Entry(name, directory, create, Dir)
def BuildDir(self, build_dir, src_dir, duplicate=1):
"""Link the supplied build directory to the source directory
for purposes of building files."""
self.__setTopLevelDir()
if not isinstance(src_dir, SCons.Node.Node):
src_dir = self.Dir(src_dir)
if not isinstance(build_dir, SCons.Node.Node):
build_dir = self.Dir(build_dir)
if not src_dir.is_under(self.Top):
raise SCons.Errors.UserError, "Source directory must be under top of build tree."
if src_dir.is_under(build_dir):
raise SCons.Errors.UserError, "Source directory cannot be under build directory."
build_dir.link(src_dir, duplicate)
def Repository(self, *dirs):
"""Specify Repository directories to search."""
for d in dirs:
if not isinstance(d, SCons.Node.Node):
d = self.Dir(d)
self.__setTopLevelDir()
self.Top.addRepository(d)
def Rsearch(self, path, clazz=_classEntry, cwd=None):
"""Search for something in a Repository. Returns the first
one found in the list, or None if there isn't one."""
if isinstance(path, SCons.Node.Node):
return path
else:
name, d = self.__transformPath(path, cwd)
n = self.__doLookup(clazz, name, d)
if n.exists():
return n
d = n.get_dir()
name = n.name
# Search repositories of all directories that this file is under.
while d:
for rep in d.getRepositories():
try:
rnode = self.__doLookup(clazz, name, rep)
# Only find the node if it exists and it is not
# a derived file. If for some reason, we are
# explicitly building a file IN a Repository, we
# don't want it to show up in the build tree.
# This is usually the case with BuildDir().
# We only want to find pre-existing files.
if rnode.exists() and \
(isinstance(rnode, Dir) or not rnode.has_builder()):
return rnode
except TypeError:
pass # Wrong type of node.
# Prepend directory name
name = d.name + os.sep + name
# Go up one directory
d = d.get_dir()
return None
def Rsearchall(self, pathlist, must_exist=1, clazz=_classEntry, cwd=None):
"""Search for a list of somethings in the Repository list."""
ret = []
if SCons.Util.is_String(pathlist):
pathlist = string.split(pathlist, os.pathsep)
if not SCons.Util.is_List(pathlist):
pathlist = [pathlist]
for path in pathlist:
if isinstance(path, SCons.Node.Node):
ret.append(path)
else:
name, d = self.__transformPath(path, cwd)
n = self.__doLookup(clazz, name, d)
if not must_exist or n.exists():
ret.append(n)
if isinstance(n, Dir):
# If this node is a directory, then any repositories
# attached to this node can be repository paths.
ret.extend(filter(lambda x, me=must_exist, clazz=clazz: isinstance(x, clazz) and (not me or x.exists()),
n.getRepositories()))
d = n.get_dir()
name = n.name
# Search repositories of all directories that this file is under.
while d:
for rep in d.getRepositories():
try:
rnode = self.__doLookup(clazz, name, rep)
# Only find the node if it exists (or must_exist is zero)
# and it is not a derived file. If for some reason, we
# are explicitly building a file IN a Repository, we don't
# want it to show up in the build tree. This is usually the
# case with BuildDir(). We only want to find pre-existing files.
if (not must_exist or rnode.exists()) and \
(not rnode.has_builder() or isinstance(rnode, Dir)):
ret.append(rnode)
except TypeError:
pass # Wrong type of node.
# Prepend directory name
name = d.name + os.sep + name
# Go up one directory
d = d.get_dir()
return ret
# XXX TODO?
# Annotate with the creator
# rel_path
# linked_targets
# is_accessible
class Dir(Entry):
"""A class for directories in a file system.
"""
def __init__(self, name, directory, fs):
Entry.__init__(self, name, directory, fs)
self._morph()
def _morph(self):
"""Turn a file system node (either a freshly initialized
directory object or a separate Entry object) into a
proper directory object.
Modify our paths to add the trailing slash that indicates
a directory. Set up this directory's entries and hook it
into the file system tree. Specify that directories (this
node) don't use signatures for currency calculation."""
self.path_ = self.path + os.sep
self.abspath_ = self.abspath + os.sep
self.repositories = []
self.srcdir = None
self.entries = {}
self.entries['.'] = self
self.entries['..'] = self.dir
self.cwd = self
self.builder = 1
self._sconsign = None
def __clearRepositoryCache(self, duplicate=None):
"""Called when we change the repository(ies) for a directory.
This clears any cached information that is invalidated by changing
the repository."""
for node in self.entries.values():
if node != self.dir:
if node != self and isinstance(node, Dir):
node.__clearRepositoryCache(duplicate)
else:
try:
del node._srcreps
except AttributeError:
pass
try:
del node._rfile
except AttributeError:
pass
try:
del node._rexists
except AttributeError:
pass
try:
del node._exists
except AttributeError:
pass
try:
del node._srcnode
except AttributeError:
pass
if duplicate != None:
node.duplicate=duplicate
def __resetDuplicate(self, node):
if node != self:
node.duplicate = node.get_dir().duplicate
def Dir(self, name):
"""Create a directory node named 'name' relative to this directory."""
return self.fs.Dir(name, self)
def File(self, name):
"""Create file node named 'name' relatove to this directory."""
return self.fs.File(name, self)
def link(self, srcdir, duplicate):
"""Set this directory as the build directory for the
supplied source directory."""
self.srcdir = srcdir
self.duplicate = duplicate
self.__clearRepositoryCache(duplicate)
def getRepositories(self):
"""Returns a list of repositories for this directory."""
if self.srcdir and not self.duplicate:
try:
return self._srcreps
except AttributeError:
self._srcreps = self.fs.Rsearchall(self.srcdir.path,
clazz=Dir,
must_exist=0,
cwd=self.fs.Top) \
+ self.repositories
return self._srcreps
return self.repositories
def addRepository(self, dir):
if not dir in self.repositories and dir != self:
self.repositories.append(dir)
self.__clearRepositoryCache()
def up(self):
return self.entries['..']
def root(self):
if not self.entries['..']:
return self
else:
return self.entries['..'].root()
def all_children(self, scan):
#XXX --random: randomize "dependencies?"
keys = filter(lambda k: k != '.' and k != '..', self.entries.keys())
kids = map(lambda x, s=self: s.entries[x], keys)
def c(one, two):
if one.abspath < two.abspath:
return -1
if one.abspath > two.abspath:
return 1
return 0
kids.sort(c)
return kids + SCons.Node.Node.all_children(self, 0)
def get_actions(self):
"""A null "builder" for directories."""
return []
def build(self):
"""A null "builder" for directories."""
pass
def calc_signature(self, calc):
"""A directory has no signature."""
return None
def set_bsig(self, bsig):
"""A directory has no signature."""
bsig = None
def set_csig(self, csig):
"""A directory has no signature."""
csig = None
def get_contents(self):
"""Return a fixed "contents" value of a directory."""
return ''
def current(self, calc):
"""If all of our children were up-to-date, then this
directory was up-to-date, too."""
state = 0
for kid in self.children(None):
s = kid.get_state()
if s and (not state or s > state):
state = s
import SCons.Node
if state == 0 or state == SCons.Node.up_to_date:
return 1
else:
return 0
def sconsign(self):
"""Return the .sconsign file info for this directory,
creating it first if necessary."""
if not self._sconsign:
import SCons.Sig
self._sconsign = SCons.Sig.SConsignFile(self)
return self._sconsign
def srcnode(self):
"""Dir has a special need for srcnode()...if we
have a srcdir attribute set, then that *is* our srcnode."""
if self.srcdir:
return self.srcdir
return Entry.srcnode(self)
# XXX TODO?
# base_suf
# suffix
# addsuffix
# accessible
# relpath
class File(Entry):
"""A class for files in a file system.
"""
def __init__(self, name, directory, fs):
Entry.__init__(self, name, directory, fs)
self._morph()
def Dir(self, name):
"""Create a directory node named 'name' relative to
the SConscript directory of this file."""
return self.fs.Dir(name, self.cwd)
def File(self, name):
"""Create a file node named 'name' relative to
the SConscript directory of this file."""
return self.fs.File(name, self.cwd)
def RDirs(self, pathlist):
"""Search for a list of directories in the Repository list."""
return self.fs.Rsearchall(pathlist, clazz=Dir, must_exist=0,
cwd=self.cwd)
def generate_build_env(self):
env = SCons.Node.Node.generate_build_env(self)
return env.Override({'Dir' : self.Dir,
'File' : self.File,
'RDirs' : self.RDirs})
def _morph(self):
"""Turn a file system node into a File object."""
self.linked = 0
self.scanner_paths = {}
self.found_includes = {}
if not hasattr(self, '_local'):
self._local = 0
def root(self):
return self.dir.root()
def get_contents(self):
if not self.rexists():
return ''
return open(self.rstr(), "rb").read()
def get_timestamp(self):
if self.rexists():
return os.path.getmtime(self.rstr())
else:
return 0
def calc_signature(self, calc):
"""
Select and calculate the appropriate build signature for a File.
self - the File node
calc - the signature calculation module
returns - the signature
This method does not store the signature in the node or
in the .sconsign file.
"""
if self.has_builder():
if SCons.Sig.build_signature:
if not hasattr(self, 'bsig'):
self.set_bsig(calc.bsig(self.rfile()))
return self.get_bsig()
else:
if not hasattr(self, 'csig'):
self.set_csig(calc.csig(self.rfile()))
return self.get_csig()
elif not self.rexists():
return None
else:
if not hasattr(self, 'csig'):
self.set_csig(calc.csig(self.rfile()))
return self.get_csig()
def store_csig(self):
self.dir.sconsign().set_csig(self.name, self.get_csig())
def store_bsig(self):
self.dir.sconsign().set_bsig(self.name, self.get_bsig())
def store_implicit(self):
self.dir.sconsign().set_implicit(self.name, self.implicit)
def store_timestamp(self):
self.dir.sconsign().set_timestamp(self.name, self.get_timestamp())
def get_prevsiginfo(self):
"""Fetch the previous signature information from the
.sconsign entry."""
return self.dir.sconsign().get(self.name)
def get_stored_implicit(self):
return self.dir.sconsign().get_implicit(self.name)
def get_found_includes(self, env, scanner, target):
"""Return the included implicit dependencies in this file.
Cache results so we only scan the file once regardless of
how many times this information is requested."""
if not scanner:
return []
try:
path = target.scanner_paths[scanner]
except AttributeError:
# The target had no scanner_paths attribute, which means
# it's an Alias or some other node that's not actually a
# file. In that case, back off and use the path for this
# node itself.
try:
path = self.scanner_paths[scanner]
except KeyError:
path = scanner.path(env, self.cwd)
self.scanner_paths[scanner] = path
except KeyError:
path = scanner.path(env, target.cwd)
target.scanner_paths[scanner] = path
try:
includes = self.found_includes[path]
except KeyError:
includes = scanner(self, env, path)
self.found_includes[path] = includes
return includes
def scanner_key(self):
return os.path.splitext(self.name)[1]
def _createDir(self):
# ensure that the directories for this node are
# created.
listDirs = []
parent=self.dir
while parent:
if parent.exists():
break
listDirs.append(parent)
p = parent.up()
if isinstance(p, ParentOfRoot):
raise SCons.Errors.StopError, parent.path
parent = p
listDirs.reverse()
for dirnode in listDirs:
try:
Mkdir(dirnode, None, None)
# The Mkdir() action may or may not have actually
# created the directory, depending on whether the -n
# option was used or not. Delete the _exists and
# _rexists attributes so they can be reevaluated.
if hasattr(dirnode, '_exists'):
delattr(dirnode, '_exists')
if hasattr(dirnode, '_rexists'):
delattr(dirnode, '_rexists')
except OSError:
pass
def built(self):
SCons.Node.Node.built(self)
self.found_includes = {}
if hasattr(self, '_exists'):
delattr(self, '_exists')
if hasattr(self, '_rexists'):
delattr(self, '_rexists')
def prepare(self):
"""Prepare for this file to be created."""
def missing(node):
return not node.has_builder() and not node.linked and not node.rexists()
missing_sources = filter(missing, self.children())
if missing_sources:
desc = "No Builder for target `%s', needed by `%s'." % (missing_sources[0], self)
raise SCons.Errors.StopError, desc
if self.exists():
if self.has_builder() and not self.precious:
Unlink(self, None, None)
if hasattr(self, '_exists'):
delattr(self, '_exists')
else:
try:
self._createDir()
except SCons.Errors.StopError, drive:
desc = "No drive `%s' for target `%s'." % (drive, self)
raise SCons.Errors.StopError, desc
def remove(self):
"""Remove this file."""
if _existsp(self.path):
os.unlink(self.path)
return 1
return None
def exists(self):
# Duplicate from source path if we are set up to do this.
if self.duplicate and not self.has_builder() and not self.linked:
src=self.srcnode().rfile()
if src.exists() and src.abspath != self.abspath:
self._createDir()
try:
Unlink(self, None, None)
except OSError:
pass
Link(self, src, None)
self.linked = 1
# The Link() action may or may not have actually
# created the file, depending on whether the -n
# option was used or not. Delete the _exists and
# _rexists attributes so they can be reevaluated.
if hasattr(self, '_exists'):
delattr(self, '_exists')
if hasattr(self, '_rexists'):
delattr(self, '_rexists')
return Entry.exists(self)
def current(self, calc):
bsig = calc.bsig(self)
if not self.exists():
# The file doesn't exist locally...
r = self.rfile()
if r != self:
# ...but there is one in a Repository...
if calc.current(r, bsig):
# ...and it's even up-to-date...
if self._local:
# ...and they'd like a local copy.
LocalCopy(self, r, None)
self.set_bsig(bsig)
self.store_bsig()
return 1
self._rfile = self
return None
else:
return calc.current(self, bsig)
def rfile(self):
if not hasattr(self, '_rfile'):
self._rfile = self
if not self.exists():
n = self.fs.Rsearch(self.path, clazz=File,
cwd=self.fs.Top)
if n:
self._rfile = n
return self._rfile
def rstr(self):
return str(self.rfile())
default_fs = FS()
def find_file(filename, paths, node_factory = default_fs.File):
"""
find_file(str, [Dir()]) -> [nodes]
filename - a filename to find
paths - a list of directory path *nodes* to search in
returns - the node created from the found file.
Find a node corresponding to either a derived file or a file
that exists already.
Only the first file found is returned, and none is returned
if no file is found.
"""
retval = None
for dir in paths:
try:
node = node_factory(filename, dir)
# Return true of the node exists or is a derived node.
if node.has_builder() or \
(isinstance(node, SCons.Node.FS.Entry) and node.exists()):
retval = node
break
except TypeError:
# If we find a directory instead of a file, we don't care
pass
return retval
def find_files(filenames, paths, node_factory = default_fs.File):
"""
find_files([str], [Dir()]) -> [nodes]
filenames - a list of filenames to find
paths - a list of directory path *nodes* to search in
returns - the nodes created from the found files.
Finds nodes corresponding to either derived files or files
that exist already.
Only the first file found is returned for each filename,
and any files that aren't found are ignored.
"""
nodes = map(lambda x, paths=paths, node_factory=node_factory:
find_file(x, paths, node_factory),
filenames)
return filter(lambda x: x != None, nodes)
|