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

Tue, 24 Dec 2013 09:17:37 -0800

author
ksrini
date
Tue, 24 Dec 2013 09:17:37 -0800
changeset 2227
998b10c43157
parent 1359
25e14ad23cef
child 2525
2eb010b6cb22
permissions
-rw-r--r--

8029230: Update copyright year to match last edit in jdk8 langtools repository for 2013
Reviewed-by: ksrini
Contributed-by: steve.sides@oracle.com

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

mercurial