Skip to content

Allow rendering for buffers without a name/path #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
der-daniel wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Allow rendering for buffers without a name/path #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
206 changes: 108 additions & 98 deletions flymd.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,138 +39,148 @@
(require 'cl-lib)
(require 'browse-url)

(defgroup flymd nil
"Group for flymd"
:group 'markdown
(defgroup flymd nil
"Group for flymd"
:group 'markdown
:group 'convenience)

(defcustom flymd-refresh-interval 0.5
"Time to refresh the README."
(defcustom flymd-refresh-interval 0.5
"Time to refresh the README."
:group 'flymd)

(defcustom flymd-markdown-file-type
'("\\.md\\'" "\\.markdown\\'")
"Regexp to match markdown file."
:group 'flymd
(defcustom flymd-markdown-file-type '("\\.md\\'" "\\.markdown\\'")
"Regexp to match markdown file."
:group 'flymd
:type '(repeat string))

(defcustom flymd-browser-open-function nil
(defcustom flymd-browser-open-function nil
"Function used to open the browser.
It needs to accept one string argument which is the url.
If it is not defined, `browse-url-default-browser' is used."
:group 'flymd
If it is not defined, `browse-url-default-browser' is used."
:group 'flymd
:type 'function)

(defcustom flymd-output-directory nil
(defcustom flymd-output-directory nil
"The directory where flymd output files will be stored.
If nil, the working directory of the markdown file is used."
:group 'flymd
If nil, the working directory of the markdown file is used."
:group 'flymd
:type 'directory)

(defcustom flymd-close-buffer-delete-temp-files nil
(defcustom flymd-close-buffer-delete-temp-files nil
"If this is non-nil, flymd.md and flymd.html will be deleted
upon markdown buffer killed."
:group 'flymd
upon markdown buffer killed."
:group 'flymd
:type 'boolean)

(defvar flymd-markdown-regex nil
(defvar flymd-markdown-regex nil
"A concatenated verion of `flymd-markdown-file-type'.")

(defconst flymd-preview-html-filename "flymd.html"
(defconst flymd-preview-html-filename "flymd.html"
"File name for flymd html.")

(defconst flymd-preview-md-filename "flymd.md"
(defconst flymd-preview-md-filename "flymd.md"
"File name for flymd md.")

(defconst flymd-point-identifier "fLyMd-mAkEr"
(defconst flymd-point-identifier "fLyMd-mAkEr"
"Insert this at point to help auto scroll.")

(defvar flymd-timer nil
(defvar flymd-timer nil
"Store the flymd timer.")

(defvar flymd-markdown-buffer-list nil
(defvar flymd-markdown-buffer-list nil
"Store the markdown which has been flyit.")

;;;###autoload
(defun flymd-flyit ()
"Enable realtime markdown preview on the current buffer."
(interactive)
(unless flymd-markdown-regex
(setq flymd-markdown-regex (mapconcat 'identity flymd-markdown-file-type "\\|")))
(if (string-match-p flymd-markdown-regex (or (buffer-file-name) ""))
(let ((working-buffer (current-buffer))
(working-point (point)))
(flymd-copy-html (flymd-get-output-directory working-buffer))
(flymd-generate-readme working-buffer working-point)
(flymd-open-browser working-buffer)
(unless flymd-timer
(setq flymd-timer (run-with-idle-timer flymd-refresh-interval t 'flymd-generate-readme)))
(cl-pushnew working-buffer flymd-markdown-buffer-list :test 'eq)
(add-hook 'kill-buffer-hook #'flymd-unflyit t))
(message "What's wrong with you???!\nDon't flyit if you are not viewing a markdown file.")))

(defun flymd-copy-html (dir)
"Copy flymd.html to working directory DIR if it is no present."
(unless (file-exists-p (concat dir flymd-preview-html-filename))
(defun flymd-flyit ()
"Enable realtime markdown preview on the current buffer."
(interactive)
(let ((working-buffer (current-buffer))
(working-point (point)))
(flymd-copy-html (flymd-get-output-directory working-buffer))
(flymd-generate-readme working-buffer working-point)
(flymd-open-browser working-buffer)
(unless flymd-timer
(setq flymd-timer (run-with-idle-timer flymd-refresh-interval t 'flymd-generate-readme)))
(cl-pushnew working-buffer flymd-markdown-buffer-list
:test 'eq)
(add-hook 'kill-buffer-hook #'flymd-unflyit t)))

(defun flymd-copy-html (dir)
"Copy flymd.html to working directory DIR if it is no present."
(unless (file-exists-p (concat dir flymd-preview-html-filename))
(copy-file (concat (file-name-directory (locate-library "flymd")) flymd-preview-html-filename)
dir)
(unless (file-exists-p (concat dir flymd-preview-html-filename))
(error "Oops! Cannot copy %s to %s" flymd-preview-html-filename dir))))

(defun flymd-generate-readme (&optional buffer point)
"Save working markdown file from BUFFER to flymd.md and add identifier to POINT."
(when (or buffer (memq (current-buffer) flymd-markdown-buffer-list))
(setq buffer (or buffer (current-buffer)))
(setq point (or point (point)))
(with-temp-buffer
(insert-buffer-substring-no-properties buffer)
(goto-char point)
(when (string-match-p "\\````" (or (thing-at-point 'line t) ""))
(forward-line))
(end-of-line)
(insert flymd-point-identifier)
(write-region (point-min)
(point-max)
(concat (flymd-get-output-directory buffer) flymd-preview-md-filename)
nil
'hey-why-are-you-inspecting-my-source-code?))))

(defun flymd-open-browser (&optional buffer)
"Open the browser with the flymd.html if BUFFER succeeded converting to flymd.md."
(if (file-readable-p (concat (flymd-get-output-directory buffer) flymd-preview-md-filename))
(if flymd-browser-open-function
(funcall flymd-browser-open-function
(concat (flymd-get-output-directory buffer) flymd-preview-html-filename))
(browse-url (concat (flymd-get-output-directory buffer) flymd-preview-html-filename)))
(error "Oops! flymd cannot create preview markdown flymd.md")))

(defsubst flymd-delete-file-maybe (path)
"Delete flymd temp file under PATH if file exists."
(when flymd-close-buffer-delete-temp-files
(when (file-exists-p (concat path flymd-preview-md-filename))
(delete-file (concat path flymd-preview-md-filename)))
(when (file-exists-p (concat path flymd-preview-html-filename))
dir)
(unless (file-exists-p (concat dir flymd-preview-html-filename))
(error
"Oops! Cannot copy %s to %s"
flymd-preview-html-filename
dir))))

(defun flymd-generate-readme
(&optional
buffer
point)
"Save working markdown file from BUFFER to flymd.md and add identifier to POINT."
(when (or buffer
(memq (current-buffer) flymd-markdown-buffer-list))
(setq buffer (or buffer
(current-buffer)))
(setq point (or point
(point)))
(with-temp-buffer
(insert-buffer-substring-no-properties buffer)
(goto-char point)
(when (string-match-p "\\````" (or (thing-at-point 'line t)
""))
(forward-line))
(end-of-line)
(insert flymd-point-identifier)
(write-region (point-min)
(point-max)
(concat (flymd-get-output-directory buffer) flymd-preview-md-filename) nil
'hey-why-are-you-inspecting-my-source-code?))))

(defun flymd-open-browser
(&optional
buffer)
"Open the browser with the flymd.html if BUFFER succeeded converting to flymd.md."
(if (file-readable-p (concat (flymd-get-output-directory buffer) flymd-preview-md-filename))
(if flymd-browser-open-function
(funcall flymd-browser-open-function (concat (flymd-get-output-directory buffer)
flymd-preview-html-filename))
(browse-url (concat (flymd-get-output-directory buffer) flymd-preview-html-filename)))
(error
"Oops! flymd cannot create preview markdown flymd.md")))

(defsubst flymd-delete-file-maybe (path)
"Delete flymd temp file under PATH if file exists."
(when flymd-close-buffer-delete-temp-files
(when (file-exists-p (concat path flymd-preview-md-filename))
(delete-file (concat path flymd-preview-md-filename)))
(when (file-exists-p (concat path flymd-preview-html-filename))
(delete-file (concat path flymd-preview-html-filename)))))

(defun flymd-unflyit ()
"Untrack a markdown buffer in `flymd-markdown-buffer-list'."
(when (buffer-file-name)
(setq flymd-markdown-buffer-list (remq (current-buffer) flymd-markdown-buffer-list))
(flymd-delete-file-maybe (flymd-get-output-directory (current-buffer)))
(unless flymd-markdown-buffer-list
(when (timerp flymd-timer)
(cancel-timer flymd-timer))
(defun flymd-unflyit ()
"Untrack a markdown buffer in `flymd-markdown-buffer-list'."
(when (buffer-file-name)
(setq flymd-markdown-buffer-list (remq (current-buffer) flymd-markdown-buffer-list))
(flymd-delete-file-maybe (flymd-get-output-directory (current-buffer)))
(unless flymd-markdown-buffer-list
(when (timerp flymd-timer)
(cancel-timer flymd-timer))
(setq flymd-timer nil))))

(defun flymd-get-output-directory (buffer)
"Gets the correct output directory for flymd preview files of BUFFER."
(if flymd-output-directory
(let ((output-dir (file-name-as-directory
(concat (file-name-as-directory flymd-output-directory)
(secure-hash 'md5 (buffer-file-name buffer))))))
(make-directory output-dir t)
output-dir)
(file-name-directory (buffer-file-name buffer))))
(defun flymd-get-output-directory (buffer)
"Gets the correct output directory for flymd preview files of BUFFER."
(if flymd-output-directory
(let ((output-dir (file-name-as-directory (concat (file-name-as-directory
flymd-output-directory)
(secure-hash 'md5 (buffer-name buffer))))))
(make-directory output-dir t)
output-dir)
(if (buffer-file-name (current-buffer))
(file-name-directory (buffer-file-name buffer))
"/tmp/")))

(provide 'flymd)
;;; flymd.el ends here