Skip to content

Doc fixes #145

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

Closed
wants to merge 2 commits into from
Closed

Doc fixes #145

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
066ad3f
A bunch of small doc fixes
Mar 9, 2013
d791daf
Indentation adjustments
Mar 9, 2013
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
148 changes: 89 additions & 59 deletions clojure-mode.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@
;;; Commentary:

;; Provides font-lock, indentation, and navigation for the Clojure
;; language. (http://clojure.org)
;; language(http://clojure.org).

;; Users of older Emacs (pre-22) should get version 1.4:
;; http://github.com/technomancy/clojure-mode/tree/1.4

;; Slime integration has been removed; see the 1.x releases if you need it.

;; Using clojure-mode with paredit is highly recommended. Use paredit
;; Using clojure-mode with paredit is highly recommended. Use paredit
;; as you would with any other minor mode; for instance:
;;
;; ;; require or autoload paredit-mode
Expand Down Expand Up @@ -240,39 +240,39 @@
"(\\(?:\.*/\\)?"
(regexp-opt
'(;; clojure.inspector
"atom?" "collection-tag" "get-child" "get-child-count" "inspect"
"inspect-table" "inspect-tree" "is-leaf" "list-model" "list-provider"
;; clojure.main
"load-script" "main" "repl" "repl-caught" "repl-exception"
"repl-prompt" "repl-read" "skip-if-eol" "skip-whitespace" "with-bindings"
;; clojure.set
"difference" "index" "intersection" "join" "map-invert"
"project" "rename" "rename-keys" "select" "union"
;; clojure.stacktrace
"e" "print-cause-trace" "print-stack-trace" "print-throwable" "print-trace-element"
;; clojure.template
"do-template" "apply-template"
;; clojure.test
"*initial-report-counters*" "*load-tests*" "*report-counters*" "*stack-trace-depth*" "*test-out*"
"*testing-contexts*" "*testing-vars*" "are" "assert-any" "assert-expr"
"assert-predicate" "compose-fixtures" "deftest" "deftest-" "file-position"
"function?" "get-possibly-unbound-var" "inc-report-counter" "is" "join-fixtures"
"report" "run-all-tests" "run-tests" "set-test" "successful?"
"test-all-vars" "test-ns" "test-var" "testing" "testing-contexts-str"
"testing-vars-str" "try-expr" "use-fixtures" "with-test" "with-test-out"
;; clojure.walk
"keywordize-keys" "macroexpand-all" "postwalk" "postwalk-demo" "postwalk-replace"
"prewalk" "prewalk-demo" "prewalk-replace" "stringify-keys" "walk"
;; clojure.xml
"*current*" "*sb*" "*stack*" "*state*" "attrs"
"content" "content-handler" "element" "emit" "emit-element"
;; clojure.zip
"append-child" "branch?" "children" "down" "edit"
"end?" "insert-child" "insert-left" "insert-right" "left"
"leftmost" "lefts" "make-node" "next" "node"
"path" "prev" "remove" "replace" "right"
"rightmost" "rights" "root" "seq-zip" "up"
) t)
"atom?" "collection-tag" "get-child" "get-child-count" "inspect"
"inspect-table" "inspect-tree" "is-leaf" "list-model" "list-provider"
;; clojure.main
"load-script" "main" "repl" "repl-caught" "repl-exception"
"repl-prompt" "repl-read" "skip-if-eol" "skip-whitespace" "with-bindings"
;; clojure.set
"difference" "index" "intersection" "join" "map-invert"
"project" "rename" "rename-keys" "select" "union"
;; clojure.stacktrace
"e" "print-cause-trace" "print-stack-trace" "print-throwable" "print-trace-element"
;; clojure.template
"do-template" "apply-template"
;; clojure.test
"*initial-report-counters*" "*load-tests*" "*report-counters*" "*stack-trace-depth*" "*test-out*"
"*testing-contexts*" "*testing-vars*" "are" "assert-any" "assert-expr"
"assert-predicate" "compose-fixtures" "deftest" "deftest-" "file-position"
"function?" "get-possibly-unbound-var" "inc-report-counter" "is" "join-fixtures"
"report" "run-all-tests" "run-tests" "set-test" "successful?"
"test-all-vars" "test-ns" "test-var" "testing" "testing-contexts-str"
"testing-vars-str" "try-expr" "use-fixtures" "with-test" "with-test-out"
;; clojure.walk
"keywordize-keys" "macroexpand-all" "postwalk" "postwalk-demo" "postwalk-replace"
"prewalk" "prewalk-demo" "prewalk-replace" "stringify-keys" "walk"
;; clojure.xml
"*current*" "*sb*" "*stack*" "*state*" "attrs"
"content" "content-handler" "element" "emit" "emit-element"
;; clojure.zip
"append-child" "branch?" "children" "down" "edit"
"end?" "insert-child" "insert-left" "insert-right" "left"
"leftmost" "lefts" "make-node" "next" "node"
"path" "prev" "remove" "replace" "right"
"rightmost" "rights" "root" "seq-zip" "up"
) t)
"\\>")
1 font-lock-type-face)
;; Constant values (keywords), including as metadata e.g. ^:static
Expand All @@ -298,9 +298,9 @@
:group 'applications)

