aoqi@0: /*
aoqi@0:  * Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.javadoc;
aoqi@0: 
aoqi@0: import java.io.File;
aoqi@0: import javax.tools.FileObject;
aoqi@0: 
aoqi@0: import com.sun.javadoc.SourcePosition;
aoqi@0: import com.sun.tools.javac.util.Position;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * A source position: filename, line number, and column number.
aoqi@0:  *
aoqi@0:  *  <p><b>This is NOT part of any supported API.
aoqi@0:  *  If you write code that depends on this, you do so at your own risk.
aoqi@0:  *  This code and its internal interfaces are subject to change or
aoqi@0:  *  deletion without notice.</b>
aoqi@0:  *
aoqi@0:  * @since J2SE1.4
aoqi@0:  * @author Neal M Gafter
aoqi@0:  * @author Michael Van De Vanter (position representation changed to char offsets)
aoqi@0:  */
aoqi@0: public class SourcePositionImpl implements SourcePosition {
aoqi@0:     FileObject filename;
aoqi@0:     int position;
aoqi@0:     Position.LineMap lineMap;
aoqi@0: 
aoqi@0:     /** The source file. Returns null if no file information is
aoqi@0:      *  available. */
aoqi@0:     public File file() {
aoqi@0:         return (filename == null) ? null : new File(filename.getName());
aoqi@0:     }
aoqi@0: 
aoqi@0:     /** The source file. Returns null if no file information is
aoqi@0:      *  available. */
aoqi@0:     public FileObject fileObject() {
aoqi@0:         return filename;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /** The line in the source file. The first line is numbered 1;
aoqi@0:      *  0 means no line number information is available. */
aoqi@0:     public int line() {
aoqi@0:         if (lineMap == null) {
aoqi@0:             return 0;
aoqi@0:         } else {
aoqi@0:             return lineMap.getLineNumber(position);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /** The column in the source file. The first column is
aoqi@0:      *  numbered 1; 0 means no column information is available.
aoqi@0:      *  Columns count characters in the input stream; a tab
aoqi@0:      *  advances the column number to the next 8-column tab stop.
aoqi@0:      */
aoqi@0:     public int column() {
aoqi@0:         if (lineMap == null) {
aoqi@0:             return 0;
aoqi@0:         }else {
aoqi@0:             return lineMap.getColumnNumber(position);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     private SourcePositionImpl(FileObject file, int position,
aoqi@0:                                Position.LineMap lineMap) {
aoqi@0:         super();
aoqi@0:         this.filename = file;
aoqi@0:         this.position = position;
aoqi@0:         this.lineMap = lineMap;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public static SourcePosition make(FileObject file, int pos,
aoqi@0:                                       Position.LineMap lineMap) {
aoqi@0:         if (file == null) return null;
aoqi@0:         return new SourcePositionImpl(file, pos, lineMap);
aoqi@0:     }
aoqi@0: 
aoqi@0:     public String toString() {
aoqi@0:         // Backwards compatibility hack. ZipFileObjects use the format
aoqi@0:         // zipfile(zipentry) but javadoc has been using zipfile/zipentry
aoqi@0:         String fn = filename.getName();
aoqi@0:         if (fn.endsWith(")")) {
aoqi@0:             int paren = fn.lastIndexOf("(");
aoqi@0:             if (paren != -1)
aoqi@0:                 fn = fn.substring(0, paren)
aoqi@0:                         + File.separatorChar
aoqi@0:                         + fn.substring(paren + 1, fn.length() - 1);
aoqi@0:         }
aoqi@0: 
aoqi@0:         if (position == Position.NOPOS)
aoqi@0:             return fn;
aoqi@0:         else
aoqi@0:             return fn + ":" + line();
aoqi@0:     }
aoqi@0: }