/** * Assumes that all of the parents of c have been registered already. * * @param c */ @SuppressWarnings("unchecked") private <T> Node registerClass(final Class<T> c) throws ClassHierarchyException { if (c.isArray()) { throw new UnsupportedOperationException("Can't register array types"); } try { return getAlreadyBoundNode(c); } catch (final NameResolutionException e) { // node not bound yet } final Node n = buildPathToNode(c); if (n instanceof ClassNode) { final ClassNode<T> cn = (ClassNode<T>) n; final Class<T> superclass = (Class<T>) c.getSuperclass(); if (superclass != null) { try { ((ClassNode<T>) getAlreadyBoundNode(superclass)).putImpl(cn); } catch (final NameResolutionException e) { throw new IllegalStateException(e); } } for (final Class<?> interf : c.getInterfaces()) { try { ((ClassNode<T>) getAlreadyBoundNode(interf)).putImpl(cn); } catch (final NameResolutionException e) { throw new IllegalStateException(e); } } } return n; }
private <T, U> Node buildPathToNode(final Class<U> clazz) throws ClassHierarchyException { final String[] path = clazz.getName().split("\\$"); Node root = namespace; for (int i = 0; i < path.length - 1; i++) { root = root.get(path[i]); } if (root == null) { throw new NullPointerException(); } final Node parent = root; final Type argType = ReflectionUtilities.getNamedParameterTargetOrNull(clazz); if (argType == null) { return JavaNodeFactory.createClassNode(parent, clazz); } else { // checked inside of NamedParameterNode, using reflection. @SuppressWarnings("unchecked") final NamedParameterNode<T> np = JavaNodeFactory.createNamedParameterNode( parent, (Class<? extends Name<T>>) clazz, argType); if (parameterParser.canParse(ReflectionUtilities.getFullName(argType)) && clazz.getAnnotation(NamedParameter.class).default_class() != Void.class) { throw new ClassHierarchyException( "Named parameter " + ReflectionUtilities.getFullName(clazz) + " defines default implementation for parsable type " + ReflectionUtilities.getFullName(argType)); } final String shortName = np.getShortName(); if (shortName != null) { final NamedParameterNode<?> oldNode = shortNames.get(shortName); if (oldNode != null) { if (oldNode.getFullName().equals(np.getFullName())) { throw new IllegalStateException( "Tried to double bind " + oldNode.getFullName() + " to short name " + shortName); } throw new ClassHierarchyException( "Named parameters " + oldNode.getFullName() + " and " + np.getFullName() + " have the same short name: " + shortName); } shortNames.put(shortName, np); } return np; } }
private void processDefaultAnnotation(final Class<?> cmb) { final DefaultImplementation di = cmb.getAnnotation(DefaultImplementation.class); // XXX hack: move to helper method + unify with rest of Tang! if (di != null) { final String diName = di.value() == Void.class ? di.name() : ReflectionUtilities.getFullName(di.value()); final ClassNode<?> cn = (ClassNode<?>) ch.getNode(cmb); final String cnS = cn.getFullName(); if (!usages.contains(diName, cnS)) { usages.put(diName, cnS); if (!knownClasses.contains(cn)) { knownClasses.add(cn); } } } }
private void processConfigurationModules(final Class<?> cmb) { for (final Field f : cmb.getFields()) { if (ReflectionUtilities.isCoercable(ConfigurationModule.class, f.getType())) { final int mod = f.getModifiers(); boolean ok = true; if (Modifier.isPrivate(mod)) { System.err.println("Found private ConfigurationModule " + f); ok = false; } if (!Modifier.isFinal(mod)) { System.err.println("Found non-final ConfigurationModule " + f); ok = false; } if (!Modifier.isStatic(f.getModifiers())) { System.err.println("Found non-static ConfigurationModule " + f); ok = false; } if (ok) { // System.err.println("OK: " + f); try { f.setAccessible(true); final String fS = ReflectionUtilities.getFullName(f); if (!modules.containsKey(f)) { modules.put(f, (ConfigurationModule) (f.get(null))); try { modules.get(f).assertStaticClean(); } catch (final ClassHierarchyException e) { System.err.println(fS + ": " + e.getMessage()); } for (final Entry<String, String> e : modules.get(f).toStringPairs()) { // System.err.println("e: " + e.getKey() + "=" + e.getValue()); try { final Node n = ch.getNode(e.getKey()); if (!setters.contains(e.getKey(), fS)) { setters.put(e.getKey(), fS); } if (n instanceof ClassNode) { final ClassNode<?> cn = (ClassNode<?>) n; if (!knownClasses.contains(cn)) { knownClasses.add(cn); } } } catch (final NameResolutionException ex) { // } try { final String s = e.getValue(); final Node n = ch.getNode(s); if (!usages.contains(ReflectionUtilities.getFullName(f), s)) { // System.err.println("Added usage: " + ReflectionUtilities.getFullName(f) + // "=" + s); usages.put(s, ReflectionUtilities.getFullName(f)); } if (n instanceof ClassNode) { final ClassNode<?> cn = (ClassNode<?>) n; if (!knownClasses.contains(cn)) { System.err.println("Added " + cn + " to known classes"); knownClasses.add(cn); } } } catch (final NameResolutionException ex) { // } } } } catch (final ExceptionInInitializerError e) { System.err.println( "Field " + ReflectionUtilities.getFullName(f) + ": " + e.getCause().getMessage()); } catch (final IllegalAccessException e) { throw new RuntimeException(e); } } } } }
/** * @param args * @throws FileNotFoundException * @throws MalformedURLException */ public static void main(final String[] args) throws FileNotFoundException, MalformedURLException, UnsupportedEncodingException { int i = 0; String doc = null; String jar = null; boolean tangTests = false; while (i < args.length) { if (args[i].equals("--doc")) { i++; doc = args[i]; } else if (args[i].equals("--jar")) { i++; jar = args[i]; } else if (args[i].equals("--tang-tests")) { tangTests = true; } i++; } final Tint t; if (jar != null) { final File f = new File(jar); if (!f.exists()) { throw new FileNotFoundException(jar); } t = new Tint(new URL[] {f.toURI().toURL()}, tangTests); } else { t = new Tint(new URL[0], tangTests); } if (doc != null) { try (final PrintStream out = new PrintStream(doc, "UTF-8")) { out.println("<html><head><title>TangDoc</title>"); out.println("<style>"); out.println( "body { font-family: 'Segoe UI', 'Comic Sans MS'; font-size:12pt; font-weight: 200; " + "margin: 1em; column-count: 2; }"); out.println(".package { font-size:18pt; font-weight: 500; column-span: all; }"); // out.println(".class { break-after: never; }"); // out.println(".doc { break-before: never; }"); out.println(".decl-margin { padding: 8pt; break-inside: avoid; }"); out.println(".module-margin { padding: 8pt; column-span: all; break-inside: avoid; }"); out.println(".decl { background-color: aliceblue; padding: 6pt;}"); out.println(".fullName { font-size: 11pt; font-weight: 400; }"); out.println(".simpleName { font-size: 11pt; font-weight: 400; }"); out.println(".constructorArg { padding-left: 16pt; }"); out.println("." + SETTERS + " { padding-top: 6pt; font-size: 10pt; }"); out.println("." + USES + " { padding-top: 6pt; font-size: 10pt; }"); out.println("pre { font-size: 10pt; }"); out.println("</style>"); out.println("</head><body>"); String currentPackage = ""; for (final Node n : t.getNamesUsedAndSet()) { final String fullName = n.getFullName(); final String[] tok = fullName.split("\\."); final StringBuffer sb = new StringBuffer(tok[0]); for (int j = 1; j < tok.length; j++) { if (tok[j].matches("^[A-Z].*") || j > 4) { break; } else { sb.append("." + tok[j]); } } final String pack = sb.toString(); if (!currentPackage.equals(pack)) { currentPackage = pack; out.println(t.endPackage()); out.println(t.startPackage(currentPackage)); } if (n instanceof NamedParameterNode<?>) { out.println(t.toHtmlString((NamedParameterNode<?>) n, currentPackage)); } else if (n instanceof ClassNode<?>) { out.println(t.toHtmlString((ClassNode<?>) n, currentPackage)); } else { throw new IllegalStateException(); } } out.println("</div>"); out.println(t.endPackage()); out.println("<div class='package'>Module definitions</div>"); for (final Field f : t.modules.keySet()) { final String moduleName = ReflectionUtilities.getFullName(f); // String declaringClassName = // ReflectionUtilities.getFullName(f.getDeclaringClass()); out.println( "<div class='module-margin' id='" + moduleName + "'><div class='decl'><span class='fullName'>" + moduleName + "</span>"); out.println("<pre>"); final String conf = t.modules.get(f).toPrettyString(); final String[] tok = conf.split("\n"); for (final String line : tok) { out.println(stripPrefix(line, "no.such.prefix")); // t.modules.get(f).toPrettyString()); } // List<Entry<String,String>> lines = t.modules.get(f).toStringPairs(); // for(Entry<String,String> line : lines) { // String k = t.stripPrefix(line.getKey(), declaringClassName); // String v = t.stripPrefix(line.getValue(), declaringClassName); // out.println(k+"="+v); // } out.println("</pre>"); out.println("</div></div>"); } out.println("<div class='package'>Interfaces and injectable classes</div>"); for (final ClassNode<?> c : t.knownClasses) { if (t.classFilter(tangTests, c.getFullName())) { Class<?> clz = null; try { clz = t.ch.classForName(c.getFullName()); } catch (final ClassNotFoundException e) { // TODO[JIRA REEF-864] Clarify handling in this case e.printStackTrace(); } final String typ = clz == null ? "undefined" : clz.isInterface() ? "interface" : "class"; out.println( "<div class='module-margin' id='" + c.getFullName() + "'><div class='decl'>" + "<span class='fullName'>" + typ + " " + c.getFullName() + "</span>"); for (final ConstructorDef<?> d : c.getInjectableConstructors()) { out.println("<div class='uses'>" + c.getFullName() + "("); for (final ConstructorArg a : d.getArgs()) { if (a.getNamedParameterName() != null) { out.print( "<div class='constructorArg'><a href='#" + a.getType() + "'>" + stripPrefix(a.getType(), "xxx") + "</a> <a href='#" + a.getNamedParameterName() + "'>" + a.getNamedParameterName() + "</a></div>"); } else { out.print( "<div class='constructorArg'><a href='#" + a.getType() + "'>" + stripPrefix(a.getType(), "xxx") + "</a></div>"); } } out.println(")</div>"); } out.println("</div></div>"); } /* out.println("<h1>Default usage of classes and constants</h1>"); for(String s : t.usages.keySet()) { out.println("<h2>" + s + "</h2>"); for(Node n : t.usages.getValuesForKey(s)) { out.println("<p>" + n.getFullName() + "</p>"); } } */ } out.println("</body></html>"); } } }
private Node register(final String s) { final Class<?> c; try { c = classForName(s); } catch (final ClassNotFoundException e1) { return null; } try { final Node n = getAlreadyBoundNode(c); return n; } catch (final NameResolutionException e) { // node not bound yet } // First, walk up the class hierarchy, registering all out parents. This // can't be loopy. if (c.getSuperclass() != null) { register(ReflectionUtilities.getFullName(c.getSuperclass())); } for (final Class<?> i : c.getInterfaces()) { register(ReflectionUtilities.getFullName(i)); } // Now, we'd like to register our enclosing classes. This turns out to be // safe. // Thankfully, Java doesn't allow: // class A implements A.B { class B { } } // It also doesn't allow cycles such as: // class A implements B.BB { interface AA { } } // class B implements A.AA { interface BB { } } // So, even though grafting arbitrary DAGs together can give us cycles, Java // seems // to have our back on this one. final Class<?> enclosing = c.getEnclosingClass(); if (enclosing != null) { register(ReflectionUtilities.getFullName(enclosing)); } // Now register the class. This has to be after the above so we know our // parents (superclasses and enclosing packages) are already registered. final Node n = registerClass(c); // Finally, do things that might introduce cycles that invlove c. // This has to be below registerClass, which ensures that any cycles // this stuff introduces are broken. for (final Class<?> innerClass : c.getDeclaredClasses()) { register(ReflectionUtilities.getFullName(innerClass)); } if (n instanceof ClassNode) { final ClassNode<?> cls = (ClassNode<?>) n; for (final ConstructorDef<?> def : cls.getInjectableConstructors()) { for (final ConstructorArg arg : def.getArgs()) { register(arg.getType()); if (arg.getNamedParameterName() != null) { final NamedParameterNode<?> np = (NamedParameterNode<?>) register(arg.getNamedParameterName()); try { // TODO: When handling sets, need to track target of generic parameter, and check the // type here! if (!np.isSet() && !np.isList() && !ReflectionUtilities.isCoercable( classForName(arg.getType()), classForName(np.getFullArgName()))) { throw new ClassHierarchyException( "Named parameter type mismatch in " + cls.getFullName() + ". Constructor expects a " + arg.getType() + " but " + np.getName() + " is a " + np.getFullArgName()); } } catch (final ClassNotFoundException e) { throw new ClassHierarchyException( "Constructor refers to unknown class " + arg.getType(), e); } } } } } else if (n instanceof NamedParameterNode) { final NamedParameterNode<?> np = (NamedParameterNode<?>) n; register(np.getFullArgName()); } return n; }