org-clock.el 113 KB

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