org-clock.el 95 KB

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