summary refs log tree commit diff stats
diff options
context:
space:
mode:
-rw-r--r--ranger/actions.py12
-rw-r--r--ranger/defaults/keys.py27
-rw-r--r--ranger/ext/move.py8
-rw-r--r--ranger/gui/defaultui.py24
-rw-r--r--ranger/gui/displayable.py9
-rw-r--r--ranger/gui/widgets/filelistcontainer.py31
-rw-r--r--ranger/gui/widgets/pager.py78
7 files changed, 177 insertions, 12 deletions
diff --git a/ranger/actions.py b/ranger/actions.py
index 968aae4f..3e5ebdb7 100644
--- a/ranger/actions.py
+++ b/ranger/actions.py
@@ -151,6 +151,18 @@ class Actions(EnvironmentAware, SettingsAware):
 	def handle_mouse(self):
 		"""Handle mouse-buttons if one was pressed"""
 		self.ui.handle_mouse()
+	
+	def display_file(self):
+		if not hasattr(self.ui, 'open_embedded_pager'):
+			return
+
+		try:
+			f = open(self.env.cf.path, 'r')
+		except:
+			pass
+		else:
+			pager = self.ui.open_embedded_pager()
+			pager.set_source(f)
 
 	def execute_file(self, files, app='', flags='', mode=0):
 		"""Execute a file.
diff --git a/ranger/defaults/keys.py b/ranger/defaults/keys.py
index cfbcc0e9..5e764ddd 100644
--- a/ranger/defaults/keys.py
+++ b/ranger/defaults/keys.py
@@ -44,8 +44,8 @@ def initialize_commands(command_list):
 	bind(KEY_NPAGE, ctrl('f'), fm.move_pointer_by_pages(1))
 	bind(KEY_PPAGE, ctrl('b'), fm.move_pointer_by_pages(-1))
 	bind('E', fm.edit_file())
-	bind('i', fm.tag_toggle())
-	bind('I', fm.tag_remove())
+	bind('b', fm.tag_toggle())
+	bind('B', fm.tag_remove())
 
 	bind(' ', fm.mark(toggle=True))
 	bind('v', fm.mark(all=True, toggle=True))
@@ -91,6 +91,8 @@ def initialize_commands(command_list):
 		if cf:
 			fm.open_console(cmode.COMMAND, 'rename ' + cf.basename)
 
+	bind('i', fm.display_file())
+
 	bind('A', edit_name)
 	bind('cw', fm.open_console(cmode.COMMAND, 'rename '))
 	bind('cd', fm.open_console(cmode.COMMAND, 'cd '))
@@ -219,6 +221,25 @@ def initialize_process_manager_commands(command_list):
 
 	bind('dd', wdg.process_remove())
 	bind('w', ESC, ctrl('d'), ctrl('c'),
-			lambda arg: arg.wdg.fm.ui.close_pman())
+			lambda arg: arg.fm.ui.close_pman())
+
+	command_list.rebuild_paths()
+
+def initialize_pager_commands(command_list):
+	initialize_embedded_pager_commands(command_list)
+
+def initialize_embedded_pager_commands(command_list):
+	system_functions(command_list)
+	bind, hint = make_abbreviations(command_list)
+
+	bind('j', KEY_DOWN, nwrap.move(relative=1))
+	bind('k', KEY_DOWN, nwrap.move(relative=-1))
+	bind('gg', KEY_DOWN, nwrap.move(absolute=0))
+	bind('G', KEY_DOWN, nwrap.move(absolute=-1))
+	
+	bind('q', 'i', lambda arg: arg.fm.ui.close_embedded_pager())
+	bind('h', wdg.move_horizontal(relative=-4))
+	bind('l', wdg.move_horizontal(relative=4))
+	bind('Q', 'ZZ', fm.exit())
 
 	command_list.rebuild_paths()
diff --git a/ranger/ext/move.py b/ranger/ext/move.py
new file mode 100644
index 00000000..5909a876
--- /dev/null
+++ b/ranger/ext/move.py
@@ -0,0 +1,8 @@
+def move_between(current, minimum, maximum, relative=0, absolute=None):
+	i = current
+	if isinstance(absolute, int):
+		i = absolute
+	if isinstance(relative, int):
+		i += relative
+	i = max(minimum, min(maximum - 1, i))
+	return i
diff --git a/ranger/gui/defaultui.py b/ranger/gui/defaultui.py
index 31049178..1bb62d72 100644
--- a/ranger/gui/defaultui.py
+++ b/ranger/gui/defaultui.py
@@ -12,6 +12,8 @@ class DefaultUI(UI):
 		from ranger.gui.widgets.statusbar import StatusBar
 		from ranger.gui.widgets.process_manager import ProcessManager
 		from ranger.gui.widgets.notify import Notify
+		from ranger.gui.widgets.pager import Pager
+
 		self.titlebar = TitleBar(self.win)
 		self.add_obj(self.titlebar)
 
@@ -32,16 +34,19 @@ class DefaultUI(UI):
 		self.notify = Notify(self.win)
 		self.add_obj(self.notify)
 
+		self.pager = Pager(self.win)
+		self.add_obj(self.pager)
+
 	def update_size(self):
 		"""resize all widgets"""
 		UI.update_size(self)
 		y, x = self.env.termsize
 
 		notify_hei = self.notify.requested_height
-#		log(notify_hei)
 
 		self.filelist_container.resize(1, 0, y - 2 - notify_hei, x)
 		self.pman.resize(1, 0, y - 2 - notify_hei, x)
+		self.pager.resize(1, 0, y - 2 - notify_hei, x)
 		self.notify.resize(y - 1 - notify_hei, 0, notify_hei, x)
 		self.titlebar.resize(0, 0, 1, x)
 		self.status.resize(y - 1, 0, 1, x)
@@ -55,6 +60,23 @@ class DefaultUI(UI):
 	def display(self, *a, **k):
 		return self.notify.display(*a, **k)
 
+	def close_pager(self):
+		self.pager.visible = False
+		self.pager.focused = False
+		self.filelist_container.visible = True
+	
+	def open_pager(self):
+		self.pager.visible = True
+		self.pager.focused = True
+		self.filelist_container.visible = False
+
+	def open_embedded_pager(self):
+		self.filelist_container.open_pager()
+		return self.filelist_container.pager
+
+	def close_embedded_pager(self):
+		self.filelist_container.close_pager()
+	
 	def open_console(self, mode, string=''):
 		if self.console.open(mode, string):
 			self.console.on_close = self.close_console
diff --git a/ranger/gui/displayable.py b/ranger/gui/displayable.py
index e3191cdb..62ff41f9 100644
--- a/ranger/gui/displayable.py
+++ b/ranger/gui/displayable.py
@@ -83,6 +83,15 @@ class Displayable(EnvironmentAware, FileManagerAware, SettingsAware):
 		"""
 		pass
 
