001//////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code for adherence to a set of rules. 003// Copyright (C) 2001-2014 Oliver Burn 004// 005// This library is free software; you can redistribute it and/or 006// modify it under the terms of the GNU Lesser General Public 007// License as published by the Free Software Foundation; either 008// version 2.1 of the License, or (at your option) any later version. 009// 010// This library is distributed in the hope that it will be useful, 011// but WITHOUT ANY WARRANTY; without even the implied warranty of 012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 013// Lesser General Public License for more details. 014// 015// You should have received a copy of the GNU Lesser General Public 016// License along with this library; if not, write to the Free Software 017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 018//////////////////////////////////////////////////////////////////////////////// 019package com.puppycrawl.tools.checkstyle.api; 020 021import com.puppycrawl.tools.checkstyle.grammars.javadoc.JavadocParser; 022 023public final class JavadocTokenTypes 024{ 025 private static final int RULE_TYPES_OFFSET = 10000; 026 027 // root node 028 public static final int JAVADOC = JavadocParser.RULE_javadoc + RULE_TYPES_OFFSET; 029 030 //--------------------------------------------------------------------------------------------// 031 //------------------ JAVADOC TAGS --------------------------------------------// 032 //--------------------------------------------------------------------------------------------// 033 034 public static final int JAVADOC_TAG = JavadocParser.RULE_javadocTag + RULE_TYPES_OFFSET; 035 public static final int JAVADOC_INLINE_TAG = JavadocParser.RULE_javadocInlineTag + RULE_TYPES_OFFSET; 036 037 public static final int RETURN_LITERAL = JavadocParser.RETURN_LITERAL; 038 public static final int DEPRECATED_LITERAL = JavadocParser.DEPRECATED_LITERAL; 039 public static final int SINCE_LITERAL = JavadocParser.SINCE_LITERAL; 040 public static final int SERIAL_DATA_LITERAL = JavadocParser.SERIAL_DATA_LITERAL; 041 public static final int SERIAL_FIELD_LITERAL = JavadocParser.SERIAL_FIELD_LITERAL; 042 public static final int PARAM_LITERAL = JavadocParser.PARAM_LITERAL; 043 public static final int SEE_LITERAL = JavadocParser.SEE_LITERAL; 044 public static final int SERIAL_LITERAL = JavadocParser.SERIAL_LITERAL; 045 public static final int VERSION_LITERAL = JavadocParser.VERSION_LITERAL; 046 public static final int CUSTOM_NAME = JavadocParser.CUSTOM_NAME; 047 public static final int EXCEPTION_LITERAL = JavadocParser.EXCEPTION_LITERAL; 048 public static final int THROWS_LITERAL = JavadocParser.THROWS_LITERAL; 049 public static final int AUTHOR_LITERAL = JavadocParser.AUTHOR_LITERAL; 050 051 public static final int JAVADOC_INLINE_TAG_START = JavadocParser.JAVADOC_INLINE_TAG_START; // '{' 052 public static final int JAVADOC_INLINE_TAG_END = JavadocParser.JAVADOC_INLINE_TAG_END; // '}' 053 054 public static final int CODE_LITERAL = JavadocParser.CODE_LITERAL; 055 public static final int DOC_ROOT_LITERAL = JavadocParser.DOC_ROOT_LITERAL; 056 public static final int LINK_LITERAL = JavadocParser.LINK_LITERAL; 057 public static final int INHERIT_DOC_LITERAL = JavadocParser.INHERIT_DOC_LITERAL; 058 public static final int LINKPLAIN_LITERAL = JavadocParser.LINKPLAIN_LITERAL; 059 public static final int LITERAL_LITERAL = JavadocParser.LITERAL_LITERAL; // @literal 060 public static final int VALUE_LITERAL = JavadocParser.VALUE_LITERAL; 061 062 // @see and {@link} argument 063 public static final int REFERENCE = JavadocParser.RULE_reference + RULE_TYPES_OFFSET; 064 065 // @see and {@link} reference components 066 public static final int PACKAGE = JavadocParser.PACKAGE; 067 public static final int CLASS = JavadocParser.CLASS; 068 public static final int DOT = JavadocParser.DOT; 069 public static final int HASH = JavadocParser.HASH; // # 070 public static final int MEMBER = JavadocParser.MEMBER; 071 public static final int PARAMETERS = JavadocParser.RULE_parameters + RULE_TYPES_OFFSET; // parent node for LEFT_BRACE, RIGHT_BRACE, ARGUMENT, COMMA nodes 072 public static final int LEFT_BRACE = JavadocParser.LEFT_BRACE; 073 public static final int RIGHT_BRACE = JavadocParser.RIGHT_BRACE; 074 public static final int ARGUMENT = JavadocParser.ARGUMENT; 075 public static final int COMMA = JavadocParser.COMMA; 076 077 // @see and {@link} argument 078 public static final int STRING = JavadocParser.STRING; // "text" 079 080 // description argument for many Javadoc tags 081 public static final int DESCRIPTION = JavadocParser.RULE_description + RULE_TYPES_OFFSET; 082 083 // First argument of @exception: @exception class-name description 084 public static final int CLASS_NAME = JavadocParser.CLASS_NAME; 085 086 // First argument of @param: @param parameter-name description 087 public static final int PARAMETER_NAME = JavadocParser.PARAMETER_NAME; 088 089 // @serial and @serialField arguments 090 public static final int LITERAL_EXCLUDE = JavadocParser.LITERAL_EXCLUDE; 091 public static final int LITERAL_INCLUDE = JavadocParser.LITERAL_INCLUDE; 092 public static final int FIELD_NAME = JavadocParser.FIELD_NAME; 093 public static final int FIELD_TYPE = JavadocParser.FIELD_TYPE; 094 095 096 //--------------------------------------------------------------------------------------------// 097 //------------------ HTML TAGS -----------------------------------------------// 098 //--------------------------------------------------------------------------------------------// 099 100 public static final int HTML_ELEMENT = JavadocParser.RULE_htmlElement + RULE_TYPES_OFFSET; // parent node for all html tags 101 public static final int HTML_ELEMENT_OPEN = JavadocParser.RULE_htmlElementOpen + RULE_TYPES_OFFSET + RULE_TYPES_OFFSET; // <XXX> 102 public static final int HTML_ELEMENT_CLOSE = JavadocParser.RULE_htmlElementClose + RULE_TYPES_OFFSET; // </XXX> 103 104 public static final int HTML_TAG = JavadocParser.RULE_htmlTag + RULE_TYPES_OFFSET; // non-special HTML tag 105 public static final int HTML_TAG_NAME = JavadocParser.HTML_TAG_NAME; // identifier inside HTML tag: tag name or attribute name 106 public static final int ATTRIBUTE = JavadocParser.RULE_attribute + RULE_TYPES_OFFSET + RULE_TYPES_OFFSET; // html tag attribute. Parent node for: HTML_TAG_IDENT, EQUALS, ATTR_VALUE 107 108 // HTML tag components 109 public static final int OPEN = JavadocParser.OPEN; // '<' 110 public static final int SLASH = JavadocParser.SLASH; // '/' 111 public static final int CLOSE = JavadocParser.CLOSE; // '>' 112 public static final int SLASH_CLOSE = JavadocParser.SLASH_CLOSE; // '/>' 113 public static final int EQUALS = JavadocParser.EQUALS; // '=' 114 public static final int ATTR_VALUE = JavadocParser.ATTR_VALUE; // attribute value 115 116 /////////////////////// HTML TAGS WITH OPTIONAL CLOSE TAG ///////////////////////////////////// 117 public static final int PARAGRAPH = JavadocParser.RULE_paragraph + RULE_TYPES_OFFSET; 118 public static final int P_TAG_OPEN = JavadocParser.RULE_pTagOpen + RULE_TYPES_OFFSET; 119 public static final int P_TAG_CLOSE = JavadocParser.RULE_pTagClose + RULE_TYPES_OFFSET; 120 public static final int P_HTML_TAG_NAME = JavadocParser.P_HTML_TAG_NAME; 121 122 public static final int LI = JavadocParser.RULE_li + RULE_TYPES_OFFSET; 123 public static final int LI_TAG_OPEN = JavadocParser.RULE_liTagOpen + RULE_TYPES_OFFSET; 124 public static final int LI_TAG_CLOSE = JavadocParser.RULE_liTagClose + RULE_TYPES_OFFSET; 125 public static final int LI_HTML_TAG_NAME = JavadocParser.LI_HTML_TAG_NAME; 126 127 public static final int TR = JavadocParser.RULE_tr + RULE_TYPES_OFFSET; 128 public static final int TR_TAG_OPEN = JavadocParser.RULE_trTagOpen + RULE_TYPES_OFFSET; 129 public static final int TR_TAG_CLOSE = JavadocParser.RULE_trTagClose + RULE_TYPES_OFFSET; 130 public static final int TR_HTML_TAG_NAME = JavadocParser.TR_HTML_TAG_NAME; 131 132 public static final int TD = JavadocParser.RULE_td + RULE_TYPES_OFFSET; 133 public static final int TD_TAG_OPEN = JavadocParser.RULE_tdTagOpen + RULE_TYPES_OFFSET; 134 public static final int TD_TAG_CLOSE = JavadocParser.RULE_tdTagClose + RULE_TYPES_OFFSET; 135 public static final int TD_HTML_TAG_NAME = JavadocParser.TD_HTML_TAG_NAME; 136 137 public static final int TH = JavadocParser.RULE_th + RULE_TYPES_OFFSET; 138 public static final int TH_TAG_OPEN = JavadocParser.RULE_thTagOpen + RULE_TYPES_OFFSET; 139 public static final int TH_TAG_CLOSE = JavadocParser.RULE_thTagClose + RULE_TYPES_OFFSET; 140 public static final int TH_HTML_TAG_NAME = JavadocParser.TH_HTML_TAG_NAME; 141 142 public static final int BODY = JavadocParser.RULE_body + RULE_TYPES_OFFSET; 143 public static final int BODY_TAG_OPEN = JavadocParser.RULE_bodyTagOpen + RULE_TYPES_OFFSET; 144 public static final int BODY_TAG_CLOSE = JavadocParser.RULE_bodyTagClose + RULE_TYPES_OFFSET; 145 public static final int BODY_HTML_TAG_NAME = JavadocParser.BODY_HTML_TAG_NAME; 146 147 public static final int COLGROUP = JavadocParser.RULE_colgroup + RULE_TYPES_OFFSET; 148 public static final int COLGROUP_TAG_OPEN = JavadocParser.RULE_colgroupTagOpen + RULE_TYPES_OFFSET; 149 public static final int COLGROUP_TAG_CLOSE = JavadocParser.RULE_colgroupTagClose + RULE_TYPES_OFFSET; 150 public static final int COLGROUP_HTML_TAG_NAME = JavadocParser.COLGROUP_HTML_TAG_NAME; 151 152 public static final int DD = JavadocParser.RULE_dd + RULE_TYPES_OFFSET; 153 public static final int DD_TAG_OPEN = JavadocParser.RULE_ddTagOpen + RULE_TYPES_OFFSET; 154 public static final int DD_TAG_CLOSE = JavadocParser.RULE_ddTagClose + RULE_TYPES_OFFSET; 155 public static final int DD_HTML_TAG_NAME = JavadocParser.DD_HTML_TAG_NAME; 156 157 public static final int DT = JavadocParser.RULE_dt + RULE_TYPES_OFFSET; 158 public static final int DT_TAG_OPEN = JavadocParser.RULE_dtTagOpen + RULE_TYPES_OFFSET; 159 public static final int DT_TAG_CLOSE = JavadocParser.RULE_dtTagClose + RULE_TYPES_OFFSET; 160 public static final int DT_HTML_TAG_NAME = JavadocParser.DT_HTML_TAG_NAME; 161 162 public static final int HEAD = JavadocParser.RULE_head + RULE_TYPES_OFFSET; 163 public static final int HEAD_TAG_OPEN = JavadocParser.RULE_headTagOpen + RULE_TYPES_OFFSET; 164 public static final int HEAD_TAG_CLOSE = JavadocParser.RULE_headTagClose + RULE_TYPES_OFFSET; 165 public static final int HEAD_HTML_TAG_NAME = JavadocParser.HEAD_HTML_TAG_NAME; 166 167 public static final int HTML = JavadocParser.RULE_html + RULE_TYPES_OFFSET; 168 public static final int HTML_TAG_OPEN = JavadocParser.RULE_htmlTagOpen + RULE_TYPES_OFFSET; 169 public static final int HTML_TAG_CLOSE = JavadocParser.RULE_htmlTagClose + RULE_TYPES_OFFSET; 170 public static final int HTML_HTML_TAG_NAME = JavadocParser.HTML_HTML_TAG_NAME; 171 172 public static final int OPTION = JavadocParser.RULE_option + RULE_TYPES_OFFSET; 173 public static final int OPTION_TAG_OPEN = JavadocParser.RULE_optionTagOpen + RULE_TYPES_OFFSET; 174 public static final int OPTION_TAG_CLOSE = JavadocParser.RULE_optionTagClose + RULE_TYPES_OFFSET; 175 public static final int OPTION_HTML_TAG_NAME = JavadocParser.OPTION_HTML_TAG_NAME; 176 177 public static final int TBODY = JavadocParser.RULE_tbody + RULE_TYPES_OFFSET; 178 public static final int TBODY_TAG_OPEN = JavadocParser.RULE_tbodyTagOpen + RULE_TYPES_OFFSET; 179 public static final int TBODY_TAG_CLOSE = JavadocParser.RULE_tbodyTagClose + RULE_TYPES_OFFSET; 180 public static final int TBODY_HTML_TAG_NAME = JavadocParser.TBODY_HTML_TAG_NAME; 181 182 public static final int TFOOT = JavadocParser.RULE_tfoot + RULE_TYPES_OFFSET; 183 public static final int TFOOT_TAG_OPEN = JavadocParser.RULE_tfootTagOpen + RULE_TYPES_OFFSET; 184 public static final int TFOOT_TAG_CLOSE = JavadocParser.RULE_tfootTagClose + RULE_TYPES_OFFSET; 185 public static final int TFOOT_HTML_TAG_NAME = JavadocParser.TFOOT_HTML_TAG_NAME; 186 187 public static final int THEAD = JavadocParser.RULE_thead + RULE_TYPES_OFFSET; 188 public static final int THEAD_TAG_OPEN = JavadocParser.RULE_theadTagOpen + RULE_TYPES_OFFSET; 189 public static final int THEAD_TAG_CLOSE = JavadocParser.RULE_theadTagClose + RULE_TYPES_OFFSET; 190 public static final int THEAD_HTML_TAG_NAME = JavadocParser.THEAD_HTML_TAG_NAME; 191 /////////////////////////////////////////////////////////////////////////////////////////////// 192 193 194 /////////////////////// SINGLETON HTML TAGS ////////////////////////////////////////////////// 195 public static final int SINGLETON_ELEMENT = JavadocParser.RULE_singletonElement + RULE_TYPES_OFFSET; // parent node for all singleton tags 196 197 public static final int SINGLETON_TAG = JavadocParser.RULE_singletonTag + RULE_TYPES_OFFSET; // non-special singleton tag 198 199 public static final int AREA_TAG = JavadocParser.RULE_areaTag + RULE_TYPES_OFFSET; 200 public static final int AREA_HTML_TAG_NAME = JavadocParser.AREA_HTML_TAG_NAME; 201 202 public static final int BASE_TAG = JavadocParser.RULE_baseTag + RULE_TYPES_OFFSET; 203 public static final int BASE_HTML_TAG_NAME = JavadocParser.BASE_HTML_TAG_NAME; 204 205 public static final int BASEFRONT_TAG = JavadocParser.RULE_basefrontTag + RULE_TYPES_OFFSET; 206 public static final int BASEFRONT_HTML_TAG_NAME = JavadocParser.BASEFRONT_HTML_TAG_NAME; 207 208 public static final int BR_TAG = JavadocParser.RULE_brTag + RULE_TYPES_OFFSET; 209 public static final int BR_HTML_TAG_NAME = JavadocParser.BR_HTML_TAG_NAME; 210 211 public static final int COL_TAG = JavadocParser.RULE_colTag + RULE_TYPES_OFFSET; 212 public static final int COL_HTML_TAG_NAME = JavadocParser.COL_HTML_TAG_NAME; 213 214 public static final int FRAME_TAG = JavadocParser.RULE_frameTag + RULE_TYPES_OFFSET; 215 public static final int FRAME_HTML_TAG_NAME = JavadocParser.FRAME_HTML_TAG_NAME; 216 217 public static final int HR_TAG = JavadocParser.RULE_hrTag + RULE_TYPES_OFFSET; 218 public static final int HR_HTML_TAG_NAME = JavadocParser.HR_HTML_TAG_NAME; 219 220 public static final int IMG_TAG = JavadocParser.RULE_imgTag + RULE_TYPES_OFFSET; 221 public static final int IMG_HTML_TAG_NAME = JavadocParser.IMG_HTML_TAG_NAME; 222 223 public static final int INPUT_TAG = JavadocParser.RULE_inputTag + RULE_TYPES_OFFSET; 224 public static final int INPUT_HTML_TAG_NAME = JavadocParser.INPUT_HTML_TAG_NAME; 225 226 public static final int ISINDEX_TAG = JavadocParser.RULE_isindexTag + RULE_TYPES_OFFSET; 227 public static final int ISINDEX_HTML_TAG_NAME = JavadocParser.ISINDEX_HTML_TAG_NAME; 228 229 public static final int LINK_TAG = JavadocParser.RULE_linkTag + RULE_TYPES_OFFSET; 230 public static final int LINK_HTML_TAG_NAME = JavadocParser.LINK_HTML_TAG_NAME; 231 232 public static final int META_TAG = JavadocParser.RULE_metaTag + RULE_TYPES_OFFSET; 233 public static final int META_HTML_TAG_NAME = JavadocParser.META_HTML_TAG_NAME; 234 235 public static final int PARAM_TAG = JavadocParser.RULE_paramTag + RULE_TYPES_OFFSET; 236 public static final int PARAM_HTML_TAG_NAME = JavadocParser.PARAM_HTML_TAG_NAME; 237 /////////////////////////////////////////////////////////////////////////////////////////////// 238 239 // HTML comments 240 public static final int HTML_COMMENT = JavadocParser.RULE_htmlComment + RULE_TYPES_OFFSET + RULE_TYPES_OFFSET; 241 public static final int HTML_COMMENT_START = JavadocParser.HTML_COMMENT_START; // <!--- 242 public static final int HTML_COMMENT_END = JavadocParser.HTML_COMMENT_END; // --> 243 244 public static final int CDATA = JavadocParser.CDATA; // '<![CDATA[...]]>' 245 246 //--------------------------------------------------------------------------------------------// 247 //------------------ OTHER ---------------------------------------------------// 248 //--------------------------------------------------------------------------------------------// 249 250 public static final int LEADING_ASTERISK = JavadocParser.LEADING_ASTERISK; 251 public static final int NEWLINE = JavadocParser.NEWLINE; // \n 252 public static final int CHAR = JavadocParser.CHAR; // any symbol 253 public static final int WS = JavadocParser.WS; // whitespace, \t 254 public static final int TEXT = JavadocParser.RULE_text + RULE_TYPES_OFFSET; // CHAR and WS sequence 255 256 public static final int EOF = JavadocParser.EOF; // end of file 257 258 259 260 private JavadocTokenTypes() 261 { 262 } 263 264}