org-clock.el 96 KB

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