(defcustom clojure-mode-font-lock-comment-sexp nil
"Set to non-nil in order to enable font-lock of (comment...)
forms. This option is experimental. Changing this will require a
restart (ie. M-x clojure-mode) of existing clojure mode buffers."
"Set to non-nil in order to enable font-lock of (comment...) forms.
This option is experimental. Changing this will require a
restart of `clojure-mode' in currently opened clojure buffers."
:type 'boolean
:group 'clojure-mode)

Expand Down Expand Up @@ -339,7 +339,7 @@ Clojure to load that file."
(define-key map (kbd "C-c C-z") 'clojure-display-inferior-lisp-buffer)
(define-key map (kbd "C-c M-q") 'clojure-fill-docstring)
map)
"Keymap for Clojure mode. Inherits from `lisp-mode-shared-map'.")
"Keymap for Clojure mode. Inherits from `lisp-mode-shared-map'.")

(easy-menu-define clojure-mode-menu clojure-mode-map
"Menu for Clojure mode."
Expand Down Expand Up @@ -442,10 +442,10 @@ if that value is non-nil."
(interactive)
(if (and inferior-lisp-buffer (get-buffer inferior-lisp-buffer))
(pop-to-buffer inferior-lisp-buffer t)
(run-lisp inferior-lisp-program)))
(run-lisp inferior-lisp-program)))

