improve caching of images

First, we used two caches. Turns out that lru_cache wasn't needed, the
dict works perfectly fine on it's own.

Second, we now also cache local images, so that we don't have to read
them off the filesystem and convert them to base64 on every keystroke

Maybe there should be a maximum size on that cache dict, but I doubt
anyone would actually run into any trouble this cache taking too much
ram.

.gitattributes

@@ -0,0 +1,3 @@
+docs/ export-ignore
+resources/*.png export-ignore
+resources/*.py export-ignore

.gitignore

@@ -1,3 +1 @@
-Thumbs.db
+__pycache__
-__pycache__/
-cache.txt

.sublime/Default.sublime-keymap

@@ -1,13 +0,0 @@
-[
-    {
-        "keys": ["alt+m"],
-        "command": "new_markdown_live_preview",
-        "context": [
-            {
-                "key": "selector",
-                "operator": "equal",
-                "operand": "text.html.markdown"
-            }
-        ]
-    }
-]

.sublime/Main.sublime-menu

@@ -1,20 +0,0 @@
-[
-    {
-        "id": "preferences",
-        "children": [
-            {
-                "id": "package-settings",
-                "children": [
-                    {
-                        "caption": "MarkdownLivePreview",
-                        "command": "open_file",
-                        "args": {
-                            "file": "$packages/User/MarkdownLivePreview.css",
-                            "contents": "/* See http://www.sublimetext.com/docs/3/minihtml.html#css to know which property you're able to use */\n\n$0"
-                        }
-                    }
-                ]
-            }
-        ]
-    }
-]

.sublime/MarkdownLivePreview.sublime-commands

@@ -1,6 +0,0 @@
-[
-    {
-        "caption": "MarkdownLivePreview: Edit Current File",
-        "command": "new_markdown_live_preview"
-    }
-]

.sublime/MarkdownLivePreview.sublime-settings

@@ -1,3 +0,0 @@
-{
-    "load_from_internet_when_starts": ["http://", "https://"]
-}

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2017 Mathieu PATUREL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MLPApi.py

@@ -1,83 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-import sublime
-import sublime_plugin
-
-import os.path
-from html.parser import HTMLParser
-
-from .lib import markdown2 as md2
-from .escape_amp import *
-from .functions import *
-from .setting_names import *
-
-__folder__ = os.path.dirname(__file__)
-
-STYLE_FILE = os.path.join(os.path.dirname(__folder__), 'User',
-                         'MarkdownLivePreview.css')
-
-
-def plugin_loaded():
-    global DEFAULT_STYLE_FILE
-    DEFAULT_STYLE_FILE = sublime.load_resource('Packages/MarkdownLivePreview/'
-                                               'default.css')
-
-def get_preview_name(md_view):
-    file_name = md_view.file_name()
-    name = md_view.name() \
-           or os.path.basename(file_name) if file_name else None \
-           or 'Untitled'
-    return name + ' - Preview'
-
-def create_preview(window, file_name):
-    preview = window.new_file()
-
-    preview.set_name(get_preview_name(file_name))
-    preview.set_scratch(True)
-
-    return preview
-
-def get_style():
-    content = ''.join([line.strip() + ' ' for line in DEFAULT_STYLE_FILE.splitlines()])
-    return content + "pre code .space {color: var(--light-bg)}"
-
-def show_html(md_view, preview):
-    html = []
-    html.append('<style>\n{}\n</style>'.format(get_style()))
-    html.append(pre_with_br(md2.markdown(get_view_content(md_view),
-                                         extras=['fenced-code-blocks',
-                                                 'no-code-highlighting'])))
-
-    html = '\n'.join(html)
-
-    # the option no-code-highlighting does not exists
-    # in the official version of markdown2 for now
-    # I personaly edited the file (markdown2.py:1743)
-
-    html = html.replace('&nbsp;', '&nbspespace;') # save where are the spaces
-
-    html = HTMLParser().unescape(html)
-
-    html = escape_amp(html)
-
-    # exception, again, because <pre> aren't supported by the phantoms
-    html = html.replace('&nbspespace;', '<i class="space">.</i>')
-    html = replace_img_src_base64(html)
-    preview.erase_phantoms('markdown_preview')
-    preview.add_phantom('markdown_preview',
-                         sublime.Region(-1),
-                         html,
-                         sublime.LAYOUT_BLOCK,
-                         lambda href: sublime.run_command('open_url',
-                                                          {'url': href}))
-
-    return
-    # set viewport position
-    # 0 < y < 1
-    y = md_view.text_to_layout(md_view.sel()[0].begin())[1] / md_view.layout_extent()[1]
-    vector = [0, y * preview.layout_extent()[1]]
-    # remove half of the viewport_extent.y to center it on the screen (verticaly)
-    vector[1] -= preview.viewport_extent()[1] / 2
-    vector[1] = mini(vector[1], 0)
-    vector[1] += preview.line_height()
-    preview.set_viewport_position(vector, animate=False)

MarkdownLivePreview.py

@@ -1,65 +1,237 @@
-# -*- encoding: utf-8 -*-
+import os.path
-
 import sublime
 import sublime_plugin
 
-from .MLPApi import *
+from functools import partial
-from .setting_names import *
-from .functions import *
 
-class NewMarkdownLivePreviewCommand(sublime_plugin.ApplicationCommand):
+from .markdown2html import markdown2html
+from .utils import *
 
-    def run(self):
+MARKDOWN_VIEW_INFOS = "markdown_view_infos"
+PREVIEW_VIEW_INFOS = "preview_view_infos"
+# FIXME: put this as a setting for the user to choose?
+DELAY = 100  # ms
 
-        """Inspired by the edit_settings command"""
 
-        current_view = sublime.active_window().active_view()
+def get_resource(resource):
-        file_name = current_view.file_name()
+    path = "Packages/MarkdownLivePreview/resources/" + resource
-        current_view.close()
+    abs_path = os.path.join(sublime.packages_path(), "..", path)
-        if file_name is None:
+    if os.path.isfile(abs_path):
-            return sublime.error_message('Not supporting unsaved file for now')
+        with open(abs_path, "r") as fp:
+            return fp.read()
+    return sublime.load_resource(path)
 
