From 0ac1c4a6dcc3d55bd603dca991d14a3ea2b48f9c Mon Sep 17 00:00:00 2001
From: "Jurgen J. Vinju" <Jurgen.Vinju@cwi.nl>
Date: Thu, 31 Oct 2024 16:30:24 +0100
Subject: [PATCH] added documentation

---
 .../library/analysis/diff/edits/TextEdits.rsc | 49 +++++++++++++++++--
 1 file changed, 46 insertions(+), 3 deletions(-)

diff --git a/src/org/rascalmpl/library/analysis/diff/edits/TextEdits.rsc b/src/org/rascalmpl/library/analysis/diff/edits/TextEdits.rsc
index 55cf05f948b..2957ca920e5 100644
--- a/src/org/rascalmpl/library/analysis/diff/edits/TextEdits.rsc
+++ b/src/org/rascalmpl/library/analysis/diff/edits/TextEdits.rsc
@@ -1,5 +1,33 @@
+@license{
+Copyright (c) 2022, NWO-I Centrum Wiskunde & Informatica (CWI) 
+All rights reserved. 
+  
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 
+  
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
+  
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 
+  
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
+}
+@synopsis{Intermediate representation for file creation, removal and changing, including textual (string) rewriting.}
+@description{
+((DocumentEdit))s can be produced by source-to-source transformation tools, and then executed 
+via ((executeDocumentEdits)) in the REPL or ((applyDocumentsEdits)) by the IDE.
+}
+@benefits{
+* Document edits can be attached to ((data:CodeAction))s and error ((data:Message))s, to achieve interactive 
+source code rewriting utilities. 
+* Document edits can be tested via ((executeDocumentEdits))
+* Document edits can be "high fidelity", avoiding unnecessary damage to a source text.   
+}
+@pitfalls{
+* Code edits depend on a specific state of the source file that may be transient while editing. Use the ((CodeAction)) interface
+to avoid racing for the state of the source file.
+}
 module analysis::diff::edits::TextEdits
 
+@synopsis{File changing operations}
 data DocumentEdit
     = removed(loc file)
     | created(loc file)
@@ -7,9 +35,24 @@ data DocumentEdit
     | changed(loc file, list[TextEdit] edits)
     ;
 
+@synopsis{String rewriting operations}
+@description{
+The core operation is to replace a substring with another.
+The replace operator uses a `loc` value to point to a range inside a string,
+and a `str` as its replacement.
+}
 data TextEdit
-    = replace(loc range, str replacement)
-    ;
+    = replace(loc range, str replacement);
+
+@synopsis{Deletion is replacement with an empty string.}
+TextEdit delete(loc range) 
+    = replace(range, "");
 
-TextEdit delete(loc range) = replace(range, "");
+@synopsis{Inserting before a given range.}
+TextEdit insertBefore(loc range, str insertion, str separator=" ")
+    = replace(range.top(range.offset, 0), "<insertion><separator>");
 
+@synopsis{Inserting after a given range.}
+TextEdit insertAfter(loc range, str insertion, str separator=" ")
+    = replace(range.top(range.offset + range.length, 0), "<separator><insertion>");
+ 
\ No newline at end of file