1#
2# Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 The SCons Foundation
3#
4# Permission is hereby granted, free of charge, to any person obtaining
5# a copy of this software and associated documentation files (the
6# "Software"), to deal in the Software without restriction, including
7# without limitation the rights to use, copy, modify, merge, publish,
8# distribute, sublicense, and/or sell copies of the Software, and to
9# permit persons to whom the Software is furnished to do so, subject to
10# the following conditions:
11#
12# The above copyright notice and this permission notice shall be included
13# in all copies or substantial portions of the Software.
14#
15# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
16# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
17# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
19# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
20# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
21# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22#
23
24__revision__ = "src/engine/SCons/Options/PathOption.py 4369 2009/09/19 15:58:29 scons"
25
26__doc__ = """Place-holder for the old SCons.Options module hierarchy
27
28This is for backwards compatibility.  The new equivalent is the Variables/
29class hierarchy.  These will have deprecation warnings added (some day),
30and will then be removed entirely (some day).
31"""
32
33import SCons.Variables
34import SCons.Warnings
35
36warned = False
37
38class _PathOptionClass:
39    def warn(self):
40        global warned
41        if not warned:
42            msg = "The PathOption() function is deprecated; use the PathVariable() function instead."
43            SCons.Warnings.warn(SCons.Warnings.DeprecatedOptionsWarning, msg)
44            warned = True
45
46    def __call__(self, *args, **kw):
47        self.warn()
48        return SCons.Variables.PathVariable(*args, **kw)
49
50    def PathAccept(self, *args, **kw):
51        self.warn()
52        return SCons.Variables.PathVariable.PathAccept(*args, **kw)
53
54    def PathIsDir(self, *args, **kw):
55        self.warn()
56        return SCons.Variables.PathVariable.PathIsDir(*args, **kw)
57
58    def PathIsDirCreate(self, *args, **kw):
59        self.warn()
60        return SCons.Variables.PathVariable.PathIsDirCreate(*args, **kw)
61
62    def PathIsFile(self, *args, **kw):
63        self.warn()
64        return SCons.Variables.PathVariable.PathIsFile(*args, **kw)
65
66    def PathExists(self, *args, **kw):
67        self.warn()
68        return SCons.Variables.PathVariable.PathExists(*args, **kw)
69
70PathOption = _PathOptionClass()
71
72# Local Variables:
73# tab-width:4
74# indent-tabs-mode:nil
75# End:
76# vim: set expandtab tabstop=4 shiftwidth=4:
77