src/share/classes/com/sun/tools/javadoc/SourcePositionImpl.java

Wed, 27 Apr 2016 01:34:52 +0800

author
aoqi
date
Wed, 27 Apr 2016 01:34:52 +0800
changeset 0
959103a6100f
child 2525
2eb010b6cb22
permissions
-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25
aoqi@0 26 package com.sun.tools.javadoc;
aoqi@0 27
aoqi@0 28 import java.io.File;
aoqi@0 29 import javax.tools.FileObject;
aoqi@0 30
aoqi@0 31 import com.sun.javadoc.SourcePosition;
aoqi@0 32 import com.sun.tools.javac.util.Position;
aoqi@0 33
aoqi@0 34 /**
aoqi@0 35 * A source position: filename, line number, and column number.
aoqi@0 36 *
aoqi@0 37 * <p><b>This is NOT part of any supported API.
aoqi@0 38 * If you write code that depends on this, you do so at your own risk.
aoqi@0 39 * This code and its internal interfaces are subject to change or
aoqi@0 40 * deletion without notice.</b>
aoqi@0 41 *
aoqi@0 42 * @since J2SE1.4
aoqi@0 43 * @author Neal M Gafter
aoqi@0 44 * @author Michael Van De Vanter (position representation changed to char offsets)
aoqi@0 45 */
aoqi@0 46 public class SourcePositionImpl implements SourcePosition {
aoqi@0 47 FileObject filename;
aoqi@0 48 int position;
aoqi@0 49 Position.LineMap lineMap;
aoqi@0 50
aoqi@0 51 /** The source file. Returns null if no file information is
aoqi@0 52 * available. */
aoqi@0 53 public File file() {
aoqi@0 54 return (filename == null) ? null : new File(filename.getName());
aoqi@0 55 }
aoqi@0 56
aoqi@0 57 /** The source file. Returns null if no file information is
aoqi@0 58 * available. */
aoqi@0 59 public FileObject fileObject() {
aoqi@0 60 return filename;
aoqi@0 61 }
aoqi@0 62
aoqi@0 63 /** The line in the source file. The first line is numbered 1;
aoqi@0 64 * 0 means no line number information is available. */
aoqi@0 65 public int line() {
aoqi@0 66 if (lineMap == null) {
aoqi@0 67 return 0;
aoqi@0 68 } else {
aoqi@0 69 return lineMap.getLineNumber(position);
aoqi@0 70 }
aoqi@0 71 }
aoqi@0 72
aoqi@0 73 /** The column in the source file. The first column is
aoqi@0 74 * numbered 1; 0 means no column information is available.
aoqi@0 75 * Columns count characters in the input stream; a tab
aoqi@0 76 * advances the column number to the next 8-column tab stop.
aoqi@0 77 */
aoqi@0 78 public int column() {
aoqi@0 79 if (lineMap == null) {
aoqi@0 80 return 0;
aoqi@0 81 }else {
aoqi@0 82 return lineMap.getColumnNumber(position);
aoqi@0 83 }
aoqi@0 84 }
aoqi@0 85
aoqi@0 86 private SourcePositionImpl(FileObject file, int position,
aoqi@0 87 Position.LineMap lineMap) {
aoqi@0 88 super();
aoqi@0 89 this.filename = file;
aoqi@0 90 this.position = position;
aoqi@0 91 this.lineMap = lineMap;
aoqi@0 92 }
aoqi@0 93
aoqi@0 94 public static SourcePosition make(FileObject file, int pos,
aoqi@0 95 Position.LineMap lineMap) {
aoqi@0 96 if (file == null) return null;
aoqi@0 97 return new SourcePositionImpl(file, pos, lineMap);
aoqi@0 98 }
aoqi@0 99
aoqi@0 100 public String toString() {
aoqi@0 101 // Backwards compatibility hack. ZipFileObjects use the format
aoqi@0 102 // zipfile(zipentry) but javadoc has been using zipfile/zipentry
aoqi@0 103 String fn = filename.getName();
aoqi@0 104 if (fn.endsWith(")")) {
aoqi@0 105 int paren = fn.lastIndexOf("(");
aoqi@0 106 if (paren != -1)
aoqi@0 107 fn = fn.substring(0, paren)
aoqi@0 108 + File.separatorChar
aoqi@0 109 + fn.substring(paren + 1, fn.length() - 1);
aoqi@0 110 }
aoqi@0 111
aoqi@0 112 if (position == Position.NOPOS)
aoqi@0 113 return fn;
aoqi@0 114 else
aoqi@0 115 return fn + ":" + line();
aoqi@0 116 }
aoqi@0 117 }

mercurial