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