org-clock.el 116 KB

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