Util.java revision 1229
207N/A * The contents of this file are subject to the terms of the 207N/A * Common Development and Distribution License (the "License"). 207N/A * You may not use this file except in compliance with the License. 207N/A * language governing permissions and limitations under the License. 207N/A * When distributing Covered Code, include this CDDL HEADER in each 207N/A * If applicable, add the following below this CDDL HEADER, with the 207N/A * fields enclosed by brackets "[]" replaced with your own identifying 207N/A * information: Portions Copyright [yyyy] [name of copyright owner] 207N/A * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. 207N/A * Portions Copyright 2011 Jens Elkner. 678N/A * Class for useful functions. 207N/A * Return a string which represents a <code>CharSequence</code> in HTML. 207N/A * @return a string representing the character sequence in HTML 207N/A * Append a character sequence to the given destination whereby 253N/A * special characters for HTML are escaped accordingly. 207N/A * @param q a character sequence to esacpe 359N/A * @param dest where to append the character sequence to 207N/A * Append a character array to the given destination whereby 207N/A * special characters for HTML are escaped accordingly. 207N/A * @param cs characters to esacpe 207N/A * @param length max. number of characters to append, starting from index 0. 207N/A * @param dest where to append the character sequence to 207N/A * Append a character to the given destination whereby special characters 261N/A * special for HTML are escaped accordingly. 207N/A * @param c the character to append 459N/A * @param dest where to append the character to 207N/A * used by BUI - CSS needs this parameter for proper cache refresh (per 207N/A * changeset) in client browser jel: but useless, since the page cached 261N/A * @return html escaped version (hg changeset) 261N/A * Convinience method for {@code breadcrumbPath(urlPrefix, path, '/')}. 261N/A * @param urlPrefix prefix to add to each url 261N/A * @param path path to crack 207N/A * @return HTML markup fro the breadcrumb or the path itself. 207N/A * @see #breadcrumbPath(String, String, char) 668N/A * Convenience method for 668N/A * {@code breadcrumbPath(urlPrefix, path, sep, "", false)}. 668N/A * @param urlPrefix prefix to add to each url 668N/A * @param path path to crack 668N/A * @param sep separator to use to crack the given path 668N/A * @return HTML markup fro the breadcrumb or the path itself. 668N/A * @see #breadcrumbPath(String, String, char, String, boolean, boolean) 668N/A * Convenience method for 668N/A * {@code breadcrumbPath(urlPrefix, path, sep, "", false, path.endsWith(sep)}. 668N/A * @param urlPrefix prefix to add to each url 668N/A * @param path path to crack 668N/A * @param sep separator to use to crack the given path 668N/A * @param urlPostfix suffix to add to each url 668N/A * @param compact if {@code true} the given path gets transformed into 668N/A * its canonical form (.i.e. all '.' and '..' and double separators 668N/A * removed, but not always resolves to an absolute path) before processing 668N/A * @return HTML markup fro the breadcrumb or the path itself. 668N/A * @see #breadcrumbPath(String, String, char, String, boolean, boolean) 668N/A * @see #getCanonicalPath(String, char) 668N/A * Create a breadcrumb path to allow navigation to each element of a path. 668N/A * Consecutive separators (<var>sep</var>) in the given <var>path</var> are 668N/A * always collapsed into a single separator automatically. If 668N/A * <var>compact</var> is {@code true} path gets translated into a canonical 668N/A * path similar to {@link File#getCanonicalPath()}, however the current 668N/A * working directory is assumed to be "/" and no checks are done (e.g. 460N/A * neither whether the path [component] exists nor which type it is). 580N/A * what should be prepend to the constructed URL 580N/A * the full path from which the breadcrumb path is built. 580N/A * the character that separates the path components in 580N/A * what should be append to the constructed URL 580N/A * if {@code true}, a canonical path gets constructed before 580N/A * if {@code true} a "/" gets append to the last path component's 580N/A * link and <var>sep</var> to its name 207N/A * @return <var>path</var> if it resolves to an empty or "/" or 580N/A * {@code null} path, the HTML markup for the breadcrumb path otherwise. 460N/A * Normalize the given <var>path</var> to its canonical form. I.e. all 439N/A * separators (<var>sep</var>) are replaced with a slash ('/'), all 274N/A * double slashes are replaced by a single slash, all single dot path 460N/A * components (".") of the formed path are removed and all double dot path 460N/A * components (".." ) of the formed path are replaced with its parent or 274N/A * '/' if there is no parent. 274N/A * So the difference to {@link File#getCanonicalPath()} is, that this method 274N/A * does not hit the disk (just string manipulation), resolves <var>path</var> 207N/A * always against '/' and thus always returns an absolute path, which may 459N/A * actually not exist, and which has a single trailing '/' if the given 678N/A * <var>path</var> ends with the given <var>sep</var>. 678N/A * @param path path to mangle. If not absolute or {@code null}, the 359N/A * current working directory is assumed to be '/'. 359N/A * @param sep file separator to use to crack <var>path</var> into path 359N/A * @return always a canonical path which starts with a '/'. 255N/A // since is not a general purpose method. So we waive to handle 456N/A // || path.endsWith("/..") || path.endsWith("/.") 651N/A * Remove all empty and {@code null} string elements from the given 274N/A * <var>names</var> and optionally all redundant information like "." and 274N/A * if {@code true}, remove redundant elements as well. 274N/A * @return a possible empty array of names all with a length > 0. 656N/A * Generate a regex that matches the specified character. Escape it in case 656N/A * it is a character that has a special meaning in a regex. 656N/A * the character that the regex should match 359N/A * @return a six-character string on the form <tt>\u</tt><i>hhhh</i> 667N/A * Convert the given size into a human readable string. 672N/A * @param num size to convert. 672N/A * @return a readable string 270N/A }
else if (l <
1048576) {
270N/A * Converts different html special characters into their encodings used in 564N/A * html. Currently used only for tooltips of annotation revision number view 564N/A * @return encoded text for use in <a title=""> tag 207N/A * Write out line information wrt. to the given annotation in the format: 359N/A * {@code Linenumber Blame Author} incl. appropriate links. 460N/A * @param num linenumber to print 460N/A * @param out print destination 359N/A * @param annotation annotation to use. If {@code null} only the 359N/A * linenumber gets printed. 359N/A * @param userPageLink see {@link RuntimeEnvironment#getUserPage()} 207N/A * @param userPageSuffix see {@link RuntimeEnvironment#getUserPageSuffix()} 320N/A * @throws IOException depends on the destination (<var>out</var>). 508N/A // this method should go to JFlexXref 207N/A * Generate a string from the given path and date in a way that allows 207N/A * stable lexicographic sorting (i.e. gives always the same results) as a 207N/A * walk of the file hierarchy. Thus null character (\u0000) is used both 207N/A * to separate directory components and to separate the path from the date. 207N/A * @param path path to mangle. 207N/A * @param date date string to use. 207N/A * @return the mangled path. 515N/A * The reverse operation for {@link #path2uid(String, String)} - re-creates 515N/A * the unmangled path from the given uid. 515N/A * @param uid uid to unmangle. 515N/A * @return the original path. 506N/A * wrapper arround UTF-8 URL encoding of a string 506N/A * @param q query to be encoded. If {@code null}, an empty string will 359N/A * @return null if fail, otherwise the encoded string 253N/A * @see URLEncoder#encode(String, String) 207N/A // Should not happen. UTF-8 must be supported by JVMs. 553N/A * Append '&name=value" to the given buffer. If the given <var>value</var> 656N/A * is {@code null}, this method does nothing. 553N/A * @param buf where to append the query string 553N/A * @param key the name of the parameter to add. Append as is! 553N/A * @param value the value for the given parameter. Gets automatically UTF-8 553N/A * @throws NullPointerException if the given buffer is {@code null}. 553N/A * @see #URIEncode(String) 506N/A * URI encode the given path. 553N/A * @param path path to encode. 593N/A * @return the encoded path. 593N/A * @see URI#getRawPath() 593N/A * @throws NullPointerException if a parameter is {@code null} 207N/A * Replace all quote characters (ASCI 0x22) with the corresponding html 207N/A * @param q string to escape. 207N/A * @return an empty string if a parameter is {@code null}, the mangled 480N/A * Tag changes in the given <var>line1</var> and <var>line2</var> 504N/A * for highlighting. Removed parts are tagged with CSS class {@code d}, 504N/A * new parts are tagged with CSS class {@code a} using a {@code span} 504N/A * @param line1 line of the original file 504N/A * @return the tagged lines (field[0] ~= line1, field[1] ~= line2). 207N/A * @throws NullPointerException if one of the given parameters is {@code null}. 207N/A if (n ==
0 || m ==
0) {
594N/A * Dump the configuration as an HTML table. 594N/A * destination for the HTML output 594N/A * if an error happens while writing to {@code out} 207N/A * @throws HistoryException 207N/A * if the history guru cannot be accesses 207N/A * Just read the given source and dump as is to the given destionation. 207N/A * Does nothing, if one or more of the parameters is {@code null}. 207N/A * @param out write destination 207N/A * @param in source to read 207N/A * @throws NullPointerException if a parameter is {@code null}. 207N/A * Silently dump a file to the given destionation. All {@link IOException}s 207N/A * gets caught and logged, but not re-thrown. 359N/A * @param out dump destination 207N/A * @param dir directory, which should contains the file. 312N/A * @param filename the basename of the file to dump. 207N/A * @param compressed if {@code true} the denoted file is assumed to be 207N/A * @return {@code true} on success (everything read and written). 207N/A * @throws NullPointerException if a parameter is {@code null}. 207N/A * Silently dump a file to the given destionation. All {@link IOException}s 207N/A * gets caught and logged, but not re-thrown. 207N/A * @param out dump destination 207N/A * @param file file to dump. 207N/A * @param compressed if {@code true} the denoted file is assumed to be 460N/A * @return {@code true} on success (everything read and written). 460N/A * @throws NullPointerException if a parameter is {@code null}. 207N/A "An error occured while piping file " +
file +
": ", e);
207N/A * Print a row in an HTML table. 207N/A * destination for the HTML output 207N/A * the values to print in the cells of the row 207N/A * if an error happens while writing to {@code out} 320N/A * Print an unordered list (HTML). 207N/A * destination for the HTML output 460N/A * if an error happens while writing to {@code out} 207N/A * Create a string literal for use in JavaScript functions. 207N/A * the string to be represented by the literal 207N/A * @return a JavaScript string literal