Cross Reference: /opengrok/src/org/opensolaris/opengrok/history/Annotation.java

87 Knut.Hatlen@Sun.COM * The contents of this file are subject to the terms of the

87 Knut.Hatlen@Sun.COM * Common Development and Distribution License (the "License").

87 Knut.Hatlen@Sun.COM * You may not use this file except in compliance with the License.

87 Knut.Hatlen@Sun.COM * See LICENSE.txt included in this distribution for the specific

87 Knut.Hatlen@Sun.COM * language governing permissions and limitations under the License.

87 Knut.Hatlen@Sun.COM * When distributing Covered Code, include this CDDL HEADER in each

87 Knut.Hatlen@Sun.COM * file and include the License file at LICENSE.txt.

87 Knut.Hatlen@Sun.COM * If applicable, add the following below this CDDL HEADER, with the

87 Knut.Hatlen@Sun.COM * fields enclosed by brackets "[]" replaced with your own identifying

87 Knut.Hatlen@Sun.COM * information: Portions Copyright [yyyy] [name of copyright owner]

87 Knut.Hatlen@Sun.COM * CDDL HEADER END

87 Knut.Hatlen@Sun.COM/*

87 Knut.Hatlen@Sun.COM * Use is subject to license terms.

87 Knut.Hatlen@Sun.COMpackage org.opensolaris.opengrok.history;

878 Lubos.Kosco@Sun.COMimport java.io.IOException;

878 Lubos.Kosco@Sun.COMimport java.io.StringWriter;

878 Lubos.Kosco@Sun.COMimport java.io.Writer;

87 Knut.Hatlen@Sun.COMimport java.util.ArrayList;

878 Lubos.Kosco@Sun.COMimport java.util.HashMap;

879 Lubos.Kosco@Sun.COMimport java.util.HashSet;

878 Lubos.Kosco@Sun.COMimport java.util.Iterator;

457 jorgen.austvik@sun.comimport java.util.List;

879 Lubos.Kosco@Sun.COMimport java.util.Map;

879 Lubos.Kosco@Sun.COMimport java.util.Map.Entry;

879 Lubos.Kosco@Sun.COMimport java.util.Set;

879 Lubos.Kosco@Sun.COMimport java.util.logging.Logger;

878 Lubos.Kosco@Sun.COMimport org.opensolaris.opengrok.web.Util;

87 Knut.Hatlen@Sun.COM/**

87 Knut.Hatlen@Sun.COM * Class representing file annotation, i.e., revision and author for the last

87 Knut.Hatlen@Sun.COM * modification of each line in the file.

87 Knut.Hatlen@Sun.COMpublic class Annotation {

1190 trond.norbye@gmail.com

457 jorgen.austvik@sun.com private final List<Line> lines = new ArrayList<Line>();

879 Lubos.Kosco@Sun.COM private final Map<String, String> desc = new HashMap<String, String>();

87 Knut.Hatlen@Sun.COM private int widestRevision;

87 Knut.Hatlen@Sun.COM private int widestAuthor;

456 jorgen.austvik@sun.com private final String filename;

879 Lubos.Kosco@Sun.COM static final Logger log = Logger.getLogger(Annotation.class.getName());

140 trond.norbye@sun.com public Annotation(String filename) {

140 trond.norbye@sun.com this.filename = filename;

140 trond.norbye@sun.com }

1190 trond.norbye@gmail.com

87 Knut.Hatlen@Sun.COM * Gets the revision for the last change to the specified line.

87 Knut.Hatlen@Sun.COM * @param line line number (counting from 1)

91 Knut.Hatlen@Sun.COM * @return revision string, or an empty string if there is no information

91 Knut.Hatlen@Sun.COM * about the specified line

87 Knut.Hatlen@Sun.COM public String getRevision(int line) {

91 Knut.Hatlen@Sun.COM try {

91 Knut.Hatlen@Sun.COM return lines.get(line-1).revision;

91 Knut.Hatlen@Sun.COM } catch (IndexOutOfBoundsException e) {

91 Knut.Hatlen@Sun.COM return "";

91 Knut.Hatlen@Sun.COM }

878 Lubos.Kosco@Sun.COM * Gets all revisions that are in use, first is the lowest one (sorted using natural order)

1190 trond.norbye@gmail.com *

878 Lubos.Kosco@Sun.COM * @return list of all revisions the file has

878 Lubos.Kosco@Sun.COM */

