Browse Source

Maintenance: Rename some ill-named functions.

Carsten Dominik 16 years ago
parent
commit
1371205fc2
3 changed files with 30 additions and 20 deletions
  1. 10 0
      lisp/ChangeLog
  2. 18 18
      lisp/org-clock.el
  3. 2 2
      lisp/org.el

+ 10 - 0
lisp/ChangeLog

@@ -1,5 +1,15 @@
 2009-01-08  Carsten Dominik  <carsten.dominik@gmail.com>
 2009-01-08  Carsten Dominik  <carsten.dominik@gmail.com>
 
 
+	* org-timer.el (org-timer-mode-line-string): New variable.
+
+	* org-clock.el (org-clock-mode-line-map): Renamed from
+	`org-clock-mode-map'.
+	(org-clock-mode-line-timer): Renamed from `org-mode-line-timer'.
+	(org-clock-update-mode-line): Renamed from `org-update-mode-line'.
+	(org-clock-put-overlay): Renamed from `org-put-clock-overlay'.
+	(org-clock-remove-overlays): Renamed from
+	`org-remove-clock-overlays'.
+
 	* org-timer.el (org-timer-pause-or-continue): Implement stopping
 	* org-timer.el (org-timer-pause-or-continue): Implement stopping
 	and mode line display.
 	and mode line display.
 	(org-timer-stop): New command.
 	(org-timer-stop): New command.

+ 18 - 18
lisp/org-clock.el

@@ -140,7 +140,7 @@ load."
 (defvar org-mode-line-string "")
 (defvar org-mode-line-string "")
 (put 'org-mode-line-string 'risky-local-variable t)
 (put 'org-mode-line-string 'risky-local-variable t)
 
 
-(defvar org-mode-line-timer nil)
+(defvar org-clock-mode-line-timer nil)
 (defvar org-clock-heading "")
 (defvar org-clock-heading "")
 (defvar org-clock-heading-for-remember "")
 (defvar org-clock-heading-for-remember "")
 (defvar org-clock-start-time "")
 (defvar org-clock-start-time "")
@@ -156,8 +156,8 @@ of a different task.")
 (defvar org-clock-interrupted-task (make-marker)
 (defvar org-clock-interrupted-task (make-marker)
   "Marker pointing to the task that has been interrupted by the current clock.")
   "Marker pointing to the task that has been interrupted by the current clock.")
 
 
-(defvar org-clock-mode-map (make-sparse-keymap))
+(defvar org-clock-mode-line-map (make-sparse-keymap))
-(define-key org-clock-mode-map [mode-line mouse-2] 'org-clock-goto)
+(define-key org-clock-mode-line-map [mode-line mouse-2] 'org-clock-goto)
 
 
 (defun org-clock-history-push (&optional pos buffer)
 (defun org-clock-history-push (&optional pos buffer)
   "Push a marker to the clock history."
   "Push a marker to the clock history."
@@ -241,7 +241,7 @@ of a different task.")
 	(insert (format "[%c] %-15s %s\n" i cat task))
 	(insert (format "[%c] %-15s %s\n" i cat task))
 	(cons i marker)))))
 	(cons i marker)))))
 
 
-(defun org-update-mode-line ()
+(defun org-clock-update-mode-line ()
   (let* ((delta (- (time-to-seconds (current-time))
   (let* ((delta (- (time-to-seconds (current-time))
 		   (time-to-seconds org-clock-start-time)))
 		   (time-to-seconds org-clock-start-time)))
 	 (h (floor delta 3600))
 	 (h (floor delta 3600))
@@ -256,7 +256,7 @@ of a different task.")
 		 (org-propertize (substring clock-string 0 org-clock-string-limit)
 		 (org-propertize (substring clock-string 0 org-clock-string-limit)
 			     'help-echo (concat help-text ": " org-clock-heading))
 			     'help-echo (concat help-text ": " org-clock-heading))
 	       (org-propertize clock-string 'help-echo help-text)))
 	       (org-propertize clock-string 'help-echo help-text)))
-	   'local-map org-clock-mode-map
+	   'local-map org-clock-mode-line-map
 	   'mouse-face (if (featurep 'xemacs) 'highlight 'mode-line-highlight)))
 	   'mouse-face (if (featurep 'xemacs) 'highlight 'mode-line-highlight)))
     (force-mode-line-update)))
     (force-mode-line-update)))
 
 
@@ -363,9 +363,9 @@ the clocking selection, associated with the letter `d'."
 	    (or (memq 'org-mode-line-string global-mode-string)
 	    (or (memq 'org-mode-line-string global-mode-string)
 		(setq global-mode-string
 		(setq global-mode-string
 		      (append global-mode-string '(org-mode-line-string))))
 		      (append global-mode-string '(org-mode-line-string))))
-	    (org-update-mode-line)
+	    (org-clock-update-mode-line)
-	    (setq org-mode-line-timer
+	    (setq org-clock-mode-line-timer
-		  (run-with-timer 60 60 'org-update-mode-line))
+		  (run-with-timer 60 60 'org-clock-update-mode-line))
 	    (message "Clock started at %s" ts)))))))
 	    (message "Clock started at %s" ts)))))))
 
 
 (defun org-clock-find-position ()
 (defun org-clock-find-position ()
@@ -463,9 +463,9 @@ If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
 	(when org-log-note-clock-out
 	(when org-log-note-clock-out
 	  (org-add-log-setup 'clock-out nil nil nil
 	  (org-add-log-setup 'clock-out nil nil nil
 			     (concat "# Task: " (org-get-heading t) "\n\n")))
 			     (concat "# Task: " (org-get-heading t) "\n\n")))
-	(when org-mode-line-timer
+	(when org-clock-mode-line-timer
-	  (cancel-timer org-mode-line-timer)
+	  (cancel-timer org-clock-mode-line-timer)
-	  (setq org-mode-line-timer nil))
+	  (setq org-clock-mode-line-timer nil))
 	(setq global-mode-string
 	(setq global-mode-string
 	      (delq 'org-mode-line-string global-mode-string))
 	      (delq 'org-mode-line-string global-mode-string))
 	(force-mode-line-update)
 	(force-mode-line-update)
@@ -562,7 +562,7 @@ Puts the resulting times in minutes as a text property on each headline."
 If TOTAL-ONLY is non-nil, only show the total time for the entire file
 If TOTAL-ONLY is non-nil, only show the total time for the entire file
 in the echo area."
 in the echo area."
   (interactive)
   (interactive)
-  (org-remove-clock-overlays)
+  (org-clock-remove-overlays)
   (let (time h m p)
   (let (time h m p)
     (org-clock-sum)
     (org-clock-sum)
     (unless total-only
     (unless total-only
@@ -574,19 +574,19 @@ in the echo area."
 			    (point) :org-clock-minutes)))
 			    (point) :org-clock-minutes)))
 	  (goto-char p)
 	  (goto-char p)
 	  (when (setq time (get-text-property p :org-clock-minutes))
 	  (when (setq time (get-text-property p :org-clock-minutes))
-	    (org-put-clock-overlay time (funcall outline-level))))
+	    (org-clock-put-overlay time (funcall outline-level))))
 	(setq h (/ org-clock-file-total-minutes 60)
 	(setq h (/ org-clock-file-total-minutes 60)
 	      m (- org-clock-file-total-minutes (* 60 h)))
 	      m (- org-clock-file-total-minutes (* 60 h)))
 	;; Arrange to remove the overlays upon next change.
 	;; Arrange to remove the overlays upon next change.
 	(when org-remove-highlights-with-change
 	(when org-remove-highlights-with-change
-	  (org-add-hook 'before-change-functions 'org-remove-clock-overlays
+	  (org-add-hook 'before-change-functions 'org-clock-remove-overlays
 			nil 'local))))
 			nil 'local))))
     (message (concat "Total file time: " org-time-clocksum-format " (%d hours and %d minutes)") h m h m)))
     (message (concat "Total file time: " org-time-clocksum-format " (%d hours and %d minutes)") h m h m)))
 
 
 (defvar org-clock-overlays nil)
 (defvar org-clock-overlays nil)
 (make-variable-buffer-local 'org-clock-overlays)
 (make-variable-buffer-local 'org-clock-overlays)
 
 
-(defun org-put-clock-overlay (time &optional level)
+(defun org-clock-put-overlay (time &optional level)
   "Put an overlays on the current line, displaying TIME.
   "Put an overlays on the current line, displaying TIME.
 If LEVEL is given, prefix time with a corresponding number of stars.
 If LEVEL is given, prefix time with a corresponding number of stars.
 This creates a new overlay and stores it in `org-clock-overlays', so that it
 This creates a new overlay and stores it in `org-clock-overlays', so that it
@@ -613,7 +613,7 @@ will be easy to remove."
       (org-overlay-put ov 'end-glyph (make-glyph tx)))
       (org-overlay-put ov 'end-glyph (make-glyph tx)))
     (push ov org-clock-overlays)))
     (push ov org-clock-overlays)))
 
 
-(defun org-remove-clock-overlays (&optional beg end noremove)
+(defun org-clock-remove-overlays (&optional beg end noremove)
   "Remove the occur highlights from the buffer.
   "Remove the occur highlights from the buffer.
 BEG and END are ignored.  If NOREMOVE is nil, remove this function
 BEG and END are ignored.  If NOREMOVE is nil, remove this function
 from the `before-change-functions' in the current buffer."
 from the `before-change-functions' in the current buffer."
@@ -623,7 +623,7 @@ from the `before-change-functions' in the current buffer."
     (setq org-clock-overlays nil)
     (setq org-clock-overlays nil)
     (unless noremove
     (unless noremove
       (remove-hook 'before-change-functions
       (remove-hook 'before-change-functions
-		   'org-remove-clock-overlays 'local))))
+		   'org-clock-remove-overlays 'local))))
 
 
 (defvar state) ;; dynamically scoped into this function
 (defvar state) ;; dynamically scoped into this function
 (defun org-clock-out-if-current ()
 (defun org-clock-out-if-current ()
@@ -671,7 +671,7 @@ will be updated.  If not, a new clocktable will be inserted.
 When called with a prefix argument, move to the first clock table in the
 When called with a prefix argument, move to the first clock table in the
 buffer and update it."
 buffer and update it."
   (interactive "P")
   (interactive "P")
-  (org-remove-clock-overlays)
+  (org-clock-remove-overlays)
   (when arg
   (when arg
     (org-find-dblock "clocktable")
     (org-find-dblock "clocktable")
     (org-show-entry))
     (org-show-entry))

+ 2 - 2
lisp/org.el

@@ -2674,7 +2674,7 @@ If TABLE-TYPE is non-nil, also check for table.el-type tables."
    "org-clock"
    "org-clock"
    '(org-clock-in org-clock-out org-clock-cancel
    '(org-clock-in org-clock-out org-clock-cancel
 		  org-clock-goto org-clock-sum org-clock-display
 		  org-clock-goto org-clock-sum org-clock-display
-		  org-remove-clock-overlays org-clock-report
+		  org-clock-remove-overlays org-clock-report
 		  org-clocktable-shift org-dblock-write:clocktable
 		  org-clocktable-shift org-dblock-write:clocktable
 		  org-get-clocktable)))
 		  org-get-clocktable)))
 
 
@@ -13167,7 +13167,7 @@ This command does many different things, depending on context:
      ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
      ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
 	  org-occur-highlights
 	  org-occur-highlights
 	  org-latex-fragment-image-overlays)
 	  org-latex-fragment-image-overlays)
-      (and (boundp 'org-clock-overlays) (org-remove-clock-overlays))
+      (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
       (org-remove-occur-highlights)
       (org-remove-occur-highlights)
       (org-remove-latex-fragment-image-overlays)
       (org-remove-latex-fragment-image-overlays)
       (message "Temporary highlights/overlays removed from current buffer"))
       (message "Temporary highlights/overlays removed from current buffer"))