org-clock.el 116 KB

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