org-clock.el 92 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515
  1. ;;; org-clock.el --- The time clocking code for Org-mode
  2. ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
  3. ;; Free Software Foundation, Inc.
  4. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  5. ;; Keywords: outlines, hypermedia, calendar, wp
  6. ;; Homepage: http://orgmode.org
  7. ;; Version: 7.4
  8. ;;
  9. ;; This file is part of GNU Emacs.
  10. ;;
  11. ;; GNU Emacs is free software: you can redistribute it and/or modify
  12. ;; it under the terms of the GNU General Public License as published by
  13. ;; the Free Software Foundation, either version 3 of the License, or
  14. ;; (at your option) any later version.
  15. ;; GNU Emacs is distributed in the hope that it will be useful,
  16. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. ;; GNU General Public License for more details.
  19. ;; You should have received a copy of the GNU General Public License
  20. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  21. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  22. ;;
  23. ;;; Commentary:
  24. ;; This file contains the time clocking code for Org-mode
  25. (require 'org)
  26. ;;; Code:
  27. (eval-when-compile
  28. (require 'cl))
  29. (declare-function calendar-absolute-from-iso "cal-iso" (&optional date))
  30. (declare-function notifications-notify "notifications" (&rest params))
  31. (defvar org-time-stamp-formats)
  32. (defgroup org-clock nil
  33. "Options concerning clocking working time in Org-mode."
  34. :tag "Org Clock"
  35. :group 'org-progress)
  36. (defcustom org-clock-into-drawer org-log-into-drawer
  37. "Should clocking info be wrapped into a drawer?
  38. When t, clocking info will always be inserted into a :LOGBOOK: drawer.
  39. If necessary, the drawer will be created.
  40. When nil, the drawer will not be created, but used when present.
  41. When an integer and the number of clocking entries in an item
  42. reaches or exceeds this number, a drawer will be created.
  43. When a string, it names the drawer to be used.
  44. The default for this variable is the value of `org-log-into-drawer',
  45. which see."
  46. :group 'org-todo
  47. :group 'org-clock
  48. :type '(choice
  49. (const :tag "Always" t)
  50. (const :tag "Only when drawer exists" nil)
  51. (integer :tag "When at least N clock entries")
  52. (const :tag "Into LOGBOOK drawer" "LOGBOOK")
  53. (string :tag "Into Drawer named...")))
  54. (defcustom org-clock-out-when-done t
  55. "When non-nil, clock will be stopped when the clocked entry is marked DONE.
  56. DONE here means any DONE-like state.
  57. A nil value means clock will keep running until stopped explicitly with
  58. `C-c C-x C-o', or until the clock is started in a different item.
  59. Instead of t, this can also be a list of TODO states that should trigger
  60. clocking out."
  61. :group 'org-clock
  62. :type '(choice
  63. (const :tag "No" nil)
  64. (const :tag "Yes, when done" t)
  65. (repeat :tag "State list"
  66. (string :tag "TODO keyword"))))
  67. (defcustom org-clock-out-remove-zero-time-clocks nil
  68. "Non-nil means remove the clock line when the resulting time is zero."
  69. :group 'org-clock
  70. :type 'boolean)
  71. (defcustom org-clock-in-switch-to-state nil
  72. "Set task to a special todo state while clocking it.
  73. The value should be the state to which the entry should be
  74. switched. If the value is a function, it must take one
  75. parameter (the current TODO state of the item) and return the
  76. state to switch it to."
  77. :group 'org-clock
  78. :group 'org-todo
  79. :type '(choice
  80. (const :tag "Don't force a state" nil)
  81. (string :tag "State")
  82. (symbol :tag "Function")))
  83. (defcustom org-clock-out-switch-to-state nil
  84. "Set task to a special todo state after clocking out.
  85. The value should be the state to which the entry should be
  86. switched. If the value is a function, it must take one
  87. parameter (the current TODO state of the item) and return the
  88. state to switch it to."
  89. :group 'org-clock
  90. :group 'org-todo
  91. :type '(choice
  92. (const :tag "Don't force a state" nil)
  93. (string :tag "State")
  94. (symbol :tag "Function")))
  95. (defcustom org-clock-history-length 5
  96. "Number of clock tasks to remember in history."
  97. :group 'org-clock
  98. :type 'integer)
  99. (defcustom org-clock-goto-may-find-recent-task t
  100. "Non-nil means `org-clock-goto' can go to recent task if no active clock."
  101. :group 'org-clock
  102. :type 'boolean)
  103. (defcustom org-clock-heading-function nil
  104. "When non-nil, should be a function to create `org-clock-heading'.
  105. This is the string shown in the mode line when a clock is running.
  106. The function is called with point at the beginning of the headline."
  107. :group 'org-clock
  108. :type 'function)
  109. (defcustom org-clock-string-limit 0
  110. "Maximum length of clock strings in the modeline. 0 means no limit."
  111. :group 'org-clock
  112. :type 'integer)
  113. (defcustom org-clock-in-resume nil
  114. "If non-nil, resume clock when clocking into task with open clock.
  115. When clocking into a task with a clock entry which has not been closed,
  116. the clock can be resumed from that point."
  117. :group 'org-clock
  118. :type 'boolean)
  119. (defcustom org-clock-persist nil
  120. "When non-nil, save the running clock when Emacs is closed.
  121. The clock is resumed when Emacs restarts.
  122. When this is t, both the running clock, and the entire clock
  123. history are saved. When this is the symbol `clock', only the
  124. running clock is saved.
  125. When Emacs restarts with saved clock information, the file containing the
  126. running clock as well as all files mentioned in the clock history will
  127. be visited.
  128. All this depends on running `org-clock-persistence-insinuate' in .emacs"
  129. :group 'org-clock
  130. :type '(choice
  131. (const :tag "Just the running clock" clock)
  132. (const :tag "Just the history" history)
  133. (const :tag "Clock and history" t)
  134. (const :tag "No persistence" nil)))
  135. (defcustom org-clock-persist-file (convert-standard-filename
  136. "~/.emacs.d/org-clock-save.el")
  137. "File to save clock data to."
  138. :group 'org-clock
  139. :type 'string)
  140. (defcustom org-clock-persist-query-save nil
  141. "When non-nil, ask before saving the current clock on exit."
  142. :group 'org-clock
  143. :type 'boolean)
  144. (defcustom org-clock-persist-query-resume t
  145. "When non-nil, ask before resuming any stored clock during load."
  146. :group 'org-clock
  147. :type 'boolean)
  148. (defcustom org-clock-sound nil
  149. "Sound that will used for notifications.
  150. Possible values:
  151. nil no sound played.
  152. t standard Emacs beep
  153. file name play this sound file. If not possible, fall back to beep"
  154. :group 'org-clock
  155. :type '(choice
  156. (const :tag "No sound" nil)
  157. (const :tag "Standard beep" t)
  158. (file :tag "Play sound file")))
  159. (defcustom org-clock-modeline-total 'auto
  160. "Default setting for the time included for the modeline clock.
  161. This can be overruled locally using the CLOCK_MODELINE_TOTAL property.
  162. Allowed values are:
  163. current Only the time in the current instance of the clock
  164. today All time clocked into this task today
  165. repeat All time clocked into this task since last repeat
  166. all All time ever recorded for this task
  167. auto Automatically, either `all', or `repeat' for repeating tasks"
  168. :group 'org-clock
  169. :type '(choice
  170. (const :tag "Current clock" current)
  171. (const :tag "Today's task time" today)
  172. (const :tag "Since last repeat" repeat)
  173. (const :tag "All task time" all)
  174. (const :tag "Automatically, `all' or since `repeat'" auto)))
  175. (defcustom org-task-overrun-text nil
  176. "The extra modeline text that should indicate that the clock is overrun.
  177. The can be nil to indicate that instead of adding text, the clock time
  178. should get a different face (`org-mode-line-clock-overrun').
  179. When this is a string, it is prepended to the clock string as an indication,
  180. also using the face `org-mode-line-clock-overrun'."
  181. :group 'org-clock
  182. :type '(choice
  183. (const :tag "Just mark the time string" nil)
  184. (string :tag "Text to prepend")))
  185. (defcustom org-show-notification-handler nil
  186. "Function or program to send notification with.
  187. The function or program will be called with the notification
  188. string as argument."
  189. :group 'org-clock
  190. :type '(choice
  191. (string :tag "Program")
  192. (function :tag "Function")))
  193. (defgroup org-clocktable nil
  194. "Options concerning the clock table in Org-mode."
  195. :tag "Org Clock Table"
  196. :group 'org-clock)
  197. (defcustom org-clocktable-defaults
  198. `(list
  199. :maxlevel 2
  200. :lang ,org-export-default-language
  201. :scope 'file
  202. :block nil
  203. :tstart nil
  204. :tend nil
  205. :step nil
  206. :stepskip0 nil
  207. :fileskip0 nil
  208. :tags nil
  209. :emphasize nil
  210. :link nil
  211. :narrow '40!
  212. :indent t
  213. :formula nil
  214. :timestamp nil
  215. :level nil
  216. :tcolumns nil
  217. :formatter nil)
  218. "Default properties for clock tables."
  219. :group 'org-clock
  220. :type 'plist)
  221. (defcustom org-clock-clocktable-formatter 'org-clocktable-write-default
  222. "Function to turn clocking data into a table.
  223. For more information, see `org-clocktable-write-default'."
  224. :group 'org-clocktable
  225. :type 'function)
  226. (defcustom org-clock-clocktable-language-setup
  227. '(("en" "File" "L" "Timestamp" "Headline" "Time" "ALL" "Total time" "File time")
  228. ("es" "Archivo" "N" "Fecha y hora" "Tarea" "Tiempo" "TODO" "Tiempo total" "Tiempo archivo")
  229. ("fr" "Fichier" "N" "Horodatage" "En-tête" "Durée" "TOUT" "Durée totale" "Durée fichier")
  230. ("nl" "Bestand" "N" "Tijdstip" "Hoofding" "Duur" "ALLES" "Totale duur" "Bestandstijd"))
  231. "Terms used in clocktable, translated to different languages."
  232. :group 'org-clocktable
  233. :type 'alist)
  234. (defcustom org-clock-clocktable-default-properties '(:maxlevel 2 :scope file)
  235. "Default properties for new clocktables.
  236. These will be inserted into the BEGIN line, to make it easy for users to
  237. play with them."
  238. :group 'org-clocktable
  239. :type 'plist)
  240. (defcustom org-clock-idle-time nil
  241. "When non-nil, resolve open clocks if the user is idle more than X minutes."
  242. :group 'org-clock
  243. :type '(choice
  244. (const :tag "Never" nil)
  245. (integer :tag "After N minutes")))
  246. (defcustom org-clock-auto-clock-resolution 'when-no-clock-is-running
  247. "When to automatically resolve open clocks found in Org buffers."
  248. :group 'org-clock
  249. :type '(choice
  250. (const :tag "Never" nil)
  251. (const :tag "Always" t)
  252. (const :tag "When no clock is running" when-no-clock-is-running)))
  253. (defcustom org-clock-report-include-clocking-task nil
  254. "When non-nil, include the current clocking task time in clock reports."
  255. :group 'org-clock
  256. :type 'boolean)
  257. (defcustom org-clock-resolve-expert nil
  258. "Non-nil means do not show the splash buffer with the clock resolver."
  259. :group 'org-clock
  260. :type 'boolean)
  261. (defvar org-clock-in-prepare-hook nil
  262. "Hook run when preparing the clock.
  263. This hook is run before anything happens to the task that
  264. you want to clock in. For example, you can use this hook
  265. to add an effort property.")
  266. (defvar org-clock-in-hook nil
  267. "Hook run when starting the clock.")
  268. (defvar org-clock-out-hook nil
  269. "Hook run when stopping the current clock.")
  270. (defvar org-clock-cancel-hook nil
  271. "Hook run when cancelling the current clock.")
  272. (defvar org-clock-goto-hook nil
  273. "Hook run when selecting the currently clocked-in entry.")
  274. (defvar org-clock-has-been-used nil
  275. "Has the clock been used during the current Emacs session?")
  276. ;;; The clock for measuring work time.
  277. (defvar org-mode-line-string "")
  278. (put 'org-mode-line-string 'risky-local-variable t)
  279. (defvar org-clock-mode-line-timer nil)
  280. (defvar org-clock-idle-timer nil)
  281. (defvar org-clock-heading) ; defined in org.el
  282. (defvar org-clock-heading-for-remember "")
  283. (defvar org-clock-start-time "")
  284. (defvar org-clock-leftover-time nil
  285. "If non-nil, user cancelled a clock; this is when leftover time started.")
  286. (defvar org-clock-effort ""
  287. "Effort estimate of the currently clocking task.")
  288. (defvar org-clock-total-time nil
  289. "Holds total time, spent previously on currently clocked item.
  290. This does not include the time in the currently running clock.")
  291. (defvar org-clock-history nil
  292. "List of marker pointing to recent clocked tasks.")
  293. (defvar org-clock-default-task (make-marker)
  294. "Marker pointing to the default task that should clock time.
  295. The clock can be made to switch to this task after clocking out
  296. of a different task.")
  297. (defvar org-clock-interrupted-task (make-marker)
  298. "Marker pointing to the task that has been interrupted by the current clock.")
  299. (defvar org-clock-mode-line-map (make-sparse-keymap))
  300. (define-key org-clock-mode-line-map [mode-line mouse-2] 'org-clock-goto)
  301. (define-key org-clock-mode-line-map [mode-line mouse-1] 'org-clock-menu)
  302. (defun org-clock-menu ()
  303. (interactive)
  304. (popup-menu
  305. '("Clock"
  306. ["Clock out" org-clock-out t]
  307. ["Change effort estimate" org-clock-modify-effort-estimate t]
  308. ["Go to clock entry" org-clock-goto t]
  309. ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"])))
  310. (defun org-clock-history-push (&optional pos buffer)
  311. "Push a marker to the clock history."
  312. (setq org-clock-history-length (max 1 (min 35 org-clock-history-length)))
  313. (let ((m (move-marker (make-marker)
  314. (or pos (point)) (org-base-buffer
  315. (or buffer (current-buffer)))))
  316. n l)
  317. (while (setq n (member m org-clock-history))
  318. (move-marker (car n) nil))
  319. (setq org-clock-history
  320. (delq nil
  321. (mapcar (lambda (x) (if (marker-buffer x) x nil))
  322. org-clock-history)))
  323. (when (>= (setq l (length org-clock-history)) org-clock-history-length)
  324. (setq org-clock-history
  325. (nreverse
  326. (nthcdr (- l org-clock-history-length -1)
  327. (nreverse org-clock-history)))))
  328. (push m org-clock-history)))
  329. (defun org-clock-save-markers-for-cut-and-paste (beg end)
  330. "Save relative positions of markers in region."
  331. (org-check-and-save-marker org-clock-marker beg end)
  332. (org-check-and-save-marker org-clock-hd-marker beg end)
  333. (org-check-and-save-marker org-clock-default-task beg end)
  334. (org-check-and-save-marker org-clock-interrupted-task beg end)
  335. (mapc (lambda (m) (org-check-and-save-marker m beg end))
  336. org-clock-history))
  337. (defun org-clocking-buffer ()
  338. "Return the clocking buffer if we are currently clocking a task or nil."
  339. (marker-buffer org-clock-marker))
  340. (defun org-clocking-p ()
  341. "Return t when clocking a task."
  342. (not (equal (org-clocking-buffer) nil)))
  343. (defvar org-clock-before-select-task-hook nil
  344. "Hook called in task selection just before prompting the user.")
  345. (defun org-clock-select-task (&optional prompt)
  346. "Select a task that recently was associated with clocking."
  347. (interactive)
  348. (let (sel-list rpl (i 0) s)
  349. (save-window-excursion
  350. (org-switch-to-buffer-other-window
  351. (get-buffer-create "*Clock Task Select*"))
  352. (erase-buffer)
  353. (when (marker-buffer org-clock-default-task)
  354. (insert (org-add-props "Default Task\n" nil 'face 'bold))
  355. (setq s (org-clock-insert-selection-line ?d org-clock-default-task))
  356. (push s sel-list))
  357. (when (marker-buffer org-clock-interrupted-task)
  358. (insert (org-add-props "The task interrupted by starting the last one\n" nil 'face 'bold))
  359. (setq s (org-clock-insert-selection-line ?i org-clock-interrupted-task))
  360. (push s sel-list))
  361. (when (org-clocking-p)
  362. (insert (org-add-props "Current Clocking Task\n" nil 'face 'bold))
  363. (setq s (org-clock-insert-selection-line ?c org-clock-marker))
  364. (push s sel-list))
  365. (insert (org-add-props "Recent Tasks\n" nil 'face 'bold))
  366. (mapc
  367. (lambda (m)
  368. (when (marker-buffer m)
  369. (setq i (1+ i)
  370. s (org-clock-insert-selection-line
  371. (if (< i 10)
  372. (+ i ?0)
  373. (+ i (- ?A 10))) m))
  374. (if (fboundp 'int-to-char) (setf (car s) (int-to-char (car s))))
  375. (push s sel-list)))
  376. org-clock-history)
  377. (run-hooks 'org-clock-before-select-task-hook)
  378. (org-fit-window-to-buffer)
  379. (message (or prompt "Select task for clocking:"))
  380. (setq rpl (read-char-exclusive))
  381. (cond
  382. ((eq rpl ?q) nil)
  383. ((eq rpl ?x) nil)
  384. ((assoc rpl sel-list) (cdr (assoc rpl sel-list)))
  385. (t (error "Invalid task choice %c" rpl))))))
  386. (defun org-clock-insert-selection-line (i marker)
  387. "Insert a line for the clock selection menu.
  388. And return a cons cell with the selection character integer and the marker
  389. pointing to it."
  390. (when (marker-buffer marker)
  391. (let (file cat task heading prefix)
  392. (with-current-buffer (org-base-buffer (marker-buffer marker))
  393. (save-excursion
  394. (save-restriction
  395. (widen)
  396. (ignore-errors
  397. (goto-char marker)
  398. (setq file (buffer-file-name (marker-buffer marker))
  399. cat (org-get-category)
  400. heading (org-get-heading 'notags)
  401. prefix (save-excursion
  402. (org-back-to-heading t)
  403. (looking-at "\\*+ ")
  404. (match-string 0))
  405. task (substring
  406. (org-fontify-like-in-org-mode
  407. (concat prefix heading)
  408. org-odd-levels-only)
  409. (length prefix)))))))
  410. (when (and cat task)
  411. (insert (format "[%c] %-15s %s\n" i cat task))
  412. (cons i marker)))))
  413. (defvar org-task-overrun nil
  414. "Internal flag indicating if the clock has overrun the planned time.")
  415. (defvar org-clock-update-period 60
  416. "Number of seconds between mode line clock string updates.")
  417. (defun org-clock-get-clock-string ()
  418. "Form a clock-string, that will be shown in the mode line.
  419. If an effort estimate was defined for the current item, use
  420. 01:30/01:50 format (clocked/estimated).
  421. If not, show simply the clocked time like 01:50."
  422. (let* ((clocked-time (org-clock-get-clocked-time))
  423. (h (floor clocked-time 60))
  424. (m (- clocked-time (* 60 h))))
  425. (if org-clock-effort
  426. (let* ((effort-in-minutes
  427. (org-hh:mm-string-to-minutes org-clock-effort))
  428. (effort-h (floor effort-in-minutes 60))
  429. (effort-m (- effort-in-minutes (* effort-h 60)))
  430. (work-done-str
  431. (org-propertize
  432. (format org-time-clocksum-format h m)
  433. 'face (if (and org-task-overrun (not org-task-overrun-text))
  434. 'org-mode-line-clock-overrun 'org-mode-line-clock)))
  435. (effort-str (format org-time-clocksum-format effort-h effort-m))
  436. (clockstr (org-propertize
  437. (concat "[%s/" effort-str
  438. "] (" (replace-regexp-in-string "%" "%%" org-clock-heading) ")")
  439. 'face 'org-mode-line-clock)))
  440. (format clockstr work-done-str))
  441. (org-propertize (format
  442. (concat "[" org-time-clocksum-format " (%s)]")
  443. h m org-clock-heading)
  444. 'face 'org-mode-line-clock))))
  445. (defun org-clock-update-mode-line ()
  446. (if org-clock-effort
  447. (org-clock-notify-once-if-expired)
  448. (setq org-task-overrun nil))
  449. (setq org-mode-line-string
  450. (org-propertize
  451. (let ((clock-string (org-clock-get-clock-string))
  452. (help-text "Org-mode clock is running.\nmouse-1 shows a menu\nmouse-2 will jump to task"))
  453. (if (and (> org-clock-string-limit 0)
  454. (> (length clock-string) org-clock-string-limit))
  455. (org-propertize
  456. (substring clock-string 0 org-clock-string-limit)
  457. 'help-echo (concat help-text ": " org-clock-heading))
  458. (org-propertize clock-string 'help-echo help-text)))
  459. 'local-map org-clock-mode-line-map
  460. 'mouse-face (if (featurep 'xemacs) 'highlight 'mode-line-highlight)
  461. ))
  462. (if (and org-task-overrun org-task-overrun-text)
  463. (setq org-mode-line-string
  464. (concat (org-propertize
  465. org-task-overrun-text
  466. 'face 'org-mode-line-clock-overrun) org-mode-line-string)))
  467. (force-mode-line-update))
  468. (defun org-clock-get-clocked-time ()
  469. "Get the clocked time for the current item in minutes.
  470. The time returned includes the time spent on this task in
  471. previous clocking intervals."
  472. (let ((currently-clocked-time
  473. (floor (- (org-float-time)
  474. (org-float-time org-clock-start-time)) 60)))
  475. (+ currently-clocked-time (or org-clock-total-time 0))))
  476. (defun org-clock-modify-effort-estimate (&optional value)
  477. "Add to or set the effort estimate of the item currently being clocked.
  478. VALUE can be a number of minutes, or a string with format hh:mm or mm.
  479. When the string starts with a + or a - sign, the current value of the effort
  480. property will be changed by that amount.
  481. This will update the \"Effort\" property of currently clocked item, and
  482. the mode line."
  483. (interactive)
  484. (when (org-clock-is-active)
  485. (let ((current org-clock-effort) sign)
  486. (unless value
  487. ;; Prompt user for a value or a change
  488. (setq value
  489. (read-string
  490. (format "Set effort (hh:mm or mm%s): "
  491. (if current
  492. (format ", prefix + to add to %s" org-clock-effort)
  493. "")))))
  494. (when (stringp value)
  495. ;; A string. See if it is a delta
  496. (setq sign (string-to-char value))
  497. (if (member sign '(?- ?+))
  498. (setq current (org-hh:mm-string-to-minutes current)
  499. value (substring value 1))
  500. (setq current 0))
  501. (setq value (org-hh:mm-string-to-minutes value))
  502. (if (equal ?- sign)
  503. (setq value (- current value))
  504. (if (equal ?+ sign) (setq value (+ current value)))))
  505. (setq value (max 0 value)
  506. org-clock-effort (org-minutes-to-hh:mm-string value))
  507. (org-entry-put org-clock-marker "Effort" org-clock-effort)
  508. (org-clock-update-mode-line)
  509. (message "Effort is now %s" org-clock-effort))))
  510. (defvar org-clock-notification-was-shown nil
  511. "Shows if we have shown notification already.")
  512. (defun org-clock-notify-once-if-expired ()
  513. "Show notification if we spent more time than we estimated before.
  514. Notification is shown only once."
  515. (when (org-clocking-p)
  516. (let ((effort-in-minutes (org-hh:mm-string-to-minutes org-clock-effort))
  517. (clocked-time (org-clock-get-clocked-time)))
  518. (if (setq org-task-overrun
  519. (if (or (null effort-in-minutes) (zerop effort-in-minutes))
  520. nil
  521. (>= clocked-time effort-in-minutes)))
  522. (unless org-clock-notification-was-shown
  523. (setq org-clock-notification-was-shown t)
  524. (org-notify
  525. (format "Task '%s' should be finished by now. (%s)"
  526. org-clock-heading org-clock-effort) t))
  527. (setq org-clock-notification-was-shown nil)))))
  528. (defun org-notify (notification &optional play-sound)
  529. "Send a NOTIFICATION and maybe PLAY-SOUND."
  530. (org-show-notification notification)
  531. (if play-sound (org-clock-play-sound)))
  532. (defun org-show-notification (notification)
  533. "Show notification.
  534. Use `org-show-notification-handler' if defined,
  535. use libnotify if available, or fall back on a message."
  536. (cond ((functionp org-show-notification-handler)
  537. (funcall org-show-notification-handler notification))
  538. ((stringp org-show-notification-handler)
  539. (start-process "emacs-timer-notification" nil
  540. org-show-notification-handler notification))
  541. ((featurep 'notifications)
  542. (require 'notifications)
  543. (notifications-notify
  544. :title "Org-mode message"
  545. :body notification
  546. ;; FIXME how to link to the Org icon?
  547. ;; :app-icon "~/.emacs.d/icons/mail.png"
  548. :urgency 'low))
  549. ((org-program-exists "notify-send")
  550. (start-process "emacs-timer-notification" nil
  551. "notify-send" notification))
  552. ;; Maybe the handler will send a message, so only use message as
  553. ;; a fall back option
  554. (t (message "%s" notification))))
  555. (defun org-clock-play-sound ()
  556. "Play sound as configured by `org-clock-sound'.
  557. Use alsa's aplay tool if available."
  558. (cond
  559. ((not org-clock-sound))
  560. ((eq org-clock-sound t) (beep t) (beep t))
  561. ((stringp org-clock-sound)
  562. (let ((file (expand-file-name org-clock-sound)))
  563. (if (file-exists-p file)
  564. (if (org-program-exists "aplay")
  565. (start-process "org-clock-play-notification" nil
  566. "aplay" file)
  567. (condition-case nil
  568. (play-sound-file file)
  569. (error (beep t) (beep t)))))))))
  570. (defun org-program-exists (program-name)
  571. "Checks whenever we can locate program and launch it."
  572. (if (eq system-type 'gnu/linux)
  573. (= 0 (call-process "which" nil nil nil program-name))))
  574. (defvar org-clock-mode-line-entry nil
  575. "Information for the modeline about the running clock.")
  576. (defun org-find-open-clocks (file)
  577. "Search through the given file and find all open clocks."
  578. (let ((buf (or (get-file-buffer file)
  579. (find-file-noselect file)))
  580. clocks)
  581. (with-current-buffer buf
  582. (save-excursion
  583. (goto-char (point-min))
  584. (while (re-search-forward "CLOCK: \\(\\[.*?\\]\\)$" nil t)
  585. (push (cons (copy-marker (match-end 1) t)
  586. (org-time-string-to-time (match-string 1))) clocks))))
  587. clocks))
  588. (defsubst org-is-active-clock (clock)
  589. "Return t if CLOCK is the currently active clock."
  590. (and (org-clock-is-active)
  591. (= org-clock-marker (car clock))))
  592. (defmacro org-with-clock-position (clock &rest forms)
  593. "Evaluate FORMS with CLOCK as the current active clock."
  594. `(with-current-buffer (marker-buffer (car ,clock))
  595. (save-excursion
  596. (save-restriction
  597. (widen)
  598. (goto-char (car ,clock))
  599. (beginning-of-line)
  600. ,@forms))))
  601. (put 'org-with-clock-position 'lisp-indent-function 1)
  602. (defmacro org-with-clock (clock &rest forms)
  603. "Evaluate FORMS with CLOCK as the current active clock.
  604. This macro also protects the current active clock from being altered."
  605. `(org-with-clock-position ,clock
  606. (let ((org-clock-start-time (cdr ,clock))
  607. (org-clock-total-time)
  608. (org-clock-history)
  609. (org-clock-effort)
  610. (org-clock-marker (car ,clock))
  611. (org-clock-hd-marker (save-excursion
  612. (outline-back-to-heading t)
  613. (point-marker))))
  614. ,@forms)))
  615. (put 'org-with-clock 'lisp-indent-function 1)
  616. (defsubst org-clock-clock-in (clock &optional resume start-time)
  617. "Clock in to the clock located by CLOCK.
  618. If necessary, clock-out of the currently active clock."
  619. (org-with-clock-position clock
  620. (let ((org-clock-in-resume (or resume org-clock-in-resume)))
  621. (org-clock-in nil start-time))))
  622. (defsubst org-clock-clock-out (clock &optional fail-quietly at-time)
  623. "Clock out of the clock located by CLOCK."
  624. (let ((temp (copy-marker (car clock)
  625. (marker-insertion-type (car clock)))))
  626. (if (org-is-active-clock clock)
  627. (org-clock-out fail-quietly at-time)
  628. (org-with-clock clock
  629. (org-clock-out fail-quietly at-time)))
  630. (setcar clock temp)))
  631. (defsubst org-clock-clock-cancel (clock)
  632. "Cancel the clock located by CLOCK."
  633. (let ((temp (copy-marker (car clock)
  634. (marker-insertion-type (car clock)))))
  635. (if (org-is-active-clock clock)
  636. (org-clock-cancel)
  637. (org-with-clock clock
  638. (org-clock-cancel)))
  639. (setcar clock temp)))
  640. (defvar org-clock-clocking-in nil)
  641. (defvar org-clock-resolving-clocks nil)
  642. (defvar org-clock-resolving-clocks-due-to-idleness nil)
  643. (defun org-clock-resolve-clock (clock resolve-to clock-out-time
  644. &optional close-p restart-p fail-quietly)
  645. "Resolve `CLOCK' given the time `RESOLVE-TO', and the present.
  646. `CLOCK' is a cons cell of the form (MARKER START-TIME)."
  647. (let ((org-clock-resolving-clocks t))
  648. (cond
  649. ((null resolve-to)
  650. (org-clock-clock-cancel clock)
  651. (if (and restart-p (not org-clock-clocking-in))
  652. (org-clock-clock-in clock)))
  653. ((eq resolve-to 'now)
  654. (if restart-p
  655. (error "RESTART-P is not valid here"))
  656. (if (or close-p org-clock-clocking-in)
  657. (org-clock-clock-out clock fail-quietly)
  658. (unless (org-is-active-clock clock)
  659. (org-clock-clock-in clock t))))
  660. ((not (time-less-p resolve-to (current-time)))
  661. (error "RESOLVE-TO must refer to a time in the past"))
  662. (t
  663. (if restart-p
  664. (error "RESTART-P is not valid here"))
  665. (org-clock-clock-out clock fail-quietly (or clock-out-time
  666. resolve-to))
  667. (unless org-clock-clocking-in
  668. (if close-p
  669. (setq org-clock-leftover-time (and (null clock-out-time)
  670. resolve-to))
  671. (org-clock-clock-in clock nil (and clock-out-time
  672. resolve-to))))))))
  673. (defun org-clock-jump-to-current-clock (&optional effective-clock)
  674. (interactive)
  675. (let ((clock (or effective-clock (cons org-clock-marker
  676. org-clock-start-time))))
  677. (unless (marker-buffer (car clock))
  678. (error "No clock is currently running"))
  679. (org-with-clock clock (org-clock-goto))
  680. (with-current-buffer (marker-buffer (car clock))
  681. (goto-char (car clock))
  682. (if org-clock-into-drawer
  683. (let ((logbook
  684. (if (stringp org-clock-into-drawer)
  685. (concat ":" org-clock-into-drawer ":")
  686. ":LOGBOOK:")))
  687. (ignore-errors
  688. (outline-flag-region
  689. (save-excursion
  690. (outline-back-to-heading t)
  691. (search-forward logbook)
  692. (goto-char (match-beginning 0)))
  693. (save-excursion
  694. (outline-back-to-heading t)
  695. (search-forward logbook)
  696. (search-forward ":END:")
  697. (goto-char (match-end 0)))
  698. nil)))))))
  699. (defun org-clock-resolve (clock &optional prompt-fn last-valid fail-quietly)
  700. "Resolve an open org-mode clock.
  701. An open clock was found, with `dangling' possibly being non-nil.
  702. If this function was invoked with a prefix argument, non-dangling
  703. open clocks are ignored. The given clock requires some sort of
  704. user intervention to resolve it, either because a clock was left
  705. dangling or due to an idle timeout. The clock resolution can
  706. either be:
  707. (a) deleted, the user doesn't care about the clock
  708. (b) restarted from the current time (if no other clock is open)
  709. (c) closed, giving the clock X minutes
  710. (d) closed and then restarted
  711. (e) resumed, as if the user had never left
  712. The format of clock is (CONS MARKER START-TIME), where MARKER
  713. identifies the buffer and position the clock is open at (and
  714. thus, the heading it's under), and START-TIME is when the clock
  715. was started."
  716. (assert clock)
  717. (let* ((ch
  718. (save-window-excursion
  719. (save-excursion
  720. (unless org-clock-resolving-clocks-due-to-idleness
  721. (org-clock-jump-to-current-clock clock))
  722. (unless org-clock-resolve-expert
  723. (with-output-to-temp-buffer "*Org Clock*"
  724. (princ "Select a Clock Resolution Command:
  725. i/q/C-g Ignore this question; the same as keeping all the idle time.
  726. k/K Keep X minutes of the idle time (default is all). If this
  727. amount is less than the default, you will be clocked out
  728. that many minutes after the time that idling began, and then
  729. clocked back in at the present time.
  730. g/G Indicate that you \"got back\" X minutes ago. This is quite
  731. different from 'k': it clocks you out from the beginning of
  732. the idle period and clock you back in X minutes ago.
  733. s/S Subtract the idle time from the current clock. This is the
  734. same as keeping 0 minutes.
  735. C Cancel the open timer altogether. It will be as though you
  736. never clocked in.
  737. j/J Jump to the current clock, to make manual adjustments.
  738. For all these options, using uppercase makes your final state
  739. to be CLOCKED OUT.")))
  740. (org-fit-window-to-buffer (get-buffer-window "*Org Clock*"))
  741. (let (char-pressed)
  742. (when (featurep 'xemacs)
  743. (message (concat (funcall prompt-fn clock)
  744. " [jkKgGsScCiq]? "))
  745. (setq char-pressed (read-char-exclusive)))
  746. (while (or (null char-pressed)
  747. (and (not (memq char-pressed
  748. '(?k ?K ?g ?G ?s ?S ?C
  749. ?j ?J ?i ?q)))
  750. (or (ding) t)))
  751. (setq char-pressed
  752. (read-char (concat (funcall prompt-fn clock)
  753. " [jkKgGSscCiq]? ")
  754. nil 45)))
  755. (and (not (memq char-pressed '(?i ?q))) char-pressed)))))
  756. (default
  757. (floor (/ (org-float-time
  758. (time-subtract (current-time) last-valid)) 60)))
  759. (keep
  760. (and (memq ch '(?k ?K))
  761. (read-number "Keep how many minutes? " default)))
  762. (gotback
  763. (and (memq ch '(?g ?G))
  764. (read-number "Got back how many minutes ago? " default)))
  765. (subtractp (memq ch '(?s ?S)))
  766. (barely-started-p (< (- (org-float-time last-valid)
  767. (org-float-time (cdr clock))) 45))
  768. (start-over (and subtractp barely-started-p)))
  769. (cond
  770. ((memq ch '(?j ?J))
  771. (if (eq ch ?J)
  772. (org-clock-resolve-clock clock 'now nil t nil fail-quietly))
  773. (org-clock-jump-to-current-clock clock))
  774. ((or (null ch)
  775. (not (memq ch '(?k ?K ?g ?G ?s ?S ?C))))
  776. (message ""))
  777. (t
  778. (org-clock-resolve-clock
  779. clock (cond
  780. ((or (eq ch ?C)
  781. ;; If the time on the clock was less than a minute before
  782. ;; the user went away, and they've ask to subtract all the
  783. ;; time...
  784. start-over)
  785. nil)
  786. ((or subtractp
  787. (and gotback (= gotback 0)))
  788. last-valid)
  789. ((or (and keep (= keep default))
  790. (and gotback (= gotback default)))
  791. 'now)
  792. (keep
  793. (time-add last-valid (seconds-to-time (* 60 keep))))
  794. (gotback
  795. (time-subtract (current-time)
  796. (seconds-to-time (* 60 gotback))))
  797. (t
  798. (error "Unexpected, please report this as a bug")))
  799. (and gotback last-valid)
  800. (memq ch '(?K ?G ?S))
  801. (and start-over
  802. (not (memq ch '(?K ?G ?S ?C))))
  803. fail-quietly)))))
  804. (defun org-resolve-clocks (&optional only-dangling-p prompt-fn last-valid)
  805. "Resolve all currently open org-mode clocks.
  806. If `only-dangling-p' is non-nil, only ask to resolve dangling
  807. \(i.e., not currently open and valid) clocks."
  808. (interactive "P")
  809. (unless org-clock-resolving-clocks
  810. (let ((org-clock-resolving-clocks t))
  811. (dolist (file (org-files-list))
  812. (let ((clocks (org-find-open-clocks file)))
  813. (dolist (clock clocks)
  814. (let ((dangling (or (not (org-clock-is-active))
  815. (/= (car clock) org-clock-marker))))
  816. (if (or (not only-dangling-p) dangling)
  817. (org-clock-resolve
  818. clock
  819. (or prompt-fn
  820. (function
  821. (lambda (clock)
  822. (format
  823. "Dangling clock started %d mins ago"
  824. (floor
  825. (/ (- (org-float-time (current-time))
  826. (org-float-time (cdr clock))) 60))))))
  827. (or last-valid
  828. (cdr clock)))))))))))
  829. (defun org-emacs-idle-seconds ()
  830. "Return the current Emacs idle time in seconds, or nil if not idle."
  831. (let ((idle-time (current-idle-time)))
  832. (if idle-time
  833. (org-float-time idle-time)
  834. 0)))
  835. (defun org-mac-idle-seconds ()
  836. "Return the current Mac idle time in seconds."
  837. (string-to-number (shell-command-to-string "ioreg -c IOHIDSystem | perl -ane 'if (/Idle/) {$idle=(pop @F)/1000000000; print $idle; last}'")))
  838. (defun org-x11-idle-seconds ()
  839. "Return the current X11 idle time in seconds."
  840. (/ (string-to-number (shell-command-to-string "x11idle")) 1000))
  841. (defun org-user-idle-seconds ()
  842. "Return the number of seconds the user has been idle for.
  843. This routine returns a floating point number."
  844. (cond
  845. ((eq system-type 'darwin)
  846. (org-mac-idle-seconds))
  847. ((eq window-system 'x)
  848. (org-x11-idle-seconds))
  849. (t
  850. (org-emacs-idle-seconds))))
  851. (defvar org-clock-user-idle-seconds)
  852. (defun org-resolve-clocks-if-idle ()
  853. "Resolve all currently open org-mode clocks.
  854. This is performed after `org-clock-idle-time' minutes, to check
  855. if the user really wants to stay clocked in after being idle for
  856. so long."
  857. (when (and org-clock-idle-time (not org-clock-resolving-clocks)
  858. org-clock-marker)
  859. (let* ((org-clock-user-idle-seconds (org-user-idle-seconds))
  860. (org-clock-user-idle-start
  861. (time-subtract (current-time)
  862. (seconds-to-time org-clock-user-idle-seconds)))
  863. (org-clock-resolving-clocks-due-to-idleness t))
  864. (if (> org-clock-user-idle-seconds (* 60 org-clock-idle-time))
  865. (org-clock-resolve
  866. (cons org-clock-marker
  867. org-clock-start-time)
  868. (function
  869. (lambda (clock)
  870. (format "Clocked in & idle for %.1f mins"
  871. (/ (org-float-time
  872. (time-subtract (current-time)
  873. org-clock-user-idle-start))
  874. 60.0))))
  875. org-clock-user-idle-start)))))
  876. (defun org-clock-in (&optional select start-time)
  877. "Start the clock on the current item.
  878. If necessary, clock-out of the currently active clock.
  879. With a prefix argument SELECT (\\[universal-argument]), offer a list of \
  880. recently clocked tasks to
  881. clock into. When SELECT is \\[universal-argument] \\[universal-argument], \
  882. clock into the current task and mark
  883. is as the default task, a special task that will always be offered in
  884. the clocking selection, associated with the letter `d'."
  885. (interactive "P")
  886. (setq org-clock-notification-was-shown nil)
  887. (catch 'abort
  888. (let ((interrupting (and (not org-clock-resolving-clocks-due-to-idleness)
  889. (org-clocking-p)))
  890. ts selected-task target-pos (msg-extra "")
  891. (leftover (and (not org-clock-resolving-clocks)
  892. org-clock-leftover-time)))
  893. (when (and org-clock-auto-clock-resolution
  894. (or (not interrupting)
  895. (eq t org-clock-auto-clock-resolution))
  896. (not org-clock-clocking-in)
  897. (not org-clock-resolving-clocks))
  898. (setq org-clock-leftover-time nil)
  899. (let ((org-clock-clocking-in t))
  900. (org-resolve-clocks))) ; check if any clocks are dangling
  901. (when (equal select '(4))
  902. (setq selected-task (org-clock-select-task "Clock-in on task: "))
  903. (if selected-task
  904. (setq selected-task (copy-marker selected-task))
  905. (error "Abort")))
  906. (when interrupting
  907. ;; We are interrupting the clocking of a different task.
  908. ;; Save a marker to this task, so that we can go back.
  909. ;; First check if we are trying to clock into the same task!
  910. (when (save-excursion
  911. (unless selected-task
  912. (org-back-to-heading t))
  913. (and (equal (marker-buffer org-clock-hd-marker)
  914. (if selected-task
  915. (marker-buffer selected-task)
  916. (current-buffer)))
  917. (= (marker-position org-clock-hd-marker)
  918. (if selected-task
  919. (marker-position selected-task)
  920. (point)))))
  921. (message "Clock continues in \"%s\"" org-clock-heading)
  922. (throw 'abort nil))
  923. (move-marker org-clock-interrupted-task
  924. (marker-position org-clock-marker)
  925. (marker-buffer org-clock-marker))
  926. (let ((org-clock-clocking-in t))
  927. (org-clock-out t)))
  928. (when (equal select '(16))
  929. ;; Mark as default clocking task
  930. (org-clock-mark-default-task))
  931. ;; Clock in at which position?
  932. (setq target-pos
  933. (if (and (eobp) (not (org-on-heading-p)))
  934. (point-at-bol 0)
  935. (point)))
  936. (run-hooks 'org-clock-in-prepare-hook)
  937. (save-excursion
  938. (when (and selected-task (marker-buffer selected-task))
  939. ;; There is a selected task, move to the correct buffer
  940. ;; and set the new target position.
  941. (set-buffer (org-base-buffer (marker-buffer selected-task)))
  942. (setq target-pos (marker-position selected-task))
  943. (move-marker selected-task nil))
  944. (save-excursion
  945. (save-restriction
  946. (widen)
  947. (goto-char target-pos)
  948. (org-back-to-heading t)
  949. (or interrupting (move-marker org-clock-interrupted-task nil))
  950. (org-clock-history-push)
  951. (org-clock-set-current)
  952. (cond ((functionp org-clock-in-switch-to-state)
  953. (looking-at org-complex-heading-regexp)
  954. (let ((newstate (funcall org-clock-in-switch-to-state
  955. (match-string 2))))
  956. (if newstate (org-todo newstate))))
  957. ((and org-clock-in-switch-to-state
  958. (not (looking-at (concat outline-regexp "[ \t]*"
  959. org-clock-in-switch-to-state
  960. "\\>"))))
  961. (org-todo org-clock-in-switch-to-state)))
  962. (setq org-clock-heading-for-remember
  963. (and (looking-at org-complex-heading-regexp)
  964. (match-end 4)
  965. (org-trim (buffer-substring (match-end 1)
  966. (match-end 4)))))
  967. (setq org-clock-heading
  968. (cond ((and org-clock-heading-function
  969. (functionp org-clock-heading-function))
  970. (funcall org-clock-heading-function))
  971. ((looking-at org-complex-heading-regexp)
  972. (replace-regexp-in-string
  973. "\\[\\[.*?\\]\\[\\(.*?\\)\\]\\]" "\\1"
  974. (match-string 4)))
  975. (t "???")))
  976. (setq org-clock-heading (org-propertize org-clock-heading
  977. 'face nil))
  978. (org-clock-find-position org-clock-in-resume)
  979. (cond
  980. ((and org-clock-in-resume
  981. (looking-at
  982. (concat "^[ \t]* " org-clock-string
  983. " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
  984. " +\\sw+\.? +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
  985. (message "Matched %s" (match-string 1))
  986. (setq ts (concat "[" (match-string 1) "]"))
  987. (goto-char (match-end 1))
  988. (setq org-clock-start-time
  989. (apply 'encode-time
  990. (org-parse-time-string (match-string 1))))
  991. (setq org-clock-effort (org-get-effort))
  992. (setq org-clock-total-time (org-clock-sum-current-item
  993. (org-clock-get-sum-start))))
  994. ((eq org-clock-in-resume 'auto-restart)
  995. ;; called from org-clock-load during startup,
  996. ;; do not interrupt, but warn!
  997. (message "Cannot restart clock because task does not contain unfinished clock")
  998. (ding)
  999. (sit-for 2)
  1000. (throw 'abort nil))
  1001. (t
  1002. (insert-before-markers "\n")
  1003. (backward-char 1)
  1004. (org-indent-line-function)
  1005. (when (and (save-excursion
  1006. (end-of-line 0)
  1007. (org-in-item-p)))
  1008. (beginning-of-line 1)
  1009. (org-indent-line-to (- (org-get-indentation) 2)))
  1010. (insert org-clock-string " ")
  1011. (setq org-clock-effort (org-get-effort))
  1012. (setq org-clock-total-time (org-clock-sum-current-item
  1013. (org-clock-get-sum-start)))
  1014. (setq org-clock-start-time
  1015. (or (and leftover
  1016. (y-or-n-p
  1017. (format
  1018. "You stopped another clock %d mins ago; start this one from then? "
  1019. (/ (- (org-float-time (current-time))
  1020. (org-float-time leftover)) 60)))
  1021. leftover)
  1022. start-time
  1023. (current-time)))
  1024. (setq ts (org-insert-time-stamp org-clock-start-time
  1025. 'with-hm 'inactive))))
  1026. (move-marker org-clock-marker (point) (buffer-base-buffer))
  1027. (move-marker org-clock-hd-marker
  1028. (save-excursion (org-back-to-heading t) (point))
  1029. (buffer-base-buffer))
  1030. (setq org-clock-has-been-used t)
  1031. (or global-mode-string (setq global-mode-string '("")))
  1032. (or (memq 'org-mode-line-string global-mode-string)
  1033. (setq global-mode-string
  1034. (append global-mode-string '(org-mode-line-string))))
  1035. (org-clock-update-mode-line)
  1036. (when org-clock-mode-line-timer
  1037. (cancel-timer org-clock-mode-line-timer)
  1038. (setq org-clock-mode-line-timer nil))
  1039. (setq org-clock-mode-line-timer
  1040. (run-with-timer org-clock-update-period
  1041. org-clock-update-period
  1042. 'org-clock-update-mode-line))
  1043. (when org-clock-idle-timer
  1044. (cancel-timer org-clock-idle-timer)
  1045. (setq org-clock-idle-timer nil))
  1046. (setq org-clock-idle-timer
  1047. (run-with-timer 60 60 'org-resolve-clocks-if-idle))
  1048. (message "Clock starts at %s - %s" ts msg-extra)
  1049. (run-hooks 'org-clock-in-hook)))))))
  1050. (defvar org-clock-current-task nil
  1051. "Task currently clocked in.")
  1052. (defun org-clock-set-current ()
  1053. "Set `org-clock-current-task' to the task currently clocked in."
  1054. (setq org-clock-current-task (nth 4 (org-heading-components))))
  1055. (defun org-clock-delete-current ()
  1056. "Reset `org-clock-current-task' to nil."
  1057. (setq org-clock-current-task nil))
  1058. (defun org-clock-mark-default-task ()
  1059. "Mark current task as default task."
  1060. (interactive)
  1061. (save-excursion
  1062. (org-back-to-heading t)
  1063. (move-marker org-clock-default-task (point))))
  1064. (defvar msg-extra)
  1065. (defun org-clock-get-sum-start ()
  1066. "Return the time from which clock times should be counted.
  1067. This is for the currently running clock as it is displayed
  1068. in the mode line. This function looks at the properties
  1069. LAST_REPEAT and in particular CLOCK_MODELINE_TOTAL and the
  1070. corresponding variable `org-clock-modeline-total' and then
  1071. decides which time to use."
  1072. (let ((cmt (or (org-entry-get nil "CLOCK_MODELINE_TOTAL")
  1073. (symbol-name org-clock-modeline-total)))
  1074. (lr (org-entry-get nil "LAST_REPEAT")))
  1075. (cond
  1076. ((equal cmt "current")
  1077. (setq msg-extra "showing time in current clock instance")
  1078. (current-time))
  1079. ((equal cmt "today")
  1080. (setq msg-extra "showing today's task time.")
  1081. (let* ((dt (decode-time (current-time))))
  1082. (setq dt (append (list 0 0 0) (nthcdr 3 dt)))
  1083. (if org-extend-today-until
  1084. (setf (nth 2 dt) org-extend-today-until))
  1085. (apply 'encode-time dt)))
  1086. ((or (equal cmt "all")
  1087. (and (or (not cmt) (equal cmt "auto"))
  1088. (not lr)))
  1089. (setq msg-extra "showing entire task time.")
  1090. nil)
  1091. ((or (equal cmt "repeat")
  1092. (and (or (not cmt) (equal cmt "auto"))
  1093. lr))
  1094. (setq msg-extra "showing task time since last repeat.")
  1095. (if (not lr)
  1096. nil
  1097. (org-time-string-to-time lr)))
  1098. (t nil))))
  1099. (defun org-clock-find-position (find-unclosed)
  1100. "Find the location where the next clock line should be inserted.
  1101. When FIND-UNCLOSED is non-nil, first check if there is an unclosed clock
  1102. line and position cursor in that line."
  1103. (org-back-to-heading t)
  1104. (catch 'exit
  1105. (let ((beg (save-excursion
  1106. (beginning-of-line 2)
  1107. (or (bolp) (newline))
  1108. (point)))
  1109. (end (progn (outline-next-heading) (point)))
  1110. (re (concat "^[ \t]*" org-clock-string))
  1111. (cnt 0)
  1112. (drawer (if (stringp org-clock-into-drawer)
  1113. org-clock-into-drawer "LOGBOOK"))
  1114. first last ind-last)
  1115. (goto-char beg)
  1116. (when (and find-unclosed
  1117. (re-search-forward
  1118. (concat "^[ \t]* " org-clock-string
  1119. " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
  1120. " +\\sw+ +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")
  1121. end t))
  1122. (beginning-of-line 1)
  1123. (throw 'exit t))
  1124. (when (eobp) (newline) (setq end (max (point) end)))
  1125. (when (re-search-forward (concat "^[ \t]*:" drawer ":") end t)
  1126. ;; we seem to have a CLOCK drawer, so go there.
  1127. (beginning-of-line 2)
  1128. (or org-log-states-order-reversed
  1129. (and (re-search-forward org-property-end-re nil t)
  1130. (goto-char (match-beginning 0))))
  1131. (throw 'exit t))
  1132. ;; Lets count the CLOCK lines
  1133. (goto-char beg)
  1134. (while (re-search-forward re end t)
  1135. (setq first (or first (match-beginning 0))
  1136. last (match-beginning 0)
  1137. cnt (1+ cnt)))
  1138. (when (and (integerp org-clock-into-drawer)
  1139. last
  1140. (>= (1+ cnt) org-clock-into-drawer))
  1141. ;; Wrap current entries into a new drawer
  1142. (goto-char last)
  1143. (setq ind-last (org-get-indentation))
  1144. (beginning-of-line 2)
  1145. (if (and (>= (org-get-indentation) ind-last)
  1146. (org-at-item-p))
  1147. (org-end-of-item))
  1148. (insert ":END:\n")
  1149. (beginning-of-line 0)
  1150. (org-indent-line-to ind-last)
  1151. (goto-char first)
  1152. (insert ":" drawer ":\n")
  1153. (beginning-of-line 0)
  1154. (org-indent-line-function)
  1155. (org-flag-drawer t)
  1156. (beginning-of-line 2)
  1157. (or org-log-states-order-reversed
  1158. (and (re-search-forward org-property-end-re nil t)
  1159. (goto-char (match-beginning 0))))
  1160. (throw 'exit nil))
  1161. (goto-char beg)
  1162. (while (and (looking-at (concat "[ \t]*" org-keyword-time-regexp))
  1163. (not (equal (match-string 1) org-clock-string)))
  1164. ;; Planning info, skip to after it
  1165. (beginning-of-line 2)
  1166. (or (bolp) (newline)))
  1167. (when (or (eq org-clock-into-drawer t)
  1168. (stringp org-clock-into-drawer)
  1169. (and (integerp org-clock-into-drawer)
  1170. (< org-clock-into-drawer 2)))
  1171. (insert ":" drawer ":\n:END:\n")
  1172. (beginning-of-line -1)
  1173. (org-indent-line-function)
  1174. (org-flag-drawer t)
  1175. (beginning-of-line 2)
  1176. (org-indent-line-function)
  1177. (beginning-of-line)
  1178. (or org-log-states-order-reversed
  1179. (and (re-search-forward org-property-end-re nil t)
  1180. (goto-char (match-beginning 0))))))))
  1181. (defun org-clock-out (&optional fail-quietly at-time)
  1182. "Stop the currently running clock.
  1183. If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
  1184. (interactive)
  1185. (catch 'exit
  1186. (when (not (org-clocking-p))
  1187. (setq global-mode-string
  1188. (delq 'org-mode-line-string global-mode-string))
  1189. (force-mode-line-update)
  1190. (if fail-quietly (throw 'exit t) (error "No active clock")))
  1191. (let (ts te s h m remove)
  1192. (save-excursion ; Do not replace this with `with-current-buffer'.
  1193. (with-no-warnings (set-buffer (org-clocking-buffer)))
  1194. (save-restriction
  1195. (widen)
  1196. (goto-char org-clock-marker)
  1197. (beginning-of-line 1)
  1198. (if (and (looking-at (concat "[ \t]*" org-keyword-time-regexp))
  1199. (equal (match-string 1) org-clock-string))
  1200. (setq ts (match-string 2))
  1201. (if fail-quietly (throw 'exit nil) (error "Clock start time is gone")))
  1202. (goto-char (match-end 0))
  1203. (delete-region (point) (point-at-eol))
  1204. (insert "--")
  1205. (setq te (org-insert-time-stamp (or at-time (current-time))
  1206. 'with-hm 'inactive))
  1207. (setq s (- (org-float-time (apply 'encode-time (org-parse-time-string te)))
  1208. (org-float-time (apply 'encode-time (org-parse-time-string ts))))
  1209. h (floor (/ s 3600))
  1210. s (- s (* 3600 h))
  1211. m (floor (/ s 60))
  1212. s (- s (* 60 s)))
  1213. (insert " => " (format "%2d:%02d" h m))
  1214. (when (setq remove (and org-clock-out-remove-zero-time-clocks
  1215. (= (+ h m) 0)))
  1216. (beginning-of-line 1)
  1217. (delete-region (point) (point-at-eol))
  1218. (and (looking-at "\n") (> (point-max) (1+ (point)))
  1219. (delete-char 1)))
  1220. (move-marker org-clock-marker nil)
  1221. (move-marker org-clock-hd-marker nil)
  1222. (when org-log-note-clock-out
  1223. (org-add-log-setup 'clock-out nil nil nil nil
  1224. (concat "# Task: " (org-get-heading t) "\n\n")))
  1225. (when org-clock-mode-line-timer
  1226. (cancel-timer org-clock-mode-line-timer)
  1227. (setq org-clock-mode-line-timer nil))
  1228. (when org-clock-idle-timer
  1229. (cancel-timer org-clock-idle-timer)
  1230. (setq org-clock-idle-timer nil))
  1231. (setq global-mode-string
  1232. (delq 'org-mode-line-string global-mode-string))
  1233. (when org-clock-out-switch-to-state
  1234. (save-excursion
  1235. (org-back-to-heading t)
  1236. (let ((org-inhibit-logging t)
  1237. (org-clock-out-when-done nil))
  1238. (cond
  1239. ((functionp org-clock-out-switch-to-state)
  1240. (looking-at org-complex-heading-regexp)
  1241. (let ((newstate (funcall org-clock-out-switch-to-state
  1242. (match-string 2))))
  1243. (if newstate (org-todo newstate))))
  1244. ((and org-clock-out-switch-to-state
  1245. (not (looking-at (concat outline-regexp "[ \t]*"
  1246. org-clock-out-switch-to-state
  1247. "\\>"))))
  1248. (org-todo org-clock-out-switch-to-state))))))
  1249. (force-mode-line-update)
  1250. (message (concat "Clock stopped at %s after HH:MM = " org-time-clocksum-format "%s") te h m
  1251. (if remove " => LINE REMOVED" ""))
  1252. (run-hooks 'org-clock-out-hook)
  1253. (org-clock-delete-current))))))
  1254. (defun org-clock-cancel ()
  1255. "Cancel the running clock by removing the start timestamp."
  1256. (interactive)
  1257. (when (not (org-clocking-p))
  1258. (setq global-mode-string
  1259. (delq 'org-mode-line-string global-mode-string))
  1260. (force-mode-line-update)
  1261. (error "No active clock"))
  1262. (save-excursion ; Do not replace this with `with-current-buffer'.
  1263. (with-no-warnings (set-buffer (org-clocking-buffer)))
  1264. (goto-char org-clock-marker)
  1265. (delete-region (1- (point-at-bol)) (point-at-eol))
  1266. ;; Just in case, remove any empty LOGBOOK left over
  1267. (org-remove-empty-drawer-at "LOGBOOK" (point)))
  1268. (move-marker org-clock-marker nil)
  1269. (move-marker org-clock-hd-marker nil)
  1270. (setq global-mode-string
  1271. (delq 'org-mode-line-string global-mode-string))
  1272. (force-mode-line-update)
  1273. (message "Clock canceled")
  1274. (run-hooks 'org-clock-cancel-hook))
  1275. (defun org-clock-goto (&optional select)
  1276. "Go to the currently clocked-in entry, or to the most recently clocked one.
  1277. With prefix arg SELECT, offer recently clocked tasks for selection."
  1278. (interactive "@P")
  1279. (let* ((recent nil)
  1280. (m (cond
  1281. (select
  1282. (or (org-clock-select-task "Select task to go to: ")
  1283. (error "No task selected")))
  1284. ((org-clocking-p) org-clock-marker)
  1285. ((and org-clock-goto-may-find-recent-task
  1286. (car org-clock-history)
  1287. (marker-buffer (car org-clock-history)))
  1288. (setq recent t)
  1289. (car org-clock-history))
  1290. (t (error "No active or recent clock task")))))
  1291. (switch-to-buffer (marker-buffer m))
  1292. (if (or (< m (point-min)) (> m (point-max))) (widen))
  1293. (goto-char m)
  1294. (org-show-entry)
  1295. (org-back-to-heading t)
  1296. (org-cycle-hide-drawers 'children)
  1297. (recenter)
  1298. (org-reveal)
  1299. (if recent
  1300. (message "No running clock, this is the most recently clocked task"))
  1301. (run-hooks 'org-clock-goto-hook)))
  1302. (defvar org-clock-file-total-minutes nil
  1303. "Holds the file total time in minutes, after a call to `org-clock-sum'.")
  1304. (make-variable-buffer-local 'org-clock-file-total-minutes)
  1305. (defun org-clock-sum (&optional tstart tend headline-filter)
  1306. "Sum the times for each subtree.
  1307. Puts the resulting times in minutes as a text property on each headline.
  1308. TSTART and TEND can mark a time range to be considered. HEADLINE-FILTER is a
  1309. zero-arg function that, if specified, is called for each headline in the time
  1310. range with point at the headline. Headlines for which HEADLINE-FILTER returns
  1311. nil are excluded from the clock summation."
  1312. (interactive)
  1313. (let* ((bmp (buffer-modified-p))
  1314. (re (concat "^\\(\\*+\\)[ \t]\\|^[ \t]*"
  1315. org-clock-string
  1316. "[ \t]*\\(?:\\(\\[.*?\\]\\)-+\\(\\[.*?\\]\\)\\|=>[ \t]+\\([0-9]+\\):\\([0-9]+\\)\\)"))
  1317. (lmax 30)
  1318. (ltimes (make-vector lmax 0))
  1319. (t1 0)
  1320. (level 0)
  1321. ts te dt
  1322. time)
  1323. (if (stringp tstart) (setq tstart (org-time-string-to-seconds tstart)))
  1324. (if (stringp tend) (setq tend (org-time-string-to-seconds tend)))
  1325. (if (consp tstart) (setq tstart (org-float-time tstart)))
  1326. (if (consp tend) (setq tend (org-float-time tend)))
  1327. (remove-text-properties (point-min) (point-max)
  1328. '(:org-clock-minutes t
  1329. :org-clock-force-headline-inclusion t))
  1330. (save-excursion
  1331. (goto-char (point-max))
  1332. (while (re-search-backward re nil t)
  1333. (cond
  1334. ((match-end 2)
  1335. ;; Two time stamps
  1336. (setq ts (match-string 2)
  1337. te (match-string 3)
  1338. ts (org-float-time
  1339. (apply 'encode-time (org-parse-time-string ts)))
  1340. te (org-float-time
  1341. (apply 'encode-time (org-parse-time-string te)))
  1342. ts (if tstart (max ts tstart) ts)
  1343. te (if tend (min te tend) te)
  1344. dt (- te ts)
  1345. t1 (if (> dt 0) (+ t1 (floor (/ dt 60))) t1)))
  1346. ((match-end 4)
  1347. ;; A naked time
  1348. (setq t1 (+ t1 (string-to-number (match-string 5))
  1349. (* 60 (string-to-number (match-string 4))))))
  1350. (t ;; A headline
  1351. ;; Add the currently clocking item time to the total
  1352. (when (and org-clock-report-include-clocking-task
  1353. (equal (org-clocking-buffer) (current-buffer))
  1354. (equal (marker-position org-clock-hd-marker) (point))
  1355. tstart
  1356. tend
  1357. (>= (org-float-time org-clock-start-time) tstart)
  1358. (<= (org-float-time org-clock-start-time) tend))
  1359. (let ((time (floor (- (org-float-time)
  1360. (org-float-time org-clock-start-time)) 60)))
  1361. (setq t1 (+ t1 time))))
  1362. (let* ((headline-forced
  1363. (get-text-property (point)
  1364. :org-clock-force-headline-inclusion))
  1365. (headline-included
  1366. (or (null headline-filter)
  1367. (save-excursion
  1368. (save-match-data (funcall headline-filter))))))
  1369. (setq level (- (match-end 1) (match-beginning 1)))
  1370. (when (or (> t1 0) (> (aref ltimes level) 0))
  1371. (when (or headline-included headline-forced)
  1372. (if headline-included
  1373. (loop for l from 0 to level do
  1374. (aset ltimes l (+ (aref ltimes l) t1))))
  1375. (setq time (aref ltimes level))
  1376. (goto-char (match-beginning 0))
  1377. (put-text-property (point) (point-at-eol) :org-clock-minutes time)
  1378. (if headline-filter
  1379. (save-excursion
  1380. (save-match-data
  1381. (while
  1382. (> (funcall outline-level) 1)
  1383. (outline-up-heading 1 t)
  1384. (put-text-property
  1385. (point) (point-at-eol)
  1386. :org-clock-force-headline-inclusion t))))))
  1387. (setq t1 0)
  1388. (loop for l from level to (1- lmax) do
  1389. (aset ltimes l 0)))))))
  1390. (setq org-clock-file-total-minutes (aref ltimes 0)))
  1391. (set-buffer-modified-p bmp)))
  1392. (defun org-clock-sum-current-item (&optional tstart)
  1393. "Return time, clocked on current item in total."
  1394. (save-excursion
  1395. (save-restriction
  1396. (org-narrow-to-subtree)
  1397. (org-clock-sum tstart)
  1398. org-clock-file-total-minutes)))
  1399. (defun org-clock-display (&optional total-only)
  1400. "Show subtree times in the entire buffer.
  1401. If TOTAL-ONLY is non-nil, only show the total time for the entire file
  1402. in the echo area."
  1403. (interactive)
  1404. (org-clock-remove-overlays)
  1405. (let (time h m p)
  1406. (org-clock-sum)
  1407. (unless total-only
  1408. (save-excursion
  1409. (goto-char (point-min))
  1410. (while (or (and (equal (setq p (point)) (point-min))
  1411. (get-text-property p :org-clock-minutes))
  1412. (setq p (next-single-property-change
  1413. (point) :org-clock-minutes)))
  1414. (goto-char p)
  1415. (when (setq time (get-text-property p :org-clock-minutes))
  1416. (org-clock-put-overlay time (funcall outline-level))))
  1417. (setq h (/ org-clock-file-total-minutes 60)
  1418. m (- org-clock-file-total-minutes (* 60 h)))
  1419. ;; Arrange to remove the overlays upon next change.
  1420. (when org-remove-highlights-with-change
  1421. (org-add-hook 'before-change-functions 'org-clock-remove-overlays
  1422. nil 'local))))
  1423. (if org-time-clocksum-use-fractional
  1424. (message (concat "Total file time: " org-time-clocksum-fractional-format
  1425. " (%d hours and %d minutes)")
  1426. (/ (+ (* h 60.0) m) 60.0) h m)
  1427. (message (concat "Total file time: " org-time-clocksum-format
  1428. " (%d hours and %d minutes)") h m h m))))
  1429. (defvar org-clock-overlays nil)
  1430. (make-variable-buffer-local 'org-clock-overlays)
  1431. (defun org-clock-put-overlay (time &optional level)
  1432. "Put an overlays on the current line, displaying TIME.
  1433. If LEVEL is given, prefix time with a corresponding number of stars.
  1434. This creates a new overlay and stores it in `org-clock-overlays', so that it
  1435. will be easy to remove."
  1436. (let* ((c 60) (h (floor (/ time 60))) (m (- time (* 60 h)))
  1437. (l (if level (org-get-valid-level level 0) 0))
  1438. (fmt (concat "%s " (if org-time-clocksum-use-fractional
  1439. org-time-clocksum-fractional-format
  1440. org-time-clocksum-format) "%s"))
  1441. (off 0)
  1442. ov tx)
  1443. (org-move-to-column c)
  1444. (unless (eolp) (skip-chars-backward "^ \t"))
  1445. (skip-chars-backward " \t")
  1446. (setq ov (make-overlay (1- (point)) (point-at-eol))
  1447. tx (concat (buffer-substring (1- (point)) (point))
  1448. (make-string (+ off (max 0 (- c (current-column)))) ?.)
  1449. (org-add-props (if org-time-clocksum-use-fractional
  1450. (format fmt
  1451. (make-string l ?*)
  1452. (/ (+ (* h 60.0) m) 60.0)
  1453. (make-string (- 16 l) ?\ ))
  1454. (format fmt
  1455. (make-string l ?*) h m
  1456. (make-string (- 16 l) ?\ )))
  1457. (list 'face 'org-clock-overlay))
  1458. ""))
  1459. (if (not (featurep 'xemacs))
  1460. (overlay-put ov 'display tx)
  1461. (overlay-put ov 'invisible t)
  1462. (overlay-put ov 'end-glyph (make-glyph tx)))
  1463. (push ov org-clock-overlays)))
  1464. (defun org-clock-remove-overlays (&optional beg end noremove)
  1465. "Remove the occur highlights from the buffer.
  1466. BEG and END are ignored. If NOREMOVE is nil, remove this function
  1467. from the `before-change-functions' in the current buffer."
  1468. (interactive)
  1469. (unless org-inhibit-highlight-removal
  1470. (mapc 'delete-overlay org-clock-overlays)
  1471. (setq org-clock-overlays nil)
  1472. (unless noremove
  1473. (remove-hook 'before-change-functions
  1474. 'org-clock-remove-overlays 'local))))
  1475. (defvar state) ;; dynamically scoped into this function
  1476. (defun org-clock-out-if-current ()
  1477. "Clock out if the current entry contains the running clock.
  1478. This is used to stop the clock after a TODO entry is marked DONE,
  1479. and is only done if the variable `org-clock-out-when-done' is not nil."
  1480. (when (and org-clock-out-when-done
  1481. (or (and (eq t org-clock-out-when-done)
  1482. (member state org-done-keywords))
  1483. (and (listp org-clock-out-when-done)
  1484. (member state org-clock-out-when-done)))
  1485. (equal (or (buffer-base-buffer (org-clocking-buffer))
  1486. (org-clocking-buffer))
  1487. (or (buffer-base-buffer (current-buffer))
  1488. (current-buffer)))
  1489. (< (point) org-clock-marker)
  1490. (> (save-excursion (outline-next-heading) (point))
  1491. org-clock-marker))
  1492. ;; Clock out, but don't accept a logging message for this.
  1493. (let ((org-log-note-clock-out nil)
  1494. (org-clock-out-switch-to-state nil))
  1495. (org-clock-out))))
  1496. (add-hook 'org-after-todo-state-change-hook
  1497. 'org-clock-out-if-current)
  1498. ;;;###autoload
  1499. (defun org-get-clocktable (&rest props)
  1500. "Get a formatted clocktable with parameters according to PROPS.
  1501. The table is created in a temporary buffer, fully formatted and
  1502. fontified, and then returned."
  1503. ;; Set the defaults
  1504. (setq props (plist-put props :name "clocktable"))
  1505. (unless (plist-member props :maxlevel)
  1506. (setq props (plist-put props :maxlevel 2)))
  1507. (unless (plist-member props :scope)
  1508. (setq props (plist-put props :scope 'agenda)))
  1509. (with-temp-buffer
  1510. (org-mode)
  1511. (org-create-dblock props)
  1512. (org-update-dblock)
  1513. (font-lock-fontify-buffer)
  1514. (forward-line 2)
  1515. (buffer-substring (point) (progn
  1516. (re-search-forward "^[ \t]*#\\+END" nil t)
  1517. (point-at-bol)))))
  1518. (defun org-clock-report (&optional arg)
  1519. "Create a table containing a report about clocked time.
  1520. If the cursor is inside an existing clocktable block, then the table
  1521. will be updated. If not, a new clocktable will be inserted.
  1522. When called with a prefix argument, move to the first clock table in the
  1523. buffer and update it."
  1524. (interactive "P")
  1525. (org-clock-remove-overlays)
  1526. (when arg
  1527. (org-find-dblock "clocktable")
  1528. (org-show-entry))
  1529. (if (org-in-clocktable-p)
  1530. (goto-char (org-in-clocktable-p))
  1531. (org-create-dblock (append (list :name "clocktable")
  1532. org-clock-clocktable-default-properties)))
  1533. (org-update-dblock))
  1534. (defun org-in-clocktable-p ()
  1535. "Check if the cursor is in a clocktable."
  1536. (let ((pos (point)) start)
  1537. (save-excursion
  1538. (end-of-line 1)
  1539. (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
  1540. (setq start (match-beginning 0))
  1541. (re-search-forward "^[ \t]*#\\+END:.*" nil t)
  1542. (>= (match-end 0) pos)
  1543. start))))
  1544. (defun org-day-of-week (day month year)
  1545. "Returns the day of the week as an integer."
  1546. (nth 6
  1547. (decode-time
  1548. (date-to-time
  1549. (format "%d-%02d-%02dT00:00:00" year month day)))))
  1550. (defun org-quarter-to-date (quarter year)
  1551. "Get the date (week day year) of the first day of a given quarter."
  1552. (let (startday)
  1553. (cond
  1554. ((= quarter 1)
  1555. (setq startday (org-day-of-week 1 1 year))
  1556. (cond
  1557. ((= startday 0)
  1558. (list 52 7 (- year 1)))
  1559. ((= startday 6)
  1560. (list 52 6 (- year 1)))
  1561. ((<= startday 4)
  1562. (list 1 startday year))
  1563. ((> startday 4)
  1564. (list 53 startday (- year 1)))
  1565. )
  1566. )
  1567. ((= quarter 2)
  1568. (setq startday (org-day-of-week 1 4 year))
  1569. (cond
  1570. ((= startday 0)
  1571. (list 13 startday year))
  1572. ((< startday 4)
  1573. (list 14 startday year))
  1574. ((>= startday 4)
  1575. (list 13 startday year))
  1576. )
  1577. )
  1578. ((= quarter 3)
  1579. (setq startday (org-day-of-week 1 7 year))
  1580. (cond
  1581. ((= startday 0)
  1582. (list 26 startday year))
  1583. ((< startday 4)
  1584. (list 27 startday year))
  1585. ((>= startday 4)
  1586. (list 26 startday year))
  1587. )
  1588. )
  1589. ((= quarter 4)
  1590. (setq startday (org-day-of-week 1 10 year))
  1591. (cond
  1592. ((= startday 0)
  1593. (list 39 startday year))
  1594. ((<= startday 4)
  1595. (list 40 startday year))
  1596. ((> startday 4)
  1597. (list 39 startday year)))))))
  1598. (defun org-clock-special-range (key &optional time as-strings)
  1599. "Return two times bordering a special time range.
  1600. Key is a symbol specifying the range and can be one of `today', `yesterday',
  1601. `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
  1602. A week starts Monday 0:00 and ends Sunday 24:00.
  1603. The range is determined relative to TIME. TIME defaults to the current time.
  1604. The return value is a cons cell with two internal times like the ones
  1605. returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
  1606. the returned times will be formatted strings."
  1607. (if (integerp key) (setq key (intern (number-to-string key))))
  1608. (let* ((tm (decode-time (or time (current-time))))
  1609. (s 0) (m (nth 1 tm)) (h (nth 2 tm))
  1610. (d (nth 3 tm)) (month (nth 4 tm)) (y (nth 5 tm))
  1611. (dow (nth 6 tm))
  1612. (skey (symbol-name key))
  1613. (shift 0)
  1614. (q (cond ((>= (nth 4 tm) 10) 4)
  1615. ((>= (nth 4 tm) 7) 3)
  1616. ((>= (nth 4 tm) 4) 2)
  1617. ((>= (nth 4 tm) 1) 1)))
  1618. s1 m1 h1 d1 month1 y1 diff ts te fm txt w date
  1619. interval tmp shiftedy shiftedm shiftedq)
  1620. (cond
  1621. ((string-match "^[0-9]+$" skey)
  1622. (setq y (string-to-number skey) m 1 d 1 key 'year))
  1623. ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)$" skey)
  1624. (setq y (string-to-number (match-string 1 skey))
  1625. month (string-to-number (match-string 2 skey))
  1626. d 1 key 'month))
  1627. ((string-match "^\\([0-9]+\\)-[wW]\\([0-9]\\{1,2\\}\\)$" skey)
  1628. (require 'cal-iso)
  1629. (setq y (string-to-number (match-string 1 skey))
  1630. w (string-to-number (match-string 2 skey)))
  1631. (setq date (calendar-gregorian-from-absolute
  1632. (calendar-absolute-from-iso (list w 1 y))))
  1633. (setq d (nth 1 date) month (car date) y (nth 2 date)
  1634. dow 1
  1635. key 'week))
  1636. ((string-match "^\\([0-9]+\\)-[qQ]\\([1-4]\\)$" skey)
  1637. (require 'cal-iso)
  1638. (setq y (string-to-number (match-string 1 skey)))
  1639. (setq q (string-to-number (match-string 2 skey)))
  1640. (setq date (calendar-gregorian-from-absolute
  1641. (calendar-absolute-from-iso (org-quarter-to-date q y))))
  1642. (setq d (nth 1 date) month (car date) y (nth 2 date)
  1643. dow 1
  1644. key 'quarter))
  1645. ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)-\\([0-9]\\{1,2\\}\\)$" skey)
  1646. (setq y (string-to-number (match-string 1 skey))
  1647. month (string-to-number (match-string 2 skey))
  1648. d (string-to-number (match-string 3 skey))
  1649. key 'day))
  1650. ((string-match "\\([-+][0-9]+\\)$" skey)
  1651. (setq shift (string-to-number (match-string 1 skey))
  1652. key (intern (substring skey 0 (match-beginning 1))))
  1653. (if(and (memq key '(quarter thisq)) (> shift 0))
  1654. (error "Looking forward with quarters isn't implemented.")
  1655. ())))
  1656. (when (= shift 0)
  1657. (cond ((eq key 'yesterday) (setq key 'today shift -1))
  1658. ((eq key 'lastweek) (setq key 'week shift -1))
  1659. ((eq key 'lastmonth) (setq key 'month shift -1))
  1660. ((eq key 'lastyear) (setq key 'year shift -1))
  1661. ((eq key 'lastq) (setq key 'quarter shift -1))))
  1662. (cond
  1663. ((memq key '(day today))
  1664. (setq d (+ d shift) h 0 m 0 h1 24 m1 0))
  1665. ((memq key '(week thisweek))
  1666. (setq diff (+ (* -7 shift) (if (= dow 0) 6 (1- dow)))
  1667. m 0 h 0 d (- d diff) d1 (+ 7 d)))
  1668. ((memq key '(month thismonth))
  1669. (setq d 1 h 0 m 0 d1 1 month (+ month shift) month1 (1+ month) h1 0 m1 0))
  1670. ((memq key '(quarter thisq))
  1671. ; compute if this shift remains in this year
  1672. ; if not, compute how many years and quarters we have to shift (via floor*)
  1673. ; and compute the shifted years, months and quarters
  1674. (cond
  1675. ((< (+ (- q 1) shift) 0) ; shift not in this year
  1676. (setq interval (* -1 (+ (- q 1) shift)))
  1677. ; set tmp to ((years to shift) (quarters to shift))
  1678. (setq tmp (org-floor* interval 4))
  1679. ; due to the use of floor, 0 quarters actually means 4
  1680. (if (= 0 (nth 1 tmp))
  1681. (setq shiftedy (- y (nth 0 tmp))
  1682. shiftedm 1
  1683. shiftedq 1)
  1684. (setq shiftedy (- y (+ 1 (nth 0 tmp)))
  1685. shiftedm (- 13 (* 3 (nth 1 tmp)))
  1686. shiftedq (- 5 (nth 1 tmp))))
  1687. (setq d 1 h 0 m 0 d1 1 month shiftedm month1 (+ 3 shiftedm) h1 0 m1 0 y shiftedy))
  1688. ((> (+ q shift) 0) ; shift is whitin this year
  1689. (setq shiftedq (+ q shift))
  1690. (setq shiftedy y)
  1691. (setq d 1 h 0 m 0 d1 1 month (+ 1 (* 3 (- (+ q shift) 1))) month1 (+ 4 (* 3 (- (+ q shift) 1))) h1 0 m1 0))))
  1692. ((memq key '(year thisyear))
  1693. (setq m 0 h 0 d 1 month 1 y (+ y shift) y1 (1+ y)))
  1694. (t (error "No such time block %s" key)))
  1695. (setq ts (encode-time s m h d month y)
  1696. te (encode-time (or s1 s) (or m1 m) (or h1 h)
  1697. (or d1 d) (or month1 month) (or y1 y)))
  1698. (setq fm (cdr org-time-stamp-formats))
  1699. (cond
  1700. ((memq key '(day today))
  1701. (setq txt (format-time-string "%A, %B %d, %Y" ts)))
  1702. ((memq key '(week thisweek))
  1703. (setq txt (format-time-string "week %G-W%V" ts)))
  1704. ((memq key '(month thismonth))
  1705. (setq txt (format-time-string "%B %Y" ts)))
  1706. ((memq key '(year thisyear))
  1707. (setq txt (format-time-string "the year %Y" ts)))
  1708. ((memq key '(quarter thisq))
  1709. (setq txt (concatenate 'string (org-count-quarter shiftedq) " quarter of " (number-to-string shiftedy))))
  1710. )
  1711. (if as-strings
  1712. (list (format-time-string fm ts) (format-time-string fm te) txt)
  1713. (list ts te txt))))
  1714. (defun org-count-quarter (n)
  1715. (cond
  1716. ((= n 1) "1st")
  1717. ((= n 2) "2nd")
  1718. ((= n 3) "3rd")
  1719. ((= n 4) "4th")))
  1720. (defun org-clocktable-shift (dir n)
  1721. "Try to shift the :block date of the clocktable at point.
  1722. Point must be in the #+BEGIN: line of a clocktable, or this function
  1723. will throw an error.
  1724. DIR is a direction, a symbol `left', `right', `up', or `down'.
  1725. Both `left' and `down' shift the block toward the past, `up' and `right'
  1726. push it toward the future.
  1727. N is the number of shift steps to take. The size of the step depends on
  1728. the currently selected interval size."
  1729. (setq n (prefix-numeric-value n))
  1730. (and (memq dir '(left down)) (setq n (- n)))
  1731. (save-excursion
  1732. (goto-char (point-at-bol))
  1733. (if (not (looking-at "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>.*?:block[ \t]+\\(\\S-+\\)"))
  1734. (error "Line needs a :block definition before this command works")
  1735. (let* ((b (match-beginning 1)) (e (match-end 1))
  1736. (s (match-string 1))
  1737. block shift ins y mw d date wp m)
  1738. (cond
  1739. ((equal s "yesterday") (setq s "today-1"))
  1740. ((equal s "lastweek") (setq s "thisweek-1"))
  1741. ((equal s "lastmonth") (setq s "thismonth-1"))
  1742. ((equal s "lastyear") (setq s "thisyear-1"))
  1743. ((equal s "lastq") (setq s "thisq-1")))
  1744. (cond
  1745. ((string-match "^\\(today\\|thisweek\\|thismonth\\|thisyear\\|thisq\\)\\([-+][0-9]+\\)?$" s)
  1746. (setq block (match-string 1 s)
  1747. shift (if (match-end 2)
  1748. (string-to-number (match-string 2 s))
  1749. 0))
  1750. (setq shift (+ shift n))
  1751. (setq ins (if (= shift 0) block (format "%s%+d" block shift))))
  1752. ((string-match "\\([0-9]+\\)\\(-\\([wWqQ]?\\)\\([0-9]\\{1,2\\}\\)\\(-\\([0-9]\\{1,2\\}\\)\\)?\\)?" s)
  1753. ;; 1 1 2 3 3 4 4 5 6 6 5 2
  1754. (setq y (string-to-number (match-string 1 s))
  1755. wp (and (match-end 3) (match-string 3 s))
  1756. mw (and (match-end 4) (string-to-number (match-string 4 s)))
  1757. d (and (match-end 6) (string-to-number (match-string 6 s))))
  1758. (cond
  1759. (d (setq ins (format-time-string
  1760. "%Y-%m-%d"
  1761. (encode-time 0 0 0 (+ d n) m y))))
  1762. ((and wp (string-match "w\\|W" wp) mw (> (length wp) 0))
  1763. (require 'cal-iso)
  1764. (setq date (calendar-gregorian-from-absolute (calendar-absolute-from-iso (list (+ mw n) 1 y))))
  1765. (setq ins (format-time-string
  1766. "%G-W%V"
  1767. (encode-time 0 0 0 (nth 1 date) (car date) (nth 2 date)))))
  1768. ((and wp (string-match "q\\|Q" wp) mw (> (length wp) 0))
  1769. (require 'cal-iso)
  1770. ; if the 4th + 1 quarter is requested we flip to the 1st quarter of the next year
  1771. (if (> (+ mw n) 4)
  1772. (setq mw 0
  1773. y (+ 1 y))
  1774. ())
  1775. ; if the 1st - 1 quarter is requested we flip to the 4th quarter of the previous year
  1776. (if (= (+ mw n) 0)
  1777. (setq mw 5
  1778. y (- y 1))
  1779. ())
  1780. (setq date (calendar-gregorian-from-absolute (calendar-absolute-from-iso (org-quarter-to-date (+ mw n) y))))
  1781. (setq ins (format-time-string
  1782. (concatenate 'string (number-to-string y) "-Q" (number-to-string (+ mw n)))
  1783. (encode-time 0 0 0 (nth 1 date) (car date) (nth 2 date)))))
  1784. (mw
  1785. (setq ins (format-time-string
  1786. "%Y-%m"
  1787. (encode-time 0 0 0 1 (+ mw n) y))))
  1788. (y
  1789. (setq ins (number-to-string (+ y n))))))
  1790. (t (error "Cannot shift clocktable block")))
  1791. (when ins
  1792. (goto-char b)
  1793. (insert ins)
  1794. (delete-region (point) (+ (point) (- e b)))
  1795. (beginning-of-line 1)
  1796. (org-update-dblock)
  1797. t)))))
  1798. (defun org-dblock-write:clocktable (params)
  1799. "Write the standard clocktable."
  1800. (setq params (org-combine-plists org-clocktable-defaults params))
  1801. (catch 'exit
  1802. (let* ((scope (plist-get params :scope))
  1803. (block (plist-get params :block))
  1804. (ts (plist-get params :tstart))
  1805. (te (plist-get params :tend))
  1806. (link (plist-get params :link))
  1807. (maxlevel (or (plist-get params :maxlevel) 3))
  1808. (step (plist-get params :step))
  1809. (timestamp (plist-get params :timestamp))
  1810. (formatter (or (plist-get params :formatter)
  1811. org-clock-clocktable-formatter
  1812. 'org-clocktable-write-default))
  1813. cc range-text ipos pos one-file-with-archives
  1814. scope-is-list tbls level)
  1815. ;; Check if we need to do steps
  1816. (when block
  1817. ;; Get the range text for the header
  1818. (setq cc (org-clock-special-range block nil t)
  1819. ts (car cc) te (nth 1 cc) range-text (nth 2 cc)))
  1820. (when step
  1821. ;; Write many tables, in steps
  1822. (unless (or block (and ts te))
  1823. (error "Clocktable `:step' can only be used with `:block' or `:tstart,:end'"))
  1824. (org-clocktable-steps params)
  1825. (throw 'exit nil))
  1826. (setq ipos (point)) ; remember the insertion position
  1827. ;; Get the right scope
  1828. (setq pos (point))
  1829. (cond
  1830. ((and scope (listp scope) (symbolp (car scope)))
  1831. (setq scope (eval scope)))
  1832. ((eq scope 'agenda)
  1833. (setq scope (org-agenda-files t)))
  1834. ((eq scope 'agenda-with-archives)
  1835. (setq scope (org-agenda-files t))
  1836. (setq scope (org-add-archive-files scope)))
  1837. ((eq scope 'file-with-archives)
  1838. (setq scope (org-add-archive-files (list (buffer-file-name)))
  1839. one-file-with-archives t)))
  1840. (setq scope-is-list (and scope (listp scope)))
  1841. (if scope-is-list
  1842. ;; we collect from several files
  1843. (let* ((files scope)
  1844. file)
  1845. (org-prepare-agenda-buffers files)
  1846. (while (setq file (pop files))
  1847. (with-current-buffer (find-buffer-visiting file)
  1848. (save-excursion
  1849. (save-restriction
  1850. (push (org-clock-get-table-data file params) tbls))))))
  1851. ;; Just from the current file
  1852. (save-restriction
  1853. ;; get the right range into the restriction
  1854. (org-prepare-agenda-buffers (list (buffer-file-name)))
  1855. (cond
  1856. ((not scope)) ; use the restriction as it is now
  1857. ((eq scope 'file) (widen))
  1858. ((eq scope 'subtree) (org-narrow-to-subtree))
  1859. ((eq scope 'tree)
  1860. (while (org-up-heading-safe))
  1861. (org-narrow-to-subtree))
  1862. ((and (symbolp scope) (string-match "^tree\\([0-9]+\\)$"
  1863. (symbol-name scope)))
  1864. (setq level (string-to-number (match-string 1 (symbol-name scope))))
  1865. (catch 'exit
  1866. (while (org-up-heading-safe)
  1867. (looking-at outline-regexp)
  1868. (if (<= (org-reduced-level (funcall outline-level)) level)
  1869. (throw 'exit nil))))
  1870. (org-narrow-to-subtree)))
  1871. ;; do the table, with no file name.
  1872. (push (org-clock-get-table-data nil params) tbls)))
  1873. ;; OK, at this point we tbls as a list of tables, one per file
  1874. (setq tbls (nreverse tbls))
  1875. (setq params (plist-put params :multifile scope-is-list))
  1876. (setq params (plist-put params :one-file-with-archives
  1877. one-file-with-archives))
  1878. (funcall formatter ipos tbls params))))
  1879. (defun org-clocktable-write-default (ipos tables params)
  1880. "Write out a clock table at position IPOS in the current buffer.
  1881. TABLES is a list of tables with clocking data as produced by
  1882. `org-clock-get-table-data'. PARAMS is the parameter property list obtained
  1883. from the dynamic block defintion."
  1884. ;; This function looks quite complicated, mainly because there are a lot
  1885. ;; of options which can add or remove columns. I have massively commented
  1886. ;; function, to I hope it is understandable. If someone want to write
  1887. ;; there own special formatter, this maybe much easier because there can
  1888. ;; be a fixed format with a well-defined number of columns...
  1889. (let* ((hlchars '((1 . "*") (2 . "/")))
  1890. (lwords (assoc (plist-get params :lang)
  1891. org-clock-clocktable-language-setup))
  1892. (multifile (plist-get params :multifile))
  1893. (block (plist-get params :block))
  1894. (ts (plist-get params :tstart))
  1895. (te (plist-get params :tend))
  1896. (header (plist-get params :header))
  1897. (narrow (plist-get params :narrow))
  1898. (link (plist-get params :link))
  1899. (maxlevel (or (plist-get params :maxlevel) 3))
  1900. (emph (plist-get params :emphasize))
  1901. (level-p (plist-get params :level))
  1902. (timestamp (plist-get params :timestamp))
  1903. (ntcol (max 1 (or (plist-get params :tcolumns) 100)))
  1904. (rm-file-column (plist-get params :one-file-with-archives))
  1905. (indent (plist-get params :indent))
  1906. range-text total-time tbl level hlc formula pcol
  1907. file-time entries entry headline
  1908. recalc content narrow-cut-p tcol)
  1909. ;; Implement abbreviations
  1910. (when (plist-get params :compact)
  1911. (setq level nil indent t narrow (or narrow '40!) ntcol 1))
  1912. ;; Some consistency test for parameters
  1913. (unless (integerp ntcol)
  1914. (setq params (plist-put params :tcolumns (setq ntcol 100))))
  1915. (when (and narrow (integerp narrow) link)
  1916. ;; We cannot have both integer narrow and link
  1917. (message
  1918. "Using hard narrowing in clocktable to allow for links")
  1919. (setq narrow (intern (format "%d!" narrow))))
  1920. (when narrow
  1921. (cond
  1922. ((integerp narrow))
  1923. ((and (symbolp narrow)
  1924. (string-match "\\`[0-9]+!\\'" (symbol-name narrow)))
  1925. (setq narrow-cut-p t
  1926. narrow (string-to-number (substring (symbol-name narrow)
  1927. 0 -1))))
  1928. (t
  1929. (error "Invalid value %s of :narrow property in clock table"
  1930. narrow))))
  1931. (when block
  1932. ;; Get the range text for the header
  1933. (setq range-text (nth 2 (org-clock-special-range block nil t))))
  1934. ;; Compute the total time
  1935. (setq total-time (apply '+ (mapcar 'cadr tables)))
  1936. ;; Now we need to output this tsuff
  1937. (goto-char ipos)
  1938. ;; Insert the text *before* the actual table
  1939. (insert-before-markers
  1940. (or header
  1941. ;; Format the standard header
  1942. (concat
  1943. "Clock summary at ["
  1944. (substring
  1945. (format-time-string (cdr org-time-stamp-formats))
  1946. 1 -1)
  1947. "]"
  1948. (if block (concat ", for " range-text ".") "")
  1949. "\n\n")))
  1950. ;; Insert the narrowing line
  1951. (when (and narrow (integerp narrow) (not narrow-cut-p))
  1952. (insert-before-markers
  1953. "|" ; table line starter
  1954. (if multifile "|" "") ; file column, maybe
  1955. (if level-p "|" "") ; level column, maybe
  1956. (if timestamp "|" "") ; timestamp column, maybe
  1957. (format "<%d>| |\n" narrow))) ; headline and time columns
  1958. ;; Insert the table header line
  1959. (insert-before-markers
  1960. "|" ; table line starter
  1961. (if multifile (concat (nth 1 lwords) "|") "") ; file column, maybe
  1962. (if level-p (concat (nth 2 lwords) "|") "") ; level column, maybe
  1963. (if timestamp (concat (nth 3 lwords) "|") "") ; timestamp column, maybe
  1964. (concat (nth 4 lwords) "|"
  1965. (nth 5 lwords) "|\n")) ; headline and time columns
  1966. ;; Insert the total time in the table
  1967. (insert-before-markers
  1968. "|-\n" ; a hline
  1969. "|" ; table line starter
  1970. (if multifile (concat "| " (nth 6 lwords) " ") "")
  1971. ; file column, maybe
  1972. (if level-p "|" "") ; level column, maybe
  1973. (if timestamp "|" "") ; timestamp column, maybe
  1974. (concat "*" (nth 7 lwords) "*| ") ; instead of a headline
  1975. "*"
  1976. (org-minutes-to-hh:mm-string (or total-time 0)) ; the time
  1977. "*|\n") ; close line
  1978. ;; Now iterate over the tables and insert the data
  1979. ;; but only if any time has been collected
  1980. (when (and total-time (> total-time 0))
  1981. (while (setq tbl (pop tables))
  1982. ;; now tbl is the table resulting from one file.
  1983. (setq file-time (nth 1 tbl))
  1984. (when (or (and file-time (> file-time 0))
  1985. (not (plist-get params :fileskip0)))
  1986. (insert-before-markers "|-\n") ; a hline because a new file starts
  1987. ;; First the file time, if we have multiple files
  1988. (when multifile
  1989. ;; Summarize the time colleted from this file
  1990. (insert-before-markers
  1991. (format (concat "| %s %s | %s*" (nth 8 lwords) "* | *%s*|\n")
  1992. (file-name-nondirectory (car tbl))
  1993. (if level-p "| " "") ; level column, maybe
  1994. (if timestamp "| " "") ; timestamp column, maybe
  1995. (org-minutes-to-hh:mm-string (nth 1 tbl))))) ; the time
  1996. ;; Get the list of node entries and iterate over it
  1997. (setq entries (nth 2 tbl))
  1998. (while (setq entry (pop entries))
  1999. (setq level (car entry)
  2000. headline (nth 1 entry)
  2001. hlc (if emph (or (cdr (assoc level hlchars)) "") ""))
  2002. (when narrow-cut-p
  2003. (if (and (string-match (concat "\\`" org-bracket-link-regexp
  2004. "\\'")
  2005. headline)
  2006. (match-end 3))
  2007. (setq headline
  2008. (format "[[%s][%s]]"
  2009. (match-string 1 headline)
  2010. (org-shorten-string (match-string 3 headline)
  2011. narrow)))
  2012. (setq headline (org-shorten-string headline narrow))))
  2013. (insert-before-markers
  2014. "|" ; start the table line
  2015. (if multifile "|" "") ; free space for file name column?
  2016. (if level-p (format "%d|" (car entry)) "") ; level, maybe
  2017. (if timestamp (concat (nth 2 entry) "|") "") ; timestamp, maybe
  2018. (if indent (org-clocktable-indent-string level) "") ; indentation
  2019. hlc headline hlc "|" ; headline
  2020. (make-string (min (1- ntcol) (or (- level 1))) ?|)
  2021. ; empty fields for higher levels
  2022. hlc (org-minutes-to-hh:mm-string (nth 3 entry)) hlc ; time
  2023. "|\n" ; close line
  2024. )))))
  2025. (backward-delete-char 1)
  2026. (if (setq formula (plist-get params :formula))
  2027. (cond
  2028. ((eq formula '%)
  2029. ;; compute the column where the % numbers need to go
  2030. (setq pcol (+ 2
  2031. (if multifile 1 0)
  2032. (if level-p 1 0)
  2033. (if timestamp 1 0)
  2034. (min maxlevel (or ntcol 100))))
  2035. ;; compute the column where the total time is
  2036. (setq tcol (+ 2
  2037. (if multifile 1 0)
  2038. (if level-p 1 0)
  2039. (if timestamp 1 0)))
  2040. (insert
  2041. (format
  2042. "\n#+TBLFM: $%d='(org-clock-time%% @%d$%d $%d..$%d);%%.1f"
  2043. pcol ; the column where the % numbers should go
  2044. (if (and narrow (not narrow-cut-p)) 3 2) ; row of the total time
  2045. tcol ; column of the total time
  2046. tcol (1- pcol) ; range of columns where times can be found
  2047. ))
  2048. (setq recalc t))
  2049. ((stringp formula)
  2050. (insert "\n#+TBLFM: " formula)
  2051. (setq recalc t))
  2052. (t (error "invalid formula in clocktable")))
  2053. ;; Should we rescue an old formula?
  2054. (when (stringp (setq content (plist-get params :content)))
  2055. (when (string-match "^\\([ \t]*#\\+TBLFM:.*\\)" content)
  2056. (setq recalc t)
  2057. (insert "\n" (match-string 1 (plist-get params :content)))
  2058. (beginning-of-line 0))))
  2059. ;; Back to beginning, align the table, recalculate if necessary
  2060. (goto-char ipos)
  2061. (skip-chars-forward "^|")
  2062. (org-table-align)
  2063. (when org-hide-emphasis-markers
  2064. ;; we need to align a second time
  2065. (org-table-align))
  2066. (when recalc
  2067. (if (eq formula '%)
  2068. (save-excursion
  2069. (if (and narrow (not narrow-cut-p)) (beginning-of-line 2))
  2070. (org-table-goto-column pcol nil 'force)
  2071. (insert "%")))
  2072. (org-table-recalculate 'all))
  2073. (when rm-file-column
  2074. ;; The file column is actually not wanted
  2075. (forward-char 1)
  2076. (org-table-delete-column))
  2077. total-time))
  2078. (defun org-clocktable-indent-string (level)
  2079. (if (= level 1)
  2080. ""
  2081. (let ((str "\\__"))
  2082. (while (> level 2)
  2083. (setq level (1- level)
  2084. str (concat str "___")))
  2085. (concat str " "))))
  2086. (defun org-clocktable-steps (params)
  2087. "Step through the range to make a number of clock tables."
  2088. (let* ((p1 (copy-sequence params))
  2089. (ts (plist-get p1 :tstart))
  2090. (te (plist-get p1 :tend))
  2091. (step0 (plist-get p1 :step))
  2092. (step (cdr (assoc step0 '((day . 86400) (week . 604800)))))
  2093. (stepskip0 (plist-get p1 :stepskip0))
  2094. (block (plist-get p1 :block))
  2095. cc range-text step-time)
  2096. (when block
  2097. (setq cc (org-clock-special-range block nil t)
  2098. ts (car cc) te (nth 1 cc) range-text (nth 2 cc)))
  2099. (cond
  2100. ((numberp ts)
  2101. ;; If ts is a number, it's an absolute day number from org-agenda.
  2102. (destructuring-bind (month day year) (calendar-gregorian-from-absolute ts)
  2103. (setq ts (org-float-time (encode-time 0 0 0 day month year)))))
  2104. (ts
  2105. (setq ts (org-float-time
  2106. (apply 'encode-time (org-parse-time-string ts))))))
  2107. (cond
  2108. ((numberp te)
  2109. ;; Likewise for te.
  2110. (destructuring-bind (month day year) (calendar-gregorian-from-absolute te)
  2111. (setq te (org-float-time (encode-time 0 0 0 day month year)))))
  2112. (te
  2113. (setq te (org-float-time
  2114. (apply 'encode-time (org-parse-time-string te))))))
  2115. (setq p1 (plist-put p1 :header ""))
  2116. (setq p1 (plist-put p1 :step nil))
  2117. (setq p1 (plist-put p1 :block nil))
  2118. (while (< ts te)
  2119. (or (bolp) (insert "\n"))
  2120. (setq p1 (plist-put p1 :tstart (format-time-string
  2121. (org-time-stamp-format nil t)
  2122. (seconds-to-time ts))))
  2123. (setq p1 (plist-put p1 :tend (format-time-string
  2124. (org-time-stamp-format nil t)
  2125. (seconds-to-time (setq ts (+ ts step))))))
  2126. (insert "\n" (if (eq step0 'day) "Daily report: "
  2127. "Weekly report starting on: ")
  2128. (plist-get p1 :tstart) "\n")
  2129. (setq step-time (org-dblock-write:clocktable p1))
  2130. (re-search-forward "^[ \t]*#\\+END:")
  2131. (when (and (equal step-time 0) stepskip0)
  2132. ;; Remove the empty table
  2133. (delete-region (point-at-bol)
  2134. (save-excursion
  2135. (re-search-backward "^\\(Daily\\|Weekly\\) report"
  2136. nil t)
  2137. (point))))
  2138. (end-of-line 0))))
  2139. (defun org-clock-get-table-data (file params)
  2140. "Get the clocktable data for file FILE, with parameters PARAMS.
  2141. FILE is only for identification - this function assumes that
  2142. the correct buffer is current, and that the wanted restriction is
  2143. in place.
  2144. The return value will be a list with the file name and the total
  2145. file time (in minutes) as 1st and 2nd elements. The third element
  2146. of this list will be a list of headline entries. Each entry has the
  2147. following structure:
  2148. (LEVEL HEADLINE TIMESTAMP TIME)
  2149. LEVEL: The level of the headline, as an integer. This will be
  2150. the reduced leve, so 1,2,3,... even if only odd levels
  2151. are being used.
  2152. HEADLINE: The text of the headline. Depending on PARAMS, this may
  2153. already be formatted like a link.
  2154. TIMESTAMP: If PARAMS require it, this will be a time stamp found in the
  2155. entry, any of SCHEDULED, DEADLINE, NORMAL, or first inactive,
  2156. in this sequence.
  2157. TIME: The sum of all time spend in this tree, in minutes. This time
  2158. will of cause be restricted to the time block and tags match
  2159. specified in PARAMS."
  2160. (let* ((maxlevel (or (plist-get params :maxlevel) 3))
  2161. (timestamp (plist-get params :timestamp))
  2162. (ts (plist-get params :tstart))
  2163. (te (plist-get params :tend))
  2164. (block (plist-get params :block))
  2165. (link (plist-get params :link))
  2166. (tags (plist-get params :tags))
  2167. (matcher (if tags (cdr (org-make-tags-matcher tags))))
  2168. cc range-text st p time level hdl props tsp tbl)
  2169. (setq org-clock-file-total-minutes nil)
  2170. (when block
  2171. (setq cc (org-clock-special-range block nil t)
  2172. ts (car cc) te (nth 1 cc) range-text (nth 2 cc)))
  2173. (when (integerp ts) (setq ts (calendar-gregorian-from-absolute ts)))
  2174. (when (integerp te) (setq te (calendar-gregorian-from-absolute te)))
  2175. (when (and ts (listp ts))
  2176. (setq ts (format "%4d-%02d-%02d" (nth 2 ts) (car ts) (nth 1 ts))))
  2177. (when (and te (listp te))
  2178. (setq te (format "%4d-%02d-%02d" (nth 2 te) (car te) (nth 1 te))))
  2179. ;; Now the times are strings we can parse.
  2180. (if ts (setq ts (org-float-time
  2181. (apply 'encode-time (org-parse-time-string ts)))))
  2182. (if te (setq te (org-float-time
  2183. (apply 'encode-time (org-parse-time-string te)))))
  2184. (save-excursion
  2185. (org-clock-sum ts te
  2186. (unless (null matcher)
  2187. (lambda ()
  2188. (let ((tags-list (org-get-tags-at)))
  2189. (eval matcher)))))
  2190. (goto-char (point-min))
  2191. (setq st t)
  2192. (while (or (and (bobp) (prog1 st (setq st nil))
  2193. (get-text-property (point) :org-clock-minutes)
  2194. (setq p (point-min)))
  2195. (setq p (next-single-property-change
  2196. (point) :org-clock-minutes)))
  2197. (goto-char p)
  2198. (when (setq time (get-text-property p :org-clock-minutes))
  2199. (save-excursion
  2200. (beginning-of-line 1)
  2201. (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@#%:]+:\\)?[ \t]*$"))
  2202. (setq level (org-reduced-level
  2203. (- (match-end 1) (match-beginning 1))))
  2204. (<= level maxlevel))
  2205. (setq hdl (if (not link)
  2206. (match-string 2)
  2207. (org-make-link-string
  2208. (format "file:%s::%s"
  2209. (buffer-file-name)
  2210. (save-match-data
  2211. (org-make-org-heading-search-string
  2212. (match-string 2))))
  2213. (match-string 2)))
  2214. tsp (when timestamp
  2215. (setq props (org-entry-properties (point)))
  2216. (or (cdr (assoc "SCHEDULED" props))
  2217. (cdr (assoc "DEADLINE" props))
  2218. (cdr (assoc "TIMESTAMP" props))
  2219. (cdr (assoc "TIMESTAMP_IA" props)))))
  2220. (when (> time 0) (push (list level hdl tsp time) tbl))))))
  2221. (setq tbl (nreverse tbl))
  2222. (list file org-clock-file-total-minutes tbl))))
  2223. (defun org-clock-time% (total &rest strings)
  2224. "Compute a time fraction in percent.
  2225. TOTAL s a time string like 10:21 specifying the total times.
  2226. STRINGS is a list of strings that should be checked for a time.
  2227. The first string that does have a time will be used.
  2228. This function is made for clock tables."
  2229. (let ((re "\\([0-9]+\\):\\([0-9]+\\)")
  2230. tot s)
  2231. (save-match-data
  2232. (catch 'exit
  2233. (if (not (string-match re total))
  2234. (throw 'exit 0.)
  2235. (setq tot (+ (string-to-number (match-string 2 total))
  2236. (* 60 (string-to-number (match-string 1 total)))))
  2237. (if (= tot 0.) (throw 'exit 0.)))
  2238. (while (setq s (pop strings))
  2239. (if (string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
  2240. (throw 'exit
  2241. (/ (* 100.0 (+ (string-to-number (match-string 2 s))
  2242. (* 60 (string-to-number
  2243. (match-string 1 s)))))
  2244. tot))))
  2245. 0))))
  2246. (defvar org-clock-loaded nil
  2247. "Was the clock file loaded?")
  2248. (defun org-clock-save ()
  2249. "Persist various clock-related data to disk.
  2250. The details of what will be saved are regulated by the variable
  2251. `org-clock-persist'."
  2252. (when (and org-clock-persist
  2253. (or org-clock-loaded
  2254. org-clock-has-been-used
  2255. (not (file-exists-p org-clock-persist-file))))
  2256. (let (b)
  2257. (with-current-buffer (find-file (expand-file-name org-clock-persist-file))
  2258. (progn
  2259. (delete-region (point-min) (point-max))
  2260. ;;Store clock
  2261. (insert (format ";; org-persist.el - %s at %s\n"
  2262. system-name (format-time-string
  2263. (cdr org-time-stamp-formats))))
  2264. (if (and (memq org-clock-persist '(t clock))
  2265. (setq b (org-clocking-buffer))
  2266. (setq b (or (buffer-base-buffer b) b))
  2267. (buffer-live-p b)
  2268. (buffer-file-name b)
  2269. (or (not org-clock-persist-query-save)
  2270. (y-or-n-p (concat "Save current clock ("
  2271. (substring-no-properties
  2272. org-clock-heading)
  2273. ") "))))
  2274. (insert "(setq resume-clock '(\""
  2275. (buffer-file-name (org-clocking-buffer))
  2276. "\" . " (int-to-string (marker-position org-clock-marker))
  2277. "))\n"))
  2278. ;; Store clocked task history. Tasks are stored reversed to make
  2279. ;; reading simpler
  2280. (when (and (memq org-clock-persist '(t history))
  2281. org-clock-history)
  2282. (insert
  2283. "(setq stored-clock-history '("
  2284. (mapconcat
  2285. (lambda (m)
  2286. (when (and (setq b (marker-buffer m))
  2287. (setq b (or (buffer-base-buffer b) b))
  2288. (buffer-live-p b)
  2289. (buffer-file-name b))
  2290. (concat "(\"" (buffer-file-name b)
  2291. "\" . " (int-to-string (marker-position m))
  2292. ")")))
  2293. (reverse org-clock-history) " ") "))\n"))
  2294. (save-buffer)
  2295. (kill-buffer (current-buffer)))))))
  2296. (defun org-clock-load ()
  2297. "Load clock-related data from disk, maybe resuming a stored clock."
  2298. (when (and org-clock-persist (not org-clock-loaded))
  2299. (let ((filename (expand-file-name org-clock-persist-file))
  2300. (org-clock-in-resume 'auto-restart)
  2301. resume-clock stored-clock-history)
  2302. (if (not (file-readable-p filename))
  2303. (message "Not restoring clock data; %s not found"
  2304. org-clock-persist-file)
  2305. (message "%s" "Restoring clock data")
  2306. (setq org-clock-loaded t)
  2307. (load-file filename)
  2308. ;; load history
  2309. (when stored-clock-history
  2310. (save-window-excursion
  2311. (mapc (lambda (task)
  2312. (if (file-exists-p (car task))
  2313. (org-clock-history-push (cdr task)
  2314. (find-file (car task)))))
  2315. stored-clock-history)))
  2316. ;; resume clock
  2317. (when (and resume-clock org-clock-persist
  2318. (file-exists-p (car resume-clock))
  2319. (or (not org-clock-persist-query-resume)
  2320. (y-or-n-p
  2321. (concat
  2322. "Resume clock ("
  2323. (with-current-buffer (find-file (car resume-clock))
  2324. (save-excursion
  2325. (goto-char (cdr resume-clock))
  2326. (org-back-to-heading t)
  2327. (and (looking-at org-complex-heading-regexp)
  2328. (match-string 4))))
  2329. ") "))))
  2330. (when (file-exists-p (car resume-clock))
  2331. (with-current-buffer (find-file (car resume-clock))
  2332. (goto-char (cdr resume-clock))
  2333. (let ((org-clock-auto-clock-resolution nil))
  2334. (org-clock-in)
  2335. (if (outline-invisible-p)
  2336. (org-show-context))))))))))
  2337. ;;;###autoload
  2338. (defun org-clock-persistence-insinuate ()
  2339. "Set up hooks for clock persistence."
  2340. (add-hook 'org-mode-hook 'org-clock-load)
  2341. (add-hook 'kill-emacs-hook 'org-clock-save))
  2342. ;; Suggested bindings
  2343. (org-defkey org-mode-map "\C-c\C-x\C-e" 'org-clock-modify-effort-estimate)
  2344. (provide 'org-clock)
  2345. ;; arch-tag: 7b42c5d4-9b36-48be-97c0-66a869daed4c
  2346. ;;; org-clock.el ends here