summaryrefslogtreecommitdiff
path: root/src/proguard/ClassMemberChecker.java
blob: 249105e62c0c94f64c0b8692a039d7e6d5ab3b7d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/*
 * ProGuard -- shrinking, optimization, obfuscation, and preverification
 *             of Java bytecode.
 *
 * Copyright (c) 2002-2014 Eric Lafortune (eric@graphics.cornell.edu)
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */
package proguard;

import proguard.classfile.*;
import proguard.classfile.util.*;
import proguard.classfile.visitor.MemberVisitor;

import java.util.List;

/**
 * This class checks if the user has specified non-existent class members.
 *
 * @author Eric Lafortune
 */
public class ClassMemberChecker
extends      SimplifiedVisitor
implements   MemberVisitor
{
    private final ClassPool      programClassPool;
    private final WarningPrinter notePrinter;


    /**
     * Creates a new ClassMemberChecker.
     */
    public ClassMemberChecker(ClassPool      programClassPool,
                              WarningPrinter notePrinter)
    {
        this.programClassPool = programClassPool;
        this.notePrinter      = notePrinter;
    }


    /**
     * Checks the classes mentioned in the given class specifications, printing
     * notes if necessary.
     */
    public void checkClassSpecifications(List classSpecifications)
    {
        if (classSpecifications != null)
        {
            for (int index = 0; index < classSpecifications.size(); index++)
            {
                ClassSpecification classSpecification =
                    (ClassSpecification)classSpecifications.get(index);

                String className = classSpecification.className;
                if (className != null             &&
                    !containsWildCards(className) &&
                    notePrinter.accepts(className))
                {
                    Clazz clazz = programClassPool.getClass(className);
                    if (clazz != null)
                    {
                        checkMemberSpecifications(clazz, classSpecification.fieldSpecifications,  true);
                        checkMemberSpecifications(clazz, classSpecification.methodSpecifications, false);
                    }
                }
            }
        }
    }


    /**
     * Checks the class members mentioned in the given class member
     * specifications, printing notes if necessary.
     */
    private void checkMemberSpecifications(Clazz   clazz,
                                           List    memberSpecifications,
                                           boolean isField)
    {
        if (memberSpecifications != null)
        {
            String className = clazz.getName();

            for (int index = 0; index < memberSpecifications.size(); index++)
            {
                MemberSpecification memberSpecification =
                    (MemberSpecification)memberSpecifications.get(index);

                String memberName = memberSpecification.name;
                String descriptor = memberSpecification.descriptor;
                if (memberName != null             &&
                    !containsWildCards(memberName) &&
                    descriptor != null             &&
                    !containsWildCards(descriptor))
                {
                    if (isField)
                    {
                        if (clazz.findField(memberName, descriptor) == null)
                        {
                            notePrinter.print(className,
                                              "Note: the configuration refers to the unknown field '" +
                                              ClassUtil.externalFullFieldDescription(0, memberName, descriptor) + "' in class '" +
                                              ClassUtil.externalClassName(className) + "'");
                        }
                    }
                    else
                    {
                        if (clazz.findMethod(memberName, descriptor) == null)
                        {
                            notePrinter.print(className,
                                              "Note: the configuration refers to the unknown method '" +
                                              ClassUtil.externalFullMethodDescription(className, 0, memberName, descriptor) + "' in class '" +
                                              ClassUtil.externalClassName(className) + "'");
                        }
                    }
                }
            }
        }
    }


    private static boolean containsWildCards(String string)
    {
        return string != null &&
            (string.indexOf('!')   >= 0 ||
             string.indexOf('*')   >= 0 ||
             string.indexOf('?')   >= 0 ||
             string.indexOf(',')   >= 0 ||
             string.indexOf("///") >= 0);
    }


    // Implementations for MemberVisitor.

    public void visitProgramField(ProgramClass programClass, ProgramField programField)
    {
        System.out.println("      Maybe you meant the field '" +
                           ClassUtil.externalFullFieldDescription(0, programField.getName(programClass), programField.getDescriptor(programClass)) + "'?");
    }


    public void visitProgramMethod(ProgramClass programClass, ProgramMethod programMethod)
    {
        System.out.println("      Maybe you meant the method '" +
                           ClassUtil.externalFullMethodDescription(programClass.getName(), 0, programMethod.getName(programClass), programMethod.getDescriptor(programClass)) + "'?");
    }
}