src/share/classes/com/sun/tools/javac/comp/Infer.java

Tue, 24 Feb 2009 17:48:53 -0800

author
darcy
date
Tue, 24 Feb 2009 17:48:53 -0800
changeset 232
1fbc1cc6e260
parent 210
1aa81917016a
child 229
03bcd66bd8e7
permissions
-rw-r--r--

6498938: Faulty comparison of TypeMirror objects in getElementsAnnotatedWith implementation
Reviewed-by: jjg

duke@1 1 /*
xdono@54 2 * Copyright 1999-2008 Sun Microsystems, Inc. All Rights Reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
duke@1 7 * published by the Free Software Foundation. Sun designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
duke@1 9 * by Sun in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
duke@1 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 22 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 23 * have any questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.tools.javac.comp;
duke@1 27
duke@1 28 import com.sun.tools.javac.util.*;
duke@1 29 import com.sun.tools.javac.util.List;
duke@1 30 import com.sun.tools.javac.code.*;
duke@1 31 import com.sun.tools.javac.code.Type.*;
mcimadamore@89 32 import com.sun.tools.javac.util.JCDiagnostic;
duke@1 33
duke@1 34 import static com.sun.tools.javac.code.TypeTags.*;
duke@1 35
duke@1 36 /** Helper class for type parameter inference, used by the attribution phase.
duke@1 37 *
duke@1 38 * <p><b>This is NOT part of any API supported by Sun Microsystems. If
duke@1 39 * you write code that depends on this, you do so at your own risk.
duke@1 40 * This code and its internal interfaces are subject to change or
duke@1 41 * deletion without notice.</b>
duke@1 42 */
duke@1 43 public class Infer {
duke@1 44 protected static final Context.Key<Infer> inferKey =
duke@1 45 new Context.Key<Infer>();
duke@1 46
duke@1 47 /** A value for prototypes that admit any type, including polymorphic ones. */
duke@1 48 public static final Type anyPoly = new Type(NONE, null);
duke@1 49
duke@1 50 Symtab syms;
duke@1 51 Types types;
mcimadamore@89 52 JCDiagnostic.Factory diags;
duke@1 53
duke@1 54 public static Infer instance(Context context) {
duke@1 55 Infer instance = context.get(inferKey);
duke@1 56 if (instance == null)
duke@1 57 instance = new Infer(context);
duke@1 58 return instance;
duke@1 59 }
duke@1 60
duke@1 61 protected Infer(Context context) {
duke@1 62 context.put(inferKey, this);
duke@1 63 syms = Symtab.instance(context);
duke@1 64 types = Types.instance(context);
mcimadamore@89 65 diags = JCDiagnostic.Factory.instance(context);
mcimadamore@89 66 ambiguousNoInstanceException =
mcimadamore@89 67 new NoInstanceException(true, diags);
mcimadamore@89 68 unambiguousNoInstanceException =
mcimadamore@89 69 new NoInstanceException(false, diags);
duke@1 70 }
duke@1 71
duke@1 72 public static class NoInstanceException extends RuntimeException {
duke@1 73 private static final long serialVersionUID = 0;
duke@1 74
duke@1 75 boolean isAmbiguous; // exist several incomparable best instances?
duke@1 76
duke@1 77 JCDiagnostic diagnostic;
mcimadamore@89 78 JCDiagnostic.Factory diags;
duke@1 79
mcimadamore@89 80 NoInstanceException(boolean isAmbiguous, JCDiagnostic.Factory diags) {
duke@1 81 this.diagnostic = null;
duke@1 82 this.isAmbiguous = isAmbiguous;
mcimadamore@89 83 this.diags = diags;
duke@1 84 }
duke@1 85 NoInstanceException setMessage(String key) {
mcimadamore@89 86 this.diagnostic = diags.fragment(key);
duke@1 87 return this;
duke@1 88 }
duke@1 89 NoInstanceException setMessage(String key, Object arg1) {
mcimadamore@89 90 this.diagnostic = diags.fragment(key, arg1);
duke@1 91 return this;
duke@1 92 }
duke@1 93 NoInstanceException setMessage(String key, Object arg1, Object arg2) {
mcimadamore@89 94 this.diagnostic = diags.fragment(key, arg1, arg2);
duke@1 95 return this;
duke@1 96 }
duke@1 97 NoInstanceException setMessage(String key, Object arg1, Object arg2, Object arg3) {
mcimadamore@89 98 this.diagnostic = diags.fragment(key, arg1, arg2, arg3);
duke@1 99 return this;
duke@1 100 }
duke@1 101 public JCDiagnostic getDiagnostic() {
duke@1 102 return diagnostic;
duke@1 103 }
duke@1 104 }
mcimadamore@89 105 private final NoInstanceException ambiguousNoInstanceException;
mcimadamore@89 106 private final NoInstanceException unambiguousNoInstanceException;
duke@1 107
duke@1 108 /***************************************************************************
duke@1 109 * Auxiliary type values and classes
duke@1 110 ***************************************************************************/
duke@1 111
duke@1 112 /** A mapping that turns type variables into undetermined type variables.
duke@1 113 */
duke@1 114 Mapping fromTypeVarFun = new Mapping("fromTypeVarFun") {
duke@1 115 public Type apply(Type t) {
duke@1 116 if (t.tag == TYPEVAR) return new UndetVar(t);
duke@1 117 else return t.map(this);
duke@1 118 }
duke@1 119 };
duke@1 120
duke@1 121 /** A mapping that returns its type argument with every UndetVar replaced
duke@1 122 * by its `inst' field. Throws a NoInstanceException
duke@1 123 * if this not possible because an `inst' field is null.
duke@1 124 */
duke@1 125 Mapping getInstFun = new Mapping("getInstFun") {
duke@1 126 public Type apply(Type t) {
duke@1 127 switch (t.tag) {
duke@1 128 case UNKNOWN:
duke@1 129 throw ambiguousNoInstanceException
duke@1 130 .setMessage("undetermined.type");
duke@1 131 case UNDETVAR:
duke@1 132 UndetVar that = (UndetVar) t;
duke@1 133 if (that.inst == null)
duke@1 134 throw ambiguousNoInstanceException
duke@1 135 .setMessage("type.variable.has.undetermined.type",
duke@1 136 that.qtype);
duke@1 137 return apply(that.inst);
duke@1 138 default:
duke@1 139 return t.map(this);
duke@1 140 }
duke@1 141 }
duke@1 142 };
duke@1 143
duke@1 144 /***************************************************************************
duke@1 145 * Mini/Maximization of UndetVars
duke@1 146 ***************************************************************************/
duke@1 147
duke@1 148 /** Instantiate undetermined type variable to its minimal upper bound.
duke@1 149 * Throw a NoInstanceException if this not possible.
duke@1 150 */
duke@1 151 void maximizeInst(UndetVar that, Warner warn) throws NoInstanceException {
duke@1 152 if (that.inst == null) {
duke@1 153 if (that.hibounds.isEmpty())
duke@1 154 that.inst = syms.objectType;
duke@1 155 else if (that.hibounds.tail.isEmpty())
duke@1 156 that.inst = that.hibounds.head;
mcimadamore@210 157 else
mcimadamore@210 158 that.inst = types.glb(that.hibounds);
duke@1 159 }
mcimadamore@210 160 if (that.inst == null ||
mcimadamore@210 161 that.inst.isErroneous() ||
mcimadamore@210 162 !types.isSubtypeUnchecked(that.inst, that.hibounds, warn))
mcimadamore@210 163 throw ambiguousNoInstanceException
mcimadamore@210 164 .setMessage("no.unique.maximal.instance.exists",
mcimadamore@210 165 that.qtype, that.hibounds);
duke@1 166 }
duke@1 167 //where
duke@1 168 private boolean isSubClass(Type t, final List<Type> ts) {
duke@1 169 t = t.baseType();
duke@1 170 if (t.tag == TYPEVAR) {
duke@1 171 List<Type> bounds = types.getBounds((TypeVar)t);
duke@1 172 for (Type s : ts) {
duke@1 173 if (!types.isSameType(t, s.baseType())) {
duke@1 174 for (Type bound : bounds) {
duke@1 175 if (!isSubClass(bound, List.of(s.baseType())))
duke@1 176 return false;
duke@1 177 }
duke@1 178 }
duke@1 179 }
duke@1 180 } else {
duke@1 181 for (Type s : ts) {
duke@1 182 if (!t.tsym.isSubClass(s.baseType().tsym, types))
duke@1 183 return false;
duke@1 184 }
duke@1 185 }
duke@1 186 return true;
duke@1 187 }
duke@1 188
jjg@110 189 /** Instantiate undetermined type variable to the lub of all its lower bounds.
duke@1 190 * Throw a NoInstanceException if this not possible.
duke@1 191 */
duke@1 192 void minimizeInst(UndetVar that, Warner warn) throws NoInstanceException {
duke@1 193 if (that.inst == null) {
duke@1 194 if (that.lobounds.isEmpty())
duke@1 195 that.inst = syms.botType;
duke@1 196 else if (that.lobounds.tail.isEmpty())
mcimadamore@5 197 that.inst = that.lobounds.head.isPrimitive() ? syms.errType : that.lobounds.head;
duke@1 198 else {
duke@1 199 that.inst = types.lub(that.lobounds);
mcimadamore@5 200 }
jjg@110 201 if (that.inst == null || that.inst.tag == ERROR)
duke@1 202 throw ambiguousNoInstanceException
duke@1 203 .setMessage("no.unique.minimal.instance.exists",
duke@1 204 that.qtype, that.lobounds);
duke@1 205 // VGJ: sort of inlined maximizeInst() below. Adding
duke@1 206 // bounds can cause lobounds that are above hibounds.
duke@1 207 if (that.hibounds.isEmpty())
duke@1 208 return;
duke@1 209 Type hb = null;
duke@1 210 if (that.hibounds.tail.isEmpty())
duke@1 211 hb = that.hibounds.head;
duke@1 212 else for (List<Type> bs = that.hibounds;
duke@1 213 bs.nonEmpty() && hb == null;
duke@1 214 bs = bs.tail) {
duke@1 215 if (isSubClass(bs.head, that.hibounds))
duke@1 216 hb = types.fromUnknownFun.apply(bs.head);
duke@1 217 }
duke@1 218 if (hb == null ||
duke@1 219 !types.isSubtypeUnchecked(hb, that.hibounds, warn) ||
duke@1 220 !types.isSubtypeUnchecked(that.inst, hb, warn))
duke@1 221 throw ambiguousNoInstanceException;
duke@1 222 }
duke@1 223 }
duke@1 224
duke@1 225 /***************************************************************************
duke@1 226 * Exported Methods
duke@1 227 ***************************************************************************/
duke@1 228
duke@1 229 /** Try to instantiate expression type `that' to given type `to'.
duke@1 230 * If a maximal instantiation exists which makes this type
duke@1 231 * a subtype of type `to', return the instantiated type.
duke@1 232 * If no instantiation exists, or if several incomparable
duke@1 233 * best instantiations exist throw a NoInstanceException.
duke@1 234 */
duke@1 235 public Type instantiateExpr(ForAll that,
duke@1 236 Type to,
duke@1 237 Warner warn) throws NoInstanceException {
duke@1 238 List<Type> undetvars = Type.map(that.tvars, fromTypeVarFun);
duke@1 239 for (List<Type> l = undetvars; l.nonEmpty(); l = l.tail) {
duke@1 240 UndetVar v = (UndetVar) l.head;
duke@1 241 ListBuffer<Type> hibounds = new ListBuffer<Type>();
duke@1 242 for (List<Type> l1 = types.getBounds((TypeVar) v.qtype); l1.nonEmpty(); l1 = l1.tail) {
duke@1 243 if (!l1.head.containsSome(that.tvars)) {
duke@1 244 hibounds.append(l1.head);
duke@1 245 }
duke@1 246 }
duke@1 247 v.hibounds = hibounds.toList();
duke@1 248 }
duke@1 249 Type qtype1 = types.subst(that.qtype, that.tvars, undetvars);
duke@1 250 if (!types.isSubtype(qtype1, to)) {
duke@1 251 throw unambiguousNoInstanceException
duke@1 252 .setMessage("no.conforming.instance.exists",
duke@1 253 that.tvars, that.qtype, to);
duke@1 254 }
duke@1 255 for (List<Type> l = undetvars; l.nonEmpty(); l = l.tail)
duke@1 256 maximizeInst((UndetVar) l.head, warn);
duke@1 257 // System.out.println(" = " + qtype1.map(getInstFun));//DEBUG
duke@1 258
duke@1 259 // check bounds
duke@1 260 List<Type> targs = Type.map(undetvars, getInstFun);
duke@1 261 targs = types.subst(targs, that.tvars, targs);
duke@1 262 checkWithinBounds(that.tvars, targs, warn);
duke@1 263
duke@1 264 return getInstFun.apply(qtype1);
duke@1 265 }
duke@1 266
duke@1 267 /** Instantiate method type `mt' by finding instantiations of
duke@1 268 * `tvars' so that method can be applied to `argtypes'.
duke@1 269 */
duke@1 270 public Type instantiateMethod(List<Type> tvars,
duke@1 271 MethodType mt,
duke@1 272 List<Type> argtypes,
duke@1 273 boolean allowBoxing,
duke@1 274 boolean useVarargs,
duke@1 275 Warner warn) throws NoInstanceException {
duke@1 276 //-System.err.println("instantiateMethod(" + tvars + ", " + mt + ", " + argtypes + ")"); //DEBUG
duke@1 277 List<Type> undetvars = Type.map(tvars, fromTypeVarFun);
duke@1 278 List<Type> formals = mt.argtypes;
duke@1 279
duke@1 280 // instantiate all polymorphic argument types and
duke@1 281 // set up lower bounds constraints for undetvars
duke@1 282 Type varargsFormal = useVarargs ? formals.last() : null;
duke@1 283 while (argtypes.nonEmpty() && formals.head != varargsFormal) {
duke@1 284 Type ft = formals.head;
duke@1 285 Type at = argtypes.head.baseType();
duke@1 286 if (at.tag == FORALL)
duke@1 287 at = instantiateArg((ForAll) at, ft, tvars, warn);
duke@1 288 Type sft = types.subst(ft, tvars, undetvars);
duke@1 289 boolean works = allowBoxing
duke@1 290 ? types.isConvertible(at, sft, warn)
duke@1 291 : types.isSubtypeUnchecked(at, sft, warn);
duke@1 292 if (!works) {
duke@1 293 throw unambiguousNoInstanceException
duke@1 294 .setMessage("no.conforming.assignment.exists",
duke@1 295 tvars, at, ft);
duke@1 296 }
duke@1 297 formals = formals.tail;
duke@1 298 argtypes = argtypes.tail;
duke@1 299 }
duke@1 300 if (formals.head != varargsFormal || // not enough args
duke@1 301 !useVarargs && argtypes.nonEmpty()) { // too many args
duke@1 302 // argument lists differ in length
duke@1 303 throw unambiguousNoInstanceException
duke@1 304 .setMessage("arg.length.mismatch");
duke@1 305 }
duke@1 306
duke@1 307 // for varargs arguments as well
duke@1 308 if (useVarargs) {
duke@1 309 Type elt = types.elemtype(varargsFormal);
duke@1 310 Type sft = types.subst(elt, tvars, undetvars);
duke@1 311 while (argtypes.nonEmpty()) {
duke@1 312 Type ft = sft;
duke@1 313 Type at = argtypes.head.baseType();
duke@1 314 if (at.tag == FORALL)
duke@1 315 at = instantiateArg((ForAll) at, ft, tvars, warn);
duke@1 316 boolean works = types.isConvertible(at, sft, warn);
duke@1 317 if (!works) {
duke@1 318 throw unambiguousNoInstanceException
duke@1 319 .setMessage("no.conforming.assignment.exists",
duke@1 320 tvars, at, ft);
duke@1 321 }
duke@1 322 argtypes = argtypes.tail;
duke@1 323 }
duke@1 324 }
duke@1 325
duke@1 326 // minimize as yet undetermined type variables
duke@1 327 for (Type t : undetvars)
duke@1 328 minimizeInst((UndetVar) t, warn);
duke@1 329
duke@1 330 /** Type variables instantiated to bottom */
duke@1 331 ListBuffer<Type> restvars = new ListBuffer<Type>();
duke@1 332
duke@1 333 /** Instantiated types or TypeVars if under-constrained */
duke@1 334 ListBuffer<Type> insttypes = new ListBuffer<Type>();
duke@1 335
duke@1 336 /** Instantiated types or UndetVars if under-constrained */
duke@1 337 ListBuffer<Type> undettypes = new ListBuffer<Type>();
duke@1 338
duke@1 339 for (Type t : undetvars) {
duke@1 340 UndetVar uv = (UndetVar)t;
duke@1 341 if (uv.inst.tag == BOT) {
duke@1 342 restvars.append(uv.qtype);
duke@1 343 insttypes.append(uv.qtype);
duke@1 344 undettypes.append(uv);
duke@1 345 uv.inst = null;
duke@1 346 } else {
duke@1 347 insttypes.append(uv.inst);
duke@1 348 undettypes.append(uv.inst);
duke@1 349 }
duke@1 350 }
duke@1 351 checkWithinBounds(tvars, undettypes.toList(), warn);
duke@1 352
duke@1 353 if (!restvars.isEmpty()) {
duke@1 354 // if there are uninstantiated variables,
duke@1 355 // quantify result type with them
duke@1 356 mt = new MethodType(mt.argtypes,
duke@1 357 new ForAll(restvars.toList(), mt.restype),
duke@1 358 mt.thrown, syms.methodClass);
duke@1 359 }
duke@1 360
duke@1 361 // return instantiated version of method type
duke@1 362 return types.subst(mt, tvars, insttypes.toList());
duke@1 363 }
duke@1 364 //where
duke@1 365
duke@1 366 /** Try to instantiate argument type `that' to given type `to'.
duke@1 367 * If this fails, try to insantiate `that' to `to' where
duke@1 368 * every occurrence of a type variable in `tvars' is replaced
duke@1 369 * by an unknown type.
duke@1 370 */
duke@1 371 private Type instantiateArg(ForAll that,
duke@1 372 Type to,
duke@1 373 List<Type> tvars,
duke@1 374 Warner warn) throws NoInstanceException {
duke@1 375 List<Type> targs;
duke@1 376 try {
duke@1 377 return instantiateExpr(that, to, warn);
duke@1 378 } catch (NoInstanceException ex) {
duke@1 379 Type to1 = to;
duke@1 380 for (List<Type> l = tvars; l.nonEmpty(); l = l.tail)
duke@1 381 to1 = types.subst(to1, List.of(l.head), List.of(syms.unknownType));
duke@1 382 return instantiateExpr(that, to1, warn);
duke@1 383 }
duke@1 384 }
duke@1 385
duke@1 386 /** check that type parameters are within their bounds.
duke@1 387 */
duke@1 388 private void checkWithinBounds(List<Type> tvars,
duke@1 389 List<Type> arguments,
duke@1 390 Warner warn)
duke@1 391 throws NoInstanceException {
duke@1 392 for (List<Type> tvs = tvars, args = arguments;
duke@1 393 tvs.nonEmpty();
duke@1 394 tvs = tvs.tail, args = args.tail) {
duke@1 395 if (args.head instanceof UndetVar) continue;
duke@1 396 List<Type> bounds = types.subst(types.getBounds((TypeVar)tvs.head), tvars, arguments);
duke@1 397 if (!types.isSubtypeUnchecked(args.head, bounds, warn))
duke@1 398 throw unambiguousNoInstanceException
duke@1 399 .setMessage("inferred.do.not.conform.to.bounds",
duke@1 400 arguments, tvars);
duke@1 401 }
duke@1 402 }
duke@1 403 }

mercurial