add ^ shorthand

Author: kaikalii

changelog.md

@@ -27,6 +27,7 @@ This version is not yet released. If you are reading this on the website, then t
 - Add numeric subscripts for [`keep ▽`](https://uiua.org/docs/keep) to keep along a number of dimensions
 - Add [`under ⍜`](https://uiua.org/docs/under) capability to [`fork ⊃`](https://uiua.org/docs/fork)s of monadic functions
   - This allows using [`un °`](https://uiua.org/docs/un)[`by ⊸`](https://uiua.org/docs/by)[`fork ⊃`](https://uiua.org/docs/fork) to set multiple properties at once
+- Add `^` shorthand for `^0` in index macros
 - Stabilize [`self ˙`](https://uiua.org/docs/self)
   - Add experimental sided subscripts for [`self ˙`](https://uiua.org/docs/self)
 - Add experimental sided subscripts for [`backward ˜`](https://uiua.org/docs/backward)

parser/src/ast.rs

@@ -348,7 +348,7 @@ pub enum Word {
     Pack(FunctionPack),
     Primitive(Primitive),
     Modified(Box<Modified>),
-    Placeholder(usize),
+    Placeholder(Option<usize>),
     Comment(String),
     Spaces,
     BreakLine,
@@ -469,7 +469,8 @@ impl fmt::Debug for Word {
             Word::Modified(modified) => modified.fmt(f),
             Word::Spaces => write!(f, "' '"),
             Word::Comment(comment) => write!(f, "# {comment}"),
-            Word::Placeholder(op) => write!(f, "^{op}"),
+            Word::Placeholder(Some(i)) => write!(f, "^{i}"),
+            Word::Placeholder(None) => write!(f, "^"),
             Word::BreakLine => write!(f, "break_line"),
             Word::FlipLine => write!(f, "unbreak_line"),
             Word::SemanticComment(comment) => write!(f, "{comment}"),

parser/src/lex.rs

@@ -609,7 +609,7 @@ pub enum Token {
     MultilineFormatStr(Vec<String>),
     Simple(AsciiToken),
     Glyph(Primitive),
-    Placeholder(usize),
+    Placeholder(Option<usize>),
     Subscr(Subscript),
     LeftArrow,
     LeftStrokeArrow,
@@ -674,7 +674,7 @@ impl Token {
             _ => None,
         }
     }
-    pub(crate) fn as_placeholder(&self) -> Option<usize> {
+    pub(crate) fn as_placeholder(&self) -> Option<Option<usize>> {
         match self {
             Token::Placeholder(i) => Some(*i),
             _ => None,
@@ -741,7 +741,8 @@ impl fmt::Display for Token {
             Token::OpenModule => write!(f, "┌─╴"),
             Token::OpenPrivateModule => write!(f, "┌╶╶"),
             Token::CloseModule => write!(f, "└─╴"),
-            Token::Placeholder(i) => write!(f, "^{i}"),
+            Token::Placeholder(Some(i)) => write!(f, "^{i}"),
+            Token::Placeholder(None) => write!(f, "^"),
         }
     }
 }
@@ -763,7 +764,6 @@ pub enum AsciiToken {
     DoubleSemicolon,
     Star,
     Percent,
-    Caret,
     Equal,
     EqualTilde,
     BangEqual,
@@ -791,7 +791,6 @@ impl fmt::Display for AsciiToken {
             AsciiToken::DoubleSemicolon => write!(f, ";;"),
             AsciiToken::Star => write!(f, "*"),
             AsciiToken::Percent => write!(f, "%"),
-            AsciiToken::Caret => write!(f, "^"),
             AsciiToken::Equal => write!(f, "="),
             AsciiToken::BangEqual => write!(f, "!="),
             AsciiToken::EqualTilde => write!(f, "=~"),
@@ -1083,9 +1082,9 @@ impl<'a> Lexer<'a> {
                 "%" => self.end(Percent, start),
                 "^" => {
                     if let Some(x) = self.next_char_if(|c| c.chars().all(|c| c.is_ascii_digit())) {
-                        self.end(Placeholder(x.parse().unwrap()), start)
+                        self.end(Placeholder(Some(x.parse().unwrap())), start)
                     } else {
-                        self.end(Caret, start)
+                        self.end(Placeholder(None), start)
                     }
                 }
                 "=" if self.next_char_exact("~") => self.end(EqualTilde, start),

parser/src/parse.rs

@@ -464,7 +464,7 @@ impl Parser<'_> {
         } else {
             glyph_span
         };
-        let array_macro = if let Some(span) = self.exact(Caret.into()) {
+        let array_macro = if let Some(span) = self.exact(Placeholder(None)) {
             arrow_span = arrow_span.merge(span);
             true
         } else {
@@ -1612,7 +1612,7 @@ impl Parser<'_> {
         Some(if branches.is_empty() {
             // Normal func
             let reset = self.index;
-            let caret_span = self.exact(Caret.into());
+            let caret_span = self.exact(Placeholder(None));
             if let Some(ident) = self
                 .ident()
                 .filter(|ident| !is_array && ident.value.chars().all(|c| "!‼".contains(c)))
@@ -2009,7 +2009,7 @@ pub fn max_placeholder(words: &[Sp<Word>]) -> Option<usize> {
     };
     for word in words {
         match &word.value {
-            Word::Placeholder(i) => set(Some(*i)),
+            Word::Placeholder(i) => set(Some(i.unwrap_or(0))),
             Word::Strand(items) => set(max_placeholder(items)),
             Word::Array(arr) => {
                 for line in arr.word_lines() {

site/text/macros.md

@@ -47,6 +47,13 @@ F‼(×2|+1) 5
 F‼(+1|⊂0) 1
 ```
 
+Because macros using a only `^0` placeholders are very common, `^0` can be written as just `^`.
+
+```uiua
+F! ← ^⇌^
+F!(⊂1) 5
+```
+
 ## Two Kinds of Macros
 The macros described so far are called *index macros*, because arguments are referenced directly by their position when the macro is called.
 

src/compile/modifier.rs

@@ -1838,7 +1838,8 @@ impl Compiler {
         let mut error = None;
         recurse_words_mut(words, &mut |word| match &mut word.value {
             Word::Placeholder(n) => {
-                if let Some(replacement) = initial.get(*n) {
+                let n = n.unwrap_or(0);
+                if let Some(replacement) = initial.get(n) {
                     *word = replacement.clone();
                 } else {
                     error = Some(self.error(

src/format.rs

@@ -1100,7 +1100,8 @@ impl Formatter<'_> {
                 self.format_modifier(&m.modifier, depth);
                 self.format_words(&m.operands, true, depth);
             }
-            Word::Placeholder(i) => self.push(&word.span, &format!("^{i}")),
+            Word::Placeholder(Some(i)) => self.push(&word.span, &format!("^{i}")),
+            Word::Placeholder(None) => self.push(&word.span, "^"),
             Word::Subscripted(sub) => match &sub.word.value {
                 Word::Modified(m) => {
                     if sub.script.value.num.is_some()

src/lsp.rs

@@ -34,7 +34,7 @@ pub enum SpanKind {
     Label,
     Signature,
     Whitespace,
-    Placeholder(usize),
+    Placeholder(Option<usize>),
     Delimiter,
     LexOrder,
     FuncDelim(Signature, SetInverses),

todo.md

@@ -1,10 +1,6 @@
 # Uiua Todo
 
 # 0.17
-- `recur` modifier
-- LSP optimizations
-  - Fix rename
-  - Fix goto references
 - Sided `join`
 - Sided `box`
 - `table` subscripts for rank selection