org-clock.el 104 KB

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