GitSharp/Stubs/RevParseCommand.cs

   1 /*
   2  * Copyright (C) 2010, Dominique van de Vorle <dvdvorle@gmail.com>
   3  *
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or
   7  * without modification, are permitted provided that the following
   8  * conditions are met:
   9  *
  10  * - Redistributions of source code must retain the above copyright
  11  *   notice, this list of conditions and the following disclaimer.
  12  *
  13  * - Redistributions in binary form must reproduce the above
  14  *   copyright notice, this list of conditions and the following
  15  *   disclaimer in the documentation and/or other materials provided
  16  *   with the distribution.
  17  *
  18  * - Neither the name of the Git Development Community nor the
  19  *   names of its contributors may be used to endorse or promote
  20  *   products derived from this software without specific prior
  21  *   written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  24  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  25  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  26  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  28  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  30  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  33  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  35  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 using System;
  39 using System.Collections.Generic;
  40 using System.IO;
  41 using System.Linq;
  42 using System.Text;
  43
  44 namespace GitSharp.Commands
  45 {
  46     public class RevParseCommand
  47         : AbstractCommand
  48     {
  49
  50         public RevParseCommand() {
  51         }
  52
  53         // note: the naming of command parameters is not following .NET conventions in favour of git command line parameter naming conventions.
  54
  55         #region Properties / Options
  56         public List<string> Arguments { get; set; }
  57         /// <summary>
  58         /// Not implemented
  59         ///
  60         /// Use 'git-rev-parse' in option parsing mode (see PARSEOPT section below).
  61         ///
  62         /// </summary>
  63         public bool Parseopt { get; set; }
  64
  65         /// <summary>
  66         /// Not implemented
  67         ///
  68         /// Only meaningful in `--parseopt` mode. Tells the option parser to echo
  69         /// out the first `--` met instead of skipping it.
  70         ///
  71         /// </summary>
  72         public bool KeepDashdash { get; set; }
  73
  74         /// <summary>
  75         /// Not implemented
  76         ///
  77         /// Only meaningful in `--parseopt` mode.  Lets the option parser stop at
  78         /// the first non-option argument.  This can be used to parse sub-commands
  79         /// that take options themself.
  80         ///
  81         /// </summary>
  82         public bool StopAtNonOption { get; set; }
  83
  84         /// <summary>
  85         /// Not implemented
  86         ///
  87         /// Use 'git-rev-parse' in shell quoting mode (see SQ-QUOTE
  88         /// section below). In contrast to the `--sq` option below, this
  89         /// mode does only quoting. Nothing else is done to command input.
  90         ///
  91         /// </summary>
  92         public bool SqQuote { get; set; }
  93
  94         /// <summary>
  95         /// Not implemented
  96         ///
  97         /// Do not output flags and parameters not meant for
  98         /// 'git-rev-list' command.
  99         ///
 100         /// </summary>
 101         public bool RevsOnly { get; set; }
 102
 103         /// <summary>
 104         /// Not implemented
 105         ///
 106         /// Do not output flags and parameters meant for
 107         /// 'git-rev-list' command.
 108         ///
 109         /// </summary>
 110         public bool NoRevs { get; set; }
 111
 112         /// <summary>
 113         /// Not implemented
 114         ///
 115         /// Do not output non-flag parameters.
 116         ///
 117         /// </summary>
 118         public bool Flags { get; set; }
 119
 120         /// <summary>
 121         /// Not implemented
 122         ///
 123         /// Do not output flag parameters.
 124         ///
 125         /// </summary>
 126         public bool NoFlags { get; set; }
 127
 128         /// <summary>
 129         /// Not implemented
 130         ///
 131         /// If there is no parameter given by the user, use `&lt;arg&gt;`
 132         /// instead.
 133         ///
 134         /// </summary>
 135         public string Default { get; set; }
 136
 137         /// <summary>
 138         /// Not implemented
 139         ///
 140         /// The parameter given must be usable as a single, valid
 141         /// object name.  Otherwise barf and abort.
 142         ///
 143         /// </summary>
 144         public bool Verify { get; set; }
 145
 146         /// <summary>
 147         /// Not implemented
 148         ///
 149         /// Only meaningful in `--verify` mode. Do not output an error
 150         /// message if the first argument is not a valid object name;
 151         /// instead exit with non-zero status silently.
 152         ///
 153         /// </summary>
 154         public bool Quiet { get; set; }
 155
 156         /// <summary>
 157         /// Not implemented
 158         ///
 159         /// Usually the output is made one line per flag and
 160         /// parameter.  This option makes output a single line,
 161         /// properly quoted for consumption by shell.  Useful when
 162         /// you expect your parameter to contain whitespaces and
 163         /// newlines (e.g. when using pickaxe `-S` with
 164         /// 'git-diff-\*'). In contrast to the `--sq-quote` option,
 165         /// the command input is still interpreted as usual.
 166         ///
 167         /// </summary>
 168         public bool Sq { get; set; }
 169
 170         /// <summary>
 171         /// Not implemented
 172         ///
 173         /// When showing object names, prefix them with '{caret}' and
 174         /// strip '{caret}' prefix from the object names that already have
 175         /// one.
 176         ///
 177         /// </summary>
 178         public bool Not { get; set; }
 179
 180         /// <summary>
 181         /// Not implemented
 182         ///
 183         /// Usually the object names are output in SHA1 form (with
 184         /// possible '{caret}' prefix); this option makes them output in a
 185         /// form as close to the original input as possible.
 186         ///
 187         /// </summary>
 188         public bool Symbolic { get; set; }
 189
 190         /// <summary>
 191         /// Not implemented
 192         ///
 193         /// This is similar to \--symbolic, but it omits input that
 194         /// are not refs (i.e. branch or tag names; or more
 195         /// explicitly disambiguating "heads/master" form, when you
 196         /// want to name the "master" branch when there is an
 197         /// unfortunately named tag "master"), and show them as full
 198         /// refnames (e.g. "refs/heads/master").
 199         ///
 200         /// </summary>
 201         public bool SymbolicFullName { get; set; }
 202
 203         /// <summary>
 204         /// Not implemented
 205         ///
 206         /// A non-ambiguous short name of the objects name.
 207         /// The option core.warnAmbiguousRefs is used to select the strict
 208         /// abbreviation mode.
 209         ///
 210         /// </summary>
 211         public string AbbrevRef { get; set; }
 212
 213         /// <summary>
 214         /// Not implemented
 215         ///
 216         /// Show all refs found in `$GIT_DIR/refs`.
 217         ///
 218         /// </summary>
 219         public bool All { get; set; }
 220
 221         /// <summary>
 222         /// Not implemented
 223         ///
 224         /// Show branch refs found in `$GIT_DIR/refs/heads`.
 225         ///
 226         /// </summary>
 227         public bool Branches { get; set; }
 228
 229         /// <summary>
 230         /// Not implemented
 231         ///
 232         /// Show tag refs found in `$GIT_DIR/refs/tags`.
 233         ///
 234         /// </summary>
 235         public bool Tags { get; set; }
 236
 237         /// <summary>
 238         /// Not implemented
 239         ///
 240         /// Show tag refs found in `$GIT_DIR/refs/remotes`.
 241         ///
 242         /// </summary>
 243         public bool Remotes { get; set; }
 244
 245         /// <summary>
 246         /// Not implemented
 247         ///
 248         /// When the command is invoked from a subdirectory, show the
 249         /// path of the current directory relative to the top-level
 250         /// directory.
 251         ///
 252         /// </summary>
 253         public bool ShowPrefix { get; set; }
 254
 255         /// <summary>
 256         /// Not implemented
 257         ///
 258         /// When the command is invoked from a subdirectory, show the
 259         /// path of the top-level directory relative to the current
 260         /// directory (typically a sequence of "../", or an empty string).
 261         ///
 262         /// </summary>
 263         public bool ShowCdup { get; set; }
 264
 265         /// <summary>
 266         /// Not implemented
 267         ///
 268         /// Show `$GIT_DIR` if defined else show the path to the .git directory.
 269         ///
 270         /// </summary>
 271         public bool GitDir { get; set; }
 272
 273         /// <summary>
 274         /// Not implemented
 275         ///
 276         /// When the current working directory is below the repository
 277         /// directory print "true", otherwise "false".
 278         ///
 279         /// </summary>
 280         public bool IsInsideGitDir { get; set; }
 281
 282         /// <summary>
 283         /// Not implemented
 284         ///
 285         /// When the current working directory is inside the work tree of the
 286         /// repository print "true", otherwise "false".
 287         ///
 288         /// </summary>
 289         public bool IsInsideWorkTree { get; set; }
 290
 291         /// <summary>
 292         /// Not implemented
 293         ///
 294         /// When the repository is bare print "true", otherwise "false".
 295         ///
 296         /// </summary>
 297         public bool IsBareRepository { get; set; }
 298
 299         ///// <summary>
 300         ///// Not implemented
 301         /////
 302         ///// Instead of outputting the full SHA1 values of object names try to
 303         ///// abbreviate them to a shorter unique name. When no length is specified
 304         ///// 7 is used. The minimum length is 4.
 305         /////
 306         ///// </summary>
 307         //public bool Short { get; set; }
 308
 309         /// <summary>
 310         /// Not implemented
 311         ///
 312         /// Instead of outputting the full SHA1 values of object names try to
 313         /// abbreviate them to a shorter unique name. When no length is specified
 314         /// 7 is used. The minimum length is 4.
 315         ///
 316         /// </summary>
 317         public string Short { get; set; }
 318
 319         /// <summary>
 320         /// Not implemented
 321         ///
 322         /// Parse the date string, and output the corresponding
 323         /// --max-age= parameter for 'git-rev-list'.
 324         ///
 325         /// </summary>
 326         public string Since { get; set; }
 327
 328         /// <summary>
 329         /// Not implemented
 330         ///
 331         /// Parse the date string, and output the corresponding
 332         /// --max-age= parameter for 'git-rev-list'.
 333         ///
 334         /// </summary>
 335         public string After { get; set; }
 336
 337         /// <summary>
 338         /// Not implemented
 339         ///
 340         /// Parse the date string, and output the corresponding
 341         /// --min-age= parameter for 'git-rev-list'.
 342         ///
 343         /// </summary>
 344         public string Until { get; set; }
 345
 346         /// <summary>
 347         /// Not implemented
 348         ///
 349         /// Parse the date string, and output the corresponding
 350         /// --min-age= parameter for 'git-rev-list'.
 351         ///
 352         /// </summary>
 353         public string Before { get; set; }
 354
 355         #endregion
 356
 357         public override void Execute()
 358         {
 359             throw new NotImplementedException();
 360         }
 361     }
 362 }