diff options
| -rw-r--r-- | LICENSE | 165 | ||||
| -rw-r--r-- | README.md | 11 | ||||
| -rw-r--r-- | rprt.md | 146 |
3 files changed, 322 insertions, 0 deletions
@@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/README.md b/README.md new file mode 100644 index 0000000..d47e0bd --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# RPRT (Rank PolymoRphic Text editor) + +> Finally, a text editor for your flying saucer. + +A text editor powered by a tacit programming language with selection rank polymorphic functions, (loosely) inspired by Sam. + +[See rprt.md for details about the programming language](rprt.md). + +## Licensing + +RPRT is copyright (c) tslil clingman and distributed under the terms of the GNU General Public License, version 3 or later (GPL-3.0+). See the `LICENSE` file for details. @@ -0,0 +1,146 @@ +# Rank PolymoRphic Text editor (RPRT) + +A compositional, point-free language for text manipulation. + +# 1. Core Concepts + +## 1.1 Two Fundamental Types + +All functions work with two core types: + +1. **Selection** — addresses and regions in files + - Rank 0: Position (integer offset) + - Rank 1: Range is a pair of positions [start,end) with capture groups + - Rank 2: A list of ranges with capture groups + - Rank 3: Indexed selection is a mapping of files -> list of ranges with capture groups + +2. **Text** — string data + +# 2. Selection Functions + +Selection functions produce Selection outputs and take zero or more Selection inputs. They come in nullary, unary (monadic), and binary (dyadic) forms. + +## 2.1 Core Selection Functions + +There are ten core selection functions in RPRT. Nine of them have nullary and unary (monadic) forms. The tenth, `,` (span), additionally has binary (dyadic) semantics - it is the only selection function that takes two arguments. + +In the nullary case there are no rank semantics. In the unary case we provide their semantics as a function of the input rank below. + +| Function | Nullary | Rank | +|----------|----------------------------------------------------|---------| +| `.` | Current selection | matched | +| `$` | End of file | 0 | +| `#n` | Character n in file | 0 | +| `n` | Line n in file | 1 | +| `/re/` | First match forward in file from start | 1 | +| `x/re/` | All matches within file | 2 | +| `+n` | Line n in file | 1 | +| `X/re/` | All files and their contents whose name matches re | 3 | +| `,` | Entire file (0,$) | 2 | + +In the unary case, all defined functions are rank preserving. Their action on ranks > 1 are given by broadcasting, that is, `α F` where `α` has rank 2 is computed by applying `F` to each rank 1 range in `α` and collecting the results into a list of ranges, mutatis mutandis for rank 3. + +**Note:** The functions `.` and `X` have no unary or higher arity semantics. To use them as such is erroneous. + +**Note:** When the input has rank 0 (position), all defined unary functions are the identity since positions have no internal structure within which to search or operate. + +| Function | α Rank 1 | +|-----------|-------------------| +| `α /re/` | First re within α | +| `α x/re/` | All re within α | +| `α $` | End position of α | +| `α #n` | Char n within α | +| `α n` | Line n within α | +| `α +n` | Line n within α | +| `α ,` | Identity | + +The span function `,` is the only selection function with binary (dyadic) semantics. It creates ranges by spanning from one selection to another. + +**Semantics by rank:** + +| Rank of α | Rank of ω | Rank of result | Semantics | +|-----------|-----------|----------------|-------------------------------------------------------| +| 0 | 0 | 1 | Range from α to ω | +| 0 | 1 | 1 | Range from α to end of ω | +| 1 | 0 | 1 | Range from start of α to ω | +| 1 | 1 | 1 | Range from start of α to end of ω | +| 0/1 | 2 | 2 | α to each range in ω (broadcast) | +| 2 | 0/1 | 2 | Each range in α to ω (broadcast) | +| 2 | 2 | 2 | Pairwise ranges (zip shortest) | +| 0 | 3 | 3 | α to each range in ω (broadcast) | +| 3 | 0 | 3 | Each range in α to ω (broadcast) | +| 3 | 1/2 | - | Erroneous (TODO: maybe makes sense if indices align?) | +| 1/2 | 3 | - | Erroneous (TODO: maybe makes sense if indices align?) | + +## 2.2 Operators + +Operators take functions as arguments and return new functions. + +### 2.2.1 The Reverse Operator `'` + +The reverse operator `'` takes a selection function and reverses its direction. + +**Note:** `'F` is not defined when `F` is one of the functions `.X,` . + +| Function | Nullary | Rank | +|----------|-------------------------------|------| +| `'$` | Start of file (position 0) | 0 | +| `'#n` | Character n from end of file | 0 | +| `'n` | Line n from end of file | 1 | +| `'/re/` | First match backward from end | 1 | +| `'x/re/` | All matches, right-to-left | 2 | +| `'+n` | Line -n in file | 1 | + +In the unary case, all functions are rank preserving, and all of the above functions are the identity on rank 0 inputs. Their action on ranks > 1 is by broadcasting. + +| Function | α Rank 1 | +|------------|--------------------------------| +| `α '$` | Start position of α | +| `α '#n` | Char n from end of α | +| `α 'n` | Line n from end of α | +| `α '/re/` | First match backward within α | +| `α 'x/re/` | All matches right-to-left in α | +| `α '+n` | Line -n within α | + +**Note:** When the input has rank 0 (position), all defined reversed unary functions are the identity since positions have no internal structure within which to search or operate. + +### 2.2.2 The Sequential Operator `;` + +The sequential operator `;` transforms a selection function from operating "within" a selection to operating "starting from the end" of that selection. + +**Note:** It is erroneous to use `;F` in the nullary case. TODO: or are there interesting semantics? + +**Note:** `;F` is not defined when `F` is one of `.X,` . + +| Function | α Rank 0 | α Rank 1 | +|------------|----------------------------|-----------------------------------| +| `α ;$` | End of file | End of file (ignores α) | +| `α ;#n` | Character n after α | Character n after end of α | +| `α ;n` | Line n after α | Line n after end of α | +| `α ;/re/` | First match forward from α | First match forward from end of α | +| `α ;x/re/` | All matches forward from α | All matches forward from end of α | +| `α ;+n` | Line n after α | Line n after end of α | + +### 2.2.3 The Complement Operator `~` + +The complement operator `~` takes a selection function and produces a new selection function which returns the complement. Naturally this changes rank somewhat, as explained in the below table. + +| Rank of output of `F` | Rank of output of `~F` | Semantics | +|-----------------------|------------------------|------------------------------------------------------------------| +| 0 | 2 | The complement of the position its file as a selection | +| 1 | 2 | The complement of the range in its file as a selection | +| 2 | 2 | The selection corresponding to the ranges between the selections | +| 3 | 3 | The broadcast of `~` to each file | + +## 2.3 Composition and Parsing + +**Operator application:** Functions are modified by operators. All operators commute: `';F` = `;'F`. + +**Precedence:** Following BQN rules: +- Operators bind tighter than functions +- Functions apply left-to-right +- Binary functions are infix + +## 3. Text Functions + +Text functions modify selections, and consume zero or one selections, and one Text value. |