Sun, 24 Feb 2013 11:36:58 -0800
7112427: The doclet needs to be able to generate JavaFX documentation.
Reviewed-by: jjg
Contributed-by: jan.valenta@oracle.com
duke@1 | 1 | /* |
jjg@1606 | 2 | * Copyright (c) 1999, 2013, Oracle and/or its affiliates. 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 |
ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@554 | 9 | * by Oracle 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 | * |
ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 23 | * questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.doclets.internal.toolkit.util; |
duke@1 | 27 | |
jjg@1357 | 28 | import java.util.*; |
jjg@1606 | 29 | import java.util.regex.Pattern; |
jjg@1357 | 30 | |
duke@1 | 31 | import com.sun.javadoc.*; |
duke@1 | 32 | import com.sun.tools.doclets.internal.toolkit.*; |
duke@1 | 33 | |
duke@1 | 34 | /** |
duke@1 | 35 | * A data structure that encapsulates the visible members of a particular |
duke@1 | 36 | * type for a given class tree. To use this data structor, you must specify |
duke@1 | 37 | * the type of member you are interested in (nested class, field, constructor |
duke@1 | 38 | * or method) and the leaf of the class tree. The data structure will map |
duke@1 | 39 | * all visible members in the leaf and classes above the leaf in the tree. |
duke@1 | 40 | * |
jjg@1359 | 41 | * <p><b>This is NOT part of any supported API. |
jjg@1359 | 42 | * If you write code that depends on this, you do so at your own risk. |
jjg@1359 | 43 | * This code and its internal interfaces are subject to change or |
jjg@1359 | 44 | * deletion without notice.</b> |
duke@1 | 45 | * |
duke@1 | 46 | * @author Atul M Dambalkar |
duke@1 | 47 | * @author Jamie Ho (rewrite) |
duke@1 | 48 | */ |
duke@1 | 49 | public class VisibleMemberMap { |
duke@1 | 50 | |
duke@1 | 51 | private boolean noVisibleMembers = true; |
duke@1 | 52 | |
duke@1 | 53 | public static final int INNERCLASSES = 0; |
duke@1 | 54 | public static final int ENUM_CONSTANTS = 1; |
duke@1 | 55 | public static final int FIELDS = 2; |
duke@1 | 56 | public static final int CONSTRUCTORS = 3; |
duke@1 | 57 | public static final int METHODS = 4; |
duke@1 | 58 | public static final int ANNOTATION_TYPE_MEMBER_OPTIONAL = 5; |
duke@1 | 59 | public static final int ANNOTATION_TYPE_MEMBER_REQUIRED = 6; |
jjg@1606 | 60 | public static final int PROPERTIES = 7; |
duke@1 | 61 | |
duke@1 | 62 | /** |
duke@1 | 63 | * The total number of member types is {@value}. |
duke@1 | 64 | */ |
jjg@1606 | 65 | public static final int NUM_MEMBER_TYPES = 8; |
duke@1 | 66 | |
duke@1 | 67 | public static final String STARTLEVEL = "start"; |
duke@1 | 68 | |
duke@1 | 69 | /** |
duke@1 | 70 | * List of ClassDoc objects for which ClassMembers objects are built. |
duke@1 | 71 | */ |
jjg@74 | 72 | private final List<ClassDoc> visibleClasses = new ArrayList<ClassDoc>(); |
duke@1 | 73 | |
duke@1 | 74 | /** |
duke@1 | 75 | * Map for each member name on to a map which contains members with same |
duke@1 | 76 | * name-signature. The mapped map will contain mapping for each MemberDoc |
duke@1 | 77 | * onto it's respecive level string. |
duke@1 | 78 | */ |
jjg@74 | 79 | private final Map<Object,Map<ProgramElementDoc,String>> memberNameMap = new HashMap<Object,Map<ProgramElementDoc,String>>(); |
duke@1 | 80 | |
duke@1 | 81 | /** |
duke@1 | 82 | * Map of class and it's ClassMembers object. |
duke@1 | 83 | */ |
jjg@74 | 84 | private final Map<ClassDoc,ClassMembers> classMap = new HashMap<ClassDoc,ClassMembers>(); |
duke@1 | 85 | |
duke@1 | 86 | /** |
duke@1 | 87 | * Type whose visible members are requested. This is the leaf of |
duke@1 | 88 | * the class tree being mapped. |
duke@1 | 89 | */ |
duke@1 | 90 | private final ClassDoc classdoc; |
duke@1 | 91 | |
duke@1 | 92 | /** |
duke@1 | 93 | * Member kind: InnerClasses/Fields/Methods? |
duke@1 | 94 | */ |
duke@1 | 95 | private final int kind; |
duke@1 | 96 | |
duke@1 | 97 | /** |
jjg@1606 | 98 | * The configuration this VisibleMemberMap was created with. |
duke@1 | 99 | */ |
jjg@1606 | 100 | private final Configuration configuration; |
jjg@1606 | 101 | |
jjg@1606 | 102 | private static final Map<ClassDoc, ProgramElementDoc[]> propertiesCache = |
jjg@1606 | 103 | new HashMap<ClassDoc, ProgramElementDoc[]>(); |
jjg@1606 | 104 | private static final Map<ProgramElementDoc, ProgramElementDoc> classPropertiesMap = |
jjg@1606 | 105 | new HashMap<ProgramElementDoc, ProgramElementDoc>(); |
jjg@1606 | 106 | private static final Map<ProgramElementDoc, GetterSetter> getterSetterMap = |
jjg@1606 | 107 | new HashMap<ProgramElementDoc, GetterSetter>(); |
duke@1 | 108 | |
duke@1 | 109 | /** |
duke@1 | 110 | * Construct a VisibleMemberMap of the given type for the given |
jjg@1606 | 111 | * class. |
duke@1 | 112 | * |
duke@1 | 113 | * @param classdoc the class whose members are being mapped. |
duke@1 | 114 | * @param kind the kind of member that is being mapped. |
jjg@1606 | 115 | * @param configuration the configuration to use to construct this |
jjg@1606 | 116 | * VisibleMemberMap. If the field configuration.nodeprecated is true the |
jjg@1606 | 117 | * deprecated members are excluded from the map. If the field |
jjg@1606 | 118 | * configuration.javafx is true the JavaFX features are used. |
duke@1 | 119 | */ |
jjg@1606 | 120 | public VisibleMemberMap(ClassDoc classdoc, |
jjg@1606 | 121 | int kind, |
jjg@1606 | 122 | Configuration configuration) { |
duke@1 | 123 | this.classdoc = classdoc; |
duke@1 | 124 | this.kind = kind; |
jjg@1606 | 125 | this.configuration = configuration; |
duke@1 | 126 | new ClassMembers(classdoc, STARTLEVEL).build(); |
duke@1 | 127 | } |
duke@1 | 128 | |
duke@1 | 129 | /** |
duke@1 | 130 | * Return the list of visible classes in this map. |
duke@1 | 131 | * |
duke@1 | 132 | * @return the list of visible classes in this map. |
duke@1 | 133 | */ |
mcimadamore@184 | 134 | public List<ClassDoc> getVisibleClassesList() { |
duke@1 | 135 | sort(visibleClasses); |
duke@1 | 136 | return visibleClasses; |
duke@1 | 137 | } |
duke@1 | 138 | |
duke@1 | 139 | /** |
jjg@1606 | 140 | * Returns the property field documentation belonging to the given member. |
jjg@1606 | 141 | * @param ped the member for which the property documentation is needed. |
jjg@1606 | 142 | * @return the property field documentation, null if there is none. |
jjg@1606 | 143 | */ |
jjg@1606 | 144 | public ProgramElementDoc getPropertyMemberDoc(ProgramElementDoc ped) { |
jjg@1606 | 145 | return classPropertiesMap.get(ped); |
jjg@1606 | 146 | } |
jjg@1606 | 147 | |
jjg@1606 | 148 | /** |
jjg@1606 | 149 | * Returns the getter documentation belonging to the given property method. |
jjg@1606 | 150 | * @param propertyMethod the method for which the getter is needed. |
jjg@1606 | 151 | * @return the getter documentation, null if there is none. |
jjg@1606 | 152 | */ |
jjg@1606 | 153 | public ProgramElementDoc getGetterForProperty(ProgramElementDoc propertyMethod) { |
jjg@1606 | 154 | return getterSetterMap.get(propertyMethod).getGetter(); |
jjg@1606 | 155 | } |
jjg@1606 | 156 | |
jjg@1606 | 157 | /** |
jjg@1606 | 158 | * Returns the setter documentation belonging to the given property method. |
jjg@1606 | 159 | * @param propertyMethod the method for which the setter is needed. |
jjg@1606 | 160 | * @return the setter documentation, null if there is none. |
jjg@1606 | 161 | */ |
jjg@1606 | 162 | public ProgramElementDoc getSetterForProperty(ProgramElementDoc propertyMethod) { |
jjg@1606 | 163 | return getterSetterMap.get(propertyMethod).getSetter(); |
jjg@1606 | 164 | } |
jjg@1606 | 165 | |
jjg@1606 | 166 | /** |
duke@1 | 167 | * Return the package private members inherited by the class. Only return |
duke@1 | 168 | * if parent is package private and not documented. |
duke@1 | 169 | * |
jjg@1358 | 170 | * @param configuration the current configuration of the doclet. |
duke@1 | 171 | * @return the package private members inherited by the class. |
duke@1 | 172 | */ |
jjg@74 | 173 | private List<ProgramElementDoc> getInheritedPackagePrivateMethods(Configuration configuration) { |
jjg@74 | 174 | List<ProgramElementDoc> results = new ArrayList<ProgramElementDoc>(); |
mcimadamore@184 | 175 | for (Iterator<ClassDoc> iter = visibleClasses.iterator(); iter.hasNext(); ) { |
mcimadamore@184 | 176 | ClassDoc currentClass = iter.next(); |
duke@1 | 177 | if (currentClass != classdoc && |
duke@1 | 178 | currentClass.isPackagePrivate() && |
duke@1 | 179 | !Util.isLinkable(currentClass, configuration)) { |
duke@1 | 180 | // Document these members in the child class because |
duke@1 | 181 | // the parent is inaccessible. |
duke@1 | 182 | results.addAll(getMembersFor(currentClass)); |
duke@1 | 183 | } |
duke@1 | 184 | } |
duke@1 | 185 | return results; |
duke@1 | 186 | } |
duke@1 | 187 | |
duke@1 | 188 | /** |
duke@1 | 189 | * Return the visible members of the class being mapped. Also append at the |
duke@1 | 190 | * end of the list members that are inherited by inaccessible parents. We |
duke@1 | 191 | * document these members in the child because the parent is not documented. |
duke@1 | 192 | * |
jjg@1358 | 193 | * @param configuration the current configuration of the doclet. |
duke@1 | 194 | */ |
jjg@74 | 195 | public List<ProgramElementDoc> getLeafClassMembers(Configuration configuration) { |
jjg@74 | 196 | List<ProgramElementDoc> result = getMembersFor(classdoc); |
duke@1 | 197 | result.addAll(getInheritedPackagePrivateMethods(configuration)); |
duke@1 | 198 | return result; |
duke@1 | 199 | } |
duke@1 | 200 | |
duke@1 | 201 | /** |
duke@1 | 202 | * Retrn the list of members for the given class. |
duke@1 | 203 | * |
duke@1 | 204 | * @param cd the class to retrieve the list of visible members for. |
duke@1 | 205 | * |
duke@1 | 206 | * @return the list of members for the given class. |
duke@1 | 207 | */ |
jjg@74 | 208 | public List<ProgramElementDoc> getMembersFor(ClassDoc cd) { |
jjg@74 | 209 | ClassMembers clmembers = classMap.get(cd); |
duke@1 | 210 | if (clmembers == null) { |
jjg@74 | 211 | return new ArrayList<ProgramElementDoc>(); |
duke@1 | 212 | } |
duke@1 | 213 | return clmembers.getMembers(); |
duke@1 | 214 | } |
duke@1 | 215 | |
duke@1 | 216 | /** |
duke@1 | 217 | * Sort the given mixed list of classes and interfaces to a list of |
duke@1 | 218 | * classes followed by interfaces traversed. Don't sort alphabetically. |
duke@1 | 219 | */ |
jjg@74 | 220 | private void sort(List<ClassDoc> list) { |
jjg@74 | 221 | List<ClassDoc> classes = new ArrayList<ClassDoc>(); |
jjg@74 | 222 | List<ClassDoc> interfaces = new ArrayList<ClassDoc>(); |
duke@1 | 223 | for (int i = 0; i < list.size(); i++) { |
jjg@74 | 224 | ClassDoc cd = list.get(i); |
duke@1 | 225 | if (cd.isClass()) { |
duke@1 | 226 | classes.add(cd); |
duke@1 | 227 | } else { |
duke@1 | 228 | interfaces.add(cd); |
duke@1 | 229 | } |
duke@1 | 230 | } |
duke@1 | 231 | list.clear(); |
duke@1 | 232 | list.addAll(classes); |
duke@1 | 233 | list.addAll(interfaces); |
duke@1 | 234 | } |
duke@1 | 235 | |
jjg@74 | 236 | private void fillMemberLevelMap(List<ProgramElementDoc> list, String level) { |
duke@1 | 237 | for (int i = 0; i < list.size(); i++) { |
jjg@74 | 238 | Object key = getMemberKey(list.get(i)); |
jjg@74 | 239 | Map<ProgramElementDoc,String> memberLevelMap = memberNameMap.get(key); |
duke@1 | 240 | if (memberLevelMap == null) { |
jjg@74 | 241 | memberLevelMap = new HashMap<ProgramElementDoc,String>(); |
duke@1 | 242 | memberNameMap.put(key, memberLevelMap); |
duke@1 | 243 | } |
duke@1 | 244 | memberLevelMap.put(list.get(i), level); |
duke@1 | 245 | } |
duke@1 | 246 | } |
duke@1 | 247 | |
mcimadamore@184 | 248 | private void purgeMemberLevelMap(List<ProgramElementDoc> list, String level) { |
duke@1 | 249 | for (int i = 0; i < list.size(); i++) { |
mcimadamore@184 | 250 | Object key = getMemberKey(list.get(i)); |
mcimadamore@184 | 251 | Map<ProgramElementDoc, String> memberLevelMap = memberNameMap.get(key); |
duke@1 | 252 | if (level.equals(memberLevelMap.get(list.get(i)))) |
duke@1 | 253 | memberLevelMap.remove(list.get(i)); |
duke@1 | 254 | } |
duke@1 | 255 | } |
duke@1 | 256 | |
duke@1 | 257 | /** |
duke@1 | 258 | * Represents a class member. We should be able to just use a |
duke@1 | 259 | * ProgramElementDoc instead of this class, but that doesn't take |
duke@1 | 260 | * type variables in consideration when comparing. |
duke@1 | 261 | */ |
duke@1 | 262 | private class ClassMember { |
jjg@74 | 263 | private Set<ProgramElementDoc> members; |
duke@1 | 264 | |
duke@1 | 265 | public ClassMember(ProgramElementDoc programElementDoc) { |
jjg@74 | 266 | members = new HashSet<ProgramElementDoc>(); |
duke@1 | 267 | members.add(programElementDoc); |
duke@1 | 268 | } |
duke@1 | 269 | |
duke@1 | 270 | public void addMember(ProgramElementDoc programElementDoc) { |
duke@1 | 271 | members.add(programElementDoc); |
duke@1 | 272 | } |
duke@1 | 273 | |
duke@1 | 274 | public boolean isEqual(MethodDoc member) { |
mcimadamore@184 | 275 | for (Iterator<ProgramElementDoc> iter = members.iterator(); iter.hasNext(); ) { |
duke@1 | 276 | MethodDoc member2 = (MethodDoc) iter.next(); |
duke@1 | 277 | if (Util.executableMembersEqual(member, member2)) { |
duke@1 | 278 | members.add(member); |
duke@1 | 279 | return true; |
duke@1 | 280 | } |
duke@1 | 281 | } |
duke@1 | 282 | return false; |
duke@1 | 283 | } |
duke@1 | 284 | } |
duke@1 | 285 | |
duke@1 | 286 | /** |
duke@1 | 287 | * A data structure that represents the class members for |
duke@1 | 288 | * a visible class. |
duke@1 | 289 | */ |
duke@1 | 290 | private class ClassMembers { |
duke@1 | 291 | |
duke@1 | 292 | /** |
duke@1 | 293 | * The mapping class, whose inherited members are put in the |
duke@1 | 294 | * {@link #members} list. |
duke@1 | 295 | */ |
duke@1 | 296 | private ClassDoc mappingClass; |
duke@1 | 297 | |
duke@1 | 298 | /** |
duke@1 | 299 | * List of inherited members from the mapping class. |
duke@1 | 300 | */ |
jjg@74 | 301 | private List<ProgramElementDoc> members = new ArrayList<ProgramElementDoc>(); |
duke@1 | 302 | |
duke@1 | 303 | /** |
duke@1 | 304 | * Level/Depth of inheritance. |
duke@1 | 305 | */ |
duke@1 | 306 | private String level; |
duke@1 | 307 | |
duke@1 | 308 | /** |
duke@1 | 309 | * Return list of inherited members from mapping class. |
duke@1 | 310 | * |
duke@1 | 311 | * @return List Inherited members. |
duke@1 | 312 | */ |
jjg@74 | 313 | public List<ProgramElementDoc> getMembers() { |
duke@1 | 314 | return members; |
duke@1 | 315 | } |
duke@1 | 316 | |
duke@1 | 317 | private ClassMembers(ClassDoc mappingClass, String level) { |
duke@1 | 318 | this.mappingClass = mappingClass; |
duke@1 | 319 | this.level = level; |
duke@1 | 320 | if (classMap.containsKey(mappingClass) && |
jjg@74 | 321 | level.startsWith(classMap.get(mappingClass).level)) { |
duke@1 | 322 | //Remove lower level class so that it can be replaced with |
duke@1 | 323 | //same class found at higher level. |
duke@1 | 324 | purgeMemberLevelMap(getClassMembers(mappingClass, false), |
jjg@74 | 325 | classMap.get(mappingClass).level); |
duke@1 | 326 | classMap.remove(mappingClass); |
duke@1 | 327 | visibleClasses.remove(mappingClass); |
duke@1 | 328 | } |
duke@1 | 329 | if (!classMap.containsKey(mappingClass)) { |
duke@1 | 330 | classMap.put(mappingClass, this); |
duke@1 | 331 | visibleClasses.add(mappingClass); |
duke@1 | 332 | } |
duke@1 | 333 | |
duke@1 | 334 | } |
duke@1 | 335 | |
duke@1 | 336 | private void build() { |
duke@1 | 337 | if (kind == CONSTRUCTORS) { |
duke@1 | 338 | addMembers(mappingClass); |
duke@1 | 339 | } else { |
duke@1 | 340 | mapClass(); |
duke@1 | 341 | } |
duke@1 | 342 | } |
duke@1 | 343 | |
duke@1 | 344 | private void mapClass() { |
duke@1 | 345 | addMembers(mappingClass); |
duke@1 | 346 | ClassDoc[] interfaces = mappingClass.interfaces(); |
duke@1 | 347 | for (int i = 0; i < interfaces.length; i++) { |
duke@1 | 348 | String locallevel = level + 1; |
duke@1 | 349 | ClassMembers cm = new ClassMembers(interfaces[i], locallevel); |
duke@1 | 350 | cm.mapClass(); |
duke@1 | 351 | } |
duke@1 | 352 | if (mappingClass.isClass()) { |
duke@1 | 353 | ClassDoc superclass = mappingClass.superclass(); |
duke@1 | 354 | if (!(superclass == null || mappingClass.equals(superclass))) { |
duke@1 | 355 | ClassMembers cm = new ClassMembers(superclass, |
duke@1 | 356 | level + "c"); |
duke@1 | 357 | cm.mapClass(); |
duke@1 | 358 | } |
duke@1 | 359 | } |
duke@1 | 360 | } |
duke@1 | 361 | |
duke@1 | 362 | /** |
duke@1 | 363 | * Get all the valid members from the mapping class. Get the list of |
duke@1 | 364 | * members for the class to be included into(ctii), also get the level |
duke@1 | 365 | * string for ctii. If mapping class member is not already in the |
duke@1 | 366 | * inherited member list and if it is visible in the ctii and not |
duke@1 | 367 | * overridden, put such a member in the inherited member list. |
duke@1 | 368 | * Adjust member-level-map, class-map. |
duke@1 | 369 | */ |
duke@1 | 370 | private void addMembers(ClassDoc fromClass) { |
jjg@74 | 371 | List<ProgramElementDoc> cdmembers = getClassMembers(fromClass, true); |
jjg@74 | 372 | List<ProgramElementDoc> incllist = new ArrayList<ProgramElementDoc>(); |
duke@1 | 373 | for (int i = 0; i < cdmembers.size(); i++) { |
jjg@74 | 374 | ProgramElementDoc pgmelem = cdmembers.get(i); |
duke@1 | 375 | if (!found(members, pgmelem) && |
duke@1 | 376 | memberIsVisible(pgmelem) && |
jjg@1606 | 377 | !isOverridden(pgmelem, level) && |
jjg@1606 | 378 | !isTreatedAsPrivate(pgmelem)) { |
jjg@1606 | 379 | incllist.add(pgmelem); |
duke@1 | 380 | } |
duke@1 | 381 | } |
duke@1 | 382 | if (incllist.size() > 0) { |
duke@1 | 383 | noVisibleMembers = false; |
duke@1 | 384 | } |
duke@1 | 385 | members.addAll(incllist); |
duke@1 | 386 | fillMemberLevelMap(getClassMembers(fromClass, false), level); |
duke@1 | 387 | } |
duke@1 | 388 | |
jjg@1606 | 389 | private boolean isTreatedAsPrivate(ProgramElementDoc pgmelem) { |
jjg@1606 | 390 | if (!configuration.javafx) { |
jjg@1606 | 391 | return false; |
jjg@1606 | 392 | } |
jjg@1606 | 393 | |
jjg@1606 | 394 | Tag[] aspTags = pgmelem.tags("@treatAsPrivate"); |
jjg@1606 | 395 | boolean result = (aspTags != null) && (aspTags.length > 0); |
jjg@1606 | 396 | return result; |
jjg@1606 | 397 | } |
jjg@1606 | 398 | |
duke@1 | 399 | /** |
duke@1 | 400 | * Is given doc item visible in given classdoc in terms fo inheritance? |
duke@1 | 401 | * The given doc item is visible in the given classdoc if it is public |
duke@1 | 402 | * or protected and if it is package-private if it's containing class |
duke@1 | 403 | * is in the same package as the given classdoc. |
duke@1 | 404 | */ |
duke@1 | 405 | private boolean memberIsVisible(ProgramElementDoc pgmdoc) { |
duke@1 | 406 | if (pgmdoc.containingClass().equals(classdoc)) { |
duke@1 | 407 | //Member is in class that we are finding visible members for. |
duke@1 | 408 | //Of course it is visible. |
duke@1 | 409 | return true; |
duke@1 | 410 | } else if (pgmdoc.isPrivate()) { |
duke@1 | 411 | //Member is in super class or implemented interface. |
duke@1 | 412 | //Private, so not inherited. |
duke@1 | 413 | return false; |
duke@1 | 414 | } else if (pgmdoc.isPackagePrivate()) { |
duke@1 | 415 | //Member is package private. Only return true if its class is in |
duke@1 | 416 | //same package. |
duke@1 | 417 | return pgmdoc.containingClass().containingPackage().equals( |
duke@1 | 418 | classdoc.containingPackage()); |
duke@1 | 419 | } else { |
duke@1 | 420 | //Public members are always inherited. |
duke@1 | 421 | return true; |
duke@1 | 422 | } |
duke@1 | 423 | } |
duke@1 | 424 | |
duke@1 | 425 | /** |
duke@1 | 426 | * Return all available class members. |
duke@1 | 427 | */ |
jjg@74 | 428 | private List<ProgramElementDoc> getClassMembers(ClassDoc cd, boolean filter) { |
duke@1 | 429 | if (cd.isEnum() && kind == CONSTRUCTORS) { |
duke@1 | 430 | //If any of these rules are hit, return empty array because |
duke@1 | 431 | //we don't document these members ever. |
duke@1 | 432 | return Arrays.asList(new ProgramElementDoc[] {}); |
duke@1 | 433 | } |
duke@1 | 434 | ProgramElementDoc[] members = null; |
duke@1 | 435 | switch (kind) { |
duke@1 | 436 | case ANNOTATION_TYPE_MEMBER_OPTIONAL: |
duke@1 | 437 | members = cd.isAnnotationType() ? |
duke@1 | 438 | filter((AnnotationTypeDoc) cd, false) : |
duke@1 | 439 | new AnnotationTypeElementDoc[] {}; |
duke@1 | 440 | break; |
duke@1 | 441 | case ANNOTATION_TYPE_MEMBER_REQUIRED: |
duke@1 | 442 | members = cd.isAnnotationType() ? |
duke@1 | 443 | filter((AnnotationTypeDoc) cd, true) : |
duke@1 | 444 | new AnnotationTypeElementDoc[] {}; |
duke@1 | 445 | break; |
duke@1 | 446 | case INNERCLASSES: |
duke@1 | 447 | members = cd.innerClasses(filter); |
duke@1 | 448 | break; |
duke@1 | 449 | case ENUM_CONSTANTS: |
duke@1 | 450 | members = cd.enumConstants(); |
duke@1 | 451 | break; |
duke@1 | 452 | case FIELDS: |
duke@1 | 453 | members = cd.fields(filter); |
duke@1 | 454 | break; |
duke@1 | 455 | case CONSTRUCTORS: |
duke@1 | 456 | members = cd.constructors(); |
duke@1 | 457 | break; |
duke@1 | 458 | case METHODS: |
duke@1 | 459 | members = cd.methods(filter); |
jjg@1606 | 460 | checkOnPropertiesTags((MethodDoc[])members); |
jjg@1606 | 461 | break; |
jjg@1606 | 462 | case PROPERTIES: |
jjg@1606 | 463 | members = properties(cd, filter); |
duke@1 | 464 | break; |
duke@1 | 465 | default: |
duke@1 | 466 | members = new ProgramElementDoc[0]; |
duke@1 | 467 | } |
jjg@1606 | 468 | // Deprected members should be excluded or not? |
jjg@1606 | 469 | if (configuration.nodeprecated) { |
duke@1 | 470 | return Util.excludeDeprecatedMembersAsList(members); |
duke@1 | 471 | } |
duke@1 | 472 | return Arrays.asList(members); |
duke@1 | 473 | } |
duke@1 | 474 | |
duke@1 | 475 | /** |
duke@1 | 476 | * Filter the annotation type members and return either the required |
duke@1 | 477 | * members or the optional members, depending on the value of the |
duke@1 | 478 | * required parameter. |
duke@1 | 479 | * |
duke@1 | 480 | * @param doc The annotation type to process. |
duke@1 | 481 | * @param required |
duke@1 | 482 | * @return the annotation type members and return either the required |
duke@1 | 483 | * members or the optional members, depending on the value of the |
duke@1 | 484 | * required parameter. |
duke@1 | 485 | */ |
duke@1 | 486 | private AnnotationTypeElementDoc[] filter(AnnotationTypeDoc doc, |
duke@1 | 487 | boolean required) { |
jjg@74 | 488 | AnnotationTypeElementDoc[] members = doc.elements(); |
jjg@74 | 489 | List<AnnotationTypeElementDoc> targetMembers = new ArrayList<AnnotationTypeElementDoc>(); |
duke@1 | 490 | for (int i = 0; i < members.length; i++) { |
duke@1 | 491 | if ((required && members[i].defaultValue() == null) || |
duke@1 | 492 | ((!required) && members[i].defaultValue() != null)){ |
duke@1 | 493 | targetMembers.add(members[i]); |
duke@1 | 494 | } |
duke@1 | 495 | } |
jjg@74 | 496 | return targetMembers.toArray(new AnnotationTypeElementDoc[]{}); |
duke@1 | 497 | } |
duke@1 | 498 | |
mcimadamore@184 | 499 | private boolean found(List<ProgramElementDoc> list, ProgramElementDoc elem) { |
duke@1 | 500 | for (int i = 0; i < list.size(); i++) { |
mcimadamore@184 | 501 | ProgramElementDoc pgmelem = list.get(i); |
duke@1 | 502 | if (Util.matches(pgmelem, elem)) { |
duke@1 | 503 | return true; |
duke@1 | 504 | } |
duke@1 | 505 | } |
duke@1 | 506 | return false; |
duke@1 | 507 | } |
duke@1 | 508 | |
duke@1 | 509 | |
duke@1 | 510 | /** |
duke@1 | 511 | * Is member overridden? The member is overridden if it is found in the |
duke@1 | 512 | * same level hierarchy e.g. member at level "11" overrides member at |
duke@1 | 513 | * level "111". |
duke@1 | 514 | */ |
duke@1 | 515 | private boolean isOverridden(ProgramElementDoc pgmdoc, String level) { |
mcimadamore@184 | 516 | Map<?,String> memberLevelMap = (Map<?,String>) memberNameMap.get(getMemberKey(pgmdoc)); |
duke@1 | 517 | if (memberLevelMap == null) |
duke@1 | 518 | return false; |
duke@1 | 519 | String mappedlevel = null; |
mcimadamore@184 | 520 | Iterator<String> iterator = memberLevelMap.values().iterator(); |
duke@1 | 521 | while (iterator.hasNext()) { |
mcimadamore@184 | 522 | mappedlevel = iterator.next(); |
duke@1 | 523 | if (mappedlevel.equals(STARTLEVEL) || |
duke@1 | 524 | (level.startsWith(mappedlevel) && |
duke@1 | 525 | !level.equals(mappedlevel))) { |
duke@1 | 526 | return true; |
duke@1 | 527 | } |
duke@1 | 528 | } |
duke@1 | 529 | return false; |
duke@1 | 530 | } |
jjg@1606 | 531 | |
jjg@1606 | 532 | private ProgramElementDoc[] properties(final ClassDoc cd, final boolean filter) { |
jjg@1606 | 533 | final MethodDoc[] allMethods = cd.methods(filter); |
jjg@1606 | 534 | final FieldDoc[] allFields = cd.fields(false); |
jjg@1606 | 535 | |
jjg@1606 | 536 | if (propertiesCache.containsKey(cd)) { |
jjg@1606 | 537 | return propertiesCache.get(cd); |
jjg@1606 | 538 | } |
jjg@1606 | 539 | |
jjg@1606 | 540 | final List<MethodDoc> result = new ArrayList<MethodDoc>(); |
jjg@1606 | 541 | |
jjg@1606 | 542 | for (final MethodDoc propertyMethod : allMethods) { |
jjg@1606 | 543 | |
jjg@1606 | 544 | if (!isPropertyMethod(propertyMethod)) { |
jjg@1606 | 545 | continue; |
jjg@1606 | 546 | } |
jjg@1606 | 547 | |
jjg@1606 | 548 | final MethodDoc getter = getterForField(allMethods, propertyMethod); |
jjg@1606 | 549 | final MethodDoc setter = setterForField(allMethods, propertyMethod); |
jjg@1606 | 550 | final FieldDoc field = fieldForProperty(allFields, propertyMethod); |
jjg@1606 | 551 | |
jjg@1606 | 552 | addToPropertiesMap(setter, getter, propertyMethod, field); |
jjg@1606 | 553 | getterSetterMap.put(propertyMethod, new GetterSetter(getter, setter)); |
jjg@1606 | 554 | result.add(propertyMethod); |
jjg@1606 | 555 | } |
jjg@1606 | 556 | final ProgramElementDoc[] resultAray = |
jjg@1606 | 557 | result.toArray(new ProgramElementDoc[result.size()]); |
jjg@1606 | 558 | propertiesCache.put(cd, resultAray); |
jjg@1606 | 559 | return resultAray; |
jjg@1606 | 560 | } |
jjg@1606 | 561 | |
jjg@1606 | 562 | private void addToPropertiesMap(MethodDoc setter, |
jjg@1606 | 563 | MethodDoc getter, |
jjg@1606 | 564 | MethodDoc propertyMethod, |
jjg@1606 | 565 | FieldDoc field) { |
jjg@1606 | 566 | if ((field == null) |
jjg@1606 | 567 | || (field.getRawCommentText() == null) |
jjg@1606 | 568 | || field.getRawCommentText().length() == 0) { |
jjg@1606 | 569 | addToPropertiesMap(setter, propertyMethod); |
jjg@1606 | 570 | addToPropertiesMap(getter, propertyMethod); |
jjg@1606 | 571 | addToPropertiesMap(propertyMethod, propertyMethod); |
jjg@1606 | 572 | } else { |
jjg@1606 | 573 | addToPropertiesMap(getter, field); |
jjg@1606 | 574 | addToPropertiesMap(setter, field); |
jjg@1606 | 575 | addToPropertiesMap(propertyMethod, field); |
jjg@1606 | 576 | } |
jjg@1606 | 577 | } |
jjg@1606 | 578 | |
jjg@1606 | 579 | private void addToPropertiesMap(ProgramElementDoc propertyMethod, |
jjg@1606 | 580 | ProgramElementDoc commentSource) { |
jjg@1606 | 581 | if (null == propertyMethod || null == commentSource) { |
jjg@1606 | 582 | return; |
jjg@1606 | 583 | } |
jjg@1606 | 584 | final String methodRawCommentText = propertyMethod.getRawCommentText(); |
jjg@1606 | 585 | |
jjg@1606 | 586 | /* The second condition is required for the property buckets. In |
jjg@1606 | 587 | * this case the comment is at the property method (not at the field) |
jjg@1606 | 588 | * and it needs to be listed in the map. |
jjg@1606 | 589 | */ |
jjg@1606 | 590 | if ((null == methodRawCommentText || 0 == methodRawCommentText.length()) |
jjg@1606 | 591 | || propertyMethod.equals(commentSource)) { |
jjg@1606 | 592 | classPropertiesMap.put(propertyMethod, commentSource); |
jjg@1606 | 593 | } |
jjg@1606 | 594 | } |
jjg@1606 | 595 | |
jjg@1606 | 596 | private MethodDoc getterForField(MethodDoc[] methods, |
jjg@1606 | 597 | MethodDoc propertyMethod) { |
jjg@1606 | 598 | final String propertyMethodName = propertyMethod.name(); |
jjg@1606 | 599 | final String fieldName = |
jjg@1606 | 600 | propertyMethodName.substring(0, |
jjg@1606 | 601 | propertyMethodName.lastIndexOf("Property")); |
jjg@1606 | 602 | final String fieldNameUppercased = |
jjg@1606 | 603 | "" + Character.toUpperCase(fieldName.charAt(0)) |
jjg@1606 | 604 | + fieldName.substring(1); |
jjg@1606 | 605 | final String getterNamePattern; |
jjg@1606 | 606 | final String fieldTypeName = propertyMethod.returnType().toString(); |
jjg@1606 | 607 | if ("boolean".equals(fieldTypeName) |
jjg@1606 | 608 | || fieldTypeName.endsWith("BooleanProperty")) { |
jjg@1606 | 609 | getterNamePattern = "(is|get)" + fieldNameUppercased; |
jjg@1606 | 610 | } else { |
jjg@1606 | 611 | getterNamePattern = "get" + fieldNameUppercased; |
jjg@1606 | 612 | } |
jjg@1606 | 613 | |
jjg@1606 | 614 | for (MethodDoc methodDoc : methods) { |
jjg@1606 | 615 | if (Pattern.matches(getterNamePattern, methodDoc.name())) { |
jjg@1606 | 616 | if (0 == methodDoc.parameters().length |
jjg@1606 | 617 | && (methodDoc.isPublic() || methodDoc.isProtected())) { |
jjg@1606 | 618 | return methodDoc; |
jjg@1606 | 619 | } |
jjg@1606 | 620 | } |
jjg@1606 | 621 | } |
jjg@1606 | 622 | return null; |
jjg@1606 | 623 | } |
jjg@1606 | 624 | |
jjg@1606 | 625 | private MethodDoc setterForField(MethodDoc[] methods, |
jjg@1606 | 626 | MethodDoc propertyMethod) { |
jjg@1606 | 627 | final String propertyMethodName = propertyMethod.name(); |
jjg@1606 | 628 | final String fieldName = |
jjg@1606 | 629 | propertyMethodName.substring(0, |
jjg@1606 | 630 | propertyMethodName.lastIndexOf("Property")); |
jjg@1606 | 631 | final String fieldNameUppercased = |
jjg@1606 | 632 | "" + Character.toUpperCase(fieldName.charAt(0)) |
jjg@1606 | 633 | + fieldName.substring(1); |
jjg@1606 | 634 | final String setter = "set" + fieldNameUppercased; |
jjg@1606 | 635 | |
jjg@1606 | 636 | for (MethodDoc methodDoc : methods) { |
jjg@1606 | 637 | if (setter.equals(methodDoc.name())) { |
jjg@1606 | 638 | if (1 == methodDoc.parameters().length |
jjg@1606 | 639 | && "void".equals(methodDoc.returnType().simpleTypeName()) |
jjg@1606 | 640 | && (methodDoc.isPublic() || methodDoc.isProtected())) { |
jjg@1606 | 641 | return methodDoc; |
jjg@1606 | 642 | } |
jjg@1606 | 643 | } |
jjg@1606 | 644 | } |
jjg@1606 | 645 | return null; |
jjg@1606 | 646 | } |
jjg@1606 | 647 | |
jjg@1606 | 648 | private FieldDoc fieldForProperty(FieldDoc[] fields, MethodDoc property) { |
jjg@1606 | 649 | |
jjg@1606 | 650 | for (FieldDoc field : fields) { |
jjg@1606 | 651 | final String fieldName = field.name(); |
jjg@1606 | 652 | final String propertyName = fieldName + "Property"; |
jjg@1606 | 653 | if (propertyName.equals(property.name())) { |
jjg@1606 | 654 | return field; |
jjg@1606 | 655 | } |
jjg@1606 | 656 | } |
jjg@1606 | 657 | return null; |
jjg@1606 | 658 | } |
jjg@1606 | 659 | |
jjg@1606 | 660 | // properties aren't named setA* or getA* |
jjg@1606 | 661 | private final Pattern pattern = Pattern.compile("[sg]et\\p{Upper}.*"); |
jjg@1606 | 662 | private boolean isPropertyMethod(MethodDoc method) { |
jjg@1606 | 663 | if (!method.name().endsWith("Property")) { |
jjg@1606 | 664 | return false; |
jjg@1606 | 665 | } |
jjg@1606 | 666 | |
jjg@1606 | 667 | if (! memberIsVisible(method)) { |
jjg@1606 | 668 | return false; |
jjg@1606 | 669 | } |
jjg@1606 | 670 | |
jjg@1606 | 671 | if (pattern.matcher(method.name()).matches()) { |
jjg@1606 | 672 | return false; |
jjg@1606 | 673 | } |
jjg@1606 | 674 | |
jjg@1606 | 675 | return 0 == method.parameters().length |
jjg@1606 | 676 | && !"void".equals(method.returnType().simpleTypeName()); |
jjg@1606 | 677 | } |
jjg@1606 | 678 | |
jjg@1606 | 679 | private void checkOnPropertiesTags(MethodDoc[] members) { |
jjg@1606 | 680 | for (MethodDoc methodDoc: members) { |
jjg@1606 | 681 | if (methodDoc.isIncluded()) { |
jjg@1606 | 682 | for (Tag tag: methodDoc.tags()) { |
jjg@1606 | 683 | String tagName = tag.name(); |
jjg@1606 | 684 | if (tagName.equals("@propertySetter") |
jjg@1606 | 685 | || tagName.equals("@propertyGetter") |
jjg@1606 | 686 | || tagName.equals("@propertyDescription")) { |
jjg@1606 | 687 | if (!isPropertyGetterOrSetter(members, methodDoc)) { |
jjg@1606 | 688 | configuration.message.warning(tag.position(), |
jjg@1606 | 689 | "doclet.javafx_tag_misuse"); |
jjg@1606 | 690 | } |
jjg@1606 | 691 | break; |
jjg@1606 | 692 | } |
jjg@1606 | 693 | } |
jjg@1606 | 694 | } |
jjg@1606 | 695 | } |
jjg@1606 | 696 | } |
jjg@1606 | 697 | |
jjg@1606 | 698 | private boolean isPropertyGetterOrSetter(MethodDoc[] members, |
jjg@1606 | 699 | MethodDoc methodDoc) { |
jjg@1606 | 700 | boolean found = false; |
jjg@1606 | 701 | String propertyName = Util.propertyNameFromMethodName(methodDoc.name()); |
jjg@1606 | 702 | if (!propertyName.isEmpty()) { |
jjg@1606 | 703 | String propertyMethodName = propertyName + "Property"; |
jjg@1606 | 704 | for (MethodDoc member: members) { |
jjg@1606 | 705 | if (member.name().equals(propertyMethodName)) { |
jjg@1606 | 706 | found = true; |
jjg@1606 | 707 | break; |
jjg@1606 | 708 | } |
jjg@1606 | 709 | } |
jjg@1606 | 710 | } |
jjg@1606 | 711 | return found; |
jjg@1606 | 712 | } |
jjg@1606 | 713 | } |
jjg@1606 | 714 | |
jjg@1606 | 715 | private class GetterSetter { |
jjg@1606 | 716 | private final ProgramElementDoc getter; |
jjg@1606 | 717 | private final ProgramElementDoc setter; |
jjg@1606 | 718 | |
jjg@1606 | 719 | public GetterSetter(ProgramElementDoc getter, ProgramElementDoc setter) { |
jjg@1606 | 720 | this.getter = getter; |
jjg@1606 | 721 | this.setter = setter; |
jjg@1606 | 722 | } |
jjg@1606 | 723 | |
jjg@1606 | 724 | public ProgramElementDoc getGetter() { |
jjg@1606 | 725 | return getter; |
jjg@1606 | 726 | } |
jjg@1606 | 727 | |
jjg@1606 | 728 | public ProgramElementDoc getSetter() { |
jjg@1606 | 729 | return setter; |
jjg@1606 | 730 | } |
duke@1 | 731 | } |
duke@1 | 732 | |
duke@1 | 733 | /** |
duke@1 | 734 | * Return true if this map has no visible members. |
duke@1 | 735 | * |
duke@1 | 736 | * @return true if this map has no visible members. |
duke@1 | 737 | */ |
duke@1 | 738 | public boolean noVisibleMembers() { |
duke@1 | 739 | return noVisibleMembers; |
duke@1 | 740 | } |
duke@1 | 741 | |
duke@1 | 742 | private ClassMember getClassMember(MethodDoc member) { |
mcimadamore@184 | 743 | for (Iterator<?> iter = memberNameMap.keySet().iterator(); iter.hasNext();) { |
duke@1 | 744 | Object key = iter.next(); |
duke@1 | 745 | if (key instanceof String) { |
duke@1 | 746 | continue; |
duke@1 | 747 | } else if (((ClassMember) key).isEqual(member)) { |
duke@1 | 748 | return (ClassMember) key; |
duke@1 | 749 | } |
duke@1 | 750 | } |
duke@1 | 751 | return new ClassMember(member); |
duke@1 | 752 | } |
duke@1 | 753 | |
duke@1 | 754 | /** |
duke@1 | 755 | * Return the key to the member map for the given member. |
duke@1 | 756 | */ |
duke@1 | 757 | private Object getMemberKey(ProgramElementDoc doc) { |
duke@1 | 758 | if (doc.isConstructor()) { |
duke@1 | 759 | return doc.name() + ((ExecutableMemberDoc)doc).signature(); |
duke@1 | 760 | } else if (doc.isMethod()) { |
duke@1 | 761 | return getClassMember((MethodDoc) doc); |
duke@1 | 762 | } else if (doc.isField() || doc.isEnumConstant() || doc.isAnnotationTypeElement()) { |
duke@1 | 763 | return doc.name(); |
duke@1 | 764 | } else { // it's a class or interface |
duke@1 | 765 | String classOrIntName = doc.name(); |
duke@1 | 766 | //Strip off the containing class name because we only want the member name. |
duke@1 | 767 | classOrIntName = classOrIntName.indexOf('.') != 0 ? classOrIntName.substring(classOrIntName.lastIndexOf('.'), classOrIntName.length()) : classOrIntName; |
duke@1 | 768 | return "clint" + classOrIntName; |
duke@1 | 769 | } |
duke@1 | 770 | } |
duke@1 | 771 | } |