-        sublime.run_command('new_window')
-        self.window = sublime.active_window()
-        self.window.settings().set(PREVIEW_WINDOW, True)
-        self.window.run_command('set_layout', {
-            'cols': [0.0, 0.5, 1.0],
-            'rows': [0.0, 1.0],
-            'cells': [[0, 0, 1, 1], [1, 0, 2, 1]]
-        })
-        self.window.focus_group(1)
-        preview = create_preview(self.window, current_view)
 
-        self.window.focus_group(0)
+resources = {}
-        md_view = self.window.open_file(file_name)
-        mdsettings = md_view.settings()
 
-        mdsettings.set(PREVIEW_ENABLED, True)
+
-        mdsettings.set(PREVIEW_ID, preview.id())
+def plugin_loaded():
+    resources["base64_404_image"] = get_resource("404.base64")
+    resources["base64_loading_image"] = get_resource("loading.base64")
+    resources["stylesheet"] = get_resource("stylesheet.css")
+
+
+# try to reload the resources if we save this file
+try:
+    plugin_loaded()
+except OSError:
+    pass
+
+# Terminology
+# original_view: the view in the regular editor, without it's own window
+# markdown_view: the markdown view, in the special window
+# preview_view: the preview view, in the special window
+# original_window: the regular window
+# preview_window: the window with the markdown file and the preview
+
+
+class MdlpInsertCommand(sublime_plugin.TextCommand):
+    def run(self, edit, point, string):
+        self.view.insert(edit, point, string)
+
+
+class OpenMarkdownPreviewCommand(sublime_plugin.TextCommand):
+    def run(self, edit):
+
+        """ If the file is saved exists on disk, we close it, and reopen it in a new
+        window. Otherwise, we copy the content, erase it all (to close the file without
+        a dialog) and re-insert it into a new view into a new window """
+
+        original_view = self.view
+        original_window_id = original_view.window().id()
+        file_name = original_view.file_name()
+
+        syntax_file = original_view.settings().get("syntax")
+
+        if file_name:
+            original_view.close()
+        else:
+            # the file isn't saved, we need to restore the content manually
+            total_region = sublime.Region(0, original_view.size())
+            content = original_view.substr(total_region)
+            original_view.erase(edit, total_region)
+            original_view.close()
+            # FIXME: save the document to a temporary file, so that if we crash,
+            #        the user doesn't lose what he wrote
+
+        sublime.run_command("new_window")
+        preview_window = sublime.active_window()
+
+        preview_window.run_command(
+            "set_layout",
+            {
+                "cols": [0.0, 0.5, 1.0],
+                "rows": [0.0, 1.0],
+                "cells": [[0, 0, 1, 1], [1, 0, 2, 1]],
+            },
+        )
+
+        preview_window.focus_group(1)
+        preview_view = preview_window.new_file()
+        preview_view.set_scratch(True)
+        preview_view.settings().set(PREVIEW_VIEW_INFOS, {})
+        preview_view.set_name("Preview")
+
+        preview_window.focus_group(0)
+        if file_name:
+            markdown_view = preview_window.open_file(file_name)
+        else:
+            markdown_view = preview_window.new_file()
+            markdown_view.run_command("mdlp_insert", {"point": 0, "string": content})
+            markdown_view.set_scratch(True)
+
+        markdown_view.set_syntax_file(syntax_file)
+        markdown_view.settings().set(
+            MARKDOWN_VIEW_INFOS, {"original_window_id": original_window_id}
+        )
 
     def is_enabled(self):
-        return is_markdown_view(sublime.active_window().active_view())
+        # FIXME: is this the best way there is to check if the current syntax is markdown?
+        #        should we only support default markdown?
+        #        what about "md"?
+        # FIXME: what about other languages, where markdown preview roughly works?
+        return "markdown" in self.view.settings().get("syntax").lower()
+
 
 class MarkdownLivePreviewListener(sublime_plugin.EventListener):
 
-    def on_modified(self, view):
+    phantom_sets = {
-        if not is_markdown_view(view): # faster than getting the settings
+        # markdown_view.id(): phantom set
+    }
+
+    # we schedule an update for every key stroke, with a delay of DELAY
+    # then, we update only if now() - last_update > DELAY
+    last_update = 0
+
+    # FIXME: maybe we shouldn't restore the file in the original window...
+
+    def on_pre_close(self, markdown_view):
+        """ Close the view in the preview window, and store information for the on_close
+        listener (see doc there)
+        """
+        if not markdown_view.settings().get(MARKDOWN_VIEW_INFOS):
             return
-        vsettings = view.settings()
+
-        if not vsettings.get(PREVIEW_ENABLED):
+        self.markdown_view = markdown_view
+        self.preview_window = markdown_view.window()
+        self.file_name = markdown_view.file_name()
+
+        if self.file_name is None:
+            total_region = sublime.Region(0, markdown_view.size())
+            self.content = markdown_view.substr(total_region)
+            markdown_view.erase(edit, total_region)
+        else:
+            self.content = None
+
+    def on_load_async(self, markdown_view):
+        infos = markdown_view.settings().get(MARKDOWN_VIEW_INFOS)
+        if not infos:
             return
-        id = vsettings.get(PREVIEW_ID)
-        if id is None:
-            raise ValueError('The preview id is None')
-        preview = get_view_from_id(view.window(), id)
-        if preview is None:
-            raise ValueError('The preview is None (id: {})'.format(id))
 
-        show_html(view, preview)
+        preview_view = markdown_view.window().active_view_in_group(1)
 
-    def on_window_command(self, window, command, args):
+        self.phantom_sets[markdown_view.id()] = sublime.PhantomSet(preview_view)
-        if command == 'close' and window.settings().get(PREVIEW_WINDOW):
+        self._update_preview(markdown_view)
-            return 'close_window', {}
 
