org.el 818 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769
  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. (eval-when-compile
  197. (defun org-release () "N/A")
  198. (defun org-git-version () "N/A !!check installation!!")
  199. (and (load (concat (org-find-library-dir "org") "../UTILITIES/org-fixup.el")
  200. 'noerror 'nomessage 'nosuffix)
  201. (org-no-warnings (org-fixup))))
  202. ;;;###autoload
  203. (defun org-version (&optional here full message)
  204. "Show the org-mode version in the echo area.
  205. With prefix arg HERE, insert it at point."
  206. (interactive "P")
  207. (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
  208. (org-install-dir (ignore-errors (org-find-library-dir "org-install.el")))
  209. (org-trash (or
  210. (and (fboundp 'org-release) (fboundp 'org-git-version))
  211. (load (concat org-dir "org-version.el")
  212. 'noerror 'nomessage 'nosuffix)))
  213. (org-version (org-release))
  214. (git-version (org-git-version))
  215. (version (format "Org-mode version %s (%s @ %s)"
  216. org-version
  217. git-version
  218. (if org-install-dir
  219. (if (string= org-dir org-install-dir)
  220. org-install-dir
  221. (concat "mixed installation! " org-install-dir " and " org-dir))
  222. "org-install.el can not be found!")))
  223. (_version (if full version org-version)))
  224. (if (org-called-interactively-p 'interactive)
  225. (if here
  226. (insert version)
  227. (message version))
  228. (if message (message _version))
  229. _version)))
  230. ;;; Compatibility constants
  231. ;;; The custom variables
  232. (defgroup org nil
  233. "Outline-based notes management and organizer."
  234. :tag "Org"
  235. :group 'outlines
  236. :group 'calendar)
  237. (defcustom org-mode-hook nil
  238. "Mode hook for Org-mode, run after the mode was turned on."
  239. :group 'org
  240. :type 'hook)
  241. (defcustom org-load-hook nil
  242. "Hook that is run after org.el has been loaded."
  243. :group 'org
  244. :type 'hook)
  245. (defcustom org-log-buffer-setup-hook nil
  246. "Hook that is run after an Org log buffer is created."
  247. :group 'org
  248. :version "24.1"
  249. :type 'hook)
  250. (defvar org-modules) ; defined below
  251. (defvar org-modules-loaded nil
  252. "Have the modules been loaded already?")
  253. (defun org-load-modules-maybe (&optional force)
  254. "Load all extensions listed in `org-modules'."
  255. (when (or force (not org-modules-loaded))
  256. (mapc (lambda (ext)
  257. (condition-case nil (require ext)
  258. (error (message "Problems while trying to load feature `%s'" ext))))
  259. org-modules)
  260. (setq org-modules-loaded t)))
  261. (defun org-set-modules (var value)
  262. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  263. (set var value)
  264. (when (featurep 'org)
  265. (org-load-modules-maybe 'force)))
  266. (when (org-bound-and-true-p org-modules)
  267. (let ((a (member 'org-infojs org-modules)))
  268. (and a (setcar a 'org-jsinfo))))
  269. (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)
  270. "Modules that should always be loaded together with org.el.
  271. If a description starts with <C>, the file is not part of Emacs
  272. and loading it will require that you have downloaded and properly installed
  273. the org-mode distribution.
  274. You can also use this system to load external packages (i.e. neither Org
  275. core modules, nor modules from the CONTRIB directory). Just add symbols
  276. to the end of the list. If the package is called org-xyz.el, then you need
  277. to add the symbol `xyz', and the package must have a call to
  278. (provide 'org-xyz)"
  279. :group 'org
  280. :set 'org-set-modules
  281. :type
  282. '(set :greedy t
  283. (const :tag " bbdb: Links to BBDB entries" org-bbdb)
  284. (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
  285. (const :tag " crypt: Encryption of subtrees" org-crypt)
  286. (const :tag " ctags: Access to Emacs tags with links" org-ctags)
  287. (const :tag " docview: Links to doc-view buffers" org-docview)
  288. (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
  289. (const :tag " id: Global IDs for identifying entries" org-id)
  290. (const :tag " info: Links to Info nodes" org-info)
  291. (const :tag " jsinfo: Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo)
  292. (const :tag " habit: Track your consistency with habits" org-habit)
  293. (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
  294. (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
  295. (const :tag " mac-message: Links to messages in Apple Mail" org-mac-message)
  296. (const :tag " mew Links to Mew folders/messages" org-mew)
  297. (const :tag " mhe: Links to MHE folders/messages" org-mhe)
  298. (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
  299. (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
  300. (const :tag " special-blocks: Turn blocks into LaTeX envs and HTML divs" org-special-blocks)
  301. (const :tag " vm: Links to VM folders/messages" org-vm)
  302. (const :tag " wl: Links to Wanderlust folders/messages" org-wl)
  303. (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
  304. (const :tag " mouse: Additional mouse support" org-mouse)
  305. (const :tag " TaskJuggler: Export tasks to a TaskJuggler project" org-taskjuggler)
  306. (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
  307. (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
  308. (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
  309. (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
  310. (const :tag "C collector: Collect properties into tables" org-collector)
  311. (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
  312. (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
  313. (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
  314. (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
  315. (const :tag "C eval: Include command output as text" org-eval)
  316. (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
  317. (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
  318. (const :tag "C exp-bibtex: Export citations using BibTeX" org-exp-bibtex)
  319. (const :tag "C git-link: Provide org links to specific file version" org-git-link)
  320. (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
  321. (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
  322. (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
  323. (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
  324. (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
  325. (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
  326. (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
  327. (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
  328. (const :tag "C man: Support for links to manpages in Org-mode" org-man)
  329. (const :tag "C mtags: Support for muse-like tags" org-mtags)
  330. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  331. (const :tag "C registry: A registry for Org-mode links" org-registry)
  332. (const :tag "C org2rem: Convert org appointments into reminders" org2rem)
  333. (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
  334. (const :tag "C secretary: Team management with org-mode" org-secretary)
  335. (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
  336. (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
  337. (const :tag "C track: Keep up with Org-mode development" org-track)
  338. (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
  339. (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
  340. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  341. (defcustom org-support-shift-select nil
  342. "Non-nil means make shift-cursor commands select text when possible.
  343. In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
  344. start selecting a region, or enlarge regions started in this way.
  345. In Org-mode, in special contexts, these same keys are used for
  346. other purposes, important enough to compete with shift selection.
  347. Org tries to balance these needs by supporting `shift-select-mode'
  348. outside these special contexts, under control of this variable.
  349. The default of this variable is nil, to avoid confusing behavior. Shifted
  350. cursor keys will then execute Org commands in the following contexts:
  351. - on a headline, changing TODO state (left/right) and priority (up/down)
  352. - on a time stamp, changing the time
  353. - in a plain list item, changing the bullet type
  354. - in a property definition line, switching between allowed values
  355. - in the BEGIN line of a clock table (changing the time block).
  356. Outside these contexts, the commands will throw an error.
  357. When this variable is t and the cursor is not in a special
  358. context, Org-mode will support shift-selection for making and
  359. enlarging regions. To make this more effective, the bullet
  360. cycling will no longer happen anywhere in an item line, but only
  361. if the cursor is exactly on the bullet.
  362. If you set this variable to the symbol `always', then the keys
  363. will not be special in headlines, property lines, and item lines,
  364. to make shift selection work there as well. If this is what you
  365. want, you can use the following alternative commands: `C-c C-t'
  366. and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
  367. can be used to switch TODO sets, `C-c -' to cycle item bullet
  368. types, and properties can be edited by hand or in column view.
  369. However, when the cursor is on a timestamp, shift-cursor commands
  370. will still edit the time stamp - this is just too good to give up.
  371. XEmacs user should have this variable set to nil, because
  372. `shift-select-mode' is in Emacs 23 or later only."
  373. :group 'org
  374. :type '(choice
  375. (const :tag "Never" nil)
  376. (const :tag "When outside special context" t)
  377. (const :tag "Everywhere except timestamps" always)))
  378. (defcustom org-loop-over-headlines-in-active-region nil
  379. "Shall some commands act upon headlines in the active region?
  380. When set to `t', some commands will be performed in all headlines
  381. within the active region.
  382. When set to `start-level', some commands will be performed in all
  383. headlines within the active region, provided that these headlines
  384. are of the same level than the first one.
  385. When set to a string, those commands will be performed on the
  386. matching headlines within the active region. Such string must be
  387. a tags/property/todo match as it is used in the agenda tags view.
  388. The list of commands is: `org-schedule', `org-deadline',
  389. `org-todo', `org-archive-subtree', `org-archive-set-tag' and
  390. `org-archive-to-archive-sibling'. The archiving commands skip
  391. already archived entries."
  392. :type '(choice (const :tag "Don't loop" nil)
  393. (const :tag "All headlines in active region" t)
  394. (const :tag "In active region, headlines at the same level than the first one" 'start-level)
  395. (string :tag "Tags/Property/Todo matcher"))
  396. :version "24.1"
  397. :group 'org-todo
  398. :group 'org-archive)
  399. (defgroup org-startup nil
  400. "Options concerning startup of Org-mode."
  401. :tag "Org Startup"
  402. :group 'org)
  403. (defcustom org-startup-folded t
  404. "Non-nil means entering Org-mode will switch to OVERVIEW.
  405. This can also be configured on a per-file basis by adding one of
  406. the following lines anywhere in the buffer:
  407. #+STARTUP: fold (or `overview', this is equivalent)
  408. #+STARTUP: nofold (or `showall', this is equivalent)
  409. #+STARTUP: content
  410. #+STARTUP: showeverything"
  411. :group 'org-startup
  412. :type '(choice
  413. (const :tag "nofold: show all" nil)
  414. (const :tag "fold: overview" t)
  415. (const :tag "content: all headlines" content)
  416. (const :tag "show everything, even drawers" showeverything)))
  417. (defcustom org-startup-truncated t
  418. "Non-nil means entering Org-mode will set `truncate-lines'.
  419. This is useful since some lines containing links can be very long and
  420. uninteresting. Also tables look terrible when wrapped."
  421. :group 'org-startup
  422. :type 'boolean)
  423. (defcustom org-startup-indented nil
  424. "Non-nil means turn on `org-indent-mode' on startup.
  425. This can also be configured on a per-file basis by adding one of
  426. the following lines anywhere in the buffer:
  427. #+STARTUP: indent
  428. #+STARTUP: noindent"
  429. :group 'org-structure
  430. :type '(choice
  431. (const :tag "Not" nil)
  432. (const :tag "Globally (slow on startup in large files)" t)))
  433. (defcustom org-use-sub-superscripts t
  434. "Non-nil means interpret \"_\" and \"^\" for export.
  435. When this option is turned on, you can use TeX-like syntax for sub- and
  436. superscripts. Several characters after \"_\" or \"^\" will be
  437. considered as a single item - so grouping with {} is normally not
  438. needed. For example, the following things will be parsed as single
  439. sub- or superscripts.
  440. 10^24 or 10^tau several digits will be considered 1 item.
  441. 10^-12 or 10^-tau a leading sign with digits or a word
  442. x^2-y^3 will be read as x^2 - y^3, because items are
  443. terminated by almost any nonword/nondigit char.
  444. x_{i^2} or x^(2-i) braces or parenthesis do grouping.
  445. Still, ambiguity is possible - so when in doubt use {} to enclose the
  446. sub/superscript. If you set this variable to the symbol `{}',
  447. the braces are *required* in order to trigger interpretations as
  448. sub/superscript. This can be helpful in documents that need \"_\"
  449. frequently in plain text.
  450. Not all export backends support this, but HTML does.
  451. This option can also be set with the +OPTIONS line, e.g. \"^:nil\"."
  452. :group 'org-startup
  453. :group 'org-export-translation
  454. :version "24.1"
  455. :type '(choice
  456. (const :tag "Always interpret" t)
  457. (const :tag "Only with braces" {})
  458. (const :tag "Never interpret" nil)))
  459. (if (fboundp 'defvaralias)
  460. (defvaralias 'org-export-with-sub-superscripts 'org-use-sub-superscripts))
  461. (defcustom org-startup-with-beamer-mode nil
  462. "Non-nil means turn on `org-beamer-mode' on startup.
  463. This can also be configured on a per-file basis by adding one of
  464. the following lines anywhere in the buffer:
  465. #+STARTUP: beamer"
  466. :group 'org-startup
  467. :version "24.1"
  468. :type 'boolean)
  469. (defcustom org-startup-align-all-tables nil
  470. "Non-nil means align all tables when visiting a file.
  471. This is useful when the column width in tables is forced with <N> cookies
  472. in table fields. Such tables will look correct only after the first re-align.
  473. This can also be configured on a per-file basis by adding one of
  474. the following lines anywhere in the buffer:
  475. #+STARTUP: align
  476. #+STARTUP: noalign"
  477. :group 'org-startup
  478. :type 'boolean)
  479. (defcustom org-startup-with-inline-images nil
  480. "Non-nil means show inline images when loading a new Org file.
  481. This can also be configured on a per-file basis by adding one of
  482. the following lines anywhere in the buffer:
  483. #+STARTUP: inlineimages
  484. #+STARTUP: noinlineimages"
  485. :group 'org-startup
  486. :version "24.1"
  487. :type 'boolean)
  488. (defcustom org-insert-mode-line-in-empty-file nil
  489. "Non-nil means insert the first line setting Org-mode in empty files.
  490. When the function `org-mode' is called interactively in an empty file, this
  491. normally means that the file name does not automatically trigger Org-mode.
  492. To ensure that the file will always be in Org-mode in the future, a
  493. line enforcing Org-mode will be inserted into the buffer, if this option
  494. has been set."
  495. :group 'org-startup
  496. :type 'boolean)
  497. (defcustom org-replace-disputed-keys nil
  498. "Non-nil means use alternative key bindings for some keys.
  499. Org-mode uses S-<cursor> keys for changing timestamps and priorities.
  500. These keys are also used by other packages like shift-selection-mode'
  501. \(built into Emacs 23), `CUA-mode' or `windmove.el'.
  502. If you want to use Org-mode together with one of these other modes,
  503. or more generally if you would like to move some Org-mode commands to
  504. other keys, set this variable and configure the keys with the variable
  505. `org-disputed-keys'.
  506. This option is only relevant at load-time of Org-mode, and must be set
  507. *before* org.el is loaded. Changing it requires a restart of Emacs to
  508. become effective."
  509. :group 'org-startup
  510. :type 'boolean)
  511. (defcustom org-use-extra-keys nil
  512. "Non-nil means use extra key sequence definitions for certain commands.
  513. This happens automatically if you run XEmacs or if `window-system'
  514. is nil. This variable lets you do the same manually. You must
  515. set it before loading org.
  516. Example: on Carbon Emacs 22 running graphically, with an external
  517. keyboard on a Powerbook, the default way of setting M-left might
  518. not work for either Alt or ESC. Setting this variable will make
  519. it work for ESC."
  520. :group 'org-startup
  521. :type 'boolean)
  522. (if (fboundp 'defvaralias)
  523. (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys))
  524. (defcustom org-disputed-keys
  525. '(([(shift up)] . [(meta p)])
  526. ([(shift down)] . [(meta n)])
  527. ([(shift left)] . [(meta -)])
  528. ([(shift right)] . [(meta +)])
  529. ([(control shift right)] . [(meta shift +)])
  530. ([(control shift left)] . [(meta shift -)]))
  531. "Keys for which Org-mode and other modes compete.
  532. This is an alist, cars are the default keys, second element specifies
  533. the alternative to use when `org-replace-disputed-keys' is t.
  534. Keys can be specified in any syntax supported by `define-key'.
  535. The value of this option takes effect only at Org-mode's startup,
  536. therefore you'll have to restart Emacs to apply it after changing."
  537. :group 'org-startup
  538. :type 'alist)
  539. (defun org-key (key)
  540. "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
  541. Or return the original if not disputed.
  542. Also apply the translations defined in `org-xemacs-key-equivalents'."
  543. (when org-replace-disputed-keys
  544. (let* ((nkey (key-description key))
  545. (x (org-find-if (lambda (x)
  546. (equal (key-description (car x)) nkey))
  547. org-disputed-keys)))
  548. (setq key (if x (cdr x) key))))
  549. (when (featurep 'xemacs)
  550. (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
  551. key)
  552. (defun org-find-if (predicate seq)
  553. (catch 'exit
  554. (while seq
  555. (if (funcall predicate (car seq))
  556. (throw 'exit (car seq))
  557. (pop seq)))))
  558. (defun org-defkey (keymap key def)
  559. "Define a key, possibly translated, as returned by `org-key'."
  560. (define-key keymap (org-key key) def))
  561. (defcustom org-ellipsis nil
  562. "The ellipsis to use in the Org-mode outline.
  563. When nil, just use the standard three dots. When a string, use that instead,
  564. When a face, use the standard 3 dots, but with the specified face.
  565. The change affects only Org-mode (which will then use its own display table).
  566. Changing this requires executing `M-x org-mode' in a buffer to become
  567. effective."
  568. :group 'org-startup
  569. :type '(choice (const :tag "Default" nil)
  570. (face :tag "Face" :value org-warning)
  571. (string :tag "String" :value "...#")))
  572. (defvar org-display-table nil
  573. "The display table for org-mode, in case `org-ellipsis' is non-nil.")
  574. (defgroup org-keywords nil
  575. "Keywords in Org-mode."
  576. :tag "Org Keywords"
  577. :group 'org)
  578. (defcustom org-deadline-string "DEADLINE:"
  579. "String to mark deadline entries.
  580. A deadline is this string, followed by a time stamp. Should be a word,
  581. terminated by a colon. You can insert a schedule keyword and
  582. a timestamp with \\[org-deadline].
  583. Changes become only effective after restarting Emacs."
  584. :group 'org-keywords
  585. :type 'string)
  586. (defcustom org-scheduled-string "SCHEDULED:"
  587. "String to mark scheduled TODO entries.
  588. A schedule is this string, followed by a time stamp. Should be a word,
  589. terminated by a colon. You can insert a schedule keyword and
  590. a timestamp with \\[org-schedule].
  591. Changes become only effective after restarting Emacs."
  592. :group 'org-keywords
  593. :type 'string)
  594. (defcustom org-closed-string "CLOSED:"
  595. "String used as the prefix for timestamps logging closing a TODO entry."
  596. :group 'org-keywords
  597. :type 'string)
  598. (defcustom org-clock-string "CLOCK:"
  599. "String used as prefix for timestamps clocking work hours on an item."
  600. :group 'org-keywords
  601. :type 'string)
  602. (defcustom org-comment-string "COMMENT"
  603. "Entries starting with this keyword will never be exported.
  604. An entry can be toggled between COMMENT and normal with
  605. \\[org-toggle-comment].
  606. Changes become only effective after restarting Emacs."
  607. :group 'org-keywords
  608. :type 'string)
  609. (defcustom org-quote-string "QUOTE"
  610. "Entries starting with this keyword will be exported in fixed-width font.
  611. Quoting applies only to the text in the entry following the headline, and does
  612. not extend beyond the next headline, even if that is lower level.
  613. An entry can be toggled between QUOTE and normal with
  614. \\[org-toggle-fixed-width-section]."
  615. :group 'org-keywords
  616. :type 'string)
  617. (defconst org-repeat-re
  618. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
  619. "Regular expression for specifying repeated events.
  620. After a match, group 1 contains the repeat expression.")
  621. (defgroup org-structure nil
  622. "Options concerning the general structure of Org-mode files."
  623. :tag "Org Structure"
  624. :group 'org)
  625. (defgroup org-reveal-location nil
  626. "Options about how to make context of a location visible."
  627. :tag "Org Reveal Location"
  628. :group 'org-structure)
  629. (defconst org-context-choice
  630. '(choice
  631. (const :tag "Always" t)
  632. (const :tag "Never" nil)
  633. (repeat :greedy t :tag "Individual contexts"
  634. (cons
  635. (choice :tag "Context"
  636. (const agenda)
  637. (const org-goto)
  638. (const occur-tree)
  639. (const tags-tree)
  640. (const link-search)
  641. (const mark-goto)
  642. (const bookmark-jump)
  643. (const isearch)
  644. (const default))
  645. (boolean))))
  646. "Contexts for the reveal options.")
  647. (defcustom org-show-hierarchy-above '((default . t))
  648. "Non-nil means show full hierarchy when revealing a location.
  649. Org-mode often shows locations in an org-mode file which might have
  650. been invisible before. When this is set, the hierarchy of headings
  651. above the exposed location is shown.
  652. Turning this off for example for sparse trees makes them very compact.
  653. Instead of t, this can also be an alist specifying this option for different
  654. contexts. Valid contexts are
  655. agenda when exposing an entry from the agenda
  656. org-goto when using the command `org-goto' on key C-c C-j
  657. occur-tree when using the command `org-occur' on key C-c /
  658. tags-tree when constructing a sparse tree based on tags matches
  659. link-search when exposing search matches associated with a link
  660. mark-goto when exposing the jump goal of a mark
  661. bookmark-jump when exposing a bookmark location
  662. isearch when exiting from an incremental search
  663. default default for all contexts not set explicitly"
  664. :group 'org-reveal-location
  665. :type org-context-choice)
  666. (defcustom org-show-following-heading '((default . nil))
  667. "Non-nil means show following heading when revealing a location.
  668. Org-mode often shows locations in an org-mode file which might have
  669. been invisible before. When this is set, the heading following the
  670. match is shown.
  671. Turning this off for example for sparse trees makes them very compact,
  672. but makes it harder to edit the location of the match. In such a case,
  673. use the command \\[org-reveal] to show more context.
  674. Instead of t, this can also be an alist specifying this option for different
  675. contexts. See `org-show-hierarchy-above' for valid contexts."
  676. :group 'org-reveal-location
  677. :type org-context-choice)
  678. (defcustom org-show-siblings '((default . nil) (isearch t))
  679. "Non-nil means show all sibling heading when revealing a location.
  680. Org-mode often shows locations in an org-mode file which might have
  681. been invisible before. When this is set, the sibling of the current entry
  682. heading are all made visible. If `org-show-hierarchy-above' is t,
  683. the same happens on each level of the hierarchy above the current entry.
  684. By default this is on for the isearch context, off for all other contexts.
  685. Turning this off for example for sparse trees makes them very compact,
  686. but makes it harder to edit the location of the match. In such a case,
  687. use the command \\[org-reveal] to show more context.
  688. Instead of t, this can also be an alist specifying this option for different
  689. contexts. See `org-show-hierarchy-above' for valid contexts."
  690. :group 'org-reveal-location
  691. :type org-context-choice)
  692. (defcustom org-show-entry-below '((default . nil))
  693. "Non-nil means show the entry below a headline when revealing a location.
  694. Org-mode often shows locations in an org-mode file which might have
  695. been invisible before. When this is set, the text below the headline that is
  696. exposed is also shown.
  697. By default this is off for all contexts.
  698. Instead of t, this can also be an alist specifying this option for different
  699. contexts. See `org-show-hierarchy-above' for valid contexts."
  700. :group 'org-reveal-location
  701. :type org-context-choice)
  702. (defcustom org-indirect-buffer-display 'other-window
  703. "How should indirect tree buffers be displayed?
  704. This applies to indirect buffers created with the commands
  705. \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
  706. Valid values are:
  707. current-window Display in the current window
  708. other-window Just display in another window.
  709. dedicated-frame Create one new frame, and re-use it each time.
  710. new-frame Make a new frame each time. Note that in this case
  711. previously-made indirect buffers are kept, and you need to
  712. kill these buffers yourself."
  713. :group 'org-structure
  714. :group 'org-agenda-windows
  715. :type '(choice
  716. (const :tag "In current window" current-window)
  717. (const :tag "In current frame, other window" other-window)
  718. (const :tag "Each time a new frame" new-frame)
  719. (const :tag "One dedicated frame" dedicated-frame)))
  720. (defcustom org-use-speed-commands nil
  721. "Non-nil means activate single letter commands at beginning of a headline.
  722. This may also be a function to test for appropriate locations where speed
  723. commands should be active."
  724. :group 'org-structure
  725. :type '(choice
  726. (const :tag "Never" nil)
  727. (const :tag "At beginning of headline stars" t)
  728. (function)))
  729. (defcustom org-speed-commands-user nil
  730. "Alist of additional speed commands.
  731. This list will be checked before `org-speed-commands-default'
  732. when the variable `org-use-speed-commands' is non-nil
  733. and when the cursor is at the beginning of a headline.
  734. The car if each entry is a string with a single letter, which must
  735. be assigned to `self-insert-command' in the global map.
  736. The cdr is either a command to be called interactively, a function
  737. to be called, or a form to be evaluated.
  738. An entry that is just a list with a single string will be interpreted
  739. as a descriptive headline that will be added when listing the speed
  740. commands in the Help buffer using the `?' speed command."
  741. :group 'org-structure
  742. :type '(repeat :value ("k" . ignore)
  743. (choice :value ("k" . ignore)
  744. (list :tag "Descriptive Headline" (string :tag "Headline"))
  745. (cons :tag "Letter and Command"
  746. (string :tag "Command letter")
  747. (choice
  748. (function)
  749. (sexp))))))
  750. (defgroup org-cycle nil
  751. "Options concerning visibility cycling in Org-mode."
  752. :tag "Org Cycle"
  753. :group 'org-structure)
  754. (defcustom org-cycle-skip-children-state-if-no-children t
  755. "Non-nil means skip CHILDREN state in entries that don't have any."
  756. :group 'org-cycle
  757. :type 'boolean)
  758. (defcustom org-cycle-max-level nil
  759. "Maximum level which should still be subject to visibility cycling.
  760. Levels higher than this will, for cycling, be treated as text, not a headline.
  761. When `org-odd-levels-only' is set, a value of N in this variable actually
  762. means 2N-1 stars as the limiting headline.
  763. When nil, cycle all levels.
  764. Note that the limiting level of cycling is also influenced by
  765. `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
  766. `org-inlinetask-min-level' is, cycling will be limited to levels one less
  767. than its value."
  768. :group 'org-cycle
  769. :type '(choice
  770. (const :tag "No limit" nil)
  771. (integer :tag "Maximum level")))
  772. (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK" "RESULTS")
  773. "Names of drawers. Drawers are not opened by cycling on the headline above.
  774. Drawers only open with a TAB on the drawer line itself. A drawer looks like
  775. this:
  776. :DRAWERNAME:
  777. .....
  778. :END:
  779. The drawer \"PROPERTIES\" is special for capturing properties through
  780. the property API.
  781. Drawers can be defined on the per-file basis with a line like:
  782. #+DRAWERS: HIDDEN STATE PROPERTIES"
  783. :group 'org-structure
  784. :group 'org-cycle
  785. :type '(repeat (string :tag "Drawer Name")))
  786. (defcustom org-hide-block-startup nil
  787. "Non-nil means entering Org-mode will fold all blocks.
  788. This can also be set in on a per-file basis with
  789. #+STARTUP: hideblocks
  790. #+STARTUP: showblocks"
  791. :group 'org-startup
  792. :group 'org-cycle
  793. :type 'boolean)
  794. (defcustom org-cycle-global-at-bob nil
  795. "Cycle globally if cursor is at beginning of buffer and not at a headline.
  796. This makes it possible to do global cycling without having to use S-TAB or
  797. \\[universal-argument] TAB. For this special case to work, the first line \
  798. of the buffer
  799. must not be a headline - it may be empty or some other text. When used in
  800. this way, `org-cycle-hook' is disables temporarily, to make sure the
  801. cursor stays at the beginning of the buffer.
  802. When this option is nil, don't do anything special at the beginning
  803. of the buffer."
  804. :group 'org-cycle
  805. :type 'boolean)
  806. (defcustom org-cycle-level-after-item/entry-creation t
  807. "Non-nil means cycle entry level or item indentation in new empty entries.
  808. When the cursor is at the end of an empty headline, i.e with only stars
  809. and maybe a TODO keyword, TAB will then switch the entry to become a child,
  810. and then all possible ancestor states, before returning to the original state.
  811. This makes data entry extremely fast: M-RET to create a new headline,
  812. on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
  813. When the cursor is at the end of an empty plain list item, one TAB will
  814. make it a subitem, two or more tabs will back up to make this an item
  815. higher up in the item hierarchy."
  816. :group 'org-cycle
  817. :type 'boolean)
  818. (defcustom org-cycle-emulate-tab t
  819. "Where should `org-cycle' emulate TAB.
  820. nil Never
  821. white Only in completely white lines
  822. whitestart Only at the beginning of lines, before the first non-white char
  823. t Everywhere except in headlines
  824. exc-hl-bol Everywhere except at the start of a headline
  825. If TAB is used in a place where it does not emulate TAB, the current subtree
  826. visibility is cycled."
  827. :group 'org-cycle
  828. :type '(choice (const :tag "Never" nil)
  829. (const :tag "Only in completely white lines" white)
  830. (const :tag "Before first char in a line" whitestart)
  831. (const :tag "Everywhere except in headlines" t)
  832. (const :tag "Everywhere except at bol in headlines" exc-hl-bol)
  833. ))
  834. (defcustom org-cycle-separator-lines 2
  835. "Number of empty lines needed to keep an empty line between collapsed trees.
  836. If you leave an empty line between the end of a subtree and the following
  837. headline, this empty line is hidden when the subtree is folded.
  838. Org-mode will leave (exactly) one empty line visible if the number of
  839. empty lines is equal or larger to the number given in this variable.
  840. So the default 2 means at least 2 empty lines after the end of a subtree
  841. are needed to produce free space between a collapsed subtree and the
  842. following headline.
  843. If the number is negative, and the number of empty lines is at least -N,
  844. all empty lines are shown.
  845. Special case: when 0, never leave empty lines in collapsed view."
  846. :group 'org-cycle
  847. :type 'integer)
  848. (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
  849. (defcustom org-pre-cycle-hook nil
  850. "Hook that is run before visibility cycling is happening.
  851. The function(s) in this hook must accept a single argument which indicates
  852. the new state that will be set right after running this hook. The
  853. argument is a symbol. Before a global state change, it can have the values
  854. `overview', `content', or `all'. Before a local state change, it can have
  855. the values `folded', `children', or `subtree'."
  856. :group 'org-cycle
  857. :type 'hook)
  858. (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
  859. org-cycle-hide-drawers
  860. org-cycle-show-empty-lines
  861. org-optimize-window-after-visibility-change)
  862. "Hook that is run after `org-cycle' has changed the buffer visibility.
  863. The function(s) in this hook must accept a single argument which indicates
  864. the new state that was set by the most recent `org-cycle' command. The
  865. argument is a symbol. After a global state change, it can have the values
  866. `overview', `content', or `all'. After a local state change, it can have
  867. the values `folded', `children', or `subtree'."
  868. :group 'org-cycle
  869. :type 'hook)
  870. (defgroup org-edit-structure nil
  871. "Options concerning structure editing in Org-mode."
  872. :tag "Org Edit Structure"
  873. :group 'org-structure)
  874. (defcustom org-odd-levels-only nil
  875. "Non-nil means skip even levels and only use odd levels for the outline.
  876. This has the effect that two stars are being added/taken away in
  877. promotion/demotion commands. It also influences how levels are
  878. handled by the exporters.
  879. Changing it requires restart of `font-lock-mode' to become effective
  880. for fontification also in regions already fontified.
  881. You may also set this on a per-file basis by adding one of the following
  882. lines to the buffer:
  883. #+STARTUP: odd
  884. #+STARTUP: oddeven"
  885. :group 'org-edit-structure
  886. :group 'org-appearance
  887. :type 'boolean)
  888. (defcustom org-adapt-indentation t
  889. "Non-nil means adapt indentation to outline node level.
  890. When this variable is set, Org assumes that you write outlines by
  891. indenting text in each node to align with the headline (after the stars).
  892. The following issues are influenced by this variable:
  893. - When this is set and the *entire* text in an entry is indented, the
  894. indentation is increased by one space in a demotion command, and
  895. decreased by one in a promotion command. If any line in the entry
  896. body starts with text at column 0, indentation is not changed at all.
  897. - Property drawers and planning information is inserted indented when
  898. this variable s set. When nil, they will not be indented.
  899. - TAB indents a line relative to context. The lines below a headline
  900. will be indented when this variable is set.
  901. Note that this is all about true indentation, by adding and removing
  902. space characters. See also `org-indent.el' which does level-dependent
  903. indentation in a virtual way, i.e. at display time in Emacs."
  904. :group 'org-edit-structure
  905. :type 'boolean)
  906. (defcustom org-special-ctrl-a/e nil
  907. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  908. When t, `C-a' will bring back the cursor to the beginning of the
  909. headline text, i.e. after the stars and after a possible TODO
  910. keyword. In an item, this will be the position after bullet and
  911. check-box, if any. When the cursor is already at that position,
  912. another `C-a' will bring it to the beginning of the line.
  913. `C-e' will jump to the end of the headline, ignoring the presence
  914. of tags in the headline. A second `C-e' will then jump to the
  915. true end of the line, after any tags. This also means that, when
  916. this variable is non-nil, `C-e' also will never jump beyond the
  917. end of the heading of a folded section, i.e. not after the
  918. ellipses.
  919. When set to the symbol `reversed', the first `C-a' or `C-e' works
  920. normally, going to the true line boundary first. Only a directly
  921. following, identical keypress will bring the cursor to the
  922. special positions.
  923. This may also be a cons cell where the behavior for `C-a' and
  924. `C-e' is set separately."
  925. :group 'org-edit-structure
  926. :type '(choice
  927. (const :tag "off" nil)
  928. (const :tag "on: after stars/bullet and before tags first" t)
  929. (const :tag "reversed: true line boundary first" reversed)
  930. (cons :tag "Set C-a and C-e separately"
  931. (choice :tag "Special C-a"
  932. (const :tag "off" nil)
  933. (const :tag "on: after stars/bullet first" t)
  934. (const :tag "reversed: before stars/bullet first" reversed))
  935. (choice :tag "Special C-e"
  936. (const :tag "off" nil)
  937. (const :tag "on: before tags first" t)
  938. (const :tag "reversed: after tags first" reversed)))))
  939. (if (fboundp 'defvaralias)
  940. (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e))
  941. (defcustom org-special-ctrl-k nil
  942. "Non-nil means `C-k' will behave specially in headlines.
  943. When nil, `C-k' will call the default `kill-line' command.
  944. When t, the following will happen while the cursor is in the headline:
  945. - When the cursor is at the beginning of a headline, kill the entire
  946. line and possible the folded subtree below the line.
  947. - When in the middle of the headline text, kill the headline up to the tags.
  948. - When after the headline text, kill the tags."
  949. :group 'org-edit-structure
  950. :type 'boolean)
  951. (defcustom org-ctrl-k-protect-subtree nil
  952. "Non-nil means, do not delete a hidden subtree with C-k.
  953. When set to the symbol `error', simply throw an error when C-k is
  954. used to kill (part-of) a headline that has hidden text behind it.
  955. Any other non-nil value will result in a query to the user, if it is
  956. OK to kill that hidden subtree. When nil, kill without remorse."
  957. :group 'org-edit-structure
  958. :version "24.1"
  959. :type '(choice
  960. (const :tag "Do not protect hidden subtrees" nil)
  961. (const :tag "Protect hidden subtrees with a security query" t)
  962. (const :tag "Never kill a hidden subtree with C-k" error)))
  963. (defcustom org-catch-invisible-edits nil
  964. "Check if in invisible region before inserting or deleting a character.
  965. Valid values are:
  966. nil Do not check, so just do invisible edits.
  967. error Throw an error and do nothing.
  968. show Make point visible, and do the requested edit.
  969. show-and-error Make point visible, then throw an error and abort the edit.
  970. smart Make point visible, and do insertion/deletion if it is
  971. adjacent to visible text and the change feels predictable.
  972. Never delete a previously invisible character or add in the
  973. middle or right after an invisible region. Basically, this
  974. allows insertion and backward-delete right before ellipses.
  975. FIXME: maybe in this case we should not even show?"
  976. :group 'org-edit-structure
  977. :version "24.1"
  978. :type '(choice
  979. (const :tag "Do not check" nil)
  980. (const :tag "Throw error when trying to edit" error)
  981. (const :tag "Unhide, but do not do the edit" show-and-error)
  982. (const :tag "Show invisible part and do the edit" show)
  983. (const :tag "Be smart and do the right thing" smart)))
  984. (defcustom org-yank-folded-subtrees t
  985. "Non-nil means when yanking subtrees, fold them.
  986. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  987. it starts with a heading and all other headings in it are either children
  988. or siblings, then fold all the subtrees. However, do this only if no
  989. text after the yank would be swallowed into a folded tree by this action."
  990. :group 'org-edit-structure
  991. :type 'boolean)
  992. (defcustom org-yank-adjusted-subtrees nil
  993. "Non-nil means when yanking subtrees, adjust the level.
  994. With this setting, `org-paste-subtree' is used to insert the subtree, see
  995. this function for details."
  996. :group 'org-edit-structure
  997. :type 'boolean)
  998. (defcustom org-M-RET-may-split-line '((default . t))
  999. "Non-nil means M-RET will split the line at the cursor position.
  1000. When nil, it will go to the end of the line before making a
  1001. new line.
  1002. You may also set this option in a different way for different
  1003. contexts. Valid contexts are:
  1004. headline when creating a new headline
  1005. item when creating a new item
  1006. table in a table field
  1007. default the value to be used for all contexts not explicitly
  1008. customized"
  1009. :group 'org-structure
  1010. :group 'org-table
  1011. :type '(choice
  1012. (const :tag "Always" t)
  1013. (const :tag "Never" nil)
  1014. (repeat :greedy t :tag "Individual contexts"
  1015. (cons
  1016. (choice :tag "Context"
  1017. (const headline)
  1018. (const item)
  1019. (const table)
  1020. (const default))
  1021. (boolean)))))
  1022. (defcustom org-insert-heading-respect-content nil
  1023. "Non-nil means insert new headings after the current subtree.
  1024. When nil, the new heading is created directly after the current line.
  1025. The commands \\[org-insert-heading-respect-content] and
  1026. \\[org-insert-todo-heading-respect-content] turn this variable on
  1027. for the duration of the command."
  1028. :group 'org-structure
  1029. :type 'boolean)
  1030. (defcustom org-blank-before-new-entry '((heading . auto)
  1031. (plain-list-item . auto))
  1032. "Should `org-insert-heading' leave a blank line before new heading/item?
  1033. The value is an alist, with `heading' and `plain-list-item' as CAR,
  1034. and a boolean flag as CDR. The cdr may also be the symbol `auto', in
  1035. which case Org will look at the surrounding headings/items and try to
  1036. make an intelligent decision whether to insert a blank line or not.
  1037. For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
  1038. set, the setting here is ignored and no empty line is inserted, to avoid
  1039. breaking the list structure."
  1040. :group 'org-edit-structure
  1041. :type '(list
  1042. (cons (const heading)
  1043. (choice (const :tag "Never" nil)
  1044. (const :tag "Always" t)
  1045. (const :tag "Auto" auto)))
  1046. (cons (const plain-list-item)
  1047. (choice (const :tag "Never" nil)
  1048. (const :tag "Always" t)
  1049. (const :tag "Auto" auto)))))
  1050. (defcustom org-insert-heading-hook nil
  1051. "Hook being run after inserting a new heading."
  1052. :group 'org-edit-structure
  1053. :type 'hook)
  1054. (defcustom org-enable-fixed-width-editor t
  1055. "Non-nil means lines starting with \":\" are treated as fixed-width.
  1056. This currently only means they are never auto-wrapped.
  1057. When nil, such lines will be treated like ordinary lines.
  1058. See also the QUOTE keyword."
  1059. :group 'org-edit-structure
  1060. :type 'boolean)
  1061. (defcustom org-goto-auto-isearch t
  1062. "Non-nil means typing characters in `org-goto' starts incremental search."
  1063. :group 'org-edit-structure
  1064. :type 'boolean)
  1065. (defgroup org-sparse-trees nil
  1066. "Options concerning sparse trees in Org-mode."
  1067. :tag "Org Sparse Trees"
  1068. :group 'org-structure)
  1069. (defcustom org-highlight-sparse-tree-matches t
  1070. "Non-nil means highlight all matches that define a sparse tree.
  1071. The highlights will automatically disappear the next time the buffer is
  1072. changed by an edit command."
  1073. :group 'org-sparse-trees
  1074. :type 'boolean)
  1075. (defcustom org-remove-highlights-with-change t
  1076. "Non-nil means any change to the buffer will remove temporary highlights.
  1077. Such highlights are created by `org-occur' and `org-clock-display'.
  1078. When nil, `C-c C-c needs to be used to get rid of the highlights.
  1079. The highlights created by `org-preview-latex-fragment' always need
  1080. `C-c C-c' to be removed."
  1081. :group 'org-sparse-trees
  1082. :group 'org-time
  1083. :type 'boolean)
  1084. (defcustom org-occur-hook '(org-first-headline-recenter)
  1085. "Hook that is run after `org-occur' has constructed a sparse tree.
  1086. This can be used to recenter the window to show as much of the structure
  1087. as possible."
  1088. :group 'org-sparse-trees
  1089. :type 'hook)
  1090. (defgroup org-imenu-and-speedbar nil
  1091. "Options concerning imenu and speedbar in Org-mode."
  1092. :tag "Org Imenu and Speedbar"
  1093. :group 'org-structure)
  1094. (defcustom org-imenu-depth 2
  1095. "The maximum level for Imenu access to Org-mode headlines.
  1096. This also applied for speedbar access."
  1097. :group 'org-imenu-and-speedbar
  1098. :type 'integer)
  1099. (defgroup org-table nil
  1100. "Options concerning tables in Org-mode."
  1101. :tag "Org Table"
  1102. :group 'org)
  1103. (defcustom org-enable-table-editor 'optimized
  1104. "Non-nil means lines starting with \"|\" are handled by the table editor.
  1105. When nil, such lines will be treated like ordinary lines.
  1106. When equal to the symbol `optimized', the table editor will be optimized to
  1107. do the following:
  1108. - Automatic overwrite mode in front of whitespace in table fields.
  1109. This makes the structure of the table stay in tact as long as the edited
  1110. field does not exceed the column width.
  1111. - Minimize the number of realigns. Normally, the table is aligned each time
  1112. TAB or RET are pressed to move to another field. With optimization this
  1113. happens only if changes to a field might have changed the column width.
  1114. Optimization requires replacing the functions `self-insert-command',
  1115. `delete-char', and `backward-delete-char' in Org-mode buffers, with a
  1116. slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
  1117. very good at guessing when a re-align will be necessary, but you can always
  1118. force one with \\[org-ctrl-c-ctrl-c].
  1119. If you would like to use the optimized version in Org-mode, but the
  1120. un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
  1121. This variable can be used to turn on and off the table editor during a session,
  1122. but in order to toggle optimization, a restart is required.
  1123. See also the variable `org-table-auto-blank-field'."
  1124. :group 'org-table
  1125. :type '(choice
  1126. (const :tag "off" nil)
  1127. (const :tag "on" t)
  1128. (const :tag "on, optimized" optimized)))
  1129. (defcustom org-self-insert-cluster-for-undo t
  1130. "Non-nil means cluster self-insert commands for undo when possible.
  1131. If this is set, then, like in the Emacs command loop, 20 consecutive
  1132. characters will be undone together.
  1133. This is configurable, because there is some impact on typing performance."
  1134. :group 'org-table
  1135. :type 'boolean)
  1136. (defcustom org-table-tab-recognizes-table.el t
  1137. "Non-nil means TAB will automatically notice a table.el table.
  1138. When it sees such a table, it moves point into it and - if necessary -
  1139. calls `table-recognize-table'."
  1140. :group 'org-table-editing
  1141. :type 'boolean)
  1142. (defgroup org-link nil
  1143. "Options concerning links in Org-mode."
  1144. :tag "Org Link"
  1145. :group 'org)
  1146. (defvar org-link-abbrev-alist-local nil
  1147. "Buffer-local version of `org-link-abbrev-alist', which see.
  1148. The value of this is taken from the #+LINK lines.")
  1149. (make-variable-buffer-local 'org-link-abbrev-alist-local)
  1150. (defcustom org-link-abbrev-alist nil
  1151. "Alist of link abbreviations.
  1152. The car of each element is a string, to be replaced at the start of a link.
  1153. The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
  1154. links in Org-mode buffers can have an optional tag after a double colon, e.g.
  1155. [[linkkey:tag][description]]
  1156. The 'linkkey' must be a word word, starting with a letter, followed
  1157. by letters, numbers, '-' or '_'.
  1158. If REPLACE is a string, the tag will simply be appended to create the link.
  1159. If the string contains \"%s\", the tag will be inserted there. Alternatively,
  1160. the placeholder \"%h\" will cause a url-encoded version of the tag to
  1161. be inserted at that point (see the function `url-hexify-string').
  1162. REPLACE may also be a function that will be called with the tag as the
  1163. only argument to create the link, which should be returned as a string.
  1164. See the manual for examples."
  1165. :group 'org-link
  1166. :type '(repeat
  1167. (cons
  1168. (string :tag "Protocol")
  1169. (choice
  1170. (string :tag "Format")
  1171. (function)))))
  1172. (defcustom org-descriptive-links t
  1173. "Non-nil means Org will display descriptive links.
  1174. E.g. [[http://orgmode.org][Org website]] will be displayed as
  1175. \"Org Website\", hiding the link itself and just displaying its
  1176. description. When set to `nil', Org will display the full links
  1177. literally.
  1178. You can interactively set the value of this variable by calling
  1179. `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
  1180. :group 'org-link
  1181. :type 'boolean)
  1182. (defcustom org-link-file-path-type 'adaptive
  1183. "How the path name in file links should be stored.
  1184. Valid values are:
  1185. relative Relative to the current directory, i.e. the directory of the file
  1186. into which the link is being inserted.
  1187. absolute Absolute path, if possible with ~ for home directory.
  1188. noabbrev Absolute path, no abbreviation of home directory.
  1189. adaptive Use relative path for files in the current directory and sub-
  1190. directories of it. For other files, use an absolute path."
  1191. :group 'org-link
  1192. :type '(choice
  1193. (const relative)
  1194. (const absolute)
  1195. (const noabbrev)
  1196. (const adaptive)))
  1197. (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
  1198. "Types of links that should be activated in Org-mode files.
  1199. This is a list of symbols, each leading to the activation of a certain link
  1200. type. In principle, it does not hurt to turn on most link types - there may
  1201. be a small gain when turning off unused link types. The types are:
  1202. bracket The recommended [[link][description]] or [[link]] links with hiding.
  1203. angle Links in angular brackets that may contain whitespace like
  1204. <bbdb:Carsten Dominik>.
  1205. plain Plain links in normal text, no whitespace, like http://google.com.
  1206. radio Text that is matched by a radio target, see manual for details.
  1207. tag Tag settings in a headline (link to tag search).
  1208. date Time stamps (link to calendar).
  1209. footnote Footnote labels.
  1210. Changing this variable requires a restart of Emacs to become effective."
  1211. :group 'org-link
  1212. :type '(set :greedy t
  1213. (const :tag "Double bracket links" bracket)
  1214. (const :tag "Angular bracket links" angle)
  1215. (const :tag "Plain text links" plain)
  1216. (const :tag "Radio target matches" radio)
  1217. (const :tag "Tags" tag)
  1218. (const :tag "Timestamps" date)
  1219. (const :tag "Footnotes" footnote)))
  1220. (defcustom org-make-link-description-function nil
  1221. "Function to use to generate link descriptions from links.
  1222. If nil the link location will be used. This function must take
  1223. two parameters; the first is the link and the second the
  1224. description `org-insert-link' has generated, and should return the
  1225. description to use."
  1226. :group 'org-link
  1227. :type 'function)
  1228. (defgroup org-link-store nil
  1229. "Options concerning storing links in Org-mode."
  1230. :tag "Org Store Link"
  1231. :group 'org-link)
  1232. (defcustom org-email-link-description-format "Email %c: %.30s"
  1233. "Format of the description part of a link to an email or usenet message.
  1234. The following %-escapes will be replaced by corresponding information:
  1235. %F full \"From\" field
  1236. %f name, taken from \"From\" field, address if no name
  1237. %T full \"To\" field
  1238. %t first name in \"To\" field, address if no name
  1239. %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
  1240. will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
  1241. %s subject
  1242. %d date
  1243. %m message-id.
  1244. You may use normal field width specification between the % and the letter.
  1245. This is for example useful to limit the length of the subject.
  1246. Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
  1247. :group 'org-link-store
  1248. :type 'string)
  1249. (defcustom org-from-is-user-regexp
  1250. (let (r1 r2)
  1251. (when (and user-mail-address (not (string= user-mail-address "")))
  1252. (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
  1253. (when (and user-full-name (not (string= user-full-name "")))
  1254. (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
  1255. (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
  1256. "Regexp matched against the \"From:\" header of an email or usenet message.
  1257. It should match if the message is from the user him/herself."
  1258. :group 'org-link-store
  1259. :type 'regexp)
  1260. (defcustom org-link-to-org-use-id 'create-if-interactive-and-no-custom-id
  1261. "Non-nil means storing a link to an Org file will use entry IDs.
  1262. Note that before this variable is even considered, org-id must be loaded,
  1263. so please customize `org-modules' and turn it on.
  1264. The variable can have the following values:
  1265. t Create an ID if needed to make a link to the current entry.
  1266. create-if-interactive
  1267. If `org-store-link' is called directly (interactively, as a user
  1268. command), do create an ID to support the link. But when doing the
  1269. job for remember, only use the ID if it already exists. The
  1270. purpose of this setting is to avoid proliferation of unwanted
  1271. IDs, just because you happen to be in an Org file when you
  1272. call `org-remember' that automatically and preemptively
  1273. creates a link. If you do want to get an ID link in a remember
  1274. template to an entry not having an ID, create it first by
  1275. explicitly creating a link to it, using `C-c C-l' first.
  1276. create-if-interactive-and-no-custom-id
  1277. Like create-if-interactive, but do not create an ID if there is
  1278. a CUSTOM_ID property defined in the entry. This is the default.
  1279. use-existing
  1280. Use existing ID, do not create one.
  1281. nil Never use an ID to make a link, instead link using a text search for
  1282. the headline text."
  1283. :group 'org-link-store
  1284. :type '(choice
  1285. (const :tag "Create ID to make link" t)
  1286. (const :tag "Create if storing link interactively"
  1287. create-if-interactive)
  1288. (const :tag "Create if storing link interactively and no CUSTOM_ID is present"
  1289. create-if-interactive-and-no-custom-id)
  1290. (const :tag "Only use existing" use-existing)
  1291. (const :tag "Do not use ID to create link" nil)))
  1292. (defcustom org-context-in-file-links t
  1293. "Non-nil means file links from `org-store-link' contain context.
  1294. A search string will be added to the file name with :: as separator and
  1295. used to find the context when the link is activated by the command
  1296. `org-open-at-point'. When this option is t, the entire active region
  1297. will be placed in the search string of the file link. If set to a
  1298. positive integer, only the first n lines of context will be stored.
  1299. Using a prefix arg to the command \\[org-store-link] (`org-store-link')
  1300. negates this setting for the duration of the command."
  1301. :group 'org-link-store
  1302. :type '(choice boolean integer))
  1303. (defcustom org-keep-stored-link-after-insertion nil
  1304. "Non-nil means keep link in list for entire session.
  1305. The command `org-store-link' adds a link pointing to the current
  1306. location to an internal list. These links accumulate during a session.
  1307. The command `org-insert-link' can be used to insert links into any
  1308. Org-mode file (offering completion for all stored links). When this
  1309. option is nil, every link which has been inserted once using \\[org-insert-link]
  1310. will be removed from the list, to make completing the unused links
  1311. more efficient."
  1312. :group 'org-link-store
  1313. :type 'boolean)
  1314. (defgroup org-link-follow nil
  1315. "Options concerning following links in Org-mode."
  1316. :tag "Org Follow Link"
  1317. :group 'org-link)
  1318. (defcustom org-link-translation-function nil
  1319. "Function to translate links with different syntax to Org syntax.
  1320. This can be used to translate links created for example by the Planner
  1321. or emacs-wiki packages to Org syntax.
  1322. The function must accept two parameters, a TYPE containing the link
  1323. protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
  1324. which is everything after the link protocol. It should return a cons
  1325. with possibly modified values of type and path.
  1326. Org contains a function for this, so if you set this variable to
  1327. `org-translate-link-from-planner', you should be able follow many
  1328. links created by planner."
  1329. :group 'org-link-follow
  1330. :type 'function)
  1331. (defcustom org-follow-link-hook nil
  1332. "Hook that is run after a link has been followed."
  1333. :group 'org-link-follow
  1334. :type 'hook)
  1335. (defcustom org-tab-follows-link nil
  1336. "Non-nil means on links TAB will follow the link.
  1337. Needs to be set before org.el is loaded.
  1338. This really should not be used, it does not make sense, and the
  1339. implementation is bad."
  1340. :group 'org-link-follow
  1341. :type 'boolean)
  1342. (defcustom org-return-follows-link nil
  1343. "Non-nil means on links RET will follow the link."
  1344. :group 'org-link-follow
  1345. :type 'boolean)
  1346. (defcustom org-mouse-1-follows-link
  1347. (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
  1348. "Non-nil means mouse-1 on a link will follow the link.
  1349. A longer mouse click will still set point. Does not work on XEmacs.
  1350. Needs to be set before org.el is loaded."
  1351. :group 'org-link-follow
  1352. :type 'boolean)
  1353. (defcustom org-mark-ring-length 4
  1354. "Number of different positions to be recorded in the ring.
  1355. Changing this requires a restart of Emacs to work correctly."
  1356. :group 'org-link-follow
  1357. :type 'integer)
  1358. (defcustom org-link-search-must-match-exact-headline 'query-to-create
  1359. "Non-nil means internal links in Org files must exactly match a headline.
  1360. When nil, the link search tries to match a phrase with all words
  1361. in the search text."
  1362. :group 'org-link-follow
  1363. :version "24.1"
  1364. :type '(choice
  1365. (const :tag "Use fuzzy text search" nil)
  1366. (const :tag "Match only exact headline" t)
  1367. (const :tag "Match exact headline or query to create it"
  1368. query-to-create)))
  1369. (defcustom org-link-frame-setup
  1370. '((vm . vm-visit-folder-other-frame)
  1371. (vm-imap . vm-visit-imap-folder-other-frame)
  1372. (gnus . org-gnus-no-new-news)
  1373. (file . find-file-other-window)
  1374. (wl . wl-other-frame))
  1375. "Setup the frame configuration for following links.
  1376. When following a link with Emacs, it may often be useful to display
  1377. this link in another window or frame. This variable can be used to
  1378. set this up for the different types of links.
  1379. For VM, use any of
  1380. `vm-visit-folder'
  1381. `vm-visit-folder-other-window'
  1382. `vm-visit-folder-other-frame'
  1383. For Gnus, use any of
  1384. `gnus'
  1385. `gnus-other-frame'
  1386. `org-gnus-no-new-news'
  1387. For FILE, use any of
  1388. `find-file'
  1389. `find-file-other-window'
  1390. `find-file-other-frame'
  1391. For Wanderlust use any of
  1392. `wl'
  1393. `wl-other-frame'
  1394. For the calendar, use the variable `calendar-setup'.
  1395. For BBDB, it is currently only possible to display the matches in
  1396. another window."
  1397. :group 'org-link-follow
  1398. :type '(list
  1399. (cons (const vm)
  1400. (choice
  1401. (const vm-visit-folder)
  1402. (const vm-visit-folder-other-window)
  1403. (const vm-visit-folder-other-frame)))
  1404. (cons (const gnus)
  1405. (choice
  1406. (const gnus)
  1407. (const gnus-other-frame)
  1408. (const org-gnus-no-new-news)))
  1409. (cons (const file)
  1410. (choice
  1411. (const find-file)
  1412. (const find-file-other-window)
  1413. (const find-file-other-frame)))
  1414. (cons (const wl)
  1415. (choice
  1416. (const wl)
  1417. (const wl-other-frame)))))
  1418. (defcustom org-display-internal-link-with-indirect-buffer nil
  1419. "Non-nil means use indirect buffer to display infile links.
  1420. Activating internal links (from one location in a file to another location
  1421. in the same file) normally just jumps to the location. When the link is
  1422. activated with a \\[universal-argument] prefix (or with mouse-3), the link \
  1423. is displayed in
  1424. another window. When this option is set, the other window actually displays
  1425. an indirect buffer clone of the current buffer, to avoid any visibility
  1426. changes to the current buffer."
  1427. :group 'org-link-follow
  1428. :type 'boolean)
  1429. (defcustom org-open-non-existing-files nil
  1430. "Non-nil means `org-open-file' will open non-existing files.
  1431. When nil, an error will be generated.
  1432. This variable applies only to external applications because they
  1433. might choke on non-existing files. If the link is to a file that
  1434. will be opened in Emacs, the variable is ignored."
  1435. :group 'org-link-follow
  1436. :type 'boolean)
  1437. (defcustom org-open-directory-means-index-dot-org nil
  1438. "Non-nil means a link to a directory really means to index.org.
  1439. When nil, following a directory link will run dired or open a finder/explorer
  1440. window on that directory."
  1441. :group 'org-link-follow
  1442. :type 'boolean)
  1443. (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
  1444. "Function and arguments to call for following mailto links.
  1445. This is a list with the first element being a Lisp function, and the
  1446. remaining elements being arguments to the function. In string arguments,
  1447. %a will be replaced by the address, and %s will be replaced by the subject
  1448. if one was given like in <mailto:arthur@galaxy.org::this subject>."
  1449. :group 'org-link-follow
  1450. :type '(choice
  1451. (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
  1452. (const :tag "compose-mail" (compose-mail "%a" "%s"))
  1453. (const :tag "message-mail" (message-mail "%a" "%s"))
  1454. (cons :tag "other" (function) (repeat :tag "argument" sexp))))
  1455. (defcustom org-confirm-shell-link-function 'yes-or-no-p
  1456. "Non-nil means ask for confirmation before executing shell links.
  1457. Shell links can be dangerous: just think about a link
  1458. [[shell:rm -rf ~/*][Google Search]]
  1459. This link would show up in your Org-mode document as \"Google Search\",
  1460. but really it would remove your entire home directory.
  1461. Therefore we advise against setting this variable to nil.
  1462. Just change it to `y-or-n-p' if you want to confirm with a
  1463. single keystroke rather than having to type \"yes\"."
  1464. :group 'org-link-follow
  1465. :type '(choice
  1466. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1467. (const :tag "with y-or-n (faster)" y-or-n-p)
  1468. (const :tag "no confirmation (dangerous)" nil)))
  1469. (put 'org-confirm-shell-link-function
  1470. 'safe-local-variable
  1471. #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1472. (defcustom org-confirm-shell-link-not-regexp ""
  1473. "A regexp to skip confirmation for shell links."
  1474. :group 'org-link-follow
  1475. :version "24.1"
  1476. :type 'regexp)
  1477. (defcustom org-confirm-elisp-link-function 'yes-or-no-p
  1478. "Non-nil means ask for confirmation before executing Emacs Lisp links.
  1479. Elisp links can be dangerous: just think about a link
  1480. [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
  1481. This link would show up in your Org-mode document as \"Google Search\",
  1482. but really it would remove your entire home directory.
  1483. Therefore we advise against setting this variable to nil.
  1484. Just change it to `y-or-n-p' if you want to confirm with a
  1485. single keystroke rather than having to type \"yes\"."
  1486. :group 'org-link-follow
  1487. :type '(choice
  1488. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1489. (const :tag "with y-or-n (faster)" y-or-n-p)
  1490. (const :tag "no confirmation (dangerous)" nil)))
  1491. (put 'org-confirm-shell-link-function
  1492. 'safe-local-variable
  1493. #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1494. (defcustom org-confirm-elisp-link-not-regexp ""
  1495. "A regexp to skip confirmation for Elisp links."
  1496. :group 'org-link-follow
  1497. :version "24.1"
  1498. :type 'regexp)
  1499. (defconst org-file-apps-defaults-gnu
  1500. '((remote . emacs)
  1501. (system . mailcap)
  1502. (t . mailcap))
  1503. "Default file applications on a UNIX or GNU/Linux system.
  1504. See `org-file-apps'.")
  1505. (defconst org-file-apps-defaults-macosx
  1506. '((remote . emacs)
  1507. (t . "open %s")
  1508. (system . "open %s")
  1509. ("ps.gz" . "gv %s")
  1510. ("eps.gz" . "gv %s")
  1511. ("dvi" . "xdvi %s")
  1512. ("fig" . "xfig %s"))
  1513. "Default file applications on a MacOS X system.
  1514. The system \"open\" is known as a default, but we use X11 applications
  1515. for some files for which the OS does not have a good default.
  1516. See `org-file-apps'.")
  1517. (defconst org-file-apps-defaults-windowsnt
  1518. (list
  1519. '(remote . emacs)
  1520. (cons t
  1521. (list (if (featurep 'xemacs)
  1522. 'mswindows-shell-execute
  1523. 'w32-shell-execute)
  1524. "open" 'file))
  1525. (cons 'system
  1526. (list (if (featurep 'xemacs)
  1527. 'mswindows-shell-execute
  1528. 'w32-shell-execute)
  1529. "open" 'file)))
  1530. "Default file applications on a Windows NT system.
  1531. The system \"open\" is used for most files.
  1532. See `org-file-apps'.")
  1533. (defcustom org-file-apps
  1534. '(
  1535. (auto-mode . emacs)
  1536. ("\\.mm\\'" . default)
  1537. ("\\.x?html?\\'" . default)
  1538. ("\\.pdf\\'" . default)
  1539. )
  1540. "External applications for opening `file:path' items in a document.
  1541. Org-mode uses system defaults for different file types, but
  1542. you can use this variable to set the application for a given file
  1543. extension. The entries in this list are cons cells where the car identifies
  1544. files and the cdr the corresponding command. Possible values for the
  1545. file identifier are
  1546. \"string\" A string as a file identifier can be interpreted in different
  1547. ways, depending on its contents:
  1548. - Alphanumeric characters only:
  1549. Match links with this file extension.
  1550. Example: (\"pdf\" . \"evince %s\")
  1551. to open PDFs with evince.
  1552. - Regular expression: Match links where the
  1553. filename matches the regexp. If you want to
  1554. use groups here, use shy groups.
  1555. Example: (\"\\.x?html\\'\" . \"firefox %s\")
  1556. (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
  1557. to open *.html and *.xhtml with firefox.
  1558. - Regular expression which contains (non-shy) groups:
  1559. Match links where the whole link, including \"::\", and
  1560. anything after that, matches the regexp.
  1561. In a custom command string, %1, %2, etc. are replaced with
  1562. the parts of the link that were matched by the groups.
  1563. For backwards compatibility, if a command string is given
  1564. that does not use any of the group matches, this case is
  1565. handled identically to the second one (i.e. match against
  1566. file name only).
  1567. In a custom lisp form, you can access the group matches with
  1568. (match-string n link).
  1569. Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
  1570. to open [[file:document.pdf::5]] with evince at page 5.
  1571. `directory' Matches a directory
  1572. `remote' Matches a remote file, accessible through tramp or efs.
  1573. Remote files most likely should be visited through Emacs
  1574. because external applications cannot handle such paths.
  1575. `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
  1576. so all files Emacs knows how to handle. Using this with
  1577. command `emacs' will open most files in Emacs. Beware that this
  1578. will also open html files inside Emacs, unless you add
  1579. (\"html\" . default) to the list as well.
  1580. t Default for files not matched by any of the other options.
  1581. `system' The system command to open files, like `open' on Windows
  1582. and Mac OS X, and mailcap under GNU/Linux. This is the command
  1583. that will be selected if you call `C-c C-o' with a double
  1584. \\[universal-argument] \\[universal-argument] prefix.
  1585. Possible values for the command are:
  1586. `emacs' The file will be visited by the current Emacs process.
  1587. `default' Use the default application for this file type, which is the
  1588. association for t in the list, most likely in the system-specific
  1589. part.
  1590. This can be used to overrule an unwanted setting in the
  1591. system-specific variable.
  1592. `system' Use the system command for opening files, like \"open\".
  1593. This command is specified by the entry whose car is `system'.
  1594. Most likely, the system-specific version of this variable
  1595. does define this command, but you can overrule/replace it
  1596. here.
  1597. string A command to be executed by a shell; %s will be replaced
  1598. by the path to the file.
  1599. sexp A Lisp form which will be evaluated. The file path will
  1600. be available in the Lisp variable `file'.
  1601. For more examples, see the system specific constants
  1602. `org-file-apps-defaults-macosx'
  1603. `org-file-apps-defaults-windowsnt'
  1604. `org-file-apps-defaults-gnu'."
  1605. :group 'org-link-follow
  1606. :type '(repeat
  1607. (cons (choice :value ""
  1608. (string :tag "Extension")
  1609. (const :tag "System command to open files" system)
  1610. (const :tag "Default for unrecognized files" t)
  1611. (const :tag "Remote file" remote)
  1612. (const :tag "Links to a directory" directory)
  1613. (const :tag "Any files that have Emacs modes"
  1614. auto-mode))
  1615. (choice :value ""
  1616. (const :tag "Visit with Emacs" emacs)
  1617. (const :tag "Use default" default)
  1618. (const :tag "Use the system command" system)
  1619. (string :tag "Command")
  1620. (sexp :tag "Lisp form")))))
  1621. (defcustom org-doi-server-url "http://dx.doi.org/"
  1622. "The URL of the DOI server."
  1623. :type 'string
  1624. :version "24.2"
  1625. :group 'org-link-follow)
  1626. (defgroup org-refile nil
  1627. "Options concerning refiling entries in Org-mode."
  1628. :tag "Org Refile"
  1629. :group 'org)
  1630. (defcustom org-directory "~/org"
  1631. "Directory with org files.
  1632. This is just a default location to look for Org files. There is no need
  1633. at all to put your files into this directory. It is only used in the
  1634. following situations:
  1635. 1. When a remember template specifies a target file that is not an
  1636. absolute path. The path will then be interpreted relative to
  1637. `org-directory'
  1638. 2. When a remember note is filed away in an interactive way (when exiting the
  1639. note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
  1640. with `org-directory' as the default path."
  1641. :group 'org-refile
  1642. :group 'org-remember
  1643. :type 'directory)
  1644. (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
  1645. "Default target for storing notes.
  1646. Used as a fall back file for org-remember.el and org-capture.el, for
  1647. templates that do not specify a target file."
  1648. :group 'org-refile
  1649. :group 'org-remember
  1650. :type '(choice
  1651. (const :tag "Default from remember-data-file" nil)
  1652. file))
  1653. (defcustom org-goto-interface 'outline
  1654. "The default interface to be used for `org-goto'.
  1655. Allowed values are:
  1656. outline The interface shows an outline of the relevant file
  1657. and the correct heading is found by moving through
  1658. the outline or by searching with incremental search.
  1659. outline-path-completion Headlines in the current buffer are offered via
  1660. completion. This is the interface also used by
  1661. the refile command."
  1662. :group 'org-refile
  1663. :type '(choice
  1664. (const :tag "Outline" outline)
  1665. (const :tag "Outline-path-completion" outline-path-completion)))
  1666. (defcustom org-goto-max-level 5
  1667. "Maximum target level when running `org-goto' with refile interface."
  1668. :group 'org-refile
  1669. :type 'integer)
  1670. (defcustom org-reverse-note-order nil
  1671. "Non-nil means store new notes at the beginning of a file or entry.
  1672. When nil, new notes will be filed to the end of a file or entry.
  1673. This can also be a list with cons cells of regular expressions that
  1674. are matched against file names, and values."
  1675. :group 'org-remember
  1676. :group 'org-refile
  1677. :type '(choice
  1678. (const :tag "Reverse always" t)
  1679. (const :tag "Reverse never" nil)
  1680. (repeat :tag "By file name regexp"
  1681. (cons regexp boolean))))
  1682. (defcustom org-log-refile nil
  1683. "Information to record when a task is refiled.
  1684. Possible values are:
  1685. nil Don't add anything
  1686. time Add a time stamp to the task
  1687. note Prompt for a note and add it with template `org-log-note-headings'
  1688. This option can also be set with on a per-file-basis with
  1689. #+STARTUP: nologrefile
  1690. #+STARTUP: logrefile
  1691. #+STARTUP: lognoterefile
  1692. You can have local logging settings for a subtree by setting the LOGGING
  1693. property to one or more of these keywords.
  1694. When bulk-refiling from the agenda, the value `note' is forbidden and
  1695. will temporarily be changed to `time'."
  1696. :group 'org-refile
  1697. :group 'org-progress
  1698. :version "24.1"
  1699. :type '(choice
  1700. (const :tag "No logging" nil)
  1701. (const :tag "Record timestamp" time)
  1702. (const :tag "Record timestamp with note." note)))
  1703. (defcustom org-refile-targets nil
  1704. "Targets for refiling entries with \\[org-refile].
  1705. This is a list of cons cells. Each cell contains:
  1706. - a specification of the files to be considered, either a list of files,
  1707. or a symbol whose function or variable value will be used to retrieve
  1708. a file name or a list of file names. If you use `org-agenda-files' for
  1709. that, all agenda files will be scanned for targets. Nil means consider
  1710. headings in the current buffer.
  1711. - A specification of how to find candidate refile targets. This may be
  1712. any of:
  1713. - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
  1714. This tag has to be present in all target headlines, inheritance will
  1715. not be considered.
  1716. - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
  1717. todo keyword.
  1718. - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
  1719. headlines that are refiling targets.
  1720. - a cons cell (:level . N). Any headline of level N is considered a target.
  1721. Note that, when `org-odd-levels-only' is set, level corresponds to
  1722. order in hierarchy, not to the number of stars.
  1723. - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
  1724. Note that, when `org-odd-levels-only' is set, level corresponds to
  1725. order in hierarchy, not to the number of stars.
  1726. Each element of this list generates a set of possible targets.
  1727. The union of these sets is presented (with completion) to
  1728. the user by `org-refile'.
  1729. You can set the variable `org-refile-target-verify-function' to a function
  1730. to verify each headline found by the simple criteria above.
  1731. When this variable is nil, all top-level headlines in the current buffer
  1732. are used, equivalent to the value `((nil . (:level . 1))'."
  1733. :group 'org-refile
  1734. :type '(repeat
  1735. (cons
  1736. (choice :value org-agenda-files
  1737. (const :tag "All agenda files" org-agenda-files)
  1738. (const :tag "Current buffer" nil)
  1739. (function) (variable) (file))
  1740. (choice :tag "Identify target headline by"
  1741. (cons :tag "Specific tag" (const :value :tag) (string))
  1742. (cons :tag "TODO keyword" (const :value :todo) (string))
  1743. (cons :tag "Regular expression" (const :value :regexp) (regexp))
  1744. (cons :tag "Level number" (const :value :level) (integer))
  1745. (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
  1746. (defcustom org-refile-target-verify-function nil
  1747. "Function to verify if the headline at point should be a refile target.
  1748. The function will be called without arguments, with point at the
  1749. beginning of the headline. It should return t and leave point
  1750. where it is if the headline is a valid target for refiling.
  1751. If the target should not be selected, the function must return nil.
  1752. In addition to this, it may move point to a place from where the search
  1753. should be continued. For example, the function may decide that the entire
  1754. subtree of the current entry should be excluded and move point to the end
  1755. of the subtree."
  1756. :group 'org-refile
  1757. :type 'function)
  1758. (defcustom org-refile-use-cache nil
  1759. "Non-nil means cache refile targets to speed up the process.
  1760. The cache for a particular file will be updated automatically when
  1761. the buffer has been killed, or when any of the marker used for flagging
  1762. refile targets no longer points at a live buffer.
  1763. If you have added new entries to a buffer that might themselves be targets,
  1764. you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
  1765. find that easier, `C-u C-u C-u C-c C-w'."
  1766. :group 'org-refile
  1767. :version "24.1"
  1768. :type 'boolean)
  1769. (defcustom org-refile-use-outline-path nil
  1770. "Non-nil means provide refile targets as paths.
  1771. So a level 3 headline will be available as level1/level2/level3.
  1772. When the value is `file', also include the file name (without directory)
  1773. into the path. In this case, you can also stop the completion after
  1774. the file name, to get entries inserted as top level in the file.
  1775. When `full-file-path', include the full file path."
  1776. :group 'org-refile
  1777. :type '(choice
  1778. (const :tag "Not" nil)
  1779. (const :tag "Yes" t)
  1780. (const :tag "Start with file name" file)
  1781. (const :tag "Start with full file path" full-file-path)))
  1782. (defcustom org-outline-path-complete-in-steps t
  1783. "Non-nil means complete the outline path in hierarchical steps.
  1784. When Org-mode uses the refile interface to select an outline path
  1785. \(see variable `org-refile-use-outline-path'), the completion of
  1786. the path can be done is a single go, or if can be done in steps down
  1787. the headline hierarchy. Going in steps is probably the best if you
  1788. do not use a special completion package like `ido' or `icicles'.
  1789. However, when using these packages, going in one step can be very
  1790. fast, while still showing the whole path to the entry."
  1791. :group 'org-refile
  1792. :type 'boolean)
  1793. (defcustom org-refile-allow-creating-parent-nodes nil
  1794. "Non-nil means allow to create new nodes as refile targets.
  1795. New nodes are then created by adding \"/new node name\" to the completion
  1796. of an existing node. When the value of this variable is `confirm',
  1797. new node creation must be confirmed by the user (recommended)
  1798. When nil, the completion must match an existing entry.
  1799. Note that, if the new heading is not seen by the criteria
  1800. listed in `org-refile-targets', multiple instances of the same
  1801. heading would be created by trying again to file under the new
  1802. heading."
  1803. :group 'org-refile
  1804. :type '(choice
  1805. (const :tag "Never" nil)
  1806. (const :tag "Always" t)
  1807. (const :tag "Prompt for confirmation" confirm)))
  1808. (defcustom org-refile-active-region-within-subtree nil
  1809. "Non-nil means also refile active region within a subtree.
  1810. By default `org-refile' doesn't allow refiling regions if they
  1811. don't contain a set of subtrees, but it might be convenient to
  1812. do so sometimes: in that case, the first line of the region is
  1813. converted to a headline before refiling."
  1814. :group 'org-refile
  1815. :version "24.1"
  1816. :type 'boolean)
  1817. (defgroup org-todo nil
  1818. "Options concerning TODO items in Org-mode."
  1819. :tag "Org TODO"
  1820. :group 'org)
  1821. (defgroup org-progress nil
  1822. "Options concerning Progress logging in Org-mode."
  1823. :tag "Org Progress"
  1824. :group 'org-time)
  1825. (defvar org-todo-interpretation-widgets
  1826. '((:tag "Sequence (cycling hits every state)" sequence)
  1827. (:tag "Type (cycling directly to DONE)" type))
  1828. "The available interpretation symbols for customizing `org-todo-keywords'.
  1829. Interested libraries should add to this list.")
  1830. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  1831. "List of TODO entry keyword sequences and their interpretation.
  1832. \\<org-mode-map>This is a list of sequences.
  1833. Each sequence starts with a symbol, either `sequence' or `type',
  1834. indicating if the keywords should be interpreted as a sequence of
  1835. action steps, or as different types of TODO items. The first
  1836. keywords are states requiring action - these states will select a headline
  1837. for inclusion into the global TODO list Org-mode produces. If one of
  1838. the \"keywords\" is the vertical bar, \"|\", the remaining keywords
  1839. signify that no further action is necessary. If \"|\" is not found,
  1840. the last keyword is treated as the only DONE state of the sequence.
  1841. The command \\[org-todo] cycles an entry through these states, and one
  1842. additional state where no keyword is present. For details about this
  1843. cycling, see the manual.
  1844. TODO keywords and interpretation can also be set on a per-file basis with
  1845. the special #+SEQ_TODO and #+TYP_TODO lines.
  1846. Each keyword can optionally specify a character for fast state selection
  1847. \(in combination with the variable `org-use-fast-todo-selection')
  1848. and specifiers for state change logging, using the same syntax
  1849. that is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says
  1850. that the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
  1851. indicates to record a time stamp each time this state is selected.
  1852. Each keyword may also specify if a timestamp or a note should be
  1853. recorded when entering or leaving the state, by adding additional
  1854. characters in the parenthesis after the keyword. This looks like this:
  1855. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  1856. record only the time of the state change. With X and Y being either
  1857. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  1858. Y when leaving the state if and only if the *target* state does not
  1859. define X. You may omit any of the fast-selection key or X or /Y,
  1860. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  1861. For backward compatibility, this variable may also be just a list
  1862. of keywords - in this case the interpretation (sequence or type) will be
  1863. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  1864. :group 'org-todo
  1865. :group 'org-keywords
  1866. :type '(choice
  1867. (repeat :tag "Old syntax, just keywords"
  1868. (string :tag "Keyword"))
  1869. (repeat :tag "New syntax"
  1870. (cons
  1871. (choice
  1872. :tag "Interpretation"
  1873. ;;Quick and dirty way to see
  1874. ;;`org-todo-interpretations'. This takes the
  1875. ;;place of item arguments
  1876. :convert-widget
  1877. (lambda (widget)
  1878. (widget-put widget
  1879. :args (mapcar
  1880. #'(lambda (x)
  1881. (widget-convert
  1882. (cons 'const x)))
  1883. org-todo-interpretation-widgets))
  1884. widget))
  1885. (repeat
  1886. (string :tag "Keyword"))))))
  1887. (defvar org-todo-keywords-1 nil
  1888. "All TODO and DONE keywords active in a buffer.")
  1889. (make-variable-buffer-local 'org-todo-keywords-1)
  1890. (defvar org-todo-keywords-for-agenda nil)
  1891. (defvar org-done-keywords-for-agenda nil)
  1892. (defvar org-drawers-for-agenda nil)
  1893. (defvar org-todo-keyword-alist-for-agenda nil)
  1894. (defvar org-tag-alist-for-agenda nil)
  1895. (defvar org-agenda-contributing-files nil)
  1896. (defvar org-not-done-keywords nil)
  1897. (make-variable-buffer-local 'org-not-done-keywords)
  1898. (defvar org-done-keywords nil)
  1899. (make-variable-buffer-local 'org-done-keywords)
  1900. (defvar org-todo-heads nil)
  1901. (make-variable-buffer-local 'org-todo-heads)
  1902. (defvar org-todo-sets nil)
  1903. (make-variable-buffer-local 'org-todo-sets)
  1904. (defvar org-todo-log-states nil)
  1905. (make-variable-buffer-local 'org-todo-log-states)
  1906. (defvar org-todo-kwd-alist nil)
  1907. (make-variable-buffer-local 'org-todo-kwd-alist)
  1908. (defvar org-todo-key-alist nil)
  1909. (make-variable-buffer-local 'org-todo-key-alist)
  1910. (defvar org-todo-key-trigger nil)
  1911. (make-variable-buffer-local 'org-todo-key-trigger)
  1912. (defcustom org-todo-interpretation 'sequence
  1913. "Controls how TODO keywords are interpreted.
  1914. This variable is in principle obsolete and is only used for
  1915. backward compatibility, if the interpretation of todo keywords is
  1916. not given already in `org-todo-keywords'. See that variable for
  1917. more information."
  1918. :group 'org-todo
  1919. :group 'org-keywords
  1920. :type '(choice (const sequence)
  1921. (const type)))
  1922. (defcustom org-use-fast-todo-selection t
  1923. "Non-nil means use the fast todo selection scheme with C-c C-t.
  1924. This variable describes if and under what circumstances the cycling
  1925. mechanism for TODO keywords will be replaced by a single-key, direct
  1926. selection scheme.
  1927. When nil, fast selection is never used.
  1928. When the symbol `prefix', it will be used when `org-todo' is called with
  1929. a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
  1930. in an agenda buffer.
  1931. When t, fast selection is used by default. In this case, the prefix
  1932. argument forces cycling instead.
  1933. In all cases, the special interface is only used if access keys have actually
  1934. been assigned by the user, i.e. if keywords in the configuration are followed
  1935. by a letter in parenthesis, like TODO(t)."
  1936. :group 'org-todo
  1937. :type '(choice
  1938. (const :tag "Never" nil)
  1939. (const :tag "By default" t)
  1940. (const :tag "Only with C-u C-c C-t" prefix)))
  1941. (defcustom org-provide-todo-statistics t
  1942. "Non-nil means update todo statistics after insert and toggle.
  1943. ALL-HEADLINES means update todo statistics by including headlines
  1944. with no TODO keyword as well, counting them as not done.
  1945. A list of TODO keywords means the same, but skip keywords that are
  1946. not in this list.
  1947. When this is set, todo statistics is updated in the parent of the
  1948. current entry each time a todo state is changed."
  1949. :group 'org-todo
  1950. :type '(choice
  1951. (const :tag "Yes, only for TODO entries" t)
  1952. (const :tag "Yes, including all entries" 'all-headlines)
  1953. (repeat :tag "Yes, for TODOs in this list"
  1954. (string :tag "TODO keyword"))
  1955. (other :tag "No TODO statistics" nil)))
  1956. (defcustom org-hierarchical-todo-statistics t
  1957. "Non-nil means TODO statistics covers just direct children.
  1958. When nil, all entries in the subtree are considered.
  1959. This has only an effect if `org-provide-todo-statistics' is set.
  1960. To set this to nil for only a single subtree, use a COOKIE_DATA
  1961. property and include the word \"recursive\" into the value."
  1962. :group 'org-todo
  1963. :type 'boolean)
  1964. (defcustom org-after-todo-state-change-hook nil
  1965. "Hook which is run after the state of a TODO item was changed.
  1966. The new state (a string with a TODO keyword, or nil) is available in the
  1967. Lisp variable `org-state'."
  1968. :group 'org-todo
  1969. :type 'hook)
  1970. (defvar org-blocker-hook nil
  1971. "Hook for functions that are allowed to block a state change.
  1972. Each function gets as its single argument a property list, see
  1973. `org-trigger-hook' for more information about this list.
  1974. If any of the functions in this hook returns nil, the state change
  1975. is blocked.")
  1976. (defvar org-trigger-hook nil
  1977. "Hook for functions that are triggered by a state change.
  1978. Each function gets as its single argument a property list with at least
  1979. the following elements:
  1980. (:type type-of-change :position pos-at-entry-start
  1981. :from old-state :to new-state)
  1982. Depending on the type, more properties may be present.
  1983. This mechanism is currently implemented for:
  1984. TODO state changes
  1985. ------------------
  1986. :type todo-state-change
  1987. :from previous state (keyword as a string), or nil, or a symbol
  1988. 'todo' or 'done', to indicate the general type of state.
  1989. :to new state, like in :from")
  1990. (defcustom org-enforce-todo-dependencies nil
  1991. "Non-nil means undone TODO entries will block switching the parent to DONE.
  1992. Also, if a parent has an :ORDERED: property, switching an entry to DONE will
  1993. be blocked if any prior sibling is not yet done.
  1994. Finally, if the parent is blocked because of ordered siblings of its own,
  1995. the child will also be blocked."
  1996. :set (lambda (var val)
  1997. (set var val)
  1998. (if val
  1999. (add-hook 'org-blocker-hook
  2000. 'org-block-todo-from-children-or-siblings-or-parent)
  2001. (remove-hook 'org-blocker-hook
  2002. 'org-block-todo-from-children-or-siblings-or-parent)))
  2003. :group 'org-todo
  2004. :type 'boolean)
  2005. (defcustom org-enforce-todo-checkbox-dependencies nil
  2006. "Non-nil means unchecked boxes will block switching the parent to DONE.
  2007. When this is nil, checkboxes have no influence on switching TODO states.
  2008. When non-nil, you first need to check off all check boxes before the TODO
  2009. entry can be switched to DONE.
  2010. This variable needs to be set before org.el is loaded, and you need to
  2011. restart Emacs after a change to make the change effective. The only way
  2012. to change is while Emacs is running is through the customize interface."
  2013. :set (lambda (var val)
  2014. (set var val)
  2015. (if val
  2016. (add-hook 'org-blocker-hook
  2017. 'org-block-todo-from-checkboxes)
  2018. (remove-hook 'org-blocker-hook
  2019. 'org-block-todo-from-checkboxes)))
  2020. :group 'org-todo
  2021. :type 'boolean)
  2022. (defcustom org-treat-insert-todo-heading-as-state-change nil
  2023. "Non-nil means inserting a TODO heading is treated as state change.
  2024. So when the command \\[org-insert-todo-heading] is used, state change
  2025. logging will apply if appropriate. When nil, the new TODO item will
  2026. be inserted directly, and no logging will take place."
  2027. :group 'org-todo
  2028. :type 'boolean)
  2029. (defcustom org-treat-S-cursor-todo-selection-as-state-change t
  2030. "Non-nil means switching TODO states with S-cursor counts as state change.
  2031. This is the default behavior. However, setting this to nil allows a
  2032. convenient way to select a TODO state and bypass any logging associated
  2033. with that."
  2034. :group 'org-todo
  2035. :type 'boolean)
  2036. (defcustom org-todo-state-tags-triggers nil
  2037. "Tag changes that should be triggered by TODO state changes.
  2038. This is a list. Each entry is
  2039. (state-change (tag . flag) .......)
  2040. State-change can be a string with a state, and empty string to indicate the
  2041. state that has no TODO keyword, or it can be one of the symbols `todo'
  2042. or `done', meaning any not-done or done state, respectively."
  2043. :group 'org-todo
  2044. :group 'org-tags
  2045. :type '(repeat
  2046. (cons (choice :tag "When changing to"
  2047. (const :tag "Not-done state" todo)
  2048. (const :tag "Done state" done)
  2049. (string :tag "State"))
  2050. (repeat
  2051. (cons :tag "Tag action"
  2052. (string :tag "Tag")
  2053. (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
  2054. (defcustom org-log-done nil
  2055. "Information to record when a task moves to the DONE state.
  2056. Possible values are:
  2057. nil Don't add anything, just change the keyword
  2058. time Add a time stamp to the task
  2059. note Prompt for a note and add it with template `org-log-note-headings'
  2060. This option can also be set with on a per-file-basis with
  2061. #+STARTUP: nologdone
  2062. #+STARTUP: logdone
  2063. #+STARTUP: lognotedone
  2064. You can have local logging settings for a subtree by setting the LOGGING
  2065. property to one or more of these keywords."
  2066. :group 'org-todo
  2067. :group 'org-progress
  2068. :type '(choice
  2069. (const :tag "No logging" nil)
  2070. (const :tag "Record CLOSED timestamp" time)
  2071. (const :tag "Record CLOSED timestamp with note." note)))
  2072. ;; Normalize old uses of org-log-done.
  2073. (cond
  2074. ((eq org-log-done t) (setq org-log-done 'time))
  2075. ((and (listp org-log-done) (memq 'done org-log-done))
  2076. (setq org-log-done 'note)))
  2077. (defcustom org-log-reschedule nil
  2078. "Information to record when the scheduling date of a tasks is modified.
  2079. Possible values are:
  2080. nil Don't add anything, just change the date
  2081. time Add a time stamp to the task
  2082. note Prompt for a note and add it with template `org-log-note-headings'
  2083. This option can also be set with on a per-file-basis with
  2084. #+STARTUP: nologreschedule
  2085. #+STARTUP: logreschedule
  2086. #+STARTUP: lognotereschedule"
  2087. :group 'org-todo
  2088. :group 'org-progress
  2089. :type '(choice
  2090. (const :tag "No logging" nil)
  2091. (const :tag "Record timestamp" time)
  2092. (const :tag "Record timestamp with note." note)))
  2093. (defcustom org-log-redeadline nil
  2094. "Information to record when the deadline date of a tasks is modified.
  2095. Possible values are:
  2096. nil Don't add anything, just change the date
  2097. time Add a time stamp to the task
  2098. note Prompt for a note and add it with template `org-log-note-headings'
  2099. This option can also be set with on a per-file-basis with
  2100. #+STARTUP: nologredeadline
  2101. #+STARTUP: logredeadline
  2102. #+STARTUP: lognoteredeadline
  2103. You can have local logging settings for a subtree by setting the LOGGING
  2104. property to one or more of these keywords."
  2105. :group 'org-todo
  2106. :group 'org-progress
  2107. :type '(choice
  2108. (const :tag "No logging" nil)
  2109. (const :tag "Record timestamp" time)
  2110. (const :tag "Record timestamp with note." note)))
  2111. (defcustom org-log-note-clock-out nil
  2112. "Non-nil means record a note when clocking out of an item.
  2113. This can also be configured on a per-file basis by adding one of
  2114. the following lines anywhere in the buffer:
  2115. #+STARTUP: lognoteclock-out
  2116. #+STARTUP: nolognoteclock-out"
  2117. :group 'org-todo
  2118. :group 'org-progress
  2119. :type 'boolean)
  2120. (defcustom org-log-done-with-time t
  2121. "Non-nil means the CLOSED time stamp will contain date and time.
  2122. When nil, only the date will be recorded."
  2123. :group 'org-progress
  2124. :type 'boolean)
  2125. (defcustom org-log-note-headings
  2126. '((done . "CLOSING NOTE %t")
  2127. (state . "State %-12s from %-12S %t")
  2128. (note . "Note taken on %t")
  2129. (reschedule . "Rescheduled from %S on %t")
  2130. (delschedule . "Not scheduled, was %S on %t")
  2131. (redeadline . "New deadline from %S on %t")
  2132. (deldeadline . "Removed deadline, was %S on %t")
  2133. (refile . "Refiled on %t")
  2134. (clock-out . ""))
  2135. "Headings for notes added to entries.
  2136. The value is an alist, with the car being a symbol indicating the note
  2137. context, and the cdr is the heading to be used. The heading may also be the
  2138. empty string.
  2139. %t in the heading will be replaced by a time stamp.
  2140. %T will be an active time stamp instead the default inactive one
  2141. %d will be replaced by a short-format time stamp.
  2142. %D will be replaced by an active short-format time stamp.
  2143. %s will be replaced by the new TODO state, in double quotes.
  2144. %S will be replaced by the old TODO state, in double quotes.
  2145. %u will be replaced by the user name.
  2146. %U will be replaced by the full user name.
  2147. In fact, it is not a good idea to change the `state' entry, because
  2148. agenda log mode depends on the format of these entries."
  2149. :group 'org-todo
  2150. :group 'org-progress
  2151. :type '(list :greedy t
  2152. (cons (const :tag "Heading when closing an item" done) string)
  2153. (cons (const :tag
  2154. "Heading when changing todo state (todo sequence only)"
  2155. state) string)
  2156. (cons (const :tag "Heading when just taking a note" note) string)
  2157. (cons (const :tag "Heading when clocking out" clock-out) string)
  2158. (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
  2159. (cons (const :tag "Heading when rescheduling" reschedule) string)
  2160. (cons (const :tag "Heading when changing deadline" redeadline) string)
  2161. (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
  2162. (cons (const :tag "Heading when refiling" refile) string)))
  2163. (unless (assq 'note org-log-note-headings)
  2164. (push '(note . "%t") org-log-note-headings))
  2165. (defcustom org-log-into-drawer nil
  2166. "Non-nil means insert state change notes and time stamps into a drawer.
  2167. When nil, state changes notes will be inserted after the headline and
  2168. any scheduling and clock lines, but not inside a drawer.
  2169. The value of this variable should be the name of the drawer to use.
  2170. LOGBOOK is proposed as the default drawer for this purpose, you can
  2171. also set this to a string to define the drawer of your choice.
  2172. A value of t is also allowed, representing \"LOGBOOK\".
  2173. If this variable is set, `org-log-state-notes-insert-after-drawers'
  2174. will be ignored.
  2175. You can set the property LOG_INTO_DRAWER to overrule this setting for
  2176. a subtree."
  2177. :group 'org-todo
  2178. :group 'org-progress
  2179. :type '(choice
  2180. (const :tag "Not into a drawer" nil)
  2181. (const :tag "LOGBOOK" t)
  2182. (string :tag "Other")))
  2183. (if (fboundp 'defvaralias)
  2184. (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer))
  2185. (defun org-log-into-drawer ()
  2186. "Return the value of `org-log-into-drawer', but let properties overrule.
  2187. If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
  2188. used instead of the default value."
  2189. (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
  2190. (cond
  2191. ((or (not p) (equal p "nil")) org-log-into-drawer)
  2192. ((equal p "t") "LOGBOOK")
  2193. (t p))))
  2194. (defcustom org-log-state-notes-insert-after-drawers nil
  2195. "Non-nil means insert state change notes after any drawers in entry.
  2196. Only the drawers that *immediately* follow the headline and the
  2197. deadline/scheduled line are skipped.
  2198. When nil, insert notes right after the heading and perhaps the line
  2199. with deadline/scheduling if present.
  2200. This variable will have no effect if `org-log-into-drawer' is
  2201. set."
  2202. :group 'org-todo
  2203. :group 'org-progress
  2204. :type 'boolean)
  2205. (defcustom org-log-states-order-reversed t
  2206. "Non-nil means the latest state note will be directly after heading.
  2207. When nil, the state change notes will be ordered according to time."
  2208. :group 'org-todo
  2209. :group 'org-progress
  2210. :type 'boolean)
  2211. (defcustom org-todo-repeat-to-state nil
  2212. "The TODO state to which a repeater should return the repeating task.
  2213. By default this is the first task in a TODO sequence, or the previous state
  2214. in a TODO_TYP set. But you can specify another task here.
  2215. alternatively, set the :REPEAT_TO_STATE: property of the entry."
  2216. :group 'org-todo
  2217. :version "24.1"
  2218. :type '(choice (const :tag "Head of sequence" nil)
  2219. (string :tag "Specific state")))
  2220. (defcustom org-log-repeat 'time
  2221. "Non-nil means record moving through the DONE state when triggering repeat.
  2222. An auto-repeating task is immediately switched back to TODO when
  2223. marked DONE. If you are not logging state changes (by adding \"@\"
  2224. or \"!\" to the TODO keyword definition), or set `org-log-done' to
  2225. record a closing note, there will be no record of the task moving
  2226. through DONE. This variable forces taking a note anyway.
  2227. nil Don't force a record
  2228. time Record a time stamp
  2229. note Record a note
  2230. This option can also be set with on a per-file-basis with
  2231. #+STARTUP: logrepeat
  2232. #+STARTUP: lognoterepeat
  2233. #+STARTUP: nologrepeat
  2234. You can have local logging settings for a subtree by setting the LOGGING
  2235. property to one or more of these keywords."
  2236. :group 'org-todo
  2237. :group 'org-progress
  2238. :type '(choice
  2239. (const :tag "Don't force a record" nil)
  2240. (const :tag "Force recording the DONE state" time)
  2241. (const :tag "Force recording a note with the DONE state" note)))
  2242. (defgroup org-priorities nil
  2243. "Priorities in Org-mode."
  2244. :tag "Org Priorities"
  2245. :group 'org-todo)
  2246. (defcustom org-enable-priority-commands t
  2247. "Non-nil means priority commands are active.
  2248. When nil, these commands will be disabled, so that you never accidentally
  2249. set a priority."
  2250. :group 'org-priorities
  2251. :type 'boolean)
  2252. (defcustom org-highest-priority ?A
  2253. "The highest priority of TODO items. A character like ?A, ?B etc.
  2254. Must have a smaller ASCII number than `org-lowest-priority'."
  2255. :group 'org-priorities
  2256. :type 'character)
  2257. (defcustom org-lowest-priority ?C
  2258. "The lowest priority of TODO items. A character like ?A, ?B etc.
  2259. Must have a larger ASCII number than `org-highest-priority'."
  2260. :group 'org-priorities
  2261. :type 'character)
  2262. (defcustom org-default-priority ?B
  2263. "The default priority of TODO items.
  2264. This is the priority an item gets if no explicit priority is given.
  2265. When starting to cycle on an empty priority the first step in the cycle
  2266. depends on `org-priority-start-cycle-with-default'. The resulting first
  2267. step priority must not exceed the range from `org-highest-priority' to
  2268. `org-lowest-priority' which means that `org-default-priority' has to be
  2269. in this range exclusive or inclusive the range boundaries. Else the
  2270. first step refuses to set the default and the second will fall back
  2271. to (depending on the command used) the highest or lowest priority."
  2272. :group 'org-priorities
  2273. :type 'character)
  2274. (defcustom org-priority-start-cycle-with-default t
  2275. "Non-nil means start with default priority when starting to cycle.
  2276. When this is nil, the first step in the cycle will be (depending on the
  2277. command used) one higher or lower than the default priority.
  2278. See also `org-default-priority'."
  2279. :group 'org-priorities
  2280. :type 'boolean)
  2281. (defcustom org-get-priority-function nil
  2282. "Function to extract the priority from a string.
  2283. The string is normally the headline. If this is nil Org computes the
  2284. priority from the priority cookie like [#A] in the headline. It returns
  2285. an integer, increasing by 1000 for each priority level.
  2286. The user can set a different function here, which should take a string
  2287. as an argument and return the numeric priority."
  2288. :group 'org-priorities
  2289. :version "24.1"
  2290. :type 'function)
  2291. (defgroup org-time nil
  2292. "Options concerning time stamps and deadlines in Org-mode."
  2293. :tag "Org Time"
  2294. :group 'org)
  2295. (defcustom org-insert-labeled-timestamps-at-point nil
  2296. "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
  2297. When nil, these labeled time stamps are forces into the second line of an
  2298. entry, just after the headline. When scheduling from the global TODO list,
  2299. the time stamp will always be forced into the second line."
  2300. :group 'org-time
  2301. :type 'boolean)
  2302. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  2303. "Formats for `format-time-string' which are used for time stamps.
  2304. It is not recommended to change this constant.")
  2305. (defcustom org-time-stamp-rounding-minutes '(0 5)
  2306. "Number of minutes to round time stamps to.
  2307. These are two values, the first applies when first creating a time stamp.
  2308. The second applies when changing it with the commands `S-up' and `S-down'.
  2309. When changing the time stamp, this means that it will change in steps
  2310. of N minutes, as given by the second value.
  2311. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  2312. numbers should be factors of 60, so for example 5, 10, 15.
  2313. When this is larger than 1, you can still force an exact time stamp by using
  2314. a double prefix argument to a time stamp command like `C-c .' or `C-c !',
  2315. and by using a prefix arg to `S-up/down' to specify the exact number
  2316. of minutes to shift."
  2317. :group 'org-time
  2318. :get #'(lambda (var) ; Make sure both elements are there
  2319. (if (integerp (default-value var))
  2320. (list (default-value var) 5)
  2321. (default-value var)))
  2322. :type '(list
  2323. (integer :tag "when inserting times")
  2324. (integer :tag "when modifying times")))
  2325. ;; Normalize old customizations of this variable.
  2326. (when (integerp org-time-stamp-rounding-minutes)
  2327. (setq org-time-stamp-rounding-minutes
  2328. (list org-time-stamp-rounding-minutes
  2329. org-time-stamp-rounding-minutes)))
  2330. (defcustom org-display-custom-times nil
  2331. "Non-nil means overlay custom formats over all time stamps.
  2332. The formats are defined through the variable `org-time-stamp-custom-formats'.
  2333. To turn this on on a per-file basis, insert anywhere in the file:
  2334. #+STARTUP: customtime"
  2335. :group 'org-time
  2336. :set 'set-default
  2337. :type 'sexp)
  2338. (make-variable-buffer-local 'org-display-custom-times)
  2339. (defcustom org-time-stamp-custom-formats
  2340. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  2341. "Custom formats for time stamps. See `format-time-string' for the syntax.
  2342. These are overlaid over the default ISO format if the variable
  2343. `org-display-custom-times' is set. Time like %H:%M should be at the
  2344. end of the second format. The custom formats are also honored by export
  2345. commands, if custom time display is turned on at the time of export."
  2346. :group 'org-time
  2347. :type 'sexp)
  2348. (defun org-time-stamp-format (&optional long inactive)
  2349. "Get the right format for a time string."
  2350. (let ((f (if long (cdr org-time-stamp-formats)
  2351. (car org-time-stamp-formats))))
  2352. (if inactive
  2353. (concat "[" (substring f 1 -1) "]")
  2354. f)))
  2355. (defcustom org-time-clocksum-format "%d:%02d"
  2356. "The format string used when creating CLOCKSUM lines.
  2357. This is also used when org-mode generates a time duration."
  2358. :group 'org-time
  2359. :type 'string)
  2360. (defcustom org-time-clocksum-use-fractional nil
  2361. "If non-nil, \\[org-clock-display] uses fractional times.
  2362. org-mode generates a time duration."
  2363. :group 'org-time
  2364. :type 'boolean)
  2365. (defcustom org-time-clocksum-fractional-format "%.2f"
  2366. "The format string used when creating CLOCKSUM lines, or when
  2367. org-mode generates a time duration."
  2368. :group 'org-time
  2369. :type 'string)
  2370. (defcustom org-deadline-warning-days 14
  2371. "No. of days before expiration during which a deadline becomes active.
  2372. This variable governs the display in sparse trees and in the agenda.
  2373. When 0 or negative, it means use this number (the absolute value of it)
  2374. even if a deadline has a different individual lead time specified.
  2375. Custom commands can set this variable in the options section."
  2376. :group 'org-time
  2377. :group 'org-agenda-daily/weekly
  2378. :type 'integer)
  2379. (defcustom org-read-date-prefer-future t
  2380. "Non-nil means assume future for incomplete date input from user.
  2381. This affects the following situations:
  2382. 1. The user gives a month but not a year.
  2383. For example, if it is April and you enter \"feb 2\", this will be read
  2384. as Feb 2, *next* year. \"May 5\", however, will be this year.
  2385. 2. The user gives a day, but no month.
  2386. For example, if today is the 15th, and you enter \"3\", Org-mode will
  2387. read this as the third of *next* month. However, if you enter \"17\",
  2388. it will be considered as *this* month.
  2389. If you set this variable to the symbol `time', then also the following
  2390. will work:
  2391. 3. If the user gives a time, but no day. If the time is before now,
  2392. to will be interpreted as tomorrow.
  2393. Currently none of this works for ISO week specifications.
  2394. When this option is nil, the current day, month and year will always be
  2395. used as defaults.
  2396. See also `org-agenda-jump-prefer-future'."
  2397. :group 'org-time
  2398. :type '(choice
  2399. (const :tag "Never" nil)
  2400. (const :tag "Check month and day" t)
  2401. (const :tag "Check month, day, and time" time)))
  2402. (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
  2403. "Should the agenda jump command prefer the future for incomplete dates?
  2404. The default is to do the same as configured in `org-read-date-prefer-future'.
  2405. But you can also set a deviating value here.
  2406. This may t or nil, or the symbol `org-read-date-prefer-future'."
  2407. :group 'org-agenda
  2408. :group 'org-time
  2409. :version "24.1"
  2410. :type '(choice
  2411. (const :tag "Use org-read-date-prefer-future"
  2412. org-read-date-prefer-future)
  2413. (const :tag "Never" nil)
  2414. (const :tag "Always" t)))
  2415. (defcustom org-read-date-force-compatible-dates t
  2416. "Should date/time prompt force dates that are guaranteed to work in Emacs?
  2417. Depending on the system Emacs is running on, certain dates cannot
  2418. be represented with the type used internally to represent time.
  2419. Dates between 1970-1-1 and 2038-1-1 can always be represented
  2420. correctly. Some systems allow for earlier dates, some for later,
  2421. some for both. One way to find out it to insert any date into an
  2422. Org buffer, putting the cursor on the year and hitting S-up and
  2423. S-down to test the range.
  2424. When this variable is set to t, the date/time prompt will not let
  2425. you specify dates outside the 1970-2037 range, so it is certain that
  2426. these dates will work in whatever version of Emacs you are
  2427. running, and also that you can move a file from one Emacs implementation
  2428. to another. WHenever Org is forcing the year for you, it will display
  2429. a message and beep.
  2430. When this variable is nil, Org will check if the date is
  2431. representable in the specific Emacs implementation you are using.
  2432. If not, it will force a year, usually the current year, and beep
  2433. to remind you. Currently this setting is not recommended because
  2434. the likelihood that you will open your Org files in an Emacs that
  2435. has limited date range is not negligible.
  2436. A workaround for this problem is to use diary sexp dates for time
  2437. stamps outside of this range."
  2438. :group 'org-time
  2439. :version "24.1"
  2440. :type 'boolean)
  2441. (defcustom org-read-date-display-live t
  2442. "Non-nil means display current interpretation of date prompt live.
  2443. This display will be in an overlay, in the minibuffer."
  2444. :group 'org-time
  2445. :type 'boolean)
  2446. (defcustom org-read-date-popup-calendar t
  2447. "Non-nil means pop up a calendar when prompting for a date.
  2448. In the calendar, the date can be selected with mouse-1. However, the
  2449. minibuffer will also be active, and you can simply enter the date as well.
  2450. When nil, only the minibuffer will be available."
  2451. :group 'org-time
  2452. :type 'boolean)
  2453. (if (fboundp 'defvaralias)
  2454. (defvaralias 'org-popup-calendar-for-date-prompt
  2455. 'org-read-date-popup-calendar))
  2456. (defcustom org-read-date-minibuffer-setup-hook nil
  2457. "Hook to be used to set up keys for the date/time interface.
  2458. Add key definitions to `minibuffer-local-map', which will be a temporary
  2459. copy."
  2460. :group 'org-time
  2461. :type 'hook)
  2462. (defcustom org-extend-today-until 0
  2463. "The hour when your day really ends. Must be an integer.
  2464. This has influence for the following applications:
  2465. - When switching the agenda to \"today\". It it is still earlier than
  2466. the time given here, the day recognized as TODAY is actually yesterday.
  2467. - When a date is read from the user and it is still before the time given
  2468. here, the current date and time will be assumed to be yesterday, 23:59.
  2469. Also, timestamps inserted in remember templates follow this rule.
  2470. IMPORTANT: This is a feature whose implementation is and likely will
  2471. remain incomplete. Really, it is only here because past midnight seems to
  2472. be the favorite working time of John Wiegley :-)"
  2473. :group 'org-time
  2474. :type 'integer)
  2475. (defcustom org-use-effective-time nil
  2476. "If non-nil, consider `org-extend-today-until' when creating timestamps.
  2477. For example, if `org-extend-today-until' is 8, and it's 4am, then the
  2478. \"effective time\" of any timestamps between midnight and 8am will be
  2479. 23:59 of the previous day."
  2480. :group 'org-time
  2481. :version "24.1"
  2482. :type 'boolean)
  2483. (defcustom org-edit-timestamp-down-means-later nil
  2484. "Non-nil means S-down will increase the time in a time stamp.
  2485. When nil, S-up will increase."
  2486. :group 'org-time
  2487. :type 'boolean)
  2488. (defcustom org-calendar-follow-timestamp-change t
  2489. "Non-nil means make the calendar window follow timestamp changes.
  2490. When a timestamp is modified and the calendar window is visible, it will be
  2491. moved to the new date."
  2492. :group 'org-time
  2493. :type 'boolean)
  2494. (defgroup org-tags nil
  2495. "Options concerning tags in Org-mode."
  2496. :tag "Org Tags"
  2497. :group 'org)
  2498. (defcustom org-tag-alist nil
  2499. "List of tags allowed in Org-mode files.
  2500. When this list is nil, Org-mode will base TAG input on what is already in the
  2501. buffer.
  2502. The value of this variable is an alist, the car of each entry must be a
  2503. keyword as a string, the cdr may be a character that is used to select
  2504. that tag through the fast-tag-selection interface.
  2505. See the manual for details."
  2506. :group 'org-tags
  2507. :type '(repeat
  2508. (choice
  2509. (cons (string :tag "Tag name")
  2510. (character :tag "Access char"))
  2511. (list :tag "Start radio group"
  2512. (const :startgroup)
  2513. (option (string :tag "Group description")))
  2514. (list :tag "End radio group"
  2515. (const :endgroup)
  2516. (option (string :tag "Group description")))
  2517. (const :tag "New line" (:newline)))))
  2518. (defcustom org-tag-persistent-alist nil
  2519. "List of tags that will always appear in all Org-mode files.
  2520. This is in addition to any in buffer settings or customizations
  2521. of `org-tag-alist'.
  2522. When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
  2523. The value of this variable is an alist, the car of each entry must be a
  2524. keyword as a string, the cdr may be a character that is used to select
  2525. that tag through the fast-tag-selection interface.
  2526. See the manual for details.
  2527. To disable these tags on a per-file basis, insert anywhere in the file:
  2528. #+STARTUP: noptag"
  2529. :group 'org-tags
  2530. :type '(repeat
  2531. (choice
  2532. (cons (string :tag "Tag name")
  2533. (character :tag "Access char"))
  2534. (const :tag "Start radio group" (:startgroup))
  2535. (const :tag "End radio group" (:endgroup))
  2536. (const :tag "New line" (:newline)))))
  2537. (defcustom org-complete-tags-always-offer-all-agenda-tags nil
  2538. "If non-nil, always offer completion for all tags of all agenda files.
  2539. Instead of customizing this variable directly, you might want to
  2540. set it locally for capture buffers, because there no list of
  2541. tags in that file can be created dynamically (there are none).
  2542. (add-hook 'org-capture-mode-hook
  2543. (lambda ()
  2544. (set (make-local-variable
  2545. 'org-complete-tags-always-offer-all-agenda-tags)
  2546. t)))"
  2547. :group 'org-tags
  2548. :version "24.1"
  2549. :type 'boolean)
  2550. (defvar org-file-tags nil
  2551. "List of tags that can be inherited by all entries in the file.
  2552. The tags will be inherited if the variable `org-use-tag-inheritance'
  2553. says they should be.
  2554. This variable is populated from #+FILETAGS lines.")
  2555. (defcustom org-use-fast-tag-selection 'auto
  2556. "Non-nil means use fast tag selection scheme.
  2557. This is a special interface to select and deselect tags with single keys.
  2558. When nil, fast selection is never used.
  2559. When the symbol `auto', fast selection is used if and only if selection
  2560. characters for tags have been configured, either through the variable
  2561. `org-tag-alist' or through a #+TAGS line in the buffer.
  2562. When t, fast selection is always used and selection keys are assigned
  2563. automatically if necessary."
  2564. :group 'org-tags
  2565. :type '(choice
  2566. (const :tag "Always" t)
  2567. (const :tag "Never" nil)
  2568. (const :tag "When selection characters are configured" 'auto)))
  2569. (defcustom org-fast-tag-selection-single-key nil
  2570. "Non-nil means fast tag selection exits after first change.
  2571. When nil, you have to press RET to exit it.
  2572. During fast tag selection, you can toggle this flag with `C-c'.
  2573. This variable can also have the value `expert'. In this case, the window
  2574. displaying the tags menu is not even shown, until you press C-c again."
  2575. :group 'org-tags
  2576. :type '(choice
  2577. (const :tag "No" nil)
  2578. (const :tag "Yes" t)
  2579. (const :tag "Expert" expert)))
  2580. (defvar org-fast-tag-selection-include-todo nil
  2581. "Non-nil means fast tags selection interface will also offer TODO states.
  2582. This is an undocumented feature, you should not rely on it.")
  2583. (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
  2584. "The column to which tags should be indented in a headline.
  2585. If this number is positive, it specifies the column. If it is negative,
  2586. it means that the tags should be flushright to that column. For example,
  2587. -80 works well for a normal 80 character screen.
  2588. When 0, place tags directly after headline text, with only one space in
  2589. between."
  2590. :group 'org-tags
  2591. :type 'integer)
  2592. (defcustom org-auto-align-tags t
  2593. "Non-nil keeps tags aligned when modifying headlines.
  2594. Some operations (i.e. demoting) change the length of a headline and
  2595. therefore shift the tags around. With this option turned on, after
  2596. each such operation the tags are again aligned to `org-tags-column'."
  2597. :group 'org-tags
  2598. :type 'boolean)
  2599. (defcustom org-use-tag-inheritance t
  2600. "Non-nil means tags in levels apply also for sublevels.
  2601. When nil, only the tags directly given in a specific line apply there.
  2602. This may also be a list of tags that should be inherited, or a regexp that
  2603. matches tags that should be inherited. Additional control is possible
  2604. with the variable `org-tags-exclude-from-inheritance' which gives an
  2605. explicit list of tags to be excluded from inheritance., even if the value of
  2606. `org-use-tag-inheritance' would select it for inheritance.
  2607. If this option is t, a match early-on in a tree can lead to a large
  2608. number of matches in the subtree when constructing the agenda or creating
  2609. a sparse tree. If you only want to see the first match in a tree during
  2610. a search, check out the variable `org-tags-match-list-sublevels'."
  2611. :group 'org-tags
  2612. :type '(choice
  2613. (const :tag "Not" nil)
  2614. (const :tag "Always" t)
  2615. (repeat :tag "Specific tags" (string :tag "Tag"))
  2616. (regexp :tag "Tags matched by regexp")))
  2617. (defcustom org-tags-exclude-from-inheritance nil
  2618. "List of tags that should never be inherited.
  2619. This is a way to exclude a few tags from inheritance. For way to do
  2620. the opposite, to actively allow inheritance for selected tags,
  2621. see the variable `org-use-tag-inheritance'."
  2622. :group 'org-tags
  2623. :type '(repeat (string :tag "Tag")))
  2624. (defun org-tag-inherit-p (tag)
  2625. "Check if TAG is one that should be inherited."
  2626. (cond
  2627. ((member tag org-tags-exclude-from-inheritance) nil)
  2628. ((eq org-use-tag-inheritance t) t)
  2629. ((not org-use-tag-inheritance) nil)
  2630. ((stringp org-use-tag-inheritance)
  2631. (string-match org-use-tag-inheritance tag))
  2632. ((listp org-use-tag-inheritance)
  2633. (member tag org-use-tag-inheritance))
  2634. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  2635. (defcustom org-tags-match-list-sublevels t
  2636. "Non-nil means list also sublevels of headlines matching a search.
  2637. This variable applies to tags/property searches, and also to stuck
  2638. projects because this search is based on a tags match as well.
  2639. When set to the symbol `indented', sublevels are indented with
  2640. leading dots.
  2641. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  2642. the sublevels of a headline matching a tag search often also match
  2643. the same search. Listing all of them can create very long lists.
  2644. Setting this variable to nil causes subtrees of a match to be skipped.
  2645. This variable is semi-obsolete and probably should always be true. It
  2646. is better to limit inheritance to certain tags using the variables
  2647. `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
  2648. :group 'org-tags
  2649. :type '(choice
  2650. (const :tag "No, don't list them" nil)
  2651. (const :tag "Yes, do list them" t)
  2652. (const :tag "List them, indented with leading dots" indented)))
  2653. (defcustom org-tags-sort-function nil
  2654. "When set, tags are sorted using this function as a comparator."
  2655. :group 'org-tags
  2656. :type '(choice
  2657. (const :tag "No sorting" nil)
  2658. (const :tag "Alphabetical" string<)
  2659. (const :tag "Reverse alphabetical" string>)
  2660. (function :tag "Custom function" nil)))
  2661. (defvar org-tags-history nil
  2662. "History of minibuffer reads for tags.")
  2663. (defvar org-last-tags-completion-table nil
  2664. "The last used completion table for tags.")
  2665. (defvar org-after-tags-change-hook nil
  2666. "Hook that is run after the tags in a line have changed.")
  2667. (defgroup org-properties nil
  2668. "Options concerning properties in Org-mode."
  2669. :tag "Org Properties"
  2670. :group 'org)
  2671. (defcustom org-property-format "%-10s %s"
  2672. "How property key/value pairs should be formatted by `indent-line'.
  2673. When `indent-line' hits a property definition, it will format the line
  2674. according to this format, mainly to make sure that the values are
  2675. lined-up with respect to each other."
  2676. :group 'org-properties
  2677. :type 'string)
  2678. (defcustom org-properties-postprocess-alist nil
  2679. "Alist of properties and functions to adjust inserted values.
  2680. Elements of this alist must be of the form
  2681. ([string] [function])
  2682. where [string] must be a property name and [function] must be a
  2683. lambda expression: this lambda expression must take one argument,
  2684. the value to adjust, and return the new value as a string.
  2685. For example, this element will allow the property \"Remaining\"
  2686. to be updated wrt the relation between the \"Effort\" property
  2687. and the clock summary:
  2688. ((\"Remaining\" (lambda(value)
  2689. (let ((clocksum (org-clock-sum-current-item))
  2690. (effort (org-duration-string-to-minutes
  2691. (org-entry-get (point) \"Effort\"))))
  2692. (org-minutes-to-hh:mm-string (- effort clocksum))))))"
  2693. :group 'org-properties
  2694. :version "24.1"
  2695. :type '(alist :key-type (string :tag "Property")
  2696. :value-type (function :tag "Function")))
  2697. (defcustom org-use-property-inheritance nil
  2698. "Non-nil means properties apply also for sublevels.
  2699. This setting is chiefly used during property searches. Turning it on can
  2700. cause significant overhead when doing a search, which is why it is not
  2701. on by default.
  2702. When nil, only the properties directly given in the current entry count.
  2703. When t, every property is inherited. The value may also be a list of
  2704. properties that should have inheritance, or a regular expression matching
  2705. properties that should be inherited.
  2706. However, note that some special properties use inheritance under special
  2707. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  2708. and the properties ending in \"_ALL\" when they are used as descriptor
  2709. for valid values of a property.
  2710. Note for programmers:
  2711. When querying an entry with `org-entry-get', you can control if inheritance
  2712. should be used. By default, `org-entry-get' looks only at the local
  2713. properties. You can request inheritance by setting the inherit argument
  2714. to t (to force inheritance) or to `selective' (to respect the setting
  2715. in this variable)."
  2716. :group 'org-properties
  2717. :type '(choice
  2718. (const :tag "Not" nil)
  2719. (const :tag "Always" t)
  2720. (repeat :tag "Specific properties" (string :tag "Property"))
  2721. (regexp :tag "Properties matched by regexp")))
  2722. (defun org-property-inherit-p (property)
  2723. "Check if PROPERTY is one that should be inherited."
  2724. (cond
  2725. ((eq org-use-property-inheritance t) t)
  2726. ((not org-use-property-inheritance) nil)
  2727. ((stringp org-use-property-inheritance)
  2728. (string-match org-use-property-inheritance property))
  2729. ((listp org-use-property-inheritance)
  2730. (member property org-use-property-inheritance))
  2731. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  2732. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  2733. "The default column format, if no other format has been defined.
  2734. This variable can be set on the per-file basis by inserting a line
  2735. #+COLUMNS: %25ITEM ....."
  2736. :group 'org-properties
  2737. :type 'string)
  2738. (defcustom org-columns-ellipses ".."
  2739. "The ellipses to be used when a field in column view is truncated.
  2740. When this is the empty string, as many characters as possible are shown,
  2741. but then there will be no visual indication that the field has been truncated.
  2742. When this is a string of length N, the last N characters of a truncated
  2743. field are replaced by this string. If the column is narrower than the
  2744. ellipses string, only part of the ellipses string will be shown."
  2745. :group 'org-properties
  2746. :type 'string)
  2747. (defcustom org-columns-modify-value-for-display-function nil
  2748. "Function that modifies values for display in column view.
  2749. For example, it can be used to cut out a certain part from a time stamp.
  2750. The function must take 2 arguments:
  2751. column-title The title of the column (*not* the property name)
  2752. value The value that should be modified.
  2753. The function should return the value that should be displayed,
  2754. or nil if the normal value should be used."
  2755. :group 'org-properties
  2756. :type 'function)
  2757. (defcustom org-effort-property "Effort"
  2758. "The property that is being used to keep track of effort estimates.
  2759. Effort estimates given in this property need to have the format H:MM."
  2760. :group 'org-properties
  2761. :group 'org-progress
  2762. :type '(string :tag "Property"))
  2763. (defconst org-global-properties-fixed
  2764. '(("VISIBILITY_ALL" . "folded children content all")
  2765. ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
  2766. "List of property/value pairs that can be inherited by any entry.
  2767. These are fixed values, for the preset properties. The user variable
  2768. that can be used to add to this list is `org-global-properties'.
  2769. The entries in this list are cons cells where the car is a property
  2770. name and cdr is a string with the value. If the value represents
  2771. multiple items like an \"_ALL\" property, separate the items by
  2772. spaces.")
  2773. (defcustom org-global-properties nil
  2774. "List of property/value pairs that can be inherited by any entry.
  2775. This list will be combined with the constant `org-global-properties-fixed'.
  2776. The entries in this list are cons cells where the car is a property
  2777. name and cdr is a string with the value.
  2778. You can set buffer-local values for the same purpose in the variable
  2779. `org-file-properties' this by adding lines like
  2780. #+PROPERTY: NAME VALUE"
  2781. :group 'org-properties
  2782. :type '(repeat
  2783. (cons (string :tag "Property")
  2784. (string :tag "Value"))))
  2785. (defvar org-file-properties nil
  2786. "List of property/value pairs that can be inherited by any entry.
  2787. Valid for the current buffer.
  2788. This variable is populated from #+PROPERTY lines.")
  2789. (make-variable-buffer-local 'org-file-properties)
  2790. (defgroup org-agenda nil
  2791. "Options concerning agenda views in Org-mode."
  2792. :tag "Org Agenda"
  2793. :group 'org)
  2794. (defvar org-category nil
  2795. "Variable used by org files to set a category for agenda display.
  2796. Such files should use a file variable to set it, for example
  2797. # -*- mode: org; org-category: \"ELisp\"
  2798. or contain a special line
  2799. #+CATEGORY: ELisp
  2800. If the file does not specify a category, then file's base name
  2801. is used instead.")
  2802. (make-variable-buffer-local 'org-category)
  2803. (put 'org-category 'safe-local-variable #'(lambda (x) (or (symbolp x) (stringp x))))
  2804. (defcustom org-agenda-files nil
  2805. "The files to be used for agenda display.
  2806. Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
  2807. \\[org-remove-file]. You can also use customize to edit the list.
  2808. If an entry is a directory, all files in that directory that are matched by
  2809. `org-agenda-file-regexp' will be part of the file list.
  2810. If the value of the variable is not a list but a single file name, then
  2811. the list of agenda files is actually stored and maintained in that file, one
  2812. agenda file per line. In this file paths can be given relative to
  2813. `org-directory'. Tilde expansion and environment variable substitution
  2814. are also made."
  2815. :group 'org-agenda
  2816. :type '(choice
  2817. (repeat :tag "List of files and directories" file)
  2818. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  2819. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  2820. "Regular expression to match files for `org-agenda-files'.
  2821. If any element in the list in that variable contains a directory instead
  2822. of a normal file, all files in that directory that are matched by this
  2823. regular expression will be included."
  2824. :group 'org-agenda
  2825. :type 'regexp)
  2826. (defcustom org-agenda-text-search-extra-files nil
  2827. "List of extra files to be searched by text search commands.
  2828. These files will be search in addition to the agenda files by the
  2829. commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
  2830. Note that these files will only be searched for text search commands,
  2831. not for the other agenda views like todo lists, tag searches or the weekly
  2832. agenda. This variable is intended to list notes and possibly archive files
  2833. that should also be searched by these two commands.
  2834. In fact, if the first element in the list is the symbol `agenda-archives',
  2835. than all archive files of all agenda files will be added to the search
  2836. scope."
  2837. :group 'org-agenda
  2838. :type '(set :greedy t
  2839. (const :tag "Agenda Archives" agenda-archives)
  2840. (repeat :inline t (file))))
  2841. (if (fboundp 'defvaralias)
  2842. (defvaralias 'org-agenda-multi-occur-extra-files
  2843. 'org-agenda-text-search-extra-files))
  2844. (defcustom org-agenda-skip-unavailable-files nil
  2845. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  2846. A nil value means to remove them, after a query, from the list."
  2847. :group 'org-agenda
  2848. :type 'boolean)
  2849. (defcustom org-calendar-to-agenda-key [?c]
  2850. "The key to be installed in `calendar-mode-map' for switching to the agenda.
  2851. The command `org-calendar-goto-agenda' will be bound to this key. The
  2852. default is the character `c' because then `c' can be used to switch back and
  2853. forth between agenda and calendar."
  2854. :group 'org-agenda
  2855. :type 'sexp)
  2856. (defcustom org-calendar-agenda-action-key [?k]
  2857. "The key to be installed in `calendar-mode-map' for agenda-action.
  2858. The command `org-agenda-action' will be bound to this key. The
  2859. default is the character `k' because we use the same key in the agenda."
  2860. :group 'org-agenda
  2861. :type 'sexp)
  2862. (defcustom org-calendar-insert-diary-entry-key [?i]
  2863. "The key to be installed in `calendar-mode-map' for adding diary entries.
  2864. This option is irrelevant until `org-agenda-diary-file' has been configured
  2865. to point to an Org-mode file. When that is the case, the command
  2866. `org-agenda-diary-entry' will be bound to the key given here, by default
  2867. `i'. In the calendar, `i' normally adds entries to `diary-file'. So
  2868. if you want to continue doing this, you need to change this to a different
  2869. key."
  2870. :group 'org-agenda
  2871. :type 'sexp)
  2872. (defcustom org-agenda-diary-file 'diary-file
  2873. "File to which to add new entries with the `i' key in agenda and calendar.
  2874. When this is the symbol `diary-file', the functionality in the Emacs
  2875. calendar will be used to add entries to the `diary-file'. But when this
  2876. points to a file, `org-agenda-diary-entry' will be used instead."
  2877. :group 'org-agenda
  2878. :type '(choice
  2879. (const :tag "The standard Emacs diary file" diary-file)
  2880. (file :tag "Special Org file diary entries")))
  2881. (eval-after-load "calendar"
  2882. '(progn
  2883. (org-defkey calendar-mode-map org-calendar-to-agenda-key
  2884. 'org-calendar-goto-agenda)
  2885. (org-defkey calendar-mode-map org-calendar-agenda-action-key
  2886. 'org-agenda-action)
  2887. (add-hook 'calendar-mode-hook
  2888. (lambda ()
  2889. (unless (eq org-agenda-diary-file 'diary-file)
  2890. (define-key calendar-mode-map
  2891. org-calendar-insert-diary-entry-key
  2892. 'org-agenda-diary-entry))))))
  2893. (defgroup org-latex nil
  2894. "Options for embedding LaTeX code into Org-mode."
  2895. :tag "Org LaTeX"
  2896. :group 'org)
  2897. (defcustom org-format-latex-options
  2898. '(:foreground default :background default :scale 1.0
  2899. :html-foreground "Black" :html-background "Transparent"
  2900. :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
  2901. "Options for creating images from LaTeX fragments.
  2902. This is a property list with the following properties:
  2903. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  2904. `default' means use the foreground of the default face.
  2905. :background the background color, or \"Transparent\".
  2906. `default' means use the background of the default face.
  2907. :scale a scaling factor for the size of the images, to get more pixels
  2908. :html-foreground, :html-background, :html-scale
  2909. the same numbers for HTML export.
  2910. :matchers a list indicating which matchers should be used to
  2911. find LaTeX fragments. Valid members of this list are:
  2912. \"begin\" find environments
  2913. \"$1\" find single characters surrounded by $.$
  2914. \"$\" find math expressions surrounded by $...$
  2915. \"$$\" find math expressions surrounded by $$....$$
  2916. \"\\(\" find math expressions surrounded by \\(...\\)
  2917. \"\\ [\" find math expressions surrounded by \\ [...\\]"
  2918. :group 'org-latex
  2919. :type 'plist)
  2920. (defcustom org-format-latex-signal-error t
  2921. "Non-nil means signal an error when image creation of LaTeX snippets fails.
  2922. When nil, just push out a message."
  2923. :group 'org-latex
  2924. :version "24.1"
  2925. :type 'boolean)
  2926. (defcustom org-latex-to-mathml-jar-file nil
  2927. "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
  2928. Use this to specify additional executable file say a jar file.
  2929. When using MathToWeb as the converter, specify the full-path to
  2930. your mathtoweb.jar file."
  2931. :group 'org-latex
  2932. :version "24.1"
  2933. :type '(choice
  2934. (const :tag "None" nil)
  2935. (file :tag "JAR file" :must-match t)))
  2936. (defcustom org-latex-to-mathml-convert-command nil
  2937. "Command to convert LaTeX fragments to MathML.
  2938. Replace format-specifiers in the command as noted below and use
  2939. `shell-command' to convert LaTeX to MathML.
  2940. %j: Executable file in fully expanded form as specified by
  2941. `org-latex-to-mathml-jar-file'.
  2942. %I: Input LaTeX file in fully expanded form
  2943. %o: Output MathML file
  2944. This command is used by `org-create-math-formula'.
  2945. When using MathToWeb as the converter, set this to
  2946. \"java -jar %j -unicode -force -df %o %I\"."
  2947. :group 'org-latex
  2948. :version "24.1"
  2949. :type '(choice
  2950. (const :tag "None" nil)
  2951. (string :tag "\nShell command")))
  2952. (defcustom org-latex-create-formula-image-program 'dvipng
  2953. "Program to convert LaTeX fragments with.
  2954. dvipng Process the LaTeX fragments to dvi file, then convert
  2955. dvi files to png files using dvipng.
  2956. This will also include processing of non-math environments.
  2957. imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
  2958. to convert pdf files to png files"
  2959. :group 'org-latex
  2960. :version "24.1"
  2961. :type '(choice
  2962. (const :tag "dvipng" dvipng)
  2963. (const :tag "imagemagick" imagemagick)))
  2964. (defun org-format-latex-mathml-available-p ()
  2965. "Return t if `org-latex-to-mathml-convert-command' is usable."
  2966. (save-match-data
  2967. (when (and (boundp 'org-latex-to-mathml-convert-command)
  2968. org-latex-to-mathml-convert-command)
  2969. (let ((executable (car (split-string
  2970. org-latex-to-mathml-convert-command))))
  2971. (when (executable-find executable)
  2972. (if (string-match
  2973. "%j" org-latex-to-mathml-convert-command)
  2974. (file-readable-p org-latex-to-mathml-jar-file)
  2975. t))))))
  2976. (defcustom org-format-latex-header "\\documentclass{article}
  2977. \\usepackage[usenames]{color}
  2978. \\usepackage{amsmath}
  2979. \\usepackage[mathscr]{eucal}
  2980. \\pagestyle{empty} % do not remove
  2981. \[PACKAGES]
  2982. \[DEFAULT-PACKAGES]
  2983. % The settings below are copied from fullpage.sty
  2984. \\setlength{\\textwidth}{\\paperwidth}
  2985. \\addtolength{\\textwidth}{-3cm}
  2986. \\setlength{\\oddsidemargin}{1.5cm}
  2987. \\addtolength{\\oddsidemargin}{-2.54cm}
  2988. \\setlength{\\evensidemargin}{\\oddsidemargin}
  2989. \\setlength{\\textheight}{\\paperheight}
  2990. \\addtolength{\\textheight}{-\\headheight}
  2991. \\addtolength{\\textheight}{-\\headsep}
  2992. \\addtolength{\\textheight}{-\\footskip}
  2993. \\addtolength{\\textheight}{-3cm}
  2994. \\setlength{\\topmargin}{1.5cm}
  2995. \\addtolength{\\topmargin}{-2.54cm}"
  2996. "The document header used for processing LaTeX fragments.
  2997. It is imperative that this header make sure that no page number
  2998. appears on the page. The package defined in the variables
  2999. `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
  3000. will either replace the placeholder \"[PACKAGES]\" in this header, or they
  3001. will be appended."
  3002. :group 'org-latex
  3003. :type 'string)
  3004. (defvar org-format-latex-header-extra nil)
  3005. (defun org-set-packages-alist (var val)
  3006. "Set the packages alist and make sure it has 3 elements per entry."
  3007. (set var (mapcar (lambda (x)
  3008. (if (and (consp x) (= (length x) 2))
  3009. (list (car x) (nth 1 x) t)
  3010. x))
  3011. val)))
  3012. (defun org-get-packages-alist (var)
  3013. "Get the packages alist and make sure it has 3 elements per entry."
  3014. (mapcar (lambda (x)
  3015. (if (and (consp x) (= (length x) 2))
  3016. (list (car x) (nth 1 x) t)
  3017. x))
  3018. (default-value var)))
  3019. ;; The following variables are defined here because is it also used
  3020. ;; when formatting latex fragments. Originally it was part of the
  3021. ;; LaTeX exporter, which is why the name includes "export".
  3022. (defcustom org-export-latex-default-packages-alist
  3023. '(("AUTO" "inputenc" t)
  3024. ("T1" "fontenc" t)
  3025. ("" "fixltx2e" nil)
  3026. ("" "graphicx" t)
  3027. ("" "longtable" nil)
  3028. ("" "float" nil)
  3029. ("" "wrapfig" nil)
  3030. ("" "soul" t)
  3031. ("" "textcomp" t)
  3032. ("" "marvosym" t)
  3033. ("" "wasysym" t)
  3034. ("" "latexsym" t)
  3035. ("" "amssymb" t)
  3036. ("" "hyperref" nil)
  3037. "\\tolerance=1000"
  3038. )
  3039. "Alist of default packages to be inserted in the header.
  3040. Change this only if one of the packages here causes an incompatibility
  3041. with another package you are using.
  3042. The packages in this list are needed by one part or another of Org-mode
  3043. to function properly.
  3044. - inputenc, fontenc: for basic font and character selection
  3045. - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
  3046. for interpreting the entities in `org-entities'. You can skip some of these
  3047. packages if you don't use any of the symbols in it.
  3048. - graphicx: for including images
  3049. - float, wrapfig: for figure placement
  3050. - longtable: for long tables
  3051. - hyperref: for cross references
  3052. Therefore you should not modify this variable unless you know what you
  3053. are doing. The one reason to change it anyway is that you might be loading
  3054. some other package that conflicts with one of the default packages.
  3055. Each cell is of the format \( \"options\" \"package\" snippet-flag\).
  3056. If SNIPPET-FLAG is t, the package also needs to be included when
  3057. compiling LaTeX snippets into images for inclusion into HTML."
  3058. :group 'org-export-latex
  3059. :set 'org-set-packages-alist
  3060. :get 'org-get-packages-alist
  3061. :version "24.1"
  3062. :type '(repeat
  3063. (choice
  3064. (list :tag "options/package pair"
  3065. (string :tag "options")
  3066. (string :tag "package")
  3067. (boolean :tag "Snippet"))
  3068. (string :tag "A line of LaTeX"))))
  3069. (defcustom org-export-latex-packages-alist nil
  3070. "Alist of packages to be inserted in every LaTeX header.
  3071. These will be inserted after `org-export-latex-default-packages-alist'.
  3072. Each cell is of the format \( \"options\" \"package\" snippet-flag \).
  3073. SNIPPET-FLAG, when t, indicates that this package is also needed when
  3074. turning LaTeX snippets into images for inclusion into HTML.
  3075. Make sure that you only list packages here which:
  3076. - you want in every file
  3077. - do not conflict with the default packages in
  3078. `org-export-latex-default-packages-alist'
  3079. - do not conflict with the setup in `org-format-latex-header'."
  3080. :group 'org-export-latex
  3081. :set 'org-set-packages-alist
  3082. :get 'org-get-packages-alist
  3083. :type '(repeat
  3084. (choice
  3085. (list :tag "options/package pair"
  3086. (string :tag "options")
  3087. (string :tag "package")
  3088. (boolean :tag "Snippet"))
  3089. (string :tag "A line of LaTeX"))))
  3090. (defgroup org-appearance nil
  3091. "Settings for Org-mode appearance."
  3092. :tag "Org Appearance"
  3093. :group 'org)
  3094. (defcustom org-level-color-stars-only nil
  3095. "Non-nil means fontify only the stars in each headline.
  3096. When nil, the entire headline is fontified.
  3097. Changing it requires restart of `font-lock-mode' to become effective
  3098. also in regions already fontified."
  3099. :group 'org-appearance
  3100. :type 'boolean)
  3101. (defcustom org-hide-leading-stars nil
  3102. "Non-nil means hide the first N-1 stars in a headline.
  3103. This works by using the face `org-hide' for these stars. This
  3104. face is white for a light background, and black for a dark
  3105. background. You may have to customize the face `org-hide' to
  3106. make this work.
  3107. Changing it requires restart of `font-lock-mode' to become effective
  3108. also in regions already fontified.
  3109. You may also set this on a per-file basis by adding one of the following
  3110. lines to the buffer:
  3111. #+STARTUP: hidestars
  3112. #+STARTUP: showstars"
  3113. :group 'org-appearance
  3114. :type 'boolean)
  3115. (defcustom org-hidden-keywords nil
  3116. "List of symbols corresponding to keywords to be hidden the org buffer.
  3117. For example, a value '(title) for this list will make the document's title
  3118. appear in the buffer without the initial #+TITLE: keyword."
  3119. :group 'org-appearance
  3120. :version "24.1"
  3121. :type '(set (const :tag "#+AUTHOR" author)
  3122. (const :tag "#+DATE" date)
  3123. (const :tag "#+EMAIL" email)
  3124. (const :tag "#+TITLE" title)))
  3125. (defcustom org-fontify-done-headline nil
  3126. "Non-nil means change the face of a headline if it is marked DONE.
  3127. Normally, only the TODO/DONE keyword indicates the state of a headline.
  3128. When this is non-nil, the headline after the keyword is set to the
  3129. `org-headline-done' as an additional indication."
  3130. :group 'org-appearance
  3131. :type 'boolean)
  3132. (defcustom org-fontify-emphasized-text t
  3133. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  3134. Changing this variable requires a restart of Emacs to take effect."
  3135. :group 'org-appearance
  3136. :type 'boolean)
  3137. (defcustom org-fontify-whole-heading-line nil
  3138. "Non-nil means fontify the whole line for headings.
  3139. This is useful when setting a background color for the
  3140. org-level-* faces."
  3141. :group 'org-appearance
  3142. :type 'boolean)
  3143. (defcustom org-highlight-latex-fragments-and-specials nil
  3144. "Non-nil means fontify what is treated specially by the exporters."
  3145. :group 'org-appearance
  3146. :type 'boolean)
  3147. (defcustom org-hide-emphasis-markers nil
  3148. "Non-nil mean font-lock should hide the emphasis marker characters."
  3149. :group 'org-appearance
  3150. :type 'boolean)
  3151. (defcustom org-pretty-entities nil
  3152. "Non-nil means show entities as UTF8 characters.
  3153. When nil, the \\name form remains in the buffer."
  3154. :group 'org-appearance
  3155. :version "24.1"
  3156. :type 'boolean)
  3157. (defcustom org-pretty-entities-include-sub-superscripts t
  3158. "Non-nil means, pretty entity display includes formatting sub/superscripts."
  3159. :group 'org-appearance
  3160. :version "24.1"
  3161. :type 'boolean)
  3162. (defvar org-emph-re nil
  3163. "Regular expression for matching emphasis.
  3164. After a match, the match groups contain these elements:
  3165. 0 The match of the full regular expression, including the characters
  3166. before and after the proper match
  3167. 1 The character before the proper match, or empty at beginning of line
  3168. 2 The proper match, including the leading and trailing markers
  3169. 3 The leading marker like * or /, indicating the type of highlighting
  3170. 4 The text between the emphasis markers, not including the markers
  3171. 5 The character after the match, empty at the end of a line")
  3172. (defvar org-verbatim-re nil
  3173. "Regular expression for matching verbatim text.")
  3174. (defvar org-emphasis-regexp-components) ; defined just below
  3175. (defvar org-emphasis-alist) ; defined just below
  3176. (defun org-set-emph-re (var val)
  3177. "Set variable and compute the emphasis regular expression."
  3178. (set var val)
  3179. (when (and (boundp 'org-emphasis-alist)
  3180. (boundp 'org-emphasis-regexp-components)
  3181. org-emphasis-alist org-emphasis-regexp-components)
  3182. (let* ((e org-emphasis-regexp-components)
  3183. (pre (car e))
  3184. (post (nth 1 e))
  3185. (border (nth 2 e))
  3186. (body (nth 3 e))
  3187. (nl (nth 4 e))
  3188. (body1 (concat body "*?"))
  3189. (markers (mapconcat 'car org-emphasis-alist ""))
  3190. (vmarkers (mapconcat
  3191. (lambda (x) (if (eq (nth 4 x) 'verbatim) (car x) ""))
  3192. org-emphasis-alist "")))
  3193. ;; make sure special characters appear at the right position in the class
  3194. (if (string-match "\\^" markers)
  3195. (setq markers (concat (replace-match "" t t markers) "^")))
  3196. (if (string-match "-" markers)
  3197. (setq markers (concat (replace-match "" t t markers) "-")))
  3198. (if (string-match "\\^" vmarkers)
  3199. (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
  3200. (if (string-match "-" vmarkers)
  3201. (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
  3202. (if (> nl 0)
  3203. (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
  3204. (int-to-string nl) "\\}")))
  3205. ;; Make the regexp
  3206. (setq org-emph-re
  3207. (concat "\\([" pre "]\\|^\\)"
  3208. "\\("
  3209. "\\([" markers "]\\)"
  3210. "\\("
  3211. "[^" border "]\\|"
  3212. "[^" border "]"
  3213. body1
  3214. "[^" border "]"
  3215. "\\)"
  3216. "\\3\\)"
  3217. "\\([" post "]\\|$\\)"))
  3218. (setq org-verbatim-re
  3219. (concat "\\([" pre "]\\|^\\)"
  3220. "\\("
  3221. "\\([" vmarkers "]\\)"
  3222. "\\("
  3223. "[^" border "]\\|"
  3224. "[^" border "]"
  3225. body1
  3226. "[^" border "]"
  3227. "\\)"
  3228. "\\3\\)"
  3229. "\\([" post "]\\|$\\)")))))
  3230. (defcustom org-emphasis-regexp-components
  3231. '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
  3232. "Components used to build the regular expression for emphasis.
  3233. This is a list with five entries. Terminology: In an emphasis string
  3234. like \" *strong word* \", we call the initial space PREMATCH, the final
  3235. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  3236. and \"trong wor\" is the body. The different components in this variable
  3237. specify what is allowed/forbidden in each part:
  3238. pre Chars allowed as prematch. Beginning of line will be allowed too.
  3239. post Chars allowed as postmatch. End of line will be allowed too.
  3240. border The chars *forbidden* as border characters.
  3241. body-regexp A regexp like \".\" to match a body character. Don't use
  3242. non-shy groups here, and don't allow newline here.
  3243. newline The maximum number of newlines allowed in an emphasis exp.
  3244. Use customize to modify this, or restart Emacs after changing it."
  3245. :group 'org-appearance
  3246. :set 'org-set-emph-re
  3247. :type '(list
  3248. (sexp :tag "Allowed chars in pre ")
  3249. (sexp :tag "Allowed chars in post ")
  3250. (sexp :tag "Forbidden chars in border ")
  3251. (sexp :tag "Regexp for body ")
  3252. (integer :tag "number of newlines allowed")
  3253. (option (boolean :tag "Please ignore this button"))))
  3254. (defcustom org-emphasis-alist
  3255. `(("*" bold "<b>" "</b>")
  3256. ("/" italic "<i>" "</i>")
  3257. ("_" underline "<span style=\"text-decoration:underline;\">" "</span>")
  3258. ("=" org-code "<code>" "</code>" verbatim)
  3259. ("~" org-verbatim "<code>" "</code>" verbatim)
  3260. ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))
  3261. "<del>" "</del>")
  3262. )
  3263. "Special syntax for emphasized text.
  3264. Text starting and ending with a special character will be emphasized, for
  3265. example *bold*, _underlined_ and /italic/. This variable sets the marker
  3266. characters, the face to be used by font-lock for highlighting in Org-mode
  3267. Emacs buffers, and the HTML tags to be used for this.
  3268. For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
  3269. For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
  3270. Use customize to modify this, or restart Emacs after changing it."
  3271. :group 'org-appearance
  3272. :set 'org-set-emph-re
  3273. :type '(repeat
  3274. (list
  3275. (string :tag "Marker character")
  3276. (choice
  3277. (face :tag "Font-lock-face")
  3278. (plist :tag "Face property list"))
  3279. (string :tag "HTML start tag")
  3280. (string :tag "HTML end tag")
  3281. (option (const verbatim)))))
  3282. (defvar org-protecting-blocks
  3283. '("src" "example" "latex" "ascii" "html" "docbook" "ditaa" "dot" "r" "R")
  3284. "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
  3285. This is needed for font-lock setup.")
  3286. ;;; Miscellaneous options
  3287. (defgroup org-completion nil
  3288. "Completion in Org-mode."
  3289. :tag "Org Completion"
  3290. :group 'org)
  3291. (defcustom org-completion-use-ido nil
  3292. "Non-nil means use ido completion wherever possible.
  3293. Note that `ido-mode' must be active for this variable to be relevant.
  3294. If you decide to turn this variable on, you might well want to turn off
  3295. `org-outline-path-complete-in-steps'.
  3296. See also `org-completion-use-iswitchb'."
  3297. :group 'org-completion
  3298. :type 'boolean)
  3299. (defcustom org-completion-use-iswitchb nil
  3300. "Non-nil means use iswitchb completion wherever possible.
  3301. Note that `iswitchb-mode' must be active for this variable to be relevant.
  3302. If you decide to turn this variable on, you might well want to turn off
  3303. `org-outline-path-complete-in-steps'.
  3304. Note that this variable has only an effect if `org-completion-use-ido' is nil."
  3305. :group 'org-completion
  3306. :type 'boolean)
  3307. (defcustom org-completion-fallback-command 'hippie-expand
  3308. "The expansion command called by \\[pcomplete] in normal context.
  3309. Normal means, no org-mode-specific context."
  3310. :group 'org-completion
  3311. :type 'function)
  3312. ;;; Functions and variables from their packages
  3313. ;; Declared here to avoid compiler warnings
  3314. ;; XEmacs only
  3315. (defvar outline-mode-menu-heading)
  3316. (defvar outline-mode-menu-show)
  3317. (defvar outline-mode-menu-hide)
  3318. (defvar zmacs-regions) ; XEmacs regions
  3319. ;; Emacs only
  3320. (defvar mark-active)
  3321. ;; Various packages
  3322. (declare-function calendar-absolute-from-iso "cal-iso" (date))
  3323. (declare-function calendar-forward-day "cal-move" (arg))
  3324. (declare-function calendar-goto-date "cal-move" (date))
  3325. (declare-function calendar-goto-today "cal-move" ())
  3326. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  3327. (defvar calc-embedded-close-formula)
  3328. (defvar calc-embedded-open-formula)
  3329. (declare-function cdlatex-tab "ext:cdlatex" ())
  3330. (declare-function cdlatex-compute-tables "ext:cdlatex" ())
  3331. (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
  3332. (defvar font-lock-unfontify-region-function)
  3333. (declare-function iswitchb-read-buffer "iswitchb"
  3334. (prompt &optional default require-match start matches-set))
  3335. (defvar iswitchb-temp-buflist)
  3336. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  3337. (defvar org-agenda-tags-todo-honor-ignore-options)
  3338. (declare-function org-agenda-skip "org-agenda" ())
  3339. (declare-function
  3340. org-agenda-format-item "org-agenda"
  3341. (extra txt &optional category tags dotime noprefix remove-re habitp))
  3342. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  3343. (declare-function org-agenda-change-all-lines "org-agenda"
  3344. (newhead hdmarker &optional fixface just-this))
  3345. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  3346. (declare-function org-agenda-maybe-redo "org-agenda" ())
  3347. (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
  3348. (beg end))
  3349. (declare-function org-agenda-copy-local-variable "org-agenda" (var))
  3350. (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  3351. "org-agenda" (&optional end))
  3352. (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  3353. (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
  3354. (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
  3355. (declare-function org-inlinetask-goto-end "org-inlinetask" ())
  3356. (declare-function org-indent-mode "org-indent" (&optional arg))
  3357. (declare-function parse-time-string "parse-time" (string))
  3358. (declare-function org-attach-reveal "org-attach" (&optional if-exists))
  3359. (declare-function org-export-latex-fix-inputenc "org-latex" ())
  3360. (declare-function orgtbl-send-table "org-table" (&optional maybe))
  3361. (defvar remember-data-file)
  3362. (defvar texmathp-why)
  3363. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  3364. (declare-function table--at-cell-p "table" (position &optional object at-column))
  3365. (defvar w3m-current-url)
  3366. (defvar w3m-current-title)
  3367. (defvar org-latex-regexps)
  3368. ;;; Autoload and prepare some org modules
  3369. ;; Some table stuff that needs to be defined here, because it is used
  3370. ;; by the functions setting up org-mode or checking for table context.
  3371. (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
  3372. "Detect an org-type or table-type table.")
  3373. (defconst org-table-line-regexp "^[ \t]*|"
  3374. "Detect an org-type table line.")
  3375. (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
  3376. "Detect an org-type table line.")
  3377. (defconst org-table-hline-regexp "^[ \t]*|-"
  3378. "Detect an org-type table hline.")
  3379. (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
  3380. "Detect a table-type table hline.")
  3381. (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
  3382. "Detect the first line outside a table when searching from within it.
  3383. This works for both table types.")
  3384. ;; Autoload the functions in org-table.el that are needed by functions here.
  3385. (eval-and-compile
  3386. (org-autoload "org-table"
  3387. '(org-table-align org-table-begin org-table-blank-field
  3388. org-table-convert org-table-convert-region org-table-copy-down
  3389. org-table-copy-region org-table-create
  3390. org-table-create-or-convert-from-region
  3391. org-table-create-with-table.el org-table-current-dline
  3392. org-table-cut-region org-table-delete-column org-table-edit-field
  3393. org-table-edit-formulas org-table-end org-table-eval-formula
  3394. org-table-export org-table-field-info
  3395. org-table-get-stored-formulas org-table-goto-column
  3396. org-table-hline-and-move org-table-import org-table-insert-column
  3397. org-table-insert-hline org-table-insert-row org-table-iterate
  3398. org-table-justify-field-maybe org-table-kill-row
  3399. org-table-maybe-eval-formula org-table-maybe-recalculate-line
  3400. org-table-move-column org-table-move-column-left
  3401. org-table-move-column-right org-table-move-row
  3402. org-table-move-row-down org-table-move-row-up
  3403. org-table-next-field org-table-next-row org-table-paste-rectangle
  3404. org-table-previous-field org-table-recalculate
  3405. org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
  3406. org-table-toggle-coordinate-overlays
  3407. org-table-toggle-formula-debugger org-table-wrap-region
  3408. orgtbl-mode turn-on-orgtbl org-table-to-lisp
  3409. orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
  3410. orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
  3411. (defun org-at-table-p (&optional table-type)
  3412. "Return t if the cursor is inside an org-type table.
  3413. If TABLE-TYPE is non-nil, also check for table.el-type tables."
  3414. (if org-enable-table-editor
  3415. (save-excursion
  3416. (beginning-of-line 1)
  3417. (looking-at (if table-type org-table-any-line-regexp
  3418. org-table-line-regexp)))
  3419. nil))
  3420. (defsubst org-table-p () (org-at-table-p))
  3421. (defun org-at-table.el-p ()
  3422. "Return t if and only if we are at a table.el table."
  3423. (and (org-at-table-p 'any)
  3424. (save-excursion
  3425. (goto-char (org-table-begin 'any))
  3426. (looking-at org-table1-hline-regexp))))
  3427. (defun org-table-recognize-table.el ()
  3428. "If there is a table.el table nearby, recognize it and move into it."
  3429. (if org-table-tab-recognizes-table.el
  3430. (if (org-at-table.el-p)
  3431. (progn
  3432. (beginning-of-line 1)
  3433. (if (looking-at org-table-dataline-regexp)
  3434. nil
  3435. (if (looking-at org-table1-hline-regexp)
  3436. (progn
  3437. (beginning-of-line 2)
  3438. (if (looking-at org-table-any-border-regexp)
  3439. (beginning-of-line -1)))))
  3440. (if (re-search-forward "|" (org-table-end t) t)
  3441. (progn
  3442. (require 'table)
  3443. (if (table--at-cell-p (point))
  3444. t
  3445. (message "recognizing table.el table...")
  3446. (table-recognize-table)
  3447. (message "recognizing table.el table...done")))
  3448. (error "This should not happen"))
  3449. t)
  3450. nil)
  3451. nil))
  3452. (defun org-at-table-hline-p ()
  3453. "Return t if the cursor is inside a hline in a table."
  3454. (if org-enable-table-editor
  3455. (save-excursion
  3456. (beginning-of-line 1)
  3457. (looking-at org-table-hline-regexp))
  3458. nil))
  3459. (defvar org-table-clean-did-remove-column nil)
  3460. (defun org-table-map-tables (function &optional quietly)
  3461. "Apply FUNCTION to the start of all tables in the buffer."
  3462. (save-excursion
  3463. (save-restriction
  3464. (widen)
  3465. (goto-char (point-min))
  3466. (while (re-search-forward org-table-any-line-regexp nil t)
  3467. (unless quietly
  3468. (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
  3469. (beginning-of-line 1)
  3470. (when (and (looking-at org-table-line-regexp)
  3471. ;; Exclude tables in src/example/verbatim/clocktable blocks
  3472. (not (org-in-block-p '("src" "example"))))
  3473. (save-excursion (funcall function))
  3474. (or (looking-at org-table-line-regexp)
  3475. (forward-char 1)))
  3476. (re-search-forward org-table-any-border-regexp nil 1))))
  3477. (unless quietly (message "Mapping tables: done")))
  3478. ;; Declare and autoload functions from org-exp.el & Co
  3479. (declare-function org-default-export-plist "org-exp")
  3480. (declare-function org-infile-export-plist "org-exp")
  3481. (declare-function org-get-current-options "org-exp")
  3482. (eval-and-compile
  3483. (org-autoload "org-exp"
  3484. '(org-export org-export-visible
  3485. org-insert-export-options-template
  3486. org-table-clean-before-export))
  3487. (org-autoload "org-ascii"
  3488. '(org-export-as-ascii org-export-ascii-preprocess
  3489. org-export-as-ascii-to-buffer org-replace-region-by-ascii
  3490. org-export-region-as-ascii))
  3491. (org-autoload "org-latex"
  3492. '(org-export-as-latex-batch org-export-as-latex-to-buffer
  3493. org-replace-region-by-latex org-export-region-as-latex
  3494. org-export-as-latex org-export-as-pdf
  3495. org-export-as-pdf-and-open))
  3496. (org-autoload "org-html"
  3497. '(org-export-as-html-and-open
  3498. org-export-as-html-batch org-export-as-html-to-buffer
  3499. org-replace-region-by-html org-export-region-as-html
  3500. org-export-as-html))
  3501. (org-autoload "org-docbook"
  3502. '(org-export-as-docbook-batch org-export-as-docbook-to-buffer
  3503. org-replace-region-by-docbook org-export-region-as-docbook
  3504. org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
  3505. org-export-as-docbook))
  3506. (org-autoload "org-icalendar"
  3507. '(org-export-icalendar-this-file
  3508. org-export-icalendar-all-agenda-files
  3509. org-export-icalendar-combine-agenda-files))
  3510. (org-autoload "org-xoxo" '(org-export-as-xoxo))
  3511. (org-autoload "org-beamer" '(org-beamer-mode org-beamer-sectioning)))
  3512. ;; Declare and autoload functions from org-agenda.el
  3513. (eval-and-compile
  3514. (org-autoload "org-agenda"
  3515. '(org-agenda org-agenda-list org-search-view
  3516. org-todo-list org-tags-view org-agenda-list-stuck-projects
  3517. org-diary org-agenda-to-appt
  3518. org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
  3519. ;; Autoload org-remember
  3520. (eval-and-compile
  3521. (org-autoload "org-remember"
  3522. '(org-remember-insinuate org-remember-annotation
  3523. org-remember-apply-template org-remember org-remember-handler)))
  3524. (eval-and-compile
  3525. (org-autoload "org-capture"
  3526. '(org-capture org-capture-insert-template-here
  3527. org-capture-import-remember-templates)))
  3528. ;; Autoload org-clock.el
  3529. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock"
  3530. (beg end))
  3531. (declare-function org-clock-update-mode-line "org-clock" ())
  3532. (declare-function org-resolve-clocks "org-clock"
  3533. (&optional also-non-dangling-p prompt last-valid))
  3534. (defvar org-clock-start-time)
  3535. (defvar org-clock-marker (make-marker)
  3536. "Marker recording the last clock-in.")
  3537. (defvar org-clock-hd-marker (make-marker)
  3538. "Marker recording the last clock-in, but the headline position.")
  3539. (defvar org-clock-heading ""
  3540. "The heading of the current clock entry.")
  3541. (defun org-clock-is-active ()
  3542. "Return non-nil if clock is currently running.
  3543. The return value is actually the clock marker."
  3544. (marker-buffer org-clock-marker))
  3545. (eval-and-compile
  3546. (org-autoload
  3547. "org-clock"
  3548. '(org-clock-in org-clock-out org-clock-cancel
  3549. org-clock-goto org-clock-sum org-clock-display
  3550. org-clock-remove-overlays org-clock-report
  3551. org-clocktable-shift org-dblock-write:clocktable
  3552. org-get-clocktable org-resolve-clocks)))
  3553. (defun org-clock-update-time-maybe ()
  3554. "If this is a CLOCK line, update it and return t.
  3555. Otherwise, return nil."
  3556. (interactive)
  3557. (save-excursion
  3558. (beginning-of-line 1)
  3559. (skip-chars-forward " \t")
  3560. (when (looking-at org-clock-string)
  3561. (let ((re (concat "[ \t]*" org-clock-string
  3562. " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
  3563. "\\([ \t]*=>.*\\)?\\)?"))
  3564. ts te h m s neg)
  3565. (cond
  3566. ((not (looking-at re))
  3567. nil)
  3568. ((not (match-end 2))
  3569. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3570. (> org-clock-marker (point))
  3571. (<= org-clock-marker (point-at-eol)))
  3572. ;; The clock is running here
  3573. (setq org-clock-start-time
  3574. (apply 'encode-time
  3575. (org-parse-time-string (match-string 1))))
  3576. (org-clock-update-mode-line)))
  3577. (t
  3578. (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
  3579. (end-of-line 1)
  3580. (setq ts (match-string 1)
  3581. te (match-string 3))
  3582. (setq s (- (org-float-time
  3583. (apply 'encode-time (org-parse-time-string te)))
  3584. (org-float-time
  3585. (apply 'encode-time (org-parse-time-string ts))))
  3586. neg (< s 0)
  3587. s (abs s)
  3588. h (floor (/ s 3600))
  3589. s (- s (* 3600 h))
  3590. m (floor (/ s 60))
  3591. s (- s (* 60 s)))
  3592. (insert " => " (format (if neg "-%d:%02d" "%2d:%02d") h m))
  3593. t))))))
  3594. (defun org-check-running-clock ()
  3595. "Check if the current buffer contains the running clock.
  3596. If yes, offer to stop it and to save the buffer with the changes."
  3597. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3598. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  3599. (buffer-name))))
  3600. (org-clock-out)
  3601. (when (y-or-n-p "Save changed buffer?")
  3602. (save-buffer))))
  3603. (defun org-clocktable-try-shift (dir n)
  3604. "Check if this line starts a clock table, if yes, shift the time block."
  3605. (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
  3606. (org-clocktable-shift dir n)))
  3607. ;; Autoload org-timer.el
  3608. (eval-and-compile
  3609. (org-autoload
  3610. "org-timer"
  3611. '(org-timer-start org-timer org-timer-item
  3612. org-timer-change-times-in-region
  3613. org-timer-set-timer
  3614. org-timer-reset-timers
  3615. org-timer-show-remaining-time)))
  3616. ;; Autoload org-feed.el
  3617. (eval-and-compile
  3618. (org-autoload
  3619. "org-feed"
  3620. '(org-feed-update org-feed-update-all org-feed-goto-inbox)))
  3621. ;; Autoload org-indent.el
  3622. ;; Define the variable already here, to make sure we have it.
  3623. (defvar org-indent-mode nil
  3624. "Non-nil if Org-Indent mode is enabled.
  3625. Use the command `org-indent-mode' to change this variable.")
  3626. (eval-and-compile
  3627. (org-autoload
  3628. "org-indent"
  3629. '(org-indent-mode)))
  3630. ;; Autoload org-mobile.el
  3631. (eval-and-compile
  3632. (org-autoload
  3633. "org-mobile"
  3634. '(org-mobile-push org-mobile-pull org-mobile-create-sumo-agenda)))
  3635. ;; Autoload archiving code
  3636. ;; The stuff that is needed for cycling and tags has to be defined here.
  3637. (defgroup org-archive nil
  3638. "Options concerning archiving in Org-mode."
  3639. :tag "Org Archive"
  3640. :group 'org-structure)
  3641. (defcustom org-archive-location "%s_archive::"
  3642. "The location where subtrees should be archived.
  3643. The value of this variable is a string, consisting of two parts,
  3644. separated by a double-colon. The first part is a filename and
  3645. the second part is a headline.
  3646. When the filename is omitted, archiving happens in the same file.
  3647. %s in the filename will be replaced by the current file
  3648. name (without the directory part). Archiving to a different file
  3649. is useful to keep archived entries from contributing to the
  3650. Org-mode Agenda.
  3651. The archived entries will be filed as subtrees of the specified
  3652. headline. When the headline is omitted, the subtrees are simply
  3653. filed away at the end of the file, as top-level entries. Also in
  3654. the heading you can use %s to represent the file name, this can be
  3655. useful when using the same archive for a number of different files.
  3656. Here are a few examples:
  3657. \"%s_archive::\"
  3658. If the current file is Projects.org, archive in file
  3659. Projects.org_archive, as top-level trees. This is the default.
  3660. \"::* Archived Tasks\"
  3661. Archive in the current file, under the top-level headline
  3662. \"* Archived Tasks\".
  3663. \"~/org/archive.org::\"
  3664. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  3665. \"~/org/archive.org::* From %s\"
  3666. Archive in file ~/org/archive.org (absolute path), under headlines
  3667. \"From FILENAME\" where file name is the current file name.
  3668. \"~/org/datetree.org::datetree/* Finished Tasks\"
  3669. The \"datetree/\" string is special, signifying to archive
  3670. items to the datetree. Items are placed in either the CLOSED
  3671. date of the item, or the current date if there is no CLOSED date.
  3672. The heading will be a subentry to the current date. There doesn't
  3673. need to be a heading, but there always needs to be a slash after
  3674. datetree. For example, to store archived items directly in the
  3675. datetree, use \"~/org/datetree.org::datetree/\".
  3676. \"basement::** Finished Tasks\"
  3677. Archive in file ./basement (relative path), as level 3 trees
  3678. below the level 2 heading \"** Finished Tasks\".
  3679. You may set this option on a per-file basis by adding to the buffer a
  3680. line like
  3681. #+ARCHIVE: basement::** Finished Tasks
  3682. You may also define it locally for a subtree by setting an ARCHIVE property
  3683. in the entry. If such a property is found in an entry, or anywhere up
  3684. the hierarchy, it will be used."
  3685. :group 'org-archive
  3686. :type 'string)
  3687. (defcustom org-archive-tag "ARCHIVE"
  3688. "The tag that marks a subtree as archived.
  3689. An archived subtree does not open during visibility cycling, and does
  3690. not contribute to the agenda listings.
  3691. After changing this, font-lock must be restarted in the relevant buffers to
  3692. get the proper fontification."
  3693. :group 'org-archive
  3694. :group 'org-keywords
  3695. :type 'string)
  3696. (defcustom org-agenda-skip-archived-trees t
  3697. "Non-nil means the agenda will skip any items located in archived trees.
  3698. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  3699. variable is no longer recommended, you should leave it at the value t.
  3700. Instead, use the key `v' to cycle the archives-mode in the agenda."
  3701. :group 'org-archive
  3702. :group 'org-agenda-skip
  3703. :type 'boolean)
  3704. (defcustom org-columns-skip-archived-trees t
  3705. "Non-nil means ignore archived trees when creating column view."
  3706. :group 'org-archive
  3707. :group 'org-properties
  3708. :type 'boolean)
  3709. (defcustom org-cycle-open-archived-trees nil
  3710. "Non-nil means `org-cycle' will open archived trees.
  3711. An archived tree is a tree marked with the tag ARCHIVE.
  3712. When nil, archived trees will stay folded. You can still open them with
  3713. normal outline commands like `show-all', but not with the cycling commands."
  3714. :group 'org-archive
  3715. :group 'org-cycle
  3716. :type 'boolean)
  3717. (defcustom org-sparse-tree-open-archived-trees nil
  3718. "Non-nil means sparse tree construction shows matches in archived trees.
  3719. When nil, matches in these trees are highlighted, but the trees are kept in
  3720. collapsed state."
  3721. :group 'org-archive
  3722. :group 'org-sparse-trees
  3723. :type 'boolean)
  3724. (defun org-cycle-hide-archived-subtrees (state)
  3725. "Re-hide all archived subtrees after a visibility state change."
  3726. (when (and (not org-cycle-open-archived-trees)
  3727. (not (memq state '(overview folded))))
  3728. (save-excursion
  3729. (let* ((globalp (memq state '(contents all)))
  3730. (beg (if globalp (point-min) (point)))
  3731. (end (if globalp (point-max) (org-end-of-subtree t))))
  3732. (org-hide-archived-subtrees beg end)
  3733. (goto-char beg)
  3734. (if (looking-at (concat ".*:" org-archive-tag ":"))
  3735. (message "%s" (substitute-command-keys
  3736. "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
  3737. (defun org-force-cycle-archived ()
  3738. "Cycle subtree even if it is archived."
  3739. (interactive)
  3740. (setq this-command 'org-cycle)
  3741. (let ((org-cycle-open-archived-trees t))
  3742. (call-interactively 'org-cycle)))
  3743. (defun org-hide-archived-subtrees (beg end)
  3744. "Re-hide all archived subtrees after a visibility state change."
  3745. (save-excursion
  3746. (let* ((re (concat ":" org-archive-tag ":")))
  3747. (goto-char beg)
  3748. (while (re-search-forward re end t)
  3749. (when (org-at-heading-p)
  3750. (org-flag-subtree t)
  3751. (org-end-of-subtree t))))))
  3752. (defun org-flag-subtree (flag)
  3753. (save-excursion
  3754. (org-back-to-heading t)
  3755. (outline-end-of-heading)
  3756. (outline-flag-region (point)
  3757. (progn (org-end-of-subtree t) (point))
  3758. flag)))
  3759. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  3760. (eval-and-compile
  3761. (org-autoload "org-archive"
  3762. '(org-add-archive-files org-archive-subtree
  3763. org-archive-to-archive-sibling org-toggle-archive-tag
  3764. org-archive-subtree-default
  3765. org-archive-subtree-default-with-confirmation)))
  3766. ;; Autoload Column View Code
  3767. (declare-function org-columns-number-to-string "org-colview")
  3768. (declare-function org-columns-get-format-and-top-level "org-colview")
  3769. (declare-function org-columns-compute "org-colview")
  3770. (org-autoload (if (featurep 'xemacs) "org-colview-xemacs" "org-colview")
  3771. '(org-columns-number-to-string org-columns-get-format-and-top-level
  3772. org-columns-compute org-agenda-columns org-columns-remove-overlays
  3773. org-columns org-insert-columns-dblock org-dblock-write:columnview))
  3774. ;; Autoload ID code
  3775. (declare-function org-id-store-link "org-id")
  3776. (declare-function org-id-locations-load "org-id")
  3777. (declare-function org-id-locations-save "org-id")
  3778. (defvar org-id-track-globally)
  3779. (org-autoload "org-id"
  3780. '(org-id-get-create org-id-new org-id-copy org-id-get
  3781. org-id-get-with-outline-path-completion
  3782. org-id-get-with-outline-drilling org-id-store-link
  3783. org-id-goto org-id-find org-id-store-link))
  3784. ;; Autoload Plotting Code
  3785. (org-autoload "org-plot"
  3786. '(org-plot/gnuplot))
  3787. ;;; Variables for pre-computed regular expressions, all buffer local
  3788. (defvar org-drawer-regexp nil
  3789. "Matches first line of a hidden block.")
  3790. (make-variable-buffer-local 'org-drawer-regexp)
  3791. (defvar org-todo-regexp nil
  3792. "Matches any of the TODO state keywords.")
  3793. (make-variable-buffer-local 'org-todo-regexp)
  3794. (defvar org-not-done-regexp nil
  3795. "Matches any of the TODO state keywords except the last one.")
  3796. (make-variable-buffer-local 'org-not-done-regexp)
  3797. (defvar org-not-done-heading-regexp nil
  3798. "Matches a TODO headline that is not done.")
  3799. (make-variable-buffer-local 'org-not-done-regexp)
  3800. (defvar org-todo-line-regexp nil
  3801. "Matches a headline and puts TODO state into group 2 if present.")
  3802. (make-variable-buffer-local 'org-todo-line-regexp)
  3803. (defvar org-complex-heading-regexp nil
  3804. "Matches a headline and puts everything into groups:
  3805. group 1: the stars
  3806. group 2: The todo keyword, maybe
  3807. group 3: Priority cookie
  3808. group 4: True headline
  3809. group 5: Tags")
  3810. (make-variable-buffer-local 'org-complex-heading-regexp)
  3811. (defvar org-complex-heading-regexp-format nil
  3812. "Printf format to make regexp to match an exact headline.
  3813. This regexp will match the headline of any node which has the
  3814. exact headline text that is put into the format, but may have any
  3815. TODO state, priority and tags.")
  3816. (make-variable-buffer-local 'org-complex-heading-regexp-format)
  3817. (defvar org-todo-line-tags-regexp nil
  3818. "Matches a headline and puts TODO state into group 2 if present.
  3819. Also put tags into group 4 if tags are present.")
  3820. (make-variable-buffer-local 'org-todo-line-tags-regexp)
  3821. (defvar org-ds-keyword-length 12
  3822. "Maximum length of the Deadline and SCHEDULED keywords.")
  3823. (make-variable-buffer-local 'org-ds-keyword-length)
  3824. (defvar org-deadline-regexp nil
  3825. "Matches the DEADLINE keyword.")
  3826. (make-variable-buffer-local 'org-deadline-regexp)
  3827. (defvar org-deadline-time-regexp nil
  3828. "Matches the DEADLINE keyword together with a time stamp.")
  3829. (make-variable-buffer-local 'org-deadline-time-regexp)
  3830. (defvar org-deadline-line-regexp nil
  3831. "Matches the DEADLINE keyword and the rest of the line.")
  3832. (make-variable-buffer-local 'org-deadline-line-regexp)
  3833. (defvar org-scheduled-regexp nil
  3834. "Matches the SCHEDULED keyword.")
  3835. (make-variable-buffer-local 'org-scheduled-regexp)
  3836. (defvar org-scheduled-time-regexp nil
  3837. "Matches the SCHEDULED keyword together with a time stamp.")
  3838. (make-variable-buffer-local 'org-scheduled-time-regexp)
  3839. (defvar org-closed-time-regexp nil
  3840. "Matches the CLOSED keyword together with a time stamp.")
  3841. (make-variable-buffer-local 'org-closed-time-regexp)
  3842. (defvar org-keyword-time-regexp nil
  3843. "Matches any of the 4 keywords, together with the time stamp.")
  3844. (make-variable-buffer-local 'org-keyword-time-regexp)
  3845. (defvar org-keyword-time-not-clock-regexp nil
  3846. "Matches any of the 3 keywords, together with the time stamp.")
  3847. (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
  3848. (defvar org-maybe-keyword-time-regexp nil
  3849. "Matches a timestamp, possibly preceded by a keyword.")
  3850. (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
  3851. (defvar org-planning-or-clock-line-re nil
  3852. "Matches a line with planning or clock info.")
  3853. (make-variable-buffer-local 'org-planning-or-clock-line-re)
  3854. (defvar org-all-time-keywords nil
  3855. "List of time keywords.")
  3856. (make-variable-buffer-local 'org-all-time-keywords)
  3857. (defconst org-plain-time-of-day-regexp
  3858. (concat
  3859. "\\(\\<[012]?[0-9]"
  3860. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3861. "\\(--?"
  3862. "\\(\\<[012]?[0-9]"
  3863. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3864. "\\)?")
  3865. "Regular expression to match a plain time or time range.
  3866. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3867. groups carry important information:
  3868. 0 the full match
  3869. 1 the first time, range or not
  3870. 8 the second time, if it is a range.")
  3871. (defconst org-plain-time-extension-regexp
  3872. (concat
  3873. "\\(\\<[012]?[0-9]"
  3874. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3875. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  3876. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  3877. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3878. groups carry important information:
  3879. 0 the full match
  3880. 7 hours of duration
  3881. 9 minutes of duration")
  3882. (defconst org-stamp-time-of-day-regexp
  3883. (concat
  3884. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  3885. "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
  3886. "\\(--?"
  3887. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  3888. "Regular expression to match a timestamp time or time range.
  3889. After a match, the following groups carry important information:
  3890. 0 the full match
  3891. 1 date plus weekday, for back referencing to make sure both times are on the same day
  3892. 2 the first time, range or not
  3893. 4 the second time, if it is a range.")
  3894. (defconst org-startup-options
  3895. '(("fold" org-startup-folded t)
  3896. ("overview" org-startup-folded t)
  3897. ("nofold" org-startup-folded nil)
  3898. ("showall" org-startup-folded nil)
  3899. ("showeverything" org-startup-folded showeverything)
  3900. ("content" org-startup-folded content)
  3901. ("indent" org-startup-indented t)
  3902. ("noindent" org-startup-indented nil)
  3903. ("hidestars" org-hide-leading-stars t)
  3904. ("showstars" org-hide-leading-stars nil)
  3905. ("odd" org-odd-levels-only t)
  3906. ("oddeven" org-odd-levels-only nil)
  3907. ("align" org-startup-align-all-tables t)
  3908. ("noalign" org-startup-align-all-tables nil)
  3909. ("inlineimages" org-startup-with-inline-images t)
  3910. ("noinlineimages" org-startup-with-inline-images nil)
  3911. ("customtime" org-display-custom-times t)
  3912. ("logdone" org-log-done time)
  3913. ("lognotedone" org-log-done note)
  3914. ("nologdone" org-log-done nil)
  3915. ("lognoteclock-out" org-log-note-clock-out t)
  3916. ("nolognoteclock-out" org-log-note-clock-out nil)
  3917. ("logrepeat" org-log-repeat state)
  3918. ("lognoterepeat" org-log-repeat note)
  3919. ("nologrepeat" org-log-repeat nil)
  3920. ("logreschedule" org-log-reschedule time)
  3921. ("lognotereschedule" org-log-reschedule note)
  3922. ("nologreschedule" org-log-reschedule nil)
  3923. ("logredeadline" org-log-redeadline time)
  3924. ("lognoteredeadline" org-log-redeadline note)
  3925. ("nologredeadline" org-log-redeadline nil)
  3926. ("logrefile" org-log-refile time)
  3927. ("lognoterefile" org-log-refile note)
  3928. ("nologrefile" org-log-refile nil)
  3929. ("fninline" org-footnote-define-inline t)
  3930. ("nofninline" org-footnote-define-inline nil)
  3931. ("fnlocal" org-footnote-section nil)
  3932. ("fnauto" org-footnote-auto-label t)
  3933. ("fnprompt" org-footnote-auto-label nil)
  3934. ("fnconfirm" org-footnote-auto-label confirm)
  3935. ("fnplain" org-footnote-auto-label plain)
  3936. ("fnadjust" org-footnote-auto-adjust t)
  3937. ("nofnadjust" org-footnote-auto-adjust nil)
  3938. ("constcgs" constants-unit-system cgs)
  3939. ("constSI" constants-unit-system SI)
  3940. ("noptag" org-tag-persistent-alist nil)
  3941. ("hideblocks" org-hide-block-startup t)
  3942. ("nohideblocks" org-hide-block-startup nil)
  3943. ("beamer" org-startup-with-beamer-mode t)
  3944. ("entitiespretty" org-pretty-entities t)
  3945. ("entitiesplain" org-pretty-entities nil))
  3946. "Variable associated with STARTUP options for org-mode.
  3947. Each element is a list of three items: The startup options as written
  3948. in the #+STARTUP line, the corresponding variable, and the value to
  3949. set this variable to if the option is found. An optional forth element PUSH
  3950. means to push this value onto the list in the variable.")
  3951. (defun org-update-property-plist (key val props)
  3952. "Update PROPS with KEY and VAL."
  3953. (let* ((appending (string= "+" (substring key (- (length key) 1))))
  3954. (key (if appending (substring key 0 (- (length key) 1)) key))
  3955. (remainder (org-remove-if (lambda (p) (string= (car p) key)) props))
  3956. (previous (cdr (assoc key props))))
  3957. (if appending
  3958. (cons (cons key (if previous (concat previous " " val) val)) remainder)
  3959. (cons (cons key val) remainder))))
  3960. (defconst org-block-regexp
  3961. "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
  3962. "Regular expression for hiding blocks.")
  3963. (defconst org-heading-keyword-regexp-format
  3964. "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  3965. "Printf format for a regexp matching an headline with some keyword.
  3966. This regexp will match the headline of any node which has the
  3967. exact keyword that is put into the format. The keyword isn't in
  3968. any group by default, but the stars and the body are.")
  3969. (defconst org-heading-keyword-maybe-regexp-format
  3970. "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
  3971. "Printf format for a regexp matching an headline, possibly with some keyword.
  3972. This regexp can match any headline with the specified keyword, or
  3973. without a keyword. The keyword isn't in any group by default,
  3974. but the stars and the body are.")
  3975. (defun org-set-regexps-and-options ()
  3976. "Precompute regular expressions for current buffer."
  3977. (when (derived-mode-p 'org-mode)
  3978. (org-set-local 'org-todo-kwd-alist nil)
  3979. (org-set-local 'org-todo-key-alist nil)
  3980. (org-set-local 'org-todo-key-trigger nil)
  3981. (org-set-local 'org-todo-keywords-1 nil)
  3982. (org-set-local 'org-done-keywords nil)
  3983. (org-set-local 'org-todo-heads nil)
  3984. (org-set-local 'org-todo-sets nil)
  3985. (org-set-local 'org-todo-log-states nil)
  3986. (org-set-local 'org-file-properties nil)
  3987. (org-set-local 'org-file-tags nil)
  3988. (let ((re (org-make-options-regexp
  3989. '("CATEGORY" "TODO" "COLUMNS"
  3990. "STARTUP" "ARCHIVE" "FILETAGS" "TAGS" "LINK" "PRIORITIES"
  3991. "CONSTANTS" "PROPERTY" "DRAWERS" "SETUPFILE" "LATEX_CLASS"
  3992. "OPTIONS")
  3993. "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
  3994. (splitre "[ \t]+")
  3995. (scripts org-use-sub-superscripts)
  3996. kwds kws0 kwsa key log value cat arch tags const links hw dws
  3997. tail sep kws1 prio props ftags drawers beamer-p
  3998. ext-setup-or-nil setup-contents (start 0))
  3999. (save-excursion
  4000. (save-restriction
  4001. (widen)
  4002. (goto-char (point-min))
  4003. (while (or (and ext-setup-or-nil
  4004. (string-match re ext-setup-or-nil start)
  4005. (setq start (match-end 0)))
  4006. (and (setq ext-setup-or-nil nil start 0)
  4007. (re-search-forward re nil t)))
  4008. (setq key (upcase (match-string 1 ext-setup-or-nil))
  4009. value (org-match-string-no-properties 2 ext-setup-or-nil))
  4010. (if (stringp value) (setq value (org-trim value)))
  4011. (cond
  4012. ((equal key "CATEGORY")
  4013. (setq cat value))
  4014. ((member key '("SEQ_TODO" "TODO"))
  4015. (push (cons 'sequence (org-split-string value splitre)) kwds))
  4016. ((equal key "TYP_TODO")
  4017. (push (cons 'type (org-split-string value splitre)) kwds))
  4018. ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
  4019. ;; general TODO-like setup
  4020. (push (cons (intern (downcase (match-string 1 key)))
  4021. (org-split-string value splitre)) kwds))
  4022. ((equal key "TAGS")
  4023. (setq tags (append tags (if tags '("\\n") nil)
  4024. (org-split-string value splitre))))
  4025. ((equal key "COLUMNS")
  4026. (org-set-local 'org-columns-default-format value))
  4027. ((equal key "LINK")
  4028. (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  4029. (push (cons (match-string 1 value)
  4030. (org-trim (match-string 2 value)))
  4031. links)))
  4032. ((equal key "PRIORITIES")
  4033. (setq prio (org-split-string value " +")))
  4034. ((equal key "PROPERTY")
  4035. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  4036. (setq props (org-update-property-plist (match-string 1 value)
  4037. (match-string 2 value)
  4038. props))))
  4039. ((equal key "FILETAGS")
  4040. (when (string-match "\\S-" value)
  4041. (setq ftags
  4042. (append
  4043. ftags
  4044. (apply 'append
  4045. (mapcar (lambda (x) (org-split-string x ":"))
  4046. (org-split-string value)))))))
  4047. ((equal key "DRAWERS")
  4048. (setq drawers (delete-dups (append org-drawers (org-split-string value splitre)))))
  4049. ((equal key "CONSTANTS")
  4050. (setq const (append const (org-split-string value splitre))))
  4051. ((equal key "STARTUP")
  4052. (let ((opts (org-split-string value splitre))
  4053. l var val)
  4054. (while (setq l (pop opts))
  4055. (when (setq l (assoc l org-startup-options))
  4056. (setq var (nth 1 l) val (nth 2 l))
  4057. (if (not (nth 3 l))
  4058. (set (make-local-variable var) val)
  4059. (if (not (listp (symbol-value var)))
  4060. (set (make-local-variable var) nil))
  4061. (set (make-local-variable var) (symbol-value var))
  4062. (add-to-list var val))))))
  4063. ((equal key "ARCHIVE")
  4064. (setq arch value)
  4065. (remove-text-properties 0 (length arch)
  4066. '(face t fontified t) arch))
  4067. ((equal key "LATEX_CLASS")
  4068. (setq beamer-p (equal value "beamer")))
  4069. ((equal key "OPTIONS")
  4070. (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value)
  4071. (setq scripts (read (match-string 2 value)))))
  4072. ((equal key "SETUPFILE")
  4073. (setq setup-contents (org-file-contents
  4074. (expand-file-name
  4075. (org-remove-double-quotes value))
  4076. 'noerror))
  4077. (if (not ext-setup-or-nil)
  4078. (setq ext-setup-or-nil setup-contents start 0)
  4079. (setq ext-setup-or-nil
  4080. (concat (substring ext-setup-or-nil 0 start)
  4081. "\n" setup-contents "\n"
  4082. (substring ext-setup-or-nil start)))))))
  4083. ;; search for property blocks
  4084. (goto-char (point-min))
  4085. (while (re-search-forward org-block-regexp nil t)
  4086. (when (equal "PROPERTY" (upcase (match-string 1)))
  4087. (setq value (replace-regexp-in-string
  4088. "[\n\r]" " " (match-string 4)))
  4089. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  4090. (setq props (org-update-property-plist (match-string 1 value)
  4091. (match-string 2 value)
  4092. props)))))))
  4093. (org-set-local 'org-use-sub-superscripts scripts)
  4094. (when cat
  4095. (org-set-local 'org-category (intern cat))
  4096. (push (cons "CATEGORY" cat) props))
  4097. (when prio
  4098. (if (< (length prio) 3) (setq prio '("A" "C" "B")))
  4099. (setq prio (mapcar 'string-to-char prio))
  4100. (org-set-local 'org-highest-priority (nth 0 prio))
  4101. (org-set-local 'org-lowest-priority (nth 1 prio))
  4102. (org-set-local 'org-default-priority (nth 2 prio)))
  4103. (and props (org-set-local 'org-file-properties (nreverse props)))
  4104. (and ftags (org-set-local 'org-file-tags
  4105. (mapcar 'org-add-prop-inherited ftags)))
  4106. (and drawers (org-set-local 'org-drawers drawers))
  4107. (and arch (org-set-local 'org-archive-location arch))
  4108. (and links (setq org-link-abbrev-alist-local (nreverse links)))
  4109. ;; Process the TODO keywords
  4110. (unless kwds
  4111. ;; Use the global values as if they had been given locally.
  4112. (setq kwds (default-value 'org-todo-keywords))
  4113. (if (stringp (car kwds))
  4114. (setq kwds (list (cons org-todo-interpretation
  4115. (default-value 'org-todo-keywords)))))
  4116. (setq kwds (reverse kwds)))
  4117. (setq kwds (nreverse kwds))
  4118. (let (inter kws kw)
  4119. (while (setq kws (pop kwds))
  4120. (let ((kws (or
  4121. (run-hook-with-args-until-success
  4122. 'org-todo-setup-filter-hook kws)
  4123. kws)))
  4124. (setq inter (pop kws) sep (member "|" kws)
  4125. kws0 (delete "|" (copy-sequence kws))
  4126. kwsa nil
  4127. kws1 (mapcar
  4128. (lambda (x)
  4129. ;; 1 2
  4130. (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
  4131. (progn
  4132. (setq kw (match-string 1 x)
  4133. key (and (match-end 2) (match-string 2 x))
  4134. log (org-extract-log-state-settings x))
  4135. (push (cons kw (and key (string-to-char key))) kwsa)
  4136. (and log (push log org-todo-log-states))
  4137. kw)
  4138. (error "Invalid TODO keyword %s" x)))
  4139. kws0)
  4140. kwsa (if kwsa (append '((:startgroup))
  4141. (nreverse kwsa)
  4142. '((:endgroup))))
  4143. hw (car kws1)
  4144. dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
  4145. tail (list inter hw (car dws) (org-last dws))))
  4146. (add-to-list 'org-todo-heads hw 'append)
  4147. (push kws1 org-todo-sets)
  4148. (setq org-done-keywords (append org-done-keywords dws nil))
  4149. (setq org-todo-key-alist (append org-todo-key-alist kwsa))
  4150. (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
  4151. (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
  4152. (setq org-todo-sets (nreverse org-todo-sets)
  4153. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  4154. org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
  4155. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
  4156. ;; Process the constants
  4157. (when const
  4158. (let (e cst)
  4159. (while (setq e (pop const))
  4160. (if (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)" e)
  4161. (push (cons (match-string 1 e) (match-string 2 e)) cst)))
  4162. (setq org-table-formula-constants-local cst)))
  4163. ;; Process the tags.
  4164. (when tags
  4165. (let (e tgs)
  4166. (while (setq e (pop tags))
  4167. (cond
  4168. ((equal e "{") (push '(:startgroup) tgs))
  4169. ((equal e "}") (push '(:endgroup) tgs))
  4170. ((equal e "\\n") (push '(:newline) tgs))
  4171. ((string-match (org-re "^\\([[:alnum:]_@#%]+\\)(\\(.\\))$") e)
  4172. (push (cons (match-string 1 e)
  4173. (string-to-char (match-string 2 e)))
  4174. tgs))
  4175. (t (push (list e) tgs))))
  4176. (org-set-local 'org-tag-alist nil)
  4177. (while (setq e (pop tgs))
  4178. (or (and (stringp (car e))
  4179. (assoc (car e) org-tag-alist))
  4180. (push e org-tag-alist)))))
  4181. ;; Compute the regular expressions and other local variables.
  4182. ;; Using `org-outline-regexp-bol' would complicate them much,
  4183. ;; because of the fixed white space at the end of that string.
  4184. (if (not org-done-keywords)
  4185. (setq org-done-keywords (and org-todo-keywords-1
  4186. (list (org-last org-todo-keywords-1)))))
  4187. (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
  4188. (length org-scheduled-string)
  4189. (length org-clock-string)
  4190. (length org-closed-string)))
  4191. org-drawer-regexp
  4192. (concat "^[ \t]*:\\("
  4193. (mapconcat 'regexp-quote org-drawers "\\|")
  4194. "\\):[ \t]*$")
  4195. org-not-done-keywords
  4196. (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
  4197. org-todo-regexp
  4198. (concat "\\("
  4199. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  4200. "\\)")
  4201. org-not-done-regexp
  4202. (concat "\\("
  4203. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  4204. "\\)")
  4205. org-not-done-heading-regexp
  4206. (format org-heading-keyword-regexp-format org-not-done-regexp)
  4207. org-todo-line-regexp
  4208. (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
  4209. org-complex-heading-regexp
  4210. (concat "^\\(\\*+\\)"
  4211. "\\(?: +" org-todo-regexp "\\)?"
  4212. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4213. "\\(?: +\\(.*?\\)\\)?"
  4214. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
  4215. "[ \t]*$")
  4216. org-complex-heading-regexp-format
  4217. (concat "^\\(\\*+\\)"
  4218. "\\(?: +" org-todo-regexp "\\)?"
  4219. "\\(?: +\\(\\[#.\\]\\)\\)?"
  4220. "\\(?: +"
  4221. ;; Stats cookies can be stuck to body.
  4222. "\\(?:\\[[0-9%%/]+\\] *\\)?"
  4223. "\\(%s\\)"
  4224. "\\(?: *\\[[0-9%%/]+\\]\\)?"
  4225. "\\)"
  4226. (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
  4227. "[ \t]*$")
  4228. org-todo-line-tags-regexp
  4229. (concat "^\\(\\*+\\)"
  4230. "\\(?: +" org-todo-regexp "\\)?"
  4231. "\\(?: +\\(.*?\\)\\)?"
  4232. (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
  4233. "[ \t]*$")
  4234. org-deadline-regexp (concat "\\<" org-deadline-string)
  4235. org-deadline-time-regexp
  4236. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  4237. org-deadline-line-regexp
  4238. (concat "\\<\\(" org-deadline-string "\\).*")
  4239. org-scheduled-regexp
  4240. (concat "\\<" org-scheduled-string)
  4241. org-scheduled-time-regexp
  4242. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  4243. org-closed-time-regexp
  4244. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  4245. org-keyword-time-regexp
  4246. (concat "\\<\\(" org-scheduled-string
  4247. "\\|" org-deadline-string
  4248. "\\|" org-closed-string
  4249. "\\|" org-clock-string "\\)"
  4250. " *[[<]\\([^]>]+\\)[]>]")
  4251. org-keyword-time-not-clock-regexp
  4252. (concat "\\<\\(" org-scheduled-string
  4253. "\\|" org-deadline-string
  4254. "\\|" org-closed-string
  4255. "\\)"
  4256. " *[[<]\\([^]>]+\\)[]>]")
  4257. org-maybe-keyword-time-regexp
  4258. (concat "\\(\\<\\(" org-scheduled-string
  4259. "\\|" org-deadline-string
  4260. "\\|" org-closed-string
  4261. "\\|" org-clock-string "\\)\\)?"
  4262. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
  4263. org-planning-or-clock-line-re
  4264. (concat "^[ \t]*\\("
  4265. org-scheduled-string "\\|"
  4266. org-deadline-string "\\|"
  4267. org-closed-string "\\|"
  4268. org-clock-string "\\)")
  4269. org-all-time-keywords
  4270. (mapcar (lambda (w) (substring w 0 -1))
  4271. (list org-scheduled-string org-deadline-string
  4272. org-clock-string org-closed-string))
  4273. )
  4274. (org-compute-latex-and-specials-regexp)
  4275. (org-set-font-lock-defaults))))
  4276. (defun org-file-contents (file &optional noerror)
  4277. "Return the contents of FILE, as a string."
  4278. (if (or (not file)
  4279. (not (file-readable-p file)))
  4280. (if noerror
  4281. (progn
  4282. (message "Cannot read file \"%s\"" file)
  4283. (ding) (sit-for 2)
  4284. "")
  4285. (error "Cannot read file \"%s\"" file))
  4286. (with-temp-buffer
  4287. (insert-file-contents file)
  4288. (buffer-string))))
  4289. (defun org-extract-log-state-settings (x)
  4290. "Extract the log state setting from a TODO keyword string.
  4291. This will extract info from a string like \"WAIT(w@/!)\"."
  4292. (let (kw key log1 log2)
  4293. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  4294. (setq kw (match-string 1 x)
  4295. key (and (match-end 2) (match-string 2 x))
  4296. log1 (and (match-end 3) (match-string 3 x))
  4297. log2 (and (match-end 4) (match-string 4 x)))
  4298. (and (or log1 log2)
  4299. (list kw
  4300. (and log1 (if (equal log1 "!") 'time 'note))
  4301. (and log2 (if (equal log2 "!") 'time 'note)))))))
  4302. (defun org-remove-keyword-keys (list)
  4303. "Remove a pair of parenthesis at the end of each string in LIST."
  4304. (mapcar (lambda (x)
  4305. (if (string-match "(.*)$" x)
  4306. (substring x 0 (match-beginning 0))
  4307. x))
  4308. list))
  4309. (defun org-assign-fast-keys (alist)
  4310. "Assign fast keys to a keyword-key alist.
  4311. Respect keys that are already there."
  4312. (let (new e (alt ?0))
  4313. (while (setq e (pop alist))
  4314. (if (or (memq (car e) '(:newline :endgroup :startgroup))
  4315. (cdr e)) ;; Key already assigned.
  4316. (push e new)
  4317. (let ((clist (string-to-list (downcase (car e))))
  4318. (used (append new alist)))
  4319. (when (= (car clist) ?@)
  4320. (pop clist))
  4321. (while (and clist (rassoc (car clist) used))
  4322. (pop clist))
  4323. (unless clist
  4324. (while (rassoc alt used)
  4325. (incf alt)))
  4326. (push (cons (car e) (or (car clist) alt)) new))))
  4327. (nreverse new)))
  4328. ;;; Some variables used in various places
  4329. (defvar org-window-configuration nil
  4330. "Used in various places to store a window configuration.")
  4331. (defvar org-selected-window nil
  4332. "Used in various places to store a window configuration.")
  4333. (defvar org-finish-function nil
  4334. "Function to be called when `C-c C-c' is used.
  4335. This is for getting out of special buffers like remember.")
  4336. ;; FIXME: Occasionally check by commenting these, to make sure
  4337. ;; no other functions uses these, forgetting to let-bind them.
  4338. (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
  4339. (defvar org-last-state)
  4340. (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  4341. ;; Defined somewhere in this file, but used before definition.
  4342. (defvar org-entities) ;; defined in org-entities.el
  4343. (defvar org-struct-menu)
  4344. (defvar org-org-menu)
  4345. (defvar org-tbl-menu)
  4346. ;;;; Define the Org-mode
  4347. (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
  4348. (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"))
  4349. ;; We use a before-change function to check if a table might need
  4350. ;; an update.
  4351. (defvar org-table-may-need-update t
  4352. "Indicates that a table might need an update.
  4353. This variable is set by `org-before-change-function'.
  4354. `org-table-align' sets it back to nil.")
  4355. (defun org-before-change-function (beg end)
  4356. "Every change indicates that a table might need an update."
  4357. (setq org-table-may-need-update t))
  4358. (defvar org-mode-map)
  4359. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  4360. (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
  4361. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  4362. (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
  4363. (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
  4364. (defvar org-table-buffer-is-an nil)
  4365. ;; `org-outline-regexp' ought to be a defconst but is let-binding in
  4366. ;; some places -- e.g. see the macro org-with-limited-levels.
  4367. ;;
  4368. ;; In Org buffers, the value of `outline-regexp' is that of
  4369. ;; `org-outline-regexp'. The only function still directly relying on
  4370. ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
  4371. ;; job when `orgstruct-mode' is active.
  4372. (defvar org-outline-regexp "\\*+ "
  4373. "Regexp to match Org headlines.")
  4374. (defconst org-outline-regexp-bol "^\\*+ "
  4375. "Regexp to match Org headlines.
  4376. This is similar to `org-outline-regexp' but additionally makes
  4377. sure that we are at the beginning of the line.")
  4378. (defconst org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
  4379. "Matches an headline, putting stars and text into groups.
  4380. Stars are put in group 1 and the trimmed body in group 2.")
  4381. (defvar bidi-paragraph-direction)
  4382. (defvar buffer-face-mode-face)
  4383. ;;;###autoload
  4384. (define-derived-mode org-mode outline-mode "Org"
  4385. "Outline-based notes management and organizer, alias
  4386. \"Carsten's outline-mode for keeping track of everything.\"
  4387. Org-mode develops organizational tasks around a NOTES file which
  4388. contains information about projects as plain text. Org-mode is
  4389. implemented on top of outline-mode, which is ideal to keep the content
  4390. of large files well structured. It supports ToDo items, deadlines and
  4391. time stamps, which magically appear in the diary listing of the Emacs
  4392. calendar. Tables are easily created with a built-in table editor.
  4393. Plain text URL-like links connect to websites, emails (VM), Usenet
  4394. messages (Gnus), BBDB entries, and any files related to the project.
  4395. For printing and sharing of notes, an Org-mode file (or a part of it)
  4396. can be exported as a structured ASCII or HTML file.
  4397. The following commands are available:
  4398. \\{org-mode-map}"
  4399. ;; Get rid of Outline menus, they are not needed
  4400. ;; Need to do this here because define-derived-mode sets up
  4401. ;; the keymap so late. Still, it is a waste to call this each time
  4402. ;; we switch another buffer into org-mode.
  4403. (if (featurep 'xemacs)
  4404. (when (boundp 'outline-mode-menu-heading)
  4405. ;; Assume this is Greg's port, it uses easymenu
  4406. (easy-menu-remove outline-mode-menu-heading)
  4407. (easy-menu-remove outline-mode-menu-show)
  4408. (easy-menu-remove outline-mode-menu-hide))
  4409. (define-key org-mode-map [menu-bar headings] 'undefined)
  4410. (define-key org-mode-map [menu-bar hide] 'undefined)
  4411. (define-key org-mode-map [menu-bar show] 'undefined))
  4412. (org-load-modules-maybe)
  4413. (easy-menu-add org-org-menu)
  4414. (easy-menu-add org-tbl-menu)
  4415. (org-install-agenda-files-menu)
  4416. (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
  4417. (add-to-invisibility-spec '(org-cwidth))
  4418. (add-to-invisibility-spec '(org-hide-block . t))
  4419. (when (featurep 'xemacs)
  4420. (org-set-local 'line-move-ignore-invisible t))
  4421. (org-set-local 'outline-regexp org-outline-regexp)
  4422. (org-set-local 'outline-level 'org-outline-level)
  4423. (setq bidi-paragraph-direction 'left-to-right)
  4424. (when (and org-ellipsis
  4425. (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
  4426. (fboundp 'make-glyph-code))
  4427. (unless org-display-table
  4428. (setq org-display-table (make-display-table)))
  4429. (set-display-table-slot
  4430. org-display-table 4
  4431. (vconcat (mapcar
  4432. (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
  4433. org-ellipsis)))
  4434. (if (stringp org-ellipsis) org-ellipsis "..."))))
  4435. (setq buffer-display-table org-display-table))
  4436. (org-set-regexps-and-options)
  4437. (when (and org-tag-faces (not org-tags-special-faces-re))
  4438. ;; tag faces set outside customize.... force initialization.
  4439. (org-set-tag-faces 'org-tag-faces org-tag-faces))
  4440. ;; Calc embedded
  4441. (org-set-local 'calc-embedded-open-mode "# ")
  4442. (modify-syntax-entry ?@ "w")
  4443. (if org-startup-truncated (setq truncate-lines t))
  4444. (org-set-local 'font-lock-unfontify-region-function
  4445. 'org-unfontify-region)
  4446. ;; Activate before-change-function
  4447. (org-set-local 'org-table-may-need-update t)
  4448. (org-add-hook 'before-change-functions 'org-before-change-function nil
  4449. 'local)
  4450. ;; Check for running clock before killing a buffer
  4451. (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  4452. ;; Paragraphs and auto-filling
  4453. (org-set-autofill-regexps)
  4454. (setq indent-line-function 'org-indent-line-function)
  4455. (org-update-radio-target-regexp)
  4456. ;; Beginning/end of defun
  4457. (org-set-local 'beginning-of-defun-function 'org-beginning-of-defun)
  4458. (org-set-local 'end-of-defun-function 'org-end-of-defun)
  4459. ;; Next error for sparse trees
  4460. (org-set-local 'next-error-function 'org-occur-next-match)
  4461. ;; Make sure dependence stuff works reliably, even for users who set it
  4462. ;; too late :-(
  4463. (if org-enforce-todo-dependencies
  4464. (add-hook 'org-blocker-hook
  4465. 'org-block-todo-from-children-or-siblings-or-parent)
  4466. (remove-hook 'org-blocker-hook
  4467. 'org-block-todo-from-children-or-siblings-or-parent))
  4468. (if org-enforce-todo-checkbox-dependencies
  4469. (add-hook 'org-blocker-hook
  4470. 'org-block-todo-from-checkboxes)
  4471. (remove-hook 'org-blocker-hook
  4472. 'org-block-todo-from-checkboxes))
  4473. ;; Comment characters
  4474. (org-set-local 'comment-start "#")
  4475. (org-set-local 'comment-padding " ")
  4476. ;; Align options lines
  4477. (org-set-local
  4478. 'align-mode-rules-list
  4479. '((org-in-buffer-settings
  4480. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  4481. (modes . '(org-mode)))))
  4482. ;; Imenu
  4483. (org-set-local 'imenu-create-index-function
  4484. 'org-imenu-get-tree)
  4485. ;; Make isearch reveal context
  4486. (if (or (featurep 'xemacs)
  4487. (not (boundp 'outline-isearch-open-invisible-function)))
  4488. ;; Emacs 21 and XEmacs make use of the hook
  4489. (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
  4490. ;; Emacs 22 deals with this through a special variable
  4491. (org-set-local 'outline-isearch-open-invisible-function
  4492. (lambda (&rest ignore) (org-show-context 'isearch))))
  4493. ;; Turn on org-beamer-mode?
  4494. (and org-startup-with-beamer-mode (org-beamer-mode 1))
  4495. ;; Setup the pcomplete hooks
  4496. (set (make-local-variable 'pcomplete-command-completion-function)
  4497. 'org-pcomplete-initial)
  4498. (set (make-local-variable 'pcomplete-command-name-function)
  4499. 'org-command-at-point)
  4500. (set (make-local-variable 'pcomplete-default-completion-function)
  4501. 'ignore)
  4502. (set (make-local-variable 'pcomplete-parse-arguments-function)
  4503. 'org-parse-arguments)
  4504. (set (make-local-variable 'pcomplete-termination-string) "")
  4505. (when (>= emacs-major-version 23)
  4506. (set (make-local-variable 'buffer-face-mode-face) 'org-default))
  4507. ;; If empty file that did not turn on org-mode automatically, make it to.
  4508. (if (and org-insert-mode-line-in-empty-file
  4509. (org-called-interactively-p 'any)
  4510. (= (point-min) (point-max)))
  4511. (insert "# -*- mode: org -*-\n\n"))
  4512. (unless org-inhibit-startup
  4513. (when org-startup-align-all-tables
  4514. (let ((bmp (buffer-modified-p)))
  4515. (org-table-map-tables 'org-table-align 'quietly)
  4516. (set-buffer-modified-p bmp)))
  4517. (when org-startup-with-inline-images
  4518. (org-display-inline-images))
  4519. (when org-startup-indented
  4520. (require 'org-indent)
  4521. (org-indent-mode 1))
  4522. (unless org-inhibit-startup-visibility-stuff
  4523. (org-set-startup-visibility))))
  4524. (when (fboundp 'abbrev-table-put)
  4525. (abbrev-table-put org-mode-abbrev-table
  4526. :parents (list text-mode-abbrev-table)))
  4527. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  4528. (defun org-current-time ()
  4529. "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
  4530. (if (> (car org-time-stamp-rounding-minutes) 1)
  4531. (let ((r (car org-time-stamp-rounding-minutes))
  4532. (time (decode-time)))
  4533. (apply 'encode-time
  4534. (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
  4535. (nthcdr 2 time))))
  4536. (current-time)))
  4537. (defun org-today ()
  4538. "Return today date, considering `org-extend-today-until'."
  4539. (time-to-days
  4540. (time-subtract (current-time)
  4541. (list 0 (* 3600 org-extend-today-until) 0))))
  4542. ;;;; Font-Lock stuff, including the activators
  4543. (defvar org-mouse-map (make-sparse-keymap))
  4544. (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
  4545. (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
  4546. (when org-mouse-1-follows-link
  4547. (org-defkey org-mouse-map [follow-link] 'mouse-face))
  4548. (when org-tab-follows-link
  4549. (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
  4550. (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
  4551. (require 'font-lock)
  4552. (defconst org-non-link-chars "]\t\n\r<>")
  4553. (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
  4554. "shell" "elisp" "doi" "message"))
  4555. (defvar org-link-types-re nil
  4556. "Matches a link that has a url-like prefix like \"http:\"")
  4557. (defvar org-link-re-with-space nil
  4558. "Matches a link with spaces, optional angular brackets around it.")
  4559. (defvar org-link-re-with-space2 nil
  4560. "Matches a link with spaces, optional angular brackets around it.")
  4561. (defvar org-link-re-with-space3 nil
  4562. "Matches a link with spaces, only for internal part in bracket links.")
  4563. (defvar org-angle-link-re nil
  4564. "Matches link with angular brackets, spaces are allowed.")
  4565. (defvar org-plain-link-re nil
  4566. "Matches plain link, without spaces.")
  4567. (defvar org-bracket-link-regexp nil
  4568. "Matches a link in double brackets.")
  4569. (defvar org-bracket-link-analytic-regexp nil
  4570. "Regular expression used to analyze links.
  4571. Here is what the match groups contain after a match:
  4572. 1: http:
  4573. 2: http
  4574. 3: path
  4575. 4: [desc]
  4576. 5: desc")
  4577. (defvar org-bracket-link-analytic-regexp++ nil
  4578. "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
  4579. (defvar org-any-link-re nil
  4580. "Regular expression matching any link.")
  4581. (defcustom org-match-sexp-depth 3
  4582. "Number of stacked braces for sub/superscript matching.
  4583. This has to be set before loading org.el to be effective."
  4584. :group 'org-export-translation ; ??????????????????????????/
  4585. :type 'integer)
  4586. (defun org-create-multibrace-regexp (left right n)
  4587. "Create a regular expression which will match a balanced sexp.
  4588. Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
  4589. as single character strings.
  4590. The regexp returned will match the entire expression including the
  4591. delimiters. It will also define a single group which contains the
  4592. match except for the outermost delimiters. The maximum depth of
  4593. stacked delimiters is N. Escaping delimiters is not possible."
  4594. (let* ((nothing (concat "[^" left right "]*?"))
  4595. (or "\\|")
  4596. (re nothing)
  4597. (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
  4598. (while (> n 1)
  4599. (setq n (1- n)
  4600. re (concat re or next)
  4601. next (concat "\\(?:" nothing left next right "\\)+" nothing)))
  4602. (concat left "\\(" re "\\)" right)))
  4603. (defvar org-match-substring-regexp
  4604. (concat
  4605. "\\([^\\]\\|^\\)\\([_^]\\)\\("
  4606. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4607. "\\|"
  4608. "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
  4609. "\\|"
  4610. "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
  4611. "The regular expression matching a sub- or superscript.")
  4612. (defvar org-match-substring-with-braces-regexp
  4613. (concat
  4614. "\\([^\\]\\|^\\)\\([_^]\\)\\("
  4615. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4616. "\\)")
  4617. "The regular expression matching a sub- or superscript, forcing braces.")
  4618. (defun org-make-link-regexps ()
  4619. "Update the link regular expressions.
  4620. This should be called after the variable `org-link-types' has changed."
  4621. (setq org-link-types-re
  4622. (concat
  4623. "\\`\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):")
  4624. org-link-re-with-space
  4625. (concat
  4626. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4627. "\\([^" org-non-link-chars " ]"
  4628. "[^" org-non-link-chars "]*"
  4629. "[^" org-non-link-chars " ]\\)>?")
  4630. org-link-re-with-space2
  4631. (concat
  4632. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4633. "\\([^" org-non-link-chars " ]"
  4634. "[^\t\n\r]*"
  4635. "[^" org-non-link-chars " ]\\)>?")
  4636. org-link-re-with-space3
  4637. (concat
  4638. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4639. "\\([^" org-non-link-chars " ]"
  4640. "[^\t\n\r]*\\)")
  4641. org-angle-link-re
  4642. (concat
  4643. "<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4644. "\\([^" org-non-link-chars " ]"
  4645. "[^" org-non-link-chars "]*"
  4646. "\\)>")
  4647. org-plain-link-re
  4648. (concat
  4649. "\\<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4650. (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
  4651. ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
  4652. org-bracket-link-regexp
  4653. "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
  4654. org-bracket-link-analytic-regexp
  4655. (concat
  4656. "\\[\\["
  4657. "\\(\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):\\)?"
  4658. "\\([^]]+\\)"
  4659. "\\]"
  4660. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4661. "\\]")
  4662. org-bracket-link-analytic-regexp++
  4663. (concat
  4664. "\\[\\["
  4665. "\\(\\(" (mapconcat 'regexp-quote (cons "coderef" org-link-types) "\\|") "\\):\\)?"
  4666. "\\([^]]+\\)"
  4667. "\\]"
  4668. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4669. "\\]")
  4670. org-any-link-re
  4671. (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
  4672. org-angle-link-re "\\)\\|\\("
  4673. org-plain-link-re "\\)")))
  4674. (org-make-link-regexps)
  4675. (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
  4676. "Regular expression for fast time stamp matching.")
  4677. (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
  4678. "Regular expression for fast time stamp matching.")
  4679. (defconst org-ts-regexp0
  4680. "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4681. "Regular expression matching time strings for analysis.
  4682. This one does not require the space after the date, so it can be used
  4683. on a string that terminates immediately after the date.")
  4684. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4685. "Regular expression matching time strings for analysis.")
  4686. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  4687. "Regular expression matching time stamps, with groups.")
  4688. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  4689. "Regular expression matching time stamps (also [..]), with groups.")
  4690. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  4691. "Regular expression matching a time stamp range.")
  4692. (defconst org-tr-regexp-both
  4693. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  4694. "Regular expression matching a time stamp range.")
  4695. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  4696. org-ts-regexp "\\)?")
  4697. "Regular expression matching a time stamp or time stamp range.")
  4698. (defconst org-tsr-regexp-both (concat org-ts-regexp-both "\\(--?-?"
  4699. org-ts-regexp-both "\\)?")
  4700. "Regular expression matching a time stamp or time stamp range.
  4701. The time stamps may be either active or inactive.")
  4702. (defvar org-emph-face nil)
  4703. (defun org-do-emphasis-faces (limit)
  4704. "Run through the buffer and add overlays to emphasized strings."
  4705. (let (rtn a)
  4706. (while (and (not rtn) (re-search-forward org-emph-re limit t))
  4707. (if (not (= (char-after (match-beginning 3))
  4708. (char-after (match-beginning 4))))
  4709. (progn
  4710. (setq rtn t)
  4711. (setq a (assoc (match-string 3) org-emphasis-alist))
  4712. (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
  4713. 'face
  4714. (nth 1 a))
  4715. (and (nth 4 a)
  4716. (org-remove-flyspell-overlays-in
  4717. (match-beginning 0) (match-end 0)))
  4718. (add-text-properties (match-beginning 2) (match-end 2)
  4719. '(font-lock-multiline t org-emphasis t))
  4720. (when org-hide-emphasis-markers
  4721. (add-text-properties (match-end 4) (match-beginning 5)
  4722. '(invisible org-link))
  4723. (add-text-properties (match-beginning 3) (match-end 3)
  4724. '(invisible org-link)))))
  4725. (backward-char 1))
  4726. rtn))
  4727. (defun org-emphasize (&optional char)
  4728. "Insert or change an emphasis, i.e. a font like bold or italic.
  4729. If there is an active region, change that region to a new emphasis.
  4730. If there is no region, just insert the marker characters and position
  4731. the cursor between them.
  4732. CHAR should be either the marker character, or the first character of the
  4733. HTML tag associated with that emphasis. If CHAR is a space, the means
  4734. to remove the emphasis of the selected region.
  4735. If char is not given (for example in an interactive call) it
  4736. will be prompted for."
  4737. (interactive)
  4738. (let ((eal org-emphasis-alist) e det
  4739. (erc org-emphasis-regexp-components)
  4740. (prompt "")
  4741. (string "") beg end move tag c s)
  4742. (if (org-region-active-p)
  4743. (setq beg (region-beginning) end (region-end)
  4744. string (buffer-substring beg end))
  4745. (setq move t))
  4746. (while (setq e (pop eal))
  4747. (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
  4748. c (aref tag 0))
  4749. (push (cons c (string-to-char (car e))) det)
  4750. (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
  4751. (substring tag 1)))))
  4752. (setq det (nreverse det))
  4753. (unless char
  4754. (message "%s" (concat "Emphasis marker or tag:" prompt))
  4755. (setq char (read-char-exclusive)))
  4756. (setq char (or (cdr (assoc char det)) char))
  4757. (if (equal char ?\ )
  4758. (setq s "" move nil)
  4759. (unless (assoc (char-to-string char) org-emphasis-alist)
  4760. (error "No such emphasis marker: \"%c\"" char))
  4761. (setq s (char-to-string char)))
  4762. (while (and (> (length string) 1)
  4763. (equal (substring string 0 1) (substring string -1))
  4764. (assoc (substring string 0 1) org-emphasis-alist))
  4765. (setq string (substring string 1 -1)))
  4766. (setq string (concat s string s))
  4767. (if beg (delete-region beg end))
  4768. (unless (or (bolp)
  4769. (string-match (concat "[" (nth 0 erc) "\n]")
  4770. (char-to-string (char-before (point)))))
  4771. (insert " "))
  4772. (unless (or (eobp)
  4773. (string-match (concat "[" (nth 1 erc) "\n]")
  4774. (char-to-string (char-after (point)))))
  4775. (insert " ") (backward-char 1))
  4776. (insert string)
  4777. (and move (backward-char 1))))
  4778. (defconst org-nonsticky-props
  4779. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
  4780. (defsubst org-rear-nonsticky-at (pos)
  4781. (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
  4782. (defun org-activate-plain-links (limit)
  4783. "Run through the buffer and add overlays to links."
  4784. (catch 'exit
  4785. (let (f)
  4786. (if (re-search-forward org-plain-link-re limit t)
  4787. (progn
  4788. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4789. (setq f (get-text-property (match-beginning 0) 'face))
  4790. (if (or (eq f 'org-tag)
  4791. (and (listp f) (memq 'org-tag f)))
  4792. nil
  4793. (add-text-properties (match-beginning 0) (match-end 0)
  4794. (list 'mouse-face 'highlight
  4795. 'face 'org-link
  4796. 'keymap org-mouse-map))
  4797. (org-rear-nonsticky-at (match-end 0)))
  4798. t)))))
  4799. (defun org-activate-code (limit)
  4800. (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
  4801. (progn
  4802. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4803. (remove-text-properties (match-beginning 0) (match-end 0)
  4804. '(display t invisible t intangible t))
  4805. t)))
  4806. (defcustom org-src-fontify-natively nil
  4807. "When non-nil, fontify code in code blocks."
  4808. :type 'boolean
  4809. :version "24.1"
  4810. :group 'org-appearance
  4811. :group 'org-babel)
  4812. (defcustom org-src-prevent-auto-filling nil
  4813. "When non-nil, prevent auto-filling in src blocks."
  4814. :type 'boolean
  4815. :version "24.1"
  4816. :group 'org-appearance
  4817. :group 'org-babel)
  4818. (defcustom org-allow-promoting-top-level-subtree nil
  4819. "When non-nil, allow promoting a top level subtree.
  4820. The leading star of the top level headline will be replaced
  4821. by a #."
  4822. :type 'boolean
  4823. :version "24.1"
  4824. :group 'org-appearance)
  4825. (defun org-fontify-meta-lines-and-blocks (limit)
  4826. (condition-case nil
  4827. (org-fontify-meta-lines-and-blocks-1 limit)
  4828. (error (message "org-mode fontification error"))))
  4829. (defun org-fontify-meta-lines-and-blocks-1 (limit)
  4830. "Fontify #+ lines and blocks, in the correct ways."
  4831. (let ((case-fold-search t))
  4832. (if (re-search-forward
  4833. "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
  4834. limit t)
  4835. (let ((beg (match-beginning 0))
  4836. (block-start (match-end 0))
  4837. (block-end nil)
  4838. (lang (match-string 7))
  4839. (beg1 (line-beginning-position 2))
  4840. (dc1 (downcase (match-string 2)))
  4841. (dc3 (downcase (match-string 3)))
  4842. end end1 quoting block-type ovl)
  4843. (cond
  4844. ((member dc1 '("html:" "ascii:" "latex:" "docbook:"))
  4845. ;; a single line of backend-specific content
  4846. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4847. (remove-text-properties (match-beginning 0) (match-end 0)
  4848. '(display t invisible t intangible t))
  4849. (add-text-properties (match-beginning 1) (match-end 3)
  4850. '(font-lock-fontified t face org-meta-line))
  4851. (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
  4852. '(font-lock-fontified t face org-block))
  4853. ; for backend-specific code
  4854. t)
  4855. ((and (match-end 4) (equal dc3 "begin"))
  4856. ;; Truly a block
  4857. (setq block-type (downcase (match-string 5))
  4858. quoting (member block-type org-protecting-blocks))
  4859. (when (re-search-forward
  4860. (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
  4861. nil t) ;; on purpose, we look further than LIMIT
  4862. (setq end (min (point-max) (match-end 0))
  4863. end1 (min (point-max) (1- (match-beginning 0))))
  4864. (setq block-end (match-beginning 0))
  4865. (when quoting
  4866. (remove-text-properties beg end
  4867. '(display t invisible t intangible t)))
  4868. (add-text-properties
  4869. beg end
  4870. '(font-lock-fontified t font-lock-multiline t))
  4871. (add-text-properties beg beg1 '(face org-meta-line))
  4872. (add-text-properties end1 (min (point-max) (1+ end))
  4873. '(face org-meta-line)) ; for end_src
  4874. (cond
  4875. ((and lang (not (string= lang "")) org-src-fontify-natively)
  4876. (org-src-font-lock-fontify-block lang block-start block-end)
  4877. ;; remove old background overlays
  4878. (mapc (lambda (ov)
  4879. (if (eq (overlay-get ov 'face) 'org-block-background)
  4880. (delete-overlay ov)))
  4881. (overlays-at (/ (+ beg1 block-end) 2)))
  4882. ;; add a background overlay
  4883. (setq ovl (make-overlay beg1 block-end))
  4884. (overlay-put ovl 'face 'org-block-background)
  4885. (overlay-put ovl 'evaporate t)) ;; make it go away when empty
  4886. (quoting
  4887. (add-text-properties beg1 (min (point-max) (1+ end1))
  4888. '(face org-block))) ; end of source block
  4889. ((not org-fontify-quote-and-verse-blocks))
  4890. ((string= block-type "quote")
  4891. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
  4892. ((string= block-type "verse")
  4893. (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
  4894. (add-text-properties beg beg1 '(face org-block-begin-line))
  4895. (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
  4896. '(face org-block-end-line))
  4897. t))
  4898. ((member dc1 '("title:" "author:" "email:" "date:"))
  4899. (add-text-properties
  4900. beg (match-end 3)
  4901. (if (member (intern (substring dc1 0 -1)) org-hidden-keywords)
  4902. '(font-lock-fontified t invisible t)
  4903. '(font-lock-fontified t face org-document-info-keyword)))
  4904. (add-text-properties
  4905. (match-beginning 6) (match-end 6)
  4906. (if (string-equal dc1 "title:")
  4907. '(font-lock-fontified t face org-document-title)
  4908. '(font-lock-fontified t face org-document-info))))
  4909. ((not (member (char-after beg) '(?\ ?\t)))
  4910. ;; just any other in-buffer setting, but not indented
  4911. (add-text-properties
  4912. beg (match-end 0)
  4913. '(font-lock-fontified t face org-meta-line))
  4914. t)
  4915. ((or (member dc1 '("begin:" "end:" "caption:" "label:"
  4916. "orgtbl:" "tblfm:" "tblname:" "results:"
  4917. "call:" "header:" "headers:" "name:"))
  4918. (and (match-end 4) (equal dc3 "attr")))
  4919. (add-text-properties
  4920. beg (match-end 0)
  4921. '(font-lock-fontified t face org-meta-line))
  4922. t)
  4923. ((member dc3 '(" " ""))
  4924. (add-text-properties
  4925. beg (match-end 0)
  4926. '(font-lock-fontified t face font-lock-comment-face)))
  4927. (t nil))))))
  4928. (defun org-strip-protective-commas (beg end)
  4929. "Strip protective commas between BEG and END in the current buffer."
  4930. (interactive "r")
  4931. (save-excursion
  4932. (save-match-data
  4933. (goto-char beg)
  4934. (let ((front-line (save-excursion
  4935. (re-search-forward
  4936. "[^[:space:]]" end t)
  4937. (goto-char (match-beginning 0))
  4938. (current-column))))
  4939. (while (re-search-forward "^[ \t]*\\(,\\)\\([*]\\|#\\+\\)" end t)
  4940. (goto-char (match-beginning 1))
  4941. (when (= (current-column) front-line)
  4942. (replace-match "" nil nil nil 1)))))))
  4943. (defun org-activate-angle-links (limit)
  4944. "Run through the buffer and add overlays to links."
  4945. (if (re-search-forward org-angle-link-re limit t)
  4946. (progn
  4947. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4948. (add-text-properties (match-beginning 0) (match-end 0)
  4949. (list 'mouse-face 'highlight
  4950. 'keymap org-mouse-map))
  4951. (org-rear-nonsticky-at (match-end 0))
  4952. t)))
  4953. (defun org-activate-footnote-links (limit)
  4954. "Run through the buffer and add overlays to footnotes."
  4955. (let ((fn (org-footnote-next-reference-or-definition limit)))
  4956. (when fn
  4957. (let ((beg (nth 1 fn)) (end (nth 2 fn)))
  4958. (org-remove-flyspell-overlays-in beg end)
  4959. (add-text-properties beg end
  4960. (list 'mouse-face 'highlight
  4961. 'keymap org-mouse-map
  4962. 'help-echo
  4963. (if (= (point-at-bol) beg)
  4964. "Footnote definition"
  4965. "Footnote reference")
  4966. 'font-lock-fontified t
  4967. 'font-lock-multiline t
  4968. 'face 'org-footnote))))))
  4969. (defun org-activate-bracket-links (limit)
  4970. "Run through the buffer and add overlays to bracketed links."
  4971. (if (re-search-forward org-bracket-link-regexp limit t)
  4972. (let* ((help (concat "LINK: "
  4973. (org-match-string-no-properties 1)))
  4974. ;; FIXME: above we should remove the escapes.
  4975. ;; but that requires another match, protecting match data,
  4976. ;; a lot of overhead for font-lock.
  4977. (ip (org-maybe-intangible
  4978. (list 'invisible 'org-link
  4979. 'keymap org-mouse-map 'mouse-face 'highlight
  4980. 'font-lock-multiline t 'help-echo help)))
  4981. (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
  4982. 'font-lock-multiline t 'help-echo help)))
  4983. ;; We need to remove the invisible property here. Table narrowing
  4984. ;; may have made some of this invisible.
  4985. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4986. (remove-text-properties (match-beginning 0) (match-end 0)
  4987. '(invisible nil))
  4988. (if (match-end 3)
  4989. (progn
  4990. (add-text-properties (match-beginning 0) (match-beginning 3) ip)
  4991. (org-rear-nonsticky-at (match-beginning 3))
  4992. (add-text-properties (match-beginning 3) (match-end 3) vp)
  4993. (org-rear-nonsticky-at (match-end 3))
  4994. (add-text-properties (match-end 3) (match-end 0) ip)
  4995. (org-rear-nonsticky-at (match-end 0)))
  4996. (add-text-properties (match-beginning 0) (match-beginning 1) ip)
  4997. (org-rear-nonsticky-at (match-beginning 1))
  4998. (add-text-properties (match-beginning 1) (match-end 1) vp)
  4999. (org-rear-nonsticky-at (match-end 1))
  5000. (add-text-properties (match-end 1) (match-end 0) ip)
  5001. (org-rear-nonsticky-at (match-end 0)))
  5002. t)))
  5003. (defun org-activate-dates (limit)
  5004. "Run through the buffer and add overlays to dates."
  5005. (if (re-search-forward org-tsr-regexp-both limit t)
  5006. (progn
  5007. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5008. (add-text-properties (match-beginning 0) (match-end 0)
  5009. (list 'mouse-face 'highlight
  5010. 'keymap org-mouse-map))
  5011. (org-rear-nonsticky-at (match-end 0))
  5012. (when org-display-custom-times
  5013. (if (match-end 3)
  5014. (org-display-custom-time (match-beginning 3) (match-end 3)))
  5015. (org-display-custom-time (match-beginning 1) (match-end 1)))
  5016. t)))
  5017. (defvar org-target-link-regexp nil
  5018. "Regular expression matching radio targets in plain text.")
  5019. (make-variable-buffer-local 'org-target-link-regexp)
  5020. (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
  5021. "Regular expression matching a link target.")
  5022. (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
  5023. "Regular expression matching a radio target.")
  5024. (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
  5025. "Regular expression matching any target.")
  5026. (defun org-activate-target-links (limit)
  5027. "Run through the buffer and add overlays to target matches."
  5028. (when org-target-link-regexp
  5029. (let ((case-fold-search t))
  5030. (if (re-search-forward org-target-link-regexp limit t)
  5031. (progn
  5032. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  5033. (add-text-properties (match-beginning 0) (match-end 0)
  5034. (list 'mouse-face 'highlight
  5035. 'keymap org-mouse-map
  5036. 'help-echo "Radio target link"
  5037. 'org-linked-text t))
  5038. (org-rear-nonsticky-at (match-end 0))
  5039. t)))))
  5040. (defun org-update-radio-target-regexp ()
  5041. "Find all radio targets in this file and update the regular expression."
  5042. (interactive)
  5043. (when (memq 'radio org-activate-links)
  5044. (setq org-target-link-regexp
  5045. (org-make-target-link-regexp (org-all-targets 'radio)))
  5046. (org-restart-font-lock)))
  5047. (defun org-hide-wide-columns (limit)
  5048. (let (s e)
  5049. (setq s (text-property-any (point) (or limit (point-max))
  5050. 'org-cwidth t))
  5051. (when s
  5052. (setq e (next-single-property-change s 'org-cwidth))
  5053. (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
  5054. (goto-char e)
  5055. t)))
  5056. (defvar org-latex-and-specials-regexp nil
  5057. "Regular expression for highlighting export special stuff.")
  5058. (defvar org-match-substring-regexp)
  5059. (defvar org-match-substring-with-braces-regexp)
  5060. ;; This should be with the exporter code, but we also use if for font-locking
  5061. (defconst org-export-html-special-string-regexps
  5062. '(("\\\\-" . "&shy;")
  5063. ("---\\([^-]\\)" . "&mdash;\\1")
  5064. ("--\\([^-]\\)" . "&ndash;\\1")
  5065. ("\\.\\.\\." . "&hellip;"))
  5066. "Regular expressions for special string conversion.")
  5067. (defun org-compute-latex-and-specials-regexp ()
  5068. "Compute regular expression for stuff treated specially by exporters."
  5069. (if (not org-highlight-latex-fragments-and-specials)
  5070. (org-set-local 'org-latex-and-specials-regexp nil)
  5071. (require 'org-exp)
  5072. (let*
  5073. ((matchers (plist-get org-format-latex-options :matchers))
  5074. (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
  5075. org-latex-regexps)))
  5076. (org-export-allow-BIND nil)
  5077. (options (org-combine-plists (org-default-export-plist)
  5078. (org-infile-export-plist)))
  5079. (org-export-with-sub-superscripts (plist-get options :sub-superscript))
  5080. (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
  5081. (org-export-with-TeX-macros (plist-get options :TeX-macros))
  5082. (org-export-html-expand (plist-get options :expand-quoted-html))
  5083. (org-export-with-special-strings (plist-get options :special-strings))
  5084. (re-sub
  5085. (cond
  5086. ((equal org-export-with-sub-superscripts '{})
  5087. (list org-match-substring-with-braces-regexp))
  5088. (org-export-with-sub-superscripts
  5089. (list org-match-substring-regexp))
  5090. (t nil)))
  5091. (re-latex
  5092. (if org-export-with-LaTeX-fragments
  5093. (mapcar (lambda (x) (nth 1 x)) latexs)))
  5094. (re-macros
  5095. (if org-export-with-TeX-macros
  5096. (list (concat "\\\\"
  5097. (regexp-opt
  5098. (append
  5099. (delq nil
  5100. (mapcar 'car-safe
  5101. (append org-entities-user
  5102. org-entities)))
  5103. (if (boundp 'org-latex-entities)
  5104. (mapcar (lambda (x)
  5105. (or (car-safe x) x))
  5106. org-latex-entities)
  5107. nil))
  5108. 'words))) ; FIXME
  5109. ))
  5110. ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
  5111. (re-special (if org-export-with-special-strings
  5112. (mapcar (lambda (x) (car x))
  5113. org-export-html-special-string-regexps)))
  5114. (re-rest
  5115. (delq nil
  5116. (list
  5117. (if org-export-html-expand "@<[^>\n]+>")
  5118. ))))
  5119. (org-set-local
  5120. 'org-latex-and-specials-regexp
  5121. (mapconcat 'identity (append re-latex re-sub re-macros re-special
  5122. re-rest) "\\|")))))
  5123. (defun org-do-latex-and-special-faces (limit)
  5124. "Run through the buffer and add overlays to links."
  5125. (when org-latex-and-specials-regexp
  5126. (let (rtn d)
  5127. (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
  5128. limit t))
  5129. (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
  5130. 'face))
  5131. '(org-code org-verbatim underline)))
  5132. (progn
  5133. (setq rtn t
  5134. d (cond ((member (char-after (1+ (match-beginning 0)))
  5135. '(?_ ?^)) 1)
  5136. (t 0)))
  5137. (font-lock-prepend-text-property
  5138. (+ d (match-beginning 0)) (match-end 0)
  5139. 'face 'org-latex-and-export-specials)
  5140. (add-text-properties (+ d (match-beginning 0)) (match-end 0)
  5141. '(font-lock-multiline t)))))
  5142. rtn)))
  5143. (defun org-restart-font-lock ()
  5144. "Restart `font-lock-mode', to force refontification."
  5145. (when (and (boundp 'font-lock-mode) font-lock-mode)
  5146. (font-lock-mode -1)
  5147. (font-lock-mode 1)))
  5148. (defun org-all-targets (&optional radio)
  5149. "Return a list of all targets in this file.
  5150. With optional argument RADIO, only find radio targets."
  5151. (let ((re (if radio org-radio-target-regexp org-target-regexp))
  5152. rtn)
  5153. (save-excursion
  5154. (goto-char (point-min))
  5155. (while (re-search-forward re nil t)
  5156. (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
  5157. rtn)))
  5158. (defun org-make-target-link-regexp (targets)
  5159. "Make regular expression matching all strings in TARGETS.
  5160. The regular expression finds the targets also if there is a line break
  5161. between words."
  5162. (and targets
  5163. (concat
  5164. "\\<\\("
  5165. (mapconcat
  5166. (lambda (x)
  5167. (setq x (regexp-quote x))
  5168. (while (string-match " +" x)
  5169. (setq x (replace-match "\\s-+" t t x)))
  5170. x)
  5171. targets
  5172. "\\|")
  5173. "\\)\\>")))
  5174. (defun org-activate-tags (limit)
  5175. (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
  5176. (progn
  5177. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  5178. (add-text-properties (match-beginning 1) (match-end 1)
  5179. (list 'mouse-face 'highlight
  5180. 'keymap org-mouse-map))
  5181. (org-rear-nonsticky-at (match-end 1))
  5182. t)))
  5183. (defun org-outline-level ()
  5184. "Compute the outline level of the heading at point.
  5185. This function assumes that the cursor is at the beginning of a line matched
  5186. by `outline-regexp'. Otherwise it returns garbage.
  5187. If this is called at a normal headline, the level is the number of stars.
  5188. Use `org-reduced-level' to remove the effect of `org-odd-levels'."
  5189. (save-excursion
  5190. (looking-at org-outline-regexp)
  5191. (1- (- (match-end 0) (match-beginning 0)))))
  5192. (defvar org-font-lock-keywords nil)
  5193. (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
  5194. "Regular expression matching a property line.")
  5195. (defvar org-font-lock-hook nil
  5196. "Functions to be called for special font lock stuff.")
  5197. (defvar org-font-lock-set-keywords-hook nil
  5198. "Functions that can manipulate `org-font-lock-extra-keywords'.
  5199. This is called after `org-font-lock-extra-keywords' is defined, but before
  5200. it is installed to be used by font lock. This can be useful if something
  5201. needs to be inserted at a specific position in the font-lock sequence.")
  5202. (defun org-font-lock-hook (limit)
  5203. (run-hook-with-args 'org-font-lock-hook limit))
  5204. (defun org-set-font-lock-defaults ()
  5205. (let* ((em org-fontify-emphasized-text)
  5206. (lk org-activate-links)
  5207. (org-font-lock-extra-keywords
  5208. (list
  5209. ;; Call the hook
  5210. '(org-font-lock-hook)
  5211. ;; Headlines
  5212. `(,(if org-fontify-whole-heading-line
  5213. "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
  5214. "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
  5215. (1 (org-get-level-face 1))
  5216. (2 (org-get-level-face 2))
  5217. (3 (org-get-level-face 3)))
  5218. ;; Table lines
  5219. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  5220. (1 'org-table t))
  5221. ;; Table internals
  5222. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  5223. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  5224. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  5225. '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
  5226. ;; Drawers
  5227. (list org-drawer-regexp '(0 'org-special-keyword t))
  5228. (list "^[ \t]*:END:" '(0 'org-special-keyword t))
  5229. ;; Properties
  5230. (list org-property-re
  5231. '(1 'org-special-keyword t)
  5232. '(3 'org-property-value t))
  5233. ;; Links
  5234. (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
  5235. (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
  5236. (if (memq 'plain lk) '(org-activate-plain-links))
  5237. (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
  5238. (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
  5239. (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
  5240. (if (memq 'footnote lk) '(org-activate-footnote-links))
  5241. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  5242. '(org-hide-wide-columns (0 nil append))
  5243. ;; TODO keyword
  5244. (list (format org-heading-keyword-regexp-format
  5245. org-todo-regexp)
  5246. '(2 (org-get-todo-face 2) t))
  5247. ;; DONE
  5248. (if org-fontify-done-headline
  5249. (list (format org-heading-keyword-regexp-format
  5250. (concat
  5251. "\\(?:"
  5252. (mapconcat 'regexp-quote org-done-keywords "\\|")
  5253. "\\)"))
  5254. '(2 'org-headline-done t))
  5255. nil)
  5256. ;; Priorities
  5257. '(org-font-lock-add-priority-faces)
  5258. ;; Tags
  5259. '(org-font-lock-add-tag-faces)
  5260. ;; Special keywords
  5261. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  5262. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  5263. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  5264. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  5265. ;; Emphasis
  5266. (if em
  5267. (if (featurep 'xemacs)
  5268. '(org-do-emphasis-faces (0 nil append))
  5269. '(org-do-emphasis-faces)))
  5270. ;; Checkboxes
  5271. '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
  5272. 1 'org-checkbox prepend)
  5273. (if (cdr (assq 'checkbox org-list-automatic-rules))
  5274. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  5275. (0 (org-get-checkbox-statistics-face) t)))
  5276. ;; Description list items
  5277. '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
  5278. 1 'org-list-dt prepend)
  5279. ;; ARCHIVEd headings
  5280. (list (concat
  5281. org-outline-regexp-bol
  5282. "\\(.*:" org-archive-tag ":.*\\)")
  5283. '(1 'org-archived prepend))
  5284. ;; Specials
  5285. '(org-do-latex-and-special-faces)
  5286. '(org-fontify-entities)
  5287. '(org-raise-scripts)
  5288. ;; Code
  5289. '(org-activate-code (1 'org-code t))
  5290. ;; COMMENT
  5291. (list (format org-heading-keyword-regexp-format
  5292. (concat "\\("
  5293. org-comment-string "\\|" org-quote-string
  5294. "\\)"))
  5295. '(2 'org-special-keyword t))
  5296. '("^#.*" (0 'font-lock-comment-face t))
  5297. ;; Blocks and meta lines
  5298. '(org-fontify-meta-lines-and-blocks)
  5299. )))
  5300. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  5301. (run-hooks 'org-font-lock-set-keywords-hook)
  5302. ;; Now set the full font-lock-keywords
  5303. (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
  5304. (org-set-local 'font-lock-defaults
  5305. '(org-font-lock-keywords t nil nil backward-paragraph))
  5306. (kill-local-variable 'font-lock-keywords) nil))
  5307. (defun org-toggle-pretty-entities ()
  5308. "Toggle the composition display of entities as UTF8 characters."
  5309. (interactive)
  5310. (org-set-local 'org-pretty-entities (not org-pretty-entities))
  5311. (org-restart-font-lock)
  5312. (if org-pretty-entities
  5313. (message "Entities are displayed as UTF8 characters")
  5314. (save-restriction
  5315. (widen)
  5316. (org-decompose-region (point-min) (point-max))
  5317. (message "Entities are displayed plain"))))
  5318. (defun org-fontify-entities (limit)
  5319. "Find an entity to fontify."
  5320. (let (ee)
  5321. (when org-pretty-entities
  5322. (catch 'match
  5323. (while (re-search-forward
  5324. "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
  5325. limit t)
  5326. (if (and (not (org-in-indented-comment-line))
  5327. (setq ee (org-entity-get (match-string 1)))
  5328. (= (length (nth 6 ee)) 1))
  5329. (let*
  5330. ((end (if (equal (match-string 2) "{}")
  5331. (match-end 2)
  5332. (match-end 1))))
  5333. (add-text-properties
  5334. (match-beginning 0) end
  5335. (list 'font-lock-fontified t))
  5336. (compose-region (match-beginning 0) end
  5337. (nth 6 ee) nil)
  5338. (backward-char 1)
  5339. (throw 'match t))))
  5340. nil))))
  5341. (defun org-fontify-like-in-org-mode (s &optional odd-levels)
  5342. "Fontify string S like in Org-mode."
  5343. (with-temp-buffer
  5344. (insert s)
  5345. (let ((org-odd-levels-only odd-levels))
  5346. (org-mode)
  5347. (font-lock-fontify-buffer)
  5348. (buffer-string))))
  5349. (defvar org-m nil)
  5350. (defvar org-l nil)
  5351. (defvar org-f nil)
  5352. (defun org-get-level-face (n)
  5353. "Get the right face for match N in font-lock matching of headlines."
  5354. (setq org-l (- (match-end 2) (match-beginning 1) 1))
  5355. (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
  5356. (if org-cycle-level-faces
  5357. (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
  5358. (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
  5359. (cond
  5360. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  5361. ((eq n 2) org-f)
  5362. (t (if org-level-color-stars-only nil org-f))))
  5363. (defun org-get-todo-face (kwd)
  5364. "Get the right face for a TODO keyword KWD.
  5365. If KWD is a number, get the corresponding match group."
  5366. (if (numberp kwd) (setq kwd (match-string kwd)))
  5367. (or (org-face-from-face-or-color
  5368. 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
  5369. (and (member kwd org-done-keywords) 'org-done)
  5370. 'org-todo))
  5371. (defun org-face-from-face-or-color (context inherit face-or-color)
  5372. "Create a face list that inherits INHERIT, but sets the foreground color.
  5373. When FACE-OR-COLOR is not a string, just return it."
  5374. (if (stringp face-or-color)
  5375. (list :inherit inherit
  5376. (cdr (assoc context org-faces-easy-properties))
  5377. face-or-color)
  5378. face-or-color))
  5379. (defun org-font-lock-add-tag-faces (limit)
  5380. "Add the special tag faces."
  5381. (when (and org-tag-faces org-tags-special-faces-re)
  5382. (while (re-search-forward org-tags-special-faces-re limit t)
  5383. (add-text-properties (match-beginning 1) (match-end 1)
  5384. (list 'face (org-get-tag-face 1)
  5385. 'font-lock-fontified t))
  5386. (backward-char 1))))
  5387. (defun org-font-lock-add-priority-faces (limit)
  5388. "Add the special priority faces."
  5389. (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
  5390. (when (save-match-data (org-at-heading-p))
  5391. (add-text-properties
  5392. (match-beginning 0) (match-end 0)
  5393. (list 'face (or (org-face-from-face-or-color
  5394. 'priority 'org-special-keyword
  5395. (cdr (assoc (char-after (match-beginning 1))
  5396. org-priority-faces)))
  5397. 'org-special-keyword)
  5398. 'font-lock-fontified t)))))
  5399. (defun org-get-tag-face (kwd)
  5400. "Get the right face for a TODO keyword KWD.
  5401. If KWD is a number, get the corresponding match group."
  5402. (if (numberp kwd) (setq kwd (match-string kwd)))
  5403. (or (org-face-from-face-or-color
  5404. 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
  5405. 'org-tag))
  5406. (defun org-unfontify-region (beg end &optional maybe_loudly)
  5407. "Remove fontification and activation overlays from links."
  5408. (font-lock-default-unfontify-region beg end)
  5409. (let* ((buffer-undo-list t)
  5410. (inhibit-read-only t) (inhibit-point-motion-hooks t)
  5411. (inhibit-modification-hooks t)
  5412. deactivate-mark buffer-file-name buffer-file-truename)
  5413. (org-decompose-region beg end)
  5414. (remove-text-properties beg end
  5415. '(mouse-face t keymap t org-linked-text t
  5416. invisible t intangible t
  5417. org-no-flyspell t org-emphasis t))
  5418. (org-remove-font-lock-display-properties beg end)))
  5419. (defconst org-script-display '(((raise -0.3) (height 0.7))
  5420. ((raise 0.3) (height 0.7))
  5421. ((raise -0.5))
  5422. ((raise 0.5)))
  5423. "Display properties for showing superscripts and subscripts.")
  5424. (defun org-remove-font-lock-display-properties (beg end)
  5425. "Remove specific display properties that have been added by font lock.
  5426. The will remove the raise properties that are used to show superscripts
  5427. and subscripts."
  5428. (let (next prop)
  5429. (while (< beg end)
  5430. (setq next (next-single-property-change beg 'display nil end)
  5431. prop (get-text-property beg 'display))
  5432. (if (member prop org-script-display)
  5433. (put-text-property beg next 'display nil))
  5434. (setq beg next))))
  5435. (defun org-raise-scripts (limit)
  5436. "Add raise properties to sub/superscripts."
  5437. (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
  5438. (if (re-search-forward
  5439. (if (eq org-use-sub-superscripts t)
  5440. org-match-substring-regexp
  5441. org-match-substring-with-braces-regexp)
  5442. limit t)
  5443. (let* ((pos (point)) table-p comment-p
  5444. (mpos (match-beginning 3))
  5445. (emph-p (get-text-property mpos 'org-emphasis))
  5446. (link-p (get-text-property mpos 'mouse-face))
  5447. (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
  5448. (goto-char (point-at-bol))
  5449. (setq table-p (org-looking-at-p org-table-dataline-regexp)
  5450. comment-p (org-looking-at-p "[ \t]*#"))
  5451. (goto-char pos)
  5452. ;; FIXME: Should we go back one character here, for a_b^c
  5453. ;; (goto-char (1- pos)) ;????????????????????
  5454. (if (or comment-p emph-p link-p keyw-p)
  5455. t
  5456. (put-text-property (match-beginning 3) (match-end 0)
  5457. 'display
  5458. (if (equal (char-after (match-beginning 2)) ?^)
  5459. (nth (if table-p 3 1) org-script-display)
  5460. (nth (if table-p 2 0) org-script-display)))
  5461. (add-text-properties (match-beginning 2) (match-end 2)
  5462. (list 'invisible t
  5463. 'org-dwidth t 'org-dwidth-n 1))
  5464. (if (and (eq (char-after (match-beginning 3)) ?{)
  5465. (eq (char-before (match-end 3)) ?}))
  5466. (progn
  5467. (add-text-properties
  5468. (match-beginning 3) (1+ (match-beginning 3))
  5469. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
  5470. (add-text-properties
  5471. (1- (match-end 3)) (match-end 3)
  5472. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
  5473. t)))))
  5474. ;;;; Visibility cycling, including org-goto and indirect buffer
  5475. ;;; Cycling
  5476. (defvar org-cycle-global-status nil)
  5477. (make-variable-buffer-local 'org-cycle-global-status)
  5478. (defvar org-cycle-subtree-status nil)
  5479. (make-variable-buffer-local 'org-cycle-subtree-status)
  5480. ;;;###autoload
  5481. (defvar org-inlinetask-min-level)
  5482. (defun org-cycle (&optional arg)
  5483. "TAB-action and visibility cycling for Org-mode.
  5484. This is the command invoked in Org-mode by the TAB key. Its main purpose
  5485. is outline visibility cycling, but it also invokes other actions
  5486. in special contexts.
  5487. - When this function is called with a prefix argument, rotate the entire
  5488. buffer through 3 states (global cycling)
  5489. 1. OVERVIEW: Show only top-level headlines.
  5490. 2. CONTENTS: Show all headlines of all levels, but no body text.
  5491. 3. SHOW ALL: Show everything.
  5492. When called with two `C-u C-u' prefixes, switch to the startup visibility,
  5493. determined by the variable `org-startup-folded', and by any VISIBILITY
  5494. properties in the buffer.
  5495. When called with three `C-u C-u C-u' prefixed, show the entire buffer,
  5496. including any drawers.
  5497. - When inside a table, re-align the table and move to the next field.
  5498. - When point is at the beginning of a headline, rotate the subtree started
  5499. by this line through 3 different states (local cycling)
  5500. 1. FOLDED: Only the main headline is shown.
  5501. 2. CHILDREN: The main headline and the direct children are shown.
  5502. From this state, you can move to one of the children
  5503. and zoom in further.
  5504. 3. SUBTREE: Show the entire subtree, including body text.
  5505. If there is no subtree, switch directly from CHILDREN to FOLDED.
  5506. - When point is at the beginning of an empty headline and the variable
  5507. `org-cycle-level-after-item/entry-creation' is set, cycle the level
  5508. of the headline by demoting and promoting it to likely levels. This
  5509. speeds up creation document structure by pressing TAB once or several
  5510. times right after creating a new headline.
  5511. - When there is a numeric prefix, go up to a heading with level ARG, do
  5512. a `show-subtree' and return to the previous cursor position. If ARG
  5513. is negative, go up that many levels.
  5514. - When point is not at the beginning of a headline, execute the global
  5515. binding for TAB, which is re-indenting the line. See the option
  5516. `org-cycle-emulate-tab' for details.
  5517. - Special case: if point is at the beginning of the buffer and there is
  5518. no headline in line 1, this function will act as if called with prefix arg
  5519. (C-u TAB, same as S-TAB) also when called without prefix arg.
  5520. But only if also the variable `org-cycle-global-at-bob' is t."
  5521. (interactive "P")
  5522. (org-load-modules-maybe)
  5523. (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
  5524. (and org-cycle-level-after-item/entry-creation
  5525. (or (org-cycle-level)
  5526. (org-cycle-item-indentation))))
  5527. (let* ((limit-level
  5528. (or org-cycle-max-level
  5529. (and (boundp 'org-inlinetask-min-level)
  5530. org-inlinetask-min-level
  5531. (1- org-inlinetask-min-level))))
  5532. (nstars (and limit-level
  5533. (if org-odd-levels-only
  5534. (and limit-level (1- (* limit-level 2)))
  5535. limit-level)))
  5536. (org-outline-regexp
  5537. (if (not (derived-mode-p 'org-mode))
  5538. outline-regexp
  5539. (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
  5540. (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
  5541. (not (looking-at org-outline-regexp))))
  5542. (org-cycle-hook
  5543. (if bob-special
  5544. (delq 'org-optimize-window-after-visibility-change
  5545. (copy-sequence org-cycle-hook))
  5546. org-cycle-hook))
  5547. (pos (point)))
  5548. (if (or bob-special (equal arg '(4)))
  5549. ;; special case: use global cycling
  5550. (setq arg t))
  5551. (cond
  5552. ((equal arg '(16))
  5553. (setq last-command 'dummy)
  5554. (org-set-startup-visibility)
  5555. (message "Startup visibility, plus VISIBILITY properties"))
  5556. ((equal arg '(64))
  5557. (show-all)
  5558. (message "Entire buffer visible, including drawers"))
  5559. ;; Table: enter it or move to the next field.
  5560. ((org-at-table-p 'any)
  5561. (if (org-at-table.el-p)
  5562. (message "Use C-c ' to edit table.el tables")
  5563. (if arg (org-table-edit-field t)
  5564. (org-table-justify-field-maybe)
  5565. (call-interactively 'org-table-next-field))))
  5566. ((run-hook-with-args-until-success
  5567. 'org-tab-after-check-for-table-hook))
  5568. ;; Global cycling: delegate to `org-cycle-internal-global'.
  5569. ((eq arg t) (org-cycle-internal-global))
  5570. ;; Drawers: delegate to `org-flag-drawer'.
  5571. ((and org-drawers org-drawer-regexp
  5572. (save-excursion
  5573. (beginning-of-line 1)
  5574. (looking-at org-drawer-regexp)))
  5575. (org-flag-drawer ; toggle block visibility
  5576. (not (get-char-property (match-end 0) 'invisible))))
  5577. ;; Show-subtree, ARG levels up from here.
  5578. ((integerp arg)
  5579. (save-excursion
  5580. (org-back-to-heading)
  5581. (outline-up-heading (if (< arg 0) (- arg)
  5582. (- (funcall outline-level) arg)))
  5583. (org-show-subtree)))
  5584. ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
  5585. ((and (featurep 'org-inlinetask)
  5586. (org-inlinetask-at-task-p)
  5587. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5588. (org-inlinetask-toggle-visibility))
  5589. ((org-try-cdlatex-tab))
  5590. ;; At an item/headline: delegate to `org-cycle-internal-local'.
  5591. ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
  5592. (save-excursion (beginning-of-line 1)
  5593. (looking-at org-outline-regexp)))
  5594. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5595. (org-cycle-internal-local))
  5596. ;; From there: TAB emulation and template completion.
  5597. (buffer-read-only (org-back-to-heading))
  5598. ((run-hook-with-args-until-success
  5599. 'org-tab-after-check-for-cycling-hook))
  5600. ((org-try-structure-completion))
  5601. ((run-hook-with-args-until-success
  5602. 'org-tab-before-tab-emulation-hook))
  5603. ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
  5604. (or (not (bolp))
  5605. (not (looking-at org-outline-regexp))))
  5606. (call-interactively (global-key-binding "\t")))
  5607. ((if (and (memq org-cycle-emulate-tab '(white whitestart))
  5608. (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
  5609. (or (and (eq org-cycle-emulate-tab 'white)
  5610. (= (match-end 0) (point-at-eol)))
  5611. (and (eq org-cycle-emulate-tab 'whitestart)
  5612. (>= (match-end 0) pos))))
  5613. t
  5614. (eq org-cycle-emulate-tab t))
  5615. (call-interactively (global-key-binding "\t")))
  5616. (t (save-excursion
  5617. (org-back-to-heading)
  5618. (org-cycle)))))))
  5619. (defun org-cycle-internal-global ()
  5620. "Do the global cycling action."
  5621. ;; Hack to avoid display of messages for .org attachments in Gnus
  5622. (let ((ga (string-match "\\*fontification" (buffer-name))))
  5623. (cond
  5624. ((and (eq last-command this-command)
  5625. (eq org-cycle-global-status 'overview))
  5626. ;; We just created the overview - now do table of contents
  5627. ;; This can be slow in very large buffers, so indicate action
  5628. (run-hook-with-args 'org-pre-cycle-hook 'contents)
  5629. (unless ga (message "CONTENTS..."))
  5630. (org-content)
  5631. (unless ga (message "CONTENTS...done"))
  5632. (setq org-cycle-global-status 'contents)
  5633. (run-hook-with-args 'org-cycle-hook 'contents))
  5634. ((and (eq last-command this-command)
  5635. (eq org-cycle-global-status 'contents))
  5636. ;; We just showed the table of contents - now show everything
  5637. (run-hook-with-args 'org-pre-cycle-hook 'all)
  5638. (show-all)
  5639. (unless ga (message "SHOW ALL"))
  5640. (setq org-cycle-global-status 'all)
  5641. (run-hook-with-args 'org-cycle-hook 'all))
  5642. (t
  5643. ;; Default action: go to overview
  5644. (run-hook-with-args 'org-pre-cycle-hook 'overview)
  5645. (org-overview)
  5646. (unless ga (message "OVERVIEW"))
  5647. (setq org-cycle-global-status 'overview)
  5648. (run-hook-with-args 'org-cycle-hook 'overview)))))
  5649. (defun org-cycle-internal-local ()
  5650. "Do the local cycling action."
  5651. (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
  5652. ;; First, determine end of headline (EOH), end of subtree or item
  5653. ;; (EOS), and if item or heading has children (HAS-CHILDREN).
  5654. (save-excursion
  5655. (if (org-at-item-p)
  5656. (progn
  5657. (beginning-of-line)
  5658. (setq struct (org-list-struct))
  5659. (setq eoh (point-at-eol))
  5660. (setq eos (org-list-get-item-end-before-blank (point) struct))
  5661. (setq has-children (org-list-has-child-p (point) struct)))
  5662. (org-back-to-heading)
  5663. (setq eoh (save-excursion (outline-end-of-heading) (point)))
  5664. (setq eos (save-excursion
  5665. (org-end-of-subtree t)
  5666. (unless (eobp)
  5667. (skip-chars-forward " \t\n"))
  5668. (if (eobp) (point) (1- (point)))))
  5669. (setq has-children
  5670. (or (save-excursion
  5671. (let ((level (funcall outline-level)))
  5672. (outline-next-heading)
  5673. (and (org-at-heading-p t)
  5674. (> (funcall outline-level) level))))
  5675. (save-excursion
  5676. (org-list-search-forward (org-item-beginning-re) eos t)))))
  5677. ;; Determine end invisible part of buffer (EOL)
  5678. (beginning-of-line 2)
  5679. ;; XEmacs doesn't have `next-single-char-property-change'
  5680. (if (featurep 'xemacs)
  5681. (while (and (not (eobp)) ;; this is like `next-line'
  5682. (get-char-property (1- (point)) 'invisible))
  5683. (beginning-of-line 2))
  5684. (while (and (not (eobp)) ;; this is like `next-line'
  5685. (get-char-property (1- (point)) 'invisible))
  5686. (goto-char (next-single-char-property-change (point) 'invisible))
  5687. (and (eolp) (beginning-of-line 2))))
  5688. (setq eol (point)))
  5689. ;; Find out what to do next and set `this-command'
  5690. (cond
  5691. ((= eos eoh)
  5692. ;; Nothing is hidden behind this heading
  5693. (run-hook-with-args 'org-pre-cycle-hook 'empty)
  5694. (message "EMPTY ENTRY")
  5695. (setq org-cycle-subtree-status nil)
  5696. (save-excursion
  5697. (goto-char eos)
  5698. (outline-next-heading)
  5699. (if (outline-invisible-p) (org-flag-heading nil))))
  5700. ((and (or (>= eol eos)
  5701. (not (string-match "\\S-" (buffer-substring eol eos))))
  5702. (or has-children
  5703. (not (setq children-skipped
  5704. org-cycle-skip-children-state-if-no-children))))
  5705. ;; Entire subtree is hidden in one line: children view
  5706. (run-hook-with-args 'org-pre-cycle-hook 'children)
  5707. (if (org-at-item-p)
  5708. (org-list-set-item-visibility (point-at-bol) struct 'children)
  5709. (org-show-entry)
  5710. (org-with-limited-levels (show-children))
  5711. ;; FIXME: This slows down the func way too much.
  5712. ;; How keep drawers hidden in subtree anyway?
  5713. ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
  5714. ;; (org-cycle-hide-drawers 'subtree))
  5715. ;; Fold every list in subtree to top-level items.
  5716. (when (eq org-cycle-include-plain-lists 'integrate)
  5717. (save-excursion
  5718. (org-back-to-heading)
  5719. (while (org-list-search-forward (org-item-beginning-re) eos t)
  5720. (beginning-of-line 1)
  5721. (let* ((struct (org-list-struct))
  5722. (prevs (org-list-prevs-alist struct))
  5723. (end (org-list-get-bottom-point struct)))
  5724. (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
  5725. (org-list-get-all-items (point) struct prevs))
  5726. (goto-char end))))))
  5727. (message "CHILDREN")
  5728. (save-excursion
  5729. (goto-char eos)
  5730. (outline-next-heading)
  5731. (if (outline-invisible-p) (org-flag-heading nil)))
  5732. (setq org-cycle-subtree-status 'children)
  5733. (run-hook-with-args 'org-cycle-hook 'children))
  5734. ((or children-skipped
  5735. (and (eq last-command this-command)
  5736. (eq org-cycle-subtree-status 'children)))
  5737. ;; We just showed the children, or no children are there,
  5738. ;; now show everything.
  5739. (run-hook-with-args 'org-pre-cycle-hook 'subtree)
  5740. (outline-flag-region eoh eos nil)
  5741. (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
  5742. (setq org-cycle-subtree-status 'subtree)
  5743. (run-hook-with-args 'org-cycle-hook 'subtree))
  5744. (t
  5745. ;; Default action: hide the subtree.
  5746. (run-hook-with-args 'org-pre-cycle-hook 'folded)
  5747. (outline-flag-region eoh eos t)
  5748. (message "FOLDED")
  5749. (setq org-cycle-subtree-status 'folded)
  5750. (run-hook-with-args 'org-cycle-hook 'folded)))))
  5751. ;;;###autoload
  5752. (defun org-global-cycle (&optional arg)
  5753. "Cycle the global visibility. For details see `org-cycle'.
  5754. With \\[universal-argument] prefix arg, switch to startup visibility.
  5755. With a numeric prefix, show all headlines up to that level."
  5756. (interactive "P")
  5757. (let ((org-cycle-include-plain-lists
  5758. (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
  5759. (cond
  5760. ((integerp arg)
  5761. (show-all)
  5762. (hide-sublevels arg)
  5763. (setq org-cycle-global-status 'contents))
  5764. ((equal arg '(4))
  5765. (org-set-startup-visibility)
  5766. (message "Startup visibility, plus VISIBILITY properties."))
  5767. (t
  5768. (org-cycle '(4))))))
  5769. (defun org-set-startup-visibility ()
  5770. "Set the visibility required by startup options and properties."
  5771. (cond
  5772. ((eq org-startup-folded t)
  5773. (org-cycle '(4)))
  5774. ((eq org-startup-folded 'content)
  5775. (let ((this-command 'org-cycle) (last-command 'org-cycle))
  5776. (org-cycle '(4)) (org-cycle '(4)))))
  5777. (unless (eq org-startup-folded 'showeverything)
  5778. (if org-hide-block-startup (org-hide-block-all))
  5779. (org-set-visibility-according-to-property 'no-cleanup)
  5780. (org-cycle-hide-archived-subtrees 'all)
  5781. (org-cycle-hide-drawers 'all)
  5782. (org-cycle-show-empty-lines t)))
  5783. (defun org-set-visibility-according-to-property (&optional no-cleanup)
  5784. "Switch subtree visibilities according to :VISIBILITY: property."
  5785. (interactive)
  5786. (let (org-show-entry-below state)
  5787. (save-excursion
  5788. (goto-char (point-min))
  5789. (while (re-search-forward
  5790. "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
  5791. nil t)
  5792. (setq state (match-string 1))
  5793. (save-excursion
  5794. (org-back-to-heading t)
  5795. (hide-subtree)
  5796. (org-reveal)
  5797. (cond
  5798. ((equal state '("fold" "folded"))
  5799. (hide-subtree))
  5800. ((equal state "children")
  5801. (org-show-hidden-entry)
  5802. (show-children))
  5803. ((equal state "content")
  5804. (save-excursion
  5805. (save-restriction
  5806. (org-narrow-to-subtree)
  5807. (org-content))))
  5808. ((member state '("all" "showall"))
  5809. (show-subtree)))))
  5810. (unless no-cleanup
  5811. (org-cycle-hide-archived-subtrees 'all)
  5812. (org-cycle-hide-drawers 'all)
  5813. (org-cycle-show-empty-lines 'all)))))
  5814. ;; This function uses outline-regexp instead of the more fundamental
  5815. ;; org-outline-regexp so that org-cycle-global works outside of Org
  5816. ;; buffers, where outline-regexp is needed.
  5817. (defun org-overview ()
  5818. "Switch to overview mode, showing only top-level headlines.
  5819. Really, this shows all headlines with level equal or greater than the level
  5820. of the first headline in the buffer. This is important, because if the
  5821. first headline is not level one, then (hide-sublevels 1) gives confusing
  5822. results."
  5823. (interactive)
  5824. (let ((level (save-excursion
  5825. (goto-char (point-min))
  5826. (if (re-search-forward (concat "^" outline-regexp) nil t)
  5827. (progn
  5828. (goto-char (match-beginning 0))
  5829. (funcall outline-level))))))
  5830. (and level (hide-sublevels level))))
  5831. (defun org-content (&optional arg)
  5832. "Show all headlines in the buffer, like a table of contents.
  5833. With numerical argument N, show content up to level N."
  5834. (interactive "P")
  5835. (save-excursion
  5836. ;; Visit all headings and show their offspring
  5837. (and (integerp arg) (org-overview))
  5838. (goto-char (point-max))
  5839. (catch 'exit
  5840. (while (and (progn (condition-case nil
  5841. (outline-previous-visible-heading 1)
  5842. (error (goto-char (point-min))))
  5843. t)
  5844. (looking-at org-outline-regexp))
  5845. (if (integerp arg)
  5846. (show-children (1- arg))
  5847. (show-branches))
  5848. (if (bobp) (throw 'exit nil))))))
  5849. (defun org-optimize-window-after-visibility-change (state)
  5850. "Adjust the window after a change in outline visibility.
  5851. This function is the default value of the hook `org-cycle-hook'."
  5852. (when (get-buffer-window (current-buffer))
  5853. (cond
  5854. ((eq state 'content) nil)
  5855. ((eq state 'all) nil)
  5856. ((eq state 'folded) nil)
  5857. ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
  5858. ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
  5859. (defun org-remove-empty-overlays-at (pos)
  5860. "Remove outline overlays that do not contain non-white stuff."
  5861. (mapc
  5862. (lambda (o)
  5863. (and (eq 'outline (overlay-get o 'invisible))
  5864. (not (string-match "\\S-" (buffer-substring (overlay-start o)
  5865. (overlay-end o))))
  5866. (delete-overlay o)))
  5867. (overlays-at pos)))
  5868. (defun org-clean-visibility-after-subtree-move ()
  5869. "Fix visibility issues after moving a subtree."
  5870. ;; First, find a reasonable region to look at:
  5871. ;; Start two siblings above, end three below
  5872. (let* ((beg (save-excursion
  5873. (and (org-get-last-sibling)
  5874. (org-get-last-sibling))
  5875. (point)))
  5876. (end (save-excursion
  5877. (and (org-get-next-sibling)
  5878. (org-get-next-sibling)
  5879. (org-get-next-sibling))
  5880. (if (org-at-heading-p)
  5881. (point-at-eol)
  5882. (point))))
  5883. (level (looking-at "\\*+"))
  5884. (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
  5885. (save-excursion
  5886. (save-restriction
  5887. (narrow-to-region beg end)
  5888. (when re
  5889. ;; Properly fold already folded siblings
  5890. (goto-char (point-min))
  5891. (while (re-search-forward re nil t)
  5892. (if (and (not (outline-invisible-p))
  5893. (save-excursion
  5894. (goto-char (point-at-eol)) (outline-invisible-p)))
  5895. (hide-entry))))
  5896. (org-cycle-show-empty-lines 'overview)
  5897. (org-cycle-hide-drawers 'overview)))))
  5898. (defun org-cycle-show-empty-lines (state)
  5899. "Show empty lines above all visible headlines.
  5900. The region to be covered depends on STATE when called through
  5901. `org-cycle-hook'. Lisp program can use t for STATE to get the
  5902. entire buffer covered. Note that an empty line is only shown if there
  5903. are at least `org-cycle-separator-lines' empty lines before the headline."
  5904. (when (not (= org-cycle-separator-lines 0))
  5905. (save-excursion
  5906. (let* ((n (abs org-cycle-separator-lines))
  5907. (re (cond
  5908. ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
  5909. ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
  5910. (t (let ((ns (number-to-string (- n 2))))
  5911. (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
  5912. "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
  5913. beg end b e)
  5914. (cond
  5915. ((memq state '(overview contents t))
  5916. (setq beg (point-min) end (point-max)))
  5917. ((memq state '(children folded))
  5918. (setq beg (point) end (progn (org-end-of-subtree t t)
  5919. (beginning-of-line 2)
  5920. (point)))))
  5921. (when beg
  5922. (goto-char beg)
  5923. (while (re-search-forward re end t)
  5924. (unless (get-char-property (match-end 1) 'invisible)
  5925. (setq e (match-end 1))
  5926. (if (< org-cycle-separator-lines 0)
  5927. (setq b (save-excursion
  5928. (goto-char (match-beginning 0))
  5929. (org-back-over-empty-lines)
  5930. (if (save-excursion
  5931. (goto-char (max (point-min) (1- (point))))
  5932. (org-at-heading-p))
  5933. (1- (point))
  5934. (point))))
  5935. (setq b (match-beginning 1)))
  5936. (outline-flag-region b e nil)))))))
  5937. ;; Never hide empty lines at the end of the file.
  5938. (save-excursion
  5939. (goto-char (point-max))
  5940. (outline-previous-heading)
  5941. (outline-end-of-heading)
  5942. (if (and (looking-at "[ \t\n]+")
  5943. (= (match-end 0) (point-max)))
  5944. (outline-flag-region (point) (match-end 0) nil))))
  5945. (defun org-show-empty-lines-in-parent ()
  5946. "Move to the parent and re-show empty lines before visible headlines."
  5947. (save-excursion
  5948. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  5949. (org-cycle-show-empty-lines context))))
  5950. (defun org-files-list ()
  5951. "Return `org-agenda-files' list, plus all open org-mode files.
  5952. This is useful for operations that need to scan all of a user's
  5953. open and agenda-wise Org files."
  5954. (let ((files (mapcar 'expand-file-name (org-agenda-files))))
  5955. (dolist (buf (buffer-list))
  5956. (with-current-buffer buf
  5957. (if (and (derived-mode-p 'org-mode) (buffer-file-name))
  5958. (let ((file (expand-file-name (buffer-file-name))))
  5959. (unless (member file files)
  5960. (push file files))))))
  5961. files))
  5962. (defsubst org-entry-beginning-position ()
  5963. "Return the beginning position of the current entry."
  5964. (save-excursion (outline-back-to-heading t) (point)))
  5965. (defsubst org-entry-end-position ()
  5966. "Return the end position of the current entry."
  5967. (save-excursion (outline-next-heading) (point)))
  5968. (defun org-cycle-hide-drawers (state)
  5969. "Re-hide all drawers after a visibility state change."
  5970. (when (and (derived-mode-p 'org-mode)
  5971. (not (memq state '(overview folded contents))))
  5972. (save-excursion
  5973. (let* ((globalp (memq state '(contents all)))
  5974. (beg (if globalp (point-min) (point)))
  5975. (end (if globalp (point-max)
  5976. (if (eq state 'children)
  5977. (save-excursion (outline-next-heading) (point))
  5978. (org-end-of-subtree t)))))
  5979. (goto-char beg)
  5980. (while (re-search-forward org-drawer-regexp end t)
  5981. (org-flag-drawer t))))))
  5982. (defun org-flag-drawer (flag)
  5983. (save-excursion
  5984. (beginning-of-line 1)
  5985. (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
  5986. (let ((b (match-end 0)))
  5987. (if (re-search-forward
  5988. "^[ \t]*:END:"
  5989. (save-excursion (outline-next-heading) (point)) t)
  5990. (outline-flag-region b (point-at-eol) flag)
  5991. (error ":END: line missing at position %s" b))))))
  5992. (defun org-subtree-end-visible-p ()
  5993. "Is the end of the current subtree visible?"
  5994. (pos-visible-in-window-p
  5995. (save-excursion (org-end-of-subtree t) (point))))
  5996. (defun org-first-headline-recenter (&optional N)
  5997. "Move cursor to the first headline and recenter the headline.
  5998. Optional argument N means put the headline into the Nth line of the window."
  5999. (goto-char (point-min))
  6000. (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
  6001. (beginning-of-line)
  6002. (recenter (prefix-numeric-value N))))
  6003. ;;; Saving and restoring visibility
  6004. (defun org-outline-overlay-data (&optional use-markers)
  6005. "Return a list of the locations of all outline overlays.
  6006. These are overlays with the `invisible' property value `outline'.
  6007. The return value is a list of cons cells, with start and stop
  6008. positions for each overlay.
  6009. If USE-MARKERS is set, return the positions as markers."
  6010. (let (beg end)
  6011. (save-excursion
  6012. (save-restriction
  6013. (widen)
  6014. (delq nil
  6015. (mapcar (lambda (o)
  6016. (when (eq (overlay-get o 'invisible) 'outline)
  6017. (setq beg (overlay-start o)
  6018. end (overlay-end o))
  6019. (and beg end (> end beg)
  6020. (if use-markers
  6021. (cons (move-marker (make-marker) beg)
  6022. (move-marker (make-marker) end))
  6023. (cons beg end)))))
  6024. (overlays-in (point-min) (point-max))))))))
  6025. (defun org-set-outline-overlay-data (data)
  6026. "Create visibility overlays for all positions in DATA.
  6027. DATA should have been made by `org-outline-overlay-data'."
  6028. (let (o)
  6029. (save-excursion
  6030. (save-restriction
  6031. (widen)
  6032. (show-all)
  6033. (mapc (lambda (c)
  6034. (outline-flag-region (car c) (cdr c) t))
  6035. data)))))
  6036. ;;; Folding of blocks
  6037. (defvar org-hide-block-overlays nil
  6038. "Overlays hiding blocks.")
  6039. (make-variable-buffer-local 'org-hide-block-overlays)
  6040. (defun org-block-map (function &optional start end)
  6041. "Call FUNCTION at the head of all source blocks in the current buffer.
  6042. Optional arguments START and END can be used to limit the range."
  6043. (let ((start (or start (point-min)))
  6044. (end (or end (point-max))))
  6045. (save-excursion
  6046. (goto-char start)
  6047. (while (and (< (point) end) (re-search-forward org-block-regexp end t))
  6048. (save-excursion
  6049. (save-match-data
  6050. (goto-char (match-beginning 0))
  6051. (funcall function)))))))
  6052. (defun org-hide-block-toggle-all ()
  6053. "Toggle the visibility of all blocks in the current buffer."
  6054. (org-block-map #'org-hide-block-toggle))
  6055. (defun org-hide-block-all ()
  6056. "Fold all blocks in the current buffer."
  6057. (interactive)
  6058. (org-show-block-all)
  6059. (org-block-map #'org-hide-block-toggle-maybe))
  6060. (defun org-show-block-all ()
  6061. "Unfold all blocks in the current buffer."
  6062. (interactive)
  6063. (mapc 'delete-overlay org-hide-block-overlays)
  6064. (setq org-hide-block-overlays nil))
  6065. (defun org-hide-block-toggle-maybe ()
  6066. "Toggle visibility of block at point."
  6067. (interactive)
  6068. (let ((case-fold-search t))
  6069. (if (save-excursion
  6070. (beginning-of-line 1)
  6071. (looking-at org-block-regexp))
  6072. (progn (org-hide-block-toggle)
  6073. t) ;; to signal that we took action
  6074. nil))) ;; to signal that we did not
  6075. (defun org-hide-block-toggle (&optional force)
  6076. "Toggle the visibility of the current block."
  6077. (interactive)
  6078. (save-excursion
  6079. (beginning-of-line)
  6080. (if (re-search-forward org-block-regexp nil t)
  6081. (let ((start (- (match-beginning 4) 1)) ;; beginning of body
  6082. (end (match-end 0)) ;; end of entire body
  6083. ov)
  6084. (if (memq t (mapcar (lambda (overlay)
  6085. (eq (overlay-get overlay 'invisible)
  6086. 'org-hide-block))
  6087. (overlays-at start)))
  6088. (if (or (not force) (eq force 'off))
  6089. (mapc (lambda (ov)
  6090. (when (member ov org-hide-block-overlays)
  6091. (setq org-hide-block-overlays
  6092. (delq ov org-hide-block-overlays)))
  6093. (when (eq (overlay-get ov 'invisible)
  6094. 'org-hide-block)
  6095. (delete-overlay ov)))
  6096. (overlays-at start)))
  6097. (setq ov (make-overlay start end))
  6098. (overlay-put ov 'invisible 'org-hide-block)
  6099. ;; make the block accessible to isearch
  6100. (overlay-put
  6101. ov 'isearch-open-invisible
  6102. (lambda (ov)
  6103. (when (member ov org-hide-block-overlays)
  6104. (setq org-hide-block-overlays
  6105. (delq ov org-hide-block-overlays)))
  6106. (when (eq (overlay-get ov 'invisible)
  6107. 'org-hide-block)
  6108. (delete-overlay ov))))
  6109. (push ov org-hide-block-overlays)))
  6110. (error "Not looking at a source block"))))
  6111. ;; org-tab-after-check-for-cycling-hook
  6112. (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
  6113. ;; Remove overlays when changing major mode
  6114. (add-hook 'org-mode-hook
  6115. (lambda () (org-add-hook 'change-major-mode-hook
  6116. 'org-show-block-all 'append 'local)))
  6117. ;;; Org-goto
  6118. (defvar org-goto-window-configuration nil)
  6119. (defvar org-goto-marker nil)
  6120. (defvar org-goto-map
  6121. (let ((map (make-sparse-keymap)))
  6122. (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
  6123. (while (setq cmd (pop cmds))
  6124. (substitute-key-definition cmd cmd map global-map)))
  6125. (suppress-keymap map)
  6126. (org-defkey map "\C-m" 'org-goto-ret)
  6127. (org-defkey map [(return)] 'org-goto-ret)
  6128. (org-defkey map [(left)] 'org-goto-left)
  6129. (org-defkey map [(right)] 'org-goto-right)
  6130. (org-defkey map [(control ?g)] 'org-goto-quit)
  6131. (org-defkey map "\C-i" 'org-cycle)
  6132. (org-defkey map [(tab)] 'org-cycle)
  6133. (org-defkey map [(down)] 'outline-next-visible-heading)
  6134. (org-defkey map [(up)] 'outline-previous-visible-heading)
  6135. (if org-goto-auto-isearch
  6136. (if (fboundp 'define-key-after)
  6137. (define-key-after map [t] 'org-goto-local-auto-isearch)
  6138. nil)
  6139. (org-defkey map "q" 'org-goto-quit)
  6140. (org-defkey map "n" 'outline-next-visible-heading)
  6141. (org-defkey map "p" 'outline-previous-visible-heading)
  6142. (org-defkey map "f" 'outline-forward-same-level)
  6143. (org-defkey map "b" 'outline-backward-same-level)
  6144. (org-defkey map "u" 'outline-up-heading))
  6145. (org-defkey map "/" 'org-occur)
  6146. (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
  6147. (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
  6148. (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
  6149. (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
  6150. (org-defkey map "\C-c\C-u" 'outline-up-heading)
  6151. map))
  6152. (defconst org-goto-help
  6153. "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
  6154. RET=jump to location [Q]uit and return to previous location
  6155. \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
  6156. (defvar org-goto-start-pos) ; dynamically scoped parameter
  6157. ;; FIXME: Docstring does not mention both interfaces
  6158. (defun org-goto (&optional alternative-interface)
  6159. "Look up a different location in the current file, keeping current visibility.
  6160. When you want look-up or go to a different location in a
  6161. document, the fastest way is often to fold the entire buffer and
  6162. then dive into the tree. This method has the disadvantage, that
  6163. the previous location will be folded, which may not be what you
  6164. want.
  6165. This command works around this by showing a copy of the current
  6166. buffer in an indirect buffer, in overview mode. You can dive
  6167. into the tree in that copy, use org-occur and incremental search
  6168. to find a location. When pressing RET or `Q', the command
  6169. returns to the original buffer in which the visibility is still
  6170. unchanged. After RET it will also jump to the location selected
  6171. in the indirect buffer and expose the headline hierarchy above.
  6172. With a prefix argument, use the alternative interface: e.g. if
  6173. `org-goto-interface' is 'outline use 'outline-path-completion."
  6174. (interactive "P")
  6175. (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
  6176. (org-refile-use-outline-path t)
  6177. (org-refile-target-verify-function nil)
  6178. (interface
  6179. (if (not alternative-interface)
  6180. org-goto-interface
  6181. (if (eq org-goto-interface 'outline)
  6182. 'outline-path-completion
  6183. 'outline)))
  6184. (org-goto-start-pos (point))
  6185. (selected-point
  6186. (if (eq interface 'outline)
  6187. (car (org-get-location (current-buffer) org-goto-help))
  6188. (let ((pa (org-refile-get-location "Goto" nil nil t)))
  6189. (org-refile-check-position pa)
  6190. (nth 3 pa)))))
  6191. (if selected-point
  6192. (progn
  6193. (org-mark-ring-push org-goto-start-pos)
  6194. (goto-char selected-point)
  6195. (if (or (outline-invisible-p) (org-invisible-p2))
  6196. (org-show-context 'org-goto)))
  6197. (message "Quit"))))
  6198. (defvar org-goto-selected-point nil) ; dynamically scoped parameter
  6199. (defvar org-goto-exit-command nil) ; dynamically scoped parameter
  6200. (defvar org-goto-local-auto-isearch-map) ; defined below
  6201. (defun org-get-location (buf help)
  6202. "Let the user select a location in the Org-mode buffer BUF.
  6203. This function uses a recursive edit. It returns the selected position
  6204. or nil."
  6205. (let ((isearch-mode-map org-goto-local-auto-isearch-map)
  6206. (isearch-hide-immediately nil)
  6207. (isearch-search-fun-function
  6208. (lambda () 'org-goto-local-search-headings))
  6209. (org-goto-selected-point org-goto-exit-command)
  6210. (pop-up-frames nil)
  6211. (special-display-buffer-names nil)
  6212. (special-display-regexps nil)
  6213. (special-display-function nil))
  6214. (save-excursion
  6215. (save-window-excursion
  6216. (delete-other-windows)
  6217. (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
  6218. (org-pop-to-buffer-same-window
  6219. (condition-case nil
  6220. (make-indirect-buffer (current-buffer) "*org-goto*")
  6221. (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
  6222. (with-output-to-temp-buffer "*Help*"
  6223. (princ help))
  6224. (org-fit-window-to-buffer (get-buffer-window "*Help*"))
  6225. (setq buffer-read-only nil)
  6226. (let ((org-startup-truncated t)
  6227. (org-startup-folded nil)
  6228. (org-startup-align-all-tables nil))
  6229. (org-mode)
  6230. (org-overview))
  6231. (setq buffer-read-only t)
  6232. (if (and (boundp 'org-goto-start-pos)
  6233. (integer-or-marker-p org-goto-start-pos))
  6234. (let ((org-show-hierarchy-above t)
  6235. (org-show-siblings t)
  6236. (org-show-following-heading t))
  6237. (goto-char org-goto-start-pos)
  6238. (and (outline-invisible-p) (org-show-context)))
  6239. (goto-char (point-min)))
  6240. (let (org-special-ctrl-a/e) (org-beginning-of-line))
  6241. (message "Select location and press RET")
  6242. (use-local-map org-goto-map)
  6243. (recursive-edit)
  6244. ))
  6245. (kill-buffer "*org-goto*")
  6246. (cons org-goto-selected-point org-goto-exit-command)))
  6247. (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
  6248. (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
  6249. (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
  6250. (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
  6251. (defun org-goto-local-search-headings (string bound noerror)
  6252. "Search and make sure that any matches are in headlines."
  6253. (catch 'return
  6254. (while (if isearch-forward
  6255. (search-forward string bound noerror)
  6256. (search-backward string bound noerror))
  6257. (when (let ((context (mapcar 'car (save-match-data (org-context)))))
  6258. (and (member :headline context)
  6259. (not (member :tags context))))
  6260. (throw 'return (point))))))
  6261. (defun org-goto-local-auto-isearch ()
  6262. "Start isearch."
  6263. (interactive)
  6264. (goto-char (point-min))
  6265. (let ((keys (this-command-keys)))
  6266. (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
  6267. (isearch-mode t)
  6268. (isearch-process-search-char (string-to-char keys)))))
  6269. (defun org-goto-ret (&optional arg)
  6270. "Finish `org-goto' by going to the new location."
  6271. (interactive "P")
  6272. (setq org-goto-selected-point (point)
  6273. org-goto-exit-command 'return)
  6274. (throw 'exit nil))
  6275. (defun org-goto-left ()
  6276. "Finish `org-goto' by going to the new location."
  6277. (interactive)
  6278. (if (org-at-heading-p)
  6279. (progn
  6280. (beginning-of-line 1)
  6281. (setq org-goto-selected-point (point)
  6282. org-goto-exit-command 'left)
  6283. (throw 'exit nil))
  6284. (error "Not on a heading")))
  6285. (defun org-goto-right ()
  6286. "Finish `org-goto' by going to the new location."
  6287. (interactive)
  6288. (if (org-at-heading-p)
  6289. (progn
  6290. (setq org-goto-selected-point (point)
  6291. org-goto-exit-command 'right)
  6292. (throw 'exit nil))
  6293. (error "Not on a heading")))
  6294. (defun org-goto-quit ()
  6295. "Finish `org-goto' without cursor motion."
  6296. (interactive)
  6297. (setq org-goto-selected-point nil)
  6298. (setq org-goto-exit-command 'quit)
  6299. (throw 'exit nil))
  6300. ;;; Indirect buffer display of subtrees
  6301. (defvar org-indirect-dedicated-frame nil
  6302. "This is the frame being used for indirect tree display.")
  6303. (defvar org-last-indirect-buffer nil)
  6304. (defun org-tree-to-indirect-buffer (&optional arg)
  6305. "Create indirect buffer and narrow it to current subtree.
  6306. With numerical prefix ARG, go up to this level and then take that tree.
  6307. If ARG is negative, go up that many levels.
  6308. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  6309. indirect buffer previously made with this command, to avoid proliferation of
  6310. indirect buffers. However, when you call the command with a \
  6311. \\[universal-argument] prefix, or
  6312. when `org-indirect-buffer-display' is `new-frame', the last buffer
  6313. is kept so that you can work with several indirect buffers at the same time.
  6314. If `org-indirect-buffer-display' is `dedicated-frame', the \
  6315. \\[universal-argument] prefix also
  6316. requests that a new frame be made for the new buffer, so that the dedicated
  6317. frame is not changed."
  6318. (interactive "P")
  6319. (let ((cbuf (current-buffer))
  6320. (cwin (selected-window))
  6321. (pos (point))
  6322. beg end level heading ibuf)
  6323. (save-excursion
  6324. (org-back-to-heading t)
  6325. (when (numberp arg)
  6326. (setq level (org-outline-level))
  6327. (if (< arg 0) (setq arg (+ level arg)))
  6328. (while (> (setq level (org-outline-level)) arg)
  6329. (outline-up-heading 1 t)))
  6330. (setq beg (point)
  6331. heading (org-get-heading))
  6332. (org-end-of-subtree t t)
  6333. (if (org-at-heading-p) (backward-char 1))
  6334. (setq end (point)))
  6335. (if (and (buffer-live-p org-last-indirect-buffer)
  6336. (not (eq org-indirect-buffer-display 'new-frame))
  6337. (not arg))
  6338. (kill-buffer org-last-indirect-buffer))
  6339. (setq ibuf (org-get-indirect-buffer cbuf)
  6340. org-last-indirect-buffer ibuf)
  6341. (cond
  6342. ((or (eq org-indirect-buffer-display 'new-frame)
  6343. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  6344. (select-frame (make-frame))
  6345. (delete-other-windows)
  6346. (org-pop-to-buffer-same-window ibuf)
  6347. (org-set-frame-title heading))
  6348. ((eq org-indirect-buffer-display 'dedicated-frame)
  6349. (raise-frame
  6350. (select-frame (or (and org-indirect-dedicated-frame
  6351. (frame-live-p org-indirect-dedicated-frame)
  6352. org-indirect-dedicated-frame)
  6353. (setq org-indirect-dedicated-frame (make-frame)))))
  6354. (delete-other-windows)
  6355. (org-pop-to-buffer-same-window ibuf)
  6356. (org-set-frame-title (concat "Indirect: " heading)))
  6357. ((eq org-indirect-buffer-display 'current-window)
  6358. (org-pop-to-buffer-same-window ibuf))
  6359. ((eq org-indirect-buffer-display 'other-window)
  6360. (pop-to-buffer ibuf))
  6361. (t (error "Invalid value")))
  6362. (if (featurep 'xemacs)
  6363. (save-excursion (org-mode) (turn-on-font-lock)))
  6364. (narrow-to-region beg end)
  6365. (show-all)
  6366. (goto-char pos)
  6367. (run-hook-with-args 'org-cycle-hook 'all)
  6368. (and (window-live-p cwin) (select-window cwin))))
  6369. (defun org-get-indirect-buffer (&optional buffer)
  6370. (setq buffer (or buffer (current-buffer)))
  6371. (let ((n 1) (base (buffer-name buffer)) bname)
  6372. (while (buffer-live-p
  6373. (get-buffer (setq bname (concat base "-" (number-to-string n)))))
  6374. (setq n (1+ n)))
  6375. (condition-case nil
  6376. (make-indirect-buffer buffer bname 'clone)
  6377. (error (make-indirect-buffer buffer bname)))))
  6378. (defun org-set-frame-title (title)
  6379. "Set the title of the current frame to the string TITLE."
  6380. ;; FIXME: how to name a single frame in XEmacs???
  6381. (unless (featurep 'xemacs)
  6382. (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
  6383. ;;;; Structure editing
  6384. ;;; Inserting headlines
  6385. (defun org-previous-line-empty-p ()
  6386. (save-excursion
  6387. (and (not (bobp))
  6388. (or (beginning-of-line 0) t)
  6389. (save-match-data
  6390. (looking-at "[ \t]*$")))))
  6391. (defun org-insert-heading (&optional force-heading invisible-ok)
  6392. "Insert a new heading or item with same depth at point.
  6393. If point is in a plain list and FORCE-HEADING is nil, create a new list item.
  6394. If point is at the beginning of a headline, insert a sibling before the
  6395. current headline. If point is not at the beginning, split the line,
  6396. create the new headline with the text in the current line after point
  6397. \(but see also the variable `org-M-RET-may-split-line').
  6398. When INVISIBLE-OK is set, stop at invisible headlines when going back.
  6399. This is important for non-interactive uses of the command."
  6400. (interactive "P")
  6401. (if (or (= (buffer-size) 0)
  6402. (and (not (save-excursion
  6403. (and (ignore-errors (org-back-to-heading invisible-ok))
  6404. (org-at-heading-p))))
  6405. (or force-heading (not (org-in-item-p)))))
  6406. (progn
  6407. (insert "\n* ")
  6408. (run-hooks 'org-insert-heading-hook))
  6409. (when (or force-heading (not (org-insert-item)))
  6410. (let* ((empty-line-p nil)
  6411. (level nil)
  6412. (on-heading (org-at-heading-p))
  6413. (head (save-excursion
  6414. (condition-case nil
  6415. (progn
  6416. (org-back-to-heading invisible-ok)
  6417. (when (and (not on-heading)
  6418. (featurep 'org-inlinetask)
  6419. (integerp org-inlinetask-min-level)
  6420. (>= (length (match-string 0))
  6421. org-inlinetask-min-level))
  6422. ;; Find a heading level before the inline task
  6423. (while (and (setq level (org-up-heading-safe))
  6424. (>= level org-inlinetask-min-level)))
  6425. (if (org-at-heading-p)
  6426. (org-back-to-heading invisible-ok)
  6427. (error "This should not happen")))
  6428. (setq empty-line-p (org-previous-line-empty-p))
  6429. (match-string 0))
  6430. (error "*"))))
  6431. (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
  6432. (blank (if (eq blank-a 'auto) empty-line-p blank-a))
  6433. pos hide-previous previous-pos)
  6434. (cond
  6435. ((and (org-at-heading-p) (bolp)
  6436. (or (bobp)
  6437. (save-excursion (backward-char 1) (not (outline-invisible-p)))))
  6438. ;; insert before the current line
  6439. (open-line (if blank 2 1)))
  6440. ((and (bolp)
  6441. (not org-insert-heading-respect-content)
  6442. (or (bobp)
  6443. (save-excursion
  6444. (backward-char 1) (not (outline-invisible-p)))))
  6445. ;; insert right here
  6446. nil)
  6447. (t
  6448. ;; somewhere in the line
  6449. (save-excursion
  6450. (setq previous-pos (point-at-bol))
  6451. (end-of-line)
  6452. (setq hide-previous (outline-invisible-p)))
  6453. (and org-insert-heading-respect-content (org-show-subtree))
  6454. (let ((split
  6455. (and (org-get-alist-option org-M-RET-may-split-line 'headline)
  6456. (save-excursion
  6457. (let ((p (point)))
  6458. (goto-char (point-at-bol))
  6459. (and (looking-at org-complex-heading-regexp)
  6460. (match-beginning 4)
  6461. (> p (match-beginning 4)))))))
  6462. tags pos)
  6463. (cond
  6464. (org-insert-heading-respect-content
  6465. (org-end-of-subtree nil t)
  6466. (when (featurep 'org-inlinetask)
  6467. (while (and (not (eobp))
  6468. (looking-at "\\(\\*+\\)[ \t]+")
  6469. (>= (length (match-string 1))
  6470. org-inlinetask-min-level))
  6471. (org-end-of-subtree nil t)))
  6472. (or (bolp) (newline))
  6473. (or (org-previous-line-empty-p)
  6474. (and blank (newline)))
  6475. (open-line 1))
  6476. ((org-at-heading-p)
  6477. (when hide-previous
  6478. (show-children)
  6479. (org-show-entry))
  6480. (looking-at ".*?\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?[ \t]*$")
  6481. (setq tags (and (match-end 2) (match-string 2)))
  6482. (and (match-end 1)
  6483. (delete-region (match-beginning 1) (match-end 1)))
  6484. (setq pos (point-at-bol))
  6485. (or split (end-of-line 1))
  6486. (delete-horizontal-space)
  6487. (if (string-match "\\`\\*+\\'"
  6488. (buffer-substring (point-at-bol) (point)))
  6489. (insert " "))
  6490. (newline (if blank 2 1))
  6491. (when tags
  6492. (save-excursion
  6493. (goto-char pos)
  6494. (end-of-line 1)
  6495. (insert " " tags)
  6496. (org-set-tags nil 'align))))
  6497. (t
  6498. (or split (end-of-line 1))
  6499. (newline (if blank 2 1)))))))
  6500. (insert head) (just-one-space)
  6501. (setq pos (point))
  6502. (end-of-line 1)
  6503. (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
  6504. (when (and org-insert-heading-respect-content hide-previous)
  6505. (save-excursion
  6506. (goto-char previous-pos)
  6507. (hide-subtree)))
  6508. (run-hooks 'org-insert-heading-hook)))))
  6509. (defun org-get-heading (&optional no-tags no-todo)
  6510. "Return the heading of the current entry, without the stars.
  6511. When NO-TAGS is non-nil, don't include tags.
  6512. When NO-TODO is non-nil, don't include TODO keywords."
  6513. (save-excursion
  6514. (org-back-to-heading t)
  6515. (cond
  6516. ((and no-tags no-todo)
  6517. (looking-at org-complex-heading-regexp)
  6518. (match-string 4))
  6519. (no-tags
  6520. (looking-at (concat org-outline-regexp
  6521. "\\(.*?\\)"
  6522. "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
  6523. (match-string 1))
  6524. (no-todo
  6525. (looking-at org-todo-line-regexp)
  6526. (match-string 3))
  6527. (t (looking-at org-heading-regexp)
  6528. (match-string 2)))))
  6529. (defun org-heading-components ()
  6530. "Return the components of the current heading.
  6531. This is a list with the following elements:
  6532. - the level as an integer
  6533. - the reduced level, different if `org-odd-levels-only' is set.
  6534. - the TODO keyword, or nil
  6535. - the priority character, like ?A, or nil if no priority is given
  6536. - the headline text itself, or the tags string if no headline text
  6537. - the tags string, or nil."
  6538. (save-excursion
  6539. (org-back-to-heading t)
  6540. (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
  6541. (list (length (match-string 1))
  6542. (org-reduced-level (length (match-string 1)))
  6543. (org-match-string-no-properties 2)
  6544. (and (match-end 3) (aref (match-string 3) 2))
  6545. (org-match-string-no-properties 4)
  6546. (org-match-string-no-properties 5)))))
  6547. (defun org-get-entry ()
  6548. "Get the entry text, after heading, entire subtree."
  6549. (save-excursion
  6550. (org-back-to-heading t)
  6551. (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
  6552. (defun org-insert-heading-after-current ()
  6553. "Insert a new heading with same level as current, after current subtree."
  6554. (interactive)
  6555. (org-back-to-heading)
  6556. (org-insert-heading)
  6557. (org-move-subtree-down)
  6558. (end-of-line 1))
  6559. (defun org-insert-heading-respect-content ()
  6560. (interactive)
  6561. (let ((org-insert-heading-respect-content t))
  6562. (org-insert-heading t)))
  6563. (defun org-insert-todo-heading-respect-content (&optional force-state)
  6564. (interactive "P")
  6565. (let ((org-insert-heading-respect-content t))
  6566. (org-insert-todo-heading force-state t)))
  6567. (defun org-insert-todo-heading (arg &optional force-heading)
  6568. "Insert a new heading with the same level and TODO state as current heading.
  6569. If the heading has no TODO state, or if the state is DONE, use the first
  6570. state (TODO by default). Also with prefix arg, force first state."
  6571. (interactive "P")
  6572. (when (or force-heading (not (org-insert-item 'checkbox)))
  6573. (org-insert-heading force-heading)
  6574. (save-excursion
  6575. (org-back-to-heading)
  6576. (outline-previous-heading)
  6577. (looking-at org-todo-line-regexp))
  6578. (let*
  6579. ((new-mark-x
  6580. (if (or arg
  6581. (not (match-beginning 2))
  6582. (member (match-string 2) org-done-keywords))
  6583. (car org-todo-keywords-1)
  6584. (match-string 2)))
  6585. (new-mark
  6586. (or
  6587. (run-hook-with-args-until-success
  6588. 'org-todo-get-default-hook new-mark-x nil)
  6589. new-mark-x)))
  6590. (beginning-of-line 1)
  6591. (and (looking-at org-outline-regexp) (goto-char (match-end 0))
  6592. (if org-treat-insert-todo-heading-as-state-change
  6593. (org-todo new-mark)
  6594. (insert new-mark " "))))
  6595. (when org-provide-todo-statistics
  6596. (org-update-parent-todo-statistics))))
  6597. (defun org-insert-subheading (arg)
  6598. "Insert a new subheading and demote it.
  6599. Works for outline headings and for plain lists alike."
  6600. (interactive "P")
  6601. (org-insert-heading arg)
  6602. (cond
  6603. ((org-at-heading-p) (org-do-demote))
  6604. ((org-at-item-p) (org-indent-item))))
  6605. (defun org-insert-todo-subheading (arg)
  6606. "Insert a new subheading with TODO keyword or checkbox and demote it.
  6607. Works for outline headings and for plain lists alike."
  6608. (interactive "P")
  6609. (org-insert-todo-heading arg)
  6610. (cond
  6611. ((org-at-heading-p) (org-do-demote))
  6612. ((org-at-item-p) (org-indent-item))))
  6613. ;;; Promotion and Demotion
  6614. (defvar org-after-demote-entry-hook nil
  6615. "Hook run after an entry has been demoted.
  6616. The cursor will be at the beginning of the entry.
  6617. When a subtree is being demoted, the hook will be called for each node.")
  6618. (defvar org-after-promote-entry-hook nil
  6619. "Hook run after an entry has been promoted.
  6620. The cursor will be at the beginning of the entry.
  6621. When a subtree is being promoted, the hook will be called for each node.")
  6622. (defun org-promote-subtree ()
  6623. "Promote the entire subtree.
  6624. See also `org-promote'."
  6625. (interactive)
  6626. (save-excursion
  6627. (org-with-limited-levels (org-map-tree 'org-promote)))
  6628. (org-fix-position-after-promote))
  6629. (defun org-demote-subtree ()
  6630. "Demote the entire subtree. See `org-demote'.
  6631. See also `org-promote'."
  6632. (interactive)
  6633. (save-excursion
  6634. (org-with-limited-levels (org-map-tree 'org-demote)))
  6635. (org-fix-position-after-promote))
  6636. (defun org-do-promote ()
  6637. "Promote the current heading higher up the tree.
  6638. If the region is active in `transient-mark-mode', promote all headings
  6639. in the region."
  6640. (interactive)
  6641. (save-excursion
  6642. (if (org-region-active-p)
  6643. (org-map-region 'org-promote (region-beginning) (region-end))
  6644. (org-promote)))
  6645. (org-fix-position-after-promote))
  6646. (defun org-do-demote ()
  6647. "Demote the current heading lower down the tree.
  6648. If the region is active in `transient-mark-mode', demote all headings
  6649. in the region."
  6650. (interactive)
  6651. (save-excursion
  6652. (if (org-region-active-p)
  6653. (org-map-region 'org-demote (region-beginning) (region-end))
  6654. (org-demote)))
  6655. (org-fix-position-after-promote))
  6656. (defun org-fix-position-after-promote ()
  6657. "Make sure that after pro/demotion cursor position is right."
  6658. (let ((pos (point)))
  6659. (when (save-excursion
  6660. (beginning-of-line 1)
  6661. (looking-at org-todo-line-regexp)
  6662. (or (equal pos (match-end 1)) (equal pos (match-end 2))))
  6663. (cond ((eobp) (insert " "))
  6664. ((eolp) (insert " "))
  6665. ((equal (char-after) ?\ ) (forward-char 1))))))
  6666. (defun org-current-level ()
  6667. "Return the level of the current entry, or nil if before the first headline.
  6668. The level is the number of stars at the beginning of the headline."
  6669. (save-excursion
  6670. (org-with-limited-levels
  6671. (if (ignore-errors (org-back-to-heading t))
  6672. (funcall outline-level)))))
  6673. (defun org-get-previous-line-level ()
  6674. "Return the outline depth of the last headline before the current line.
  6675. Returns 0 for the first headline in the buffer, and nil if before the
  6676. first headline."
  6677. (let ((current-level (org-current-level))
  6678. (prev-level (when (> (line-number-at-pos) 1)
  6679. (save-excursion
  6680. (beginning-of-line 0)
  6681. (org-current-level)))))
  6682. (cond ((null current-level) nil) ; Before first headline
  6683. ((null prev-level) 0) ; At first headline
  6684. (prev-level))))
  6685. (defun org-reduced-level (l)
  6686. "Compute the effective level of a heading.
  6687. This takes into account the setting of `org-odd-levels-only'."
  6688. (cond
  6689. ((zerop l) 0)
  6690. (org-odd-levels-only (1+ (floor (/ l 2))))
  6691. (t l)))
  6692. (defun org-level-increment ()
  6693. "Return the number of stars that will be added or removed at a
  6694. time to headlines when structure editing, based on the value of
  6695. `org-odd-levels-only'."
  6696. (if org-odd-levels-only 2 1))
  6697. (defun org-get-valid-level (level &optional change)
  6698. "Rectify a level change under the influence of `org-odd-levels-only'
  6699. LEVEL is a current level, CHANGE is by how much the level should be
  6700. modified. Even if CHANGE is nil, LEVEL may be returned modified because
  6701. even level numbers will become the next higher odd number."
  6702. (if org-odd-levels-only
  6703. (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
  6704. ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
  6705. ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
  6706. (max 1 (+ level (or change 0)))))
  6707. (if (boundp 'define-obsolete-function-alias)
  6708. (if (or (featurep 'xemacs) (< emacs-major-version 23))
  6709. (define-obsolete-function-alias 'org-get-legal-level
  6710. 'org-get-valid-level)
  6711. (define-obsolete-function-alias 'org-get-legal-level
  6712. 'org-get-valid-level "23.1")))
  6713. (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
  6714. ;; ̀org-with-limited-levels'
  6715. (defun org-promote ()
  6716. "Promote the current heading higher up the tree.
  6717. If the region is active in `transient-mark-mode', promote all headings
  6718. in the region."
  6719. (org-back-to-heading t)
  6720. (let* ((level (save-match-data (funcall outline-level)))
  6721. (after-change-functions (remove 'flyspell-after-change-function
  6722. after-change-functions))
  6723. (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
  6724. (diff (abs (- level (length up-head) -1))))
  6725. (cond ((and (= level 1) org-called-with-limited-levels
  6726. org-allow-promoting-top-level-subtree)
  6727. (replace-match "# " nil t))
  6728. ((= level 1)
  6729. (error "Cannot promote to level 0. UNDO to recover if necessary"))
  6730. (t (replace-match up-head nil t)))
  6731. ;; Fixup tag positioning
  6732. (unless (= level 1)
  6733. (and org-auto-align-tags (org-set-tags nil t))
  6734. (if org-adapt-indentation (org-fixup-indentation (- diff))))
  6735. (run-hooks 'org-after-promote-entry-hook)))
  6736. (defun org-demote ()
  6737. "Demote the current heading lower down the tree.
  6738. If the region is active in `transient-mark-mode', demote all headings
  6739. in the region."
  6740. (org-back-to-heading t)
  6741. (let* ((level (save-match-data (funcall outline-level)))
  6742. (after-change-functions (remove 'flyspell-after-change-function
  6743. after-change-functions))
  6744. (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
  6745. (diff (abs (- level (length down-head) -1))))
  6746. (replace-match down-head nil t)
  6747. ;; Fixup tag positioning
  6748. (and org-auto-align-tags (org-set-tags nil t))
  6749. (if org-adapt-indentation (org-fixup-indentation diff))
  6750. (run-hooks 'org-after-demote-entry-hook)))
  6751. (defun org-cycle-level ()
  6752. "Cycle the level of an empty headline through possible states.
  6753. This goes first to child, then to parent, level, then up the hierarchy.
  6754. After top level, it switches back to sibling level."
  6755. (interactive)
  6756. (let ((org-adapt-indentation nil))
  6757. (when (org-point-at-end-of-empty-headline)
  6758. (setq this-command 'org-cycle-level) ; Only needed for caching
  6759. (let ((cur-level (org-current-level))
  6760. (prev-level (org-get-previous-line-level)))
  6761. (cond
  6762. ;; If first headline in file, promote to top-level.
  6763. ((= prev-level 0)
  6764. (loop repeat (/ (- cur-level 1) (org-level-increment))
  6765. do (org-do-promote)))
  6766. ;; If same level as prev, demote one.
  6767. ((= prev-level cur-level)
  6768. (org-do-demote))
  6769. ;; If parent is top-level, promote to top level if not already.
  6770. ((= prev-level 1)
  6771. (loop repeat (/ (- cur-level 1) (org-level-increment))
  6772. do (org-do-promote)))
  6773. ;; If top-level, return to prev-level.
  6774. ((= cur-level 1)
  6775. (loop repeat (/ (- prev-level 1) (org-level-increment))
  6776. do (org-do-demote)))
  6777. ;; If less than prev-level, promote one.
  6778. ((< cur-level prev-level)
  6779. (org-do-promote))
  6780. ;; If deeper than prev-level, promote until higher than
  6781. ;; prev-level.
  6782. ((> cur-level prev-level)
  6783. (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
  6784. do (org-do-promote))))
  6785. t))))
  6786. (defun org-map-tree (fun)
  6787. "Call FUN for every heading underneath the current one."
  6788. (org-back-to-heading)
  6789. (let ((level (funcall outline-level)))
  6790. (save-excursion
  6791. (funcall fun)
  6792. (while (and (progn
  6793. (outline-next-heading)
  6794. (> (funcall outline-level) level))
  6795. (not (eobp)))
  6796. (funcall fun)))))
  6797. (defun org-map-region (fun beg end)
  6798. "Call FUN for every heading between BEG and END."
  6799. (let ((org-ignore-region t))
  6800. (save-excursion
  6801. (setq end (copy-marker end))
  6802. (goto-char beg)
  6803. (if (and (re-search-forward org-outline-regexp-bol nil t)
  6804. (< (point) end))
  6805. (funcall fun))
  6806. (while (and (progn
  6807. (outline-next-heading)
  6808. (< (point) end))
  6809. (not (eobp)))
  6810. (funcall fun)))))
  6811. (defvar org-property-end-re) ; silence byte-compiler
  6812. (defun org-fixup-indentation (diff)
  6813. "Change the indentation in the current entry by DIFF.
  6814. However, if any line in the current entry has no indentation, or if it
  6815. would end up with no indentation after the change, nothing at all is done."
  6816. (save-excursion
  6817. (let ((end (save-excursion (outline-next-heading)
  6818. (point-marker)))
  6819. (prohibit (if (> diff 0)
  6820. "^\\S-"
  6821. (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
  6822. col)
  6823. (unless (save-excursion (end-of-line 1)
  6824. (re-search-forward prohibit end t))
  6825. (while (and (< (point) end)
  6826. (re-search-forward "^[ \t]+" end t))
  6827. (goto-char (match-end 0))
  6828. (setq col (current-column))
  6829. (if (< diff 0) (replace-match ""))
  6830. (org-indent-to-column (+ diff col))))
  6831. (move-marker end nil))))
  6832. (defun org-convert-to-odd-levels ()
  6833. "Convert an org-mode file with all levels allowed to one with odd levels.
  6834. This will leave level 1 alone, convert level 2 to level 3, level 3 to
  6835. level 5 etc."
  6836. (interactive)
  6837. (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
  6838. (let ((outline-level 'org-outline-level)
  6839. (org-odd-levels-only nil) n)
  6840. (save-excursion
  6841. (goto-char (point-min))
  6842. (while (re-search-forward "^\\*\\*+ " nil t)
  6843. (setq n (- (length (match-string 0)) 2))
  6844. (while (>= (setq n (1- n)) 0)
  6845. (org-demote))
  6846. (end-of-line 1))))))
  6847. (defun org-convert-to-oddeven-levels ()
  6848. "Convert an org-mode file with only odd levels to one with odd/even levels.
  6849. This promotes level 3 to level 2, level 5 to level 3 etc. If the
  6850. file contains a section with an even level, conversion would
  6851. destroy the structure of the file. An error is signaled in this
  6852. case."
  6853. (interactive)
  6854. (goto-char (point-min))
  6855. ;; First check if there are no even levels
  6856. (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
  6857. (org-show-context t)
  6858. (error "Not all levels are odd in this file. Conversion not possible"))
  6859. (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
  6860. (let ((outline-regexp org-outline-regexp)
  6861. (outline-level 'org-outline-level)
  6862. (org-odd-levels-only nil) n)
  6863. (save-excursion
  6864. (goto-char (point-min))
  6865. (while (re-search-forward "^\\*\\*+ " nil t)
  6866. (setq n (/ (1- (length (match-string 0))) 2))
  6867. (while (>= (setq n (1- n)) 0)
  6868. (org-promote))
  6869. (end-of-line 1))))))
  6870. (defun org-tr-level (n)
  6871. "Make N odd if required."
  6872. (if org-odd-levels-only (1+ (/ n 2)) n))
  6873. ;;; Vertical tree motion, cutting and pasting of subtrees
  6874. (defun org-move-subtree-up (&optional arg)
  6875. "Move the current subtree up past ARG headlines of the same level."
  6876. (interactive "p")
  6877. (org-move-subtree-down (- (prefix-numeric-value arg))))
  6878. (defun org-move-subtree-down (&optional arg)
  6879. "Move the current subtree down past ARG headlines of the same level."
  6880. (interactive "p")
  6881. (setq arg (prefix-numeric-value arg))
  6882. (let ((movfunc (if (> arg 0) 'org-get-next-sibling
  6883. 'org-get-last-sibling))
  6884. (ins-point (make-marker))
  6885. (cnt (abs arg))
  6886. (col (current-column))
  6887. beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
  6888. ;; Select the tree
  6889. (org-back-to-heading)
  6890. (setq beg0 (point))
  6891. (save-excursion
  6892. (setq ne-beg (org-back-over-empty-lines))
  6893. (setq beg (point)))
  6894. (save-match-data
  6895. (save-excursion (outline-end-of-heading)
  6896. (setq folded (outline-invisible-p)))
  6897. (outline-end-of-subtree))
  6898. (outline-next-heading)
  6899. (setq ne-end (org-back-over-empty-lines))
  6900. (setq end (point))
  6901. (goto-char beg0)
  6902. (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
  6903. ;; include less whitespace
  6904. (save-excursion
  6905. (goto-char beg)
  6906. (forward-line (- ne-beg ne-end))
  6907. (setq beg (point))))
  6908. ;; Find insertion point, with error handling
  6909. (while (> cnt 0)
  6910. (or (and (funcall movfunc) (looking-at org-outline-regexp))
  6911. (progn (goto-char beg0)
  6912. (error "Cannot move past superior level or buffer limit")))
  6913. (setq cnt (1- cnt)))
  6914. (if (> arg 0)
  6915. ;; Moving forward - still need to move over subtree
  6916. (progn (org-end-of-subtree t t)
  6917. (save-excursion
  6918. (org-back-over-empty-lines)
  6919. (or (bolp) (newline)))))
  6920. (setq ne-ins (org-back-over-empty-lines))
  6921. (move-marker ins-point (point))
  6922. (setq txt (buffer-substring beg end))
  6923. (org-save-markers-in-region beg end)
  6924. (delete-region beg end)
  6925. (org-remove-empty-overlays-at beg)
  6926. (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
  6927. (or (bobp) (outline-flag-region (1- (point)) (point) nil))
  6928. (and (not (bolp)) (looking-at "\n") (forward-char 1))
  6929. (let ((bbb (point)))
  6930. (insert-before-markers txt)
  6931. (org-reinstall-markers-in-region bbb)
  6932. (move-marker ins-point bbb))
  6933. (or (bolp) (insert "\n"))
  6934. (setq ins-end (point))
  6935. (goto-char ins-point)
  6936. (org-skip-whitespace)
  6937. (when (and (< arg 0)
  6938. (org-first-sibling-p)
  6939. (> ne-ins ne-beg))
  6940. ;; Move whitespace back to beginning
  6941. (save-excursion
  6942. (goto-char ins-end)
  6943. (let ((kill-whole-line t))
  6944. (kill-line (- ne-ins ne-beg)) (point)))
  6945. (insert (make-string (- ne-ins ne-beg) ?\n)))
  6946. (move-marker ins-point nil)
  6947. (if folded
  6948. (hide-subtree)
  6949. (org-show-entry)
  6950. (show-children)
  6951. (org-cycle-hide-drawers 'children))
  6952. (org-clean-visibility-after-subtree-move)
  6953. ;; move back to the initial column we were at
  6954. (move-to-column col)))
  6955. (defvar org-subtree-clip ""
  6956. "Clipboard for cut and paste of subtrees.
  6957. This is actually only a copy of the kill, because we use the normal kill
  6958. ring. We need it to check if the kill was created by `org-copy-subtree'.")
  6959. (defvar org-subtree-clip-folded nil
  6960. "Was the last copied subtree folded?
  6961. This is used to fold the tree back after pasting.")
  6962. (defun org-cut-subtree (&optional n)
  6963. "Cut the current subtree into the clipboard.
  6964. With prefix arg N, cut this many sequential subtrees.
  6965. This is a short-hand for marking the subtree and then cutting it."
  6966. (interactive "p")
  6967. (org-copy-subtree n 'cut))
  6968. (defun org-copy-subtree (&optional n cut force-store-markers)
  6969. "Cut the current subtree into the clipboard.
  6970. With prefix arg N, cut this many sequential subtrees.
  6971. This is a short-hand for marking the subtree and then copying it.
  6972. If CUT is non-nil, actually cut the subtree.
  6973. If FORCE-STORE-MARKERS is non-nil, store the relative locations
  6974. of some markers in the region, even if CUT is non-nil. This is
  6975. useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
  6976. (interactive "p")
  6977. (let (beg end folded (beg0 (point)))
  6978. (if (org-called-interactively-p 'any)
  6979. (org-back-to-heading nil) ; take what looks like a subtree
  6980. (org-back-to-heading t)) ; take what is really there
  6981. (org-back-over-empty-lines)
  6982. (setq beg (point))
  6983. (skip-chars-forward " \t\r\n")
  6984. (save-match-data
  6985. (save-excursion (outline-end-of-heading)
  6986. (setq folded (outline-invisible-p)))
  6987. (condition-case nil
  6988. (org-forward-same-level (1- n) t)
  6989. (error nil))
  6990. (org-end-of-subtree t t))
  6991. (org-back-over-empty-lines)
  6992. (setq end (point))
  6993. (goto-char beg0)
  6994. (when (> end beg)
  6995. (setq org-subtree-clip-folded folded)
  6996. (when (or cut force-store-markers)
  6997. (org-save-markers-in-region beg end))
  6998. (if cut (kill-region beg end) (copy-region-as-kill beg end))
  6999. (setq org-subtree-clip (current-kill 0))
  7000. (message "%s: Subtree(s) with %d characters"
  7001. (if cut "Cut" "Copied")
  7002. (length org-subtree-clip)))))
  7003. (defun org-paste-subtree (&optional level tree for-yank)
  7004. "Paste the clipboard as a subtree, with modification of headline level.
  7005. The entire subtree is promoted or demoted in order to match a new headline
  7006. level.
  7007. If the cursor is at the beginning of a headline, the same level as
  7008. that headline is used to paste the tree
  7009. If not, the new level is derived from the *visible* headings
  7010. before and after the insertion point, and taken to be the inferior headline
  7011. level of the two. So if the previous visible heading is level 3 and the
  7012. next is level 4 (or vice versa), level 4 will be used for insertion.
  7013. This makes sure that the subtree remains an independent subtree and does
  7014. not swallow low level entries.
  7015. You can also force a different level, either by using a numeric prefix
  7016. argument, or by inserting the heading marker by hand. For example, if the
  7017. cursor is after \"*****\", then the tree will be shifted to level 5.
  7018. If optional TREE is given, use this text instead of the kill ring.
  7019. When FOR-YANK is set, this is called by `org-yank'. In this case, do not
  7020. move back over whitespace before inserting, and move point to the end of
  7021. the inserted text when done."
  7022. (interactive "P")
  7023. (setq tree (or tree (and kill-ring (current-kill 0))))
  7024. (unless (org-kill-is-subtree-p tree)
  7025. (error "%s"
  7026. (substitute-command-keys
  7027. "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
  7028. (org-with-limited-levels
  7029. (let* ((visp (not (outline-invisible-p)))
  7030. (txt tree)
  7031. (^re_ "\\(\\*+\\)[ \t]*")
  7032. (old-level (if (string-match org-outline-regexp-bol txt)
  7033. (- (match-end 0) (match-beginning 0) 1)
  7034. -1))
  7035. (force-level (cond (level (prefix-numeric-value level))
  7036. ((and (looking-at "[ \t]*$")
  7037. (string-match
  7038. "^\\*+$" (buffer-substring
  7039. (point-at-bol) (point))))
  7040. (- (match-end 1) (match-beginning 1)))
  7041. ((and (bolp)
  7042. (looking-at org-outline-regexp))
  7043. (- (match-end 0) (point) 1))
  7044. (t nil)))
  7045. (previous-level (save-excursion
  7046. (condition-case nil
  7047. (progn
  7048. (outline-previous-visible-heading 1)
  7049. (if (looking-at ^re_)
  7050. (- (match-end 0) (match-beginning 0) 1)
  7051. 1))
  7052. (error 1))))
  7053. (next-level (save-excursion
  7054. (condition-case nil
  7055. (progn
  7056. (or (looking-at org-outline-regexp)
  7057. (outline-next-visible-heading 1))
  7058. (if (looking-at ^re_)
  7059. (- (match-end 0) (match-beginning 0) 1)
  7060. 1))
  7061. (error 1))))
  7062. (new-level (or force-level (max previous-level next-level)))
  7063. (shift (if (or (= old-level -1)
  7064. (= new-level -1)
  7065. (= old-level new-level))
  7066. 0
  7067. (- new-level old-level)))
  7068. (delta (if (> shift 0) -1 1))
  7069. (func (if (> shift 0) 'org-demote 'org-promote))
  7070. (org-odd-levels-only nil)
  7071. beg end newend)
  7072. ;; Remove the forced level indicator
  7073. (if force-level
  7074. (delete-region (point-at-bol) (point)))
  7075. ;; Paste
  7076. (beginning-of-line (if (bolp) 1 2))
  7077. (unless for-yank (org-back-over-empty-lines))
  7078. (setq beg (point))
  7079. (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
  7080. (insert-before-markers txt)
  7081. (unless (string-match "\n\\'" txt) (insert "\n"))
  7082. (setq newend (point))
  7083. (org-reinstall-markers-in-region beg)
  7084. (setq end (point))
  7085. (goto-char beg)
  7086. (skip-chars-forward " \t\n\r")
  7087. (setq beg (point))
  7088. (if (and (outline-invisible-p) visp)
  7089. (save-excursion (outline-show-heading)))
  7090. ;; Shift if necessary
  7091. (unless (= shift 0)
  7092. (save-restriction
  7093. (narrow-to-region beg end)
  7094. (while (not (= shift 0))
  7095. (org-map-region func (point-min) (point-max))
  7096. (setq shift (+ delta shift)))
  7097. (goto-char (point-min))
  7098. (setq newend (point-max))))
  7099. (when (or (org-called-interactively-p 'interactive) for-yank)
  7100. (message "Clipboard pasted as level %d subtree" new-level))
  7101. (if (and (not for-yank) ; in this case, org-yank will decide about folding
  7102. kill-ring
  7103. (eq org-subtree-clip (current-kill 0))
  7104. org-subtree-clip-folded)
  7105. ;; The tree was folded before it was killed/copied
  7106. (hide-subtree))
  7107. (and for-yank (goto-char newend)))))
  7108. (defun org-kill-is-subtree-p (&optional txt)
  7109. "Check if the current kill is an outline subtree, or a set of trees.
  7110. Returns nil if kill does not start with a headline, or if the first
  7111. headline level is not the largest headline level in the tree.
  7112. So this will actually accept several entries of equal levels as well,
  7113. which is OK for `org-paste-subtree'.
  7114. If optional TXT is given, check this string instead of the current kill."
  7115. (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
  7116. (re (org-get-limited-outline-regexp))
  7117. (^re (concat "^" re))
  7118. (start-level (and kill
  7119. (string-match
  7120. (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
  7121. kill)
  7122. (- (match-end 2) (match-beginning 2) 1)))
  7123. (start (1+ (or (match-beginning 2) -1))))
  7124. (if (not start-level)
  7125. (progn
  7126. nil) ;; does not even start with a heading
  7127. (catch 'exit
  7128. (while (setq start (string-match ^re kill (1+ start)))
  7129. (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
  7130. (throw 'exit nil)))
  7131. t))))
  7132. (defvar org-markers-to-move nil
  7133. "Markers that should be moved with a cut-and-paste operation.
  7134. Those markers are stored together with their positions relative to
  7135. the start of the region.")
  7136. (defun org-save-markers-in-region (beg end)
  7137. "Check markers in region.
  7138. If these markers are between BEG and END, record their position relative
  7139. to BEG, so that after moving the block of text, we can put the markers back
  7140. into place.
  7141. This function gets called just before an entry or tree gets cut from the
  7142. buffer. After re-insertion, `org-reinstall-markers-in-region' must be
  7143. called immediately, to move the markers with the entries."
  7144. (setq org-markers-to-move nil)
  7145. (when (featurep 'org-clock)
  7146. (org-clock-save-markers-for-cut-and-paste beg end))
  7147. (when (featurep 'org-agenda)
  7148. (org-agenda-save-markers-for-cut-and-paste beg end)))
  7149. (defun org-check-and-save-marker (marker beg end)
  7150. "Check if MARKER is between BEG and END.
  7151. If yes, remember the marker and the distance to BEG."
  7152. (when (and (marker-buffer marker)
  7153. (equal (marker-buffer marker) (current-buffer)))
  7154. (if (and (>= marker beg) (< marker end))
  7155. (push (cons marker (- marker beg)) org-markers-to-move))))
  7156. (defun org-reinstall-markers-in-region (beg)
  7157. "Move all remembered markers to their position relative to BEG."
  7158. (mapc (lambda (x)
  7159. (move-marker (car x) (+ beg (cdr x))))
  7160. org-markers-to-move)
  7161. (setq org-markers-to-move nil))
  7162. (defun org-narrow-to-subtree ()
  7163. "Narrow buffer to the current subtree."
  7164. (interactive)
  7165. (save-excursion
  7166. (save-match-data
  7167. (org-with-limited-levels
  7168. (narrow-to-region
  7169. (progn (org-back-to-heading t) (point))
  7170. (progn (org-end-of-subtree t t)
  7171. (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
  7172. (point)))))))
  7173. (defun org-narrow-to-block ()
  7174. "Narrow buffer to the current block."
  7175. (interactive)
  7176. (let* ((case-fold-search t)
  7177. (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
  7178. "^[ \t]*#\\+end_.*")))
  7179. (if blockp
  7180. (narrow-to-region (car blockp) (cdr blockp))
  7181. (error "Not in a block"))))
  7182. (eval-when-compile
  7183. (defvar org-property-drawer-re))
  7184. (defvar org-property-start-re) ;; defined below
  7185. (defun org-clone-subtree-with-time-shift (n &optional shift)
  7186. "Clone the task (subtree) at point N times.
  7187. The clones will be inserted as siblings.
  7188. In interactive use, the user will be prompted for the number of
  7189. clones to be produced, and for a time SHIFT, which may be a
  7190. repeater as used in time stamps, for example `+3d'.
  7191. When a valid repeater is given and the entry contains any time
  7192. stamps, the clones will become a sequence in time, with time
  7193. stamps in the subtree shifted for each clone produced. If SHIFT
  7194. is nil or the empty string, time stamps will be left alone. The
  7195. ID property of the original subtree is removed.
  7196. If the original subtree did contain time stamps with a repeater,
  7197. the following will happen:
  7198. - the repeater will be removed in each clone
  7199. - an additional clone will be produced, with the current, unshifted
  7200. date(s) in the entry.
  7201. - the original entry will be placed *after* all the clones, with
  7202. repeater intact.
  7203. - the start days in the repeater in the original entry will be shifted
  7204. to past the last clone.
  7205. In this way you can spell out a number of instances of a repeating task,
  7206. and still retain the repeater to cover future instances of the task."
  7207. (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
  7208. (let (beg end template task idprop
  7209. shift-n shift-what doshift nmin nmax (n-no-remove -1)
  7210. (drawer-re org-drawer-regexp))
  7211. (if (not (and (integerp n) (> n 0)))
  7212. (error "Invalid number of replications %s" n))
  7213. (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
  7214. (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
  7215. shift)))
  7216. (error "Invalid shift specification %s" shift))
  7217. (when doshift
  7218. (setq shift-n (string-to-number (match-string 1 shift))
  7219. shift-what (cdr (assoc (match-string 2 shift)
  7220. '(("d" . day) ("w" . week)
  7221. ("m" . month) ("y" . year))))))
  7222. (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
  7223. (setq nmin 1 nmax n)
  7224. (org-back-to-heading t)
  7225. (setq beg (point))
  7226. (setq idprop (org-entry-get nil "ID"))
  7227. (org-end-of-subtree t t)
  7228. (or (bolp) (insert "\n"))
  7229. (setq end (point))
  7230. (setq template (buffer-substring beg end))
  7231. (when (and doshift
  7232. (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
  7233. (delete-region beg end)
  7234. (setq end beg)
  7235. (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
  7236. (goto-char end)
  7237. (loop for n from nmin to nmax do
  7238. ;; prepare clone
  7239. (with-temp-buffer
  7240. (insert template)
  7241. (org-mode)
  7242. (goto-char (point-min))
  7243. (org-show-subtree)
  7244. (and idprop (if org-clone-delete-id
  7245. (org-entry-delete nil "ID")
  7246. (org-id-get-create t)))
  7247. (unless (= n 0)
  7248. (while (re-search-forward "^[ \t]*CLOCK:.*$" nil t)
  7249. (kill-whole-line))
  7250. (goto-char (point-min))
  7251. (while (re-search-forward drawer-re nil t)
  7252. (mapc (lambda (d)
  7253. (org-remove-empty-drawer-at d (point))) org-drawers)))
  7254. (goto-char (point-min))
  7255. (when doshift
  7256. (while (re-search-forward org-ts-regexp-both nil t)
  7257. (org-timestamp-change (* n shift-n) shift-what))
  7258. (unless (= n n-no-remove)
  7259. (goto-char (point-min))
  7260. (while (re-search-forward org-ts-regexp nil t)
  7261. (save-excursion
  7262. (goto-char (match-beginning 0))
  7263. (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
  7264. (delete-region (match-beginning 1) (match-end 1)))))))
  7265. (setq task (buffer-string)))
  7266. (insert task))
  7267. (goto-char beg)))
  7268. ;;; Outline Sorting
  7269. (defun org-sort (with-case)
  7270. "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
  7271. Optional argument WITH-CASE means sort case-sensitively."
  7272. (interactive "P")
  7273. (cond
  7274. ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
  7275. ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
  7276. (t
  7277. (org-call-with-arg 'org-sort-entries with-case))))
  7278. (defun org-sort-remove-invisible (s)
  7279. (remove-text-properties 0 (length s) org-rm-props s)
  7280. (while (string-match org-bracket-link-regexp s)
  7281. (setq s (replace-match (if (match-end 2)
  7282. (match-string 3 s)
  7283. (match-string 1 s)) t t s)))
  7284. s)
  7285. (defvar org-priority-regexp) ; defined later in the file
  7286. (defvar org-after-sorting-entries-or-items-hook nil
  7287. "Hook that is run after a bunch of entries or items have been sorted.
  7288. When children are sorted, the cursor is in the parent line when this
  7289. hook gets called. When a region or a plain list is sorted, the cursor
  7290. will be in the first entry of the sorted region/list.")
  7291. (defun org-sort-entries
  7292. (&optional with-case sorting-type getkey-func compare-func property)
  7293. "Sort entries on a certain level of an outline tree.
  7294. If there is an active region, the entries in the region are sorted.
  7295. Else, if the cursor is before the first entry, sort the top-level items.
  7296. Else, the children of the entry at point are sorted.
  7297. Sorting can be alphabetically, numerically, by date/time as given by
  7298. a time stamp, by a property or by priority.
  7299. The command prompts for the sorting type unless it has been given to the
  7300. function through the SORTING-TYPE argument, which needs to be a character,
  7301. \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
  7302. precise meaning of each character:
  7303. n Numerically, by converting the beginning of the entry/item to a number.
  7304. a Alphabetically, ignoring the TODO keyword and the priority, if any.
  7305. t By date/time, either the first active time stamp in the entry, or, if
  7306. none exist, by the first inactive one.
  7307. s By the scheduled date/time.
  7308. d By deadline date/time.
  7309. c By creation time, which is assumed to be the first inactive time stamp
  7310. at the beginning of a line.
  7311. p By priority according to the cookie.
  7312. r By the value of a property.
  7313. Capital letters will reverse the sort order.
  7314. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
  7315. called with point at the beginning of the record. It must return either
  7316. a string or a number that should serve as the sorting key for that record.
  7317. Comparing entries ignores case by default. However, with an optional argument
  7318. WITH-CASE, the sorting considers case as well."
  7319. (interactive "P")
  7320. (let ((case-func (if with-case 'identity 'downcase))
  7321. start beg end stars re re2
  7322. txt what tmp)
  7323. ;; Find beginning and end of region to sort
  7324. (cond
  7325. ((org-region-active-p)
  7326. ;; we will sort the region
  7327. (setq end (region-end)
  7328. what "region")
  7329. (goto-char (region-beginning))
  7330. (if (not (org-at-heading-p)) (outline-next-heading))
  7331. (setq start (point)))
  7332. ((or (org-at-heading-p)
  7333. (condition-case nil (progn (org-back-to-heading) t) (error nil)))
  7334. ;; we will sort the children of the current headline
  7335. (org-back-to-heading)
  7336. (setq start (point)
  7337. end (progn (org-end-of-subtree t t)
  7338. (or (bolp) (insert "\n"))
  7339. (org-back-over-empty-lines)
  7340. (point))
  7341. what "children")
  7342. (goto-char start)
  7343. (show-subtree)
  7344. (outline-next-heading))
  7345. (t
  7346. ;; we will sort the top-level entries in this file
  7347. (goto-char (point-min))
  7348. (or (org-at-heading-p) (outline-next-heading))
  7349. (setq start (point))
  7350. (goto-char (point-max))
  7351. (beginning-of-line 1)
  7352. (when (looking-at ".*?\\S-")
  7353. ;; File ends in a non-white line
  7354. (end-of-line 1)
  7355. (insert "\n"))
  7356. (setq end (point-max))
  7357. (setq what "top-level")
  7358. (goto-char start)
  7359. (show-all)))
  7360. (setq beg (point))
  7361. (if (>= beg end) (error "Nothing to sort"))
  7362. (looking-at "\\(\\*+\\)")
  7363. (setq stars (match-string 1)
  7364. re (concat "^" (regexp-quote stars) " +")
  7365. re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
  7366. txt (buffer-substring beg end))
  7367. (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
  7368. (if (and (not (equal stars "*")) (string-match re2 txt))
  7369. (error "Region to sort contains a level above the first entry"))
  7370. (unless sorting-type
  7371. (message
  7372. "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
  7373. [t]ime [s]cheduled [d]eadline [c]reated
  7374. A/N/T/S/D/C/P/O/F means reversed:"
  7375. what)
  7376. (setq sorting-type (read-char-exclusive))
  7377. (and (= (downcase sorting-type) ?f)
  7378. (setq getkey-func
  7379. (org-icompleting-read "Sort using function: "
  7380. obarray 'fboundp t nil nil))
  7381. (setq getkey-func (intern getkey-func)))
  7382. (and (= (downcase sorting-type) ?r)
  7383. (setq property
  7384. (org-icompleting-read "Property: "
  7385. (mapcar 'list (org-buffer-property-keys t))
  7386. nil t))))
  7387. (message "Sorting entries...")
  7388. (save-restriction
  7389. (narrow-to-region start end)
  7390. (let ((dcst (downcase sorting-type))
  7391. (case-fold-search nil)
  7392. (now (current-time)))
  7393. (sort-subr
  7394. (/= dcst sorting-type)
  7395. ;; This function moves to the beginning character of the "record" to
  7396. ;; be sorted.
  7397. (lambda nil
  7398. (if (re-search-forward re nil t)
  7399. (goto-char (match-beginning 0))
  7400. (goto-char (point-max))))
  7401. ;; This function moves to the last character of the "record" being
  7402. ;; sorted.
  7403. (lambda nil
  7404. (save-match-data
  7405. (condition-case nil
  7406. (outline-forward-same-level 1)
  7407. (error
  7408. (goto-char (point-max))))))
  7409. ;; This function returns the value that gets sorted against.
  7410. (lambda nil
  7411. (cond
  7412. ((= dcst ?n)
  7413. (if (looking-at org-complex-heading-regexp)
  7414. (string-to-number (match-string 4))
  7415. nil))
  7416. ((= dcst ?a)
  7417. (if (looking-at org-complex-heading-regexp)
  7418. (funcall case-func (match-string 4))
  7419. nil))
  7420. ((= dcst ?t)
  7421. (let ((end (save-excursion (outline-next-heading) (point))))
  7422. (if (or (re-search-forward org-ts-regexp end t)
  7423. (re-search-forward org-ts-regexp-both end t))
  7424. (org-time-string-to-seconds (match-string 0))
  7425. (org-float-time now))))
  7426. ((= dcst ?c)
  7427. (let ((end (save-excursion (outline-next-heading) (point))))
  7428. (if (re-search-forward
  7429. (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
  7430. end t)
  7431. (org-time-string-to-seconds (match-string 0))
  7432. (org-float-time now))))
  7433. ((= dcst ?s)
  7434. (let ((end (save-excursion (outline-next-heading) (point))))
  7435. (if (re-search-forward org-scheduled-time-regexp end t)
  7436. (org-time-string-to-seconds (match-string 1))
  7437. (org-float-time now))))
  7438. ((= dcst ?d)
  7439. (let ((end (save-excursion (outline-next-heading) (point))))
  7440. (if (re-search-forward org-deadline-time-regexp end t)
  7441. (org-time-string-to-seconds (match-string 1))
  7442. (org-float-time now))))
  7443. ((= dcst ?p)
  7444. (if (re-search-forward org-priority-regexp (point-at-eol) t)
  7445. (string-to-char (match-string 2))
  7446. org-default-priority))
  7447. ((= dcst ?r)
  7448. (or (org-entry-get nil property) ""))
  7449. ((= dcst ?o)
  7450. (if (looking-at org-complex-heading-regexp)
  7451. (- 9999 (length (member (match-string 2)
  7452. org-todo-keywords-1)))))
  7453. ((= dcst ?f)
  7454. (if getkey-func
  7455. (progn
  7456. (setq tmp (funcall getkey-func))
  7457. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  7458. tmp)
  7459. (error "Invalid key function `%s'" getkey-func)))
  7460. (t (error "Invalid sorting type `%c'" sorting-type))))
  7461. nil
  7462. (cond
  7463. ((= dcst ?a) 'string<)
  7464. ((= dcst ?f) compare-func)
  7465. ((member dcst '(?p ?t ?s ?d ?c)) '<)
  7466. (t nil)))))
  7467. (run-hooks 'org-after-sorting-entries-or-items-hook)
  7468. (message "Sorting entries...done")))
  7469. (defun org-do-sort (table what &optional with-case sorting-type)
  7470. "Sort TABLE of WHAT according to SORTING-TYPE.
  7471. The user will be prompted for the SORTING-TYPE if the call to this
  7472. function does not specify it. WHAT is only for the prompt, to indicate
  7473. what is being sorted. The sorting key will be extracted from
  7474. the car of the elements of the table.
  7475. If WITH-CASE is non-nil, the sorting will be case-sensitive."
  7476. (unless sorting-type
  7477. (message
  7478. "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
  7479. what)
  7480. (setq sorting-type (read-char-exclusive)))
  7481. (let ((dcst (downcase sorting-type))
  7482. extractfun comparefun)
  7483. ;; Define the appropriate functions
  7484. (cond
  7485. ((= dcst ?n)
  7486. (setq extractfun 'string-to-number
  7487. comparefun (if (= dcst sorting-type) '< '>)))
  7488. ((= dcst ?a)
  7489. (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
  7490. (lambda(x) (downcase (org-sort-remove-invisible x))))
  7491. comparefun (if (= dcst sorting-type)
  7492. 'string<
  7493. (lambda (a b) (and (not (string< a b))
  7494. (not (string= a b)))))))
  7495. ((= dcst ?t)
  7496. (setq extractfun
  7497. (lambda (x)
  7498. (if (or (string-match org-ts-regexp x)
  7499. (string-match org-ts-regexp-both x))
  7500. (org-float-time
  7501. (org-time-string-to-time (match-string 0 x)))
  7502. 0))
  7503. comparefun (if (= dcst sorting-type) '< '>)))
  7504. (t (error "Invalid sorting type `%c'" sorting-type)))
  7505. (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
  7506. table)
  7507. (lambda (a b) (funcall comparefun (car a) (car b))))))
  7508. ;;; The orgstruct minor mode
  7509. ;; Define a minor mode which can be used in other modes in order to
  7510. ;; integrate the org-mode structure editing commands.
  7511. ;; This is really a hack, because the org-mode structure commands use
  7512. ;; keys which normally belong to the major mode. Here is how it
  7513. ;; works: The minor mode defines all the keys necessary to operate the
  7514. ;; structure commands, but wraps the commands into a function which
  7515. ;; tests if the cursor is currently at a headline or a plain list
  7516. ;; item. If that is the case, the structure command is used,
  7517. ;; temporarily setting many Org-mode variables like regular
  7518. ;; expressions for filling etc. However, when any of those keys is
  7519. ;; used at a different location, function uses `key-binding' to look
  7520. ;; up if the key has an associated command in another currently active
  7521. ;; keymap (minor modes, major mode, global), and executes that
  7522. ;; command. There might be problems if any of the keys is otherwise
  7523. ;; used as a prefix key.
  7524. ;; Another challenge is that the key binding for TAB can be tab or \C-i,
  7525. ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
  7526. ;; addresses this by checking explicitly for both bindings.
  7527. (defvar orgstruct-mode-map (make-sparse-keymap)
  7528. "Keymap for the minor `orgstruct-mode'.")
  7529. (defvar org-local-vars nil
  7530. "List of local variables, for use by `orgstruct-mode'.")
  7531. ;;;###autoload
  7532. (define-minor-mode orgstruct-mode
  7533. "Toggle the minor mode `orgstruct-mode'.
  7534. This mode is for using Org-mode structure commands in other
  7535. modes. The following keys behave as if Org-mode were active, if
  7536. the cursor is on a headline, or on a plain list item (both as
  7537. defined by Org-mode).
  7538. M-up Move entry/item up
  7539. M-down Move entry/item down
  7540. M-left Promote
  7541. M-right Demote
  7542. M-S-up Move entry/item up
  7543. M-S-down Move entry/item down
  7544. M-S-left Promote subtree
  7545. M-S-right Demote subtree
  7546. M-q Fill paragraph and items like in Org-mode
  7547. C-c ^ Sort entries
  7548. C-c - Cycle list bullet
  7549. TAB Cycle item visibility
  7550. M-RET Insert new heading/item
  7551. S-M-RET Insert new TODO heading / Checkbox item
  7552. C-c C-c Set tags / toggle checkbox"
  7553. nil " OrgStruct" nil
  7554. (org-load-modules-maybe)
  7555. (and (orgstruct-setup) (defun orgstruct-setup () nil)))
  7556. ;;;###autoload
  7557. (defun turn-on-orgstruct ()
  7558. "Unconditionally turn on `orgstruct-mode'."
  7559. (orgstruct-mode 1))
  7560. (defvar org-fb-vars nil)
  7561. (make-variable-buffer-local 'org-fb-vars)
  7562. (defun orgstruct++-mode (&optional arg)
  7563. "Toggle `orgstruct-mode', the enhanced version of it.
  7564. In addition to setting orgstruct-mode, this also exports all
  7565. indentation and autofilling variables from org-mode into the
  7566. buffer. It will also recognize item context in multiline items."
  7567. (interactive "P")
  7568. (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
  7569. (if (< arg 1)
  7570. (progn (orgstruct-mode -1)
  7571. (mapc (lambda(v)
  7572. (org-set-local (car v)
  7573. (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
  7574. org-fb-vars))
  7575. (orgstruct-mode 1)
  7576. (setq org-fb-vars nil)
  7577. (let (var val)
  7578. (mapc
  7579. (lambda (x)
  7580. (when (string-match
  7581. "^\\(paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
  7582. (symbol-name (car x)))
  7583. (setq var (car x) val (nth 1 x))
  7584. (push (list var `(quote ,(eval var))) org-fb-vars)
  7585. (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
  7586. org-local-vars)
  7587. (org-set-local 'orgstruct-is-++ t))))
  7588. (defvar orgstruct-is-++ nil
  7589. "Is `orgstruct-mode' in ++ version in the current-buffer?")
  7590. (make-variable-buffer-local 'orgstruct-is-++)
  7591. ;;;###autoload
  7592. (defun turn-on-orgstruct++ ()
  7593. "Unconditionally turn on `orgstruct++-mode'."
  7594. (orgstruct++-mode 1))
  7595. (defun orgstruct-error ()
  7596. "Error when there is no default binding for a structure key."
  7597. (interactive)
  7598. (error "This key has no function outside structure elements"))
  7599. (defun orgstruct-setup ()
  7600. "Setup orgstruct keymaps."
  7601. (let ((nfunc 0)
  7602. (bindings
  7603. (list
  7604. '([(meta up)] org-metaup)
  7605. '([(meta down)] org-metadown)
  7606. '([(meta left)] org-metaleft)
  7607. '([(meta right)] org-metaright)
  7608. '([(meta shift up)] org-shiftmetaup)
  7609. '([(meta shift down)] org-shiftmetadown)
  7610. '([(meta shift left)] org-shiftmetaleft)
  7611. '([(meta shift right)] org-shiftmetaright)
  7612. '([?\e (up)] org-metaup)
  7613. '([?\e (down)] org-metadown)
  7614. '([?\e (left)] org-metaleft)
  7615. '([?\e (right)] org-metaright)
  7616. '([?\e (shift up)] org-shiftmetaup)
  7617. '([?\e (shift down)] org-shiftmetadown)
  7618. '([?\e (shift left)] org-shiftmetaleft)
  7619. '([?\e (shift right)] org-shiftmetaright)
  7620. '([(shift up)] org-shiftup)
  7621. '([(shift down)] org-shiftdown)
  7622. '([(shift left)] org-shiftleft)
  7623. '([(shift right)] org-shiftright)
  7624. '("\C-c\C-c" org-ctrl-c-ctrl-c)
  7625. '("\M-q" fill-paragraph)
  7626. '("\C-c^" org-sort)
  7627. '("\C-c-" org-cycle-list-bullet)))
  7628. elt key fun cmd)
  7629. (while (setq elt (pop bindings))
  7630. (setq nfunc (1+ nfunc))
  7631. (setq key (org-key (car elt))
  7632. fun (nth 1 elt)
  7633. cmd (orgstruct-make-binding fun nfunc key))
  7634. (org-defkey orgstruct-mode-map key cmd))
  7635. ;; Special treatment needed for TAB and RET
  7636. (org-defkey orgstruct-mode-map [(tab)]
  7637. (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
  7638. (org-defkey orgstruct-mode-map "\C-i"
  7639. (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
  7640. (org-defkey orgstruct-mode-map "\M-\C-m"
  7641. (orgstruct-make-binding 'org-insert-heading 105
  7642. "\M-\C-m" [(meta return)]))
  7643. (org-defkey orgstruct-mode-map [(meta return)]
  7644. (orgstruct-make-binding 'org-insert-heading 106
  7645. [(meta return)] "\M-\C-m"))
  7646. (org-defkey orgstruct-mode-map [(shift meta return)]
  7647. (orgstruct-make-binding 'org-insert-todo-heading 107
  7648. [(meta return)] "\M-\C-m"))
  7649. (org-defkey orgstruct-mode-map "\e\C-m"
  7650. (orgstruct-make-binding 'org-insert-heading 108
  7651. "\e\C-m" [?\e (return)]))
  7652. (org-defkey orgstruct-mode-map [?\e (return)]
  7653. (orgstruct-make-binding 'org-insert-heading 109
  7654. [?\e (return)] "\e\C-m"))
  7655. (org-defkey orgstruct-mode-map [?\e (shift return)]
  7656. (orgstruct-make-binding 'org-insert-todo-heading 110
  7657. [?\e (return)] "\e\C-m"))
  7658. (unless org-local-vars
  7659. (setq org-local-vars (org-get-local-variables)))
  7660. t))
  7661. (defun orgstruct-make-binding (fun n &rest keys)
  7662. "Create a function for binding in the structure minor mode.
  7663. FUN is the command to call inside a table. N is used to create a unique
  7664. command name. KEYS are keys that should be checked in for a command
  7665. to execute outside of tables."
  7666. (eval
  7667. (list 'defun
  7668. (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
  7669. '(arg)
  7670. (concat "In Structure, run `" (symbol-name fun) "'.\n"
  7671. "Outside of structure, run the binding of `"
  7672. (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
  7673. "'.")
  7674. '(interactive "p")
  7675. (list 'if
  7676. `(org-context-p 'headline 'item
  7677. (and orgstruct-is-++
  7678. ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
  7679. 'item-body))
  7680. (list 'org-run-like-in-org-mode (list 'quote fun))
  7681. (list 'let '(orgstruct-mode)
  7682. (list 'call-interactively
  7683. (append '(or)
  7684. (mapcar (lambda (k)
  7685. (list 'key-binding k))
  7686. keys)
  7687. '('orgstruct-error))))))))
  7688. (defun org-context-p (&rest contexts)
  7689. "Check if local context is any of CONTEXTS.
  7690. Possible values in the list of contexts are `table', `headline', and `item'."
  7691. (let ((pos (point)))
  7692. (goto-char (point-at-bol))
  7693. (prog1 (or (and (memq 'table contexts)
  7694. (looking-at "[ \t]*|"))
  7695. (and (memq 'headline contexts)
  7696. (looking-at org-outline-regexp))
  7697. (and (memq 'item contexts)
  7698. (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
  7699. (and (memq 'item-body contexts)
  7700. (org-in-item-p)))
  7701. (goto-char pos))))
  7702. (defun org-get-local-variables ()
  7703. "Return a list of all local variables in an org-mode buffer."
  7704. (let (varlist)
  7705. (with-current-buffer (get-buffer-create "*Org tmp*")
  7706. (erase-buffer)
  7707. (org-mode)
  7708. (setq varlist (buffer-local-variables)))
  7709. (kill-buffer "*Org tmp*")
  7710. (delq nil
  7711. (mapcar
  7712. (lambda (x)
  7713. (setq x
  7714. (if (symbolp x)
  7715. (list x)
  7716. (list (car x) (list 'quote (cdr x)))))
  7717. (if (string-match
  7718. "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
  7719. (symbol-name (car x)))
  7720. x nil))
  7721. varlist))))
  7722. (defun org-clone-local-variables (from-buffer &optional regexp)
  7723. "Clone local variables from FROM-BUFFER.
  7724. Optional argument REGEXP selects variables to clone."
  7725. (mapc
  7726. (lambda (pair)
  7727. (and (symbolp (car pair))
  7728. (or (null regexp)
  7729. (string-match regexp (symbol-name (car pair))))
  7730. (set (make-local-variable (car pair))
  7731. (cdr pair))))
  7732. (buffer-local-variables from-buffer)))
  7733. ;;;###autoload
  7734. (defun org-run-like-in-org-mode (cmd)
  7735. "Run a command, pretending that the current buffer is in Org-mode.
  7736. This will temporarily bind local variables that are typically bound in
  7737. Org-mode to the values they have in Org-mode, and then interactively
  7738. call CMD."
  7739. (org-load-modules-maybe)
  7740. (unless org-local-vars
  7741. (setq org-local-vars (org-get-local-variables)))
  7742. (eval (list 'let org-local-vars
  7743. (list 'call-interactively (list 'quote cmd)))))
  7744. ;;;; Archiving
  7745. (defun org-get-category (&optional pos force-refresh)
  7746. "Get the category applying to position POS."
  7747. (save-match-data
  7748. (if force-refresh (org-refresh-category-properties))
  7749. (let ((pos (or pos (point))))
  7750. (or (get-text-property pos 'org-category)
  7751. (progn (org-refresh-category-properties)
  7752. (get-text-property pos 'org-category))))))
  7753. (defun org-refresh-category-properties ()
  7754. "Refresh category text properties in the buffer."
  7755. (let ((inhibit-read-only t)
  7756. (def-cat (cond
  7757. ((null org-category)
  7758. (if buffer-file-name
  7759. (file-name-sans-extension
  7760. (file-name-nondirectory buffer-file-name))
  7761. "???"))
  7762. ((symbolp org-category) (symbol-name org-category))
  7763. (t org-category)))
  7764. beg end cat pos optionp)
  7765. (org-unmodified
  7766. (save-excursion
  7767. (save-restriction
  7768. (widen)
  7769. (goto-char (point-min))
  7770. (put-text-property (point) (point-max) 'org-category def-cat)
  7771. (while (re-search-forward
  7772. "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
  7773. (setq pos (match-end 0)
  7774. optionp (equal (char-after (match-beginning 0)) ?#)
  7775. cat (org-trim (match-string 2)))
  7776. (if optionp
  7777. (setq beg (point-at-bol) end (point-max))
  7778. (org-back-to-heading t)
  7779. (setq beg (point) end (org-end-of-subtree t t)))
  7780. (put-text-property beg end 'org-category cat)
  7781. (put-text-property beg end 'org-category-position beg)
  7782. (goto-char pos)))))))
  7783. ;;;; Link Stuff
  7784. ;;; Link abbreviations
  7785. (defun org-link-expand-abbrev (link)
  7786. "Apply replacements as defined in `org-link-abbrev-alist'."
  7787. (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
  7788. (let* ((key (match-string 1 link))
  7789. (as (or (assoc key org-link-abbrev-alist-local)
  7790. (assoc key org-link-abbrev-alist)))
  7791. (tag (and (match-end 2) (match-string 3 link)))
  7792. rpl)
  7793. (if (not as)
  7794. link
  7795. (setq rpl (cdr as))
  7796. (cond
  7797. ((symbolp rpl) (funcall rpl tag))
  7798. ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
  7799. ((string-match "%h" rpl)
  7800. (replace-match (url-hexify-string (or tag "")) t t rpl))
  7801. (t (concat rpl tag)))))
  7802. link))
  7803. ;;; Storing and inserting links
  7804. (defvar org-insert-link-history nil
  7805. "Minibuffer history for links inserted with `org-insert-link'.")
  7806. (defvar org-stored-links nil
  7807. "Contains the links stored with `org-store-link'.")
  7808. (defvar org-store-link-plist nil
  7809. "Plist with info about the most recently link created with `org-store-link'.")
  7810. (defvar org-link-protocols nil
  7811. "Link protocols added to Org-mode using `org-add-link-type'.")
  7812. (defvar org-store-link-functions nil
  7813. "List of functions that are called to create and store a link.
  7814. Each function will be called in turn until one returns a non-nil
  7815. value. Each function should check if it is responsible for creating
  7816. this link (for example by looking at the major mode).
  7817. If not, it must exit and return nil.
  7818. If yes, it should return a non-nil value after a calling
  7819. `org-store-link-props' with a list of properties and values.
  7820. Special properties are:
  7821. :type The link prefix, like \"http\". This must be given.
  7822. :link The link, like \"http://www.astro.uva.nl/~dominik\".
  7823. This is obligatory as well.
  7824. :description Optional default description for the second pair
  7825. of brackets in an Org-mode link. The user can still change
  7826. this when inserting this link into an Org-mode buffer.
  7827. In addition to these, any additional properties can be specified
  7828. and then used in remember templates.")
  7829. (defun org-add-link-type (type &optional follow export)
  7830. "Add TYPE to the list of `org-link-types'.
  7831. Re-compute all regular expressions depending on `org-link-types'
  7832. FOLLOW and EXPORT are two functions.
  7833. FOLLOW should take the link path as the single argument and do whatever
  7834. is necessary to follow the link, for example find a file or display
  7835. a mail message.
  7836. EXPORT should format the link path for export to one of the export formats.
  7837. It should be a function accepting three arguments:
  7838. path the path of the link, the text after the prefix (like \"http:\")
  7839. desc the description of the link, if any, or a description added by
  7840. org-export-normalize-links if there is none
  7841. format the export format, a symbol like `html' or `latex' or `ascii'..
  7842. The function may use the FORMAT information to return different values
  7843. depending on the format. The return value will be put literally into
  7844. the exported file. If the return value is nil, this means Org should
  7845. do what it normally does with links which do not have EXPORT defined.
  7846. Org-mode has a built-in default for exporting links. If you are happy with
  7847. this default, there is no need to define an export function for the link
  7848. type. For a simple example of an export function, see `org-bbdb.el'."
  7849. (add-to-list 'org-link-types type t)
  7850. (org-make-link-regexps)
  7851. (if (assoc type org-link-protocols)
  7852. (setcdr (assoc type org-link-protocols) (list follow export))
  7853. (push (list type follow export) org-link-protocols)))
  7854. (defvar org-agenda-buffer-name)
  7855. ;;;###autoload
  7856. (defun org-store-link (arg)
  7857. "\\<org-mode-map>Store an org-link to the current location.
  7858. This link is added to `org-stored-links' and can later be inserted
  7859. into an org-buffer with \\[org-insert-link].
  7860. For some link types, a prefix arg is interpreted:
  7861. For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
  7862. For file links, arg negates `org-context-in-file-links'."
  7863. (interactive "P")
  7864. (org-load-modules-maybe)
  7865. (setq org-store-link-plist nil) ; reset
  7866. (org-with-limited-levels
  7867. (let (link cpltxt desc description search txt custom-id agenda-link)
  7868. (cond
  7869. ((run-hook-with-args-until-success 'org-store-link-functions)
  7870. (setq link (plist-get org-store-link-plist :link)
  7871. desc (or (plist-get org-store-link-plist :description) link)))
  7872. ((org-src-edit-buffer-p)
  7873. (let (label gc)
  7874. (while (or (not label)
  7875. (save-excursion
  7876. (save-restriction
  7877. (widen)
  7878. (goto-char (point-min))
  7879. (re-search-forward
  7880. (regexp-quote (format org-coderef-label-format label))
  7881. nil t))))
  7882. (when label (message "Label exists already") (sit-for 2))
  7883. (setq label (read-string "Code line label: " label)))
  7884. (end-of-line 1)
  7885. (setq link (format org-coderef-label-format label))
  7886. (setq gc (- 79 (length link)))
  7887. (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
  7888. (insert link)
  7889. (setq link (concat "(" label ")") desc nil)))
  7890. ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
  7891. ;; We are in the agenda, link to referenced location
  7892. (let ((m (or (get-text-property (point) 'org-hd-marker)
  7893. (get-text-property (point) 'org-marker))))
  7894. (when m
  7895. (org-with-point-at m
  7896. (setq agenda-link
  7897. (if (org-called-interactively-p 'any)
  7898. (call-interactively 'org-store-link)
  7899. (org-store-link nil)))))))
  7900. ((eq major-mode 'calendar-mode)
  7901. (let ((cd (calendar-cursor-to-date)))
  7902. (setq link
  7903. (format-time-string
  7904. (car org-time-stamp-formats)
  7905. (apply 'encode-time
  7906. (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
  7907. nil nil nil))))
  7908. (org-store-link-props :type "calendar" :date cd)))
  7909. ((eq major-mode 'w3-mode)
  7910. (setq cpltxt (if (and (buffer-name)
  7911. (not (string-match "Untitled" (buffer-name))))
  7912. (buffer-name)
  7913. (url-view-url t))
  7914. link (org-make-link (url-view-url t)))
  7915. (org-store-link-props :type "w3" :url (url-view-url t)))
  7916. ((eq major-mode 'w3m-mode)
  7917. (setq cpltxt (or w3m-current-title w3m-current-url)
  7918. link (org-make-link w3m-current-url))
  7919. (org-store-link-props :type "w3m" :url (url-view-url t)))
  7920. ((setq search (run-hook-with-args-until-success
  7921. 'org-create-file-search-functions))
  7922. (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
  7923. "::" search))
  7924. (setq cpltxt (or description link)))
  7925. ((eq major-mode 'image-mode)
  7926. (setq cpltxt (concat "file:"
  7927. (abbreviate-file-name buffer-file-name))
  7928. link (org-make-link cpltxt))
  7929. (org-store-link-props :type "image" :file buffer-file-name))
  7930. ((eq major-mode 'dired-mode)
  7931. ;; link to the file in the current line
  7932. (let ((file (dired-get-filename nil t)))
  7933. (setq file (if file
  7934. (abbreviate-file-name
  7935. (expand-file-name (dired-get-filename nil t)))
  7936. ;; otherwise, no file so use current directory.
  7937. default-directory))
  7938. (setq cpltxt (concat "file:" file)
  7939. link (org-make-link cpltxt))))
  7940. ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
  7941. (setq custom-id (org-entry-get nil "CUSTOM_ID"))
  7942. (cond
  7943. ((org-in-regexp "<<\\(.*?\\)>>")
  7944. (setq cpltxt
  7945. (concat "file:"
  7946. (abbreviate-file-name
  7947. (buffer-file-name (buffer-base-buffer)))
  7948. "::" (match-string 1))
  7949. link (org-make-link cpltxt)))
  7950. ((and (featurep 'org-id)
  7951. (or (eq org-link-to-org-use-id t)
  7952. (and (eq org-link-to-org-use-id 'create-if-interactive)
  7953. (org-called-interactively-p 'any))
  7954. (and (eq org-link-to-org-use-id
  7955. 'create-if-interactive-and-no-custom-id)
  7956. (org-called-interactively-p 'any)
  7957. (not custom-id))
  7958. (and org-link-to-org-use-id
  7959. (org-entry-get nil "ID"))))
  7960. ;; We can make a link using the ID.
  7961. (setq link (condition-case nil
  7962. (prog1 (org-id-store-link)
  7963. (setq desc (plist-get org-store-link-plist
  7964. :description)))
  7965. (error
  7966. ;; probably before first headline, link to file only
  7967. (concat "file:"
  7968. (abbreviate-file-name
  7969. (buffer-file-name (buffer-base-buffer))))))))
  7970. (t
  7971. ;; Just link to current headline
  7972. (setq cpltxt (concat "file:"
  7973. (abbreviate-file-name
  7974. (buffer-file-name (buffer-base-buffer)))))
  7975. ;; Add a context search string
  7976. (when (org-xor org-context-in-file-links arg)
  7977. (setq txt (cond
  7978. ((org-at-heading-p) nil)
  7979. ((org-region-active-p)
  7980. (buffer-substring (region-beginning) (region-end)))
  7981. (t nil)))
  7982. (when (or (null txt) (string-match "\\S-" txt))
  7983. (setq cpltxt
  7984. (concat cpltxt "::"
  7985. (condition-case nil
  7986. (org-make-org-heading-search-string txt)
  7987. (error "")))
  7988. desc (or (nth 4 (ignore-errors
  7989. (org-heading-components))) "NONE"))))
  7990. (if (string-match "::\\'" cpltxt)
  7991. (setq cpltxt (substring cpltxt 0 -2)))
  7992. (setq link (org-make-link cpltxt)))))
  7993. ((buffer-file-name (buffer-base-buffer))
  7994. ;; Just link to this file here.
  7995. (setq cpltxt (concat "file:"
  7996. (abbreviate-file-name
  7997. (buffer-file-name (buffer-base-buffer)))))
  7998. ;; Add a context string
  7999. (when (org-xor org-context-in-file-links arg)
  8000. (setq txt (if (org-region-active-p)
  8001. (buffer-substring (region-beginning) (region-end))
  8002. (buffer-substring (point-at-bol) (point-at-eol))))
  8003. ;; Only use search option if there is some text.
  8004. (when (string-match "\\S-" txt)
  8005. (setq cpltxt
  8006. (concat cpltxt "::" (org-make-org-heading-search-string txt))
  8007. desc "NONE")))
  8008. (setq link (org-make-link cpltxt)))
  8009. ((org-called-interactively-p 'interactive)
  8010. (error "Cannot link to a buffer which is not visiting a file"))
  8011. (t (setq link nil)))
  8012. (if (consp link) (setq cpltxt (car link) link (cdr link)))
  8013. (setq link (or link cpltxt)
  8014. desc (or desc cpltxt))
  8015. (if (equal desc "NONE") (setq desc nil))
  8016. (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
  8017. (progn
  8018. (setq org-stored-links
  8019. (cons (list link desc) org-stored-links))
  8020. (message "Stored: %s" (or desc link))
  8021. (when custom-id
  8022. (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
  8023. "::#" custom-id))
  8024. (setq org-stored-links
  8025. (cons (list link desc) org-stored-links))))
  8026. (or agenda-link (and link (org-make-link-string link desc)))))))
  8027. (defun org-store-link-props (&rest plist)
  8028. "Store link properties, extract names and addresses."
  8029. (let (x adr)
  8030. (when (setq x (plist-get plist :from))
  8031. (setq adr (mail-extract-address-components x))
  8032. (setq plist (plist-put plist :fromname (car adr)))
  8033. (setq plist (plist-put plist :fromaddress (nth 1 adr))))
  8034. (when (setq x (plist-get plist :to))
  8035. (setq adr (mail-extract-address-components x))
  8036. (setq plist (plist-put plist :toname (car adr)))
  8037. (setq plist (plist-put plist :toaddress (nth 1 adr)))))
  8038. (let ((from (plist-get plist :from))
  8039. (to (plist-get plist :to)))
  8040. (when (and from to org-from-is-user-regexp)
  8041. (setq plist
  8042. (plist-put plist :fromto
  8043. (if (string-match org-from-is-user-regexp from)
  8044. (concat "to %t")
  8045. (concat "from %f"))))))
  8046. (setq org-store-link-plist plist))
  8047. (defun org-add-link-props (&rest plist)
  8048. "Add these properties to the link property list."
  8049. (let (key value)
  8050. (while plist
  8051. (setq key (pop plist) value (pop plist))
  8052. (setq org-store-link-plist
  8053. (plist-put org-store-link-plist key value)))))
  8054. (defun org-email-link-description (&optional fmt)
  8055. "Return the description part of an email link.
  8056. This takes information from `org-store-link-plist' and formats it
  8057. according to FMT (default from `org-email-link-description-format')."
  8058. (setq fmt (or fmt org-email-link-description-format))
  8059. (let* ((p org-store-link-plist)
  8060. (to (plist-get p :toaddress))
  8061. (from (plist-get p :fromaddress))
  8062. (table
  8063. (list
  8064. (cons "%c" (plist-get p :fromto))
  8065. (cons "%F" (plist-get p :from))
  8066. (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
  8067. (cons "%T" (plist-get p :to))
  8068. (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
  8069. (cons "%s" (plist-get p :subject))
  8070. (cons "%d" (plist-get p :date))
  8071. (cons "%m" (plist-get p :message-id)))))
  8072. (when (string-match "%c" fmt)
  8073. ;; Check if the user wrote this message
  8074. (if (and org-from-is-user-regexp from to
  8075. (save-match-data (string-match org-from-is-user-regexp from)))
  8076. (setq fmt (replace-match "to %t" t t fmt))
  8077. (setq fmt (replace-match "from %f" t t fmt))))
  8078. (org-replace-escapes fmt table)))
  8079. (defun org-make-org-heading-search-string (&optional string heading)
  8080. "Make search string for STRING or current headline."
  8081. (interactive)
  8082. (let ((s (or string (org-get-heading)))
  8083. (lines org-context-in-file-links))
  8084. (unless (and string (not heading))
  8085. ;; We are using a headline, clean up garbage in there.
  8086. (if (string-match org-todo-regexp s)
  8087. (setq s (replace-match "" t t s)))
  8088. (if (string-match (org-re ":[[:alnum:]_@#%:]+:[ \t]*$") s)
  8089. (setq s (replace-match "" t t s)))
  8090. (setq s (org-trim s))
  8091. (if (string-match (concat "^\\(" org-quote-string "\\|"
  8092. org-comment-string "\\)") s)
  8093. (setq s (replace-match "" t t s)))
  8094. (while (string-match org-ts-regexp s)
  8095. (setq s (replace-match "" t t s))))
  8096. (or string (setq s (concat "*" s))) ; Add * for headlines
  8097. (when (and string (integerp lines) (> lines 0))
  8098. (let ((slines (org-split-string s "\n")))
  8099. (when (< lines (length slines))
  8100. (setq s (mapconcat
  8101. 'identity
  8102. (reverse (nthcdr (- (length slines) lines)
  8103. (reverse slines))) "\n")))))
  8104. (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
  8105. (defun org-make-link (&rest strings)
  8106. "Concatenate STRINGS."
  8107. (apply 'concat strings))
  8108. (defun org-make-link-string (link &optional description)
  8109. "Make a link with brackets, consisting of LINK and DESCRIPTION."
  8110. (unless (string-match "\\S-" link)
  8111. (error "Empty link"))
  8112. (when (and description
  8113. (stringp description)
  8114. (not (string-match "\\S-" description)))
  8115. (setq description nil))
  8116. (when (stringp description)
  8117. ;; Remove brackets from the description, they are fatal.
  8118. (while (string-match "\\[" description)
  8119. (setq description (replace-match "{" t t description)))
  8120. (while (string-match "\\]" description)
  8121. (setq description (replace-match "}" t t description))))
  8122. (when (equal link description)
  8123. ;; No description needed, it is identical
  8124. (setq description nil))
  8125. (when (and (not description)
  8126. (not (string-match (org-image-file-name-regexp) link))
  8127. (not (equal link (org-link-escape link))))
  8128. (setq description (org-extract-attributes link)))
  8129. (setq link
  8130. (cond ((string-match (org-image-file-name-regexp) link) link)
  8131. ((string-match org-link-types-re link)
  8132. (concat (match-string 1 link)
  8133. (org-link-escape (substring link (match-end 1)))))
  8134. (t (org-link-escape link))))
  8135. (concat "[[" link "]"
  8136. (if description (concat "[" description "]") "")
  8137. "]"))
  8138. (defconst org-link-escape-chars
  8139. '(?\ ?\[ ?\] ?\; ?\= ?\+)
  8140. "List of characters that should be escaped in link.
  8141. This is the list that is used for internal purposes.")
  8142. (defvar org-url-encoding-use-url-hexify nil)
  8143. (defconst org-link-escape-chars-browser
  8144. '(?\ )
  8145. "List of escapes for characters that are problematic in links.
  8146. This is the list that is used before handing over to the browser.")
  8147. (defun org-link-escape (text &optional table merge)
  8148. "Return percent escaped representation of TEXT.
  8149. TEXT is a string with the text to escape.
  8150. Optional argument TABLE is a list with characters that should be
  8151. escaped. When nil, `org-link-escape-chars' is used.
  8152. If optional argument MERGE is set, merge TABLE into
  8153. `org-link-escape-chars'."
  8154. (if (and org-url-encoding-use-url-hexify (not table))
  8155. (url-hexify-string text)
  8156. (cond
  8157. ((and table merge)
  8158. (mapc (lambda (defchr)
  8159. (unless (member defchr table)
  8160. (setq table (cons defchr table)))) org-link-escape-chars))
  8161. ((null table)
  8162. (setq table org-link-escape-chars)))
  8163. (mapconcat
  8164. (lambda (char)
  8165. (if (or (member char table)
  8166. (< char 32) (= char 37) (> char 126))
  8167. (mapconcat (lambda (sequence-element)
  8168. (format "%%%.2X" sequence-element))
  8169. (or (encode-coding-char char 'utf-8)
  8170. (error "Unable to percent escape character: %s"
  8171. (char-to-string char))) "")
  8172. (char-to-string char))) text "")))
  8173. (defun org-link-unescape (str)
  8174. "Unhex hexified Unicode strings as returned from the JavaScript function
  8175. encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
  8176. (unless (and (null str) (string= "" str))
  8177. (let ((pos 0) (case-fold-search t) unhexed)
  8178. (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
  8179. (setq unhexed (org-link-unescape-compound (match-string 0 str)))
  8180. (setq str (replace-match unhexed t t str))
  8181. (setq pos (+ pos (length unhexed))))))
  8182. str)
  8183. (defun org-link-unescape-compound (hex)
  8184. "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
  8185. Note: this function also decodes single byte encodings like
  8186. `%E1' (\"á\") if not followed by another `%[A-F0-9]{2}' group."
  8187. (save-match-data
  8188. (let* ((bytes (cdr (split-string hex "%")))
  8189. (ret "")
  8190. (eat 0)
  8191. (sum 0))
  8192. (while bytes
  8193. (let* ((val (string-to-number (pop bytes) 16))
  8194. (shift-xor
  8195. (if (= 0 eat)
  8196. (cond
  8197. ((>= val 252) (cons 6 252))
  8198. ((>= val 248) (cons 5 248))
  8199. ((>= val 240) (cons 4 240))
  8200. ((>= val 224) (cons 3 224))
  8201. ((>= val 192) (cons 2 192))
  8202. (t (cons 0 0)))
  8203. (cons 6 128))))
  8204. (if (>= val 192) (setq eat (car shift-xor)))
  8205. (setq val (logxor val (cdr shift-xor)))
  8206. (setq sum (+ (lsh sum (car shift-xor)) val))
  8207. (if (> eat 0) (setq eat (- eat 1)))
  8208. (cond
  8209. ((= 0 eat) ;multi byte
  8210. (setq ret (concat ret (org-char-to-string sum)))
  8211. (setq sum 0))
  8212. ((not bytes) ; single byte(s)
  8213. (setq ret (org-link-unescape-single-byte-sequence hex))))
  8214. )) ;; end (while bytes
  8215. ret )))
  8216. (defun org-link-unescape-single-byte-sequence (hex)
  8217. "Unhexify hex-encoded single byte character sequences."
  8218. (mapconcat (lambda (byte)
  8219. (char-to-string (string-to-number byte 16)))
  8220. (cdr (split-string hex "%")) ""))
  8221. (defun org-xor (a b)
  8222. "Exclusive or."
  8223. (if a (not b) b))
  8224. (defun org-fixup-message-id-for-http (s)
  8225. "Replace special characters in a message id, so it can be used in an http query."
  8226. (when (string-match "%" s)
  8227. (setq s (mapconcat (lambda (c)
  8228. (if (eq c ?%)
  8229. "%25"
  8230. (char-to-string c)))
  8231. s "")))
  8232. (while (string-match "<" s)
  8233. (setq s (replace-match "%3C" t t s)))
  8234. (while (string-match ">" s)
  8235. (setq s (replace-match "%3E" t t s)))
  8236. (while (string-match "@" s)
  8237. (setq s (replace-match "%40" t t s)))
  8238. s)
  8239. (defun org-link-prettify (link)
  8240. "Return a human-readable representation of LINK.
  8241. The car of LINK must be a raw link the cdr of LINK must be either
  8242. a link description or nil."
  8243. (let ((desc (or (cadr link) "<no description>")))
  8244. (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
  8245. "[[" (car link) "]]")))
  8246. ;;;###autoload
  8247. (defun org-insert-link-global ()
  8248. "Insert a link like Org-mode does.
  8249. This command can be called in any mode to insert a link in Org-mode syntax."
  8250. (interactive)
  8251. (org-load-modules-maybe)
  8252. (org-run-like-in-org-mode 'org-insert-link))
  8253. (defun org-insert-link (&optional complete-file link-location default-description)
  8254. "Insert a link. At the prompt, enter the link.
  8255. Completion can be used to insert any of the link protocol prefixes like
  8256. http or ftp in use.
  8257. The history can be used to select a link previously stored with
  8258. `org-store-link'. When the empty string is entered (i.e. if you just
  8259. press RET at the prompt), the link defaults to the most recently
  8260. stored link. As SPC triggers completion in the minibuffer, you need to
  8261. use M-SPC or C-q SPC to force the insertion of a space character.
  8262. You will also be prompted for a description, and if one is given, it will
  8263. be displayed in the buffer instead of the link.
  8264. If there is already a link at point, this command will allow you to edit link
  8265. and description parts.
  8266. With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
  8267. be selected using completion. The path to the file will be relative to the
  8268. current directory if the file is in the current directory or a subdirectory.
  8269. Otherwise, the link will be the absolute path as completed in the minibuffer
  8270. \(i.e. normally ~/path/to/file). You can configure this behavior using the
  8271. option `org-link-file-path-type'.
  8272. With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
  8273. the current directory or below.
  8274. With three \\[universal-argument] prefixes, negate the meaning of
  8275. `org-keep-stored-link-after-insertion'.
  8276. If `org-make-link-description-function' is non-nil, this function will be
  8277. called with the link target, and the result will be the default
  8278. link description.
  8279. If the LINK-LOCATION parameter is non-nil, this value will be
  8280. used as the link location instead of reading one interactively.
  8281. If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
  8282. be used as the default description."
  8283. (interactive "P")
  8284. (let* ((wcf (current-window-configuration))
  8285. (region (if (org-region-active-p)
  8286. (buffer-substring (region-beginning) (region-end))))
  8287. (remove (and region (list (region-beginning) (region-end))))
  8288. (desc region)
  8289. tmphist ; byte-compile incorrectly complains about this
  8290. (link link-location)
  8291. entry file all-prefixes)
  8292. (cond
  8293. (link-location) ; specified by arg, just use it.
  8294. ((org-in-regexp org-bracket-link-regexp 1)
  8295. ;; We do have a link at point, and we are going to edit it.
  8296. (setq remove (list (match-beginning 0) (match-end 0)))
  8297. (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
  8298. (setq link (read-string "Link: "
  8299. (org-link-unescape
  8300. (org-match-string-no-properties 1)))))
  8301. ((or (org-in-regexp org-angle-link-re)
  8302. (org-in-regexp org-plain-link-re))
  8303. ;; Convert to bracket link
  8304. (setq remove (list (match-beginning 0) (match-end 0))
  8305. link (read-string "Link: "
  8306. (org-remove-angle-brackets (match-string 0)))))
  8307. ((member complete-file '((4) (16)))
  8308. ;; Completing read for file names.
  8309. (setq link (org-file-complete-link complete-file)))
  8310. (t
  8311. ;; Read link, with completion for stored links.
  8312. (with-output-to-temp-buffer "*Org Links*"
  8313. (princ "Insert a link.
  8314. Use TAB to complete link prefixes, then RET for type-specific completion support\n")
  8315. (when org-stored-links
  8316. (princ "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
  8317. (princ (mapconcat 'org-link-prettify
  8318. (reverse org-stored-links) "\n"))))
  8319. (let ((cw (selected-window)))
  8320. (select-window (get-buffer-window "*Org Links*" 'visible))
  8321. (with-current-buffer "*Org Links*" (setq truncate-lines t))
  8322. (unless (pos-visible-in-window-p (point-max))
  8323. (org-fit-window-to-buffer))
  8324. (and (window-live-p cw) (select-window cw)))
  8325. ;; Fake a link history, containing the stored links.
  8326. (setq tmphist (append (mapcar 'car org-stored-links)
  8327. org-insert-link-history))
  8328. (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
  8329. (mapcar 'car org-link-abbrev-alist)
  8330. org-link-types))
  8331. (unwind-protect
  8332. (progn
  8333. (setq link
  8334. (let ((org-completion-use-ido nil)
  8335. (org-completion-use-iswitchb nil))
  8336. (org-completing-read
  8337. "Link: "
  8338. (append
  8339. (mapcar (lambda (x) (list (concat x ":")))
  8340. all-prefixes)
  8341. (mapcar 'car org-stored-links))
  8342. nil nil nil
  8343. 'tmphist
  8344. (car (car org-stored-links)))))
  8345. (if (not (string-match "\\S-" link))
  8346. (error "No link selected"))
  8347. (if (or (member link all-prefixes)
  8348. (and (equal ":" (substring link -1))
  8349. (member (substring link 0 -1) all-prefixes)
  8350. (setq link (substring link 0 -1))))
  8351. (setq link (org-link-try-special-completion link))))
  8352. (set-window-configuration wcf)
  8353. (kill-buffer "*Org Links*"))
  8354. (setq entry (assoc link org-stored-links))
  8355. (or entry (push link org-insert-link-history))
  8356. (if (funcall (if (equal complete-file '(64)) 'not 'identity)
  8357. (not org-keep-stored-link-after-insertion))
  8358. (setq org-stored-links (delq (assoc link org-stored-links)
  8359. org-stored-links)))
  8360. (setq desc (or desc (nth 1 entry)))))
  8361. (if (string-match org-plain-link-re link)
  8362. ;; URL-like link, normalize the use of angular brackets.
  8363. (setq link (org-make-link (org-remove-angle-brackets link))))
  8364. ;; Check if we are linking to the current file with a search option
  8365. ;; If yes, simplify the link by using only the search option.
  8366. (when (and buffer-file-name
  8367. (string-match "^file:\\(.+?\\)::\\([^>]+\\)" link))
  8368. (let* ((path (match-string 1 link))
  8369. (case-fold-search nil)
  8370. (search (match-string 2 link)))
  8371. (save-match-data
  8372. (if (equal (file-truename buffer-file-name) (file-truename path))
  8373. ;; We are linking to this same file, with a search option
  8374. (setq link search)))))
  8375. ;; Check if we can/should use a relative path. If yes, simplify the link
  8376. (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
  8377. (let* ((type (match-string 1 link))
  8378. (path (match-string 2 link))
  8379. (origpath path)
  8380. (case-fold-search nil))
  8381. (cond
  8382. ((or (eq org-link-file-path-type 'absolute)
  8383. (equal complete-file '(16)))
  8384. (setq path (abbreviate-file-name (expand-file-name path))))
  8385. ((eq org-link-file-path-type 'noabbrev)
  8386. (setq path (expand-file-name path)))
  8387. ((eq org-link-file-path-type 'relative)
  8388. (setq path (file-relative-name path)))
  8389. (t
  8390. (save-match-data
  8391. (if (string-match (concat "^" (regexp-quote
  8392. (expand-file-name
  8393. (file-name-as-directory
  8394. default-directory))))
  8395. (expand-file-name path))
  8396. ;; We are linking a file with relative path name.
  8397. (setq path (substring (expand-file-name path)
  8398. (match-end 0)))
  8399. (setq path (abbreviate-file-name (expand-file-name path)))))))
  8400. (setq link (concat type path))
  8401. (if (equal desc origpath)
  8402. (setq desc path))))
  8403. (if org-make-link-description-function
  8404. (setq desc (funcall org-make-link-description-function link desc))
  8405. (if default-description (setq desc default-description)))
  8406. (setq desc (read-string "Description: " desc))
  8407. (unless (string-match "\\S-" desc) (setq desc nil))
  8408. (if remove (apply 'delete-region remove))
  8409. (insert (org-make-link-string link desc))))
  8410. (defun org-link-try-special-completion (type)
  8411. "If there is completion support for link type TYPE, offer it."
  8412. (let ((fun (intern (concat "org-" type "-complete-link"))))
  8413. (if (functionp fun)
  8414. (funcall fun)
  8415. (read-string "Link (no completion support): " (concat type ":")))))
  8416. (defun org-file-complete-link (&optional arg)
  8417. "Create a file link using completion."
  8418. (let (file link)
  8419. (setq file (read-file-name "File: "))
  8420. (let ((pwd (file-name-as-directory (expand-file-name ".")))
  8421. (pwd1 (file-name-as-directory (abbreviate-file-name
  8422. (expand-file-name ".")))))
  8423. (cond
  8424. ((equal arg '(16))
  8425. (setq link (org-make-link
  8426. "file:"
  8427. (abbreviate-file-name (expand-file-name file)))))
  8428. ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
  8429. (setq link (org-make-link "file:" (match-string 1 file))))
  8430. ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
  8431. (expand-file-name file))
  8432. (setq link (org-make-link
  8433. "file:" (match-string 1 (expand-file-name file)))))
  8434. (t (setq link (org-make-link "file:" file)))))
  8435. link))
  8436. (defun org-completing-read (&rest args)
  8437. "Completing-read with SPACE being a normal character."
  8438. (let ((enable-recursive-minibuffers t)
  8439. (minibuffer-local-completion-map
  8440. (copy-keymap minibuffer-local-completion-map)))
  8441. (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
  8442. (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
  8443. (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
  8444. (apply 'org-icompleting-read args)))
  8445. (defun org-completing-read-no-i (&rest args)
  8446. (let (org-completion-use-ido org-completion-use-iswitchb)
  8447. (apply 'org-completing-read args)))
  8448. (defun org-iswitchb-completing-read (prompt choices &rest args)
  8449. "Use iswitch as a completing-read replacement to choose from choices.
  8450. PROMPT is a string to prompt with. CHOICES is a list of strings to choose
  8451. from."
  8452. (let* ((iswitchb-use-virtual-buffers nil)
  8453. (iswitchb-make-buflist-hook
  8454. (lambda ()
  8455. (setq iswitchb-temp-buflist choices))))
  8456. (iswitchb-read-buffer prompt)))
  8457. (defun org-icompleting-read (&rest args)
  8458. "Completing-read using `ido-mode' or `iswitchb' speedups if available."
  8459. (org-without-partial-completion
  8460. (if (and org-completion-use-ido
  8461. (fboundp 'ido-completing-read)
  8462. (boundp 'ido-mode) ido-mode
  8463. (listp (second args)))
  8464. (let ((ido-enter-matching-directory nil))
  8465. (apply 'ido-completing-read (concat (car args))
  8466. (if (consp (car (nth 1 args)))
  8467. (mapcar 'car (nth 1 args))
  8468. (nth 1 args))
  8469. (cddr args)))
  8470. (if (and org-completion-use-iswitchb
  8471. (boundp 'iswitchb-mode) iswitchb-mode
  8472. (listp (second args)))
  8473. (apply 'org-iswitchb-completing-read (concat (car args))
  8474. (if (consp (car (nth 1 args)))
  8475. (mapcar 'car (nth 1 args))
  8476. (nth 1 args))
  8477. (cddr args))
  8478. (apply 'completing-read args)))))
  8479. (defun org-extract-attributes (s)
  8480. "Extract the attributes cookie from a string and set as text property."
  8481. (let (a attr (start 0) key value)
  8482. (save-match-data
  8483. (when (string-match "{{\\([^}]+\\)}}$" s)
  8484. (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
  8485. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
  8486. (setq key (match-string 1 a) value (match-string 2 a)
  8487. start (match-end 0)
  8488. attr (plist-put attr (intern key) value))))
  8489. (org-add-props s nil 'org-attr attr))
  8490. s))
  8491. (defun org-extract-attributes-from-string (tag)
  8492. (let (key value attr)
  8493. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"\\s-?" tag)
  8494. (setq key (match-string 1 tag) value (match-string 2 tag)
  8495. tag (replace-match "" t t tag)
  8496. attr (plist-put attr (intern key) value)))
  8497. (cons tag attr)))
  8498. (defun org-attributes-to-string (plist)
  8499. "Format a property list into an HTML attribute list."
  8500. (let ((s "") key value)
  8501. (while plist
  8502. (setq key (pop plist) value (pop plist))
  8503. (and value
  8504. (setq s (concat s " " (symbol-name key) "=\"" value "\""))))
  8505. s))
  8506. ;;; Opening/following a link
  8507. (defvar org-link-search-failed nil)
  8508. (defvar org-open-link-functions nil
  8509. "Hook for functions finding a plain text link.
  8510. These functions must take a single argument, the link content.
  8511. They will be called for links that look like [[link text][description]]
  8512. when LINK TEXT does not have a protocol like \"http:\" and does not look
  8513. like a filename (e.g. \"./blue.png\").
  8514. These functions will be called *before* Org attempts to resolve the
  8515. link by doing text searches in the current buffer - so if you want a
  8516. link \"[[target]]\" to still find \"<<target>>\", your function should
  8517. handle this as a special case.
  8518. When the function does handle the link, it must return a non-nil value.
  8519. If it decides that it is not responsible for this link, it must return
  8520. nil to indicate that that Org-mode can continue with other options
  8521. like exact and fuzzy text search.")
  8522. (defun org-next-link ()
  8523. "Move forward to the next link.
  8524. If the link is in hidden text, expose it."
  8525. (interactive)
  8526. (when (and org-link-search-failed (eq this-command last-command))
  8527. (goto-char (point-min))
  8528. (message "Link search wrapped back to beginning of buffer"))
  8529. (setq org-link-search-failed nil)
  8530. (let* ((pos (point))
  8531. (ct (org-context))
  8532. (a (assoc :link ct)))
  8533. (if a (goto-char (nth 2 a)))
  8534. (if (re-search-forward org-any-link-re nil t)
  8535. (progn
  8536. (goto-char (match-beginning 0))
  8537. (if (outline-invisible-p) (org-show-context)))
  8538. (goto-char pos)
  8539. (setq org-link-search-failed t)
  8540. (error "No further link found"))))
  8541. (defun org-previous-link ()
  8542. "Move backward to the previous link.
  8543. If the link is in hidden text, expose it."
  8544. (interactive)
  8545. (when (and org-link-search-failed (eq this-command last-command))
  8546. (goto-char (point-max))
  8547. (message "Link search wrapped back to end of buffer"))
  8548. (setq org-link-search-failed nil)
  8549. (let* ((pos (point))
  8550. (ct (org-context))
  8551. (a (assoc :link ct)))
  8552. (if a (goto-char (nth 1 a)))
  8553. (if (re-search-backward org-any-link-re nil t)
  8554. (progn
  8555. (goto-char (match-beginning 0))
  8556. (if (outline-invisible-p) (org-show-context)))
  8557. (goto-char pos)
  8558. (setq org-link-search-failed t)
  8559. (error "No further link found"))))
  8560. (defun org-translate-link (s)
  8561. "Translate a link string if a translation function has been defined."
  8562. (if (and org-link-translation-function
  8563. (fboundp org-link-translation-function)
  8564. (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
  8565. (progn
  8566. (setq s (funcall org-link-translation-function
  8567. (match-string 1 s) (match-string 2 s)))
  8568. (concat (car s) ":" (cdr s)))
  8569. s))
  8570. (defun org-translate-link-from-planner (type path)
  8571. "Translate a link from Emacs Planner syntax so that Org can follow it.
  8572. This is still an experimental function, your mileage may vary."
  8573. (cond
  8574. ((member type '("http" "https" "news" "ftp"))
  8575. ;; standard Internet links are the same.
  8576. nil)
  8577. ((and (equal type "irc") (string-match "^//" path))
  8578. ;; Planner has two / at the beginning of an irc link, we have 1.
  8579. ;; We should have zero, actually....
  8580. (setq path (substring path 1)))
  8581. ((and (equal type "lisp") (string-match "^/" path))
  8582. ;; Planner has a slash, we do not.
  8583. (setq type "elisp" path (substring path 1)))
  8584. ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
  8585. ;; A typical message link. Planner has the id after the final slash,
  8586. ;; we separate it with a hash mark
  8587. (setq path (concat (match-string 1 path) "#"
  8588. (org-remove-angle-brackets (match-string 2 path)))))
  8589. )
  8590. (cons type path))
  8591. (defun org-find-file-at-mouse (ev)
  8592. "Open file link or URL at mouse."
  8593. (interactive "e")
  8594. (mouse-set-point ev)
  8595. (org-open-at-point 'in-emacs))
  8596. (defun org-open-at-mouse (ev)
  8597. "Open file link or URL at mouse.
  8598. See the docstring of `org-open-file' for details."
  8599. (interactive "e")
  8600. (mouse-set-point ev)
  8601. (if (eq major-mode 'org-agenda-mode)
  8602. (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
  8603. (org-open-at-point))
  8604. (defvar org-window-config-before-follow-link nil
  8605. "The window configuration before following a link.
  8606. This is saved in case the need arises to restore it.")
  8607. (defvar org-open-link-marker (make-marker)
  8608. "Marker pointing to the location where `org-open-at-point; was called.")
  8609. ;;;###autoload
  8610. (defun org-open-at-point-global ()
  8611. "Follow a link like Org-mode does.
  8612. This command can be called in any mode to follow a link that has
  8613. Org-mode syntax."
  8614. (interactive)
  8615. (org-run-like-in-org-mode 'org-open-at-point))
  8616. ;;;###autoload
  8617. (defun org-open-link-from-string (s &optional arg reference-buffer)
  8618. "Open a link in the string S, as if it was in Org-mode."
  8619. (interactive "sLink: \nP")
  8620. (let ((reference-buffer (or reference-buffer (current-buffer))))
  8621. (with-temp-buffer
  8622. (let ((org-inhibit-startup (not reference-buffer)))
  8623. (org-mode)
  8624. (insert s)
  8625. (goto-char (point-min))
  8626. (when reference-buffer
  8627. (setq org-link-abbrev-alist-local
  8628. (with-current-buffer reference-buffer
  8629. org-link-abbrev-alist-local)))
  8630. (org-open-at-point arg reference-buffer)))))
  8631. (defvar org-open-at-point-functions nil
  8632. "Hook that is run when following a link at point.
  8633. Functions in this hook must return t if they identify and follow
  8634. a link at point. If they don't find anything interesting at point,
  8635. they must return nil.")
  8636. (defun org-open-at-point (&optional arg reference-buffer)
  8637. "Open link at or after point.
  8638. If there is no link at point, this function will search forward up to
  8639. the end of the current line.
  8640. Normally, files will be opened by an appropriate application. If the
  8641. optional prefix argument ARG is non-nil, Emacs will visit the file.
  8642. With a double prefix argument, try to open outside of Emacs, in the
  8643. application the system uses for this file type."
  8644. (interactive "P")
  8645. ;; if in a code block, then open the block's results
  8646. (unless (call-interactively #'org-babel-open-src-block-result)
  8647. (org-load-modules-maybe)
  8648. (move-marker org-open-link-marker (point))
  8649. (setq org-window-config-before-follow-link (current-window-configuration))
  8650. (org-remove-occur-highlights nil nil t)
  8651. (cond
  8652. ((and (org-at-heading-p)
  8653. (not (org-at-timestamp-p t))
  8654. (not (org-in-regexp
  8655. (concat org-plain-link-re "\\|"
  8656. org-bracket-link-regexp "\\|"
  8657. org-angle-link-re "\\|"
  8658. "[ \t]:[^ \t\n]+:[ \t]*$")))
  8659. (not (get-text-property (point) 'org-linked-text)))
  8660. (or (org-offer-links-in-entry arg)
  8661. (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
  8662. ((run-hook-with-args-until-success 'org-open-at-point-functions))
  8663. ((org-at-timestamp-p t) (org-follow-timestamp-link))
  8664. ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
  8665. (not (org-in-regexp org-bracket-link-regexp)))
  8666. (org-footnote-action))
  8667. (t
  8668. (let (type path link line search (pos (point)))
  8669. (catch 'match
  8670. (save-excursion
  8671. (skip-chars-forward "^]\n\r")
  8672. (when (org-in-regexp org-bracket-link-regexp 1)
  8673. (setq link (org-extract-attributes
  8674. (org-link-unescape (org-match-string-no-properties 1))))
  8675. (while (string-match " *\n *" link)
  8676. (setq link (replace-match " " t t link)))
  8677. (setq link (org-link-expand-abbrev link))
  8678. (cond
  8679. ((or (file-name-absolute-p link)
  8680. (string-match "^\\.\\.?/" link))
  8681. (setq type "file" path link))
  8682. ((string-match org-link-re-with-space3 link)
  8683. (setq type (match-string 1 link) path (match-string 2 link)))
  8684. (t (setq type "thisfile" path link)))
  8685. (throw 'match t)))
  8686. (when (get-text-property (point) 'org-linked-text)
  8687. (setq type "thisfile"
  8688. pos (if (get-text-property (1+ (point)) 'org-linked-text)
  8689. (1+ (point)) (point))
  8690. path (buffer-substring
  8691. (or (previous-single-property-change pos 'org-linked-text)
  8692. (point-min))
  8693. (or (next-single-property-change pos 'org-linked-text)
  8694. (point-max))))
  8695. (throw 'match t))
  8696. (save-excursion
  8697. (when (or (org-in-regexp org-angle-link-re)
  8698. (org-in-regexp org-plain-link-re))
  8699. (setq type (match-string 1)
  8700. path (org-link-unescape (match-string 2)))
  8701. (throw 'match t)))
  8702. (save-excursion
  8703. (when (org-in-regexp (org-re "\\(:[[:alnum:]_@#%:]+\\):[ \t]*$"))
  8704. (setq type "tags"
  8705. path (match-string 1))
  8706. (while (string-match ":" path)
  8707. (setq path (replace-match "+" t t path)))
  8708. (throw 'match t)))
  8709. (when (org-in-regexp "<\\([^><\n]+\\)>")
  8710. (setq type "tree-match"
  8711. path (match-string 1))
  8712. (throw 'match t)))
  8713. (unless path
  8714. (error "No link found"))
  8715. ;; switch back to reference buffer
  8716. ;; needed when if called in a temporary buffer through
  8717. ;; org-open-link-from-string
  8718. (with-current-buffer (or reference-buffer (current-buffer))
  8719. ;; Remove any trailing spaces in path
  8720. (if (string-match " +\\'" path)
  8721. (setq path (replace-match "" t t path)))
  8722. (if (and org-link-translation-function
  8723. (fboundp org-link-translation-function))
  8724. ;; Check if we need to translate the link
  8725. (let ((tmp (funcall org-link-translation-function type path)))
  8726. (setq type (car tmp) path (cdr tmp))))
  8727. (cond
  8728. ((assoc type org-link-protocols)
  8729. (funcall (nth 1 (assoc type org-link-protocols)) path))
  8730. ((equal type "mailto")
  8731. (let ((cmd (car org-link-mailto-program))
  8732. (args (cdr org-link-mailto-program)) args1
  8733. (address path) (subject "") a)
  8734. (if (string-match "\\(.*\\)::\\(.*\\)" path)
  8735. (setq address (match-string 1 path)
  8736. subject (org-link-escape (match-string 2 path))))
  8737. (while args
  8738. (cond
  8739. ((not (stringp (car args))) (push (pop args) args1))
  8740. (t (setq a (pop args))
  8741. (if (string-match "%a" a)
  8742. (setq a (replace-match address t t a)))
  8743. (if (string-match "%s" a)
  8744. (setq a (replace-match subject t t a)))
  8745. (push a args1))))
  8746. (apply cmd (nreverse args1))))
  8747. ((member type '("http" "https" "ftp" "news"))
  8748. (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
  8749. (org-link-escape
  8750. path org-link-escape-chars-browser)
  8751. path))))
  8752. ((string= type "doi")
  8753. (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
  8754. (org-link-escape
  8755. path org-link-escape-chars-browser)
  8756. path))))
  8757. ((member type '("message"))
  8758. (browse-url (concat type ":" path)))
  8759. ((string= type "tags")
  8760. (org-tags-view arg path))
  8761. ((string= type "tree-match")
  8762. (org-occur (concat "\\[" (regexp-quote path) "\\]")))
  8763. ((string= type "file")
  8764. (if (string-match "::\\([0-9]+\\)\\'" path)
  8765. (setq line (string-to-number (match-string 1 path))
  8766. path (substring path 0 (match-beginning 0)))
  8767. (if (string-match "::\\(.+\\)\\'" path)
  8768. (setq search (match-string 1 path)
  8769. path (substring path 0 (match-beginning 0)))))
  8770. (if (string-match "[*?{]" (file-name-nondirectory path))
  8771. (dired path)
  8772. (org-open-file path arg line search)))
  8773. ((string= type "shell")
  8774. (let ((cmd path))
  8775. (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
  8776. (string-match org-confirm-shell-link-not-regexp cmd))
  8777. (not org-confirm-shell-link-function)
  8778. (funcall org-confirm-shell-link-function
  8779. (format "Execute \"%s\" in shell? "
  8780. (org-add-props cmd nil
  8781. 'face 'org-warning))))
  8782. (progn
  8783. (message "Executing %s" cmd)
  8784. (shell-command cmd))
  8785. (error "Abort"))))
  8786. ((string= type "elisp")
  8787. (let ((cmd path))
  8788. (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
  8789. (string-match org-confirm-elisp-link-not-regexp cmd))
  8790. (not org-confirm-elisp-link-function)
  8791. (funcall org-confirm-elisp-link-function
  8792. (format "Execute \"%s\" as elisp? "
  8793. (org-add-props cmd nil
  8794. 'face 'org-warning))))
  8795. (message "%s => %s" cmd
  8796. (if (equal (string-to-char cmd) ?\()
  8797. (eval (read cmd))
  8798. (call-interactively (read cmd))))
  8799. (error "Abort"))))
  8800. ((and (string= type "thisfile")
  8801. (run-hook-with-args-until-success
  8802. 'org-open-link-functions path)))
  8803. ((string= type "thisfile")
  8804. (if arg
  8805. (switch-to-buffer-other-window
  8806. (org-get-buffer-for-internal-link (current-buffer)))
  8807. (org-mark-ring-push))
  8808. (let ((cmd `(org-link-search
  8809. ,path
  8810. ,(cond ((equal arg '(4)) ''occur)
  8811. ((equal arg '(16)) ''org-occur)
  8812. (t nil))
  8813. ,pos)))
  8814. (condition-case nil (let ((org-link-search-inhibit-query t))
  8815. (eval cmd))
  8816. (error (progn (widen) (eval cmd))))))
  8817. (t
  8818. (browse-url-at-point)))))))
  8819. (move-marker org-open-link-marker nil)
  8820. (run-hook-with-args 'org-follow-link-hook)))
  8821. (defun org-offer-links-in-entry (&optional nth zero)
  8822. "Offer links in the current entry and follow the selected link.
  8823. If there is only one link, follow it immediately as well.
  8824. If NTH is an integer, immediately pick the NTH link found.
  8825. If ZERO is a string, check also this string for a link, and if
  8826. there is one, offer it as link number zero."
  8827. (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
  8828. "\\(" org-angle-link-re "\\)\\|"
  8829. "\\(" org-plain-link-re "\\)"))
  8830. (cnt ?0)
  8831. (in-emacs (if (integerp nth) nil nth))
  8832. have-zero end links link c)
  8833. (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
  8834. (push (match-string 0 zero) links)
  8835. (setq cnt (1- cnt) have-zero t))
  8836. (save-excursion
  8837. (org-back-to-heading t)
  8838. (setq end (save-excursion (outline-next-heading) (point)))
  8839. (while (re-search-forward re end t)
  8840. (push (match-string 0) links))
  8841. (setq links (org-uniquify (reverse links))))
  8842. (cond
  8843. ((null links)
  8844. (message "No links"))
  8845. ((equal (length links) 1)
  8846. (setq link (list (car links))))
  8847. ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
  8848. (setq link (list (nth (if have-zero nth (1- nth)) links))))
  8849. (t ; we have to select a link
  8850. (save-excursion
  8851. (save-window-excursion
  8852. (delete-other-windows)
  8853. (with-output-to-temp-buffer "*Select Link*"
  8854. (mapc (lambda (l)
  8855. (if (not (string-match org-bracket-link-regexp l))
  8856. (princ (format "[%c] %s\n" (incf cnt)
  8857. (org-remove-angle-brackets l)))
  8858. (if (match-end 3)
  8859. (princ (format "[%c] %s (%s)\n" (incf cnt)
  8860. (match-string 3 l) (match-string 1 l)))
  8861. (princ (format "[%c] %s\n" (incf cnt)
  8862. (match-string 1 l))))))
  8863. links))
  8864. (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
  8865. (message "Select link to open, RET to open all:")
  8866. (setq c (read-char-exclusive))
  8867. (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
  8868. (when (equal c ?q) (error "Abort"))
  8869. (if (equal c ?\C-m)
  8870. (setq link links)
  8871. (setq nth (- c ?0))
  8872. (if have-zero (setq nth (1+ nth)))
  8873. (unless (and (integerp nth) (>= (length links) nth))
  8874. (error "Invalid link selection"))
  8875. (setq link (list (nth (1- nth) links))))))
  8876. (if link
  8877. (let ((buf (current-buffer)))
  8878. (dolist (l link)
  8879. (org-open-link-from-string l in-emacs buf))
  8880. t)
  8881. nil)))
  8882. ;; Add special file links that specify the way of opening
  8883. (org-add-link-type "file+sys" 'org-open-file-with-system)
  8884. (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
  8885. (defun org-open-file-with-system (path)
  8886. "Open file at PATH using the system way of opening it."
  8887. (org-open-file path 'system))
  8888. (defun org-open-file-with-emacs (path)
  8889. "Open file at PATH in Emacs."
  8890. (org-open-file path 'emacs))
  8891. (defun org-remove-file-link-modifiers ()
  8892. "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
  8893. (goto-char (point-min))
  8894. (while (re-search-forward "\\<file\\+\\(sys\\|emacs\\):" nil t)
  8895. (org-if-unprotected
  8896. (replace-match "file:" t t))))
  8897. (eval-after-load "org-exp"
  8898. '(add-hook 'org-export-preprocess-before-normalizing-links-hook
  8899. 'org-remove-file-link-modifiers))
  8900. ;;;; Time estimates
  8901. (defun org-get-effort (&optional pom)
  8902. "Get the effort estimate for the current entry."
  8903. (org-entry-get pom org-effort-property))
  8904. ;;; File search
  8905. (defvar org-create-file-search-functions nil
  8906. "List of functions to construct the right search string for a file link.
  8907. These functions are called in turn with point at the location to
  8908. which the link should point.
  8909. A function in the hook should first test if it would like to
  8910. handle this file type, for example by checking the `major-mode'
  8911. or the file extension. If it decides not to handle this file, it
  8912. should just return nil to give other functions a chance. If it
  8913. does handle the file, it must return the search string to be used
  8914. when following the link. The search string will be part of the
  8915. file link, given after a double colon, and `org-open-at-point'
  8916. will automatically search for it. If special measures must be
  8917. taken to make the search successful, another function should be
  8918. added to the companion hook `org-execute-file-search-functions',
  8919. which see.
  8920. A function in this hook may also use `setq' to set the variable
  8921. `description' to provide a suggestion for the descriptive text to
  8922. be used for this link when it gets inserted into an Org-mode
  8923. buffer with \\[org-insert-link].")
  8924. (defvar org-execute-file-search-functions nil
  8925. "List of functions to execute a file search triggered by a link.
  8926. Functions added to this hook must accept a single argument, the
  8927. search string that was part of the file link, the part after the
  8928. double colon. The function must first check if it would like to
  8929. handle this search, for example by checking the `major-mode' or
  8930. the file extension. If it decides not to handle this search, it
  8931. should just return nil to give other functions a chance. If it
  8932. does handle the search, it must return a non-nil value to keep
  8933. other functions from trying.
  8934. Each function can access the current prefix argument through the
  8935. variable `current-prefix-argument'. Note that a single prefix is
  8936. used to force opening a link in Emacs, so it may be good to only
  8937. use a numeric or double prefix to guide the search function.
  8938. In case this is needed, a function in this hook can also restore
  8939. the window configuration before `org-open-at-point' was called using:
  8940. (set-window-configuration org-window-config-before-follow-link)")
  8941. (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
  8942. (defun org-link-search (s &optional type avoid-pos stealth)
  8943. "Search for a link search option.
  8944. If S is surrounded by forward slashes, it is interpreted as a
  8945. regular expression. In org-mode files, this will create an `org-occur'
  8946. sparse tree. In ordinary files, `occur' will be used to list matches.
  8947. If the current buffer is in `dired-mode', grep will be used to search
  8948. in all files. If AVOID-POS is given, ignore matches near that position.
  8949. When optional argument STEALTH is non-nil, do not modify
  8950. visibility around point, thus ignoring
  8951. `org-show-hierarchy-above', `org-show-following-heading' and
  8952. `org-show-siblings' variables."
  8953. (let ((case-fold-search t)
  8954. (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
  8955. (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
  8956. (append '(("") (" ") ("\t") ("\n"))
  8957. org-emphasis-alist)
  8958. "\\|") "\\)"))
  8959. (pos (point))
  8960. (pre nil) (post nil)
  8961. words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
  8962. (cond
  8963. ;; First check if there are any special search functions
  8964. ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
  8965. ;; Now try the builtin stuff
  8966. ((and (equal (string-to-char s0) ?#)
  8967. (> (length s0) 1)
  8968. (save-excursion
  8969. (goto-char (point-min))
  8970. (and
  8971. (re-search-forward
  8972. (concat "^[ \t]*:CUSTOM_ID:[ \t]+" (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
  8973. (setq type 'dedicated
  8974. pos (match-beginning 0))))
  8975. ;; There is an exact target for this
  8976. (goto-char pos)
  8977. (org-back-to-heading t)))
  8978. ((save-excursion
  8979. (goto-char (point-min))
  8980. (and
  8981. (re-search-forward
  8982. (concat "<<" (regexp-quote s0) ">>") nil t)
  8983. (setq type 'dedicated
  8984. pos (match-beginning 0))))
  8985. ;; There is an exact target for this
  8986. (goto-char pos))
  8987. ((save-excursion
  8988. (goto-char (point-min))
  8989. (and
  8990. (re-search-forward
  8991. (format "^[ \t]*#\\+TARGET: %s" (regexp-quote s0)) nil t)
  8992. (setq type 'dedicated pos (match-beginning 0))))
  8993. ;; Found an invisible target.
  8994. (goto-char pos))
  8995. ((save-excursion
  8996. (goto-char (point-min))
  8997. (and
  8998. (re-search-forward
  8999. (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
  9000. (setq type 'dedicated pos (match-beginning 0))))
  9001. ;; Found an element with a matching #+name affiliated keyword.
  9002. (goto-char pos))
  9003. ((and (string-match "^(\\(.*\\))$" s0)
  9004. (save-excursion
  9005. (goto-char (point-min))
  9006. (and
  9007. (re-search-forward
  9008. (concat "[^[]" (regexp-quote
  9009. (format org-coderef-label-format
  9010. (match-string 1 s0))))
  9011. nil t)
  9012. (setq type 'dedicated
  9013. pos (1+ (match-beginning 0))))))
  9014. ;; There is a coderef target for this
  9015. (goto-char pos))
  9016. ((string-match "^/\\(.*\\)/$" s)
  9017. ;; A regular expression
  9018. (cond
  9019. ((derived-mode-p 'org-mode)
  9020. (org-occur (match-string 1 s)))
  9021. ;;((eq major-mode 'dired-mode)
  9022. ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
  9023. (t (org-do-occur (match-string 1 s)))))
  9024. ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
  9025. (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
  9026. (goto-char (point-min))
  9027. (cond
  9028. ((let (case-fold-search)
  9029. (re-search-forward (format org-complex-heading-regexp-format
  9030. (regexp-quote s))
  9031. nil t))
  9032. ;; OK, found a match
  9033. (setq type 'dedicated)
  9034. (goto-char (match-beginning 0)))
  9035. ((and (not org-link-search-inhibit-query)
  9036. (eq org-link-search-must-match-exact-headline 'query-to-create)
  9037. (y-or-n-p "No match - create this as a new heading? "))
  9038. (goto-char (point-max))
  9039. (or (bolp) (newline))
  9040. (insert "* " s "\n")
  9041. (beginning-of-line 0))
  9042. (t
  9043. (goto-char pos)
  9044. (error "No match"))))
  9045. (t
  9046. ;; A normal search string
  9047. (when (equal (string-to-char s) ?*)
  9048. ;; Anchor on headlines, post may include tags.
  9049. (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
  9050. post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
  9051. s (substring s 1)))
  9052. (remove-text-properties
  9053. 0 (length s)
  9054. '(face nil mouse-face nil keymap nil fontified nil) s)
  9055. ;; Make a series of regular expressions to find a match
  9056. (setq words (org-split-string s "[ \n\r\t]+")
  9057. re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
  9058. re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
  9059. "\\)" markers)
  9060. re2a_ (concat "\\(" (mapconcat 'downcase words "[ \t\r\n]+") "\\)[ \t\r\n]")
  9061. re2a (concat "[ \t\r\n]" re2a_)
  9062. re4_ (concat "\\(" (mapconcat 'downcase words "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
  9063. re4 (concat "[^a-zA-Z_]" re4_)
  9064. re1 (concat pre re2 post)
  9065. re3 (concat pre (if pre re4_ re4) post)
  9066. re5 (concat pre ".*" re4)
  9067. re2 (concat pre re2)
  9068. re2a (concat pre (if pre re2a_ re2a))
  9069. re4 (concat pre (if pre re4_ re4))
  9070. reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
  9071. "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
  9072. re5 "\\)"
  9073. ))
  9074. (cond
  9075. ((eq type 'org-occur) (org-occur reall))
  9076. ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
  9077. (t (goto-char (point-min))
  9078. (setq type 'fuzzy)
  9079. (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
  9080. (org-search-not-self 1 re1 nil t)
  9081. (org-search-not-self 1 re2 nil t)
  9082. (org-search-not-self 1 re2a nil t)
  9083. (org-search-not-self 1 re3 nil t)
  9084. (org-search-not-self 1 re4 nil t)
  9085. (org-search-not-self 1 re5 nil t)
  9086. )
  9087. (goto-char (match-beginning 1))
  9088. (goto-char pos)
  9089. (error "No match"))))))
  9090. (and (derived-mode-p 'org-mode)
  9091. (not stealth)
  9092. (org-show-context 'link-search))
  9093. type))
  9094. (defun org-search-not-self (group &rest args)
  9095. "Execute `re-search-forward', but only accept matches that do not
  9096. enclose the position of `org-open-link-marker'."
  9097. (let ((m org-open-link-marker))
  9098. (catch 'exit
  9099. (while (apply 're-search-forward args)
  9100. (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
  9101. (goto-char (match-end group))
  9102. (if (and (or (not (eq (marker-buffer m) (current-buffer)))
  9103. (> (match-beginning 0) (marker-position m))
  9104. (< (match-end 0) (marker-position m)))
  9105. (save-match-data
  9106. (or (not (org-in-regexp
  9107. org-bracket-link-analytic-regexp 1))
  9108. (not (match-end 4)) ; no description
  9109. (and (<= (match-beginning 4) (point))
  9110. (>= (match-end 4) (point))))))
  9111. (throw 'exit (point))))))))
  9112. (defun org-get-buffer-for-internal-link (buffer)
  9113. "Return a buffer to be used for displaying the link target of internal links."
  9114. (cond
  9115. ((not org-display-internal-link-with-indirect-buffer)
  9116. buffer)
  9117. ((string-match "(Clone)$" (buffer-name buffer))
  9118. (message "Buffer is already a clone, not making another one")
  9119. ;; we also do not modify visibility in this case
  9120. buffer)
  9121. (t ; make a new indirect buffer for displaying the link
  9122. (let* ((bn (buffer-name buffer))
  9123. (ibn (concat bn "(Clone)"))
  9124. (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
  9125. (with-current-buffer ib (org-overview))
  9126. ib))))
  9127. (defun org-do-occur (regexp &optional cleanup)
  9128. "Call the Emacs command `occur'.
  9129. If CLEANUP is non-nil, remove the printout of the regular expression
  9130. in the *Occur* buffer. This is useful if the regex is long and not useful
  9131. to read."
  9132. (occur regexp)
  9133. (when cleanup
  9134. (let ((cwin (selected-window)) win beg end)
  9135. (when (setq win (get-buffer-window "*Occur*"))
  9136. (select-window win))
  9137. (goto-char (point-min))
  9138. (when (re-search-forward "match[a-z]+" nil t)
  9139. (setq beg (match-end 0))
  9140. (if (re-search-forward "^[ \t]*[0-9]+" nil t)
  9141. (setq end (1- (match-beginning 0)))))
  9142. (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
  9143. (goto-char (point-min))
  9144. (select-window cwin))))
  9145. ;;; The mark ring for links jumps
  9146. (defvar org-mark-ring nil
  9147. "Mark ring for positions before jumps in Org-mode.")
  9148. (defvar org-mark-ring-last-goto nil
  9149. "Last position in the mark ring used to go back.")
  9150. ;; Fill and close the ring
  9151. (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
  9152. (loop for i from 1 to org-mark-ring-length do
  9153. (push (make-marker) org-mark-ring))
  9154. (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
  9155. org-mark-ring)
  9156. (defun org-mark-ring-push (&optional pos buffer)
  9157. "Put the current position or POS into the mark ring and rotate it."
  9158. (interactive)
  9159. (setq pos (or pos (point)))
  9160. (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  9161. (move-marker (car org-mark-ring)
  9162. (or pos (point))
  9163. (or buffer (current-buffer)))
  9164. (message "%s"
  9165. (substitute-command-keys
  9166. "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
  9167. (defun org-mark-ring-goto (&optional n)
  9168. "Jump to the previous position in the mark ring.
  9169. With prefix arg N, jump back that many stored positions. When
  9170. called several times in succession, walk through the entire ring.
  9171. Org-mode commands jumping to a different position in the current file,
  9172. or to another Org-mode file, automatically push the old position
  9173. onto the ring."
  9174. (interactive "p")
  9175. (let (p m)
  9176. (if (eq last-command this-command)
  9177. (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
  9178. (setq p org-mark-ring))
  9179. (setq org-mark-ring-last-goto p)
  9180. (setq m (car p))
  9181. (org-pop-to-buffer-same-window (marker-buffer m))
  9182. (goto-char m)
  9183. (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
  9184. (defun org-remove-angle-brackets (s)
  9185. (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
  9186. (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
  9187. s)
  9188. (defun org-add-angle-brackets (s)
  9189. (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
  9190. (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
  9191. s)
  9192. (defun org-remove-double-quotes (s)
  9193. (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
  9194. (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
  9195. s)
  9196. ;;; Following specific links
  9197. (defun org-follow-timestamp-link ()
  9198. (cond
  9199. ((org-at-date-range-p t)
  9200. (let ((org-agenda-start-on-weekday)
  9201. (t1 (match-string 1))
  9202. (t2 (match-string 2)))
  9203. (setq t1 (time-to-days (org-time-string-to-time t1))
  9204. t2 (time-to-days (org-time-string-to-time t2)))
  9205. (org-agenda-list nil t1 (1+ (- t2 t1)))))
  9206. ((org-at-timestamp-p t)
  9207. (org-agenda-list nil (time-to-days (org-time-string-to-time
  9208. (substring (match-string 1) 0 10)))
  9209. 1))
  9210. (t (error "This should not happen"))))
  9211. ;;; Following file links
  9212. (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
  9213. (declare-function mailcap-extension-to-mime "mailcap" (extn))
  9214. (declare-function mailcap-mime-info
  9215. "mailcap" (string &optional request no-decode))
  9216. (defvar org-wait nil)
  9217. (defun org-open-file (path &optional in-emacs line search)
  9218. "Open the file at PATH.
  9219. First, this expands any special file name abbreviations. Then the
  9220. configuration variable `org-file-apps' is checked if it contains an
  9221. entry for this file type, and if yes, the corresponding command is launched.
  9222. If no application is found, Emacs simply visits the file.
  9223. With optional prefix argument IN-EMACS, Emacs will visit the file.
  9224. With a double \\[universal-argument] \\[universal-argument] \
  9225. prefix arg, Org tries to avoid opening in Emacs
  9226. and to use an external application to visit the file.
  9227. Optional LINE specifies a line to go to, optional SEARCH a string
  9228. to search for. If LINE or SEARCH is given, the file will be
  9229. opened in Emacs, unless an entry from org-file-apps that makes
  9230. use of groups in a regexp matches.
  9231. If you want to change the way frames are used when following a
  9232. link, please customize `org-link-frame-setup'.
  9233. If the file does not exist, an error is thrown."
  9234. (let* ((file (if (equal path "")
  9235. buffer-file-name
  9236. (substitute-in-file-name (expand-file-name path))))
  9237. (file-apps (append org-file-apps (org-default-apps)))
  9238. (apps (org-remove-if
  9239. 'org-file-apps-entry-match-against-dlink-p file-apps))
  9240. (apps-dlink (org-remove-if-not
  9241. 'org-file-apps-entry-match-against-dlink-p file-apps))
  9242. (remp (and (assq 'remote apps) (org-file-remote-p file)))
  9243. (dirp (if remp nil (file-directory-p file)))
  9244. (file (if (and dirp org-open-directory-means-index-dot-org)
  9245. (concat (file-name-as-directory file) "index.org")
  9246. file))
  9247. (a-m-a-p (assq 'auto-mode apps))
  9248. (dfile (downcase file))
  9249. ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
  9250. (link (cond ((and (eq line nil)
  9251. (eq search nil))
  9252. file)
  9253. (line
  9254. (concat file "::" (number-to-string line)))
  9255. (search
  9256. (concat file "::" search))))
  9257. (dlink (downcase link))
  9258. (old-buffer (current-buffer))
  9259. (old-pos (point))
  9260. (old-mode major-mode)
  9261. ext cmd link-match-data)
  9262. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
  9263. (setq ext (match-string 1 dfile))
  9264. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
  9265. (setq ext (match-string 1 dfile))))
  9266. (cond
  9267. ((member in-emacs '((16) system))
  9268. (setq cmd (cdr (assoc 'system apps))))
  9269. (in-emacs (setq cmd 'emacs))
  9270. (t
  9271. (setq cmd (or (and remp (cdr (assoc 'remote apps)))
  9272. (and dirp (cdr (assoc 'directory apps)))
  9273. ; first, try matching against apps-dlink
  9274. ; if we get a match here, store the match data for later
  9275. (let ((match (assoc-default dlink apps-dlink
  9276. 'string-match)))
  9277. (if match
  9278. (progn (setq link-match-data (match-data))
  9279. match)
  9280. (progn (setq in-emacs (or in-emacs line search))
  9281. nil))) ; if we have no match in apps-dlink,
  9282. ; always open the file in emacs if line or search
  9283. ; is given (for backwards compatibility)
  9284. (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
  9285. 'string-match)
  9286. (cdr (assoc ext apps))
  9287. (cdr (assoc t apps))))))
  9288. (when (eq cmd 'system)
  9289. (setq cmd (cdr (assoc 'system apps))))
  9290. (when (eq cmd 'default)
  9291. (setq cmd (cdr (assoc t apps))))
  9292. (when (eq cmd 'mailcap)
  9293. (require 'mailcap)
  9294. (mailcap-parse-mailcaps)
  9295. (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
  9296. (command (mailcap-mime-info mime-type)))
  9297. (if (stringp command)
  9298. (setq cmd command)
  9299. (setq cmd 'emacs))))
  9300. (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
  9301. (not (file-exists-p file))
  9302. (not org-open-non-existing-files))
  9303. (error "No such file: %s" file))
  9304. (cond
  9305. ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
  9306. ;; Remove quotes around the file name - we'll use shell-quote-argument.
  9307. (while (string-match "['\"]%s['\"]" cmd)
  9308. (setq cmd (replace-match "%s" t t cmd)))
  9309. (while (string-match "%s" cmd)
  9310. (setq cmd (replace-match
  9311. (save-match-data
  9312. (shell-quote-argument
  9313. (convert-standard-filename file)))
  9314. t t cmd)))
  9315. ;; Replace "%1", "%2" etc. in command with group matches from regex
  9316. (save-match-data
  9317. (let ((match-index 1)
  9318. (number-of-groups (- (/ (length link-match-data) 2) 1)))
  9319. (set-match-data link-match-data)
  9320. (while (<= match-index number-of-groups)
  9321. (let ((regex (concat "%" (number-to-string match-index)))
  9322. (replace-with (match-string match-index dlink)))
  9323. (while (string-match regex cmd)
  9324. (setq cmd (replace-match replace-with t t cmd))))
  9325. (setq match-index (+ match-index 1)))))
  9326. (save-window-excursion
  9327. (start-process-shell-command cmd nil cmd)
  9328. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
  9329. ))
  9330. ((or (stringp cmd)
  9331. (eq cmd 'emacs))
  9332. (funcall (cdr (assq 'file org-link-frame-setup)) file)
  9333. (widen)
  9334. (if line (org-goto-line line)
  9335. (if search (org-link-search search))))
  9336. ((consp cmd)
  9337. (let ((file (convert-standard-filename file)))
  9338. (save-match-data
  9339. (set-match-data link-match-data)
  9340. (eval cmd))))
  9341. (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
  9342. (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
  9343. (or (not (equal old-buffer (current-buffer)))
  9344. (not (equal old-pos (point))))
  9345. (org-mark-ring-push old-pos old-buffer))))
  9346. (defun org-file-apps-entry-match-against-dlink-p (entry)
  9347. "This function returns non-nil if `entry' uses a regular
  9348. expression which should be matched against the whole link by
  9349. org-open-file.
  9350. It assumes that is the case when the entry uses a regular
  9351. expression which has at least one grouping construct and the
  9352. action is either a lisp form or a command string containing
  9353. '%1', i.e. using at least one subexpression match as a
  9354. parameter."
  9355. (let ((selector (car entry))
  9356. (action (cdr entry)))
  9357. (if (stringp selector)
  9358. (and (> (regexp-opt-depth selector) 0)
  9359. (or (and (stringp action)
  9360. (string-match "%[0-9]" action))
  9361. (consp action)))
  9362. nil)))
  9363. (defun org-default-apps ()
  9364. "Return the default applications for this operating system."
  9365. (cond
  9366. ((eq system-type 'darwin)
  9367. org-file-apps-defaults-macosx)
  9368. ((eq system-type 'windows-nt)
  9369. org-file-apps-defaults-windowsnt)
  9370. (t org-file-apps-defaults-gnu)))
  9371. (defun org-apps-regexp-alist (list &optional add-auto-mode)
  9372. "Convert extensions to regular expressions in the cars of LIST.
  9373. Also, weed out any non-string entries, because the return value is used
  9374. only for regexp matching.
  9375. When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
  9376. point to the symbol `emacs', indicating that the file should
  9377. be opened in Emacs."
  9378. (append
  9379. (delq nil
  9380. (mapcar (lambda (x)
  9381. (if (not (stringp (car x)))
  9382. nil
  9383. (if (string-match "\\W" (car x))
  9384. x
  9385. (cons (concat "\\." (car x) "\\'") (cdr x)))))
  9386. list))
  9387. (if add-auto-mode
  9388. (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
  9389. (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
  9390. (defun org-file-remote-p (file)
  9391. "Test whether FILE specifies a location on a remote system.
  9392. Return non-nil if the location is indeed remote.
  9393. For example, the filename \"/user@host:/foo\" specifies a location
  9394. on the system \"/user@host:\"."
  9395. (cond ((fboundp 'file-remote-p)
  9396. (file-remote-p file))
  9397. ((fboundp 'tramp-handle-file-remote-p)
  9398. (tramp-handle-file-remote-p file))
  9399. ((and (boundp 'ange-ftp-name-format)
  9400. (string-match (car ange-ftp-name-format) file))
  9401. t)
  9402. (t nil)))
  9403. ;;;; Refiling
  9404. (defun org-get-org-file ()
  9405. "Read a filename, with default directory `org-directory'."
  9406. (let ((default (or org-default-notes-file remember-data-file)))
  9407. (read-file-name (format "File name [%s]: " default)
  9408. (file-name-as-directory org-directory)
  9409. default)))
  9410. (defun org-notes-order-reversed-p ()
  9411. "Check if the current file should receive notes in reversed order."
  9412. (cond
  9413. ((not org-reverse-note-order) nil)
  9414. ((eq t org-reverse-note-order) t)
  9415. ((not (listp org-reverse-note-order)) nil)
  9416. (t (catch 'exit
  9417. (let ((all org-reverse-note-order)
  9418. entry)
  9419. (while (setq entry (pop all))
  9420. (if (string-match (car entry) buffer-file-name)
  9421. (throw 'exit (cdr entry))))
  9422. nil)))))
  9423. (defvar org-refile-target-table nil
  9424. "The list of refile targets, created by `org-refile'.")
  9425. (defvar org-agenda-new-buffers nil
  9426. "Buffers created to visit agenda files.")
  9427. (defvar org-refile-cache nil
  9428. "Cache for refile targets.")
  9429. (defvar org-refile-markers nil
  9430. "All the markers used for caching refile locations.")
  9431. (defun org-refile-marker (pos)
  9432. "Get a new refile marker, but only if caching is in use."
  9433. (if (not org-refile-use-cache)
  9434. pos
  9435. (let ((m (make-marker)))
  9436. (move-marker m pos)
  9437. (push m org-refile-markers)
  9438. m)))
  9439. (defun org-refile-cache-clear ()
  9440. "Clear the refile cache and disable all the markers."
  9441. (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
  9442. (setq org-refile-markers nil)
  9443. (setq org-refile-cache nil)
  9444. (message "Refile cache has been cleared"))
  9445. (defun org-refile-cache-check-set (set)
  9446. "Check if all the markers in the cache still have live buffers."
  9447. (let (marker)
  9448. (catch 'exit
  9449. (while (and set (setq marker (nth 3 (pop set))))
  9450. ;; if org-refile-use-outline-path is 'file, marker may be nil
  9451. (when (and marker (null (marker-buffer marker)))
  9452. (message "not found") (sit-for 3)
  9453. (throw 'exit nil)))
  9454. t)))
  9455. (defun org-refile-cache-put (set &rest identifiers)
  9456. "Push the refile targets SET into the cache, under IDENTIFIERS."
  9457. (let* ((key (sha1 (prin1-to-string identifiers)))
  9458. (entry (assoc key org-refile-cache)))
  9459. (if entry
  9460. (setcdr entry set)
  9461. (push (cons key set) org-refile-cache))))
  9462. (defun org-refile-cache-get (&rest identifiers)
  9463. "Retrieve the cached value for refile targets given by IDENTIFIERS."
  9464. (cond
  9465. ((not org-refile-cache) nil)
  9466. ((not org-refile-use-cache) (org-refile-cache-clear) nil)
  9467. (t
  9468. (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
  9469. org-refile-cache))))
  9470. (and set (org-refile-cache-check-set set) set)))))
  9471. (defun org-refile-get-targets (&optional default-buffer excluded-entries)
  9472. "Produce a table with refile targets."
  9473. (let ((case-fold-search nil)
  9474. ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
  9475. (entries (or org-refile-targets '((nil . (:level . 1)))))
  9476. targets tgs txt re files f desc descre fast-path-p level pos0)
  9477. (message "Getting targets...")
  9478. (with-current-buffer (or default-buffer (current-buffer))
  9479. (while (setq entry (pop entries))
  9480. (setq files (car entry) desc (cdr entry))
  9481. (setq fast-path-p nil)
  9482. (cond
  9483. ((null files) (setq files (list (current-buffer))))
  9484. ((eq files 'org-agenda-files)
  9485. (setq files (org-agenda-files 'unrestricted)))
  9486. ((and (symbolp files) (fboundp files))
  9487. (setq files (funcall files)))
  9488. ((and (symbolp files) (boundp files))
  9489. (setq files (symbol-value files))))
  9490. (if (stringp files) (setq files (list files)))
  9491. (cond
  9492. ((eq (car desc) :tag)
  9493. (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
  9494. ((eq (car desc) :todo)
  9495. (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
  9496. ((eq (car desc) :regexp)
  9497. (setq descre (cdr desc)))
  9498. ((eq (car desc) :level)
  9499. (setq descre (concat "^\\*\\{" (number-to-string
  9500. (if org-odd-levels-only
  9501. (1- (* 2 (cdr desc)))
  9502. (cdr desc)))
  9503. "\\}[ \t]")))
  9504. ((eq (car desc) :maxlevel)
  9505. (setq fast-path-p t)
  9506. (setq descre (concat "^\\*\\{1," (number-to-string
  9507. (if org-odd-levels-only
  9508. (1- (* 2 (cdr desc)))
  9509. (cdr desc)))
  9510. "\\}[ \t]")))
  9511. (t (error "Bad refiling target description %s" desc)))
  9512. (while (setq f (pop files))
  9513. (with-current-buffer
  9514. (if (bufferp f) f (org-get-agenda-file-buffer f))
  9515. (or
  9516. (setq tgs (org-refile-cache-get (buffer-file-name) descre))
  9517. (progn
  9518. (if (bufferp f) (setq f (buffer-file-name
  9519. (buffer-base-buffer f))))
  9520. (setq f (and f (expand-file-name f)))
  9521. (if (eq org-refile-use-outline-path 'file)
  9522. (push (list (file-name-nondirectory f) f nil nil) tgs))
  9523. (save-excursion
  9524. (save-restriction
  9525. (widen)
  9526. (goto-char (point-min))
  9527. (while (re-search-forward descre nil t)
  9528. (goto-char (setq pos0 (point-at-bol)))
  9529. (catch 'next
  9530. (when org-refile-target-verify-function
  9531. (save-match-data
  9532. (or (funcall org-refile-target-verify-function)
  9533. (throw 'next t))))
  9534. (when (and (looking-at org-complex-heading-regexp)
  9535. (not (member (match-string 4) excluded-entries))
  9536. (match-string 4))
  9537. (setq level (org-reduced-level
  9538. (- (match-end 1) (match-beginning 1)))
  9539. txt (org-link-display-format (match-string 4))
  9540. txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
  9541. re (format org-complex-heading-regexp-format
  9542. (regexp-quote (match-string 4))))
  9543. (when org-refile-use-outline-path
  9544. (setq txt (mapconcat
  9545. 'org-protect-slash
  9546. (append
  9547. (if (eq org-refile-use-outline-path
  9548. 'file)
  9549. (list (file-name-nondirectory
  9550. (buffer-file-name
  9551. (buffer-base-buffer))))
  9552. (if (eq org-refile-use-outline-path
  9553. 'full-file-path)
  9554. (list (buffer-file-name
  9555. (buffer-base-buffer)))))
  9556. (org-get-outline-path fast-path-p
  9557. level txt)
  9558. (list txt))
  9559. "/")))
  9560. (push (list txt f re (org-refile-marker (point)))
  9561. tgs)))
  9562. (when (= (point) pos0)
  9563. ;; verification function has not moved point
  9564. (goto-char (point-at-eol))))))))
  9565. (when org-refile-use-cache
  9566. (org-refile-cache-put tgs (buffer-file-name) descre))
  9567. (setq targets (append tgs targets))
  9568. ))))
  9569. (message "Getting targets...done")
  9570. (nreverse targets)))
  9571. (defun org-protect-slash (s)
  9572. (while (string-match "/" s)
  9573. (setq s (replace-match "\\" t t s)))
  9574. s)
  9575. (defvar org-olpa (make-vector 20 nil))
  9576. (defun org-get-outline-path (&optional fastp level heading)
  9577. "Return the outline path to the current entry, as a list.
  9578. The parameters FASTP, LEVEL, and HEADING are for use by a scanner
  9579. routine which makes outline path derivations for an entire file,
  9580. avoiding backtracing. Refile target collection makes use of that."
  9581. (if fastp
  9582. (progn
  9583. (if (> level 19)
  9584. (error "Outline path failure, more than 19 levels"))
  9585. (loop for i from level upto 19 do
  9586. (aset org-olpa i nil))
  9587. (prog1
  9588. (delq nil (append org-olpa nil))
  9589. (aset org-olpa level heading)))
  9590. (let (rtn case-fold-search)
  9591. (save-excursion
  9592. (save-restriction
  9593. (widen)
  9594. (while (org-up-heading-safe)
  9595. (when (looking-at org-complex-heading-regexp)
  9596. (push (org-match-string-no-properties 4) rtn)))
  9597. rtn)))))
  9598. (defun org-format-outline-path (path &optional width prefix)
  9599. "Format the outline path PATH for display.
  9600. Width is the maximum number of characters that is available.
  9601. Prefix is a prefix to be included in the returned string,
  9602. such as the file name."
  9603. (setq width (or width 79))
  9604. (if prefix (setq width (- width (length prefix))))
  9605. (if (not path)
  9606. (or prefix "")
  9607. (let* ((nsteps (length path))
  9608. (total-width (+ nsteps (apply '+ (mapcar 'length path))))
  9609. (maxwidth (if (<= total-width width)
  9610. 10000 ;; everything fits
  9611. ;; we need to shorten the level headings
  9612. (/ (- width nsteps) nsteps)))
  9613. (org-odd-levels-only nil)
  9614. (n 0)
  9615. (total (1+ (length prefix))))
  9616. (setq maxwidth (max maxwidth 10))
  9617. (concat prefix
  9618. (mapconcat
  9619. (lambda (h)
  9620. (setq n (1+ n))
  9621. (if (and (= n nsteps) (< maxwidth 10000))
  9622. (setq maxwidth (- total-width total)))
  9623. (if (< (length h) maxwidth)
  9624. (progn (setq total (+ total (length h) 1)) h)
  9625. (setq h (substring h 0 (- maxwidth 2))
  9626. total (+ total maxwidth 1))
  9627. (if (string-match "[ \t]+\\'" h)
  9628. (setq h (substring h 0 (match-beginning 0))))
  9629. (setq h (concat h "..")))
  9630. (org-add-props h nil 'face
  9631. (nth (% (1- n) org-n-level-faces)
  9632. org-level-faces))
  9633. h)
  9634. path "/")))))
  9635. (defun org-display-outline-path (&optional file current)
  9636. "Display the current outline path in the echo area."
  9637. (interactive "P")
  9638. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  9639. (case-fold-search nil)
  9640. (path (and (derived-mode-p 'org-mode) (org-get-outline-path))))
  9641. (if current (setq path (append path
  9642. (save-excursion
  9643. (org-back-to-heading t)
  9644. (if (looking-at org-complex-heading-regexp)
  9645. (list (match-string 4)))))))
  9646. (message "%s"
  9647. (org-format-outline-path
  9648. path
  9649. (1- (frame-width))
  9650. (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
  9651. (defvar org-refile-history nil
  9652. "History for refiling operations.")
  9653. (defvar org-after-refile-insert-hook nil
  9654. "Hook run after `org-refile' has inserted its stuff at the new location.
  9655. Note that this is still *before* the stuff will be removed from
  9656. the *old* location.")
  9657. (defvar org-capture-last-stored-marker)
  9658. (defun org-refile (&optional goto default-buffer rfloc)
  9659. "Move the entry or entries at point to another heading.
  9660. The list of target headings is compiled using the information in
  9661. `org-refile-targets', which see.
  9662. At the target location, the entry is filed as a subitem of the target
  9663. heading. Depending on `org-reverse-note-order', the new subitem will
  9664. either be the first or the last subitem.
  9665. If there is an active region, all entries in that region will be moved.
  9666. However, the region must fulfill the requirement that the first heading
  9667. is the first one sets the top-level of the moved text - at most siblings
  9668. below it are allowed.
  9669. With prefix arg GOTO, the command will only visit the target location
  9670. and not actually move anything.
  9671. With a double prefix arg \\[universal-argument] \\[universal-argument], \
  9672. go to the location where the last refiling operation has put the subtree.
  9673. With a prefix argument of `2', refile to the running clock.
  9674. RFLOC can be a refile location obtained in a different way.
  9675. See also `org-refile-use-outline-path' and `org-completion-use-ido'.
  9676. If you are using target caching (see `org-refile-use-cache'),
  9677. you have to clear the target cache in order to find new targets.
  9678. This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
  9679. prefix argument (`C-u C-u C-u C-c C-w')."
  9680. (interactive "P")
  9681. (if (member goto '(0 (64)))
  9682. (org-refile-cache-clear)
  9683. (let* ((cbuf (current-buffer))
  9684. (regionp (org-region-active-p))
  9685. (region-start (and regionp (region-beginning)))
  9686. (region-end (and regionp (region-end)))
  9687. (region-length (and regionp (- region-end region-start)))
  9688. (filename (buffer-file-name (buffer-base-buffer cbuf)))
  9689. pos it nbuf file re level reversed)
  9690. (setq last-command nil)
  9691. (when regionp
  9692. (goto-char region-start)
  9693. (or (bolp) (goto-char (point-at-bol)))
  9694. (setq region-start (point))
  9695. (unless (or (org-kill-is-subtree-p
  9696. (buffer-substring region-start region-end))
  9697. (prog1 org-refile-active-region-within-subtree
  9698. (org-toggle-heading)))
  9699. (error "The region is not a (sequence of) subtree(s)")))
  9700. (if (equal goto '(16))
  9701. (org-refile-goto-last-stored)
  9702. (when (or
  9703. (and (equal goto 2)
  9704. org-clock-hd-marker (marker-buffer org-clock-hd-marker)
  9705. (prog1
  9706. (setq it (list (or org-clock-heading "running clock")
  9707. (buffer-file-name
  9708. (marker-buffer org-clock-hd-marker))
  9709. ""
  9710. (marker-position org-clock-hd-marker)))
  9711. (setq goto nil)))
  9712. (setq it (or rfloc
  9713. (let (heading-text)
  9714. (save-excursion
  9715. (unless goto
  9716. (org-back-to-heading t)
  9717. (setq heading-text
  9718. (nth 4 (org-heading-components))))
  9719. (org-refile-get-location
  9720. (cond (goto "Goto")
  9721. (regionp "Refile region to")
  9722. (t (concat "Refile subtree \""
  9723. heading-text "\" to")))
  9724. default-buffer
  9725. (and (not (equal '(4) goto))
  9726. org-refile-allow-creating-parent-nodes)
  9727. goto))))))
  9728. (setq file (nth 1 it)
  9729. re (nth 2 it)
  9730. pos (nth 3 it))
  9731. (if (and (not goto)
  9732. pos
  9733. (equal (buffer-file-name) file)
  9734. (if regionp
  9735. (and (>= pos region-start)
  9736. (<= pos region-end))
  9737. (and (>= pos (point))
  9738. (< pos (save-excursion
  9739. (org-end-of-subtree t t))))))
  9740. (error "Cannot refile to position inside the tree or region"))
  9741. (setq nbuf (or (find-buffer-visiting file)
  9742. (find-file-noselect file)))
  9743. (if goto
  9744. (progn
  9745. (org-pop-to-buffer-same-window nbuf)
  9746. (goto-char pos)
  9747. (org-show-context 'org-goto))
  9748. (if regionp
  9749. (progn
  9750. (org-kill-new (buffer-substring region-start region-end))
  9751. (org-save-markers-in-region region-start region-end))
  9752. (org-copy-subtree 1 nil t))
  9753. (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
  9754. (find-file-noselect file)))
  9755. (setq reversed (org-notes-order-reversed-p))
  9756. (save-excursion
  9757. (save-restriction
  9758. (widen)
  9759. (if pos
  9760. (progn
  9761. (goto-char pos)
  9762. (looking-at org-outline-regexp)
  9763. (setq level (org-get-valid-level (funcall outline-level) 1))
  9764. (goto-char
  9765. (if reversed
  9766. (or (outline-next-heading) (point-max))
  9767. (or (save-excursion (org-get-next-sibling))
  9768. (org-end-of-subtree t t)
  9769. (point-max)))))
  9770. (setq level 1)
  9771. (if (not reversed)
  9772. (goto-char (point-max))
  9773. (goto-char (point-min))
  9774. (or (outline-next-heading) (goto-char (point-max)))))
  9775. (if (not (bolp)) (newline))
  9776. (org-paste-subtree level)
  9777. (when org-log-refile
  9778. (org-add-log-setup 'refile nil nil 'findpos
  9779. org-log-refile)
  9780. (unless (eq org-log-refile 'note)
  9781. (save-excursion (org-add-log-note))))
  9782. (and org-auto-align-tags (org-set-tags nil t))
  9783. (bookmark-set "org-refile-last-stored")
  9784. ;; If we are refiling for capture, make sure that the
  9785. ;; last-capture pointers point here
  9786. (when (org-bound-and-true-p org-refile-for-capture)
  9787. (bookmark-set "org-capture-last-stored-marker")
  9788. (move-marker org-capture-last-stored-marker (point)))
  9789. (if (fboundp 'deactivate-mark) (deactivate-mark))
  9790. (run-hooks 'org-after-refile-insert-hook))))
  9791. (if regionp
  9792. (delete-region (point) (+ (point) region-length))
  9793. (org-cut-subtree))
  9794. (when (featurep 'org-inlinetask)
  9795. (org-inlinetask-remove-END-maybe))
  9796. (setq org-markers-to-move nil)
  9797. (message "Refiled to \"%s\" in file %s" (car it) file)))))))
  9798. (defun org-refile-goto-last-stored ()
  9799. "Go to the location where the last refile was stored."
  9800. (interactive)
  9801. (bookmark-jump "org-refile-last-stored")
  9802. (message "This is the location of the last refile"))
  9803. (defun org-refile-get-location (&optional prompt default-buffer new-nodes
  9804. no-exclude)
  9805. "Prompt the user for a refile location, using PROMPT.
  9806. PROMPT should not be suffixed with a colon and a space, because
  9807. this function appends the default value from
  9808. `org-refile-history' automatically, if that is not empty.
  9809. When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
  9810. this is used for the GOTO interface."
  9811. (let ((org-refile-targets org-refile-targets)
  9812. (org-refile-use-outline-path org-refile-use-outline-path)
  9813. excluded-entries)
  9814. (when (and (derived-mode-p 'org-mode)
  9815. (not org-refile-use-cache)
  9816. (not no-exclude))
  9817. (org-map-tree
  9818. (lambda()
  9819. (setq excluded-entries
  9820. (append excluded-entries (list (org-get-heading t t)))))))
  9821. (setq org-refile-target-table
  9822. (org-refile-get-targets default-buffer excluded-entries)))
  9823. (unless org-refile-target-table
  9824. (error "No refile targets"))
  9825. (let* ((prompt (concat prompt
  9826. (and (car org-refile-history)
  9827. (concat " (default " (car org-refile-history) ")"))
  9828. ": "))
  9829. (cbuf (current-buffer))
  9830. (partial-completion-mode nil)
  9831. (cfn (buffer-file-name (buffer-base-buffer cbuf)))
  9832. (cfunc (if (and org-refile-use-outline-path
  9833. org-outline-path-complete-in-steps)
  9834. 'org-olpath-completing-read
  9835. 'org-icompleting-read))
  9836. (extra (if org-refile-use-outline-path "/" ""))
  9837. (filename (and cfn (expand-file-name cfn)))
  9838. (tbl (mapcar
  9839. (lambda (x)
  9840. (if (and (not (member org-refile-use-outline-path
  9841. '(file full-file-path)))
  9842. (not (equal filename (nth 1 x))))
  9843. (cons (concat (car x) extra " ("
  9844. (file-name-nondirectory (nth 1 x)) ")")
  9845. (cdr x))
  9846. (cons (concat (car x) extra) (cdr x))))
  9847. org-refile-target-table))
  9848. (completion-ignore-case t)
  9849. pa answ parent-target child parent old-hist)
  9850. (setq old-hist org-refile-history)
  9851. (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
  9852. nil 'org-refile-history (car org-refile-history)))
  9853. (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
  9854. (org-refile-check-position pa)
  9855. (if pa
  9856. (progn
  9857. (when (or (not org-refile-history)
  9858. (not (eq old-hist org-refile-history))
  9859. (not (equal (car pa) (car org-refile-history))))
  9860. (setq org-refile-history
  9861. (cons (car pa) (if (assoc (car org-refile-history) tbl)
  9862. org-refile-history
  9863. (cdr org-refile-history))))
  9864. (if (equal (car org-refile-history) (nth 1 org-refile-history))
  9865. (pop org-refile-history)))
  9866. pa)
  9867. (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
  9868. (progn
  9869. (setq parent (match-string 1 answ)
  9870. child (match-string 2 answ))
  9871. (setq parent-target (or (assoc parent tbl)
  9872. (assoc (concat parent "/") tbl)))
  9873. (when (and parent-target
  9874. (or (eq new-nodes t)
  9875. (and (eq new-nodes 'confirm)
  9876. (y-or-n-p (format "Create new node \"%s\"? "
  9877. child)))))
  9878. (org-refile-new-child parent-target child)))
  9879. (error "Invalid target location")))))
  9880. (declare-function org-string-nw-p "org-macs.el" (s))
  9881. (defun org-refile-check-position (refile-pointer)
  9882. "Check if the refile pointer matches the readline to which it points."
  9883. (let* ((file (nth 1 refile-pointer))
  9884. (re (nth 2 refile-pointer))
  9885. (pos (nth 3 refile-pointer))
  9886. buffer)
  9887. (when (org-string-nw-p re)
  9888. (setq buffer (if (markerp pos)
  9889. (marker-buffer pos)
  9890. (or (find-buffer-visiting file)
  9891. (find-file-noselect file))))
  9892. (with-current-buffer buffer
  9893. (save-excursion
  9894. (save-restriction
  9895. (widen)
  9896. (goto-char pos)
  9897. (beginning-of-line 1)
  9898. (unless (org-looking-at-p re)
  9899. (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
  9900. (defun org-refile-new-child (parent-target child)
  9901. "Use refile target PARENT-TARGET to add new CHILD below it."
  9902. (unless parent-target
  9903. (error "Cannot find parent for new node"))
  9904. (let ((file (nth 1 parent-target))
  9905. (pos (nth 3 parent-target))
  9906. level)
  9907. (with-current-buffer (or (find-buffer-visiting file)
  9908. (find-file-noselect file))
  9909. (save-excursion
  9910. (save-restriction
  9911. (widen)
  9912. (if pos
  9913. (goto-char pos)
  9914. (goto-char (point-max))
  9915. (if (not (bolp)) (newline)))
  9916. (when (looking-at org-outline-regexp)
  9917. (setq level (funcall outline-level))
  9918. (org-end-of-subtree t t))
  9919. (org-back-over-empty-lines)
  9920. (insert "\n" (make-string
  9921. (if pos (org-get-valid-level level 1) 1) ?*)
  9922. " " child "\n")
  9923. (beginning-of-line 0)
  9924. (list (concat (car parent-target) "/" child) file "" (point)))))))
  9925. (defun org-olpath-completing-read (prompt collection &rest args)
  9926. "Read an outline path like a file name."
  9927. (let ((thetable collection)
  9928. (org-completion-use-ido nil) ; does not work with ido.
  9929. (org-completion-use-iswitchb nil)) ; or iswitchb
  9930. (apply
  9931. 'org-icompleting-read prompt
  9932. (lambda (string predicate &optional flag)
  9933. (let (rtn r f (l (length string)))
  9934. (cond
  9935. ((eq flag nil)
  9936. ;; try completion
  9937. (try-completion string thetable))
  9938. ((eq flag t)
  9939. ;; all-completions
  9940. (setq rtn (all-completions string thetable predicate))
  9941. (mapcar
  9942. (lambda (x)
  9943. (setq r (substring x l))
  9944. (if (string-match " ([^)]*)$" x)
  9945. (setq f (match-string 0 x))
  9946. (setq f ""))
  9947. (if (string-match "/" r)
  9948. (concat string (substring r 0 (match-end 0)) f)
  9949. x))
  9950. rtn))
  9951. ((eq flag 'lambda)
  9952. ;; exact match?
  9953. (assoc string thetable)))))
  9954. args)))
  9955. ;;;; Dynamic blocks
  9956. (defun org-find-dblock (name)
  9957. "Find the first dynamic block with name NAME in the buffer.
  9958. If not found, stay at current position and return nil."
  9959. (let (pos)
  9960. (save-excursion
  9961. (goto-char (point-min))
  9962. (setq pos (and (re-search-forward (concat "^[ \t]*#\\+BEGIN:[ \t]+" name "\\>")
  9963. nil t)
  9964. (match-beginning 0))))
  9965. (if pos (goto-char pos))
  9966. pos))
  9967. (defconst org-dblock-start-re
  9968. "^[ \t]*#\\+BEGIN:[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
  9969. "Matches the start line of a dynamic block, with parameters.")
  9970. (defconst org-dblock-end-re "^[ \t]*#\\+END\\([: \t\r\n]\\|$\\)"
  9971. "Matches the end of a dynamic block.")
  9972. (defun org-create-dblock (plist)
  9973. "Create a dynamic block section, with parameters taken from PLIST.
  9974. PLIST must contain a :name entry which is used as name of the block."
  9975. (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
  9976. (end-of-line 1)
  9977. (newline))
  9978. (let ((col (current-column))
  9979. (name (plist-get plist :name)))
  9980. (insert "#+BEGIN: " name)
  9981. (while plist
  9982. (if (eq (car plist) :name)
  9983. (setq plist (cddr plist))
  9984. (insert " " (prin1-to-string (pop plist)))))
  9985. (insert "\n\n" (make-string col ?\ ) "#+END:\n")
  9986. (beginning-of-line -2)))
  9987. (defun org-prepare-dblock ()
  9988. "Prepare dynamic block for refresh.
  9989. This empties the block, puts the cursor at the insert position and returns
  9990. the property list including an extra property :name with the block name."
  9991. (unless (looking-at org-dblock-start-re)
  9992. (error "Not at a dynamic block"))
  9993. (let* ((begdel (1+ (match-end 0)))
  9994. (name (org-no-properties (match-string 1)))
  9995. (params (append (list :name name)
  9996. (read (concat "(" (match-string 3) ")")))))
  9997. (save-excursion
  9998. (beginning-of-line 1)
  9999. (skip-chars-forward " \t")
  10000. (setq params (plist-put params :indentation-column (current-column))))
  10001. (unless (re-search-forward org-dblock-end-re nil t)
  10002. (error "Dynamic block not terminated"))
  10003. (setq params
  10004. (append params
  10005. (list :content (buffer-substring
  10006. begdel (match-beginning 0)))))
  10007. (delete-region begdel (match-beginning 0))
  10008. (goto-char begdel)
  10009. (open-line 1)
  10010. params))
  10011. (defun org-map-dblocks (&optional command)
  10012. "Apply COMMAND to all dynamic blocks in the current buffer.
  10013. If COMMAND is not given, use `org-update-dblock'."
  10014. (let ((cmd (or command 'org-update-dblock)))
  10015. (save-excursion
  10016. (goto-char (point-min))
  10017. (while (re-search-forward org-dblock-start-re nil t)
  10018. (goto-char (match-beginning 0))
  10019. (save-excursion
  10020. (condition-case nil
  10021. (funcall cmd)
  10022. (error (message "Error during update of dynamic block"))))
  10023. (unless (re-search-forward org-dblock-end-re nil t)
  10024. (error "Dynamic block not terminated"))))))
  10025. (defun org-dblock-update (&optional arg)
  10026. "User command for updating dynamic blocks.
  10027. Update the dynamic block at point. With prefix ARG, update all dynamic
  10028. blocks in the buffer."
  10029. (interactive "P")
  10030. (if arg
  10031. (org-update-all-dblocks)
  10032. (or (looking-at org-dblock-start-re)
  10033. (org-beginning-of-dblock))
  10034. (org-update-dblock)))
  10035. (defun org-update-dblock ()
  10036. "Update the dynamic block at point.
  10037. This means to empty the block, parse for parameters and then call
  10038. the correct writing function."
  10039. (interactive)
  10040. (save-window-excursion
  10041. (let* ((pos (point))
  10042. (line (org-current-line))
  10043. (params (org-prepare-dblock))
  10044. (name (plist-get params :name))
  10045. (indent (plist-get params :indentation-column))
  10046. (cmd (intern (concat "org-dblock-write:" name))))
  10047. (message "Updating dynamic block `%s' at line %d..." name line)
  10048. (funcall cmd params)
  10049. (message "Updating dynamic block `%s' at line %d...done" name line)
  10050. (goto-char pos)
  10051. (when (and indent (> indent 0))
  10052. (setq indent (make-string indent ?\ ))
  10053. (save-excursion
  10054. (org-beginning-of-dblock)
  10055. (forward-line 1)
  10056. (while (not (looking-at org-dblock-end-re))
  10057. (insert indent)
  10058. (beginning-of-line 2))
  10059. (when (looking-at org-dblock-end-re)
  10060. (and (looking-at "[ \t]+")
  10061. (replace-match ""))
  10062. (insert indent)))))))
  10063. (defun org-beginning-of-dblock ()
  10064. "Find the beginning of the dynamic block at point.
  10065. Error if there is no such block at point."
  10066. (let ((pos (point))
  10067. beg)
  10068. (end-of-line 1)
  10069. (if (and (re-search-backward org-dblock-start-re nil t)
  10070. (setq beg (match-beginning 0))
  10071. (re-search-forward org-dblock-end-re nil t)
  10072. (> (match-end 0) pos))
  10073. (goto-char beg)
  10074. (goto-char pos)
  10075. (error "Not in a dynamic block"))))
  10076. ;;;###autoload
  10077. (defun org-update-all-dblocks ()
  10078. "Update all dynamic blocks in the buffer.
  10079. This function can be used in a hook."
  10080. (interactive)
  10081. (when (derived-mode-p 'org-mode)
  10082. (org-map-dblocks 'org-update-dblock)))
  10083. ;;;; Completion
  10084. (defconst org-additional-option-like-keywords
  10085. '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
  10086. "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
  10087. "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
  10088. "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
  10089. "BEGIN:" "END:"
  10090. "ORGTBL" "TBLFM:" "TBLNAME:"
  10091. "BEGIN_EXAMPLE" "END_EXAMPLE"
  10092. "BEGIN_QUOTE" "END_QUOTE"
  10093. "BEGIN_VERSE" "END_VERSE"
  10094. "BEGIN_CENTER" "END_CENTER"
  10095. "BEGIN_SRC" "END_SRC"
  10096. "BEGIN_RESULT" "END_RESULT"
  10097. "NAME:" "RESULTS:"
  10098. "HEADER:" "HEADERS:"
  10099. "CATEGORY:" "COLUMNS:" "PROPERTY:"
  10100. "CAPTION:" "LABEL:"
  10101. "SETUPFILE:"
  10102. "INCLUDE:"
  10103. "BIND:"
  10104. "MACRO:"))
  10105. (defcustom org-structure-template-alist
  10106. '(
  10107. ("s" "#+BEGIN_SRC ?\n\n#+END_SRC"
  10108. "<src lang=\"?\">\n\n</src>")
  10109. ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE"
  10110. "<example>\n?\n</example>")
  10111. ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE"
  10112. "<quote>\n?\n</quote>")
  10113. ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE"
  10114. "<verse>\n?\n</verse>")
  10115. ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER"
  10116. "<center>\n?\n</center>")
  10117. ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX"
  10118. "<literal style=\"latex\">\n?\n</literal>")
  10119. ("L" "#+LaTeX: "
  10120. "<literal style=\"latex\">?</literal>")
  10121. ("h" "#+BEGIN_HTML\n?\n#+END_HTML"
  10122. "<literal style=\"html\">\n?\n</literal>")
  10123. ("H" "#+HTML: "
  10124. "<literal style=\"html\">?</literal>")
  10125. ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
  10126. ("A" "#+ASCII: ")
  10127. ("i" "#+INDEX: ?"
  10128. "#+INDEX: ?")
  10129. ("I" "#+INCLUDE %file ?"
  10130. "<include file=%file markup=\"?\">")
  10131. )
  10132. "Structure completion elements.
  10133. This is a list of abbreviation keys and values. The value gets inserted
  10134. if you type `<' followed by the key and then press the completion key,
  10135. usually `M-TAB'. %file will be replaced by a file name after prompting
  10136. for the file using completion. The cursor will be placed at the position
  10137. of the `?` in the template.
  10138. There are two templates for each key, the first uses the original Org syntax,
  10139. the second uses Emacs Muse-like syntax tags. These Muse-like tags become
  10140. the default when the /org-mtags.el/ module has been loaded. See also the
  10141. variable `org-mtags-prefer-muse-templates'."
  10142. :group 'org-completion
  10143. :type '(repeat
  10144. (string :tag "Key")
  10145. (string :tag "Template")
  10146. (string :tag "Muse Template")))
  10147. (defun org-try-structure-completion ()
  10148. "Try to complete a structure template before point.
  10149. This looks for strings like \"<e\" on an otherwise empty line and
  10150. expands them."
  10151. (let ((l (buffer-substring (point-at-bol) (point)))
  10152. a)
  10153. (when (and (looking-at "[ \t]*$")
  10154. (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
  10155. (setq a (assoc (match-string 1 l) org-structure-template-alist)))
  10156. (org-complete-expand-structure-template (+ -1 (point-at-bol)
  10157. (match-beginning 1)) a)
  10158. t)))
  10159. (defun org-complete-expand-structure-template (start cell)
  10160. "Expand a structure template."
  10161. (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
  10162. (rpl (nth (if musep 2 1) cell))
  10163. (ind ""))
  10164. (delete-region start (point))
  10165. (when (string-match "\\`#\\+" rpl)
  10166. (cond
  10167. ((bolp))
  10168. ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
  10169. (setq ind (buffer-substring (point-at-bol) (point))))
  10170. (t (newline))))
  10171. (setq start (point))
  10172. (if (string-match "%file" rpl)
  10173. (setq rpl (replace-match
  10174. (concat
  10175. "\""
  10176. (save-match-data
  10177. (abbreviate-file-name (read-file-name "Include file: ")))
  10178. "\"")
  10179. t t rpl)))
  10180. (setq rpl (mapconcat 'identity (split-string rpl "\n")
  10181. (concat "\n" ind)))
  10182. (insert rpl)
  10183. (if (re-search-backward "\\?" start t) (delete-char 1))))
  10184. ;;;; TODO, DEADLINE, Comments
  10185. (defun org-toggle-comment ()
  10186. "Change the COMMENT state of an entry."
  10187. (interactive)
  10188. (save-excursion
  10189. (org-back-to-heading)
  10190. (let (case-fold-search)
  10191. (cond
  10192. ((looking-at (format org-heading-keyword-regexp-format
  10193. org-comment-string))
  10194. (goto-char (match-end 1))
  10195. (looking-at (concat " +" org-comment-string))
  10196. (replace-match "" t t)
  10197. (when (eolp) (insert " ")))
  10198. ((looking-at org-outline-regexp)
  10199. (goto-char (match-end 0))
  10200. (insert org-comment-string " "))))))
  10201. (defvar org-last-todo-state-is-todo nil
  10202. "This is non-nil when the last TODO state change led to a TODO state.
  10203. If the last change removed the TODO tag or switched to DONE, then
  10204. this is nil.")
  10205. (defvar org-setting-tags nil) ; dynamically skipped
  10206. (defvar org-todo-setup-filter-hook nil
  10207. "Hook for functions that pre-filter todo specs.
  10208. Each function takes a todo spec and returns either nil or the spec
  10209. transformed into canonical form." )
  10210. (defvar org-todo-get-default-hook nil
  10211. "Hook for functions that get a default item for todo.
  10212. Each function takes arguments (NEW-MARK OLD-MARK) and returns either
  10213. nil or a string to be used for the todo mark." )
  10214. (defvar org-agenda-headline-snapshot-before-repeat)
  10215. (defun org-current-effective-time ()
  10216. "Return current time adjusted for `org-extend-today-until' variable"
  10217. (let* ((ct (org-current-time))
  10218. (dct (decode-time ct))
  10219. (ct1
  10220. (if (and org-use-effective-time
  10221. (< (nth 2 dct) org-extend-today-until))
  10222. (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
  10223. ct)))
  10224. ct1))
  10225. (defun org-todo-yesterday (&optional arg)
  10226. "Like `org-todo' but the time of change will be 23:59 of yesterday."
  10227. (interactive "P")
  10228. (if (eq major-mode 'org-agenda-mode)
  10229. (apply 'org-agenda-todo-yesterday arg)
  10230. (let* ((hour (third (decode-time
  10231. (org-current-time))))
  10232. (org-extend-today-until (1+ hour)))
  10233. (org-todo arg))))
  10234. (defun org-todo (&optional arg)
  10235. "Change the TODO state of an item.
  10236. The state of an item is given by a keyword at the start of the heading,
  10237. like
  10238. *** TODO Write paper
  10239. *** DONE Call mom
  10240. The different keywords are specified in the variable `org-todo-keywords'.
  10241. By default the available states are \"TODO\" and \"DONE\".
  10242. So for this example: when the item starts with TODO, it is changed to DONE.
  10243. When it starts with DONE, the DONE is removed. And when neither TODO nor
  10244. DONE are present, add TODO at the beginning of the heading.
  10245. With \\[universal-argument] prefix arg, use completion to determine the new \
  10246. state.
  10247. With numeric prefix arg, switch to that state.
  10248. With a double \\[universal-argument] prefix, switch to the next set of TODO \
  10249. keywords (nextset).
  10250. With a triple \\[universal-argument] prefix, circumvent any state blocking.
  10251. With a numeric prefix arg of 0, inhibit note taking for the change.
  10252. For calling through lisp, arg is also interpreted in the following way:
  10253. 'none -> empty state
  10254. \"\"(empty string) -> switch to empty state
  10255. 'done -> switch to DONE
  10256. 'nextset -> switch to the next set of keywords
  10257. 'previousset -> switch to the previous set of keywords
  10258. \"WAITING\" -> switch to the specified keyword, but only if it
  10259. really is a member of `org-todo-keywords'."
  10260. (interactive "P")
  10261. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  10262. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  10263. 'region-start-level 'region))
  10264. org-loop-over-headlines-in-active-region)
  10265. (org-map-entries
  10266. `(org-todo ,arg)
  10267. org-loop-over-headlines-in-active-region
  10268. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  10269. (if (equal arg '(16)) (setq arg 'nextset))
  10270. (let ((org-blocker-hook org-blocker-hook)
  10271. (case-fold-search nil))
  10272. (when (equal arg '(64))
  10273. (setq arg nil org-blocker-hook nil))
  10274. (when (and org-blocker-hook
  10275. (or org-inhibit-blocking
  10276. (org-entry-get nil "NOBLOCKING")))
  10277. (setq org-blocker-hook nil))
  10278. (save-excursion
  10279. (catch 'exit
  10280. (org-back-to-heading t)
  10281. (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
  10282. (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
  10283. (looking-at "\\(?: *\\|[ \t]*$\\)"))
  10284. (let* ((match-data (match-data))
  10285. (startpos (point-at-bol))
  10286. (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
  10287. (org-log-done org-log-done)
  10288. (org-log-repeat org-log-repeat)
  10289. (org-todo-log-states org-todo-log-states)
  10290. (org-inhibit-logging
  10291. (if (equal arg 0)
  10292. (progn (setq arg nil) 'note) org-inhibit-logging))
  10293. (this (match-string 1))
  10294. (hl-pos (match-beginning 0))
  10295. (head (org-get-todo-sequence-head this))
  10296. (ass (assoc head org-todo-kwd-alist))
  10297. (interpret (nth 1 ass))
  10298. (done-word (nth 3 ass))
  10299. (final-done-word (nth 4 ass))
  10300. (org-last-state (or this ""))
  10301. (completion-ignore-case t)
  10302. (member (member this org-todo-keywords-1))
  10303. (tail (cdr member))
  10304. (org-state (cond
  10305. ((and org-todo-key-trigger
  10306. (or (and (equal arg '(4))
  10307. (eq org-use-fast-todo-selection 'prefix))
  10308. (and (not arg) org-use-fast-todo-selection
  10309. (not (eq org-use-fast-todo-selection
  10310. 'prefix)))))
  10311. ;; Use fast selection
  10312. (org-fast-todo-selection))
  10313. ((and (equal arg '(4))
  10314. (or (not org-use-fast-todo-selection)
  10315. (not org-todo-key-trigger)))
  10316. ;; Read a state with completion
  10317. (org-icompleting-read
  10318. "State: " (mapcar (lambda(x) (list x))
  10319. org-todo-keywords-1)
  10320. nil t))
  10321. ((eq arg 'right)
  10322. (if this
  10323. (if tail (car tail) nil)
  10324. (car org-todo-keywords-1)))
  10325. ((eq arg 'left)
  10326. (if (equal member org-todo-keywords-1)
  10327. nil
  10328. (if this
  10329. (nth (- (length org-todo-keywords-1)
  10330. (length tail) 2)
  10331. org-todo-keywords-1)
  10332. (org-last org-todo-keywords-1))))
  10333. ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
  10334. (setq arg nil))) ; hack to fall back to cycling
  10335. (arg
  10336. ;; user or caller requests a specific state
  10337. (cond
  10338. ((equal arg "") nil)
  10339. ((eq arg 'none) nil)
  10340. ((eq arg 'done) (or done-word (car org-done-keywords)))
  10341. ((eq arg 'nextset)
  10342. (or (car (cdr (member head org-todo-heads)))
  10343. (car org-todo-heads)))
  10344. ((eq arg 'previousset)
  10345. (let ((org-todo-heads (reverse org-todo-heads)))
  10346. (or (car (cdr (member head org-todo-heads)))
  10347. (car org-todo-heads))))
  10348. ((car (member arg org-todo-keywords-1)))
  10349. ((stringp arg)
  10350. (error "State `%s' not valid in this file" arg))
  10351. ((nth (1- (prefix-numeric-value arg))
  10352. org-todo-keywords-1))))
  10353. ((null member) (or head (car org-todo-keywords-1)))
  10354. ((equal this final-done-word) nil) ;; -> make empty
  10355. ((null tail) nil) ;; -> first entry
  10356. ((memq interpret '(type priority))
  10357. (if (eq this-command last-command)
  10358. (car tail)
  10359. (if (> (length tail) 0)
  10360. (or done-word (car org-done-keywords))
  10361. nil)))
  10362. (t
  10363. (car tail))))
  10364. (org-state (or
  10365. (run-hook-with-args-until-success
  10366. 'org-todo-get-default-hook org-state org-last-state)
  10367. org-state))
  10368. (next (if org-state (concat " " org-state " ") " "))
  10369. (change-plist (list :type 'todo-state-change :from this :to org-state
  10370. :position startpos))
  10371. dolog now-done-p)
  10372. (when org-blocker-hook
  10373. (setq org-last-todo-state-is-todo
  10374. (not (member this org-done-keywords)))
  10375. (unless (save-excursion
  10376. (save-match-data
  10377. (org-with-wide-buffer
  10378. (run-hook-with-args-until-failure
  10379. 'org-blocker-hook change-plist))))
  10380. (if (org-called-interactively-p 'interactive)
  10381. (error "TODO state change from %s to %s blocked" this org-state)
  10382. ;; fail silently
  10383. (message "TODO state change from %s to %s blocked" this org-state)
  10384. (throw 'exit nil))))
  10385. (store-match-data match-data)
  10386. (replace-match next t t)
  10387. (unless (pos-visible-in-window-p hl-pos)
  10388. (message "TODO state changed to %s" (org-trim next)))
  10389. (unless head
  10390. (setq head (org-get-todo-sequence-head org-state)
  10391. ass (assoc head org-todo-kwd-alist)
  10392. interpret (nth 1 ass)
  10393. done-word (nth 3 ass)
  10394. final-done-word (nth 4 ass)))
  10395. (when (memq arg '(nextset previousset))
  10396. (message "Keyword-Set %d/%d: %s"
  10397. (- (length org-todo-sets) -1
  10398. (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
  10399. (length org-todo-sets)
  10400. (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
  10401. (setq org-last-todo-state-is-todo
  10402. (not (member org-state org-done-keywords)))
  10403. (setq now-done-p (and (member org-state org-done-keywords)
  10404. (not (member this org-done-keywords))))
  10405. (and logging (org-local-logging logging))
  10406. (when (and (or org-todo-log-states org-log-done)
  10407. (not (eq org-inhibit-logging t))
  10408. (not (memq arg '(nextset previousset))))
  10409. ;; we need to look at recording a time and note
  10410. (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
  10411. (nth 2 (assoc this org-todo-log-states))))
  10412. (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
  10413. (setq dolog 'time))
  10414. (when (and org-state
  10415. (member org-state org-not-done-keywords)
  10416. (not (member this org-not-done-keywords)))
  10417. ;; This is now a todo state and was not one before
  10418. ;; If there was a CLOSED time stamp, get rid of it.
  10419. (org-add-planning-info nil nil 'closed))
  10420. (when (and now-done-p org-log-done)
  10421. ;; It is now done, and it was not done before
  10422. (org-add-planning-info 'closed (org-current-effective-time))
  10423. (if (and (not dolog) (eq 'note org-log-done))
  10424. (org-add-log-setup 'done org-state this 'findpos 'note)))
  10425. (when (and org-state dolog)
  10426. ;; This is a non-nil state, and we need to log it
  10427. (org-add-log-setup 'state org-state this 'findpos dolog)))
  10428. ;; Fixup tag positioning
  10429. (org-todo-trigger-tag-changes org-state)
  10430. (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
  10431. (when org-provide-todo-statistics
  10432. (org-update-parent-todo-statistics))
  10433. (run-hooks 'org-after-todo-state-change-hook)
  10434. (if (and arg (not (member org-state org-done-keywords)))
  10435. (setq head (org-get-todo-sequence-head org-state)))
  10436. (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
  10437. ;; Do we need to trigger a repeat?
  10438. (when now-done-p
  10439. (when (boundp 'org-agenda-headline-snapshot-before-repeat)
  10440. ;; This is for the agenda, take a snapshot of the headline.
  10441. (save-match-data
  10442. (setq org-agenda-headline-snapshot-before-repeat
  10443. (org-get-heading))))
  10444. (org-auto-repeat-maybe org-state))
  10445. ;; Fixup cursor location if close to the keyword
  10446. (if (and (outline-on-heading-p)
  10447. (not (bolp))
  10448. (save-excursion (beginning-of-line 1)
  10449. (looking-at org-todo-line-regexp))
  10450. (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
  10451. (progn
  10452. (goto-char (or (match-end 2) (match-end 1)))
  10453. (and (looking-at " ") (just-one-space))))
  10454. (when org-trigger-hook
  10455. (save-excursion
  10456. (run-hook-with-args 'org-trigger-hook change-plist)))))))))
  10457. (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
  10458. "Block turning an entry into a TODO, using the hierarchy.
  10459. This checks whether the current task should be blocked from state
  10460. changes. Such blocking occurs when:
  10461. 1. The task has children which are not all in a completed state.
  10462. 2. A task has a parent with the property :ORDERED:, and there
  10463. are siblings prior to the current task with incomplete
  10464. status.
  10465. 3. The parent of the task is blocked because it has siblings that should
  10466. be done first, or is child of a block grandparent TODO entry."
  10467. (if (not org-enforce-todo-dependencies)
  10468. t ; if locally turned off don't block
  10469. (catch 'dont-block
  10470. ;; If this is not a todo state change, or if this entry is already DONE,
  10471. ;; do not block
  10472. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  10473. (member (plist-get change-plist :from)
  10474. (cons 'done org-done-keywords))
  10475. (member (plist-get change-plist :to)
  10476. (cons 'todo org-not-done-keywords))
  10477. (not (plist-get change-plist :to)))
  10478. (throw 'dont-block t))
  10479. ;; If this task has children, and any are undone, it's blocked
  10480. (save-excursion
  10481. (org-back-to-heading t)
  10482. (let ((this-level (funcall outline-level)))
  10483. (outline-next-heading)
  10484. (let ((child-level (funcall outline-level)))
  10485. (while (and (not (eobp))
  10486. (> child-level this-level))
  10487. ;; this todo has children, check whether they are all
  10488. ;; completed
  10489. (if (and (not (org-entry-is-done-p))
  10490. (org-entry-is-todo-p))
  10491. (throw 'dont-block nil))
  10492. (outline-next-heading)
  10493. (setq child-level (funcall outline-level))))))
  10494. ;; Otherwise, if the task's parent has the :ORDERED: property, and
  10495. ;; any previous siblings are undone, it's blocked
  10496. (save-excursion
  10497. (org-back-to-heading t)
  10498. (let* ((pos (point))
  10499. (parent-pos (and (org-up-heading-safe) (point))))
  10500. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  10501. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  10502. (forward-line 1)
  10503. (re-search-forward org-not-done-heading-regexp pos t))
  10504. (throw 'dont-block nil)) ; block, there is an older sibling not done.
  10505. ;; Search further up the hierarchy, to see if an ancestor is blocked
  10506. (while t
  10507. (goto-char parent-pos)
  10508. (if (not (looking-at org-not-done-heading-regexp))
  10509. (throw 'dont-block t)) ; do not block, parent is not a TODO
  10510. (setq pos (point))
  10511. (setq parent-pos (and (org-up-heading-safe) (point)))
  10512. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  10513. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  10514. (forward-line 1)
  10515. (re-search-forward org-not-done-heading-regexp pos t))
  10516. (throw 'dont-block nil)))))))) ; block, older sibling not done.
  10517. (defcustom org-track-ordered-property-with-tag nil
  10518. "Should the ORDERED property also be shown as a tag?
  10519. The ORDERED property decides if an entry should require subtasks to be
  10520. completed in sequence. Since a property is not very visible, setting
  10521. this option means that toggling the ORDERED property with the command
  10522. `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
  10523. not relevant for the behavior, but it makes things more visible.
  10524. Note that toggling the tag with tags commands will not change the property
  10525. and therefore not influence behavior!
  10526. This can be t, meaning the tag ORDERED should be used, It can also be a
  10527. string to select a different tag for this task."
  10528. :group 'org-todo
  10529. :type '(choice
  10530. (const :tag "No tracking" nil)
  10531. (const :tag "Track with ORDERED tag" t)
  10532. (string :tag "Use other tag")))
  10533. (defun org-toggle-ordered-property ()
  10534. "Toggle the ORDERED property of the current entry.
  10535. For better visibility, you can track the value of this property with a tag.
  10536. See variable `org-track-ordered-property-with-tag'."
  10537. (interactive)
  10538. (let* ((t1 org-track-ordered-property-with-tag)
  10539. (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
  10540. (save-excursion
  10541. (org-back-to-heading)
  10542. (if (org-entry-get nil "ORDERED")
  10543. (progn
  10544. (org-delete-property "ORDERED")
  10545. (and tag (org-toggle-tag tag 'off))
  10546. (message "Subtasks can be completed in arbitrary order"))
  10547. (org-entry-put nil "ORDERED" "t")
  10548. (and tag (org-toggle-tag tag 'on))
  10549. (message "Subtasks must be completed in sequence")))))
  10550. (defvar org-blocked-by-checkboxes) ; dynamically scoped
  10551. (defun org-block-todo-from-checkboxes (change-plist)
  10552. "Block turning an entry into a TODO, using checkboxes.
  10553. This checks whether the current task should be blocked from state
  10554. changes because there are unchecked boxes in this entry."
  10555. (if (not org-enforce-todo-checkbox-dependencies)
  10556. t ; if locally turned off don't block
  10557. (catch 'dont-block
  10558. ;; If this is not a todo state change, or if this entry is already DONE,
  10559. ;; do not block
  10560. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  10561. (member (plist-get change-plist :from)
  10562. (cons 'done org-done-keywords))
  10563. (member (plist-get change-plist :to)
  10564. (cons 'todo org-not-done-keywords))
  10565. (not (plist-get change-plist :to)))
  10566. (throw 'dont-block t))
  10567. ;; If this task has checkboxes that are not checked, it's blocked
  10568. (save-excursion
  10569. (org-back-to-heading t)
  10570. (let ((beg (point)) end)
  10571. (outline-next-heading)
  10572. (setq end (point))
  10573. (goto-char beg)
  10574. (if (org-list-search-forward
  10575. (concat (org-item-beginning-re)
  10576. "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
  10577. "\\[[- ]\\]")
  10578. end t)
  10579. (progn
  10580. (if (boundp 'org-blocked-by-checkboxes)
  10581. (setq org-blocked-by-checkboxes t))
  10582. (throw 'dont-block nil)))))
  10583. t))) ; do not block
  10584. (defun org-entry-blocked-p ()
  10585. "Is the current entry blocked?"
  10586. (if (org-entry-get nil "NOBLOCKING")
  10587. nil ;; Never block this entry
  10588. (not
  10589. (run-hook-with-args-until-failure
  10590. 'org-blocker-hook
  10591. (list :type 'todo-state-change
  10592. :position (point)
  10593. :from 'todo
  10594. :to 'done)))))
  10595. (defun org-update-statistics-cookies (all)
  10596. "Update the statistics cookie, either from TODO or from checkboxes.
  10597. This should be called with the cursor in a line with a statistics cookie."
  10598. (interactive "P")
  10599. (if all
  10600. (progn
  10601. (org-update-checkbox-count 'all)
  10602. (org-map-entries 'org-update-parent-todo-statistics))
  10603. (if (not (org-at-heading-p))
  10604. (org-update-checkbox-count)
  10605. (let ((pos (move-marker (make-marker) (point)))
  10606. end l1 l2)
  10607. (ignore-errors (org-back-to-heading t))
  10608. (if (not (org-at-heading-p))
  10609. (org-update-checkbox-count)
  10610. (setq l1 (org-outline-level))
  10611. (setq end (save-excursion
  10612. (outline-next-heading)
  10613. (if (org-at-heading-p) (setq l2 (org-outline-level)))
  10614. (point)))
  10615. (if (and (save-excursion
  10616. (re-search-forward
  10617. "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
  10618. (not (save-excursion (re-search-forward
  10619. ":COOKIE_DATA:.*\\<todo\\>" end t))))
  10620. (org-update-checkbox-count)
  10621. (if (and l2 (> l2 l1))
  10622. (progn
  10623. (goto-char end)
  10624. (org-update-parent-todo-statistics))
  10625. (goto-char pos)
  10626. (beginning-of-line 1)
  10627. (while (re-search-forward
  10628. "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
  10629. (point-at-eol) t)
  10630. (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
  10631. (goto-char pos)
  10632. (move-marker pos nil)))))
  10633. (defvar org-entry-property-inherited-from) ;; defined below
  10634. (defun org-update-parent-todo-statistics ()
  10635. "Update any statistics cookie in the parent of the current headline.
  10636. When `org-hierarchical-todo-statistics' is nil, statistics will cover
  10637. the entire subtree and this will travel up the hierarchy and update
  10638. statistics everywhere."
  10639. (let* ((prop (save-excursion (org-up-heading-safe)
  10640. (org-entry-get nil "COOKIE_DATA" 'inherit)))
  10641. (recursive (or (not org-hierarchical-todo-statistics)
  10642. (and prop (string-match "\\<recursive\\>" prop))))
  10643. (lim (or (and prop (marker-position org-entry-property-inherited-from))
  10644. 0))
  10645. (first t)
  10646. (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  10647. level ltoggle l1 new ndel
  10648. (cnt-all 0) (cnt-done 0) is-percent kwd
  10649. checkbox-beg ov ovs ove cookie-present)
  10650. (catch 'exit
  10651. (save-excursion
  10652. (beginning-of-line 1)
  10653. (setq ltoggle (funcall outline-level))
  10654. ;; Three situations are to consider:
  10655. ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
  10656. ;; to the top-level ancestor on the headline;
  10657. ;; 2. If parent has "recursive" property, repeat up to the
  10658. ;; headline setting that property, taking inheritance into
  10659. ;; account;
  10660. ;; 3. Else, move up to direct parent and proceed only once.
  10661. (while (and (setq level (org-up-heading-safe))
  10662. (or recursive first)
  10663. (>= (point) lim))
  10664. (setq first nil cookie-present nil)
  10665. (unless (and level
  10666. (not (string-match
  10667. "\\<checkbox\\>"
  10668. (downcase (or (org-entry-get nil "COOKIE_DATA")
  10669. "")))))
  10670. (throw 'exit nil))
  10671. (while (re-search-forward box-re (point-at-eol) t)
  10672. (setq cnt-all 0 cnt-done 0 cookie-present t)
  10673. (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
  10674. (save-match-data
  10675. (unless (outline-next-heading) (throw 'exit nil))
  10676. (while (and (looking-at org-complex-heading-regexp)
  10677. (> (setq l1 (length (match-string 1))) level))
  10678. (setq kwd (and (or recursive (= l1 ltoggle))
  10679. (match-string 2)))
  10680. (if (or (eq org-provide-todo-statistics 'all-headlines)
  10681. (and (listp org-provide-todo-statistics)
  10682. (or (member kwd org-provide-todo-statistics)
  10683. (member kwd org-done-keywords))))
  10684. (setq cnt-all (1+ cnt-all))
  10685. (if (eq org-provide-todo-statistics t)
  10686. (and kwd (setq cnt-all (1+ cnt-all)))))
  10687. (and (member kwd org-done-keywords)
  10688. (setq cnt-done (1+ cnt-done)))
  10689. (outline-next-heading)))
  10690. (setq new
  10691. (if is-percent
  10692. (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
  10693. (format "[%d/%d]" cnt-done cnt-all))
  10694. ndel (- (match-end 0) checkbox-beg))
  10695. ;; handle overlays when updating cookie from column view
  10696. (when (setq ov (car (overlays-at checkbox-beg)))
  10697. (setq ovs (overlay-start ov) ove (overlay-end ov))
  10698. (delete-overlay ov))
  10699. (goto-char checkbox-beg)
  10700. (insert new)
  10701. (delete-region (point) (+ (point) ndel))
  10702. (when org-auto-align-tags (org-fix-tags-on-the-fly))
  10703. (when ov (move-overlay ov ovs ove)))
  10704. (when cookie-present
  10705. (run-hook-with-args 'org-after-todo-statistics-hook
  10706. cnt-done (- cnt-all cnt-done))))))
  10707. (run-hooks 'org-todo-statistics-hook)))
  10708. (defvar org-after-todo-statistics-hook nil
  10709. "Hook that is called after a TODO statistics cookie has been updated.
  10710. Each function is called with two arguments: the number of not-done entries
  10711. and the number of done entries.
  10712. For example, the following function, when added to this hook, will switch
  10713. an entry to DONE when all children are done, and back to TODO when new
  10714. entries are set to a TODO status. Note that this hook is only called
  10715. when there is a statistics cookie in the headline!
  10716. (defun org-summary-todo (n-done n-not-done)
  10717. \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
  10718. (let (org-log-done org-log-states) ; turn off logging
  10719. (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
  10720. ")
  10721. (defvar org-todo-statistics-hook nil
  10722. "Hook that is run whenever Org thinks TODO statistics should be updated.
  10723. This hook runs even if there is no statistics cookie present, in which case
  10724. `org-after-todo-statistics-hook' would not run.")
  10725. (defun org-todo-trigger-tag-changes (state)
  10726. "Apply the changes defined in `org-todo-state-tags-triggers'."
  10727. (let ((l org-todo-state-tags-triggers)
  10728. changes)
  10729. (when (or (not state) (equal state ""))
  10730. (setq changes (append changes (cdr (assoc "" l)))))
  10731. (when (and (stringp state) (> (length state) 0))
  10732. (setq changes (append changes (cdr (assoc state l)))))
  10733. (when (member state org-not-done-keywords)
  10734. (setq changes (append changes (cdr (assoc 'todo l)))))
  10735. (when (member state org-done-keywords)
  10736. (setq changes (append changes (cdr (assoc 'done l)))))
  10737. (dolist (c changes)
  10738. (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
  10739. (defun org-local-logging (value)
  10740. "Get logging settings from a property VALUE."
  10741. (let* (words w a)
  10742. ;; directly set the variables, they are already local.
  10743. (setq org-log-done nil
  10744. org-log-repeat nil
  10745. org-todo-log-states nil)
  10746. (setq words (org-split-string value))
  10747. (while (setq w (pop words))
  10748. (cond
  10749. ((setq a (assoc w org-startup-options))
  10750. (and (member (nth 1 a) '(org-log-done org-log-repeat))
  10751. (set (nth 1 a) (nth 2 a))))
  10752. ((setq a (org-extract-log-state-settings w))
  10753. (and (member (car a) org-todo-keywords-1)
  10754. (push a org-todo-log-states)))))))
  10755. (defun org-get-todo-sequence-head (kwd)
  10756. "Return the head of the TODO sequence to which KWD belongs.
  10757. If KWD is not set, check if there is a text property remembering the
  10758. right sequence."
  10759. (let (p)
  10760. (cond
  10761. ((not kwd)
  10762. (or (get-text-property (point-at-bol) 'org-todo-head)
  10763. (progn
  10764. (setq p (next-single-property-change (point-at-bol) 'org-todo-head
  10765. nil (point-at-eol)))
  10766. (get-text-property p 'org-todo-head))))
  10767. ((not (member kwd org-todo-keywords-1))
  10768. (car org-todo-keywords-1))
  10769. (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
  10770. (defun org-fast-todo-selection ()
  10771. "Fast TODO keyword selection with single keys.
  10772. Returns the new TODO keyword, or nil if no state change should occur."
  10773. (let* ((fulltable org-todo-key-alist)
  10774. (done-keywords org-done-keywords) ;; needed for the faces.
  10775. (maxlen (apply 'max (mapcar
  10776. (lambda (x)
  10777. (if (stringp (car x)) (string-width (car x)) 0))
  10778. fulltable)))
  10779. (expert nil)
  10780. (fwidth (+ maxlen 3 1 3))
  10781. (ncol (/ (- (window-width) 4) fwidth))
  10782. tg cnt e c tbl
  10783. groups ingroup)
  10784. (save-excursion
  10785. (save-window-excursion
  10786. (if expert
  10787. (set-buffer (get-buffer-create " *Org todo*"))
  10788. (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
  10789. (erase-buffer)
  10790. (org-set-local 'org-done-keywords done-keywords)
  10791. (setq tbl fulltable cnt 0)
  10792. (while (setq e (pop tbl))
  10793. (cond
  10794. ((equal e '(:startgroup))
  10795. (push '() groups) (setq ingroup t)
  10796. (when (not (= cnt 0))
  10797. (setq cnt 0)
  10798. (insert "\n"))
  10799. (insert "{ "))
  10800. ((equal e '(:endgroup))
  10801. (setq ingroup nil cnt 0)
  10802. (insert "}\n"))
  10803. ((equal e '(:newline))
  10804. (when (not (= cnt 0))
  10805. (setq cnt 0)
  10806. (insert "\n")
  10807. (setq e (car tbl))
  10808. (while (equal (car tbl) '(:newline))
  10809. (insert "\n")
  10810. (setq tbl (cdr tbl)))))
  10811. (t
  10812. (setq tg (car e) c (cdr e))
  10813. (if ingroup (push tg (car groups)))
  10814. (setq tg (org-add-props tg nil 'face
  10815. (org-get-todo-face tg)))
  10816. (if (and (= cnt 0) (not ingroup)) (insert " "))
  10817. (insert "[" c "] " tg (make-string
  10818. (- fwidth 4 (length tg)) ?\ ))
  10819. (when (= (setq cnt (1+ cnt)) ncol)
  10820. (insert "\n")
  10821. (if ingroup (insert " "))
  10822. (setq cnt 0)))))
  10823. (insert "\n")
  10824. (goto-char (point-min))
  10825. (if (not expert) (org-fit-window-to-buffer))
  10826. (message "[a-z..]:Set [SPC]:clear")
  10827. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  10828. (cond
  10829. ((or (= c ?\C-g)
  10830. (and (= c ?q) (not (rassoc c fulltable))))
  10831. (setq quit-flag t))
  10832. ((= c ?\ ) nil)
  10833. ((setq e (rassoc c fulltable) tg (car e))
  10834. tg)
  10835. (t (setq quit-flag t)))))))
  10836. (defun org-entry-is-todo-p ()
  10837. (member (org-get-todo-state) org-not-done-keywords))
  10838. (defun org-entry-is-done-p ()
  10839. (member (org-get-todo-state) org-done-keywords))
  10840. (defun org-get-todo-state ()
  10841. (save-excursion
  10842. (org-back-to-heading t)
  10843. (and (looking-at org-todo-line-regexp)
  10844. (match-end 2)
  10845. (match-string 2))))
  10846. (defun org-at-date-range-p (&optional inactive-ok)
  10847. "Is the cursor inside a date range?"
  10848. (interactive)
  10849. (save-excursion
  10850. (catch 'exit
  10851. (let ((pos (point)))
  10852. (skip-chars-backward "^[<\r\n")
  10853. (skip-chars-backward "<[")
  10854. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  10855. (>= (match-end 0) pos)
  10856. (throw 'exit t))
  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. nil)))
  10863. (defun org-get-repeat (&optional tagline)
  10864. "Check if there is a deadline/schedule with repeater in this entry."
  10865. (save-match-data
  10866. (save-excursion
  10867. (org-back-to-heading t)
  10868. (and (re-search-forward (if tagline
  10869. (concat tagline "\\s-*" org-repeat-re)
  10870. org-repeat-re)
  10871. (org-entry-end-position) t)
  10872. (match-string-no-properties 1)))))
  10873. (defvar org-last-changed-timestamp)
  10874. (defvar org-last-inserted-timestamp)
  10875. (defvar org-log-post-message)
  10876. (defvar org-log-note-purpose)
  10877. (defvar org-log-note-how)
  10878. (defvar org-log-note-extra)
  10879. (defun org-auto-repeat-maybe (done-word)
  10880. "Check if the current headline contains a repeated deadline/schedule.
  10881. If yes, set TODO state back to what it was and change the base date
  10882. of repeating deadline/scheduled time stamps to new date.
  10883. This function is run automatically after each state change to a DONE state."
  10884. ;; last-state is dynamically scoped into this function
  10885. (let* ((repeat (org-get-repeat))
  10886. (aa (assoc org-last-state org-todo-kwd-alist))
  10887. (interpret (nth 1 aa))
  10888. (head (nth 2 aa))
  10889. (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
  10890. (msg "Entry repeats: ")
  10891. (org-log-done nil)
  10892. (org-todo-log-states nil)
  10893. re type n what ts time to-state)
  10894. (when repeat
  10895. (if (eq org-log-repeat t) (setq org-log-repeat 'state))
  10896. (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
  10897. org-todo-repeat-to-state))
  10898. (unless (and to-state (member to-state org-todo-keywords-1))
  10899. (setq to-state (if (eq interpret 'type) org-last-state head)))
  10900. (org-todo to-state)
  10901. (when (or org-log-repeat (org-entry-get nil "CLOCK"))
  10902. (org-entry-put nil "LAST_REPEAT" (format-time-string
  10903. (org-time-stamp-format t t))))
  10904. (when org-log-repeat
  10905. (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
  10906. (memq 'org-add-log-note post-command-hook))
  10907. ;; OK, we are already setup for some record
  10908. (if (eq org-log-repeat 'note)
  10909. ;; make sure we take a note, not only a time stamp
  10910. (setq org-log-note-how 'note))
  10911. ;; Set up for taking a record
  10912. (org-add-log-setup 'state (or done-word (car org-done-keywords))
  10913. org-last-state
  10914. 'findpos org-log-repeat)))
  10915. (org-back-to-heading t)
  10916. (org-add-planning-info nil nil 'closed)
  10917. (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  10918. org-deadline-time-regexp "\\)\\|\\("
  10919. org-ts-regexp "\\)"))
  10920. (while (re-search-forward
  10921. re (save-excursion (outline-next-heading) (point)) t)
  10922. (setq type (if (match-end 1) org-scheduled-string
  10923. (if (match-end 3) org-deadline-string "Plain:"))
  10924. ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
  10925. (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
  10926. (setq n (string-to-number (match-string 2 ts))
  10927. what (match-string 3 ts))
  10928. (if (equal what "w") (setq n (* n 7) what "d"))
  10929. (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
  10930. (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
  10931. ;; Preparation, see if we need to modify the start date for the change
  10932. (when (match-end 1)
  10933. (setq time (save-match-data (org-time-string-to-time ts)))
  10934. (cond
  10935. ((equal (match-string 1 ts) ".")
  10936. ;; Shift starting date to today
  10937. (org-timestamp-change
  10938. (- (org-today) (time-to-days time))
  10939. 'day))
  10940. ((equal (match-string 1 ts) "+")
  10941. (let ((nshiftmax 10) (nshift 0))
  10942. (while (or (= nshift 0)
  10943. (<= (time-to-days time)
  10944. (time-to-days (current-time))))
  10945. (when (= (incf nshift) nshiftmax)
  10946. (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
  10947. (error "Abort")))
  10948. (org-timestamp-change n (cdr (assoc what whata)))
  10949. (org-at-timestamp-p t)
  10950. (setq ts (match-string 1))
  10951. (setq time (save-match-data (org-time-string-to-time ts)))))
  10952. (org-timestamp-change (- n) (cdr (assoc what whata)))
  10953. ;; rematch, so that we have everything in place for the real shift
  10954. (org-at-timestamp-p t)
  10955. (setq ts (match-string 1))
  10956. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
  10957. (org-timestamp-change n (cdr (assoc what whata)))
  10958. (setq msg (concat msg type " " org-last-changed-timestamp " "))))
  10959. (setq org-log-post-message msg)
  10960. (message "%s" msg))))
  10961. (defun org-show-todo-tree (arg)
  10962. "Make a compact tree which shows all headlines marked with TODO.
  10963. The tree will show the lines where the regexp matches, and all higher
  10964. headlines above the match.
  10965. With a \\[universal-argument] prefix, prompt for a regexp to match.
  10966. With a numeric prefix N, construct a sparse tree for the Nth element
  10967. of `org-todo-keywords-1'."
  10968. (interactive "P")
  10969. (let ((case-fold-search nil)
  10970. (kwd-re
  10971. (cond ((null arg) org-not-done-regexp)
  10972. ((equal arg '(4))
  10973. (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
  10974. (mapcar 'list org-todo-keywords-1))))
  10975. (concat "\\("
  10976. (mapconcat 'identity (org-split-string kwd "|") "\\|")
  10977. "\\)\\>")))
  10978. ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
  10979. (regexp-quote (nth (1- (prefix-numeric-value arg))
  10980. org-todo-keywords-1)))
  10981. (t (error "Invalid prefix argument: %s" arg)))))
  10982. (message "%d TODO entries found"
  10983. (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
  10984. (defun org-deadline (&optional remove time)
  10985. "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
  10986. With argument REMOVE, remove any deadline from the item.
  10987. With argument TIME, set the deadline at the corresponding date. TIME
  10988. can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  10989. (interactive "P")
  10990. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  10991. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  10992. 'region-start-level 'region))
  10993. org-loop-over-headlines-in-active-region)
  10994. (org-map-entries
  10995. `(org-deadline ',remove ,time)
  10996. org-loop-over-headlines-in-active-region
  10997. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  10998. (let* ((old-date (org-entry-get nil "DEADLINE"))
  10999. (repeater (and old-date
  11000. (string-match
  11001. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  11002. old-date)
  11003. (match-string 1 old-date))))
  11004. (if remove
  11005. (progn
  11006. (when (and old-date org-log-redeadline)
  11007. (org-add-log-setup 'deldeadline nil old-date 'findpos
  11008. org-log-redeadline))
  11009. (org-remove-timestamp-with-keyword org-deadline-string)
  11010. (message "Item no longer has a deadline."))
  11011. (org-add-planning-info 'deadline time 'closed)
  11012. (when (and old-date org-log-redeadline
  11013. (not (equal old-date
  11014. (substring org-last-inserted-timestamp 1 -1))))
  11015. (org-add-log-setup 'redeadline nil old-date 'findpos
  11016. org-log-redeadline))
  11017. (when repeater
  11018. (save-excursion
  11019. (org-back-to-heading t)
  11020. (when (re-search-forward (concat org-deadline-string " "
  11021. org-last-inserted-timestamp)
  11022. (save-excursion
  11023. (outline-next-heading) (point)) t)
  11024. (goto-char (1- (match-end 0)))
  11025. (insert " " repeater)
  11026. (setq org-last-inserted-timestamp
  11027. (concat (substring org-last-inserted-timestamp 0 -1)
  11028. " " repeater
  11029. (substring org-last-inserted-timestamp -1))))))
  11030. (message "Deadline on %s" org-last-inserted-timestamp)))))
  11031. (defun org-schedule (&optional remove time)
  11032. "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
  11033. With argument REMOVE, remove any scheduling date from the item.
  11034. With argument TIME, scheduled at the corresponding date. TIME can
  11035. either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
  11036. (interactive "P")
  11037. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  11038. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  11039. 'region-start-level 'region))
  11040. org-loop-over-headlines-in-active-region)
  11041. (org-map-entries
  11042. `(org-schedule ',remove ,time)
  11043. org-loop-over-headlines-in-active-region
  11044. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  11045. (let* ((old-date (org-entry-get nil "SCHEDULED"))
  11046. (repeater (and old-date
  11047. (string-match
  11048. "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  11049. old-date)
  11050. (match-string 1 old-date))))
  11051. (if remove
  11052. (progn
  11053. (when (and old-date org-log-reschedule)
  11054. (org-add-log-setup 'delschedule nil old-date 'findpos
  11055. org-log-reschedule))
  11056. (org-remove-timestamp-with-keyword org-scheduled-string)
  11057. (message "Item is no longer scheduled."))
  11058. (org-add-planning-info 'scheduled time 'closed)
  11059. (when (and old-date org-log-reschedule
  11060. (not (equal old-date
  11061. (substring org-last-inserted-timestamp 1 -1))))
  11062. (org-add-log-setup 'reschedule nil old-date 'findpos
  11063. org-log-reschedule))
  11064. (when repeater
  11065. (save-excursion
  11066. (org-back-to-heading t)
  11067. (when (re-search-forward (concat org-scheduled-string " "
  11068. org-last-inserted-timestamp)
  11069. (save-excursion
  11070. (outline-next-heading) (point)) t)
  11071. (goto-char (1- (match-end 0)))
  11072. (insert " " repeater)
  11073. (setq org-last-inserted-timestamp
  11074. (concat (substring org-last-inserted-timestamp 0 -1)
  11075. " " repeater
  11076. (substring org-last-inserted-timestamp -1))))))
  11077. (message "Scheduled to %s" org-last-inserted-timestamp)))))
  11078. (defun org-get-scheduled-time (pom &optional inherit)
  11079. "Get the scheduled time as a time tuple, of a format suitable
  11080. for calling org-schedule with, or if there is no scheduling,
  11081. returns nil."
  11082. (let ((time (org-entry-get pom "SCHEDULED" inherit)))
  11083. (when time
  11084. (apply 'encode-time (org-parse-time-string time)))))
  11085. (defun org-get-deadline-time (pom &optional inherit)
  11086. "Get the deadline as a time tuple, of a format suitable for
  11087. calling org-deadline with, or if there is no scheduling, returns
  11088. nil."
  11089. (let ((time (org-entry-get pom "DEADLINE" inherit)))
  11090. (when time
  11091. (apply 'encode-time (org-parse-time-string time)))))
  11092. (defun org-remove-timestamp-with-keyword (keyword)
  11093. "Remove all time stamps with KEYWORD in the current entry."
  11094. (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
  11095. beg)
  11096. (save-excursion
  11097. (org-back-to-heading t)
  11098. (setq beg (point))
  11099. (outline-next-heading)
  11100. (while (re-search-backward re beg t)
  11101. (replace-match "")
  11102. (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
  11103. (equal (char-before) ?\ ))
  11104. (backward-delete-char 1)
  11105. (if (string-match "^[ \t]*$" (buffer-substring
  11106. (point-at-bol) (point-at-eol)))
  11107. (delete-region (point-at-bol)
  11108. (min (point-max) (1+ (point-at-eol))))))))))
  11109. (defun org-add-planning-info (what &optional time &rest remove)
  11110. "Insert new timestamp with keyword in the line directly after the headline.
  11111. WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
  11112. If non is given, the user is prompted for a date.
  11113. REMOVE indicates what kind of entries to remove. An old WHAT entry will also
  11114. be removed."
  11115. (interactive)
  11116. (let (org-time-was-given org-end-time-was-given ts
  11117. end default-time default-input)
  11118. (catch 'exit
  11119. (when (and (memq what '(scheduled deadline))
  11120. (or (not time)
  11121. (and (stringp time)
  11122. (string-match "^[-+]+[0-9]" time))))
  11123. ;; Try to get a default date/time from existing timestamp
  11124. (save-excursion
  11125. (org-back-to-heading t)
  11126. (setq end (save-excursion (outline-next-heading) (point)))
  11127. (when (re-search-forward (if (eq what 'scheduled)
  11128. org-scheduled-time-regexp
  11129. org-deadline-time-regexp)
  11130. end t)
  11131. (setq ts (match-string 1)
  11132. default-time
  11133. (apply 'encode-time (org-parse-time-string ts))
  11134. default-input (and ts (org-get-compact-tod ts))))))
  11135. (when what
  11136. (setq time
  11137. (if (stringp time)
  11138. ;; This is a string (relative or absolute), set proper date
  11139. (apply 'encode-time
  11140. (org-read-date-analyze
  11141. time default-time (decode-time default-time)))
  11142. ;; If necessary, get the time from the user
  11143. (or time (org-read-date nil 'to-time nil nil
  11144. default-time default-input)))))
  11145. (when (and org-insert-labeled-timestamps-at-point
  11146. (member what '(scheduled deadline)))
  11147. (insert
  11148. (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
  11149. (org-insert-time-stamp time org-time-was-given
  11150. nil nil nil (list org-end-time-was-given))
  11151. (setq what nil))
  11152. (save-excursion
  11153. (save-restriction
  11154. (let (col list elt ts buffer-invisibility-spec)
  11155. (org-back-to-heading t)
  11156. (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
  11157. (goto-char (match-end 1))
  11158. (setq col (current-column))
  11159. (goto-char (match-end 0))
  11160. (if (eobp) (insert "\n") (forward-char 1))
  11161. (when (and (not what)
  11162. (not (looking-at
  11163. (concat "[ \t]*"
  11164. org-keyword-time-not-clock-regexp))))
  11165. ;; Nothing to add, nothing to remove...... :-)
  11166. (throw 'exit nil))
  11167. (if (and (not (looking-at org-outline-regexp))
  11168. (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
  11169. "[^\r\n]*"))
  11170. (not (equal (match-string 1) org-clock-string)))
  11171. (narrow-to-region (match-beginning 0) (match-end 0))
  11172. (insert-before-markers "\n")
  11173. (backward-char 1)
  11174. (narrow-to-region (point) (point))
  11175. (and org-adapt-indentation (org-indent-to-column col)))
  11176. ;; Check if we have to remove something.
  11177. (setq list (cons what remove))
  11178. (while list
  11179. (setq elt (pop list))
  11180. (when (or (and (eq elt 'scheduled)
  11181. (re-search-forward org-scheduled-time-regexp nil t))
  11182. (and (eq elt 'deadline)
  11183. (re-search-forward org-deadline-time-regexp nil t))
  11184. (and (eq elt 'closed)
  11185. (re-search-forward org-closed-time-regexp nil t)))
  11186. (replace-match "")
  11187. (if (looking-at "--+<[^>]+>") (replace-match ""))))
  11188. (and (looking-at "[ \t]+") (replace-match ""))
  11189. (and org-adapt-indentation (bolp) (org-indent-to-column col))
  11190. (when what
  11191. (insert
  11192. (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
  11193. (cond ((eq what 'scheduled) org-scheduled-string)
  11194. ((eq what 'deadline) org-deadline-string)
  11195. ((eq what 'closed) org-closed-string))
  11196. " ")
  11197. (setq ts (org-insert-time-stamp
  11198. time
  11199. (or org-time-was-given
  11200. (and (eq what 'closed) org-log-done-with-time))
  11201. (eq what 'closed)
  11202. nil nil (list org-end-time-was-given)))
  11203. (insert
  11204. (if (not (or (bolp) (eq (char-before) ?\ )
  11205. (memq (char-after) '(32 10))
  11206. (eobp))) " " ""))
  11207. (end-of-line 1))
  11208. (goto-char (point-min))
  11209. (widen)
  11210. (if (and (looking-at "[ \t]*\n")
  11211. (equal (char-before) ?\n))
  11212. (delete-region (1- (point)) (point-at-eol)))
  11213. ts))))))
  11214. (defvar org-log-note-marker (make-marker))
  11215. (defvar org-log-note-purpose nil)
  11216. (defvar org-log-note-state nil)
  11217. (defvar org-log-note-previous-state nil)
  11218. (defvar org-log-note-how nil)
  11219. (defvar org-log-note-extra nil)
  11220. (defvar org-log-note-window-configuration nil)
  11221. (defvar org-log-note-return-to (make-marker))
  11222. (defvar org-log-note-effective-time nil
  11223. "Remembered current time so that dynamically scoped
  11224. `org-extend-today-until' affects tha timestamps in state change
  11225. log")
  11226. (defvar org-log-post-message nil
  11227. "Message to be displayed after a log note has been stored.
  11228. The auto-repeater uses this.")
  11229. (defun org-add-note ()
  11230. "Add a note to the current entry.
  11231. This is done in the same way as adding a state change note."
  11232. (interactive)
  11233. (org-add-log-setup 'note nil nil 'findpos nil))
  11234. (defvar org-property-end-re)
  11235. (defun org-add-log-setup (&optional purpose state prev-state
  11236. findpos how extra)
  11237. "Set up the post command hook to take a note.
  11238. If this is about to TODO state change, the new state is expected in STATE.
  11239. When FINDPOS is non-nil, find the correct position for the note in
  11240. the current entry. If not, assume that it can be inserted at point.
  11241. HOW is an indicator what kind of note should be created.
  11242. EXTRA is additional text that will be inserted into the notes buffer."
  11243. (let* ((org-log-into-drawer (org-log-into-drawer))
  11244. (drawer (cond ((stringp org-log-into-drawer)
  11245. org-log-into-drawer)
  11246. (org-log-into-drawer "LOGBOOK")
  11247. (t nil))))
  11248. (save-restriction
  11249. (save-excursion
  11250. (when findpos
  11251. (org-back-to-heading t)
  11252. (narrow-to-region (point) (save-excursion
  11253. (outline-next-heading) (point)))
  11254. (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"
  11255. "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
  11256. "[^\r\n]*\\)?"))
  11257. (goto-char (match-end 0))
  11258. (cond
  11259. (drawer
  11260. (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
  11261. nil t)
  11262. (progn
  11263. (goto-char (match-end 0))
  11264. (or org-log-states-order-reversed
  11265. (and (re-search-forward org-property-end-re nil t)
  11266. (goto-char (1- (match-beginning 0))))))
  11267. (insert "\n:" drawer ":\n:END:")
  11268. (beginning-of-line 0)
  11269. (org-indent-line-function)
  11270. (beginning-of-line 2)
  11271. (org-indent-line-function)
  11272. (end-of-line 0)))
  11273. ((and org-log-state-notes-insert-after-drawers
  11274. (save-excursion
  11275. (forward-line) (looking-at org-drawer-regexp)))
  11276. (forward-line)
  11277. (while (looking-at org-drawer-regexp)
  11278. (goto-char (match-end 0))
  11279. (re-search-forward org-property-end-re (point-max) t)
  11280. (forward-line))
  11281. (forward-line -1)))
  11282. (unless org-log-states-order-reversed
  11283. (and (= (char-after) ?\n) (forward-char 1))
  11284. (org-skip-over-state-notes)
  11285. (skip-chars-backward " \t\n\r")))
  11286. (move-marker org-log-note-marker (point))
  11287. (setq org-log-note-purpose purpose
  11288. org-log-note-state state
  11289. org-log-note-previous-state prev-state
  11290. org-log-note-how how
  11291. org-log-note-extra extra
  11292. org-log-note-effective-time (org-current-effective-time))
  11293. (add-hook 'post-command-hook 'org-add-log-note 'append)))))
  11294. (defun org-skip-over-state-notes ()
  11295. "Skip past the list of State notes in an entry."
  11296. (if (looking-at "\n[ \t]*- State") (forward-char 1))
  11297. (when (ignore-errors (goto-char (org-in-item-p)))
  11298. (let* ((struct (org-list-struct))
  11299. (prevs (org-list-prevs-alist struct)))
  11300. (while (looking-at "[ \t]*- State")
  11301. (goto-char (or (org-list-get-next-item (point) struct prevs)
  11302. (org-list-get-item-end (point) struct)))))))
  11303. (defun org-add-log-note (&optional purpose)
  11304. "Pop up a window for taking a note, and add this note later at point."
  11305. (remove-hook 'post-command-hook 'org-add-log-note)
  11306. (setq org-log-note-window-configuration (current-window-configuration))
  11307. (delete-other-windows)
  11308. (move-marker org-log-note-return-to (point))
  11309. (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
  11310. (goto-char org-log-note-marker)
  11311. (org-switch-to-buffer-other-window "*Org Note*")
  11312. (erase-buffer)
  11313. (if (memq org-log-note-how '(time state))
  11314. (let (current-prefix-arg) (org-store-log-note))
  11315. (let ((org-inhibit-startup t)) (org-mode))
  11316. (insert (format "# Insert note for %s.
  11317. # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
  11318. (cond
  11319. ((eq org-log-note-purpose 'clock-out) "stopped clock")
  11320. ((eq org-log-note-purpose 'done) "closed todo item")
  11321. ((eq org-log-note-purpose 'state)
  11322. (format "state change from \"%s\" to \"%s\""
  11323. (or org-log-note-previous-state "")
  11324. (or org-log-note-state "")))
  11325. ((eq org-log-note-purpose 'reschedule)
  11326. "rescheduling")
  11327. ((eq org-log-note-purpose 'delschedule)
  11328. "no longer scheduled")
  11329. ((eq org-log-note-purpose 'redeadline)
  11330. "changing deadline")
  11331. ((eq org-log-note-purpose 'deldeadline)
  11332. "removing deadline")
  11333. ((eq org-log-note-purpose 'refile)
  11334. "refiling")
  11335. ((eq org-log-note-purpose 'note)
  11336. "this entry")
  11337. (t (error "This should not happen")))))
  11338. (if org-log-note-extra (insert org-log-note-extra))
  11339. (org-set-local 'org-finish-function 'org-store-log-note)
  11340. (run-hooks 'org-log-buffer-setup-hook)))
  11341. (defvar org-note-abort nil) ; dynamically scoped
  11342. (defun org-store-log-note ()
  11343. "Finish taking a log note, and insert it to where it belongs."
  11344. (let ((txt (buffer-string))
  11345. (note (cdr (assq org-log-note-purpose org-log-note-headings)))
  11346. lines ind bul)
  11347. (kill-buffer (current-buffer))
  11348. (while (string-match "\\`#.*\n[ \t\n]*" txt)
  11349. (setq txt (replace-match "" t t txt)))
  11350. (if (string-match "\\s-+\\'" txt)
  11351. (setq txt (replace-match "" t t txt)))
  11352. (setq lines (org-split-string txt "\n"))
  11353. (when (and note (string-match "\\S-" note))
  11354. (setq note
  11355. (org-replace-escapes
  11356. note
  11357. (list (cons "%u" (user-login-name))
  11358. (cons "%U" user-full-name)
  11359. (cons "%t" (format-time-string
  11360. (org-time-stamp-format 'long 'inactive)
  11361. org-log-note-effective-time))
  11362. (cons "%T" (format-time-string
  11363. (org-time-stamp-format 'long nil)
  11364. org-log-note-effective-time))
  11365. (cons "%d" (format-time-string
  11366. (org-time-stamp-format nil 'inactive)
  11367. org-log-note-effective-time))
  11368. (cons "%D" (format-time-string
  11369. (org-time-stamp-format nil nil)
  11370. org-log-note-effective-time))
  11371. (cons "%s" (if org-log-note-state
  11372. (concat "\"" org-log-note-state "\"")
  11373. ""))
  11374. (cons "%S" (if org-log-note-previous-state
  11375. (concat "\"" org-log-note-previous-state "\"")
  11376. "\"\"")))))
  11377. (if lines (setq note (concat note " \\\\")))
  11378. (push note lines))
  11379. (when (or current-prefix-arg org-note-abort)
  11380. (when org-log-into-drawer
  11381. (org-remove-empty-drawer-at
  11382. (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
  11383. org-log-note-marker))
  11384. (setq lines nil))
  11385. (when lines
  11386. (with-current-buffer (marker-buffer org-log-note-marker)
  11387. (save-excursion
  11388. (goto-char org-log-note-marker)
  11389. (move-marker org-log-note-marker nil)
  11390. (end-of-line 1)
  11391. (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
  11392. (setq ind (save-excursion
  11393. (if (ignore-errors (goto-char (org-in-item-p)))
  11394. (let ((struct (org-list-struct)))
  11395. (org-list-get-ind
  11396. (org-list-get-top-point struct) struct))
  11397. (skip-chars-backward " \r\t\n")
  11398. (cond
  11399. ((and (org-at-heading-p)
  11400. org-adapt-indentation)
  11401. (1+ (org-current-level)))
  11402. ((org-at-heading-p) 0)
  11403. (t (org-get-indentation))))))
  11404. (setq bul (org-list-bullet-string "-"))
  11405. (org-indent-line-to ind)
  11406. (insert bul (pop lines))
  11407. (let ((ind-body (+ (length bul) ind)))
  11408. (while lines
  11409. (insert "\n")
  11410. (org-indent-line-to ind-body)
  11411. (insert (pop lines))))
  11412. (message "Note stored")
  11413. (org-back-to-heading t)
  11414. (org-cycle-hide-drawers 'children)))))
  11415. (set-window-configuration org-log-note-window-configuration)
  11416. (with-current-buffer (marker-buffer org-log-note-return-to)
  11417. (goto-char org-log-note-return-to))
  11418. (move-marker org-log-note-return-to nil)
  11419. (and org-log-post-message (message "%s" org-log-post-message)))
  11420. (defun org-remove-empty-drawer-at (drawer pos)
  11421. "Remove an empty drawer DRAWER at position POS.
  11422. POS may also be a marker."
  11423. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  11424. (save-excursion
  11425. (save-restriction
  11426. (widen)
  11427. (goto-char pos)
  11428. (if (org-in-regexp
  11429. (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
  11430. (replace-match ""))))))
  11431. (defun org-sparse-tree (&optional arg)
  11432. "Create a sparse tree, prompt for the details.
  11433. This command can create sparse trees. You first need to select the type
  11434. of match used to create the tree:
  11435. t Show all TODO entries.
  11436. T Show entries with a specific TODO keyword.
  11437. m Show entries selected by a tags/property match.
  11438. p Enter a property name and its value (both with completion on existing
  11439. names/values) and show entries with that property.
  11440. r Show entries matching a regular expression (`/' can be used as well)
  11441. d Show deadlines due within `org-deadline-warning-days'.
  11442. b Show deadlines and scheduled items before a date.
  11443. a Show deadlines and scheduled items after a date."
  11444. (interactive "P")
  11445. (let (ans kwd value)
  11446. (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")
  11447. (setq ans (read-char-exclusive))
  11448. (cond
  11449. ((equal ans ?d)
  11450. (call-interactively 'org-check-deadlines))
  11451. ((equal ans ?b)
  11452. (call-interactively 'org-check-before-date))
  11453. ((equal ans ?a)
  11454. (call-interactively 'org-check-after-date))
  11455. ((equal ans ?D)
  11456. (call-interactively 'org-check-dates-range))
  11457. ((equal ans ?t)
  11458. (org-show-todo-tree nil))
  11459. ((equal ans ?T)
  11460. (org-show-todo-tree '(4)))
  11461. ((member ans '(?T ?m))
  11462. (call-interactively 'org-match-sparse-tree))
  11463. ((member ans '(?p ?P))
  11464. (setq kwd (org-icompleting-read "Property: "
  11465. (mapcar 'list (org-buffer-property-keys))))
  11466. (setq value (org-icompleting-read "Value: "
  11467. (mapcar 'list (org-property-values kwd))))
  11468. (unless (string-match "\\`{.*}\\'" value)
  11469. (setq value (concat "\"" value "\"")))
  11470. (org-match-sparse-tree arg (concat kwd "=" value)))
  11471. ((member ans '(?r ?R ?/))
  11472. (call-interactively 'org-occur))
  11473. (t (error "No such sparse tree command \"%c\"" ans)))))
  11474. (defvar org-occur-highlights nil
  11475. "List of overlays used for occur matches.")
  11476. (make-variable-buffer-local 'org-occur-highlights)
  11477. (defvar org-occur-parameters nil
  11478. "Parameters of the active org-occur calls.
  11479. This is a list, each call to org-occur pushes as cons cell,
  11480. containing the regular expression and the callback, onto the list.
  11481. The list can contain several entries if `org-occur' has been called
  11482. several time with the KEEP-PREVIOUS argument. Otherwise, this list
  11483. will only contain one set of parameters. When the highlights are
  11484. removed (for example with `C-c C-c', or with the next edit (depending
  11485. on `org-remove-highlights-with-change'), this variable is emptied
  11486. as well.")
  11487. (make-variable-buffer-local 'org-occur-parameters)
  11488. (defun org-occur (regexp &optional keep-previous callback)
  11489. "Make a compact tree which shows all matches of REGEXP.
  11490. The tree will show the lines where the regexp matches, and all higher
  11491. headlines above the match. It will also show the heading after the match,
  11492. to make sure editing the matching entry is easy.
  11493. If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
  11494. call to `org-occur' will be kept, to allow stacking of calls to this
  11495. command.
  11496. If CALLBACK is non-nil, it is a function which is called to confirm
  11497. that the match should indeed be shown."
  11498. (interactive "sRegexp: \nP")
  11499. (when (equal regexp "")
  11500. (error "Regexp cannot be empty"))
  11501. (unless keep-previous
  11502. (org-remove-occur-highlights nil nil t))
  11503. (push (cons regexp callback) org-occur-parameters)
  11504. (let ((cnt 0))
  11505. (save-excursion
  11506. (goto-char (point-min))
  11507. (if (or (not keep-previous) ; do not want to keep
  11508. (not org-occur-highlights)) ; no previous matches
  11509. ;; hide everything
  11510. (org-overview))
  11511. (while (re-search-forward regexp nil t)
  11512. (when (or (not callback)
  11513. (save-match-data (funcall callback)))
  11514. (setq cnt (1+ cnt))
  11515. (when org-highlight-sparse-tree-matches
  11516. (org-highlight-new-match (match-beginning 0) (match-end 0)))
  11517. (org-show-context 'occur-tree))))
  11518. (when org-remove-highlights-with-change
  11519. (org-add-hook 'before-change-functions 'org-remove-occur-highlights
  11520. nil 'local))
  11521. (unless org-sparse-tree-open-archived-trees
  11522. (org-hide-archived-subtrees (point-min) (point-max)))
  11523. (run-hooks 'org-occur-hook)
  11524. (if (org-called-interactively-p 'interactive)
  11525. (message "%d match(es) for regexp %s" cnt regexp))
  11526. cnt))
  11527. (defun org-occur-next-match (&optional n reset)
  11528. "Function for `next-error-function' to find sparse tree matches.
  11529. N is the number of matches to move, when negative move backwards.
  11530. RESET is entirely ignored - this function always goes back to the
  11531. starting point when no match is found."
  11532. (let* ((limit (if (< n 0) (point-min) (point-max)))
  11533. (search-func (if (< n 0)
  11534. 'previous-single-char-property-change
  11535. 'next-single-char-property-change))
  11536. (n (abs n))
  11537. (pos (point))
  11538. p1)
  11539. (catch 'exit
  11540. (while (setq p1 (funcall search-func (point) 'org-type))
  11541. (when (equal p1 limit)
  11542. (goto-char pos)
  11543. (error "No more matches"))
  11544. (when (equal (get-char-property p1 'org-type) 'org-occur)
  11545. (setq n (1- n))
  11546. (when (= n 0)
  11547. (goto-char p1)
  11548. (throw 'exit (point))))
  11549. (goto-char p1))
  11550. (goto-char p1)
  11551. (error "No more matches"))))
  11552. (defun org-show-context (&optional key)
  11553. "Make sure point and context are visible.
  11554. How much context is shown depends upon the variables
  11555. `org-show-hierarchy-above', `org-show-following-heading',
  11556. `org-show-entry-below' and `org-show-siblings'."
  11557. (let ((heading-p (org-at-heading-p t))
  11558. (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
  11559. (following-p (org-get-alist-option org-show-following-heading key))
  11560. (entry-p (org-get-alist-option org-show-entry-below key))
  11561. (siblings-p (org-get-alist-option org-show-siblings key)))
  11562. (catch 'exit
  11563. ;; Show heading or entry text
  11564. (if (and heading-p (not entry-p))
  11565. (org-flag-heading nil) ; only show the heading
  11566. (and (or entry-p (outline-invisible-p) (org-invisible-p2))
  11567. (org-show-hidden-entry))) ; show entire entry
  11568. (when following-p
  11569. ;; Show next sibling, or heading below text
  11570. (save-excursion
  11571. (and (if heading-p (org-goto-sibling) (outline-next-heading))
  11572. (org-flag-heading nil))))
  11573. (when siblings-p (org-show-siblings))
  11574. (when hierarchy-p
  11575. ;; show all higher headings, possibly with siblings
  11576. (save-excursion
  11577. (while (and (condition-case nil
  11578. (progn (org-up-heading-all 1) t)
  11579. (error nil))
  11580. (not (bobp)))
  11581. (org-flag-heading nil)
  11582. (when siblings-p (org-show-siblings))))))))
  11583. (defvar org-reveal-start-hook nil
  11584. "Hook run before revealing a location.")
  11585. (defun org-reveal (&optional siblings)
  11586. "Show current entry, hierarchy above it, and the following headline.
  11587. This can be used to show a consistent set of context around locations
  11588. exposed with `org-show-hierarchy-above' or `org-show-following-heading'
  11589. not t for the search context.
  11590. With optional argument SIBLINGS, on each level of the hierarchy all
  11591. siblings are shown. This repairs the tree structure to what it would
  11592. look like when opened with hierarchical calls to `org-cycle'.
  11593. With double optional argument \\[universal-argument] \\[universal-argument], \
  11594. go to the parent and show the
  11595. entire tree."
  11596. (interactive "P")
  11597. (run-hooks 'org-reveal-start-hook)
  11598. (let ((org-show-hierarchy-above t)
  11599. (org-show-following-heading t)
  11600. (org-show-siblings (if siblings t org-show-siblings)))
  11601. (org-show-context nil))
  11602. (when (equal siblings '(16))
  11603. (save-excursion
  11604. (when (org-up-heading-safe)
  11605. (org-show-subtree)
  11606. (run-hook-with-args 'org-cycle-hook 'subtree)))))
  11607. (defun org-highlight-new-match (beg end)
  11608. "Highlight from BEG to END and mark the highlight is an occur headline."
  11609. (let ((ov (make-overlay beg end)))
  11610. (overlay-put ov 'face 'secondary-selection)
  11611. (overlay-put ov 'org-type 'org-occur)
  11612. (push ov org-occur-highlights)))
  11613. (defun org-remove-occur-highlights (&optional beg end noremove)
  11614. "Remove the occur highlights from the buffer.
  11615. BEG and END are ignored. If NOREMOVE is nil, remove this function
  11616. from the `before-change-functions' in the current buffer."
  11617. (interactive)
  11618. (unless org-inhibit-highlight-removal
  11619. (mapc 'delete-overlay org-occur-highlights)
  11620. (setq org-occur-highlights nil)
  11621. (setq org-occur-parameters nil)
  11622. (unless noremove
  11623. (remove-hook 'before-change-functions
  11624. 'org-remove-occur-highlights 'local))))
  11625. ;;;; Priorities
  11626. (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
  11627. "Regular expression matching the priority indicator.")
  11628. (defvar org-remove-priority-next-time nil)
  11629. (defun org-priority-up ()
  11630. "Increase the priority of the current item."
  11631. (interactive)
  11632. (org-priority 'up))
  11633. (defun org-priority-down ()
  11634. "Decrease the priority of the current item."
  11635. (interactive)
  11636. (org-priority 'down))
  11637. (defun org-priority (&optional action)
  11638. "Change the priority of an item by ARG.
  11639. ACTION can be `set', `up', `down', or a character."
  11640. (interactive)
  11641. (unless org-enable-priority-commands
  11642. (error "Priority commands are disabled"))
  11643. (setq action (or action 'set))
  11644. (let (current new news have remove)
  11645. (save-excursion
  11646. (org-back-to-heading t)
  11647. (if (looking-at org-priority-regexp)
  11648. (setq current (string-to-char (match-string 2))
  11649. have t))
  11650. (cond
  11651. ((eq action 'remove)
  11652. (setq remove t new ?\ ))
  11653. ((or (eq action 'set)
  11654. (if (featurep 'xemacs) (characterp action) (integerp action)))
  11655. (if (not (eq action 'set))
  11656. (setq new action)
  11657. (message "Priority %c-%c, SPC to remove: "
  11658. org-highest-priority org-lowest-priority)
  11659. (save-match-data
  11660. (setq new (read-char-exclusive))))
  11661. (if (and (= (upcase org-highest-priority) org-highest-priority)
  11662. (= (upcase org-lowest-priority) org-lowest-priority))
  11663. (setq new (upcase new)))
  11664. (cond ((equal new ?\ ) (setq remove t))
  11665. ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
  11666. (error "Priority must be between `%c' and `%c'"
  11667. org-highest-priority org-lowest-priority))))
  11668. ((eq action 'up)
  11669. (setq new (if have
  11670. (1- current) ; normal cycling
  11671. ;; last priority was empty
  11672. (if (eq last-command this-command)
  11673. org-lowest-priority ; wrap around empty to lowest
  11674. ;; default
  11675. (if org-priority-start-cycle-with-default
  11676. org-default-priority
  11677. (1- org-default-priority))))))
  11678. ((eq action 'down)
  11679. (setq new (if have
  11680. (1+ current) ; normal cycling
  11681. ;; last priority was empty
  11682. (if (eq last-command this-command)
  11683. org-highest-priority ; wrap around empty to highest
  11684. ;; default
  11685. (if org-priority-start-cycle-with-default
  11686. org-default-priority
  11687. (1+ org-default-priority))))))
  11688. (t (error "Invalid action")))
  11689. (if (or (< (upcase new) org-highest-priority)
  11690. (> (upcase new) org-lowest-priority))
  11691. (if (and (memq action '(up down))
  11692. (not have) (not (eq last-command this-command)))
  11693. ;; `new' is from default priority
  11694. (error
  11695. "The default can not be set, see `org-default-priority' why")
  11696. ;; normal cycling: `new' is beyond highest/lowest priority
  11697. ;; and is wrapped around to the empty priority
  11698. (setq remove t)))
  11699. (setq news (format "%c" new))
  11700. (if have
  11701. (if remove
  11702. (replace-match "" t t nil 1)
  11703. (replace-match news t t nil 2))
  11704. (if remove
  11705. (error "No priority cookie found in line")
  11706. (let ((case-fold-search nil))
  11707. (looking-at org-todo-line-regexp))
  11708. (if (match-end 2)
  11709. (progn
  11710. (goto-char (match-end 2))
  11711. (insert " [#" news "]"))
  11712. (goto-char (match-beginning 3))
  11713. (insert "[#" news "] "))))
  11714. (org-preserve-lc (org-set-tags nil 'align)))
  11715. (if remove
  11716. (message "Priority removed")
  11717. (message "Priority of current item set to %s" news))))
  11718. (defun org-get-priority (s)
  11719. "Find priority cookie and return priority."
  11720. (if (functionp org-get-priority-function)
  11721. (funcall org-get-priority-function)
  11722. (save-match-data
  11723. (if (not (string-match org-priority-regexp s))
  11724. (* 1000 (- org-lowest-priority org-default-priority))
  11725. (* 1000 (- org-lowest-priority
  11726. (string-to-char (match-string 2 s))))))))
  11727. ;;;; Tags
  11728. (defvar org-agenda-archives-mode)
  11729. (defvar org-map-continue-from nil
  11730. "Position from where mapping should continue.
  11731. Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
  11732. (defvar org-scanner-tags nil
  11733. "The current tag list while the tags scanner is running.")
  11734. (defvar org-trust-scanner-tags nil
  11735. "Should `org-get-tags-at' use the tags for the scanner.
  11736. This is for internal dynamical scoping only.
  11737. When this is non-nil, the function `org-get-tags-at' will return the value
  11738. of `org-scanner-tags' instead of building the list by itself. This
  11739. can lead to large speed-ups when the tags scanner is used in a file with
  11740. many entries, and when the list of tags is retrieved, for example to
  11741. obtain a list of properties. Building the tags list for each entry in such
  11742. a file becomes an N^2 operation - but with this variable set, it scales
  11743. as N.")
  11744. (defun org-scan-tags (action matcher todo-only &optional start-level)
  11745. "Scan headline tags with inheritance and produce output ACTION.
  11746. ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
  11747. or `agenda' to produce an entry list for an agenda view. It can also be
  11748. a Lisp form or a function that should be called at each matched headline, in
  11749. this case the return value is a list of all return values from these calls.
  11750. MATCHER is a Lisp form to be evaluated, testing if a given set of tags
  11751. qualifies a headline for inclusion. When TODO-ONLY is non-nil,
  11752. only lines with a not-done TODO keyword are included in the output.
  11753. This should be the same variable that was scoped into
  11754. and set by `org-make-tags-matcher' when it constructed MATCHER.
  11755. START-LEVEL can be a string with asterisks, reducing the scope to
  11756. headlines matching this string."
  11757. (require 'org-agenda)
  11758. (let* ((re (concat "^"
  11759. (if start-level
  11760. ;; Get the correct level to match
  11761. (concat "\\*\\{" (number-to-string start-level) "\\} ")
  11762. org-outline-regexp)
  11763. " *\\(\\<\\("
  11764. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  11765. (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
  11766. (props (list 'face 'default
  11767. 'done-face 'org-agenda-done
  11768. 'undone-face 'default
  11769. 'mouse-face 'highlight
  11770. 'org-not-done-regexp org-not-done-regexp
  11771. 'org-todo-regexp org-todo-regexp
  11772. 'org-complex-heading-regexp org-complex-heading-regexp
  11773. 'help-echo
  11774. (format "mouse-2 or RET jump to org file %s"
  11775. (abbreviate-file-name
  11776. (or (buffer-file-name (buffer-base-buffer))
  11777. (buffer-name (buffer-base-buffer)))))))
  11778. (case-fold-search nil)
  11779. (org-map-continue-from nil)
  11780. lspos tags tags-list
  11781. (tags-alist (list (cons 0 org-file-tags)))
  11782. (llast 0) rtn rtn1 level category i txt
  11783. todo marker entry priority)
  11784. (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
  11785. (setq action (list 'lambda nil action)))
  11786. (save-excursion
  11787. (goto-char (point-min))
  11788. (when (eq action 'sparse-tree)
  11789. (org-overview)
  11790. (org-remove-occur-highlights))
  11791. (while (re-search-forward re nil t)
  11792. (setq org-map-continue-from nil)
  11793. (catch :skip
  11794. (setq todo (if (match-end 1) (org-match-string-no-properties 2))
  11795. tags (if (match-end 4) (org-match-string-no-properties 4)))
  11796. (goto-char (setq lspos (match-beginning 0)))
  11797. (setq level (org-reduced-level (funcall outline-level))
  11798. category (org-get-category))
  11799. (setq i llast llast level)
  11800. ;; remove tag lists from same and sublevels
  11801. (while (>= i level)
  11802. (when (setq entry (assoc i tags-alist))
  11803. (setq tags-alist (delete entry tags-alist)))
  11804. (setq i (1- i)))
  11805. ;; add the next tags
  11806. (when tags
  11807. (setq tags (org-split-string tags ":")
  11808. tags-alist
  11809. (cons (cons level tags) tags-alist)))
  11810. ;; compile tags for current headline
  11811. (setq tags-list
  11812. (if org-use-tag-inheritance
  11813. (apply 'append (mapcar 'cdr (reverse tags-alist)))
  11814. tags)
  11815. org-scanner-tags tags-list)
  11816. (when org-use-tag-inheritance
  11817. (setcdr (car tags-alist)
  11818. (mapcar (lambda (x)
  11819. (setq x (copy-sequence x))
  11820. (org-add-prop-inherited x))
  11821. (cdar tags-alist))))
  11822. (when (and tags org-use-tag-inheritance
  11823. (or (not (eq t org-use-tag-inheritance))
  11824. org-tags-exclude-from-inheritance))
  11825. ;; selective inheritance, remove uninherited ones
  11826. (setcdr (car tags-alist)
  11827. (org-remove-uninherited-tags (cdar tags-alist))))
  11828. (when (and
  11829. ;; eval matcher only when the todo condition is OK
  11830. (and (or (not todo-only) (member todo org-not-done-keywords))
  11831. (let ((case-fold-search t) (org-trust-scanner-tags t))
  11832. (eval matcher)))
  11833. ;; Call the skipper, but return t if it does not skip,
  11834. ;; so that the `and' form continues evaluating
  11835. (progn
  11836. (unless (eq action 'sparse-tree) (org-agenda-skip))
  11837. t)
  11838. ;; Check if timestamps are deselecting this entry
  11839. (or (not todo-only)
  11840. (and (member todo org-not-done-keywords)
  11841. (or (not org-agenda-tags-todo-honor-ignore-options)
  11842. (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
  11843. ;; Extra check for the archive tag
  11844. ;; FIXME: Does the skipper already do this????
  11845. (or
  11846. (not (member org-archive-tag tags-list))
  11847. ;; we have an archive tag, should we use this anyway?
  11848. (or (not org-agenda-skip-archived-trees)
  11849. (and (eq action 'agenda) org-agenda-archives-mode))))
  11850. ;; select this headline
  11851. (cond
  11852. ((eq action 'sparse-tree)
  11853. (and org-highlight-sparse-tree-matches
  11854. (org-get-heading) (match-end 0)
  11855. (org-highlight-new-match
  11856. (match-beginning 1) (match-end 1)))
  11857. (org-show-context 'tags-tree))
  11858. ((eq action 'agenda)
  11859. (setq txt (org-agenda-format-item
  11860. ""
  11861. (concat
  11862. (if (eq org-tags-match-list-sublevels 'indented)
  11863. (make-string (1- level) ?.) "")
  11864. (org-get-heading))
  11865. category
  11866. tags-list)
  11867. priority (org-get-priority txt))
  11868. (goto-char lspos)
  11869. (setq marker (org-agenda-new-marker))
  11870. (org-add-props txt props
  11871. 'org-marker marker 'org-hd-marker marker 'org-category category
  11872. 'todo-state todo
  11873. 'priority priority 'type "tagsmatch")
  11874. (push txt rtn))
  11875. ((functionp action)
  11876. (setq org-map-continue-from nil)
  11877. (save-excursion
  11878. (setq rtn1 (funcall action))
  11879. (push rtn1 rtn)))
  11880. (t (error "Invalid action")))
  11881. ;; if we are to skip sublevels, jump to end of subtree
  11882. (unless org-tags-match-list-sublevels
  11883. (org-end-of-subtree t)
  11884. (backward-char 1))))
  11885. ;; Get the correct position from where to continue
  11886. (if org-map-continue-from
  11887. (goto-char org-map-continue-from)
  11888. (and (= (point) lspos) (end-of-line 1)))))
  11889. (when (and (eq action 'sparse-tree)
  11890. (not org-sparse-tree-open-archived-trees))
  11891. (org-hide-archived-subtrees (point-min) (point-max)))
  11892. (nreverse rtn)))
  11893. (defun org-remove-uninherited-tags (tags)
  11894. "Remove all tags that are not inherited from the list TAGS."
  11895. (cond
  11896. ((eq org-use-tag-inheritance t)
  11897. (if org-tags-exclude-from-inheritance
  11898. (org-delete-all org-tags-exclude-from-inheritance tags)
  11899. tags))
  11900. ((not org-use-tag-inheritance) nil)
  11901. ((stringp org-use-tag-inheritance)
  11902. (delq nil (mapcar
  11903. (lambda (x)
  11904. (if (and (string-match org-use-tag-inheritance x)
  11905. (not (member x org-tags-exclude-from-inheritance)))
  11906. x nil))
  11907. tags)))
  11908. ((listp org-use-tag-inheritance)
  11909. (delq nil (mapcar
  11910. (lambda (x)
  11911. (if (member x org-use-tag-inheritance) x nil))
  11912. tags)))))
  11913. (defun org-match-sparse-tree (&optional todo-only match)
  11914. "Create a sparse tree according to tags string MATCH.
  11915. MATCH can contain positive and negative selection of tags, like
  11916. \"+WORK+URGENT-WITHBOSS\".
  11917. If optional argument TODO-ONLY is non-nil, only select lines that are
  11918. also TODO lines."
  11919. (interactive "P")
  11920. (org-prepare-agenda-buffers (list (current-buffer)))
  11921. (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
  11922. (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
  11923. (defvar org-cached-props nil)
  11924. (defun org-cached-entry-get (pom property)
  11925. (if (or (eq t org-use-property-inheritance)
  11926. (and (stringp org-use-property-inheritance)
  11927. (string-match org-use-property-inheritance property))
  11928. (and (listp org-use-property-inheritance)
  11929. (member property org-use-property-inheritance)))
  11930. ;; Caching is not possible, check it directly
  11931. (org-entry-get pom property 'inherit)
  11932. ;; Get all properties, so that we can do complicated checks easily
  11933. (cdr (assoc property (or org-cached-props
  11934. (setq org-cached-props
  11935. (org-entry-properties pom)))))))
  11936. (defun org-global-tags-completion-table (&optional files)
  11937. "Return the list of all tags in all agenda buffer/files.
  11938. Optional FILES argument is a list of files to which can be used
  11939. instead of the agenda files."
  11940. (save-excursion
  11941. (org-uniquify
  11942. (delq nil
  11943. (apply 'append
  11944. (mapcar
  11945. (lambda (file)
  11946. (set-buffer (find-file-noselect file))
  11947. (append (org-get-buffer-tags)
  11948. (mapcar (lambda (x) (if (stringp (car-safe x))
  11949. (list (car-safe x)) nil))
  11950. org-tag-alist)))
  11951. (if (and files (car files))
  11952. files
  11953. (org-agenda-files))))))))
  11954. (defun org-make-tags-matcher (match)
  11955. "Create the TAGS/TODO matcher form for the selection string MATCH.
  11956. The variable `todo-only' is scoped dynamically into this function; it will be
  11957. set to t if the matcher restricts matching to TODO entries,
  11958. otherwise will not be touched.
  11959. Returns a cons of the selection string MATCH and the constructed
  11960. lisp form implementing the matcher. The matcher is to be
  11961. evaluated at an Org entry, with point on the headline,
  11962. and returns t if the entry matches the
  11963. selection string MATCH. The returned lisp form references
  11964. two variables with information about the entry, which must be
  11965. bound around the form's evaluation: todo, the TODO keyword at the
  11966. entry (or nil of none); and tags-list, the list of all tags at the
  11967. entry including inherited ones. Additionally, the category
  11968. of the entry (if any) must be specified as the text property
  11969. 'org-category on the headline.
  11970. See also `org-scan-tags'.
  11971. "
  11972. (declare (special todo-only))
  11973. (unless (boundp 'todo-only)
  11974. (error "org-make-tags-matcher expects todo-only to be scoped in"))
  11975. (unless match
  11976. ;; Get a new match request, with completion
  11977. (let ((org-last-tags-completion-table
  11978. (org-global-tags-completion-table)))
  11979. (setq match (org-completing-read-no-i
  11980. "Match: " 'org-tags-completion-function nil nil nil
  11981. 'org-tags-history))))
  11982. ;; Parse the string and create a lisp form
  11983. (let ((match0 match)
  11984. (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
  11985. minus tag mm
  11986. tagsmatch todomatch tagsmatcher todomatcher kwd matcher
  11987. orterms term orlist re-p str-p level-p level-op time-p
  11988. prop-p pn pv po gv rest)
  11989. (if (string-match "/+" match)
  11990. ;; match contains also a todo-matching request
  11991. (progn
  11992. (setq tagsmatch (substring match 0 (match-beginning 0))
  11993. todomatch (substring match (match-end 0)))
  11994. (if (string-match "^!" todomatch)
  11995. (setq todo-only t todomatch (substring todomatch 1)))
  11996. (if (string-match "^\\s-*$" todomatch)
  11997. (setq todomatch nil)))
  11998. ;; only matching tags
  11999. (setq tagsmatch match todomatch nil))
  12000. ;; Make the tags matcher
  12001. (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
  12002. (setq tagsmatcher t)
  12003. (setq orterms (org-split-string tagsmatch "|") orlist nil)
  12004. (while (setq term (pop orterms))
  12005. (while (and (equal (substring term -1) "\\") orterms)
  12006. (setq term (concat term "|" (pop orterms)))) ; repair bad split
  12007. (while (string-match re term)
  12008. (setq rest (substring term (match-end 0))
  12009. minus (and (match-end 1)
  12010. (equal (match-string 1 term) "-"))
  12011. tag (save-match-data (replace-regexp-in-string
  12012. "\\\\-" "-"
  12013. (match-string 2 term)))
  12014. re-p (equal (string-to-char tag) ?{)
  12015. level-p (match-end 4)
  12016. prop-p (match-end 5)
  12017. mm (cond
  12018. (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
  12019. (level-p
  12020. (setq level-op (org-op-to-function (match-string 3 term)))
  12021. `(,level-op level ,(string-to-number
  12022. (match-string 4 term))))
  12023. (prop-p
  12024. (setq pn (match-string 5 term)
  12025. po (match-string 6 term)
  12026. pv (match-string 7 term)
  12027. re-p (equal (string-to-char pv) ?{)
  12028. str-p (equal (string-to-char pv) ?\")
  12029. time-p (save-match-data
  12030. (string-match "^\"[[<].*[]>]\"$" pv))
  12031. pv (if (or re-p str-p) (substring pv 1 -1) pv))
  12032. (if time-p (setq pv (org-matcher-time pv)))
  12033. (setq po (org-op-to-function po (if time-p 'time str-p)))
  12034. (cond
  12035. ((equal pn "CATEGORY")
  12036. (setq gv '(get-text-property (point) 'org-category)))
  12037. ((equal pn "TODO")
  12038. (setq gv 'todo))
  12039. (t
  12040. (setq gv `(org-cached-entry-get nil ,pn))))
  12041. (if re-p
  12042. (if (eq po 'org<>)
  12043. `(not (string-match ,pv (or ,gv "")))
  12044. `(string-match ,pv (or ,gv "")))
  12045. (if str-p
  12046. `(,po (or ,gv "") ,pv)
  12047. `(,po (string-to-number (or ,gv ""))
  12048. ,(string-to-number pv) ))))
  12049. (t `(member ,tag tags-list)))
  12050. mm (if minus (list 'not mm) mm)
  12051. term rest)
  12052. (push mm tagsmatcher))
  12053. (push (if (> (length tagsmatcher) 1)
  12054. (cons 'and tagsmatcher)
  12055. (car tagsmatcher))
  12056. orlist)
  12057. (setq tagsmatcher nil))
  12058. (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
  12059. (setq tagsmatcher
  12060. (list 'progn '(setq org-cached-props nil) tagsmatcher)))
  12061. ;; Make the todo matcher
  12062. (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
  12063. (setq todomatcher t)
  12064. (setq orterms (org-split-string todomatch "|") orlist nil)
  12065. (while (setq term (pop orterms))
  12066. (while (string-match re term)
  12067. (setq minus (and (match-end 1)
  12068. (equal (match-string 1 term) "-"))
  12069. kwd (match-string 2 term)
  12070. re-p (equal (string-to-char kwd) ?{)
  12071. term (substring term (match-end 0))
  12072. mm (if re-p
  12073. `(string-match ,(substring kwd 1 -1) todo)
  12074. (list 'equal 'todo kwd))
  12075. mm (if minus (list 'not mm) mm))
  12076. (push mm todomatcher))
  12077. (push (if (> (length todomatcher) 1)
  12078. (cons 'and todomatcher)
  12079. (car todomatcher))
  12080. orlist)
  12081. (setq todomatcher nil))
  12082. (setq todomatcher (if (> (length orlist) 1)
  12083. (cons 'or orlist) (car orlist))))
  12084. ;; Return the string and lisp forms of the matcher
  12085. (setq matcher (if todomatcher
  12086. (list 'and tagsmatcher todomatcher)
  12087. tagsmatcher))
  12088. (when todo-only
  12089. (setq matcher (list 'and '(member todo org-not-done-keywords)
  12090. matcher)))
  12091. (cons match0 matcher)))
  12092. (defun org-op-to-function (op &optional stringp)
  12093. "Turn an operator into the appropriate function."
  12094. (setq op
  12095. (cond
  12096. ((equal op "<" ) '(< string< org-time<))
  12097. ((equal op ">" ) '(> org-string> org-time>))
  12098. ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
  12099. ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
  12100. ((member op '("=" "==")) '(= string= org-time=))
  12101. ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
  12102. (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
  12103. (defun org<> (a b) (not (= a b)))
  12104. (defun org-string<= (a b) (or (string= a b) (string< a b)))
  12105. (defun org-string>= (a b) (not (string< a b)))
  12106. (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
  12107. (defun org-string<> (a b) (not (string= a b)))
  12108. (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
  12109. (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
  12110. (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
  12111. (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
  12112. (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
  12113. (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
  12114. (defun org-2ft (s)
  12115. "Convert S to a floating point time.
  12116. If S is already a number, just return it. If it is a string, parse
  12117. it as a time string and apply `float-time' to it. If S is nil, just return 0."
  12118. (cond
  12119. ((numberp s) s)
  12120. ((stringp s)
  12121. (condition-case nil
  12122. (float-time (apply 'encode-time (org-parse-time-string s)))
  12123. (error 0.)))
  12124. (t 0.)))
  12125. (defun org-time-today ()
  12126. "Time in seconds today at 0:00.
  12127. Returns the float number of seconds since the beginning of the
  12128. epoch to the beginning of today (00:00)."
  12129. (float-time (apply 'encode-time
  12130. (append '(0 0 0) (nthcdr 3 (decode-time))))))
  12131. (defun org-matcher-time (s)
  12132. "Interpret a time comparison value."
  12133. (save-match-data
  12134. (cond
  12135. ((string= s "<now>") (float-time))
  12136. ((string= s "<today>") (org-time-today))
  12137. ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
  12138. ((string= s "<yesterday>") (- (org-time-today) 86400.0))
  12139. ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
  12140. (+ (org-time-today)
  12141. (* (string-to-number (match-string 1 s))
  12142. (cdr (assoc (match-string 2 s)
  12143. '(("d" . 86400.0) ("w" . 604800.0)
  12144. ("m" . 2678400.0) ("y" . 31557600.0)))))))
  12145. (t (org-2ft s)))))
  12146. (defun org-match-any-p (re list)
  12147. "Does re match any element of list?"
  12148. (setq list (mapcar (lambda (x) (string-match re x)) list))
  12149. (delq nil list))
  12150. (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
  12151. (defvar org-tags-overlay (make-overlay 1 1))
  12152. (org-detach-overlay org-tags-overlay)
  12153. (defun org-get-local-tags-at (&optional pos)
  12154. "Get a list of tags defined in the current headline."
  12155. (org-get-tags-at pos 'local))
  12156. (defun org-get-local-tags ()
  12157. "Get a list of tags defined in the current headline."
  12158. (org-get-tags-at nil 'local))
  12159. (defun org-get-tags-at (&optional pos local)
  12160. "Get a list of all headline tags applicable at POS.
  12161. POS defaults to point. If tags are inherited, the list contains
  12162. the targets in the same sequence as the headlines appear, i.e.
  12163. the tags of the current headline come last.
  12164. When LOCAL is non-nil, only return tags from the current headline,
  12165. ignore inherited ones."
  12166. (interactive)
  12167. (if (and org-trust-scanner-tags
  12168. (or (not pos) (equal pos (point)))
  12169. (not local))
  12170. org-scanner-tags
  12171. (let (tags ltags lastpos parent)
  12172. (save-excursion
  12173. (save-restriction
  12174. (widen)
  12175. (goto-char (or pos (point)))
  12176. (save-match-data
  12177. (catch 'done
  12178. (condition-case nil
  12179. (progn
  12180. (org-back-to-heading t)
  12181. (while (not (equal lastpos (point)))
  12182. (setq lastpos (point))
  12183. (when (looking-at
  12184. (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
  12185. (setq ltags (org-split-string
  12186. (org-match-string-no-properties 1) ":"))
  12187. (when parent
  12188. (setq ltags (mapcar 'org-add-prop-inherited ltags)))
  12189. (setq tags (append
  12190. (if parent
  12191. (org-remove-uninherited-tags ltags)
  12192. ltags)
  12193. tags)))
  12194. (or org-use-tag-inheritance (throw 'done t))
  12195. (if local (throw 'done t))
  12196. (or (org-up-heading-safe) (error nil))
  12197. (setq parent t)))
  12198. (error nil)))))
  12199. (if local
  12200. tags
  12201. (append (org-remove-uninherited-tags org-file-tags) tags))))))
  12202. (defun org-add-prop-inherited (s)
  12203. (add-text-properties 0 (length s) '(inherited t) s)
  12204. s)
  12205. (defun org-toggle-tag (tag &optional onoff)
  12206. "Toggle the tag TAG for the current line.
  12207. If ONOFF is `on' or `off', don't toggle but set to this state."
  12208. (let (res current)
  12209. (save-excursion
  12210. (org-back-to-heading t)
  12211. (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
  12212. (point-at-eol) t)
  12213. (progn
  12214. (setq current (match-string 1))
  12215. (replace-match ""))
  12216. (setq current ""))
  12217. (setq current (nreverse (org-split-string current ":")))
  12218. (cond
  12219. ((eq onoff 'on)
  12220. (setq res t)
  12221. (or (member tag current) (push tag current)))
  12222. ((eq onoff 'off)
  12223. (or (not (member tag current)) (setq current (delete tag current))))
  12224. (t (if (member tag current)
  12225. (setq current (delete tag current))
  12226. (setq res t)
  12227. (push tag current))))
  12228. (end-of-line 1)
  12229. (if current
  12230. (progn
  12231. (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
  12232. (org-set-tags nil t))
  12233. (delete-horizontal-space))
  12234. (run-hooks 'org-after-tags-change-hook))
  12235. res))
  12236. (defun org-align-tags-here (to-col)
  12237. ;; Assumes that this is a headline
  12238. (let ((pos (point)) (col (current-column)) ncol tags-l p)
  12239. (beginning-of-line 1)
  12240. (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12241. (< pos (match-beginning 2)))
  12242. (progn
  12243. (setq tags-l (- (match-end 2) (match-beginning 2)))
  12244. (goto-char (match-beginning 1))
  12245. (insert " ")
  12246. (delete-region (point) (1+ (match-beginning 2)))
  12247. (setq ncol (max (current-column)
  12248. (1+ col)
  12249. (if (> to-col 0)
  12250. to-col
  12251. (- (abs to-col) tags-l))))
  12252. (setq p (point))
  12253. (insert (make-string (- ncol (current-column)) ?\ ))
  12254. (setq ncol (current-column))
  12255. (when indent-tabs-mode (tabify p (point-at-eol)))
  12256. (org-move-to-column (min ncol col) t))
  12257. (goto-char pos))))
  12258. (defun org-set-tags-command (&optional arg just-align)
  12259. "Call the set-tags command for the current entry."
  12260. (interactive "P")
  12261. (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
  12262. (org-set-tags arg just-align)
  12263. (save-excursion
  12264. (org-back-to-heading t)
  12265. (org-set-tags arg just-align))))
  12266. (defun org-set-tags-to (data)
  12267. "Set the tags of the current entry to DATA, replacing the current tags.
  12268. DATA may be a tags string like :aa:bb:cc:, or a list of tags.
  12269. If DATA is nil or the empty string, any tags will be removed."
  12270. (interactive "sTags: ")
  12271. (setq data
  12272. (cond
  12273. ((eq data nil) "")
  12274. ((equal data "") "")
  12275. ((stringp data)
  12276. (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
  12277. ":"))
  12278. ((listp data)
  12279. (concat ":" (mapconcat 'identity data ":") ":"))
  12280. (t nil)))
  12281. (when data
  12282. (save-excursion
  12283. (org-back-to-heading t)
  12284. (when (looking-at org-complex-heading-regexp)
  12285. (if (match-end 5)
  12286. (progn
  12287. (goto-char (match-beginning 5))
  12288. (insert data)
  12289. (delete-region (point) (point-at-eol))
  12290. (org-set-tags nil 'align))
  12291. (goto-char (point-at-eol))
  12292. (insert " " data)
  12293. (org-set-tags nil 'align)))
  12294. (beginning-of-line 1)
  12295. (if (looking-at ".*?\\([ \t]+\\)$")
  12296. (delete-region (match-beginning 1) (match-end 1))))))
  12297. (defun org-align-all-tags ()
  12298. "Align the tags i all headings."
  12299. (interactive)
  12300. (save-excursion
  12301. (or (ignore-errors (org-back-to-heading t))
  12302. (outline-next-heading))
  12303. (if (org-at-heading-p)
  12304. (org-set-tags t)
  12305. (message "No headings"))))
  12306. (defvar org-indent-indentation-per-level)
  12307. (defun org-set-tags (&optional arg just-align)
  12308. "Set the tags for the current headline.
  12309. With prefix ARG, realign all tags in headings in the current buffer."
  12310. (interactive "P")
  12311. (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
  12312. (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
  12313. 'region-start-level 'region))
  12314. org-loop-over-headlines-in-active-region)
  12315. (org-map-entries
  12316. ;; We don't use ARG and JUST-ALIGN here these args are not
  12317. ;; useful when looping over headlines
  12318. `(org-set-tags)
  12319. org-loop-over-headlines-in-active-region
  12320. cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
  12321. (let* ((re org-outline-regexp-bol)
  12322. (current (unless arg (org-get-tags-string)))
  12323. (col (current-column))
  12324. (org-setting-tags t)
  12325. table current-tags inherited-tags ; computed below when needed
  12326. tags p0 c0 c1 rpl di tc level)
  12327. (if arg
  12328. (save-excursion
  12329. (goto-char (point-min))
  12330. (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
  12331. (while (re-search-forward re nil t)
  12332. (org-set-tags nil t)
  12333. (end-of-line 1)))
  12334. (message "All tags realigned to column %d" org-tags-column))
  12335. (if just-align
  12336. (setq tags current)
  12337. ;; Get a new set of tags from the user
  12338. (save-excursion
  12339. (setq table (append org-tag-persistent-alist
  12340. (or org-tag-alist (org-get-buffer-tags))
  12341. (and
  12342. org-complete-tags-always-offer-all-agenda-tags
  12343. (org-global-tags-completion-table
  12344. (org-agenda-files))))
  12345. org-last-tags-completion-table table
  12346. current-tags (org-split-string current ":")
  12347. inherited-tags (nreverse
  12348. (nthcdr (length current-tags)
  12349. (nreverse (org-get-tags-at))))
  12350. tags
  12351. (if (or (eq t org-use-fast-tag-selection)
  12352. (and org-use-fast-tag-selection
  12353. (delq nil (mapcar 'cdr table))))
  12354. (org-fast-tag-selection
  12355. current-tags inherited-tags table
  12356. (if org-fast-tag-selection-include-todo
  12357. org-todo-key-alist))
  12358. (let ((org-add-colon-after-tag-completion (< 1 (length table))))
  12359. (org-trim
  12360. (org-icompleting-read "Tags: "
  12361. 'org-tags-completion-function
  12362. nil nil current 'org-tags-history))))))
  12363. (while (string-match "[-+&]+" tags)
  12364. ;; No boolean logic, just a list
  12365. (setq tags (replace-match ":" t t tags))))
  12366. (setq tags (replace-regexp-in-string "[,]" ":" tags))
  12367. (if org-tags-sort-function
  12368. (setq tags (mapconcat 'identity
  12369. (sort (org-split-string
  12370. tags (org-re "[^[:alnum:]_@#%]+"))
  12371. org-tags-sort-function) ":")))
  12372. (if (string-match "\\`[\t ]*\\'" tags)
  12373. (setq tags "")
  12374. (unless (string-match ":$" tags) (setq tags (concat tags ":")))
  12375. (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
  12376. ;; Insert new tags at the correct column
  12377. (beginning-of-line 1)
  12378. (setq level (or (and (looking-at org-outline-regexp)
  12379. (- (match-end 0) (point) 1))
  12380. 1))
  12381. (cond
  12382. ((and (equal current "") (equal tags "")))
  12383. ((re-search-forward
  12384. (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
  12385. (point-at-eol) t)
  12386. (if (equal tags "")
  12387. (setq rpl "")
  12388. (goto-char (match-beginning 0))
  12389. (setq c0 (current-column)
  12390. ;; compute offset for the case of org-indent-mode active
  12391. di (if org-indent-mode
  12392. (* (1- org-indent-indentation-per-level) (1- level))
  12393. 0)
  12394. p0 (if (equal (char-before) ?*) (1+ (point)) (point))
  12395. tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
  12396. c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
  12397. rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
  12398. (replace-match rpl t t)
  12399. (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
  12400. tags)
  12401. (t (error "Tags alignment failed")))
  12402. (org-move-to-column col)
  12403. (unless just-align
  12404. (run-hooks 'org-after-tags-change-hook))))))
  12405. (defun org-change-tag-in-region (beg end tag off)
  12406. "Add or remove TAG for each entry in the region.
  12407. This works in the agenda, and also in an org-mode buffer."
  12408. (interactive
  12409. (list (region-beginning) (region-end)
  12410. (let ((org-last-tags-completion-table
  12411. (if (derived-mode-p 'org-mode)
  12412. (org-get-buffer-tags)
  12413. (org-global-tags-completion-table))))
  12414. (org-icompleting-read
  12415. "Tag: " 'org-tags-completion-function nil nil nil
  12416. 'org-tags-history))
  12417. (progn
  12418. (message "[s]et or [r]emove? ")
  12419. (equal (read-char-exclusive) ?r))))
  12420. (if (fboundp 'deactivate-mark) (deactivate-mark))
  12421. (let ((agendap (equal major-mode 'org-agenda-mode))
  12422. l1 l2 m buf pos newhead (cnt 0))
  12423. (goto-char end)
  12424. (setq l2 (1- (org-current-line)))
  12425. (goto-char beg)
  12426. (setq l1 (org-current-line))
  12427. (loop for l from l1 to l2 do
  12428. (org-goto-line l)
  12429. (setq m (get-text-property (point) 'org-hd-marker))
  12430. (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
  12431. (and agendap m))
  12432. (setq buf (if agendap (marker-buffer m) (current-buffer))
  12433. pos (if agendap m (point)))
  12434. (with-current-buffer buf
  12435. (save-excursion
  12436. (save-restriction
  12437. (goto-char pos)
  12438. (setq cnt (1+ cnt))
  12439. (org-toggle-tag tag (if off 'off 'on))
  12440. (setq newhead (org-get-heading)))))
  12441. (and agendap (org-agenda-change-all-lines newhead m))))
  12442. (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
  12443. (defun org-tags-completion-function (string predicate &optional flag)
  12444. (let (s1 s2 rtn (ctable org-last-tags-completion-table)
  12445. (confirm (lambda (x) (stringp (car x)))))
  12446. (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
  12447. (setq s1 (match-string 1 string)
  12448. s2 (match-string 2 string))
  12449. (setq s1 "" s2 string))
  12450. (cond
  12451. ((eq flag nil)
  12452. ;; try completion
  12453. (setq rtn (try-completion s2 ctable confirm))
  12454. (if (stringp rtn)
  12455. (setq rtn
  12456. (concat s1 s2 (substring rtn (length s2))
  12457. (if (and org-add-colon-after-tag-completion
  12458. (assoc rtn ctable))
  12459. ":" ""))))
  12460. rtn)
  12461. ((eq flag t)
  12462. ;; all-completions
  12463. (all-completions s2 ctable confirm)
  12464. )
  12465. ((eq flag 'lambda)
  12466. ;; exact match?
  12467. (assoc s2 ctable)))
  12468. ))
  12469. (defun org-fast-tag-insert (kwd tags face &optional end)
  12470. "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
  12471. (insert (format "%-12s" (concat kwd ":"))
  12472. (org-add-props (mapconcat 'identity tags " ") nil 'face face)
  12473. (or end "")))
  12474. (defun org-fast-tag-show-exit (flag)
  12475. (save-excursion
  12476. (org-goto-line 3)
  12477. (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
  12478. (replace-match ""))
  12479. (when flag
  12480. (end-of-line 1)
  12481. (org-move-to-column (- (window-width) 19) t)
  12482. (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
  12483. (defun org-set-current-tags-overlay (current prefix)
  12484. (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
  12485. (if (featurep 'xemacs)
  12486. (org-overlay-display org-tags-overlay (concat prefix s)
  12487. 'secondary-selection)
  12488. (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
  12489. (org-overlay-display org-tags-overlay (concat prefix s)))))
  12490. (defvar org-last-tag-selection-key nil)
  12491. (defun org-fast-tag-selection (current inherited table &optional todo-table)
  12492. "Fast tag selection with single keys.
  12493. CURRENT is the current list of tags in the headline, INHERITED is the
  12494. list of inherited tags, and TABLE is an alist of tags and corresponding keys,
  12495. possibly with grouping information. TODO-TABLE is a similar table with
  12496. TODO keywords, should these have keys assigned to them.
  12497. If the keys are nil, a-z are automatically assigned.
  12498. Returns the new tags string, or nil to not change the current settings."
  12499. (let* ((fulltable (append table todo-table))
  12500. (maxlen (apply 'max (mapcar
  12501. (lambda (x)
  12502. (if (stringp (car x)) (string-width (car x)) 0))
  12503. fulltable)))
  12504. (buf (current-buffer))
  12505. (expert (eq org-fast-tag-selection-single-key 'expert))
  12506. (buffer-tags nil)
  12507. (fwidth (+ maxlen 3 1 3))
  12508. (ncol (/ (- (window-width) 4) fwidth))
  12509. (i-face 'org-done)
  12510. (c-face 'org-todo)
  12511. tg cnt e c char c1 c2 ntable tbl rtn
  12512. ov-start ov-end ov-prefix
  12513. (exit-after-next org-fast-tag-selection-single-key)
  12514. (done-keywords org-done-keywords)
  12515. groups ingroup)
  12516. (save-excursion
  12517. (beginning-of-line 1)
  12518. (if (looking-at
  12519. (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12520. (setq ov-start (match-beginning 1)
  12521. ov-end (match-end 1)
  12522. ov-prefix "")
  12523. (setq ov-start (1- (point-at-eol))
  12524. ov-end (1+ ov-start))
  12525. (skip-chars-forward "^\n\r")
  12526. (setq ov-prefix
  12527. (concat
  12528. (buffer-substring (1- (point)) (point))
  12529. (if (> (current-column) org-tags-column)
  12530. " "
  12531. (make-string (- org-tags-column (current-column)) ?\ ))))))
  12532. (move-overlay org-tags-overlay ov-start ov-end)
  12533. (save-window-excursion
  12534. (if expert
  12535. (set-buffer (get-buffer-create " *Org tags*"))
  12536. (delete-other-windows)
  12537. (split-window-vertically)
  12538. (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
  12539. (erase-buffer)
  12540. (org-set-local 'org-done-keywords done-keywords)
  12541. (org-fast-tag-insert "Inherited" inherited i-face "\n")
  12542. (org-fast-tag-insert "Current" current c-face "\n\n")
  12543. (org-fast-tag-show-exit exit-after-next)
  12544. (org-set-current-tags-overlay current ov-prefix)
  12545. (setq tbl fulltable char ?a cnt 0)
  12546. (while (setq e (pop tbl))
  12547. (cond
  12548. ((equal (car e) :startgroup)
  12549. (push '() groups) (setq ingroup t)
  12550. (when (not (= cnt 0))
  12551. (setq cnt 0)
  12552. (insert "\n"))
  12553. (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
  12554. ((equal (car e) :endgroup)
  12555. (setq ingroup nil cnt 0)
  12556. (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
  12557. ((equal e '(:newline))
  12558. (when (not (= cnt 0))
  12559. (setq cnt 0)
  12560. (insert "\n")
  12561. (setq e (car tbl))
  12562. (while (equal (car tbl) '(:newline))
  12563. (insert "\n")
  12564. (setq tbl (cdr tbl)))))
  12565. (t
  12566. (setq tg (copy-sequence (car e)) c2 nil)
  12567. (if (cdr e)
  12568. (setq c (cdr e))
  12569. ;; automatically assign a character.
  12570. (setq c1 (string-to-char
  12571. (downcase (substring
  12572. tg (if (= (string-to-char tg) ?@) 1 0)))))
  12573. (if (or (rassoc c1 ntable) (rassoc c1 table))
  12574. (while (or (rassoc char ntable) (rassoc char table))
  12575. (setq char (1+ char)))
  12576. (setq c2 c1))
  12577. (setq c (or c2 char)))
  12578. (if ingroup (push tg (car groups)))
  12579. (setq tg (org-add-props tg nil 'face
  12580. (cond
  12581. ((not (assoc tg table))
  12582. (org-get-todo-face tg))
  12583. ((member tg current) c-face)
  12584. ((member tg inherited) i-face)
  12585. (t nil))))
  12586. (if (and (= cnt 0) (not ingroup)) (insert " "))
  12587. (insert "[" c "] " tg (make-string
  12588. (- fwidth 4 (length tg)) ?\ ))
  12589. (push (cons tg c) ntable)
  12590. (when (= (setq cnt (1+ cnt)) ncol)
  12591. (insert "\n")
  12592. (if ingroup (insert " "))
  12593. (setq cnt 0)))))
  12594. (setq ntable (nreverse ntable))
  12595. (insert "\n")
  12596. (goto-char (point-min))
  12597. (if (not expert) (org-fit-window-to-buffer))
  12598. (setq rtn
  12599. (catch 'exit
  12600. (while t
  12601. (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
  12602. (if (not groups) "no " "")
  12603. (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
  12604. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  12605. (setq org-last-tag-selection-key c)
  12606. (cond
  12607. ((= c ?\r) (throw 'exit t))
  12608. ((= c ?!)
  12609. (setq groups (not groups))
  12610. (goto-char (point-min))
  12611. (while (re-search-forward "[{}]" nil t) (replace-match " ")))
  12612. ((= c ?\C-c)
  12613. (if (not expert)
  12614. (org-fast-tag-show-exit
  12615. (setq exit-after-next (not exit-after-next)))
  12616. (setq expert nil)
  12617. (delete-other-windows)
  12618. (set-window-buffer (split-window-vertically) " *Org tags*")
  12619. (org-switch-to-buffer-other-window " *Org tags*")
  12620. (org-fit-window-to-buffer)))
  12621. ((or (= c ?\C-g)
  12622. (and (= c ?q) (not (rassoc c ntable))))
  12623. (org-detach-overlay org-tags-overlay)
  12624. (setq quit-flag t))
  12625. ((= c ?\ )
  12626. (setq current nil)
  12627. (if exit-after-next (setq exit-after-next 'now)))
  12628. ((= c ?\t)
  12629. (condition-case nil
  12630. (setq tg (org-icompleting-read
  12631. "Tag: "
  12632. (or buffer-tags
  12633. (with-current-buffer buf
  12634. (org-get-buffer-tags)))))
  12635. (quit (setq tg "")))
  12636. (when (string-match "\\S-" tg)
  12637. (add-to-list 'buffer-tags (list tg))
  12638. (if (member tg current)
  12639. (setq current (delete tg current))
  12640. (push tg current)))
  12641. (if exit-after-next (setq exit-after-next 'now)))
  12642. ((setq e (rassoc c todo-table) tg (car e))
  12643. (with-current-buffer buf
  12644. (save-excursion (org-todo tg)))
  12645. (if exit-after-next (setq exit-after-next 'now)))
  12646. ((setq e (rassoc c ntable) tg (car e))
  12647. (if (member tg current)
  12648. (setq current (delete tg current))
  12649. (loop for g in groups do
  12650. (if (member tg g)
  12651. (mapc (lambda (x)
  12652. (setq current (delete x current)))
  12653. g)))
  12654. (push tg current))
  12655. (if exit-after-next (setq exit-after-next 'now))))
  12656. ;; Create a sorted list
  12657. (setq current
  12658. (sort current
  12659. (lambda (a b)
  12660. (assoc b (cdr (memq (assoc a ntable) ntable))))))
  12661. (if (eq exit-after-next 'now) (throw 'exit t))
  12662. (goto-char (point-min))
  12663. (beginning-of-line 2)
  12664. (delete-region (point) (point-at-eol))
  12665. (org-fast-tag-insert "Current" current c-face)
  12666. (org-set-current-tags-overlay current ov-prefix)
  12667. (while (re-search-forward
  12668. (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
  12669. (setq tg (match-string 1))
  12670. (add-text-properties
  12671. (match-beginning 1) (match-end 1)
  12672. (list 'face
  12673. (cond
  12674. ((member tg current) c-face)
  12675. ((member tg inherited) i-face)
  12676. (t (get-text-property (match-beginning 1) 'face))))))
  12677. (goto-char (point-min)))))
  12678. (org-detach-overlay org-tags-overlay)
  12679. (if rtn
  12680. (mapconcat 'identity current ":")
  12681. nil))))
  12682. (defun org-get-tags-string ()
  12683. "Get the TAGS string in the current headline."
  12684. (unless (org-at-heading-p t)
  12685. (error "Not on a heading"))
  12686. (save-excursion
  12687. (beginning-of-line 1)
  12688. (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
  12689. (org-match-string-no-properties 1)
  12690. "")))
  12691. (defun org-get-tags ()
  12692. "Get the list of tags specified in the current headline."
  12693. (org-split-string (org-get-tags-string) ":"))
  12694. (defun org-get-buffer-tags ()
  12695. "Get a table of all tags used in the buffer, for completion."
  12696. (let (tags)
  12697. (save-excursion
  12698. (goto-char (point-min))
  12699. (while (re-search-forward
  12700. (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
  12701. (when (equal (char-after (point-at-bol 0)) ?*)
  12702. (mapc (lambda (x) (add-to-list 'tags x))
  12703. (org-split-string (org-match-string-no-properties 1) ":")))))
  12704. (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
  12705. (mapcar 'list tags)))
  12706. ;;;; The mapping API
  12707. ;;;###autoload
  12708. (defun org-map-entries (func &optional match scope &rest skip)
  12709. "Call FUNC at each headline selected by MATCH in SCOPE.
  12710. FUNC is a function or a lisp form. The function will be called without
  12711. arguments, with the cursor positioned at the beginning of the headline.
  12712. The return values of all calls to the function will be collected and
  12713. returned as a list.
  12714. The call to FUNC will be wrapped into a save-excursion form, so FUNC
  12715. does not need to preserve point. After evaluation, the cursor will be
  12716. moved to the end of the line (presumably of the headline of the
  12717. processed entry) and search continues from there. Under some
  12718. circumstances, this may not produce the wanted results. For example,
  12719. if you have removed (e.g. archived) the current (sub)tree it could
  12720. mean that the next entry will be skipped entirely. In such cases, you
  12721. can specify the position from where search should continue by making
  12722. FUNC set the variable `org-map-continue-from' to the desired buffer
  12723. position.
  12724. MATCH is a tags/property/todo match as it is used in the agenda tags view.
  12725. Only headlines that are matched by this query will be considered during
  12726. the iteration. When MATCH is nil or t, all headlines will be
  12727. visited by the iteration.
  12728. SCOPE determines the scope of this command. It can be any of:
  12729. nil The current buffer, respecting the restriction if any
  12730. tree The subtree started with the entry at point
  12731. region The entries within the active region, if any
  12732. region-start-level
  12733. The entries within the active region, but only those at
  12734. the same level than the first one.
  12735. file The current buffer, without restriction
  12736. file-with-archives
  12737. The current buffer, and any archives associated with it
  12738. agenda All agenda files
  12739. agenda-with-archives
  12740. All agenda files with any archive files associated with them
  12741. \(file1 file2 ...)
  12742. If this is a list, all files in the list will be scanned
  12743. The remaining args are treated as settings for the skipping facilities of
  12744. the scanner. The following items can be given here:
  12745. archive skip trees with the archive tag.
  12746. comment skip trees with the COMMENT keyword
  12747. function or Emacs Lisp form:
  12748. will be used as value for `org-agenda-skip-function', so whenever
  12749. the function returns t, FUNC will not be called for that
  12750. entry and search will continue from the point where the
  12751. function leaves it.
  12752. If your function needs to retrieve the tags including inherited tags
  12753. at the *current* entry, you can use the value of the variable
  12754. `org-scanner-tags' which will be much faster than getting the value
  12755. with `org-get-tags-at'. If your function gets properties with
  12756. `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
  12757. to t around the call to `org-entry-properties' to get the same speedup.
  12758. Note that if your function moves around to retrieve tags and properties at
  12759. a *different* entry, you cannot use these techniques."
  12760. (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
  12761. (not (org-region-active-p)))
  12762. (let* ((org-agenda-archives-mode nil) ; just to make sure
  12763. (org-agenda-skip-archived-trees (memq 'archive skip))
  12764. (org-agenda-skip-comment-trees (memq 'comment skip))
  12765. (org-agenda-skip-function
  12766. (car (org-delete-all '(comment archive) skip)))
  12767. (org-tags-match-list-sublevels t)
  12768. (start-level (eq scope 'region-start-level))
  12769. matcher file res
  12770. org-todo-keywords-for-agenda
  12771. org-done-keywords-for-agenda
  12772. org-todo-keyword-alist-for-agenda
  12773. org-drawers-for-agenda
  12774. org-tag-alist-for-agenda
  12775. todo-only)
  12776. (cond
  12777. ((eq match t) (setq matcher t))
  12778. ((eq match nil) (setq matcher t))
  12779. (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
  12780. (save-excursion
  12781. (save-restriction
  12782. (cond ((eq scope 'tree)
  12783. (org-back-to-heading t)
  12784. (org-narrow-to-subtree)
  12785. (setq scope nil))
  12786. ((and (or (eq scope 'region) (eq scope 'region-start-level))
  12787. (org-region-active-p))
  12788. ;; If needed, set start-level to a string like "2"
  12789. (when start-level
  12790. (save-excursion
  12791. (goto-char (region-beginning))
  12792. (unless (org-at-heading-p) (outline-next-heading))
  12793. (setq start-level (org-current-level))))
  12794. (narrow-to-region (region-beginning)
  12795. (save-excursion
  12796. (goto-char (region-end))
  12797. (unless (and (bolp) (org-at-heading-p))
  12798. (outline-next-heading))
  12799. (point)))
  12800. (setq scope nil)))
  12801. (if (not scope)
  12802. (progn
  12803. (org-prepare-agenda-buffers
  12804. (list (buffer-file-name (current-buffer))))
  12805. (setq res (org-scan-tags func matcher todo-only start-level)))
  12806. ;; Get the right scope
  12807. (cond
  12808. ((and scope (listp scope) (symbolp (car scope)))
  12809. (setq scope (eval scope)))
  12810. ((eq scope 'agenda)
  12811. (setq scope (org-agenda-files t)))
  12812. ((eq scope 'agenda-with-archives)
  12813. (setq scope (org-agenda-files t))
  12814. (setq scope (org-add-archive-files scope)))
  12815. ((eq scope 'file)
  12816. (setq scope (list (buffer-file-name))))
  12817. ((eq scope 'file-with-archives)
  12818. (setq scope (org-add-archive-files (list (buffer-file-name))))))
  12819. (org-prepare-agenda-buffers scope)
  12820. (while (setq file (pop scope))
  12821. (with-current-buffer (org-find-base-buffer-visiting file)
  12822. (save-excursion
  12823. (save-restriction
  12824. (widen)
  12825. (goto-char (point-min))
  12826. (setq res (append res (org-scan-tags func matcher todo-only))))))))))
  12827. res)))
  12828. ;;;; Properties
  12829. ;;; Setting and retrieving properties
  12830. (defconst org-special-properties
  12831. '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
  12832. "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
  12833. "The special properties valid in Org-mode.
  12834. These are properties that are not defined in the property drawer,
  12835. but in some other way.")
  12836. (defconst org-default-properties
  12837. '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
  12838. "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
  12839. "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
  12840. "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
  12841. "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
  12842. "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
  12843. "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
  12844. "Some properties that are used by Org-mode for various purposes.
  12845. Being in this list makes sure that they are offered for completion.")
  12846. (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
  12847. "Regular expression matching the first line of a property drawer.")
  12848. (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
  12849. "Regular expression matching the last line of a property drawer.")
  12850. (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
  12851. "Regular expression matching the first line of a property drawer.")
  12852. (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
  12853. "Regular expression matching the first line of a property drawer.")
  12854. (defconst org-property-drawer-re
  12855. (concat "\\(" org-property-start-re "\\)[^\000]*\\("
  12856. org-property-end-re "\\)\n?")
  12857. "Matches an entire property drawer.")
  12858. (defconst org-clock-drawer-re
  12859. (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
  12860. org-property-end-re "\\)\n?")
  12861. "Matches an entire clock drawer.")
  12862. (defsubst org-re-property (property)
  12863. "Return a regexp matching PROPERTY.
  12864. Match group 1 will be set to the value "
  12865. (concat "^[ \t]*:" (regexp-quote property) ":[ \t]*\\(\\S-.*\\)"))
  12866. (defun org-property-action ()
  12867. "Do an action on properties."
  12868. (interactive)
  12869. (let (c)
  12870. (org-at-property-p)
  12871. (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
  12872. (setq c (read-char-exclusive))
  12873. (cond
  12874. ((equal c ?s)
  12875. (call-interactively 'org-set-property))
  12876. ((equal c ?d)
  12877. (call-interactively 'org-delete-property))
  12878. ((equal c ?D)
  12879. (call-interactively 'org-delete-property-globally))
  12880. ((equal c ?c)
  12881. (call-interactively 'org-compute-property-at-point))
  12882. (t (error "No such property action %c" c)))))
  12883. (defun org-set-effort (&optional value)
  12884. "Set the effort property of the current entry.
  12885. With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
  12886. allowed value."
  12887. (interactive "P")
  12888. (if (equal value 0) (setq value 10))
  12889. (let* ((completion-ignore-case t)
  12890. (prop org-effort-property)
  12891. (cur (org-entry-get nil prop))
  12892. (allowed (org-property-get-allowed-values nil prop 'table))
  12893. (existing (mapcar 'list (org-property-values prop)))
  12894. rpl
  12895. (val (cond
  12896. ((stringp value) value)
  12897. ((and allowed (integerp value))
  12898. (or (car (nth (1- value) allowed))
  12899. (car (org-last allowed))))
  12900. (allowed
  12901. (message "Select 1-9,0, [RET%s]: %s"
  12902. (if cur (concat "=" cur) "")
  12903. (mapconcat 'car allowed " "))
  12904. (setq rpl (read-char-exclusive))
  12905. (if (equal rpl ?\r)
  12906. cur
  12907. (setq rpl (- rpl ?0))
  12908. (if (equal rpl 0) (setq rpl 10))
  12909. (if (and (> rpl 0) (<= rpl (length allowed)))
  12910. (car (nth (1- rpl) allowed))
  12911. (org-completing-read "Effort: " allowed nil))))
  12912. (t
  12913. (let (org-completion-use-ido org-completion-use-iswitchb)
  12914. (org-completing-read
  12915. (concat "Effort " (if (and cur (string-match "\\S-" cur))
  12916. (concat "[" cur "]") "")
  12917. ": ")
  12918. existing nil nil "" nil cur))))))
  12919. (unless (equal (org-entry-get nil prop) val)
  12920. (org-entry-put nil prop val))
  12921. (message "%s is now %s" prop val)))
  12922. (defun org-at-property-p ()
  12923. "Is cursor inside a property drawer?"
  12924. (save-excursion
  12925. (beginning-of-line 1)
  12926. (when (looking-at (org-re "^[ \t]*\\(:\\([[:alpha:]][[:alnum:]_-]*\\):\\)[ \t]*\\(.*\\)"))
  12927. (save-match-data ;; Used by calling procedures
  12928. (let ((p (point))
  12929. (range (unless (org-before-first-heading-p)
  12930. (org-get-property-block))))
  12931. (and range (<= (car range) p) (< p (cdr range))))))))
  12932. (defun org-get-property-block (&optional beg end force)
  12933. "Return the (beg . end) range of the body of the property drawer.
  12934. BEG and END can be beginning and end of subtree, if not given
  12935. they will be found.
  12936. If the drawer does not exist and FORCE is non-nil, create the drawer."
  12937. (catch 'exit
  12938. (save-excursion
  12939. (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
  12940. (end (or end (progn (outline-next-heading) (point)))))
  12941. (goto-char beg)
  12942. (if (re-search-forward org-property-start-re end t)
  12943. (setq beg (1+ (match-end 0)))
  12944. (if force
  12945. (save-excursion
  12946. (org-insert-property-drawer)
  12947. (setq end (progn (outline-next-heading) (point))))
  12948. (throw 'exit nil))
  12949. (goto-char beg)
  12950. (if (re-search-forward org-property-start-re end t)
  12951. (setq beg (1+ (match-end 0)))))
  12952. (if (re-search-forward org-property-end-re end t)
  12953. (setq end (match-beginning 0))
  12954. (or force (throw 'exit nil))
  12955. (goto-char beg)
  12956. (setq end beg)
  12957. (org-indent-line-function)
  12958. (insert ":END:\n"))
  12959. (cons beg end)))))
  12960. (defun org-entry-properties (&optional pom which specific)
  12961. "Get all properties of the entry at point-or-marker POM.
  12962. This includes the TODO keyword, the tags, time strings for deadline,
  12963. scheduled, and clocking, and any additional properties defined in the
  12964. entry. The return value is an alist, keys may occur multiple times
  12965. if the property key was used several times.
  12966. POM may also be nil, in which case the current entry is used.
  12967. If WHICH is nil or `all', get all properties. If WHICH is
  12968. `special' or `standard', only get that subclass. If WHICH
  12969. is a string only get exactly this property. SPECIFIC can be a string, the
  12970. specific property we are interested in. Specifying it can speed
  12971. things up because then unnecessary parsing is avoided."
  12972. (setq which (or which 'all))
  12973. (org-with-point-at pom
  12974. (let ((clockstr (substring org-clock-string 0 -1))
  12975. (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
  12976. (case-fold-search nil)
  12977. beg end range props sum-props key key1 value string clocksum)
  12978. (save-excursion
  12979. (when (condition-case nil
  12980. (and (derived-mode-p 'org-mode) (org-back-to-heading t))
  12981. (error nil))
  12982. (setq beg (point))
  12983. (setq sum-props (get-text-property (point) 'org-summaries))
  12984. (setq clocksum (get-text-property (point) :org-clock-minutes))
  12985. (outline-next-heading)
  12986. (setq end (point))
  12987. (when (memq which '(all special))
  12988. ;; Get the special properties, like TODO and tags
  12989. (goto-char beg)
  12990. (when (and (or (not specific) (string= specific "TODO"))
  12991. (looking-at org-todo-line-regexp) (match-end 2))
  12992. (push (cons "TODO" (org-match-string-no-properties 2)) props))
  12993. (when (and (or (not specific) (string= specific "PRIORITY"))
  12994. (looking-at org-priority-regexp))
  12995. (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
  12996. (when (or (not specific) (string= specific "FILE"))
  12997. (push (cons "FILE" buffer-file-name) props))
  12998. (when (and (or (not specific) (string= specific "TAGS"))
  12999. (setq value (org-get-tags-string))
  13000. (string-match "\\S-" value))
  13001. (push (cons "TAGS" value) props))
  13002. (when (and (or (not specific) (string= specific "ALLTAGS"))
  13003. (setq value (org-get-tags-at)))
  13004. (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
  13005. ":"))
  13006. props))
  13007. (when (or (not specific) (string= specific "BLOCKED"))
  13008. (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
  13009. (when (or (not specific)
  13010. (member specific
  13011. '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
  13012. "TIMESTAMP" "TIMESTAMP_IA")))
  13013. (catch 'match
  13014. (while (re-search-forward org-maybe-keyword-time-regexp end t)
  13015. (setq key (if (match-end 1)
  13016. (substring (org-match-string-no-properties 1)
  13017. 0 -1))
  13018. string (if (equal key clockstr)
  13019. (org-no-properties
  13020. (org-trim
  13021. (buffer-substring
  13022. (match-beginning 3) (goto-char
  13023. (point-at-eol)))))
  13024. (substring (org-match-string-no-properties 3)
  13025. 1 -1)))
  13026. ;; Get the correct property name from the key. This is
  13027. ;; necessary if the user has configured time keywords.
  13028. (setq key1 (concat key ":"))
  13029. (cond
  13030. ((not key)
  13031. (setq key
  13032. (if (= (char-after (match-beginning 3)) ?\[)
  13033. "TIMESTAMP_IA" "TIMESTAMP")))
  13034. ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
  13035. ((equal key1 org-deadline-string) (setq key "DEADLINE"))
  13036. ((equal key1 org-closed-string) (setq key "CLOSED"))
  13037. ((equal key1 org-clock-string) (setq key "CLOCK")))
  13038. (if (and specific (equal key specific) (not (equal key "CLOCK")))
  13039. (progn
  13040. (push (cons key string) props)
  13041. ;; no need to search further if match is found
  13042. (throw 'match t))
  13043. (when (or (equal key "CLOCK") (not (assoc key props)))
  13044. (push (cons key string) props))))))
  13045. )
  13046. (when (memq which '(all standard))
  13047. ;; Get the standard properties, like :PROP: ...
  13048. (setq range (org-get-property-block beg end))
  13049. (when range
  13050. (goto-char (car range))
  13051. (while (re-search-forward
  13052. (org-re "^[ \t]*:\\([[:alpha:]][[:alnum:]_-]*\\):[ \t]*\\(\\S-.*\\)?")
  13053. (cdr range) t)
  13054. (setq key (org-match-string-no-properties 1)
  13055. value (org-trim (or (org-match-string-no-properties 2) "")))
  13056. (unless (member key excluded)
  13057. (push (cons key (or value "")) props)))))
  13058. (if clocksum
  13059. (push (cons "CLOCKSUM"
  13060. (org-columns-number-to-string (/ (float clocksum) 60.)
  13061. 'add_times))
  13062. props))
  13063. (unless (assoc "CATEGORY" props)
  13064. (push (cons "CATEGORY" (org-get-category)) props))
  13065. (append sum-props (nreverse props)))))))
  13066. (defun org-entry-get (pom property &optional inherit literal-nil)
  13067. "Get value of PROPERTY for entry at point-or-marker POM.
  13068. If INHERIT is non-nil and the entry does not have the property,
  13069. then also check higher levels of the hierarchy.
  13070. If INHERIT is the symbol `selective', use inheritance only if the setting
  13071. in `org-use-property-inheritance' selects PROPERTY for inheritance.
  13072. If the property is present but empty, the return value is the empty string.
  13073. If the property is not present at all, nil is returned.
  13074. If LITERAL-NIL is set, return the string value \"nil\" as a string,
  13075. do not interpret it as the list atom nil. This is used for inheritance
  13076. when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
  13077. (org-with-point-at pom
  13078. (if (and inherit (if (eq inherit 'selective)
  13079. (org-property-inherit-p property)
  13080. t))
  13081. (org-entry-get-with-inheritance property literal-nil)
  13082. (if (member property org-special-properties)
  13083. ;; We need a special property. Use `org-entry-properties' to
  13084. ;; retrieve it, but specify the wanted property
  13085. (cdr (assoc property (org-entry-properties nil 'special property)))
  13086. (let ((range (unless (org-before-first-heading-p)
  13087. (org-get-property-block)))
  13088. (props (list (or (assoc property org-file-properties)
  13089. (assoc property org-global-properties)
  13090. (assoc property org-global-properties-fixed))))
  13091. val)
  13092. (flet ((ap (key)
  13093. (when (re-search-forward
  13094. (org-re-property key) (cdr range) t)
  13095. (setq props
  13096. (org-update-property-plist
  13097. key
  13098. (if (match-end 1)
  13099. (org-match-string-no-properties 1) "")
  13100. props)))))
  13101. (when (and range (goto-char (car range)))
  13102. (ap property)
  13103. (goto-char (car range))
  13104. (while (ap (concat property "+")))
  13105. (setq val (cdr (assoc property props)))
  13106. (when val (if literal-nil val (org-not-nil val))))))))))
  13107. (defun org-property-or-variable-value (var &optional inherit)
  13108. "Check if there is a property fixing the value of VAR.
  13109. If yes, return this value. If not, return the current value of the variable."
  13110. (let ((prop (org-entry-get nil (symbol-name var) inherit)))
  13111. (if (and prop (stringp prop) (string-match "\\S-" prop))
  13112. (read prop)
  13113. (symbol-value var))))
  13114. (defun org-entry-delete (pom property)
  13115. "Delete the property PROPERTY from entry at point-or-marker POM."
  13116. (org-with-point-at pom
  13117. (if (member property org-special-properties)
  13118. nil ; cannot delete these properties.
  13119. (let ((range (org-get-property-block)))
  13120. (if (and range
  13121. (goto-char (car range))
  13122. (re-search-forward
  13123. (org-re-property property)
  13124. (cdr range) t))
  13125. (progn
  13126. (delete-region (match-beginning 0) (1+ (point-at-eol)))
  13127. t)
  13128. nil)))))
  13129. ;; Multi-values properties are properties that contain multiple values
  13130. ;; These values are assumed to be single words, separated by whitespace.
  13131. (defun org-entry-add-to-multivalued-property (pom property value)
  13132. "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
  13133. (let* ((old (org-entry-get pom property))
  13134. (values (and old (org-split-string old "[ \t]"))))
  13135. (setq value (org-entry-protect-space value))
  13136. (unless (member value values)
  13137. (setq values (cons value values))
  13138. (org-entry-put pom property
  13139. (mapconcat 'identity values " ")))))
  13140. (defun org-entry-remove-from-multivalued-property (pom property value)
  13141. "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
  13142. (let* ((old (org-entry-get pom property))
  13143. (values (and old (org-split-string old "[ \t]"))))
  13144. (setq value (org-entry-protect-space value))
  13145. (when (member value values)
  13146. (setq values (delete value values))
  13147. (org-entry-put pom property
  13148. (mapconcat 'identity values " ")))))
  13149. (defun org-entry-member-in-multivalued-property (pom property value)
  13150. "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
  13151. (let* ((old (org-entry-get pom property))
  13152. (values (and old (org-split-string old "[ \t]"))))
  13153. (setq value (org-entry-protect-space value))
  13154. (member value values)))
  13155. (defun org-entry-get-multivalued-property (pom property)
  13156. "Return a list of values in a multivalued property."
  13157. (let* ((value (org-entry-get pom property))
  13158. (values (and value (org-split-string value "[ \t]"))))
  13159. (mapcar 'org-entry-restore-space values)))
  13160. (defun org-entry-put-multivalued-property (pom property &rest values)
  13161. "Set multivalued PROPERTY at point-or-marker POM to VALUES.
  13162. VALUES should be a list of strings. Spaces will be protected."
  13163. (org-entry-put pom property
  13164. (mapconcat 'org-entry-protect-space values " "))
  13165. (let* ((value (org-entry-get pom property))
  13166. (values (and value (org-split-string value "[ \t]"))))
  13167. (mapcar 'org-entry-restore-space values)))
  13168. (defun org-entry-protect-space (s)
  13169. "Protect spaces and newline in string S."
  13170. (while (string-match " " s)
  13171. (setq s (replace-match "%20" t t s)))
  13172. (while (string-match "\n" s)
  13173. (setq s (replace-match "%0A" t t s)))
  13174. s)
  13175. (defun org-entry-restore-space (s)
  13176. "Restore spaces and newline in string S."
  13177. (while (string-match "%20" s)
  13178. (setq s (replace-match " " t t s)))
  13179. (while (string-match "%0A" s)
  13180. (setq s (replace-match "\n" t t s)))
  13181. s)
  13182. (defvar org-entry-property-inherited-from (make-marker)
  13183. "Marker pointing to the entry from where a property was inherited.
  13184. Each call to `org-entry-get-with-inheritance' will set this marker to the
  13185. location of the entry where the inheritance search matched. If there was
  13186. no match, the marker will point nowhere.
  13187. Note that also `org-entry-get' calls this function, if the INHERIT flag
  13188. is set.")
  13189. (defun org-entry-get-with-inheritance (property &optional literal-nil)
  13190. "Get entry property, and search higher levels if not present.
  13191. The search will stop at the first ancestor which has the property defined.
  13192. If the value found is \"nil\", return nil to show that the property
  13193. should be considered as undefined (this is the meaning of nil here).
  13194. However, if LITERAL-NIL is set, return the string value \"nil\" instead."
  13195. (move-marker org-entry-property-inherited-from nil)
  13196. (let (tmp)
  13197. (unless (org-before-first-heading-p)
  13198. (save-excursion
  13199. (save-restriction
  13200. (widen)
  13201. (catch 'ex
  13202. (while t
  13203. (when (setq tmp (org-entry-get nil property nil 'literal-nil))
  13204. (org-back-to-heading t)
  13205. (move-marker org-entry-property-inherited-from (point))
  13206. (throw 'ex tmp))
  13207. (or (org-up-heading-safe) (throw 'ex nil)))))))
  13208. (setq tmp (or tmp
  13209. (cdr (assoc property org-file-properties))
  13210. (cdr (assoc property org-global-properties))
  13211. (cdr (assoc property org-global-properties-fixed))))
  13212. (if literal-nil tmp (org-not-nil tmp))))
  13213. (defvar org-property-changed-functions nil
  13214. "Hook called when the value of a property has changed.
  13215. Each hook function should accept two arguments, the name of the property
  13216. and the new value.")
  13217. (defun org-entry-put (pom property value)
  13218. "Set PROPERTY to VALUE for entry at point-or-marker POM."
  13219. (org-with-point-at pom
  13220. (org-back-to-heading t)
  13221. (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
  13222. range)
  13223. (cond
  13224. ((equal property "TODO")
  13225. (when (and (stringp value) (string-match "\\S-" value)
  13226. (not (member value org-todo-keywords-1)))
  13227. (error "\"%s\" is not a valid TODO state" value))
  13228. (if (or (not value)
  13229. (not (string-match "\\S-" value)))
  13230. (setq value 'none))
  13231. (org-todo value)
  13232. (org-set-tags nil 'align))
  13233. ((equal property "PRIORITY")
  13234. (org-priority (if (and value (stringp value) (string-match "\\S-" value))
  13235. (string-to-char value) ?\ ))
  13236. (org-set-tags nil 'align))
  13237. ((equal property "SCHEDULED")
  13238. (if (re-search-forward org-scheduled-time-regexp end t)
  13239. (cond
  13240. ((eq value 'earlier) (org-timestamp-change -1 'day))
  13241. ((eq value 'later) (org-timestamp-change 1 'day))
  13242. (t (call-interactively 'org-schedule)))
  13243. (call-interactively 'org-schedule)))
  13244. ((equal property "DEADLINE")
  13245. (if (re-search-forward org-deadline-time-regexp end t)
  13246. (cond
  13247. ((eq value 'earlier) (org-timestamp-change -1 'day))
  13248. ((eq value 'later) (org-timestamp-change 1 'day))
  13249. (t (call-interactively 'org-deadline)))
  13250. (call-interactively 'org-deadline)))
  13251. ((member property org-special-properties)
  13252. (error "The %s property can not yet be set with `org-entry-put'"
  13253. property))
  13254. (t ; a non-special property
  13255. (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
  13256. (setq range (org-get-property-block beg end 'force))
  13257. (goto-char (car range))
  13258. (if (re-search-forward
  13259. (org-re-property property) (cdr range) t)
  13260. (progn
  13261. (delete-region (match-beginning 0) (match-end 0))
  13262. (goto-char (match-beginning 0)))
  13263. (goto-char (cdr range))
  13264. (insert "\n")
  13265. (backward-char 1)
  13266. (org-indent-line-function))
  13267. (insert ":" property ":")
  13268. (and value (insert " " value))
  13269. (org-indent-line-function)))))
  13270. (run-hook-with-args 'org-property-changed-functions property value)))
  13271. (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
  13272. "Get all property keys in the current buffer.
  13273. With INCLUDE-SPECIALS, also list the special properties that reflect things
  13274. like tags and TODO state.
  13275. With INCLUDE-DEFAULTS, also include properties that has special meaning
  13276. internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
  13277. and others.
  13278. With INCLUDE-COLUMNS, also include property names given in COLUMN
  13279. formats in the current buffer."
  13280. (let (rtn range cfmt s p)
  13281. (save-excursion
  13282. (save-restriction
  13283. (widen)
  13284. (goto-char (point-min))
  13285. (while (re-search-forward org-property-start-re nil t)
  13286. (setq range (org-get-property-block))
  13287. (goto-char (car range))
  13288. (while (re-search-forward
  13289. (org-re "^[ \t]*:\\([-[:alnum:]_]+\\):")
  13290. (cdr range) t)
  13291. (add-to-list 'rtn (org-match-string-no-properties 1)))
  13292. (outline-next-heading))))
  13293. (when include-specials
  13294. (setq rtn (append org-special-properties rtn)))
  13295. (when include-defaults
  13296. (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
  13297. (add-to-list 'rtn org-effort-property))
  13298. (when include-columns
  13299. (save-excursion
  13300. (save-restriction
  13301. (widen)
  13302. (goto-char (point-min))
  13303. (while (re-search-forward
  13304. "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
  13305. nil t)
  13306. (setq cfmt (match-string 2) s 0)
  13307. (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
  13308. cfmt s)
  13309. (setq s (match-end 0)
  13310. p (match-string 1 cfmt))
  13311. (unless (or (equal p "ITEM")
  13312. (member p org-special-properties))
  13313. (add-to-list 'rtn (match-string 1 cfmt))))))))
  13314. (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
  13315. (defun org-property-values (key)
  13316. "Return a list of all values of property KEY in the current buffer."
  13317. (save-excursion
  13318. (save-restriction
  13319. (widen)
  13320. (goto-char (point-min))
  13321. (let ((re (org-re-property key))
  13322. values)
  13323. (while (re-search-forward re nil t)
  13324. (add-to-list 'values (org-trim (match-string 1))))
  13325. (delete "" values)))))
  13326. (defun org-insert-property-drawer ()
  13327. "Insert a property drawer into the current entry."
  13328. (org-back-to-heading t)
  13329. (looking-at org-outline-regexp)
  13330. (let ((indent (if org-adapt-indentation
  13331. (- (match-end 0) (match-beginning 0))
  13332. 0))
  13333. (beg (point))
  13334. (re (concat "^[ \t]*" org-keyword-time-regexp))
  13335. end hiddenp)
  13336. (outline-next-heading)
  13337. (setq end (point))
  13338. (goto-char beg)
  13339. (while (re-search-forward re end t))
  13340. (setq hiddenp (outline-invisible-p))
  13341. (end-of-line 1)
  13342. (and (equal (char-after) ?\n) (forward-char 1))
  13343. (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
  13344. (if (member (match-string 1) '("CLOCK:" ":END:"))
  13345. ;; just skip this line
  13346. (beginning-of-line 2)
  13347. ;; Drawer start, find the end
  13348. (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
  13349. (beginning-of-line 1)))
  13350. (org-skip-over-state-notes)
  13351. (skip-chars-backward " \t\n\r")
  13352. (if (eq (char-before) ?*) (forward-char 1))
  13353. (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
  13354. (beginning-of-line 0)
  13355. (org-indent-to-column indent)
  13356. (beginning-of-line 2)
  13357. (org-indent-to-column indent)
  13358. (beginning-of-line 0)
  13359. (if hiddenp
  13360. (save-excursion
  13361. (org-back-to-heading t)
  13362. (hide-entry))
  13363. (org-flag-drawer t))))
  13364. (defun org-insert-drawer (&optional arg drawer)
  13365. "Insert a drawer at point.
  13366. Optional argument DRAWER, when non-nil, is a string representing
  13367. drawer's name. Otherwise, the user is prompted for a name.
  13368. If a region is active, insert the drawer around that region
  13369. instead.
  13370. Point is left between drawer's boundaries."
  13371. (interactive "P")
  13372. (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
  13373. "LOGBOOK"))
  13374. ;; SYSTEM-DRAWERS is a list of drawer names that are used
  13375. ;; internally by Org. They are meant to be inserted
  13376. ;; automatically.
  13377. (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
  13378. ;; Remove system drawers from list. Note: For some reason,
  13379. ;; `org-completing-read' ignores the predicate while
  13380. ;; `completing-read' handles it fine.
  13381. (drawer (if arg "PROPERTIES"
  13382. (or drawer
  13383. (completing-read
  13384. "Drawer: " org-drawers
  13385. (lambda (d) (not (member d system-drawers))))))))
  13386. (cond
  13387. ;; With C-u, fall back on `org-insert-property-drawer'
  13388. (arg (org-insert-property-drawer))
  13389. ;; With an active region, insert a drawer at point.
  13390. ((not (org-region-active-p))
  13391. (progn
  13392. (unless (bolp) (insert "\n"))
  13393. (insert (format ":%s:\n\n:END:\n" drawer))
  13394. (forward-line -2)))
  13395. ;; Otherwise, insert the drawer at point
  13396. (t
  13397. (let ((rbeg (region-beginning))
  13398. (rend (copy-marker (region-end))))
  13399. (unwind-protect
  13400. (progn
  13401. (goto-char rbeg)
  13402. (beginning-of-line)
  13403. (when (save-excursion
  13404. (re-search-forward org-outline-regexp-bol rend t))
  13405. (error "Drawers cannot contain headlines"))
  13406. ;; Position point at the beginning of the first
  13407. ;; non-blank line in region. Insert drawer's opening
  13408. ;; there, then indent it.
  13409. (org-skip-whitespace)
  13410. (beginning-of-line)
  13411. (insert ":" drawer ":\n")
  13412. (forward-line -1)
  13413. (indent-for-tab-command)
  13414. ;; Move point to the beginning of the first blank line
  13415. ;; after the last non-blank line in region. Insert
  13416. ;; drawer's closing, then indent it.
  13417. (goto-char rend)
  13418. (skip-chars-backward " \r\t\n")
  13419. (insert "\n:END:")
  13420. (indent-for-tab-command)
  13421. (unless (eolp) (insert "\n")))
  13422. ;; Clear marker, whatever the outcome of insertion is.
  13423. (set-marker rend nil)))))))
  13424. (defvar org-property-set-functions-alist nil
  13425. "Property set function alist.
  13426. Each entry should have the following format:
  13427. (PROPERTY . READ-FUNCTION)
  13428. The read function will be called with the same argument as
  13429. `org-completing-read'.")
  13430. (defun org-set-property-function (property)
  13431. "Get the function that should be used to set PROPERTY.
  13432. This is computed according to `org-property-set-functions-alist'."
  13433. (or (cdr (assoc property org-property-set-functions-alist))
  13434. 'org-completing-read))
  13435. (defun org-read-property-value (property)
  13436. "Read PROPERTY value from user."
  13437. (let* ((completion-ignore-case t)
  13438. (allowed (org-property-get-allowed-values nil property 'table))
  13439. (cur (org-entry-get nil property))
  13440. (prompt (concat property " value"
  13441. (if (and cur (string-match "\\S-" cur))
  13442. (concat " [" cur "]") "") ": "))
  13443. (set-function (org-set-property-function property))
  13444. (val (if allowed
  13445. (funcall set-function prompt allowed nil
  13446. (not (get-text-property 0 'org-unrestricted
  13447. (caar allowed))))
  13448. (let (org-completion-use-ido org-completion-use-iswitchb)
  13449. (funcall set-function prompt
  13450. (mapcar 'list (org-property-values property))
  13451. nil nil "" nil cur)))))
  13452. (if (equal val "")
  13453. cur
  13454. val)))
  13455. (defvar org-last-set-property nil)
  13456. (defun org-read-property-name ()
  13457. "Read a property name."
  13458. (let* ((completion-ignore-case t)
  13459. (keys (org-buffer-property-keys nil t t))
  13460. (default-prop (or (save-excursion
  13461. (save-match-data
  13462. (beginning-of-line)
  13463. (and (looking-at "^\\s-*:\\([^:\n]+\\):")
  13464. (null (string= (match-string 1) "END"))
  13465. (match-string 1))))
  13466. org-last-set-property))
  13467. (property (org-icompleting-read
  13468. (concat "Property"
  13469. (if default-prop (concat " [" default-prop "]") "")
  13470. ": ")
  13471. (mapcar 'list keys)
  13472. nil nil nil nil
  13473. default-prop
  13474. )))
  13475. (if (member property keys)
  13476. property
  13477. (or (cdr (assoc (downcase property)
  13478. (mapcar (lambda (x) (cons (downcase x) x))
  13479. keys)))
  13480. property))))
  13481. (defun org-set-property (property value)
  13482. "In the current entry, set PROPERTY to VALUE.
  13483. When called interactively, this will prompt for a property name, offering
  13484. completion on existing and default properties. And then it will prompt
  13485. for a value, offering completion either on allowed values (via an inherited
  13486. xxx_ALL property) or on existing values in other instances of this property
  13487. in the current file."
  13488. (interactive (list nil nil))
  13489. (let* ((property (or property (org-read-property-name)))
  13490. (value (or value (org-read-property-value property)))
  13491. (fn (cdr (assoc property org-properties-postprocess-alist))))
  13492. (setq org-last-set-property property)
  13493. ;; Possibly postprocess the inserted value:
  13494. (when fn (setq value (funcall fn value)))
  13495. (unless (equal (org-entry-get nil property) value)
  13496. (org-entry-put nil property value))))
  13497. (defun org-delete-property (property)
  13498. "In the current entry, delete PROPERTY."
  13499. (interactive
  13500. (let* ((completion-ignore-case t)
  13501. (prop (org-icompleting-read "Property: "
  13502. (org-entry-properties nil 'standard))))
  13503. (list prop)))
  13504. (message "Property %s %s" property
  13505. (if (org-entry-delete nil property)
  13506. "deleted"
  13507. "was not present in the entry")))
  13508. (defun org-delete-property-globally (property)
  13509. "Remove PROPERTY globally, from all entries."
  13510. (interactive
  13511. (let* ((completion-ignore-case t)
  13512. (prop (org-icompleting-read
  13513. "Globally remove property: "
  13514. (mapcar 'list (org-buffer-property-keys)))))
  13515. (list prop)))
  13516. (save-excursion
  13517. (save-restriction
  13518. (widen)
  13519. (goto-char (point-min))
  13520. (let ((cnt 0))
  13521. (while (re-search-forward
  13522. (org-re-property property)
  13523. nil t)
  13524. (setq cnt (1+ cnt))
  13525. (delete-region (match-beginning 0) (1+ (point-at-eol))))
  13526. (message "Property \"%s\" removed from %d entries" property cnt)))))
  13527. (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
  13528. (defun org-compute-property-at-point ()
  13529. "Compute the property at point.
  13530. This looks for an enclosing column format, extracts the operator and
  13531. then applies it to the property in the column format's scope."
  13532. (interactive)
  13533. (unless (org-at-property-p)
  13534. (error "Not at a property"))
  13535. (let ((prop (org-match-string-no-properties 2)))
  13536. (org-columns-get-format-and-top-level)
  13537. (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
  13538. (error "No operator defined for property %s" prop))
  13539. (org-columns-compute prop)))
  13540. (defvar org-property-allowed-value-functions nil
  13541. "Hook for functions supplying allowed values for a specific property.
  13542. The functions must take a single argument, the name of the property, and
  13543. return a flat list of allowed values. If \":ETC\" is one of
  13544. the values, this means that these values are intended as defaults for
  13545. completion, but that other values should be allowed too.
  13546. The functions must return nil if they are not responsible for this
  13547. property.")
  13548. (defun org-property-get-allowed-values (pom property &optional table)
  13549. "Get allowed values for the property PROPERTY.
  13550. When TABLE is non-nil, return an alist that can directly be used for
  13551. completion."
  13552. (let (vals)
  13553. (cond
  13554. ((equal property "TODO")
  13555. (setq vals (org-with-point-at pom
  13556. (append org-todo-keywords-1 '("")))))
  13557. ((equal property "PRIORITY")
  13558. (let ((n org-lowest-priority))
  13559. (while (>= n org-highest-priority)
  13560. (push (char-to-string n) vals)
  13561. (setq n (1- n)))))
  13562. ((member property org-special-properties))
  13563. ((setq vals (run-hook-with-args-until-success
  13564. 'org-property-allowed-value-functions property)))
  13565. (t
  13566. (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
  13567. (when (and vals (string-match "\\S-" vals))
  13568. (setq vals (car (read-from-string (concat "(" vals ")"))))
  13569. (setq vals (mapcar (lambda (x)
  13570. (cond ((stringp x) x)
  13571. ((numberp x) (number-to-string x))
  13572. ((symbolp x) (symbol-name x))
  13573. (t "???")))
  13574. vals)))))
  13575. (when (member ":ETC" vals)
  13576. (setq vals (remove ":ETC" vals))
  13577. (org-add-props (car vals) '(org-unrestricted t)))
  13578. (if table (mapcar 'list vals) vals)))
  13579. (defun org-property-previous-allowed-value (&optional previous)
  13580. "Switch to the next allowed value for this property."
  13581. (interactive)
  13582. (org-property-next-allowed-value t))
  13583. (defun org-property-next-allowed-value (&optional previous)
  13584. "Switch to the next allowed value for this property."
  13585. (interactive)
  13586. (unless (org-at-property-p)
  13587. (error "Not at a property"))
  13588. (let* ((key (match-string 2))
  13589. (value (match-string 3))
  13590. (allowed (or (org-property-get-allowed-values (point) key)
  13591. (and (member value '("[ ]" "[-]" "[X]"))
  13592. '("[ ]" "[X]"))))
  13593. nval)
  13594. (unless allowed
  13595. (error "Allowed values for this property have not been defined"))
  13596. (if previous (setq allowed (reverse allowed)))
  13597. (if (member value allowed)
  13598. (setq nval (car (cdr (member value allowed)))))
  13599. (setq nval (or nval (car allowed)))
  13600. (if (equal nval value)
  13601. (error "Only one allowed value for this property"))
  13602. (org-at-property-p)
  13603. (replace-match (concat " :" key ": " nval) t t)
  13604. (org-indent-line-function)
  13605. (beginning-of-line 1)
  13606. (skip-chars-forward " \t")
  13607. (run-hook-with-args 'org-property-changed-functions key nval)))
  13608. (defun org-find-olp (path &optional this-buffer)
  13609. "Return a marker pointing to the entry at outline path OLP.
  13610. If anything goes wrong, throw an error.
  13611. You can wrap this call to catch the error like this:
  13612. (condition-case msg
  13613. (org-mobile-locate-entry (match-string 4))
  13614. (error (nth 1 msg)))
  13615. The return value will then be either a string with the error message,
  13616. or a marker if everything is OK.
  13617. If THIS-BUFFER is set, the outline path does not contain a file,
  13618. only headings."
  13619. (let* ((file (if this-buffer buffer-file-name (pop path)))
  13620. (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
  13621. (level 1)
  13622. (lmin 1)
  13623. (lmax 1)
  13624. limit re end found pos heading cnt flevel)
  13625. (unless buffer (error "File not found :%s" file))
  13626. (with-current-buffer buffer
  13627. (save-excursion
  13628. (save-restriction
  13629. (widen)
  13630. (setq limit (point-max))
  13631. (goto-char (point-min))
  13632. (while (setq heading (pop path))
  13633. (setq re (format org-complex-heading-regexp-format
  13634. (regexp-quote heading)))
  13635. (setq cnt 0 pos (point))
  13636. (while (re-search-forward re end t)
  13637. (setq level (- (match-end 1) (match-beginning 1)))
  13638. (if (and (>= level lmin) (<= level lmax))
  13639. (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
  13640. (when (= cnt 0) (error "Heading not found on level %d: %s"
  13641. lmax heading))
  13642. (when (> cnt 1) (error "Heading not unique on level %d: %s"
  13643. lmax heading))
  13644. (goto-char found)
  13645. (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
  13646. (setq end (save-excursion (org-end-of-subtree t t))))
  13647. (when (org-at-heading-p)
  13648. (move-marker (make-marker) (point))))))))
  13649. (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
  13650. "Find node HEADING in BUFFER.
  13651. Return a marker to the heading if it was found, or nil if not.
  13652. If POS-ONLY is set, return just the position instead of a marker.
  13653. The heading text must match exact, but it may have a TODO keyword,
  13654. a priority cookie and tags in the standard locations."
  13655. (with-current-buffer (or buffer (current-buffer))
  13656. (save-excursion
  13657. (save-restriction
  13658. (widen)
  13659. (goto-char (point-min))
  13660. (let (case-fold-search)
  13661. (if (re-search-forward
  13662. (format org-complex-heading-regexp-format
  13663. (regexp-quote heading)) nil t)
  13664. (if pos-only
  13665. (match-beginning 0)
  13666. (move-marker (make-marker) (match-beginning 0)))))))))
  13667. (defun org-find-exact-heading-in-directory (heading &optional dir)
  13668. "Find Org node headline HEADING in all .org files in directory DIR.
  13669. When the target headline is found, return a marker to this location."
  13670. (let ((files (directory-files (or dir default-directory)
  13671. nil "\\`[^.#].*\\.org\\'"))
  13672. file visiting m buffer)
  13673. (catch 'found
  13674. (while (setq file (pop files))
  13675. (message "trying %s" file)
  13676. (setq visiting (org-find-base-buffer-visiting file))
  13677. (setq buffer (or visiting (find-file-noselect file)))
  13678. (setq m (org-find-exact-headline-in-buffer
  13679. heading buffer))
  13680. (when (and (not m) (not visiting)) (kill-buffer buffer))
  13681. (and m (throw 'found m))))))
  13682. (defun org-find-entry-with-id (ident)
  13683. "Locate the entry that contains the ID property with exact value IDENT.
  13684. IDENT can be a string, a symbol or a number, this function will search for
  13685. the string representation of it.
  13686. Return the position where this entry starts, or nil if there is no such entry."
  13687. (interactive "sID: ")
  13688. (let ((id (cond
  13689. ((stringp ident) ident)
  13690. ((symbol-name ident) (symbol-name ident))
  13691. ((numberp ident) (number-to-string ident))
  13692. (t (error "IDENT %s must be a string, symbol or number" ident))))
  13693. (case-fold-search nil))
  13694. (save-excursion
  13695. (save-restriction
  13696. (widen)
  13697. (goto-char (point-min))
  13698. (when (re-search-forward
  13699. (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
  13700. nil t)
  13701. (org-back-to-heading t)
  13702. (point))))))
  13703. ;;;; Timestamps
  13704. (defvar org-last-changed-timestamp nil)
  13705. (defvar org-last-inserted-timestamp nil
  13706. "The last time stamp inserted with `org-insert-time-stamp'.")
  13707. (defvar org-time-was-given) ; dynamically scoped parameter
  13708. (defvar org-end-time-was-given) ; dynamically scoped parameter
  13709. (defvar org-ts-what) ; dynamically scoped parameter
  13710. (defun org-time-stamp (arg &optional inactive)
  13711. "Prompt for a date/time and insert a time stamp.
  13712. If the user specifies a time like HH:MM or if this command is
  13713. called with at least one prefix argument, the time stamp contains
  13714. the date and the time. Otherwise, only the date is be included.
  13715. All parts of a date not specified by the user is filled in from
  13716. the current date/time. So if you just press return without
  13717. typing anything, the time stamp will represent the current
  13718. date/time.
  13719. If there is already a timestamp at the cursor, it will be
  13720. modified.
  13721. With two universal prefix arguments, insert an active timestamp
  13722. with the current time without prompting the user."
  13723. (interactive "P")
  13724. (let* ((ts nil)
  13725. (default-time
  13726. ;; Default time is either today, or, when entering a range,
  13727. ;; the range start.
  13728. (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
  13729. (save-excursion
  13730. (re-search-backward
  13731. (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
  13732. (- (point) 20) t)))
  13733. (apply 'encode-time (org-parse-time-string (match-string 1)))
  13734. (current-time)))
  13735. (default-input (and ts (org-get-compact-tod ts)))
  13736. (repeater (save-excursion
  13737. (save-match-data
  13738. (beginning-of-line)
  13739. (when (re-search-forward
  13740. "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
  13741. (save-excursion (progn (end-of-line) (point))) t)
  13742. (match-string 0)))))
  13743. org-time-was-given org-end-time-was-given time)
  13744. (cond
  13745. ((and (org-at-timestamp-p t)
  13746. (memq last-command '(org-time-stamp org-time-stamp-inactive))
  13747. (memq this-command '(org-time-stamp org-time-stamp-inactive)))
  13748. (insert "--")
  13749. (setq time (let ((this-command this-command))
  13750. (org-read-date arg 'totime nil nil
  13751. default-time default-input inactive)))
  13752. (org-insert-time-stamp time (or org-time-was-given arg) inactive))
  13753. ((org-at-timestamp-p t)
  13754. (setq time (let ((this-command this-command))
  13755. (org-read-date arg 'totime nil nil default-time default-input inactive)))
  13756. (when (org-at-timestamp-p t) ; just to get the match data
  13757. ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
  13758. (replace-match "")
  13759. (setq org-last-changed-timestamp
  13760. (org-insert-time-stamp
  13761. time (or org-time-was-given arg)
  13762. inactive nil nil (list org-end-time-was-given)))
  13763. (when repeater (goto-char (1- (point))) (insert " " repeater)
  13764. (setq org-last-changed-timestamp
  13765. (concat (substring org-last-inserted-timestamp 0 -1)
  13766. " " repeater ">"))))
  13767. (message "Timestamp updated"))
  13768. ((equal arg '(16))
  13769. (org-insert-time-stamp (current-time) t))
  13770. (t
  13771. (setq time (let ((this-command this-command))
  13772. (org-read-date arg 'totime nil nil default-time default-input inactive)))
  13773. (org-insert-time-stamp time (or org-time-was-given arg) inactive
  13774. nil nil (list org-end-time-was-given))))))
  13775. ;; FIXME: can we use this for something else, like computing time differences?
  13776. (defun org-get-compact-tod (s)
  13777. (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
  13778. (let* ((t1 (match-string 1 s))
  13779. (h1 (string-to-number (match-string 2 s)))
  13780. (m1 (string-to-number (match-string 3 s)))
  13781. (t2 (and (match-end 4) (match-string 5 s)))
  13782. (h2 (and t2 (string-to-number (match-string 6 s))))
  13783. (m2 (and t2 (string-to-number (match-string 7 s))))
  13784. dh dm)
  13785. (if (not t2)
  13786. t1
  13787. (setq dh (- h2 h1) dm (- m2 m1))
  13788. (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
  13789. (concat t1 "+" (number-to-string dh)
  13790. (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
  13791. (defun org-time-stamp-inactive (&optional arg)
  13792. "Insert an inactive time stamp.
  13793. An inactive time stamp is enclosed in square brackets instead of angle
  13794. brackets. It is inactive in the sense that it does not trigger agenda entries,
  13795. does not link to the calendar and cannot be changed with the S-cursor keys.
  13796. So these are more for recording a certain time/date."
  13797. (interactive "P")
  13798. (org-time-stamp arg 'inactive))
  13799. (defvar org-date-ovl (make-overlay 1 1))
  13800. (overlay-put org-date-ovl 'face 'org-date-selected)
  13801. (org-detach-overlay org-date-ovl)
  13802. (defvar org-ans1) ; dynamically scoped parameter
  13803. (defvar org-ans2) ; dynamically scoped parameter
  13804. (defvar org-plain-time-of-day-regexp) ; defined below
  13805. (defvar org-overriding-default-time nil) ; dynamically scoped
  13806. (defvar org-read-date-overlay nil)
  13807. (defvar org-dcst nil) ; dynamically scoped
  13808. (defvar org-read-date-history nil)
  13809. (defvar org-read-date-final-answer nil)
  13810. (defvar org-read-date-analyze-futurep nil)
  13811. (defvar org-read-date-analyze-forced-year nil)
  13812. (defvar org-read-date-inactive)
  13813. (defun org-read-date (&optional org-with-time to-time from-string prompt
  13814. default-time default-input inactive)
  13815. "Read a date, possibly a time, and make things smooth for the user.
  13816. The prompt will suggest to enter an ISO date, but you can also enter anything
  13817. which will at least partially be understood by `parse-time-string'.
  13818. Unrecognized parts of the date will default to the current day, month, year,
  13819. hour and minute. If this command is called to replace a timestamp at point,
  13820. or to enter the second timestamp of a range, the default time is taken
  13821. from the existing stamp. Furthermore, the command prefers the future,
  13822. so if you are giving a date where the year is not given, and the day-month
  13823. combination is already past in the current year, it will assume you
  13824. mean next year. For details, see the manual. A few examples:
  13825. 3-2-5 --> 2003-02-05
  13826. feb 15 --> currentyear-02-15
  13827. 2/15 --> currentyear-02-15
  13828. sep 12 9 --> 2009-09-12
  13829. 12:45 --> today 12:45
  13830. 22 sept 0:34 --> currentyear-09-22 0:34
  13831. 12 --> currentyear-currentmonth-12
  13832. Fri --> nearest Friday (today or later)
  13833. etc.
  13834. Furthermore you can specify a relative date by giving, as the *first* thing
  13835. in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
  13836. change in days weeks, months, years.
  13837. With a single plus or minus, the date is relative to today. With a double
  13838. plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
  13839. +4d --> four days from today
  13840. +4 --> same as above
  13841. +2w --> two weeks from today
  13842. ++5 --> five days from default date
  13843. The function understands only English month and weekday abbreviations.
  13844. While prompting, a calendar is popped up - you can also select the
  13845. date with the mouse (button 1). The calendar shows a period of three
  13846. months. To scroll it to other months, use the keys `>' and `<'.
  13847. If you don't like the calendar, turn it off with
  13848. \(setq org-read-date-popup-calendar nil)
  13849. With optional argument TO-TIME, the date will immediately be converted
  13850. to an internal time.
  13851. With an optional argument WITH-TIME, the prompt will suggest to also
  13852. insert a time. Note that when WITH-TIME is not set, you can still
  13853. enter a time, and this function will inform the calling routine about
  13854. this change. The calling routine may then choose to change the format
  13855. used to insert the time stamp into the buffer to include the time.
  13856. With optional argument FROM-STRING, read from this string instead from
  13857. the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
  13858. the time/date that is used for everything that is not specified by the
  13859. user."
  13860. (require 'parse-time)
  13861. (let* ((org-time-stamp-rounding-minutes
  13862. (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
  13863. (org-dcst org-display-custom-times)
  13864. (ct (org-current-time))
  13865. (org-def (or org-overriding-default-time default-time ct))
  13866. (org-defdecode (decode-time org-def))
  13867. (dummy (progn
  13868. (when (< (nth 2 org-defdecode) org-extend-today-until)
  13869. (setcar (nthcdr 2 org-defdecode) -1)
  13870. (setcar (nthcdr 1 org-defdecode) 59)
  13871. (setq org-def (apply 'encode-time org-defdecode)
  13872. org-defdecode (decode-time org-def)))))
  13873. (calendar-frame-setup nil)
  13874. (calendar-setup nil)
  13875. (calendar-move-hook nil)
  13876. (calendar-view-diary-initially-flag nil)
  13877. (calendar-view-holidays-initially-flag nil)
  13878. (timestr (format-time-string
  13879. (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
  13880. (prompt (concat (if prompt (concat prompt " ") "")
  13881. (format "Date+time [%s]: " timestr)))
  13882. ans (org-ans0 "") org-ans1 org-ans2 final)
  13883. (cond
  13884. (from-string (setq ans from-string))
  13885. (org-read-date-popup-calendar
  13886. (save-excursion
  13887. (save-window-excursion
  13888. (calendar)
  13889. (org-eval-in-calendar '(setq cursor-type nil) t)
  13890. (unwind-protect
  13891. (progn
  13892. (calendar-forward-day (- (time-to-days org-def)
  13893. (calendar-absolute-from-gregorian
  13894. (calendar-current-date))))
  13895. (org-eval-in-calendar nil t)
  13896. (let* ((old-map (current-local-map))
  13897. (map (copy-keymap calendar-mode-map))
  13898. (minibuffer-local-map (copy-keymap minibuffer-local-map)))
  13899. (org-defkey map (kbd "RET") 'org-calendar-select)
  13900. (org-defkey map [mouse-1] 'org-calendar-select-mouse)
  13901. (org-defkey map [mouse-2] 'org-calendar-select-mouse)
  13902. (org-defkey minibuffer-local-map [(meta shift left)]
  13903. (lambda () (interactive)
  13904. (org-eval-in-calendar '(calendar-backward-month 1))))
  13905. (org-defkey minibuffer-local-map [(meta shift right)]
  13906. (lambda () (interactive)
  13907. (org-eval-in-calendar '(calendar-forward-month 1))))
  13908. (org-defkey minibuffer-local-map [(meta shift up)]
  13909. (lambda () (interactive)
  13910. (org-eval-in-calendar '(calendar-backward-year 1))))
  13911. (org-defkey minibuffer-local-map [(meta shift down)]
  13912. (lambda () (interactive)
  13913. (org-eval-in-calendar '(calendar-forward-year 1))))
  13914. (org-defkey minibuffer-local-map [?\e (shift left)]
  13915. (lambda () (interactive)
  13916. (org-eval-in-calendar '(calendar-backward-month 1))))
  13917. (org-defkey minibuffer-local-map [?\e (shift right)]
  13918. (lambda () (interactive)
  13919. (org-eval-in-calendar '(calendar-forward-month 1))))
  13920. (org-defkey minibuffer-local-map [?\e (shift up)]
  13921. (lambda () (interactive)
  13922. (org-eval-in-calendar '(calendar-backward-year 1))))
  13923. (org-defkey minibuffer-local-map [?\e (shift down)]
  13924. (lambda () (interactive)
  13925. (org-eval-in-calendar '(calendar-forward-year 1))))
  13926. (org-defkey minibuffer-local-map [(shift up)]
  13927. (lambda () (interactive)
  13928. (org-eval-in-calendar '(calendar-backward-week 1))))
  13929. (org-defkey minibuffer-local-map [(shift down)]
  13930. (lambda () (interactive)
  13931. (org-eval-in-calendar '(calendar-forward-week 1))))
  13932. (org-defkey minibuffer-local-map [(shift left)]
  13933. (lambda () (interactive)
  13934. (org-eval-in-calendar '(calendar-backward-day 1))))
  13935. (org-defkey minibuffer-local-map [(shift right)]
  13936. (lambda () (interactive)
  13937. (org-eval-in-calendar '(calendar-forward-day 1))))
  13938. (org-defkey minibuffer-local-map ">"
  13939. (lambda () (interactive)
  13940. (org-eval-in-calendar '(scroll-calendar-left 1))))
  13941. (org-defkey minibuffer-local-map "<"
  13942. (lambda () (interactive)
  13943. (org-eval-in-calendar '(scroll-calendar-right 1))))
  13944. (org-defkey minibuffer-local-map "\C-v"
  13945. (lambda () (interactive)
  13946. (org-eval-in-calendar
  13947. '(calendar-scroll-left-three-months 1))))
  13948. (org-defkey minibuffer-local-map "\M-v"
  13949. (lambda () (interactive)
  13950. (org-eval-in-calendar
  13951. '(calendar-scroll-right-three-months 1))))
  13952. (run-hooks 'org-read-date-minibuffer-setup-hook)
  13953. (unwind-protect
  13954. (progn
  13955. (use-local-map map)
  13956. (setq org-read-date-inactive inactive)
  13957. (add-hook 'post-command-hook 'org-read-date-display)
  13958. (setq org-ans0 (read-string prompt default-input
  13959. 'org-read-date-history nil))
  13960. ;; org-ans0: from prompt
  13961. ;; org-ans1: from mouse click
  13962. ;; org-ans2: from calendar motion
  13963. (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
  13964. (remove-hook 'post-command-hook 'org-read-date-display)
  13965. (use-local-map old-map)
  13966. (when org-read-date-overlay
  13967. (delete-overlay org-read-date-overlay)
  13968. (setq org-read-date-overlay nil)))))
  13969. (bury-buffer "*Calendar*")))))
  13970. (t ; Naked prompt only
  13971. (unwind-protect
  13972. (setq ans (read-string prompt default-input
  13973. 'org-read-date-history timestr))
  13974. (when org-read-date-overlay
  13975. (delete-overlay org-read-date-overlay)
  13976. (setq org-read-date-overlay nil)))))
  13977. (setq final (org-read-date-analyze ans org-def org-defdecode))
  13978. (when org-read-date-analyze-forced-year
  13979. (message "Year was forced into %s"
  13980. (if org-read-date-force-compatible-dates
  13981. "compatible range (1970-2037)"
  13982. "range representable on this machine"))
  13983. (ding))
  13984. ;; One round trip to get rid of 34th of August and stuff like that....
  13985. (setq final (decode-time (apply 'encode-time final)))
  13986. (setq org-read-date-final-answer ans)
  13987. (if to-time
  13988. (apply 'encode-time final)
  13989. (if (and (boundp 'org-time-was-given) org-time-was-given)
  13990. (format "%04d-%02d-%02d %02d:%02d"
  13991. (nth 5 final) (nth 4 final) (nth 3 final)
  13992. (nth 2 final) (nth 1 final))
  13993. (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
  13994. (defvar org-def)
  13995. (defvar org-defdecode)
  13996. (defvar org-with-time)
  13997. (defun org-read-date-display ()
  13998. "Display the current date prompt interpretation in the minibuffer."
  13999. (when org-read-date-display-live
  14000. (when org-read-date-overlay
  14001. (delete-overlay org-read-date-overlay))
  14002. (when (minibufferp (current-buffer))
  14003. (save-excursion
  14004. (end-of-line 1)
  14005. (while (not (equal (buffer-substring
  14006. (max (point-min) (- (point) 4)) (point))
  14007. " "))
  14008. (insert " ")))
  14009. (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
  14010. " " (or org-ans1 org-ans2)))
  14011. (org-end-time-was-given nil)
  14012. (f (org-read-date-analyze ans org-def org-defdecode))
  14013. (fmts (if org-dcst
  14014. org-time-stamp-custom-formats
  14015. org-time-stamp-formats))
  14016. (fmt (if (or org-with-time
  14017. (and (boundp 'org-time-was-given) org-time-was-given))
  14018. (cdr fmts)
  14019. (car fmts)))
  14020. (txt (format-time-string fmt (apply 'encode-time f)))
  14021. (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
  14022. (txt (concat "=> " txt)))
  14023. (when (and org-end-time-was-given
  14024. (string-match org-plain-time-of-day-regexp txt))
  14025. (setq txt (concat (substring txt 0 (match-end 0)) "-"
  14026. org-end-time-was-given
  14027. (substring txt (match-end 0)))))
  14028. (when org-read-date-analyze-futurep
  14029. (setq txt (concat txt " (=>F)")))
  14030. (setq org-read-date-overlay
  14031. (make-overlay (1- (point-at-eol)) (point-at-eol)))
  14032. (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
  14033. (defun org-read-date-analyze (ans org-def org-defdecode)
  14034. "Analyze the combined answer of the date prompt."
  14035. ;; FIXME: cleanup and comment
  14036. (let ((nowdecode (decode-time (current-time)))
  14037. delta deltan deltaw deltadef year month day
  14038. hour minute second wday pm h2 m2 tl wday1
  14039. iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
  14040. (setq org-read-date-analyze-futurep nil
  14041. org-read-date-analyze-forced-year nil)
  14042. (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
  14043. (setq ans "+0"))
  14044. (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
  14045. (setq ans (replace-match "" t t ans)
  14046. deltan (car delta)
  14047. deltaw (nth 1 delta)
  14048. deltadef (nth 2 delta)))
  14049. ;; Check if there is an iso week date in there
  14050. ;; If yes, store the info and postpone interpreting it until the rest
  14051. ;; of the parsing is done
  14052. (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
  14053. (setq iso-year (if (match-end 1)
  14054. (org-small-year-to-year
  14055. (string-to-number (match-string 1 ans))))
  14056. iso-weekday (if (match-end 3)
  14057. (string-to-number (match-string 3 ans)))
  14058. iso-week (string-to-number (match-string 2 ans)))
  14059. (setq ans (replace-match "" t t ans)))
  14060. ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
  14061. (when (string-match
  14062. "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
  14063. (setq year (if (match-end 2)
  14064. (string-to-number (match-string 2 ans))
  14065. (progn (setq kill-year t)
  14066. (string-to-number (format-time-string "%Y"))))
  14067. month (string-to-number (match-string 3 ans))
  14068. day (string-to-number (match-string 4 ans)))
  14069. (if (< year 100) (setq year (+ 2000 year)))
  14070. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14071. t nil ans)))
  14072. ;; Help matching dotted european dates
  14073. (when (string-match
  14074. "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
  14075. (setq year (if (match-end 3)
  14076. (string-to-number (match-string 3 ans))
  14077. (progn (setq kill-year t)
  14078. (string-to-number (format-time-string "%Y"))))
  14079. day (string-to-number (match-string 1 ans))
  14080. month (string-to-number (match-string 2 ans))
  14081. ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14082. t nil ans)))
  14083. ;; Help matching american dates, like 5/30 or 5/30/7
  14084. (when (string-match
  14085. "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
  14086. (setq year (if (match-end 4)
  14087. (string-to-number (match-string 4 ans))
  14088. (progn (setq kill-year t)
  14089. (string-to-number (format-time-string "%Y"))))
  14090. month (string-to-number (match-string 1 ans))
  14091. day (string-to-number (match-string 2 ans)))
  14092. (if (< year 100) (setq year (+ 2000 year)))
  14093. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  14094. t nil ans)))
  14095. ;; Help matching am/pm times, because `parse-time-string' does not do that.
  14096. ;; If there is a time with am/pm, and *no* time without it, we convert
  14097. ;; so that matching will be successful.
  14098. (loop for i from 1 to 2 do ; twice, for end time as well
  14099. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  14100. (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
  14101. (setq hour (string-to-number (match-string 1 ans))
  14102. minute (if (match-end 3)
  14103. (string-to-number (match-string 3 ans))
  14104. 0)
  14105. pm (equal ?p
  14106. (string-to-char (downcase (match-string 4 ans)))))
  14107. (if (and (= hour 12) (not pm))
  14108. (setq hour 0)
  14109. (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
  14110. (setq ans (replace-match (format "%02d:%02d" hour minute)
  14111. t t ans))))
  14112. ;; Check if a time range is given as a duration
  14113. (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
  14114. (setq hour (string-to-number (match-string 1 ans))
  14115. h2 (+ hour (string-to-number (match-string 3 ans)))
  14116. minute (string-to-number (match-string 2 ans))
  14117. m2 (+ minute (if (match-end 5) (string-to-number
  14118. (match-string 5 ans))0)))
  14119. (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
  14120. (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
  14121. t t ans)))
  14122. ;; Check if there is a time range
  14123. (when (boundp 'org-end-time-was-given)
  14124. (setq org-time-was-given nil)
  14125. (when (and (string-match org-plain-time-of-day-regexp ans)
  14126. (match-end 8))
  14127. (setq org-end-time-was-given (match-string 8 ans))
  14128. (setq ans (concat (substring ans 0 (match-beginning 7))
  14129. (substring ans (match-end 7))))))
  14130. (setq tl (parse-time-string ans)
  14131. day (or (nth 3 tl) (nth 3 org-defdecode))
  14132. month (or (nth 4 tl)
  14133. (if (and org-read-date-prefer-future
  14134. (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
  14135. (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
  14136. (nth 4 org-defdecode)))
  14137. year (or (and (not kill-year) (nth 5 tl))
  14138. (if (and org-read-date-prefer-future
  14139. (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
  14140. (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
  14141. (nth 5 org-defdecode)))
  14142. hour (or (nth 2 tl) (nth 2 org-defdecode))
  14143. minute (or (nth 1 tl) (nth 1 org-defdecode))
  14144. second (or (nth 0 tl) 0)
  14145. wday (nth 6 tl))
  14146. (when (and (eq org-read-date-prefer-future 'time)
  14147. (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
  14148. (equal day (nth 3 nowdecode))
  14149. (equal month (nth 4 nowdecode))
  14150. (equal year (nth 5 nowdecode))
  14151. (nth 2 tl)
  14152. (or (< (nth 2 tl) (nth 2 nowdecode))
  14153. (and (= (nth 2 tl) (nth 2 nowdecode))
  14154. (nth 1 tl)
  14155. (< (nth 1 tl) (nth 1 nowdecode)))))
  14156. (setq day (1+ day)
  14157. futurep t))
  14158. ;; Special date definitions below
  14159. (cond
  14160. (iso-week
  14161. ;; There was an iso week
  14162. (require 'cal-iso)
  14163. (setq futurep nil)
  14164. (setq year (or iso-year year)
  14165. day (or iso-weekday wday 1)
  14166. wday nil ; to make sure that the trigger below does not match
  14167. iso-date (calendar-gregorian-from-absolute
  14168. (calendar-absolute-from-iso
  14169. (list iso-week day year))))
  14170. ; FIXME: Should we also push ISO weeks into the future?
  14171. ; (when (and org-read-date-prefer-future
  14172. ; (not iso-year)
  14173. ; (< (calendar-absolute-from-gregorian iso-date)
  14174. ; (time-to-days (current-time))))
  14175. ; (setq year (1+ year)
  14176. ; iso-date (calendar-gregorian-from-absolute
  14177. ; (calendar-absolute-from-iso
  14178. ; (list iso-week day year)))))
  14179. (setq month (car iso-date)
  14180. year (nth 2 iso-date)
  14181. day (nth 1 iso-date)))
  14182. (deltan
  14183. (setq futurep nil)
  14184. (unless deltadef
  14185. (let ((now (decode-time (current-time))))
  14186. (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
  14187. (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
  14188. ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
  14189. ((equal deltaw "m") (setq month (+ month deltan)))
  14190. ((equal deltaw "y") (setq year (+ year deltan)))))
  14191. ((and wday (not (nth 3 tl)))
  14192. (setq futurep nil)
  14193. ;; Weekday was given, but no day, so pick that day in the week
  14194. ;; on or after the derived date.
  14195. (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
  14196. (unless (equal wday wday1)
  14197. (setq day (+ day (% (- wday wday1 -7) 7))))))
  14198. (if (and (boundp 'org-time-was-given)
  14199. (nth 2 tl))
  14200. (setq org-time-was-given t))
  14201. (if (< year 100) (setq year (+ 2000 year)))
  14202. ;; Check of the date is representable
  14203. (if org-read-date-force-compatible-dates
  14204. (progn
  14205. (if (< year 1970)
  14206. (setq year 1970 org-read-date-analyze-forced-year t))
  14207. (if (> year 2037)
  14208. (setq year 2037 org-read-date-analyze-forced-year t)))
  14209. (condition-case nil
  14210. (ignore (encode-time second minute hour day month year))
  14211. (error
  14212. (setq year (nth 5 org-defdecode))
  14213. (setq org-read-date-analyze-forced-year t))))
  14214. (setq org-read-date-analyze-futurep futurep)
  14215. (list second minute hour day month year)))
  14216. (defvar parse-time-weekdays)
  14217. (defun org-read-date-get-relative (s today default)
  14218. "Check string S for special relative date string.
  14219. TODAY and DEFAULT are internal times, for today and for a default.
  14220. Return shift list (N what def-flag)
  14221. WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
  14222. N is the number of WHATs to shift.
  14223. DEF-FLAG is t when a double ++ or -- indicates shift relative to
  14224. the DEFAULT date rather than TODAY."
  14225. (require 'parse-time)
  14226. (when (and
  14227. (string-match
  14228. (concat
  14229. "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
  14230. "\\([0-9]+\\)?"
  14231. "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
  14232. "\\([ \t]\\|$\\)") s)
  14233. (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
  14234. (let* ((dir (if (> (match-end 1) (match-beginning 1))
  14235. (string-to-char (substring (match-string 1 s) -1))
  14236. ?+))
  14237. (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
  14238. (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
  14239. (what (if (match-end 3) (match-string 3 s) "d"))
  14240. (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
  14241. (date (if rel default today))
  14242. (wday (nth 6 (decode-time date)))
  14243. delta)
  14244. (if wday1
  14245. (progn
  14246. (setq delta (mod (+ 7 (- wday1 wday)) 7))
  14247. (if (= dir ?-) (setq delta (- delta 7)))
  14248. (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
  14249. (list delta "d" rel))
  14250. (list (* n (if (= dir ?-) -1 1)) what rel)))))
  14251. (defun org-order-calendar-date-args (arg1 arg2 arg3)
  14252. "Turn a user-specified date into the internal representation.
  14253. The internal representation needed by the calendar is (month day year).
  14254. This is a wrapper to handle the brain-dead convention in calendar that
  14255. user function argument order change dependent on argument order."
  14256. (if (boundp 'calendar-date-style)
  14257. (cond
  14258. ((eq calendar-date-style 'american)
  14259. (list arg1 arg2 arg3))
  14260. ((eq calendar-date-style 'european)
  14261. (list arg2 arg1 arg3))
  14262. ((eq calendar-date-style 'iso)
  14263. (list arg2 arg3 arg1)))
  14264. (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
  14265. (if (org-bound-and-true-p european-calendar-style)
  14266. (list arg2 arg1 arg3)
  14267. (list arg1 arg2 arg3)))))
  14268. (defun org-eval-in-calendar (form &optional keepdate)
  14269. "Eval FORM in the calendar window and return to current window.
  14270. When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
  14271. otherwise stick to the current value of `org-ans2'."
  14272. (let ((sf (selected-frame))
  14273. (sw (selected-window)))
  14274. (select-window (get-buffer-window "*Calendar*" t))
  14275. (eval form)
  14276. (when (and (not keepdate) (calendar-cursor-to-date))
  14277. (let* ((date (calendar-cursor-to-date))
  14278. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14279. (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
  14280. (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
  14281. (select-window sw)
  14282. (org-select-frame-set-input-focus sf)))
  14283. (defun org-calendar-select ()
  14284. "Return to `org-read-date' with the date currently selected.
  14285. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  14286. (interactive)
  14287. (when (calendar-cursor-to-date)
  14288. (let* ((date (calendar-cursor-to-date))
  14289. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14290. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  14291. (if (active-minibuffer-window) (exit-minibuffer))))
  14292. (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
  14293. "Insert a date stamp for the date given by the internal TIME.
  14294. WITH-HM means use the stamp format that includes the time of the day.
  14295. INACTIVE means use square brackets instead of angular ones, so that the
  14296. stamp will not contribute to the agenda.
  14297. PRE and POST are optional strings to be inserted before and after the
  14298. stamp.
  14299. The command returns the inserted time stamp."
  14300. (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
  14301. stamp)
  14302. (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
  14303. (insert-before-markers (or pre ""))
  14304. (when (listp extra)
  14305. (setq extra (car extra))
  14306. (if (and (stringp extra)
  14307. (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
  14308. (setq extra (format "-%02d:%02d"
  14309. (string-to-number (match-string 1 extra))
  14310. (string-to-number (match-string 2 extra))))
  14311. (setq extra nil)))
  14312. (when extra
  14313. (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
  14314. (insert-before-markers (setq stamp (format-time-string fmt time)))
  14315. (insert-before-markers (or post ""))
  14316. (setq org-last-inserted-timestamp stamp)))
  14317. (defun org-toggle-time-stamp-overlays ()
  14318. "Toggle the use of custom time stamp formats."
  14319. (interactive)
  14320. (setq org-display-custom-times (not org-display-custom-times))
  14321. (unless org-display-custom-times
  14322. (let ((p (point-min)) (bmp (buffer-modified-p)))
  14323. (while (setq p (next-single-property-change p 'display))
  14324. (if (and (get-text-property p 'display)
  14325. (eq (get-text-property p 'face) 'org-date))
  14326. (remove-text-properties
  14327. p (setq p (next-single-property-change p 'display))
  14328. '(display t))))
  14329. (set-buffer-modified-p bmp)))
  14330. (if (featurep 'xemacs)
  14331. (remove-text-properties (point-min) (point-max) '(end-glyph t)))
  14332. (org-restart-font-lock)
  14333. (setq org-table-may-need-update t)
  14334. (if org-display-custom-times
  14335. (message "Time stamps are overlaid with custom format")
  14336. (message "Time stamp overlays removed")))
  14337. (defun org-display-custom-time (beg end)
  14338. "Overlay modified time stamp format over timestamp between BEG and END."
  14339. (let* ((ts (buffer-substring beg end))
  14340. t1 w1 with-hm tf time str w2 (off 0))
  14341. (save-match-data
  14342. (setq t1 (org-parse-time-string ts t))
  14343. (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
  14344. (setq off (- (match-end 0) (match-beginning 0)))))
  14345. (setq end (- end off))
  14346. (setq w1 (- end beg)
  14347. with-hm (and (nth 1 t1) (nth 2 t1))
  14348. tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
  14349. time (org-fix-decoded-time t1)
  14350. str (org-add-props
  14351. (format-time-string
  14352. (substring tf 1 -1) (apply 'encode-time time))
  14353. nil 'mouse-face 'highlight)
  14354. w2 (length str))
  14355. (if (not (= w2 w1))
  14356. (add-text-properties (1+ beg) (+ 2 beg)
  14357. (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
  14358. (if (featurep 'xemacs)
  14359. (progn
  14360. (put-text-property beg end 'invisible t)
  14361. (put-text-property beg end 'end-glyph (make-glyph str)))
  14362. (put-text-property beg end 'display str))))
  14363. (defun org-translate-time (string)
  14364. "Translate all timestamps in STRING to custom format.
  14365. But do this only if the variable `org-display-custom-times' is set."
  14366. (when org-display-custom-times
  14367. (save-match-data
  14368. (let* ((start 0)
  14369. (re org-ts-regexp-both)
  14370. t1 with-hm inactive tf time str beg end)
  14371. (while (setq start (string-match re string start))
  14372. (setq beg (match-beginning 0)
  14373. end (match-end 0)
  14374. t1 (save-match-data
  14375. (org-parse-time-string (substring string beg end) t))
  14376. with-hm (and (nth 1 t1) (nth 2 t1))
  14377. inactive (equal (substring string beg (1+ beg)) "[")
  14378. tf (funcall (if with-hm 'cdr 'car)
  14379. org-time-stamp-custom-formats)
  14380. time (org-fix-decoded-time t1)
  14381. str (format-time-string
  14382. (concat
  14383. (if inactive "[" "<") (substring tf 1 -1)
  14384. (if inactive "]" ">"))
  14385. (apply 'encode-time time))
  14386. string (replace-match str t t string)
  14387. start (+ start (length str)))))))
  14388. string)
  14389. (defun org-fix-decoded-time (time)
  14390. "Set 0 instead of nil for the first 6 elements of time.
  14391. Don't touch the rest."
  14392. (let ((n 0))
  14393. (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
  14394. (defun org-days-to-time (timestamp-string)
  14395. "Difference between TIMESTAMP-STRING and now in days."
  14396. (- (time-to-days (org-time-string-to-time timestamp-string))
  14397. (time-to-days (current-time))))
  14398. (defun org-deadline-close (timestamp-string &optional ndays)
  14399. "Is the time in TIMESTAMP-STRING close to the current date?"
  14400. (setq ndays (or ndays (org-get-wdays timestamp-string)))
  14401. (and (< (org-days-to-time timestamp-string) ndays)
  14402. (not (org-entry-is-done-p))))
  14403. (defun org-get-wdays (ts)
  14404. "Get the deadline lead time appropriate for timestring TS."
  14405. (cond
  14406. ((<= org-deadline-warning-days 0)
  14407. ;; 0 or negative, enforce this value no matter what
  14408. (- org-deadline-warning-days))
  14409. ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
  14410. ;; lead time is specified.
  14411. (floor (* (string-to-number (match-string 1 ts))
  14412. (cdr (assoc (match-string 2 ts)
  14413. '(("d" . 1) ("w" . 7)
  14414. ("m" . 30.4) ("y" . 365.25)))))))
  14415. ;; go for the default.
  14416. (t org-deadline-warning-days)))
  14417. (defun org-calendar-select-mouse (ev)
  14418. "Return to `org-read-date' with the date currently selected.
  14419. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  14420. (interactive "e")
  14421. (mouse-set-point ev)
  14422. (when (calendar-cursor-to-date)
  14423. (let* ((date (calendar-cursor-to-date))
  14424. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  14425. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  14426. (if (active-minibuffer-window) (exit-minibuffer))))
  14427. (defun org-check-deadlines (ndays)
  14428. "Check if there are any deadlines due or past due.
  14429. A deadline is considered due if it happens within `org-deadline-warning-days'
  14430. days from today's date. If the deadline appears in an entry marked DONE,
  14431. it is not shown. The prefix arg NDAYS can be used to test that many
  14432. days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
  14433. (interactive "P")
  14434. (let* ((org-warn-days
  14435. (cond
  14436. ((equal ndays '(4)) 100000)
  14437. (ndays (prefix-numeric-value ndays))
  14438. (t (abs org-deadline-warning-days))))
  14439. (case-fold-search nil)
  14440. (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  14441. (callback
  14442. (lambda () (org-deadline-close (match-string 1) org-warn-days))))
  14443. (message "%d deadlines past-due or due within %d days"
  14444. (org-occur regexp nil callback)
  14445. org-warn-days)))
  14446. (defun org-check-before-date (date)
  14447. "Check if there are deadlines or scheduled entries before DATE."
  14448. (interactive (list (org-read-date)))
  14449. (let ((case-fold-search nil)
  14450. (regexp (concat "\\<\\(" org-deadline-string
  14451. "\\|" org-scheduled-string
  14452. "\\) *<\\([^>]+\\)>"))
  14453. (callback
  14454. (lambda () (time-less-p
  14455. (org-time-string-to-time (match-string 2))
  14456. (org-time-string-to-time date)))))
  14457. (message "%d entries before %s"
  14458. (org-occur regexp nil callback) date)))
  14459. (defun org-check-after-date (date)
  14460. "Check if there are deadlines or scheduled entries after DATE."
  14461. (interactive (list (org-read-date)))
  14462. (let ((case-fold-search nil)
  14463. (regexp (concat "\\<\\(" org-deadline-string
  14464. "\\|" org-scheduled-string
  14465. "\\) *<\\([^>]+\\)>"))
  14466. (callback
  14467. (lambda () (not
  14468. (time-less-p
  14469. (org-time-string-to-time (match-string 2))
  14470. (org-time-string-to-time date))))))
  14471. (message "%d entries after %s"
  14472. (org-occur regexp nil callback) date)))
  14473. (defun org-check-dates-range (start-date end-date)
  14474. "Check for deadlines/scheduled entries between START-DATE and END-DATE."
  14475. (interactive (list (org-read-date nil nil nil "Range starts")
  14476. (org-read-date nil nil nil "Range end")))
  14477. (let ((case-fold-search nil)
  14478. (regexp (concat "\\<\\(" org-deadline-string
  14479. "\\|" org-scheduled-string
  14480. "\\) *<\\([^>]+\\)>"))
  14481. (callback
  14482. (lambda ()
  14483. (let ((match (match-string 2)))
  14484. (and
  14485. (not (time-less-p
  14486. (org-time-string-to-time match)
  14487. (org-time-string-to-time start-date)))
  14488. (time-less-p
  14489. (org-time-string-to-time match)
  14490. (org-time-string-to-time end-date)))))))
  14491. (message "%d entries between %s and %s"
  14492. (org-occur regexp nil callback) start-date end-date)))
  14493. (defun org-evaluate-time-range (&optional to-buffer)
  14494. "Evaluate a time range by computing the difference between start and end.
  14495. Normally the result is just printed in the echo area, but with prefix arg
  14496. TO-BUFFER, the result is inserted just after the date stamp into the buffer.
  14497. If the time range is actually in a table, the result is inserted into the
  14498. next column.
  14499. For time difference computation, a year is assumed to be exactly 365
  14500. days in order to avoid rounding problems."
  14501. (interactive "P")
  14502. (or
  14503. (org-clock-update-time-maybe)
  14504. (save-excursion
  14505. (unless (org-at-date-range-p t)
  14506. (goto-char (point-at-bol))
  14507. (re-search-forward org-tr-regexp-both (point-at-eol) t))
  14508. (if (not (org-at-date-range-p t))
  14509. (error "Not at a time-stamp range, and none found in current line")))
  14510. (let* ((ts1 (match-string 1))
  14511. (ts2 (match-string 2))
  14512. (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
  14513. (match-end (match-end 0))
  14514. (time1 (org-time-string-to-time ts1))
  14515. (time2 (org-time-string-to-time ts2))
  14516. (t1 (org-float-time time1))
  14517. (t2 (org-float-time time2))
  14518. (diff (abs (- t2 t1)))
  14519. (negative (< (- t2 t1) 0))
  14520. ;; (ys (floor (* 365 24 60 60)))
  14521. (ds (* 24 60 60))
  14522. (hs (* 60 60))
  14523. (fy "%dy %dd %02d:%02d")
  14524. (fy1 "%dy %dd")
  14525. (fd "%dd %02d:%02d")
  14526. (fd1 "%dd")
  14527. (fh "%02d:%02d")
  14528. y d h m align)
  14529. (if havetime
  14530. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  14531. y 0
  14532. d (floor (/ diff ds)) diff (mod diff ds)
  14533. h (floor (/ diff hs)) diff (mod diff hs)
  14534. m (floor (/ diff 60)))
  14535. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  14536. y 0
  14537. d (floor (+ (/ diff ds) 0.5))
  14538. h 0 m 0))
  14539. (if (not to-buffer)
  14540. (message "%s" (org-make-tdiff-string y d h m))
  14541. (if (org-at-table-p)
  14542. (progn
  14543. (goto-char match-end)
  14544. (setq align t)
  14545. (and (looking-at " *|") (goto-char (match-end 0))))
  14546. (goto-char match-end))
  14547. (if (looking-at
  14548. "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
  14549. (replace-match ""))
  14550. (if negative (insert " -"))
  14551. (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
  14552. (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
  14553. (insert " " (format fh h m))))
  14554. (if align (org-table-align))
  14555. (message "Time difference inserted")))))
  14556. (defun org-make-tdiff-string (y d h m)
  14557. (let ((fmt "")
  14558. (l nil))
  14559. (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
  14560. l (push y l)))
  14561. (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
  14562. l (push d l)))
  14563. (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
  14564. l (push h l)))
  14565. (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
  14566. l (push m l)))
  14567. (apply 'format fmt (nreverse l))))
  14568. (defun org-time-string-to-time (s &optional buffer pos)
  14569. (condition-case errdata
  14570. (apply 'encode-time (org-parse-time-string s))
  14571. (error (error "Bad timestamp `%s'%s\nError was: %s"
  14572. s (if (not (and buffer pos))
  14573. ""
  14574. (format " at %d in buffer `%s'" pos buffer))
  14575. (cdr errdata)))))
  14576. (defun org-time-string-to-seconds (s)
  14577. (org-float-time (org-time-string-to-time s)))
  14578. (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
  14579. "Convert a time stamp to an absolute day number.
  14580. If there is a specifier for a cyclic time stamp, get the closest date to
  14581. DAYNR.
  14582. PREFER and SHOW-ALL are passed through to `org-closest-date'.
  14583. The variable date is bound by the calendar when this is called."
  14584. (cond
  14585. ((and daynr (string-match "\\`%%\\((.*)\\)" s))
  14586. (if (org-diary-sexp-entry (match-string 1 s) "" date)
  14587. daynr
  14588. (+ daynr 1000)))
  14589. ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
  14590. (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
  14591. (time-to-days (current-time))) (match-string 0 s)
  14592. prefer show-all))
  14593. (t (time-to-days
  14594. (condition-case errdata
  14595. (apply 'encode-time (org-parse-time-string s))
  14596. (error (error "Bad timestamp `%s'%s\nError was: %s"
  14597. s (if (not (and buffer pos))
  14598. ""
  14599. (format " at %d in buffer `%s'" pos buffer))
  14600. (cdr errdata))))))))
  14601. (defun org-days-to-iso-week (days)
  14602. "Return the iso week number."
  14603. (require 'cal-iso)
  14604. (car (calendar-iso-from-absolute days)))
  14605. (defun org-small-year-to-year (year)
  14606. "Convert 2-digit years into 4-digit years.
  14607. 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
  14608. The year 2000 cannot be abbreviated. Any year larger than 99
  14609. is returned unchanged."
  14610. (if (< year 38)
  14611. (setq year (+ 2000 year))
  14612. (if (< year 100)
  14613. (setq year (+ 1900 year))))
  14614. year)
  14615. (defun org-time-from-absolute (d)
  14616. "Return the time corresponding to date D.
  14617. D may be an absolute day number, or a calendar-type list (month day year)."
  14618. (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
  14619. (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
  14620. (defun org-calendar-holiday ()
  14621. "List of holidays, for Diary display in Org-mode."
  14622. (require 'holidays)
  14623. (let ((hl (funcall
  14624. (if (fboundp 'calendar-check-holidays)
  14625. 'calendar-check-holidays 'check-calendar-holidays) date)))
  14626. (if hl (mapconcat 'identity hl "; "))))
  14627. (defun org-diary-sexp-entry (sexp entry date)
  14628. "Process a SEXP diary ENTRY for DATE."
  14629. (require 'diary-lib)
  14630. (let ((result (if calendar-debug-sexp
  14631. (let ((stack-trace-on-error t))
  14632. (eval (car (read-from-string sexp))))
  14633. (condition-case nil
  14634. (eval (car (read-from-string sexp)))
  14635. (error
  14636. (beep)
  14637. (message "Bad sexp at line %d in %s: %s"
  14638. (org-current-line)
  14639. (buffer-file-name) sexp)
  14640. (sleep-for 2))))))
  14641. (cond ((stringp result) (split-string result "; "))
  14642. ((and (consp result)
  14643. (not (consp (cdr result)))
  14644. (stringp (cdr result))) (cdr result))
  14645. ((and (consp result)
  14646. (stringp (car result))) result)
  14647. (result entry)
  14648. (t nil))))
  14649. (defun org-diary-to-ical-string (frombuf)
  14650. "Get iCalendar entries from diary entries in buffer FROMBUF.
  14651. This uses the icalendar.el library."
  14652. (let* ((tmpdir (if (featurep 'xemacs)
  14653. (temp-directory)
  14654. temporary-file-directory))
  14655. (tmpfile (make-temp-name
  14656. (expand-file-name "orgics" tmpdir)))
  14657. buf rtn b e)
  14658. (with-current-buffer frombuf
  14659. (icalendar-export-region (point-min) (point-max) tmpfile)
  14660. (setq buf (find-buffer-visiting tmpfile))
  14661. (set-buffer buf)
  14662. (goto-char (point-min))
  14663. (if (re-search-forward "^BEGIN:VEVENT" nil t)
  14664. (setq b (match-beginning 0)))
  14665. (goto-char (point-max))
  14666. (if (re-search-backward "^END:VEVENT" nil t)
  14667. (setq e (match-end 0)))
  14668. (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
  14669. (kill-buffer buf)
  14670. (delete-file tmpfile)
  14671. rtn))
  14672. (defun org-closest-date (start current change prefer show-all)
  14673. "Find the date closest to CURRENT that is consistent with START and CHANGE.
  14674. When PREFER is `past', return a date that is either CURRENT or past.
  14675. When PREFER is `future', return a date that is either CURRENT or future.
  14676. When SHOW-ALL is nil, only return the current occurrence of a time stamp."
  14677. ;; Make the proper lists from the dates
  14678. (catch 'exit
  14679. (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
  14680. dn dw sday cday n1 n2 n0
  14681. d m y y1 y2 date1 date2 nmonths nm ny m2)
  14682. (setq start (org-date-to-gregorian start)
  14683. current (org-date-to-gregorian
  14684. (if show-all
  14685. current
  14686. (time-to-days (current-time))))
  14687. sday (calendar-absolute-from-gregorian start)
  14688. cday (calendar-absolute-from-gregorian current))
  14689. (if (<= cday sday) (throw 'exit sday))
  14690. (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
  14691. (setq dn (string-to-number (match-string 1 change))
  14692. dw (cdr (assoc (match-string 2 change) a1)))
  14693. (error "Invalid change specifier: %s" change))
  14694. (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
  14695. (cond
  14696. ((eq dw 'day)
  14697. (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
  14698. n2 (+ n1 dn)))
  14699. ((eq dw 'year)
  14700. (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
  14701. (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
  14702. (setq date1 (list m d y1)
  14703. n1 (calendar-absolute-from-gregorian date1)
  14704. date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
  14705. n2 (calendar-absolute-from-gregorian date2)))
  14706. ((eq dw 'month)
  14707. ;; approx number of month between the two dates
  14708. (setq nmonths (floor (/ (- cday sday) 30.436875)))
  14709. ;; How often does dn fit in there?
  14710. (setq d (nth 1 start) m (car start) y (nth 2 start)
  14711. nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
  14712. m (+ m nm)
  14713. ny (floor (/ m 12))
  14714. y (+ y ny)
  14715. m (- m (* ny 12)))
  14716. (while (> m 12) (setq m (- m 12) y (1+ y)))
  14717. (setq n1 (calendar-absolute-from-gregorian (list m d y)))
  14718. (setq m2 (+ m dn) y2 y)
  14719. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  14720. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
  14721. (while (<= n2 cday)
  14722. (setq n1 n2 m m2 y y2)
  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. ;; Make sure n1 is the earlier date
  14727. (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
  14728. (if show-all
  14729. (cond
  14730. ((eq prefer 'past) (if (= cday n2) n2 n1))
  14731. ((eq prefer 'future) (if (= cday n1) n1 n2))
  14732. (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
  14733. (cond
  14734. ((eq prefer 'past) (if (= cday n2) n2 n1))
  14735. ((eq prefer 'future) (if (= cday n1) n1 n2))
  14736. (t (if (= cday n1) n1 n2)))))))
  14737. (defun org-date-to-gregorian (date)
  14738. "Turn any specification of DATE into a Gregorian date for the calendar."
  14739. (cond ((integerp date) (calendar-gregorian-from-absolute date))
  14740. ((and (listp date) (= (length date) 3)) date)
  14741. ((stringp date)
  14742. (setq date (org-parse-time-string date))
  14743. (list (nth 4 date) (nth 3 date) (nth 5 date)))
  14744. ((listp date)
  14745. (list (nth 4 date) (nth 3 date) (nth 5 date)))))
  14746. (defun org-parse-time-string (s &optional nodefault)
  14747. "Parse the standard Org-mode time string.
  14748. This should be a lot faster than the normal `parse-time-string'.
  14749. If time is not given, defaults to 0:00. However, with optional NODEFAULT,
  14750. hour and minute fields will be nil if not given."
  14751. (if (string-match org-ts-regexp0 s)
  14752. (list 0
  14753. (if (or (match-beginning 8) (not nodefault))
  14754. (string-to-number (or (match-string 8 s) "0")))
  14755. (if (or (match-beginning 7) (not nodefault))
  14756. (string-to-number (or (match-string 7 s) "0")))
  14757. (string-to-number (match-string 4 s))
  14758. (string-to-number (match-string 3 s))
  14759. (string-to-number (match-string 2 s))
  14760. nil nil nil)
  14761. (error "Not a standard Org-mode time string: %s" s)))
  14762. (defun org-timestamp-up (&optional arg)
  14763. "Increase the date item at the cursor by one.
  14764. If the cursor is on the year, change the year. If it is on the month,
  14765. the day or the time, change that.
  14766. With prefix ARG, change by that many units."
  14767. (interactive "p")
  14768. (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
  14769. (defun org-timestamp-down (&optional arg)
  14770. "Decrease the date item at the cursor by one.
  14771. If the cursor is on the year, change the year. If it is on the month,
  14772. the day or the time, change that.
  14773. With prefix ARG, change by that many units."
  14774. (interactive "p")
  14775. (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
  14776. (defun org-timestamp-up-day (&optional arg)
  14777. "Increase the date in the time stamp by one day.
  14778. With prefix ARG, change that many days."
  14779. (interactive "p")
  14780. (if (and (not (org-at-timestamp-p t))
  14781. (org-at-heading-p))
  14782. (org-todo 'up)
  14783. (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
  14784. (defun org-timestamp-down-day (&optional arg)
  14785. "Decrease the date in the time stamp by one day.
  14786. With prefix ARG, change that many days."
  14787. (interactive "p")
  14788. (if (and (not (org-at-timestamp-p t))
  14789. (org-at-heading-p))
  14790. (org-todo 'down)
  14791. (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
  14792. (defun org-at-timestamp-p (&optional inactive-ok)
  14793. "Determine if the cursor is in or at a timestamp."
  14794. (interactive)
  14795. (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
  14796. (pos (point))
  14797. (ans (or (looking-at tsr)
  14798. (save-excursion
  14799. (skip-chars-backward "^[<\n\r\t")
  14800. (if (> (point) (point-min)) (backward-char 1))
  14801. (and (looking-at tsr)
  14802. (> (- (match-end 0) pos) -1))))))
  14803. (and ans
  14804. (boundp 'org-ts-what)
  14805. (setq org-ts-what
  14806. (cond
  14807. ((= pos (match-beginning 0)) 'bracket)
  14808. ;; Point is considered to be "on the bracket" whether
  14809. ;; it's really on it or right after it.
  14810. ((= pos (1- (match-end 0))) 'bracket)
  14811. ((= pos (match-end 0)) 'after)
  14812. ((org-pos-in-match-range pos 2) 'year)
  14813. ((org-pos-in-match-range pos 3) 'month)
  14814. ((org-pos-in-match-range pos 7) 'hour)
  14815. ((org-pos-in-match-range pos 8) 'minute)
  14816. ((or (org-pos-in-match-range pos 4)
  14817. (org-pos-in-match-range pos 5)) 'day)
  14818. ((and (> pos (or (match-end 8) (match-end 5)))
  14819. (< pos (match-end 0)))
  14820. (- pos (or (match-end 8) (match-end 5))))
  14821. (t 'day))))
  14822. ans))
  14823. (defun org-toggle-timestamp-type ()
  14824. "Toggle the type (<active> or [inactive]) of a time stamp."
  14825. (interactive)
  14826. (when (org-at-timestamp-p t)
  14827. (let ((beg (match-beginning 0)) (end (match-end 0))
  14828. (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
  14829. (save-excursion
  14830. (goto-char beg)
  14831. (while (re-search-forward "[][<>]" end t)
  14832. (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
  14833. t t)))
  14834. (message "Timestamp is now %sactive"
  14835. (if (equal (char-after beg) ?<) "" "in")))))
  14836. (defun org-timestamp-change (n &optional what updown)
  14837. "Change the date in the time stamp at point.
  14838. The date will be changed by N times WHAT. WHAT can be `day', `month',
  14839. `year', `minute', `second'. If WHAT is not given, the cursor position
  14840. in the timestamp determines what will be changed."
  14841. (let ((origin (point)) origin-cat
  14842. with-hm inactive
  14843. (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
  14844. org-ts-what
  14845. extra rem
  14846. ts time time0)
  14847. (if (not (org-at-timestamp-p t))
  14848. (error "Not at a timestamp"))
  14849. (if (and (not what) (eq org-ts-what 'bracket))
  14850. (org-toggle-timestamp-type)
  14851. ;; Point isn't on brackets. Remember the part of the time-stamp
  14852. ;; the point was in. Indeed, size of time-stamps may change,
  14853. ;; but point must be kept in the same category nonetheless.
  14854. (setq origin-cat org-ts-what)
  14855. (if (and (not what) (not (eq org-ts-what 'day))
  14856. org-display-custom-times
  14857. (get-text-property (point) 'display)
  14858. (not (get-text-property (1- (point)) 'display)))
  14859. (setq org-ts-what 'day))
  14860. (setq org-ts-what (or what org-ts-what)
  14861. inactive (= (char-after (match-beginning 0)) ?\[)
  14862. ts (match-string 0))
  14863. (replace-match "")
  14864. (if (string-match
  14865. "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
  14866. ts)
  14867. (setq extra (match-string 1 ts)))
  14868. (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
  14869. (setq with-hm t))
  14870. (setq time0 (org-parse-time-string ts))
  14871. (when (and updown
  14872. (eq org-ts-what 'minute)
  14873. (not current-prefix-arg))
  14874. ;; This looks like s-up and s-down. Change by one rounding step.
  14875. (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
  14876. (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
  14877. (setcar (cdr time0) (+ (nth 1 time0)
  14878. (if (> n 0) (- rem) (- dm rem))))))
  14879. (setq time
  14880. (encode-time (or (car time0) 0)
  14881. (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
  14882. (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
  14883. (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
  14884. (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
  14885. (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
  14886. (nthcdr 6 time0)))
  14887. (when (and (member org-ts-what '(hour minute))
  14888. extra
  14889. (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
  14890. (setq extra (org-modify-ts-extra
  14891. extra
  14892. (if (eq org-ts-what 'hour) 2 5)
  14893. n dm)))
  14894. (when (integerp org-ts-what)
  14895. (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
  14896. (if (eq what 'calendar)
  14897. (let ((cal-date (org-get-date-from-calendar)))
  14898. (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
  14899. (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
  14900. (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
  14901. (setcar time0 (or (car time0) 0))
  14902. (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
  14903. (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
  14904. (setq time (apply 'encode-time time0))))
  14905. ;; Insert the new time-stamp, and ensure point stays in the same
  14906. ;; category as before (i.e. not after the last position in that
  14907. ;; category).
  14908. (let ((pos (point)))
  14909. ;; Stay before inserted string. `save-excursion' is of no use.
  14910. (setq org-last-changed-timestamp
  14911. (org-insert-time-stamp time with-hm inactive nil nil extra))
  14912. (goto-char pos))
  14913. (save-match-data
  14914. (looking-at org-ts-regexp3)
  14915. (goto-char (cond
  14916. ;; `day' category ends before `hour' if any, or at
  14917. ;; the end of the day name.
  14918. ((eq origin-cat 'day)
  14919. (min (or (match-beginning 7) (1- (match-end 5))) origin))
  14920. ((eq origin-cat 'hour) (min (match-end 7) origin))
  14921. ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
  14922. ((integerp origin-cat) (min (1- (match-end 0)) origin))
  14923. ;; `year' and `month' have both fixed size: point
  14924. ;; couldn't have moved into another part.
  14925. (t origin))))
  14926. ;; Update clock if on a CLOCK line.
  14927. (org-clock-update-time-maybe)
  14928. ;; Try to recenter the calendar window, if any.
  14929. (if (and org-calendar-follow-timestamp-change
  14930. (get-buffer-window "*Calendar*" t)
  14931. (memq org-ts-what '(day month year)))
  14932. (org-recenter-calendar (time-to-days time))))))
  14933. (defun org-modify-ts-extra (s pos n dm)
  14934. "Change the different parts of the lead-time and repeat fields in timestamp."
  14935. (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
  14936. ng h m new rem)
  14937. (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
  14938. (cond
  14939. ((or (org-pos-in-match-range pos 2)
  14940. (org-pos-in-match-range pos 3))
  14941. (setq m (string-to-number (match-string 3 s))
  14942. h (string-to-number (match-string 2 s)))
  14943. (if (org-pos-in-match-range pos 2)
  14944. (setq h (+ h n))
  14945. (setq n (* dm (org-no-warnings (signum n))))
  14946. (when (not (= 0 (setq rem (% m dm))))
  14947. (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
  14948. (setq m (+ m n)))
  14949. (if (< m 0) (setq m (+ m 60) h (1- h)))
  14950. (if (> m 59) (setq m (- m 60) h (1+ h)))
  14951. (setq h (min 24 (max 0 h)))
  14952. (setq ng 1 new (format "-%02d:%02d" h m)))
  14953. ((org-pos-in-match-range pos 6)
  14954. (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
  14955. ((org-pos-in-match-range pos 5)
  14956. (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
  14957. ((org-pos-in-match-range pos 9)
  14958. (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
  14959. ((org-pos-in-match-range pos 8)
  14960. (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
  14961. (when ng
  14962. (setq s (concat
  14963. (substring s 0 (match-beginning ng))
  14964. new
  14965. (substring s (match-end ng))))))
  14966. s))
  14967. (defun org-recenter-calendar (date)
  14968. "If the calendar is visible, recenter it to DATE."
  14969. (let ((cwin (get-buffer-window "*Calendar*" t)))
  14970. (when cwin
  14971. (let ((calendar-move-hook nil))
  14972. (with-selected-window cwin
  14973. (calendar-goto-date (if (listp date) date
  14974. (calendar-gregorian-from-absolute date))))))))
  14975. (defun org-goto-calendar (&optional arg)
  14976. "Go to the Emacs calendar at the current date.
  14977. If there is a time stamp in the current line, go to that date.
  14978. A prefix ARG can be used to force the current date."
  14979. (interactive "P")
  14980. (let ((tsr org-ts-regexp) diff
  14981. (calendar-move-hook nil)
  14982. (calendar-view-holidays-initially-flag nil)
  14983. (calendar-view-diary-initially-flag nil))
  14984. (if (or (org-at-timestamp-p)
  14985. (save-excursion
  14986. (beginning-of-line 1)
  14987. (looking-at (concat ".*" tsr))))
  14988. (let ((d1 (time-to-days (current-time)))
  14989. (d2 (time-to-days
  14990. (org-time-string-to-time (match-string 1)))))
  14991. (setq diff (- d2 d1))))
  14992. (calendar)
  14993. (calendar-goto-today)
  14994. (if (and diff (not arg)) (calendar-forward-day diff))))
  14995. (defun org-get-date-from-calendar ()
  14996. "Return a list (month day year) of date at point in calendar."
  14997. (with-current-buffer "*Calendar*"
  14998. (save-match-data
  14999. (calendar-cursor-to-date))))
  15000. (defun org-date-from-calendar ()
  15001. "Insert time stamp corresponding to cursor date in *Calendar* buffer.
  15002. If there is already a time stamp at the cursor position, update it."
  15003. (interactive)
  15004. (if (org-at-timestamp-p t)
  15005. (org-timestamp-change 0 'calendar)
  15006. (let ((cal-date (org-get-date-from-calendar)))
  15007. (org-insert-time-stamp
  15008. (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
  15009. (defun org-minutes-to-hh:mm-string (m)
  15010. "Compute H:MM from a number of minutes."
  15011. (let ((h (/ m 60)))
  15012. (setq m (- m (* 60 h)))
  15013. (format org-time-clocksum-format h m)))
  15014. (defun org-hh:mm-string-to-minutes (s)
  15015. "Convert a string H:MM to a number of minutes.
  15016. If the string is just a number, interpret it as minutes.
  15017. In fact, the first hh:mm or number in the string will be taken,
  15018. there can be extra stuff in the string.
  15019. If no number is found, the return value is 0."
  15020. (cond
  15021. ((integerp s) s)
  15022. ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
  15023. (+ (* (string-to-number (match-string 1 s)) 60)
  15024. (string-to-number (match-string 2 s))))
  15025. ((string-match "\\([0-9]+\\)" s)
  15026. (string-to-number (match-string 1 s)))
  15027. (t 0)))
  15028. (defcustom org-effort-durations
  15029. `(("h" . 60)
  15030. ("d" . ,(* 60 8))
  15031. ("w" . ,(* 60 8 5))
  15032. ("m" . ,(* 60 8 5 4))
  15033. ("y" . ,(* 60 8 5 40)))
  15034. "Conversion factor to minutes for an effort modifier.
  15035. Each entry has the form (MODIFIER . MINUTES).
  15036. In an effort string, a number followed by MODIFIER is multiplied
  15037. by the specified number of MINUTES to obtain an effort in
  15038. minutes.
  15039. For example, if the value of this variable is ((\"hours\" . 60)), then an
  15040. effort string \"2hours\" is equivalent to 120 minutes."
  15041. :group 'org-agenda
  15042. :version "24.1"
  15043. :type '(alist :key-type (string :tag "Modifier")
  15044. :value-type (number :tag "Minutes")))
  15045. (defun org-duration-string-to-minutes (s &optional output-to-string)
  15046. "Convert a duration string S to minutes.
  15047. A bare number is interpreted as minutes, modifiers can be set by
  15048. customizing `org-effort-durations' (which see).
  15049. Entries containing a colon are interpreted as H:MM by
  15050. `org-hh:mm-string-to-minutes'."
  15051. (let ((result 0)
  15052. (re (concat "\\([0-9.]+\\) *\\("
  15053. (regexp-opt (mapcar 'car org-effort-durations))
  15054. "\\)")))
  15055. (while (string-match re s)
  15056. (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
  15057. (string-to-number (match-string 1 s))))
  15058. (setq s (replace-match "" nil t s)))
  15059. (setq result (floor result))
  15060. (incf result (org-hh:mm-string-to-minutes s))
  15061. (if output-to-string (number-to-string result) result)))
  15062. ;;;; Files
  15063. (defun org-save-all-org-buffers ()
  15064. "Save all Org-mode buffers without user confirmation."
  15065. (interactive)
  15066. (message "Saving all Org-mode buffers...")
  15067. (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
  15068. (when (featurep 'org-id) (org-id-locations-save))
  15069. (message "Saving all Org-mode buffers... done"))
  15070. (defun org-revert-all-org-buffers ()
  15071. "Revert all Org-mode buffers.
  15072. Prompt for confirmation when there are unsaved changes.
  15073. Be sure you know what you are doing before letting this function
  15074. overwrite your changes.
  15075. This function is useful in a setup where one tracks org files
  15076. with a version control system, to revert on one machine after pulling
  15077. changes from another. I believe the procedure must be like this:
  15078. 1. M-x org-save-all-org-buffers
  15079. 2. Pull changes from the other machine, resolve conflicts
  15080. 3. M-x org-revert-all-org-buffers"
  15081. (interactive)
  15082. (unless (yes-or-no-p "Revert all Org buffers from their files? ")
  15083. (error "Abort"))
  15084. (save-excursion
  15085. (save-window-excursion
  15086. (mapc
  15087. (lambda (b)
  15088. (when (and (with-current-buffer b (derived-mode-p 'org-mode))
  15089. (with-current-buffer b buffer-file-name))
  15090. (org-pop-to-buffer-same-window b)
  15091. (revert-buffer t 'no-confirm)))
  15092. (buffer-list))
  15093. (when (and (featurep 'org-id) org-id-track-globally)
  15094. (org-id-locations-load)))))
  15095. ;;;; Agenda files
  15096. ;;;###autoload
  15097. (defun org-switchb (&optional arg)
  15098. "Switch between Org buffers.
  15099. With one prefix argument, restrict available buffers to files.
  15100. With two prefix arguments, restrict available buffers to agenda files.
  15101. Defaults to `iswitchb' for buffer name completion.
  15102. Set `org-completion-use-ido' to make it use ido instead."
  15103. (interactive "P")
  15104. (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
  15105. ((equal arg '(16)) (org-buffer-list 'agenda))
  15106. (t (org-buffer-list))))
  15107. (org-completion-use-iswitchb org-completion-use-iswitchb)
  15108. (org-completion-use-ido org-completion-use-ido))
  15109. (unless (or org-completion-use-ido org-completion-use-iswitchb)
  15110. (setq org-completion-use-iswitchb t))
  15111. (org-pop-to-buffer-same-window
  15112. (org-icompleting-read "Org buffer: "
  15113. (mapcar 'list (mapcar 'buffer-name blist))
  15114. nil t))))
  15115. ;;; Define some older names previously used for this functionality
  15116. ;;;###autoload
  15117. (defalias 'org-ido-switchb 'org-switchb)
  15118. ;;;###autoload
  15119. (defalias 'org-iswitchb 'org-switchb)
  15120. (defun org-buffer-list (&optional predicate exclude-tmp)
  15121. "Return a list of Org buffers.
  15122. PREDICATE can be `export', `files' or `agenda'.
  15123. export restrict the list to Export buffers.
  15124. files restrict the list to buffers visiting Org files.
  15125. agenda restrict the list to buffers visiting agenda files.
  15126. If EXCLUDE-TMP is non-nil, ignore temporary buffers."
  15127. (let* ((bfn nil)
  15128. (agenda-files (and (eq predicate 'agenda)
  15129. (mapcar 'file-truename (org-agenda-files t))))
  15130. (filter
  15131. (cond
  15132. ((eq predicate 'files)
  15133. (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
  15134. ((eq predicate 'export)
  15135. (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
  15136. ((eq predicate 'agenda)
  15137. (lambda (b)
  15138. (with-current-buffer b
  15139. (and (derived-mode-p 'org-mode)
  15140. (setq bfn (buffer-file-name b))
  15141. (member (file-truename bfn) agenda-files)))))
  15142. (t (lambda (b) (with-current-buffer b
  15143. (or (derived-mode-p 'org-mode)
  15144. (string-match "\*Org .*Export"
  15145. (buffer-name b)))))))))
  15146. (delq nil
  15147. (mapcar
  15148. (lambda(b)
  15149. (if (and (funcall filter b)
  15150. (or (not exclude-tmp)
  15151. (not (string-match "tmp" (buffer-name b)))))
  15152. b
  15153. nil))
  15154. (buffer-list)))))
  15155. (defun org-agenda-files (&optional unrestricted archives)
  15156. "Get the list of agenda files.
  15157. Optional UNRESTRICTED means return the full list even if a restriction
  15158. is currently in place.
  15159. When ARCHIVES is t, include all archive files that are really being
  15160. used by the agenda files. If ARCHIVE is `ifmode', do this only if
  15161. `org-agenda-archives-mode' is t."
  15162. (let ((files
  15163. (cond
  15164. ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
  15165. ((stringp org-agenda-files) (org-read-agenda-file-list))
  15166. ((listp org-agenda-files) org-agenda-files)
  15167. (t (error "Invalid value of `org-agenda-files'")))))
  15168. (setq files (apply 'append
  15169. (mapcar (lambda (f)
  15170. (if (file-directory-p f)
  15171. (directory-files
  15172. f t org-agenda-file-regexp)
  15173. (list f)))
  15174. files)))
  15175. (when org-agenda-skip-unavailable-files
  15176. (setq files (delq nil
  15177. (mapcar (function
  15178. (lambda (file)
  15179. (and (file-readable-p file) file)))
  15180. files))))
  15181. (when (or (eq archives t)
  15182. (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
  15183. (setq files (org-add-archive-files files)))
  15184. files))
  15185. (defun org-agenda-file-p (&optional file)
  15186. "Return non-nil, if FILE is an agenda file.
  15187. If FILE is omitted, use the file associated with the current
  15188. buffer."
  15189. (member (or file (buffer-file-name))
  15190. (org-agenda-files t)))
  15191. (defun org-edit-agenda-file-list ()
  15192. "Edit the list of agenda files.
  15193. Depending on setup, this either uses customize to edit the variable
  15194. `org-agenda-files', or it visits the file that is holding the list. In the
  15195. latter case, the buffer is set up in a way that saving it automatically kills
  15196. the buffer and restores the previous window configuration."
  15197. (interactive)
  15198. (if (stringp org-agenda-files)
  15199. (let ((cw (current-window-configuration)))
  15200. (find-file org-agenda-files)
  15201. (org-set-local 'org-window-configuration cw)
  15202. (org-add-hook 'after-save-hook
  15203. (lambda ()
  15204. (set-window-configuration
  15205. (prog1 org-window-configuration
  15206. (kill-buffer (current-buffer))))
  15207. (org-install-agenda-files-menu)
  15208. (message "New agenda file list installed"))
  15209. nil 'local)
  15210. (message "%s" (substitute-command-keys
  15211. "Edit list and finish with \\[save-buffer]")))
  15212. (customize-variable 'org-agenda-files)))
  15213. (defun org-store-new-agenda-file-list (list)
  15214. "Set new value for the agenda file list and save it correctly."
  15215. (if (stringp org-agenda-files)
  15216. (let ((fe (org-read-agenda-file-list t)) b u)
  15217. (while (setq b (find-buffer-visiting org-agenda-files))
  15218. (kill-buffer b))
  15219. (with-temp-file org-agenda-files
  15220. (insert
  15221. (mapconcat
  15222. (lambda (f) ;; Keep un-expanded entries.
  15223. (if (setq u (assoc f fe))
  15224. (cdr u)
  15225. f))
  15226. list "\n")
  15227. "\n")))
  15228. (let ((org-mode-hook nil) (org-inhibit-startup t)
  15229. (org-insert-mode-line-in-empty-file nil))
  15230. (setq org-agenda-files list)
  15231. (customize-save-variable 'org-agenda-files org-agenda-files))))
  15232. (defun org-read-agenda-file-list (&optional pair-with-expansion)
  15233. "Read the list of agenda files from a file.
  15234. If PAIR-WITH-EXPANSION is t return pairs with un-expanded
  15235. filenames, used by `org-store-new-agenda-file-list' to write back
  15236. un-expanded file names."
  15237. (when (file-directory-p org-agenda-files)
  15238. (error "`org-agenda-files' cannot be a single directory"))
  15239. (when (stringp org-agenda-files)
  15240. (with-temp-buffer
  15241. (insert-file-contents org-agenda-files)
  15242. (mapcar
  15243. (lambda (f)
  15244. (let ((e (expand-file-name (substitute-in-file-name f)
  15245. org-directory)))
  15246. (if pair-with-expansion
  15247. (cons e f)
  15248. e)))
  15249. (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
  15250. ;;;###autoload
  15251. (defun org-cycle-agenda-files ()
  15252. "Cycle through the files in `org-agenda-files'.
  15253. If the current buffer visits an agenda file, find the next one in the list.
  15254. If the current buffer does not, find the first agenda file."
  15255. (interactive)
  15256. (let* ((fs (org-agenda-files t))
  15257. (files (append fs (list (car fs))))
  15258. (tcf (if buffer-file-name (file-truename buffer-file-name)))
  15259. file)
  15260. (unless files (error "No agenda files"))
  15261. (catch 'exit
  15262. (while (setq file (pop files))
  15263. (if (equal (file-truename file) tcf)
  15264. (when (car files)
  15265. (find-file (car files))
  15266. (throw 'exit t))))
  15267. (find-file (car fs)))
  15268. (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
  15269. (defun org-agenda-file-to-front (&optional to-end)
  15270. "Move/add the current file to the top of the agenda file list.
  15271. If the file is not present in the list, it is added to the front. If it is
  15272. present, it is moved there. With optional argument TO-END, add/move to the
  15273. end of the list."
  15274. (interactive "P")
  15275. (let ((org-agenda-skip-unavailable-files nil)
  15276. (file-alist (mapcar (lambda (x)
  15277. (cons (file-truename x) x))
  15278. (org-agenda-files t)))
  15279. (ctf (file-truename buffer-file-name))
  15280. x had)
  15281. (setq x (assoc ctf file-alist) had x)
  15282. (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
  15283. (if to-end
  15284. (setq file-alist (append (delq x file-alist) (list x)))
  15285. (setq file-alist (cons x (delq x file-alist))))
  15286. (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
  15287. (org-install-agenda-files-menu)
  15288. (message "File %s to %s of agenda file list"
  15289. (if had "moved" "added") (if to-end "end" "front"))))
  15290. (defun org-remove-file (&optional file)
  15291. "Remove current file from the list of files in variable `org-agenda-files'.
  15292. These are the files which are being checked for agenda entries.
  15293. Optional argument FILE means use this file instead of the current."
  15294. (interactive)
  15295. (let* ((org-agenda-skip-unavailable-files nil)
  15296. (file (or file buffer-file-name))
  15297. (true-file (file-truename file))
  15298. (afile (abbreviate-file-name file))
  15299. (files (delq nil (mapcar
  15300. (lambda (x)
  15301. (if (equal true-file
  15302. (file-truename x))
  15303. nil x))
  15304. (org-agenda-files t)))))
  15305. (if (not (= (length files) (length (org-agenda-files t))))
  15306. (progn
  15307. (org-store-new-agenda-file-list files)
  15308. (org-install-agenda-files-menu)
  15309. (message "Removed file: %s" afile))
  15310. (message "File was not in list: %s (not removed)" afile))))
  15311. (defun org-file-menu-entry (file)
  15312. (vector file (list 'find-file file) t))
  15313. (defun org-check-agenda-file (file)
  15314. "Make sure FILE exists. If not, ask user what to do."
  15315. (when (not (file-exists-p file))
  15316. (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
  15317. (abbreviate-file-name file))
  15318. (let ((r (downcase (read-char-exclusive))))
  15319. (cond
  15320. ((equal r ?r)
  15321. (org-remove-file file)
  15322. (throw 'nextfile t))
  15323. (t (error "Abort"))))))
  15324. (defun org-get-agenda-file-buffer (file)
  15325. "Get a buffer visiting FILE. If the buffer needs to be created, add
  15326. it to the list of buffers which might be released later."
  15327. (let ((buf (org-find-base-buffer-visiting file)))
  15328. (if buf
  15329. buf ; just return it
  15330. ;; Make a new buffer and remember it
  15331. (setq buf (find-file-noselect file))
  15332. (if buf (push buf org-agenda-new-buffers))
  15333. buf)))
  15334. (defun org-release-buffers (blist)
  15335. "Release all buffers in list, asking the user for confirmation when needed.
  15336. When a buffer is unmodified, it is just killed. When modified, it is saved
  15337. \(if the user agrees) and then killed."
  15338. (let (buf file)
  15339. (while (setq buf (pop blist))
  15340. (setq file (buffer-file-name buf))
  15341. (when (and (buffer-modified-p buf)
  15342. file
  15343. (y-or-n-p (format "Save file %s? " file)))
  15344. (with-current-buffer buf (save-buffer)))
  15345. (kill-buffer buf))))
  15346. (defun org-prepare-agenda-buffers (files)
  15347. "Create buffers for all agenda files, protect archived trees and comments."
  15348. (interactive)
  15349. (let ((pa '(:org-archived t))
  15350. (pc '(:org-comment t))
  15351. (pall '(:org-archived t :org-comment t))
  15352. (inhibit-read-only t)
  15353. (rea (concat ":" org-archive-tag ":"))
  15354. bmp file re)
  15355. (save-excursion
  15356. (save-restriction
  15357. (while (setq file (pop files))
  15358. (catch 'nextfile
  15359. (if (bufferp file)
  15360. (set-buffer file)
  15361. (org-check-agenda-file file)
  15362. (set-buffer (org-get-agenda-file-buffer file)))
  15363. (widen)
  15364. (setq bmp (buffer-modified-p))
  15365. (org-refresh-category-properties)
  15366. (setq org-todo-keywords-for-agenda
  15367. (append org-todo-keywords-for-agenda org-todo-keywords-1))
  15368. (setq org-done-keywords-for-agenda
  15369. (append org-done-keywords-for-agenda org-done-keywords))
  15370. (setq org-todo-keyword-alist-for-agenda
  15371. (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
  15372. (setq org-drawers-for-agenda
  15373. (append org-drawers-for-agenda org-drawers))
  15374. (setq org-tag-alist-for-agenda
  15375. (append org-tag-alist-for-agenda org-tag-alist))
  15376. (save-excursion
  15377. (remove-text-properties (point-min) (point-max) pall)
  15378. (when org-agenda-skip-archived-trees
  15379. (goto-char (point-min))
  15380. (while (re-search-forward rea nil t)
  15381. (if (org-at-heading-p t)
  15382. (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
  15383. (goto-char (point-min))
  15384. (setq re (format org-heading-keyword-regexp-format
  15385. org-comment-string))
  15386. (while (re-search-forward re nil t)
  15387. (add-text-properties
  15388. (match-beginning 0) (org-end-of-subtree t) pc)))
  15389. (set-buffer-modified-p bmp)))))
  15390. (setq org-todo-keywords-for-agenda
  15391. (org-uniquify org-todo-keywords-for-agenda))
  15392. (setq org-todo-keyword-alist-for-agenda
  15393. (org-uniquify org-todo-keyword-alist-for-agenda)
  15394. org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
  15395. ;;;; Embedded LaTeX
  15396. (defvar org-cdlatex-mode-map (make-sparse-keymap)
  15397. "Keymap for the minor `org-cdlatex-mode'.")
  15398. (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
  15399. (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
  15400. (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
  15401. (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
  15402. (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
  15403. (defvar org-cdlatex-texmathp-advice-is-done nil
  15404. "Flag remembering if we have applied the advice to texmathp already.")
  15405. (define-minor-mode org-cdlatex-mode
  15406. "Toggle the minor `org-cdlatex-mode'.
  15407. This mode supports entering LaTeX environment and math in LaTeX fragments
  15408. in Org-mode.
  15409. \\{org-cdlatex-mode-map}"
  15410. nil " OCDL" nil
  15411. (when org-cdlatex-mode
  15412. (require 'cdlatex)
  15413. (run-hooks 'cdlatex-mode-hook)
  15414. (cdlatex-compute-tables))
  15415. (unless org-cdlatex-texmathp-advice-is-done
  15416. (setq org-cdlatex-texmathp-advice-is-done t)
  15417. (defadvice texmathp (around org-math-always-on activate)
  15418. "Always return t in org-mode buffers.
  15419. This is because we want to insert math symbols without dollars even outside
  15420. the LaTeX math segments. If Orgmode thinks that point is actually inside
  15421. an embedded LaTeX fragment, let texmathp do its job.
  15422. \\[org-cdlatex-mode-map]"
  15423. (interactive)
  15424. (let (p)
  15425. (cond
  15426. ((not (derived-mode-p 'org-mode)) ad-do-it)
  15427. ((eq this-command 'cdlatex-math-symbol)
  15428. (setq ad-return-value t
  15429. texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
  15430. (t
  15431. (let ((p (org-inside-LaTeX-fragment-p)))
  15432. (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
  15433. (setq ad-return-value t
  15434. texmathp-why '("Org-mode embedded math" . 0))
  15435. (if p ad-do-it)))))))))
  15436. (defun turn-on-org-cdlatex ()
  15437. "Unconditionally turn on `org-cdlatex-mode'."
  15438. (org-cdlatex-mode 1))
  15439. (defun org-inside-LaTeX-fragment-p ()
  15440. "Test if point is inside a LaTeX fragment.
  15441. I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
  15442. sequence appearing also before point.
  15443. Even though the matchers for math are configurable, this function assumes
  15444. that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
  15445. delimiters are skipped when they have been removed by customization.
  15446. The return value is nil, or a cons cell with the delimiter and the
  15447. position of this delimiter.
  15448. This function does a reasonably good job, but can locally be fooled by
  15449. for example currency specifications. For example it will assume being in
  15450. inline math after \"$22.34\". The LaTeX fragment formatter will only format
  15451. fragments that are properly closed, but during editing, we have to live
  15452. with the uncertainty caused by missing closing delimiters. This function
  15453. looks only before point, not after."
  15454. (catch 'exit
  15455. (let ((pos (point))
  15456. (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
  15457. (lim (progn
  15458. (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
  15459. (point)))
  15460. dd-on str (start 0) m re)
  15461. (goto-char pos)
  15462. (when dodollar
  15463. (setq str (concat (buffer-substring lim (point)) "\000 X$.")
  15464. re (nth 1 (assoc "$" org-latex-regexps)))
  15465. (while (string-match re str start)
  15466. (cond
  15467. ((= (match-end 0) (length str))
  15468. (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
  15469. ((= (match-end 0) (- (length str) 5))
  15470. (throw 'exit nil))
  15471. (t (setq start (match-end 0))))))
  15472. (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
  15473. (goto-char pos)
  15474. (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
  15475. (and (match-beginning 2) (throw 'exit nil))
  15476. ;; count $$
  15477. (while (re-search-backward "\\$\\$" lim t)
  15478. (setq dd-on (not dd-on)))
  15479. (goto-char pos)
  15480. (if dd-on (cons "$$" m))))))
  15481. (defun org-inside-latex-macro-p ()
  15482. "Is point inside a LaTeX macro or its arguments?"
  15483. (save-match-data
  15484. (org-in-regexp
  15485. "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
  15486. (defun org-try-cdlatex-tab ()
  15487. "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
  15488. It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
  15489. - inside a LaTeX fragment, or
  15490. - after the first word in a line, where an abbreviation expansion could
  15491. insert a LaTeX environment."
  15492. (when org-cdlatex-mode
  15493. (cond
  15494. ;; Before any word on the line: No expansion possible.
  15495. ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
  15496. ;; Just after first word on the line: Expand it. Make sure it
  15497. ;; cannot happen on headlines, though.
  15498. ((save-excursion
  15499. (skip-chars-backward "a-zA-Z0-9*")
  15500. (skip-chars-backward " \t")
  15501. (and (bolp) (not (org-at-heading-p))))
  15502. (cdlatex-tab) t)
  15503. ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
  15504. (defun org-cdlatex-underscore-caret (&optional arg)
  15505. "Execute `cdlatex-sub-superscript' in LaTeX fragments.
  15506. Revert to the normal definition outside of these fragments."
  15507. (interactive "P")
  15508. (if (org-inside-LaTeX-fragment-p)
  15509. (call-interactively 'cdlatex-sub-superscript)
  15510. (let (org-cdlatex-mode)
  15511. (call-interactively (key-binding (vector last-input-event))))))
  15512. (defun org-cdlatex-math-modify (&optional arg)
  15513. "Execute `cdlatex-math-modify' in LaTeX fragments.
  15514. Revert to the normal definition outside of these fragments."
  15515. (interactive "P")
  15516. (if (org-inside-LaTeX-fragment-p)
  15517. (call-interactively 'cdlatex-math-modify)
  15518. (let (org-cdlatex-mode)
  15519. (call-interactively (key-binding (vector last-input-event))))))
  15520. (defvar org-latex-fragment-image-overlays nil
  15521. "List of overlays carrying the images of latex fragments.")
  15522. (make-variable-buffer-local 'org-latex-fragment-image-overlays)
  15523. (defun org-remove-latex-fragment-image-overlays ()
  15524. "Remove all overlays with LaTeX fragment images in current buffer."
  15525. (mapc 'delete-overlay org-latex-fragment-image-overlays)
  15526. (setq org-latex-fragment-image-overlays nil))
  15527. (defun org-preview-latex-fragment (&optional subtree)
  15528. "Preview the LaTeX fragment at point, or all locally or globally.
  15529. If the cursor is in a LaTeX fragment, create the image and overlay
  15530. it over the source code. If there is no fragment at point, display
  15531. all fragments in the current text, from one headline to the next. With
  15532. prefix SUBTREE, display all fragments in the current subtree. With a
  15533. double prefix arg \\[universal-argument] \\[universal-argument], or when \
  15534. the cursor is before the first headline,
  15535. display all fragments in the buffer.
  15536. The images can be removed again with \\[org-ctrl-c-ctrl-c]."
  15537. (interactive "P")
  15538. (unless buffer-file-name
  15539. (error "Can't preview LaTeX fragment in a non-file buffer"))
  15540. (org-remove-latex-fragment-image-overlays)
  15541. (save-excursion
  15542. (save-restriction
  15543. (let (beg end at msg)
  15544. (cond
  15545. ((or (equal subtree '(16))
  15546. (not (save-excursion
  15547. (re-search-backward org-outline-regexp-bol nil t))))
  15548. (setq beg (point-min) end (point-max)
  15549. msg "Creating images for buffer...%s"))
  15550. ((equal subtree '(4))
  15551. (org-back-to-heading)
  15552. (setq beg (point) end (org-end-of-subtree t)
  15553. msg "Creating images for subtree...%s"))
  15554. (t
  15555. (if (setq at (org-inside-LaTeX-fragment-p))
  15556. (goto-char (max (point-min) (- (cdr at) 2)))
  15557. (org-back-to-heading))
  15558. (setq beg (point) end (progn (outline-next-heading) (point))
  15559. msg (if at "Creating image...%s"
  15560. "Creating images for entry...%s"))))
  15561. (message msg "")
  15562. (narrow-to-region beg end)
  15563. (goto-char beg)
  15564. (org-format-latex
  15565. (concat "ltxpng/" (file-name-sans-extension
  15566. (file-name-nondirectory
  15567. buffer-file-name)))
  15568. default-directory 'overlays msg at 'forbuffer
  15569. org-latex-create-formula-image-program)
  15570. (message msg "done. Use `C-c C-c' to remove images.")))))
  15571. (defvar org-latex-regexps
  15572. '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
  15573. ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
  15574. ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
  15575. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  15576. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  15577. ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
  15578. ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
  15579. ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
  15580. "Regular expressions for matching embedded LaTeX.")
  15581. (defvar org-export-have-math nil) ;; dynamic scoping
  15582. (defun org-format-latex (prefix &optional dir overlays msg at
  15583. forbuffer processing-type)
  15584. "Replace LaTeX fragments with links to an image, and produce images.
  15585. Some of the options can be changed using the variable
  15586. `org-format-latex-options'."
  15587. (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
  15588. (let* ((prefixnodir (file-name-nondirectory prefix))
  15589. (absprefix (expand-file-name prefix dir))
  15590. (todir (file-name-directory absprefix))
  15591. (opt org-format-latex-options)
  15592. (matchers (plist-get opt :matchers))
  15593. (re-list org-latex-regexps)
  15594. (org-format-latex-header-extra
  15595. (plist-get (org-infile-export-plist) :latex-header-extra))
  15596. (cnt 0) txt hash link beg end re e checkdir
  15597. executables-checked string
  15598. m n block-type block linkfile movefile ov)
  15599. ;; Check the different regular expressions
  15600. (while (setq e (pop re-list))
  15601. (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
  15602. block (if block-type "\n\n" ""))
  15603. (when (member m matchers)
  15604. (goto-char (point-min))
  15605. (while (re-search-forward re nil t)
  15606. (when (and (or (not at) (equal (cdr at) (match-beginning n)))
  15607. (not (get-text-property (match-beginning n)
  15608. 'org-protected))
  15609. (or (not overlays)
  15610. (not (eq (get-char-property (match-beginning n)
  15611. 'org-overlay-type)
  15612. 'org-latex-overlay))))
  15613. (setq org-export-have-math t)
  15614. (cond
  15615. ((eq processing-type 'verbatim)
  15616. ;; Leave the text verbatim, just protect it
  15617. (add-text-properties (match-beginning n) (match-end n)
  15618. '(org-protected t)))
  15619. ((eq processing-type 'mathjax)
  15620. ;; Prepare for MathJax processing
  15621. (setq string (match-string n))
  15622. (if (member m '("$" "$1"))
  15623. (save-excursion
  15624. (delete-region (match-beginning n) (match-end n))
  15625. (goto-char (match-beginning n))
  15626. (insert (org-add-props (concat "\\(" (substring string 1 -1)
  15627. "\\)")
  15628. '(org-protected t))))
  15629. (add-text-properties (match-beginning n) (match-end n)
  15630. '(org-protected t))))
  15631. ((or (eq processing-type 'dvipng)
  15632. (eq processing-type 'imagemagick))
  15633. ;; Process to an image
  15634. (setq txt (match-string n)
  15635. beg (match-beginning n) end (match-end n)
  15636. cnt (1+ cnt))
  15637. (let (print-length print-level) ; make sure full list is printed
  15638. (setq hash (sha1 (prin1-to-string
  15639. (list org-format-latex-header
  15640. org-format-latex-header-extra
  15641. org-export-latex-default-packages-alist
  15642. org-export-latex-packages-alist
  15643. org-format-latex-options
  15644. forbuffer txt)))
  15645. linkfile (format "%s_%s.png" prefix hash)
  15646. movefile (format "%s_%s.png" absprefix hash)))
  15647. (setq link (concat block "[[file:" linkfile "]]" block))
  15648. (if msg (message msg cnt))
  15649. (goto-char beg)
  15650. (unless checkdir ; make sure the directory exists
  15651. (setq checkdir t)
  15652. (or (file-directory-p todir) (make-directory todir t)))
  15653. (cond
  15654. ((eq processing-type 'dvipng)
  15655. (unless executables-checked
  15656. (org-check-external-command
  15657. "latex" "needed to convert LaTeX fragments to images")
  15658. (org-check-external-command
  15659. "dvipng" "needed to convert LaTeX fragments to images")
  15660. (setq executables-checked t))
  15661. (unless (file-exists-p movefile)
  15662. (org-create-formula-image-with-dvipng
  15663. txt movefile opt forbuffer)))
  15664. ((eq processing-type 'imagemagick)
  15665. (unless executables-checked
  15666. (org-check-external-command
  15667. "convert" "you need to install imagemagick")
  15668. (setq executables-checked t))
  15669. (unless (file-exists-p movefile)
  15670. (org-create-formula-image-with-imagemagick
  15671. txt movefile opt forbuffer))))
  15672. (if overlays
  15673. (progn
  15674. (mapc (lambda (o)
  15675. (if (eq (overlay-get o 'org-overlay-type)
  15676. 'org-latex-overlay)
  15677. (delete-overlay o)))
  15678. (overlays-in beg end))
  15679. (setq ov (make-overlay beg end))
  15680. (overlay-put ov 'org-overlay-type 'org-latex-overlay)
  15681. (if (featurep 'xemacs)
  15682. (progn
  15683. (overlay-put ov 'invisible t)
  15684. (overlay-put
  15685. ov 'end-glyph
  15686. (make-glyph (vector 'png :file movefile))))
  15687. (overlay-put
  15688. ov 'display
  15689. (list 'image :type 'png :file movefile :ascent 'center)))
  15690. (push ov org-latex-fragment-image-overlays)
  15691. (goto-char end))
  15692. (delete-region beg end)
  15693. (insert (org-add-props link
  15694. (list 'org-latex-src
  15695. (replace-regexp-in-string
  15696. "\"" "" txt)
  15697. 'org-latex-src-embed-type
  15698. (if block-type 'paragraph 'character))))))
  15699. ((eq processing-type 'mathml)
  15700. ;; Process to MathML
  15701. (unless executables-checked
  15702. (unless (save-match-data (org-format-latex-mathml-available-p))
  15703. (error "LaTeX to MathML converter not configured"))
  15704. (setq executables-checked t))
  15705. (setq txt (match-string n)
  15706. beg (match-beginning n) end (match-end n)
  15707. cnt (1+ cnt))
  15708. (if msg (message msg cnt))
  15709. (goto-char beg)
  15710. (delete-region beg end)
  15711. (insert (org-format-latex-as-mathml
  15712. txt block-type prefix dir)))
  15713. (t
  15714. (error "Unknown conversion type %s for latex fragments"
  15715. processing-type)))))))))
  15716. (defun org-create-math-formula (latex-frag &optional mathml-file)
  15717. "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
  15718. Use `org-latex-to-mathml-convert-command'. If the conversion is
  15719. sucessful, return the portion between \"<math...> </math>\"
  15720. elements otherwise return nil. When MATHML-FILE is specified,
  15721. write the results in to that file. When invoked as an
  15722. interactive command, prompt for LATEX-FRAG, with initial value
  15723. set to the current active region and echo the results for user
  15724. inspection."
  15725. (interactive (list (let ((frag (when (region-active-p)
  15726. (buffer-substring-no-properties
  15727. (region-beginning) (region-end)))))
  15728. (read-string "LaTeX Fragment: " frag nil frag))))
  15729. (unless latex-frag (error "Invalid latex-frag"))
  15730. (let* ((tmp-in-file (file-relative-name
  15731. (make-temp-name (expand-file-name "ltxmathml-in"))))
  15732. (ignore (write-region latex-frag nil tmp-in-file))
  15733. (tmp-out-file (file-relative-name
  15734. (make-temp-name (expand-file-name "ltxmathml-out"))))
  15735. (cmd (format-spec
  15736. org-latex-to-mathml-convert-command
  15737. `((?j . ,(shell-quote-argument
  15738. (expand-file-name org-latex-to-mathml-jar-file)))
  15739. (?I . ,(shell-quote-argument tmp-in-file))
  15740. (?o . ,(shell-quote-argument tmp-out-file)))))
  15741. mathml shell-command-output)
  15742. (when (org-called-interactively-p 'any)
  15743. (unless (org-format-latex-mathml-available-p)
  15744. (error "LaTeX to MathML converter not configured")))
  15745. (message "Running %s" cmd)
  15746. (setq shell-command-output (shell-command-to-string cmd))
  15747. (setq mathml
  15748. (when (file-readable-p tmp-out-file)
  15749. (with-current-buffer (find-file-noselect tmp-out-file t)
  15750. (goto-char (point-min))
  15751. (when (re-search-forward
  15752. (concat
  15753. (regexp-quote
  15754. "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
  15755. "\\(.\\|\n\\)*"
  15756. (regexp-quote "</math>")) nil t)
  15757. (prog1 (match-string 0) (kill-buffer))))))
  15758. (cond
  15759. (mathml
  15760. (setq mathml
  15761. (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
  15762. (when mathml-file
  15763. (write-region mathml nil mathml-file))
  15764. (when (org-called-interactively-p 'any)
  15765. (message mathml)))
  15766. ((message "LaTeX to MathML conversion failed")
  15767. (message shell-command-output)))
  15768. (delete-file tmp-in-file)
  15769. (when (file-exists-p tmp-out-file)
  15770. (delete-file tmp-out-file))
  15771. mathml))
  15772. (defun org-format-latex-as-mathml (latex-frag latex-frag-type
  15773. prefix &optional dir)
  15774. "Use `org-create-math-formula' but check local cache first."
  15775. (let* ((absprefix (expand-file-name prefix dir))
  15776. (print-length nil) (print-level nil)
  15777. (formula-id (concat
  15778. "formula-"
  15779. (sha1
  15780. (prin1-to-string
  15781. (list latex-frag
  15782. org-latex-to-mathml-convert-command)))))
  15783. (formula-cache (format "%s-%s.mathml" absprefix formula-id))
  15784. (formula-cache-dir (file-name-directory formula-cache)))
  15785. (unless (file-directory-p formula-cache-dir)
  15786. (make-directory formula-cache-dir t))
  15787. (unless (file-exists-p formula-cache)
  15788. (org-create-math-formula latex-frag formula-cache))
  15789. (if (file-exists-p formula-cache)
  15790. ;; Successful conversion. Return the link to MathML file.
  15791. (org-add-props
  15792. (format "[[file:%s]]" (file-relative-name formula-cache dir))
  15793. (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
  15794. 'org-latex-src-embed-type (if latex-frag-type
  15795. 'paragraph 'character)))
  15796. ;; Failed conversion. Return the LaTeX fragment verbatim
  15797. (add-text-properties
  15798. 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
  15799. latex-frag)))
  15800. ;; This function borrows from Ganesh Swami's latex2png.el
  15801. (defun org-create-formula-image-with-dvipng (string tofile options buffer)
  15802. "This calls dvipng."
  15803. (require 'org-latex)
  15804. (let* ((tmpdir (if (featurep 'xemacs)
  15805. (temp-directory)
  15806. temporary-file-directory))
  15807. (texfilebase (make-temp-name
  15808. (expand-file-name "orgtex" tmpdir)))
  15809. (texfile (concat texfilebase ".tex"))
  15810. (dvifile (concat texfilebase ".dvi"))
  15811. (pngfile (concat texfilebase ".png"))
  15812. (fnh (if (featurep 'xemacs)
  15813. (font-height (face-font 'default))
  15814. (face-attribute 'default :height nil)))
  15815. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  15816. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  15817. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  15818. "Black"))
  15819. (bg (or (plist-get options (if buffer :background :html-background))
  15820. "Transparent")))
  15821. (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
  15822. (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
  15823. (with-temp-file texfile
  15824. (insert (org-splice-latex-header
  15825. org-format-latex-header
  15826. org-export-latex-default-packages-alist
  15827. org-export-latex-packages-alist t
  15828. org-format-latex-header-extra))
  15829. (insert "\n\\begin{document}\n" string "\n\\end{document}\n")
  15830. (require 'org-latex)
  15831. (org-export-latex-fix-inputenc))
  15832. (let ((dir default-directory))
  15833. (condition-case nil
  15834. (progn
  15835. (cd tmpdir)
  15836. (call-process "latex" nil nil nil texfile))
  15837. (error nil))
  15838. (cd dir))
  15839. (if (not (file-exists-p dvifile))
  15840. (progn (message "Failed to create dvi file from %s" texfile) nil)
  15841. (condition-case nil
  15842. (if (featurep 'xemacs)
  15843. (call-process "dvipng" nil nil nil
  15844. "-fg" fg "-bg" bg
  15845. "-T" "tight"
  15846. "-o" pngfile
  15847. dvifile)
  15848. (call-process "dvipng" nil nil nil
  15849. "-fg" fg "-bg" bg
  15850. "-D" dpi
  15851. ;;"-x" scale "-y" scale
  15852. "-T" "tight"
  15853. "-o" pngfile
  15854. dvifile))
  15855. (error nil))
  15856. (if (not (file-exists-p pngfile))
  15857. (if org-format-latex-signal-error
  15858. (error "Failed to create png file from %s" texfile)
  15859. (message "Failed to create png file from %s" texfile)
  15860. nil)
  15861. ;; Use the requested file name and clean up
  15862. (copy-file pngfile tofile 'replace)
  15863. (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
  15864. (if (file-exists-p (concat texfilebase e))
  15865. (delete-file (concat texfilebase e))))
  15866. pngfile))))
  15867. (defvar org-latex-to-pdf-process) ;; Defined in org-latex.el
  15868. (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
  15869. "This calls convert, which is included into imagemagick."
  15870. (require 'org-latex)
  15871. (let* ((tmpdir (if (featurep 'xemacs)
  15872. (temp-directory)
  15873. temporary-file-directory))
  15874. (texfilebase (make-temp-name
  15875. (expand-file-name "orgtex" tmpdir)))
  15876. (texfile (concat texfilebase ".tex"))
  15877. (pdffile (concat texfilebase ".pdf"))
  15878. (pngfile (concat texfilebase ".png"))
  15879. (fnh (if (featurep 'xemacs)
  15880. (font-height (face-font 'default))
  15881. (face-attribute 'default :height nil)))
  15882. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  15883. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  15884. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  15885. "black"))
  15886. (bg (or (plist-get options (if buffer :background :html-background))
  15887. "white")))
  15888. (if (eq fg 'default) (setq fg (org-latex-color :foreground))
  15889. (setq fg (org-latex-color-format fg)))
  15890. (if (eq bg 'default) (setq bg (org-latex-color :background))
  15891. (setq bg (org-latex-color-format
  15892. (if (string= bg "Transparent")(setq bg "white")))))
  15893. (with-temp-file texfile
  15894. (insert (org-splice-latex-header
  15895. org-format-latex-header
  15896. org-export-latex-default-packages-alist
  15897. org-export-latex-packages-alist t
  15898. org-format-latex-header-extra))
  15899. (insert "\n\\begin{document}\n"
  15900. "\\definecolor{fg}{rgb}{" fg "}\n"
  15901. "\\definecolor{bg}{rgb}{" bg "}\n"
  15902. "\n\\pagecolor{bg}\n"
  15903. "\n{\\color{fg}\n"
  15904. string
  15905. "\n}\n"
  15906. "\n\\end{document}\n" )
  15907. (require 'org-latex)
  15908. (org-export-latex-fix-inputenc))
  15909. (let ((dir default-directory) cmd cmds latex-frags-cmds)
  15910. (condition-case nil
  15911. (progn
  15912. (cd tmpdir)
  15913. (setq cmds org-latex-to-pdf-process)
  15914. (while cmds
  15915. (setq latex-frags-cmds (pop cmds))
  15916. (if (listp latex-frags-cmds)
  15917. (setq cmds nil)
  15918. (setq latex-frags-cmds (list (car org-latex-to-pdf-process)))))
  15919. (while latex-frags-cmds
  15920. (setq cmd (pop latex-frags-cmds))
  15921. (while (string-match "%b" cmd)
  15922. (setq cmd (replace-match
  15923. (save-match-data
  15924. (shell-quote-argument texfile))
  15925. t t cmd)))
  15926. (while (string-match "%f" cmd)
  15927. (setq cmd (replace-match
  15928. (save-match-data
  15929. (shell-quote-argument (file-name-nondirectory texfile)))
  15930. t t cmd)))
  15931. (while (string-match "%o" cmd)
  15932. (setq cmd (replace-match
  15933. (save-match-data
  15934. (shell-quote-argument (file-name-directory texfile)))
  15935. t t cmd)))
  15936. (setq cmd (split-string cmd))
  15937. (eval (append (list 'call-process (pop cmd) nil nil nil) cmd))))
  15938. (error nil))
  15939. (cd dir))
  15940. (if (not (file-exists-p pdffile))
  15941. (progn (message "Failed to create pdf file from %s" texfile) nil)
  15942. (condition-case nil
  15943. (if (featurep 'xemacs)
  15944. (call-process "convert" nil nil nil
  15945. "-density" "96"
  15946. "-trim"
  15947. "-antialias"
  15948. pdffile
  15949. "-quality" "100"
  15950. ;; "-sharpen" "0x1.0"
  15951. pngfile)
  15952. (call-process "convert" nil nil nil
  15953. "-density" dpi
  15954. "-trim"
  15955. "-antialias"
  15956. pdffile
  15957. "-quality" "100"
  15958. ; "-sharpen" "0x1.0"
  15959. pngfile))
  15960. (error nil))
  15961. (if (not (file-exists-p pngfile))
  15962. (if org-format-latex-signal-error
  15963. (error "Failed to create png file from %s" texfile)
  15964. (message "Failed to create png file from %s" texfile)
  15965. nil)
  15966. ;; Use the requested file name and clean up
  15967. (copy-file pngfile tofile 'replace)
  15968. (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
  15969. (if (file-exists-p (concat texfilebase e))
  15970. (delete-file (concat texfilebase e))))
  15971. pngfile))))
  15972. (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
  15973. "Fill a LaTeX header template TPL.
  15974. In the template, the following place holders will be recognized:
  15975. [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
  15976. [NO-DEFAULT-PACKAGES] do not include DEF-PKG
  15977. [PACKAGES] \\usepackage statements for PKG
  15978. [NO-PACKAGES] do not include PKG
  15979. [EXTRA] the string EXTRA
  15980. [NO-EXTRA] do not include EXTRA
  15981. For backward compatibility, if both the positive and the negative place
  15982. holder is missing, the positive one (without the \"NO-\") will be
  15983. assumed to be present at the end of the template.
  15984. DEF-PKG and PKG are assumed to be alists of options/packagename lists.
  15985. EXTRA is a string.
  15986. SNIPPETS-P indicates if this is run to create snippet images for HTML."
  15987. (let (rpl (end ""))
  15988. (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
  15989. (setq rpl (if (or (match-end 1) (not def-pkg))
  15990. "" (org-latex-packages-to-string def-pkg snippets-p t))
  15991. tpl (replace-match rpl t t tpl))
  15992. (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
  15993. (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
  15994. (setq rpl (if (or (match-end 1) (not pkg))
  15995. "" (org-latex-packages-to-string pkg snippets-p t))
  15996. tpl (replace-match rpl t t tpl))
  15997. (if pkg (setq end
  15998. (concat end "\n"
  15999. (org-latex-packages-to-string pkg snippets-p)))))
  16000. (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
  16001. (setq rpl (if (or (match-end 1) (not extra))
  16002. "" (concat extra "\n"))
  16003. tpl (replace-match rpl t t tpl))
  16004. (if (and extra (string-match "\\S-" extra))
  16005. (setq end (concat end "\n" extra))))
  16006. (if (string-match "\\S-" end)
  16007. (concat tpl "\n" end)
  16008. tpl)))
  16009. (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
  16010. "Turn an alist of packages into a string with the \\usepackage macros."
  16011. (setq pkg (mapconcat (lambda(p)
  16012. (cond
  16013. ((stringp p) p)
  16014. ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
  16015. (format "%% Package %s omitted" (cadr p)))
  16016. ((equal "" (car p))
  16017. (format "\\usepackage{%s}" (cadr p)))
  16018. (t
  16019. (format "\\usepackage[%s]{%s}"
  16020. (car p) (cadr p)))))
  16021. pkg
  16022. "\n"))
  16023. (if newline (concat pkg "\n") pkg))
  16024. (defun org-dvipng-color (attr)
  16025. "Return a RGB color specification for dvipng."
  16026. (apply 'format "rgb %s %s %s"
  16027. (mapcar 'org-normalize-color
  16028. (if (featurep 'xemacs)
  16029. (color-rgb-components
  16030. (face-property 'default
  16031. (cond ((eq attr :foreground) 'foreground)
  16032. ((eq attr :background) 'background))))
  16033. (color-values (face-attribute 'default attr nil))))))
  16034. (defun org-latex-color (attr)
  16035. "Return a RGB color for the LaTeX color package."
  16036. (apply 'format "%s,%s,%s"
  16037. (mapcar 'org-normalize-color
  16038. (if (featurep 'xemacs)
  16039. (color-rgb-components
  16040. (face-property 'default
  16041. (cond ((eq attr :foreground) 'foreground)
  16042. ((eq attr :background) 'background))))
  16043. (color-values (face-attribute 'default attr nil))))))
  16044. (defun org-latex-color-format (color-name)
  16045. "Convert COLOR-NAME to a RGB color value."
  16046. (apply 'format "%s,%s,%s"
  16047. (mapcar 'org-normalize-color
  16048. (color-values color-name))))
  16049. (defun org-normalize-color (value)
  16050. "Return string to be used as color value for an RGB component."
  16051. (format "%g" (/ value 65535.0)))
  16052. ;; Image display
  16053. (defvar org-inline-image-overlays nil)
  16054. (make-variable-buffer-local 'org-inline-image-overlays)
  16055. (defun org-toggle-inline-images (&optional include-linked)
  16056. "Toggle the display of inline images.
  16057. INCLUDE-LINKED is passed to `org-display-inline-images'."
  16058. (interactive "P")
  16059. (if org-inline-image-overlays
  16060. (progn
  16061. (org-remove-inline-images)
  16062. (message "Inline image display turned off"))
  16063. (org-display-inline-images include-linked)
  16064. (if org-inline-image-overlays
  16065. (message "%d images displayed inline"
  16066. (length org-inline-image-overlays))
  16067. (message "No images to display inline"))))
  16068. (defun org-display-inline-images (&optional include-linked refresh beg end)
  16069. "Display inline images.
  16070. Normally only links without a description part are inlined, because this
  16071. is how it will work for export. When INCLUDE-LINKED is set, also links
  16072. with a description part will be inlined. This can be nice for a quick
  16073. look at those images, but it does not reflect what exported files will look
  16074. like.
  16075. When REFRESH is set, refresh existing images between BEG and END.
  16076. This will create new image displays only if necessary.
  16077. BEG and END default to the buffer boundaries."
  16078. (interactive "P")
  16079. (unless refresh
  16080. (org-remove-inline-images)
  16081. (if (fboundp 'clear-image-cache) (clear-image-cache)))
  16082. (save-excursion
  16083. (save-restriction
  16084. (widen)
  16085. (setq beg (or beg (point-min)) end (or end (point-max)))
  16086. (goto-char beg)
  16087. (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([^]\n]+?"
  16088. (substring (org-image-file-name-regexp) 0 -2)
  16089. "\\)\\]" (if include-linked "" "\\]")))
  16090. old file ov img)
  16091. (while (re-search-forward re end t)
  16092. (setq old (get-char-property-and-overlay (match-beginning 1)
  16093. 'org-image-overlay))
  16094. (setq file (expand-file-name
  16095. (concat (or (match-string 3) "") (match-string 4))))
  16096. (when (file-exists-p file)
  16097. (if (and (car-safe old) refresh)
  16098. (image-refresh (overlay-get (cdr old) 'display))
  16099. (setq img (save-match-data (create-image file)))
  16100. (when img
  16101. (setq ov (make-overlay (match-beginning 0) (match-end 0)))
  16102. (overlay-put ov 'display img)
  16103. (overlay-put ov 'face 'default)
  16104. (overlay-put ov 'org-image-overlay t)
  16105. (overlay-put ov 'modification-hooks
  16106. (list 'org-display-inline-modification-hook))
  16107. (push ov org-inline-image-overlays)))))))))
  16108. (defun org-display-inline-modification-hook (ov after beg end &optional len)
  16109. "Remove inline-display overlay if a corresponding region is modified."
  16110. (let ((inhibit-modification-hooks t))
  16111. (when (and ov after)
  16112. (delete ov org-inline-image-overlays)
  16113. (delete-overlay ov))))
  16114. (defun org-remove-inline-images ()
  16115. "Remove inline display of images."
  16116. (interactive)
  16117. (mapc 'delete-overlay org-inline-image-overlays)
  16118. (setq org-inline-image-overlays nil))
  16119. ;;;; Key bindings
  16120. ;; Outline functions from `outline-mode-prefix-map'
  16121. ;; that can be remapped in Org:
  16122. (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
  16123. (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
  16124. (define-key org-mode-map [remap outline-forward-same-level]
  16125. 'org-forward-same-level)
  16126. (define-key org-mode-map [remap outline-backward-same-level]
  16127. 'org-backward-same-level)
  16128. (define-key org-mode-map [remap show-branches]
  16129. 'org-kill-note-or-show-branches)
  16130. (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
  16131. (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
  16132. (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
  16133. ;; Outline functions from `outline-mode-prefix-map'
  16134. ;; that can not be remapped in Org:
  16135. ;; - the column "key binding" shows whether the Outline function is still
  16136. ;; available in Org mode on the same key that it has been bound to in
  16137. ;; Outline mode:
  16138. ;; - "overridden": key used for a different functionality in Org mode
  16139. ;; - else: key still bound to the same Outline function in Org mode
  16140. ;; | Outline function | key binding | Org replacement |
  16141. ;; |------------------------------------+-------------+-----------------------|
  16142. ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
  16143. ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
  16144. ;; | `show-children' | `C-c C-i' | visibility cycling |
  16145. ;; | `hide-subtree' | overridden | visibility cycling |
  16146. ;; | `outline-up-heading' | `C-c C-u' | still same function |
  16147. ;; | `hide-body' | overridden | no replacement |
  16148. ;; | `show-all' | overridden | no replacement |
  16149. ;; | `hide-entry' | overridden | visibility cycling |
  16150. ;; | `show-entry' | overridden | no replacement |
  16151. ;; | `hide-leaves' | overridden | no replacement |
  16152. ;; | `hide-sublevels' | overridden | no replacement |
  16153. ;; | `hide-other' | overridden | no replacement |
  16154. ;; | `outline-move-subtree-up' | `C-c C-^' | better: org-shiftup |
  16155. ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
  16156. ;; Make `C-c C-x' a prefix key
  16157. (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
  16158. ;; TAB key with modifiers
  16159. (org-defkey org-mode-map "\C-i" 'org-cycle)
  16160. (org-defkey org-mode-map [(tab)] 'org-cycle)
  16161. (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
  16162. (org-defkey org-mode-map "\M-\t" 'pcomplete)
  16163. ;; The following line is necessary under Suse GNU/Linux
  16164. (unless (featurep 'xemacs)
  16165. (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
  16166. (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
  16167. (define-key org-mode-map [backtab] 'org-shifttab)
  16168. (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
  16169. (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
  16170. (org-defkey org-mode-map [(meta return)] 'org-meta-return)
  16171. ;; Cursor keys with modifiers
  16172. (org-defkey org-mode-map [(meta left)] 'org-metaleft)
  16173. (org-defkey org-mode-map [(meta right)] 'org-metaright)
  16174. (org-defkey org-mode-map [(meta up)] 'org-metaup)
  16175. (org-defkey org-mode-map [(meta down)] 'org-metadown)
  16176. (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
  16177. (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
  16178. (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
  16179. (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
  16180. (org-defkey org-mode-map [(shift up)] 'org-shiftup)
  16181. (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
  16182. (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
  16183. (org-defkey org-mode-map [(shift right)] 'org-shiftright)
  16184. (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
  16185. (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
  16186. (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
  16187. (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
  16188. ;; Babel keys
  16189. (define-key org-mode-map org-babel-key-prefix org-babel-map)
  16190. (mapc (lambda (pair)
  16191. (define-key org-babel-map (car pair) (cdr pair)))
  16192. org-babel-key-bindings)
  16193. ;;; Extra keys for tty access.
  16194. ;; We only set them when really needed because otherwise the
  16195. ;; menus don't show the simple keys
  16196. (when (or org-use-extra-keys
  16197. (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
  16198. (not window-system))
  16199. (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
  16200. (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
  16201. (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
  16202. (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
  16203. (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
  16204. (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
  16205. (org-defkey org-mode-map [?\e (right)] 'org-metaright)
  16206. (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
  16207. (org-defkey org-mode-map [?\e (up)] 'org-metaup)
  16208. (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
  16209. (org-defkey org-mode-map [?\e (down)] 'org-metadown)
  16210. (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
  16211. (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
  16212. (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
  16213. (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
  16214. (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
  16215. (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
  16216. (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
  16217. (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
  16218. (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
  16219. (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
  16220. (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
  16221. (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
  16222. (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
  16223. (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
  16224. (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
  16225. (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
  16226. (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
  16227. ;; All the other keys
  16228. (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
  16229. (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
  16230. (if (boundp 'narrow-map)
  16231. (org-defkey narrow-map "s" 'org-narrow-to-subtree)
  16232. (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
  16233. (if (boundp 'narrow-map)
  16234. (org-defkey narrow-map "b" 'org-narrow-to-block)
  16235. (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
  16236. (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
  16237. (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
  16238. (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
  16239. (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
  16240. (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
  16241. (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
  16242. (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
  16243. (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
  16244. (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
  16245. (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
  16246. (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
  16247. (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
  16248. (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
  16249. (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
  16250. (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
  16251. (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
  16252. (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
  16253. (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
  16254. (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
  16255. (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
  16256. (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
  16257. (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
  16258. (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
  16259. (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
  16260. (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
  16261. (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
  16262. (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
  16263. (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
  16264. (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
  16265. (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
  16266. (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
  16267. (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
  16268. (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
  16269. (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
  16270. (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
  16271. (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
  16272. (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
  16273. (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
  16274. (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
  16275. (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
  16276. (org-defkey org-mode-map "\C-c]" 'org-remove-file)
  16277. (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
  16278. (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  16279. (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
  16280. (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
  16281. (org-defkey org-mode-map "\C-c^" 'org-sort)
  16282. (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
  16283. (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
  16284. (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
  16285. (org-defkey org-mode-map "\C-m" 'org-return)
  16286. (org-defkey org-mode-map "\C-j" 'org-return-indent)
  16287. (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
  16288. (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
  16289. (org-defkey org-mode-map "\C-c+" 'org-table-sum)
  16290. (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
  16291. (org-defkey org-mode-map "\C-c'" 'org-edit-special)
  16292. (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
  16293. (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
  16294. (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
  16295. (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
  16296. (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
  16297. (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
  16298. (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
  16299. (org-defkey org-mode-map "\C-c\C-e" 'org-export)
  16300. (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
  16301. (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
  16302. (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
  16303. (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  16304. (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  16305. (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
  16306. (org-defkey org-mode-map "\C-c\C-@" 'org-mark-list)
  16307. (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
  16308. ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
  16309. (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
  16310. (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
  16311. (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
  16312. (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
  16313. (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
  16314. (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
  16315. (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
  16316. (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  16317. (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
  16318. (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
  16319. (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
  16320. (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
  16321. (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
  16322. (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
  16323. (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
  16324. (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
  16325. (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
  16326. (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
  16327. (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
  16328. (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
  16329. (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
  16330. (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
  16331. (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
  16332. (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
  16333. (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
  16334. (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
  16335. (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
  16336. (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
  16337. (define-key org-mode-map "\C-c\C-x!" 'org-reload)
  16338. (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
  16339. (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
  16340. (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
  16341. (when (featurep 'xemacs)
  16342. (org-defkey org-mode-map 'button3 'popup-mode-menu))
  16343. (defconst org-speed-commands-default
  16344. '(
  16345. ("Outline Navigation")
  16346. ("n" . (org-speed-move-safe 'outline-next-visible-heading))
  16347. ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
  16348. ("f" . (org-speed-move-safe 'org-forward-same-level))
  16349. ("b" . (org-speed-move-safe 'org-backward-same-level))
  16350. ("u" . (org-speed-move-safe 'outline-up-heading))
  16351. ("j" . org-goto)
  16352. ("g" . (org-refile t))
  16353. ("Outline Visibility")
  16354. ("c" . org-cycle)
  16355. ("C" . org-shifttab)
  16356. (" " . org-display-outline-path)
  16357. (":" . org-columns)
  16358. ("Outline Structure Editing")
  16359. ("U" . org-shiftmetaup)
  16360. ("D" . org-shiftmetadown)
  16361. ("r" . org-metaright)
  16362. ("l" . org-metaleft)
  16363. ("R" . org-shiftmetaright)
  16364. ("L" . org-shiftmetaleft)
  16365. ("i" . (progn (forward-char 1) (call-interactively
  16366. 'org-insert-heading-respect-content)))
  16367. ("^" . org-sort)
  16368. ("w" . org-refile)
  16369. ("a" . org-archive-subtree-default-with-confirmation)
  16370. ("." . org-mark-subtree)
  16371. ("#" . org-toggle-comment)
  16372. ("Clock Commands")
  16373. ("I" . org-clock-in)
  16374. ("O" . org-clock-out)
  16375. ("Meta Data Editing")
  16376. ("t" . org-todo)
  16377. ("0" . (org-priority ?\ ))
  16378. ("1" . (org-priority ?A))
  16379. ("2" . (org-priority ?B))
  16380. ("3" . (org-priority ?C))
  16381. (";" . org-set-tags-command)
  16382. ("e" . org-set-effort)
  16383. ("Agenda Views etc")
  16384. ("v" . org-agenda)
  16385. ("/" . org-sparse-tree)
  16386. ("Misc")
  16387. ("o" . org-open-at-point)
  16388. ("?" . org-speed-command-help)
  16389. ("<" . (org-agenda-set-restriction-lock 'subtree))
  16390. (">" . (org-agenda-remove-restriction-lock))
  16391. )
  16392. "The default speed commands.")
  16393. (defun org-print-speed-command (e)
  16394. (if (> (length (car e)) 1)
  16395. (progn
  16396. (princ "\n")
  16397. (princ (car e))
  16398. (princ "\n")
  16399. (princ (make-string (length (car e)) ?-))
  16400. (princ "\n"))
  16401. (princ (car e))
  16402. (princ " ")
  16403. (if (symbolp (cdr e))
  16404. (princ (symbol-name (cdr e)))
  16405. (prin1 (cdr e)))
  16406. (princ "\n")))
  16407. (defun org-speed-command-help ()
  16408. "Show the available speed commands."
  16409. (interactive)
  16410. (if (not org-use-speed-commands)
  16411. (error "Speed commands are not activated, customize `org-use-speed-commands'")
  16412. (with-output-to-temp-buffer "*Help*"
  16413. (princ "User-defined Speed commands\n===========================\n")
  16414. (mapc 'org-print-speed-command org-speed-commands-user)
  16415. (princ "\n")
  16416. (princ "Built-in Speed commands\n=======================\n")
  16417. (mapc 'org-print-speed-command org-speed-commands-default))
  16418. (with-current-buffer "*Help*"
  16419. (setq truncate-lines t))))
  16420. (defun org-speed-move-safe (cmd)
  16421. "Execute CMD, but make sure that the cursor always ends up in a headline.
  16422. If not, return to the original position and throw an error."
  16423. (interactive)
  16424. (let ((pos (point)))
  16425. (call-interactively cmd)
  16426. (unless (and (bolp) (org-at-heading-p))
  16427. (goto-char pos)
  16428. (error "Boundary reached while executing %s" cmd))))
  16429. (defvar org-self-insert-command-undo-counter 0)
  16430. (defvar org-table-auto-blank-field) ; defined in org-table.el
  16431. (defvar org-speed-command nil)
  16432. (defun org-speed-command-default-hook (keys)
  16433. "Hook for activating single-letter speed commands.
  16434. `org-speed-commands-default' specifies a minimal command set.
  16435. Use `org-speed-commands-user' for further customization."
  16436. (when (or (and (bolp) (looking-at org-outline-regexp))
  16437. (and (functionp org-use-speed-commands)
  16438. (funcall org-use-speed-commands)))
  16439. (cdr (assoc keys (append org-speed-commands-user
  16440. org-speed-commands-default)))))
  16441. (defun org-babel-speed-command-hook (keys)
  16442. "Hook for activating single-letter code block commands."
  16443. (when (and (bolp) (looking-at org-babel-src-block-regexp))
  16444. (cdr (assoc keys org-babel-key-bindings))))
  16445. (defcustom org-speed-command-hook
  16446. '(org-speed-command-default-hook org-babel-speed-command-hook)
  16447. "Hook for activating speed commands at strategic locations.
  16448. Hook functions are called in sequence until a valid handler is
  16449. found.
  16450. Each hook takes a single argument, a user-pressed command key
  16451. which is also a `self-insert-command' from the global map.
  16452. Within the hook, examine the cursor position and the command key
  16453. and return nil or a valid handler as appropriate. Handler could
  16454. be one of an interactive command, a function, or a form.
  16455. Set `org-use-speed-commands' to non-nil value to enable this
  16456. hook. The default setting is `org-speed-command-default-hook'."
  16457. :group 'org-structure
  16458. :version "24.1"
  16459. :type 'hook)
  16460. (defun org-self-insert-command (N)
  16461. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  16462. If the cursor is in a table looking at whitespace, the whitespace is
  16463. overwritten, and the table is not marked as requiring realignment."
  16464. (interactive "p")
  16465. (org-check-before-invisible-edit 'insert)
  16466. (cond
  16467. ((and org-use-speed-commands
  16468. (setq org-speed-command
  16469. (run-hook-with-args-until-success
  16470. 'org-speed-command-hook (this-command-keys))))
  16471. (cond
  16472. ((commandp org-speed-command)
  16473. (setq this-command org-speed-command)
  16474. (call-interactively org-speed-command))
  16475. ((functionp org-speed-command)
  16476. (funcall org-speed-command))
  16477. ((and org-speed-command (listp org-speed-command))
  16478. (eval org-speed-command))
  16479. (t (let (org-use-speed-commands)
  16480. (call-interactively 'org-self-insert-command)))))
  16481. ((and
  16482. (org-table-p)
  16483. (progn
  16484. ;; check if we blank the field, and if that triggers align
  16485. (and (featurep 'org-table) org-table-auto-blank-field
  16486. (member last-command
  16487. '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
  16488. (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
  16489. ;; got extra space, this field does not determine column width
  16490. (let (org-table-may-need-update) (org-table-blank-field))
  16491. ;; no extra space, this field may determine column width
  16492. (org-table-blank-field)))
  16493. t)
  16494. (eq N 1)
  16495. (looking-at "[^|\n]* |"))
  16496. (let (org-table-may-need-update)
  16497. (goto-char (1- (match-end 0)))
  16498. (backward-delete-char 1)
  16499. (goto-char (match-beginning 0))
  16500. (self-insert-command N)))
  16501. (t
  16502. (setq org-table-may-need-update t)
  16503. (self-insert-command N)
  16504. (org-fix-tags-on-the-fly)
  16505. (if org-self-insert-cluster-for-undo
  16506. (if (not (eq last-command 'org-self-insert-command))
  16507. (setq org-self-insert-command-undo-counter 1)
  16508. (if (>= org-self-insert-command-undo-counter 20)
  16509. (setq org-self-insert-command-undo-counter 1)
  16510. (and (> org-self-insert-command-undo-counter 0)
  16511. buffer-undo-list (listp buffer-undo-list)
  16512. (not (cadr buffer-undo-list)) ; remove nil entry
  16513. (setcdr buffer-undo-list (cddr buffer-undo-list)))
  16514. (setq org-self-insert-command-undo-counter
  16515. (1+ org-self-insert-command-undo-counter))))))))
  16516. (defun org-check-before-invisible-edit (kind)
  16517. "Check is editing if kind KIND would be dangerous with invisible text around.
  16518. The detailed reaction depends on the user option `org-catch-invisible-edits'."
  16519. ;; First, try to get out of here as quickly as possible, to reduce overhead
  16520. (if (and org-catch-invisible-edits
  16521. (or (not (boundp 'visible-mode)) (not visible-mode))
  16522. (or (get-char-property (point) 'invisible)
  16523. (get-char-property (max (point-min) (1- (point))) 'invisible)))
  16524. ;; OK, we need to take a closer look
  16525. (let* ((invisible-at-point (get-char-property (point) 'invisible))
  16526. (invisible-before-point (if (bobp) nil (get-char-property
  16527. (1- (point)) 'invisible)))
  16528. (border-and-ok-direction
  16529. (or
  16530. ;; Check if we are acting predictably before invisible text
  16531. (and invisible-at-point (not invisible-before-point)
  16532. (memq kind '(insert delete-backward)))
  16533. ;; Check if we are acting predictably after invisible text
  16534. ;; This works not well, and I have turned it off. It seems
  16535. ;; better to always show and stop after invisible text.
  16536. ;; (and (not invisible-at-point) invisible-before-point
  16537. ;; (memq kind '(insert delete)))
  16538. )))
  16539. (when (or (memq invisible-at-point '(outline org-hide-block))
  16540. (memq invisible-before-point '(outline org-hide-block)))
  16541. (if (eq org-catch-invisible-edits 'error)
  16542. (error "Editing in invisible areas is prohibited - make visible first"))
  16543. ;; Make the area visible
  16544. (save-excursion
  16545. (if invisible-before-point
  16546. (goto-char (previous-single-char-property-change
  16547. (point) 'invisible)))
  16548. (org-cycle))
  16549. (cond
  16550. ((eq org-catch-invisible-edits 'show)
  16551. ;; That's it, we do the edit after showing
  16552. (message
  16553. "Unfolding invisible region around point before editing")
  16554. (sit-for 1))
  16555. ((and (eq org-catch-invisible-edits 'smart)
  16556. border-and-ok-direction)
  16557. (message "Unfolding invisible region around point before editing"))
  16558. (t
  16559. ;; Don't do the edit, make the user repeat it in full visibility
  16560. (error "Edit in invisible region aborted, repeat to confirm with text visible")))))))
  16561. (defun org-fix-tags-on-the-fly ()
  16562. (when (and (equal (char-after (point-at-bol)) ?*)
  16563. (org-at-heading-p))
  16564. (org-align-tags-here org-tags-column)))
  16565. (defun org-delete-backward-char (N)
  16566. "Like `delete-backward-char', insert whitespace at field end in tables.
  16567. When deleting backwards, in tables this function will insert whitespace in
  16568. front of the next \"|\" separator, to keep the table aligned. The table will
  16569. still be marked for re-alignment if the field did fill the entire column,
  16570. because, in this case the deletion might narrow the column."
  16571. (interactive "p")
  16572. (org-check-before-invisible-edit 'delete-backward)
  16573. (if (and (org-table-p)
  16574. (eq N 1)
  16575. (string-match "|" (buffer-substring (point-at-bol) (point)))
  16576. (looking-at ".*?|"))
  16577. (let ((pos (point))
  16578. (noalign (looking-at "[^|\n\r]* |"))
  16579. (c org-table-may-need-update))
  16580. (backward-delete-char N)
  16581. (if (not overwrite-mode)
  16582. (progn
  16583. (skip-chars-forward "^|")
  16584. (insert " ")
  16585. (goto-char (1- pos))))
  16586. ;; noalign: if there were two spaces at the end, this field
  16587. ;; does not determine the width of the column.
  16588. (if noalign (setq org-table-may-need-update c)))
  16589. (backward-delete-char N)
  16590. (org-fix-tags-on-the-fly)))
  16591. (defun org-delete-char (N)
  16592. "Like `delete-char', but insert whitespace at field end in tables.
  16593. When deleting characters, in tables this function will insert whitespace in
  16594. front of the next \"|\" separator, to keep the table aligned. The table will
  16595. still be marked for re-alignment if the field did fill the entire column,
  16596. because, in this case the deletion might narrow the column."
  16597. (interactive "p")
  16598. (org-check-before-invisible-edit 'delete)
  16599. (if (and (org-table-p)
  16600. (not (bolp))
  16601. (not (= (char-after) ?|))
  16602. (eq N 1))
  16603. (if (looking-at ".*?|")
  16604. (let ((pos (point))
  16605. (noalign (looking-at "[^|\n\r]* |"))
  16606. (c org-table-may-need-update))
  16607. (replace-match (concat
  16608. (substring (match-string 0) 1 -1)
  16609. " |"))
  16610. (goto-char pos)
  16611. ;; noalign: if there were two spaces at the end, this field
  16612. ;; does not determine the width of the column.
  16613. (if noalign (setq org-table-may-need-update c)))
  16614. (delete-char N))
  16615. (delete-char N)
  16616. (org-fix-tags-on-the-fly)))
  16617. ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
  16618. (put 'org-self-insert-command 'delete-selection t)
  16619. (put 'orgtbl-self-insert-command 'delete-selection t)
  16620. (put 'org-delete-char 'delete-selection 'supersede)
  16621. (put 'org-delete-backward-char 'delete-selection 'supersede)
  16622. (put 'org-yank 'delete-selection 'yank)
  16623. ;; Make `flyspell-mode' delay after some commands
  16624. (put 'org-self-insert-command 'flyspell-delayed t)
  16625. (put 'orgtbl-self-insert-command 'flyspell-delayed t)
  16626. (put 'org-delete-char 'flyspell-delayed t)
  16627. (put 'org-delete-backward-char 'flyspell-delayed t)
  16628. ;; Make pabbrev-mode expand after org-mode commands
  16629. (put 'org-self-insert-command 'pabbrev-expand-after-command t)
  16630. (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
  16631. ;; How to do this: Measure non-white length of current string
  16632. ;; If equal to column width, we should realign.
  16633. (defun org-remap (map &rest commands)
  16634. "In MAP, remap the functions given in COMMANDS.
  16635. COMMANDS is a list of alternating OLDDEF NEWDEF command names."
  16636. (let (new old)
  16637. (while commands
  16638. (setq old (pop commands) new (pop commands))
  16639. (if (fboundp 'command-remapping)
  16640. (org-defkey map (vector 'remap old) new)
  16641. (substitute-key-definition old new map global-map)))))
  16642. (when (eq org-enable-table-editor 'optimized)
  16643. ;; If the user wants maximum table support, we need to hijack
  16644. ;; some standard editing functions
  16645. (org-remap org-mode-map
  16646. 'self-insert-command 'org-self-insert-command
  16647. 'delete-char 'org-delete-char
  16648. 'delete-backward-char 'org-delete-backward-char)
  16649. (org-defkey org-mode-map "|" 'org-force-self-insert))
  16650. (defvar org-ctrl-c-ctrl-c-hook nil
  16651. "Hook for functions attaching themselves to `C-c C-c'.
  16652. This can be used to add additional functionality to the C-c C-c
  16653. key which executes context-dependent commands. This hook is run
  16654. before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
  16655. run after the last test.
  16656. Each function will be called with no arguments. The function
  16657. must check if the context is appropriate for it to act. If yes,
  16658. it should do its thing and then return a non-nil value. If the
  16659. context is wrong, just do nothing and return nil.")
  16660. (defvar org-ctrl-c-ctrl-c-final-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. after any other test, while `org-ctrl-c-ctrl-c-hook' is run
  16665. before the first 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-tab-first-hook nil
  16671. "Hook for functions to attach themselves to TAB.
  16672. See `org-ctrl-c-ctrl-c-hook' for more information.
  16673. This hook runs as the first action when TAB is pressed, even before
  16674. `org-cycle' messes around with the `outline-regexp' to cater for
  16675. inline tasks and plain list item folding.
  16676. If any function in this hook returns t, any other actions that
  16677. would have been caused by TAB (such as table field motion or visibility
  16678. cycling) will not occur.")
  16679. (defvar org-tab-after-check-for-table-hook nil
  16680. "Hook for functions to attach themselves to TAB.
  16681. See `org-ctrl-c-ctrl-c-hook' for more information.
  16682. This hook runs after it has been established that the cursor is not in a
  16683. table, but before checking if the cursor is in a headline or if global cycling
  16684. should be done.
  16685. If any function in this hook returns t, not other actions like visibility
  16686. cycling will be done.")
  16687. (defvar org-tab-after-check-for-cycling-hook nil
  16688. "Hook for functions to attach themselves to TAB.
  16689. See `org-ctrl-c-ctrl-c-hook' for more information.
  16690. This hook runs after it has been established that not table field motion and
  16691. not visibility should be done because of current context. This is probably
  16692. the place where a package like yasnippets can hook in.")
  16693. (defvar org-tab-before-tab-emulation-hook nil
  16694. "Hook for functions to attach themselves to TAB.
  16695. See `org-ctrl-c-ctrl-c-hook' for more information.
  16696. This hook runs after every other options for TAB have been exhausted, but
  16697. before indentation and \t insertion takes place.")
  16698. (defvar org-metaleft-hook nil
  16699. "Hook for functions attaching themselves to `M-left'.
  16700. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16701. (defvar org-metaright-hook nil
  16702. "Hook for functions attaching themselves to `M-right'.
  16703. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16704. (defvar org-metaup-hook nil
  16705. "Hook for functions attaching themselves to `M-up'.
  16706. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16707. (defvar org-metadown-hook nil
  16708. "Hook for functions attaching themselves to `M-down'.
  16709. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16710. (defvar org-shiftmetaleft-hook nil
  16711. "Hook for functions attaching themselves to `M-S-left'.
  16712. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16713. (defvar org-shiftmetaright-hook nil
  16714. "Hook for functions attaching themselves to `M-S-right'.
  16715. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16716. (defvar org-shiftmetaup-hook nil
  16717. "Hook for functions attaching themselves to `M-S-up'.
  16718. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16719. (defvar org-shiftmetadown-hook nil
  16720. "Hook for functions attaching themselves to `M-S-down'.
  16721. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16722. (defvar org-metareturn-hook nil
  16723. "Hook for functions attaching themselves to `M-RET'.
  16724. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16725. (defvar org-shiftup-hook nil
  16726. "Hook for functions attaching themselves to `S-up'.
  16727. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16728. (defvar org-shiftup-final-hook nil
  16729. "Hook for functions attaching themselves to `S-up'.
  16730. This one runs after all other options except shift-select have been excluded.
  16731. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16732. (defvar org-shiftdown-hook nil
  16733. "Hook for functions attaching themselves to `S-down'.
  16734. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16735. (defvar org-shiftdown-final-hook nil
  16736. "Hook for functions attaching themselves to `S-down'.
  16737. This one runs after all other options except shift-select have been excluded.
  16738. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16739. (defvar org-shiftleft-hook nil
  16740. "Hook for functions attaching themselves to `S-left'.
  16741. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16742. (defvar org-shiftleft-final-hook nil
  16743. "Hook for functions attaching themselves to `S-left'.
  16744. This one runs after all other options except shift-select have been excluded.
  16745. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16746. (defvar org-shiftright-hook nil
  16747. "Hook for functions attaching themselves to `S-right'.
  16748. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16749. (defvar org-shiftright-final-hook nil
  16750. "Hook for functions attaching themselves to `S-right'.
  16751. This one runs after all other options except shift-select have been excluded.
  16752. See `org-ctrl-c-ctrl-c-hook' for more information.")
  16753. (defun org-modifier-cursor-error ()
  16754. "Throw an error, a modified cursor command was applied in wrong context."
  16755. (error "This command is active in special context like tables, headlines or items"))
  16756. (defun org-shiftselect-error ()
  16757. "Throw an error because Shift-Cursor command was applied in wrong context."
  16758. (if (and (boundp 'shift-select-mode) shift-select-mode)
  16759. (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
  16760. (error "This command works only in special context like headlines or timestamps")))
  16761. (defun org-call-for-shift-select (cmd)
  16762. (let ((this-command-keys-shift-translated t))
  16763. (call-interactively cmd)))
  16764. (defun org-shifttab (&optional arg)
  16765. "Global visibility cycling or move to previous table field.
  16766. Calls `org-cycle' with argument t, or `org-table-previous-field', depending
  16767. on context.
  16768. See the individual commands for more information."
  16769. (interactive "P")
  16770. (cond
  16771. ((org-at-table-p) (call-interactively 'org-table-previous-field))
  16772. ((integerp arg)
  16773. (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
  16774. (message "Content view to level: %d" arg)
  16775. (org-content (prefix-numeric-value arg2))
  16776. (setq org-cycle-global-status 'overview)))
  16777. (t (call-interactively 'org-global-cycle))))
  16778. (defun org-shiftmetaleft ()
  16779. "Promote subtree or delete table column.
  16780. Calls `org-promote-subtree', `org-outdent-item-tree', or
  16781. `org-table-delete-column', depending on context. See the
  16782. individual commands for more information."
  16783. (interactive)
  16784. (cond
  16785. ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
  16786. ((org-at-table-p) (call-interactively 'org-table-delete-column))
  16787. ((org-at-heading-p) (call-interactively 'org-promote-subtree))
  16788. ((if (not (org-region-active-p)) (org-at-item-p)
  16789. (save-excursion (goto-char (region-beginning))
  16790. (org-at-item-p)))
  16791. (call-interactively 'org-outdent-item-tree))
  16792. (t (org-modifier-cursor-error))))
  16793. (defun org-shiftmetaright ()
  16794. "Demote subtree or insert table column.
  16795. Calls `org-demote-subtree', `org-indent-item-tree', or
  16796. `org-table-insert-column', depending on context. See the
  16797. individual commands for more information."
  16798. (interactive)
  16799. (cond
  16800. ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
  16801. ((org-at-table-p) (call-interactively 'org-table-insert-column))
  16802. ((org-at-heading-p) (call-interactively 'org-demote-subtree))
  16803. ((if (not (org-region-active-p)) (org-at-item-p)
  16804. (save-excursion (goto-char (region-beginning))
  16805. (org-at-item-p)))
  16806. (call-interactively 'org-indent-item-tree))
  16807. (t (org-modifier-cursor-error))))
  16808. (defun org-shiftmetaup (&optional arg)
  16809. "Move subtree up or kill table row.
  16810. Calls `org-move-subtree-up' or `org-table-kill-row' or
  16811. `org-move-item-up' depending on context. See the individual commands
  16812. for more information."
  16813. (interactive "P")
  16814. (cond
  16815. ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
  16816. ((org-at-table-p) (call-interactively 'org-table-kill-row))
  16817. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  16818. ((org-at-item-p) (call-interactively 'org-move-item-up))
  16819. (t (org-modifier-cursor-error))))
  16820. (defun org-shiftmetadown (&optional arg)
  16821. "Move subtree down or insert table row.
  16822. Calls `org-move-subtree-down' or `org-table-insert-row' or
  16823. `org-move-item-down', depending on context. See the individual
  16824. commands for more information."
  16825. (interactive "P")
  16826. (cond
  16827. ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
  16828. ((org-at-table-p) (call-interactively 'org-table-insert-row))
  16829. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  16830. ((org-at-item-p) (call-interactively 'org-move-item-down))
  16831. (t (org-modifier-cursor-error))))
  16832. (defsubst org-hidden-tree-error ()
  16833. (error
  16834. "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
  16835. (defun org-metaleft (&optional arg)
  16836. "Promote heading or move table column to left.
  16837. Calls `org-do-promote' or `org-table-move-column', depending on context.
  16838. With no specific context, calls the Emacs default `backward-word'.
  16839. See the individual commands for more information."
  16840. (interactive "P")
  16841. (cond
  16842. ((run-hook-with-args-until-success 'org-metaleft-hook))
  16843. ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
  16844. ((org-with-limited-levels
  16845. (or (org-at-heading-p)
  16846. (and (org-region-active-p)
  16847. (save-excursion
  16848. (goto-char (region-beginning))
  16849. (org-at-heading-p)))))
  16850. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  16851. (call-interactively 'org-do-promote))
  16852. ;; At an inline task.
  16853. ((org-at-heading-p)
  16854. (call-interactively 'org-inlinetask-promote))
  16855. ((or (org-at-item-p)
  16856. (and (org-region-active-p)
  16857. (save-excursion
  16858. (goto-char (region-beginning))
  16859. (org-at-item-p))))
  16860. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  16861. (call-interactively 'org-outdent-item))
  16862. (t (call-interactively 'backward-word))))
  16863. (defun org-metaright (&optional arg)
  16864. "Demote a subtree, a list item or move table column to right.
  16865. In front of a drawer or a block keyword, indent it correctly.
  16866. With no specific context, calls the Emacs default `forward-word'.
  16867. See the individual commands for more information."
  16868. (interactive "P")
  16869. (cond
  16870. ((run-hook-with-args-until-success 'org-metaright-hook))
  16871. ((org-at-table-p) (call-interactively 'org-table-move-column))
  16872. ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
  16873. ((org-at-block-p) (call-interactively 'org-indent-block))
  16874. ((org-with-limited-levels
  16875. (or (org-at-heading-p)
  16876. (and (org-region-active-p)
  16877. (save-excursion
  16878. (goto-char (region-beginning))
  16879. (org-at-heading-p)))))
  16880. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  16881. (call-interactively 'org-do-demote))
  16882. ;; At an inline task.
  16883. ((org-at-heading-p)
  16884. (call-interactively 'org-inlinetask-demote))
  16885. ((or (org-at-item-p)
  16886. (and (org-region-active-p)
  16887. (save-excursion
  16888. (goto-char (region-beginning))
  16889. (org-at-item-p))))
  16890. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  16891. (call-interactively 'org-indent-item))
  16892. (t (call-interactively 'forward-word))))
  16893. (defun org-check-for-hidden (what)
  16894. "Check if there are hidden headlines/items in the current visual line.
  16895. WHAT can be either `headlines' or `items'. If the current line is
  16896. an outline or item heading and it has a folded subtree below it,
  16897. this function returns t, nil otherwise."
  16898. (let ((re (cond
  16899. ((eq what 'headlines) org-outline-regexp-bol)
  16900. ((eq what 'items) (org-item-beginning-re))
  16901. (t (error "This should not happen"))))
  16902. beg end)
  16903. (save-excursion
  16904. (catch 'exit
  16905. (unless (org-region-active-p)
  16906. (setq beg (point-at-bol))
  16907. (beginning-of-line 2)
  16908. (while (and (not (eobp)) ;; this is like `next-line'
  16909. (get-char-property (1- (point)) 'invisible))
  16910. (beginning-of-line 2))
  16911. (setq end (point))
  16912. (goto-char beg)
  16913. (goto-char (point-at-eol))
  16914. (setq end (max end (point)))
  16915. (while (re-search-forward re end t)
  16916. (if (get-char-property (match-beginning 0) 'invisible)
  16917. (throw 'exit t))))
  16918. nil))))
  16919. (defun org-metaup (&optional arg)
  16920. "Move subtree up or move table row up.
  16921. Calls `org-move-subtree-up' or `org-table-move-row' or
  16922. `org-move-item-up', depending on context. See the individual commands
  16923. for more information."
  16924. (interactive "P")
  16925. (cond
  16926. ((run-hook-with-args-until-success 'org-metaup-hook))
  16927. ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
  16928. ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
  16929. ((org-at-item-p) (call-interactively 'org-move-item-up))
  16930. (t (transpose-lines 1) (beginning-of-line -1))))
  16931. (defun org-metadown (&optional arg)
  16932. "Move subtree down or move table row down.
  16933. Calls `org-move-subtree-down' or `org-table-move-row' or
  16934. `org-move-item-down', depending on context. See the individual
  16935. commands for more information."
  16936. (interactive "P")
  16937. (cond
  16938. ((run-hook-with-args-until-success 'org-metadown-hook))
  16939. ((org-at-table-p) (call-interactively 'org-table-move-row))
  16940. ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
  16941. ((org-at-item-p) (call-interactively 'org-move-item-down))
  16942. (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
  16943. (defun org-shiftup (&optional arg)
  16944. "Increase item in timestamp or increase priority of current headline.
  16945. Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
  16946. depending on context. See the individual commands for more information."
  16947. (interactive "P")
  16948. (cond
  16949. ((run-hook-with-args-until-success 'org-shiftup-hook))
  16950. ((and org-support-shift-select (org-region-active-p))
  16951. (org-call-for-shift-select 'previous-line))
  16952. ((org-at-timestamp-p t)
  16953. (call-interactively (if org-edit-timestamp-down-means-later
  16954. 'org-timestamp-down 'org-timestamp-up)))
  16955. ((and (not (eq org-support-shift-select 'always))
  16956. org-enable-priority-commands
  16957. (org-at-heading-p))
  16958. (call-interactively 'org-priority-up))
  16959. ((and (not org-support-shift-select) (org-at-item-p))
  16960. (call-interactively 'org-previous-item))
  16961. ((org-clocktable-try-shift 'up arg))
  16962. ((run-hook-with-args-until-success 'org-shiftup-final-hook))
  16963. (org-support-shift-select
  16964. (org-call-for-shift-select 'previous-line))
  16965. (t (org-shiftselect-error))))
  16966. (defun org-shiftdown (&optional arg)
  16967. "Decrease item in timestamp or decrease priority of current headline.
  16968. Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
  16969. depending on context. See the individual commands for more information."
  16970. (interactive "P")
  16971. (cond
  16972. ((run-hook-with-args-until-success 'org-shiftdown-hook))
  16973. ((and org-support-shift-select (org-region-active-p))
  16974. (org-call-for-shift-select 'next-line))
  16975. ((org-at-timestamp-p t)
  16976. (call-interactively (if org-edit-timestamp-down-means-later
  16977. 'org-timestamp-up 'org-timestamp-down)))
  16978. ((and (not (eq org-support-shift-select 'always))
  16979. org-enable-priority-commands
  16980. (org-at-heading-p))
  16981. (call-interactively 'org-priority-down))
  16982. ((and (not org-support-shift-select) (org-at-item-p))
  16983. (call-interactively 'org-next-item))
  16984. ((org-clocktable-try-shift 'down arg))
  16985. ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
  16986. (org-support-shift-select
  16987. (org-call-for-shift-select 'next-line))
  16988. (t (org-shiftselect-error))))
  16989. (defun org-shiftright (&optional arg)
  16990. "Cycle the thing at point or in the current line, depending on context.
  16991. Depending on context, this does one of the following:
  16992. - switch a timestamp at point one day into the future
  16993. - on a headline, switch to the next TODO keyword.
  16994. - on an item, switch entire list to the next bullet type
  16995. - on a property line, switch to the next allowed value
  16996. - on a clocktable definition line, move time block into the future"
  16997. (interactive "P")
  16998. (cond
  16999. ((run-hook-with-args-until-success 'org-shiftright-hook))
  17000. ((and org-support-shift-select (org-region-active-p))
  17001. (org-call-for-shift-select 'forward-char))
  17002. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
  17003. ((and (not (eq org-support-shift-select 'always))
  17004. (org-at-heading-p))
  17005. (let ((org-inhibit-logging
  17006. (not org-treat-S-cursor-todo-selection-as-state-change))
  17007. (org-inhibit-blocking
  17008. (not org-treat-S-cursor-todo-selection-as-state-change)))
  17009. (org-call-with-arg 'org-todo 'right)))
  17010. ((or (and org-support-shift-select
  17011. (not (eq org-support-shift-select 'always))
  17012. (org-at-item-bullet-p))
  17013. (and (not org-support-shift-select) (org-at-item-p)))
  17014. (org-call-with-arg 'org-cycle-list-bullet nil))
  17015. ((and (not (eq org-support-shift-select 'always))
  17016. (org-at-property-p))
  17017. (call-interactively 'org-property-next-allowed-value))
  17018. ((org-clocktable-try-shift 'right arg))
  17019. ((run-hook-with-args-until-success 'org-shiftright-final-hook))
  17020. (org-support-shift-select
  17021. (org-call-for-shift-select 'forward-char))
  17022. (t (org-shiftselect-error))))
  17023. (defun org-shiftleft (&optional arg)
  17024. "Cycle the thing at point or in the current line, depending on context.
  17025. Depending on context, this does one of the following:
  17026. - switch a timestamp at point one day into the past
  17027. - on a headline, switch to the previous TODO keyword.
  17028. - on an item, switch entire list to the previous bullet type
  17029. - on a property line, switch to the previous allowed value
  17030. - on a clocktable definition line, move time block into the past"
  17031. (interactive "P")
  17032. (cond
  17033. ((run-hook-with-args-until-success 'org-shiftleft-hook))
  17034. ((and org-support-shift-select (org-region-active-p))
  17035. (org-call-for-shift-select 'backward-char))
  17036. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
  17037. ((and (not (eq org-support-shift-select 'always))
  17038. (org-at-heading-p))
  17039. (let ((org-inhibit-logging
  17040. (not org-treat-S-cursor-todo-selection-as-state-change))
  17041. (org-inhibit-blocking
  17042. (not org-treat-S-cursor-todo-selection-as-state-change)))
  17043. (org-call-with-arg 'org-todo 'left)))
  17044. ((or (and org-support-shift-select
  17045. (not (eq org-support-shift-select 'always))
  17046. (org-at-item-bullet-p))
  17047. (and (not org-support-shift-select) (org-at-item-p)))
  17048. (org-call-with-arg 'org-cycle-list-bullet 'previous))
  17049. ((and (not (eq org-support-shift-select 'always))
  17050. (org-at-property-p))
  17051. (call-interactively 'org-property-previous-allowed-value))
  17052. ((org-clocktable-try-shift 'left arg))
  17053. ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
  17054. (org-support-shift-select
  17055. (org-call-for-shift-select 'backward-char))
  17056. (t (org-shiftselect-error))))
  17057. (defun org-shiftcontrolright ()
  17058. "Switch to next TODO set."
  17059. (interactive)
  17060. (cond
  17061. ((and org-support-shift-select (org-region-active-p))
  17062. (org-call-for-shift-select 'forward-word))
  17063. ((and (not (eq org-support-shift-select 'always))
  17064. (org-at-heading-p))
  17065. (org-call-with-arg 'org-todo 'nextset))
  17066. (org-support-shift-select
  17067. (org-call-for-shift-select 'forward-word))
  17068. (t (org-shiftselect-error))))
  17069. (defun org-shiftcontrolleft ()
  17070. "Switch to previous TODO set."
  17071. (interactive)
  17072. (cond
  17073. ((and org-support-shift-select (org-region-active-p))
  17074. (org-call-for-shift-select 'backward-word))
  17075. ((and (not (eq org-support-shift-select 'always))
  17076. (org-at-heading-p))
  17077. (org-call-with-arg 'org-todo 'previousset))
  17078. (org-support-shift-select
  17079. (org-call-for-shift-select 'backward-word))
  17080. (t (org-shiftselect-error))))
  17081. (defun org-shiftcontrolup ()
  17082. "Change timestamps synchronously up in CLOCK log lines."
  17083. (interactive)
  17084. (cond ((and (not org-support-shift-select)
  17085. (org-at-clock-log-p)
  17086. (org-at-timestamp-p t))
  17087. (org-clock-timestamps-up))
  17088. (t (org-shiftselect-error))))
  17089. (defun org-shiftcontroldown ()
  17090. "Change timestamps synchronously down in CLOCK log lines."
  17091. (interactive)
  17092. (cond ((and (not org-support-shift-select)
  17093. (org-at-clock-log-p)
  17094. (org-at-timestamp-p t))
  17095. (org-clock-timestamps-down))
  17096. (t (org-shiftselect-error))))
  17097. (defun org-ctrl-c-ret ()
  17098. "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
  17099. (interactive)
  17100. (cond
  17101. ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
  17102. (t (call-interactively 'org-insert-heading))))
  17103. (defun org-find-visible ()
  17104. (let ((s (point)))
  17105. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  17106. (get-char-property s 'invisible)))
  17107. s))
  17108. (defun org-find-invisible ()
  17109. (let ((s (point)))
  17110. (while (and (not (= (point-max) (setq s (next-overlay-change s))))
  17111. (not (get-char-property s 'invisible))))
  17112. s))
  17113. (defun org-copy-visible (beg end)
  17114. "Copy the visible parts of the region."
  17115. (interactive "r")
  17116. (let (snippets s)
  17117. (save-excursion
  17118. (save-restriction
  17119. (narrow-to-region beg end)
  17120. (setq s (goto-char (point-min)))
  17121. (while (not (= (point) (point-max)))
  17122. (goto-char (org-find-invisible))
  17123. (push (buffer-substring s (point)) snippets)
  17124. (setq s (goto-char (org-find-visible))))))
  17125. (kill-new (apply 'concat (nreverse snippets)))))
  17126. (defun org-copy-special ()
  17127. "Copy region in table or copy current subtree.
  17128. Calls `org-table-copy' or `org-copy-subtree', depending on context.
  17129. See the individual commands for more information."
  17130. (interactive)
  17131. (call-interactively
  17132. (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
  17133. (defun org-cut-special ()
  17134. "Cut region in table or cut current subtree.
  17135. Calls `org-table-copy' or `org-cut-subtree', depending on context.
  17136. See the individual commands for more information."
  17137. (interactive)
  17138. (call-interactively
  17139. (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
  17140. (defun org-paste-special (arg)
  17141. "Paste rectangular region into table, or past subtree relative to level.
  17142. Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
  17143. See the individual commands for more information."
  17144. (interactive "P")
  17145. (if (org-at-table-p)
  17146. (org-table-paste-rectangle)
  17147. (org-paste-subtree arg)))
  17148. (defun org-edit-special (&optional arg)
  17149. "Call a special editor for the stuff at point.
  17150. When at a table, call the formula editor with `org-table-edit-formulas'.
  17151. When at the first line of an src example, call `org-edit-src-code'.
  17152. When in an #+include line, visit the include file. Otherwise call
  17153. `ffap' to visit the file at point."
  17154. (interactive)
  17155. ;; possibly prep session before editing source
  17156. (when arg
  17157. (let* ((info (org-babel-get-src-block-info))
  17158. (lang (nth 0 info))
  17159. (params (nth 2 info))
  17160. (session (cdr (assoc :session params))))
  17161. (when (and info session) ;; we are in a source-code block with a session
  17162. (funcall
  17163. (intern (concat "org-babel-prep-session:" lang)) session params))))
  17164. (cond ;; proceed with `org-edit-special'
  17165. ((save-excursion
  17166. (beginning-of-line 1)
  17167. (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
  17168. (find-file (org-trim (match-string 1))))
  17169. ((org-edit-src-code))
  17170. ((org-edit-fixed-width-region))
  17171. ((org-at-table.el-p)
  17172. (org-edit-src-code))
  17173. ((or (org-at-table-p)
  17174. (save-excursion
  17175. (beginning-of-line 1)
  17176. (let ((case-fold-search )) (looking-at "[ \t]*#\\+tblfm:"))))
  17177. (call-interactively 'org-table-edit-formulas))
  17178. (t (call-interactively 'ffap))))
  17179. (defvar org-table-coordinate-overlays) ; defined in org-table.el
  17180. (defun org-ctrl-c-ctrl-c (&optional arg)
  17181. "Set tags in headline, or update according to changed information at point.
  17182. This command does many different things, depending on context:
  17183. - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
  17184. this is what we do.
  17185. - If the cursor is on a statistics cookie, update it.
  17186. - If the cursor is in a headline, prompt for tags and insert them
  17187. into the current line, aligned to `org-tags-column'. When called
  17188. with prefix arg, realign all tags in the current buffer.
  17189. - If the cursor is in one of the special #+KEYWORD lines, this
  17190. triggers scanning the buffer for these lines and updating the
  17191. information.
  17192. - If the cursor is inside a table, realign the table. This command
  17193. works even if the automatic table editor has been turned off.
  17194. - If the cursor is on a #+TBLFM line, re-apply the formulas to
  17195. the entire table.
  17196. - If the cursor is at a footnote reference or definition, jump to
  17197. the corresponding definition or references, respectively.
  17198. - If the cursor is a the beginning of a dynamic block, update it.
  17199. - If the current buffer is a capture buffer, close note and file it.
  17200. - If the cursor is on a <<<target>>>, update radio targets and
  17201. corresponding links in this buffer.
  17202. - If the cursor is on a numbered item in a plain list, renumber the
  17203. ordered list.
  17204. - If the cursor is on a checkbox, toggle it.
  17205. - If the cursor is on a code block, evaluate it. The variable
  17206. `org-confirm-babel-evaluate' can be used to control prompting
  17207. before code block evaluation, by default every code block
  17208. evaluation requires confirmation. Code block evaluation can be
  17209. inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
  17210. (interactive "P")
  17211. (let ((org-enable-table-editor t))
  17212. (cond
  17213. ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
  17214. org-occur-highlights
  17215. org-latex-fragment-image-overlays)
  17216. (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
  17217. (org-remove-occur-highlights)
  17218. (org-remove-latex-fragment-image-overlays)
  17219. (message "Temporary highlights/overlays removed from current buffer"))
  17220. ((and (local-variable-p 'org-finish-function (current-buffer))
  17221. (fboundp org-finish-function))
  17222. (funcall org-finish-function))
  17223. ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
  17224. ((org-in-regexp org-ts-regexp-both)
  17225. (org-timestamp-change 0 'day))
  17226. ((or (looking-at org-property-start-re)
  17227. (org-at-property-p))
  17228. (call-interactively 'org-property-action))
  17229. ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
  17230. ((and (org-in-regexp "\\[\\([0-9]*%\\|[0-9]*/[0-9]*\\)\\]")
  17231. (or (org-at-heading-p) (org-at-item-p)))
  17232. (call-interactively 'org-update-statistics-cookies))
  17233. ((org-at-heading-p) (call-interactively 'org-set-tags))
  17234. ((org-at-table.el-p)
  17235. (message "Use C-c ' to edit table.el tables"))
  17236. ((org-at-table-p)
  17237. (org-table-maybe-eval-formula)
  17238. (if arg
  17239. (call-interactively 'org-table-recalculate)
  17240. (org-table-maybe-recalculate-line))
  17241. (call-interactively 'org-table-align)
  17242. (orgtbl-send-table 'maybe))
  17243. ((or (org-footnote-at-reference-p)
  17244. (org-footnote-at-definition-p))
  17245. (call-interactively 'org-footnote-action))
  17246. ((org-at-item-checkbox-p)
  17247. ;; Cursor at a checkbox: repair list and update checkboxes. Send
  17248. ;; list only if at top item.
  17249. (let* ((cbox (match-string 1))
  17250. (struct (org-list-struct))
  17251. (old-struct (copy-tree struct))
  17252. (parents (org-list-parents-alist struct))
  17253. (orderedp (org-entry-get nil "ORDERED"))
  17254. (firstp (= (org-list-get-top-point struct) (point-at-bol)))
  17255. block-item)
  17256. ;; Use a light version of `org-toggle-checkbox' to avoid
  17257. ;; computing list structure twice.
  17258. (let ((new-box (cond
  17259. ((equal arg '(16)) "[-]")
  17260. ((equal arg '(4)) nil)
  17261. ((equal "[X]" cbox) "[ ]")
  17262. (t "[X]"))))
  17263. (if (and firstp arg)
  17264. ;; If at first item of sub-list, remove check-box from
  17265. ;; every item at the same level.
  17266. (mapc
  17267. (lambda (pos) (org-list-set-checkbox pos struct new-box))
  17268. (org-list-get-all-items
  17269. (point-at-bol) struct (org-list-prevs-alist struct)))
  17270. (org-list-set-checkbox (point-at-bol) struct new-box)))
  17271. ;; Replicate `org-list-write-struct', while grabbing a return
  17272. ;; value from `org-list-struct-fix-box'.
  17273. (org-list-struct-fix-ind struct parents 2)
  17274. (org-list-struct-fix-item-end struct)
  17275. (let ((prevs (org-list-prevs-alist struct)))
  17276. (org-list-struct-fix-bul struct prevs)
  17277. (org-list-struct-fix-ind struct parents)
  17278. (setq block-item
  17279. (org-list-struct-fix-box struct parents prevs orderedp)))
  17280. (org-list-struct-apply-struct struct old-struct)
  17281. (org-update-checkbox-count-maybe)
  17282. (when block-item
  17283. (message
  17284. "Checkboxes were removed due to unchecked box at line %d"
  17285. (org-current-line block-item)))
  17286. (when firstp (org-list-send-list 'maybe))))
  17287. ((org-at-item-p)
  17288. ;; Cursor at an item: repair list. Do checkbox related actions
  17289. ;; only if function was called with an argument. Send list only
  17290. ;; if at top item.
  17291. (let* ((struct (org-list-struct))
  17292. (firstp (= (org-list-get-top-point struct) (point-at-bol)))
  17293. old-struct)
  17294. (when arg
  17295. (setq old-struct (copy-tree struct))
  17296. (if firstp
  17297. ;; If at first item of sub-list, add check-box to every
  17298. ;; item at the same level.
  17299. (mapc
  17300. (lambda (pos)
  17301. (unless (org-list-get-checkbox pos struct)
  17302. (org-list-set-checkbox pos struct "[ ]")))
  17303. (org-list-get-all-items
  17304. (point-at-bol) struct (org-list-prevs-alist struct)))
  17305. (org-list-set-checkbox (point-at-bol) struct "[ ]")))
  17306. (org-list-write-struct
  17307. struct (org-list-parents-alist struct) old-struct)
  17308. (when arg (org-update-checkbox-count-maybe))
  17309. (when firstp (org-list-send-list 'maybe))))
  17310. ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
  17311. ;; Dynamic block
  17312. (beginning-of-line 1)
  17313. (save-excursion (org-update-dblock)))
  17314. ((save-excursion
  17315. (let ((case-fold-search t))
  17316. (beginning-of-line 1)
  17317. (looking-at "[ \t]*#\\+\\([a-z]+\\)")))
  17318. (cond
  17319. ((or (equal (match-string 1) "TBLFM")
  17320. (equal (match-string 1) "tblfm"))
  17321. ;; Recalculate the table before this line
  17322. (save-excursion
  17323. (beginning-of-line 1)
  17324. (skip-chars-backward " \r\n\t")
  17325. (if (org-at-table-p)
  17326. (org-call-with-arg 'org-table-recalculate (or arg t)))))
  17327. (t
  17328. (let ((org-inhibit-startup-visibility-stuff t)
  17329. (org-startup-align-all-tables nil))
  17330. (when (boundp 'org-table-coordinate-overlays)
  17331. (mapc 'delete-overlay org-table-coordinate-overlays)
  17332. (setq org-table-coordinate-overlays nil))
  17333. (org-save-outline-visibility 'use-markers (org-mode-restart)))
  17334. (message "Local setup has been refreshed"))))
  17335. ((org-clock-update-time-maybe))
  17336. (t
  17337. (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
  17338. (error "C-c C-c can do nothing useful at this location"))))))
  17339. (defun org-mode-restart ()
  17340. "Restart Org-mode, to scan again for special lines.
  17341. Also updates the keyword regular expressions."
  17342. (interactive)
  17343. (org-mode)
  17344. (message "Org-mode restarted"))
  17345. (defun org-kill-note-or-show-branches ()
  17346. "If this is a Note buffer, abort storing the note. Else call `show-branches'."
  17347. (interactive)
  17348. (if (not org-finish-function)
  17349. (progn
  17350. (hide-subtree)
  17351. (call-interactively 'show-branches))
  17352. (let ((org-note-abort t))
  17353. (funcall org-finish-function))))
  17354. (defun org-return (&optional indent)
  17355. "Goto next table row or insert a newline.
  17356. Calls `org-table-next-row' or `newline', depending on context.
  17357. See the individual commands for more information."
  17358. (interactive)
  17359. (let (org-ts-what)
  17360. (cond
  17361. ((or (bobp) (org-in-src-block-p))
  17362. (if indent (newline-and-indent) (newline)))
  17363. ((org-at-table-p)
  17364. (org-table-justify-field-maybe)
  17365. (call-interactively 'org-table-next-row))
  17366. ;; when `newline-and-indent' is called within a list, make sure
  17367. ;; text moved stays inside the item.
  17368. ((and (org-in-item-p) indent)
  17369. (if (and (org-at-item-p) (>= (point) (match-end 0)))
  17370. (progn
  17371. (save-match-data (newline))
  17372. (org-indent-line-to (length (match-string 0))))
  17373. (let ((ind (org-get-indentation)))
  17374. (newline)
  17375. (if (org-looking-back org-list-end-re)
  17376. (org-indent-line-function)
  17377. (org-indent-line-to ind)))))
  17378. ((and org-return-follows-link
  17379. (org-at-timestamp-p t)
  17380. (not (eq org-ts-what 'after)))
  17381. (org-follow-timestamp-link))
  17382. ((and org-return-follows-link
  17383. (let ((tprop (get-text-property (point) 'face)))
  17384. (or (eq tprop 'org-link)
  17385. (and (listp tprop) (memq 'org-link tprop)))))
  17386. (call-interactively 'org-open-at-point))
  17387. ((and (org-at-heading-p)
  17388. (looking-at
  17389. (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
  17390. (org-show-entry)
  17391. (end-of-line 1)
  17392. (newline))
  17393. (t (if indent (newline-and-indent) (newline))))))
  17394. (defun org-return-indent ()
  17395. "Goto next table row or insert a newline and indent.
  17396. Calls `org-table-next-row' or `newline-and-indent', depending on
  17397. context. See the individual commands for more information."
  17398. (interactive)
  17399. (org-return t))
  17400. (defun org-ctrl-c-star ()
  17401. "Compute table, or change heading status of lines.
  17402. Calls `org-table-recalculate' or `org-toggle-heading',
  17403. depending on context."
  17404. (interactive)
  17405. (cond
  17406. ((org-at-table-p)
  17407. (call-interactively 'org-table-recalculate))
  17408. (t
  17409. ;; Convert all lines in region to list items
  17410. (call-interactively 'org-toggle-heading))))
  17411. (defun org-ctrl-c-minus ()
  17412. "Insert separator line in table or modify bullet status of line.
  17413. Also turns a plain line or a region of lines into list items.
  17414. Calls `org-table-insert-hline', `org-toggle-item', or
  17415. `org-cycle-list-bullet', depending on context."
  17416. (interactive)
  17417. (cond
  17418. ((org-at-table-p)
  17419. (call-interactively 'org-table-insert-hline))
  17420. ((org-region-active-p)
  17421. (call-interactively 'org-toggle-item))
  17422. ((org-in-item-p)
  17423. (call-interactively 'org-cycle-list-bullet))
  17424. (t
  17425. (call-interactively 'org-toggle-item))))
  17426. (defun org-toggle-item (arg)
  17427. "Convert headings or normal lines to items, items to normal lines.
  17428. If there is no active region, only the current line is considered.
  17429. If the first non blank line in the region is an headline, convert
  17430. all headlines to items, shifting text accordingly.
  17431. If it is an item, convert all items to normal lines.
  17432. If it is normal text, change region into an item. With a prefix
  17433. argument ARG, change each line in region into an item."
  17434. (interactive "P")
  17435. (let ((shift-text
  17436. (function
  17437. ;; Shift text in current section to IND, from point to END.
  17438. ;; The function leaves point to END line.
  17439. (lambda (ind end)
  17440. (let ((min-i 1000) (end (copy-marker end)))
  17441. ;; First determine the minimum indentation (MIN-I) of
  17442. ;; the text.
  17443. (save-excursion
  17444. (catch 'exit
  17445. (while (< (point) end)
  17446. (let ((i (org-get-indentation)))
  17447. (cond
  17448. ;; Skip blank lines and inline tasks.
  17449. ((looking-at "^[ \t]*$"))
  17450. ((looking-at org-outline-regexp-bol))
  17451. ;; We can't find less than 0 indentation.
  17452. ((zerop i) (throw 'exit (setq min-i 0)))
  17453. ((< i min-i) (setq min-i i))))
  17454. (forward-line))))
  17455. ;; Then indent each line so that a line indented to
  17456. ;; MIN-I becomes indented to IND. Ignore blank lines
  17457. ;; and inline tasks in the process.
  17458. (let ((delta (- ind min-i)))
  17459. (while (< (point) end)
  17460. (unless (or (looking-at "^[ \t]*$")
  17461. (looking-at org-outline-regexp-bol))
  17462. (org-indent-line-to (+ (org-get-indentation) delta)))
  17463. (forward-line)))))))
  17464. (skip-blanks
  17465. (function
  17466. ;; Return beginning of first non-blank line, starting from
  17467. ;; line at POS.
  17468. (lambda (pos)
  17469. (save-excursion
  17470. (goto-char pos)
  17471. (skip-chars-forward " \r\t\n")
  17472. (point-at-bol)))))
  17473. beg end)
  17474. ;; Determine boundaries of changes.
  17475. (if (org-region-active-p)
  17476. (setq beg (funcall skip-blanks (region-beginning))
  17477. end (copy-marker (region-end)))
  17478. (setq beg (funcall skip-blanks (point-at-bol))
  17479. end (copy-marker (point-at-eol))))
  17480. ;; Depending on the starting line, choose an action on the text
  17481. ;; between BEG and END.
  17482. (org-with-limited-levels
  17483. (save-excursion
  17484. (goto-char beg)
  17485. (cond
  17486. ;; Case 1. Start at an item: de-itemize. Note that it only
  17487. ;; happens when a region is active: `org-ctrl-c-minus'
  17488. ;; would call `org-cycle-list-bullet' otherwise.
  17489. ((org-at-item-p)
  17490. (while (< (point) end)
  17491. (when (org-at-item-p)
  17492. (skip-chars-forward " \t")
  17493. (delete-region (point) (match-end 0)))
  17494. (forward-line)))
  17495. ;; Case 2. Start at an heading: convert to items.
  17496. ((org-at-heading-p)
  17497. (let* ((bul (org-list-bullet-string "-"))
  17498. (bul-len (length bul))
  17499. ;; Indentation of the first heading. It should be
  17500. ;; relative to the indentation of its parent, if any.
  17501. (start-ind (save-excursion
  17502. (cond
  17503. ((not org-adapt-indentation) 0)
  17504. ((not (outline-previous-heading)) 0)
  17505. (t (length (match-string 0))))))
  17506. ;; Level of first heading. Further headings will be
  17507. ;; compared to it to determine hierarchy in the list.
  17508. (ref-level (org-reduced-level (org-outline-level))))
  17509. (while (< (point) end)
  17510. (let* ((level (org-reduced-level (org-outline-level)))
  17511. (delta (max 0 (- level ref-level))))
  17512. ;; If current headline is less indented than the first
  17513. ;; one, set it as reference, in order to preserve
  17514. ;; subtrees.
  17515. (when (< level ref-level) (setq ref-level level))
  17516. (replace-match bul t t)
  17517. (org-indent-line-to (+ start-ind (* delta bul-len)))
  17518. ;; Ensure all text down to END (or SECTION-END) belongs
  17519. ;; to the newly created item.
  17520. (let ((section-end (save-excursion
  17521. (or (outline-next-heading) (point)))))
  17522. (forward-line)
  17523. (funcall shift-text
  17524. (+ start-ind (* (1+ delta) bul-len))
  17525. (min end section-end)))))))
  17526. ;; Case 3. Normal line with ARG: turn each non-item line into
  17527. ;; an item.
  17528. (arg
  17529. (while (< (point) end)
  17530. (unless (or (org-at-heading-p) (org-at-item-p))
  17531. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  17532. (replace-match
  17533. (concat "\\1" (org-list-bullet-string "-") "\\2"))))
  17534. (forward-line)))
  17535. ;; Case 4. Normal line without ARG: make the first line of
  17536. ;; region an item, and shift indentation of others
  17537. ;; lines to set them as item's body.
  17538. (t (let* ((bul (org-list-bullet-string "-"))
  17539. (bul-len (length bul))
  17540. (ref-ind (org-get-indentation)))
  17541. (skip-chars-forward " \t")
  17542. (insert bul)
  17543. (forward-line)
  17544. (while (< (point) end)
  17545. ;; Ensure that lines less indented than first one
  17546. ;; still get included in item body.
  17547. (funcall shift-text
  17548. (+ ref-ind bul-len)
  17549. (min end (save-excursion (or (outline-next-heading)
  17550. (point)))))
  17551. (forward-line)))))))))
  17552. (defun org-toggle-heading (&optional nstars)
  17553. "Convert headings to normal text, or items or text to headings.
  17554. If there is no active region, only the current line is considered.
  17555. With a \\[universal-argument] prefix, convert the whole list at
  17556. point into heading.
  17557. In a region:
  17558. - If the first non blank line is an headline, remove the stars
  17559. from all headlines in the region.
  17560. - If it is a normal line turn each and every normal line (i.e. not an
  17561. heading or an item) in the region into a heading.
  17562. - If it is a plain list item, turn all plain list items into headings.
  17563. When converting a line into a heading, the number of stars is chosen
  17564. such that the lines become children of the current entry. However,
  17565. when a prefix argument is given, its value determines the number of
  17566. stars to add."
  17567. (interactive "P")
  17568. (let ((skip-blanks
  17569. (function
  17570. ;; Return beginning of first non-blank line, starting from
  17571. ;; line at POS.
  17572. (lambda (pos)
  17573. (save-excursion
  17574. (goto-char pos)
  17575. (while (org-at-comment-p) (forward-line))
  17576. (skip-chars-forward " \r\t\n")
  17577. (point-at-bol)))))
  17578. beg end toggled)
  17579. ;; Determine boundaries of changes. If a universal prefix has
  17580. ;; been given, put the list in a region. If region ends at a bol,
  17581. ;; do not consider the last line to be in the region.
  17582. (when (and current-prefix-arg (org-at-item-p))
  17583. (if (equal current-prefix-arg '(4)) (setq current-prefix-arg 1))
  17584. (org-mark-list))
  17585. (if (org-region-active-p)
  17586. (setq beg (funcall skip-blanks (region-beginning))
  17587. end (copy-marker (save-excursion
  17588. (goto-char (region-end))
  17589. (if (bolp) (point) (point-at-eol)))))
  17590. (setq beg (funcall skip-blanks (point-at-bol))
  17591. end (copy-marker (point-at-eol))))
  17592. ;; Ensure inline tasks don't count as headings.
  17593. (org-with-limited-levels
  17594. (save-excursion
  17595. (goto-char beg)
  17596. (cond
  17597. ;; Case 1. Started at an heading: de-star headings.
  17598. ((org-at-heading-p)
  17599. (while (< (point) end)
  17600. (when (org-at-heading-p t)
  17601. (looking-at org-outline-regexp) (replace-match "")
  17602. (setq toggled t))
  17603. (forward-line)))
  17604. ;; Case 2. Started at an item: change items into headlines.
  17605. ;; One star will be added by `org-list-to-subtree'.
  17606. ((org-at-item-p)
  17607. (let* ((stars (make-string
  17608. (if nstars
  17609. ;; subtract the star that will be added again by
  17610. ;; `org-list-to-subtree'
  17611. (1- (prefix-numeric-value current-prefix-arg))
  17612. (or (org-current-level) 0))
  17613. ?*))
  17614. (add-stars
  17615. (cond (nstars "") ; stars from prefix only
  17616. ((equal stars "") "") ; before first heading
  17617. (org-odd-levels-only "*") ; inside heading, odd
  17618. (t "")))) ; inside heading, oddeven
  17619. (while (< (point) end)
  17620. (when (org-at-item-p)
  17621. ;; Pay attention to cases when region ends before list.
  17622. (let* ((struct (org-list-struct))
  17623. (list-end (min (org-list-get-bottom-point struct) (1+ end))))
  17624. (save-restriction
  17625. (narrow-to-region (point) list-end)
  17626. (insert
  17627. (org-list-to-subtree
  17628. (org-list-parse-list t)
  17629. '(:istart (concat stars add-stars (funcall get-stars depth))
  17630. :icount (concat stars add-stars (funcall get-stars depth)))))))
  17631. (setq toggled t))
  17632. (forward-line))))
  17633. ;; Case 3. Started at normal text: make every line an heading,
  17634. ;; skipping headlines and items.
  17635. (t (let* ((stars (make-string
  17636. (if nstars
  17637. (prefix-numeric-value current-prefix-arg)
  17638. (or (org-current-level) 0))
  17639. ?*))
  17640. (add-stars
  17641. (cond (nstars "") ; stars from prefix only
  17642. ((equal stars "") "*") ; before first heading
  17643. (org-odd-levels-only "**") ; inside heading, odd
  17644. (t "*"))) ; inside heading, oddeven
  17645. (rpl (concat stars add-stars " ")))
  17646. (while (< (point) end)
  17647. (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
  17648. (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
  17649. (replace-match (concat rpl (match-string 2))) (setq toggled t))
  17650. (forward-line)))))))
  17651. (unless toggled (message "Cannot toggle heading from here"))))
  17652. (defun org-meta-return (&optional arg)
  17653. "Insert a new heading or wrap a region in a table.
  17654. Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
  17655. See the individual commands for more information."
  17656. (interactive "P")
  17657. (cond
  17658. ((run-hook-with-args-until-success 'org-metareturn-hook))
  17659. ((or (org-at-drawer-p) (org-at-property-p))
  17660. (newline-and-indent))
  17661. ((org-at-table-p)
  17662. (call-interactively 'org-table-wrap-region))
  17663. (t (call-interactively 'org-insert-heading))))
  17664. ;;; Menu entries
  17665. ;; Define the Org-mode menus
  17666. (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
  17667. '("Tbl"
  17668. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
  17669. ["Next Field" org-cycle (org-at-table-p)]
  17670. ["Previous Field" org-shifttab (org-at-table-p)]
  17671. ["Next Row" org-return (org-at-table-p)]
  17672. "--"
  17673. ["Blank Field" org-table-blank-field (org-at-table-p)]
  17674. ["Edit Field" org-table-edit-field (org-at-table-p)]
  17675. ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
  17676. "--"
  17677. ("Column"
  17678. ["Move Column Left" org-metaleft (org-at-table-p)]
  17679. ["Move Column Right" org-metaright (org-at-table-p)]
  17680. ["Delete Column" org-shiftmetaleft (org-at-table-p)]
  17681. ["Insert Column" org-shiftmetaright (org-at-table-p)])
  17682. ("Row"
  17683. ["Move Row Up" org-metaup (org-at-table-p)]
  17684. ["Move Row Down" org-metadown (org-at-table-p)]
  17685. ["Delete Row" org-shiftmetaup (org-at-table-p)]
  17686. ["Insert Row" org-shiftmetadown (org-at-table-p)]
  17687. ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
  17688. "--"
  17689. ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
  17690. ("Rectangle"
  17691. ["Copy Rectangle" org-copy-special (org-at-table-p)]
  17692. ["Cut Rectangle" org-cut-special (org-at-table-p)]
  17693. ["Paste Rectangle" org-paste-special (org-at-table-p)]
  17694. ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
  17695. "--"
  17696. ("Calculate"
  17697. ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
  17698. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  17699. ["Edit Formulas" org-edit-special (org-at-table-p)]
  17700. "--"
  17701. ["Recalculate line" org-table-recalculate (org-at-table-p)]
  17702. ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
  17703. ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  17704. "--"
  17705. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
  17706. "--"
  17707. ["Sum Column/Rectangle" org-table-sum
  17708. (or (org-at-table-p) (org-region-active-p))]
  17709. ["Which Column?" org-table-current-column (org-at-table-p)])
  17710. ["Debug Formulas"
  17711. org-table-toggle-formula-debugger
  17712. :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
  17713. ["Show Col/Row Numbers"
  17714. org-table-toggle-coordinate-overlays
  17715. :style toggle
  17716. :selected (org-bound-and-true-p org-table-overlay-coordinates)]
  17717. "--"
  17718. ["Create" org-table-create (and (not (org-at-table-p))
  17719. org-enable-table-editor)]
  17720. ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
  17721. ["Import from File" org-table-import (not (org-at-table-p))]
  17722. ["Export to File" org-table-export (org-at-table-p)]
  17723. "--"
  17724. ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
  17725. (easy-menu-define org-org-menu org-mode-map "Org menu"
  17726. '("Org"
  17727. ("Show/Hide"
  17728. ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
  17729. ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
  17730. ["Sparse Tree..." org-sparse-tree t]
  17731. ["Reveal Context" org-reveal t]
  17732. ["Show All" show-all t]
  17733. "--"
  17734. ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
  17735. "--"
  17736. ["New Heading" org-insert-heading t]
  17737. ("Navigate Headings"
  17738. ["Up" outline-up-heading t]
  17739. ["Next" outline-next-visible-heading t]
  17740. ["Previous" outline-previous-visible-heading t]
  17741. ["Next Same Level" outline-forward-same-level t]
  17742. ["Previous Same Level" outline-backward-same-level t]
  17743. "--"
  17744. ["Jump" org-goto t])
  17745. ("Edit Structure"
  17746. ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
  17747. ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
  17748. "--"
  17749. ["Copy Subtree" org-copy-special (not (org-at-table-p))]
  17750. ["Cut Subtree" org-cut-special (not (org-at-table-p))]
  17751. ["Paste Subtree" org-paste-special (not (org-at-table-p))]
  17752. "--"
  17753. ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
  17754. "--"
  17755. ["Copy visible text" org-copy-visible t]
  17756. "--"
  17757. ["Promote Heading" org-metaleft (not (org-at-table-p))]
  17758. ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
  17759. ["Demote Heading" org-metaright (not (org-at-table-p))]
  17760. ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
  17761. "--"
  17762. ["Sort Region/Children" org-sort (not (org-at-table-p))]
  17763. "--"
  17764. ["Convert to odd levels" org-convert-to-odd-levels t]
  17765. ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
  17766. ("Editing"
  17767. ["Emphasis..." org-emphasize t]
  17768. ["Edit Source Example" org-edit-special t]
  17769. "--"
  17770. ["Footnote new/jump" org-footnote-action t]
  17771. ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
  17772. ("Archive"
  17773. ["Archive (default method)" org-archive-subtree-default t]
  17774. "--"
  17775. ["Move Subtree to Archive file" org-advertized-archive-subtree t]
  17776. ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
  17777. ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
  17778. )
  17779. "--"
  17780. ("Hyperlinks"
  17781. ["Store Link (Global)" org-store-link t]
  17782. ["Find existing link to here" org-occur-link-in-agenda-files t]
  17783. ["Insert Link" org-insert-link t]
  17784. ["Follow Link" org-open-at-point t]
  17785. "--"
  17786. ["Next link" org-next-link t]
  17787. ["Previous link" org-previous-link t]
  17788. "--"
  17789. ["Descriptive Links"
  17790. org-toggle-link-display
  17791. :style radio
  17792. :selected org-descriptive-links
  17793. ]
  17794. ["Literal Links"
  17795. org-toggle-link-display
  17796. :style radio
  17797. :selected (not org-descriptive-links)])
  17798. "--"
  17799. ("TODO Lists"
  17800. ["TODO/DONE/-" org-todo t]
  17801. ("Select keyword"
  17802. ["Next keyword" org-shiftright (org-at-heading-p)]
  17803. ["Previous keyword" org-shiftleft (org-at-heading-p)]
  17804. ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
  17805. ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
  17806. ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
  17807. ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
  17808. ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
  17809. "--"
  17810. ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
  17811. :selected org-enforce-todo-dependencies :style toggle :active t]
  17812. "Settings for tree at point"
  17813. ["Do Children sequentially" org-toggle-ordered-property :style radio
  17814. :selected (org-entry-get nil "ORDERED")
  17815. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  17816. ["Do Children parallel" org-toggle-ordered-property :style radio
  17817. :selected (not (org-entry-get nil "ORDERED"))
  17818. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  17819. "--"
  17820. ["Set Priority" org-priority t]
  17821. ["Priority Up" org-shiftup t]
  17822. ["Priority Down" org-shiftdown t]
  17823. "--"
  17824. ["Get news from all feeds" org-feed-update-all t]
  17825. ["Go to the inbox of a feed..." org-feed-goto-inbox t]
  17826. ["Customize feeds" (customize-variable 'org-feed-alist) t])
  17827. ("TAGS and Properties"
  17828. ["Set Tags" org-set-tags-command t]
  17829. ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
  17830. "--"
  17831. ["Set property" org-set-property t]
  17832. ["Column view of properties" org-columns t]
  17833. ["Insert Column View DBlock" org-insert-columns-dblock t])
  17834. ("Dates and Scheduling"
  17835. ["Timestamp" org-time-stamp t]
  17836. ["Timestamp (inactive)" org-time-stamp-inactive t]
  17837. ("Change Date"
  17838. ["1 Day Later" org-shiftright t]
  17839. ["1 Day Earlier" org-shiftleft t]
  17840. ["1 ... Later" org-shiftup t]
  17841. ["1 ... Earlier" org-shiftdown t])
  17842. ["Compute Time Range" org-evaluate-time-range t]
  17843. ["Schedule Item" org-schedule t]
  17844. ["Deadline" org-deadline t]
  17845. "--"
  17846. ["Custom time format" org-toggle-time-stamp-overlays
  17847. :style radio :selected org-display-custom-times]
  17848. "--"
  17849. ["Goto Calendar" org-goto-calendar t]
  17850. ["Date from Calendar" org-date-from-calendar t]
  17851. "--"
  17852. ["Start/Restart Timer" org-timer-start t]
  17853. ["Pause/Continue Timer" org-timer-pause-or-continue t]
  17854. ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
  17855. ["Insert Timer String" org-timer t]
  17856. ["Insert Timer Item" org-timer-item t])
  17857. ("Logging work"
  17858. ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
  17859. ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
  17860. ["Clock out" org-clock-out t]
  17861. ["Clock cancel" org-clock-cancel t]
  17862. "--"
  17863. ["Mark as default task" org-clock-mark-default-task t]
  17864. ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
  17865. ["Goto running clock" org-clock-goto t]
  17866. "--"
  17867. ["Display times" org-clock-display t]
  17868. ["Create clock table" org-clock-report t]
  17869. "--"
  17870. ["Record DONE time"
  17871. (progn (setq org-log-done (not org-log-done))
  17872. (message "Switching to %s will %s record a timestamp"
  17873. (car org-done-keywords)
  17874. (if org-log-done "automatically" "not")))
  17875. :style toggle :selected org-log-done])
  17876. "--"
  17877. ["Agenda Command..." org-agenda t]
  17878. ["Set Restriction Lock" org-agenda-set-restriction-lock t]
  17879. ("File List for Agenda")
  17880. ("Special views current file"
  17881. ["TODO Tree" org-show-todo-tree t]
  17882. ["Check Deadlines" org-check-deadlines t]
  17883. ["Timeline" org-timeline t]
  17884. ["Tags/Property tree" org-match-sparse-tree t])
  17885. "--"
  17886. ["Export/Publish..." org-export t]
  17887. ("LaTeX"
  17888. ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
  17889. :selected org-cdlatex-mode]
  17890. ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
  17891. ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
  17892. ["Modify math symbol" org-cdlatex-math-modify
  17893. (org-inside-LaTeX-fragment-p)]
  17894. ["Insert citation" org-reftex-citation t]
  17895. "--"
  17896. ["Template for BEAMER" (progn (require 'org-beamer)
  17897. (org-insert-beamer-options-template)) t])
  17898. "--"
  17899. ("MobileOrg"
  17900. ["Push Files and Views" org-mobile-push t]
  17901. ["Get Captured and Flagged" org-mobile-pull t]
  17902. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  17903. "--"
  17904. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  17905. "--"
  17906. ("Documentation"
  17907. ["Show Version" org-version t]
  17908. ["Info Documentation" org-info t])
  17909. ("Customize"
  17910. ["Browse Org Group" org-customize t]
  17911. "--"
  17912. ["Expand This Menu" org-create-customize-menu
  17913. (fboundp 'customize-menu-create)])
  17914. ["Send bug report" org-submit-bug-report t]
  17915. "--"
  17916. ("Refresh/Reload"
  17917. ["Refresh setup current buffer" org-mode-restart t]
  17918. ["Reload Org (after update)" org-reload t]
  17919. ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
  17920. ))
  17921. (defun org-info (&optional node)
  17922. "Read documentation for Org-mode in the info system.
  17923. With optional NODE, go directly to that node."
  17924. (interactive)
  17925. (info (format "(org)%s" (or node ""))))
  17926. ;;;###autoload
  17927. (defun org-submit-bug-report ()
  17928. "Submit a bug report on Org-mode via mail.
  17929. Don't hesitate to report any problems or inaccurate documentation.
  17930. If you don't have setup sending mail from (X)Emacs, please copy the
  17931. output buffer into your mail program, as it gives us important
  17932. information about your Org-mode version and configuration."
  17933. (interactive)
  17934. (require 'reporter)
  17935. (org-load-modules-maybe)
  17936. (org-require-autoloaded-modules)
  17937. (let ((reporter-prompt-for-summary-p "Bug report subject: "))
  17938. (reporter-submit-bug-report
  17939. "emacs-orgmode@gnu.org"
  17940. (org-version nil 'full)
  17941. (let (list)
  17942. (save-window-excursion
  17943. (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
  17944. (delete-other-windows)
  17945. (erase-buffer)
  17946. (insert "You are about to submit a bug report to the Org-mode mailing list.
  17947. We would like to add your full Org-mode and Outline configuration to the
  17948. bug report. This greatly simplifies the work of the maintainer and
  17949. other experts on the mailing list.
  17950. HOWEVER, some variables you have customized may contain private
  17951. information. The names of customers, colleagues, or friends, might
  17952. appear in the form of file names, tags, todo states, or search strings.
  17953. If you answer yes to the prompt, you might want to check and remove
  17954. such private information before sending the email.")
  17955. (add-text-properties (point-min) (point-max) '(face org-warning))
  17956. (when (yes-or-no-p "Include your Org-mode configuration ")
  17957. (mapatoms
  17958. (lambda (v)
  17959. (and (boundp v)
  17960. (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
  17961. (or (and (symbol-value v)
  17962. (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
  17963. (and
  17964. (get v 'custom-type) (get v 'standard-value)
  17965. (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
  17966. (push v list)))))
  17967. (kill-buffer (get-buffer "*Warn about privacy*"))
  17968. list))
  17969. nil nil
  17970. "Remember to cover the basics, that is, what you expected to happen and
  17971. what in fact did happen. You don't know how to make a good report? See
  17972. http://orgmode.org/manual/Feedback.html#Feedback
  17973. Your bug report will be posted to the Org-mode mailing list.
  17974. ------------------------------------------------------------------------")
  17975. (save-excursion
  17976. (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
  17977. (replace-match "\\1Bug: \\3 [\\2]")))))
  17978. (defun org-install-agenda-files-menu ()
  17979. (let ((bl (buffer-list)))
  17980. (save-excursion
  17981. (while bl
  17982. (set-buffer (pop bl))
  17983. (if (derived-mode-p 'org-mode) (setq bl nil)))
  17984. (when (derived-mode-p 'org-mode)
  17985. (easy-menu-change
  17986. '("Org") "File List for Agenda"
  17987. (append
  17988. (list
  17989. ["Edit File List" (org-edit-agenda-file-list) t]
  17990. ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
  17991. ["Remove Current File from List" org-remove-file t]
  17992. ["Cycle through agenda files" org-cycle-agenda-files t]
  17993. ["Occur in all agenda files" org-occur-in-agenda-files t]
  17994. "--")
  17995. (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
  17996. ;;;; Documentation
  17997. ;;;###autoload
  17998. (defun org-require-autoloaded-modules ()
  17999. (interactive)
  18000. (mapc 'require
  18001. '(org-agenda org-archive org-ascii org-attach org-clock org-colview
  18002. org-docbook org-exp org-html org-icalendar
  18003. org-id org-latex
  18004. org-publish org-remember org-table
  18005. org-timer org-xoxo)))
  18006. ;;;###autoload
  18007. (defun org-reload (&optional uncompiled)
  18008. "Reload all org lisp files.
  18009. With prefix arg UNCOMPILED, load the uncompiled versions."
  18010. (interactive "P")
  18011. (require 'find-func)
  18012. (let* ((file-re "^org\\(-.*\\)?\\.el")
  18013. (dir-org (file-name-directory (org-find-library-dir "org")))
  18014. (dir-org-contrib (ignore-errors
  18015. (file-name-directory
  18016. (org-find-library-dir "org-contribdir"))))
  18017. (babel-files
  18018. (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
  18019. (append (list nil "comint" "eval" "exp" "keys"
  18020. "lob" "ref" "table" "tangle")
  18021. (delq nil
  18022. (mapcar
  18023. (lambda (lang)
  18024. (when (cdr lang) (symbol-name (car lang))))
  18025. org-babel-load-languages)))))
  18026. (files
  18027. (append babel-files
  18028. (and dir-org-contrib
  18029. (directory-files dir-org-contrib t file-re))
  18030. (directory-files dir-org t file-re)))
  18031. (remove-re (concat (if (featurep 'xemacs)
  18032. "org-colview" "org-colview-xemacs")
  18033. "\\'")))
  18034. (setq files (mapcar 'file-name-sans-extension files))
  18035. (setq files (mapcar
  18036. (lambda (x) (if (string-match remove-re x) nil x))
  18037. files))
  18038. (setq files (delq nil files))
  18039. (mapc
  18040. (lambda (f)
  18041. (when (featurep (intern (file-name-nondirectory f)))
  18042. (if (and (not uncompiled)
  18043. (file-exists-p (concat f ".elc")))
  18044. (load (concat f ".elc") nil nil 'nosuffix)
  18045. (load (concat f ".el") nil nil 'nosuffix))))
  18046. files)
  18047. (load (concat dir-org "org-version.el") 'noerror nil 'nosuffix))
  18048. (org-version nil 'full 'message))
  18049. ;;;###autoload
  18050. (defun org-customize ()
  18051. "Call the customize function with org as argument."
  18052. (interactive)
  18053. (org-load-modules-maybe)
  18054. (org-require-autoloaded-modules)
  18055. (customize-browse 'org))
  18056. (defun org-create-customize-menu ()
  18057. "Create a full customization menu for Org-mode, insert it into the menu."
  18058. (interactive)
  18059. (org-load-modules-maybe)
  18060. (org-require-autoloaded-modules)
  18061. (if (fboundp 'customize-menu-create)
  18062. (progn
  18063. (easy-menu-change
  18064. '("Org") "Customize"
  18065. `(["Browse Org group" org-customize t]
  18066. "--"
  18067. ,(customize-menu-create 'org)
  18068. ["Set" Custom-set t]
  18069. ["Save" Custom-save t]
  18070. ["Reset to Current" Custom-reset-current t]
  18071. ["Reset to Saved" Custom-reset-saved t]
  18072. ["Reset to Standard Settings" Custom-reset-standard t]))
  18073. (message "\"Org\"-menu now contains full customization menu"))
  18074. (error "Cannot expand menu (outdated version of cus-edit.el)")))
  18075. ;;;; Miscellaneous stuff
  18076. ;;; Generally useful functions
  18077. (defun org-get-at-bol (property)
  18078. "Get text property PROPERTY at beginning of line."
  18079. (get-text-property (point-at-bol) property))
  18080. (defun org-find-text-property-in-string (prop s)
  18081. "Return the first non-nil value of property PROP in string S."
  18082. (or (get-text-property 0 prop s)
  18083. (get-text-property (or (next-single-property-change 0 prop s) 0)
  18084. prop s)))
  18085. (defun org-display-warning (message) ;; Copied from Emacs-Muse
  18086. "Display the given MESSAGE as a warning."
  18087. (if (fboundp 'display-warning)
  18088. (display-warning 'org message
  18089. (if (featurep 'xemacs) 'warning :warning))
  18090. (let ((buf (get-buffer-create "*Org warnings*")))
  18091. (with-current-buffer buf
  18092. (goto-char (point-max))
  18093. (insert "Warning (Org): " message)
  18094. (unless (bolp)
  18095. (newline)))
  18096. (display-buffer buf)
  18097. (sit-for 0))))
  18098. (defun org-eval (form)
  18099. "Eval FORM and return result."
  18100. (condition-case error
  18101. (eval form)
  18102. (error (format "%%![Error: %s]" error))))
  18103. (defun org-in-clocktable-p ()
  18104. "Check if the cursor is in a clocktable."
  18105. (let ((pos (point)) start)
  18106. (save-excursion
  18107. (end-of-line 1)
  18108. (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
  18109. (setq start (match-beginning 0))
  18110. (re-search-forward "^[ \t]*#\\+END:.*" nil t)
  18111. (>= (match-end 0) pos)
  18112. start))))
  18113. (defun org-in-commented-line ()
  18114. "Is point in a line starting with `#'?"
  18115. (equal (char-after (point-at-bol)) ?#))
  18116. (defun org-in-indented-comment-line ()
  18117. "Is point in a line starting with `#' after some white space?"
  18118. (save-excursion
  18119. (save-match-data
  18120. (goto-char (point-at-bol))
  18121. (looking-at "[ \t]*#"))))
  18122. (defun org-in-verbatim-emphasis ()
  18123. (save-match-data
  18124. (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
  18125. (defun org-goto-marker-or-bmk (marker &optional bookmark)
  18126. "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
  18127. (if (and marker (marker-buffer marker)
  18128. (buffer-live-p (marker-buffer marker)))
  18129. (progn
  18130. (org-pop-to-buffer-same-window (marker-buffer marker))
  18131. (if (or (> marker (point-max)) (< marker (point-min)))
  18132. (widen))
  18133. (goto-char marker)
  18134. (org-show-context 'org-goto))
  18135. (if bookmark
  18136. (bookmark-jump bookmark)
  18137. (error "Cannot find location"))))
  18138. (defun org-quote-csv-field (s)
  18139. "Quote field for inclusion in CSV material."
  18140. (if (string-match "[\",]" s)
  18141. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
  18142. s))
  18143. (defun org-force-self-insert (N)
  18144. "Needed to enforce self-insert under remapping."
  18145. (interactive "p")
  18146. (self-insert-command N))
  18147. (defun org-string-width (s)
  18148. "Compute width of string, ignoring invisible characters.
  18149. This ignores character with invisibility property `org-link', and also
  18150. characters with property `org-cwidth', because these will become invisible
  18151. upon the next fontification round."
  18152. (let (b l)
  18153. (when (or (eq t buffer-invisibility-spec)
  18154. (assq 'org-link buffer-invisibility-spec))
  18155. (while (setq b (text-property-any 0 (length s)
  18156. 'invisible 'org-link s))
  18157. (setq s (concat (substring s 0 b)
  18158. (substring s (or (next-single-property-change
  18159. b 'invisible s) (length s)))))))
  18160. (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
  18161. (setq s (concat (substring s 0 b)
  18162. (substring s (or (next-single-property-change
  18163. b 'org-cwidth s) (length s))))))
  18164. (setq l (string-width s) b -1)
  18165. (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
  18166. (setq l (- l (get-text-property b 'org-dwidth-n s))))
  18167. l))
  18168. (defun org-shorten-string (s maxlength)
  18169. "Shorten string S so tht it is no longer than MAXLENGTH characters.
  18170. If the string is shorter or has length MAXLENGTH, just return the
  18171. original string. If it is longer, the functions finds a space in the
  18172. string, breaks this string off at that locations and adds three dots
  18173. as ellipsis. Including the ellipsis, the string will not be longer
  18174. than MAXLENGTH. If finding a good breaking point in the string does
  18175. not work, the string is just chopped off in the middle of a word
  18176. if necessary."
  18177. (if (<= (length s) maxlength)
  18178. s
  18179. (let* ((n (max (- maxlength 4) 1))
  18180. (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
  18181. (if (string-match re s)
  18182. (concat (match-string 1 s) "...")
  18183. (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
  18184. (defun org-get-indentation (&optional line)
  18185. "Get the indentation of the current line, interpreting tabs.
  18186. When LINE is given, assume it represents a line and compute its indentation."
  18187. (if line
  18188. (if (string-match "^ *" (org-remove-tabs line))
  18189. (match-end 0))
  18190. (save-excursion
  18191. (beginning-of-line 1)
  18192. (skip-chars-forward " \t")
  18193. (current-column))))
  18194. (defun org-get-string-indentation (s)
  18195. "What indentation has S due to SPACE and TAB at the beginning of the string?"
  18196. (let ((n -1) (i 0) (w tab-width) c)
  18197. (catch 'exit
  18198. (while (< (setq n (1+ n)) (length s))
  18199. (setq c (aref s n))
  18200. (cond ((= c ?\ ) (setq i (1+ i)))
  18201. ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
  18202. (t (throw 'exit t)))))
  18203. i))
  18204. (defun org-remove-tabs (s &optional width)
  18205. "Replace tabulators in S with spaces.
  18206. Assumes that s is a single line, starting in column 0."
  18207. (setq width (or width tab-width))
  18208. (while (string-match "\t" s)
  18209. (setq s (replace-match
  18210. (make-string
  18211. (- (* width (/ (+ (match-beginning 0) width) width))
  18212. (match-beginning 0)) ?\ )
  18213. t t s)))
  18214. s)
  18215. (defun org-fix-indentation (line ind)
  18216. "Fix indentation in LINE.
  18217. IND is a cons cell with target and minimum indentation.
  18218. If the current indentation in LINE is smaller than the minimum,
  18219. leave it alone. If it is larger than ind, set it to the target."
  18220. (let* ((l (org-remove-tabs line))
  18221. (i (org-get-indentation l))
  18222. (i1 (car ind)) (i2 (cdr ind)))
  18223. (if (>= i i2) (setq l (substring line i2)))
  18224. (if (> i1 0)
  18225. (concat (make-string i1 ?\ ) l)
  18226. l)))
  18227. (defun org-remove-indentation (code &optional n)
  18228. "Remove the maximum common indentation from the lines in CODE.
  18229. N may optionally be the number of spaces to remove."
  18230. (with-temp-buffer
  18231. (insert code)
  18232. (org-do-remove-indentation n)
  18233. (buffer-string)))
  18234. (defun org-do-remove-indentation (&optional n)
  18235. "Remove the maximum common indentation from the buffer."
  18236. (untabify (point-min) (point-max))
  18237. (let ((min 10000) re)
  18238. (if n
  18239. (setq min n)
  18240. (goto-char (point-min))
  18241. (while (re-search-forward "^ *[^ \n]" nil t)
  18242. (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
  18243. (unless (or (= min 0) (= min 10000))
  18244. (setq re (format "^ \\{%d\\}" min))
  18245. (goto-char (point-min))
  18246. (while (re-search-forward re nil t)
  18247. (replace-match "")
  18248. (end-of-line 1))
  18249. min)))
  18250. (defun org-fill-template (template alist)
  18251. "Find each %key of ALIST in TEMPLATE and replace it."
  18252. (let ((case-fold-search nil)
  18253. entry key value)
  18254. (setq alist (sort (copy-sequence alist)
  18255. (lambda (a b) (< (length (car a)) (length (car b))))))
  18256. (while (setq entry (pop alist))
  18257. (setq template
  18258. (replace-regexp-in-string
  18259. (concat "%" (regexp-quote (car entry)))
  18260. (cdr entry) template t t)))
  18261. template))
  18262. (defun org-base-buffer (buffer)
  18263. "Return the base buffer of BUFFER, if it has one. Else return the buffer."
  18264. (if (not buffer)
  18265. buffer
  18266. (or (buffer-base-buffer buffer)
  18267. buffer)))
  18268. (defun org-trim (s)
  18269. "Remove whitespace at beginning and end of string."
  18270. (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
  18271. (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
  18272. s)
  18273. (defun org-wrap (string &optional width lines)
  18274. "Wrap string to either a number of lines, or a width in characters.
  18275. If WIDTH is non-nil, the string is wrapped to that width, however many lines
  18276. that costs. If there is a word longer than WIDTH, the text is actually
  18277. wrapped to the length of that word.
  18278. IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
  18279. many lines, whatever width that takes.
  18280. The return value is a list of lines, without newlines at the end."
  18281. (let* ((words (org-split-string string "[ \t\n]+"))
  18282. (maxword (apply 'max (mapcar 'org-string-width words)))
  18283. w ll)
  18284. (cond (width
  18285. (org-do-wrap words (max maxword width)))
  18286. (lines
  18287. (setq w maxword)
  18288. (setq ll (org-do-wrap words maxword))
  18289. (if (<= (length ll) lines)
  18290. ll
  18291. (setq ll words)
  18292. (while (> (length ll) lines)
  18293. (setq w (1+ w))
  18294. (setq ll (org-do-wrap words w)))
  18295. ll))
  18296. (t (error "Cannot wrap this")))))
  18297. (defun org-do-wrap (words width)
  18298. "Create lines of maximum width WIDTH (in characters) from word list WORDS."
  18299. (let (lines line)
  18300. (while words
  18301. (setq line (pop words))
  18302. (while (and words (< (+ (length line) (length (car words))) width))
  18303. (setq line (concat line " " (pop words))))
  18304. (setq lines (push line lines)))
  18305. (nreverse lines)))
  18306. (defun org-split-string (string &optional separators)
  18307. "Splits STRING into substrings at SEPARATORS.
  18308. No empty strings are returned if there are matches at the beginning
  18309. and end of string."
  18310. (let ((rexp (or separators "[ \f\t\n\r\v]+"))
  18311. (start 0)
  18312. notfirst
  18313. (list nil))
  18314. (while (and (string-match rexp string
  18315. (if (and notfirst
  18316. (= start (match-beginning 0))
  18317. (< start (length string)))
  18318. (1+ start) start))
  18319. (< (match-beginning 0) (length string)))
  18320. (setq notfirst t)
  18321. (or (eq (match-beginning 0) 0)
  18322. (and (eq (match-beginning 0) (match-end 0))
  18323. (eq (match-beginning 0) start))
  18324. (setq list
  18325. (cons (substring string start (match-beginning 0))
  18326. list)))
  18327. (setq start (match-end 0)))
  18328. (or (eq start (length string))
  18329. (setq list
  18330. (cons (substring string start)
  18331. list)))
  18332. (nreverse list)))
  18333. (defun org-quote-vert (s)
  18334. "Replace \"|\" with \"\\vert\"."
  18335. (while (string-match "|" s)
  18336. (setq s (replace-match "\\vert" t t s)))
  18337. s)
  18338. (defun org-uuidgen-p (s)
  18339. "Is S an ID created by UUIDGEN?"
  18340. (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
  18341. (defun org-in-src-block-p nil
  18342. "Whether point is in a code source block."
  18343. (let (ov)
  18344. (when (setq ov (overlays-at (point)))
  18345. (memq 'org-block-background
  18346. (overlay-properties
  18347. (car ov))))))
  18348. (defun org-context ()
  18349. "Return a list of contexts of the current cursor position.
  18350. If several contexts apply, all are returned.
  18351. Each context entry is a list with a symbol naming the context, and
  18352. two positions indicating start and end of the context. Possible
  18353. contexts are:
  18354. :headline anywhere in a headline
  18355. :headline-stars on the leading stars in a headline
  18356. :todo-keyword on a TODO keyword (including DONE) in a headline
  18357. :tags on the TAGS in a headline
  18358. :priority on the priority cookie in a headline
  18359. :item on the first line of a plain list item
  18360. :item-bullet on the bullet/number of a plain list item
  18361. :checkbox on the checkbox in a plain list item
  18362. :table in an org-mode table
  18363. :table-special on a special filed in a table
  18364. :table-table in a table.el table
  18365. :clocktable in a clocktable
  18366. :src-block in a source block
  18367. :link on a hyperlink
  18368. :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
  18369. :target on a <<target>>
  18370. :radio-target on a <<<radio-target>>>
  18371. :latex-fragment on a LaTeX fragment
  18372. :latex-preview on a LaTeX fragment with overlaid preview image
  18373. This function expects the position to be visible because it uses font-lock
  18374. faces as a help to recognize the following contexts: :table-special, :link,
  18375. and :keyword."
  18376. (let* ((f (get-text-property (point) 'face))
  18377. (faces (if (listp f) f (list f)))
  18378. (case-fold-search t)
  18379. (p (point)) clist o)
  18380. ;; First the large context
  18381. (cond
  18382. ((org-at-heading-p t)
  18383. (push (list :headline (point-at-bol) (point-at-eol)) clist)
  18384. (when (progn
  18385. (beginning-of-line 1)
  18386. (looking-at org-todo-line-tags-regexp))
  18387. (push (org-point-in-group p 1 :headline-stars) clist)
  18388. (push (org-point-in-group p 2 :todo-keyword) clist)
  18389. (push (org-point-in-group p 4 :tags) clist))
  18390. (goto-char p)
  18391. (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
  18392. (if (looking-at "\\[#[A-Z0-9]\\]")
  18393. (push (org-point-in-group p 0 :priority) clist)))
  18394. ((org-at-item-p)
  18395. (push (org-point-in-group p 2 :item-bullet) clist)
  18396. (push (list :item (point-at-bol)
  18397. (save-excursion (org-end-of-item) (point)))
  18398. clist)
  18399. (and (org-at-item-checkbox-p)
  18400. (push (org-point-in-group p 0 :checkbox) clist)))
  18401. ((org-at-table-p)
  18402. (push (list :table (org-table-begin) (org-table-end)) clist)
  18403. (if (memq 'org-formula faces)
  18404. (push (list :table-special
  18405. (previous-single-property-change p 'face)
  18406. (next-single-property-change p 'face)) clist)))
  18407. ((org-at-table-p 'any)
  18408. (push (list :table-table) clist)))
  18409. (goto-char p)
  18410. ;; New the "medium" contexts: clocktables, source blocks
  18411. (cond ((org-in-clocktable-p)
  18412. (push (list :clocktable
  18413. (and (or (looking-at "#\\+BEGIN: clocktable")
  18414. (search-backward "#+BEGIN: clocktable" nil t))
  18415. (match-beginning 0))
  18416. (and (re-search-forward "#\\+END:?" nil t)
  18417. (match-end 0))) clist))
  18418. ((org-in-src-block-p)
  18419. (push (list :src-block
  18420. (and (or (looking-at "#\\+BEGIN_SRC")
  18421. (search-backward "#+BEGIN_SRC" nil t))
  18422. (match-beginning 0))
  18423. (and (search-forward "#+END_SRC" nil t)
  18424. (match-beginning 0))) clist)))
  18425. (goto-char p)
  18426. ;; Now the small context
  18427. (cond
  18428. ((org-at-timestamp-p)
  18429. (push (org-point-in-group p 0 :timestamp) clist))
  18430. ((memq 'org-link faces)
  18431. (push (list :link
  18432. (previous-single-property-change p 'face)
  18433. (next-single-property-change p 'face)) clist))
  18434. ((memq 'org-special-keyword faces)
  18435. (push (list :keyword
  18436. (previous-single-property-change p 'face)
  18437. (next-single-property-change p 'face)) clist))
  18438. ((org-at-target-p)
  18439. (push (org-point-in-group p 0 :target) clist)
  18440. (goto-char (1- (match-beginning 0)))
  18441. (if (looking-at org-radio-target-regexp)
  18442. (push (org-point-in-group p 0 :radio-target) clist))
  18443. (goto-char p))
  18444. ((setq o (car (delq nil
  18445. (mapcar
  18446. (lambda (x)
  18447. (if (memq x org-latex-fragment-image-overlays) x))
  18448. (overlays-at (point))))))
  18449. (push (list :latex-fragment
  18450. (overlay-start o) (overlay-end o)) clist)
  18451. (push (list :latex-preview
  18452. (overlay-start o) (overlay-end o)) clist))
  18453. ((org-inside-LaTeX-fragment-p)
  18454. ;; FIXME: positions wrong.
  18455. (push (list :latex-fragment (point) (point)) clist)))
  18456. (setq clist (nreverse (delq nil clist)))
  18457. clist))
  18458. ;; FIXME: Compare with at-regexp-p Do we need both?
  18459. (defun org-in-regexp (re &optional nlines visually)
  18460. "Check if point is inside a match of regexp.
  18461. Normally only the current line is checked, but you can include NLINES extra
  18462. lines both before and after point into the search.
  18463. If VISUALLY is set, require that the cursor is not after the match but
  18464. really on, so that the block visually is on the match."
  18465. (catch 'exit
  18466. (let ((pos (point))
  18467. (eol (point-at-eol (+ 1 (or nlines 0))))
  18468. (inc (if visually 1 0)))
  18469. (save-excursion
  18470. (beginning-of-line (- 1 (or nlines 0)))
  18471. (while (re-search-forward re eol t)
  18472. (if (and (<= (match-beginning 0) pos)
  18473. (>= (+ inc (match-end 0)) pos))
  18474. (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
  18475. (defun org-at-regexp-p (regexp)
  18476. "Is point inside a match of REGEXP in the current line?"
  18477. (catch 'exit
  18478. (save-excursion
  18479. (let ((pos (point)) (end (point-at-eol)))
  18480. (beginning-of-line 1)
  18481. (while (re-search-forward regexp end t)
  18482. (if (and (<= (match-beginning 0) pos)
  18483. (>= (match-end 0) pos))
  18484. (throw 'exit t)))
  18485. nil))))
  18486. (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
  18487. "Non-nil when point is between matches of START-RE and END-RE.
  18488. Also return a non-nil value when point is on one of the matches.
  18489. Optional arguments LIM-UP and LIM-DOWN bound the search; they are
  18490. buffer positions. Default values are the positions of headlines
  18491. surrounding the point.
  18492. The functions returns a cons cell whose car (resp. cdr) is the
  18493. position before START-RE (resp. after END-RE)."
  18494. (save-match-data
  18495. (let ((pos (point))
  18496. (limit-up (or lim-up (save-excursion (outline-previous-heading))))
  18497. (limit-down (or lim-down (save-excursion (outline-next-heading))))
  18498. beg end)
  18499. (save-excursion
  18500. ;; Point is on a block when on START-RE or if START-RE can be
  18501. ;; found before it...
  18502. (and (or (org-at-regexp-p start-re)
  18503. (re-search-backward start-re limit-up t))
  18504. (setq beg (match-beginning 0))
  18505. ;; ... and END-RE after it...
  18506. (goto-char (match-end 0))
  18507. (re-search-forward end-re limit-down t)
  18508. (> (setq end (match-end 0)) pos)
  18509. ;; ... without another START-RE in-between.
  18510. (goto-char (match-beginning 0))
  18511. (not (re-search-backward start-re (1+ beg) t))
  18512. ;; Return value.
  18513. (cons beg end))))))
  18514. (defun org-in-block-p (names)
  18515. "Non-nil when point belongs to a block whose name belongs to NAMES.
  18516. NAMES is a list of strings containing names of blocks.
  18517. Return first block name matched, or nil. Beware that in case of
  18518. nested blocks, the returned name may not belong to the closest
  18519. block from point."
  18520. (save-match-data
  18521. (catch 'exit
  18522. (let ((case-fold-search t)
  18523. (lim-up (save-excursion (outline-previous-heading)))
  18524. (lim-down (save-excursion (outline-next-heading))))
  18525. (mapc (lambda (name)
  18526. (let ((n (regexp-quote name)))
  18527. (when (org-between-regexps-p
  18528. (concat "^[ \t]*#\\+begin_" n)
  18529. (concat "^[ \t]*#\\+end_" n)
  18530. lim-up lim-down)
  18531. (throw 'exit n))))
  18532. names))
  18533. nil)))
  18534. (defun org-occur-in-agenda-files (regexp &optional nlines)
  18535. "Call `multi-occur' with buffers for all agenda files."
  18536. (interactive "sOrg-files matching: \np")
  18537. (let* ((files (org-agenda-files))
  18538. (tnames (mapcar 'file-truename files))
  18539. (extra org-agenda-text-search-extra-files)
  18540. f)
  18541. (when (eq (car extra) 'agenda-archives)
  18542. (setq extra (cdr extra))
  18543. (setq files (org-add-archive-files files)))
  18544. (while (setq f (pop extra))
  18545. (unless (member (file-truename f) tnames)
  18546. (add-to-list 'files f 'append)
  18547. (add-to-list 'tnames (file-truename f) 'append)))
  18548. (multi-occur
  18549. (mapcar (lambda (x)
  18550. (with-current-buffer
  18551. (or (get-file-buffer x) (find-file-noselect x))
  18552. (widen)
  18553. (current-buffer)))
  18554. files)
  18555. regexp)))
  18556. (if (boundp 'occur-mode-find-occurrence-hook)
  18557. ;; Emacs 23
  18558. (add-hook 'occur-mode-find-occurrence-hook
  18559. (lambda ()
  18560. (when (derived-mode-p 'org-mode)
  18561. (org-reveal))))
  18562. ;; Emacs 22
  18563. (defadvice occur-mode-goto-occurrence
  18564. (after org-occur-reveal activate)
  18565. (and (derived-mode-p 'org-mode) (org-reveal)))
  18566. (defadvice occur-mode-goto-occurrence-other-window
  18567. (after org-occur-reveal activate)
  18568. (and (derived-mode-p 'org-mode) (org-reveal)))
  18569. (defadvice occur-mode-display-occurrence
  18570. (after org-occur-reveal activate)
  18571. (when (derived-mode-p 'org-mode)
  18572. (let ((pos (occur-mode-find-occurrence)))
  18573. (with-current-buffer (marker-buffer pos)
  18574. (save-excursion
  18575. (goto-char pos)
  18576. (org-reveal)))))))
  18577. (defun org-occur-link-in-agenda-files ()
  18578. "Create a link and search for it in the agendas.
  18579. The link is not stored in `org-stored-links', it is just created
  18580. for the search purpose."
  18581. (interactive)
  18582. (let ((link (condition-case nil
  18583. (org-store-link nil)
  18584. (error "Unable to create a link to here"))))
  18585. (org-occur-in-agenda-files (regexp-quote link))))
  18586. (defun org-uniquify (list)
  18587. "Remove duplicate elements from LIST."
  18588. (let (res)
  18589. (mapc (lambda (x) (add-to-list 'res x 'append)) list)
  18590. res))
  18591. (defun org-delete-all (elts list)
  18592. "Remove all elements in ELTS from LIST."
  18593. (while elts
  18594. (setq list (delete (pop elts) list)))
  18595. list)
  18596. (defun org-count (cl-item cl-seq)
  18597. "Count the number of occurrences of ITEM in SEQ.
  18598. Taken from `count' in cl-seq.el with all keyword arguments removed."
  18599. (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
  18600. (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
  18601. (while (< cl-start cl-end)
  18602. (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
  18603. (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
  18604. (setq cl-start (1+ cl-start)))
  18605. cl-count))
  18606. (defun org-remove-if (predicate seq)
  18607. "Remove everything from SEQ that fulfills PREDICATE."
  18608. (let (res e)
  18609. (while seq
  18610. (setq e (pop seq))
  18611. (if (not (funcall predicate e)) (push e res)))
  18612. (nreverse res)))
  18613. (defun org-remove-if-not (predicate seq)
  18614. "Remove everything from SEQ that does not fulfill PREDICATE."
  18615. (let (res e)
  18616. (while seq
  18617. (setq e (pop seq))
  18618. (if (funcall predicate e) (push e res)))
  18619. (nreverse res)))
  18620. (defun org-reduce (cl-func cl-seq &rest cl-keys)
  18621. "Reduce two-argument FUNCTION across SEQ.
  18622. Taken from `reduce' in cl-seq.el with all keyword arguments but
  18623. \":initial-value\" removed."
  18624. (let ((cl-accum (cond ((memq :initial-value cl-keys)
  18625. (cadr (memq :initial-value cl-keys)))
  18626. (cl-seq (pop cl-seq))
  18627. (t (funcall cl-func)))))
  18628. (while cl-seq
  18629. (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
  18630. cl-accum))
  18631. (defun org-back-over-empty-lines ()
  18632. "Move backwards over whitespace, to the beginning of the first empty line.
  18633. Returns the number of empty lines passed."
  18634. (let ((pos (point)))
  18635. (if (cdr (assoc 'heading org-blank-before-new-entry))
  18636. (skip-chars-backward " \t\n\r")
  18637. (unless (eobp)
  18638. (forward-line -1)))
  18639. (beginning-of-line 2)
  18640. (goto-char (min (point) pos))
  18641. (count-lines (point) pos)))
  18642. (defun org-skip-whitespace ()
  18643. (skip-chars-forward " \t\n\r"))
  18644. (defun org-point-in-group (point group &optional context)
  18645. "Check if POINT is in match-group GROUP.
  18646. If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
  18647. match. If the match group does not exist or point is not inside it,
  18648. return nil."
  18649. (and (match-beginning group)
  18650. (>= point (match-beginning group))
  18651. (<= point (match-end group))
  18652. (if context
  18653. (list context (match-beginning group) (match-end group))
  18654. t)))
  18655. (defun org-switch-to-buffer-other-window (&rest args)
  18656. "Switch to buffer in a second window on the current frame.
  18657. In particular, do not allow pop-up frames.
  18658. Returns the newly created buffer."
  18659. (let (pop-up-frames special-display-buffer-names special-display-regexps
  18660. special-display-function)
  18661. (apply 'switch-to-buffer-other-window args)))
  18662. (defun org-combine-plists (&rest plists)
  18663. "Create a single property list from all plists in PLISTS.
  18664. The process starts by copying the first list, and then setting properties
  18665. from the other lists. Settings in the last list are the most significant
  18666. ones and overrule settings in the other lists."
  18667. (let ((rtn (copy-sequence (pop plists)))
  18668. p v ls)
  18669. (while plists
  18670. (setq ls (pop plists))
  18671. (while ls
  18672. (setq p (pop ls) v (pop ls))
  18673. (setq rtn (plist-put rtn p v))))
  18674. rtn))
  18675. (defun org-move-line-down (arg)
  18676. "Move the current line down. With prefix argument, move it past ARG lines."
  18677. (interactive "p")
  18678. (let ((col (current-column))
  18679. beg end pos)
  18680. (beginning-of-line 1) (setq beg (point))
  18681. (beginning-of-line 2) (setq end (point))
  18682. (beginning-of-line (+ 1 arg))
  18683. (setq pos (move-marker (make-marker) (point)))
  18684. (insert (delete-and-extract-region beg end))
  18685. (goto-char pos)
  18686. (org-move-to-column col)))
  18687. (defun org-move-line-up (arg)
  18688. "Move the current line up. With prefix argument, move it past ARG lines."
  18689. (interactive "p")
  18690. (let ((col (current-column))
  18691. beg end pos)
  18692. (beginning-of-line 1) (setq beg (point))
  18693. (beginning-of-line 2) (setq end (point))
  18694. (beginning-of-line (- arg))
  18695. (setq pos (move-marker (make-marker) (point)))
  18696. (insert (delete-and-extract-region beg end))
  18697. (goto-char pos)
  18698. (org-move-to-column col)))
  18699. (defun org-replace-escapes (string table)
  18700. "Replace %-escapes in STRING with values in TABLE.
  18701. TABLE is an association list with keys like \"%a\" and string values.
  18702. The sequences in STRING may contain normal field width and padding information,
  18703. for example \"%-5s\". Replacements happen in the sequence given by TABLE,
  18704. so values can contain further %-escapes if they are define later in TABLE."
  18705. (let ((tbl (copy-alist table))
  18706. (case-fold-search nil)
  18707. (pchg 0)
  18708. e re rpl)
  18709. (while (setq e (pop tbl))
  18710. (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
  18711. (when (and (cdr e) (string-match re (cdr e)))
  18712. (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
  18713. (safe "SREF"))
  18714. (add-text-properties 0 3 (list 'sref sref) safe)
  18715. (setcdr e (replace-match safe t t (cdr e)))))
  18716. (while (string-match re string)
  18717. (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
  18718. (cdr e)))
  18719. (setq string (replace-match rpl t t string))))
  18720. (while (setq pchg (next-property-change pchg string))
  18721. (let ((sref (get-text-property pchg 'sref string)))
  18722. (when (and sref (string-match "SREF" string pchg))
  18723. (setq string (replace-match sref t t string)))))
  18724. string))
  18725. (defun org-sublist (list start end)
  18726. "Return a section of LIST, from START to END.
  18727. Counting starts at 1."
  18728. (let (rtn (c start))
  18729. (setq list (nthcdr (1- start) list))
  18730. (while (and list (<= c end))
  18731. (push (pop list) rtn)
  18732. (setq c (1+ c)))
  18733. (nreverse rtn)))
  18734. (defun org-find-base-buffer-visiting (file)
  18735. "Like `find-buffer-visiting' but always return the base buffer and
  18736. not an indirect buffer."
  18737. (let ((buf (or (get-file-buffer file)
  18738. (find-buffer-visiting file))))
  18739. (if buf
  18740. (or (buffer-base-buffer buf) buf)
  18741. nil)))
  18742. (defun org-image-file-name-regexp (&optional extensions)
  18743. "Return regexp matching the file names of images.
  18744. If EXTENSIONS is given, only match these."
  18745. (if (and (not extensions) (fboundp 'image-file-name-regexp))
  18746. (image-file-name-regexp)
  18747. (let ((image-file-name-extensions
  18748. (or extensions
  18749. '("png" "jpeg" "jpg" "gif" "tiff" "tif"
  18750. "xbm" "xpm" "pbm" "pgm" "ppm"))))
  18751. (concat "\\."
  18752. (regexp-opt (nconc (mapcar 'upcase
  18753. image-file-name-extensions)
  18754. image-file-name-extensions)
  18755. t)
  18756. "\\'"))))
  18757. (defun org-file-image-p (file &optional extensions)
  18758. "Return non-nil if FILE is an image."
  18759. (save-match-data
  18760. (string-match (org-image-file-name-regexp extensions) file)))
  18761. (defun org-get-cursor-date ()
  18762. "Return the date at cursor in as a time.
  18763. This works in the calendar and in the agenda, anywhere else it just
  18764. returns the current time."
  18765. (let (date day defd)
  18766. (cond
  18767. ((eq major-mode 'calendar-mode)
  18768. (setq date (calendar-cursor-to-date)
  18769. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  18770. ((eq major-mode 'org-agenda-mode)
  18771. (setq day (get-text-property (point) 'day))
  18772. (if day
  18773. (setq date (calendar-gregorian-from-absolute day)
  18774. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  18775. (nth 2 date))))))
  18776. (or defd (current-time))))
  18777. (defvar org-agenda-action-marker (make-marker)
  18778. "Marker pointing to the entry for the next agenda action.")
  18779. (defun org-mark-entry-for-agenda-action ()
  18780. "Mark the current entry as target of an agenda action.
  18781. Agenda actions are actions executed from the agenda with the key `k',
  18782. which make use of the date at the cursor."
  18783. (interactive)
  18784. (move-marker org-agenda-action-marker
  18785. (save-excursion (org-back-to-heading t) (point))
  18786. (current-buffer))
  18787. (message
  18788. "Entry marked for action; press `k' at desired date in agenda or calendar"))
  18789. (defun org-mark-subtree ()
  18790. "Mark the current subtree.
  18791. This puts point at the start of the current subtree, and mark at the end.
  18792. If point is in an inline task, mark that task instead."
  18793. (interactive)
  18794. (let ((inline-task-p
  18795. (and (featurep 'org-inlinetask)
  18796. (org-inlinetask-in-task-p)))
  18797. (beg))
  18798. ;; Get beginning of subtree
  18799. (cond
  18800. (inline-task-p (org-inlinetask-goto-beginning))
  18801. ((org-at-heading-p) (beginning-of-line))
  18802. (t (org-with-limited-levels (outline-previous-visible-heading 1))))
  18803. (setq beg (point))
  18804. ;; Get end of it
  18805. (if inline-task-p
  18806. (org-inlinetask-goto-end)
  18807. (org-end-of-subtree))
  18808. ;; Mark zone
  18809. (push-mark (point) nil t)
  18810. (goto-char beg)))
  18811. ;;; Paragraph filling stuff.
  18812. ;; We want this to be just right, so use the full arsenal.
  18813. (defun org-indent-line-function ()
  18814. "Indent line depending on context."
  18815. (interactive)
  18816. (let* ((pos (point))
  18817. (itemp (org-at-item-p))
  18818. (case-fold-search t)
  18819. (org-drawer-regexp (or org-drawer-regexp "\000"))
  18820. (inline-task-p (and (featurep 'org-inlinetask)
  18821. (org-inlinetask-in-task-p)))
  18822. (inline-re (and inline-task-p
  18823. (org-inlinetask-outline-regexp)))
  18824. column)
  18825. (beginning-of-line 1)
  18826. (cond
  18827. ;; Comments
  18828. ((looking-at "# ") (setq column 0))
  18829. ;; Headings
  18830. ((looking-at org-outline-regexp) (setq column 0))
  18831. ;; Included files
  18832. ((looking-at "#\\+include:") (setq column 0))
  18833. ;; Footnote definition
  18834. ((looking-at org-footnote-definition-re) (setq column 0))
  18835. ;; Literal examples
  18836. ((looking-at "[ \t]*:\\( \\|$\\)")
  18837. (setq column (org-get-indentation))) ; do nothing
  18838. ;; Lists
  18839. ((ignore-errors (goto-char (org-in-item-p)))
  18840. (setq column (if itemp
  18841. (org-get-indentation)
  18842. (org-list-item-body-column (point))))
  18843. (goto-char pos))
  18844. ;; Drawers
  18845. ((and (looking-at "[ \t]*:END:")
  18846. (save-excursion (re-search-backward org-drawer-regexp nil t)))
  18847. (save-excursion
  18848. (goto-char (1- (match-beginning 1)))
  18849. (setq column (current-column))))
  18850. ;; Special blocks
  18851. ((and (looking-at "[ \t]*#\\+end_\\([a-z]+\\)")
  18852. (save-excursion
  18853. (re-search-backward
  18854. (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
  18855. (setq column (org-get-indentation (match-string 0))))
  18856. ((and (not (looking-at "[ \t]*#\\+begin_"))
  18857. (org-between-regexps-p "^[ \t]*#\\+begin_" "[ \t]*#\\+end_"))
  18858. (save-excursion
  18859. (re-search-backward "^[ \t]*#\\+begin_\\([a-z]+\\)" nil t))
  18860. (setq column
  18861. (cond ((equal (downcase (match-string 1)) "src")
  18862. ;; src blocks: let `org-edit-src-exit' handle them
  18863. (org-get-indentation))
  18864. ((equal (downcase (match-string 1)) "example")
  18865. (max (org-get-indentation)
  18866. (org-get-indentation (match-string 0))))
  18867. (t
  18868. (org-get-indentation (match-string 0))))))
  18869. ;; This line has nothing special, look at the previous relevant
  18870. ;; line to compute indentation
  18871. (t
  18872. (beginning-of-line 0)
  18873. (while (and (not (bobp))
  18874. (not (looking-at org-drawer-regexp))
  18875. ;; When point started in an inline task, do not move
  18876. ;; above task starting line.
  18877. (not (and inline-task-p (looking-at inline-re)))
  18878. ;; Skip drawers, blocks, empty lines, verbatim,
  18879. ;; comments, tables, footnotes definitions, lists,
  18880. ;; inline tasks.
  18881. (or (and (looking-at "[ \t]*:END:")
  18882. (re-search-backward org-drawer-regexp nil t))
  18883. (and (looking-at "[ \t]*#\\+end_")
  18884. (re-search-backward "[ \t]*#\\+begin_"nil t))
  18885. (looking-at "[ \t]*[\n:#|]")
  18886. (looking-at org-footnote-definition-re)
  18887. (and (ignore-errors (goto-char (org-in-item-p)))
  18888. (goto-char
  18889. (org-list-get-top-point (org-list-struct))))
  18890. (and (not inline-task-p)
  18891. (featurep 'org-inlinetask)
  18892. (org-inlinetask-in-task-p)
  18893. (or (org-inlinetask-goto-beginning) t))))
  18894. (beginning-of-line 0))
  18895. (cond
  18896. ;; There was an heading above.
  18897. ((looking-at "\\*+[ \t]+")
  18898. (if (not org-adapt-indentation)
  18899. (setq column 0)
  18900. (goto-char (match-end 0))
  18901. (setq column (current-column))))
  18902. ;; A drawer had started and is unfinished
  18903. ((looking-at org-drawer-regexp)
  18904. (goto-char (1- (match-beginning 1)))
  18905. (setq column (current-column)))
  18906. ;; Else, nothing noticeable found: get indentation and go on.
  18907. (t (setq column (org-get-indentation))))))
  18908. ;; Now apply indentation and move cursor accordingly
  18909. (goto-char pos)
  18910. (if (<= (current-column) (current-indentation))
  18911. (org-indent-line-to column)
  18912. (save-excursion (org-indent-line-to column)))
  18913. ;; Special polishing for properties, see `org-property-format'
  18914. (setq column (current-column))
  18915. (beginning-of-line 1)
  18916. (if (looking-at
  18917. "\\([ \t]+\\)\\(:[-_0-9a-zA-Z]+:\\)[ \t]*\\(\\S-.*\\(\\S-\\|$\\)\\)")
  18918. (replace-match (concat (match-string 1)
  18919. (format org-property-format
  18920. (match-string 2) (match-string 3)))
  18921. t t))
  18922. (org-move-to-column column)
  18923. (when (and orgstruct-is-++ (eq pos (point)))
  18924. (org-let org-fb-vars
  18925. '(indent-according-to-mode)))))
  18926. (defun org-indent-drawer ()
  18927. "Indent the drawer at point."
  18928. (interactive)
  18929. (let ((p (point))
  18930. (e (and (save-excursion (re-search-forward ":END:" nil t))
  18931. (match-end 0)))
  18932. (folded
  18933. (save-excursion
  18934. (end-of-line)
  18935. (when (overlays-at (point))
  18936. (member 'invisible (overlay-properties
  18937. (car (overlays-at (point)))))))))
  18938. (when folded (org-cycle))
  18939. (indent-for-tab-command)
  18940. (while (and (move-beginning-of-line 2) (< (point) e))
  18941. (indent-for-tab-command))
  18942. (goto-char p)
  18943. (when folded (org-cycle)))
  18944. (message "Drawer at point indented"))
  18945. (defun org-indent-block ()
  18946. "Indent the block at point."
  18947. (interactive)
  18948. (let ((p (point))
  18949. (case-fold-search t)
  18950. (e (and (save-excursion (re-search-forward "#\\+end_?\\(?:[a-z]+\\)?" nil t))
  18951. (match-end 0)))
  18952. (folded
  18953. (save-excursion
  18954. (end-of-line)
  18955. (when (overlays-at (point))
  18956. (member 'invisible (overlay-properties
  18957. (car (overlays-at (point)))))))))
  18958. (when folded (org-cycle))
  18959. (indent-for-tab-command)
  18960. (while (and (move-beginning-of-line 2) (< (point) e))
  18961. (indent-for-tab-command))
  18962. (goto-char p)
  18963. (when folded (org-cycle)))
  18964. (message "Block at point indented"))
  18965. ;; For reference, this is the default value of adaptive-fill-regexp
  18966. ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
  18967. (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
  18968. "Variable to store copy of `adaptive-fill-regexp'.
  18969. Since `adaptive-fill-regexp' is set to never match, we need to
  18970. store a backup of its value before entering `org-mode' so that
  18971. the functionality can be provided as a fall-back.")
  18972. (defun org-set-autofill-regexps ()
  18973. (interactive)
  18974. ;; In the paragraph separator we include headlines, because filling
  18975. ;; text in a line directly attached to a headline would otherwise
  18976. ;; fill the headline as well.
  18977. (org-set-local 'comment-start-skip "^#+[ \t]*")
  18978. (org-set-local 'paragraph-separate "\f\\|\\*+ \\|[ ]*$\\|[ \t]*[:|#]")
  18979. ;; The paragraph starter includes hand-formatted lists.
  18980. (org-set-local
  18981. 'paragraph-start
  18982. (concat
  18983. "\f" "\\|"
  18984. "[ ]*$" "\\|"
  18985. org-outline-regexp "\\|"
  18986. "[ \t]*#" "\\|"
  18987. (org-item-re) "\\|"
  18988. "[ \t]*[:|]" "\\|"
  18989. "\\$\\$" "\\|"
  18990. "\\\\\\(begin\\|end\\|[][]\\)"))
  18991. ;; Inhibit auto-fill for headers, tables and fixed-width lines.
  18992. ;; But only if the user has not turned off tables or fixed-width regions
  18993. (org-set-local
  18994. 'auto-fill-inhibit-regexp
  18995. (concat org-outline-regexp
  18996. "\\|#\\+"
  18997. "\\|[ \t]*" org-keyword-time-regexp
  18998. (if (or org-enable-table-editor org-enable-fixed-width-editor)
  18999. (concat
  19000. "\\|[ \t]*["
  19001. (if org-enable-table-editor "|" "")
  19002. (if org-enable-fixed-width-editor ":" "")
  19003. "]"))))
  19004. ;; We use our own fill-paragraph function, to make sure that tables
  19005. ;; and fixed-width regions are not wrapped. That function will pass
  19006. ;; through to `fill-paragraph' when appropriate.
  19007. (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
  19008. ;; Prevent auto-fill from inserting unwanted new items.
  19009. (if (boundp 'fill-nobreak-predicate)
  19010. (org-set-local
  19011. 'fill-nobreak-predicate
  19012. (org-uniquify
  19013. (append fill-nobreak-predicate
  19014. '(org-fill-item-nobreak-p org-fill-line-break-nobreak-p)))))
  19015. ;; Adaptive filling: To get full control, first make sure that
  19016. ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
  19017. (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
  19018. (org-set-local 'org-adaptive-fill-regexp-backup
  19019. adaptive-fill-regexp))
  19020. (org-set-local 'adaptive-fill-regexp "\000")
  19021. (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
  19022. (org-set-local 'adaptive-fill-function
  19023. 'org-adaptive-fill-function)
  19024. (org-set-local
  19025. 'align-mode-rules-list
  19026. '((org-in-buffer-settings
  19027. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  19028. (modes . '(org-mode))))))
  19029. (defun org-fill-item-nobreak-p ()
  19030. "Non-nil when a line break at point would insert a new item."
  19031. (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
  19032. (defun org-fill-line-break-nobreak-p ()
  19033. "Non-nil when a line break at point would create an Org line break."
  19034. (save-excursion
  19035. (skip-chars-backward "[ \t]")
  19036. (skip-chars-backward "\\\\")
  19037. (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
  19038. (defun org-fill-paragraph (&optional justify)
  19039. "Re-align a table, pass through to fill-paragraph if no table."
  19040. (let ((table-p (org-at-table-p))
  19041. (table.el-p (org-at-table.el-p))
  19042. (itemp (org-in-item-p)))
  19043. (cond ((and (equal (char-after (point-at-bol)) ?*)
  19044. (save-excursion (goto-char (point-at-bol))
  19045. (looking-at org-outline-regexp)))
  19046. t) ; skip headlines
  19047. (table.el-p t) ; skip table.el tables
  19048. (table-p (org-table-align) t) ; align Org tables
  19049. (itemp ; align text in items
  19050. (let* ((struct (save-excursion (goto-char itemp)
  19051. (org-list-struct)))
  19052. (parents (org-list-parents-alist struct))
  19053. (children (org-list-get-children itemp struct parents))
  19054. beg end prev next prefix)
  19055. ;; Determine in which part of item point is: before
  19056. ;; first child, after last child, between two
  19057. ;; sub-lists, or simply in item if there's no child.
  19058. (cond
  19059. ((not children)
  19060. (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
  19061. beg itemp
  19062. end (org-list-get-item-end itemp struct)))
  19063. ((< (point) (setq next (car children)))
  19064. (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
  19065. beg itemp
  19066. end next))
  19067. ((> (point) (setq prev (car (last children))))
  19068. (setq beg (org-list-get-item-end prev struct)
  19069. end (org-list-get-item-end itemp struct)
  19070. prefix (save-excursion
  19071. (goto-char beg)
  19072. (skip-chars-forward " \t")
  19073. (make-string (current-column) ?\ ))))
  19074. (t (catch 'exit
  19075. (while (setq next (pop children))
  19076. (if (> (point) next)
  19077. (setq prev next)
  19078. (setq beg (org-list-get-item-end prev struct)
  19079. end next
  19080. prefix (save-excursion
  19081. (goto-char beg)
  19082. (skip-chars-forward " \t")
  19083. (make-string (current-column) ?\ )))
  19084. (throw 'exit nil))))))
  19085. ;; Use `fill-paragraph' with buffer narrowed to item
  19086. ;; without any child, and with our computed PREFIX.
  19087. (flet ((fill-context-prefix (from to &optional flr) prefix))
  19088. (save-restriction
  19089. (narrow-to-region beg end)
  19090. (save-excursion (fill-paragraph justify)))) t))
  19091. ;; Special case where point is not in a list but is on
  19092. ;; a paragraph adjacent to a list: make sure this paragraph
  19093. ;; doesn't get merged with the end of the list by narrowing
  19094. ;; buffer first.
  19095. ((and (derived-mode-p 'org-mode)
  19096. (save-excursion (forward-paragraph -1)
  19097. (setq itemp (org-in-item-p))))
  19098. (let ((struct (save-excursion (goto-char itemp)
  19099. (org-list-struct))))
  19100. (save-restriction
  19101. (narrow-to-region (org-list-get-bottom-point struct)
  19102. (save-excursion (forward-paragraph 1)
  19103. (point)))
  19104. (fill-paragraph justify) t)))
  19105. ;; Don't fill schedule/deadline line before a paragraph
  19106. ;; This only makes sense in real org-mode buffers
  19107. ((and (eq major-mode 'org-mode)
  19108. (save-excursion (forward-paragraph -1)
  19109. (or (looking-at (concat "^[^\n]*" org-scheduled-regexp ".*$"))
  19110. (looking-at (concat "^[^\n]*" org-deadline-regexp ".*$")))))
  19111. (save-restriction
  19112. (narrow-to-region (1+ (match-end 0))
  19113. (save-excursion (forward-paragraph 1) (point)))
  19114. (fill-paragraph justify) t))
  19115. ;; Else fall back on fill-paragraph-function as possibly
  19116. ;; defined in `org-fb-vars'
  19117. (orgstruct-is-++
  19118. (org-let org-fb-vars
  19119. '(fill-paragraph justify)))
  19120. (t nil))))
  19121. (defun org-adaptive-fill-function ()
  19122. "Return a fill prefix for org-mode files."
  19123. (let (itemp)
  19124. (save-excursion
  19125. (cond
  19126. ;; Comment line
  19127. ((looking-at "#[ \t]+")
  19128. (match-string-no-properties 0))
  19129. ;; Plain list item
  19130. ((org-at-item-p)
  19131. (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
  19132. ;; Point is in a list after `backward-paragraph': original
  19133. ;; point wasn't in the list, or filling would have been taken
  19134. ;; care of by `org-auto-fill-function', but the list and the
  19135. ;; real paragraph are not separated by a blank line. Thus, move
  19136. ;; point after the list to go back to real paragraph and
  19137. ;; determine fill-prefix.
  19138. ((setq itemp (org-in-item-p))
  19139. (goto-char itemp)
  19140. (let* ((struct (org-list-struct))
  19141. (bottom (org-list-get-bottom-point struct)))
  19142. (goto-char bottom)
  19143. (make-string (org-get-indentation) ?\ )))
  19144. ;; Other text
  19145. ((looking-at org-adaptive-fill-regexp-backup)
  19146. (match-string-no-properties 0))))))
  19147. (defun org-auto-fill-function ()
  19148. "Auto-fill function."
  19149. (unless (and org-src-prevent-auto-filling (org-in-src-block-p))
  19150. (let (itemp prefix)
  19151. ;; When in a list, compute an appropriate fill-prefix and make
  19152. ;; sure it will be used by `do-auto-fill'.
  19153. (cond ((setq itemp (org-in-item-p))
  19154. (progn
  19155. (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
  19156. (flet ((fill-context-prefix (from to &optional flr) prefix))
  19157. (do-auto-fill))))
  19158. (orgstruct-is-++
  19159. (org-let org-fb-vars
  19160. '(do-auto-fill)))
  19161. (t (do-auto-fill))))))
  19162. ;;; Other stuff.
  19163. (defun org-toggle-fixed-width-section (arg)
  19164. "Toggle the fixed-width export.
  19165. If there is no active region, the QUOTE keyword at the current headline is
  19166. inserted or removed. When present, it causes the text between this headline
  19167. and the next to be exported as fixed-width text, and unmodified.
  19168. If there is an active region, this command adds or removes a colon as the
  19169. first character of this line. If the first character of a line is a colon,
  19170. this line is also exported in fixed-width font."
  19171. (interactive "P")
  19172. (let* ((cc 0)
  19173. (regionp (org-region-active-p))
  19174. (beg (if regionp (region-beginning) (point)))
  19175. (end (if regionp (region-end)))
  19176. (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
  19177. (case-fold-search nil)
  19178. (re "[ \t]*\\(:\\(?: \\|$\\)\\)")
  19179. off)
  19180. (if regionp
  19181. (save-excursion
  19182. (goto-char beg)
  19183. (setq cc (current-column))
  19184. (beginning-of-line 1)
  19185. (setq off (looking-at re))
  19186. (while (> nlines 0)
  19187. (setq nlines (1- nlines))
  19188. (beginning-of-line 1)
  19189. (cond
  19190. (arg
  19191. (org-move-to-column cc t)
  19192. (insert ": \n")
  19193. (forward-line -1))
  19194. ((and off (looking-at re))
  19195. (replace-match "" t t nil 1))
  19196. ((not off) (org-move-to-column cc t) (insert ": ")))
  19197. (forward-line 1)))
  19198. (save-excursion
  19199. (org-back-to-heading)
  19200. (cond
  19201. ((looking-at (format org-heading-keyword-regexp-format
  19202. org-quote-string))
  19203. (goto-char (match-end 1))
  19204. (looking-at (concat " +" org-quote-string))
  19205. (replace-match "" t t)
  19206. (when (eolp) (insert " ")))
  19207. ((looking-at org-outline-regexp)
  19208. (goto-char (match-end 0))
  19209. (insert org-quote-string " ")))))))
  19210. (defun org-reftex-citation ()
  19211. "Use reftex-citation to insert a citation into the buffer.
  19212. This looks for a line like
  19213. #+BIBLIOGRAPHY: foo plain option:-d
  19214. and derives from it that foo.bib is the bibliography file relevant
  19215. for this document. It then installs the necessary environment for RefTeX
  19216. to work in this buffer and calls `reftex-citation' to insert a citation
  19217. into the buffer.
  19218. Export of such citations to both LaTeX and HTML is handled by the contributed
  19219. package org-exp-bibtex by Taru Karttunen."
  19220. (interactive)
  19221. (let ((reftex-docstruct-symbol 'rds)
  19222. (reftex-cite-format "\\cite{%l}")
  19223. rds bib)
  19224. (save-excursion
  19225. (save-restriction
  19226. (widen)
  19227. (let ((case-fold-search t)
  19228. (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
  19229. (if (not (save-excursion
  19230. (or (re-search-forward re nil t)
  19231. (re-search-backward re nil t))))
  19232. (error "No bibliography defined in file")
  19233. (setq bib (concat (match-string 1) ".bib")
  19234. rds (list (list 'bib bib)))))))
  19235. (call-interactively 'reftex-citation)))
  19236. ;;;; Functions extending outline functionality
  19237. (defun org-beginning-of-line (&optional arg)
  19238. "Go to the beginning of the current line. If that is invisible, continue
  19239. to a visible line beginning. This makes the function of C-a more intuitive.
  19240. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  19241. first attempt, and only move to after the tags when the cursor is already
  19242. beyond the end of the headline."
  19243. (interactive "P")
  19244. (let ((pos (point))
  19245. (special (if (consp org-special-ctrl-a/e)
  19246. (car org-special-ctrl-a/e)
  19247. org-special-ctrl-a/e))
  19248. refpos)
  19249. (if (org-bound-and-true-p line-move-visual)
  19250. (beginning-of-visual-line 1)
  19251. (beginning-of-line 1))
  19252. (if (and arg (fboundp 'move-beginning-of-line))
  19253. (call-interactively 'move-beginning-of-line)
  19254. (if (bobp)
  19255. nil
  19256. (backward-char 1)
  19257. (if (org-truely-invisible-p)
  19258. (while (and (not (bobp)) (org-truely-invisible-p))
  19259. (backward-char 1)
  19260. (beginning-of-line 1))
  19261. (forward-char 1))))
  19262. (when special
  19263. (cond
  19264. ((and (looking-at org-complex-heading-regexp)
  19265. (= (char-after (match-end 1)) ?\ ))
  19266. (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
  19267. (point-at-eol)))
  19268. (goto-char
  19269. (if (eq special t)
  19270. (cond ((> pos refpos) refpos)
  19271. ((= pos (point)) refpos)
  19272. (t (point)))
  19273. (cond ((> pos (point)) (point))
  19274. ((not (eq last-command this-command)) (point))
  19275. (t refpos)))))
  19276. ((org-at-item-p)
  19277. ;; Being at an item and not looking at an the item means point
  19278. ;; was previously moved to beginning of a visual line, which
  19279. ;; doesn't contain the item. Therefore, do nothing special,
  19280. ;; just stay here.
  19281. (when (looking-at org-list-full-item-re)
  19282. ;; Set special position at first white space character after
  19283. ;; bullet, and check-box, if any.
  19284. (let ((after-bullet
  19285. (let ((box (match-end 3)))
  19286. (if (not box) (match-end 1)
  19287. (let ((after (char-after box)))
  19288. (if (and after (= after ? )) (1+ box) box))))))
  19289. ;; Special case: Move point to special position when
  19290. ;; currently after it or at beginning of line.
  19291. (if (eq special t)
  19292. (when (or (> pos after-bullet) (= (point) pos))
  19293. (goto-char after-bullet))
  19294. ;; Reversed case: Move point to special position when
  19295. ;; point was already at beginning of line and command is
  19296. ;; repeated.
  19297. (when (and (= (point) pos) (eq last-command this-command))
  19298. (goto-char after-bullet))))))))
  19299. (org-no-warnings
  19300. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  19301. (defun org-end-of-line (&optional arg)
  19302. "Go to the end of the line.
  19303. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  19304. first attempt, and only move to after the tags when the cursor is already
  19305. beyond the end of the headline."
  19306. (interactive "P")
  19307. (let ((special (if (consp org-special-ctrl-a/e)
  19308. (cdr org-special-ctrl-a/e)
  19309. org-special-ctrl-a/e)))
  19310. (cond
  19311. ((or (not special) arg
  19312. (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
  19313. (call-interactively
  19314. (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
  19315. ((fboundp 'move-end-of-line) 'move-end-of-line)
  19316. (t 'end-of-line))))
  19317. ((org-at-heading-p)
  19318. (let ((pos (point)))
  19319. (beginning-of-line 1)
  19320. (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
  19321. (if (eq special t)
  19322. (if (or (< pos (match-beginning 1))
  19323. (= pos (match-end 0)))
  19324. (goto-char (match-beginning 1))
  19325. (goto-char (match-end 0)))
  19326. (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
  19327. (goto-char (match-end 0))
  19328. (goto-char (match-beginning 1))))
  19329. (call-interactively (if (fboundp 'move-end-of-line)
  19330. 'move-end-of-line
  19331. 'end-of-line)))))
  19332. ((org-at-drawer-p)
  19333. (move-end-of-line 1)
  19334. (when (overlays-at (1- (point))) (backward-char 1)))
  19335. ;; At an item: Move before any hidden text.
  19336. (t (call-interactively
  19337. (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
  19338. ((fboundp 'move-end-of-line) 'move-end-of-line)
  19339. (t 'end-of-line)))))
  19340. (org-no-warnings
  19341. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  19342. (define-key org-mode-map "\C-a" 'org-beginning-of-line)
  19343. (define-key org-mode-map "\C-e" 'org-end-of-line)
  19344. (defun org-backward-sentence (&optional arg)
  19345. "Go to beginning of sentence, or beginning of table field.
  19346. This will call `backward-sentence' or `org-table-beginning-of-field',
  19347. depending on context."
  19348. (interactive "P")
  19349. (cond
  19350. ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
  19351. (t (call-interactively 'backward-sentence))))
  19352. (defun org-forward-sentence (&optional arg)
  19353. "Go to end of sentence, or end of table field.
  19354. This will call `forward-sentence' or `org-table-end-of-field',
  19355. depending on context."
  19356. (interactive "P")
  19357. (cond
  19358. ((org-at-table-p) (call-interactively 'org-table-end-of-field))
  19359. (t (call-interactively 'forward-sentence))))
  19360. (define-key org-mode-map "\M-a" 'org-backward-sentence)
  19361. (define-key org-mode-map "\M-e" 'org-forward-sentence)
  19362. (defun org-kill-line (&optional arg)
  19363. "Kill line, to tags or end of line."
  19364. (interactive "P")
  19365. (cond
  19366. ((or (not org-special-ctrl-k)
  19367. (bolp)
  19368. (not (org-at-heading-p)))
  19369. (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
  19370. org-ctrl-k-protect-subtree)
  19371. (if (or (eq org-ctrl-k-protect-subtree 'error)
  19372. (not (y-or-n-p "Kill hidden subtree along with headline? ")))
  19373. (error "C-k aborted - would kill hidden subtree")))
  19374. (call-interactively
  19375. (if (and (boundp 'visual-line-mode) visual-line-mode) 'kill-visual-line 'kill-line)))
  19376. ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
  19377. (kill-region (point) (match-beginning 1))
  19378. (org-set-tags nil t))
  19379. (t (kill-region (point) (point-at-eol)))))
  19380. (define-key org-mode-map "\C-k" 'org-kill-line)
  19381. (defun org-yank (&optional arg)
  19382. "Yank. If the kill is a subtree, treat it specially.
  19383. This command will look at the current kill and check if is a single
  19384. subtree, or a series of subtrees[1]. If it passes the test, and if the
  19385. cursor is at the beginning of a line or after the stars of a currently
  19386. empty headline, then the yank is handled specially. How exactly depends
  19387. on the value of the following variables, both set by default.
  19388. org-yank-folded-subtrees
  19389. When set, the subtree(s) will be folded after insertion, but only
  19390. if doing so would now swallow text after the yanked text.
  19391. org-yank-adjusted-subtrees
  19392. When set, the subtree will be promoted or demoted in order to
  19393. fit into the local outline tree structure, which means that the level
  19394. will be adjusted so that it becomes the smaller one of the two
  19395. *visible* surrounding headings.
  19396. Any prefix to this command will cause `yank' to be called directly with
  19397. no special treatment. In particular, a simple \\[universal-argument] prefix \
  19398. will just
  19399. plainly yank the text as it is.
  19400. \[1] The test checks if the first non-white line is a heading
  19401. and if there are no other headings with fewer stars."
  19402. (interactive "P")
  19403. (org-yank-generic 'yank arg))
  19404. (defun org-yank-generic (command arg)
  19405. "Perform some yank-like command.
  19406. This function implements the behavior described in the `org-yank'
  19407. documentation. However, it has been generalized to work for any
  19408. interactive command with similar behavior."
  19409. ;; pretend to be command COMMAND
  19410. (setq this-command command)
  19411. (if arg
  19412. (call-interactively command)
  19413. (let ((subtreep ; is kill a subtree, and the yank position appropriate?
  19414. (and (org-kill-is-subtree-p)
  19415. (or (bolp)
  19416. (and (looking-at "[ \t]*$")
  19417. (string-match
  19418. "\\`\\*+\\'"
  19419. (buffer-substring (point-at-bol) (point)))))))
  19420. swallowp)
  19421. (cond
  19422. ((and subtreep org-yank-folded-subtrees)
  19423. (let ((beg (point))
  19424. end)
  19425. (if (and subtreep org-yank-adjusted-subtrees)
  19426. (org-paste-subtree nil nil 'for-yank)
  19427. (call-interactively command))
  19428. (setq end (point))
  19429. (goto-char beg)
  19430. (when (and (bolp) subtreep
  19431. (not (setq swallowp
  19432. (org-yank-folding-would-swallow-text beg end))))
  19433. (org-with-limited-levels
  19434. (or (looking-at org-outline-regexp)
  19435. (re-search-forward org-outline-regexp-bol end t))
  19436. (while (and (< (point) end) (looking-at org-outline-regexp))
  19437. (hide-subtree)
  19438. (org-cycle-show-empty-lines 'folded)
  19439. (condition-case nil
  19440. (outline-forward-same-level 1)
  19441. (error (goto-char end))))))
  19442. (when swallowp
  19443. (message
  19444. "Inserted text not folded because that would swallow text"))
  19445. (goto-char end)
  19446. (skip-chars-forward " \t\n\r")
  19447. (beginning-of-line 1)
  19448. (push-mark beg 'nomsg)))
  19449. ((and subtreep org-yank-adjusted-subtrees)
  19450. (let ((beg (point-at-bol)))
  19451. (org-paste-subtree nil nil 'for-yank)
  19452. (push-mark beg 'nomsg)))
  19453. (t
  19454. (call-interactively command))))))
  19455. (defun org-yank-folding-would-swallow-text (beg end)
  19456. "Would hide-subtree at BEG swallow any text after END?"
  19457. (let (level)
  19458. (org-with-limited-levels
  19459. (save-excursion
  19460. (goto-char beg)
  19461. (when (or (looking-at org-outline-regexp)
  19462. (re-search-forward org-outline-regexp-bol end t))
  19463. (setq level (org-outline-level)))
  19464. (goto-char end)
  19465. (skip-chars-forward " \t\r\n\v\f")
  19466. (if (or (eobp)
  19467. (and (bolp) (looking-at org-outline-regexp)
  19468. (<= (org-outline-level) level)))
  19469. nil ; Nothing would be swallowed
  19470. t))))) ; something would swallow
  19471. (define-key org-mode-map "\C-y" 'org-yank)
  19472. (defun org-truely-invisible-p ()
  19473. "Check if point is at a character currently not visible.
  19474. This version does not only check the character property, but also
  19475. `visible-mode'."
  19476. ;; Early versions of noutline don't have `outline-invisible-p'.
  19477. (if (org-bound-and-true-p visible-mode)
  19478. nil
  19479. (outline-invisible-p)))
  19480. (defun org-invisible-p2 ()
  19481. "Check if point is at a character currently not visible."
  19482. (save-excursion
  19483. (if (and (eolp) (not (bobp))) (backward-char 1))
  19484. ;; Early versions of noutline don't have `outline-invisible-p'.
  19485. (outline-invisible-p)))
  19486. (defun org-back-to-heading (&optional invisible-ok)
  19487. "Call `outline-back-to-heading', but provide a better error message."
  19488. (condition-case nil
  19489. (outline-back-to-heading invisible-ok)
  19490. (error (error "Before first headline at position %d in buffer %s"
  19491. (point) (current-buffer)))))
  19492. (defun org-beginning-of-defun ()
  19493. "Go to the beginning of the subtree, i.e. back to the heading."
  19494. (org-back-to-heading))
  19495. (defun org-end-of-defun ()
  19496. "Go to the end of the subtree."
  19497. (org-end-of-subtree nil t))
  19498. (defun org-before-first-heading-p ()
  19499. "Before first heading?"
  19500. (save-excursion
  19501. (end-of-line)
  19502. (null (re-search-backward org-outline-regexp-bol nil t))))
  19503. (defun org-at-heading-p (&optional ignored)
  19504. (outline-on-heading-p t))
  19505. ;; Compatibility alias with Org versions < 7.8.03
  19506. (defalias 'org-on-heading-p 'org-at-heading-p)
  19507. (defun org-at-comment-p nil
  19508. "Is cursor in a line starting with a # character?"
  19509. (save-excursion
  19510. (beginning-of-line)
  19511. (looking-at "^#")))
  19512. (defun org-at-drawer-p nil
  19513. "Is cursor at a drawer keyword?"
  19514. (save-excursion
  19515. (move-beginning-of-line 1)
  19516. (looking-at org-drawer-regexp)))
  19517. (defun org-at-block-p nil
  19518. "Is cursor at a block keyword?"
  19519. (save-excursion
  19520. (move-beginning-of-line 1)
  19521. (looking-at org-block-regexp)))
  19522. (defun org-point-at-end-of-empty-headline ()
  19523. "If point is at the end of an empty headline, return t, else nil.
  19524. If the heading only contains a TODO keyword, it is still still considered
  19525. empty."
  19526. (and (looking-at "[ \t]*$")
  19527. (when org-todo-line-regexp
  19528. (save-excursion
  19529. (beginning-of-line 1)
  19530. (let ((case-fold-search nil))
  19531. (looking-at org-todo-line-regexp)
  19532. (string= (match-string 3) ""))))))
  19533. (defun org-at-heading-or-item-p ()
  19534. (or (org-at-heading-p) (org-at-item-p)))
  19535. (defun org-at-target-p ()
  19536. (or (org-in-regexp org-radio-target-regexp)
  19537. (org-in-regexp org-target-regexp)))
  19538. ;; Compatibility alias with Org versions < 7.8.03
  19539. (defalias 'org-on-target-p 'org-at-target-p)
  19540. (defun org-up-heading-all (arg)
  19541. "Move to the heading line of which the present line is a subheading.
  19542. This function considers both visible and invisible heading lines.
  19543. With argument, move up ARG levels."
  19544. (if (fboundp 'outline-up-heading-all)
  19545. (outline-up-heading-all arg) ; emacs 21 version of outline.el
  19546. (outline-up-heading arg t))) ; emacs 22 version of outline.el
  19547. (defun org-up-heading-safe ()
  19548. "Move to the heading line of which the present line is a subheading.
  19549. This version will not throw an error. It will return the level of the
  19550. headline found, or nil if no higher level is found.
  19551. Also, this function will be a lot faster than `outline-up-heading',
  19552. because it relies on stars being the outline starters. This can really
  19553. make a significant difference in outlines with very many siblings."
  19554. (let (start-level re)
  19555. (org-back-to-heading t)
  19556. (setq start-level (funcall outline-level))
  19557. (if (equal start-level 1)
  19558. nil
  19559. (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
  19560. (if (re-search-backward re nil t)
  19561. (funcall outline-level)))))
  19562. (defun org-first-sibling-p ()
  19563. "Is this heading the first child of its parents?"
  19564. (interactive)
  19565. (let ((re org-outline-regexp-bol)
  19566. level l)
  19567. (unless (org-at-heading-p t)
  19568. (error "Not at a heading"))
  19569. (setq level (funcall outline-level))
  19570. (save-excursion
  19571. (if (not (re-search-backward re nil t))
  19572. t
  19573. (setq l (funcall outline-level))
  19574. (< l level)))))
  19575. (defun org-goto-sibling (&optional previous)
  19576. "Goto the next sibling, even if it is invisible.
  19577. When PREVIOUS is set, go to the previous sibling instead. Returns t
  19578. when a sibling was found. When none is found, return nil and don't
  19579. move point."
  19580. (let ((fun (if previous 're-search-backward 're-search-forward))
  19581. (pos (point))
  19582. (re org-outline-regexp-bol)
  19583. level l)
  19584. (when (condition-case nil (org-back-to-heading t) (error nil))
  19585. (setq level (funcall outline-level))
  19586. (catch 'exit
  19587. (or previous (forward-char 1))
  19588. (while (funcall fun re nil t)
  19589. (setq l (funcall outline-level))
  19590. (when (< l level) (goto-char pos) (throw 'exit nil))
  19591. (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
  19592. (goto-char pos)
  19593. nil))))
  19594. (defun org-show-siblings ()
  19595. "Show all siblings of the current headline."
  19596. (save-excursion
  19597. (while (org-goto-sibling) (org-flag-heading nil)))
  19598. (save-excursion
  19599. (while (org-goto-sibling 'previous)
  19600. (org-flag-heading nil))))
  19601. (defun org-goto-first-child ()
  19602. "Goto the first child, even if it is invisible.
  19603. Return t when a child was found. Otherwise don't move point and
  19604. return nil."
  19605. (let (level (pos (point)) (re org-outline-regexp-bol))
  19606. (when (condition-case nil (org-back-to-heading t) (error nil))
  19607. (setq level (outline-level))
  19608. (forward-char 1)
  19609. (if (and (re-search-forward re nil t) (> (outline-level) level))
  19610. (progn (goto-char (match-beginning 0)) t)
  19611. (goto-char pos) nil))))
  19612. (defun org-show-hidden-entry ()
  19613. "Show an entry where even the heading is hidden."
  19614. (save-excursion
  19615. (org-show-entry)))
  19616. (defun org-flag-heading (flag &optional entry)
  19617. "Flag the current heading. FLAG non-nil means make invisible.
  19618. When ENTRY is non-nil, show the entire entry."
  19619. (save-excursion
  19620. (org-back-to-heading t)
  19621. ;; Check if we should show the entire entry
  19622. (if entry
  19623. (progn
  19624. (org-show-entry)
  19625. (save-excursion
  19626. (and (outline-next-heading)
  19627. (org-flag-heading nil))))
  19628. (outline-flag-region (max (point-min) (1- (point)))
  19629. (save-excursion (outline-end-of-heading) (point))
  19630. flag))))
  19631. (defun org-get-next-sibling ()
  19632. "Move to next heading of the same level, and return point.
  19633. If there is no such heading, return nil.
  19634. This is like outline-next-sibling, but invisible headings are ok."
  19635. (let ((level (funcall outline-level)))
  19636. (outline-next-heading)
  19637. (while (and (not (eobp)) (> (funcall outline-level) level))
  19638. (outline-next-heading))
  19639. (if (or (eobp) (< (funcall outline-level) level))
  19640. nil
  19641. (point))))
  19642. (defun org-get-last-sibling ()
  19643. "Move to previous heading of the same level, and return point.
  19644. If there is no such heading, return nil."
  19645. (let ((opoint (point))
  19646. (level (funcall outline-level)))
  19647. (outline-previous-heading)
  19648. (when (and (/= (point) opoint) (outline-on-heading-p t))
  19649. (while (and (> (funcall outline-level) level)
  19650. (not (bobp)))
  19651. (outline-previous-heading))
  19652. (if (< (funcall outline-level) level)
  19653. nil
  19654. (point)))))
  19655. (defun org-end-of-subtree (&optional invisible-OK to-heading)
  19656. ;; This contains an exact copy of the original function, but it uses
  19657. ;; `org-back-to-heading', to make it work also in invisible
  19658. ;; trees. And is uses an invisible-OK argument.
  19659. ;; Under Emacs this is not needed, but the old outline.el needs this fix.
  19660. ;; Furthermore, when used inside Org, finding the end of a large subtree
  19661. ;; with many children and grandchildren etc, this can be much faster
  19662. ;; than the outline version.
  19663. (org-back-to-heading invisible-OK)
  19664. (let ((first t)
  19665. (level (funcall outline-level)))
  19666. (if (and (derived-mode-p 'org-mode) (< level 1000))
  19667. ;; A true heading (not a plain list item), in Org-mode
  19668. ;; This means we can easily find the end by looking
  19669. ;; only for the right number of stars. Using a regexp to do
  19670. ;; this is so much faster than using a Lisp loop.
  19671. (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
  19672. (forward-char 1)
  19673. (and (re-search-forward re nil 'move) (beginning-of-line 1)))
  19674. ;; something else, do it the slow way
  19675. (while (and (not (eobp))
  19676. (or first (> (funcall outline-level) level)))
  19677. (setq first nil)
  19678. (outline-next-heading)))
  19679. (unless to-heading
  19680. (if (memq (preceding-char) '(?\n ?\^M))
  19681. (progn
  19682. ;; Go to end of line before heading
  19683. (forward-char -1)
  19684. (if (memq (preceding-char) '(?\n ?\^M))
  19685. ;; leave blank line before heading
  19686. (forward-char -1))))))
  19687. (point))
  19688. (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
  19689. "Use Org version in org-mode, for dramatic speed-up."
  19690. (if (derived-mode-p 'org-mode)
  19691. (progn
  19692. (org-end-of-subtree nil t)
  19693. (unless (eobp) (backward-char 1)))
  19694. ad-do-it))
  19695. (defun org-end-of-meta-data-and-drawers ()
  19696. "Jump to the first text after meta data and drawers in the current entry.
  19697. This will move over empty lines, lines with planning time stamps,
  19698. clocking lines, and drawers."
  19699. (org-back-to-heading t)
  19700. (let ((end (save-excursion (outline-next-heading) (point)))
  19701. (re (concat "\\(" org-drawer-regexp "\\)"
  19702. "\\|" "[ \t]*" org-keyword-time-regexp)))
  19703. (forward-line 1)
  19704. (while (re-search-forward re end t)
  19705. (if (not (match-end 1))
  19706. ;; empty or planning line
  19707. (forward-line 1)
  19708. ;; a drawer, find the end
  19709. (re-search-forward "^[ \t]*:END:" end 'move)
  19710. (forward-line 1)))
  19711. (and (re-search-forward "[^\n]" nil t) (backward-char 1))
  19712. (point)))
  19713. (defun org-forward-same-level (arg &optional invisible-ok)
  19714. "Move forward to the arg'th subheading at same level as this one.
  19715. Stop at the first and last subheadings of a superior heading.
  19716. Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
  19717. it wil also look at invisible ones."
  19718. (interactive "p")
  19719. (org-back-to-heading invisible-ok)
  19720. (org-at-heading-p)
  19721. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  19722. (re (format "^\\*\\{1,%d\\} " level))
  19723. l)
  19724. (forward-char 1)
  19725. (while (> arg 0)
  19726. (while (and (re-search-forward re nil 'move)
  19727. (setq l (- (match-end 0) (match-beginning 0) 1))
  19728. (= l level)
  19729. (not invisible-ok)
  19730. (progn (backward-char 1) (outline-invisible-p)))
  19731. (if (< l level) (setq arg 1)))
  19732. (setq arg (1- arg)))
  19733. (beginning-of-line 1)))
  19734. (defun org-backward-same-level (arg &optional invisible-ok)
  19735. "Move backward to the arg'th subheading at same level as this one.
  19736. Stop at the first and last subheadings of a superior heading."
  19737. (interactive "p")
  19738. (org-back-to-heading)
  19739. (org-at-heading-p)
  19740. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  19741. (re (format "^\\*\\{1,%d\\} " level))
  19742. l)
  19743. (while (> arg 0)
  19744. (while (and (re-search-backward re nil 'move)
  19745. (setq l (- (match-end 0) (match-beginning 0) 1))
  19746. (= l level)
  19747. (not invisible-ok)
  19748. (outline-invisible-p))
  19749. (if (< l level) (setq arg 1)))
  19750. (setq arg (1- arg)))))
  19751. (defun org-show-subtree ()
  19752. "Show everything after this heading at deeper levels."
  19753. (interactive)
  19754. (outline-flag-region
  19755. (point)
  19756. (save-excursion
  19757. (org-end-of-subtree t t))
  19758. nil))
  19759. (defun org-show-entry ()
  19760. "Show the body directly following this heading.
  19761. Show the heading too, if it is currently invisible."
  19762. (interactive)
  19763. (save-excursion
  19764. (condition-case nil
  19765. (progn
  19766. (org-back-to-heading t)
  19767. (outline-flag-region
  19768. (max (point-min) (1- (point)))
  19769. (save-excursion
  19770. (if (re-search-forward
  19771. (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
  19772. (match-beginning 1)
  19773. (point-max)))
  19774. nil)
  19775. (org-cycle-hide-drawers 'children))
  19776. (error nil))))
  19777. (defun org-make-options-regexp (kwds &optional extra)
  19778. "Make a regular expression for keyword lines."
  19779. (concat
  19780. "^"
  19781. "#?[ \t]*\\+\\("
  19782. (mapconcat 'regexp-quote kwds "\\|")
  19783. (if extra (concat "\\|" extra))
  19784. "\\):[ \t]*"
  19785. "\\(.*\\)"))
  19786. ;; Make isearch reveal the necessary context
  19787. (defun org-isearch-end ()
  19788. "Reveal context after isearch exits."
  19789. (when isearch-success ; only if search was successful
  19790. (if (featurep 'xemacs)
  19791. ;; Under XEmacs, the hook is run in the correct place,
  19792. ;; we directly show the context.
  19793. (org-show-context 'isearch)
  19794. ;; In Emacs the hook runs *before* restoring the overlays.
  19795. ;; So we have to use a one-time post-command-hook to do this.
  19796. ;; (Emacs 22 has a special variable, see function `org-mode')
  19797. (unless (and (boundp 'isearch-mode-end-hook-quit)
  19798. isearch-mode-end-hook-quit)
  19799. ;; Only when the isearch was not quitted.
  19800. (org-add-hook 'post-command-hook 'org-isearch-post-command
  19801. 'append 'local)))))
  19802. (defun org-isearch-post-command ()
  19803. "Remove self from hook, and show context."
  19804. (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
  19805. (org-show-context 'isearch))
  19806. ;;;; Integration with and fixes for other packages
  19807. ;;; Imenu support
  19808. (defvar org-imenu-markers nil
  19809. "All markers currently used by Imenu.")
  19810. (make-variable-buffer-local 'org-imenu-markers)
  19811. (defun org-imenu-new-marker (&optional pos)
  19812. "Return a new marker for use by Imenu, and remember the marker."
  19813. (let ((m (make-marker)))
  19814. (move-marker m (or pos (point)))
  19815. (push m org-imenu-markers)
  19816. m))
  19817. (defun org-imenu-get-tree ()
  19818. "Produce the index for Imenu."
  19819. (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
  19820. (setq org-imenu-markers nil)
  19821. (let* ((n org-imenu-depth)
  19822. (re (concat "^" (org-get-limited-outline-regexp)))
  19823. (subs (make-vector (1+ n) nil))
  19824. (last-level 0)
  19825. m level head)
  19826. (save-excursion
  19827. (save-restriction
  19828. (widen)
  19829. (goto-char (point-max))
  19830. (while (re-search-backward re nil t)
  19831. (setq level (org-reduced-level (funcall outline-level)))
  19832. (when (and (<= level n)
  19833. (looking-at org-complex-heading-regexp))
  19834. (setq head (org-link-display-format
  19835. (org-match-string-no-properties 4))
  19836. m (org-imenu-new-marker))
  19837. (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
  19838. (if (>= level last-level)
  19839. (push (cons head m) (aref subs level))
  19840. (push (cons head (aref subs (1+ level))) (aref subs level))
  19841. (loop for i from (1+ level) to n do (aset subs i nil)))
  19842. (setq last-level level)))))
  19843. (aref subs 1)))
  19844. (eval-after-load "imenu"
  19845. '(progn
  19846. (add-hook 'imenu-after-jump-hook
  19847. (lambda ()
  19848. (if (derived-mode-p 'org-mode)
  19849. (org-show-context 'org-goto))))))
  19850. (defun org-link-display-format (link)
  19851. "Replace a link with either the description, or the link target
  19852. if no description is present"
  19853. (save-match-data
  19854. (if (string-match org-bracket-link-analytic-regexp link)
  19855. (replace-match (if (match-end 5)
  19856. (match-string 5 link)
  19857. (concat (match-string 1 link)
  19858. (match-string 3 link)))
  19859. nil t link)
  19860. link)))
  19861. (defun org-toggle-link-display ()
  19862. "Toggle the literal or descriptive display of links."
  19863. (interactive)
  19864. (if org-descriptive-links
  19865. (progn (org-remove-from-invisibility-spec '(org-link))
  19866. (org-restart-font-lock)
  19867. (setq org-descriptive-links nil))
  19868. (progn (add-to-invisibility-spec '(org-link))
  19869. (org-restart-font-lock)
  19870. (setq org-descriptive-links t))))
  19871. ;; Speedbar support
  19872. (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
  19873. "Overlay marking the agenda restriction line in speedbar.")
  19874. (overlay-put org-speedbar-restriction-lock-overlay
  19875. 'face 'org-agenda-restriction-lock)
  19876. (overlay-put org-speedbar-restriction-lock-overlay
  19877. 'help-echo "Agendas are currently limited to this item.")
  19878. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  19879. (defun org-speedbar-set-agenda-restriction ()
  19880. "Restrict future agenda commands to the location at point in speedbar.
  19881. To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
  19882. (interactive)
  19883. (require 'org-agenda)
  19884. (let (p m tp np dir txt)
  19885. (cond
  19886. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  19887. 'org-imenu t))
  19888. (setq m (get-text-property p 'org-imenu-marker))
  19889. (with-current-buffer (marker-buffer m)
  19890. (goto-char m)
  19891. (org-agenda-set-restriction-lock 'subtree)))
  19892. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  19893. 'speedbar-function 'speedbar-find-file))
  19894. (setq tp (previous-single-property-change
  19895. (1+ p) 'speedbar-function)
  19896. np (next-single-property-change
  19897. tp 'speedbar-function)
  19898. dir (speedbar-line-directory)
  19899. txt (buffer-substring-no-properties (or tp (point-min))
  19900. (or np (point-max))))
  19901. (with-current-buffer (find-file-noselect
  19902. (let ((default-directory dir))
  19903. (expand-file-name txt)))
  19904. (unless (derived-mode-p 'org-mode)
  19905. (error "Cannot restrict to non-Org-mode file"))
  19906. (org-agenda-set-restriction-lock 'file)))
  19907. (t (error "Don't know how to restrict Org-mode's agenda")))
  19908. (move-overlay org-speedbar-restriction-lock-overlay
  19909. (point-at-bol) (point-at-eol))
  19910. (setq current-prefix-arg nil)
  19911. (org-agenda-maybe-redo)))
  19912. (eval-after-load "speedbar"
  19913. '(progn
  19914. (speedbar-add-supported-extension ".org")
  19915. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  19916. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  19917. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  19918. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  19919. (add-hook 'speedbar-visiting-tag-hook
  19920. (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
  19921. ;;; Fixes and Hacks for problems with other packages
  19922. ;; Make flyspell not check words in links, to not mess up our keymap
  19923. (defun org-mode-flyspell-verify ()
  19924. "Don't let flyspell put overlays at active buttons, or on
  19925. {todo,all-time,additional-option-like}-keywords."
  19926. (let ((pos (max (1- (point)) (point-min)))
  19927. (word (thing-at-point 'word)))
  19928. (and (not (get-text-property pos 'keymap))
  19929. (not (get-text-property pos 'org-no-flyspell))
  19930. (not (member word org-todo-keywords-1))
  19931. (not (member word org-all-time-keywords))
  19932. (not (member word org-additional-option-like-keywords)))))
  19933. (defun org-remove-flyspell-overlays-in (beg end)
  19934. "Remove flyspell overlays in region."
  19935. (and (org-bound-and-true-p flyspell-mode)
  19936. (fboundp 'flyspell-delete-region-overlays)
  19937. (flyspell-delete-region-overlays beg end))
  19938. (add-text-properties beg end '(org-no-flyspell t)))
  19939. ;; Make `bookmark-jump' shows the jump location if it was hidden.
  19940. (eval-after-load "bookmark"
  19941. '(if (boundp 'bookmark-after-jump-hook)
  19942. ;; We can use the hook
  19943. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  19944. ;; Hook not available, use advice
  19945. (defadvice bookmark-jump (after org-make-visible activate)
  19946. "Make the position visible."
  19947. (org-bookmark-jump-unhide))))
  19948. ;; Make sure saveplace shows the location if it was hidden
  19949. (eval-after-load "saveplace"
  19950. '(defadvice save-place-find-file-hook (after org-make-visible activate)
  19951. "Make the position visible."
  19952. (org-bookmark-jump-unhide)))
  19953. ;; Make sure ecb shows the location if it was hidden
  19954. (eval-after-load "ecb"
  19955. '(defadvice ecb-method-clicked (after esf/org-show-context activate)
  19956. "Make hierarchy visible when jumping into location from ECB tree buffer."
  19957. (if (derived-mode-p 'org-mode)
  19958. (org-show-context))))
  19959. (defun org-bookmark-jump-unhide ()
  19960. "Unhide the current position, to show the bookmark location."
  19961. (and (derived-mode-p 'org-mode)
  19962. (or (outline-invisible-p)
  19963. (save-excursion (goto-char (max (point-min) (1- (point))))
  19964. (outline-invisible-p)))
  19965. (org-show-context 'bookmark-jump)))
  19966. ;; Make session.el ignore our circular variable
  19967. (eval-after-load "session"
  19968. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  19969. ;;;; Experimental code
  19970. (defun org-closed-in-range ()
  19971. "Sparse tree of items closed in a certain time range.
  19972. Still experimental, may disappear in the future."
  19973. (interactive)
  19974. ;; Get the time interval from the user.
  19975. (let* ((time1 (org-float-time
  19976. (org-read-date nil 'to-time nil "Starting date: ")))
  19977. (time2 (org-float-time
  19978. (org-read-date nil 'to-time nil "End date:")))
  19979. ;; callback function
  19980. (callback (lambda ()
  19981. (let ((time
  19982. (org-float-time
  19983. (apply 'encode-time
  19984. (org-parse-time-string
  19985. (match-string 1))))))
  19986. ;; check if time in interval
  19987. (and (>= time time1) (<= time time2))))))
  19988. ;; make tree, check each match with the callback
  19989. (org-occur "CLOSED: +\\[\\(.*?\\)\\]" nil callback)))
  19990. ;;;; Finish up
  19991. (provide 'org)
  19992. (run-hooks 'org-load-hook)
  19993. ;;; org.el ends here