Add some documentation to the SCons-version-switching hack
[senf.git] / scons / scons-1.2.0 / engine / SCons / Tool / javah.py
1 """SCons.Tool.javah
2
3 Tool-specific initialization for javah.
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/javah.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.Tool.javac
43 import SCons.Util
44
45 def emit_java_headers(target, source, env):
46     """Create and return lists of Java stub header files that will
47     be created from a set of class files.
48     """
49     class_suffix = env.get('JAVACLASSSUFFIX', '.class')
50     classdir = env.get('JAVACLASSDIR')
51
52     if not classdir:
53         try:
54             s = source[0]
55         except IndexError:
56             classdir = '.'
57         else:
58             try:
59                 classdir = s.attributes.java_classdir
60             except AttributeError:
61                 classdir = '.'
62     classdir = env.Dir(classdir).rdir()
63
64     if str(classdir) == '.':
65         c_ = None
66     else:
67         c_ = str(classdir) + os.sep
68
69     slist = []
70     for src in source:
71         try:
72             classname = src.attributes.java_classname
73         except AttributeError:
74             classname = str(src)
75             if c_ and classname[:len(c_)] == c_:
76                 classname = classname[len(c_):]
77             if class_suffix and classname[-len(class_suffix):] == class_suffix:
78                 classname = classname[:-len(class_suffix)]
79             classname = SCons.Tool.javac.classname(classname)
80         s = src.rfile()
81         s.attributes.java_classname = classname
82         slist.append(s)
83
84     s = source[0].rfile()
85     if not hasattr(s.attributes, 'java_classdir'):
86         s.attributes.java_classdir = classdir
87
88     if target[0].__class__ is SCons.Node.FS.File:
89         tlist = target
90     else:
91         if not isinstance(target[0], SCons.Node.FS.Dir):
92             target[0].__class__ = SCons.Node.FS.Dir
93             target[0]._morph()
94         tlist = []
95         for s in source:
96             fname = string.replace(s.attributes.java_classname, '.', '_') + '.h'
97             t = target[0].File(fname)
98             t.attributes.java_lookupdir = target[0]
99             tlist.append(t)
100
101     return tlist, source
102
103 def JavaHOutFlagGenerator(target, source, env, for_signature):
104     try:
105         t = target[0]
106     except (AttributeError, TypeError):
107         t = target
108     try:
109         return '-d ' + str(t.attributes.java_lookupdir)
110     except AttributeError:
111         return '-o ' + str(t)
112
113 def getJavaHClassPath(env,target, source, for_signature):
114     path = "${SOURCE.attributes.java_classdir}"
115     if env.has_key('JAVACLASSPATH') and env['JAVACLASSPATH']:
116         path = SCons.Util.AppendPath(path, env['JAVACLASSPATH'])
117     return "-classpath %s" % (path)
118
119 def generate(env):
120     """Add Builders and construction variables for javah to an Environment."""
121     java_javah = SCons.Tool.CreateJavaHBuilder(env)
122     java_javah.emitter = emit_java_headers
123
124     env['_JAVAHOUTFLAG']    = JavaHOutFlagGenerator
125     env['JAVAH']            = 'javah'
126     env['JAVAHFLAGS']       = SCons.Util.CLVar('')
127     env['_JAVAHCLASSPATH']  = getJavaHClassPath
128     env['JAVAHCOM']         = '$JAVAH $JAVAHFLAGS $_JAVAHOUTFLAG $_JAVAHCLASSPATH ${SOURCES.attributes.java_classname}'
129     env['JAVACLASSSUFFIX']  = '.class'
130
131 def exists(env):
132     return env.Detect('javah')