added 'Clear All Cells' command

Author: Constantin Gahr

Default.sublime-commands

@@ -42,6 +42,10 @@
     "caption": "Helium: Get Object Inspection",
     "command": "helium_get_object_inspection"
   },
+  {
+    "caption": "Helium: Clear All Cells",
+    "command": "helium_clear_all_cells"
+  },
   {
     "caption": "Helium: Settings",
     "command": "edit_settings", "args":

helium.py

@@ -16,7 +16,7 @@
 import sublime
 from sublime_plugin import EventListener, TextCommand, ViewEventListener
 
-from .lib.kernel import KernelConnection
+from .lib.kernel import MAX_PHANTOMS, KernelConnection
 from .lib.utils import add_path, chain_callbacks, get_cell
 
 with add_path(os.path.join(os.path.dirname(__file__), "lib/client")):
@@ -334,6 +334,7 @@ class HeliumStartKernel(TextCommand):
     def run(self, edit, *, logger=HELIUM_LOGGER):
         """Command definition."""
         _start_kernel(sublime.active_window(), self.view)
+        self.view.run_command("helium_clear_all_cells")
 
 
 # TODO: Make this an enum
@@ -482,6 +483,7 @@ class HeliumConnectKernel(TextCommand):
     def run(self, edit, *, logger=HELIUM_LOGGER):
         """Command definition."""
         _connect_kernel(sublime.active_window(), self.view, logger=logger)
+        self.view.run_command("helium_clear_all_cells")
 
 
 @chain_callbacks
@@ -574,6 +576,7 @@ def is_visible(self, *, logger=HELIUM_LOGGER):
     def run(self, edit, *, logger=HELIUM_LOGGER):
         """Command definition."""
         _restart_kernel(sublime.active_window(), self.view, logger=logger)
+        self.view.run_command("helium_clear_all_cells")
 
 
 @chain_callbacks
@@ -801,6 +804,56 @@ def run(self, edit, move_cursor=False, *, logger=HELIUM_LOGGER):
             sublime.set_timeout(lambda: self.view.show(pt), 500)
 
 
+class HeliumClearAllCells(TextCommand):
+    """Clear all phantoms"""
+
+    def is_enabled(self, *, logger=HELIUM_LOGGER):
+        try:
+            kernel = ViewManager.get_kernel_for_view(self.view.buffer_id())
+
+            # if view has an attached kernel, return its status
+            return kernel.is_alive()
+        except KeyError:
+            # if view doesn't have an attached kernel, check if view was created by
+            # kernel
+            parent_view = self._get_parent_view()
+            return parent_view is not None
+
+    def is_visible(self, *, logger=HELIUM_LOGGER):
+        return self.is_enabled()
+
+    def run(self, edit, *, logger=HELIUM_LOGGER):
+        # get correct kernel
+        try:
+            kernel = ViewManager.get_kernel_for_view(self.view.buffer_id())
+        except KeyError:
+            view = self._get_parent_view()
+            kernel = ViewManager.get_kernel_for_view(view.buffer_id())
+
+        def cb():
+            if kernel._show_inline_output:
+                for k in range(MAX_PHANTOMS):
+                    self.view.erase_phantom_by_id(k)
+            else:
+                kernel.get_view().close()
+                kernel.activate_view()
+
+        # clear the old phantoms async
+        sublime.set_timeout_async(cb, 0)
+
+    def _get_parent_view(self) -> sublime.View:
+        for window in sublime.windows():
+            for view in window.views():
+                try:
+                    kernel = ViewManager.get_kernel_for_view(view.buffer_id())
+                except KeyError:
+                    continue
+
+                if kernel.get_view() == self.view:
+                    return view
+        return None
+
+
 class StatusBar(object):
     """Status Bar with animation.
 

lib/kernel.py

@@ -36,6 +36,7 @@
 MSG_TYPE_STATUS = "status"
 
 HELIUM_FIGURE_PHANTOMS = "helium_figure_phantoms"
+MAX_PHANTOMS = 65536
 
 # Used as key of status bar.
 KERNEL_STATUS_KEY = "helium_kernel_status"
@@ -422,17 +423,7 @@ def _write_inline_html_phantom(
             id = HELIUM_FIGURE_PHANTOMS + datetime.now().isoformat()
 
             html = TEXT_PHANTOM.format(content=content)
-            int_id = view.add_phantom(
-                id,
-                region,
-                html,
-                sublime.LAYOUT_BLOCK,
-                on_navigate=lambda href, id=id, view=view: self._erase_phantom(
-                    id, view=view
-                ),
-            )
-            self.phantoms[id] = int_id
-            self._logger.info("Created inline phantom {}".format(html))
+            self._add_phantom(view, id, region, html)
 
     def _write_inline_image_phantom(
         self, data: str, region: sublime.Region, view: sublime.View
@@ -458,17 +449,28 @@ def _write_inline_image_phantom(
 
                 html = IMAGE_PHANTOM.format(data=data, width=width, height=height)
 
-            int_id = view.add_phantom(
-                id,
-                region,
-                html,
-                sublime.LAYOUT_BLOCK,
-                on_navigate=lambda href, id=id, view=view: self._erase_phantom(
-                    id, view=view
-                ),
+            self._add_phantom(view, id, region, html)
+
+    def _add_phantom(
+        self, view: sublime.View, id: str, region: sublime.Region, html: str
+    ):
+        int_id = view.add_phantom(
+            id,
+            region,
+            html,
+            sublime.LAYOUT_BLOCK,
+            on_navigate=lambda href, id=id, view=view: self._erase_phantom(
+                id, view=view
+            ),
+        )
+        self.phantoms[id] = int_id
+
+        if int_id > MAX_PHANTOMS:
+            sublime.message_dialog(
+                "Please close and reopen your current tab. "
+                + "Otherwise the 'Clear All Cells' command might not work as intended."
             )
-            self.phantoms[id] = int_id
-            self._logger.info("Created inline phantom image")
+        self._logger.info("Created inline phantom image")
 
     def _clear_phantoms_in_region(self, region: sublime.Region, view: sublime.View):
         _, cell = get_cell(view, region, logger="")