org.el 819 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787
  1. ;;; org.el --- Outline-based notes management and organizer
  2. ;; Carstens outline-mode for keeping track of everything.
  3. ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
  4. ;;
  5. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  6. ;; Maintainer: Bastien Guerry <bzg at gnu dot org>
  7. ;; Keywords: outlines, hypermedia, calendar, wp
  8. ;; Homepage: http://orgmode.org
  9. ;;
  10. ;; This file is part of GNU Emacs.
  11. ;;
  12. ;; GNU Emacs is free software: you can redistribute it and/or modify
  13. ;; it under the terms of the GNU General Public License as published by
  14. ;; the Free Software Foundation, either version 3 of the License, or
  15. ;; (at your option) any later version.
  16. ;; GNU Emacs is distributed in the hope that it will be useful,
  17. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. ;; GNU General Public License for more details.
  20. ;; You should have received a copy of the GNU General Public License
  21. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  22. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  23. ;;
  24. ;;; Commentary:
  25. ;;
  26. ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
  27. ;; project planning with a fast and effective plain-text system.
  28. ;;
  29. ;; Org-mode develops organizational tasks around NOTES files that contain
  30. ;; information about projects as plain text. Org-mode is implemented on
  31. ;; top of outline-mode, which makes it possible to keep the content of
  32. ;; large files well structured. Visibility cycling and structure editing
  33. ;; help to work with the tree. Tables are easily created with a built-in
  34. ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
  35. ;; and scheduling. It dynamically compiles entries into an agenda that
  36. ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
  37. ;; Plain text URL-like links connect to websites, emails, Usenet
  38. ;; messages, BBDB entries, and any files related to the projects. For
  39. ;; printing and sharing of notes, an Org-mode file can be exported as a
  40. ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
  41. ;; iCalendar file. It can also serve as a publishing tool for a set of
  42. ;; linked webpages.
  43. ;;
  44. ;; Installation and Activation
  45. ;; ---------------------------
  46. ;; See the corresponding sections in the manual at
  47. ;;
  48. ;; http://orgmode.org/org.html#Installation
  49. ;;
  50. ;; Documentation
  51. ;; -------------
  52. ;; The documentation of Org-mode can be found in the TeXInfo file. The
  53. ;; distribution also contains a PDF version of it. At the homepage of
  54. ;; Org-mode, you can read the same text online as HTML. There is also an
  55. ;; excellent reference card made by Philip Rooke. This card can be found
  56. ;; in the etc/ directory of Emacs 22.
  57. ;;
  58. ;; A list of recent changes can be found at
  59. ;; http://orgmode.org/Changes.html
  60. ;;
  61. ;;; Code:
  62. (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
  63. (defvar org-table-formula-constants-local nil
  64. "Local version of `org-table-formula-constants'.")
  65. (make-variable-buffer-local 'org-table-formula-constants-local)
  66. ;;;; Require other packages
  67. (eval-when-compile
  68. (require 'cl)
  69. (require 'gnus-sum))
  70. (require 'calendar)
  71. (require 'find-func)
  72. (require 'format-spec)
  73. ;; Emacs 22 calendar compatibility: Make sure the new variables are available
  74. (when (fboundp 'defvaralias)
  75. (unless (boundp 'calendar-view-holidays-initially-flag)
  76. (defvaralias 'calendar-view-holidays-initially-flag
  77. 'view-calendar-holidays-initially))
  78. (unless (boundp 'calendar-view-diary-initially-flag)
  79. (defvaralias 'calendar-view-diary-initially-flag
  80. 'view-diary-entries-initially))
  81. (unless (boundp 'diary-fancy-buffer)
  82. (defvaralias 'diary-fancy-buffer 'fancy-diary-buffer)))
  83. (require 'outline)
  84. (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
  85. ;; Other stuff we need.
  86. (require 'time-date)
  87. (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
  88. (require 'easymenu)
  89. (require 'overlay)
  90. (require 'org-macs)
  91. (require 'org-entities)
  92. (require 'org-compat)
  93. (require 'org-faces)
  94. (require 'org-list)
  95. (require 'org-pcomplete)
  96. (require 'org-src)
  97. (require 'org-footnote)
  98. (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
  99. (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
  100. (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
  101. (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
  102. (declare-function org-at-clock-log-p "org-clock" ())
  103. (declare-function org-clock-timestamps-up "org-clock" ())
  104. (declare-function org-clock-timestamps-down "org-clock" ())
  105. ;; babel
  106. (require 'ob)
  107. (require 'ob-table)
  108. (require 'ob-lob)
  109. (require 'ob-ref)
  110. (require 'ob-tangle)
  111. (require 'ob-comint)
  112. (require 'ob-keys)
  113. ;; load languages based on value of `org-babel-load-languages'
  114. (defvar org-babel-load-languages)
  115. ;;;###autoload
  116. (defun org-babel-do-load-languages (sym value)
  117. "Load the languages defined in `org-babel-load-languages'."
  118. (set-default sym value)
  119. (mapc (lambda (pair)
  120. (let ((active (cdr pair)) (lang (symbol-name (car pair))))
  121. (if active
  122. (progn
  123. (require (intern (concat "ob-" lang))))
  124. (progn
  125. (funcall 'fmakunbound
  126. (intern (concat "org-babel-execute:" lang)))
  127. (funcall 'fmakunbound
  128. (intern (concat "org-babel-expand-body:" lang)))))))
  129. org-babel-load-languages))
  130. (defcustom org-babel-load-languages '((emacs-lisp . t))
  131. "Languages which can be evaluated in Org-mode buffers.
  132. This list can be used to load support for any of the languages
  133. below, note that each language will depend on a different set of
  134. system executables and/or Emacs modes. When a language is
  135. \"loaded\", then code blocks in that language can be evaluated
  136. with `org-babel-execute-src-block' bound by default to C-c
  137. C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
  138. be set to remove code block evaluation from the C-c C-c
  139. keybinding. By default only Emacs Lisp (which has no
  140. requirements) is loaded."
  141. :group 'org-babel
  142. :set 'org-babel-do-load-languages
  143. :version "24.1"
  144. :type '(alist :tag "Babel Languages"
  145. :key-type
  146. (choice
  147. (const :tag "Awk" awk)
  148. (const :tag "C" C)
  149. (const :tag "R" R)
  150. (const :tag "Asymptote" asymptote)
  151. (const :tag "Calc" calc)
  152. (const :tag "Clojure" clojure)
  153. (const :tag "CSS" css)
  154. (const :tag "Ditaa" ditaa)
  155. (const :tag "Dot" dot)
  156. (const :tag "Emacs Lisp" emacs-lisp)
  157. (const :tag "Fortran" fortran)
  158. (const :tag "Gnuplot" gnuplot)
  159. (const :tag "Haskell" haskell)
  160. (const :tag "IO" io)
  161. (const :tag "Java" java)
  162. (const :tag "Javascript" js)
  163. (const :tag "LaTeX" latex)
  164. (const :tag "Ledger" ledger)
  165. (const :tag "Lilypond" lilypond)
  166. (const :tag "Maxima" maxima)
  167. (const :tag "Matlab" matlab)
  168. (const :tag "Mscgen" mscgen)
  169. (const :tag "Ocaml" ocaml)
  170. (const :tag "Octave" octave)
  171. (const :tag "Org" org)
  172. (const :tag "Perl" perl)
  173. (const :tag "Pico Lisp" picolisp)
  174. (const :tag "PlantUML" plantuml)
  175. (const :tag "Python" python)
  176. (const :tag "Ruby" ruby)
  177. (const :tag "Sass" sass)
  178. (const :tag "Scala" scala)
  179. (const :tag "Scheme" scheme)
  180. (const :tag "Screen" screen)
  181. (const :tag "Shell Script" sh)
  182. (const :tag "Shen" shen)
  183. (const :tag "Sql" sql)
  184. (const :tag "Sqlite" sqlite))
  185. :value-type (boolean :tag "Activate" :value t)))
  186. ;;;; Customization variables
  187. (defcustom org-clone-delete-id nil
  188. "Remove ID property of clones of a subtree.
  189. When non-nil, clones of a subtree don't inherit the ID property.
  190. Otherwise they inherit the ID property with a new unique
  191. identifier."
  192. :type 'boolean
  193. :version "24.1"
  194. :group 'org-id)
  195. ;;; Version
  196. (org-check-version)
  197. ;;;###autoload
  198. (defun org-version (&optional here full message)
  199. "Show the org-mode version in the echo area.
  200. With prefix arg HERE, insert it at point."
  201. (interactive "P")
  202. (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
  203. (org-install-dir (ignore-errors (org-find-library-dir "org-install.el")))
  204. (org-trash (or
  205. (and (fboundp 'org-release) (fboundp 'org-git-version))
  206. (load (concat org-dir "org-version.el")
  207. 'noerror 'nomessage 'nosuffix)))
  208. (org-version (org-release))
  209. (git-version (org-git-version))
  210. (version (format "Org-mode version %s (%s @ %s)"
  211. org-version
  212. git-version
  213. (if org-install-dir
  214. (if (string= org-dir org-install-dir)
  215. org-install-dir
  216. (concat "mixed installation! " org-install-dir " and " org-dir))
  217. "org-install.el can not be found!")))
  218. (_version (if full version org-version)))
  219. (if (org-called-interactively-p 'interactive)
  220. (if here
  221. (insert version)
  222. (message version))
  223. (if message (message _version))
  224. _version)))
  225. ;;; Compatibility constants
  226. ;;; The custom variables
  227. (defgroup org nil
  228. "Outline-based notes management and organizer."
  229. :tag "Org"
  230. :group 'outlines
  231. :group 'calendar)
  232. (defcustom org-mode-hook nil
  233. "Mode hook for Org-mode, run after the mode was turned on."
  234. :group 'org
  235. :type 'hook)
  236. (defcustom org-load-hook nil
  237. "Hook that is run after org.el has been loaded."
  238. :group 'org
  239. :type 'hook)
  240. (defcustom org-log-buffer-setup-hook nil
  241. "Hook that is run after an Org log buffer is created."
  242. :group 'org
  243. :version "24.1"
  244. :type 'hook)
  245. (defvar org-modules) ; defined below
  246. (defvar org-modules-loaded nil
  247. "Have the modules been loaded already?")
  248. (defun org-load-modules-maybe (&optional force)
  249. "Load all extensions listed in `org-modules'."
  250. (when (or force (not org-modules-loaded))
  251. (mapc (lambda (ext)
  252. (condition-case nil (require ext)
  253. (error (message "Problems while trying to load feature `%s'" ext))))
  254. org-modules)
  255. (setq org-modules-loaded t)))
  256. (defun org-set-modules (var value)
  257. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  258. (set var value)
  259. (when (featurep 'org)
  260. (org-load-modules-maybe 'force)))
  261. (when (org-bound-and-true-p org-modules)
  262. (let ((a (member 'org-infojs org-modules)))
  263. (and a (setcar a 'org-jsinfo))))
  264. (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
  265. "Modules that should always be loaded together with org.el.
  266. If a description starts with <C>, the file is not part of Emacs
  267. and loading it will require that you have downloaded and properly installed
  268. the org-mode distribution.
  269. You can also use this system to load external packages (i.e. neither Org
  270. core modules, nor modules from the CONTRIB directory). Just add symbols
  271. to the end of the list. If the package is called org-xyz.el, then you need
  272. to add the symbol `xyz', and the package must have a call to
  273. (provide 'org-xyz)"
  274. :group 'org
  275. :set 'org-set-modules
  276. :type
  277. '(set :greedy t
  278. (const :tag " bbdb: Links to BBDB entries" org-bbdb)
  279. (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
  280. (const :tag " crypt: Encryption of subtrees" org-crypt)
  281. (const :tag " ctags: Access to Emacs tags with links" org-ctags)
  282. (const :tag " docview: Links to doc-view buffers" org-docview)
  283. (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
  284. (const :tag " id: Global IDs for identifying entries" org-id)
  285. (const :tag " info: Links to Info nodes" org-info)
  286. (const :tag " jsinfo: Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo)
  287. (const :tag " habit: Track your consistency with habits" org-habit)
  288. (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
  289. (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
  290. (const :tag " mac-message: Links to messages in Apple Mail" org-mac-message)
  291. (const :tag " mew Links to Mew folders/messages" org-mew)
  292. (const :tag " mhe: Links to MHE folders/messages" org-mhe)
  293. (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
  294. (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
  295. (const :tag " special-blocks: Turn blocks into LaTeX envs and HTML divs" org-special-blocks)
  296. (const :tag " vm: Links to VM folders/messages" org-vm)
  297. (const :tag " wl: Links to Wanderlust folders/messages" org-wl)
  298. (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
  299. (const :tag " mouse: Additional mouse support" org-mouse)
  300. (const :tag " TaskJuggler: Export tasks to a TaskJuggler project" org-taskjuggler)
  301. (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
  302. (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
  303. (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
  304. (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
  305. (const :tag "C collector: Collect properties into tables" org-collector)
  306. (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
  307. (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
  308. (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
  309. (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
  310. (const :tag "C eval: Include command output as text" org-eval)
  311. (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
  312. (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
  313. (const :tag "C exp-bibtex: Export citations using BibTeX" org-exp-bibtex)
  314. (const :tag "C git-link: Provide org links to specific file version" org-git-link)
  315. (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
  316. (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
  317. (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
  318. (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
  319. (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
  320. (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
  321. (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
  322. (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
  323. (const :tag "C man: Support for links to manpages in Org-mode" org-man)
  324. (const :tag "C mtags: Support for muse-like tags" org-mtags)
  325. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  326. (const :tag "C registry: A registry for Org-mode links" org-registry)
  327. (const :tag "C org2rem: Convert org appointments into reminders" org2rem)
  328. (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
  329. (const :tag "C secretary: Team management with org-mode" org-secretary)
  330. (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
  331. (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
  332. (const :tag "C track: Keep up with Org-mode development" org-track)
  333. (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
  334. (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
  335. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  336. (defcustom org-support-shift-select nil
  337. "Non-nil means make shift-cursor commands select text when possible.
  338. In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
  339. start selecting a region, or enlarge regions started in this way.
  340. In Org-mode, in special contexts, these same keys are used for
  341. other purposes, important enough to compete with shift selection.
  342. Org tries to balance these needs by supporting `shift-select-mode'
  343. outside these special contexts, under control of this variable.
  344. The default of this variable is nil, to avoid confusing behavior. Shifted
  345. cursor keys will then execute Org commands in the following contexts:
  346. - on a headline, changing TODO state (left/right) and priority (up/down)
  347. - on a time stamp, changing the time
  348. - in a plain list item, changing the bullet type
  349. - in a property definition line, switching between allowed values
  350. - in the BEGIN line of a clock table (changing the time block).
  351. Outside these contexts, the commands will throw an error.
  352. When this variable is t and the cursor is not in a special
  353. context, Org-mode will support shift-selection for making and
  354. enlarging regions. To make this more effective, the bullet
  355. cycling will no longer happen anywhere in an item line, but only
  356. if the cursor is exactly on the bullet.
  357. If you set this variable to the symbol `always', then the keys
  358. will not be special in headlines, property lines, and item lines,
  359. to make shift selection work there as well. If this is what you
  360. want, you can use the following alternative commands: `C-c C-t'
  361. and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
  362. can be used to switch TODO sets, `C-c -' to cycle item bullet
  363. types, and properties can be edited by hand or in column view.
  364. However, when the cursor is on a timestamp, shift-cursor commands
  365. will still edit the time stamp - this is just too good to give up.
  366. XEmacs user should have this variable set to nil, because
  367. `shift-select-mode' is in Emacs 23 or later only."
  368. :group 'org
  369. :type '(choice
  370. (const :tag "Never" nil)
  371. (const :tag "When outside special context" t)
  372. (const :tag "Everywhere except timestamps" always)))
  373. (defcustom org-loop-over-headlines-in-active-region nil
  374. "Shall some commands act upon headlines in the active region?
  375. When set to `t', some commands will be performed in all headlines
  376. within the active region.
  377. When set to `start-level', some commands will be performed in all
  378. headlines within the active region, provided that these headlines
  379. are of the same level than the first one.
  380. When set to a string, those commands will be performed on the
  381. matching headlines within the active region. Such string must be
  382. a tags/property/todo match as it is used in the agenda tags view.
  383. The list of commands is: `org-schedule', `org-deadline',
  384. `org-todo', `org-archive-subtree', `org-archive-set-tag' and
  385. `org-archive-to-archive-sibling'. The archiving commands skip
  386. already archived entries."
  387. :type '(choice (const :tag "Don't loop" nil)
  388. (const :tag "All headlines in active region" t)
  389. (const :tag "In active region, headlines at the same level than the first one" 'start-level)
  390. (string :tag "Tags/Property/Todo matcher"))
  391. :version "24.1"
  392. :group 'org-todo
  393. :group 'org-archive)
  394. (defgroup org-startup nil
  395. "Options concerning startup of Org-mode."
  396. :tag "Org Startup"
  397. :group 'org)
  398. (defcustom org-startup-folded t
  399. "Non-nil means entering Org-mode will switch to OVERVIEW.
  400. This can also be configured on a per-file basis by adding one of
  401. the following lines anywhere in the buffer:
  402. #+STARTUP: fold (or `overview', this is equivalent)
  403. #+STARTUP: nofold (or `showall', this is equivalent)
  404. #+STARTUP: content
  405. #+STARTUP: showeverything"
  406. :group 'org-startup
  407. :type '(choice
  408. (const :tag "nofold: show all" nil)
  409. (const :tag "fold: overview" t)
  410. (const :tag "content: all headlines" content)
  411. (const :tag "show everything, even drawers" showeverything)))
  412. (defcustom org-startup-truncated t
  413. "Non-nil means entering Org-mode will set `truncate-lines'.
  414. This is useful since some lines containing links can be very long and
  415. uninteresting. Also tables look terrible when wrapped."
  416. :group 'org-startup
  417. :type 'boolean)
  418. (defcustom org-startup-indented nil
  419. "Non-nil means turn on `org-indent-mode' on startup.
  420. This can also be configured on a per-file basis by adding one of
  421. the following lines anywhere in the buffer:
  422. #+STARTUP: indent
  423. #+STARTUP: noindent"
  424. :group 'org-structure
  425. :type '(choice
  426. (const :tag "Not" nil)
  427. (const :tag "Globally (slow on startup in large files)" t)))
  428. (defcustom org-use-sub-superscripts t
  429. "Non-nil means interpret \"_\" and \"^\" for export.
  430. When this option is turned on, you can use TeX-like syntax for sub- and
  431. superscripts. Several characters after \"_\" or \"^\" will be
  432. considered as a single item - so grouping with {} is normally not
  433. needed. For example, the following things will be parsed as single
  434. sub- or superscripts.
  435. 10^24 or 10^tau several digits will be considered 1 item.
  436. 10^-12 or 10^-tau a leading sign with digits or a word
  437. x^2-y^3 will be read as x^2 - y^3, because items are
  438. terminated by almost any nonword/nondigit char.
  439. x_{i^2} or x^(2-i) braces or parenthesis do grouping.
  440. Still, ambiguity is possible - so when in doubt use {} to enclose the
  441. sub/superscript. If you set this variable to the symbol `{}',
  442. the braces are *required* in order to trigger interpretations as
  443. sub/superscript. This can be helpful in documents that need \"_\"
  444. frequently in plain text.
  445. Not all export backends support this, but HTML does.
  446. This option can also be set with the #+OPTIONS line, e.g. \"^:nil\"."
  447. :group 'org-startup
  448. :group 'org-export-translation
  449. :version "24.1"
  450. :type '(choice
  451. (const :tag "Always interpret" t)
  452. (const :tag "Only with braces" {})
  453. (const :tag "Never interpret" nil)))
  454. (if (fboundp 'defvaralias)
  455. (defvaralias 'org-export-with-sub-superscripts 'org-use-sub-superscripts))
  456. (defcustom org-startup-with-beamer-mode nil
  457. "Non-nil means turn on `org-beamer-mode' on startup.
  458. This can also be configured on a per-file basis by adding one of
  459. the following lines anywhere in the buffer:
  460. #+STARTUP: beamer"
  461. :group 'org-startup
  462. :version "24.1"
  463. :type 'boolean)
  464. (defcustom org-startup-align-all-tables nil
  465. "Non-nil means align all tables when visiting a file.
  466. This is useful when the column width in tables is forced with <N> cookies
  467. in table fields. Such tables will look correct only after the first re-align.
  468. This can also be configured on a per-file basis by adding one of
  469. the following lines anywhere in the buffer:
  470. #+STARTUP: align
  471. #+STARTUP: noalign"
  472. :group 'org-startup
  473. :type 'boolean)
  474. (defcustom org-startup-with-inline-images nil
  475. "Non-nil means show inline images when loading a new Org file.
  476. This can also be configured on a per-file basis by adding one of
  477. the following lines anywhere in the buffer:
  478. #+STARTUP: inlineimages
  479. #+STARTUP: noinlineimages"
  480. :group 'org-startup
  481. :version "24.1"
  482. :type 'boolean)
  483. (defcustom org-insert-mode-line-in-empty-file nil
  484. "Non-nil means insert the first line setting Org-mode in empty files.
  485. When the function `org-mode' is called interactively in an empty file, this
  486. normally means that the file name does not automatically trigger Org-mode.
  487. To ensure that the file will always be in Org-mode in the future, a
  488. line enforcing Org-mode will be inserted into the buffer, if this option
  489. has been set."
  490. :group 'org-startup
  491. :type 'boolean)
  492. (defcustom org-replace-disputed-keys nil
  493. "Non-nil means use alternative key bindings for some keys.
  494. Org-mode uses S-<cursor> keys for changing timestamps and priorities.
  495. These keys are also used by other packages like shift-selection-mode'
  496. \(built into Emacs 23), `CUA-mode' or `windmove.el'.
  497. If you want to use Org-mode together with one of these other modes,
  498. or more generally if you would like to move some Org-mode commands to
  499. other keys, set this variable and configure the keys with the variable
  500. `org-disputed-keys'.
  501. This option is only relevant at load-time of Org-mode, and must be set
  502. *before* org.el is loaded. Changing it requires a restart of Emacs to
  503. become effective."
  504. :group 'org-startup
  505. :type 'boolean)
  506. (defcustom org-use-extra-keys nil
  507. "Non-nil means use extra key sequence definitions for certain commands.
  508. This happens automatically if you run XEmacs or if `window-system'
  509. is nil. This variable lets you do the same manually. You must
  510. set it before loading org.
  511. Example: on Carbon Emacs 22 running graphically, with an external
  512. keyboard on a Powerbook, the default way of setting M-left might
  513. not work for either Alt or ESC. Setting this variable will make
  514. it work for ESC."
  515. :group 'org-startup
  516. :type 'boolean)
  517. (if (fboundp 'defvaralias)
  518. (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys))
  519. (defcustom org-disputed-keys
  520. '(([(shift up)] . [(meta p)])
  521. ([(shift down)] . [(meta n)])
  522. ([(shift left)] . [(meta -)])
  523. ([(shift right)] . [(meta +)])
  524. ([(control shift right)] . [(meta shift +)])
  525. ([(control shift left)] . [(meta shift -)]))
  526. "Keys for which Org-mode and other modes compete.
  527. This is an alist, cars are the default keys, second element specifies
  528. the alternative to use when `org-replace-disputed-keys' is t.
  529. Keys can be specified in any syntax supported by `define-key'.
  530. The value of this option takes effect only at Org-mode's startup,
  531. therefore you'll have to restart Emacs to apply it after changing."
  532. :group 'org-startup
  533. :type 'alist)
  534. (defun org-key (key)
  535. "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
  536. Or return the original if not disputed.
  537. Also apply the translations defined in `org-xemacs-key-equivalents'."
  538. (when org-replace-disputed-keys
  539. (let* ((nkey (key-description key))
  540. (x (org-find-if (lambda (x)
  541. (equal (key-description (car x)) nkey))
  542. org-disputed-keys)))
  543. (setq key (if x (cdr x) key))))
  544. (when (featurep 'xemacs)
  545. (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
  546. key)
  547. (defun org-find-if (predicate seq)
  548. (catch 'exit
  549. (while seq
  550. (if (funcall predicate (car seq))
  551. (throw 'exit (car seq))
  552. (pop seq)))))
  553. (defun org-defkey (keymap key def)
  554. "Define a key, possibly translated, as returned by `org-key'."
  555. (define-key keymap (org-key key) def))
  556. (defcustom org-ellipsis nil
  557. "The ellipsis to use in the Org-mode outline.
  558. When nil, just use the standard three dots. When a string, use that instead,
  559. When a face, use the standard 3 dots, but with the specified face.
  560. The change affects only Org-mode (which will then use its own display table).
  561. Changing this requires executing `M-x org-mode' in a buffer to become
  562. effective."
  563. :group 'org-startup
  564. :type '(choice (const :tag "Default" nil)
  565. (face :tag "Face" :value org-warning)
  566. (string :tag "String" :value "...#")))
  567. (defvar org-display-table nil
  568. "The display table for org-mode, in case `org-ellipsis' is non-nil.")
  569. (defgroup org-keywords nil
  570. "Keywords in Org-mode."
  571. :tag "Org Keywords"
  572. :group 'org)
  573. (defcustom org-deadline-string "DEADLINE:"
  574. "String to mark deadline entries.
  575. A deadline is this string, followed by a time stamp. Should be a word,
  576. terminated by a colon. You can insert a schedule keyword and
  577. a timestamp with \\[org-deadline].
  578. Changes become only effective after restarting Emacs."
  579. :group 'org-keywords
  580. :type 'string)
  581. (defcustom org-scheduled-string "SCHEDULED:"
  582. "String to mark scheduled TODO entries.
  583. A schedule is this string, followed by a time stamp. Should be a word,
  584. terminated by a colon. You can insert a schedule keyword and
  585. a timestamp with \\[org-schedule].
  586. Changes become only effective after restarting Emacs."
  587. :group 'org-keywords
  588. :type 'string)
  589. (defcustom org-closed-string "CLOSED:"
  590. "String used as the prefix for timestamps logging closing a TODO entry."
  591. :group 'org-keywords
  592. :type 'string)
  593. (defcustom org-clock-string "CLOCK:"
  594. "String used as prefix for timestamps clocking work hours on an item."
  595. :group 'org-keywords
  596. :type 'string)
  597. (defcustom org-comment-string "COMMENT"
  598. "Entries starting with this keyword will never be exported.
  599. An entry can be toggled between COMMENT and normal with
  600. \\[org-toggle-comment].
  601. Changes become only effective after restarting Emacs."
  602. :group 'org-keywords
  603. :type 'string)
  604. (defcustom org-quote-string "QUOTE"
  605. "Entries starting with this keyword will be exported in fixed-width font.
  606. Quoting applies only to the text in the entry following the headline, and does
  607. not extend beyond the next headline, even if that is lower level.
  608. An entry can be toggled between QUOTE and normal with
  609. \\[org-toggle-fixed-width-section]."
  610. :group 'org-keywords
  611. :type 'string)
  612. (defconst org-repeat-re
  613. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
  614. "Regular expression for specifying repeated events.
  615. After a match, group 1 contains the repeat expression.")
  616. (defgroup org-structure nil
  617. "Options concerning the general structure of Org-mode files."
  618. :tag "Org Structure"
  619. :group 'org)
  620. (defgroup org-reveal-location nil
  621. "Options about how to make context of a location visible."
  622. :tag "Org Reveal Location"
  623. :group 'org-structure)
  624. (defconst org-context-choice
  625. '(choice
  626. (const :tag "Always" t)
  627. (const :tag "Never" nil)
  628. (repeat :greedy t :tag "Individual contexts"
  629. (cons
  630. (choice :tag "Context"
  631. (const agenda)
  632. (const org-goto)
  633. (const occur-tree)
  634. (const tags-tree)
  635. (const link-search)
  636. (const mark-goto)
  637. (const bookmark-jump)
  638. (const isearch)
  639. (const default))
  640. (boolean))))
  641. "Contexts for the reveal options.")
  642. (defcustom org-show-hierarchy-above '((default . t))
  643. "Non-nil means show full hierarchy when revealing a location.
  644. Org-mode often shows locations in an org-mode file which might have
  645. been invisible before. When this is set, the hierarchy of headings
  646. above the exposed location is shown.
  647. Turning this off for example for sparse trees makes them very compact.
  648. Instead of t, this can also be an alist specifying this option for different
  649. contexts. Valid contexts are
  650. agenda when exposing an entry from the agenda
  651. org-goto when using the command `org-goto' on key C-c C-j
  652. occur-tree when using the command `org-occur' on key C-c /
  653. tags-tree when constructing a sparse tree based on tags matches
  654. link-search when exposing search matches associated with a link
  655. mark-goto when exposing the jump goal of a mark
  656. bookmark-jump when exposing a bookmark location
  657. isearch when exiting from an incremental search
  658. default default for all contexts not set explicitly"
  659. :group 'org-reveal-location
  660. :type org-context-choice)
  661. (defcustom org-show-following-heading '((default . nil))
  662. "Non-nil means show following heading when revealing a location.
  663. Org-mode often shows locations in an org-mode file which might have
  664. been invisible before. When this is set, the heading following the
  665. match is shown.
  666. Turning this off for example for sparse trees makes them very compact,
  667. but makes it harder to edit the location of the match. In such a case,
  668. use the command \\[org-reveal] to show more context.
  669. Instead of t, this can also be an alist specifying this option for different
  670. contexts. See `org-show-hierarchy-above' for valid contexts."
  671. :group 'org-reveal-location
  672. :type org-context-choice)
  673. (defcustom org-show-siblings '((default . nil) (isearch t))
  674. "Non-nil means show all sibling heading when revealing a location.
  675. Org-mode often shows locations in an org-mode file which might have
  676. been invisible before. When this is set, the sibling of the current entry
  677. heading are all made visible. If `org-show-hierarchy-above' is t,
  678. the same happens on each level of the hierarchy above the current entry.
  679. By default this is on for the isearch context, off for all other contexts.
  680. Turning this off for example for sparse trees makes them very compact,
  681. but makes it harder to edit the location of the match. In such a case,
  682. use the command \\[org-reveal] to show more context.
  683. Instead of t, this can also be an alist specifying this option for different
  684. contexts. See `org-show-hierarchy-above' for valid contexts."
  685. :group 'org-reveal-location
  686. :type org-context-choice)
  687. (defcustom org-show-entry-below '((default . nil))
  688. "Non-nil means show the entry below a headline when revealing a location.
  689. Org-mode often shows locations in an org-mode file which might have
  690. been invisible before. When this is set, the text below the headline that is
  691. exposed is also shown.
  692. By default this is off for all contexts.
  693. Instead of t, this can also be an alist specifying this option for different
  694. contexts. See `org-show-hierarchy-above' for valid contexts."
  695. :group 'org-reveal-location
  696. :type org-context-choice)
  697. (defcustom org-indirect-buffer-display 'other-window
  698. "How should indirect tree buffers be displayed?
  699. This applies to indirect buffers created with the commands
  700. \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
  701. Valid values are:
  702. current-window Display in the current window
  703. other-window Just display in another window.
  704. dedicated-frame Create one new frame, and re-use it each time.
  705. new-frame Make a new frame each time. Note that in this case
  706. previously-made indirect buffers are kept, and you need to
  707. kill these buffers yourself."
  708. :group 'org-structure
  709. :group 'org-agenda-windows
  710. :type '(choice
  711. (const :tag "In current window" current-window)
  712. (const :tag "In current frame, other window" other-window)
  713. (const :tag "Each time a new frame" new-frame)
  714. (const :tag "One dedicated frame" dedicated-frame)))
  715. (defcustom org-use-speed-commands nil
  716. "Non-nil means activate single letter commands at beginning of a headline.
  717. This may also be a function to test for appropriate locations where speed
  718. commands should be active."
  719. :group 'org-structure
  720. :type '(choice
  721. (const :tag "Never" nil)
  722. (const :tag "At beginning of headline stars" t)
  723. (function)))
  724. (defcustom org-speed-commands-user nil
  725. "Alist of additional speed commands.
  726. This list will be checked before `org-speed-commands-default'
  727. when the variable `org-use-speed-commands' is non-nil
  728. and when the cursor is at the beginning of a headline.
  729. The car if each entry is a string with a single letter, which must
  730. be assigned to `self-insert-command' in the global map.
  731. The cdr is either a command to be called interactively, a function
  732. to be called, or a form to be evaluated.
  733. An entry that is just a list with a single string will be interpreted
  734. as a descriptive headline that will be added when listing the speed
  735. commands in the Help buffer using the `?' speed command."
  736. :group 'org-structure
  737. :type '(repeat :value ("k" . ignore)
  738. (choice :value ("k" . ignore)
  739. (list :tag "Descriptive Headline" (string :tag "Headline"))
  740. (cons :tag "Letter and Command"
  741. (string :tag "Command letter")
  742. (choice
  743. (function)
  744. (sexp))))))
  745. (defgroup org-cycle nil
  746. "Options concerning visibility cycling in Org-mode."
  747. :tag "Org Cycle"
  748. :group 'org-structure)
  749. (defcustom org-cycle-skip-children-state-if-no-children t
  750. "Non-nil means skip CHILDREN state in entries that don't have any."
  751. :group 'org-cycle
  752. :type 'boolean)
  753. (defcustom org-cycle-max-level nil
  754. "Maximum level which should still be subject to visibility cycling.
  755. Levels higher than this will, for cycling, be treated as text, not a headline.
  756. When `org-odd-levels-only' is set, a value of N in this variable actually
  757. means 2N-1 stars as the limiting headline.
  758. When nil, cycle all levels.
  759. Note that the limiting level of cycling is also influenced by
  760. `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
  761. `org-inlinetask-min-level' is, cycling will be limited to levels one less
  762. than its value."
  763. :group 'org-cycle
  764. :type '(choice
  765. (const :tag "No limit" nil)
  766. (integer :tag "Maximum level")))
  767. (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK" "RESULTS")
  768. "Names of drawers. Drawers are not opened by cycling on the headline above.
  769. Drawers only open with a TAB on the drawer line itself. A drawer looks like
  770. this:
  771. :DRAWERNAME:
  772. .....
  773. :END:
  774. The drawer \"PROPERTIES\" is special for capturing properties through
  775. the property API.
  776. Drawers can be defined on the per-file basis with a line like:
  777. #+DRAWERS: HIDDEN STATE PROPERTIES"
  778. :group 'org-structure
  779. :group 'org-cycle
  780. :type '(repeat (string :tag "Drawer Name")))
  781. (defcustom org-hide-block-startup nil
  782. "Non-nil means entering Org-mode will fold all blocks.
  783. This can also be set in on a per-file basis with
  784. #+STARTUP: hideblocks
  785. #+STARTUP: showblocks"
  786. :group 'org-startup
  787. :group 'org-cycle
  788. :type 'boolean)
  789. (defcustom org-cycle-global-at-bob nil
  790. "Cycle globally if cursor is at beginning of buffer and not at a headline.
  791. This makes it possible to do global cycling without having to use S-TAB or
  792. \\[universal-argument] TAB. For this special case to work, the first line \
  793. of the buffer
  794. must not be a headline - it may be empty or some other text. When used in
  795. this way, `org-cycle-hook' is disables temporarily, to make sure the
  796. cursor stays at the beginning of the buffer.
  797. When this option is nil, don't do anything special at the beginning
  798. of the buffer."
  799. :group 'org-cycle
  800. :type 'boolean)
  801. (defcustom org-cycle-level-after-item/entry-creation t
  802. "Non-nil means cycle entry level or item indentation in new empty entries.
  803. When the cursor is at the end of an empty headline, i.e with only stars
  804. and maybe a TODO keyword, TAB will then switch the entry to become a child,
  805. and then all possible ancestor states, before returning to the original state.
  806. This makes data entry extremely fast: M-RET to create a new headline,
  807. on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
  808. When the cursor is at the end of an empty plain list item, one TAB will
  809. make it a subitem, two or more tabs will back up to make this an item
  810. higher up in the item hierarchy."
  811. :group 'org-cycle
  812. :type 'boolean)
  813. (defcustom org-cycle-emulate-tab t
  814. "Where should `org-cycle' emulate TAB.
  815. nil Never
  816. white Only in completely white lines
  817. whitestart Only at the beginning of lines, before the first non-white char
  818. t Everywhere except in headlines
  819. exc-hl-bol Everywhere except at the start of a headline
  820. If TAB is used in a place where it does not emulate TAB, the current subtree
  821. visibility is cycled."
  822. :group 'org-cycle
  823. :type '(choice (const :tag "Never" nil)
  824. (const :tag "Only in completely white lines" white)
  825. (const :tag "Before first char in a line" whitestart)
  826. (const :tag "Everywhere except in headlines" t)
  827. (const :tag "Everywhere except at bol in headlines" exc-hl-bol)
  828. ))
  829. (defcustom org-cycle-separator-lines 2
  830. "Number of empty lines needed to keep an empty line between collapsed trees.
  831. If you leave an empty line between the end of a subtree and the following
  832. headline, this empty line is hidden when the subtree is folded.
  833. Org-mode will leave (exactly) one empty line visible if the number of
  834. empty lines is equal or larger to the number given in this variable.
  835. So the default 2 means at least 2 empty lines after the end of a subtree
  836. are needed to produce free space between a collapsed subtree and the
  837. following headline.
  838. If the number is negative, and the number of empty lines is at least -N,
  839. all empty lines are shown.
  840. Special case: when 0, never leave empty lines in collapsed view."
  841. :group 'org-cycle
  842. :type 'integer)
  843. (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
  844. (defcustom org-pre-cycle-hook nil
  845. "Hook that is run before visibility cycling is happening.
  846. The function(s) in this hook must accept a single argument which indicates
  847. the new state that will be set right after running this hook. The
  848. argument is a symbol. Before a global state change, it can have the values
  849. `overview', `content', or `all'. Before a local state change, it can have
  850. the values `folded', `children', or `subtree'."
  851. :group 'org-cycle
  852. :type 'hook)
  853. (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
  854. org-cycle-hide-drawers
  855. org-cycle-show-empty-lines
  856. org-optimize-window-after-visibility-change)
  857. "Hook that is run after `org-cycle' has changed the buffer visibility.
  858. The function(s) in this hook must accept a single argument which indicates
  859. the new state that was set by the most recent `org-cycle' command. The
  860. argument is a symbol. After a global state change, it can have the values
  861. `overview', `content', or `all'. After a local state change, it can have
  862. the values `folded', `children', or `subtree'."
  863. :group 'org-cycle
  864. :type 'hook)
  865. (defgroup org-edit-structure nil
  866. "Options concerning structure editing in Org-mode."
  867. :tag "Org Edit Structure"
  868. :group 'org-structure)
  869. (defcustom org-odd-levels-only nil
  870. "Non-nil means skip even levels and only use odd levels for the outline.
  871. This has the effect that two stars are being added/taken away in
  872. promotion/demotion commands. It also influences how levels are
  873. handled by the exporters.
  874. Changing it requires restart of `font-lock-mode' to become effective
  875. for fontification also in regions already fontified.
  876. You may also set this on a per-file basis by adding one of the following
  877. lines to the buffer:
  878. #+STARTUP: odd
  879. #+STARTUP: oddeven"
  880. :group 'org-edit-structure
  881. :group 'org-appearance
  882. :type 'boolean)
  883. (defcustom org-adapt-indentation t
  884. "Non-nil means adapt indentation to outline node level.
  885. When this variable is set, Org assumes that you write outlines by
  886. indenting text in each node to align with the headline (after the stars).
  887. The following issues are influenced by this variable:
  888. - When this is set and the *entire* text in an entry is indented, the
  889. indentation is increased by one space in a demotion command, and
  890. decreased by one in a promotion command. If any line in the entry
  891. body starts with text at column 0, indentation is not changed at all.
  892. - Property drawers and planning information is inserted indented when
  893. this variable s set. When nil, they will not be indented.
  894. - TAB indents a line relative to context. The lines below a headline
  895. will be indented when this variable is set.
  896. Note that this is all about true indentation, by adding and removing
  897. space characters. See also `org-indent.el' which does level-dependent
  898. indentation in a virtual way, i.e. at display time in Emacs."
  899. :group 'org-edit-structure
  900. :type 'boolean)
  901. (defcustom org-special-ctrl-a/e nil
  902. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  903. When t, `C-a' will bring back the cursor to the beginning of the
  904. headline text, i.e. after the stars and after a possible TODO
  905. keyword. In an item, this will be the position after bullet and
  906. check-box, if any. When the cursor is already at that position,
  907. another `C-a' will bring it to the beginning of the line.
  908. `C-e' will jump to the end of the headline, ignoring the presence
  909. of tags in the headline. A second `C-e' will then jump to the
  910. true end of the line, after any tags. This also means that, when
  911. this variable is non-nil, `C-e' also will never jump beyond the
  912. end of the heading of a folded section, i.e. not after the
  913. ellipses.
  914. When set to the symbol `reversed', the first `C-a' or `C-e' works
  915. normally, going to the true line boundary first. Only a directly
  916. following, identical keypress will bring the cursor to the
  917. special positions.
  918. This may also be a cons cell where the behavior for `C-a' and
  919. `C-e' is set separately."
  920. :group 'org-edit-structure
  921. :type '(choice
  922. (const :tag "off" nil)
  923. (const :tag "on: after stars/bullet and before tags first" t)
  924. (const :tag "reversed: true line boundary first" reversed)
  925. (cons :tag "Set C-a and C-e separately"
  926. (choice :tag "Special C-a"
  927. (const :tag "off" nil)
  928. (const :tag "on: after stars/bullet first" t)
  929. (const :tag "reversed: before stars/bullet first" reversed))
  930. (choice :tag "Special C-e"
  931. (const :tag "off" nil)
  932. (const :tag "on: before tags first" t)
  933. (const :tag "reversed: after tags first" reversed)))))
  934. (if (fboundp 'defvaralias)
  935. (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e))
  936. (defcustom org-special-ctrl-k nil
  937. "Non-nil means `C-k' will behave specially in headlines.
  938. When nil, `C-k' will call the default `kill-line' command.
  939. When t, the following will happen while the cursor is in the headline:
  940. - When the cursor is at the beginning of a headline, kill the entire
  941. line and possible the folded subtree below the line.
  942. - When in the middle of the headline text, kill the headline up to the tags.
  943. - When after the headline text, kill the tags."
  944. :group 'org-edit-structure
  945. :type 'boolean)
  946. (defcustom org-ctrl-k-protect-subtree nil
  947. "Non-nil means, do not delete a hidden subtree with C-k.
  948. When set to the symbol `error', simply throw an error when C-k is
  949. used to kill (part-of) a headline that has hidden text behind it.
  950. Any other non-nil value will result in a query to the user, if it is
  951. OK to kill that hidden subtree. When nil, kill without remorse."
  952. :group 'org-edit-structure
  953. :version "24.1"
  954. :type '(choice
  955. (const :tag "Do not protect hidden subtrees" nil)
  956. (const :tag "Protect hidden subtrees with a security query" t)
  957. (const :tag "Never kill a hidden subtree with C-k" error)))
  958. (defcustom org-catch-invisible-edits nil
  959. "Check if in invisible region before inserting or deleting a character.
  960. Valid values are:
  961. nil Do not check, so just do invisible edits.
  962. error Throw an error and do nothing.
  963. show Make point visible, and do the requested edit.
  964. show-and-error Make point visible, then throw an error and abort the edit.
  965. smart Make point visible, and do insertion/deletion if it is
  966. adjacent to visible text and the change feels predictable.
  967. Never delete a previously invisible character or add in the
  968. middle or right after an invisible region. Basically, this
  969. allows insertion and backward-delete right before ellipses.
  970. FIXME: maybe in this case we should not even show?"
  971. :group 'org-edit-structure
  972. :version "24.1"
  973. :type '(choice
  974. (const :tag "Do not check" nil)
  975. (const :tag "Throw error when trying to edit" error)
  976. (const :tag "Unhide, but do not do the edit" show-and-error)
  977. (const :tag "Show invisible part and do the edit" show)
  978. (const :tag "Be smart and do the right thing" smart)))
  979. (defcustom org-yank-folded-subtrees t
  980. "Non-nil means when yanking subtrees, fold them.
  981. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  982. it starts with a heading and all other headings in it are either children
  983. or siblings, then fold all the subtrees. However, do this only if no
  984. text after the yank would be swallowed into a folded tree by this action."
  985. :group 'org-edit-structure
  986. :type 'boolean)
  987. (defcustom org-yank-adjusted-subtrees nil
  988. "Non-nil means when yanking subtrees, adjust the level.
  989. With this setting, `org-paste-subtree' is used to insert the subtree, see
  990. this function for details."
  991. :group 'org-edit-structure
  992. :type 'boolean)
  993. (defcustom org-M-RET-may-split-line '((default . t))
  994. "Non-nil means M-RET will split the line at the cursor position.
  995. When nil, it will go to the end of the line before making a
  996. new line.
  997. You may also set this option in a different way for different
  998. contexts. Valid contexts are:
  999. headline when creating a new headline
  1000. item when creating a new item
  1001. table in a table field
  1002. default the value to be used for all contexts not explicitly
  1003. customized"
  1004. :group 'org-structure
  1005. :group 'org-table
  1006. :type '(choice
  1007. (const :tag "Always" t)
  1008. (const :tag "Never" nil)
  1009. (repeat :greedy t :tag "Individual contexts"
  1010. (cons
  1011. (choice :tag "Context"
  1012. (const headline)
  1013. (const item)
  1014. (const table)
  1015. (const default))
  1016. (boolean)))))
  1017. (defcustom org-insert-heading-respect-content nil
  1018. "Non-nil means insert new headings after the current subtree.
  1019. When nil, the new heading is created directly after the current line.
  1020. The commands \\[org-insert-heading-respect-content] and
  1021. \\[org-insert-todo-heading-respect-content] turn this variable on
  1022. for the duration of the command."
  1023. :group 'org-structure
  1024. :type 'boolean)
  1025. (defcustom org-blank-before-new-entry '((heading . auto)
  1026. (plain-list-item . auto))
  1027. "Should `org-insert-heading' leave a blank line before new heading/item?
  1028. The value is an alist, with `heading' and `plain-list-item' as CAR,
  1029. and a boolean flag as CDR. The cdr may also be the symbol `auto', in
  1030. which case Org will look at the surrounding headings/items and try to
  1031. make an intelligent decision whether to insert a blank line or not.
  1032. For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
  1033. set, the setting here is ignored and no empty line is inserted, to avoid
  1034. breaking the list structure."
  1035. :group 'org-edit-structure
  1036. :type '(list
  1037. (cons (const heading)
  1038. (choice (const :tag "Never" nil)
  1039. (const :tag "Always" t)
  1040. (const :tag "Auto" auto)))
  1041. (cons (const plain-list-item)
  1042. (choice (const :tag "Never" nil)
  1043. (const :tag "Always" t)
  1044. (const :tag "Auto" auto)))))
  1045. (defcustom org-insert-heading-hook nil
  1046. "Hook being run after inserting a new heading."
  1047. :group 'org-edit-structure
  1048. :type 'hook)
  1049. (defcustom org-enable-fixed-width-editor t
  1050. "Non-nil means lines starting with \":\" are treated as fixed-width.
  1051. This currently only means they are never auto-wrapped.
  1052. When nil, such lines will be treated like ordinary lines.
  1053. See also the QUOTE keyword."
  1054. :group 'org-edit-structure
  1055. :type 'boolean)
  1056. (defcustom org-goto-auto-isearch t
  1057. "Non-nil means typing characters in `org-goto' starts incremental search."
  1058. :group 'org-edit-structure
  1059. :type 'boolean)
  1060. (defgroup org-sparse-trees nil
  1061. "Options concerning sparse trees in Org-mode."
  1062. :tag "Org Sparse Trees"
  1063. :group 'org-structure)
  1064. (defcustom org-highlight-sparse-tree-matches t
  1065. "Non-nil means highlight all matches that define a sparse tree.
  1066. The highlights will automatically disappear the next time the buffer is
  1067. changed by an edit command."
  1068. :group 'org-sparse-trees
  1069. :type 'boolean)
  1070. (defcustom org-remove-highlights-with-change t
  1071. "Non-nil means any change to the buffer will remove temporary highlights.
  1072. Such highlights are created by `org-occur' and `org-clock-display'.
  1073. When nil, `C-c C-c needs to be used to get rid of the highlights.
  1074. The highlights created by `org-preview-latex-fragment' always need
  1075. `C-c C-c' to be removed."
  1076. :group 'org-sparse-trees
  1077. :group 'org-time
  1078. :type 'boolean)
  1079. (defcustom org-occur-hook '(org-first-headline-recenter)
  1080. "Hook that is run after `org-occur' has constructed a sparse tree.
  1081. This can be used to recenter the window to show as much of the structure
  1082. as possible."
  1083. :group 'org-sparse-trees
  1084. :type 'hook)
  1085. (defgroup org-imenu-and-speedbar nil
  1086. "Options concerning imenu and speedbar in Org-mode."
  1087. :tag "Org Imenu and Speedbar"
  1088. :group 'org-structure)
  1089. (defcustom org-imenu-depth 2
  1090. "The maximum level for Imenu access to Org-mode headlines.
  1091. This also applied for speedbar access."
  1092. :group 'org-imenu-and-speedbar
  1093. :type 'integer)
  1094. (defgroup org-table nil
  1095. "Options concerning tables in Org-mode."
  1096. :tag "Org Table"
  1097. :group 'org)
  1098. (defcustom org-enable-table-editor 'optimized
  1099. "Non-nil means lines starting with \"|\" are handled by the table editor.
  1100. When nil, such lines will be treated like ordinary lines.
  1101. When equal to the symbol `optimized', the table editor will be optimized to
  1102. do the following:
  1103. - Automatic overwrite mode in front of whitespace in table fields.
  1104. This makes the structure of the table stay in tact as long as the edited
  1105. field does not exceed the column width.
  1106. - Minimize the number of realigns. Normally, the table is aligned each time
  1107. TAB or RET are pressed to move to another field. With optimization this
  1108. happens only if changes to a field might have changed the column width.
  1109. Optimization requires replacing the functions `self-insert-command',
  1110. `delete-char', and `backward-delete-char' in Org-mode buffers, with a
  1111. slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
  1112. very good at guessing when a re-align will be necessary, but you can always
  1113. force one with \\[org-ctrl-c-ctrl-c].
  1114. If you would like to use the optimized version in Org-mode, but the
  1115. un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
  1116. This variable can be used to turn on and off the table editor during a session,
  1117. but in order to toggle optimization, a restart is required.
  1118. See also the variable `org-table-auto-blank-field'."
  1119. :group 'org-table
  1120. :type '(choice
  1121. (const :tag "off" nil)
  1122. (const :tag "on" t)
  1123. (const :tag "on, optimized" optimized)))
  1124. (defcustom org-self-insert-cluster-for-undo t
  1125. "Non-nil means cluster self-insert commands for undo when possible.
  1126. If this is set, then, like in the Emacs command loop, 20 consecutive
  1127. characters will be undone together.
  1128. This is configurable, because there is some impact on typing performance."
  1129. :group 'org-table
  1130. :type 'boolean)
  1131. (defcustom org-table-tab-recognizes-table.el t
  1132. "Non-nil means TAB will automatically notice a table.el table.
  1133. When it sees such a table, it moves point into it and - if necessary -
  1134. calls `table-recognize-table'."
  1135. :group 'org-table-editing
  1136. :type 'boolean)
  1137. (defgroup org-link nil
  1138. "Options concerning links in Org-mode."
  1139. :tag "Org Link"
  1140. :group 'org)
  1141. (defvar org-link-abbrev-alist-local nil
  1142. "Buffer-local version of `org-link-abbrev-alist', which see.
  1143. The value of this is taken from the #+LINK lines.")
  1144. (make-variable-buffer-local 'org-link-abbrev-alist-local)
  1145. (defcustom org-link-abbrev-alist nil
  1146. "Alist of link abbreviations.
  1147. The car of each element is a string, to be replaced at the start of a link.
  1148. The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
  1149. links in Org-mode buffers can have an optional tag after a double colon, e.g.
  1150. [[linkkey:tag][description]]
  1151. The 'linkkey' must be a word word, starting with a letter, followed
  1152. by letters, numbers, '-' or '_'.
  1153. If REPLACE is a string, the tag will simply be appended to create the link.
  1154. If the string contains \"%s\", the tag will be inserted there. If the string
  1155. contains \"%h\", it will cause a url-encoded version of the tag to be inserted
  1156. at that point (see the function `url-hexify-string'). If the string contains
  1157. the specifier \"%(my-function)\", then the custom function `my-function' will
  1158. be invoked: this function takes the tag as its only argument and must return
  1159. a string.
  1160. REPLACE may also be a function that will be called with the tag as the
  1161. only argument to create the link, which should be returned as a string.
  1162. See the manual for examples."
  1163. :group 'org-link
  1164. :type '(repeat
  1165. (cons
  1166. (string :tag "Protocol")
  1167. (choice
  1168. (string :tag "Format")
  1169. (function)))))
  1170. (defcustom org-descriptive-links t
  1171. "Non-nil means Org will display descriptive links.
  1172. E.g. [[http://orgmode.org][Org website]] will be displayed as
  1173. \"Org Website\", hiding the link itself and just displaying its
  1174. description. When set to `nil', Org will display the full links
  1175. literally.
  1176. You can interactively set the value of this variable by calling
  1177. `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
  1178. :group 'org-link
  1179. :type 'boolean)
  1180. (defcustom org-link-file-path-type 'adaptive
  1181. "How the path name in file links should be stored.
  1182. Valid values are:
  1183. relative Relative to the current directory, i.e. the directory of the file
  1184. into which the link is being inserted.
  1185. absolute Absolute path, if possible with ~ for home directory.
  1186. noabbrev Absolute path, no abbreviation of home directory.
  1187. adaptive Use relative path for files in the current directory and sub-
  1188. directories of it. For other files, use an absolute path."
  1189. :group 'org-link
  1190. :type '(choice
  1191. (const relative)
  1192. (const absolute)
  1193. (const noabbrev)
  1194. (const adaptive)))
  1195. (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
  1196. "Types of links that should be activated in Org-mode files.
  1197. This is a list of symbols, each leading to the activation of a certain link
  1198. type. In principle, it does not hurt to turn on most link types - there may
  1199. be a small gain when turning off unused link types. The types are:
  1200. bracket The recommended [[link][description]] or [[link]] links with hiding.
  1201. angle Links in angular brackets that may contain whitespace like
  1202. <bbdb:Carsten Dominik>.
  1203. plain Plain links in normal text, no whitespace, like http://google.com.
  1204. radio Text that is matched by a radio target, see manual for details.
  1205. tag Tag settings in a headline (link to tag search).
  1206. date Time stamps (link to calendar).
  1207. footnote Footnote labels.
  1208. Changing this variable requires a restart of Emacs to become effective."
  1209. :group 'org-link
  1210. :type '(set :greedy t
  1211. (const :tag "Double bracket links" bracket)
  1212. (const :tag "Angular bracket links" angle)
  1213. (const :tag "Plain text links" plain)
  1214. (const :tag "Radio target matches" radio)
  1215. (const :tag "Tags" tag)
  1216. (const :tag "Timestamps" date)
  1217. (const :tag "Footnotes" footnote)))
  1218. (defcustom org-make-link-description-function nil
  1219. "Function to use to generate link descriptions from links.
  1220. If nil the link location will be used. This function must take
  1221. two parameters; the first is the link and the second the
  1222. description `org-insert-link' has generated, and should return the
  1223. description to use."
  1224. :group 'org-link
  1225. :type 'function)
  1226. (defgroup org-link-store nil
  1227. "Options concerning storing links in Org-mode."
  1228. :tag "Org Store Link"
  1229. :group 'org-link)
  1230. (defcustom org-email-link-description-format "Email %c: %.30s"
  1231. "Format of the description part of a link to an email or usenet message.
  1232. The following %-escapes will be replaced by corresponding information:
  1233. %F full \"From\" field
  1234. %f name, taken from \"From\" field, address if no name
  1235. %T full \"To\" field
  1236. %t first name in \"To\" field, address if no name
  1237. %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
  1238. will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
  1239. %s subject
  1240. %d date
  1241. %m message-id.
  1242. You may use normal field width specification between the % and the letter.
  1243. This is for example useful to limit the length of the subject.
  1244. Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
  1245. :group 'org-link-store
  1246. :type 'string)
  1247. (defcustom org-from-is-user-regexp
  1248. (let (r1 r2)
  1249. (when (and user-mail-address (not (string= user-mail-address "")))
  1250. (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
  1251. (when (and user-full-name (not (string= user-full-name "")))
  1252. (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
  1253. (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
  1254. "Regexp matched against the \"From:\" header of an email or usenet message.
  1255. It should match if the message is from the user him/herself."
  1256. :group 'org-link-store
  1257. :type 'regexp)
  1258. (defcustom org-link-to-org-use-id 'create-if-interactive-and-no-custom-id
  1259. "Non-nil means storing a link to an Org file will use entry IDs.
  1260. Note that before this variable is even considered, org-id must be loaded,
  1261. so please customize `org-modules' and turn it on.
  1262. The variable can have the following values:
  1263. t Create an ID if needed to make a link to the current entry.
  1264. create-if-interactive
  1265. If `org-store-link' is called directly (interactively, as a user
  1266. command), do create an ID to support the link. But when doing the
  1267. job for remember, only use the ID if it already exists. The
  1268. purpose of this setting is to avoid proliferation of unwanted
  1269. IDs, just because you happen to be in an Org file when you
  1270. call `org-remember' that automatically and preemptively
  1271. creates a link. If you do want to get an ID link in a remember
  1272. template to an entry not having an ID, create it first by
  1273. explicitly creating a link to it, using `C-c C-l' first.
  1274. create-if-interactive-and-no-custom-id
  1275. Like create-if-interactive, but do not create an ID if there is
  1276. a CUSTOM_ID property defined in the entry. This is the default.
  1277. use-existing
  1278. Use existing ID, do not create one.
  1279. nil Never use an ID to make a link, instead link using a text search for
  1280. the headline text."
  1281. :group 'org-link-store
  1282. :type '(choice
  1283. (const :tag "Create ID to make link" t)
  1284. (const :tag "Create if storing link interactively"
  1285. create-if-interactive)
  1286. (const :tag "Create if storing link interactively and no CUSTOM_ID is present"
  1287. create-if-interactive-and-no-custom-id)
  1288. (const :tag "Only use existing" use-existing)
  1289. (const :tag "Do not use ID to create link" nil)))
  1290. (defcustom org-context-in-file-links t
  1291. "Non-nil means file links from `org-store-link' contain context.
  1292. A search string will be added to the file name with :: as separator and
  1293. used to find the context when the link is activated by the command
  1294. `org-open-at-point'. When this option is t, the entire active region
  1295. will be placed in the search string of the file link. If set to a
  1296. positive integer, only the first n lines of context will be stored.
  1297. Using a prefix arg to the command \\[org-store-link] (`org-store-link')
  1298. negates this setting for the duration of the command."
  1299. :group 'org-link-store
  1300. :type '(choice boolean integer))
  1301. (defcustom org-keep-stored-link-after-insertion nil
  1302. "Non-nil means keep link in list for entire session.
  1303. The command `org-store-link' adds a link pointing to the current
  1304. location to an internal list. These links accumulate during a session.
  1305. The command `org-insert-link' can be used to insert links into any
  1306. Org-mode file (offering completion for all stored links). When this
  1307. option is nil, every link which has been inserted once using \\[org-insert-link]
  1308. will be removed from the list, to make completing the unused links
  1309. more efficient."
  1310. :group 'org-link-store
  1311. :type 'boolean)
  1312. (defgroup org-link-follow nil
  1313. "Options concerning following links in Org-mode."
  1314. :tag "Org Follow Link"
  1315. :group 'org-link)
  1316. (defcustom org-link-translation-function nil
  1317. "Function to translate links with different syntax to Org syntax.
  1318. This can be used to translate links created for example by the Planner
  1319. or emacs-wiki packages to Org syntax.
  1320. The function must accept two parameters, a TYPE containing the link
  1321. protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
  1322. which is everything after the link protocol. It should return a cons
  1323. with possibly modified values of type and path.
  1324. Org contains a function for this, so if you set this variable to
  1325. `org-translate-link-from-planner', you should be able follow many
  1326. links created by planner."
  1327. :group 'org-link-follow
  1328. :type 'function)
  1329. (defcustom org-follow-link-hook nil
  1330. "Hook that is run after a link has been followed."
  1331. :group 'org-link-follow
  1332. :type 'hook)
  1333. (defcustom org-tab-follows-link nil
  1334. "Non-nil means on links TAB will follow the link.
  1335. Needs to be set before org.el is loaded.
  1336. This really should not be used, it does not make sense, and the
  1337. implementation is bad."
  1338. :group 'org-link-follow
  1339. :type 'boolean)
  1340. (defcustom org-return-follows-link nil
  1341. "Non-nil means on links RET will follow the link."
  1342. :group 'org-link-follow
  1343. :type 'boolean)
  1344. (defcustom org-mouse-1-follows-link
  1345. (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
  1346. "Non-nil means mouse-1 on a link will follow the link.
  1347. A longer mouse click will still set point. Does not work on XEmacs.
  1348. Needs to be set before org.el is loaded."
  1349. :group 'org-link-follow
  1350. :type 'boolean)
  1351. (defcustom org-mark-ring-length 4
  1352. "Number of different positions to be recorded in the ring.
  1353. Changing this requires a restart of Emacs to work correctly."
  1354. :group 'org-link-follow
  1355. :type 'integer)
  1356. (defcustom org-link-search-must-match-exact-headline 'query-to-create
  1357. "Non-nil means internal links in Org files must exactly match a headline.
  1358. When nil, the link search tries to match a phrase with all words
  1359. in the search text."
  1360. :group 'org-link-follow
  1361. :version "24.1"
  1362. :type '(choice
  1363. (const :tag "Use fuzzy text search" nil)
  1364. (const :tag "Match only exact headline" t)
  1365. (const :tag "Match exact headline or query to create it"
  1366. query-to-create)))
  1367. (defcustom org-link-frame-setup
  1368. '((vm . vm-visit-folder-other-frame)
  1369. (vm-imap . vm-visit-imap-folder-other-frame)
  1370. (gnus . org-gnus-no-new-news)
  1371. (file . find-file-other-window)
  1372. (wl . wl-other-frame))
  1373. "Setup the frame configuration for following links.
  1374. When following a link with Emacs, it may often be useful to display
  1375. this link in another window or frame. This variable can be used to
  1376. set this up for the different types of links.
  1377. For VM, use any of
  1378. `vm-visit-folder'
  1379. `vm-visit-folder-other-window'
  1380. `vm-visit-folder-other-frame'
  1381. For Gnus, use any of
  1382. `gnus'
  1383. `gnus-other-frame'
  1384. `org-gnus-no-new-news'
  1385. For FILE, use any of
  1386. `find-file'
  1387. `find-file-other-window'
  1388. `find-file-other-frame'
  1389. For Wanderlust use any of
  1390. `wl'
  1391. `wl-other-frame'
  1392. For the calendar, use the variable `calendar-setup'.
  1393. For BBDB, it is currently only possible to display the matches in
  1394. another window."
  1395. :group 'org-link-follow
  1396. :type '(list
  1397. (cons (const vm)
  1398. (choice
  1399. (const vm-visit-folder)
  1400. (const vm-visit-folder-other-window)
  1401. (const vm-visit-folder-other-frame)))
  1402. (cons (const gnus)
  1403. (choice
  1404. (const gnus)
  1405. (const gnus-other-frame)
  1406. (const org-gnus-no-new-news)))
  1407. (cons (const file)
  1408. (choice
  1409. (const find-file)
  1410. (const find-file-other-window)
  1411. (const find-file-other-frame)))
  1412. (cons (const wl)
  1413. (choice
  1414. (const wl)
  1415. (const wl-other-frame)))))
  1416. (defcustom org-display-internal-link-with-indirect-buffer nil
  1417. "Non-nil means use indirect buffer to display infile links.
  1418. Activating internal links (from one location in a file to another location
  1419. in the same file) normally just jumps to the location. When the link is
  1420. activated with a \\[universal-argument] prefix (or with mouse-3), the link \
  1421. is displayed in
  1422. another window. When this option is set, the other window actually displays
  1423. an indirect buffer clone of the current buffer, to avoid any visibility
  1424. changes to the current buffer."
  1425. :group 'org-link-follow
  1426. :type 'boolean)
  1427. (defcustom org-open-non-existing-files nil
  1428. "Non-nil means `org-open-file' will open non-existing files.
  1429. When nil, an error will be generated.
  1430. This variable applies only to external applications because they
  1431. might choke on non-existing files. If the link is to a file that
  1432. will be opened in Emacs, the variable is ignored."
  1433. :group 'org-link-follow
  1434. :type 'boolean)
  1435. (defcustom org-open-directory-means-index-dot-org nil
  1436. "Non-nil means a link to a directory really means to index.org.
  1437. When nil, following a directory link will run dired or open a finder/explorer
  1438. window on that directory."
  1439. :group 'org-link-follow
  1440. :type 'boolean)
  1441. (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
  1442. "Function and arguments to call for following mailto links.
  1443. This is a list with the first element being a Lisp function, and the
  1444. remaining elements being arguments to the function. In string arguments,
  1445. %a will be replaced by the address, and %s will be replaced by the subject
  1446. if one was given like in <mailto:arthur@galaxy.org::this subject>."
  1447. :group 'org-link-follow
  1448. :type '(choice
  1449. (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
  1450. (const :tag "compose-mail" (compose-mail "%a" "%s"))
  1451. (const :tag "message-mail" (message-mail "%a" "%s"))
  1452. (cons :tag "other" (function) (repeat :tag "argument" sexp))))
  1453. (defcustom org-confirm-shell-link-function 'yes-or-no-p
  1454. "Non-nil means ask for confirmation before executing shell links.
  1455. Shell links can be dangerous: just think about a link
  1456. [[shell:rm -rf ~/*][Google Search]]
  1457. This link would show up in your Org-mode document as \"Google Search\",
  1458. but really it would remove your entire home directory.
  1459. Therefore we advise against setting this variable to nil.
  1460. Just change it to `y-or-n-p' if you want to confirm with a
  1461. single keystroke rather than having to type \"yes\"."
  1462. :group 'org-link-follow
  1463. :type '(choice
  1464. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1465. (const :tag "with y-or-n (faster)" y-or-n-p)
  1466. (const :tag "no confirmation (dangerous)" nil)))
  1467. (put 'org-confirm-shell-link-function
  1468. 'safe-local-variable
  1469. #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1470. (defcustom org-confirm-shell-link-not-regexp ""
  1471. "A regexp to skip confirmation for shell links."
  1472. :group 'org-link-follow
  1473. :version "24.1"
  1474. :type 'regexp)
  1475. (defcustom org-confirm-elisp-link-function 'yes-or-no-p
  1476. "Non-nil means ask for confirmation before executing Emacs Lisp links.
  1477. Elisp links can be dangerous: just think about a link
  1478. [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
  1479. This link would show up in your Org-mode document as \"Google Search\",
  1480. but really it would remove your entire home directory.
  1481. Therefore we advise against setting this variable to nil.
  1482. Just change it to `y-or-n-p' if you want to confirm with a
  1483. single keystroke rather than having to type \"yes\"."
  1484. :group 'org-link-follow
  1485. :type '(choice
  1486. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1487. (const :tag "with y-or-n (faster)" y-or-n-p)
  1488. (const :tag "no confirmation (dangerous)" nil)))
  1489. (put 'org-confirm-shell-link-function
  1490. 'safe-local-variable
  1491. #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1492. (defcustom org-confirm-elisp-link-not-regexp ""
  1493. "A regexp to skip confirmation for Elisp links."
  1494. :group 'org-link-follow
  1495. :version "24.1"
  1496. :type 'regexp)
  1497. (defconst org-file-apps-defaults-gnu
  1498. '((remote . emacs)
  1499. (system . mailcap)
  1500. (t . mailcap))
  1501. "Default file applications on a UNIX or GNU/Linux system.
  1502. See `org-file-apps'.")
  1503. (defconst org-file-apps-defaults-macosx
  1504. '((remote . emacs)
  1505. (t . "open %s")
  1506. (system . "open %s")
  1507. ("ps.gz" . "gv %s")
  1508. ("eps.gz" . "gv %s")
  1509. ("dvi" . "xdvi %s")
  1510. ("fig" . "xfig %s"))
  1511. "Default file applications on a MacOS X system.
  1512. The system \"open\" is known as a default, but we use X11 applications
  1513. for some files for which the OS does not have a good default.
  1514. See `org-file-apps'.")
  1515. (defconst org-file-apps-defaults-windowsnt
  1516. (list
  1517. '(remote . emacs)
  1518. (cons t
  1519. (list (if (featurep 'xemacs)
  1520. 'mswindows-shell-execute
  1521. 'w32-shell-execute)
  1522. "open" 'file))
  1523. (cons 'system
  1524. (list (if (featurep 'xemacs)
  1525. 'mswindows-shell-execute
  1526. 'w32-shell-execute)
  1527. "open" 'file)))
  1528. "Default file applications on a Windows NT system.
  1529. The system \"open\" is used for most files.
  1530. See `org-file-apps'.")
  1531. (defcustom org-file-apps
  1532. '(
  1533. (auto-mode . emacs)
  1534. ("\\.mm\\'" . default)
  1535. ("\\.x?html?\\'" . default)
  1536. ("\\.pdf\\'" . default)
  1537. )
  1538. "External applications for opening `file:path' items in a document.
  1539. Org-mode uses system defaults for different file types, but
  1540. you can use this variable to set the application for a given file
  1541. extension. The entries in this list are cons cells where the car identifies
  1542. files and the cdr the corresponding command. Possible values for the
  1543. file identifier are
  1544. \"string\" A string as a file identifier can be interpreted in different
  1545. ways, depending on its contents:
  1546. - Alphanumeric characters only:
  1547. Match links with this file extension.
  1548. Example: (\"pdf\" . \"evince %s\")
  1549. to open PDFs with evince.
  1550. - Regular expression: Match links where the
  1551. filename matches the regexp. If you want to
  1552. use groups here, use shy groups.
  1553. Example: (\"\\.x?html\\'\" . \"firefox %s\")
  1554. (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
  1555. to open *.html and *.xhtml with firefox.
  1556. - Regular expression which contains (non-shy) groups:
  1557. Match links where the whole link, including \"::\", and
  1558. anything after that, matches the regexp.
  1559. In a custom command string, %1, %2, etc. are replaced with
  1560. the parts of the link that were matched by the groups.
  1561. For backwards compatibility, if a command string is given
  1562. that does not use any of the group matches, this case is
  1563. handled identically to the second one (i.e. match against
  1564. file name only).
  1565. In a custom lisp form, you can access the group matches with
  1566. (match-string n link).
  1567. Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
  1568. to open [[file:document.pdf::5]] with evince at page 5.
  1569. `directory' Matches a directory
  1570. `remote' Matches a remote file, accessible through tramp or efs.
  1571. Remote files most likely should be visited through Emacs
  1572. because external applications cannot handle such paths.
  1573. `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
  1574. so all files Emacs knows how to handle. Using this with
  1575. command `emacs' will open most files in Emacs. Beware that this
  1576. will also open html files inside Emacs, unless you add
  1577. (\"html\" . default) to the list as well.
  1578. t Default for files not matched by any of the other options.
  1579. `system' The system command to open files, like `open' on Windows
  1580. and Mac OS X, and mailcap under GNU/Linux. This is the command
  1581. that will be selected if you call `C-c C-o' with a double
  1582. \\[universal-argument] \\[universal-argument] prefix.
  1583. Possible values for the command are:
  1584. `emacs' The file will be visited by the current Emacs process.
  1585. `default' Use the default application for this file type, which is the
  1586. association for t in the list, most likely in the system-specific
  1587. part.
  1588. This can be used to overrule an unwanted setting in the
  1589. system-specific variable.
  1590. `system' Use the system command for opening files, like \"open\".
  1591. This command is specified by the entry whose car is `system'.
  1592. Most likely, the system-specific version of this variable
  1593. does define this command, but you can overrule/replace it
  1594. here.
  1595. string A command to be executed by a shell; %s will be replaced
  1596. by the path to the file.
  1597. sexp A Lisp form which will be evaluated. The file path will
  1598. be available in the Lisp variable `file'.
  1599. For more examples, see the system specific constants
  1600. `org-file-apps-defaults-macosx'
  1601. `org-file-apps-defaults-windowsnt'
  1602. `org-file-apps-defaults-gnu'."
  1603. :group 'org-link-follow
  1604. :type '(repeat
  1605. (cons (choice :value ""
  1606. (string :tag "Extension")
  1607. (const :tag "System command to open files" system)
  1608. (const :tag "Default for unrecognized files" t)
  1609. (const :tag "Remote file" remote)
  1610. (const :tag "Links to a directory" directory)
  1611. (const :tag "Any files that have Emacs modes"
  1612. auto-mode))
  1613. (choice :value ""
  1614. (const :tag "Visit with Emacs" emacs)
  1615. (const :tag "Use default" default)
  1616. (const :tag "Use the system command" system)
  1617. (string :tag "Command")
  1618. (sexp :tag "Lisp form")))))
  1619. (defcustom org-doi-server-url "http://dx.doi.org/"
  1620. "The URL of the DOI server."
  1621. :type 'string
  1622. :version "24.2"
  1623. :group 'org-link-follow)
  1624. (defgroup org-refile nil
  1625. "Options concerning refiling entries in Org-mode."
  1626. :tag "Org Refile"
  1627. :group 'org)
  1628. (defcustom org-directory "~/org"
  1629. "Directory with org files.
  1630. This is just a default location to look for Org files. There is no need
  1631. at all to put your files into this directory. It is only used in the
  1632. following situations:
  1633. 1. When a remember template specifies a target file that is not an
  1634. absolute path. The path will then be interpreted relative to
  1635. `org-directory'
  1636. 2. When a remember note is filed away in an interactive way (when exiting the
  1637. note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
  1638. with `org-directory' as the default path."
  1639. :group 'org-refile
  1640. :group 'org-remember
  1641. :type 'directory)
  1642. (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
  1643. "Default target for storing notes.
  1644. Used as a fall back file for org-remember.el and org-capture.el, for
  1645. templates that do not specify a target file."
  1646. :group 'org-refile
  1647. :group 'org-remember
  1648. :type '(choice
  1649. (const :tag "Default from remember-data-file" nil)
  1650. file))
  1651. (defcustom org-goto-interface 'outline
  1652. "The default interface to be used for `org-goto'.
  1653. Allowed values are:
  1654. outline The interface shows an outline of the relevant file
  1655. and the correct heading is found by moving through
  1656. the outline or by searching with incremental search.
  1657. outline-path-completion Headlines in the current buffer are offered via
  1658. completion. This is the interface also used by
  1659. the refile command."
  1660. :group 'org-refile
  1661. :type '(choice
  1662. (const :tag "Outline" outline)
  1663. (const :tag "Outline-path-completion" outline-path-completion)))
  1664. (defcustom org-goto-max-level 5
  1665. "Maximum target level when running `org-goto' with refile interface."
  1666. :group 'org-refile
  1667. :type 'integer)
  1668. (defcustom org-reverse-note-order nil
  1669. "Non-nil means store new notes at the beginning of a file or entry.
  1670. When nil, new notes will be filed to the end of a file or entry.
  1671. This can also be a list with cons cells of regular expressions that
  1672. are matched against file names, and values."
  1673. :group 'org-remember
  1674. :group 'org-refile
  1675. :type '(choice
  1676. (const :tag "Reverse always" t)
  1677. (const :tag "Reverse never" nil)
  1678. (repeat :tag "By file name regexp"
  1679. (cons regexp boolean))))
  1680. (defcustom org-log-refile nil
  1681. "Information to record when a task is refiled.
  1682. Possible values are:
  1683. nil Don't add anything
  1684. time Add a time stamp to the task
  1685. note Prompt for a note and add it with template `org-log-note-headings'
  1686. This option can also be set with on a per-file-basis with
  1687. #+STARTUP: nologrefile
  1688. #+STARTUP: logrefile
  1689. #+STARTUP: lognoterefile
  1690. You can have local logging settings for a subtree by setting the LOGGING
  1691. property to one or more of these keywords.
  1692. When bulk-refiling from the agenda, the value `note' is forbidden and
  1693. will temporarily be changed to `time'."
  1694. :group 'org-refile
  1695. :group 'org-progress
  1696. :version "24.1"
  1697. :type '(choice
  1698. (const :tag "No logging" nil)
  1699. (const :tag "Record timestamp" time)
  1700. (const :tag "Record timestamp with note." note)))
  1701. (defcustom org-refile-targets nil
  1702. "Targets for refiling entries with \\[org-refile].
  1703. This is a list of cons cells. Each cell contains:
  1704. - a specification of the files to be considered, either a list of files,
  1705. or a symbol whose function or variable value will be used to retrieve
  1706. a file name or a list of file names. If you use `org-agenda-files' for
  1707. that, all agenda files will be scanned for targets. Nil means consider
  1708. headings in the current buffer.
  1709. - A specification of how to find candidate refile targets. This may be
  1710. any of:
  1711. - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
  1712. This tag has to be present in all target headlines, inheritance will
  1713. not be considered.
  1714. - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
  1715. todo keyword.
  1716. - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
  1717. headlines that are refiling targets.
  1718. - a cons cell (:level . N). Any headline of level N is considered a target.
  1719. Note that, when `org-odd-levels-only' is set, level corresponds to
  1720. order in hierarchy, not to the number of stars.
  1721. - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
  1722. Note that, when `org-odd-levels-only' is set, level corresponds to
  1723. order in hierarchy, not to the number of stars.
  1724. Each element of this list generates a set of possible targets.
  1725. The union of these sets is presented (with completion) to
  1726. the user by `org-refile'.
  1727. You can set the variable `org-refile-target-verify-function' to a function
  1728. to verify each headline found by the simple criteria above.
  1729. When this variable is nil, all top-level headlines in the current buffer
  1730. are used, equivalent to the value `((nil . (:level . 1))'."
  1731. :group 'org-refile
  1732. :type '(repeat
  1733. (cons
  1734. (choice :value org-agenda-files
  1735. (const :tag "All agenda files" org-agenda-files)
  1736. (const :tag "Current buffer" nil)
  1737. (function) (variable) (file))
  1738. (choice :tag "Identify target headline by"
  1739. (cons :tag "Specific tag" (const :value :tag) (string))
  1740. (cons :tag "TODO keyword" (const :value :todo) (string))
  1741. (cons :tag "Regular expression" (const :value :regexp) (regexp))
  1742. (cons :tag "Level number" (const :value :level) (integer))
  1743. (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
  1744. (defcustom org-refile-target-verify-function nil
  1745. "Function to verify if the headline at point should be a refile target.
  1746. The function will be called without arguments, with point at the
  1747. beginning of the headline. It should return t and leave point
  1748. where it is if the headline is a valid target for refiling.
  1749. If the target should not be selected, the function must return nil.
  1750. In addition to this, it may move point to a place from where the search
  1751. should be continued. For example, the function may decide that the entire
  1752. subtree of the current entry should be excluded and move point to the end
  1753. of the subtree."
  1754. :group 'org-refile
  1755. :type 'function)
  1756. (defcustom org-refile-use-cache nil
  1757. "Non-nil means cache refile targets to speed up the process.
  1758. The cache for a particular file will be updated automatically when
  1759. the buffer has been killed, or when any of the marker used for flagging
  1760. refile targets no longer points at a live buffer.
  1761. If you have added new entries to a buffer that might themselves be targets,
  1762. you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
  1763. find that easier, `C-u C-u C-u C-c C-w'."
  1764. :group 'org-refile
  1765. :version "24.1"
  1766. :type 'boolean)
  1767. (defcustom org-refile-use-outline-path nil
  1768. "Non-nil means provide refile targets as paths.
  1769. So a level 3 headline will be available as level1/level2/level3.
  1770. When the value is `file', also include the file name (without directory)
  1771. into the path. In this case, you can also stop the completion after
  1772. the file name, to get entries inserted as top level in the file.
  1773. When `full-file-path', include the full file path."
  1774. :group 'org-refile
  1775. :type '(choice
  1776. (const :tag "Not" nil)
  1777. (const :tag "Yes" t)
  1778. (const :tag "Start with file name" file)
  1779. (const :tag "Start with full file path" full-file-path)))
  1780. (defcustom org-outline-path-complete-in-steps t
  1781. "Non-nil means complete the outline path in hierarchical steps.
  1782. When Org-mode uses the refile interface to select an outline path
  1783. \(see variable `org-refile-use-outline-path'), the completion of
  1784. the path can be done is a single go, or if can be done in steps down
  1785. the headline hierarchy. Going in steps is probably the best if you
  1786. do not use a special completion package like `ido' or `icicles'.
  1787. However, when using these packages, going in one step can be very
  1788. fast, while still showing the whole path to the entry."
  1789. :group 'org-refile
  1790. :type 'boolean)
  1791. (defcustom org-refile-allow-creating-parent-nodes nil
  1792. "Non-nil means allow to create new nodes as refile targets.
  1793. New nodes are then created by adding \"/new node name\" to the completion
  1794. of an existing node. When the value of this variable is `confirm',
  1795. new node creation must be confirmed by the user (recommended)
  1796. When nil, the completion must match an existing entry.
  1797. Note that, if the new heading is not seen by the criteria
  1798. listed in `org-refile-targets', multiple instances of the same
  1799. heading would be created by trying again to file under the new
  1800. heading."
  1801. :group 'org-refile
  1802. :type '(choice
  1803. (const :tag "Never" nil)
  1804. (const :tag "Always" t)
  1805. (const :tag "Prompt for confirmation" confirm)))
  1806. (defcustom org-refile-active-region-within-subtree nil
  1807. "Non-nil means also refile active region within a subtree.
  1808. By default `org-refile' doesn't allow refiling regions if they
  1809. don't contain a set of subtrees, but it might be convenient to
  1810. do so sometimes: in that case, the first line of the region is
  1811. converted to a headline before refiling."
  1812. :group 'org-refile
  1813. :version "24.1"
  1814. :type 'boolean)
  1815. (defgroup org-todo nil
  1816. "Options concerning TODO items in Org-mode."
  1817. :tag "Org TODO"
  1818. :group 'org)
  1819. (defgroup org-progress nil
  1820. "Options concerning Progress logging in Org-mode."
  1821. :tag "Org Progress"
  1822. :group 'org-time)
  1823. (defvar org-todo-interpretation-widgets
  1824. '((:tag "Sequence (cycling hits every state)" sequence)
  1825. (:tag "Type (cycling directly to DONE)" type))
  1826. "The available interpretation symbols for customizing `org-todo-keywords'.
  1827. Interested libraries should add to this list.")
  1828. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  1829. "List of TODO entry keyword sequences and their interpretation.
  1830. \\<org-mode-map>This is a list of sequences.
  1831. Each sequence starts with a symbol, either `sequence' or `type',
  1832. indicating if the keywords should be interpreted as a sequence of
  1833. action steps, or as different types of TODO items. The first
  1834. keywords are states requiring action - these states will select a headline
  1835. for inclusion into the global TODO list Org-mode produces. If one of
  1836. the \"keywords\" is the vertical bar, \"|\", the remaining keywords
  1837. signify that no further action is necessary. If \"|\" is not found,
  1838. the last keyword is treated as the only DONE state of the sequence.
  1839. The command \\[org-todo] cycles an entry through these states, and one
  1840. additional state where no keyword is present. For details about this
  1841. cycling, see the manual.
  1842. TODO keywords and interpretation can also be set on a per-file basis with
  1843. the special #+SEQ_TODO and #+TYP_TODO lines.
  1844. Each keyword can optionally specify a letter for fast state selection
  1845. \(in combination with the variable `org-use-fast-todo-selection')
  1846. and specifiers for state change logging, using the same syntax that
  1847. is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
  1848. the WAIT state can be selected with the \"w\" letter. \"WAIT(w!)\"
  1849. indicates to record a time stamp each time this state is selected.
  1850. Each keyword may also specify if a timestamp or a note should be
  1851. recorded when entering or leaving the state, by adding additional
  1852. characters in the parenthesis after the keyword. This looks like this:
  1853. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  1854. record only the time of the state change. With X and Y being either
  1855. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  1856. Y when leaving the state if and only if the *target* state does not
  1857. define X. You may omit any of the fast-selection key or X or /Y,
  1858. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  1859. For backward compatibility, this variable may also be just a list
  1860. of keywords. In this case the interpretation (sequence or type) will be
  1861. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  1862. :group 'org-todo
  1863. :group 'org-keywords
  1864. :type '(choice
  1865. (repeat :tag "Old syntax, just keywords"
  1866. (string :tag "Keyword"))
  1867. (repeat :tag "New syntax"
  1868. (cons
  1869. (choice
  1870. :tag "Interpretation"
  1871. ;;Quick and dirty way to see
  1872. ;;`org-todo-interpretations'. This takes the
  1873. ;;place of item arguments
  1874. :convert-widget
  1875. (lambda (widget)
  1876. (widget-put widget
  1877. :args (mapcar
  1878. #'(lambda (x)
  1879. (widget-convert
  1880. (cons 'const x)))
  1881. org-todo-interpretation-widgets))
  1882. widget))
  1883. (repeat
  1884. (string :tag "Keyword"))))))
  1885. (defvar org-todo-keywords-1 nil
  1886. "All TODO and DONE keywords active in a buffer.")
  1887. (make-variable-buffer-local 'org-todo-keywords-1)
  1888. (defvar org-todo-keywords-for-agenda nil)
  1889. (defvar org-done-keywords-for-agenda nil)
  1890. (defvar org-drawers-for-agenda nil)
  1891. (defvar org-todo-keyword-alist-for-agenda nil)
  1892. (defvar org-tag-alist-for-agenda nil)
  1893. (defvar org-agenda-contributing-files nil)
  1894. (defvar org-not-done-keywords nil)
  1895. (make-variable-buffer-local 'org-not-done-keywords)
  1896. (defvar org-done-keywords nil)
  1897. (make-variable-buffer-local 'org-done-keywords)
  1898. (defvar org-todo-heads nil)
  1899. (make-variable-buffer-local 'org-todo-heads)
  1900. (defvar org-todo-sets nil)
  1901. (make-variable-buffer-local 'org-todo-sets)
  1902. (defvar org-todo-log-states nil)
  1903. (make-variable-buffer-local 'org-todo-log-states)
  1904. (defvar org-todo-kwd-alist nil)
  1905. (make-variable-buffer-local 'org-todo-kwd-alist)
  1906. (defvar org-todo-key-alist nil)
  1907. (make-variable-buffer-local 'org-todo-key-alist)
  1908. (defvar org-todo-key-trigger nil)
  1909. (make-variable-buffer-local 'org-todo-key-trigger)
  1910. (defcustom org-todo-interpretation 'sequence
  1911. "Controls how TODO keywords are interpreted.
  1912. This variable is in principle obsolete and is only used for
  1913. backward compatibility, if the interpretation of todo keywords is
  1914. not given already in `org-todo-keywords'. See that variable for
  1915. more information."
  1916. :group 'org-todo
  1917. :group 'org-keywords
  1918. :type '(choice (const sequence)
  1919. (const type)))
  1920. (defcustom org-use-fast-todo-selection t
  1921. "Non-nil means use the fast todo selection scheme with C-c C-t.
  1922. This variable describes if and under what circumstances the cycling
  1923. mechanism for TODO keywords will be replaced by a single-key, direct
  1924. selection scheme.
  1925. When nil, fast selection is never used.
  1926. When the symbol `prefix', it will be used when `org-todo' is called
  1927. with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
  1928. `C-u t' in an agenda buffer.
  1929. When t, fast selection is used by default. In this case, the prefix
  1930. argument forces cycling instead.
  1931. In all cases, the special interface is only used if access keys have
  1932. actually been assigned by the user, i.e. if keywords in the configuration
  1933. are followed by a letter in parenthesis, like TODO(t)."
  1934. :group 'org-todo
  1935. :type '(choice
  1936. (const :tag "Never" nil)
  1937. (const :tag "By default" t)
  1938. (const :tag "Only with C-u C-c C-t" prefix)))
  1939. (defcustom org-provide-todo-statistics t
  1940. "Non-nil means update todo statistics after insert and toggle.
  1941. ALL-HEADLINES means update todo statistics by including headlines
  1942. with no TODO keyword as well, counting them as not done.
  1943. A list of TODO keywords means the same, but skip keywords that are
  1944. not in this list.
  1945. When this is set, todo statistics is updated in the parent of the
  1946. current entry each time a todo state is changed."
  1947. :group 'org-todo
  1948. :type '(choice
  1949. (const :tag "Yes, only for TODO entries" t)
  1950. (const :tag "Yes, including all entries" 'all-headlines)
  1951. (repeat :tag "Yes, for TODOs in this list"
  1952. (string :tag "TODO keyword"))
  1953. (other :tag "No TODO statistics" nil)))
  1954. (defcustom org-hierarchical-todo-statistics t
  1955. "Non-nil means TODO statistics covers just direct children.
  1956. When nil, all entries in the subtree are considered.
  1957. This has only an effect if `org-provide-todo-statistics' is set.
  1958. To set this to nil for only a single subtree, use a COOKIE_DATA
  1959. property and include the word \"recursive\" into the value."
  1960. :group 'org-todo
  1961. :type 'boolean)
  1962. (defcustom org-after-todo-state-change-hook nil
  1963. "Hook which is run after the state of a TODO item was changed.
  1964. The new state (a string with a TODO keyword, or nil) is available in the
  1965. Lisp variable `org-state'."
  1966. :group 'org-todo
  1967. :type 'hook)
  1968. (defvar org-blocker-hook nil
  1969. "Hook for functions that are allowed to block a state change.
  1970. Each function gets as its single argument a property list, see
  1971. `org-trigger-hook' for more information about this list.
  1972. If any of the functions in this hook returns nil, the state change
  1973. is blocked.")
  1974. (defvar org-trigger-hook nil
  1975. "Hook for functions that are triggered by a state change.
  1976. Each function gets as its single argument a property list with at least
  1977. the following elements:
  1978. (:type type-of-change :position pos-at-entry-start
  1979. :from old-state :to new-state)
  1980. Depending on the type, more properties may be present.
  1981. This mechanism is currently implemented for:
  1982. TODO state changes
  1983. ------------------
  1984. :type todo-state-change
  1985. :from previous state (keyword as a string), or nil, or a symbol
  1986. 'todo' or 'done', to indicate the general type of state.
  1987. :to new state, like in :from")
  1988. (defcustom org-enforce-todo-dependencies nil
  1989. "Non-nil means undone TODO entries will block switching the parent to DONE.
  1990. Also, if a parent has an :ORDERED: property, switching an entry to DONE will
  1991. be blocked if any prior sibling is not yet done.
  1992. Finally, if the parent is blocked because of ordered siblings of its own,
  1993. the child will also be blocked."
  1994. :set (lambda (var val)
  1995. (set var val)
  1996. (if val
  1997. (add-hook 'org-blocker-hook
  1998. 'org-block-todo-from-children-or-siblings-or-parent)
  1999. (remove-hook 'org-blocker-hook
  2000. 'org-block-todo-from-children-or-siblings-or-parent)))
  2001. :group 'org-todo
  2002. :type 'boolean)
  2003. (defcustom org-enforce-todo-checkbox-dependencies nil
  2004. "Non-nil means unchecked boxes will block switching the parent to DONE.
  2005. When this is nil, checkboxes have no influence on switching TODO states.
  2006. When non-nil, you first need to check off all check boxes before the TODO
  2007. entry can be switched to DONE.
  2008. This variable needs to be set before org.el is loaded, and you need to
  2009. restart Emacs after a change to make the change effective. The only way
  2010. to change is while Emacs is running is through the customize interface."
  2011. :set (lambda (var val)
  2012. (set var val)
  2013. (if val
  2014. (add-hook 'org-blocker-hook
  2015. 'org-block-todo-from-checkboxes)
  2016. (remove-hook 'org-blocker-hook
  2017. 'org-block-todo-from-checkboxes)))
  2018. :group 'org-todo
  2019. :type 'boolean)
  2020. (defcustom org-treat-insert-todo-heading-as-state-change nil
  2021. "Non-nil means inserting a TODO heading is treated as state change.
  2022. So when the command \\[org-insert-todo-heading] is used, state change
  2023. logging will apply if appropriate. When nil, the new TODO item will
  2024. be inserted directly, and no logging will take place."
  2025. :group 'org-todo
  2026. :type 'boolean)
  2027. (defcustom org-treat-S-cursor-todo-selection-as-state-change t
  2028. "Non-nil means switching TODO states with S-cursor counts as state change.
  2029. This is the default behavior. However, setting this to nil allows a
  2030. convenient way to select a TODO state and bypass any logging associated
  2031. with that."
  2032. :group 'org-todo
  2033. :type 'boolean)
  2034. (defcustom org-todo-state-tags-triggers nil
  2035. "Tag changes that should be triggered by TODO state changes.
  2036. This is a list. Each entry is
  2037. (state-change (tag . flag) .......)
  2038. State-change can be a string with a state, and empty string to indicate the
  2039. state that has no TODO keyword, or it can be one of the symbols `todo'
  2040. or `done', meaning any not-done or done state, respectively."
  2041. :group 'org-todo
  2042. :group 'org-tags
  2043. :type '(repeat
  2044. (cons (choice :tag "When changing to"
  2045. (const :tag "Not-done state" todo)
  2046. (const :tag "Done state" done)
  2047. (string :tag "State"))
  2048. (repeat
  2049. (cons :tag "Tag action"
  2050. (string :tag "Tag")
  2051. (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
  2052. (defcustom org-log-done nil
  2053. "Information to record when a task moves to the DONE state.
  2054. Possible values are:
  2055. nil Don't add anything, just change the keyword
  2056. time Add a time stamp to the task
  2057. note Prompt for a note and add it with template `org-log-note-headings'
  2058. This option can also be set with on a per-file-basis with
  2059. #+STARTUP: nologdone
  2060. #+STARTUP: logdone
  2061. #+STARTUP: lognotedone
  2062. You can have local logging settings for a subtree by setting the LOGGING
  2063. property to one or more of these keywords."
  2064. :group 'org-todo
  2065. :group 'org-progress
  2066. :type '(choice
  2067. (const :tag "No logging" nil)
  2068. (const :tag "Record CLOSED timestamp" time)
  2069. (const :tag "Record CLOSED timestamp with note." note)))
  2070. ;; Normalize old uses of org-log-done.
  2071. (cond
  2072. ((eq org-log-done t) (setq org-log-done 'time))
  2073. ((and (listp org-log-done) (memq 'done org-log-done))
  2074. (setq org-log-done 'note)))
  2075. (defcustom org-log-reschedule nil
  2076. "Information to record when the scheduling date of a tasks is modified.
  2077. Possible values are:
  2078. nil Don't add anything, just change the date
  2079. time Add a time stamp to the task
  2080. note Prompt for a note and add it with template `org-log-note-headings'
  2081. This option can also be set with on a per-file-basis with
  2082. #+STARTUP: nologreschedule
  2083. #+STARTUP: logreschedule
  2084. #+STARTUP: lognotereschedule"
  2085. :group 'org-todo
  2086. :group 'org-progress
  2087. :type '(choice
  2088. (const :tag "No logging" nil)
  2089. (const :tag "Record timestamp" time)
  2090. (const :tag "Record timestamp with note." note)))
  2091. (defcustom org-log-redeadline nil
  2092. "Information to record when the deadline date of a tasks is modified.
  2093. Possible values are:
  2094. nil Don't add anything, just change the date
  2095. time Add a time stamp to the task
  2096. note Prompt for a note and add it with template `org-log-note-headings'
  2097. This option can also be set with on a per-file-basis with
  2098. #+STARTUP: nologredeadline
  2099. #+STARTUP: logredeadline
  2100. #+STARTUP: lognoteredeadline
  2101. You can have local logging settings for a subtree by setting the LOGGING
  2102. property to one or more of these keywords."
  2103. :group 'org-todo
  2104. :group 'org-progress
  2105. :type '(choice
  2106. (const :tag "No logging" nil)
  2107. (const :tag "Record timestamp" time)
  2108. (const :tag "Record timestamp with note." note)))
  2109. (defcustom org-log-note-clock-out nil
  2110. "Non-nil means record a note when clocking out of an item.
  2111. This can also be configured on a per-file basis by adding one of
  2112. the following lines anywhere in the buffer:
  2113. #+STARTUP: lognoteclock-out
  2114. #+STARTUP: nolognoteclock-out"
  2115. :group 'org-todo
  2116. :group 'org-progress
  2117. :type 'boolean)
  2118. (defcustom org-log-done-with-time t
  2119. "Non-nil means the CLOSED time stamp will contain date and time.
  2120. When nil, only the date will be recorded."
  2121. :group 'org-progress
  2122. :type 'boolean)
  2123. (defcustom org-log-note-headings
  2124. '((done . "CLOSING NOTE %t")
  2125. (state . "State %-12s from %-12S %t")
  2126. (note . "Note taken on %t")
  2127. (reschedule . "Rescheduled from %S on %t")
  2128. (delschedule . "Not scheduled, was %S on %t")
  2129. (redeadline . "New deadline from %S on %t")
  2130. (deldeadline . "Removed deadline, was %S on %t")
  2131. (refile . "Refiled on %t")
  2132. (clock-out . ""))
  2133. "Headings for notes added to entries.
  2134. The value is an alist, with the car being a symbol indicating the note
  2135. context, and the cdr is the heading to be used. The heading may also be the
  2136. empty string.
  2137. %t in the heading will be replaced by a time stamp.
  2138. %T will be an active time stamp instead the default inactive one
  2139. %d will be replaced by a short-format time stamp.
  2140. %D will be replaced by an active short-format time stamp.
  2141. %s will be replaced by the new TODO state, in double quotes.
  2142. %S will be replaced by the old TODO state, in double quotes.
  2143. %u will be replaced by the user name.
  2144. %U will be replaced by the full user name.
  2145. In fact, it is not a good idea to change the `state' entry, because
  2146. agenda log mode depends on the format of these entries."
  2147. :group 'org-todo
  2148. :group 'org-progress
  2149. :type '(list :greedy t
  2150. (cons (const :tag "Heading when closing an item" done) string)
  2151. (cons (const :tag
  2152. "Heading when changing todo state (todo sequence only)"
  2153. state) string)
  2154. (cons (const :tag "Heading when just taking a note" note) string)
  2155. (cons (const :tag "Heading when clocking out" clock-out) string)
  2156. (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
  2157. (cons (const :tag "Heading when rescheduling" reschedule) string)
  2158. (cons (const :tag "Heading when changing deadline" redeadline) string)
  2159. (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
  2160. (cons (const :tag "Heading when refiling" refile) string)))
  2161. (unless (assq 'note org-log-note-headings)
  2162. (push '(note . "%t") org-log-note-headings))
  2163. (defcustom org-log-into-drawer nil
  2164. "Non-nil means insert state change notes and time stamps into a drawer.
  2165. When nil, state changes notes will be inserted after the headline and
  2166. any scheduling and clock lines, but not inside a drawer.
  2167. The value of this variable should be the name of the drawer to use.
  2168. LOGBOOK is proposed as the default drawer for this purpose, you can
  2169. also set this to a string to define the drawer of your choice.
  2170. A value of t is also allowed, representing \"LOGBOOK\".
  2171. If this variable is set, `org-log-state-notes-insert-after-drawers'
  2172. will be ignored.
  2173. You can set the property LOG_INTO_DRAWER to overrule this setting for
  2174. a subtree."
  2175. :group 'org-todo
  2176. :group 'org-progress
  2177. :type '(choice
  2178. (const :tag "Not into a drawer" nil)
  2179. (const :tag "LOGBOOK" t)
  2180. (string :tag "Other")))
  2181. (if (fboundp 'defvaralias)
  2182. (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer))
  2183. (defun org-log-into-drawer ()
  2184. "Return the value of `org-log-into-drawer', but let properties overrule.
  2185. If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
  2186. used instead of the default value."
  2187. (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
  2188. (cond
  2189. ((or (not p) (equal p "nil")) org-log-into-drawer)
  2190. ((equal p "t") "LOGBOOK")
  2191. (t p))))
  2192. (defcustom org-log-state-notes-insert-after-drawers nil
  2193. "Non-nil means insert state change notes after any drawers in entry.
  2194. Only the drawers that *immediately* follow the headline and the
  2195. deadline/scheduled line are skipped.
  2196. When nil, insert notes right after the heading and perhaps the line
  2197. with deadline/scheduling if present.
  2198. This variable will have no effect if `org-log-into-drawer' is
  2199. set."
  2200. :group 'org-todo
  2201. :group 'org-progress
  2202. :type 'boolean)
  2203. (defcustom org-log-states-order-reversed t
  2204. "Non-nil means the latest state note will be directly after heading.
  2205. When nil, the state change notes will be ordered according to time."
  2206. :group 'org-todo
  2207. :group 'org-progress
  2208. :type 'boolean)
  2209. (defcustom org-todo-repeat-to-state nil
  2210. "The TODO state to which a repeater should return the repeating task.
  2211. By default this is the first task in a TODO sequence, or the previous state
  2212. in a TODO_TYP set. But you can specify another task here.
  2213. alternatively, set the :REPEAT_TO_STATE: property of the entry."
  2214. :group 'org-todo
  2215. :version "24.1"
  2216. :type '(choice (const :tag "Head of sequence" nil)
  2217. (string :tag "Specific state")))
  2218. (defcustom org-log-repeat 'time
  2219. "Non-nil means record moving through the DONE state when triggering repeat.
  2220. An auto-repeating task is immediately switched back to TODO when
  2221. marked DONE. If you are not logging state changes (by adding \"@\"
  2222. or \"!\" to the TODO keyword definition), or set `org-log-done' to
  2223. record a closing note, there will be no record of the task moving
  2224. through DONE. This variable forces taking a note anyway.
  2225. nil Don't force a record
  2226. time Record a time stamp
  2227. note Record a note
  2228. This option can also be set with on a per-file-basis with
  2229. #+STARTUP: logrepeat
  2230. #+STARTUP: lognoterepeat
  2231. #+STARTUP: nologrepeat
  2232. You can have local logging settings for a subtree by setting the LOGGING
  2233. property to one or more of these keywords."
  2234. :group 'org-todo
  2235. :group 'org-progress
  2236. :type '(choice
  2237. (const :tag "Don't force a record" nil)
  2238. (const :tag "Force recording the DONE state" time)
  2239. (const :tag "Force recording a note with the DONE state" note)))
  2240. (defgroup org-priorities nil
  2241. "Priorities in Org-mode."
  2242. :tag "Org Priorities"
  2243. :group 'org-todo)
  2244. (defcustom org-enable-priority-commands t
  2245. "Non-nil means priority commands are active.
  2246. When nil, these commands will be disabled, so that you never accidentally
  2247. set a priority."
  2248. :group 'org-priorities
  2249. :type 'boolean)
  2250. (defcustom org-highest-priority ?A
  2251. "The highest priority of TODO items. A character like ?A, ?B etc.
  2252. Must have a smaller ASCII number than `org-lowest-priority'."
  2253. :group 'org-priorities
  2254. :type 'character)
  2255. (defcustom org-lowest-priority ?C
  2256. "The lowest priority of TODO items. A character like ?A, ?B etc.
  2257. Must have a larger ASCII number than `org-highest-priority'."
  2258. :group 'org-priorities
  2259. :type 'character)
  2260. (defcustom org-default-priority ?B
  2261. "The default priority of TODO items.
  2262. This is the priority an item gets if no explicit priority is given.
  2263. When starting to cycle on an empty priority the first step in the cycle
  2264. depends on `org-priority-start-cycle-with-default'. The resulting first
  2265. step priority must not exceed the range from `org-highest-priority' to
  2266. `org-lowest-priority' which means that `org-default-priority' has to be
  2267. in this range exclusive or inclusive the range boundaries. Else the
  2268. first step refuses to set the default and the second will fall back
  2269. to (depending on the command used) the highest or lowest priority."
  2270. :group 'org-priorities
  2271. :type 'character)
  2272. (defcustom org-priority-start-cycle-with-default t
  2273. "Non-nil means start with default priority when starting to cycle.
  2274. When this is nil, the first step in the cycle will be (depending on the
  2275. command used) one higher or lower than the default priority.
  2276. See also `org-default-priority'."
  2277. :group 'org-priorities
  2278. :type 'boolean)
  2279. (defcustom org-get-priority-function nil
  2280. "Function to extract the priority from a string.
  2281. The string is normally the headline. If this is nil Org computes the
  2282. priority from the priority cookie like [#A] in the headline. It returns
  2283. an integer, increasing by 1000 for each priority level.
  2284. The user can set a different function here, which should take a string
  2285. as an argument and return the numeric priority."
  2286. :group 'org-priorities
  2287. :version "24.1"
  2288. :type 'function)
  2289. (defgroup org-time nil
  2290. "Options concerning time stamps and deadlines in Org-mode."
  2291. :tag "Org Time"
  2292. :group 'org)
  2293. (defcustom org-insert-labeled-timestamps-at-point nil
  2294. "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
  2295. When nil, these labeled time stamps are forces into the second line of an
  2296. entry, just after the headline. When scheduling from the global TODO list,
  2297. the time stamp will always be forced into the second line."
  2298. :group 'org-time
  2299. :type 'boolean)
  2300. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  2301. "Formats for `format-time-string' which are used for time stamps.
  2302. It is not recommended to change this constant.")
  2303. (defcustom org-time-stamp-rounding-minutes '(0 5)
  2304. "Number of minutes to round time stamps to.
  2305. These are two values, the first applies when first creating a time stamp.
  2306. The second applies when changing it with the commands `S-up' and `S-down'.
  2307. When changing the time stamp, this means that it will change in steps
  2308. of N minutes, as given by the second value.
  2309. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  2310. numbers should be factors of 60, so for example 5, 10, 15.
  2311. When this is larger than 1, you can still force an exact time stamp by using
  2312. a double prefix argument to a time stamp command like `C-c .' or `C-c !',
  2313. and by using a prefix arg to `S-up/down' to specify the exact number
  2314. of minutes to shift."
  2315. :group 'org-time
  2316. :get #'(lambda (var) ; Make sure both elements are there
  2317. (if (integerp (default-value var))
  2318. (list (default-value var) 5)
  2319. (default-value var)))
  2320. :type '(list
  2321. (integer :tag "when inserting times")
  2322. (integer :tag "when modifying times")))
  2323. ;; Normalize old customizations of this variable.
  2324. (when (integerp org-time-stamp-rounding-minutes)
  2325. (setq org-time-stamp-rounding-minutes
  2326. (list org-time-stamp-rounding-minutes
  2327. org-time-stamp-rounding-minutes)))
  2328. (defcustom org-display-custom-times nil
  2329. "Non-nil means overlay custom formats over all time stamps.
  2330. The formats are defined through the variable `org-time-stamp-custom-formats'.
  2331. To turn this on on a per-file basis, insert anywhere in the file:
  2332. #+STARTUP: customtime"
  2333. :group 'org-time
  2334. :set 'set-default
  2335. :type 'sexp)
  2336. (make-variable-buffer-local 'org-display-custom-times)
  2337. (defcustom org-time-stamp-custom-formats
  2338. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  2339. "Custom formats for time stamps. See `format-time-string' for the syntax.
  2340. These are overlaid over the default ISO format if the variable
  2341. `org-display-custom-times' is set. Time like %H:%M should be at the
  2342. end of the second format. The custom formats are also honored by export
  2343. commands, if custom time display is turned on at the time of export."
  2344. :group 'org-time
  2345. :type 'sexp)
  2346. (defun org-time-stamp-format (&optional long inactive)
  2347. "Get the right format for a time string."
  2348. (let ((f (if long (cdr org-time-stamp-formats)
  2349. (car org-time-stamp-formats))))
  2350. (if inactive
  2351. (concat "[" (substring f 1 -1) "]")
  2352. f)))
  2353. (defcustom org-time-clocksum-format "%d:%02d"
  2354. "The format string used when creating CLOCKSUM lines.
  2355. This is also used when org-mode generates a time duration."
  2356. :group 'org-time
  2357. :type 'string)
  2358. (defcustom org-time-clocksum-use-fractional nil
  2359. "If non-nil, \\[org-clock-display] uses fractional times.
  2360. org-mode generates a time duration."
  2361. :group 'org-time
  2362. :type 'boolean)
  2363. (defcustom org-time-clocksum-fractional-format "%.2f"
  2364. "The format string used when creating CLOCKSUM lines, or when
  2365. org-mode generates a time duration."
  2366. :group 'org-time
  2367. :type 'string)
  2368. (defcustom org-deadline-warning-days 14
  2369. "No. of days before expiration during which a deadline becomes active.
  2370. This variable governs the display in sparse trees and in the agenda.
  2371. When 0 or negative, it means use this number (the absolute value of it)
  2372. even if a deadline has a different individual lead time specified.
  2373. Custom commands can set this variable in the options section."
  2374. :group 'org-time
  2375. :group 'org-agenda-daily/weekly
  2376. :type 'integer)
  2377. (defcustom org-read-date-prefer-future t
  2378. "Non-nil means assume future for incomplete date input from user.
  2379. This affects the following situations:
  2380. 1. The user gives a month but not a year.
  2381. For example, if it is April and you enter \"feb 2\", this will be read
  2382. as Feb 2, *next* year. \"May 5\", however, will be this year.
  2383. 2. The user gives a day, but no month.
  2384. For example, if today is the 15th, and you enter \"3\", Org-mode will
  2385. read this as the third of *next* month. However, if you enter \"17\",
  2386. it will be considered as *this* month.
  2387. If you set this variable to the symbol `time', then also the following
  2388. will work:
  2389. 3. If the user gives a time, but no day. If the time is before now,
  2390. to will be interpreted as tomorrow.
  2391. Currently none of this works for ISO week specifications.
  2392. When this option is nil, the current day, month and year will always be
  2393. used as defaults.
  2394. See also `org-agenda-jump-prefer-future'."
  2395. :group 'org-time
  2396. :type '(choice
  2397. (const :tag "Never" nil)
  2398. (const :tag "Check month and day" t)
  2399. (const :tag "Check month, day, and time" time)))
  2400. (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
  2401. "Should the agenda jump command prefer the future for incomplete dates?
  2402. The default is to do the same as configured in `org-read-date-prefer-future'.
  2403. But you can also set a deviating value here.
  2404. This may t or nil, or the symbol `org-read-date-prefer-future'."
  2405. :group 'org-agenda
  2406. :group 'org-time
  2407. :version "24.1"
  2408. :type '(choice
  2409. (const :tag "Use org-read-date-prefer-future"
  2410. org-read-date-prefer-future)
  2411. (const :tag "Never" nil)
  2412. (const :tag "Always" t)))
  2413. (defcustom org-read-date-force-compatible-dates t
  2414. "Should date/time prompt force dates that are guaranteed to work in Emacs?
  2415. Depending on the system Emacs is running on, certain dates cannot
  2416. be represented with the type used internally to represent time.
  2417. Dates between 1970-1-1 and 2038-1-1 can always be represented
  2418. correctly. Some systems allow for earlier dates, some for later,
  2419. some for both. One way to find out it to insert any date into an
  2420. Org buffer, putting the cursor on the year and hitting S-up and
  2421. S-down to test the range.
  2422. When this variable is set to t, the date/time prompt will not let
  2423. you specify dates outside the 1970-2037 range, so it is certain that
  2424. these dates will work in whatever version of Emacs you are
  2425. running, and also that you can move a file from one Emacs implementation
  2426. to another. WHenever Org is forcing the year for you, it will display
  2427. a message and beep.
  2428. When this variable is nil, Org will check if the date is
  2429. representable in the specific Emacs implementation you are using.
  2430. If not, it will force a year, usually the current year, and beep
  2431. to remind you. Currently this setting is not recommended because
  2432. the likelihood that you will open your Org files in an Emacs that
  2433. has limited date range is not negligible.
  2434. A workaround for this problem is to use diary sexp dates for time
  2435. stamps outside of this range."
  2436. :group 'org-time
  2437. :version "24.1"
  2438. :type 'boolean)
  2439. (defcustom org-read-date-display-live t
  2440. "Non-nil means display current interpretation of date prompt live.
  2441. This display will be in an overlay, in the minibuffer."
  2442. :group 'org-time
  2443. :type 'boolean)
  2444. (defcustom org-read-date-popup-calendar t
  2445. "Non-nil means pop up a calendar when prompting for a date.
  2446. In the calendar, the date can be selected with mouse-1. However, the
  2447. minibuffer will also be active, and you can simply enter the date as well.
  2448. When nil, only the minibuffer will be available."
  2449. :group 'org-time
  2450. :type 'boolean)
  2451. (if (fboundp 'defvaralias)
  2452. (defvaralias 'org-popup-calendar-for-date-prompt
  2453. 'org-read-date-popup-calendar))
  2454. (defcustom org-read-date-minibuffer-setup-hook nil
  2455. "Hook to be used to set up keys for the date/time interface.
  2456. Add key definitions to `minibuffer-local-map', which will be a temporary
  2457. copy."
  2458. :group 'org-time
  2459. :type 'hook)
  2460. (defcustom org-extend-today-until 0
  2461. "The hour when your day really ends. Must be an integer.
  2462. This has influence for the following applications:
  2463. - When switching the agenda to \"today\". It it is still earlier than
  2464. the time given here, the day recognized as TODAY is actually yesterday.
  2465. - When a date is read from the user and it is still before the time given
  2466. here, the current date and time will be assumed to be yesterday, 23:59.
  2467. Also, timestamps inserted in remember templates follow this rule.
  2468. IMPORTANT: This is a feature whose implementation is and likely will
  2469. remain incomplete. Really, it is only here because past midnight seems to
  2470. be the favorite working time of John Wiegley :-)"
  2471. :group 'org-time
  2472. :type 'integer)
  2473. (defcustom org-use-effective-time nil
  2474. "If non-nil, consider `org-extend-today-until' when creating timestamps.
  2475. For example, if `org-extend-today-until' is 8, and it's 4am, then the
  2476. \"effective time\" of any timestamps between midnight and 8am will be
  2477. 23:59 of the previous day."
  2478. :group 'org-time
  2479. :version "24.1"
  2480. :type 'boolean)
  2481. (defcustom org-edit-timestamp-down-means-later nil
  2482. "Non-nil means S-down will increase the time in a time stamp.
  2483. When nil, S-up will increase."
  2484. :group 'org-time
  2485. :type 'boolean)
  2486. (defcustom org-calendar-follow-timestamp-change t
  2487. "Non-nil means make the calendar window follow timestamp changes.
  2488. When a timestamp is modified and the calendar window is visible, it will be
  2489. moved to the new date."
  2490. :group 'org-time
  2491. :type 'boolean)
  2492. (defgroup org-tags nil
  2493. "Options concerning tags in Org-mode."
  2494. :tag "Org Tags"
  2495. :group 'org)
  2496. (defcustom org-tag-alist nil
  2497. "List of tags allowed in Org-mode files.
  2498. When this list is nil, Org-mode will base TAG input on what is already in the
  2499. buffer.
  2500. The value of this variable is an alist, the car of each entry must be a
  2501. keyword as a string, the cdr may be a character that is used to select
  2502. that tag through the fast-tag-selection interface.
  2503. See the manual for details."
  2504. :group 'org-tags
  2505. :type '(repeat
  2506. (choice
  2507. (cons (string :tag "Tag name")
  2508. (character :tag "Access char"))
  2509. (list :tag "Start radio group"
  2510. (const :startgroup)
  2511. (option (string :tag "Group description")))
  2512. (list :tag "End radio group"
  2513. (const :endgroup)
  2514. (option (string :tag "Group description")))
  2515. (const :tag "New line" (:newline)))))
  2516. (defcustom org-tag-persistent-alist nil
  2517. "List of tags that will always appear in all Org-mode files.
  2518. This is in addition to any in buffer settings or customizations
  2519. of `org-tag-alist'.
  2520. When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
  2521. The value of this variable is an alist, the car of each entry must be a
  2522. keyword as a string, the cdr may be a character that is used to select
  2523. that tag through the fast-tag-selection interface.
  2524. See the manual for details.
  2525. To disable these tags on a per-file basis, insert anywhere in the file:
  2526. #+STARTUP: noptag"
  2527. :group 'org-tags
  2528. :type '(repeat
  2529. (choice
  2530. (cons (string :tag "Tag name")
  2531. (character :tag "Access char"))
  2532. (const :tag "Start radio group" (:startgroup))
  2533. (const :tag "End radio group" (:endgroup))
  2534. (const :tag "New line" (:newline)))))
  2535. (defcustom org-complete-tags-always-offer-all-agenda-tags nil
  2536. "If non-nil, always offer completion for all tags of all agenda files.
  2537. Instead of customizing this variable directly, you might want to
  2538. set it locally for capture buffers, because there no list of
  2539. tags in that file can be created dynamically (there are none).
  2540. (add-hook 'org-capture-mode-hook
  2541. (lambda ()
  2542. (set (make-local-variable
  2543. 'org-complete-tags-always-offer-all-agenda-tags)
  2544. t)))"
  2545. :group 'org-tags
  2546. :version "24.1"
  2547. :type 'boolean)
  2548. (defvar org-file-tags nil
  2549. "List of tags that can be inherited by all entries in the file.
  2550. The tags will be inherited if the variable `org-use-tag-inheritance'
  2551. says they should be.
  2552. This variable is populated from #+FILETAGS lines.")
  2553. (defcustom org-use-fast-tag-selection 'auto
  2554. "Non-nil means use fast tag selection scheme.
  2555. This is a special interface to select and deselect tags with single keys.
  2556. When nil, fast selection is never used.
  2557. When the symbol `auto', fast selection is used if and only if selection
  2558. characters for tags have been configured, either through the variable
  2559. `org-tag-alist' or through a #+TAGS line in the buffer.
  2560. When t, fast selection is always used and selection keys are assigned
  2561. automatically if necessary."
  2562. :group 'org-tags
  2563. :type '(choice
  2564. (const :tag "Always" t)
  2565. (const :tag "Never" nil)
  2566. (const :tag "When selection characters are configured" 'auto)))
  2567. (defcustom org-fast-tag-selection-single-key nil
  2568. "Non-nil means fast tag selection exits after first change.
  2569. When nil, you have to press RET to exit it.
  2570. During fast tag selection, you can toggle this flag with `C-c'.
  2571. This variable can also have the value `expert'. In this case, the window
  2572. displaying the tags menu is not even shown, until you press C-c again."
  2573. :group 'org-tags
  2574. :type '(choice
  2575. (const :tag "No" nil)
  2576. (const :tag "Yes" t)
  2577. (const :tag "Expert" expert)))
  2578. (defvar org-fast-tag-selection-include-todo nil
  2579. "Non-nil means fast tags selection interface will also offer TODO states.
  2580. This is an undocumented feature, you should not rely on it.")
  2581. (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
  2582. "The column to which tags should be indented in a headline.
  2583. If this number is positive, it specifies the column. If it is negative,
  2584. it means that the tags should be flushright to that column. For example,
  2585. -80 works well for a normal 80 character screen.
  2586. When 0, place tags directly after headline text, with only one space in
  2587. between."
  2588. :group 'org-tags
  2589. :type 'integer)
  2590. (defcustom org-auto-align-tags t
  2591. "Non-nil keeps tags aligned when modifying headlines.
  2592. Some operations (i.e. demoting) change the length of a headline and
  2593. therefore shift the tags around. With this option turned on, after
  2594. each such operation the tags are again aligned to `org-tags-column'."
  2595. :group 'org-tags
  2596. :type 'boolean)
  2597. (defcustom org-use-tag-inheritance t
  2598. "Non-nil means tags in levels apply also for sublevels.
  2599. When nil, only the tags directly given in a specific line apply there.
  2600. This may also be a list of tags that should be inherited, or a regexp that
  2601. matches tags that should be inherited. Additional control is possible
  2602. with the variable `org-tags-exclude-from-inheritance' which gives an
  2603. explicit list of tags to be excluded from inheritance., even if the value of
  2604. `org-use-tag-inheritance' would select it for inheritance.
  2605. If this option is t, a match early-on in a tree can lead to a large
  2606. number of matches in the subtree when constructing the agenda or creating
  2607. a sparse tree. If you only want to see the first match in a tree during
  2608. a search, check out the variable `org-tags-match-list-sublevels'."
  2609. :group 'org-tags
  2610. :type '(choice
  2611. (const :tag "Not" nil)
  2612. (const :tag "Always" t)
  2613. (repeat :tag "Specific tags" (string :tag "Tag"))
  2614. (regexp :tag "Tags matched by regexp")))
  2615. (defcustom org-tags-exclude-from-inheritance nil
  2616. "List of tags that should never be inherited.
  2617. This is a way to exclude a few tags from inheritance. For way to do
  2618. the opposite, to actively allow inheritance for selected tags,
  2619. see the variable `org-use-tag-inheritance'."
  2620. :group 'org-tags
  2621. :type '(repeat (string :tag "Tag")))
  2622. (defun org-tag-inherit-p (tag)
  2623. "Check if TAG is one that should be inherited."
  2624. (cond
  2625. ((member tag org-tags-exclude-from-inheritance) nil)
  2626. ((eq org-use-tag-inheritance t) t)
  2627. ((not org-use-tag-inheritance) nil)
  2628. ((stringp org-use-tag-inheritance)
  2629. (string-match org-use-tag-inheritance tag))
  2630. ((listp org-use-tag-inheritance)
  2631. (member tag org-use-tag-inheritance))
  2632. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  2633. (defcustom org-tags-match-list-sublevels t
  2634. "Non-nil means list also sublevels of headlines matching a search.
  2635. This variable applies to tags/property searches, and also to stuck
  2636. projects because this search is based on a tags match as well.
  2637. When set to the symbol `indented', sublevels are indented with
  2638. leading dots.
  2639. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  2640. the sublevels of a headline matching a tag search often also match
  2641. the same search. Listing all of them can create very long lists.
  2642. Setting this variable to nil causes subtrees of a match to be skipped.
  2643. This variable is semi-obsolete and probably should always be true. It
  2644. is better to limit inheritance to certain tags using the variables
  2645. `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
  2646. :group 'org-tags
  2647. :type '(choice
  2648. (const :tag "No, don't list them" nil)
  2649. (const :tag "Yes, do list them" t)
  2650. (const :tag "List them, indented with leading dots" indented)))
  2651. (defcustom org-tags-sort-function nil
  2652. "When set, tags are sorted using this function as a comparator."
  2653. :group 'org-tags
  2654. :type '(choice
  2655. (const :tag "No sorting" nil)
  2656. (const :tag "Alphabetical" string<)
  2657. (const :tag "Reverse alphabetical" string>)
  2658. (function :tag "Custom function" nil)))
  2659. (defvar org-tags-history nil
  2660. "History of minibuffer reads for tags.")
  2661. (defvar org-last-tags-completion-table nil
  2662. "The last used completion table for tags.")
  2663. (defvar org-after-tags-change-hook nil
  2664. "Hook that is run after the tags in a line have changed.")
  2665. (defgroup org-properties nil
  2666. "Options concerning properties in Org-mode."
  2667. :tag "Org Properties"
  2668. :group 'org)
  2669. (defcustom org-property-format "%-10s %s"
  2670. "How property key/value pairs should be formatted by `indent-line'.
  2671. When `indent-line' hits a property definition, it will format the line
  2672. according to this format, mainly to make sure that the values are
  2673. lined-up with respect to each other."
  2674. :group 'org-properties
  2675. :type 'string)
  2676. (defcustom org-properties-postprocess-alist nil
  2677. "Alist of properties and functions to adjust inserted values.
  2678. Elements of this alist must be of the form
  2679. ([string] [function])
  2680. where [string] must be a property name and [function] must be a
  2681. lambda expression: this lambda expression must take one argument,
  2682. the value to adjust, and return the new value as a string.
  2683. For example, this element will allow the property \"Remaining\"
  2684. to be updated wrt the relation between the \"Effort\" property
  2685. and the clock summary:
  2686. ((\"Remaining\" (lambda(value)
  2687. (let ((clocksum (org-clock-sum-current-item))
  2688. (effort (org-duration-string-to-minutes
  2689. (org-entry-get (point) \"Effort\"))))
  2690. (org-minutes-to-hh:mm-string (- effort clocksum))))))"
  2691. :group 'org-properties
  2692. :version "24.1"
  2693. :type '(alist :key-type (string :tag "Property")
  2694. :value-type (function :tag "Function")))
  2695. (defcustom org-use-property-inheritance nil
  2696. "Non-nil means properties apply also for sublevels.
  2697. This setting is chiefly used during property searches. Turning it on can
  2698. cause significant overhead when doing a search, which is why it is not
  2699. on by default.
  2700. When nil, only the properties directly given in the current entry count.
  2701. When t, every property is inherited. The value may also be a list of
  2702. properties that should have inheritance, or a regular expression matching
  2703. properties that should be inherited.
  2704. However, note that some special properties use inheritance under special
  2705. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  2706. and the properties ending in \"_ALL\" when they are used as descriptor
  2707. for valid values of a property.
  2708. Note for programmers:
  2709. When querying an entry with `org-entry-get', you can control if inheritance
  2710. should be used. By default, `org-entry-get' looks only at the local
  2711. properties. You can request inheritance by setting the inherit argument
  2712. to t (to force inheritance) or to `selective' (to respect the setting
  2713. in this variable)."
  2714. :group 'org-properties
  2715. :type '(choice
  2716. (const :tag "Not" nil)
  2717. (const :tag "Always" t)
  2718. (repeat :tag "Specific properties" (string :tag "Property"))
  2719. (regexp :tag "Properties matched by regexp")))
  2720. (defun org-property-inherit-p (property)
  2721. "Check if PROPERTY is one that should be inherited."
  2722. (cond
  2723. ((eq org-use-property-inheritance t) t)
  2724. ((not org-use-property-inheritance) nil)
  2725. ((stringp org-use-property-inheritance)
  2726. (string-match org-use-property-inheritance property))
  2727. ((listp org-use-property-inheritance)
  2728. (member property org-use-property-inheritance))
  2729. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  2730. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  2731. "The default column format, if no other format has been defined.
  2732. This variable can be set on the per-file basis by inserting a line
  2733. #+COLUMNS: %25ITEM ....."
  2734. :group 'org-properties
  2735. :type 'string)
  2736. (defcustom org-columns-ellipses ".."
  2737. "The ellipses to be used when a field in column view is truncated.
  2738. When this is the empty string, as many characters as possible are shown,
  2739. but then there will be no visual indication that the field has been truncated.
  2740. When this is a string of length N, the last N characters of a truncated
  2741. field are replaced by this string. If the column is narrower than the
  2742. ellipses string, only part of the ellipses string will be shown."
  2743. :group 'org-properties
  2744. :type 'string)
  2745. (defcustom org-columns-modify-value-for-display-function nil
  2746. "Function that modifies values for display in column view.
  2747. For example, it can be used to cut out a certain part from a time stamp.
  2748. The function must take 2 arguments:
  2749. column-title The title of the column (*not* the property name)
  2750. value The value that should be modified.
  2751. The function should return the value that should be displayed,
  2752. or nil if the normal value should be used."
  2753. :group 'org-properties
  2754. :type 'function)
  2755. (defcustom org-effort-property "Effort"
  2756. "The property that is being used to keep track of effort estimates.
  2757. Effort estimates given in this property need to have the format H:MM."
  2758. :group 'org-properties
  2759. :group 'org-progress
  2760. :type '(string :tag "Property"))
  2761. (defconst org-global-properties-fixed
  2762. '(("VISIBILITY_ALL" . "folded children content all")
  2763. ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
  2764. "List of property/value pairs that can be inherited by any entry.
  2765. These are fixed values, for the preset properties. The user variable
  2766. that can be used to add to this list is `org-global-properties'.
  2767. The entries in this list are cons cells where the car is a property
  2768. name and cdr is a string with the value. If the value represents
  2769. multiple items like an \"_ALL\" property, separate the items by
  2770. spaces.")
  2771. (defcustom org-global-properties nil
  2772. "List of property/value pairs that can be inherited by any entry.
  2773. This list will be combined with the constant `org-global-properties-fixed'.
  2774. The entries in this list are cons cells where the car is a property
  2775. name and cdr is a string with the value.
  2776. You can set buffer-local values for the same purpose in the variable
  2777. `org-file-properties' this by adding lines like
  2778. #+PROPERTY: NAME VALUE"
  2779. :group 'org-properties
  2780. :type '(repeat
  2781. (cons (string :tag "Property")
  2782. (string :tag "Value"))))
  2783. (defvar org-file-properties nil
  2784. "List of property/value pairs that can be inherited by any entry.
  2785. Valid for the current buffer.
  2786. This variable is populated from #+PROPERTY lines.")
  2787. (make-variable-buffer-local 'org-file-properties)
  2788. (defgroup org-agenda nil
  2789. "Options concerning agenda views in Org-mode."
  2790. :tag "Org Agenda"
  2791. :group 'org)
  2792. (defvar org-category nil
  2793. "Variable used by org files to set a category for agenda display.
  2794. Such files should use a file variable to set it, for example
  2795. # -*- mode: org; org-category: \"ELisp\"
  2796. or contain a special line
  2797. #+CATEGORY: ELisp
  2798. If the file does not specify a category, then file's base name
  2799. is used instead.")
  2800. (make-variable-buffer-local 'org-category)
  2801. (put 'org-category 'safe-local-variable #'(lambda (x) (or (symbolp x) (stringp x))))
  2802. (defcustom org-agenda-files nil
  2803. "The files to be used for agenda display.
  2804. Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
  2805. \\[org-remove-file]. You can also use customize to edit the list.
  2806. If an entry is a directory, all files in that directory that are matched by
  2807. `org-agenda-file-regexp' will be part of the file list.
  2808. If the value of the variable is not a list but a single file name, then
  2809. the list of agenda files is actually stored and maintained in that file, one
  2810. agenda file per line. In this file paths can be given relative to
  2811. `org-directory'. Tilde expansion and environment variable substitution
  2812. are also made."
  2813. :group 'org-agenda
  2814. :type '(choice
  2815. (repeat :tag "List of files and directories" file)
  2816. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  2817. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  2818. "Regular expression to match files for `org-agenda-files'.
  2819. If any element in the list in that variable contains a directory instead
  2820. of a normal file, all files in that directory that are matched by this
  2821. regular expression will be included."
  2822. :group 'org-agenda
  2823. :type 'regexp)
  2824. (defcustom org-agenda-text-search-extra-files nil
  2825. "List of extra files to be searched by text search commands.
  2826. These files will be search in addition to the agenda files by the
  2827. commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
  2828. Note that these files will only be searched for text search commands,
  2829. not for the other agenda views like todo lists, tag searches or the weekly
  2830. agenda. This variable is intended to list notes and possibly archive files
  2831. that should also be searched by these two commands.
  2832. In fact, if the first element in the list is the symbol `agenda-archives',
  2833. than all archive files of all agenda files will be added to the search
  2834. scope."
  2835. :group 'org-agenda
  2836. :type '(set :greedy t
  2837. (const :tag "Agenda Archives" agenda-archives)
  2838. (repeat :inline t (file))))
  2839. (if (fboundp 'defvaralias)
  2840. (defvaralias 'org-agenda-multi-occur-extra-files
  2841. 'org-agenda-text-search-extra-files))
  2842. (defcustom org-agenda-skip-unavailable-files nil
  2843. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  2844. A nil value means to remove them, after a query, from the list."
  2845. :group 'org-agenda
  2846. :type 'boolean)
  2847. (defcustom org-calendar-to-agenda-key [?c]
  2848. "The key to be installed in `calendar-mode-map' for switching to the agenda.
  2849. The command `org-calendar-goto-agenda' will be bound to this key. The
  2850. default is the character `c' because then `c' can be used to switch back and
  2851. forth between agenda and calendar."
  2852. :group 'org-agenda
  2853. :type 'sexp)
  2854. (defcustom org-calendar-agenda-action-key [?k]
  2855. "The key to be installed in `calendar-mode-map' for agenda-action.
  2856. The command `org-agenda-action' will be bound to this key. The
  2857. default is the character `k' because we use the same key in the agenda."
  2858. :group 'org-agenda
  2859. :type 'sexp)
  2860. (defcustom org-calendar-insert-diary-entry-key [?i]
  2861. "The key to be installed in `calendar-mode-map' for adding diary entries.
  2862. This option is irrelevant until `org-agenda-diary-file' has been configured
  2863. to point to an Org-mode file. When that is the case, the command
  2864. `org-agenda-diary-entry' will be bound to the key given here, by default
  2865. `i'. In the calendar, `i' normally adds entries to `diary-file'. So
  2866. if you want to continue doing this, you need to change this to a different
  2867. key."
  2868. :group 'org-agenda
  2869. :type 'sexp)
  2870. (defcustom org-agenda-diary-file 'diary-file
  2871. "File to which to add new entries with the `i' key in agenda and calendar.
  2872. When this is the symbol `diary-file', the functionality in the Emacs
  2873. calendar will be used to add entries to the `diary-file'. But when this
  2874. points to a file, `org-agenda-diary-entry' will be used instead."
  2875. :group 'org-agenda
  2876. :type '(choice
  2877. (const :tag "The standard Emacs diary file" diary-file)
  2878. (file :tag "Special Org file diary entries")))
  2879. (eval-after-load "calendar"
  2880. '(progn
  2881. (org-defkey calendar-mode-map org-calendar-to-agenda-key
  2882. 'org-calendar-goto-agenda)
  2883. (org-defkey calendar-mode-map org-calendar-agenda-action-key
  2884. 'org-agenda-action)
  2885. (add-hook 'calendar-mode-hook
  2886. (lambda ()
  2887. (unless (eq org-agenda-diary-file 'diary-file)
  2888. (define-key calendar-mode-map
  2889. org-calendar-insert-diary-entry-key
  2890. 'org-agenda-diary-entry))))))
  2891. (defgroup org-latex nil
  2892. "Options for embedding LaTeX code into Org-mode."
  2893. :tag "Org LaTeX"
  2894. :group 'org)
  2895. (defcustom org-format-latex-options
  2896. '(:foreground default :background default :scale 1.0
  2897. :html-foreground "Black" :html-background "Transparent"
  2898. :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
  2899. "Options for creating images from LaTeX fragments.
  2900. This is a property list with the following properties:
  2901. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  2902. `default' means use the foreground of the default face.
  2903. :background the background color, or \"Transparent\".
  2904. `default' means use the background of the default face.
  2905. :scale a scaling factor for the size of the images, to get more pixels
  2906. :html-foreground, :html-background, :html-scale
  2907. the same numbers for HTML export.
  2908. :matchers a list indicating which matchers should be used to
  2909. find LaTeX fragments. Valid members of this list are:
  2910. \"begin\" find environments
  2911. \"$1\" find single characters surrounded by $.$
  2912. \"$\" find math expressions surrounded by $...$
  2913. \"$$\" find math expressions surrounded by $$....$$
  2914. \"\\(\" find math expressions surrounded by \\(...\\)
  2915. \"\\ [\" find math expressions surrounded by \\ [...\\]"
  2916. :group 'org-latex
  2917. :type 'plist)
  2918. (defcustom org-format-latex-signal-error t
  2919. "Non-nil means signal an error when image creation of LaTeX snippets fails.
  2920. When nil, just push out a message."
  2921. :group 'org-latex
  2922. :version "24.1"
  2923. :type 'boolean)
  2924. (defcustom org-latex-to-mathml-jar-file nil
  2925. "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
  2926. Use this to specify additional executable file say a jar file.
  2927. When using MathToWeb as the converter, specify the full-path to
  2928. your mathtoweb.jar file."
  2929. :group 'org-latex
  2930. :version "24.1"
  2931. :type '(choice
  2932. (const :tag "None" nil)
  2933. (file :tag "JAR file" :must-match t)))
  2934. (defcustom org-latex-to-mathml-convert-command nil
  2935. "Command to convert LaTeX fragments to MathML.
  2936. Replace format-specifiers in the command as noted below and use
  2937. `shell-command' to convert LaTeX to MathML.
  2938. %j: Executable file in fully expanded form as specified by
  2939. `org-latex-to-mathml-jar-file'.
  2940. %I: Input LaTeX file in fully expanded form
  2941. %o: Output MathML file
  2942. This command is used by `org-create-math-formula'.
  2943. When using MathToWeb as the converter, set this to
  2944. \"java -jar %j -unicode -force -df %o %I\"."
  2945. :group 'org-latex
  2946. :version "24.1"
  2947. :type '(choice
  2948. (const :tag "None" nil)
  2949. (string :tag "\nShell command")))
  2950. (defcustom org-latex-create-formula-image-program 'dvipng
  2951. "Program to convert LaTeX fragments with.
  2952. dvipng Process the LaTeX fragments to dvi file, then convert
  2953. dvi files to png files using dvipng.
  2954. This will also include processing of non-math environments.
  2955. imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
  2956. to convert pdf files to png files"
  2957. :group 'org-latex
  2958. :version "24.1"
  2959. :type '(choice
  2960. (const :tag "dvipng" dvipng)
  2961. (const :tag "imagemagick" imagemagick)))
  2962. (defun org-format-latex-mathml-available-p ()
  2963. "Return t if `org-latex-to-mathml-convert-command' is usable."
  2964. (save-match-data
  2965. (when (and (boundp 'org-latex-to-mathml-convert-command)
  2966. org-latex-to-mathml-convert-command)
  2967. (let ((executable (car (split-string
  2968. org-latex-to-mathml-convert-command))))
  2969. (when (executable-find executable)
  2970. (if (string-match
  2971. "%j" org-latex-to-mathml-convert-command)
  2972. (file-readable-p org-latex-to-mathml-jar-file)
  2973. t))))))
  2974. (defcustom org-format-latex-header "\\documentclass{article}
  2975. \\usepackage[usenames]{color}
  2976. \\usepackage{amsmath}
  2977. \\usepackage[mathscr]{eucal}
  2978. \\pagestyle{empty} % do not remove
  2979. \[PACKAGES]
  2980. \[DEFAULT-PACKAGES]
  2981. % The settings below are copied from fullpage.sty
  2982. \\setlength{\\textwidth}{\\paperwidth}
  2983. \\addtolength{\\textwidth}{-3cm}
  2984. \\setlength{\\oddsidemargin}{1.5cm}
  2985. \\addtolength{\\oddsidemargin}{-2.54cm}
  2986. \\setlength{\\evensidemargin}{\\oddsidemargin}
  2987. \\setlength{\\textheight}{\\paperheight}
  2988. \\addtolength{\\textheight}{-\\headheight}
  2989. \\addtolength{\\textheight}{-\\headsep}
  2990. \\addtolength{\\textheight}{-\\footskip}
  2991. \\addtolength{\\textheight}{-3cm}
  2992. \\setlength{\\topmargin}{1.5cm}
  2993. \\addtolength{\\topmargin}{-2.54cm}"
  2994. "The document header used for processing LaTeX fragments.
  2995. It is imperative that this header make sure that no page number
  2996. appears on the page. The package defined in the variables
  2997. `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
  2998. will either replace the placeholder \"[PACKAGES]\" in this header, or they
  2999. will be appended."
  3000. :group 'org-latex
  3001. :type 'string)
  3002. (defvar org-format-latex-header-extra nil)
  3003. (defun org-set-packages-alist (var val)
  3004. "Set the packages alist and make sure it has 3 elements per entry."
  3005. (set var (mapcar (lambda (x)
  3006. (if (and (consp x) (= (length x) 2))
  3007. (list (car x) (nth 1 x) t)
  3008. x))
  3009. val)))
  3010. (defun org-get-packages-alist (var)
  3011. "Get the packages alist and make sure it has 3 elements per entry."
  3012. (mapcar (lambda (x)
  3013. (if (and (consp x) (= (length x) 2))
  3014. (list (car x) (nth 1 x) t)
  3015. x))
  3016. (default-value var)))
  3017. ;; The following variables are defined here because is it also used
  3018. ;; when formatting latex fragments. Originally it was part of the
  3019. ;; LaTeX exporter, which is why the name includes "export".
  3020. (defcustom org-export-latex-default-packages-alist
  3021. '(("AUTO" "inputenc" t)
  3022. ("T1" "fontenc" t)
  3023. ("" "fixltx2e" nil)
  3024. ("" "graphicx" t)
  3025. ("" "longtable" nil)
  3026. ("" "float" nil)
  3027. ("" "wrapfig" nil)
  3028. ("" "soul" t)
  3029. ("" "textcomp" t)
  3030. ("" "marvosym" t)
  3031. ("" "wasysym" t)
  3032. ("" "latexsym" t)
  3033. ("" "amssymb" t)
  3034. ("" "hyperref" nil)
  3035. "\\tolerance=1000"
  3036. )
  3037. "Alist of default packages to be inserted in the header.
  3038. Change this only if one of the packages here causes an incompatibility
  3039. with another package you are using.
  3040. The packages in this list are needed by one part or another of Org-mode
  3041. to function properly.
  3042. - inputenc, fontenc: for basic font and character selection
  3043. - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
  3044. for interpreting the entities in `org-entities'. You can skip some of these
  3045. packages if you don't use any of the symbols in it.
  3046. - graphicx: for including images
  3047. - float, wrapfig: for figure placement
  3048. - longtable: for long tables
  3049. - hyperref: for cross references
  3050. Therefore you should not modify this variable unless you know what you
  3051. are doing. The one reason to change it anyway is that you might be loading
  3052. some other package that conflicts with one of the default packages.
  3053. Each cell is of the format \( \"options\" \"package\" snippet-flag\).
  3054. If SNIPPET-FLAG is t, the package also needs to be included when
  3055. compiling LaTeX snippets into images for inclusion into HTML."
  3056. :group 'org-export-latex
  3057. :set 'org-set-packages-alist
  3058. :get 'org-get-packages-alist
  3059. :version "24.1"
  3060. :type '(repeat
  3061. (choice
  3062. (list :tag "options/package pair"
  3063. (string :tag "options")
  3064. (string :tag "package")
  3065. (boolean :tag "Snippet"))
  3066. (string :tag "A line of LaTeX"))))
  3067. (defcustom org-export-latex-packages-alist nil
  3068. "Alist of packages to be inserted in every LaTeX header.
  3069. These will be inserted after `org-export-latex-default-packages-alist'.
  3070. Each cell is of the format \( \"options\" \"package\" snippet-flag \).
  3071. SNIPPET-FLAG, when t, indicates that this package is also needed when
  3072. turning LaTeX snippets into images for inclusion into HTML.
  3073. Make sure that you only list packages here which:
  3074. - you want in every file
  3075. - do not conflict with the default packages in
  3076. `org-export-latex-default-packages-alist'
  3077. - do not conflict with the setup in `org-format-latex-header'."
  3078. :group 'org-export-latex
  3079. :set 'org-set-packages-alist
  3080. :get 'org-get-packages-alist
  3081. :type '(repeat
  3082. (choice
  3083. (list :tag "options/package pair"
  3084. (string :tag "options")
  3085. (string :tag "package")
  3086. (boolean :tag "Snippet"))
  3087. (string :tag "A line of LaTeX"))))
  3088. (defgroup org-appearance nil
  3089. "Settings for Org-mode appearance."
  3090. :tag "Org Appearance"
  3091. :group 'org)
  3092. (defcustom org-level-color-stars-only nil
  3093. "Non-nil means fontify only the stars in each headline.
  3094. When nil, the entire headline is fontified.
  3095. Changing it requires restart of `font-lock-mode' to become effective
  3096. also in regions already fontified."
  3097. :group 'org-appearance
  3098. :type 'boolean)
  3099. (defcustom org-hide-leading-stars nil
  3100. "Non-nil means hide the first N-1 stars in a headline.
  3101. This works by using the face `org-hide' for these stars. This
  3102. face is white for a light background, and black for a dark
  3103. background. You may have to customize the face `org-hide' to
  3104. make this work.
  3105. Changing it requires restart of `font-lock-mode' to become effective
  3106. also in regions already fontified.
  3107. You may also set this on a per-file basis by adding one of the following
  3108. lines to the buffer:
  3109. #+STARTUP: hidestars
  3110. #+STARTUP: showstars"
  3111. :group 'org-appearance
  3112. :type 'boolean)
  3113. (defcustom org-hidden-keywords nil
  3114. "List of symbols corresponding to keywords to be hidden the org buffer.
  3115. For example, a value '(title) for this list will make the document's title
  3116. appear in the buffer without the initial #+TITLE: keyword."
  3117. :group 'org-appearance
  3118. :version "24.1"
  3119. :type '(set (const :tag "#+AUTHOR" author)
  3120. (const :tag "#+DATE" date)
  3121. (const :tag "#+EMAIL" email)
  3122. (const :tag "#+TITLE" title)))
  3123. (defcustom org-fontify-done-headline nil
  3124. "Non-nil means change the face of a headline if it is marked DONE.
  3125. Normally, only the TODO/DONE keyword indicates the state of a headline.
  3126. When this is non-nil, the headline after the keyword is set to the
  3127. `org-headline-done' as an additional indication."
  3128. :group 'org-appearance
  3129. :type 'boolean)
  3130. (defcustom org-fontify-emphasized-text t
  3131. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  3132. Changing this variable requires a restart of Emacs to take effect."
  3133. :group 'org-appearance
  3134. :type 'boolean)
  3135. (defcustom org-fontify-whole-heading-line nil
  3136. "Non-nil means fontify the whole line for headings.
  3137. This is useful when setting a background color for the
  3138. org-level-* faces."
  3139. :group 'org-appearance
  3140. :type 'boolean)
  3141. (defcustom org-highlight-latex-fragments-and-specials nil
  3142. "Non-nil means fontify what is treated specially by the exporters."
  3143. :group 'org-appearance
  3144. :type 'boolean)
  3145. (defcustom org-hide-emphasis-markers nil
  3146. "Non-nil mean font-lock should hide the emphasis marker characters."
  3147. :group 'org-appearance
  3148. :type 'boolean)
  3149. (defcustom org-pretty-entities nil
  3150. "Non-nil means show entities as UTF8 characters.
  3151. When nil, the \\name form remains in the buffer."
  3152. :group 'org-appearance
  3153. :version "24.1"
  3154. :type 'boolean)
  3155. (defcustom org-pretty-entities-include-sub-superscripts t
  3156. "Non-nil means, pretty entity display includes formatting sub/superscripts."
  3157. :group 'org-appearance
  3158. :version "24.1"
  3159. :type 'boolean)
  3160. (defvar org-emph-re nil
  3161. "Regular expression for matching emphasis.
  3162. After a match, the match groups contain these elements:
  3163. 0 The match of the full regular expression, including the characters
  3164. before and after the proper match
  3165. 1 The character before the proper match, or empty at beginning of line
  3166. 2 The proper match, including the leading and trailing markers
  3167. 3 The leading marker like * or /, indicating the type of highlighting
  3168. 4 The text between the emphasis markers, not including the markers
  3169. 5 The character after the match, empty at the end of a line")
  3170. (defvar org-verbatim-re nil
  3171. "Regular expression for matching verbatim text.")
  3172. (defvar org-emphasis-regexp-components) ; defined just below
  3173. (defvar org-emphasis-alist) ; defined just below
  3174. (defun org-set-emph-re (var val)
  3175. "Set variable and compute the emphasis regular expression."
  3176. (set var val)
  3177. (when (and (boundp 'org-emphasis-alist)
  3178. (boundp 'org-emphasis-regexp-components)
  3179. org-emphasis-alist org-emphasis-regexp-components)
  3180. (let* ((e org-emphasis-regexp-components)
  3181. (pre (car e))
  3182. (post (nth 1 e))
  3183. (border (nth 2 e))
  3184. (body (nth 3 e))
  3185. (nl (nth 4 e))
  3186. (body1 (concat body "*?"))
  3187. (markers (mapconcat 'car org-emphasis-alist ""))
  3188. (vmarkers (mapconcat
  3189. (lambda (x) (if (eq (nth 4 x) 'verbatim) (car x) ""))
  3190. org-emphasis-alist "")))
  3191. ;; make sure special characters appear at the right position in the class
  3192. (if (string-match "\\^" markers)
  3193. (setq markers (concat (replace-match "" t t markers) "^")))
  3194. (if (string-match "-" markers)
  3195. (setq markers (concat (replace-match "" t t markers) "-")))
  3196. (if (string-match "\\^" vmarkers)
  3197. (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
  3198. (if (string-match "-" vmarkers)
  3199. (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
  3200. (if (> nl 0)
  3201. (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
  3202. (int-to-string nl) "\\}")))
  3203. ;; Make the regexp
  3204. (setq org-emph-re
  3205. (concat "\\([" pre "]\\|^\\)"
  3206. "\\("
  3207. "\\([" markers "]\\)"
  3208. "\\("
  3209. "[^" border "]\\|"
  3210. "[^" border "]"
  3211. body1
  3212. "[^" border "]"
  3213. "\\)"
  3214. "\\3\\)"
  3215. "\\([" post "]\\|$\\)"))
  3216. (setq org-verbatim-re
  3217. (concat "\\([" pre "]\\|^\\)"
  3218. "\\("
  3219. "\\([" vmarkers "]\\)"
  3220. "\\("
  3221. "[^" border "]\\|"
  3222. "[^" border "]"
  3223. body1
  3224. "[^" border "]"
  3225. "\\)"
  3226. "\\3\\)"
  3227. "\\([" post "]\\|$\\)")))))
  3228. (defcustom org-emphasis-regexp-components
  3229. '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
  3230. "Components used to build the regular expression for emphasis.
  3231. This is a list with five entries. Terminology: In an emphasis string
  3232. like \" *strong word* \", we call the initial space PREMATCH, the final
  3233. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  3234. and \"trong wor\" is the body. The different components in this variable
  3235. specify what is allowed/forbidden in each part:
  3236. pre Chars allowed as prematch. Beginning of line will be allowed too.
  3237. post Chars allowed as postmatch. End of line will be allowed too.
  3238. border The chars *forbidden* as border characters.
  3239. body-regexp A regexp like \".\" to match a body character. Don't use
  3240. non-shy groups here, and don't allow newline here.
  3241. newline The maximum number of newlines allowed in an emphasis exp.
  3242. Use customize to modify this, or restart Emacs after changing it."
  3243. :group 'org-appearance
  3244. :set 'org-set-emph-re
  3245. :type '(list
  3246. (sexp :tag "Allowed chars in pre ")
  3247. (sexp :tag "Allowed chars in post ")
  3248. (sexp :tag "Forbidden chars in border ")
  3249. (sexp :tag "Regexp for body ")
  3250. (integer :tag "number of newlines allowed")
  3251. (option (boolean :tag "Please ignore this button"))))
  3252. (defcustom org-emphasis-alist
  3253. `(("*" bold "<b>" "</b>")
  3254. ("/" italic "<i>" "</i>")
  3255. ("_" underline "<span style=\"text-decoration:underline;\">" "</span>")
  3256. ("=" org-code "<code>" "</code>" verbatim)
  3257. ("~" org-verbatim "<code>" "</code>" verbatim)
  3258. ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))
  3259. "<del>" "</del>")
  3260. )
  3261. "Special syntax for emphasized text.
  3262. Text starting and ending with a special character will be emphasized, for
  3263. example *bold*, _underlined_ and /italic/. This variable sets the marker
  3264. characters, the face to be used by font-lock for highlighting in Org-mode
  3265. Emacs buffers, and the HTML tags to be used for this.
  3266. For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
  3267. For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
  3268. Use customize to modify this, or restart Emacs after changing it."
  3269. :group 'org-appearance
  3270. :set 'org-set-emph-re
  3271. :type '(repeat
  3272. (list
  3273. (string :tag "Marker character")
  3274. (choice
  3275. (face :tag "Font-lock-face")
  3276. (plist :tag "Face property list"))
  3277. (string :tag "HTML start tag")
  3278. (string :tag "HTML end tag")
  3279. (option (const verbatim)))))
  3280. (defvar org-protecting-blocks
  3281. '("src" "example" "latex" "ascii" "html" "docbook" "ditaa" "dot" "r" "R")
  3282. "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
  3283. This is needed for font-lock setup.")
  3284. ;;; Miscellaneous options
  3285. (defgroup org-completion nil
  3286. "Completion in Org-mode."
  3287. :tag "Org Completion"
  3288. :group 'org)
  3289. (defcustom org-completion-use-ido nil
  3290. "Non-nil means use ido completion wherever possible.
  3291. Note that `ido-mode' must be active for this variable to be relevant.
  3292. If you decide to turn this variable on, you might well want to turn off
  3293. `org-outline-path-complete-in-steps'.
  3294. See also `org-completion-use-iswitchb'."
  3295. :group 'org-completion
  3296. :type 'boolean)
  3297. (defcustom org-completion-use-iswitchb nil
  3298. "Non-nil means use iswitchb completion wherever possible.
  3299. Note that `iswitchb-mode' must be active for this variable to be relevant.
  3300. If you decide to turn this variable on, you might well want to turn off
  3301. `org-outline-path-complete-in-steps'.
  3302. Note that this variable has only an effect if `org-completion-use-ido' is nil."
  3303. :group 'org-completion
  3304. :type 'boolean)
  3305. (defcustom org-completion-fallback-command 'hippie-expand
  3306. "The expansion command called by \\[pcomplete] in normal context.
  3307. Normal means, no org-mode-specific context."
  3308. :group 'org-completion
  3309. :type 'function)
  3310. ;;; Functions and variables from their packages
  3311. ;; Declared here to avoid compiler warnings
  3312. ;; XEmacs only
  3313. (defvar outline-mode-menu-heading)
  3314. (defvar outline-mode-menu-show)
  3315. (defvar outline-mode-menu-hide)
  3316. (defvar zmacs-regions) ; XEmacs regions
  3317. ;; Emacs only
  3318. (defvar mark-active)
  3319. ;; Various packages
  3320. (declare-function calendar-absolute-from-iso "cal-iso" (date))
  3321. (declare-function calendar-forward-day "cal-move" (arg))
  3322. (declare-function calendar-goto-date "cal-move" (date))
  3323. (declare-function calendar-goto-today "cal-move" ())
  3324. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  3325. (defvar calc-embedded-close-formula)
  3326. (defvar calc-embedded-open-formula)
  3327. (declare-function cdlatex-tab "ext:cdlatex" ())
  3328. (declare-function cdlatex-compute-tables "ext:cdlatex" ())
  3329. (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
  3330. (defvar font-lock-unfontify-region-function)
  3331. (declare-function iswitchb-read-buffer "iswitchb"
  3332. (prompt &optional default require-match start matches-set))
  3333. (defvar iswitchb-temp-buflist)
  3334. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  3335. (defvar org-agenda-tags-todo-honor-ignore-options)
  3336. (declare-function org-agenda-skip "org-agenda" ())
  3337. (declare-function
  3338. org-agenda-format-item "org-agenda"
  3339. (extra txt &optional category tags dotime noprefix remove-re habitp))
  3340. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  3341. (declare-function org-agenda-change-all-lines "org-agenda"
  3342. (newhead hdmarker &optional fixface just-this))
  3343. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  3344. (declare-function org-agenda-maybe-redo "org-agenda" ())
  3345. (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
  3346. (beg end))
  3347. (declare-function org-agenda-copy-local-variable "org-agenda" (var))
  3348. (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  3349. "org-agenda" (&optional end))
  3350. (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  3351. (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
  3352. (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
  3353. (declare-function org-inlinetask-goto-end "org-inlinetask" ())
  3354. (declare-function org-indent-mode "org-indent" (&optional arg))
  3355. (declare-function parse-time-string "parse-time" (string))
  3356. (declare-function org-attach-reveal "org-attach" (&optional if-exists))
  3357. (declare-function org-export-latex-fix-inputenc "org-latex" ())
  3358. (declare-function orgtbl-send-table "org-table" (&optional maybe))
  3359. (defvar remember-data-file)
  3360. (defvar texmathp-why)
  3361. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  3362. (declare-function table--at-cell-p "table" (position &optional object at-column))
  3363. (defvar w3m-current-url)
  3364. (defvar w3m-current-title)
  3365. (defvar org-latex-regexps)
  3366. ;;; Autoload and prepare some org modules
  3367. ;; Some table stuff that needs to be defined here, because it is used
  3368. ;; by the functions setting up org-mode or checking for table context.
  3369. (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
  3370. "Detect an org-type or table-type table.")
  3371. (defconst org-table-line-regexp "^[ \t]*|"
  3372. "Detect an org-type table line.")
  3373. (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
  3374. "Detect an org-type table line.")
  3375. (defconst org-table-hline-regexp "^[ \t]*|-"
  3376. "Detect an org-type table hline.")
  3377. (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
  3378. "Detect a table-type table hline.")
  3379. (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
  3380. "Detect the first line outside a table when searching from within it.
  3381. This works for both table types.")
  3382. ;; Autoload the functions in org-table.el that are needed by functions here.
  3383. (eval-and-compile
  3384. (org-autoload "org-table"
  3385. '(org-table-align org-table-begin org-table-blank-field
  3386. org-table-convert org-table-convert-region org-table-copy-down
  3387. org-table-copy-region org-table-create
  3388. org-table-create-or-convert-from-region
  3389. org-table-create-with-table.el org-table-current-dline
  3390. org-table-cut-region org-table-delete-column org-table-edit-field
  3391. org-table-edit-formulas org-table-end org-table-eval-formula
  3392. org-table-export org-table-field-info
  3393. org-table-get-stored-formulas org-table-goto-column
  3394. org-table-hline-and-move org-table-import org-table-insert-column
  3395. org-table-insert-hline org-table-insert-row org-table-iterate
  3396. org-table-justify-field-maybe org-table-kill-row
  3397. org-table-maybe-eval-formula org-table-maybe-recalculate-line
  3398. org-table-move-column org-table-move-column-left
  3399. org-table-move-column-right org-table-move-row
  3400. org-table-move-row-down org-table-move-row-up
  3401. org-table-next-field org-table-next-row org-table-paste-rectangle
  3402. org-table-previous-field org-table-recalculate
  3403. org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
  3404. org-table-toggle-coordinate-overlays
  3405. org-table-toggle-formula-debugger org-table-wrap-region
  3406. orgtbl-mode turn-on-orgtbl org-table-to-lisp
  3407. orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
  3408. orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
  3409. (defun org-at-table-p (&optional table-type)
  3410. "Return t if the cursor is inside an org-type table.
  3411. If TABLE-TYPE is non-nil, also check for table.el-type tables."
  3412. (if org-enable-table-editor
  3413. (save-excursion
  3414. (beginning-of-line 1)
  3415. (looking-at (if table-type org-table-any-line-regexp
  3416. org-table-line-regexp)))
  3417. nil))
  3418. (defsubst org-table-p () (org-at-table-p))
  3419. (defun org-at-table.el-p ()
  3420. "Return t if and only if we are at a table.el table."
  3421. (and (org-at-table-p 'any)
  3422. (save-excursion
  3423. (goto-char (org-table-begin 'any))
  3424. (looking-at org-table1-hline-regexp))))
  3425. (defun org-table-recognize-table.el ()
  3426. "If there is a table.el table nearby, recognize it and move into it."
  3427. (if org-table-tab-recognizes-table.el
  3428. (if (org-at-table.el-p)
  3429. (progn
  3430. (beginning-of-line 1)
  3431. (if (looking-at org-table-dataline-regexp)
  3432. nil
  3433. (if (looking-at org-table1-hline-regexp)
  3434. (progn
  3435. (beginning-of-line 2)
  3436. (if (looking-at org-table-any-border-regexp)
  3437. (beginning-of-line -1)))))
  3438. (if (re-search-forward "|" (org-table-end t) t)
  3439. (progn
  3440. (require 'table)
  3441. (if (table--at-cell-p (point))
  3442. t
  3443. (message "recognizing table.el table...")
  3444. (table-recognize-table)
  3445. (message "recognizing table.el table...done")))
  3446. (error "This should not happen"))
  3447. t)
  3448. nil)
  3449. nil))
  3450. (defun org-at-table-hline-p ()
  3451. "Return t if the cursor is inside a hline in a table."
  3452. (if org-enable-table-editor
  3453. (save-excursion
  3454. (beginning-of-line 1)
  3455. (looking-at org-table-hline-regexp))
  3456. nil))
  3457. (defvar org-table-clean-did-remove-column nil)
  3458. (defun org-table-map-tables (function &optional quietly)
  3459. "Apply FUNCTION to the start of all tables in the buffer."
  3460. (save-excursion
  3461. (save-restriction
  3462. (widen)
  3463. (goto-char (point-min))
  3464. (while (re-search-forward org-table-any-line-regexp nil t)
  3465. (unless quietly
  3466. (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
  3467. (beginning-of-line 1)
  3468. (when (and (looking-at org-table-line-regexp)
  3469. ;; Exclude tables in src/example/verbatim/clocktable blocks
  3470. (not (org-in-block-p '("src" "example"))))
  3471. (save-excursion (funcall function))
  3472. (or (looking-at org-table-line-regexp)
  3473. (forward-char 1)))
  3474. (re-search-forward org-table-any-border-regexp nil 1))))
  3475. (unless quietly (message "Mapping tables: done")))
  3476. ;; Declare and autoload functions from org-exp.el & Co
  3477. (declare-function org-default-export-plist "org-exp")
  3478. (declare-function org-infile-export-plist "org-exp")
  3479. (declare-function org-get-current-options "org-exp")
  3480. (eval-and-compile
  3481. (org-autoload "org-exp"
  3482. '(org-export org-export-visible
  3483. org-insert-export-options-template
  3484. org-table-clean-before-export))
  3485. (org-autoload "org-ascii"
  3486. '(org-export-as-ascii org-export-ascii-preprocess
  3487. org-export-as-ascii-to-buffer org-replace-region-by-ascii
  3488. org-export-region-as-ascii))
  3489. (org-autoload "org-latex"
  3490. '(org-export-as-latex-batch org-export-as-latex-to-buffer
  3491. org-replace-region-by-latex org-export-region-as-latex
  3492. org-export-as-latex org-export-as-pdf
  3493. org-export-as-pdf-and-open))
  3494. (org-autoload "org-html"
  3495. '(org-export-as-html-and-open
  3496. org-export-as-html-batch org-export-as-html-to-buffer
  3497. org-replace-region-by-html org-export-region-as-html
  3498. org-export-as-html))
  3499. (org-autoload "org-docbook"
  3500. '(org-export-as-docbook-batch org-export-as-docbook-to-buffer
  3501. org-replace-region-by-docbook org-export-region-as-docbook
  3502. org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
  3503. org-export-as-docbook))
  3504. (org-autoload "org-icalendar"
  3505. '(org-export-icalendar-this-file
  3506. org-export-icalendar-all-agenda-files
  3507. org-export-icalendar-combine-agenda-files))
  3508. (org-autoload "org-xoxo" '(org-export-as-xoxo))
  3509. (org-autoload "org-beamer" '(org-beamer-mode org-beamer-sectioning)))
  3510. ;; Declare and autoload functions from org-agenda.el
  3511. (eval-and-compile
  3512. (org-autoload "org-agenda"
  3513. '(org-agenda org-agenda-list org-search-view
  3514. org-todo-list org-tags-view org-agenda-list-stuck-projects
  3515. org-diary org-agenda-to-appt
  3516. org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
  3517. ;; Autoload org-remember
  3518. (eval-and-compile
  3519. (org-autoload "org-remember"
  3520. '(org-remember-insinuate org-remember-annotation
  3521. org-remember-apply-template org-remember org-remember-handler)))
  3522. (eval-and-compile
  3523. (org-autoload "org-capture"
  3524. '(org-capture org-capture-insert-template-here
  3525. org-capture-import-remember-templates)))
  3526. ;; Autoload org-clock.el
  3527. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock"
  3528. (beg end))
  3529. (declare-function org-clock-update-mode-line "org-clock" ())
  3530. (declare-function org-resolve-clocks "org-clock"
  3531. (&optional also-non-dangling-p prompt last-valid))
  3532. (defvar org-clock-start-time)
  3533. (defvar org-clock-marker (make-marker)
  3534. "Marker recording the last clock-in.")
  3535. (defvar org-clock-hd-marker (make-marker)
  3536. "Marker recording the last clock-in, but the headline position.")
  3537. (defvar org-clock-heading ""
  3538. "The heading of the current clock entry.")
  3539. (defun org-clock-is-active ()
  3540. "Return non-nil if clock is currently running.
  3541. The return value is actually the clock marker."
  3542. (marker-buffer org-clock-marker))
  3543. (eval-and-compile
  3544. (org-autoload
  3545. "org-clock"
  3546. '(org-clock-in org-clock-out org-clock-cancel
  3547. org-clock-goto org-clock-sum org-clock-display
  3548. org-clock-remove-overlays org-clock-report
  3549. org-clocktable-shift org-dblock-write:clocktable
  3550. org-get-clocktable org-resolve-clocks)))
  3551. (defun org-clock-update-time-maybe ()
  3552. "If this is a CLOCK line, update it and return t.
  3553. Otherwise, return nil."
  3554. (interactive)
  3555. (save-excursion
  3556. (beginning-of-line 1)
  3557. (skip-chars-forward " \t")
  3558. (when (looking-at org-clock-string)
  3559. (let ((re (concat "[ \t]*" org-clock-string
  3560. " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
  3561. "\\([ \t]*=>.*\\)?\\)?"))
  3562. ts te h m s neg)
  3563. (cond
  3564. ((not (looking-at re))
  3565. nil)
  3566. ((not (match-end 2))
  3567. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3568. (> org-clock-marker (point))
  3569. (<= org-clock-marker (point-at-eol)))
  3570. ;; The clock is running here
  3571. (setq org-clock-start-time
  3572. (apply 'encode-time
  3573. (org-parse-time-string (match-string 1))))
  3574. (org-clock-update-mode-line)))
  3575. (t
  3576. (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
  3577. (end-of-line 1)
  3578. (setq ts (match-string 1)
  3579. te (match-string 3))
  3580. (setq s (- (org-float-time
  3581. (apply 'encode-time (org-parse-time-string te)))
  3582. (org-float-time
  3583. (apply 'encode-time (org-parse-time-string ts))))
  3584. neg (< s 0)
  3585. s (abs s)
  3586. h (floor (/ s 3600))
  3587. s (- s (* 3600 h))
  3588. m (floor (/ s 60))
  3589. s (- s (* 60 s)))
  3590. (insert " => " (format (if neg "-%d:%02d" "%2d:%02d") h m))
  3591. t))))))
  3592. (defun org-check-running-clock ()
  3593. "Check if the current buffer contains the running clock.
  3594. If yes, offer to stop it and to save the buffer with the changes."
  3595. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3596. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  3597. (buffer-name))))
  3598. (org-clock-out)
  3599. (when (y-or-n-p "Save changed buffer?")
  3600. (save-buffer))))
  3601. (defun org-clocktable-try-shift (dir n)
  3602. "Check if this line starts a clock table, if yes, shift the time block."
  3603. (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
  3604. (org-clocktable-shift dir n)))
  3605. ;; Autoload org-timer.el
  3606. (eval-and-compile
  3607. (org-autoload
  3608. "org-timer"
  3609. '(org-timer-start org-timer org-timer-item
  3610. org-timer-change-times-in-region
  3611. org-timer-set-timer
  3612. org-timer-reset-timers
  3613. org-timer-show-remaining-time)))
  3614. ;; Autoload org-feed.el
  3615. (eval-and-compile
  3616. (org-autoload
  3617. "org-feed"
  3618. '(org-feed-update org-feed-update-all org-feed-goto-inbox)))
  3619. ;; Autoload org-indent.el
  3620. ;; Define the variable already here, to make sure we have it.
  3621. (defvar org-indent-mode nil
  3622. "Non-nil if Org-Indent mode is enabled.
  3623. Use the command `org-indent-mode' to change this variable.")
  3624. (eval-and-compile
  3625. (org-autoload
  3626. "org-indent"
  3627. '(org-indent-mode)))
  3628. ;; Autoload org-mobile.el
  3629. (eval-and-compile
  3630. (org-autoload
  3631. "org-mobile"
  3632. '(org-mobile-push org-mobile-pull org-mobile-create-sumo-agenda)))
  3633. ;; Autoload archiving code
  3634. ;; The stuff that is needed for cycling and tags has to be defined here.
  3635. (defgroup org-archive nil
  3636. "Options concerning archiving in Org-mode."
  3637. :tag "Org Archive"
  3638. :group 'org-structure)
  3639. (defcustom org-archive-location "%s_archive::"
  3640. "The location where subtrees should be archived.
  3641. The value of this variable is a string, consisting of two parts,
  3642. separated by a double-colon. The first part is a filename and
  3643. the second part is a headline.
  3644. When the filename is omitted, archiving happens in the same file.
  3645. %s in the filename will be replaced by the current file
  3646. name (without the directory part). Archiving to a different file
  3647. is useful to keep archived entries from contributing to the
  3648. Org-mode Agenda.
  3649. The archived entries will be filed as subtrees of the specified
  3650. headline. When the headline is omitted, the subtrees are simply
  3651. filed away at the end of the file, as top-level entries. Also in
  3652. the heading you can use %s to represent the file name, this can be
  3653. useful when using the same archive for a number of different files.
  3654. Here are a few examples:
  3655. \"%s_archive::\"
  3656. If the current file is Projects.org, archive in file
  3657. Projects.org_archive, as top-level trees. This is the default.
  3658. \"::* Archived Tasks\"
  3659. Archive in the current file, under the top-level headline
  3660. \"* Archived Tasks\".
  3661. \"~/org/archive.org::\"
  3662. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  3663. \"~/org/archive.org::* From %s\"
  3664. Archive in file ~/org/archive.org (absolute path), under headlines
  3665. \"From FILENAME\" where file name is the current file name.
  3666. \"~/org/datetree.org::datetree/* Finished Tasks\"
  3667. The \"datetree/\" string is special, signifying to archive
  3668. items to the datetree. Items are placed in either the CLOSED
  3669. date of the item, or the current date if there is no CLOSED date.
  3670. The heading will be a subentry to the current date. There doesn't
  3671. need to be a heading, but there always needs to be a slash after
  3672. datetree. For example, to store archived items directly in the
  3673. datetree, use \"~/org/datetree.org::datetree/\".
  3674. \"basement::** Finished Tasks\"
  3675. Archive in file ./basement (relative path), as level 3 trees
  3676. below the level 2 heading \"** Finished Tasks\".
  3677. You may set this option on a per-file basis by adding to the buffer a
  3678. line like
  3679. #+ARCHIVE: basement::** Finished Tasks
  3680. You may also define it locally for a subtree by setting an ARCHIVE property
  3681. in the entry. If such a property is found in an entry, or anywhere up
  3682. the hierarchy, it will be used."
  3683. :group 'org-archive
  3684. :type 'string)
  3685. (defcustom org-archive-tag "ARCHIVE"
  3686. "The tag that marks a subtree as archived.
  3687. An archived subtree does not open during visibility cycling, and does
  3688. not contribute to the agenda listings.
  3689. After changing this, font-lock must be restarted in the relevant buffers to
  3690. get the proper fontification."
  3691. :group 'org-archive
  3692. :group 'org-keywords
  3693. :type 'string)
  3694. (defcustom org-agenda-skip-archived-trees t
  3695. "Non-nil means the agenda will skip any items located in archived trees.
  3696. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  3697. variable is no longer recommended, you should leave it at the value t.
  3698. Instead, use the key `v' to cycle the archives-mode in the agenda."
  3699. :group 'org-archive
  3700. :group 'org-agenda-skip
  3701. :type 'boolean)
  3702. (defcustom org-columns-skip-archived-trees t
  3703. "Non-nil means ignore archived trees when creating column view."
  3704. :group 'org-archive
  3705. :group 'org-properties
  3706. :type 'boolean)
  3707. (defcustom org-cycle-open-archived-trees nil
  3708. "Non-nil means `org-cycle' will open archived trees.
  3709. An archived tree is a tree marked with the tag ARCHIVE.
  3710. When nil, archived trees will stay folded. You can still open them with
  3711. normal outline commands like `show-all', but not with the cycling commands."
  3712. :group 'org-archive
  3713. :group 'org-cycle
  3714. :type 'boolean)
  3715. (defcustom org-sparse-tree-open-archived-trees nil
  3716. "Non-nil means sparse tree construction shows matches in archived trees.
  3717. When nil, matches in these trees are highlighted, but the trees are kept in
  3718. collapsed state."
  3719. :group 'org-archive
  3720. :group 'org-sparse-trees
  3721. :type 'boolean)
  3722. (defun org-cycle-hide-archived-subtrees (state)
  3723. "Re-hide all archived subtrees after a visibility state change."
  3724. (when (and (not org-cycle-open-archived-trees)
  3725. (not (memq state '(overview folded))))
  3726. (save-excursion
  3727. (let* ((globalp (memq state '(contents all)))
  3728. (beg (if globalp (point-min) (point)))
  3729. (end (if globalp (point-max) (org-end-of-subtree t))))
  3730. (org-hide-archived-subtrees beg end)
  3731. (goto-char beg)
  3732. (if (looking-at (concat ".*:" org-archive-tag ":"))
  3733. (message "%s" (substitute-command-keys
  3734. "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
  3735. (defun org-force-cycle-archived ()
  3736. "Cycle subtree even if it is archived."
  3737. (interactive)
  3738. (setq this-command 'org-cycle)
  3739. (let ((org-cycle-open-archived-trees t))
  3740. (call-interactively 'org-cycle)))
  3741. (defun org-hide-archived-subtrees (beg end)
  3742. "Re-hide all archived subtrees after a visibility state change."
  3743. (save-excursion
  3744. (let* ((re (concat ":" org-archive-tag ":")))
  3745. (goto-char beg)
  3746. (while (re-search-forward re end t)
  3747. (when (org-at-heading-p)
  3748. (org-flag-subtree t)
  3749. (org-end-of-subtree t))))))
  3750. (defun org-flag-subtree (flag)
  3751. (save-excursion
  3752. (org-back-to-heading t)
  3753. (outline-end-of-heading)
  3754. (outline-flag-region (point)
  3755. (progn (org-end-of-subtree t) (point))
  3756. flag)))
  3757. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  3758. (eval-and-compile
  3759. (org-autoload "org-archive"
  3760. '(org-add-archive-files org-archive-subtree
  3761. org-archive-to-archive-sibling org-toggle-archive-tag
  3762. org-archive-subtree-default
  3763. org-archive-subtree-default-with-confirmation)))
  3764. ;; Autoload Column View Code
  3765. (declare-function org-columns-number-to-string "org-colview")
  3766. (declare-function org-columns-get-format-and-top-level "org-colview")
  3767. (declare-function org-columns-compute "org-colview")
  3768. (org-autoload (if (featurep 'xemacs) "org-colview-xemacs" "org-colview")
  3769. '(org-columns-number-to-string org-columns-get-format-and-top-level
  3770. org-columns-compute org-agenda-columns org-columns-remove-overlays
  3771. org-columns org-insert-columns-dblock org-dblock-write:columnview))
  3772. ;; Autoload ID code
  3773. (declare-function org-id-store-link "org-id")
  3774. (declare-function org-id-locations-load "org-id")
  3775. (declare-function org-id-locations-save "org-id")
  3776. (defvar org-id-track-globally)
  3777. (org-autoload "org-id"
  3778. '(org-id-get-create org-id-new org-id-copy org-id-get
  3779. org-id-get-with-outline-path-completion
  3780. org-id-get-with-outline-drilling org-id-store-link
  3781. org-id-goto org-id-find org-id-store-link))
  3782. ;; Autoload Plotting Code
  3783. (org-autoload "org-plot"
  3784. '(org-plot/gnuplot))
  3785. ;;; Variables for pre-computed regular expressions, all buffer local
  3786. (defvar org-drawer-regexp nil
  3787. "Matches first line of a hidden block.")
  3788. (make-variable-buffer-local 'org-drawer-regexp)
  3789. (defvar org-todo-regexp nil
  3790. "Matches any of the TODO state keywords.")
  3791. (make-variable-buffer-local 'org-todo-regexp)
  3792. (defvar org-not-done-regexp nil
  3793. "Matches any of the TODO state keywords except the last one.")
  3794. (make-variable-buffer-local 'org-not-done-regexp)
  3795. (defvar org-not-done-heading-regexp nil
  3796. "Matches a TODO headline that is not done.")
  3797. (make-variable-buffer-local 'org-not-done-regexp)
  3798. (defvar org-todo-line-regexp nil
  3799. "Matches a headline and puts TODO state into group 2 if present.")
  3800. (make-variable-buffer-local 'org-todo-line-regexp)
  3801. (defvar org-complex-heading-regexp nil
  3802. "Matches a headline and puts everything into groups:
  3803. group 1: the stars
  3804. group 2: The todo keyword, maybe
  3805. group 3: Priority cookie
  3806. group 4: True headline
  3807. group 5: Tags")
  3808. (make-variable-buffer-local 'org-complex-heading-regexp)
  3809. (defvar org-complex-heading-regexp-format nil
  3810. "Printf format to make regexp to match an exact headline.
  3811. This regexp will match the headline of any node which has the
  3812. exact headline text that is put into the format, but may have any
  3813. TODO state, priority and tags.")
  3814. (make-variable-buffer-local 'org-complex-heading-regexp-format)
  3815. (defvar org-todo-line-tags-regexp nil
  3816. "Matches a headline and puts TODO state into group 2 if present.
  3817. Also put tags into group 4 if tags are present.")
  3818. (make-variable-buffer-local 'org-todo-line-tags-regexp)
  3819. (defvar org-ds-keyword-length 12
  3820. "Maximum length of the Deadline and SCHEDULED keywords.")
  3821. (make-variable-buffer-local 'org-ds-keyword-length)
  3822. (defvar org-deadline-regexp nil
  3823. "Matches the DEADLINE keyword.")
  3824. (make-variable-buffer-local 'org-deadline-regexp)
  3825. (defvar org-deadline-time-regexp nil
  3826. "Matches the DEADLINE keyword together with a time stamp.")
  3827. (make-variable-buffer-local 'org-deadline-time-regexp)
  3828. (defvar org-deadline-line-regexp nil
  3829. "Matches the DEADLINE keyword and the rest of the line.")
  3830. (make-variable-buffer-local 'org-deadline-line-regexp)
  3831. (defvar org-scheduled-regexp nil
  3832. "Matches the SCHEDULED keyword.")
  3833. (make-variable-buffer-local 'org-scheduled-regexp)
  3834. (defvar org-scheduled-time-regexp nil
  3835. "Matches the SCHEDULED keyword together with a time stamp.")
  3836. (make-variable-buffer-local 'org-scheduled-time-regexp)
  3837. (defvar org-closed-time-regexp nil
  3838. "Matches the CLOSED keyword together with a time stamp.")
  3839. (make-variable-buffer-local 'org-closed-time-regexp)
  3840. (defvar org-keyword-time-regexp nil
  3841. "Matches any of the 4 keywords, together with the time stamp.")
  3842. (make-variable-buffer-local 'org-keyword-time-regexp)
  3843. (defvar org-keyword-time-not-clock-regexp nil
  3844. "Matches any of the 3 keywords, together with the time stamp.")
  3845. (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
  3846. (defvar org-maybe-keyword-time-regexp nil
  3847. "Matches a timestamp, possibly preceded by a keyword.")
  3848. (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
  3849. (defvar org-planning-or-clock-line-re nil
  3850. "Matches a line with planning or clock info.")
  3851. (make-variable-buffer-local 'org-planning-or-clock-line-re)
  3852. (defvar org-all-time-keywords nil
  3853. "List of time keywords.")
  3854. (make-variable-buffer-local 'org-all-time-keywords)
  3855. (defconst org-plain-time-of-day-regexp
  3856. (concat
  3857. "\\(\\<[012]?[0-9]"
  3858. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3859. "\\(--?"
  3860. "\\(\\<[012]?[0-9]"
  3861. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3862. "\\)?")
  3863. "Regular expression to match a plain time or time range.
  3864. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3865. groups carry important information:
  3866. 0 the full match
  3867. 1 the first time, range or not
  3868. 8 the second time, if it is a range.")
  3869. (defconst org-plain-time-extension-regexp
  3870. (concat
  3871. "\\(\\<[012]?[0-9]"
  3872. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3873. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  3874. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  3875. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3876. groups carry important information:
  3877. 0 the full match
  3878. 7 hours of duration
  3879. 9 minutes of duration")
  3880. (defconst org-stamp-time-of-day-regexp
  3881. (concat
  3882. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  3883. "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
  3884. "\\(--?"
  3885. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  3886. "Regular expression to match a timestamp time or time range.
  3887. After a match, the following groups carry important information:
  3888. 0 the full match
  3889. 1 date plus weekday, for back referencing to make sure both times are on the same day
  3890. 2 the first time, range or not
  3891. 4 the second time, if it is a range.")
  3892. (defconst org-startup-options
  3893. '(("fold" org-startup-folded t)
  3894. ("overview" org-startup-folded t)
  3895. ("nofold" org-startup-folded nil)
  3896. ("showall" org-startup-folded nil)
  3897. ("showeverything" org-startup-folded showeverything)
  3898. ("content" org-startup-folded content)
  3899. ("indent" org-startup-indented t)
  3900. ("noindent" org-startup-indented nil)
  3901. ("hidestars" org-hide-leading-stars t)
  3902. ("showstars" org-hide-leading-stars nil)
  3903. ("odd" org-odd-levels-only t)
  3904. ("oddeven" org-odd-levels-only nil)
  3905. ("align" org-startup-align-all-tables t)
  3906. ("noalign" org-startup-align-all-tables nil)
  3907. ("inlineimages" org-startup-with-inline-images t)
  3908. ("noinlineimages" org-startup-with-inline-images nil)
  3909. ("customtime" org-display-custom-times t)
  3910. ("logdone" org-log-done time)
  3911. ("lognotedone" org-log-done note)
  3912. ("nologdone" org-log-done nil)
  3913. ("lognoteclock-out" org-log-note-clock-out t)
  3914. ("nolognoteclock-out" org-log-note-clock-out nil)
  3915. ("logrepeat" org-log-repeat state)
  3916. ("lognoterepeat" org-log-repeat note)
  3917. ("nologrepeat" org-log-repeat nil)
  3918. ("logreschedule" org-log-reschedule time)
  3919. ("lognotereschedule" org-log-reschedule note)
  3920. ("nologreschedule" org-log-reschedule nil)
  3921. ("logredeadline" org-log-redeadline time)
  3922. ("lognoteredeadline" org-log-redeadline note)
  3923. ("nologredeadline" org-log-redeadline nil)
  3924. ("logrefile" org-log-refile time)
  3925. ("lognoterefile" org-log-refile note)
  3926. ("nologrefile" org-log-refile nil)
  3927. ("fninline" org-footnote-define-inline t)
  3928. ("nofninline" org-footnote-define-inline nil)
  3929. ("fnlocal" org-footnote-section nil)
  3930. ("fnauto" org-footnote-auto-label t)
  3931. ("fnprompt" org-footnote-auto-label nil)
  3932. ("fnconfirm" org-footnote-auto-label confirm)
  3933. ("fnplain" org-footnote-auto-label plain)
  3934. ("fnadjust" org-footnote-auto-adjust t)
  3935. ("nofnadjust" org-footnote-auto-adjust nil)
  3936. ("constcgs" constants-unit-system cgs)
  3937. ("constSI" constants-unit-system SI)
  3938. ("noptag" org-tag-persistent-alist nil)
  3939. ("hideblocks" org-hide-block-startup t)
  3940. ("nohideblocks" org-hide-block-startup nil)
  3941. ("beamer" org-startup-with-beamer-mode t)
  3942. ("entitiespretty" org-pretty-entities t)
  3943. ("entitiesplain" org-pretty-entities nil))
  3944. "Variable associated with STARTUP options for org-mode.
  3945. Each element is a list of three items: the startup options (as written
  3946. in the #+STARTUP line), the corresponding variable, and the value to set
  3947. this variable to if the option is found. An optional forth element PUSH
  3948. means to push this value onto the list in the variable.")
  3949. (defun org-update-property-plist (key val props)
  3950. "Update PROPS with KEY and VAL."
  3951. (let* ((appending (string= "+" (substring key (- (length key) 1))))
  3952. (key (if appending (substring key 0 (- (length key) 1)) key))
  3953. (remainder (org-remove-if (lambda (p) (string= (car p) key)) props))
  3954. (previous (cdr (assoc key props))))
  3955. (if appending
  3956. (cons (cons key (if previous (concat previous " " val) val)) remainder)
  3957. (cons (cons key val) remainder))))
  3958. (defconst org-block-regexp
  3959. "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
  3960. "Regular expression for hiding blocks.")
  3961. (defconst org-heading-keyword-regexp-format
  3962. "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  3963. "Printf format for a regexp matching an headline with some keyword.
  3964. This regexp will match the headline of any node which has the
  3965. exact keyword that is put into the format. The keyword isn't in
  3966. any group by default, but the stars and the body are.")
  3967. (defconst org-heading-keyword-maybe-regexp-format
  3968. "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
  3969. "Printf format for a regexp matching an headline, possibly with some keyword.
  3970. This regexp can match any headline with the specified keyword, or
  3971. without a keyword. The keyword isn't in any group by default,
  3972. but the stars and the body are.")
  3973. (defun org-set-regexps-and-options ()
  3974. "Precompute regular expressions for current buffer."
  3975. (when (derived-mode-p 'org-mode)
  3976. (org-set-local 'org-todo-kwd-alist nil)
  3977. (org-set-local 'org-todo-key-alist nil)
  3978. (org-set-local 'org-todo-key-trigger nil)
  3979. (org-set-local 'org-todo-keywords-1 nil)
  3980. (org-set-local 'org-done-keywords nil)
  3981. (org-set-local 'org-todo-heads nil)
  3982. (org-set-local 'org-todo-sets nil)
  3983. (org-set-local 'org-todo-log-states nil)
  3984. (org-set-local 'org-file-properties nil)
  3985. (org-set-local 'org-file-tags nil)
  3986. (let ((re (org-make-options-regexp
  3987. '("CATEGORY" "TODO" "COLUMNS"
  3988. "STARTUP" "ARCHIVE" "FILETAGS" "TAGS" "LINK" "PRIORITIES"
  3989. "CONSTANTS" "PROPERTY" "DRAWERS" "SETUPFILE" "LATEX_CLASS"
  3990. "OPTIONS")
  3991. "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
  3992. (splitre "[ \t]+")
  3993. (scripts org-use-sub-superscripts)
  3994. kwds kws0 kwsa key log value cat arch tags const links hw dws
  3995. tail sep kws1 prio props ftags drawers beamer-p
  3996. ext-setup-or-nil setup-contents (start 0))
  3997. (save-excursion
  3998. (save-restriction
  3999. (widen)
  4000. (goto-char (point-min))
  4001. (while (or (and ext-setup-or-nil
  4002. (string-match re ext-setup-or-nil start)
  4003. (setq start (match-end 0)))
  4004. (and (setq ext-setup-or-nil nil start 0)
  4005. (re-search-forward re nil t)))
  4006. (setq key (upcase (match-string 1 ext-setup-or-nil))
  4007. value (org-match-string-no-properties 2 ext-setup-or-nil))
  4008. (if (stringp value) (setq value (org-trim value)))
  4009. (cond
  4010. ((equal key "CATEGORY")
  4011. (setq cat value))
  4012. ((member key '("SEQ_TODO" "TODO"))
  4013. (push (cons 'sequence (org-split-string value splitre)) kwds))
  4014. ((equal key "TYP_TODO")
  4015. (push (cons 'type (org-split-string value splitre)) kwds))
  4016. ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
  4017. ;; general TODO-like setup
  4018. (push (cons (intern (downcase (match-string 1 key)))
  4019. (org-split-string value splitre)) kwds))
  4020. ((equal key "TAGS")
  4021. (setq tags (append tags (if tags '("\\n") nil)
  4022. (org-split-string value splitre))))
  4023. ((equal key "COLUMNS")
  4024. (org-set-local 'org-columns-default-format value))
  4025. ((equal key "LINK")
  4026. (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  4027. (push (cons (match-string 1 value)
  4028. (org-trim (match-string 2 value)))
  4029. links)))
  4030. ((equal key "PRIORITIES")
  4031. (setq prio (org-split-string value " +")))
  4032. ((equal key "PROPERTY")
  4033. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  4034. (setq props (org-update-property-plist (match-string 1 value)
  4035. (match-string 2 value)
  4036. props))))
  4037. ((equal key "FILETAGS")
  4038. (when (string-match "\\S-" value)
  4039. (setq ftags
  4040. (append
  4041. ftags
  4042. (apply 'append
  4043. (mapcar (lambda (x) (org-split-string x ":"))
  4044. (org-split-string value)))))))
  4045. ((equal key "DRAWERS")
  4046. (setq drawers (delete-dups (append org-drawers (org-split-string value splitre)))))
  4047. ((equal key "CONSTANTS")
  4048. (setq const (append const (org-split-string value splitre))))
  4049. ((equal key "STARTUP")
  4050. (let ((opts (org-split-string value splitre))
  4051. l var val)
  4052. (while (setq l (pop opts))
  4053. (when (setq l (assoc l org-startup-options))
  4054. (setq var (nth 1 l) val (nth 2 l))
  4055. (if (not (nth 3 l))
  4056. (set (make-local-variable var) val)
  4057. (if (not (listp (symbol-value var)))
  4058. (set (make-local-variable var) nil))
  4059. (set (make-local-variable var) (symbol-value var))
  4060. (add-to-list var val))))))
  4061. ((equal key "ARCHIVE")
  4062. (setq arch value)
  4063. (remove-text-properties 0 (length arch)
  4064. '(face t fontified t) arch))
  4065. ((equal key "LATEX_CLASS")
  4066. (setq beamer-p (equal value "beamer")))
  4067. ((equal key "OPTIONS")
  4068. (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value)
  4069. (setq scripts (read (match-string 2 value)))))
  4070. ((equal key "SETUPFILE")
  4071. (setq setup-contents (org-file-contents
  4072. (expand-file-name
  4073. (org-remove-double-quotes value))
  4074. 'noerror))
  4075. (if (not ext-setup-or-nil)
  4076. (setq ext-setup-or-nil setup-contents start 0)
  4077. (setq ext-setup-or-nil
  4078. (concat (substring ext-setup-or-nil 0 start)
  4079. "\n" setup-contents "\n"
  4080. (substring ext-setup-or-nil start)))))))
  4081. ;; search for property blocks
  4082. (goto-char (point-min))
  4083. (while (re-search-forward org-block-regexp nil t)
  4084. (when (equal "PROPERTY" (upcase (match-string 1)))
  4085. (setq value (replace-regexp-in-string
  4086. "[\n\r]" " " (match-string 4)))
  4087. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  4088. (setq props (org-update-property-plist (match-string 1 value)
  4089. (match-string 2 value)
  4090. props)))))))
  4091. (org-set-local 'org-use-sub-superscripts scripts)
  4092. (when cat
  4093. (org-set-local 'org-category (intern cat))
  4094. (push (cons "CATEGORY" cat) props))
  4095. (when prio
  4096. (if (< (length prio) 3) (setq prio '("A" "C" "B")))
  4097. (setq prio (mapcar 'string-to-char prio))
  4098. (org-set-local 'org-highest-priority (nth 0 prio))
  4099. (org-set-local 'org-lowest-priority (nth 1 prio))
  4100. (org-set-local 'org-default-priority (nth 2 prio)))
  4101. (and props (org-set-local 'org-file-properties (nreverse props)))
  4102. (and ftags (org-set-local 'org-file-tags
  4103. (mapcar 'org-add-prop-inherited ftags)))
  4104. (and drawers (org-set-local 'org-drawers drawers))
  4105. (and arch (org-set-local 'org-archive-location arch))
  4106. (and links (setq org-link-abbrev-alist-local (nreverse links)))
  4107. ;; Process the TODO keywords
  4108. (unless kwds
  4109. ;; Use the global values as if they had been given locally.
  4110. (setq kwds (default-value 'org-todo-keywords))
  4111. (if (stringp (car kwds))
  4112. (setq kwds (list (cons org-todo-interpretation
  4113. (default-value 'org-todo-keywords)))))
  4114. (setq kwds (reverse kwds)))
  4115. (setq kwds (nreverse kwds))
  4116. (let (inter kws kw)
  4117. (while (setq kws (pop kwds))
  4118. (let ((kws (or
  4119. (run-hook-with-args-until-success
  4120. 'org-todo-setup-filter-hook kws)
  4121. kws)))
  4122. (setq inter (pop kws) sep (member "|" kws)
  4123. kws0 (delete "|" (copy-sequence kws))
  4124. kwsa nil
  4125. kws1 (mapcar
  4126. (lambda (x)
  4127. ;; 1 2
  4128. (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
  4129. (progn
  4130. (setq kw (match-string 1 x)
  4131. key (and (match-end 2) (match-string 2 x))
  4132. log (org-extract-log-state-settings x))
  4133. (push (cons kw (and key (string-to-char key))) kwsa)
  4134. (and log (push log org-todo-log-states))
  4135. kw)
  4136. (error "Invalid TODO keyword %s" x)))
  4137. kws0)
  4138. kwsa (if kwsa (append '((:startgroup))
  4139. (nreverse kwsa)
  4140. '((:endgroup))))
  4141. hw (car kws1)
  4142. dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
  4143. tail (list inter hw (car dws) (org-last dws))))
  4144. (add-to-list 'org-todo-heads hw 'append)
  4145. (push kws1 org-todo-sets)
  4146. (setq org-done-keywords (append org-done-keywords dws nil))
  4147. (setq org-todo-key-alist (append org-todo-key-alist kwsa))
  4148. (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
  4149. (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
  4150. (setq org-todo-sets (nreverse org-todo-sets)
  4151. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  4152. org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
  4153. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
  4154. ;; Process the constants
  4155. (when const
  4156. (let (e cst)
  4157. (while (setq e (pop const))
  4158. (if (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)" e)
  4159. (push (cons (match-string 1 e) (match-string 2 e)) cst)))
  4160. (setq org-table-formula-constants-local cst)))
  4161. ;; Process the tags.
  4162. (when tags
  4163. (let (e tgs)
  4164. (while (setq e (pop tags))
  4165. (cond
  4166. ((equal e "{") (push '(:startgroup) tgs))
  4167. ((equal e "}") (push '(:endgroup) tgs))
  4168. ((equal e "\\n") (push '(:newline) tgs))
  4169. ((string-match (org-re "^\\([[:alnum:]_@#%]+\\)(\\(.\\))$") e)
  4170. (push (cons (match-string 1 e)
  4171. (string-to-char (match-string 2 e)))
  4172. tgs))
  4173. (t (push (list e) tgs))))
  4174. (org-set-local 'org-tag-alist nil)
  4175. (while (setq e (pop tgs))
  4176. (or (and (stringp (car e))
  4177. (assoc (car e) org-tag-alist))
  4178. (push e org-tag-alist)))))
  4179. ;; Compute the regular expressions and other local variables.
  4180. ;; Using `org-outline-regexp-bol' would complicate them much,
  4181. ;; because of the fixed white space at the end of that string.
  4182. (if (not org-done-keywords)
  4183. (setq org-done-keywords (and org-todo-keywords-1
  4184. (list (org-last org-todo-keywords-1)))))
  4185. (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
  4186. (length org-scheduled-string)
  4187. (length org-clock-string)
  4188. (length org-closed-string)))
  4189. org-drawer-regexp
  4190. (concat "^[ \t]*:\\("
  4191. (mapconcat 'regexp-quote org-drawers "\\|")
  4192. "\\):[ \t]*$")
  4193. org-not-done-keywords
  4194. (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
  4195. org-todo-regexp
  4196. (concat "\\("
  4197. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  4198. "\\)")
  4199. org-not-done-regexp
  4200. (concat "\\("
  4201. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  4202. "\\)")
  4203. org-not-done-heading-regexp
  4204. (format org-heading-keyword-regexp-format org-not-done-regexp)
  4205. org-todo-line-regexp
  4206. (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
  4207. org-complex-heading-regexp
  4208. (concat "^\\(\\*+\\)"
  4209. "\\(?: +" org-todo-regexp "\\)?"
  4210. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4211. "\\(?: +\\(.*?\\)\\)?"
  4212. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
  4213. "[ \t]*$")
  4214. org-complex-heading-regexp-format
  4215. (concat "^\\(\\*+\\)"
  4216. "\\(?: +" org-todo-regexp "\\)?"
  4217. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4218. "\\(?: +"
  4219. ;; Stats cookies can be stuck to body.
  4220. "\\(?:\\[[0-9%%/]+\\] *\\)?"
  4221. "\\(%s\\)"
  4222. "\\(?: *\\[[0-9%%/]+\\]\\)?"
  4223. "\\)"
  4224. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
  4225. "[ \t]*$")
  4226. org-todo-line-tags-regexp
  4227. (concat "^\\(\\*+\\)"
  4228. "\\(?: +" org-todo-regexp "\\)?"
  4229. "\\(?: +\\(.*?\\)\\)?"
  4230. (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
  4231. "[ \t]*$")
  4232. org-deadline-regexp (concat "\\<" org-deadline-string)
  4233. org-deadline-time-regexp
  4234. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  4235. org-deadline-line-regexp
  4236. (concat "\\<\\(" org-deadline-string "\\).*")
  4237. org-scheduled-regexp
  4238. (concat "\\<" org-scheduled-string)
  4239. org-scheduled-time-regexp
  4240. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  4241. org-closed-time-regexp
  4242. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  4243. org-keyword-time-regexp
  4244. (concat "\\<\\(" org-scheduled-string
  4245. "\\|" org-deadline-string
  4246. "\\|" org-closed-string
  4247. "\\|" org-clock-string "\\)"
  4248. " *[[<]\\([^]>]+\\)[]>]")
  4249. org-keyword-time-not-clock-regexp
  4250. (concat "\\<\\(" org-scheduled-string
  4251. "\\|" org-deadline-string
  4252. "\\|" org-closed-string
  4253. "\\)"
  4254. " *[[<]\\([^]>]+\\)[]>]")
  4255. org-maybe-keyword-time-regexp
  4256. (concat "\\(\\<\\(" org-scheduled-string
  4257. "\\|" org-deadline-string
  4258. "\\|" org-closed-string
  4259. "\\|" org-clock-string "\\)\\)?"
  4260. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
  4261. org-planning-or-clock-line-re
  4262. (concat "^[ \t]*\\("
  4263. org-scheduled-string "\\|"
  4264. org-deadline-string "\\|"
  4265. org-closed-string "\\|"
  4266. org-clock-string "\\)")
  4267. org-all-time-keywords
  4268. (mapcar (lambda (w) (substring w 0 -1))
  4269. (list org-scheduled-string org-deadline-string
  4270. org-clock-string org-closed-string))
  4271. )
  4272. (org-compute-latex-and-specials-regexp)
  4273. (org-set-font-lock-defaults))))
  4274. (defun org-file-contents (file &optional noerror)
  4275. "Return the contents of FILE, as a string."
  4276. (if (or (not file)
  4277. (not (file-readable-p file)))
  4278. (if noerror
  4279. (progn
  4280. (message "Cannot read file \"%s\"" file)
  4281. (ding) (sit-for 2)
  4282. "")
  4283. (error "Cannot read file \"%s\"" file))
  4284. (with-temp-buffer
  4285. (insert-file-contents file)
  4286. (buffer-string))))
  4287. (defun org-extract-log-state-settings (x)
  4288. "Extract the log state setting from a TODO keyword string.
  4289. This will extract info from a string like \"WAIT(w@/!)\"."
  4290. (let (kw key log1 log2)
  4291. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  4292. (setq kw (match-string 1 x)
  4293. key (and (match-end 2) (match-string 2 x))
  4294. log1 (and (match-end 3) (match-string 3 x))
  4295. log2 (and (match-end 4) (match-string 4 x)))
  4296. (and (or log1 log2)
  4297. (list kw
  4298. (and log1 (if (equal log1 "!") 'time 'note))
  4299. (and log2 (if (equal log2 "!") 'time 'note)))))))
  4300. (defun org-remove-keyword-keys (list)
  4301. "Remove a pair of parenthesis at the end of each string in LIST."
  4302. (mapcar (lambda (x)
  4303. (if (string-match "(.*)$" x)
  4304. (substring x 0 (match-beginning 0))
  4305. x))
  4306. list))
  4307. (defun org-assign-fast-keys (alist)
  4308. "Assign fast keys to a keyword-key alist.
  4309. Respect keys that are already there."
  4310. (let (new e (alt ?0))
  4311. (while (setq e (pop alist))
  4312. (if (or (memq (car e) '(:newline :endgroup :startgroup))
  4313. (cdr e)) ;; Key already assigned.
  4314. (push e new)
  4315. (let ((clist (string-to-list (downcase (car e))))
  4316. (used (append new alist)))
  4317. (when (= (car clist) ?@)
  4318. (pop clist))
  4319. (while (and clist (rassoc (car clist) used))
  4320. (pop clist))
  4321. (unless clist
  4322. (while (rassoc alt used)
  4323. (incf alt)))
  4324. (push (cons (car e) (or (car clist) alt)) new))))
  4325. (nreverse new)))
  4326. ;;; Some variables used in various places
  4327. (defvar org-window-configuration nil
  4328. "Used in various places to store a window configuration.")
  4329. (defvar org-selected-window nil
  4330. "Used in various places to store a window configuration.")
  4331. (defvar org-finish-function nil
  4332. "Function to be called when `C-c C-c' is used.
  4333. This is for getting out of special buffers like remember.")
  4334. ;; FIXME: Occasionally check by commenting these, to make sure
  4335. ;; no other functions uses these, forgetting to let-bind them.
  4336. (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  4337. (defvar org-last-state)
  4338. (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  4339. ;; Defined somewhere in this file, but used before definition.
  4340. (defvar org-entities) ;; defined in org-entities.el
  4341. (defvar org-struct-menu)
  4342. (defvar org-org-menu)
  4343. (defvar org-tbl-menu)
  4344. ;;;; Define the Org-mode
  4345. (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
  4346. (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or upgrade to newer allout, for example by switching to Emacs 22"))
  4347. ;; We use a before-change function to check if a table might need
  4348. ;; an update.
  4349. (defvar org-table-may-need-update t
  4350. "Indicates that a table might need an update.
  4351. This variable is set by `org-before-change-function'.
  4352. `org-table-align' sets it back to nil.")
  4353. (defun org-before-change-function (beg end)
  4354. "Every change indicates that a table might need an update."
  4355. (setq org-table-may-need-update t))
  4356. (defvar org-mode-map)
  4357. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  4358. (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
  4359. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  4360. (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
  4361. (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
  4362. (defvar org-table-buffer-is-an nil)
  4363. ;; `org-outline-regexp' ought to be a defconst but is let-binding in
  4364. ;; some places -- e.g. see the macro org-with-limited-levels.
  4365. ;;
  4366. ;; In Org buffers, the value of `outline-regexp' is that of
  4367. ;; `org-outline-regexp'. The only function still directly relying on
  4368. ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
  4369. ;; job when `orgstruct-mode' is active.
  4370. (defvar org-outline-regexp "\\*+ "
  4371. "Regexp to match Org headlines.")
  4372. (defconst org-outline-regexp-bol "^\\*+ "
  4373. "Regexp to match Org headlines.
  4374. This is similar to `org-outline-regexp' but additionally makes
  4375. sure that we are at the beginning of the line.")
  4376. (defconst org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  4377. "Matches an headline, putting stars and text into groups.
  4378. Stars are put in group 1 and the trimmed body in group 2.")
  4379. (defvar bidi-paragraph-direction)
  4380. (defvar buffer-face-mode-face)
  4381. ;;;###autoload
  4382. (define-derived-mode org-mode outline-mode "Org"
  4383. "Outline-based notes management and organizer, alias
  4384. \"Carsten's outline-mode for keeping track of everything.\"
  4385. Org-mode develops organizational tasks around a NOTES file which
  4386. contains information about projects as plain text. Org-mode is
  4387. implemented on top of outline-mode, which is ideal to keep the content
  4388. of large files well structured. It supports ToDo items, deadlines and
  4389. time stamps, which magically appear in the diary listing of the Emacs
  4390. calendar. Tables are easily created with a built-in table editor.
  4391. Plain text URL-like links connect to websites, emails (VM), Usenet
  4392. messages (Gnus), BBDB entries, and any files related to the project.
  4393. For printing and sharing of notes, an Org-mode file (or a part of it)
  4394. can be exported as a structured ASCII or HTML file.
  4395. The following commands are available:
  4396. \\{org-mode-map}"
  4397. ;; Get rid of Outline menus, they are not needed
  4398. ;; Need to do this here because define-derived-mode sets up
  4399. ;; the keymap so late. Still, it is a waste to call this each time
  4400. ;; we switch another buffer into org-mode.
  4401. (if (featurep 'xemacs)
  4402. (when (boundp 'outline-mode-menu-heading)
  4403. ;; Assume this is Greg's port, it uses easymenu
  4404. (easy-menu-remove outline-mode-menu-heading)
  4405. (easy-menu-remove outline-mode-menu-show)
  4406. (easy-menu-remove outline-mode-menu-hide))
  4407. (define-key org-mode-map [menu-bar headings] 'undefined)
  4408. (define-key org-mode-map [menu-bar hide] 'undefined)
  4409. (define-key org-mode-map [menu-bar show] 'undefined))
  4410. (org-load-modules-maybe)
  4411. (easy-menu-add org-org-menu)
  4412. (easy-menu-add org-tbl-menu)
  4413. (org-install-agenda-files-menu)
  4414. (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
  4415. (add-to-invisibility-spec '(org-cwidth))
  4416. (add-to-invisibility-spec '(org-hide-block . t))
  4417. (when (featurep 'xemacs)
  4418. (org-set-local 'line-move-ignore-invisible t))
  4419. (org-set-local 'outline-regexp org-outline-regexp)
  4420. (org-set-local 'outline-level 'org-outline-level)
  4421. (setq bidi-paragraph-direction 'left-to-right)
  4422. (when (and org-ellipsis
  4423. (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
  4424. (fboundp 'make-glyph-code))
  4425. (unless org-display-table
  4426. (setq org-display-table (make-display-table)))
  4427. (set-display-table-slot
  4428. org-display-table 4
  4429. (vconcat (mapcar
  4430. (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
  4431. org-ellipsis)))
  4432. (if (stringp org-ellipsis) org-ellipsis "..."))))
  4433. (setq buffer-display-table org-display-table))
  4434. (org-set-regexps-and-options)
  4435. (when (and org-tag-faces (not org-tags-special-faces-re))
  4436. ;; tag faces set outside customize.... force initialization.
  4437. (org-set-tag-faces 'org-tag-faces org-tag-faces))
  4438. ;; Calc embedded
  4439. (org-set-local 'calc-embedded-open-mode "# ")
  4440. (modify-syntax-entry ?@ "w")
  4441. (if org-startup-truncated (setq truncate-lines t))
  4442. (org-set-local 'font-lock-unfontify-region-function
  4443. 'org-unfontify-region)
  4444. ;; Activate before-change-function
  4445. (org-set-local 'org-table-may-need-update t)
  4446. (org-add-hook 'before-change-functions 'org-before-change-function nil
  4447. 'local)
  4448. ;; Check for running clock before killing a buffer
  4449. (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  4450. ;; Paragraphs and auto-filling
  4451. (org-set-autofill-regexps)
  4452. (org-set-local 'indent-line-function 'org-indent-line)
  4453. (org-set-local 'indent-region-function 'org-indent-region)
  4454. (org-update-radio-target-regexp)
  4455. ;; Beginning/end of defun
  4456. (org-set-local 'beginning-of-defun-function 'org-beginning-of-defun)
  4457. (org-set-local 'end-of-defun-function 'org-end-of-defun)
  4458. ;; Next error for sparse trees
  4459. (org-set-local 'next-error-function 'org-occur-next-match)
  4460. ;; Make sure dependence stuff works reliably, even for users who set it
  4461. ;; too late :-(
  4462. (if org-enforce-todo-dependencies
  4463. (add-hook 'org-blocker-hook
  4464. 'org-block-todo-from-children-or-siblings-or-parent)
  4465. (remove-hook 'org-blocker-hook
  4466. 'org-block-todo-from-children-or-siblings-or-parent))
  4467. (if org-enforce-todo-checkbox-dependencies
  4468. (add-hook 'org-blocker-hook
  4469. 'org-block-todo-from-checkboxes)
  4470. (remove-hook 'org-blocker-hook
  4471. 'org-block-todo-from-checkboxes))
  4472. ;; Comment characters
  4473. (org-set-local 'comment-start "#")
  4474. (org-set-local 'comment-padding " ")
  4475. ;; Align options lines
  4476. (org-set-local
  4477. 'align-mode-rules-list
  4478. '((org-in-buffer-settings
  4479. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  4480. (modes . '(org-mode)))))
  4481. ;; Imenu
  4482. (org-set-local 'imenu-create-index-function
  4483. 'org-imenu-get-tree)
  4484. ;; Make isearch reveal context
  4485. (if (or (featurep 'xemacs)
  4486. (not (boundp 'outline-isearch-open-invisible-function)))
  4487. ;; Emacs 21 and XEmacs make use of the hook
  4488. (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
  4489. ;; Emacs 22 deals with this through a special variable
  4490. (org-set-local 'outline-isearch-open-invisible-function
  4491. (lambda (&rest ignore) (org-show-context 'isearch))))
  4492. ;; Turn on org-beamer-mode?
  4493. (and org-startup-with-beamer-mode (org-beamer-mode 1))
  4494. ;; Setup the pcomplete hooks
  4495. (set (make-local-variable 'pcomplete-command-completion-function)
  4496. 'org-pcomplete-initial)
  4497. (set (make-local-variable 'pcomplete-command-name-function)
  4498. 'org-command-at-point)
  4499. (set (make-local-variable 'pcomplete-default-completion-function)
  4500. 'ignore)
  4501. (set (make-local-variable 'pcomplete-parse-arguments-function)
  4502. 'org-parse-arguments)
  4503. (set (make-local-variable 'pcomplete-termination-string) "")
  4504. (when (>= emacs-major-version 23)
  4505. (set (make-local-variable 'buffer-face-mode-face) 'org-default))
  4506. ;; If empty file that did not turn on org-mode automatically, make it to.
  4507. (if (and org-insert-mode-line-in-empty-file
  4508. (org-called-interactively-p 'any)
  4509. (= (point-min) (point-max)))
  4510. (insert "# -*- mode: org -*-\n\n"))
  4511. (unless org-inhibit-startup
  4512. (when org-startup-align-all-tables
  4513. (let ((bmp (buffer-modified-p)))
  4514. (org-table-map-tables 'org-table-align 'quietly)
  4515. (set-buffer-modified-p bmp)))
  4516. (when org-startup-with-inline-images
  4517. (org-display-inline-images))
  4518. (when org-startup-indented
  4519. (require 'org-indent)
  4520. (org-indent-mode 1))
  4521. (unless org-inhibit-startup-visibility-stuff
  4522. (org-set-startup-visibility))))
  4523. (when (fboundp 'abbrev-table-put)
  4524. (abbrev-table-put org-mode-abbrev-table
  4525. :parents (list text-mode-abbrev-table)))
  4526. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  4527. (defun org-current-time ()
  4528. "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
  4529. (if (> (car org-time-stamp-rounding-minutes) 1)
  4530. (let ((r (car org-time-stamp-rounding-minutes))
  4531. (time (decode-time)))
  4532. (apply 'encode-time
  4533. (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
  4534. (nthcdr 2 time))))
  4535. (current-time)))
  4536. (defun org-today ()
  4537. "Return today date, considering `org-extend-today-until'."
  4538. (time-to-days
  4539. (time-subtract (current-time)
  4540. (list 0 (* 3600 org-extend-today-until) 0))))
  4541. ;;;; Font-Lock stuff, including the activators
  4542. (defvar org-mouse-map (make-sparse-keymap))
  4543. (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
  4544. (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
  4545. (when org-mouse-1-follows-link
  4546. (org-defkey org-mouse-map [follow-link] 'mouse-face))
  4547. (when org-tab-follows-link
  4548. (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
  4549. (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
  4550. (require 'font-lock)
  4551. (defconst org-non-link-chars "]\t\n\r<>")
  4552. (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
  4553. "shell" "elisp" "doi" "message"))
  4554. (defvar org-link-types-re nil
  4555. "Matches a link that has a url-like prefix like \"http:\"")
  4556. (defvar org-link-re-with-space nil
  4557. "Matches a link with spaces, optional angular brackets around it.")
  4558. (defvar org-link-re-with-space2 nil
  4559. "Matches a link with spaces, optional angular brackets around it.")
  4560. (defvar org-link-re-with-space3 nil
  4561. "Matches a link with spaces, only for internal part in bracket links.")
  4562. (defvar org-angle-link-re nil
  4563. "Matches link with angular brackets, spaces are allowed.")
  4564. (defvar org-plain-link-re nil
  4565. "Matches plain link, without spaces.")
  4566. (defvar org-bracket-link-regexp nil
  4567. "Matches a link in double brackets.")
  4568. (defvar org-bracket-link-analytic-regexp nil
  4569. "Regular expression used to analyze links.
  4570. Here is what the match groups contain after a match:
  4571. 1: http:
  4572. 2: http
  4573. 3: path
  4574. 4: [desc]
  4575. 5: desc")
  4576. (defvar org-bracket-link-analytic-regexp++ nil
  4577. "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
  4578. (defvar org-any-link-re nil
  4579. "Regular expression matching any link.")
  4580. (defcustom org-match-sexp-depth 3
  4581. "Number of stacked braces for sub/superscript matching.
  4582. This has to be set before loading org.el to be effective."
  4583. :group 'org-export-translation ; ??????????????????????????/
  4584. :type 'integer)
  4585. (defun org-create-multibrace-regexp (left right n)
  4586. "Create a regular expression which will match a balanced sexp.
  4587. Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
  4588. as single character strings.
  4589. The regexp returned will match the entire expression including the
  4590. delimiters. It will also define a single group which contains the
  4591. match except for the outermost delimiters. The maximum depth of
  4592. stacked delimiters is N. Escaping delimiters is not possible."
  4593. (let* ((nothing (concat "[^" left right "]*?"))
  4594. (or "\\|")
  4595. (re nothing)
  4596. (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
  4597. (while (> n 1)
  4598. (setq n (1- n)
  4599. re (concat re or next)
  4600. next (concat "\\(?:" nothing left next right "\\)+" nothing)))
  4601. (concat left "\\(" re "\\)" right)))
  4602. (defvar org-match-substring-regexp
  4603. (concat
  4604. "\\([^\\]\\|^\\)\\([_^]\\)\\("
  4605. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4606. "\\|"
  4607. "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
  4608. "\\|"
  4609. "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
  4610. "The regular expression matching a sub- or superscript.")
  4611. (defvar org-match-substring-with-braces-regexp
  4612. (concat
  4613. "\\([^\\]\\|^\\)\\([_^]\\)\\("
  4614. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4615. "\\)")
  4616. "The regular expression matching a sub- or superscript, forcing braces.")
  4617. (defun org-make-link-regexps ()
  4618. "Update the link regular expressions.
  4619. This should be called after the variable `org-link-types' has changed."
  4620. (setq org-link-types-re
  4621. (concat
  4622. "\\`\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):")
  4623. org-link-re-with-space
  4624. (concat
  4625. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4626. "\\([^" org-non-link-chars " ]"
  4627. "[^" org-non-link-chars "]*"
  4628. "[^" org-non-link-chars " ]\\)>?")
  4629. org-link-re-with-space2
  4630. (concat
  4631. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4632. "\\([^" org-non-link-chars " ]"
  4633. "[^\t\n\r]*"
  4634. "[^" org-non-link-chars " ]\\)>?")
  4635. org-link-re-with-space3
  4636. (concat
  4637. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4638. "\\([^" org-non-link-chars " ]"
  4639. "[^\t\n\r]*\\)")
  4640. org-angle-link-re
  4641. (concat
  4642. "<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4643. "\\([^" org-non-link-chars " ]"
  4644. "[^" org-non-link-chars "]*"
  4645. "\\)>")
  4646. org-plain-link-re
  4647. (concat
  4648. "\\<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4649. (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
  4650. ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
  4651. org-bracket-link-regexp
  4652. "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
  4653. org-bracket-link-analytic-regexp
  4654. (concat
  4655. "\\[\\["
  4656. "\\(\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):\\)?"
  4657. "\\([^]]+\\)"
  4658. "\\]"
  4659. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4660. "\\]")
  4661. org-bracket-link-analytic-regexp++
  4662. (concat
  4663. "\\[\\["
  4664. "\\(\\(" (mapconcat 'regexp-quote (cons "coderef" org-link-types) "\\|") "\\):\\)?"
  4665. "\\([^]]+\\)"
  4666. "\\]"
  4667. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4668. "\\]")
  4669. org-any-link-re
  4670. (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
  4671. org-angle-link-re "\\)\\|\\("
  4672. org-plain-link-re "\\)")))
  4673. (org-make-link-regexps)
  4674. (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
  4675. "Regular expression for fast time stamp matching.")
  4676. (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
  4677. "Regular expression for fast time stamp matching.")
  4678. (defconst org-ts-regexp0
  4679. "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4680. "Regular expression matching time strings for analysis.
  4681. This one does not require the space after the date, so it can be used
  4682. on a string that terminates immediately after the date.")
  4683. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4684. "Regular expression matching time strings for analysis.")
  4685. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  4686. "Regular expression matching time stamps, with groups.")
  4687. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  4688. "Regular expression matching time stamps (also [..]), with groups.")
  4689. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  4690. "Regular expression matching a time stamp range.")
  4691. (defconst org-tr-regexp-both
  4692. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  4693. "Regular expression matching a time stamp range.")
  4694. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  4695. org-ts-regexp "\\)?")
  4696. "Regular expression matching a time stamp or time stamp range.")
  4697. (defconst org-tsr-regexp-both (concat org-ts-regexp-both "\\(--?-?"
  4698. org-ts-regexp-both "\\)?")
  4699. "Regular expression matching a time stamp or time stamp range.
  4700. The time stamps may be either active or inactive.")
  4701. (defvar org-emph-face nil)
  4702. (defun org-do-emphasis-faces (limit)
  4703. "Run through the buffer and add overlays to emphasized strings."
  4704. (let (rtn a)
  4705. (while (and (not rtn) (re-search-forward org-emph-re limit t))
  4706. (if (not (= (char-after (match-beginning 3))
  4707. (char-after (match-beginning 4))))
  4708. (progn
  4709. (setq rtn t)
  4710. (setq a (assoc (match-string 3) org-emphasis-alist))
  4711. (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
  4712. 'face
  4713. (nth 1 a))
  4714. (and (nth 4 a)
  4715. (org-remove-flyspell-overlays-in
  4716. (match-beginning 0) (match-end 0)))
  4717. (add-text-properties (match-beginning 2) (match-end 2)
  4718. '(font-lock-multiline t org-emphasis t))
  4719. (when org-hide-emphasis-markers
  4720. (add-text-properties (match-end 4) (match-beginning 5)
  4721. '(invisible org-link))
  4722. (add-text-properties (match-beginning 3) (match-end 3)
  4723. '(invisible org-link)))))
  4724. (backward-char 1))
  4725. rtn))
  4726. (defun org-emphasize (&optional char)
  4727. "Insert or change an emphasis, i.e. a font like bold or italic.
  4728. If there is an active region, change that region to a new emphasis.
  4729. If there is no region, just insert the marker characters and position
  4730. the cursor between them.
  4731. CHAR should be either the marker character, or the first character of the
  4732. HTML tag associated with that emphasis. If CHAR is a space, the means
  4733. to remove the emphasis of the selected region.
  4734. If char is not given (for example in an interactive call) it
  4735. will be prompted for."
  4736. (interactive)
  4737. (let ((eal org-emphasis-alist) e det
  4738. (erc org-emphasis-regexp-components)
  4739. (prompt "")
  4740. (string "") beg end move tag c s)
  4741. (if (org-region-active-p)
  4742. (setq beg (region-beginning) end (region-end)
  4743. string (buffer-substring beg end))
  4744. (setq move t))
  4745. (while (setq e (pop eal))
  4746. (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
  4747. c (aref tag 0))
  4748. (push (cons c (string-to-char (car e))) det)
  4749. (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
  4750. (substring tag 1)))))
  4751. (setq det (nreverse det))
  4752. (unless char
  4753. (message "%s" (concat "Emphasis marker or tag:" prompt))
  4754. (setq char (read-char-exclusive)))
  4755. (setq char (or (cdr (assoc char det)) char))
  4756. (if (equal char ?\ )
  4757. (setq s "" move nil)
  4758. (unless (assoc (char-to-string char) org-emphasis-alist)
  4759. (error "No such emphasis marker: \"%c\"" char))
  4760. (setq s (char-to-string char)))
  4761. (while (and (> (length string) 1)
  4762. (equal (substring string 0 1) (substring string -1))
  4763. (assoc (substring string 0 1) org-emphasis-alist))
  4764. (setq string (substring string 1 -1)))
  4765. (setq string (concat s string s))
  4766. (if beg (delete-region beg end))
  4767. (unless (or (bolp)
  4768. (string-match (concat "[" (nth 0 erc) "\n]")
  4769. (char-to-string (char-before (point)))))
  4770. (insert " "))
  4771. (unless (or (eobp)
  4772. (string-match (concat "[" (nth 1 erc) "\n]")
  4773. (char-to-string (char-after (point)))))
  4774. (insert " ") (backward-char 1))
  4775. (insert string)
  4776. (and move (backward-char 1))))
  4777. (defconst org-nonsticky-props
  4778. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
  4779. (defsubst org-rear-nonsticky-at (pos)
  4780. (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
  4781. (defun org-activate-plain-links (limit)
  4782. "Run through the buffer and add overlays to links."
  4783. (catch 'exit
  4784. (let (f)
  4785. (if (re-search-forward org-plain-link-re limit t)
  4786. (progn
  4787. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4788. (setq f (get-text-property (match-beginning 0) 'face))
  4789. (if (or (eq f 'org-tag)
  4790. (and (listp f) (memq 'org-tag f)))
  4791. nil
  4792. (add-text-properties (match-beginning 0) (match-end 0)
  4793. (list 'mouse-face 'highlight
  4794. 'face 'org-link
  4795. 'keymap org-mouse-map))
  4796. (org-rear-nonsticky-at (match-end 0)))
  4797. t)))))
  4798. (defun org-activate-code (limit)
  4799. (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
  4800. (progn
  4801. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4802. (remove-text-properties (match-beginning 0) (match-end 0)
  4803. '(display t invisible t intangible t))
  4804. t)))
  4805. (defcustom org-src-fontify-natively nil
  4806. "When non-nil, fontify code in code blocks."
  4807. :type 'boolean
  4808. :version "24.1"
  4809. :group 'org-appearance
  4810. :group 'org-babel)
  4811. (defcustom org-src-prevent-auto-filling nil
  4812. "When non-nil, prevent auto-filling in src blocks."
  4813. :type 'boolean
  4814. :version "24.1"
  4815. :group 'org-appearance
  4816. :group 'org-babel)
  4817. (defcustom org-allow-promoting-top-level-subtree nil
  4818. "When non-nil, allow promoting a top level subtree.
  4819. The leading star of the top level headline will be replaced
  4820. by a #."
  4821. :type 'boolean
  4822. :version "24.1"
  4823. :group 'org-appearance)
  4824. (defun org-fontify-meta-lines-and-blocks (limit)
  4825. (condition-case nil
  4826. (org-fontify-meta-lines-and-blocks-1 limit)
  4827. (error (message "org-mode fontification error"))))
  4828. (defun org-fontify-meta-lines-and-blocks-1 (limit)
  4829. "Fontify #+ lines and blocks, in the correct ways."
  4830. (let ((case-fold-search t))
  4831. (if (re-search-forward
  4832. "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
  4833. limit t)
  4834. (let ((beg (match-beginning 0))
  4835. (block-start (match-end 0))
  4836. (block-end nil)
  4837. (lang (match-string 7))
  4838. (beg1 (line-beginning-position 2))
  4839. (dc1 (downcase (match-string 2)))
  4840. (dc3 (downcase (match-string 3)))
  4841. end end1 quoting block-type ovl)
  4842. (cond
  4843. ((member dc1 '("html:" "ascii:" "latex:" "docbook:"))
  4844. ;; a single line of backend-specific content
  4845. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4846. (remove-text-properties (match-beginning 0) (match-end 0)
  4847. '(display t invisible t intangible t))
  4848. (add-text-properties (match-beginning 1) (match-end 3)
  4849. '(font-lock-fontified t face org-meta-line))
  4850. (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
  4851. '(font-lock-fontified t face org-block))
  4852. ; for backend-specific code
  4853. t)
  4854. ((and (match-end 4) (equal dc3 "begin"))
  4855. ;; Truly a block
  4856. (setq block-type (downcase (match-string 5))
  4857. quoting (member block-type org-protecting-blocks))
  4858. (when (re-search-forward
  4859. (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
  4860. nil t) ;; on purpose, we look further than LIMIT
  4861. (setq end (min (point-max) (match-end 0))
  4862. end1 (min (point-max) (1- (match-beginning 0))))
  4863. (setq block-end (match-beginning 0))
  4864. (when quoting
  4865. (remove-text-properties beg end
  4866. '(display t invisible t intangible t)))
  4867. (add-text-properties
  4868. beg end
  4869. '(font-lock-fontified t font-lock-multiline t))
  4870. (add-text-properties beg beg1 '(face org-meta-line))
  4871. (add-text-properties end1 (min (point-max) (1+ end))
  4872. '(face org-meta-line)) ; for end_src
  4873. (cond
  4874. ((and lang (not (string= lang "")) org-src-fontify-natively)
  4875. (org-src-font-lock-fontify-block lang block-start block-end)
  4876. ;; remove old background overlays
  4877. (mapc (lambda (ov)
  4878. (if (eq (overlay-get ov 'face) 'org-block-background)
  4879. (delete-overlay ov)))
  4880. (overlays-at (/ (+ beg1 block-end) 2)))
  4881. ;; add a background overlay
  4882. (setq ovl (make-overlay beg1 block-end))
  4883. (overlay-put ovl 'face 'org-block-background)
  4884. (overlay-put ovl 'evaporate t)) ;; make it go away when empty
  4885. (quoting
  4886. (add-text-properties beg1 (min (point-max) (1+ end1))
  4887. '(face org-block))) ; end of source block
  4888. ((not org-fontify-quote-and-verse-blocks))
  4889. ((string= block-type "quote")
  4890. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
  4891. ((string= block-type "verse")
  4892. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
  4893. (add-text-properties beg beg1 '(face org-block-begin-line))
  4894. (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
  4895. '(face org-block-end-line))
  4896. t))
  4897. ((member dc1 '("title:" "author:" "email:" "date:"))
  4898. (add-text-properties
  4899. beg (match-end 3)
  4900. (if (member (intern (substring dc1 0 -1)) org-hidden-keywords)
  4901. '(font-lock-fontified t invisible t)
  4902. '(font-lock-fontified t face org-document-info-keyword)))
  4903. (add-text-properties
  4904. (match-beginning 6) (match-end 6)
  4905. (if (string-equal dc1 "title:")
  4906. '(font-lock-fontified t face org-document-title)
  4907. '(font-lock-fontified t face org-document-info))))
  4908. ((not (member (char-after beg) '(?\ ?\t)))
  4909. ;; just any other in-buffer setting, but not indented
  4910. (add-text-properties
  4911. beg (match-end 0)
  4912. '(font-lock-fontified t face org-meta-line))
  4913. t)
  4914. ((or (member dc1 '("begin:" "end:" "caption:" "label:"
  4915. "orgtbl:" "tblfm:" "tblname:" "results:"
  4916. "call:" "header:" "headers:" "name:"))
  4917. (and (match-end 4) (equal dc3 "attr")))
  4918. (add-text-properties
  4919. beg (match-end 0)
  4920. '(font-lock-fontified t face org-meta-line))
  4921. t)
  4922. ((member dc3 '(" " ""))
  4923. (add-text-properties
  4924. beg (match-end 0)
  4925. '(font-lock-fontified t face font-lock-comment-face)))
  4926. (t nil))))))
  4927. (defun org-strip-protective-commas (beg end)
  4928. "Strip protective commas between BEG and END in the current buffer."
  4929. (interactive "r")
  4930. (save-excursion
  4931. (save-match-data
  4932. (goto-char beg)
  4933. (let ((front-line (save-excursion
  4934. (re-search-forward
  4935. "[^[:space:]]" end t)
  4936. (goto-char (match-beginning 0))
  4937. (current-column))))
  4938. (while (re-search-forward "^[ \t]*\\(,\\)\\([*]\\|#\\+\\)" end t)
  4939. (goto-char (match-beginning 1))
  4940. (when (= (current-column) front-line)
  4941. (replace-match "" nil nil nil 1)))))))
  4942. (defun org-activate-angle-links (limit)
  4943. "Run through the buffer and add overlays to links."
  4944. (if (re-search-forward org-angle-link-re limit t)
  4945. (progn
  4946. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4947. (add-text-properties (match-beginning 0) (match-end 0)
  4948. (list 'mouse-face 'highlight
  4949. 'keymap org-mouse-map))
  4950. (org-rear-nonsticky-at (match-end 0))
  4951. t)))
  4952. (defun org-activate-footnote-links (limit)
  4953. "Run through the buffer and add overlays to footnotes."
  4954. (let ((fn (org-footnote-next-reference-or-definition limit)))
  4955. (when fn
  4956. (let ((beg (nth 1 fn)) (end (nth 2 fn)))
  4957. (org-remove-flyspell-overlays-in beg end)
  4958. (add-text-properties beg end
  4959. (list 'mouse-face 'highlight
  4960. 'keymap org-mouse-map
  4961. 'help-echo
  4962. (if (= (point-at-bol) beg)
  4963. "Footnote definition"
  4964. "Footnote reference")
  4965. 'font-lock-fontified t
  4966. 'font-lock-multiline t
  4967. 'face 'org-footnote))))))
  4968. (defun org-activate-bracket-links (limit)
  4969. "Run through the buffer and add overlays to bracketed links."
  4970. (if (re-search-forward org-bracket-link-regexp limit t)
  4971. (let* ((help (concat "LINK: "
  4972. (org-match-string-no-properties 1)))
  4973. ;; FIXME: above we should remove the escapes.
  4974. ;; but that requires another match, protecting match data,
  4975. ;; a lot of overhead for font-lock.
  4976. (ip (org-maybe-intangible
  4977. (list 'invisible 'org-link
  4978. 'keymap org-mouse-map 'mouse-face 'highlight
  4979. 'font-lock-multiline t 'help-echo help)))
  4980. (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
  4981. 'font-lock-multiline t 'help-echo help)))
  4982. ;; We need to remove the invisible property here. Table narrowing
  4983. ;; may have made some of this invisible.
  4984. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4985. (remove-text-properties (match-beginning 0) (match-end 0)
  4986. '(invisible nil))
  4987. (if (match-end 3)
  4988. (progn
  4989. (add-text-properties (match-beginning 0) (match-beginning 3) ip)
  4990. (org-rear-nonsticky-at (match-beginning 3))
  4991. (add-text-properties (match-beginning 3) (match-end 3) vp)
  4992. (org-rear-nonsticky-at (match-end 3))
  4993. (add-text-properties (match-end 3) (match-end 0) ip)
  4994. (org-rear-nonsticky-at (match-end 0)))
  4995. (add-text-properties (match-beginning 0) (match-beginning 1) ip)
  4996. (org-rear-nonsticky-at (match-beginning 1))
  4997. (add-text-properties (match-beginning 1) (match-end 1) vp)
  4998. (org-rear-nonsticky-at (match-end 1))
  4999. (add-text-properties (match-end 1) (match-end 0) ip)
  5000. (org-rear-nonsticky-at (match-end 0)))
  5001. t)))
  5002. (defun org-activate-dates (limit)
  5003. "Run through the buffer and add overlays to dates."
  5004. (if (re-search-forward org-tsr-regexp-both limit t)
  5005. (progn
  5006. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5007. (add-text-properties (match-beginning 0) (match-end 0)
  5008. (list 'mouse-face 'highlight
  5009. 'keymap org-mouse-map))
  5010. (org-rear-nonsticky-at (match-end 0))
  5011. (when org-display-custom-times
  5012. (if (match-end 3)
  5013. (org-display-custom-time (match-beginning 3) (match-end 3)))
  5014. (org-display-custom-time (match-beginning 1) (match-end 1)))
  5015. t)))
  5016. (defvar org-target-link-regexp nil
  5017. "Regular expression matching radio targets in plain text.")
  5018. (make-variable-buffer-local 'org-target-link-regexp)
  5019. (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
  5020. "Regular expression matching a link target.")
  5021. (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
  5022. "Regular expression matching a radio target.")
  5023. (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
  5024. "Regular expression matching any target.")
  5025. (defun org-activate-target-links (limit)
  5026. "Run through the buffer and add overlays to target matches."
  5027. (when org-target-link-regexp
  5028. (let ((case-fold-search t))
  5029. (if (re-search-forward org-target-link-regexp limit t)
  5030. (progn
  5031. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5032. (add-text-properties (match-beginning 0) (match-end 0)
  5033. (list 'mouse-face 'highlight
  5034. 'keymap org-mouse-map
  5035. 'help-echo "Radio target link"
  5036. 'org-linked-text t))
  5037. (org-rear-nonsticky-at (match-end 0))
  5038. t)))))
  5039. (defun org-update-radio-target-regexp ()
  5040. "Find all radio targets in this file and update the regular expression."
  5041. (interactive)
  5042. (when (memq 'radio org-activate-links)
  5043. (setq org-target-link-regexp
  5044. (org-make-target-link-regexp (org-all-targets 'radio)))
  5045. (org-restart-font-lock)))
  5046. (defun org-hide-wide-columns (limit)
  5047. (let (s e)
  5048. (setq s (text-property-any (point) (or limit (point-max))
  5049. 'org-cwidth t))
  5050. (when s
  5051. (setq e (next-single-property-change s 'org-cwidth))
  5052. (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
  5053. (goto-char e)
  5054. t)))
  5055. (defvar org-latex-and-specials-regexp nil
  5056. "Regular expression for highlighting export special stuff.")
  5057. (defvar org-match-substring-regexp)
  5058. (defvar org-match-substring-with-braces-regexp)
  5059. ;; This should be with the exporter code, but we also use if for font-locking
  5060. (defconst org-export-html-special-string-regexps
  5061. '(("\\\\-" . "&shy;")
  5062. ("---\\([^-]\\)" . "&mdash;\\1")
  5063. ("--\\([^-]\\)" . "&ndash;\\1")
  5064. ("\\.\\.\\." . "&hellip;"))
  5065. "Regular expressions for special string conversion.")
  5066. (defun org-compute-latex-and-specials-regexp ()
  5067. "Compute regular expression for stuff treated specially by exporters."
  5068. (if (not org-highlight-latex-fragments-and-specials)
  5069. (org-set-local 'org-latex-and-specials-regexp nil)
  5070. (require 'org-exp)
  5071. (let*
  5072. ((matchers (plist-get org-format-latex-options :matchers))
  5073. (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
  5074. org-latex-regexps)))
  5075. (org-export-allow-BIND nil)
  5076. (options (org-combine-plists (org-default-export-plist)
  5077. (org-infile-export-plist)))
  5078. (org-export-with-sub-superscripts (plist-get options :sub-superscript))
  5079. (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
  5080. (org-export-with-TeX-macros (plist-get options :TeX-macros))
  5081. (org-export-html-expand (plist-get options :expand-quoted-html))
  5082. (org-export-with-special-strings (plist-get options :special-strings))
  5083. (re-sub
  5084. (cond
  5085. ((equal org-export-with-sub-superscripts '{})
  5086. (list org-match-substring-with-braces-regexp))
  5087. (org-export-with-sub-superscripts
  5088. (list org-match-substring-regexp))
  5089. (t nil)))
  5090. (re-latex
  5091. (if org-export-with-LaTeX-fragments
  5092. (mapcar (lambda (x) (nth 1 x)) latexs)))
  5093. (re-macros
  5094. (if org-export-with-TeX-macros
  5095. (list (concat "\\\\"
  5096. (regexp-opt
  5097. (append
  5098. (delq nil
  5099. (mapcar 'car-safe
  5100. (append org-entities-user
  5101. org-entities)))
  5102. (if (boundp 'org-latex-entities)
  5103. (mapcar (lambda (x)
  5104. (or (car-safe x) x))
  5105. org-latex-entities)
  5106. nil))
  5107. 'words))) ; FIXME
  5108. ))
  5109. ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
  5110. (re-special (if org-export-with-special-strings
  5111. (mapcar (lambda (x) (car x))
  5112. org-export-html-special-string-regexps)))
  5113. (re-rest
  5114. (delq nil
  5115. (list
  5116. (if org-export-html-expand "@<[^>\n]+>")
  5117. ))))
  5118. (org-set-local
  5119. 'org-latex-and-specials-regexp
  5120. (mapconcat 'identity (append re-latex re-sub re-macros re-special
  5121. re-rest) "\\|")))))
  5122. (defun org-do-latex-and-special-faces (limit)
  5123. "Run through the buffer and add overlays to links."
  5124. (when org-latex-and-specials-regexp
  5125. (let (rtn d)
  5126. (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
  5127. limit t))
  5128. (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
  5129. 'face))
  5130. '(org-code org-verbatim underline)))
  5131. (progn
  5132. (setq rtn t
  5133. d (cond ((member (char-after (1+ (match-beginning 0)))
  5134. '(?_ ?^)) 1)
  5135. (t 0)))
  5136. (font-lock-prepend-text-property
  5137. (+ d (match-beginning 0)) (match-end 0)
  5138. 'face 'org-latex-and-export-specials)
  5139. (add-text-properties (+ d (match-beginning 0)) (match-end 0)
  5140. '(font-lock-multiline t)))))
  5141. rtn)))
  5142. (defun org-restart-font-lock ()
  5143. "Restart `font-lock-mode', to force refontification."
  5144. (when (and (boundp 'font-lock-mode) font-lock-mode)
  5145. (font-lock-mode -1)
  5146. (font-lock-mode 1)))
  5147. (defun org-all-targets (&optional radio)
  5148. "Return a list of all targets in this file.
  5149. With optional argument RADIO, only find radio targets."
  5150. (let ((re (if radio org-radio-target-regexp org-target-regexp))
  5151. rtn)
  5152. (save-excursion
  5153. (goto-char (point-min))
  5154. (while (re-search-forward re nil t)
  5155. (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
  5156. rtn)))
  5157. (defun org-make-target-link-regexp (targets)
  5158. "Make regular expression matching all strings in TARGETS.
  5159. The regular expression finds the targets also if there is a line break
  5160. between words."
  5161. (and targets
  5162. (concat
  5163. "\\<\\("
  5164. (mapconcat
  5165. (lambda (x)
  5166. (setq x (regexp-quote x))
  5167. (while (string-match " +" x)
  5168. (setq x (replace-match "\\s-+" t t x)))
  5169. x)
  5170. targets
  5171. "\\|")
  5172. "\\)\\>")))
  5173. (defun org-activate-tags (limit)
  5174. (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
  5175. (progn
  5176. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  5177. (add-text-properties (match-beginning 1) (match-end 1)
  5178. (list 'mouse-face 'highlight
  5179. 'keymap org-mouse-map))
  5180. (org-rear-nonsticky-at (match-end 1))
  5181. t)))
  5182. (defun org-outline-level ()
  5183. "Compute the outline level of the heading at point.
  5184. This function assumes that the cursor is at the beginning of a line matched
  5185. by `outline-regexp'. Otherwise it returns garbage.
  5186. If this is called at a normal headline, the level is the number of stars.
  5187. Use `org-reduced-level' to remove the effect of `org-odd-levels'."
  5188. (save-excursion
  5189. (looking-at org-outline-regexp)
  5190. (1- (- (match-end 0) (match-beginning 0)))))
  5191. (defvar org-font-lock-keywords nil)
  5192. (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
  5193. "Regular expression matching a property line.")
  5194. (defvar org-font-lock-hook nil
  5195. "Functions to be called for special font lock stuff.")
  5196. (defvar org-font-lock-set-keywords-hook nil
  5197. "Functions that can manipulate `org-font-lock-extra-keywords'.
  5198. This is called after `org-font-lock-extra-keywords' is defined, but before
  5199. it is installed to be used by font lock. This can be useful if something
  5200. needs to be inserted at a specific position in the font-lock sequence.")
  5201. (defun org-font-lock-hook (limit)
  5202. (run-hook-with-args 'org-font-lock-hook limit))
  5203. (defun org-set-font-lock-defaults ()
  5204. (let* ((em org-fontify-emphasized-text)
  5205. (lk org-activate-links)
  5206. (org-font-lock-extra-keywords
  5207. (list
  5208. ;; Call the hook
  5209. '(org-font-lock-hook)
  5210. ;; Headlines
  5211. `(,(if org-fontify-whole-heading-line
  5212. "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
  5213. "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
  5214. (1 (org-get-level-face 1))
  5215. (2 (org-get-level-face 2))
  5216. (3 (org-get-level-face 3)))
  5217. ;; Table lines
  5218. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  5219. (1 'org-table t))
  5220. ;; Table internals
  5221. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  5222. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  5223. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  5224. '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
  5225. ;; Drawers
  5226. (list org-drawer-regexp '(0 'org-special-keyword t))
  5227. (list "^[ \t]*:END:" '(0 'org-special-keyword t))
  5228. ;; Properties
  5229. (list org-property-re
  5230. '(1 'org-special-keyword t)
  5231. '(3 'org-property-value t))
  5232. ;; Links
  5233. (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
  5234. (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
  5235. (if (memq 'plain lk) '(org-activate-plain-links))
  5236. (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
  5237. (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
  5238. (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
  5239. (if (memq 'footnote lk) '(org-activate-footnote-links))
  5240. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  5241. '(org-hide-wide-columns (0 nil append))
  5242. ;; TODO keyword
  5243. (list (format org-heading-keyword-regexp-format
  5244. org-todo-regexp)
  5245. '(2 (org-get-todo-face 2) t))
  5246. ;; DONE
  5247. (if org-fontify-done-headline
  5248. (list (format org-heading-keyword-regexp-format
  5249. (concat
  5250. "\\(?:"
  5251. (mapconcat 'regexp-quote org-done-keywords "\\|")
  5252. "\\)"))
  5253. '(2 'org-headline-done t))
  5254. nil)
  5255. ;; Priorities
  5256. '(org-font-lock-add-priority-faces)
  5257. ;; Tags
  5258. '(org-font-lock-add-tag-faces)
  5259. ;; Special keywords
  5260. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  5261. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  5262. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  5263. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  5264. ;; Emphasis
  5265. (if em
  5266. (if (featurep 'xemacs)
  5267. '(org-do-emphasis-faces (0 nil append))
  5268. '(org-do-emphasis-faces)))
  5269. ;; Checkboxes
  5270. '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
  5271. 1 'org-checkbox prepend)
  5272. (if (cdr (assq 'checkbox org-list-automatic-rules))
  5273. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  5274. (0 (org-get-checkbox-statistics-face) t)))
  5275. ;; Description list items
  5276. '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
  5277. 1 'org-list-dt prepend)
  5278. ;; ARCHIVEd headings
  5279. (list (concat
  5280. org-outline-regexp-bol
  5281. "\\(.*:" org-archive-tag ":.*\\)")
  5282. '(1 'org-archived prepend))
  5283. ;; Specials
  5284. '(org-do-latex-and-special-faces)
  5285. '(org-fontify-entities)
  5286. '(org-raise-scripts)
  5287. ;; Code
  5288. '(org-activate-code (1 'org-code t))
  5289. ;; COMMENT
  5290. (list (format org-heading-keyword-regexp-format
  5291. (concat "\\("
  5292. org-comment-string "\\|" org-quote-string
  5293. "\\)"))
  5294. '(2 'org-special-keyword t))
  5295. '("^#.*" (0 'font-lock-comment-face t))
  5296. ;; Blocks and meta lines
  5297. '(org-fontify-meta-lines-and-blocks)
  5298. )))
  5299. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  5300. (run-hooks 'org-font-lock-set-keywords-hook)
  5301. ;; Now set the full font-lock-keywords
  5302. (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
  5303. (org-set-local 'font-lock-defaults
  5304. '(org-font-lock-keywords t nil nil backward-paragraph))
  5305. (kill-local-variable 'font-lock-keywords) nil))
  5306. (defun org-toggle-pretty-entities ()
  5307. "Toggle the composition display of entities as UTF8 characters."
  5308. (interactive)
  5309. (org-set-local 'org-pretty-entities (not org-pretty-entities))
  5310. (org-restart-font-lock)
  5311. (if org-pretty-entities
  5312. (message "Entities are displayed as UTF8 characters")
  5313. (save-restriction
  5314. (widen)
  5315. (org-decompose-region (point-min) (point-max))
  5316. (message "Entities are displayed plain"))))
  5317. (defun org-fontify-entities (limit)
  5318. "Find an entity to fontify."
  5319. (let (ee)
  5320. (when org-pretty-entities
  5321. (catch 'match
  5322. (while (re-search-forward
  5323. "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
  5324. limit t)
  5325. (if (and (not (org-in-indented-comment-line))
  5326. (setq ee (org-entity-get (match-string 1)))
  5327. (= (length (nth 6 ee)) 1))
  5328. (let*
  5329. ((end (if (equal (match-string 2) "{}")
  5330. (match-end 2)
  5331. (match-end 1))))
  5332. (add-text-properties
  5333. (match-beginning 0) end
  5334. (list 'font-lock-fontified t))
  5335. (compose-region (match-beginning 0) end
  5336. (nth 6 ee) nil)
  5337. (backward-char 1)
  5338. (throw 'match t))))
  5339. nil))))
  5340. (defun org-fontify-like-in-org-mode (s &optional odd-levels)
  5341. "Fontify string S like in Org-mode."
  5342. (with-temp-buffer
  5343. (insert s)
  5344. (let ((org-odd-levels-only odd-levels))
  5345. (org-mode)
  5346. (font-lock-fontify-buffer)
  5347. (buffer-string))))
  5348. (defvar org-m nil)
  5349. (defvar org-l nil)
  5350. (defvar org-f nil)
  5351. (defun org-get-level-face (n)
  5352. "Get the right face for match N in font-lock matching of headlines."
  5353. (setq org-l (- (match-end 2) (match-beginning 1) 1))
  5354. (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
  5355. (if org-cycle-level-faces
  5356. (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
  5357. (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
  5358. (cond
  5359. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  5360. ((eq n 2) org-f)
  5361. (t (if org-level-color-stars-only nil org-f))))
  5362. (defun org-get-todo-face (kwd)
  5363. "Get the right face for a TODO keyword KWD.
  5364. If KWD is a number, get the corresponding match group."
  5365. (if (numberp kwd) (setq kwd (match-string kwd)))
  5366. (or (org-face-from-face-or-color
  5367. 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
  5368. (and (member kwd org-done-keywords) 'org-done)
  5369. 'org-todo))
  5370. (defun org-face-from-face-or-color (context inherit face-or-color)
  5371. "Create a face list that inherits INHERIT, but sets the foreground color.
  5372. When FACE-OR-COLOR is not a string, just return it."
  5373. (if (stringp face-or-color)
  5374. (list :inherit inherit
  5375. (cdr (assoc context org-faces-easy-properties))
  5376. face-or-color)
  5377. face-or-color))
  5378. (defun org-font-lock-add-tag-faces (limit)
  5379. "Add the special tag faces."
  5380. (when (and org-tag-faces org-tags-special-faces-re)
  5381. (while (re-search-forward org-tags-special-faces-re limit t)
  5382. (add-text-properties (match-beginning 1) (match-end 1)
  5383. (list 'face (org-get-tag-face 1)
  5384. 'font-lock-fontified t))
  5385. (backward-char 1))))
  5386. (defun org-font-lock-add-priority-faces (limit)
  5387. "Add the special priority faces."
  5388. (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
  5389. (when (save-match-data (org-at-heading-p))
  5390. (add-text-properties
  5391. (match-beginning 0) (match-end 0)
  5392. (list 'face (or (org-face-from-face-or-color
  5393. 'priority 'org-special-keyword
  5394. (cdr (assoc (char-after (match-beginning 1))
  5395. org-priority-faces)))
  5396. 'org-special-keyword)
  5397. 'font-lock-fontified t)))))
  5398. (defun org-get-tag-face (kwd)
  5399. "Get the right face for a TODO keyword KWD.
  5400. If KWD is a number, get the corresponding match group."
  5401. (if (numberp kwd) (setq kwd (match-string kwd)))
  5402. (or (org-face-from-face-or-color
  5403. 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
  5404. 'org-tag))
  5405. (defun org-unfontify-region (beg end &optional maybe_loudly)
  5406. "Remove fontification and activation overlays from links."
  5407. (font-lock-default-unfontify-region beg end)
  5408. (let* ((buffer-undo-list t)
  5409. (inhibit-read-only t) (inhibit-point-motion-hooks t)
  5410. (inhibit-modification-hooks t)
  5411. deactivate-mark buffer-file-name buffer-file-truename)
  5412. (org-decompose-region beg end)
  5413. (remove-text-properties beg end
  5414. '(mouse-face t keymap t org-linked-text t
  5415. invisible t intangible t
  5416. org-no-flyspell t org-emphasis t))
  5417. (org-remove-font-lock-display-properties beg end)))
  5418. (defconst org-script-display '(((raise -0.3) (height 0.7))
  5419. ((raise 0.3) (height 0.7))
  5420. ((raise -0.5))
  5421. ((raise 0.5)))
  5422. "Display properties for showing superscripts and subscripts.")
  5423. (defun org-remove-font-lock-display-properties (beg end)
  5424. "Remove specific display properties that have been added by font lock.
  5425. The will remove the raise properties that are used to show superscripts
  5426. and subscripts."
  5427. (let (next prop)
  5428. (while (< beg end)
  5429. (setq next (next-single-property-change beg 'display nil end)
  5430. prop (get-text-property beg 'display))
  5431. (if (member prop org-script-display)
  5432. (put-text-property beg next 'display nil))
  5433. (setq beg next))))
  5434. (defun org-raise-scripts (limit)
  5435. "Add raise properties to sub/superscripts."
  5436. (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
  5437. (if (re-search-forward
  5438. (if (eq org-use-sub-superscripts t)
  5439. org-match-substring-regexp
  5440. org-match-substring-with-braces-regexp)
  5441. limit t)
  5442. (let* ((pos (point)) table-p comment-p
  5443. (mpos (match-beginning 3))
  5444. (emph-p (get-text-property mpos 'org-emphasis))
  5445. (link-p (get-text-property mpos 'mouse-face))
  5446. (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
  5447. (goto-char (point-at-bol))
  5448. (setq table-p (org-looking-at-p org-table-dataline-regexp)
  5449. comment-p (org-looking-at-p "[ \t]*#"))
  5450. (goto-char pos)
  5451. ;; FIXME: Should we go back one character here, for a_b^c
  5452. ;; (goto-char (1- pos)) ;????????????????????
  5453. (if (or comment-p emph-p link-p keyw-p)
  5454. t
  5455. (put-text-property (match-beginning 3) (match-end 0)
  5456. 'display
  5457. (if (equal (char-after (match-beginning 2)) ?^)
  5458. (nth (if table-p 3 1) org-script-display)
  5459. (nth (if table-p 2 0) org-script-display)))
  5460. (add-text-properties (match-beginning 2) (match-end 2)
  5461. (list 'invisible t
  5462. 'org-dwidth t 'org-dwidth-n 1))
  5463. (if (and (eq (char-after (match-beginning 3)) ?{)
  5464. (eq (char-before (match-end 3)) ?}))
  5465. (progn
  5466. (add-text-properties
  5467. (match-beginning 3) (1+ (match-beginning 3))
  5468. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
  5469. (add-text-properties
  5470. (1- (match-end 3)) (match-end 3)
  5471. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
  5472. t)))))
  5473. ;;;; Visibility cycling, including org-goto and indirect buffer
  5474. ;;; Cycling
  5475. (defvar org-cycle-global-status nil)
  5476. (make-variable-buffer-local 'org-cycle-global-status)
  5477. (defvar org-cycle-subtree-status nil)
  5478. (make-variable-buffer-local 'org-cycle-subtree-status)
  5479. ;;;###autoload
  5480. (defvar org-inlinetask-min-level)
  5481. (defun org-cycle (&optional arg)
  5482. "TAB-action and visibility cycling for Org-mode.
  5483. This is the command invoked in Org-mode by the TAB key. Its main purpose
  5484. is outline visibility cycling, but it also invokes other actions
  5485. in special contexts.
  5486. - When this function is called with a prefix argument, rotate the entire
  5487. buffer through 3 states (global cycling)
  5488. 1. OVERVIEW: Show only top-level headlines.
  5489. 2. CONTENTS: Show all headlines of all levels, but no body text.
  5490. 3. SHOW ALL: Show everything.
  5491. When called with two `C-u C-u' prefixes, switch to the startup visibility,
  5492. determined by the variable `org-startup-folded', and by any VISIBILITY
  5493. properties in the buffer.
  5494. When called with three `C-u C-u C-u' prefixed, show the entire buffer,
  5495. including any drawers.
  5496. - When inside a table, re-align the table and move to the next field.
  5497. - When point is at the beginning of a headline, rotate the subtree started
  5498. by this line through 3 different states (local cycling)
  5499. 1. FOLDED: Only the main headline is shown.
  5500. 2. CHILDREN: The main headline and the direct children are shown.
  5501. From this state, you can move to one of the children
  5502. and zoom in further.
  5503. 3. SUBTREE: Show the entire subtree, including body text.
  5504. If there is no subtree, switch directly from CHILDREN to FOLDED.
  5505. - When point is at the beginning of an empty headline and the variable
  5506. `org-cycle-level-after-item/entry-creation' is set, cycle the level
  5507. of the headline by demoting and promoting it to likely levels. This
  5508. speeds up creation document structure by pressing TAB once or several
  5509. times right after creating a new headline.
  5510. - When there is a numeric prefix, go up to a heading with level ARG, do
  5511. a `show-subtree' and return to the previous cursor position. If ARG
  5512. is negative, go up that many levels.
  5513. - When point is not at the beginning of a headline, execute the global
  5514. binding for TAB, which is re-indenting the line. See the option
  5515. `org-cycle-emulate-tab' for details.
  5516. - Special case: if point is at the beginning of the buffer and there is
  5517. no headline in line 1, this function will act as if called with prefix arg
  5518. (C-u TAB, same as S-TAB) also when called without prefix arg.
  5519. But only if also the variable `org-cycle-global-at-bob' is t."
  5520. (interactive "P")
  5521. (org-load-modules-maybe)
  5522. (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
  5523. (and org-cycle-level-after-item/entry-creation
  5524. (or (org-cycle-level)
  5525. (org-cycle-item-indentation))))
  5526. (let* ((limit-level
  5527. (or org-cycle-max-level
  5528. (and (boundp 'org-inlinetask-min-level)
  5529. org-inlinetask-min-level
  5530. (1- org-inlinetask-min-level))))
  5531. (nstars (and limit-level
  5532. (if org-odd-levels-only
  5533. (and limit-level (1- (* limit-level 2)))
  5534. limit-level)))
  5535. (org-outline-regexp
  5536. (if (not (derived-mode-p 'org-mode))
  5537. outline-regexp
  5538. (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
  5539. (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
  5540. (not (looking-at org-outline-regexp))))
  5541. (org-cycle-hook
  5542. (if bob-special
  5543. (delq 'org-optimize-window-after-visibility-change
  5544. (copy-sequence org-cycle-hook))
  5545. org-cycle-hook))
  5546. (pos (point)))
  5547. (if (or bob-special (equal arg '(4)))
  5548. ;; special case: use global cycling
  5549. (setq arg t))
  5550. (cond
  5551. ((equal arg '(16))
  5552. (setq last-command 'dummy)
  5553. (org-set-startup-visibility)
  5554. (message "Startup visibility, plus VISIBILITY properties"))
  5555. ((equal arg '(64))
  5556. (show-all)
  5557. (message "Entire buffer visible, including drawers"))
  5558. ;; Table: enter it or move to the next field.
  5559. ((org-at-table-p 'any)
  5560. (if (org-at-table.el-p)
  5561. (message "Use C-c ' to edit table.el tables")
  5562. (if arg (org-table-edit-field t)
  5563. (org-table-justify-field-maybe)
  5564. (call-interactively 'org-table-next-field))))
  5565. ((run-hook-with-args-until-success
  5566. 'org-tab-after-check-for-table-hook))
  5567. ;; Global cycling: delegate to `org-cycle-internal-global'.
  5568. ((eq arg t) (org-cycle-internal-global))
  5569. ;; Drawers: delegate to `org-flag-drawer'.
  5570. ((and org-drawers org-drawer-regexp
  5571. (save-excursion
  5572. (beginning-of-line 1)
  5573. (looking-at org-drawer-regexp)))
  5574. (org-flag-drawer ; toggle block visibility
  5575. (not (get-char-property (match-end 0) 'invisible))))
  5576. ;; Show-subtree, ARG levels up from here.
  5577. ((integerp arg)
  5578. (save-excursion
  5579. (org-back-to-heading)
  5580. (outline-up-heading (if (< arg 0) (- arg)
  5581. (- (funcall outline-level) arg)))
  5582. (org-show-subtree)))
  5583. ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
  5584. ((and (featurep 'org-inlinetask)
  5585. (org-inlinetask-at-task-p)
  5586. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5587. (org-inlinetask-toggle-visibility))
  5588. ((org-try-cdlatex-tab))
  5589. ;; At an item/headline: delegate to `org-cycle-internal-local'.
  5590. ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
  5591. (save-excursion (beginning-of-line 1)
  5592. (looking-at org-outline-regexp)))
  5593. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5594. (org-cycle-internal-local))
  5595. ;; From there: TAB emulation and template completion.
  5596. (buffer-read-only (org-back-to-heading))
  5597. ((run-hook-with-args-until-success
  5598. 'org-tab-after-check-for-cycling-hook))
  5599. ((org-try-structure-completion))
  5600. ((run-hook-with-args-until-success
  5601. 'org-tab-before-tab-emulation-hook))
  5602. ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
  5603. (or (not (bolp))
  5604. (not (looking-at org-outline-regexp))))
  5605. (call-interactively (global-key-binding "\t")))
  5606. ((if (and (memq org-cycle-emulate-tab '(white whitestart))
  5607. (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
  5608. (or (and (eq org-cycle-emulate-tab 'white)
  5609. (= (match-end 0) (point-at-eol)))
  5610. (and (eq org-cycle-emulate-tab 'whitestart)
  5611. (>= (match-end 0) pos))))
  5612. t
  5613. (eq org-cycle-emulate-tab t))
  5614. (call-interactively (global-key-binding "\t")))
  5615. (t (save-excursion
  5616. (org-back-to-heading)
  5617. (org-cycle)))))))
  5618. (defun org-cycle-internal-global ()
  5619. "Do the global cycling action."
  5620. ;; Hack to avoid display of messages for .org attachments in Gnus
  5621. (let ((ga (string-match "\\*fontification" (buffer-name))))
  5622. (cond
  5623. ((and (eq last-command this-command)
  5624. (eq org-cycle-global-status 'overview))
  5625. ;; We just created the overview - now do table of contents
  5626. ;; This can be slow in very large buffers, so indicate action
  5627. (run-hook-with-args 'org-pre-cycle-hook 'contents)
  5628. (unless ga (message "CONTENTS..."))
  5629. (org-content)
  5630. (unless ga (message "CONTENTS...done"))
  5631. (setq org-cycle-global-status 'contents)
  5632. (run-hook-with-args 'org-cycle-hook 'contents))
  5633. ((and (eq last-command this-command)
  5634. (eq org-cycle-global-status 'contents))
  5635. ;; We just showed the table of contents - now show everything
  5636. (run-hook-with-args 'org-pre-cycle-hook 'all)
  5637. (show-all)
  5638. (unless ga (message "SHOW ALL"))
  5639. (setq org-cycle-global-status 'all)
  5640. (run-hook-with-args 'org-cycle-hook 'all))
  5641. (t
  5642. ;; Default action: go to overview
  5643. (run-hook-with-args 'org-pre-cycle-hook 'overview)
  5644. (org-overview)
  5645. (unless ga (message "OVERVIEW"))
  5646. (setq org-cycle-global-status 'overview)
  5647. (run-hook-with-args 'org-cycle-hook 'overview)))))
  5648. (defun org-cycle-internal-local ()
  5649. "Do the local cycling action."
  5650. (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
  5651. ;; First, determine end of headline (EOH), end of subtree or item
  5652. ;; (EOS), and if item or heading has children (HAS-CHILDREN).
  5653. (save-excursion
  5654. (if (org-at-item-p)
  5655. (progn
  5656. (beginning-of-line)
  5657. (setq struct (org-list-struct))
  5658. (setq eoh (point-at-eol))
  5659. (setq eos (org-list-get-item-end-before-blank (point) struct))
  5660. (setq has-children (org-list-has-child-p (point) struct)))
  5661. (org-back-to-heading)
  5662. (setq eoh (save-excursion (outline-end-of-heading) (point)))
  5663. (setq eos (save-excursion
  5664. (org-end-of-subtree t)
  5665. (unless (eobp)
  5666. (skip-chars-forward " \t\n"))
  5667. (if (eobp) (point) (1- (point)))))
  5668. (setq has-children
  5669. (or (save-excursion
  5670. (let ((level (funcall outline-level)))
  5671. (outline-next-heading)
  5672. (and (org-at-heading-p t)
  5673. (> (funcall outline-level) level))))
  5674. (save-excursion
  5675. (org-list-search-forward (org-item-beginning-re) eos t)))))
  5676. ;; Determine end invisible part of buffer (EOL)
  5677. (beginning-of-line 2)
  5678. ;; XEmacs doesn't have `next-single-char-property-change'
  5679. (if (featurep 'xemacs)
  5680. (while (and (not (eobp)) ;; this is like `next-line'
  5681. (get-char-property (1- (point)) 'invisible))
  5682. (beginning-of-line 2))
  5683. (while (and (not (eobp)) ;; this is like `next-line'
  5684. (get-char-property (1- (point)) 'invisible))
  5685. (goto-char (next-single-char-property-change (point) 'invisible))
  5686. (and (eolp) (beginning-of-line 2))))
  5687. (setq eol (point)))
  5688. ;; Find out what to do next and set `this-command'
  5689. (cond
  5690. ((= eos eoh)
  5691. ;; Nothing is hidden behind this heading
  5692. (run-hook-with-args 'org-pre-cycle-hook 'empty)
  5693. (message "EMPTY ENTRY")
  5694. (setq org-cycle-subtree-status nil)
  5695. (save-excursion
  5696. (goto-char eos)
  5697. (outline-next-heading)
  5698. (if (outline-invisible-p) (org-flag-heading nil))))
  5699. ((and (or (>= eol eos)
  5700. (not (string-match "\\S-" (buffer-substring eol eos))))
  5701. (or has-children
  5702. (not (setq children-skipped
  5703. org-cycle-skip-children-state-if-no-children))))
  5704. ;; Entire subtree is hidden in one line: children view
  5705. (run-hook-with-args 'org-pre-cycle-hook 'children)
  5706. (if (org-at-item-p)
  5707. (org-list-set-item-visibility (point-at-bol) struct 'children)
  5708. (org-show-entry)
  5709. (org-with-limited-levels (show-children))
  5710. ;; FIXME: This slows down the func way too much.
  5711. ;; How keep drawers hidden in subtree anyway?
  5712. ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
  5713. ;; (org-cycle-hide-drawers 'subtree))
  5714. ;; Fold every list in subtree to top-level items.
  5715. (when (eq org-cycle-include-plain-lists 'integrate)
  5716. (save-excursion
  5717. (org-back-to-heading)
  5718. (while (org-list-search-forward (org-item-beginning-re) eos t)
  5719. (beginning-of-line 1)
  5720. (let* ((struct (org-list-struct))
  5721. (prevs (org-list-prevs-alist struct))
  5722. (end (org-list-get-bottom-point struct)))
  5723. (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
  5724. (org-list-get-all-items (point) struct prevs))
  5725. (goto-char end))))))
  5726. (message "CHILDREN")
  5727. (save-excursion
  5728. (goto-char eos)
  5729. (outline-next-heading)
  5730. (if (outline-invisible-p) (org-flag-heading nil)))
  5731. (setq org-cycle-subtree-status 'children)
  5732. (run-hook-with-args 'org-cycle-hook 'children))
  5733. ((or children-skipped
  5734. (and (eq last-command this-command)
  5735. (eq org-cycle-subtree-status 'children)))
  5736. ;; We just showed the children, or no children are there,
  5737. ;; now show everything.
  5738. (run-hook-with-args 'org-pre-cycle-hook 'subtree)
  5739. (outline-flag-region eoh eos nil)
  5740. (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
  5741. (setq org-cycle-subtree-status 'subtree)
  5742. (run-hook-with-args 'org-cycle-hook 'subtree))
  5743. (t
  5744. ;; Default action: hide the subtree.
  5745. (run-hook-with-args 'org-pre-cycle-hook 'folded)
  5746. (outline-flag-region eoh eos t)
  5747. (message "FOLDED")
  5748. (setq org-cycle-subtree-status 'folded)
  5749. (run-hook-with-args 'org-cycle-hook 'folded)))))
  5750. ;;;###autoload
  5751. (defun org-global-cycle (&optional arg)
  5752. "Cycle the global visibility. For details see `org-cycle'.
  5753. With \\[universal-argument] prefix arg, switch to startup visibility.
  5754. With a numeric prefix, show all headlines up to that level."
  5755. (interactive "P")
  5756. (let ((org-cycle-include-plain-lists
  5757. (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
  5758. (cond
  5759. ((integerp arg)
  5760. (show-all)
  5761. (hide-sublevels arg)
  5762. (setq org-cycle-global-status 'contents))
  5763. ((equal arg '(4))
  5764. (org-set-startup-visibility)
  5765. (message "Startup visibility, plus VISIBILITY properties."))
  5766. (t
  5767. (org-cycle '(4))))))
  5768. (defun org-set-startup-visibility ()
  5769. "Set the visibility required by startup options and properties."
  5770. (cond
  5771. ((eq org-startup-folded t)
  5772. (org-cycle '(4)))
  5773. ((eq org-startup-folded 'content)
  5774. (let ((this-command 'org-cycle) (last-command 'org-cycle))
  5775. (org-cycle '(4)) (org-cycle '(4)))))
  5776. (unless (eq org-startup-folded 'showeverything)
  5777. (if org-hide-block-startup (org-hide-block-all))
  5778. (org-set-visibility-according-to-property 'no-cleanup)
  5779. (org-cycle-hide-archived-subtrees 'all)
  5780. (org-cycle-hide-drawers 'all)
  5781. (org-cycle-show-empty-lines t)))
  5782. (defun org-set-visibility-according-to-property (&optional no-cleanup)
  5783. "Switch subtree visibilities according to :VISIBILITY: property."
  5784. (interactive)
  5785. (let (org-show-entry-below state)
  5786. (save-excursion
  5787. (goto-char (point-min))
  5788. (while (re-search-forward
  5789. "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
  5790. nil t)
  5791. (setq state (match-string 1))
  5792. (save-excursion
  5793. (org-back-to-heading t)
  5794. (hide-subtree)
  5795. (org-reveal)
  5796. (cond
  5797. ((equal state '("fold" "folded"))
  5798. (hide-subtree))
  5799. ((equal state "children")
  5800. (org-show-hidden-entry)
  5801. (show-children))
  5802. ((equal state "content")
  5803. (save-excursion
  5804. (save-restriction
  5805. (org-narrow-to-subtree)
  5806. (org-content))))
  5807. ((member state '("all" "showall"))
  5808. (show-subtree)))))
  5809. (unless no-cleanup
  5810. (org-cycle-hide-archived-subtrees 'all)
  5811. (org-cycle-hide-drawers 'all)
  5812. (org-cycle-show-empty-lines 'all)))))
  5813. ;; This function uses outline-regexp instead of the more fundamental
  5814. ;; org-outline-regexp so that org-cycle-global works outside of Org
  5815. ;; buffers, where outline-regexp is needed.
  5816. (defun org-overview ()
  5817. "Switch to overview mode, showing only top-level headlines.
  5818. Really, this shows all headlines with level equal or greater than the level
  5819. of the first headline in the buffer. This is important, because if the
  5820. first headline is not level one, then (hide-sublevels 1) gives confusing
  5821. results."
  5822. (interactive)
  5823. (let ((level (save-excursion
  5824. (goto-char (point-min))
  5825. (if (re-search-forward (concat "^" outline-regexp) nil t)
  5826. (progn
  5827. (goto-char (match-beginning 0))
  5828. (funcall outline-level))))))
  5829. (and level (hide-sublevels level))))
  5830. (defun org-content (&optional arg)
  5831. "Show all headlines in the buffer, like a table of contents.
  5832. With numerical argument N, show content up to level N."
  5833. (interactive "P")
  5834. (save-excursion
  5835. ;; Visit all headings and show their offspring
  5836. (and (integerp arg) (org-overview))
  5837. (goto-char (point-max))
  5838. (catch 'exit
  5839. (while (and (progn (condition-case nil
  5840. (outline-previous-visible-heading 1)
  5841. (error (goto-char (point-min))))
  5842. t)
  5843. (looking-at org-outline-regexp))
  5844. (if (integerp arg)
  5845. (show-children (1- arg))
  5846. (show-branches))
  5847. (if (bobp) (throw 'exit nil))))))
  5848. (defun org-optimize-window-after-visibility-change (state)
  5849. "Adjust the window after a change in outline visibility.
  5850. This function is the default value of the hook `org-cycle-hook'."
  5851. (when (get-buffer-window (current-buffer))
  5852. (cond
  5853. ((eq state 'content) nil)
  5854. ((eq state 'all) nil)
  5855. ((eq state 'folded) nil)
  5856. ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
  5857. ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
  5858. (defun org-remove-empty-overlays-at (pos)
  5859. "Remove outline overlays that do not contain non-white stuff."
  5860. (mapc
  5861. (lambda (o)
  5862. (and (eq 'outline (overlay-get o 'invisible))
  5863. (not (string-match "\\S-" (buffer-substring (overlay-start o)
  5864. (overlay-end o))))
  5865. (delete-overlay o)))
  5866. (overlays-at pos)))
  5867. (defun org-clean-visibility-after-subtree-move ()
  5868. "Fix visibility issues after moving a subtree."
  5869. ;; First, find a reasonable region to look at:
  5870. ;; Start two siblings above, end three below
  5871. (let* ((beg (save-excursion
  5872. (and (org-get-last-sibling)
  5873. (org-get-last-sibling))
  5874. (point)))
  5875. (end (save-excursion
  5876. (and (org-get-next-sibling)
  5877. (org-get-next-sibling)
  5878. (org-get-next-sibling))
  5879. (if (org-at-heading-p)
  5880. (point-at-eol)
  5881. (point))))
  5882. (level (looking-at "\\*+"))
  5883. (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
  5884. (save-excursion
  5885. (save-restriction
  5886. (narrow-to-region beg end)
  5887. (when re
  5888. ;; Properly fold already folded siblings
  5889. (goto-char (point-min))
  5890. (while (re-search-forward re nil t)
  5891. (if (and (not (outline-invisible-p))
  5892. (save-excursion
  5893. (goto-char (point-at-eol)) (outline-invisible-p)))
  5894. (hide-entry))))
  5895. (org-cycle-show-empty-lines 'overview)
  5896. (org-cycle-hide-drawers 'overview)))))
  5897. (defun org-cycle-show-empty-lines (state)
  5898. "Show empty lines above all visible headlines.
  5899. The region to be covered depends on STATE when called through
  5900. `org-cycle-hook'. Lisp program can use t for STATE to get the
  5901. entire buffer covered. Note that an empty line is only shown if there
  5902. are at least `org-cycle-separator-lines' empty lines before the headline."
  5903. (when (not (= org-cycle-separator-lines 0))
  5904. (save-excursion
  5905. (let* ((n (abs org-cycle-separator-lines))
  5906. (re (cond
  5907. ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
  5908. ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
  5909. (t (let ((ns (number-to-string (- n 2))))
  5910. (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
  5911. "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
  5912. beg end b e)
  5913. (cond
  5914. ((memq state '(overview contents t))
  5915. (setq beg (point-min) end (point-max)))
  5916. ((memq state '(children folded))
  5917. (setq beg (point) end (progn (org-end-of-subtree t t)
  5918. (beginning-of-line 2)
  5919. (point)))))
  5920. (when beg
  5921. (goto-char beg)
  5922. (while (re-search-forward re end t)
  5923. (unless (get-char-property (match-end 1) 'invisible)
  5924. (setq e (match-end 1))
  5925. (if (< org-cycle-separator-lines 0)
  5926. (setq b (save-excursion
  5927. (goto-char (match-beginning 0))
  5928. (org-back-over-empty-lines)
  5929. (if (save-excursion
  5930. (goto-char (max (point-min) (1- (point))))
  5931. (org-at-heading-p))
  5932. (1- (point))
  5933. (point))))
  5934. (setq b (match-beginning 1)))
  5935. (outline-flag-region b e nil)))))))
  5936. ;; Never hide empty lines at the end of the file.
  5937. (save-excursion
  5938. (goto-char (point-max))
  5939. (outline-previous-heading)
  5940. (outline-end-of-heading)
  5941. (if (and (looking-at "[ \t\n]+")
  5942. (= (match-end 0) (point-max)))
  5943. (outline-flag-region (point) (match-end 0) nil))))
  5944. (defun org-show-empty-lines-in-parent ()
  5945. "Move to the parent and re-show empty lines before visible headlines."
  5946. (save-excursion
  5947. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  5948. (org-cycle-show-empty-lines context))))
  5949. (defun org-files-list ()
  5950. "Return `org-agenda-files' list, plus all open org-mode files.
  5951. This is useful for operations that need to scan all of a user's
  5952. open and agenda-wise Org files."
  5953. (let ((files (mapcar 'expand-file-name (org-agenda-files))))
  5954. (dolist (buf (buffer-list))
  5955. (with-current-buffer buf
  5956. (if (and (derived-mode-p 'org-mode) (buffer-file-name))
  5957. (let ((file (expand-file-name (buffer-file-name))))
  5958. (unless (member file files)
  5959. (push file files))))))
  5960. files))
  5961. (defsubst org-entry-beginning-position ()
  5962. "Return the beginning position of the current entry."
  5963. (save-excursion (outline-back-to-heading t) (point)))
  5964. (defsubst org-entry-end-position ()
  5965. "Return the end position of the current entry."
  5966. (save-excursion (outline-next-heading) (point)))
  5967. (defun org-cycle-hide-drawers (state)
  5968. "Re-hide all drawers after a visibility state change."
  5969. (when (and (derived-mode-p 'org-mode)
  5970. (not (memq state '(overview folded contents))))
  5971. (save-excursion
  5972. (let* ((globalp (memq state '(contents all)))
  5973. (beg (if globalp (point-min) (point)))
  5974. (end (if globalp (point-max)
  5975. (if (eq state 'children)
  5976. (save-excursion (outline-next-heading) (point))
  5977. (org-end-of-subtree t)))))
  5978. (goto-char beg)
  5979. (while (re-search-forward org-drawer-regexp end t)
  5980. (org-flag-drawer t))))))
  5981. (defun org-flag-drawer (flag)
  5982. "When FLAG is non-nil, hide the drawer we are within.
  5983. Otherwise make it visible."
  5984. (save-excursion
  5985. (beginning-of-line 1)
  5986. (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
  5987. (let ((b (match-end 0)))
  5988. (if (re-search-forward
  5989. "^[ \t]*:END:"
  5990. (save-excursion (outline-next-heading) (point)) t)
  5991. (outline-flag-region b (point-at-eol) flag)
  5992. (error ":END: line missing at position %s" b))))))
  5993. (defun org-subtree-end-visible-p ()
  5994. "Is the end of the current subtree visible?"
  5995. (pos-visible-in-window-p
  5996. (save-excursion (org-end-of-subtree t) (point))))
  5997. (defun org-first-headline-recenter (&optional N)
  5998. "Move cursor to the first headline and recenter the headline.
  5999. Optional argument N means put the headline into the Nth line of the window."
  6000. (goto-char (point-min))
  6001. (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
  6002. (beginning-of-line)
  6003. (recenter (prefix-numeric-value N))))
  6004. ;;; Saving and restoring visibility
  6005. (defun org-outline-overlay-data (&optional use-markers)
  6006. "Return a list of the locations of all outline overlays.
  6007. These are overlays with the `invisible' property value `outline'.
  6008. The return value is a list of cons cells, with start and stop
  6009. positions for each overlay.
  6010. If USE-MARKERS is set, return the positions as markers."
  6011. (let (beg end)
  6012. (save-excursion
  6013. (save-restriction
  6014. (widen)
  6015. (delq nil
  6016. (mapcar (lambda (o)
  6017. (when (eq (overlay-get o 'invisible) 'outline)
  6018. (setq beg (overlay-start o)
  6019. end (overlay-end o))
  6020. (and beg end (> end beg)
  6021. (if use-markers
  6022. (cons (move-marker (make-marker) beg)
  6023. (move-marker (make-marker) end))
  6024. (cons beg end)))))
  6025. (overlays-in (point-min) (point-max))))))))
  6026. (defun org-set-outline-overlay-data (data)
  6027. "Create visibility overlays for all positions in DATA.
  6028. DATA should have been made by `org-outline-overlay-data'."
  6029. (let (o)
  6030. (save-excursion
  6031. (save-restriction
  6032. (widen)
  6033. (show-all)
  6034. (mapc (lambda (c)
  6035. (outline-flag-region (car c) (cdr c) t))
  6036. data)))))
  6037. ;;; Folding of blocks
  6038. (defvar org-hide-block-overlays nil
  6039. "Overlays hiding blocks.")
  6040. (make-variable-buffer-local 'org-hide-block-overlays)
  6041. (defun org-block-map (function &optional start end)
  6042. "Call FUNCTION at the head of all source blocks in the current buffer.
  6043. Optional arguments START and END can be used to limit the range."
  6044. (let ((start (or start (point-min)))
  6045. (end (or end (point-max))))
  6046. (save-excursion
  6047. (goto-char start)
  6048. (while (and (< (point) end) (re-search-forward org-block-regexp end t))
  6049. (save-excursion
  6050. (save-match-data
  6051. (goto-char (match-beginning 0))
  6052. (funcall function)))))))
  6053. (defun org-hide-block-toggle-all ()
  6054. "Toggle the visibility of all blocks in the current buffer."
  6055. (org-block-map #'org-hide-block-toggle))
  6056. (defun org-hide-block-all ()
  6057. "Fold all blocks in the current buffer."
  6058. (interactive)
  6059. (org-show-block-all)
  6060. (org-block-map #'org-hide-block-toggle-maybe))
  6061. (defun org-show-block-all ()
  6062. "Unfold all blocks in the current buffer."
  6063. (interactive)
  6064. (mapc 'delete-overlay org-hide-block-overlays)
  6065. (setq org-hide-block-overlays nil))
  6066. (defun org-hide-block-toggle-maybe ()
  6067. "Toggle visibility of block at point."
  6068. (interactive)
  6069. (let ((case-fold-search t))
  6070. (if (save-excursion
  6071. (beginning-of-line 1)
  6072. (looking-at org-block-regexp))
  6073. (progn (org-hide-block-toggle)
  6074. t) ;; to signal that we took action
  6075. nil))) ;; to signal that we did not
  6076. (defun org-hide-block-toggle (&optional force)
  6077. "Toggle the visibility of the current block."
  6078. (interactive)
  6079. (save-excursion
  6080. (beginning-of-line)
  6081. (if (re-search-forward org-block-regexp nil t)
  6082. (let ((start (- (match-beginning 4) 1)) ;; beginning of body
  6083. (end (match-end 0)) ;; end of entire body
  6084. ov)
  6085. (if (memq t (mapcar (lambda (overlay)
  6086. (eq (overlay-get overlay 'invisible)
  6087. 'org-hide-block))
  6088. (overlays-at start)))
  6089. (if (or (not force) (eq force 'off))
  6090. (mapc (lambda (ov)
  6091. (when (member ov org-hide-block-overlays)
  6092. (setq org-hide-block-overlays
  6093. (delq ov org-hide-block-overlays)))
  6094. (when (eq (overlay-get ov 'invisible)
  6095. 'org-hide-block)
  6096. (delete-overlay ov)))
  6097. (overlays-at start)))
  6098. (setq ov (make-overlay start end))
  6099. (overlay-put ov 'invisible 'org-hide-block)
  6100. ;; make the block accessible to isearch
  6101. (overlay-put
  6102. ov 'isearch-open-invisible
  6103. (lambda (ov)
  6104. (when (member ov org-hide-block-overlays)
  6105. (setq org-hide-block-overlays
  6106. (delq ov org-hide-block-overlays)))
  6107. (when (eq (overlay-get ov 'invisible)
  6108. 'org-hide-block)
  6109. (delete-overlay ov))))
  6110. (push ov org-hide-block-overlays)))
  6111. (error "Not looking at a source block"))))
  6112. ;; org-tab-after-check-for-cycling-hook
  6113. (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
  6114. ;; Remove overlays when changing major mode
  6115. (add-hook 'org-mode-hook
  6116. (lambda () (org-add-hook 'change-major-mode-hook
  6117. 'org-show-block-all 'append 'local)))
  6118. ;;; Org-goto
  6119. (defvar org-goto-window-configuration nil)
  6120. (defvar org-goto-marker nil)
  6121. (defvar org-goto-map
  6122. (let ((map (make-sparse-keymap)))
  6123. (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
  6124. (while (setq cmd (pop cmds))
  6125. (substitute-key-definition cmd cmd map global-map)))
  6126. (suppress-keymap map)
  6127. (org-defkey map "\C-m" 'org-goto-ret)
  6128. (org-defkey map [(return)] 'org-goto-ret)
  6129. (org-defkey map [(left)] 'org-goto-left)
  6130. (org-defkey map [(right)] 'org-goto-right)
  6131. (org-defkey map [(control ?g)] 'org-goto-quit)
  6132. (org-defkey map "\C-i" 'org-cycle)
  6133. (org-defkey map [(tab)] 'org-cycle)
  6134. (org-defkey map [(down)] 'outline-next-visible-heading)
  6135. (org-defkey map [(up)] 'outline-previous-visible-heading)
  6136. (if org-goto-auto-isearch
  6137. (if (fboundp 'define-key-after)
  6138. (define-key-after map [t] 'org-goto-local-auto-isearch)
  6139. nil)
  6140. (org-defkey map "q" 'org-goto-quit)
  6141. (org-defkey map "n" 'outline-next-visible-heading)
  6142. (org-defkey map "p" 'outline-previous-visible-heading)
  6143. (org-defkey map "f" 'outline-forward-same-level)
  6144. (org-defkey map "b" 'outline-backward-same-level)
  6145. (org-defkey map "u" 'outline-up-heading))
  6146. (org-defkey map "/" 'org-occur)
  6147. (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
  6148. (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
  6149. (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
  6150. (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
  6151. (org-defkey map "\C-c\C-u" 'outline-up-heading)
  6152. map))
  6153. (defconst org-goto-help
  6154. "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
  6155. RET=jump to location [Q]uit and return to previous location
  6156. \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
  6157. (defvar org-goto-start-pos) ; dynamically scoped parameter
  6158. ;; FIXME: Docstring does not mention both interfaces
  6159. (defun org-goto (&optional alternative-interface)
  6160. "Look up a different location in the current file, keeping current visibility.
  6161. When you want look-up or go to a different location in a
  6162. document, the fastest way is often to fold the entire buffer and
  6163. then dive into the tree. This method has the disadvantage, that
  6164. the previous location will be folded, which may not be what you
  6165. want.
  6166. This command works around this by showing a copy of the current
  6167. buffer in an indirect buffer, in overview mode. You can dive
  6168. into the tree in that copy, use org-occur and incremental search
  6169. to find a location. When pressing RET or `Q', the command
  6170. returns to the original buffer in which the visibility is still
  6171. unchanged. After RET it will also jump to the location selected
  6172. in the indirect buffer and expose the headline hierarchy above.
  6173. With a prefix argument, use the alternative interface: e.g. if
  6174. `org-goto-interface' is 'outline use 'outline-path-completion."
  6175. (interactive "P")
  6176. (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
  6177. (org-refile-use-outline-path t)
  6178. (org-refile-target-verify-function nil)
  6179. (interface
  6180. (if (not alternative-interface)
  6181. org-goto-interface
  6182. (if (eq org-goto-interface 'outline)
  6183. 'outline-path-completion
  6184. 'outline)))
  6185. (org-goto-start-pos (point))
  6186. (selected-point
  6187. (if (eq interface 'outline)
  6188. (car (org-get-location (current-buffer) org-goto-help))
  6189. (let ((pa (org-refile-get-location "Goto" nil nil t)))
  6190. (org-refile-check-position pa)
  6191. (nth 3 pa)))))
  6192. (if selected-point
  6193. (progn
  6194. (org-mark-ring-push org-goto-start-pos)
  6195. (goto-char selected-point)
  6196. (if (or (outline-invisible-p) (org-invisible-p2))
  6197. (org-show-context 'org-goto)))
  6198. (message "Quit"))))
  6199. (defvar org-goto-selected-point nil) ; dynamically scoped parameter
  6200. (defvar org-goto-exit-command nil) ; dynamically scoped parameter
  6201. (defvar org-goto-local-auto-isearch-map) ; defined below
  6202. (defun org-get-location (buf help)
  6203. "Let the user select a location in the Org-mode buffer BUF.
  6204. This function uses a recursive edit. It returns the selected position
  6205. or nil."
  6206. (let ((isearch-mode-map org-goto-local-auto-isearch-map)
  6207. (isearch-hide-immediately nil)
  6208. (isearch-search-fun-function
  6209. (lambda () 'org-goto-local-search-headings))
  6210. (org-goto-selected-point org-goto-exit-command)
  6211. (pop-up-frames nil)
  6212. (special-display-buffer-names nil)
  6213. (special-display-regexps nil)
  6214. (special-display-function nil))
  6215. (save-excursion
  6216. (save-window-excursion
  6217. (delete-other-windows)
  6218. (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
  6219. (org-pop-to-buffer-same-window
  6220. (condition-case nil
  6221. (make-indirect-buffer (current-buffer) "*org-goto*")
  6222. (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
  6223. (with-output-to-temp-buffer "*Help*"
  6224. (princ help))
  6225. (org-fit-window-to-buffer (get-buffer-window "*Help*"))
  6226. (setq buffer-read-only nil)
  6227. (let ((org-startup-truncated t)
  6228. (org-startup-folded nil)
  6229. (org-startup-align-all-tables nil))
  6230. (org-mode)
  6231. (org-overview))
  6232. (setq buffer-read-only t)
  6233. (if (and (boundp 'org-goto-start-pos)
  6234. (integer-or-marker-p org-goto-start-pos))
  6235. (let ((org-show-hierarchy-above t)
  6236. (org-show-siblings t)
  6237. (org-show-following-heading t))
  6238. (goto-char org-goto-start-pos)
  6239. (and (outline-invisible-p) (org-show-context)))
  6240. (goto-char (point-min)))
  6241. (let (org-special-ctrl-a/e) (org-beginning-of-line))
  6242. (message "Select location and press RET")
  6243. (use-local-map org-goto-map)
  6244. (recursive-edit)
  6245. ))
  6246. (kill-buffer "*org-goto*")
  6247. (cons org-goto-selected-point org-goto-exit-command)))
  6248. (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
  6249. (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
  6250. (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
  6251. (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
  6252. (defun org-goto-local-search-headings (string bound noerror)
  6253. "Search and make sure that any matches are in headlines."
  6254. (catch 'return
  6255. (while (if isearch-forward
  6256. (search-forward string bound noerror)
  6257. (search-backward string bound noerror))
  6258. (when (let ((context (mapcar 'car (save-match-data (org-context)))))
  6259. (and (member :headline context)
  6260. (not (member :tags context))))
  6261. (throw 'return (point))))))
  6262. (defun org-goto-local-auto-isearch ()
  6263. "Start isearch."
  6264. (interactive)
  6265. (goto-char (point-min))
  6266. (let ((keys (this-command-keys)))
  6267. (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
  6268. (isearch-mode t)
  6269. (isearch-process-search-char (string-to-char keys)))))
  6270. (defun org-goto-ret (&optional arg)
  6271. "Finish `org-goto' by going to the new location."
  6272. (interactive "P")
  6273. (setq org-goto-selected-point (point)
  6274. org-goto-exit-command 'return)
  6275. (throw 'exit nil))
  6276. (defun org-goto-left ()
  6277. "Finish `org-goto' by going to the new location."
  6278. (interactive)
  6279. (if (org-at-heading-p)
  6280. (progn
  6281. (beginning-of-line 1)
  6282. (setq org-goto-selected-point (point)
  6283. org-goto-exit-command 'left)
  6284. (throw 'exit nil))
  6285. (error "Not on a heading")))
  6286. (defun org-goto-right ()
  6287. "Finish `org-goto' by going to the new location."
  6288. (interactive)
  6289. (if (org-at-heading-p)
  6290. (progn
  6291. (setq org-goto-selected-point (point)
  6292. org-goto-exit-command 'right)
  6293. (throw 'exit nil))
  6294. (error "Not on a heading")))
  6295. (defun org-goto-quit ()
  6296. "Finish `org-goto' without cursor motion."
  6297. (interactive)
  6298. (setq org-goto-selected-point nil)
  6299. (setq org-goto-exit-command 'quit)
  6300. (throw 'exit nil))
  6301. ;;; Indirect buffer display of subtrees
  6302. (defvar org-indirect-dedicated-frame nil
  6303. "This is the frame being used for indirect tree display.")
  6304. (defvar org-last-indirect-buffer nil)
  6305. (defun org-tree-to-indirect-buffer (&optional arg)
  6306. "Create indirect buffer and narrow it to current subtree.
  6307. With numerical prefix ARG, go up to this level and then take that tree.
  6308. If ARG is negative, go up that many levels.
  6309. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  6310. indirect buffer previously made with this command, to avoid proliferation of
  6311. indirect buffers. However, when you call the command with a \
  6312. \\[universal-argument] prefix, or
  6313. when `org-indirect-buffer-display' is `new-frame', the last buffer
  6314. is kept so that you can work with several indirect buffers at the same time.
  6315. If `org-indirect-buffer-display' is `dedicated-frame', the \
  6316. \\[universal-argument] prefix also
  6317. requests that a new frame be made for the new buffer, so that the dedicated
  6318. frame is not changed."
  6319. (interactive "P")
  6320. (let ((cbuf (current-buffer))
  6321. (cwin (selected-window))
  6322. (pos (point))
  6323. beg end level heading ibuf)
  6324. (save-excursion
  6325. (org-back-to-heading t)
  6326. (when (numberp arg)
  6327. (setq level (org-outline-level))
  6328. (if (< arg 0) (setq arg (+ level arg)))
  6329. (while (> (setq level (org-outline-level)) arg)
  6330. (outline-up-heading 1 t)))
  6331. (setq beg (point)
  6332. heading (org-get-heading))
  6333. (org-end-of-subtree t t)
  6334. (if (org-at-heading-p) (backward-char 1))
  6335. (setq end (point)))
  6336. (if (and (buffer-live-p org-last-indirect-buffer)
  6337. (not (eq org-indirect-buffer-display 'new-frame))
  6338. (not arg))
  6339. (kill-buffer org-last-indirect-buffer))
  6340. (setq ibuf (org-get-indirect-buffer cbuf)
  6341. org-last-indirect-buffer ibuf)
  6342. (cond
  6343. ((or (eq org-indirect-buffer-display 'new-frame)
  6344. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  6345. (select-frame (make-frame))
  6346. (delete-other-windows)
  6347. (org-pop-to-buffer-same-window ibuf)
  6348. (org-set-frame-title heading))
  6349. ((eq org-indirect-buffer-display 'dedicated-frame)
  6350. (raise-frame
  6351. (select-frame (or (and org-indirect-dedicated-frame
  6352. (frame-live-p org-indirect-dedicated-frame)
  6353. org-indirect-dedicated-frame)
  6354. (setq org-indirect-dedicated-frame (make-frame)))))
  6355. (delete-other-windows)
  6356. (org-pop-to-buffer-same-window ibuf)
  6357. (org-set-frame-title (concat "Indirect: " heading)))
  6358. ((eq org-indirect-buffer-display 'current-window)
  6359. (org-pop-to-buffer-same-window ibuf))
  6360. ((eq org-indirect-buffer-display 'other-window)
  6361. (pop-to-buffer ibuf))
  6362. (t (error "Invalid value")))
  6363. (if (featurep 'xemacs)
  6364. (save-excursion (org-mode) (turn-on-font-lock)))
  6365. (narrow-to-region beg end)
  6366. (show-all)
  6367. (goto-char pos)
  6368. (run-hook-with-args 'org-cycle-hook 'all)
  6369. (and (window-live-p cwin) (select-window cwin))))
  6370. (defun org-get-indirect-buffer (&optional buffer)
  6371. (setq buffer (or buffer (current-buffer)))
  6372. (let ((n 1) (base (buffer-name buffer)) bname)
  6373. (while (buffer-live-p
  6374. (get-buffer (setq bname (concat base "-" (number-to-string n)))))
  6375. (setq n (1+ n)))
  6376. (condition-case nil
  6377. (make-indirect-buffer buffer bname 'clone)
  6378. (error (make-indirect-buffer buffer bname)))))
  6379. (defun org-set-frame-title (title)
  6380. "Set the title of the current frame to the string TITLE."
  6381. ;; FIXME: how to name a single frame in XEmacs???
  6382. (unless (featurep 'xemacs)
  6383. (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
  6384. ;;;; Structure editing
  6385. ;;; Inserting headlines
  6386. (defun org-previous-line-empty-p ()
  6387. (save-excursion
  6388. (and (not (bobp))
  6389. (or (beginning-of-line 0) t)
  6390. (save-match-data
  6391. (looking-at "[ \t]*$")))))
  6392. (defun org-insert-heading (&optional force-heading invisible-ok)
  6393. "Insert a new heading or item with same depth at point.
  6394. If point is in a plain list and FORCE-HEADING is nil, create a new list item.
  6395. If point is at the beginning of a headline, insert a sibling before the
  6396. current headline. If point is not at the beginning, split the line,
  6397. create the new headline with the text in the current line after point
  6398. \(but see also the variable `org-M-RET-may-split-line').
  6399. When INVISIBLE-OK is set, stop at invisible headlines when going back.
  6400. This is important for non-interactive uses of the command."
  6401. (interactive "P")
  6402. (if (or (= (buffer-size) 0)
  6403. (and (not (save-excursion
  6404. (and (ignore-errors (org-back-to-heading invisible-ok))
  6405. (org-at-heading-p))))
  6406. (or force-heading (not (org-in-item-p)))))
  6407. (progn
  6408. (insert "\n* ")
  6409. (run-hooks 'org-insert-heading-hook))
  6410. (when (or force-heading (not (org-insert-item)))
  6411. (let* ((empty-line-p nil)
  6412. (level nil)
  6413. (on-heading (org-at-heading-p))
  6414. (head (save-excursion
  6415. (condition-case nil
  6416. (progn
  6417. (org-back-to-heading invisible-ok)
  6418. (when (and (not on-heading)
  6419. (featurep 'org-inlinetask)
  6420. (integerp org-inlinetask-min-level)
  6421. (>= (length (match-string 0))
  6422. org-inlinetask-min-level))
  6423. ;; Find a heading level before the inline task
  6424. (while (and (setq level (org-up-heading-safe))
  6425. (>= level org-inlinetask-min-level)))
  6426. (if (org-at-heading-p)
  6427. (org-back-to-heading invisible-ok)
  6428. (error "This should not happen")))
  6429. (setq empty-line-p (org-previous-line-empty-p))
  6430. (match-string 0))
  6431. (error "*"))))
  6432. (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
  6433. (blank (if (eq blank-a 'auto) empty-line-p blank-a))
  6434. pos hide-previous previous-pos)
  6435. (cond
  6436. ((and (org-at-heading-p) (bolp)
  6437. (or (bobp)
  6438. (save-excursion (backward-char 1) (not (outline-invisible-p)))))
  6439. ;; insert before the current line
  6440. (open-line (if blank 2 1)))
  6441. ((and (bolp)
  6442. (not org-insert-heading-respect-content)
  6443. (or (bobp)
  6444. (save-excursion
  6445. (backward-char 1) (not (outline-invisible-p)))))
  6446. ;; insert right here
  6447. nil)
  6448. (t
  6449. ;; somewhere in the line
  6450. (save-excursion
  6451. (setq previous-pos (point-at-bol))
  6452. (end-of-line)
  6453. (setq hide-previous (outline-invisible-p)))
  6454. (and org-insert-heading-respect-content (org-show-subtree))
  6455. (let ((split
  6456. (and (org-get-alist-option org-M-RET-may-split-line 'headline)
  6457. (save-excursion
  6458. (let ((p (point)))
  6459. (goto-char (point-at-bol))
  6460. (and (looking-at org-complex-heading-regexp)
  6461. (match-beginning 4)
  6462. (> p (match-beginning 4)))))))
  6463. tags pos)
  6464. (cond
  6465. (org-insert-heading-respect-content
  6466. (org-end-of-subtree nil t)
  6467. (when (featurep 'org-inlinetask)
  6468. (while (and (not (eobp))
  6469. (looking-at "\\(\\*+\\)[ \t]+")
  6470. (>= (length (match-string 1))
  6471. org-inlinetask-min-level))
  6472. (org-end-of-subtree nil t)))
  6473. (or (bolp) (newline))
  6474. (or (org-previous-line-empty-p)
  6475. (and blank (newline)))
  6476. (open-line 1))
  6477. ((org-at-heading-p)
  6478. (when hide-previous
  6479. (show-children)
  6480. (org-show-entry))
  6481. (looking-at ".*?\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?[ \t]*$")
  6482. (setq tags (and (match-end 2) (match-string 2)))
  6483. (and (match-end 1)
  6484. (delete-region (match-beginning 1) (match-end 1)))
  6485. (setq pos (point-at-bol))
  6486. (or split (end-of-line 1))
  6487. (delete-horizontal-space)
  6488. (if (string-match "\\`\\*+\\'"
  6489. (buffer-substring (point-at-bol) (point)))
  6490. (insert " "))
  6491. (newline (if blank 2 1))
  6492. (when tags
  6493. (save-excursion
  6494. (goto-char pos)
  6495. (end-of-line 1)
  6496. (insert " " tags)
  6497. (org-set-tags nil 'align))))
  6498. (t
  6499. (or split (end-of-line 1))
  6500. (newline (if blank 2 1)))))))
  6501. (insert head) (just-one-space)
  6502. (setq pos (point))
  6503. (end-of-line 1)
  6504. (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
  6505. (when (and org-insert-heading-respect-content hide-previous)
  6506. (save-excursion
  6507. (goto-char previous-pos)
  6508. (hide-subtree)))
  6509. (run-hooks 'org-insert-heading-hook)))))
  6510. (defun org-get-heading (&optional no-tags no-todo)
  6511. "Return the heading of the current entry, without the stars.
  6512. When NO-TAGS is non-nil, don't include tags.
  6513. When NO-TODO is non-nil, don't include TODO keywords."
  6514. (save-excursion
  6515. (org-back-to-heading t)
  6516. (cond
  6517. ((and no-tags no-todo)
  6518. (looking-at org-complex-heading-regexp)
  6519. (match-string 4))
  6520. (no-tags
  6521. (looking-at (concat org-outline-regexp
  6522. "\\(.*?\\)"
  6523. "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
  6524. (match-string 1))
  6525. (no-todo
  6526. (looking-at org-todo-line-regexp)
  6527. (match-string 3))
  6528. (t (looking-at org-heading-regexp)
  6529. (match-string 2)))))
  6530. (defun org-heading-components ()
  6531. "Return the components of the current heading.
  6532. This is a list with the following elements:
  6533. - the level as an integer
  6534. - the reduced level, different if `org-odd-levels-only' is set.
  6535. - the TODO keyword, or nil
  6536. - the priority character, like ?A, or nil if no priority is given
  6537. - the headline text itself, or the tags string if no headline text
  6538. - the tags string, or nil."
  6539. (save-excursion
  6540. (org-back-to-heading t)
  6541. (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
  6542. (list (length (match-string 1))
  6543. (org-reduced-level (length (match-string 1)))
  6544. (org-match-string-no-properties 2)
  6545. (and (match-end 3) (aref (match-string 3) 2))
  6546. (org-match-string-no-properties 4)
  6547. (org-match-string-no-properties 5)))))
  6548. (defun org-get-entry ()
  6549. "Get the entry text, after heading, entire subtree."
  6550. (save-excursion
  6551. (org-back-to-heading t)
  6552. (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
  6553. (defun org-insert-heading-after-current ()
  6554. "Insert a new heading with same level as current, after current subtree."
  6555. (interactive)
  6556. (org-back-to-heading)
  6557. (org-insert-heading)
  6558. (org-move-subtree-down)
  6559. (end-of-line 1))
  6560. (defun org-insert-heading-respect-content ()
  6561. (interactive)
  6562. (let ((org-insert-heading-respect-content t))
  6563. (org-insert-heading t)))
  6564. (defun org-insert-todo-heading-respect-content (&optional force-state)
  6565. (interactive "P")
  6566. (let ((org-insert-heading-respect-content t))
  6567. (org-insert-todo-heading force-state t)))
  6568. (defun org-insert-todo-heading (arg &optional force-heading)
  6569. "Insert a new heading with the same level and TODO state as current heading.
  6570. If the heading has no TODO state, or if the state is DONE, use the first
  6571. state (TODO by default). Also with prefix arg, force first state."
  6572. (interactive "P")
  6573. (when (or force-heading (not (org-insert-item 'checkbox)))
  6574. (org-insert-heading force-heading)
  6575. (save-excursion
  6576. (org-back-to-heading)
  6577. (outline-previous-heading)
  6578. (looking-at org-todo-line-regexp))
  6579. (let*
  6580. ((new-mark-x
  6581. (if (or arg
  6582. (not (match-beginning 2))
  6583. (member (match-string 2) org-done-keywords))
  6584. (car org-todo-keywords-1)
  6585. (match-string 2)))
  6586. (new-mark
  6587. (or
  6588. (run-hook-with-args-until-success
  6589. 'org-todo-get-default-hook new-mark-x nil)
  6590. new-mark-x)))
  6591. (beginning-of-line 1)
  6592. (and (looking-at org-outline-regexp) (goto-char (match-end 0))
  6593. (if org-treat-insert-todo-heading-as-state-change
  6594. (org-todo new-mark)
  6595. (insert new-mark " "))))
  6596. (when org-provide-todo-statistics
  6597. (org-update-parent-todo-statistics))))
  6598. (defun org-insert-subheading (arg)
  6599. "Insert a new subheading and demote it.
  6600. Works for outline headings and for plain lists alike."
  6601. (interactive "P")
  6602. (org-insert-heading arg)
  6603. (cond
  6604. ((org-at-heading-p) (org-do-demote))
  6605. ((org-at-item-p) (org-indent-item))))
  6606. (defun org-insert-todo-subheading (arg)
  6607. "Insert a new subheading with TODO keyword or checkbox and demote it.
  6608. Works for outline headings and for plain lists alike."
  6609. (interactive "P")
  6610. (org-insert-todo-heading arg)
  6611. (cond
  6612. ((org-at-heading-p) (org-do-demote))
  6613. ((org-at-item-p) (org-indent-item))))
  6614. ;;; Promotion and Demotion
  6615. (defvar org-after-demote-entry-hook nil
  6616. "Hook run after an entry has been demoted.
  6617. The cursor will be at the beginning of the entry.
  6618. When a subtree is being demoted, the hook will be called for each node.")
  6619. (defvar org-after-promote-entry-hook nil
  6620. "Hook run after an entry has been promoted.
  6621. The cursor will be at the beginning of the entry.
  6622. When a subtree is being promoted, the hook will be called for each node.")
  6623. (defun org-promote-subtree ()
  6624. "Promote the entire subtree.
  6625. See also `org-promote'."
  6626. (interactive)
  6627. (save-excursion
  6628. (org-with-limited-levels (org-map-tree 'org-promote)))
  6629. (org-fix-position-after-promote))
  6630. (defun org-demote-subtree ()
  6631. "Demote the entire subtree. See `org-demote'.
  6632. See also `org-promote'."
  6633. (interactive)
  6634. (save-excursion
  6635. (org-with-limited-levels (org-map-tree 'org-demote)))
  6636. (org-fix-position-after-promote))
  6637. (defun org-do-promote ()
  6638. "Promote the current heading higher up the tree.
  6639. If the region is active in `transient-mark-mode', promote all headings
  6640. in the region."
  6641. (interactive)
  6642. (save-excursion
  6643. (if (org-region-active-p)
  6644. (org-map-region 'org-promote (region-beginning) (region-end))
  6645. (org-promote)))
  6646. (org-fix-position-after-promote))
  6647. (defun org-do-demote ()
  6648. "Demote the current heading lower down the tree.
  6649. If the region is active in `transient-mark-mode', demote all headings
  6650. in the region."
  6651. (interactive)
  6652. (save-excursion
  6653. (if (org-region-active-p)
  6654. (org-map-region 'org-demote (region-beginning) (region-end))
  6655. (org-demote)))
  6656. (org-fix-position-after-promote))
  6657. (defun org-fix-position-after-promote ()
  6658. "Make sure that after pro/demotion cursor position is right."
  6659. (let ((pos (point)))
  6660. (when (save-excursion
  6661. (beginning-of-line 1)
  6662. (looking-at org-todo-line-regexp)
  6663. (or (equal pos (match-end 1)) (equal pos (match-end 2))))
  6664. (cond ((eobp) (insert " "))
  6665. ((eolp) (insert " "))
  6666. ((equal (char-after) ?\ ) (forward-char 1))))))
  6667. (defun org-current-level ()
  6668. "Return the level of the current entry, or nil if before the first headline.
  6669. The level is the number of stars at the beginning of the headline."
  6670. (save-excursion
  6671. (org-with-limited-levels
  6672. (if (ignore-errors (org-back-to-heading t))
  6673. (funcall outline-level)))))
  6674. (defun org-get-previous-line-level ()
  6675. "Return the outline depth of the last headline before the current line.
  6676. Returns 0 for the first headline in the buffer, and nil if before the
  6677. first headline."
  6678. (let ((current-level (org-current-level))
  6679. (prev-level (when (> (line-number-at-pos) 1)
  6680. (save-excursion
  6681. (beginning-of-line 0)
  6682. (org-current-level)))))
  6683. (cond ((null current-level) nil) ; Before first headline
  6684. ((null prev-level) 0) ; At first headline
  6685. (prev-level))))
  6686. (defun org-reduced-level (l)
  6687. "Compute the effective level of a heading.
  6688. This takes into account the setting of `org-odd-levels-only'."
  6689. (cond
  6690. ((zerop l) 0)
  6691. (org-odd-levels-only (1+ (floor (/ l 2))))
  6692. (t l)))
  6693. (defun org-level-increment ()
  6694. "Return the number of stars that will be added or removed at a
  6695. time to headlines when structure editing, based on the value of
  6696. `org-odd-levels-only'."
  6697. (if org-odd-levels-only 2 1))
  6698. (defun org-get-valid-level (level &optional change)
  6699. "Rectify a level change under the influence of `org-odd-levels-only'
  6700. LEVEL is a current level, CHANGE is by how much the level should be
  6701. modified. Even if CHANGE is nil, LEVEL may be returned modified because
  6702. even level numbers will become the next higher odd number."
  6703. (if org-odd-levels-only
  6704. (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
  6705. ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
  6706. ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
  6707. (max 1 (+ level (or change 0)))))
  6708. (if (boundp 'define-obsolete-function-alias)
  6709. (if (or (featurep 'xemacs) (< emacs-major-version 23))
  6710. (define-obsolete-function-alias 'org-get-legal-level
  6711. 'org-get-valid-level)
  6712. (define-obsolete-function-alias 'org-get-legal-level
  6713. 'org-get-valid-level "23.1")))
  6714. (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
  6715. ;; ̀org-with-limited-levels'
  6716. (defun org-promote ()
  6717. "Promote the current heading higher up the tree.
  6718. If the region is active in `transient-mark-mode', promote all headings
  6719. in the region."
  6720. (org-back-to-heading t)
  6721. (let* ((level (save-match-data (funcall outline-level)))
  6722. (after-change-functions (remove 'flyspell-after-change-function
  6723. after-change-functions))
  6724. (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
  6725. (diff (abs (- level (length up-head) -1))))
  6726. (cond ((and (= level 1) org-called-with-limited-levels
  6727. org-allow-promoting-top-level-subtree)
  6728. (replace-match "# " nil t))
  6729. ((= level 1)
  6730. (error "Cannot promote to level 0. UNDO to recover if necessary"))
  6731. (t (replace-match up-head nil t)))
  6732. ;; Fixup tag positioning
  6733. (unless (= level 1)
  6734. (and org-auto-align-tags (org-set-tags nil t))
  6735. (if org-adapt-indentation (org-fixup-indentation (- diff))))
  6736. (run-hooks 'org-after-promote-entry-hook)))
  6737. (defun org-demote ()
  6738. "Demote the current heading lower down the tree.
  6739. If the region is active in `transient-mark-mode', demote all headings
  6740. in the region."
  6741. (org-back-to-heading t)
  6742. (let* ((level (save-match-data (funcall outline-level)))
  6743. (after-change-functions (remove 'flyspell-after-change-function
  6744. after-change-functions))
  6745. (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
  6746. (diff (abs (- level (length down-head) -1))))
  6747. (replace-match down-head nil t)
  6748. ;; Fixup tag positioning
  6749. (and org-auto-align-tags (org-set-tags nil t))
  6750. (if org-adapt-indentation (org-fixup-indentation diff))
  6751. (run-hooks 'org-after-demote-entry-hook)))
  6752. (defun org-cycle-level ()
  6753. "Cycle the level of an empty headline through possible states.
  6754. This goes first to child, then to parent, level, then up the hierarchy.
  6755. After top level, it switches back to sibling level."
  6756. (interactive)
  6757. (let ((org-adapt-indentation nil))
  6758. (when (org-point-at-end-of-empty-headline)
  6759. (setq this-command 'org-cycle-level) ; Only needed for caching
  6760. (let ((cur-level (org-current-level))
  6761. (prev-level (org-get-previous-line-level)))
  6762. (cond
  6763. ;; If first headline in file, promote to top-level.
  6764. ((= prev-level 0)
  6765. (loop repeat (/ (- cur-level 1) (org-level-increment))
  6766. do (org-do-promote)))
  6767. ;; If same level as prev, demote one.
  6768. ((= prev-level cur-level)
  6769. (org-do-demote))
  6770. ;; If parent is top-level, promote to top level if not already.
  6771. ((= prev-level 1)
  6772. (loop repeat (/ (- cur-level 1) (org-level-increment))
  6773. do (org-do-promote)))
  6774. ;; If top-level, return to prev-level.
  6775. ((= cur-level 1)
  6776. (loop repeat (/ (- prev-level 1) (org-level-increment))
  6777. do (org-do-demote)))
  6778. ;; If less than prev-level, promote one.
  6779. ((< cur-level prev-level)
  6780. (org-do-promote))
  6781. ;; If deeper than prev-level, promote until higher than
  6782. ;; prev-level.
  6783. ((> cur-level prev-level)
  6784. (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
  6785. do (org-do-promote))))
  6786. t))))
  6787. (defun org-map-tree (fun)
  6788. "Call FUN for every heading underneath the current one."
  6789. (org-back-to-heading)
  6790. (let ((level (funcall outline-level)))
  6791. (save-excursion
  6792. (funcall fun)
  6793. (while (and (progn
  6794. (outline-next-heading)
  6795. (> (funcall outline-level) level))
  6796. (not (eobp)))
  6797. (funcall fun)))))
  6798. (defun org-map-region (fun beg end)
  6799. "Call FUN for every heading between BEG and END."
  6800. (let ((org-ignore-region t))
  6801. (save-excursion
  6802. (setq end (copy-marker end))
  6803. (goto-char beg)
  6804. (if (and (re-search-forward org-outline-regexp-bol nil t)
  6805. (< (point) end))
  6806. (funcall fun))
  6807. (while (and (progn
  6808. (outline-next-heading)
  6809. (< (point) end))
  6810. (not (eobp)))
  6811. (funcall fun)))))
  6812. (defvar org-property-end-re) ; silence byte-compiler
  6813. (defun org-fixup-indentation (diff)
  6814. "Change the indentation in the current entry by DIFF.
  6815. However, if any line in the current entry has no indentation, or if it
  6816. would end up with no indentation after the change, nothing at all is done."
  6817. (save-excursion
  6818. (let ((end (save-excursion (outline-next-heading)
  6819. (point-marker)))
  6820. (prohibit (if (> diff 0)
  6821. "^\\S-"
  6822. (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
  6823. col)
  6824. (unless (save-excursion (end-of-line 1)
  6825. (re-search-forward prohibit end t))
  6826. (while (and (< (point) end)
  6827. (re-search-forward "^[ \t]+" end t))
  6828. (goto-char (match-end 0))
  6829. (setq col (current-column))
  6830. (if (< diff 0) (replace-match ""))
  6831. (org-indent-to-column (+ diff col))))
  6832. (move-marker end nil))))
  6833. (defun org-convert-to-odd-levels ()
  6834. "Convert an org-mode file with all levels allowed to one with odd levels.
  6835. This will leave level 1 alone, convert level 2 to level 3, level 3 to
  6836. level 5 etc."
  6837. (interactive)
  6838. (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
  6839. (let ((outline-level 'org-outline-level)
  6840. (org-odd-levels-only nil) n)
  6841. (save-excursion
  6842. (goto-char (point-min))
  6843. (while (re-search-forward "^\\*\\*+ " nil t)
  6844. (setq n (- (length (match-string 0)) 2))
  6845. (while (>= (setq n (1- n)) 0)
  6846. (org-demote))
  6847. (end-of-line 1))))))
  6848. (defun org-convert-to-oddeven-levels ()
  6849. "Convert an org-mode file with only odd levels to one with odd/even levels.
  6850. This promotes level 3 to level 2, level 5 to level 3 etc. If the
  6851. file contains a section with an even level, conversion would
  6852. destroy the structure of the file. An error is signaled in this
  6853. case."
  6854. (interactive)
  6855. (goto-char (point-min))
  6856. ;; First check if there are no even levels
  6857. (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
  6858. (org-show-context t)
  6859. (error "Not all levels are odd in this file. Conversion not possible"))
  6860. (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
  6861. (let ((outline-regexp org-outline-regexp)
  6862. (outline-level 'org-outline-level)
  6863. (org-odd-levels-only nil) n)
  6864. (save-excursion
  6865. (goto-char (point-min))
  6866. (while (re-search-forward "^\\*\\*+ " nil t)
  6867. (setq n (/ (1- (length (match-string 0))) 2))
  6868. (while (>= (setq n (1- n)) 0)
  6869. (org-promote))
  6870. (end-of-line 1))))))
  6871. (defun org-tr-level (n)
  6872. "Make N odd if required."
  6873. (if org-odd-levels-only (1+ (/ n 2)) n))
  6874. ;;; Vertical tree motion, cutting and pasting of subtrees
  6875. (defun org-move-subtree-up (&optional arg)
  6876. "Move the current subtree up past ARG headlines of the same level."
  6877. (interactive "p")
  6878. (org-move-subtree-down (- (prefix-numeric-value arg))))
  6879. (defun org-move-subtree-down (&optional arg)
  6880. "Move the current subtree down past ARG headlines of the same level."
  6881. (interactive "p")
  6882. (setq arg (prefix-numeric-value arg))
  6883. (let ((movfunc (if (> arg 0) 'org-get-next-sibling
  6884. 'org-get-last-sibling))
  6885. (ins-point (make-marker))
  6886. (cnt (abs arg))
  6887. (col (current-column))
  6888. beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
  6889. ;; Select the tree
  6890. (org-back-to-heading)
  6891. (setq beg0 (point))
  6892. (save-excursion
  6893. (setq ne-beg (org-back-over-empty-lines))
  6894. (setq beg (point)))
  6895. (save-match-data
  6896. (save-excursion (outline-end-of-heading)
  6897. (setq folded (outline-invisible-p)))
  6898. (outline-end-of-subtree))
  6899. (outline-next-heading)
  6900. (setq ne-end (org-back-over-empty-lines))
  6901. (setq end (point))
  6902. (goto-char beg0)
  6903. (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
  6904. ;; include less whitespace
  6905. (save-excursion
  6906. (goto-char beg)
  6907. (forward-line (- ne-beg ne-end))
  6908. (setq beg (point))))
  6909. ;; Find insertion point, with error handling
  6910. (while (> cnt 0)
  6911. (or (and (funcall movfunc) (looking-at org-outline-regexp))
  6912. (progn (goto-char beg0)
  6913. (error "Cannot move past superior level or buffer limit")))
  6914. (setq cnt (1- cnt)))
  6915. (if (> arg 0)
  6916. ;; Moving forward - still need to move over subtree
  6917. (progn (org-end-of-subtree t t)
  6918. (save-excursion
  6919. (org-back-over-empty-lines)
  6920. (or (bolp) (newline)))))
  6921. (setq ne-ins (org-back-over-empty-lines))
  6922. (move-marker ins-point (point))
  6923. (setq txt (buffer-substring beg end))
  6924. (org-save-markers-in-region beg end)
  6925. (delete-region beg end)
  6926. (org-remove-empty-overlays-at beg)
  6927. (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
  6928. (or (bobp) (outline-flag-region (1- (point)) (point) nil))
  6929. (and (not (bolp)) (looking-at "\n") (forward-char 1))
  6930. (let ((bbb (point)))
  6931. (insert-before-markers txt)
  6932. (org-reinstall-markers-in-region bbb)
  6933. (move-marker ins-point bbb))
  6934. (or (bolp) (insert "\n"))
  6935. (setq ins-end (point))
  6936. (goto-char ins-point)
  6937. (org-skip-whitespace)
  6938. (when (and (< arg 0)
  6939. (org-first-sibling-p)
  6940. (> ne-ins ne-beg))
  6941. ;; Move whitespace back to beginning
  6942. (save-excursion
  6943. (goto-char ins-end)
  6944. (let ((kill-whole-line t))
  6945. (kill-line (- ne-ins ne-beg)) (point)))
  6946. (insert (make-string (- ne-ins ne-beg) ?\n)))
  6947. (move-marker ins-point nil)
  6948. (if folded
  6949. (hide-subtree)
  6950. (org-show-entry)
  6951. (show-children)
  6952. (org-cycle-hide-drawers 'children))
  6953. (org-clean-visibility-after-subtree-move)
  6954. ;; move back to the initial column we were at
  6955. (move-to-column col)))
  6956. (defvar org-subtree-clip ""
  6957. "Clipboard for cut and paste of subtrees.
  6958. This is actually only a copy of the kill, because we use the normal kill
  6959. ring. We need it to check if the kill was created by `org-copy-subtree'.")
  6960. (defvar org-subtree-clip-folded nil
  6961. "Was the last copied subtree folded?
  6962. This is used to fold the tree back after pasting.")
  6963. (defun org-cut-subtree (&optional n)
  6964. "Cut the current subtree into the clipboard.
  6965. With prefix arg N, cut this many sequential subtrees.
  6966. This is a short-hand for marking the subtree and then cutting it."
  6967. (interactive "p")
  6968. (org-copy-subtree n 'cut))
  6969. (defun org-copy-subtree (&optional n cut force-store-markers)
  6970. "Cut the current subtree into the clipboard.
  6971. With prefix arg N, cut this many sequential subtrees.
  6972. This is a short-hand for marking the subtree and then copying it.
  6973. If CUT is non-nil, actually cut the subtree.
  6974. If FORCE-STORE-MARKERS is non-nil, store the relative locations
  6975. of some markers in the region, even if CUT is non-nil. This is
  6976. useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
  6977. (interactive "p")
  6978. (let (beg end folded (beg0 (point)))
  6979. (if (org-called-interactively-p 'any)
  6980. (org-back-to-heading nil) ; take what looks like a subtree
  6981. (org-back-to-heading t)) ; take what is really there
  6982. (org-back-over-empty-lines)
  6983. (setq beg (point))
  6984. (skip-chars-forward " \t\r\n")
  6985. (save-match-data
  6986. (save-excursion (outline-end-of-heading)
  6987. (setq folded (outline-invisible-p)))
  6988. (condition-case nil
  6989. (org-forward-same-level (1- n) t)
  6990. (error nil))
  6991. (org-end-of-subtree t t))
  6992. (org-back-over-empty-lines)
  6993. (setq end (point))
  6994. (goto-char beg0)
  6995. (when (> end beg)
  6996. (setq org-subtree-clip-folded folded)
  6997. (when (or cut force-store-markers)
  6998. (org-save-markers-in-region beg end))
  6999. (if cut (kill-region beg end) (copy-region-as-kill beg end))
  7000. (setq org-subtree-clip (current-kill 0))
  7001. (message "%s: Subtree(s) with %d characters"
  7002. (if cut "Cut" "Copied")
  7003. (length org-subtree-clip)))))
  7004. (defun org-paste-subtree (&optional level tree for-yank)
  7005. "Paste the clipboard as a subtree, with modification of headline level.
  7006. The entire subtree is promoted or demoted in order to match a new headline
  7007. level.
  7008. If the cursor is at the beginning of a headline, the same level as
  7009. that headline is used to paste the tree
  7010. If not, the new level is derived from the *visible* headings
  7011. before and after the insertion point, and taken to be the inferior headline
  7012. level of the two. So if the previous visible heading is level 3 and the
  7013. next is level 4 (or vice versa), level 4 will be used for insertion.
  7014. This makes sure that the subtree remains an independent subtree and does
  7015. not swallow low level entries.
  7016. You can also force a different level, either by using a numeric prefix
  7017. argument, or by inserting the heading marker by hand. For example, if the
  7018. cursor is after \"*****\", then the tree will be shifted to level 5.
  7019. If optional TREE is given, use this text instead of the kill ring.
  7020. When FOR-YANK is set, this is called by `org-yank'. In this case, do not
  7021. move back over whitespace before inserting, and move point to the end of
  7022. the inserted text when done."
  7023. (interactive "P")
  7024. (setq tree (or tree (and kill-ring (current-kill 0))))
  7025. (unless (org-kill-is-subtree-p tree)
  7026. (error "%s"
  7027. (substitute-command-keys
  7028. "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
  7029. (org-with-limited-levels
  7030. (let* ((visp (not (outline-invisible-p)))
  7031. (txt tree)
  7032. (^re_ "\\(\\*+\\)[ \t]*")
  7033. (old-level (if (string-match org-outline-regexp-bol txt)
  7034. (- (match-end 0) (match-beginning 0) 1)
  7035. -1))
  7036. (force-level (cond (level (prefix-numeric-value level))
  7037. ((and (looking-at "[ \t]*$")
  7038. (string-match
  7039. "^\\*+$" (buffer-substring
  7040. (point-at-bol) (point))))
  7041. (- (match-end 1) (match-beginning 1)))
  7042. ((and (bolp)
  7043. (looking-at org-outline-regexp))
  7044. (- (match-end 0) (point) 1))
  7045. (t nil)))
  7046. (previous-level (save-excursion
  7047. (condition-case nil
  7048. (progn
  7049. (outline-previous-visible-heading 1)
  7050. (if (looking-at ^re_)
  7051. (- (match-end 0) (match-beginning 0) 1)
  7052. 1))
  7053. (error 1))))
  7054. (next-level (save-excursion
  7055. (condition-case nil
  7056. (progn
  7057. (or (looking-at org-outline-regexp)
  7058. (outline-next-visible-heading 1))
  7059. (if (looking-at ^re_)
  7060. (- (match-end 0) (match-beginning 0) 1)
  7061. 1))
  7062. (error 1))))
  7063. (new-level (or force-level (max previous-level next-level)))
  7064. (shift (if (or (= old-level -1)
  7065. (= new-level -1)
  7066. (= old-level new-level))
  7067. 0
  7068. (- new-level old-level)))
  7069. (delta (if (> shift 0) -1 1))
  7070. (func (if (> shift 0) 'org-demote 'org-promote))
  7071. (org-odd-levels-only nil)
  7072. beg end newend)
  7073. ;; Remove the forced level indicator
  7074. (if force-level
  7075. (delete-region (point-at-bol) (point)))
  7076. ;; Paste
  7077. (beginning-of-line (if (bolp) 1 2))
  7078. (unless for-yank (org-back-over-empty-lines))
  7079. (setq beg (point))
  7080. (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
  7081. (insert-before-markers txt)
  7082. (unless (string-match "\n\\'" txt) (insert "\n"))
  7083. (setq newend (point))
  7084. (org-reinstall-markers-in-region beg)
  7085. (setq end (point))
  7086. (goto-char beg)
  7087. (skip-chars-forward " \t\n\r")
  7088. (setq beg (point))
  7089. (if (and (outline-invisible-p) visp)
  7090. (save-excursion (outline-show-heading)))
  7091. ;; Shift if necessary
  7092. (unless (= shift 0)
  7093. (save-restriction
  7094. (narrow-to-region beg end)
  7095. (while (not (= shift 0))
  7096. (org-map-region func (point-min) (point-max))
  7097. (setq shift (+ delta shift)))
  7098. (goto-char (point-min))
  7099. (setq newend (point-max))))
  7100. (when (or (org-called-interactively-p 'interactive) for-yank)
  7101. (message "Clipboard pasted as level %d subtree" new-level))
  7102. (if (and (not for-yank) ; in this case, org-yank will decide about folding
  7103. kill-ring
  7104. (eq org-subtree-clip (current-kill 0))
  7105. org-subtree-clip-folded)
  7106. ;; The tree was folded before it was killed/copied
  7107. (hide-subtree))
  7108. (and for-yank (goto-char newend)))))
  7109. (defun org-kill-is-subtree-p (&optional txt)
  7110. "Check if the current kill is an outline subtree, or a set of trees.
  7111. Returns nil if kill does not start with a headline, or if the first
  7112. headline level is not the largest headline level in the tree.
  7113. So this will actually accept several entries of equal levels as well,
  7114. which is OK for `org-paste-subtree'.
  7115. If optional TXT is given, check this string instead of the current kill."
  7116. (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
  7117. (re (org-get-limited-outline-regexp))
  7118. (^re (concat "^" re))
  7119. (start-level (and kill
  7120. (string-match
  7121. (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
  7122. kill)
  7123. (- (match-end 2) (match-beginning 2) 1)))
  7124. (start (1+ (or (match-beginning 2) -1))))
  7125. (if (not start-level)
  7126. (progn
  7127. nil) ;; does not even start with a heading
  7128. (catch 'exit
  7129. (while (setq start (string-match ^re kill (1+ start)))
  7130. (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
  7131. (throw 'exit nil)))
  7132. t))))
  7133. (defvar org-markers-to-move nil
  7134. "Markers that should be moved with a cut-and-paste operation.
  7135. Those markers are stored together with their positions relative to
  7136. the start of the region.")
  7137. (defun org-save-markers-in-region (beg end)
  7138. "Check markers in region.
  7139. If these markers are between BEG and END, record their position relative
  7140. to BEG, so that after moving the block of text, we can put the markers back
  7141. into place.
  7142. This function gets called just before an entry or tree gets cut from the
  7143. buffer. After re-insertion, `org-reinstall-markers-in-region' must be
  7144. called immediately, to move the markers with the entries."
  7145. (setq org-markers-to-move nil)
  7146. (when (featurep 'org-clock)
  7147. (org-clock-save-markers-for-cut-and-paste beg end))
  7148. (when (featurep 'org-agenda)
  7149. (org-agenda-save-markers-for-cut-and-paste beg end)))
  7150. (defun org-check-and-save-marker (marker beg end)
  7151. "Check if MARKER is between BEG and END.
  7152. If yes, remember the marker and the distance to BEG."
  7153. (when (and (marker-buffer marker)
  7154. (equal (marker-buffer marker) (current-buffer)))
  7155. (if (and (>= marker beg) (< marker end))
  7156. (push (cons marker (- marker beg)) org-markers-to-move))))
  7157. (defun org-reinstall-markers-in-region (beg)
  7158. "Move all remembered markers to their position relative to BEG."
  7159. (mapc (lambda (x)
  7160. (move-marker (car x) (+ beg (cdr x))))
  7161. org-markers-to-move)
  7162. (setq org-markers-to-move nil))
  7163. (defun org-narrow-to-subtree ()
  7164. "Narrow buffer to the current subtree."
  7165. (interactive)
  7166. (save-excursion
  7167. (save-match-data
  7168. (org-with-limited-levels
  7169. (narrow-to-region
  7170. (progn (org-back-to-heading t) (point))
  7171. (progn (org-end-of-subtree t t)
  7172. (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
  7173. (point)))))))
  7174. (defun org-narrow-to-block ()
  7175. "Narrow buffer to the current block."
  7176. (interactive)
  7177. (let* ((case-fold-search t)
  7178. (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
  7179. "^[ \t]*#\\+end_.*")))
  7180. (if blockp
  7181. (narrow-to-region (car blockp) (cdr blockp))
  7182. (error "Not in a block"))))
  7183. (eval-when-compile
  7184. (defvar org-property-drawer-re))
  7185. (defvar org-property-start-re) ;; defined below
  7186. (defun org-clone-subtree-with-time-shift (n &optional shift)
  7187. "Clone the task (subtree) at point N times.
  7188. The clones will be inserted as siblings.
  7189. In interactive use, the user will be prompted for the number of
  7190. clones to be produced, and for a time SHIFT, which may be a
  7191. repeater as used in time stamps, for example `+3d'.
  7192. When a valid repeater is given and the entry contains any time
  7193. stamps, the clones will become a sequence in time, with time
  7194. stamps in the subtree shifted for each clone produced. If SHIFT
  7195. is nil or the empty string, time stamps will be left alone. The
  7196. ID property of the original subtree is removed.
  7197. If the original subtree did contain time stamps with a repeater,
  7198. the following will happen:
  7199. - the repeater will be removed in each clone
  7200. - an additional clone will be produced, with the current, unshifted
  7201. date(s) in the entry.
  7202. - the original entry will be placed *after* all the clones, with
  7203. repeater intact.
  7204. - the start days in the repeater in the original entry will be shifted
  7205. to past the last clone.
  7206. In this way you can spell out a number of instances of a repeating task,
  7207. and still retain the repeater to cover future instances of the task."
  7208. (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
  7209. (let (beg end template task idprop
  7210. shift-n shift-what doshift nmin nmax (n-no-remove -1)
  7211. (drawer-re org-drawer-regexp))
  7212. (if (not (and (integerp n) (> n 0)))
  7213. (error "Invalid number of replications %s" n))
  7214. (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
  7215. (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
  7216. shift)))
  7217. (error "Invalid shift specification %s" shift))
  7218. (when doshift
  7219. (setq shift-n (string-to-number (match-string 1 shift))
  7220. shift-what (cdr (assoc (match-string 2 shift)
  7221. '(("d" . day) ("w" . week)
  7222. ("m" . month) ("y" . year))))))
  7223. (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
  7224. (setq nmin 1 nmax n)
  7225. (org-back-to-heading t)
  7226. (setq beg (point))
  7227. (setq idprop (org-entry-get nil "ID"))
  7228. (org-end-of-subtree t t)
  7229. (or (bolp) (insert "\n"))
  7230. (setq end (point))
  7231. (setq template (buffer-substring beg end))
  7232. (when (and doshift
  7233. (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
  7234. (delete-region beg end)
  7235. (setq end beg)
  7236. (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
  7237. (goto-char end)
  7238. (loop for n from nmin to nmax do
  7239. ;; prepare clone
  7240. (with-temp-buffer
  7241. (insert template)
  7242. (org-mode)
  7243. (goto-char (point-min))
  7244. (org-show-subtree)
  7245. (and idprop (if org-clone-delete-id
  7246. (org-entry-delete nil "ID")
  7247. (org-id-get-create t)))
  7248. (unless (= n 0)
  7249. (while (re-search-forward "^[ \t]*CLOCK:.*$" nil t)
  7250. (kill-whole-line))
  7251. (goto-char (point-min))
  7252. (while (re-search-forward drawer-re nil t)
  7253. (mapc (lambda (d)
  7254. (org-remove-empty-drawer-at d (point))) org-drawers)))
  7255. (goto-char (point-min))
  7256. (when doshift
  7257. (while (re-search-forward org-ts-regexp-both nil t)
  7258. (org-timestamp-change (* n shift-n) shift-what))
  7259. (unless (= n n-no-remove)
  7260. (goto-char (point-min))
  7261. (while (re-search-forward org-ts-regexp nil t)
  7262. (save-excursion
  7263. (goto-char (match-beginning 0))
  7264. (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
  7265. (delete-region (match-beginning 1) (match-end 1)))))))
  7266. (setq task (buffer-string)))
  7267. (insert task))
  7268. (goto-char beg)))
  7269. ;;; Outline Sorting
  7270. (defun org-sort (with-case)
  7271. "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
  7272. Optional argument WITH-CASE means sort case-sensitively."
  7273. (interactive "P")
  7274. (cond
  7275. ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
  7276. ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
  7277. (t
  7278. (org-call-with-arg 'org-sort-entries with-case))))
  7279. (defun org-sort-remove-invisible (s)
  7280. (remove-text-properties 0 (length s) org-rm-props s)
  7281. (while (string-match org-bracket-link-regexp s)
  7282. (setq s (replace-match (if (match-end 2)
  7283. (match-string 3 s)
  7284. (match-string 1 s)) t t s)))
  7285. s)
  7286. (defvar org-priority-regexp) ; defined later in the file
  7287. (defvar org-after-sorting-entries-or-items-hook nil
  7288. "Hook that is run after a bunch of entries or items have been sorted.
  7289. When children are sorted, the cursor is in the parent line when this
  7290. hook gets called. When a region or a plain list is sorted, the cursor
  7291. will be in the first entry of the sorted region/list.")
  7292. (defun org-sort-entries
  7293. (&optional with-case sorting-type getkey-func compare-func property)
  7294. "Sort entries on a certain level of an outline tree.
  7295. If there is an active region, the entries in the region are sorted.
  7296. Else, if the cursor is before the first entry, sort the top-level items.
  7297. Else, the children of the entry at point are sorted.
  7298. Sorting can be alphabetically, numerically, by date/time as given by
  7299. a time stamp, by a property or by priority.
  7300. The command prompts for the sorting type unless it has been given to the
  7301. function through the SORTING-TYPE argument, which needs to be a character,
  7302. \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
  7303. precise meaning of each character:
  7304. n Numerically, by converting the beginning of the entry/item to a number.
  7305. a Alphabetically, ignoring the TODO keyword and the priority, if any.
  7306. t By date/time, either the first active time stamp in the entry, or, if
  7307. none exist, by the first inactive one.
  7308. s By the scheduled date/time.
  7309. d By deadline date/time.
  7310. c By creation time, which is assumed to be the first inactive time stamp
  7311. at the beginning of a line.
  7312. p By priority according to the cookie.
  7313. r By the value of a property.
  7314. Capital letters will reverse the sort order.
  7315. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
  7316. called with point at the beginning of the record. It must return either
  7317. a string or a number that should serve as the sorting key for that record.
  7318. Comparing entries ignores case by default. However, with an optional argument
  7319. WITH-CASE, the sorting considers case as well."
  7320. (interactive "P")
  7321. (let ((case-func (if with-case 'identity 'downcase))
  7322. start beg end stars re re2
  7323. txt what tmp)
  7324. ;; Find beginning and end of region to sort
  7325. (cond
  7326. ((org-region-active-p)
  7327. ;; we will sort the region
  7328. (setq end (region-end)
  7329. what "region")
  7330. (goto-char (region-beginning))
  7331. (if (not (org-at-heading-p)) (outline-next-heading))
  7332. (setq start (point)))
  7333. ((or (org-at-heading-p)
  7334. (condition-case nil (progn (org-back-to-heading) t) (error nil)))
  7335. ;; we will sort the children of the current headline
  7336. (org-back-to-heading)
  7337. (setq start (point)
  7338. end (progn (org-end-of-subtree t t)
  7339. (or (bolp) (insert "\n"))
  7340. (org-back-over-empty-lines)
  7341. (point))
  7342. what "children")
  7343. (goto-char start)
  7344. (show-subtree)
  7345. (outline-next-heading))
  7346. (t
  7347. ;; we will sort the top-level entries in this file
  7348. (goto-char (point-min))
  7349. (or (org-at-heading-p) (outline-next-heading))
  7350. (setq start (point))
  7351. (goto-char (point-max))
  7352. (beginning-of-line 1)
  7353. (when (looking-at ".*?\\S-")
  7354. ;; File ends in a non-white line
  7355. (end-of-line 1)
  7356. (insert "\n"))
  7357. (setq end (point-max))
  7358. (setq what "top-level")
  7359. (goto-char start)
  7360. (show-all)))
  7361. (setq beg (point))
  7362. (if (>= beg end) (error "Nothing to sort"))
  7363. (looking-at "\\(\\*+\\)")
  7364. (setq stars (match-string 1)
  7365. re (concat "^" (regexp-quote stars) " +")
  7366. re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
  7367. txt (buffer-substring beg end))
  7368. (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
  7369. (if (and (not (equal stars "*")) (string-match re2 txt))
  7370. (error "Region to sort contains a level above the first entry"))
  7371. (unless sorting-type
  7372. (message
  7373. "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
  7374. [t]ime [s]cheduled [d]eadline [c]reated
  7375. A/N/T/S/D/C/P/O/F means reversed:"
  7376. what)
  7377. (setq sorting-type (read-char-exclusive))
  7378. (and (= (downcase sorting-type) ?f)
  7379. (setq getkey-func
  7380. (org-icompleting-read "Sort using function: "
  7381. obarray 'fboundp t nil nil))
  7382. (setq getkey-func (intern getkey-func)))
  7383. (and (= (downcase sorting-type) ?r)
  7384. (setq property
  7385. (org-icompleting-read "Property: "
  7386. (mapcar 'list (org-buffer-property-keys t))
  7387. nil t))))
  7388. (message "Sorting entries...")
  7389. (save-restriction
  7390. (narrow-to-region start end)
  7391. (let ((dcst (downcase sorting-type))
  7392. (case-fold-search nil)
  7393. (now (current-time)))
  7394. (sort-subr
  7395. (/= dcst sorting-type)
  7396. ;; This function moves to the beginning character of the "record" to
  7397. ;; be sorted.
  7398. (lambda nil
  7399. (if (re-search-forward re nil t)
  7400. (goto-char (match-beginning 0))
  7401. (goto-char (point-max))))
  7402. ;; This function moves to the last character of the "record" being
  7403. ;; sorted.
  7404. (lambda nil
  7405. (save-match-data
  7406. (condition-case nil
  7407. (outline-forward-same-level 1)
  7408. (error
  7409. (goto-char (point-max))))))
  7410. ;; This function returns the value that gets sorted against.
  7411. (lambda nil
  7412. (cond
  7413. ((= dcst ?n)
  7414. (if (looking-at org-complex-heading-regexp)
  7415. (string-to-number (match-string 4))
  7416. nil))
  7417. ((= dcst ?a)
  7418. (if (looking-at org-complex-heading-regexp)
  7419. (funcall case-func (match-string 4))
  7420. nil))
  7421. ((= dcst ?t)
  7422. (let ((end (save-excursion (outline-next-heading) (point))))
  7423. (if (or (re-search-forward org-ts-regexp end t)
  7424. (re-search-forward org-ts-regexp-both end t))
  7425. (org-time-string-to-seconds (match-string 0))
  7426. (org-float-time now))))
  7427. ((= dcst ?c)
  7428. (let ((end (save-excursion (outline-next-heading) (point))))
  7429. (if (re-search-forward
  7430. (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
  7431. end t)
  7432. (org-time-string-to-seconds (match-string 0))
  7433. (org-float-time now))))
  7434. ((= dcst ?s)
  7435. (let ((end (save-excursion (outline-next-heading) (point))))
  7436. (if (re-search-forward org-scheduled-time-regexp end t)
  7437. (org-time-string-to-seconds (match-string 1))
  7438. (org-float-time now))))
  7439. ((= dcst ?d)
  7440. (let ((end (save-excursion (outline-next-heading) (point))))
  7441. (if (re-search-forward org-deadline-time-regexp end t)
  7442. (org-time-string-to-seconds (match-string 1))
  7443. (org-float-time now))))
  7444. ((= dcst ?p)
  7445. (if (re-search-forward org-priority-regexp (point-at-eol) t)
  7446. (string-to-char (match-string 2))
  7447. org-default-priority))
  7448. ((= dcst ?r)
  7449. (or (org-entry-get nil property) ""))
  7450. ((= dcst ?o)
  7451. (if (looking-at org-complex-heading-regexp)
  7452. (- 9999 (length (member (match-string 2)
  7453. org-todo-keywords-1)))))
  7454. ((= dcst ?f)
  7455. (if getkey-func
  7456. (progn
  7457. (setq tmp (funcall getkey-func))
  7458. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  7459. tmp)
  7460. (error "Invalid key function `%s'" getkey-func)))
  7461. (t (error "Invalid sorting type `%c'" sorting-type))))
  7462. nil
  7463. (cond
  7464. ((= dcst ?a) 'string<)
  7465. ((= dcst ?f) compare-func)
  7466. ((member dcst '(?p ?t ?s ?d ?c)) '<)
  7467. (t nil)))))
  7468. (run-hooks 'org-after-sorting-entries-or-items-hook)
  7469. (message "Sorting entries...done")))
  7470. (defun org-do-sort (table what &optional with-case sorting-type)
  7471. "Sort TABLE of WHAT according to SORTING-TYPE.
  7472. The user will be prompted for the SORTING-TYPE if the call to this
  7473. function does not specify it. WHAT is only for the prompt, to indicate
  7474. what is being sorted. The sorting key will be extracted from
  7475. the car of the elements of the table.
  7476. If WITH-CASE is non-nil, the sorting will be case-sensitive."
  7477. (unless sorting-type
  7478. (message
  7479. "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
  7480. what)
  7481. (setq sorting-type (read-char-exclusive)))
  7482. (let ((dcst (downcase sorting-type))
  7483. extractfun comparefun)
  7484. ;; Define the appropriate functions
  7485. (cond
  7486. ((= dcst ?n)
  7487. (setq extractfun 'string-to-number
  7488. comparefun (if (= dcst sorting-type) '< '>)))
  7489. ((= dcst ?a)
  7490. (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
  7491. (lambda(x) (downcase (org-sort-remove-invisible x))))
  7492. comparefun (if (= dcst sorting-type)
  7493. 'string<
  7494. (lambda (a b) (and (not (string< a b))
  7495. (not (string= a b)))))))
  7496. ((= dcst ?t)
  7497. (setq extractfun
  7498. (lambda (x)
  7499. (if (or (string-match org-ts-regexp x)
  7500. (string-match org-ts-regexp-both x))
  7501. (org-float-time
  7502. (org-time-string-to-time (match-string 0 x)))
  7503. 0))
  7504. comparefun (if (= dcst sorting-type) '< '>)))
  7505. (t (error "Invalid sorting type `%c'" sorting-type)))
  7506. (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
  7507. table)
  7508. (lambda (a b) (funcall comparefun (car a) (car b))))))
  7509. ;;; The orgstruct minor mode
  7510. ;; Define a minor mode which can be used in other modes in order to
  7511. ;; integrate the org-mode structure editing commands.
  7512. ;; This is really a hack, because the org-mode structure commands use
  7513. ;; keys which normally belong to the major mode. Here is how it
  7514. ;; works: The minor mode defines all the keys necessary to operate the
  7515. ;; structure commands, but wraps the commands into a function which
  7516. ;; tests if the cursor is currently at a headline or a plain list
  7517. ;; item. If that is the case, the structure command is used,
  7518. ;; temporarily setting many Org-mode variables like regular
  7519. ;; expressions for filling etc. However, when any of those keys is
  7520. ;; used at a different location, function uses `key-binding' to look
  7521. ;; up if the key has an associated command in another currently active
  7522. ;; keymap (minor modes, major mode, global), and executes that
  7523. ;; command. There might be problems if any of the keys is otherwise
  7524. ;; used as a prefix key.
  7525. ;; Another challenge is that the key binding for TAB can be tab or \C-i,
  7526. ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
  7527. ;; addresses this by checking explicitly for both bindings.
  7528. (defvar orgstruct-mode-map (make-sparse-keymap)
  7529. "Keymap for the minor `orgstruct-mode'.")
  7530. (defvar org-local-vars nil
  7531. "List of local variables, for use by `orgstruct-mode'.")
  7532. ;;;###autoload
  7533. (define-minor-mode orgstruct-mode
  7534. "Toggle the minor mode `orgstruct-mode'.
  7535. This mode is for using Org-mode structure commands in other
  7536. modes. The following keys behave as if Org-mode were active, if
  7537. the cursor is on a headline, or on a plain list item (both as
  7538. defined by Org-mode).
  7539. M-up Move entry/item up
  7540. M-down Move entry/item down
  7541. M-left Promote
  7542. M-right Demote
  7543. M-S-up Move entry/item up
  7544. M-S-down Move entry/item down
  7545. M-S-left Promote subtree
  7546. M-S-right Demote subtree
  7547. M-q Fill paragraph and items like in Org-mode
  7548. C-c ^ Sort entries
  7549. C-c - Cycle list bullet
  7550. TAB Cycle item visibility
  7551. M-RET Insert new heading/item
  7552. S-M-RET Insert new TODO heading / Checkbox item
  7553. C-c C-c Set tags / toggle checkbox"
  7554. nil " OrgStruct" nil
  7555. (org-load-modules-maybe)
  7556. (and (orgstruct-setup) (defun orgstruct-setup () nil)))
  7557. ;;;###autoload
  7558. (defun turn-on-orgstruct ()
  7559. "Unconditionally turn on `orgstruct-mode'."
  7560. (orgstruct-mode 1))
  7561. (defvar org-fb-vars nil)
  7562. (make-variable-buffer-local 'org-fb-vars)
  7563. (defun orgstruct++-mode (&optional arg)
  7564. "Toggle `orgstruct-mode', the enhanced version of it.
  7565. In addition to setting orgstruct-mode, this also exports all
  7566. indentation and autofilling variables from org-mode into the
  7567. buffer. It will also recognize item context in multiline items."
  7568. (interactive "P")
  7569. (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
  7570. (if (< arg 1)
  7571. (progn (orgstruct-mode -1)
  7572. (mapc (lambda(v)
  7573. (org-set-local (car v)
  7574. (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
  7575. org-fb-vars))
  7576. (orgstruct-mode 1)
  7577. (setq org-fb-vars nil)
  7578. (let (var val)
  7579. (mapc
  7580. (lambda (x)
  7581. (when (string-match
  7582. "^\\(paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
  7583. (symbol-name (car x)))
  7584. (setq var (car x) val (nth 1 x))
  7585. (push (list var `(quote ,(eval var))) org-fb-vars)
  7586. (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
  7587. org-local-vars)
  7588. (org-set-local 'orgstruct-is-++ t))))
  7589. (defvar orgstruct-is-++ nil
  7590. "Is `orgstruct-mode' in ++ version in the current-buffer?")
  7591. (make-variable-buffer-local 'orgstruct-is-++)
  7592. ;;;###autoload
  7593. (defun turn-on-orgstruct++ ()
  7594. "Unconditionally turn on `orgstruct++-mode'."
  7595. (orgstruct++-mode 1))
  7596. (defun orgstruct-error ()
  7597. "Error when there is no default binding for a structure key."
  7598. (interactive)
  7599. (error "This key has no function outside structure elements"))
  7600. (defun orgstruct-setup ()
  7601. "Setup orgstruct keymaps."
  7602. (let ((nfunc 0)
  7603. (bindings
  7604. (list
  7605. '([(meta up)] org-metaup)
  7606. '([(meta down)] org-metadown)
  7607. '([(meta left)] org-metaleft)
  7608. '([(meta right)] org-metaright)
  7609. '([(meta shift up)] org-shiftmetaup)
  7610. '([(meta shift down)] org-shiftmetadown)
  7611. '([(meta shift left)] org-shiftmetaleft)
  7612. '([(meta shift right)] org-shiftmetaright)
  7613. '([?\e (up)] org-metaup)
  7614. '([?\e (down)] org-metadown)
  7615. '([?\e (left)] org-metaleft)
  7616. '([?\e (right)] org-metaright)
  7617. '([?\e (shift up)] org-shiftmetaup)
  7618. '([?\e (shift down)] org-shiftmetadown)
  7619. '([?\e (shift left)] org-shiftmetaleft)
  7620. '([?\e (shift right)] org-shiftmetaright)
  7621. '([(shift up)] org-shiftup)
  7622. '([(shift down)] org-shiftdown)
  7623. '([(shift left)] org-shiftleft)
  7624. '([(shift right)] org-shiftright)
  7625. '("\C-c\C-c" org-ctrl-c-ctrl-c)
  7626. '("\M-q" fill-paragraph)
  7627. '("\C-c^" org-sort)
  7628. '("\C-c-" org-cycle-list-bullet)))
  7629. elt key fun cmd)
  7630. (while (setq elt (pop bindings))
  7631. (setq nfunc (1+ nfunc))
  7632. (setq key (org-key (car elt))
  7633. fun (nth 1 elt)
  7634. cmd (orgstruct-make-binding fun nfunc key))
  7635. (org-defkey orgstruct-mode-map key cmd))
  7636. ;; Special treatment needed for TAB and RET
  7637. (org-defkey orgstruct-mode-map [(tab)]
  7638. (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
  7639. (org-defkey orgstruct-mode-map "\C-i"
  7640. (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
  7641. (org-defkey orgstruct-mode-map "\M-\C-m"
  7642. (orgstruct-make-binding 'org-insert-heading 105
  7643. "\M-\C-m" [(meta return)]))
  7644. (org-defkey orgstruct-mode-map [(meta return)]
  7645. (orgstruct-make-binding 'org-insert-heading 106
  7646. [(meta return)] "\M-\C-m"))
  7647. (org-defkey orgstruct-mode-map [(shift meta return)]
  7648. (orgstruct-make-binding 'org-insert-todo-heading 107
  7649. [(meta return)] "\M-\C-m"))
  7650. (org-defkey orgstruct-mode-map "\e\C-m"
  7651. (orgstruct-make-binding 'org-insert-heading 108
  7652. "\e\C-m" [?\e (return)]))
  7653. (org-defkey orgstruct-mode-map [?\e (return)]
  7654. (orgstruct-make-binding 'org-insert-heading 109
  7655. [?\e (return)] "\e\C-m"))
  7656. (org-defkey orgstruct-mode-map [?\e (shift return)]
  7657. (orgstruct-make-binding 'org-insert-todo-heading 110
  7658. [?\e (return)] "\e\C-m"))
  7659. (unless org-local-vars
  7660. (setq org-local-vars (org-get-local-variables)))
  7661. t))
  7662. (defun orgstruct-make-binding (fun n &rest keys)
  7663. "Create a function for binding in the structure minor mode.
  7664. FUN is the command to call inside a table. N is used to create a unique
  7665. command name. KEYS are keys that should be checked in for a command
  7666. to execute outside of tables."
  7667. (eval
  7668. (list 'defun
  7669. (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
  7670. '(arg)
  7671. (concat "In Structure, run `" (symbol-name fun) "'.\n"
  7672. "Outside of structure, run the binding of `"
  7673. (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
  7674. "'.")
  7675. '(interactive "p")
  7676. (list 'if
  7677. `(org-context-p 'headline 'item
  7678. (and orgstruct-is-++
  7679. ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
  7680. 'item-body))
  7681. (list 'org-run-like-in-org-mode (list 'quote fun))
  7682. (list 'let '(orgstruct-mode)
  7683. (list 'call-interactively
  7684. (append '(or)
  7685. (mapcar (lambda (k)
  7686. (list 'key-binding k))
  7687. keys)
  7688. '('orgstruct-error))))))))
  7689. (defun org-context-p (&rest contexts)
  7690. "Check if local context is any of CONTEXTS.
  7691. Possible values in the list of contexts are `table', `headline', and `item'."
  7692. (let ((pos (point)))
  7693. (goto-char (point-at-bol))
  7694. (prog1 (or (and (memq 'table contexts)
  7695. (looking-at "[ \t]*|"))
  7696. (and (memq 'headline contexts)
  7697. (looking-at org-outline-regexp))
  7698. (and (memq 'item contexts)
  7699. (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
  7700. (and (memq 'item-body contexts)
  7701. (org-in-item-p)))
  7702. (goto-char pos))))
  7703. (defun org-get-local-variables ()
  7704. "Return a list of all local variables in an org-mode buffer."
  7705. (let (varlist)
  7706. (with-current-buffer (get-buffer-create "*Org tmp*")
  7707. (erase-buffer)
  7708. (org-mode)
  7709. (setq varlist (buffer-local-variables)))
  7710. (kill-buffer "*Org tmp*")
  7711. (delq nil
  7712. (mapcar
  7713. (lambda (x)
  7714. (setq x
  7715. (if (symbolp x)
  7716. (list x)
  7717. (list (car x) (list 'quote (cdr x)))))
  7718. (if (string-match
  7719. "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
  7720. (symbol-name (car x)))
  7721. x nil))
  7722. varlist))))
  7723. (defun org-clone-local-variables (from-buffer &optional regexp)
  7724. "Clone local variables from FROM-BUFFER.
  7725. Optional argument REGEXP selects variables to clone."
  7726. (mapc
  7727. (lambda (pair)
  7728. (and (symbolp (car pair))
  7729. (or (null regexp)
  7730. (string-match regexp (symbol-name (car pair))))
  7731. (set (make-local-variable (car pair))
  7732. (cdr pair))))
  7733. (buffer-local-variables from-buffer)))
  7734. ;;;###autoload
  7735. (defun org-run-like-in-org-mode (cmd)
  7736. "Run a command, pretending that the current buffer is in Org-mode.
  7737. This will temporarily bind local variables that are typically bound in
  7738. Org-mode to the values they have in Org-mode, and then interactively
  7739. call CMD."
  7740. (org-load-modules-maybe)
  7741. (unless org-local-vars
  7742. (setq org-local-vars (org-get-local-variables)))
  7743. (eval (list 'let org-local-vars
  7744. (list 'call-interactively (list 'quote cmd)))))
  7745. ;;;; Archiving
  7746. (defun org-get-category (&optional pos force-refresh)
  7747. "Get the category applying to position POS."
  7748. (save-match-data
  7749. (if force-refresh (org-refresh-category-properties))
  7750. (let ((pos (or pos (point))))
  7751. (or (get-text-property pos 'org-category)
  7752. (progn (org-refresh-category-properties)
  7753. (get-text-property pos 'org-category))))))
  7754. (defun org-refresh-category-properties ()
  7755. "Refresh category text properties in the buffer."
  7756. (let ((inhibit-read-only t)
  7757. (def-cat (cond
  7758. ((null org-category)
  7759. (if buffer-file-name
  7760. (file-name-sans-extension
  7761. (file-name-nondirectory buffer-file-name))
  7762. "???"))
  7763. ((symbolp org-category) (symbol-name org-category))
  7764. (t org-category)))
  7765. beg end cat pos optionp)
  7766. (org-unmodified
  7767. (save-excursion
  7768. (save-restriction
  7769. (widen)
  7770. (goto-char (point-min))
  7771. (put-text-property (point) (point-max) 'org-category def-cat)
  7772. (while (re-search-forward
  7773. "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
  7774. (setq pos (match-end 0)
  7775. optionp (equal (char-after (match-beginning 0)) ?#)
  7776. cat (org-trim (match-string 2)))
  7777. (if optionp
  7778. (setq beg (point-at-bol) end (point-max))
  7779. (org-back-to-heading t)
  7780. (setq beg (point) end (org-end-of-subtree t t)))
  7781. (put-text-property beg end 'org-category cat)
  7782. (put-text-property beg end 'org-category-position beg)
  7783. (goto-char pos)))))))
  7784. ;;;; Link Stuff
  7785. ;;; Link abbreviations
  7786. (defun org-link-expand-abbrev (link)
  7787. "Apply replacements as defined in `org-link-abbrev-alist'."
  7788. (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
  7789. (let* ((key (match-string 1 link))
  7790. (as (or (assoc key org-link-abbrev-alist-local)
  7791. (assoc key org-link-abbrev-alist)))
  7792. (tag (and (match-end 2) (match-string 3 link)))
  7793. rpl)
  7794. (if (not as)
  7795. link
  7796. (setq rpl (cdr as))
  7797. (cond
  7798. ((symbolp rpl) (funcall rpl tag))
  7799. ((string-match "%(\\([^)]+\\))" rpl)
  7800. (replace-match (funcall (intern-soft (match-string 1 rpl)) tag) t t rpl))
  7801. ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
  7802. ((string-match "%h" rpl)
  7803. (replace-match (url-hexify-string (or tag "")) t t rpl))
  7804. (t (concat rpl tag)))))
  7805. link))
  7806. ;;; Storing and inserting links
  7807. (defvar org-insert-link-history nil
  7808. "Minibuffer history for links inserted with `org-insert-link'.")
  7809. (defvar org-stored-links nil
  7810. "Contains the links stored with `org-store-link'.")
  7811. (defvar org-store-link-plist nil
  7812. "Plist with info about the most recently link created with `org-store-link'.")
  7813. (defvar org-link-protocols nil
  7814. "Link protocols added to Org-mode using `org-add-link-type'.")
  7815. (defvar org-store-link-functions nil
  7816. "List of functions that are called to create and store a link.
  7817. Each function will be called in turn until one returns a non-nil
  7818. value. Each function should check if it is responsible for creating
  7819. this link (for example by looking at the major mode).
  7820. If not, it must exit and return nil.
  7821. If yes, it should return a non-nil value after a calling
  7822. `org-store-link-props' with a list of properties and values.
  7823. Special properties are:
  7824. :type The link prefix, like \"http\". This must be given.
  7825. :link The link, like \"http://www.astro.uva.nl/~dominik\".
  7826. This is obligatory as well.
  7827. :description Optional default description for the second pair
  7828. of brackets in an Org-mode link. The user can still change
  7829. this when inserting this link into an Org-mode buffer.
  7830. In addition to these, any additional properties can be specified
  7831. and then used in remember templates.")
  7832. (defun org-add-link-type (type &optional follow export)
  7833. "Add TYPE to the list of `org-link-types'.
  7834. Re-compute all regular expressions depending on `org-link-types'
  7835. FOLLOW and EXPORT are two functions.
  7836. FOLLOW should take the link path as the single argument and do whatever
  7837. is necessary to follow the link, for example find a file or display
  7838. a mail message.
  7839. EXPORT should format the link path for export to one of the export formats.
  7840. It should be a function accepting three arguments:
  7841. path the path of the link, the text after the prefix (like \"http:\")
  7842. desc the description of the link, if any, or a description added by
  7843. org-export-normalize-links if there is none
  7844. format the export format, a symbol like `html' or `latex' or `ascii'..
  7845. The function may use the FORMAT information to return different values
  7846. depending on the format. The return value will be put literally into
  7847. the exported file. If the return value is nil, this means Org should
  7848. do what it normally does with links which do not have EXPORT defined.
  7849. Org-mode has a built-in default for exporting links. If you are happy with
  7850. this default, there is no need to define an export function for the link
  7851. type. For a simple example of an export function, see `org-bbdb.el'."
  7852. (add-to-list 'org-link-types type t)
  7853. (org-make-link-regexps)
  7854. (if (assoc type org-link-protocols)
  7855. (setcdr (assoc type org-link-protocols) (list follow export))
  7856. (push (list type follow export) org-link-protocols)))
  7857. (defvar org-agenda-buffer-name)
  7858. ;;;###autoload
  7859. (defun org-store-link (arg)
  7860. "\\<org-mode-map>Store an org-link to the current location.
  7861. This link is added to `org-stored-links' and can later be inserted
  7862. into an org-buffer with \\[org-insert-link].
  7863. For some link types, a prefix arg is interpreted:
  7864. For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
  7865. For file links, arg negates `org-context-in-file-links'."
  7866. (interactive "P")
  7867. (org-load-modules-maybe)
  7868. (setq org-store-link-plist nil) ; reset
  7869. (org-with-limited-levels
  7870. (let (link cpltxt desc description search txt custom-id agenda-link)
  7871. (cond
  7872. ((run-hook-with-args-until-success 'org-store-link-functions)
  7873. (setq link (plist-get org-store-link-plist :link)
  7874. desc (or (plist-get org-store-link-plist :description) link)))
  7875. ((org-src-edit-buffer-p)
  7876. (let (label gc)
  7877. (while (or (not label)
  7878. (save-excursion
  7879. (save-restriction
  7880. (widen)
  7881. (goto-char (point-min))
  7882. (re-search-forward
  7883. (regexp-quote (format org-coderef-label-format label))
  7884. nil t))))
  7885. (when label (message "Label exists already") (sit-for 2))
  7886. (setq label (read-string "Code line label: " label)))
  7887. (end-of-line 1)
  7888. (setq link (format org-coderef-label-format label))
  7889. (setq gc (- 79 (length link)))
  7890. (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
  7891. (insert link)
  7892. (setq link (concat "(" label ")") desc nil)))
  7893. ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
  7894. ;; We are in the agenda, link to referenced location
  7895. (let ((m (or (get-text-property (point) 'org-hd-marker)
  7896. (get-text-property (point) 'org-marker))))
  7897. (when m
  7898. (org-with-point-at m
  7899. (setq agenda-link
  7900. (if (org-called-interactively-p 'any)
  7901. (call-interactively 'org-store-link)
  7902. (org-store-link nil)))))))
  7903. ((eq major-mode 'calendar-mode)
  7904. (let ((cd (calendar-cursor-to-date)))
  7905. (setq link
  7906. (format-time-string
  7907. (car org-time-stamp-formats)
  7908. (apply 'encode-time
  7909. (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
  7910. nil nil nil))))
  7911. (org-store-link-props :type "calendar" :date cd)))
  7912. ((eq major-mode 'w3-mode)
  7913. (setq cpltxt (if (and (buffer-name)
  7914. (not (string-match "Untitled" (buffer-name))))
  7915. (buffer-name)
  7916. (url-view-url t))
  7917. link (org-make-link (url-view-url t)))
  7918. (org-store-link-props :type "w3" :url (url-view-url t)))
  7919. ((eq major-mode 'w3m-mode)
  7920. (setq cpltxt (or w3m-current-title w3m-current-url)
  7921. link (org-make-link w3m-current-url))
  7922. (org-store-link-props :type "w3m" :url (url-view-url t)))
  7923. ((setq search (run-hook-with-args-until-success
  7924. 'org-create-file-search-functions))
  7925. (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
  7926. "::" search))
  7927. (setq cpltxt (or description link)))
  7928. ((eq major-mode 'image-mode)
  7929. (setq cpltxt (concat "file:"
  7930. (abbreviate-file-name buffer-file-name))
  7931. link (org-make-link cpltxt))
  7932. (org-store-link-props :type "image" :file buffer-file-name))
  7933. ((eq major-mode 'dired-mode)
  7934. ;; link to the file in the current line
  7935. (let ((file (dired-get-filename nil t)))
  7936. (setq file (if file
  7937. (abbreviate-file-name
  7938. (expand-file-name (dired-get-filename nil t)))
  7939. ;; otherwise, no file so use current directory.
  7940. default-directory))
  7941. (setq cpltxt (concat "file:" file)
  7942. link (org-make-link cpltxt))))
  7943. ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
  7944. (setq custom-id (org-entry-get nil "CUSTOM_ID"))
  7945. (cond
  7946. ((org-in-regexp "<<\\(.*?\\)>>")
  7947. (setq cpltxt
  7948. (concat "file:"
  7949. (abbreviate-file-name
  7950. (buffer-file-name (buffer-base-buffer)))
  7951. "::" (match-string 1))
  7952. link (org-make-link cpltxt)))
  7953. ((and (featurep 'org-id)
  7954. (or (eq org-link-to-org-use-id t)
  7955. (and (eq org-link-to-org-use-id 'create-if-interactive)
  7956. (org-called-interactively-p 'any))
  7957. (and (eq org-link-to-org-use-id
  7958. 'create-if-interactive-and-no-custom-id)
  7959. (org-called-interactively-p 'any)
  7960. (not custom-id))
  7961. (and org-link-to-org-use-id
  7962. (org-entry-get nil "ID"))))
  7963. ;; We can make a link using the ID.
  7964. (setq link (condition-case nil
  7965. (prog1 (org-id-store-link)
  7966. (setq desc (plist-get org-store-link-plist
  7967. :description)))
  7968. (error
  7969. ;; probably before first headline, link to file only
  7970. (concat "file:"
  7971. (abbreviate-file-name
  7972. (buffer-file-name (buffer-base-buffer))))))))
  7973. (t
  7974. ;; Just link to current headline
  7975. (setq cpltxt (concat "file:"
  7976. (abbreviate-file-name
  7977. (buffer-file-name (buffer-base-buffer)))))
  7978. ;; Add a context search string
  7979. (when (org-xor org-context-in-file-links arg)
  7980. (setq txt (cond
  7981. ((org-at-heading-p) nil)
  7982. ((org-region-active-p)
  7983. (buffer-substring (region-beginning) (region-end)))
  7984. (t nil)))
  7985. (when (or (null txt) (string-match "\\S-" txt))
  7986. (setq cpltxt
  7987. (concat cpltxt "::"
  7988. (condition-case nil
  7989. (org-make-org-heading-search-string txt)
  7990. (error "")))
  7991. desc (or (nth 4 (ignore-errors
  7992. (org-heading-components))) "NONE"))))
  7993. (if (string-match "::\\'" cpltxt)
  7994. (setq cpltxt (substring cpltxt 0 -2)))
  7995. (setq link (org-make-link cpltxt)))))
  7996. ((buffer-file-name (buffer-base-buffer))
  7997. ;; Just link to this file here.
  7998. (setq cpltxt (concat "file:"
  7999. (abbreviate-file-name
  8000. (buffer-file-name (buffer-base-buffer)))))
  8001. ;; Add a context string
  8002. (when (org-xor org-context-in-file-links arg)
  8003. (setq txt (if (org-region-active-p)
  8004. (buffer-substring (region-beginning) (region-end))
  8005. (buffer-substring (point-at-bol) (point-at-eol))))
  8006. ;; Only use search option if there is some text.
  8007. (when (string-match "\\S-" txt)
  8008. (setq cpltxt
  8009. (concat cpltxt "::" (org-make-org-heading-search-string txt))
  8010. desc "NONE")))
  8011. (setq link (org-make-link cpltxt)))
  8012. ((org-called-interactively-p 'interactive)
  8013. (error "Cannot link to a buffer which is not visiting a file"))
  8014. (t (setq link nil)))
  8015. (if (consp link) (setq cpltxt (car link) link (cdr link)))
  8016. (setq link (or link cpltxt)
  8017. desc (or desc cpltxt))
  8018. (if (equal desc "NONE") (setq desc nil))
  8019. (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
  8020. (progn
  8021. (setq org-stored-links
  8022. (cons (list link desc) org-stored-links))
  8023. (message "Stored: %s" (or desc link))
  8024. (when custom-id
  8025. (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
  8026. "::#" custom-id))
  8027. (setq org-stored-links
  8028. (cons (list link desc) org-stored-links))))
  8029. (or agenda-link (and link (org-make-link-string link desc)))))))
  8030. (defun org-store-link-props (&rest plist)
  8031. "Store link properties, extract names and addresses."
  8032. (let (x adr)
  8033. (when (setq x (plist-get plist :from))
  8034. (setq adr (mail-extract-address-components x))
  8035. (setq plist (plist-put plist :fromname (car adr)))
  8036. (setq plist (plist-put plist :fromaddress (nth 1 adr))))
  8037. (when (setq x (plist-get plist :to))
  8038. (setq adr (mail-extract-address-components x))
  8039. (setq plist (plist-put plist :toname (car adr)))
  8040. (setq plist (plist-put plist :toaddress (nth 1 adr)))))
  8041. (let ((from (plist-get plist :from))
  8042. (to (plist-get plist :to)))
  8043. (when (and from to org-from-is-user-regexp)
  8044. (setq plist
  8045. (plist-put plist :fromto
  8046. (if (string-match org-from-is-user-regexp from)
  8047. (concat "to %t")
  8048. (concat "from %f"))))))
  8049. (setq org-store-link-plist plist))
  8050. (defun org-add-link-props (&rest plist)
  8051. "Add these properties to the link property list."
  8052. (let (key value)
  8053. (while plist
  8054. (setq key (pop plist) value (pop plist))
  8055. (setq org-store-link-plist
  8056. (plist-put org-store-link-plist key value)))))
  8057. (defun org-email-link-description (&optional fmt)
  8058. "Return the description part of an email link.
  8059. This takes information from `org-store-link-plist' and formats it
  8060. according to FMT (default from `org-email-link-description-format')."
  8061. (setq fmt (or fmt org-email-link-description-format))
  8062. (let* ((p org-store-link-plist)
  8063. (to (plist-get p :toaddress))
  8064. (from (plist-get p :fromaddress))
  8065. (table
  8066. (list
  8067. (cons "%c" (plist-get p :fromto))
  8068. (cons "%F" (plist-get p :from))
  8069. (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
  8070. (cons "%T" (plist-get p :to))
  8071. (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
  8072. (cons "%s" (plist-get p :subject))
  8073. (cons "%d" (plist-get p :date))
  8074. (cons "%m" (plist-get p :message-id)))))
  8075. (when (string-match "%c" fmt)
  8076. ;; Check if the user wrote this message
  8077. (if (and org-from-is-user-regexp from to
  8078. (save-match-data (string-match org-from-is-user-regexp from)))
  8079. (setq fmt (replace-match "to %t" t t fmt))
  8080. (setq fmt (replace-match "from %f" t t fmt))))
  8081. (org-replace-escapes fmt table)))
  8082. (defun org-make-org-heading-search-string (&optional string heading)
  8083. "Make search string for STRING or current headline."
  8084. (interactive)
  8085. (let ((s (or string (org-get-heading)))
  8086. (lines org-context-in-file-links))
  8087. (unless (and string (not heading))
  8088. ;; We are using a headline, clean up garbage in there.
  8089. (if (string-match org-todo-regexp s)
  8090. (setq s (replace-match "" t t s)))
  8091. (if (string-match (org-re ":[[:alnum:]_@#%:]+:[ \t]*$") s)
  8092. (setq s (replace-match "" t t s)))
  8093. (setq s (org-trim s))
  8094. (if (string-match (concat "^\\(" org-quote-string "\\|"
  8095. org-comment-string "\\)") s)
  8096. (setq s (replace-match "" t t s)))
  8097. (while (string-match org-ts-regexp s)
  8098. (setq s (replace-match "" t t s))))
  8099. (or string (setq s (concat "*" s))) ; Add * for headlines
  8100. (when (and string (integerp lines) (> lines 0))
  8101. (let ((slines (org-split-string s "\n")))
  8102. (when (< lines (length slines))
  8103. (setq s (mapconcat
  8104. 'identity
  8105. (reverse (nthcdr (- (length slines) lines)
  8106. (reverse slines))) "\n")))))
  8107. (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
  8108. (defun org-make-link (&rest strings)
  8109. "Concatenate STRINGS."
  8110. (apply 'concat strings))
  8111. (defun org-make-link-string (link &optional description)
  8112. "Make a link with brackets, consisting of LINK and DESCRIPTION."
  8113. (unless (string-match "\\S-" link)
  8114. (error "Empty link"))
  8115. (when (and description
  8116. (stringp description)
  8117. (not (string-match "\\S-" description)))
  8118. (setq description nil))
  8119. (when (stringp description)
  8120. ;; Remove brackets from the description, they are fatal.
  8121. (while (string-match "\\[" description)
  8122. (setq description (replace-match "{" t t description)))
  8123. (while (string-match "\\]" description)
  8124. (setq description (replace-match "}" t t description))))
  8125. (when (equal link description)
  8126. ;; No description needed, it is identical
  8127. (setq description nil))
  8128. (when (and (not description)
  8129. (not (string-match (org-image-file-name-regexp) link))
  8130. (not (equal link (org-link-escape link))))
  8131. (setq description (org-extract-attributes link)))
  8132. (setq link
  8133. (cond ((string-match (org-image-file-name-regexp) link) link)
  8134. ((string-match org-link-types-re link)
  8135. (concat (match-string 1 link)
  8136. (org-link-escape (substring link (match-end 1)))))
  8137. (t (org-link-escape link))))
  8138. (concat "[[" link "]"
  8139. (if description (concat "[" description "]") "")
  8140. "]"))
  8141. (defconst org-link-escape-chars
  8142. '(?\ ?\[ ?\] ?\; ?\= ?\+)
  8143. "List of characters that should be escaped in link.
  8144. This is the list that is used for internal purposes.")
  8145. (defvar org-url-encoding-use-url-hexify nil)
  8146. (defconst org-link-escape-chars-browser
  8147. '(?\ )
  8148. "List of escapes for characters that are problematic in links.
  8149. This is the list that is used before handing over to the browser.")
  8150. (defun org-link-escape (text &optional table merge)
  8151. "Return percent escaped representation of TEXT.
  8152. TEXT is a string with the text to escape.
  8153. Optional argument TABLE is a list with characters that should be
  8154. escaped. When nil, `org-link-escape-chars' is used.
  8155. If optional argument MERGE is set, merge TABLE into
  8156. `org-link-escape-chars'."
  8157. (if (and org-url-encoding-use-url-hexify (not table))
  8158. (url-hexify-string text)
  8159. (cond
  8160. ((and table merge)
  8161. (mapc (lambda (defchr)
  8162. (unless (member defchr table)
  8163. (setq table (cons defchr table)))) org-link-escape-chars))
  8164. ((null table)
  8165. (setq table org-link-escape-chars)))
  8166. (mapconcat
  8167. (lambda (char)
  8168. (if (or (member char table)
  8169. (< char 32) (= char 37) (> char 126))
  8170. (mapconcat (lambda (sequence-element)
  8171. (format "%%%.2X" sequence-element))
  8172. (or (encode-coding-char char 'utf-8)
  8173. (error "Unable to percent escape character: %s"
  8174. (char-to-string char))) "")
  8175. (char-to-string char))) text "")))
  8176. (defun org-link-unescape (str)
  8177. "Unhex hexified Unicode strings as returned from the JavaScript function
  8178. encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
  8179. (unless (and (null str) (string= "" str))
  8180. (let ((pos 0) (case-fold-search t) unhexed)
  8181. (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
  8182. (setq unhexed (org-link-unescape-compound (match-string 0 str)))
  8183. (setq str (replace-match unhexed t t str))
  8184. (setq pos (+ pos (length unhexed))))))
  8185. str)
  8186. (defun org-link-unescape-compound (hex)
  8187. "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
  8188. Note: this function also decodes single byte encodings like
  8189. `%E1' (\"á\") if not followed by another `%[A-F0-9]{2}' group."
  8190. (save-match-data
  8191. (let* ((bytes (cdr (split-string hex "%")))
  8192. (ret "")
  8193. (eat 0)
  8194. (sum 0))
  8195. (while bytes
  8196. (let* ((val (string-to-number (pop bytes) 16))
  8197. (shift-xor
  8198. (if (= 0 eat)
  8199. (cond
  8200. ((>= val 252) (cons 6 252))
  8201. ((>= val 248) (cons 5 248))
  8202. ((>= val 240) (cons 4 240))
  8203. ((>= val 224) (cons 3 224))
  8204. ((>= val 192) (cons 2 192))
  8205. (t (cons 0 0)))
  8206. (cons 6 128))))
  8207. (if (>= val 192) (setq eat (car shift-xor)))
  8208. (setq val (logxor val (cdr shift-xor)))
  8209. (setq sum (+ (lsh sum (car shift-xor)) val))
  8210. (if (> eat 0) (setq eat (- eat 1)))
  8211. (cond
  8212. ((= 0 eat) ;multi byte
  8213. (setq ret (concat ret (org-char-to-string sum)))
  8214. (setq sum 0))
  8215. ((not bytes) ; single byte(s)
  8216. (setq ret (org-link-unescape-single-byte-sequence hex))))
  8217. )) ;; end (while bytes
  8218. ret )))
  8219. (defun org-link-unescape-single-byte-sequence (hex)
  8220. "Unhexify hex-encoded single byte character sequences."
  8221. (mapconcat (lambda (byte)
  8222. (char-to-string (string-to-number byte 16)))
  8223. (cdr (split-string hex "%")) ""))
  8224. (defun org-xor (a b)
  8225. "Exclusive or."
  8226. (if a (not b) b))
  8227. (defun org-fixup-message-id-for-http (s)
  8228. "Replace special characters in a message id, so it can be used in an http query."
  8229. (when (string-match "%" s)
  8230. (setq s (mapconcat (lambda (c)
  8231. (if (eq c ?%)
  8232. "%25"
  8233. (char-to-string c)))
  8234. s "")))
  8235. (while (string-match "<" s)
  8236. (setq s (replace-match "%3C" t t s)))
  8237. (while (string-match ">" s)
  8238. (setq s (replace-match "%3E" t t s)))
  8239. (while (string-match "@" s)
  8240. (setq s (replace-match "%40" t t s)))
  8241. s)
  8242. (defun org-link-prettify (link)
  8243. "Return a human-readable representation of LINK.
  8244. The car of LINK must be a raw link the cdr of LINK must be either
  8245. a link description or nil."
  8246. (let ((desc (or (cadr link) "<no description>")))
  8247. (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
  8248. "[[" (car link) "]]")))
  8249. ;;;###autoload
  8250. (defun org-insert-link-global ()
  8251. "Insert a link like Org-mode does.
  8252. This command can be called in any mode to insert a link in Org-mode syntax."
  8253. (interactive)
  8254. (org-load-modules-maybe)
  8255. (org-run-like-in-org-mode 'org-insert-link))
  8256. (defun org-insert-link (&optional complete-file link-location default-description)
  8257. "Insert a link. At the prompt, enter the link.
  8258. Completion can be used to insert any of the link protocol prefixes like
  8259. http or ftp in use.
  8260. The history can be used to select a link previously stored with
  8261. `org-store-link'. When the empty string is entered (i.e. if you just
  8262. press RET at the prompt), the link defaults to the most recently
  8263. stored link. As SPC triggers completion in the minibuffer, you need to
  8264. use M-SPC or C-q SPC to force the insertion of a space character.
  8265. You will also be prompted for a description, and if one is given, it will
  8266. be displayed in the buffer instead of the link.
  8267. If there is already a link at point, this command will allow you to edit link
  8268. and description parts.
  8269. With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
  8270. be selected using completion. The path to the file will be relative to the
  8271. current directory if the file is in the current directory or a subdirectory.
  8272. Otherwise, the link will be the absolute path as completed in the minibuffer
  8273. \(i.e. normally ~/path/to/file). You can configure this behavior using the
  8274. option `org-link-file-path-type'.
  8275. With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
  8276. the current directory or below.
  8277. With three \\[universal-argument] prefixes, negate the meaning of
  8278. `org-keep-stored-link-after-insertion'.
  8279. If `org-make-link-description-function' is non-nil, this function will be
  8280. called with the link target, and the result will be the default
  8281. link description.
  8282. If the LINK-LOCATION parameter is non-nil, this value will be
  8283. used as the link location instead of reading one interactively.
  8284. If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
  8285. be used as the default description."
  8286. (interactive "P")
  8287. (let* ((wcf (current-window-configuration))
  8288. (region (if (org-region-active-p)
  8289. (buffer-substring (region-beginning) (region-end))))
  8290. (remove (and region (list (region-beginning) (region-end))))
  8291. (desc region)
  8292. tmphist ; byte-compile incorrectly complains about this
  8293. (link link-location)
  8294. entry file all-prefixes)
  8295. (cond
  8296. (link-location) ; specified by arg, just use it.
  8297. ((org-in-regexp org-bracket-link-regexp 1)
  8298. ;; We do have a link at point, and we are going to edit it.
  8299. (setq remove (list (match-beginning 0) (match-end 0)))
  8300. (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
  8301. (setq link (read-string "Link: "
  8302. (org-link-unescape
  8303. (org-match-string-no-properties 1)))))
  8304. ((or (org-in-regexp org-angle-link-re)
  8305. (org-in-regexp org-plain-link-re))
  8306. ;; Convert to bracket link
  8307. (setq remove (list (match-beginning 0) (match-end 0))
  8308. link (read-string "Link: "
  8309. (org-remove-angle-brackets (match-string 0)))))
  8310. ((member complete-file '((4) (16)))
  8311. ;; Completing read for file names.
  8312. (setq link (org-file-complete-link complete-file)))
  8313. (t
  8314. ;; Read link, with completion for stored links.
  8315. (with-output-to-temp-buffer "*Org Links*"
  8316. (princ "Insert a link.
  8317. Use TAB to complete link prefixes, then RET for type-specific completion support\n")
  8318. (when org-stored-links
  8319. (princ "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
  8320. (princ (mapconcat 'org-link-prettify
  8321. (reverse org-stored-links) "\n"))))
  8322. (let ((cw (selected-window)))
  8323. (select-window (get-buffer-window "*Org Links*" 'visible))
  8324. (with-current-buffer "*Org Links*" (setq truncate-lines t))
  8325. (unless (pos-visible-in-window-p (point-max))
  8326. (org-fit-window-to-buffer))
  8327. (and (window-live-p cw) (select-window cw)))
  8328. ;; Fake a link history, containing the stored links.
  8329. (setq tmphist (append (mapcar 'car org-stored-links)
  8330. org-insert-link-history))
  8331. (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
  8332. (mapcar 'car org-link-abbrev-alist)
  8333. org-link-types))
  8334. (unwind-protect
  8335. (progn
  8336. (setq link
  8337. (let ((org-completion-use-ido nil)
  8338. (org-completion-use-iswitchb nil))
  8339. (org-completing-read
  8340. "Link: "
  8341. (append
  8342. (mapcar (lambda (x) (list (concat x ":")))
  8343. all-prefixes)
  8344. (mapcar 'car org-stored-links))
  8345. nil nil nil
  8346. 'tmphist
  8347. (car (car org-stored-links)))))
  8348. (if (not (string-match "\\S-" link))
  8349. (error "No link selected"))
  8350. (if (or (member link all-prefixes)
  8351. (and (equal ":" (substring link -1))
  8352. (member (substring link 0 -1) all-prefixes)
  8353. (setq link (substring link 0 -1))))
  8354. (setq link (org-link-try-special-completion link))))
  8355. (set-window-configuration wcf)
  8356. (kill-buffer "*Org Links*"))
  8357. (setq entry (assoc link org-stored-links))
  8358. (or entry (push link org-insert-link-history))
  8359. (if (funcall (if (equal complete-file '(64)) 'not 'identity)
  8360. (not org-keep-stored-link-after-insertion))
  8361. (setq org-stored-links (delq (assoc link org-stored-links)
  8362. org-stored-links)))
  8363. (setq desc (or desc (nth 1 entry)))))
  8364. (if (string-match org-plain-link-re link)
  8365. ;; URL-like link, normalize the use of angular brackets.
  8366. (setq link (org-make-link (org-remove-angle-brackets link))))
  8367. ;; Check if we are linking to the current file with a search option
  8368. ;; If yes, simplify the link by using only the search option.
  8369. (when (and buffer-file-name
  8370. (string-match "^file:\\(.+?\\)::\\([^>]+\\)" link))
  8371. (let* ((path (match-string 1 link))
  8372. (case-fold-search nil)
  8373. (search (match-string 2 link)))
  8374. (save-match-data
  8375. (if (equal (file-truename buffer-file-name) (file-truename path))
  8376. ;; We are linking to this same file, with a search option
  8377. (setq link search)))))
  8378. ;; Check if we can/should use a relative path. If yes, simplify the link
  8379. (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
  8380. (let* ((type (match-string 1 link))
  8381. (path (match-string 2 link))
  8382. (origpath path)
  8383. (case-fold-search nil))
  8384. (cond
  8385. ((or (eq org-link-file-path-type 'absolute)
  8386. (equal complete-file '(16)))
  8387. (setq path (abbreviate-file-name (expand-file-name path))))
  8388. ((eq org-link-file-path-type 'noabbrev)
  8389. (setq path (expand-file-name path)))
  8390. ((eq org-link-file-path-type 'relative)
  8391. (setq path (file-relative-name path)))
  8392. (t
  8393. (save-match-data
  8394. (if (string-match (concat "^" (regexp-quote
  8395. (expand-file-name
  8396. (file-name-as-directory
  8397. default-directory))))
  8398. (expand-file-name path))
  8399. ;; We are linking a file with relative path name.
  8400. (setq path (substring (expand-file-name path)
  8401. (match-end 0)))
  8402. (setq path (abbreviate-file-name (expand-file-name path)))))))
  8403. (setq link (concat type path))
  8404. (if (equal desc origpath)
  8405. (setq desc path))))
  8406. (if org-make-link-description-function
  8407. (setq desc (funcall org-make-link-description-function link desc))
  8408. (if default-description (setq desc default-description)))
  8409. (setq desc (read-string "Description: " desc))
  8410. (unless (string-match "\\S-" desc) (setq desc nil))
  8411. (if remove (apply 'delete-region remove))
  8412. (insert (org-make-link-string link desc))))
  8413. (defun org-link-try-special-completion (type)
  8414. "If there is completion support for link type TYPE, offer it."
  8415. (let ((fun (intern (concat "org-" type "-complete-link"))))
  8416. (if (functionp fun)
  8417. (funcall fun)
  8418. (read-string "Link (no completion support): " (concat type ":")))))
  8419. (defun org-file-complete-link (&optional arg)
  8420. "Create a file link using completion."
  8421. (let (file link)
  8422. (setq file (read-file-name "File: "))
  8423. (let ((pwd (file-name-as-directory (expand-file-name ".")))
  8424. (pwd1 (file-name-as-directory (abbreviate-file-name
  8425. (expand-file-name ".")))))
  8426. (cond
  8427. ((equal arg '(16))
  8428. (setq link (org-make-link
  8429. "file:"
  8430. (abbreviate-file-name (expand-file-name file)))))
  8431. ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
  8432. (setq link (org-make-link "file:" (match-string 1 file))))
  8433. ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
  8434. (expand-file-name file))
  8435. (setq link (org-make-link
  8436. "file:" (match-string 1 (expand-file-name file)))))
  8437. (t (setq link (org-make-link "file:" file)))))
  8438. link))
  8439. (defun org-completing-read (&rest args)
  8440. "Completing-read with SPACE being a normal character."
  8441. (let ((enable-recursive-minibuffers t)
  8442. (minibuffer-local-completion-map
  8443. (copy-keymap minibuffer-local-completion-map)))
  8444. (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
  8445. (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
  8446. (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
  8447. (apply 'org-icompleting-read args)))
  8448. (defun org-completing-read-no-i (&rest args)
  8449. (let (org-completion-use-ido org-completion-use-iswitchb)
  8450. (apply 'org-completing-read args)))
  8451. (defun org-iswitchb-completing-read (prompt choices &rest args)
  8452. "Use iswitch as a completing-read replacement to choose from choices.
  8453. PROMPT is a string to prompt with. CHOICES is a list of strings to choose
  8454. from."
  8455. (let* ((iswitchb-use-virtual-buffers nil)
  8456. (iswitchb-make-buflist-hook
  8457. (lambda ()
  8458. (setq iswitchb-temp-buflist choices))))
  8459. (iswitchb-read-buffer prompt)))
  8460. (defun org-icompleting-read (&rest args)
  8461. "Completing-read using `ido-mode' or `iswitchb' speedups if available."
  8462. (org-without-partial-completion
  8463. (if (and org-completion-use-ido
  8464. (fboundp 'ido-completing-read)
  8465. (boundp 'ido-mode) ido-mode
  8466. (listp (second args)))
  8467. (let ((ido-enter-matching-directory nil))
  8468. (apply 'ido-completing-read (concat (car args))
  8469. (if (consp (car (nth 1 args)))
  8470. (mapcar 'car (nth 1 args))
  8471. (nth 1 args))
  8472. (cddr args)))
  8473. (if (and org-completion-use-iswitchb
  8474. (boundp 'iswitchb-mode) iswitchb-mode
  8475. (listp (second args)))
  8476. (apply 'org-iswitchb-completing-read (concat (car args))
  8477. (if (consp (car (nth 1 args)))
  8478. (mapcar 'car (nth 1 args))
  8479. (nth 1 args))
  8480. (cddr args))
  8481. (apply 'completing-read args)))))
  8482. (defun org-extract-attributes (s)
  8483. "Extract the attributes cookie from a string and set as text property."
  8484. (let (a attr (start 0) key value)
  8485. (save-match-data
  8486. (when (string-match "{{\\([^}]+\\)}}$" s)
  8487. (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
  8488. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
  8489. (setq key (match-string 1 a) value (match-string 2 a)
  8490. start (match-end 0)
  8491. attr (plist-put attr (intern key) value))))
  8492. (org-add-props s nil 'org-attr attr))
  8493. s))
  8494. (defun org-extract-attributes-from-string (tag)
  8495. (let (key value attr)
  8496. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"\\s-?" tag)
  8497. (setq key (match-string 1 tag) value (match-string 2 tag)
  8498. tag (replace-match "" t t tag)
  8499. attr (plist-put attr (intern key) value)))
  8500. (cons tag attr)))
  8501. (defun org-attributes-to-string (plist)
  8502. "Format a property list into an HTML attribute list."
  8503. (let ((s "") key value)
  8504. (while plist
  8505. (setq key (pop plist) value (pop plist))
  8506. (and value
  8507. (setq s (concat s " " (symbol-name key) "=\"" value "\""))))
  8508. s))
  8509. ;;; Opening/following a link
  8510. (defvar org-link-search-failed nil)
  8511. (defvar org-open-link-functions nil
  8512. "Hook for functions finding a plain text link.
  8513. These functions must take a single argument, the link content.
  8514. They will be called for links that look like [[link text][description]]
  8515. when LINK TEXT does not have a protocol like \"http:\" and does not look
  8516. like a filename (e.g. \"./blue.png\").
  8517. These functions will be called *before* Org attempts to resolve the
  8518. link by doing text searches in the current buffer - so if you want a
  8519. link \"[[target]]\" to still find \"<<target>>\", your function should
  8520. handle this as a special case.
  8521. When the function does handle the link, it must return a non-nil value.
  8522. If it decides that it is not responsible for this link, it must return
  8523. nil to indicate that that Org-mode can continue with other options
  8524. like exact and fuzzy text search.")
  8525. (defun org-next-link ()
  8526. "Move forward to the next link.
  8527. If the link is in hidden text, expose it."
  8528. (interactive)
  8529. (when (and org-link-search-failed (eq this-command last-command))
  8530. (goto-char (point-min))
  8531. (message "Link search wrapped back to beginning of buffer"))
  8532. (setq org-link-search-failed nil)
  8533. (let* ((pos (point))
  8534. (ct (org-context))
  8535. (a (assoc :link ct)))
  8536. (if a (goto-char (nth 2 a)))
  8537. (if (re-search-forward org-any-link-re nil t)
  8538. (progn
  8539. (goto-char (match-beginning 0))
  8540. (if (outline-invisible-p) (org-show-context)))
  8541. (goto-char pos)
  8542. (setq org-link-search-failed t)
  8543. (error "No further link found"))))
  8544. (defun org-previous-link ()
  8545. "Move backward to the previous link.
  8546. If the link is in hidden text, expose it."
  8547. (interactive)
  8548. (when (and org-link-search-failed (eq this-command last-command))
  8549. (goto-char (point-max))
  8550. (message "Link search wrapped back to end of buffer"))
  8551. (setq org-link-search-failed nil)
  8552. (let* ((pos (point))
  8553. (ct (org-context))
  8554. (a (assoc :link ct)))
  8555. (if a (goto-char (nth 1 a)))
  8556. (if (re-search-backward org-any-link-re nil t)
  8557. (progn
  8558. (goto-char (match-beginning 0))
  8559. (if (outline-invisible-p) (org-show-context)))
  8560. (goto-char pos)
  8561. (setq org-link-search-failed t)
  8562. (error "No further link found"))))
  8563. (defun org-translate-link (s)
  8564. "Translate a link string if a translation function has been defined."
  8565. (if (and org-link-translation-function
  8566. (fboundp org-link-translation-function)
  8567. (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
  8568. (progn
  8569. (setq s (funcall org-link-translation-function
  8570. (match-string 1 s) (match-string 2 s)))
  8571. (concat (car s) ":" (cdr s)))
  8572. s))
  8573. (defun org-translate-link-from-planner (type path)
  8574. "Translate a link from Emacs Planner syntax so that Org can follow it.
  8575. This is still an experimental function, your mileage may vary."
  8576. (cond
  8577. ((member type '("http" "https" "news" "ftp"))
  8578. ;; standard Internet links are the same.
  8579. nil)
  8580. ((and (equal type "irc") (string-match "^//" path))
  8581. ;; Planner has two / at the beginning of an irc link, we have 1.
  8582. ;; We should have zero, actually....
  8583. (setq path (substring path 1)))
  8584. ((and (equal type "lisp") (string-match "^/" path))
  8585. ;; Planner has a slash, we do not.
  8586. (setq type "elisp" path (substring path 1)))
  8587. ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
  8588. ;; A typical message link. Planner has the id after the final slash,
  8589. ;; we separate it with a hash mark
  8590. (setq path (concat (match-string 1 path) "#"
  8591. (org-remove-angle-brackets (match-string 2 path)))))
  8592. )
  8593. (cons type path))
  8594. (defun org-find-file-at-mouse (ev)
  8595. "Open file link or URL at mouse."
  8596. (interactive "e")
  8597. (mouse-set-point ev)
  8598. (org-open-at-point 'in-emacs))
  8599. (defun org-open-at-mouse (ev)
  8600. "Open file link or URL at mouse.
  8601. See the docstring of `org-open-file' for details."
  8602. (interactive "e")
  8603. (mouse-set-point ev)
  8604. (if (eq major-mode 'org-agenda-mode)
  8605. (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
  8606. (org-open-at-point))
  8607. (defvar org-window-config-before-follow-link nil
  8608. "The window configuration before following a link.
  8609. This is saved in case the need arises to restore it.")
  8610. (defvar org-open-link-marker (make-marker)
  8611. "Marker pointing to the location where `org-open-at-point; was called.")
  8612. ;;;###autoload
  8613. (defun org-open-at-point-global ()
  8614. "Follow a link like Org-mode does.
  8615. This command can be called in any mode to follow a link that has
  8616. Org-mode syntax."
  8617. (interactive)
  8618. (org-run-like-in-org-mode 'org-open-at-point))
  8619. ;;;###autoload
  8620. (defun org-open-link-from-string (s &optional arg reference-buffer)
  8621. "Open a link in the string S, as if it was in Org-mode."
  8622. (interactive "sLink: \nP")
  8623. (let ((reference-buffer (or reference-buffer (current-buffer))))
  8624. (with-temp-buffer
  8625. (let ((org-inhibit-startup (not reference-buffer)))
  8626. (org-mode)
  8627. (insert s)
  8628. (goto-char (point-min))
  8629. (when reference-buffer
  8630. (setq org-link-abbrev-alist-local
  8631. (with-current-buffer reference-buffer
  8632. org-link-abbrev-alist-local)))
  8633. (org-open-at-point arg reference-buffer)))))
  8634. (defvar org-open-at-point-functions nil
  8635. "Hook that is run when following a link at point.
  8636. Functions in this hook must return t if they identify and follow
  8637. a link at point. If they don't find anything interesting at point,
  8638. they must return nil.")
  8639. (defun org-open-at-point (&optional arg reference-buffer)
  8640. "Open link at or after point.
  8641. If there is no link at point, this function will search forward up to
  8642. the end of the current line.
  8643. Normally, files will be opened by an appropriate application. If the
  8644. optional prefix argument ARG is non-nil, Emacs will visit the file.
  8645. With a double prefix argument, try to open outside of Emacs, in the
  8646. application the system uses for this file type."
  8647. (interactive "P")
  8648. ;; if in a code block, then open the block's results
  8649. (unless (call-interactively #'org-babel-open-src-block-result)
  8650. (org-load-modules-maybe)
  8651. (move-marker org-open-link-marker (point))
  8652. (setq org-window-config-before-follow-link (current-window-configuration))
  8653. (org-remove-occur-highlights nil nil t)
  8654. (cond
  8655. ((and (org-at-heading-p)
  8656. (not (org-at-timestamp-p t))
  8657. (not (org-in-regexp
  8658. (concat org-plain-link-re "\\|"
  8659. org-bracket-link-regexp "\\|"
  8660. org-angle-link-re "\\|"
  8661. "[ \t]:[^ \t\n]+:[ \t]*$")))
  8662. (not (get-text-property (point) 'org-linked-text)))
  8663. (or (org-offer-links-in-entry arg)
  8664. (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
  8665. ((run-hook-with-args-until-success 'org-open-at-point-functions))
  8666. ((org-at-timestamp-p t) (org-follow-timestamp-link))
  8667. ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
  8668. (not (org-in-regexp org-bracket-link-regexp)))
  8669. (org-footnote-action))
  8670. (t
  8671. (let (type path link line search (pos (point)))
  8672. (catch 'match
  8673. (save-excursion
  8674. (skip-chars-forward "^]\n\r")
  8675. (when (org-in-regexp org-bracket-link-regexp 1)
  8676. (setq link (org-extract-attributes
  8677. (org-link-unescape (org-match-string-no-properties 1))))
  8678. (while (string-match " *\n *" link)
  8679. (setq link (replace-match " " t t link)))
  8680. (setq link (org-link-expand-abbrev link))
  8681. (cond
  8682. ((or (file-name-absolute-p link)
  8683. (string-match "^\\.\\.?/" link))
  8684. (setq type "file" path link))
  8685. ((string-match org-link-re-with-space3 link)
  8686. (setq type (match-string 1 link) path (match-string 2 link)))
  8687. (t (setq type "thisfile" path link)))
  8688. (throw 'match t)))
  8689. (when (get-text-property (point) 'org-linked-text)
  8690. (setq type "thisfile"
  8691. pos (if (get-text-property (1+ (point)) 'org-linked-text)
  8692. (1+ (point)) (point))
  8693. path (buffer-substring
  8694. (or (previous-single-property-change pos 'org-linked-text)
  8695. (point-min))
  8696. (or (next-single-property-change pos 'org-linked-text)
  8697. (point-max))))
  8698. (throw 'match t))
  8699. (save-excursion
  8700. (when (or (org-in-regexp org-angle-link-re)
  8701. (org-in-regexp org-plain-link-re))
  8702. (setq type (match-string 1)
  8703. path (org-link-unescape (match-string 2)))
  8704. (throw 'match t)))
  8705. (save-excursion
  8706. (when (org-in-regexp (org-re "\\(:[[:alnum:]_@#%:]+\\):[ \t]*$"))
  8707. (setq type "tags"
  8708. path (match-string 1))
  8709. (while (string-match ":" path)
  8710. (setq path (replace-match "+" t t path)))
  8711. (throw 'match t)))
  8712. (when (org-in-regexp "<\\([^><\n]+\\)>")
  8713. (setq type "tree-match"
  8714. path (match-string 1))
  8715. (throw 'match t)))
  8716. (unless path
  8717. (error "No link found"))
  8718. ;; switch back to reference buffer
  8719. ;; needed when if called in a temporary buffer through
  8720. ;; org-open-link-from-string
  8721. (with-current-buffer (or reference-buffer (current-buffer))
  8722. ;; Remove any trailing spaces in path
  8723. (if (string-match " +\\'" path)
  8724. (setq path (replace-match "" t t path)))
  8725. (if (and org-link-translation-function
  8726. (fboundp org-link-translation-function))
  8727. ;; Check if we need to translate the link
  8728. (let ((tmp (funcall org-link-translation-function type path)))
  8729. (setq type (car tmp) path (cdr tmp))))
  8730. (cond
  8731. ((assoc type org-link-protocols)
  8732. (funcall (nth 1 (assoc type org-link-protocols)) path))
  8733. ((equal type "mailto")
  8734. (let ((cmd (car org-link-mailto-program))
  8735. (args (cdr org-link-mailto-program)) args1
  8736. (address path) (subject "") a)
  8737. (if (string-match "\\(.*\\)::\\(.*\\)" path)
  8738. (setq address (match-string 1 path)
  8739. subject (org-link-escape (match-string 2 path))))
  8740. (while args
  8741. (cond
  8742. ((not (stringp (car args))) (push (pop args) args1))
  8743. (t (setq a (pop args))
  8744. (if (string-match "%a" a)
  8745. (setq a (replace-match address t t a)))
  8746. (if (string-match "%s" a)
  8747. (setq a (replace-match subject t t a)))
  8748. (push a args1))))
  8749. (apply cmd (nreverse args1))))
  8750. ((member type '("http" "https" "ftp" "news"))
  8751. (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
  8752. (org-link-escape
  8753. path org-link-escape-chars-browser)
  8754. path))))
  8755. ((string= type "doi")
  8756. (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
  8757. (org-link-escape
  8758. path org-link-escape-chars-browser)
  8759. path))))
  8760. ((member type '("message"))
  8761. (browse-url (concat type ":" path)))
  8762. ((string= type "tags")
  8763. (org-tags-view arg path))
  8764. ((string= type "tree-match")
  8765. (org-occur (concat "\\[" (regexp-quote path) "\\]")))
  8766. ((string= type "file")
  8767. (if (string-match "::\\([0-9]+\\)\\'" path)
  8768. (setq line (string-to-number (match-string 1 path))
  8769. path (substring path 0 (match-beginning 0)))
  8770. (if (string-match "::\\(.+\\)\\'" path)
  8771. (setq search (match-string 1 path)
  8772. path (substring path 0 (match-beginning 0)))))
  8773. (if (string-match "[*?{]" (file-name-nondirectory path))
  8774. (dired path)
  8775. (org-open-file path arg line search)))
  8776. ((string= type "shell")
  8777. (let ((cmd path))
  8778. (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
  8779. (string-match org-confirm-shell-link-not-regexp cmd))
  8780. (not org-confirm-shell-link-function)
  8781. (funcall org-confirm-shell-link-function
  8782. (format "Execute \"%s\" in shell? "
  8783. (org-add-props cmd nil
  8784. 'face 'org-warning))))
  8785. (progn
  8786. (message "Executing %s" cmd)
  8787. (shell-command cmd))
  8788. (error "Abort"))))
  8789. ((string= type "elisp")
  8790. (let ((cmd path))
  8791. (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
  8792. (string-match org-confirm-elisp-link-not-regexp cmd))
  8793. (not org-confirm-elisp-link-function)
  8794. (funcall org-confirm-elisp-link-function
  8795. (format "Execute \"%s\" as elisp? "
  8796. (org-add-props cmd nil
  8797. 'face 'org-warning))))
  8798. (message "%s => %s" cmd
  8799. (if (equal (string-to-char cmd) ?\()
  8800. (eval (read cmd))
  8801. (call-interactively (read cmd))))
  8802. (error "Abort"))))
  8803. ((and (string= type "thisfile")
  8804. (run-hook-with-args-until-success
  8805. 'org-open-link-functions path)))
  8806. ((string= type "thisfile")
  8807. (if arg
  8808. (switch-to-buffer-other-window
  8809. (org-get-buffer-for-internal-link (current-buffer)))
  8810. (org-mark-ring-push))
  8811. (let ((cmd `(org-link-search
  8812. ,path
  8813. ,(cond ((equal arg '(4)) ''occur)
  8814. ((equal arg '(16)) ''org-occur)
  8815. (t nil))
  8816. ,pos)))
  8817. (condition-case nil (let ((org-link-search-inhibit-query t))
  8818. (eval cmd))
  8819. (error (progn (widen) (eval cmd))))))
  8820. (t
  8821. (browse-url-at-point)))))))
  8822. (move-marker org-open-link-marker nil)
  8823. (run-hook-with-args 'org-follow-link-hook)))
  8824. (defun org-offer-links-in-entry (&optional nth zero)
  8825. "Offer links in the current entry and follow the selected link.
  8826. If there is only one link, follow it immediately as well.
  8827. If NTH is an integer, immediately pick the NTH link found.
  8828. If ZERO is a string, check also this string for a link, and if
  8829. there is one, offer it as link number zero."
  8830. (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
  8831. "\\(" org-angle-link-re "\\)\\|"
  8832. "\\(" org-plain-link-re "\\)"))
  8833. (cnt ?0)
  8834. (in-emacs (if (integerp nth) nil nth))
  8835. have-zero end links link c)
  8836. (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
  8837. (push (match-string 0 zero) links)
  8838. (setq cnt (1- cnt) have-zero t))
  8839. (save-excursion
  8840. (org-back-to-heading t)
  8841. (setq end (save-excursion (outline-next-heading) (point)))
  8842. (while (re-search-forward re end t)
  8843. (push (match-string 0) links))
  8844. (setq links (org-uniquify (reverse links))))
  8845. (cond
  8846. ((null links)
  8847. (message "No links"))
  8848. ((equal (length links) 1)
  8849. (setq link (list (car links))))
  8850. ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
  8851. (setq link (list (nth (if have-zero nth (1- nth)) links))))
  8852. (t ; we have to select a link
  8853. (save-excursion
  8854. (save-window-excursion
  8855. (delete-other-windows)
  8856. (with-output-to-temp-buffer "*Select Link*"
  8857. (mapc (lambda (l)
  8858. (if (not (string-match org-bracket-link-regexp l))
  8859. (princ (format "[%c] %s\n" (incf cnt)
  8860. (org-remove-angle-brackets l)))
  8861. (if (match-end 3)
  8862. (princ (format "[%c] %s (%s)\n" (incf cnt)
  8863. (match-string 3 l) (match-string 1 l)))
  8864. (princ (format "[%c] %s\n" (incf cnt)
  8865. (match-string 1 l))))))
  8866. links))
  8867. (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
  8868. (message "Select link to open, RET to open all:")
  8869. (setq c (read-char-exclusive))
  8870. (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
  8871. (when (equal c ?q) (error "Abort"))
  8872. (if (equal c ?\C-m)
  8873. (setq link links)
  8874. (setq nth (- c ?0))
  8875. (if have-zero (setq nth (1+ nth)))
  8876. (unless (and (integerp nth) (>= (length links) nth))
  8877. (error "Invalid link selection"))
  8878. (setq link (list (nth (1- nth) links))))))
  8879. (if link
  8880. (let ((buf (current-buffer)))
  8881. (dolist (l link)
  8882. (org-open-link-from-string l in-emacs buf))
  8883. t)
  8884. nil)))
  8885. ;; Add special file links that specify the way of opening
  8886. (org-add-link-type "file+sys" 'org-open-file-with-system)
  8887. (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
  8888. (defun org-open-file-with-system (path)
  8889. "Open file at PATH using the system way of opening it."
  8890. (org-open-file path 'system))
  8891. (defun org-open-file-with-emacs (path)
  8892. "Open file at PATH in Emacs."
  8893. (org-open-file path 'emacs))
  8894. (defun org-remove-file-link-modifiers ()
  8895. "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
  8896. (goto-char (point-min))
  8897. (while (re-search-forward "\\<file\\+\\(sys\\|emacs\\):" nil t)
  8898. (org-if-unprotected
  8899. (replace-match "file:" t t))))
  8900. (eval-after-load "org-exp"
  8901. '(add-hook 'org-export-preprocess-before-normalizing-links-hook
  8902. 'org-remove-file-link-modifiers))
  8903. ;;;; Time estimates
  8904. (defun org-get-effort (&optional pom)
  8905. "Get the effort estimate for the current entry."
  8906. (org-entry-get pom org-effort-property))
  8907. ;;; File search
  8908. (defvar org-create-file-search-functions nil
  8909. "List of functions to construct the right search string for a file link.
  8910. These functions are called in turn with point at the location to
  8911. which the link should point.
  8912. A function in the hook should first test if it would like to
  8913. handle this file type, for example by checking the `major-mode'
  8914. or the file extension. If it decides not to handle this file, it
  8915. should just return nil to give other functions a chance. If it
  8916. does handle the file, it must return the search string to be used
  8917. when following the link. The search string will be part of the
  8918. file link, given after a double colon, and `org-open-at-point'
  8919. will automatically search for it. If special measures must be
  8920. taken to make the search successful, another function should be
  8921. added to the companion hook `org-execute-file-search-functions',
  8922. which see.
  8923. A function in this hook may also use `setq' to set the variable
  8924. `description' to provide a suggestion for the descriptive text to
  8925. be used for this link when it gets inserted into an Org-mode
  8926. buffer with \\[org-insert-link].")
  8927. (defvar org-execute-file-search-functions nil
  8928. "List of functions to execute a file search triggered by a link.
  8929. Functions added to this hook must accept a single argument, the
  8930. search string that was part of the file link, the part after the
  8931. double colon. The function must first check if it would like to
  8932. handle this search, for example by checking the `major-mode' or
  8933. the file extension. If it decides not to handle this search, it
  8934. should just return nil to give other functions a chance. If it
  8935. does handle the search, it must return a non-nil value to keep
  8936. other functions from trying.
  8937. Each function can access the current prefix argument through the
  8938. variable `current-prefix-argument'. Note that a single prefix is
  8939. used to force opening a link in Emacs, so it may be good to only
  8940. use a numeric or double prefix to guide the search function.
  8941. In case this is needed, a function in this hook can also restore
  8942. the window configuration before `org-open-at-point' was called using:
  8943. (set-window-configuration org-window-config-before-follow-link)")
  8944. (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
  8945. (defun org-link-search (s &optional type avoid-pos stealth)
  8946. "Search for a link search option.
  8947. If S is surrounded by forward slashes, it is interpreted as a
  8948. regular expression. In org-mode files, this will create an `org-occur'
  8949. sparse tree. In ordinary files, `occur' will be used to list matches.
  8950. If the current buffer is in `dired-mode', grep will be used to search
  8951. in all files. If AVOID-POS is given, ignore matches near that position.
  8952. When optional argument STEALTH is non-nil, do not modify
  8953. visibility around point, thus ignoring
  8954. `org-show-hierarchy-above', `org-show-following-heading' and
  8955. `org-show-siblings' variables."
  8956. (let ((case-fold-search t)
  8957. (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
  8958. (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
  8959. (append '(("") (" ") ("\t") ("\n"))
  8960. org-emphasis-alist)
  8961. "\\|") "\\)"))
  8962. (pos (point))
  8963. (pre nil) (post nil)
  8964. words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
  8965. (cond
  8966. ;; First check if there are any special search functions
  8967. ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
  8968. ;; Now try the builtin stuff
  8969. ((and (equal (string-to-char s0) ?#)
  8970. (> (length s0) 1)
  8971. (save-excursion
  8972. (goto-char (point-min))
  8973. (and
  8974. (re-search-forward
  8975. (concat "^[ \t]*:CUSTOM_ID:[ \t]+" (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
  8976. (setq type 'dedicated
  8977. pos (match-beginning 0))))
  8978. ;; There is an exact target for this
  8979. (goto-char pos)
  8980. (org-back-to-heading t)))
  8981. ((save-excursion
  8982. (goto-char (point-min))
  8983. (and
  8984. (re-search-forward
  8985. (concat "<<" (regexp-quote s0) ">>") nil t)
  8986. (setq type 'dedicated
  8987. pos (match-beginning 0))))
  8988. ;; There is an exact target for this
  8989. (goto-char pos))
  8990. ((save-excursion
  8991. (goto-char (point-min))
  8992. (and
  8993. (re-search-forward
  8994. (format "^[ \t]*#\\+TARGET: %s" (regexp-quote s0)) nil t)
  8995. (setq type 'dedicated pos (match-beginning 0))))
  8996. ;; Found an invisible target.
  8997. (goto-char pos))
  8998. ((save-excursion
  8999. (goto-char (point-min))
  9000. (and
  9001. (re-search-forward
  9002. (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
  9003. (setq type 'dedicated pos (match-beginning 0))))
  9004. ;; Found an element with a matching #+name affiliated keyword.
  9005. (goto-char pos))
  9006. ((and (string-match "^(\\(.*\\))$" s0)
  9007. (save-excursion
  9008. (goto-char (point-min))
  9009. (and
  9010. (re-search-forward
  9011. (concat "[^[]" (regexp-quote
  9012. (format org-coderef-label-format
  9013. (match-string 1 s0))))
  9014. nil t)
  9015. (setq type 'dedicated
  9016. pos (1+ (match-beginning 0))))))
  9017. ;; There is a coderef target for this
  9018. (goto-char pos))
  9019. ((string-match "^/\\(.*\\)/$" s)
  9020. ;; A regular expression
  9021. (cond
  9022. ((derived-mode-p 'org-mode)
  9023. (org-occur (match-string 1 s)))
  9024. ;;((eq major-mode 'dired-mode)
  9025. ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
  9026. (t (org-do-occur (match-string 1 s)))))
  9027. ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
  9028. (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
  9029. (goto-char (point-min))
  9030. (cond
  9031. ((let (case-fold-search)
  9032. (re-search-forward (format org-complex-heading-regexp-format
  9033. (regexp-quote s))
  9034. nil t))
  9035. ;; OK, found a match
  9036. (setq type 'dedicated)
  9037. (goto-char (match-beginning 0)))
  9038. ((and (not org-link-search-inhibit-query)
  9039. (eq org-link-search-must-match-exact-headline 'query-to-create)
  9040. (y-or-n-p "No match - create this as a new heading? "))
  9041. (goto-char (point-max))
  9042. (or (bolp) (newline))
  9043. (insert "* " s "\n")
  9044. (beginning-of-line 0))
  9045. (t
  9046. (goto-char pos)
  9047. (error "No match"))))
  9048. (t
  9049. ;; A normal search string
  9050. (when (equal (string-to-char s) ?*)
  9051. ;; Anchor on headlines, post may include tags.
  9052. (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
  9053. post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
  9054. s (substring s 1)))
  9055. (remove-text-properties
  9056. 0 (length s)
  9057. '(face nil mouse-face nil keymap nil fontified nil) s)
  9058. ;; Make a series of regular expressions to find a match
  9059. (setq words (org-split-string s "[ \n\r\t]+")
  9060. re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
  9061. re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
  9062. "\\)" markers)
  9063. re2a_ (concat "\\(" (mapconcat 'downcase words "[ \t\r\n]+") "\\)[ \t\r\n]")
  9064. re2a (concat "[ \t\r\n]" re2a_)
  9065. re4_ (concat "\\(" (mapconcat 'downcase words "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
  9066. re4 (concat "[^a-zA-Z_]" re4_)
  9067. re1 (concat pre re2 post)
  9068. re3 (concat pre (if pre re4_ re4) post)
  9069. re5 (concat pre ".*" re4)
  9070. re2 (concat pre re2)
  9071. re2a (concat pre (if pre re2a_ re2a))
  9072. re4 (concat pre (if pre re4_ re4))
  9073. reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
  9074. "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
  9075. re5 "\\)"
  9076. ))
  9077. (cond
  9078. ((eq type 'org-occur) (org-occur reall))
  9079. ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
  9080. (t (goto-char (point-min))
  9081. (setq type 'fuzzy)
  9082. (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
  9083. (org-search-not-self 1 re1 nil t)
  9084. (org-search-not-self 1 re2 nil t)
  9085. (org-search-not-self 1 re2a nil t)
  9086. (org-search-not-self 1 re3 nil t)
  9087. (org-search-not-self 1 re4 nil t)
  9088. (org-search-not-self 1 re5 nil t)
  9089. )
  9090. (goto-char (match-beginning 1))
  9091. (goto-char pos)
  9092. (error "No match"))))))
  9093. (and (derived-mode-p 'org-mode)
  9094. (not stealth)
  9095. (org-show-context 'link-search))
  9096. type))
  9097. (defun org-search-not-self (group &rest args)
  9098. "Execute `re-search-forward', but only accept matches that do not
  9099. enclose the position of `org-open-link-marker'."
  9100. (let ((m org-open-link-marker))
  9101. (catch 'exit
  9102. (while (apply 're-search-forward args)
  9103. (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
  9104. (goto-char (match-end group))
  9105. (if (and (or (not (eq (marker-buffer m) (current-buffer)))
  9106. (> (match-beginning 0) (marker-position m))
  9107. (< (match-end 0) (marker-position m)))
  9108. (save-match-data
  9109. (or (not (org-in-regexp
  9110. org-bracket-link-analytic-regexp 1))
  9111. (not (match-end 4)) ; no description
  9112. (and (<= (match-beginning 4) (point))
  9113. (>= (match-end 4) (point))))))
  9114. (throw 'exit (point))))))))
  9115. (defun org-get-buffer-for-internal-link (buffer)
  9116. "Return a buffer to be used for displaying the link target of internal links."
  9117. (cond
  9118. ((not org-display-internal-link-with-indirect-buffer)
  9119. buffer)
  9120. ((string-match "(Clone)$" (buffer-name buffer))
  9121. (message "Buffer is already a clone, not making another one")
  9122. ;; we also do not modify visibility in this case
  9123. buffer)
  9124. (t ; make a new indirect buffer for displaying the link
  9125. (let* ((bn (buffer-name buffer))
  9126. (ibn (concat bn "(Clone)"))
  9127. (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
  9128. (with-current-buffer ib (org-overview))
  9129. ib))))
  9130. (defun org-do-occur (regexp &optional cleanup)
  9131. "Call the Emacs command `occur'.
  9132. If CLEANUP is non-nil, remove the printout of the regular expression
  9133. in the *Occur* buffer. This is useful if the regex is long and not useful
  9134. to read."
  9135. (occur regexp)
  9136. (when cleanup
  9137. (let ((cwin (selected-window)) win beg end)
  9138. (when (setq win (get-buffer-window "*Occur*"))
  9139. (select-window win))
  9140. (goto-char (point-min))
  9141. (when (re-search-forward "match[a-z]+" nil t)
  9142. (setq beg (match-end 0))
  9143. (if (re-search-forward "^[ \t]*[0-9]+" nil t)
  9144. (setq end (1- (match-beginning 0)))))
  9145. (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
  9146. (goto-char (point-min))
  9147. (select-window cwin))))
  9148. ;;; The mark ring for links jumps
  9149. (defvar org-mark-ring nil
  9150. "Mark ring for positions before jumps in Org-mode.")
  9151. (defvar org-mark-ring-last-goto nil
  9152. "Last position in the mark ring used to go back.")
  9153. ;; Fill and close the ring
  9154. (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
  9155. (loop for i from 1 to org-mark-ring-length do
  9156. (push (make-marker) org-mark-ring))
  9157. (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
  9158. org-mark-ring)
  9159. (defun org-mark-ring-push (&optional pos buffer)
  9160. "Put the current position or POS into the mark ring and rotate it."
  9161. (interactive)
  9162. (setq pos (or pos (point)))
  9163. (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  9164. (move-marker (car org-mark-ring)
  9165. (or pos (point))
  9166. (or buffer (current-buffer)))
  9167. (message "%s"
  9168. (substitute-command-keys
  9169. "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
  9170. (defun org-mark-ring-goto (&optional n)
  9171. "Jump to the previous position in the mark ring.
  9172. With prefix arg N, jump back that many stored positions. When
  9173. called several times in succession, walk through the entire ring.
  9174. Org-mode commands jumping to a different position in the current file,
  9175. or to another Org-mode file, automatically push the old position
  9176. onto the ring."
  9177. (interactive "p")
  9178. (let (p m)
  9179. (if (eq last-command this-command)
  9180. (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
  9181. (setq p org-mark-ring))
  9182. (setq org-mark-ring-last-goto p)
  9183. (setq m (car p))
  9184. (org-pop-to-buffer-same-window (marker-buffer m))
  9185. (goto-char m)
  9186. (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
  9187. (defun org-remove-angle-brackets (s)
  9188. (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
  9189. (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
  9190. s)
  9191. (defun org-add-angle-brackets (s)
  9192. (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
  9193. (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
  9194. s)
  9195. (defun org-remove-double-quotes (s)
  9196. (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
  9197. (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
  9198. s)
  9199. ;;; Following specific links
  9200. (defun org-follow-timestamp-link ()
  9201. (cond
  9202. ((org-at-date-range-p t)
  9203. (let ((org-agenda-start-on-weekday)
  9204. (t1 (match-string 1))
  9205. (t2 (match-string 2)))
  9206. (setq t1 (time-to-days (org-time-string-to-time t1))
  9207. t2 (time-to-days (org-time-string-to-time t2)))
  9208. (org-agenda-list nil t1 (1+ (- t2 t1)))))
  9209. ((org-at-timestamp-p t)
  9210. (org-agenda-list nil (time-to-days (org-time-string-to-time
  9211. (substring (match-string 1) 0 10)))
  9212. 1))
  9213. (t (error "This should not happen"))))
  9214. ;;; Following file links
  9215. (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
  9216. (declare-function mailcap-extension-to-mime "mailcap" (extn))
  9217. (declare-function mailcap-mime-info
  9218. "mailcap" (string &optional request no-decode))
  9219. (defvar org-wait nil)
  9220. (defun org-open-file (path &optional in-emacs line search)
  9221. "Open the file at PATH.
  9222. First, this expands any special file name abbreviations. Then the
  9223. configuration variable `org-file-apps' is checked if it contains an
  9224. entry for this file type, and if yes, the corresponding command is launched.
  9225. If no application is found, Emacs simply visits the file.
  9226. With optional prefix argument IN-EMACS, Emacs will visit the file.
  9227. With a double \\[universal-argument] \\[universal-argument] \
  9228. prefix arg, Org tries to avoid opening in Emacs
  9229. and to use an external application to visit the file.
  9230. Optional LINE specifies a line to go to, optional SEARCH a string
  9231. to search for. If LINE or SEARCH is given, the file will be
  9232. opened in Emacs, unless an entry from org-file-apps that makes
  9233. use of groups in a regexp matches.
  9234. If you want to change the way frames are used when following a
  9235. link, please customize `org-link-frame-setup'.
  9236. If the file does not exist, an error is thrown."
  9237. (let* ((file (if (equal path "")
  9238. buffer-file-name
  9239. (substitute-in-file-name (expand-file-name path))))
  9240. (file-apps (append org-file-apps (org-default-apps)))
  9241. (apps (org-remove-if
  9242. 'org-file-apps-entry-match-against-dlink-p file-apps))
  9243. (apps-dlink (org-remove-if-not
  9244. 'org-file-apps-entry-match-against-dlink-p file-apps))
  9245. (remp (and (assq 'remote apps) (org-file-remote-p file)))
  9246. (dirp (if remp nil (file-directory-p file)))
  9247. (file (if (and dirp org-open-directory-means-index-dot-org)
  9248. (concat (file-name-as-directory file) "index.org")
  9249. file))
  9250. (a-m-a-p (assq 'auto-mode apps))
  9251. (dfile (downcase file))
  9252. ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
  9253. (link (cond ((and (eq line nil)
  9254. (eq search nil))
  9255. file)
  9256. (line
  9257. (concat file "::" (number-to-string line)))
  9258. (search
  9259. (concat file "::" search))))
  9260. (dlink (downcase link))
  9261. (old-buffer (current-buffer))
  9262. (old-pos (point))
  9263. (old-mode major-mode)
  9264. ext cmd link-match-data)
  9265. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
  9266. (setq ext (match-string 1 dfile))
  9267. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
  9268. (setq ext (match-string 1 dfile))))
  9269. (cond
  9270. ((member in-emacs '((16) system))
  9271. (setq cmd (cdr (assoc 'system apps))))
  9272. (in-emacs (setq cmd 'emacs))
  9273. (t
  9274. (setq cmd (or (and remp (cdr (assoc 'remote apps)))
  9275. (and dirp (cdr (assoc 'directory apps)))
  9276. ; first, try matching against apps-dlink
  9277. ; if we get a match here, store the match data for later
  9278. (let ((match (assoc-default dlink apps-dlink
  9279. 'string-match)))
  9280. (if match
  9281. (progn (setq link-match-data (match-data))
  9282. match)
  9283. (progn (setq in-emacs (or in-emacs line search))
  9284. nil))) ; if we have no match in apps-dlink,
  9285. ; always open the file in emacs if line or search
  9286. ; is given (for backwards compatibility)
  9287. (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
  9288. 'string-match)
  9289. (cdr (assoc ext apps))
  9290. (cdr (assoc t apps))))))
  9291. (when (eq cmd 'system)
  9292. (setq cmd (cdr (assoc 'system apps))))
  9293. (when (eq cmd 'default)
  9294. (setq cmd (cdr (assoc t apps))))
  9295. (when (eq cmd 'mailcap)
  9296. (require 'mailcap)
  9297. (mailcap-parse-mailcaps)
  9298. (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
  9299. (command (mailcap-mime-info mime-type)))
  9300. (if (stringp command)
  9301. (setq cmd command)
  9302. (setq cmd 'emacs))))
  9303. (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
  9304. (not (file-exists-p file))
  9305. (not org-open-non-existing-files))
  9306. (error "No such file: %s" file))
  9307. (cond
  9308. ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
  9309. ;; Remove quotes around the file name - we'll use shell-quote-argument.
  9310. (while (string-match "['\"]%s['\"]" cmd)
  9311. (setq cmd (replace-match "%s" t t cmd)))
  9312. (while (string-match "%s" cmd)
  9313. (setq cmd (replace-match
  9314. (save-match-data
  9315. (shell-quote-argument
  9316. (convert-standard-filename file)))
  9317. t t cmd)))
  9318. ;; Replace "%1", "%2" etc. in command with group matches from regex
  9319. (save-match-data
  9320. (let ((match-index 1)
  9321. (number-of-groups (- (/ (length link-match-data) 2) 1)))
  9322. (set-match-data link-match-data)
  9323. (while (<= match-index number-of-groups)
  9324. (let ((regex (concat "%" (number-to-string match-index)))
  9325. (replace-with (match-string match-index dlink)))
  9326. (while (string-match regex cmd)
  9327. (setq cmd (replace-match replace-with t t cmd))))
  9328. (setq match-index (+ match-index 1)))))
  9329. (save-window-excursion
  9330. (start-process-shell-command cmd nil cmd)
  9331. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
  9332. ))
  9333. ((or (stringp cmd)
  9334. (eq cmd 'emacs))
  9335. (funcall (cdr (assq 'file org-link-frame-setup)) file)
  9336. (widen)
  9337. (if line (org-goto-line line)
  9338. (if search (org-link-search search))))
  9339. ((consp cmd)
  9340. (let ((file (convert-standard-filename file)))
  9341. (save-match-data
  9342. (set-match-data link-match-data)
  9343. (eval cmd))))
  9344. (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
  9345. (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
  9346. (or (not (equal old-buffer (current-buffer)))
  9347. (not (equal old-pos (point))))
  9348. (org-mark-ring-push old-pos old-buffer))))
  9349. (defun org-file-apps-entry-match-against-dlink-p (entry)
  9350. "This function returns non-nil if `entry' uses a regular
  9351. expression which should be matched against the whole link by
  9352. org-open-file.
  9353. It assumes that is the case when the entry uses a regular
  9354. expression which has at least one grouping construct and the
  9355. action is either a lisp form or a command string containing
  9356. '%1', i.e. using at least one subexpression match as a
  9357. parameter."
  9358. (let ((selector (car entry))
  9359. (action (cdr entry)))
  9360. (if (stringp selector)
  9361. (and (> (regexp-opt-depth selector) 0)
  9362. (or (and (stringp action)
  9363. (string-match "%[0-9]" action))
  9364. (consp action)))
  9365. nil)))
  9366. (defun org-default-apps ()
  9367. "Return the default applications for this operating system."
  9368. (cond
  9369. ((eq system-type 'darwin)
  9370. org-file-apps-defaults-macosx)
  9371. ((eq system-type 'windows-nt)
  9372. org-file-apps-defaults-windowsnt)
  9373. (t org-file-apps-defaults-gnu)))
  9374. (defun org-apps-regexp-alist (list &optional add-auto-mode)
  9375. "Convert extensions to regular expressions in the cars of LIST.
  9376. Also, weed out any non-string entries, because the return value is used
  9377. only for regexp matching.
  9378. When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
  9379. point to the symbol `emacs', indicating that the file should
  9380. be opened in Emacs."
  9381. (append
  9382. (delq nil
  9383. (mapcar (lambda (x)
  9384. (if (not (stringp (car x)))
  9385. nil
  9386. (if (string-match "\\W" (car x))
  9387. x
  9388. (cons (concat "\\." (car x) "\\'") (cdr x)))))
  9389. list))
  9390. (if add-auto-mode
  9391. (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
  9392. (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
  9393. (defun org-file-remote-p (file)
  9394. "Test whether FILE specifies a location on a remote system.
  9395. Return non-nil if the location is indeed remote.
  9396. For example, the filename \"/user@host:/foo\" specifies a location
  9397. on the system \"/user@host:\"."
  9398. (cond ((fboundp 'file-remote-p)
  9399. (file-remote-p file))
  9400. ((fboundp 'tramp-handle-file-remote-p)
  9401. (tramp-handle-file-remote-p file))
  9402. ((and (boundp 'ange-ftp-name-format)
  9403. (string-match (car ange-ftp-name-format) file))
  9404. t)
  9405. (t nil)))
  9406. ;;;; Refiling
  9407. (defun org-get-org-file ()
  9408. "Read a filename, with default directory `org-directory'."
  9409. (let ((default (or org-default-notes-file remember-data-file)))
  9410. (read-file-name (format "File name [%s]: " default)
  9411. (file-name-as-directory org-directory)
  9412. default)))
  9413. (defun org-notes-order-reversed-p ()
  9414. "Check if the current file should receive notes in reversed order."
  9415. (cond
  9416. ((not org-reverse-note-order) nil)
  9417. ((eq t org-reverse-note-order) t)
  9418. ((not (listp org-reverse-note-order)) nil)
  9419. (t (catch 'exit
  9420. (let ((all org-reverse-note-order)
  9421. entry)
  9422. (while (setq entry (pop all))
  9423. (if (string-match (car entry) buffer-file-name)
  9424. (throw 'exit (cdr entry))))
  9425. nil)))))
  9426. (defvar org-refile-target-table nil
  9427. "The list of refile targets, created by `org-refile'.")
  9428. (defvar org-agenda-new-buffers nil
  9429. "Buffers created to visit agenda files.")
  9430. (defvar org-refile-cache nil
  9431. "Cache for refile targets.")
  9432. (defvar org-refile-markers nil
  9433. "All the markers used for caching refile locations.")
  9434. (defun org-refile-marker (pos)
  9435. "Get a new refile marker, but only if caching is in use."
  9436. (if (not org-refile-use-cache)
  9437. pos
  9438. (let ((m (make-marker)))
  9439. (move-marker m pos)
  9440. (push m org-refile-markers)
  9441. m)))
  9442. (defun org-refile-cache-clear ()
  9443. "Clear the refile cache and disable all the markers."
  9444. (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
  9445. (setq org-refile-markers nil)
  9446. (setq org-refile-cache nil)
  9447. (message "Refile cache has been cleared"))
  9448. (defun org-refile-cache-check-set (set)
  9449. "Check if all the markers in the cache still have live buffers."
  9450. (let (marker)
  9451. (catch 'exit
  9452. (while (and set (setq marker (nth 3 (pop set))))
  9453. ;; if org-refile-use-outline-path is 'file, marker may be nil
  9454. (when (and marker (null (marker-buffer marker)))
  9455. (message "not found") (sit-for 3)
  9456. (throw 'exit nil)))
  9457. t)))
  9458. (defun org-refile-cache-put (set &rest identifiers)
  9459. "Push the refile targets SET into the cache, under IDENTIFIERS."
  9460. (let* ((key (sha1 (prin1-to-string identifiers)))
  9461. (entry (assoc key org-refile-cache)))
  9462. (if entry
  9463. (setcdr entry set)
  9464. (push (cons key set) org-refile-cache))))
  9465. (defun org-refile-cache-get (&rest identifiers)
  9466. "Retrieve the cached value for refile targets given by IDENTIFIERS."
  9467. (cond
  9468. ((not org-refile-cache) nil)
  9469. ((not org-refile-use-cache) (org-refile-cache-clear) nil)
  9470. (t
  9471. (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
  9472. org-refile-cache))))
  9473. (and set (org-refile-cache-check-set set) set)))))
  9474. (defun org-refile-get-targets (&optional default-buffer excluded-entries)
  9475. "Produce a table with refile targets."
  9476. (let ((case-fold-search nil)
  9477. ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
  9478. (entries (or org-refile-targets '((nil . (:level . 1)))))
  9479. targets tgs txt re files f desc descre fast-path-p level pos0)
  9480. (message "Getting targets...")
  9481. (with-current-buffer (or default-buffer (current-buffer))
  9482. (while (setq entry (pop entries))
  9483. (setq files (car entry) desc (cdr entry))
  9484. (setq fast-path-p nil)
  9485. (cond
  9486. ((null files) (setq files (list (current-buffer))))
  9487. ((eq files 'org-agenda-files)
  9488. (setq files (org-agenda-files 'unrestricted)))
  9489. ((and (symbolp files) (fboundp files))
  9490. (setq files (funcall files)))
  9491. ((and (symbolp files) (boundp files))
  9492. (setq files (symbol-value files))))
  9493. (if (stringp files) (setq files (list files)))
  9494. (cond
  9495. ((eq (car desc) :tag)
  9496. (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
  9497. ((eq (car desc) :todo)
  9498. (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
  9499. ((eq (car desc) :regexp)
  9500. (setq descre (cdr desc)))
  9501. ((eq (car desc) :level)
  9502. (setq descre (concat "^\\*\\{" (number-to-string
  9503. (if org-odd-levels-only
  9504. (1- (* 2 (cdr desc)))
  9505. (cdr desc)))
  9506. "\\}[ \t]")))
  9507. ((eq (car desc) :maxlevel)
  9508. (setq fast-path-p t)
  9509. (setq descre (concat "^\\*\\{1," (number-to-string
  9510. (if org-odd-levels-only
  9511. (1- (* 2 (cdr desc)))
  9512. (cdr desc)))
  9513. "\\}[ \t]")))
  9514. (t (error "Bad refiling target description %s" desc)))
  9515. (while (setq f (pop files))
  9516. (with-current-buffer
  9517. (if (bufferp f) f (org-get-agenda-file-buffer f))
  9518. (or
  9519. (setq tgs (org-refile-cache-get (buffer-file-name) descre))
  9520. (progn
  9521. (if (bufferp f) (setq f (buffer-file-name
  9522. (buffer-base-buffer f))))
  9523. (setq f (and f (expand-file-name f)))
  9524. (if (eq org-refile-use-outline-path 'file)
  9525. (push (list (file-name-nondirectory f) f nil nil) tgs))
  9526. (save-excursion
  9527. (save-restriction
  9528. (widen)
  9529. (goto-char (point-min))
  9530. (while (re-search-forward descre nil t)
  9531. (goto-char (setq pos0 (point-at-bol)))
  9532. (catch 'next
  9533. (when org-refile-target-verify-function
  9534. (save-match-data
  9535. (or (funcall org-refile-target-verify-function)
  9536. (throw 'next t))))
  9537. (when (and (looking-at org-complex-heading-regexp)
  9538. (not (member (match-string 4) excluded-entries))
  9539. (match-string 4))
  9540. (setq level (org-reduced-level
  9541. (- (match-end 1) (match-beginning 1)))
  9542. txt (org-link-display-format (match-string 4))
  9543. txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
  9544. re (format org-complex-heading-regexp-format
  9545. (regexp-quote (match-string 4))))
  9546. (when org-refile-use-outline-path
  9547. (setq txt (mapconcat
  9548. 'org-protect-slash
  9549. (append
  9550. (if (eq org-refile-use-outline-path
  9551. 'file)
  9552. (list (file-name-nondirectory
  9553. (buffer-file-name
  9554. (buffer-base-buffer))))
  9555. (if (eq org-refile-use-outline-path
  9556. 'full-file-path)
  9557. (list (buffer-file-name
  9558. (buffer-base-buffer)))))
  9559. (org-get-outline-path fast-path-p
  9560. level txt)
  9561. (list txt))
  9562. "/")))
  9563. (push (list txt f re (org-refile-marker (point)))
  9564. tgs)))
  9565. (when (= (point) pos0)
  9566. ;; verification function has not moved point
  9567. (goto-char (point-at-eol))))))))
  9568. (when org-refile-use-cache
  9569. (org-refile-cache-put tgs (buffer-file-name) descre))
  9570. (setq targets (append tgs targets))
  9571. ))))
  9572. (message "Getting targets...done")
  9573. (nreverse targets)))
  9574. (defun org-protect-slash (s)
  9575. (while (string-match "/" s)
  9576. (setq s (replace-match "\\" t t s)))
  9577. s)
  9578. (defvar org-olpa (make-vector 20 nil))
  9579. (defun org-get-outline-path (&optional fastp level heading)
  9580. "Return the outline path to the current entry, as a list.
  9581. The parameters FASTP, LEVEL, and HEADING are for use by a scanner
  9582. routine which makes outline path derivations for an entire file,
  9583. avoiding backtracing. Refile target collection makes use of that."
  9584. (if fastp
  9585. (progn
  9586. (if (> level 19)
  9587. (error "Outline path failure, more than 19 levels"))
  9588. (loop for i from level upto 19 do
  9589. (aset org-olpa i nil))
  9590. (prog1
  9591. (delq nil (append org-olpa nil))
  9592. (aset org-olpa level heading)))
  9593. (let (rtn case-fold-search)
  9594. (save-excursion
  9595. (save-restriction
  9596. (widen)
  9597. (while (org-up-heading-safe)
  9598. (when (looking-at org-complex-heading-regexp)
  9599. (push (org-match-string-no-properties 4) rtn)))
  9600. rtn)))))
  9601. (defun org-format-outline-path (path &optional width prefix)
  9602. "Format the outline path PATH for display.
  9603. Width is the maximum number of characters that is available.
  9604. Prefix is a prefix to be included in the returned string,
  9605. such as the file name."
  9606. (setq width (or width 79))
  9607. (if prefix (setq width (- width (length prefix))))
  9608. (if (not path)
  9609. (or prefix "")
  9610. (let* ((nsteps (length path))
  9611. (total-width (+ nsteps (apply '+ (mapcar 'length path))))
  9612. (maxwidth (if (<= total-width width)
  9613. 10000 ;; everything fits
  9614. ;; we need to shorten the level headings
  9615. (/ (- width nsteps) nsteps)))
  9616. (org-odd-levels-only nil)
  9617. (n 0)
  9618. (total (1+ (length prefix))))
  9619. (setq maxwidth (max maxwidth 10))
  9620. (concat prefix
  9621. (mapconcat
  9622. (lambda (h)
  9623. (setq n (1+ n))
  9624. (if (and (= n nsteps) (< maxwidth 10000))
  9625. (setq maxwidth (- total-width total)))
  9626. (if (< (length h) maxwidth)
  9627. (progn (setq total (+ total (length h) 1)) h)
  9628. (setq h (substring h 0 (- maxwidth 2))
  9629. total (+ total maxwidth 1))
  9630. (if (string-match "[ \t]+\\'" h)
  9631. (setq h (substring h 0 (match-beginning 0))))
  9632. (setq h (concat h "..")))
  9633. (org-add-props h nil 'face
  9634. (nth (% (1- n) org-n-level-faces)
  9635. org-level-faces))
  9636. h)
  9637. path "/")))))
  9638. (defun org-display-outline-path (&optional file current)
  9639. "Display the current outline path in the echo area."
  9640. (interactive "P")
  9641. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  9642. (case-fold-search nil)
  9643. (path (and (derived-mode-p 'org-mode) (org-get-outline-path))))
  9644. (if current (setq path (append path
  9645. (save-excursion
  9646. (org-back-to-heading t)
  9647. (if (looking-at org-complex-heading-regexp)
  9648. (list (match-string 4)))))))
  9649. (message "%s"
  9650. (org-format-outline-path
  9651. path
  9652. (1- (frame-width))
  9653. (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
  9654. (defvar org-refile-history nil
  9655. "History for refiling operations.")
  9656. (defvar org-after-refile-insert-hook nil
  9657. "Hook run after `org-refile' has inserted its stuff at the new location.
  9658. Note that this is still *before* the stuff will be removed from
  9659. the *old* location.")
  9660. (defvar org-capture-last-stored-marker)
  9661. (defun org-refile (&optional goto default-buffer rfloc)
  9662. "Move the entry or entries at point to another heading.
  9663. The list of target headings is compiled using the information in
  9664. `org-refile-targets', which see.
  9665. At the target location, the entry is filed as a subitem of the target
  9666. heading. Depending on `org-reverse-note-order', the new subitem will
  9667. either be the first or the last subitem.
  9668. If there is an active region, all entries in that region will be moved.
  9669. However, the region must fulfill the requirement that the first heading
  9670. is the first one sets the top-level of the moved text - at most siblings
  9671. below it are allowed.
  9672. With prefix arg GOTO, the command will only visit the target location
  9673. and not actually move anything.
  9674. With a double prefix arg \\[universal-argument] \\[universal-argument], \
  9675. go to the location where the last refiling operation has put the subtree.
  9676. With a prefix argument of `2', refile to the running clock.
  9677. RFLOC can be a refile location obtained in a different way.
  9678. See also `org-refile-use-outline-path' and `org-completion-use-ido'.
  9679. If you are using target caching (see `org-refile-use-cache'),
  9680. you have to clear the target cache in order to find new targets.
  9681. This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
  9682. prefix argument (`C-u C-u C-u C-c C-w')."
  9683. (interactive "P")
  9684. (if (member goto '(0 (64)))
  9685. (org-refile-cache-clear)
  9686. (let* ((cbuf (current-buffer))
  9687. (regionp (org-region-active-p))
  9688. (region-start (and regionp (region-beginning)))
  9689. (region-end (and regionp (region-end)))
  9690. (region-length (and regionp (- region-end region-start)))
  9691. (filename (buffer-file-name (buffer-base-buffer cbuf)))
  9692. pos it nbuf file re level reversed)
  9693. (setq last-command nil)
  9694. (when regionp
  9695. (goto-char region-start)
  9696. (or (bolp) (goto-char (point-at-bol)))
  9697. (setq region-start (point))
  9698. (unless (or (org-kill-is-subtree-p
  9699. (buffer-substring region-start region-end))
  9700. (prog1 org-refile-active-region-within-subtree
  9701. (org-toggle-heading)))
  9702. (error "The region is not a (sequence of) subtree(s)")))
  9703. (if (equal goto '(16))
  9704. (org-refile-goto-last-stored)
  9705. (when (or
  9706. (and (equal goto 2)
  9707. org-clock-hd-marker (marker-buffer org-clock-hd-marker)
  9708. (prog1
  9709. (setq it (list (or org-clock-heading "running clock")
  9710. (buffer-file-name
  9711. (marker-buffer org-clock-hd-marker))
  9712. ""
  9713. (marker-position org-clock-hd-marker)))
  9714. (setq goto nil)))
  9715. (setq it (or rfloc
  9716. (let (heading-text)
  9717. (save-excursion
  9718. (unless goto
  9719. (org-back-to-heading t)
  9720. (setq heading-text
  9721. (nth 4 (org-heading-components))))
  9722. (org-refile-get-location
  9723. (cond (goto "Goto")
  9724. (regionp "Refile region to")
  9725. (t (concat "Refile subtree \""
  9726. heading-text "\" to")))
  9727. default-buffer
  9728. (and (not (equal '(4) goto))
  9729. org-refile-allow-creating-parent-nodes)
  9730. goto))))))
  9731. (setq file (nth 1 it)
  9732. re (nth 2 it)
  9733. pos (nth 3 it))
  9734. (if (and (not goto)
  9735. pos
  9736. (equal (buffer-file-name) file)
  9737. (if regionp
  9738. (and (>= pos region-start)
  9739. (<= pos region-end))
  9740. (and (>= pos (point))
  9741. (< pos (save-excursion
  9742. (org-end-of-subtree t t))))))
  9743. (error "Cannot refile to position inside the tree or region"))
  9744. (setq nbuf (or (find-buffer-visiting file)
  9745. (find-file-noselect file)))
  9746. (if goto
  9747. (progn
  9748. (org-pop-to-buffer-same-window nbuf)
  9749. (goto-char pos)
  9750. (org-show-context 'org-goto))
  9751. (if regionp
  9752. (progn
  9753. (org-kill-new (buffer-substring region-start region-end))
  9754. (org-save-markers-in-region region-start region-end))
  9755. (org-copy-subtree 1 nil t))
  9756. (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
  9757. (find-file-noselect file)))
  9758. (setq reversed (org-notes-order-reversed-p))
  9759. (save-excursion
  9760. (save-restriction
  9761. (widen)
  9762. (if pos
  9763. (progn
  9764. (goto-char pos)
  9765. (looking-at org-outline-regexp)
  9766. (setq level (org-get-valid-level (funcall outline-level) 1))
  9767. (goto-char
  9768. (if reversed
  9769. (or (outline-next-heading) (point-max))
  9770. (or (save-excursion (org-get-next-sibling))
  9771. (org-end-of-subtree t t)
  9772. (point-max)))))
  9773. (setq level 1)
  9774. (if (not reversed)
  9775. (goto-char (point-max))
  9776. (goto-char (point-min))
  9777. (or (outline-next-heading) (goto-char (point-max)))))
  9778. (if (not (bolp)) (newline))
  9779. (org-paste-subtree level)
  9780. (when org-log-refile
  9781. (org-add-log-setup 'refile nil nil 'findpos
  9782. org-log-refile)
  9783. (unless (eq org-log-refile 'note)
  9784. (save-excursion (org-add-log-note))))
  9785. (and org-auto-align-tags
  9786. (let ((org-loop-over-headlines-in-active-region nil))
  9787. (org-set-tags nil t)))
  9788. (bookmark-set "org-refile-last-stored")
  9789. ;; If we are refiling for capture, make sure that the
  9790. ;; last-capture pointers point here
  9791. (when (org-bound-and-true-p org-refile-for-capture)
  9792. (bookmark-set "org-capture-last-stored-marker")
  9793. (move-marker org-capture-last-stored-marker (point)))
  9794. (if (fboundp 'deactivate-mark) (deactivate-mark))
  9795. (run-hooks 'org-after-refile-insert-hook))))
  9796. (if regionp
  9797. (delete-region (point) (+ (point) region-length))
  9798. (org-cut-subtree))
  9799. (when (featurep 'org-inlinetask)
  9800. (org-inlinetask-remove-END-maybe))
  9801. (setq org-markers-to-move nil)
  9802. (message "Refiled to \"%s\" in file %s" (car it) file)))))))
  9803. (defun org-refile-goto-last-stored ()
  9804. "Go to the location where the last refile was stored."
  9805. (interactive)
  9806. (bookmark-jump "org-refile-last-stored")
  9807. (message "This is the location of the last refile"))
  9808. (defun org-refile-get-location (&optional prompt default-buffer new-nodes
  9809. no-exclude)
  9810. "Prompt the user for a refile location, using PROMPT.
  9811. PROMPT should not be suffixed with a colon and a space, because
  9812. this function appends the default value from
  9813. `org-refile-history' automatically, if that is not empty.
  9814. When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
  9815. this is used for the GOTO interface."
  9816. (let ((org-refile-targets org-refile-targets)
  9817. (org-refile-use-outline-path org-refile-use-outline-path)
  9818. excluded-entries)
  9819. (when (and (derived-mode-p 'org-mode)
  9820. (not org-refile-use-cache)
  9821. (not no-exclude))
  9822. (org-map-tree
  9823. (lambda()
  9824. (setq excluded-entries
  9825. (append excluded-entries (list (org-get-heading t t)))))))
  9826. (setq org-refile-target-table
  9827. (org-refile-get-targets default-buffer excluded-entries)))
  9828. (unless org-refile-target-table
  9829. (error "No refile targets"))
  9830. (let* ((prompt (concat prompt
  9831. (and (car org-refile-history)
  9832. (concat " (default " (car org-refile-history) ")"))
  9833. ": "))
  9834. (cbuf (current-buffer))
  9835. (partial-completion-mode nil)
  9836. (cfn (buffer-file-name (buffer-base-buffer cbuf)))
  9837. (cfunc (if (and org-refile-use-outline-path
  9838. org-outline-path-complete-in-steps)
  9839. 'org-olpath-completing-read
  9840. 'org-icompleting-read))
  9841. (extra (if org-refile-use-outline-path "/" ""))
  9842. (filename (and cfn (expand-file-name cfn)))
  9843. (tbl (mapcar
  9844. (lambda (x)
  9845. (if (and (not (member org-refile-use-outline-path
  9846. '(file full-file-path)))
  9847. (not (equal filename (nth 1 x))))
  9848. (cons (concat (car x) extra " ("
  9849. (file-name-nondirectory (nth 1 x)) ")")
  9850. (cdr x))
  9851. (cons (concat (car x) extra) (cdr x))))
  9852. org-refile-target-table))
  9853. (completion-ignore-case t)
  9854. pa answ parent-target child parent old-hist)
  9855. (setq old-hist org-refile-history)
  9856. (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
  9857. nil 'org-refile-history (car org-refile-history)))
  9858. (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
  9859. (org-refile-check-position pa)
  9860. (if pa
  9861. (progn
  9862. (when (or (not org-refile-history)
  9863. (not (eq old-hist org-refile-history))
  9864. (not (equal (car pa) (car org-refile-history))))
  9865. (setq org-refile-history
  9866. (cons (car pa) (if (assoc (car org-refile-history) tbl)
  9867. org-refile-history
  9868. (cdr org-refile-history))))
  9869. (if (equal (car org-refile-history) (nth 1 org-refile-history))
  9870. (pop org-refile-history)))
  9871. pa)
  9872. (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
  9873. (progn
  9874. (setq parent (match-string 1 answ)
  9875. child (match-string 2 answ))
  9876. (setq parent-target (or (assoc parent tbl)
  9877. (assoc (concat parent "/") tbl)))
  9878. (when (and parent-target
  9879. (or (eq new-nodes t)
  9880. (and (eq new-nodes 'confirm)
  9881. (y-or-n-p (format "Create new node \"%s\"? "
  9882. child)))))
  9883. (org-refile-new-child parent-target child)))
  9884. (error "Invalid target location")))))
  9885. (declare-function org-string-nw-p "org-macs.el" (s))
  9886. (defun org-refile-check-position (refile-pointer)
  9887. "Check if the refile pointer matches the readline to which it points."
  9888. (let* ((file (nth 1 refile-pointer))
  9889. (re (nth 2 refile-pointer))
  9890. (pos (nth 3 refile-pointer))
  9891. buffer)
  9892. (when (org-string-nw-p re)
  9893. (setq buffer (if (markerp pos)
  9894. (marker-buffer pos)
  9895. (or (find-buffer-visiting file)
  9896. (find-file-noselect file))))
  9897. (with-current-buffer buffer
  9898. (save-excursion
  9899. (save-restriction
  9900. (widen)
  9901. (goto-char pos)
  9902. (beginning-of-line 1)
  9903. (unless (org-looking-at-p re)
  9904. (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
  9905. (defun org-refile-new-child (parent-target child)
  9906. "Use refile target PARENT-TARGET to add new CHILD below it."
  9907. (unless parent-target
  9908. (error "Cannot find parent for new node"))
  9909. (let ((file (nth 1 parent-target))
  9910. (pos (nth 3 parent-target))
  9911. level)
  9912. (with-current-buffer (or (find-buffer-visiting file)
  9913. (find-file-noselect file))
  9914. (save-excursion
  9915. (save-restriction
  9916. (widen)
  9917. (if pos
  9918. (goto-char pos)
  9919. (goto-char (point-max))
  9920. (if (not (bolp)) (newline)))
  9921. (when (looking-at org-outline-regexp)
  9922. (setq level (funcall outline-level))
  9923. (org-end-of-subtree t t))
  9924. (org-back-over-empty-lines)
  9925. (insert "\n" (make-string
  9926. (if pos (org-get-valid-level level 1) 1) ?*)
  9927. " " child "\n")
  9928. (beginning-of-line 0)
  9929. (list (concat (car parent-target) "/" child) file "" (point)))))))
  9930. (defun org-olpath-completing-read (prompt collection &rest args)
  9931. "Read an outline path like a file name."
  9932. (let ((thetable collection)
  9933. (org-completion-use-ido nil) ; does not work with ido.
  9934. (org-completion-use-iswitchb nil)) ; or iswitchb
  9935. (apply
  9936. 'org-icompleting-read prompt
  9937. (lambda (string predicate &optional flag)
  9938. (let (rtn r f (l (length string)))
  9939. (cond
  9940. ((eq flag nil)
  9941. ;; try completion
  9942. (try-completion string thetable))
  9943. ((eq flag t)
  9944. ;; all-completions
  9945. (setq rtn (all-completions string thetable predicate))
  9946. (mapcar
  9947. (lambda (x)
  9948. (setq r (substring x l))
  9949. (if (string-match " ([^)]*)$" x)
  9950. (setq f (match-string 0 x))
  9951. (setq f ""))
  9952. (if (string-match "/" r)
  9953. (concat string (substring r 0 (match-end 0)) f)
  9954. x))
  9955. rtn))
  9956. ((eq flag 'lambda)
  9957. ;; exact match?
  9958. (assoc string thetable)))))
  9959. args)))
  9960. ;;;; Dynamic blocks
  9961. (defun org-find-dblock (name)
  9962. "Find the first dynamic block with name NAME in the buffer.
  9963. If not found, stay at current position and return nil."
  9964. (let (pos)
  9965. (save-excursion
  9966. (goto-char (point-min))
  9967. (setq pos (and (re-search-forward (concat "^[ \t]*#\\+BEGIN:[ \t]+" name "\\>")
  9968. nil t)
  9969. (match-beginning 0))))
  9970. (if pos (goto-char pos))
  9971. pos))
  9972. (defconst org-dblock-start-re
  9973. "^[ \t]*#\\+BEGIN:[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
  9974. "Matches the start line of a dynamic block, with parameters.")
  9975. (defconst org-dblock-end-re "^[ \t]*#\\+END\\([: \t\r\n]\\|$\\)"
  9976. "Matches the end of a dynamic block.")
  9977. (defun org-create-dblock (plist)
  9978. "Create a dynamic block section, with parameters taken from PLIST.
  9979. PLIST must contain a :name entry which is used as name of the block."
  9980. (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
  9981. (end-of-line 1)
  9982. (newline))
  9983. (let ((col (current-column))
  9984. (name (plist-get plist :name)))
  9985. (insert "#+BEGIN: " name)
  9986. (while plist
  9987. (if (eq (car plist) :name)
  9988. (setq plist (cddr plist))
  9989. (insert " " (prin1-to-string (pop plist)))))
  9990. (insert "\n\n" (make-string col ?\ ) "#+END:\n")
  9991. (beginning-of-line -2)))
  9992. (defun org-prepare-dblock ()
  9993. "Prepare dynamic block for refresh.
  9994. This empties the block, puts the cursor at the insert position and returns
  9995. the property list including an extra property :name with the block name."
  9996. (unless (looking-at org-dblock-start-re)
  9997. (error "Not at a dynamic block"))
  9998. (let* ((begdel (1+ (match-end 0)))
  9999. (name (org-no-properties (match-string 1)))
  10000. (params (append (list :name name)
  10001. (read (concat "(" (match-string 3) ")")))))
  10002. (save-excursion
  10003. (beginning-of-line 1)
  10004. (skip-chars-forward " \t")
  10005. (setq params (plist-put params :indentation-column (current-column))))
  10006. (unless (re-search-forward org-dblock-end-re nil t)
  10007. (error "Dynamic block not terminated"))
  10008. (setq params
  10009. (append params
  10010. (list :content (buffer-substring
  10011. begdel (match-beginning 0)))))
  10012. (delete-region begdel (match-beginning 0))
  10013. (goto-char begdel)
  10014. (open-line 1)
  10015. params))
  10016. (defun org-map-dblocks (&optional command)
  10017. "Apply COMMAND to all dynamic blocks in the current buffer.
  10018. If COMMAND is not given, use `org-update-dblock'."
  10019. (let ((cmd (or command 'org-update-dblock)))
  10020. (save-excursion
  10021. (goto-char (point-min))
  10022. (while (re-search-forward org-dblock-start-re nil t)
  10023. (goto-char (match-beginning 0))
  10024. (save-excursion
  10025. (condition-case nil
  10026. (funcall cmd)
  10027. (error (message "Error during update of dynamic block"))))
  10028. (unless (re-search-forward org-dblock-end-re nil t)
  10029. (error "Dynamic block not terminated"))))))
  10030. (defun org-dblock-update (&optional arg)
  10031. "User command for updating dynamic blocks.
  10032. Update the dynamic block at point. With prefix ARG, update all dynamic
  10033. blocks in the buffer."
  10034. (interactive "P")
  10035. (if arg
  10036. (org-update-all-dblocks)
  10037. (or (looking-at org-dblock-start-re)
  10038. (org-beginning-of-dblock))
  10039. (org-update-dblock)))
  10040. (defun org-update-dblock ()
  10041. "Update the dynamic block at point.
  10042. This means to empty the block, parse for parameters and then call
  10043. the correct writing function."
  10044. (interactive)
  10045. (save-window-excursion
  10046. (let* ((pos (point))
  10047. (line (org-current-line))
  10048. (params (org-prepare-dblock))
  10049. (name (plist-get params :name))
  10050. (indent (plist-get params :indentation-column))
  10051. (cmd (intern (concat "org-dblock-write:" name))))
  10052. (message "Updating dynamic block `%s' at line %d..." name line)
  10053. (funcall cmd params)
  10054. (message "Updating dynamic block `%s' at line %d...done" name line)
  10055. (goto-char pos)
  10056. (when (and indent (> indent 0))
  10057. (setq indent (make-string indent ?\ ))
  10058. (save-excursion
  10059. (org-beginning-of-dblock)
  10060. (forward-line 1)
  10061. (while (not (looking-at org-dblock-end-re))
  10062. (insert indent)
  10063. (beginning-of-line 2))
  10064. (when (looking-at org-dblock-end-re)
  10065. (and (looking-at "[ \t]+")
  10066. (replace-match ""))
  10067. (insert indent)))))))
  10068. (defun org-beginning-of-dblock ()
  10069. "Find the beginning of the dynamic block at point.
  10070. Error if there is no such block at point."
  10071. (let ((pos (point))
  10072. beg)
  10073. (end-of-line 1)
  10074. (if (and (re-search-backward org-dblock-start-re nil t)
  10075. (setq beg (match-beginning 0))
  10076. (re-search-forward org-dblock-end-re nil t)
  10077. (> (match-end 0) pos))
  10078. (goto-char beg)
  10079. (goto-char pos)
  10080. (error "Not in a dynamic block"))))
  10081. ;;;###autoload
  10082. (defun org-update-all-dblocks ()
  10083. "Update all dynamic blocks in the buffer.
  10084. This function can be used in a hook."
  10085. (interactive)
  10086. (when (derived-mode-p 'org-mode)
  10087. (org-map-dblocks 'org-update-dblock)))
  10088. ;;;; Completion
  10089. (defconst org-additional-option-like-keywords
  10090. '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
  10091. "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
  10092. "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
  10093. "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
  10094. "BEGIN:" "END:"
  10095. "ORGTBL" "TBLFM:" "TBLNAME:"
  10096. "BEGIN_EXAMPLE" "END_EXAMPLE"
  10097. "BEGIN_QUOTE" "END_QUOTE"
  10098. "BEGIN_VERSE" "END_VERSE"
  10099. "BEGIN_CENTER" "END_CENTER"
  10100. "BEGIN_SRC" "END_SRC"
  10101. "BEGIN_RESULT" "END_RESULT"
  10102. "NAME:" "RESULTS:"
  10103. "HEADER:" "HEADERS:"
  10104. "CATEGORY:" "COLUMNS:" "PROPERTY:"
  10105. "CAPTION:" "LABEL:"
  10106. "SETUPFILE:"
  10107. "INCLUDE:"
  10108. "BIND:"
  10109. "MACRO:"))
  10110. (defcustom org-structure-template-alist
  10111. '(
  10112. ("s" "#+BEGIN_SRC ?\n\n#+END_SRC"
  10113. "<src lang=\"?\">\n\n</src>")
  10114. ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE"
  10115. "<example>\n?\n</example>")
  10116. ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE"
  10117. "<quote>\n?\n</quote>")
  10118. ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE"
  10119. "<verse>\n?\n</verse>")
  10120. ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER"
  10121. "<center>\n?\n</center>")
  10122. ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX"
  10123. "<literal style=\"latex\">\n?\n</literal>")
  10124. ("L" "#+LaTeX: "
  10125. "<literal style=\"latex\">?</literal>")
  10126. ("h" "#+BEGIN_HTML\n?\n#+END_HTML"
  10127. "<literal style=\"html\">\n?\n</literal>")
  10128. ("H" "#+HTML: "
  10129. "<literal style=\"html\">?</literal>")
  10130. ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
  10131. ("A" "#+ASCII: ")
  10132. ("i" "#+INDEX: ?"
  10133. "#+INDEX: ?")
  10134. ("I" "#+INCLUDE %file ?"
  10135. "<include file=%file markup=\"?\">")
  10136. )
  10137. "Structure completion elements.
  10138. This is a list of abbreviation keys and values. The value gets inserted
  10139. if you type `<' followed by the key and then press the completion key,
  10140. usually `M-TAB'. %file will be replaced by a file name after prompting
  10141. for the file using completion. The cursor will be placed at the position
  10142. of the `?` in the template.
  10143. There are two templates for each key, the first uses the original Org syntax,
  10144. the second uses Emacs Muse-like syntax tags. These Muse-like tags become
  10145. the default when the /org-mtags.el/ module has been loaded. See also the
  10146. variable `org-mtags-prefer-muse-templates'."
  10147. :group 'org-completion
  10148. :type '(repeat
  10149. (string :tag "Key")
  10150. (string :tag "Template")
  10151. (string :tag "Muse Template")))
  10152. (defun org-try-structure-completion ()
  10153. "Try to complete a structure template before point.
  10154. This looks for strings like \"<e\" on an otherwise empty line and
  10155. expands them."
  10156. (let ((l (buffer-substring (point-at-bol) (point)))
  10157. a)
  10158. (when (and (looking-at "[ \t]*$")
  10159. (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
  10160. (setq a (assoc (match-string 1 l) org-structure-template-alist)))
  10161. (org-complete-expand-structure-template (+ -1 (point-at-bol)
  10162. (match-beginning 1)) a)
  10163. t)))
  10164. (defun org-complete-expand-structure-template (start cell)
  10165. "Expand a structure template."
  10166. (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
  10167. (rpl (nth (if musep 2 1) cell))
  10168. (ind ""))
  10169. (delete-region start (point))
  10170. (when (string-match "\\`#\\+" rpl)
  10171. (cond
  10172. ((bolp))
  10173. ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
  10174. (setq ind (buffer-substring (point-at-bol) (point))))
  10175. (t (newline))))
  10176. (setq start (point))
  10177. (if (string-match "%file" rpl)
  10178. (setq rpl (replace-match
  10179. (concat
  10180. "\""
  10181. (save-match-data
  10182. (abbreviate-file-name (read-file-name "Include file: ")))
  10183. "\"")
  10184. t t rpl)))
  10185. (setq rpl (mapconcat 'identity (split-string rpl "\n")
  10186. (concat "\n" ind)))
  10187. (insert rpl)
  10188. (if (re-search-backward "\\?" start t) (delete-char 1))))
  10189. ;;;; TODO, DEADLINE, Comments
  10190. (defun org-toggle-comment ()
  10191. "Change the COMMENT state of an entry."
  10192. (interactive)
  10193. (save-excursion
  10194. (org-back-to-heading)
  10195. (let (case-fold-search)
  10196. (cond
  10197. ((looking-at (format org-heading-keyword-regexp-format
  10198. org-comment-string))
  10199. (goto-char (match-end 1))
  10200. (looking-at (concat " +" org-comment-string))
  10201. (replace-match "" t t)
  10202. (when (eolp) (insert " ")))
  10203. ((looking-at org-outline-regexp)
  10204. (goto-char (match-end 0))
  10205. (insert org-comment-string " "))))))
  10206. (defvar org-last-todo-state-is-todo nil
  10207. "This is non-nil when the last TODO state change led to a TODO state.
  10208. If the last change removed the TODO tag or switched to DONE, then
  10209. this is nil.")
  10210. (defvar org-setting-tags nil) ; dynamically skipped
  10211. (defvar org-todo-setup-filter-hook nil
  10212. "Hook for functions that pre-filter todo specs.
  10213. Each function takes a todo spec and returns either nil or the spec
  10214. transformed into canonical form." )
  10215. (defvar org-todo-get-default-hook nil
  10216. "Hook for functions that get a default item for todo.
  10217. Each function takes arguments (NEW-MARK OLD-MARK) and returns either
  10218. nil or a string to be used for the todo mark." )
  10219. (defvar org-agenda-headline-snapshot-before-repeat)
  10220. (defun org-current-effective-time ()
  10221. "Return current time adjusted for `org-extend-today-until' variable"
  10222. (let* ((ct (org-current-time))
  10223. (dct (decode-time ct))
  10224. (ct1
  10225. (if (and org-use-effective-time
  10226. (< (nth 2 dct) org-extend-today-until))
  10227. (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
  10228. ct)))
  10229. ct1))
  10230. (defun org-todo-yesterday (&optional arg)
  10231. "Like `org-todo' but the time of change will be 23:59 of yesterday."
  10232. (interactive "P")
  10233. (if (eq major-mode 'org-agenda-mode)
  10234. (apply 'org-agenda-todo-yesterday arg)
  10235. (let* ((hour (third (decode-time
  10236. (org-current-time))))
  10237. (org-extend-today-until (1+ hour)))
  10238. (org-todo arg))))
  10239. (defun org-todo (&optional arg)
  10240. "Change the TODO state of an item.
  10241. The state of an item is given by a keyword at the start of the heading,
  10242. like
  10243. *** TODO Write paper
  10244. *** DONE Call mom
  10245. The different keywords are specified in the variable `org-todo-keywords'.
  10246. By default the available states are \"TODO\" and \"DONE\".
  10247. So for this example: when the item starts with TODO, it is changed to DONE.
  10248. When it starts with DONE, the DONE is removed. And when neither TODO nor
  10249. DONE are present, add TODO at the beginning of the heading.
  10250. With \\[universal-argument] prefix arg, use completion to determine the new \
  10251. state.
  10252. With numeric prefix arg, switch to that state.
  10253. With a double \\[universal-argument] prefix, switch to the next set of TODO \
  10254. keywords (nextset).
  10255. With a triple \\[universal-argument] prefix, circumvent any state blocking.
  10256. With a numeric prefix arg of 0, inhibit note taking for the change.
  10257. For calling through lisp, arg is also interpreted in the following way:
  10258. 'none -> empty state
  10259. \"\"(empty string) -> switch to empty state
  10260. 'done -> switch to DONE
  10261. 'nextset -> switch to the next set of keywords
  10262. 'previousset -> switch to the previous set of keywords
  10263. \"WAITING\" -> switch to the specified keyword, but only if it
  10264. really is a member of `org-todo-keywords'."
  10265. (interactive "P")
  10266. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  10267. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  10268. 'region-start-level 'region))
  10269. org-loop-over-headlines-in-active-region)
  10270. (org-map-entries
  10271. `(org-todo ,arg)
  10272. org-loop-over-headlines-in-active-region
  10273. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  10274. (if (equal arg '(16)) (setq arg 'nextset))
  10275. (let ((org-blocker-hook org-blocker-hook)
  10276. (case-fold-search nil))
  10277. (when (equal arg '(64))
  10278. (setq arg nil org-blocker-hook nil))
  10279. (when (and org-blocker-hook
  10280. (or org-inhibit-blocking
  10281. (org-entry-get nil "NOBLOCKING")))
  10282. (setq org-blocker-hook nil))
  10283. (save-excursion
  10284. (catch 'exit
  10285. (org-back-to-heading t)
  10286. (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
  10287. (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
  10288. (looking-at "\\(?: *\\|[ \t]*$\\)"))
  10289. (let* ((match-data (match-data))
  10290. (startpos (point-at-bol))
  10291. (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
  10292. (org-log-done org-log-done)
  10293. (org-log-repeat org-log-repeat)
  10294. (org-todo-log-states org-todo-log-states)
  10295. (org-inhibit-logging
  10296. (if (equal arg 0)
  10297. (progn (setq arg nil) 'note) org-inhibit-logging))
  10298. (this (match-string 1))
  10299. (hl-pos (match-beginning 0))
  10300. (head (org-get-todo-sequence-head this))
  10301. (ass (assoc head org-todo-kwd-alist))
  10302. (interpret (nth 1 ass))
  10303. (done-word (nth 3 ass))
  10304. (final-done-word (nth 4 ass))
  10305. (org-last-state (or this ""))
  10306. (completion-ignore-case t)
  10307. (member (member this org-todo-keywords-1))
  10308. (tail (cdr member))
  10309. (org-state (cond
  10310. ((and org-todo-key-trigger
  10311. (or (and (equal arg '(4))
  10312. (eq org-use-fast-todo-selection 'prefix))
  10313. (and (not arg) org-use-fast-todo-selection
  10314. (not (eq org-use-fast-todo-selection
  10315. 'prefix)))))
  10316. ;; Use fast selection
  10317. (org-fast-todo-selection))
  10318. ((and (equal arg '(4))
  10319. (or (not org-use-fast-todo-selection)
  10320. (not org-todo-key-trigger)))
  10321. ;; Read a state with completion
  10322. (org-icompleting-read
  10323. "State: " (mapcar (lambda(x) (list x))
  10324. org-todo-keywords-1)
  10325. nil t))
  10326. ((eq arg 'right)
  10327. (if this
  10328. (if tail (car tail) nil)
  10329. (car org-todo-keywords-1)))
  10330. ((eq arg 'left)
  10331. (if (equal member org-todo-keywords-1)
  10332. nil
  10333. (if this
  10334. (nth (- (length org-todo-keywords-1)
  10335. (length tail) 2)
  10336. org-todo-keywords-1)
  10337. (org-last org-todo-keywords-1))))
  10338. ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
  10339. (setq arg nil))) ; hack to fall back to cycling
  10340. (arg
  10341. ;; user or caller requests a specific state
  10342. (cond
  10343. ((equal arg "") nil)
  10344. ((eq arg 'none) nil)
  10345. ((eq arg 'done) (or done-word (car org-done-keywords)))
  10346. ((eq arg 'nextset)
  10347. (or (car (cdr (member head org-todo-heads)))
  10348. (car org-todo-heads)))
  10349. ((eq arg 'previousset)
  10350. (let ((org-todo-heads (reverse org-todo-heads)))
  10351. (or (car (cdr (member head org-todo-heads)))
  10352. (car org-todo-heads))))
  10353. ((car (member arg org-todo-keywords-1)))
  10354. ((stringp arg)
  10355. (error "State `%s' not valid in this file" arg))
  10356. ((nth (1- (prefix-numeric-value arg))
  10357. org-todo-keywords-1))))
  10358. ((null member) (or head (car org-todo-keywords-1)))
  10359. ((equal this final-done-word) nil) ;; -> make empty
  10360. ((null tail) nil) ;; -> first entry
  10361. ((memq interpret '(type priority))
  10362. (if (eq this-command last-command)
  10363. (car tail)
  10364. (if (> (length tail) 0)
  10365. (or done-word (car org-done-keywords))
  10366. nil)))
  10367. (t
  10368. (car tail))))
  10369. (org-state (or
  10370. (run-hook-with-args-until-success
  10371. 'org-todo-get-default-hook org-state org-last-state)
  10372. org-state))
  10373. (next (if org-state (concat " " org-state " ") " "))
  10374. (change-plist (list :type 'todo-state-change :from this :to org-state
  10375. :position startpos))
  10376. dolog now-done-p)
  10377. (when org-blocker-hook
  10378. (setq org-last-todo-state-is-todo
  10379. (not (member this org-done-keywords)))
  10380. (unless (save-excursion
  10381. (save-match-data
  10382. (org-with-wide-buffer
  10383. (run-hook-with-args-until-failure
  10384. 'org-blocker-hook change-plist))))
  10385. (if (org-called-interactively-p 'interactive)
  10386. (error "TODO state change from %s to %s blocked" this org-state)
  10387. ;; fail silently
  10388. (message "TODO state change from %s to %s blocked" this org-state)
  10389. (throw 'exit nil))))
  10390. (store-match-data match-data)
  10391. (replace-match next t t)
  10392. (unless (pos-visible-in-window-p hl-pos)
  10393. (message "TODO state changed to %s" (org-trim next)))
  10394. (unless head
  10395. (setq head (org-get-todo-sequence-head org-state)
  10396. ass (assoc head org-todo-kwd-alist)
  10397. interpret (nth 1 ass)
  10398. done-word (nth 3 ass)
  10399. final-done-word (nth 4 ass)))
  10400. (when (memq arg '(nextset previousset))
  10401. (message "Keyword-Set %d/%d: %s"
  10402. (- (length org-todo-sets) -1
  10403. (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
  10404. (length org-todo-sets)
  10405. (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
  10406. (setq org-last-todo-state-is-todo
  10407. (not (member org-state org-done-keywords)))
  10408. (setq now-done-p (and (member org-state org-done-keywords)
  10409. (not (member this org-done-keywords))))
  10410. (and logging (org-local-logging logging))
  10411. (when (and (or org-todo-log-states org-log-done)
  10412. (not (eq org-inhibit-logging t))
  10413. (not (memq arg '(nextset previousset))))
  10414. ;; we need to look at recording a time and note
  10415. (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
  10416. (nth 2 (assoc this org-todo-log-states))))
  10417. (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
  10418. (setq dolog 'time))
  10419. (when (and org-state
  10420. (member org-state org-not-done-keywords)
  10421. (not (member this org-not-done-keywords)))
  10422. ;; This is now a todo state and was not one before
  10423. ;; If there was a CLOSED time stamp, get rid of it.
  10424. (org-add-planning-info nil nil 'closed))
  10425. (when (and now-done-p org-log-done)
  10426. ;; It is now done, and it was not done before
  10427. (org-add-planning-info 'closed (org-current-effective-time))
  10428. (if (and (not dolog) (eq 'note org-log-done))
  10429. (org-add-log-setup 'done org-state this 'findpos 'note)))
  10430. (when (and org-state dolog)
  10431. ;; This is a non-nil state, and we need to log it
  10432. (org-add-log-setup 'state org-state this 'findpos dolog)))
  10433. ;; Fixup tag positioning
  10434. (org-todo-trigger-tag-changes org-state)
  10435. (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
  10436. (when org-provide-todo-statistics
  10437. (org-update-parent-todo-statistics))
  10438. (run-hooks 'org-after-todo-state-change-hook)
  10439. (if (and arg (not (member org-state org-done-keywords)))
  10440. (setq head (org-get-todo-sequence-head org-state)))
  10441. (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
  10442. ;; Do we need to trigger a repeat?
  10443. (when now-done-p
  10444. (when (boundp 'org-agenda-headline-snapshot-before-repeat)
  10445. ;; This is for the agenda, take a snapshot of the headline.
  10446. (save-match-data
  10447. (setq org-agenda-headline-snapshot-before-repeat
  10448. (org-get-heading))))
  10449. (org-auto-repeat-maybe org-state))
  10450. ;; Fixup cursor location if close to the keyword
  10451. (if (and (outline-on-heading-p)
  10452. (not (bolp))
  10453. (save-excursion (beginning-of-line 1)
  10454. (looking-at org-todo-line-regexp))
  10455. (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
  10456. (progn
  10457. (goto-char (or (match-end 2) (match-end 1)))
  10458. (and (looking-at " ") (just-one-space))))
  10459. (when org-trigger-hook
  10460. (save-excursion
  10461. (run-hook-with-args 'org-trigger-hook change-plist)))))))))
  10462. (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
  10463. "Block turning an entry into a TODO, using the hierarchy.
  10464. This checks whether the current task should be blocked from state
  10465. changes. Such blocking occurs when:
  10466. 1. The task has children which are not all in a completed state.
  10467. 2. A task has a parent with the property :ORDERED:, and there
  10468. are siblings prior to the current task with incomplete
  10469. status.
  10470. 3. The parent of the task is blocked because it has siblings that should
  10471. be done first, or is child of a block grandparent TODO entry."
  10472. (if (not org-enforce-todo-dependencies)
  10473. t ; if locally turned off don't block
  10474. (catch 'dont-block
  10475. ;; If this is not a todo state change, or if this entry is already DONE,
  10476. ;; do not block
  10477. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  10478. (member (plist-get change-plist :from)
  10479. (cons 'done org-done-keywords))
  10480. (member (plist-get change-plist :to)
  10481. (cons 'todo org-not-done-keywords))
  10482. (not (plist-get change-plist :to)))
  10483. (throw 'dont-block t))
  10484. ;; If this task has children, and any are undone, it's blocked
  10485. (save-excursion
  10486. (org-back-to-heading t)
  10487. (let ((this-level (funcall outline-level)))
  10488. (outline-next-heading)
  10489. (let ((child-level (funcall outline-level)))
  10490. (while (and (not (eobp))
  10491. (> child-level this-level))
  10492. ;; this todo has children, check whether they are all
  10493. ;; completed
  10494. (if (and (not (org-entry-is-done-p))
  10495. (org-entry-is-todo-p))
  10496. (throw 'dont-block nil))
  10497. (outline-next-heading)
  10498. (setq child-level (funcall outline-level))))))
  10499. ;; Otherwise, if the task's parent has the :ORDERED: property, and
  10500. ;; any previous siblings are undone, it's blocked
  10501. (save-excursion
  10502. (org-back-to-heading t)
  10503. (let* ((pos (point))
  10504. (parent-pos (and (org-up-heading-safe) (point))))
  10505. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  10506. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  10507. (forward-line 1)
  10508. (re-search-forward org-not-done-heading-regexp pos t))
  10509. (throw 'dont-block nil)) ; block, there is an older sibling not done.
  10510. ;; Search further up the hierarchy, to see if an ancestor is blocked
  10511. (while t
  10512. (goto-char parent-pos)
  10513. (if (not (looking-at org-not-done-heading-regexp))
  10514. (throw 'dont-block t)) ; do not block, parent is not a TODO
  10515. (setq pos (point))
  10516. (setq parent-pos (and (org-up-heading-safe) (point)))
  10517. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  10518. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  10519. (forward-line 1)
  10520. (re-search-forward org-not-done-heading-regexp pos t))
  10521. (throw 'dont-block nil)))))))) ; block, older sibling not done.
  10522. (defcustom org-track-ordered-property-with-tag nil
  10523. "Should the ORDERED property also be shown as a tag?
  10524. The ORDERED property decides if an entry should require subtasks to be
  10525. completed in sequence. Since a property is not very visible, setting
  10526. this option means that toggling the ORDERED property with the command
  10527. `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
  10528. not relevant for the behavior, but it makes things more visible.
  10529. Note that toggling the tag with tags commands will not change the property
  10530. and therefore not influence behavior!
  10531. This can be t, meaning the tag ORDERED should be used, It can also be a
  10532. string to select a different tag for this task."
  10533. :group 'org-todo
  10534. :type '(choice
  10535. (const :tag "No tracking" nil)
  10536. (const :tag "Track with ORDERED tag" t)
  10537. (string :tag "Use other tag")))
  10538. (defun org-toggle-ordered-property ()
  10539. "Toggle the ORDERED property of the current entry.
  10540. For better visibility, you can track the value of this property with a tag.
  10541. See variable `org-track-ordered-property-with-tag'."
  10542. (interactive)
  10543. (let* ((t1 org-track-ordered-property-with-tag)
  10544. (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
  10545. (save-excursion
  10546. (org-back-to-heading)
  10547. (if (org-entry-get nil "ORDERED")
  10548. (progn
  10549. (org-delete-property "ORDERED")
  10550. (and tag (org-toggle-tag tag 'off))
  10551. (message "Subtasks can be completed in arbitrary order"))
  10552. (org-entry-put nil "ORDERED" "t")
  10553. (and tag (org-toggle-tag tag 'on))
  10554. (message "Subtasks must be completed in sequence")))))
  10555. (defvar org-blocked-by-checkboxes) ; dynamically scoped
  10556. (defun org-block-todo-from-checkboxes (change-plist)
  10557. "Block turning an entry into a TODO, using checkboxes.
  10558. This checks whether the current task should be blocked from state
  10559. changes because there are unchecked boxes in this entry."
  10560. (if (not org-enforce-todo-checkbox-dependencies)
  10561. t ; if locally turned off don't block
  10562. (catch 'dont-block
  10563. ;; If this is not a todo state change, or if this entry is already DONE,
  10564. ;; do not block
  10565. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  10566. (member (plist-get change-plist :from)
  10567. (cons 'done org-done-keywords))
  10568. (member (plist-get change-plist :to)
  10569. (cons 'todo org-not-done-keywords))
  10570. (not (plist-get change-plist :to)))
  10571. (throw 'dont-block t))
  10572. ;; If this task has checkboxes that are not checked, it's blocked
  10573. (save-excursion
  10574. (org-back-to-heading t)
  10575. (let ((beg (point)) end)
  10576. (outline-next-heading)
  10577. (setq end (point))
  10578. (goto-char beg)
  10579. (if (org-list-search-forward
  10580. (concat (org-item-beginning-re)
  10581. "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
  10582. "\\[[- ]\\]")
  10583. end t)
  10584. (progn
  10585. (if (boundp 'org-blocked-by-checkboxes)
  10586. (setq org-blocked-by-checkboxes t))
  10587. (throw 'dont-block nil)))))
  10588. t))) ; do not block
  10589. (defun org-entry-blocked-p ()
  10590. "Is the current entry blocked?"
  10591. (if (org-entry-get nil "NOBLOCKING")
  10592. nil ;; Never block this entry
  10593. (not
  10594. (run-hook-with-args-until-failure
  10595. 'org-blocker-hook
  10596. (list :type 'todo-state-change
  10597. :position (point)
  10598. :from 'todo
  10599. :to 'done)))))
  10600. (defun org-update-statistics-cookies (all)
  10601. "Update the statistics cookie, either from TODO or from checkboxes.
  10602. This should be called with the cursor in a line with a statistics cookie."
  10603. (interactive "P")
  10604. (if all
  10605. (progn
  10606. (org-update-checkbox-count 'all)
  10607. (org-map-entries 'org-update-parent-todo-statistics))
  10608. (if (not (org-at-heading-p))
  10609. (org-update-checkbox-count)
  10610. (let ((pos (move-marker (make-marker) (point)))
  10611. end l1 l2)
  10612. (ignore-errors (org-back-to-heading t))
  10613. (if (not (org-at-heading-p))
  10614. (org-update-checkbox-count)
  10615. (setq l1 (org-outline-level))
  10616. (setq end (save-excursion
  10617. (outline-next-heading)
  10618. (if (org-at-heading-p) (setq l2 (org-outline-level)))
  10619. (point)))
  10620. (if (and (save-excursion
  10621. (re-search-forward
  10622. "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
  10623. (not (save-excursion (re-search-forward
  10624. ":COOKIE_DATA:.*\\<todo\\>" end t))))
  10625. (org-update-checkbox-count)
  10626. (if (and l2 (> l2 l1))
  10627. (progn
  10628. (goto-char end)
  10629. (org-update-parent-todo-statistics))
  10630. (goto-char pos)
  10631. (beginning-of-line 1)
  10632. (while (re-search-forward
  10633. "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
  10634. (point-at-eol) t)
  10635. (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
  10636. (goto-char pos)
  10637. (move-marker pos nil)))))
  10638. (defvar org-entry-property-inherited-from) ;; defined below
  10639. (defun org-update-parent-todo-statistics ()
  10640. "Update any statistics cookie in the parent of the current headline.
  10641. When `org-hierarchical-todo-statistics' is nil, statistics will cover
  10642. the entire subtree and this will travel up the hierarchy and update
  10643. statistics everywhere."
  10644. (let* ((prop (save-excursion (org-up-heading-safe)
  10645. (org-entry-get nil "COOKIE_DATA" 'inherit)))
  10646. (recursive (or (not org-hierarchical-todo-statistics)
  10647. (and prop (string-match "\\<recursive\\>" prop))))
  10648. (lim (or (and prop (marker-position org-entry-property-inherited-from))
  10649. 0))
  10650. (first t)
  10651. (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  10652. level ltoggle l1 new ndel
  10653. (cnt-all 0) (cnt-done 0) is-percent kwd
  10654. checkbox-beg ov ovs ove cookie-present)
  10655. (catch 'exit
  10656. (save-excursion
  10657. (beginning-of-line 1)
  10658. (setq ltoggle (funcall outline-level))
  10659. ;; Three situations are to consider:
  10660. ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
  10661. ;; to the top-level ancestor on the headline;
  10662. ;; 2. If parent has "recursive" property, repeat up to the
  10663. ;; headline setting that property, taking inheritance into
  10664. ;; account;
  10665. ;; 3. Else, move up to direct parent and proceed only once.
  10666. (while (and (setq level (org-up-heading-safe))
  10667. (or recursive first)
  10668. (>= (point) lim))
  10669. (setq first nil cookie-present nil)
  10670. (unless (and level
  10671. (not (string-match
  10672. "\\<checkbox\\>"
  10673. (downcase (or (org-entry-get nil "COOKIE_DATA")
  10674. "")))))
  10675. (throw 'exit nil))
  10676. (while (re-search-forward box-re (point-at-eol) t)
  10677. (setq cnt-all 0 cnt-done 0 cookie-present t)
  10678. (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
  10679. (save-match-data
  10680. (unless (outline-next-heading) (throw 'exit nil))
  10681. (while (and (looking-at org-complex-heading-regexp)
  10682. (> (setq l1 (length (match-string 1))) level))
  10683. (setq kwd (and (or recursive (= l1 ltoggle))
  10684. (match-string 2)))
  10685. (if (or (eq org-provide-todo-statistics 'all-headlines)
  10686. (and (listp org-provide-todo-statistics)
  10687. (or (member kwd org-provide-todo-statistics)
  10688. (member kwd org-done-keywords))))
  10689. (setq cnt-all (1+ cnt-all))
  10690. (if (eq org-provide-todo-statistics t)
  10691. (and kwd (setq cnt-all (1+ cnt-all)))))
  10692. (and (member kwd org-done-keywords)
  10693. (setq cnt-done (1+ cnt-done)))
  10694. (outline-next-heading)))
  10695. (setq new
  10696. (if is-percent
  10697. (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
  10698. (format "[%d/%d]" cnt-done cnt-all))
  10699. ndel (- (match-end 0) checkbox-beg))
  10700. ;; handle overlays when updating cookie from column view
  10701. (when (setq ov (car (overlays-at checkbox-beg)))
  10702. (setq ovs (overlay-start ov) ove (overlay-end ov))
  10703. (delete-overlay ov))
  10704. (goto-char checkbox-beg)
  10705. (insert new)
  10706. (delete-region (point) (+ (point) ndel))
  10707. (when org-auto-align-tags (org-fix-tags-on-the-fly))
  10708. (when ov (move-overlay ov ovs ove)))
  10709. (when cookie-present
  10710. (run-hook-with-args 'org-after-todo-statistics-hook
  10711. cnt-done (- cnt-all cnt-done))))))
  10712. (run-hooks 'org-todo-statistics-hook)))
  10713. (defvar org-after-todo-statistics-hook nil
  10714. "Hook that is called after a TODO statistics cookie has been updated.
  10715. Each function is called with two arguments: the number of not-done entries
  10716. and the number of done entries.
  10717. For example, the following function, when added to this hook, will switch
  10718. an entry to DONE when all children are done, and back to TODO when new
  10719. entries are set to a TODO status. Note that this hook is only called
  10720. when there is a statistics cookie in the headline!
  10721. (defun org-summary-todo (n-done n-not-done)
  10722. \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
  10723. (let (org-log-done org-log-states) ; turn off logging
  10724. (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
  10725. ")
  10726. (defvar org-todo-statistics-hook nil
  10727. "Hook that is run whenever Org thinks TODO statistics should be updated.
  10728. This hook runs even if there is no statistics cookie present, in which case
  10729. `org-after-todo-statistics-hook' would not run.")
  10730. (defun org-todo-trigger-tag-changes (state)
  10731. "Apply the changes defined in `org-todo-state-tags-triggers'."
  10732. (let ((l org-todo-state-tags-triggers)
  10733. changes)
  10734. (when (or (not state) (equal state ""))
  10735. (setq changes (append changes (cdr (assoc "" l)))))
  10736. (when (and (stringp state) (> (length state) 0))
  10737. (setq changes (append changes (cdr (assoc state l)))))
  10738. (when (member state org-not-done-keywords)
  10739. (setq changes (append changes (cdr (assoc 'todo l)))))
  10740. (when (member state org-done-keywords)
  10741. (setq changes (append changes (cdr (assoc 'done l)))))
  10742. (dolist (c changes)
  10743. (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
  10744. (defun org-local-logging (value)
  10745. "Get logging settings from a property VALUE."
  10746. (let* (words w a)
  10747. ;; directly set the variables, they are already local.
  10748. (setq org-log-done nil
  10749. org-log-repeat nil
  10750. org-todo-log-states nil)
  10751. (setq words (org-split-string value))
  10752. (while (setq w (pop words))
  10753. (cond
  10754. ((setq a (assoc w org-startup-options))
  10755. (and (member (nth 1 a) '(org-log-done org-log-repeat))
  10756. (set (nth 1 a) (nth 2 a))))
  10757. ((setq a (org-extract-log-state-settings w))
  10758. (and (member (car a) org-todo-keywords-1)
  10759. (push a org-todo-log-states)))))))
  10760. (defun org-get-todo-sequence-head (kwd)
  10761. "Return the head of the TODO sequence to which KWD belongs.
  10762. If KWD is not set, check if there is a text property remembering the
  10763. right sequence."
  10764. (let (p)
  10765. (cond
  10766. ((not kwd)
  10767. (or (get-text-property (point-at-bol) 'org-todo-head)
  10768. (progn
  10769. (setq p (next-single-property-change (point-at-bol) 'org-todo-head
  10770. nil (point-at-eol)))
  10771. (get-text-property p 'org-todo-head))))
  10772. ((not (member kwd org-todo-keywords-1))
  10773. (car org-todo-keywords-1))
  10774. (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
  10775. (defun org-fast-todo-selection ()
  10776. "Fast TODO keyword selection with single keys.
  10777. Returns the new TODO keyword, or nil if no state change should occur."
  10778. (let* ((fulltable org-todo-key-alist)
  10779. (done-keywords org-done-keywords) ;; needed for the faces.
  10780. (maxlen (apply 'max (mapcar
  10781. (lambda (x)
  10782. (if (stringp (car x)) (string-width (car x)) 0))
  10783. fulltable)))
  10784. (expert nil)
  10785. (fwidth (+ maxlen 3 1 3))
  10786. (ncol (/ (- (window-width) 4) fwidth))
  10787. tg cnt e c tbl
  10788. groups ingroup)
  10789. (save-excursion
  10790. (save-window-excursion
  10791. (if expert
  10792. (set-buffer (get-buffer-create " *Org todo*"))
  10793. (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
  10794. (erase-buffer)
  10795. (org-set-local 'org-done-keywords done-keywords)
  10796. (setq tbl fulltable cnt 0)
  10797. (while (setq e (pop tbl))
  10798. (cond
  10799. ((equal e '(:startgroup))
  10800. (push '() groups) (setq ingroup t)
  10801. (when (not (= cnt 0))
  10802. (setq cnt 0)
  10803. (insert "\n"))
  10804. (insert "{ "))
  10805. ((equal e '(:endgroup))
  10806. (setq ingroup nil cnt 0)
  10807. (insert "}\n"))
  10808. ((equal e '(:newline))
  10809. (when (not (= cnt 0))
  10810. (setq cnt 0)
  10811. (insert "\n")
  10812. (setq e (car tbl))
  10813. (while (equal (car tbl) '(:newline))
  10814. (insert "\n")
  10815. (setq tbl (cdr tbl)))))
  10816. (t
  10817. (setq tg (car e) c (cdr e))
  10818. (if ingroup (push tg (car groups)))
  10819. (setq tg (org-add-props tg nil 'face
  10820. (org-get-todo-face tg)))
  10821. (if (and (= cnt 0) (not ingroup)) (insert " "))
  10822. (insert "[" c "] " tg (make-string
  10823. (- fwidth 4 (length tg)) ?\ ))
  10824. (when (= (setq cnt (1+ cnt)) ncol)
  10825. (insert "\n")
  10826. (if ingroup (insert " "))
  10827. (setq cnt 0)))))
  10828. (insert "\n")
  10829. (goto-char (point-min))
  10830. (if (not expert) (org-fit-window-to-buffer))
  10831. (message "[a-z..]:Set [SPC]:clear")
  10832. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  10833. (cond
  10834. ((or (= c ?\C-g)
  10835. (and (= c ?q) (not (rassoc c fulltable))))
  10836. (setq quit-flag t))
  10837. ((= c ?\ ) nil)
  10838. ((setq e (rassoc c fulltable) tg (car e))
  10839. tg)
  10840. (t (setq quit-flag t)))))))
  10841. (defun org-entry-is-todo-p ()
  10842. (member (org-get-todo-state) org-not-done-keywords))
  10843. (defun org-entry-is-done-p ()
  10844. (member (org-get-todo-state) org-done-keywords))
  10845. (defun org-get-todo-state ()
  10846. (save-excursion
  10847. (org-back-to-heading t)
  10848. (and (looking-at org-todo-line-regexp)
  10849. (match-end 2)
  10850. (match-string 2))))
  10851. (defun org-at-date-range-p (&optional inactive-ok)
  10852. "Is the cursor inside a date range?"
  10853. (interactive)
  10854. (save-excursion
  10855. (catch 'exit
  10856. (let ((pos (point)))
  10857. (skip-chars-backward "^[<\r\n")
  10858. (skip-chars-backward "<[")
  10859. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  10860. (>= (match-end 0) pos)
  10861. (throw 'exit t))
  10862. (skip-chars-backward "^<[\r\n")
  10863. (skip-chars-backward "<[")
  10864. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  10865. (>= (match-end 0) pos)
  10866. (throw 'exit t)))
  10867. nil)))
  10868. (defun org-get-repeat (&optional tagline)
  10869. "Check if there is a deadline/schedule with repeater in this entry."
  10870. (save-match-data
  10871. (save-excursion
  10872. (org-back-to-heading t)
  10873. (and (re-search-forward (if tagline
  10874. (concat tagline "\\s-*" org-repeat-re)
  10875. org-repeat-re)
  10876. (org-entry-end-position) t)
  10877. (match-string-no-properties 1)))))
  10878. (defvar org-last-changed-timestamp)
  10879. (defvar org-last-inserted-timestamp)
  10880. (defvar org-log-post-message)
  10881. (defvar org-log-note-purpose)
  10882. (defvar org-log-note-how)
  10883. (defvar org-log-note-extra)
  10884. (defun org-auto-repeat-maybe (done-word)
  10885. "Check if the current headline contains a repeated deadline/schedule.
  10886. If yes, set TODO state back to what it was and change the base date
  10887. of repeating deadline/scheduled time stamps to new date.
  10888. This function is run automatically after each state change to a DONE state."
  10889. ;; last-state is dynamically scoped into this function
  10890. (let* ((repeat (org-get-repeat))
  10891. (aa (assoc org-last-state org-todo-kwd-alist))
  10892. (interpret (nth 1 aa))
  10893. (head (nth 2 aa))
  10894. (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
  10895. (msg "Entry repeats: ")
  10896. (org-log-done nil)
  10897. (org-todo-log-states nil)
  10898. re type n what ts time to-state)
  10899. (when repeat
  10900. (if (eq org-log-repeat t) (setq org-log-repeat 'state))
  10901. (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
  10902. org-todo-repeat-to-state))
  10903. (unless (and to-state (member to-state org-todo-keywords-1))
  10904. (setq to-state (if (eq interpret 'type) org-last-state head)))
  10905. (org-todo to-state)
  10906. (when (or org-log-repeat (org-entry-get nil "CLOCK"))
  10907. (org-entry-put nil "LAST_REPEAT" (format-time-string
  10908. (org-time-stamp-format t t))))
  10909. (when org-log-repeat
  10910. (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
  10911. (memq 'org-add-log-note post-command-hook))
  10912. ;; OK, we are already setup for some record
  10913. (if (eq org-log-repeat 'note)
  10914. ;; make sure we take a note, not only a time stamp
  10915. (setq org-log-note-how 'note))
  10916. ;; Set up for taking a record
  10917. (org-add-log-setup 'state (or done-word (car org-done-keywords))
  10918. org-last-state
  10919. 'findpos org-log-repeat)))
  10920. (org-back-to-heading t)
  10921. (org-add-planning-info nil nil 'closed)
  10922. (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  10923. org-deadline-time-regexp "\\)\\|\\("
  10924. org-ts-regexp "\\)"))
  10925. (while (re-search-forward
  10926. re (save-excursion (outline-next-heading) (point)) t)
  10927. (setq type (if (match-end 1) org-scheduled-string
  10928. (if (match-end 3) org-deadline-string "Plain:"))
  10929. ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
  10930. (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
  10931. (setq n (string-to-number (match-string 2 ts))
  10932. what (match-string 3 ts))
  10933. (if (equal what "w") (setq n (* n 7) what "d"))
  10934. (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
  10935. (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
  10936. ;; Preparation, see if we need to modify the start date for the change
  10937. (when (match-end 1)
  10938. (setq time (save-match-data (org-time-string-to-time ts)))
  10939. (cond
  10940. ((equal (match-string 1 ts) ".")
  10941. ;; Shift starting date to today
  10942. (org-timestamp-change
  10943. (- (org-today) (time-to-days time))
  10944. 'day))
  10945. ((equal (match-string 1 ts) "+")
  10946. (let ((nshiftmax 10) (nshift 0))
  10947. (while (or (= nshift 0)
  10948. (<= (time-to-days time)
  10949. (time-to-days (current-time))))
  10950. (when (= (incf nshift) nshiftmax)
  10951. (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
  10952. (error "Abort")))
  10953. (org-timestamp-change n (cdr (assoc what whata)))
  10954. (org-at-timestamp-p t)
  10955. (setq ts (match-string 1))
  10956. (setq time (save-match-data (org-time-string-to-time ts)))))
  10957. (org-timestamp-change (- n) (cdr (assoc what whata)))
  10958. ;; rematch, so that we have everything in place for the real shift
  10959. (org-at-timestamp-p t)
  10960. (setq ts (match-string 1))
  10961. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
  10962. (org-timestamp-change n (cdr (assoc what whata)))
  10963. (setq msg (concat msg type " " org-last-changed-timestamp " "))))
  10964. (setq org-log-post-message msg)
  10965. (message "%s" msg))))
  10966. (defun org-show-todo-tree (arg)
  10967. "Make a compact tree which shows all headlines marked with TODO.
  10968. The tree will show the lines where the regexp matches, and all higher
  10969. headlines above the match.
  10970. With a \\[universal-argument] prefix, prompt for a regexp to match.
  10971. With a numeric prefix N, construct a sparse tree for the Nth element
  10972. of `org-todo-keywords-1'."
  10973. (interactive "P")
  10974. (let ((case-fold-search nil)
  10975. (kwd-re
  10976. (cond ((null arg) org-not-done-regexp)
  10977. ((equal arg '(4))
  10978. (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
  10979. (mapcar 'list org-todo-keywords-1))))
  10980. (concat "\\("
  10981. (mapconcat 'identity (org-split-string kwd "|") "\\|")
  10982. "\\)\\>")))
  10983. ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
  10984. (regexp-quote (nth (1- (prefix-numeric-value arg))
  10985. org-todo-keywords-1)))
  10986. (t (error "Invalid prefix argument: %s" arg)))))
  10987. (message "%d TODO entries found"
  10988. (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
  10989. (defun org-deadline (&optional remove time)
  10990. "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
  10991. With argument REMOVE, remove any deadline from the item.
  10992. With argument TIME, set the deadline at the corresponding date. TIME
  10993. can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  10994. (interactive "P")
  10995. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  10996. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  10997. 'region-start-level 'region))
  10998. org-loop-over-headlines-in-active-region)
  10999. (org-map-entries
  11000. `(org-deadline ',remove ,time)
  11001. org-loop-over-headlines-in-active-region
  11002. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11003. (let* ((old-date (org-entry-get nil "DEADLINE"))
  11004. (repeater (and old-date
  11005. (string-match
  11006. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  11007. old-date)
  11008. (match-string 1 old-date))))
  11009. (if remove
  11010. (progn
  11011. (when (and old-date org-log-redeadline)
  11012. (org-add-log-setup 'deldeadline nil old-date 'findpos
  11013. org-log-redeadline))
  11014. (org-remove-timestamp-with-keyword org-deadline-string)
  11015. (message "Item no longer has a deadline."))
  11016. (org-add-planning-info 'deadline time 'closed)
  11017. (when (and old-date org-log-redeadline
  11018. (not (equal old-date
  11019. (substring org-last-inserted-timestamp 1 -1))))
  11020. (org-add-log-setup 'redeadline nil old-date 'findpos
  11021. org-log-redeadline))
  11022. (when repeater
  11023. (save-excursion
  11024. (org-back-to-heading t)
  11025. (when (re-search-forward (concat org-deadline-string " "
  11026. org-last-inserted-timestamp)
  11027. (save-excursion
  11028. (outline-next-heading) (point)) t)
  11029. (goto-char (1- (match-end 0)))
  11030. (insert " " repeater)
  11031. (setq org-last-inserted-timestamp
  11032. (concat (substring org-last-inserted-timestamp 0 -1)
  11033. " " repeater
  11034. (substring org-last-inserted-timestamp -1))))))
  11035. (message "Deadline on %s" org-last-inserted-timestamp)))))
  11036. (defun org-schedule (&optional remove time)
  11037. "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
  11038. With argument REMOVE, remove any scheduling date from the item.
  11039. With argument TIME, scheduled at the corresponding date. TIME can
  11040. either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  11041. (interactive "P")
  11042. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11043. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11044. 'region-start-level 'region))
  11045. org-loop-over-headlines-in-active-region)
  11046. (org-map-entries
  11047. `(org-schedule ',remove ,time)
  11048. org-loop-over-headlines-in-active-region
  11049. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11050. (let* ((old-date (org-entry-get nil "SCHEDULED"))
  11051. (repeater (and old-date
  11052. (string-match
  11053. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  11054. old-date)
  11055. (match-string 1 old-date))))
  11056. (if remove
  11057. (progn
  11058. (when (and old-date org-log-reschedule)
  11059. (org-add-log-setup 'delschedule nil old-date 'findpos
  11060. org-log-reschedule))
  11061. (org-remove-timestamp-with-keyword org-scheduled-string)
  11062. (message "Item is no longer scheduled."))
  11063. (org-add-planning-info 'scheduled time 'closed)
  11064. (when (and old-date org-log-reschedule
  11065. (not (equal old-date
  11066. (substring org-last-inserted-timestamp 1 -1))))
  11067. (org-add-log-setup 'reschedule nil old-date 'findpos
  11068. org-log-reschedule))
  11069. (when repeater
  11070. (save-excursion
  11071. (org-back-to-heading t)
  11072. (when (re-search-forward (concat org-scheduled-string " "
  11073. org-last-inserted-timestamp)
  11074. (save-excursion
  11075. (outline-next-heading) (point)) t)
  11076. (goto-char (1- (match-end 0)))
  11077. (insert " " repeater)
  11078. (setq org-last-inserted-timestamp
  11079. (concat (substring org-last-inserted-timestamp 0 -1)
  11080. " " repeater
  11081. (substring org-last-inserted-timestamp -1))))))
  11082. (message "Scheduled to %s" org-last-inserted-timestamp)))))
  11083. (defun org-get-scheduled-time (pom &optional inherit)
  11084. "Get the scheduled time as a time tuple, of a format suitable
  11085. for calling org-schedule with, or if there is no scheduling,
  11086. returns nil."
  11087. (let ((time (org-entry-get pom "SCHEDULED" inherit)))
  11088. (when time
  11089. (apply 'encode-time (org-parse-time-string time)))))
  11090. (defun org-get-deadline-time (pom &optional inherit)
  11091. "Get the deadline as a time tuple, of a format suitable for
  11092. calling org-deadline with, or if there is no scheduling, returns
  11093. nil."
  11094. (let ((time (org-entry-get pom "DEADLINE" inherit)))
  11095. (when time
  11096. (apply 'encode-time (org-parse-time-string time)))))
  11097. (defun org-remove-timestamp-with-keyword (keyword)
  11098. "Remove all time stamps with KEYWORD in the current entry."
  11099. (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
  11100. beg)
  11101. (save-excursion
  11102. (org-back-to-heading t)
  11103. (setq beg (point))
  11104. (outline-next-heading)
  11105. (while (re-search-backward re beg t)
  11106. (replace-match "")
  11107. (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
  11108. (equal (char-before) ?\ ))
  11109. (backward-delete-char 1)
  11110. (if (string-match "^[ \t]*$" (buffer-substring
  11111. (point-at-bol) (point-at-eol)))
  11112. (delete-region (point-at-bol)
  11113. (min (point-max) (1+ (point-at-eol))))))))))
  11114. (defun org-add-planning-info (what &optional time &rest remove)
  11115. "Insert new timestamp with keyword in the line directly after the headline.
  11116. WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
  11117. If non is given, the user is prompted for a date.
  11118. REMOVE indicates what kind of entries to remove. An old WHAT entry will also
  11119. be removed."
  11120. (interactive)
  11121. (let (org-time-was-given org-end-time-was-given ts
  11122. end default-time default-input)
  11123. (catch 'exit
  11124. (when (and (memq what '(scheduled deadline))
  11125. (or (not time)
  11126. (and (stringp time)
  11127. (string-match "^[-+]+[0-9]" time))))
  11128. ;; Try to get a default date/time from existing timestamp
  11129. (save-excursion
  11130. (org-back-to-heading t)
  11131. (setq end (save-excursion (outline-next-heading) (point)))
  11132. (when (re-search-forward (if (eq what 'scheduled)
  11133. org-scheduled-time-regexp
  11134. org-deadline-time-regexp)
  11135. end t)
  11136. (setq ts (match-string 1)
  11137. default-time
  11138. (apply 'encode-time (org-parse-time-string ts))
  11139. default-input (and ts (org-get-compact-tod ts))))))
  11140. (when what
  11141. (setq time
  11142. (if (stringp time)
  11143. ;; This is a string (relative or absolute), set proper date
  11144. (apply 'encode-time
  11145. (org-read-date-analyze
  11146. time default-time (decode-time default-time)))
  11147. ;; If necessary, get the time from the user
  11148. (or time (org-read-date nil 'to-time nil nil
  11149. default-time default-input)))))
  11150. (when (and org-insert-labeled-timestamps-at-point
  11151. (member what '(scheduled deadline)))
  11152. (insert
  11153. (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
  11154. (org-insert-time-stamp time org-time-was-given
  11155. nil nil nil (list org-end-time-was-given))
  11156. (setq what nil))
  11157. (save-excursion
  11158. (save-restriction
  11159. (let (col list elt ts buffer-invisibility-spec)
  11160. (org-back-to-heading t)
  11161. (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
  11162. (goto-char (match-end 1))
  11163. (setq col (current-column))
  11164. (goto-char (match-end 0))
  11165. (if (eobp) (insert "\n") (forward-char 1))
  11166. (when (and (not what)
  11167. (not (looking-at
  11168. (concat "[ \t]*"
  11169. org-keyword-time-not-clock-regexp))))
  11170. ;; Nothing to add, nothing to remove...... :-)
  11171. (throw 'exit nil))
  11172. (if (and (not (looking-at org-outline-regexp))
  11173. (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
  11174. "[^\r\n]*"))
  11175. (not (equal (match-string 1) org-clock-string)))
  11176. (narrow-to-region (match-beginning 0) (match-end 0))
  11177. (insert-before-markers "\n")
  11178. (backward-char 1)
  11179. (narrow-to-region (point) (point))
  11180. (and org-adapt-indentation (org-indent-to-column col)))
  11181. ;; Check if we have to remove something.
  11182. (setq list (cons what remove))
  11183. (while list
  11184. (setq elt (pop list))
  11185. (when (or (and (eq elt 'scheduled)
  11186. (re-search-forward org-scheduled-time-regexp nil t))
  11187. (and (eq elt 'deadline)
  11188. (re-search-forward org-deadline-time-regexp nil t))
  11189. (and (eq elt 'closed)
  11190. (re-search-forward org-closed-time-regexp nil t)))
  11191. (replace-match "")
  11192. (if (looking-at "--+<[^>]+>") (replace-match ""))))
  11193. (and (looking-at "[ \t]+") (replace-match ""))
  11194. (and org-adapt-indentation (bolp) (org-indent-to-column col))
  11195. (when what
  11196. (insert
  11197. (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
  11198. (cond ((eq what 'scheduled) org-scheduled-string)
  11199. ((eq what 'deadline) org-deadline-string)
  11200. ((eq what 'closed) org-closed-string))
  11201. " ")
  11202. (setq ts (org-insert-time-stamp
  11203. time
  11204. (or org-time-was-given
  11205. (and (eq what 'closed) org-log-done-with-time))
  11206. (eq what 'closed)
  11207. nil nil (list org-end-time-was-given)))
  11208. (insert
  11209. (if (not (or (bolp) (eq (char-before) ?\ )
  11210. (memq (char-after) '(32 10))
  11211. (eobp))) " " ""))
  11212. (end-of-line 1))
  11213. (goto-char (point-min))
  11214. (widen)
  11215. (if (and (looking-at "[ \t]*\n")
  11216. (equal (char-before) ?\n))
  11217. (delete-region (1- (point)) (point-at-eol)))
  11218. ts))))))
  11219. (defvar org-log-note-marker (make-marker))
  11220. (defvar org-log-note-purpose nil)
  11221. (defvar org-log-note-state nil)
  11222. (defvar org-log-note-previous-state nil)
  11223. (defvar org-log-note-how nil)
  11224. (defvar org-log-note-extra nil)
  11225. (defvar org-log-note-window-configuration nil)
  11226. (defvar org-log-note-return-to (make-marker))
  11227. (defvar org-log-note-effective-time nil
  11228. "Remembered current time so that dynamically scoped
  11229. `org-extend-today-until' affects tha timestamps in state change
  11230. log")
  11231. (defvar org-log-post-message nil
  11232. "Message to be displayed after a log note has been stored.
  11233. The auto-repeater uses this.")
  11234. (defun org-add-note ()
  11235. "Add a note to the current entry.
  11236. This is done in the same way as adding a state change note."
  11237. (interactive)
  11238. (org-add-log-setup 'note nil nil 'findpos nil))
  11239. (defvar org-property-end-re)
  11240. (defun org-add-log-setup (&optional purpose state prev-state
  11241. findpos how extra)
  11242. "Set up the post command hook to take a note.
  11243. If this is about to TODO state change, the new state is expected in STATE.
  11244. When FINDPOS is non-nil, find the correct position for the note in
  11245. the current entry. If not, assume that it can be inserted at point.
  11246. HOW is an indicator what kind of note should be created.
  11247. EXTRA is additional text that will be inserted into the notes buffer."
  11248. (let* ((org-log-into-drawer (org-log-into-drawer))
  11249. (drawer (cond ((stringp org-log-into-drawer)
  11250. org-log-into-drawer)
  11251. (org-log-into-drawer "LOGBOOK")
  11252. (t nil))))
  11253. (save-restriction
  11254. (save-excursion
  11255. (when findpos
  11256. (org-back-to-heading t)
  11257. (narrow-to-region (point) (save-excursion
  11258. (outline-next-heading) (point)))
  11259. (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"
  11260. "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
  11261. "[^\r\n]*\\)?"))
  11262. (goto-char (match-end 0))
  11263. (cond
  11264. (drawer
  11265. (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
  11266. nil t)
  11267. (progn
  11268. (goto-char (match-end 0))
  11269. (or org-log-states-order-reversed
  11270. (and (re-search-forward org-property-end-re nil t)
  11271. (goto-char (1- (match-beginning 0))))))
  11272. (insert "\n:" drawer ":\n:END:")
  11273. (beginning-of-line 0)
  11274. (org-indent-line)
  11275. (beginning-of-line 2)
  11276. (org-indent-line)
  11277. (end-of-line 0)))
  11278. ((and org-log-state-notes-insert-after-drawers
  11279. (save-excursion
  11280. (forward-line) (looking-at org-drawer-regexp)))
  11281. (forward-line)
  11282. (while (looking-at org-drawer-regexp)
  11283. (goto-char (match-end 0))
  11284. (re-search-forward org-property-end-re (point-max) t)
  11285. (forward-line))
  11286. (forward-line -1)))
  11287. (unless org-log-states-order-reversed
  11288. (and (= (char-after) ?\n) (forward-char 1))
  11289. (org-skip-over-state-notes)
  11290. (skip-chars-backward " \t\n\r")))
  11291. (move-marker org-log-note-marker (point))
  11292. (setq org-log-note-purpose purpose
  11293. org-log-note-state state
  11294. org-log-note-previous-state prev-state
  11295. org-log-note-how how
  11296. org-log-note-extra extra
  11297. org-log-note-effective-time (org-current-effective-time))
  11298. (add-hook 'post-command-hook 'org-add-log-note 'append)))))
  11299. (defun org-skip-over-state-notes ()
  11300. "Skip past the list of State notes in an entry."
  11301. (if (looking-at "\n[ \t]*- State") (forward-char 1))
  11302. (when (ignore-errors (goto-char (org-in-item-p)))
  11303. (let* ((struct (org-list-struct))
  11304. (prevs (org-list-prevs-alist struct)))
  11305. (while (looking-at "[ \t]*- State")
  11306. (goto-char (or (org-list-get-next-item (point) struct prevs)
  11307. (org-list-get-item-end (point) struct)))))))
  11308. (defun org-add-log-note (&optional purpose)
  11309. "Pop up a window for taking a note, and add this note later at point."
  11310. (remove-hook 'post-command-hook 'org-add-log-note)
  11311. (setq org-log-note-window-configuration (current-window-configuration))
  11312. (delete-other-windows)
  11313. (move-marker org-log-note-return-to (point))
  11314. (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
  11315. (goto-char org-log-note-marker)
  11316. (org-switch-to-buffer-other-window "*Org Note*")
  11317. (erase-buffer)
  11318. (if (memq org-log-note-how '(time state))
  11319. (let (current-prefix-arg) (org-store-log-note))
  11320. (let ((org-inhibit-startup t)) (org-mode))
  11321. (insert (format "# Insert note for %s.
  11322. # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
  11323. (cond
  11324. ((eq org-log-note-purpose 'clock-out) "stopped clock")
  11325. ((eq org-log-note-purpose 'done) "closed todo item")
  11326. ((eq org-log-note-purpose 'state)
  11327. (format "state change from \"%s\" to \"%s\""
  11328. (or org-log-note-previous-state "")
  11329. (or org-log-note-state "")))
  11330. ((eq org-log-note-purpose 'reschedule)
  11331. "rescheduling")
  11332. ((eq org-log-note-purpose 'delschedule)
  11333. "no longer scheduled")
  11334. ((eq org-log-note-purpose 'redeadline)
  11335. "changing deadline")
  11336. ((eq org-log-note-purpose 'deldeadline)
  11337. "removing deadline")
  11338. ((eq org-log-note-purpose 'refile)
  11339. "refiling")
  11340. ((eq org-log-note-purpose 'note)
  11341. "this entry")
  11342. (t (error "This should not happen")))))
  11343. (if org-log-note-extra (insert org-log-note-extra))
  11344. (org-set-local 'org-finish-function 'org-store-log-note)
  11345. (run-hooks 'org-log-buffer-setup-hook)))
  11346. (defvar org-note-abort nil) ; dynamically scoped
  11347. (defun org-store-log-note ()
  11348. "Finish taking a log note, and insert it to where it belongs."
  11349. (let ((txt (buffer-string))
  11350. (note (cdr (assq org-log-note-purpose org-log-note-headings)))
  11351. lines ind bul)
  11352. (kill-buffer (current-buffer))
  11353. (while (string-match "\\`#.*\n[ \t\n]*" txt)
  11354. (setq txt (replace-match "" t t txt)))
  11355. (if (string-match "\\s-+\\'" txt)
  11356. (setq txt (replace-match "" t t txt)))
  11357. (setq lines (org-split-string txt "\n"))
  11358. (when (and note (string-match "\\S-" note))
  11359. (setq note
  11360. (org-replace-escapes
  11361. note
  11362. (list (cons "%u" (user-login-name))
  11363. (cons "%U" user-full-name)
  11364. (cons "%t" (format-time-string
  11365. (org-time-stamp-format 'long 'inactive)
  11366. org-log-note-effective-time))
  11367. (cons "%T" (format-time-string
  11368. (org-time-stamp-format 'long nil)
  11369. org-log-note-effective-time))
  11370. (cons "%d" (format-time-string
  11371. (org-time-stamp-format nil 'inactive)
  11372. org-log-note-effective-time))
  11373. (cons "%D" (format-time-string
  11374. (org-time-stamp-format nil nil)
  11375. org-log-note-effective-time))
  11376. (cons "%s" (if org-log-note-state
  11377. (concat "\"" org-log-note-state "\"")
  11378. ""))
  11379. (cons "%S" (if org-log-note-previous-state
  11380. (concat "\"" org-log-note-previous-state "\"")
  11381. "\"\"")))))
  11382. (if lines (setq note (concat note " \\\\")))
  11383. (push note lines))
  11384. (when (or current-prefix-arg org-note-abort)
  11385. (when org-log-into-drawer
  11386. (org-remove-empty-drawer-at
  11387. (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
  11388. org-log-note-marker))
  11389. (setq lines nil))
  11390. (when lines
  11391. (with-current-buffer (marker-buffer org-log-note-marker)
  11392. (save-excursion
  11393. (goto-char org-log-note-marker)
  11394. (move-marker org-log-note-marker nil)
  11395. (end-of-line 1)
  11396. (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
  11397. (setq ind (save-excursion
  11398. (if (ignore-errors (goto-char (org-in-item-p)))
  11399. (let ((struct (org-list-struct)))
  11400. (org-list-get-ind
  11401. (org-list-get-top-point struct) struct))
  11402. (skip-chars-backward " \r\t\n")
  11403. (cond
  11404. ((and (org-at-heading-p)
  11405. org-adapt-indentation)
  11406. (1+ (org-current-level)))
  11407. ((org-at-heading-p) 0)
  11408. (t (org-get-indentation))))))
  11409. (setq bul (org-list-bullet-string "-"))
  11410. (org-indent-line-to ind)
  11411. (insert bul (pop lines))
  11412. (let ((ind-body (+ (length bul) ind)))
  11413. (while lines
  11414. (insert "\n")
  11415. (org-indent-line-to ind-body)
  11416. (insert (pop lines))))
  11417. (message "Note stored")
  11418. (org-back-to-heading t)
  11419. (org-cycle-hide-drawers 'children)))))
  11420. (set-window-configuration org-log-note-window-configuration)
  11421. (with-current-buffer (marker-buffer org-log-note-return-to)
  11422. (goto-char org-log-note-return-to))
  11423. (move-marker org-log-note-return-to nil)
  11424. (and org-log-post-message (message "%s" org-log-post-message)))
  11425. (defun org-remove-empty-drawer-at (drawer pos)
  11426. "Remove an empty drawer DRAWER at position POS.
  11427. POS may also be a marker."
  11428. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  11429. (save-excursion
  11430. (save-restriction
  11431. (widen)
  11432. (goto-char pos)
  11433. (if (org-in-regexp
  11434. (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
  11435. (replace-match ""))))))
  11436. (defun org-sparse-tree (&optional arg)
  11437. "Create a sparse tree, prompt for the details.
  11438. This command can create sparse trees. You first need to select the type
  11439. of match used to create the tree:
  11440. t Show all TODO entries.
  11441. T Show entries with a specific TODO keyword.
  11442. m Show entries selected by a tags/property match.
  11443. p Enter a property name and its value (both with completion on existing
  11444. names/values) and show entries with that property.
  11445. r Show entries matching a regular expression (`/' can be used as well)
  11446. d Show deadlines due within `org-deadline-warning-days'.
  11447. b Show deadlines and scheduled items before a date.
  11448. a Show deadlines and scheduled items after a date."
  11449. (interactive "P")
  11450. (let (ans kwd value)
  11451. (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date [D]ates range")
  11452. (setq ans (read-char-exclusive))
  11453. (cond
  11454. ((equal ans ?d)
  11455. (call-interactively 'org-check-deadlines))
  11456. ((equal ans ?b)
  11457. (call-interactively 'org-check-before-date))
  11458. ((equal ans ?a)
  11459. (call-interactively 'org-check-after-date))
  11460. ((equal ans ?D)
  11461. (call-interactively 'org-check-dates-range))
  11462. ((equal ans ?t)
  11463. (org-show-todo-tree nil))
  11464. ((equal ans ?T)
  11465. (org-show-todo-tree '(4)))
  11466. ((member ans '(?T ?m))
  11467. (call-interactively 'org-match-sparse-tree))
  11468. ((member ans '(?p ?P))
  11469. (setq kwd (org-icompleting-read "Property: "
  11470. (mapcar 'list (org-buffer-property-keys))))
  11471. (setq value (org-icompleting-read "Value: "
  11472. (mapcar 'list (org-property-values kwd))))
  11473. (unless (string-match "\\`{.*}\\'" value)
  11474. (setq value (concat "\"" value "\"")))
  11475. (org-match-sparse-tree arg (concat kwd "=" value)))
  11476. ((member ans '(?r ?R ?/))
  11477. (call-interactively 'org-occur))
  11478. (t (error "No such sparse tree command \"%c\"" ans)))))
  11479. (defvar org-occur-highlights nil
  11480. "List of overlays used for occur matches.")
  11481. (make-variable-buffer-local 'org-occur-highlights)
  11482. (defvar org-occur-parameters nil
  11483. "Parameters of the active org-occur calls.
  11484. This is a list, each call to org-occur pushes as cons cell,
  11485. containing the regular expression and the callback, onto the list.
  11486. The list can contain several entries if `org-occur' has been called
  11487. several time with the KEEP-PREVIOUS argument. Otherwise, this list
  11488. will only contain one set of parameters. When the highlights are
  11489. removed (for example with `C-c C-c', or with the next edit (depending
  11490. on `org-remove-highlights-with-change'), this variable is emptied
  11491. as well.")
  11492. (make-variable-buffer-local 'org-occur-parameters)
  11493. (defun org-occur (regexp &optional keep-previous callback)
  11494. "Make a compact tree which shows all matches of REGEXP.
  11495. The tree will show the lines where the regexp matches, and all higher
  11496. headlines above the match. It will also show the heading after the match,
  11497. to make sure editing the matching entry is easy.
  11498. If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
  11499. call to `org-occur' will be kept, to allow stacking of calls to this
  11500. command.
  11501. If CALLBACK is non-nil, it is a function which is called to confirm
  11502. that the match should indeed be shown."
  11503. (interactive "sRegexp: \nP")
  11504. (when (equal regexp "")
  11505. (error "Regexp cannot be empty"))
  11506. (unless keep-previous
  11507. (org-remove-occur-highlights nil nil t))
  11508. (push (cons regexp callback) org-occur-parameters)
  11509. (let ((cnt 0))
  11510. (save-excursion
  11511. (goto-char (point-min))
  11512. (if (or (not keep-previous) ; do not want to keep
  11513. (not org-occur-highlights)) ; no previous matches
  11514. ;; hide everything
  11515. (org-overview))
  11516. (while (re-search-forward regexp nil t)
  11517. (when (or (not callback)
  11518. (save-match-data (funcall callback)))
  11519. (setq cnt (1+ cnt))
  11520. (when org-highlight-sparse-tree-matches
  11521. (org-highlight-new-match (match-beginning 0) (match-end 0)))
  11522. (org-show-context 'occur-tree))))
  11523. (when org-remove-highlights-with-change
  11524. (org-add-hook 'before-change-functions 'org-remove-occur-highlights
  11525. nil 'local))
  11526. (unless org-sparse-tree-open-archived-trees
  11527. (org-hide-archived-subtrees (point-min) (point-max)))
  11528. (run-hooks 'org-occur-hook)
  11529. (if (org-called-interactively-p 'interactive)
  11530. (message "%d match(es) for regexp %s" cnt regexp))
  11531. cnt))
  11532. (defun org-occur-next-match (&optional n reset)
  11533. "Function for `next-error-function' to find sparse tree matches.
  11534. N is the number of matches to move, when negative move backwards.
  11535. RESET is entirely ignored - this function always goes back to the
  11536. starting point when no match is found."
  11537. (let* ((limit (if (< n 0) (point-min) (point-max)))
  11538. (search-func (if (< n 0)
  11539. 'previous-single-char-property-change
  11540. 'next-single-char-property-change))
  11541. (n (abs n))
  11542. (pos (point))
  11543. p1)
  11544. (catch 'exit
  11545. (while (setq p1 (funcall search-func (point) 'org-type))
  11546. (when (equal p1 limit)
  11547. (goto-char pos)
  11548. (error "No more matches"))
  11549. (when (equal (get-char-property p1 'org-type) 'org-occur)
  11550. (setq n (1- n))
  11551. (when (= n 0)
  11552. (goto-char p1)
  11553. (throw 'exit (point))))
  11554. (goto-char p1))
  11555. (goto-char p1)
  11556. (error "No more matches"))))
  11557. (defun org-show-context (&optional key)
  11558. "Make sure point and context are visible.
  11559. How much context is shown depends upon the variables
  11560. `org-show-hierarchy-above', `org-show-following-heading',
  11561. `org-show-entry-below' and `org-show-siblings'."
  11562. (let ((heading-p (org-at-heading-p t))
  11563. (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
  11564. (following-p (org-get-alist-option org-show-following-heading key))
  11565. (entry-p (org-get-alist-option org-show-entry-below key))
  11566. (siblings-p (org-get-alist-option org-show-siblings key)))
  11567. (catch 'exit
  11568. ;; Show heading or entry text
  11569. (if (and heading-p (not entry-p))
  11570. (org-flag-heading nil) ; only show the heading
  11571. (and (or entry-p (outline-invisible-p) (org-invisible-p2))
  11572. (org-show-hidden-entry))) ; show entire entry
  11573. (when following-p
  11574. ;; Show next sibling, or heading below text
  11575. (save-excursion
  11576. (and (if heading-p (org-goto-sibling) (outline-next-heading))
  11577. (org-flag-heading nil))))
  11578. (when siblings-p (org-show-siblings))
  11579. (when hierarchy-p
  11580. ;; show all higher headings, possibly with siblings
  11581. (save-excursion
  11582. (while (and (condition-case nil
  11583. (progn (org-up-heading-all 1) t)
  11584. (error nil))
  11585. (not (bobp)))
  11586. (org-flag-heading nil)
  11587. (when siblings-p (org-show-siblings))))))))
  11588. (defvar org-reveal-start-hook nil
  11589. "Hook run before revealing a location.")
  11590. (defun org-reveal (&optional siblings)
  11591. "Show current entry, hierarchy above it, and the following headline.
  11592. This can be used to show a consistent set of context around locations
  11593. exposed with `org-show-hierarchy-above' or `org-show-following-heading'
  11594. not t for the search context.
  11595. With optional argument SIBLINGS, on each level of the hierarchy all
  11596. siblings are shown. This repairs the tree structure to what it would
  11597. look like when opened with hierarchical calls to `org-cycle'.
  11598. With double optional argument \\[universal-argument] \\[universal-argument], \
  11599. go to the parent and show the
  11600. entire tree."
  11601. (interactive "P")
  11602. (run-hooks 'org-reveal-start-hook)
  11603. (let ((org-show-hierarchy-above t)
  11604. (org-show-following-heading t)
  11605. (org-show-siblings (if siblings t org-show-siblings)))
  11606. (org-show-context nil))
  11607. (when (equal siblings '(16))
  11608. (save-excursion
  11609. (when (org-up-heading-safe)
  11610. (org-show-subtree)
  11611. (run-hook-with-args 'org-cycle-hook 'subtree)))))
  11612. (defun org-highlight-new-match (beg end)
  11613. "Highlight from BEG to END and mark the highlight is an occur headline."
  11614. (let ((ov (make-overlay beg end)))
  11615. (overlay-put ov 'face 'secondary-selection)
  11616. (overlay-put ov 'org-type 'org-occur)
  11617. (push ov org-occur-highlights)))
  11618. (defun org-remove-occur-highlights (&optional beg end noremove)
  11619. "Remove the occur highlights from the buffer.
  11620. BEG and END are ignored. If NOREMOVE is nil, remove this function
  11621. from the `before-change-functions' in the current buffer."
  11622. (interactive)
  11623. (unless org-inhibit-highlight-removal
  11624. (mapc 'delete-overlay org-occur-highlights)
  11625. (setq org-occur-highlights nil)
  11626. (setq org-occur-parameters nil)
  11627. (unless noremove
  11628. (remove-hook 'before-change-functions
  11629. 'org-remove-occur-highlights 'local))))
  11630. ;;;; Priorities
  11631. (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
  11632. "Regular expression matching the priority indicator.")
  11633. (defvar org-remove-priority-next-time nil)
  11634. (defun org-priority-up ()
  11635. "Increase the priority of the current item."
  11636. (interactive)
  11637. (org-priority 'up))
  11638. (defun org-priority-down ()
  11639. "Decrease the priority of the current item."
  11640. (interactive)
  11641. (org-priority 'down))
  11642. (defun org-priority (&optional action)
  11643. "Change the priority of an item by ARG.
  11644. ACTION can be `set', `up', `down', or a character."
  11645. (interactive)
  11646. (unless org-enable-priority-commands
  11647. (error "Priority commands are disabled"))
  11648. (setq action (or action 'set))
  11649. (let (current new news have remove)
  11650. (save-excursion
  11651. (org-back-to-heading t)
  11652. (if (looking-at org-priority-regexp)
  11653. (setq current (string-to-char (match-string 2))
  11654. have t))
  11655. (cond
  11656. ((eq action 'remove)
  11657. (setq remove t new ?\ ))
  11658. ((or (eq action 'set)
  11659. (if (featurep 'xemacs) (characterp action) (integerp action)))
  11660. (if (not (eq action 'set))
  11661. (setq new action)
  11662. (message "Priority %c-%c, SPC to remove: "
  11663. org-highest-priority org-lowest-priority)
  11664. (save-match-data
  11665. (setq new (read-char-exclusive))))
  11666. (if (and (= (upcase org-highest-priority) org-highest-priority)
  11667. (= (upcase org-lowest-priority) org-lowest-priority))
  11668. (setq new (upcase new)))
  11669. (cond ((equal new ?\ ) (setq remove t))
  11670. ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
  11671. (error "Priority must be between `%c' and `%c'"
  11672. org-highest-priority org-lowest-priority))))
  11673. ((eq action 'up)
  11674. (setq new (if have
  11675. (1- current) ; normal cycling
  11676. ;; last priority was empty
  11677. (if (eq last-command this-command)
  11678. org-lowest-priority ; wrap around empty to lowest
  11679. ;; default
  11680. (if org-priority-start-cycle-with-default
  11681. org-default-priority
  11682. (1- org-default-priority))))))
  11683. ((eq action 'down)
  11684. (setq new (if have
  11685. (1+ current) ; normal cycling
  11686. ;; last priority was empty
  11687. (if (eq last-command this-command)
  11688. org-highest-priority ; wrap around empty to highest
  11689. ;; default
  11690. (if org-priority-start-cycle-with-default
  11691. org-default-priority
  11692. (1+ org-default-priority))))))
  11693. (t (error "Invalid action")))
  11694. (if (or (< (upcase new) org-highest-priority)
  11695. (> (upcase new) org-lowest-priority))
  11696. (if (and (memq action '(up down))
  11697. (not have) (not (eq last-command this-command)))
  11698. ;; `new' is from default priority
  11699. (error
  11700. "The default can not be set, see `org-default-priority' why")
  11701. ;; normal cycling: `new' is beyond highest/lowest priority
  11702. ;; and is wrapped around to the empty priority
  11703. (setq remove t)))
  11704. (setq news (format "%c" new))
  11705. (if have
  11706. (if remove
  11707. (replace-match "" t t nil 1)
  11708. (replace-match news t t nil 2))
  11709. (if remove
  11710. (error "No priority cookie found in line")
  11711. (let ((case-fold-search nil))
  11712. (looking-at org-todo-line-regexp))
  11713. (if (match-end 2)
  11714. (progn
  11715. (goto-char (match-end 2))
  11716. (insert " [#" news "]"))
  11717. (goto-char (match-beginning 3))
  11718. (insert "[#" news "] "))))
  11719. (org-preserve-lc (org-set-tags nil 'align)))
  11720. (if remove
  11721. (message "Priority removed")
  11722. (message "Priority of current item set to %s" news))))
  11723. (defun org-get-priority (s)
  11724. "Find priority cookie and return priority."
  11725. (if (functionp org-get-priority-function)
  11726. (funcall org-get-priority-function)
  11727. (save-match-data
  11728. (if (not (string-match org-priority-regexp s))
  11729. (* 1000 (- org-lowest-priority org-default-priority))
  11730. (* 1000 (- org-lowest-priority
  11731. (string-to-char (match-string 2 s))))))))
  11732. ;;;; Tags
  11733. (defvar org-agenda-archives-mode)
  11734. (defvar org-map-continue-from nil
  11735. "Position from where mapping should continue.
  11736. Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
  11737. (defvar org-scanner-tags nil
  11738. "The current tag list while the tags scanner is running.")
  11739. (defvar org-trust-scanner-tags nil
  11740. "Should `org-get-tags-at' use the tags for the scanner.
  11741. This is for internal dynamical scoping only.
  11742. When this is non-nil, the function `org-get-tags-at' will return the value
  11743. of `org-scanner-tags' instead of building the list by itself. This
  11744. can lead to large speed-ups when the tags scanner is used in a file with
  11745. many entries, and when the list of tags is retrieved, for example to
  11746. obtain a list of properties. Building the tags list for each entry in such
  11747. a file becomes an N^2 operation - but with this variable set, it scales
  11748. as N.")
  11749. (defun org-scan-tags (action matcher todo-only &optional start-level)
  11750. "Scan headline tags with inheritance and produce output ACTION.
  11751. ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
  11752. or `agenda' to produce an entry list for an agenda view. It can also be
  11753. a Lisp form or a function that should be called at each matched headline, in
  11754. this case the return value is a list of all return values from these calls.
  11755. MATCHER is a Lisp form to be evaluated, testing if a given set of tags
  11756. qualifies a headline for inclusion. When TODO-ONLY is non-nil,
  11757. only lines with a not-done TODO keyword are included in the output.
  11758. This should be the same variable that was scoped into
  11759. and set by `org-make-tags-matcher' when it constructed MATCHER.
  11760. START-LEVEL can be a string with asterisks, reducing the scope to
  11761. headlines matching this string."
  11762. (require 'org-agenda)
  11763. (let* ((re (concat "^"
  11764. (if start-level
  11765. ;; Get the correct level to match
  11766. (concat "\\*\\{" (number-to-string start-level) "\\} ")
  11767. org-outline-regexp)
  11768. " *\\(\\<\\("
  11769. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  11770. (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
  11771. (props (list 'face 'default
  11772. 'done-face 'org-agenda-done
  11773. 'undone-face 'default
  11774. 'mouse-face 'highlight
  11775. 'org-not-done-regexp org-not-done-regexp
  11776. 'org-todo-regexp org-todo-regexp
  11777. 'org-complex-heading-regexp org-complex-heading-regexp
  11778. 'help-echo
  11779. (format "mouse-2 or RET jump to org file %s"
  11780. (abbreviate-file-name
  11781. (or (buffer-file-name (buffer-base-buffer))
  11782. (buffer-name (buffer-base-buffer)))))))
  11783. (case-fold-search nil)
  11784. (org-map-continue-from nil)
  11785. lspos tags tags-list
  11786. (tags-alist (list (cons 0 org-file-tags)))
  11787. (llast 0) rtn rtn1 level category i txt
  11788. todo marker entry priority)
  11789. (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
  11790. (setq action (list 'lambda nil action)))
  11791. (save-excursion
  11792. (goto-char (point-min))
  11793. (when (eq action 'sparse-tree)
  11794. (org-overview)
  11795. (org-remove-occur-highlights))
  11796. (while (re-search-forward re nil t)
  11797. (setq org-map-continue-from nil)
  11798. (catch :skip
  11799. (setq todo (if (match-end 1) (org-match-string-no-properties 2))
  11800. tags (if (match-end 4) (org-match-string-no-properties 4)))
  11801. (goto-char (setq lspos (match-beginning 0)))
  11802. (setq level (org-reduced-level (funcall outline-level))
  11803. category (org-get-category))
  11804. (setq i llast llast level)
  11805. ;; remove tag lists from same and sublevels
  11806. (while (>= i level)
  11807. (when (setq entry (assoc i tags-alist))
  11808. (setq tags-alist (delete entry tags-alist)))
  11809. (setq i (1- i)))
  11810. ;; add the next tags
  11811. (when tags
  11812. (setq tags (org-split-string tags ":")
  11813. tags-alist
  11814. (cons (cons level tags) tags-alist)))
  11815. ;; compile tags for current headline
  11816. (setq tags-list
  11817. (if org-use-tag-inheritance
  11818. (apply 'append (mapcar 'cdr (reverse tags-alist)))
  11819. tags)
  11820. org-scanner-tags tags-list)
  11821. (when org-use-tag-inheritance
  11822. (setcdr (car tags-alist)
  11823. (mapcar (lambda (x)
  11824. (setq x (copy-sequence x))
  11825. (org-add-prop-inherited x))
  11826. (cdar tags-alist))))
  11827. (when (and tags org-use-tag-inheritance
  11828. (or (not (eq t org-use-tag-inheritance))
  11829. org-tags-exclude-from-inheritance))
  11830. ;; selective inheritance, remove uninherited ones
  11831. (setcdr (car tags-alist)
  11832. (org-remove-uninherited-tags (cdar tags-alist))))
  11833. (when (and
  11834. ;; eval matcher only when the todo condition is OK
  11835. (and (or (not todo-only) (member todo org-not-done-keywords))
  11836. (let ((case-fold-search t) (org-trust-scanner-tags t))
  11837. (eval matcher)))
  11838. ;; Call the skipper, but return t if it does not skip,
  11839. ;; so that the `and' form continues evaluating
  11840. (progn
  11841. (unless (eq action 'sparse-tree) (org-agenda-skip))
  11842. t)
  11843. ;; Check if timestamps are deselecting this entry
  11844. (or (not todo-only)
  11845. (and (member todo org-not-done-keywords)
  11846. (or (not org-agenda-tags-todo-honor-ignore-options)
  11847. (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
  11848. ;; Extra check for the archive tag
  11849. ;; FIXME: Does the skipper already do this????
  11850. (or
  11851. (not (member org-archive-tag tags-list))
  11852. ;; we have an archive tag, should we use this anyway?
  11853. (or (not org-agenda-skip-archived-trees)
  11854. (and (eq action 'agenda) org-agenda-archives-mode))))
  11855. ;; select this headline
  11856. (cond
  11857. ((eq action 'sparse-tree)
  11858. (and org-highlight-sparse-tree-matches
  11859. (org-get-heading) (match-end 0)
  11860. (org-highlight-new-match
  11861. (match-beginning 1) (match-end 1)))
  11862. (org-show-context 'tags-tree))
  11863. ((eq action 'agenda)
  11864. (setq txt (org-agenda-format-item
  11865. ""
  11866. (concat
  11867. (if (eq org-tags-match-list-sublevels 'indented)
  11868. (make-string (1- level) ?.) "")
  11869. (org-get-heading))
  11870. category
  11871. tags-list)
  11872. priority (org-get-priority txt))
  11873. (goto-char lspos)
  11874. (setq marker (org-agenda-new-marker))
  11875. (org-add-props txt props
  11876. 'org-marker marker 'org-hd-marker marker 'org-category category
  11877. 'todo-state todo
  11878. 'priority priority 'type "tagsmatch")
  11879. (push txt rtn))
  11880. ((functionp action)
  11881. (setq org-map-continue-from nil)
  11882. (save-excursion
  11883. (setq rtn1 (funcall action))
  11884. (push rtn1 rtn)))
  11885. (t (error "Invalid action")))
  11886. ;; if we are to skip sublevels, jump to end of subtree
  11887. (unless org-tags-match-list-sublevels
  11888. (org-end-of-subtree t)
  11889. (backward-char 1))))
  11890. ;; Get the correct position from where to continue
  11891. (if org-map-continue-from
  11892. (goto-char org-map-continue-from)
  11893. (and (= (point) lspos) (end-of-line 1)))))
  11894. (when (and (eq action 'sparse-tree)
  11895. (not org-sparse-tree-open-archived-trees))
  11896. (org-hide-archived-subtrees (point-min) (point-max)))
  11897. (nreverse rtn)))
  11898. (defun org-remove-uninherited-tags (tags)
  11899. "Remove all tags that are not inherited from the list TAGS."
  11900. (cond
  11901. ((eq org-use-tag-inheritance t)
  11902. (if org-tags-exclude-from-inheritance
  11903. (org-delete-all org-tags-exclude-from-inheritance tags)
  11904. tags))
  11905. ((not org-use-tag-inheritance) nil)
  11906. ((stringp org-use-tag-inheritance)
  11907. (delq nil (mapcar
  11908. (lambda (x)
  11909. (if (and (string-match org-use-tag-inheritance x)
  11910. (not (member x org-tags-exclude-from-inheritance)))
  11911. x nil))
  11912. tags)))
  11913. ((listp org-use-tag-inheritance)
  11914. (delq nil (mapcar
  11915. (lambda (x)
  11916. (if (member x org-use-tag-inheritance) x nil))
  11917. tags)))))
  11918. (defun org-match-sparse-tree (&optional todo-only match)
  11919. "Create a sparse tree according to tags string MATCH.
  11920. MATCH can contain positive and negative selection of tags, like
  11921. \"+WORK+URGENT-WITHBOSS\".
  11922. If optional argument TODO-ONLY is non-nil, only select lines that are
  11923. also TODO lines."
  11924. (interactive "P")
  11925. (org-prepare-agenda-buffers (list (current-buffer)))
  11926. (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
  11927. (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
  11928. (defvar org-cached-props nil)
  11929. (defun org-cached-entry-get (pom property)
  11930. (if (or (eq t org-use-property-inheritance)
  11931. (and (stringp org-use-property-inheritance)
  11932. (string-match org-use-property-inheritance property))
  11933. (and (listp org-use-property-inheritance)
  11934. (member property org-use-property-inheritance)))
  11935. ;; Caching is not possible, check it directly
  11936. (org-entry-get pom property 'inherit)
  11937. ;; Get all properties, so that we can do complicated checks easily
  11938. (cdr (assoc property (or org-cached-props
  11939. (setq org-cached-props
  11940. (org-entry-properties pom)))))))
  11941. (defun org-global-tags-completion-table (&optional files)
  11942. "Return the list of all tags in all agenda buffer/files.
  11943. Optional FILES argument is a list of files to which can be used
  11944. instead of the agenda files."
  11945. (save-excursion
  11946. (org-uniquify
  11947. (delq nil
  11948. (apply 'append
  11949. (mapcar
  11950. (lambda (file)
  11951. (set-buffer (find-file-noselect file))
  11952. (append (org-get-buffer-tags)
  11953. (mapcar (lambda (x) (if (stringp (car-safe x))
  11954. (list (car-safe x)) nil))
  11955. org-tag-alist)))
  11956. (if (and files (car files))
  11957. files
  11958. (org-agenda-files))))))))
  11959. (defun org-make-tags-matcher (match)
  11960. "Create the TAGS/TODO matcher form for the selection string MATCH.
  11961. The variable `todo-only' is scoped dynamically into this function; it will be
  11962. set to t if the matcher restricts matching to TODO entries,
  11963. otherwise will not be touched.
  11964. Returns a cons of the selection string MATCH and the constructed
  11965. lisp form implementing the matcher. The matcher is to be
  11966. evaluated at an Org entry, with point on the headline,
  11967. and returns t if the entry matches the
  11968. selection string MATCH. The returned lisp form references
  11969. two variables with information about the entry, which must be
  11970. bound around the form's evaluation: todo, the TODO keyword at the
  11971. entry (or nil of none); and tags-list, the list of all tags at the
  11972. entry including inherited ones. Additionally, the category
  11973. of the entry (if any) must be specified as the text property
  11974. 'org-category on the headline.
  11975. See also `org-scan-tags'.
  11976. "
  11977. (declare (special todo-only))
  11978. (unless (boundp 'todo-only)
  11979. (error "org-make-tags-matcher expects todo-only to be scoped in"))
  11980. (unless match
  11981. ;; Get a new match request, with completion
  11982. (let ((org-last-tags-completion-table
  11983. (org-global-tags-completion-table)))
  11984. (setq match (org-completing-read-no-i
  11985. "Match: " 'org-tags-completion-function nil nil nil
  11986. 'org-tags-history))))
  11987. ;; Parse the string and create a lisp form
  11988. (let ((match0 match)
  11989. (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
  11990. minus tag mm
  11991. tagsmatch todomatch tagsmatcher todomatcher kwd matcher
  11992. orterms term orlist re-p str-p level-p level-op time-p
  11993. prop-p pn pv po gv rest)
  11994. (if (string-match "/+" match)
  11995. ;; match contains also a todo-matching request
  11996. (progn
  11997. (setq tagsmatch (substring match 0 (match-beginning 0))
  11998. todomatch (substring match (match-end 0)))
  11999. (if (string-match "^!" todomatch)
  12000. (setq todo-only t todomatch (substring todomatch 1)))
  12001. (if (string-match "^\\s-*$" todomatch)
  12002. (setq todomatch nil)))
  12003. ;; only matching tags
  12004. (setq tagsmatch match todomatch nil))
  12005. ;; Make the tags matcher
  12006. (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
  12007. (setq tagsmatcher t)
  12008. (setq orterms (org-split-string tagsmatch "|") orlist nil)
  12009. (while (setq term (pop orterms))
  12010. (while (and (equal (substring term -1) "\\") orterms)
  12011. (setq term (concat term "|" (pop orterms)))) ; repair bad split
  12012. (while (string-match re term)
  12013. (setq rest (substring term (match-end 0))
  12014. minus (and (match-end 1)
  12015. (equal (match-string 1 term) "-"))
  12016. tag (save-match-data (replace-regexp-in-string
  12017. "\\\\-" "-"
  12018. (match-string 2 term)))
  12019. re-p (equal (string-to-char tag) ?{)
  12020. level-p (match-end 4)
  12021. prop-p (match-end 5)
  12022. mm (cond
  12023. (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
  12024. (level-p
  12025. (setq level-op (org-op-to-function (match-string 3 term)))
  12026. `(,level-op level ,(string-to-number
  12027. (match-string 4 term))))
  12028. (prop-p
  12029. (setq pn (match-string 5 term)
  12030. po (match-string 6 term)
  12031. pv (match-string 7 term)
  12032. re-p (equal (string-to-char pv) ?{)
  12033. str-p (equal (string-to-char pv) ?\")
  12034. time-p (save-match-data
  12035. (string-match "^\"[[<].*[]>]\"$" pv))
  12036. pv (if (or re-p str-p) (substring pv 1 -1) pv))
  12037. (if time-p (setq pv (org-matcher-time pv)))
  12038. (setq po (org-op-to-function po (if time-p 'time str-p)))
  12039. (cond
  12040. ((equal pn "CATEGORY")
  12041. (setq gv '(get-text-property (point) 'org-category)))
  12042. ((equal pn "TODO")
  12043. (setq gv 'todo))
  12044. (t
  12045. (setq gv `(org-cached-entry-get nil ,pn))))
  12046. (if re-p
  12047. (if (eq po 'org<>)
  12048. `(not (string-match ,pv (or ,gv "")))
  12049. `(string-match ,pv (or ,gv "")))
  12050. (if str-p
  12051. `(,po (or ,gv "") ,pv)
  12052. `(,po (string-to-number (or ,gv ""))
  12053. ,(string-to-number pv) ))))
  12054. (t `(member ,tag tags-list)))
  12055. mm (if minus (list 'not mm) mm)
  12056. term rest)
  12057. (push mm tagsmatcher))
  12058. (push (if (> (length tagsmatcher) 1)
  12059. (cons 'and tagsmatcher)
  12060. (car tagsmatcher))
  12061. orlist)
  12062. (setq tagsmatcher nil))
  12063. (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
  12064. (setq tagsmatcher
  12065. (list 'progn '(setq org-cached-props nil) tagsmatcher)))
  12066. ;; Make the todo matcher
  12067. (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
  12068. (setq todomatcher t)
  12069. (setq orterms (org-split-string todomatch "|") orlist nil)
  12070. (while (setq term (pop orterms))
  12071. (while (string-match re term)
  12072. (setq minus (and (match-end 1)
  12073. (equal (match-string 1 term) "-"))
  12074. kwd (match-string 2 term)
  12075. re-p (equal (string-to-char kwd) ?{)
  12076. term (substring term (match-end 0))
  12077. mm (if re-p
  12078. `(string-match ,(substring kwd 1 -1) todo)
  12079. (list 'equal 'todo kwd))
  12080. mm (if minus (list 'not mm) mm))
  12081. (push mm todomatcher))
  12082. (push (if (> (length todomatcher) 1)
  12083. (cons 'and todomatcher)
  12084. (car todomatcher))
  12085. orlist)
  12086. (setq todomatcher nil))
  12087. (setq todomatcher (if (> (length orlist) 1)
  12088. (cons 'or orlist) (car orlist))))
  12089. ;; Return the string and lisp forms of the matcher
  12090. (setq matcher (if todomatcher
  12091. (list 'and tagsmatcher todomatcher)
  12092. tagsmatcher))
  12093. (when todo-only
  12094. (setq matcher (list 'and '(member todo org-not-done-keywords)
  12095. matcher)))
  12096. (cons match0 matcher)))
  12097. (defun org-op-to-function (op &optional stringp)
  12098. "Turn an operator into the appropriate function."
  12099. (setq op
  12100. (cond
  12101. ((equal op "<" ) '(< string< org-time<))
  12102. ((equal op ">" ) '(> org-string> org-time>))
  12103. ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
  12104. ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
  12105. ((member op '("=" "==")) '(= string= org-time=))
  12106. ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
  12107. (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
  12108. (defun org<> (a b) (not (= a b)))
  12109. (defun org-string<= (a b) (or (string= a b) (string< a b)))
  12110. (defun org-string>= (a b) (not (string< a b)))
  12111. (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
  12112. (defun org-string<> (a b) (not (string= a b)))
  12113. (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
  12114. (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
  12115. (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
  12116. (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
  12117. (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
  12118. (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
  12119. (defun org-2ft (s)
  12120. "Convert S to a floating point time.
  12121. If S is already a number, just return it. If it is a string, parse
  12122. it as a time string and apply `float-time' to it. If S is nil, just return 0."
  12123. (cond
  12124. ((numberp s) s)
  12125. ((stringp s)
  12126. (condition-case nil
  12127. (float-time (apply 'encode-time (org-parse-time-string s)))
  12128. (error 0.)))
  12129. (t 0.)))
  12130. (defun org-time-today ()
  12131. "Time in seconds today at 0:00.
  12132. Returns the float number of seconds since the beginning of the
  12133. epoch to the beginning of today (00:00)."
  12134. (float-time (apply 'encode-time
  12135. (append '(0 0 0) (nthcdr 3 (decode-time))))))
  12136. (defun org-matcher-time (s)
  12137. "Interpret a time comparison value."
  12138. (save-match-data
  12139. (cond
  12140. ((string= s "<now>") (float-time))
  12141. ((string= s "<today>") (org-time-today))
  12142. ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
  12143. ((string= s "<yesterday>") (- (org-time-today) 86400.0))
  12144. ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
  12145. (+ (org-time-today)
  12146. (* (string-to-number (match-string 1 s))
  12147. (cdr (assoc (match-string 2 s)
  12148. '(("d" . 86400.0) ("w" . 604800.0)
  12149. ("m" . 2678400.0) ("y" . 31557600.0)))))))
  12150. (t (org-2ft s)))))
  12151. (defun org-match-any-p (re list)
  12152. "Does re match any element of list?"
  12153. (setq list (mapcar (lambda (x) (string-match re x)) list))
  12154. (delq nil list))
  12155. (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
  12156. (defvar org-tags-overlay (make-overlay 1 1))
  12157. (org-detach-overlay org-tags-overlay)
  12158. (defun org-get-local-tags-at (&optional pos)
  12159. "Get a list of tags defined in the current headline."
  12160. (org-get-tags-at pos 'local))
  12161. (defun org-get-local-tags ()
  12162. "Get a list of tags defined in the current headline."
  12163. (org-get-tags-at nil 'local))
  12164. (defun org-get-tags-at (&optional pos local)
  12165. "Get a list of all headline tags applicable at POS.
  12166. POS defaults to point. If tags are inherited, the list contains
  12167. the targets in the same sequence as the headlines appear, i.e.
  12168. the tags of the current headline come last.
  12169. When LOCAL is non-nil, only return tags from the current headline,
  12170. ignore inherited ones."
  12171. (interactive)
  12172. (if (and org-trust-scanner-tags
  12173. (or (not pos) (equal pos (point)))
  12174. (not local))
  12175. org-scanner-tags
  12176. (let (tags ltags lastpos parent)
  12177. (save-excursion
  12178. (save-restriction
  12179. (widen)
  12180. (goto-char (or pos (point)))
  12181. (save-match-data
  12182. (catch 'done
  12183. (condition-case nil
  12184. (progn
  12185. (org-back-to-heading t)
  12186. (while (not (equal lastpos (point)))
  12187. (setq lastpos (point))
  12188. (when (looking-at
  12189. (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
  12190. (setq ltags (org-split-string
  12191. (org-match-string-no-properties 1) ":"))
  12192. (when parent
  12193. (setq ltags (mapcar 'org-add-prop-inherited ltags)))
  12194. (setq tags (append
  12195. (if parent
  12196. (org-remove-uninherited-tags ltags)
  12197. ltags)
  12198. tags)))
  12199. (or org-use-tag-inheritance (throw 'done t))
  12200. (if local (throw 'done t))
  12201. (or (org-up-heading-safe) (error nil))
  12202. (setq parent t)))
  12203. (error nil)))))
  12204. (if local
  12205. tags
  12206. (append (org-remove-uninherited-tags org-file-tags) tags))))))
  12207. (defun org-add-prop-inherited (s)
  12208. (add-text-properties 0 (length s) '(inherited t) s)
  12209. s)
  12210. (defun org-toggle-tag (tag &optional onoff)
  12211. "Toggle the tag TAG for the current line.
  12212. If ONOFF is `on' or `off', don't toggle but set to this state."
  12213. (let (res current)
  12214. (save-excursion
  12215. (org-back-to-heading t)
  12216. (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
  12217. (point-at-eol) t)
  12218. (progn
  12219. (setq current (match-string 1))
  12220. (replace-match ""))
  12221. (setq current ""))
  12222. (setq current (nreverse (org-split-string current ":")))
  12223. (cond
  12224. ((eq onoff 'on)
  12225. (setq res t)
  12226. (or (member tag current) (push tag current)))
  12227. ((eq onoff 'off)
  12228. (or (not (member tag current)) (setq current (delete tag current))))
  12229. (t (if (member tag current)
  12230. (setq current (delete tag current))
  12231. (setq res t)
  12232. (push tag current))))
  12233. (end-of-line 1)
  12234. (if current
  12235. (progn
  12236. (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
  12237. (org-set-tags nil t))
  12238. (delete-horizontal-space))
  12239. (run-hooks 'org-after-tags-change-hook))
  12240. res))
  12241. (defun org-align-tags-here (to-col)
  12242. ;; Assumes that this is a headline
  12243. (let ((pos (point)) (col (current-column)) ncol tags-l p)
  12244. (beginning-of-line 1)
  12245. (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12246. (< pos (match-beginning 2)))
  12247. (progn
  12248. (setq tags-l (- (match-end 2) (match-beginning 2)))
  12249. (goto-char (match-beginning 1))
  12250. (insert " ")
  12251. (delete-region (point) (1+ (match-beginning 2)))
  12252. (setq ncol (max (current-column)
  12253. (1+ col)
  12254. (if (> to-col 0)
  12255. to-col
  12256. (- (abs to-col) tags-l))))
  12257. (setq p (point))
  12258. (insert (make-string (- ncol (current-column)) ?\ ))
  12259. (setq ncol (current-column))
  12260. (when indent-tabs-mode (tabify p (point-at-eol)))
  12261. (org-move-to-column (min ncol col) t))
  12262. (goto-char pos))))
  12263. (defun org-set-tags-command (&optional arg just-align)
  12264. "Call the set-tags command for the current entry."
  12265. (interactive "P")
  12266. (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
  12267. (org-set-tags arg just-align)
  12268. (save-excursion
  12269. (org-back-to-heading t)
  12270. (org-set-tags arg just-align))))
  12271. (defun org-set-tags-to (data)
  12272. "Set the tags of the current entry to DATA, replacing the current tags.
  12273. DATA may be a tags string like :aa:bb:cc:, or a list of tags.
  12274. If DATA is nil or the empty string, any tags will be removed."
  12275. (interactive "sTags: ")
  12276. (setq data
  12277. (cond
  12278. ((eq data nil) "")
  12279. ((equal data "") "")
  12280. ((stringp data)
  12281. (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
  12282. ":"))
  12283. ((listp data)
  12284. (concat ":" (mapconcat 'identity data ":") ":"))
  12285. (t nil)))
  12286. (when data
  12287. (save-excursion
  12288. (org-back-to-heading t)
  12289. (when (looking-at org-complex-heading-regexp)
  12290. (if (match-end 5)
  12291. (progn
  12292. (goto-char (match-beginning 5))
  12293. (insert data)
  12294. (delete-region (point) (point-at-eol))
  12295. (org-set-tags nil 'align))
  12296. (goto-char (point-at-eol))
  12297. (insert " " data)
  12298. (org-set-tags nil 'align)))
  12299. (beginning-of-line 1)
  12300. (if (looking-at ".*?\\([ \t]+\\)$")
  12301. (delete-region (match-beginning 1) (match-end 1))))))
  12302. (defun org-align-all-tags ()
  12303. "Align the tags i all headings."
  12304. (interactive)
  12305. (save-excursion
  12306. (or (ignore-errors (org-back-to-heading t))
  12307. (outline-next-heading))
  12308. (if (org-at-heading-p)
  12309. (org-set-tags t)
  12310. (message "No headings"))))
  12311. (defvar org-indent-indentation-per-level)
  12312. (defun org-set-tags (&optional arg just-align)
  12313. "Set the tags for the current headline.
  12314. With prefix ARG, realign all tags in headings in the current buffer."
  12315. (interactive "P")
  12316. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  12317. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  12318. 'region-start-level 'region))
  12319. org-loop-over-headlines-in-active-region)
  12320. (org-map-entries
  12321. ;; We don't use ARG and JUST-ALIGN here these args are not
  12322. ;; useful when looping over headlines
  12323. `(org-set-tags)
  12324. org-loop-over-headlines-in-active-region
  12325. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  12326. (let* ((re org-outline-regexp-bol)
  12327. (current (unless arg (org-get-tags-string)))
  12328. (col (current-column))
  12329. (org-setting-tags t)
  12330. table current-tags inherited-tags ; computed below when needed
  12331. tags p0 c0 c1 rpl di tc level)
  12332. (if arg
  12333. (save-excursion
  12334. (goto-char (point-min))
  12335. (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
  12336. (while (re-search-forward re nil t)
  12337. (org-set-tags nil t)
  12338. (end-of-line 1)))
  12339. (message "All tags realigned to column %d" org-tags-column))
  12340. (if just-align
  12341. (setq tags current)
  12342. ;; Get a new set of tags from the user
  12343. (save-excursion
  12344. (setq table (append org-tag-persistent-alist
  12345. (or org-tag-alist (org-get-buffer-tags))
  12346. (and
  12347. org-complete-tags-always-offer-all-agenda-tags
  12348. (org-global-tags-completion-table
  12349. (org-agenda-files))))
  12350. org-last-tags-completion-table table
  12351. current-tags (org-split-string current ":")
  12352. inherited-tags (nreverse
  12353. (nthcdr (length current-tags)
  12354. (nreverse (org-get-tags-at))))
  12355. tags
  12356. (if (or (eq t org-use-fast-tag-selection)
  12357. (and org-use-fast-tag-selection
  12358. (delq nil (mapcar 'cdr table))))
  12359. (org-fast-tag-selection
  12360. current-tags inherited-tags table
  12361. (if org-fast-tag-selection-include-todo
  12362. org-todo-key-alist))
  12363. (let ((org-add-colon-after-tag-completion (< 1 (length table))))
  12364. (org-trim
  12365. (org-icompleting-read "Tags: "
  12366. 'org-tags-completion-function
  12367. nil nil current 'org-tags-history))))))
  12368. (while (string-match "[-+&]+" tags)
  12369. ;; No boolean logic, just a list
  12370. (setq tags (replace-match ":" t t tags))))
  12371. (setq tags (replace-regexp-in-string "[,]" ":" tags))
  12372. (if org-tags-sort-function
  12373. (setq tags (mapconcat 'identity
  12374. (sort (org-split-string
  12375. tags (org-re "[^[:alnum:]_@#%]+"))
  12376. org-tags-sort-function) ":")))
  12377. (if (string-match "\\`[\t ]*\\'" tags)
  12378. (setq tags "")
  12379. (unless (string-match ":$" tags) (setq tags (concat tags ":")))
  12380. (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
  12381. ;; Insert new tags at the correct column
  12382. (beginning-of-line 1)
  12383. (setq level (or (and (looking-at org-outline-regexp)
  12384. (- (match-end 0) (point) 1))
  12385. 1))
  12386. (cond
  12387. ((and (equal current "") (equal tags "")))
  12388. ((re-search-forward
  12389. (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
  12390. (point-at-eol) t)
  12391. (if (equal tags "")
  12392. (setq rpl "")
  12393. (goto-char (match-beginning 0))
  12394. (setq c0 (current-column)
  12395. ;; compute offset for the case of org-indent-mode active
  12396. di (if org-indent-mode
  12397. (* (1- org-indent-indentation-per-level) (1- level))
  12398. 0)
  12399. p0 (if (equal (char-before) ?*) (1+ (point)) (point))
  12400. tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
  12401. c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
  12402. rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
  12403. (replace-match rpl t t)
  12404. (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
  12405. tags)
  12406. (t (error "Tags alignment failed")))
  12407. (org-move-to-column col)
  12408. (unless just-align
  12409. (run-hooks 'org-after-tags-change-hook))))))
  12410. (defun org-change-tag-in-region (beg end tag off)
  12411. "Add or remove TAG for each entry in the region.
  12412. This works in the agenda, and also in an org-mode buffer."
  12413. (interactive
  12414. (list (region-beginning) (region-end)
  12415. (let ((org-last-tags-completion-table
  12416. (if (derived-mode-p 'org-mode)
  12417. (org-get-buffer-tags)
  12418. (org-global-tags-completion-table))))
  12419. (org-icompleting-read
  12420. "Tag: " 'org-tags-completion-function nil nil nil
  12421. 'org-tags-history))
  12422. (progn
  12423. (message "[s]et or [r]emove? ")
  12424. (equal (read-char-exclusive) ?r))))
  12425. (if (fboundp 'deactivate-mark) (deactivate-mark))
  12426. (let ((agendap (equal major-mode 'org-agenda-mode))
  12427. l1 l2 m buf pos newhead (cnt 0))
  12428. (goto-char end)
  12429. (setq l2 (1- (org-current-line)))
  12430. (goto-char beg)
  12431. (setq l1 (org-current-line))
  12432. (loop for l from l1 to l2 do
  12433. (org-goto-line l)
  12434. (setq m (get-text-property (point) 'org-hd-marker))
  12435. (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
  12436. (and agendap m))
  12437. (setq buf (if agendap (marker-buffer m) (current-buffer))
  12438. pos (if agendap m (point)))
  12439. (with-current-buffer buf
  12440. (save-excursion
  12441. (save-restriction
  12442. (goto-char pos)
  12443. (setq cnt (1+ cnt))
  12444. (org-toggle-tag tag (if off 'off 'on))
  12445. (setq newhead (org-get-heading)))))
  12446. (and agendap (org-agenda-change-all-lines newhead m))))
  12447. (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
  12448. (defun org-tags-completion-function (string predicate &optional flag)
  12449. (let (s1 s2 rtn (ctable org-last-tags-completion-table)
  12450. (confirm (lambda (x) (stringp (car x)))))
  12451. (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
  12452. (setq s1 (match-string 1 string)
  12453. s2 (match-string 2 string))
  12454. (setq s1 "" s2 string))
  12455. (cond
  12456. ((eq flag nil)
  12457. ;; try completion
  12458. (setq rtn (try-completion s2 ctable confirm))
  12459. (if (stringp rtn)
  12460. (setq rtn
  12461. (concat s1 s2 (substring rtn (length s2))
  12462. (if (and org-add-colon-after-tag-completion
  12463. (assoc rtn ctable))
  12464. ":" ""))))
  12465. rtn)
  12466. ((eq flag t)
  12467. ;; all-completions
  12468. (all-completions s2 ctable confirm)
  12469. )
  12470. ((eq flag 'lambda)
  12471. ;; exact match?
  12472. (assoc s2 ctable)))
  12473. ))
  12474. (defun org-fast-tag-insert (kwd tags face &optional end)
  12475. "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
  12476. (insert (format "%-12s" (concat kwd ":"))
  12477. (org-add-props (mapconcat 'identity tags " ") nil 'face face)
  12478. (or end "")))
  12479. (defun org-fast-tag-show-exit (flag)
  12480. (save-excursion
  12481. (org-goto-line 3)
  12482. (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
  12483. (replace-match ""))
  12484. (when flag
  12485. (end-of-line 1)
  12486. (org-move-to-column (- (window-width) 19) t)
  12487. (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
  12488. (defun org-set-current-tags-overlay (current prefix)
  12489. (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
  12490. (if (featurep 'xemacs)
  12491. (org-overlay-display org-tags-overlay (concat prefix s)
  12492. 'secondary-selection)
  12493. (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
  12494. (org-overlay-display org-tags-overlay (concat prefix s)))))
  12495. (defvar org-last-tag-selection-key nil)
  12496. (defun org-fast-tag-selection (current inherited table &optional todo-table)
  12497. "Fast tag selection with single keys.
  12498. CURRENT is the current list of tags in the headline, INHERITED is the
  12499. list of inherited tags, and TABLE is an alist of tags and corresponding keys,
  12500. possibly with grouping information. TODO-TABLE is a similar table with
  12501. TODO keywords, should these have keys assigned to them.
  12502. If the keys are nil, a-z are automatically assigned.
  12503. Returns the new tags string, or nil to not change the current settings."
  12504. (let* ((fulltable (append table todo-table))
  12505. (maxlen (apply 'max (mapcar
  12506. (lambda (x)
  12507. (if (stringp (car x)) (string-width (car x)) 0))
  12508. fulltable)))
  12509. (buf (current-buffer))
  12510. (expert (eq org-fast-tag-selection-single-key 'expert))
  12511. (buffer-tags nil)
  12512. (fwidth (+ maxlen 3 1 3))
  12513. (ncol (/ (- (window-width) 4) fwidth))
  12514. (i-face 'org-done)
  12515. (c-face 'org-todo)
  12516. tg cnt e c char c1 c2 ntable tbl rtn
  12517. ov-start ov-end ov-prefix
  12518. (exit-after-next org-fast-tag-selection-single-key)
  12519. (done-keywords org-done-keywords)
  12520. groups ingroup)
  12521. (save-excursion
  12522. (beginning-of-line 1)
  12523. (if (looking-at
  12524. (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12525. (setq ov-start (match-beginning 1)
  12526. ov-end (match-end 1)
  12527. ov-prefix "")
  12528. (setq ov-start (1- (point-at-eol))
  12529. ov-end (1+ ov-start))
  12530. (skip-chars-forward "^\n\r")
  12531. (setq ov-prefix
  12532. (concat
  12533. (buffer-substring (1- (point)) (point))
  12534. (if (> (current-column) org-tags-column)
  12535. " "
  12536. (make-string (- org-tags-column (current-column)) ?\ ))))))
  12537. (move-overlay org-tags-overlay ov-start ov-end)
  12538. (save-window-excursion
  12539. (if expert
  12540. (set-buffer (get-buffer-create " *Org tags*"))
  12541. (delete-other-windows)
  12542. (split-window-vertically)
  12543. (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
  12544. (erase-buffer)
  12545. (org-set-local 'org-done-keywords done-keywords)
  12546. (org-fast-tag-insert "Inherited" inherited i-face "\n")
  12547. (org-fast-tag-insert "Current" current c-face "\n\n")
  12548. (org-fast-tag-show-exit exit-after-next)
  12549. (org-set-current-tags-overlay current ov-prefix)
  12550. (setq tbl fulltable char ?a cnt 0)
  12551. (while (setq e (pop tbl))
  12552. (cond
  12553. ((equal (car e) :startgroup)
  12554. (push '() groups) (setq ingroup t)
  12555. (when (not (= cnt 0))
  12556. (setq cnt 0)
  12557. (insert "\n"))
  12558. (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
  12559. ((equal (car e) :endgroup)
  12560. (setq ingroup nil cnt 0)
  12561. (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
  12562. ((equal e '(:newline))
  12563. (when (not (= cnt 0))
  12564. (setq cnt 0)
  12565. (insert "\n")
  12566. (setq e (car tbl))
  12567. (while (equal (car tbl) '(:newline))
  12568. (insert "\n")
  12569. (setq tbl (cdr tbl)))))
  12570. (t
  12571. (setq tg (copy-sequence (car e)) c2 nil)
  12572. (if (cdr e)
  12573. (setq c (cdr e))
  12574. ;; automatically assign a character.
  12575. (setq c1 (string-to-char
  12576. (downcase (substring
  12577. tg (if (= (string-to-char tg) ?@) 1 0)))))
  12578. (if (or (rassoc c1 ntable) (rassoc c1 table))
  12579. (while (or (rassoc char ntable) (rassoc char table))
  12580. (setq char (1+ char)))
  12581. (setq c2 c1))
  12582. (setq c (or c2 char)))
  12583. (if ingroup (push tg (car groups)))
  12584. (setq tg (org-add-props tg nil 'face
  12585. (cond
  12586. ((not (assoc tg table))
  12587. (org-get-todo-face tg))
  12588. ((member tg current) c-face)
  12589. ((member tg inherited) i-face)
  12590. (t nil))))
  12591. (if (and (= cnt 0) (not ingroup)) (insert " "))
  12592. (insert "[" c "] " tg (make-string
  12593. (- fwidth 4 (length tg)) ?\ ))
  12594. (push (cons tg c) ntable)
  12595. (when (= (setq cnt (1+ cnt)) ncol)
  12596. (insert "\n")
  12597. (if ingroup (insert " "))
  12598. (setq cnt 0)))))
  12599. (setq ntable (nreverse ntable))
  12600. (insert "\n")
  12601. (goto-char (point-min))
  12602. (if (not expert) (org-fit-window-to-buffer))
  12603. (setq rtn
  12604. (catch 'exit
  12605. (while t
  12606. (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
  12607. (if (not groups) "no " "")
  12608. (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
  12609. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  12610. (setq org-last-tag-selection-key c)
  12611. (cond
  12612. ((= c ?\r) (throw 'exit t))
  12613. ((= c ?!)
  12614. (setq groups (not groups))
  12615. (goto-char (point-min))
  12616. (while (re-search-forward "[{}]" nil t) (replace-match " ")))
  12617. ((= c ?\C-c)
  12618. (if (not expert)
  12619. (org-fast-tag-show-exit
  12620. (setq exit-after-next (not exit-after-next)))
  12621. (setq expert nil)
  12622. (delete-other-windows)
  12623. (set-window-buffer (split-window-vertically) " *Org tags*")
  12624. (org-switch-to-buffer-other-window " *Org tags*")
  12625. (org-fit-window-to-buffer)))
  12626. ((or (= c ?\C-g)
  12627. (and (= c ?q) (not (rassoc c ntable))))
  12628. (org-detach-overlay org-tags-overlay)
  12629. (setq quit-flag t))
  12630. ((= c ?\ )
  12631. (setq current nil)
  12632. (if exit-after-next (setq exit-after-next 'now)))
  12633. ((= c ?\t)
  12634. (condition-case nil
  12635. (setq tg (org-icompleting-read
  12636. "Tag: "
  12637. (or buffer-tags
  12638. (with-current-buffer buf
  12639. (org-get-buffer-tags)))))
  12640. (quit (setq tg "")))
  12641. (when (string-match "\\S-" tg)
  12642. (add-to-list 'buffer-tags (list tg))
  12643. (if (member tg current)
  12644. (setq current (delete tg current))
  12645. (push tg current)))
  12646. (if exit-after-next (setq exit-after-next 'now)))
  12647. ((setq e (rassoc c todo-table) tg (car e))
  12648. (with-current-buffer buf
  12649. (save-excursion (org-todo tg)))
  12650. (if exit-after-next (setq exit-after-next 'now)))
  12651. ((setq e (rassoc c ntable) tg (car e))
  12652. (if (member tg current)
  12653. (setq current (delete tg current))
  12654. (loop for g in groups do
  12655. (if (member tg g)
  12656. (mapc (lambda (x)
  12657. (setq current (delete x current)))
  12658. g)))
  12659. (push tg current))
  12660. (if exit-after-next (setq exit-after-next 'now))))
  12661. ;; Create a sorted list
  12662. (setq current
  12663. (sort current
  12664. (lambda (a b)
  12665. (assoc b (cdr (memq (assoc a ntable) ntable))))))
  12666. (if (eq exit-after-next 'now) (throw 'exit t))
  12667. (goto-char (point-min))
  12668. (beginning-of-line 2)
  12669. (delete-region (point) (point-at-eol))
  12670. (org-fast-tag-insert "Current" current c-face)
  12671. (org-set-current-tags-overlay current ov-prefix)
  12672. (while (re-search-forward
  12673. (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
  12674. (setq tg (match-string 1))
  12675. (add-text-properties
  12676. (match-beginning 1) (match-end 1)
  12677. (list 'face
  12678. (cond
  12679. ((member tg current) c-face)
  12680. ((member tg inherited) i-face)
  12681. (t (get-text-property (match-beginning 1) 'face))))))
  12682. (goto-char (point-min)))))
  12683. (org-detach-overlay org-tags-overlay)
  12684. (if rtn
  12685. (mapconcat 'identity current ":")
  12686. nil))))
  12687. (defun org-get-tags-string ()
  12688. "Get the TAGS string in the current headline."
  12689. (unless (org-at-heading-p t)
  12690. (error "Not on a heading"))
  12691. (save-excursion
  12692. (beginning-of-line 1)
  12693. (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12694. (org-match-string-no-properties 1)
  12695. "")))
  12696. (defun org-get-tags ()
  12697. "Get the list of tags specified in the current headline."
  12698. (org-split-string (org-get-tags-string) ":"))
  12699. (defun org-get-buffer-tags ()
  12700. "Get a table of all tags used in the buffer, for completion."
  12701. (let (tags)
  12702. (save-excursion
  12703. (goto-char (point-min))
  12704. (while (re-search-forward
  12705. (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
  12706. (when (equal (char-after (point-at-bol 0)) ?*)
  12707. (mapc (lambda (x) (add-to-list 'tags x))
  12708. (org-split-string (org-match-string-no-properties 1) ":")))))
  12709. (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
  12710. (mapcar 'list tags)))
  12711. ;;;; The mapping API
  12712. ;;;###autoload
  12713. (defun org-map-entries (func &optional match scope &rest skip)
  12714. "Call FUNC at each headline selected by MATCH in SCOPE.
  12715. FUNC is a function or a lisp form. The function will be called without
  12716. arguments, with the cursor positioned at the beginning of the headline.
  12717. The return values of all calls to the function will be collected and
  12718. returned as a list.
  12719. The call to FUNC will be wrapped into a save-excursion form, so FUNC
  12720. does not need to preserve point. After evaluation, the cursor will be
  12721. moved to the end of the line (presumably of the headline of the
  12722. processed entry) and search continues from there. Under some
  12723. circumstances, this may not produce the wanted results. For example,
  12724. if you have removed (e.g. archived) the current (sub)tree it could
  12725. mean that the next entry will be skipped entirely. In such cases, you
  12726. can specify the position from where search should continue by making
  12727. FUNC set the variable `org-map-continue-from' to the desired buffer
  12728. position.
  12729. MATCH is a tags/property/todo match as it is used in the agenda tags view.
  12730. Only headlines that are matched by this query will be considered during
  12731. the iteration. When MATCH is nil or t, all headlines will be
  12732. visited by the iteration.
  12733. SCOPE determines the scope of this command. It can be any of:
  12734. nil The current buffer, respecting the restriction if any
  12735. tree The subtree started with the entry at point
  12736. region The entries within the active region, if any
  12737. region-start-level
  12738. The entries within the active region, but only those at
  12739. the same level than the first one.
  12740. file The current buffer, without restriction
  12741. file-with-archives
  12742. The current buffer, and any archives associated with it
  12743. agenda All agenda files
  12744. agenda-with-archives
  12745. All agenda files with any archive files associated with them
  12746. \(file1 file2 ...)
  12747. If this is a list, all files in the list will be scanned
  12748. The remaining args are treated as settings for the skipping facilities of
  12749. the scanner. The following items can be given here:
  12750. archive skip trees with the archive tag.
  12751. comment skip trees with the COMMENT keyword
  12752. function or Emacs Lisp form:
  12753. will be used as value for `org-agenda-skip-function', so whenever
  12754. the function returns t, FUNC will not be called for that
  12755. entry and search will continue from the point where the
  12756. function leaves it.
  12757. If your function needs to retrieve the tags including inherited tags
  12758. at the *current* entry, you can use the value of the variable
  12759. `org-scanner-tags' which will be much faster than getting the value
  12760. with `org-get-tags-at'. If your function gets properties with
  12761. `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
  12762. to t around the call to `org-entry-properties' to get the same speedup.
  12763. Note that if your function moves around to retrieve tags and properties at
  12764. a *different* entry, you cannot use these techniques."
  12765. (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
  12766. (not (org-region-active-p)))
  12767. (let* ((org-agenda-archives-mode nil) ; just to make sure
  12768. (org-agenda-skip-archived-trees (memq 'archive skip))
  12769. (org-agenda-skip-comment-trees (memq 'comment skip))
  12770. (org-agenda-skip-function
  12771. (car (org-delete-all '(comment archive) skip)))
  12772. (org-tags-match-list-sublevels t)
  12773. (start-level (eq scope 'region-start-level))
  12774. matcher file res
  12775. org-todo-keywords-for-agenda
  12776. org-done-keywords-for-agenda
  12777. org-todo-keyword-alist-for-agenda
  12778. org-drawers-for-agenda
  12779. org-tag-alist-for-agenda
  12780. todo-only)
  12781. (cond
  12782. ((eq match t) (setq matcher t))
  12783. ((eq match nil) (setq matcher t))
  12784. (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
  12785. (save-excursion
  12786. (save-restriction
  12787. (cond ((eq scope 'tree)
  12788. (org-back-to-heading t)
  12789. (org-narrow-to-subtree)
  12790. (setq scope nil))
  12791. ((and (or (eq scope 'region) (eq scope 'region-start-level))
  12792. (org-region-active-p))
  12793. ;; If needed, set start-level to a string like "2"
  12794. (when start-level
  12795. (save-excursion
  12796. (goto-char (region-beginning))
  12797. (unless (org-at-heading-p) (outline-next-heading))
  12798. (setq start-level (org-current-level))))
  12799. (narrow-to-region (region-beginning)
  12800. (save-excursion
  12801. (goto-char (region-end))
  12802. (unless (and (bolp) (org-at-heading-p))
  12803. (outline-next-heading))
  12804. (point)))
  12805. (setq scope nil)))
  12806. (if (not scope)
  12807. (progn
  12808. (org-prepare-agenda-buffers
  12809. (list (buffer-file-name (current-buffer))))
  12810. (setq res (org-scan-tags func matcher todo-only start-level)))
  12811. ;; Get the right scope
  12812. (cond
  12813. ((and scope (listp scope) (symbolp (car scope)))
  12814. (setq scope (eval scope)))
  12815. ((eq scope 'agenda)
  12816. (setq scope (org-agenda-files t)))
  12817. ((eq scope 'agenda-with-archives)
  12818. (setq scope (org-agenda-files t))
  12819. (setq scope (org-add-archive-files scope)))
  12820. ((eq scope 'file)
  12821. (setq scope (list (buffer-file-name))))
  12822. ((eq scope 'file-with-archives)
  12823. (setq scope (org-add-archive-files (list (buffer-file-name))))))
  12824. (org-prepare-agenda-buffers scope)
  12825. (while (setq file (pop scope))
  12826. (with-current-buffer (org-find-base-buffer-visiting file)
  12827. (save-excursion
  12828. (save-restriction
  12829. (widen)
  12830. (goto-char (point-min))
  12831. (setq res (append res (org-scan-tags func matcher todo-only))))))))))
  12832. res)))
  12833. ;;;; Properties
  12834. ;;; Setting and retrieving properties
  12835. (defconst org-special-properties
  12836. '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
  12837. "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
  12838. "The special properties valid in Org-mode.
  12839. These are properties that are not defined in the property drawer,
  12840. but in some other way.")
  12841. (defconst org-default-properties
  12842. '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
  12843. "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
  12844. "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
  12845. "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
  12846. "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
  12847. "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
  12848. "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
  12849. "Some properties that are used by Org-mode for various purposes.
  12850. Being in this list makes sure that they are offered for completion.")
  12851. (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
  12852. "Regular expression matching the first line of a property drawer.")
  12853. (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
  12854. "Regular expression matching the last line of a property drawer.")
  12855. (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
  12856. "Regular expression matching the first line of a property drawer.")
  12857. (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
  12858. "Regular expression matching the first line of a property drawer.")
  12859. (defconst org-property-drawer-re
  12860. (concat "\\(" org-property-start-re "\\)[^\000]*\\("
  12861. org-property-end-re "\\)\n?")
  12862. "Matches an entire property drawer.")
  12863. (defconst org-clock-drawer-re
  12864. (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
  12865. org-property-end-re "\\)\n?")
  12866. "Matches an entire clock drawer.")
  12867. (defsubst org-re-property (property)
  12868. "Return a regexp matching PROPERTY.
  12869. Match group 1 will be set to the value "
  12870. (concat "^[ \t]*:" (regexp-quote property) ":[ \t]*\\(\\S-.*\\)"))
  12871. (defun org-property-action ()
  12872. "Do an action on properties."
  12873. (interactive)
  12874. (let (c)
  12875. (org-at-property-p)
  12876. (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
  12877. (setq c (read-char-exclusive))
  12878. (cond
  12879. ((equal c ?s)
  12880. (call-interactively 'org-set-property))
  12881. ((equal c ?d)
  12882. (call-interactively 'org-delete-property))
  12883. ((equal c ?D)
  12884. (call-interactively 'org-delete-property-globally))
  12885. ((equal c ?c)
  12886. (call-interactively 'org-compute-property-at-point))
  12887. (t (error "No such property action %c" c)))))
  12888. (defun org-set-effort (&optional value)
  12889. "Set the effort property of the current entry.
  12890. With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
  12891. allowed value."
  12892. (interactive "P")
  12893. (if (equal value 0) (setq value 10))
  12894. (let* ((completion-ignore-case t)
  12895. (prop org-effort-property)
  12896. (cur (org-entry-get nil prop))
  12897. (allowed (org-property-get-allowed-values nil prop 'table))
  12898. (existing (mapcar 'list (org-property-values prop)))
  12899. rpl
  12900. (val (cond
  12901. ((stringp value) value)
  12902. ((and allowed (integerp value))
  12903. (or (car (nth (1- value) allowed))
  12904. (car (org-last allowed))))
  12905. (allowed
  12906. (message "Select 1-9,0, [RET%s]: %s"
  12907. (if cur (concat "=" cur) "")
  12908. (mapconcat 'car allowed " "))
  12909. (setq rpl (read-char-exclusive))
  12910. (if (equal rpl ?\r)
  12911. cur
  12912. (setq rpl (- rpl ?0))
  12913. (if (equal rpl 0) (setq rpl 10))
  12914. (if (and (> rpl 0) (<= rpl (length allowed)))
  12915. (car (nth (1- rpl) allowed))
  12916. (org-completing-read "Effort: " allowed nil))))
  12917. (t
  12918. (let (org-completion-use-ido org-completion-use-iswitchb)
  12919. (org-completing-read
  12920. (concat "Effort " (if (and cur (string-match "\\S-" cur))
  12921. (concat "[" cur "]") "")
  12922. ": ")
  12923. existing nil nil "" nil cur))))))
  12924. (unless (equal (org-entry-get nil prop) val)
  12925. (org-entry-put nil prop val))
  12926. (message "%s is now %s" prop val)))
  12927. (defun org-at-property-p ()
  12928. "Is cursor inside a property drawer?"
  12929. (save-excursion
  12930. (beginning-of-line 1)
  12931. (when (looking-at (org-re "^[ \t]*\\(:\\([[:alpha:]][[:alnum:]_-]*\\):\\)[ \t]*\\(.*\\)"))
  12932. (save-match-data ;; Used by calling procedures
  12933. (let ((p (point))
  12934. (range (unless (org-before-first-heading-p)
  12935. (org-get-property-block))))
  12936. (and range (<= (car range) p) (< p (cdr range))))))))
  12937. (defun org-get-property-block (&optional beg end force)
  12938. "Return the (beg . end) range of the body of the property drawer.
  12939. BEG and END can be beginning and end of subtree, if not given
  12940. they will be found.
  12941. If the drawer does not exist and FORCE is non-nil, create the drawer."
  12942. (catch 'exit
  12943. (save-excursion
  12944. (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
  12945. (end (or end (progn (outline-next-heading) (point)))))
  12946. (goto-char beg)
  12947. (if (re-search-forward org-property-start-re end t)
  12948. (setq beg (1+ (match-end 0)))
  12949. (if force
  12950. (save-excursion
  12951. (org-insert-property-drawer)
  12952. (setq end (progn (outline-next-heading) (point))))
  12953. (throw 'exit nil))
  12954. (goto-char beg)
  12955. (if (re-search-forward org-property-start-re end t)
  12956. (setq beg (1+ (match-end 0)))))
  12957. (if (re-search-forward org-property-end-re end t)
  12958. (setq end (match-beginning 0))
  12959. (or force (throw 'exit nil))
  12960. (goto-char beg)
  12961. (setq end beg)
  12962. (org-indent-line)
  12963. (insert ":END:\n"))
  12964. (cons beg end)))))
  12965. (defun org-entry-properties (&optional pom which specific)
  12966. "Get all properties of the entry at point-or-marker POM.
  12967. This includes the TODO keyword, the tags, time strings for deadline,
  12968. scheduled, and clocking, and any additional properties defined in the
  12969. entry. The return value is an alist, keys may occur multiple times
  12970. if the property key was used several times.
  12971. POM may also be nil, in which case the current entry is used.
  12972. If WHICH is nil or `all', get all properties. If WHICH is
  12973. `special' or `standard', only get that subclass. If WHICH
  12974. is a string only get exactly this property. SPECIFIC can be a string, the
  12975. specific property we are interested in. Specifying it can speed
  12976. things up because then unnecessary parsing is avoided."
  12977. (setq which (or which 'all))
  12978. (org-with-point-at pom
  12979. (let ((clockstr (substring org-clock-string 0 -1))
  12980. (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
  12981. (case-fold-search nil)
  12982. beg end range props sum-props key key1 value string clocksum)
  12983. (save-excursion
  12984. (when (condition-case nil
  12985. (and (derived-mode-p 'org-mode) (org-back-to-heading t))
  12986. (error nil))
  12987. (setq beg (point))
  12988. (setq sum-props (get-text-property (point) 'org-summaries))
  12989. (setq clocksum (get-text-property (point) :org-clock-minutes))
  12990. (outline-next-heading)
  12991. (setq end (point))
  12992. (when (memq which '(all special))
  12993. ;; Get the special properties, like TODO and tags
  12994. (goto-char beg)
  12995. (when (and (or (not specific) (string= specific "TODO"))
  12996. (looking-at org-todo-line-regexp) (match-end 2))
  12997. (push (cons "TODO" (org-match-string-no-properties 2)) props))
  12998. (when (and (or (not specific) (string= specific "PRIORITY"))
  12999. (looking-at org-priority-regexp))
  13000. (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
  13001. (when (or (not specific) (string= specific "FILE"))
  13002. (push (cons "FILE" buffer-file-name) props))
  13003. (when (and (or (not specific) (string= specific "TAGS"))
  13004. (setq value (org-get-tags-string))
  13005. (string-match "\\S-" value))
  13006. (push (cons "TAGS" value) props))
  13007. (when (and (or (not specific) (string= specific "ALLTAGS"))
  13008. (setq value (org-get-tags-at)))
  13009. (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
  13010. ":"))
  13011. props))
  13012. (when (or (not specific) (string= specific "BLOCKED"))
  13013. (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
  13014. (when (or (not specific)
  13015. (member specific
  13016. '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
  13017. "TIMESTAMP" "TIMESTAMP_IA")))
  13018. (catch 'match
  13019. (while (re-search-forward org-maybe-keyword-time-regexp end t)
  13020. (setq key (if (match-end 1)
  13021. (substring (org-match-string-no-properties 1)
  13022. 0 -1))
  13023. string (if (equal key clockstr)
  13024. (org-no-properties
  13025. (org-trim
  13026. (buffer-substring
  13027. (match-beginning 3) (goto-char
  13028. (point-at-eol)))))
  13029. (substring (org-match-string-no-properties 3)
  13030. 1 -1)))
  13031. ;; Get the correct property name from the key. This is
  13032. ;; necessary if the user has configured time keywords.
  13033. (setq key1 (concat key ":"))
  13034. (cond
  13035. ((not key)
  13036. (setq key
  13037. (if (= (char-after (match-beginning 3)) ?\[)
  13038. "TIMESTAMP_IA" "TIMESTAMP")))
  13039. ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
  13040. ((equal key1 org-deadline-string) (setq key "DEADLINE"))
  13041. ((equal key1 org-closed-string) (setq key "CLOSED"))
  13042. ((equal key1 org-clock-string) (setq key "CLOCK")))
  13043. (if (and specific (equal key specific) (not (equal key "CLOCK")))
  13044. (progn
  13045. (push (cons key string) props)
  13046. ;; no need to search further if match is found
  13047. (throw 'match t))
  13048. (when (or (equal key "CLOCK") (not (assoc key props)))
  13049. (push (cons key string) props))))))
  13050. )
  13051. (when (memq which '(all standard))
  13052. ;; Get the standard properties, like :PROP: ...
  13053. (setq range (org-get-property-block beg end))
  13054. (when range
  13055. (goto-char (car range))
  13056. (while (re-search-forward
  13057. (org-re "^[ \t]*:\\([[:alpha:]][[:alnum:]_-]*\\):[ \t]*\\(\\S-.*\\)?")
  13058. (cdr range) t)
  13059. (setq key (org-match-string-no-properties 1)
  13060. value (org-trim (or (org-match-string-no-properties 2) "")))
  13061. (unless (member key excluded)
  13062. (push (cons key (or value "")) props)))))
  13063. (if clocksum
  13064. (push (cons "CLOCKSUM"
  13065. (org-columns-number-to-string (/ (float clocksum) 60.)
  13066. 'add_times))
  13067. props))
  13068. (unless (assoc "CATEGORY" props)
  13069. (push (cons "CATEGORY" (org-get-category)) props))
  13070. (append sum-props (nreverse props)))))))
  13071. (defun org-entry-get (pom property &optional inherit literal-nil)
  13072. "Get value of PROPERTY for entry at point-or-marker POM.
  13073. If INHERIT is non-nil and the entry does not have the property,
  13074. then also check higher levels of the hierarchy.
  13075. If INHERIT is the symbol `selective', use inheritance only if the setting
  13076. in `org-use-property-inheritance' selects PROPERTY for inheritance.
  13077. If the property is present but empty, the return value is the empty string.
  13078. If the property is not present at all, nil is returned.
  13079. If LITERAL-NIL is set, return the string value \"nil\" as a string,
  13080. do not interpret it as the list atom nil. This is used for inheritance
  13081. when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
  13082. (org-with-point-at pom
  13083. (if (and inherit (if (eq inherit 'selective)
  13084. (org-property-inherit-p property)
  13085. t))
  13086. (org-entry-get-with-inheritance property literal-nil)
  13087. (if (member property org-special-properties)
  13088. ;; We need a special property. Use `org-entry-properties' to
  13089. ;; retrieve it, but specify the wanted property
  13090. (cdr (assoc property (org-entry-properties nil 'special property)))
  13091. (let ((range (unless (org-before-first-heading-p)
  13092. (org-get-property-block)))
  13093. (props (list (or (assoc property org-file-properties)
  13094. (assoc property org-global-properties)
  13095. (assoc property org-global-properties-fixed))))
  13096. val)
  13097. (flet ((ap (key)
  13098. (when (re-search-forward
  13099. (org-re-property key) (cdr range) t)
  13100. (setq props
  13101. (org-update-property-plist
  13102. key
  13103. (if (match-end 1)
  13104. (org-match-string-no-properties 1) "")
  13105. props)))))
  13106. (when (and range (goto-char (car range)))
  13107. (ap property)
  13108. (goto-char (car range))
  13109. (while (ap (concat property "+")))
  13110. (setq val (cdr (assoc property props)))
  13111. (when val (if literal-nil val (org-not-nil val))))))))))
  13112. (defun org-property-or-variable-value (var &optional inherit)
  13113. "Check if there is a property fixing the value of VAR.
  13114. If yes, return this value. If not, return the current value of the variable."
  13115. (let ((prop (org-entry-get nil (symbol-name var) inherit)))
  13116. (if (and prop (stringp prop) (string-match "\\S-" prop))
  13117. (read prop)
  13118. (symbol-value var))))
  13119. (defun org-entry-delete (pom property)
  13120. "Delete the property PROPERTY from entry at point-or-marker POM."
  13121. (org-with-point-at pom
  13122. (if (member property org-special-properties)
  13123. nil ; cannot delete these properties.
  13124. (let ((range (org-get-property-block)))
  13125. (if (and range
  13126. (goto-char (car range))
  13127. (re-search-forward
  13128. (org-re-property property)
  13129. (cdr range) t))
  13130. (progn
  13131. (delete-region (match-beginning 0) (1+ (point-at-eol)))
  13132. t)
  13133. nil)))))
  13134. ;; Multi-values properties are properties that contain multiple values
  13135. ;; These values are assumed to be single words, separated by whitespace.
  13136. (defun org-entry-add-to-multivalued-property (pom property value)
  13137. "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
  13138. (let* ((old (org-entry-get pom property))
  13139. (values (and old (org-split-string old "[ \t]"))))
  13140. (setq value (org-entry-protect-space value))
  13141. (unless (member value values)
  13142. (setq values (cons value values))
  13143. (org-entry-put pom property
  13144. (mapconcat 'identity values " ")))))
  13145. (defun org-entry-remove-from-multivalued-property (pom property value)
  13146. "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
  13147. (let* ((old (org-entry-get pom property))
  13148. (values (and old (org-split-string old "[ \t]"))))
  13149. (setq value (org-entry-protect-space value))
  13150. (when (member value values)
  13151. (setq values (delete value values))
  13152. (org-entry-put pom property
  13153. (mapconcat 'identity values " ")))))
  13154. (defun org-entry-member-in-multivalued-property (pom property value)
  13155. "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
  13156. (let* ((old (org-entry-get pom property))
  13157. (values (and old (org-split-string old "[ \t]"))))
  13158. (setq value (org-entry-protect-space value))
  13159. (member value values)))
  13160. (defun org-entry-get-multivalued-property (pom property)
  13161. "Return a list of values in a multivalued property."
  13162. (let* ((value (org-entry-get pom property))
  13163. (values (and value (org-split-string value "[ \t]"))))
  13164. (mapcar 'org-entry-restore-space values)))
  13165. (defun org-entry-put-multivalued-property (pom property &rest values)
  13166. "Set multivalued PROPERTY at point-or-marker POM to VALUES.
  13167. VALUES should be a list of strings. Spaces will be protected."
  13168. (org-entry-put pom property
  13169. (mapconcat 'org-entry-protect-space values " "))
  13170. (let* ((value (org-entry-get pom property))
  13171. (values (and value (org-split-string value "[ \t]"))))
  13172. (mapcar 'org-entry-restore-space values)))
  13173. (defun org-entry-protect-space (s)
  13174. "Protect spaces and newline in string S."
  13175. (while (string-match " " s)
  13176. (setq s (replace-match "%20" t t s)))
  13177. (while (string-match "\n" s)
  13178. (setq s (replace-match "%0A" t t s)))
  13179. s)
  13180. (defun org-entry-restore-space (s)
  13181. "Restore spaces and newline in string S."
  13182. (while (string-match "%20" s)
  13183. (setq s (replace-match " " t t s)))
  13184. (while (string-match "%0A" s)
  13185. (setq s (replace-match "\n" t t s)))
  13186. s)
  13187. (defvar org-entry-property-inherited-from (make-marker)
  13188. "Marker pointing to the entry from where a property was inherited.
  13189. Each call to `org-entry-get-with-inheritance' will set this marker to the
  13190. location of the entry where the inheritance search matched. If there was
  13191. no match, the marker will point nowhere.
  13192. Note that also `org-entry-get' calls this function, if the INHERIT flag
  13193. is set.")
  13194. (defun org-entry-get-with-inheritance (property &optional literal-nil)
  13195. "Get entry property, and search higher levels if not present.
  13196. The search will stop at the first ancestor which has the property defined.
  13197. If the value found is \"nil\", return nil to show that the property
  13198. should be considered as undefined (this is the meaning of nil here).
  13199. However, if LITERAL-NIL is set, return the string value \"nil\" instead."
  13200. (move-marker org-entry-property-inherited-from nil)
  13201. (let (tmp)
  13202. (unless (org-before-first-heading-p)
  13203. (save-excursion
  13204. (save-restriction
  13205. (widen)
  13206. (catch 'ex
  13207. (while t
  13208. (when (setq tmp (org-entry-get nil property nil 'literal-nil))
  13209. (org-back-to-heading t)
  13210. (move-marker org-entry-property-inherited-from (point))
  13211. (throw 'ex tmp))
  13212. (or (org-up-heading-safe) (throw 'ex nil)))))))
  13213. (setq tmp (or tmp
  13214. (cdr (assoc property org-file-properties))
  13215. (cdr (assoc property org-global-properties))
  13216. (cdr (assoc property org-global-properties-fixed))))
  13217. (if literal-nil tmp (org-not-nil tmp))))
  13218. (defvar org-property-changed-functions nil
  13219. "Hook called when the value of a property has changed.
  13220. Each hook function should accept two arguments, the name of the property
  13221. and the new value.")
  13222. (defun org-entry-put (pom property value)
  13223. "Set PROPERTY to VALUE for entry at point-or-marker POM."
  13224. (org-with-point-at pom
  13225. (org-back-to-heading t)
  13226. (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
  13227. range)
  13228. (cond
  13229. ((equal property "TODO")
  13230. (when (and (stringp value) (string-match "\\S-" value)
  13231. (not (member value org-todo-keywords-1)))
  13232. (error "\"%s\" is not a valid TODO state" value))
  13233. (if (or (not value)
  13234. (not (string-match "\\S-" value)))
  13235. (setq value 'none))
  13236. (org-todo value)
  13237. (org-set-tags nil 'align))
  13238. ((equal property "PRIORITY")
  13239. (org-priority (if (and value (stringp value) (string-match "\\S-" value))
  13240. (string-to-char value) ?\ ))
  13241. (org-set-tags nil 'align))
  13242. ((equal property "SCHEDULED")
  13243. (if (re-search-forward org-scheduled-time-regexp end t)
  13244. (cond
  13245. ((eq value 'earlier) (org-timestamp-change -1 'day))
  13246. ((eq value 'later) (org-timestamp-change 1 'day))
  13247. (t (call-interactively 'org-schedule)))
  13248. (call-interactively 'org-schedule)))
  13249. ((equal property "DEADLINE")
  13250. (if (re-search-forward org-deadline-time-regexp end t)
  13251. (cond
  13252. ((eq value 'earlier) (org-timestamp-change -1 'day))
  13253. ((eq value 'later) (org-timestamp-change 1 'day))
  13254. (t (call-interactively 'org-deadline)))
  13255. (call-interactively 'org-deadline)))
  13256. ((member property org-special-properties)
  13257. (error "The %s property can not yet be set with `org-entry-put'"
  13258. property))
  13259. (t ; a non-special property
  13260. (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
  13261. (setq range (org-get-property-block beg end 'force))
  13262. (goto-char (car range))
  13263. (if (re-search-forward
  13264. (org-re-property property) (cdr range) t)
  13265. (progn
  13266. (delete-region (match-beginning 0) (match-end 0))
  13267. (goto-char (match-beginning 0)))
  13268. (goto-char (cdr range))
  13269. (insert "\n")
  13270. (backward-char 1)
  13271. (org-indent-line))
  13272. (insert ":" property ":")
  13273. (and value (insert " " value))
  13274. (org-indent-line)))))
  13275. (run-hook-with-args 'org-property-changed-functions property value)))
  13276. (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
  13277. "Get all property keys in the current buffer.
  13278. With INCLUDE-SPECIALS, also list the special properties that reflect things
  13279. like tags and TODO state.
  13280. With INCLUDE-DEFAULTS, also include properties that has special meaning
  13281. internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
  13282. and others.
  13283. With INCLUDE-COLUMNS, also include property names given in COLUMN
  13284. formats in the current buffer."
  13285. (let (rtn range cfmt s p)
  13286. (save-excursion
  13287. (save-restriction
  13288. (widen)
  13289. (goto-char (point-min))
  13290. (while (re-search-forward org-property-start-re nil t)
  13291. (setq range (org-get-property-block))
  13292. (goto-char (car range))
  13293. (while (re-search-forward
  13294. (org-re "^[ \t]*:\\([-[:alnum:]_]+\\):")
  13295. (cdr range) t)
  13296. (add-to-list 'rtn (org-match-string-no-properties 1)))
  13297. (outline-next-heading))))
  13298. (when include-specials
  13299. (setq rtn (append org-special-properties rtn)))
  13300. (when include-defaults
  13301. (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
  13302. (add-to-list 'rtn org-effort-property))
  13303. (when include-columns
  13304. (save-excursion
  13305. (save-restriction
  13306. (widen)
  13307. (goto-char (point-min))
  13308. (while (re-search-forward
  13309. "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
  13310. nil t)
  13311. (setq cfmt (match-string 2) s 0)
  13312. (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
  13313. cfmt s)
  13314. (setq s (match-end 0)
  13315. p (match-string 1 cfmt))
  13316. (unless (or (equal p "ITEM")
  13317. (member p org-special-properties))
  13318. (add-to-list 'rtn (match-string 1 cfmt))))))))
  13319. (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
  13320. (defun org-property-values (key)
  13321. "Return a list of all values of property KEY in the current buffer."
  13322. (save-excursion
  13323. (save-restriction
  13324. (widen)
  13325. (goto-char (point-min))
  13326. (let ((re (org-re-property key))
  13327. values)
  13328. (while (re-search-forward re nil t)
  13329. (add-to-list 'values (org-trim (match-string 1))))
  13330. (delete "" values)))))
  13331. (defun org-insert-property-drawer ()
  13332. "Insert a property drawer into the current entry."
  13333. (org-back-to-heading t)
  13334. (looking-at org-outline-regexp)
  13335. (let ((indent (if org-adapt-indentation
  13336. (- (match-end 0) (match-beginning 0))
  13337. 0))
  13338. (beg (point))
  13339. (re (concat "^[ \t]*" org-keyword-time-regexp))
  13340. end hiddenp)
  13341. (outline-next-heading)
  13342. (setq end (point))
  13343. (goto-char beg)
  13344. (while (re-search-forward re end t))
  13345. (setq hiddenp (outline-invisible-p))
  13346. (end-of-line 1)
  13347. (and (equal (char-after) ?\n) (forward-char 1))
  13348. (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
  13349. (if (member (match-string 1) '("CLOCK:" ":END:"))
  13350. ;; just skip this line
  13351. (beginning-of-line 2)
  13352. ;; Drawer start, find the end
  13353. (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
  13354. (beginning-of-line 1)))
  13355. (org-skip-over-state-notes)
  13356. (skip-chars-backward " \t\n\r")
  13357. (if (eq (char-before) ?*) (forward-char 1))
  13358. (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
  13359. (beginning-of-line 0)
  13360. (org-indent-to-column indent)
  13361. (beginning-of-line 2)
  13362. (org-indent-to-column indent)
  13363. (beginning-of-line 0)
  13364. (if hiddenp
  13365. (save-excursion
  13366. (org-back-to-heading t)
  13367. (hide-entry))
  13368. (org-flag-drawer t))))
  13369. (defun org-insert-drawer (&optional arg drawer)
  13370. "Insert a drawer at point.
  13371. Optional argument DRAWER, when non-nil, is a string representing
  13372. drawer's name. Otherwise, the user is prompted for a name.
  13373. If a region is active, insert the drawer around that region
  13374. instead.
  13375. Point is left between drawer's boundaries."
  13376. (interactive "P")
  13377. (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
  13378. "LOGBOOK"))
  13379. ;; SYSTEM-DRAWERS is a list of drawer names that are used
  13380. ;; internally by Org. They are meant to be inserted
  13381. ;; automatically.
  13382. (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
  13383. ;; Remove system drawers from list. Note: For some reason,
  13384. ;; `org-completing-read' ignores the predicate while
  13385. ;; `completing-read' handles it fine.
  13386. (drawer (if arg "PROPERTIES"
  13387. (or drawer
  13388. (completing-read
  13389. "Drawer: " org-drawers
  13390. (lambda (d) (not (member d system-drawers))))))))
  13391. (cond
  13392. ;; With C-u, fall back on `org-insert-property-drawer'
  13393. (arg (org-insert-property-drawer))
  13394. ;; With an active region, insert a drawer at point.
  13395. ((not (org-region-active-p))
  13396. (progn
  13397. (unless (bolp) (insert "\n"))
  13398. (insert (format ":%s:\n\n:END:\n" drawer))
  13399. (forward-line -2)))
  13400. ;; Otherwise, insert the drawer at point
  13401. (t
  13402. (let ((rbeg (region-beginning))
  13403. (rend (copy-marker (region-end))))
  13404. (unwind-protect
  13405. (progn
  13406. (goto-char rbeg)
  13407. (beginning-of-line)
  13408. (when (save-excursion
  13409. (re-search-forward org-outline-regexp-bol rend t))
  13410. (error "Drawers cannot contain headlines"))
  13411. ;; Position point at the beginning of the first
  13412. ;; non-blank line in region. Insert drawer's opening
  13413. ;; there, then indent it.
  13414. (org-skip-whitespace)
  13415. (beginning-of-line)
  13416. (insert ":" drawer ":\n")
  13417. (forward-line -1)
  13418. (indent-for-tab-command)
  13419. ;; Move point to the beginning of the first blank line
  13420. ;; after the last non-blank line in region. Insert
  13421. ;; drawer's closing, then indent it.
  13422. (goto-char rend)
  13423. (skip-chars-backward " \r\t\n")
  13424. (insert "\n:END:")
  13425. (indent-for-tab-command)
  13426. (unless (eolp) (insert "\n")))
  13427. ;; Clear marker, whatever the outcome of insertion is.
  13428. (set-marker rend nil)))))))
  13429. (defvar org-property-set-functions-alist nil
  13430. "Property set function alist.
  13431. Each entry should have the following format:
  13432. (PROPERTY . READ-FUNCTION)
  13433. The read function will be called with the same argument as
  13434. `org-completing-read'.")
  13435. (defun org-set-property-function (property)
  13436. "Get the function that should be used to set PROPERTY.
  13437. This is computed according to `org-property-set-functions-alist'."
  13438. (or (cdr (assoc property org-property-set-functions-alist))
  13439. 'org-completing-read))
  13440. (defun org-read-property-value (property)
  13441. "Read PROPERTY value from user."
  13442. (let* ((completion-ignore-case t)
  13443. (allowed (org-property-get-allowed-values nil property 'table))
  13444. (cur (org-entry-get nil property))
  13445. (prompt (concat property " value"
  13446. (if (and cur (string-match "\\S-" cur))
  13447. (concat " [" cur "]") "") ": "))
  13448. (set-function (org-set-property-function property))
  13449. (val (if allowed
  13450. (funcall set-function prompt allowed nil
  13451. (not (get-text-property 0 'org-unrestricted
  13452. (caar allowed))))
  13453. (let (org-completion-use-ido org-completion-use-iswitchb)
  13454. (funcall set-function prompt
  13455. (mapcar 'list (org-property-values property))
  13456. nil nil "" nil cur)))))
  13457. (if (equal val "")
  13458. cur
  13459. val)))
  13460. (defvar org-last-set-property nil)
  13461. (defun org-read-property-name ()
  13462. "Read a property name."
  13463. (let* ((completion-ignore-case t)
  13464. (keys (org-buffer-property-keys nil t t))
  13465. (default-prop (or (save-excursion
  13466. (save-match-data
  13467. (beginning-of-line)
  13468. (and (looking-at "^\\s-*:\\([^:\n]+\\):")
  13469. (null (string= (match-string 1) "END"))
  13470. (match-string 1))))
  13471. org-last-set-property))
  13472. (property (org-icompleting-read
  13473. (concat "Property"
  13474. (if default-prop (concat " [" default-prop "]") "")
  13475. ": ")
  13476. (mapcar 'list keys)
  13477. nil nil nil nil
  13478. default-prop
  13479. )))
  13480. (if (member property keys)
  13481. property
  13482. (or (cdr (assoc (downcase property)
  13483. (mapcar (lambda (x) (cons (downcase x) x))
  13484. keys)))
  13485. property))))
  13486. (defun org-set-property (property value)
  13487. "In the current entry, set PROPERTY to VALUE.
  13488. When called interactively, this will prompt for a property name, offering
  13489. completion on existing and default properties. And then it will prompt
  13490. for a value, offering completion either on allowed values (via an inherited
  13491. xxx_ALL property) or on existing values in other instances of this property
  13492. in the current file."
  13493. (interactive (list nil nil))
  13494. (let* ((property (or property (org-read-property-name)))
  13495. (value (or value (org-read-property-value property)))
  13496. (fn (cdr (assoc property org-properties-postprocess-alist))))
  13497. (setq org-last-set-property property)
  13498. ;; Possibly postprocess the inserted value:
  13499. (when fn (setq value (funcall fn value)))
  13500. (unless (equal (org-entry-get nil property) value)
  13501. (org-entry-put nil property value))))
  13502. (defun org-delete-property (property)
  13503. "In the current entry, delete PROPERTY."
  13504. (interactive
  13505. (let* ((completion-ignore-case t)
  13506. (prop (org-icompleting-read "Property: "
  13507. (org-entry-properties nil 'standard))))
  13508. (list prop)))
  13509. (message "Property %s %s" property
  13510. (if (org-entry-delete nil property)
  13511. "deleted"
  13512. "was not present in the entry")))
  13513. (defun org-delete-property-globally (property)
  13514. "Remove PROPERTY globally, from all entries."
  13515. (interactive
  13516. (let* ((completion-ignore-case t)
  13517. (prop (org-icompleting-read
  13518. "Globally remove property: "
  13519. (mapcar 'list (org-buffer-property-keys)))))
  13520. (list prop)))
  13521. (save-excursion
  13522. (save-restriction
  13523. (widen)
  13524. (goto-char (point-min))
  13525. (let ((cnt 0))
  13526. (while (re-search-forward
  13527. (org-re-property property)
  13528. nil t)
  13529. (setq cnt (1+ cnt))
  13530. (delete-region (match-beginning 0) (1+ (point-at-eol))))
  13531. (message "Property \"%s\" removed from %d entries" property cnt)))))
  13532. (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
  13533. (defun org-compute-property-at-point ()
  13534. "Compute the property at point.
  13535. This looks for an enclosing column format, extracts the operator and
  13536. then applies it to the property in the column format's scope."
  13537. (interactive)
  13538. (unless (org-at-property-p)
  13539. (error "Not at a property"))
  13540. (let ((prop (org-match-string-no-properties 2)))
  13541. (org-columns-get-format-and-top-level)
  13542. (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
  13543. (error "No operator defined for property %s" prop))
  13544. (org-columns-compute prop)))
  13545. (defvar org-property-allowed-value-functions nil
  13546. "Hook for functions supplying allowed values for a specific property.
  13547. The functions must take a single argument, the name of the property, and
  13548. return a flat list of allowed values. If \":ETC\" is one of
  13549. the values, this means that these values are intended as defaults for
  13550. completion, but that other values should be allowed too.
  13551. The functions must return nil if they are not responsible for this
  13552. property.")
  13553. (defun org-property-get-allowed-values (pom property &optional table)
  13554. "Get allowed values for the property PROPERTY.
  13555. When TABLE is non-nil, return an alist that can directly be used for
  13556. completion."
  13557. (let (vals)
  13558. (cond
  13559. ((equal property "TODO")
  13560. (setq vals (org-with-point-at pom
  13561. (append org-todo-keywords-1 '("")))))
  13562. ((equal property "PRIORITY")
  13563. (let ((n org-lowest-priority))
  13564. (while (>= n org-highest-priority)
  13565. (push (char-to-string n) vals)
  13566. (setq n (1- n)))))
  13567. ((member property org-special-properties))
  13568. ((setq vals (run-hook-with-args-until-success
  13569. 'org-property-allowed-value-functions property)))
  13570. (t
  13571. (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
  13572. (when (and vals (string-match "\\S-" vals))
  13573. (setq vals (car (read-from-string (concat "(" vals ")"))))
  13574. (setq vals (mapcar (lambda (x)
  13575. (cond ((stringp x) x)
  13576. ((numberp x) (number-to-string x))
  13577. ((symbolp x) (symbol-name x))
  13578. (t "???")))
  13579. vals)))))
  13580. (when (member ":ETC" vals)
  13581. (setq vals (remove ":ETC" vals))
  13582. (org-add-props (car vals) '(org-unrestricted t)))
  13583. (if table (mapcar 'list vals) vals)))
  13584. (defun org-property-previous-allowed-value (&optional previous)
  13585. "Switch to the next allowed value for this property."
  13586. (interactive)
  13587. (org-property-next-allowed-value t))
  13588. (defun org-property-next-allowed-value (&optional previous)
  13589. "Switch to the next allowed value for this property."
  13590. (interactive)
  13591. (unless (org-at-property-p)
  13592. (error "Not at a property"))
  13593. (let* ((key (match-string 2))
  13594. (value (match-string 3))
  13595. (allowed (or (org-property-get-allowed-values (point) key)
  13596. (and (member value '("[ ]" "[-]" "[X]"))
  13597. '("[ ]" "[X]"))))
  13598. nval)
  13599. (unless allowed
  13600. (error "Allowed values for this property have not been defined"))
  13601. (if previous (setq allowed (reverse allowed)))
  13602. (if (member value allowed)
  13603. (setq nval (car (cdr (member value allowed)))))
  13604. (setq nval (or nval (car allowed)))
  13605. (if (equal nval value)
  13606. (error "Only one allowed value for this property"))
  13607. (org-at-property-p)
  13608. (replace-match (concat " :" key ": " nval) t t)
  13609. (org-indent-line)
  13610. (beginning-of-line 1)
  13611. (skip-chars-forward " \t")
  13612. (run-hook-with-args 'org-property-changed-functions key nval)))
  13613. (defun org-find-olp (path &optional this-buffer)
  13614. "Return a marker pointing to the entry at outline path OLP.
  13615. If anything goes wrong, throw an error.
  13616. You can wrap this call to catch the error like this:
  13617. (condition-case msg
  13618. (org-mobile-locate-entry (match-string 4))
  13619. (error (nth 1 msg)))
  13620. The return value will then be either a string with the error message,
  13621. or a marker if everything is OK.
  13622. If THIS-BUFFER is set, the outline path does not contain a file,
  13623. only headings."
  13624. (let* ((file (if this-buffer buffer-file-name (pop path)))
  13625. (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
  13626. (level 1)
  13627. (lmin 1)
  13628. (lmax 1)
  13629. limit re end found pos heading cnt flevel)
  13630. (unless buffer (error "File not found :%s" file))
  13631. (with-current-buffer buffer
  13632. (save-excursion
  13633. (save-restriction
  13634. (widen)
  13635. (setq limit (point-max))
  13636. (goto-char (point-min))
  13637. (while (setq heading (pop path))
  13638. (setq re (format org-complex-heading-regexp-format
  13639. (regexp-quote heading)))
  13640. (setq cnt 0 pos (point))
  13641. (while (re-search-forward re end t)
  13642. (setq level (- (match-end 1) (match-beginning 1)))
  13643. (if (and (>= level lmin) (<= level lmax))
  13644. (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
  13645. (when (= cnt 0) (error "Heading not found on level %d: %s"
  13646. lmax heading))
  13647. (when (> cnt 1) (error "Heading not unique on level %d: %s"
  13648. lmax heading))
  13649. (goto-char found)
  13650. (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
  13651. (setq end (save-excursion (org-end-of-subtree t t))))
  13652. (when (org-at-heading-p)
  13653. (move-marker (make-marker) (point))))))))
  13654. (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
  13655. "Find node HEADING in BUFFER.
  13656. Return a marker to the heading if it was found, or nil if not.
  13657. If POS-ONLY is set, return just the position instead of a marker.
  13658. The heading text must match exact, but it may have a TODO keyword,
  13659. a priority cookie and tags in the standard locations."
  13660. (with-current-buffer (or buffer (current-buffer))
  13661. (save-excursion
  13662. (save-restriction
  13663. (widen)
  13664. (goto-char (point-min))
  13665. (let (case-fold-search)
  13666. (if (re-search-forward
  13667. (format org-complex-heading-regexp-format
  13668. (regexp-quote heading)) nil t)
  13669. (if pos-only
  13670. (match-beginning 0)
  13671. (move-marker (make-marker) (match-beginning 0)))))))))
  13672. (defun org-find-exact-heading-in-directory (heading &optional dir)
  13673. "Find Org node headline HEADING in all .org files in directory DIR.
  13674. When the target headline is found, return a marker to this location."
  13675. (let ((files (directory-files (or dir default-directory)
  13676. nil "\\`[^.#].*\\.org\\'"))
  13677. file visiting m buffer)
  13678. (catch 'found
  13679. (while (setq file (pop files))
  13680. (message "trying %s" file)
  13681. (setq visiting (org-find-base-buffer-visiting file))
  13682. (setq buffer (or visiting (find-file-noselect file)))
  13683. (setq m (org-find-exact-headline-in-buffer
  13684. heading buffer))
  13685. (when (and (not m) (not visiting)) (kill-buffer buffer))
  13686. (and m (throw 'found m))))))
  13687. (defun org-find-entry-with-id (ident)
  13688. "Locate the entry that contains the ID property with exact value IDENT.
  13689. IDENT can be a string, a symbol or a number, this function will search for
  13690. the string representation of it.
  13691. Return the position where this entry starts, or nil if there is no such entry."
  13692. (interactive "sID: ")
  13693. (let ((id (cond
  13694. ((stringp ident) ident)
  13695. ((symbol-name ident) (symbol-name ident))
  13696. ((numberp ident) (number-to-string ident))
  13697. (t (error "IDENT %s must be a string, symbol or number" ident))))
  13698. (case-fold-search nil))
  13699. (save-excursion
  13700. (save-restriction
  13701. (widen)
  13702. (goto-char (point-min))
  13703. (when (re-search-forward
  13704. (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
  13705. nil t)
  13706. (org-back-to-heading t)
  13707. (point))))))
  13708. ;;;; Timestamps
  13709. (defvar org-last-changed-timestamp nil)
  13710. (defvar org-last-inserted-timestamp nil
  13711. "The last time stamp inserted with `org-insert-time-stamp'.")
  13712. (defvar org-time-was-given) ; dynamically scoped parameter
  13713. (defvar org-end-time-was-given) ; dynamically scoped parameter
  13714. (defvar org-ts-what) ; dynamically scoped parameter
  13715. (defun org-time-stamp (arg &optional inactive)
  13716. "Prompt for a date/time and insert a time stamp.
  13717. If the user specifies a time like HH:MM or if this command is
  13718. called with at least one prefix argument, the time stamp contains
  13719. the date and the time. Otherwise, only the date is be included.
  13720. All parts of a date not specified by the user is filled in from
  13721. the current date/time. So if you just press return without
  13722. typing anything, the time stamp will represent the current
  13723. date/time.
  13724. If there is already a timestamp at the cursor, it will be
  13725. modified.
  13726. With two universal prefix arguments, insert an active timestamp
  13727. with the current time without prompting the user."
  13728. (interactive "P")
  13729. (let* ((ts nil)
  13730. (default-time
  13731. ;; Default time is either today, or, when entering a range,
  13732. ;; the range start.
  13733. (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
  13734. (save-excursion
  13735. (re-search-backward
  13736. (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
  13737. (- (point) 20) t)))
  13738. (apply 'encode-time (org-parse-time-string (match-string 1)))
  13739. (current-time)))
  13740. (default-input (and ts (org-get-compact-tod ts)))
  13741. (repeater (save-excursion
  13742. (save-match-data
  13743. (beginning-of-line)
  13744. (when (re-search-forward
  13745. "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  13746. (save-excursion (progn (end-of-line) (point))) t)
  13747. (match-string 0)))))
  13748. org-time-was-given org-end-time-was-given time)
  13749. (cond
  13750. ((and (org-at-timestamp-p t)
  13751. (memq last-command '(org-time-stamp org-time-stamp-inactive))
  13752. (memq this-command '(org-time-stamp org-time-stamp-inactive)))
  13753. (insert "--")
  13754. (setq time (let ((this-command this-command))
  13755. (org-read-date arg 'totime nil nil
  13756. default-time default-input inactive)))
  13757. (org-insert-time-stamp time (or org-time-was-given arg) inactive))
  13758. ((org-at-timestamp-p t)
  13759. (setq time (let ((this-command this-command))
  13760. (org-read-date arg 'totime nil nil default-time default-input inactive)))
  13761. (when (org-at-timestamp-p t) ; just to get the match data
  13762. ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
  13763. (replace-match "")
  13764. (setq org-last-changed-timestamp
  13765. (org-insert-time-stamp
  13766. time (or org-time-was-given arg)
  13767. inactive nil nil (list org-end-time-was-given)))
  13768. (when repeater (goto-char (1- (point))) (insert " " repeater)
  13769. (setq org-last-changed-timestamp
  13770. (concat (substring org-last-inserted-timestamp 0 -1)
  13771. " " repeater ">"))))
  13772. (message "Timestamp updated"))
  13773. ((equal arg '(16))
  13774. (org-insert-time-stamp (current-time) t))
  13775. (t
  13776. (setq time (let ((this-command this-command))
  13777. (org-read-date arg 'totime nil nil default-time default-input inactive)))
  13778. (org-insert-time-stamp time (or org-time-was-given arg) inactive
  13779. nil nil (list org-end-time-was-given))))))
  13780. ;; FIXME: can we use this for something else, like computing time differences?
  13781. (defun org-get-compact-tod (s)
  13782. (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
  13783. (let* ((t1 (match-string 1 s))
  13784. (h1 (string-to-number (match-string 2 s)))
  13785. (m1 (string-to-number (match-string 3 s)))
  13786. (t2 (and (match-end 4) (match-string 5 s)))
  13787. (h2 (and t2 (string-to-number (match-string 6 s))))
  13788. (m2 (and t2 (string-to-number (match-string 7 s))))
  13789. dh dm)
  13790. (if (not t2)
  13791. t1
  13792. (setq dh (- h2 h1) dm (- m2 m1))
  13793. (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
  13794. (concat t1 "+" (number-to-string dh)
  13795. (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
  13796. (defun org-time-stamp-inactive (&optional arg)
  13797. "Insert an inactive time stamp.
  13798. An inactive time stamp is enclosed in square brackets instead of angle
  13799. brackets. It is inactive in the sense that it does not trigger agenda entries,
  13800. does not link to the calendar and cannot be changed with the S-cursor keys.
  13801. So these are more for recording a certain time/date."
  13802. (interactive "P")
  13803. (org-time-stamp arg 'inactive))
  13804. (defvar org-date-ovl (make-overlay 1 1))
  13805. (overlay-put org-date-ovl 'face 'org-date-selected)
  13806. (org-detach-overlay org-date-ovl)
  13807. (defvar org-ans1) ; dynamically scoped parameter
  13808. (defvar org-ans2) ; dynamically scoped parameter
  13809. (defvar org-plain-time-of-day-regexp) ; defined below
  13810. (defvar org-overriding-default-time nil) ; dynamically scoped
  13811. (defvar org-read-date-overlay nil)
  13812. (defvar org-dcst nil) ; dynamically scoped
  13813. (defvar org-read-date-history nil)
  13814. (defvar org-read-date-final-answer nil)
  13815. (defvar org-read-date-analyze-futurep nil)
  13816. (defvar org-read-date-analyze-forced-year nil)
  13817. (defvar org-read-date-inactive)
  13818. (defun org-read-date (&optional org-with-time to-time from-string prompt
  13819. default-time default-input inactive)
  13820. "Read a date, possibly a time, and make things smooth for the user.
  13821. The prompt will suggest to enter an ISO date, but you can also enter anything
  13822. which will at least partially be understood by `parse-time-string'.
  13823. Unrecognized parts of the date will default to the current day, month, year,
  13824. hour and minute. If this command is called to replace a timestamp at point,
  13825. or to enter the second timestamp of a range, the default time is taken
  13826. from the existing stamp. Furthermore, the command prefers the future,
  13827. so if you are giving a date where the year is not given, and the day-month
  13828. combination is already past in the current year, it will assume you
  13829. mean next year. For details, see the manual. A few examples:
  13830. 3-2-5 --> 2003-02-05
  13831. feb 15 --> currentyear-02-15
  13832. 2/15 --> currentyear-02-15
  13833. sep 12 9 --> 2009-09-12
  13834. 12:45 --> today 12:45
  13835. 22 sept 0:34 --> currentyear-09-22 0:34
  13836. 12 --> currentyear-currentmonth-12
  13837. Fri --> nearest Friday (today or later)
  13838. etc.
  13839. Furthermore you can specify a relative date by giving, as the *first* thing
  13840. in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
  13841. change in days weeks, months, years.
  13842. With a single plus or minus, the date is relative to today. With a double
  13843. plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
  13844. +4d --> four days from today
  13845. +4 --> same as above
  13846. +2w --> two weeks from today
  13847. ++5 --> five days from default date
  13848. The function understands only English month and weekday abbreviations.
  13849. While prompting, a calendar is popped up - you can also select the
  13850. date with the mouse (button 1). The calendar shows a period of three
  13851. months. To scroll it to other months, use the keys `>' and `<'.
  13852. If you don't like the calendar, turn it off with
  13853. \(setq org-read-date-popup-calendar nil)
  13854. With optional argument TO-TIME, the date will immediately be converted
  13855. to an internal time.
  13856. With an optional argument WITH-TIME, the prompt will suggest to also
  13857. insert a time. Note that when WITH-TIME is not set, you can still
  13858. enter a time, and this function will inform the calling routine about
  13859. this change. The calling routine may then choose to change the format
  13860. used to insert the time stamp into the buffer to include the time.
  13861. With optional argument FROM-STRING, read from this string instead from
  13862. the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
  13863. the time/date that is used for everything that is not specified by the
  13864. user."
  13865. (require 'parse-time)
  13866. (let* ((org-time-stamp-rounding-minutes
  13867. (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
  13868. (org-dcst org-display-custom-times)
  13869. (ct (org-current-time))
  13870. (org-def (or org-overriding-default-time default-time ct))
  13871. (org-defdecode (decode-time org-def))
  13872. (dummy (progn
  13873. (when (< (nth 2 org-defdecode) org-extend-today-until)
  13874. (setcar (nthcdr 2 org-defdecode) -1)
  13875. (setcar (nthcdr 1 org-defdecode) 59)
  13876. (setq org-def (apply 'encode-time org-defdecode)
  13877. org-defdecode (decode-time org-def)))))
  13878. (calendar-frame-setup nil)
  13879. (calendar-setup nil)
  13880. (calendar-move-hook nil)
  13881. (calendar-view-diary-initially-flag nil)
  13882. (calendar-view-holidays-initially-flag nil)
  13883. (timestr (format-time-string
  13884. (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
  13885. (prompt (concat (if prompt (concat prompt " ") "")
  13886. (format "Date+time [%s]: " timestr)))
  13887. ans (org-ans0 "") org-ans1 org-ans2 final)
  13888. (cond
  13889. (from-string (setq ans from-string))
  13890. (org-read-date-popup-calendar
  13891. (save-excursion
  13892. (save-window-excursion
  13893. (calendar)
  13894. (org-eval-in-calendar '(setq cursor-type nil) t)
  13895. (unwind-protect
  13896. (progn
  13897. (calendar-forward-day (- (time-to-days org-def)
  13898. (calendar-absolute-from-gregorian
  13899. (calendar-current-date))))
  13900. (org-eval-in-calendar nil t)
  13901. (let* ((old-map (current-local-map))
  13902. (map (copy-keymap calendar-mode-map))
  13903. (minibuffer-local-map (copy-keymap minibuffer-local-map)))
  13904. (org-defkey map (kbd "RET") 'org-calendar-select)
  13905. (org-defkey map [mouse-1] 'org-calendar-select-mouse)
  13906. (org-defkey map [mouse-2] 'org-calendar-select-mouse)
  13907. (org-defkey minibuffer-local-map [(meta shift left)]
  13908. (lambda () (interactive)
  13909. (org-eval-in-calendar '(calendar-backward-month 1))))
  13910. (org-defkey minibuffer-local-map [(meta shift right)]
  13911. (lambda () (interactive)
  13912. (org-eval-in-calendar '(calendar-forward-month 1))))
  13913. (org-defkey minibuffer-local-map [(meta shift up)]
  13914. (lambda () (interactive)
  13915. (org-eval-in-calendar '(calendar-backward-year 1))))
  13916. (org-defkey minibuffer-local-map [(meta shift down)]
  13917. (lambda () (interactive)
  13918. (org-eval-in-calendar '(calendar-forward-year 1))))
  13919. (org-defkey minibuffer-local-map [?\e (shift left)]
  13920. (lambda () (interactive)
  13921. (org-eval-in-calendar '(calendar-backward-month 1))))
  13922. (org-defkey minibuffer-local-map [?\e (shift right)]
  13923. (lambda () (interactive)
  13924. (org-eval-in-calendar '(calendar-forward-month 1))))
  13925. (org-defkey minibuffer-local-map [?\e (shift up)]
  13926. (lambda () (interactive)
  13927. (org-eval-in-calendar '(calendar-backward-year 1))))
  13928. (org-defkey minibuffer-local-map [?\e (shift down)]
  13929. (lambda () (interactive)
  13930. (org-eval-in-calendar '(calendar-forward-year 1))))
  13931. (org-defkey minibuffer-local-map [(shift up)]
  13932. (lambda () (interactive)
  13933. (org-eval-in-calendar '(calendar-backward-week 1))))
  13934. (org-defkey minibuffer-local-map [(shift down)]
  13935. (lambda () (interactive)
  13936. (org-eval-in-calendar '(calendar-forward-week 1))))
  13937. (org-defkey minibuffer-local-map [(shift left)]
  13938. (lambda () (interactive)
  13939. (org-eval-in-calendar '(calendar-backward-day 1))))
  13940. (org-defkey minibuffer-local-map [(shift right)]
  13941. (lambda () (interactive)
  13942. (org-eval-in-calendar '(calendar-forward-day 1))))
  13943. (org-defkey minibuffer-local-map ">"
  13944. (lambda () (interactive)
  13945. (org-eval-in-calendar '(scroll-calendar-left 1))))
  13946. (org-defkey minibuffer-local-map "<"
  13947. (lambda () (interactive)
  13948. (org-eval-in-calendar '(scroll-calendar-right 1))))
  13949. (org-defkey minibuffer-local-map "\C-v"
  13950. (lambda () (interactive)
  13951. (org-eval-in-calendar
  13952. '(calendar-scroll-left-three-months 1))))
  13953. (org-defkey minibuffer-local-map "\M-v"
  13954. (lambda () (interactive)
  13955. (org-eval-in-calendar
  13956. '(calendar-scroll-right-three-months 1))))
  13957. (run-hooks 'org-read-date-minibuffer-setup-hook)
  13958. (unwind-protect
  13959. (progn
  13960. (use-local-map map)
  13961. (setq org-read-date-inactive inactive)
  13962. (add-hook 'post-command-hook 'org-read-date-display)
  13963. (setq org-ans0 (read-string prompt default-input
  13964. 'org-read-date-history nil))
  13965. ;; org-ans0: from prompt
  13966. ;; org-ans1: from mouse click
  13967. ;; org-ans2: from calendar motion
  13968. (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
  13969. (remove-hook 'post-command-hook 'org-read-date-display)
  13970. (use-local-map old-map)
  13971. (when org-read-date-overlay
  13972. (delete-overlay org-read-date-overlay)
  13973. (setq org-read-date-overlay nil)))))
  13974. (bury-buffer "*Calendar*")))))
  13975. (t ; Naked prompt only
  13976. (unwind-protect
  13977. (setq ans (read-string prompt default-input
  13978. 'org-read-date-history timestr))
  13979. (when org-read-date-overlay
  13980. (delete-overlay org-read-date-overlay)
  13981. (setq org-read-date-overlay nil)))))
  13982. (setq final (org-read-date-analyze ans org-def org-defdecode))
  13983. (when org-read-date-analyze-forced-year
  13984. (message "Year was forced into %s"
  13985. (if org-read-date-force-compatible-dates
  13986. "compatible range (1970-2037)"
  13987. "range representable on this machine"))
  13988. (ding))
  13989. ;; One round trip to get rid of 34th of August and stuff like that....
  13990. (setq final (decode-time (apply 'encode-time final)))
  13991. (setq org-read-date-final-answer ans)
  13992. (if to-time
  13993. (apply 'encode-time final)
  13994. (if (and (boundp 'org-time-was-given) org-time-was-given)
  13995. (format "%04d-%02d-%02d %02d:%02d"
  13996. (nth 5 final) (nth 4 final) (nth 3 final)
  13997. (nth 2 final) (nth 1 final))
  13998. (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
  13999. (defvar org-def)
  14000. (defvar org-defdecode)
  14001. (defvar org-with-time)
  14002. (defun org-read-date-display ()
  14003. "Display the current date prompt interpretation in the minibuffer."
  14004. (when org-read-date-display-live
  14005. (when org-read-date-overlay
  14006. (delete-overlay org-read-date-overlay))
  14007. (when (minibufferp (current-buffer))
  14008. (save-excursion
  14009. (end-of-line 1)
  14010. (while (not (equal (buffer-substring
  14011. (max (point-min) (- (point) 4)) (point))
  14012. " "))
  14013. (insert " ")))
  14014. (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
  14015. " " (or org-ans1 org-ans2)))
  14016. (org-end-time-was-given nil)
  14017. (f (org-read-date-analyze ans org-def org-defdecode))
  14018. (fmts (if org-dcst
  14019. org-time-stamp-custom-formats
  14020. org-time-stamp-formats))
  14021. (fmt (if (or org-with-time
  14022. (and (boundp 'org-time-was-given) org-time-was-given))
  14023. (cdr fmts)
  14024. (car fmts)))
  14025. (txt (format-time-string fmt (apply 'encode-time f)))
  14026. (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
  14027. (txt (concat "=> " txt)))
  14028. (when (and org-end-time-was-given
  14029. (string-match org-plain-time-of-day-regexp txt))
  14030. (setq txt (concat (substring txt 0 (match-end 0)) "-"
  14031. org-end-time-was-given
  14032. (substring txt (match-end 0)))))
  14033. (when org-read-date-analyze-futurep
  14034. (setq txt (concat txt " (=>F)")))
  14035. (setq org-read-date-overlay
  14036. (make-overlay (1- (point-at-eol)) (point-at-eol)))
  14037. (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
  14038. (defun org-read-date-analyze (ans org-def org-defdecode)
  14039. "Analyze the combined answer of the date prompt."
  14040. ;; FIXME: cleanup and comment
  14041. (let ((nowdecode (decode-time (current-time)))
  14042. delta deltan deltaw deltadef year month day
  14043. hour minute second wday pm h2 m2 tl wday1
  14044. iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
  14045. (setq org-read-date-analyze-futurep nil
  14046. org-read-date-analyze-forced-year nil)
  14047. (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
  14048. (setq ans "+0"))
  14049. (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
  14050. (setq ans (replace-match "" t t ans)
  14051. deltan (car delta)
  14052. deltaw (nth 1 delta)
  14053. deltadef (nth 2 delta)))
  14054. ;; Check if there is an iso week date in there
  14055. ;; If yes, store the info and postpone interpreting it until the rest
  14056. ;; of the parsing is done
  14057. (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
  14058. (setq iso-year (if (match-end 1)
  14059. (org-small-year-to-year
  14060. (string-to-number (match-string 1 ans))))
  14061. iso-weekday (if (match-end 3)
  14062. (string-to-number (match-string 3 ans)))
  14063. iso-week (string-to-number (match-string 2 ans)))
  14064. (setq ans (replace-match "" t t ans)))
  14065. ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
  14066. (when (string-match
  14067. "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
  14068. (setq year (if (match-end 2)
  14069. (string-to-number (match-string 2 ans))
  14070. (progn (setq kill-year t)
  14071. (string-to-number (format-time-string "%Y"))))
  14072. month (string-to-number (match-string 3 ans))
  14073. day (string-to-number (match-string 4 ans)))
  14074. (if (< year 100) (setq year (+ 2000 year)))
  14075. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14076. t nil ans)))
  14077. ;; Help matching dotted european dates
  14078. (when (string-match
  14079. "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
  14080. (setq year (if (match-end 3)
  14081. (string-to-number (match-string 3 ans))
  14082. (progn (setq kill-year t)
  14083. (string-to-number (format-time-string "%Y"))))
  14084. day (string-to-number (match-string 1 ans))
  14085. month (string-to-number (match-string 2 ans))
  14086. ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14087. t nil ans)))
  14088. ;; Help matching american dates, like 5/30 or 5/30/7
  14089. (when (string-match
  14090. "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
  14091. (setq year (if (match-end 4)
  14092. (string-to-number (match-string 4 ans))
  14093. (progn (setq kill-year t)
  14094. (string-to-number (format-time-string "%Y"))))
  14095. month (string-to-number (match-string 1 ans))
  14096. day (string-to-number (match-string 2 ans)))
  14097. (if (< year 100) (setq year (+ 2000 year)))
  14098. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14099. t nil ans)))
  14100. ;; Help matching am/pm times, because `parse-time-string' does not do that.
  14101. ;; If there is a time with am/pm, and *no* time without it, we convert
  14102. ;; so that matching will be successful.
  14103. (loop for i from 1 to 2 do ; twice, for end time as well
  14104. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  14105. (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
  14106. (setq hour (string-to-number (match-string 1 ans))
  14107. minute (if (match-end 3)
  14108. (string-to-number (match-string 3 ans))
  14109. 0)
  14110. pm (equal ?p
  14111. (string-to-char (downcase (match-string 4 ans)))))
  14112. (if (and (= hour 12) (not pm))
  14113. (setq hour 0)
  14114. (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
  14115. (setq ans (replace-match (format "%02d:%02d" hour minute)
  14116. t t ans))))
  14117. ;; Check if a time range is given as a duration
  14118. (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
  14119. (setq hour (string-to-number (match-string 1 ans))
  14120. h2 (+ hour (string-to-number (match-string 3 ans)))
  14121. minute (string-to-number (match-string 2 ans))
  14122. m2 (+ minute (if (match-end 5) (string-to-number
  14123. (match-string 5 ans))0)))
  14124. (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
  14125. (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
  14126. t t ans)))
  14127. ;; Check if there is a time range
  14128. (when (boundp 'org-end-time-was-given)
  14129. (setq org-time-was-given nil)
  14130. (when (and (string-match org-plain-time-of-day-regexp ans)
  14131. (match-end 8))
  14132. (setq org-end-time-was-given (match-string 8 ans))
  14133. (setq ans (concat (substring ans 0 (match-beginning 7))
  14134. (substring ans (match-end 7))))))
  14135. (setq tl (parse-time-string ans)
  14136. day (or (nth 3 tl) (nth 3 org-defdecode))
  14137. month (or (nth 4 tl)
  14138. (if (and org-read-date-prefer-future
  14139. (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
  14140. (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
  14141. (nth 4 org-defdecode)))
  14142. year (or (and (not kill-year) (nth 5 tl))
  14143. (if (and org-read-date-prefer-future
  14144. (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
  14145. (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
  14146. (nth 5 org-defdecode)))
  14147. hour (or (nth 2 tl) (nth 2 org-defdecode))
  14148. minute (or (nth 1 tl) (nth 1 org-defdecode))
  14149. second (or (nth 0 tl) 0)
  14150. wday (nth 6 tl))
  14151. (when (and (eq org-read-date-prefer-future 'time)
  14152. (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
  14153. (equal day (nth 3 nowdecode))
  14154. (equal month (nth 4 nowdecode))
  14155. (equal year (nth 5 nowdecode))
  14156. (nth 2 tl)
  14157. (or (< (nth 2 tl) (nth 2 nowdecode))
  14158. (and (= (nth 2 tl) (nth 2 nowdecode))
  14159. (nth 1 tl)
  14160. (< (nth 1 tl) (nth 1 nowdecode)))))
  14161. (setq day (1+ day)
  14162. futurep t))
  14163. ;; Special date definitions below
  14164. (cond
  14165. (iso-week
  14166. ;; There was an iso week
  14167. (require 'cal-iso)
  14168. (setq futurep nil)
  14169. (setq year (or iso-year year)
  14170. day (or iso-weekday wday 1)
  14171. wday nil ; to make sure that the trigger below does not match
  14172. iso-date (calendar-gregorian-from-absolute
  14173. (calendar-absolute-from-iso
  14174. (list iso-week day year))))
  14175. ; FIXME: Should we also push ISO weeks into the future?
  14176. ; (when (and org-read-date-prefer-future
  14177. ; (not iso-year)
  14178. ; (< (calendar-absolute-from-gregorian iso-date)
  14179. ; (time-to-days (current-time))))
  14180. ; (setq year (1+ year)
  14181. ; iso-date (calendar-gregorian-from-absolute
  14182. ; (calendar-absolute-from-iso
  14183. ; (list iso-week day year)))))
  14184. (setq month (car iso-date)
  14185. year (nth 2 iso-date)
  14186. day (nth 1 iso-date)))
  14187. (deltan
  14188. (setq futurep nil)
  14189. (unless deltadef
  14190. (let ((now (decode-time (current-time))))
  14191. (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
  14192. (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
  14193. ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
  14194. ((equal deltaw "m") (setq month (+ month deltan)))
  14195. ((equal deltaw "y") (setq year (+ year deltan)))))
  14196. ((and wday (not (nth 3 tl)))
  14197. (setq futurep nil)
  14198. ;; Weekday was given, but no day, so pick that day in the week
  14199. ;; on or after the derived date.
  14200. (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
  14201. (unless (equal wday wday1)
  14202. (setq day (+ day (% (- wday wday1 -7) 7))))))
  14203. (if (and (boundp 'org-time-was-given)
  14204. (nth 2 tl))
  14205. (setq org-time-was-given t))
  14206. (if (< year 100) (setq year (+ 2000 year)))
  14207. ;; Check of the date is representable
  14208. (if org-read-date-force-compatible-dates
  14209. (progn
  14210. (if (< year 1970)
  14211. (setq year 1970 org-read-date-analyze-forced-year t))
  14212. (if (> year 2037)
  14213. (setq year 2037 org-read-date-analyze-forced-year t)))
  14214. (condition-case nil
  14215. (ignore (encode-time second minute hour day month year))
  14216. (error
  14217. (setq year (nth 5 org-defdecode))
  14218. (setq org-read-date-analyze-forced-year t))))
  14219. (setq org-read-date-analyze-futurep futurep)
  14220. (list second minute hour day month year)))
  14221. (defvar parse-time-weekdays)
  14222. (defun org-read-date-get-relative (s today default)
  14223. "Check string S for special relative date string.
  14224. TODAY and DEFAULT are internal times, for today and for a default.
  14225. Return shift list (N what def-flag)
  14226. WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
  14227. N is the number of WHATs to shift.
  14228. DEF-FLAG is t when a double ++ or -- indicates shift relative to
  14229. the DEFAULT date rather than TODAY."
  14230. (require 'parse-time)
  14231. (when (and
  14232. (string-match
  14233. (concat
  14234. "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
  14235. "\\([0-9]+\\)?"
  14236. "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
  14237. "\\([ \t]\\|$\\)") s)
  14238. (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
  14239. (let* ((dir (if (> (match-end 1) (match-beginning 1))
  14240. (string-to-char (substring (match-string 1 s) -1))
  14241. ?+))
  14242. (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
  14243. (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
  14244. (what (if (match-end 3) (match-string 3 s) "d"))
  14245. (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
  14246. (date (if rel default today))
  14247. (wday (nth 6 (decode-time date)))
  14248. delta)
  14249. (if wday1
  14250. (progn
  14251. (setq delta (mod (+ 7 (- wday1 wday)) 7))
  14252. (if (= dir ?-) (setq delta (- delta 7)))
  14253. (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
  14254. (list delta "d" rel))
  14255. (list (* n (if (= dir ?-) -1 1)) what rel)))))
  14256. (defun org-order-calendar-date-args (arg1 arg2 arg3)
  14257. "Turn a user-specified date into the internal representation.
  14258. The internal representation needed by the calendar is (month day year).
  14259. This is a wrapper to handle the brain-dead convention in calendar that
  14260. user function argument order change dependent on argument order."
  14261. (if (boundp 'calendar-date-style)
  14262. (cond
  14263. ((eq calendar-date-style 'american)
  14264. (list arg1 arg2 arg3))
  14265. ((eq calendar-date-style 'european)
  14266. (list arg2 arg1 arg3))
  14267. ((eq calendar-date-style 'iso)
  14268. (list arg2 arg3 arg1)))
  14269. (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
  14270. (if (org-bound-and-true-p european-calendar-style)
  14271. (list arg2 arg1 arg3)
  14272. (list arg1 arg2 arg3)))))
  14273. (defun org-eval-in-calendar (form &optional keepdate)
  14274. "Eval FORM in the calendar window and return to current window.
  14275. When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
  14276. otherwise stick to the current value of `org-ans2'."
  14277. (let ((sf (selected-frame))
  14278. (sw (selected-window)))
  14279. (select-window (get-buffer-window "*Calendar*" t))
  14280. (eval form)
  14281. (when (and (not keepdate) (calendar-cursor-to-date))
  14282. (let* ((date (calendar-cursor-to-date))
  14283. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14284. (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
  14285. (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
  14286. (select-window sw)
  14287. (org-select-frame-set-input-focus sf)))
  14288. (defun org-calendar-select ()
  14289. "Return to `org-read-date' with the date currently selected.
  14290. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  14291. (interactive)
  14292. (when (calendar-cursor-to-date)
  14293. (let* ((date (calendar-cursor-to-date))
  14294. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14295. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  14296. (if (active-minibuffer-window) (exit-minibuffer))))
  14297. (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
  14298. "Insert a date stamp for the date given by the internal TIME.
  14299. WITH-HM means use the stamp format that includes the time of the day.
  14300. INACTIVE means use square brackets instead of angular ones, so that the
  14301. stamp will not contribute to the agenda.
  14302. PRE and POST are optional strings to be inserted before and after the
  14303. stamp.
  14304. The command returns the inserted time stamp."
  14305. (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
  14306. stamp)
  14307. (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
  14308. (insert-before-markers (or pre ""))
  14309. (when (listp extra)
  14310. (setq extra (car extra))
  14311. (if (and (stringp extra)
  14312. (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
  14313. (setq extra (format "-%02d:%02d"
  14314. (string-to-number (match-string 1 extra))
  14315. (string-to-number (match-string 2 extra))))
  14316. (setq extra nil)))
  14317. (when extra
  14318. (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
  14319. (insert-before-markers (setq stamp (format-time-string fmt time)))
  14320. (insert-before-markers (or post ""))
  14321. (setq org-last-inserted-timestamp stamp)))
  14322. (defun org-toggle-time-stamp-overlays ()
  14323. "Toggle the use of custom time stamp formats."
  14324. (interactive)
  14325. (setq org-display-custom-times (not org-display-custom-times))
  14326. (unless org-display-custom-times
  14327. (let ((p (point-min)) (bmp (buffer-modified-p)))
  14328. (while (setq p (next-single-property-change p 'display))
  14329. (if (and (get-text-property p 'display)
  14330. (eq (get-text-property p 'face) 'org-date))
  14331. (remove-text-properties
  14332. p (setq p (next-single-property-change p 'display))
  14333. '(display t))))
  14334. (set-buffer-modified-p bmp)))
  14335. (if (featurep 'xemacs)
  14336. (remove-text-properties (point-min) (point-max) '(end-glyph t)))
  14337. (org-restart-font-lock)
  14338. (setq org-table-may-need-update t)
  14339. (if org-display-custom-times
  14340. (message "Time stamps are overlaid with custom format")
  14341. (message "Time stamp overlays removed")))
  14342. (defun org-display-custom-time (beg end)
  14343. "Overlay modified time stamp format over timestamp between BEG and END."
  14344. (let* ((ts (buffer-substring beg end))
  14345. t1 w1 with-hm tf time str w2 (off 0))
  14346. (save-match-data
  14347. (setq t1 (org-parse-time-string ts t))
  14348. (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
  14349. (setq off (- (match-end 0) (match-beginning 0)))))
  14350. (setq end (- end off))
  14351. (setq w1 (- end beg)
  14352. with-hm (and (nth 1 t1) (nth 2 t1))
  14353. tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
  14354. time (org-fix-decoded-time t1)
  14355. str (org-add-props
  14356. (format-time-string
  14357. (substring tf 1 -1) (apply 'encode-time time))
  14358. nil 'mouse-face 'highlight)
  14359. w2 (length str))
  14360. (if (not (= w2 w1))
  14361. (add-text-properties (1+ beg) (+ 2 beg)
  14362. (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
  14363. (if (featurep 'xemacs)
  14364. (progn
  14365. (put-text-property beg end 'invisible t)
  14366. (put-text-property beg end 'end-glyph (make-glyph str)))
  14367. (put-text-property beg end 'display str))))
  14368. (defun org-translate-time (string)
  14369. "Translate all timestamps in STRING to custom format.
  14370. But do this only if the variable `org-display-custom-times' is set."
  14371. (when org-display-custom-times
  14372. (save-match-data
  14373. (let* ((start 0)
  14374. (re org-ts-regexp-both)
  14375. t1 with-hm inactive tf time str beg end)
  14376. (while (setq start (string-match re string start))
  14377. (setq beg (match-beginning 0)
  14378. end (match-end 0)
  14379. t1 (save-match-data
  14380. (org-parse-time-string (substring string beg end) t))
  14381. with-hm (and (nth 1 t1) (nth 2 t1))
  14382. inactive (equal (substring string beg (1+ beg)) "[")
  14383. tf (funcall (if with-hm 'cdr 'car)
  14384. org-time-stamp-custom-formats)
  14385. time (org-fix-decoded-time t1)
  14386. str (format-time-string
  14387. (concat
  14388. (if inactive "[" "<") (substring tf 1 -1)
  14389. (if inactive "]" ">"))
  14390. (apply 'encode-time time))
  14391. string (replace-match str t t string)
  14392. start (+ start (length str)))))))
  14393. string)
  14394. (defun org-fix-decoded-time (time)
  14395. "Set 0 instead of nil for the first 6 elements of time.
  14396. Don't touch the rest."
  14397. (let ((n 0))
  14398. (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
  14399. (defun org-days-to-time (timestamp-string)
  14400. "Difference between TIMESTAMP-STRING and now in days."
  14401. (- (time-to-days (org-time-string-to-time timestamp-string))
  14402. (time-to-days (current-time))))
  14403. (defun org-deadline-close (timestamp-string &optional ndays)
  14404. "Is the time in TIMESTAMP-STRING close to the current date?"
  14405. (setq ndays (or ndays (org-get-wdays timestamp-string)))
  14406. (and (< (org-days-to-time timestamp-string) ndays)
  14407. (not (org-entry-is-done-p))))
  14408. (defun org-get-wdays (ts)
  14409. "Get the deadline lead time appropriate for timestring TS."
  14410. (cond
  14411. ((<= org-deadline-warning-days 0)
  14412. ;; 0 or negative, enforce this value no matter what
  14413. (- org-deadline-warning-days))
  14414. ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
  14415. ;; lead time is specified.
  14416. (floor (* (string-to-number (match-string 1 ts))
  14417. (cdr (assoc (match-string 2 ts)
  14418. '(("d" . 1) ("w" . 7)
  14419. ("m" . 30.4) ("y" . 365.25)))))))
  14420. ;; go for the default.
  14421. (t org-deadline-warning-days)))
  14422. (defun org-calendar-select-mouse (ev)
  14423. "Return to `org-read-date' with the date currently selected.
  14424. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  14425. (interactive "e")
  14426. (mouse-set-point ev)
  14427. (when (calendar-cursor-to-date)
  14428. (let* ((date (calendar-cursor-to-date))
  14429. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14430. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  14431. (if (active-minibuffer-window) (exit-minibuffer))))
  14432. (defun org-check-deadlines (ndays)
  14433. "Check if there are any deadlines due or past due.
  14434. A deadline is considered due if it happens within `org-deadline-warning-days'
  14435. days from today's date. If the deadline appears in an entry marked DONE,
  14436. it is not shown. The prefix arg NDAYS can be used to test that many
  14437. days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
  14438. (interactive "P")
  14439. (let* ((org-warn-days
  14440. (cond
  14441. ((equal ndays '(4)) 100000)
  14442. (ndays (prefix-numeric-value ndays))
  14443. (t (abs org-deadline-warning-days))))
  14444. (case-fold-search nil)
  14445. (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  14446. (callback
  14447. (lambda () (org-deadline-close (match-string 1) org-warn-days))))
  14448. (message "%d deadlines past-due or due within %d days"
  14449. (org-occur regexp nil callback)
  14450. org-warn-days)))
  14451. (defun org-check-before-date (date)
  14452. "Check if there are deadlines or scheduled entries before DATE."
  14453. (interactive (list (org-read-date)))
  14454. (let ((case-fold-search nil)
  14455. (regexp (concat "\\<\\(" org-deadline-string
  14456. "\\|" org-scheduled-string
  14457. "\\) *<\\([^>]+\\)>"))
  14458. (callback
  14459. (lambda () (time-less-p
  14460. (org-time-string-to-time (match-string 2))
  14461. (org-time-string-to-time date)))))
  14462. (message "%d entries before %s"
  14463. (org-occur regexp nil callback) date)))
  14464. (defun org-check-after-date (date)
  14465. "Check if there are deadlines or scheduled entries after DATE."
  14466. (interactive (list (org-read-date)))
  14467. (let ((case-fold-search nil)
  14468. (regexp (concat "\\<\\(" org-deadline-string
  14469. "\\|" org-scheduled-string
  14470. "\\) *<\\([^>]+\\)>"))
  14471. (callback
  14472. (lambda () (not
  14473. (time-less-p
  14474. (org-time-string-to-time (match-string 2))
  14475. (org-time-string-to-time date))))))
  14476. (message "%d entries after %s"
  14477. (org-occur regexp nil callback) date)))
  14478. (defun org-check-dates-range (start-date end-date)
  14479. "Check for deadlines/scheduled entries between START-DATE and END-DATE."
  14480. (interactive (list (org-read-date nil nil nil "Range starts")
  14481. (org-read-date nil nil nil "Range end")))
  14482. (let ((case-fold-search nil)
  14483. (regexp (concat "\\<\\(" org-deadline-string
  14484. "\\|" org-scheduled-string
  14485. "\\) *<\\([^>]+\\)>"))
  14486. (callback
  14487. (lambda ()
  14488. (let ((match (match-string 2)))
  14489. (and
  14490. (not (time-less-p
  14491. (org-time-string-to-time match)
  14492. (org-time-string-to-time start-date)))
  14493. (time-less-p
  14494. (org-time-string-to-time match)
  14495. (org-time-string-to-time end-date)))))))
  14496. (message "%d entries between %s and %s"
  14497. (org-occur regexp nil callback) start-date end-date)))
  14498. (defun org-evaluate-time-range (&optional to-buffer)
  14499. "Evaluate a time range by computing the difference between start and end.
  14500. Normally the result is just printed in the echo area, but with prefix arg
  14501. TO-BUFFER, the result is inserted just after the date stamp into the buffer.
  14502. If the time range is actually in a table, the result is inserted into the
  14503. next column.
  14504. For time difference computation, a year is assumed to be exactly 365
  14505. days in order to avoid rounding problems."
  14506. (interactive "P")
  14507. (or
  14508. (org-clock-update-time-maybe)
  14509. (save-excursion
  14510. (unless (org-at-date-range-p t)
  14511. (goto-char (point-at-bol))
  14512. (re-search-forward org-tr-regexp-both (point-at-eol) t))
  14513. (if (not (org-at-date-range-p t))
  14514. (error "Not at a time-stamp range, and none found in current line")))
  14515. (let* ((ts1 (match-string 1))
  14516. (ts2 (match-string 2))
  14517. (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
  14518. (match-end (match-end 0))
  14519. (time1 (org-time-string-to-time ts1))
  14520. (time2 (org-time-string-to-time ts2))
  14521. (t1 (org-float-time time1))
  14522. (t2 (org-float-time time2))
  14523. (diff (abs (- t2 t1)))
  14524. (negative (< (- t2 t1) 0))
  14525. ;; (ys (floor (* 365 24 60 60)))
  14526. (ds (* 24 60 60))
  14527. (hs (* 60 60))
  14528. (fy "%dy %dd %02d:%02d")
  14529. (fy1 "%dy %dd")
  14530. (fd "%dd %02d:%02d")
  14531. (fd1 "%dd")
  14532. (fh "%02d:%02d")
  14533. y d h m align)
  14534. (if havetime
  14535. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  14536. y 0
  14537. d (floor (/ diff ds)) diff (mod diff ds)
  14538. h (floor (/ diff hs)) diff (mod diff hs)
  14539. m (floor (/ diff 60)))
  14540. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  14541. y 0
  14542. d (floor (+ (/ diff ds) 0.5))
  14543. h 0 m 0))
  14544. (if (not to-buffer)
  14545. (message "%s" (org-make-tdiff-string y d h m))
  14546. (if (org-at-table-p)
  14547. (progn
  14548. (goto-char match-end)
  14549. (setq align t)
  14550. (and (looking-at " *|") (goto-char (match-end 0))))
  14551. (goto-char match-end))
  14552. (if (looking-at
  14553. "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
  14554. (replace-match ""))
  14555. (if negative (insert " -"))
  14556. (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
  14557. (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
  14558. (insert " " (format fh h m))))
  14559. (if align (org-table-align))
  14560. (message "Time difference inserted")))))
  14561. (defun org-make-tdiff-string (y d h m)
  14562. (let ((fmt "")
  14563. (l nil))
  14564. (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
  14565. l (push y l)))
  14566. (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
  14567. l (push d l)))
  14568. (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
  14569. l (push h l)))
  14570. (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
  14571. l (push m l)))
  14572. (apply 'format fmt (nreverse l))))
  14573. (defun org-time-string-to-time (s &optional buffer pos)
  14574. (condition-case errdata
  14575. (apply 'encode-time (org-parse-time-string s))
  14576. (error (error "Bad timestamp `%s'%s\nError was: %s"
  14577. s (if (not (and buffer pos))
  14578. ""
  14579. (format " at %d in buffer `%s'" pos buffer))
  14580. (cdr errdata)))))
  14581. (defun org-time-string-to-seconds (s)
  14582. (org-float-time (org-time-string-to-time s)))
  14583. (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
  14584. "Convert a time stamp to an absolute day number.
  14585. If there is a specifier for a cyclic time stamp, get the closest date to
  14586. DAYNR.
  14587. PREFER and SHOW-ALL are passed through to `org-closest-date'.
  14588. The variable date is bound by the calendar when this is called."
  14589. (cond
  14590. ((and daynr (string-match "\\`%%\\((.*)\\)" s))
  14591. (if (org-diary-sexp-entry (match-string 1 s) "" date)
  14592. daynr
  14593. (+ daynr 1000)))
  14594. ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
  14595. (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
  14596. (time-to-days (current-time))) (match-string 0 s)
  14597. prefer show-all))
  14598. (t (time-to-days
  14599. (condition-case errdata
  14600. (apply 'encode-time (org-parse-time-string s))
  14601. (error (error "Bad timestamp `%s'%s\nError was: %s"
  14602. s (if (not (and buffer pos))
  14603. ""
  14604. (format " at %d in buffer `%s'" pos buffer))
  14605. (cdr errdata))))))))
  14606. (defun org-days-to-iso-week (days)
  14607. "Return the iso week number."
  14608. (require 'cal-iso)
  14609. (car (calendar-iso-from-absolute days)))
  14610. (defun org-small-year-to-year (year)
  14611. "Convert 2-digit years into 4-digit years.
  14612. 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
  14613. The year 2000 cannot be abbreviated. Any year larger than 99
  14614. is returned unchanged."
  14615. (if (< year 38)
  14616. (setq year (+ 2000 year))
  14617. (if (< year 100)
  14618. (setq year (+ 1900 year))))
  14619. year)
  14620. (defun org-time-from-absolute (d)
  14621. "Return the time corresponding to date D.
  14622. D may be an absolute day number, or a calendar-type list (month day year)."
  14623. (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
  14624. (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
  14625. (defun org-calendar-holiday ()
  14626. "List of holidays, for Diary display in Org-mode."
  14627. (require 'holidays)
  14628. (let ((hl (funcall
  14629. (if (fboundp 'calendar-check-holidays)
  14630. 'calendar-check-holidays 'check-calendar-holidays) date)))
  14631. (if hl (mapconcat 'identity hl "; "))))
  14632. (defun org-diary-sexp-entry (sexp entry date)
  14633. "Process a SEXP diary ENTRY for DATE."
  14634. (require 'diary-lib)
  14635. (let ((result (if calendar-debug-sexp
  14636. (let ((stack-trace-on-error t))
  14637. (eval (car (read-from-string sexp))))
  14638. (condition-case nil
  14639. (eval (car (read-from-string sexp)))
  14640. (error
  14641. (beep)
  14642. (message "Bad sexp at line %d in %s: %s"
  14643. (org-current-line)
  14644. (buffer-file-name) sexp)
  14645. (sleep-for 2))))))
  14646. (cond ((stringp result) (split-string result "; "))
  14647. ((and (consp result)
  14648. (not (consp (cdr result)))
  14649. (stringp (cdr result))) (cdr result))
  14650. ((and (consp result)
  14651. (stringp (car result))) result)
  14652. (result entry)
  14653. (t nil))))
  14654. (defun org-diary-to-ical-string (frombuf)
  14655. "Get iCalendar entries from diary entries in buffer FROMBUF.
  14656. This uses the icalendar.el library."
  14657. (let* ((tmpdir (if (featurep 'xemacs)
  14658. (temp-directory)
  14659. temporary-file-directory))
  14660. (tmpfile (make-temp-name
  14661. (expand-file-name "orgics" tmpdir)))
  14662. buf rtn b e)
  14663. (with-current-buffer frombuf
  14664. (icalendar-export-region (point-min) (point-max) tmpfile)
  14665. (setq buf (find-buffer-visiting tmpfile))
  14666. (set-buffer buf)
  14667. (goto-char (point-min))
  14668. (if (re-search-forward "^BEGIN:VEVENT" nil t)
  14669. (setq b (match-beginning 0)))
  14670. (goto-char (point-max))
  14671. (if (re-search-backward "^END:VEVENT" nil t)
  14672. (setq e (match-end 0)))
  14673. (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
  14674. (kill-buffer buf)
  14675. (delete-file tmpfile)
  14676. rtn))
  14677. (defun org-closest-date (start current change prefer show-all)
  14678. "Find the date closest to CURRENT that is consistent with START and CHANGE.
  14679. When PREFER is `past', return a date that is either CURRENT or past.
  14680. When PREFER is `future', return a date that is either CURRENT or future.
  14681. When SHOW-ALL is nil, only return the current occurrence of a time stamp."
  14682. ;; Make the proper lists from the dates
  14683. (catch 'exit
  14684. (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
  14685. dn dw sday cday n1 n2 n0
  14686. d m y y1 y2 date1 date2 nmonths nm ny m2)
  14687. (setq start (org-date-to-gregorian start)
  14688. current (org-date-to-gregorian
  14689. (if show-all
  14690. current
  14691. (time-to-days (current-time))))
  14692. sday (calendar-absolute-from-gregorian start)
  14693. cday (calendar-absolute-from-gregorian current))
  14694. (if (<= cday sday) (throw 'exit sday))
  14695. (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
  14696. (setq dn (string-to-number (match-string 1 change))
  14697. dw (cdr (assoc (match-string 2 change) a1)))
  14698. (error "Invalid change specifier: %s" change))
  14699. (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
  14700. (cond
  14701. ((eq dw 'day)
  14702. (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
  14703. n2 (+ n1 dn)))
  14704. ((eq dw 'year)
  14705. (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
  14706. (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
  14707. (setq date1 (list m d y1)
  14708. n1 (calendar-absolute-from-gregorian date1)
  14709. date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
  14710. n2 (calendar-absolute-from-gregorian date2)))
  14711. ((eq dw 'month)
  14712. ;; approx number of month between the two dates
  14713. (setq nmonths (floor (/ (- cday sday) 30.436875)))
  14714. ;; How often does dn fit in there?
  14715. (setq d (nth 1 start) m (car start) y (nth 2 start)
  14716. nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
  14717. m (+ m nm)
  14718. ny (floor (/ m 12))
  14719. y (+ y ny)
  14720. m (- m (* ny 12)))
  14721. (while (> m 12) (setq m (- m 12) y (1+ y)))
  14722. (setq n1 (calendar-absolute-from-gregorian (list m d y)))
  14723. (setq m2 (+ m dn) y2 y)
  14724. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  14725. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
  14726. (while (<= n2 cday)
  14727. (setq n1 n2 m m2 y y2)
  14728. (setq m2 (+ m dn) y2 y)
  14729. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  14730. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
  14731. ;; Make sure n1 is the earlier date
  14732. (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
  14733. (if show-all
  14734. (cond
  14735. ((eq prefer 'past) (if (= cday n2) n2 n1))
  14736. ((eq prefer 'future) (if (= cday n1) n1 n2))
  14737. (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
  14738. (cond
  14739. ((eq prefer 'past) (if (= cday n2) n2 n1))
  14740. ((eq prefer 'future) (if (= cday n1) n1 n2))
  14741. (t (if (= cday n1) n1 n2)))))))
  14742. (defun org-date-to-gregorian (date)
  14743. "Turn any specification of DATE into a Gregorian date for the calendar."
  14744. (cond ((integerp date) (calendar-gregorian-from-absolute date))
  14745. ((and (listp date) (= (length date) 3)) date)
  14746. ((stringp date)
  14747. (setq date (org-parse-time-string date))
  14748. (list (nth 4 date) (nth 3 date) (nth 5 date)))
  14749. ((listp date)
  14750. (list (nth 4 date) (nth 3 date) (nth 5 date)))))
  14751. (defun org-parse-time-string (s &optional nodefault)
  14752. "Parse the standard Org-mode time string.
  14753. This should be a lot faster than the normal `parse-time-string'.
  14754. If time is not given, defaults to 0:00. However, with optional NODEFAULT,
  14755. hour and minute fields will be nil if not given."
  14756. (if (string-match org-ts-regexp0 s)
  14757. (list 0
  14758. (if (or (match-beginning 8) (not nodefault))
  14759. (string-to-number (or (match-string 8 s) "0")))
  14760. (if (or (match-beginning 7) (not nodefault))
  14761. (string-to-number (or (match-string 7 s) "0")))
  14762. (string-to-number (match-string 4 s))
  14763. (string-to-number (match-string 3 s))
  14764. (string-to-number (match-string 2 s))
  14765. nil nil nil)
  14766. (error "Not a standard Org-mode time string: %s" s)))
  14767. (defun org-timestamp-up (&optional arg)
  14768. "Increase the date item at the cursor by one.
  14769. If the cursor is on the year, change the year. If it is on the month,
  14770. the day or the time, change that.
  14771. With prefix ARG, change by that many units."
  14772. (interactive "p")
  14773. (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
  14774. (defun org-timestamp-down (&optional arg)
  14775. "Decrease the date item at the cursor by one.
  14776. If the cursor is on the year, change the year. If it is on the month,
  14777. the day or the time, change that.
  14778. With prefix ARG, change by that many units."
  14779. (interactive "p")
  14780. (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
  14781. (defun org-timestamp-up-day (&optional arg)
  14782. "Increase the date in the time stamp by one day.
  14783. With prefix ARG, change that many days."
  14784. (interactive "p")
  14785. (if (and (not (org-at-timestamp-p t))
  14786. (org-at-heading-p))
  14787. (org-todo 'up)
  14788. (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
  14789. (defun org-timestamp-down-day (&optional arg)
  14790. "Decrease the date in the time stamp by one day.
  14791. With prefix ARG, change that many days."
  14792. (interactive "p")
  14793. (if (and (not (org-at-timestamp-p t))
  14794. (org-at-heading-p))
  14795. (org-todo 'down)
  14796. (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
  14797. (defun org-at-timestamp-p (&optional inactive-ok)
  14798. "Determine if the cursor is in or at a timestamp."
  14799. (interactive)
  14800. (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
  14801. (pos (point))
  14802. (ans (or (looking-at tsr)
  14803. (save-excursion
  14804. (skip-chars-backward "^[<\n\r\t")
  14805. (if (> (point) (point-min)) (backward-char 1))
  14806. (and (looking-at tsr)
  14807. (> (- (match-end 0) pos) -1))))))
  14808. (and ans
  14809. (boundp 'org-ts-what)
  14810. (setq org-ts-what
  14811. (cond
  14812. ((= pos (match-beginning 0)) 'bracket)
  14813. ;; Point is considered to be "on the bracket" whether
  14814. ;; it's really on it or right after it.
  14815. ((= pos (1- (match-end 0))) 'bracket)
  14816. ((= pos (match-end 0)) 'after)
  14817. ((org-pos-in-match-range pos 2) 'year)
  14818. ((org-pos-in-match-range pos 3) 'month)
  14819. ((org-pos-in-match-range pos 7) 'hour)
  14820. ((org-pos-in-match-range pos 8) 'minute)
  14821. ((or (org-pos-in-match-range pos 4)
  14822. (org-pos-in-match-range pos 5)) 'day)
  14823. ((and (> pos (or (match-end 8) (match-end 5)))
  14824. (< pos (match-end 0)))
  14825. (- pos (or (match-end 8) (match-end 5))))
  14826. (t 'day))))
  14827. ans))
  14828. (defun org-toggle-timestamp-type ()
  14829. "Toggle the type (<active> or [inactive]) of a time stamp."
  14830. (interactive)
  14831. (when (org-at-timestamp-p t)
  14832. (let ((beg (match-beginning 0)) (end (match-end 0))
  14833. (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
  14834. (save-excursion
  14835. (goto-char beg)
  14836. (while (re-search-forward "[][<>]" end t)
  14837. (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
  14838. t t)))
  14839. (message "Timestamp is now %sactive"
  14840. (if (equal (char-after beg) ?<) "" "in")))))
  14841. (defun org-timestamp-change (n &optional what updown)
  14842. "Change the date in the time stamp at point.
  14843. The date will be changed by N times WHAT. WHAT can be `day', `month',
  14844. `year', `minute', `second'. If WHAT is not given, the cursor position
  14845. in the timestamp determines what will be changed."
  14846. (let ((origin (point)) origin-cat
  14847. with-hm inactive
  14848. (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
  14849. org-ts-what
  14850. extra rem
  14851. ts time time0)
  14852. (if (not (org-at-timestamp-p t))
  14853. (error "Not at a timestamp"))
  14854. (if (and (not what) (eq org-ts-what 'bracket))
  14855. (org-toggle-timestamp-type)
  14856. ;; Point isn't on brackets. Remember the part of the time-stamp
  14857. ;; the point was in. Indeed, size of time-stamps may change,
  14858. ;; but point must be kept in the same category nonetheless.
  14859. (setq origin-cat org-ts-what)
  14860. (if (and (not what) (not (eq org-ts-what 'day))
  14861. org-display-custom-times
  14862. (get-text-property (point) 'display)
  14863. (not (get-text-property (1- (point)) 'display)))
  14864. (setq org-ts-what 'day))
  14865. (setq org-ts-what (or what org-ts-what)
  14866. inactive (= (char-after (match-beginning 0)) ?\[)
  14867. ts (match-string 0))
  14868. (replace-match "")
  14869. (if (string-match
  14870. "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
  14871. ts)
  14872. (setq extra (match-string 1 ts)))
  14873. (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
  14874. (setq with-hm t))
  14875. (setq time0 (org-parse-time-string ts))
  14876. (when (and updown
  14877. (eq org-ts-what 'minute)
  14878. (not current-prefix-arg))
  14879. ;; This looks like s-up and s-down. Change by one rounding step.
  14880. (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
  14881. (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
  14882. (setcar (cdr time0) (+ (nth 1 time0)
  14883. (if (> n 0) (- rem) (- dm rem))))))
  14884. (setq time
  14885. (encode-time (or (car time0) 0)
  14886. (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
  14887. (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
  14888. (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
  14889. (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
  14890. (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
  14891. (nthcdr 6 time0)))
  14892. (when (and (member org-ts-what '(hour minute))
  14893. extra
  14894. (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
  14895. (setq extra (org-modify-ts-extra
  14896. extra
  14897. (if (eq org-ts-what 'hour) 2 5)
  14898. n dm)))
  14899. (when (integerp org-ts-what)
  14900. (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
  14901. (if (eq what 'calendar)
  14902. (let ((cal-date (org-get-date-from-calendar)))
  14903. (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
  14904. (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
  14905. (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
  14906. (setcar time0 (or (car time0) 0))
  14907. (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
  14908. (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
  14909. (setq time (apply 'encode-time time0))))
  14910. ;; Insert the new time-stamp, and ensure point stays in the same
  14911. ;; category as before (i.e. not after the last position in that
  14912. ;; category).
  14913. (let ((pos (point)))
  14914. ;; Stay before inserted string. `save-excursion' is of no use.
  14915. (setq org-last-changed-timestamp
  14916. (org-insert-time-stamp time with-hm inactive nil nil extra))
  14917. (goto-char pos))
  14918. (save-match-data
  14919. (looking-at org-ts-regexp3)
  14920. (goto-char (cond
  14921. ;; `day' category ends before `hour' if any, or at
  14922. ;; the end of the day name.
  14923. ((eq origin-cat 'day)
  14924. (min (or (match-beginning 7) (1- (match-end 5))) origin))
  14925. ((eq origin-cat 'hour) (min (match-end 7) origin))
  14926. ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
  14927. ((integerp origin-cat) (min (1- (match-end 0)) origin))
  14928. ;; `year' and `month' have both fixed size: point
  14929. ;; couldn't have moved into another part.
  14930. (t origin))))
  14931. ;; Update clock if on a CLOCK line.
  14932. (org-clock-update-time-maybe)
  14933. ;; Try to recenter the calendar window, if any.
  14934. (if (and org-calendar-follow-timestamp-change
  14935. (get-buffer-window "*Calendar*" t)
  14936. (memq org-ts-what '(day month year)))
  14937. (org-recenter-calendar (time-to-days time))))))
  14938. (defun org-modify-ts-extra (s pos n dm)
  14939. "Change the different parts of the lead-time and repeat fields in timestamp."
  14940. (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
  14941. ng h m new rem)
  14942. (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
  14943. (cond
  14944. ((or (org-pos-in-match-range pos 2)
  14945. (org-pos-in-match-range pos 3))
  14946. (setq m (string-to-number (match-string 3 s))
  14947. h (string-to-number (match-string 2 s)))
  14948. (if (org-pos-in-match-range pos 2)
  14949. (setq h (+ h n))
  14950. (setq n (* dm (org-no-warnings (signum n))))
  14951. (when (not (= 0 (setq rem (% m dm))))
  14952. (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
  14953. (setq m (+ m n)))
  14954. (if (< m 0) (setq m (+ m 60) h (1- h)))
  14955. (if (> m 59) (setq m (- m 60) h (1+ h)))
  14956. (setq h (min 24 (max 0 h)))
  14957. (setq ng 1 new (format "-%02d:%02d" h m)))
  14958. ((org-pos-in-match-range pos 6)
  14959. (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
  14960. ((org-pos-in-match-range pos 5)
  14961. (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
  14962. ((org-pos-in-match-range pos 9)
  14963. (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
  14964. ((org-pos-in-match-range pos 8)
  14965. (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
  14966. (when ng
  14967. (setq s (concat
  14968. (substring s 0 (match-beginning ng))
  14969. new
  14970. (substring s (match-end ng))))))
  14971. s))
  14972. (defun org-recenter-calendar (date)
  14973. "If the calendar is visible, recenter it to DATE."
  14974. (let ((cwin (get-buffer-window "*Calendar*" t)))
  14975. (when cwin
  14976. (let ((calendar-move-hook nil))
  14977. (with-selected-window cwin
  14978. (calendar-goto-date (if (listp date) date
  14979. (calendar-gregorian-from-absolute date))))))))
  14980. (defun org-goto-calendar (&optional arg)
  14981. "Go to the Emacs calendar at the current date.
  14982. If there is a time stamp in the current line, go to that date.
  14983. A prefix ARG can be used to force the current date."
  14984. (interactive "P")
  14985. (let ((tsr org-ts-regexp) diff
  14986. (calendar-move-hook nil)
  14987. (calendar-view-holidays-initially-flag nil)
  14988. (calendar-view-diary-initially-flag nil))
  14989. (if (or (org-at-timestamp-p)
  14990. (save-excursion
  14991. (beginning-of-line 1)
  14992. (looking-at (concat ".*" tsr))))
  14993. (let ((d1 (time-to-days (current-time)))
  14994. (d2 (time-to-days
  14995. (org-time-string-to-time (match-string 1)))))
  14996. (setq diff (- d2 d1))))
  14997. (calendar)
  14998. (calendar-goto-today)
  14999. (if (and diff (not arg)) (calendar-forward-day diff))))
  15000. (defun org-get-date-from-calendar ()
  15001. "Return a list (month day year) of date at point in calendar."
  15002. (with-current-buffer "*Calendar*"
  15003. (save-match-data
  15004. (calendar-cursor-to-date))))
  15005. (defun org-date-from-calendar ()
  15006. "Insert time stamp corresponding to cursor date in *Calendar* buffer.
  15007. If there is already a time stamp at the cursor position, update it."
  15008. (interactive)
  15009. (if (org-at-timestamp-p t)
  15010. (org-timestamp-change 0 'calendar)
  15011. (let ((cal-date (org-get-date-from-calendar)))
  15012. (org-insert-time-stamp
  15013. (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
  15014. (defun org-minutes-to-hh:mm-string (m)
  15015. "Compute H:MM from a number of minutes."
  15016. (let ((h (/ m 60)))
  15017. (setq m (- m (* 60 h)))
  15018. (format org-time-clocksum-format h m)))
  15019. (defun org-hh:mm-string-to-minutes (s)
  15020. "Convert a string H:MM to a number of minutes.
  15021. If the string is just a number, interpret it as minutes.
  15022. In fact, the first hh:mm or number in the string will be taken,
  15023. there can be extra stuff in the string.
  15024. If no number is found, the return value is 0."
  15025. (cond
  15026. ((integerp s) s)
  15027. ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
  15028. (+ (* (string-to-number (match-string 1 s)) 60)
  15029. (string-to-number (match-string 2 s))))
  15030. ((string-match "\\([0-9]+\\)" s)
  15031. (string-to-number (match-string 1 s)))
  15032. (t 0)))
  15033. (defcustom org-effort-durations
  15034. `(("h" . 60)
  15035. ("d" . ,(* 60 8))
  15036. ("w" . ,(* 60 8 5))
  15037. ("m" . ,(* 60 8 5 4))
  15038. ("y" . ,(* 60 8 5 40)))
  15039. "Conversion factor to minutes for an effort modifier.
  15040. Each entry has the form (MODIFIER . MINUTES).
  15041. In an effort string, a number followed by MODIFIER is multiplied
  15042. by the specified number of MINUTES to obtain an effort in
  15043. minutes.
  15044. For example, if the value of this variable is ((\"hours\" . 60)), then an
  15045. effort string \"2hours\" is equivalent to 120 minutes."
  15046. :group 'org-agenda
  15047. :version "24.1"
  15048. :type '(alist :key-type (string :tag "Modifier")
  15049. :value-type (number :tag "Minutes")))
  15050. (defun org-duration-string-to-minutes (s &optional output-to-string)
  15051. "Convert a duration string S to minutes.
  15052. A bare number is interpreted as minutes, modifiers can be set by
  15053. customizing `org-effort-durations' (which see).
  15054. Entries containing a colon are interpreted as H:MM by
  15055. `org-hh:mm-string-to-minutes'."
  15056. (let ((result 0)
  15057. (re (concat "\\([0-9.]+\\) *\\("
  15058. (regexp-opt (mapcar 'car org-effort-durations))
  15059. "\\)")))
  15060. (while (string-match re s)
  15061. (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
  15062. (string-to-number (match-string 1 s))))
  15063. (setq s (replace-match "" nil t s)))
  15064. (setq result (floor result))
  15065. (incf result (org-hh:mm-string-to-minutes s))
  15066. (if output-to-string (number-to-string result) result)))
  15067. ;;;; Files
  15068. (defun org-save-all-org-buffers ()
  15069. "Save all Org-mode buffers without user confirmation."
  15070. (interactive)
  15071. (message "Saving all Org-mode buffers...")
  15072. (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
  15073. (when (featurep 'org-id) (org-id-locations-save))
  15074. (message "Saving all Org-mode buffers... done"))
  15075. (defun org-revert-all-org-buffers ()
  15076. "Revert all Org-mode buffers.
  15077. Prompt for confirmation when there are unsaved changes.
  15078. Be sure you know what you are doing before letting this function
  15079. overwrite your changes.
  15080. This function is useful in a setup where one tracks org files
  15081. with a version control system, to revert on one machine after pulling
  15082. changes from another. I believe the procedure must be like this:
  15083. 1. M-x org-save-all-org-buffers
  15084. 2. Pull changes from the other machine, resolve conflicts
  15085. 3. M-x org-revert-all-org-buffers"
  15086. (interactive)
  15087. (unless (yes-or-no-p "Revert all Org buffers from their files? ")
  15088. (error "Abort"))
  15089. (save-excursion
  15090. (save-window-excursion
  15091. (mapc
  15092. (lambda (b)
  15093. (when (and (with-current-buffer b (derived-mode-p 'org-mode))
  15094. (with-current-buffer b buffer-file-name))
  15095. (org-pop-to-buffer-same-window b)
  15096. (revert-buffer t 'no-confirm)))
  15097. (buffer-list))
  15098. (when (and (featurep 'org-id) org-id-track-globally)
  15099. (org-id-locations-load)))))
  15100. ;;;; Agenda files
  15101. ;;;###autoload
  15102. (defun org-switchb (&optional arg)
  15103. "Switch between Org buffers.
  15104. With one prefix argument, restrict available buffers to files.
  15105. With two prefix arguments, restrict available buffers to agenda files.
  15106. Defaults to `iswitchb' for buffer name completion.
  15107. Set `org-completion-use-ido' to make it use ido instead."
  15108. (interactive "P")
  15109. (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
  15110. ((equal arg '(16)) (org-buffer-list 'agenda))
  15111. (t (org-buffer-list))))
  15112. (org-completion-use-iswitchb org-completion-use-iswitchb)
  15113. (org-completion-use-ido org-completion-use-ido))
  15114. (unless (or org-completion-use-ido org-completion-use-iswitchb)
  15115. (setq org-completion-use-iswitchb t))
  15116. (org-pop-to-buffer-same-window
  15117. (org-icompleting-read "Org buffer: "
  15118. (mapcar 'list (mapcar 'buffer-name blist))
  15119. nil t))))
  15120. ;;; Define some older names previously used for this functionality
  15121. ;;;###autoload
  15122. (defalias 'org-ido-switchb 'org-switchb)
  15123. ;;;###autoload
  15124. (defalias 'org-iswitchb 'org-switchb)
  15125. (defun org-buffer-list (&optional predicate exclude-tmp)
  15126. "Return a list of Org buffers.
  15127. PREDICATE can be `export', `files' or `agenda'.
  15128. export restrict the list to Export buffers.
  15129. files restrict the list to buffers visiting Org files.
  15130. agenda restrict the list to buffers visiting agenda files.
  15131. If EXCLUDE-TMP is non-nil, ignore temporary buffers."
  15132. (let* ((bfn nil)
  15133. (agenda-files (and (eq predicate 'agenda)
  15134. (mapcar 'file-truename (org-agenda-files t))))
  15135. (filter
  15136. (cond
  15137. ((eq predicate 'files)
  15138. (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
  15139. ((eq predicate 'export)
  15140. (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
  15141. ((eq predicate 'agenda)
  15142. (lambda (b)
  15143. (with-current-buffer b
  15144. (and (derived-mode-p 'org-mode)
  15145. (setq bfn (buffer-file-name b))
  15146. (member (file-truename bfn) agenda-files)))))
  15147. (t (lambda (b) (with-current-buffer b
  15148. (or (derived-mode-p 'org-mode)
  15149. (string-match "\*Org .*Export"
  15150. (buffer-name b)))))))))
  15151. (delq nil
  15152. (mapcar
  15153. (lambda(b)
  15154. (if (and (funcall filter b)
  15155. (or (not exclude-tmp)
  15156. (not (string-match "tmp" (buffer-name b)))))
  15157. b
  15158. nil))
  15159. (buffer-list)))))
  15160. (defun org-agenda-files (&optional unrestricted archives)
  15161. "Get the list of agenda files.
  15162. Optional UNRESTRICTED means return the full list even if a restriction
  15163. is currently in place.
  15164. When ARCHIVES is t, include all archive files that are really being
  15165. used by the agenda files. If ARCHIVE is `ifmode', do this only if
  15166. `org-agenda-archives-mode' is t."
  15167. (let ((files
  15168. (cond
  15169. ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
  15170. ((stringp org-agenda-files) (org-read-agenda-file-list))
  15171. ((listp org-agenda-files) org-agenda-files)
  15172. (t (error "Invalid value of `org-agenda-files'")))))
  15173. (setq files (apply 'append
  15174. (mapcar (lambda (f)
  15175. (if (file-directory-p f)
  15176. (directory-files
  15177. f t org-agenda-file-regexp)
  15178. (list f)))
  15179. files)))
  15180. (when org-agenda-skip-unavailable-files
  15181. (setq files (delq nil
  15182. (mapcar (function
  15183. (lambda (file)
  15184. (and (file-readable-p file) file)))
  15185. files))))
  15186. (when (or (eq archives t)
  15187. (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
  15188. (setq files (org-add-archive-files files)))
  15189. files))
  15190. (defun org-agenda-file-p (&optional file)
  15191. "Return non-nil, if FILE is an agenda file.
  15192. If FILE is omitted, use the file associated with the current
  15193. buffer."
  15194. (member (or file (buffer-file-name))
  15195. (org-agenda-files t)))
  15196. (defun org-edit-agenda-file-list ()
  15197. "Edit the list of agenda files.
  15198. Depending on setup, this either uses customize to edit the variable
  15199. `org-agenda-files', or it visits the file that is holding the list. In the
  15200. latter case, the buffer is set up in a way that saving it automatically kills
  15201. the buffer and restores the previous window configuration."
  15202. (interactive)
  15203. (if (stringp org-agenda-files)
  15204. (let ((cw (current-window-configuration)))
  15205. (find-file org-agenda-files)
  15206. (org-set-local 'org-window-configuration cw)
  15207. (org-add-hook 'after-save-hook
  15208. (lambda ()
  15209. (set-window-configuration
  15210. (prog1 org-window-configuration
  15211. (kill-buffer (current-buffer))))
  15212. (org-install-agenda-files-menu)
  15213. (message "New agenda file list installed"))
  15214. nil 'local)
  15215. (message "%s" (substitute-command-keys
  15216. "Edit list and finish with \\[save-buffer]")))
  15217. (customize-variable 'org-agenda-files)))
  15218. (defun org-store-new-agenda-file-list (list)
  15219. "Set new value for the agenda file list and save it correctly."
  15220. (if (stringp org-agenda-files)
  15221. (let ((fe (org-read-agenda-file-list t)) b u)
  15222. (while (setq b (find-buffer-visiting org-agenda-files))
  15223. (kill-buffer b))
  15224. (with-temp-file org-agenda-files
  15225. (insert
  15226. (mapconcat
  15227. (lambda (f) ;; Keep un-expanded entries.
  15228. (if (setq u (assoc f fe))
  15229. (cdr u)
  15230. f))
  15231. list "\n")
  15232. "\n")))
  15233. (let ((org-mode-hook nil) (org-inhibit-startup t)
  15234. (org-insert-mode-line-in-empty-file nil))
  15235. (setq org-agenda-files list)
  15236. (customize-save-variable 'org-agenda-files org-agenda-files))))
  15237. (defun org-read-agenda-file-list (&optional pair-with-expansion)
  15238. "Read the list of agenda files from a file.
  15239. If PAIR-WITH-EXPANSION is t return pairs with un-expanded
  15240. filenames, used by `org-store-new-agenda-file-list' to write back
  15241. un-expanded file names."
  15242. (when (file-directory-p org-agenda-files)
  15243. (error "`org-agenda-files' cannot be a single directory"))
  15244. (when (stringp org-agenda-files)
  15245. (with-temp-buffer
  15246. (insert-file-contents org-agenda-files)
  15247. (mapcar
  15248. (lambda (f)
  15249. (let ((e (expand-file-name (substitute-in-file-name f)
  15250. org-directory)))
  15251. (if pair-with-expansion
  15252. (cons e f)
  15253. e)))
  15254. (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
  15255. ;;;###autoload
  15256. (defun org-cycle-agenda-files ()
  15257. "Cycle through the files in `org-agenda-files'.
  15258. If the current buffer visits an agenda file, find the next one in the list.
  15259. If the current buffer does not, find the first agenda file."
  15260. (interactive)
  15261. (let* ((fs (org-agenda-files t))
  15262. (files (append fs (list (car fs))))
  15263. (tcf (if buffer-file-name (file-truename buffer-file-name)))
  15264. file)
  15265. (unless files (error "No agenda files"))
  15266. (catch 'exit
  15267. (while (setq file (pop files))
  15268. (if (equal (file-truename file) tcf)
  15269. (when (car files)
  15270. (find-file (car files))
  15271. (throw 'exit t))))
  15272. (find-file (car fs)))
  15273. (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
  15274. (defun org-agenda-file-to-front (&optional to-end)
  15275. "Move/add the current file to the top of the agenda file list.
  15276. If the file is not present in the list, it is added to the front. If it is
  15277. present, it is moved there. With optional argument TO-END, add/move to the
  15278. end of the list."
  15279. (interactive "P")
  15280. (let ((org-agenda-skip-unavailable-files nil)
  15281. (file-alist (mapcar (lambda (x)
  15282. (cons (file-truename x) x))
  15283. (org-agenda-files t)))
  15284. (ctf (file-truename buffer-file-name))
  15285. x had)
  15286. (setq x (assoc ctf file-alist) had x)
  15287. (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
  15288. (if to-end
  15289. (setq file-alist (append (delq x file-alist) (list x)))
  15290. (setq file-alist (cons x (delq x file-alist))))
  15291. (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
  15292. (org-install-agenda-files-menu)
  15293. (message "File %s to %s of agenda file list"
  15294. (if had "moved" "added") (if to-end "end" "front"))))
  15295. (defun org-remove-file (&optional file)
  15296. "Remove current file from the list of files in variable `org-agenda-files'.
  15297. These are the files which are being checked for agenda entries.
  15298. Optional argument FILE means use this file instead of the current."
  15299. (interactive)
  15300. (let* ((org-agenda-skip-unavailable-files nil)
  15301. (file (or file buffer-file-name))
  15302. (true-file (file-truename file))
  15303. (afile (abbreviate-file-name file))
  15304. (files (delq nil (mapcar
  15305. (lambda (x)
  15306. (if (equal true-file
  15307. (file-truename x))
  15308. nil x))
  15309. (org-agenda-files t)))))
  15310. (if (not (= (length files) (length (org-agenda-files t))))
  15311. (progn
  15312. (org-store-new-agenda-file-list files)
  15313. (org-install-agenda-files-menu)
  15314. (message "Removed file: %s" afile))
  15315. (message "File was not in list: %s (not removed)" afile))))
  15316. (defun org-file-menu-entry (file)
  15317. (vector file (list 'find-file file) t))
  15318. (defun org-check-agenda-file (file)
  15319. "Make sure FILE exists. If not, ask user what to do."
  15320. (when (not (file-exists-p file))
  15321. (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
  15322. (abbreviate-file-name file))
  15323. (let ((r (downcase (read-char-exclusive))))
  15324. (cond
  15325. ((equal r ?r)
  15326. (org-remove-file file)
  15327. (throw 'nextfile t))
  15328. (t (error "Abort"))))))
  15329. (defun org-get-agenda-file-buffer (file)
  15330. "Get a buffer visiting FILE. If the buffer needs to be created, add
  15331. it to the list of buffers which might be released later."
  15332. (let ((buf (org-find-base-buffer-visiting file)))
  15333. (if buf
  15334. buf ; just return it
  15335. ;; Make a new buffer and remember it
  15336. (setq buf (find-file-noselect file))
  15337. (if buf (push buf org-agenda-new-buffers))
  15338. buf)))
  15339. (defun org-release-buffers (blist)
  15340. "Release all buffers in list, asking the user for confirmation when needed.
  15341. When a buffer is unmodified, it is just killed. When modified, it is saved
  15342. \(if the user agrees) and then killed."
  15343. (let (buf file)
  15344. (while (setq buf (pop blist))
  15345. (setq file (buffer-file-name buf))
  15346. (when (and (buffer-modified-p buf)
  15347. file
  15348. (y-or-n-p (format "Save file %s? " file)))
  15349. (with-current-buffer buf (save-buffer)))
  15350. (kill-buffer buf))))
  15351. (defun org-prepare-agenda-buffers (files)
  15352. "Create buffers for all agenda files, protect archived trees and comments."
  15353. (interactive)
  15354. (let ((pa '(:org-archived t))
  15355. (pc '(:org-comment t))
  15356. (pall '(:org-archived t :org-comment t))
  15357. (inhibit-read-only t)
  15358. (rea (concat ":" org-archive-tag ":"))
  15359. bmp file re)
  15360. (save-excursion
  15361. (save-restriction
  15362. (while (setq file (pop files))
  15363. (catch 'nextfile
  15364. (if (bufferp file)
  15365. (set-buffer file)
  15366. (org-check-agenda-file file)
  15367. (set-buffer (org-get-agenda-file-buffer file)))
  15368. (widen)
  15369. (setq bmp (buffer-modified-p))
  15370. (org-refresh-category-properties)
  15371. (setq org-todo-keywords-for-agenda
  15372. (append org-todo-keywords-for-agenda org-todo-keywords-1))
  15373. (setq org-done-keywords-for-agenda
  15374. (append org-done-keywords-for-agenda org-done-keywords))
  15375. (setq org-todo-keyword-alist-for-agenda
  15376. (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
  15377. (setq org-drawers-for-agenda
  15378. (append org-drawers-for-agenda org-drawers))
  15379. (setq org-tag-alist-for-agenda
  15380. (append org-tag-alist-for-agenda org-tag-alist))
  15381. (save-excursion
  15382. (remove-text-properties (point-min) (point-max) pall)
  15383. (when org-agenda-skip-archived-trees
  15384. (goto-char (point-min))
  15385. (while (re-search-forward rea nil t)
  15386. (if (org-at-heading-p t)
  15387. (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
  15388. (goto-char (point-min))
  15389. (setq re (format org-heading-keyword-regexp-format
  15390. org-comment-string))
  15391. (while (re-search-forward re nil t)
  15392. (add-text-properties
  15393. (match-beginning 0) (org-end-of-subtree t) pc)))
  15394. (set-buffer-modified-p bmp)))))
  15395. (setq org-todo-keywords-for-agenda
  15396. (org-uniquify org-todo-keywords-for-agenda))
  15397. (setq org-todo-keyword-alist-for-agenda
  15398. (org-uniquify org-todo-keyword-alist-for-agenda)
  15399. org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
  15400. ;;;; Embedded LaTeX
  15401. (defvar org-cdlatex-mode-map (make-sparse-keymap)
  15402. "Keymap for the minor `org-cdlatex-mode'.")
  15403. (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
  15404. (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
  15405. (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
  15406. (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
  15407. (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
  15408. (defvar org-cdlatex-texmathp-advice-is-done nil
  15409. "Flag remembering if we have applied the advice to texmathp already.")
  15410. (define-minor-mode org-cdlatex-mode
  15411. "Toggle the minor `org-cdlatex-mode'.
  15412. This mode supports entering LaTeX environment and math in LaTeX fragments
  15413. in Org-mode.
  15414. \\{org-cdlatex-mode-map}"
  15415. nil " OCDL" nil
  15416. (when org-cdlatex-mode
  15417. (require 'cdlatex)
  15418. (run-hooks 'cdlatex-mode-hook)
  15419. (cdlatex-compute-tables))
  15420. (unless org-cdlatex-texmathp-advice-is-done
  15421. (setq org-cdlatex-texmathp-advice-is-done t)
  15422. (defadvice texmathp (around org-math-always-on activate)
  15423. "Always return t in org-mode buffers.
  15424. This is because we want to insert math symbols without dollars even outside
  15425. the LaTeX math segments. If Orgmode thinks that point is actually inside
  15426. an embedded LaTeX fragment, let texmathp do its job.
  15427. \\[org-cdlatex-mode-map]"
  15428. (interactive)
  15429. (let (p)
  15430. (cond
  15431. ((not (derived-mode-p 'org-mode)) ad-do-it)
  15432. ((eq this-command 'cdlatex-math-symbol)
  15433. (setq ad-return-value t
  15434. texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
  15435. (t
  15436. (let ((p (org-inside-LaTeX-fragment-p)))
  15437. (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
  15438. (setq ad-return-value t
  15439. texmathp-why '("Org-mode embedded math" . 0))
  15440. (if p ad-do-it)))))))))
  15441. (defun turn-on-org-cdlatex ()
  15442. "Unconditionally turn on `org-cdlatex-mode'."
  15443. (org-cdlatex-mode 1))
  15444. (defun org-inside-LaTeX-fragment-p ()
  15445. "Test if point is inside a LaTeX fragment.
  15446. I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
  15447. sequence appearing also before point.
  15448. Even though the matchers for math are configurable, this function assumes
  15449. that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
  15450. delimiters are skipped when they have been removed by customization.
  15451. The return value is nil, or a cons cell with the delimiter and the
  15452. position of this delimiter.
  15453. This function does a reasonably good job, but can locally be fooled by
  15454. for example currency specifications. For example it will assume being in
  15455. inline math after \"$22.34\". The LaTeX fragment formatter will only format
  15456. fragments that are properly closed, but during editing, we have to live
  15457. with the uncertainty caused by missing closing delimiters. This function
  15458. looks only before point, not after."
  15459. (catch 'exit
  15460. (let ((pos (point))
  15461. (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
  15462. (lim (progn
  15463. (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
  15464. (point)))
  15465. dd-on str (start 0) m re)
  15466. (goto-char pos)
  15467. (when dodollar
  15468. (setq str (concat (buffer-substring lim (point)) "\000 X$.")
  15469. re (nth 1 (assoc "$" org-latex-regexps)))
  15470. (while (string-match re str start)
  15471. (cond
  15472. ((= (match-end 0) (length str))
  15473. (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
  15474. ((= (match-end 0) (- (length str) 5))
  15475. (throw 'exit nil))
  15476. (t (setq start (match-end 0))))))
  15477. (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
  15478. (goto-char pos)
  15479. (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
  15480. (and (match-beginning 2) (throw 'exit nil))
  15481. ;; count $$
  15482. (while (re-search-backward "\\$\\$" lim t)
  15483. (setq dd-on (not dd-on)))
  15484. (goto-char pos)
  15485. (if dd-on (cons "$$" m))))))
  15486. (defun org-inside-latex-macro-p ()
  15487. "Is point inside a LaTeX macro or its arguments?"
  15488. (save-match-data
  15489. (org-in-regexp
  15490. "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
  15491. (defun org-try-cdlatex-tab ()
  15492. "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
  15493. It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
  15494. - inside a LaTeX fragment, or
  15495. - after the first word in a line, where an abbreviation expansion could
  15496. insert a LaTeX environment."
  15497. (when org-cdlatex-mode
  15498. (cond
  15499. ;; Before any word on the line: No expansion possible.
  15500. ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
  15501. ;; Just after first word on the line: Expand it. Make sure it
  15502. ;; cannot happen on headlines, though.
  15503. ((save-excursion
  15504. (skip-chars-backward "a-zA-Z0-9*")
  15505. (skip-chars-backward " \t")
  15506. (and (bolp) (not (org-at-heading-p))))
  15507. (cdlatex-tab) t)
  15508. ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
  15509. (defun org-cdlatex-underscore-caret (&optional arg)
  15510. "Execute `cdlatex-sub-superscript' in LaTeX fragments.
  15511. Revert to the normal definition outside of these fragments."
  15512. (interactive "P")
  15513. (if (org-inside-LaTeX-fragment-p)
  15514. (call-interactively 'cdlatex-sub-superscript)
  15515. (let (org-cdlatex-mode)
  15516. (call-interactively (key-binding (vector last-input-event))))))
  15517. (defun org-cdlatex-math-modify (&optional arg)
  15518. "Execute `cdlatex-math-modify' in LaTeX fragments.
  15519. Revert to the normal definition outside of these fragments."
  15520. (interactive "P")
  15521. (if (org-inside-LaTeX-fragment-p)
  15522. (call-interactively 'cdlatex-math-modify)
  15523. (let (org-cdlatex-mode)
  15524. (call-interactively (key-binding (vector last-input-event))))))
  15525. (defvar org-latex-fragment-image-overlays nil
  15526. "List of overlays carrying the images of latex fragments.")
  15527. (make-variable-buffer-local 'org-latex-fragment-image-overlays)
  15528. (defun org-remove-latex-fragment-image-overlays ()
  15529. "Remove all overlays with LaTeX fragment images in current buffer."
  15530. (mapc 'delete-overlay org-latex-fragment-image-overlays)
  15531. (setq org-latex-fragment-image-overlays nil))
  15532. (defun org-preview-latex-fragment (&optional subtree)
  15533. "Preview the LaTeX fragment at point, or all locally or globally.
  15534. If the cursor is in a LaTeX fragment, create the image and overlay
  15535. it over the source code. If there is no fragment at point, display
  15536. all fragments in the current text, from one headline to the next. With
  15537. prefix SUBTREE, display all fragments in the current subtree. With a
  15538. double prefix arg \\[universal-argument] \\[universal-argument], or when \
  15539. the cursor is before the first headline,
  15540. display all fragments in the buffer.
  15541. The images can be removed again with \\[org-ctrl-c-ctrl-c]."
  15542. (interactive "P")
  15543. (unless buffer-file-name
  15544. (error "Can't preview LaTeX fragment in a non-file buffer"))
  15545. (org-remove-latex-fragment-image-overlays)
  15546. (save-excursion
  15547. (save-restriction
  15548. (let (beg end at msg)
  15549. (cond
  15550. ((or (equal subtree '(16))
  15551. (not (save-excursion
  15552. (re-search-backward org-outline-regexp-bol nil t))))
  15553. (setq beg (point-min) end (point-max)
  15554. msg "Creating images for buffer...%s"))
  15555. ((equal subtree '(4))
  15556. (org-back-to-heading)
  15557. (setq beg (point) end (org-end-of-subtree t)
  15558. msg "Creating images for subtree...%s"))
  15559. (t
  15560. (if (setq at (org-inside-LaTeX-fragment-p))
  15561. (goto-char (max (point-min) (- (cdr at) 2)))
  15562. (org-back-to-heading))
  15563. (setq beg (point) end (progn (outline-next-heading) (point))
  15564. msg (if at "Creating image...%s"
  15565. "Creating images for entry...%s"))))
  15566. (message msg "")
  15567. (narrow-to-region beg end)
  15568. (goto-char beg)
  15569. (org-format-latex
  15570. (concat "ltxpng/" (file-name-sans-extension
  15571. (file-name-nondirectory
  15572. buffer-file-name)))
  15573. default-directory 'overlays msg at 'forbuffer
  15574. org-latex-create-formula-image-program)
  15575. (message msg "done. Use `C-c C-c' to remove images.")))))
  15576. (defvar org-latex-regexps
  15577. '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
  15578. ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
  15579. ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
  15580. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  15581. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  15582. ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
  15583. ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
  15584. ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
  15585. "Regular expressions for matching embedded LaTeX.")
  15586. (defvar org-export-have-math nil) ;; dynamic scoping
  15587. (defun org-format-latex (prefix &optional dir overlays msg at
  15588. forbuffer processing-type)
  15589. "Replace LaTeX fragments with links to an image, and produce images.
  15590. Some of the options can be changed using the variable
  15591. `org-format-latex-options'."
  15592. (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
  15593. (let* ((prefixnodir (file-name-nondirectory prefix))
  15594. (absprefix (expand-file-name prefix dir))
  15595. (todir (file-name-directory absprefix))
  15596. (opt org-format-latex-options)
  15597. (matchers (plist-get opt :matchers))
  15598. (re-list org-latex-regexps)
  15599. (org-format-latex-header-extra
  15600. (plist-get (org-infile-export-plist) :latex-header-extra))
  15601. (cnt 0) txt hash link beg end re e checkdir
  15602. executables-checked string
  15603. m n block-type block linkfile movefile ov)
  15604. ;; Check the different regular expressions
  15605. (while (setq e (pop re-list))
  15606. (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
  15607. block (if block-type "\n\n" ""))
  15608. (when (member m matchers)
  15609. (goto-char (point-min))
  15610. (while (re-search-forward re nil t)
  15611. (when (and (or (not at) (equal (cdr at) (match-beginning n)))
  15612. (not (get-text-property (match-beginning n)
  15613. 'org-protected))
  15614. (or (not overlays)
  15615. (not (eq (get-char-property (match-beginning n)
  15616. 'org-overlay-type)
  15617. 'org-latex-overlay))))
  15618. (setq org-export-have-math t)
  15619. (cond
  15620. ((eq processing-type 'verbatim)
  15621. ;; Leave the text verbatim, just protect it
  15622. (add-text-properties (match-beginning n) (match-end n)
  15623. '(org-protected t)))
  15624. ((eq processing-type 'mathjax)
  15625. ;; Prepare for MathJax processing
  15626. (setq string (match-string n))
  15627. (if (member m '("$" "$1"))
  15628. (save-excursion
  15629. (delete-region (match-beginning n) (match-end n))
  15630. (goto-char (match-beginning n))
  15631. (insert (org-add-props (concat "\\(" (substring string 1 -1)
  15632. "\\)")
  15633. '(org-protected t))))
  15634. (add-text-properties (match-beginning n) (match-end n)
  15635. '(org-protected t))))
  15636. ((or (eq processing-type 'dvipng)
  15637. (eq processing-type 'imagemagick))
  15638. ;; Process to an image
  15639. (setq txt (match-string n)
  15640. beg (match-beginning n) end (match-end n)
  15641. cnt (1+ cnt))
  15642. (let (print-length print-level) ; make sure full list is printed
  15643. (setq hash (sha1 (prin1-to-string
  15644. (list org-format-latex-header
  15645. org-format-latex-header-extra
  15646. org-export-latex-default-packages-alist
  15647. org-export-latex-packages-alist
  15648. org-format-latex-options
  15649. forbuffer txt)))
  15650. linkfile (format "%s_%s.png" prefix hash)
  15651. movefile (format "%s_%s.png" absprefix hash)))
  15652. (setq link (concat block "[[file:" linkfile "]]" block))
  15653. (if msg (message msg cnt))
  15654. (goto-char beg)
  15655. (unless checkdir ; make sure the directory exists
  15656. (setq checkdir t)
  15657. (or (file-directory-p todir) (make-directory todir t)))
  15658. (cond
  15659. ((eq processing-type 'dvipng)
  15660. (unless executables-checked
  15661. (org-check-external-command
  15662. "latex" "needed to convert LaTeX fragments to images")
  15663. (org-check-external-command
  15664. "dvipng" "needed to convert LaTeX fragments to images")
  15665. (setq executables-checked t))
  15666. (unless (file-exists-p movefile)
  15667. (org-create-formula-image-with-dvipng
  15668. txt movefile opt forbuffer)))
  15669. ((eq processing-type 'imagemagick)
  15670. (unless executables-checked
  15671. (org-check-external-command
  15672. "convert" "you need to install imagemagick")
  15673. (setq executables-checked t))
  15674. (unless (file-exists-p movefile)
  15675. (org-create-formula-image-with-imagemagick
  15676. txt movefile opt forbuffer))))
  15677. (if overlays
  15678. (progn
  15679. (mapc (lambda (o)
  15680. (if (eq (overlay-get o 'org-overlay-type)
  15681. 'org-latex-overlay)
  15682. (delete-overlay o)))
  15683. (overlays-in beg end))
  15684. (setq ov (make-overlay beg end))
  15685. (overlay-put ov 'org-overlay-type 'org-latex-overlay)
  15686. (if (featurep 'xemacs)
  15687. (progn
  15688. (overlay-put ov 'invisible t)
  15689. (overlay-put
  15690. ov 'end-glyph
  15691. (make-glyph (vector 'png :file movefile))))
  15692. (overlay-put
  15693. ov 'display
  15694. (list 'image :type 'png :file movefile :ascent 'center)))
  15695. (push ov org-latex-fragment-image-overlays)
  15696. (goto-char end))
  15697. (delete-region beg end)
  15698. (insert (org-add-props link
  15699. (list 'org-latex-src
  15700. (replace-regexp-in-string
  15701. "\"" "" txt)
  15702. 'org-latex-src-embed-type
  15703. (if block-type 'paragraph 'character))))))
  15704. ((eq processing-type 'mathml)
  15705. ;; Process to MathML
  15706. (unless executables-checked
  15707. (unless (save-match-data (org-format-latex-mathml-available-p))
  15708. (error "LaTeX to MathML converter not configured"))
  15709. (setq executables-checked t))
  15710. (setq txt (match-string n)
  15711. beg (match-beginning n) end (match-end n)
  15712. cnt (1+ cnt))
  15713. (if msg (message msg cnt))
  15714. (goto-char beg)
  15715. (delete-region beg end)
  15716. (insert (org-format-latex-as-mathml
  15717. txt block-type prefix dir)))
  15718. (t
  15719. (error "Unknown conversion type %s for latex fragments"
  15720. processing-type)))))))))
  15721. (defun org-create-math-formula (latex-frag &optional mathml-file)
  15722. "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
  15723. Use `org-latex-to-mathml-convert-command'. If the conversion is
  15724. sucessful, return the portion between \"<math...> </math>\"
  15725. elements otherwise return nil. When MATHML-FILE is specified,
  15726. write the results in to that file. When invoked as an
  15727. interactive command, prompt for LATEX-FRAG, with initial value
  15728. set to the current active region and echo the results for user
  15729. inspection."
  15730. (interactive (list (let ((frag (when (region-active-p)
  15731. (buffer-substring-no-properties
  15732. (region-beginning) (region-end)))))
  15733. (read-string "LaTeX Fragment: " frag nil frag))))
  15734. (unless latex-frag (error "Invalid latex-frag"))
  15735. (let* ((tmp-in-file (file-relative-name
  15736. (make-temp-name (expand-file-name "ltxmathml-in"))))
  15737. (ignore (write-region latex-frag nil tmp-in-file))
  15738. (tmp-out-file (file-relative-name
  15739. (make-temp-name (expand-file-name "ltxmathml-out"))))
  15740. (cmd (format-spec
  15741. org-latex-to-mathml-convert-command
  15742. `((?j . ,(shell-quote-argument
  15743. (expand-file-name org-latex-to-mathml-jar-file)))
  15744. (?I . ,(shell-quote-argument tmp-in-file))
  15745. (?o . ,(shell-quote-argument tmp-out-file)))))
  15746. mathml shell-command-output)
  15747. (when (org-called-interactively-p 'any)
  15748. (unless (org-format-latex-mathml-available-p)
  15749. (error "LaTeX to MathML converter not configured")))
  15750. (message "Running %s" cmd)
  15751. (setq shell-command-output (shell-command-to-string cmd))
  15752. (setq mathml
  15753. (when (file-readable-p tmp-out-file)
  15754. (with-current-buffer (find-file-noselect tmp-out-file t)
  15755. (goto-char (point-min))
  15756. (when (re-search-forward
  15757. (concat
  15758. (regexp-quote
  15759. "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
  15760. "\\(.\\|\n\\)*"
  15761. (regexp-quote "</math>")) nil t)
  15762. (prog1 (match-string 0) (kill-buffer))))))
  15763. (cond
  15764. (mathml
  15765. (setq mathml
  15766. (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
  15767. (when mathml-file
  15768. (write-region mathml nil mathml-file))
  15769. (when (org-called-interactively-p 'any)
  15770. (message mathml)))
  15771. ((message "LaTeX to MathML conversion failed")
  15772. (message shell-command-output)))
  15773. (delete-file tmp-in-file)
  15774. (when (file-exists-p tmp-out-file)
  15775. (delete-file tmp-out-file))
  15776. mathml))
  15777. (defun org-format-latex-as-mathml (latex-frag latex-frag-type
  15778. prefix &optional dir)
  15779. "Use `org-create-math-formula' but check local cache first."
  15780. (let* ((absprefix (expand-file-name prefix dir))
  15781. (print-length nil) (print-level nil)
  15782. (formula-id (concat
  15783. "formula-"
  15784. (sha1
  15785. (prin1-to-string
  15786. (list latex-frag
  15787. org-latex-to-mathml-convert-command)))))
  15788. (formula-cache (format "%s-%s.mathml" absprefix formula-id))
  15789. (formula-cache-dir (file-name-directory formula-cache)))
  15790. (unless (file-directory-p formula-cache-dir)
  15791. (make-directory formula-cache-dir t))
  15792. (unless (file-exists-p formula-cache)
  15793. (org-create-math-formula latex-frag formula-cache))
  15794. (if (file-exists-p formula-cache)
  15795. ;; Successful conversion. Return the link to MathML file.
  15796. (org-add-props
  15797. (format "[[file:%s]]" (file-relative-name formula-cache dir))
  15798. (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
  15799. 'org-latex-src-embed-type (if latex-frag-type
  15800. 'paragraph 'character)))
  15801. ;; Failed conversion. Return the LaTeX fragment verbatim
  15802. (add-text-properties
  15803. 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
  15804. latex-frag)))
  15805. ;; This function borrows from Ganesh Swami's latex2png.el
  15806. (defun org-create-formula-image-with-dvipng (string tofile options buffer)
  15807. "This calls dvipng."
  15808. (require 'org-latex)
  15809. (let* ((tmpdir (if (featurep 'xemacs)
  15810. (temp-directory)
  15811. temporary-file-directory))
  15812. (texfilebase (make-temp-name
  15813. (expand-file-name "orgtex" tmpdir)))
  15814. (texfile (concat texfilebase ".tex"))
  15815. (dvifile (concat texfilebase ".dvi"))
  15816. (pngfile (concat texfilebase ".png"))
  15817. (fnh (if (featurep 'xemacs)
  15818. (font-height (face-font 'default))
  15819. (face-attribute 'default :height nil)))
  15820. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  15821. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  15822. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  15823. "Black"))
  15824. (bg (or (plist-get options (if buffer :background :html-background))
  15825. "Transparent")))
  15826. (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
  15827. (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
  15828. (with-temp-file texfile
  15829. (insert (org-splice-latex-header
  15830. org-format-latex-header
  15831. org-export-latex-default-packages-alist
  15832. org-export-latex-packages-alist t
  15833. org-format-latex-header-extra))
  15834. (insert "\n\\begin{document}\n" string "\n\\end{document}\n")
  15835. (require 'org-latex)
  15836. (org-export-latex-fix-inputenc))
  15837. (let ((dir default-directory))
  15838. (condition-case nil
  15839. (progn
  15840. (cd tmpdir)
  15841. (call-process "latex" nil nil nil texfile))
  15842. (error nil))
  15843. (cd dir))
  15844. (if (not (file-exists-p dvifile))
  15845. (progn (message "Failed to create dvi file from %s" texfile) nil)
  15846. (condition-case nil
  15847. (if (featurep 'xemacs)
  15848. (call-process "dvipng" nil nil nil
  15849. "-fg" fg "-bg" bg
  15850. "-T" "tight"
  15851. "-o" pngfile
  15852. dvifile)
  15853. (call-process "dvipng" nil nil nil
  15854. "-fg" fg "-bg" bg
  15855. "-D" dpi
  15856. ;;"-x" scale "-y" scale
  15857. "-T" "tight"
  15858. "-o" pngfile
  15859. dvifile))
  15860. (error nil))
  15861. (if (not (file-exists-p pngfile))
  15862. (if org-format-latex-signal-error
  15863. (error "Failed to create png file from %s" texfile)
  15864. (message "Failed to create png file from %s" texfile)
  15865. nil)
  15866. ;; Use the requested file name and clean up
  15867. (copy-file pngfile tofile 'replace)
  15868. (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
  15869. (if (file-exists-p (concat texfilebase e))
  15870. (delete-file (concat texfilebase e))))
  15871. pngfile))))
  15872. (defvar org-latex-to-pdf-process) ;; Defined in org-latex.el
  15873. (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
  15874. "This calls convert, which is included into imagemagick."
  15875. (require 'org-latex)
  15876. (let* ((tmpdir (if (featurep 'xemacs)
  15877. (temp-directory)
  15878. temporary-file-directory))
  15879. (texfilebase (make-temp-name
  15880. (expand-file-name "orgtex" tmpdir)))
  15881. (texfile (concat texfilebase ".tex"))
  15882. (pdffile (concat texfilebase ".pdf"))
  15883. (pngfile (concat texfilebase ".png"))
  15884. (fnh (if (featurep 'xemacs)
  15885. (font-height (face-font 'default))
  15886. (face-attribute 'default :height nil)))
  15887. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  15888. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  15889. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  15890. "black"))
  15891. (bg (or (plist-get options (if buffer :background :html-background))
  15892. "white")))
  15893. (if (eq fg 'default) (setq fg (org-latex-color :foreground))
  15894. (setq fg (org-latex-color-format fg)))
  15895. (if (eq bg 'default) (setq bg (org-latex-color :background))
  15896. (setq bg (org-latex-color-format
  15897. (if (string= bg "Transparent")(setq bg "white")))))
  15898. (with-temp-file texfile
  15899. (insert (org-splice-latex-header
  15900. org-format-latex-header
  15901. org-export-latex-default-packages-alist
  15902. org-export-latex-packages-alist t
  15903. org-format-latex-header-extra))
  15904. (insert "\n\\begin{document}\n"
  15905. "\\definecolor{fg}{rgb}{" fg "}\n"
  15906. "\\definecolor{bg}{rgb}{" bg "}\n"
  15907. "\n\\pagecolor{bg}\n"
  15908. "\n{\\color{fg}\n"
  15909. string
  15910. "\n}\n"
  15911. "\n\\end{document}\n" )
  15912. (require 'org-latex)
  15913. (org-export-latex-fix-inputenc))
  15914. (let ((dir default-directory) cmd cmds latex-frags-cmds)
  15915. (condition-case nil
  15916. (progn
  15917. (cd tmpdir)
  15918. (setq cmds org-latex-to-pdf-process)
  15919. (while cmds
  15920. (setq latex-frags-cmds (pop cmds))
  15921. (if (listp latex-frags-cmds)
  15922. (setq cmds nil)
  15923. (setq latex-frags-cmds (list (car org-latex-to-pdf-process)))))
  15924. (while latex-frags-cmds
  15925. (setq cmd (pop latex-frags-cmds))
  15926. (while (string-match "%b" cmd)
  15927. (setq cmd (replace-match
  15928. (save-match-data
  15929. (shell-quote-argument texfile))
  15930. t t cmd)))
  15931. (while (string-match "%f" cmd)
  15932. (setq cmd (replace-match
  15933. (save-match-data
  15934. (shell-quote-argument (file-name-nondirectory texfile)))
  15935. t t cmd)))
  15936. (while (string-match "%o" cmd)
  15937. (setq cmd (replace-match
  15938. (save-match-data
  15939. (shell-quote-argument (file-name-directory texfile)))
  15940. t t cmd)))
  15941. (setq cmd (split-string cmd))
  15942. (eval (append (list 'call-process (pop cmd) nil nil nil) cmd))))
  15943. (error nil))
  15944. (cd dir))
  15945. (if (not (file-exists-p pdffile))
  15946. (progn (message "Failed to create pdf file from %s" texfile) nil)
  15947. (condition-case nil
  15948. (if (featurep 'xemacs)
  15949. (call-process "convert" nil nil nil
  15950. "-density" "96"
  15951. "-trim"
  15952. "-antialias"
  15953. pdffile
  15954. "-quality" "100"
  15955. ;; "-sharpen" "0x1.0"
  15956. pngfile)
  15957. (call-process "convert" nil nil nil
  15958. "-density" dpi
  15959. "-trim"
  15960. "-antialias"
  15961. pdffile
  15962. "-quality" "100"
  15963. ; "-sharpen" "0x1.0"
  15964. pngfile))
  15965. (error nil))
  15966. (if (not (file-exists-p pngfile))
  15967. (if org-format-latex-signal-error
  15968. (error "Failed to create png file from %s" texfile)
  15969. (message "Failed to create png file from %s" texfile)
  15970. nil)
  15971. ;; Use the requested file name and clean up
  15972. (copy-file pngfile tofile 'replace)
  15973. (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
  15974. (if (file-exists-p (concat texfilebase e))
  15975. (delete-file (concat texfilebase e))))
  15976. pngfile))))
  15977. (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
  15978. "Fill a LaTeX header template TPL.
  15979. In the template, the following place holders will be recognized:
  15980. [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
  15981. [NO-DEFAULT-PACKAGES] do not include DEF-PKG
  15982. [PACKAGES] \\usepackage statements for PKG
  15983. [NO-PACKAGES] do not include PKG
  15984. [EXTRA] the string EXTRA
  15985. [NO-EXTRA] do not include EXTRA
  15986. For backward compatibility, if both the positive and the negative place
  15987. holder is missing, the positive one (without the \"NO-\") will be
  15988. assumed to be present at the end of the template.
  15989. DEF-PKG and PKG are assumed to be alists of options/packagename lists.
  15990. EXTRA is a string.
  15991. SNIPPETS-P indicates if this is run to create snippet images for HTML."
  15992. (let (rpl (end ""))
  15993. (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
  15994. (setq rpl (if (or (match-end 1) (not def-pkg))
  15995. "" (org-latex-packages-to-string def-pkg snippets-p t))
  15996. tpl (replace-match rpl t t tpl))
  15997. (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
  15998. (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
  15999. (setq rpl (if (or (match-end 1) (not pkg))
  16000. "" (org-latex-packages-to-string pkg snippets-p t))
  16001. tpl (replace-match rpl t t tpl))
  16002. (if pkg (setq end
  16003. (concat end "\n"
  16004. (org-latex-packages-to-string pkg snippets-p)))))
  16005. (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
  16006. (setq rpl (if (or (match-end 1) (not extra))
  16007. "" (concat extra "\n"))
  16008. tpl (replace-match rpl t t tpl))
  16009. (if (and extra (string-match "\\S-" extra))
  16010. (setq end (concat end "\n" extra))))
  16011. (if (string-match "\\S-" end)
  16012. (concat tpl "\n" end)
  16013. tpl)))
  16014. (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
  16015. "Turn an alist of packages into a string with the \\usepackage macros."
  16016. (setq pkg (mapconcat (lambda(p)
  16017. (cond
  16018. ((stringp p) p)
  16019. ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
  16020. (format "%% Package %s omitted" (cadr p)))
  16021. ((equal "" (car p))
  16022. (format "\\usepackage{%s}" (cadr p)))
  16023. (t
  16024. (format "\\usepackage[%s]{%s}"
  16025. (car p) (cadr p)))))
  16026. pkg
  16027. "\n"))
  16028. (if newline (concat pkg "\n") pkg))
  16029. (defun org-dvipng-color (attr)
  16030. "Return a RGB color specification for dvipng."
  16031. (apply 'format "rgb %s %s %s"
  16032. (mapcar 'org-normalize-color
  16033. (if (featurep 'xemacs)
  16034. (color-rgb-components
  16035. (face-property 'default
  16036. (cond ((eq attr :foreground) 'foreground)
  16037. ((eq attr :background) 'background))))
  16038. (color-values (face-attribute 'default attr nil))))))
  16039. (defun org-latex-color (attr)
  16040. "Return a RGB color for the LaTeX color package."
  16041. (apply 'format "%s,%s,%s"
  16042. (mapcar 'org-normalize-color
  16043. (if (featurep 'xemacs)
  16044. (color-rgb-components
  16045. (face-property 'default
  16046. (cond ((eq attr :foreground) 'foreground)
  16047. ((eq attr :background) 'background))))
  16048. (color-values (face-attribute 'default attr nil))))))
  16049. (defun org-latex-color-format (color-name)
  16050. "Convert COLOR-NAME to a RGB color value."
  16051. (apply 'format "%s,%s,%s"
  16052. (mapcar 'org-normalize-color
  16053. (color-values color-name))))
  16054. (defun org-normalize-color (value)
  16055. "Return string to be used as color value for an RGB component."
  16056. (format "%g" (/ value 65535.0)))
  16057. ;; Image display
  16058. (defvar org-inline-image-overlays nil)
  16059. (make-variable-buffer-local 'org-inline-image-overlays)
  16060. (defun org-toggle-inline-images (&optional include-linked)
  16061. "Toggle the display of inline images.
  16062. INCLUDE-LINKED is passed to `org-display-inline-images'."
  16063. (interactive "P")
  16064. (if org-inline-image-overlays
  16065. (progn
  16066. (org-remove-inline-images)
  16067. (message "Inline image display turned off"))
  16068. (org-display-inline-images include-linked)
  16069. (if org-inline-image-overlays
  16070. (message "%d images displayed inline"
  16071. (length org-inline-image-overlays))
  16072. (message "No images to display inline"))))
  16073. (defun org-display-inline-images (&optional include-linked refresh beg end)
  16074. "Display inline images.
  16075. Normally only links without a description part are inlined, because this
  16076. is how it will work for export. When INCLUDE-LINKED is set, also links
  16077. with a description part will be inlined. This can be nice for a quick
  16078. look at those images, but it does not reflect what exported files will look
  16079. like.
  16080. When REFRESH is set, refresh existing images between BEG and END.
  16081. This will create new image displays only if necessary.
  16082. BEG and END default to the buffer boundaries."
  16083. (interactive "P")
  16084. (unless refresh
  16085. (org-remove-inline-images)
  16086. (if (fboundp 'clear-image-cache) (clear-image-cache)))
  16087. (save-excursion
  16088. (save-restriction
  16089. (widen)
  16090. (setq beg (or beg (point-min)) end (or end (point-max)))
  16091. (goto-char beg)
  16092. (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([^]\n]+?"
  16093. (substring (org-image-file-name-regexp) 0 -2)
  16094. "\\)\\]" (if include-linked "" "\\]")))
  16095. old file ov img)
  16096. (while (re-search-forward re end t)
  16097. (setq old (get-char-property-and-overlay (match-beginning 1)
  16098. 'org-image-overlay))
  16099. (setq file (expand-file-name
  16100. (concat (or (match-string 3) "") (match-string 4))))
  16101. (when (file-exists-p file)
  16102. (if (and (car-safe old) refresh)
  16103. (image-refresh (overlay-get (cdr old) 'display))
  16104. (setq img (save-match-data (create-image file)))
  16105. (when img
  16106. (setq ov (make-overlay (match-beginning 0) (match-end 0)))
  16107. (overlay-put ov 'display img)
  16108. (overlay-put ov 'face 'default)
  16109. (overlay-put ov 'org-image-overlay t)
  16110. (overlay-put ov 'modification-hooks
  16111. (list 'org-display-inline-modification-hook))
  16112. (push ov org-inline-image-overlays)))))))))
  16113. (defun org-display-inline-modification-hook (ov after beg end &optional len)
  16114. "Remove inline-display overlay if a corresponding region is modified."
  16115. (let ((inhibit-modification-hooks t))
  16116. (when (and ov after)
  16117. (delete ov org-inline-image-overlays)
  16118. (delete-overlay ov))))
  16119. (defun org-remove-inline-images ()
  16120. "Remove inline display of images."
  16121. (interactive)
  16122. (mapc 'delete-overlay org-inline-image-overlays)
  16123. (setq org-inline-image-overlays nil))
  16124. ;;;; Key bindings
  16125. ;; Outline functions from `outline-mode-prefix-map'
  16126. ;; that can be remapped in Org:
  16127. (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
  16128. (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
  16129. (define-key org-mode-map [remap outline-forward-same-level]
  16130. 'org-forward-same-level)
  16131. (define-key org-mode-map [remap outline-backward-same-level]
  16132. 'org-backward-same-level)
  16133. (define-key org-mode-map [remap show-branches]
  16134. 'org-kill-note-or-show-branches)
  16135. (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
  16136. (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
  16137. (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
  16138. ;; Outline functions from `outline-mode-prefix-map' that can not
  16139. ;; be remapped in Org:
  16140. ;;
  16141. ;; - the column "key binding" shows whether the Outline function is still
  16142. ;; available in Org mode on the same key that it has been bound to in
  16143. ;; Outline mode:
  16144. ;; - "overridden": key used for a different functionality in Org mode
  16145. ;; - else: key still bound to the same Outline function in Org mode
  16146. ;;
  16147. ;; | Outline function | key binding | Org replacement |
  16148. ;; |------------------------------------+-------------+-----------------------|
  16149. ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
  16150. ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
  16151. ;; | `outline-up-heading' | `C-c C-u' | still same function |
  16152. ;; | `outline-move-subtree-up' | `C-c C-^' | better: org-shiftup |
  16153. ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
  16154. ;; | `show-entry' | overridden | no replacement |
  16155. ;; | `show-children' | `C-c C-i' | visibility cycling |
  16156. ;; | `show-branches' | `C-c C-k' | still same function |
  16157. ;; | `show-subtree' | overridden | visibility cycling |
  16158. ;; | `show-all' | overridden | no replacement |
  16159. ;; | `hide-subtree' | overridden | visibility cycling |
  16160. ;; | `hide-body' | overridden | no replacement |
  16161. ;; | `hide-entry' | overridden | visibility cycling |
  16162. ;; | `hide-leaves' | overridden | no replacement |
  16163. ;; | `hide-sublevels' | overridden | no replacement |
  16164. ;; | `hide-other' | overridden | no replacement |
  16165. ;; Make `C-c C-x' a prefix key
  16166. (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
  16167. ;; TAB key with modifiers
  16168. (org-defkey org-mode-map "\C-i" 'org-cycle)
  16169. (org-defkey org-mode-map [(tab)] 'org-cycle)
  16170. (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
  16171. (org-defkey org-mode-map "\M-\t" 'pcomplete)
  16172. ;; The following line is necessary under Suse GNU/Linux
  16173. (unless (featurep 'xemacs)
  16174. (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
  16175. (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
  16176. (define-key org-mode-map [backtab] 'org-shifttab)
  16177. (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
  16178. (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
  16179. (org-defkey org-mode-map [(meta return)] 'org-meta-return)
  16180. ;; Cursor keys with modifiers
  16181. (org-defkey org-mode-map [(meta left)] 'org-metaleft)
  16182. (org-defkey org-mode-map [(meta right)] 'org-metaright)
  16183. (org-defkey org-mode-map [(meta up)] 'org-metaup)
  16184. (org-defkey org-mode-map [(meta down)] 'org-metadown)
  16185. (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
  16186. (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
  16187. (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
  16188. (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
  16189. (org-defkey org-mode-map [(shift up)] 'org-shiftup)
  16190. (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
  16191. (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
  16192. (org-defkey org-mode-map [(shift right)] 'org-shiftright)
  16193. (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
  16194. (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
  16195. (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
  16196. (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
  16197. ;; Babel keys
  16198. (define-key org-mode-map org-babel-key-prefix org-babel-map)
  16199. (mapc (lambda (pair)
  16200. (define-key org-babel-map (car pair) (cdr pair)))
  16201. org-babel-key-bindings)
  16202. ;;; Extra keys for tty access.
  16203. ;; We only set them when really needed because otherwise the
  16204. ;; menus don't show the simple keys
  16205. (when (or org-use-extra-keys
  16206. (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
  16207. (not window-system))
  16208. (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
  16209. (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
  16210. (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
  16211. (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
  16212. (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
  16213. (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
  16214. (org-defkey org-mode-map [?\e (right)] 'org-metaright)
  16215. (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
  16216. (org-defkey org-mode-map [?\e (up)] 'org-metaup)
  16217. (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
  16218. (org-defkey org-mode-map [?\e (down)] 'org-metadown)
  16219. (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
  16220. (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
  16221. (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
  16222. (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
  16223. (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
  16224. (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
  16225. (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
  16226. (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
  16227. (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
  16228. (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
  16229. (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
  16230. (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
  16231. (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
  16232. (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
  16233. (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
  16234. (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
  16235. (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
  16236. ;; All the other keys
  16237. (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
  16238. (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
  16239. (if (boundp 'narrow-map)
  16240. (org-defkey narrow-map "s" 'org-narrow-to-subtree)
  16241. (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
  16242. (if (boundp 'narrow-map)
  16243. (org-defkey narrow-map "b" 'org-narrow-to-block)
  16244. (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
  16245. (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
  16246. (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
  16247. (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
  16248. (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
  16249. (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
  16250. (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
  16251. (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
  16252. (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
  16253. (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
  16254. (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
  16255. (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
  16256. (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
  16257. (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
  16258. (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
  16259. (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
  16260. (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
  16261. (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
  16262. (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
  16263. (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
  16264. (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
  16265. (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
  16266. (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
  16267. (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
  16268. (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
  16269. (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
  16270. (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
  16271. (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
  16272. (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
  16273. (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
  16274. (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
  16275. (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
  16276. (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
  16277. (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
  16278. (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
  16279. (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
  16280. (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
  16281. (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
  16282. (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
  16283. (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
  16284. (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
  16285. (org-defkey org-mode-map "\C-c]" 'org-remove-file)
  16286. (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
  16287. (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  16288. (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
  16289. (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
  16290. (org-defkey org-mode-map "\C-c^" 'org-sort)
  16291. (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
  16292. (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
  16293. (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
  16294. (org-defkey org-mode-map "\C-m" 'org-return)
  16295. (org-defkey org-mode-map "\C-j" 'org-return-indent)
  16296. (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
  16297. (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
  16298. (org-defkey org-mode-map "\C-c+" 'org-table-sum)
  16299. (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
  16300. (org-defkey org-mode-map "\C-c'" 'org-edit-special)
  16301. (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
  16302. (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
  16303. (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
  16304. (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
  16305. (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
  16306. (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
  16307. (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
  16308. (org-defkey org-mode-map "\C-c\C-e" 'org-export)
  16309. (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
  16310. (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
  16311. (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
  16312. (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  16313. (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  16314. (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
  16315. (org-defkey org-mode-map "\C-c\C-@" 'org-mark-list)
  16316. (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
  16317. ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
  16318. (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
  16319. (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
  16320. (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
  16321. (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
  16322. (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
  16323. (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
  16324. (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
  16325. (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
  16326. (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  16327. (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
  16328. (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
  16329. (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
  16330. (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
  16331. (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
  16332. (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
  16333. (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
  16334. (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
  16335. (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
  16336. (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
  16337. (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
  16338. (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
  16339. (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
  16340. (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
  16341. (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
  16342. (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
  16343. (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
  16344. (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
  16345. (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
  16346. (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
  16347. (define-key org-mode-map "\C-c\C-x!" 'org-reload)
  16348. (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
  16349. (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
  16350. (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
  16351. (when (featurep 'xemacs)
  16352. (org-defkey org-mode-map 'button3 'popup-mode-menu))
  16353. (defconst org-speed-commands-default
  16354. '(
  16355. ("Outline Navigation")
  16356. ("n" . (org-speed-move-safe 'outline-next-visible-heading))
  16357. ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
  16358. ("f" . (org-speed-move-safe 'org-forward-same-level))
  16359. ("b" . (org-speed-move-safe 'org-backward-same-level))
  16360. ("u" . (org-speed-move-safe 'outline-up-heading))
  16361. ("j" . org-goto)
  16362. ("g" . (org-refile t))
  16363. ("Outline Visibility")
  16364. ("c" . org-cycle)
  16365. ("C" . org-shifttab)
  16366. (" " . org-display-outline-path)
  16367. (":" . org-columns)
  16368. ("Outline Structure Editing")
  16369. ("U" . org-shiftmetaup)
  16370. ("D" . org-shiftmetadown)
  16371. ("r" . org-metaright)
  16372. ("l" . org-metaleft)
  16373. ("R" . org-shiftmetaright)
  16374. ("L" . org-shiftmetaleft)
  16375. ("i" . (progn (forward-char 1) (call-interactively
  16376. 'org-insert-heading-respect-content)))
  16377. ("^" . org-sort)
  16378. ("w" . org-refile)
  16379. ("a" . org-archive-subtree-default-with-confirmation)
  16380. ("." . org-mark-subtree)
  16381. ("#" . org-toggle-comment)
  16382. ("Clock Commands")
  16383. ("I" . org-clock-in)
  16384. ("O" . org-clock-out)
  16385. ("Meta Data Editing")
  16386. ("t" . org-todo)
  16387. ("0" . (org-priority ?\ ))
  16388. ("1" . (org-priority ?A))
  16389. ("2" . (org-priority ?B))
  16390. ("3" . (org-priority ?C))
  16391. (";" . org-set-tags-command)
  16392. ("e" . org-set-effort)
  16393. ("Agenda Views etc")
  16394. ("v" . org-agenda)
  16395. ("/" . org-sparse-tree)
  16396. ("Misc")
  16397. ("o" . org-open-at-point)
  16398. ("?" . org-speed-command-help)
  16399. ("<" . (org-agenda-set-restriction-lock 'subtree))
  16400. (">" . (org-agenda-remove-restriction-lock))
  16401. )
  16402. "The default speed commands.")
  16403. (defun org-print-speed-command (e)
  16404. (if (> (length (car e)) 1)
  16405. (progn
  16406. (princ "\n")
  16407. (princ (car e))
  16408. (princ "\n")
  16409. (princ (make-string (length (car e)) ?-))
  16410. (princ "\n"))
  16411. (princ (car e))
  16412. (princ " ")
  16413. (if (symbolp (cdr e))
  16414. (princ (symbol-name (cdr e)))
  16415. (prin1 (cdr e)))
  16416. (princ "\n")))
  16417. (defun org-speed-command-help ()
  16418. "Show the available speed commands."
  16419. (interactive)
  16420. (if (not org-use-speed-commands)
  16421. (error "Speed commands are not activated, customize `org-use-speed-commands'")
  16422. (with-output-to-temp-buffer "*Help*"
  16423. (princ "User-defined Speed commands\n===========================\n")
  16424. (mapc 'org-print-speed-command org-speed-commands-user)
  16425. (princ "\n")
  16426. (princ "Built-in Speed commands\n=======================\n")
  16427. (mapc 'org-print-speed-command org-speed-commands-default))
  16428. (with-current-buffer "*Help*"
  16429. (setq truncate-lines t))))
  16430. (defun org-speed-move-safe (cmd)
  16431. "Execute CMD, but make sure that the cursor always ends up in a headline.
  16432. If not, return to the original position and throw an error."
  16433. (interactive)
  16434. (let ((pos (point)))
  16435. (call-interactively cmd)
  16436. (unless (and (bolp) (org-at-heading-p))
  16437. (goto-char pos)
  16438. (error "Boundary reached while executing %s" cmd))))
  16439. (defvar org-self-insert-command-undo-counter 0)
  16440. (defvar org-table-auto-blank-field) ; defined in org-table.el
  16441. (defvar org-speed-command nil)
  16442. (defun org-speed-command-default-hook (keys)
  16443. "Hook for activating single-letter speed commands.
  16444. `org-speed-commands-default' specifies a minimal command set.
  16445. Use `org-speed-commands-user' for further customization."
  16446. (when (or (and (bolp) (looking-at org-outline-regexp))
  16447. (and (functionp org-use-speed-commands)
  16448. (funcall org-use-speed-commands)))
  16449. (cdr (assoc keys (append org-speed-commands-user
  16450. org-speed-commands-default)))))
  16451. (defun org-babel-speed-command-hook (keys)
  16452. "Hook for activating single-letter code block commands."
  16453. (when (and (bolp) (looking-at org-babel-src-block-regexp))
  16454. (cdr (assoc keys org-babel-key-bindings))))
  16455. (defcustom org-speed-command-hook
  16456. '(org-speed-command-default-hook org-babel-speed-command-hook)
  16457. "Hook for activating speed commands at strategic locations.
  16458. Hook functions are called in sequence until a valid handler is
  16459. found.
  16460. Each hook takes a single argument, a user-pressed command key
  16461. which is also a `self-insert-command' from the global map.
  16462. Within the hook, examine the cursor position and the command key
  16463. and return nil or a valid handler as appropriate. Handler could
  16464. be one of an interactive command, a function, or a form.
  16465. Set `org-use-speed-commands' to non-nil value to enable this
  16466. hook. The default setting is `org-speed-command-default-hook'."
  16467. :group 'org-structure
  16468. :version "24.1"
  16469. :type 'hook)
  16470. (defun org-self-insert-command (N)
  16471. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  16472. If the cursor is in a table looking at whitespace, the whitespace is
  16473. overwritten, and the table is not marked as requiring realignment."
  16474. (interactive "p")
  16475. (org-check-before-invisible-edit 'insert)
  16476. (cond
  16477. ((and org-use-speed-commands
  16478. (setq org-speed-command
  16479. (run-hook-with-args-until-success
  16480. 'org-speed-command-hook (this-command-keys))))
  16481. (cond
  16482. ((commandp org-speed-command)
  16483. (setq this-command org-speed-command)
  16484. (call-interactively org-speed-command))
  16485. ((functionp org-speed-command)
  16486. (funcall org-speed-command))
  16487. ((and org-speed-command (listp org-speed-command))
  16488. (eval org-speed-command))
  16489. (t (let (org-use-speed-commands)
  16490. (call-interactively 'org-self-insert-command)))))
  16491. ((and
  16492. (org-table-p)
  16493. (progn
  16494. ;; check if we blank the field, and if that triggers align
  16495. (and (featurep 'org-table) org-table-auto-blank-field
  16496. (member last-command
  16497. '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
  16498. (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
  16499. ;; got extra space, this field does not determine column width
  16500. (let (org-table-may-need-update) (org-table-blank-field))
  16501. ;; no extra space, this field may determine column width
  16502. (org-table-blank-field)))
  16503. t)
  16504. (eq N 1)
  16505. (looking-at "[^|\n]* |"))
  16506. (let (org-table-may-need-update)
  16507. (goto-char (1- (match-end 0)))
  16508. (backward-delete-char 1)
  16509. (goto-char (match-beginning 0))
  16510. (self-insert-command N)))
  16511. (t
  16512. (setq org-table-may-need-update t)
  16513. (self-insert-command N)
  16514. (org-fix-tags-on-the-fly)
  16515. (if org-self-insert-cluster-for-undo
  16516. (if (not (eq last-command 'org-self-insert-command))
  16517. (setq org-self-insert-command-undo-counter 1)
  16518. (if (>= org-self-insert-command-undo-counter 20)
  16519. (setq org-self-insert-command-undo-counter 1)
  16520. (and (> org-self-insert-command-undo-counter 0)
  16521. buffer-undo-list (listp buffer-undo-list)
  16522. (not (cadr buffer-undo-list)) ; remove nil entry
  16523. (setcdr buffer-undo-list (cddr buffer-undo-list)))
  16524. (setq org-self-insert-command-undo-counter
  16525. (1+ org-self-insert-command-undo-counter))))))))
  16526. (defun org-check-before-invisible-edit (kind)
  16527. "Check is editing if kind KIND would be dangerous with invisible text around.
  16528. The detailed reaction depends on the user option `org-catch-invisible-edits'."
  16529. ;; First, try to get out of here as quickly as possible, to reduce overhead
  16530. (if (and org-catch-invisible-edits
  16531. (or (not (boundp 'visible-mode)) (not visible-mode))
  16532. (or (get-char-property (point) 'invisible)
  16533. (get-char-property (max (point-min) (1- (point))) 'invisible)))
  16534. ;; OK, we need to take a closer look
  16535. (let* ((invisible-at-point (get-char-property (point) 'invisible))
  16536. (invisible-before-point (if (bobp) nil (get-char-property
  16537. (1- (point)) 'invisible)))
  16538. (border-and-ok-direction
  16539. (or
  16540. ;; Check if we are acting predictably before invisible text
  16541. (and invisible-at-point (not invisible-before-point)
  16542. (memq kind '(insert delete-backward)))
  16543. ;; Check if we are acting predictably after invisible text
  16544. ;; This works not well, and I have turned it off. It seems
  16545. ;; better to always show and stop after invisible text.
  16546. ;; (and (not invisible-at-point) invisible-before-point
  16547. ;; (memq kind '(insert delete)))
  16548. )))
  16549. (when (or (memq invisible-at-point '(outline org-hide-block))
  16550. (memq invisible-before-point '(outline org-hide-block)))
  16551. (if (eq org-catch-invisible-edits 'error)
  16552. (error "Editing in invisible areas is prohibited - make visible first"))
  16553. ;; Make the area visible
  16554. (save-excursion
  16555. (if invisible-before-point
  16556. (goto-char (previous-single-char-property-change
  16557. (point) 'invisible)))
  16558. (org-cycle))
  16559. (cond
  16560. ((eq org-catch-invisible-edits 'show)
  16561. ;; That's it, we do the edit after showing
  16562. (message
  16563. "Unfolding invisible region around point before editing")
  16564. (sit-for 1))
  16565. ((and (eq org-catch-invisible-edits 'smart)
  16566. border-and-ok-direction)
  16567. (message "Unfolding invisible region around point before editing"))
  16568. (t
  16569. ;; Don't do the edit, make the user repeat it in full visibility
  16570. (error "Edit in invisible region aborted, repeat to confirm with text visible")))))))
  16571. (defun org-fix-tags-on-the-fly ()
  16572. (when (and (equal (char-after (point-at-bol)) ?*)
  16573. (org-at-heading-p))
  16574. (org-align-tags-here org-tags-column)))
  16575. (defun org-delete-backward-char (N)
  16576. "Like `delete-backward-char', insert whitespace at field end in tables.
  16577. When deleting backwards, in tables this function will insert whitespace in
  16578. front of the next \"|\" separator, to keep the table aligned. The table will
  16579. still be marked for re-alignment if the field did fill the entire column,
  16580. because, in this case the deletion might narrow the column."
  16581. (interactive "p")
  16582. (org-check-before-invisible-edit 'delete-backward)
  16583. (if (and (org-table-p)
  16584. (eq N 1)
  16585. (string-match "|" (buffer-substring (point-at-bol) (point)))
  16586. (looking-at ".*?|"))
  16587. (let ((pos (point))
  16588. (noalign (looking-at "[^|\n\r]* |"))
  16589. (c org-table-may-need-update))
  16590. (backward-delete-char N)
  16591. (if (not overwrite-mode)
  16592. (progn
  16593. (skip-chars-forward "^|")
  16594. (insert " ")
  16595. (goto-char (1- pos))))
  16596. ;; noalign: if there were two spaces at the end, this field
  16597. ;; does not determine the width of the column.
  16598. (if noalign (setq org-table-may-need-update c)))
  16599. (backward-delete-char N)
  16600. (org-fix-tags-on-the-fly)))
  16601. (defun org-delete-char (N)
  16602. "Like `delete-char', but insert whitespace at field end in tables.
  16603. When deleting characters, in tables this function will insert whitespace in
  16604. front of the next \"|\" separator, to keep the table aligned. The table will
  16605. still be marked for re-alignment if the field did fill the entire column,
  16606. because, in this case the deletion might narrow the column."
  16607. (interactive "p")
  16608. (org-check-before-invisible-edit 'delete)
  16609. (if (and (org-table-p)
  16610. (not (bolp))
  16611. (not (= (char-after) ?|))
  16612. (eq N 1))
  16613. (if (looking-at ".*?|")
  16614. (let ((pos (point))
  16615. (noalign (looking-at "[^|\n\r]* |"))
  16616. (c org-table-may-need-update))
  16617. (replace-match (concat
  16618. (substring (match-string 0) 1 -1)
  16619. " |"))
  16620. (goto-char pos)
  16621. ;; noalign: if there were two spaces at the end, this field
  16622. ;; does not determine the width of the column.
  16623. (if noalign (setq org-table-may-need-update c)))
  16624. (delete-char N))
  16625. (delete-char N)
  16626. (org-fix-tags-on-the-fly)))
  16627. ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
  16628. (put 'org-self-insert-command 'delete-selection t)
  16629. (put 'orgtbl-self-insert-command 'delete-selection t)
  16630. (put 'org-delete-char 'delete-selection 'supersede)
  16631. (put 'org-delete-backward-char 'delete-selection 'supersede)
  16632. (put 'org-yank 'delete-selection 'yank)
  16633. ;; Make `flyspell-mode' delay after some commands
  16634. (put 'org-self-insert-command 'flyspell-delayed t)
  16635. (put 'orgtbl-self-insert-command 'flyspell-delayed t)
  16636. (put 'org-delete-char 'flyspell-delayed t)
  16637. (put 'org-delete-backward-char 'flyspell-delayed t)
  16638. ;; Make pabbrev-mode expand after org-mode commands
  16639. (put 'org-self-insert-command 'pabbrev-expand-after-command t)
  16640. (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
  16641. ;; How to do this: Measure non-white length of current string
  16642. ;; If equal to column width, we should realign.
  16643. (defun org-remap (map &rest commands)
  16644. "In MAP, remap the functions given in COMMANDS.
  16645. COMMANDS is a list of alternating OLDDEF NEWDEF command names."
  16646. (let (new old)
  16647. (while commands
  16648. (setq old (pop commands) new (pop commands))
  16649. (if (fboundp 'command-remapping)
  16650. (org-defkey map (vector 'remap old) new)
  16651. (substitute-key-definition old new map global-map)))))
  16652. (when (eq org-enable-table-editor 'optimized)
  16653. ;; If the user wants maximum table support, we need to hijack
  16654. ;; some standard editing functions
  16655. (org-remap org-mode-map
  16656. 'self-insert-command 'org-self-insert-command
  16657. 'delete-char 'org-delete-char
  16658. 'delete-backward-char 'org-delete-backward-char)
  16659. (org-defkey org-mode-map "|" 'org-force-self-insert))
  16660. (defvar org-ctrl-c-ctrl-c-hook nil
  16661. "Hook for functions attaching themselves to `C-c C-c'.
  16662. This can be used to add additional functionality to the C-c C-c
  16663. key which executes context-dependent commands. This hook is run
  16664. before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
  16665. run after the last test.
  16666. Each function will be called with no arguments. The function
  16667. must check if the context is appropriate for it to act. If yes,
  16668. it should do its thing and then return a non-nil value. If the
  16669. context is wrong, just do nothing and return nil.")
  16670. (defvar org-ctrl-c-ctrl-c-final-hook nil
  16671. "Hook for functions attaching themselves to `C-c C-c'.
  16672. This can be used to add additional functionality to the C-c C-c
  16673. key which executes context-dependent commands. This hook is run
  16674. after any other test, while `org-ctrl-c-ctrl-c-hook' is run
  16675. before the first test.
  16676. Each function will be called with no arguments. The function
  16677. must check if the context is appropriate for it to act. If yes,
  16678. it should do its thing and then return a non-nil value. If the
  16679. context is wrong, just do nothing and return nil.")
  16680. (defvar org-tab-first-hook nil
  16681. "Hook for functions to attach themselves to TAB.
  16682. See `org-ctrl-c-ctrl-c-hook' for more information.
  16683. This hook runs as the first action when TAB is pressed, even before
  16684. `org-cycle' messes around with the `outline-regexp' to cater for
  16685. inline tasks and plain list item folding.
  16686. If any function in this hook returns t, any other actions that
  16687. would have been caused by TAB (such as table field motion or visibility
  16688. cycling) will not occur.")
  16689. (defvar org-tab-after-check-for-table-hook nil
  16690. "Hook for functions to attach themselves to TAB.
  16691. See `org-ctrl-c-ctrl-c-hook' for more information.
  16692. This hook runs after it has been established that the cursor is not in a
  16693. table, but before checking if the cursor is in a headline or if global cycling
  16694. should be done.
  16695. If any function in this hook returns t, not other actions like visibility
  16696. cycling will be done.")
  16697. (defvar org-tab-after-check-for-cycling-hook nil
  16698. "Hook for functions to attach themselves to TAB.
  16699. See `org-ctrl-c-ctrl-c-hook' for more information.
  16700. This hook runs after it has been established that not table field motion and
  16701. not visibility should be done because of current context. This is probably
  16702. the place where a package like yasnippets can hook in.")
  16703. (defvar org-tab-before-tab-emulation-hook nil
  16704. "Hook for functions to attach themselves to TAB.
  16705. See `org-ctrl-c-ctrl-c-hook' for more information.
  16706. This hook runs after every other options for TAB have been exhausted, but
  16707. before indentation and \t insertion takes place.")
  16708. (defvar org-metaleft-hook nil
  16709. "Hook for functions attaching themselves to `M-left'.
  16710. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16711. (defvar org-metaright-hook nil
  16712. "Hook for functions attaching themselves to `M-right'.
  16713. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16714. (defvar org-metaup-hook nil
  16715. "Hook for functions attaching themselves to `M-up'.
  16716. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16717. (defvar org-metadown-hook nil
  16718. "Hook for functions attaching themselves to `M-down'.
  16719. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16720. (defvar org-shiftmetaleft-hook nil
  16721. "Hook for functions attaching themselves to `M-S-left'.
  16722. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16723. (defvar org-shiftmetaright-hook nil
  16724. "Hook for functions attaching themselves to `M-S-right'.
  16725. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16726. (defvar org-shiftmetaup-hook nil
  16727. "Hook for functions attaching themselves to `M-S-up'.
  16728. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16729. (defvar org-shiftmetadown-hook nil
  16730. "Hook for functions attaching themselves to `M-S-down'.
  16731. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16732. (defvar org-metareturn-hook nil
  16733. "Hook for functions attaching themselves to `M-RET'.
  16734. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16735. (defvar org-shiftup-hook nil
  16736. "Hook for functions attaching themselves to `S-up'.
  16737. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16738. (defvar org-shiftup-final-hook nil
  16739. "Hook for functions attaching themselves to `S-up'.
  16740. This one runs after all other options except shift-select have been excluded.
  16741. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16742. (defvar org-shiftdown-hook nil
  16743. "Hook for functions attaching themselves to `S-down'.
  16744. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16745. (defvar org-shiftdown-final-hook nil
  16746. "Hook for functions attaching themselves to `S-down'.
  16747. This one runs after all other options except shift-select have been excluded.
  16748. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16749. (defvar org-shiftleft-hook nil
  16750. "Hook for functions attaching themselves to `S-left'.
  16751. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16752. (defvar org-shiftleft-final-hook nil
  16753. "Hook for functions attaching themselves to `S-left'.
  16754. This one runs after all other options except shift-select have been excluded.
  16755. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16756. (defvar org-shiftright-hook nil
  16757. "Hook for functions attaching themselves to `S-right'.
  16758. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16759. (defvar org-shiftright-final-hook nil
  16760. "Hook for functions attaching themselves to `S-right'.
  16761. This one runs after all other options except shift-select have been excluded.
  16762. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16763. (defun org-modifier-cursor-error ()
  16764. "Throw an error, a modified cursor command was applied in wrong context."
  16765. (error "This command is active in special context like tables, headlines or items"))
  16766. (defun org-shiftselect-error ()
  16767. "Throw an error because Shift-Cursor command was applied in wrong context."
  16768. (if (and (boundp 'shift-select-mode) shift-select-mode)
  16769. (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
  16770. (error "This command works only in special context like headlines or timestamps")))
  16771. (defun org-call-for-shift-select (cmd)
  16772. (let ((this-command-keys-shift-translated t))
  16773. (call-interactively cmd)))
  16774. (defun org-shifttab (&optional arg)
  16775. "Global visibility cycling or move to previous table field.
  16776. Calls `org-cycle' with argument t, or `org-table-previous-field', depending
  16777. on context.
  16778. See the individual commands for more information."
  16779. (interactive "P")
  16780. (cond
  16781. ((org-at-table-p) (call-interactively 'org-table-previous-field))
  16782. ((integerp arg)
  16783. (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
  16784. (message "Content view to level: %d" arg)
  16785. (org-content (prefix-numeric-value arg2))
  16786. (setq org-cycle-global-status 'overview)))
  16787. (t (call-interactively 'org-global-cycle))))
  16788. (defun org-shiftmetaleft ()
  16789. "Promote subtree or delete table column.
  16790. Calls `org-promote-subtree', `org-outdent-item-tree', or
  16791. `org-table-delete-column', depending on context. See the
  16792. individual commands for more information."
  16793. (interactive)
  16794. (cond
  16795. ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
  16796. ((org-at-table-p) (call-interactively 'org-table-delete-column))
  16797. ((org-at-heading-p) (call-interactively 'org-promote-subtree))
  16798. ((if (not (org-region-active-p)) (org-at-item-p)
  16799. (save-excursion (goto-char (region-beginning))
  16800. (org-at-item-p)))
  16801. (call-interactively 'org-outdent-item-tree))
  16802. (t (org-modifier-cursor-error))))
  16803. (defun org-shiftmetaright ()
  16804. "Demote subtree or insert table column.
  16805. Calls `org-demote-subtree', `org-indent-item-tree', or
  16806. `org-table-insert-column', depending on context. See the
  16807. individual commands for more information."
  16808. (interactive)
  16809. (cond
  16810. ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
  16811. ((org-at-table-p) (call-interactively 'org-table-insert-column))
  16812. ((org-at-heading-p) (call-interactively 'org-demote-subtree))
  16813. ((if (not (org-region-active-p)) (org-at-item-p)
  16814. (save-excursion (goto-char (region-beginning))
  16815. (org-at-item-p)))
  16816. (call-interactively 'org-indent-item-tree))
  16817. (t (org-modifier-cursor-error))))
  16818. (defun org-shiftmetaup (&optional arg)
  16819. "Move subtree up or kill table row.
  16820. Calls `org-move-subtree-up' or `org-table-kill-row' or
  16821. `org-move-item-up' depending on context. See the individual commands
  16822. for more information."
  16823. (interactive "P")
  16824. (cond
  16825. ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
  16826. ((org-at-table-p) (call-interactively 'org-table-kill-row))
  16827. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  16828. ((org-at-item-p) (call-interactively 'org-move-item-up))
  16829. (t (org-modifier-cursor-error))))
  16830. (defun org-shiftmetadown (&optional arg)
  16831. "Move subtree down or insert table row.
  16832. Calls `org-move-subtree-down' or `org-table-insert-row' or
  16833. `org-move-item-down', depending on context. See the individual
  16834. commands for more information."
  16835. (interactive "P")
  16836. (cond
  16837. ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
  16838. ((org-at-table-p) (call-interactively 'org-table-insert-row))
  16839. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  16840. ((org-at-item-p) (call-interactively 'org-move-item-down))
  16841. (t (org-modifier-cursor-error))))
  16842. (defsubst org-hidden-tree-error ()
  16843. (error
  16844. "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
  16845. (defun org-metaleft (&optional arg)
  16846. "Promote heading or move table column to left.
  16847. Calls `org-do-promote' or `org-table-move-column', depending on context.
  16848. With no specific context, calls the Emacs default `backward-word'.
  16849. See the individual commands for more information."
  16850. (interactive "P")
  16851. (cond
  16852. ((run-hook-with-args-until-success 'org-metaleft-hook))
  16853. ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
  16854. ((org-with-limited-levels
  16855. (or (org-at-heading-p)
  16856. (and (org-region-active-p)
  16857. (save-excursion
  16858. (goto-char (region-beginning))
  16859. (org-at-heading-p)))))
  16860. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  16861. (call-interactively 'org-do-promote))
  16862. ;; At an inline task.
  16863. ((org-at-heading-p)
  16864. (call-interactively 'org-inlinetask-promote))
  16865. ((or (org-at-item-p)
  16866. (and (org-region-active-p)
  16867. (save-excursion
  16868. (goto-char (region-beginning))
  16869. (org-at-item-p))))
  16870. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  16871. (call-interactively 'org-outdent-item))
  16872. (t (call-interactively 'backward-word))))
  16873. (defun org-metaright (&optional arg)
  16874. "Demote a subtree, a list item or move table column to right.
  16875. In front of a drawer or a block keyword, indent it correctly.
  16876. With no specific context, calls the Emacs default `forward-word'.
  16877. See the individual commands for more information."
  16878. (interactive "P")
  16879. (cond
  16880. ((run-hook-with-args-until-success 'org-metaright-hook))
  16881. ((org-at-table-p) (call-interactively 'org-table-move-column))
  16882. ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
  16883. ((org-at-block-p) (call-interactively 'org-indent-block))
  16884. ((org-with-limited-levels
  16885. (or (org-at-heading-p)
  16886. (and (org-region-active-p)
  16887. (save-excursion
  16888. (goto-char (region-beginning))
  16889. (org-at-heading-p)))))
  16890. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  16891. (call-interactively 'org-do-demote))
  16892. ;; At an inline task.
  16893. ((org-at-heading-p)
  16894. (call-interactively 'org-inlinetask-demote))
  16895. ((or (org-at-item-p)
  16896. (and (org-region-active-p)
  16897. (save-excursion
  16898. (goto-char (region-beginning))
  16899. (org-at-item-p))))
  16900. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  16901. (call-interactively 'org-indent-item))
  16902. (t (call-interactively 'forward-word))))
  16903. (defun org-check-for-hidden (what)
  16904. "Check if there are hidden headlines/items in the current visual line.
  16905. WHAT can be either `headlines' or `items'. If the current line is
  16906. an outline or item heading and it has a folded subtree below it,
  16907. this function returns t, nil otherwise."
  16908. (let ((re (cond
  16909. ((eq what 'headlines) org-outline-regexp-bol)
  16910. ((eq what 'items) (org-item-beginning-re))
  16911. (t (error "This should not happen"))))
  16912. beg end)
  16913. (save-excursion
  16914. (catch 'exit
  16915. (unless (org-region-active-p)
  16916. (setq beg (point-at-bol))
  16917. (beginning-of-line 2)
  16918. (while (and (not (eobp)) ;; this is like `next-line'
  16919. (get-char-property (1- (point)) 'invisible))
  16920. (beginning-of-line 2))
  16921. (setq end (point))
  16922. (goto-char beg)
  16923. (goto-char (point-at-eol))
  16924. (setq end (max end (point)))
  16925. (while (re-search-forward re end t)
  16926. (if (get-char-property (match-beginning 0) 'invisible)
  16927. (throw 'exit t))))
  16928. nil))))
  16929. (defun org-metaup (&optional arg)
  16930. "Move subtree up or move table row up.
  16931. Calls `org-move-subtree-up' or `org-table-move-row' or
  16932. `org-move-item-up', depending on context. See the individual commands
  16933. for more information."
  16934. (interactive "P")
  16935. (cond
  16936. ((run-hook-with-args-until-success 'org-metaup-hook))
  16937. ((org-region-active-p)
  16938. (let* ((a (min (region-beginning) (region-end)))
  16939. (b (1- (max (region-beginning) (region-end))))
  16940. (c (save-excursion (goto-char a)
  16941. (move-beginning-of-line 0)))
  16942. (d (save-excursion (goto-char a)
  16943. (move-end-of-line 0) (point))))
  16944. (transpose-regions a b c d)
  16945. (goto-char c)))
  16946. ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
  16947. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  16948. ((org-at-item-p) (call-interactively 'org-move-item-up))
  16949. (t (transpose-lines 1) (beginning-of-line -1))))
  16950. (defun org-metadown (&optional arg)
  16951. "Move subtree down or move table row down.
  16952. Calls `org-move-subtree-down' or `org-table-move-row' or
  16953. `org-move-item-down', depending on context. See the individual
  16954. commands for more information."
  16955. (interactive "P")
  16956. (cond
  16957. ((run-hook-with-args-until-success 'org-metadown-hook))
  16958. ((org-region-active-p)
  16959. (let* ((a (min (region-beginning) (region-end)))
  16960. (b (max (region-beginning) (region-end)))
  16961. (c (save-excursion (goto-char b)
  16962. (move-beginning-of-line 1)))
  16963. (d (save-excursion (goto-char b)
  16964. (move-end-of-line 1) (1+ (point)))))
  16965. (transpose-regions a b c d)
  16966. (goto-char d)))
  16967. ((org-at-table-p) (call-interactively 'org-table-move-row))
  16968. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  16969. ((org-at-item-p) (call-interactively 'org-move-item-down))
  16970. (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
  16971. (defun org-shiftup (&optional arg)
  16972. "Increase item in timestamp or increase priority of current headline.
  16973. Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
  16974. depending on context. See the individual commands for more information."
  16975. (interactive "P")
  16976. (cond
  16977. ((run-hook-with-args-until-success 'org-shiftup-hook))
  16978. ((and org-support-shift-select (org-region-active-p))
  16979. (org-call-for-shift-select 'previous-line))
  16980. ((org-at-timestamp-p t)
  16981. (call-interactively (if org-edit-timestamp-down-means-later
  16982. 'org-timestamp-down 'org-timestamp-up)))
  16983. ((and (not (eq org-support-shift-select 'always))
  16984. org-enable-priority-commands
  16985. (org-at-heading-p))
  16986. (call-interactively 'org-priority-up))
  16987. ((and (not org-support-shift-select) (org-at-item-p))
  16988. (call-interactively 'org-previous-item))
  16989. ((org-clocktable-try-shift 'up arg))
  16990. ((run-hook-with-args-until-success 'org-shiftup-final-hook))
  16991. (org-support-shift-select
  16992. (org-call-for-shift-select 'previous-line))
  16993. (t (org-shiftselect-error))))
  16994. (defun org-shiftdown (&optional arg)
  16995. "Decrease item in timestamp or decrease priority of current headline.
  16996. Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
  16997. depending on context. See the individual commands for more information."
  16998. (interactive "P")
  16999. (cond
  17000. ((run-hook-with-args-until-success 'org-shiftdown-hook))
  17001. ((and org-support-shift-select (org-region-active-p))
  17002. (org-call-for-shift-select 'next-line))
  17003. ((org-at-timestamp-p t)
  17004. (call-interactively (if org-edit-timestamp-down-means-later
  17005. 'org-timestamp-up 'org-timestamp-down)))
  17006. ((and (not (eq org-support-shift-select 'always))
  17007. org-enable-priority-commands
  17008. (org-at-heading-p))
  17009. (call-interactively 'org-priority-down))
  17010. ((and (not org-support-shift-select) (org-at-item-p))
  17011. (call-interactively 'org-next-item))
  17012. ((org-clocktable-try-shift 'down arg))
  17013. ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
  17014. (org-support-shift-select
  17015. (org-call-for-shift-select 'next-line))
  17016. (t (org-shiftselect-error))))
  17017. (defun org-shiftright (&optional arg)
  17018. "Cycle the thing at point or in the current line, depending on context.
  17019. Depending on context, this does one of the following:
  17020. - switch a timestamp at point one day into the future
  17021. - on a headline, switch to the next TODO keyword.
  17022. - on an item, switch entire list to the next bullet type
  17023. - on a property line, switch to the next allowed value
  17024. - on a clocktable definition line, move time block into the future"
  17025. (interactive "P")
  17026. (cond
  17027. ((run-hook-with-args-until-success 'org-shiftright-hook))
  17028. ((and org-support-shift-select (org-region-active-p))
  17029. (org-call-for-shift-select 'forward-char))
  17030. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
  17031. ((and (not (eq org-support-shift-select 'always))
  17032. (org-at-heading-p))
  17033. (let ((org-inhibit-logging
  17034. (not org-treat-S-cursor-todo-selection-as-state-change))
  17035. (org-inhibit-blocking
  17036. (not org-treat-S-cursor-todo-selection-as-state-change)))
  17037. (org-call-with-arg 'org-todo 'right)))
  17038. ((or (and org-support-shift-select
  17039. (not (eq org-support-shift-select 'always))
  17040. (org-at-item-bullet-p))
  17041. (and (not org-support-shift-select) (org-at-item-p)))
  17042. (org-call-with-arg 'org-cycle-list-bullet nil))
  17043. ((and (not (eq org-support-shift-select 'always))
  17044. (org-at-property-p))
  17045. (call-interactively 'org-property-next-allowed-value))
  17046. ((org-clocktable-try-shift 'right arg))
  17047. ((run-hook-with-args-until-success 'org-shiftright-final-hook))
  17048. (org-support-shift-select
  17049. (org-call-for-shift-select 'forward-char))
  17050. (t (org-shiftselect-error))))
  17051. (defun org-shiftleft (&optional arg)
  17052. "Cycle the thing at point or in the current line, depending on context.
  17053. Depending on context, this does one of the following:
  17054. - switch a timestamp at point one day into the past
  17055. - on a headline, switch to the previous TODO keyword.
  17056. - on an item, switch entire list to the previous bullet type
  17057. - on a property line, switch to the previous allowed value
  17058. - on a clocktable definition line, move time block into the past"
  17059. (interactive "P")
  17060. (cond
  17061. ((run-hook-with-args-until-success 'org-shiftleft-hook))
  17062. ((and org-support-shift-select (org-region-active-p))
  17063. (org-call-for-shift-select 'backward-char))
  17064. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
  17065. ((and (not (eq org-support-shift-select 'always))
  17066. (org-at-heading-p))
  17067. (let ((org-inhibit-logging
  17068. (not org-treat-S-cursor-todo-selection-as-state-change))
  17069. (org-inhibit-blocking
  17070. (not org-treat-S-cursor-todo-selection-as-state-change)))
  17071. (org-call-with-arg 'org-todo 'left)))
  17072. ((or (and org-support-shift-select
  17073. (not (eq org-support-shift-select 'always))
  17074. (org-at-item-bullet-p))
  17075. (and (not org-support-shift-select) (org-at-item-p)))
  17076. (org-call-with-arg 'org-cycle-list-bullet 'previous))
  17077. ((and (not (eq org-support-shift-select 'always))
  17078. (org-at-property-p))
  17079. (call-interactively 'org-property-previous-allowed-value))
  17080. ((org-clocktable-try-shift 'left arg))
  17081. ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
  17082. (org-support-shift-select
  17083. (org-call-for-shift-select 'backward-char))
  17084. (t (org-shiftselect-error))))
  17085. (defun org-shiftcontrolright ()
  17086. "Switch to next TODO set."
  17087. (interactive)
  17088. (cond
  17089. ((and org-support-shift-select (org-region-active-p))
  17090. (org-call-for-shift-select 'forward-word))
  17091. ((and (not (eq org-support-shift-select 'always))
  17092. (org-at-heading-p))
  17093. (org-call-with-arg 'org-todo 'nextset))
  17094. (org-support-shift-select
  17095. (org-call-for-shift-select 'forward-word))
  17096. (t (org-shiftselect-error))))
  17097. (defun org-shiftcontrolleft ()
  17098. "Switch to previous TODO set."
  17099. (interactive)
  17100. (cond
  17101. ((and org-support-shift-select (org-region-active-p))
  17102. (org-call-for-shift-select 'backward-word))
  17103. ((and (not (eq org-support-shift-select 'always))
  17104. (org-at-heading-p))
  17105. (org-call-with-arg 'org-todo 'previousset))
  17106. (org-support-shift-select
  17107. (org-call-for-shift-select 'backward-word))
  17108. (t (org-shiftselect-error))))
  17109. (defun org-shiftcontrolup ()
  17110. "Change timestamps synchronously up in CLOCK log lines."
  17111. (interactive)
  17112. (cond ((and (not org-support-shift-select)
  17113. (org-at-clock-log-p)
  17114. (org-at-timestamp-p t))
  17115. (org-clock-timestamps-up))
  17116. (t (org-shiftselect-error))))
  17117. (defun org-shiftcontroldown ()
  17118. "Change timestamps synchronously down in CLOCK log lines."
  17119. (interactive)
  17120. (cond ((and (not org-support-shift-select)
  17121. (org-at-clock-log-p)
  17122. (org-at-timestamp-p t))
  17123. (org-clock-timestamps-down))
  17124. (t (org-shiftselect-error))))
  17125. (defun org-ctrl-c-ret ()
  17126. "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
  17127. (interactive)
  17128. (cond
  17129. ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
  17130. (t (call-interactively 'org-insert-heading))))
  17131. (defun org-find-visible ()
  17132. (let ((s (point)))
  17133. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  17134. (get-char-property s 'invisible)))
  17135. s))
  17136. (defun org-find-invisible ()
  17137. (let ((s (point)))
  17138. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  17139. (not (get-char-property s 'invisible))))
  17140. s))
  17141. (defun org-copy-visible (beg end)
  17142. "Copy the visible parts of the region."
  17143. (interactive "r")
  17144. (let (snippets s)
  17145. (save-excursion
  17146. (save-restriction
  17147. (narrow-to-region beg end)
  17148. (setq s (goto-char (point-min)))
  17149. (while (not (= (point) (point-max)))
  17150. (goto-char (org-find-invisible))
  17151. (push (buffer-substring s (point)) snippets)
  17152. (setq s (goto-char (org-find-visible))))))
  17153. (kill-new (apply 'concat (nreverse snippets)))))
  17154. (defun org-copy-special ()
  17155. "Copy region in table or copy current subtree.
  17156. Calls `org-table-copy' or `org-copy-subtree', depending on context.
  17157. See the individual commands for more information."
  17158. (interactive)
  17159. (call-interactively
  17160. (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
  17161. (defun org-cut-special ()
  17162. "Cut region in table or cut current subtree.
  17163. Calls `org-table-copy' or `org-cut-subtree', depending on context.
  17164. See the individual commands for more information."
  17165. (interactive)
  17166. (call-interactively
  17167. (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
  17168. (defun org-paste-special (arg)
  17169. "Paste rectangular region into table, or past subtree relative to level.
  17170. Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
  17171. See the individual commands for more information."
  17172. (interactive "P")
  17173. (if (org-at-table-p)
  17174. (org-table-paste-rectangle)
  17175. (org-paste-subtree arg)))
  17176. (defun org-edit-special (&optional arg)
  17177. "Call a special editor for the stuff at point.
  17178. When at a table, call the formula editor with `org-table-edit-formulas'.
  17179. When at the first line of an src example, call `org-edit-src-code'.
  17180. When in an #+include line, visit the include file. Otherwise call
  17181. `ffap' to visit the file at point."
  17182. (interactive)
  17183. ;; possibly prep session before editing source
  17184. (when arg
  17185. (let* ((info (org-babel-get-src-block-info))
  17186. (lang (nth 0 info))
  17187. (params (nth 2 info))
  17188. (session (cdr (assoc :session params))))
  17189. (when (and info session) ;; we are in a source-code block with a session
  17190. (funcall
  17191. (intern (concat "org-babel-prep-session:" lang)) session params))))
  17192. (cond ;; proceed with `org-edit-special'
  17193. ((save-excursion
  17194. (beginning-of-line 1)
  17195. (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
  17196. (find-file (org-trim (match-string 1))))
  17197. ((org-edit-src-code))
  17198. ((org-edit-fixed-width-region))
  17199. ((org-at-table.el-p)
  17200. (org-edit-src-code))
  17201. ((or (org-at-table-p)
  17202. (save-excursion
  17203. (beginning-of-line 1)
  17204. (let ((case-fold-search )) (looking-at "[ \t]*#\\+tblfm:"))))
  17205. (call-interactively 'org-table-edit-formulas))
  17206. (t (call-interactively 'ffap))))
  17207. (defvar org-table-coordinate-overlays) ; defined in org-table.el
  17208. (defun org-ctrl-c-ctrl-c (&optional arg)
  17209. "Set tags in headline, or update according to changed information at point.
  17210. This command does many different things, depending on context:
  17211. - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
  17212. this is what we do.
  17213. - If the cursor is on a statistics cookie, update it.
  17214. - If the cursor is in a headline, prompt for tags and insert them
  17215. into the current line, aligned to `org-tags-column'. When called
  17216. with prefix arg, realign all tags in the current buffer.
  17217. - If the cursor is in one of the special #+KEYWORD lines, this
  17218. triggers scanning the buffer for these lines and updating the
  17219. information.
  17220. - If the cursor is inside a table, realign the table. This command
  17221. works even if the automatic table editor has been turned off.
  17222. - If the cursor is on a #+TBLFM line, re-apply the formulas to
  17223. the entire table.
  17224. - If the cursor is at a footnote reference or definition, jump to
  17225. the corresponding definition or references, respectively.
  17226. - If the cursor is a the beginning of a dynamic block, update it.
  17227. - If the current buffer is a capture buffer, close note and file it.
  17228. - If the cursor is on a <<<target>>>, update radio targets and
  17229. corresponding links in this buffer.
  17230. - If the cursor is on a numbered item in a plain list, renumber the
  17231. ordered list.
  17232. - If the cursor is on a checkbox, toggle it.
  17233. - If the cursor is on a code block, evaluate it. The variable
  17234. `org-confirm-babel-evaluate' can be used to control prompting
  17235. before code block evaluation, by default every code block
  17236. evaluation requires confirmation. Code block evaluation can be
  17237. inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
  17238. (interactive "P")
  17239. (let ((org-enable-table-editor t))
  17240. (cond
  17241. ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
  17242. org-occur-highlights
  17243. org-latex-fragment-image-overlays)
  17244. (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
  17245. (org-remove-occur-highlights)
  17246. (org-remove-latex-fragment-image-overlays)
  17247. (message "Temporary highlights/overlays removed from current buffer"))
  17248. ((and (local-variable-p 'org-finish-function (current-buffer))
  17249. (fboundp org-finish-function))
  17250. (funcall org-finish-function))
  17251. ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
  17252. ((org-in-regexp org-ts-regexp-both)
  17253. (org-timestamp-change 0 'day))
  17254. ((or (looking-at org-property-start-re)
  17255. (org-at-property-p))
  17256. (call-interactively 'org-property-action))
  17257. ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
  17258. ((and (org-in-regexp "\\[\\([0-9]*%\\|[0-9]*/[0-9]*\\)\\]")
  17259. (or (org-at-heading-p) (org-at-item-p)))
  17260. (call-interactively 'org-update-statistics-cookies))
  17261. ((org-at-heading-p) (call-interactively 'org-set-tags))
  17262. ((org-at-table.el-p)
  17263. (message "Use C-c ' to edit table.el tables"))
  17264. ((org-at-table-p)
  17265. (org-table-maybe-eval-formula)
  17266. (if arg
  17267. (call-interactively 'org-table-recalculate)
  17268. (org-table-maybe-recalculate-line))
  17269. (call-interactively 'org-table-align)
  17270. (orgtbl-send-table 'maybe))
  17271. ((or (org-footnote-at-reference-p)
  17272. (org-footnote-at-definition-p))
  17273. (call-interactively 'org-footnote-action))
  17274. ((org-at-item-checkbox-p)
  17275. ;; Cursor at a checkbox: repair list and update checkboxes. Send
  17276. ;; list only if at top item.
  17277. (let* ((cbox (match-string 1))
  17278. (struct (org-list-struct))
  17279. (old-struct (copy-tree struct))
  17280. (parents (org-list-parents-alist struct))
  17281. (orderedp (org-entry-get nil "ORDERED"))
  17282. (firstp (= (org-list-get-top-point struct) (point-at-bol)))
  17283. block-item)
  17284. ;; Use a light version of `org-toggle-checkbox' to avoid
  17285. ;; computing list structure twice.
  17286. (let ((new-box (cond
  17287. ((equal arg '(16)) "[-]")
  17288. ((equal arg '(4)) nil)
  17289. ((equal "[X]" cbox) "[ ]")
  17290. (t "[X]"))))
  17291. (if (and firstp arg)
  17292. ;; If at first item of sub-list, remove check-box from
  17293. ;; every item at the same level.
  17294. (mapc
  17295. (lambda (pos) (org-list-set-checkbox pos struct new-box))
  17296. (org-list-get-all-items
  17297. (point-at-bol) struct (org-list-prevs-alist struct)))
  17298. (org-list-set-checkbox (point-at-bol) struct new-box)))
  17299. ;; Replicate `org-list-write-struct', while grabbing a return
  17300. ;; value from `org-list-struct-fix-box'.
  17301. (org-list-struct-fix-ind struct parents 2)
  17302. (org-list-struct-fix-item-end struct)
  17303. (let ((prevs (org-list-prevs-alist struct)))
  17304. (org-list-struct-fix-bul struct prevs)
  17305. (org-list-struct-fix-ind struct parents)
  17306. (setq block-item
  17307. (org-list-struct-fix-box struct parents prevs orderedp)))
  17308. (org-list-struct-apply-struct struct old-struct)
  17309. (org-update-checkbox-count-maybe)
  17310. (when block-item
  17311. (message
  17312. "Checkboxes were removed due to unchecked box at line %d"
  17313. (org-current-line block-item)))
  17314. (when firstp (org-list-send-list 'maybe))))
  17315. ((org-at-item-p)
  17316. ;; Cursor at an item: repair list. Do checkbox related actions
  17317. ;; only if function was called with an argument. Send list only
  17318. ;; if at top item.
  17319. (let* ((struct (org-list-struct))
  17320. (firstp (= (org-list-get-top-point struct) (point-at-bol)))
  17321. old-struct)
  17322. (when arg
  17323. (setq old-struct (copy-tree struct))
  17324. (if firstp
  17325. ;; If at first item of sub-list, add check-box to every
  17326. ;; item at the same level.
  17327. (mapc
  17328. (lambda (pos)
  17329. (unless (org-list-get-checkbox pos struct)
  17330. (org-list-set-checkbox pos struct "[ ]")))
  17331. (org-list-get-all-items
  17332. (point-at-bol) struct (org-list-prevs-alist struct)))
  17333. (org-list-set-checkbox (point-at-bol) struct "[ ]")))
  17334. (org-list-write-struct
  17335. struct (org-list-parents-alist struct) old-struct)
  17336. (when arg (org-update-checkbox-count-maybe))
  17337. (when firstp (org-list-send-list 'maybe))))
  17338. ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
  17339. ;; Dynamic block
  17340. (beginning-of-line 1)
  17341. (save-excursion (org-update-dblock)))
  17342. ((save-excursion
  17343. (let ((case-fold-search t))
  17344. (beginning-of-line 1)
  17345. (looking-at "[ \t]*#\\+\\([a-z]+\\)")))
  17346. (cond
  17347. ((or (equal (match-string 1) "TBLFM")
  17348. (equal (match-string 1) "tblfm"))
  17349. ;; Recalculate the table before this line
  17350. (save-excursion
  17351. (beginning-of-line 1)
  17352. (skip-chars-backward " \r\n\t")
  17353. (if (org-at-table-p)
  17354. (org-call-with-arg 'org-table-recalculate (or arg t)))))
  17355. (t
  17356. (let ((org-inhibit-startup-visibility-stuff t)
  17357. (org-startup-align-all-tables nil))
  17358. (when (boundp 'org-table-coordinate-overlays)
  17359. (mapc 'delete-overlay org-table-coordinate-overlays)
  17360. (setq org-table-coordinate-overlays nil))
  17361. (org-save-outline-visibility 'use-markers (org-mode-restart)))
  17362. (message "Local setup has been refreshed"))))
  17363. ((org-clock-update-time-maybe))
  17364. (t
  17365. (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
  17366. (error "C-c C-c can do nothing useful at this location"))))))
  17367. (defun org-mode-restart ()
  17368. "Restart Org-mode, to scan again for special lines.
  17369. Also updates the keyword regular expressions."
  17370. (interactive)
  17371. (org-mode)
  17372. (message "Org-mode restarted"))
  17373. (defun org-kill-note-or-show-branches ()
  17374. "If this is a Note buffer, abort storing the note. Else call `show-branches'."
  17375. (interactive)
  17376. (if (not org-finish-function)
  17377. (progn
  17378. (hide-subtree)
  17379. (call-interactively 'show-branches))
  17380. (let ((org-note-abort t))
  17381. (funcall org-finish-function))))
  17382. (defun org-return (&optional indent)
  17383. "Goto next table row or insert a newline.
  17384. Calls `org-table-next-row' or `newline', depending on context.
  17385. See the individual commands for more information."
  17386. (interactive)
  17387. (let (org-ts-what)
  17388. (cond
  17389. ((or (bobp) (org-in-src-block-p))
  17390. (if indent (newline-and-indent) (newline)))
  17391. ((org-at-table-p)
  17392. (org-table-justify-field-maybe)
  17393. (call-interactively 'org-table-next-row))
  17394. ;; when `newline-and-indent' is called within a list, make sure
  17395. ;; text moved stays inside the item.
  17396. ((and (org-in-item-p) indent)
  17397. (if (and (org-at-item-p) (>= (point) (match-end 0)))
  17398. (progn
  17399. (save-match-data (newline))
  17400. (org-indent-line-to (length (match-string 0))))
  17401. (let ((ind (org-get-indentation)))
  17402. (newline)
  17403. (if (org-looking-back org-list-end-re)
  17404. (org-indent-line)
  17405. (org-indent-line-to ind)))))
  17406. ((and org-return-follows-link
  17407. (org-at-timestamp-p t)
  17408. (not (eq org-ts-what 'after)))
  17409. (org-follow-timestamp-link))
  17410. ((and org-return-follows-link
  17411. (let ((tprop (get-text-property (point) 'face)))
  17412. (or (eq tprop 'org-link)
  17413. (and (listp tprop) (memq 'org-link tprop)))))
  17414. (call-interactively 'org-open-at-point))
  17415. ((and (org-at-heading-p)
  17416. (looking-at
  17417. (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
  17418. (org-show-entry)
  17419. (end-of-line 1)
  17420. (newline))
  17421. (t (if indent (newline-and-indent) (newline))))))
  17422. (defun org-return-indent ()
  17423. "Goto next table row or insert a newline and indent.
  17424. Calls `org-table-next-row' or `newline-and-indent', depending on
  17425. context. See the individual commands for more information."
  17426. (interactive)
  17427. (org-return t))
  17428. (defun org-ctrl-c-star ()
  17429. "Compute table, or change heading status of lines.
  17430. Calls `org-table-recalculate' or `org-toggle-heading',
  17431. depending on context."
  17432. (interactive)
  17433. (cond
  17434. ((org-at-table-p)
  17435. (call-interactively 'org-table-recalculate))
  17436. (t
  17437. ;; Convert all lines in region to list items
  17438. (call-interactively 'org-toggle-heading))))
  17439. (defun org-ctrl-c-minus ()
  17440. "Insert separator line in table or modify bullet status of line.
  17441. Also turns a plain line or a region of lines into list items.
  17442. Calls `org-table-insert-hline', `org-toggle-item', or
  17443. `org-cycle-list-bullet', depending on context."
  17444. (interactive)
  17445. (cond
  17446. ((org-at-table-p)
  17447. (call-interactively 'org-table-insert-hline))
  17448. ((org-region-active-p)
  17449. (call-interactively 'org-toggle-item))
  17450. ((org-in-item-p)
  17451. (call-interactively 'org-cycle-list-bullet))
  17452. (t
  17453. (call-interactively 'org-toggle-item))))
  17454. (defun org-toggle-item (arg)
  17455. "Convert headings or normal lines to items, items to normal lines.
  17456. If there is no active region, only the current line is considered.
  17457. If the first non blank line in the region is an headline, convert
  17458. all headlines to items, shifting text accordingly.
  17459. If it is an item, convert all items to normal lines.
  17460. If it is normal text, change region into an item. With a prefix
  17461. argument ARG, change each line in region into an item."
  17462. (interactive "P")
  17463. (let ((shift-text
  17464. (function
  17465. ;; Shift text in current section to IND, from point to END.
  17466. ;; The function leaves point to END line.
  17467. (lambda (ind end)
  17468. (let ((min-i 1000) (end (copy-marker end)))
  17469. ;; First determine the minimum indentation (MIN-I) of
  17470. ;; the text.
  17471. (save-excursion
  17472. (catch 'exit
  17473. (while (< (point) end)
  17474. (let ((i (org-get-indentation)))
  17475. (cond
  17476. ;; Skip blank lines and inline tasks.
  17477. ((looking-at "^[ \t]*$"))
  17478. ((looking-at org-outline-regexp-bol))
  17479. ;; We can't find less than 0 indentation.
  17480. ((zerop i) (throw 'exit (setq min-i 0)))
  17481. ((< i min-i) (setq min-i i))))
  17482. (forward-line))))
  17483. ;; Then indent each line so that a line indented to
  17484. ;; MIN-I becomes indented to IND. Ignore blank lines
  17485. ;; and inline tasks in the process.
  17486. (let ((delta (- ind min-i)))
  17487. (while (< (point) end)
  17488. (unless (or (looking-at "^[ \t]*$")
  17489. (looking-at org-outline-regexp-bol))
  17490. (org-indent-line-to (+ (org-get-indentation) delta)))
  17491. (forward-line)))))))
  17492. (skip-blanks
  17493. (function
  17494. ;; Return beginning of first non-blank line, starting from
  17495. ;; line at POS.
  17496. (lambda (pos)
  17497. (save-excursion
  17498. (goto-char pos)
  17499. (skip-chars-forward " \r\t\n")
  17500. (point-at-bol)))))
  17501. beg end)
  17502. ;; Determine boundaries of changes.
  17503. (if (org-region-active-p)
  17504. (setq beg (funcall skip-blanks (region-beginning))
  17505. end (copy-marker (region-end)))
  17506. (setq beg (funcall skip-blanks (point-at-bol))
  17507. end (copy-marker (point-at-eol))))
  17508. ;; Depending on the starting line, choose an action on the text
  17509. ;; between BEG and END.
  17510. (org-with-limited-levels
  17511. (save-excursion
  17512. (goto-char beg)
  17513. (cond
  17514. ;; Case 1. Start at an item: de-itemize. Note that it only
  17515. ;; happens when a region is active: `org-ctrl-c-minus'
  17516. ;; would call `org-cycle-list-bullet' otherwise.
  17517. ((org-at-item-p)
  17518. (while (< (point) end)
  17519. (when (org-at-item-p)
  17520. (skip-chars-forward " \t")
  17521. (delete-region (point) (match-end 0)))
  17522. (forward-line)))
  17523. ;; Case 2. Start at an heading: convert to items.
  17524. ((org-at-heading-p)
  17525. (let* ((bul (org-list-bullet-string "-"))
  17526. (bul-len (length bul))
  17527. ;; Indentation of the first heading. It should be
  17528. ;; relative to the indentation of its parent, if any.
  17529. (start-ind (save-excursion
  17530. (cond
  17531. ((not org-adapt-indentation) 0)
  17532. ((not (outline-previous-heading)) 0)
  17533. (t (length (match-string 0))))))
  17534. ;; Level of first heading. Further headings will be
  17535. ;; compared to it to determine hierarchy in the list.
  17536. (ref-level (org-reduced-level (org-outline-level))))
  17537. (while (< (point) end)
  17538. (let* ((level (org-reduced-level (org-outline-level)))
  17539. (delta (max 0 (- level ref-level))))
  17540. ;; If current headline is less indented than the first
  17541. ;; one, set it as reference, in order to preserve
  17542. ;; subtrees.
  17543. (when (< level ref-level) (setq ref-level level))
  17544. (replace-match bul t t)
  17545. (org-indent-line-to (+ start-ind (* delta bul-len)))
  17546. ;; Ensure all text down to END (or SECTION-END) belongs
  17547. ;; to the newly created item.
  17548. (let ((section-end (save-excursion
  17549. (or (outline-next-heading) (point)))))
  17550. (forward-line)
  17551. (funcall shift-text
  17552. (+ start-ind (* (1+ delta) bul-len))
  17553. (min end section-end)))))))
  17554. ;; Case 3. Normal line with ARG: turn each non-item line into
  17555. ;; an item.
  17556. (arg
  17557. (while (< (point) end)
  17558. (unless (or (org-at-heading-p) (org-at-item-p))
  17559. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  17560. (replace-match
  17561. (concat "\\1" (org-list-bullet-string "-") "\\2"))))
  17562. (forward-line)))
  17563. ;; Case 4. Normal line without ARG: make the first line of
  17564. ;; region an item, and shift indentation of others
  17565. ;; lines to set them as item's body.
  17566. (t (let* ((bul (org-list-bullet-string "-"))
  17567. (bul-len (length bul))
  17568. (ref-ind (org-get-indentation)))
  17569. (skip-chars-forward " \t")
  17570. (insert bul)
  17571. (forward-line)
  17572. (while (< (point) end)
  17573. ;; Ensure that lines less indented than first one
  17574. ;; still get included in item body.
  17575. (funcall shift-text
  17576. (+ ref-ind bul-len)
  17577. (min end (save-excursion (or (outline-next-heading)
  17578. (point)))))
  17579. (forward-line)))))))))
  17580. (defun org-toggle-heading (&optional nstars)
  17581. "Convert headings to normal text, or items or text to headings.
  17582. If there is no active region, only the current line is considered.
  17583. With a \\[universal-argument] prefix, convert the whole list at
  17584. point into heading.
  17585. In a region:
  17586. - If the first non blank line is an headline, remove the stars
  17587. from all headlines in the region.
  17588. - If it is a normal line turn each and every normal line (i.e. not an
  17589. heading or an item) in the region into a heading.
  17590. - If it is a plain list item, turn all plain list items into headings.
  17591. When converting a line into a heading, the number of stars is chosen
  17592. such that the lines become children of the current entry. However,
  17593. when a prefix argument is given, its value determines the number of
  17594. stars to add."
  17595. (interactive "P")
  17596. (let ((skip-blanks
  17597. (function
  17598. ;; Return beginning of first non-blank line, starting from
  17599. ;; line at POS.
  17600. (lambda (pos)
  17601. (save-excursion
  17602. (goto-char pos)
  17603. (while (org-at-comment-p) (forward-line))
  17604. (skip-chars-forward " \r\t\n")
  17605. (point-at-bol)))))
  17606. beg end toggled)
  17607. ;; Determine boundaries of changes. If a universal prefix has
  17608. ;; been given, put the list in a region. If region ends at a bol,
  17609. ;; do not consider the last line to be in the region.
  17610. (when (and current-prefix-arg (org-at-item-p))
  17611. (if (equal current-prefix-arg '(4)) (setq current-prefix-arg 1))
  17612. (org-mark-list))
  17613. (if (org-region-active-p)
  17614. (setq beg (funcall skip-blanks (region-beginning))
  17615. end (copy-marker (save-excursion
  17616. (goto-char (region-end))
  17617. (if (bolp) (point) (point-at-eol)))))
  17618. (setq beg (funcall skip-blanks (point-at-bol))
  17619. end (copy-marker (point-at-eol))))
  17620. ;; Ensure inline tasks don't count as headings.
  17621. (org-with-limited-levels
  17622. (save-excursion
  17623. (goto-char beg)
  17624. (cond
  17625. ;; Case 1. Started at an heading: de-star headings.
  17626. ((org-at-heading-p)
  17627. (while (< (point) end)
  17628. (when (org-at-heading-p t)
  17629. (looking-at org-outline-regexp) (replace-match "")
  17630. (setq toggled t))
  17631. (forward-line)))
  17632. ;; Case 2. Started at an item: change items into headlines.
  17633. ;; One star will be added by `org-list-to-subtree'.
  17634. ((org-at-item-p)
  17635. (let* ((stars (make-string
  17636. (if nstars
  17637. ;; subtract the star that will be added again by
  17638. ;; `org-list-to-subtree'
  17639. (1- (prefix-numeric-value current-prefix-arg))
  17640. (or (org-current-level) 0))
  17641. ?*))
  17642. (add-stars
  17643. (cond (nstars "") ; stars from prefix only
  17644. ((equal stars "") "") ; before first heading
  17645. (org-odd-levels-only "*") ; inside heading, odd
  17646. (t "")))) ; inside heading, oddeven
  17647. (while (< (point) end)
  17648. (when (org-at-item-p)
  17649. ;; Pay attention to cases when region ends before list.
  17650. (let* ((struct (org-list-struct))
  17651. (list-end (min (org-list-get-bottom-point struct) (1+ end))))
  17652. (save-restriction
  17653. (narrow-to-region (point) list-end)
  17654. (insert
  17655. (org-list-to-subtree
  17656. (org-list-parse-list t)
  17657. '(:istart (concat stars add-stars (funcall get-stars depth))
  17658. :icount (concat stars add-stars (funcall get-stars depth)))))))
  17659. (setq toggled t))
  17660. (forward-line))))
  17661. ;; Case 3. Started at normal text: make every line an heading,
  17662. ;; skipping headlines and items.
  17663. (t (let* ((stars (make-string
  17664. (if nstars
  17665. (prefix-numeric-value current-prefix-arg)
  17666. (or (org-current-level) 0))
  17667. ?*))
  17668. (add-stars
  17669. (cond (nstars "") ; stars from prefix only
  17670. ((equal stars "") "*") ; before first heading
  17671. (org-odd-levels-only "**") ; inside heading, odd
  17672. (t "*"))) ; inside heading, oddeven
  17673. (rpl (concat stars add-stars " ")))
  17674. (while (< (point) end)
  17675. (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
  17676. (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
  17677. (replace-match (concat rpl (match-string 2))) (setq toggled t))
  17678. (forward-line)))))))
  17679. (unless toggled (message "Cannot toggle heading from here"))))
  17680. (defun org-meta-return (&optional arg)
  17681. "Insert a new heading or wrap a region in a table.
  17682. Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
  17683. See the individual commands for more information."
  17684. (interactive "P")
  17685. (cond
  17686. ((run-hook-with-args-until-success 'org-metareturn-hook))
  17687. ((or (org-at-drawer-p) (org-at-property-p))
  17688. (newline-and-indent))
  17689. ((org-at-table-p)
  17690. (call-interactively 'org-table-wrap-region))
  17691. (t (call-interactively 'org-insert-heading))))
  17692. ;;; Menu entries
  17693. ;; Define the Org-mode menus
  17694. (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
  17695. '("Tbl"
  17696. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
  17697. ["Next Field" org-cycle (org-at-table-p)]
  17698. ["Previous Field" org-shifttab (org-at-table-p)]
  17699. ["Next Row" org-return (org-at-table-p)]
  17700. "--"
  17701. ["Blank Field" org-table-blank-field (org-at-table-p)]
  17702. ["Edit Field" org-table-edit-field (org-at-table-p)]
  17703. ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
  17704. "--"
  17705. ("Column"
  17706. ["Move Column Left" org-metaleft (org-at-table-p)]
  17707. ["Move Column Right" org-metaright (org-at-table-p)]
  17708. ["Delete Column" org-shiftmetaleft (org-at-table-p)]
  17709. ["Insert Column" org-shiftmetaright (org-at-table-p)])
  17710. ("Row"
  17711. ["Move Row Up" org-metaup (org-at-table-p)]
  17712. ["Move Row Down" org-metadown (org-at-table-p)]
  17713. ["Delete Row" org-shiftmetaup (org-at-table-p)]
  17714. ["Insert Row" org-shiftmetadown (org-at-table-p)]
  17715. ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
  17716. "--"
  17717. ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
  17718. ("Rectangle"
  17719. ["Copy Rectangle" org-copy-special (org-at-table-p)]
  17720. ["Cut Rectangle" org-cut-special (org-at-table-p)]
  17721. ["Paste Rectangle" org-paste-special (org-at-table-p)]
  17722. ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
  17723. "--"
  17724. ("Calculate"
  17725. ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
  17726. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  17727. ["Edit Formulas" org-edit-special (org-at-table-p)]
  17728. "--"
  17729. ["Recalculate line" org-table-recalculate (org-at-table-p)]
  17730. ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
  17731. ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  17732. "--"
  17733. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
  17734. "--"
  17735. ["Sum Column/Rectangle" org-table-sum
  17736. (or (org-at-table-p) (org-region-active-p))]
  17737. ["Which Column?" org-table-current-column (org-at-table-p)])
  17738. ["Debug Formulas"
  17739. org-table-toggle-formula-debugger
  17740. :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
  17741. ["Show Col/Row Numbers"
  17742. org-table-toggle-coordinate-overlays
  17743. :style toggle
  17744. :selected (org-bound-and-true-p org-table-overlay-coordinates)]
  17745. "--"
  17746. ["Create" org-table-create (and (not (org-at-table-p))
  17747. org-enable-table-editor)]
  17748. ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
  17749. ["Import from File" org-table-import (not (org-at-table-p))]
  17750. ["Export to File" org-table-export (org-at-table-p)]
  17751. "--"
  17752. ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
  17753. (easy-menu-define org-org-menu org-mode-map "Org menu"
  17754. '("Org"
  17755. ("Show/Hide"
  17756. ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
  17757. ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
  17758. ["Sparse Tree..." org-sparse-tree t]
  17759. ["Reveal Context" org-reveal t]
  17760. ["Show All" show-all t]
  17761. "--"
  17762. ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
  17763. "--"
  17764. ["New Heading" org-insert-heading t]
  17765. ("Navigate Headings"
  17766. ["Up" outline-up-heading t]
  17767. ["Next" outline-next-visible-heading t]
  17768. ["Previous" outline-previous-visible-heading t]
  17769. ["Next Same Level" outline-forward-same-level t]
  17770. ["Previous Same Level" outline-backward-same-level t]
  17771. "--"
  17772. ["Jump" org-goto t])
  17773. ("Edit Structure"
  17774. ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
  17775. ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
  17776. "--"
  17777. ["Copy Subtree" org-copy-special (not (org-at-table-p))]
  17778. ["Cut Subtree" org-cut-special (not (org-at-table-p))]
  17779. ["Paste Subtree" org-paste-special (not (org-at-table-p))]
  17780. "--"
  17781. ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
  17782. "--"
  17783. ["Copy visible text" org-copy-visible t]
  17784. "--"
  17785. ["Promote Heading" org-metaleft (not (org-at-table-p))]
  17786. ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
  17787. ["Demote Heading" org-metaright (not (org-at-table-p))]
  17788. ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
  17789. "--"
  17790. ["Sort Region/Children" org-sort (not (org-at-table-p))]
  17791. "--"
  17792. ["Convert to odd levels" org-convert-to-odd-levels t]
  17793. ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
  17794. ("Editing"
  17795. ["Emphasis..." org-emphasize t]
  17796. ["Edit Source Example" org-edit-special t]
  17797. "--"
  17798. ["Footnote new/jump" org-footnote-action t]
  17799. ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
  17800. ("Archive"
  17801. ["Archive (default method)" org-archive-subtree-default t]
  17802. "--"
  17803. ["Move Subtree to Archive file" org-advertized-archive-subtree t]
  17804. ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
  17805. ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
  17806. )
  17807. "--"
  17808. ("Hyperlinks"
  17809. ["Store Link (Global)" org-store-link t]
  17810. ["Find existing link to here" org-occur-link-in-agenda-files t]
  17811. ["Insert Link" org-insert-link t]
  17812. ["Follow Link" org-open-at-point t]
  17813. "--"
  17814. ["Next link" org-next-link t]
  17815. ["Previous link" org-previous-link t]
  17816. "--"
  17817. ["Descriptive Links"
  17818. org-toggle-link-display
  17819. :style radio
  17820. :selected org-descriptive-links
  17821. ]
  17822. ["Literal Links"
  17823. org-toggle-link-display
  17824. :style radio
  17825. :selected (not org-descriptive-links)])
  17826. "--"
  17827. ("TODO Lists"
  17828. ["TODO/DONE/-" org-todo t]
  17829. ("Select keyword"
  17830. ["Next keyword" org-shiftright (org-at-heading-p)]
  17831. ["Previous keyword" org-shiftleft (org-at-heading-p)]
  17832. ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
  17833. ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
  17834. ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
  17835. ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
  17836. ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
  17837. "--"
  17838. ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
  17839. :selected org-enforce-todo-dependencies :style toggle :active t]
  17840. "Settings for tree at point"
  17841. ["Do Children sequentially" org-toggle-ordered-property :style radio
  17842. :selected (org-entry-get nil "ORDERED")
  17843. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  17844. ["Do Children parallel" org-toggle-ordered-property :style radio
  17845. :selected (not (org-entry-get nil "ORDERED"))
  17846. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  17847. "--"
  17848. ["Set Priority" org-priority t]
  17849. ["Priority Up" org-shiftup t]
  17850. ["Priority Down" org-shiftdown t]
  17851. "--"
  17852. ["Get news from all feeds" org-feed-update-all t]
  17853. ["Go to the inbox of a feed..." org-feed-goto-inbox t]
  17854. ["Customize feeds" (customize-variable 'org-feed-alist) t])
  17855. ("TAGS and Properties"
  17856. ["Set Tags" org-set-tags-command t]
  17857. ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
  17858. "--"
  17859. ["Set property" org-set-property t]
  17860. ["Column view of properties" org-columns t]
  17861. ["Insert Column View DBlock" org-insert-columns-dblock t])
  17862. ("Dates and Scheduling"
  17863. ["Timestamp" org-time-stamp t]
  17864. ["Timestamp (inactive)" org-time-stamp-inactive t]
  17865. ("Change Date"
  17866. ["1 Day Later" org-shiftright t]
  17867. ["1 Day Earlier" org-shiftleft t]
  17868. ["1 ... Later" org-shiftup t]
  17869. ["1 ... Earlier" org-shiftdown t])
  17870. ["Compute Time Range" org-evaluate-time-range t]
  17871. ["Schedule Item" org-schedule t]
  17872. ["Deadline" org-deadline t]
  17873. "--"
  17874. ["Custom time format" org-toggle-time-stamp-overlays
  17875. :style radio :selected org-display-custom-times]
  17876. "--"
  17877. ["Goto Calendar" org-goto-calendar t]
  17878. ["Date from Calendar" org-date-from-calendar t]
  17879. "--"
  17880. ["Start/Restart Timer" org-timer-start t]
  17881. ["Pause/Continue Timer" org-timer-pause-or-continue t]
  17882. ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
  17883. ["Insert Timer String" org-timer t]
  17884. ["Insert Timer Item" org-timer-item t])
  17885. ("Logging work"
  17886. ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
  17887. ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
  17888. ["Clock out" org-clock-out t]
  17889. ["Clock cancel" org-clock-cancel t]
  17890. "--"
  17891. ["Mark as default task" org-clock-mark-default-task t]
  17892. ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
  17893. ["Goto running clock" org-clock-goto t]
  17894. "--"
  17895. ["Display times" org-clock-display t]
  17896. ["Create clock table" org-clock-report t]
  17897. "--"
  17898. ["Record DONE time"
  17899. (progn (setq org-log-done (not org-log-done))
  17900. (message "Switching to %s will %s record a timestamp"
  17901. (car org-done-keywords)
  17902. (if org-log-done "automatically" "not")))
  17903. :style toggle :selected org-log-done])
  17904. "--"
  17905. ["Agenda Command..." org-agenda t]
  17906. ["Set Restriction Lock" org-agenda-set-restriction-lock t]
  17907. ("File List for Agenda")
  17908. ("Special views current file"
  17909. ["TODO Tree" org-show-todo-tree t]
  17910. ["Check Deadlines" org-check-deadlines t]
  17911. ["Timeline" org-timeline t]
  17912. ["Tags/Property tree" org-match-sparse-tree t])
  17913. "--"
  17914. ["Export/Publish..." org-export t]
  17915. ("LaTeX"
  17916. ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
  17917. :selected org-cdlatex-mode]
  17918. ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
  17919. ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
  17920. ["Modify math symbol" org-cdlatex-math-modify
  17921. (org-inside-LaTeX-fragment-p)]
  17922. ["Insert citation" org-reftex-citation t]
  17923. "--"
  17924. ["Template for BEAMER" (progn (require 'org-beamer)
  17925. (org-insert-beamer-options-template)) t])
  17926. "--"
  17927. ("MobileOrg"
  17928. ["Push Files and Views" org-mobile-push t]
  17929. ["Get Captured and Flagged" org-mobile-pull t]
  17930. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  17931. "--"
  17932. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  17933. "--"
  17934. ("Documentation"
  17935. ["Show Version" org-version t]
  17936. ["Info Documentation" org-info t])
  17937. ("Customize"
  17938. ["Browse Org Group" org-customize t]
  17939. "--"
  17940. ["Expand This Menu" org-create-customize-menu
  17941. (fboundp 'customize-menu-create)])
  17942. ["Send bug report" org-submit-bug-report t]
  17943. "--"
  17944. ("Refresh/Reload"
  17945. ["Refresh setup current buffer" org-mode-restart t]
  17946. ["Reload Org (after update)" org-reload t]
  17947. ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
  17948. ))
  17949. (defun org-info (&optional node)
  17950. "Read documentation for Org-mode in the info system.
  17951. With optional NODE, go directly to that node."
  17952. (interactive)
  17953. (info (format "(org)%s" (or node ""))))
  17954. ;;;###autoload
  17955. (defun org-submit-bug-report ()
  17956. "Submit a bug report on Org-mode via mail.
  17957. Don't hesitate to report any problems or inaccurate documentation.
  17958. If you don't have setup sending mail from (X)Emacs, please copy the
  17959. output buffer into your mail program, as it gives us important
  17960. information about your Org-mode version and configuration."
  17961. (interactive)
  17962. (require 'reporter)
  17963. (org-load-modules-maybe)
  17964. (org-require-autoloaded-modules)
  17965. (let ((reporter-prompt-for-summary-p "Bug report subject: "))
  17966. (reporter-submit-bug-report
  17967. "emacs-orgmode@gnu.org"
  17968. (org-version nil 'full)
  17969. (let (list)
  17970. (save-window-excursion
  17971. (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
  17972. (delete-other-windows)
  17973. (erase-buffer)
  17974. (insert "You are about to submit a bug report to the Org-mode mailing list.
  17975. We would like to add your full Org-mode and Outline configuration to the
  17976. bug report. This greatly simplifies the work of the maintainer and
  17977. other experts on the mailing list.
  17978. HOWEVER, some variables you have customized may contain private
  17979. information. The names of customers, colleagues, or friends, might
  17980. appear in the form of file names, tags, todo states, or search strings.
  17981. If you answer yes to the prompt, you might want to check and remove
  17982. such private information before sending the email.")
  17983. (add-text-properties (point-min) (point-max) '(face org-warning))
  17984. (when (yes-or-no-p "Include your Org-mode configuration ")
  17985. (mapatoms
  17986. (lambda (v)
  17987. (and (boundp v)
  17988. (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
  17989. (or (and (symbol-value v)
  17990. (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
  17991. (and
  17992. (get v 'custom-type) (get v 'standard-value)
  17993. (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
  17994. (push v list)))))
  17995. (kill-buffer (get-buffer "*Warn about privacy*"))
  17996. list))
  17997. nil nil
  17998. "Remember to cover the basics, that is, what you expected to happen and
  17999. what in fact did happen. You don't know how to make a good report? See
  18000. http://orgmode.org/manual/Feedback.html#Feedback
  18001. Your bug report will be posted to the Org-mode mailing list.
  18002. ------------------------------------------------------------------------")
  18003. (save-excursion
  18004. (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
  18005. (replace-match "\\1Bug: \\3 [\\2]")))))
  18006. (defun org-install-agenda-files-menu ()
  18007. (let ((bl (buffer-list)))
  18008. (save-excursion
  18009. (while bl
  18010. (set-buffer (pop bl))
  18011. (if (derived-mode-p 'org-mode) (setq bl nil)))
  18012. (when (derived-mode-p 'org-mode)
  18013. (easy-menu-change
  18014. '("Org") "File List for Agenda"
  18015. (append
  18016. (list
  18017. ["Edit File List" (org-edit-agenda-file-list) t]
  18018. ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
  18019. ["Remove Current File from List" org-remove-file t]
  18020. ["Cycle through agenda files" org-cycle-agenda-files t]
  18021. ["Occur in all agenda files" org-occur-in-agenda-files t]
  18022. "--")
  18023. (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
  18024. ;;;; Documentation
  18025. ;;;###autoload
  18026. (defun org-require-autoloaded-modules ()
  18027. (interactive)
  18028. (mapc 'require
  18029. '(org-agenda org-archive org-ascii org-attach org-clock org-colview
  18030. org-docbook org-exp org-html org-icalendar
  18031. org-id org-latex
  18032. org-publish org-remember org-table
  18033. org-timer org-xoxo)))
  18034. ;;;###autoload
  18035. (defun org-reload (&optional uncompiled)
  18036. "Reload all org lisp files.
  18037. With prefix arg UNCOMPILED, load the uncompiled versions."
  18038. (interactive "P")
  18039. (require 'find-func)
  18040. (let* ((file-re "^org\\(-.*\\)?\\.el")
  18041. (dir-org (file-name-directory (org-find-library-dir "org")))
  18042. (dir-org-contrib (ignore-errors
  18043. (file-name-directory
  18044. (org-find-library-dir "org-contribdir"))))
  18045. (babel-files
  18046. (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
  18047. (append (list nil "comint" "eval" "exp" "keys"
  18048. "lob" "ref" "table" "tangle")
  18049. (delq nil
  18050. (mapcar
  18051. (lambda (lang)
  18052. (when (cdr lang) (symbol-name (car lang))))
  18053. org-babel-load-languages)))))
  18054. (files
  18055. (append babel-files
  18056. (and dir-org-contrib
  18057. (directory-files dir-org-contrib t file-re))
  18058. (directory-files dir-org t file-re)))
  18059. (remove-re (concat (if (featurep 'xemacs)
  18060. "org-colview" "org-colview-xemacs")
  18061. "\\'")))
  18062. (setq files (mapcar 'file-name-sans-extension files))
  18063. (setq files (mapcar
  18064. (lambda (x) (if (string-match remove-re x) nil x))
  18065. files))
  18066. (setq files (delq nil files))
  18067. (mapc
  18068. (lambda (f)
  18069. (when (featurep (intern (file-name-nondirectory f)))
  18070. (if (and (not uncompiled)
  18071. (file-exists-p (concat f ".elc")))
  18072. (load (concat f ".elc") nil nil 'nosuffix)
  18073. (load (concat f ".el") nil nil 'nosuffix))))
  18074. files)
  18075. (load (concat dir-org "org-version.el") 'noerror nil 'nosuffix))
  18076. (org-version nil 'full 'message))
  18077. ;;;###autoload
  18078. (defun org-customize ()
  18079. "Call the customize function with org as argument."
  18080. (interactive)
  18081. (org-load-modules-maybe)
  18082. (org-require-autoloaded-modules)
  18083. (customize-browse 'org))
  18084. (defun org-create-customize-menu ()
  18085. "Create a full customization menu for Org-mode, insert it into the menu."
  18086. (interactive)
  18087. (org-load-modules-maybe)
  18088. (org-require-autoloaded-modules)
  18089. (if (fboundp 'customize-menu-create)
  18090. (progn
  18091. (easy-menu-change
  18092. '("Org") "Customize"
  18093. `(["Browse Org group" org-customize t]
  18094. "--"
  18095. ,(customize-menu-create 'org)
  18096. ["Set" Custom-set t]
  18097. ["Save" Custom-save t]
  18098. ["Reset to Current" Custom-reset-current t]
  18099. ["Reset to Saved" Custom-reset-saved t]
  18100. ["Reset to Standard Settings" Custom-reset-standard t]))
  18101. (message "\"Org\"-menu now contains full customization menu"))
  18102. (error "Cannot expand menu (outdated version of cus-edit.el)")))
  18103. ;;;; Miscellaneous stuff
  18104. ;;; Generally useful functions
  18105. (defun org-get-at-bol (property)
  18106. "Get text property PROPERTY at beginning of line."
  18107. (get-text-property (point-at-bol) property))
  18108. (defun org-find-text-property-in-string (prop s)
  18109. "Return the first non-nil value of property PROP in string S."
  18110. (or (get-text-property 0 prop s)
  18111. (get-text-property (or (next-single-property-change 0 prop s) 0)
  18112. prop s)))
  18113. (defun org-display-warning (message) ;; Copied from Emacs-Muse
  18114. "Display the given MESSAGE as a warning."
  18115. (if (fboundp 'display-warning)
  18116. (display-warning 'org message
  18117. (if (featurep 'xemacs) 'warning :warning))
  18118. (let ((buf (get-buffer-create "*Org warnings*")))
  18119. (with-current-buffer buf
  18120. (goto-char (point-max))
  18121. (insert "Warning (Org): " message)
  18122. (unless (bolp)
  18123. (newline)))
  18124. (display-buffer buf)
  18125. (sit-for 0))))
  18126. (defun org-eval (form)
  18127. "Eval FORM and return result."
  18128. (condition-case error
  18129. (eval form)
  18130. (error (format "%%![Error: %s]" error))))
  18131. (defun org-in-clocktable-p ()
  18132. "Check if the cursor is in a clocktable."
  18133. (let ((pos (point)) start)
  18134. (save-excursion
  18135. (end-of-line 1)
  18136. (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
  18137. (setq start (match-beginning 0))
  18138. (re-search-forward "^[ \t]*#\\+END:.*" nil t)
  18139. (>= (match-end 0) pos)
  18140. start))))
  18141. (defun org-in-commented-line ()
  18142. "Is point in a line starting with `#'?"
  18143. (equal (char-after (point-at-bol)) ?#))
  18144. (defun org-in-indented-comment-line ()
  18145. "Is point in a line starting with `#' after some white space?"
  18146. (save-excursion
  18147. (save-match-data
  18148. (goto-char (point-at-bol))
  18149. (looking-at "[ \t]*#"))))
  18150. (defun org-in-verbatim-emphasis ()
  18151. (save-match-data
  18152. (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
  18153. (defun org-goto-marker-or-bmk (marker &optional bookmark)
  18154. "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
  18155. (if (and marker (marker-buffer marker)
  18156. (buffer-live-p (marker-buffer marker)))
  18157. (progn
  18158. (org-pop-to-buffer-same-window (marker-buffer marker))
  18159. (if (or (> marker (point-max)) (< marker (point-min)))
  18160. (widen))
  18161. (goto-char marker)
  18162. (org-show-context 'org-goto))
  18163. (if bookmark
  18164. (bookmark-jump bookmark)
  18165. (error "Cannot find location"))))
  18166. (defun org-quote-csv-field (s)
  18167. "Quote field for inclusion in CSV material."
  18168. (if (string-match "[\",]" s)
  18169. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
  18170. s))
  18171. (defun org-force-self-insert (N)
  18172. "Needed to enforce self-insert under remapping."
  18173. (interactive "p")
  18174. (self-insert-command N))
  18175. (defun org-string-width (s)
  18176. "Compute width of string, ignoring invisible characters.
  18177. This ignores character with invisibility property `org-link', and also
  18178. characters with property `org-cwidth', because these will become invisible
  18179. upon the next fontification round."
  18180. (let (b l)
  18181. (when (or (eq t buffer-invisibility-spec)
  18182. (assq 'org-link buffer-invisibility-spec))
  18183. (while (setq b (text-property-any 0 (length s)
  18184. 'invisible 'org-link s))
  18185. (setq s (concat (substring s 0 b)
  18186. (substring s (or (next-single-property-change
  18187. b 'invisible s) (length s)))))))
  18188. (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
  18189. (setq s (concat (substring s 0 b)
  18190. (substring s (or (next-single-property-change
  18191. b 'org-cwidth s) (length s))))))
  18192. (setq l (string-width s) b -1)
  18193. (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
  18194. (setq l (- l (get-text-property b 'org-dwidth-n s))))
  18195. l))
  18196. (defun org-shorten-string (s maxlength)
  18197. "Shorten string S so tht it is no longer than MAXLENGTH characters.
  18198. If the string is shorter or has length MAXLENGTH, just return the
  18199. original string. If it is longer, the functions finds a space in the
  18200. string, breaks this string off at that locations and adds three dots
  18201. as ellipsis. Including the ellipsis, the string will not be longer
  18202. than MAXLENGTH. If finding a good breaking point in the string does
  18203. not work, the string is just chopped off in the middle of a word
  18204. if necessary."
  18205. (if (<= (length s) maxlength)
  18206. s
  18207. (let* ((n (max (- maxlength 4) 1))
  18208. (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
  18209. (if (string-match re s)
  18210. (concat (match-string 1 s) "...")
  18211. (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
  18212. (defun org-get-indentation (&optional line)
  18213. "Get the indentation of the current line, interpreting tabs.
  18214. When LINE is given, assume it represents a line and compute its indentation."
  18215. (if line
  18216. (if (string-match "^ *" (org-remove-tabs line))
  18217. (match-end 0))
  18218. (save-excursion
  18219. (beginning-of-line 1)
  18220. (skip-chars-forward " \t")
  18221. (current-column))))
  18222. (defun org-get-string-indentation (s)
  18223. "What indentation has S due to SPACE and TAB at the beginning of the string?"
  18224. (let ((n -1) (i 0) (w tab-width) c)
  18225. (catch 'exit
  18226. (while (< (setq n (1+ n)) (length s))
  18227. (setq c (aref s n))
  18228. (cond ((= c ?\ ) (setq i (1+ i)))
  18229. ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
  18230. (t (throw 'exit t)))))
  18231. i))
  18232. (defun org-remove-tabs (s &optional width)
  18233. "Replace tabulators in S with spaces.
  18234. Assumes that s is a single line, starting in column 0."
  18235. (setq width (or width tab-width))
  18236. (while (string-match "\t" s)
  18237. (setq s (replace-match
  18238. (make-string
  18239. (- (* width (/ (+ (match-beginning 0) width) width))
  18240. (match-beginning 0)) ?\ )
  18241. t t s)))
  18242. s)
  18243. (defun org-fix-indentation (line ind)
  18244. "Fix indentation in LINE.
  18245. IND is a cons cell with target and minimum indentation.
  18246. If the current indentation in LINE is smaller than the minimum,
  18247. leave it alone. If it is larger than ind, set it to the target."
  18248. (let* ((l (org-remove-tabs line))
  18249. (i (org-get-indentation l))
  18250. (i1 (car ind)) (i2 (cdr ind)))
  18251. (if (>= i i2) (setq l (substring line i2)))
  18252. (if (> i1 0)
  18253. (concat (make-string i1 ?\ ) l)
  18254. l)))
  18255. (defun org-remove-indentation (code &optional n)
  18256. "Remove the maximum common indentation from the lines in CODE.
  18257. N may optionally be the number of spaces to remove."
  18258. (with-temp-buffer
  18259. (insert code)
  18260. (org-do-remove-indentation n)
  18261. (buffer-string)))
  18262. (defun org-do-remove-indentation (&optional n)
  18263. "Remove the maximum common indentation from the buffer."
  18264. (untabify (point-min) (point-max))
  18265. (let ((min 10000) re)
  18266. (if n
  18267. (setq min n)
  18268. (goto-char (point-min))
  18269. (while (re-search-forward "^ *[^ \n]" nil t)
  18270. (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
  18271. (unless (or (= min 0) (= min 10000))
  18272. (setq re (format "^ \\{%d\\}" min))
  18273. (goto-char (point-min))
  18274. (while (re-search-forward re nil t)
  18275. (replace-match "")
  18276. (end-of-line 1))
  18277. min)))
  18278. (defun org-fill-template (template alist)
  18279. "Find each %key of ALIST in TEMPLATE and replace it."
  18280. (let ((case-fold-search nil)
  18281. entry key value)
  18282. (setq alist (sort (copy-sequence alist)
  18283. (lambda (a b) (< (length (car a)) (length (car b))))))
  18284. (while (setq entry (pop alist))
  18285. (setq template
  18286. (replace-regexp-in-string
  18287. (concat "%" (regexp-quote (car entry)))
  18288. (cdr entry) template t t)))
  18289. template))
  18290. (defun org-base-buffer (buffer)
  18291. "Return the base buffer of BUFFER, if it has one. Else return the buffer."
  18292. (if (not buffer)
  18293. buffer
  18294. (or (buffer-base-buffer buffer)
  18295. buffer)))
  18296. (defun org-trim (s)
  18297. "Remove whitespace at beginning and end of string."
  18298. (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
  18299. (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
  18300. s)
  18301. (defun org-wrap (string &optional width lines)
  18302. "Wrap string to either a number of lines, or a width in characters.
  18303. If WIDTH is non-nil, the string is wrapped to that width, however many lines
  18304. that costs. If there is a word longer than WIDTH, the text is actually
  18305. wrapped to the length of that word.
  18306. IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
  18307. many lines, whatever width that takes.
  18308. The return value is a list of lines, without newlines at the end."
  18309. (let* ((words (org-split-string string "[ \t\n]+"))
  18310. (maxword (apply 'max (mapcar 'org-string-width words)))
  18311. w ll)
  18312. (cond (width
  18313. (org-do-wrap words (max maxword width)))
  18314. (lines
  18315. (setq w maxword)
  18316. (setq ll (org-do-wrap words maxword))
  18317. (if (<= (length ll) lines)
  18318. ll
  18319. (setq ll words)
  18320. (while (> (length ll) lines)
  18321. (setq w (1+ w))
  18322. (setq ll (org-do-wrap words w)))
  18323. ll))
  18324. (t (error "Cannot wrap this")))))
  18325. (defun org-do-wrap (words width)
  18326. "Create lines of maximum width WIDTH (in characters) from word list WORDS."
  18327. (let (lines line)
  18328. (while words
  18329. (setq line (pop words))
  18330. (while (and words (< (+ (length line) (length (car words))) width))
  18331. (setq line (concat line " " (pop words))))
  18332. (setq lines (push line lines)))
  18333. (nreverse lines)))
  18334. (defun org-split-string (string &optional separators)
  18335. "Splits STRING into substrings at SEPARATORS.
  18336. No empty strings are returned if there are matches at the beginning
  18337. and end of string."
  18338. (let ((rexp (or separators "[ \f\t\n\r\v]+"))
  18339. (start 0)
  18340. notfirst
  18341. (list nil))
  18342. (while (and (string-match rexp string
  18343. (if (and notfirst
  18344. (= start (match-beginning 0))
  18345. (< start (length string)))
  18346. (1+ start) start))
  18347. (< (match-beginning 0) (length string)))
  18348. (setq notfirst t)
  18349. (or (eq (match-beginning 0) 0)
  18350. (and (eq (match-beginning 0) (match-end 0))
  18351. (eq (match-beginning 0) start))
  18352. (setq list
  18353. (cons (substring string start (match-beginning 0))
  18354. list)))
  18355. (setq start (match-end 0)))
  18356. (or (eq start (length string))
  18357. (setq list
  18358. (cons (substring string start)
  18359. list)))
  18360. (nreverse list)))
  18361. (defun org-quote-vert (s)
  18362. "Replace \"|\" with \"\\vert\"."
  18363. (while (string-match "|" s)
  18364. (setq s (replace-match "\\vert" t t s)))
  18365. s)
  18366. (defun org-uuidgen-p (s)
  18367. "Is S an ID created by UUIDGEN?"
  18368. (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
  18369. (defun org-in-src-block-p nil
  18370. "Whether point is in a code source block."
  18371. (let (ov)
  18372. (when (setq ov (overlays-at (point)))
  18373. (memq 'org-block-background
  18374. (overlay-properties
  18375. (car ov))))))
  18376. (defun org-context ()
  18377. "Return a list of contexts of the current cursor position.
  18378. If several contexts apply, all are returned.
  18379. Each context entry is a list with a symbol naming the context, and
  18380. two positions indicating start and end of the context. Possible
  18381. contexts are:
  18382. :headline anywhere in a headline
  18383. :headline-stars on the leading stars in a headline
  18384. :todo-keyword on a TODO keyword (including DONE) in a headline
  18385. :tags on the TAGS in a headline
  18386. :priority on the priority cookie in a headline
  18387. :item on the first line of a plain list item
  18388. :item-bullet on the bullet/number of a plain list item
  18389. :checkbox on the checkbox in a plain list item
  18390. :table in an org-mode table
  18391. :table-special on a special filed in a table
  18392. :table-table in a table.el table
  18393. :clocktable in a clocktable
  18394. :src-block in a source block
  18395. :link on a hyperlink
  18396. :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
  18397. :target on a <<target>>
  18398. :radio-target on a <<<radio-target>>>
  18399. :latex-fragment on a LaTeX fragment
  18400. :latex-preview on a LaTeX fragment with overlaid preview image
  18401. This function expects the position to be visible because it uses font-lock
  18402. faces as a help to recognize the following contexts: :table-special, :link,
  18403. and :keyword."
  18404. (let* ((f (get-text-property (point) 'face))
  18405. (faces (if (listp f) f (list f)))
  18406. (case-fold-search t)
  18407. (p (point)) clist o)
  18408. ;; First the large context
  18409. (cond
  18410. ((org-at-heading-p t)
  18411. (push (list :headline (point-at-bol) (point-at-eol)) clist)
  18412. (when (progn
  18413. (beginning-of-line 1)
  18414. (looking-at org-todo-line-tags-regexp))
  18415. (push (org-point-in-group p 1 :headline-stars) clist)
  18416. (push (org-point-in-group p 2 :todo-keyword) clist)
  18417. (push (org-point-in-group p 4 :tags) clist))
  18418. (goto-char p)
  18419. (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
  18420. (if (looking-at "\\[#[A-Z0-9]\\]")
  18421. (push (org-point-in-group p 0 :priority) clist)))
  18422. ((org-at-item-p)
  18423. (push (org-point-in-group p 2 :item-bullet) clist)
  18424. (push (list :item (point-at-bol)
  18425. (save-excursion (org-end-of-item) (point)))
  18426. clist)
  18427. (and (org-at-item-checkbox-p)
  18428. (push (org-point-in-group p 0 :checkbox) clist)))
  18429. ((org-at-table-p)
  18430. (push (list :table (org-table-begin) (org-table-end)) clist)
  18431. (if (memq 'org-formula faces)
  18432. (push (list :table-special
  18433. (previous-single-property-change p 'face)
  18434. (next-single-property-change p 'face)) clist)))
  18435. ((org-at-table-p 'any)
  18436. (push (list :table-table) clist)))
  18437. (goto-char p)
  18438. ;; New the "medium" contexts: clocktables, source blocks
  18439. (cond ((org-in-clocktable-p)
  18440. (push (list :clocktable
  18441. (and (or (looking-at "#\\+BEGIN: clocktable")
  18442. (search-backward "#+BEGIN: clocktable" nil t))
  18443. (match-beginning 0))
  18444. (and (re-search-forward "#\\+END:?" nil t)
  18445. (match-end 0))) clist))
  18446. ((org-in-src-block-p)
  18447. (push (list :src-block
  18448. (and (or (looking-at "#\\+BEGIN_SRC")
  18449. (search-backward "#+BEGIN_SRC" nil t))
  18450. (match-beginning 0))
  18451. (and (search-forward "#+END_SRC" nil t)
  18452. (match-beginning 0))) clist)))
  18453. (goto-char p)
  18454. ;; Now the small context
  18455. (cond
  18456. ((org-at-timestamp-p)
  18457. (push (org-point-in-group p 0 :timestamp) clist))
  18458. ((memq 'org-link faces)
  18459. (push (list :link
  18460. (previous-single-property-change p 'face)
  18461. (next-single-property-change p 'face)) clist))
  18462. ((memq 'org-special-keyword faces)
  18463. (push (list :keyword
  18464. (previous-single-property-change p 'face)
  18465. (next-single-property-change p 'face)) clist))
  18466. ((org-at-target-p)
  18467. (push (org-point-in-group p 0 :target) clist)
  18468. (goto-char (1- (match-beginning 0)))
  18469. (if (looking-at org-radio-target-regexp)
  18470. (push (org-point-in-group p 0 :radio-target) clist))
  18471. (goto-char p))
  18472. ((setq o (car (delq nil
  18473. (mapcar
  18474. (lambda (x)
  18475. (if (memq x org-latex-fragment-image-overlays) x))
  18476. (overlays-at (point))))))
  18477. (push (list :latex-fragment
  18478. (overlay-start o) (overlay-end o)) clist)
  18479. (push (list :latex-preview
  18480. (overlay-start o) (overlay-end o)) clist))
  18481. ((org-inside-LaTeX-fragment-p)
  18482. ;; FIXME: positions wrong.
  18483. (push (list :latex-fragment (point) (point)) clist)))
  18484. (setq clist (nreverse (delq nil clist)))
  18485. clist))
  18486. ;; FIXME: Compare with at-regexp-p Do we need both?
  18487. (defun org-in-regexp (re &optional nlines visually)
  18488. "Check if point is inside a match of regexp.
  18489. Normally only the current line is checked, but you can include NLINES extra
  18490. lines both before and after point into the search.
  18491. If VISUALLY is set, require that the cursor is not after the match but
  18492. really on, so that the block visually is on the match."
  18493. (catch 'exit
  18494. (let ((pos (point))
  18495. (eol (point-at-eol (+ 1 (or nlines 0))))
  18496. (inc (if visually 1 0)))
  18497. (save-excursion
  18498. (beginning-of-line (- 1 (or nlines 0)))
  18499. (while (re-search-forward re eol t)
  18500. (if (and (<= (match-beginning 0) pos)
  18501. (>= (+ inc (match-end 0)) pos))
  18502. (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
  18503. (defun org-at-regexp-p (regexp)
  18504. "Is point inside a match of REGEXP in the current line?"
  18505. (catch 'exit
  18506. (save-excursion
  18507. (let ((pos (point)) (end (point-at-eol)))
  18508. (beginning-of-line 1)
  18509. (while (re-search-forward regexp end t)
  18510. (if (and (<= (match-beginning 0) pos)
  18511. (>= (match-end 0) pos))
  18512. (throw 'exit t)))
  18513. nil))))
  18514. (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
  18515. "Non-nil when point is between matches of START-RE and END-RE.
  18516. Also return a non-nil value when point is on one of the matches.
  18517. Optional arguments LIM-UP and LIM-DOWN bound the search; they are
  18518. buffer positions. Default values are the positions of headlines
  18519. surrounding the point.
  18520. The functions returns a cons cell whose car (resp. cdr) is the
  18521. position before START-RE (resp. after END-RE)."
  18522. (save-match-data
  18523. (let ((pos (point))
  18524. (limit-up (or lim-up (save-excursion (outline-previous-heading))))
  18525. (limit-down (or lim-down (save-excursion (outline-next-heading))))
  18526. beg end)
  18527. (save-excursion
  18528. ;; Point is on a block when on START-RE or if START-RE can be
  18529. ;; found before it...
  18530. (and (or (org-at-regexp-p start-re)
  18531. (re-search-backward start-re limit-up t))
  18532. (setq beg (match-beginning 0))
  18533. ;; ... and END-RE after it...
  18534. (goto-char (match-end 0))
  18535. (re-search-forward end-re limit-down t)
  18536. (> (setq end (match-end 0)) pos)
  18537. ;; ... without another START-RE in-between.
  18538. (goto-char (match-beginning 0))
  18539. (not (re-search-backward start-re (1+ beg) t))
  18540. ;; Return value.
  18541. (cons beg end))))))
  18542. (defun org-in-block-p (names)
  18543. "Non-nil when point belongs to a block whose name belongs to NAMES.
  18544. NAMES is a list of strings containing names of blocks.
  18545. Return first block name matched, or nil. Beware that in case of
  18546. nested blocks, the returned name may not belong to the closest
  18547. block from point."
  18548. (save-match-data
  18549. (catch 'exit
  18550. (let ((case-fold-search t)
  18551. (lim-up (save-excursion (outline-previous-heading)))
  18552. (lim-down (save-excursion (outline-next-heading))))
  18553. (mapc (lambda (name)
  18554. (let ((n (regexp-quote name)))
  18555. (when (org-between-regexps-p
  18556. (concat "^[ \t]*#\\+begin_" n)
  18557. (concat "^[ \t]*#\\+end_" n)
  18558. lim-up lim-down)
  18559. (throw 'exit n))))
  18560. names))
  18561. nil)))
  18562. (defun org-occur-in-agenda-files (regexp &optional nlines)
  18563. "Call `multi-occur' with buffers for all agenda files."
  18564. (interactive "sOrg-files matching: \np")
  18565. (let* ((files (org-agenda-files))
  18566. (tnames (mapcar 'file-truename files))
  18567. (extra org-agenda-text-search-extra-files)
  18568. f)
  18569. (when (eq (car extra) 'agenda-archives)
  18570. (setq extra (cdr extra))
  18571. (setq files (org-add-archive-files files)))
  18572. (while (setq f (pop extra))
  18573. (unless (member (file-truename f) tnames)
  18574. (add-to-list 'files f 'append)
  18575. (add-to-list 'tnames (file-truename f) 'append)))
  18576. (multi-occur
  18577. (mapcar (lambda (x)
  18578. (with-current-buffer
  18579. (or (get-file-buffer x) (find-file-noselect x))
  18580. (widen)
  18581. (current-buffer)))
  18582. files)
  18583. regexp)))
  18584. (if (boundp 'occur-mode-find-occurrence-hook)
  18585. ;; Emacs 23
  18586. (add-hook 'occur-mode-find-occurrence-hook
  18587. (lambda ()
  18588. (when (derived-mode-p 'org-mode)
  18589. (org-reveal))))
  18590. ;; Emacs 22
  18591. (defadvice occur-mode-goto-occurrence
  18592. (after org-occur-reveal activate)
  18593. (and (derived-mode-p 'org-mode) (org-reveal)))
  18594. (defadvice occur-mode-goto-occurrence-other-window
  18595. (after org-occur-reveal activate)
  18596. (and (derived-mode-p 'org-mode) (org-reveal)))
  18597. (defadvice occur-mode-display-occurrence
  18598. (after org-occur-reveal activate)
  18599. (when (derived-mode-p 'org-mode)
  18600. (let ((pos (occur-mode-find-occurrence)))
  18601. (with-current-buffer (marker-buffer pos)
  18602. (save-excursion
  18603. (goto-char pos)
  18604. (org-reveal)))))))
  18605. (defun org-occur-link-in-agenda-files ()
  18606. "Create a link and search for it in the agendas.
  18607. The link is not stored in `org-stored-links', it is just created
  18608. for the search purpose."
  18609. (interactive)
  18610. (let ((link (condition-case nil
  18611. (org-store-link nil)
  18612. (error "Unable to create a link to here"))))
  18613. (org-occur-in-agenda-files (regexp-quote link))))
  18614. (defun org-uniquify (list)
  18615. "Remove duplicate elements from LIST."
  18616. (let (res)
  18617. (mapc (lambda (x) (add-to-list 'res x 'append)) list)
  18618. res))
  18619. (defun org-delete-all (elts list)
  18620. "Remove all elements in ELTS from LIST."
  18621. (while elts
  18622. (setq list (delete (pop elts) list)))
  18623. list)
  18624. (defun org-count (cl-item cl-seq)
  18625. "Count the number of occurrences of ITEM in SEQ.
  18626. Taken from `count' in cl-seq.el with all keyword arguments removed."
  18627. (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
  18628. (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
  18629. (while (< cl-start cl-end)
  18630. (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
  18631. (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
  18632. (setq cl-start (1+ cl-start)))
  18633. cl-count))
  18634. (defun org-remove-if (predicate seq)
  18635. "Remove everything from SEQ that fulfills PREDICATE."
  18636. (let (res e)
  18637. (while seq
  18638. (setq e (pop seq))
  18639. (if (not (funcall predicate e)) (push e res)))
  18640. (nreverse res)))
  18641. (defun org-remove-if-not (predicate seq)
  18642. "Remove everything from SEQ that does not fulfill PREDICATE."
  18643. (let (res e)
  18644. (while seq
  18645. (setq e (pop seq))
  18646. (if (funcall predicate e) (push e res)))
  18647. (nreverse res)))
  18648. (defun org-reduce (cl-func cl-seq &rest cl-keys)
  18649. "Reduce two-argument FUNCTION across SEQ.
  18650. Taken from `reduce' in cl-seq.el with all keyword arguments but
  18651. \":initial-value\" removed."
  18652. (let ((cl-accum (cond ((memq :initial-value cl-keys)
  18653. (cadr (memq :initial-value cl-keys)))
  18654. (cl-seq (pop cl-seq))
  18655. (t (funcall cl-func)))))
  18656. (while cl-seq
  18657. (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
  18658. cl-accum))
  18659. (defun org-back-over-empty-lines ()
  18660. "Move backwards over whitespace, to the beginning of the first empty line.
  18661. Returns the number of empty lines passed."
  18662. (let ((pos (point)))
  18663. (if (cdr (assoc 'heading org-blank-before-new-entry))
  18664. (skip-chars-backward " \t\n\r")
  18665. (unless (eobp)
  18666. (forward-line -1)))
  18667. (beginning-of-line 2)
  18668. (goto-char (min (point) pos))
  18669. (count-lines (point) pos)))
  18670. (defun org-skip-whitespace ()
  18671. (skip-chars-forward " \t\n\r"))
  18672. (defun org-point-in-group (point group &optional context)
  18673. "Check if POINT is in match-group GROUP.
  18674. If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
  18675. match. If the match group does not exist or point is not inside it,
  18676. return nil."
  18677. (and (match-beginning group)
  18678. (>= point (match-beginning group))
  18679. (<= point (match-end group))
  18680. (if context
  18681. (list context (match-beginning group) (match-end group))
  18682. t)))
  18683. (defun org-switch-to-buffer-other-window (&rest args)
  18684. "Switch to buffer in a second window on the current frame.
  18685. In particular, do not allow pop-up frames.
  18686. Returns the newly created buffer."
  18687. (let (pop-up-frames special-display-buffer-names special-display-regexps
  18688. special-display-function)
  18689. (apply 'switch-to-buffer-other-window args)))
  18690. (defun org-combine-plists (&rest plists)
  18691. "Create a single property list from all plists in PLISTS.
  18692. The process starts by copying the first list, and then setting properties
  18693. from the other lists. Settings in the last list are the most significant
  18694. ones and overrule settings in the other lists."
  18695. (let ((rtn (copy-sequence (pop plists)))
  18696. p v ls)
  18697. (while plists
  18698. (setq ls (pop plists))
  18699. (while ls
  18700. (setq p (pop ls) v (pop ls))
  18701. (setq rtn (plist-put rtn p v))))
  18702. rtn))
  18703. (defun org-replace-escapes (string table)
  18704. "Replace %-escapes in STRING with values in TABLE.
  18705. TABLE is an association list with keys like \"%a\" and string values.
  18706. The sequences in STRING may contain normal field width and padding information,
  18707. for example \"%-5s\". Replacements happen in the sequence given by TABLE,
  18708. so values can contain further %-escapes if they are define later in TABLE."
  18709. (let ((tbl (copy-alist table))
  18710. (case-fold-search nil)
  18711. (pchg 0)
  18712. e re rpl)
  18713. (while (setq e (pop tbl))
  18714. (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
  18715. (when (and (cdr e) (string-match re (cdr e)))
  18716. (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
  18717. (safe "SREF"))
  18718. (add-text-properties 0 3 (list 'sref sref) safe)
  18719. (setcdr e (replace-match safe t t (cdr e)))))
  18720. (while (string-match re string)
  18721. (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
  18722. (cdr e)))
  18723. (setq string (replace-match rpl t t string))))
  18724. (while (setq pchg (next-property-change pchg string))
  18725. (let ((sref (get-text-property pchg 'sref string)))
  18726. (when (and sref (string-match "SREF" string pchg))
  18727. (setq string (replace-match sref t t string)))))
  18728. string))
  18729. (defun org-sublist (list start end)
  18730. "Return a section of LIST, from START to END.
  18731. Counting starts at 1."
  18732. (let (rtn (c start))
  18733. (setq list (nthcdr (1- start) list))
  18734. (while (and list (<= c end))
  18735. (push (pop list) rtn)
  18736. (setq c (1+ c)))
  18737. (nreverse rtn)))
  18738. (defun org-find-base-buffer-visiting (file)
  18739. "Like `find-buffer-visiting' but always return the base buffer and
  18740. not an indirect buffer."
  18741. (let ((buf (or (get-file-buffer file)
  18742. (find-buffer-visiting file))))
  18743. (if buf
  18744. (or (buffer-base-buffer buf) buf)
  18745. nil)))
  18746. (defun org-image-file-name-regexp (&optional extensions)
  18747. "Return regexp matching the file names of images.
  18748. If EXTENSIONS is given, only match these."
  18749. (if (and (not extensions) (fboundp 'image-file-name-regexp))
  18750. (image-file-name-regexp)
  18751. (let ((image-file-name-extensions
  18752. (or extensions
  18753. '("png" "jpeg" "jpg" "gif" "tiff" "tif"
  18754. "xbm" "xpm" "pbm" "pgm" "ppm"))))
  18755. (concat "\\."
  18756. (regexp-opt (nconc (mapcar 'upcase
  18757. image-file-name-extensions)
  18758. image-file-name-extensions)
  18759. t)
  18760. "\\'"))))
  18761. (defun org-file-image-p (file &optional extensions)
  18762. "Return non-nil if FILE is an image."
  18763. (save-match-data
  18764. (string-match (org-image-file-name-regexp extensions) file)))
  18765. (defun org-get-cursor-date ()
  18766. "Return the date at cursor in as a time.
  18767. This works in the calendar and in the agenda, anywhere else it just
  18768. returns the current time."
  18769. (let (date day defd)
  18770. (cond
  18771. ((eq major-mode 'calendar-mode)
  18772. (setq date (calendar-cursor-to-date)
  18773. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  18774. ((eq major-mode 'org-agenda-mode)
  18775. (setq day (get-text-property (point) 'day))
  18776. (if day
  18777. (setq date (calendar-gregorian-from-absolute day)
  18778. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  18779. (nth 2 date))))))
  18780. (or defd (current-time))))
  18781. (defvar org-agenda-action-marker (make-marker)
  18782. "Marker pointing to the entry for the next agenda action.")
  18783. (defun org-mark-entry-for-agenda-action ()
  18784. "Mark the current entry as target of an agenda action.
  18785. Agenda actions are actions executed from the agenda with the key `k',
  18786. which make use of the date at the cursor."
  18787. (interactive)
  18788. (move-marker org-agenda-action-marker
  18789. (save-excursion (org-back-to-heading t) (point))
  18790. (current-buffer))
  18791. (message
  18792. "Entry marked for action; press `k' at desired date in agenda or calendar"))
  18793. (defun org-mark-subtree ()
  18794. "Mark the current subtree.
  18795. This puts point at the start of the current subtree, and mark at the end.
  18796. If point is in an inline task, mark that task instead."
  18797. (interactive)
  18798. (let ((inline-task-p
  18799. (and (featurep 'org-inlinetask)
  18800. (org-inlinetask-in-task-p)))
  18801. (beg))
  18802. ;; Get beginning of subtree
  18803. (cond
  18804. (inline-task-p (org-inlinetask-goto-beginning))
  18805. ((org-at-heading-p) (beginning-of-line))
  18806. (t (org-with-limited-levels (outline-previous-visible-heading 1))))
  18807. (setq beg (point))
  18808. ;; Get end of it
  18809. (if inline-task-p
  18810. (org-inlinetask-goto-end)
  18811. (org-end-of-subtree))
  18812. ;; Mark zone
  18813. (push-mark (point) nil t)
  18814. (goto-char beg)))
  18815. ;;; Paragraph filling stuff.
  18816. ;; We want this to be just right, so use the full arsenal.
  18817. (defun org-indent-line ()
  18818. "Indent line depending on context."
  18819. (interactive)
  18820. (let* ((pos (point))
  18821. (itemp (org-at-item-p))
  18822. (case-fold-search t)
  18823. (org-drawer-regexp (or org-drawer-regexp "\000"))
  18824. (inline-task-p (and (featurep 'org-inlinetask)
  18825. (org-inlinetask-in-task-p)))
  18826. (inline-re (and inline-task-p
  18827. (org-inlinetask-outline-regexp)))
  18828. column)
  18829. (beginning-of-line 1)
  18830. (cond
  18831. ;; Comments
  18832. ((looking-at "# ") (setq column 0))
  18833. ;; Headings
  18834. ((looking-at org-outline-regexp) (setq column 0))
  18835. ;; Included files
  18836. ((looking-at "#\\+include:") (setq column 0))
  18837. ;; Footnote definition
  18838. ((looking-at org-footnote-definition-re) (setq column 0))
  18839. ;; Literal examples
  18840. ((looking-at "[ \t]*:\\( \\|$\\)")
  18841. (setq column (org-get-indentation))) ; do nothing
  18842. ;; Lists
  18843. ((ignore-errors (goto-char (org-in-item-p)))
  18844. (setq column (if itemp
  18845. (org-get-indentation)
  18846. (org-list-item-body-column (point))))
  18847. (goto-char pos))
  18848. ;; Drawers
  18849. ((and (looking-at "[ \t]*:END:")
  18850. (save-excursion (re-search-backward org-drawer-regexp nil t)))
  18851. (save-excursion
  18852. (goto-char (1- (match-beginning 1)))
  18853. (setq column (current-column))))
  18854. ;; Special blocks
  18855. ((and (looking-at "[ \t]*#\\+end_\\([a-z]+\\)")
  18856. (save-excursion
  18857. (re-search-backward
  18858. (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
  18859. (setq column (org-get-indentation (match-string 0))))
  18860. ((and (not (looking-at "[ \t]*#\\+begin_"))
  18861. (org-between-regexps-p "^[ \t]*#\\+begin_" "[ \t]*#\\+end_"))
  18862. (save-excursion
  18863. (re-search-backward "^[ \t]*#\\+begin_\\([a-z]+\\)" nil t))
  18864. (setq column
  18865. (cond ((equal (downcase (match-string 1)) "src")
  18866. ;; src blocks: let `org-edit-src-exit' handle them
  18867. (org-get-indentation))
  18868. ((equal (downcase (match-string 1)) "example")
  18869. (max (org-get-indentation)
  18870. (org-get-indentation (match-string 0))))
  18871. (t
  18872. (org-get-indentation (match-string 0))))))
  18873. ;; This line has nothing special, look at the previous relevant
  18874. ;; line to compute indentation
  18875. (t
  18876. (beginning-of-line 0)
  18877. (while (and (not (bobp))
  18878. (not (looking-at org-drawer-regexp))
  18879. ;; When point started in an inline task, do not move
  18880. ;; above task starting line.
  18881. (not (and inline-task-p (looking-at inline-re)))
  18882. ;; Skip drawers, blocks, empty lines, verbatim,
  18883. ;; comments, tables, footnotes definitions, lists,
  18884. ;; inline tasks.
  18885. (or (and (looking-at "[ \t]*:END:")
  18886. (re-search-backward org-drawer-regexp nil t))
  18887. (and (looking-at "[ \t]*#\\+end_")
  18888. (re-search-backward "[ \t]*#\\+begin_"nil t))
  18889. (looking-at "[ \t]*[\n:#|]")
  18890. (looking-at org-footnote-definition-re)
  18891. (and (ignore-errors (goto-char (org-in-item-p)))
  18892. (goto-char
  18893. (org-list-get-top-point (org-list-struct))))
  18894. (and (not inline-task-p)
  18895. (featurep 'org-inlinetask)
  18896. (org-inlinetask-in-task-p)
  18897. (or (org-inlinetask-goto-beginning) t))))
  18898. (beginning-of-line 0))
  18899. (cond
  18900. ;; There was an heading above.
  18901. ((looking-at "\\*+[ \t]+")
  18902. (if (not org-adapt-indentation)
  18903. (setq column 0)
  18904. (goto-char (match-end 0))
  18905. (setq column (current-column))))
  18906. ;; A drawer had started and is unfinished
  18907. ((looking-at org-drawer-regexp)
  18908. (goto-char (1- (match-beginning 1)))
  18909. (setq column (current-column)))
  18910. ;; Else, nothing noticeable found: get indentation and go on.
  18911. (t (setq column (org-get-indentation))))))
  18912. ;; Now apply indentation and move cursor accordingly
  18913. (goto-char pos)
  18914. (if (<= (current-column) (current-indentation))
  18915. (org-indent-line-to column)
  18916. (save-excursion (org-indent-line-to column)))
  18917. ;; Special polishing for properties, see `org-property-format'
  18918. (setq column (current-column))
  18919. (beginning-of-line 1)
  18920. (if (looking-at
  18921. "\\([ \t]+\\)\\(:[-_0-9a-zA-Z]+:\\)[ \t]*\\(\\S-.*\\(\\S-\\|$\\)\\)")
  18922. (replace-match (concat (match-string 1)
  18923. (format org-property-format
  18924. (match-string 2) (match-string 3)))
  18925. t t))
  18926. (org-move-to-column column)
  18927. (when (and orgstruct-is-++ (eq pos (point)))
  18928. (org-let org-fb-vars
  18929. '(indent-according-to-mode)))))
  18930. (defun org-indent-drawer ()
  18931. "Indent the drawer at point."
  18932. (interactive)
  18933. (let ((p (point))
  18934. (e (and (save-excursion (re-search-forward ":END:" nil t))
  18935. (match-end 0)))
  18936. (folded
  18937. (save-excursion
  18938. (end-of-line)
  18939. (when (overlays-at (point))
  18940. (member 'invisible (overlay-properties
  18941. (car (overlays-at (point)))))))))
  18942. (when folded (org-cycle))
  18943. (indent-for-tab-command)
  18944. (while (and (move-beginning-of-line 2) (< (point) e))
  18945. (indent-for-tab-command))
  18946. (goto-char p)
  18947. (when folded (org-cycle)))
  18948. (message "Drawer at point indented"))
  18949. (defun org-indent-block ()
  18950. "Indent the block at point."
  18951. (interactive)
  18952. (let ((p (point))
  18953. (case-fold-search t)
  18954. (e (and (save-excursion (re-search-forward "#\\+end_?\\(?:[a-z]+\\)?" nil t))
  18955. (match-end 0)))
  18956. (folded
  18957. (save-excursion
  18958. (end-of-line)
  18959. (when (overlays-at (point))
  18960. (member 'invisible (overlay-properties
  18961. (car (overlays-at (point)))))))))
  18962. (when folded (org-cycle))
  18963. (indent-for-tab-command)
  18964. (while (and (move-beginning-of-line 2) (< (point) e))
  18965. (indent-for-tab-command))
  18966. (goto-char p)
  18967. (when folded (org-cycle)))
  18968. (message "Block at point indented"))
  18969. (defun org-indent-region (start end)
  18970. "Indent region."
  18971. (interactive "r")
  18972. (save-excursion
  18973. (let ((line-end (org-current-line end)))
  18974. (goto-char start)
  18975. (while (< (org-current-line) line-end)
  18976. (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
  18977. (t (call-interactively 'org-indent-line)))
  18978. (move-beginning-of-line 2)))))
  18979. ;; For reference, this is the default value of adaptive-fill-regexp
  18980. ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
  18981. (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
  18982. "Variable to store copy of `adaptive-fill-regexp'.
  18983. Since `adaptive-fill-regexp' is set to never match, we need to
  18984. store a backup of its value before entering `org-mode' so that
  18985. the functionality can be provided as a fall-back.")
  18986. (defun org-set-autofill-regexps ()
  18987. (interactive)
  18988. ;; In the paragraph separator we include headlines, because filling
  18989. ;; text in a line directly attached to a headline would otherwise
  18990. ;; fill the headline as well.
  18991. (org-set-local 'comment-start-skip "^#+[ \t]*")
  18992. (org-set-local 'paragraph-separate "\f\\|\\*+ \\|[ ]*$\\|[ \t]*[:|#]")
  18993. ;; The paragraph starter includes hand-formatted lists.
  18994. (org-set-local
  18995. 'paragraph-start
  18996. (concat
  18997. "\f" "\\|"
  18998. "[ ]*$" "\\|"
  18999. org-outline-regexp "\\|"
  19000. "[ \t]*#" "\\|"
  19001. (org-item-re) "\\|"
  19002. "[ \t]*[:|]" "\\|"
  19003. "\\$\\$" "\\|"
  19004. "\\\\\\(begin\\|end\\|[][]\\)"))
  19005. ;; Inhibit auto-fill for headers, tables and fixed-width lines.
  19006. ;; But only if the user has not turned off tables or fixed-width regions
  19007. (org-set-local
  19008. 'auto-fill-inhibit-regexp
  19009. (concat org-outline-regexp
  19010. "\\|#\\+"
  19011. "\\|[ \t]*" org-keyword-time-regexp
  19012. (if (or org-enable-table-editor org-enable-fixed-width-editor)
  19013. (concat
  19014. "\\|[ \t]*["
  19015. (if org-enable-table-editor "|" "")
  19016. (if org-enable-fixed-width-editor ":" "")
  19017. "]"))))
  19018. ;; We use our own fill-paragraph function, to make sure that tables
  19019. ;; and fixed-width regions are not wrapped. That function will pass
  19020. ;; through to `fill-paragraph' when appropriate.
  19021. (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
  19022. ;; Prevent auto-fill from inserting unwanted new items.
  19023. (if (boundp 'fill-nobreak-predicate)
  19024. (org-set-local
  19025. 'fill-nobreak-predicate
  19026. (org-uniquify
  19027. (append fill-nobreak-predicate
  19028. '(org-fill-item-nobreak-p org-fill-line-break-nobreak-p)))))
  19029. ;; Adaptive filling: To get full control, first make sure that
  19030. ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
  19031. (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
  19032. (org-set-local 'org-adaptive-fill-regexp-backup
  19033. adaptive-fill-regexp))
  19034. (org-set-local 'adaptive-fill-regexp "\000")
  19035. (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
  19036. (org-set-local 'adaptive-fill-function
  19037. 'org-adaptive-fill-function)
  19038. (org-set-local
  19039. 'align-mode-rules-list
  19040. '((org-in-buffer-settings
  19041. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  19042. (modes . '(org-mode))))))
  19043. (defun org-fill-item-nobreak-p ()
  19044. "Non-nil when a line break at point would insert a new item."
  19045. (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
  19046. (defun org-fill-line-break-nobreak-p ()
  19047. "Non-nil when a line break at point would create an Org line break."
  19048. (save-excursion
  19049. (skip-chars-backward "[ \t]")
  19050. (skip-chars-backward "\\\\")
  19051. (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
  19052. (defun org-fill-paragraph (&optional justify)
  19053. "Re-align a table, pass through to fill-paragraph if no table."
  19054. (let ((table-p (org-at-table-p))
  19055. (table.el-p (org-at-table.el-p))
  19056. (itemp (org-in-item-p))
  19057. (srcp (org-in-src-block-p)))
  19058. (cond ((and (equal (char-after (point-at-bol)) ?*)
  19059. (save-excursion (goto-char (point-at-bol))
  19060. (looking-at org-outline-regexp)))
  19061. t) ; skip headlines
  19062. (table.el-p t) ; skip table.el tables
  19063. (table-p (org-table-align) t) ; align Org tables
  19064. (srcp ; indent entire src block to prevent
  19065. (save-excursion ; fill-paragraph-as-region to mess up
  19066. (org-babel-do-in-edit-buffer
  19067. (indent-region (point-min) (point-max)))))
  19068. (itemp ; align text in items
  19069. (let* ((struct (save-excursion (goto-char itemp)
  19070. (org-list-struct)))
  19071. (parents (org-list-parents-alist struct))
  19072. (children (org-list-get-children itemp struct parents))
  19073. beg end prev next prefix)
  19074. ;; Determine in which part of item point is: before
  19075. ;; first child, after last child, between two
  19076. ;; sub-lists, or simply in item if there's no child.
  19077. (cond
  19078. ((not children)
  19079. (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
  19080. beg itemp
  19081. end (org-list-get-item-end itemp struct)))
  19082. ((< (point) (setq next (car children)))
  19083. (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
  19084. beg itemp
  19085. end next))
  19086. ((> (point) (setq prev (car (last children))))
  19087. (setq beg (org-list-get-item-end prev struct)
  19088. end (org-list-get-item-end itemp struct)
  19089. prefix (save-excursion
  19090. (goto-char beg)
  19091. (skip-chars-forward " \t")
  19092. (make-string (current-column) ?\ ))))
  19093. (t (catch 'exit
  19094. (while (setq next (pop children))
  19095. (if (> (point) next)
  19096. (setq prev next)
  19097. (setq beg (org-list-get-item-end prev struct)
  19098. end next
  19099. prefix (save-excursion
  19100. (goto-char beg)
  19101. (skip-chars-forward " \t")
  19102. (make-string (current-column) ?\ )))
  19103. (throw 'exit nil))))))
  19104. ;; Use `fill-paragraph' with buffer narrowed to item
  19105. ;; without any child, and with our computed PREFIX.
  19106. (flet ((fill-context-prefix (from to &optional flr) prefix))
  19107. (save-restriction
  19108. (narrow-to-region beg end)
  19109. (save-excursion (fill-paragraph justify)))) t))
  19110. ;; Special case where point is not in a list but is on
  19111. ;; a paragraph adjacent to a list: make sure this paragraph
  19112. ;; doesn't get merged with the end of the list by narrowing
  19113. ;; buffer first.
  19114. ((and (derived-mode-p 'org-mode)
  19115. (save-excursion (forward-paragraph -1)
  19116. (setq itemp (org-in-item-p))))
  19117. (let ((struct (save-excursion (goto-char itemp)
  19118. (org-list-struct))))
  19119. (save-restriction
  19120. (narrow-to-region (org-list-get-bottom-point struct)
  19121. (save-excursion (forward-paragraph 1)
  19122. (point)))
  19123. (fill-paragraph justify) t)))
  19124. ;; Don't fill schedule/deadline line before a paragraph
  19125. ;; This only makes sense in real org-mode buffers
  19126. ((and (eq major-mode 'org-mode)
  19127. (save-excursion (forward-paragraph -1)
  19128. (or (looking-at (concat "^[^\n]*" org-scheduled-regexp ".*$"))
  19129. (looking-at (concat "^[^\n]*" org-deadline-regexp ".*$")))))
  19130. (save-restriction
  19131. (narrow-to-region (1+ (match-end 0))
  19132. (save-excursion (forward-paragraph 1) (point)))
  19133. (fill-paragraph justify) t))
  19134. ;; Else fall back on fill-paragraph-function as possibly
  19135. ;; defined in `org-fb-vars'
  19136. (orgstruct-is-++
  19137. (org-let org-fb-vars
  19138. '(fill-paragraph justify)))
  19139. (t nil))))
  19140. (defun org-adaptive-fill-function ()
  19141. "Return a fill prefix for org-mode files."
  19142. (let (itemp)
  19143. (save-excursion
  19144. (cond
  19145. ;; Comment line
  19146. ((looking-at "#[ \t]+")
  19147. (match-string-no-properties 0))
  19148. ;; Plain list item
  19149. ((org-at-item-p)
  19150. (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
  19151. ;; Point is in a list after `backward-paragraph': original
  19152. ;; point wasn't in the list, or filling would have been taken
  19153. ;; care of by `org-auto-fill-function', but the list and the
  19154. ;; real paragraph are not separated by a blank line. Thus, move
  19155. ;; point after the list to go back to real paragraph and
  19156. ;; determine fill-prefix.
  19157. ((setq itemp (org-in-item-p))
  19158. (goto-char itemp)
  19159. (let* ((struct (org-list-struct))
  19160. (bottom (org-list-get-bottom-point struct)))
  19161. (goto-char bottom)
  19162. (make-string (org-get-indentation) ?\ )))
  19163. ;; Other text
  19164. ((looking-at org-adaptive-fill-regexp-backup)
  19165. (match-string-no-properties 0))))))
  19166. (defun org-auto-fill-function ()
  19167. "Auto-fill function."
  19168. (unless (and org-src-prevent-auto-filling (org-in-src-block-p))
  19169. (let (itemp prefix)
  19170. ;; When in a list, compute an appropriate fill-prefix and make
  19171. ;; sure it will be used by `do-auto-fill'.
  19172. (cond ((setq itemp (org-in-item-p))
  19173. (progn
  19174. (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
  19175. (flet ((fill-context-prefix (from to &optional flr) prefix))
  19176. (do-auto-fill))))
  19177. (orgstruct-is-++
  19178. (org-let org-fb-vars
  19179. '(do-auto-fill)))
  19180. (t (do-auto-fill))))))
  19181. ;;; Other stuff.
  19182. (defun org-toggle-fixed-width-section (arg)
  19183. "Toggle the fixed-width export.
  19184. If there is no active region, the QUOTE keyword at the current headline is
  19185. inserted or removed. When present, it causes the text between this headline
  19186. and the next to be exported as fixed-width text, and unmodified.
  19187. If there is an active region, this command adds or removes a colon as the
  19188. first character of this line. If the first character of a line is a colon,
  19189. this line is also exported in fixed-width font."
  19190. (interactive "P")
  19191. (let* ((cc 0)
  19192. (regionp (org-region-active-p))
  19193. (beg (if regionp (region-beginning) (point)))
  19194. (end (if regionp (region-end)))
  19195. (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
  19196. (case-fold-search nil)
  19197. (re "[ \t]*\\(:\\(?: \\|$\\)\\)")
  19198. off)
  19199. (if regionp
  19200. (save-excursion
  19201. (goto-char beg)
  19202. (setq cc (current-column))
  19203. (beginning-of-line 1)
  19204. (setq off (looking-at re))
  19205. (while (> nlines 0)
  19206. (setq nlines (1- nlines))
  19207. (beginning-of-line 1)
  19208. (cond
  19209. (arg
  19210. (org-move-to-column cc t)
  19211. (insert ": \n")
  19212. (forward-line -1))
  19213. ((and off (looking-at re))
  19214. (replace-match "" t t nil 1))
  19215. ((not off) (org-move-to-column cc t) (insert ": ")))
  19216. (forward-line 1)))
  19217. (save-excursion
  19218. (org-back-to-heading)
  19219. (cond
  19220. ((looking-at (format org-heading-keyword-regexp-format
  19221. org-quote-string))
  19222. (goto-char (match-end 1))
  19223. (looking-at (concat " +" org-quote-string))
  19224. (replace-match "" t t)
  19225. (when (eolp) (insert " ")))
  19226. ((looking-at org-outline-regexp)
  19227. (goto-char (match-end 0))
  19228. (insert org-quote-string " ")))))))
  19229. (defun org-reftex-citation ()
  19230. "Use reftex-citation to insert a citation into the buffer.
  19231. This looks for a line like
  19232. #+BIBLIOGRAPHY: foo plain option:-d
  19233. and derives from it that foo.bib is the bibliography file relevant
  19234. for this document. It then installs the necessary environment for RefTeX
  19235. to work in this buffer and calls `reftex-citation' to insert a citation
  19236. into the buffer.
  19237. Export of such citations to both LaTeX and HTML is handled by the contributed
  19238. package org-exp-bibtex by Taru Karttunen."
  19239. (interactive)
  19240. (let ((reftex-docstruct-symbol 'rds)
  19241. (reftex-cite-format "\\cite{%l}")
  19242. rds bib)
  19243. (save-excursion
  19244. (save-restriction
  19245. (widen)
  19246. (let ((case-fold-search t)
  19247. (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
  19248. (if (not (save-excursion
  19249. (or (re-search-forward re nil t)
  19250. (re-search-backward re nil t))))
  19251. (error "No bibliography defined in file")
  19252. (setq bib (concat (match-string 1) ".bib")
  19253. rds (list (list 'bib bib)))))))
  19254. (call-interactively 'reftex-citation)))
  19255. ;;;; Functions extending outline functionality
  19256. (defun org-beginning-of-line (&optional arg)
  19257. "Go to the beginning of the current line. If that is invisible, continue
  19258. to a visible line beginning. This makes the function of C-a more intuitive.
  19259. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  19260. first attempt, and only move to after the tags when the cursor is already
  19261. beyond the end of the headline."
  19262. (interactive "P")
  19263. (let ((pos (point))
  19264. (special (if (consp org-special-ctrl-a/e)
  19265. (car org-special-ctrl-a/e)
  19266. org-special-ctrl-a/e))
  19267. refpos)
  19268. (if (org-bound-and-true-p line-move-visual)
  19269. (beginning-of-visual-line 1)
  19270. (beginning-of-line 1))
  19271. (if (and arg (fboundp 'move-beginning-of-line))
  19272. (call-interactively 'move-beginning-of-line)
  19273. (if (bobp)
  19274. nil
  19275. (backward-char 1)
  19276. (if (org-truely-invisible-p)
  19277. (while (and (not (bobp)) (org-truely-invisible-p))
  19278. (backward-char 1)
  19279. (beginning-of-line 1))
  19280. (forward-char 1))))
  19281. (when special
  19282. (cond
  19283. ((and (looking-at org-complex-heading-regexp)
  19284. (= (char-after (match-end 1)) ?\ ))
  19285. (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
  19286. (point-at-eol)))
  19287. (goto-char
  19288. (if (eq special t)
  19289. (cond ((> pos refpos) refpos)
  19290. ((= pos (point)) refpos)
  19291. (t (point)))
  19292. (cond ((> pos (point)) (point))
  19293. ((not (eq last-command this-command)) (point))
  19294. (t refpos)))))
  19295. ((org-at-item-p)
  19296. ;; Being at an item and not looking at an the item means point
  19297. ;; was previously moved to beginning of a visual line, which
  19298. ;; doesn't contain the item. Therefore, do nothing special,
  19299. ;; just stay here.
  19300. (when (looking-at org-list-full-item-re)
  19301. ;; Set special position at first white space character after
  19302. ;; bullet, and check-box, if any.
  19303. (let ((after-bullet
  19304. (let ((box (match-end 3)))
  19305. (if (not box) (match-end 1)
  19306. (let ((after (char-after box)))
  19307. (if (and after (= after ? )) (1+ box) box))))))
  19308. ;; Special case: Move point to special position when
  19309. ;; currently after it or at beginning of line.
  19310. (if (eq special t)
  19311. (when (or (> pos after-bullet) (= (point) pos))
  19312. (goto-char after-bullet))
  19313. ;; Reversed case: Move point to special position when
  19314. ;; point was already at beginning of line and command is
  19315. ;; repeated.
  19316. (when (and (= (point) pos) (eq last-command this-command))
  19317. (goto-char after-bullet))))))))
  19318. (org-no-warnings
  19319. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  19320. (defun org-end-of-line (&optional arg)
  19321. "Go to the end of the line.
  19322. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  19323. first attempt, and only move to after the tags when the cursor is already
  19324. beyond the end of the headline."
  19325. (interactive "P")
  19326. (let ((special (if (consp org-special-ctrl-a/e)
  19327. (cdr org-special-ctrl-a/e)
  19328. org-special-ctrl-a/e)))
  19329. (cond
  19330. ((or (not special) arg
  19331. (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
  19332. (call-interactively
  19333. (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
  19334. ((fboundp 'move-end-of-line) 'move-end-of-line)
  19335. (t 'end-of-line))))
  19336. ((org-at-heading-p)
  19337. (let ((pos (point)))
  19338. (beginning-of-line 1)
  19339. (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
  19340. (if (eq special t)
  19341. (if (or (< pos (match-beginning 1))
  19342. (= pos (match-end 0)))
  19343. (goto-char (match-beginning 1))
  19344. (goto-char (match-end 0)))
  19345. (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
  19346. (goto-char (match-end 0))
  19347. (goto-char (match-beginning 1))))
  19348. (call-interactively (if (fboundp 'move-end-of-line)
  19349. 'move-end-of-line
  19350. 'end-of-line)))))
  19351. ((org-at-drawer-p)
  19352. (move-end-of-line 1)
  19353. (when (overlays-at (1- (point))) (backward-char 1)))
  19354. ;; At an item: Move before any hidden text.
  19355. (t (call-interactively
  19356. (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
  19357. ((fboundp 'move-end-of-line) 'move-end-of-line)
  19358. (t 'end-of-line)))))
  19359. (org-no-warnings
  19360. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  19361. (define-key org-mode-map "\C-a" 'org-beginning-of-line)
  19362. (define-key org-mode-map "\C-e" 'org-end-of-line)
  19363. (defun org-backward-sentence (&optional arg)
  19364. "Go to beginning of sentence, or beginning of table field.
  19365. This will call `backward-sentence' or `org-table-beginning-of-field',
  19366. depending on context."
  19367. (interactive "P")
  19368. (cond
  19369. ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
  19370. (t (call-interactively 'backward-sentence))))
  19371. (defun org-forward-sentence (&optional arg)
  19372. "Go to end of sentence, or end of table field.
  19373. This will call `forward-sentence' or `org-table-end-of-field',
  19374. depending on context."
  19375. (interactive "P")
  19376. (cond
  19377. ((org-at-table-p) (call-interactively 'org-table-end-of-field))
  19378. (t (call-interactively 'forward-sentence))))
  19379. (define-key org-mode-map "\M-a" 'org-backward-sentence)
  19380. (define-key org-mode-map "\M-e" 'org-forward-sentence)
  19381. (defun org-kill-line (&optional arg)
  19382. "Kill line, to tags or end of line."
  19383. (interactive "P")
  19384. (cond
  19385. ((or (not org-special-ctrl-k)
  19386. (bolp)
  19387. (not (org-at-heading-p)))
  19388. (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
  19389. org-ctrl-k-protect-subtree)
  19390. (if (or (eq org-ctrl-k-protect-subtree 'error)
  19391. (not (y-or-n-p "Kill hidden subtree along with headline? ")))
  19392. (error "C-k aborted - would kill hidden subtree")))
  19393. (call-interactively
  19394. (if (and (boundp 'visual-line-mode) visual-line-mode) 'kill-visual-line 'kill-line)))
  19395. ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
  19396. (kill-region (point) (match-beginning 1))
  19397. (org-set-tags nil t))
  19398. (t (kill-region (point) (point-at-eol)))))
  19399. (define-key org-mode-map "\C-k" 'org-kill-line)
  19400. (defun org-yank (&optional arg)
  19401. "Yank. If the kill is a subtree, treat it specially.
  19402. This command will look at the current kill and check if is a single
  19403. subtree, or a series of subtrees[1]. If it passes the test, and if the
  19404. cursor is at the beginning of a line or after the stars of a currently
  19405. empty headline, then the yank is handled specially. How exactly depends
  19406. on the value of the following variables, both set by default.
  19407. org-yank-folded-subtrees
  19408. When set, the subtree(s) will be folded after insertion, but only
  19409. if doing so would now swallow text after the yanked text.
  19410. org-yank-adjusted-subtrees
  19411. When set, the subtree will be promoted or demoted in order to
  19412. fit into the local outline tree structure, which means that the level
  19413. will be adjusted so that it becomes the smaller one of the two
  19414. *visible* surrounding headings.
  19415. Any prefix to this command will cause `yank' to be called directly with
  19416. no special treatment. In particular, a simple \\[universal-argument] prefix \
  19417. will just
  19418. plainly yank the text as it is.
  19419. \[1] The test checks if the first non-white line is a heading
  19420. and if there are no other headings with fewer stars."
  19421. (interactive "P")
  19422. (org-yank-generic 'yank arg))
  19423. (defun org-yank-generic (command arg)
  19424. "Perform some yank-like command.
  19425. This function implements the behavior described in the `org-yank'
  19426. documentation. However, it has been generalized to work for any
  19427. interactive command with similar behavior."
  19428. ;; pretend to be command COMMAND
  19429. (setq this-command command)
  19430. (if arg
  19431. (call-interactively command)
  19432. (let ((subtreep ; is kill a subtree, and the yank position appropriate?
  19433. (and (org-kill-is-subtree-p)
  19434. (or (bolp)
  19435. (and (looking-at "[ \t]*$")
  19436. (string-match
  19437. "\\`\\*+\\'"
  19438. (buffer-substring (point-at-bol) (point)))))))
  19439. swallowp)
  19440. (cond
  19441. ((and subtreep org-yank-folded-subtrees)
  19442. (let ((beg (point))
  19443. end)
  19444. (if (and subtreep org-yank-adjusted-subtrees)
  19445. (org-paste-subtree nil nil 'for-yank)
  19446. (call-interactively command))
  19447. (setq end (point))
  19448. (goto-char beg)
  19449. (when (and (bolp) subtreep
  19450. (not (setq swallowp
  19451. (org-yank-folding-would-swallow-text beg end))))
  19452. (org-with-limited-levels
  19453. (or (looking-at org-outline-regexp)
  19454. (re-search-forward org-outline-regexp-bol end t))
  19455. (while (and (< (point) end) (looking-at org-outline-regexp))
  19456. (hide-subtree)
  19457. (org-cycle-show-empty-lines 'folded)
  19458. (condition-case nil
  19459. (outline-forward-same-level 1)
  19460. (error (goto-char end))))))
  19461. (when swallowp
  19462. (message
  19463. "Inserted text not folded because that would swallow text"))
  19464. (goto-char end)
  19465. (skip-chars-forward " \t\n\r")
  19466. (beginning-of-line 1)
  19467. (push-mark beg 'nomsg)))
  19468. ((and subtreep org-yank-adjusted-subtrees)
  19469. (let ((beg (point-at-bol)))
  19470. (org-paste-subtree nil nil 'for-yank)
  19471. (push-mark beg 'nomsg)))
  19472. (t
  19473. (call-interactively command))))))
  19474. (defun org-yank-folding-would-swallow-text (beg end)
  19475. "Would hide-subtree at BEG swallow any text after END?"
  19476. (let (level)
  19477. (org-with-limited-levels
  19478. (save-excursion
  19479. (goto-char beg)
  19480. (when (or (looking-at org-outline-regexp)
  19481. (re-search-forward org-outline-regexp-bol end t))
  19482. (setq level (org-outline-level)))
  19483. (goto-char end)
  19484. (skip-chars-forward " \t\r\n\v\f")
  19485. (if (or (eobp)
  19486. (and (bolp) (looking-at org-outline-regexp)
  19487. (<= (org-outline-level) level)))
  19488. nil ; Nothing would be swallowed
  19489. t))))) ; something would swallow
  19490. (define-key org-mode-map "\C-y" 'org-yank)
  19491. (defun org-truely-invisible-p ()
  19492. "Check if point is at a character currently not visible.
  19493. This version does not only check the character property, but also
  19494. `visible-mode'."
  19495. ;; Early versions of noutline don't have `outline-invisible-p'.
  19496. (if (org-bound-and-true-p visible-mode)
  19497. nil
  19498. (outline-invisible-p)))
  19499. (defun org-invisible-p2 ()
  19500. "Check if point is at a character currently not visible."
  19501. (save-excursion
  19502. (if (and (eolp) (not (bobp))) (backward-char 1))
  19503. ;; Early versions of noutline don't have `outline-invisible-p'.
  19504. (outline-invisible-p)))
  19505. (defun org-back-to-heading (&optional invisible-ok)
  19506. "Call `outline-back-to-heading', but provide a better error message."
  19507. (condition-case nil
  19508. (outline-back-to-heading invisible-ok)
  19509. (error (error "Before first headline at position %d in buffer %s"
  19510. (point) (current-buffer)))))
  19511. (defun org-beginning-of-defun ()
  19512. "Go to the beginning of the subtree, i.e. back to the heading."
  19513. (org-back-to-heading))
  19514. (defun org-end-of-defun ()
  19515. "Go to the end of the subtree."
  19516. (org-end-of-subtree nil t))
  19517. (defun org-before-first-heading-p ()
  19518. "Before first heading?"
  19519. (save-excursion
  19520. (end-of-line)
  19521. (null (re-search-backward org-outline-regexp-bol nil t))))
  19522. (defun org-at-heading-p (&optional ignored)
  19523. (outline-on-heading-p t))
  19524. ;; Compatibility alias with Org versions < 7.8.03
  19525. (defalias 'org-on-heading-p 'org-at-heading-p)
  19526. (defun org-at-comment-p nil
  19527. "Is cursor in a line starting with a # character?"
  19528. (save-excursion
  19529. (beginning-of-line)
  19530. (looking-at "^#")))
  19531. (defun org-at-drawer-p nil
  19532. "Is cursor at a drawer keyword?"
  19533. (save-excursion
  19534. (move-beginning-of-line 1)
  19535. (looking-at org-drawer-regexp)))
  19536. (defun org-at-block-p nil
  19537. "Is cursor at a block keyword?"
  19538. (save-excursion
  19539. (move-beginning-of-line 1)
  19540. (looking-at org-block-regexp)))
  19541. (defun org-point-at-end-of-empty-headline ()
  19542. "If point is at the end of an empty headline, return t, else nil.
  19543. If the heading only contains a TODO keyword, it is still still considered
  19544. empty."
  19545. (and (looking-at "[ \t]*$")
  19546. (when org-todo-line-regexp
  19547. (save-excursion
  19548. (beginning-of-line 1)
  19549. (let ((case-fold-search nil))
  19550. (looking-at org-todo-line-regexp)
  19551. (string= (match-string 3) ""))))))
  19552. (defun org-at-heading-or-item-p ()
  19553. (or (org-at-heading-p) (org-at-item-p)))
  19554. (defun org-at-target-p ()
  19555. (or (org-in-regexp org-radio-target-regexp)
  19556. (org-in-regexp org-target-regexp)))
  19557. ;; Compatibility alias with Org versions < 7.8.03
  19558. (defalias 'org-on-target-p 'org-at-target-p)
  19559. (defun org-up-heading-all (arg)
  19560. "Move to the heading line of which the present line is a subheading.
  19561. This function considers both visible and invisible heading lines.
  19562. With argument, move up ARG levels."
  19563. (if (fboundp 'outline-up-heading-all)
  19564. (outline-up-heading-all arg) ; emacs 21 version of outline.el
  19565. (outline-up-heading arg t))) ; emacs 22 version of outline.el
  19566. (defun org-up-heading-safe ()
  19567. "Move to the heading line of which the present line is a subheading.
  19568. This version will not throw an error. It will return the level of the
  19569. headline found, or nil if no higher level is found.
  19570. Also, this function will be a lot faster than `outline-up-heading',
  19571. because it relies on stars being the outline starters. This can really
  19572. make a significant difference in outlines with very many siblings."
  19573. (let (start-level re)
  19574. (org-back-to-heading t)
  19575. (setq start-level (funcall outline-level))
  19576. (if (equal start-level 1)
  19577. nil
  19578. (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
  19579. (if (re-search-backward re nil t)
  19580. (funcall outline-level)))))
  19581. (defun org-first-sibling-p ()
  19582. "Is this heading the first child of its parents?"
  19583. (interactive)
  19584. (let ((re org-outline-regexp-bol)
  19585. level l)
  19586. (unless (org-at-heading-p t)
  19587. (error "Not at a heading"))
  19588. (setq level (funcall outline-level))
  19589. (save-excursion
  19590. (if (not (re-search-backward re nil t))
  19591. t
  19592. (setq l (funcall outline-level))
  19593. (< l level)))))
  19594. (defun org-goto-sibling (&optional previous)
  19595. "Goto the next sibling, even if it is invisible.
  19596. When PREVIOUS is set, go to the previous sibling instead. Returns t
  19597. when a sibling was found. When none is found, return nil and don't
  19598. move point."
  19599. (let ((fun (if previous 're-search-backward 're-search-forward))
  19600. (pos (point))
  19601. (re org-outline-regexp-bol)
  19602. level l)
  19603. (when (condition-case nil (org-back-to-heading t) (error nil))
  19604. (setq level (funcall outline-level))
  19605. (catch 'exit
  19606. (or previous (forward-char 1))
  19607. (while (funcall fun re nil t)
  19608. (setq l (funcall outline-level))
  19609. (when (< l level) (goto-char pos) (throw 'exit nil))
  19610. (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
  19611. (goto-char pos)
  19612. nil))))
  19613. (defun org-show-siblings ()
  19614. "Show all siblings of the current headline."
  19615. (save-excursion
  19616. (while (org-goto-sibling) (org-flag-heading nil)))
  19617. (save-excursion
  19618. (while (org-goto-sibling 'previous)
  19619. (org-flag-heading nil))))
  19620. (defun org-goto-first-child ()
  19621. "Goto the first child, even if it is invisible.
  19622. Return t when a child was found. Otherwise don't move point and
  19623. return nil."
  19624. (let (level (pos (point)) (re org-outline-regexp-bol))
  19625. (when (condition-case nil (org-back-to-heading t) (error nil))
  19626. (setq level (outline-level))
  19627. (forward-char 1)
  19628. (if (and (re-search-forward re nil t) (> (outline-level) level))
  19629. (progn (goto-char (match-beginning 0)) t)
  19630. (goto-char pos) nil))))
  19631. (defun org-show-hidden-entry ()
  19632. "Show an entry where even the heading is hidden."
  19633. (save-excursion
  19634. (org-show-entry)))
  19635. (defun org-flag-heading (flag &optional entry)
  19636. "Flag the current heading. FLAG non-nil means make invisible.
  19637. When ENTRY is non-nil, show the entire entry."
  19638. (save-excursion
  19639. (org-back-to-heading t)
  19640. ;; Check if we should show the entire entry
  19641. (if entry
  19642. (progn
  19643. (org-show-entry)
  19644. (save-excursion
  19645. (and (outline-next-heading)
  19646. (org-flag-heading nil))))
  19647. (outline-flag-region (max (point-min) (1- (point)))
  19648. (save-excursion (outline-end-of-heading) (point))
  19649. flag))))
  19650. (defun org-get-next-sibling ()
  19651. "Move to next heading of the same level, and return point.
  19652. If there is no such heading, return nil.
  19653. This is like outline-next-sibling, but invisible headings are ok."
  19654. (let ((level (funcall outline-level)))
  19655. (outline-next-heading)
  19656. (while (and (not (eobp)) (> (funcall outline-level) level))
  19657. (outline-next-heading))
  19658. (if (or (eobp) (< (funcall outline-level) level))
  19659. nil
  19660. (point))))
  19661. (defun org-get-last-sibling ()
  19662. "Move to previous heading of the same level, and return point.
  19663. If there is no such heading, return nil."
  19664. (let ((opoint (point))
  19665. (level (funcall outline-level)))
  19666. (outline-previous-heading)
  19667. (when (and (/= (point) opoint) (outline-on-heading-p t))
  19668. (while (and (> (funcall outline-level) level)
  19669. (not (bobp)))
  19670. (outline-previous-heading))
  19671. (if (< (funcall outline-level) level)
  19672. nil
  19673. (point)))))
  19674. (defun org-end-of-subtree (&optional invisible-OK to-heading)
  19675. ;; This contains an exact copy of the original function, but it uses
  19676. ;; `org-back-to-heading', to make it work also in invisible
  19677. ;; trees. And is uses an invisible-OK argument.
  19678. ;; Under Emacs this is not needed, but the old outline.el needs this fix.
  19679. ;; Furthermore, when used inside Org, finding the end of a large subtree
  19680. ;; with many children and grandchildren etc, this can be much faster
  19681. ;; than the outline version.
  19682. (org-back-to-heading invisible-OK)
  19683. (let ((first t)
  19684. (level (funcall outline-level)))
  19685. (if (and (derived-mode-p 'org-mode) (< level 1000))
  19686. ;; A true heading (not a plain list item), in Org-mode
  19687. ;; This means we can easily find the end by looking
  19688. ;; only for the right number of stars. Using a regexp to do
  19689. ;; this is so much faster than using a Lisp loop.
  19690. (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
  19691. (forward-char 1)
  19692. (and (re-search-forward re nil 'move) (beginning-of-line 1)))
  19693. ;; something else, do it the slow way
  19694. (while (and (not (eobp))
  19695. (or first (> (funcall outline-level) level)))
  19696. (setq first nil)
  19697. (outline-next-heading)))
  19698. (unless to-heading
  19699. (if (memq (preceding-char) '(?\n ?\^M))
  19700. (progn
  19701. ;; Go to end of line before heading
  19702. (forward-char -1)
  19703. (if (memq (preceding-char) '(?\n ?\^M))
  19704. ;; leave blank line before heading
  19705. (forward-char -1))))))
  19706. (point))
  19707. (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
  19708. "Use Org version in org-mode, for dramatic speed-up."
  19709. (if (derived-mode-p 'org-mode)
  19710. (progn
  19711. (org-end-of-subtree nil t)
  19712. (unless (eobp) (backward-char 1)))
  19713. ad-do-it))
  19714. (defun org-end-of-meta-data-and-drawers ()
  19715. "Jump to the first text after meta data and drawers in the current entry.
  19716. This will move over empty lines, lines with planning time stamps,
  19717. clocking lines, and drawers."
  19718. (org-back-to-heading t)
  19719. (let ((end (save-excursion (outline-next-heading) (point)))
  19720. (re (concat "\\(" org-drawer-regexp "\\)"
  19721. "\\|" "[ \t]*" org-keyword-time-regexp)))
  19722. (forward-line 1)
  19723. (while (re-search-forward re end t)
  19724. (if (not (match-end 1))
  19725. ;; empty or planning line
  19726. (forward-line 1)
  19727. ;; a drawer, find the end
  19728. (re-search-forward "^[ \t]*:END:" end 'move)
  19729. (forward-line 1)))
  19730. (and (re-search-forward "[^\n]" nil t) (backward-char 1))
  19731. (point)))
  19732. (defun org-forward-same-level (arg &optional invisible-ok)
  19733. "Move forward to the arg'th subheading at same level as this one.
  19734. Stop at the first and last subheadings of a superior heading.
  19735. Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
  19736. it wil also look at invisible ones."
  19737. (interactive "p")
  19738. (org-back-to-heading invisible-ok)
  19739. (org-at-heading-p)
  19740. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  19741. (re (format "^\\*\\{1,%d\\} " level))
  19742. l)
  19743. (forward-char 1)
  19744. (while (> arg 0)
  19745. (while (and (re-search-forward re nil 'move)
  19746. (setq l (- (match-end 0) (match-beginning 0) 1))
  19747. (= l level)
  19748. (not invisible-ok)
  19749. (progn (backward-char 1) (outline-invisible-p)))
  19750. (if (< l level) (setq arg 1)))
  19751. (setq arg (1- arg)))
  19752. (beginning-of-line 1)))
  19753. (defun org-backward-same-level (arg &optional invisible-ok)
  19754. "Move backward to the arg'th subheading at same level as this one.
  19755. Stop at the first and last subheadings of a superior heading."
  19756. (interactive "p")
  19757. (org-back-to-heading)
  19758. (org-at-heading-p)
  19759. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  19760. (re (format "^\\*\\{1,%d\\} " level))
  19761. l)
  19762. (while (> arg 0)
  19763. (while (and (re-search-backward re nil 'move)
  19764. (setq l (- (match-end 0) (match-beginning 0) 1))
  19765. (= l level)
  19766. (not invisible-ok)
  19767. (outline-invisible-p))
  19768. (if (< l level) (setq arg 1)))
  19769. (setq arg (1- arg)))))
  19770. (defun org-show-subtree ()
  19771. "Show everything after this heading at deeper levels."
  19772. (interactive)
  19773. (outline-flag-region
  19774. (point)
  19775. (save-excursion
  19776. (org-end-of-subtree t t))
  19777. nil))
  19778. (defun org-show-entry ()
  19779. "Show the body directly following this heading.
  19780. Show the heading too, if it is currently invisible."
  19781. (interactive)
  19782. (save-excursion
  19783. (condition-case nil
  19784. (progn
  19785. (org-back-to-heading t)
  19786. (outline-flag-region
  19787. (max (point-min) (1- (point)))
  19788. (save-excursion
  19789. (if (re-search-forward
  19790. (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
  19791. (match-beginning 1)
  19792. (point-max)))
  19793. nil)
  19794. (org-cycle-hide-drawers 'children))
  19795. (error nil))))
  19796. (defun org-make-options-regexp (kwds &optional extra)
  19797. "Make a regular expression for keyword lines."
  19798. (concat
  19799. "^"
  19800. "#?[ \t]*\\+\\("
  19801. (mapconcat 'regexp-quote kwds "\\|")
  19802. (if extra (concat "\\|" extra))
  19803. "\\):[ \t]*"
  19804. "\\(.*\\)"))
  19805. ;; Make isearch reveal the necessary context
  19806. (defun org-isearch-end ()
  19807. "Reveal context after isearch exits."
  19808. (when isearch-success ; only if search was successful
  19809. (if (featurep 'xemacs)
  19810. ;; Under XEmacs, the hook is run in the correct place,
  19811. ;; we directly show the context.
  19812. (org-show-context 'isearch)
  19813. ;; In Emacs the hook runs *before* restoring the overlays.
  19814. ;; So we have to use a one-time post-command-hook to do this.
  19815. ;; (Emacs 22 has a special variable, see function `org-mode')
  19816. (unless (and (boundp 'isearch-mode-end-hook-quit)
  19817. isearch-mode-end-hook-quit)
  19818. ;; Only when the isearch was not quitted.
  19819. (org-add-hook 'post-command-hook 'org-isearch-post-command
  19820. 'append 'local)))))
  19821. (defun org-isearch-post-command ()
  19822. "Remove self from hook, and show context."
  19823. (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
  19824. (org-show-context 'isearch))
  19825. ;;;; Integration with and fixes for other packages
  19826. ;;; Imenu support
  19827. (defvar org-imenu-markers nil
  19828. "All markers currently used by Imenu.")
  19829. (make-variable-buffer-local 'org-imenu-markers)
  19830. (defun org-imenu-new-marker (&optional pos)
  19831. "Return a new marker for use by Imenu, and remember the marker."
  19832. (let ((m (make-marker)))
  19833. (move-marker m (or pos (point)))
  19834. (push m org-imenu-markers)
  19835. m))
  19836. (defun org-imenu-get-tree ()
  19837. "Produce the index for Imenu."
  19838. (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
  19839. (setq org-imenu-markers nil)
  19840. (let* ((n org-imenu-depth)
  19841. (re (concat "^" (org-get-limited-outline-regexp)))
  19842. (subs (make-vector (1+ n) nil))
  19843. (last-level 0)
  19844. m level head)
  19845. (save-excursion
  19846. (save-restriction
  19847. (widen)
  19848. (goto-char (point-max))
  19849. (while (re-search-backward re nil t)
  19850. (setq level (org-reduced-level (funcall outline-level)))
  19851. (when (and (<= level n)
  19852. (looking-at org-complex-heading-regexp))
  19853. (setq head (org-link-display-format
  19854. (org-match-string-no-properties 4))
  19855. m (org-imenu-new-marker))
  19856. (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
  19857. (if (>= level last-level)
  19858. (push (cons head m) (aref subs level))
  19859. (push (cons head (aref subs (1+ level))) (aref subs level))
  19860. (loop for i from (1+ level) to n do (aset subs i nil)))
  19861. (setq last-level level)))))
  19862. (aref subs 1)))
  19863. (eval-after-load "imenu"
  19864. '(progn
  19865. (add-hook 'imenu-after-jump-hook
  19866. (lambda ()
  19867. (if (derived-mode-p 'org-mode)
  19868. (org-show-context 'org-goto))))))
  19869. (defun org-link-display-format (link)
  19870. "Replace a link with either the description, or the link target
  19871. if no description is present"
  19872. (save-match-data
  19873. (if (string-match org-bracket-link-analytic-regexp link)
  19874. (replace-match (if (match-end 5)
  19875. (match-string 5 link)
  19876. (concat (match-string 1 link)
  19877. (match-string 3 link)))
  19878. nil t link)
  19879. link)))
  19880. (defun org-toggle-link-display ()
  19881. "Toggle the literal or descriptive display of links."
  19882. (interactive)
  19883. (if org-descriptive-links
  19884. (progn (org-remove-from-invisibility-spec '(org-link))
  19885. (org-restart-font-lock)
  19886. (setq org-descriptive-links nil))
  19887. (progn (add-to-invisibility-spec '(org-link))
  19888. (org-restart-font-lock)
  19889. (setq org-descriptive-links t))))
  19890. ;; Speedbar support
  19891. (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
  19892. "Overlay marking the agenda restriction line in speedbar.")
  19893. (overlay-put org-speedbar-restriction-lock-overlay
  19894. 'face 'org-agenda-restriction-lock)
  19895. (overlay-put org-speedbar-restriction-lock-overlay
  19896. 'help-echo "Agendas are currently limited to this item.")
  19897. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  19898. (defun org-speedbar-set-agenda-restriction ()
  19899. "Restrict future agenda commands to the location at point in speedbar.
  19900. To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
  19901. (interactive)
  19902. (require 'org-agenda)
  19903. (let (p m tp np dir txt)
  19904. (cond
  19905. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  19906. 'org-imenu t))
  19907. (setq m (get-text-property p 'org-imenu-marker))
  19908. (with-current-buffer (marker-buffer m)
  19909. (goto-char m)
  19910. (org-agenda-set-restriction-lock 'subtree)))
  19911. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  19912. 'speedbar-function 'speedbar-find-file))
  19913. (setq tp (previous-single-property-change
  19914. (1+ p) 'speedbar-function)
  19915. np (next-single-property-change
  19916. tp 'speedbar-function)
  19917. dir (speedbar-line-directory)
  19918. txt (buffer-substring-no-properties (or tp (point-min))
  19919. (or np (point-max))))
  19920. (with-current-buffer (find-file-noselect
  19921. (let ((default-directory dir))
  19922. (expand-file-name txt)))
  19923. (unless (derived-mode-p 'org-mode)
  19924. (error "Cannot restrict to non-Org-mode file"))
  19925. (org-agenda-set-restriction-lock 'file)))
  19926. (t (error "Don't know how to restrict Org-mode's agenda")))
  19927. (move-overlay org-speedbar-restriction-lock-overlay
  19928. (point-at-bol) (point-at-eol))
  19929. (setq current-prefix-arg nil)
  19930. (org-agenda-maybe-redo)))
  19931. (eval-after-load "speedbar"
  19932. '(progn
  19933. (speedbar-add-supported-extension ".org")
  19934. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  19935. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  19936. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  19937. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  19938. (add-hook 'speedbar-visiting-tag-hook
  19939. (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
  19940. ;;; Fixes and Hacks for problems with other packages
  19941. ;; Make flyspell not check words in links, to not mess up our keymap
  19942. (defun org-mode-flyspell-verify ()
  19943. "Don't let flyspell put overlays at active buttons, or on
  19944. {todo,all-time,additional-option-like}-keywords."
  19945. (let ((pos (max (1- (point)) (point-min)))
  19946. (word (thing-at-point 'word)))
  19947. (and (not (get-text-property pos 'keymap))
  19948. (not (get-text-property pos 'org-no-flyspell))
  19949. (not (member word org-todo-keywords-1))
  19950. (not (member word org-all-time-keywords))
  19951. (not (member word org-additional-option-like-keywords)))))
  19952. (defun org-remove-flyspell-overlays-in (beg end)
  19953. "Remove flyspell overlays in region."
  19954. (and (org-bound-and-true-p flyspell-mode)
  19955. (fboundp 'flyspell-delete-region-overlays)
  19956. (flyspell-delete-region-overlays beg end))
  19957. (add-text-properties beg end '(org-no-flyspell t)))
  19958. ;; Make `bookmark-jump' shows the jump location if it was hidden.
  19959. (eval-after-load "bookmark"
  19960. '(if (boundp 'bookmark-after-jump-hook)
  19961. ;; We can use the hook
  19962. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  19963. ;; Hook not available, use advice
  19964. (defadvice bookmark-jump (after org-make-visible activate)
  19965. "Make the position visible."
  19966. (org-bookmark-jump-unhide))))
  19967. ;; Make sure saveplace shows the location if it was hidden
  19968. (eval-after-load "saveplace"
  19969. '(defadvice save-place-find-file-hook (after org-make-visible activate)
  19970. "Make the position visible."
  19971. (org-bookmark-jump-unhide)))
  19972. ;; Make sure ecb shows the location if it was hidden
  19973. (eval-after-load "ecb"
  19974. '(defadvice ecb-method-clicked (after esf/org-show-context activate)
  19975. "Make hierarchy visible when jumping into location from ECB tree buffer."
  19976. (if (derived-mode-p 'org-mode)
  19977. (org-show-context))))
  19978. (defun org-bookmark-jump-unhide ()
  19979. "Unhide the current position, to show the bookmark location."
  19980. (and (derived-mode-p 'org-mode)
  19981. (or (outline-invisible-p)
  19982. (save-excursion (goto-char (max (point-min) (1- (point))))
  19983. (outline-invisible-p)))
  19984. (org-show-context 'bookmark-jump)))
  19985. ;; Make session.el ignore our circular variable
  19986. (eval-after-load "session"
  19987. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  19988. ;;;; Experimental code
  19989. (defun org-closed-in-range ()
  19990. "Sparse tree of items closed in a certain time range.
  19991. Still experimental, may disappear in the future."
  19992. (interactive)
  19993. ;; Get the time interval from the user.
  19994. (let* ((time1 (org-float-time
  19995. (org-read-date nil 'to-time nil "Starting date: ")))
  19996. (time2 (org-float-time
  19997. (org-read-date nil 'to-time nil "End date:")))
  19998. ;; callback function
  19999. (callback (lambda ()
  20000. (let ((time
  20001. (org-float-time
  20002. (apply 'encode-time
  20003. (org-parse-time-string
  20004. (match-string 1))))))
  20005. ;; check if time in interval
  20006. (and (>= time time1) (<= time time2))))))
  20007. ;; make tree, check each match with the callback
  20008. (org-occur "CLOSED: +\\[\\(.*?\\)\\]" nil callback)))
  20009. ;;;; Finish up
  20010. (provide 'org)
  20011. (run-hooks 'org-load-hook)
  20012. ;;; org.el ends here