-    def on_load_async(self, view):
+    def on_close(self, markdown_view):
-        self.on_modified(view)
+        """ Use the information saved to restore the markdown_view as an original_view
+        """
+        infos = markdown_view.settings().get(MARKDOWN_VIEW_INFOS)
+        if not infos:
+            return
+
+        assert (
+            markdown_view.id() == self.markdown_view.id()
+        ), "pre_close view.id() != close view.id()"
+
+        del self.phantom_sets[markdown_view.id()]
+
+        self.preview_window.run_command("close_window")
+
+        # find the window with the right id
+        original_window = next(
+            window
+            for window in sublime.windows()
+            if window.id() == infos["original_window_id"]
+        )
+        if self.file_name:
+            original_window.open_file(self.file_name)
+        else:
+            assert markdown_view.is_scratch(), (
+                "markdown view of an unsaved file should " "be a scratch"
+            )
+            # note here that this is called original_view, because it's what semantically
+            # makes sense, but this original_view.id() will be different than the one
+            # that we closed first to reopen in the preview window
+            # shouldn't cause any trouble though
+            original_view = original_window.new_file()
+            original_view.run_command(
+                "mdlp_insert", {"point": 0, "string": self.content}
+            )
+
+            original_view.set_syntax_file(markdown_view.settings().get("syntax"))
+
+    # here, views are NOT treated independently, which is theoretically wrong
+    # but in practice, you can only edit one markdown file at a time, so it doesn't really
+    # matter.
+    # @min_time_between_call(.5)
+    def on_modified_async(self, markdown_view):
+
+        infos = markdown_view.settings().get(MARKDOWN_VIEW_INFOS)
+        if not infos:
+            return
+
+        # we schedule an update, which won't run if an
+        sublime.set_timeout(partial(self._update_preview, markdown_view), DELAY)
+
+    def _update_preview(self, markdown_view):
+        # if the buffer id is 0, that means that the markdown_view has been closed
+        # This check is needed since a this function is used as a callback for when images
+        # are loaded from the internet (ie. it could finish loading *after* the user
+        # closes the markdown_view)
+        if time.time() - self.last_update < DELAY / 1000:
+            return
+
+        if markdown_view.buffer_id() == 0:
+            return
+
+        self.last_update = time.time()
+
+        total_region = sublime.Region(0, markdown_view.size())
+        markdown = markdown_view.substr(total_region)
+
+        basepath = os.path.dirname(markdown_view.file_name())
+        html = markdown2html(
+            markdown, basepath, partial(self._update_preview, markdown_view), resources,
+        )
+
+        self.phantom_sets[markdown_view.id()].update(
+            [
+                sublime.Phantom(
+                    sublime.Region(0),
+                    html,
+                    sublime.LAYOUT_BLOCK,
+                    lambda href: sublime.run_command("open_url", {"url": href}),
+                )
+            ]
+        )

MarkdownLivePreview.sublime-commands

@@ -0,0 +1,7 @@
+[
+
+	{
+		"caption": "MarkdownLivePreview: Open Preview",
+		"command": "open_markdown_preview"
+	}
+]

MarkdownLivePreview.tasks

@@ -1,34 +0,0 @@
-Fast:
-
-  ☐ sync scroll @needsUpdate(because of images)
-  ☐ cache image in object when used, so that it's faster @needsTest
-  ☐ call settings listener on_new too - might be too heavy
-  ☐ add clear cache command
-  ☐ add settings for the preview
-
-Medium:
-  ☐ auto refresh preview if loading images
-  ☐ use alt attribute for 404 error
-  ☐ use MarkdownLivePreview syntax, so we can use syntax's settings
-  ☐ listen for settings to change
-  ☐ fix relative source
-
-Long:
-  ☐ fix #4 @high
-  ☐ support hanchor (TOC) @big
-
-Unknown:
-  ☐ check how many times is the show_html function called
-
-
-＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿
-Archive:
- ✔ regive focus to the right markdown view @done Mon 02 Jan 2017 at 18:34 @project(Fast)
- ✔ try/except for 404 @done Mon 02 Jan 2017 at 18:03 @project(Fast)
- ✔ fix bug when empty `src` @done Mon 02 Jan 2017 at 17:15 @project(Fast)
- ✔ preview.set_scratch(True) @done Mon 02 Jan 2017 at 16:58
- ✔ set the title of the preview @done Mon 02 Jan 2017 at 16:58
- ✔ preview.wordWrap => True @done Mon 02 Jan 2017 at 16:58
- ✔ clean the code (syntax) @done Mon 02 Jan 2017 at 16:58
- ✔ add 404 image @done Mon 02 Jan 2017 at 16:57
- ✔ load images from internet (`https:`) @done Mon 02 Jan 2017 at 16:57

README.md

@@ -1,55 +1,26 @@
 # MarkdownLivePreview
 
-This is a sublime text **3** plugin that allows you to preview your markdown instantly *in* it!
+A simple plugin to preview your markdown as you type right in Sublime Text.
+No dependencies!
 
-### Dependencies
+## How to install
 
