summaryrefslogtreecommitdiffstats
path: root/tools/droiddoc/src/Errors.java
blob: dfeac8867cdf327c2c648b520ba08f6c31b2e978 (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
/*
 * Copyright (C) 2008 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import java.util.SortedSet;
import java.util.TreeSet;

public class Errors
{
    public static boolean hadError = false;
    private static boolean warningsAreErrors = false;
    private static TreeSet<Message> allErrors = new TreeSet<Message>();

    private static class Message implements Comparable {
        SourcePositionInfo pos;
        int level;
        String msg;

        Message(SourcePositionInfo p, int l, String m) {
            pos = p;
            level = l;
            msg = m;
        }

        public int compareTo(Object o) {
            Message that = (Message)o;
            int r = this.pos.compareTo(that.pos);
            if (r != 0) return r;
            return this.msg.compareTo(that.msg);
        }

        public String toString() {
            String whereText = this.pos == null ? "unknown: " : this.pos.toString() + ':';
            return whereText + this.msg;
        }
    }

    public static void error(Error error, SourcePositionInfo where, String text) {
        if (error.level == HIDDEN) {
            return;
        }

        int level = (!warningsAreErrors && error.level == WARNING) ? WARNING : ERROR;
        String which = level == WARNING ? " warning " : " error ";
        String message = which + error.code + ": " + text;

        if (where == null) {
            where = new SourcePositionInfo("unknown", 0, 0);
        }

        allErrors.add(new Message(where, level, message));

        if (error.level == ERROR || (warningsAreErrors && error.level == WARNING)) {
            hadError = true;
        }
    }

    public static void printErrors() {
        for (Message m: allErrors) {
            if (m.level == WARNING) {
                System.err.println(m.toString());
            }
        }
        for (Message m: allErrors) {
            if (m.level == ERROR) {
                System.err.println(m.toString());
            }
        }
    }

    public static int HIDDEN = 0;
    public static int WARNING = 1;
    public static int ERROR = 2;

    public static void setWarningsAreErrors(boolean val) {
        warningsAreErrors = val;
    }

    public static class Error {
        public int code;
        public int level;

        public Error(int code, int level)
        {
            this.code = code;
            this.level = level;
        }
    }

    public static Error UNRESOLVED_LINK = new Error(1, WARNING);
    public static Error BAD_INCLUDE_TAG = new Error(2, WARNING);
    public static Error UNKNOWN_TAG = new Error(3, WARNING);
    public static Error UNKNOWN_PARAM_TAG_NAME = new Error(4, WARNING);
    public static Error UNDOCUMENTED_PARAMETER = new Error(5, HIDDEN);
    public static Error BAD_ATTR_TAG = new Error(6, ERROR);
    public static Error BAD_INHERITDOC = new Error(7, HIDDEN);
    public static Error HIDDEN_LINK = new Error(8, WARNING);
    public static Error HIDDEN_CONSTRUCTOR = new Error(9, WARNING);
    public static Error UNAVAILABLE_SYMBOL = new Error(10, ERROR);
    public static Error HIDDEN_SUPERCLASS = new Error(11, WARNING);
    public static Error DEPRECATED = new Error(12, HIDDEN);
    public static Error DEPRECATION_MISMATCH = new Error(13, WARNING);
    public static Error MISSING_COMMENT = new Error(14, WARNING);
    public static Error IO_ERROR = new Error(15, HIDDEN);

    public static Error[] ERRORS = {
            UNRESOLVED_LINK,
            BAD_INCLUDE_TAG,
            UNKNOWN_TAG,
            UNKNOWN_PARAM_TAG_NAME,
            UNDOCUMENTED_PARAMETER,
            BAD_ATTR_TAG,
            BAD_INHERITDOC,
            HIDDEN_LINK,
            HIDDEN_CONSTRUCTOR,
            UNAVAILABLE_SYMBOL,
            HIDDEN_SUPERCLASS,
            DEPRECATED,
            IO_ERROR,
        };

    public static boolean setErrorLevel(int code, int level) {
        for (Error e: ERRORS) {
            if (e.code == code) {
                e.level = level;
                return true;
            }
        }
        return false;
    }
}