CommandLineMergeTool.java

  1. /*
  2.  * Copyright (C) 2018-2022, Andre Bossert <andre.bossert@siemens.com>
  3.  *
  4.  * This program and the accompanying materials are made available under the
  5.  * terms of the Eclipse Distribution License v. 1.0 which is available at
  6.  * https://www.eclipse.org/org/documents/edl-v10.php.
  7.  *
  8.  * SPDX-License-Identifier: BSD-3-Clause
  9.  */

  11. package org.eclipse.jgit.internal.diffmergetool;

  13. /**
  14.  * Pre-defined merge tools.
  15.  *
  16.  * Adds same merge tools as also pre-defined in C-Git see "git-core\mergetools\"
  17.  * see links to command line parameter description for the tools
  18.  *
  19.  * <pre>
  20.  * araxis
  21.  * bc
  22.  * bc3
  23.  * codecompare
  24.  * deltawalker
  25.  * diffmerge
  26.  * diffuse
  27.  * ecmerge
  28.  * emerge
  29.  * examdiff
  30.  * guiffy
  31.  * gvimdiff
  32.  * gvimdiff2
  33.  * gvimdiff3
  34.  * kdiff3
  35.  * kompare
  36.  * meld
  37.  * opendiff
  38.  * p4merge
  39.  * tkdiff
  40.  * tortoisemerge
  41.  * vimdiff
  42.  * vimdiff2
  43.  * vimdiff3
  44.  * winmerge
  45.  * xxdiff
  46.  * </pre>
  47.  *
  48.  */
  49. @SuppressWarnings("nls")
  50. public enum CommandLineMergeTool {
  51.     /**
  52.      * See: <a href=
  53.      * "https://www.araxis.com/merge/documentation-windows/command-line.en">https://www.araxis.com/merge/documentation-windows/command-line.en</a>
  54.      */
  55.     araxis("compare",
  56.             "-wait -merge -3 -a1 \"$BASE\" \"$LOCAL\" \"$REMOTE\" \"$MERGED\"",
  57.             "-wait -2 \"$LOCAL\" \"$REMOTE\" \"$MERGED\"",
  58.             false),
  59.     /**
  60.      * See: <a href=
  61.      * "https://www.scootersoftware.com/v4help/index.html?command_line_reference.html">https://www.scootersoftware.com/v4help/index.html?command_line_reference.html</a>
  62.      */
  63.     bc("bcomp", "\"$LOCAL\" \"$REMOTE\" \"$BASE\" --mergeoutput=\"$MERGED\"",
  64.             "\"$LOCAL\" \"$REMOTE\" --mergeoutput=\"$MERGED\"",
  65.             false),
  66.     /**
  67.      * See: <a href=
  68.      * "https://www.scootersoftware.com/v4help/index.html?command_line_reference.html">https://www.scootersoftware.com/v4help/index.html?command_line_reference.html</a>
  69.      */
  70.     bc3("bcompare", bc),
  71.     /**
  72.      * See: <a href=
  73.      * "https://www.devart.com/codecompare/docs/index.html?merging_via_command_line.htm">https://www.devart.com/codecompare/docs/index.html?merging_via_command_line.htm</a>
  74.      */
  75.     codecompare("CodeMerge",
  76.             "-MF=\"$LOCAL\" -TF=\"$REMOTE\" -BF=\"$BASE\" -RF=\"$MERGED\"",
  77.             "-MF=\"$LOCAL\" -TF=\"$REMOTE\" -RF=\"$MERGED\"",
  78.             false),
  79.     /**
  80.      * See: <a href=
  81.      * "https://www.deltawalker.com/integrate/command-line">https://www.deltawalker.com/integrate/command-line</a>
  82.      * <p>
  83.      * Hint: $(pwd) command must be defined
  84.      * </p>
  85.      */
  86.     deltawalker("DeltaWalker",
  87.             "\"$LOCAL\" \"$REMOTE\" \"$BASE\" -pwd=\"$(pwd)\" -merged=\"$MERGED\"",
  88.             "\"$LOCAL\" \"$REMOTE\" -pwd=\"$(pwd)\" -merged=\"$MERGED\"",
  89.             true),
  90.     /**
  91.      * See: <a href=
  92.      * "https://sourcegear.com/diffmerge/webhelp/sec__clargs__diff.html">https://sourcegear.com/diffmerge/webhelp/sec__clargs__diff.html</a>
  93.      */
  94.     diffmerge("diffmerge", //$NON-NLS-1$
  95.             "--merge --result=\"$MERGED\" \"$LOCAL\" \"$BASE\" \"$REMOTE\"",
  96.             "--merge --result=\"$MERGED\" \"$LOCAL\" \"$REMOTE\"",
  97.             true),
  98.     /**
  99.      * See: <a href=
  100.      * "http://diffuse.sourceforge.net/manual.html#introduction-usage">http://diffuse.sourceforge.net/manual.html#introduction-usage</a>
  101.      * <p>
  102.      * Hint: check the ' | cat' for the call
  103.      * </p>
  104.      */
  105.     diffuse("diffuse", "\"$LOCAL\" \"$MERGED\" \"$REMOTE\" \"$BASE\"",
  106.             "\"$LOCAL\" \"$MERGED\" \"$REMOTE\"", false),
  107.     /**
  108.      * See: <a href=
  109.      * "http://www.elliecomputing.com/en/OnlineDoc/ecmerge_en/44205167.asp">http://www.elliecomputing.com/en/OnlineDoc/ecmerge_en/44205167.asp</a>
  110.      */
  111.     ecmerge("ecmerge",
  112.             "--default --mode=merge3 \"$BASE\" \"$LOCAL\" \"$REMOTE\" --to=\"$MERGED\"",
  113.             "--default --mode=merge2 \"$LOCAL\" \"$REMOTE\" --to=\"$MERGED\"",
  114.             false),
  115.     /**
  116.      * See: <a href=
  117.      * "https://www.gnu.org/software/emacs/manual/html_node/emacs/Overview-of-Emerge.html">https://www.gnu.org/software/emacs/manual/html_node/emacs/Overview-of-Emerge.html</a>
  118.      * <p>
  119.      * Hint: $(basename) command must be defined
  120.      * </p>
  121.      */
  122.     emerge("emacs",
  123.             "-f emerge-files-with-ancestor-command \"$LOCAL\" \"$REMOTE\" \"$BASE\" \"$(basename \"$MERGED\")\"",
  124.             "-f emerge-files-command \"$LOCAL\" \"$REMOTE\" \"$(basename \"$MERGED\")\"",
  125.             true),
  126.     /**
  127.      * See: <a href=
  128.      * "https://www.prestosoft.com/ps.asp?page=htmlhelp/edp/command_line_options">https://www.prestosoft.com/ps.asp?page=htmlhelp/edp/command_line_options</a>
  129.      */
  130.     examdiff("ExamDiff",
  131.             "-merge \"$LOCAL\" \"$BASE\" \"$REMOTE\" -o:\"$MERGED\" -nh",
  132.             "-merge \"$LOCAL\" \"$REMOTE\" -o:\"$MERGED\" -nh",
  133.             false),
  134.     /**
  135.      * See: <a href=
  136.      * "https://www.guiffy.com/help/GuiffyHelp/GuiffyCmd.html">https://www.guiffy.com/help/GuiffyHelp/GuiffyCmd.html</a>
  137.      */
  138.     guiffy("guiffy", "-s \"$LOCAL\" \"$REMOTE\" \"$BASE\" \"$MERGED\"",
  139.             "-m \"$LOCAL\" \"$REMOTE\" \"$MERGED\"", true),
  140.     /**
  141.      * See: <a href=
  142.      * "http://vimdoc.sourceforge.net/htmldoc/diff.html">http://vimdoc.sourceforge.net/htmldoc/diff.html</a>
  143.      */
  144.     gvimdiff("gvim",
  145.             "-f -d -c '4wincmd w | wincmd J' \"$LOCAL\" \"$BASE\" \"$REMOTE\" \"$MERGED\"",
  146.             "-f -d -c 'wincmd l' \"$LOCAL\" \"$MERGED\" \"$REMOTE\"",
  147.             true),
  148.     /**
  149.      * See: <a href=
  150.      * "http://vimdoc.sourceforge.net/htmldoc/diff.html">http://vimdoc.sourceforge.net/htmldoc/diff.html</a>
  151.      */
  152.     gvimdiff2("gvim", "-f -d -c 'wincmd l' \"$LOCAL\" \"$MERGED\" \"$REMOTE\"",
  153.             "-f -d -c 'wincmd l' \"$LOCAL\" \"$MERGED\" \"$REMOTE\"", true),
  154.     /**
  155.      * See: <a href= "http://vimdoc.sourceforge.net/htmldoc/diff.html"></a>
  156.      */
  157.     gvimdiff3("gvim",
  158.             "-f -d -c 'hid | hid | hid' \"$LOCAL\" \"$REMOTE\" \"$BASE\" \"$MERGED\"",
  159.             "-f -d -c 'hid | hid' \"$LOCAL\" \"$REMOTE\" \"$MERGED\"", true),
  160.     /**
  161.      * See: <a href=
  162.      * "http://kdiff3.sourceforge.net/doc/documentation.html">http://kdiff3.sourceforge.net/doc/documentation.html</a>
  163.      */
  164.     kdiff3("kdiff3",
  165.             "--auto --L1 \"$MERGED (Base)\" --L2 \"$MERGED (Local)\" --L3 \"$MERGED (Remote)\" -o \"$MERGED\" \"$BASE\" \"$LOCAL\" \"$REMOTE\"",
  166.             "--auto --L1 \"$MERGED (Local)\" --L2 \"$MERGED (Remote)\" -o \"$MERGED\" \"$LOCAL\" \"$REMOTE\"",
  167.             true),
  168.     /**
  169.      * See: <a href=
  170.      * "http://meldmerge.org/help/file-mode.html">http://meldmerge.org/help/file-mode.html</a>
  171.      * <p>
  172.      * Hint: use meld with output option only (new versions)
  173.      * </p>
  174.      */
  175.     meld("meld", "--output=\"$MERGED\" \"$LOCAL\" \"$BASE\" \"$REMOTE\"",
  176.             "\"$LOCAL\" \"$MERGED\" \"$REMOTE\"",
  177.             false),
  178.     /**
  179.      * See: <a href=
  180.      * "http://www.manpagez.com/man/1/opendiff/">http://www.manpagez.com/man/1/opendiff/</a>
  181.      * <p>
  182.      * Hint: check the ' | cat' for the call
  183.      * </p>
  184.      */
  185.     opendiff("opendiff",
  186.             "\"$LOCAL\" \"$REMOTE\" -ancestor \"$BASE\" -merge \"$MERGED\"",
  187.             "\"$LOCAL\" \"$REMOTE\" -merge \"$MERGED\"",
  188.             false),
  189.     /**
  190.      * See: <a href=
  191.      * "https://www.perforce.com/manuals/v15.1/cmdref/p4_merge.html">https://www.perforce.com/manuals/v15.1/cmdref/p4_merge.html</a>
  192.      * <p>
  193.      * Hint: check how to fix "no base present" / create_virtual_base problem
  194.      * </p>
  195.      */
  196.     p4merge("p4merge", "\"$BASE\" \"$REMOTE\" \"$LOCAL\" \"$MERGED\"",
  197.             "\"$REMOTE\" \"$LOCAL\" \"$MERGED\"", false),
  198.     /**
  199.      * See: <a href=
  200.      * "http://linux.math.tifr.res.in/manuals/man/tkdiff.html">http://linux.math.tifr.res.in/manuals/man/tkdiff.html</a>
  201.      */
  202.     tkdiff("tkdiff", "-a \"$BASE\" -o \"$MERGED\" \"$LOCAL\" \"$REMOTE\"",
  203.             "-o \"$MERGED\" \"$LOCAL\" \"$REMOTE\"",
  204.             true),
  205.     /**
  206.      * See: <a href=
  207.      * "https://tortoisegit.org/docs/tortoisegitmerge/tme-automation.html#tme-automation-basics">https://tortoisegit.org/docs/tortoisegitmerge/tme-automation.html#tme-automation-basics</a>
  208.      * <p>
  209.      * Hint: merge without base is not supported
  210.      * </p>
  211.      * <p>
  212.      * Hint: cannot diff
  213.      * </p>
  214.      */
  215.     tortoisegitmerge("tortoisegitmerge",
  216.             "-base \"$BASE\" -mine \"$LOCAL\" -theirs \"$REMOTE\" -merged \"$MERGED\"",
  217.             null, false),
  218.     /**
  219.      * See: <a href=
  220.      * "https://tortoisegit.org/docs/tortoisegitmerge/tme-automation.html#tme-automation-basics">https://tortoisegit.org/docs/tortoisegitmerge/tme-automation.html#tme-automation-basics</a>
  221.      * <p>
  222.      * Hint: merge without base is not supported
  223.      * </p>
  224.      * <p>
  225.      * Hint: cannot diff
  226.      * </p>
  227.      */
  228.     tortoisemerge("tortoisemerge",
  229.             "-base:\"$BASE\" -mine:\"$LOCAL\" -theirs:\"$REMOTE\" -merged:\"$MERGED\"",
  230.             null, false),
  231.     /**
  232.      * See: <a href=
  233.      * "http://vimdoc.sourceforge.net/htmldoc/diff.html">http://vimdoc.sourceforge.net/htmldoc/diff.html</a>
  234.      */
  235.     vimdiff("vim", gvimdiff),
  236.     /**
  237.      * See: <a href=
  238.      * "http://vimdoc.sourceforge.net/htmldoc/diff.html">http://vimdoc.sourceforge.net/htmldoc/diff.html</a>
  239.      */
  240.     vimdiff2("vim", gvimdiff2),
  241.     /**
  242.      * See: <a href=
  243.      * "http://vimdoc.sourceforge.net/htmldoc/diff.html">http://vimdoc.sourceforge.net/htmldoc/diff.html</a>
  244.      */
  245.     vimdiff3("vim", gvimdiff3),
  246.     /**
  247.      * See: <a href=
  248.      * "http://manual.winmerge.org/Command_line.html">http://manual.winmerge.org/Command_line.html</a>
  249.      * <p>
  250.      * Hint: check how 'mergetool_find_win32_cmd "WinMergeU.exe" "WinMerge"'
  251.      * works
  252.      * </p>
  253.      */
  254.     winmerge("WinMergeU",
  255.             "-u -e -dl Local -dr Remote \"$LOCAL\" \"$REMOTE\" \"$MERGED\"",
  256.             "-u -e -dl Local -dr Remote \"$LOCAL\" \"$REMOTE\" \"$MERGED\"",
  257.             false),
  258.     /**
  259.      * See: <a href=
  260.      * "http://furius.ca/xxdiff/doc/xxdiff-doc.html">http://furius.ca/xxdiff/doc/xxdiff-doc.html</a>
  261.      */
  262.     xxdiff("xxdiff",
  263.             "-X --show-merged-pane -R 'Accel.SaveAsMerged: \"Ctrl+S\"' -R 'Accel.Search: \"Ctrl+F\"' -R 'Accel.SearchForward: \"Ctrl+G\"' --merged-file \"$MERGED\" \"$LOCAL\" \"$BASE\" \"$REMOTE\"",
  264.             "-X -R 'Accel.SaveAsMerged: \"Ctrl+S\"' -R 'Accel.Search: \"Ctrl+F\"' -R 'Accel.SearchForward: \"Ctrl+G\"' --merged-file \"$MERGED\" \"$LOCAL\" \"$REMOTE\"",
  265.             false);

  267.     CommandLineMergeTool(String path, String parametersWithBase,
  268.             String parametersWithoutBase,
  269.             boolean exitCodeTrustable) {
  270.         this.path = path;
  271.         this.parametersWithBase = parametersWithBase;
  272.         this.parametersWithoutBase = parametersWithoutBase;
  273.         this.exitCodeTrustable = exitCodeTrustable;
  274.     }

  276.     CommandLineMergeTool(CommandLineMergeTool from) {
  277.         this(from.getPath(), from.getParameters(true),
  278.                 from.getParameters(false), from.isExitCodeTrustable());
  279.     }

  281.     CommandLineMergeTool(String path, CommandLineMergeTool from) {
  282.         this(path, from.getParameters(true), from.getParameters(false),
  283.                 from.isExitCodeTrustable());
  284.     }

  286.     private final String path;

  288.     private final String parametersWithBase;

  290.     private final String parametersWithoutBase;

  292.     private final boolean exitCodeTrustable;

  294.     /**
  295.      * @return path
  296.      */
  297.     public String getPath() {
  298.         return path;
  299.     }

  301.     /**
  302.      * @param withBase
  303.      *            return parameters with base present?
  304.      * @return parameters with or without base present
  305.      */
  306.     public String getParameters(boolean withBase) {
  307.         if (withBase) {
  308.             return parametersWithBase;
  309.         }
  310.         return parametersWithoutBase;
  311.     }

  313.     /**
  314.      * @return parameters
  315.      */
  316.     public boolean isExitCodeTrustable() {
  317.         return exitCodeTrustable;
  318.     }

  320.     /**
  321.      * @return true if command with base present is valid, false otherwise
  322.      */
  323.     public boolean canMergeWithoutBasePresent() {
  324.         return parametersWithoutBase != null;
  325.     }

  327. }
Created with JaCoCo 0.8.7.202105040129