org-clock.el 97 KB

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