-**None**! There is no dependency! It uses [markdown2](https://github.com/trentm/python-markdown2) but it's a one file plugin, so it's included in the package.
+It's available on package control!
 
-## Installation
+## How to contribute
 
-Although MarkdownLivePreview is not available on the default channel of [PackageControl](http://packagecontrol.io), you can still use it to download this little package.
+If you know what feature you want to implement, or what bug you wanna fix, then
+go ahead and hack! But if you wanna contribute just to say thanks, and don't
+really know what you could be working on, then there are a bunch of `FIXME`s
+in `MarkdownLivePreview.py` and `markdown2html.py` (GitHub only shows the top
+2 results if you try to search using their interface :slightly_frowning_face:).
 
-1. Open the command palette (`ctrl+shift+p`)
+### Hack it!
-2. Search for: `Package Control: Add Repository`
-3. Enter in the input at the bottom of ST the path to this repo: <https://github.com/math2001/MarkdownLivePreview> (tip: just drag the link in)
-4. Hit <kbd>enter</kbd>
 
-What this does is simply adding this repo to the list of packages you get when you install a package using PC.
+1. Fork this repo
+2. Make your own branch (the name of the branch should be the feature you are
+   implementing eg. `improve-tables`, `fix-crash-on-multiple-preview`
+3. All your code should be formated by black.
+4. Send a PR!
 
-So, as you probably understood, now you just need to install MarkdownLivePreview as if it was available on the default channel:
+FIXME: add a git hook to format using black (can the git hook be added on github?)
-
-1. Open the command palette (`ctrl+shift+p`)
-2. Search for: `Package Control: Install Package`
-3. Search for: `MarkdownLivePreview`
-4. hit <kbd>enter</kbd>
-
-Done!
-
-### Usage
-
-You can choose to enable MarkdownLivePreview by pressing <kbd>alt+m</kbd> or selecting in the command palette `MarkdownLivePreview: Edit Current File`. Note that you need to be editing (simply having the focus on) a markdown file. Because [Markdown Extended][markdown-extended] did a good job, it's compatible with this plugin.
-
-It will open a new window, with only your markdown file, with the preview. Once your done, close whichever file and it'll close the entire window.
-
-*Notice that it will close the entire window if you close **whichever** file. It means that if you open a random file in this window, and then close it, it'll close the entire window still*
-
-### In dev
-
-This plugin is not finished, there's still some things to fix (custom css, focus, etc). So, don't run away if you have any trouble, just submit an issue [here](http://github.com/math2001/MarkdownLivePreview/issues).
-
-### Demo
-
-![demo](demo.gif)
-
-### Custom css
-
-It is possible to set your own css. But, be carefull, you have to respect [those rules](http://www.sublimetext.com/docs/3/minihtml.html#css). Just go to `Preferences -> Package Settings -> MarkdownLivePreview`. It will open a css file, here: `$packages/User/MarkdownLivePreview.css`. Just save it and it will automatically use it instead of the default one.
-
-### How to open the [README](http://github.com/math2001/MarkdownLivePreview/README.md)
-
-Some of the package add a command in the menus, others in the command palette, or other nowhere. None of those options are really good, especially the last one on ST3 because the packages are compressed. But, fortunately, there is plugin that exists and **will solve this problem** for us (and he has a really cute name, don't you think?): [ReadmePlease](https://packagecontrol.io/packages/ReadmePlease).
-
-
-
-[markdown-extended]: https://packagecontrol.io/packages/Markdown

default.css

@@ -1,39 +0,0 @@
-html {
-    --light-bg: color(var(--background) blend(#999 85%));
-}
-body {
-    padding:10px;
-    padding-top: 0px;
-    font-family: "Open Sans", sans-serif;
-    background-color: var(--background);
-    font-size: 15px;
-}
-
-blockquote {
-    font-style: italic;
-    display: block;
-    margin-left: 30px;
-    border: 1px solid red;
-}
-
-code {
-    padding-left: 0.2rem;
-    padding-right: 0.2rem;
-    background-color: var(--light-bg);
-    margin: 0;
-    border-radius: 3px;
-    margin: 5px;
-}
-
-pre {
-    display: block;
-    margin-top: 20px;
-    line-height: 1.7;
-    background-color: var(--light-bg);
-    padding-left: 10px;
-    width: 100%;
-    border-radius: 3px;
-}
-pre code {
-    padding-left: 0;
-}

dependencies.json

@@ -0,0 +1,7 @@
+{
+    "*": {
+        "*": [
+            "bs4"
+        ]
+    }
+}

devListener.py

@@ -1,20 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-import sublime
-import sublime_plugin
-import os.path
-
-class MLPDevListener(sublime_plugin.EventListener):
-
-    def on_post_save(self, view):
-        return
-        if not (os.path.dirname(__file__) in view.file_name() and
-            view.file_name().endswith('.py')):
-            return
-        sublime.run_command('reload_plugin', {
-            'main': os.path.join(sublime.packages_path(),
-                                 'MarkdownLivePreview', 'md_in_popup.py'),
-            'scripts': ['image_manager', 'functions', 'MLPApi',
-                        'setting_names'],
-            'quiet': True
-        })

escape_amp.py

@@ -1,39 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-import re
-
-__all__ = ['escape_amp']
-
-RE_REPLACE_AMPERSAND = re.compile(r'&(\w*)(;)?')
-
-def replace(matchobj):
-    if matchobj.group(2):
-        return matchobj.group(0)
-    else:
-        return matchobj.group(0).replace('&', '&')
-
-def escape_amp(text):
-    return RE_REPLACE_AMPERSAND.sub(replace, text)
-
-def run_tests():
-    tests = [
-        ['&', '&'],
-        ['&amp', '&amp'],
-        ['&', '&'],
-        ['& &hello &bonjour;', '& &hello &bonjour;']
-    ]
-    fails = 0
-    for i, (subject, result) in enumerate(tests):
-        if RE_REPLACE_AMPERSAND.sub(replace, subject) != result:
-            # CSW: ignore
-            print('TEST FAIL ({i}): {subject!r} escaped did not match {result!r}'.format(**locals()))
-            fails += 1
-    if fails == 0:
-        # CSW: ignore
-        print("SUCCESS: every tests ({}) passed successfully!".format(len(tests)))
-    else:
-        # CSW: ignore
-        print("{} test{} failed".format(fails, 's' if fails > 1 else ''))
-
-if __name__ == '__main__':
-    run_tests()

functions.py

@@ -1,100 +0,0 @@
-# -*- encoding: utf-8 -*-
-import base64
-import os.path
-import sublime
-import re
-from .image_manager import ImageManager
-
-def plugin_loaded():
-    global error404, loading
-    loading = sublime.load_resource('Packages/MarkdownLivePreview/loading.txt')
-    error404 = sublime.load_resource('Packages/MarkdownLivePreview/404.txt')
-
-
-def replace_img_src_base64(html):
-    """Really messy, but it works (should be updated)"""
-    index = -1
-    tag_start = '<img src="'
-    shtml, html = html, list(html)
-    while True:
-        index = shtml.find(tag_start, index + 1)
-        if index == -1:
-            break
-        path, end = get_content_till(html, '"', start=index + len(tag_start))
-        if ''.join(path).startswith('data:image/'):
-            continue
-        if ''.join(path).startswith(tuple(get_settings().get('load_from_internet'
-                                                    '_when_starts'))):
-            image = ImageManager.get(''.join(path))
-            image = image or loading
-
-        else:
-            # local image
-            image = to_base64(''.join(path))
-        html[index+len(tag_start):end] = image
-        shtml = ''.join(html)
-    return ''.join(html)
-
-def is_markdown_view(view):
-        return 'markdown' in view.scope_name(0)
-
-def to_base64(path=None, content=None):
-    if path is None and content is None:
-        return error404
-    elif content is None and path is not None:
-        try:
-            with open(path, 'rb') as fp:
-                content = fp.read()
-        except (FileNotFoundError, OSError):
-            return error404
-
-    return 'data:image/png;base64,' + ''.join([chr(el) for el in list(base64.standard_b64encode(content))])
-
-def md(*t, **kwargs):
-    sublime.message_dialog(kwargs.get('sep', '\n').join([str(el) for el in t]))
-
-def sm(*t, **kwargs):
-    sublime.status_message(kwargs.get('sep', ' ').join([str(el) for el in t]))
-
-def em(*t, **kwargs):
-    sublime.error_message(kwargs.get('sep', ' ').join([str(el) for el in t]))
-
-def mini(val, min):
-    if val < min:
-        return min
-    return val
-
-def get_content_till(string, char_to_look_for, start=0):
-    i = start
-    while i < len(string):
-        if string[i] == char_to_look_for:
-            return string[start:i], i
-        i += 1
-
-def get_view_content(view):
-    return view.substr(sublime.Region(0, view.size()))
-
-def get_view_from_id(window, id):
-    if not isinstance(id, int):
-        return
-    for view in window.views():
-        if view.id() == id:
-            return view
-
-def get_settings():
-    return sublime.load_settings('MarkdownLivePreview.sublime-settings')
-
-def pre_with_br(html):
-    """Because the phantoms of sublime text does not support <pre> blocks
-    this function replaces every \n with a <br> in a <pre>"""
-
-    while True:
-        obj = re.search(r'<pre>(.*?)</pre>', html, re.DOTALL)
-        if not obj:
-            break
-        html = list(html)
-        html[obj.start(0):obj.end(0)] = '<pre >' + ''.join(html[obj.start(1):obj.end(1)]) \
-                                            .replace('\n', '<br>') \
-                                            .replace(' ', '&nbsp;') + '</pre>'
-        html = ''.join(html)
-    return html

image_manager.py

@@ -1,98 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-import os.path
-import tempfile
-import sublime
-from threading import Thread
-import urllib.request, urllib.error
-from .functions import *
-
-CACHE_FILE = os.path.join(tempfile.gettempdir(),
-                          'MarkdownLivePreviewCache.txt')
-TIMEOUT = 20 # seconds
-
-SEPARATOR = '---%cache%--'
-
-def get_base64_saver(loading, url):
-    def callback(content):
-        if isinstance(content, urllib.error.HTTPError):
-            if content.getcode() == 404:
-                loading[url] = 404
-                return
-        elif isinstance(content, urllib.error.URLError):
-            if (content.reason.errno == 11001 and
-                content.reason.strerror == 'getaddrinfo failed'):
-                loading[url] = 404
-                return
-            return sublime.error_message('An unexpected error has occured: ' +
-                                         str(content))
-        loading[url] = to_base64(content=content)
-
-    return callback
-
-def get_cache_for(imageurl):
-    if not os.path.exists(CACHE_FILE):
-        return
-    with open(CACHE_FILE) as fp:
-        for line in fp.read().splitlines():
-            url, base64 = line.split(SEPARATOR, 1)
-            if url == imageurl:
-                return base64
-
-def cache(imageurl, base64):
-    with open(CACHE_FILE, 'a') as fp:
-        fp.write(imageurl + SEPARATOR + base64 + '\n')
-
-class ImageLoader(Thread):
-
-    def __init__(self, url, callback):
-        Thread.__init__(self)
-        self.url = url
-        self.callback = callback
-
-    def run(self):
-        try:
-            page = urllib.request.urlopen(self.url, None, TIMEOUT)
-        except Exception as e:
-            self.callback(e)
-        else:
-            self.callback(page.read())
-
-
-class ImageManager(object):
-
-    """
-        Usage:
-
-        >>> image = ImageManager.get('http://domain.com/image.png')
-        >>> image = ImageManager.get('http://domain.com/image.png')
-        # still loading (this is a comment, no an outputed text), it doesn't
-        # run an other request
-        >>> image = ImageManager.get('http://domain.com/image.png')
-        'data:image/png;base64,....'
-    """
-    loading = {}
-
-    @staticmethod
-    def get(imageurl, user_callback=None):
-
-        cached = get_cache_for(imageurl)
-        if cached:
-            return cached
-        elif imageurl in ImageManager.loading.keys():
-            # return None (the file is still loading, already made a request)
-            # return string the base64 of the url (which is going to be cached)
-            temp_cached = ImageManager.loading[imageurl]
-            if temp_cached == 404:
-                return to_base64('404.png')
-            if temp_cached:
-                cache(imageurl, temp_cached)
-                del ImageManager.loading[imageurl]
-            return temp_cached
-        else:
-            # load from internet
-            ImageManager.loading[imageurl] = None
-            callback = get_base64_saver(ImageManager.loading, imageurl)
-            loader = ImageLoader(imageurl, callback)
-            loader.start()
-            sublime.set_timeout_async(lambda: loader.join(), TIMEOUT * 1000)

imgs/README.md

@@ -1 +0,0 @@
-There is images here, allthough they aren't of any use for the plugin. They're just the image that I used to generate the base64 (404.txt and loading.txt)

live-testing/images.md

@@ -0,0 +1,18 @@
+I'm not sure that it **actually** going to work, but it seems nicer than the [previous version][prev]
+
+this is a test, hello world
+
+This is the first image from the local file system (absolute path, sorry, it's not going
+to work on your system unless your username is math2001):
+
+![The sublime text logo!](file:///home/math2001/.config/sublime-text-3/Packages/MarkdownLivePreview/live-testing/sublime_text.png)
+
+This is the first image from the local file system, *relative* path!
+
+![The sublime text logo!](sublime_merge.png)
+
+This is the first image from the internet!
+
+![math2001's logo](https://avatars1.githubusercontent.com/u/15224242?s=400&u=53324cf4e303d15032ba53aa41673a2046b3284b&v=4)
+
+[prev]: https://github.com/math2001/MarkdownLivePreview/tree/d4c477749ce7e77b8e9fc85464a2488f003c45bc

live-testing/test.md

@@ -0,0 +1,18 @@
+# hello world
+
+This is a *test*. Some inline `[2]code()`.
+
+what the hell...
+
+```python
+import this
+
+if input("answer yes") != 'yes':
+	print("Really?")
+```
+
+this flickering is really annoying...
+
+It looks like it's gone... Oh wait nah, it's still here...
+
+This should still be working, and it is!

loading.txt

@@ -1 +0,0 @@
-data:image/png;base64,R0lGODlhZABkAPU+AAAAAAwNDRweHyYpKzg8Pzo+QUBFSERJTEdMT05UV1NYXFVbX1hfY1lfZGFobWJpbmhvdGxzeHF5fnJ6gHV9g3Z+hHqDiXuEin+IjoCIjoKLkYKMkoSNk4eQl4iSmIqTmouUm42XnY+ZoJKco5OdpJOepZSeppahqJeiqZmjqpumrZ6psJ+qsqOutqSvt6SwuKezu6i0vKm1vay4wK66wq+7w6+8xLK+xrK/x7TAybXCy7bDy7jEzbjFzrzJ0gAAACH5BAUAAD4AIf8LTkVUU0NBUEUyLjADAQAAACwAAAAAZABkAAAG/kCfcEgsGo/IpHLJbDqf0Kh0Sq1ar9isdsvter/gsHhMLpvP6LR6zW673/C4fE6v2+/4vH7P7/v/gIGCg4SFhoeIiW8IAAAUilUpjQABkEsmMUchkwBIOTOQBQICGUabk0ctFhYdiSajAgOZRKeNRjkYqxaghyuwAgxFtZ1FJBe6NokHvya0nEUzuhYgijG/B86oRCDSOZAPv6VCw0SquiiWNwOwAzfjz0I8uasYPIMvDQ0kRhm/Ee/afKiQ1sIIDBAgkuUxQKDhA29ERMHK9GJSJR85pLUiwkOELgx6Goo0sG/IK1gVhCig9MjHimOreAmBMU+XngciRTrAMSQB/qxmR6KtEjGko7Shey7kbGgA6A0GBz4oOUjCno8YNXWp6NOCwVICD6UYPQqiBiANDHNOkILiqIYVg2Y0yPlAikddICASQtuwJJQY9OAimqFCZpRPei0pPnKjg4fHkB936JBYyg4VmDNrVlH5zYMFoEOLZgDBSoejqDfQEc1atBXUsOl8bi26bpUNsKWpnlPjg+PIj32brZJjs/HOi5PjiMFzCo4ZyAWpqCBhwgspMFa9NZRjg4TvEjZCEQFzWvQ9KiiA/+73SVtpGAT7mcFh/XcPVqH0uCsNhDs+J9gnAQXX+cADCSDMggRVVtGE2lZ6fCAgfkPcdYFhRAhlAVHxxfCnC4d42EdghtII1hYGLgjxki6GOSiNHtR990F+QpymizcZ0SNEjquI1+FHetDHQYFEuCANhBpaMMRAuqRYxEEJDSLPR1YlWVRN9Vjy3ioFCWHlEC6Uh44iOcB0gQck2kSEB90o4sEFx1yY5irQ9JdIDdIANcSXRBiDzGAfVcbnELiwmEgHx3Q5p5JGmOPjIdAF9eIRnyRnhA1AWvqEn4pq6umnoIYq6qiklmrqqaimquqqrLbq6quwxirrrLTWauuttwYBADs=

markdown2html.py

@@ -0,0 +1,138 @@
+""" Notice how this file is completely independent of sublime text
+
+I think it should be kept this way, just because it gives a bit more organisation,
+and makes it a lot easier to think about, and for anyone who would want to, test since
+markdown2html is just a pure function
+"""
+
+import os.path
+import concurrent.futures
+import urllib.request
+import base64
+import bs4
+
+from functools import partial
+
+from .lib.markdown2 import Markdown
+
+__all__ = ("markdown2html",)
+
+markdowner = Markdown(extras=["fenced-code-blocks"])
+
+# FIXME: how do I choose how many workers I want? Does thread pool reuse threads or
+#        does it stupidly throw them out? (we could implement something of our own)
+executor = concurrent.futures.ThreadPoolExecutor(max_workers=5)
+
+images_cache = {}
+
+
+class LoadingError(Exception):
+    pass
+
+
+def markdown2html(markdown, basepath, re_render, resources):
+    """ converts the markdown to html, loads the images and puts in base64 for sublime
+    to understand them correctly. That means that we are responsible for loading the
+    images from the internet. Hence, we take in re_render, which is just a function we 
+    call when an image has finished loading to retrigger a render (see #90)
+    """
+    html = markdowner.convert(markdown)
+
+    soup = bs4.BeautifulSoup(html, "html.parser")
+    for img_element in soup.find_all("img"):
+        src = img_element["src"]
+
+        # already in base64, or something of the like
+        # FIXME: what other types are possible? Are they handled by ST? If not, could we
+        #        convert it into base64? is it worth the effort?
+        if src.startswith("data:image/"):
+            continue
+
+        if src.startswith("http://") or src.startswith("https://"):
+            path = src
+        elif src.startswith("file://"):
+            path = src[len("file://") :]
+        else:
+            # expanduser: ~ -> /home/math2001
+            # realpath: simplify that paths so that we don't have duplicated caches
+            path = os.path.realpath(os.path.expanduser(os.path.join(basepath, src)))
+
+        try:
+            base64 = get_base64_image(path, re_render)
+        except FileNotFoundError as e:
+            base64 = resources["base64_404_image"]
+        except LoadingError:
+            base64 = resources["base64_loading_image"]
+
+        img_element["src"] = base64
+
+    # remove comments, because they pollute the console with error messages
+    for comment_element in soup.find_all(
+        text=lambda text: isinstance(text, bs4.Comment)
+    ):
+        comment_element.extract()
+
+    # FIXME: how do tables look? should we use ascii tables?
+
+    # pre aren't handled by ST3. The require manual adjustment
+    for pre_element in soup.find_all("pre"):
+        # select the first child, <code>
+        code_element = next(pre_element.children)
+
+        # FIXME: this method sucks, but can we do better?
+        fixed_pre = (
+            str(code_element)
+            .replace(" ", '<i class="space">.</i>')
+            .replace("\n", "<br />")
+        )
+
+        code_element.replace_with(bs4.BeautifulSoup(fixed_pre, "html.parser"))
+
+    # FIXME: highlight the code using Sublime's syntax
+
+    # FIXME: report that ST doesn't support <br/> but does work with <br />... WTF?
+    return "<style>\n{}\n</style>\n\n{}".format(resources["stylesheet"], soup).replace(
+        "<br/>", "<br />"
+    )
+
+
+def get_base64_image(path, re_render):
+    """ Gets the base64 for the image (local and remote images). re_render is a
+    callback which is called when we finish loading an image from the internet
+    to trigger an update of the preview (the image will then be loaded from the cache)
+    """
+
+    def callback(path, future):
+        # altering image_cache is "safe" to do because callback is called in the same
+        # thread as add_done_callback:
+        # > Added callables are called in the order that they were added and are always
+        # > called in a thread belonging to the process that added them
+        # > --- Python docs
+        images_cache[path] = future.result()
+        # we render, which means this function will be called again, but this time, we
+        # will read from the cache
+        re_render()
+
+    if path in images_cache:
+        return images_cache[path]
+
+    if path.startswith("http://") or path.startswith("https://"):
+        executor.submit(load_image, path).add_done_callback(partial(callback, path))
+        raise LoadingError()
+
+    with open(path, "rb") as fp:
+        image = "data:image/png;base64," + base64.b64encode(fp.read()).decode("utf-8")
+        images_cache[path] = image
+        return image
+
+
+def load_image(url):
+    with urllib.request.urlopen(url, timeout=60) as conn:
+        content_type = conn.info().get_content_type()
+        if "image" not in content_type:
+            raise ValueError(
+                "{!r} doesn't point to an image, but to a {!r}".format(
+                    url, content_type
+                )
+            )
+        return "data:image/png;base64," + base64.b64encode(conn.read()).decode("utf-8")

messages.json

@@ -1,4 +1,7 @@
 {
     "install": "messages/install.txt",
-    "1.1.2": "messages/1.1.2.txt"
+    "1.1.2": "messages/1.1.2.txt",
-}
+    "2.0.1": "messages/2.0.1.txt",
+    "2.2.1": "messages/2.2.0.txt",
+    "2.4.1": "messages/2.4.txt"
+}

messages/1.1.2.txt

@@ -1,4 +1,4 @@
-Sorry to interupt you... :(
+Sorry to interrupt you... :(
 
 Small changes occured on MarkdownLivePreview.
 
@@ -9,4 +9,4 @@ Main callback is now async (prevent ST from crashing)
 
 
 Tip of the day: Delete all the content till the end of the line: Ctrl+k, Ctrl+k
-                You'll use it much more than you think ;)
+                You'll use it much more than you think ;)

messages/2.0.1.txt

@@ -0,0 +1,22 @@
+Sorry to interrupt you... :(
+
+Some quite important changes have occured on MarkdownLivePreview.
+
+The first version was quite buggy: it made Sublime Text 3 crash. So I released
+a whole new version, which is working differently.
+
+When you active MarkdownLivePreview, it'll open a new window with the markdown
+view on the left, and the preview on the right.
+
+When you'll close any file in this window, it'll close the *entire* window.
+
+I hope you'll still enjoy using MarkdownLivePreview. If you have any request,
+just let me know by raising an issue here:
+
+github.com/math2001/MarkdownLivePreview/issues
+
+Tip of the day: you can duplicate a line by pressing 'ctrl+d'
+                        remove a line by pressing 'ctrl+shift+k'
+                        join lines by pressing 'ctrl+j'
+                get use to use these few shortcuts, and you'll speed up
+                significantly.

messages/2.1.0.txt

@@ -0,0 +1,8 @@
+Sorry to interrupt you... :(
+
+A settings is now available: `markdown_live_preview_on_open`. If set to true,
+it opens the window preview as soon as you open a markdown file. See the
+README for more infos.
+
+Tip of the day: `ctrl+w`: closes the current file
+                `ctrl+shift+w`: closes the current window

messages/2.2.0.txt

@@ -0,0 +1,8 @@
+Sorry to interrupt you... :(
+
+Something changed on MarkdownLivePreview: the preview is now scrolled to where
+you are editing your markdown file! It doesn't scroll back up all the time any
+more!
+
+Tip of the day: You can center the screen on your cursor by pressing:
+               `ctrl+k, ctrl+v` (on OSX `cmd+k, cmd+v`)

messages/2.4.txt

@@ -0,0 +1,10 @@
+Sorry to interrupt you... :(
+
+Some stuff changed on MarkdownLivePreview. It now supports YAML/TOML front matters. You can hide it,
+or show it in a pre block (edit your settings for this).
+
+Hope you'll enjoy it!
+
+Tip of the day: If you want a VIM-like search feature, then just press 'ctrl/cmd+i'
+                (Find → Incremental find). You can still go the next match by pressing 'f3', and to
+                the previous one by pressing 'shift+f3'

messages/install.txt

@@ -10,10 +10,10 @@ Thanks for installing MarkdownLivePreview! I hope you'll enjoy using it!
 Quick Start:
 ~~~~~~~~~~~~
 
-To enable MarkdownLivePreview, you need to me on a markdown view (works with
+To enable MarkdownLivePreview, you need to be on a markdown view (works with
 Markdown Extended). Then just press `alt+m`, or search up in the command
 palette: 'MarkdownLivePreview: Toggle'. Hit enter and you're done. As soon as
-you'll type anything in, it'll show up the preview in a new group.
+you type anything in, it'll show up with the preview in a new group.
 
 Say thanks:
 ~~~~~~~~~~~

resources/convertresources.py

@@ -0,0 +1,9 @@
+""" A small script to convert the images into base64 data """
+
+from base64 import b64encode
+
+with open("404.png", "rb") as png, open("404.base64", "wb") as base64:
+    base64.write(b64encode(png.read()))
+
+with open("loading.png", "rb") as png, open("loading.base64", "wb") as base64:
+    base64.write(b64encode(png.read()))

resources/loading.base64

@@ -0,0 +1 @@
+R0lGODlhZABkAPU+AAAAAAwNDRweHyYpKzg8Pzo+QUBFSERJTEdMT05UV1NYXFVbX1hfY1lfZGFobWJpbmhvdGxzeHF5fnJ6gHV9g3Z+hHqDiXuEin+IjoCIjoKLkYKMkoSNk4eQl4iSmIqTmouUm42XnY+ZoJKco5OdpJOepZSeppahqJeiqZmjqpumrZ6psJ+qsqOutqSvt6SwuKezu6i0vKm1vay4wK66wq+7w6+8xLK+xrK/x7TAybXCy7bDy7jEzbjFzrzJ0gAAACH5BAUAAD4AIf8LTkVUU0NBUEUyLjADAQAAACwAAAAAZABkAAAG/kCfcEgsGo/IpHLJbDqf0Kh0Sq1ar9isdsvter/gsHhMLpvP6LR6zW673/C4fE6v2+/4vH7P7/v/gIGCg4SFhoeIiW8IAAAUilUpjQABkEsmMUchkwBIOTOQBQICGUabk0ctFhYdiSajAgOZRKeNRjkYqxaghyuwAgxFtZ1FJBe6NokHvya0nEUzuhYgijG/B86oRCDSOZAPv6VCw0SquiiWNwOwAzfjz0I8uasYPIMvDQ0kRhm/Ee/afKiQ1sIIDBAgkuUxQKDhA29ERMHK9GJSJR85pLUiwkOELgx6Goo0sG/IK1gVhCig9MjHimOreAmBMU+XngciRTrAMSQB/qxmR6KtEjGko7Shey7kbGgA6A0GBz4oOUjCno8YNXWp6NOCwVICD6UYPQqiBiANDHNOkILiqIYVg2Y0yPlAikddICASQtuwJJQY9OAimqFCZpRPei0pPnKjg4fHkB936JBYyg4VmDNrVlH5zYMFoEOLZgDBSoejqDfQEc1atBXUsOl8bi26bpUNsKWpnlPjg+PIj32brZJjs/HOi5PjiMFzCo4ZyAWpqCBhwgspMFa9NZRjg4TvEjZCEQFzWvQ9KiiA/+73SVtpGAT7mcFh/XcPVqH0uCsNhDs+J9gnAQXX+cADCSDMggRVVtGE2lZ6fCAgfkPcdYFhRAhlAVHxxfCnC4d42EdghtII1hYGLgjxki6GOSiNHtR990F+QpymizcZ0SNEjquI1+FHetDHQYFEuCANhBpaMMRAuqRYxEEJDSLPR1YlWVRN9Vjy3ioFCWHlEC6Uh44iOcB0gQck2kSEB90o4sEFx1yY5irQ9JdIDdIANcSXRBiDzGAfVcbnELiwmEgHx3Q5p5JGmOPjIdAF9eIRnyRnhA1AWvqEn4pq6umnoIYq6qiklmrqqaimquqqrLbq6quwxirrrLTWauuttwYBADs=

resources/stylesheet.css

@@ -0,0 +1,44 @@
+html {
+    --light-bg: color(var(--background) blend(#fff 90%));
+    --very-light-bg: color(var(--background) blend(#fff 85%));
+}
+
+body {
+    font-family: "Ubuntu", "DejaVu Sans", "Open Sans", sans-serif;
+    font-size: 15px;
+}
+
+blockquote {
+    font-style: italic;
+    display: block;
+    margin-left: 30px;
+}
+
+pre {
+	display: block;
+	background-color: var(--very-light-bg);
+}
+
+code {
+    padding-left: 0.2rem;
+    padding-right: 0.2rem;
+    margin: 0;
+    border-radius: 3px;
+    background-color: red;
+}
+
+code {
+    padding-left: 0.2rem;
+    padding-right: 0.2rem;
+    background-color: var(--very-light-bg);
+    margin: 0;
+    border-radius: 3px;
+}
+
+pre code {
+    padding: 0;
+}
+
+i.space {
+    color: var(--very-light-bg);
+}

sample.md

@@ -1,19 +0,0 @@
-# DuckDuckGo - The Search engine you'll fall in love
-
-This is cool. The stylesheet's back!
-
-This is a test, and this is pretty cool!
-
-Hope you'll enjoy using MarkdownLivePreview!
-
-![Sublime Text Forum](https://forum.sublimetext.com/uploads/st-forum-wide.png)
-
-```python
-print(hello world)
-if DEBUG:
-    print('DEBUG_MODE on')
-```
-
-> Only a fool knows everything. A wise man knows how little he knows
-
-The only think I know right now is that Boxy Theme's just awesome.

setting_names.py

@@ -1,8 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-PREVIEW_ENABLED = 'markdown_live_preview_enabled'
-PREVIEW_ID = 'markdown_live_preview_id'
-IS_PREVIEW = 'is_markdown_live_preview'
-IS_HIDDEN = 'is_hidden_markdown_live_preview'
-MD_VIEW_ID = 'markdown_live_preview_md_id'
-PREVIEW_WINDOW = 'markdown_live_preview_window'

utils.py

@@ -0,0 +1,27 @@
+# import sublime
+import time
+
+
+def get_settings():
+    return sublime.get_settings("MarkdownLivePreview.sublime-settings")
+
+
+def min_time_between_call(timeout, on_block=lambda *args, **kwargs: None):
+    """ Enforces a timeout between each call to the function
+    timeout is in seconds
+    """
+    last_call = 0
+
+    def outer(func):
+        def wrapper(*args, **kwargs):
+            nonlocal last_call
+
+            if time.time() - last_call < timeout:
+                time.sleep(timeout - (time.time() - last_call))
+
+            last_call = time.time()
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return outer