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