<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Darcs.Patch.Split</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Darcs-Patch-Split.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Darcs-Patch-Split.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">darcs-2.8.3: a distributed, interactive, smart revision control system</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">Darcs.Patch.Split</p></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:Splitter">Splitter</a> p = <a href="#v:Splitter">Splitter</a> {<ul class="subs"><li><a href="#v:applySplitter">applySplitter</a> :: <span class="keyword">forall</span> x y. p x y -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> (<a href="/usr/share/doc/ghc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a>, <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> (<a href="Darcs-Witnesses-Ordered.html#t:FL">FL</a> p x y))</li><li><a href="#v:canonizeSplit">canonizeSplit</a> :: <span class="keyword">forall</span> x y. <a href="Darcs-Witnesses-Ordered.html#t:FL">FL</a> p x y -> <a href="Darcs-Witnesses-Ordered.html#t:FL">FL</a> p x y</li></ul>}</li><li class="src short"><a href="#v:rawSplitter">rawSplitter</a> :: (<a href="Darcs-Patch-Show.html#t:ShowPatch">ShowPatch</a> p, <a href="Darcs-Patch-Read.html#t:ReadPatch">ReadPatch</a> p, <a href="Darcs-Patch-Invert.html#t:Invert">Invert</a> p) => <a href="Darcs-Patch-Split.html#t:Splitter">Splitter</a> p</li><li class="src short"><a href="#v:noSplitter">noSplitter</a> :: <a href="Darcs-Patch-Split.html#t:Splitter">Splitter</a> p</li><li class="src short"><a href="#v:primSplitter">primSplitter</a> :: <a href="Darcs-Patch-Prim-Class.html#t:PrimPatch">PrimPatch</a> p => <a href="Darcs-Patch-Split.html#t:Splitter">Splitter</a> p</li><li class="src short"><a href="#v:reversePrimSplitter">reversePrimSplitter</a> :: <a href="Darcs-Patch-Prim-Class.html#t:PrimPatch">PrimPatch</a> prim => <a href="Darcs-Patch-Split.html#t:Splitter">Splitter</a> prim</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Splitter" class="def">Splitter</a> p <a href="src/Darcs-Patch-Split.html#Splitter" class="link">Source</a></p><div class="doc"><p>A splitter is something that can take a patch and (possibly) render it
as text in some format of its own choosing.
This text can then be presented to the user for editing, and the result
given to the splitter for parsing.
If the parse succeeds, the result is a list of patches that could replace
the original patch in any context.
Typically this list will contain the changed version of the patch, along
with fixup pieces to ensure that the overall effect of the list is the same
as the original patch.
The individual elements of the list can then be offered separately to the
user, allowing them to accept some and reject others.
</p><p>There's no immediate application for a splitter for anything other than
Prim (you shouldn't go editing named patches, you'll break them!)
However you might want to compose splitters for FilePatchType to make
splitters for Prim etc, and the generality doesn't cost anything.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Splitter" class="def">Splitter</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:applySplitter" class="def">applySplitter</a> :: <span class="keyword">forall</span> x y. p x y -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> (<a href="/usr/share/doc/ghc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a>, <a href="/usr/share/doc/ghc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> (<a href="Darcs-Witnesses-Ordered.html#t:FL">FL</a> p x y))</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:canonizeSplit" class="def">canonizeSplit</a> :: <span class="keyword">forall</span> x y. <a href="Darcs-Witnesses-Ordered.html#t:FL">FL</a> p x y -> <a href="Darcs-Witnesses-Ordered.html#t:FL">FL</a> p x y</dt><dd class="doc empty"> </dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><a name="v:rawSplitter" class="def">rawSplitter</a> :: (<a href="Darcs-Patch-Show.html#t:ShowPatch">ShowPatch</a> p, <a href="Darcs-Patch-Read.html#t:ReadPatch">ReadPatch</a> p, <a href="Darcs-Patch-Invert.html#t:Invert">Invert</a> p) => <a href="Darcs-Patch-Split.html#t:Splitter">Splitter</a> p<a href="src/Darcs-Patch-Split.html#rawSplitter" class="link">Source</a></p><div class="doc"><p>This generic splitter just lets the user edit the printed representation of the patch
Should not be used expect for testing and experimentation.
</p></div></div><div class="top"><p class="src"><a name="v:noSplitter" class="def">noSplitter</a> :: <a href="Darcs-Patch-Split.html#t:Splitter">Splitter</a> p<a href="src/Darcs-Patch-Split.html#noSplitter" class="link">Source</a></p><div class="doc"><p>Never splits. In other code we normally pass around Maybe Splitter instead of using this
as the default, because it saves clients that don't care about splitting from having to
import this module just to get noSplitter.
</p></div></div><div class="top"><p class="src"><a name="v:primSplitter" class="def">primSplitter</a> :: <a href="Darcs-Patch-Prim-Class.html#t:PrimPatch">PrimPatch</a> p => <a href="Darcs-Patch-Split.html#t:Splitter">Splitter</a> p<a href="src/Darcs-Patch-Split.html#primSplitter" class="link">Source</a></p><div class="doc"><p>Split a primitive hunk patch up
by allowing the user to edit both the before and after lines, then insert fixup patches
to clean up the mess.
</p></div></div><div class="top"><p class="src"><a name="v:reversePrimSplitter" class="def">reversePrimSplitter</a> :: <a href="Darcs-Patch-Prim-Class.html#t:PrimPatch">PrimPatch</a> prim => <a href="Darcs-Patch-Split.html#t:Splitter">Splitter</a> prim<a href="src/Darcs-Patch-Split.html#reversePrimSplitter" class="link">Source</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