879 Lubos.Kosco@Sun.COM public Set<String> getRevisions() {

879 Lubos.Kosco@Sun.COM Set<String> ret=new HashSet<String>();

878 Lubos.Kosco@Sun.COM for (Iterator<Line> it = this.lines.iterator(); it.hasNext();) {

878 Lubos.Kosco@Sun.COM Line ln = it.next();

1190 trond.norbye@gmail.com ret.add(ln.revision);

1190 trond.norbye@gmail.com }

878 Lubos.Kosco@Sun.COM return ret;

878 Lubos.Kosco@Sun.COM /**

87 Knut.Hatlen@Sun.COM * Gets the author who last modified the specified line.

87 Knut.Hatlen@Sun.COM * @param line line number (counting from 1)

91 Knut.Hatlen@Sun.COM * @return author, or an empty string if there is no information about the

91 Knut.Hatlen@Sun.COM * specified line

87 Knut.Hatlen@Sun.COM public String getAuthor(int line) {

91 Knut.Hatlen@Sun.COM try {

91 Knut.Hatlen@Sun.COM return lines.get(line-1).author;

91 Knut.Hatlen@Sun.COM } catch (IndexOutOfBoundsException e) {

91 Knut.Hatlen@Sun.COM return "";

91 Knut.Hatlen@Sun.COM }

168 ldavis@fonix.com * Gets the enabled state for the last change to the specified line.

168 ldavis@fonix.com *

168 ldavis@fonix.com * @param line line number (counting from 1)

168 ldavis@fonix.com * @return true if the xref for this revision is enabled, false otherwise

168 ldavis@fonix.com */

168 ldavis@fonix.com public boolean isEnabled(int line) {

168 ldavis@fonix.com try {

168 ldavis@fonix.com return lines.get(line-1).enabled;

168 ldavis@fonix.com } catch (IndexOutOfBoundsException e) {

168 ldavis@fonix.com return false;

168 ldavis@fonix.com }

168 ldavis@fonix.com

168 ldavis@fonix.com /**

87 Knut.Hatlen@Sun.COM * Returns the size of the file (number of lines).

87 Knut.Hatlen@Sun.COM * @return number of lines

87 Knut.Hatlen@Sun.COM public int size() {

87 Knut.Hatlen@Sun.COM return lines.size();

87 Knut.Hatlen@Sun.COM * Returns the widest revision string in the file (used for pretty

87 Knut.Hatlen@Sun.COM * printing).

87 Knut.Hatlen@Sun.COM * @return number of characters in the widest revision string

87 Knut.Hatlen@Sun.COM public int getWidestRevision() {

87 Knut.Hatlen@Sun.COM return widestRevision;

87 Knut.Hatlen@Sun.COM * Returns the widest author name in the file (used for pretty printing).

87 Knut.Hatlen@Sun.COM * @return number of characters in the widest author string

87 Knut.Hatlen@Sun.COM public int getWidestAuthor() {

87 Knut.Hatlen@Sun.COM return widestAuthor;

87 Knut.Hatlen@Sun.COM * Adds a line to the file.

87 Knut.Hatlen@Sun.COM * @param revision revision number

87 Knut.Hatlen@Sun.COM * @param author author name

168 ldavis@fonix.com void addLine(String revision, String author, boolean enabled) {

168 ldavis@fonix.com final Line line = new Line(revision, author, enabled);

117 ldavis@fonix.com lines.add(line);

117 ldavis@fonix.com widestRevision = Math.max(widestRevision, line.revision.length());

117 ldavis@fonix.com widestAuthor = Math.max(widestAuthor, line.author.length());

1190 trond.norbye@gmail.com void addDesc(String revision, String description) {

878 Lubos.Kosco@Sun.COM desc.put(revision, Util.encode(description));

1190 trond.norbye@gmail.com public String getDesc(String revision) {

878 Lubos.Kosco@Sun.COM return desc.get(revision);

87 Knut.Hatlen@Sun.COM /** Class representing one line in the file. */

87 Knut.Hatlen@Sun.COM private static class Line {

87 Knut.Hatlen@Sun.COM final String revision;

87 Knut.Hatlen@Sun.COM final String author;

168 ldavis@fonix.com final boolean enabled;

168 ldavis@fonix.com Line(String rev, String aut, boolean ena) {

117 ldavis@fonix.com revision = (rev == null) ? "" : rev;

117 ldavis@fonix.com author = (aut == null) ? "" : aut;

168 ldavis@fonix.com enabled = ena;

87 Knut.Hatlen@Sun.COM }

140 trond.norbye@sun.com

140 trond.norbye@sun.com public String getFilename() {

140 trond.norbye@sun.com return filename;

140 trond.norbye@sun.com }

878 Lubos.Kosco@Sun.COM //TODO below might be useless, need to test with more SCMs and different commit messages

878 Lubos.Kosco@Sun.COM // to see if it will not be usefull, if title attribute of <a> loses it's breath

878 Lubos.Kosco@Sun.COM public void writeTooltipMap(Writer out) throws IOException {

1227 trond.norbye@gmail.com out.append("<script type=\"text/javascript\">\nvar desc = new Object();\n");

878 Lubos.Kosco@Sun.COM for (Entry<String, String> entry : desc.entrySet()) {

1227 trond.norbye@gmail.com out.append("desc['");

1227 trond.norbye@gmail.com out.append(entry.getKey());

1227 trond.norbye@gmail.com out.append("'] = \"");

1227 trond.norbye@gmail.com out.append(entry.getValue());

1227 trond.norbye@gmail.com out.append("\";\n");

878 Lubos.Kosco@Sun.COM }

1227 trond.norbye@gmail.com out.append("</script>\n");

1227 trond.norbye@gmail.com

878 Lubos.Kosco@Sun.COM @Override

878 Lubos.Kosco@Sun.COM public String toString() {

1227 trond.norbye@gmail.com StringWriter sw = new StringWriter();

972 Knut.Hatlen@Sun.COM for (Line line : lines) {

1227 trond.norbye@gmail.com sw.append(line.revision);

1227 trond.norbye@gmail.com sw.append("|");

1227 trond.norbye@gmail.com sw.append(line.author);

1227 trond.norbye@gmail.com sw.append(": \n");

972 Knut.Hatlen@Sun.COM }

972 Knut.Hatlen@Sun.COM try {

972 Knut.Hatlen@Sun.COM writeTooltipMap(sw);

972 Knut.Hatlen@Sun.COM } catch (IOException e) {

972 Knut.Hatlen@Sun.COM log.finest(e.getMessage());

972 Knut.Hatlen@Sun.COM }