org.eclipse.egit.ui/src/org/eclipse/egit/ui/internal/components/RefContentProposal.java

   1 /*******************************************************************************
   2  * Copyright (C) 2008, Marek Zawirski <marek.zawirski@gmail.com>
   3  *
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *******************************************************************************/
   9 package org.eclipse.egit.ui.internal.components;
  10
  11 import java.io.IOException;
  12 import java.sql.Blob;
  13
  14 import org.eclipse.egit.ui.Activator;
  15 import org.eclipse.egit.ui.UIText;
  16 import org.eclipse.jface.fieldassist.IContentProposal;
  17 import org.eclipse.jgit.lib.Commit;
  18 import org.eclipse.jgit.lib.Constants;
  19 import org.eclipse.jgit.lib.ObjectId;
  20 import org.eclipse.jgit.lib.PersonIdent;
  21 import org.eclipse.jgit.lib.Ref;
  22 import org.eclipse.jgit.lib.Repository;
  23 import org.eclipse.jgit.lib.Tag;
  24 import org.eclipse.jgit.lib.Tree;
  25 import org.eclipse.osgi.util.NLS;
  26
  27 /**
  28  * Content proposal class for refs names, specifically Ref objects - name with
  29  * optionally associated object id. This class can be used for Eclipse field
  30  * assist as content proposal.
  31  * <p>
  32  * Content of this proposal is simply a ref name, but description and labels
  33  * tries to be smarter - showing easier to read label for user (stripping
  34  * prefixes) and information about pointed object if it exists locally.
  35  */
  36 public class RefContentProposal implements IContentProposal {
  37         private static final String PREFIXES[] = new String[] { Constants.R_HEADS,
  38                         Constants.R_REMOTES, Constants.R_TAGS };
  39
  40         private final static String branchPF = " ["   //$NON-NLS-1$
  41                 + UIText.RefContentProposal_branch
  42                 + "]";  //$NON-NLS-1$
  43
  44         private final static String trackingBranchPF = " ["  //$NON-NLS-1$
  45                 + UIText.RefContentProposal_trackingBranch
  46                 + "]";  //$NON-NLS-1$
  47
  48         private final static String tagPF = " ["  //$NON-NLS-1$
  49                 + UIText.RefContentProposal_tag
  50                 + "]"; //$NON-NLS-1$
  51
  52         private static final String PREFIXES_DESCRIPTIONS[] = new String[] {
  53                         branchPF, trackingBranchPF, tagPF };
  54
  55         private static void appendObjectSummary(final StringBuilder sb,
  56                         final String type, final PersonIdent author, final String message) {
  57                 sb.append(type);
  58                 sb.append(" "); //$NON-NLS-1$
  59                 sb.append(UIText.RefContentProposal_by);
  60                 sb.append(" "); //$NON-NLS-1$
  61                 sb.append(author.getName());
  62                 sb.append("\n");  //$NON-NLS-1$
  63                 sb.append(author.getWhen());
  64                 sb.append("\n\n");  //$NON-NLS-1$
  65                 final int newLine = message.indexOf('\n');
  66                 final int last = (newLine != -1 ? newLine : message.length());
  67                 sb.append(message.substring(0, last));
  68         }
  69
  70         private final Repository db;
  71
  72         private final String refName;
  73
  74         private final ObjectId objectId;
  75
  76         /**
  77          * Create content proposal for specified ref.
  78          *
  79          * @param repo
  80          *            repository for accessing information about objects. Could be a
  81          *            local repository even for remote objects.
  82          * @param ref
  83          *            ref being a content proposal. May have null or locally
  84          *            non-existent object id.
  85          */
  86         public RefContentProposal(final Repository repo, final Ref ref) {
  87                 this(repo, ref.getName(), ref.getObjectId());
  88         }
  89
  90         /**
  91          * Create content proposal for specified ref name and object id.
  92          *
  93          * @param repo
  94          *            repository for accessing information about objects. Could be a
  95          *            local repository even for remote objects.
  96          * @param refName
  97          *            ref name being a content proposal.
  98          * @param objectId
  99          *            object being pointed by this ref name. May be null or locally
 100          *            non-existent object.
 101          */
 102         public RefContentProposal(final Repository repo, final String refName,
 103                         final ObjectId objectId) {
 104                 this.db = repo;
 105                 this.refName = refName;
 106                 this.objectId = objectId;
 107         }
 108
 109         public String getContent() {
 110                 return refName;
 111         }
 112
 113         public int getCursorPosition() {
 114                 return refName.length();
 115         }
 116
 117         public String getDescription() {
 118                 if (objectId == null)
 119                         return null;
 120                 final Object obj;
 121                 try {
 122                         obj = db.mapObject(objectId, refName);
 123                 } catch (IOException e) {
 124                         Activator.logError(NLS.bind(
 125                                         UIText.RefContentProposal_errorReadingObject, objectId), e);
 126                         return null;
 127                 }
 128
 129                 final StringBuilder sb = new StringBuilder();
 130                 sb.append(refName);
 131                 sb.append('\n');
 132                 sb.append(objectId.abbreviate(db).name());
 133                 sb.append(" - "); //$NON-NLS-1$
 134                 if (obj instanceof Commit) {
 135                         final Commit c = ((Commit) obj);
 136                         appendObjectSummary(sb, UIText.RefContentProposal_commit, c
 137                                         .getAuthor(), c.getMessage());
 138                 } else if (obj instanceof Tag) {
 139                         final Tag t = ((Tag) obj);
 140                         appendObjectSummary(sb, UIText.RefContentProposal_tag, t
 141                                         .getAuthor(), t.getMessage());
 142                 } else if (obj instanceof Tree) {
 143                         sb.append(UIText.RefContentProposal_tree);
 144                 } else if (obj instanceof Blob) {
 145                         sb.append(UIText.RefContentProposal_blob);
 146                 } else
 147                         sb.append(UIText.RefContentProposal_unknownObject);
 148                 return sb.toString();
 149         }
 150
 151         public String getLabel() {
 152                 for (int i = 0; i < PREFIXES.length; i++)
 153                         if (refName.startsWith(PREFIXES[i]))
 154                                 return refName.substring(PREFIXES[i].length())
 155                                                 + PREFIXES_DESCRIPTIONS[i];
 156                 return refName;
 157
 158         }
 159 }