Skip to content
Find file
Fetching contributors…
Cannot retrieve contributors at this time
320 lines (270 sloc) 10.4 KB
;;; js2r-vars.el --- Variable declaration manipulation functions for js2-refactor
;; Copyright (C) 2012-2014 Magnar Sveen
;; Copyright (C) 2015 Magnar Sveen and Nicolas Petton
;; Author: Magnar Sveen <>,
;; Nicolas Petton <>
;; Keywords: conveniences
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <>.
;;; Code:
(require 'multiple-cursors-core)
(require 'dash)
;; Helpers
(defun js2r--name-node-at-point (&optional pos)
(setq pos (or pos (point)))
(let ((current-node (js2-node-at-point pos)))
(unless (js2-name-node-p current-node)
(setq current-node (js2-node-at-point (- (point) 1))))
(if (not (and current-node (js2-name-node-p current-node)))
(error "Point is not on an identifier.")
(defun js2r--local-name-node-at-point (&optional pos)
(setq pos (or pos (point)))
(let ((current-node (js2r--name-node-at-point pos)))
(unless (js2r--local-name-node-p current-node)
(error "Point is not on a local identifier"))
(defun js2r--local-name-node-p (node)
(and (js2-name-node-p node)
(not (save-excursion ; not key in object literal { key: value }
(goto-char (+ (js2-node-abs-pos node) (js2-node-len node)))
(looking-at "[\n\t ]*:")))
(not (save-excursion ; not property lookup on object
(goto-char (js2-node-abs-pos node))
(looking-back "\\.[\n\t ]*")))))
(defun js2r--local-usages-of-name-node (name-node)
(unless (js2r--local-name-node-p name-node)
(error "Node is not on a local identifier"))
(let* ((name (js2-name-node-name name-node))
(scope (js2-node-get-enclosing-scope name-node))
(scope (js2-get-defining-scope scope name))
(current-start (js2-node-abs-pos name-node))
(current-end (+ current-start (js2-node-len name-node)))
(result nil))
(lambda (node end-p)
(when (and (not end-p)
(js2r--local-name-node-p node)
(string= name (js2-name-node-name node)))
(add-to-list 'result node))
(defun js2r--local-var-positions (name-node)
(-map 'js2-node-abs-pos (js2r--local-usages-of-name-node name-node)))
(defun js2r--var-defining-node (var-node)
(unless (js2r--local-name-node-p var-node)
(error "Node is not on a local identifier"))
(let* ((name (js2-name-node-name var-node))
(scope (js2-node-get-enclosing-scope var-node))
(scope (js2-get-defining-scope scope name)))
(js2-scope-get-symbol scope name))))
;; Add to jslint globals annotation
(defun current-line-contents ()
"Find the contents of the current line, minus indentation."
(buffer-substring (save-excursion (back-to-indentation) (point))
(save-excursion (end-of-line) (point))))
(require 'thingatpt)
(defun js2r-add-to-globals-annotation ()
(let ((var (thing-at-point 'symbol)))
(when (not (string-match "^/\\*global " (current-line-contents)))
(forward-line -1)
(insert "/*global */")
(forward-line -1))
(while (not (string-match "*/" (current-line-contents)))
(delete-char -2)
(unless (looking-back "global ")
(while (looking-back " ")
(delete-char -1))
(insert ", "))
(insert (concat var " */")))))
;; Rename variable
(defun js2r-rename-var ()
"Renames the variable on point and all occurrences in its lexical scope."
(let* ((current-node (js2r--local-name-node-at-point))
(len (js2-node-len current-node))
(current-start (js2-node-abs-pos current-node))
(current-end (+ current-start len)))
(push-mark current-end)
(goto-char current-start)
(mapc (lambda (beg)
(when (not (= beg current-start))
(goto-char beg)
(set-mark (+ beg len))
(js2r--local-var-positions current-node))))
(add-to-list 'mc--default-cmds-to-run-once 'js2r-rename-var)
;; Change local variable to use this. instead
(defun js2r-var-to-this ()
"Changes the variable on point to use this.var instead."
(let ((node (js2-node-at-point)))
(when (js2-var-decl-node-p node)
(let ((kids (js2-var-decl-node-kids node)))
(when (cdr kids)
(error "Currently does not support converting multivar statements."))
(goto-char (js2-node-abs-pos (car kids))))))
(--each (js2r--local-var-positions (js2r--local-name-node-at-point))
(goto-char it)
(when (looking-back "var ")
(delete-char -4))
(insert "this."))))
;; Inline var
(defun js2r-inline-var ()
(let* ((current-node (js2r--local-name-node-at-point))
(definer (js2r--var-defining-node current-node))
(definer-start (js2-node-abs-pos definer))
(var-init (js2-node-parent definer))
(initializer (js2-var-init-node-initializer
(unless initializer
(error "Var is not initialized when defined."))
(let* ((var-len (js2-node-len current-node))
(init-beg (js2-node-abs-pos initializer))
(init-end (+ init-beg (js2-node-len initializer)))
(var-init-beg (copy-marker (js2-node-abs-pos var-init)))
(var-init-end (copy-marker (+ var-init-beg (js2-node-len var-init))))
(contents (buffer-substring init-beg init-end)))
(mapc (lambda (beg)
(when (not (= beg definer-start))
(goto-char beg)
(delete-char var-len)
(insert contents)))
(js2r--local-var-positions current-node))
(js2r--delete-var-init var-init-beg var-init-end)))))
(defun js2r--was-single-var ()
(or (string= "var ;" (current-line-contents))
(string= "const ;" (current-line-contents))
(string= "let ;" (current-line-contents))
(string= "," (current-line-contents))))
(defun js2r--was-starting-var ()
(or (looking-back "var ")
(looking-back "const ")
(looking-back "let ")))
(defun js2r--was-ending-var ()
(looking-at ";"))
(defun js2r--delete-var-init (beg end)
(goto-char beg)
(delete-char (- end beg))
(delete-region (point-at-bol) (point-at-eol))
(delete-char 1)
(if (looking-at " ")
(delete-char 1)
(join-line -1)))
(if (looking-back ", ")
(delete-char -1)
(delete-char 1))
(delete-char -1))
(t (delete-char 2))))
;; two cases
;; - it's the only var -> remove the line
;; - there are several vars -> remove the node then clean up commas
;; Extract variable
(defun js2r--start-of-parent-stmt ()
(js2-node-abs-pos (js2r--closest-stmt-node)))
(defun js2r--object-literal-key-behind (pos)
(goto-char pos)
(when (looking-back "\\sw: ?")
(backward-char 2)
(js2-name-node-name (js2r--name-node-at-point)))))
(defun js2r--line-above-is-blank ()
(forward-line -1)
(string= "" (current-line-contents))))
(defun js2r-extract-var ()
(if (use-region-p)
(js2r--extract-var-between (region-beginning) (region-end))
(let ((node (js2r--closest-extractable-node)))
(js2r--extract-var-between (js2-node-abs-pos node)
(js2-node-abs-end node)))))
(add-to-list 'mc--default-cmds-to-run-once 'js2r-extract-var)
(defun js2r--extract-var-between (beg end)
(interactive "r")
(unless (js2r--single-complete-expression-between-p beg end)
(error "Can only extract single, complete expressions to var"))
(let ((deactivate-mark nil)
(expression (buffer-substring beg end))
(orig-var-end (make-marker))
(new-var-end (make-marker))
(name (or (js2r--object-literal-key-behind beg) "name")))
(delete-region beg end)
(insert name)
(set-marker orig-var-end (point))
(goto-char (js2r--start-of-parent-stmt))
(insert "var " name)
(set-marker new-var-end (point))
(insert " = " expression ";")
(when (or (js2r--line-above-is-blank)
(string-match-p "^function " expression))
(indent-region new-var-end orig-var-end)
(goto-char new-var-end)
(set-mark (- (point) (length name)))
(goto-char orig-var-end)
(set-mark (- (point) (length name)))
(set-marker orig-var-end nil)
(set-marker new-var-end nil))
(defun js2r-split-var-declaration ()
"Split a variable declaration into separate variable
declarations for each declared variable."
(let* ((declaration (or (js2r--closest #'js2-var-decl-node-p) (error "No var declaration at point.")))
(kids (js2-var-decl-node-kids declaration))
(stmt (js2-node-parent-stmt declaration)))
(goto-char (js2-node-abs-end stmt))
(mapc (lambda (kid)
(insert "var " (js2-node-string kid) ";")
(if (save-excursion
(goto-char (js2-node-abs-end kid))
(looking-at ", *\n *\n"))
(delete-char -1) ;; delete final newline
(let ((end (point)))
(js2r--goto-and-delete-node stmt)
(indent-region (point) end)))))
(provide 'js2r-vars)
;;; js2-vars.el ends here
Jump to Line
Something went wrong with that request. Please try again.