<!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/SetPref.lhs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
% Copyright (C) 2003 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{setpref}
\begin{code}
<pre><a name="line-1"></a><span class='hs-comment'>{-# OPTIONS_GHC -cpp #-}</span>
<a name="line-2"></a><span class='hs-comment'>{-# LANGUAGE CPP #-}</span>
<a name="line-3"></a>
<a name="line-4"></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'>SetPref</span> <span class='hs-layout'>(</span> <span class='hs-varid'>setpref</span> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-5"></a>
<a name="line-6"></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-varid'>exitWith</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>
<a name="line-7"></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-8"></a>
<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'>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>
<a name="line-10"></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-varid'>workingRepoDir</span><span class='hs-layout'>,</span> <span class='hs-varid'>umaskOption</span> <span class='hs-layout'>)</span>
<a name="line-11"></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-varid'>amInRepository</span><span class='hs-layout'>,</span> <span class='hs-varid'>add_to_pending</span><span class='hs-layout'>,</span> <span class='hs-varid'>withRepoLock</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-12"></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-varid'>changepref</span> <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'>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-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'>Prefs</span> <span class='hs-layout'>(</span> <span class='hs-varid'>getPrefval</span><span class='hs-layout'>,</span> <span class='hs-varid'>changePrefval</span><span class='hs-layout'>,</span> <span class='hs-layout'>)</span>
<a name="line-15"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>English</span> <span class='hs-layout'>(</span> <span class='hs-varid'>orClauses</span> <span class='hs-layout'>)</span>
<a name="line-16"></a><span class='hs-cpp'>#include "impossible.h"</span>
<a name="line-17"></a>
<a name="line-18"></a><a name="validPrefData"></a><span class='hs-comment'>-- | A list of all valid preferences for @_darcs/prefs/prefs@.</span>
<a name="line-19"></a><span class='hs-definition'>validPrefData</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>String</span><span class='hs-layout'>,</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ (name, one line description)</span>
<a name="line-20"></a><span class='hs-definition'>validPrefData</span> <span class='hs-keyglyph'>=</span>
<a name="line-21"></a> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-str'>"test"</span><span class='hs-layout'>,</span> <span class='hs-str'>"a shell command that runs regression tests"</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-22"></a> <span class='hs-layout'>(</span><span class='hs-str'>"predist"</span><span class='hs-layout'>,</span> <span class='hs-str'>"a shell command to run before `darcs dist'"</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-23"></a> <span class='hs-layout'>(</span><span class='hs-str'>"boringfile"</span><span class='hs-layout'>,</span> <span class='hs-str'>"the path to a version-controlled boring file"</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-24"></a> <span class='hs-layout'>(</span><span class='hs-str'>"binariesfile"</span><span class='hs-layout'>,</span> <span class='hs-str'>"the path to a version-controlled binaries file"</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-25"></a>
<a name="line-26"></a><a name="validPrefs"></a><span class='hs-definition'>validPrefs</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span>
<a name="line-27"></a><span class='hs-definition'>validPrefs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>map</span> <span class='hs-varid'>fst</span> <span class='hs-varid'>validPrefData</span>
<a name="line-28"></a>
<a name="line-29"></a><a name="setprefDescription"></a><span class='hs-definition'>setprefDescription</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span>
<a name="line-30"></a><span class='hs-definition'>setprefDescription</span> <span class='hs-keyglyph'>=</span>
<a name="line-31"></a> <span class='hs-str'>"Set a preference ("</span> <span class='hs-varop'>++</span> <span class='hs-varid'>orClauses</span> <span class='hs-varid'>validPrefs</span> <span class='hs-varop'>++</span> <span class='hs-str'>")."</span>
<a name="line-32"></a>
<a name="line-33"></a><a name="setprefHelp"></a><span class='hs-definition'>setprefHelp</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span>
<a name="line-34"></a><span class='hs-definition'>setprefHelp</span> <span class='hs-keyglyph'>=</span>
<a name="line-35"></a> <span class='hs-str'>"When working on project with multiple repositories and contributors,\n"</span> <span class='hs-varop'>++</span>
<a name="line-36"></a> <span class='hs-str'>"it is sometimes desirable for a preference to be set consistently\n"</span> <span class='hs-varop'>++</span>
<a name="line-37"></a> <span class='hs-str'>"project-wide. This is achieved by treating a preference set with\n"</span> <span class='hs-varop'>++</span>
<a name="line-38"></a> <span class='hs-str'>"`darcs setpref' as an unrecorded change, which can then be recorded\n"</span> <span class='hs-varop'>++</span>
<a name="line-39"></a> <span class='hs-str'>"and then treated like any other patch.\n"</span> <span class='hs-varop'>++</span>
<a name="line-40"></a> <span class='hs-str'>"\n"</span> <span class='hs-varop'>++</span>
<a name="line-41"></a> <span class='hs-str'>"Valid preferences are:\n"</span> <span class='hs-varop'>++</span>
<a name="line-42"></a> <span class='hs-str'>"\n"</span> <span class='hs-varop'>++</span>
<a name="line-43"></a> <span class='hs-varid'>unlines</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>" "</span><span class='hs-varop'>++</span><span class='hs-varid'>x</span><span class='hs-varop'>++</span><span class='hs-str'>" -- "</span><span class='hs-varop'>++</span><span class='hs-varid'>y</span> <span class='hs-keyglyph'>|</span> <span class='hs-layout'>(</span><span class='hs-varid'>x</span><span class='hs-layout'>,</span><span class='hs-varid'>y</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>validPrefData</span><span class='hs-keyglyph'>]</span> <span class='hs-varop'>++</span>
<a name="line-44"></a> <span class='hs-str'>"\n"</span> <span class='hs-varop'>++</span>
<a name="line-45"></a> <span class='hs-str'>"For example, a project using GNU autotools, with a `make test' target\n"</span> <span class='hs-varop'>++</span>
<a name="line-46"></a> <span class='hs-str'>"to perform regression tests, might enable Darcs' integrated regression\n"</span> <span class='hs-varop'>++</span>
<a name="line-47"></a> <span class='hs-str'>"testing with the following command:\n"</span> <span class='hs-varop'>++</span>
<a name="line-48"></a> <span class='hs-str'>"\n"</span> <span class='hs-varop'>++</span>
<a name="line-49"></a> <span class='hs-str'>" darcs setpref test 'autoconf && ./configure && make && make test'\n"</span> <span class='hs-varop'>++</span>
<a name="line-50"></a> <span class='hs-str'>"\n"</span> <span class='hs-varop'>++</span>
<a name="line-51"></a> <span class='hs-str'>"Note that merging is not currently implemented for preferences: if two\n"</span> <span class='hs-varop'>++</span>
<a name="line-52"></a> <span class='hs-str'>"patches attempt to set the same preference, the last patch applied to\n"</span> <span class='hs-varop'>++</span>
<a name="line-53"></a> <span class='hs-str'>"the repository will always take precedence. This is considered a\n"</span> <span class='hs-varop'>++</span>
<a name="line-54"></a> <span class='hs-str'>"low-priority bug, because preferences are seldom set.\n"</span>
<a name="line-55"></a>
<a name="line-56"></a><a name="setpref"></a><span class='hs-definition'>setpref</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>DarcsCommand</span>
<a name="line-57"></a><span class='hs-definition'>setpref</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'>"setpref"</span><span class='hs-layout'>,</span>
<a name="line-58"></a> <span class='hs-varid'>commandHelp</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>setprefHelp</span><span class='hs-layout'>,</span>
<a name="line-59"></a> <span class='hs-varid'>commandDescription</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>setprefDescription</span><span class='hs-layout'>,</span>
<a name="line-60"></a> <span class='hs-varid'>commandExtraArgs</span> <span class='hs-keyglyph'>=</span> <span class='hs-num'>2</span><span class='hs-layout'>,</span>
<a name="line-61"></a> <span class='hs-varid'>commandExtraArgHelp</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"<PREF>"</span><span class='hs-layout'>,</span>
<a name="line-62"></a> <span class='hs-str'>"<VALUE>"</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span>
<a name="line-63"></a> <span class='hs-varid'>commandCommand</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>setprefCmd</span><span class='hs-layout'>,</span>
<a name="line-64"></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-65"></a> <span class='hs-varid'>commandGetArgPossibilities</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-varid'>validPrefs</span><span class='hs-layout'>,</span>
<a name="line-66"></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-67"></a> <span class='hs-varid'>commandAdvancedOptions</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>umaskOption</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span>
<a name="line-68"></a> <span class='hs-varid'>commandBasicOptions</span> <span class='hs-keyglyph'>=</span>
<a name="line-69"></a> <span class='hs-keyglyph'>[</span><span class='hs-varid'>workingRepoDir</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>}</span>
<a name="line-70"></a>
<a name="line-71"></a><a name="setprefCmd"></a><span class='hs-definition'>setprefCmd</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-72"></a><span class='hs-definition'>setprefCmd</span> <span class='hs-varid'>opts</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>pref</span><span class='hs-layout'>,</span><span class='hs-varid'>val</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>withRepoLock</span> <span class='hs-varid'>opts</span> <span class='hs-varop'>$-</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>repository</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-73"></a> <span class='hs-varid'>when</span> <span class='hs-layout'>(</span><span class='hs-chr'>' '</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>pref</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>do</span>
<a name="line-74"></a> <span class='hs-varid'>putStrLn</span> <span class='hs-varop'>$</span> <span class='hs-str'>"'"</span><span class='hs-varop'>++</span><span class='hs-varid'>pref</span><span class='hs-varop'>++</span>
<a name="line-75"></a> <span class='hs-str'>"' is not a valid preference name: no spaces allowed!"</span>
<a name="line-76"></a> <span class='hs-varid'>exitWith</span> <span class='hs-varop'>$</span> <span class='hs-conid'>ExitFailure</span> <span class='hs-num'>1</span>
<a name="line-77"></a> <span class='hs-varid'>when</span> <span class='hs-layout'>(</span><span class='hs-varid'>not</span> <span class='hs-varop'>$</span> <span class='hs-varid'>pref</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>validPrefs</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>do</span>
<a name="line-78"></a> <span class='hs-varid'>putStrLn</span> <span class='hs-varop'>$</span> <span class='hs-str'>"'"</span><span class='hs-varop'>++</span><span class='hs-varid'>pref</span><span class='hs-varop'>++</span><span class='hs-str'>"' is not a valid preference name!"</span>
<a name="line-79"></a> <span class='hs-varid'>putStrLn</span> <span class='hs-varop'>$</span> <span class='hs-str'>"Try one of: "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>unwords</span> <span class='hs-varid'>validPrefs</span>
<a name="line-80"></a> <span class='hs-varid'>exitWith</span> <span class='hs-varop'>$</span> <span class='hs-conid'>ExitFailure</span> <span class='hs-num'>1</span>
<a name="line-81"></a> <span class='hs-varid'>oval</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getPrefval</span> <span class='hs-varid'>pref</span>
<a name="line-82"></a> <span class='hs-varid'>old</span> <span class='hs-keyglyph'><-</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>oval</span> <span class='hs-keyword'>of</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>v</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-varid'>v</span>
<a name="line-83"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-str'>""</span>
<a name="line-84"></a> <span class='hs-varid'>changePrefval</span> <span class='hs-varid'>pref</span> <span class='hs-varid'>old</span> <span class='hs-varid'>val</span>
<a name="line-85"></a> <span class='hs-varid'>putStrLn</span> <span class='hs-varop'>$</span> <span class='hs-str'>"Changing value of "</span><span class='hs-varop'>++</span><span class='hs-varid'>pref</span><span class='hs-varop'>++</span><span class='hs-str'>" from '"</span><span class='hs-varop'>++</span><span class='hs-varid'>old</span><span class='hs-varop'>++</span><span class='hs-str'>"' to '"</span><span class='hs-varop'>++</span><span class='hs-varid'>val</span><span class='hs-varop'>++</span><span class='hs-str'>"'"</span>
<a name="line-86"></a> <span class='hs-varid'>add_to_pending</span> <span class='hs-varid'>repository</span> <span class='hs-layout'>(</span><span class='hs-varid'>changepref</span> <span class='hs-varid'>pref</span> <span class='hs-varid'>old</span> <span class='hs-varid'>val</span> <span class='hs-conop'>:>:</span> <span class='hs-conid'>NilFL</span><span class='hs-layout'>)</span>
<a name="line-87"></a><span class='hs-definition'>setprefCmd</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>impossible</span>
</pre>\end{code}
</body>
</html>
