org-clock.el 103 KB

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