+	def activate(self, boolean):
+		boolean = bool(boolean)
+		self.visible = boolean
+		self.focused = boolean
+	
+	def show(self, boolean):
+		boolean = bool(boolean)
+		self.visible = boolean
+
 	def poke(self):
 		"""Called before drawing, even if invisible"""
 	
diff --git a/ranger/gui/widgets/filelistcontainer.py b/ranger/gui/widgets/filelistcontainer.py
index 6e925f83..53cbf064 100644
--- a/ranger/gui/widgets/filelistcontainer.py
+++ b/ranger/gui/widgets/filelistcontainer.py
@@ -1,6 +1,7 @@
 """The FileListContainer manages a set of FileLists."""
 from . import Widget
 from .filelist import FileList
+from .pager import Pager
 from ..displayable import DisplayableContainer
 from ranger import log
 
@@ -39,6 +40,9 @@ class FileListContainer(Widget, DisplayableContainer):
 		else:
 			self.main_filelist.display_infostring = True
 			self.main_filelist.main_display = True
+
+		self.pager = Pager(win, embedded=True)
+		self.add_obj(self.pager)
 	
 	def resize(self, y, x, hei, wid):
 		"""Resize all the filelists according to the given ratio"""
@@ -53,12 +57,17 @@ class FileListContainer(Widget, DisplayableContainer):
 		else:
 			generator = zip(self.ratios, range(len(self.ratios)))
 
+		last_i = len(self.ratios) - 1
+
 		for ratio, i in generator:
 			wid = int(ratio * self.wid)
 
-			if i == len(self.ratios) - 1:
+			if i == last_i:
 				wid = int(self.wid - left + 1)
 
+			if i == last_i - 1:
+				self.pager.resize(self.y, left, hei, max(1, self.wid - left))
+
 			try:
 				self.container[i].resize(self.y, left, hei, max(1, wid-1))
 			except KeyError:
@@ -66,10 +75,28 @@ class FileListContainer(Widget, DisplayableContainer):
 
 			left += wid
 	
+	def open_pager(self):
+		self.pager.activate(True)
+		self.pager.open()
+		try:
+			self.container[-2].show(False)
+			self.container[-3].show(False)
+		except IndexError:
+			pass
+	
+	def close_pager(self):
+		self.pager.activate(False)
+		self.pager.close()
+		try:
+			self.container[-2].show(True)
+			self.container[-3].show(True)
+		except IndexError:
+			pass
+	
 	def poke(self):
 		DisplayableContainer.poke(self)
 		if self.settings.collapse_preview and self.preview:
-			has_preview = self.container[-1].has_preview()
+			has_preview = self.container[-2].has_preview()
 			if self.preview_available != has_preview:
 				self.preview_available = has_preview
 				self.resize(self.y, self.x, self.hei, self.wid)
