Merge branch 'master' of https://github.com/rm-dr/lamb

.gitignore

@@ -1,7 +1,13 @@
+# Python dev files
 venv
 __pycache__
 
+# Python build files
 *.egg-info
 *.spec
 build
-dist
+dist
+
+# Misc
+*.gif
+misc/secrets.sh

.vscode/settings.json

@@ -8,6 +8,7 @@
         "mdel",
         "onefile",
         "Packrat",
+        "printables",
         "pyparsing",
         "rlimit",
         "runstatus",

README.md

@@ -1,15 +1,29 @@
-# Lamb: A Lambda Calculus Engine
+# 🐑 Lamb: A Lambda Calculus Engine
 
-If you're reading this on PyPi, go [here](https://git.betalupi.com/Mark/lamb).
+![Lamb Demo](https://github.com/rm-dr/lamb/assets/96270320/d518e344-e7c8-47ed-89c4-7ce273bf4e2d)
-
-![Lamb screenshot](./misc/screenshot.png)
 
 
-## Installation
 
-### Method 1: PyPi [here](https://pypi.org/project/lamb-engine)
+## :brain: What is lambda calculus?
-1. `pip install lamb-engine`
+
-2. `lamb`
+ - [video 1](https://www.youtube.com/watch?v=3VQ382QG-y4): Introduction and boolean logic. The first few minutes are a bit confusing, but it starts to make sense at about [`6:50`](https://youtu.be/3VQ382QG-y4?t=400)
+
+ - [video 2](https://www.youtube.com/watch?v=pAnLQ9jwN-E): Continuation of video 1. Features combinators and numerals.
+
+ - [blog](https://www.driverlesscrocodile.com/technology/lambda-calculus-for-people-a-step-behind-me-1): Another introduction. Moves slower than the two videos above and doesn't assume CS knowledge. Four-part series.
+
+ - [handout](https://static.betalupi.com/ormc/Advanced/Lambda%20Calculus.pdf): A handout I've written on lambda calculus.
+
+## :package: Installation
+
+### Method 1: [PyPi](https://pypi.org/project/lamb-engine)
+1. *(Optional but recommended)* make and enter a [venv](https://docs.python.org/3/library/venv.html)
+	- **On Windows, run the following in cmd or powershell:**
+	- `cd Desktop`
+	- `python -m venv lamb`
+	- `.\Scripts\activate`
+2. `pip install lamb-engine`
+3. `lamb`
 
 ### Method 2: Git
 1. Clone this repository.
@@ -20,10 +34,10 @@ If you're reading this on PyPi, go [here](https://git.betalupi.com/Mark/lamb).
 
 -------------------------------------------------
 
-## Usage
+## 📖 Usage
 
 
-Type lambda expressions into the prompt, and Lamb will evaluate them. \
+Type expressions into the prompt, and Lamb will evaluate them. \
 Use your `\` (backslash) key to type a `λ`. \
 To define macros, use `=`. For example,
 ```
@@ -62,7 +76,7 @@ Have fun!
 
 -------------------------------------------------
 
-## Commands
+## :card_file_box: Commands
 
 Lamb understands many commands. Prefix them with a `:` in the prompt.
 
@@ -99,8 +113,7 @@ The lines in a file look exactly the same as regular entries in the prompt, but
  - Cleanup warnings
  - Truncate long expressions in warnings
  - Loop detection
- - α-equivalence check
  - Unchurch command: make church numerals human-readable
- - Better Syntax highlighting
+ - Better syntax highlighting
- - Complete file names and commands
+ - Tab-complete file names and commands
- - Tests
+ - Load default macros without manually downloading `macros.lamb` (via `requests`, maybe?)

lamb_engine/nodes/nodes.py

@@ -77,8 +77,8 @@ class Node:
 		self.parent_side: Direction = None # type: ignore
 
 		# Left and right nodes, None if empty
-		self._left: Node | None = None
+		self._left = None
-		self._right: Node | None = None
+		self._right = None
 
 		# The runner this node is attached to.
 		# Set by Node.set_runner()
@@ -341,7 +341,7 @@ class Bound(EndNode):
 		# The name of the macro this bound came from.
 		# Always equal to self.name, unless the macro
 		# this came from had a subscript.
-		self.macro_name: str | None = macro_name
+		self.macro_name = macro_name
 
 		if forced_id is None:
 			self.identifier = bound_counter
@@ -381,9 +381,9 @@ class Func(Node):
 				Func.from_parse(result)
 			)
 
-	def __init__(self, input: Macro | Bound, output: Node, *, runner = None) -> None:
+	def __init__(self, input, output: Node, *, runner = None) -> None:
 		super().__init__()
-		self.input: Macro | Bound = input
+		self.input = input
 		self.left: Node = output
 		self.right: None = None
 		self.runner = runner # type: ignore

lamb_engine/parser.py

@@ -56,7 +56,7 @@ class LambdaParser:
 			(self.lp + self.pp_history + self.rp)
 		)
 
-		self.pp_command = pp.Suppress(":") + pp.Word(pp.alphas + "_") + pp.Word(pp.alphas + pp.nums + "_.")[0, ...]
+		self.pp_command = pp.Suppress(":") + pp.Word(pp.alphas + "_") + pp.Word(pp.printables)[0, ...]
 
 
 		self.pp_all = (

lamb_engine/runner/commands.py

@@ -14,7 +14,7 @@ help_texts = {}
 
 def lamb_command(
 		*,
-		command_name: str | None = None,
+		command_name = None,
 		help_text: str
 	):
 	"""

lamb_engine/runner/runner.py

@@ -46,7 +46,7 @@ class Runner:
 		# Maximum amount of reductions.
 		# If None, no maximum is enforced.
 		# Must be at least 1.
-		self.reduction_limit: int | None = 1_000_000
+		self.reduction_limit = 1_000_000
 
 		# Ensure bound variables are unique.
 		# This is automatically incremented whenever we make
@@ -74,7 +74,7 @@ class Runner:
 			message = self.prompt_message
 		)
 
-	def parse(self, line) -> tuple[lamb_engine.nodes.Root | MacroDef | Command, list]:
+	def parse(self, line): # -> tuple[lamb_engine.nodes.Root | MacroDef | Command, list]
 		e = self.parser.parse_line(line)
 
 		w = []
@@ -127,53 +127,55 @@ class Runner:
 
 
 		skip_to_end = False
-		while (
+		try:
-				(
+			while (
-					(self.reduction_limit is None) or
+					(
-					(k < self.reduction_limit)
+						(self.reduction_limit is None) or
-				) and not only_macro
+						(k < self.reduction_limit)
-			):
+					) and not only_macro
-
-			# Show reduction count
-			if (
-					( (k >= self.iter_update) and (k % self.iter_update == 0) )
-					and not (self.step_reduction and not skip_to_end)
 				):
-				print(f" Reducing... {k:,}", end = "\r")
 
-			try:
+				# Show reduction count
+				if (
+						( (k >= self.iter_update) and (k % self.iter_update == 0) )
+						and not (self.step_reduction and not skip_to_end)
+					):
+					print(f" Reducing... {k:,}", end = "\r")
+
+				# Reduce
 				red_type, node = lamb_engine.nodes.reduce(node)
-			except KeyboardInterrupt:
-				stop_reason = StopReason.INTERRUPT
-				break
 
-			# If we can't reduce this expression anymore,
+				# If we can't reduce this expression anymore,
-			# it's in beta-normal form.
+				# it's in beta-normal form.
-			if red_type == lamb_engine.nodes.ReductionType.NOTHING:
+				if red_type == lamb_engine.nodes.ReductionType.NOTHING:
-				stop_reason = StopReason.BETA_NORMAL
+					stop_reason = StopReason.BETA_NORMAL
-				break
+					break
 
-			# Count reductions
+				# Count reductions
-			k += 1
+				k += 1
-			if red_type == lamb_engine.nodes.ReductionType.FUNCTION_APPLY:
+				if red_type == lamb_engine.nodes.ReductionType.FUNCTION_APPLY:
-				macro_expansions += 1
+					macro_expansions += 1
 
-			# Pause after step if necessary
+				# Pause after step if necessary
-			if self.step_reduction and not skip_to_end:
+				if self.step_reduction and not skip_to_end:
-				try:
+					try:
-					s = prompt(
+						s = prompt(
-						message = FormattedText([
+							message = FormattedText([
-							("class:prompt", lamb_engine.nodes.reduction_text[red_type]),
+								("class:prompt", lamb_engine.nodes.reduction_text[red_type]),
-							("class:prompt", f":{k:03} ")
+								("class:prompt", f":{k:03} ")
-						] + lamb_engine.utils.lex_str(str(node))),
+							] + lamb_engine.utils.lex_str(str(node))),
-						style = lamb_engine.utils.style,
+							style = lamb_engine.utils.style,
-						key_bindings = step_bindings
+							key_bindings = step_bindings
-					)
+						)
-				except KeyboardInterrupt or EOFError:
+					except KeyboardInterrupt or EOFError:
-					skip_to_end = True
+						skip_to_end = True
-					printf(FormattedText([
+						printf(FormattedText([
-						("class:warn", "Skipping to end."),
+							("class:warn", "Skipping to end."),
-					]), style = lamb_engine.utils.style)
+						]), style = lamb_engine.utils.style)
+
+		# Gracefully catch keyboard interrupts
+		except KeyboardInterrupt:
+			stop_reason = StopReason.INTERRUPT
 
 		# Print a space between step messages
 		if self.step_reduction:
@@ -194,24 +196,31 @@ class Runner:
 			]
 
 		else:
+			if not self.step_reduction:
+				out_text += [
+					("class:ok", f"Runtime: "),
+					("class:text", f"{time.time() - start_time:.03f} seconds"),
+					("class:text", "\n")
+				]
+
 			out_text += [
-				("class:ok", f"Runtime: "),
+				("class:ok", f"Exit reason: "),
-				("class:text", f"{time.time() - start_time:.03f} seconds"),
-
-				("class:ok", f"\nExit reason: "),
 				stop_reason.value,
+				("class:text", "\n"),
 
-				("class:ok", f"\nMacro expansions: "),
+				("class:ok", f"Macro expansions: "),
 				("class:text", f"{macro_expansions:,}"),
+				("class:text", "\n"),
 
-				("class:ok", f"\nReductions: "),
+				("class:ok", f"Reductions: "),
 				("class:text", f"{k:,}\t"),
 				("class:muted", f"(Limit: {self.reduction_limit:,})")
 			]
 
 		if self.full_expansion:
 			out_text += [
-				("class:ok", "\nAll macros have been expanded")
+				("class:text", "\n"),
+				("class:ok", "All macros have been expanded")
 			]
 
 		if (

misc/demo.tape

@@ -0,0 +1,84 @@
+# See makedemo.sh
+
+#Output lambdemo.mp4
+Output lambdemo.gif
+
+Set FontSize 30
+Set Width 2000
+Set Height 1500
+Set FontFamily "FantasqueSansMono NF"
+Set TypingSpeed 60ms
+Set Framerate 30
+
+# Intro
+Sleep 2000ms
+Type "lamb"
+Sleep 1000ms
+Enter
+Sleep 2000ms
+
+# Demo 1: load
+Type ":load ../macros.lamb"
+Sleep 500ms
+Enter
+Sleep 2000ms
+
+Type "NOT T"
+Sleep 1000ms
+Enter
+Sleep 6s
+
+Type ":clear"
+Sleep 1000ms
+Enter
+Sleep 1500ms
+
+
+# Demo 2: stepping
+Type ":step"
+Sleep 500ms
+Enter
+Sleep 1500ms
+
+Type "NOT T"
+Sleep 100ms
+Enter
+Sleep 1500ms
+Enter
+Sleep 760ms
+Enter
+Sleep 850ms
+Enter
+Sleep 650ms
+Enter
+Sleep 700ms
+Enter
+
+Sleep 3000ms
+
+Type ":step"
+Sleep 500ms
+Enter
+Sleep 6s
+Type ":clear"
+Sleep 1000ms
+Enter
+Sleep 1500ms
+
+# Demo 3: macros
+Type "M = \x.x x"
+Sleep 500ms
+Enter
+Sleep 500ms
+
+Type "M M"
+Sleep 500ms
+Enter
+Sleep 3s
+Ctrl+c
+Sleep 1000ms
+
+Type "Y FAC 3"
+Sleep 500ms
+Enter
+Sleep 6s

misc/makedemo.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+# Should be run from the misc directory.
+# Will not work with any other root.
+
+# Create this file.
+# Should define two variables:
+# DAV_USER="name:password"
+# DAV_URL="https://site.com/dav-path"
+
+if [[ -f "secrets.sh" ]]; then
+	source secrets.sh
+else
+	echo "Cannot run without secrets.sh"
+	exit
+fi
+
+# Activate venv if not in venv
+if [[ "$VIRTUAL_ENV" == "" ]]; then
+	source ../venv/bin/activate
+fi
+
+# Make sure our venv is running the latest
+# version of lamb.
+pip install --editable ..
+
+
+# Make gif
+vhs < demo.tape
+
+# Upload
+curl \
+	--user $DAV_USER \
+	--url $DAV_URL \
+	--upload-file "lambdemo.gif"

pyproject.toml

@@ -15,7 +15,7 @@ lamb = "lamb_engine:main"
 [project]
 name = "lamb_engine"
 description = "A lambda calculus engine"
-version = "1.1.6"
+version = "1.1.9"
 dependencies = [
 	"prompt-toolkit==3.0.31",
 	"pyparsing==3.0.9"