View Javadoc

1   /* Generated By:JavaCC: Do not edit this line. TokenMgrError.java Version 5.0 */
2   /* JavaCCOptions: */
3   package net.sourceforge.pmd.lang.ast;
4   
5   /** Token Manager Error. */
6   public class TokenMgrError extends RuntimeException
7   {
8   
9     /**
10     * The version identifier for this Serializable class.
11     * Increment only if the <i>serialized</i> form of the
12     * class changes.
13     */
14    private static final long serialVersionUID = 1L;
15  
16    /*
17     * Ordinals for various reasons why an Error of this type can be thrown.
18     */
19  
20    /**
21     * Lexical error occurred.
22     */
23    public static final int LEXICAL_ERROR = 0;
24  
25    /**
26     * An attempt was made to create a second instance of a static token manager.
27     */
28    public static final int STATIC_LEXER_ERROR = 1;
29  
30    /**
31     * Tried to change to an invalid lexical state.
32     */
33    public static final int INVALID_LEXICAL_STATE = 2;
34  
35    /**
36     * Detected (and bailed out of) an infinite loop in the token manager.
37     */
38    public static final int LOOP_DETECTED = 3;
39  
40    /**
41     * Indicates the reason why the exception is thrown. It will have
42     * one of the above 4 values.
43     */
44    int errorCode;
45  
46    /**
47     * Replaces unprintable characters by their escaped (or unicode escaped)
48     * equivalents in the given string
49     */
50    protected static final String addEscapes(String str) {
51      StringBuffer retval = new StringBuffer();
52      char ch;
53      for (int i = 0; i < str.length(); i++) {
54        switch (str.charAt(i))
55        {
56          case 0 :
57            continue;
58          case '\b':
59            retval.append("\\b");
60            continue;
61          case '\t':
62            retval.append("\\t");
63            continue;
64          case '\n':
65            retval.append("\\n");
66            continue;
67          case '\f':
68            retval.append("\\f");
69            continue;
70          case '\r':
71            retval.append("\\r");
72            continue;
73          case '\"':
74            retval.append("\\\"");
75            continue;
76          case '\'':
77            retval.append("\\\'");
78            continue;
79          case '\\':
80            retval.append("\\\\");
81            continue;
82          default:
83            if ((ch = str.charAt(i)) < 0x20 || ch > 0x7e) {
84              String s = "0000" + Integer.toString(ch, 16);
85              retval.append("\\u" + s.substring(s.length() - 4, s.length()));
86            } else {
87              retval.append(ch);
88            }
89            continue;
90        }
91      }
92      return retval.toString();
93    }
94  
95    /**
96     * Returns a detailed message for the Error when it is thrown by the
97     * token manager to indicate a lexical error.
98     * Parameters :
99     *    EOFSeen     : indicates if EOF caused the lexical error
100    *    curLexState : lexical state in which this error occurred
101    *    errorLine   : line number when the error occurred
102    *    errorColumn : column number when the error occurred
103    *    errorAfter  : prefix that was seen before this error occurred
104    *    curchar     : the offending character
105    * Note: You can customize the lexical error message by modifying this method.
106    */
107   protected static String LexicalError(boolean EOFSeen, int lexState, int errorLine, int errorColumn, String errorAfter, char curChar) {
108     return("Lexical error in file " + AbstractTokenManager.getFileName() + " at line " +
109           errorLine + ", column " +
110           errorColumn + ".  Encountered: " +
111           (EOFSeen ? "<EOF> " : ("\"" + addEscapes(String.valueOf(curChar)) + "\"") + " (" + (int)curChar + "), ") +
112           "after : \"" + addEscapes(errorAfter) + "\"");
113   }
114 
115   /**
116    * You can also modify the body of this method to customize your error messages.
117    * For example, cases like LOOP_DETECTED and INVALID_LEXICAL_STATE are not
118    * of end-users concern, so you can return something like :
119    *
120    *     "Internal Error : Please file a bug report .... "
121    *
122    * from this method for such cases in the release version of your parser.
123    */
124   public String getMessage() {
125     return super.getMessage();
126   }
127 
128   /*
129    * Constructors of various flavors follow.
130    */
131 
132   /** No arg constructor. */
133   public TokenMgrError() {
134   }
135 
136   /** Constructor with message and reason. */
137   public TokenMgrError(String message, int reason) {
138     super(message);
139     errorCode = reason;
140   }
141 
142   /** Full Constructor. */
143   public TokenMgrError(boolean EOFSeen, int lexState, int errorLine, int errorColumn, String errorAfter, char curChar, int reason) {
144     this(LexicalError(EOFSeen, lexState, errorLine, errorColumn, errorAfter, curChar), reason);
145   }
146 }
147 /* JavaCC - OriginalChecksum=c85aad4d5805fc96f6457a5c4cee44ab (do not edit this line) */