diff --git a/ranger/gui/widgets/pager.py b/ranger/gui/widgets/pager.py
index 7a93a2d6..6a147766 100644
--- a/ranger/gui/widgets/pager.py
+++ b/ranger/gui/widgets/pager.py
@@ -3,21 +3,39 @@ The pager displays text and allows you to scroll inside it.
 """
 from ranger import log
 from . import Widget
+from ranger.container.commandlist import CommandList
+from ranger.ext.move import move_between
 
 class Pager(Widget):
 	source = None
 	source_is_stream = False
-	def __init__(self, win):
+	def __init__(self, win, embedded=False):
 		Widget.__init__(self, win)
+		self.embedded = embedded
 		self.scroll_begin = 0
+		self.startx = 0
+		self.lines = []
 
-#		self.commandlist = CommandList()
-#		self.settings.keys.initialize_pager_commands( \
-#				self.commandlist)
+		self.commandlist = CommandList()
+
+		if embedded:
+			keyfnc = self.settings.keys.initialize_embedded_pager_commands
+		else:
+			keyfnc = self.settings.keys.initialize_pager_commands
+
+		keyfnc(self.commandlist)
+	
+	def open(self):
+		self.scroll_begin = 0
+		self.startx = 0
+	
+	def close(self):
+		if self.source and self.source_is_stream:
+			self.source.close()
 	
 	def draw(self):
 		line_gen = self._generate_lines(
-				starty=self.scroll_begin, startx=0)
+				starty=self.scroll_begin, startx=self.startx)
 
 		for line, i in zip(line_gen, range(self.hei)):
 			y, x = self.y + i, self.x
@@ -27,6 +45,54 @@ class Pager(Widget):
 			except:
 				pass
 	
+	def move(self, relative=0, absolute=None):
+		i = self.scroll_begin
+		if isinstance(absolute, int):
+			i = absolute
+
+		if isinstance(relative, int):
+			i += relative
+
+		length = len(self.lines) - self.hei - 1
+		log('before: ' + str(length))
+
+		if i >= length:
+			self._get_line(i+self.hei)
+
+		length = len(self.lines) - self.hei - 1
+		log('after: ' + str(length))
+
+		if i >= length:
+			i = length
+
+		if i < 0:
+			i = 0
+
+		self.scroll_begin = i
+	
+	def move_horizontal(self, relative=0, absolute=None):
+		self.startx = move_between(
+				current=self.startx,
+				minimum=0,
+				maximum=999,
+				relative=relative,
+				absolute=absolute)
+
+	def press(self, key):
+		try:
+			tup = self.env.keybuffer.tuple_without_numbers()
+			if tup:
+				cmd = self.commandlist[tup]
+			else:
+				return
+				
+		except KeyError:
+			self.env.key_clear()
+		else:
+			if hasattr(cmd, 'execute'):
+				cmd.execute_wrap(self)
+				self.env.key_clear()
+	
 	def set_source(self, source):
 		if self.source and self.source_is_stream:
 			self.source.close()
@@ -44,7 +110,7 @@ class Pager(Widget):
 
 		self.source = source
 		return True
-	
+
 	def _get_line(self, n, attempt_to_read=True):
 		try:
 			return self.lines[n]
21'>721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
//: Containers contain a fixed number of elements of different types.

:(before "End Mu Types Initialization")
//: We'll use this container as a running example in scenarios below.
type_ordinal point = put(Type_ordinal, "point", Next_type_ordinal++);
get_or_insert(Type, point);  // initialize
get(Type, point).kind = CONTAINER;
get(Type, point).name = "point";
get(Type, point).elements.push_back(reagent("x:number"));
get(Type, point).elements.push_back(reagent("y:number"));

//: Containers can be copied around with a single instruction just like
//: numbers, no matter how large they are.

//: Tests in this layer often explicitly set up memory before reading it as a
//: container. Don't do this in general. I'm tagging such cases with /unsafe;
//: they'll be exceptions to later checks.

:(code)
void test_copy_multiple_locations() {
  run(
      "def main [\n"
      "  1:num <- copy 34\n"
      "  2:num <- copy 35\n"
      "  3:point <- copy 1:point/unsafe\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "mem: storing 34 in location 3\n"
      "mem: storing 35 in location 4\n"
  );
}

//: trying to copy to a differently-typed destination will fail
void test_copy_checks_size() {
  Hide_errors = true;
  run(
      "def main [\n"
      "  2:point <- copy 1:num\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "error: main: can't copy '1:num' to '2:point'; types don't match\n"
  );
}

:(before "End Mu Types Initialization")
// A more complex example container, containing another container as one of
// its elements.
type_ordinal point_number = put(Type_ordinal, "point-number", Next_type_ordinal++);
get_or_insert(Type, point_number);  // initialize
get(Type, point_number).kind = CONTAINER;
get(Type, point_number).name = "point-number";
get(Type, point_number).elements.push_back(reagent("xy:point"));
get(Type, point_number).elements.push_back(reagent("z:number"));

:(code)
void test_copy_handles_nested_container_elements() {
  run(
      "def main [\n"
      "  12:num <- copy 34\n"
      "  13:num <- copy 35\n"
      "  14:num <- copy 36\n"
      "  15:point-number <- copy 12:point-number/unsafe\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "mem: storing 36 in location 17\n"
  );
}

//: products of recipes can include containers
void test_return_container() {
  run(
      "def main [\n"
      "  3:point <- f 2\n"
      "]\n"
      "def f [\n"
      "  12:num <- next-ingredient\n"
      "  13:num <- copy 35\n"
      "  return 12:point/raw\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "run: result 0 is [2, 35]\n"
      "mem: storing 2 in location 3\n"
      "mem: storing 35 in location 4\n"
  );
}

//: Containers can be checked for equality with a single instruction just like
//: numbers, no matter how large they are.

void test_compare_multiple_locations() {
  run(
      "def main [\n"
      "  1:num <- copy 34\n"  // first
      "  2:num <- copy 35\n"
      "  3:num <- copy 36\n"
      "  4:num <- copy 34\n"  // second
      "  5:num <- copy 35\n"
      "  6:num <- copy 36\n"
      "  7:bool <- equal 1:point-number/raw, 4:point-number/unsafe\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "mem: storing 1 in location 7\n"
  );
}

void test_compare_multiple_locations_2() {
  run(
      "def main [\n"
      "  1:num <- copy 34\n"  // first
      "  2:num <- copy 35\n"
      "  3:num <- copy 36\n"
      "  4:num <- copy 34\n"  // second
      "  5:num <- copy 35\n"
      "  6:num <- copy 37\n"  // different
      "  7:bool <- equal 1:point-number/raw, 4:point-number/unsafe\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "mem: storing 0 in location 7\n"
  );
}

:(before "End size_of(type) Special-cases")
if (type->value == -1) return 1;  // error value, but we'll raise it elsewhere
if (type->value == 0) return 1;
if (!contains_key(Type, type->value)) {
  raise << "no such type " << type->value << '\n' << end();
  return 0;
}
type_info t = get(Type, type->value);
if (t.kind == CONTAINER) {
  // size of a container is the sum of the sizes of its elements
  int result = 0;
  for (int i = 0; i < SIZE(t.elements); ++i) {
    // todo: strengthen assertion to disallow mutual type recursion
    if (t.elements.at(i).type->value == type->value) {
      raise << "container " << t.name << " can't include itself as a member\n" << end();
      return 0;
    }
    result += size_of(element_type(type, i));
  }
  return result;
}

:(code)
void test_stash_container() {
  run(
      "def main [\n"
      "  1:num <- copy 34\n"  // first
      "  2:num <- copy 35\n"
      "  3:num <- copy 36\n"
      "  stash [foo:], 1:point-number/raw\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "app: foo: 34 35 36\n"
  );
}

//:: To access elements of a container, use 'get'
//: 'get' takes a 'base' container and an 'offset' into it and returns the
//: appropriate element of the container value.

void test_get() {
  run(
      "def main [\n"
      "  12:num <- copy 34\n"
      "  13:num <- copy 35\n"
      "  15:num <- get 12:point/raw, 1:offset\n"  // unsafe
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "mem: storing 35 in location 15\n"
  );
}

:(before "End Primitive Recipe Declarations")
GET,
:(before "End Primitive Recipe Numbers")
put(Recipe_ordinal, "get", GET);
:(before "End Primitive Recipe Checks")
case GET: {
  if (SIZE(inst.ingredients) != 2) {
    raise << maybe(get(Recipe, r).name) << "'get' expects exactly 2 ingredients in '" << to_original_string(inst) << "'\n" << end();
    break;
  }
  reagent/*copy*/ base = inst.ingredients.at(0);  // new copy for every invocation
  // Update GET base in Check
  if (!base.type) {
    raise << maybe(get(Recipe, r).name) << "first ingredient of 'get' should be a container, but got '" << inst.ingredients.at(0).original_string << "'\n" << end();
    break;
  }
  const type_tree* base_type = base.type;
  // Update GET base_type in Check
  if (!base_type->atom || base_type->value == 0 || !contains_key(Type, base_type->value) || get(Type, base_type->value).kind != CONTAINER) {
    raise << maybe(get(Recipe, r).name) << "first ingredient of 'get' should be a container, but got '" << inst.ingredients.at(0).original_string << "'\n" << end();
    break;
  }
  const reagent& offset = inst.ingredients.at(1);
  if (!is_literal(offset) || !is_mu_scalar(offset)) {
    raise << maybe(get(Recipe, r).name) << "second ingredient of 'get' should have type 'offset', but got '" << inst.ingredients.at(1).original_string << "'\n" << end();
    break;
  }
  int offset_value = 0;
  if (is_integer(offset.name)) {
    offset_value = to_integer(offset.name);
  }
  // End update GET offset_value in Check
  if (offset_value < 0 || offset_value >= SIZE(get(Type, base_type->value).elements)) {
    raise << maybe(get(Recipe, r).name) << "invalid offset '" << offset_value << "' for '" << get(Type, base_type->value).name << "'\n" << end();
    break;
  }
  if (inst.products.empty()) break;
  reagent/*copy*/ product = inst.products.at(0);
  // Update GET product in Check
  //: use base.type rather than base_type because later layers will introduce compound types
  const reagent/*copy*/ element = element_type(base.type, offset_value);
  if (!types_coercible(product, element)) {
    raise << maybe(get(Recipe, r).name) << "'get " << base.original_string << ", " << offset.original_string << "' should write to " << names_to_string_without_quotes(element.type) << " but '" << product.name << "' has type " << names_to_string_without_quotes(product.type) << '\n' << end();
    break;
  }
  break;
}
:(before "End Primitive Recipe Implementations")
case GET: {
  reagent/*copy*/ base = current_instruction().ingredients.at(0);
  // Update GET base in Run
  int base_address = base.value;
  if (base_address == 0) {
    raise << maybe(current_recipe_name()) << "tried to access location 0 in '" << to_original_string(current_instruction()) << "'\n" << end();
    break;
  }
  const type_tree* base_type = base.type;
  // Update GET base_type in Run
  int offset = ingredients.at(1).at(0);
  if (offset < 0 || offset >= SIZE(get(Type, base_type->value).elements)) break;  // copied from Check above
  int src = base_address;
  for (int i = 0; i < offset; ++i)
    src += size_of(element_type(base.type, i));
  trace(Callstack_depth+1, "run") << "address to copy is " << src << end();
  //: use base.type rather than base_type because later layers will introduce compound types
  reagent/*copy*/ element = element_type(base.type, offset);
  element.set_value(src);
  trace(Callstack_depth+1, "run") << "its type is " << names_to_string(element.type) << end();
  // Read element
  products.push_back(read_memory(element));
  break;
}

:(code)
const reagent element_type(const type_tree* type, int offset_value) {
  assert(offset_value >= 0);
  const type_tree* base_type = type;
  // Update base_type in element_type
  assert(contains_key(Type, base_type->value));
  assert(!get(Type, base_type->value).name.empty());
  const type_info& info = get(Type, base_type->value);
  assert(info.kind == CONTAINER);
  if (offset_value >= SIZE(info.elements)) return reagent();  // error handled elsewhere
  reagent/*copy*/ element = info.elements.at(offset_value);
  // End element_type Special-cases
  return element;
}

void test_get_handles_nested_container_elements() {
  run(
      "def main [\n"
      "  12:num <- copy 34\n"
      "  13:num <- copy 35\n"
      "  14:num <- copy 36\n"
      "  15:num <- get 12:point-number/raw, 1:offset\n"  // unsafe
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "mem: storing 36 in location 15\n"
  );
}

void test_get_out_of_bounds() {
  Hide_errors = true;
  run(
      "def main [\n"
      "  12:num <- copy 34\n"
      "  13:num <- copy 35\n"
      "  14:num <- copy 36\n"
      "  get 12:point-number/raw, 2:offset\n"  // point-number occupies 3 locations but has only 2 fields; out of bounds
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "error: main: invalid offset '2' for 'point-number'\n"
  );
}

void test_get_out_of_bounds_2() {
  Hide_errors = true;
  run(
      "def main [\n"
      "  12:num <- copy 34\n"
      "  13:num <- copy 35\n"
      "  14:num <- copy 36\n"
      "  get 12:point-number/raw, -1:offset\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "error: main: invalid offset '-1' for 'point-number'\n"
  );
}

void test_get_product_type_mismatch() {
  Hide_errors = true;
  run(
      "def main [\n"
      "  12:num <- copy 34\n"
      "  13:num <- copy 35\n"
      "  14:num <- copy 36\n"
      "  15:&:num <- get 12:point-number/raw, 1:offset\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "error: main: 'get 12:point-number/raw, 1:offset' should write to number but '15' has type (address number)\n"
  );
}

//: we might want to call 'get' without saving the results, say in a sandbox

void test_get_without_product() {
  run(
      "def main [\n"
      "  12:num <- copy 34\n"
      "  13:num <- copy 35\n"
      "  get 12:point/raw, 1:offset\n"  // unsafe
      "]\n"
  );
  // just don't die
}

//:: To write to elements of containers, use 'put'.

void test_put() {
  run(
      "def main [\n"
      "  12:num <- copy 34\n"
      "  13:num <- copy 35\n"
      "  $clear-trace\n"
      "  12:point <- put 12:point, 1:offset, 36\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "mem: storing 36 in location 13"
  );
  CHECK_TRACE_DOESNT_CONTAIN("mem: storing 34 in location 12");
}

:(before "End Primitive Recipe Declarations")
PUT,
:(before "End Primitive Recipe Numbers")
put(Recipe_ordinal, "put", PUT);
:(before "End Primitive Recipe Checks")
case PUT: {
  if (SIZE(inst.ingredients) != 3) {
    raise << maybe(get(Recipe, r).name) << "'put' expects exactly 3 ingredients in '" << to_original_string(inst) << "'\n" << end();
    break;
  }
  reagent/*copy*/ base = inst.ingredients.at(0);
  // Update PUT base in Check
  if (!base.type) {
    raise << maybe(get(Recipe, r).name) << "first ingredient of 'put' should be a container, but got '" << inst.ingredients.at(0).original_string << "'\n" << end();
    break;
  }
  const type_tree* base_type = base.type;
  // Update PUT base_type in Check
  if (!base_type->atom || base_type->value == 0 || !contains_key(Type, base_type->value) || get(Type, base_type->value).kind != CONTAINER) {
    raise << maybe(get(Recipe, r).name) << "first ingredient of 'put' should be a container, but got '" << inst.ingredients.at(0).original_string << "'\n" << end();
    break;
  }
  reagent/*copy*/ offset = inst.ingredients.at(1);
  // Update PUT offset in Check
  if (!is_literal(offset) || !is_mu_scalar(offset)) {
    raise << maybe(get(Recipe, r).name) << "second ingredient of 'put' should have type 'offset', but got '" << inst.ingredients.at(1).original_string << "'\n" << end();
    break;
  }
  int offset_value = 0;
  //: later layers will permit non-integer offsets
  if (is_integer(offset.name)) {
    offset_value = to_integer(offset.name);
    if (offset_value < 0 || offset_value >= SIZE(get(Type, base_type->value).elements)) {
      raise << maybe(get(Recipe, r).name) << "invalid offset '" << offset_value << "' for '" << get(Type, base_type->value).name << "'\n" << end();
      break;
    }
  }
  else {
    offset_value = offset.value;
  }
  const reagent& value = inst.ingredients.at(2);
  //: use base.type rather than base_type because later layers will introduce compound types
  const reagent& element = element_type(base.type, offset_value);
  if (!types_coercible(element, value)) {
    raise << maybe(get(Recipe, r).name) << "'put " << base.original_string << ", " << offset.original_string << "' should write to " << names_to_string_without_quotes(element.type) << " but '" << value.name << "' has type " << names_to_string_without_quotes(value.type) << '\n' << end();
    break;
  }
  if (inst.products.empty()) break;  // no more checks necessary
  if (inst.products.at(0).name != inst.ingredients.at(0).name) {
    raise << maybe(get(Recipe, r).name) << "product of 'put' must be first ingredient '" << inst.ingredients.at(0).original_string << "', but got '" << inst.products.at(0).original_string << "'\n" << end();
    break;
  }
  // End PUT Product Checks
  break;
}
:(before "End Primitive Recipe Implementations")
case PUT: {
  reagent/*copy*/ base = current_instruction().ingredients.at(0);
  // Update PUT base in Run
  int base_address = base.value;
  if (base_address == 0) {
    raise << maybe(current_recipe_name()) << "tried to access location 0 in '" << to_original_string(current_instruction()) << "'\n" << end();
    break;
  }
  const type_tree* base_type = base.type;
  // Update PUT base_type in Run
  int offset = ingredients.at(1).at(0);
  if (offset < 0 || offset >= SIZE(get(Type, base_type->value).elements)) break;  // copied from Check above
  int address = base_address;
  for (int i = 0; i < offset; ++i)
    address += size_of(element_type(base.type, i));
  trace(Callstack_depth+1, "run") << "address to copy to is " << address << end();
  // optimization: directly write the element rather than updating 'product'
  // and writing the entire container
  // Write Memory in PUT in Run
  write_products = false;
  for (int i = 0;  i < SIZE(ingredients.at(2));  ++i) {
    trace(Callstack_depth+1, "mem") << "storing " << no_scientific(ingredients.at(2).at(i)) << " in location " << address+i << end();
    put(Memory, address+i, ingredients.at(2).at(i));
  }
  break;
}

:(code)
void test_put_product_error() {
  Hide_errors = true;
  run(
      "def main [\n"
      "  local-scope\n"
      "  load-ingredients\n"
      "  1:point <- merge 34, 35\n"
      "  3:point <- put 1:point, x:offset, 36\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "error: main: product of 'put' must be first ingredient '1:point', but got '3:point'\n"
  );
}

//:: Allow containers to be defined in Mu code.

void test_container() {
  load(
      "container foo [\n"
      "  x:num\n"
      "  y:num\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "parse: --- defining container foo\n"
      "parse: element: {x: \"number\"}\n"
      "parse: element: {y: \"number\"}\n"
  );
}

void test_container_use_before_definition() {
  load(
      "container foo [\n"
      "  x:num\n"
      "  y:bar\n"
      "]\n"
      "container bar [\n"
      "  x:num\n"
      "  y:num\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "parse: --- defining container foo\n"
      "parse: type number: 1000\n"
      "parse:   element: {x: \"number\"}\n"
      // todo: brittle
      // type bar is unknown at this point, but we assign it a number
      "parse:   element: {y: \"bar\"}\n"
      // later type bar gets a definition
      "parse: --- defining container bar\n"
      "parse: type number: 1001\n"
      "parse:   element: {x: \"number\"}\n"
      "parse:   element: {y: \"number\"}\n"
  );
}

//: if a container is defined again, the new fields add to the original definition
void test_container_extend() {
  run(
      "container foo [\n"
      "  x:num\n"
      "]\n"
      "container foo [\n"  // add to previous definition
      "  y:num\n"
      "]\n"
      "def main [\n"
      "  1:num <- copy 34\n"
      "  2:num <- copy 35\n"
      "  3:num <- get 1:foo, 0:offset\n"
      "  4:num <- get 1:foo, 1:offset\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "mem: storing 34 in location 3\n"
      "mem: storing 35 in location 4\n"
  );
}

:(before "End Command Handlers")
else if (command == "container") {
  insert_container(command, CONTAINER, in);
}

//: Even though we allow containers to be extended, we don't allow this after
//: a call to transform_all. But we do want to detect this situation and raise
//: an error. This field will help us raise such errors.
:(before "End type_info Fields")
int Num_calls_to_transform_all_at_first_definition;
:(before "End type_info Constructor")
Num_calls_to_transform_all_at_first_definition = -1;

:(code)
void insert_container(const string& command, kind_of_type kind, istream& in) {
  skip_whitespace_but_not_newline(in);
  string name = next_word(in);
  if (name.empty()) {
    assert(!has_data(in));
    raise << "incomplete container definition at end of file (0)\n" << end();
    return;
  }
  // End container Name Refinements
  trace(101, "parse") << "--- defining " << command << ' ' << name << end();
  if (!contains_key(Type_ordinal, name)
      || get(Type_ordinal, name) == 0) {
    put(Type_ordinal, name, Next_type_ordinal++);
  }
  trace(102, "parse") << "type number: " << get(Type_ordinal, name) << end();
  skip_bracket(in, "'"+command+"' must begin with '['");
  type_info& info = get_or_insert(Type, get(Type_ordinal, name));
  if (info.Num_calls_to_transform_all_at_first_definition == -1) {
    // initial definition of this container
    info.Num_calls_to_transform_all_at_first_definition = Num_calls_to_transform_all;
  }
  else if (info.Num_calls_to_transform_all_at_first_definition != Num_calls_to_transform_all) {
    // extension after transform_all
    raise << "there was a call to transform_all() between the definition of container '" << name << "' and a subsequent extension. This is not supported, since any recipes that used '" << name << "' values have already been transformed and \"frozen\".\n" << end();
    return;
  }
  info.name = name;
  info.kind = kind;
  while (has_data(in)) {
    skip_whitespace_and_comments(in);
    string element = next_word(in);
    if (element.empty()) {
      assert(!has_data(in));
      raise << "incomplete container definition at end of file (1)\n" << end();
      return;
    }
    if (element == "]") break;
    if (in.peek() != '\n') {
      raise << command << " '" << name << "' contains multiple elements on a single line. Containers and exclusive containers must only contain elements, one to a line, no code.\n" << end();
      // skip rest of container declaration
      while (has_data(in)) {
        skip_whitespace_and_comments(in);
        if (next_word(in) == "]") break;
      }
      break;
    }
    info.elements.push_back(reagent(element));
    expand_type_abbreviations(info.elements.back().type);  // todo: use abbreviation before declaration
    replace_unknown_types_with_unique_ordinals(info.elements.back().type, info);
    trace(103, "parse") << "  element: " << to_string(info.elements.back()) << end();
    // End Load Container Element Definition
  }
}

void replace_unknown_types_with_unique_ordinals(type_tree* type, const type_info& info) {
  if (!type) return;
  if (!type->atom) {
    replace_unknown_types_with_unique_ordinals(type->left, info);
    replace_unknown_types_with_unique_ordinals(type->right, info);
    return;
  }
  assert(!type->name.empty());
  if (contains_key(Type_ordinal, type->name)) {
    type->value = get(Type_ordinal, type->name);
  }
  // End insert_container Special-cases
  else if (type->name != "->") {  // used in recipe types
    put(Type_ordinal, type->name, Next_type_ordinal++);
    type->value = get(Type_ordinal, type->name);
  }
}

void skip_bracket(istream& in, string message) {
  skip_whitespace_and_comments(in);
  if (in.get() != '[')
    raise << message << '\n' << end();
}

void test_multi_word_line_in_container_declaration() {
  Hide_errors = true;
  run(
      "container foo [\n"
      "  x:num y:num\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "error: container 'foo' contains multiple elements on a single line. Containers and exclusive containers must only contain elements, one to a line, no code.\n"
  );
}

//: support type abbreviations in container definitions

void test_type_abbreviations_in_containers() {
  run(
      "type foo = number\n"
      "container bar [\n"
      "  x:foo\n"
      "]\n"
      "def main [\n"
      "  1:num <- copy 34\n"
      "  2:foo <- get 1:bar/unsafe, 0:offset\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "mem: storing 34 in location 2\n"
  );
}

:(after "Transform.push_back(expand_type_abbreviations)")
Transform.push_back(expand_type_abbreviations_in_containers);  // idempotent
:(code)
// extremely inefficient; we process all types over and over again, once for every single recipe
// but it doesn't seem to cause any noticeable slowdown
void expand_type_abbreviations_in_containers(const recipe_ordinal /*unused*/) {
  for (map<type_ordinal, type_info>::iterator p = Type.begin();  p != Type.end();  ++p) {
    for (int i = 0;  i < SIZE(p->second.elements);  ++i)
      expand_type_abbreviations(p->second.elements.at(i).type);
  }
}

//: ensure scenarios are consistent by always starting new container
//: declarations at the same type number
:(before "End Reset")  //: for tests
Next_type_ordinal = 1000;
:(before "End Test Run Initialization")
assert(Next_type_ordinal < 1000);

:(code)
void test_error_on_transform_all_between_container_definition_and_extension() {
  // define a container
  run("container foo [\n"
      "  a:num\n"
      "]\n");
  // try to extend the container after transform
  transform_all();
  CHECK_TRACE_DOESNT_CONTAIN_ERRORS();
  Hide_errors = true;
  run("container foo [\n"
      "  b:num\n"
      "]\n");
  CHECK_TRACE_CONTAINS_ERRORS();
}

//:: Allow container definitions anywhere in the codebase, but complain if you
//:: can't find a definition at the end.

void test_run_complains_on_unknown_types() {
  Hide_errors = true;
  run(
      "def main [\n"
      "  1:integer <- copy 0\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "error: main: unknown type integer in '1:integer <- copy 0'\n"
  );
}

void test_run_allows_type_definition_after_use() {
  run(
      "def main [\n"
      "  1:bar <- copy 0/unsafe\n"
      "]\n"
      "container bar [\n"
      "  x:num\n"
      "]\n"
  );
  CHECK_TRACE_COUNT("error", 0);
}

:(before "End Type Modifying Transforms")
Transform.push_back(check_or_set_invalid_types);  // idempotent

:(code)
void check_or_set_invalid_types(const recipe_ordinal r) {
  recipe& caller = get(Recipe, r);
  trace(101, "transform") << "--- check for invalid types in recipe " << caller.name << end();
  for (int index = 0;  index < SIZE(caller.steps);  ++index) {
    instruction& inst = caller.steps.at(index);
    for (int i = 0;  i < SIZE(inst.ingredients);  ++i)
      check_or_set_invalid_types(inst.ingredients.at(i), caller, inst);
    for (int i = 0;  i < SIZE(inst.products);  ++i)
      check_or_set_invalid_types(inst.products.at(i), caller, inst);
  }
  // End check_or_set_invalid_types
}

void check_or_set_invalid_types(reagent& r, const recipe& caller, const instruction& inst) {
  // Begin check_or_set_invalid_types(r)
  check_or_set_invalid_types(r.type, maybe(caller.name), "'"+to_original_string(inst)+"'");
}

void check_or_set_invalid_types(type_tree* type, const string& location_for_error_messages, const string& name_for_error_messages) {
  if (!type) return;
  // End Container Type Checks
  if (!type->atom) {
    check_or_set_invalid_types(type->left, location_for_error_messages, name_for_error_messages);
    check_or_set_invalid_types(type->right, location_for_error_messages, name_for_error_messages);
    return;
  }
  if (type->value == 0) return;
  if (!contains_key(Type, type->value)) {
    assert(!type->name.empty());
    if (contains_key(Type_ordinal, type->name))
      type->value = get(Type_ordinal, type->name);
    else
      raise << location_for_error_messages << "unknown type " << type->name << " in " << name_for_error_messages << '\n' << end();
  }
}

void test_container_unknown_field() {
  Hide_errors = true;
  run(
      "container foo [\n"
      "  x:num\n"
      "  y:bar\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "error: foo: unknown type in y\n"
  );
}

void test_read_container_with_bracket_in_comment() {
  run(
      "container foo [\n"
      "  x:num\n"
      "  # ']' in comment\n"
      "  y:num\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "parse: --- defining container foo\n"
      "parse: element: {x: \"number\"}\n"
      "parse: element: {y: \"number\"}\n"
  );
}
void test_container_with_compound_field_type() {
  run(
      "container foo [\n"
      "  {x: (address array (address array character))}\n"
      "]\n"
  );
  CHECK_TRACE_COUNT("error", 0);
}

:(before "End transform_all")
check_container_field_types();

:(code)
void check_container_field_types() {
  for (map<type_ordinal, type_info>::iterator p = Type.begin();  p != Type.end();  ++p) {
    const type_info& info = p->second;
    // Check Container Field Types(info)
    for (int i = 0;  i < SIZE(info.elements);  ++i)
      check_invalid_types(info.elements.at(i).type, maybe(info.name), info.elements.at(i).name);
  }
}

void check_invalid_types(const type_tree* type, const string& location_for_error_messages, const string& name_for_error_messages) {
  if (!type) return;  // will throw a more precise error elsewhere
  if (!type->atom) {
    check_invalid_types(type->left, location_for_error_messages, name_for_error_messages);
    check_invalid_types(type->right, location_for_error_messages, name_for_error_messages);
    return;
  }
  if (type->value != 0) {  // value 0 = compound types (layer parse_tree) or type ingredients (layer shape_shifting_container)
    if (!contains_key(Type, type->value))
      raise << location_for_error_messages << "unknown type in " << name_for_error_messages << '\n' << end();
  }
}

string to_original_string(const type_ordinal t) {
  ostringstream out;
  if (!contains_key(Type, t)) return out.str();
  const type_info& info = get(Type, t);
  if (info.kind == PRIMITIVE) return out.str();
  out << (info.kind == CONTAINER ? "container" : "exclusive-container") << " " << info.name << " [\n";
  for (int i = 0;  i < SIZE(info.elements);  ++i) {
    out << "  " << info.elements.at(i).original_string << "\n";
  }
  out << "]\n";
  return out.str();
}