Source code for SCons.Scanner.Java

# MIT License
#
# Copyright The SCons Foundation
#
# 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.

import os

import SCons.Node
import SCons.Node.FS
import SCons.Scanner
from SCons.Util import flatten, is_String


[docs]def _subst_paths(env, paths) -> list: """Return a list of substituted path elements. If *paths* is a string, it is split on the search-path separator. Otherwise, substitution is done on string-valued list elements but they are not split. Note helps support behavior like pulling in the external ``CLASSPATH`` and setting it directly into ``JAVACLASSPATH``, however splitting on ``os.pathsep`` makes the interpretation system-specific (this is warned about in the manpage entry for ``JAVACLASSPATH``). """ if is_String(paths): paths = env.subst(paths) if SCons.Util.is_String(paths): paths = paths.split(os.pathsep) else: # TODO: may want to revisit splitting list-element strings if requested paths = flatten(paths) paths = [env.subst(path) if is_String(path) else path for path in paths] return paths
[docs]def _collect_classes(classlist, dirname, files) -> None: for fname in files: if fname.endswith(".class"): classlist.append(os.path.join(str(dirname), fname))
[docs]def scan(node, env, libpath=()) -> list: """Scan for files both on JAVACLASSPATH and JAVAPROCESSORPATH. JAVACLASSPATH/JAVAPROCESSORPATH path can contain: - Explicit paths to JAR/Zip files - Wildcards (*) - Directories which contain classes in an unnamed package - Parent directories of the root package for classes in a named package Class path entries that are neither directories nor archives (.zip or JAR files) nor the asterisk (*) wildcard character are ignored. """ classpath = [] for var in ['JAVACLASSPATH', 'JAVAPROCESSORPATH']: classpath += _subst_paths(env, env.get(var, [])) result = [] for path in classpath: if is_String(path) and "*" in path: # This matches more than the Java docs describe: a '*' only # matches jar files. The filter later should trim this down. # TODO: should we filter here? use .endswith('*') rather than "in"? libs = env.Glob(path) else: libs = [path] for lib in libs: if os.path.isdir(str(lib)): # grab the in-memory nodes env.Dir(lib).walk(_collect_classes, result) # now the on-disk ones for root, dirs, files in os.walk(str(lib)): _collect_classes(result, root, files) else: result.append(lib) return list(filter(lambda x: os.path.splitext(str(x))[1] in [".class", ".zip", ".jar"], result))
[docs]def JavaScanner(): """Scanner for .java files. .. versionadded:: 4.4 """ return SCons.Scanner.Base(scan, 'JavaScanner', skeys=['.java'])
# Local Variables: # tab-width:4 # indent-tabs-mode:nil # End: # vim: set expandtab tabstop=4 shiftwidth=4: