<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>src/Darcs/Commands/Check.lhs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
% Copyright (C) 2002-2005 David Roundy
%
% This program is free software; you can redistribute it and/or modify
% it under the terms of the GNU General Public License as published by
% the Free Software Foundation; either version 2, or (at your option)
% any later version.
%
% This program is distributed in the hope that it will be useful,
% but WITHOUT ANY WARRANTY; without even the implied warranty of
% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
% GNU General Public License for more details.
%
% You should have received a copy of the GNU General Public License
% along with this program; see the file COPYING. If not, write to
% the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
% Boston, MA 02110-1301, USA.
\darcsCommand{check}
\begin{code}
<pre><a name="line-1"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>Commands</span><span class='hs-varop'>.</span><span class='hs-conid'>Check</span> <span class='hs-layout'>(</span> <span class='hs-varid'>check</span> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-2"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span> <span class='hs-layout'>(</span> <span class='hs-varid'>when</span> <span class='hs-layout'>)</span>
<a name="line-3"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Applicative</span><span class='hs-layout'>(</span> <span class='hs-layout'>(</span><span class='hs-varop'><$></span><span class='hs-layout'>)</span> <span class='hs-layout'>)</span>
<a name="line-4"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Exit</span> <span class='hs-layout'>(</span> <span class='hs-conid'>ExitCode</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>exitWith</span> <span class='hs-layout'>)</span>
<a name="line-5"></a>
<a name="line-6"></a>
<a name="line-7"></a>
<a name="line-8"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>Commands</span> <span class='hs-layout'>(</span> <span class='hs-conid'>DarcsCommand</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>nodefaults</span><span class='hs-layout'>,</span> <span class='hs-varid'>putInfo</span> <span class='hs-layout'>)</span>
<a name="line-9"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>Arguments</span> <span class='hs-layout'>(</span> <span class='hs-conid'>DarcsFlag</span><span class='hs-layout'>(</span><span class='hs-conid'>Quiet</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-10"></a> <span class='hs-varid'>partialCheck</span><span class='hs-layout'>,</span> <span class='hs-varid'>notest</span><span class='hs-layout'>,</span> <span class='hs-varid'>testByDefault</span><span class='hs-layout'>,</span>
<a name="line-11"></a> <span class='hs-varid'>leaveTestDir</span><span class='hs-layout'>,</span> <span class='hs-varid'>workingRepoDir</span><span class='hs-layout'>,</span> <span class='hs-varid'>ignoretimes</span>
<a name="line-12"></a> <span class='hs-layout'>)</span>
<a name="line-13"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>Flags</span><span class='hs-layout'>(</span><span class='hs-varid'>willIgnoreTimes</span><span class='hs-layout'>)</span>
<a name="line-14"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>Repository</span><span class='hs-varop'>.</span><span class='hs-conid'>Repair</span><span class='hs-layout'>(</span> <span class='hs-varid'>replayRepository</span><span class='hs-layout'>,</span> <span class='hs-varid'>checkIndex</span>
<a name="line-15"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>RepositoryConsistency</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span> <span class='hs-layout'>)</span>
<a name="line-16"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>Repository</span> <span class='hs-layout'>(</span> <span class='hs-conid'>Repository</span><span class='hs-layout'>,</span> <span class='hs-varid'>amInRepository</span><span class='hs-layout'>,</span> <span class='hs-varid'>withRepository</span><span class='hs-layout'>,</span>
<a name="line-17"></a> <span class='hs-varid'>testRecorded</span><span class='hs-layout'>,</span> <span class='hs-varid'>readRecorded</span> <span class='hs-layout'>)</span>
<a name="line-18"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>Patch</span> <span class='hs-layout'>(</span> <span class='hs-conid'>RepoPatch</span><span class='hs-layout'>,</span> <span class='hs-varid'>showPatch</span> <span class='hs-layout'>)</span>
<a name="line-19"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>Witnesses</span><span class='hs-varop'>.</span><span class='hs-conid'>Ordered</span> <span class='hs-layout'>(</span> <span class='hs-conid'>FL</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span> <span class='hs-layout'>)</span>
<a name="line-20"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>Repository</span><span class='hs-varop'>.</span><span class='hs-conid'>Prefs</span> <span class='hs-layout'>(</span> <span class='hs-varid'>filetypeFunction</span> <span class='hs-layout'>)</span>
<a name="line-21"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>Diff</span><span class='hs-layout'>(</span> <span class='hs-varid'>treeDiff</span> <span class='hs-layout'>)</span>
<a name="line-22"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Printer</span> <span class='hs-layout'>(</span> <span class='hs-varid'>text</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varop'>$$</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varop'><+></span><span class='hs-layout'>)</span> <span class='hs-layout'>)</span>
<a name="line-23"></a>
<a name="line-24"></a>
<a name="line-25"></a><a name="checkDescription"></a><span class='hs-definition'>checkDescription</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span>
<a name="line-26"></a><span class='hs-definition'>checkDescription</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"Check the repository for consistency."</span>
<a name="line-27"></a>
<a name="line-28"></a><a name="checkHelp"></a><span class='hs-definition'>checkHelp</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span>
<a name="line-29"></a><span class='hs-definition'>checkHelp</span> <span class='hs-keyglyph'>=</span>
<a name="line-30"></a> <span class='hs-str'>"This command verifies that the patches in the repository, when applied\n"</span> <span class='hs-varop'>++</span>
<a name="line-31"></a> <span class='hs-str'>"successively to an empty tree, result in the pristine tree. If not,\n"</span> <span class='hs-varop'>++</span>
<a name="line-32"></a> <span class='hs-str'>"the differences are printed and Darcs exits unsucessfully (with a\n"</span> <span class='hs-varop'>++</span>
<a name="line-33"></a> <span class='hs-str'>"non-zero exit status).\n"</span> <span class='hs-varop'>++</span>
<a name="line-34"></a> <span class='hs-str'>"\n"</span> <span class='hs-varop'>++</span>
<a name="line-35"></a> <span class='hs-str'>"If the repository is in darcs-1 format and has a checkpoint, you can\n"</span> <span class='hs-varop'>++</span>
<a name="line-36"></a> <span class='hs-str'>"use the --partial option to start checking from the latest checkpoint.\n"</span> <span class='hs-varop'>++</span>
<a name="line-37"></a> <span class='hs-str'>"This is the default for partial darcs-1 repositories; the --complete\n"</span> <span class='hs-varop'>++</span>
<a name="line-38"></a> <span class='hs-str'>"option to forces a full check.\n"</span> <span class='hs-varop'>++</span>
<a name="line-39"></a> <span class='hs-str'>"\n"</span> <span class='hs-varop'>++</span>
<a name="line-40"></a> <span class='hs-str'>"If a regression test is defined (see `darcs setpref') it will be run\n"</span> <span class='hs-varop'>++</span>
<a name="line-41"></a> <span class='hs-str'>"by `darcs check'. Use the --no-test option to disable this.\n"</span>
<a name="line-42"></a>
<a name="line-43"></a><a name="check"></a><span class='hs-definition'>check</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>DarcsCommand</span>
<a name="line-44"></a><span class='hs-definition'>check</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DarcsCommand</span> <span class='hs-layout'>{</span><span class='hs-varid'>commandName</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"check"</span><span class='hs-layout'>,</span>
<a name="line-45"></a> <span class='hs-varid'>commandHelp</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>checkHelp</span><span class='hs-layout'>,</span>
<a name="line-46"></a> <span class='hs-varid'>commandDescription</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>checkDescription</span><span class='hs-layout'>,</span>
<a name="line-47"></a> <span class='hs-varid'>commandExtraArgs</span> <span class='hs-keyglyph'>=</span> <span class='hs-num'>0</span><span class='hs-layout'>,</span>
<a name="line-48"></a> <span class='hs-varid'>commandExtraArgHelp</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>[]</span><span class='hs-layout'>,</span>
<a name="line-49"></a> <span class='hs-varid'>commandCommand</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>checkCmd</span><span class='hs-layout'>,</span>
<a name="line-50"></a> <span class='hs-varid'>commandPrereq</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>amInRepository</span><span class='hs-layout'>,</span>
<a name="line-51"></a> <span class='hs-varid'>commandGetArgPossibilities</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-conid'>[]</span><span class='hs-layout'>,</span>
<a name="line-52"></a> <span class='hs-varid'>commandArgdefaults</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>nodefaults</span><span class='hs-layout'>,</span>
<a name="line-53"></a> <span class='hs-varid'>commandAdvancedOptions</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>[]</span><span class='hs-layout'>,</span>
<a name="line-54"></a> <span class='hs-varid'>commandBasicOptions</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>partialCheck</span><span class='hs-layout'>,</span>
<a name="line-55"></a> <span class='hs-varid'>notest</span><span class='hs-layout'>,</span>
<a name="line-56"></a> <span class='hs-varid'>leaveTestDir</span><span class='hs-layout'>,</span>
<a name="line-57"></a> <span class='hs-varid'>workingRepoDir</span><span class='hs-layout'>,</span>
<a name="line-58"></a> <span class='hs-varid'>ignoretimes</span>
<a name="line-59"></a> <span class='hs-keyglyph'>]</span><span class='hs-layout'>}</span>
<a name="line-60"></a>
<a name="line-61"></a><a name="checkCmd"></a><span class='hs-definition'>checkCmd</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>DarcsFlag</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-62"></a><span class='hs-definition'>checkCmd</span> <span class='hs-varid'>opts</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>withRepository</span> <span class='hs-varid'>opts</span> <span class='hs-layout'>(</span><span class='hs-varid'>check'</span> <span class='hs-varid'>opts</span><span class='hs-layout'>)</span>
<a name="line-63"></a>
<a name="line-64"></a><a name="check'"></a><span class='hs-definition'>check'</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>RepoPatch</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>DarcsFlag</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Repository</span> <span class='hs-varid'>p</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-65"></a><span class='hs-definition'>check'</span> <span class='hs-varid'>opts</span> <span class='hs-varid'>repository</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-66"></a> <span class='hs-varid'>failed</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>replayRepository</span> <span class='hs-varid'>repository</span> <span class='hs-layout'>(</span><span class='hs-varid'>testByDefault</span> <span class='hs-varid'>opts</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span> <span class='hs-varid'>state</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-67"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>state</span> <span class='hs-keyword'>of</span>
<a name="line-68"></a> <span class='hs-conid'>RepositoryConsistent</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-69"></a> <span class='hs-varid'>putInfo</span> <span class='hs-varid'>opts</span> <span class='hs-varop'>$</span> <span class='hs-varid'>text</span> <span class='hs-str'>"The repository is consistent!"</span>
<a name="line-70"></a> <span class='hs-varid'>testRecorded</span> <span class='hs-varid'>repository</span>
<a name="line-71"></a> <span class='hs-varid'>return</span> <span class='hs-conid'>False</span>
<a name="line-72"></a> <span class='hs-conid'>BrokenPristine</span> <span class='hs-varid'>newpris</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-73"></a> <span class='hs-varid'>brokenPristine</span> <span class='hs-varid'>newpris</span>
<a name="line-74"></a> <span class='hs-varid'>return</span> <span class='hs-conid'>True</span>
<a name="line-75"></a> <span class='hs-conid'>BrokenPatches</span> <span class='hs-varid'>newpris</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-76"></a> <span class='hs-varid'>brokenPristine</span> <span class='hs-varid'>newpris</span>
<a name="line-77"></a> <span class='hs-varid'>putInfo</span> <span class='hs-varid'>opts</span> <span class='hs-varop'>$</span> <span class='hs-varid'>text</span> <span class='hs-str'>"Found broken patches."</span>
<a name="line-78"></a> <span class='hs-varid'>return</span> <span class='hs-conid'>True</span>
<a name="line-79"></a> <span class='hs-varid'>bad_index</span> <span class='hs-keyglyph'><-</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>willIgnoreTimes</span> <span class='hs-varid'>opts</span> <span class='hs-keyword'>of</span>
<a name="line-80"></a> <span class='hs-conid'>False</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>not</span> <span class='hs-varop'><$></span> <span class='hs-varid'>checkIndex</span> <span class='hs-varid'>repository</span> <span class='hs-layout'>(</span><span class='hs-conid'>Quiet</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>opts</span><span class='hs-layout'>)</span>
<a name="line-81"></a> <span class='hs-conid'>True</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-conid'>False</span>
<a name="line-82"></a> <span class='hs-varid'>when</span> <span class='hs-varid'>bad_index</span> <span class='hs-varop'>$</span> <span class='hs-varid'>putInfo</span> <span class='hs-varid'>opts</span> <span class='hs-varop'>$</span> <span class='hs-varid'>text</span> <span class='hs-str'>"Bad index."</span>
<a name="line-83"></a> <span class='hs-varid'>exitWith</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>failed</span> <span class='hs-varop'>||</span> <span class='hs-varid'>bad_index</span> <span class='hs-keyword'>then</span> <span class='hs-conid'>ExitFailure</span> <span class='hs-num'>1</span> <span class='hs-keyword'>else</span> <span class='hs-conid'>ExitSuccess</span>
<a name="line-84"></a> <span class='hs-keyword'>where</span>
<a name="line-85"></a> <span class='hs-varid'>brokenPristine</span> <span class='hs-varid'>newpris</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-86"></a> <span class='hs-varid'>putInfo</span> <span class='hs-varid'>opts</span> <span class='hs-varop'>$</span> <span class='hs-varid'>text</span> <span class='hs-str'>"Looks like we have a difference..."</span>
<a name="line-87"></a> <span class='hs-varid'>mc</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>readRecorded</span> <span class='hs-varid'>repository</span>
<a name="line-88"></a> <span class='hs-varid'>ftf</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>filetypeFunction</span>
<a name="line-89"></a> <span class='hs-varid'>diff</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>treeDiff</span> <span class='hs-varid'>ftf</span> <span class='hs-varid'>newpris</span> <span class='hs-varid'>mc</span>
<a name="line-90"></a> <span class='hs-varid'>putInfo</span> <span class='hs-varid'>opts</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>diff</span> <span class='hs-keyword'>of</span>
<a name="line-91"></a> <span class='hs-conid'>NilFL</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>text</span> <span class='hs-str'>"Nothing"</span>
<a name="line-92"></a> <span class='hs-varid'>patch</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>text</span> <span class='hs-str'>"Difference: "</span> <span class='hs-varop'><+></span> <span class='hs-varid'>showPatch</span> <span class='hs-varid'>patch</span>
<a name="line-93"></a> <span class='hs-varid'>putInfo</span> <span class='hs-varid'>opts</span> <span class='hs-varop'>$</span> <span class='hs-varid'>text</span> <span class='hs-str'>""</span>
<a name="line-94"></a> <span class='hs-varop'>$$</span> <span class='hs-varid'>text</span> <span class='hs-str'>"Inconsistent repository!"</span>
<a name="line-95"></a>
</pre>\end{code}
%% FIXME: this should go in "common options" or something, since
%% commands like record and amend-record also run the test command.
\input{Darcs/Test.lhs}
</body>
</html>
