Add some documentation to the SCons-version-switching hack
[senf.git] / scons / scons-1.2.0 / engine / SCons / Tool / rmic.py
1 """SCons.Tool.rmic
2
3 Tool-specific initialization for rmic.
4
5 There normally shouldn't be any need to import this module directly.
6 It will usually be imported through the generic SCons.Tool.Tool()
7 selection method.
8
9 """
10
11 #
12 # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The SCons Foundation
13 #
14 # Permission is hereby granted, free of charge, to any person obtaining
15 # a copy of this software and associated documentation files (the
16 # "Software"), to deal in the Software without restriction, including
17 # without limitation the rights to use, copy, modify, merge, publish,
18 # distribute, sublicense, and/or sell copies of the Software, and to
19 # permit persons to whom the Software is furnished to do so, subject to
20 # the following conditions:
21 #
22 # The above copyright notice and this permission notice shall be included
23 # in all copies or substantial portions of the Software.
24 #
25 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
26 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
27 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
29 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
30 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
31 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
32 #
33
34 __revision__ = "src/engine/SCons/Tool/rmic.py 3842 2008/12/20 22:59:52 scons"
35
36 import os.path
37 import string
38
39 import SCons.Action
40 import SCons.Builder
41 import SCons.Node.FS
42 import SCons.Util
43
44 def emit_rmic_classes(target, source, env):
45     """Create and return lists of Java RMI stub and skeleton
46     class files to be created from a set of class files.
47     """
48     class_suffix = env.get('JAVACLASSSUFFIX', '.class')
49     classdir = env.get('JAVACLASSDIR')
50
51     if not classdir:
52         try:
53             s = source[0]
54         except IndexError:
55             classdir = '.'
56         else:
57             try:
58                 classdir = s.attributes.java_classdir
59             except AttributeError:
60                 classdir = '.'
61     classdir = env.Dir(classdir).rdir()
62     if str(classdir) == '.':
63         c_ = None
64     else:
65         c_ = str(classdir) + os.sep
66
67     slist = []
68     for src in source:
69         try:
70             classname = src.attributes.java_classname
71         except AttributeError:
72             classname = str(src)
73             if c_ and classname[:len(c_)] == c_:
74                 classname = classname[len(c_):]
75             if class_suffix and classname[:-len(class_suffix)] == class_suffix:
76                 classname = classname[-len(class_suffix):]
77         s = src.rfile()
78         s.attributes.java_classdir = classdir
79         s.attributes.java_classname = classname
80         slist.append(s)
81
82     stub_suffixes = ['_Stub']
83     if env.get('JAVAVERSION') == '1.4':
84         stub_suffixes.append('_Skel')
85
86     tlist = []
87     for s in source:
88         for suff in stub_suffixes:
89             fname = string.replace(s.attributes.java_classname, '.', os.sep) + \
90                     suff + class_suffix
91             t = target[0].File(fname)
92             t.attributes.java_lookupdir = target[0]
93             tlist.append(t)
94
95     return tlist, source
96
97 RMICAction = SCons.Action.Action('$RMICCOM', '$RMICCOMSTR')
98
99 RMICBuilder = SCons.Builder.Builder(action = RMICAction,
100                      emitter = emit_rmic_classes,
101                      src_suffix = '$JAVACLASSSUFFIX',
102                      target_factory = SCons.Node.FS.Dir,
103                      source_factory = SCons.Node.FS.File)
104
105 def generate(env):
106     """Add Builders and construction variables for rmic to an Environment."""
107     env['BUILDERS']['RMIC'] = RMICBuilder
108
109     env['RMIC']            = 'rmic'
110     env['RMICFLAGS']       = SCons.Util.CLVar('')
111     env['RMICCOM']         = '$RMIC $RMICFLAGS -d ${TARGET.attributes.java_lookupdir} -classpath ${SOURCE.attributes.java_classdir} ${SOURCES.attributes.java_classname}'
112     env['JAVACLASSSUFFIX']  = '.class'
113
114 def exists(env):
115     return env.Detect('rmic')