org-clock.el 105 KB

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