-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Please see the README on GitHub at
--   <a>https://github.com/codedownio/myers-diff#readme</a>
@package myers-diff
@version 0.3.0.0

module Data.Diff.Types
data Edit
EditDelete :: Int -> Int -> Edit
[deleteFrom] :: Edit -> Int
[deleteTo] :: Edit -> Int
EditInsert :: Int -> Int -> Int -> Edit
[insertPos] :: Edit -> Int
[insertFrom] :: Edit -> Int
[insertTo] :: Edit -> Int
data Position
Position :: Int -> Int -> Position
[positionLine] :: Position -> Int
[positionCh] :: Position -> Int
data Range
Range :: Position -> Position -> Range
[rangeStart] :: Range -> Position
[rangeEnd] :: Range -> Position
data ChangeEvent
ChangeEvent :: Range -> Text -> ChangeEvent
[range] :: ChangeEvent -> Range
[text] :: ChangeEvent -> Text
instance GHC.Classes.Eq Data.Diff.Types.Edit
instance GHC.Show.Show Data.Diff.Types.Edit
instance GHC.Classes.Eq Data.Diff.Types.Position
instance GHC.Show.Show Data.Diff.Types.Position
instance GHC.Classes.Eq Data.Diff.Types.Range
instance GHC.Show.Show Data.Diff.Types.Range
instance GHC.Classes.Eq Data.Diff.Types.ChangeEvent
instance GHC.Show.Show Data.Diff.Types.ChangeEvent


-- | This is a fast Haskell implementation of the Myers text diff
--   algorithm[1]. It is heavily inspired by the Python version in <a>this
--   post</a>, and should have the same <tt>O(min(len(a), len(b)))</tt>
--   space complexity. (By contrast, the <a>Diff</a> package advertises
--   <tt>O(ab)</tt> space complexity.) The implementation uses unboxed
--   mutable vectors for performance.
--   
--   This repo also can also build a couple other versions for benchmarking
--   comparison, gated behind flags.
--   
--   <ul>
--   <li><tt>-funi_myers</tt> will build the version from the
--   <a>uni-util</a> package.</li>
--   <li><tt>-fdiff_myers</tt> will use the <a>Diff</a> package.</li>
--   </ul>
--   
--   <ul>
--   <li><i>1</i> E. Myers (1986). "An O(ND) Difference Algorithm and Its
--   Variations". Algorithmica. 1 (2): 251–266. CiteSeerX
--   <a>10.1.1.4.6927</a>.
--   doi:[10.1007<i>BF01840446](https:</i><i>doi.org</i>10.1007%2FBF01840446).
--   S2CID <a>6996809</a>.</li>
--   </ul>
module Data.Diff.Myers

-- | Diff <a>Text</a>s to produce an edit script.
diffTexts :: Text -> Text -> Seq Edit

-- | Diff <a>Text</a>s to produce LSP-style change events.
diffTextsToChangeEvents :: Text -> Text -> [ChangeEvent]

-- | Diff <a>Text</a>s to produce consolidated LSP-style change events.
diffTextsToChangeEventsConsolidate :: Text -> Text -> [ChangeEvent]

-- | Diff <a>Text</a>s with a custom consolidation function.
diffTextsToChangeEvents' :: (Seq Edit -> Seq Edit) -> Text -> Text -> [ChangeEvent]

-- | Diff <a>Vector</a>s to produce an edit script.
diffVectors :: Vector Char -> Vector Char -> Seq Edit

-- | To use in benchmarking against other libraries that use String.
diffStrings :: String -> String -> Seq Edit
diff :: (PrimMonad m, Unbox a, Eq a, Show a) => Vector a -> Vector a -> m (Seq Edit)

-- | Convert edit script to LSP-style change events.
editScriptToChangeEvents :: Vector Char -> Vector Char -> Seq Edit -> Seq ChangeEvent

-- | Consolidate adjacent edit script entries to shorten the script.
consolidateEditScript :: Seq Edit -> Seq Edit

-- | This is currently the only way to convert a <a>Text</a> to a
--   <a>Vector</a> without extraneous allocations. Taken from
--   <a>https://stackoverflow.com/a/77388392/2659595</a> Once the text
--   library contains a foldM function, we can switch to that and avoid
--   importing internal functions. See
--   <a>https://github.com/haskell/text/pull/543</a>
fastTextToVector :: Text -> Vector Char
data Edit
EditDelete :: Int -> Int -> Edit
[deleteFrom] :: Edit -> Int
[deleteTo] :: Edit -> Int
EditInsert :: Int -> Int -> Int -> Edit
[insertPos] :: Edit -> Int
[insertFrom] :: Edit -> Int
[insertTo] :: Edit -> Int