JFlexXref.java revision 1384
850N/A * The contents of this file are subject to the terms of the 850N/A * Common Development and Distribution License (the "License"). 850N/A * You may not use this file except in compliance with the License. 850N/A * language governing permissions and limitations under the License. 850N/A * When distributing Covered Code, include this CDDL HEADER in each 850N/A * If applicable, add the following below this CDDL HEADER, with the 850N/A * fields enclosed by brackets "[]" replaced with your own identifying 850N/A * information: Portions Copyright [yyyy] [name of copyright owner] 1058N/A * Copyright (c) 2009, 2011, Oracle and/or its affiliates. All rights reserved. 1185N/A * Portions Copyright 2011, 2012 Jens Elkner. 850N/A * Base class for Xref lexers. 1185N/A * A stack of <span ...> CSS class names currently opened. 1185N/A * It is used to close all open spans for a line and re-open them at the 1185N/A * start of the next line to produce wellformed XML. So if a 1190N/A * <span ...> is opened and do not closed on the same line, the class 1190N/A * name used needs to be pushed onto this stack. If the <span ...> 1185N/A * gets closed on a different line, it needs to be popped from this stack. 1185N/A * If properly done, the stack should be empty when the last line has been 1145N/A * Create a new empty instance with the default capacity. 1145N/A * The preferred method to add a new span class name to this instance. 1145N/A * @param s class name to add. 1145N/A * @throws IllegalArgumentException if the given argument is {@code null}. 1145N/A * The preferred method to remove the last element from this stack. 1145N/A * @return {@code null} if the stack is empty, the removed element 1121N/A /** the {@link SpanStack} for this and only this instance */ 1121N/A /** EOF value returned by yylex(). */ 1121N/A /** See {@link RuntimeEnvironment#getUserPage()}. Per default initialized 1121N/A * in the constructor and here to be consistent and avoid lot of 1185N/A /** See {@link RuntimeEnvironment#getUserPageSuffix()}. Per default 1185N/A * initialized in the constructor and here to be consistent and avoid lot of 1121N/A * Description of the style to use for a type of definitions. 1121N/A /** Name of the style definition as given by CTags. */ 1121N/A /** Class name used by the style sheets when rendering the xref. */ 1121N/A * The title of the section to which this type belongs, or {@code null} 1121N/A * if this type should not be listed in the navigation panel. 1121N/A /** Construct a style description. */ 1121N/A * Description of styles to use for different types of definitions. 1121N/A * Create a new lexer instance. Initializes {@link #userPageLink}, 1121N/A * {@link #userPageSuffix} using the runtime environment and creates a new 1121N/A * @see RuntimeEnvironment#getUserPage() 1121N/A * @see RuntimeEnvironment#getUserPageSuffix() 1121N/A // TODO when bug #16053 is fixed, we should add a getter to a file 1121N/A // that's included from all the Xref classes so that we avoid the 1145N/A // The auto-generated constructors for the Xref classes don't 1145N/A // expect a checked exception, so wrap it in an AssertionError. 1145N/A // This should never happen, since all the Xref classes will get 1145N/A // a public static YYEOF field from JFlex. 1145N/A throw ae;
// NOPMD (stack trace is preserved by initCause(), but 1145N/A * Reinitialize the xref with new contents. 1145N/A * @param contents a char buffer with text to analyze 1145N/A * @param length the number of characters to use from the char buffer 1145N/A /** Get the next token from the scanner. */ 1145N/A /** Get the value of {@code yyline}. */ 1145N/A /** Set the value of {@code yyline}. */ 1145N/A * Write the crossfile content to the specified {@code Writer}. 1145N/A * @param out xref destination 1145N/A * @throws IOException on error when writing the xref 1145N/A // nothing to do here, yylex() will do the work 1145N/A +
" lexer is not perfect yet!");
1145N/A * Write a JavaScript function that returns an array with the definitions 1145N/A * to list in the navigation panel. Each element of the array is itself an 1145N/A * array containing the name of the definition type, the CSS class name for 1145N/A * the type, and an array of (symbol, line) pairs for the definitions of 1145N/A // No definitions, no symbol table to write 1145N/A // We want the symbol table to be sorted 1121N/A // Order by symbol name, and then by line number if multiple 1121N/A // definitions use the same symbol name 1121N/A /* no LF intentionally - xml is whitespace aware ... */ 1121N/A * Get the style description for a definition type. 1121N/A * @param type the definition type 1121N/A * @return the style of a definition type, or {@code null} if no style is 1121N/A * Write out annotation infos for the given line. 1121N/A * @param num linenumber to print 1121N/A * @throws IOException depends on the destination (<var>out</var>). out.
write(
' ');
// <div></div> doesn't produce a line-height block * Terminate the current line and insert preamble for the next line. The * line count will be incremented. * @throws IOException on error when writing the xref * -> uncompressed size ~6%, compressed size ~26% bigger; * <div id="N"><b>N</b>...</div> * -> uncompressed size ~12%, compressed size ~52% bigger; * <span class="[h]l" id="N">N</span>... * -> is about the same as previous one * Write a symbol and generate links as appropriate. * @param symbol the symbol to write * @param keywords a set of keywords recognized by this analyzer (no links * will be generated if the symbol is a keyword) * @param line the line number on which the symbol appears * @throws IOException if an error occurs while writing to the stream // This is a keyword, so we don't create a link. // This is the definition of the symbol. // 1) Create an anchor for direct links. (Perhaps we should only // do this when there's exactly one definition of the symbol in // this file? Otherwise, we may end up with multiple anchors with // 2) Create a link that searches for all references to this symbol. // This is a reference to a symbol defined exactly once in this file. // Generate a direct link to the symbol definition. // This is a symbol that is not defined in this file, or a symbol // that is defined more than once in this file. In either case, we // can't generate a direct link to the definition, so generate a // link to search for all definitions of that symbol instead. * Write HTML escape sequence for the specified Unicode character, unless * it's an ISO control character, in which case it is ignored. * @param c the character to write * @throws IOException if an error occurs while writing to the stream * Write an e-mail address. The address will be obfuscated if * {@link RuntimeEnvironment#isObfuscatingEMailAddresses()} returns * @param address the address to write * @throws IOException if an error occurs while writing to the stream