(defun clojure-load-file (file-name)
"Load a Lisp file into the inferior Lisp process."
"Load a Clojure file FILE-NAME into the inferior Lisp process."
(interactive (comint-get-source "Load Clojure file: "
clojure-prev-l/c-dir/file
'(clojure-mode) t))
Expand All @@ -459,7 +459,7 @@ if that value is non-nil."


(defun clojure-match-next-def ()
"Scans the buffer backwards for the next top-level definition.
"Scan the buffer backwards for the next top level definition.
Called by `imenu--generic-function'."
(when (re-search-backward "^\\s *(def\\S *[ \n\t]+" nil t)
(save-excursion
Expand Down Expand Up @@ -570,17 +570,17 @@ in regular expression."

(defun clojure-find-block-comment-start (limit)
"Search for (comment...) or #_ style block comments and put
point at the beginning of the expression."
point at the beginning of the expression."
(let ((pos (re-search-forward "\\((comment\\>\\|#_\\)" limit t)))
(when pos
(forward-char (- (length (match-string 1))))
pos)))

(defun clojure-font-lock-extend-region-comment ()
"Move fontification boundaries to always contain
entire (comment ..) and #_ sexp. Does not work if you have a
white-space between ( and comment, but that is omitted to make
this run faster."
entire (comment ..) and #_ sexp. Does not work if you have a
white-space between ( and comment, but that is omitted to make
this run faster."
(let ((changed nil))
(goto-char font-lock-beg)
(condition-case nil (beginning-of-defun) (error nil))
Expand All @@ -596,7 +596,7 @@ in regular expression."
changed))

(defun clojure-font-lock-mark-comment (limit)
"Marks all (comment ..) and #_ forms with font-lock-comment-face."
"Mark all (comment ..) and #_ forms with font-lock-comment-face."
(let (pos)
(while (and (< (point) limit)
(setq pos (clojure-find-block-comment-start limit)))
Expand Down Expand Up @@ -711,8 +711,9 @@ This function also returns nil meaning don't specify the indentation."
indent-point state normal-indent)))))))

(defun clojure-backtracking-indent (indent-point state normal-indent)
"Experimental backtracking support. Will upwards in an sexp to
check for contextual indenting."
"Experimental backtracking support.

Will upwards in an sexp to check for contextual indenting."
(let (indent (path) (depth 0))
(goto-char (elt state 1))
(while (and (not indent)
Expand Down Expand Up @@ -772,7 +773,7 @@ check for contextual indenting."
(defmacro define-clojure-indent (&rest kvs)
`(progn
,@(mapcar (lambda (x) `(put-clojure-indent
(quote ,(first x)) ,(second x))) kvs)))
(quote ,(first x)) ,(second x))) kvs)))

(defun add-custom-clojure-indents (name value)
(custom-set-default name value)
Expand Down Expand Up @@ -848,11 +849,15 @@ use (put-clojure-indent 'some-symbol 'defun)."
;; clojure.test
(testing 1)
(deftest 'defun)
<<<<<<< HEAD
(are 1)
=======
>>>>>>> Indentation adjustments
(use-fixtures 'defun))



<<<<<<< HEAD
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;; Better docstring filling for clojure-mode
Expand All @@ -876,11 +881,31 @@ return nil."
(and (char-equal ?# (char-before beg)) (1- beg))
(when (not (char-equal ?# (char-before beg)))
beg))))))))
=======
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;; Better docstring filling for clojure-mode
;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defun clojure-string-start ()
"Return the position of the \" that begins the string at point."
(save-excursion
(save-match-data
;; Find a quote that appears immediately after whitespace,
;; beginning of line, or an open paren, brace, or bracket
(re-search-backward "\\(\\s-\\|^\\|(\\|\\[\\|{\\)\\(\"\\)")
(match-beginning 2))))
>>>>>>> Indentation adjustments

(defun clojure-char-at-point ()
"Return the char at point or nil if at buffer end."
(when (not (= (point) (point-max)))
<<<<<<< HEAD
(buffer-substring-no-properties (point) (1+ (point)))))
=======
(buffer-substring-no-properties (point) (1+ (point)))))
>>>>>>> Indentation adjustments

(defun clojure-char-before-point ()
"Return the char before point or nil if at buffer beginning."
Expand Down Expand Up @@ -925,10 +950,10 @@ returned."
(defun clojure-fill-docstring (&optional argument)
"Fill the definition that the point is on appropriate for Clojure.

Fills so that every paragraph has a minimum of two initial spaces,
with the exception of the first line. Fill margins are taken from
paragraph start, so a paragraph that begins with four spaces will
remain indented by four spaces after refilling."
Fills so that every paragraph has a minimum of two initial spaces,
with the exception of the first line. Fill margins are taken from
paragraph start, so a paragraph that begins with four spaces will
remain indented by four spaces after refilling."
(interactive "P")
(if (and (fboundp 'paredit-in-string-p) paredit-mode)
(unless (paredit-in-string-p)
Expand Down Expand Up @@ -1000,7 +1025,7 @@ returned."


(defun clojure-expected-ns ()
"Returns the namespace name that the file should have."
"Return the namespace name that the file should have."
(let* ((project-dir (file-truename
(locate-dominating-file default-directory
"project.clj")))
Expand All @@ -1009,12 +1034,14 @@ returned."
"_" "-" (mapconcat 'identity (cdr (split-string relative "/")) "."))))

(defun clojure-insert-ns-form ()
"Insert ns form at the beginning of the current buffer."
(interactive)
(goto-char (point-min))
(insert (format "(ns %s)" (clojure-expected-ns))))

(defun clojure-update-ns ()
"Updates the namespace of the current buffer. Useful if a file has been renamed."
"Update the namespace of the current buffer.
Useful if a file has been renamed."
(interactive)
(let ((nsname (clojure-expected-ns)))
(when nsname
Expand All @@ -1026,6 +1053,7 @@ returned."
(error "Namespace not found"))))))))

(defun clojure-find-ns ()
"Find the ns of the current buffer."
(let ((regexp clojure-namespace-name-regex))
(save-restriction
(save-excursion
Expand All @@ -1037,14 +1065,16 @@ returned."

;; Test navigation:
(defun clojure-in-tests-p ()
"Check if we're in a test file or ns."
(or (string-match-p "test\." (clojure-find-ns))
(string-match-p "/test" (buffer-file-name))))

(defun clojure-underscores-for-hyphens (namespace)
"Replace underscores in NAMESPACE with hyphens."
(replace-regexp-in-string "-" "_" namespace))

(defun clojure-test-for (namespace)
"Returns the path of the test file for the given namespace."
"Return the path of the test file for the given NAMESPACE."
(let* ((namespace (clojure-underscores-for-hyphens namespace))
(segments (split-string namespace "\\.")))
(format "%stest/%s_test.clj"
Expand All @@ -1053,15 +1083,15 @@ returned."
(mapconcat 'identity segments "/"))))

(defvar clojure-test-for-fn 'clojure-test-for
"Var pointing to the function that will return the full path of the
Clojure test file for the given namespace.")
"The function that will return the full path of the Clojure test file for the given namespace.")

(defun clojure-jump-to-test ()
"Jump from implementation file to test."
(interactive)
(find-file (funcall clojure-test-for-fn (clojure-find-ns))))

(defun clojure-jump-between-tests-and-code ()
"Jump between tests and code."
(interactive)
(if (clojure-in-tests-p)
(clojure-test-jump-to-implementation)
Expand Down