org.el 703 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825
  1. ;;; org.el --- Outline-based notes management and organizer
  2. ;; Carstens outline-mode for keeping track of everything.
  3. ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
  4. ;; Free Software Foundation, Inc.
  5. ;;
  6. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  7. ;; Keywords: outlines, hypermedia, calendar, wp
  8. ;; Homepage: http://orgmode.org
  9. ;; Version: 6.36trans
  10. ;;
  11. ;; This file is part of GNU Emacs.
  12. ;;
  13. ;; GNU Emacs is free software: you can redistribute it and/or modify
  14. ;; it under the terms of the GNU General Public License as published by
  15. ;; the Free Software Foundation, either version 3 of the License, or
  16. ;; (at your option) any later version.
  17. ;; GNU Emacs is distributed in the hope that it will be useful,
  18. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20. ;; GNU General Public License for more details.
  21. ;; You should have received a copy of the GNU General Public License
  22. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  23. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  24. ;;
  25. ;;; Commentary:
  26. ;;
  27. ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
  28. ;; project planning with a fast and effective plain-text system.
  29. ;;
  30. ;; Org-mode develops organizational tasks around NOTES files that contain
  31. ;; information about projects as plain text. Org-mode is implemented on
  32. ;; top of outline-mode, which makes it possible to keep the content of
  33. ;; large files well structured. Visibility cycling and structure editing
  34. ;; help to work with the tree. Tables are easily created with a built-in
  35. ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
  36. ;; and scheduling. It dynamically compiles entries into an agenda that
  37. ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
  38. ;; Plain text URL-like links connect to websites, emails, Usenet
  39. ;; messages, BBDB entries, and any files related to the projects. For
  40. ;; printing and sharing of notes, an Org-mode file can be exported as a
  41. ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
  42. ;; iCalendar file. It can also serve as a publishing tool for a set of
  43. ;; linked webpages.
  44. ;;
  45. ;; Installation and Activation
  46. ;; ---------------------------
  47. ;; See the corresponding sections in the manual at
  48. ;;
  49. ;; http://orgmode.org/org.html#Installation
  50. ;;
  51. ;; Documentation
  52. ;; -------------
  53. ;; The documentation of Org-mode can be found in the TeXInfo file. The
  54. ;; distribution also contains a PDF version of it. At the homepage of
  55. ;; Org-mode, you can read the same text online as HTML. There is also an
  56. ;; excellent reference card made by Philip Rooke. This card can be found
  57. ;; in the etc/ directory of Emacs 22.
  58. ;;
  59. ;; A list of recent changes can be found at
  60. ;; http://orgmode.org/Changes.html
  61. ;;
  62. ;;; Code:
  63. (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
  64. (defvar org-table-formula-constants-local nil
  65. "Local version of `org-table-formula-constants'.")
  66. (make-variable-buffer-local 'org-table-formula-constants-local)
  67. ;;;; Require other packages
  68. (eval-when-compile
  69. (require 'cl)
  70. (require 'gnus-sum))
  71. (require 'calendar)
  72. ;; Emacs 22 calendar compatibility: Make sure the new variables are available
  73. (unless (boundp 'calendar-view-holidays-initially-flag)
  74. (defvaralias 'calendar-view-holidays-initially-flag
  75. 'view-calendar-holidays-initially))
  76. (unless (boundp 'calendar-view-diary-initially-flag)
  77. (defvaralias 'calendar-view-diary-initially-flag
  78. 'view-diary-entries-initially))
  79. (unless (boundp 'diary-fancy-buffer)
  80. (defvaralias 'diary-fancy-buffer 'fancy-diary-buffer))
  81. ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
  82. ;; the file noutline.el being loaded.
  83. (if (featurep 'xemacs) (condition-case nil (require 'noutline)))
  84. ;; We require noutline, which might be provided in outline.el
  85. (require 'outline) (require 'noutline)
  86. ;; Other stuff we need.
  87. (require 'time-date)
  88. (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
  89. (require 'easymenu)
  90. (require 'overlay)
  91. (require 'org-macs)
  92. (require 'org-entities)
  93. (require 'org-compat)
  94. (require 'org-faces)
  95. (require 'org-list)
  96. (require 'org-src)
  97. (require 'org-footnote)
  98. ;;;; Customization variables
  99. ;;; Version
  100. (defconst org-version "6.36trans"
  101. "The version number of the file org.el.")
  102. (defun org-version (&optional here)
  103. "Show the org-mode version in the echo area.
  104. With prefix arg HERE, insert it at point."
  105. (interactive "P")
  106. (let* ((origin default-directory)
  107. (version org-version)
  108. (git-version)
  109. (dir (concat (file-name-directory (locate-library "org")) "../" )))
  110. (when (and (file-exists-p (expand-file-name ".git" dir))
  111. (executable-find "git"))
  112. (unwind-protect
  113. (progn
  114. (cd dir)
  115. (when (eql 0 (shell-command "git describe --abbrev=4 HEAD"))
  116. (with-current-buffer "*Shell Command Output*"
  117. (goto-char (point-min))
  118. (setq git-version (buffer-substring (point) (point-at-eol))))
  119. (subst-char-in-string ?- ?. git-version t)
  120. (when (string-match "\\S-"
  121. (shell-command-to-string
  122. "git diff-index --name-only HEAD --"))
  123. (setq git-version (concat git-version ".dirty")))
  124. (setq version (concat version " (" git-version ")"))))
  125. (cd origin)))
  126. (setq version (format "Org-mode version %s" version))
  127. (if here (insert version))
  128. (message version)))
  129. ;;; Compatibility constants
  130. ;;; The custom variables
  131. (defgroup org nil
  132. "Outline-based notes management and organizer."
  133. :tag "Org"
  134. :group 'outlines
  135. :group 'calendar)
  136. (defcustom org-mode-hook nil
  137. "Mode hook for Org-mode, run after the mode was turned on."
  138. :group 'org
  139. :type 'hook)
  140. (defcustom org-load-hook nil
  141. "Hook that is run after org.el has been loaded."
  142. :group 'org
  143. :type 'hook)
  144. (defvar org-modules) ; defined below
  145. (defvar org-modules-loaded nil
  146. "Have the modules been loaded already?")
  147. (defun org-load-modules-maybe (&optional force)
  148. "Load all extensions listed in `org-modules'."
  149. (when (or force (not org-modules-loaded))
  150. (mapc (lambda (ext)
  151. (condition-case nil (require ext)
  152. (error (message "Problems while trying to load feature `%s'" ext))))
  153. org-modules)
  154. (setq org-modules-loaded t)))
  155. (defun org-set-modules (var value)
  156. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  157. (set var value)
  158. (when (featurep 'org)
  159. (org-load-modules-maybe 'force)))
  160. (when (org-bound-and-true-p org-modules)
  161. (let ((a (member 'org-infojs org-modules)))
  162. (and a (setcar a 'org-jsinfo))))
  163. (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)
  164. "Modules that should always be loaded together with org.el.
  165. If a description starts with <C>, the file is not part of Emacs
  166. and loading it will require that you have downloaded and properly installed
  167. the org-mode distribution.
  168. You can also use this system to load external packages (i.e. neither Org
  169. core modules, nor modules from the CONTRIB directory). Just add symbols
  170. to the end of the list. If the package is called org-xyz.el, then you need
  171. to add the symbol `xyz', and the package must have a call to
  172. (provide 'org-xyz)"
  173. :group 'org
  174. :set 'org-set-modules
  175. :type
  176. '(set :greedy t
  177. (const :tag " bbdb: Links to BBDB entries" org-bbdb)
  178. (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
  179. (const :tag " crypt: Encryption of subtrees" org-crypt)
  180. (const :tag " ctags: Access to Emacs tags with links" org-ctags)
  181. (const :tag " docview: Links to doc-view buffers" org-docview)
  182. (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
  183. (const :tag " id: Global IDs for identifying entries" org-id)
  184. (const :tag " info: Links to Info nodes" org-info)
  185. (const :tag " jsinfo: Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo)
  186. (const :tag " habit: Track your consistency with habits" org-habit)
  187. (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
  188. (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
  189. (const :tag " mac-message: Links to messages in Apple Mail" org-mac-message)
  190. (const :tag " mew Links to Mew folders/messages" org-mew)
  191. (const :tag " mhe: Links to MHE folders/messages" org-mhe)
  192. (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
  193. (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
  194. (const :tag " vm: Links to VM folders/messages" org-vm)
  195. (const :tag " wl: Links to Wanderlust folders/messages" org-wl)
  196. (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
  197. (const :tag " mouse: Additional mouse support" org-mouse)
  198. (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
  199. (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
  200. (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
  201. (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
  202. (const :tag "C collector: Collect properties into tables" org-collector)
  203. (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
  204. (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
  205. (const :tag "C eval: Include command output as text" org-eval)
  206. (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
  207. (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
  208. (const :tag "C exp-bibtex: Export citations using BibTeX" org-exp-bibtex)
  209. (const :tag "C git-link: Provide org links to specific file version" org-git-link)
  210. (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
  211. (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
  212. (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
  213. (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
  214. (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
  215. (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
  216. (const :tag "C man: Support for links to manpages in Org-mode" org-man)
  217. (const :tag "C mtags: Support for muse-like tags" org-mtags)
  218. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  219. (const :tag "C registry: A registry for Org-mode links" org-registry)
  220. (const :tag "C org2rem: Convert org appointments into reminders" org2rem)
  221. (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
  222. (const :tag "C secretary: Team management with org-mode" org-secretary)
  223. (const :tag "C special-blocks: Turn blocks into LaTeX envs and HTML divs" org-special-blocks)
  224. (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
  225. (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
  226. (const :tag "C track: Keep up with Org-mode development" org-track)
  227. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  228. (defcustom org-support-shift-select nil
  229. "Non-nil means make shift-cursor commands select text when possible.
  230. In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
  231. selecting a region, or enlarge thusly regions started in this way.
  232. In Org-mode, in special contexts, these same keys are used for other
  233. purposes, important enough to compete with shift selection. Org tries
  234. to balance these needs by supporting `shift-select-mode' outside these
  235. special contexts, under control of this variable.
  236. The default of this variable is nil, to avoid confusing behavior. Shifted
  237. cursor keys will then execute Org commands in the following contexts:
  238. - on a headline, changing TODO state (left/right) and priority (up/down)
  239. - on a time stamp, changing the time
  240. - in a plain list item, changing the bullet type
  241. - in a property definition line, switching between allowed values
  242. - in the BEGIN line of a clock table (changing the time block).
  243. Outside these contexts, the commands will throw an error.
  244. When this variable is t and the cursor is not in a special context,
  245. Org-mode will support shift-selection for making and enlarging regions.
  246. To make this more effective, the bullet cycling will no longer happen
  247. anywhere in an item line, but only if the cursor is exactly on the bullet.
  248. If you set this variable to the symbol `always', then the keys
  249. will not be special in headlines, property lines, and item lines, to make
  250. shift selection work there as well. If this is what you want, you can
  251. use the following alternative commands: `C-c C-t' and `C-c ,' to
  252. change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
  253. TODO sets, `C-c -' to cycle item bullet types, and properties can be
  254. edited by hand or in column view.
  255. However, when the cursor is on a timestamp, shift-cursor commands
  256. will still edit the time stamp - this is just too good to give up.
  257. XEmacs user should have this variable set to nil, because shift-select-mode
  258. is Emacs 23 only."
  259. :group 'org
  260. :type '(choice
  261. (const :tag "Never" nil)
  262. (const :tag "When outside special context" t)
  263. (const :tag "Everywhere except timestamps" always)))
  264. (defgroup org-startup nil
  265. "Options concerning startup of Org-mode."
  266. :tag "Org Startup"
  267. :group 'org)
  268. (defcustom org-startup-folded t
  269. "Non-nil means entering Org-mode will switch to OVERVIEW.
  270. This can also be configured on a per-file basis by adding one of
  271. the following lines anywhere in the buffer:
  272. #+STARTUP: fold (or `overview', this is equivalent)
  273. #+STARTUP: nofold (or `showall', this is equivalent)
  274. #+STARTUP: content
  275. #+STARTUP: showeverything"
  276. :group 'org-startup
  277. :type '(choice
  278. (const :tag "nofold: show all" nil)
  279. (const :tag "fold: overview" t)
  280. (const :tag "content: all headlines" content)
  281. (const :tag "show everything, even drawers" showeverything)))
  282. (defcustom org-startup-truncated t
  283. "Non-nil means entering Org-mode will set `truncate-lines'.
  284. This is useful since some lines containing links can be very long and
  285. uninteresting. Also tables look terrible when wrapped."
  286. :group 'org-startup
  287. :type 'boolean)
  288. (defcustom org-startup-indented nil
  289. "Non-nil means turn on `org-indent-mode' on startup.
  290. This can also be configured on a per-file basis by adding one of
  291. the following lines anywhere in the buffer:
  292. #+STARTUP: indent
  293. #+STARTUP: noindent"
  294. :group 'org-structure
  295. :type '(choice
  296. (const :tag "Not" nil)
  297. (const :tag "Globally (slow on startup in large files)" t)))
  298. (defcustom org-startup-with-beamer-mode nil
  299. "Non-nil means turn on `org-beamer-mode' on startup.
  300. This can also be configured on a per-file basis by adding one of
  301. the following lines anywhere in the buffer:
  302. #+STARTUP: beamer"
  303. :group 'org-startup
  304. :type 'boolean)
  305. (defcustom org-startup-align-all-tables nil
  306. "Non-nil means align all tables when visiting a file.
  307. This is useful when the column width in tables is forced with <N> cookies
  308. in table fields. Such tables will look correct only after the first re-align.
  309. This can also be configured on a per-file basis by adding one of
  310. the following lines anywhere in the buffer:
  311. #+STARTUP: align
  312. #+STARTUP: noalign"
  313. :group 'org-startup
  314. :type 'boolean)
  315. (defcustom org-insert-mode-line-in-empty-file nil
  316. "Non-nil means insert the first line setting Org-mode in empty files.
  317. When the function `org-mode' is called interactively in an empty file, this
  318. normally means that the file name does not automatically trigger Org-mode.
  319. To ensure that the file will always be in Org-mode in the future, a
  320. line enforcing Org-mode will be inserted into the buffer, if this option
  321. has been set."
  322. :group 'org-startup
  323. :type 'boolean)
  324. (defcustom org-replace-disputed-keys nil
  325. "Non-nil means use alternative key bindings for some keys.
  326. Org-mode uses S-<cursor> keys for changing timestamps and priorities.
  327. These keys are also used by other packages like shift-selection-mode'
  328. \(built into Emacs 23), `CUA-mode' or `windmove.el'.
  329. If you want to use Org-mode together with one of these other modes,
  330. or more generally if you would like to move some Org-mode commands to
  331. other keys, set this variable and configure the keys with the variable
  332. `org-disputed-keys'.
  333. This option is only relevant at load-time of Org-mode, and must be set
  334. *before* org.el is loaded. Changing it requires a restart of Emacs to
  335. become effective."
  336. :group 'org-startup
  337. :type 'boolean)
  338. (defcustom org-use-extra-keys nil
  339. "Non-nil means use extra key sequence definitions for certain
  340. commands. This happens automatically if you run XEmacs or if
  341. window-system is nil. This variable lets you do the same
  342. manually. You must set it before loading org.
  343. Example: on Carbon Emacs 22 running graphically, with an external
  344. keyboard on a Powerbook, the default way of setting M-left might
  345. not work for either Alt or ESC. Setting this variable will make
  346. it work for ESC."
  347. :group 'org-startup
  348. :type 'boolean)
  349. (if (fboundp 'defvaralias)
  350. (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys))
  351. (defcustom org-disputed-keys
  352. '(([(shift up)] . [(meta p)])
  353. ([(shift down)] . [(meta n)])
  354. ([(shift left)] . [(meta -)])
  355. ([(shift right)] . [(meta +)])
  356. ([(control shift right)] . [(meta shift +)])
  357. ([(control shift left)] . [(meta shift -)]))
  358. "Keys for which Org-mode and other modes compete.
  359. This is an alist, cars are the default keys, second element specifies
  360. the alternative to use when `org-replace-disputed-keys' is t.
  361. Keys can be specified in any syntax supported by `define-key'.
  362. The value of this option takes effect only at Org-mode's startup,
  363. therefore you'll have to restart Emacs to apply it after changing."
  364. :group 'org-startup
  365. :type 'alist)
  366. (defun org-key (key)
  367. "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
  368. Or return the original if not disputed.
  369. Also apply the trnaslations defined in `org-xemacs-key-equivalents'."
  370. (when org-replace-disputed-keys
  371. (let* ((nkey (key-description key))
  372. (x (org-find-if (lambda (x)
  373. (equal (key-description (car x)) nkey))
  374. org-disputed-keys)))
  375. (setq key (if x (cdr x) key))))
  376. (when (featurep 'xemacs)
  377. (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
  378. key)
  379. (defun org-find-if (predicate seq)
  380. (catch 'exit
  381. (while seq
  382. (if (funcall predicate (car seq))
  383. (throw 'exit (car seq))
  384. (pop seq)))))
  385. (defun org-defkey (keymap key def)
  386. "Define a key, possibly translated, as returned by `org-key'."
  387. (define-key keymap (org-key key) def))
  388. (defcustom org-ellipsis nil
  389. "The ellipsis to use in the Org-mode outline.
  390. When nil, just use the standard three dots. When a string, use that instead,
  391. When a face, use the standard 3 dots, but with the specified face.
  392. The change affects only Org-mode (which will then use its own display table).
  393. Changing this requires executing `M-x org-mode' in a buffer to become
  394. effective."
  395. :group 'org-startup
  396. :type '(choice (const :tag "Default" nil)
  397. (face :tag "Face" :value org-warning)
  398. (string :tag "String" :value "...#")))
  399. (defvar org-display-table nil
  400. "The display table for org-mode, in case `org-ellipsis' is non-nil.")
  401. (defgroup org-keywords nil
  402. "Keywords in Org-mode."
  403. :tag "Org Keywords"
  404. :group 'org)
  405. (defcustom org-deadline-string "DEADLINE:"
  406. "String to mark deadline entries.
  407. A deadline is this string, followed by a time stamp. Should be a word,
  408. terminated by a colon. You can insert a schedule keyword and
  409. a timestamp with \\[org-deadline].
  410. Changes become only effective after restarting Emacs."
  411. :group 'org-keywords
  412. :type 'string)
  413. (defcustom org-scheduled-string "SCHEDULED:"
  414. "String to mark scheduled TODO entries.
  415. A schedule is this string, followed by a time stamp. Should be a word,
  416. terminated by a colon. You can insert a schedule keyword and
  417. a timestamp with \\[org-schedule].
  418. Changes become only effective after restarting Emacs."
  419. :group 'org-keywords
  420. :type 'string)
  421. (defcustom org-closed-string "CLOSED:"
  422. "String used as the prefix for timestamps logging closing a TODO entry."
  423. :group 'org-keywords
  424. :type 'string)
  425. (defcustom org-clock-string "CLOCK:"
  426. "String used as prefix for timestamps clocking work hours on an item."
  427. :group 'org-keywords
  428. :type 'string)
  429. (defcustom org-comment-string "COMMENT"
  430. "Entries starting with this keyword will never be exported.
  431. An entry can be toggled between COMMENT and normal with
  432. \\[org-toggle-comment].
  433. Changes become only effective after restarting Emacs."
  434. :group 'org-keywords
  435. :type 'string)
  436. (defcustom org-quote-string "QUOTE"
  437. "Entries starting with this keyword will be exported in fixed-width font.
  438. Quoting applies only to the text in the entry following the headline, and does
  439. not extend beyond the next headline, even if that is lower level.
  440. An entry can be toggled between QUOTE and normal with
  441. \\[org-toggle-fixed-width-section]."
  442. :group 'org-keywords
  443. :type 'string)
  444. (defconst org-repeat-re
  445. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)"
  446. "Regular expression for specifying repeated events.
  447. After a match, group 1 contains the repeat expression.")
  448. (defgroup org-structure nil
  449. "Options concerning the general structure of Org-mode files."
  450. :tag "Org Structure"
  451. :group 'org)
  452. (defgroup org-reveal-location nil
  453. "Options about how to make context of a location visible."
  454. :tag "Org Reveal Location"
  455. :group 'org-structure)
  456. (defconst org-context-choice
  457. '(choice
  458. (const :tag "Always" t)
  459. (const :tag "Never" nil)
  460. (repeat :greedy t :tag "Individual contexts"
  461. (cons
  462. (choice :tag "Context"
  463. (const agenda)
  464. (const org-goto)
  465. (const occur-tree)
  466. (const tags-tree)
  467. (const link-search)
  468. (const mark-goto)
  469. (const bookmark-jump)
  470. (const isearch)
  471. (const default))
  472. (boolean))))
  473. "Contexts for the reveal options.")
  474. (defcustom org-show-hierarchy-above '((default . t))
  475. "Non-nil means show full hierarchy when revealing a location.
  476. Org-mode often shows locations in an org-mode file which might have
  477. been invisible before. When this is set, the hierarchy of headings
  478. above the exposed location is shown.
  479. Turning this off for example for sparse trees makes them very compact.
  480. Instead of t, this can also be an alist specifying this option for different
  481. contexts. Valid contexts are
  482. agenda when exposing an entry from the agenda
  483. org-goto when using the command `org-goto' on key C-c C-j
  484. occur-tree when using the command `org-occur' on key C-c /
  485. tags-tree when constructing a sparse tree based on tags matches
  486. link-search when exposing search matches associated with a link
  487. mark-goto when exposing the jump goal of a mark
  488. bookmark-jump when exposing a bookmark location
  489. isearch when exiting from an incremental search
  490. default default for all contexts not set explicitly"
  491. :group 'org-reveal-location
  492. :type org-context-choice)
  493. (defcustom org-show-following-heading '((default . nil))
  494. "Non-nil means show following heading when revealing a location.
  495. Org-mode often shows locations in an org-mode file which might have
  496. been invisible before. When this is set, the heading following the
  497. match is shown.
  498. Turning this off for example for sparse trees makes them very compact,
  499. but makes it harder to edit the location of the match. In such a case,
  500. use the command \\[org-reveal] to show more context.
  501. Instead of t, this can also be an alist specifying this option for different
  502. contexts. See `org-show-hierarchy-above' for valid contexts."
  503. :group 'org-reveal-location
  504. :type org-context-choice)
  505. (defcustom org-show-siblings '((default . nil) (isearch t))
  506. "Non-nil means show all sibling heading when revealing a location.
  507. Org-mode often shows locations in an org-mode file which might have
  508. been invisible before. When this is set, the sibling of the current entry
  509. heading are all made visible. If `org-show-hierarchy-above' is t,
  510. the same happens on each level of the hierarchy above the current entry.
  511. By default this is on for the isearch context, off for all other contexts.
  512. Turning this off for example for sparse trees makes them very compact,
  513. but makes it harder to edit the location of the match. In such a case,
  514. use the command \\[org-reveal] to show more context.
  515. Instead of t, this can also be an alist specifying this option for different
  516. contexts. See `org-show-hierarchy-above' for valid contexts."
  517. :group 'org-reveal-location
  518. :type org-context-choice)
  519. (defcustom org-show-entry-below '((default . nil))
  520. "Non-nil means show the entry below a headline when revealing a location.
  521. Org-mode often shows locations in an org-mode file which might have
  522. been invisible before. When this is set, the text below the headline that is
  523. exposed is also shown.
  524. By default this is off for all contexts.
  525. Instead of t, this can also be an alist specifying this option for different
  526. contexts. See `org-show-hierarchy-above' for valid contexts."
  527. :group 'org-reveal-location
  528. :type org-context-choice)
  529. (defcustom org-indirect-buffer-display 'other-window
  530. "How should indirect tree buffers be displayed?
  531. This applies to indirect buffers created with the commands
  532. \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
  533. Valid values are:
  534. current-window Display in the current window
  535. other-window Just display in another window.
  536. dedicated-frame Create one new frame, and re-use it each time.
  537. new-frame Make a new frame each time. Note that in this case
  538. previously-made indirect buffers are kept, and you need to
  539. kill these buffers yourself."
  540. :group 'org-structure
  541. :group 'org-agenda-windows
  542. :type '(choice
  543. (const :tag "In current window" current-window)
  544. (const :tag "In current frame, other window" other-window)
  545. (const :tag "Each time a new frame" new-frame)
  546. (const :tag "One dedicated frame" dedicated-frame)))
  547. (defcustom org-use-speed-commands nil
  548. "Non-nil means activate single letter commands at beginning of a headline.
  549. This may also be a function to test for appropriate locations where speed
  550. commands should be active."
  551. :group 'org-structure
  552. :type '(choice
  553. (const :tag "Never" nil)
  554. (const :tag "At beginning of headline stars" t)
  555. (function)))
  556. (defcustom org-speed-commands-user nil
  557. "Alist of additional speed commands.
  558. This list will be checked before `org-speed-commands-default'
  559. when the variable `org-use-speed-commands' is non-nil
  560. and when the cursor is at the beginning of a headline.
  561. The car if each entry is a string with a single letter, which must
  562. be assigned to `self-insert-command' in the global map.
  563. The cdr is either a command to be called interactively, a function
  564. to be called, or a form to be evaluated.
  565. An entry that is just a list with a single string will be interpreted
  566. as a descriptive headline that will be added when listing the speed
  567. copmmands in the Help buffer using the `?' speed command."
  568. :group 'org-structure
  569. :type '(repeat :value ("k" . ignore)
  570. (choice :value ("k" . ignore)
  571. (list :tag "Descriptive Headline" (string :tag "Headline"))
  572. (cons :tag "Letter and Command"
  573. (string :tag "Command letter")
  574. (choice
  575. (function)
  576. (sexp))))))
  577. (defgroup org-cycle nil
  578. "Options concerning visibility cycling in Org-mode."
  579. :tag "Org Cycle"
  580. :group 'org-structure)
  581. (defcustom org-cycle-skip-children-state-if-no-children t
  582. "Non-nil means skip CHILDREN state in entries that don't have any."
  583. :group 'org-cycle
  584. :type 'boolean)
  585. (defcustom org-cycle-max-level nil
  586. "Maximum level which should still be subject to visibility cycling.
  587. Levels higher than this will, for cycling, be treated as text, not a headline.
  588. When `org-odd-levels-only' is set, a value of N in this variable actually
  589. means 2N-1 stars as the limiting headline.
  590. When nil, cycle all levels.
  591. Note that the limiting level of cycling is also influenced by
  592. `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
  593. `org-inlinetask-min-level' is, cycling will be limited to levels one less
  594. than its value."
  595. :group 'org-cycle
  596. :type '(choice
  597. (const :tag "No limit" nil)
  598. (integer :tag "Maximum level")))
  599. (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK")
  600. "Names of drawers. Drawers are not opened by cycling on the headline above.
  601. Drawers only open with a TAB on the drawer line itself. A drawer looks like
  602. this:
  603. :DRAWERNAME:
  604. .....
  605. :END:
  606. The drawer \"PROPERTIES\" is special for capturing properties through
  607. the property API.
  608. Drawers can be defined on the per-file basis with a line like:
  609. #+DRAWERS: HIDDEN STATE PROPERTIES"
  610. :group 'org-structure
  611. :group 'org-cycle
  612. :type '(repeat (string :tag "Drawer Name")))
  613. (defcustom org-hide-block-startup nil
  614. "Non-nil means entering Org-mode will fold all blocks.
  615. This can also be set in on a per-file basis with
  616. #+STARTUP: hideblocks
  617. #+STARTUP: showblocks"
  618. :group 'org-startup
  619. :group 'org-cycle
  620. :type 'boolean)
  621. (defcustom org-cycle-global-at-bob nil
  622. "Cycle globally if cursor is at beginning of buffer and not at a headline.
  623. This makes it possible to do global cycling without having to use S-TAB or
  624. C-u TAB. For this special case to work, the first line of the buffer
  625. must not be a headline - it may be empty or some other text. When used in
  626. this way, `org-cycle-hook' is disables temporarily, to make sure the
  627. cursor stays at the beginning of the buffer.
  628. When this option is nil, don't do anything special at the beginning
  629. of the buffer."
  630. :group 'org-cycle
  631. :type 'boolean)
  632. (defcustom org-cycle-level-after-item/entry-creation t
  633. "Non-nil means cycle entry level or item indentation in new empty entries.
  634. When the cursor is at the end of an empty headline, i.e with only stars
  635. and maybe a TODO keyword, TAB will then switch the entry to become a child,
  636. and then all possible anchestor states, before returning to the original state.
  637. This makes data entry extremely fast: M-RET to create a new headline,
  638. on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
  639. When the cursor is at the end of an empty plain list item, one TAB will
  640. make it a subitem, two or more tabs will back up to make this an item
  641. higher up in the item hierarchy."
  642. :group 'org-cycle
  643. :type 'boolean)
  644. (defcustom org-cycle-emulate-tab t
  645. "Where should `org-cycle' emulate TAB.
  646. nil Never
  647. white Only in completely white lines
  648. whitestart Only at the beginning of lines, before the first non-white char
  649. t Everywhere except in headlines
  650. exc-hl-bol Everywhere except at the start of a headline
  651. If TAB is used in a place where it does not emulate TAB, the current subtree
  652. visibility is cycled."
  653. :group 'org-cycle
  654. :type '(choice (const :tag "Never" nil)
  655. (const :tag "Only in completely white lines" white)
  656. (const :tag "Before first char in a line" whitestart)
  657. (const :tag "Everywhere except in headlines" t)
  658. (const :tag "Everywhere except at bol in headlines" exc-hl-bol)
  659. ))
  660. (defcustom org-cycle-separator-lines 2
  661. "Number of empty lines needed to keep an empty line between collapsed trees.
  662. If you leave an empty line between the end of a subtree and the following
  663. headline, this empty line is hidden when the subtree is folded.
  664. Org-mode will leave (exactly) one empty line visible if the number of
  665. empty lines is equal or larger to the number given in this variable.
  666. So the default 2 means at least 2 empty lines after the end of a subtree
  667. are needed to produce free space between a collapsed subtree and the
  668. following headline.
  669. If the number is negative, and the number of empty lines is at least -N,
  670. all empty lines are shown.
  671. Special case: when 0, never leave empty lines in collapsed view."
  672. :group 'org-cycle
  673. :type 'integer)
  674. (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
  675. (defcustom org-pre-cycle-hook nil
  676. "Hook that is run before visibility cycling is happening.
  677. The function(s) in this hook must accept a single argument which indicates
  678. the new state that will be set right after running this hook. The
  679. argument is a symbol. Before a global state change, it can have the values
  680. `overview', `content', or `all'. Before a local state change, it can have
  681. the values `folded', `children', or `subtree'."
  682. :group 'org-cycle
  683. :type 'hook)
  684. (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
  685. org-cycle-hide-drawers
  686. org-cycle-show-empty-lines
  687. org-optimize-window-after-visibility-change)
  688. "Hook that is run after `org-cycle' has changed the buffer visibility.
  689. The function(s) in this hook must accept a single argument which indicates
  690. the new state that was set by the most recent `org-cycle' command. The
  691. argument is a symbol. After a global state change, it can have the values
  692. `overview', `content', or `all'. After a local state change, it can have
  693. the values `folded', `children', or `subtree'."
  694. :group 'org-cycle
  695. :type 'hook)
  696. (defgroup org-edit-structure nil
  697. "Options concerning structure editing in Org-mode."
  698. :tag "Org Edit Structure"
  699. :group 'org-structure)
  700. (defcustom org-odd-levels-only nil
  701. "Non-nil means skip even levels and only use odd levels for the outline.
  702. This has the effect that two stars are being added/taken away in
  703. promotion/demotion commands. It also influences how levels are
  704. handled by the exporters.
  705. Changing it requires restart of `font-lock-mode' to become effective
  706. for fontification also in regions already fontified.
  707. You may also set this on a per-file basis by adding one of the following
  708. lines to the buffer:
  709. #+STARTUP: odd
  710. #+STARTUP: oddeven"
  711. :group 'org-edit-structure
  712. :group 'org-appearance
  713. :type 'boolean)
  714. (defcustom org-adapt-indentation t
  715. "Non-nil means adapt indentation to outline node level.
  716. When this variable is set, Org assumes that you write outlines by
  717. indenting text in each node to align with the headline (after the stars).
  718. The following issues are influenced by this variable:
  719. - When this is set and the *entire* text in an entry is indented, the
  720. indentation is increased by one space in a demotion command, and
  721. decreased by one in a promotion command. If any line in the entry
  722. body starts with text at column 0, indentation is not changed at all.
  723. - Property drawers and planning information is inserted indented when
  724. this variable s set. When nil, they will not be indented.
  725. - TAB indents a line relative to context. The lines below a headline
  726. will be indented when this variable is set.
  727. Note that this is all about true indentation, by adding and removing
  728. space characters. See also `org-indent.el' which does level-dependent
  729. indentation in a virtual way, i.e. at display time in Emacs."
  730. :group 'org-edit-structure
  731. :type 'boolean)
  732. (defcustom org-special-ctrl-a/e nil
  733. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  734. When t, `C-a' will bring back the cursor to the beginning of the
  735. headline text, i.e. after the stars and after a possible TODO keyword.
  736. In an item, this will be the position after the bullet.
  737. When the cursor is already at that position, another `C-a' will bring
  738. it to the beginning of the line.
  739. `C-e' will jump to the end of the headline, ignoring the presence of tags
  740. in the headline. A second `C-e' will then jump to the true end of the
  741. line, after any tags. This also means that, when this variable is
  742. non-nil, `C-e' also will never jump beyond the end of the heading of a
  743. folded section, i.e. not after the ellipses.
  744. When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
  745. going to the true line boundary first. Only a directly following, identical
  746. keypress will bring the cursor to the special positions.
  747. This may also be a cons cell where the behavior for `C-a' and `C-e' is
  748. set separately."
  749. :group 'org-edit-structure
  750. :type '(choice
  751. (const :tag "off" nil)
  752. (const :tag "on: after stars/bullet and before tags first" t)
  753. (const :tag "reversed: true line boundary first" reversed)
  754. (cons :tag "Set C-a and C-e separately"
  755. (choice :tag "Special C-a"
  756. (const :tag "off" nil)
  757. (const :tag "on: after stars/bullet first" t)
  758. (const :tag "reversed: before stars/bullet first" reversed))
  759. (choice :tag "Special C-e"
  760. (const :tag "off" nil)
  761. (const :tag "on: before tags first" t)
  762. (const :tag "reversed: after tags first" reversed)))))
  763. (if (fboundp 'defvaralias)
  764. (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e))
  765. (defcustom org-special-ctrl-k nil
  766. "Non-nil means `C-k' will behave specially in headlines.
  767. When nil, `C-k' will call the default `kill-line' command.
  768. When t, the following will happen while the cursor is in the headline:
  769. - When the cursor is at the beginning of a headline, kill the entire
  770. line and possible the folded subtree below the line.
  771. - When in the middle of the headline text, kill the headline up to the tags.
  772. - When after the headline text, kill the tags."
  773. :group 'org-edit-structure
  774. :type 'boolean)
  775. (defcustom org-yank-folded-subtrees t
  776. "Non-nil means when yanking subtrees, fold them.
  777. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  778. it starts with a heading and all other headings in it are either children
  779. or siblings, then fold all the subtrees. However, do this only if no
  780. text after the yank would be swallowed into a folded tree by this action."
  781. :group 'org-edit-structure
  782. :type 'boolean)
  783. (defcustom org-yank-adjusted-subtrees nil
  784. "Non-nil means when yanking subtrees, adjust the level.
  785. With this setting, `org-paste-subtree' is used to insert the subtree, see
  786. this function for details."
  787. :group 'org-edit-structure
  788. :type 'boolean)
  789. (defcustom org-M-RET-may-split-line '((default . t))
  790. "Non-nil means M-RET will split the line at the cursor position.
  791. When nil, it will go to the end of the line before making a
  792. new line.
  793. You may also set this option in a different way for different
  794. contexts. Valid contexts are:
  795. headline when creating a new headline
  796. item when creating a new item
  797. table in a table field
  798. default the value to be used for all contexts not explicitly
  799. customized"
  800. :group 'org-structure
  801. :group 'org-table
  802. :type '(choice
  803. (const :tag "Always" t)
  804. (const :tag "Never" nil)
  805. (repeat :greedy t :tag "Individual contexts"
  806. (cons
  807. (choice :tag "Context"
  808. (const headline)
  809. (const item)
  810. (const table)
  811. (const default))
  812. (boolean)))))
  813. (defcustom org-insert-heading-respect-content nil
  814. "Non-nil means insert new headings after the current subtree.
  815. When nil, the new heading is created directly after the current line.
  816. The commands \\[org-insert-heading-respect-content] and
  817. \\[org-insert-todo-heading-respect-content] turn this variable on
  818. for the duration of the command."
  819. :group 'org-structure
  820. :type 'boolean)
  821. (defcustom org-blank-before-new-entry '((heading . auto)
  822. (plain-list-item . auto))
  823. "Should `org-insert-heading' leave a blank line before new heading/item?
  824. The value is an alist, with `heading' and `plain-list-item' as car,
  825. and a boolean flag as cdr. For plain lists, if the variable
  826. `org-empty-line-terminates-plain-lists' is set, the setting here
  827. is ignored and no empty line is inserted, to keep the list in tact."
  828. :group 'org-edit-structure
  829. :type '(list
  830. (cons (const heading)
  831. (choice (const :tag "Never" nil)
  832. (const :tag "Always" t)
  833. (const :tag "Auto" auto)))
  834. (cons (const plain-list-item)
  835. (choice (const :tag "Never" nil)
  836. (const :tag "Always" t)
  837. (const :tag "Auto" auto)))))
  838. (defcustom org-insert-heading-hook nil
  839. "Hook being run after inserting a new heading."
  840. :group 'org-edit-structure
  841. :type 'hook)
  842. (defcustom org-enable-fixed-width-editor t
  843. "Non-nil means lines starting with \":\" are treated as fixed-width.
  844. This currently only means they are never auto-wrapped.
  845. When nil, such lines will be treated like ordinary lines.
  846. See also the QUOTE keyword."
  847. :group 'org-edit-structure
  848. :type 'boolean)
  849. (defcustom org-goto-auto-isearch t
  850. "Non-nil means typing characters in org-goto starts incremental search."
  851. :group 'org-edit-structure
  852. :type 'boolean)
  853. (defgroup org-sparse-trees nil
  854. "Options concerning sparse trees in Org-mode."
  855. :tag "Org Sparse Trees"
  856. :group 'org-structure)
  857. (defcustom org-highlight-sparse-tree-matches t
  858. "Non-nil means highlight all matches that define a sparse tree.
  859. The highlights will automatically disappear the next time the buffer is
  860. changed by an edit command."
  861. :group 'org-sparse-trees
  862. :type 'boolean)
  863. (defcustom org-remove-highlights-with-change t
  864. "Non-nil means any change to the buffer will remove temporary highlights.
  865. Such highlights are created by `org-occur' and `org-clock-display'.
  866. When nil, `C-c C-c needs to be used to get rid of the highlights.
  867. The highlights created by `org-preview-latex-fragment' always need
  868. `C-c C-c' to be removed."
  869. :group 'org-sparse-trees
  870. :group 'org-time
  871. :type 'boolean)
  872. (defcustom org-occur-hook '(org-first-headline-recenter)
  873. "Hook that is run after `org-occur' has constructed a sparse tree.
  874. This can be used to recenter the window to show as much of the structure
  875. as possible."
  876. :group 'org-sparse-trees
  877. :type 'hook)
  878. (defgroup org-imenu-and-speedbar nil
  879. "Options concerning imenu and speedbar in Org-mode."
  880. :tag "Org Imenu and Speedbar"
  881. :group 'org-structure)
  882. (defcustom org-imenu-depth 2
  883. "The maximum level for Imenu access to Org-mode headlines.
  884. This also applied for speedbar access."
  885. :group 'org-imenu-and-speedbar
  886. :type 'integer)
  887. (defgroup org-table nil
  888. "Options concerning tables in Org-mode."
  889. :tag "Org Table"
  890. :group 'org)
  891. (defcustom org-enable-table-editor 'optimized
  892. "Non-nil means lines starting with \"|\" are handled by the table editor.
  893. When nil, such lines will be treated like ordinary lines.
  894. When equal to the symbol `optimized', the table editor will be optimized to
  895. do the following:
  896. - Automatic overwrite mode in front of whitespace in table fields.
  897. This makes the structure of the table stay in tact as long as the edited
  898. field does not exceed the column width.
  899. - Minimize the number of realigns. Normally, the table is aligned each time
  900. TAB or RET are pressed to move to another field. With optimization this
  901. happens only if changes to a field might have changed the column width.
  902. Optimization requires replacing the functions `self-insert-command',
  903. `delete-char', and `backward-delete-char' in Org-mode buffers, with a
  904. slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
  905. very good at guessing when a re-align will be necessary, but you can always
  906. force one with \\[org-ctrl-c-ctrl-c].
  907. If you would like to use the optimized version in Org-mode, but the
  908. un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
  909. This variable can be used to turn on and off the table editor during a session,
  910. but in order to toggle optimization, a restart is required.
  911. See also the variable `org-table-auto-blank-field'."
  912. :group 'org-table
  913. :type '(choice
  914. (const :tag "off" nil)
  915. (const :tag "on" t)
  916. (const :tag "on, optimized" optimized)))
  917. (defcustom org-self-insert-cluster-for-undo t
  918. "Non-nil means cluster self-insert commands for undo when possible.
  919. If this is set, then, like in the Emacs command loop, 20 consecutive
  920. characters will be undone together.
  921. This is configurable, because there is some impact on typing performance."
  922. :group 'org-table
  923. :type 'boolean)
  924. (defcustom org-table-tab-recognizes-table.el t
  925. "Non-nil means TAB will automatically notice a table.el table.
  926. When it sees such a table, it moves point into it and - if necessary -
  927. calls `table-recognize-table'."
  928. :group 'org-table-editing
  929. :type 'boolean)
  930. (defgroup org-link nil
  931. "Options concerning links in Org-mode."
  932. :tag "Org Link"
  933. :group 'org)
  934. (defvar org-link-abbrev-alist-local nil
  935. "Buffer-local version of `org-link-abbrev-alist', which see.
  936. The value of this is taken from the #+LINK lines.")
  937. (make-variable-buffer-local 'org-link-abbrev-alist-local)
  938. (defcustom org-link-abbrev-alist nil
  939. "Alist of link abbreviations.
  940. The car of each element is a string, to be replaced at the start of a link.
  941. The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
  942. links in Org-mode buffers can have an optional tag after a double colon, e.g.
  943. [[linkkey:tag][description]]
  944. The 'linkkey' must be a word word, starting with a letter, followed
  945. by letters, numbers, '-' or '_'.
  946. If REPLACE is a string, the tag will simply be appended to create the link.
  947. If the string contains \"%s\", the tag will be inserted there. Alternatively,
  948. the placeholder \"%h\" will cause a url-encoded version of the tag to
  949. be inserted at that point (see the function `url-hexify-string').
  950. REPLACE may also be a function that will be called with the tag as the
  951. only argument to create the link, which should be returned as a string.
  952. See the manual for examples."
  953. :group 'org-link
  954. :type '(repeat
  955. (cons
  956. (string :tag "Protocol")
  957. (choice
  958. (string :tag "Format")
  959. (function)))))
  960. (defcustom org-descriptive-links t
  961. "Non-nil means hide link part and only show description of bracket links.
  962. Bracket links are like [[link][description]]. This variable sets the initial
  963. state in new org-mode buffers. The setting can then be toggled on a
  964. per-buffer basis from the Org->Hyperlinks menu."
  965. :group 'org-link
  966. :type 'boolean)
  967. (defcustom org-link-file-path-type 'adaptive
  968. "How the path name in file links should be stored.
  969. Valid values are:
  970. relative Relative to the current directory, i.e. the directory of the file
  971. into which the link is being inserted.
  972. absolute Absolute path, if possible with ~ for home directory.
  973. noabbrev Absolute path, no abbreviation of home directory.
  974. adaptive Use relative path for files in the current directory and sub-
  975. directories of it. For other files, use an absolute path."
  976. :group 'org-link
  977. :type '(choice
  978. (const relative)
  979. (const absolute)
  980. (const noabbrev)
  981. (const adaptive)))
  982. (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
  983. "Types of links that should be activated in Org-mode files.
  984. This is a list of symbols, each leading to the activation of a certain link
  985. type. In principle, it does not hurt to turn on most link types - there may
  986. be a small gain when turning off unused link types. The types are:
  987. bracket The recommended [[link][description]] or [[link]] links with hiding.
  988. angular Links in angular brackets that may contain whitespace like
  989. <bbdb:Carsten Dominik>.
  990. plain Plain links in normal text, no whitespace, like http://google.com.
  991. radio Text that is matched by a radio target, see manual for details.
  992. tag Tag settings in a headline (link to tag search).
  993. date Time stamps (link to calendar).
  994. footnote Footnote labels.
  995. Changing this variable requires a restart of Emacs to become effective."
  996. :group 'org-link
  997. :type '(set :greedy t
  998. (const :tag "Double bracket links (new style)" bracket)
  999. (const :tag "Angular bracket links (old style)" angular)
  1000. (const :tag "Plain text links" plain)
  1001. (const :tag "Radio target matches" radio)
  1002. (const :tag "Tags" tag)
  1003. (const :tag "Timestamps" date)
  1004. (const :tag "Footnotes" footnote)))
  1005. (defcustom org-make-link-description-function nil
  1006. "Function to use to generate link descriptions from links. If
  1007. nil the link location will be used. This function must take two
  1008. parameters; the first is the link and the second the description
  1009. org-insert-link has generated, and should return the description
  1010. to use."
  1011. :group 'org-link
  1012. :type 'function)
  1013. (defgroup org-link-store nil
  1014. "Options concerning storing links in Org-mode."
  1015. :tag "Org Store Link"
  1016. :group 'org-link)
  1017. (defcustom org-email-link-description-format "Email %c: %.30s"
  1018. "Format of the description part of a link to an email or usenet message.
  1019. The following %-escapes will be replaced by corresponding information:
  1020. %F full \"From\" field
  1021. %f name, taken from \"From\" field, address if no name
  1022. %T full \"To\" field
  1023. %t first name in \"To\" field, address if no name
  1024. %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
  1025. will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
  1026. %s subject
  1027. %m message-id.
  1028. You may use normal field width specification between the % and the letter.
  1029. This is for example useful to limit the length of the subject.
  1030. Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
  1031. :group 'org-link-store
  1032. :type 'string)
  1033. (defcustom org-from-is-user-regexp
  1034. (let (r1 r2)
  1035. (when (and user-mail-address (not (string= user-mail-address "")))
  1036. (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
  1037. (when (and user-full-name (not (string= user-full-name "")))
  1038. (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
  1039. (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
  1040. "Regexp matched against the \"From:\" header of an email or usenet message.
  1041. It should match if the message is from the user him/herself."
  1042. :group 'org-link-store
  1043. :type 'regexp)
  1044. (defcustom org-link-to-org-use-id 'create-if-interactive-and-no-custom-id
  1045. "Non-nil means storing a link to an Org file will use entry IDs.
  1046. Note that before this variable is even considered, org-id must be loaded,
  1047. so please customize `org-modules' and turn it on.
  1048. The variable can have the following values:
  1049. t Create an ID if needed to make a link to the current entry.
  1050. create-if-interactive
  1051. If `org-store-link' is called directly (interactively, as a user
  1052. command), do create an ID to support the link. But when doing the
  1053. job for remember, only use the ID if it already exists. The
  1054. purpose of this setting is to avoid proliferation of unwanted
  1055. IDs, just because you happen to be in an Org file when you
  1056. call `org-remember' that automatically and preemptively
  1057. creates a link. If you do want to get an ID link in a remember
  1058. template to an entry not having an ID, create it first by
  1059. explicitly creating a link to it, using `C-c C-l' first.
  1060. create-if-interactive-and-no-custom-id
  1061. Like create-if-interactive, but do not create an ID if there is
  1062. a CUSTOM_ID property defined in the entry. This is the default.
  1063. use-existing
  1064. Use existing ID, do not create one.
  1065. nil Never use an ID to make a link, instead link using a text search for
  1066. the headline text."
  1067. :group 'org-link-store
  1068. :type '(choice
  1069. (const :tag "Create ID to make link" t)
  1070. (const :tag "Create if storing link interactively"
  1071. create-if-interactive)
  1072. (const :tag "Create if storing link interactively and no CUSTOM_ID is present"
  1073. create-if-interactive-and-no-custom-id)
  1074. (const :tag "Only use existing" use-existing)
  1075. (const :tag "Do not use ID to create link" nil)))
  1076. (defcustom org-context-in-file-links t
  1077. "Non-nil means file links from `org-store-link' contain context.
  1078. A search string will be added to the file name with :: as separator and
  1079. used to find the context when the link is activated by the command
  1080. `org-open-at-point'.
  1081. Using a prefix arg to the command \\[org-store-link] (`org-store-link')
  1082. negates this setting for the duration of the command."
  1083. :group 'org-link-store
  1084. :type 'boolean)
  1085. (defcustom org-keep-stored-link-after-insertion nil
  1086. "Non-nil means keep link in list for entire session.
  1087. The command `org-store-link' adds a link pointing to the current
  1088. location to an internal list. These links accumulate during a session.
  1089. The command `org-insert-link' can be used to insert links into any
  1090. Org-mode file (offering completion for all stored links). When this
  1091. option is nil, every link which has been inserted once using \\[org-insert-link]
  1092. will be removed from the list, to make completing the unused links
  1093. more efficient."
  1094. :group 'org-link-store
  1095. :type 'boolean)
  1096. (defgroup org-link-follow nil
  1097. "Options concerning following links in Org-mode."
  1098. :tag "Org Follow Link"
  1099. :group 'org-link)
  1100. (defcustom org-link-translation-function nil
  1101. "Function to translate links with different syntax to Org syntax.
  1102. This can be used to translate links created for example by the Planner
  1103. or emacs-wiki packages to Org syntax.
  1104. The function must accept two parameters, a TYPE containing the link
  1105. protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
  1106. which is everything after the link protocol. It should return a cons
  1107. with possibly modified values of type and path.
  1108. Org contains a function for this, so if you set this variable to
  1109. `org-translate-link-from-planner', you should be able follow many
  1110. links created by planner."
  1111. :group 'org-link-follow
  1112. :type 'function)
  1113. (defcustom org-follow-link-hook nil
  1114. "Hook that is run after a link has been followed."
  1115. :group 'org-link-follow
  1116. :type 'hook)
  1117. (defcustom org-tab-follows-link nil
  1118. "Non-nil means on links TAB will follow the link.
  1119. Needs to be set before org.el is loaded.
  1120. This really should not be used, it does not make sense, and the
  1121. implementation is bad."
  1122. :group 'org-link-follow
  1123. :type 'boolean)
  1124. (defcustom org-return-follows-link nil
  1125. "Non-nil means on links RET will follow the link."
  1126. :group 'org-link-follow
  1127. :type 'boolean)
  1128. (defcustom org-mouse-1-follows-link
  1129. (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
  1130. "Non-nil means mouse-1 on a link will follow the link.
  1131. A longer mouse click will still set point. Does not work on XEmacs.
  1132. Needs to be set before org.el is loaded."
  1133. :group 'org-link-follow
  1134. :type 'boolean)
  1135. (defcustom org-mark-ring-length 4
  1136. "Number of different positions to be recorded in the ring
  1137. Changing this requires a restart of Emacs to work correctly."
  1138. :group 'org-link-follow
  1139. :type 'integer)
  1140. (defcustom org-link-frame-setup
  1141. '((vm . vm-visit-folder-other-frame)
  1142. (gnus . gnus-other-frame)
  1143. (file . find-file-other-window))
  1144. "Setup the frame configuration for following links.
  1145. When following a link with Emacs, it may often be useful to display
  1146. this link in another window or frame. This variable can be used to
  1147. set this up for the different types of links.
  1148. For VM, use any of
  1149. `vm-visit-folder'
  1150. `vm-visit-folder-other-frame'
  1151. For Gnus, use any of
  1152. `gnus'
  1153. `gnus-other-frame'
  1154. `org-gnus-no-new-news'
  1155. For FILE, use any of
  1156. `find-file'
  1157. `find-file-other-window'
  1158. `find-file-other-frame'
  1159. For the calendar, use the variable `calendar-setup'.
  1160. For BBDB, it is currently only possible to display the matches in
  1161. another window."
  1162. :group 'org-link-follow
  1163. :type '(list
  1164. (cons (const vm)
  1165. (choice
  1166. (const vm-visit-folder)
  1167. (const vm-visit-folder-other-window)
  1168. (const vm-visit-folder-other-frame)))
  1169. (cons (const gnus)
  1170. (choice
  1171. (const gnus)
  1172. (const gnus-other-frame)
  1173. (const org-gnus-no-new-news)))
  1174. (cons (const file)
  1175. (choice
  1176. (const find-file)
  1177. (const find-file-other-window)
  1178. (const find-file-other-frame)))))
  1179. (defcustom org-display-internal-link-with-indirect-buffer nil
  1180. "Non-nil means use indirect buffer to display infile links.
  1181. Activating internal links (from one location in a file to another location
  1182. in the same file) normally just jumps to the location. When the link is
  1183. activated with a C-u prefix (or with mouse-3), the link is displayed in
  1184. another window. When this option is set, the other window actually displays
  1185. an indirect buffer clone of the current buffer, to avoid any visibility
  1186. changes to the current buffer."
  1187. :group 'org-link-follow
  1188. :type 'boolean)
  1189. (defcustom org-open-non-existing-files nil
  1190. "Non-nil means `org-open-file' will open non-existing files.
  1191. When nil, an error will be generated.
  1192. This variable applies only to external applications because they
  1193. might choke on non-existing files. If the link is to a file that
  1194. will be opened in Emacs, the variable is ignored."
  1195. :group 'org-link-follow
  1196. :type 'boolean)
  1197. (defcustom org-open-directory-means-index-dot-org nil
  1198. "Non-nil means a link to a directory really means to index.org.
  1199. When nil, following a directory link will run dired or open a finder/explorer
  1200. window on that directory."
  1201. :group 'org-link-follow
  1202. :type 'boolean)
  1203. (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
  1204. "Function and arguments to call for following mailto links.
  1205. This is a list with the first element being a lisp function, and the
  1206. remaining elements being arguments to the function. In string arguments,
  1207. %a will be replaced by the address, and %s will be replaced by the subject
  1208. if one was given like in <mailto:arthur@galaxy.org::this subject>."
  1209. :group 'org-link-follow
  1210. :type '(choice
  1211. (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
  1212. (const :tag "compose-mail" (compose-mail "%a" "%s"))
  1213. (const :tag "message-mail" (message-mail "%a" "%s"))
  1214. (cons :tag "other" (function) (repeat :tag "argument" sexp))))
  1215. (defcustom org-confirm-shell-link-function 'yes-or-no-p
  1216. "Non-nil means ask for confirmation before executing shell links.
  1217. Shell links can be dangerous: just think about a link
  1218. [[shell:rm -rf ~/*][Google Search]]
  1219. This link would show up in your Org-mode document as \"Google Search\",
  1220. but really it would remove your entire home directory.
  1221. Therefore we advise against setting this variable to nil.
  1222. Just change it to `y-or-n-p' if you want to confirm with a
  1223. single keystroke rather than having to type \"yes\"."
  1224. :group 'org-link-follow
  1225. :type '(choice
  1226. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1227. (const :tag "with y-or-n (faster)" y-or-n-p)
  1228. (const :tag "no confirmation (dangerous)" nil)))
  1229. (defcustom org-confirm-elisp-link-function 'yes-or-no-p
  1230. "Non-nil means ask for confirmation before executing Emacs Lisp links.
  1231. Elisp links can be dangerous: just think about a link
  1232. [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
  1233. This link would show up in your Org-mode document as \"Google Search\",
  1234. but really it would remove your entire home directory.
  1235. Therefore we advise against setting this variable to nil.
  1236. Just change it to `y-or-n-p' if you want to confirm with a
  1237. single keystroke rather than having to type \"yes\"."
  1238. :group 'org-link-follow
  1239. :type '(choice
  1240. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1241. (const :tag "with y-or-n (faster)" y-or-n-p)
  1242. (const :tag "no confirmation (dangerous)" nil)))
  1243. (defconst org-file-apps-defaults-gnu
  1244. '((remote . emacs)
  1245. (system . mailcap)
  1246. (t . mailcap))
  1247. "Default file applications on a UNIX or GNU/Linux system.
  1248. See `org-file-apps'.")
  1249. (defconst org-file-apps-defaults-macosx
  1250. '((remote . emacs)
  1251. (t . "open %s")
  1252. (system . "open %s")
  1253. ("ps.gz" . "gv %s")
  1254. ("eps.gz" . "gv %s")
  1255. ("dvi" . "xdvi %s")
  1256. ("fig" . "xfig %s"))
  1257. "Default file applications on a MacOS X system.
  1258. The system \"open\" is known as a default, but we use X11 applications
  1259. for some files for which the OS does not have a good default.
  1260. See `org-file-apps'.")
  1261. (defconst org-file-apps-defaults-windowsnt
  1262. (list
  1263. '(remote . emacs)
  1264. (cons t
  1265. (list (if (featurep 'xemacs)
  1266. 'mswindows-shell-execute
  1267. 'w32-shell-execute)
  1268. "open" 'file))
  1269. (cons 'system
  1270. (list (if (featurep 'xemacs)
  1271. 'mswindows-shell-execute
  1272. 'w32-shell-execute)
  1273. "open" 'file)))
  1274. "Default file applications on a Windows NT system.
  1275. The system \"open\" is used for most files.
  1276. See `org-file-apps'.")
  1277. (defcustom org-file-apps
  1278. '(
  1279. (auto-mode . emacs)
  1280. ("\\.mm\\'" . default)
  1281. ("\\.x?html?\\'" . default)
  1282. ("\\.pdf\\'" . default)
  1283. )
  1284. "External applications for opening `file:path' items in a document.
  1285. Org-mode uses system defaults for different file types, but
  1286. you can use this variable to set the application for a given file
  1287. extension. The entries in this list are cons cells where the car identifies
  1288. files and the cdr the corresponding command. Possible values for the
  1289. file identifier are
  1290. \"string\" A string as a file identifier can be interpreted in different
  1291. ways, depending on its contents:
  1292. - Alphanumeric characters only:
  1293. Match links with this file extension.
  1294. Example: (\"pdf\" . \"evince %s\")
  1295. to open PDFs with evince.
  1296. - Regular expression: Match links where the
  1297. filename matches the regexp. If you want to
  1298. use groups here, use shy groups.
  1299. Example: (\"\\.x?html\\'\" . \"firefox %s\")
  1300. (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
  1301. to open *.html and *.xhtml with firefox.
  1302. - Regular expression which contains (non-shy) groups:
  1303. Match links where the whole link, including \"::\", and
  1304. anything after that, matches the regexp.
  1305. In a custom command string, %1, %2, etc. are replaced with
  1306. the parts of the link that were matched by the groups.
  1307. For backwards compatibility, if a command string is given
  1308. that does not use any of the group matches, this case is
  1309. handled identically to the second one (i.e. match against
  1310. file name only).
  1311. In a custom lisp form, you can access the group matches with
  1312. (match-string n link).
  1313. Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
  1314. to open [[file:document.pdf::5]] with evince at page 5.
  1315. `directory' Matches a directory
  1316. `remote' Matches a remote file, accessible through tramp or efs.
  1317. Remote files most likely should be visited through Emacs
  1318. because external applications cannot handle such paths.
  1319. `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
  1320. so all files Emacs knows how to handle. Using this with
  1321. command `emacs' will open most files in Emacs. Beware that this
  1322. will also open html files inside Emacs, unless you add
  1323. (\"html\" . default) to the list as well.
  1324. t Default for files not matched by any of the other options.
  1325. `system' The system command to open files, like `open' on Windows
  1326. and Mac OS X, and mailcap under GNU/Linux. This is the command
  1327. that will be selected if you call `C-c C-o' with a double
  1328. `C-u C-u' prefix.
  1329. Possible values for the command are:
  1330. `emacs' The file will be visited by the current Emacs process.
  1331. `default' Use the default application for this file type, which is the
  1332. association for t in the list, most likely in the system-specific
  1333. part.
  1334. This can be used to overrule an unwanted setting in the
  1335. system-specific variable.
  1336. `system' Use the system command for opening files, like \"open\".
  1337. This command is specified by the entry whose car is `system'.
  1338. Most likely, the system-specific version of this variable
  1339. does define this command, but you can overrule/replace it
  1340. here.
  1341. string A command to be executed by a shell; %s will be replaced
  1342. by the path to the file.
  1343. sexp A Lisp form which will be evaluated. The file path will
  1344. be available in the Lisp variable `file'.
  1345. For more examples, see the system specific constants
  1346. `org-file-apps-defaults-macosx'
  1347. `org-file-apps-defaults-windowsnt'
  1348. `org-file-apps-defaults-gnu'."
  1349. :group 'org-link-follow
  1350. :type '(repeat
  1351. (cons (choice :value ""
  1352. (string :tag "Extension")
  1353. (const :tag "System command to open files" system)
  1354. (const :tag "Default for unrecognized files" t)
  1355. (const :tag "Remote file" remote)
  1356. (const :tag "Links to a directory" directory)
  1357. (const :tag "Any files that have Emacs modes"
  1358. auto-mode))
  1359. (choice :value ""
  1360. (const :tag "Visit with Emacs" emacs)
  1361. (const :tag "Use default" default)
  1362. (const :tag "Use the system command" system)
  1363. (string :tag "Command")
  1364. (sexp :tag "Lisp form")))))
  1365. (defgroup org-refile nil
  1366. "Options concerning refiling entries in Org-mode."
  1367. :tag "Org Refile"
  1368. :group 'org)
  1369. (defcustom org-directory "~/org"
  1370. "Directory with org files.
  1371. This is just a default location to look for Org files. There is no need
  1372. at all to put your files into this directory. It is only used in the
  1373. following situations:
  1374. 1. When a remember template specifies a target file that is not an
  1375. absolute path. The path will then be interpreted relative to
  1376. `org-directory'
  1377. 2. When a remember note is filed away in an interactive way (when exiting the
  1378. note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
  1379. with `org-directory' as the default path."
  1380. :group 'org-refile
  1381. :group 'org-remember
  1382. :type 'directory)
  1383. (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
  1384. "Default target for storing notes.
  1385. Used by the hooks for remember.el. This can be a string, or nil to mean
  1386. the value of `remember-data-file'.
  1387. You can set this on a per-template basis with the variable
  1388. `org-remember-templates'."
  1389. :group 'org-refile
  1390. :group 'org-remember
  1391. :type '(choice
  1392. (const :tag "Default from remember-data-file" nil)
  1393. file))
  1394. (defcustom org-goto-interface 'outline
  1395. "The default interface to be used for `org-goto'.
  1396. Allowed values are:
  1397. outline The interface shows an outline of the relevant file
  1398. and the correct heading is found by moving through
  1399. the outline or by searching with incremental search.
  1400. outline-path-completion Headlines in the current buffer are offered via
  1401. completion. This is the interface also used by
  1402. the refile command."
  1403. :group 'org-refile
  1404. :type '(choice
  1405. (const :tag "Outline" outline)
  1406. (const :tag "Outline-path-completion" outline-path-completion)))
  1407. (defcustom org-goto-max-level 5
  1408. "Maximum level to be considered when running org-goto with refile interface."
  1409. :group 'org-refile
  1410. :type 'integer)
  1411. (defcustom org-reverse-note-order nil
  1412. "Non-nil means store new notes at the beginning of a file or entry.
  1413. When nil, new notes will be filed to the end of a file or entry.
  1414. This can also be a list with cons cells of regular expressions that
  1415. are matched against file names, and values."
  1416. :group 'org-remember
  1417. :group 'org-refile
  1418. :type '(choice
  1419. (const :tag "Reverse always" t)
  1420. (const :tag "Reverse never" nil)
  1421. (repeat :tag "By file name regexp"
  1422. (cons regexp boolean))))
  1423. (defcustom org-log-refile nil
  1424. "Information to record when a task is refiled.
  1425. Possible values are:
  1426. nil Don't add anything
  1427. time Add a time stamp to the task
  1428. note Prompt for a note and add it with template `org-log-note-headings'
  1429. This option can also be set with on a per-file-basis with
  1430. #+STARTUP: nologrefile
  1431. #+STARTUP: logrefile
  1432. #+STARTUP: lognoterefile
  1433. You can have local logging settings for a subtree by setting the LOGGING
  1434. property to one or more of these keywords.
  1435. When bulk-refiling from the agenda, the value `note' is forbidden and
  1436. will temporarily be changed to `time'."
  1437. :group 'org-refile
  1438. :group 'org-progress
  1439. :type '(choice
  1440. (const :tag "No logging" nil)
  1441. (const :tag "Record timestamp" time)
  1442. (const :tag "Record timestamp with note." note)))
  1443. (defcustom org-refile-targets nil
  1444. "Targets for refiling entries with \\[org-refile].
  1445. This is list of cons cells. Each cell contains:
  1446. - a specification of the files to be considered, either a list of files,
  1447. or a symbol whose function or variable value will be used to retrieve
  1448. a file name or a list of file names. If you use `org-agenda-files' for
  1449. that, all agenda files will be scanned for targets. Nil means consider
  1450. headings in the current buffer.
  1451. - A specification of how to find candidate refile targets. This may be
  1452. any of:
  1453. - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
  1454. This tag has to be present in all target headlines, inheritance will
  1455. not be considered.
  1456. - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
  1457. todo keyword.
  1458. - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
  1459. headlines that are refiling targets.
  1460. - a cons cell (:level . N). Any headline of level N is considered a target.
  1461. Note that, when `org-odd-levels-only' is set, level corresponds to
  1462. order in hierarchy, not to the number of stars.
  1463. - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
  1464. Note that, when `org-odd-levels-only' is set, level corresponds to
  1465. order in hierarchy, not to the number of stars.
  1466. You can set the variable `org-refile-target-verify-function' to a function
  1467. to verify each headline found by the simple critery above.
  1468. When this variable is nil, all top-level headlines in the current buffer
  1469. are used, equivalent to the value `((nil . (:level . 1))'."
  1470. :group 'org-refile
  1471. :type '(repeat
  1472. (cons
  1473. (choice :value org-agenda-files
  1474. (const :tag "All agenda files" org-agenda-files)
  1475. (const :tag "Current buffer" nil)
  1476. (function) (variable) (file))
  1477. (choice :tag "Identify target headline by"
  1478. (cons :tag "Specific tag" (const :value :tag) (string))
  1479. (cons :tag "TODO keyword" (const :value :todo) (string))
  1480. (cons :tag "Regular expression" (const :value :regexp) (regexp))
  1481. (cons :tag "Level number" (const :value :level) (integer))
  1482. (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
  1483. (defcustom org-refile-target-verify-function nil
  1484. "Function to verify if the headline at point should be a refile target.
  1485. The function will be called without arguments, with point at the
  1486. beginning of the headline. It should return t and leave point
  1487. where it is if the headline is a valid target for refiling.
  1488. If the target should not be selected, the function must return nil.
  1489. In addition to this, it may move point to a place from where the search
  1490. should be continued. For example, the function may decide that the entire
  1491. subtree of the current entry should be excluded and move point to the end
  1492. of the subtree."
  1493. :group 'org-refile
  1494. :type 'function)
  1495. (defcustom org-refile-use-outline-path nil
  1496. "Non-nil means provide refile targets as paths.
  1497. So a level 3 headline will be available as level1/level2/level3.
  1498. When the value is `file', also include the file name (without directory)
  1499. into the path. In this case, you can also stop the completion after
  1500. the file name, to get entries inserted as top level in the file.
  1501. When `full-file-path', include the full file path."
  1502. :group 'org-refile
  1503. :type '(choice
  1504. (const :tag "Not" nil)
  1505. (const :tag "Yes" t)
  1506. (const :tag "Start with file name" file)
  1507. (const :tag "Start with full file path" full-file-path)))
  1508. (defcustom org-outline-path-complete-in-steps t
  1509. "Non-nil means complete the outline path in hierarchical steps.
  1510. When Org-mode uses the refile interface to select an outline path
  1511. \(see variable `org-refile-use-outline-path'), the completion of
  1512. the path can be done is a single go, or if can be done in steps down
  1513. the headline hierarchy. Going in steps is probably the best if you
  1514. do not use a special completion package like `ido' or `icicles'.
  1515. However, when using these packages, going in one step can be very
  1516. fast, while still showing the whole path to the entry."
  1517. :group 'org-refile
  1518. :type 'boolean)
  1519. (defcustom org-refile-allow-creating-parent-nodes nil
  1520. "Non-nil means allow to create new nodes as refile targets.
  1521. New nodes are then created by adding \"/new node name\" to the completion
  1522. of an existing node. When the value of this variable is `confirm',
  1523. new node creation must be confirmed by the user (recommended)
  1524. When nil, the completion must match an existing entry.
  1525. Note that, if the new heading is not seen by the criteria
  1526. listed in `org-refile-targets', multiple instances of the same
  1527. heading would be created by trying again to file under the new
  1528. heading."
  1529. :group 'org-refile
  1530. :type '(choice
  1531. (const :tag "Never" nil)
  1532. (const :tag "Always" t)
  1533. (const :tag "Prompt for confirmation" confirm)))
  1534. (defgroup org-todo nil
  1535. "Options concerning TODO items in Org-mode."
  1536. :tag "Org TODO"
  1537. :group 'org)
  1538. (defgroup org-progress nil
  1539. "Options concerning Progress logging in Org-mode."
  1540. :tag "Org Progress"
  1541. :group 'org-time)
  1542. (defvar org-todo-interpretation-widgets
  1543. '(
  1544. (:tag "Sequence (cycling hits every state)" sequence)
  1545. (:tag "Type (cycling directly to DONE)" type))
  1546. "The available interpretation symbols for customizing
  1547. `org-todo-keywords'.
  1548. Interested libraries should add to this list.")
  1549. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  1550. "List of TODO entry keyword sequences and their interpretation.
  1551. \\<org-mode-map>This is a list of sequences.
  1552. Each sequence starts with a symbol, either `sequence' or `type',
  1553. indicating if the keywords should be interpreted as a sequence of
  1554. action steps, or as different types of TODO items. The first
  1555. keywords are states requiring action - these states will select a headline
  1556. for inclusion into the global TODO list Org-mode produces. If one of
  1557. the \"keywords\" is the vertical bat \"|\" the remaining keywords
  1558. signify that no further action is necessary. If \"|\" is not found,
  1559. the last keyword is treated as the only DONE state of the sequence.
  1560. The command \\[org-todo] cycles an entry through these states, and one
  1561. additional state where no keyword is present. For details about this
  1562. cycling, see the manual.
  1563. TODO keywords and interpretation can also be set on a per-file basis with
  1564. the special #+SEQ_TODO and #+TYP_TODO lines.
  1565. Each keyword can optionally specify a character for fast state selection
  1566. \(in combination with the variable `org-use-fast-todo-selection')
  1567. and specifiers for state change logging, using the same syntax
  1568. that is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says
  1569. that the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
  1570. indicates to record a time stamp each time this state is selected.
  1571. Each keyword may also specify if a timestamp or a note should be
  1572. recorded when entering or leaving the state, by adding additional
  1573. characters in the parenthesis after the keyword. This looks like this:
  1574. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  1575. record only the time of the state change. With X and Y being either
  1576. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  1577. Y when leaving the state if and only if the *target* state does not
  1578. define X. You may omit any of the fast-selection key or X or /Y,
  1579. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  1580. For backward compatibility, this variable may also be just a list
  1581. of keywords - in this case the interpretation (sequence or type) will be
  1582. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  1583. :group 'org-todo
  1584. :group 'org-keywords
  1585. :type '(choice
  1586. (repeat :tag "Old syntax, just keywords"
  1587. (string :tag "Keyword"))
  1588. (repeat :tag "New syntax"
  1589. (cons
  1590. (choice
  1591. :tag "Interpretation"
  1592. ;;Quick and dirty way to see
  1593. ;;`org-todo-interpretations'. This takes the
  1594. ;;place of item arguments
  1595. :convert-widget
  1596. (lambda (widget)
  1597. (widget-put widget
  1598. :args (mapcar
  1599. #'(lambda (x)
  1600. (widget-convert
  1601. (cons 'const x)))
  1602. org-todo-interpretation-widgets))
  1603. widget))
  1604. (repeat
  1605. (string :tag "Keyword"))))))
  1606. (defvar org-todo-keywords-1 nil
  1607. "All TODO and DONE keywords active in a buffer.")
  1608. (make-variable-buffer-local 'org-todo-keywords-1)
  1609. (defvar org-todo-keywords-for-agenda nil)
  1610. (defvar org-done-keywords-for-agenda nil)
  1611. (defvar org-drawers-for-agenda nil)
  1612. (defvar org-todo-keyword-alist-for-agenda nil)
  1613. (defvar org-tag-alist-for-agenda nil)
  1614. (defvar org-agenda-contributing-files nil)
  1615. (defvar org-not-done-keywords nil)
  1616. (make-variable-buffer-local 'org-not-done-keywords)
  1617. (defvar org-done-keywords nil)
  1618. (make-variable-buffer-local 'org-done-keywords)
  1619. (defvar org-todo-heads nil)
  1620. (make-variable-buffer-local 'org-todo-heads)
  1621. (defvar org-todo-sets nil)
  1622. (make-variable-buffer-local 'org-todo-sets)
  1623. (defvar org-todo-log-states nil)
  1624. (make-variable-buffer-local 'org-todo-log-states)
  1625. (defvar org-todo-kwd-alist nil)
  1626. (make-variable-buffer-local 'org-todo-kwd-alist)
  1627. (defvar org-todo-key-alist nil)
  1628. (make-variable-buffer-local 'org-todo-key-alist)
  1629. (defvar org-todo-key-trigger nil)
  1630. (make-variable-buffer-local 'org-todo-key-trigger)
  1631. (defcustom org-todo-interpretation 'sequence
  1632. "Controls how TODO keywords are interpreted.
  1633. This variable is in principle obsolete and is only used for
  1634. backward compatibility, if the interpretation of todo keywords is
  1635. not given already in `org-todo-keywords'. See that variable for
  1636. more information."
  1637. :group 'org-todo
  1638. :group 'org-keywords
  1639. :type '(choice (const sequence)
  1640. (const type)))
  1641. (defcustom org-use-fast-todo-selection t
  1642. "Non-nil means use the fast todo selection scheme with C-c C-t.
  1643. This variable describes if and under what circumstances the cycling
  1644. mechanism for TODO keywords will be replaced by a single-key, direct
  1645. selection scheme.
  1646. When nil, fast selection is never used.
  1647. When the symbol `prefix', it will be used when `org-todo' is called with
  1648. a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
  1649. in an agenda buffer.
  1650. When t, fast selection is used by default. In this case, the prefix
  1651. argument forces cycling instead.
  1652. In all cases, the special interface is only used if access keys have actually
  1653. been assigned by the user, i.e. if keywords in the configuration are followed
  1654. by a letter in parenthesis, like TODO(t)."
  1655. :group 'org-todo
  1656. :type '(choice
  1657. (const :tag "Never" nil)
  1658. (const :tag "By default" t)
  1659. (const :tag "Only with C-u C-c C-t" prefix)))
  1660. (defcustom org-provide-todo-statistics t
  1661. "Non-nil means update todo statistics after insert and toggle.
  1662. ALL-HEADLINES means update todo statistics by including headlines
  1663. with no TODO keyword as well, counting them as not done.
  1664. A list of TODO keywords means the same, but skip keywords that are
  1665. not in this list.
  1666. When this is set, todo statistics is updated in the parent of the
  1667. current entry each time a todo state is changed."
  1668. :group 'org-todo
  1669. :type '(choice
  1670. (const :tag "Yes, only for TODO entries" t)
  1671. (const :tag "Yes, including all entries" 'all-headlines)
  1672. (repeat :tag "Yes, for TODOs in this list"
  1673. (string :tag "TODO keyword"))
  1674. (other :tag "No TODO statistics" nil)))
  1675. (defcustom org-hierarchical-todo-statistics t
  1676. "Non-nil means TODO statistics covers just direct children.
  1677. When nil, all entries in the subtree are considered.
  1678. This has only an effect if `org-provide-todo-statistics' is set.
  1679. To set this to nil for only a single subtree, use a COOKIE_DATA
  1680. property and include the word \"recursive\" into the value."
  1681. :group 'org-todo
  1682. :type 'boolean)
  1683. (defcustom org-after-todo-state-change-hook nil
  1684. "Hook which is run after the state of a TODO item was changed.
  1685. The new state (a string with a TODO keyword, or nil) is available in the
  1686. Lisp variable `state'."
  1687. :group 'org-todo
  1688. :type 'hook)
  1689. (defvar org-blocker-hook nil
  1690. "Hook for functions that are allowed to block a state change.
  1691. Each function gets as its single argument a property list, see
  1692. `org-trigger-hook' for more information about this list.
  1693. If any of the functions in this hook returns nil, the state change
  1694. is blocked.")
  1695. (defvar org-trigger-hook nil
  1696. "Hook for functions that are triggered by a state change.
  1697. Each function gets as its single argument a property list with at least
  1698. the following elements:
  1699. (:type type-of-change :position pos-at-entry-start
  1700. :from old-state :to new-state)
  1701. Depending on the type, more properties may be present.
  1702. This mechanism is currently implemented for:
  1703. TODO state changes
  1704. ------------------
  1705. :type todo-state-change
  1706. :from previous state (keyword as a string), or nil, or a symbol
  1707. 'todo' or 'done', to indicate the general type of state.
  1708. :to new state, like in :from")
  1709. (defcustom org-enforce-todo-dependencies nil
  1710. "Non-nil means undone TODO entries will block switching the parent to DONE.
  1711. Also, if a parent has an :ORDERED: property, switching an entry to DONE will
  1712. be blocked if any prior sibling is not yet done.
  1713. Finally, if the parent is blocked because of ordered siblings of its own,
  1714. the child will also be blocked.
  1715. This variable needs to be set before org.el is loaded, and you need to
  1716. restart Emacs after a change to make the change effective. The only way
  1717. to change is while Emacs is running is through the customize interface."
  1718. :set (lambda (var val)
  1719. (set var val)
  1720. (if val
  1721. (add-hook 'org-blocker-hook
  1722. 'org-block-todo-from-children-or-siblings-or-parent)
  1723. (remove-hook 'org-blocker-hook
  1724. 'org-block-todo-from-children-or-siblings-or-parent)))
  1725. :group 'org-todo
  1726. :type 'boolean)
  1727. (defcustom org-enforce-todo-checkbox-dependencies nil
  1728. "Non-nil means unchecked boxes will block switching the parent to DONE.
  1729. When this is nil, checkboxes have no influence on switching TODO states.
  1730. When non-nil, you first need to check off all check boxes before the TODO
  1731. entry can be switched to DONE.
  1732. This variable needs to be set before org.el is loaded, and you need to
  1733. restart Emacs after a change to make the change effective. The only way
  1734. to change is while Emacs is running is through the customize interface."
  1735. :set (lambda (var val)
  1736. (set var val)
  1737. (if val
  1738. (add-hook 'org-blocker-hook
  1739. 'org-block-todo-from-checkboxes)
  1740. (remove-hook 'org-blocker-hook
  1741. 'org-block-todo-from-checkboxes)))
  1742. :group 'org-todo
  1743. :type 'boolean)
  1744. (defcustom org-treat-insert-todo-heading-as-state-change nil
  1745. "Non-nil means inserting a TODO heading is treated as state change.
  1746. So when the command \\[org-insert-todo-heading] is used, state change
  1747. logging will apply if appropriate. When nil, the new TODO item will
  1748. be inserted directly, and no logging will take place."
  1749. :group 'org-todo
  1750. :type 'boolean)
  1751. (defcustom org-treat-S-cursor-todo-selection-as-state-change t
  1752. "Non-nil means switching TODO states with S-cursor counts as state change.
  1753. This is the default behavior. However, setting this to nil allows a
  1754. convenient way to select a TODO state and bypass any logging associated
  1755. with that."
  1756. :group 'org-todo
  1757. :type 'boolean)
  1758. (defcustom org-todo-state-tags-triggers nil
  1759. "Tag changes that should be triggered by TODO state changes.
  1760. This is a list. Each entry is
  1761. (state-change (tag . flag) .......)
  1762. State-change can be a string with a state, and empty string to indicate the
  1763. state that has no TODO keyword, or it can be one of the symbols `todo'
  1764. or `done', meaning any not-done or done state, respectively."
  1765. :group 'org-todo
  1766. :group 'org-tags
  1767. :type '(repeat
  1768. (cons (choice :tag "When changing to"
  1769. (const :tag "Not-done state" todo)
  1770. (const :tag "Done state" done)
  1771. (string :tag "State"))
  1772. (repeat
  1773. (cons :tag "Tag action"
  1774. (string :tag "Tag")
  1775. (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
  1776. (defcustom org-log-done nil
  1777. "Information to record when a task moves to the DONE state.
  1778. Possible values are:
  1779. nil Don't add anything, just change the keyword
  1780. time Add a time stamp to the task
  1781. note Prompt for a note and add it with template `org-log-note-headings'
  1782. This option can also be set with on a per-file-basis with
  1783. #+STARTUP: nologdone
  1784. #+STARTUP: logdone
  1785. #+STARTUP: lognotedone
  1786. You can have local logging settings for a subtree by setting the LOGGING
  1787. property to one or more of these keywords."
  1788. :group 'org-todo
  1789. :group 'org-progress
  1790. :type '(choice
  1791. (const :tag "No logging" nil)
  1792. (const :tag "Record CLOSED timestamp" time)
  1793. (const :tag "Record CLOSED timestamp with note." note)))
  1794. ;; Normalize old uses of org-log-done.
  1795. (cond
  1796. ((eq org-log-done t) (setq org-log-done 'time))
  1797. ((and (listp org-log-done) (memq 'done org-log-done))
  1798. (setq org-log-done 'note)))
  1799. (defcustom org-log-reschedule nil
  1800. "Information to record when the scheduling date of a tasks is modified.
  1801. Possible values are:
  1802. nil Don't add anything, just change the date
  1803. time Add a time stamp to the task
  1804. note Prompt for a note and add it with template `org-log-note-headings'
  1805. This option can also be set with on a per-file-basis with
  1806. #+STARTUP: nologreschedule
  1807. #+STARTUP: logreschedule
  1808. #+STARTUP: lognotereschedule"
  1809. :group 'org-todo
  1810. :group 'org-progress
  1811. :type '(choice
  1812. (const :tag "No logging" nil)
  1813. (const :tag "Record timestamp" time)
  1814. (const :tag "Record timestamp with note." note)))
  1815. (defcustom org-log-redeadline nil
  1816. "Information to record when the deadline date of a tasks is modified.
  1817. Possible values are:
  1818. nil Don't add anything, just change the date
  1819. time Add a time stamp to the task
  1820. note Prompt for a note and add it with template `org-log-note-headings'
  1821. This option can also be set with on a per-file-basis with
  1822. #+STARTUP: nologredeadline
  1823. #+STARTUP: logredeadline
  1824. #+STARTUP: lognoteredeadline
  1825. You can have local logging settings for a subtree by setting the LOGGING
  1826. property to one or more of these keywords."
  1827. :group 'org-todo
  1828. :group 'org-progress
  1829. :type '(choice
  1830. (const :tag "No logging" nil)
  1831. (const :tag "Record timestamp" time)
  1832. (const :tag "Record timestamp with note." note)))
  1833. (defcustom org-log-note-clock-out nil
  1834. "Non-nil means record a note when clocking out of an item.
  1835. This can also be configured on a per-file basis by adding one of
  1836. the following lines anywhere in the buffer:
  1837. #+STARTUP: lognoteclock-out
  1838. #+STARTUP: nolognoteclock-out"
  1839. :group 'org-todo
  1840. :group 'org-progress
  1841. :type 'boolean)
  1842. (defcustom org-log-done-with-time t
  1843. "Non-nil means the CLOSED time stamp will contain date and time.
  1844. When nil, only the date will be recorded."
  1845. :group 'org-progress
  1846. :type 'boolean)
  1847. (defcustom org-log-note-headings
  1848. '((done . "CLOSING NOTE %t")
  1849. (state . "State %-12s from %-12S %t")
  1850. (note . "Note taken on %t")
  1851. (reschedule . "Rescheduled from %S on %t")
  1852. (delschedule . "Not scheduled, was %S on %t")
  1853. (redeadline . "New deadline from %S on %t")
  1854. (deldeadline . "Removed deadline, was %S on %t")
  1855. (refile . "Refiled on %t")
  1856. (clock-out . ""))
  1857. "Headings for notes added to entries.
  1858. The value is an alist, with the car being a symbol indicating the note
  1859. context, and the cdr is the heading to be used. The heading may also be the
  1860. empty string.
  1861. %t in the heading will be replaced by a time stamp.
  1862. %s will be replaced by the new TODO state, in double quotes.
  1863. %S will be replaced by the old TODO state, in double quotes.
  1864. %u will be replaced by the user name.
  1865. %U will be replaced by the full user name.
  1866. In fact, it is not a good idea to change the `state' entry, because
  1867. agenda log mode depends on the format of these entries."
  1868. :group 'org-todo
  1869. :group 'org-progress
  1870. :type '(list :greedy t
  1871. (cons (const :tag "Heading when closing an item" done) string)
  1872. (cons (const :tag
  1873. "Heading when changing todo state (todo sequence only)"
  1874. state) string)
  1875. (cons (const :tag "Heading when just taking a note" note) string)
  1876. (cons (const :tag "Heading when clocking out" clock-out) string)
  1877. (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
  1878. (cons (const :tag "Heading when rescheduling" reschedule) string)
  1879. (cons (const :tag "Heading when changing deadline" redeadline) string)
  1880. (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
  1881. (cons (const :tag "Heading when refiling" refile) string)))
  1882. (unless (assq 'note org-log-note-headings)
  1883. (push '(note . "%t") org-log-note-headings))
  1884. (defcustom org-log-into-drawer nil
  1885. "Non-nil means insert state change notes and time stamps into a drawer.
  1886. When nil, state changes notes will be inserted after the headline and
  1887. any scheduling and clock lines, but not inside a drawer.
  1888. The value of this variable should be the name of the drawer to use.
  1889. LOGBOOK is proposed at the default drawer for this purpose, you can
  1890. also set this to a string to define the drawer of your choice.
  1891. A value of t is also allowed, representing \"LOGBOOK\".
  1892. If this variable is set, `org-log-state-notes-insert-after-drawers'
  1893. will be ignored.
  1894. You can set the property LOG_INTO_DRAWER to overrule this setting for
  1895. a subtree."
  1896. :group 'org-todo
  1897. :group 'org-progress
  1898. :type '(choice
  1899. (const :tag "Not into a drawer" nil)
  1900. (const :tag "LOGBOOK" t)
  1901. (string :tag "Other")))
  1902. (if (fboundp 'defvaralias)
  1903. (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer))
  1904. (defun org-log-into-drawer ()
  1905. "Return the value of `org-log-into-drawer', but let properties overrule.
  1906. If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
  1907. used instead of the default value."
  1908. (let ((p (ignore-errors (org-entry-get nil "LOG_INTO_DRAWER" 'inherit))))
  1909. (cond
  1910. ((or (not p) (equal p "nil")) org-log-into-drawer)
  1911. ((equal p "t") "LOGBOOK")
  1912. (t p))))
  1913. (defcustom org-log-state-notes-insert-after-drawers nil
  1914. "Non-nil means insert state change notes after any drawers in entry.
  1915. Only the drawers that *immediately* follow the headline and the
  1916. deadline/scheduled line are skipped.
  1917. When nil, insert notes right after the heading and perhaps the line
  1918. with deadline/scheduling if present.
  1919. This variable will have no effect if `org-log-into-drawer' is
  1920. set."
  1921. :group 'org-todo
  1922. :group 'org-progress
  1923. :type 'boolean)
  1924. (defcustom org-log-states-order-reversed t
  1925. "Non-nil means the latest state note will be directly after heading.
  1926. When nil, the state change notes will be ordered according to time."
  1927. :group 'org-todo
  1928. :group 'org-progress
  1929. :type 'boolean)
  1930. (defcustom org-todo-repeat-to-state nil
  1931. "The TODO state to which a repeater should return the repeating task.
  1932. By default this is the first task in a TODO sequence, or the previous state
  1933. in a TODO_TYP set. But you can specify another task here.
  1934. alternatively, set the :REPEAT_TO_STATE: property of the entry."
  1935. :group 'org-todo
  1936. :type '(choice (const :tag "Head of sequence" nil)
  1937. (string :tag "Specific state")))
  1938. (defcustom org-log-repeat 'time
  1939. "Non-nil means record moving through the DONE state when triggering repeat.
  1940. An auto-repeating task is immediately switched back to TODO when
  1941. marked DONE. If you are not logging state changes (by adding \"@\"
  1942. or \"!\" to the TODO keyword definition), or set `org-log-done' to
  1943. record a closing note, there will be no record of the task moving
  1944. through DONE. This variable forces taking a note anyway.
  1945. nil Don't force a record
  1946. time Record a time stamp
  1947. note Record a note
  1948. This option can also be set with on a per-file-basis with
  1949. #+STARTUP: logrepeat
  1950. #+STARTUP: lognoterepeat
  1951. #+STARTUP: nologrepeat
  1952. You can have local logging settings for a subtree by setting the LOGGING
  1953. property to one or more of these keywords."
  1954. :group 'org-todo
  1955. :group 'org-progress
  1956. :type '(choice
  1957. (const :tag "Don't force a record" nil)
  1958. (const :tag "Force recording the DONE state" time)
  1959. (const :tag "Force recording a note with the DONE state" note)))
  1960. (defgroup org-priorities nil
  1961. "Priorities in Org-mode."
  1962. :tag "Org Priorities"
  1963. :group 'org-todo)
  1964. (defcustom org-enable-priority-commands t
  1965. "Non-nil means priority commands are active.
  1966. When nil, these commands will be disabled, so that you never accidentally
  1967. set a priority."
  1968. :group 'org-priorities
  1969. :type 'boolean)
  1970. (defcustom org-highest-priority ?A
  1971. "The highest priority of TODO items. A character like ?A, ?B etc.
  1972. Must have a smaller ASCII number than `org-lowest-priority'."
  1973. :group 'org-priorities
  1974. :type 'character)
  1975. (defcustom org-lowest-priority ?C
  1976. "The lowest priority of TODO items. A character like ?A, ?B etc.
  1977. Must have a larger ASCII number than `org-highest-priority'."
  1978. :group 'org-priorities
  1979. :type 'character)
  1980. (defcustom org-default-priority ?B
  1981. "The default priority of TODO items.
  1982. This is the priority an item get if no explicit priority is given."
  1983. :group 'org-priorities
  1984. :type 'character)
  1985. (defcustom org-priority-start-cycle-with-default t
  1986. "Non-nil means start with default priority when starting to cycle.
  1987. When this is nil, the first step in the cycle will be (depending on the
  1988. command used) one higher or lower that the default priority."
  1989. :group 'org-priorities
  1990. :type 'boolean)
  1991. (defgroup org-time nil
  1992. "Options concerning time stamps and deadlines in Org-mode."
  1993. :tag "Org Time"
  1994. :group 'org)
  1995. (defcustom org-insert-labeled-timestamps-at-point nil
  1996. "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
  1997. When nil, these labeled time stamps are forces into the second line of an
  1998. entry, just after the headline. When scheduling from the global TODO list,
  1999. the time stamp will always be forced into the second line."
  2000. :group 'org-time
  2001. :type 'boolean)
  2002. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  2003. "Formats for `format-time-string' which are used for time stamps.
  2004. It is not recommended to change this constant.")
  2005. (defcustom org-time-stamp-rounding-minutes '(0 5)
  2006. "Number of minutes to round time stamps to.
  2007. These are two values, the first applies when first creating a time stamp.
  2008. The second applies when changing it with the commands `S-up' and `S-down'.
  2009. When changing the time stamp, this means that it will change in steps
  2010. of N minutes, as given by the second value.
  2011. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  2012. numbers should be factors of 60, so for example 5, 10, 15.
  2013. When this is larger than 1, you can still force an exact time-stamp by using
  2014. a double prefix argument to a time-stamp command like `C-c .' or `C-c !',
  2015. and by using a prefix arg to `S-up/down' to specify the exact number
  2016. of minutes to shift."
  2017. :group 'org-time
  2018. :get '(lambda (var) ; Make sure both elements are there
  2019. (if (integerp (default-value var))
  2020. (list (default-value var) 5)
  2021. (default-value var)))
  2022. :type '(list
  2023. (integer :tag "when inserting times")
  2024. (integer :tag "when modifying times")))
  2025. ;; Normalize old customizations of this variable.
  2026. (when (integerp org-time-stamp-rounding-minutes)
  2027. (setq org-time-stamp-rounding-minutes
  2028. (list org-time-stamp-rounding-minutes
  2029. org-time-stamp-rounding-minutes)))
  2030. (defcustom org-display-custom-times nil
  2031. "Non-nil means overlay custom formats over all time stamps.
  2032. The formats are defined through the variable `org-time-stamp-custom-formats'.
  2033. To turn this on on a per-file basis, insert anywhere in the file:
  2034. #+STARTUP: customtime"
  2035. :group 'org-time
  2036. :set 'set-default
  2037. :type 'sexp)
  2038. (make-variable-buffer-local 'org-display-custom-times)
  2039. (defcustom org-time-stamp-custom-formats
  2040. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  2041. "Custom formats for time stamps. See `format-time-string' for the syntax.
  2042. These are overlayed over the default ISO format if the variable
  2043. `org-display-custom-times' is set. Time like %H:%M should be at the
  2044. end of the second format. The custom formats are also honored by export
  2045. commands, if custom time display is turned on at the time of export."
  2046. :group 'org-time
  2047. :type 'sexp)
  2048. (defun org-time-stamp-format (&optional long inactive)
  2049. "Get the right format for a time string."
  2050. (let ((f (if long (cdr org-time-stamp-formats)
  2051. (car org-time-stamp-formats))))
  2052. (if inactive
  2053. (concat "[" (substring f 1 -1) "]")
  2054. f)))
  2055. (defcustom org-time-clocksum-format "%d:%02d"
  2056. "The format string used when creating CLOCKSUM lines, or when
  2057. org-mode generates a time duration."
  2058. :group 'org-time
  2059. :type 'string)
  2060. (defcustom org-time-clocksum-use-fractional nil
  2061. "If non-nil, \\[org-clock-display] uses fractional times.
  2062. org-mode generates a time duration."
  2063. :group 'org-time
  2064. :type 'boolean)
  2065. (defcustom org-time-clocksum-fractional-format "%.2f"
  2066. "The format string used when creating CLOCKSUM lines, or when
  2067. org-mode generates a time duration."
  2068. :group 'org-time
  2069. :type 'string)
  2070. (defcustom org-deadline-warning-days 14
  2071. "No. of days before expiration during which a deadline becomes active.
  2072. This variable governs the display in sparse trees and in the agenda.
  2073. When 0 or negative, it means use this number (the absolute value of it)
  2074. even if a deadline has a different individual lead time specified.
  2075. Custom commands can set this variable in the options section."
  2076. :group 'org-time
  2077. :group 'org-agenda-daily/weekly
  2078. :type 'integer)
  2079. (defcustom org-read-date-prefer-future t
  2080. "Non-nil means assume future for incomplete date input from user.
  2081. This affects the following situations:
  2082. 1. The user gives a month but not a year.
  2083. For example, if it is april and you enter \"feb 2\", this will be read
  2084. as feb 2, *next* year. \"May 5\", however, will be this year.
  2085. 2. The user gives a day, but no month.
  2086. For example, if today is the 15th, and you enter \"3\", Org-mode will
  2087. read this as the third of *next* month. However, if you enter \"17\",
  2088. it will be considered as *this* month.
  2089. If you set this variable to the symbol `time', then also the following
  2090. will work:
  2091. 3. If the user gives a time, but no day. If the time is before now,
  2092. to will be interpreted as tomorrow.
  2093. Currently none of this works for ISO week specifications.
  2094. When this option is nil, the current day, month and year will always be
  2095. used as defaults."
  2096. :group 'org-time
  2097. :type '(choice
  2098. (const :tag "Never" nil)
  2099. (const :tag "Check month and day" t)
  2100. (const :tag "Check month, day, and time" time)))
  2101. (defcustom org-read-date-display-live t
  2102. "Non-nil means display current interpretation of date prompt live.
  2103. This display will be in an overlay, in the minibuffer."
  2104. :group 'org-time
  2105. :type 'boolean)
  2106. (defcustom org-read-date-popup-calendar t
  2107. "Non-nil means pop up a calendar when prompting for a date.
  2108. In the calendar, the date can be selected with mouse-1. However, the
  2109. minibuffer will also be active, and you can simply enter the date as well.
  2110. When nil, only the minibuffer will be available."
  2111. :group 'org-time
  2112. :type 'boolean)
  2113. (if (fboundp 'defvaralias)
  2114. (defvaralias 'org-popup-calendar-for-date-prompt
  2115. 'org-read-date-popup-calendar))
  2116. (defcustom org-read-date-minibuffer-setup-hook nil
  2117. "Hook to be used to set up keys for the date/time interface.
  2118. Add key definitions to `minibuffer-local-map', which will be a temporary
  2119. copy."
  2120. :group 'org-time
  2121. :type 'hook)
  2122. (defcustom org-extend-today-until 0
  2123. "The hour when your day really ends. Must be an integer.
  2124. This has influence for the following applications:
  2125. - When switching the agenda to \"today\". It it is still earlier than
  2126. the time given here, the day recognized as TODAY is actually yesterday.
  2127. - When a date is read from the user and it is still before the time given
  2128. here, the current date and time will be assumed to be yesterday, 23:59.
  2129. Also, timestamps inserted in remember templates follow this rule.
  2130. IMPORTANT: This is a feature whose implementation is and likely will
  2131. remain incomplete. Really, it is only here because past midnight seems to
  2132. be the favorite working time of John Wiegley :-)"
  2133. :group 'org-time
  2134. :type 'integer)
  2135. (defcustom org-edit-timestamp-down-means-later nil
  2136. "Non-nil means S-down will increase the time in a time stamp.
  2137. When nil, S-up will increase."
  2138. :group 'org-time
  2139. :type 'boolean)
  2140. (defcustom org-calendar-follow-timestamp-change t
  2141. "Non-nil means make the calendar window follow timestamp changes.
  2142. When a timestamp is modified and the calendar window is visible, it will be
  2143. moved to the new date."
  2144. :group 'org-time
  2145. :type 'boolean)
  2146. (defgroup org-tags nil
  2147. "Options concerning tags in Org-mode."
  2148. :tag "Org Tags"
  2149. :group 'org)
  2150. (defcustom org-tag-alist nil
  2151. "List of tags allowed in Org-mode files.
  2152. When this list is nil, Org-mode will base TAG input on what is already in the
  2153. buffer.
  2154. The value of this variable is an alist, the car of each entry must be a
  2155. keyword as a string, the cdr may be a character that is used to select
  2156. that tag through the fast-tag-selection interface.
  2157. See the manual for details."
  2158. :group 'org-tags
  2159. :type '(repeat
  2160. (choice
  2161. (cons (string :tag "Tag name")
  2162. (character :tag "Access char"))
  2163. (list :tag "Start radio group"
  2164. (const :startgroup)
  2165. (option (string :tag "Group description")))
  2166. (list :tag "End radio group"
  2167. (const :endgroup)
  2168. (option (string :tag "Group description")))
  2169. (const :tag "New line" (:newline)))))
  2170. (defcustom org-tag-persistent-alist nil
  2171. "List of tags that will always appear in all Org-mode files.
  2172. This is in addition to any in buffer settings or customizations
  2173. of `org-tag-alist'.
  2174. When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
  2175. The value of this variable is an alist, the car of each entry must be a
  2176. keyword as a string, the cdr may be a character that is used to select
  2177. that tag through the fast-tag-selection interface.
  2178. See the manual for details.
  2179. To disable these tags on a per-file basis, insert anywhere in the file:
  2180. #+STARTUP: noptag"
  2181. :group 'org-tags
  2182. :type '(repeat
  2183. (choice
  2184. (cons (string :tag "Tag name")
  2185. (character :tag "Access char"))
  2186. (const :tag "Start radio group" (:startgroup))
  2187. (const :tag "End radio group" (:endgroup))
  2188. (const :tag "New line" (:newline)))))
  2189. (defcustom org-complete-tags-always-offer-all-agenda-tags nil
  2190. "If non-nil, always offer completion for all tags of all agenda files.
  2191. Instead of customizing this variable directly, you might want to
  2192. set it locally for remember buffers, because there no list of
  2193. tags in that file can be created dynamically (there are none).
  2194. (add-hook 'org-remember-mode-hook
  2195. (lambda ()
  2196. (set (make-local-variable
  2197. 'org-complete-tags-always-offer-all-agenda-tags)
  2198. t)))"
  2199. :group 'org-tags
  2200. :type 'boolean)
  2201. (defvar org-file-tags nil
  2202. "List of tags that can be inherited by all entries in the file.
  2203. The tags will be inherited if the variable `org-use-tag-inheritance'
  2204. says they should be.
  2205. This variable is populated from #+FILETAGS lines.")
  2206. (defcustom org-use-fast-tag-selection 'auto
  2207. "Non-nil means use fast tag selection scheme.
  2208. This is a special interface to select and deselect tags with single keys.
  2209. When nil, fast selection is never used.
  2210. When the symbol `auto', fast selection is used if and only if selection
  2211. characters for tags have been configured, either through the variable
  2212. `org-tag-alist' or through a #+TAGS line in the buffer.
  2213. When t, fast selection is always used and selection keys are assigned
  2214. automatically if necessary."
  2215. :group 'org-tags
  2216. :type '(choice
  2217. (const :tag "Always" t)
  2218. (const :tag "Never" nil)
  2219. (const :tag "When selection characters are configured" 'auto)))
  2220. (defcustom org-fast-tag-selection-single-key nil
  2221. "Non-nil means fast tag selection exits after first change.
  2222. When nil, you have to press RET to exit it.
  2223. During fast tag selection, you can toggle this flag with `C-c'.
  2224. This variable can also have the value `expert'. In this case, the window
  2225. displaying the tags menu is not even shown, until you press C-c again."
  2226. :group 'org-tags
  2227. :type '(choice
  2228. (const :tag "No" nil)
  2229. (const :tag "Yes" t)
  2230. (const :tag "Expert" expert)))
  2231. (defvar org-fast-tag-selection-include-todo nil
  2232. "Non-nil means fast tags selection interface will also offer TODO states.
  2233. This is an undocumented feature, you should not rely on it.")
  2234. (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
  2235. "The column to which tags should be indented in a headline.
  2236. If this number is positive, it specifies the column. If it is negative,
  2237. it means that the tags should be flushright to that column. For example,
  2238. -80 works well for a normal 80 character screen."
  2239. :group 'org-tags
  2240. :type 'integer)
  2241. (defcustom org-auto-align-tags t
  2242. "Non-nil means realign tags after pro/demotion of TODO state change.
  2243. These operations change the length of a headline and therefore shift
  2244. the tags around. With this options turned on, after each such operation
  2245. the tags are again aligned to `org-tags-column'."
  2246. :group 'org-tags
  2247. :type 'boolean)
  2248. (defcustom org-use-tag-inheritance t
  2249. "Non-nil means tags in levels apply also for sublevels.
  2250. When nil, only the tags directly given in a specific line apply there.
  2251. This may also be a list of tags that should be inherited, or a regexp that
  2252. matches tags that should be inherited. Additional control is possible
  2253. with the variable `org-tags-exclude-from-inheritance' which gives an
  2254. explicit list of tags to be excluded from inheritance., even if the value of
  2255. `org-use-tag-inheritance' would select it for inheritance.
  2256. If this option is t, a match early-on in a tree can lead to a large
  2257. number of matches in the subtree when constructing the agenda or creating
  2258. a sparse tree. If you only want to see the first match in a tree during
  2259. a search, check out the variable `org-tags-match-list-sublevels'."
  2260. :group 'org-tags
  2261. :type '(choice
  2262. (const :tag "Not" nil)
  2263. (const :tag "Always" t)
  2264. (repeat :tag "Specific tags" (string :tag "Tag"))
  2265. (regexp :tag "Tags matched by regexp")))
  2266. (defcustom org-tags-exclude-from-inheritance nil
  2267. "List of tags that should never be inherited.
  2268. This is a way to exclude a few tags from inheritance. For way to do
  2269. the opposite, to actively allow inheritance for selected tags,
  2270. see the variable `org-use-tag-inheritance'."
  2271. :group 'org-tags
  2272. :type '(repeat (string :tag "Tag")))
  2273. (defun org-tag-inherit-p (tag)
  2274. "Check if TAG is one that should be inherited."
  2275. (cond
  2276. ((member tag org-tags-exclude-from-inheritance) nil)
  2277. ((eq org-use-tag-inheritance t) t)
  2278. ((not org-use-tag-inheritance) nil)
  2279. ((stringp org-use-tag-inheritance)
  2280. (string-match org-use-tag-inheritance tag))
  2281. ((listp org-use-tag-inheritance)
  2282. (member tag org-use-tag-inheritance))
  2283. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  2284. (defcustom org-tags-match-list-sublevels t
  2285. "Non-nil means list also sublevels of headlines matching a search.
  2286. This variable applies to tags/property searches, and also to stuck
  2287. projects because this search is based on a tags match as well.
  2288. When set to the symbol `indented', sublevels are indented with
  2289. leading dots.
  2290. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  2291. the sublevels of a headline matching a tag search often also match
  2292. the same search. Listing all of them can create very long lists.
  2293. Setting this variable to nil causes subtrees of a match to be skipped.
  2294. This variable is semi-obsolete and probably should always be true. It
  2295. is better to limit inheritance to certain tags using the variables
  2296. `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
  2297. :group 'org-tags
  2298. :type '(choice
  2299. (const :tag "No, don't list them" nil)
  2300. (const :tag "Yes, do list them" t)
  2301. (const :tag "List them, indented with leading dots" indented)))
  2302. (defcustom org-tags-sort-function nil
  2303. "When set, tags are sorted using this function as a comparator"
  2304. :group 'org-tags
  2305. :type '(choice
  2306. (const :tag "No sorting" nil)
  2307. (const :tag "Alphabetical" string<)
  2308. (const :tag "Reverse alphabetical" string>)
  2309. (function :tag "Custom function" nil)))
  2310. (defvar org-tags-history nil
  2311. "History of minibuffer reads for tags.")
  2312. (defvar org-last-tags-completion-table nil
  2313. "The last used completion table for tags.")
  2314. (defvar org-after-tags-change-hook nil
  2315. "Hook that is run after the tags in a line have changed.")
  2316. (defgroup org-properties nil
  2317. "Options concerning properties in Org-mode."
  2318. :tag "Org Properties"
  2319. :group 'org)
  2320. (defcustom org-property-format "%-10s %s"
  2321. "How property key/value pairs should be formatted by `indent-line'.
  2322. When `indent-line' hits a property definition, it will format the line
  2323. according to this format, mainly to make sure that the values are
  2324. lined-up with respect to each other."
  2325. :group 'org-properties
  2326. :type 'string)
  2327. (defcustom org-use-property-inheritance nil
  2328. "Non-nil means properties apply also for sublevels.
  2329. This setting is chiefly used during property searches. Turning it on can
  2330. cause significant overhead when doing a search, which is why it is not
  2331. on by default.
  2332. When nil, only the properties directly given in the current entry count.
  2333. When t, every property is inherited. The value may also be a list of
  2334. properties that should have inheritance, or a regular expression matching
  2335. properties that should be inherited.
  2336. However, note that some special properties use inheritance under special
  2337. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  2338. and the properties ending in \"_ALL\" when they are used as descriptor
  2339. for valid values of a property.
  2340. Note for programmers:
  2341. When querying an entry with `org-entry-get', you can control if inheritance
  2342. should be used. By default, `org-entry-get' looks only at the local
  2343. properties. You can request inheritance by setting the inherit argument
  2344. to t (to force inheritance) or to `selective' (to respect the setting
  2345. in this variable)."
  2346. :group 'org-properties
  2347. :type '(choice
  2348. (const :tag "Not" nil)
  2349. (const :tag "Always" t)
  2350. (repeat :tag "Specific properties" (string :tag "Property"))
  2351. (regexp :tag "Properties matched by regexp")))
  2352. (defun org-property-inherit-p (property)
  2353. "Check if PROPERTY is one that should be inherited."
  2354. (cond
  2355. ((eq org-use-property-inheritance t) t)
  2356. ((not org-use-property-inheritance) nil)
  2357. ((stringp org-use-property-inheritance)
  2358. (string-match org-use-property-inheritance property))
  2359. ((listp org-use-property-inheritance)
  2360. (member property org-use-property-inheritance))
  2361. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  2362. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  2363. "The default column format, if no other format has been defined.
  2364. This variable can be set on the per-file basis by inserting a line
  2365. #+COLUMNS: %25ITEM ....."
  2366. :group 'org-properties
  2367. :type 'string)
  2368. (defcustom org-columns-ellipses ".."
  2369. "The ellipses to be used when a field in column view is truncated.
  2370. When this is the empty string, as many characters as possible are shown,
  2371. but then there will be no visual indication that the field has been truncated.
  2372. When this is a string of length N, the last N characters of a truncated
  2373. field are replaced by this string. If the column is narrower than the
  2374. ellipses string, only part of the ellipses string will be shown."
  2375. :group 'org-properties
  2376. :type 'string)
  2377. (defcustom org-columns-modify-value-for-display-function nil
  2378. "Function that modifies values for display in column view.
  2379. For example, it can be used to cut out a certain part from a time stamp.
  2380. The function must take 2 arguments:
  2381. column-title The title of the column (*not* the property name)
  2382. value The value that should be modified.
  2383. The function should return the value that should be displayed,
  2384. or nil if the normal value should be used."
  2385. :group 'org-properties
  2386. :type 'function)
  2387. (defcustom org-effort-property "Effort"
  2388. "The property that is being used to keep track of effort estimates.
  2389. Effort estimates given in this property need to have the format H:MM."
  2390. :group 'org-properties
  2391. :group 'org-progress
  2392. :type '(string :tag "Property"))
  2393. (defconst org-global-properties-fixed
  2394. '(("VISIBILITY_ALL" . "folded children content all")
  2395. ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
  2396. "List of property/value pairs that can be inherited by any entry.
  2397. These are fixed values, for the preset properties. The user variable
  2398. that can be used to add to this list is `org-global-properties'.
  2399. The entries in this list are cons cells where the car is a property
  2400. name and cdr is a string with the value. If the value represents
  2401. multiple items like an \"_ALL\" property, separate the items by
  2402. spaces.")
  2403. (defcustom org-global-properties nil
  2404. "List of property/value pairs that can be inherited by any entry.
  2405. This list will be combined with the constant `org-global-properties-fixed'.
  2406. The entries in this list are cons cells where the car is a property
  2407. name and cdr is a string with the value.
  2408. You can set buffer-local values for the same purpose in the variable
  2409. `org-file-properties' this by adding lines like
  2410. #+PROPERTY: NAME VALUE"
  2411. :group 'org-properties
  2412. :type '(repeat
  2413. (cons (string :tag "Property")
  2414. (string :tag "Value"))))
  2415. (defvar org-file-properties nil
  2416. "List of property/value pairs that can be inherited by any entry.
  2417. Valid for the current buffer.
  2418. This variable is populated from #+PROPERTY lines.")
  2419. (make-variable-buffer-local 'org-file-properties)
  2420. (defgroup org-agenda nil
  2421. "Options concerning agenda views in Org-mode."
  2422. :tag "Org Agenda"
  2423. :group 'org)
  2424. (defvar org-category nil
  2425. "Variable used by org files to set a category for agenda display.
  2426. Such files should use a file variable to set it, for example
  2427. # -*- mode: org; org-category: \"ELisp\"
  2428. or contain a special line
  2429. #+CATEGORY: ELisp
  2430. If the file does not specify a category, then file's base name
  2431. is used instead.")
  2432. (make-variable-buffer-local 'org-category)
  2433. (put 'org-category 'safe-local-variable '(lambda (x) (or (symbolp x) (stringp x))))
  2434. (defcustom org-agenda-files nil
  2435. "The files to be used for agenda display.
  2436. Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
  2437. \\[org-remove-file]. You can also use customize to edit the list.
  2438. If an entry is a directory, all files in that directory that are matched by
  2439. `org-agenda-file-regexp' will be part of the file list.
  2440. If the value of the variable is not a list but a single file name, then
  2441. the list of agenda files is actually stored and maintained in that file, one
  2442. agenda file per line. In this file paths can be given relative to
  2443. `org-directory'. Tilde expansion and environment variable substitution
  2444. are also made."
  2445. :group 'org-agenda
  2446. :type '(choice
  2447. (repeat :tag "List of files and directories" file)
  2448. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  2449. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  2450. "Regular expression to match files for `org-agenda-files'.
  2451. If any element in the list in that variable contains a directory instead
  2452. of a normal file, all files in that directory that are matched by this
  2453. regular expression will be included."
  2454. :group 'org-agenda
  2455. :type 'regexp)
  2456. (defcustom org-agenda-text-search-extra-files nil
  2457. "List of extra files to be searched by text search commands.
  2458. These files will be search in addition to the agenda files by the
  2459. commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
  2460. Note that these files will only be searched for text search commands,
  2461. not for the other agenda views like todo lists, tag searches or the weekly
  2462. agenda. This variable is intended to list notes and possibly archive files
  2463. that should also be searched by these two commands.
  2464. In fact, if the first element in the list is the symbol `agenda-archives',
  2465. than all archive files of all agenda files will be added to the search
  2466. scope."
  2467. :group 'org-agenda
  2468. :type '(set :greedy t
  2469. (const :tag "Agenda Archives" agenda-archives)
  2470. (repeat :inline t (file))))
  2471. (if (fboundp 'defvaralias)
  2472. (defvaralias 'org-agenda-multi-occur-extra-files
  2473. 'org-agenda-text-search-extra-files))
  2474. (defcustom org-agenda-skip-unavailable-files nil
  2475. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  2476. A nil value means to remove them, after a query, from the list."
  2477. :group 'org-agenda
  2478. :type 'boolean)
  2479. (defcustom org-calendar-to-agenda-key [?c]
  2480. "The key to be installed in `calendar-mode-map' for switching to the agenda.
  2481. The command `org-calendar-goto-agenda' will be bound to this key. The
  2482. default is the character `c' because then `c' can be used to switch back and
  2483. forth between agenda and calendar."
  2484. :group 'org-agenda
  2485. :type 'sexp)
  2486. (defcustom org-calendar-agenda-action-key [?k]
  2487. "The key to be installed in `calendar-mode-map' for agenda-action.
  2488. The command `org-agenda-action' will be bound to this key. The
  2489. default is the character `k' because we use the same key in the agenda."
  2490. :group 'org-agenda
  2491. :type 'sexp)
  2492. (defcustom org-calendar-insert-diary-entry-key [?i]
  2493. "The key to be installed in `calendar-mode-map' for adding diary entries.
  2494. This option is irrelevant until `org-agenda-diary-file' has been configured
  2495. to point to an Org-mode file. When that is the case, the command
  2496. `org-agenda-diary-entry' will be bound to the key given here, by default
  2497. `i'. In the calendar, `i' normally adds entries to `diary-file'. So
  2498. if you want to continue doing this, you need to change this to a different
  2499. key."
  2500. :group 'org-agenda
  2501. :type 'sexp)
  2502. (defcustom org-agenda-diary-file 'diary-file
  2503. "File to which to add new entries with the `i' key in agenda and calendar.
  2504. When this is the symbol `diary-file', the functionality in the Emacs
  2505. calendar will be used to add entries to the `diary-file'. But when this
  2506. points to a file, `org-agenda-diary-entry' will be used instead."
  2507. :group 'org-agenda
  2508. :type '(choice
  2509. (const :tag "The standard Emacs diary file" diary-file)
  2510. (file :tag "Special Org file diary entries")))
  2511. (eval-after-load "calendar"
  2512. '(progn
  2513. (org-defkey calendar-mode-map org-calendar-to-agenda-key
  2514. 'org-calendar-goto-agenda)
  2515. (org-defkey calendar-mode-map org-calendar-agenda-action-key
  2516. 'org-agenda-action)
  2517. (add-hook 'calendar-mode-hook
  2518. (lambda ()
  2519. (unless (eq org-agenda-diary-file 'diary-file)
  2520. (define-key calendar-mode-map
  2521. org-calendar-insert-diary-entry-key
  2522. 'org-agenda-diary-entry))))))
  2523. (defgroup org-latex nil
  2524. "Options for embedding LaTeX code into Org-mode."
  2525. :tag "Org LaTeX"
  2526. :group 'org)
  2527. (defcustom org-format-latex-options
  2528. '(:foreground default :background default :scale 1.0
  2529. :html-foreground "Black" :html-background "Transparent" :html-scale 1.0
  2530. :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
  2531. "Options for creating images from LaTeX fragments.
  2532. This is a property list with the following properties:
  2533. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  2534. `default' means use the foreground of the default face.
  2535. :background the background color, or \"Transparent\".
  2536. `default' means use the background of the default face.
  2537. :scale a scaling factor for the size of the images.
  2538. :html-foreground, :html-background, :html-scale
  2539. the same numbers for HTML export.
  2540. :matchers a list indicating which matchers should be used to
  2541. find LaTeX fragments. Valid members of this list are:
  2542. \"begin\" find environments
  2543. \"$1\" find single characters surrounded by $.$
  2544. \"$\" find math expressions surrounded by $...$
  2545. \"$$\" find math expressions surrounded by $$....$$
  2546. \"\\(\" find math expressions surrounded by \\(...\\)
  2547. \"\\ [\" find math expressions surrounded by \\ [...\\]"
  2548. :group 'org-latex
  2549. :type 'plist)
  2550. (defcustom org-format-latex-signal-error t
  2551. "Non-nil means signal an error when image creation of LaTeX snippets fails.
  2552. When nil, just push out a message."
  2553. :group 'org-latex
  2554. :type 'boolean)
  2555. (defcustom org-format-latex-header "\\documentclass{article}
  2556. \\usepackage[usenames]{color}
  2557. \\usepackage{amsmath}
  2558. \\usepackage[mathscr]{eucal}
  2559. \\pagestyle{empty} % do not remove
  2560. \[PACKAGES]
  2561. \[DEFAULT-PACKAGES]
  2562. % The settings below are copied from fullpage.sty
  2563. \\setlength{\\textwidth}{\\paperwidth}
  2564. \\addtolength{\\textwidth}{-3cm}
  2565. \\setlength{\\oddsidemargin}{1.5cm}
  2566. \\addtolength{\\oddsidemargin}{-2.54cm}
  2567. \\setlength{\\evensidemargin}{\\oddsidemargin}
  2568. \\setlength{\\textheight}{\\paperheight}
  2569. \\addtolength{\\textheight}{-\\headheight}
  2570. \\addtolength{\\textheight}{-\\headsep}
  2571. \\addtolength{\\textheight}{-\\footskip}
  2572. \\addtolength{\\textheight}{-3cm}
  2573. \\setlength{\\topmargin}{1.5cm}
  2574. \\addtolength{\\topmargin}{-2.54cm}"
  2575. "The document header used for processing LaTeX fragments.
  2576. It is imperative that this header make sure that no page number
  2577. appears on the page. The package defined in the variables
  2578. `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
  2579. will either replace the placeholder \"[PACKAGES]\" in this header, or they
  2580. will be appended."
  2581. :group 'org-latex
  2582. :type 'string)
  2583. (defvar org-format-latex-header-extra nil)
  2584. (defun org-set-packages-alist (var val)
  2585. "Set the packages alist and make sure it has 3 elements per entry."
  2586. (set var (mapcar (lambda (x)
  2587. (if (and (consp x) (= (length x) 2))
  2588. (list (car x) (nth 1 x) t)
  2589. x))
  2590. val)))
  2591. (defun org-get-packages-alist (var)
  2592. "Get the packages alist and make sure it has 3 elements per entry."
  2593. (mapcar (lambda (x)
  2594. (if (and (consp x) (= (length x) 2))
  2595. (list (car x) (nth 1 x) t)
  2596. x))
  2597. (default-value var)))
  2598. ;; The following variables are defined here because is it also used
  2599. ;; when formatting latex fragments. Originally it was part of the
  2600. ;; LaTeX exporter, which is why the name includes "export".
  2601. (defcustom org-export-latex-default-packages-alist
  2602. '(("AUTO" "inputenc" t)
  2603. ("T1" "fontenc" t)
  2604. ("" "fixltx2e" nil)
  2605. ("" "graphicx" t)
  2606. ("" "longtable" nil)
  2607. ("" "float" nil)
  2608. ("" "wrapfig" nil)
  2609. ("" "soul" t)
  2610. ("" "t1enc" t)
  2611. ("" "textcomp" t)
  2612. ("" "marvosym" t)
  2613. ("" "wasysym" t)
  2614. ("" "latexsym" t)
  2615. ("" "amssymb" t)
  2616. ("" "hyperref" nil)
  2617. "\\tolerance=1000"
  2618. )
  2619. "Alist of default packages to be inserted in the header.
  2620. Change this only if one of the packages here causes an incompatibility
  2621. with another package you are using.
  2622. The packages in this list are needed by one part or another of Org-mode
  2623. to function properly.
  2624. - inputenc, fontenc, t1enc: for basic font and character selection
  2625. - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
  2626. for interpreting the entities in `org-entities'. You can skip some of these
  2627. packages if you don't use any of the symbols in it.
  2628. - graphicx: for including images
  2629. - float, wrapfig: for figure placement
  2630. - longtable: for long tables
  2631. - hyperref: for cross references
  2632. Therefore you should not modify this variable unless you know what you
  2633. are doing. The one reason to change it anyway is that you might be loading
  2634. some other package that conflicts with one of the default packages.
  2635. Each cell is of the format \( \"options\" \"package\" snippet-flag\).
  2636. If SNIPPET-FLAG is t, the package also needs to be included when
  2637. compiling LaTeX snippets into images for inclusion into HTML."
  2638. :group 'org-export-latex
  2639. :set 'org-set-packages-alist
  2640. :get 'org-get-packages-alist
  2641. :type '(repeat
  2642. (choice
  2643. (list :tag "options/package pair"
  2644. (string :tag "options")
  2645. (string :tag "package")
  2646. (boolean :tag "Snippet"))
  2647. (string :tag "A line of LaTeX"))))
  2648. (defcustom org-export-latex-packages-alist nil
  2649. "Alist of packages to be inserted in every LaTeX header.
  2650. These will be inserted after `org-export-latex-default-packages-alist'.
  2651. Each cell is of the format \( \"options\" \"package\" snippet-flag \).
  2652. SNIPPET-FLAG, when t, indicates that this package is also needed when
  2653. turning LaTeX snippets into images for inclusion into HTML.
  2654. Make sure that you only list packages here which:
  2655. - you want in every file
  2656. - do not conflict with the default packages in
  2657. `org-export-latex-default-packages-alist'
  2658. - do not conflict with the setup in `org-format-latex-header'."
  2659. :group 'org-export-latex
  2660. :set 'org-set-packages-alist
  2661. :get 'org-get-packages-alist
  2662. :type '(repeat
  2663. (choice
  2664. (list :tag "options/package pair"
  2665. (string :tag "options")
  2666. (string :tag "package")
  2667. (boolean :tag "Snippet"))
  2668. (string :tag "A line of LaTeX"))))
  2669. (defgroup org-appearance nil
  2670. "Settings for Org-mode appearance."
  2671. :tag "Org Appearance"
  2672. :group 'org)
  2673. (defcustom org-level-color-stars-only nil
  2674. "Non-nil means fontify only the stars in each headline.
  2675. When nil, the entire headline is fontified.
  2676. Changing it requires restart of `font-lock-mode' to become effective
  2677. also in regions already fontified."
  2678. :group 'org-appearance
  2679. :type 'boolean)
  2680. (defcustom org-hide-leading-stars nil
  2681. "Non-nil means hide the first N-1 stars in a headline.
  2682. This works by using the face `org-hide' for these stars. This
  2683. face is white for a light background, and black for a dark
  2684. background. You may have to customize the face `org-hide' to
  2685. make this work.
  2686. Changing it requires restart of `font-lock-mode' to become effective
  2687. also in regions already fontified.
  2688. You may also set this on a per-file basis by adding one of the following
  2689. lines to the buffer:
  2690. #+STARTUP: hidestars
  2691. #+STARTUP: showstars"
  2692. :group 'org-appearance
  2693. :type 'boolean)
  2694. (defcustom org-hidden-keywords nil
  2695. "List of keywords that should be hidden when typed in the org buffer.
  2696. For example, add #+TITLE to this list in order to make the
  2697. document title appear in the buffer without the initial #+TITLE:
  2698. keyword."
  2699. :group 'org-appearance
  2700. :type '(set (const :tag "#+AUTHOR" author)
  2701. (const :tag "#+DATE" date)
  2702. (const :tag "#+EMAIL" email)
  2703. (const :tag "#+TITLE" title)))
  2704. (defcustom org-fontify-done-headline nil
  2705. "Non-nil means change the face of a headline if it is marked DONE.
  2706. Normally, only the TODO/DONE keyword indicates the state of a headline.
  2707. When this is non-nil, the headline after the keyword is set to the
  2708. `org-headline-done' as an additional indication."
  2709. :group 'org-appearance
  2710. :type 'boolean)
  2711. (defcustom org-fontify-emphasized-text t
  2712. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  2713. Changing this variable requires a restart of Emacs to take effect."
  2714. :group 'org-appearance
  2715. :type 'boolean)
  2716. (defcustom org-fontify-whole-heading-line nil
  2717. "Non-nil means fontify the whole line for headings.
  2718. This is useful when setting a background color for the
  2719. org-level-* faces."
  2720. :group 'org-appearance
  2721. :type 'boolean)
  2722. (defcustom org-highlight-latex-fragments-and-specials nil
  2723. "Non-nil means fontify what is treated specially by the exporters."
  2724. :group 'org-appearance
  2725. :type 'boolean)
  2726. (defcustom org-hide-emphasis-markers nil
  2727. "Non-nil mean font-lock should hide the emphasis marker characters."
  2728. :group 'org-appearance
  2729. :type 'boolean)
  2730. (defvar org-emph-re nil
  2731. "Regular expression for matching emphasis.")
  2732. (defvar org-verbatim-re nil
  2733. "Regular expression for matching verbatim text.")
  2734. (defvar org-emphasis-regexp-components) ; defined just below
  2735. (defvar org-emphasis-alist) ; defined just below
  2736. (defun org-set-emph-re (var val)
  2737. "Set variable and compute the emphasis regular expression."
  2738. (set var val)
  2739. (when (and (boundp 'org-emphasis-alist)
  2740. (boundp 'org-emphasis-regexp-components)
  2741. org-emphasis-alist org-emphasis-regexp-components)
  2742. (let* ((e org-emphasis-regexp-components)
  2743. (pre (car e))
  2744. (post (nth 1 e))
  2745. (border (nth 2 e))
  2746. (body (nth 3 e))
  2747. (nl (nth 4 e))
  2748. (body1 (concat body "*?"))
  2749. (markers (mapconcat 'car org-emphasis-alist ""))
  2750. (vmarkers (mapconcat
  2751. (lambda (x) (if (eq (nth 4 x) 'verbatim) (car x) ""))
  2752. org-emphasis-alist "")))
  2753. ;; make sure special characters appear at the right position in the class
  2754. (if (string-match "\\^" markers)
  2755. (setq markers (concat (replace-match "" t t markers) "^")))
  2756. (if (string-match "-" markers)
  2757. (setq markers (concat (replace-match "" t t markers) "-")))
  2758. (if (string-match "\\^" vmarkers)
  2759. (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
  2760. (if (string-match "-" vmarkers)
  2761. (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
  2762. (if (> nl 0)
  2763. (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
  2764. (int-to-string nl) "\\}")))
  2765. ;; Make the regexp
  2766. (setq org-emph-re
  2767. (concat "\\([" pre "]\\|^\\)"
  2768. "\\("
  2769. "\\([" markers "]\\)"
  2770. "\\("
  2771. "[^" border "]\\|"
  2772. "[^" border "]"
  2773. body1
  2774. "[^" border "]"
  2775. "\\)"
  2776. "\\3\\)"
  2777. "\\([" post "]\\|$\\)"))
  2778. (setq org-verbatim-re
  2779. (concat "\\([" pre "]\\|^\\)"
  2780. "\\("
  2781. "\\([" vmarkers "]\\)"
  2782. "\\("
  2783. "[^" border "]\\|"
  2784. "[^" border "]"
  2785. body1
  2786. "[^" border "]"
  2787. "\\)"
  2788. "\\3\\)"
  2789. "\\([" post "]\\|$\\)")))))
  2790. (defcustom org-emphasis-regexp-components
  2791. '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
  2792. "Components used to build the regular expression for emphasis.
  2793. This is a list with 6 entries. Terminology: In an emphasis string
  2794. like \" *strong word* \", we call the initial space PREMATCH, the final
  2795. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  2796. and \"trong wor\" is the body. The different components in this variable
  2797. specify what is allowed/forbidden in each part:
  2798. pre Chars allowed as prematch. Beginning of line will be allowed too.
  2799. post Chars allowed as postmatch. End of line will be allowed too.
  2800. border The chars *forbidden* as border characters.
  2801. body-regexp A regexp like \".\" to match a body character. Don't use
  2802. non-shy groups here, and don't allow newline here.
  2803. newline The maximum number of newlines allowed in an emphasis exp.
  2804. Use customize to modify this, or restart Emacs after changing it."
  2805. :group 'org-appearance
  2806. :set 'org-set-emph-re
  2807. :type '(list
  2808. (sexp :tag "Allowed chars in pre ")
  2809. (sexp :tag "Allowed chars in post ")
  2810. (sexp :tag "Forbidden chars in border ")
  2811. (sexp :tag "Regexp for body ")
  2812. (integer :tag "number of newlines allowed")
  2813. (option (boolean :tag "Please ignore this button"))))
  2814. (defcustom org-emphasis-alist
  2815. `(("*" bold "<b>" "</b>")
  2816. ("/" italic "<i>" "</i>")
  2817. ("_" underline "<span style=\"text-decoration:underline;\">" "</span>")
  2818. ("=" org-code "<code>" "</code>" verbatim)
  2819. ("~" org-verbatim "<code>" "</code>" verbatim)
  2820. ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))
  2821. "<del>" "</del>")
  2822. )
  2823. "Special syntax for emphasized text.
  2824. Text starting and ending with a special character will be emphasized, for
  2825. example *bold*, _underlined_ and /italic/. This variable sets the marker
  2826. characters, the face to be used by font-lock for highlighting in Org-mode
  2827. Emacs buffers, and the HTML tags to be used for this.
  2828. For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
  2829. Use customize to modify this, or restart Emacs after changing it."
  2830. :group 'org-appearance
  2831. :set 'org-set-emph-re
  2832. :type '(repeat
  2833. (list
  2834. (string :tag "Marker character")
  2835. (choice
  2836. (face :tag "Font-lock-face")
  2837. (plist :tag "Face property list"))
  2838. (string :tag "HTML start tag")
  2839. (string :tag "HTML end tag")
  2840. (option (const verbatim)))))
  2841. (defvar org-protecting-blocks
  2842. '("src" "example" "latex" "ascii" "html" "docbook" "ditaa" "dot" "r" "R")
  2843. "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
  2844. This is needed for font-lock setup.")
  2845. ;;; Miscellaneous options
  2846. (defgroup org-completion nil
  2847. "Completion in Org-mode."
  2848. :tag "Org Completion"
  2849. :group 'org)
  2850. (defcustom org-completion-use-ido nil
  2851. "Non-nil means use ido completion wherever possible.
  2852. Note that `ido-mode' must be active for this variable to be relevant.
  2853. If you decide to turn this variable on, you might well want to turn off
  2854. `org-outline-path-complete-in-steps'.
  2855. See also `org-completion-use-iswitchb'."
  2856. :group 'org-completion
  2857. :type 'boolean)
  2858. (defcustom org-completion-use-iswitchb nil
  2859. "Non-nil means use iswitchb completion wherever possible.
  2860. Note that `iswitchb-mode' must be active for this variable to be relevant.
  2861. If you decide to turn this variable on, you might well want to turn off
  2862. `org-outline-path-complete-in-steps'.
  2863. Note that this variable has only an effect if `org-completion-use-ido' is nil."
  2864. :group 'org-completion
  2865. :type 'boolean)
  2866. (defcustom org-completion-fallback-command 'hippie-expand
  2867. "The expansion command called by \\[org-complete] in normal context.
  2868. Normal means no org-mode-specific context."
  2869. :group 'org-completion
  2870. :type 'function)
  2871. ;;; Functions and variables from their packages
  2872. ;; Declared here to avoid compiler warnings
  2873. ;; XEmacs only
  2874. (defvar outline-mode-menu-heading)
  2875. (defvar outline-mode-menu-show)
  2876. (defvar outline-mode-menu-hide)
  2877. (defvar zmacs-regions) ; XEmacs regions
  2878. ;; Emacs only
  2879. (defvar mark-active)
  2880. ;; Various packages
  2881. (declare-function calendar-absolute-from-iso "cal-iso" (date))
  2882. (declare-function calendar-forward-day "cal-move" (arg))
  2883. (declare-function calendar-goto-date "cal-move" (date))
  2884. (declare-function calendar-goto-today "cal-move" ())
  2885. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  2886. (defvar calc-embedded-close-formula)
  2887. (defvar calc-embedded-open-formula)
  2888. (declare-function cdlatex-tab "ext:cdlatex" ())
  2889. (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
  2890. (defvar font-lock-unfontify-region-function)
  2891. (declare-function iswitchb-read-buffer "iswitchb"
  2892. (prompt &optional default require-match start matches-set))
  2893. (defvar iswitchb-temp-buflist)
  2894. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  2895. (defvar org-agenda-tags-todo-honor-ignore-options)
  2896. (declare-function org-agenda-skip "org-agenda" ())
  2897. (declare-function
  2898. org-format-agenda-item "org-agenda"
  2899. (extra txt &optional category tags dotime noprefix remove-re habitp))
  2900. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  2901. (declare-function org-agenda-change-all-lines "org-agenda"
  2902. (newhead hdmarker &optional fixface just-this))
  2903. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  2904. (declare-function org-agenda-maybe-redo "org-agenda" ())
  2905. (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
  2906. (beg end))
  2907. (declare-function org-agenda-copy-local-variable "org-agenda" (var))
  2908. (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  2909. "org-agenda" (&optional end))
  2910. (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  2911. (declare-function org-indent-mode "org-indent" (&optional arg))
  2912. (declare-function parse-time-string "parse-time" (string))
  2913. (declare-function org-attach-reveal "org-attach" (&optional if-exists))
  2914. (declare-function org-export-latex-fix-inputenc "org-latex" ())
  2915. (defvar remember-data-file)
  2916. (defvar texmathp-why)
  2917. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  2918. (declare-function table--at-cell-p "table" (position &optional object at-column))
  2919. (defvar w3m-current-url)
  2920. (defvar w3m-current-title)
  2921. (defvar org-latex-regexps)
  2922. ;;; Autoload and prepare some org modules
  2923. ;; Some table stuff that needs to be defined here, because it is used
  2924. ;; by the functions setting up org-mode or checking for table context.
  2925. (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
  2926. "Detects an org-type or table-type table.")
  2927. (defconst org-table-line-regexp "^[ \t]*|"
  2928. "Detects an org-type table line.")
  2929. (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
  2930. "Detects an org-type table line.")
  2931. (defconst org-table-hline-regexp "^[ \t]*|-"
  2932. "Detects an org-type table hline.")
  2933. (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
  2934. "Detects a table-type table hline.")
  2935. (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
  2936. "Searching from within a table (any type) this finds the first line
  2937. outside the table.")
  2938. ;; Autoload the functions in org-table.el that are needed by functions here.
  2939. (eval-and-compile
  2940. (org-autoload "org-table"
  2941. '(org-table-align org-table-begin org-table-blank-field
  2942. org-table-convert org-table-convert-region org-table-copy-down
  2943. org-table-copy-region org-table-create
  2944. org-table-create-or-convert-from-region
  2945. org-table-create-with-table.el org-table-current-dline
  2946. org-table-cut-region org-table-delete-column org-table-edit-field
  2947. org-table-edit-formulas org-table-end org-table-eval-formula
  2948. org-table-export org-table-field-info
  2949. org-table-get-stored-formulas org-table-goto-column
  2950. org-table-hline-and-move org-table-import org-table-insert-column
  2951. org-table-insert-hline org-table-insert-row org-table-iterate
  2952. org-table-justify-field-maybe org-table-kill-row
  2953. org-table-maybe-eval-formula org-table-maybe-recalculate-line
  2954. org-table-move-column org-table-move-column-left
  2955. org-table-move-column-right org-table-move-row
  2956. org-table-move-row-down org-table-move-row-up
  2957. org-table-next-field org-table-next-row org-table-paste-rectangle
  2958. org-table-previous-field org-table-recalculate
  2959. org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
  2960. org-table-toggle-coordinate-overlays
  2961. org-table-toggle-formula-debugger org-table-wrap-region
  2962. orgtbl-mode turn-on-orgtbl org-table-to-lisp)))
  2963. (defun org-at-table-p (&optional table-type)
  2964. "Return t if the cursor is inside an org-type table.
  2965. If TABLE-TYPE is non-nil, also check for table.el-type tables."
  2966. (if org-enable-table-editor
  2967. (save-excursion
  2968. (beginning-of-line 1)
  2969. (looking-at (if table-type org-table-any-line-regexp
  2970. org-table-line-regexp)))
  2971. nil))
  2972. (defsubst org-table-p () (org-at-table-p))
  2973. (defun org-at-table.el-p ()
  2974. "Return t if and only if we are at a table.el table."
  2975. (and (org-at-table-p 'any)
  2976. (save-excursion
  2977. (goto-char (org-table-begin 'any))
  2978. (looking-at org-table1-hline-regexp))))
  2979. (defun org-table-recognize-table.el ()
  2980. "If there is a table.el table nearby, recognize it and move into it."
  2981. (if org-table-tab-recognizes-table.el
  2982. (if (org-at-table.el-p)
  2983. (progn
  2984. (beginning-of-line 1)
  2985. (if (looking-at org-table-dataline-regexp)
  2986. nil
  2987. (if (looking-at org-table1-hline-regexp)
  2988. (progn
  2989. (beginning-of-line 2)
  2990. (if (looking-at org-table-any-border-regexp)
  2991. (beginning-of-line -1)))))
  2992. (if (re-search-forward "|" (org-table-end t) t)
  2993. (progn
  2994. (require 'table)
  2995. (if (table--at-cell-p (point))
  2996. t
  2997. (message "recognizing table.el table...")
  2998. (table-recognize-table)
  2999. (message "recognizing table.el table...done")))
  3000. (error "This should not happen..."))
  3001. t)
  3002. nil)
  3003. nil))
  3004. (defun org-at-table-hline-p ()
  3005. "Return t if the cursor is inside a hline in a table."
  3006. (if org-enable-table-editor
  3007. (save-excursion
  3008. (beginning-of-line 1)
  3009. (looking-at org-table-hline-regexp))
  3010. nil))
  3011. (defvar org-table-clean-did-remove-column nil)
  3012. (defun org-table-map-tables (function &optional quietly)
  3013. "Apply FUNCTION to the start of all tables in the buffer."
  3014. (save-excursion
  3015. (save-restriction
  3016. (widen)
  3017. (goto-char (point-min))
  3018. (while (re-search-forward org-table-any-line-regexp nil t)
  3019. (unless quietly
  3020. (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
  3021. (beginning-of-line 1)
  3022. (when (looking-at org-table-line-regexp)
  3023. (save-excursion (funcall function))
  3024. (or (looking-at org-table-line-regexp)
  3025. (forward-char 1)))
  3026. (re-search-forward org-table-any-border-regexp nil 1))))
  3027. (unless quietly (message "Mapping tables: done")))
  3028. ;; Declare and autoload functions from org-exp.el & Co
  3029. (declare-function org-default-export-plist "org-exp")
  3030. (declare-function org-infile-export-plist "org-exp")
  3031. (declare-function org-get-current-options "org-exp")
  3032. (eval-and-compile
  3033. (org-autoload "org-exp"
  3034. '(org-export org-export-visible
  3035. org-insert-export-options-template
  3036. org-table-clean-before-export))
  3037. (org-autoload "org-ascii"
  3038. '(org-export-as-ascii org-export-ascii-preprocess
  3039. org-export-as-ascii-to-buffer org-replace-region-by-ascii
  3040. org-export-region-as-ascii))
  3041. (org-autoload "org-latex"
  3042. '(org-export-as-latex-batch org-export-as-latex-to-buffer
  3043. org-replace-region-by-latex org-export-region-as-latex
  3044. org-export-as-latex org-export-as-pdf
  3045. org-export-as-pdf-and-open))
  3046. (org-autoload "org-html"
  3047. '(org-export-as-html-and-open
  3048. org-export-as-html-batch org-export-as-html-to-buffer
  3049. org-replace-region-by-html org-export-region-as-html
  3050. org-export-as-html))
  3051. (org-autoload "org-docbook"
  3052. '(org-export-as-docbook-batch org-export-as-docbook-to-buffer
  3053. org-replace-region-by-docbook org-export-region-as-docbook
  3054. org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
  3055. org-export-as-docbook))
  3056. (org-autoload "org-icalendar"
  3057. '(org-export-icalendar-this-file
  3058. org-export-icalendar-all-agenda-files
  3059. org-export-icalendar-combine-agenda-files))
  3060. (org-autoload "org-xoxo" '(org-export-as-xoxo))
  3061. (org-autoload "org-beamer" '(org-beamer-mode org-beamer-sectioning)))
  3062. ;; Declare and autoload functions from org-agenda.el
  3063. (eval-and-compile
  3064. (org-autoload "org-agenda"
  3065. '(org-agenda org-agenda-list org-search-view
  3066. org-todo-list org-tags-view org-agenda-list-stuck-projects
  3067. org-diary org-agenda-to-appt
  3068. org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
  3069. ;; Autoload org-remember
  3070. (eval-and-compile
  3071. (org-autoload "org-remember"
  3072. '(org-remember-insinuate org-remember-annotation
  3073. org-remember-apply-template org-remember org-remember-handler)))
  3074. ;; Autoload org-clock.el
  3075. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock"
  3076. (beg end))
  3077. (declare-function org-clock-update-mode-line "org-clock" ())
  3078. (declare-function org-resolve-clocks "org-clock"
  3079. (&optional also-non-dangling-p prompt last-valid))
  3080. (defvar org-clock-start-time)
  3081. (defvar org-clock-marker (make-marker)
  3082. "Marker recording the last clock-in.")
  3083. (defvar org-clock-hd-marker (make-marker)
  3084. "Marker recording the last clock-in, but the headline position.")
  3085. (defvar org-clock-heading ""
  3086. "The heading of the current clock entry.")
  3087. (defun org-clock-is-active ()
  3088. "Return non-nil if clock is currently running.
  3089. The return value is actually the clock marker."
  3090. (marker-buffer org-clock-marker))
  3091. (eval-and-compile
  3092. (org-autoload
  3093. "org-clock"
  3094. '(org-clock-in org-clock-out org-clock-cancel
  3095. org-clock-goto org-clock-sum org-clock-display
  3096. org-clock-remove-overlays org-clock-report
  3097. org-clocktable-shift org-dblock-write:clocktable
  3098. org-get-clocktable org-resolve-clocks)))
  3099. (defun org-clock-update-time-maybe ()
  3100. "If this is a CLOCK line, update it and return t.
  3101. Otherwise, return nil."
  3102. (interactive)
  3103. (save-excursion
  3104. (beginning-of-line 1)
  3105. (skip-chars-forward " \t")
  3106. (when (looking-at org-clock-string)
  3107. (let ((re (concat "[ \t]*" org-clock-string
  3108. " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
  3109. "\\([ \t]*=>.*\\)?\\)?"))
  3110. ts te h m s neg)
  3111. (cond
  3112. ((not (looking-at re))
  3113. nil)
  3114. ((not (match-end 2))
  3115. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3116. (> org-clock-marker (point))
  3117. (<= org-clock-marker (point-at-eol)))
  3118. ;; The clock is running here
  3119. (setq org-clock-start-time
  3120. (apply 'encode-time
  3121. (org-parse-time-string (match-string 1))))
  3122. (org-clock-update-mode-line)))
  3123. (t
  3124. (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
  3125. (end-of-line 1)
  3126. (setq ts (match-string 1)
  3127. te (match-string 3))
  3128. (setq s (- (org-float-time
  3129. (apply 'encode-time (org-parse-time-string te)))
  3130. (org-float-time
  3131. (apply 'encode-time (org-parse-time-string ts))))
  3132. neg (< s 0)
  3133. s (abs s)
  3134. h (floor (/ s 3600))
  3135. s (- s (* 3600 h))
  3136. m (floor (/ s 60))
  3137. s (- s (* 60 s)))
  3138. (insert " => " (format (if neg "-%d:%02d" "%2d:%02d") h m))
  3139. t))))))
  3140. (defun org-check-running-clock ()
  3141. "Check if the current buffer contains the running clock.
  3142. If yes, offer to stop it and to save the buffer with the changes."
  3143. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3144. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  3145. (buffer-name))))
  3146. (org-clock-out)
  3147. (when (y-or-n-p "Save changed buffer?")
  3148. (save-buffer))))
  3149. (defun org-clocktable-try-shift (dir n)
  3150. "Check if this line starts a clock table, if yes, shift the time block."
  3151. (when (org-match-line "#\\+BEGIN: clocktable\\>")
  3152. (org-clocktable-shift dir n)))
  3153. ;; Autoload org-timer.el
  3154. (eval-and-compile
  3155. (org-autoload
  3156. "org-timer"
  3157. '(org-timer-start org-timer org-timer-item
  3158. org-timer-change-times-in-region
  3159. org-timer-set-timer
  3160. org-timer-reset-timers
  3161. org-timer-show-remaining-time)))
  3162. ;; Autoload org-feed.el
  3163. (eval-and-compile
  3164. (org-autoload
  3165. "org-feed"
  3166. '(org-feed-update org-feed-update-all org-feed-goto-inbox)))
  3167. ;; Autoload org-indent.el
  3168. ;; Define the variable already here, to make sure we have it.
  3169. (defvar org-indent-mode nil
  3170. "Non-nil if Org-Indent mode is enabled.
  3171. Use the command `org-indent-mode' to change this variable.")
  3172. (eval-and-compile
  3173. (org-autoload
  3174. "org-indent"
  3175. '(org-indent-mode)))
  3176. ;; Autoload org-mobile.el
  3177. (eval-and-compile
  3178. (org-autoload
  3179. "org-mobile"
  3180. '(org-mobile-push org-mobile-pull org-mobile-create-sumo-agenda)))
  3181. ;; Autoload archiving code
  3182. ;; The stuff that is needed for cycling and tags has to be defined here.
  3183. (defgroup org-archive nil
  3184. "Options concerning archiving in Org-mode."
  3185. :tag "Org Archive"
  3186. :group 'org-structure)
  3187. (defcustom org-archive-location "%s_archive::"
  3188. "The location where subtrees should be archived.
  3189. The value of this variable is a string, consisting of two parts,
  3190. separated by a double-colon. The first part is a filename and
  3191. the second part is a headline.
  3192. When the filename is omitted, archiving happens in the same file.
  3193. %s in the filename will be replaced by the current file
  3194. name (without the directory part). Archiving to a different file
  3195. is useful to keep archived entries from contributing to the
  3196. Org-mode Agenda.
  3197. The archived entries will be filed as subtrees of the specified
  3198. headline. When the headline is omitted, the subtrees are simply
  3199. filed away at the end of the file, as top-level entries. Also in
  3200. the heading you can use %s to represent the file name, this can be
  3201. useful when using the same archive for a number of different files.
  3202. Here are a few examples:
  3203. \"%s_archive::\"
  3204. If the current file is Projects.org, archive in file
  3205. Projects.org_archive, as top-level trees. This is the default.
  3206. \"::* Archived Tasks\"
  3207. Archive in the current file, under the top-level headline
  3208. \"* Archived Tasks\".
  3209. \"~/org/archive.org::\"
  3210. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  3211. \"~/org/archive.org::From %s\"
  3212. Archive in file ~/org/archive.org (absolute path), under headlines
  3213. \"From FILENAME\" where file name is the current file name.
  3214. \"basement::** Finished Tasks\"
  3215. Archive in file ./basement (relative path), as level 3 trees
  3216. below the level 2 heading \"** Finished Tasks\".
  3217. You may set this option on a per-file basis by adding to the buffer a
  3218. line like
  3219. #+ARCHIVE: basement::** Finished Tasks
  3220. You may also define it locally for a subtree by setting an ARCHIVE property
  3221. in the entry. If such a property is found in an entry, or anywhere up
  3222. the hierarchy, it will be used."
  3223. :group 'org-archive
  3224. :type 'string)
  3225. (defcustom org-archive-tag "ARCHIVE"
  3226. "The tag that marks a subtree as archived.
  3227. An archived subtree does not open during visibility cycling, and does
  3228. not contribute to the agenda listings.
  3229. After changing this, font-lock must be restarted in the relevant buffers to
  3230. get the proper fontification."
  3231. :group 'org-archive
  3232. :group 'org-keywords
  3233. :type 'string)
  3234. (defcustom org-agenda-skip-archived-trees t
  3235. "Non-nil means the agenda will skip any items located in archived trees.
  3236. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  3237. variable is no longer recommended, you should leave it at the value t.
  3238. Instead, use the key `v' to cycle the archives-mode in the agenda."
  3239. :group 'org-archive
  3240. :group 'org-agenda-skip
  3241. :type 'boolean)
  3242. (defcustom org-columns-skip-archived-trees t
  3243. "Non-nil means ignore archived trees when creating column view."
  3244. :group 'org-archive
  3245. :group 'org-properties
  3246. :type 'boolean)
  3247. (defcustom org-cycle-open-archived-trees nil
  3248. "Non-nil means `org-cycle' will open archived trees.
  3249. An archived tree is a tree marked with the tag ARCHIVE.
  3250. When nil, archived trees will stay folded. You can still open them with
  3251. normal outline commands like `show-all', but not with the cycling commands."
  3252. :group 'org-archive
  3253. :group 'org-cycle
  3254. :type 'boolean)
  3255. (defcustom org-sparse-tree-open-archived-trees nil
  3256. "Non-nil means sparse tree construction shows matches in archived trees.
  3257. When nil, matches in these trees are highlighted, but the trees are kept in
  3258. collapsed state."
  3259. :group 'org-archive
  3260. :group 'org-sparse-trees
  3261. :type 'boolean)
  3262. (defun org-cycle-hide-archived-subtrees (state)
  3263. "Re-hide all archived subtrees after a visibility state change."
  3264. (when (and (not org-cycle-open-archived-trees)
  3265. (not (memq state '(overview folded))))
  3266. (save-excursion
  3267. (let* ((globalp (memq state '(contents all)))
  3268. (beg (if globalp (point-min) (point)))
  3269. (end (if globalp (point-max) (org-end-of-subtree t))))
  3270. (org-hide-archived-subtrees beg end)
  3271. (goto-char beg)
  3272. (if (looking-at (concat ".*:" org-archive-tag ":"))
  3273. (message "%s" (substitute-command-keys
  3274. "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
  3275. (defun org-force-cycle-archived ()
  3276. "Cycle subtree even if it is archived."
  3277. (interactive)
  3278. (setq this-command 'org-cycle)
  3279. (let ((org-cycle-open-archived-trees t))
  3280. (call-interactively 'org-cycle)))
  3281. (defun org-hide-archived-subtrees (beg end)
  3282. "Re-hide all archived subtrees after a visibility state change."
  3283. (save-excursion
  3284. (let* ((re (concat ":" org-archive-tag ":")))
  3285. (goto-char beg)
  3286. (while (re-search-forward re end t)
  3287. (when (org-on-heading-p)
  3288. (org-flag-subtree t)
  3289. (org-end-of-subtree t))))))
  3290. (defun org-flag-subtree (flag)
  3291. (save-excursion
  3292. (org-back-to-heading t)
  3293. (outline-end-of-heading)
  3294. (outline-flag-region (point)
  3295. (progn (org-end-of-subtree t) (point))
  3296. flag)))
  3297. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  3298. (eval-and-compile
  3299. (org-autoload "org-archive"
  3300. '(org-add-archive-files org-archive-subtree
  3301. org-archive-to-archive-sibling org-toggle-archive-tag
  3302. org-archive-subtree-default
  3303. org-archive-subtree-default-with-confirmation)))
  3304. ;; Autoload Column View Code
  3305. (declare-function org-columns-number-to-string "org-colview")
  3306. (declare-function org-columns-get-format-and-top-level "org-colview")
  3307. (declare-function org-columns-compute "org-colview")
  3308. (org-autoload (if (featurep 'xemacs) "org-colview-xemacs" "org-colview")
  3309. '(org-columns-number-to-string org-columns-get-format-and-top-level
  3310. org-columns-compute org-agenda-columns org-columns-remove-overlays
  3311. org-columns org-insert-columns-dblock org-dblock-write:columnview))
  3312. ;; Autoload ID code
  3313. (declare-function org-id-store-link "org-id")
  3314. (declare-function org-id-locations-load "org-id")
  3315. (declare-function org-id-locations-save "org-id")
  3316. (defvar org-id-track-globally)
  3317. (org-autoload "org-id"
  3318. '(org-id-get-create org-id-new org-id-copy org-id-get
  3319. org-id-get-with-outline-path-completion
  3320. org-id-get-with-outline-drilling
  3321. org-id-goto org-id-find org-id-store-link))
  3322. ;; Autoload Plotting Code
  3323. (org-autoload "org-plot"
  3324. '(org-plot/gnuplot))
  3325. ;;; Variables for pre-computed regular expressions, all buffer local
  3326. (defvar org-drawer-regexp nil
  3327. "Matches first line of a hidden block.")
  3328. (make-variable-buffer-local 'org-drawer-regexp)
  3329. (defvar org-todo-regexp nil
  3330. "Matches any of the TODO state keywords.")
  3331. (make-variable-buffer-local 'org-todo-regexp)
  3332. (defvar org-not-done-regexp nil
  3333. "Matches any of the TODO state keywords except the last one.")
  3334. (make-variable-buffer-local 'org-not-done-regexp)
  3335. (defvar org-not-done-heading-regexp nil
  3336. "Matches a TODO headline that is not done.")
  3337. (make-variable-buffer-local 'org-not-done-regexp)
  3338. (defvar org-todo-line-regexp nil
  3339. "Matches a headline and puts TODO state into group 2 if present.")
  3340. (make-variable-buffer-local 'org-todo-line-regexp)
  3341. (defvar org-complex-heading-regexp nil
  3342. "Matches a headline and puts everything into groups:
  3343. group 1: the stars
  3344. group 2: The todo keyword, maybe
  3345. group 3: Priority cookie
  3346. group 4: True headline
  3347. group 5: Tags")
  3348. (make-variable-buffer-local 'org-complex-heading-regexp)
  3349. (defvar org-complex-heading-regexp-format nil)
  3350. (make-variable-buffer-local 'org-complex-heading-regexp-format)
  3351. (defvar org-todo-line-tags-regexp nil
  3352. "Matches a headline and puts TODO state into group 2 if present.
  3353. Also put tags into group 4 if tags are present.")
  3354. (make-variable-buffer-local 'org-todo-line-tags-regexp)
  3355. (defvar org-nl-done-regexp nil
  3356. "Matches newline followed by a headline with the DONE keyword.")
  3357. (make-variable-buffer-local 'org-nl-done-regexp)
  3358. (defvar org-looking-at-done-regexp nil
  3359. "Matches the DONE keyword a point.")
  3360. (make-variable-buffer-local 'org-looking-at-done-regexp)
  3361. (defvar org-ds-keyword-length 12
  3362. "Maximum length of the Deadline and SCHEDULED keywords.")
  3363. (make-variable-buffer-local 'org-ds-keyword-length)
  3364. (defvar org-deadline-regexp nil
  3365. "Matches the DEADLINE keyword.")
  3366. (make-variable-buffer-local 'org-deadline-regexp)
  3367. (defvar org-deadline-time-regexp nil
  3368. "Matches the DEADLINE keyword together with a time stamp.")
  3369. (make-variable-buffer-local 'org-deadline-time-regexp)
  3370. (defvar org-deadline-line-regexp nil
  3371. "Matches the DEADLINE keyword and the rest of the line.")
  3372. (make-variable-buffer-local 'org-deadline-line-regexp)
  3373. (defvar org-scheduled-regexp nil
  3374. "Matches the SCHEDULED keyword.")
  3375. (make-variable-buffer-local 'org-scheduled-regexp)
  3376. (defvar org-scheduled-time-regexp nil
  3377. "Matches the SCHEDULED keyword together with a time stamp.")
  3378. (make-variable-buffer-local 'org-scheduled-time-regexp)
  3379. (defvar org-closed-time-regexp nil
  3380. "Matches the CLOSED keyword together with a time stamp.")
  3381. (make-variable-buffer-local 'org-closed-time-regexp)
  3382. (defvar org-keyword-time-regexp nil
  3383. "Matches any of the 4 keywords, together with the time stamp.")
  3384. (make-variable-buffer-local 'org-keyword-time-regexp)
  3385. (defvar org-keyword-time-not-clock-regexp nil
  3386. "Matches any of the 3 keywords, together with the time stamp.")
  3387. (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
  3388. (defvar org-maybe-keyword-time-regexp nil
  3389. "Matches a timestamp, possibly preceeded by a keyword.")
  3390. (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
  3391. (defvar org-planning-or-clock-line-re nil
  3392. "Matches a line with planning or clock info.")
  3393. (make-variable-buffer-local 'org-planning-or-clock-line-re)
  3394. (defvar org-all-time-keywords nil
  3395. "List of time keywords.")
  3396. (make-variable-buffer-local 'org-all-time-keywords)
  3397. (defconst org-plain-time-of-day-regexp
  3398. (concat
  3399. "\\(\\<[012]?[0-9]"
  3400. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3401. "\\(--?"
  3402. "\\(\\<[012]?[0-9]"
  3403. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3404. "\\)?")
  3405. "Regular expression to match a plain time or time range.
  3406. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3407. groups carry important information:
  3408. 0 the full match
  3409. 1 the first time, range or not
  3410. 8 the second time, if it is a range.")
  3411. (defconst org-plain-time-extension-regexp
  3412. (concat
  3413. "\\(\\<[012]?[0-9]"
  3414. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3415. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  3416. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  3417. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3418. groups carry important information:
  3419. 0 the full match
  3420. 7 hours of duration
  3421. 9 minutes of duration")
  3422. (defconst org-stamp-time-of-day-regexp
  3423. (concat
  3424. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  3425. "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
  3426. "\\(--?"
  3427. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  3428. "Regular expression to match a timestamp time or time range.
  3429. After a match, the following groups carry important information:
  3430. 0 the full match
  3431. 1 date plus weekday, for back referencing to make sure both times are on the same day
  3432. 2 the first time, range or not
  3433. 4 the second time, if it is a range.")
  3434. (defconst org-startup-options
  3435. '(("fold" org-startup-folded t)
  3436. ("overview" org-startup-folded t)
  3437. ("nofold" org-startup-folded nil)
  3438. ("showall" org-startup-folded nil)
  3439. ("showeverything" org-startup-folded showeverything)
  3440. ("content" org-startup-folded content)
  3441. ("indent" org-startup-indented t)
  3442. ("noindent" org-startup-indented nil)
  3443. ("hidestars" org-hide-leading-stars t)
  3444. ("showstars" org-hide-leading-stars nil)
  3445. ("odd" org-odd-levels-only t)
  3446. ("oddeven" org-odd-levels-only nil)
  3447. ("align" org-startup-align-all-tables t)
  3448. ("noalign" org-startup-align-all-tables nil)
  3449. ("customtime" org-display-custom-times t)
  3450. ("logdone" org-log-done time)
  3451. ("lognotedone" org-log-done note)
  3452. ("nologdone" org-log-done nil)
  3453. ("lognoteclock-out" org-log-note-clock-out t)
  3454. ("nolognoteclock-out" org-log-note-clock-out nil)
  3455. ("logrepeat" org-log-repeat state)
  3456. ("lognoterepeat" org-log-repeat note)
  3457. ("nologrepeat" org-log-repeat nil)
  3458. ("logreschedule" org-log-reschedule time)
  3459. ("lognotereschedule" org-log-reschedule note)
  3460. ("nologreschedule" org-log-reschedule nil)
  3461. ("logredeadline" org-log-redeadline time)
  3462. ("lognoteredeadline" org-log-redeadline note)
  3463. ("nologredeadline" org-log-redeadline nil)
  3464. ("logrefile" org-log-refile time)
  3465. ("lognoterefile" org-log-refile note)
  3466. ("nologrefile" org-log-refile nil)
  3467. ("fninline" org-footnote-define-inline t)
  3468. ("nofninline" org-footnote-define-inline nil)
  3469. ("fnlocal" org-footnote-section nil)
  3470. ("fnauto" org-footnote-auto-label t)
  3471. ("fnprompt" org-footnote-auto-label nil)
  3472. ("fnconfirm" org-footnote-auto-label confirm)
  3473. ("fnplain" org-footnote-auto-label plain)
  3474. ("fnadjust" org-footnote-auto-adjust t)
  3475. ("nofnadjust" org-footnote-auto-adjust nil)
  3476. ("constcgs" constants-unit-system cgs)
  3477. ("constSI" constants-unit-system SI)
  3478. ("noptag" org-tag-persistent-alist nil)
  3479. ("hideblocks" org-hide-block-startup t)
  3480. ("nohideblocks" org-hide-block-startup nil)
  3481. ("beamer" org-startup-with-beamer-mode t))
  3482. "Variable associated with STARTUP options for org-mode.
  3483. Each element is a list of three items: The startup options as written
  3484. in the #+STARTUP line, the corresponding variable, and the value to
  3485. set this variable to if the option is found. An optional forth element PUSH
  3486. means to push this value onto the list in the variable.")
  3487. (defun org-set-regexps-and-options ()
  3488. "Precompute regular expressions for current buffer."
  3489. (when (org-mode-p)
  3490. (org-set-local 'org-todo-kwd-alist nil)
  3491. (org-set-local 'org-todo-key-alist nil)
  3492. (org-set-local 'org-todo-key-trigger nil)
  3493. (org-set-local 'org-todo-keywords-1 nil)
  3494. (org-set-local 'org-done-keywords nil)
  3495. (org-set-local 'org-todo-heads nil)
  3496. (org-set-local 'org-todo-sets nil)
  3497. (org-set-local 'org-todo-log-states nil)
  3498. (org-set-local 'org-file-properties nil)
  3499. (org-set-local 'org-file-tags nil)
  3500. (let ((re (org-make-options-regexp
  3501. '("CATEGORY" "TODO" "COLUMNS"
  3502. "STARTUP" "ARCHIVE" "FILETAGS" "TAGS" "LINK" "PRIORITIES"
  3503. "CONSTANTS" "PROPERTY" "DRAWERS" "SETUPFILE" "LATEX_CLASS")
  3504. "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
  3505. (splitre "[ \t]+")
  3506. kwds kws0 kwsa key log value cat arch tags const links hw dws
  3507. tail sep kws1 prio props ftags drawers beamer-p
  3508. ext-setup-or-nil setup-contents (start 0))
  3509. (save-excursion
  3510. (save-restriction
  3511. (widen)
  3512. (goto-char (point-min))
  3513. (while (or (and ext-setup-or-nil
  3514. (string-match re ext-setup-or-nil start)
  3515. (setq start (match-end 0)))
  3516. (and (setq ext-setup-or-nil nil start 0)
  3517. (re-search-forward re nil t)))
  3518. (setq key (upcase (match-string 1 ext-setup-or-nil))
  3519. value (org-match-string-no-properties 2 ext-setup-or-nil))
  3520. (cond
  3521. ((equal key "CATEGORY")
  3522. (if (string-match "[ \t]+$" value)
  3523. (setq value (replace-match "" t t value)))
  3524. (setq cat value))
  3525. ((member key '("SEQ_TODO" "TODO"))
  3526. (push (cons 'sequence (org-split-string value splitre)) kwds))
  3527. ((equal key "TYP_TODO")
  3528. (push (cons 'type (org-split-string value splitre)) kwds))
  3529. ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
  3530. ;; general TODO-like setup
  3531. (push (cons (intern (downcase (match-string 1 key)))
  3532. (org-split-string value splitre)) kwds))
  3533. ((equal key "TAGS")
  3534. (setq tags (append tags (if tags '("\\n") nil)
  3535. (org-split-string value splitre))))
  3536. ((equal key "COLUMNS")
  3537. (org-set-local 'org-columns-default-format value))
  3538. ((equal key "LINK")
  3539. (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  3540. (push (cons (match-string 1 value)
  3541. (org-trim (match-string 2 value)))
  3542. links)))
  3543. ((equal key "PRIORITIES")
  3544. (setq prio (org-split-string value " +")))
  3545. ((equal key "PROPERTY")
  3546. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  3547. (push (cons (match-string 1 value) (match-string 2 value))
  3548. props)))
  3549. ((equal key "FILETAGS")
  3550. (when (string-match "\\S-" value)
  3551. (setq ftags
  3552. (append
  3553. ftags
  3554. (apply 'append
  3555. (mapcar (lambda (x) (org-split-string x ":"))
  3556. (org-split-string value)))))))
  3557. ((equal key "DRAWERS")
  3558. (setq drawers (org-split-string value splitre)))
  3559. ((equal key "CONSTANTS")
  3560. (setq const (append const (org-split-string value splitre))))
  3561. ((equal key "STARTUP")
  3562. (let ((opts (org-split-string value splitre))
  3563. l var val)
  3564. (while (setq l (pop opts))
  3565. (when (setq l (assoc l org-startup-options))
  3566. (setq var (nth 1 l) val (nth 2 l))
  3567. (if (not (nth 3 l))
  3568. (set (make-local-variable var) val)
  3569. (if (not (listp (symbol-value var)))
  3570. (set (make-local-variable var) nil))
  3571. (set (make-local-variable var) (symbol-value var))
  3572. (add-to-list var val))))))
  3573. ((equal key "ARCHIVE")
  3574. (string-match " *$" value)
  3575. (setq arch (replace-match "" t t value))
  3576. (remove-text-properties 0 (length arch)
  3577. '(face t fontified t) arch))
  3578. ((equal key "LATEX_CLASS")
  3579. (setq beamer-p (equal value "beamer")))
  3580. ((equal key "SETUPFILE")
  3581. (setq setup-contents (org-file-contents
  3582. (expand-file-name
  3583. (org-remove-double-quotes value))
  3584. 'noerror))
  3585. (if (not ext-setup-or-nil)
  3586. (setq ext-setup-or-nil setup-contents start 0)
  3587. (setq ext-setup-or-nil
  3588. (concat (substring ext-setup-or-nil 0 start)
  3589. "\n" setup-contents "\n"
  3590. (substring ext-setup-or-nil start)))))
  3591. ))))
  3592. (when cat
  3593. (org-set-local 'org-category (intern cat))
  3594. (push (cons "CATEGORY" cat) props))
  3595. (when prio
  3596. (if (< (length prio) 3) (setq prio '("A" "C" "B")))
  3597. (setq prio (mapcar 'string-to-char prio))
  3598. (org-set-local 'org-highest-priority (nth 0 prio))
  3599. (org-set-local 'org-lowest-priority (nth 1 prio))
  3600. (org-set-local 'org-default-priority (nth 2 prio)))
  3601. (and props (org-set-local 'org-file-properties (nreverse props)))
  3602. (and ftags (org-set-local 'org-file-tags
  3603. (mapcar 'org-add-prop-inherited ftags)))
  3604. (and drawers (org-set-local 'org-drawers drawers))
  3605. (and arch (org-set-local 'org-archive-location arch))
  3606. (and links (setq org-link-abbrev-alist-local (nreverse links)))
  3607. ;; Process the TODO keywords
  3608. (unless kwds
  3609. ;; Use the global values as if they had been given locally.
  3610. (setq kwds (default-value 'org-todo-keywords))
  3611. (if (stringp (car kwds))
  3612. (setq kwds (list (cons org-todo-interpretation
  3613. (default-value 'org-todo-keywords)))))
  3614. (setq kwds (reverse kwds)))
  3615. (setq kwds (nreverse kwds))
  3616. (let (inter kws kw)
  3617. (while (setq kws (pop kwds))
  3618. (let ((kws (or
  3619. (run-hook-with-args-until-success
  3620. 'org-todo-setup-filter-hook kws)
  3621. kws)))
  3622. (setq inter (pop kws) sep (member "|" kws)
  3623. kws0 (delete "|" (copy-sequence kws))
  3624. kwsa nil
  3625. kws1 (mapcar
  3626. (lambda (x)
  3627. ;; 1 2
  3628. (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
  3629. (progn
  3630. (setq kw (match-string 1 x)
  3631. key (and (match-end 2) (match-string 2 x))
  3632. log (org-extract-log-state-settings x))
  3633. (push (cons kw (and key (string-to-char key))) kwsa)
  3634. (and log (push log org-todo-log-states))
  3635. kw)
  3636. (error "Invalid TODO keyword %s" x)))
  3637. kws0)
  3638. kwsa (if kwsa (append '((:startgroup))
  3639. (nreverse kwsa)
  3640. '((:endgroup))))
  3641. hw (car kws1)
  3642. dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
  3643. tail (list inter hw (car dws) (org-last dws))))
  3644. (add-to-list 'org-todo-heads hw 'append)
  3645. (push kws1 org-todo-sets)
  3646. (setq org-done-keywords (append org-done-keywords dws nil))
  3647. (setq org-todo-key-alist (append org-todo-key-alist kwsa))
  3648. (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
  3649. (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
  3650. (setq org-todo-sets (nreverse org-todo-sets)
  3651. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  3652. org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
  3653. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
  3654. ;; Process the constants
  3655. (when const
  3656. (let (e cst)
  3657. (while (setq e (pop const))
  3658. (if (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)" e)
  3659. (push (cons (match-string 1 e) (match-string 2 e)) cst)))
  3660. (setq org-table-formula-constants-local cst)))
  3661. ;; Process the tags.
  3662. (when tags
  3663. (let (e tgs)
  3664. (while (setq e (pop tags))
  3665. (cond
  3666. ((equal e "{") (push '(:startgroup) tgs))
  3667. ((equal e "}") (push '(:endgroup) tgs))
  3668. ((equal e "\\n") (push '(:newline) tgs))
  3669. ((string-match (org-re "^\\([[:alnum:]_@]+\\)(\\(.\\))$") e)
  3670. (push (cons (match-string 1 e)
  3671. (string-to-char (match-string 2 e)))
  3672. tgs))
  3673. (t (push (list e) tgs))))
  3674. (org-set-local 'org-tag-alist nil)
  3675. (while (setq e (pop tgs))
  3676. (or (and (stringp (car e))
  3677. (assoc (car e) org-tag-alist))
  3678. (push e org-tag-alist)))))
  3679. ;; Compute the regular expressions and other local variables
  3680. (if (not org-done-keywords)
  3681. (setq org-done-keywords (and org-todo-keywords-1
  3682. (list (org-last org-todo-keywords-1)))))
  3683. (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
  3684. (length org-scheduled-string)
  3685. (length org-clock-string)
  3686. (length org-closed-string)))
  3687. org-drawer-regexp
  3688. (concat "^[ \t]*:\\("
  3689. (mapconcat 'regexp-quote org-drawers "\\|")
  3690. "\\):[ \t]*$")
  3691. org-not-done-keywords
  3692. (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
  3693. org-todo-regexp
  3694. (concat "\\<\\(" (mapconcat 'regexp-quote org-todo-keywords-1
  3695. "\\|") "\\)\\>")
  3696. org-not-done-regexp
  3697. (concat "\\<\\("
  3698. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  3699. "\\)\\>")
  3700. org-not-done-heading-regexp
  3701. (concat "^\\(\\*+\\)[ \t]+\\("
  3702. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  3703. "\\)\\>")
  3704. org-todo-line-regexp
  3705. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3706. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3707. "\\)\\>\\)?[ \t]*\\(.*\\)")
  3708. org-complex-heading-regexp
  3709. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3710. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3711. "\\)\\>\\)?\\(?:[ \t]*\\(\\[#.\\]\\)\\)?[ \t]*\\(.*?\\)"
  3712. "\\(?:[ \t]+\\(:[[:alnum:]_@:]+:\\)\\)?[ \t]*$")
  3713. org-complex-heading-regexp-format
  3714. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3715. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3716. "\\)\\>\\)?\\(?:[ \t]*\\(\\[#.\\]\\)\\)?[ \t]*\\(%s\\)"
  3717. "\\(?:[ \t]+\\(:[[:alnum:]_@:]+:\\)\\)?[ \t]*$")
  3718. org-nl-done-regexp
  3719. (concat "\n\\*+[ \t]+"
  3720. "\\(?:" (mapconcat 'regexp-quote org-done-keywords "\\|")
  3721. "\\)" "\\>")
  3722. org-todo-line-tags-regexp
  3723. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3724. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3725. (org-re
  3726. "\\)\\>\\)? *\\(.*?\\([ \t]:[[:alnum:]:_@]+:[ \t]*\\)?$\\)"))
  3727. org-looking-at-done-regexp
  3728. (concat "^" "\\(?:"
  3729. (mapconcat 'regexp-quote org-done-keywords "\\|") "\\)"
  3730. "\\>")
  3731. org-deadline-regexp (concat "\\<" org-deadline-string)
  3732. org-deadline-time-regexp
  3733. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  3734. org-deadline-line-regexp
  3735. (concat "\\<\\(" org-deadline-string "\\).*")
  3736. org-scheduled-regexp
  3737. (concat "\\<" org-scheduled-string)
  3738. org-scheduled-time-regexp
  3739. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  3740. org-closed-time-regexp
  3741. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  3742. org-keyword-time-regexp
  3743. (concat "\\<\\(" org-scheduled-string
  3744. "\\|" org-deadline-string
  3745. "\\|" org-closed-string
  3746. "\\|" org-clock-string "\\)"
  3747. " *[[<]\\([^]>]+\\)[]>]")
  3748. org-keyword-time-not-clock-regexp
  3749. (concat "\\<\\(" org-scheduled-string
  3750. "\\|" org-deadline-string
  3751. "\\|" org-closed-string
  3752. "\\)"
  3753. " *[[<]\\([^]>]+\\)[]>]")
  3754. org-maybe-keyword-time-regexp
  3755. (concat "\\(\\<\\(" org-scheduled-string
  3756. "\\|" org-deadline-string
  3757. "\\|" org-closed-string
  3758. "\\|" org-clock-string "\\)\\)?"
  3759. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
  3760. org-planning-or-clock-line-re
  3761. (concat "\\(?:^[ \t]*\\(" org-scheduled-string
  3762. "\\|" org-deadline-string
  3763. "\\|" org-closed-string "\\|" org-clock-string
  3764. "\\)\\>\\)")
  3765. org-all-time-keywords
  3766. (mapcar (lambda (w) (substring w 0 -1))
  3767. (list org-scheduled-string org-deadline-string
  3768. org-clock-string org-closed-string))
  3769. )
  3770. (org-compute-latex-and-specials-regexp)
  3771. (org-set-font-lock-defaults))))
  3772. (defun org-file-contents (file &optional noerror)
  3773. "Return the contents of FILE, as a string."
  3774. (if (or (not file)
  3775. (not (file-readable-p file)))
  3776. (if noerror
  3777. (progn
  3778. (message "Cannot read file %s" file)
  3779. (ding) (sit-for 2)
  3780. "")
  3781. (error "Cannot read file %s" file))
  3782. (with-temp-buffer
  3783. (insert-file-contents file)
  3784. (buffer-string))))
  3785. (defun org-extract-log-state-settings (x)
  3786. "Extract the log state setting from a TODO keyword string.
  3787. This will extract info from a string like \"WAIT(w@/!)\"."
  3788. (let (kw key log1 log2)
  3789. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  3790. (setq kw (match-string 1 x)
  3791. key (and (match-end 2) (match-string 2 x))
  3792. log1 (and (match-end 3) (match-string 3 x))
  3793. log2 (and (match-end 4) (match-string 4 x)))
  3794. (and (or log1 log2)
  3795. (list kw
  3796. (and log1 (if (equal log1 "!") 'time 'note))
  3797. (and log2 (if (equal log2 "!") 'time 'note)))))))
  3798. (defun org-remove-keyword-keys (list)
  3799. "Remove a pair of parenthesis at the end of each string in LIST."
  3800. (mapcar (lambda (x)
  3801. (if (string-match "(.*)$" x)
  3802. (substring x 0 (match-beginning 0))
  3803. x))
  3804. list))
  3805. (defun org-assign-fast-keys (alist)
  3806. "Assign fast keys to a keyword-key alist.
  3807. Respect keys that are already there."
  3808. (let (new e (alt ?0))
  3809. (while (setq e (pop alist))
  3810. (if (or (memq (car e) '(:newline :endgroup :startgroup))
  3811. (cdr e)) ;; Key already assigned.
  3812. (push e new)
  3813. (let ((clist (string-to-list (downcase (car e))))
  3814. (used (append new alist)))
  3815. (when (= (car clist) ?@)
  3816. (pop clist))
  3817. (while (and clist (rassoc (car clist) used))
  3818. (pop clist))
  3819. (unless clist
  3820. (while (rassoc alt used)
  3821. (incf alt)))
  3822. (push (cons (car e) (or (car clist) alt)) new))))
  3823. (nreverse new)))
  3824. ;;; Some variables used in various places
  3825. (defvar org-window-configuration nil
  3826. "Used in various places to store a window configuration.")
  3827. (defvar org-selected-window nil
  3828. "Used in various places to store a window configuration.")
  3829. (defvar org-finish-function nil
  3830. "Function to be called when `C-c C-c' is used.
  3831. This is for getting out of special buffers like remember.")
  3832. ;; FIXME: Occasionally check by commenting these, to make sure
  3833. ;; no other functions uses these, forgetting to let-bind them.
  3834. (defvar entry)
  3835. (defvar last-state)
  3836. (defvar date)
  3837. ;; Defined somewhere in this file, but used before definition.
  3838. (defvar org-entities) ;; defined in org-entities.el
  3839. (defvar org-struct-menu)
  3840. (defvar org-org-menu)
  3841. (defvar org-tbl-menu)
  3842. ;;;; Define the Org-mode
  3843. (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
  3844. (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."))
  3845. ;; We use a before-change function to check if a table might need
  3846. ;; an update.
  3847. (defvar org-table-may-need-update t
  3848. "Indicates that a table might need an update.
  3849. This variable is set by `org-before-change-function'.
  3850. `org-table-align' sets it back to nil.")
  3851. (defun org-before-change-function (beg end)
  3852. "Every change indicates that a table might need an update."
  3853. (setq org-table-may-need-update t))
  3854. (defvar org-mode-map)
  3855. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  3856. (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
  3857. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  3858. (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
  3859. (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
  3860. (defvar org-table-buffer-is-an nil)
  3861. (defconst org-outline-regexp "\\*+ ")
  3862. ;;;###autoload
  3863. (define-derived-mode org-mode outline-mode "Org"
  3864. "Outline-based notes management and organizer, alias
  3865. \"Carsten's outline-mode for keeping track of everything.\"
  3866. Org-mode develops organizational tasks around a NOTES file which
  3867. contains information about projects as plain text. Org-mode is
  3868. implemented on top of outline-mode, which is ideal to keep the content
  3869. of large files well structured. It supports ToDo items, deadlines and
  3870. time stamps, which magically appear in the diary listing of the Emacs
  3871. calendar. Tables are easily created with a built-in table editor.
  3872. Plain text URL-like links connect to websites, emails (VM), Usenet
  3873. messages (Gnus), BBDB entries, and any files related to the project.
  3874. For printing and sharing of notes, an Org-mode file (or a part of it)
  3875. can be exported as a structured ASCII or HTML file.
  3876. The following commands are available:
  3877. \\{org-mode-map}"
  3878. ;; Get rid of Outline menus, they are not needed
  3879. ;; Need to do this here because define-derived-mode sets up
  3880. ;; the keymap so late. Still, it is a waste to call this each time
  3881. ;; we switch another buffer into org-mode.
  3882. (if (featurep 'xemacs)
  3883. (when (boundp 'outline-mode-menu-heading)
  3884. ;; Assume this is Greg's port, it uses easymenu
  3885. (easy-menu-remove outline-mode-menu-heading)
  3886. (easy-menu-remove outline-mode-menu-show)
  3887. (easy-menu-remove outline-mode-menu-hide))
  3888. (define-key org-mode-map [menu-bar headings] 'undefined)
  3889. (define-key org-mode-map [menu-bar hide] 'undefined)
  3890. (define-key org-mode-map [menu-bar show] 'undefined))
  3891. (org-load-modules-maybe)
  3892. (easy-menu-add org-org-menu)
  3893. (easy-menu-add org-tbl-menu)
  3894. (org-install-agenda-files-menu)
  3895. (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
  3896. (add-to-invisibility-spec '(org-cwidth))
  3897. (add-to-invisibility-spec '(org-hide-block . t))
  3898. (when (featurep 'xemacs)
  3899. (org-set-local 'line-move-ignore-invisible t))
  3900. (org-set-local 'outline-regexp org-outline-regexp)
  3901. (org-set-local 'outline-level 'org-outline-level)
  3902. (when (and org-ellipsis
  3903. (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
  3904. (fboundp 'make-glyph-code))
  3905. (unless org-display-table
  3906. (setq org-display-table (make-display-table)))
  3907. (set-display-table-slot
  3908. org-display-table 4
  3909. (vconcat (mapcar
  3910. (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
  3911. org-ellipsis)))
  3912. (if (stringp org-ellipsis) org-ellipsis "..."))))
  3913. (setq buffer-display-table org-display-table))
  3914. (org-set-regexps-and-options)
  3915. (when (and org-tag-faces (not org-tags-special-faces-re))
  3916. ;; tag faces set outside customize.... force initialization.
  3917. (org-set-tag-faces 'org-tag-faces org-tag-faces))
  3918. ;; Calc embedded
  3919. (org-set-local 'calc-embedded-open-mode "# ")
  3920. (modify-syntax-entry ?@ "w")
  3921. (if org-startup-truncated (setq truncate-lines t))
  3922. (org-set-local 'font-lock-unfontify-region-function
  3923. 'org-unfontify-region)
  3924. ;; Activate before-change-function
  3925. (org-set-local 'org-table-may-need-update t)
  3926. (org-add-hook 'before-change-functions 'org-before-change-function nil
  3927. 'local)
  3928. ;; Check for running clock before killing a buffer
  3929. (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  3930. ;; Paragraphs and auto-filling
  3931. (org-set-autofill-regexps)
  3932. (setq indent-line-function 'org-indent-line-function)
  3933. (org-update-radio-target-regexp)
  3934. ;; Make sure dependence stuff works reliably, even for users who set it
  3935. ;; too late :-(
  3936. (if org-enforce-todo-dependencies
  3937. (add-hook 'org-blocker-hook
  3938. 'org-block-todo-from-children-or-siblings-or-parent)
  3939. (remove-hook 'org-blocker-hook
  3940. 'org-block-todo-from-children-or-siblings-or-parent))
  3941. (if org-enforce-todo-checkbox-dependencies
  3942. (add-hook 'org-blocker-hook
  3943. 'org-block-todo-from-checkboxes)
  3944. (remove-hook 'org-blocker-hook
  3945. 'org-block-todo-from-checkboxes))
  3946. ;; Comment characters
  3947. ;; (org-set-local 'comment-start "#")
  3948. (org-set-local 'comment-padding " ")
  3949. (modify-syntax-entry ?# "<")
  3950. ;; (modify-syntax-entry ?\n ">")
  3951. ;; Align options lines
  3952. (org-set-local
  3953. 'align-mode-rules-list
  3954. '((org-in-buffer-settings
  3955. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  3956. (modes . '(org-mode)))))
  3957. ;; Imenu
  3958. (org-set-local 'imenu-create-index-function
  3959. 'org-imenu-get-tree)
  3960. ;; Make isearch reveal context
  3961. (if (or (featurep 'xemacs)
  3962. (not (boundp 'outline-isearch-open-invisible-function)))
  3963. ;; Emacs 21 and XEmacs make use of the hook
  3964. (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
  3965. ;; Emacs 22 deals with this through a special variable
  3966. (org-set-local 'outline-isearch-open-invisible-function
  3967. (lambda (&rest ignore) (org-show-context 'isearch))))
  3968. ;; Turn on org-beamer-mode?
  3969. (and org-startup-with-beamer-mode (org-beamer-mode 1))
  3970. ;; If empty file that did not turn on org-mode automatically, make it to.
  3971. (if (and org-insert-mode-line-in-empty-file
  3972. (interactive-p)
  3973. (= (point-min) (point-max)))
  3974. (insert "# -*- mode: org -*-\n\n"))
  3975. (unless org-inhibit-startup
  3976. (when org-startup-align-all-tables
  3977. (let ((bmp (buffer-modified-p)))
  3978. (org-table-map-tables 'org-table-align 'quietly)
  3979. (set-buffer-modified-p bmp)))
  3980. (when org-startup-indented
  3981. (require 'org-indent)
  3982. (org-indent-mode 1))
  3983. (unless org-inhibit-startup-visibility-stuff
  3984. (org-set-startup-visibility))))
  3985. (when (fboundp 'abbrev-table-put)
  3986. (abbrev-table-put org-mode-abbrev-table
  3987. :parents (list text-mode-abbrev-table)))
  3988. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  3989. (defun org-current-time ()
  3990. "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
  3991. (if (> (car org-time-stamp-rounding-minutes) 1)
  3992. (let ((r (car org-time-stamp-rounding-minutes))
  3993. (time (decode-time)))
  3994. (apply 'encode-time
  3995. (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
  3996. (nthcdr 2 time))))
  3997. (current-time)))
  3998. ;;;; Font-Lock stuff, including the activators
  3999. (defvar org-mouse-map (make-sparse-keymap))
  4000. (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
  4001. (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
  4002. (when org-mouse-1-follows-link
  4003. (org-defkey org-mouse-map [follow-link] 'mouse-face))
  4004. (when org-tab-follows-link
  4005. (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
  4006. (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
  4007. (require 'font-lock)
  4008. (defconst org-non-link-chars "]\t\n\r<>")
  4009. (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
  4010. "shell" "elisp" "doi"))
  4011. (defvar org-link-types-re nil
  4012. "Matches a link that has a url-like prefix like \"http:\"")
  4013. (defvar org-link-re-with-space nil
  4014. "Matches a link with spaces, optional angular brackets around it.")
  4015. (defvar org-link-re-with-space2 nil
  4016. "Matches a link with spaces, optional angular brackets around it.")
  4017. (defvar org-link-re-with-space3 nil
  4018. "Matches a link with spaces, only for internal part in bracket links.")
  4019. (defvar org-angle-link-re nil
  4020. "Matches link with angular brackets, spaces are allowed.")
  4021. (defvar org-plain-link-re nil
  4022. "Matches plain link, without spaces.")
  4023. (defvar org-bracket-link-regexp nil
  4024. "Matches a link in double brackets.")
  4025. (defvar org-bracket-link-analytic-regexp nil
  4026. "Regular expression used to analyze links.
  4027. Here is what the match groups contain after a match:
  4028. 1: http:
  4029. 2: http
  4030. 3: path
  4031. 4: [desc]
  4032. 5: desc")
  4033. (defvar org-bracket-link-analytic-regexp++ nil
  4034. "Like org-bracket-link-analytic-regexp, but include coderef internal type.")
  4035. (defvar org-any-link-re nil
  4036. "Regular expression matching any link.")
  4037. (defun org-make-link-regexps ()
  4038. "Update the link regular expressions.
  4039. This should be called after the variable `org-link-types' has changed."
  4040. (setq org-link-types-re
  4041. (concat
  4042. "\\`\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):")
  4043. org-link-re-with-space
  4044. (concat
  4045. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4046. "\\([^" org-non-link-chars " ]"
  4047. "[^" org-non-link-chars "]*"
  4048. "[^" org-non-link-chars " ]\\)>?")
  4049. org-link-re-with-space2
  4050. (concat
  4051. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4052. "\\([^" org-non-link-chars " ]"
  4053. "[^\t\n\r]*"
  4054. "[^" org-non-link-chars " ]\\)>?")
  4055. org-link-re-with-space3
  4056. (concat
  4057. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4058. "\\([^" org-non-link-chars " ]"
  4059. "[^\t\n\r]*\\)")
  4060. org-angle-link-re
  4061. (concat
  4062. "<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4063. "\\([^" org-non-link-chars " ]"
  4064. "[^" org-non-link-chars "]*"
  4065. "\\)>")
  4066. org-plain-link-re
  4067. (concat
  4068. "\\<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4069. (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
  4070. ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
  4071. org-bracket-link-regexp
  4072. "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
  4073. org-bracket-link-analytic-regexp
  4074. (concat
  4075. "\\[\\["
  4076. "\\(\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):\\)?"
  4077. "\\([^]]+\\)"
  4078. "\\]"
  4079. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4080. "\\]")
  4081. org-bracket-link-analytic-regexp++
  4082. (concat
  4083. "\\[\\["
  4084. "\\(\\(" (mapconcat 'regexp-quote (cons "coderef" org-link-types) "\\|") "\\):\\)?"
  4085. "\\([^]]+\\)"
  4086. "\\]"
  4087. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4088. "\\]")
  4089. org-any-link-re
  4090. (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
  4091. org-angle-link-re "\\)\\|\\("
  4092. org-plain-link-re "\\)")))
  4093. (org-make-link-regexps)
  4094. (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^\r\n>]*?\\)>"
  4095. "Regular expression for fast time stamp matching.")
  4096. (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^\r\n>]*?\\)[]>]"
  4097. "Regular expression for fast time stamp matching.")
  4098. (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4099. "Regular expression matching time strings for analysis.
  4100. This one does not require the space after the date, so it can be used
  4101. on a string that terminates immediately after the date.")
  4102. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4103. "Regular expression matching time strings for analysis.")
  4104. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  4105. "Regular expression matching time stamps, with groups.")
  4106. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  4107. "Regular expression matching time stamps (also [..]), with groups.")
  4108. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  4109. "Regular expression matching a time stamp range.")
  4110. (defconst org-tr-regexp-both
  4111. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  4112. "Regular expression matching a time stamp range.")
  4113. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  4114. org-ts-regexp "\\)?")
  4115. "Regular expression matching a time stamp or time stamp range.")
  4116. (defconst org-tsr-regexp-both (concat org-ts-regexp-both "\\(--?-?"
  4117. org-ts-regexp-both "\\)?")
  4118. "Regular expression matching a time stamp or time stamp range.
  4119. The time stamps may be either active or inactive.")
  4120. (defvar org-emph-face nil)
  4121. (defun org-do-emphasis-faces (limit)
  4122. "Run through the buffer and add overlays to links."
  4123. (let (rtn a)
  4124. (while (and (not rtn) (re-search-forward org-emph-re limit t))
  4125. (if (not (= (char-after (match-beginning 3))
  4126. (char-after (match-beginning 4))))
  4127. (progn
  4128. (setq rtn t)
  4129. (setq a (assoc (match-string 3) org-emphasis-alist))
  4130. (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
  4131. 'face
  4132. (nth 1 a))
  4133. (and (nth 4 a)
  4134. (org-remove-flyspell-overlays-in
  4135. (match-beginning 0) (match-end 0)))
  4136. (add-text-properties (match-beginning 2) (match-end 2)
  4137. '(font-lock-multiline t))
  4138. (when org-hide-emphasis-markers
  4139. (add-text-properties (match-end 4) (match-beginning 5)
  4140. '(invisible org-link))
  4141. (add-text-properties (match-beginning 3) (match-end 3)
  4142. '(invisible org-link)))))
  4143. (backward-char 1))
  4144. rtn))
  4145. (defun org-emphasize (&optional char)
  4146. "Insert or change an emphasis, i.e. a font like bold or italic.
  4147. If there is an active region, change that region to a new emphasis.
  4148. If there is no region, just insert the marker characters and position
  4149. the cursor between them.
  4150. CHAR should be either the marker character, or the first character of the
  4151. HTML tag associated with that emphasis. If CHAR is a space, the means
  4152. to remove the emphasis of the selected region.
  4153. If char is not given (for example in an interactive call) it
  4154. will be prompted for."
  4155. (interactive)
  4156. (let ((eal org-emphasis-alist) e det
  4157. (erc org-emphasis-regexp-components)
  4158. (prompt "")
  4159. (string "") beg end move tag c s)
  4160. (if (org-region-active-p)
  4161. (setq beg (region-beginning) end (region-end)
  4162. string (buffer-substring beg end))
  4163. (setq move t))
  4164. (while (setq e (pop eal))
  4165. (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
  4166. c (aref tag 0))
  4167. (push (cons c (string-to-char (car e))) det)
  4168. (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
  4169. (substring tag 1)))))
  4170. (setq det (nreverse det))
  4171. (unless char
  4172. (message "%s" (concat "Emphasis marker or tag:" prompt))
  4173. (setq char (read-char-exclusive)))
  4174. (setq char (or (cdr (assoc char det)) char))
  4175. (if (equal char ?\ )
  4176. (setq s "" move nil)
  4177. (unless (assoc (char-to-string char) org-emphasis-alist)
  4178. (error "No such emphasis marker: \"%c\"" char))
  4179. (setq s (char-to-string char)))
  4180. (while (and (> (length string) 1)
  4181. (equal (substring string 0 1) (substring string -1))
  4182. (assoc (substring string 0 1) org-emphasis-alist))
  4183. (setq string (substring string 1 -1)))
  4184. (setq string (concat s string s))
  4185. (if beg (delete-region beg end))
  4186. (unless (or (bolp)
  4187. (string-match (concat "[" (nth 0 erc) "\n]")
  4188. (char-to-string (char-before (point)))))
  4189. (insert " "))
  4190. (unless (or (eobp)
  4191. (string-match (concat "[" (nth 1 erc) "\n]")
  4192. (char-to-string (char-after (point)))))
  4193. (insert " ") (backward-char 1))
  4194. (insert string)
  4195. (and move (backward-char 1))))
  4196. (defconst org-nonsticky-props
  4197. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
  4198. (defsubst org-rear-nonsticky-at (pos)
  4199. (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
  4200. (defun org-activate-plain-links (limit)
  4201. "Run through the buffer and add overlays to links."
  4202. (catch 'exit
  4203. (let (f)
  4204. (if (re-search-forward org-plain-link-re limit t)
  4205. (progn
  4206. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4207. (setq f (get-text-property (match-beginning 0) 'face))
  4208. (if (or (eq f 'org-tag)
  4209. (and (listp f) (memq 'org-tag f)))
  4210. nil
  4211. (add-text-properties (match-beginning 0) (match-end 0)
  4212. (list 'mouse-face 'highlight
  4213. 'face 'org-link
  4214. 'keymap org-mouse-map))
  4215. (org-rear-nonsticky-at (match-end 0)))
  4216. t)))))
  4217. (defun org-activate-code (limit)
  4218. (if (re-search-forward "^[ \t]*\\(: .*\n?\\)" limit t)
  4219. (progn
  4220. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4221. (remove-text-properties (match-beginning 0) (match-end 0)
  4222. '(display t invisible t intangible t))
  4223. t)))
  4224. (defun org-fontify-meta-lines-and-blocks (limit)
  4225. "Fontify #+ lines and blocks, in the correct ways."
  4226. (let ((case-fold-search t))
  4227. (if (re-search-forward
  4228. "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)\\(.*\\)\\)"
  4229. limit t)
  4230. (let ((beg (match-beginning 0))
  4231. (beg1 (line-beginning-position 2))
  4232. (dc1 (downcase (match-string 2)))
  4233. (dc3 (downcase (match-string 3)))
  4234. end end1 quoting block-type)
  4235. (cond
  4236. ((member dc1 '("html:" "ascii:" "latex:" "docbook:"))
  4237. ;; a single line of backend-specific content
  4238. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4239. (remove-text-properties (match-beginning 0) (match-end 0)
  4240. '(display t invisible t intangible t))
  4241. (add-text-properties (match-beginning 1) (match-end 3)
  4242. '(font-lock-fontified t face org-meta-line))
  4243. (add-text-properties (match-beginning 6) (match-end 6)
  4244. '(font-lock-fontified t face org-block))
  4245. t)
  4246. ((and (match-end 4) (equal dc3 "begin"))
  4247. ;; Truly a block
  4248. (setq block-type (downcase (match-string 5))
  4249. quoting (member block-type org-protecting-blocks))
  4250. (when (re-search-forward
  4251. (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
  4252. nil t) ;; on purpose, we look further than LIMIT
  4253. (setq end (match-end 0) end1 (1- (match-beginning 0)))
  4254. (when quoting
  4255. (remove-text-properties beg end
  4256. '(display t invisible t intangible t)))
  4257. (add-text-properties
  4258. beg end
  4259. '(font-lock-fontified t font-lock-multiline t))
  4260. (add-text-properties beg beg1 '(face org-meta-line))
  4261. (add-text-properties end1 end '(face org-meta-line))
  4262. (cond
  4263. (quoting
  4264. (add-text-properties beg1 end1 '(face org-block)))
  4265. ((not org-fontify-quote-and-verse-blocks))
  4266. ((string= block-type "quote")
  4267. (add-text-properties beg1 end1 '(face org-quote)))
  4268. ((string= block-type "verse")
  4269. (add-text-properties beg1 end1 '(face org-verse))))
  4270. t))
  4271. ((member dc1 '("title:" "author:" "email:" "date:"))
  4272. (add-text-properties
  4273. beg (match-end 3)
  4274. (if (member (intern (substring dc1 0 -1)) org-hidden-keywords)
  4275. '(font-lock-fontified t invisible t)
  4276. '(font-lock-fontified t face org-document-info-keyword)))
  4277. (add-text-properties
  4278. (match-beginning 6) (match-end 6)
  4279. (if (string-equal dc1 "title:")
  4280. '(font-lock-fontified t face org-document-title)
  4281. '(font-lock-fontified t face org-document-info))))
  4282. ((not (member (char-after beg) '(?\ ?\t)))
  4283. ;; just any other in-buffer setting, but not indented
  4284. (add-text-properties
  4285. beg (match-end 0)
  4286. '(font-lock-fontified t face org-meta-line))
  4287. t)
  4288. ((or (member dc1 '("begin:" "end:" "caption:" "label:"
  4289. "orgtbl:" "tblfm:" "tblname:"))
  4290. (and (match-end 4) (equal dc3 "attr")))
  4291. (add-text-properties
  4292. beg (match-end 0)
  4293. '(font-lock-fontified t face org-meta-line))
  4294. t)
  4295. ((member dc3 '(" " ""))
  4296. (add-text-properties
  4297. beg (match-end 0)
  4298. '(font-lock-fontified t face font-lock-comment-face)))
  4299. (t nil))))))
  4300. (defun org-activate-angle-links (limit)
  4301. "Run through the buffer and add overlays to links."
  4302. (if (re-search-forward org-angle-link-re limit t)
  4303. (progn
  4304. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4305. (add-text-properties (match-beginning 0) (match-end 0)
  4306. (list 'mouse-face 'highlight
  4307. 'keymap org-mouse-map))
  4308. (org-rear-nonsticky-at (match-end 0))
  4309. t)))
  4310. (defun org-activate-footnote-links (limit)
  4311. "Run through the buffer and add overlays to links."
  4312. (if (re-search-forward "\\(^\\|[^][]\\)\\(\\[\\([0-9]+\\]\\|fn:[^ \t\r\n:]+?[]:]\\)\\)"
  4313. limit t)
  4314. (progn
  4315. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4316. (add-text-properties (match-beginning 2) (match-end 2)
  4317. (list 'mouse-face 'highlight
  4318. 'keymap org-mouse-map
  4319. 'help-echo
  4320. (if (= (point-at-bol) (match-beginning 2))
  4321. "Footnote definition"
  4322. "Footnote reference")
  4323. ))
  4324. (org-rear-nonsticky-at (match-end 2))
  4325. t)))
  4326. (defun org-activate-bracket-links (limit)
  4327. "Run through the buffer and add overlays to bracketed links."
  4328. (if (re-search-forward org-bracket-link-regexp limit t)
  4329. (let* ((help (concat "LINK: "
  4330. (org-match-string-no-properties 1)))
  4331. ;; FIXME: above we should remove the escapes.
  4332. ;; but that requires another match, protecting match data,
  4333. ;; a lot of overhead for font-lock.
  4334. (ip (org-maybe-intangible
  4335. (list 'invisible 'org-link
  4336. 'keymap org-mouse-map 'mouse-face 'highlight
  4337. 'font-lock-multiline t 'help-echo help)))
  4338. (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
  4339. 'font-lock-multiline t 'help-echo help)))
  4340. ;; We need to remove the invisible property here. Table narrowing
  4341. ;; may have made some of this invisible.
  4342. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4343. (remove-text-properties (match-beginning 0) (match-end 0)
  4344. '(invisible nil))
  4345. (if (match-end 3)
  4346. (progn
  4347. (add-text-properties (match-beginning 0) (match-beginning 3) ip)
  4348. (org-rear-nonsticky-at (match-beginning 3))
  4349. (add-text-properties (match-beginning 3) (match-end 3) vp)
  4350. (org-rear-nonsticky-at (match-end 3))
  4351. (add-text-properties (match-end 3) (match-end 0) ip)
  4352. (org-rear-nonsticky-at (match-end 0)))
  4353. (add-text-properties (match-beginning 0) (match-beginning 1) ip)
  4354. (org-rear-nonsticky-at (match-beginning 1))
  4355. (add-text-properties (match-beginning 1) (match-end 1) vp)
  4356. (org-rear-nonsticky-at (match-end 1))
  4357. (add-text-properties (match-end 1) (match-end 0) ip)
  4358. (org-rear-nonsticky-at (match-end 0)))
  4359. t)))
  4360. (defun org-activate-dates (limit)
  4361. "Run through the buffer and add overlays to dates."
  4362. (if (re-search-forward org-tsr-regexp-both limit t)
  4363. (progn
  4364. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4365. (add-text-properties (match-beginning 0) (match-end 0)
  4366. (list 'mouse-face 'highlight
  4367. 'keymap org-mouse-map))
  4368. (org-rear-nonsticky-at (match-end 0))
  4369. (when org-display-custom-times
  4370. (if (match-end 3)
  4371. (org-display-custom-time (match-beginning 3) (match-end 3)))
  4372. (org-display-custom-time (match-beginning 1) (match-end 1)))
  4373. t)))
  4374. (defvar org-target-link-regexp nil
  4375. "Regular expression matching radio targets in plain text.")
  4376. (make-variable-buffer-local 'org-target-link-regexp)
  4377. (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
  4378. "Regular expression matching a link target.")
  4379. (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
  4380. "Regular expression matching a radio target.")
  4381. (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
  4382. "Regular expression matching any target.")
  4383. (defun org-activate-target-links (limit)
  4384. "Run through the buffer and add overlays to target matches."
  4385. (when org-target-link-regexp
  4386. (let ((case-fold-search t))
  4387. (if (re-search-forward org-target-link-regexp limit t)
  4388. (progn
  4389. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4390. (add-text-properties (match-beginning 0) (match-end 0)
  4391. (list 'mouse-face 'highlight
  4392. 'keymap org-mouse-map
  4393. 'help-echo "Radio target link"
  4394. 'org-linked-text t))
  4395. (org-rear-nonsticky-at (match-end 0))
  4396. t)))))
  4397. (defun org-update-radio-target-regexp ()
  4398. "Find all radio targets in this file and update the regular expression."
  4399. (interactive)
  4400. (when (memq 'radio org-activate-links)
  4401. (setq org-target-link-regexp
  4402. (org-make-target-link-regexp (org-all-targets 'radio)))
  4403. (org-restart-font-lock)))
  4404. (defun org-hide-wide-columns (limit)
  4405. (let (s e)
  4406. (setq s (text-property-any (point) (or limit (point-max))
  4407. 'org-cwidth t))
  4408. (when s
  4409. (setq e (next-single-property-change s 'org-cwidth))
  4410. (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
  4411. (goto-char e)
  4412. t)))
  4413. (defvar org-latex-and-specials-regexp nil
  4414. "Regular expression for highlighting export special stuff.")
  4415. (defvar org-match-substring-regexp)
  4416. (defvar org-match-substring-with-braces-regexp)
  4417. ;; This should be with the exporter code, but we also use if for font-locking
  4418. (defconst org-export-html-special-string-regexps
  4419. '(("\\\\-" . "&shy;")
  4420. ("---\\([^-]\\)" . "&mdash;\\1")
  4421. ("--\\([^-]\\)" . "&ndash;\\1")
  4422. ("\\.\\.\\." . "&hellip;"))
  4423. "Regular expressions for special string conversion.")
  4424. (defun org-compute-latex-and-specials-regexp ()
  4425. "Compute regular expression for stuff treated specially by exporters."
  4426. (if (not org-highlight-latex-fragments-and-specials)
  4427. (org-set-local 'org-latex-and-specials-regexp nil)
  4428. (require 'org-exp)
  4429. (let*
  4430. ((matchers (plist-get org-format-latex-options :matchers))
  4431. (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
  4432. org-latex-regexps)))
  4433. (org-export-allow-BIND nil)
  4434. (options (org-combine-plists (org-default-export-plist)
  4435. (org-infile-export-plist)))
  4436. (org-export-with-sub-superscripts (plist-get options :sub-superscript))
  4437. (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
  4438. (org-export-with-TeX-macros (plist-get options :TeX-macros))
  4439. (org-export-html-expand (plist-get options :expand-quoted-html))
  4440. (org-export-with-special-strings (plist-get options :special-strings))
  4441. (re-sub
  4442. (cond
  4443. ((equal org-export-with-sub-superscripts '{})
  4444. (list org-match-substring-with-braces-regexp))
  4445. (org-export-with-sub-superscripts
  4446. (list org-match-substring-regexp))
  4447. (t nil)))
  4448. (re-latex
  4449. (if org-export-with-LaTeX-fragments
  4450. (mapcar (lambda (x) (nth 1 x)) latexs)))
  4451. (re-macros
  4452. (if org-export-with-TeX-macros
  4453. (list (concat "\\\\"
  4454. (regexp-opt
  4455. (append (mapcar 'car (append org-entities-user
  4456. org-entities))
  4457. (if (boundp 'org-latex-entities)
  4458. (mapcar (lambda (x)
  4459. (or (car-safe x) x))
  4460. org-latex-entities)
  4461. nil))
  4462. 'words))) ; FIXME
  4463. ))
  4464. ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
  4465. (re-special (if org-export-with-special-strings
  4466. (mapcar (lambda (x) (car x))
  4467. org-export-html-special-string-regexps)))
  4468. (re-rest
  4469. (delq nil
  4470. (list
  4471. (if org-export-html-expand "@<[^>\n]+>")
  4472. ))))
  4473. (org-set-local
  4474. 'org-latex-and-specials-regexp
  4475. (mapconcat 'identity (append re-latex re-sub re-macros re-special
  4476. re-rest) "\\|")))))
  4477. (defun org-do-latex-and-special-faces (limit)
  4478. "Run through the buffer and add overlays to links."
  4479. (when org-latex-and-specials-regexp
  4480. (let (rtn d)
  4481. (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
  4482. limit t))
  4483. (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
  4484. 'face))
  4485. '(org-code org-verbatim underline)))
  4486. (progn
  4487. (setq rtn t
  4488. d (cond ((member (char-after (1+ (match-beginning 0)))
  4489. '(?_ ?^)) 1)
  4490. (t 0)))
  4491. (font-lock-prepend-text-property
  4492. (+ d (match-beginning 0)) (match-end 0)
  4493. 'face 'org-latex-and-export-specials)
  4494. (add-text-properties (+ d (match-beginning 0)) (match-end 0)
  4495. '(font-lock-multiline t)))))
  4496. rtn)))
  4497. (defun org-restart-font-lock ()
  4498. "Restart font-lock-mode, to force refontification."
  4499. (when (and (boundp 'font-lock-mode) font-lock-mode)
  4500. (font-lock-mode -1)
  4501. (font-lock-mode 1)))
  4502. (defun org-all-targets (&optional radio)
  4503. "Return a list of all targets in this file.
  4504. With optional argument RADIO, only find radio targets."
  4505. (let ((re (if radio org-radio-target-regexp org-target-regexp))
  4506. rtn)
  4507. (save-excursion
  4508. (goto-char (point-min))
  4509. (while (re-search-forward re nil t)
  4510. (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
  4511. rtn)))
  4512. (defun org-make-target-link-regexp (targets)
  4513. "Make regular expression matching all strings in TARGETS.
  4514. The regular expression finds the targets also if there is a line break
  4515. between words."
  4516. (and targets
  4517. (concat
  4518. "\\<\\("
  4519. (mapconcat
  4520. (lambda (x)
  4521. (while (string-match " +" x)
  4522. (setq x (replace-match "\\s-+" t t x)))
  4523. x)
  4524. targets
  4525. "\\|")
  4526. "\\)\\>")))
  4527. (defun org-activate-tags (limit)
  4528. (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \r\n]") limit t)
  4529. (progn
  4530. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  4531. (add-text-properties (match-beginning 1) (match-end 1)
  4532. (list 'mouse-face 'highlight
  4533. 'keymap org-mouse-map))
  4534. (org-rear-nonsticky-at (match-end 1))
  4535. t)))
  4536. (defun org-outline-level ()
  4537. "Compute the outline level of the heading at point.
  4538. This function assumes that the cursor is at the beginning of a line matched
  4539. by outline-regexp. Otherwise it returns garbage.
  4540. If this is called at a normal headline, the level is the number of stars.
  4541. Use `org-reduced-level' to remove the effect of `org-odd-levels'.
  4542. For plain list items, if they are matched by `outline-regexp', this returns
  4543. 1000 plus the line indentation."
  4544. (save-excursion
  4545. (looking-at outline-regexp)
  4546. (if (match-beginning 1)
  4547. (+ (org-get-string-indentation (match-string 1)) 1000)
  4548. (1- (- (match-end 0) (match-beginning 0))))))
  4549. (defvar org-font-lock-keywords nil)
  4550. (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
  4551. "Regular expression matching a property line.")
  4552. (defvar org-font-lock-hook nil
  4553. "Functions to be called for special font lock stuff.")
  4554. (defun org-font-lock-hook (limit)
  4555. (run-hook-with-args 'org-font-lock-hook limit))
  4556. (defun org-set-font-lock-defaults ()
  4557. (let* ((em org-fontify-emphasized-text)
  4558. (lk org-activate-links)
  4559. (org-font-lock-extra-keywords
  4560. (list
  4561. ;; Call the hook
  4562. '(org-font-lock-hook)
  4563. ;; Headlines
  4564. `(,(if org-fontify-whole-heading-line
  4565. "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
  4566. "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
  4567. (1 (org-get-level-face 1))
  4568. (2 (org-get-level-face 2))
  4569. (3 (org-get-level-face 3)))
  4570. ;; Table lines
  4571. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  4572. (1 'org-table t))
  4573. ;; Table internals
  4574. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  4575. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  4576. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  4577. '("| *\\(<[lr]?[0-9]*>\\)" (1 'org-formula t))
  4578. ;; Drawers
  4579. (list org-drawer-regexp '(0 'org-special-keyword t))
  4580. (list "^[ \t]*:END:" '(0 'org-special-keyword t))
  4581. ;; Properties
  4582. (list org-property-re
  4583. '(1 'org-special-keyword t)
  4584. '(3 'org-property-value t))
  4585. ;; Links
  4586. (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
  4587. (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
  4588. (if (memq 'plain lk) '(org-activate-plain-links))
  4589. (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
  4590. (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
  4591. (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
  4592. (if (memq 'footnote lk) '(org-activate-footnote-links
  4593. (2 'org-footnote t)))
  4594. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  4595. '(org-hide-wide-columns (0 nil append))
  4596. ;; TODO lines
  4597. (list (concat "^\\*+[ \t]+" org-todo-regexp "\\([ \t]\\|$\\)")
  4598. '(1 (org-get-todo-face 1) t))
  4599. ;; DONE
  4600. (if org-fontify-done-headline
  4601. (list (concat "^[*]+ +\\<\\("
  4602. (mapconcat 'regexp-quote org-done-keywords "\\|")
  4603. "\\)\\(.*\\)")
  4604. '(2 'org-headline-done t))
  4605. nil)
  4606. ;; Priorities
  4607. '(org-font-lock-add-priority-faces)
  4608. ;; Tags
  4609. '(org-font-lock-add-tag-faces)
  4610. ;; Special keywords
  4611. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  4612. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  4613. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  4614. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  4615. ;; Emphasis
  4616. (if em
  4617. (if (featurep 'xemacs)
  4618. '(org-do-emphasis-faces (0 nil append))
  4619. '(org-do-emphasis-faces)))
  4620. ;; Checkboxes
  4621. '("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(\\[[- X]\\]\\)"
  4622. 2 'org-checkbox prepend)
  4623. (if org-provide-checkbox-statistics
  4624. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  4625. (0 (org-get-checkbox-statistics-face) t)))
  4626. ;; Description list items
  4627. '("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(.*? ::\\)"
  4628. 2 'bold prepend)
  4629. ;; ARCHIVEd headings
  4630. (list (concat "^\\*+ \\(.*:" org-archive-tag ":.*\\)")
  4631. '(1 'org-archived prepend))
  4632. ;; Specials
  4633. '(org-do-latex-and-special-faces)
  4634. ;; Code
  4635. '(org-activate-code (1 'org-code t))
  4636. ;; COMMENT
  4637. (list (concat "^\\*+[ \t]+\\<\\(" org-comment-string
  4638. "\\|" org-quote-string "\\)\\>")
  4639. '(1 'org-special-keyword t))
  4640. '("^#.*" (0 'font-lock-comment-face t))
  4641. ;; Blocks and meta lines
  4642. '(org-fontify-meta-lines-and-blocks)
  4643. )))
  4644. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  4645. ;; Now set the full font-lock-keywords
  4646. (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
  4647. (org-set-local 'font-lock-defaults
  4648. '(org-font-lock-keywords t nil nil backward-paragraph))
  4649. (kill-local-variable 'font-lock-keywords) nil))
  4650. (defun org-fontify-like-in-org-mode (s &optional odd-levels)
  4651. "Fontify string S like in Org-mode"
  4652. (with-temp-buffer
  4653. (insert s)
  4654. (let ((org-odd-levels-only odd-levels))
  4655. (org-mode)
  4656. (font-lock-fontify-buffer)
  4657. (buffer-string))))
  4658. (defvar org-m nil)
  4659. (defvar org-l nil)
  4660. (defvar org-f nil)
  4661. (defun org-get-level-face (n)
  4662. "Get the right face for match N in font-lock matching of headlines."
  4663. (setq org-l (- (match-end 2) (match-beginning 1) 1))
  4664. (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
  4665. (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
  4666. (cond
  4667. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  4668. ((eq n 2) org-f)
  4669. (t (if org-level-color-stars-only nil org-f))))
  4670. (defun org-get-todo-face (kwd)
  4671. "Get the right face for a TODO keyword KWD.
  4672. If KWD is a number, get the corresponding match group."
  4673. (if (numberp kwd) (setq kwd (match-string kwd)))
  4674. (or (org-face-from-face-or-color
  4675. 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
  4676. (and (member kwd org-done-keywords) 'org-done)
  4677. 'org-todo))
  4678. (defun org-face-from-face-or-color (context inherit face-or-color)
  4679. "Create a face list that inherits INHERIT, but sets the foreground color.
  4680. When FACE-OR-COLOR is not a string, just return it."
  4681. (if (stringp face-or-color)
  4682. (list :inherit inherit
  4683. (cdr (assoc context org-faces-easy-properties))
  4684. face-or-color)
  4685. face-or-color))
  4686. (defun org-font-lock-add-tag-faces (limit)
  4687. "Add the special tag faces."
  4688. (when (and org-tag-faces org-tags-special-faces-re)
  4689. (while (re-search-forward org-tags-special-faces-re limit t)
  4690. (add-text-properties (match-beginning 1) (match-end 1)
  4691. (list 'face (org-get-tag-face 1)
  4692. 'font-lock-fontified t))
  4693. (backward-char 1))))
  4694. (defun org-font-lock-add-priority-faces (limit)
  4695. "Add the special priority faces."
  4696. (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
  4697. (add-text-properties
  4698. (match-beginning 0) (match-end 0)
  4699. (list 'face (or (org-face-from-face-or-color
  4700. 'priority 'org-special-keyword
  4701. (cdr (assoc (char-after (match-beginning 1))
  4702. org-priority-faces)))
  4703. 'org-special-keyword)
  4704. 'font-lock-fontified t))))
  4705. (defun org-get-tag-face (kwd)
  4706. "Get the right face for a TODO keyword KWD.
  4707. If KWD is a number, get the corresponding match group."
  4708. (if (numberp kwd) (setq kwd (match-string kwd)))
  4709. (or (org-face-from-face-or-color
  4710. 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
  4711. 'org-tag))
  4712. (defun org-unfontify-region (beg end &optional maybe_loudly)
  4713. "Remove fontification and activation overlays from links."
  4714. (font-lock-default-unfontify-region beg end)
  4715. (let* ((buffer-undo-list t)
  4716. (inhibit-read-only t) (inhibit-point-motion-hooks t)
  4717. (inhibit-modification-hooks t)
  4718. deactivate-mark buffer-file-name buffer-file-truename)
  4719. (remove-text-properties
  4720. beg end
  4721. (if org-indent-mode
  4722. ;; also remove line-prefix and wrap-prefix properties
  4723. '(mouse-face t keymap t org-linked-text t
  4724. invisible t intangible t
  4725. line-prefix t wrap-prefix t
  4726. org-no-flyspell t)
  4727. '(mouse-face t keymap t org-linked-text t
  4728. invisible t intangible t
  4729. org-no-flyspell t)))))
  4730. ;;;; Visibility cycling, including org-goto and indirect buffer
  4731. ;;; Cycling
  4732. (defvar org-cycle-global-status nil)
  4733. (make-variable-buffer-local 'org-cycle-global-status)
  4734. (defvar org-cycle-subtree-status nil)
  4735. (make-variable-buffer-local 'org-cycle-subtree-status)
  4736. ;;;###autoload
  4737. (defvar org-inlinetask-min-level)
  4738. (defun org-cycle (&optional arg)
  4739. "TAB-action and visibility cycling for Org-mode.
  4740. This is the command invoked in Org-mode by the TAB key. Its main purpose
  4741. is outline visibility cycling, but it also invokes other actions
  4742. in special contexts.
  4743. - When this function is called with a prefix argument, rotate the entire
  4744. buffer through 3 states (global cycling)
  4745. 1. OVERVIEW: Show only top-level headlines.
  4746. 2. CONTENTS: Show all headlines of all levels, but no body text.
  4747. 3. SHOW ALL: Show everything.
  4748. When called with two `C-u C-u' prefixes, switch to the startup visibility,
  4749. determined by the variable `org-startup-folded', and by any VISIBILITY
  4750. properties in the buffer.
  4751. When called with three `C-u C-u C-u' prefixed, show the entire buffer,
  4752. including any drawers.
  4753. - When inside a table, re-align the table and move to the next field.
  4754. - When point is at the beginning of a headline, rotate the subtree started
  4755. by this line through 3 different states (local cycling)
  4756. 1. FOLDED: Only the main headline is shown.
  4757. 2. CHILDREN: The main headline and the direct children are shown.
  4758. From this state, you can move to one of the children
  4759. and zoom in further.
  4760. 3. SUBTREE: Show the entire subtree, including body text.
  4761. If there is no subtree, switch directly from CHILDREN to FOLDED.
  4762. - When point is at the beginning of an empty headline and the variable
  4763. `org-cycle-level-after-item/entry-creation' is set, cycle the level
  4764. of the headline by demoting and promoting it to likely levels. This
  4765. speeds up creation document structure by presing TAB once or several
  4766. times right after creating a new headline.
  4767. - When there is a numeric prefix, go up to a heading with level ARG, do
  4768. a `show-subtree' and return to the previous cursor position. If ARG
  4769. is negative, go up that many levels.
  4770. - When point is not at the beginning of a headline, execute the global
  4771. binding for TAB, which is re-indenting the line. See the option
  4772. `org-cycle-emulate-tab' for details.
  4773. - Special case: if point is at the beginning of the buffer and there is
  4774. no headline in line 1, this function will act as if called with prefix arg.
  4775. But only if also the variable `org-cycle-global-at-bob' is t."
  4776. (interactive "P")
  4777. (org-load-modules-maybe)
  4778. (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
  4779. (and org-cycle-level-after-item/entry-creation
  4780. (or (org-cycle-level)
  4781. (org-cycle-item-indentation))))
  4782. (let* ((limit-level
  4783. (or org-cycle-max-level
  4784. (and (boundp 'org-inlinetask-min-level)
  4785. org-inlinetask-min-level
  4786. (1- org-inlinetask-min-level))))
  4787. (nstars (and limit-level
  4788. (if org-odd-levels-only
  4789. (and limit-level (1- (* limit-level 2)))
  4790. limit-level)))
  4791. (outline-regexp
  4792. (cond
  4793. ((not (org-mode-p)) outline-regexp)
  4794. ((or (eq org-cycle-include-plain-lists 'integrate)
  4795. (and org-cycle-include-plain-lists (org-at-item-p)))
  4796. (concat "\\(?:\\*"
  4797. (if nstars (format "\\{1,%d\\}" nstars) "+")
  4798. " \\|\\([ \t]*\\)\\([-+*]\\|[0-9]+[.)]\\) \\)"))
  4799. (t (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ ")))))
  4800. (bob-special (and org-cycle-global-at-bob (bobp)
  4801. (not (looking-at outline-regexp))))
  4802. (org-cycle-hook
  4803. (if bob-special
  4804. (delq 'org-optimize-window-after-visibility-change
  4805. (copy-sequence org-cycle-hook))
  4806. org-cycle-hook))
  4807. (pos (point)))
  4808. (if (or bob-special (equal arg '(4)))
  4809. ;; special case: use global cycling
  4810. (setq arg t))
  4811. (cond
  4812. ((equal arg '(16))
  4813. (org-set-startup-visibility)
  4814. (message "Startup visibility, plus VISIBILITY properties"))
  4815. ((equal arg '(64))
  4816. (show-all)
  4817. (message "Entire buffer visible, including drawers"))
  4818. ((org-at-table-p 'any)
  4819. ;; Enter the table or move to the next field in the table
  4820. (if (org-at-table.el-p)
  4821. (message "Use C-c ' to edit table.el tables")
  4822. (if arg (org-table-edit-field t)
  4823. (org-table-justify-field-maybe)
  4824. (call-interactively 'org-table-next-field))))
  4825. ((run-hook-with-args-until-success
  4826. 'org-tab-after-check-for-table-hook))
  4827. ((eq arg t) ;; Global cycling
  4828. (org-cycle-internal-global))
  4829. ((and org-drawers org-drawer-regexp
  4830. (save-excursion
  4831. (beginning-of-line 1)
  4832. (looking-at org-drawer-regexp)))
  4833. ;; Toggle block visibility
  4834. (org-flag-drawer
  4835. (not (get-char-property (match-end 0) 'invisible))))
  4836. ((integerp arg)
  4837. ;; Show-subtree, ARG levels up from here.
  4838. (save-excursion
  4839. (org-back-to-heading)
  4840. (outline-up-heading (if (< arg 0) (- arg)
  4841. (- (funcall outline-level) arg)))
  4842. (org-show-subtree)))
  4843. ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
  4844. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  4845. (org-cycle-internal-local))
  4846. ;; TAB emulation and template completion
  4847. (buffer-read-only (org-back-to-heading))
  4848. ((run-hook-with-args-until-success
  4849. 'org-tab-after-check-for-cycling-hook))
  4850. ((org-try-structure-completion))
  4851. ((org-try-cdlatex-tab))
  4852. ((run-hook-with-args-until-success
  4853. 'org-tab-before-tab-emulation-hook))
  4854. ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
  4855. (or (not (bolp))
  4856. (not (looking-at outline-regexp))))
  4857. (call-interactively (global-key-binding "\t")))
  4858. ((if (and (memq org-cycle-emulate-tab '(white whitestart))
  4859. (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
  4860. (or (and (eq org-cycle-emulate-tab 'white)
  4861. (= (match-end 0) (point-at-eol)))
  4862. (and (eq org-cycle-emulate-tab 'whitestart)
  4863. (>= (match-end 0) pos))))
  4864. t
  4865. (eq org-cycle-emulate-tab t))
  4866. (call-interactively (global-key-binding "\t")))
  4867. (t (save-excursion
  4868. (org-back-to-heading)
  4869. (org-cycle)))))))
  4870. (defun org-cycle-internal-global ()
  4871. "Do the global cycling action."
  4872. (cond
  4873. ((and (eq last-command this-command)
  4874. (eq org-cycle-global-status 'overview))
  4875. ;; We just created the overview - now do table of contents
  4876. ;; This can be slow in very large buffers, so indicate action
  4877. (run-hook-with-args 'org-pre-cycle-hook 'contents)
  4878. (message "CONTENTS...")
  4879. (org-content)
  4880. (message "CONTENTS...done")
  4881. (setq org-cycle-global-status 'contents)
  4882. (run-hook-with-args 'org-cycle-hook 'contents))
  4883. ((and (eq last-command this-command)
  4884. (eq org-cycle-global-status 'contents))
  4885. ;; We just showed the table of contents - now show everything
  4886. (run-hook-with-args 'org-pre-cycle-hook 'all)
  4887. (show-all)
  4888. (message "SHOW ALL")
  4889. (setq org-cycle-global-status 'all)
  4890. (run-hook-with-args 'org-cycle-hook 'all))
  4891. (t
  4892. ;; Default action: go to overview
  4893. (run-hook-with-args 'org-pre-cycle-hook 'overview)
  4894. (org-overview)
  4895. (message "OVERVIEW")
  4896. (setq org-cycle-global-status 'overview)
  4897. (run-hook-with-args 'org-cycle-hook 'overview))))
  4898. (defun org-cycle-internal-local ()
  4899. "Do the local cycling action."
  4900. (org-back-to-heading)
  4901. (let ((goal-column 0) eoh eol eos level has-children children-skipped)
  4902. ;; First, some boundaries
  4903. (save-excursion
  4904. (org-back-to-heading)
  4905. (setq level (funcall outline-level))
  4906. (save-excursion
  4907. (beginning-of-line 2)
  4908. (if (or (featurep 'xemacs) (<= emacs-major-version 21))
  4909. ; XEmacs does not have `next-single-char-property-change'
  4910. ; I'm not sure about Emacs 21.
  4911. (while (and (not (eobp)) ;; this is like `next-line'
  4912. (get-char-property (1- (point)) 'invisible))
  4913. (beginning-of-line 2))
  4914. (while (and (not (eobp)) ;; this is like `next-line'
  4915. (get-char-property (1- (point)) 'invisible))
  4916. (goto-char (next-single-char-property-change (point) 'invisible))
  4917. (and (eolp) (beginning-of-line 2))))
  4918. (setq eol (point)))
  4919. (outline-end-of-heading) (setq eoh (point))
  4920. (save-excursion
  4921. (outline-next-heading)
  4922. (setq has-children (and (org-at-heading-p t)
  4923. (> (funcall outline-level) level))))
  4924. (org-end-of-subtree t)
  4925. (unless (eobp)
  4926. (skip-chars-forward " \t\n")
  4927. (beginning-of-line 1) ; in case this is an item
  4928. )
  4929. (setq eos (if (eobp) (point) (1- (point)))))
  4930. ;; Find out what to do next and set `this-command'
  4931. (cond
  4932. ((= eos eoh)
  4933. ;; Nothing is hidden behind this heading
  4934. (run-hook-with-args 'org-pre-cycle-hook 'empty)
  4935. (message "EMPTY ENTRY")
  4936. (setq org-cycle-subtree-status nil)
  4937. (save-excursion
  4938. (goto-char eos)
  4939. (outline-next-heading)
  4940. (if (org-invisible-p) (org-flag-heading nil))))
  4941. ((and (or (>= eol eos)
  4942. (not (string-match "\\S-" (buffer-substring eol eos))))
  4943. (or has-children
  4944. (not (setq children-skipped
  4945. org-cycle-skip-children-state-if-no-children))))
  4946. ;; Entire subtree is hidden in one line: children view
  4947. (run-hook-with-args 'org-pre-cycle-hook 'children)
  4948. (org-show-entry)
  4949. (show-children)
  4950. (message "CHILDREN")
  4951. (save-excursion
  4952. (goto-char eos)
  4953. (outline-next-heading)
  4954. (if (org-invisible-p) (org-flag-heading nil)))
  4955. (setq org-cycle-subtree-status 'children)
  4956. (run-hook-with-args 'org-cycle-hook 'children))
  4957. ((or children-skipped
  4958. (and (eq last-command this-command)
  4959. (eq org-cycle-subtree-status 'children)))
  4960. ;; We just showed the children, or no children are there,
  4961. ;; now show everything.
  4962. (run-hook-with-args 'org-pre-cycle-hook 'subtree)
  4963. (org-show-subtree)
  4964. (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
  4965. (setq org-cycle-subtree-status 'subtree)
  4966. (run-hook-with-args 'org-cycle-hook 'subtree))
  4967. (t
  4968. ;; Default action: hide the subtree.
  4969. (run-hook-with-args 'org-pre-cycle-hook 'folded)
  4970. (hide-subtree)
  4971. (message "FOLDED")
  4972. (setq org-cycle-subtree-status 'folded)
  4973. (run-hook-with-args 'org-cycle-hook 'folded)))))
  4974. ;;;###autoload
  4975. (defun org-global-cycle (&optional arg)
  4976. "Cycle the global visibility. For details see `org-cycle'.
  4977. With C-u prefix arg, switch to startup visibility.
  4978. With a numeric prefix, show all headlines up to that level."
  4979. (interactive "P")
  4980. (let ((org-cycle-include-plain-lists
  4981. (if (org-mode-p) org-cycle-include-plain-lists nil)))
  4982. (cond
  4983. ((integerp arg)
  4984. (show-all)
  4985. (hide-sublevels arg)
  4986. (setq org-cycle-global-status 'contents))
  4987. ((equal arg '(4))
  4988. (org-set-startup-visibility)
  4989. (message "Startup visibility, plus VISIBILITY properties."))
  4990. (t
  4991. (org-cycle '(4))))))
  4992. (defun org-set-startup-visibility ()
  4993. "Set the visibility required by startup options and properties."
  4994. (cond
  4995. ((eq org-startup-folded t)
  4996. (org-cycle '(4)))
  4997. ((eq org-startup-folded 'content)
  4998. (let ((this-command 'org-cycle) (last-command 'org-cycle))
  4999. (org-cycle '(4)) (org-cycle '(4)))))
  5000. (unless (eq org-startup-folded 'showeverything)
  5001. (if org-hide-block-startup (org-hide-block-all))
  5002. (org-set-visibility-according-to-property 'no-cleanup)
  5003. (org-cycle-hide-archived-subtrees 'all)
  5004. (org-cycle-hide-drawers 'all)
  5005. (org-cycle-show-empty-lines t)))
  5006. (defun org-set-visibility-according-to-property (&optional no-cleanup)
  5007. "Switch subtree visibilities according to :VISIBILITY: property."
  5008. (interactive)
  5009. (let (org-show-entry-below state)
  5010. (save-excursion
  5011. (goto-char (point-min))
  5012. (while (re-search-forward
  5013. "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
  5014. nil t)
  5015. (setq state (match-string 1))
  5016. (save-excursion
  5017. (org-back-to-heading t)
  5018. (hide-subtree)
  5019. (org-reveal)
  5020. (cond
  5021. ((equal state '("fold" "folded"))
  5022. (hide-subtree))
  5023. ((equal state "children")
  5024. (org-show-hidden-entry)
  5025. (show-children))
  5026. ((equal state "content")
  5027. (save-excursion
  5028. (save-restriction
  5029. (org-narrow-to-subtree)
  5030. (org-content))))
  5031. ((member state '("all" "showall"))
  5032. (show-subtree)))))
  5033. (unless no-cleanup
  5034. (org-cycle-hide-archived-subtrees 'all)
  5035. (org-cycle-hide-drawers 'all)
  5036. (org-cycle-show-empty-lines 'all)))))
  5037. (defun org-overview ()
  5038. "Switch to overview mode, showing only top-level headlines.
  5039. Really, this shows all headlines with level equal or greater than the level
  5040. of the first headline in the buffer. This is important, because if the
  5041. first headline is not level one, then (hide-sublevels 1) gives confusing
  5042. results."
  5043. (interactive)
  5044. (let ((level (save-excursion
  5045. (goto-char (point-min))
  5046. (if (re-search-forward (concat "^" outline-regexp) nil t)
  5047. (progn
  5048. (goto-char (match-beginning 0))
  5049. (funcall outline-level))))))
  5050. (and level (hide-sublevels level))))
  5051. (defun org-content (&optional arg)
  5052. "Show all headlines in the buffer, like a table of contents.
  5053. With numerical argument N, show content up to level N."
  5054. (interactive "P")
  5055. (save-excursion
  5056. ;; Visit all headings and show their offspring
  5057. (and (integerp arg) (org-overview))
  5058. (goto-char (point-max))
  5059. (catch 'exit
  5060. (while (and (progn (condition-case nil
  5061. (outline-previous-visible-heading 1)
  5062. (error (goto-char (point-min))))
  5063. t)
  5064. (looking-at outline-regexp))
  5065. (if (integerp arg)
  5066. (show-children (1- arg))
  5067. (show-branches))
  5068. (if (bobp) (throw 'exit nil))))))
  5069. (defun org-optimize-window-after-visibility-change (state)
  5070. "Adjust the window after a change in outline visibility.
  5071. This function is the default value of the hook `org-cycle-hook'."
  5072. (when (get-buffer-window (current-buffer))
  5073. (cond
  5074. ((eq state 'content) nil)
  5075. ((eq state 'all) nil)
  5076. ((eq state 'folded) nil)
  5077. ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
  5078. ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
  5079. (defun org-remove-empty-overlays-at (pos)
  5080. "Remove outline overlays that do not contain non-white stuff."
  5081. (mapc
  5082. (lambda (o)
  5083. (and (eq 'outline (overlay-get o 'invisible))
  5084. (not (string-match "\\S-" (buffer-substring (overlay-start o)
  5085. (overlay-end o))))
  5086. (delete-overlay o)))
  5087. (overlays-at pos)))
  5088. (defun org-clean-visibility-after-subtree-move ()
  5089. "Fix visibility issues after moving a subtree."
  5090. ;; First, find a reasonable region to look at:
  5091. ;; Start two siblings above, end three below
  5092. (let* ((beg (save-excursion
  5093. (and (org-get-last-sibling)
  5094. (org-get-last-sibling))
  5095. (point)))
  5096. (end (save-excursion
  5097. (and (org-get-next-sibling)
  5098. (org-get-next-sibling)
  5099. (org-get-next-sibling))
  5100. (if (org-at-heading-p)
  5101. (point-at-eol)
  5102. (point))))
  5103. (level (looking-at "\\*+"))
  5104. (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
  5105. (save-excursion
  5106. (save-restriction
  5107. (narrow-to-region beg end)
  5108. (when re
  5109. ;; Properly fold already folded siblings
  5110. (goto-char (point-min))
  5111. (while (re-search-forward re nil t)
  5112. (if (and (not (org-invisible-p))
  5113. (save-excursion
  5114. (goto-char (point-at-eol)) (org-invisible-p)))
  5115. (hide-entry))))
  5116. (org-cycle-show-empty-lines 'overview)
  5117. (org-cycle-hide-drawers 'overview)))))
  5118. (defun org-cycle-show-empty-lines (state)
  5119. "Show empty lines above all visible headlines.
  5120. The region to be covered depends on STATE when called through
  5121. `org-cycle-hook'. Lisp program can use t for STATE to get the
  5122. entire buffer covered. Note that an empty line is only shown if there
  5123. are at least `org-cycle-separator-lines' empty lines before the headline."
  5124. (when (not (= org-cycle-separator-lines 0))
  5125. (save-excursion
  5126. (let* ((n (abs org-cycle-separator-lines))
  5127. (re (cond
  5128. ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
  5129. ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
  5130. (t (let ((ns (number-to-string (- n 2))))
  5131. (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
  5132. "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
  5133. beg end b e)
  5134. (cond
  5135. ((memq state '(overview contents t))
  5136. (setq beg (point-min) end (point-max)))
  5137. ((memq state '(children folded))
  5138. (setq beg (point) end (progn (org-end-of-subtree t t)
  5139. (beginning-of-line 2)
  5140. (point)))))
  5141. (when beg
  5142. (goto-char beg)
  5143. (while (re-search-forward re end t)
  5144. (unless (get-char-property (match-end 1) 'invisible)
  5145. (setq e (match-end 1))
  5146. (if (< org-cycle-separator-lines 0)
  5147. (setq b (save-excursion
  5148. (goto-char (match-beginning 0))
  5149. (org-back-over-empty-lines)
  5150. (if (save-excursion
  5151. (goto-char (max (point-min) (1- (point))))
  5152. (org-on-heading-p))
  5153. (1- (point))
  5154. (point))))
  5155. (setq b (match-beginning 1)))
  5156. (outline-flag-region b e nil)))))))
  5157. ;; Never hide empty lines at the end of the file.
  5158. (save-excursion
  5159. (goto-char (point-max))
  5160. (outline-previous-heading)
  5161. (outline-end-of-heading)
  5162. (if (and (looking-at "[ \t\n]+")
  5163. (= (match-end 0) (point-max)))
  5164. (outline-flag-region (point) (match-end 0) nil))))
  5165. (defun org-show-empty-lines-in-parent ()
  5166. "Move to the parent and re-show empty lines before visible headlines."
  5167. (save-excursion
  5168. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  5169. (org-cycle-show-empty-lines context))))
  5170. (defun org-files-list ()
  5171. "Return `org-agenda-files' list, plus all open org-mode files.
  5172. This is useful for operations that need to scan all of a user's
  5173. open and agenda-wise Org files."
  5174. (let ((files (mapcar 'expand-file-name (org-agenda-files))))
  5175. (dolist (buf (buffer-list))
  5176. (with-current-buffer buf
  5177. (if (and (eq major-mode 'org-mode) (buffer-file-name))
  5178. (let ((file (expand-file-name (buffer-file-name))))
  5179. (unless (member file files)
  5180. (push file files))))))
  5181. files))
  5182. (defsubst org-entry-beginning-position ()
  5183. "Return the beginning position of the current entry."
  5184. (save-excursion (outline-back-to-heading t) (point)))
  5185. (defsubst org-entry-end-position ()
  5186. "Return the end position of the current entry."
  5187. (save-excursion (outline-next-heading) (point)))
  5188. (defun org-cycle-hide-drawers (state)
  5189. "Re-hide all drawers after a visibility state change."
  5190. (when (and (org-mode-p)
  5191. (not (memq state '(overview folded contents))))
  5192. (save-excursion
  5193. (let* ((globalp (memq state '(contents all)))
  5194. (beg (if globalp (point-min) (point)))
  5195. (end (if globalp (point-max)
  5196. (if (eq state 'children)
  5197. (save-excursion (outline-next-heading) (point))
  5198. (org-end-of-subtree t)))))
  5199. (goto-char beg)
  5200. (while (re-search-forward org-drawer-regexp end t)
  5201. (org-flag-drawer t))))))
  5202. (defun org-flag-drawer (flag)
  5203. (save-excursion
  5204. (beginning-of-line 1)
  5205. (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
  5206. (let ((b (match-end 0))
  5207. (outline-regexp org-outline-regexp))
  5208. (if (re-search-forward
  5209. "^[ \t]*:END:"
  5210. (save-excursion (outline-next-heading) (point)) t)
  5211. (outline-flag-region b (point-at-eol) flag)
  5212. (error ":END: line missing at position %s" b))))))
  5213. (defun org-subtree-end-visible-p ()
  5214. "Is the end of the current subtree visible?"
  5215. (pos-visible-in-window-p
  5216. (save-excursion (org-end-of-subtree t) (point))))
  5217. (defun org-first-headline-recenter (&optional N)
  5218. "Move cursor to the first headline and recenter the headline.
  5219. Optional argument N means put the headline into the Nth line of the window."
  5220. (goto-char (point-min))
  5221. (when (re-search-forward (concat "^\\(" outline-regexp "\\)") nil t)
  5222. (beginning-of-line)
  5223. (recenter (prefix-numeric-value N))))
  5224. ;;; Saving and restoring visibility
  5225. (defun org-outline-overlay-data (&optional use-markers)
  5226. "Return a list of the locations of all outline overlays.
  5227. The are overlays with the `invisible' property value `outline'.
  5228. The return valus is a list of cons cells, with start and stop
  5229. positions for each overlay.
  5230. If USE-MARKERS is set, return the positions as markers."
  5231. (let (beg end)
  5232. (save-excursion
  5233. (save-restriction
  5234. (widen)
  5235. (delq nil
  5236. (mapcar (lambda (o)
  5237. (when (eq (overlay-get o 'invisible) 'outline)
  5238. (setq beg (overlay-start o)
  5239. end (overlay-end o))
  5240. (and beg end (> end beg)
  5241. (if use-markers
  5242. (cons (move-marker (make-marker) beg)
  5243. (move-marker (make-marker) end))
  5244. (cons beg end)))))
  5245. (overlays-in (point-min) (point-max))))))))
  5246. (defun org-set-outline-overlay-data (data)
  5247. "Create visibility overlays for all positions in DATA.
  5248. DATA should have been made by `org-outline-overlay-data'."
  5249. (let (o)
  5250. (save-excursion
  5251. (save-restriction
  5252. (widen)
  5253. (show-all)
  5254. (mapc (lambda (c)
  5255. (setq o (make-overlay (car c) (cdr c)))
  5256. (overlay-put o 'invisible 'outline))
  5257. data)))))
  5258. (defmacro org-save-outline-visibility (use-markers &rest body)
  5259. "Save and restore outline visibility around BODY.
  5260. If USE-MARKERS is non-nil, use markers for the positions.
  5261. This means that the buffer may change while running BODY,
  5262. but it also means that the buffer should stay alive
  5263. during the operation, because otherwise all these markers will
  5264. point nowhere."
  5265. `(let ((data (org-outline-overlay-data ,use-markers)))
  5266. (unwind-protect
  5267. (progn
  5268. ,@body
  5269. (org-set-outline-overlay-data data))
  5270. (when ,use-markers
  5271. (mapc (lambda (c)
  5272. (and (markerp (car c)) (move-marker (car c) nil))
  5273. (and (markerp (cdr c)) (move-marker (cdr c) nil)))
  5274. data)))))
  5275. ;;; Folding of blocks
  5276. (defconst org-block-regexp
  5277. "^[ \t]*#\\+begin_\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_\\1[ \t]*$"
  5278. "Regular expression for hiding blocks.")
  5279. (defvar org-hide-block-overlays nil
  5280. "Overlays hiding blocks.")
  5281. (make-variable-buffer-local 'org-hide-block-overlays)
  5282. (defun org-block-map (function &optional start end)
  5283. "Call func at the head of all source blocks in the current
  5284. buffer. Optional arguments START and END can be used to limit
  5285. the range."
  5286. (let ((start (or start (point-min)))
  5287. (end (or end (point-max))))
  5288. (save-excursion
  5289. (goto-char start)
  5290. (while (and (< (point) end) (re-search-forward org-block-regexp end t))
  5291. (save-excursion
  5292. (save-match-data
  5293. (goto-char (match-beginning 0))
  5294. (funcall function)))))))
  5295. (defun org-hide-block-toggle-all ()
  5296. "Toggle the visibility of all blocks in the current buffer."
  5297. (org-block-map #'org-hide-block-toggle))
  5298. (defun org-hide-block-all ()
  5299. "Fold all blocks in the current buffer."
  5300. (interactive)
  5301. (org-show-block-all)
  5302. (org-block-map #'org-hide-block-toggle-maybe))
  5303. (defun org-show-block-all ()
  5304. "Unfold all blocks in the current buffer."
  5305. (mapc 'delete-overlay org-hide-block-overlays)
  5306. (setq org-hide-block-overlays nil))
  5307. (defun org-hide-block-toggle-maybe ()
  5308. "Toggle visibility of block at point."
  5309. (interactive)
  5310. (let ((case-fold-search t))
  5311. (if (save-excursion
  5312. (beginning-of-line 1)
  5313. (looking-at org-block-regexp))
  5314. (progn (org-hide-block-toggle)
  5315. t) ;; to signal that we took action
  5316. nil))) ;; to signal that we did not
  5317. (defun org-hide-block-toggle (&optional force)
  5318. "Toggle the visibility of the current block."
  5319. (interactive)
  5320. (save-excursion
  5321. (beginning-of-line)
  5322. (if (re-search-forward org-block-regexp nil t)
  5323. (let ((start (- (match-beginning 4) 1)) ;; beginning of body
  5324. (end (match-end 0)) ;; end of entire body
  5325. ov)
  5326. (if (memq t (mapcar (lambda (overlay)
  5327. (eq (overlay-get overlay 'invisible)
  5328. 'org-hide-block))
  5329. (overlays-at start)))
  5330. (if (or (not force) (eq force 'off))
  5331. (mapc (lambda (ov)
  5332. (when (member ov org-hide-block-overlays)
  5333. (setq org-hide-block-overlays
  5334. (delq ov org-hide-block-overlays)))
  5335. (when (eq (overlay-get ov 'invisible)
  5336. 'org-hide-block)
  5337. (delete-overlay ov)))
  5338. (overlays-at start)))
  5339. (setq ov (make-overlay start end))
  5340. (overlay-put ov 'invisible 'org-hide-block)
  5341. ;; make the block accessible to isearch
  5342. (overlay-put
  5343. ov 'isearch-open-invisible
  5344. (lambda (ov)
  5345. (when (member ov org-hide-block-overlays)
  5346. (setq org-hide-block-overlays
  5347. (delq ov org-hide-block-overlays)))
  5348. (when (eq (overlay-get ov 'invisible)
  5349. 'org-hide-block)
  5350. (delete-overlay ov))))
  5351. (push ov org-hide-block-overlays)))
  5352. (error "Not looking at a source block"))))
  5353. ;; org-tab-after-check-for-cycling-hook
  5354. (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
  5355. ;; Remove overlays when changing major mode
  5356. (add-hook 'org-mode-hook
  5357. (lambda () (org-add-hook 'change-major-mode-hook
  5358. 'org-show-block-all 'append 'local)))
  5359. ;;; Org-goto
  5360. (defvar org-goto-window-configuration nil)
  5361. (defvar org-goto-marker nil)
  5362. (defvar org-goto-map
  5363. (let ((map (make-sparse-keymap)))
  5364. (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
  5365. (while (setq cmd (pop cmds))
  5366. (substitute-key-definition cmd cmd map global-map)))
  5367. (suppress-keymap map)
  5368. (org-defkey map "\C-m" 'org-goto-ret)
  5369. (org-defkey map [(return)] 'org-goto-ret)
  5370. (org-defkey map [(left)] 'org-goto-left)
  5371. (org-defkey map [(right)] 'org-goto-right)
  5372. (org-defkey map [(control ?g)] 'org-goto-quit)
  5373. (org-defkey map "\C-i" 'org-cycle)
  5374. (org-defkey map [(tab)] 'org-cycle)
  5375. (org-defkey map [(down)] 'outline-next-visible-heading)
  5376. (org-defkey map [(up)] 'outline-previous-visible-heading)
  5377. (if org-goto-auto-isearch
  5378. (if (fboundp 'define-key-after)
  5379. (define-key-after map [t] 'org-goto-local-auto-isearch)
  5380. nil)
  5381. (org-defkey map "q" 'org-goto-quit)
  5382. (org-defkey map "n" 'outline-next-visible-heading)
  5383. (org-defkey map "p" 'outline-previous-visible-heading)
  5384. (org-defkey map "f" 'outline-forward-same-level)
  5385. (org-defkey map "b" 'outline-backward-same-level)
  5386. (org-defkey map "u" 'outline-up-heading))
  5387. (org-defkey map "/" 'org-occur)
  5388. (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
  5389. (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
  5390. (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
  5391. (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
  5392. (org-defkey map "\C-c\C-u" 'outline-up-heading)
  5393. map))
  5394. (defconst org-goto-help
  5395. "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
  5396. RET=jump to location [Q]uit and return to previous location
  5397. \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
  5398. (defvar org-goto-start-pos) ; dynamically scoped parameter
  5399. ;; FIXME: Docstring does not mention both interfaces
  5400. (defun org-goto (&optional alternative-interface)
  5401. "Look up a different location in the current file, keeping current visibility.
  5402. When you want look-up or go to a different location in a document, the
  5403. fastest way is often to fold the entire buffer and then dive into the tree.
  5404. This method has the disadvantage, that the previous location will be folded,
  5405. which may not be what you want.
  5406. This command works around this by showing a copy of the current buffer
  5407. in an indirect buffer, in overview mode. You can dive into the tree in
  5408. that copy, use org-occur and incremental search to find a location.
  5409. When pressing RET or `Q', the command returns to the original buffer in
  5410. which the visibility is still unchanged. After RET is will also jump to
  5411. the location selected in the indirect buffer and expose the
  5412. the headline hierarchy above."
  5413. (interactive "P")
  5414. (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
  5415. (org-refile-use-outline-path t)
  5416. (org-refile-target-verify-function nil)
  5417. (interface
  5418. (if (not alternative-interface)
  5419. org-goto-interface
  5420. (if (eq org-goto-interface 'outline)
  5421. 'outline-path-completion
  5422. 'outline)))
  5423. (org-goto-start-pos (point))
  5424. (selected-point
  5425. (if (eq interface 'outline)
  5426. (car (org-get-location (current-buffer) org-goto-help))
  5427. (nth 3 (org-refile-get-location "Goto: ")))))
  5428. (if selected-point
  5429. (progn
  5430. (org-mark-ring-push org-goto-start-pos)
  5431. (goto-char selected-point)
  5432. (if (or (org-invisible-p) (org-invisible-p2))
  5433. (org-show-context 'org-goto)))
  5434. (message "Quit"))))
  5435. (defvar org-goto-selected-point nil) ; dynamically scoped parameter
  5436. (defvar org-goto-exit-command nil) ; dynamically scoped parameter
  5437. (defvar org-goto-local-auto-isearch-map) ; defined below
  5438. (defun org-get-location (buf help)
  5439. "Let the user select a location in the Org-mode buffer BUF.
  5440. This function uses a recursive edit. It returns the selected position
  5441. or nil."
  5442. (let ((isearch-mode-map org-goto-local-auto-isearch-map)
  5443. (isearch-hide-immediately nil)
  5444. (isearch-search-fun-function
  5445. (lambda () 'org-goto-local-search-headings))
  5446. (org-goto-selected-point org-goto-exit-command)
  5447. (pop-up-frames nil)
  5448. (special-display-buffer-names nil)
  5449. (special-display-regexps nil)
  5450. (special-display-function nil))
  5451. (save-excursion
  5452. (save-window-excursion
  5453. (delete-other-windows)
  5454. (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
  5455. (switch-to-buffer
  5456. (condition-case nil
  5457. (make-indirect-buffer (current-buffer) "*org-goto*")
  5458. (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
  5459. (with-output-to-temp-buffer "*Help*"
  5460. (princ help))
  5461. (org-fit-window-to-buffer (get-buffer-window "*Help*"))
  5462. (setq buffer-read-only nil)
  5463. (let ((org-startup-truncated t)
  5464. (org-startup-folded nil)
  5465. (org-startup-align-all-tables nil))
  5466. (org-mode)
  5467. (org-overview))
  5468. (setq buffer-read-only t)
  5469. (if (and (boundp 'org-goto-start-pos)
  5470. (integer-or-marker-p org-goto-start-pos))
  5471. (let ((org-show-hierarchy-above t)
  5472. (org-show-siblings t)
  5473. (org-show-following-heading t))
  5474. (goto-char org-goto-start-pos)
  5475. (and (org-invisible-p) (org-show-context)))
  5476. (goto-char (point-min)))
  5477. (let (org-special-ctrl-a/e) (org-beginning-of-line))
  5478. (message "Select location and press RET")
  5479. (use-local-map org-goto-map)
  5480. (recursive-edit)
  5481. ))
  5482. (kill-buffer "*org-goto*")
  5483. (cons org-goto-selected-point org-goto-exit-command)))
  5484. (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
  5485. (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
  5486. (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
  5487. (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
  5488. (defun org-goto-local-search-headings (string bound noerror)
  5489. "Search and make sure that any matches are in headlines."
  5490. (catch 'return
  5491. (while (if isearch-forward
  5492. (search-forward string bound noerror)
  5493. (search-backward string bound noerror))
  5494. (when (let ((context (mapcar 'car (save-match-data (org-context)))))
  5495. (and (member :headline context)
  5496. (not (member :tags context))))
  5497. (throw 'return (point))))))
  5498. (defun org-goto-local-auto-isearch ()
  5499. "Start isearch."
  5500. (interactive)
  5501. (goto-char (point-min))
  5502. (let ((keys (this-command-keys)))
  5503. (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
  5504. (isearch-mode t)
  5505. (isearch-process-search-char (string-to-char keys)))))
  5506. (defun org-goto-ret (&optional arg)
  5507. "Finish `org-goto' by going to the new location."
  5508. (interactive "P")
  5509. (setq org-goto-selected-point (point)
  5510. org-goto-exit-command 'return)
  5511. (throw 'exit nil))
  5512. (defun org-goto-left ()
  5513. "Finish `org-goto' by going to the new location."
  5514. (interactive)
  5515. (if (org-on-heading-p)
  5516. (progn
  5517. (beginning-of-line 1)
  5518. (setq org-goto-selected-point (point)
  5519. org-goto-exit-command 'left)
  5520. (throw 'exit nil))
  5521. (error "Not on a heading")))
  5522. (defun org-goto-right ()
  5523. "Finish `org-goto' by going to the new location."
  5524. (interactive)
  5525. (if (org-on-heading-p)
  5526. (progn
  5527. (setq org-goto-selected-point (point)
  5528. org-goto-exit-command 'right)
  5529. (throw 'exit nil))
  5530. (error "Not on a heading")))
  5531. (defun org-goto-quit ()
  5532. "Finish `org-goto' without cursor motion."
  5533. (interactive)
  5534. (setq org-goto-selected-point nil)
  5535. (setq org-goto-exit-command 'quit)
  5536. (throw 'exit nil))
  5537. ;;; Indirect buffer display of subtrees
  5538. (defvar org-indirect-dedicated-frame nil
  5539. "This is the frame being used for indirect tree display.")
  5540. (defvar org-last-indirect-buffer nil)
  5541. (defun org-tree-to-indirect-buffer (&optional arg)
  5542. "Create indirect buffer and narrow it to current subtree.
  5543. With numerical prefix ARG, go up to this level and then take that tree.
  5544. If ARG is negative, go up that many levels.
  5545. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  5546. indirect buffer previously made with this command, to avoid proliferation of
  5547. indirect buffers. However, when you call the command with a `C-u' prefix, or
  5548. when `org-indirect-buffer-display' is `new-frame', the last buffer
  5549. is kept so that you can work with several indirect buffers at the same time.
  5550. If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
  5551. requests that a new frame be made for the new buffer, so that the dedicated
  5552. frame is not changed."
  5553. (interactive "P")
  5554. (let ((cbuf (current-buffer))
  5555. (cwin (selected-window))
  5556. (pos (point))
  5557. beg end level heading ibuf)
  5558. (save-excursion
  5559. (org-back-to-heading t)
  5560. (when (numberp arg)
  5561. (setq level (org-outline-level))
  5562. (if (< arg 0) (setq arg (+ level arg)))
  5563. (while (> (setq level (org-outline-level)) arg)
  5564. (outline-up-heading 1 t)))
  5565. (setq beg (point)
  5566. heading (org-get-heading))
  5567. (org-end-of-subtree t t)
  5568. (if (org-on-heading-p) (backward-char 1))
  5569. (setq end (point)))
  5570. (if (and (buffer-live-p org-last-indirect-buffer)
  5571. (not (eq org-indirect-buffer-display 'new-frame))
  5572. (not arg))
  5573. (kill-buffer org-last-indirect-buffer))
  5574. (setq ibuf (org-get-indirect-buffer cbuf)
  5575. org-last-indirect-buffer ibuf)
  5576. (cond
  5577. ((or (eq org-indirect-buffer-display 'new-frame)
  5578. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  5579. (select-frame (make-frame))
  5580. (delete-other-windows)
  5581. (switch-to-buffer ibuf)
  5582. (org-set-frame-title heading))
  5583. ((eq org-indirect-buffer-display 'dedicated-frame)
  5584. (raise-frame
  5585. (select-frame (or (and org-indirect-dedicated-frame
  5586. (frame-live-p org-indirect-dedicated-frame)
  5587. org-indirect-dedicated-frame)
  5588. (setq org-indirect-dedicated-frame (make-frame)))))
  5589. (delete-other-windows)
  5590. (switch-to-buffer ibuf)
  5591. (org-set-frame-title (concat "Indirect: " heading)))
  5592. ((eq org-indirect-buffer-display 'current-window)
  5593. (switch-to-buffer ibuf))
  5594. ((eq org-indirect-buffer-display 'other-window)
  5595. (pop-to-buffer ibuf))
  5596. (t (error "Invalid value")))
  5597. (if (featurep 'xemacs)
  5598. (save-excursion (org-mode) (turn-on-font-lock)))
  5599. (narrow-to-region beg end)
  5600. (show-all)
  5601. (goto-char pos)
  5602. (and (window-live-p cwin) (select-window cwin))))
  5603. (defun org-get-indirect-buffer (&optional buffer)
  5604. (setq buffer (or buffer (current-buffer)))
  5605. (let ((n 1) (base (buffer-name buffer)) bname)
  5606. (while (buffer-live-p
  5607. (get-buffer (setq bname (concat base "-" (number-to-string n)))))
  5608. (setq n (1+ n)))
  5609. (condition-case nil
  5610. (make-indirect-buffer buffer bname 'clone)
  5611. (error (make-indirect-buffer buffer bname)))))
  5612. (defun org-set-frame-title (title)
  5613. "Set the title of the current frame to the string TITLE."
  5614. ;; FIXME: how to name a single frame in XEmacs???
  5615. (unless (featurep 'xemacs)
  5616. (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
  5617. ;;;; Structure editing
  5618. ;;; Inserting headlines
  5619. (defun org-previous-line-empty-p ()
  5620. (save-excursion
  5621. (and (not (bobp))
  5622. (or (beginning-of-line 0) t)
  5623. (save-match-data
  5624. (looking-at "[ \t]*$")))))
  5625. (defun org-insert-heading (&optional force-heading invisible-ok)
  5626. "Insert a new heading or item with same depth at point.
  5627. If point is in a plain list and FORCE-HEADING is nil, create a new list item.
  5628. If point is at the beginning of a headline, insert a sibling before the
  5629. current headline. If point is not at the beginning, do not split the line,
  5630. but create the new headline after the current line.
  5631. When INVISIBLE-OK is set, stop at invisible headlines when going back.
  5632. This is important for non-interactive uses of the command."
  5633. (interactive "P")
  5634. (if (or (= (buffer-size) 0)
  5635. (and (not (save-excursion (and (ignore-errors (org-back-to-heading invisible-ok))
  5636. (org-on-heading-p))))
  5637. (not (org-in-item-p))))
  5638. (insert "\n* ")
  5639. (when (or force-heading (not (org-insert-item)))
  5640. (let* ((empty-line-p nil)
  5641. (head (save-excursion
  5642. (condition-case nil
  5643. (progn
  5644. (org-back-to-heading invisible-ok)
  5645. (setq empty-line-p (org-previous-line-empty-p))
  5646. (match-string 0))
  5647. (error "*"))))
  5648. (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
  5649. (blank (if (eq blank-a 'auto) empty-line-p blank-a))
  5650. pos hide-previous previous-pos)
  5651. (cond
  5652. ((and (org-on-heading-p) (bolp)
  5653. (or (bobp)
  5654. (save-excursion (backward-char 1) (not (org-invisible-p)))))
  5655. ;; insert before the current line
  5656. (open-line (if blank 2 1)))
  5657. ((and (bolp)
  5658. (not org-insert-heading-respect-content)
  5659. (or (bobp)
  5660. (save-excursion
  5661. (backward-char 1) (not (org-invisible-p)))))
  5662. ;; insert right here
  5663. nil)
  5664. (t
  5665. ;; somewhere in the line
  5666. (save-excursion
  5667. (setq previous-pos (point-at-bol))
  5668. (end-of-line)
  5669. (setq hide-previous (org-invisible-p)))
  5670. (and org-insert-heading-respect-content (org-show-subtree))
  5671. (let ((split
  5672. (and (org-get-alist-option org-M-RET-may-split-line 'headline)
  5673. (save-excursion
  5674. (let ((p (point)))
  5675. (goto-char (point-at-bol))
  5676. (and (looking-at org-complex-heading-regexp)
  5677. (> p (match-beginning 4)))))))
  5678. tags pos)
  5679. (cond
  5680. (org-insert-heading-respect-content
  5681. (org-end-of-subtree nil t)
  5682. (or (bolp) (newline))
  5683. (or (org-previous-line-empty-p)
  5684. (and blank (newline)))
  5685. (open-line 1))
  5686. ((org-on-heading-p)
  5687. (when hide-previous
  5688. (show-children)
  5689. (org-show-entry))
  5690. (looking-at ".*?\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)?[ \t]*$")
  5691. (setq tags (and (match-end 2) (match-string 2)))
  5692. (and (match-end 1)
  5693. (delete-region (match-beginning 1) (match-end 1)))
  5694. (setq pos (point-at-bol))
  5695. (or split (end-of-line 1))
  5696. (delete-horizontal-space)
  5697. (if (string-match "\\`\\*+\\'"
  5698. (buffer-substring (point-at-bol) (point)))
  5699. (insert " "))
  5700. (newline (if blank 2 1))
  5701. (when tags
  5702. (save-excursion
  5703. (goto-char pos)
  5704. (end-of-line 1)
  5705. (insert " " tags)
  5706. (org-set-tags nil 'align))))
  5707. (t
  5708. (or split (end-of-line 1))
  5709. (newline (if blank 2 1)))))))
  5710. (insert head) (just-one-space)
  5711. (setq pos (point))
  5712. (end-of-line 1)
  5713. (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
  5714. (when (and org-insert-heading-respect-content hide-previous)
  5715. (save-excursion
  5716. (goto-char previous-pos)
  5717. (hide-subtree)))
  5718. (run-hooks 'org-insert-heading-hook)))))
  5719. (defun org-get-heading (&optional no-tags)
  5720. "Return the heading of the current entry, without the stars."
  5721. (save-excursion
  5722. (org-back-to-heading t)
  5723. (if (looking-at
  5724. (if no-tags
  5725. (org-re "\\*+[ \t]+\\([^\n\r]*?\\)\\([ \t]+:[[:alnum:]:_@]+:[ \t]*\\)?$")
  5726. "\\*+[ \t]+\\([^\r\n]*\\)"))
  5727. (match-string 1) "")))
  5728. (defun org-heading-components ()
  5729. "Return the components of the current heading.
  5730. This is a list with the following elements:
  5731. - the level as an integer
  5732. - the reduced level, different if `org-odd-levels-only' is set.
  5733. - the TODO keyword, or nil
  5734. - the priority character, like ?A, or nil if no priority is given
  5735. - the headline text itself, or the tags string if no headline text
  5736. - the tags string, or nil."
  5737. (save-excursion
  5738. (org-back-to-heading t)
  5739. (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
  5740. (list (length (match-string 1))
  5741. (org-reduced-level (length (match-string 1)))
  5742. (org-match-string-no-properties 2)
  5743. (and (match-end 3) (aref (match-string 3) 2))
  5744. (org-match-string-no-properties 4)
  5745. (org-match-string-no-properties 5)))))
  5746. (defun org-get-entry ()
  5747. "Get the entry text, after heading, entire subtree."
  5748. (save-excursion
  5749. (org-back-to-heading t)
  5750. (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
  5751. (defun org-insert-heading-after-current ()
  5752. "Insert a new heading with same level as current, after current subtree."
  5753. (interactive)
  5754. (org-back-to-heading)
  5755. (org-insert-heading)
  5756. (org-move-subtree-down)
  5757. (end-of-line 1))
  5758. (defun org-insert-heading-respect-content ()
  5759. (interactive)
  5760. (let ((org-insert-heading-respect-content t))
  5761. (org-insert-heading t)))
  5762. (defun org-insert-todo-heading-respect-content (&optional force-state)
  5763. (interactive "P")
  5764. (let ((org-insert-heading-respect-content t))
  5765. (org-insert-todo-heading force-state t)))
  5766. (defun org-insert-todo-heading (arg &optional force-heading)
  5767. "Insert a new heading with the same level and TODO state as current heading.
  5768. If the heading has no TODO state, or if the state is DONE, use the first
  5769. state (TODO by default). Also with prefix arg, force first state."
  5770. (interactive "P")
  5771. (when (or force-heading (not (org-insert-item 'checkbox)))
  5772. (org-insert-heading force-heading)
  5773. (save-excursion
  5774. (org-back-to-heading)
  5775. (outline-previous-heading)
  5776. (looking-at org-todo-line-regexp))
  5777. (let*
  5778. ((new-mark-x
  5779. (if (or arg
  5780. (not (match-beginning 2))
  5781. (member (match-string 2) org-done-keywords))
  5782. (car org-todo-keywords-1)
  5783. (match-string 2)))
  5784. (new-mark
  5785. (or
  5786. (run-hook-with-args-until-success
  5787. 'org-todo-get-default-hook new-mark-x nil)
  5788. new-mark-x)))
  5789. (beginning-of-line 1)
  5790. (and (looking-at "\\*+ ") (goto-char (match-end 0))
  5791. (if org-treat-insert-todo-heading-as-state-change
  5792. (org-todo new-mark)
  5793. (insert new-mark " "))))
  5794. (when org-provide-todo-statistics
  5795. (org-update-parent-todo-statistics))))
  5796. (defun org-insert-subheading (arg)
  5797. "Insert a new subheading and demote it.
  5798. Works for outline headings and for plain lists alike."
  5799. (interactive "P")
  5800. (org-insert-heading arg)
  5801. (cond
  5802. ((org-on-heading-p) (org-do-demote))
  5803. ((org-at-item-p) (org-indent-item 1))))
  5804. (defun org-insert-todo-subheading (arg)
  5805. "Insert a new subheading with TODO keyword or checkbox and demote it.
  5806. Works for outline headings and for plain lists alike."
  5807. (interactive "P")
  5808. (org-insert-todo-heading arg)
  5809. (cond
  5810. ((org-on-heading-p) (org-do-demote))
  5811. ((org-at-item-p) (org-indent-item 1))))
  5812. ;;; Promotion and Demotion
  5813. (defvar org-after-demote-entry-hook nil
  5814. "Hook run after an entry has been demoted.
  5815. The cursor will be at the beginning of the entry.
  5816. When a subtree is being demoted, the hook will be called for each node.")
  5817. (defvar org-after-promote-entry-hook nil
  5818. "Hook run after an entry has been promoted.
  5819. The cursor will be at the beginning of the entry.
  5820. When a subtree is being promoted, the hook will be called for each node.")
  5821. (defun org-promote-subtree ()
  5822. "Promote the entire subtree.
  5823. See also `org-promote'."
  5824. (interactive)
  5825. (save-excursion
  5826. (org-map-tree 'org-promote))
  5827. (org-fix-position-after-promote))
  5828. (defun org-demote-subtree ()
  5829. "Demote the entire subtree. See `org-demote'.
  5830. See also `org-promote'."
  5831. (interactive)
  5832. (save-excursion
  5833. (org-map-tree 'org-demote))
  5834. (org-fix-position-after-promote))
  5835. (defun org-do-promote ()
  5836. "Promote the current heading higher up the tree.
  5837. If the region is active in `transient-mark-mode', promote all headings
  5838. in the region."
  5839. (interactive)
  5840. (save-excursion
  5841. (if (org-region-active-p)
  5842. (org-map-region 'org-promote (region-beginning) (region-end))
  5843. (org-promote)))
  5844. (org-fix-position-after-promote))
  5845. (defun org-do-demote ()
  5846. "Demote the current heading lower down the tree.
  5847. If the region is active in `transient-mark-mode', demote all headings
  5848. in the region."
  5849. (interactive)
  5850. (save-excursion
  5851. (if (org-region-active-p)
  5852. (org-map-region 'org-demote (region-beginning) (region-end))
  5853. (org-demote)))
  5854. (org-fix-position-after-promote))
  5855. (defun org-fix-position-after-promote ()
  5856. "Make sure that after pro/demotion cursor position is right."
  5857. (let ((pos (point)))
  5858. (when (save-excursion
  5859. (beginning-of-line 1)
  5860. (looking-at org-todo-line-regexp)
  5861. (or (equal pos (match-end 1)) (equal pos (match-end 2))))
  5862. (cond ((eobp) (insert " "))
  5863. ((eolp) (insert " "))
  5864. ((equal (char-after) ?\ ) (forward-char 1))))))
  5865. (defun org-current-level ()
  5866. "Return the level of the current entry, or nil if before the first headline.
  5867. The level is the number of stars at the beginning of the headline."
  5868. (save-excursion
  5869. (condition-case nil
  5870. (progn
  5871. (org-back-to-heading t)
  5872. (funcall outline-level))
  5873. (error nil))))
  5874. (defun org-get-previous-line-level ()
  5875. "Return the outline depth of the last headline before the current line.
  5876. Returns 0 for the first headline in the buffer, and nil if before the
  5877. first headline."
  5878. (let ((current-level (org-current-level))
  5879. (prev-level (when (> (line-number-at-pos) 1)
  5880. (save-excursion
  5881. (beginning-of-line 0)
  5882. (org-current-level)))))
  5883. (cond ((null current-level) nil) ; Before first headline
  5884. ((null prev-level) 0) ; At first headline
  5885. (prev-level))))
  5886. (defun org-reduced-level (l)
  5887. "Compute the effective level of a heading.
  5888. This takes into account the setting of `org-odd-levels-only'."
  5889. (if org-odd-levels-only (1+ (floor (/ l 2))) l))
  5890. (defun org-level-increment ()
  5891. "Return the number of stars that will be added or removed at a
  5892. time to headlines when structure editing, based on the value of
  5893. `org-odd-levels-only'."
  5894. (if org-odd-levels-only 2 1))
  5895. (defun org-get-valid-level (level &optional change)
  5896. "Rectify a level change under the influence of `org-odd-levels-only'
  5897. LEVEL is a current level, CHANGE is by how much the level should be
  5898. modified. Even if CHANGE is nil, LEVEL may be returned modified because
  5899. even level numbers will become the next higher odd number."
  5900. (if org-odd-levels-only
  5901. (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
  5902. ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
  5903. ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
  5904. (max 1 (+ level (or change 0)))))
  5905. (if (boundp 'define-obsolete-function-alias)
  5906. (if (or (featurep 'xemacs) (< emacs-major-version 23))
  5907. (define-obsolete-function-alias 'org-get-legal-level
  5908. 'org-get-valid-level)
  5909. (define-obsolete-function-alias 'org-get-legal-level
  5910. 'org-get-valid-level "23.1")))
  5911. (defun org-promote ()
  5912. "Promote the current heading higher up the tree.
  5913. If the region is active in `transient-mark-mode', promote all headings
  5914. in the region."
  5915. (org-back-to-heading t)
  5916. (let* ((level (save-match-data (funcall outline-level)))
  5917. (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
  5918. (diff (abs (- level (length up-head) -1))))
  5919. (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
  5920. (replace-match up-head nil t)
  5921. ;; Fixup tag positioning
  5922. (and org-auto-align-tags (org-set-tags nil t))
  5923. (if org-adapt-indentation (org-fixup-indentation (- diff)))
  5924. (run-hooks 'org-after-promote-entry-hook)))
  5925. (defun org-demote ()
  5926. "Demote the current heading lower down the tree.
  5927. If the region is active in `transient-mark-mode', demote all headings
  5928. in the region."
  5929. (org-back-to-heading t)
  5930. (let* ((level (save-match-data (funcall outline-level)))
  5931. (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
  5932. (diff (abs (- level (length down-head) -1))))
  5933. (replace-match down-head nil t)
  5934. ;; Fixup tag positioning
  5935. (and org-auto-align-tags (org-set-tags nil t))
  5936. (if org-adapt-indentation (org-fixup-indentation diff))
  5937. (run-hooks 'org-after-demote-entry-hook)))
  5938. (defun org-cycle-level ()
  5939. "Cycle the level of an empty headline through possible states.
  5940. This goes first to child, then to parent, level, then up the hierarchy.
  5941. After top level, it switches back to sibling level."
  5942. (interactive)
  5943. (let ((org-adapt-indentation nil))
  5944. (when (org-point-at-end-of-empty-headline)
  5945. (setq this-command 'org-cycle-level) ; Only needed for caching
  5946. (let ((cur-level (org-current-level))
  5947. (prev-level (org-get-previous-line-level)))
  5948. (cond
  5949. ;; If first headline in file, promote to top-level.
  5950. ((= prev-level 0)
  5951. (loop repeat (/ (- cur-level 1) (org-level-increment))
  5952. do (org-do-promote)))
  5953. ;; If same level as prev, demote one.
  5954. ((= prev-level cur-level)
  5955. (org-do-demote))
  5956. ;; If parent is top-level, promote to top level if not already.
  5957. ((= prev-level 1)
  5958. (loop repeat (/ (- cur-level 1) (org-level-increment))
  5959. do (org-do-promote)))
  5960. ;; If top-level, return to prev-level.
  5961. ((= cur-level 1)
  5962. (loop repeat (/ (- prev-level 1) (org-level-increment))
  5963. do (org-do-demote)))
  5964. ;; If less than prev-level, promote one.
  5965. ((< cur-level prev-level)
  5966. (org-do-promote))
  5967. ;; If deeper than prev-level, promote until higher than
  5968. ;; prev-level.
  5969. ((> cur-level prev-level)
  5970. (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
  5971. do (org-do-promote))))
  5972. t))))
  5973. (defun org-map-tree (fun)
  5974. "Call FUN for every heading underneath the current one."
  5975. (org-back-to-heading)
  5976. (let ((level (funcall outline-level)))
  5977. (save-excursion
  5978. (funcall fun)
  5979. (while (and (progn
  5980. (outline-next-heading)
  5981. (> (funcall outline-level) level))
  5982. (not (eobp)))
  5983. (funcall fun)))))
  5984. (defun org-map-region (fun beg end)
  5985. "Call FUN for every heading between BEG and END."
  5986. (let ((org-ignore-region t))
  5987. (save-excursion
  5988. (setq end (copy-marker end))
  5989. (goto-char beg)
  5990. (if (and (re-search-forward (concat "^" outline-regexp) nil t)
  5991. (< (point) end))
  5992. (funcall fun))
  5993. (while (and (progn
  5994. (outline-next-heading)
  5995. (< (point) end))
  5996. (not (eobp)))
  5997. (funcall fun)))))
  5998. (defun org-fixup-indentation (diff)
  5999. "Change the indentation in the current entry by DIFF
  6000. However, if any line in the current entry has no indentation, or if it
  6001. would end up with no indentation after the change, nothing at all is done."
  6002. (save-excursion
  6003. (let ((end (save-excursion (outline-next-heading)
  6004. (point-marker)))
  6005. (prohibit (if (> diff 0)
  6006. "^\\S-"
  6007. (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
  6008. col)
  6009. (unless (save-excursion (end-of-line 1)
  6010. (re-search-forward prohibit end t))
  6011. (while (and (< (point) end)
  6012. (re-search-forward "^[ \t]+" end t))
  6013. (goto-char (match-end 0))
  6014. (setq col (current-column))
  6015. (if (< diff 0) (replace-match ""))
  6016. (org-indent-to-column (+ diff col))))
  6017. (move-marker end nil))))
  6018. (defun org-convert-to-odd-levels ()
  6019. "Convert an org-mode file with all levels allowed to one with odd levels.
  6020. This will leave level 1 alone, convert level 2 to level 3, level 3 to
  6021. level 5 etc."
  6022. (interactive)
  6023. (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
  6024. (let ((outline-regexp org-outline-regexp)
  6025. (outline-level 'org-outline-level)
  6026. (org-odd-levels-only nil) n)
  6027. (save-excursion
  6028. (goto-char (point-min))
  6029. (while (re-search-forward "^\\*\\*+ " nil t)
  6030. (setq n (- (length (match-string 0)) 2))
  6031. (while (>= (setq n (1- n)) 0)
  6032. (org-demote))
  6033. (end-of-line 1))))))
  6034. (defun org-convert-to-oddeven-levels ()
  6035. "Convert an org-mode file with only odd levels to one with odd and even levels.
  6036. This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
  6037. section with an even level, conversion would destroy the structure of the file. An error
  6038. is signaled in this case."
  6039. (interactive)
  6040. (goto-char (point-min))
  6041. ;; First check if there are no even levels
  6042. (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
  6043. (org-show-context t)
  6044. (error "Not all levels are odd in this file. Conversion not possible"))
  6045. (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
  6046. (let ((outline-regexp org-outline-regexp)
  6047. (outline-level 'org-outline-level)
  6048. (org-odd-levels-only nil) n)
  6049. (save-excursion
  6050. (goto-char (point-min))
  6051. (while (re-search-forward "^\\*\\*+ " nil t)
  6052. (setq n (/ (1- (length (match-string 0))) 2))
  6053. (while (>= (setq n (1- n)) 0)
  6054. (org-promote))
  6055. (end-of-line 1))))))
  6056. (defun org-tr-level (n)
  6057. "Make N odd if required."
  6058. (if org-odd-levels-only (1+ (/ n 2)) n))
  6059. ;;; Vertical tree motion, cutting and pasting of subtrees
  6060. (defun org-move-subtree-up (&optional arg)
  6061. "Move the current subtree up past ARG headlines of the same level."
  6062. (interactive "p")
  6063. (org-move-subtree-down (- (prefix-numeric-value arg))))
  6064. (defun org-move-subtree-down (&optional arg)
  6065. "Move the current subtree down past ARG headlines of the same level."
  6066. (interactive "p")
  6067. (setq arg (prefix-numeric-value arg))
  6068. (let ((movfunc (if (> arg 0) 'org-get-next-sibling
  6069. 'org-get-last-sibling))
  6070. (ins-point (make-marker))
  6071. (cnt (abs arg))
  6072. beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
  6073. ;; Select the tree
  6074. (org-back-to-heading)
  6075. (setq beg0 (point))
  6076. (save-excursion
  6077. (setq ne-beg (org-back-over-empty-lines))
  6078. (setq beg (point)))
  6079. (save-match-data
  6080. (save-excursion (outline-end-of-heading)
  6081. (setq folded (org-invisible-p)))
  6082. (outline-end-of-subtree))
  6083. (outline-next-heading)
  6084. (setq ne-end (org-back-over-empty-lines))
  6085. (setq end (point))
  6086. (goto-char beg0)
  6087. (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
  6088. ;; include less whitespace
  6089. (save-excursion
  6090. (goto-char beg)
  6091. (forward-line (- ne-beg ne-end))
  6092. (setq beg (point))))
  6093. ;; Find insertion point, with error handling
  6094. (while (> cnt 0)
  6095. (or (and (funcall movfunc) (looking-at outline-regexp))
  6096. (progn (goto-char beg0)
  6097. (error "Cannot move past superior level or buffer limit")))
  6098. (setq cnt (1- cnt)))
  6099. (if (> arg 0)
  6100. ;; Moving forward - still need to move over subtree
  6101. (progn (org-end-of-subtree t t)
  6102. (save-excursion
  6103. (org-back-over-empty-lines)
  6104. (or (bolp) (newline)))))
  6105. (setq ne-ins (org-back-over-empty-lines))
  6106. (move-marker ins-point (point))
  6107. (setq txt (buffer-substring beg end))
  6108. (org-save-markers-in-region beg end)
  6109. (delete-region beg end)
  6110. (org-remove-empty-overlays-at beg)
  6111. (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
  6112. (or (bobp) (outline-flag-region (1- (point)) (point) nil))
  6113. (and (not (bolp)) (looking-at "\n") (forward-char 1))
  6114. (let ((bbb (point)))
  6115. (insert-before-markers txt)
  6116. (org-reinstall-markers-in-region bbb)
  6117. (move-marker ins-point bbb))
  6118. (or (bolp) (insert "\n"))
  6119. (setq ins-end (point))
  6120. (goto-char ins-point)
  6121. (org-skip-whitespace)
  6122. (when (and (< arg 0)
  6123. (org-first-sibling-p)
  6124. (> ne-ins ne-beg))
  6125. ;; Move whitespace back to beginning
  6126. (save-excursion
  6127. (goto-char ins-end)
  6128. (let ((kill-whole-line t))
  6129. (kill-line (- ne-ins ne-beg)) (point)))
  6130. (insert (make-string (- ne-ins ne-beg) ?\n)))
  6131. (move-marker ins-point nil)
  6132. (if folded
  6133. (hide-subtree)
  6134. (org-show-entry)
  6135. (show-children)
  6136. (org-cycle-hide-drawers 'children))
  6137. (org-clean-visibility-after-subtree-move)))
  6138. (defvar org-subtree-clip ""
  6139. "Clipboard for cut and paste of subtrees.
  6140. This is actually only a copy of the kill, because we use the normal kill
  6141. ring. We need it to check if the kill was created by `org-copy-subtree'.")
  6142. (defvar org-subtree-clip-folded nil
  6143. "Was the last copied subtree folded?
  6144. This is used to fold the tree back after pasting.")
  6145. (defun org-cut-subtree (&optional n)
  6146. "Cut the current subtree into the clipboard.
  6147. With prefix arg N, cut this many sequential subtrees.
  6148. This is a short-hand for marking the subtree and then cutting it."
  6149. (interactive "p")
  6150. (org-copy-subtree n 'cut))
  6151. (defun org-copy-subtree (&optional n cut force-store-markers)
  6152. "Cut the current subtree into the clipboard.
  6153. With prefix arg N, cut this many sequential subtrees.
  6154. This is a short-hand for marking the subtree and then copying it.
  6155. If CUT is non-nil, actually cut the subtree.
  6156. If FORCE-STORE-MARKERS is non-nil, store the relative locations
  6157. of some markers in the region, even if CUT is non-nil. This is
  6158. useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
  6159. (interactive "p")
  6160. (let (beg end folded (beg0 (point)))
  6161. (if (interactive-p)
  6162. (org-back-to-heading nil) ; take what looks like a subtree
  6163. (org-back-to-heading t)) ; take what is really there
  6164. (org-back-over-empty-lines)
  6165. (setq beg (point))
  6166. (skip-chars-forward " \t\r\n")
  6167. (save-match-data
  6168. (save-excursion (outline-end-of-heading)
  6169. (setq folded (org-invisible-p)))
  6170. (condition-case nil
  6171. (org-forward-same-level (1- n) t)
  6172. (error nil))
  6173. (org-end-of-subtree t t))
  6174. (org-back-over-empty-lines)
  6175. (setq end (point))
  6176. (goto-char beg0)
  6177. (when (> end beg)
  6178. (setq org-subtree-clip-folded folded)
  6179. (when (or cut force-store-markers)
  6180. (org-save-markers-in-region beg end))
  6181. (if cut (kill-region beg end) (copy-region-as-kill beg end))
  6182. (setq org-subtree-clip (current-kill 0))
  6183. (message "%s: Subtree(s) with %d characters"
  6184. (if cut "Cut" "Copied")
  6185. (length org-subtree-clip)))))
  6186. (defun org-paste-subtree (&optional level tree for-yank)
  6187. "Paste the clipboard as a subtree, with modification of headline level.
  6188. The entire subtree is promoted or demoted in order to match a new headline
  6189. level.
  6190. If the cursor is at the beginning of a headline, the same level as
  6191. that headline is used to paste the tree
  6192. If not, the new level is derived from the *visible* headings
  6193. before and after the insertion point, and taken to be the inferior headline
  6194. level of the two. So if the previous visible heading is level 3 and the
  6195. next is level 4 (or vice versa), level 4 will be used for insertion.
  6196. This makes sure that the subtree remains an independent subtree and does
  6197. not swallow low level entries.
  6198. You can also force a different level, either by using a numeric prefix
  6199. argument, or by inserting the heading marker by hand. For example, if the
  6200. cursor is after \"*****\", then the tree will be shifted to level 5.
  6201. If optional TREE is given, use this text instead of the kill ring.
  6202. When FOR-YANK is set, this is called by `org-yank'. In this case, do not
  6203. move back over whitespace before inserting, and move point to the end of
  6204. the inserted text when done."
  6205. (interactive "P")
  6206. (setq tree (or tree (and kill-ring (current-kill 0))))
  6207. (unless (org-kill-is-subtree-p tree)
  6208. (error "%s"
  6209. (substitute-command-keys
  6210. "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
  6211. (let* ((visp (not (org-invisible-p)))
  6212. (txt tree)
  6213. (^re (concat "^\\(" outline-regexp "\\)"))
  6214. (re (concat "\\(" outline-regexp "\\)"))
  6215. (^re_ (concat "\\(\\*+\\)[ \t]*"))
  6216. (old-level (if (string-match ^re txt)
  6217. (- (match-end 0) (match-beginning 0) 1)
  6218. -1))
  6219. (force-level (cond (level (prefix-numeric-value level))
  6220. ((and (looking-at "[ \t]*$")
  6221. (string-match
  6222. ^re_ (buffer-substring
  6223. (point-at-bol) (point))))
  6224. (- (match-end 1) (match-beginning 1)))
  6225. ((and (bolp)
  6226. (looking-at org-outline-regexp))
  6227. (- (match-end 0) (point) 1))
  6228. (t nil)))
  6229. (previous-level (save-excursion
  6230. (condition-case nil
  6231. (progn
  6232. (outline-previous-visible-heading 1)
  6233. (if (looking-at re)
  6234. (- (match-end 0) (match-beginning 0) 1)
  6235. 1))
  6236. (error 1))))
  6237. (next-level (save-excursion
  6238. (condition-case nil
  6239. (progn
  6240. (or (looking-at outline-regexp)
  6241. (outline-next-visible-heading 1))
  6242. (if (looking-at re)
  6243. (- (match-end 0) (match-beginning 0) 1)
  6244. 1))
  6245. (error 1))))
  6246. (new-level (or force-level (max previous-level next-level)))
  6247. (shift (if (or (= old-level -1)
  6248. (= new-level -1)
  6249. (= old-level new-level))
  6250. 0
  6251. (- new-level old-level)))
  6252. (delta (if (> shift 0) -1 1))
  6253. (func (if (> shift 0) 'org-demote 'org-promote))
  6254. (org-odd-levels-only nil)
  6255. beg end newend)
  6256. ;; Remove the forced level indicator
  6257. (if force-level
  6258. (delete-region (point-at-bol) (point)))
  6259. ;; Paste
  6260. (beginning-of-line 1)
  6261. (unless for-yank (org-back-over-empty-lines))
  6262. (setq beg (point))
  6263. (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
  6264. (insert-before-markers txt)
  6265. (unless (string-match "\n\\'" txt) (insert "\n"))
  6266. (setq newend (point))
  6267. (org-reinstall-markers-in-region beg)
  6268. (setq end (point))
  6269. (goto-char beg)
  6270. (skip-chars-forward " \t\n\r")
  6271. (setq beg (point))
  6272. (if (and (org-invisible-p) visp)
  6273. (save-excursion (outline-show-heading)))
  6274. ;; Shift if necessary
  6275. (unless (= shift 0)
  6276. (save-restriction
  6277. (narrow-to-region beg end)
  6278. (while (not (= shift 0))
  6279. (org-map-region func (point-min) (point-max))
  6280. (setq shift (+ delta shift)))
  6281. (goto-char (point-min))
  6282. (setq newend (point-max))))
  6283. (when (or (interactive-p) for-yank)
  6284. (message "Clipboard pasted as level %d subtree" new-level))
  6285. (if (and (not for-yank) ; in this case, org-yank will decide about folding
  6286. kill-ring
  6287. (eq org-subtree-clip (current-kill 0))
  6288. org-subtree-clip-folded)
  6289. ;; The tree was folded before it was killed/copied
  6290. (hide-subtree))
  6291. (and for-yank (goto-char newend))))
  6292. (defun org-kill-is-subtree-p (&optional txt)
  6293. "Check if the current kill is an outline subtree, or a set of trees.
  6294. Returns nil if kill does not start with a headline, or if the first
  6295. headline level is not the largest headline level in the tree.
  6296. So this will actually accept several entries of equal levels as well,
  6297. which is OK for `org-paste-subtree'.
  6298. If optional TXT is given, check this string instead of the current kill."
  6299. (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
  6300. (start-level (and kill
  6301. (string-match (concat "\\`\\([ \t\n\r]*?\n\\)?\\("
  6302. org-outline-regexp "\\)")
  6303. kill)
  6304. (- (match-end 2) (match-beginning 2) 1)))
  6305. (re (concat "^" org-outline-regexp))
  6306. (start (1+ (or (match-beginning 2) -1))))
  6307. (if (not start-level)
  6308. (progn
  6309. nil) ;; does not even start with a heading
  6310. (catch 'exit
  6311. (while (setq start (string-match re kill (1+ start)))
  6312. (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
  6313. (throw 'exit nil)))
  6314. t))))
  6315. (defvar org-markers-to-move nil
  6316. "Markers that should be moved with a cut-and-paste operation.
  6317. Those markers are stored together with their positions relative to
  6318. the start of the region.")
  6319. (defun org-save-markers-in-region (beg end)
  6320. "Check markers in region.
  6321. If these markers are between BEG and END, record their position relative
  6322. to BEG, so that after moving the block of text, we can put the markers back
  6323. into place.
  6324. This function gets called just before an entry or tree gets cut from the
  6325. buffer. After re-insertion, `org-reinstall-markers-in-region' must be
  6326. called immediately, to move the markers with the entries."
  6327. (setq org-markers-to-move nil)
  6328. (when (featurep 'org-clock)
  6329. (org-clock-save-markers-for-cut-and-paste beg end))
  6330. (when (featurep 'org-agenda)
  6331. (org-agenda-save-markers-for-cut-and-paste beg end)))
  6332. (defun org-check-and-save-marker (marker beg end)
  6333. "Check if MARKER is between BEG and END.
  6334. If yes, remember the marker and the distance to BEG."
  6335. (when (and (marker-buffer marker)
  6336. (equal (marker-buffer marker) (current-buffer)))
  6337. (if (and (>= marker beg) (< marker end))
  6338. (push (cons marker (- marker beg)) org-markers-to-move))))
  6339. (defun org-reinstall-markers-in-region (beg)
  6340. "Move all remembered markers to their position relative to BEG."
  6341. (mapc (lambda (x)
  6342. (move-marker (car x) (+ beg (cdr x))))
  6343. org-markers-to-move)
  6344. (setq org-markers-to-move nil))
  6345. (defun org-narrow-to-subtree ()
  6346. "Narrow buffer to the current subtree."
  6347. (interactive)
  6348. (save-excursion
  6349. (save-match-data
  6350. (narrow-to-region
  6351. (progn (org-back-to-heading t) (point))
  6352. (progn (org-end-of-subtree t t)
  6353. (if (org-on-heading-p) (backward-char 1))
  6354. (point))))))
  6355. (defun org-clone-subtree-with-time-shift (n &optional shift)
  6356. "Clone the task (subtree) at point N times.
  6357. The clones will be inserted as siblings.
  6358. In interactive use, the user will be prompted for the number of clones
  6359. to be produced, and for a time SHIFT, which may be a repeater as used
  6360. in time stamps, for example `+3d'.
  6361. When a valid repeater is given and the entry contains any time stamps,
  6362. the clones will become a sequence in time, with time stamps in the
  6363. subtree shifted for each clone produced. If SHIFT is nil or the
  6364. empty string, time stamps will be left alone.
  6365. If the original subtree did contain time stamps with a repeater,
  6366. the following will happen:
  6367. - the repeater will be removed in each clone
  6368. - an additional clone will be produced, with the current, unshifted
  6369. date(s) in the entry.
  6370. - the original entry will be placed *after* all the clones, with
  6371. repeater intact.
  6372. - the start days in the repeater in the original entry will be shifted
  6373. to past the last clone.
  6374. I this way you can spell out a number of instances of a repeating task,
  6375. and still retain the repeater to cover future instances of the task."
  6376. (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
  6377. (let (beg end template task
  6378. shift-n shift-what doshift nmin nmax (n-no-remove -1))
  6379. (if (not (and (integerp n) (> n 0)))
  6380. (error "Invalid number of replications %s" n))
  6381. (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
  6382. (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([dwmy]\\)[ \t]*\\'"
  6383. shift)))
  6384. (error "Invalid shift specification %s" shift))
  6385. (when doshift
  6386. (setq shift-n (string-to-number (match-string 1 shift))
  6387. shift-what (cdr (assoc (match-string 2 shift)
  6388. '(("d" . day) ("w" . week)
  6389. ("m" . month) ("y" . year))))))
  6390. (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
  6391. (setq nmin 1 nmax n)
  6392. (org-back-to-heading t)
  6393. (setq beg (point))
  6394. (org-end-of-subtree t t)
  6395. (or (bolp) (insert "\n"))
  6396. (setq end (point))
  6397. (setq template (buffer-substring beg end))
  6398. (when (and doshift
  6399. (string-match "<[^<>\n]+ \\+[0-9]+[dwmy][^<>\n]*>" template))
  6400. (delete-region beg end)
  6401. (setq end beg)
  6402. (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
  6403. (goto-char end)
  6404. (loop for n from nmin to nmax do
  6405. (if (not doshift)
  6406. (setq task template)
  6407. (with-temp-buffer
  6408. (insert template)
  6409. (org-mode)
  6410. (goto-char (point-min))
  6411. (while (re-search-forward org-ts-regexp-both nil t)
  6412. (org-timestamp-change (* n shift-n) shift-what))
  6413. (unless (= n n-no-remove)
  6414. (goto-char (point-min))
  6415. (while (re-search-forward org-ts-regexp nil t)
  6416. (save-excursion
  6417. (goto-char (match-beginning 0))
  6418. (if (looking-at "<[^<>\n]+\\( +\\+[0-9]+[dwmy]\\)")
  6419. (delete-region (match-beginning 1) (match-end 1))))))
  6420. (setq task (buffer-string))))
  6421. (insert task))
  6422. (goto-char beg)))
  6423. ;;; Outline Sorting
  6424. (defun org-sort (with-case)
  6425. "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
  6426. Optional argument WITH-CASE means sort case-sensitively.
  6427. With a double prefix argument, also remove duplicate entries."
  6428. (interactive "P")
  6429. (if (org-at-table-p)
  6430. (org-call-with-arg 'org-table-sort-lines with-case)
  6431. (org-call-with-arg 'org-sort-entries-or-items with-case)))
  6432. (defun org-sort-remove-invisible (s)
  6433. (remove-text-properties 0 (length s) org-rm-props s)
  6434. (while (string-match org-bracket-link-regexp s)
  6435. (setq s (replace-match (if (match-end 2)
  6436. (match-string 3 s)
  6437. (match-string 1 s)) t t s)))
  6438. s)
  6439. (defvar org-priority-regexp) ; defined later in the file
  6440. (defvar org-after-sorting-entries-or-items-hook nil
  6441. "Hook that is run after a bunch of entries or items have been sorted.
  6442. When children are sorted, the cursor is in the parent line when this
  6443. hook gets called. When a region or a plain list is sorted, the cursor
  6444. will be in the first entry of the sorted region/list.")
  6445. (defun org-sort-entries-or-items
  6446. (&optional with-case sorting-type getkey-func compare-func property)
  6447. "Sort entries on a certain level of an outline tree, or plain list items.
  6448. If there is an active region, the entries in the region are sorted.
  6449. Else, if the cursor is before the first entry, sort the top-level items.
  6450. Else, the children of the entry at point are sorted.
  6451. If the cursor is at the first item in a plain list, the list items will be
  6452. sorted.
  6453. Sorting can be alphabetically, numerically, by date/time as given by
  6454. a time stamp, by a property or by priority.
  6455. The command prompts for the sorting type unless it has been given to the
  6456. function through the SORTING-TYPE argument, which needs to be a character,
  6457. \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
  6458. precise meaning of each character:
  6459. n Numerically, by converting the beginning of the entry/item to a number.
  6460. a Alphabetically, ignoring the TODO keyword and the priority, if any.
  6461. t By date/time, either the first active time stamp in the entry, or, if
  6462. none exist, by the first inactive one.
  6463. In items, only the first line will be checked.
  6464. s By the scheduled date/time.
  6465. d By deadline date/time.
  6466. c By creation time, which is assumed to be the first inactive time stamp
  6467. at the beginning of a line.
  6468. p By priority according to the cookie.
  6469. r By the value of a property.
  6470. Capital letters will reverse the sort order.
  6471. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
  6472. called with point at the beginning of the record. It must return either
  6473. a string or a number that should serve as the sorting key for that record.
  6474. Comparing entries ignores case by default. However, with an optional argument
  6475. WITH-CASE, the sorting considers case as well."
  6476. (interactive "P")
  6477. (let ((case-func (if with-case 'identity 'downcase))
  6478. start beg end stars re re2
  6479. txt what tmp plain-list-p)
  6480. ;; Find beginning and end of region to sort
  6481. (cond
  6482. ((org-region-active-p)
  6483. ;; we will sort the region
  6484. (setq end (region-end)
  6485. what "region")
  6486. (goto-char (region-beginning))
  6487. (if (not (org-on-heading-p)) (outline-next-heading))
  6488. (setq start (point)))
  6489. ((org-at-item-p)
  6490. ;; we will sort this plain list
  6491. (org-beginning-of-item-list) (setq start (point))
  6492. (org-end-of-item-list)
  6493. (or (bolp) (insert "\n"))
  6494. (setq end (point))
  6495. (goto-char start)
  6496. (setq plain-list-p t
  6497. what "plain list"))
  6498. ((or (org-on-heading-p)
  6499. (condition-case nil (progn (org-back-to-heading) t) (error nil)))
  6500. ;; we will sort the children of the current headline
  6501. (org-back-to-heading)
  6502. (setq start (point)
  6503. end (progn (org-end-of-subtree t t)
  6504. (or (bolp) (insert "\n"))
  6505. (org-back-over-empty-lines)
  6506. (point))
  6507. what "children")
  6508. (goto-char start)
  6509. (show-subtree)
  6510. (outline-next-heading))
  6511. (t
  6512. ;; we will sort the top-level entries in this file
  6513. (goto-char (point-min))
  6514. (or (org-on-heading-p) (outline-next-heading))
  6515. (setq start (point))
  6516. (goto-char (point-max))
  6517. (beginning-of-line 1)
  6518. (when (looking-at ".*?\\S-")
  6519. ;; File ends in a non-white line
  6520. (end-of-line 1)
  6521. (insert "\n"))
  6522. (setq end (point-max))
  6523. (setq what "top-level")
  6524. (goto-char start)
  6525. (show-all)))
  6526. (setq beg (point))
  6527. (if (>= beg end) (error "Nothing to sort"))
  6528. (unless plain-list-p
  6529. (looking-at "\\(\\*+\\)")
  6530. (setq stars (match-string 1)
  6531. re (concat "^" (regexp-quote stars) " +")
  6532. re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
  6533. txt (buffer-substring beg end))
  6534. (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
  6535. (if (and (not (equal stars "*")) (string-match re2 txt))
  6536. (error "Region to sort contains a level above the first entry")))
  6537. (unless sorting-type
  6538. (message
  6539. (if plain-list-p
  6540. "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
  6541. "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
  6542. [t]ime [s]cheduled [d]eadline [c]reated
  6543. A/N/T/S/D/C/P/O/F means reversed:")
  6544. what)
  6545. (setq sorting-type (read-char-exclusive))
  6546. (and (= (downcase sorting-type) ?f)
  6547. (setq getkey-func
  6548. (org-icompleting-read "Sort using function: "
  6549. obarray 'fboundp t nil nil))
  6550. (setq getkey-func (intern getkey-func)))
  6551. (and (= (downcase sorting-type) ?r)
  6552. (setq property
  6553. (org-icompleting-read "Property: "
  6554. (mapcar 'list (org-buffer-property-keys t))
  6555. nil t))))
  6556. (message "Sorting entries...")
  6557. (save-restriction
  6558. (narrow-to-region start end)
  6559. (let ((dcst (downcase sorting-type))
  6560. (case-fold-search nil)
  6561. (now (current-time)))
  6562. (sort-subr
  6563. (/= dcst sorting-type)
  6564. ;; This function moves to the beginning character of the "record" to
  6565. ;; be sorted.
  6566. (if plain-list-p
  6567. (lambda nil
  6568. (if (org-at-item-p) t (goto-char (point-max))))
  6569. (lambda nil
  6570. (if (re-search-forward re nil t)
  6571. (goto-char (match-beginning 0))
  6572. (goto-char (point-max)))))
  6573. ;; This function moves to the last character of the "record" being
  6574. ;; sorted.
  6575. (if plain-list-p
  6576. 'org-end-of-item
  6577. (lambda nil
  6578. (save-match-data
  6579. (condition-case nil
  6580. (outline-forward-same-level 1)
  6581. (error
  6582. (goto-char (point-max)))))))
  6583. ;; This function returns the value that gets sorted against.
  6584. (if plain-list-p
  6585. (lambda nil
  6586. (when (looking-at "[ \t]*[-+*0-9.)]+[ \t]+")
  6587. (cond
  6588. ((= dcst ?n)
  6589. (string-to-number (buffer-substring (match-end 0)
  6590. (point-at-eol))))
  6591. ((= dcst ?a)
  6592. (buffer-substring (match-end 0) (point-at-eol)))
  6593. ((= dcst ?t)
  6594. (if (or (re-search-forward org-ts-regexp (point-at-eol) t)
  6595. (re-search-forward org-ts-regexp-both
  6596. (point-at-eol) t))
  6597. (org-time-string-to-seconds (match-string 0))
  6598. (org-float-time now)))
  6599. ((= dcst ?f)
  6600. (if getkey-func
  6601. (progn
  6602. (setq tmp (funcall getkey-func))
  6603. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  6604. tmp)
  6605. (error "Invalid key function `%s'" getkey-func)))
  6606. (t (error "Invalid sorting type `%c'" sorting-type)))))
  6607. (lambda nil
  6608. (cond
  6609. ((= dcst ?n)
  6610. (if (looking-at org-complex-heading-regexp)
  6611. (string-to-number (match-string 4))
  6612. nil))
  6613. ((= dcst ?a)
  6614. (if (looking-at org-complex-heading-regexp)
  6615. (funcall case-func (match-string 4))
  6616. nil))
  6617. ((= dcst ?t)
  6618. (let ((end (save-excursion (outline-next-heading) (point))))
  6619. (if (or (re-search-forward org-ts-regexp end t)
  6620. (re-search-forward org-ts-regexp-both end t))
  6621. (org-time-string-to-seconds (match-string 0))
  6622. (org-float-time now))))
  6623. ((= dcst ?c)
  6624. (let ((end (save-excursion (outline-next-heading) (point))))
  6625. (if (re-search-forward
  6626. (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
  6627. end t)
  6628. (org-time-string-to-seconds (match-string 0))
  6629. (org-float-time now))))
  6630. ((= dcst ?s)
  6631. (let ((end (save-excursion (outline-next-heading) (point))))
  6632. (if (re-search-forward org-scheduled-time-regexp end t)
  6633. (org-time-string-to-seconds (match-string 1))
  6634. (org-float-time now))))
  6635. ((= dcst ?d)
  6636. (let ((end (save-excursion (outline-next-heading) (point))))
  6637. (if (re-search-forward org-deadline-time-regexp end t)
  6638. (org-time-string-to-seconds (match-string 1))
  6639. (org-float-time now))))
  6640. ((= dcst ?p)
  6641. (if (re-search-forward org-priority-regexp (point-at-eol) t)
  6642. (string-to-char (match-string 2))
  6643. org-default-priority))
  6644. ((= dcst ?r)
  6645. (or (org-entry-get nil property) ""))
  6646. ((= dcst ?o)
  6647. (if (looking-at org-complex-heading-regexp)
  6648. (- 9999 (length (member (match-string 2)
  6649. org-todo-keywords-1)))))
  6650. ((= dcst ?f)
  6651. (if getkey-func
  6652. (progn
  6653. (setq tmp (funcall getkey-func))
  6654. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  6655. tmp)
  6656. (error "Invalid key function `%s'" getkey-func)))
  6657. (t (error "Invalid sorting type `%c'" sorting-type)))))
  6658. nil
  6659. (cond
  6660. ((= dcst ?a) 'string<)
  6661. ((= dcst ?f) compare-func)
  6662. ((member dcst '(?p ?t ?s ?d ?c)) '<)
  6663. (t nil)))))
  6664. (run-hooks 'org-after-sorting-entries-or-items-hook)
  6665. (message "Sorting entries...done")))
  6666. (defun org-do-sort (table what &optional with-case sorting-type)
  6667. "Sort TABLE of WHAT according to SORTING-TYPE.
  6668. The user will be prompted for the SORTING-TYPE if the call to this
  6669. function does not specify it. WHAT is only for the prompt, to indicate
  6670. what is being sorted. The sorting key will be extracted from
  6671. the car of the elements of the table.
  6672. If WITH-CASE is non-nil, the sorting will be case-sensitive."
  6673. (unless sorting-type
  6674. (message
  6675. "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
  6676. what)
  6677. (setq sorting-type (read-char-exclusive)))
  6678. (let ((dcst (downcase sorting-type))
  6679. extractfun comparefun)
  6680. ;; Define the appropriate functions
  6681. (cond
  6682. ((= dcst ?n)
  6683. (setq extractfun 'string-to-number
  6684. comparefun (if (= dcst sorting-type) '< '>)))
  6685. ((= dcst ?a)
  6686. (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
  6687. (lambda(x) (downcase (org-sort-remove-invisible x))))
  6688. comparefun (if (= dcst sorting-type)
  6689. 'string<
  6690. (lambda (a b) (and (not (string< a b))
  6691. (not (string= a b)))))))
  6692. ((= dcst ?t)
  6693. (setq extractfun
  6694. (lambda (x)
  6695. (if (or (string-match org-ts-regexp x)
  6696. (string-match org-ts-regexp-both x))
  6697. (org-float-time
  6698. (org-time-string-to-time (match-string 0 x)))
  6699. 0))
  6700. comparefun (if (= dcst sorting-type) '< '>)))
  6701. (t (error "Invalid sorting type `%c'" sorting-type)))
  6702. (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
  6703. table)
  6704. (lambda (a b) (funcall comparefun (car a) (car b))))))
  6705. ;;; The orgstruct minor mode
  6706. ;; Define a minor mode which can be used in other modes in order to
  6707. ;; integrate the org-mode structure editing commands.
  6708. ;; This is really a hack, because the org-mode structure commands use
  6709. ;; keys which normally belong to the major mode. Here is how it
  6710. ;; works: The minor mode defines all the keys necessary to operate the
  6711. ;; structure commands, but wraps the commands into a function which
  6712. ;; tests if the cursor is currently at a headline or a plain list
  6713. ;; item. If that is the case, the structure command is used,
  6714. ;; temporarily setting many Org-mode variables like regular
  6715. ;; expressions for filling etc. However, when any of those keys is
  6716. ;; used at a different location, function uses `key-binding' to look
  6717. ;; up if the key has an associated command in another currently active
  6718. ;; keymap (minor modes, major mode, global), and executes that
  6719. ;; command. There might be problems if any of the keys is otherwise
  6720. ;; used as a prefix key.
  6721. ;; Another challenge is that the key binding for TAB can be tab or \C-i,
  6722. ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
  6723. ;; addresses this by checking explicitly for both bindings.
  6724. (defvar orgstruct-mode-map (make-sparse-keymap)
  6725. "Keymap for the minor `orgstruct-mode'.")
  6726. (defvar org-local-vars nil
  6727. "List of local variables, for use by `orgstruct-mode'")
  6728. ;;;###autoload
  6729. (define-minor-mode orgstruct-mode
  6730. "Toggle the minor mode `orgstruct-mode'.
  6731. This mode is for using Org-mode structure commands in other
  6732. modes. The following keys behave as if Org-mode were active, if
  6733. the cursor is on a headline, or on a plain list item (both as
  6734. defined by Org-mode).
  6735. M-up Move entry/item up
  6736. M-down Move entry/item down
  6737. M-left Promote
  6738. M-right Demote
  6739. M-S-up Move entry/item up
  6740. M-S-down Move entry/item down
  6741. M-S-left Promote subtree
  6742. M-S-right Demote subtree
  6743. M-q Fill paragraph and items like in Org-mode
  6744. C-c ^ Sort entries
  6745. C-c - Cycle list bullet
  6746. TAB Cycle item visibility
  6747. M-RET Insert new heading/item
  6748. S-M-RET Insert new TODO heading / Checkbox item
  6749. C-c C-c Set tags / toggle checkbox"
  6750. nil " OrgStruct" nil
  6751. (org-load-modules-maybe)
  6752. (and (orgstruct-setup) (defun orgstruct-setup () nil)))
  6753. ;;;###autoload
  6754. (defun turn-on-orgstruct ()
  6755. "Unconditionally turn on `orgstruct-mode'."
  6756. (orgstruct-mode 1))
  6757. (defun orgstruct++-mode (&optional arg)
  6758. "Toggle `orgstruct-mode', the enhanced version of it.
  6759. In addition to setting orgstruct-mode, this also exports all indentation
  6760. and autofilling variables from org-mode into the buffer. It will also
  6761. recognize item context in multiline items.
  6762. Note that turning off orgstruct-mode will *not* remove the
  6763. indentation/paragraph settings. This can only be done by refreshing the
  6764. major mode, for example with \\[normal-mode]."
  6765. (interactive "P")
  6766. (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
  6767. (if (< arg 1)
  6768. (orgstruct-mode -1)
  6769. (orgstruct-mode 1)
  6770. (let (var val)
  6771. (mapc
  6772. (lambda (x)
  6773. (when (string-match
  6774. "^\\(paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
  6775. (symbol-name (car x)))
  6776. (setq var (car x) val (nth 1 x))
  6777. (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
  6778. org-local-vars)
  6779. (org-set-local 'orgstruct-is-++ t))))
  6780. (defvar orgstruct-is-++ nil
  6781. "Is orgstruct-mode in ++ version in the current-buffer?")
  6782. (make-variable-buffer-local 'orgstruct-is-++)
  6783. ;;;###autoload
  6784. (defun turn-on-orgstruct++ ()
  6785. "Unconditionally turn on `orgstruct++-mode'."
  6786. (orgstruct++-mode 1))
  6787. (defun orgstruct-error ()
  6788. "Error when there is no default binding for a structure key."
  6789. (interactive)
  6790. (error "This key has no function outside structure elements"))
  6791. (defun orgstruct-setup ()
  6792. "Setup orgstruct keymaps."
  6793. (let ((nfunc 0)
  6794. (bindings
  6795. (list
  6796. '([(meta up)] org-metaup)
  6797. '([(meta down)] org-metadown)
  6798. '([(meta left)] org-metaleft)
  6799. '([(meta right)] org-metaright)
  6800. '([(meta shift up)] org-shiftmetaup)
  6801. '([(meta shift down)] org-shiftmetadown)
  6802. '([(meta shift left)] org-shiftmetaleft)
  6803. '([(meta shift right)] org-shiftmetaright)
  6804. '([?\e (up)] org-metaup)
  6805. '([?\e (down)] org-metadown)
  6806. '([?\e (left)] org-metaleft)
  6807. '([?\e (right)] org-metaright)
  6808. '([?\e (shift up)] org-shiftmetaup)
  6809. '([?\e (shift down)] org-shiftmetadown)
  6810. '([?\e (shift left)] org-shiftmetaleft)
  6811. '([?\e (shift right)] org-shiftmetaright)
  6812. '([(shift up)] org-shiftup)
  6813. '([(shift down)] org-shiftdown)
  6814. '([(shift left)] org-shiftleft)
  6815. '([(shift right)] org-shiftright)
  6816. '("\C-c\C-c" org-ctrl-c-ctrl-c)
  6817. '("\M-q" fill-paragraph)
  6818. '("\C-c^" org-sort)
  6819. '("\C-c-" org-cycle-list-bullet)))
  6820. elt key fun cmd)
  6821. (while (setq elt (pop bindings))
  6822. (setq nfunc (1+ nfunc))
  6823. (setq key (org-key (car elt))
  6824. fun (nth 1 elt)
  6825. cmd (orgstruct-make-binding fun nfunc key))
  6826. (org-defkey orgstruct-mode-map key cmd))
  6827. ;; Special treatment needed for TAB and RET
  6828. (org-defkey orgstruct-mode-map [(tab)]
  6829. (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
  6830. (org-defkey orgstruct-mode-map "\C-i"
  6831. (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
  6832. (org-defkey orgstruct-mode-map "\M-\C-m"
  6833. (orgstruct-make-binding 'org-insert-heading 105
  6834. "\M-\C-m" [(meta return)]))
  6835. (org-defkey orgstruct-mode-map [(meta return)]
  6836. (orgstruct-make-binding 'org-insert-heading 106
  6837. [(meta return)] "\M-\C-m"))
  6838. (org-defkey orgstruct-mode-map [(shift meta return)]
  6839. (orgstruct-make-binding 'org-insert-todo-heading 107
  6840. [(meta return)] "\M-\C-m"))
  6841. (org-defkey orgstruct-mode-map "\e\C-m"
  6842. (orgstruct-make-binding 'org-insert-heading 108
  6843. "\e\C-m" [?\e (return)]))
  6844. (org-defkey orgstruct-mode-map [?\e (return)]
  6845. (orgstruct-make-binding 'org-insert-heading 109
  6846. [?\e (return)] "\e\C-m"))
  6847. (org-defkey orgstruct-mode-map [?\e (shift return)]
  6848. (orgstruct-make-binding 'org-insert-todo-heading 110
  6849. [?\e (return)] "\e\C-m"))
  6850. (unless org-local-vars
  6851. (setq org-local-vars (org-get-local-variables)))
  6852. t))
  6853. (defun orgstruct-make-binding (fun n &rest keys)
  6854. "Create a function for binding in the structure minor mode.
  6855. FUN is the command to call inside a table. N is used to create a unique
  6856. command name. KEYS are keys that should be checked in for a command
  6857. to execute outside of tables."
  6858. (eval
  6859. (list 'defun
  6860. (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
  6861. '(arg)
  6862. (concat "In Structure, run `" (symbol-name fun) "'.\n"
  6863. "Outside of structure, run the binding of `"
  6864. (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
  6865. "'.")
  6866. '(interactive "p")
  6867. (list 'if
  6868. `(org-context-p 'headline 'item
  6869. (and orgstruct-is-++
  6870. ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
  6871. 'item-body))
  6872. (list 'org-run-like-in-org-mode (list 'quote fun))
  6873. (list 'let '(orgstruct-mode)
  6874. (list 'call-interactively
  6875. (append '(or)
  6876. (mapcar (lambda (k)
  6877. (list 'key-binding k))
  6878. keys)
  6879. '('orgstruct-error))))))))
  6880. (defun org-context-p (&rest contexts)
  6881. "Check if local context is any of CONTEXTS.
  6882. Possible values in the list of contexts are `table', `headline', and `item'."
  6883. (let ((pos (point)))
  6884. (goto-char (point-at-bol))
  6885. (prog1 (or (and (memq 'table contexts)
  6886. (looking-at "[ \t]*|"))
  6887. (and (memq 'headline contexts)
  6888. ;;????????? (looking-at "\\*+"))
  6889. (looking-at outline-regexp))
  6890. (and (memq 'item contexts)
  6891. (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
  6892. (and (memq 'item-body contexts)
  6893. (org-in-item-p)))
  6894. (goto-char pos))))
  6895. (defun org-get-local-variables ()
  6896. "Return a list of all local variables in an org-mode buffer."
  6897. (let (varlist)
  6898. (with-current-buffer (get-buffer-create "*Org tmp*")
  6899. (erase-buffer)
  6900. (org-mode)
  6901. (setq varlist (buffer-local-variables)))
  6902. (kill-buffer "*Org tmp*")
  6903. (delq nil
  6904. (mapcar
  6905. (lambda (x)
  6906. (setq x
  6907. (if (symbolp x)
  6908. (list x)
  6909. (list (car x) (list 'quote (cdr x)))))
  6910. (if (string-match
  6911. "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
  6912. (symbol-name (car x)))
  6913. x nil))
  6914. varlist))))
  6915. ;;;###autoload
  6916. (defun org-run-like-in-org-mode (cmd)
  6917. "Run a command, pretending that the current buffer is in Org-mode.
  6918. This will temporarily bind local variables that are typically bound in
  6919. Org-mode to the values they have in Org-mode, and then interactively
  6920. call CMD."
  6921. (org-load-modules-maybe)
  6922. (unless org-local-vars
  6923. (setq org-local-vars (org-get-local-variables)))
  6924. (eval (list 'let org-local-vars
  6925. (list 'call-interactively (list 'quote cmd)))))
  6926. ;;;; Archiving
  6927. (defun org-get-category (&optional pos)
  6928. "Get the category applying to position POS."
  6929. (get-text-property (or pos (point)) 'org-category))
  6930. (defun org-refresh-category-properties ()
  6931. "Refresh category text properties in the buffer."
  6932. (let ((def-cat (cond
  6933. ((null org-category)
  6934. (if buffer-file-name
  6935. (file-name-sans-extension
  6936. (file-name-nondirectory buffer-file-name))
  6937. "???"))
  6938. ((symbolp org-category) (symbol-name org-category))
  6939. (t org-category)))
  6940. beg end cat pos optionp)
  6941. (org-unmodified
  6942. (save-excursion
  6943. (save-restriction
  6944. (widen)
  6945. (goto-char (point-min))
  6946. (put-text-property (point) (point-max) 'org-category def-cat)
  6947. (while (re-search-forward
  6948. "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
  6949. (setq pos (match-end 0)
  6950. optionp (equal (char-after (match-beginning 0)) ?#)
  6951. cat (org-trim (match-string 2)))
  6952. (if optionp
  6953. (setq beg (point-at-bol) end (point-max))
  6954. (org-back-to-heading t)
  6955. (setq beg (point) end (org-end-of-subtree t t)))
  6956. (put-text-property beg end 'org-category cat)
  6957. (goto-char pos)))))))
  6958. ;;;; Link Stuff
  6959. ;;; Link abbreviations
  6960. (defun org-link-expand-abbrev (link)
  6961. "Apply replacements as defined in `org-link-abbrev-alist."
  6962. (if (string-match "^\\([a-zA-Z][-_a-zA-Z0-9]*\\)\\(::?\\(.*\\)\\)?$" link)
  6963. (let* ((key (match-string 1 link))
  6964. (as (or (assoc key org-link-abbrev-alist-local)
  6965. (assoc key org-link-abbrev-alist)))
  6966. (tag (and (match-end 2) (match-string 3 link)))
  6967. rpl)
  6968. (if (not as)
  6969. link
  6970. (setq rpl (cdr as))
  6971. (cond
  6972. ((symbolp rpl) (funcall rpl tag))
  6973. ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
  6974. ((string-match "%h" rpl)
  6975. (replace-match (url-hexify-string (or tag "")) t t rpl))
  6976. (t (concat rpl tag)))))
  6977. link))
  6978. ;;; Storing and inserting links
  6979. (defvar org-insert-link-history nil
  6980. "Minibuffer history for links inserted with `org-insert-link'.")
  6981. (defvar org-stored-links nil
  6982. "Contains the links stored with `org-store-link'.")
  6983. (defvar org-store-link-plist nil
  6984. "Plist with info about the most recently link created with `org-store-link'.")
  6985. (defvar org-link-protocols nil
  6986. "Link protocols added to Org-mode using `org-add-link-type'.")
  6987. (defvar org-store-link-functions nil
  6988. "List of functions that are called to create and store a link.
  6989. Each function will be called in turn until one returns a non-nil
  6990. value. Each function should check if it is responsible for creating
  6991. this link (for example by looking at the major mode).
  6992. If not, it must exit and return nil.
  6993. If yes, it should return a non-nil value after a calling
  6994. `org-store-link-props' with a list of properties and values.
  6995. Special properties are:
  6996. :type The link prefix. like \"http\". This must be given.
  6997. :link The link, like \"http://www.astro.uva.nl/~dominik\".
  6998. This is obligatory as well.
  6999. :description Optional default description for the second pair
  7000. of brackets in an Org-mode link. The user can still change
  7001. this when inserting this link into an Org-mode buffer.
  7002. In addition to these, any additional properties can be specified
  7003. and then used in remember templates.")
  7004. (defun org-add-link-type (type &optional follow export)
  7005. "Add TYPE to the list of `org-link-types'.
  7006. Re-compute all regular expressions depending on `org-link-types'
  7007. FOLLOW and EXPORT are two functions.
  7008. FOLLOW should take the link path as the single argument and do whatever
  7009. is necessary to follow the link, for example find a file or display
  7010. a mail message.
  7011. EXPORT should format the link path for export to one of the export formats.
  7012. It should be a function accepting three arguments:
  7013. path the path of the link, the text after the prefix (like \"http:\")
  7014. desc the description of the link, if any, nil if there was no description
  7015. format the export format, a symbol like `html' or `latex'.
  7016. The function may use the FORMAT information to return different values
  7017. depending on the format. The return value will be put literally into
  7018. the exported file.
  7019. Org-mode has a built-in default for exporting links. If you are happy with
  7020. this default, there is no need to define an export function for the link
  7021. type. For a simple example of an export function, see `org-bbdb.el'."
  7022. (add-to-list 'org-link-types type t)
  7023. (org-make-link-regexps)
  7024. (if (assoc type org-link-protocols)
  7025. (setcdr (assoc type org-link-protocols) (list follow export))
  7026. (push (list type follow export) org-link-protocols)))
  7027. (defvar org-agenda-buffer-name)
  7028. ;;;###autoload
  7029. (defun org-store-link (arg)
  7030. "\\<org-mode-map>Store an org-link to the current location.
  7031. This link is added to `org-stored-links' and can later be inserted
  7032. into an org-buffer with \\[org-insert-link].
  7033. For some link types, a prefix arg is interpreted:
  7034. For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
  7035. For file links, arg negates `org-context-in-file-links'."
  7036. (interactive "P")
  7037. (org-load-modules-maybe)
  7038. (setq org-store-link-plist nil) ; reset
  7039. (let ((outline-regexp (org-get-limited-outline-regexp))
  7040. link cpltxt desc description search txt custom-id)
  7041. (cond
  7042. ((run-hook-with-args-until-success 'org-store-link-functions)
  7043. (setq link (plist-get org-store-link-plist :link)
  7044. desc (or (plist-get org-store-link-plist :description) link)))
  7045. ((equal (buffer-name) "*Org Edit Src Example*")
  7046. (let (label gc)
  7047. (while (or (not label)
  7048. (save-excursion
  7049. (save-restriction
  7050. (widen)
  7051. (goto-char (point-min))
  7052. (re-search-forward
  7053. (regexp-quote (format org-coderef-label-format label))
  7054. nil t))))
  7055. (when label (message "Label exists already") (sit-for 2))
  7056. (setq label (read-string "Code line label: " label)))
  7057. (end-of-line 1)
  7058. (setq link (format org-coderef-label-format label))
  7059. (setq gc (- 79 (length link)))
  7060. (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
  7061. (insert link)
  7062. (setq link (concat "(" label ")") desc nil)))
  7063. ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
  7064. ;; We are in the agenda, link to referenced location
  7065. (let ((m (or (get-text-property (point) 'org-hd-marker)
  7066. (get-text-property (point) 'org-marker))))
  7067. (when m
  7068. (org-with-point-at m
  7069. (call-interactively 'org-store-link)))))
  7070. ((eq major-mode 'calendar-mode)
  7071. (let ((cd (calendar-cursor-to-date)))
  7072. (setq link
  7073. (format-time-string
  7074. (car org-time-stamp-formats)
  7075. (apply 'encode-time
  7076. (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
  7077. nil nil nil))))
  7078. (org-store-link-props :type "calendar" :date cd)))
  7079. ((eq major-mode 'w3-mode)
  7080. (setq cpltxt (if (and (buffer-name)
  7081. (not (string-match "Untitled" (buffer-name))))
  7082. (buffer-name)
  7083. (url-view-url t))
  7084. link (org-make-link (url-view-url t)))
  7085. (org-store-link-props :type "w3" :url (url-view-url t)))
  7086. ((eq major-mode 'w3m-mode)
  7087. (setq cpltxt (or w3m-current-title w3m-current-url)
  7088. link (org-make-link w3m-current-url))
  7089. (org-store-link-props :type "w3m" :url (url-view-url t)))
  7090. ((setq search (run-hook-with-args-until-success
  7091. 'org-create-file-search-functions))
  7092. (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
  7093. "::" search))
  7094. (setq cpltxt (or description link)))
  7095. ((eq major-mode 'image-mode)
  7096. (setq cpltxt (concat "file:"
  7097. (abbreviate-file-name buffer-file-name))
  7098. link (org-make-link cpltxt))
  7099. (org-store-link-props :type "image" :file buffer-file-name))
  7100. ((eq major-mode 'dired-mode)
  7101. ;; link to the file in the current line
  7102. (let ((file (dired-get-filename nil t)))
  7103. (setq file (if file
  7104. (abbreviate-file-name
  7105. (expand-file-name (dired-get-filename nil t)))
  7106. ;; otherwise, no file so use current directory.
  7107. default-directory))
  7108. (setq cpltxt (concat "file:" file)
  7109. link (org-make-link cpltxt))))
  7110. ((and buffer-file-name (org-mode-p))
  7111. (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
  7112. (cond
  7113. ((org-in-regexp "<<\\(.*?\\)>>")
  7114. (setq cpltxt
  7115. (concat "file:"
  7116. (abbreviate-file-name buffer-file-name)
  7117. "::" (match-string 1))
  7118. link (org-make-link cpltxt)))
  7119. ((and (featurep 'org-id)
  7120. (or (eq org-link-to-org-use-id t)
  7121. (and (eq org-link-to-org-use-id 'create-if-interactive)
  7122. (interactive-p))
  7123. (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
  7124. (interactive-p)
  7125. (not custom-id))
  7126. (and org-link-to-org-use-id
  7127. (condition-case nil
  7128. (org-entry-get nil "ID")
  7129. (error nil)))))
  7130. ;; We can make a link using the ID.
  7131. (setq link (condition-case nil
  7132. (prog1 (org-id-store-link)
  7133. (setq desc (plist-get org-store-link-plist
  7134. :description)))
  7135. (error
  7136. ;; probably before first headline, link to file only
  7137. (concat "file:"
  7138. (abbreviate-file-name buffer-file-name))))))
  7139. (t
  7140. ;; Just link to current headline
  7141. (setq cpltxt (concat "file:"
  7142. (abbreviate-file-name buffer-file-name)))
  7143. ;; Add a context search string
  7144. (when (org-xor org-context-in-file-links arg)
  7145. (setq txt (cond
  7146. ((org-on-heading-p) nil)
  7147. ((org-region-active-p)
  7148. (buffer-substring (region-beginning) (region-end)))
  7149. (t nil)))
  7150. (when (or (null txt) (string-match "\\S-" txt))
  7151. (setq cpltxt
  7152. (concat cpltxt "::"
  7153. (condition-case nil
  7154. (org-make-org-heading-search-string txt)
  7155. (error "")))
  7156. desc (or (nth 4 (ignore-errors
  7157. (org-heading-components))) "NONE"))))
  7158. (if (string-match "::\\'" cpltxt)
  7159. (setq cpltxt (substring cpltxt 0 -2)))
  7160. (setq link (org-make-link cpltxt)))))
  7161. ((buffer-file-name (buffer-base-buffer))
  7162. ;; Just link to this file here.
  7163. (setq cpltxt (concat "file:"
  7164. (abbreviate-file-name
  7165. (buffer-file-name (buffer-base-buffer)))))
  7166. ;; Add a context string
  7167. (when (org-xor org-context-in-file-links arg)
  7168. (setq txt (if (org-region-active-p)
  7169. (buffer-substring (region-beginning) (region-end))
  7170. (buffer-substring (point-at-bol) (point-at-eol))))
  7171. ;; Only use search option if there is some text.
  7172. (when (string-match "\\S-" txt)
  7173. (setq cpltxt
  7174. (concat cpltxt "::" (org-make-org-heading-search-string txt))
  7175. desc "NONE")))
  7176. (setq link (org-make-link cpltxt)))
  7177. ((interactive-p)
  7178. (error "Cannot link to a buffer which is not visiting a file"))
  7179. (t (setq link nil)))
  7180. (if (consp link) (setq cpltxt (car link) link (cdr link)))
  7181. (setq link (or link cpltxt)
  7182. desc (or desc cpltxt))
  7183. (if (equal desc "NONE") (setq desc nil))
  7184. (if (and (or (interactive-p) executing-kbd-macro) link)
  7185. (progn
  7186. (setq org-stored-links
  7187. (cons (list link desc) org-stored-links))
  7188. (message "Stored: %s" (or desc link))
  7189. (when custom-id
  7190. (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
  7191. "::#" custom-id))
  7192. (setq org-stored-links
  7193. (cons (list link desc) org-stored-links))))
  7194. (and link (org-make-link-string link desc)))))
  7195. (defun org-store-link-props (&rest plist)
  7196. "Store link properties, extract names and addresses."
  7197. (let (x adr)
  7198. (when (setq x (plist-get plist :from))
  7199. (setq adr (mail-extract-address-components x))
  7200. (setq plist (plist-put plist :fromname (car adr)))
  7201. (setq plist (plist-put plist :fromaddress (nth 1 adr))))
  7202. (when (setq x (plist-get plist :to))
  7203. (setq adr (mail-extract-address-components x))
  7204. (setq plist (plist-put plist :toname (car adr)))
  7205. (setq plist (plist-put plist :toaddress (nth 1 adr)))))
  7206. (let ((from (plist-get plist :from))
  7207. (to (plist-get plist :to)))
  7208. (when (and from to org-from-is-user-regexp)
  7209. (setq plist
  7210. (plist-put plist :fromto
  7211. (if (string-match org-from-is-user-regexp from)
  7212. (concat "to %t")
  7213. (concat "from %f"))))))
  7214. (setq org-store-link-plist plist))
  7215. (defun org-add-link-props (&rest plist)
  7216. "Add these properties to the link property list."
  7217. (let (key value)
  7218. (while plist
  7219. (setq key (pop plist) value (pop plist))
  7220. (setq org-store-link-plist
  7221. (plist-put org-store-link-plist key value)))))
  7222. (defun org-email-link-description (&optional fmt)
  7223. "Return the description part of an email link.
  7224. This takes information from `org-store-link-plist' and formats it
  7225. according to FMT (default from `org-email-link-description-format')."
  7226. (setq fmt (or fmt org-email-link-description-format))
  7227. (let* ((p org-store-link-plist)
  7228. (to (plist-get p :toaddress))
  7229. (from (plist-get p :fromaddress))
  7230. (table
  7231. (list
  7232. (cons "%c" (plist-get p :fromto))
  7233. (cons "%F" (plist-get p :from))
  7234. (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
  7235. (cons "%T" (plist-get p :to))
  7236. (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
  7237. (cons "%s" (plist-get p :subject))
  7238. (cons "%m" (plist-get p :message-id)))))
  7239. (when (string-match "%c" fmt)
  7240. ;; Check if the user wrote this message
  7241. (if (and org-from-is-user-regexp from to
  7242. (save-match-data (string-match org-from-is-user-regexp from)))
  7243. (setq fmt (replace-match "to %t" t t fmt))
  7244. (setq fmt (replace-match "from %f" t t fmt))))
  7245. (org-replace-escapes fmt table)))
  7246. (defun org-make-org-heading-search-string (&optional string heading)
  7247. "Make search string for STRING or current headline."
  7248. (interactive)
  7249. (let ((s (or string (org-get-heading))))
  7250. (unless (and string (not heading))
  7251. ;; We are using a headline, clean up garbage in there.
  7252. (if (string-match org-todo-regexp s)
  7253. (setq s (replace-match "" t t s)))
  7254. (if (string-match (org-re ":[[:alnum:]_@:]+:[ \t]*$") s)
  7255. (setq s (replace-match "" t t s)))
  7256. (setq s (org-trim s))
  7257. (if (string-match (concat "^\\(" org-quote-string "\\|"
  7258. org-comment-string "\\)") s)
  7259. (setq s (replace-match "" t t s)))
  7260. (while (string-match org-ts-regexp s)
  7261. (setq s (replace-match "" t t s))))
  7262. (while (string-match "[^a-zA-Z_0-9 \t]+" s)
  7263. (setq s (replace-match " " t t s)))
  7264. (or string (setq s (concat "*" s))) ; Add * for headlines
  7265. (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
  7266. (defun org-make-link (&rest strings)
  7267. "Concatenate STRINGS."
  7268. (apply 'concat strings))
  7269. (defun org-make-link-string (link &optional description)
  7270. "Make a link with brackets, consisting of LINK and DESCRIPTION."
  7271. (unless (string-match "\\S-" link)
  7272. (error "Empty link"))
  7273. (when (and description
  7274. (stringp description)
  7275. (not (string-match "\\S-" description)))
  7276. (setq description nil))
  7277. (when (stringp description)
  7278. ;; Remove brackets from the description, they are fatal.
  7279. (while (string-match "\\[" description)
  7280. (setq description (replace-match "{" t t description)))
  7281. (while (string-match "\\]" description)
  7282. (setq description (replace-match "}" t t description))))
  7283. (when (equal (org-link-escape link) description)
  7284. ;; No description needed, it is identical
  7285. (setq description nil))
  7286. (when (and (not description)
  7287. (not (equal link (org-link-escape link))))
  7288. (setq description (org-extract-attributes link)))
  7289. (concat "[[" (org-link-escape link) "]"
  7290. (if description (concat "[" description "]") "")
  7291. "]"))
  7292. (defconst org-link-escape-chars
  7293. '((?\ . "%20")
  7294. (?\[ . "%5B")
  7295. (?\] . "%5D")
  7296. (?\340 . "%E0") ; `a
  7297. (?\342 . "%E2") ; ^a
  7298. (?\347 . "%E7") ; ,c
  7299. (?\350 . "%E8") ; `e
  7300. (?\351 . "%E9") ; 'e
  7301. (?\352 . "%EA") ; ^e
  7302. (?\356 . "%EE") ; ^i
  7303. (?\364 . "%F4") ; ^o
  7304. (?\371 . "%F9") ; `u
  7305. (?\373 . "%FB") ; ^u
  7306. (?\; . "%3B")
  7307. ;; (?? . "%3F")
  7308. (?= . "%3D")
  7309. (?+ . "%2B")
  7310. )
  7311. "Association list of escapes for some characters problematic in links.
  7312. This is the list that is used for internal purposes.")
  7313. (defvar org-url-encoding-use-url-hexify nil)
  7314. (defconst org-link-escape-chars-browser
  7315. '((?\ . "%20")) ; 32 for the SPC char
  7316. "Association list of escapes for some characters problematic in links.
  7317. This is the list that is used before handing over to the browser.")
  7318. (defun org-link-escape (text &optional table)
  7319. "Escape characters in TEXT that are problematic for links."
  7320. (if (and org-url-encoding-use-url-hexify (not table))
  7321. (url-hexify-string text)
  7322. (setq table (or table org-link-escape-chars))
  7323. (when text
  7324. (let ((re (mapconcat (lambda (x) (regexp-quote
  7325. (char-to-string (car x))))
  7326. table "\\|")))
  7327. (while (string-match re text)
  7328. (setq text
  7329. (replace-match
  7330. (cdr (assoc (string-to-char (match-string 0 text))
  7331. table))
  7332. t t text)))
  7333. text))))
  7334. (defun org-link-unescape (text &optional table)
  7335. "Reverse the action of `org-link-escape'."
  7336. (if (and org-url-encoding-use-url-hexify (not table))
  7337. (url-unhex-string text)
  7338. (setq table (or table org-link-escape-chars))
  7339. (when text
  7340. (let ((case-fold-search t)
  7341. (re (mapconcat (lambda (x) (regexp-quote (downcase (cdr x))))
  7342. table "\\|")))
  7343. (while (string-match re text)
  7344. (setq text
  7345. (replace-match
  7346. (char-to-string (car (rassoc (upcase (match-string 0 text))
  7347. table)))
  7348. t t text)))
  7349. text))))
  7350. (defun org-xor (a b)
  7351. "Exclusive or."
  7352. (if a (not b) b))
  7353. (defun org-fixup-message-id-for-http (s)
  7354. "Replace special characters in a message id, so it can be used in an http query."
  7355. (while (string-match "<" s)
  7356. (setq s (replace-match "%3C" t t s)))
  7357. (while (string-match ">" s)
  7358. (setq s (replace-match "%3E" t t s)))
  7359. (while (string-match "@" s)
  7360. (setq s (replace-match "%40" t t s)))
  7361. s)
  7362. ;;;###autoload
  7363. (defun org-insert-link-global ()
  7364. "Insert a link like Org-mode does.
  7365. This command can be called in any mode to insert a link in Org-mode syntax."
  7366. (interactive)
  7367. (org-load-modules-maybe)
  7368. (org-run-like-in-org-mode 'org-insert-link))
  7369. (defun org-insert-link (&optional complete-file link-location)
  7370. "Insert a link. At the prompt, enter the link.
  7371. Completion can be used to insert any of the link protocol prefixes like
  7372. http or ftp in use.
  7373. The history can be used to select a link previously stored with
  7374. `org-store-link'. When the empty string is entered (i.e. if you just
  7375. press RET at the prompt), the link defaults to the most recently
  7376. stored link. As SPC triggers completion in the minibuffer, you need to
  7377. use M-SPC or C-q SPC to force the insertion of a space character.
  7378. You will also be prompted for a description, and if one is given, it will
  7379. be displayed in the buffer instead of the link.
  7380. If there is already a link at point, this command will allow you to edit link
  7381. and description parts.
  7382. With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
  7383. be selected using completion. The path to the file will be relative to the
  7384. current directory if the file is in the current directory or a subdirectory.
  7385. Otherwise, the link will be the absolute path as completed in the minibuffer
  7386. \(i.e. normally ~/path/to/file). You can configure this behavior using the
  7387. option `org-link-file-path-type'.
  7388. With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
  7389. the current directory or below.
  7390. With three \\[universal-argument] prefixes, negate the meaning of
  7391. `org-keep-stored-link-after-insertion'.
  7392. If `org-make-link-description-function' is non-nil, this function will be
  7393. called with the link target, and the result will be the default
  7394. link description.
  7395. If the LINK-LOCATION parameter is non-nil, this value will be
  7396. used as the link location instead of reading one interactively."
  7397. (interactive "P")
  7398. (let* ((wcf (current-window-configuration))
  7399. (region (if (org-region-active-p)
  7400. (buffer-substring (region-beginning) (region-end))))
  7401. (remove (and region (list (region-beginning) (region-end))))
  7402. (desc region)
  7403. tmphist ; byte-compile incorrectly complains about this
  7404. (link link-location)
  7405. entry file all-prefixes)
  7406. (cond
  7407. (link-location) ; specified by arg, just use it.
  7408. ((org-in-regexp org-bracket-link-regexp 1)
  7409. ;; We do have a link at point, and we are going to edit it.
  7410. (setq remove (list (match-beginning 0) (match-end 0)))
  7411. (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
  7412. (setq link (read-string "Link: "
  7413. (org-link-unescape
  7414. (org-match-string-no-properties 1)))))
  7415. ((or (org-in-regexp org-angle-link-re)
  7416. (org-in-regexp org-plain-link-re))
  7417. ;; Convert to bracket link
  7418. (setq remove (list (match-beginning 0) (match-end 0))
  7419. link (read-string "Link: "
  7420. (org-remove-angle-brackets (match-string 0)))))
  7421. ((member complete-file '((4) (16)))
  7422. ;; Completing read for file names.
  7423. (setq link (org-file-complete-link complete-file)))
  7424. (t
  7425. ;; Read link, with completion for stored links.
  7426. (with-output-to-temp-buffer "*Org Links*"
  7427. (princ "Insert a link.
  7428. Use TAB to complete link prefixes, then RET for type-specific completion support\n")
  7429. (when org-stored-links
  7430. (princ "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
  7431. (princ (mapconcat
  7432. (lambda (x)
  7433. (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
  7434. (reverse org-stored-links) "\n"))))
  7435. (let ((cw (selected-window)))
  7436. (select-window (get-buffer-window "*Org Links*" 'visible))
  7437. (setq truncate-lines t)
  7438. (unless (pos-visible-in-window-p (point-max))
  7439. (org-fit-window-to-buffer))
  7440. (and (window-live-p cw) (select-window cw)))
  7441. ;; Fake a link history, containing the stored links.
  7442. (setq tmphist (append (mapcar 'car org-stored-links)
  7443. org-insert-link-history))
  7444. (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
  7445. (mapcar 'car org-link-abbrev-alist)
  7446. org-link-types))
  7447. (unwind-protect
  7448. (progn
  7449. (setq link
  7450. (let ((org-completion-use-ido nil)
  7451. (org-completion-use-iswitchb nil))
  7452. (org-completing-read
  7453. "Link: "
  7454. (append
  7455. (mapcar (lambda (x) (list (concat x ":")))
  7456. all-prefixes)
  7457. (mapcar 'car org-stored-links))
  7458. nil nil nil
  7459. 'tmphist
  7460. (car (car org-stored-links)))))
  7461. (if (not (string-match "\\S-" link))
  7462. (error "No link selected"))
  7463. (if (or (member link all-prefixes)
  7464. (and (equal ":" (substring link -1))
  7465. (member (substring link 0 -1) all-prefixes)
  7466. (setq link (substring link 0 -1))))
  7467. (setq link (org-link-try-special-completion link))))
  7468. (set-window-configuration wcf)
  7469. (kill-buffer "*Org Links*"))
  7470. (setq entry (assoc link org-stored-links))
  7471. (or entry (push link org-insert-link-history))
  7472. (if (funcall (if (equal complete-file '(64)) 'not 'identity)
  7473. (not org-keep-stored-link-after-insertion))
  7474. (setq org-stored-links (delq (assoc link org-stored-links)
  7475. org-stored-links)))
  7476. (setq desc (or desc (nth 1 entry)))))
  7477. (if (string-match org-plain-link-re link)
  7478. ;; URL-like link, normalize the use of angular brackets.
  7479. (setq link (org-make-link (org-remove-angle-brackets link))))
  7480. ;; Check if we are linking to the current file with a search option
  7481. ;; If yes, simplify the link by using only the search option.
  7482. (when (and buffer-file-name
  7483. (string-match "^file:\\(.+?\\)::\\([^>]+\\)" link))
  7484. (let* ((path (match-string 1 link))
  7485. (case-fold-search nil)
  7486. (search (match-string 2 link)))
  7487. (save-match-data
  7488. (if (equal (file-truename buffer-file-name) (file-truename path))
  7489. ;; We are linking to this same file, with a search option
  7490. (setq link search)))))
  7491. ;; Check if we can/should use a relative path. If yes, simplify the link
  7492. (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
  7493. (let* ((type (match-string 1 link))
  7494. (path (match-string 2 link))
  7495. (origpath path)
  7496. (case-fold-search nil))
  7497. (cond
  7498. ((or (eq org-link-file-path-type 'absolute)
  7499. (equal complete-file '(16)))
  7500. (setq path (abbreviate-file-name (expand-file-name path))))
  7501. ((eq org-link-file-path-type 'noabbrev)
  7502. (setq path (expand-file-name path)))
  7503. ((eq org-link-file-path-type 'relative)
  7504. (setq path (file-relative-name path)))
  7505. (t
  7506. (save-match-data
  7507. (if (string-match (concat "^" (regexp-quote
  7508. (file-name-as-directory
  7509. (expand-file-name "."))))
  7510. (expand-file-name path))
  7511. ;; We are linking a file with relative path name.
  7512. (setq path (substring (expand-file-name path)
  7513. (match-end 0)))
  7514. (setq path (abbreviate-file-name (expand-file-name path)))))))
  7515. (setq link (concat type path))
  7516. (if (equal desc origpath)
  7517. (setq desc path))))
  7518. (if org-make-link-description-function
  7519. (setq desc (funcall org-make-link-description-function link desc)))
  7520. (setq desc (read-string "Description: " desc))
  7521. (unless (string-match "\\S-" desc) (setq desc nil))
  7522. (if remove (apply 'delete-region remove))
  7523. (insert (org-make-link-string link desc))))
  7524. (defun org-link-try-special-completion (type)
  7525. "If there is completion support for link type TYPE, offer it."
  7526. (let ((fun (intern (concat "org-" type "-complete-link"))))
  7527. (if (functionp fun)
  7528. (funcall fun)
  7529. (read-string "Link (no completion support): " (concat type ":")))))
  7530. (defun org-file-complete-link (&optional arg)
  7531. "Create a file link using completion."
  7532. (let (file link)
  7533. (setq file (read-file-name "File: "))
  7534. (let ((pwd (file-name-as-directory (expand-file-name ".")))
  7535. (pwd1 (file-name-as-directory (abbreviate-file-name
  7536. (expand-file-name ".")))))
  7537. (cond
  7538. ((equal arg '(16))
  7539. (setq link (org-make-link
  7540. "file:"
  7541. (abbreviate-file-name (expand-file-name file)))))
  7542. ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
  7543. (setq link (org-make-link "file:" (match-string 1 file))))
  7544. ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
  7545. (expand-file-name file))
  7546. (setq link (org-make-link
  7547. "file:" (match-string 1 (expand-file-name file)))))
  7548. (t (setq link (org-make-link "file:" file)))))
  7549. link))
  7550. (defun org-completing-read (&rest args)
  7551. "Completing-read with SPACE being a normal character."
  7552. (let ((minibuffer-local-completion-map
  7553. (copy-keymap minibuffer-local-completion-map)))
  7554. (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
  7555. (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
  7556. (apply 'org-icompleting-read args)))
  7557. (defun org-completing-read-no-i (&rest args)
  7558. (let (org-completion-use-ido org-completion-use-iswitchb)
  7559. (apply 'org-completing-read args)))
  7560. (defun org-iswitchb-completing-read (prompt choices &rest args)
  7561. "Use iswitch as a completing-read replacement to choose from choices.
  7562. PROMPT is a string to prompt with. CHOICES is a list of strings to choose
  7563. from."
  7564. (let* ((iswitchb-use-virtual-buffers nil)
  7565. (iswitchb-make-buflist-hook
  7566. (lambda ()
  7567. (setq iswitchb-temp-buflist choices))))
  7568. (iswitchb-read-buffer prompt)))
  7569. (defun org-icompleting-read (&rest args)
  7570. "Completing-read using `ido-mode' or `iswitchb' speedups if available."
  7571. (org-without-partial-completion
  7572. (if (and org-completion-use-ido
  7573. (fboundp 'ido-completing-read)
  7574. (boundp 'ido-mode) ido-mode
  7575. (listp (second args)))
  7576. (let ((ido-enter-matching-directory nil))
  7577. (apply 'ido-completing-read (concat (car args))
  7578. (if (consp (car (nth 1 args)))
  7579. (mapcar (lambda (x) (car x)) (nth 1 args))
  7580. (nth 1 args))
  7581. (cddr args)))
  7582. (if (and org-completion-use-iswitchb
  7583. (boundp 'iswitchb-mode) iswitchb-mode
  7584. (listp (second args)))
  7585. (apply 'org-iswitchb-completing-read (concat (car args))
  7586. (if (consp (car (nth 1 args)))
  7587. (mapcar (lambda (x) (car x)) (nth 1 args))
  7588. (nth 1 args))
  7589. (cddr args))
  7590. (apply 'completing-read args)))))
  7591. (defun org-extract-attributes (s)
  7592. "Extract the attributes cookie from a string and set as text property."
  7593. (let (a attr (start 0) key value)
  7594. (save-match-data
  7595. (when (string-match "{{\\([^}]+\\)}}$" s)
  7596. (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
  7597. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
  7598. (setq key (match-string 1 a) value (match-string 2 a)
  7599. start (match-end 0)
  7600. attr (plist-put attr (intern key) value))))
  7601. (org-add-props s nil 'org-attr attr))
  7602. s))
  7603. (defun org-extract-attributes-from-string (tag)
  7604. (let (key value attr)
  7605. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"\\s-?" tag)
  7606. (setq key (match-string 1 tag) value (match-string 2 tag)
  7607. tag (replace-match "" t t tag)
  7608. attr (plist-put attr (intern key) value)))
  7609. (cons tag attr)))
  7610. (defun org-attributes-to-string (plist)
  7611. "Format a property list into an HTML attribute list."
  7612. (let ((s "") key value)
  7613. (while plist
  7614. (setq key (pop plist) value (pop plist))
  7615. (and value
  7616. (setq s (concat s " " (symbol-name key) "=\"" value "\""))))
  7617. s))
  7618. ;;; Opening/following a link
  7619. (defvar org-link-search-failed nil)
  7620. (defvar org-open-link-functions nil
  7621. "Hook for functions finding a plain text link.
  7622. These functions must take a single argument, the link content.
  7623. They will be called for links that look like [[link text][description]]
  7624. when LINK TEXT does not have a protocol like \"http:\" and does not look
  7625. like a filename (e.g. \"./blue.png\").
  7626. These functions will be called *before* Org attempts to resolve the
  7627. link by doing text searches in the current buffer - so if you want a
  7628. link \"[[target]]\" to still find \"<<target>>\", your function should
  7629. handle this as a special case.
  7630. When the function does handle the link, it must return a non-nil value.
  7631. If it decides that it is not responsible for this link, it must return
  7632. nil to indicate that that Org-mode can continue with other options
  7633. like exact and fuzzy text search.")
  7634. (defun org-next-link ()
  7635. "Move forward to the next link.
  7636. If the link is in hidden text, expose it."
  7637. (interactive)
  7638. (when (and org-link-search-failed (eq this-command last-command))
  7639. (goto-char (point-min))
  7640. (message "Link search wrapped back to beginning of buffer"))
  7641. (setq org-link-search-failed nil)
  7642. (let* ((pos (point))
  7643. (ct (org-context))
  7644. (a (assoc :link ct)))
  7645. (if a (goto-char (nth 2 a)))
  7646. (if (re-search-forward org-any-link-re nil t)
  7647. (progn
  7648. (goto-char (match-beginning 0))
  7649. (if (org-invisible-p) (org-show-context)))
  7650. (goto-char pos)
  7651. (setq org-link-search-failed t)
  7652. (error "No further link found"))))
  7653. (defun org-previous-link ()
  7654. "Move backward to the previous link.
  7655. If the link is in hidden text, expose it."
  7656. (interactive)
  7657. (when (and org-link-search-failed (eq this-command last-command))
  7658. (goto-char (point-max))
  7659. (message "Link search wrapped back to end of buffer"))
  7660. (setq org-link-search-failed nil)
  7661. (let* ((pos (point))
  7662. (ct (org-context))
  7663. (a (assoc :link ct)))
  7664. (if a (goto-char (nth 1 a)))
  7665. (if (re-search-backward org-any-link-re nil t)
  7666. (progn
  7667. (goto-char (match-beginning 0))
  7668. (if (org-invisible-p) (org-show-context)))
  7669. (goto-char pos)
  7670. (setq org-link-search-failed t)
  7671. (error "No further link found"))))
  7672. (defun org-translate-link (s)
  7673. "Translate a link string if a translation function has been defined."
  7674. (if (and org-link-translation-function
  7675. (fboundp org-link-translation-function)
  7676. (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
  7677. (progn
  7678. (setq s (funcall org-link-translation-function
  7679. (match-string 1) (match-string 2)))
  7680. (concat (car s) ":" (cdr s)))
  7681. s))
  7682. (defun org-translate-link-from-planner (type path)
  7683. "Translate a link from Emacs Planner syntax so that Org can follow it.
  7684. This is still an experimental function, your mileage may vary."
  7685. (cond
  7686. ((member type '("http" "https" "news" "ftp"))
  7687. ;; standard Internet links are the same.
  7688. nil)
  7689. ((and (equal type "irc") (string-match "^//" path))
  7690. ;; Planner has two / at the beginning of an irc link, we have 1.
  7691. ;; We should have zero, actually....
  7692. (setq path (substring path 1)))
  7693. ((and (equal type "lisp") (string-match "^/" path))
  7694. ;; Planner has a slash, we do not.
  7695. (setq type "elisp" path (substring path 1)))
  7696. ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
  7697. ;; A typical message link. Planner has the id after the final slash,
  7698. ;; we separate it with a hash mark
  7699. (setq path (concat (match-string 1 path) "#"
  7700. (org-remove-angle-brackets (match-string 2 path)))))
  7701. )
  7702. (cons type path))
  7703. (defun org-find-file-at-mouse (ev)
  7704. "Open file link or URL at mouse."
  7705. (interactive "e")
  7706. (mouse-set-point ev)
  7707. (org-open-at-point 'in-emacs))
  7708. (defun org-open-at-mouse (ev)
  7709. "Open file link or URL at mouse."
  7710. (interactive "e")
  7711. (mouse-set-point ev)
  7712. (if (eq major-mode 'org-agenda-mode)
  7713. (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
  7714. (org-open-at-point))
  7715. (defvar org-window-config-before-follow-link nil
  7716. "The window configuration before following a link.
  7717. This is saved in case the need arises to restore it.")
  7718. (defvar org-open-link-marker (make-marker)
  7719. "Marker pointing to the location where `org-open-at-point; was called.")
  7720. ;;;###autoload
  7721. (defun org-open-at-point-global ()
  7722. "Follow a link like Org-mode does.
  7723. This command can be called in any mode to follow a link that has
  7724. Org-mode syntax."
  7725. (interactive)
  7726. (org-run-like-in-org-mode 'org-open-at-point))
  7727. ;;;###autoload
  7728. (defun org-open-link-from-string (s &optional arg reference-buffer)
  7729. "Open a link in the string S, as if it was in Org-mode."
  7730. (interactive "sLink: \nP")
  7731. (let ((reference-buffer (or reference-buffer (current-buffer))))
  7732. (with-temp-buffer
  7733. (let ((org-inhibit-startup t))
  7734. (org-mode)
  7735. (insert s)
  7736. (goto-char (point-min))
  7737. (when reference-buffer
  7738. (setq org-link-abbrev-alist-local
  7739. (with-current-buffer reference-buffer
  7740. org-link-abbrev-alist-local)))
  7741. (org-open-at-point arg reference-buffer)))))
  7742. (defun org-open-at-point (&optional in-emacs reference-buffer)
  7743. "Open link at or after point.
  7744. If there is no link at point, this function will search forward up to
  7745. the end of the current line.
  7746. Normally, files will be opened by an appropriate application. If the
  7747. optional argument IN-EMACS is non-nil, Emacs will visit the file.
  7748. With a double prefix argument, try to open outside of Emacs, in the
  7749. application the system uses for this file type."
  7750. (interactive "P")
  7751. (org-load-modules-maybe)
  7752. (move-marker org-open-link-marker (point))
  7753. (setq org-window-config-before-follow-link (current-window-configuration))
  7754. (org-remove-occur-highlights nil nil t)
  7755. (cond
  7756. ((and (org-on-heading-p)
  7757. (not (org-in-regexp
  7758. (concat org-plain-link-re "\\|"
  7759. org-bracket-link-regexp "\\|"
  7760. org-angle-link-re "\\|"
  7761. "[ \t]:[^ \t\n]+:[ \t]*$")))
  7762. (not (get-text-property (point) 'org-linked-text)))
  7763. (or (org-offer-links-in-entry in-emacs)
  7764. (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
  7765. ((org-at-timestamp-p t) (org-follow-timestamp-link))
  7766. ((or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
  7767. (org-footnote-action))
  7768. (t
  7769. (let (type path link line search (pos (point)))
  7770. (catch 'match
  7771. (save-excursion
  7772. (skip-chars-forward "^]\n\r")
  7773. (when (org-in-regexp org-bracket-link-regexp 1)
  7774. (setq link (org-extract-attributes
  7775. (org-link-unescape (org-match-string-no-properties 1))))
  7776. (while (string-match " *\n *" link)
  7777. (setq link (replace-match " " t t link)))
  7778. (setq link (org-link-expand-abbrev link))
  7779. (cond
  7780. ((or (file-name-absolute-p link)
  7781. (string-match "^\\.\\.?/" link))
  7782. (setq type "file" path link))
  7783. ((string-match org-link-re-with-space3 link)
  7784. (setq type (match-string 1 link) path (match-string 2 link)))
  7785. (t (setq type "thisfile" path link)))
  7786. (throw 'match t)))
  7787. (when (get-text-property (point) 'org-linked-text)
  7788. (setq type "thisfile"
  7789. pos (if (get-text-property (1+ (point)) 'org-linked-text)
  7790. (1+ (point)) (point))
  7791. path (buffer-substring
  7792. (previous-single-property-change pos 'org-linked-text)
  7793. (next-single-property-change pos 'org-linked-text)))
  7794. (throw 'match t))
  7795. (save-excursion
  7796. (when (or (org-in-regexp org-angle-link-re)
  7797. (org-in-regexp org-plain-link-re))
  7798. (setq type (match-string 1) path (match-string 2))
  7799. (throw 'match t)))
  7800. (save-excursion
  7801. (when (org-in-regexp (org-re "\\(:[[:alnum:]_@:]+\\):[ \t]*$"))
  7802. (setq type "tags"
  7803. path (match-string 1))
  7804. (while (string-match ":" path)
  7805. (setq path (replace-match "+" t t path)))
  7806. (throw 'match t)))
  7807. (when (org-in-regexp "<\\([^><\n]+\\)>")
  7808. (setq type "tree-match"
  7809. path (match-string 1))
  7810. (throw 'match t)))
  7811. (unless path
  7812. (error "No link found"))
  7813. ;; switch back to reference buffer
  7814. ;; needed when if called in a temporary buffer through
  7815. ;; org-open-link-from-string
  7816. (with-current-buffer (or reference-buffer (current-buffer))
  7817. ;; Remove any trailing spaces in path
  7818. (if (string-match " +\\'" path)
  7819. (setq path (replace-match "" t t path)))
  7820. (if (and org-link-translation-function
  7821. (fboundp org-link-translation-function))
  7822. ;; Check if we need to translate the link
  7823. (let ((tmp (funcall org-link-translation-function type path)))
  7824. (setq type (car tmp) path (cdr tmp))))
  7825. (cond
  7826. ((assoc type org-link-protocols)
  7827. (funcall (nth 1 (assoc type org-link-protocols)) path))
  7828. ((equal type "mailto")
  7829. (let ((cmd (car org-link-mailto-program))
  7830. (args (cdr org-link-mailto-program)) args1
  7831. (address path) (subject "") a)
  7832. (if (string-match "\\(.*\\)::\\(.*\\)" path)
  7833. (setq address (match-string 1 path)
  7834. subject (org-link-escape (match-string 2 path))))
  7835. (while args
  7836. (cond
  7837. ((not (stringp (car args))) (push (pop args) args1))
  7838. (t (setq a (pop args))
  7839. (if (string-match "%a" a)
  7840. (setq a (replace-match address t t a)))
  7841. (if (string-match "%s" a)
  7842. (setq a (replace-match subject t t a)))
  7843. (push a args1))))
  7844. (apply cmd (nreverse args1))))
  7845. ((member type '("http" "https" "ftp" "news"))
  7846. (browse-url (concat type ":" (org-link-escape
  7847. path org-link-escape-chars-browser))))
  7848. ((string= type "doi")
  7849. (browse-url (concat "http://dx.doi.org/"
  7850. (org-link-escape
  7851. path org-link-escape-chars-browser))))
  7852. ((member type '("message"))
  7853. (browse-url (concat type ":" path)))
  7854. ((string= type "tags")
  7855. (org-tags-view in-emacs path))
  7856. ((string= type "tree-match")
  7857. (org-occur (concat "\\[" (regexp-quote path) "\\]")))
  7858. ((string= type "file")
  7859. (if (string-match "::\\([0-9]+\\)\\'" path)
  7860. (setq line (string-to-number (match-string 1 path))
  7861. path (substring path 0 (match-beginning 0)))
  7862. (if (string-match "::\\(.+\\)\\'" path)
  7863. (setq search (match-string 1 path)
  7864. path (substring path 0 (match-beginning 0)))))
  7865. (if (string-match "[*?{]" (file-name-nondirectory path))
  7866. (dired path)
  7867. (org-open-file path in-emacs line search)))
  7868. ((string= type "news")
  7869. (require 'org-gnus)
  7870. (org-gnus-follow-link path))
  7871. ((string= type "shell")
  7872. (let ((cmd path))
  7873. (if (or (not org-confirm-shell-link-function)
  7874. (funcall org-confirm-shell-link-function
  7875. (format "Execute \"%s\" in shell? "
  7876. (org-add-props cmd nil
  7877. 'face 'org-warning))))
  7878. (progn
  7879. (message "Executing %s" cmd)
  7880. (shell-command cmd))
  7881. (error "Abort"))))
  7882. ((string= type "elisp")
  7883. (let ((cmd path))
  7884. (if (or (not org-confirm-elisp-link-function)
  7885. (funcall org-confirm-elisp-link-function
  7886. (format "Execute \"%s\" as elisp? "
  7887. (org-add-props cmd nil
  7888. 'face 'org-warning))))
  7889. (message "%s => %s" cmd
  7890. (if (equal (string-to-char cmd) ?\()
  7891. (eval (read cmd))
  7892. (call-interactively (read cmd))))
  7893. (error "Abort"))))
  7894. ((and (string= type "thisfile")
  7895. (run-hook-with-args-until-success
  7896. 'org-open-link-functions path)))
  7897. ((string= type "thisfile")
  7898. (if in-emacs
  7899. (switch-to-buffer-other-window
  7900. (org-get-buffer-for-internal-link (current-buffer)))
  7901. (org-mark-ring-push))
  7902. (let ((cmd `(org-link-search
  7903. ,path
  7904. ,(cond ((equal in-emacs '(4)) 'occur)
  7905. ((equal in-emacs '(16)) 'org-occur)
  7906. (t nil))
  7907. ,pos)))
  7908. (condition-case nil (eval cmd)
  7909. (error (progn (widen) (eval cmd))))))
  7910. (t
  7911. (browse-url-at-point)))))))
  7912. (move-marker org-open-link-marker nil)
  7913. (run-hook-with-args 'org-follow-link-hook))
  7914. (defun org-offer-links-in-entry (&optional nth zero)
  7915. "Offer links in the current entry and follow the selected link.
  7916. If there is only one link, follow it immediately as well.
  7917. If NTH is an integer, immediately pick the NTH link found.
  7918. If ZERO is a string, check also this string for a link, and if
  7919. there is one, offer it as link number zero."
  7920. (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
  7921. "\\(" org-angle-link-re "\\)\\|"
  7922. "\\(" org-plain-link-re "\\)"))
  7923. (cnt ?0)
  7924. (in-emacs (if (integerp nth) nil nth))
  7925. have-zero end links link c)
  7926. (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
  7927. (push (match-string 0 zero) links)
  7928. (setq cnt (1- cnt) have-zero t))
  7929. (save-excursion
  7930. (org-back-to-heading t)
  7931. (setq end (save-excursion (outline-next-heading) (point)))
  7932. (while (re-search-forward re end t)
  7933. (push (match-string 0) links))
  7934. (setq links (org-uniquify (reverse links))))
  7935. (cond
  7936. ((null links)
  7937. (message "No links"))
  7938. ((equal (length links) 1)
  7939. (setq link (list (car links))))
  7940. ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
  7941. (setq link (nth (if have-zero nth (1- nth)) links)))
  7942. (t ; we have to select a link
  7943. (save-excursion
  7944. (save-window-excursion
  7945. (delete-other-windows)
  7946. (with-output-to-temp-buffer "*Select Link*"
  7947. (mapc (lambda (l)
  7948. (if (not (string-match org-bracket-link-regexp l))
  7949. (princ (format "[%c] %s\n" (incf cnt)
  7950. (org-remove-angle-brackets l)))
  7951. (if (match-end 3)
  7952. (princ (format "[%c] %s (%s)\n" (incf cnt)
  7953. (match-string 3 l) (match-string 1 l)))
  7954. (princ (format "[%c] %s\n" (incf cnt)
  7955. (match-string 1 l))))))
  7956. links))
  7957. (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
  7958. (message "Select link to open, RET to open all:")
  7959. (setq c (read-char-exclusive))
  7960. (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
  7961. (when (equal c ?q) (error "Abort"))
  7962. (if (equal c ?\C-m)
  7963. (setq link links)
  7964. (setq nth (- c ?0))
  7965. (if have-zero (setq nth (1+ nth)))
  7966. (unless (and (integerp nth) (>= (length links) nth))
  7967. (error "Invalid link selection"))
  7968. (setq link (list (nth (1- nth) links))))))
  7969. (if link
  7970. (let ((buf (current-buffer)))
  7971. (dolist (l link)
  7972. (org-open-link-from-string l in-emacs buf))
  7973. t)
  7974. nil)))
  7975. ;; Add special file links that specify the way of opening
  7976. (org-add-link-type "file+sys" 'org-open-file-with-system)
  7977. (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
  7978. (defun org-open-file-with-system (path)
  7979. "Open file at PATH using the system way of opeing it."
  7980. (org-open-file path 'system))
  7981. (defun org-open-file-with-emacs (path)
  7982. "Open file at PATH in emacs."
  7983. (org-open-file path 'emacs))
  7984. (defun org-remove-file-link-modifiers ()
  7985. "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
  7986. (goto-char (point-min))
  7987. (while (re-search-forward "\\<file\\+\\(sys\\|emacs\\):" nil t)
  7988. (org-if-unprotected
  7989. (replace-match "file:" t t))))
  7990. (eval-after-load "org-exp"
  7991. '(add-hook 'org-export-preprocess-before-normalizing-links-hook
  7992. 'org-remove-file-link-modifiers))
  7993. ;;;; Time estimates
  7994. (defun org-get-effort (&optional pom)
  7995. "Get the effort estimate for the current entry."
  7996. (org-entry-get pom org-effort-property))
  7997. ;;; File search
  7998. (defvar org-create-file-search-functions nil
  7999. "List of functions to construct the right search string for a file link.
  8000. These functions are called in turn with point at the location to
  8001. which the link should point.
  8002. A function in the hook should first test if it would like to
  8003. handle this file type, for example by checking the major-mode or
  8004. the file extension. If it decides not to handle this file, it
  8005. should just return nil to give other functions a chance. If it
  8006. does handle the file, it must return the search string to be used
  8007. when following the link. The search string will be part of the
  8008. file link, given after a double colon, and `org-open-at-point'
  8009. will automatically search for it. If special measures must be
  8010. taken to make the search successful, another function should be
  8011. added to the companion hook `org-execute-file-search-functions',
  8012. which see.
  8013. A function in this hook may also use `setq' to set the variable
  8014. `description' to provide a suggestion for the descriptive text to
  8015. be used for this link when it gets inserted into an Org-mode
  8016. buffer with \\[org-insert-link].")
  8017. (defvar org-execute-file-search-functions nil
  8018. "List of functions to execute a file search triggered by a link.
  8019. Functions added to this hook must accept a single argument, the
  8020. search string that was part of the file link, the part after the
  8021. double colon. The function must first check if it would like to
  8022. handle this search, for example by checking the major-mode or the
  8023. file extension. If it decides not to handle this search, it
  8024. should just return nil to give other functions a chance. If it
  8025. does handle the search, it must return a non-nil value to keep
  8026. other functions from trying.
  8027. Each function can access the current prefix argument through the
  8028. variable `current-prefix-argument'. Note that a single prefix is
  8029. used to force opening a link in Emacs, so it may be good to only
  8030. use a numeric or double prefix to guide the search function.
  8031. In case this is needed, a function in this hook can also restore
  8032. the window configuration before `org-open-at-point' was called using:
  8033. (set-window-configuration org-window-config-before-follow-link)")
  8034. (defun org-link-search (s &optional type avoid-pos)
  8035. "Search for a link search option.
  8036. If S is surrounded by forward slashes, it is interpreted as a
  8037. regular expression. In org-mode files, this will create an `org-occur'
  8038. sparse tree. In ordinary files, `occur' will be used to list matches.
  8039. If the current buffer is in `dired-mode', grep will be used to search
  8040. in all files. If AVOID-POS is given, ignore matches near that position."
  8041. (let ((case-fold-search t)
  8042. (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
  8043. (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
  8044. (append '(("") (" ") ("\t") ("\n"))
  8045. org-emphasis-alist)
  8046. "\\|") "\\)"))
  8047. (pos (point))
  8048. (pre nil) (post nil)
  8049. words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
  8050. (cond
  8051. ;; First check if there are any special
  8052. ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
  8053. ;; Now try the builtin stuff
  8054. ((and (equal (string-to-char s0) ?#)
  8055. (> (length s0) 1)
  8056. (save-excursion
  8057. (goto-char (point-min))
  8058. (and
  8059. (re-search-forward
  8060. (concat "^[ \t]*:CUSTOM_ID:[ \t]+" (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
  8061. (setq type 'dedicated
  8062. pos (match-beginning 0))))
  8063. ;; There is an exact target for this
  8064. (goto-char pos)
  8065. (org-back-to-heading t)))
  8066. ((save-excursion
  8067. (goto-char (point-min))
  8068. (and
  8069. (re-search-forward
  8070. (concat "<<" (regexp-quote s0) ">>") nil t)
  8071. (setq type 'dedicated
  8072. pos (match-beginning 0))))
  8073. ;; There is an exact target for this
  8074. (goto-char pos))
  8075. ((and (string-match "^(\\(.*\\))$" s0)
  8076. (save-excursion
  8077. (goto-char (point-min))
  8078. (and
  8079. (re-search-forward
  8080. (concat "[^[]" (regexp-quote
  8081. (format org-coderef-label-format
  8082. (match-string 1 s0))))
  8083. nil t)
  8084. (setq type 'dedicated
  8085. pos (1+ (match-beginning 0))))))
  8086. ;; There is a coderef target for this
  8087. (goto-char pos))
  8088. ((string-match "^/\\(.*\\)/$" s)
  8089. ;; A regular expression
  8090. (cond
  8091. ((org-mode-p)
  8092. (org-occur (match-string 1 s)))
  8093. ;;((eq major-mode 'dired-mode)
  8094. ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
  8095. (t (org-do-occur (match-string 1 s)))))
  8096. (t
  8097. ;; A normal search strings
  8098. (when (equal (string-to-char s) ?*)
  8099. ;; Anchor on headlines, post may include tags.
  8100. (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
  8101. post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@:+]:[ \t]*\\)?$")
  8102. s (substring s 1)))
  8103. (remove-text-properties
  8104. 0 (length s)
  8105. '(face nil mouse-face nil keymap nil fontified nil) s)
  8106. ;; Make a series of regular expressions to find a match
  8107. (setq words (org-split-string s "[ \n\r\t]+")
  8108. re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
  8109. re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
  8110. "\\)" markers)
  8111. re2a_ (concat "\\(" (mapconcat 'downcase words "[ \t\r\n]+") "\\)[ \t\r\n]")
  8112. re2a (concat "[ \t\r\n]" re2a_)
  8113. re4_ (concat "\\(" (mapconcat 'downcase words "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
  8114. re4 (concat "[^a-zA-Z_]" re4_)
  8115. re1 (concat pre re2 post)
  8116. re3 (concat pre (if pre re4_ re4) post)
  8117. re5 (concat pre ".*" re4)
  8118. re2 (concat pre re2)
  8119. re2a (concat pre (if pre re2a_ re2a))
  8120. re4 (concat pre (if pre re4_ re4))
  8121. reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
  8122. "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
  8123. re5 "\\)"
  8124. ))
  8125. (cond
  8126. ((eq type 'org-occur) (org-occur reall))
  8127. ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
  8128. (t (goto-char (point-min))
  8129. (setq type 'fuzzy)
  8130. (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
  8131. (org-search-not-self 1 re1 nil t)
  8132. (org-search-not-self 1 re2 nil t)
  8133. (org-search-not-self 1 re2a nil t)
  8134. (org-search-not-self 1 re3 nil t)
  8135. (org-search-not-self 1 re4 nil t)
  8136. (org-search-not-self 1 re5 nil t)
  8137. )
  8138. (goto-char (match-beginning 1))
  8139. (goto-char pos)
  8140. (error "No match")))))
  8141. (t
  8142. ;; Normal string-search
  8143. (goto-char (point-min))
  8144. (if (search-forward s nil t)
  8145. (goto-char (match-beginning 0))
  8146. (error "No match"))))
  8147. (and (org-mode-p) (org-show-context 'link-search))
  8148. type))
  8149. (defun org-search-not-self (group &rest args)
  8150. "Execute `re-search-forward', but only accept matches that do not
  8151. enclose the position of `org-open-link-marker'."
  8152. (let ((m org-open-link-marker))
  8153. (catch 'exit
  8154. (while (apply 're-search-forward args)
  8155. (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
  8156. (goto-char (match-end group))
  8157. (if (and (or (not (eq (marker-buffer m) (current-buffer)))
  8158. (> (match-beginning 0) (marker-position m))
  8159. (< (match-end 0) (marker-position m)))
  8160. (save-match-data
  8161. (or (not (org-in-regexp
  8162. org-bracket-link-analytic-regexp 1))
  8163. (not (match-end 4)) ; no description
  8164. (and (<= (match-beginning 4) (point))
  8165. (>= (match-end 4) (point))))))
  8166. (throw 'exit (point))))))))
  8167. (defun org-get-buffer-for-internal-link (buffer)
  8168. "Return a buffer to be used for displaying the link target of internal links."
  8169. (cond
  8170. ((not org-display-internal-link-with-indirect-buffer)
  8171. buffer)
  8172. ((string-match "(Clone)$" (buffer-name buffer))
  8173. (message "Buffer is already a clone, not making another one")
  8174. ;; we also do not modify visibility in this case
  8175. buffer)
  8176. (t ; make a new indirect buffer for displaying the link
  8177. (let* ((bn (buffer-name buffer))
  8178. (ibn (concat bn "(Clone)"))
  8179. (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
  8180. (with-current-buffer ib (org-overview))
  8181. ib))))
  8182. (defun org-do-occur (regexp &optional cleanup)
  8183. "Call the Emacs command `occur'.
  8184. If CLEANUP is non-nil, remove the printout of the regular expression
  8185. in the *Occur* buffer. This is useful if the regex is long and not useful
  8186. to read."
  8187. (occur regexp)
  8188. (when cleanup
  8189. (let ((cwin (selected-window)) win beg end)
  8190. (when (setq win (get-buffer-window "*Occur*"))
  8191. (select-window win))
  8192. (goto-char (point-min))
  8193. (when (re-search-forward "match[a-z]+" nil t)
  8194. (setq beg (match-end 0))
  8195. (if (re-search-forward "^[ \t]*[0-9]+" nil t)
  8196. (setq end (1- (match-beginning 0)))))
  8197. (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
  8198. (goto-char (point-min))
  8199. (select-window cwin))))
  8200. ;;; The mark ring for links jumps
  8201. (defvar org-mark-ring nil
  8202. "Mark ring for positions before jumps in Org-mode.")
  8203. (defvar org-mark-ring-last-goto nil
  8204. "Last position in the mark ring used to go back.")
  8205. ;; Fill and close the ring
  8206. (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
  8207. (loop for i from 1 to org-mark-ring-length do
  8208. (push (make-marker) org-mark-ring))
  8209. (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
  8210. org-mark-ring)
  8211. (defun org-mark-ring-push (&optional pos buffer)
  8212. "Put the current position or POS into the mark ring and rotate it."
  8213. (interactive)
  8214. (setq pos (or pos (point)))
  8215. (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  8216. (move-marker (car org-mark-ring)
  8217. (or pos (point))
  8218. (or buffer (current-buffer)))
  8219. (message "%s"
  8220. (substitute-command-keys
  8221. "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
  8222. (defun org-mark-ring-goto (&optional n)
  8223. "Jump to the previous position in the mark ring.
  8224. With prefix arg N, jump back that many stored positions. When
  8225. called several times in succession, walk through the entire ring.
  8226. Org-mode commands jumping to a different position in the current file,
  8227. or to another Org-mode file, automatically push the old position
  8228. onto the ring."
  8229. (interactive "p")
  8230. (let (p m)
  8231. (if (eq last-command this-command)
  8232. (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
  8233. (setq p org-mark-ring))
  8234. (setq org-mark-ring-last-goto p)
  8235. (setq m (car p))
  8236. (switch-to-buffer (marker-buffer m))
  8237. (goto-char m)
  8238. (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
  8239. (defun org-remove-angle-brackets (s)
  8240. (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
  8241. (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
  8242. s)
  8243. (defun org-add-angle-brackets (s)
  8244. (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
  8245. (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
  8246. s)
  8247. (defun org-remove-double-quotes (s)
  8248. (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
  8249. (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
  8250. s)
  8251. ;;; Following specific links
  8252. (defun org-follow-timestamp-link ()
  8253. (cond
  8254. ((org-at-date-range-p t)
  8255. (let ((org-agenda-start-on-weekday)
  8256. (t1 (match-string 1))
  8257. (t2 (match-string 2)))
  8258. (setq t1 (time-to-days (org-time-string-to-time t1))
  8259. t2 (time-to-days (org-time-string-to-time t2)))
  8260. (org-agenda-list nil t1 (1+ (- t2 t1)))))
  8261. ((org-at-timestamp-p t)
  8262. (org-agenda-list nil (time-to-days (org-time-string-to-time
  8263. (substring (match-string 1) 0 10)))
  8264. 1))
  8265. (t (error "This should not happen"))))
  8266. ;;; Following file links
  8267. (defvar org-wait nil)
  8268. (defun org-open-file (path &optional in-emacs line search)
  8269. "Open the file at PATH.
  8270. First, this expands any special file name abbreviations. Then the
  8271. configuration variable `org-file-apps' is checked if it contains an
  8272. entry for this file type, and if yes, the corresponding command is launched.
  8273. If no application is found, Emacs simply visits the file.
  8274. With optional prefix argument IN-EMACS, Emacs will visit the file.
  8275. With a double C-c C-u prefix arg, Org tries to avoid opening in Emacs
  8276. and to use an external application to visit the file.
  8277. Optional LINE specifies a line to go to, optional SEARCH a string
  8278. to search for. If LINE or SEARCH is given, the file will be
  8279. opened in Emacs, unless an entry from org-file-apps that makes
  8280. use of groups in a regexp matches.
  8281. If the file does not exist, an error is thrown."
  8282. (let* ((file (if (equal path "")
  8283. buffer-file-name
  8284. (substitute-in-file-name (expand-file-name path))))
  8285. (file-apps (append org-file-apps (org-default-apps)))
  8286. (apps (org-remove-if
  8287. 'org-file-apps-entry-match-against-dlink-p file-apps))
  8288. (apps-dlink (org-remove-if-not
  8289. 'org-file-apps-entry-match-against-dlink-p file-apps))
  8290. (remp (and (assq 'remote apps) (org-file-remote-p file)))
  8291. (dirp (if remp nil (file-directory-p file)))
  8292. (file (if (and dirp org-open-directory-means-index-dot-org)
  8293. (concat (file-name-as-directory file) "index.org")
  8294. file))
  8295. (a-m-a-p (assq 'auto-mode apps))
  8296. (dfile (downcase file))
  8297. ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
  8298. (link (cond ((and (eq line nil)
  8299. (eq search nil))
  8300. file)
  8301. (line
  8302. (concat file "::" (number-to-string line)))
  8303. (search
  8304. (concat file "::" search))))
  8305. (dlink (downcase link))
  8306. (old-buffer (current-buffer))
  8307. (old-pos (point))
  8308. (old-mode major-mode)
  8309. ext cmd link-match-data)
  8310. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
  8311. (setq ext (match-string 1 dfile))
  8312. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
  8313. (setq ext (match-string 1 dfile))))
  8314. (cond
  8315. ((member in-emacs '((16) system))
  8316. (setq cmd (cdr (assoc 'system apps))))
  8317. (in-emacs (setq cmd 'emacs))
  8318. (t
  8319. (setq cmd (or (and remp (cdr (assoc 'remote apps)))
  8320. (and dirp (cdr (assoc 'directory apps)))
  8321. ; first, try matching against apps-dlink
  8322. ; if we get a match here, store the match data for later
  8323. (let ((match (assoc-default dlink apps-dlink
  8324. 'string-match)))
  8325. (if match
  8326. (progn (setq link-match-data (match-data))
  8327. match)
  8328. (progn (setq in-emacs (or in-emacs line search))
  8329. nil))) ; if we have no match in apps-dlink,
  8330. ; always open the file in emacs if line or search
  8331. ; is given (for backwards compatibility)
  8332. (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
  8333. 'string-match)
  8334. (cdr (assoc ext apps))
  8335. (cdr (assoc t apps))))))
  8336. (when (eq cmd 'system)
  8337. (setq cmd (cdr (assoc 'system apps))))
  8338. (when (eq cmd 'default)
  8339. (setq cmd (cdr (assoc t apps))))
  8340. (when (eq cmd 'mailcap)
  8341. (require 'mailcap)
  8342. (mailcap-parse-mailcaps)
  8343. (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
  8344. (command (mailcap-mime-info mime-type)))
  8345. (if (stringp command)
  8346. (setq cmd command)
  8347. (setq cmd 'emacs))))
  8348. (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
  8349. (not (file-exists-p file))
  8350. (not org-open-non-existing-files))
  8351. (error "No such file: %s" file))
  8352. (cond
  8353. ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
  8354. ;; Remove quotes around the file name - we'll use shell-quote-argument.
  8355. (while (string-match "['\"]%s['\"]" cmd)
  8356. (setq cmd (replace-match "%s" t t cmd)))
  8357. (while (string-match "%s" cmd)
  8358. (setq cmd (replace-match
  8359. (save-match-data
  8360. (shell-quote-argument
  8361. (convert-standard-filename file)))
  8362. t t cmd)))
  8363. ;; Replace "%1", "%2" etc. in command with group matches from regex
  8364. (save-match-data
  8365. (let ((match-index 1)
  8366. (number-of-groups (- (/ (length link-match-data) 2) 1)))
  8367. (set-match-data link-match-data)
  8368. (while (<= match-index number-of-groups)
  8369. (let ((regex (concat "%" (number-to-string match-index)))
  8370. (replace-with (match-string match-index dlink)))
  8371. (while (string-match regex cmd)
  8372. (setq cmd (replace-match replace-with t t cmd))))
  8373. (setq match-index (+ match-index 1)))))
  8374. (save-window-excursion
  8375. (start-process-shell-command cmd nil cmd)
  8376. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
  8377. ))
  8378. ((or (stringp cmd)
  8379. (eq cmd 'emacs))
  8380. (funcall (cdr (assq 'file org-link-frame-setup)) file)
  8381. (widen)
  8382. (if line (org-goto-line line)
  8383. (if search (org-link-search search))))
  8384. ((consp cmd)
  8385. (let ((file (convert-standard-filename file)))
  8386. (save-match-data
  8387. (set-match-data link-match-data)
  8388. (eval cmd))))
  8389. (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
  8390. (and (org-mode-p) (eq old-mode 'org-mode)
  8391. (or (not (equal old-buffer (current-buffer)))
  8392. (not (equal old-pos (point))))
  8393. (org-mark-ring-push old-pos old-buffer))))
  8394. (defun org-file-apps-entry-match-against-dlink-p (entry)
  8395. "This function returns non-nil if `entry' uses a regular
  8396. expression which should be matched against the whole link by
  8397. org-open-file.
  8398. It assumes that is the case when the entry uses a regular
  8399. expression which has at least one grouping construct and the
  8400. action is either a lisp form or a command string containing
  8401. '%1', i.e. using at least one subexpression match as a
  8402. parameter."
  8403. (let ((selector (car entry))
  8404. (action (cdr entry)))
  8405. (if (stringp selector)
  8406. (and (> (regexp-opt-depth selector) 0)
  8407. (or (and (stringp action)
  8408. (string-match "%[0-9]" action))
  8409. (consp action)))
  8410. nil)))
  8411. (defun org-default-apps ()
  8412. "Return the default applications for this operating system."
  8413. (cond
  8414. ((eq system-type 'darwin)
  8415. org-file-apps-defaults-macosx)
  8416. ((eq system-type 'windows-nt)
  8417. org-file-apps-defaults-windowsnt)
  8418. (t org-file-apps-defaults-gnu)))
  8419. (defun org-apps-regexp-alist (list &optional add-auto-mode)
  8420. "Convert extensions to regular expressions in the cars of LIST.
  8421. Also, weed out any non-string entries, because the return value is used
  8422. only for regexp matching.
  8423. When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
  8424. point to the symbol `emacs', indicating that the file should
  8425. be opened in Emacs."
  8426. (append
  8427. (delq nil
  8428. (mapcar (lambda (x)
  8429. (if (not (stringp (car x)))
  8430. nil
  8431. (if (string-match "\\W" (car x))
  8432. x
  8433. (cons (concat "\\." (car x) "\\'") (cdr x)))))
  8434. list))
  8435. (if add-auto-mode
  8436. (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
  8437. (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
  8438. (defun org-file-remote-p (file)
  8439. "Test whether FILE specifies a location on a remote system.
  8440. Return non-nil if the location is indeed remote.
  8441. For example, the filename \"/user@host:/foo\" specifies a location
  8442. on the system \"/user@host:\"."
  8443. (cond ((fboundp 'file-remote-p)
  8444. (file-remote-p file))
  8445. ((fboundp 'tramp-handle-file-remote-p)
  8446. (tramp-handle-file-remote-p file))
  8447. ((and (boundp 'ange-ftp-name-format)
  8448. (string-match (car ange-ftp-name-format) file))
  8449. t)
  8450. (t nil)))
  8451. ;;;; Refiling
  8452. (defun org-get-org-file ()
  8453. "Read a filename, with default directory `org-directory'."
  8454. (let ((default (or org-default-notes-file remember-data-file)))
  8455. (read-file-name (format "File name [%s]: " default)
  8456. (file-name-as-directory org-directory)
  8457. default)))
  8458. (defun org-notes-order-reversed-p ()
  8459. "Check if the current file should receive notes in reversed order."
  8460. (cond
  8461. ((not org-reverse-note-order) nil)
  8462. ((eq t org-reverse-note-order) t)
  8463. ((not (listp org-reverse-note-order)) nil)
  8464. (t (catch 'exit
  8465. (let ((all org-reverse-note-order)
  8466. entry)
  8467. (while (setq entry (pop all))
  8468. (if (string-match (car entry) buffer-file-name)
  8469. (throw 'exit (cdr entry))))
  8470. nil)))))
  8471. (defvar org-refile-target-table nil
  8472. "The list of refile targets, created by `org-refile'.")
  8473. (defvar org-agenda-new-buffers nil
  8474. "Buffers created to visit agenda files.")
  8475. (defun org-get-refile-targets (&optional default-buffer)
  8476. "Produce a table with refile targets."
  8477. (let ((case-fold-search nil)
  8478. ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
  8479. (entries (or org-refile-targets '((nil . (:level . 1)))))
  8480. targets txt re files f desc descre fast-path-p level pos0)
  8481. (message "Getting targets...")
  8482. (with-current-buffer (or default-buffer (current-buffer))
  8483. (while (setq entry (pop entries))
  8484. (setq files (car entry) desc (cdr entry))
  8485. (setq fast-path-p nil)
  8486. (cond
  8487. ((null files) (setq files (list (current-buffer))))
  8488. ((eq files 'org-agenda-files)
  8489. (setq files (org-agenda-files 'unrestricted)))
  8490. ((and (symbolp files) (fboundp files))
  8491. (setq files (funcall files)))
  8492. ((and (symbolp files) (boundp files))
  8493. (setq files (symbol-value files))))
  8494. (if (stringp files) (setq files (list files)))
  8495. (cond
  8496. ((eq (car desc) :tag)
  8497. (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
  8498. ((eq (car desc) :todo)
  8499. (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
  8500. ((eq (car desc) :regexp)
  8501. (setq descre (cdr desc)))
  8502. ((eq (car desc) :level)
  8503. (setq descre (concat "^\\*\\{" (number-to-string
  8504. (if org-odd-levels-only
  8505. (1- (* 2 (cdr desc)))
  8506. (cdr desc)))
  8507. "\\}[ \t]")))
  8508. ((eq (car desc) :maxlevel)
  8509. (setq fast-path-p t)
  8510. (setq descre (concat "^\\*\\{1," (number-to-string
  8511. (if org-odd-levels-only
  8512. (1- (* 2 (cdr desc)))
  8513. (cdr desc)))
  8514. "\\}[ \t]")))
  8515. (t (error "Bad refiling target description %s" desc)))
  8516. (while (setq f (pop files))
  8517. (with-current-buffer
  8518. (if (bufferp f) f (org-get-agenda-file-buffer f))
  8519. (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
  8520. (setq f (and f (expand-file-name f)))
  8521. (if (eq org-refile-use-outline-path 'file)
  8522. (push (list (file-name-nondirectory f) f nil nil) targets))
  8523. (save-excursion
  8524. (save-restriction
  8525. (widen)
  8526. (goto-char (point-min))
  8527. (while (re-search-forward descre nil t)
  8528. (goto-char (setq pos0 (point-at-bol)))
  8529. (catch 'next
  8530. (when org-refile-target-verify-function
  8531. (save-match-data
  8532. (or (funcall org-refile-target-verify-function)
  8533. (throw 'next t))))
  8534. (when (looking-at org-complex-heading-regexp)
  8535. (setq level (org-reduced-level (- (match-end 1) (match-beginning 1)))
  8536. txt (org-link-display-format (match-string 4))
  8537. re (concat "^" (regexp-quote
  8538. (buffer-substring (match-beginning 1)
  8539. (match-end 4)))))
  8540. (if (match-end 5) (setq re (concat re "[ \t]+"
  8541. (regexp-quote
  8542. (match-string 5)))))
  8543. (setq re (concat re "[ \t]*$"))
  8544. (when org-refile-use-outline-path
  8545. (setq txt (mapconcat 'org-protect-slash
  8546. (append
  8547. (if (eq org-refile-use-outline-path 'file)
  8548. (list (file-name-nondirectory
  8549. (buffer-file-name (buffer-base-buffer))))
  8550. (if (eq org-refile-use-outline-path 'full-file-path)
  8551. (list (buffer-file-name (buffer-base-buffer)))))
  8552. (org-get-outline-path fast-path-p level txt)
  8553. (list txt))
  8554. "/")))
  8555. (push (list txt f re (point)) targets)))
  8556. (when (= (point) pos0)
  8557. ;; verification function has not moved point
  8558. (goto-char (point-at-eol))))))))))
  8559. (message "Getting targets...done")
  8560. (nreverse targets)))
  8561. (defun org-protect-slash (s)
  8562. (while (string-match "/" s)
  8563. (setq s (replace-match "\\" t t s)))
  8564. s)
  8565. (defvar org-olpa (make-vector 20 nil))
  8566. (defun org-get-outline-path (&optional fastp level heading)
  8567. "Return the outline path to the current entry, as a list.
  8568. The parameters FASTP, LEVEL, and HEADING are for use be a scanner
  8569. routine which makes outline path derivations for an entire file,
  8570. avoiding backtracing."
  8571. (if fastp
  8572. (progn
  8573. (if (> level 19)
  8574. (error "Outline path failure, more than 19 levels."))
  8575. (loop for i from level upto 19 do
  8576. (aset org-olpa i nil))
  8577. (prog1
  8578. (delq nil (append org-olpa nil))
  8579. (aset org-olpa level heading)))
  8580. (let (rtn case-fold-search)
  8581. (save-excursion
  8582. (save-restriction
  8583. (widen)
  8584. (while (org-up-heading-safe)
  8585. (when (looking-at org-complex-heading-regexp)
  8586. (push (org-match-string-no-properties 4) rtn)))
  8587. rtn)))))
  8588. (defun org-format-outline-path (path &optional width prefix)
  8589. "Format the outlie path PATH for display.
  8590. Width is the maximum number of characters that is available.
  8591. Prefix is a prefix to be included in the returned string,
  8592. such as the file name."
  8593. (setq width (or width 79))
  8594. (if prefix (setq width (- width (length prefix))))
  8595. (if (not path)
  8596. (or prefix "")
  8597. (let* ((nsteps (length path))
  8598. (total-width (+ nsteps (apply '+ (mapcar 'length path))))
  8599. (maxwidth (if (<= total-width width)
  8600. 10000 ;; everything fits
  8601. ;; we need to shorten the level headings
  8602. (/ (- width nsteps) nsteps)))
  8603. (org-odd-levels-only nil)
  8604. (n 0)
  8605. (total (1+ (length prefix))))
  8606. (setq maxwidth (max maxwidth 10))
  8607. (concat prefix
  8608. (mapconcat
  8609. (lambda (h)
  8610. (setq n (1+ n))
  8611. (if (and (= n nsteps) (< maxwidth 10000))
  8612. (setq maxwidth (- total-width total)))
  8613. (if (< (length h) maxwidth)
  8614. (progn (setq total (+ total (length h) 1)) h)
  8615. (setq h (substring h 0 (- maxwidth 2))
  8616. total (+ total maxwidth 1))
  8617. (if (string-match "[ \t]+\\'" h)
  8618. (setq h (substring h 0 (match-beginning 0))))
  8619. (setq h (concat h "..")))
  8620. (org-add-props h nil 'face
  8621. (nth (% (1- n) org-n-level-faces)
  8622. org-level-faces))
  8623. h)
  8624. path "/")))))
  8625. (defun org-display-outline-path (&optional file current)
  8626. "Display the current outline path in the echo area."
  8627. (interactive "P")
  8628. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  8629. (case-fold-search nil)
  8630. (path (and (org-mode-p) (org-get-outline-path))))
  8631. (if current (setq path (append path
  8632. (save-excursion
  8633. (org-back-to-heading t)
  8634. (if (looking-at org-complex-heading-regexp)
  8635. (list (match-string 4)))))))
  8636. (message "%s"
  8637. (org-format-outline-path
  8638. path
  8639. (1- (frame-width))
  8640. (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
  8641. (defvar org-refile-history nil
  8642. "History for refiling operations.")
  8643. (defvar org-after-refile-insert-hook nil
  8644. "Hook run after `org-refile' has inserted its stuff at the new location.
  8645. Note that this is still *before* the stuff will be removed from
  8646. the *old* location.")
  8647. (defun org-refile (&optional goto default-buffer rfloc)
  8648. "Move the entry at point to another heading.
  8649. The list of target headings is compiled using the information in
  8650. `org-refile-targets', which see. This list is created before each use
  8651. and will therefore always be up-to-date.
  8652. At the target location, the entry is filed as a subitem of the target heading.
  8653. Depending on `org-reverse-note-order', the new subitem will either be the
  8654. first or the last subitem.
  8655. If there is an active region, all entries in that region will be moved.
  8656. However, the region must fulfil the requirement that the first heading
  8657. is the first one sets the top-level of the moved text - at most siblings
  8658. below it are allowed.
  8659. With prefix arg GOTO, the command will only visit the target location,
  8660. not actually move anything.
  8661. With a double prefix `C-u C-u', go to the location where the last refiling
  8662. operation has put the subtree.
  8663. With a prefix argument of `2', refile to the running clock.
  8664. RFLOC can be a refile location obtained in a different way.
  8665. See also `org-refile-use-outline-path' and `org-completion-use-ido'"
  8666. (interactive "P")
  8667. (let* ((cbuf (current-buffer))
  8668. (regionp (org-region-active-p))
  8669. (region-start (and regionp (region-beginning)))
  8670. (region-end (and regionp (region-end)))
  8671. (region-length (and regionp (- region-end region-start)))
  8672. (filename (buffer-file-name (buffer-base-buffer cbuf)))
  8673. pos it nbuf file re level reversed)
  8674. (setq last-command nil)
  8675. (when regionp
  8676. (goto-char region-start)
  8677. (or (bolp) (goto-char (point-at-bol)))
  8678. (setq region-start (point))
  8679. (unless (org-kill-is-subtree-p
  8680. (buffer-substring region-start region-end))
  8681. (error "The region is not a (sequence of) subtree(s)")))
  8682. (if (equal goto '(16))
  8683. (org-refile-goto-last-stored)
  8684. (when (or
  8685. (and (equal goto 2)
  8686. org-clock-hd-marker (marker-buffer org-clock-hd-marker)
  8687. (prog1
  8688. (setq it (list (or org-clock-heading "running clock")
  8689. (buffer-file-name
  8690. (marker-buffer org-clock-hd-marker))
  8691. ""
  8692. (marker-position org-clock-hd-marker)))
  8693. (setq goto nil)))
  8694. (setq it (or rfloc
  8695. (save-excursion
  8696. (org-refile-get-location
  8697. (if goto "Goto: " "Refile to: ") default-buffer
  8698. org-refile-allow-creating-parent-nodes)))))
  8699. (setq file (nth 1 it)
  8700. re (nth 2 it)
  8701. pos (nth 3 it))
  8702. (if (and (not goto)
  8703. pos
  8704. (equal (buffer-file-name) file)
  8705. (if regionp
  8706. (and (>= pos region-start)
  8707. (<= pos region-end))
  8708. (and (>= pos (point))
  8709. (< pos (save-excursion
  8710. (org-end-of-subtree t t))))))
  8711. (error "Cannot refile to position inside the tree or region"))
  8712. (setq nbuf (or (find-buffer-visiting file)
  8713. (find-file-noselect file)))
  8714. (if goto
  8715. (progn
  8716. (switch-to-buffer nbuf)
  8717. (goto-char pos)
  8718. (org-show-context 'org-goto))
  8719. (if regionp
  8720. (progn
  8721. (org-kill-new (buffer-substring region-start region-end))
  8722. (org-save-markers-in-region region-start region-end))
  8723. (org-copy-subtree 1 nil t))
  8724. (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
  8725. (find-file-noselect file)))
  8726. (setq reversed (org-notes-order-reversed-p))
  8727. (save-excursion
  8728. (save-restriction
  8729. (widen)
  8730. (if pos
  8731. (progn
  8732. (goto-char pos)
  8733. (looking-at outline-regexp)
  8734. (setq level (org-get-valid-level (funcall outline-level) 1))
  8735. (goto-char
  8736. (if reversed
  8737. (or (outline-next-heading) (point-max))
  8738. (or (save-excursion (org-get-next-sibling))
  8739. (org-end-of-subtree t t)
  8740. (point-max)))))
  8741. (setq level 1)
  8742. (if (not reversed)
  8743. (goto-char (point-max))
  8744. (goto-char (point-min))
  8745. (or (outline-next-heading) (goto-char (point-max)))))
  8746. (if (not (bolp)) (newline))
  8747. (org-paste-subtree level)
  8748. (when org-log-refile
  8749. (org-add-log-setup 'refile nil nil 'findpos
  8750. org-log-refile)
  8751. (unless (eq org-log-refile 'note)
  8752. (save-excursion (org-add-log-note))))
  8753. (and org-auto-align-tags (org-set-tags nil t))
  8754. (bookmark-set "org-refile-last-stored")
  8755. (if (fboundp 'deactivate-mark) (deactivate-mark))
  8756. (run-hooks 'org-after-refile-insert-hook))))
  8757. (if regionp
  8758. (delete-region (point) (+ (point) region-length))
  8759. (org-cut-subtree))
  8760. (when (featurep 'org-inlinetask)
  8761. (org-inlinetask-remove-END-maybe))
  8762. (setq org-markers-to-move nil)
  8763. (message "Refiled to \"%s\"" (car it)))))))
  8764. (defun org-refile-goto-last-stored ()
  8765. "Go to the location where the last refile was stored."
  8766. (interactive)
  8767. (bookmark-jump "org-refile-last-stored")
  8768. (message "This is the location of the last refile"))
  8769. (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
  8770. "Prompt the user for a refile location, using PROMPT."
  8771. (let ((org-refile-targets org-refile-targets)
  8772. (org-refile-use-outline-path org-refile-use-outline-path))
  8773. (setq org-refile-target-table (org-get-refile-targets default-buffer)))
  8774. (unless org-refile-target-table
  8775. (error "No refile targets"))
  8776. (let* ((cbuf (current-buffer))
  8777. (partial-completion-mode nil)
  8778. (cfn (buffer-file-name (buffer-base-buffer cbuf)))
  8779. (cfunc (if (and org-refile-use-outline-path
  8780. org-outline-path-complete-in-steps)
  8781. 'org-olpath-completing-read
  8782. 'org-icompleting-read))
  8783. (extra (if org-refile-use-outline-path "/" ""))
  8784. (filename (and cfn (expand-file-name cfn)))
  8785. (tbl (mapcar
  8786. (lambda (x)
  8787. (if (and (not (member org-refile-use-outline-path
  8788. '(file full-file-path)))
  8789. (not (equal filename (nth 1 x))))
  8790. (cons (concat (car x) extra " ("
  8791. (file-name-nondirectory (nth 1 x)) ")")
  8792. (cdr x))
  8793. (cons (concat (car x) extra) (cdr x))))
  8794. org-refile-target-table))
  8795. (completion-ignore-case t)
  8796. pa answ parent-target child parent old-hist)
  8797. (setq old-hist org-refile-history)
  8798. (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
  8799. nil 'org-refile-history))
  8800. (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
  8801. (if pa
  8802. (progn
  8803. (when (or (not org-refile-history)
  8804. (not (eq old-hist org-refile-history))
  8805. (not (equal (car pa) (car org-refile-history))))
  8806. (setq org-refile-history
  8807. (cons (car pa) (if (assoc (car org-refile-history) tbl)
  8808. org-refile-history
  8809. (cdr org-refile-history))))
  8810. (if (equal (car org-refile-history) (nth 1 org-refile-history))
  8811. (pop org-refile-history)))
  8812. pa)
  8813. (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
  8814. (progn
  8815. (setq parent (match-string 1 answ)
  8816. child (match-string 2 answ))
  8817. (setq parent-target (or (assoc parent tbl)
  8818. (assoc (concat parent "/") tbl)))
  8819. (when (and parent-target
  8820. (or (eq new-nodes t)
  8821. (and (eq new-nodes 'confirm)
  8822. (y-or-n-p (format "Create new node \"%s\"? "
  8823. child)))))
  8824. (org-refile-new-child parent-target child)))
  8825. (error "Invalid target location")))))
  8826. (defun org-refile-new-child (parent-target child)
  8827. "Use refile target PARENT-TARGET to add new CHILD below it."
  8828. (unless parent-target
  8829. (error "Cannot find parent for new node"))
  8830. (let ((file (nth 1 parent-target))
  8831. (pos (nth 3 parent-target))
  8832. level)
  8833. (with-current-buffer (or (find-buffer-visiting file)
  8834. (find-file-noselect file))
  8835. (save-excursion
  8836. (save-restriction
  8837. (widen)
  8838. (if pos
  8839. (goto-char pos)
  8840. (goto-char (point-max))
  8841. (if (not (bolp)) (newline)))
  8842. (when (looking-at outline-regexp)
  8843. (setq level (funcall outline-level))
  8844. (org-end-of-subtree t t))
  8845. (org-back-over-empty-lines)
  8846. (insert "\n" (make-string
  8847. (if pos (org-get-valid-level level 1) 1) ?*)
  8848. " " child "\n")
  8849. (beginning-of-line 0)
  8850. (list (concat (car parent-target) "/" child) file "" (point)))))))
  8851. (defun org-olpath-completing-read (prompt collection &rest args)
  8852. "Read an outline path like a file name."
  8853. (let ((thetable collection)
  8854. (org-completion-use-ido nil) ; does not work with ido.
  8855. (org-completion-use-iswitchb nil)) ; or iswitchb
  8856. (apply
  8857. 'org-icompleting-read prompt
  8858. (lambda (string predicate &optional flag)
  8859. (let (rtn r f (l (length string)))
  8860. (cond
  8861. ((eq flag nil)
  8862. ;; try completion
  8863. (try-completion string thetable))
  8864. ((eq flag t)
  8865. ;; all-completions
  8866. (setq rtn (all-completions string thetable predicate))
  8867. (mapcar
  8868. (lambda (x)
  8869. (setq r (substring x l))
  8870. (if (string-match " ([^)]*)$" x)
  8871. (setq f (match-string 0 x))
  8872. (setq f ""))
  8873. (if (string-match "/" r)
  8874. (concat string (substring r 0 (match-end 0)) f)
  8875. x))
  8876. rtn))
  8877. ((eq flag 'lambda)
  8878. ;; exact match?
  8879. (assoc string thetable)))
  8880. ))
  8881. args)))
  8882. ;;;; Dynamic blocks
  8883. (defun org-find-dblock (name)
  8884. "Find the first dynamic block with name NAME in the buffer.
  8885. If not found, stay at current position and return nil."
  8886. (let (pos)
  8887. (save-excursion
  8888. (goto-char (point-min))
  8889. (setq pos (and (re-search-forward (concat "^#\\+BEGIN:[ \t]+" name "\\>")
  8890. nil t)
  8891. (match-beginning 0))))
  8892. (if pos (goto-char pos))
  8893. pos))
  8894. (defconst org-dblock-start-re
  8895. "^[ \t]*#\\+BEGIN:[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
  8896. "Matches the start line of a dynamic block, with parameters.")
  8897. (defconst org-dblock-end-re "^[ \t]*#\\+END\\([: \t\r\n]\\|$\\)"
  8898. "Matches the end of a dynamic block.")
  8899. (defun org-create-dblock (plist)
  8900. "Create a dynamic block section, with parameters taken from PLIST.
  8901. PLIST must contain a :name entry which is used as name of the block."
  8902. (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
  8903. (end-of-line 1)
  8904. (newline))
  8905. (let ((col (current-column))
  8906. (name (plist-get plist :name)))
  8907. (insert "#+BEGIN: " name)
  8908. (while plist
  8909. (if (eq (car plist) :name)
  8910. (setq plist (cddr plist))
  8911. (insert " " (prin1-to-string (pop plist)))))
  8912. (insert "\n\n" (make-string col ?\ ) "#+END:\n")
  8913. (beginning-of-line -2)))
  8914. (defun org-prepare-dblock ()
  8915. "Prepare dynamic block for refresh.
  8916. This empties the block, puts the cursor at the insert position and returns
  8917. the property list including an extra property :name with the block name."
  8918. (unless (looking-at org-dblock-start-re)
  8919. (error "Not at a dynamic block"))
  8920. (let* ((begdel (1+ (match-end 0)))
  8921. (name (org-no-properties (match-string 1)))
  8922. (params (append (list :name name)
  8923. (read (concat "(" (match-string 3) ")")))))
  8924. (save-excursion
  8925. (beginning-of-line 1)
  8926. (skip-chars-forward " \t")
  8927. (setq params (plist-put params :indentation-column (current-column))))
  8928. (unless (re-search-forward org-dblock-end-re nil t)
  8929. (error "Dynamic block not terminated"))
  8930. (setq params
  8931. (append params
  8932. (list :content (buffer-substring
  8933. begdel (match-beginning 0)))))
  8934. (delete-region begdel (match-beginning 0))
  8935. (goto-char begdel)
  8936. (open-line 1)
  8937. params))
  8938. (defun org-map-dblocks (&optional command)
  8939. "Apply COMMAND to all dynamic blocks in the current buffer.
  8940. If COMMAND is not given, use `org-update-dblock'."
  8941. (let ((cmd (or command 'org-update-dblock)))
  8942. (save-excursion
  8943. (goto-char (point-min))
  8944. (while (re-search-forward org-dblock-start-re nil t)
  8945. (goto-char (match-beginning 0))
  8946. (save-excursion
  8947. (condition-case nil
  8948. (funcall cmd)
  8949. (error (message "Error during update of dynamic block"))))
  8950. (unless (re-search-forward org-dblock-end-re nil t)
  8951. (error "Dynamic block not terminated"))))))
  8952. (defun org-dblock-update (&optional arg)
  8953. "User command for updating dynamic blocks.
  8954. Update the dynamic block at point. With prefix ARG, update all dynamic
  8955. blocks in the buffer."
  8956. (interactive "P")
  8957. (if arg
  8958. (org-update-all-dblocks)
  8959. (or (looking-at org-dblock-start-re)
  8960. (org-beginning-of-dblock))
  8961. (org-update-dblock)))
  8962. (defun org-update-dblock ()
  8963. "Update the dynamic block at point
  8964. This means to empty the block, parse for parameters and then call
  8965. the correct writing function."
  8966. (save-window-excursion
  8967. (let* ((pos (point))
  8968. (line (org-current-line))
  8969. (params (org-prepare-dblock))
  8970. (name (plist-get params :name))
  8971. (indent (plist-get params :indentation-column))
  8972. (cmd (intern (concat "org-dblock-write:" name))))
  8973. (message "Updating dynamic block `%s' at line %d..." name line)
  8974. (funcall cmd params)
  8975. (message "Updating dynamic block `%s' at line %d...done" name line)
  8976. (goto-char pos)
  8977. (when (and indent (> indent 0))
  8978. (setq indent (make-string indent ?\ ))
  8979. (save-excursion
  8980. (org-beginning-of-dblock)
  8981. (forward-line 1)
  8982. (while (not (looking-at org-dblock-end-re))
  8983. (insert indent)
  8984. (beginning-of-line 2))
  8985. (when (looking-at org-dblock-end-re)
  8986. (and (looking-at "[ \t]+")
  8987. (replace-match ""))
  8988. (insert indent)))))))
  8989. (defun org-beginning-of-dblock ()
  8990. "Find the beginning of the dynamic block at point.
  8991. Error if there is no such block at point."
  8992. (let ((pos (point))
  8993. beg)
  8994. (end-of-line 1)
  8995. (if (and (re-search-backward org-dblock-start-re nil t)
  8996. (setq beg (match-beginning 0))
  8997. (re-search-forward org-dblock-end-re nil t)
  8998. (> (match-end 0) pos))
  8999. (goto-char beg)
  9000. (goto-char pos)
  9001. (error "Not in a dynamic block"))))
  9002. (defun org-update-all-dblocks ()
  9003. "Update all dynamic blocks in the buffer.
  9004. This function can be used in a hook."
  9005. (when (org-mode-p)
  9006. (org-map-dblocks 'org-update-dblock)))
  9007. ;;;; Completion
  9008. (defconst org-additional-option-like-keywords
  9009. '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML"
  9010. "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook"
  9011. "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
  9012. "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX"
  9013. "BEGIN:" "END:"
  9014. "ORGTBL" "TBLFM:" "TBLNAME:"
  9015. "BEGIN_EXAMPLE" "END_EXAMPLE"
  9016. "BEGIN_QUOTE" "END_QUOTE"
  9017. "BEGIN_VERSE" "END_VERSE"
  9018. "BEGIN_CENTER" "END_CENTER"
  9019. "BEGIN_SRC" "END_SRC"
  9020. "CATEGORY" "COLUMNS"
  9021. "CAPTION" "LABEL"
  9022. "SETUPFILE"
  9023. "BIND"
  9024. "MACRO"))
  9025. (defcustom org-structure-template-alist
  9026. '(
  9027. ("s" "#+begin_src ?\n\n#+end_src"
  9028. "<src lang=\"?\">\n\n</src>")
  9029. ("e" "#+begin_example\n?\n#+end_example"
  9030. "<example>\n?\n</example>")
  9031. ("q" "#+begin_quote\n?\n#+end_quote"
  9032. "<quote>\n?\n</quote>")
  9033. ("v" "#+begin_verse\n?\n#+end_verse"
  9034. "<verse>\n?\n/verse>")
  9035. ("c" "#+begin_center\n?\n#+end_center"
  9036. "<center>\n?\n/center>")
  9037. ("l" "#+begin_latex\n?\n#+end_latex"
  9038. "<literal style=\"latex\">\n?\n</literal>")
  9039. ("L" "#+latex: "
  9040. "<literal style=\"latex\">?</literal>")
  9041. ("h" "#+begin_html\n?\n#+end_html"
  9042. "<literal style=\"html\">\n?\n</literal>")
  9043. ("H" "#+html: "
  9044. "<literal style=\"html\">?</literal>")
  9045. ("a" "#+begin_ascii\n?\n#+end_ascii")
  9046. ("A" "#+ascii: ")
  9047. ("i" "#+include %file ?"
  9048. "<include file=%file markup=\"?\">")
  9049. )
  9050. "Structure completion elements.
  9051. This is a list of abbreviation keys and values. The value gets inserted
  9052. if you type `<' followed by the key and then press the completion key,
  9053. usually `M-TAB'. %file will be replaced by a file name after prompting
  9054. for the file using completion.
  9055. There are two templates for each key, the first uses the original Org syntax,
  9056. the second uses Emacs Muse-like syntax tags. These Muse-like tags become
  9057. the default when the /org-mtags.el/ module has been loaded. See also the
  9058. variable `org-mtags-prefer-muse-templates'.
  9059. This is an experimental feature, it is undecided if it is going to stay in."
  9060. :group 'org-completion
  9061. :type '(repeat
  9062. (string :tag "Key")
  9063. (string :tag "Template")
  9064. (string :tag "Muse Template")))
  9065. (defun org-try-structure-completion ()
  9066. "Try to complete a structure template before point.
  9067. This looks for strings like \"<e\" on an otherwise empty line and
  9068. expands them."
  9069. (let ((l (buffer-substring (point-at-bol) (point)))
  9070. a)
  9071. (when (and (looking-at "[ \t]*$")
  9072. (string-match "^[ \t]*<\\([a-z]+\\)$"l)
  9073. (setq a (assoc (match-string 1 l) org-structure-template-alist)))
  9074. (org-complete-expand-structure-template (+ -1 (point-at-bol)
  9075. (match-beginning 1)) a)
  9076. t)))
  9077. (defun org-complete-expand-structure-template (start cell)
  9078. "Expand a structure template."
  9079. (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
  9080. (rpl (nth (if musep 2 1) cell))
  9081. (ind ""))
  9082. (delete-region start (point))
  9083. (when (string-match "\\`#\\+" rpl)
  9084. (cond
  9085. ((bolp))
  9086. ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
  9087. (setq ind (buffer-substring (point-at-bol) (point))))
  9088. (t (newline))))
  9089. (setq start (point))
  9090. (if (string-match "%file" rpl)
  9091. (setq rpl (replace-match
  9092. (concat
  9093. "\""
  9094. (save-match-data
  9095. (abbreviate-file-name (read-file-name "Include file: ")))
  9096. "\"")
  9097. t t rpl)))
  9098. (setq rpl (mapconcat 'identity (split-string rpl "\n")
  9099. (concat "\n" ind)))
  9100. (insert rpl)
  9101. (if (re-search-backward "\\?" start t) (delete-char 1))))
  9102. (defun org-complete (&optional arg)
  9103. "Perform completion on word at point.
  9104. At the beginning of a headline, this completes TODO keywords as given in
  9105. `org-todo-keywords'.
  9106. If the current word is preceded by a backslash, completes the TeX symbols
  9107. that are supported for HTML support.
  9108. If the current word is preceded by \"#+\", completes special words for
  9109. setting file options.
  9110. In the line after \"#+STARTUP:, complete valid keywords.\"
  9111. At all other locations, this simply calls the value of
  9112. `org-completion-fallback-command'."
  9113. (interactive "P")
  9114. (org-without-partial-completion
  9115. (catch 'exit
  9116. (let* ((a nil)
  9117. (end (point))
  9118. (beg1 (save-excursion
  9119. (skip-chars-backward (org-re "[:alnum:]_@"))
  9120. (point)))
  9121. (beg (save-excursion
  9122. (skip-chars-backward "a-zA-Z0-9_:$")
  9123. (point)))
  9124. (confirm (lambda (x) (stringp (car x))))
  9125. (searchhead (equal (char-before beg) ?*))
  9126. (struct
  9127. (when (and (member (char-before beg1) '(?. ?<))
  9128. (setq a (assoc (buffer-substring beg1 (point))
  9129. org-structure-template-alist)))
  9130. (org-complete-expand-structure-template (1- beg1) a)
  9131. (throw 'exit t)))
  9132. (tag (and (equal (char-before beg1) ?:)
  9133. (equal (char-after (point-at-bol)) ?*)))
  9134. (prop (and (equal (char-before beg1) ?:)
  9135. (not (equal (char-after (point-at-bol)) ?*))))
  9136. (texp (equal (char-before beg) ?\\))
  9137. (link (equal (char-before beg) ?\[))
  9138. (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
  9139. beg)
  9140. "#+"))
  9141. (startup (string-match "^#\\+STARTUP:.*"
  9142. (buffer-substring (point-at-bol) (point))))
  9143. (completion-ignore-case opt)
  9144. (type nil)
  9145. (tbl nil)
  9146. (table (cond
  9147. (opt
  9148. (setq type :opt)
  9149. (require 'org-exp)
  9150. (append
  9151. (delq nil
  9152. (mapcar
  9153. (lambda (x)
  9154. (if (string-match
  9155. "^#\\+\\(\\([A-Z_]+:?\\).*\\)" x)
  9156. (cons (match-string 2 x)
  9157. (match-string 1 x))))
  9158. (org-split-string (org-get-current-options) "\n")))
  9159. (mapcar 'list org-additional-option-like-keywords)))
  9160. (startup
  9161. (setq type :startup)
  9162. org-startup-options)
  9163. (link (append org-link-abbrev-alist-local
  9164. org-link-abbrev-alist))
  9165. (texp
  9166. (setq type :tex)
  9167. (append org-entities-user org-entities))
  9168. ((string-match "\\`\\*+[ \t]+\\'"
  9169. (buffer-substring (point-at-bol) beg))
  9170. (setq type :todo)
  9171. (mapcar 'list org-todo-keywords-1))
  9172. (searchhead
  9173. (setq type :searchhead)
  9174. (save-excursion
  9175. (goto-char (point-min))
  9176. (while (re-search-forward org-todo-line-regexp nil t)
  9177. (push (list
  9178. (org-make-org-heading-search-string
  9179. (match-string 3) t))
  9180. tbl)))
  9181. tbl)
  9182. (tag (setq type :tag beg beg1)
  9183. (or org-tag-alist (org-get-buffer-tags)))
  9184. (prop (setq type :prop beg beg1)
  9185. (mapcar 'list (org-buffer-property-keys nil t t)))
  9186. (t (progn
  9187. (call-interactively org-completion-fallback-command)
  9188. (throw 'exit nil)))))
  9189. (pattern (buffer-substring-no-properties beg end))
  9190. (completion (try-completion pattern table confirm)))
  9191. (cond ((eq completion t)
  9192. (if (not (assoc (upcase pattern) table))
  9193. (message "Already complete")
  9194. (if (and (equal type :opt)
  9195. (not (member (car (assoc (upcase pattern) table))
  9196. org-additional-option-like-keywords)))
  9197. (insert (substring (cdr (assoc (upcase pattern) table))
  9198. (length pattern)))
  9199. (if (memq type '(:tag :prop)) (insert ":")))))
  9200. ((null completion)
  9201. (message "Can't find completion for \"%s\"" pattern)
  9202. (ding))
  9203. ((not (string= pattern completion))
  9204. (delete-region beg end)
  9205. (if (string-match " +$" completion)
  9206. (setq completion (replace-match "" t t completion)))
  9207. (insert completion)
  9208. (if (get-buffer-window "*Completions*")
  9209. (delete-window (get-buffer-window "*Completions*")))
  9210. (if (assoc completion table)
  9211. (if (eq type :todo) (insert " ")
  9212. (if (memq type '(:tag :prop)) (insert ":"))))
  9213. (if (and (equal type :opt) (assoc completion table))
  9214. (message "%s" (substitute-command-keys
  9215. "Press \\[org-complete] again to insert example settings"))))
  9216. (t
  9217. (message "Making completion list...")
  9218. (let ((list (sort (all-completions pattern table confirm)
  9219. 'string<)))
  9220. (with-output-to-temp-buffer "*Completions*"
  9221. (condition-case nil
  9222. ;; Protection needed for XEmacs and emacs 21
  9223. (display-completion-list list pattern)
  9224. (error (display-completion-list list)))))
  9225. (message "Making completion list...%s" "done")))))))
  9226. ;;;; TODO, DEADLINE, Comments
  9227. (defun org-toggle-comment ()
  9228. "Change the COMMENT state of an entry."
  9229. (interactive)
  9230. (save-excursion
  9231. (org-back-to-heading)
  9232. (let (case-fold-search)
  9233. (if (looking-at (concat outline-regexp
  9234. "\\( *\\<" org-comment-string "\\>[ \t]*\\)"))
  9235. (replace-match "" t t nil 1)
  9236. (if (looking-at outline-regexp)
  9237. (progn
  9238. (goto-char (match-end 0))
  9239. (insert org-comment-string " ")))))))
  9240. (defvar org-last-todo-state-is-todo nil
  9241. "This is non-nil when the last TODO state change led to a TODO state.
  9242. If the last change removed the TODO tag or switched to DONE, then
  9243. this is nil.")
  9244. (defvar org-setting-tags nil) ; dynamically skipped
  9245. (defun org-parse-local-options (string var)
  9246. "Parse STRING for startup setting relevant for variable VAR."
  9247. (let ((rtn (symbol-value var))
  9248. e opts)
  9249. (save-match-data
  9250. (if (or (not string) (not (string-match "\\S-" string)))
  9251. rtn
  9252. (setq opts (delq nil (mapcar (lambda (x)
  9253. (setq e (assoc x org-startup-options))
  9254. (if (eq (nth 1 e) var) e nil))
  9255. (org-split-string string "[ \t]+"))))
  9256. (if (not opts)
  9257. rtn
  9258. (setq rtn nil)
  9259. (while (setq e (pop opts))
  9260. (if (not (nth 3 e))
  9261. (setq rtn (nth 2 e))
  9262. (if (not (listp rtn)) (setq rtn nil))
  9263. (push (nth 2 e) rtn)))
  9264. rtn)))))
  9265. (defvar org-todo-setup-filter-hook nil
  9266. "Hook for functions that pre-filter todo specs.
  9267. Each function takes a todo spec and returns either `nil' or the spec
  9268. transformed into canonical form." )
  9269. (defvar org-todo-get-default-hook nil
  9270. "Hook for functions that get a default item for todo.
  9271. Each function takes arguments (NEW-MARK OLD-MARK) and returns either
  9272. `nil' or a string to be used for the todo mark." )
  9273. (defvar org-agenda-headline-snapshot-before-repeat)
  9274. (defun org-todo (&optional arg)
  9275. "Change the TODO state of an item.
  9276. The state of an item is given by a keyword at the start of the heading,
  9277. like
  9278. *** TODO Write paper
  9279. *** DONE Call mom
  9280. The different keywords are specified in the variable `org-todo-keywords'.
  9281. By default the available states are \"TODO\" and \"DONE\".
  9282. So for this example: when the item starts with TODO, it is changed to DONE.
  9283. When it starts with DONE, the DONE is removed. And when neither TODO nor
  9284. DONE are present, add TODO at the beginning of the heading.
  9285. With C-u prefix arg, use completion to determine the new state.
  9286. With numeric prefix arg, switch to that state.
  9287. With a double C-u prefix, switch to the next set of TODO keywords (nextset).
  9288. With a triple C-u prefix, circumvent any state blocking.
  9289. For calling through lisp, arg is also interpreted in the following way:
  9290. 'none -> empty state
  9291. \"\"(empty string) -> switch to empty state
  9292. 'done -> switch to DONE
  9293. 'nextset -> switch to the next set of keywords
  9294. 'previousset -> switch to the previous set of keywords
  9295. \"WAITING\" -> switch to the specified keyword, but only if it
  9296. really is a member of `org-todo-keywords'."
  9297. (interactive "P")
  9298. (if (equal arg '(16)) (setq arg 'nextset))
  9299. (let ((org-blocker-hook org-blocker-hook)
  9300. (case-fold-search nil))
  9301. (when (equal arg '(64))
  9302. (setq arg nil org-blocker-hook nil))
  9303. (when (and org-blocker-hook
  9304. (or org-inhibit-blocking
  9305. (org-entry-get nil "NOBLOCKING")))
  9306. (setq org-blocker-hook nil))
  9307. (save-excursion
  9308. (catch 'exit
  9309. (org-back-to-heading t)
  9310. (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
  9311. (or (looking-at (concat " +" org-todo-regexp "\\( +\\|$\\)"))
  9312. (looking-at " *"))
  9313. (let* ((match-data (match-data))
  9314. (startpos (point-at-bol))
  9315. (logging (save-match-data (org-entry-get nil "LOGGING" t)))
  9316. (org-log-done org-log-done)
  9317. (org-log-repeat org-log-repeat)
  9318. (org-todo-log-states org-todo-log-states)
  9319. (this (match-string 1))
  9320. (hl-pos (match-beginning 0))
  9321. (head (org-get-todo-sequence-head this))
  9322. (ass (assoc head org-todo-kwd-alist))
  9323. (interpret (nth 1 ass))
  9324. (done-word (nth 3 ass))
  9325. (final-done-word (nth 4 ass))
  9326. (last-state (or this ""))
  9327. (completion-ignore-case t)
  9328. (member (member this org-todo-keywords-1))
  9329. (tail (cdr member))
  9330. (state (cond
  9331. ((and org-todo-key-trigger
  9332. (or (and (equal arg '(4))
  9333. (eq org-use-fast-todo-selection 'prefix))
  9334. (and (not arg) org-use-fast-todo-selection
  9335. (not (eq org-use-fast-todo-selection
  9336. 'prefix)))))
  9337. ;; Use fast selection
  9338. (org-fast-todo-selection))
  9339. ((and (equal arg '(4))
  9340. (or (not org-use-fast-todo-selection)
  9341. (not org-todo-key-trigger)))
  9342. ;; Read a state with completion
  9343. (org-icompleting-read
  9344. "State: " (mapcar (lambda(x) (list x))
  9345. org-todo-keywords-1)
  9346. nil t))
  9347. ((eq arg 'right)
  9348. (if this
  9349. (if tail (car tail) nil)
  9350. (car org-todo-keywords-1)))
  9351. ((eq arg 'left)
  9352. (if (equal member org-todo-keywords-1)
  9353. nil
  9354. (if this
  9355. (nth (- (length org-todo-keywords-1)
  9356. (length tail) 2)
  9357. org-todo-keywords-1)
  9358. (org-last org-todo-keywords-1))))
  9359. ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
  9360. (setq arg nil))) ; hack to fall back to cycling
  9361. (arg
  9362. ;; user or caller requests a specific state
  9363. (cond
  9364. ((equal arg "") nil)
  9365. ((eq arg 'none) nil)
  9366. ((eq arg 'done) (or done-word (car org-done-keywords)))
  9367. ((eq arg 'nextset)
  9368. (or (car (cdr (member head org-todo-heads)))
  9369. (car org-todo-heads)))
  9370. ((eq arg 'previousset)
  9371. (let ((org-todo-heads (reverse org-todo-heads)))
  9372. (or (car (cdr (member head org-todo-heads)))
  9373. (car org-todo-heads))))
  9374. ((car (member arg org-todo-keywords-1)))
  9375. ((stringp arg)
  9376. (error "State `%s' not valid in this file" arg))
  9377. ((nth (1- (prefix-numeric-value arg))
  9378. org-todo-keywords-1))))
  9379. ((null member) (or head (car org-todo-keywords-1)))
  9380. ((equal this final-done-word) nil) ;; -> make empty
  9381. ((null tail) nil) ;; -> first entry
  9382. ((memq interpret '(type priority))
  9383. (if (eq this-command last-command)
  9384. (car tail)
  9385. (if (> (length tail) 0)
  9386. (or done-word (car org-done-keywords))
  9387. nil)))
  9388. (t
  9389. (car tail))))
  9390. (state (or
  9391. (run-hook-with-args-until-success
  9392. 'org-todo-get-default-hook state last-state)
  9393. state))
  9394. (next (if state (concat " " state " ") " "))
  9395. (change-plist (list :type 'todo-state-change :from this :to state
  9396. :position startpos))
  9397. dolog now-done-p)
  9398. (when org-blocker-hook
  9399. (setq org-last-todo-state-is-todo
  9400. (not (member this org-done-keywords)))
  9401. (unless (save-excursion
  9402. (save-match-data
  9403. (run-hook-with-args-until-failure
  9404. 'org-blocker-hook change-plist)))
  9405. (if (interactive-p)
  9406. (error "TODO state change from %s to %s blocked" this state)
  9407. ;; fail silently
  9408. (message "TODO state change from %s to %s blocked" this state)
  9409. (throw 'exit nil))))
  9410. (store-match-data match-data)
  9411. (replace-match next t t)
  9412. (unless (pos-visible-in-window-p hl-pos)
  9413. (message "TODO state changed to %s" (org-trim next)))
  9414. (unless head
  9415. (setq head (org-get-todo-sequence-head state)
  9416. ass (assoc head org-todo-kwd-alist)
  9417. interpret (nth 1 ass)
  9418. done-word (nth 3 ass)
  9419. final-done-word (nth 4 ass)))
  9420. (when (memq arg '(nextset previousset))
  9421. (message "Keyword-Set %d/%d: %s"
  9422. (- (length org-todo-sets) -1
  9423. (length (memq (assoc state org-todo-sets) org-todo-sets)))
  9424. (length org-todo-sets)
  9425. (mapconcat 'identity (assoc state org-todo-sets) " ")))
  9426. (setq org-last-todo-state-is-todo
  9427. (not (member state org-done-keywords)))
  9428. (setq now-done-p (and (member state org-done-keywords)
  9429. (not (member this org-done-keywords))))
  9430. (and logging (org-local-logging logging))
  9431. (when (and (or org-todo-log-states org-log-done)
  9432. (not (eq org-inhibit-logging t))
  9433. (not (memq arg '(nextset previousset))))
  9434. ;; we need to look at recording a time and note
  9435. (setq dolog (or (nth 1 (assoc state org-todo-log-states))
  9436. (nth 2 (assoc this org-todo-log-states))))
  9437. (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
  9438. (setq dolog 'time))
  9439. (when (and state
  9440. (member state org-not-done-keywords)
  9441. (not (member this org-not-done-keywords)))
  9442. ;; This is now a todo state and was not one before
  9443. ;; If there was a CLOSED time stamp, get rid of it.
  9444. (org-add-planning-info nil nil 'closed))
  9445. (when (and now-done-p org-log-done)
  9446. ;; It is now done, and it was not done before
  9447. (org-add-planning-info 'closed (org-current-time))
  9448. (if (and (not dolog) (eq 'note org-log-done))
  9449. (org-add-log-setup 'done state this 'findpos 'note)))
  9450. (when (and state dolog)
  9451. ;; This is a non-nil state, and we need to log it
  9452. (org-add-log-setup 'state state this 'findpos dolog)))
  9453. ;; Fixup tag positioning
  9454. (org-todo-trigger-tag-changes state)
  9455. (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
  9456. (when org-provide-todo-statistics
  9457. (org-update-parent-todo-statistics))
  9458. (run-hooks 'org-after-todo-state-change-hook)
  9459. (if (and arg (not (member state org-done-keywords)))
  9460. (setq head (org-get-todo-sequence-head state)))
  9461. (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
  9462. ;; Do we need to trigger a repeat?
  9463. (when now-done-p
  9464. (when (boundp 'org-agenda-headline-snapshot-before-repeat)
  9465. ;; This is for the agenda, take a snapshot of the headline.
  9466. (save-match-data
  9467. (setq org-agenda-headline-snapshot-before-repeat
  9468. (org-get-heading))))
  9469. (org-auto-repeat-maybe state))
  9470. ;; Fixup cursor location if close to the keyword
  9471. (if (and (outline-on-heading-p)
  9472. (not (bolp))
  9473. (save-excursion (beginning-of-line 1)
  9474. (looking-at org-todo-line-regexp))
  9475. (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
  9476. (progn
  9477. (goto-char (or (match-end 2) (match-end 1)))
  9478. (and (looking-at " ") (just-one-space))))
  9479. (when org-trigger-hook
  9480. (save-excursion
  9481. (run-hook-with-args 'org-trigger-hook change-plist))))))))
  9482. (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
  9483. "Block turning an entry into a TODO, using the hierarchy.
  9484. This checks whether the current task should be blocked from state
  9485. changes. Such blocking occurs when:
  9486. 1. The task has children which are not all in a completed state.
  9487. 2. A task has a parent with the property :ORDERED:, and there
  9488. are siblings prior to the current task with incomplete
  9489. status.
  9490. 3. The parent of the task is blocked because it has siblings that should
  9491. be done first, or is child of a block grandparent TODO entry."
  9492. (if (not org-enforce-todo-dependencies)
  9493. t ; if locally turned off don't block
  9494. (catch 'dont-block
  9495. ;; If this is not a todo state change, or if this entry is already DONE,
  9496. ;; do not block
  9497. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  9498. (member (plist-get change-plist :from)
  9499. (cons 'done org-done-keywords))
  9500. (member (plist-get change-plist :to)
  9501. (cons 'todo org-not-done-keywords))
  9502. (not (plist-get change-plist :to)))
  9503. (throw 'dont-block t))
  9504. ;; If this task has children, and any are undone, it's blocked
  9505. (save-excursion
  9506. (org-back-to-heading t)
  9507. (let ((this-level (funcall outline-level)))
  9508. (outline-next-heading)
  9509. (let ((child-level (funcall outline-level)))
  9510. (while (and (not (eobp))
  9511. (> child-level this-level))
  9512. ;; this todo has children, check whether they are all
  9513. ;; completed
  9514. (if (and (not (org-entry-is-done-p))
  9515. (org-entry-is-todo-p))
  9516. (throw 'dont-block nil))
  9517. (outline-next-heading)
  9518. (setq child-level (funcall outline-level))))))
  9519. ;; Otherwise, if the task's parent has the :ORDERED: property, and
  9520. ;; any previous siblings are undone, it's blocked
  9521. (save-excursion
  9522. (org-back-to-heading t)
  9523. (let* ((pos (point))
  9524. (parent-pos (and (org-up-heading-safe) (point))))
  9525. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  9526. (when (and (org-entry-get (point) "ORDERED")
  9527. (forward-line 1)
  9528. (re-search-forward org-not-done-heading-regexp pos t))
  9529. (throw 'dont-block nil)) ; block, there is an older sibling not done.
  9530. ;; Search further up the hierarchy, to see if an anchestor is blocked
  9531. (while t
  9532. (goto-char parent-pos)
  9533. (if (not (looking-at org-not-done-heading-regexp))
  9534. (throw 'dont-block t)) ; do not block, parent is not a TODO
  9535. (setq pos (point))
  9536. (setq parent-pos (and (org-up-heading-safe) (point)))
  9537. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  9538. (when (and (org-entry-get (point) "ORDERED")
  9539. (forward-line 1)
  9540. (re-search-forward org-not-done-heading-regexp pos t))
  9541. (throw 'dont-block nil)))))))) ; block, older sibling not done.
  9542. (defcustom org-track-ordered-property-with-tag nil
  9543. "Should the ORDERED property also be shown as a tag?
  9544. The ORDERED property decides if an entry should require subtasks to be
  9545. completed in sequence. Since a property is not very visible, setting
  9546. this option means that toggling the ORDERED property with the command
  9547. `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
  9548. not relevant for the behavior, but it makes things more visible.
  9549. Note that toggling the tag with tags commands will not change the property
  9550. and therefore not influence behavior!
  9551. This can be t, meaning the tag ORDERED should be used, It can also be a
  9552. string to select a different tag for this task."
  9553. :group 'org-todo
  9554. :type '(choice
  9555. (const :tag "No tracking" nil)
  9556. (const :tag "Track with ORDERED tag" t)
  9557. (string :tag "Use other tag")))
  9558. (defun org-toggle-ordered-property ()
  9559. "Toggle the ORDERED property of the current entry.
  9560. For better visibility, you can track the value of this property with a tag.
  9561. See variable `org-track-ordered-property-with-tag'."
  9562. (interactive)
  9563. (let* ((t1 org-track-ordered-property-with-tag)
  9564. (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
  9565. (save-excursion
  9566. (org-back-to-heading)
  9567. (if (org-entry-get nil "ORDERED")
  9568. (progn
  9569. (org-delete-property "ORDERED")
  9570. (and tag (org-toggle-tag tag 'off))
  9571. (message "Subtasks can be completed in arbitrary order"))
  9572. (org-entry-put nil "ORDERED" "t")
  9573. (and tag (org-toggle-tag tag 'on))
  9574. (message "Subtasks must be completed in sequence")))))
  9575. (defvar org-blocked-by-checkboxes) ; dynamically scoped
  9576. (defun org-block-todo-from-checkboxes (change-plist)
  9577. "Block turning an entry into a TODO, using checkboxes.
  9578. This checks whether the current task should be blocked from state
  9579. changes because there are unchecked boxes in this entry."
  9580. (if (not org-enforce-todo-checkbox-dependencies)
  9581. t ; if locally turned off don't block
  9582. (catch 'dont-block
  9583. ;; If this is not a todo state change, or if this entry is already DONE,
  9584. ;; do not block
  9585. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  9586. (member (plist-get change-plist :from)
  9587. (cons 'done org-done-keywords))
  9588. (member (plist-get change-plist :to)
  9589. (cons 'todo org-not-done-keywords))
  9590. (not (plist-get change-plist :to)))
  9591. (throw 'dont-block t))
  9592. ;; If this task has checkboxes that are not checked, it's blocked
  9593. (save-excursion
  9594. (org-back-to-heading t)
  9595. (let ((beg (point)) end)
  9596. (outline-next-heading)
  9597. (setq end (point))
  9598. (goto-char beg)
  9599. (if (re-search-forward "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\)[ \t]+\\[[- ]\\]"
  9600. end t)
  9601. (progn
  9602. (if (boundp 'org-blocked-by-checkboxes)
  9603. (setq org-blocked-by-checkboxes t))
  9604. (throw 'dont-block nil)))))
  9605. t))) ; do not block
  9606. (defun org-entry-blocked-p ()
  9607. "Is the current entry blocked?"
  9608. (if (org-entry-get nil "NOBLOCKING")
  9609. nil ;; Never block this entry
  9610. (not
  9611. (run-hook-with-args-until-failure
  9612. 'org-blocker-hook
  9613. (list :type 'todo-state-change
  9614. :position (point)
  9615. :from 'todo
  9616. :to 'done)))))
  9617. (defun org-update-statistics-cookies (all)
  9618. "Update the statistics cookie, either from TODO or from checkboxes.
  9619. This should be called with the cursor in a line with a statistics cookie."
  9620. (interactive "P")
  9621. (if all
  9622. (progn
  9623. (org-update-checkbox-count 'all)
  9624. (org-map-entries 'org-update-parent-todo-statistics))
  9625. (if (not (org-on-heading-p))
  9626. (org-update-checkbox-count)
  9627. (let ((pos (move-marker (make-marker) (point)))
  9628. end l1 l2)
  9629. (ignore-errors (org-back-to-heading t))
  9630. (if (not (org-on-heading-p))
  9631. (org-update-checkbox-count)
  9632. (setq l1 (org-outline-level))
  9633. (setq end (save-excursion
  9634. (outline-next-heading)
  9635. (if (org-on-heading-p) (setq l2 (org-outline-level)))
  9636. (point)))
  9637. (if (and (save-excursion
  9638. (re-search-forward
  9639. "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
  9640. (not (save-excursion (re-search-forward
  9641. ":COOKIE_DATA:.*\\<todo\\>" end t))))
  9642. (org-update-checkbox-count)
  9643. (if (and l2 (> l2 l1))
  9644. (progn
  9645. (goto-char end)
  9646. (org-update-parent-todo-statistics))
  9647. (goto-char pos)
  9648. (beginning-of-line 1)
  9649. (while (re-search-forward
  9650. "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
  9651. (point-at-eol) t)
  9652. (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
  9653. (goto-char pos)
  9654. (move-marker pos nil)))))
  9655. (defvar org-entry-property-inherited-from) ;; defined below
  9656. (defun org-update-parent-todo-statistics ()
  9657. "Update any statistics cookie in the parent of the current headline.
  9658. When `org-hierarchical-todo-statistics' is nil, statistics will cover
  9659. the entire subtree and this will travel up the hierarchy and update
  9660. statistics everywhere."
  9661. (interactive)
  9662. (let* ((lim 0) prop
  9663. (recursive (or (not org-hierarchical-todo-statistics)
  9664. (string-match
  9665. "\\<recursive\\>"
  9666. (or (setq prop (org-entry-get
  9667. nil "COOKIE_DATA" 'inherit)) ""))))
  9668. (lim (or (and prop (marker-position
  9669. org-entry-property-inherited-from))
  9670. lim))
  9671. (first t)
  9672. (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  9673. level ltoggle l1 new ndel
  9674. (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
  9675. (catch 'exit
  9676. (save-excursion
  9677. (beginning-of-line 1)
  9678. (if (org-at-heading-p)
  9679. (setq ltoggle (funcall outline-level))
  9680. (error "This should not happen"))
  9681. (while (and (setq level (org-up-heading-safe))
  9682. (or recursive first)
  9683. (>= (point) lim))
  9684. (setq first nil cookie-present nil)
  9685. (unless (and level
  9686. (not (string-match
  9687. "\\<checkbox\\>"
  9688. (downcase
  9689. (or (org-entry-get
  9690. nil "COOKIE_DATA")
  9691. "")))))
  9692. (throw 'exit nil))
  9693. (while (re-search-forward box-re (point-at-eol) t)
  9694. (setq cnt-all 0 cnt-done 0 cookie-present t)
  9695. (setq is-percent (match-end 2))
  9696. (save-match-data
  9697. (unless (outline-next-heading) (throw 'exit nil))
  9698. (while (and (looking-at org-complex-heading-regexp)
  9699. (> (setq l1 (length (match-string 1))) level))
  9700. (setq kwd (and (or recursive (= l1 ltoggle))
  9701. (match-string 2)))
  9702. (if (or (eq org-provide-todo-statistics 'all-headlines)
  9703. (and (listp org-provide-todo-statistics)
  9704. (or (member kwd org-provide-todo-statistics)
  9705. (member kwd org-done-keywords))))
  9706. (setq cnt-all (1+ cnt-all))
  9707. (if (eq org-provide-todo-statistics t)
  9708. (and kwd (setq cnt-all (1+ cnt-all)))))
  9709. (and (member kwd org-done-keywords)
  9710. (setq cnt-done (1+ cnt-done)))
  9711. (outline-next-heading)))
  9712. (setq new
  9713. (if is-percent
  9714. (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
  9715. (format "[%d/%d]" cnt-done cnt-all))
  9716. ndel (- (match-end 0) (match-beginning 0)))
  9717. (goto-char (match-beginning 0))
  9718. (insert new)
  9719. (delete-region (point) (+ (point) ndel)))
  9720. (when cookie-present
  9721. (run-hook-with-args 'org-after-todo-statistics-hook
  9722. cnt-done (- cnt-all cnt-done))))))
  9723. (run-hooks 'org-todo-statistics-hook)))
  9724. (defvar org-after-todo-statistics-hook nil
  9725. "Hook that is called after a TODO statistics cookie has been updated.
  9726. Each function is called with two arguments: the number of not-done entries
  9727. and the number of done entries.
  9728. For example, the following function, when added to this hook, will switch
  9729. an entry to DONE when all children are done, and back to TODO when new
  9730. entries are set to a TODO status. Note that this hook is only called
  9731. when there is a statistics cookie in the headline!
  9732. (defun org-summary-todo (n-done n-not-done)
  9733. \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
  9734. (let (org-log-done org-log-states) ; turn off logging
  9735. (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
  9736. ")
  9737. (defvar org-todo-statistics-hook nil
  9738. "Hook that is run whenever Org thinks TODO statistics should be updated.
  9739. This hook runs even if there is no statistics cookie present, in which case
  9740. `org-after-todo-statistics-hook' would not run.")
  9741. (defun org-todo-trigger-tag-changes (state)
  9742. "Apply the changes defined in `org-todo-state-tags-triggers'."
  9743. (let ((l org-todo-state-tags-triggers)
  9744. changes)
  9745. (when (or (not state) (equal state ""))
  9746. (setq changes (append changes (cdr (assoc "" l)))))
  9747. (when (and (stringp state) (> (length state) 0))
  9748. (setq changes (append changes (cdr (assoc state l)))))
  9749. (when (member state org-not-done-keywords)
  9750. (setq changes (append changes (cdr (assoc 'todo l)))))
  9751. (when (member state org-done-keywords)
  9752. (setq changes (append changes (cdr (assoc 'done l)))))
  9753. (dolist (c changes)
  9754. (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
  9755. (defun org-local-logging (value)
  9756. "Get logging settings from a property VALUE."
  9757. (let* (words w a)
  9758. ;; directly set the variables, they are already local.
  9759. (setq org-log-done nil
  9760. org-log-repeat nil
  9761. org-todo-log-states nil)
  9762. (setq words (org-split-string value))
  9763. (while (setq w (pop words))
  9764. (cond
  9765. ((setq a (assoc w org-startup-options))
  9766. (and (member (nth 1 a) '(org-log-done org-log-repeat))
  9767. (set (nth 1 a) (nth 2 a))))
  9768. ((setq a (org-extract-log-state-settings w))
  9769. (and (member (car a) org-todo-keywords-1)
  9770. (push a org-todo-log-states)))))))
  9771. (defun org-get-todo-sequence-head (kwd)
  9772. "Return the head of the TODO sequence to which KWD belongs.
  9773. If KWD is not set, check if there is a text property remembering the
  9774. right sequence."
  9775. (let (p)
  9776. (cond
  9777. ((not kwd)
  9778. (or (get-text-property (point-at-bol) 'org-todo-head)
  9779. (progn
  9780. (setq p (next-single-property-change (point-at-bol) 'org-todo-head
  9781. nil (point-at-eol)))
  9782. (get-text-property p 'org-todo-head))))
  9783. ((not (member kwd org-todo-keywords-1))
  9784. (car org-todo-keywords-1))
  9785. (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
  9786. (defun org-fast-todo-selection ()
  9787. "Fast TODO keyword selection with single keys.
  9788. Returns the new TODO keyword, or nil if no state change should occur."
  9789. (let* ((fulltable org-todo-key-alist)
  9790. (done-keywords org-done-keywords) ;; needed for the faces.
  9791. (maxlen (apply 'max (mapcar
  9792. (lambda (x)
  9793. (if (stringp (car x)) (string-width (car x)) 0))
  9794. fulltable)))
  9795. (expert nil)
  9796. (fwidth (+ maxlen 3 1 3))
  9797. (ncol (/ (- (window-width) 4) fwidth))
  9798. tg cnt e c tbl
  9799. groups ingroup)
  9800. (save-excursion
  9801. (save-window-excursion
  9802. (if expert
  9803. (set-buffer (get-buffer-create " *Org todo*"))
  9804. (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
  9805. (erase-buffer)
  9806. (org-set-local 'org-done-keywords done-keywords)
  9807. (setq tbl fulltable cnt 0)
  9808. (while (setq e (pop tbl))
  9809. (cond
  9810. ((equal e '(:startgroup))
  9811. (push '() groups) (setq ingroup t)
  9812. (when (not (= cnt 0))
  9813. (setq cnt 0)
  9814. (insert "\n"))
  9815. (insert "{ "))
  9816. ((equal e '(:endgroup))
  9817. (setq ingroup nil cnt 0)
  9818. (insert "}\n"))
  9819. ((equal e '(:newline))
  9820. (when (not (= cnt 0))
  9821. (setq cnt 0)
  9822. (insert "\n")
  9823. (setq e (car tbl))
  9824. (while (equal (car tbl) '(:newline))
  9825. (insert "\n")
  9826. (setq tbl (cdr tbl)))))
  9827. (t
  9828. (setq tg (car e) c (cdr e))
  9829. (if ingroup (push tg (car groups)))
  9830. (setq tg (org-add-props tg nil 'face
  9831. (org-get-todo-face tg)))
  9832. (if (and (= cnt 0) (not ingroup)) (insert " "))
  9833. (insert "[" c "] " tg (make-string
  9834. (- fwidth 4 (length tg)) ?\ ))
  9835. (when (= (setq cnt (1+ cnt)) ncol)
  9836. (insert "\n")
  9837. (if ingroup (insert " "))
  9838. (setq cnt 0)))))
  9839. (insert "\n")
  9840. (goto-char (point-min))
  9841. (if (not expert) (org-fit-window-to-buffer))
  9842. (message "[a-z..]:Set [SPC]:clear")
  9843. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  9844. (cond
  9845. ((or (= c ?\C-g)
  9846. (and (= c ?q) (not (rassoc c fulltable))))
  9847. (setq quit-flag t))
  9848. ((= c ?\ ) nil)
  9849. ((setq e (rassoc c fulltable) tg (car e))
  9850. tg)
  9851. (t (setq quit-flag t)))))))
  9852. (defun org-entry-is-todo-p ()
  9853. (member (org-get-todo-state) org-not-done-keywords))
  9854. (defun org-entry-is-done-p ()
  9855. (member (org-get-todo-state) org-done-keywords))
  9856. (defun org-get-todo-state ()
  9857. (save-excursion
  9858. (org-back-to-heading t)
  9859. (and (looking-at org-todo-line-regexp)
  9860. (match-end 2)
  9861. (match-string 2))))
  9862. (defun org-at-date-range-p (&optional inactive-ok)
  9863. "Is the cursor inside a date range?"
  9864. (interactive)
  9865. (save-excursion
  9866. (catch 'exit
  9867. (let ((pos (point)))
  9868. (skip-chars-backward "^[<\r\n")
  9869. (skip-chars-backward "<[")
  9870. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  9871. (>= (match-end 0) pos)
  9872. (throw 'exit t))
  9873. (skip-chars-backward "^<[\r\n")
  9874. (skip-chars-backward "<[")
  9875. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  9876. (>= (match-end 0) pos)
  9877. (throw 'exit t)))
  9878. nil)))
  9879. (defun org-get-repeat (&optional tagline)
  9880. "Check if there is a deadline/schedule with repeater in this entry."
  9881. (save-match-data
  9882. (save-excursion
  9883. (org-back-to-heading t)
  9884. (and (re-search-forward (if tagline
  9885. (concat tagline "\\s-*" org-repeat-re)
  9886. org-repeat-re)
  9887. (org-entry-end-position) t)
  9888. (match-string-no-properties 1)))))
  9889. (defvar org-last-changed-timestamp)
  9890. (defvar org-last-inserted-timestamp)
  9891. (defvar org-log-post-message)
  9892. (defvar org-log-note-purpose)
  9893. (defvar org-log-note-how)
  9894. (defvar org-log-note-extra)
  9895. (defun org-auto-repeat-maybe (done-word)
  9896. "Check if the current headline contains a repeated deadline/schedule.
  9897. If yes, set TODO state back to what it was and change the base date
  9898. of repeating deadline/scheduled time stamps to new date.
  9899. This function is run automatically after each state change to a DONE state."
  9900. ;; last-state is dynamically scoped into this function
  9901. (let* ((repeat (org-get-repeat))
  9902. (aa (assoc last-state org-todo-kwd-alist))
  9903. (interpret (nth 1 aa))
  9904. (head (nth 2 aa))
  9905. (whata '(("d" . day) ("m" . month) ("y" . year)))
  9906. (msg "Entry repeats: ")
  9907. (org-log-done nil)
  9908. (org-todo-log-states nil)
  9909. (nshiftmax 10) (nshift 0)
  9910. re type n what ts time to-state)
  9911. (when repeat
  9912. (if (eq org-log-repeat t) (setq org-log-repeat 'state))
  9913. (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
  9914. org-todo-repeat-to-state))
  9915. (unless (and to-state (member to-state org-todo-keywords-1))
  9916. (setq to-state (if (eq interpret 'type) last-state head)))
  9917. (org-todo to-state)
  9918. (when (or org-log-repeat (org-entry-get nil "CLOCK"))
  9919. (org-entry-put nil "LAST_REPEAT" (format-time-string
  9920. (org-time-stamp-format t t))))
  9921. (when org-log-repeat
  9922. (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
  9923. (memq 'org-add-log-note post-command-hook))
  9924. ;; OK, we are already setup for some record
  9925. (if (eq org-log-repeat 'note)
  9926. ;; make sure we take a note, not only a time stamp
  9927. (setq org-log-note-how 'note))
  9928. ;; Set up for taking a record
  9929. (org-add-log-setup 'state (or done-word (car org-done-keywords))
  9930. last-state
  9931. 'findpos org-log-repeat)))
  9932. (org-back-to-heading t)
  9933. (org-add-planning-info nil nil 'closed)
  9934. (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  9935. org-deadline-time-regexp "\\)\\|\\("
  9936. org-ts-regexp "\\)"))
  9937. (while (re-search-forward
  9938. re (save-excursion (outline-next-heading) (point)) t)
  9939. (setq type (if (match-end 1) org-scheduled-string
  9940. (if (match-end 3) org-deadline-string "Plain:"))
  9941. ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
  9942. (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([dwmy]\\)" ts)
  9943. (setq n (string-to-number (match-string 2 ts))
  9944. what (match-string 3 ts))
  9945. (if (equal what "w") (setq n (* n 7) what "d"))
  9946. ;; Preparation, see if we need to modify the start date for the change
  9947. (when (match-end 1)
  9948. (setq time (save-match-data (org-time-string-to-time ts)))
  9949. (cond
  9950. ((equal (match-string 1 ts) ".")
  9951. ;; Shift starting date to today
  9952. (org-timestamp-change
  9953. (- (time-to-days (current-time)) (time-to-days time))
  9954. 'day))
  9955. ((equal (match-string 1 ts) "+")
  9956. (while (or (= nshift 0)
  9957. (<= (time-to-days time) (time-to-days (current-time))))
  9958. (when (= (incf nshift) nshiftmax)
  9959. (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
  9960. (error "Abort")))
  9961. (org-timestamp-change n (cdr (assoc what whata)))
  9962. (org-at-timestamp-p t)
  9963. (setq ts (match-string 1))
  9964. (setq time (save-match-data (org-time-string-to-time ts))))
  9965. (org-timestamp-change (- n) (cdr (assoc what whata)))
  9966. ;; rematch, so that we have everything in place for the real shift
  9967. (org-at-timestamp-p t)
  9968. (setq ts (match-string 1))
  9969. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([dwmy]\\)" ts))))
  9970. (org-timestamp-change n (cdr (assoc what whata)))
  9971. (setq msg (concat msg type " " org-last-changed-timestamp " "))))
  9972. (setq org-log-post-message msg)
  9973. (message "%s" msg))))
  9974. (defun org-show-todo-tree (arg)
  9975. "Make a compact tree which shows all headlines marked with TODO.
  9976. The tree will show the lines where the regexp matches, and all higher
  9977. headlines above the match.
  9978. With a \\[universal-argument] prefix, prompt for a regexp to match.
  9979. With a numeric prefix N, construct a sparse tree for the Nth element
  9980. of `org-todo-keywords-1'."
  9981. (interactive "P")
  9982. (let ((case-fold-search nil)
  9983. (kwd-re
  9984. (cond ((null arg) org-not-done-regexp)
  9985. ((equal arg '(4))
  9986. (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
  9987. (mapcar 'list org-todo-keywords-1))))
  9988. (concat "\\("
  9989. (mapconcat 'identity (org-split-string kwd "|") "\\|")
  9990. "\\)\\>")))
  9991. ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
  9992. (regexp-quote (nth (1- (prefix-numeric-value arg))
  9993. org-todo-keywords-1)))
  9994. (t (error "Invalid prefix argument: %s" arg)))))
  9995. (message "%d TODO entries found"
  9996. (org-occur (concat "^" outline-regexp " *" kwd-re )))))
  9997. (defun org-deadline (&optional remove time)
  9998. "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
  9999. With argument REMOVE, remove any deadline from the item.
  10000. When TIME is set, it should be an internal time specification, and the
  10001. scheduling will use the corresponding date."
  10002. (interactive "P")
  10003. (let* ((old-date (org-entry-get nil "DEADLINE"))
  10004. (repeater (and old-date
  10005. (string-match "\\([.+]+[0-9]+[dwmy]\\) ?" old-date)
  10006. (match-string 1 old-date))))
  10007. (if remove
  10008. (progn
  10009. (when (and old-date org-log-redeadline)
  10010. (org-add-log-setup 'deldeadline nil old-date 'findpos
  10011. org-log-redeadline))
  10012. (org-remove-timestamp-with-keyword org-deadline-string)
  10013. (message "Item no longer has a deadline."))
  10014. (org-add-planning-info 'deadline time 'closed)
  10015. (when (and old-date org-log-redeadline
  10016. (not (equal old-date
  10017. (substring org-last-inserted-timestamp 1 -1))))
  10018. (org-add-log-setup 'redeadline nil old-date 'findpos
  10019. org-log-redeadline))
  10020. (when repeater
  10021. (save-excursion
  10022. (org-back-to-heading t)
  10023. (when (re-search-forward (concat org-deadline-string " "
  10024. org-last-inserted-timestamp)
  10025. (save-excursion
  10026. (outline-next-heading) (point)) t)
  10027. (goto-char (1- (match-end 0)))
  10028. (insert " " repeater)
  10029. (setq org-last-inserted-timestamp
  10030. (concat (substring org-last-inserted-timestamp 0 -1)
  10031. " " repeater
  10032. (substring org-last-inserted-timestamp -1))))))
  10033. (message "Deadline on %s" org-last-inserted-timestamp))))
  10034. (defun org-schedule (&optional remove time)
  10035. "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
  10036. With argument REMOVE, remove any scheduling date from the item.
  10037. When TIME is set, it should be an internal time specification, and the
  10038. scheduling will use the corresponding date."
  10039. (interactive "P")
  10040. (let* ((old-date (org-entry-get nil "SCHEDULED"))
  10041. (repeater (and old-date
  10042. (string-match "\\([.+]+[0-9]+[dwmy]\\) ?" old-date)
  10043. (match-string 1 old-date))))
  10044. (if remove
  10045. (progn
  10046. (when (and old-date org-log-reschedule)
  10047. (org-add-log-setup 'delschedule nil old-date 'findpos
  10048. org-log-reschedule))
  10049. (org-remove-timestamp-with-keyword org-scheduled-string)
  10050. (message "Item is no longer scheduled."))
  10051. (org-add-planning-info 'scheduled time 'closed)
  10052. (when (and old-date org-log-reschedule
  10053. (not (equal old-date
  10054. (substring org-last-inserted-timestamp 1 -1))))
  10055. (org-add-log-setup 'reschedule nil old-date 'findpos
  10056. org-log-reschedule))
  10057. (when repeater
  10058. (save-excursion
  10059. (org-back-to-heading t)
  10060. (when (re-search-forward (concat org-scheduled-string " "
  10061. org-last-inserted-timestamp)
  10062. (save-excursion
  10063. (outline-next-heading) (point)) t)
  10064. (goto-char (1- (match-end 0)))
  10065. (insert " " repeater)
  10066. (setq org-last-inserted-timestamp
  10067. (concat (substring org-last-inserted-timestamp 0 -1)
  10068. " " repeater
  10069. (substring org-last-inserted-timestamp -1))))))
  10070. (message "Scheduled to %s" org-last-inserted-timestamp))))
  10071. (defun org-get-scheduled-time (pom &optional inherit)
  10072. "Get the scheduled time as a time tuple, of a format suitable
  10073. for calling org-schedule with, or if there is no scheduling,
  10074. returns nil."
  10075. (let ((time (org-entry-get pom "SCHEDULED" inherit)))
  10076. (when time
  10077. (apply 'encode-time (org-parse-time-string time)))))
  10078. (defun org-get-deadline-time (pom &optional inherit)
  10079. "Get the deadine as a time tuple, of a format suitable for
  10080. calling org-deadline with, or if there is no scheduling, returns
  10081. nil."
  10082. (let ((time (org-entry-get pom "DEADLINE" inherit)))
  10083. (when time
  10084. (apply 'encode-time (org-parse-time-string time)))))
  10085. (defun org-remove-timestamp-with-keyword (keyword)
  10086. "Remove all time stamps with KEYWORD in the current entry."
  10087. (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
  10088. beg)
  10089. (save-excursion
  10090. (org-back-to-heading t)
  10091. (setq beg (point))
  10092. (outline-next-heading)
  10093. (while (re-search-backward re beg t)
  10094. (replace-match "")
  10095. (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
  10096. (equal (char-before) ?\ ))
  10097. (backward-delete-char 1)
  10098. (if (string-match "^[ \t]*$" (buffer-substring
  10099. (point-at-bol) (point-at-eol)))
  10100. (delete-region (point-at-bol)
  10101. (min (point-max) (1+ (point-at-eol))))))))))
  10102. (defun org-add-planning-info (what &optional time &rest remove)
  10103. "Insert new timestamp with keyword in the line directly after the headline.
  10104. WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
  10105. If non is given, the user is prompted for a date.
  10106. REMOVE indicates what kind of entries to remove. An old WHAT entry will also
  10107. be removed."
  10108. (interactive)
  10109. (let (org-time-was-given org-end-time-was-given ts
  10110. end default-time default-input)
  10111. (catch 'exit
  10112. (when (and (not time) (memq what '(scheduled deadline)))
  10113. ;; Try to get a default date/time from existing timestamp
  10114. (save-excursion
  10115. (org-back-to-heading t)
  10116. (setq end (save-excursion (outline-next-heading) (point)))
  10117. (when (re-search-forward (if (eq what 'scheduled)
  10118. org-scheduled-time-regexp
  10119. org-deadline-time-regexp)
  10120. end t)
  10121. (setq ts (match-string 1)
  10122. default-time
  10123. (apply 'encode-time (org-parse-time-string ts))
  10124. default-input (and ts (org-get-compact-tod ts))))))
  10125. (when what
  10126. ;; If necessary, get the time from the user
  10127. (setq time (or time (org-read-date nil 'to-time nil nil
  10128. default-time default-input))))
  10129. (when (and org-insert-labeled-timestamps-at-point
  10130. (member what '(scheduled deadline)))
  10131. (insert
  10132. (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
  10133. (org-insert-time-stamp time org-time-was-given
  10134. nil nil nil (list org-end-time-was-given))
  10135. (setq what nil))
  10136. (save-excursion
  10137. (save-restriction
  10138. (let (col list elt ts buffer-invisibility-spec)
  10139. (org-back-to-heading t)
  10140. (looking-at (concat outline-regexp "\\( *\\)[^\r\n]*"))
  10141. (goto-char (match-end 1))
  10142. (setq col (current-column))
  10143. (goto-char (match-end 0))
  10144. (if (eobp) (insert "\n") (forward-char 1))
  10145. (when (and (not what)
  10146. (not (looking-at
  10147. (concat "[ \t]*"
  10148. org-keyword-time-not-clock-regexp))))
  10149. ;; Nothing to add, nothing to remove...... :-)
  10150. (throw 'exit nil))
  10151. (if (and (not (looking-at outline-regexp))
  10152. (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
  10153. "[^\r\n]*"))
  10154. (not (equal (match-string 1) org-clock-string)))
  10155. (narrow-to-region (match-beginning 0) (match-end 0))
  10156. (insert-before-markers "\n")
  10157. (backward-char 1)
  10158. (narrow-to-region (point) (point))
  10159. (and org-adapt-indentation (org-indent-to-column col)))
  10160. ;; Check if we have to remove something.
  10161. (setq list (cons what remove))
  10162. (while list
  10163. (setq elt (pop list))
  10164. (goto-char (point-min))
  10165. (when (or (and (eq elt 'scheduled)
  10166. (re-search-forward org-scheduled-time-regexp nil t))
  10167. (and (eq elt 'deadline)
  10168. (re-search-forward org-deadline-time-regexp nil t))
  10169. (and (eq elt 'closed)
  10170. (re-search-forward org-closed-time-regexp nil t)))
  10171. (replace-match "")
  10172. (if (looking-at "--+<[^>]+>") (replace-match ""))
  10173. (skip-chars-backward " ")
  10174. (if (looking-at " +") (replace-match ""))))
  10175. (goto-char (point-max))
  10176. (and org-adapt-indentation (bolp) (org-indent-to-column col))
  10177. (when what
  10178. (insert
  10179. (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
  10180. (cond ((eq what 'scheduled) org-scheduled-string)
  10181. ((eq what 'deadline) org-deadline-string)
  10182. ((eq what 'closed) org-closed-string))
  10183. " ")
  10184. (setq ts (org-insert-time-stamp
  10185. time
  10186. (or org-time-was-given
  10187. (and (eq what 'closed) org-log-done-with-time))
  10188. (eq what 'closed)
  10189. nil nil (list org-end-time-was-given)))
  10190. (end-of-line 1))
  10191. (goto-char (point-min))
  10192. (widen)
  10193. (if (and (looking-at "[ \t]+\n")
  10194. (equal (char-before) ?\n))
  10195. (delete-region (1- (point)) (point-at-eol)))
  10196. ts))))))
  10197. (defvar org-log-note-marker (make-marker))
  10198. (defvar org-log-note-purpose nil)
  10199. (defvar org-log-note-state nil)
  10200. (defvar org-log-note-previous-state nil)
  10201. (defvar org-log-note-how nil)
  10202. (defvar org-log-note-extra nil)
  10203. (defvar org-log-note-window-configuration nil)
  10204. (defvar org-log-note-return-to (make-marker))
  10205. (defvar org-log-post-message nil
  10206. "Message to be displayed after a log note has been stored.
  10207. The auto-repeater uses this.")
  10208. (defun org-add-note ()
  10209. "Add a note to the current entry.
  10210. This is done in the same way as adding a state change note."
  10211. (interactive)
  10212. (org-add-log-setup 'note nil nil 'findpos nil))
  10213. (defvar org-property-end-re)
  10214. (defun org-add-log-setup (&optional purpose state prev-state
  10215. findpos how &optional extra)
  10216. "Set up the post command hook to take a note.
  10217. If this is about to TODO state change, the new state is expected in STATE.
  10218. When FINDPOS is non-nil, find the correct position for the note in
  10219. the current entry. If not, assume that it can be inserted at point.
  10220. HOW is an indicator what kind of note should be created.
  10221. EXTRA is additional text that will be inserted into the notes buffer."
  10222. (let* ((org-log-into-drawer (org-log-into-drawer))
  10223. (drawer (cond ((stringp org-log-into-drawer)
  10224. org-log-into-drawer)
  10225. (org-log-into-drawer "LOGBOOK")
  10226. (t nil))))
  10227. (save-restriction
  10228. (save-excursion
  10229. (when findpos
  10230. (org-back-to-heading t)
  10231. (narrow-to-region (point) (save-excursion
  10232. (outline-next-heading) (point)))
  10233. (looking-at (concat outline-regexp "\\( *\\)[^\r\n]*"
  10234. "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
  10235. "[^\r\n]*\\)?"))
  10236. (goto-char (match-end 0))
  10237. (cond
  10238. (drawer
  10239. (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
  10240. nil t)
  10241. (progn
  10242. (goto-char (match-end 0))
  10243. (or org-log-states-order-reversed
  10244. (and (re-search-forward org-property-end-re nil t)
  10245. (goto-char (1- (match-beginning 0))))))
  10246. (insert "\n:" drawer ":\n:END:")
  10247. (beginning-of-line 0)
  10248. (org-indent-line-function)
  10249. (beginning-of-line 2)
  10250. (org-indent-line-function)
  10251. (end-of-line 0)))
  10252. ((and org-log-state-notes-insert-after-drawers
  10253. (save-excursion
  10254. (forward-line) (looking-at org-drawer-regexp)))
  10255. (forward-line)
  10256. (while (looking-at org-drawer-regexp)
  10257. (goto-char (match-end 0))
  10258. (re-search-forward org-property-end-re (point-max) t)
  10259. (forward-line))
  10260. (forward-line -1)))
  10261. (unless org-log-states-order-reversed
  10262. (and (= (char-after) ?\n) (forward-char 1))
  10263. (org-skip-over-state-notes)
  10264. (skip-chars-backward " \t\n\r")))
  10265. (move-marker org-log-note-marker (point))
  10266. (setq org-log-note-purpose purpose
  10267. org-log-note-state state
  10268. org-log-note-previous-state prev-state
  10269. org-log-note-how how
  10270. org-log-note-extra extra)
  10271. (add-hook 'post-command-hook 'org-add-log-note 'append)))))
  10272. (defun org-skip-over-state-notes ()
  10273. "Skip past the list of State notes in an entry."
  10274. (if (looking-at "\n[ \t]*- State") (forward-char 1))
  10275. (while (looking-at "[ \t]*- State")
  10276. (condition-case nil
  10277. (org-next-item)
  10278. (error (org-end-of-item)))))
  10279. (defun org-add-log-note (&optional purpose)
  10280. "Pop up a window for taking a note, and add this note later at point."
  10281. (remove-hook 'post-command-hook 'org-add-log-note)
  10282. (setq org-log-note-window-configuration (current-window-configuration))
  10283. (delete-other-windows)
  10284. (move-marker org-log-note-return-to (point))
  10285. (switch-to-buffer (marker-buffer org-log-note-marker))
  10286. (goto-char org-log-note-marker)
  10287. (org-switch-to-buffer-other-window "*Org Note*")
  10288. (erase-buffer)
  10289. (if (memq org-log-note-how '(time state))
  10290. (let (current-prefix-arg) (org-store-log-note))
  10291. (let ((org-inhibit-startup t)) (org-mode))
  10292. (insert (format "# Insert note for %s.
  10293. # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
  10294. (cond
  10295. ((eq org-log-note-purpose 'clock-out) "stopped clock")
  10296. ((eq org-log-note-purpose 'done) "closed todo item")
  10297. ((eq org-log-note-purpose 'state)
  10298. (format "state change from \"%s\" to \"%s\""
  10299. (or org-log-note-previous-state "")
  10300. (or org-log-note-state "")))
  10301. ((eq org-log-note-purpose 'reschedule)
  10302. "rescheduling")
  10303. ((eq org-log-note-purpose 'delschedule)
  10304. "no longer scheduled")
  10305. ((eq org-log-note-purpose 'redeadline)
  10306. "changing deadline")
  10307. ((eq org-log-note-purpose 'deldeadline)
  10308. "removing deadline")
  10309. ((eq org-log-note-purpose 'refile)
  10310. "refiling")
  10311. ((eq org-log-note-purpose 'note)
  10312. "this entry")
  10313. (t (error "This should not happen")))))
  10314. (if org-log-note-extra (insert org-log-note-extra))
  10315. (org-set-local 'org-finish-function 'org-store-log-note)))
  10316. (defvar org-note-abort nil) ; dynamically scoped
  10317. (defun org-store-log-note ()
  10318. "Finish taking a log note, and insert it to where it belongs."
  10319. (let ((txt (buffer-string))
  10320. (note (cdr (assq org-log-note-purpose org-log-note-headings)))
  10321. lines ind)
  10322. (kill-buffer (current-buffer))
  10323. (while (string-match "\\`#.*\n[ \t\n]*" txt)
  10324. (setq txt (replace-match "" t t txt)))
  10325. (if (string-match "\\s-+\\'" txt)
  10326. (setq txt (replace-match "" t t txt)))
  10327. (setq lines (org-split-string txt "\n"))
  10328. (when (and note (string-match "\\S-" note))
  10329. (setq note
  10330. (org-replace-escapes
  10331. note
  10332. (list (cons "%u" (user-login-name))
  10333. (cons "%U" user-full-name)
  10334. (cons "%t" (format-time-string
  10335. (org-time-stamp-format 'long 'inactive)
  10336. (current-time)))
  10337. (cons "%s" (if org-log-note-state
  10338. (concat "\"" org-log-note-state "\"")
  10339. ""))
  10340. (cons "%S" (if org-log-note-previous-state
  10341. (concat "\"" org-log-note-previous-state "\"")
  10342. "\"\"")))))
  10343. (if lines (setq note (concat note " \\\\")))
  10344. (push note lines))
  10345. (when (or current-prefix-arg org-note-abort)
  10346. (when org-log-into-drawer
  10347. (org-remove-empty-drawer-at
  10348. (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
  10349. org-log-note-marker))
  10350. (setq lines nil))
  10351. (when lines
  10352. (with-current-buffer (marker-buffer org-log-note-marker)
  10353. (save-excursion
  10354. (goto-char org-log-note-marker)
  10355. (move-marker org-log-note-marker nil)
  10356. (end-of-line 1)
  10357. (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
  10358. (insert "- " (pop lines))
  10359. (org-indent-line-function)
  10360. (beginning-of-line 1)
  10361. (looking-at "[ \t]*")
  10362. (setq ind (concat (match-string 0) " "))
  10363. (end-of-line 1)
  10364. (while lines (insert "\n" ind (pop lines)))
  10365. (message "Note stored")
  10366. (org-back-to-heading t)
  10367. (org-cycle-hide-drawers 'children)))))
  10368. (set-window-configuration org-log-note-window-configuration)
  10369. (with-current-buffer (marker-buffer org-log-note-return-to)
  10370. (goto-char org-log-note-return-to))
  10371. (move-marker org-log-note-return-to nil)
  10372. (and org-log-post-message (message "%s" org-log-post-message)))
  10373. (defun org-remove-empty-drawer-at (drawer pos)
  10374. "Remove an empty drawer DRAWER at position POS.
  10375. POS may also be a marker."
  10376. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  10377. (save-excursion
  10378. (save-restriction
  10379. (widen)
  10380. (goto-char pos)
  10381. (if (org-in-regexp
  10382. (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
  10383. (replace-match ""))))))
  10384. (defun org-sparse-tree (&optional arg)
  10385. "Create a sparse tree, prompt for the details.
  10386. This command can create sparse trees. You first need to select the type
  10387. of match used to create the tree:
  10388. t Show all TODO entries.
  10389. T Show entries with a specific TODO keyword.
  10390. m Show entries selected by a tags/property match.
  10391. p Enter a property name and its value (both with completion on existing
  10392. names/values) and show entries with that property.
  10393. / Show entries matching a regular expression (`r' can be used as well)
  10394. d Show deadlines due within `org-deadline-warning-days'.
  10395. b Show deadlines and scheduled items before a date.
  10396. a Show deadlines and scheduled items after a date."
  10397. (interactive "P")
  10398. (let (ans kwd value)
  10399. (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty [d]eadlines\n [b]efore-date [a]fter-date")
  10400. (setq ans (read-char-exclusive))
  10401. (cond
  10402. ((equal ans ?d)
  10403. (call-interactively 'org-check-deadlines))
  10404. ((equal ans ?b)
  10405. (call-interactively 'org-check-before-date))
  10406. ((equal ans ?a)
  10407. (call-interactively 'org-check-after-date))
  10408. ((equal ans ?t)
  10409. (org-show-todo-tree nil))
  10410. ((equal ans ?T)
  10411. (org-show-todo-tree '(4)))
  10412. ((member ans '(?T ?m))
  10413. (call-interactively 'org-match-sparse-tree))
  10414. ((member ans '(?p ?P))
  10415. (setq kwd (org-icompleting-read "Property: "
  10416. (mapcar 'list (org-buffer-property-keys))))
  10417. (setq value (org-icompleting-read "Value: "
  10418. (mapcar 'list (org-property-values kwd))))
  10419. (unless (string-match "\\`{.*}\\'" value)
  10420. (setq value (concat "\"" value "\"")))
  10421. (org-match-sparse-tree arg (concat kwd "=" value)))
  10422. ((member ans '(?r ?R ?/))
  10423. (call-interactively 'org-occur))
  10424. (t (error "No such sparse tree command \"%c\"" ans)))))
  10425. (defvar org-occur-highlights nil
  10426. "List of overlays used for occur matches.")
  10427. (make-variable-buffer-local 'org-occur-highlights)
  10428. (defvar org-occur-parameters nil
  10429. "Parameters of the active org-occur calls.
  10430. This is a list, each call to org-occur pushes as cons cell,
  10431. containing the regular expression and the callback, onto the list.
  10432. The list can contain several entries if `org-occur' has been called
  10433. several time with the KEEP-PREVIOUS argument. Otherwise, this list
  10434. will only contain one set of parameters. When the highlights are
  10435. removed (for example with `C-c C-c', or with the next edit (depending
  10436. on `org-remove-highlights-with-change'), this variable is emptied
  10437. as well.")
  10438. (make-variable-buffer-local 'org-occur-parameters)
  10439. (defun org-occur (regexp &optional keep-previous callback)
  10440. "Make a compact tree which shows all matches of REGEXP.
  10441. The tree will show the lines where the regexp matches, and all higher
  10442. headlines above the match. It will also show the heading after the match,
  10443. to make sure editing the matching entry is easy.
  10444. If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
  10445. call to `org-occur' will be kept, to allow stacking of calls to this
  10446. command.
  10447. If CALLBACK is non-nil, it is a function which is called to confirm
  10448. that the match should indeed be shown."
  10449. (interactive "sRegexp: \nP")
  10450. (when (equal regexp "")
  10451. (error "Regexp cannot be empty"))
  10452. (unless keep-previous
  10453. (org-remove-occur-highlights nil nil t))
  10454. (push (cons regexp callback) org-occur-parameters)
  10455. (let ((cnt 0))
  10456. (save-excursion
  10457. (goto-char (point-min))
  10458. (if (or (not keep-previous) ; do not want to keep
  10459. (not org-occur-highlights)) ; no previous matches
  10460. ;; hide everything
  10461. (org-overview))
  10462. (while (re-search-forward regexp nil t)
  10463. (when (or (not callback)
  10464. (save-match-data (funcall callback)))
  10465. (setq cnt (1+ cnt))
  10466. (when org-highlight-sparse-tree-matches
  10467. (org-highlight-new-match (match-beginning 0) (match-end 0)))
  10468. (org-show-context 'occur-tree))))
  10469. (when org-remove-highlights-with-change
  10470. (org-add-hook 'before-change-functions 'org-remove-occur-highlights
  10471. nil 'local))
  10472. (unless org-sparse-tree-open-archived-trees
  10473. (org-hide-archived-subtrees (point-min) (point-max)))
  10474. (run-hooks 'org-occur-hook)
  10475. (if (interactive-p)
  10476. (message "%d match(es) for regexp %s" cnt regexp))
  10477. cnt))
  10478. (defun org-show-context (&optional key)
  10479. "Make sure point and context and visible.
  10480. How much context is shown depends upon the variables
  10481. `org-show-hierarchy-above', `org-show-following-heading'. and
  10482. `org-show-siblings'."
  10483. (let ((heading-p (org-on-heading-p t))
  10484. (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
  10485. (following-p (org-get-alist-option org-show-following-heading key))
  10486. (entry-p (org-get-alist-option org-show-entry-below key))
  10487. (siblings-p (org-get-alist-option org-show-siblings key)))
  10488. (catch 'exit
  10489. ;; Show heading or entry text
  10490. (if (and heading-p (not entry-p))
  10491. (org-flag-heading nil) ; only show the heading
  10492. (and (or entry-p (org-invisible-p) (org-invisible-p2))
  10493. (org-show-hidden-entry))) ; show entire entry
  10494. (when following-p
  10495. ;; Show next sibling, or heading below text
  10496. (save-excursion
  10497. (and (if heading-p (org-goto-sibling) (outline-next-heading))
  10498. (org-flag-heading nil))))
  10499. (when siblings-p (org-show-siblings))
  10500. (when hierarchy-p
  10501. ;; show all higher headings, possibly with siblings
  10502. (save-excursion
  10503. (while (and (condition-case nil
  10504. (progn (org-up-heading-all 1) t)
  10505. (error nil))
  10506. (not (bobp)))
  10507. (org-flag-heading nil)
  10508. (when siblings-p (org-show-siblings))))))))
  10509. (defvar org-reveal-start-hook nil
  10510. "Hook run before revealing a location.")
  10511. (defun org-reveal (&optional siblings)
  10512. "Show current entry, hierarchy above it, and the following headline.
  10513. This can be used to show a consistent set of context around locations
  10514. exposed with `org-show-hierarchy-above' or `org-show-following-heading'
  10515. not t for the search context.
  10516. With optional argument SIBLINGS, on each level of the hierarchy all
  10517. siblings are shown. This repairs the tree structure to what it would
  10518. look like when opened with hierarchical calls to `org-cycle'.
  10519. With double optional argument `C-u C-u', go to the parent and show the
  10520. entire tree."
  10521. (interactive "P")
  10522. (run-hooks 'org-reveal-start-hook)
  10523. (let ((org-show-hierarchy-above t)
  10524. (org-show-following-heading t)
  10525. (org-show-siblings (if siblings t org-show-siblings)))
  10526. (org-show-context nil))
  10527. (when (equal siblings '(16))
  10528. (save-excursion
  10529. (when (org-up-heading-safe)
  10530. (org-show-subtree)
  10531. (run-hook-with-args 'org-cycle-hook 'subtree)))))
  10532. (defun org-highlight-new-match (beg end)
  10533. "Highlight from BEG to END and mark the highlight is an occur headline."
  10534. (let ((ov (make-overlay beg end)))
  10535. (overlay-put ov 'face 'secondary-selection)
  10536. (push ov org-occur-highlights)))
  10537. (defun org-remove-occur-highlights (&optional beg end noremove)
  10538. "Remove the occur highlights from the buffer.
  10539. BEG and END are ignored. If NOREMOVE is nil, remove this function
  10540. from the `before-change-functions' in the current buffer."
  10541. (interactive)
  10542. (unless org-inhibit-highlight-removal
  10543. (mapc 'delete-overlay org-occur-highlights)
  10544. (setq org-occur-highlights nil)
  10545. (setq org-occur-parameters nil)
  10546. (unless noremove
  10547. (remove-hook 'before-change-functions
  10548. 'org-remove-occur-highlights 'local))))
  10549. ;;;; Priorities
  10550. (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
  10551. "Regular expression matching the priority indicator.")
  10552. (defvar org-remove-priority-next-time nil)
  10553. (defun org-priority-up ()
  10554. "Increase the priority of the current item."
  10555. (interactive)
  10556. (org-priority 'up))
  10557. (defun org-priority-down ()
  10558. "Decrease the priority of the current item."
  10559. (interactive)
  10560. (org-priority 'down))
  10561. (defun org-priority (&optional action)
  10562. "Change the priority of an item by ARG.
  10563. ACTION can be `set', `up', `down', or a character."
  10564. (interactive)
  10565. (unless org-enable-priority-commands
  10566. (error "Priority commands are disabled"))
  10567. (setq action (or action 'set))
  10568. (let (current new news have remove)
  10569. (save-excursion
  10570. (org-back-to-heading t)
  10571. (if (looking-at org-priority-regexp)
  10572. (setq current (string-to-char (match-string 2))
  10573. have t)
  10574. (setq current org-default-priority))
  10575. (cond
  10576. ((eq action 'remove)
  10577. (setq remove t new ?\ ))
  10578. ((or (eq action 'set)
  10579. (if (featurep 'xemacs) (characterp action) (integerp action)))
  10580. (if (not (eq action 'set))
  10581. (setq new action)
  10582. (message "Priority %c-%c, SPC to remove: "
  10583. org-highest-priority org-lowest-priority)
  10584. (setq new (read-char-exclusive)))
  10585. (if (and (= (upcase org-highest-priority) org-highest-priority)
  10586. (= (upcase org-lowest-priority) org-lowest-priority))
  10587. (setq new (upcase new)))
  10588. (cond ((equal new ?\ ) (setq remove t))
  10589. ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
  10590. (error "Priority must be between `%c' and `%c'"
  10591. org-highest-priority org-lowest-priority))))
  10592. ((eq action 'up)
  10593. (if (and (not have) (eq last-command this-command))
  10594. (setq new org-lowest-priority)
  10595. (setq new (if (and org-priority-start-cycle-with-default (not have))
  10596. org-default-priority (1- current)))))
  10597. ((eq action 'down)
  10598. (if (and (not have) (eq last-command this-command))
  10599. (setq new org-highest-priority)
  10600. (setq new (if (and org-priority-start-cycle-with-default (not have))
  10601. org-default-priority (1+ current)))))
  10602. (t (error "Invalid action")))
  10603. (if (or (< (upcase new) org-highest-priority)
  10604. (> (upcase new) org-lowest-priority))
  10605. (setq remove t))
  10606. (setq news (format "%c" new))
  10607. (if have
  10608. (if remove
  10609. (replace-match "" t t nil 1)
  10610. (replace-match news t t nil 2))
  10611. (if remove
  10612. (error "No priority cookie found in line")
  10613. (let ((case-fold-search nil))
  10614. (looking-at org-todo-line-regexp))
  10615. (if (match-end 2)
  10616. (progn
  10617. (goto-char (match-end 2))
  10618. (insert " [#" news "]"))
  10619. (goto-char (match-beginning 3))
  10620. (insert "[#" news "] "))))
  10621. (org-preserve-lc (org-set-tags nil 'align)))
  10622. (if remove
  10623. (message "Priority removed")
  10624. (message "Priority of current item set to %s" news))))
  10625. (defun org-get-priority (s)
  10626. "Find priority cookie and return priority."
  10627. (save-match-data
  10628. (if (not (string-match org-priority-regexp s))
  10629. (* 1000 (- org-lowest-priority org-default-priority))
  10630. (* 1000 (- org-lowest-priority
  10631. (string-to-char (match-string 2 s)))))))
  10632. ;;;; Tags
  10633. (defvar org-agenda-archives-mode)
  10634. (defvar org-map-continue-from nil
  10635. "Position from where mapping should continue.
  10636. Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
  10637. (defvar org-scanner-tags nil
  10638. "The current tag list while the tags scanner is running.")
  10639. (defvar org-trust-scanner-tags nil
  10640. "Should `org-get-tags-at' use the tags fro the scanner.
  10641. This is for internal dynamical scoping only.
  10642. When this is non-nil, the function `org-get-tags-at' will return the value
  10643. of `org-scanner-tags' instead of building the list by itself. This
  10644. can lead to large speed-ups when the tags scanner is used in a file with
  10645. many entries, and when the list of tags is retrieved, for example to
  10646. obtain a list of properties. Building the tags list for each entry in such
  10647. a file becomes an N^2 operation - but with this variable set, it scales
  10648. as N.")
  10649. (defun org-scan-tags (action matcher &optional todo-only)
  10650. "Scan headline tags with inheritance and produce output ACTION.
  10651. ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
  10652. or `agenda' to produce an entry list for an agenda view. It can also be
  10653. a Lisp form or a function that should be called at each matched headline, in
  10654. this case the return value is a list of all return values from these calls.
  10655. MATCHER is a Lisp form to be evaluated, testing if a given set of tags
  10656. qualifies a headline for inclusion. When TODO-ONLY is non-nil,
  10657. only lines with a TODO keyword are included in the output."
  10658. (require 'org-agenda)
  10659. (let* ((re (concat "^" outline-regexp " *\\(\\<\\("
  10660. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  10661. (org-re
  10662. "\\>\\)\\)? *\\(.*?\\)\\(:[[:alnum:]_@:]+:\\)?[ \t]*$")))
  10663. (props (list 'face 'default
  10664. 'done-face 'org-agenda-done
  10665. 'undone-face 'default
  10666. 'mouse-face 'highlight
  10667. 'org-not-done-regexp org-not-done-regexp
  10668. 'org-todo-regexp org-todo-regexp
  10669. 'help-echo
  10670. (format "mouse-2 or RET jump to org file %s"
  10671. (abbreviate-file-name
  10672. (or (buffer-file-name (buffer-base-buffer))
  10673. (buffer-name (buffer-base-buffer)))))))
  10674. (case-fold-search nil)
  10675. (org-map-continue-from nil)
  10676. lspos tags tags-list
  10677. (tags-alist (list (cons 0 org-file-tags)))
  10678. (llast 0) rtn rtn1 level category i txt
  10679. todo marker entry priority)
  10680. (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
  10681. (setq action (list 'lambda nil action)))
  10682. (save-excursion
  10683. (goto-char (point-min))
  10684. (when (eq action 'sparse-tree)
  10685. (org-overview)
  10686. (org-remove-occur-highlights))
  10687. (while (re-search-forward re nil t)
  10688. (catch :skip
  10689. (setq todo (if (match-end 1) (org-match-string-no-properties 2))
  10690. tags (if (match-end 4) (org-match-string-no-properties 4)))
  10691. (goto-char (setq lspos (match-beginning 0)))
  10692. (setq level (org-reduced-level (funcall outline-level))
  10693. category (org-get-category))
  10694. (setq i llast llast level)
  10695. ;; remove tag lists from same and sublevels
  10696. (while (>= i level)
  10697. (when (setq entry (assoc i tags-alist))
  10698. (setq tags-alist (delete entry tags-alist)))
  10699. (setq i (1- i)))
  10700. ;; add the next tags
  10701. (when tags
  10702. (setq tags (org-split-string tags ":")
  10703. tags-alist
  10704. (cons (cons level tags) tags-alist)))
  10705. ;; compile tags for current headline
  10706. (setq tags-list
  10707. (if org-use-tag-inheritance
  10708. (apply 'append (mapcar 'cdr (reverse tags-alist)))
  10709. tags)
  10710. org-scanner-tags tags-list)
  10711. (when org-use-tag-inheritance
  10712. (setcdr (car tags-alist)
  10713. (mapcar (lambda (x)
  10714. (setq x (copy-sequence x))
  10715. (org-add-prop-inherited x))
  10716. (cdar tags-alist))))
  10717. (when (and tags org-use-tag-inheritance
  10718. (or (not (eq t org-use-tag-inheritance))
  10719. org-tags-exclude-from-inheritance))
  10720. ;; selective inheritance, remove uninherited ones
  10721. (setcdr (car tags-alist)
  10722. (org-remove-uniherited-tags (cdar tags-alist))))
  10723. (when (and (or (not todo-only)
  10724. (and (member todo org-not-done-keywords)
  10725. (or (not org-agenda-tags-todo-honor-ignore-options)
  10726. (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
  10727. (let ((case-fold-search t)) (eval matcher))
  10728. (or
  10729. (not (member org-archive-tag tags-list))
  10730. ;; we have an archive tag, should we use this anyway?
  10731. (or (not org-agenda-skip-archived-trees)
  10732. (and (eq action 'agenda) org-agenda-archives-mode))))
  10733. (unless (eq action 'sparse-tree) (org-agenda-skip))
  10734. ;; select this headline
  10735. (cond
  10736. ((eq action 'sparse-tree)
  10737. (and org-highlight-sparse-tree-matches
  10738. (org-get-heading) (match-end 0)
  10739. (org-highlight-new-match
  10740. (match-beginning 0) (match-beginning 1)))
  10741. (org-show-context 'tags-tree))
  10742. ((eq action 'agenda)
  10743. (setq txt (org-format-agenda-item
  10744. ""
  10745. (concat
  10746. (if (eq org-tags-match-list-sublevels 'indented)
  10747. (make-string (1- level) ?.) "")
  10748. (org-get-heading))
  10749. category
  10750. tags-list
  10751. )
  10752. priority (org-get-priority txt))
  10753. (goto-char lspos)
  10754. (setq marker (org-agenda-new-marker))
  10755. (org-add-props txt props
  10756. 'org-marker marker 'org-hd-marker marker 'org-category category
  10757. 'todo-state todo
  10758. 'priority priority 'type "tagsmatch")
  10759. (push txt rtn))
  10760. ((functionp action)
  10761. (setq org-map-continue-from nil)
  10762. (save-excursion
  10763. (setq rtn1 (funcall action))
  10764. (push rtn1 rtn)))
  10765. (t (error "Invalid action")))
  10766. ;; if we are to skip sublevels, jump to end of subtree
  10767. (unless org-tags-match-list-sublevels
  10768. (org-end-of-subtree t)
  10769. (backward-char 1))))
  10770. ;; Get the correct position from where to continue
  10771. (if org-map-continue-from
  10772. (goto-char org-map-continue-from)
  10773. (and (= (point) lspos) (end-of-line 1)))))
  10774. (when (and (eq action 'sparse-tree)
  10775. (not org-sparse-tree-open-archived-trees))
  10776. (org-hide-archived-subtrees (point-min) (point-max)))
  10777. (nreverse rtn)))
  10778. (defun org-remove-uniherited-tags (tags)
  10779. "Remove all tags that are not inherited from the list TAGS."
  10780. (cond
  10781. ((eq org-use-tag-inheritance t)
  10782. (if org-tags-exclude-from-inheritance
  10783. (org-delete-all org-tags-exclude-from-inheritance tags)
  10784. tags))
  10785. ((not org-use-tag-inheritance) nil)
  10786. ((stringp org-use-tag-inheritance)
  10787. (delq nil (mapcar
  10788. (lambda (x)
  10789. (if (and (string-match org-use-tag-inheritance x)
  10790. (not (member x org-tags-exclude-from-inheritance)))
  10791. x nil))
  10792. tags)))
  10793. ((listp org-use-tag-inheritance)
  10794. (delq nil (mapcar
  10795. (lambda (x)
  10796. (if (member x org-use-tag-inheritance) x nil))
  10797. tags)))))
  10798. (defvar todo-only) ;; dynamically scoped
  10799. (defun org-match-sparse-tree (&optional todo-only match)
  10800. "Create a sparse tree according to tags string MATCH.
  10801. MATCH can contain positive and negative selection of tags, like
  10802. \"+WORK+URGENT-WITHBOSS\".
  10803. If optional argument TODO-ONLY is non-nil, only select lines that are
  10804. also TODO lines."
  10805. (interactive "P")
  10806. (org-prepare-agenda-buffers (list (current-buffer)))
  10807. (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
  10808. (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
  10809. (defvar org-cached-props nil)
  10810. (defun org-cached-entry-get (pom property)
  10811. (if (or (eq t org-use-property-inheritance)
  10812. (and (stringp org-use-property-inheritance)
  10813. (string-match org-use-property-inheritance property))
  10814. (and (listp org-use-property-inheritance)
  10815. (member property org-use-property-inheritance)))
  10816. ;; Caching is not possible, check it directly
  10817. (org-entry-get pom property 'inherit)
  10818. ;; Get all properties, so that we can do complicated checks easily
  10819. (cdr (assoc property (or org-cached-props
  10820. (setq org-cached-props
  10821. (org-entry-properties pom)))))))
  10822. (defun org-global-tags-completion-table (&optional files)
  10823. "Return the list of all tags in all agenda buffer/files."
  10824. (save-excursion
  10825. (org-uniquify
  10826. (delq nil
  10827. (apply 'append
  10828. (mapcar
  10829. (lambda (file)
  10830. (set-buffer (find-file-noselect file))
  10831. (append (org-get-buffer-tags)
  10832. (mapcar (lambda (x) (if (stringp (car-safe x))
  10833. (list (car-safe x)) nil))
  10834. org-tag-alist)))
  10835. (if (and files (car files))
  10836. files
  10837. (org-agenda-files))))))))
  10838. (defun org-make-tags-matcher (match)
  10839. "Create the TAGS//TODO matcher form for the selection string MATCH."
  10840. ;; todo-only is scoped dynamically into this function, and the function
  10841. ;; may change it if the matcher asks for it.
  10842. (unless match
  10843. ;; Get a new match request, with completion
  10844. (let ((org-last-tags-completion-table
  10845. (org-global-tags-completion-table)))
  10846. (setq match (org-completing-read-no-i
  10847. "Match: " 'org-tags-completion-function nil nil nil
  10848. 'org-tags-history))))
  10849. ;; Parse the string and create a lisp form
  10850. (let ((match0 match)
  10851. (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@]+\\)"))
  10852. minus tag mm
  10853. tagsmatch todomatch tagsmatcher todomatcher kwd matcher
  10854. orterms term orlist re-p str-p level-p level-op time-p
  10855. prop-p pn pv po cat-p gv rest)
  10856. (if (string-match "/+" match)
  10857. ;; match contains also a todo-matching request
  10858. (progn
  10859. (setq tagsmatch (substring match 0 (match-beginning 0))
  10860. todomatch (substring match (match-end 0)))
  10861. (if (string-match "^!" todomatch)
  10862. (setq todo-only t todomatch (substring todomatch 1)))
  10863. (if (string-match "^\\s-*$" todomatch)
  10864. (setq todomatch nil)))
  10865. ;; only matching tags
  10866. (setq tagsmatch match todomatch nil))
  10867. ;; Make the tags matcher
  10868. (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
  10869. (setq tagsmatcher t)
  10870. (setq orterms (org-split-string tagsmatch "|") orlist nil)
  10871. (while (setq term (pop orterms))
  10872. (while (and (equal (substring term -1) "\\") orterms)
  10873. (setq term (concat term "|" (pop orterms)))) ; repair bad split
  10874. (while (string-match re term)
  10875. (setq rest (substring term (match-end 0))
  10876. minus (and (match-end 1)
  10877. (equal (match-string 1 term) "-"))
  10878. tag (match-string 2 term)
  10879. re-p (equal (string-to-char tag) ?{)
  10880. level-p (match-end 4)
  10881. prop-p (match-end 5)
  10882. mm (cond
  10883. (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
  10884. (level-p
  10885. (setq level-op (org-op-to-function (match-string 3 term)))
  10886. `(,level-op level ,(string-to-number
  10887. (match-string 4 term))))
  10888. (prop-p
  10889. (setq pn (match-string 5 term)
  10890. po (match-string 6 term)
  10891. pv (match-string 7 term)
  10892. cat-p (equal pn "CATEGORY")
  10893. re-p (equal (string-to-char pv) ?{)
  10894. str-p (equal (string-to-char pv) ?\")
  10895. time-p (save-match-data
  10896. (string-match "^\"[[<].*[]>]\"$" pv))
  10897. pv (if (or re-p str-p) (substring pv 1 -1) pv))
  10898. (if time-p (setq pv (org-matcher-time pv)))
  10899. (setq po (org-op-to-function po (if time-p 'time str-p)))
  10900. (cond
  10901. ((equal pn "CATEGORY")
  10902. (setq gv '(get-text-property (point) 'org-category)))
  10903. ((equal pn "TODO")
  10904. (setq gv 'todo))
  10905. (t
  10906. (setq gv `(org-cached-entry-get nil ,pn))))
  10907. (if re-p
  10908. (if (eq po 'org<>)
  10909. `(not (string-match ,pv (or ,gv "")))
  10910. `(string-match ,pv (or ,gv "")))
  10911. (if str-p
  10912. `(,po (or ,gv "") ,pv)
  10913. `(,po (string-to-number (or ,gv ""))
  10914. ,(string-to-number pv) ))))
  10915. (t `(member ,tag tags-list)))
  10916. mm (if minus (list 'not mm) mm)
  10917. term rest)
  10918. (push mm tagsmatcher))
  10919. (push (if (> (length tagsmatcher) 1)
  10920. (cons 'and tagsmatcher)
  10921. (car tagsmatcher))
  10922. orlist)
  10923. (setq tagsmatcher nil))
  10924. (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
  10925. (setq tagsmatcher
  10926. (list 'progn '(setq org-cached-props nil) tagsmatcher)))
  10927. ;; Make the todo matcher
  10928. (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
  10929. (setq todomatcher t)
  10930. (setq orterms (org-split-string todomatch "|") orlist nil)
  10931. (while (setq term (pop orterms))
  10932. (while (string-match re term)
  10933. (setq minus (and (match-end 1)
  10934. (equal (match-string 1 term) "-"))
  10935. kwd (match-string 2 term)
  10936. re-p (equal (string-to-char kwd) ?{)
  10937. term (substring term (match-end 0))
  10938. mm (if re-p
  10939. `(string-match ,(substring kwd 1 -1) todo)
  10940. (list 'equal 'todo kwd))
  10941. mm (if minus (list 'not mm) mm))
  10942. (push mm todomatcher))
  10943. (push (if (> (length todomatcher) 1)
  10944. (cons 'and todomatcher)
  10945. (car todomatcher))
  10946. orlist)
  10947. (setq todomatcher nil))
  10948. (setq todomatcher (if (> (length orlist) 1)
  10949. (cons 'or orlist) (car orlist))))
  10950. ;; Return the string and lisp forms of the matcher
  10951. (setq matcher (if todomatcher
  10952. (list 'and tagsmatcher todomatcher)
  10953. tagsmatcher))
  10954. (cons match0 matcher)))
  10955. (defun org-op-to-function (op &optional stringp)
  10956. "Turn an operator into the appropriate function."
  10957. (setq op
  10958. (cond
  10959. ((equal op "<" ) '(< string< org-time<))
  10960. ((equal op ">" ) '(> org-string> org-time>))
  10961. ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
  10962. ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
  10963. ((member op '("=" "==")) '(= string= org-time=))
  10964. ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
  10965. (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
  10966. (defun org<> (a b) (not (= a b)))
  10967. (defun org-string<= (a b) (or (string= a b) (string< a b)))
  10968. (defun org-string>= (a b) (not (string< a b)))
  10969. (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
  10970. (defun org-string<> (a b) (not (string= a b)))
  10971. (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
  10972. (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
  10973. (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
  10974. (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
  10975. (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
  10976. (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
  10977. (defun org-2ft (s)
  10978. "Convert S to a floating point time.
  10979. If S is already a number, just return it. If it is a string, parse
  10980. it as a time string and apply `float-time' to it. If S is nil, just return 0."
  10981. (cond
  10982. ((numberp s) s)
  10983. ((stringp s)
  10984. (condition-case nil
  10985. (float-time (apply 'encode-time (org-parse-time-string s)))
  10986. (error 0.)))
  10987. (t 0.)))
  10988. (defun org-time-today ()
  10989. "Time in seconds today at 0:00.
  10990. Returns the float number of seconds since the beginning of the
  10991. epoch to the beginning of today (00:00)."
  10992. (float-time (apply 'encode-time
  10993. (append '(0 0 0) (nthcdr 3 (decode-time))))))
  10994. (defun org-matcher-time (s)
  10995. "Interpret a time comparison value."
  10996. (save-match-data
  10997. (cond
  10998. ((string= s "<now>") (float-time))
  10999. ((string= s "<today>") (org-time-today))
  11000. ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
  11001. ((string= s "<yesterday>") (- (org-time-today) 86400.0))
  11002. ((string-match "^<\\([-+][0-9]+\\)\\([dwmy]\\)>$" s)
  11003. (+ (org-time-today)
  11004. (* (string-to-number (match-string 1 s))
  11005. (cdr (assoc (match-string 2 s)
  11006. '(("d" . 86400.0) ("w" . 604800.0)
  11007. ("m" . 2678400.0) ("y" . 31557600.0)))))))
  11008. (t (org-2ft s)))))
  11009. (defun org-match-any-p (re list)
  11010. "Does re match any element of list?"
  11011. (setq list (mapcar (lambda (x) (string-match re x)) list))
  11012. (delq nil list))
  11013. (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
  11014. (defvar org-tags-overlay (make-overlay 1 1))
  11015. (org-detach-overlay org-tags-overlay)
  11016. (defun org-get-local-tags-at (&optional pos)
  11017. "Get a list of tags defined in the current headline."
  11018. (org-get-tags-at pos 'local))
  11019. (defun org-get-local-tags ()
  11020. "Get a list of tags defined in the current headline."
  11021. (org-get-tags-at nil 'local))
  11022. (defun org-get-tags-at (&optional pos local)
  11023. "Get a list of all headline tags applicable at POS.
  11024. POS defaults to point. If tags are inherited, the list contains
  11025. the targets in the same sequence as the headlines appear, i.e.
  11026. the tags of the current headline come last.
  11027. When LOCAL is non-nil, only return tags from the current headline,
  11028. ignore inherited ones."
  11029. (interactive)
  11030. (if (and org-trust-scanner-tags
  11031. (or (not pos) (equal pos (point)))
  11032. (not local))
  11033. org-scanner-tags
  11034. (let (tags ltags lastpos parent)
  11035. (save-excursion
  11036. (save-restriction
  11037. (widen)
  11038. (goto-char (or pos (point)))
  11039. (save-match-data
  11040. (catch 'done
  11041. (condition-case nil
  11042. (progn
  11043. (org-back-to-heading t)
  11044. (while (not (equal lastpos (point)))
  11045. (setq lastpos (point))
  11046. (when (looking-at
  11047. (org-re "[^\r\n]+?:\\([[:alnum:]_@:]+\\):[ \t]*$"))
  11048. (setq ltags (org-split-string
  11049. (org-match-string-no-properties 1) ":"))
  11050. (when parent
  11051. (setq ltags (mapcar 'org-add-prop-inherited ltags)))
  11052. (setq tags (append
  11053. (if parent
  11054. (org-remove-uniherited-tags ltags)
  11055. ltags)
  11056. tags)))
  11057. (or org-use-tag-inheritance (throw 'done t))
  11058. (if local (throw 'done t))
  11059. (or (org-up-heading-safe) (error nil))
  11060. (setq parent t)))
  11061. (error nil)))))
  11062. (append (org-remove-uniherited-tags org-file-tags) tags)))))
  11063. (defun org-add-prop-inherited (s)
  11064. (add-text-properties 0 (length s) '(inherited t) s)
  11065. s)
  11066. (defun org-toggle-tag (tag &optional onoff)
  11067. "Toggle the tag TAG for the current line.
  11068. If ONOFF is `on' or `off', don't toggle but set to this state."
  11069. (let (res current)
  11070. (save-excursion
  11071. (org-back-to-heading t)
  11072. (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@:]+\\):[ \t]*$")
  11073. (point-at-eol) t)
  11074. (progn
  11075. (setq current (match-string 1))
  11076. (replace-match ""))
  11077. (setq current ""))
  11078. (setq current (nreverse (org-split-string current ":")))
  11079. (cond
  11080. ((eq onoff 'on)
  11081. (setq res t)
  11082. (or (member tag current) (push tag current)))
  11083. ((eq onoff 'off)
  11084. (or (not (member tag current)) (setq current (delete tag current))))
  11085. (t (if (member tag current)
  11086. (setq current (delete tag current))
  11087. (setq res t)
  11088. (push tag current))))
  11089. (end-of-line 1)
  11090. (if current
  11091. (progn
  11092. (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
  11093. (org-set-tags nil t))
  11094. (delete-horizontal-space))
  11095. (run-hooks 'org-after-tags-change-hook))
  11096. res))
  11097. (defun org-align-tags-here (to-col)
  11098. ;; Assumes that this is a headline
  11099. (let ((pos (point)) (col (current-column)) ncol tags-l p)
  11100. (beginning-of-line 1)
  11101. (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
  11102. (< pos (match-beginning 2)))
  11103. (progn
  11104. (setq tags-l (- (match-end 2) (match-beginning 2)))
  11105. (goto-char (match-beginning 1))
  11106. (insert " ")
  11107. (delete-region (point) (1+ (match-beginning 2)))
  11108. (setq ncol (max (1+ (current-column))
  11109. (1+ col)
  11110. (if (> to-col 0)
  11111. to-col
  11112. (- (abs to-col) tags-l))))
  11113. (setq p (point))
  11114. (insert (make-string (- ncol (current-column)) ?\ ))
  11115. (setq ncol (current-column))
  11116. (when indent-tabs-mode (tabify p (point-at-eol)))
  11117. (org-move-to-column (min ncol col) t))
  11118. (goto-char pos))))
  11119. (defun org-set-tags-command (&optional arg just-align)
  11120. "Call the set-tags command for the current entry."
  11121. (interactive "P")
  11122. (if (org-on-heading-p)
  11123. (org-set-tags arg just-align)
  11124. (save-excursion
  11125. (org-back-to-heading t)
  11126. (org-set-tags arg just-align))))
  11127. (defun org-set-tags-to (data)
  11128. "Set the tags of the current entry to DATA, replacing the current tags.
  11129. DATA may be a tags string like :aa:bb:cc:, or a list of tags.
  11130. If DATA is nil or the empty string, any tags will be removed."
  11131. (interactive "sTags: ")
  11132. (setq data
  11133. (cond
  11134. ((eq data nil) "")
  11135. ((equal data "") "")
  11136. ((stringp data)
  11137. (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
  11138. ":"))
  11139. ((listp data)
  11140. (concat ":" (mapconcat 'identity data ":") ":"))
  11141. (t nil)))
  11142. (when data
  11143. (save-excursion
  11144. (org-back-to-heading t)
  11145. (when (looking-at org-complex-heading-regexp)
  11146. (if (match-end 5)
  11147. (progn
  11148. (goto-char (match-beginning 5))
  11149. (insert data)
  11150. (delete-region (point) (point-at-eol))
  11151. (org-set-tags nil 'align))
  11152. (goto-char (point-at-eol))
  11153. (insert " " data)
  11154. (org-set-tags nil 'align)))
  11155. (beginning-of-line 1)
  11156. (if (looking-at ".*?\\([ \t]+\\)$")
  11157. (delete-region (match-beginning 1) (match-end 1))))))
  11158. (defun org-align-all-tags ()
  11159. "Align the tags i all headings."
  11160. (interactive)
  11161. (save-excursion
  11162. (or (ignore-errors (org-back-to-heading t))
  11163. (outline-next-heading))
  11164. (if (org-on-heading-p)
  11165. (org-set-tags t)
  11166. (message "No headings"))))
  11167. (defun org-set-tags (&optional arg just-align)
  11168. "Set the tags for the current headline.
  11169. With prefix ARG, realign all tags in headings in the current buffer."
  11170. (interactive "P")
  11171. (let* ((re (concat "^" outline-regexp))
  11172. (current (org-get-tags-string))
  11173. (col (current-column))
  11174. (org-setting-tags t)
  11175. table current-tags inherited-tags ; computed below when needed
  11176. tags p0 c0 c1 rpl)
  11177. (if arg
  11178. (save-excursion
  11179. (goto-char (point-min))
  11180. (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
  11181. (while (re-search-forward re nil t)
  11182. (org-set-tags nil t)
  11183. (end-of-line 1)))
  11184. (message "All tags realigned to column %d" org-tags-column))
  11185. (if just-align
  11186. (setq tags current)
  11187. ;; Get a new set of tags from the user
  11188. (save-excursion
  11189. (setq table (append org-tag-persistent-alist
  11190. (or org-tag-alist (org-get-buffer-tags))
  11191. (and org-complete-tags-always-offer-all-agenda-tags
  11192. (org-global-tags-completion-table (org-agenda-files))))
  11193. org-last-tags-completion-table table
  11194. current-tags (org-split-string current ":")
  11195. inherited-tags (nreverse
  11196. (nthcdr (length current-tags)
  11197. (nreverse (org-get-tags-at))))
  11198. tags
  11199. (if (or (eq t org-use-fast-tag-selection)
  11200. (and org-use-fast-tag-selection
  11201. (delq nil (mapcar 'cdr table))))
  11202. (org-fast-tag-selection
  11203. current-tags inherited-tags table
  11204. (if org-fast-tag-selection-include-todo org-todo-key-alist))
  11205. (let ((org-add-colon-after-tag-completion t))
  11206. (org-trim
  11207. (org-without-partial-completion
  11208. (org-icompleting-read "Tags: " 'org-tags-completion-function
  11209. nil nil current 'org-tags-history)))))))
  11210. (while (string-match "[-+&]+" tags)
  11211. ;; No boolean logic, just a list
  11212. (setq tags (replace-match ":" t t tags))))
  11213. (if org-tags-sort-function
  11214. (setq tags (mapconcat 'identity
  11215. (sort (org-split-string tags (org-re "[^[:alnum:]_@]+"))
  11216. org-tags-sort-function) ":")))
  11217. (if (string-match "\\`[\t ]*\\'" tags)
  11218. (setq tags "")
  11219. (unless (string-match ":$" tags) (setq tags (concat tags ":")))
  11220. (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
  11221. ;; Insert new tags at the correct column
  11222. (beginning-of-line 1)
  11223. (cond
  11224. ((and (equal current "") (equal tags "")))
  11225. ((re-search-forward
  11226. (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
  11227. (point-at-eol) t)
  11228. (if (equal tags "")
  11229. (setq rpl "")
  11230. (goto-char (match-beginning 0))
  11231. (setq c0 (current-column) p0 (if (equal (char-before) ?*)
  11232. (1+ (point)) (point))
  11233. c1 (max (1+ c0) (if (> org-tags-column 0)
  11234. org-tags-column
  11235. (- (- org-tags-column) (length tags))))
  11236. rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
  11237. (replace-match rpl t t)
  11238. (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
  11239. tags)
  11240. (t (error "Tags alignment failed")))
  11241. (org-move-to-column col)
  11242. (unless just-align
  11243. (run-hooks 'org-after-tags-change-hook)))))
  11244. (defun org-change-tag-in-region (beg end tag off)
  11245. "Add or remove TAG for each entry in the region.
  11246. This works in the agenda, and also in an org-mode buffer."
  11247. (interactive
  11248. (list (region-beginning) (region-end)
  11249. (let ((org-last-tags-completion-table
  11250. (if (org-mode-p)
  11251. (org-get-buffer-tags)
  11252. (org-global-tags-completion-table))))
  11253. (org-icompleting-read
  11254. "Tag: " 'org-tags-completion-function nil nil nil
  11255. 'org-tags-history))
  11256. (progn
  11257. (message "[s]et or [r]emove? ")
  11258. (equal (read-char-exclusive) ?r))))
  11259. (if (fboundp 'deactivate-mark) (deactivate-mark))
  11260. (let ((agendap (equal major-mode 'org-agenda-mode))
  11261. l1 l2 m buf pos newhead (cnt 0))
  11262. (goto-char end)
  11263. (setq l2 (1- (org-current-line)))
  11264. (goto-char beg)
  11265. (setq l1 (org-current-line))
  11266. (loop for l from l1 to l2 do
  11267. (org-goto-line l)
  11268. (setq m (get-text-property (point) 'org-hd-marker))
  11269. (when (or (and (org-mode-p) (org-on-heading-p))
  11270. (and agendap m))
  11271. (setq buf (if agendap (marker-buffer m) (current-buffer))
  11272. pos (if agendap m (point)))
  11273. (with-current-buffer buf
  11274. (save-excursion
  11275. (save-restriction
  11276. (goto-char pos)
  11277. (setq cnt (1+ cnt))
  11278. (org-toggle-tag tag (if off 'off 'on))
  11279. (setq newhead (org-get-heading)))))
  11280. (and agendap (org-agenda-change-all-lines newhead m))))
  11281. (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
  11282. (defun org-tags-completion-function (string predicate &optional flag)
  11283. (let (s1 s2 rtn (ctable org-last-tags-completion-table)
  11284. (confirm (lambda (x) (stringp (car x)))))
  11285. (if (string-match "^\\(.*[-+:&|]\\)\\([^-+:&|]*\\)$" string)
  11286. (setq s1 (match-string 1 string)
  11287. s2 (match-string 2 string))
  11288. (setq s1 "" s2 string))
  11289. (cond
  11290. ((eq flag nil)
  11291. ;; try completion
  11292. (setq rtn (try-completion s2 ctable confirm))
  11293. (if (stringp rtn)
  11294. (setq rtn
  11295. (concat s1 s2 (substring rtn (length s2))
  11296. (if (and org-add-colon-after-tag-completion
  11297. (assoc rtn ctable))
  11298. ":" ""))))
  11299. rtn)
  11300. ((eq flag t)
  11301. ;; all-completions
  11302. (all-completions s2 ctable confirm)
  11303. )
  11304. ((eq flag 'lambda)
  11305. ;; exact match?
  11306. (assoc s2 ctable)))
  11307. ))
  11308. (defun org-fast-tag-insert (kwd tags face &optional end)
  11309. "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
  11310. (insert (format "%-12s" (concat kwd ":"))
  11311. (org-add-props (mapconcat 'identity tags " ") nil 'face face)
  11312. (or end "")))
  11313. (defun org-fast-tag-show-exit (flag)
  11314. (save-excursion
  11315. (org-goto-line 3)
  11316. (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
  11317. (replace-match ""))
  11318. (when flag
  11319. (end-of-line 1)
  11320. (org-move-to-column (- (window-width) 19) t)
  11321. (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
  11322. (defun org-set-current-tags-overlay (current prefix)
  11323. (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
  11324. (if (featurep 'xemacs)
  11325. (org-overlay-display org-tags-overlay (concat prefix s)
  11326. 'secondary-selection)
  11327. (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
  11328. (org-overlay-display org-tags-overlay (concat prefix s)))))
  11329. (defvar org-last-tag-selection-key nil)
  11330. (defun org-fast-tag-selection (current inherited table &optional todo-table)
  11331. "Fast tag selection with single keys.
  11332. CURRENT is the current list of tags in the headline, INHERITED is the
  11333. list of inherited tags, and TABLE is an alist of tags and corresponding keys,
  11334. possibly with grouping information. TODO-TABLE is a similar table with
  11335. TODO keywords, should these have keys assigned to them.
  11336. If the keys are nil, a-z are automatically assigned.
  11337. Returns the new tags string, or nil to not change the current settings."
  11338. (let* ((fulltable (append table todo-table))
  11339. (maxlen (apply 'max (mapcar
  11340. (lambda (x)
  11341. (if (stringp (car x)) (string-width (car x)) 0))
  11342. fulltable)))
  11343. (buf (current-buffer))
  11344. (expert (eq org-fast-tag-selection-single-key 'expert))
  11345. (buffer-tags nil)
  11346. (fwidth (+ maxlen 3 1 3))
  11347. (ncol (/ (- (window-width) 4) fwidth))
  11348. (i-face 'org-done)
  11349. (c-face 'org-todo)
  11350. tg cnt e c char c1 c2 ntable tbl rtn
  11351. ov-start ov-end ov-prefix
  11352. (exit-after-next org-fast-tag-selection-single-key)
  11353. (done-keywords org-done-keywords)
  11354. groups ingroup)
  11355. (save-excursion
  11356. (beginning-of-line 1)
  11357. (if (looking-at
  11358. (org-re ".*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
  11359. (setq ov-start (match-beginning 1)
  11360. ov-end (match-end 1)
  11361. ov-prefix "")
  11362. (setq ov-start (1- (point-at-eol))
  11363. ov-end (1+ ov-start))
  11364. (skip-chars-forward "^\n\r")
  11365. (setq ov-prefix
  11366. (concat
  11367. (buffer-substring (1- (point)) (point))
  11368. (if (> (current-column) org-tags-column)
  11369. " "
  11370. (make-string (- org-tags-column (current-column)) ?\ ))))))
  11371. (move-overlay org-tags-overlay ov-start ov-end)
  11372. (save-window-excursion
  11373. (if expert
  11374. (set-buffer (get-buffer-create " *Org tags*"))
  11375. (delete-other-windows)
  11376. (split-window-vertically)
  11377. (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
  11378. (erase-buffer)
  11379. (org-set-local 'org-done-keywords done-keywords)
  11380. (org-fast-tag-insert "Inherited" inherited i-face "\n")
  11381. (org-fast-tag-insert "Current" current c-face "\n\n")
  11382. (org-fast-tag-show-exit exit-after-next)
  11383. (org-set-current-tags-overlay current ov-prefix)
  11384. (setq tbl fulltable char ?a cnt 0)
  11385. (while (setq e (pop tbl))
  11386. (cond
  11387. ((equal (car e) :startgroup)
  11388. (push '() groups) (setq ingroup t)
  11389. (when (not (= cnt 0))
  11390. (setq cnt 0)
  11391. (insert "\n"))
  11392. (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
  11393. ((equal (car e) :endgroup)
  11394. (setq ingroup nil cnt 0)
  11395. (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
  11396. ((equal e '(:newline))
  11397. (when (not (= cnt 0))
  11398. (setq cnt 0)
  11399. (insert "\n")
  11400. (setq e (car tbl))
  11401. (while (equal (car tbl) '(:newline))
  11402. (insert "\n")
  11403. (setq tbl (cdr tbl)))))
  11404. (t
  11405. (setq tg (copy-sequence (car e)) c2 nil)
  11406. (if (cdr e)
  11407. (setq c (cdr e))
  11408. ;; automatically assign a character.
  11409. (setq c1 (string-to-char
  11410. (downcase (substring
  11411. tg (if (= (string-to-char tg) ?@) 1 0)))))
  11412. (if (or (rassoc c1 ntable) (rassoc c1 table))
  11413. (while (or (rassoc char ntable) (rassoc char table))
  11414. (setq char (1+ char)))
  11415. (setq c2 c1))
  11416. (setq c (or c2 char)))
  11417. (if ingroup (push tg (car groups)))
  11418. (setq tg (org-add-props tg nil 'face
  11419. (cond
  11420. ((not (assoc tg table))
  11421. (org-get-todo-face tg))
  11422. ((member tg current) c-face)
  11423. ((member tg inherited) i-face)
  11424. (t nil))))
  11425. (if (and (= cnt 0) (not ingroup)) (insert " "))
  11426. (insert "[" c "] " tg (make-string
  11427. (- fwidth 4 (length tg)) ?\ ))
  11428. (push (cons tg c) ntable)
  11429. (when (= (setq cnt (1+ cnt)) ncol)
  11430. (insert "\n")
  11431. (if ingroup (insert " "))
  11432. (setq cnt 0)))))
  11433. (setq ntable (nreverse ntable))
  11434. (insert "\n")
  11435. (goto-char (point-min))
  11436. (if (not expert) (org-fit-window-to-buffer))
  11437. (setq rtn
  11438. (catch 'exit
  11439. (while t
  11440. (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
  11441. (if (not groups) "no " "")
  11442. (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
  11443. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  11444. (setq org-last-tag-selection-key c)
  11445. (cond
  11446. ((= c ?\r) (throw 'exit t))
  11447. ((= c ?!)
  11448. (setq groups (not groups))
  11449. (goto-char (point-min))
  11450. (while (re-search-forward "[{}]" nil t) (replace-match " ")))
  11451. ((= c ?\C-c)
  11452. (if (not expert)
  11453. (org-fast-tag-show-exit
  11454. (setq exit-after-next (not exit-after-next)))
  11455. (setq expert nil)
  11456. (delete-other-windows)
  11457. (split-window-vertically)
  11458. (org-switch-to-buffer-other-window " *Org tags*")
  11459. (org-fit-window-to-buffer)))
  11460. ((or (= c ?\C-g)
  11461. (and (= c ?q) (not (rassoc c ntable))))
  11462. (org-detach-overlay org-tags-overlay)
  11463. (setq quit-flag t))
  11464. ((= c ?\ )
  11465. (setq current nil)
  11466. (if exit-after-next (setq exit-after-next 'now)))
  11467. ((= c ?\t)
  11468. (condition-case nil
  11469. (setq tg (org-icompleting-read
  11470. "Tag: "
  11471. (or buffer-tags
  11472. (with-current-buffer buf
  11473. (org-get-buffer-tags)))))
  11474. (quit (setq tg "")))
  11475. (when (string-match "\\S-" tg)
  11476. (add-to-list 'buffer-tags (list tg))
  11477. (if (member tg current)
  11478. (setq current (delete tg current))
  11479. (push tg current)))
  11480. (if exit-after-next (setq exit-after-next 'now)))
  11481. ((setq e (rassoc c todo-table) tg (car e))
  11482. (with-current-buffer buf
  11483. (save-excursion (org-todo tg)))
  11484. (if exit-after-next (setq exit-after-next 'now)))
  11485. ((setq e (rassoc c ntable) tg (car e))
  11486. (if (member tg current)
  11487. (setq current (delete tg current))
  11488. (loop for g in groups do
  11489. (if (member tg g)
  11490. (mapc (lambda (x)
  11491. (setq current (delete x current)))
  11492. g)))
  11493. (push tg current))
  11494. (if exit-after-next (setq exit-after-next 'now))))
  11495. ;; Create a sorted list
  11496. (setq current
  11497. (sort current
  11498. (lambda (a b)
  11499. (assoc b (cdr (memq (assoc a ntable) ntable))))))
  11500. (if (eq exit-after-next 'now) (throw 'exit t))
  11501. (goto-char (point-min))
  11502. (beginning-of-line 2)
  11503. (delete-region (point) (point-at-eol))
  11504. (org-fast-tag-insert "Current" current c-face)
  11505. (org-set-current-tags-overlay current ov-prefix)
  11506. (while (re-search-forward
  11507. (org-re "\\[.\\] \\([[:alnum:]_@]+\\)") nil t)
  11508. (setq tg (match-string 1))
  11509. (add-text-properties
  11510. (match-beginning 1) (match-end 1)
  11511. (list 'face
  11512. (cond
  11513. ((member tg current) c-face)
  11514. ((member tg inherited) i-face)
  11515. (t (get-text-property (match-beginning 1) 'face))))))
  11516. (goto-char (point-min)))))
  11517. (org-detach-overlay org-tags-overlay)
  11518. (if rtn
  11519. (mapconcat 'identity current ":")
  11520. nil))))
  11521. (defun org-get-tags-string ()
  11522. "Get the TAGS string in the current headline."
  11523. (unless (org-on-heading-p t)
  11524. (error "Not on a heading"))
  11525. (save-excursion
  11526. (beginning-of-line 1)
  11527. (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
  11528. (org-match-string-no-properties 1)
  11529. "")))
  11530. (defun org-get-tags ()
  11531. "Get the list of tags specified in the current headline."
  11532. (org-split-string (org-get-tags-string) ":"))
  11533. (defun org-get-buffer-tags ()
  11534. "Get a table of all tags used in the buffer, for completion."
  11535. (let (tags)
  11536. (save-excursion
  11537. (goto-char (point-min))
  11538. (while (re-search-forward
  11539. (org-re "[ \t]:\\([[:alnum:]_@:]+\\):[ \t\r\n]") nil t)
  11540. (when (equal (char-after (point-at-bol 0)) ?*)
  11541. (mapc (lambda (x) (add-to-list 'tags x))
  11542. (org-split-string (org-match-string-no-properties 1) ":")))))
  11543. (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
  11544. (mapcar 'list tags)))
  11545. ;;;; The mapping API
  11546. ;;;###autoload
  11547. (defun org-map-entries (func &optional match scope &rest skip)
  11548. "Call FUNC at each headline selected by MATCH in SCOPE.
  11549. FUNC is a function or a lisp form. The function will be called without
  11550. arguments, with the cursor positioned at the beginning of the headline.
  11551. The return values of all calls to the function will be collected and
  11552. returned as a list.
  11553. The call to FUNC will be wrapped into a save-excursion form, so FUNC
  11554. does not need to preserve point. After evaluation, the cursor will be
  11555. moved to the end of the line (presumably of the headline of the
  11556. processed entry) and search continues from there. Under some
  11557. circumstances, this may not produce the wanted results. For example,
  11558. if you have removed (e.g. archived) the current (sub)tree it could
  11559. mean that the next entry will be skipped entirely. In such cases, you
  11560. can specify the position from where search should continue by making
  11561. FUNC set the variable `org-map-continue-from' to the desired buffer
  11562. position.
  11563. MATCH is a tags/property/todo match as it is used in the agenda tags view.
  11564. Only headlines that are matched by this query will be considered during
  11565. the iteration. When MATCH is nil or t, all headlines will be
  11566. visited by the iteration.
  11567. SCOPE determines the scope of this command. It can be any of:
  11568. nil The current buffer, respecting the restriction if any
  11569. tree The subtree started with the entry at point
  11570. file The current buffer, without restriction
  11571. file-with-archives
  11572. The current buffer, and any archives associated with it
  11573. agenda All agenda files
  11574. agenda-with-archives
  11575. All agenda files with any archive files associated with them
  11576. \(file1 file2 ...)
  11577. If this is a list, all files in the list will be scanned
  11578. The remaining args are treated as settings for the skipping facilities of
  11579. the scanner. The following items can be given here:
  11580. archive skip trees with the archive tag.
  11581. comment skip trees with the COMMENT keyword
  11582. function or Emacs Lisp form:
  11583. will be used as value for `org-agenda-skip-function', so whenever
  11584. the function returns t, FUNC will not be called for that
  11585. entry and search will continue from the point where the
  11586. function leaves it.
  11587. If your function needs to retrieve the tags including inherited tags
  11588. at the *current* entry, you can use the value of the variable
  11589. `org-scanner-tags' which will be much faster than getting the value
  11590. with `org-get-tags-at'. If your function gets properties with
  11591. `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
  11592. to t around the call to `org-entry-properties' to get the same speedup.
  11593. Note that if your function moves around to retrieve tags and properties at
  11594. a *different* entry, you cannot use these techniques."
  11595. (let* ((org-agenda-archives-mode nil) ; just to make sure
  11596. (org-agenda-skip-archived-trees (memq 'archive skip))
  11597. (org-agenda-skip-comment-trees (memq 'comment skip))
  11598. (org-agenda-skip-function
  11599. (car (org-delete-all '(comment archive) skip)))
  11600. (org-tags-match-list-sublevels t)
  11601. matcher file res
  11602. org-todo-keywords-for-agenda
  11603. org-done-keywords-for-agenda
  11604. org-todo-keyword-alist-for-agenda
  11605. org-drawers-for-agenda
  11606. org-tag-alist-for-agenda)
  11607. (cond
  11608. ((eq match t) (setq matcher t))
  11609. ((eq match nil) (setq matcher t))
  11610. (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
  11611. (save-excursion
  11612. (save-restriction
  11613. (when (eq scope 'tree)
  11614. (org-back-to-heading t)
  11615. (org-narrow-to-subtree)
  11616. (setq scope nil))
  11617. (if (not scope)
  11618. (progn
  11619. (org-prepare-agenda-buffers
  11620. (list (buffer-file-name (current-buffer))))
  11621. (setq res (org-scan-tags func matcher)))
  11622. ;; Get the right scope
  11623. (cond
  11624. ((and scope (listp scope) (symbolp (car scope)))
  11625. (setq scope (eval scope)))
  11626. ((eq scope 'agenda)
  11627. (setq scope (org-agenda-files t)))
  11628. ((eq scope 'agenda-with-archives)
  11629. (setq scope (org-agenda-files t))
  11630. (setq scope (org-add-archive-files scope)))
  11631. ((eq scope 'file)
  11632. (setq scope (list (buffer-file-name))))
  11633. ((eq scope 'file-with-archives)
  11634. (setq scope (org-add-archive-files (list (buffer-file-name))))))
  11635. (org-prepare-agenda-buffers scope)
  11636. (while (setq file (pop scope))
  11637. (with-current-buffer (org-find-base-buffer-visiting file)
  11638. (save-excursion
  11639. (save-restriction
  11640. (widen)
  11641. (goto-char (point-min))
  11642. (setq res (append res (org-scan-tags func matcher))))))))))
  11643. res))
  11644. ;;;; Properties
  11645. ;;; Setting and retrieving properties
  11646. (defconst org-special-properties
  11647. '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
  11648. "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED")
  11649. "The special properties valid in Org-mode.
  11650. These are properties that are not defined in the property drawer,
  11651. but in some other way.")
  11652. (defconst org-default-properties
  11653. '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
  11654. "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
  11655. "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
  11656. "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
  11657. "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
  11658. "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
  11659. "Some properties that are used by Org-mode for various purposes.
  11660. Being in this list makes sure that they are offered for completion.")
  11661. (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
  11662. "Regular expression matching the first line of a property drawer.")
  11663. (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
  11664. "Regular expression matching the last line of a property drawer.")
  11665. (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
  11666. "Regular expression matching the first line of a property drawer.")
  11667. (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
  11668. "Regular expression matching the first line of a property drawer.")
  11669. (defconst org-property-drawer-re
  11670. (concat "\\(" org-property-start-re "\\)[^\000]*\\("
  11671. org-property-end-re "\\)\n?")
  11672. "Matches an entire property drawer.")
  11673. (defconst org-clock-drawer-re
  11674. (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
  11675. org-property-end-re "\\)\n?")
  11676. "Matches an entire clock drawer.")
  11677. (defun org-property-action ()
  11678. "Do an action on properties."
  11679. (interactive)
  11680. (let (c)
  11681. (org-at-property-p)
  11682. (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
  11683. (setq c (read-char-exclusive))
  11684. (cond
  11685. ((equal c ?s)
  11686. (call-interactively 'org-set-property))
  11687. ((equal c ?d)
  11688. (call-interactively 'org-delete-property))
  11689. ((equal c ?D)
  11690. (call-interactively 'org-delete-property-globally))
  11691. ((equal c ?c)
  11692. (call-interactively 'org-compute-property-at-point))
  11693. (t (error "No such property action %c" c)))))
  11694. (defun org-set-effort (&optional value)
  11695. "Set the effort property of the current entry.
  11696. With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
  11697. allowed value."
  11698. (interactive "P")
  11699. (if (equal value 0) (setq value 10))
  11700. (let* ((completion-ignore-case t)
  11701. (prop org-effort-property)
  11702. (cur (org-entry-get nil prop))
  11703. (allowed (org-property-get-allowed-values nil prop 'table))
  11704. (existing (mapcar 'list (org-property-values prop)))
  11705. rpl
  11706. (val (cond
  11707. ((stringp value) value)
  11708. ((and allowed (integerp value))
  11709. (or (car (nth (1- value) allowed))
  11710. (car (org-last allowed))))
  11711. (allowed
  11712. (message "Select 1-9,0, [RET%s]: %s"
  11713. (if cur (concat "=" cur) "")
  11714. (mapconcat 'car allowed " "))
  11715. (setq rpl (read-char-exclusive))
  11716. (if (equal rpl ?\r)
  11717. cur
  11718. (setq rpl (- rpl ?0))
  11719. (if (equal rpl 0) (setq rpl 10))
  11720. (if (and (> rpl 0) (<= rpl (length allowed)))
  11721. (car (nth (1- rpl) allowed))
  11722. (org-completing-read "Effort: " allowed nil))))
  11723. (t
  11724. (let (org-completion-use-ido org-completion-use-iswitchb)
  11725. (org-completing-read
  11726. (concat "Effort " (if (and cur (string-match "\\S-" cur))
  11727. (concat "[" cur "]") "")
  11728. ": ")
  11729. existing nil nil "" nil cur))))))
  11730. (unless (equal (org-entry-get nil prop) val)
  11731. (org-entry-put nil prop val))
  11732. (message "%s is now %s" prop val)))
  11733. (defun org-at-property-p ()
  11734. "Is cursor inside a property drawer?"
  11735. (save-excursion
  11736. (beginning-of-line 1)
  11737. (when (looking-at (org-re "^[ \t]*\\(:\\([[:alpha:]][[:alnum:]_-]*\\):\\)[ \t]*\\(.*\\)"))
  11738. (let ((match (match-data)) ;; Keep match-data for use by calling
  11739. (p (point)) ;; procedures.
  11740. (range (unless (org-before-first-heading-p)
  11741. (org-get-property-block))))
  11742. (prog1 (and range (<= (car range) p) (< p (cdr range)))
  11743. (set-match-data match))))))
  11744. (defun org-get-property-block (&optional beg end force)
  11745. "Return the (beg . end) range of the body of the property drawer.
  11746. BEG and END can be beginning and end of subtree, if not given
  11747. they will be found.
  11748. If the drawer does not exist and FORCE is non-nil, create the drawer."
  11749. (catch 'exit
  11750. (save-excursion
  11751. (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
  11752. (end (or end (progn (outline-next-heading) (point)))))
  11753. (goto-char beg)
  11754. (if (re-search-forward org-property-start-re end t)
  11755. (setq beg (1+ (match-end 0)))
  11756. (if force
  11757. (save-excursion
  11758. (org-insert-property-drawer)
  11759. (setq end (progn (outline-next-heading) (point))))
  11760. (throw 'exit nil))
  11761. (goto-char beg)
  11762. (if (re-search-forward org-property-start-re end t)
  11763. (setq beg (1+ (match-end 0)))))
  11764. (if (re-search-forward org-property-end-re end t)
  11765. (setq end (match-beginning 0))
  11766. (or force (throw 'exit nil))
  11767. (goto-char beg)
  11768. (setq end beg)
  11769. (org-indent-line-function)
  11770. (insert ":END:\n"))
  11771. (cons beg end)))))
  11772. (defun org-entry-properties (&optional pom which specific)
  11773. "Get all properties of the entry at point-or-marker POM.
  11774. This includes the TODO keyword, the tags, time strings for deadline,
  11775. scheduled, and clocking, and any additional properties defined in the
  11776. entry. The return value is an alist, keys may occur multiple times
  11777. if the property key was used several times.
  11778. POM may also be nil, in which case the current entry is used.
  11779. If WHICH is nil or `all', get all properties. If WHICH is
  11780. `special' or `standard', only get that subclass. If WHICH
  11781. is a string only get exactly this property. Specific can be a string, the
  11782. specific property we are interested in. Specifying it can speed
  11783. things up because then unnecessary parsing is avoided."
  11784. (setq which (or which 'all))
  11785. (org-with-point-at pom
  11786. (let ((clockstr (substring org-clock-string 0 -1))
  11787. (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
  11788. (case-fold-search nil)
  11789. beg end range props sum-props key value string clocksum)
  11790. (save-excursion
  11791. (when (condition-case nil
  11792. (and (org-mode-p) (org-back-to-heading t))
  11793. (error nil))
  11794. (setq beg (point))
  11795. (setq sum-props (get-text-property (point) 'org-summaries))
  11796. (setq clocksum (get-text-property (point) :org-clock-minutes))
  11797. (outline-next-heading)
  11798. (setq end (point))
  11799. (when (memq which '(all special))
  11800. ;; Get the special properties, like TODO and tags
  11801. (goto-char beg)
  11802. (when (and (or (not specific) (string= specific "TODO"))
  11803. (looking-at org-todo-line-regexp) (match-end 2))
  11804. (push (cons "TODO" (org-match-string-no-properties 2)) props))
  11805. (when (and (or (not specific) (string= specific "PRIORITY"))
  11806. (looking-at org-priority-regexp))
  11807. (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
  11808. (when (and (or (not specific) (string= specific "TAGS"))
  11809. (setq value (org-get-tags-string))
  11810. (string-match "\\S-" value))
  11811. (push (cons "TAGS" value) props))
  11812. (when (and (or (not specific) (string= specific "ALLTAGS"))
  11813. (setq value (org-get-tags-at)))
  11814. (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
  11815. ":"))
  11816. props))
  11817. (when (or (not specific) (string= specific "BLOCKED"))
  11818. (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
  11819. (when (or (not specific)
  11820. (member specific org-all-time-keywords)
  11821. (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
  11822. (while (re-search-forward org-maybe-keyword-time-regexp end t)
  11823. (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
  11824. string (if (equal key clockstr)
  11825. (org-no-properties
  11826. (org-trim
  11827. (buffer-substring
  11828. (match-beginning 3) (goto-char (point-at-eol)))))
  11829. (substring (org-match-string-no-properties 3) 1 -1)))
  11830. (unless key
  11831. (if (= (char-after (match-beginning 3)) ?\[)
  11832. (setq key "TIMESTAMP_IA")
  11833. (setq key "TIMESTAMP")))
  11834. (when (or (equal key clockstr) (not (assoc key props)))
  11835. (push (cons key string) props))))
  11836. )
  11837. (when (memq which '(all standard))
  11838. ;; Get the standard properties, like :PROP: ...
  11839. (setq range (org-get-property-block beg end))
  11840. (when range
  11841. (goto-char (car range))
  11842. (while (re-search-forward
  11843. (org-re "^[ \t]*:\\([[:alpha:]][[:alnum:]_-]*\\):[ \t]*\\(\\S-.*\\)?")
  11844. (cdr range) t)
  11845. (setq key (org-match-string-no-properties 1)
  11846. value (org-trim (or (org-match-string-no-properties 2) "")))
  11847. (unless (member key excluded)
  11848. (push (cons key (or value "")) props)))))
  11849. (if clocksum
  11850. (push (cons "CLOCKSUM"
  11851. (org-columns-number-to-string (/ (float clocksum) 60.)
  11852. 'add_times))
  11853. props))
  11854. (unless (assoc "CATEGORY" props)
  11855. (setq value (or (org-get-category)
  11856. (progn (org-refresh-category-properties)
  11857. (org-get-category))))
  11858. (push (cons "CATEGORY" value) props))
  11859. (append sum-props (nreverse props)))))))
  11860. (defun org-entry-get (pom property &optional inherit)
  11861. "Get value of PROPERTY for entry at point-or-marker POM.
  11862. If INHERIT is non-nil and the entry does not have the property,
  11863. then also check higher levels of the hierarchy.
  11864. If INHERIT is the symbol `selective', use inheritance only if the setting
  11865. in `org-use-property-inheritance' selects PROPERTY for inheritance.
  11866. If the property is present but empty, the return value is the empty string.
  11867. If the property is not present at all, nil is returned."
  11868. (org-with-point-at pom
  11869. (if (and inherit (if (eq inherit 'selective)
  11870. (org-property-inherit-p property)
  11871. t))
  11872. (org-entry-get-with-inheritance property)
  11873. (if (member property org-special-properties)
  11874. ;; We need a special property. Use `org-entry-properties' to
  11875. ;; retrieve it, but specify the wanted property
  11876. (cdr (assoc property (org-entry-properties nil 'special property)))
  11877. (let ((range (org-get-property-block)))
  11878. (if (and range
  11879. (goto-char (car range))
  11880. (re-search-forward
  11881. (concat "^[ \t]*:" property ":[ \t]*\\(.*[^ \t\r\n\f\v]\\)?")
  11882. (cdr range) t))
  11883. ;; Found the property, return it.
  11884. (if (match-end 1)
  11885. (org-match-string-no-properties 1)
  11886. "")))))))
  11887. (defun org-property-or-variable-value (var &optional inherit)
  11888. "Check if there is a property fixing the value of VAR.
  11889. If yes, return this value. If not, return the current value of the variable."
  11890. (let ((prop (org-entry-get nil (symbol-name var) inherit)))
  11891. (if (and prop (stringp prop) (string-match "\\S-" prop))
  11892. (read prop)
  11893. (symbol-value var))))
  11894. (defun org-entry-delete (pom property)
  11895. "Delete the property PROPERTY from entry at point-or-marker POM."
  11896. (org-with-point-at pom
  11897. (if (member property org-special-properties)
  11898. nil ; cannot delete these properties.
  11899. (let ((range (org-get-property-block)))
  11900. (if (and range
  11901. (goto-char (car range))
  11902. (re-search-forward
  11903. (concat "^[ \t]*:" property ":[ \t]*\\(.*[^ \t\r\n\f\v]\\)")
  11904. (cdr range) t))
  11905. (progn
  11906. (delete-region (match-beginning 0) (1+ (point-at-eol)))
  11907. t)
  11908. nil)))))
  11909. ;; Multi-values properties are properties that contain multiple values
  11910. ;; These values are assumed to be single words, separated by whitespace.
  11911. (defun org-entry-add-to-multivalued-property (pom property value)
  11912. "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
  11913. (let* ((old (org-entry-get pom property))
  11914. (values (and old (org-split-string old "[ \t]"))))
  11915. (setq value (org-entry-protect-space value))
  11916. (unless (member value values)
  11917. (setq values (cons value values))
  11918. (org-entry-put pom property
  11919. (mapconcat 'identity values " ")))))
  11920. (defun org-entry-remove-from-multivalued-property (pom property value)
  11921. "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
  11922. (let* ((old (org-entry-get pom property))
  11923. (values (and old (org-split-string old "[ \t]"))))
  11924. (setq value (org-entry-protect-space value))
  11925. (when (member value values)
  11926. (setq values (delete value values))
  11927. (org-entry-put pom property
  11928. (mapconcat 'identity values " ")))))
  11929. (defun org-entry-member-in-multivalued-property (pom property value)
  11930. "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
  11931. (let* ((old (org-entry-get pom property))
  11932. (values (and old (org-split-string old "[ \t]"))))
  11933. (setq value (org-entry-protect-space value))
  11934. (member value values)))
  11935. (defun org-entry-get-multivalued-property (pom property)
  11936. "Return a list of values in a multivalued property."
  11937. (let* ((value (org-entry-get pom property))
  11938. (values (and value (org-split-string value "[ \t]"))))
  11939. (mapcar 'org-entry-restore-space values)))
  11940. (defun org-entry-put-multivalued-property (pom property &rest values)
  11941. "Set multivalued PROPERTY at point-or-marker POM to VALUES.
  11942. VALUES should be a list of strings. Spaces will be protected."
  11943. (org-entry-put pom property
  11944. (mapconcat 'org-entry-protect-space values " "))
  11945. (let* ((value (org-entry-get pom property))
  11946. (values (and value (org-split-string value "[ \t]"))))
  11947. (mapcar 'org-entry-restore-space values)))
  11948. (defun org-entry-protect-space (s)
  11949. "Protect spaces and newline in string S."
  11950. (while (string-match " " s)
  11951. (setq s (replace-match "%20" t t s)))
  11952. (while (string-match "\n" s)
  11953. (setq s (replace-match "%0A" t t s)))
  11954. s)
  11955. (defun org-entry-restore-space (s)
  11956. "Restore spaces and newline in string S."
  11957. (while (string-match "%20" s)
  11958. (setq s (replace-match " " t t s)))
  11959. (while (string-match "%0A" s)
  11960. (setq s (replace-match "\n" t t s)))
  11961. s)
  11962. (defvar org-entry-property-inherited-from (make-marker)
  11963. "Marker pointing to the entry from where a property was inherited.
  11964. Each call to `org-entry-get-with-inheritance' will set this marker to the
  11965. location of the entry where the inheritance search matched. If there was
  11966. no match, the marker will point nowhere.
  11967. Note that also `org-entry-get' calls this function, if the INHERIT flag
  11968. is set.")
  11969. (defun org-entry-get-with-inheritance (property)
  11970. "Get entry property, and search higher levels if not present."
  11971. (move-marker org-entry-property-inherited-from nil)
  11972. (let (tmp)
  11973. (save-excursion
  11974. (save-restriction
  11975. (widen)
  11976. (catch 'ex
  11977. (while t
  11978. (when (setq tmp (org-entry-get nil property))
  11979. (org-back-to-heading t)
  11980. (move-marker org-entry-property-inherited-from (point))
  11981. (throw 'ex tmp))
  11982. (or (org-up-heading-safe) (throw 'ex nil)))))
  11983. (or tmp
  11984. (cdr (assoc property org-file-properties))
  11985. (cdr (assoc property org-global-properties))
  11986. (cdr (assoc property org-global-properties-fixed))))))
  11987. (defvar org-property-changed-functions nil
  11988. "Hook called when the value of a property has changed.
  11989. Each hook function should accept two arguments, the name of the property
  11990. and the new value.")
  11991. (defun org-entry-put (pom property value)
  11992. "Set PROPERTY to VALUE for entry at point-or-marker POM."
  11993. (org-with-point-at pom
  11994. (org-back-to-heading t)
  11995. (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
  11996. range)
  11997. (cond
  11998. ((equal property "TODO")
  11999. (when (and (stringp value) (string-match "\\S-" value)
  12000. (not (member value org-todo-keywords-1)))
  12001. (error "\"%s\" is not a valid TODO state" value))
  12002. (if (or (not value)
  12003. (not (string-match "\\S-" value)))
  12004. (setq value 'none))
  12005. (org-todo value)
  12006. (org-set-tags nil 'align))
  12007. ((equal property "PRIORITY")
  12008. (org-priority (if (and value (stringp value) (string-match "\\S-" value))
  12009. (string-to-char value) ?\ ))
  12010. (org-set-tags nil 'align))
  12011. ((equal property "SCHEDULED")
  12012. (if (re-search-forward org-scheduled-time-regexp end t)
  12013. (cond
  12014. ((eq value 'earlier) (org-timestamp-change -1 'day))
  12015. ((eq value 'later) (org-timestamp-change 1 'day))
  12016. (t (call-interactively 'org-schedule)))
  12017. (call-interactively 'org-schedule)))
  12018. ((equal property "DEADLINE")
  12019. (if (re-search-forward org-deadline-time-regexp end t)
  12020. (cond
  12021. ((eq value 'earlier) (org-timestamp-change -1 'day))
  12022. ((eq value 'later) (org-timestamp-change 1 'day))
  12023. (t (call-interactively 'org-deadline)))
  12024. (call-interactively 'org-deadline)))
  12025. ((member property org-special-properties)
  12026. (error "The %s property can not yet be set with `org-entry-put'"
  12027. property))
  12028. (t ; a non-special property
  12029. (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
  12030. (setq range (org-get-property-block beg end 'force))
  12031. (goto-char (car range))
  12032. (if (re-search-forward
  12033. (concat "^[ \t]*:" property ":\\(.*\\)") (cdr range) t)
  12034. (progn
  12035. (delete-region (match-beginning 1) (match-end 1))
  12036. (goto-char (match-beginning 1)))
  12037. (goto-char (cdr range))
  12038. (insert "\n")
  12039. (backward-char 1)
  12040. (org-indent-line-function)
  12041. (insert ":" property ":"))
  12042. (and value (insert " " value))
  12043. (org-indent-line-function)))))
  12044. (run-hook-with-args 'org-property-changed-functions property value)))
  12045. (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
  12046. "Get all property keys in the current buffer.
  12047. With INCLUDE-SPECIALS, also list the special properties that reflect things
  12048. like tags and TODO state.
  12049. With INCLUDE-DEFAULTS, also include properties that has special meaning
  12050. internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
  12051. With INCLUDE-COLUMNS, also include property names given in COLUMN
  12052. formats in the current buffer."
  12053. (let (rtn range cfmt s p)
  12054. (save-excursion
  12055. (save-restriction
  12056. (widen)
  12057. (goto-char (point-min))
  12058. (while (re-search-forward org-property-start-re nil t)
  12059. (setq range (org-get-property-block))
  12060. (goto-char (car range))
  12061. (while (re-search-forward
  12062. (org-re "^[ \t]*:\\([-[:alnum:]_]+\\):")
  12063. (cdr range) t)
  12064. (add-to-list 'rtn (org-match-string-no-properties 1)))
  12065. (outline-next-heading))))
  12066. (when include-specials
  12067. (setq rtn (append org-special-properties rtn)))
  12068. (when include-defaults
  12069. (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
  12070. (add-to-list 'rtn org-effort-property))
  12071. (when include-columns
  12072. (save-excursion
  12073. (save-restriction
  12074. (widen)
  12075. (goto-char (point-min))
  12076. (while (re-search-forward
  12077. "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
  12078. nil t)
  12079. (setq cfmt (match-string 2) s 0)
  12080. (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
  12081. cfmt s)
  12082. (setq s (match-end 0)
  12083. p (match-string 1 cfmt))
  12084. (unless (or (equal p "ITEM")
  12085. (member p org-special-properties))
  12086. (add-to-list 'rtn (match-string 1 cfmt))))))))
  12087. (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
  12088. (defun org-property-values (key)
  12089. "Return a list of all values of property KEY."
  12090. (save-excursion
  12091. (save-restriction
  12092. (widen)
  12093. (goto-char (point-min))
  12094. (let ((re (concat "^[ \t]*:" key ":[ \t]*\\(\\S-.*\\)"))
  12095. values)
  12096. (while (re-search-forward re nil t)
  12097. (add-to-list 'values (org-trim (match-string 1))))
  12098. (delete "" values)))))
  12099. (defun org-insert-property-drawer ()
  12100. "Insert a property drawer into the current entry."
  12101. (interactive)
  12102. (org-back-to-heading t)
  12103. (looking-at outline-regexp)
  12104. (let ((indent (if org-adapt-indentation
  12105. (- (match-end 0)(match-beginning 0))
  12106. 0))
  12107. (beg (point))
  12108. (re (concat "^[ \t]*" org-keyword-time-regexp))
  12109. end hiddenp)
  12110. (outline-next-heading)
  12111. (setq end (point))
  12112. (goto-char beg)
  12113. (while (re-search-forward re end t))
  12114. (setq hiddenp (org-invisible-p))
  12115. (end-of-line 1)
  12116. (and (equal (char-after) ?\n) (forward-char 1))
  12117. (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
  12118. (if (member (match-string 1) '("CLOCK:" ":END:"))
  12119. ;; just skip this line
  12120. (beginning-of-line 2)
  12121. ;; Drawer start, find the end
  12122. (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
  12123. (beginning-of-line 1)))
  12124. (org-skip-over-state-notes)
  12125. (skip-chars-backward " \t\n\r")
  12126. (if (eq (char-before) ?*) (forward-char 1))
  12127. (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
  12128. (beginning-of-line 0)
  12129. (org-indent-to-column indent)
  12130. (beginning-of-line 2)
  12131. (org-indent-to-column indent)
  12132. (beginning-of-line 0)
  12133. (if hiddenp
  12134. (save-excursion
  12135. (org-back-to-heading t)
  12136. (hide-entry))
  12137. (org-flag-drawer t))))
  12138. (defun org-set-property (property value)
  12139. "In the current entry, set PROPERTY to VALUE.
  12140. When called interactively, this will prompt for a property name, offering
  12141. completion on existing and default properties. And then it will prompt
  12142. for a value, offering completion either on allowed values (via an inherited
  12143. xxx_ALL property) or on existing values in other instances of this property
  12144. in the current file."
  12145. (interactive
  12146. (let* ((completion-ignore-case t)
  12147. (keys (org-buffer-property-keys nil t t))
  12148. (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
  12149. (prop (if (member prop0 keys)
  12150. prop0
  12151. (or (cdr (assoc (downcase prop0)
  12152. (mapcar (lambda (x) (cons (downcase x) x))
  12153. keys)))
  12154. prop0)))
  12155. (cur (org-entry-get nil prop))
  12156. (prompt (concat prop " value"
  12157. (if (and cur (string-match "\\S-" cur))
  12158. (concat " [" cur "]") "") ": "))
  12159. (allowed (org-property-get-allowed-values nil prop 'table))
  12160. (existing (mapcar 'list (org-property-values prop)))
  12161. (val (if allowed
  12162. (org-completing-read prompt allowed nil
  12163. (not (get-text-property 0 'org-unrestricted
  12164. (caar allowed))))
  12165. (let (org-completion-use-ido org-completion-use-iswitchb)
  12166. (org-completing-read prompt existing nil nil "" nil cur)))))
  12167. (list prop (if (equal val "") cur val))))
  12168. (unless (equal (org-entry-get nil property) value)
  12169. (org-entry-put nil property value)))
  12170. (defun org-delete-property (property)
  12171. "In the current entry, delete PROPERTY."
  12172. (interactive
  12173. (let* ((completion-ignore-case t)
  12174. (prop (org-icompleting-read "Property: " (org-entry-properties nil 'standard))))
  12175. (list prop)))
  12176. (message "Property %s %s" property
  12177. (if (org-entry-delete nil property)
  12178. "deleted"
  12179. "was not present in the entry")))
  12180. (defun org-delete-property-globally (property)
  12181. "Remove PROPERTY globally, from all entries."
  12182. (interactive
  12183. (let* ((completion-ignore-case t)
  12184. (prop (org-icompleting-read
  12185. "Globally remove property: "
  12186. (mapcar 'list (org-buffer-property-keys)))))
  12187. (list prop)))
  12188. (save-excursion
  12189. (save-restriction
  12190. (widen)
  12191. (goto-char (point-min))
  12192. (let ((cnt 0))
  12193. (while (re-search-forward
  12194. (concat "^[ \t]*:" (regexp-quote property) ":.*\n?")
  12195. nil t)
  12196. (setq cnt (1+ cnt))
  12197. (replace-match ""))
  12198. (message "Property \"%s\" removed from %d entries" property cnt)))))
  12199. (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
  12200. (defun org-compute-property-at-point ()
  12201. "Compute the property at point.
  12202. This looks for an enclosing column format, extracts the operator and
  12203. then applies it to the property in the column format's scope."
  12204. (interactive)
  12205. (unless (org-at-property-p)
  12206. (error "Not at a property"))
  12207. (let ((prop (org-match-string-no-properties 2)))
  12208. (org-columns-get-format-and-top-level)
  12209. (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
  12210. (error "No operator defined for property %s" prop))
  12211. (org-columns-compute prop)))
  12212. (defvar org-property-allowed-value-functions nil
  12213. "Hook for functions supplying allowed values for a specific property.
  12214. The functions must take a single argument, the name of the property, and
  12215. return a flat list of allowed values. If \":ETC\" is one of
  12216. the values, this means that these values are intended as defaults for
  12217. completion, but that other values should be allowed too.
  12218. The functions must return nil if they are not responsible for this
  12219. property.")
  12220. (defun org-property-get-allowed-values (pom property &optional table)
  12221. "Get allowed values for the property PROPERTY.
  12222. When TABLE is non-nil, return an alist that can directly be used for
  12223. completion."
  12224. (let (vals)
  12225. (cond
  12226. ((equal property "TODO")
  12227. (setq vals (org-with-point-at pom
  12228. (append org-todo-keywords-1 '("")))))
  12229. ((equal property "PRIORITY")
  12230. (let ((n org-lowest-priority))
  12231. (while (>= n org-highest-priority)
  12232. (push (char-to-string n) vals)
  12233. (setq n (1- n)))))
  12234. ((member property org-special-properties))
  12235. ((setq vals (run-hook-with-args-until-success
  12236. 'org-property-allowed-value-functions property)))
  12237. (t
  12238. (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
  12239. (when (and vals (string-match "\\S-" vals))
  12240. (setq vals (car (read-from-string (concat "(" vals ")"))))
  12241. (setq vals (mapcar (lambda (x)
  12242. (cond ((stringp x) x)
  12243. ((numberp x) (number-to-string x))
  12244. ((symbolp x) (symbol-name x))
  12245. (t "???")))
  12246. vals)))))
  12247. (when (member ":ETC" vals)
  12248. (setq vals (remove ":ETC" vals))
  12249. (org-add-props (car vals) '(org-unrestricted t)))
  12250. (if table (mapcar 'list vals) vals)))
  12251. (defun org-property-previous-allowed-value (&optional previous)
  12252. "Switch to the next allowed value for this property."
  12253. (interactive)
  12254. (org-property-next-allowed-value t))
  12255. (defun org-property-next-allowed-value (&optional previous)
  12256. "Switch to the next allowed value for this property."
  12257. (interactive)
  12258. (unless (org-at-property-p)
  12259. (error "Not at a property"))
  12260. (let* ((key (match-string 2))
  12261. (value (match-string 3))
  12262. (allowed (or (org-property-get-allowed-values (point) key)
  12263. (and (member value '("[ ]" "[-]" "[X]"))
  12264. '("[ ]" "[X]"))))
  12265. nval)
  12266. (unless allowed
  12267. (error "Allowed values for this property have not been defined"))
  12268. (if previous (setq allowed (reverse allowed)))
  12269. (if (member value allowed)
  12270. (setq nval (car (cdr (member value allowed)))))
  12271. (setq nval (or nval (car allowed)))
  12272. (if (equal nval value)
  12273. (error "Only one allowed value for this property"))
  12274. (org-at-property-p)
  12275. (replace-match (concat " :" key ": " nval) t t)
  12276. (org-indent-line-function)
  12277. (beginning-of-line 1)
  12278. (skip-chars-forward " \t")
  12279. (run-hook-with-args 'org-property-changed-functions key nval)))
  12280. (defun org-find-entry-with-id (ident)
  12281. "Locate the entry that contains the ID property with exact value IDENT.
  12282. IDENT can be a string, a symbol or a number, this function will search for
  12283. the string representation of it.
  12284. Return the position where this entry starts, or nil if there is no such entry."
  12285. (interactive "sID: ")
  12286. (let ((id (cond
  12287. ((stringp ident) ident)
  12288. ((symbol-name ident) (symbol-name ident))
  12289. ((numberp ident) (number-to-string ident))
  12290. (t (error "IDENT %s must be a string, symbol or number" ident))))
  12291. (case-fold-search nil))
  12292. (save-excursion
  12293. (save-restriction
  12294. (widen)
  12295. (goto-char (point-min))
  12296. (when (re-search-forward
  12297. (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
  12298. nil t)
  12299. (org-back-to-heading t)
  12300. (point))))))
  12301. ;;;; Timestamps
  12302. (defvar org-last-changed-timestamp nil)
  12303. (defvar org-last-inserted-timestamp nil
  12304. "The last time stamp inserted with `org-insert-time-stamp'.")
  12305. (defvar org-time-was-given) ; dynamically scoped parameter
  12306. (defvar org-end-time-was-given) ; dynamically scoped parameter
  12307. (defvar org-ts-what) ; dynamically scoped parameter
  12308. (defun org-time-stamp (arg &optional inactive)
  12309. "Prompt for a date/time and insert a time stamp.
  12310. If the user specifies a time like HH:MM, or if this command is called
  12311. with a prefix argument, the time stamp will contain date and time.
  12312. Otherwise, only the date will be included. All parts of a date not
  12313. specified by the user will be filled in from the current date/time.
  12314. So if you press just return without typing anything, the time stamp
  12315. will represent the current date/time. If there is already a timestamp
  12316. at the cursor, it will be modified."
  12317. (interactive "P")
  12318. (let* ((ts nil)
  12319. (default-time
  12320. ;; Default time is either today, or, when entering a range,
  12321. ;; the range start.
  12322. (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
  12323. (save-excursion
  12324. (re-search-backward
  12325. (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
  12326. (- (point) 20) t)))
  12327. (apply 'encode-time (org-parse-time-string (match-string 1)))
  12328. (current-time)))
  12329. (default-input (and ts (org-get-compact-tod ts)))
  12330. org-time-was-given org-end-time-was-given time)
  12331. (cond
  12332. ((and (org-at-timestamp-p t)
  12333. (memq last-command '(org-time-stamp org-time-stamp-inactive))
  12334. (memq this-command '(org-time-stamp org-time-stamp-inactive)))
  12335. (insert "--")
  12336. (setq time (let ((this-command this-command))
  12337. (org-read-date arg 'totime nil nil
  12338. default-time default-input)))
  12339. (org-insert-time-stamp time (or org-time-was-given arg) inactive))
  12340. ((org-at-timestamp-p t)
  12341. (setq time (let ((this-command this-command))
  12342. (org-read-date arg 'totime nil nil default-time default-input)))
  12343. (when (org-at-timestamp-p t) ; just to get the match data
  12344. ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
  12345. (replace-match "")
  12346. (setq org-last-changed-timestamp
  12347. (org-insert-time-stamp
  12348. time (or org-time-was-given arg)
  12349. inactive nil nil (list org-end-time-was-given))))
  12350. (message "Timestamp updated"))
  12351. (t
  12352. (setq time (let ((this-command this-command))
  12353. (org-read-date arg 'totime nil nil default-time default-input)))
  12354. (org-insert-time-stamp time (or org-time-was-given arg) inactive
  12355. nil nil (list org-end-time-was-given))))))
  12356. ;; FIXME: can we use this for something else, like computing time differences?
  12357. (defun org-get-compact-tod (s)
  12358. (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
  12359. (let* ((t1 (match-string 1 s))
  12360. (h1 (string-to-number (match-string 2 s)))
  12361. (m1 (string-to-number (match-string 3 s)))
  12362. (t2 (and (match-end 4) (match-string 5 s)))
  12363. (h2 (and t2 (string-to-number (match-string 6 s))))
  12364. (m2 (and t2 (string-to-number (match-string 7 s))))
  12365. dh dm)
  12366. (if (not t2)
  12367. t1
  12368. (setq dh (- h2 h1) dm (- m2 m1))
  12369. (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
  12370. (concat t1 "+" (number-to-string dh)
  12371. (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
  12372. (defun org-time-stamp-inactive (&optional arg)
  12373. "Insert an inactive time stamp.
  12374. An inactive time stamp is enclosed in square brackets instead of angle
  12375. brackets. It is inactive in the sense that it does not trigger agenda entries,
  12376. does not link to the calendar and cannot be changed with the S-cursor keys.
  12377. So these are more for recording a certain time/date."
  12378. (interactive "P")
  12379. (org-time-stamp arg 'inactive))
  12380. (defvar org-date-ovl (make-overlay 1 1))
  12381. (overlay-put org-date-ovl 'face 'org-warning)
  12382. (org-detach-overlay org-date-ovl)
  12383. (defvar org-ans1) ; dynamically scoped parameter
  12384. (defvar org-ans2) ; dynamically scoped parameter
  12385. (defvar org-plain-time-of-day-regexp) ; defined below
  12386. (defvar org-overriding-default-time nil) ; dynamically scoped
  12387. (defvar org-read-date-overlay nil)
  12388. (defvar org-dcst nil) ; dynamically scoped
  12389. (defvar org-read-date-history nil)
  12390. (defvar org-read-date-final-answer nil)
  12391. (defun org-read-date (&optional with-time to-time from-string prompt
  12392. default-time default-input)
  12393. "Read a date, possibly a time, and make things smooth for the user.
  12394. The prompt will suggest to enter an ISO date, but you can also enter anything
  12395. which will at least partially be understood by `parse-time-string'.
  12396. Unrecognized parts of the date will default to the current day, month, year,
  12397. hour and minute. If this command is called to replace a timestamp at point,
  12398. of to enter the second timestamp of a range, the default time is taken from the
  12399. existing stamp. For example,
  12400. 3-2-5 --> 2003-02-05
  12401. feb 15 --> currentyear-02-15
  12402. sep 12 9 --> 2009-09-12
  12403. 12:45 --> today 12:45
  12404. 22 sept 0:34 --> currentyear-09-22 0:34
  12405. 12 --> currentyear-currentmonth-12
  12406. Fri --> nearest Friday (today or later)
  12407. etc.
  12408. Furthermore you can specify a relative date by giving, as the *first* thing
  12409. in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
  12410. change in days weeks, months, years.
  12411. With a single plus or minus, the date is relative to today. With a double
  12412. plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
  12413. +4d --> four days from today
  12414. +4 --> same as above
  12415. +2w --> two weeks from today
  12416. ++5 --> five days from default date
  12417. The function understands only English month and weekday abbreviations,
  12418. but this can be configured with the variables `parse-time-months' and
  12419. `parse-time-weekdays'.
  12420. While prompting, a calendar is popped up - you can also select the
  12421. date with the mouse (button 1). The calendar shows a period of three
  12422. months. To scroll it to other months, use the keys `>' and `<'.
  12423. If you don't like the calendar, turn it off with
  12424. \(setq org-read-date-popup-calendar nil)
  12425. With optional argument TO-TIME, the date will immediately be converted
  12426. to an internal time.
  12427. With an optional argument WITH-TIME, the prompt will suggest to also
  12428. insert a time. Note that when WITH-TIME is not set, you can still
  12429. enter a time, and this function will inform the calling routine about
  12430. this change. The calling routine may then choose to change the format
  12431. used to insert the time stamp into the buffer to include the time.
  12432. With optional argument FROM-STRING, read from this string instead from
  12433. the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
  12434. the time/date that is used for everything that is not specified by the
  12435. user."
  12436. (require 'parse-time)
  12437. (let* ((org-time-stamp-rounding-minutes
  12438. (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
  12439. (org-dcst org-display-custom-times)
  12440. (ct (org-current-time))
  12441. (def (or org-overriding-default-time default-time ct))
  12442. (defdecode (decode-time def))
  12443. (dummy (progn
  12444. (when (< (nth 2 defdecode) org-extend-today-until)
  12445. (setcar (nthcdr 2 defdecode) -1)
  12446. (setcar (nthcdr 1 defdecode) 59)
  12447. (setq def (apply 'encode-time defdecode)
  12448. defdecode (decode-time def)))))
  12449. (calendar-frame-setup nil)
  12450. (calendar-move-hook nil)
  12451. (calendar-view-diary-initially-flag nil)
  12452. (calendar-view-holidays-initially-flag nil)
  12453. (timestr (format-time-string
  12454. (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
  12455. (prompt (concat (if prompt (concat prompt " ") "")
  12456. (format "Date+time [%s]: " timestr)))
  12457. ans (org-ans0 "") org-ans1 org-ans2 final)
  12458. (cond
  12459. (from-string (setq ans from-string))
  12460. (org-read-date-popup-calendar
  12461. (save-excursion
  12462. (save-window-excursion
  12463. (calendar)
  12464. (calendar-forward-day (- (time-to-days def)
  12465. (calendar-absolute-from-gregorian
  12466. (calendar-current-date))))
  12467. (org-eval-in-calendar nil t)
  12468. (let* ((old-map (current-local-map))
  12469. (map (copy-keymap calendar-mode-map))
  12470. (minibuffer-local-map (copy-keymap minibuffer-local-map)))
  12471. (org-defkey map (kbd "RET") 'org-calendar-select)
  12472. (org-defkey map [mouse-1] 'org-calendar-select-mouse)
  12473. (org-defkey map [mouse-2] 'org-calendar-select-mouse)
  12474. (org-defkey minibuffer-local-map [(meta shift left)]
  12475. (lambda () (interactive)
  12476. (org-eval-in-calendar '(calendar-backward-month 1))))
  12477. (org-defkey minibuffer-local-map [(meta shift right)]
  12478. (lambda () (interactive)
  12479. (org-eval-in-calendar '(calendar-forward-month 1))))
  12480. (org-defkey minibuffer-local-map [(meta shift up)]
  12481. (lambda () (interactive)
  12482. (org-eval-in-calendar '(calendar-backward-year 1))))
  12483. (org-defkey minibuffer-local-map [(meta shift down)]
  12484. (lambda () (interactive)
  12485. (org-eval-in-calendar '(calendar-forward-year 1))))
  12486. (org-defkey minibuffer-local-map [?\e (shift left)]
  12487. (lambda () (interactive)
  12488. (org-eval-in-calendar '(calendar-backward-month 1))))
  12489. (org-defkey minibuffer-local-map [?\e (shift right)]
  12490. (lambda () (interactive)
  12491. (org-eval-in-calendar '(calendar-forward-month 1))))
  12492. (org-defkey minibuffer-local-map [?\e (shift up)]
  12493. (lambda () (interactive)
  12494. (org-eval-in-calendar '(calendar-backward-year 1))))
  12495. (org-defkey minibuffer-local-map [?\e (shift down)]
  12496. (lambda () (interactive)
  12497. (org-eval-in-calendar '(calendar-forward-year 1))))
  12498. (org-defkey minibuffer-local-map [(shift up)]
  12499. (lambda () (interactive)
  12500. (org-eval-in-calendar '(calendar-backward-week 1))))
  12501. (org-defkey minibuffer-local-map [(shift down)]
  12502. (lambda () (interactive)
  12503. (org-eval-in-calendar '(calendar-forward-week 1))))
  12504. (org-defkey minibuffer-local-map [(shift left)]
  12505. (lambda () (interactive)
  12506. (org-eval-in-calendar '(calendar-backward-day 1))))
  12507. (org-defkey minibuffer-local-map [(shift right)]
  12508. (lambda () (interactive)
  12509. (org-eval-in-calendar '(calendar-forward-day 1))))
  12510. (org-defkey minibuffer-local-map ">"
  12511. (lambda () (interactive)
  12512. (org-eval-in-calendar '(scroll-calendar-left 1))))
  12513. (org-defkey minibuffer-local-map "<"
  12514. (lambda () (interactive)
  12515. (org-eval-in-calendar '(scroll-calendar-right 1))))
  12516. (org-defkey minibuffer-local-map "\C-v"
  12517. (lambda () (interactive)
  12518. (org-eval-in-calendar
  12519. '(calendar-scroll-left-three-months 1))))
  12520. (org-defkey minibuffer-local-map "\M-v"
  12521. (lambda () (interactive)
  12522. (org-eval-in-calendar
  12523. '(calendar-scroll-right-three-months 1))))
  12524. (run-hooks 'org-read-date-minibuffer-setup-hook)
  12525. (unwind-protect
  12526. (progn
  12527. (use-local-map map)
  12528. (add-hook 'post-command-hook 'org-read-date-display)
  12529. (setq org-ans0 (read-string prompt default-input
  12530. 'org-read-date-history nil))
  12531. ;; org-ans0: from prompt
  12532. ;; org-ans1: from mouse click
  12533. ;; org-ans2: from calendar motion
  12534. (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
  12535. (remove-hook 'post-command-hook 'org-read-date-display)
  12536. (use-local-map old-map)
  12537. (when org-read-date-overlay
  12538. (delete-overlay org-read-date-overlay)
  12539. (setq org-read-date-overlay nil)))))))
  12540. (t ; Naked prompt only
  12541. (unwind-protect
  12542. (setq ans (read-string prompt default-input
  12543. 'org-read-date-history timestr))
  12544. (when org-read-date-overlay
  12545. (delete-overlay org-read-date-overlay)
  12546. (setq org-read-date-overlay nil)))))
  12547. (setq final (org-read-date-analyze ans def defdecode))
  12548. (setq org-read-date-final-answer ans)
  12549. (if to-time
  12550. (apply 'encode-time final)
  12551. (if (and (boundp 'org-time-was-given) org-time-was-given)
  12552. (format "%04d-%02d-%02d %02d:%02d"
  12553. (nth 5 final) (nth 4 final) (nth 3 final)
  12554. (nth 2 final) (nth 1 final))
  12555. (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
  12556. (defvar def)
  12557. (defvar defdecode)
  12558. (defvar with-time)
  12559. (defvar org-read-date-analyze-futurep nil)
  12560. (defun org-read-date-display ()
  12561. "Display the current date prompt interpretation in the minibuffer."
  12562. (when org-read-date-display-live
  12563. (when org-read-date-overlay
  12564. (delete-overlay org-read-date-overlay))
  12565. (let ((p (point)))
  12566. (end-of-line 1)
  12567. (while (not (equal (buffer-substring
  12568. (max (point-min) (- (point) 4)) (point))
  12569. " "))
  12570. (insert " "))
  12571. (goto-char p))
  12572. (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
  12573. " " (or org-ans1 org-ans2)))
  12574. (org-end-time-was-given nil)
  12575. (f (org-read-date-analyze ans def defdecode))
  12576. (fmts (if org-dcst
  12577. org-time-stamp-custom-formats
  12578. org-time-stamp-formats))
  12579. (fmt (if (or with-time
  12580. (and (boundp 'org-time-was-given) org-time-was-given))
  12581. (cdr fmts)
  12582. (car fmts)))
  12583. (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
  12584. (when (and org-end-time-was-given
  12585. (string-match org-plain-time-of-day-regexp txt))
  12586. (setq txt (concat (substring txt 0 (match-end 0)) "-"
  12587. org-end-time-was-given
  12588. (substring txt (match-end 0)))))
  12589. (when org-read-date-analyze-futurep
  12590. (setq txt (concat txt " (=>F)")))
  12591. (setq org-read-date-overlay
  12592. (make-overlay (1- (point-at-eol)) (point-at-eol)))
  12593. (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
  12594. (defun org-read-date-analyze (ans def defdecode)
  12595. "Analyse the combined answer of the date prompt."
  12596. ;; FIXME: cleanup and comment
  12597. (let ((nowdecode (decode-time (current-time)))
  12598. delta deltan deltaw deltadef year month day
  12599. hour minute second wday pm h2 m2 tl wday1
  12600. iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
  12601. (setq org-read-date-analyze-futurep nil)
  12602. (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
  12603. (setq ans "+0"))
  12604. (when (setq delta (org-read-date-get-relative ans (current-time) def))
  12605. (setq ans (replace-match "" t t ans)
  12606. deltan (car delta)
  12607. deltaw (nth 1 delta)
  12608. deltadef (nth 2 delta)))
  12609. ;; Check if there is an iso week date in there
  12610. ;; If yes, store the info and postpone interpreting it until the rest
  12611. ;; of the parsing is done
  12612. (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
  12613. (setq iso-year (if (match-end 1)
  12614. (org-small-year-to-year
  12615. (string-to-number (match-string 1 ans))))
  12616. iso-weekday (if (match-end 3)
  12617. (string-to-number (match-string 3 ans)))
  12618. iso-week (string-to-number (match-string 2 ans)))
  12619. (setq ans (replace-match "" t t ans)))
  12620. ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
  12621. (when (string-match
  12622. "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
  12623. (setq year (if (match-end 2)
  12624. (string-to-number (match-string 2 ans))
  12625. (progn (setq kill-year t)
  12626. (string-to-number (format-time-string "%Y"))))
  12627. month (string-to-number (match-string 3 ans))
  12628. day (string-to-number (match-string 4 ans)))
  12629. (if (< year 100) (setq year (+ 2000 year)))
  12630. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  12631. t nil ans)))
  12632. ;; Help matching american dates, like 5/30 or 5/30/7
  12633. (when (string-match
  12634. "^ *\\([0-3]?[0-9]\\)/\\([0-1]?[0-9]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
  12635. (setq year (if (match-end 4)
  12636. (string-to-number (match-string 4 ans))
  12637. (progn (setq kill-year t)
  12638. (string-to-number (format-time-string "%Y"))))
  12639. month (string-to-number (match-string 1 ans))
  12640. day (string-to-number (match-string 2 ans)))
  12641. (if (< year 100) (setq year (+ 2000 year)))
  12642. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  12643. t nil ans)))
  12644. ;; Help matching am/pm times, because `parse-time-string' does not do that.
  12645. ;; If there is a time with am/pm, and *no* time without it, we convert
  12646. ;; so that matching will be successful.
  12647. (loop for i from 1 to 2 do ; twice, for end time as well
  12648. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  12649. (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
  12650. (setq hour (string-to-number (match-string 1 ans))
  12651. minute (if (match-end 3)
  12652. (string-to-number (match-string 3 ans))
  12653. 0)
  12654. pm (equal ?p
  12655. (string-to-char (downcase (match-string 4 ans)))))
  12656. (if (and (= hour 12) (not pm))
  12657. (setq hour 0)
  12658. (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
  12659. (setq ans (replace-match (format "%02d:%02d" hour minute)
  12660. t t ans))))
  12661. ;; Check if a time range is given as a duration
  12662. (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
  12663. (setq hour (string-to-number (match-string 1 ans))
  12664. h2 (+ hour (string-to-number (match-string 3 ans)))
  12665. minute (string-to-number (match-string 2 ans))
  12666. m2 (+ minute (if (match-end 5) (string-to-number
  12667. (match-string 5 ans))0)))
  12668. (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
  12669. (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
  12670. t t ans)))
  12671. ;; Check if there is a time range
  12672. (when (boundp 'org-end-time-was-given)
  12673. (setq org-time-was-given nil)
  12674. (when (and (string-match org-plain-time-of-day-regexp ans)
  12675. (match-end 8))
  12676. (setq org-end-time-was-given (match-string 8 ans))
  12677. (setq ans (concat (substring ans 0 (match-beginning 7))
  12678. (substring ans (match-end 7))))))
  12679. (setq tl (parse-time-string ans)
  12680. day (or (nth 3 tl) (nth 3 defdecode))
  12681. month (or (nth 4 tl)
  12682. (if (and org-read-date-prefer-future
  12683. (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
  12684. (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
  12685. (nth 4 defdecode)))
  12686. year (or (and (not kill-year) (nth 5 tl))
  12687. (if (and org-read-date-prefer-future
  12688. (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
  12689. (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
  12690. (nth 5 defdecode)))
  12691. hour (or (nth 2 tl) (nth 2 defdecode))
  12692. minute (or (nth 1 tl) (nth 1 defdecode))
  12693. second (or (nth 0 tl) 0)
  12694. wday (nth 6 tl))
  12695. (when (and (eq org-read-date-prefer-future 'time)
  12696. (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
  12697. (equal day (nth 3 nowdecode))
  12698. (equal month (nth 4 nowdecode))
  12699. (equal year (nth 5 nowdecode))
  12700. (nth 2 tl)
  12701. (or (< (nth 2 tl) (nth 2 nowdecode))
  12702. (and (= (nth 2 tl) (nth 2 nowdecode))
  12703. (nth 1 tl)
  12704. (< (nth 1 tl) (nth 1 nowdecode)))))
  12705. (setq day (1+ day)
  12706. futurep t))
  12707. ;; Special date definitions below
  12708. (cond
  12709. (iso-week
  12710. ;; There was an iso week
  12711. (require 'cal-iso)
  12712. (setq futurep nil)
  12713. (setq year (or iso-year year)
  12714. day (or iso-weekday wday 1)
  12715. wday nil ; to make sure that the trigger below does not match
  12716. iso-date (calendar-gregorian-from-absolute
  12717. (calendar-absolute-from-iso
  12718. (list iso-week day year))))
  12719. ; FIXME: Should we also push ISO weeks into the future?
  12720. ; (when (and org-read-date-prefer-future
  12721. ; (not iso-year)
  12722. ; (< (calendar-absolute-from-gregorian iso-date)
  12723. ; (time-to-days (current-time))))
  12724. ; (setq year (1+ year)
  12725. ; iso-date (calendar-gregorian-from-absolute
  12726. ; (calendar-absolute-from-iso
  12727. ; (list iso-week day year)))))
  12728. (setq month (car iso-date)
  12729. year (nth 2 iso-date)
  12730. day (nth 1 iso-date)))
  12731. (deltan
  12732. (setq futurep nil)
  12733. (unless deltadef
  12734. (let ((now (decode-time (current-time))))
  12735. (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
  12736. (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
  12737. ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
  12738. ((equal deltaw "m") (setq month (+ month deltan)))
  12739. ((equal deltaw "y") (setq year (+ year deltan)))))
  12740. ((and wday (not (nth 3 tl)))
  12741. (setq futurep nil)
  12742. ;; Weekday was given, but no day, so pick that day in the week
  12743. ;; on or after the derived date.
  12744. (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
  12745. (unless (equal wday wday1)
  12746. (setq day (+ day (% (- wday wday1 -7) 7))))))
  12747. (if (and (boundp 'org-time-was-given)
  12748. (nth 2 tl))
  12749. (setq org-time-was-given t))
  12750. (if (< year 100) (setq year (+ 2000 year)))
  12751. (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
  12752. (setq org-read-date-analyze-futurep futurep)
  12753. (list second minute hour day month year)))
  12754. (defvar parse-time-weekdays)
  12755. (defun org-read-date-get-relative (s today default)
  12756. "Check string S for special relative date string.
  12757. TODAY and DEFAULT are internal times, for today and for a default.
  12758. Return shift list (N what def-flag)
  12759. WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
  12760. N is the number of WHATs to shift.
  12761. DEF-FLAG is t when a double ++ or -- indicates shift relative to
  12762. the DEFAULT date rather than TODAY."
  12763. (when (and
  12764. (string-match
  12765. (concat
  12766. "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
  12767. "\\([0-9]+\\)?"
  12768. "\\([dwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
  12769. "\\([ \t]\\|$\\)") s)
  12770. (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
  12771. (let* ((dir (if (> (match-end 1) (match-beginning 1))
  12772. (string-to-char (substring (match-string 1 s) -1))
  12773. ?+))
  12774. (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
  12775. (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
  12776. (what (if (match-end 3) (match-string 3 s) "d"))
  12777. (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
  12778. (date (if rel default today))
  12779. (wday (nth 6 (decode-time date)))
  12780. delta)
  12781. (if wday1
  12782. (progn
  12783. (setq delta (mod (+ 7 (- wday1 wday)) 7))
  12784. (if (= dir ?-) (setq delta (- delta 7)))
  12785. (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
  12786. (list delta "d" rel))
  12787. (list (* n (if (= dir ?-) -1 1)) what rel)))))
  12788. (defun org-order-calendar-date-args (arg1 arg2 arg3)
  12789. "Turn a user-specified date into the internal representation.
  12790. The internal representation needed by the calendar is (month day year).
  12791. This is a wrapper to handle the brain-dead convention in calendar that
  12792. user function argument order change dependent on argument order."
  12793. (if (boundp 'calendar-date-style)
  12794. (cond
  12795. ((eq calendar-date-style 'american)
  12796. (list arg1 arg2 arg3))
  12797. ((eq calendar-date-style 'european)
  12798. (list arg2 arg1 arg3))
  12799. ((eq calendar-date-style 'iso)
  12800. (list arg2 arg3 arg1)))
  12801. (if (org-bound-and-true-p european-calendar-style)
  12802. (list arg2 arg1 arg3)
  12803. (list arg1 arg2 arg3))))
  12804. (defun org-eval-in-calendar (form &optional keepdate)
  12805. "Eval FORM in the calendar window and return to current window.
  12806. Also, store the cursor date in variable org-ans2."
  12807. (let ((sf (selected-frame))
  12808. (sw (selected-window)))
  12809. (select-window (get-buffer-window "*Calendar*" t))
  12810. (eval form)
  12811. (when (and (not keepdate) (calendar-cursor-to-date))
  12812. (let* ((date (calendar-cursor-to-date))
  12813. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  12814. (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
  12815. (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
  12816. (select-window sw)
  12817. (org-select-frame-set-input-focus sf)))
  12818. (defun org-calendar-select ()
  12819. "Return to `org-read-date' with the date currently selected.
  12820. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  12821. (interactive)
  12822. (when (calendar-cursor-to-date)
  12823. (let* ((date (calendar-cursor-to-date))
  12824. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  12825. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  12826. (if (active-minibuffer-window) (exit-minibuffer))))
  12827. (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
  12828. "Insert a date stamp for the date given by the internal TIME.
  12829. WITH-HM means use the stamp format that includes the time of the day.
  12830. INACTIVE means use square brackets instead of angular ones, so that the
  12831. stamp will not contribute to the agenda.
  12832. PRE and POST are optional strings to be inserted before and after the
  12833. stamp.
  12834. The command returns the inserted time stamp."
  12835. (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
  12836. stamp)
  12837. (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
  12838. (insert-before-markers (or pre ""))
  12839. (insert-before-markers (setq stamp (format-time-string fmt time)))
  12840. (when (listp extra)
  12841. (setq extra (car extra))
  12842. (if (and (stringp extra)
  12843. (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
  12844. (setq extra (format "-%02d:%02d"
  12845. (string-to-number (match-string 1 extra))
  12846. (string-to-number (match-string 2 extra))))
  12847. (setq extra nil)))
  12848. (when extra
  12849. (backward-char 1)
  12850. (insert-before-markers extra)
  12851. (forward-char 1))
  12852. (insert-before-markers (or post ""))
  12853. (setq org-last-inserted-timestamp stamp)))
  12854. (defun org-toggle-time-stamp-overlays ()
  12855. "Toggle the use of custom time stamp formats."
  12856. (interactive)
  12857. (setq org-display-custom-times (not org-display-custom-times))
  12858. (unless org-display-custom-times
  12859. (let ((p (point-min)) (bmp (buffer-modified-p)))
  12860. (while (setq p (next-single-property-change p 'display))
  12861. (if (and (get-text-property p 'display)
  12862. (eq (get-text-property p 'face) 'org-date))
  12863. (remove-text-properties
  12864. p (setq p (next-single-property-change p 'display))
  12865. '(display t))))
  12866. (set-buffer-modified-p bmp)))
  12867. (if (featurep 'xemacs)
  12868. (remove-text-properties (point-min) (point-max) '(end-glyph t)))
  12869. (org-restart-font-lock)
  12870. (setq org-table-may-need-update t)
  12871. (if org-display-custom-times
  12872. (message "Time stamps are overlayed with custom format")
  12873. (message "Time stamp overlays removed")))
  12874. (defun org-display-custom-time (beg end)
  12875. "Overlay modified time stamp format over timestamp between BEG and END."
  12876. (let* ((ts (buffer-substring beg end))
  12877. t1 w1 with-hm tf time str w2 (off 0))
  12878. (save-match-data
  12879. (setq t1 (org-parse-time-string ts t))
  12880. (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
  12881. (setq off (- (match-end 0) (match-beginning 0)))))
  12882. (setq end (- end off))
  12883. (setq w1 (- end beg)
  12884. with-hm (and (nth 1 t1) (nth 2 t1))
  12885. tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
  12886. time (org-fix-decoded-time t1)
  12887. str (org-add-props
  12888. (format-time-string
  12889. (substring tf 1 -1) (apply 'encode-time time))
  12890. nil 'mouse-face 'highlight)
  12891. w2 (length str))
  12892. (if (not (= w2 w1))
  12893. (add-text-properties (1+ beg) (+ 2 beg)
  12894. (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
  12895. (if (featurep 'xemacs)
  12896. (progn
  12897. (put-text-property beg end 'invisible t)
  12898. (put-text-property beg end 'end-glyph (make-glyph str)))
  12899. (put-text-property beg end 'display str))))
  12900. (defun org-translate-time (string)
  12901. "Translate all timestamps in STRING to custom format.
  12902. But do this only if the variable `org-display-custom-times' is set."
  12903. (when org-display-custom-times
  12904. (save-match-data
  12905. (let* ((start 0)
  12906. (re org-ts-regexp-both)
  12907. t1 with-hm inactive tf time str beg end)
  12908. (while (setq start (string-match re string start))
  12909. (setq beg (match-beginning 0)
  12910. end (match-end 0)
  12911. t1 (save-match-data
  12912. (org-parse-time-string (substring string beg end) t))
  12913. with-hm (and (nth 1 t1) (nth 2 t1))
  12914. inactive (equal (substring string beg (1+ beg)) "[")
  12915. tf (funcall (if with-hm 'cdr 'car)
  12916. org-time-stamp-custom-formats)
  12917. time (org-fix-decoded-time t1)
  12918. str (format-time-string
  12919. (concat
  12920. (if inactive "[" "<") (substring tf 1 -1)
  12921. (if inactive "]" ">"))
  12922. (apply 'encode-time time))
  12923. string (replace-match str t t string)
  12924. start (+ start (length str)))))))
  12925. string)
  12926. (defun org-fix-decoded-time (time)
  12927. "Set 0 instead of nil for the first 6 elements of time.
  12928. Don't touch the rest."
  12929. (let ((n 0))
  12930. (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
  12931. (defun org-days-to-time (timestamp-string)
  12932. "Difference between TIMESTAMP-STRING and now in days."
  12933. (- (time-to-days (org-time-string-to-time timestamp-string))
  12934. (time-to-days (current-time))))
  12935. (defun org-deadline-close (timestamp-string &optional ndays)
  12936. "Is the time in TIMESTAMP-STRING close to the current date?"
  12937. (setq ndays (or ndays (org-get-wdays timestamp-string)))
  12938. (and (< (org-days-to-time timestamp-string) ndays)
  12939. (not (org-entry-is-done-p))))
  12940. (defun org-get-wdays (ts)
  12941. "Get the deadline lead time appropriate for timestring TS."
  12942. (cond
  12943. ((<= org-deadline-warning-days 0)
  12944. ;; 0 or negative, enforce this value no matter what
  12945. (- org-deadline-warning-days))
  12946. ((string-match "-\\([0-9]+\\)\\([dwmy]\\)\\(\\'\\|>\\| \\)" ts)
  12947. ;; lead time is specified.
  12948. (floor (* (string-to-number (match-string 1 ts))
  12949. (cdr (assoc (match-string 2 ts)
  12950. '(("d" . 1) ("w" . 7)
  12951. ("m" . 30.4) ("y" . 365.25)))))))
  12952. ;; go for the default.
  12953. (t org-deadline-warning-days)))
  12954. (defun org-calendar-select-mouse (ev)
  12955. "Return to `org-read-date' with the date currently selected.
  12956. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  12957. (interactive "e")
  12958. (mouse-set-point ev)
  12959. (when (calendar-cursor-to-date)
  12960. (let* ((date (calendar-cursor-to-date))
  12961. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  12962. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  12963. (if (active-minibuffer-window) (exit-minibuffer))))
  12964. (defun org-check-deadlines (ndays)
  12965. "Check if there are any deadlines due or past due.
  12966. A deadline is considered due if it happens within `org-deadline-warning-days'
  12967. days from today's date. If the deadline appears in an entry marked DONE,
  12968. it is not shown. The prefix arg NDAYS can be used to test that many
  12969. days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
  12970. (interactive "P")
  12971. (let* ((org-warn-days
  12972. (cond
  12973. ((equal ndays '(4)) 100000)
  12974. (ndays (prefix-numeric-value ndays))
  12975. (t (abs org-deadline-warning-days))))
  12976. (case-fold-search nil)
  12977. (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  12978. (callback
  12979. (lambda () (org-deadline-close (match-string 1) org-warn-days))))
  12980. (message "%d deadlines past-due or due within %d days"
  12981. (org-occur regexp nil callback)
  12982. org-warn-days)))
  12983. (defun org-check-before-date (date)
  12984. "Check if there are deadlines or scheduled entries before DATE."
  12985. (interactive (list (org-read-date)))
  12986. (let ((case-fold-search nil)
  12987. (regexp (concat "\\<\\(" org-deadline-string
  12988. "\\|" org-scheduled-string
  12989. "\\) *<\\([^>]+\\)>"))
  12990. (callback
  12991. (lambda () (time-less-p
  12992. (org-time-string-to-time (match-string 2))
  12993. (org-time-string-to-time date)))))
  12994. (message "%d entries before %s"
  12995. (org-occur regexp nil callback) date)))
  12996. (defun org-check-after-date (date)
  12997. "Check if there are deadlines or scheduled entries after DATE."
  12998. (interactive (list (org-read-date)))
  12999. (let ((case-fold-search nil)
  13000. (regexp (concat "\\<\\(" org-deadline-string
  13001. "\\|" org-scheduled-string
  13002. "\\) *<\\([^>]+\\)>"))
  13003. (callback
  13004. (lambda () (not
  13005. (time-less-p
  13006. (org-time-string-to-time (match-string 2))
  13007. (org-time-string-to-time date))))))
  13008. (message "%d entries after %s"
  13009. (org-occur regexp nil callback) date)))
  13010. (defun org-evaluate-time-range (&optional to-buffer)
  13011. "Evaluate a time range by computing the difference between start and end.
  13012. Normally the result is just printed in the echo area, but with prefix arg
  13013. TO-BUFFER, the result is inserted just after the date stamp into the buffer.
  13014. If the time range is actually in a table, the result is inserted into the
  13015. next column.
  13016. For time difference computation, a year is assumed to be exactly 365
  13017. days in order to avoid rounding problems."
  13018. (interactive "P")
  13019. (or
  13020. (org-clock-update-time-maybe)
  13021. (save-excursion
  13022. (unless (org-at-date-range-p t)
  13023. (goto-char (point-at-bol))
  13024. (re-search-forward org-tr-regexp-both (point-at-eol) t))
  13025. (if (not (org-at-date-range-p t))
  13026. (error "Not at a time-stamp range, and none found in current line")))
  13027. (let* ((ts1 (match-string 1))
  13028. (ts2 (match-string 2))
  13029. (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
  13030. (match-end (match-end 0))
  13031. (time1 (org-time-string-to-time ts1))
  13032. (time2 (org-time-string-to-time ts2))
  13033. (t1 (org-float-time time1))
  13034. (t2 (org-float-time time2))
  13035. (diff (abs (- t2 t1)))
  13036. (negative (< (- t2 t1) 0))
  13037. ;; (ys (floor (* 365 24 60 60)))
  13038. (ds (* 24 60 60))
  13039. (hs (* 60 60))
  13040. (fy "%dy %dd %02d:%02d")
  13041. (fy1 "%dy %dd")
  13042. (fd "%dd %02d:%02d")
  13043. (fd1 "%dd")
  13044. (fh "%02d:%02d")
  13045. y d h m align)
  13046. (if havetime
  13047. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  13048. y 0
  13049. d (floor (/ diff ds)) diff (mod diff ds)
  13050. h (floor (/ diff hs)) diff (mod diff hs)
  13051. m (floor (/ diff 60)))
  13052. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  13053. y 0
  13054. d (floor (+ (/ diff ds) 0.5))
  13055. h 0 m 0))
  13056. (if (not to-buffer)
  13057. (message "%s" (org-make-tdiff-string y d h m))
  13058. (if (org-at-table-p)
  13059. (progn
  13060. (goto-char match-end)
  13061. (setq align t)
  13062. (and (looking-at " *|") (goto-char (match-end 0))))
  13063. (goto-char match-end))
  13064. (if (looking-at
  13065. "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
  13066. (replace-match ""))
  13067. (if negative (insert " -"))
  13068. (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
  13069. (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
  13070. (insert " " (format fh h m))))
  13071. (if align (org-table-align))
  13072. (message "Time difference inserted")))))
  13073. (defun org-make-tdiff-string (y d h m)
  13074. (let ((fmt "")
  13075. (l nil))
  13076. (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
  13077. l (push y l)))
  13078. (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
  13079. l (push d l)))
  13080. (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
  13081. l (push h l)))
  13082. (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
  13083. l (push m l)))
  13084. (apply 'format fmt (nreverse l))))
  13085. (defun org-time-string-to-time (s)
  13086. (apply 'encode-time (org-parse-time-string s)))
  13087. (defun org-time-string-to-seconds (s)
  13088. (org-float-time (org-time-string-to-time s)))
  13089. (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
  13090. "Convert a time stamp to an absolute day number.
  13091. If there is a specifyer for a cyclic time stamp, get the closest date to
  13092. DAYNR.
  13093. PREFER and SHOW-ALL are passed through to `org-closest-date'.
  13094. the variable date is bound by the calendar when this is called."
  13095. (cond
  13096. ((and daynr (string-match "\\`%%\\((.*)\\)" s))
  13097. (if (org-diary-sexp-entry (match-string 1 s) "" date)
  13098. daynr
  13099. (+ daynr 1000)))
  13100. ((and daynr (string-match "\\+[0-9]+[dwmy]" s))
  13101. (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
  13102. (time-to-days (current-time))) (match-string 0 s)
  13103. prefer show-all))
  13104. (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
  13105. (defun org-days-to-iso-week (days)
  13106. "Return the iso week number."
  13107. (require 'cal-iso)
  13108. (car (calendar-iso-from-absolute days)))
  13109. (defun org-small-year-to-year (year)
  13110. "Convert 2-digit years into 4-digit years.
  13111. 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
  13112. The year 2000 cannot be abbreviated. Any year larger than 99
  13113. is returned unchanged."
  13114. (if (< year 38)
  13115. (setq year (+ 2000 year))
  13116. (if (< year 100)
  13117. (setq year (+ 1900 year))))
  13118. year)
  13119. (defun org-time-from-absolute (d)
  13120. "Return the time corresponding to date D.
  13121. D may be an absolute day number, or a calendar-type list (month day year)."
  13122. (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
  13123. (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
  13124. (defun org-calendar-holiday ()
  13125. "List of holidays, for Diary display in Org-mode."
  13126. (require 'holidays)
  13127. (let ((hl (funcall
  13128. (if (fboundp 'calendar-check-holidays)
  13129. 'calendar-check-holidays 'check-calendar-holidays) date)))
  13130. (if hl (mapconcat 'identity hl "; "))))
  13131. (defun org-diary-sexp-entry (sexp entry date)
  13132. "Process a SEXP diary ENTRY for DATE."
  13133. (require 'diary-lib)
  13134. (let ((result (if calendar-debug-sexp
  13135. (let ((stack-trace-on-error t))
  13136. (eval (car (read-from-string sexp))))
  13137. (condition-case nil
  13138. (eval (car (read-from-string sexp)))
  13139. (error
  13140. (beep)
  13141. (message "Bad sexp at line %d in %s: %s"
  13142. (org-current-line)
  13143. (buffer-file-name) sexp)
  13144. (sleep-for 2))))))
  13145. (cond ((stringp result) result)
  13146. ((and (consp result)
  13147. (stringp (cdr result))) (cdr result))
  13148. (result entry)
  13149. (t nil))))
  13150. (defun org-diary-to-ical-string (frombuf)
  13151. "Get iCalendar entries from diary entries in buffer FROMBUF.
  13152. This uses the icalendar.el library."
  13153. (let* ((tmpdir (if (featurep 'xemacs)
  13154. (temp-directory)
  13155. temporary-file-directory))
  13156. (tmpfile (make-temp-name
  13157. (expand-file-name "orgics" tmpdir)))
  13158. buf rtn b e)
  13159. (with-current-buffer frombuf
  13160. (icalendar-export-region (point-min) (point-max) tmpfile)
  13161. (setq buf (find-buffer-visiting tmpfile))
  13162. (set-buffer buf)
  13163. (goto-char (point-min))
  13164. (if (re-search-forward "^BEGIN:VEVENT" nil t)
  13165. (setq b (match-beginning 0)))
  13166. (goto-char (point-max))
  13167. (if (re-search-backward "^END:VEVENT" nil t)
  13168. (setq e (match-end 0)))
  13169. (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
  13170. (kill-buffer buf)
  13171. (delete-file tmpfile)
  13172. rtn))
  13173. (defun org-closest-date (start current change prefer show-all)
  13174. "Find the date closest to CURRENT that is consistent with START and CHANGE.
  13175. When PREFER is `past' return a date that is either CURRENT or past.
  13176. When PREFER is `future', return a date that is either CURRENT or future.
  13177. When SHOW-ALL is nil, only return the current occurrence of a time stamp."
  13178. ;; Make the proper lists from the dates
  13179. (catch 'exit
  13180. (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
  13181. dn dw sday cday n1 n2 n0
  13182. d m y y1 y2 date1 date2 nmonths nm ny m2)
  13183. (setq start (org-date-to-gregorian start)
  13184. current (org-date-to-gregorian
  13185. (if show-all
  13186. current
  13187. (time-to-days (current-time))))
  13188. sday (calendar-absolute-from-gregorian start)
  13189. cday (calendar-absolute-from-gregorian current))
  13190. (if (<= cday sday) (throw 'exit sday))
  13191. (if (string-match "\\(\\+[0-9]+\\)\\([dwmy]\\)" change)
  13192. (setq dn (string-to-number (match-string 1 change))
  13193. dw (cdr (assoc (match-string 2 change) a1)))
  13194. (error "Invalid change specifyer: %s" change))
  13195. (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
  13196. (cond
  13197. ((eq dw 'day)
  13198. (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
  13199. n2 (+ n1 dn)))
  13200. ((eq dw 'year)
  13201. (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
  13202. (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
  13203. (setq date1 (list m d y1)
  13204. n1 (calendar-absolute-from-gregorian date1)
  13205. date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
  13206. n2 (calendar-absolute-from-gregorian date2)))
  13207. ((eq dw 'month)
  13208. ;; approx number of month between the two dates
  13209. (setq nmonths (floor (/ (- cday sday) 30.436875)))
  13210. ;; How often does dn fit in there?
  13211. (setq d (nth 1 start) m (car start) y (nth 2 start)
  13212. nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
  13213. m (+ m nm)
  13214. ny (floor (/ m 12))
  13215. y (+ y ny)
  13216. m (- m (* ny 12)))
  13217. (while (> m 12) (setq m (- m 12) y (1+ y)))
  13218. (setq n1 (calendar-absolute-from-gregorian (list m d y)))
  13219. (setq m2 (+ m dn) y2 y)
  13220. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  13221. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
  13222. (while (<= n2 cday)
  13223. (setq n1 n2 m m2 y y2)
  13224. (setq m2 (+ m dn) y2 y)
  13225. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  13226. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
  13227. ;; Make sure n1 is the earlier date
  13228. (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
  13229. (if show-all
  13230. (cond
  13231. ((eq prefer 'past) (if (= cday n2) n2 n1))
  13232. ((eq prefer 'future) (if (= cday n1) n1 n2))
  13233. (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
  13234. (cond
  13235. ((eq prefer 'past) (if (= cday n2) n2 n1))
  13236. ((eq prefer 'future) (if (= cday n1) n1 n2))
  13237. (t (if (= cday n1) n1 n2)))))))
  13238. (defun org-date-to-gregorian (date)
  13239. "Turn any specification of DATE into a gregorian date for the calendar."
  13240. (cond ((integerp date) (calendar-gregorian-from-absolute date))
  13241. ((and (listp date) (= (length date) 3)) date)
  13242. ((stringp date)
  13243. (setq date (org-parse-time-string date))
  13244. (list (nth 4 date) (nth 3 date) (nth 5 date)))
  13245. ((listp date)
  13246. (list (nth 4 date) (nth 3 date) (nth 5 date)))))
  13247. (defun org-parse-time-string (s &optional nodefault)
  13248. "Parse the standard Org-mode time string.
  13249. This should be a lot faster than the normal `parse-time-string'.
  13250. If time is not given, defaults to 0:00. However, with optional NODEFAULT,
  13251. hour and minute fields will be nil if not given."
  13252. (if (string-match org-ts-regexp0 s)
  13253. (list 0
  13254. (if (or (match-beginning 8) (not nodefault))
  13255. (string-to-number (or (match-string 8 s) "0")))
  13256. (if (or (match-beginning 7) (not nodefault))
  13257. (string-to-number (or (match-string 7 s) "0")))
  13258. (string-to-number (match-string 4 s))
  13259. (string-to-number (match-string 3 s))
  13260. (string-to-number (match-string 2 s))
  13261. nil nil nil)
  13262. (error "Not a standard Org-mode time string: %s" s)))
  13263. (defun org-timestamp-up (&optional arg)
  13264. "Increase the date item at the cursor by one.
  13265. If the cursor is on the year, change the year. If it is on the month or
  13266. the day, change that.
  13267. With prefix ARG, change by that many units."
  13268. (interactive "p")
  13269. (org-timestamp-change (prefix-numeric-value arg)))
  13270. (defun org-timestamp-down (&optional arg)
  13271. "Decrease the date item at the cursor by one.
  13272. If the cursor is on the year, change the year. If it is on the month or
  13273. the day, change that.
  13274. With prefix ARG, change by that many units."
  13275. (interactive "p")
  13276. (org-timestamp-change (- (prefix-numeric-value arg))))
  13277. (defun org-timestamp-up-day (&optional arg)
  13278. "Increase the date in the time stamp by one day.
  13279. With prefix ARG, change that many days."
  13280. (interactive "p")
  13281. (if (and (not (org-at-timestamp-p t))
  13282. (org-on-heading-p))
  13283. (org-todo 'up)
  13284. (org-timestamp-change (prefix-numeric-value arg) 'day)))
  13285. (defun org-timestamp-down-day (&optional arg)
  13286. "Decrease the date in the time stamp by one day.
  13287. With prefix ARG, change that many days."
  13288. (interactive "p")
  13289. (if (and (not (org-at-timestamp-p t))
  13290. (org-on-heading-p))
  13291. (org-todo 'down)
  13292. (org-timestamp-change (- (prefix-numeric-value arg)) 'day)))
  13293. (defun org-at-timestamp-p (&optional inactive-ok)
  13294. "Determine if the cursor is in or at a timestamp."
  13295. (interactive)
  13296. (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
  13297. (pos (point))
  13298. (ans (or (looking-at tsr)
  13299. (save-excursion
  13300. (skip-chars-backward "^[<\n\r\t")
  13301. (if (> (point) (point-min)) (backward-char 1))
  13302. (and (looking-at tsr)
  13303. (> (- (match-end 0) pos) -1))))))
  13304. (and ans
  13305. (boundp 'org-ts-what)
  13306. (setq org-ts-what
  13307. (cond
  13308. ((= pos (match-beginning 0)) 'bracket)
  13309. ((= pos (1- (match-end 0))) 'bracket)
  13310. ((org-pos-in-match-range pos 2) 'year)
  13311. ((org-pos-in-match-range pos 3) 'month)
  13312. ((org-pos-in-match-range pos 7) 'hour)
  13313. ((org-pos-in-match-range pos 8) 'minute)
  13314. ((or (org-pos-in-match-range pos 4)
  13315. (org-pos-in-match-range pos 5)) 'day)
  13316. ((and (> pos (or (match-end 8) (match-end 5)))
  13317. (< pos (match-end 0)))
  13318. (- pos (or (match-end 8) (match-end 5))))
  13319. (t 'day))))
  13320. ans))
  13321. (defun org-toggle-timestamp-type ()
  13322. "Toggle the type (<active> or [inactive]) of a time stamp."
  13323. (interactive)
  13324. (when (org-at-timestamp-p t)
  13325. (let ((beg (match-beginning 0)) (end (match-end 0))
  13326. (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
  13327. (save-excursion
  13328. (goto-char beg)
  13329. (while (re-search-forward "[][<>]" end t)
  13330. (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
  13331. t t)))
  13332. (message "Timestamp is now %sactive"
  13333. (if (equal (char-after beg) ?<) "" "in")))))
  13334. (defun org-timestamp-change (n &optional what)
  13335. "Change the date in the time stamp at point.
  13336. The date will be changed by N times WHAT. WHAT can be `day', `month',
  13337. `year', `minute', `second'. If WHAT is not given, the cursor position
  13338. in the timestamp determines what will be changed."
  13339. (let ((pos (point))
  13340. with-hm inactive
  13341. (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
  13342. org-ts-what
  13343. extra rem
  13344. ts time time0)
  13345. (if (not (org-at-timestamp-p t))
  13346. (error "Not at a timestamp"))
  13347. (if (and (not what) (eq org-ts-what 'bracket))
  13348. (org-toggle-timestamp-type)
  13349. (if (and (not what) (not (eq org-ts-what 'day))
  13350. org-display-custom-times
  13351. (get-text-property (point) 'display)
  13352. (not (get-text-property (1- (point)) 'display)))
  13353. (setq org-ts-what 'day))
  13354. (setq org-ts-what (or what org-ts-what)
  13355. inactive (= (char-after (match-beginning 0)) ?\[)
  13356. ts (match-string 0))
  13357. (replace-match "")
  13358. (if (string-match
  13359. "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?[-+][0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)*\\)[]>]"
  13360. ts)
  13361. (setq extra (match-string 1 ts)))
  13362. (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
  13363. (setq with-hm t))
  13364. (setq time0 (org-parse-time-string ts))
  13365. (when (and (eq org-ts-what 'minute)
  13366. (eq current-prefix-arg nil))
  13367. (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
  13368. (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
  13369. (setcar (cdr time0) (+ (nth 1 time0)
  13370. (if (> n 0) (- rem) (- dm rem))))))
  13371. (setq time
  13372. (encode-time (or (car time0) 0)
  13373. (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
  13374. (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
  13375. (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
  13376. (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
  13377. (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
  13378. (nthcdr 6 time0)))
  13379. (when (and (member org-ts-what '(hour minute))
  13380. extra
  13381. (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
  13382. (setq extra (org-modify-ts-extra
  13383. extra
  13384. (if (eq org-ts-what 'hour) 2 5)
  13385. n dm)))
  13386. (when (integerp org-ts-what)
  13387. (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
  13388. (if (eq what 'calendar)
  13389. (let ((cal-date (org-get-date-from-calendar)))
  13390. (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
  13391. (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
  13392. (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
  13393. (setcar time0 (or (car time0) 0))
  13394. (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
  13395. (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
  13396. (setq time (apply 'encode-time time0))))
  13397. (setq org-last-changed-timestamp
  13398. (org-insert-time-stamp time with-hm inactive nil nil extra))
  13399. (org-clock-update-time-maybe)
  13400. (goto-char pos)
  13401. ;; Try to recenter the calendar window, if any
  13402. (if (and org-calendar-follow-timestamp-change
  13403. (get-buffer-window "*Calendar*" t)
  13404. (memq org-ts-what '(day month year)))
  13405. (org-recenter-calendar (time-to-days time))))))
  13406. (defun org-modify-ts-extra (s pos n dm)
  13407. "Change the different parts of the lead-time and repeat fields in timestamp."
  13408. (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
  13409. ng h m new rem)
  13410. (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
  13411. (cond
  13412. ((or (org-pos-in-match-range pos 2)
  13413. (org-pos-in-match-range pos 3))
  13414. (setq m (string-to-number (match-string 3 s))
  13415. h (string-to-number (match-string 2 s)))
  13416. (if (org-pos-in-match-range pos 2)
  13417. (setq h (+ h n))
  13418. (setq n (* dm (org-no-warnings (signum n))))
  13419. (when (not (= 0 (setq rem (% m dm))))
  13420. (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
  13421. (setq m (+ m n)))
  13422. (if (< m 0) (setq m (+ m 60) h (1- h)))
  13423. (if (> m 59) (setq m (- m 60) h (1+ h)))
  13424. (setq h (min 24 (max 0 h)))
  13425. (setq ng 1 new (format "-%02d:%02d" h m)))
  13426. ((org-pos-in-match-range pos 6)
  13427. (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
  13428. ((org-pos-in-match-range pos 5)
  13429. (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
  13430. ((org-pos-in-match-range pos 9)
  13431. (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
  13432. ((org-pos-in-match-range pos 8)
  13433. (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
  13434. (when ng
  13435. (setq s (concat
  13436. (substring s 0 (match-beginning ng))
  13437. new
  13438. (substring s (match-end ng))))))
  13439. s))
  13440. (defun org-recenter-calendar (date)
  13441. "If the calendar is visible, recenter it to DATE."
  13442. (let* ((win (selected-window))
  13443. (cwin (get-buffer-window "*Calendar*" t))
  13444. (calendar-move-hook nil))
  13445. (when cwin
  13446. (select-window cwin)
  13447. (calendar-goto-date (if (listp date) date
  13448. (calendar-gregorian-from-absolute date)))
  13449. (select-window win))))
  13450. (defun org-goto-calendar (&optional arg)
  13451. "Go to the Emacs calendar at the current date.
  13452. If there is a time stamp in the current line, go to that date.
  13453. A prefix ARG can be used to force the current date."
  13454. (interactive "P")
  13455. (let ((tsr org-ts-regexp) diff
  13456. (calendar-move-hook nil)
  13457. (calendar-view-holidays-initially-flag nil)
  13458. (calendar-view-diary-initially-flag nil))
  13459. (if (or (org-at-timestamp-p)
  13460. (save-excursion
  13461. (beginning-of-line 1)
  13462. (looking-at (concat ".*" tsr))))
  13463. (let ((d1 (time-to-days (current-time)))
  13464. (d2 (time-to-days
  13465. (org-time-string-to-time (match-string 1)))))
  13466. (setq diff (- d2 d1))))
  13467. (calendar)
  13468. (calendar-goto-today)
  13469. (if (and diff (not arg)) (calendar-forward-day diff))))
  13470. (defun org-get-date-from-calendar ()
  13471. "Return a list (month day year) of date at point in calendar."
  13472. (with-current-buffer "*Calendar*"
  13473. (save-match-data
  13474. (calendar-cursor-to-date))))
  13475. (defun org-date-from-calendar ()
  13476. "Insert time stamp corresponding to cursor date in *Calendar* buffer.
  13477. If there is already a time stamp at the cursor position, update it."
  13478. (interactive)
  13479. (if (org-at-timestamp-p t)
  13480. (org-timestamp-change 0 'calendar)
  13481. (let ((cal-date (org-get-date-from-calendar)))
  13482. (org-insert-time-stamp
  13483. (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
  13484. (defun org-minutes-to-hh:mm-string (m)
  13485. "Compute H:MM from a number of minutes."
  13486. (let ((h (/ m 60)))
  13487. (setq m (- m (* 60 h)))
  13488. (format org-time-clocksum-format h m)))
  13489. (defun org-hh:mm-string-to-minutes (s)
  13490. "Convert a string H:MM to a number of minutes.
  13491. If the string is just a number, interpret it as minutes.
  13492. In fact, the first hh:mm or number in the string will be taken,
  13493. there can be extra stuff in the string.
  13494. If no number is found, the return value is 0."
  13495. (cond
  13496. ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
  13497. (+ (* (string-to-number (match-string 1 s)) 60)
  13498. (string-to-number (match-string 2 s))))
  13499. ((string-match "\\([0-9]+\\)" s)
  13500. (string-to-number (match-string 1 s)))
  13501. (t 0)))
  13502. ;;;; Files
  13503. (defun org-save-all-org-buffers ()
  13504. "Save all Org-mode buffers without user confirmation."
  13505. (interactive)
  13506. (message "Saving all Org-mode buffers...")
  13507. (save-some-buffers t 'org-mode-p)
  13508. (when (featurep 'org-id) (org-id-locations-save))
  13509. (message "Saving all Org-mode buffers... done"))
  13510. (defun org-revert-all-org-buffers ()
  13511. "Revert all Org-mode buffers.
  13512. Prompt for confirmation when there are unsaved changes.
  13513. Be sure you know what you are doing before letting this function
  13514. overwrite your changes.
  13515. This function is useful in a setup where one tracks org files
  13516. with a version control system, to revert on one machine after pulling
  13517. changes from another. I believe the procedure must be like this:
  13518. 1. M-x org-save-all-org-buffers
  13519. 2. Pull changes from the other machine, resolve conflicts
  13520. 3. M-x org-revert-all-org-buffers"
  13521. (interactive)
  13522. (unless (yes-or-no-p "Revert all Org buffers from their files? ")
  13523. (error "Abort"))
  13524. (save-excursion
  13525. (save-window-excursion
  13526. (mapc
  13527. (lambda (b)
  13528. (when (and (with-current-buffer b (org-mode-p))
  13529. (with-current-buffer b buffer-file-name))
  13530. (switch-to-buffer b)
  13531. (revert-buffer t 'no-confirm)))
  13532. (buffer-list))
  13533. (when (and (featurep 'org-id) org-id-track-globally)
  13534. (org-id-locations-load)))))
  13535. ;;;; Agenda files
  13536. ;;;###autoload
  13537. (defun org-iswitchb (&optional arg)
  13538. "Use `org-icompleting-read' to prompt for an Org buffer to switch to.
  13539. With a prefix argument, restrict available to files.
  13540. With two prefix arguments, restrict available buffers to agenda files."
  13541. (interactive "P")
  13542. (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
  13543. ((equal arg '(16)) (org-buffer-list 'agenda))
  13544. (t (org-buffer-list)))))
  13545. (switch-to-buffer
  13546. (org-icompleting-read "Org buffer: "
  13547. (mapcar 'list (mapcar 'buffer-name blist))
  13548. nil t))))
  13549. ;;;###autoload
  13550. (defalias 'org-ido-switchb 'org-iswitchb)
  13551. (defun org-buffer-list (&optional predicate exclude-tmp)
  13552. "Return a list of Org buffers.
  13553. PREDICATE can be `export', `files' or `agenda'.
  13554. export restrict the list to Export buffers.
  13555. files restrict the list to buffers visiting Org files.
  13556. agenda restrict the list to buffers visiting agenda files.
  13557. If EXCLUDE-TMP is non-nil, ignore temporary buffers."
  13558. (let* ((bfn nil)
  13559. (agenda-files (and (eq predicate 'agenda)
  13560. (mapcar 'file-truename (org-agenda-files t))))
  13561. (filter
  13562. (cond
  13563. ((eq predicate 'files)
  13564. (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
  13565. ((eq predicate 'export)
  13566. (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
  13567. ((eq predicate 'agenda)
  13568. (lambda (b)
  13569. (with-current-buffer b
  13570. (and (eq major-mode 'org-mode)
  13571. (setq bfn (buffer-file-name b))
  13572. (member (file-truename bfn) agenda-files)))))
  13573. (t (lambda (b) (with-current-buffer b
  13574. (or (eq major-mode 'org-mode)
  13575. (string-match "\*Org .*Export"
  13576. (buffer-name b)))))))))
  13577. (delq nil
  13578. (mapcar
  13579. (lambda(b)
  13580. (if (and (funcall filter b)
  13581. (or (not exclude-tmp)
  13582. (not (string-match "tmp" (buffer-name b)))))
  13583. b
  13584. nil))
  13585. (buffer-list)))))
  13586. (defun org-agenda-files (&optional unrestricted archives)
  13587. "Get the list of agenda files.
  13588. Optional UNRESTRICTED means return the full list even if a restriction
  13589. is currently in place.
  13590. When ARCHIVES is t, include all archive files that are really being
  13591. used by the agenda files. If ARCHIVE is `ifmode', do this only if
  13592. `org-agenda-archives-mode' is t."
  13593. (let ((files
  13594. (cond
  13595. ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
  13596. ((stringp org-agenda-files) (org-read-agenda-file-list))
  13597. ((listp org-agenda-files) org-agenda-files)
  13598. (t (error "Invalid value of `org-agenda-files'")))))
  13599. (setq files (apply 'append
  13600. (mapcar (lambda (f)
  13601. (if (file-directory-p f)
  13602. (directory-files
  13603. f t org-agenda-file-regexp)
  13604. (list f)))
  13605. files)))
  13606. (when org-agenda-skip-unavailable-files
  13607. (setq files (delq nil
  13608. (mapcar (function
  13609. (lambda (file)
  13610. (and (file-readable-p file) file)))
  13611. files))))
  13612. (when (or (eq archives t)
  13613. (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
  13614. (setq files (org-add-archive-files files)))
  13615. files))
  13616. (defun org-edit-agenda-file-list ()
  13617. "Edit the list of agenda files.
  13618. Depending on setup, this either uses customize to edit the variable
  13619. `org-agenda-files', or it visits the file that is holding the list. In the
  13620. latter case, the buffer is set up in a way that saving it automatically kills
  13621. the buffer and restores the previous window configuration."
  13622. (interactive)
  13623. (if (stringp org-agenda-files)
  13624. (let ((cw (current-window-configuration)))
  13625. (find-file org-agenda-files)
  13626. (org-set-local 'org-window-configuration cw)
  13627. (org-add-hook 'after-save-hook
  13628. (lambda ()
  13629. (set-window-configuration
  13630. (prog1 org-window-configuration
  13631. (kill-buffer (current-buffer))))
  13632. (org-install-agenda-files-menu)
  13633. (message "New agenda file list installed"))
  13634. nil 'local)
  13635. (message "%s" (substitute-command-keys
  13636. "Edit list and finish with \\[save-buffer]")))
  13637. (customize-variable 'org-agenda-files)))
  13638. (defun org-store-new-agenda-file-list (list)
  13639. "Set new value for the agenda file list and save it correctly."
  13640. (if (stringp org-agenda-files)
  13641. (let ((fe (org-read-agenda-file-list t)) b u)
  13642. (while (setq b (find-buffer-visiting org-agenda-files))
  13643. (kill-buffer b))
  13644. (with-temp-file org-agenda-files
  13645. (insert
  13646. (mapconcat
  13647. (lambda (f) ;; Keep un-expanded entries.
  13648. (if (setq u (assoc f fe))
  13649. (cdr u)
  13650. f))
  13651. list "\n")
  13652. "\n")))
  13653. (let ((org-mode-hook nil) (org-inhibit-startup t)
  13654. (org-insert-mode-line-in-empty-file nil))
  13655. (setq org-agenda-files list)
  13656. (customize-save-variable 'org-agenda-files org-agenda-files))))
  13657. (defun org-read-agenda-file-list (&optional pair-with-expansion)
  13658. "Read the list of agenda files from a file.
  13659. If PAIR-WITH-EXPANSION is t return pairs with un-expanded
  13660. filenames, used by `org-store-new-agenda-file-list' to write back
  13661. un-expanded file names."
  13662. (when (file-directory-p org-agenda-files)
  13663. (error "`org-agenda-files' cannot be a single directory"))
  13664. (when (stringp org-agenda-files)
  13665. (with-temp-buffer
  13666. (insert-file-contents org-agenda-files)
  13667. (mapcar
  13668. (lambda (f)
  13669. (let ((e (expand-file-name (substitute-in-file-name f)
  13670. org-directory)))
  13671. (if pair-with-expansion
  13672. (cons e f)
  13673. e)))
  13674. (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
  13675. ;;;###autoload
  13676. (defun org-cycle-agenda-files ()
  13677. "Cycle through the files in `org-agenda-files'.
  13678. If the current buffer visits an agenda file, find the next one in the list.
  13679. If the current buffer does not, find the first agenda file."
  13680. (interactive)
  13681. (let* ((fs (org-agenda-files t))
  13682. (files (append fs (list (car fs))))
  13683. (tcf (if buffer-file-name (file-truename buffer-file-name)))
  13684. file)
  13685. (unless files (error "No agenda files"))
  13686. (catch 'exit
  13687. (while (setq file (pop files))
  13688. (if (equal (file-truename file) tcf)
  13689. (when (car files)
  13690. (find-file (car files))
  13691. (throw 'exit t))))
  13692. (find-file (car fs)))
  13693. (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
  13694. (defun org-agenda-file-to-front (&optional to-end)
  13695. "Move/add the current file to the top of the agenda file list.
  13696. If the file is not present in the list, it is added to the front. If it is
  13697. present, it is moved there. With optional argument TO-END, add/move to the
  13698. end of the list."
  13699. (interactive "P")
  13700. (let ((org-agenda-skip-unavailable-files nil)
  13701. (file-alist (mapcar (lambda (x)
  13702. (cons (file-truename x) x))
  13703. (org-agenda-files t)))
  13704. (ctf (file-truename buffer-file-name))
  13705. x had)
  13706. (setq x (assoc ctf file-alist) had x)
  13707. (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
  13708. (if to-end
  13709. (setq file-alist (append (delq x file-alist) (list x)))
  13710. (setq file-alist (cons x (delq x file-alist))))
  13711. (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
  13712. (org-install-agenda-files-menu)
  13713. (message "File %s to %s of agenda file list"
  13714. (if had "moved" "added") (if to-end "end" "front"))))
  13715. (defun org-remove-file (&optional file)
  13716. "Remove current file from the list of files in variable `org-agenda-files'.
  13717. These are the files which are being checked for agenda entries.
  13718. Optional argument FILE means use this file instead of the current."
  13719. (interactive)
  13720. (let* ((org-agenda-skip-unavailable-files nil)
  13721. (file (or file buffer-file-name))
  13722. (true-file (file-truename file))
  13723. (afile (abbreviate-file-name file))
  13724. (files (delq nil (mapcar
  13725. (lambda (x)
  13726. (if (equal true-file
  13727. (file-truename x))
  13728. nil x))
  13729. (org-agenda-files t)))))
  13730. (if (not (= (length files) (length (org-agenda-files t))))
  13731. (progn
  13732. (org-store-new-agenda-file-list files)
  13733. (org-install-agenda-files-menu)
  13734. (message "Removed file: %s" afile))
  13735. (message "File was not in list: %s (not removed)" afile))))
  13736. (defun org-file-menu-entry (file)
  13737. (vector file (list 'find-file file) t))
  13738. (defun org-check-agenda-file (file)
  13739. "Make sure FILE exists. If not, ask user what to do."
  13740. (when (not (file-exists-p file))
  13741. (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
  13742. (abbreviate-file-name file))
  13743. (let ((r (downcase (read-char-exclusive))))
  13744. (cond
  13745. ((equal r ?r)
  13746. (org-remove-file file)
  13747. (throw 'nextfile t))
  13748. (t (error "Abort"))))))
  13749. (defun org-get-agenda-file-buffer (file)
  13750. "Get a buffer visiting FILE. If the buffer needs to be created, add
  13751. it to the list of buffers which might be released later."
  13752. (let ((buf (org-find-base-buffer-visiting file)))
  13753. (if buf
  13754. buf ; just return it
  13755. ;; Make a new buffer and remember it
  13756. (setq buf (find-file-noselect file))
  13757. (if buf (push buf org-agenda-new-buffers))
  13758. buf)))
  13759. (defun org-release-buffers (blist)
  13760. "Release all buffers in list, asking the user for confirmation when needed.
  13761. When a buffer is unmodified, it is just killed. When modified, it is saved
  13762. \(if the user agrees) and then killed."
  13763. (let (buf file)
  13764. (while (setq buf (pop blist))
  13765. (setq file (buffer-file-name buf))
  13766. (when (and (buffer-modified-p buf)
  13767. file
  13768. (y-or-n-p (format "Save file %s? " file)))
  13769. (with-current-buffer buf (save-buffer)))
  13770. (kill-buffer buf))))
  13771. (defun org-prepare-agenda-buffers (files)
  13772. "Create buffers for all agenda files, protect archived trees and comments."
  13773. (interactive)
  13774. (let ((pa '(:org-archived t))
  13775. (pc '(:org-comment t))
  13776. (pall '(:org-archived t :org-comment t))
  13777. (inhibit-read-only t)
  13778. (rea (concat ":" org-archive-tag ":"))
  13779. bmp file re)
  13780. (save-excursion
  13781. (save-restriction
  13782. (while (setq file (pop files))
  13783. (catch 'nextfile
  13784. (if (bufferp file)
  13785. (set-buffer file)
  13786. (org-check-agenda-file file)
  13787. (set-buffer (org-get-agenda-file-buffer file)))
  13788. (widen)
  13789. (setq bmp (buffer-modified-p))
  13790. (org-refresh-category-properties)
  13791. (setq org-todo-keywords-for-agenda
  13792. (append org-todo-keywords-for-agenda org-todo-keywords-1))
  13793. (setq org-done-keywords-for-agenda
  13794. (append org-done-keywords-for-agenda org-done-keywords))
  13795. (setq org-todo-keyword-alist-for-agenda
  13796. (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
  13797. (setq org-drawers-for-agenda
  13798. (append org-drawers-for-agenda org-drawers))
  13799. (setq org-tag-alist-for-agenda
  13800. (append org-tag-alist-for-agenda org-tag-alist))
  13801. (save-excursion
  13802. (remove-text-properties (point-min) (point-max) pall)
  13803. (when org-agenda-skip-archived-trees
  13804. (goto-char (point-min))
  13805. (while (re-search-forward rea nil t)
  13806. (if (org-on-heading-p t)
  13807. (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
  13808. (goto-char (point-min))
  13809. (setq re (concat "^\\*+ +" org-comment-string "\\>"))
  13810. (while (re-search-forward re nil t)
  13811. (add-text-properties
  13812. (match-beginning 0) (org-end-of-subtree t) pc)))
  13813. (set-buffer-modified-p bmp)))))
  13814. (setq org-todo-keywords-for-agenda
  13815. (org-uniquify org-todo-keywords-for-agenda))
  13816. (setq org-todo-keyword-alist-for-agenda
  13817. (org-uniquify org-todo-keyword-alist-for-agenda)
  13818. org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
  13819. ;;;; Embedded LaTeX
  13820. (defvar org-cdlatex-mode-map (make-sparse-keymap)
  13821. "Keymap for the minor `org-cdlatex-mode'.")
  13822. (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
  13823. (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
  13824. (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
  13825. (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
  13826. (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
  13827. (defvar org-cdlatex-texmathp-advice-is-done nil
  13828. "Flag remembering if we have applied the advice to texmathp already.")
  13829. (define-minor-mode org-cdlatex-mode
  13830. "Toggle the minor `org-cdlatex-mode'.
  13831. This mode supports entering LaTeX environment and math in LaTeX fragments
  13832. in Org-mode.
  13833. \\{org-cdlatex-mode-map}"
  13834. nil " OCDL" nil
  13835. (when org-cdlatex-mode (require 'cdlatex))
  13836. (unless org-cdlatex-texmathp-advice-is-done
  13837. (setq org-cdlatex-texmathp-advice-is-done t)
  13838. (defadvice texmathp (around org-math-always-on activate)
  13839. "Always return t in org-mode buffers.
  13840. This is because we want to insert math symbols without dollars even outside
  13841. the LaTeX math segments. If Orgmode thinks that point is actually inside
  13842. an embedded LaTeX fragment, let texmathp do its job.
  13843. \\[org-cdlatex-mode-map]"
  13844. (interactive)
  13845. (let (p)
  13846. (cond
  13847. ((not (org-mode-p)) ad-do-it)
  13848. ((eq this-command 'cdlatex-math-symbol)
  13849. (setq ad-return-value t
  13850. texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
  13851. (t
  13852. (let ((p (org-inside-LaTeX-fragment-p)))
  13853. (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
  13854. (setq ad-return-value t
  13855. texmathp-why '("Org-mode embedded math" . 0))
  13856. (if p ad-do-it)))))))))
  13857. (defun turn-on-org-cdlatex ()
  13858. "Unconditionally turn on `org-cdlatex-mode'."
  13859. (org-cdlatex-mode 1))
  13860. (defun org-inside-LaTeX-fragment-p ()
  13861. "Test if point is inside a LaTeX fragment.
  13862. I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
  13863. sequence appearing also before point.
  13864. Even though the matchers for math are configurable, this function assumes
  13865. that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
  13866. delimiters are skipped when they have been removed by customization.
  13867. The return value is nil, or a cons cell with the delimiter and
  13868. and the position of this delimiter.
  13869. This function does a reasonably good job, but can locally be fooled by
  13870. for example currency specifications. For example it will assume being in
  13871. inline math after \"$22.34\". The LaTeX fragment formatter will only format
  13872. fragments that are properly closed, but during editing, we have to live
  13873. with the uncertainty caused by missing closing delimiters. This function
  13874. looks only before point, not after."
  13875. (catch 'exit
  13876. (let ((pos (point))
  13877. (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
  13878. (lim (progn
  13879. (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
  13880. (point)))
  13881. dd-on str (start 0) m re)
  13882. (goto-char pos)
  13883. (when dodollar
  13884. (setq str (concat (buffer-substring lim (point)) "\000 X$.")
  13885. re (nth 1 (assoc "$" org-latex-regexps)))
  13886. (while (string-match re str start)
  13887. (cond
  13888. ((= (match-end 0) (length str))
  13889. (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
  13890. ((= (match-end 0) (- (length str) 5))
  13891. (throw 'exit nil))
  13892. (t (setq start (match-end 0))))))
  13893. (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
  13894. (goto-char pos)
  13895. (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
  13896. (and (match-beginning 2) (throw 'exit nil))
  13897. ;; count $$
  13898. (while (re-search-backward "\\$\\$" lim t)
  13899. (setq dd-on (not dd-on)))
  13900. (goto-char pos)
  13901. (if dd-on (cons "$$" m))))))
  13902. (defun org-inside-latex-macro-p ()
  13903. "Is point inside a LaTeX macro or its arguments?"
  13904. (save-match-data
  13905. (org-in-regexp
  13906. "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
  13907. (defun test ()
  13908. (interactive)
  13909. (message "%s" (org-inside-latex-macro-p)))
  13910. (defun org-try-cdlatex-tab ()
  13911. "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
  13912. It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
  13913. - inside a LaTeX fragment, or
  13914. - after the first word in a line, where an abbreviation expansion could
  13915. insert a LaTeX environment."
  13916. (when org-cdlatex-mode
  13917. (cond
  13918. ((save-excursion
  13919. (skip-chars-backward "a-zA-Z0-9*")
  13920. (skip-chars-backward " \t")
  13921. (bolp))
  13922. (cdlatex-tab) t)
  13923. ((org-inside-LaTeX-fragment-p)
  13924. (cdlatex-tab) t)
  13925. (t nil))))
  13926. (defun org-cdlatex-underscore-caret (&optional arg)
  13927. "Execute `cdlatex-sub-superscript' in LaTeX fragments.
  13928. Revert to the normal definition outside of these fragments."
  13929. (interactive "P")
  13930. (if (org-inside-LaTeX-fragment-p)
  13931. (call-interactively 'cdlatex-sub-superscript)
  13932. (let (org-cdlatex-mode)
  13933. (call-interactively (key-binding (vector last-input-event))))))
  13934. (defun org-cdlatex-math-modify (&optional arg)
  13935. "Execute `cdlatex-math-modify' in LaTeX fragments.
  13936. Revert to the normal definition outside of these fragments."
  13937. (interactive "P")
  13938. (if (org-inside-LaTeX-fragment-p)
  13939. (call-interactively 'cdlatex-math-modify)
  13940. (let (org-cdlatex-mode)
  13941. (call-interactively (key-binding (vector last-input-event))))))
  13942. (defvar org-latex-fragment-image-overlays nil
  13943. "List of overlays carrying the images of latex fragments.")
  13944. (make-variable-buffer-local 'org-latex-fragment-image-overlays)
  13945. (defun org-remove-latex-fragment-image-overlays ()
  13946. "Remove all overlays with LaTeX fragment images in current buffer."
  13947. (mapc 'delete-overlay org-latex-fragment-image-overlays)
  13948. (setq org-latex-fragment-image-overlays nil))
  13949. (defun org-preview-latex-fragment (&optional subtree)
  13950. "Preview the LaTeX fragment at point, or all locally or globally.
  13951. If the cursor is in a LaTeX fragment, create the image and overlay
  13952. it over the source code. If there is no fragment at point, display
  13953. all fragments in the current text, from one headline to the next. With
  13954. prefix SUBTREE, display all fragments in the current subtree. With a
  13955. double prefix `C-u C-u', or when the cursor is before the first headline,
  13956. display all fragments in the buffer.
  13957. The images can be removed again with \\[org-ctrl-c-ctrl-c]."
  13958. (interactive "P")
  13959. (org-remove-latex-fragment-image-overlays)
  13960. (save-excursion
  13961. (save-restriction
  13962. (let (beg end at msg)
  13963. (cond
  13964. ((or (equal subtree '(16))
  13965. (not (save-excursion
  13966. (re-search-backward (concat "^" outline-regexp) nil t))))
  13967. (setq beg (point-min) end (point-max)
  13968. msg "Creating images for buffer...%s"))
  13969. ((equal subtree '(4))
  13970. (org-back-to-heading)
  13971. (setq beg (point) end (org-end-of-subtree t)
  13972. msg "Creating images for subtree...%s"))
  13973. (t
  13974. (if (setq at (org-inside-LaTeX-fragment-p))
  13975. (goto-char (max (point-min) (- (cdr at) 2)))
  13976. (org-back-to-heading))
  13977. (setq beg (point) end (progn (outline-next-heading) (point))
  13978. msg (if at "Creating image...%s"
  13979. "Creating images for entry...%s"))))
  13980. (message msg "")
  13981. (narrow-to-region beg end)
  13982. (goto-char beg)
  13983. (org-format-latex
  13984. (concat "ltxpng/" (file-name-sans-extension
  13985. (file-name-nondirectory
  13986. buffer-file-name)))
  13987. default-directory 'overlays msg at 'forbuffer)
  13988. (message msg "done. Use `C-c C-c' to remove images.")))))
  13989. (defvar org-latex-regexps
  13990. '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
  13991. ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
  13992. ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
  13993. ("$1" "\\([^$]\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  13994. ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  13995. ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
  13996. ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
  13997. ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
  13998. "Regular expressions for matching embedded LaTeX.")
  13999. (defun org-format-latex (prefix &optional dir overlays msg at forbuffer)
  14000. "Replace LaTeX fragments with links to an image, and produce images.
  14001. Some of the options can be changed using the variable
  14002. `org-format-latex-options'."
  14003. (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
  14004. (let* ((prefixnodir (file-name-nondirectory prefix))
  14005. (absprefix (expand-file-name prefix dir))
  14006. (todir (file-name-directory absprefix))
  14007. (opt org-format-latex-options)
  14008. (matchers (plist-get opt :matchers))
  14009. (re-list org-latex-regexps)
  14010. (org-format-latex-header-extra
  14011. (plist-get (org-infile-export-plist) :latex-header-extra))
  14012. (cnt 0) txt hash link beg end re e checkdir
  14013. executables-checked
  14014. m n block linkfile movefile ov)
  14015. ;; Check the different regular expressions
  14016. (while (setq e (pop re-list))
  14017. (setq m (car e) re (nth 1 e) n (nth 2 e)
  14018. block (if (nth 3 e) "\n\n" ""))
  14019. (when (member m matchers)
  14020. (goto-char (point-min))
  14021. (while (re-search-forward re nil t)
  14022. (when (and (or (not at) (equal (cdr at) (match-beginning n)))
  14023. (not (get-text-property (match-beginning n)
  14024. 'org-protected))
  14025. (or (not overlays)
  14026. (not (eq (get-char-property (match-beginning n)
  14027. 'org-overlay-type)
  14028. 'org-latex-overlay))))
  14029. (setq txt (match-string n)
  14030. beg (match-beginning n) end (match-end n)
  14031. cnt (1+ cnt))
  14032. (let (print-length print-level) ; make sure full list is printed
  14033. (setq hash (sha1 (prin1-to-string
  14034. (list org-format-latex-header
  14035. org-format-latex-header-extra
  14036. org-export-latex-default-packages-alist
  14037. org-export-latex-packages-alist
  14038. org-format-latex-options
  14039. forbuffer txt)))
  14040. linkfile (format "%s_%s.png" prefix hash)
  14041. movefile (format "%s_%s.png" absprefix hash)))
  14042. (setq link (concat block "[[file:" linkfile "]]" block))
  14043. (if msg (message msg cnt))
  14044. (goto-char beg)
  14045. (unless checkdir ; make sure the directory exists
  14046. (setq checkdir t)
  14047. (or (file-directory-p todir) (make-directory todir)))
  14048. (unless executables-checked
  14049. (org-check-external-command
  14050. "latex" "needed to convert LaTeX fragments to images")
  14051. (org-check-external-command
  14052. "dvipng" "needed to convert LaTeX fragments to images")
  14053. (setq executables-checked t))
  14054. (unless (file-exists-p movefile)
  14055. (org-create-formula-image
  14056. txt movefile opt forbuffer))
  14057. (if overlays
  14058. (progn
  14059. (mapc (lambda (o)
  14060. (if (eq (overlay-get o 'org-overlay-type)
  14061. 'org-latex-overlay)
  14062. (delete-overlay o)))
  14063. (overlays-in beg end))
  14064. (setq ov (make-overlay beg end))
  14065. (overlay-put ov 'org-overlay-type 'org-latex-overlay)
  14066. (if (featurep 'xemacs)
  14067. (progn
  14068. (overlay-put ov 'invisible t)
  14069. (overlay-put
  14070. ov 'end-glyph
  14071. (make-glyph (vector 'png :file movefile))))
  14072. (overlay-put
  14073. ov 'display
  14074. (list 'image :type 'png :file movefile :ascent 'center)))
  14075. (push ov org-latex-fragment-image-overlays)
  14076. (goto-char end))
  14077. (delete-region beg end)
  14078. (insert (org-add-props link
  14079. (list 'org-latex-src
  14080. (replace-regexp-in-string "\"" "" txt)))))))))))
  14081. ;; This function borrows from Ganesh Swami's latex2png.el
  14082. (defun org-create-formula-image (string tofile options buffer)
  14083. "This calls dvipng."
  14084. (require 'org-latex)
  14085. (let* ((tmpdir (if (featurep 'xemacs)
  14086. (temp-directory)
  14087. temporary-file-directory))
  14088. (texfilebase (make-temp-name
  14089. (expand-file-name "orgtex" tmpdir)))
  14090. (texfile (concat texfilebase ".tex"))
  14091. (dvifile (concat texfilebase ".dvi"))
  14092. (pngfile (concat texfilebase ".png"))
  14093. (fnh (if (featurep 'xemacs)
  14094. (font-height (get-face-font 'default))
  14095. (face-attribute 'default :height nil)))
  14096. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  14097. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  14098. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  14099. "Black"))
  14100. (bg (or (plist-get options (if buffer :background :html-background))
  14101. "Transparent")))
  14102. (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
  14103. (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
  14104. (with-temp-file texfile
  14105. (insert (org-splice-latex-header
  14106. org-format-latex-header
  14107. org-export-latex-default-packages-alist
  14108. org-export-latex-packages-alist t
  14109. org-format-latex-header-extra))
  14110. (insert "\n\\begin{document}\n" string "\n\\end{document}\n")
  14111. (require 'org-latex)
  14112. (org-export-latex-fix-inputenc))
  14113. (let ((dir default-directory))
  14114. (condition-case nil
  14115. (progn
  14116. (cd tmpdir)
  14117. (call-process "latex" nil nil nil texfile))
  14118. (error nil))
  14119. (cd dir))
  14120. (if (not (file-exists-p dvifile))
  14121. (progn (message "Failed to create dvi file from %s" texfile) nil)
  14122. (condition-case nil
  14123. (call-process "dvipng" nil nil nil
  14124. "-fg" fg "-bg" bg
  14125. "-D" dpi
  14126. ;;"-x" scale "-y" scale
  14127. "-T" "tight"
  14128. "-o" pngfile
  14129. dvifile)
  14130. (error nil))
  14131. (if (not (file-exists-p pngfile))
  14132. (if org-format-latex-signal-error
  14133. (error "Failed to create png file from %s" texfile)
  14134. (message "Failed to create png file from %s" texfile)
  14135. nil)
  14136. ;; Use the requested file name and clean up
  14137. (copy-file pngfile tofile 'replace)
  14138. (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
  14139. (delete-file (concat texfilebase e)))
  14140. pngfile))))
  14141. (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
  14142. "Fill a LaTeX header template TPL.
  14143. In the template, the following place holders will be recognized:
  14144. [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
  14145. [NO-DEFAULT-PACKAGES] do not include DEF-PKG
  14146. [PACKAGES] \\usepackage statements for PKG
  14147. [NO-PACKAGES] do not include PKG
  14148. [EXTRA] the string EXTRA
  14149. [NO-EXTRA] do not include EXTRA
  14150. For backward compatibility, if both the positive and the negative place
  14151. holder is missing, the positive one (without the \"NO-\") will be
  14152. assumed to be present at the end of the template.
  14153. DEF-PKG and PKG are assumed to be alists of options/packagename lists.
  14154. EXTRA is a string.
  14155. SNIPPETS-P indicates if this is run to create snippet images for HTML."
  14156. (let (rpl (end ""))
  14157. (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
  14158. (setq rpl (if (or (match-end 1) (not def-pkg))
  14159. "" (org-latex-packages-to-string def-pkg snippets-p t))
  14160. tpl (replace-match rpl t t tpl))
  14161. (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
  14162. (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
  14163. (setq rpl (if (or (match-end 1) (not pkg))
  14164. "" (org-latex-packages-to-string pkg snippets-p t))
  14165. tpl (replace-match rpl t t tpl))
  14166. (if pkg (setq end
  14167. (concat end "\n"
  14168. (org-latex-packages-to-string pkg snippets-p)))))
  14169. (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
  14170. (setq rpl (if (or (match-end 1) (not extra))
  14171. "" (concat extra "\n"))
  14172. tpl (replace-match rpl t t tpl))
  14173. (if (and extra (string-match "\\S-" extra))
  14174. (setq end (concat end "\n" extra))))
  14175. (if (string-match "\\S-" end)
  14176. (concat tpl "\n" end)
  14177. tpl)))
  14178. (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
  14179. "Turn an alist of packages into a string with the \\usepackage macros."
  14180. (setq pkg (mapconcat (lambda(p)
  14181. (cond
  14182. ((stringp p) p)
  14183. ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
  14184. (format "%% Package %s omitted" (cadr p)))
  14185. ((equal "" (car p))
  14186. (format "\\usepackage{%s}" (cadr p)))
  14187. (t
  14188. (format "\\usepackage[%s]{%s}"
  14189. (car p) (cadr p)))))
  14190. pkg
  14191. "\n"))
  14192. (if newline (concat pkg "\n") pkg))
  14193. (defun org-dvipng-color (attr)
  14194. "Return an rgb color specification for dvipng."
  14195. (apply 'format "rgb %s %s %s"
  14196. (mapcar 'org-normalize-color
  14197. (color-values (face-attribute 'default attr nil)))))
  14198. (defun org-normalize-color (value)
  14199. "Return string to be used as color value for an RGB component."
  14200. (format "%g" (/ value 65535.0)))
  14201. ;; Image display
  14202. (defvar org-inline-image-overlays nil)
  14203. (make-variable-buffer-local 'org-inline-image-overlays)
  14204. (defun org-toggle-inline-images (&optional include-linked)
  14205. "Toggle the display of inline images.
  14206. INCLUDE-LINKED is passed to `org-display-inline-images'."
  14207. (interactive "P")
  14208. (if org-inline-image-overlays
  14209. (progn
  14210. (org-remove-inline-images)
  14211. (message "Inline image display turned off"))
  14212. (org-display-inline-images include-linked)
  14213. (if org-inline-image-overlays
  14214. (message "%d images displayed inline"
  14215. (length org-inline-image-overlays))
  14216. (message "No images to display inline"))))
  14217. (defun org-display-inline-images (&optional include-linked refresh beg end)
  14218. "Display inline images.
  14219. Normally only links without a description part are inlined, because this
  14220. is how it will work for export. When INCLUDE-LINKED is set, also links
  14221. with a description part will be inlined. This can be nice for a quick
  14222. look at those images, but it does not reflect whatexported files will look
  14223. like.
  14224. When REFRESH is set, refresh existing images between BEG and END.
  14225. This will create new image displays only if necessary.
  14226. BEG and END default to the buffer boundaries."
  14227. (interactive "P")
  14228. (unless refresh
  14229. (org-remove-inline-images)
  14230. (clear-image-cache))
  14231. (save-excursion
  14232. (save-restriction
  14233. (widen)
  14234. (setq beg (or beg (point-min)) end (or end (point-max)))
  14235. (goto-char (point-min))
  14236. (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([-+~./_0-9a-zA-Z]+"
  14237. (substring (org-image-file-name-regexp) 0 -2)
  14238. "\\)\\]" (if include-linked "" "\\]")))
  14239. file ov img)
  14240. (while (re-search-forward re end t)
  14241. (setq old (get-char-property-and-overlay (match-beginning 1)
  14242. 'org-image-overlay))
  14243. (setq file (expand-file-name
  14244. (concat (or (match-string 3) "") (match-string 4))))
  14245. (when (file-exists-p file)
  14246. (if (and (car-safe old) refresh)
  14247. (image-refresh (overlay-get (cdr old) 'display))
  14248. (setq img (create-image file))
  14249. (when img
  14250. (setq ov (make-overlay (match-beginning 0) (match-end 0)))
  14251. (overlay-put ov 'display img)
  14252. (overlay-put ov 'face 'default)
  14253. (overlay-put ov 'org-image-overlay t)
  14254. (push ov org-inline-image-overlays)))))))))
  14255. (defun org-remove-inline-images ()
  14256. "Remove inline display of images."
  14257. (interactive)
  14258. (mapc 'delete-overlay org-inline-image-overlays)
  14259. (setq org-inline-image-overlays nil))
  14260. ;;;; Key bindings
  14261. ;; Make `C-c C-x' a prefix key
  14262. (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
  14263. ;; TAB key with modifiers
  14264. (org-defkey org-mode-map "\C-i" 'org-cycle)
  14265. (org-defkey org-mode-map [(tab)] 'org-cycle)
  14266. (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
  14267. (org-defkey org-mode-map [(meta tab)] 'org-complete)
  14268. (org-defkey org-mode-map "\M-\t" 'org-complete)
  14269. (org-defkey org-mode-map "\M-\C-i" 'org-complete)
  14270. ;; The following line is necessary under Suse GNU/Linux
  14271. (unless (featurep 'xemacs)
  14272. (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
  14273. (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
  14274. (define-key org-mode-map [backtab] 'org-shifttab)
  14275. (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
  14276. (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
  14277. (org-defkey org-mode-map [(meta return)] 'org-meta-return)
  14278. ;; Cursor keys with modifiers
  14279. (org-defkey org-mode-map [(meta left)] 'org-metaleft)
  14280. (org-defkey org-mode-map [(meta right)] 'org-metaright)
  14281. (org-defkey org-mode-map [(meta up)] 'org-metaup)
  14282. (org-defkey org-mode-map [(meta down)] 'org-metadown)
  14283. (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
  14284. (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
  14285. (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
  14286. (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
  14287. (org-defkey org-mode-map [(shift up)] 'org-shiftup)
  14288. (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
  14289. (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
  14290. (org-defkey org-mode-map [(shift right)] 'org-shiftright)
  14291. (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
  14292. (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
  14293. ;;; Extra keys for tty access.
  14294. ;; We only set them when really needed because otherwise the
  14295. ;; menus don't show the simple keys
  14296. (when (or org-use-extra-keys
  14297. (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
  14298. (not window-system))
  14299. (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
  14300. (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
  14301. (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
  14302. (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
  14303. (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
  14304. (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
  14305. (org-defkey org-mode-map [?\e (right)] 'org-metaright)
  14306. (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
  14307. (org-defkey org-mode-map [?\e (up)] 'org-metaup)
  14308. (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
  14309. (org-defkey org-mode-map [?\e (down)] 'org-metadown)
  14310. (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
  14311. (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
  14312. (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
  14313. (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
  14314. (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
  14315. (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
  14316. (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
  14317. (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
  14318. (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
  14319. (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
  14320. (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
  14321. (org-defkey org-mode-map [?\e (tab)] 'org-complete)
  14322. (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
  14323. (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
  14324. (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
  14325. (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
  14326. (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
  14327. ;; All the other keys
  14328. (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
  14329. (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
  14330. (if (boundp 'narrow-map)
  14331. (org-defkey narrow-map "s" 'org-narrow-to-subtree)
  14332. (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
  14333. (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
  14334. (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
  14335. (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
  14336. (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
  14337. (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
  14338. (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
  14339. (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
  14340. (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
  14341. (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
  14342. (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
  14343. (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
  14344. (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
  14345. (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
  14346. (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
  14347. (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
  14348. (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
  14349. (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
  14350. (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
  14351. (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
  14352. (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
  14353. (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
  14354. (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
  14355. (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
  14356. (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
  14357. (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
  14358. (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
  14359. (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
  14360. (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
  14361. (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
  14362. (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
  14363. (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
  14364. (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
  14365. (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
  14366. (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
  14367. (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
  14368. (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
  14369. (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
  14370. (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
  14371. (org-defkey org-mode-map "\C-c]" 'org-remove-file)
  14372. (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
  14373. (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  14374. (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
  14375. (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
  14376. (org-defkey org-mode-map "\C-c^" 'org-sort)
  14377. (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
  14378. (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
  14379. (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
  14380. (org-defkey org-mode-map "\C-m" 'org-return)
  14381. (org-defkey org-mode-map "\C-j" 'org-return-indent)
  14382. (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
  14383. (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
  14384. (org-defkey org-mode-map "\C-c+" 'org-table-sum)
  14385. (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
  14386. (org-defkey org-mode-map "\C-c'" 'org-edit-special)
  14387. (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
  14388. (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
  14389. (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
  14390. (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
  14391. (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
  14392. (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
  14393. (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
  14394. (org-defkey org-mode-map "\C-c\C-e" 'org-export)
  14395. (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
  14396. (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
  14397. (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
  14398. (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  14399. (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  14400. (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
  14401. ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
  14402. (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
  14403. (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
  14404. (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
  14405. (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
  14406. (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
  14407. (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
  14408. (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
  14409. (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  14410. (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
  14411. (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
  14412. (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
  14413. (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
  14414. (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
  14415. (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
  14416. (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
  14417. (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
  14418. (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
  14419. (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
  14420. (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
  14421. (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
  14422. (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
  14423. (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
  14424. (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
  14425. (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
  14426. (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
  14427. (define-key org-mode-map "\C-c\C-x!" 'org-reload)
  14428. (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
  14429. (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
  14430. (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
  14431. (when (featurep 'xemacs)
  14432. (org-defkey org-mode-map 'button3 'popup-mode-menu))
  14433. (defconst org-speed-commands-default
  14434. '(
  14435. ("Outline Navigation")
  14436. ("n" . (org-speed-move-safe 'outline-next-visible-heading))
  14437. ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
  14438. ("f" . (org-speed-move-safe 'org-forward-same-level))
  14439. ("b" . (org-speed-move-safe 'org-backward-same-level))
  14440. ("u" . (org-speed-move-safe 'outline-up-heading))
  14441. ("j" . org-goto)
  14442. ("g" . (org-refile t))
  14443. ("Outline Visibility")
  14444. ("c" . org-cycle)
  14445. ("C" . org-shifttab)
  14446. (" " . org-display-outline-path)
  14447. ("Outline Structure Editing")
  14448. ("U" . org-shiftmetaup)
  14449. ("D" . org-shiftmetadown)
  14450. ("r" . org-metaright)
  14451. ("l" . org-metaleft)
  14452. ("R" . org-shiftmetaright)
  14453. ("L" . org-shiftmetaleft)
  14454. ("i" . (progn (forward-char 1) (call-interactively
  14455. 'org-insert-heading-respect-content)))
  14456. ("^" . org-sort)
  14457. ("w" . org-refile)
  14458. ("a" . org-archive-subtree-default-with-confirmation)
  14459. ("." . outline-mark-subtree)
  14460. ("Clock Commands")
  14461. ("I" . org-clock-in)
  14462. ("O" . org-clock-out)
  14463. ("Meta Data Editing")
  14464. ("t" . org-todo)
  14465. ("0" . (org-priority ?\ ))
  14466. ("1" . (org-priority ?A))
  14467. ("2" . (org-priority ?B))
  14468. ("3" . (org-priority ?C))
  14469. (";" . org-set-tags-command)
  14470. ("e" . org-set-effort)
  14471. ("Agenda Views etc")
  14472. ("v" . org-agenda)
  14473. ("/" . org-sparse-tree)
  14474. ("Misc")
  14475. ("o" . org-open-at-point)
  14476. ("?" . org-speed-command-help)
  14477. )
  14478. "The default speed commands.")
  14479. (defun org-print-speed-command (e)
  14480. (if (> (length (car e)) 1)
  14481. (progn
  14482. (princ "\n")
  14483. (princ (car e))
  14484. (princ "\n")
  14485. (princ (make-string (length (car e)) ?-))
  14486. (princ "\n"))
  14487. (princ (car e))
  14488. (princ " ")
  14489. (if (symbolp (cdr e))
  14490. (princ (symbol-name (cdr e)))
  14491. (prin1 (cdr e)))
  14492. (princ "\n")))
  14493. (defun org-speed-command-help ()
  14494. "Show the available speed commands."
  14495. (interactive)
  14496. (if (not org-use-speed-commands)
  14497. (error "Speed commands are not activated, customize `org-use-speed-commands'.")
  14498. (with-output-to-temp-buffer "*Help*"
  14499. (princ "User-defined Speed commands\n===========================\n")
  14500. (mapc 'org-print-speed-command org-speed-commands-user)
  14501. (princ "\n")
  14502. (princ "Built-in Speed commands\n=======================\n")
  14503. (mapc 'org-print-speed-command org-speed-commands-default))
  14504. (with-current-buffer "*Help*"
  14505. (setq truncate-lines t))))
  14506. (defun org-speed-move-safe (cmd)
  14507. "Execute CMD, but make sure that the cursor always ends up in a headline.
  14508. If not, return to the original position and throw an error."
  14509. (interactive)
  14510. (let ((pos (point)))
  14511. (call-interactively cmd)
  14512. (unless (and (bolp) (org-on-heading-p))
  14513. (goto-char pos)
  14514. (error "Boundary reached while executing %s" cmd))))
  14515. (defvar org-self-insert-command-undo-counter 0)
  14516. (defvar org-table-auto-blank-field) ; defined in org-table.el
  14517. (defvar org-speed-command nil)
  14518. (defun org-self-insert-command (N)
  14519. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  14520. If the cursor is in a table looking at whitespace, the whitespace is
  14521. overwritten, and the table is not marked as requiring realignment."
  14522. (interactive "p")
  14523. (cond
  14524. ((and org-use-speed-commands
  14525. (or (and (bolp) (looking-at outline-regexp))
  14526. (and (functionp org-use-speed-commands)
  14527. (funcall org-use-speed-commands)))
  14528. (setq
  14529. org-speed-command
  14530. (or (cdr (assoc (this-command-keys) org-speed-commands-user))
  14531. (cdr (assoc (this-command-keys) org-speed-commands-default)))))
  14532. (cond
  14533. ((commandp org-speed-command)
  14534. (setq this-command org-speed-command)
  14535. (call-interactively org-speed-command))
  14536. ((functionp org-speed-command)
  14537. (funcall org-speed-command))
  14538. ((and org-speed-command (listp org-speed-command))
  14539. (eval org-speed-command))
  14540. (t (let (org-use-speed-commands)
  14541. (call-interactively 'org-self-insert-command)))))
  14542. ((and
  14543. (org-table-p)
  14544. (progn
  14545. ;; check if we blank the field, and if that triggers align
  14546. (and (featurep 'org-table) org-table-auto-blank-field
  14547. (member last-command
  14548. '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
  14549. (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
  14550. ;; got extra space, this field does not determine column width
  14551. (let (org-table-may-need-update) (org-table-blank-field))
  14552. ;; no extra space, this field may determine column width
  14553. (org-table-blank-field)))
  14554. t)
  14555. (eq N 1)
  14556. (looking-at "[^|\n]* |"))
  14557. (let (org-table-may-need-update)
  14558. (goto-char (1- (match-end 0)))
  14559. (delete-backward-char 1)
  14560. (goto-char (match-beginning 0))
  14561. (self-insert-command N)))
  14562. (t
  14563. (setq org-table-may-need-update t)
  14564. (self-insert-command N)
  14565. (org-fix-tags-on-the-fly)
  14566. (if org-self-insert-cluster-for-undo
  14567. (if (not (eq last-command 'org-self-insert-command))
  14568. (setq org-self-insert-command-undo-counter 1)
  14569. (if (>= org-self-insert-command-undo-counter 20)
  14570. (setq org-self-insert-command-undo-counter 1)
  14571. (and (> org-self-insert-command-undo-counter 0)
  14572. buffer-undo-list
  14573. (not (cadr buffer-undo-list)) ; remove nil entry
  14574. (setcdr buffer-undo-list (cddr buffer-undo-list)))
  14575. (setq org-self-insert-command-undo-counter
  14576. (1+ org-self-insert-command-undo-counter))))))))
  14577. (defun org-fix-tags-on-the-fly ()
  14578. (when (and (equal (char-after (point-at-bol)) ?*)
  14579. (org-on-heading-p))
  14580. (org-align-tags-here org-tags-column)))
  14581. (defun org-delete-backward-char (N)
  14582. "Like `delete-backward-char', insert whitespace at field end in tables.
  14583. When deleting backwards, in tables this function will insert whitespace in
  14584. front of the next \"|\" separator, to keep the table aligned. The table will
  14585. still be marked for re-alignment if the field did fill the entire column,
  14586. because, in this case the deletion might narrow the column."
  14587. (interactive "p")
  14588. (if (and (org-table-p)
  14589. (eq N 1)
  14590. (string-match "|" (buffer-substring (point-at-bol) (point)))
  14591. (looking-at ".*?|"))
  14592. (let ((pos (point))
  14593. (noalign (looking-at "[^|\n\r]* |"))
  14594. (c org-table-may-need-update))
  14595. (backward-delete-char N)
  14596. (skip-chars-forward "^|")
  14597. (insert " ")
  14598. (goto-char (1- pos))
  14599. ;; noalign: if there were two spaces at the end, this field
  14600. ;; does not determine the width of the column.
  14601. (if noalign (setq org-table-may-need-update c)))
  14602. (backward-delete-char N)
  14603. (org-fix-tags-on-the-fly)))
  14604. (defun org-delete-char (N)
  14605. "Like `delete-char', but insert whitespace at field end in tables.
  14606. When deleting characters, in tables this function will insert whitespace in
  14607. front of the next \"|\" separator, to keep the table aligned. The table will
  14608. still be marked for re-alignment if the field did fill the entire column,
  14609. because, in this case the deletion might narrow the column."
  14610. (interactive "p")
  14611. (if (and (org-table-p)
  14612. (not (bolp))
  14613. (not (= (char-after) ?|))
  14614. (eq N 1))
  14615. (if (looking-at ".*?|")
  14616. (let ((pos (point))
  14617. (noalign (looking-at "[^|\n\r]* |"))
  14618. (c org-table-may-need-update))
  14619. (replace-match (concat
  14620. (substring (match-string 0) 1 -1)
  14621. " |"))
  14622. (goto-char pos)
  14623. ;; noalign: if there were two spaces at the end, this field
  14624. ;; does not determine the width of the column.
  14625. (if noalign (setq org-table-may-need-update c)))
  14626. (delete-char N))
  14627. (delete-char N)
  14628. (org-fix-tags-on-the-fly)))
  14629. ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
  14630. (put 'org-self-insert-command 'delete-selection t)
  14631. (put 'orgtbl-self-insert-command 'delete-selection t)
  14632. (put 'org-delete-char 'delete-selection 'supersede)
  14633. (put 'org-delete-backward-char 'delete-selection 'supersede)
  14634. (put 'org-yank 'delete-selection 'yank)
  14635. ;; Make `flyspell-mode' delay after some commands
  14636. (put 'org-self-insert-command 'flyspell-delayed t)
  14637. (put 'orgtbl-self-insert-command 'flyspell-delayed t)
  14638. (put 'org-delete-char 'flyspell-delayed t)
  14639. (put 'org-delete-backward-char 'flyspell-delayed t)
  14640. ;; Make pabbrev-mode expand after org-mode commands
  14641. (put 'org-self-insert-command 'pabbrev-expand-after-command t)
  14642. (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
  14643. ;; How to do this: Measure non-white length of current string
  14644. ;; If equal to column width, we should realign.
  14645. (defun org-remap (map &rest commands)
  14646. "In MAP, remap the functions given in COMMANDS.
  14647. COMMANDS is a list of alternating OLDDEF NEWDEF command names."
  14648. (let (new old)
  14649. (while commands
  14650. (setq old (pop commands) new (pop commands))
  14651. (if (fboundp 'command-remapping)
  14652. (org-defkey map (vector 'remap old) new)
  14653. (substitute-key-definition old new map global-map)))))
  14654. (when (eq org-enable-table-editor 'optimized)
  14655. ;; If the user wants maximum table support, we need to hijack
  14656. ;; some standard editing functions
  14657. (org-remap org-mode-map
  14658. 'self-insert-command 'org-self-insert-command
  14659. 'delete-char 'org-delete-char
  14660. 'delete-backward-char 'org-delete-backward-char)
  14661. (org-defkey org-mode-map "|" 'org-force-self-insert))
  14662. (defvar org-ctrl-c-ctrl-c-hook nil
  14663. "Hook for functions attaching themselves to `C-c C-c'.
  14664. This can be used to add additional functionality to the C-c C-c key which
  14665. executes context-dependent commands.
  14666. Each function will be called with no arguments. The function must check
  14667. if the context is appropriate for it to act. If yes, it should do its
  14668. thing and then return a non-nil value. If the context is wrong,
  14669. just do nothing and return nil.")
  14670. (defvar org-tab-first-hook nil
  14671. "Hook for functions to attach themselves to TAB.
  14672. See `org-ctrl-c-ctrl-c-hook' for more information.
  14673. This hook runs as the first action when TAB is pressed, even before
  14674. `org-cycle' messes around with the `outline-regexp' to cater for
  14675. inline tasks and plain list item folding.
  14676. If any function in this hook returns t, any other actions that
  14677. would have been caused by TAB (such as table field motion or visibility
  14678. cycling) will not occur.")
  14679. (defvar org-tab-after-check-for-table-hook nil
  14680. "Hook for functions to attach themselves to TAB.
  14681. See `org-ctrl-c-ctrl-c-hook' for more information.
  14682. This hook runs after it has been established that the cursor is not in a
  14683. table, but before checking if the cursor is in a headline or if global cycling
  14684. should be done.
  14685. If any function in this hook returns t, not other actions like visibility
  14686. cycling will be done.")
  14687. (defvar org-tab-after-check-for-cycling-hook nil
  14688. "Hook for functions to attach themselves to TAB.
  14689. See `org-ctrl-c-ctrl-c-hook' for more information.
  14690. This hook runs after it has been established that not table field motion and
  14691. not visibility should be done because of current context. This is probably
  14692. the place where a package like yasnippets can hook in.")
  14693. (defvar org-tab-before-tab-emulation-hook nil
  14694. "Hook for functions to attach themselves to TAB.
  14695. See `org-ctrl-c-ctrl-c-hook' for more information.
  14696. This hook runs after every other options for TAB have been exhausted, but
  14697. before indentation and \t insertion takes place.")
  14698. (defvar org-metaleft-hook nil
  14699. "Hook for functions attaching themselves to `M-left'.
  14700. See `org-ctrl-c-ctrl-c-hook' for more information.")
  14701. (defvar org-metaright-hook nil
  14702. "Hook for functions attaching themselves to `M-right'.
  14703. See `org-ctrl-c-ctrl-c-hook' for more information.")
  14704. (defvar org-metaup-hook nil
  14705. "Hook for functions attaching themselves to `M-up'.
  14706. See `org-ctrl-c-ctrl-c-hook' for more information.")
  14707. (defvar org-metadown-hook nil
  14708. "Hook for functions attaching themselves to `M-down'.
  14709. See `org-ctrl-c-ctrl-c-hook' for more information.")
  14710. (defvar org-shiftmetaleft-hook nil
  14711. "Hook for functions attaching themselves to `M-S-left'.
  14712. See `org-ctrl-c-ctrl-c-hook' for more information.")
  14713. (defvar org-shiftmetaright-hook nil
  14714. "Hook for functions attaching themselves to `M-S-right'.
  14715. See `org-ctrl-c-ctrl-c-hook' for more information.")
  14716. (defvar org-shiftmetaup-hook nil
  14717. "Hook for functions attaching themselves to `M-S-up'.
  14718. See `org-ctrl-c-ctrl-c-hook' for more information.")
  14719. (defvar org-shiftmetadown-hook nil
  14720. "Hook for functions attaching themselves to `M-S-down'.
  14721. See `org-ctrl-c-ctrl-c-hook' for more information.")
  14722. (defvar org-metareturn-hook nil
  14723. "Hook for functions attaching themselves to `M-RET'.
  14724. See `org-ctrl-c-ctrl-c-hook' for more information.")
  14725. (defvar org-shiftup-hook nil
  14726. "Hook for functions attaching themselves to `S-up'.
  14727. See `org-ctrl-c-ctrl-c-hook' for more information.")
  14728. (defvar org-shiftup-final-hook nil
  14729. "Hook for functions attaching themselves to `S-up'.
  14730. This one runs after all other options except shift-select have been excluded.
  14731. See `org-ctrl-c-ctrl-c-hook' for more information.")
  14732. (defvar org-shiftdown-hook nil
  14733. "Hook for functions attaching themselves to `S-down'.
  14734. See `org-ctrl-c-ctrl-c-hook' for more information.")
  14735. (defvar org-shiftdown-final-hook nil
  14736. "Hook for functions attaching themselves to `S-down'.
  14737. This one runs after all other options except shift-select have been excluded.
  14738. See `org-ctrl-c-ctrl-c-hook' for more information.")
  14739. (defvar org-shiftleft-hook nil
  14740. "Hook for functions attaching themselves to `S-left'.
  14741. See `org-ctrl-c-ctrl-c-hook' for more information.")
  14742. (defvar org-shiftleft-final-hook nil
  14743. "Hook for functions attaching themselves to `S-left'.
  14744. This one runs after all other options except shift-select have been excluded.
  14745. See `org-ctrl-c-ctrl-c-hook' for more information.")
  14746. (defvar org-shiftright-hook nil
  14747. "Hook for functions attaching themselves to `S-right'.
  14748. See `org-ctrl-c-ctrl-c-hook' for more information.")
  14749. (defvar org-shiftright-final-hook nil
  14750. "Hook for functions attaching themselves to `S-right'.
  14751. This one runs after all other options except shift-select have been excluded.
  14752. See `org-ctrl-c-ctrl-c-hook' for more information.")
  14753. (defun org-modifier-cursor-error ()
  14754. "Throw an error, a modified cursor command was applied in wrong context."
  14755. (error "This command is active in special context like tables, headlines or items"))
  14756. (defun org-shiftselect-error ()
  14757. "Throw an error because Shift-Cursor command was applied in wrong context."
  14758. (if (and (boundp 'shift-select-mode) shift-select-mode)
  14759. (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
  14760. (error "This command works only in special context like headlines or timestamps")))
  14761. (defun org-call-for-shift-select (cmd)
  14762. (let ((this-command-keys-shift-translated t))
  14763. (call-interactively cmd)))
  14764. (defun org-shifttab (&optional arg)
  14765. "Global visibility cycling or move to previous table field.
  14766. Calls `org-cycle' with argument t, or `org-table-previous-field', depending
  14767. on context.
  14768. See the individual commands for more information."
  14769. (interactive "P")
  14770. (cond
  14771. ((org-at-table-p) (call-interactively 'org-table-previous-field))
  14772. ((integerp arg)
  14773. (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
  14774. (message "Content view to level: %d" arg)
  14775. (org-content (prefix-numeric-value arg2))
  14776. (setq org-cycle-global-status 'overview)))
  14777. (t (call-interactively 'org-global-cycle))))
  14778. (defun org-shiftmetaleft ()
  14779. "Promote subtree or delete table column.
  14780. Calls `org-promote-subtree', `org-outdent-item',
  14781. or `org-table-delete-column', depending on context.
  14782. See the individual commands for more information."
  14783. (interactive)
  14784. (cond
  14785. ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
  14786. ((org-at-table-p) (call-interactively 'org-table-delete-column))
  14787. ((org-on-heading-p) (call-interactively 'org-promote-subtree))
  14788. ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
  14789. (t (org-modifier-cursor-error))))
  14790. (defun org-shiftmetaright ()
  14791. "Demote subtree or insert table column.
  14792. Calls `org-demote-subtree', `org-indent-item',
  14793. or `org-table-insert-column', depending on context.
  14794. See the individual commands for more information."
  14795. (interactive)
  14796. (cond
  14797. ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
  14798. ((org-at-table-p) (call-interactively 'org-table-insert-column))
  14799. ((org-on-heading-p) (call-interactively 'org-demote-subtree))
  14800. ((org-at-item-p) (call-interactively 'org-indent-item-tree))
  14801. (t (org-modifier-cursor-error))))
  14802. (defun org-shiftmetaup (&optional arg)
  14803. "Move subtree up or kill table row.
  14804. Calls `org-move-subtree-up' or `org-table-kill-row' or
  14805. `org-move-item-up' depending on context. See the individual commands
  14806. for more information."
  14807. (interactive "P")
  14808. (cond
  14809. ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
  14810. ((org-at-table-p) (call-interactively 'org-table-kill-row))
  14811. ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
  14812. ((org-at-item-p) (call-interactively 'org-move-item-up))
  14813. (t (org-modifier-cursor-error))))
  14814. (defun org-shiftmetadown (&optional arg)
  14815. "Move subtree down or insert table row.
  14816. Calls `org-move-subtree-down' or `org-table-insert-row' or
  14817. `org-move-item-down', depending on context. See the individual
  14818. commands for more information."
  14819. (interactive "P")
  14820. (cond
  14821. ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
  14822. ((org-at-table-p) (call-interactively 'org-table-insert-row))
  14823. ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
  14824. ((org-at-item-p) (call-interactively 'org-move-item-down))
  14825. (t (org-modifier-cursor-error))))
  14826. (defsubst org-hidden-tree-error ()
  14827. (error
  14828. "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
  14829. (defun org-metaleft (&optional arg)
  14830. "Promote heading or move table column to left.
  14831. Calls `org-do-promote' or `org-table-move-column', depending on context.
  14832. With no specific context, calls the Emacs default `backward-word'.
  14833. See the individual commands for more information."
  14834. (interactive "P")
  14835. (cond
  14836. ((run-hook-with-args-until-success 'org-metaleft-hook))
  14837. ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
  14838. ((or (org-on-heading-p)
  14839. (and (org-region-active-p)
  14840. (save-excursion
  14841. (goto-char (region-beginning))
  14842. (org-on-heading-p))))
  14843. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  14844. (call-interactively 'org-do-promote))
  14845. ((or (org-at-item-p)
  14846. (and (org-region-active-p)
  14847. (save-excursion
  14848. (goto-char (region-beginning))
  14849. (org-at-item-p))))
  14850. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  14851. (call-interactively 'org-outdent-item))
  14852. (t (call-interactively 'backward-word))))
  14853. (defun org-metaright (&optional arg)
  14854. "Demote subtree or move table column to right.
  14855. Calls `org-do-demote' or `org-table-move-column', depending on context.
  14856. With no specific context, calls the Emacs default `forward-word'.
  14857. See the individual commands for more information."
  14858. (interactive "P")
  14859. (cond
  14860. ((run-hook-with-args-until-success 'org-metaright-hook))
  14861. ((org-at-table-p) (call-interactively 'org-table-move-column))
  14862. ((or (org-on-heading-p)
  14863. (and (org-region-active-p)
  14864. (save-excursion
  14865. (goto-char (region-beginning))
  14866. (org-on-heading-p))))
  14867. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  14868. (call-interactively 'org-do-demote))
  14869. ((or (org-at-item-p)
  14870. (and (org-region-active-p)
  14871. (save-excursion
  14872. (goto-char (region-beginning))
  14873. (org-at-item-p))))
  14874. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  14875. (call-interactively 'org-indent-item))
  14876. (t (call-interactively 'forward-word))))
  14877. (defun org-check-for-hidden (what)
  14878. "Check if there are hidden headlines/items in the current visual line.
  14879. WHAT can be either `headlines' or `items'. If the current line is
  14880. an outline or item heading and it has a folded subtree below it,
  14881. this fucntion returns t, nil otherwise."
  14882. (let ((re (cond
  14883. ((eq what 'headlines) (concat "^" org-outline-regexp))
  14884. ((eq what 'items) (concat "^" (org-item-re t)))
  14885. (t (error "This should not happen"))))
  14886. beg end)
  14887. (save-excursion
  14888. (catch 'exit
  14889. (unless (org-region-active-p)
  14890. (setq beg (point-at-bol))
  14891. (beginning-of-line 2)
  14892. (while (and (not (eobp)) ;; this is like `next-line'
  14893. (get-char-property (1- (point)) 'invisible))
  14894. (beginning-of-line 2))
  14895. (setq end (point))
  14896. (goto-char beg)
  14897. (goto-char (point-at-eol))
  14898. (setq end (max end (point)))
  14899. (while (re-search-forward re end t)
  14900. (if (get-char-property (match-beginning 0) 'invisible)
  14901. (throw 'exit t))))
  14902. nil))))
  14903. (defun org-metaup (&optional arg)
  14904. "Move subtree up or move table row up.
  14905. Calls `org-move-subtree-up' or `org-table-move-row' or
  14906. `org-move-item-up', depending on context. See the individual commands
  14907. for more information."
  14908. (interactive "P")
  14909. (cond
  14910. ((run-hook-with-args-until-success 'org-metaup-hook))
  14911. ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
  14912. ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
  14913. ((org-at-item-p) (call-interactively 'org-move-item-up))
  14914. (t (transpose-lines 1) (beginning-of-line -1))))
  14915. (defun org-metadown (&optional arg)
  14916. "Move subtree down or move table row down.
  14917. Calls `org-move-subtree-down' or `org-table-move-row' or
  14918. `org-move-item-down', depending on context. See the individual
  14919. commands for more information."
  14920. (interactive "P")
  14921. (cond
  14922. ((run-hook-with-args-until-success 'org-metadown-hook))
  14923. ((org-at-table-p) (call-interactively 'org-table-move-row))
  14924. ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
  14925. ((org-at-item-p) (call-interactively 'org-move-item-down))
  14926. (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
  14927. (defun org-shiftup (&optional arg)
  14928. "Increase item in timestamp or increase priority of current headline.
  14929. Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
  14930. depending on context. See the individual commands for more information."
  14931. (interactive "P")
  14932. (cond
  14933. ((run-hook-with-args-until-success 'org-shiftup-hook))
  14934. ((and org-support-shift-select (org-region-active-p))
  14935. (org-call-for-shift-select 'previous-line))
  14936. ((org-at-timestamp-p t)
  14937. (call-interactively (if org-edit-timestamp-down-means-later
  14938. 'org-timestamp-down 'org-timestamp-up)))
  14939. ((and (not (eq org-support-shift-select 'always))
  14940. org-enable-priority-commands
  14941. (org-on-heading-p))
  14942. (call-interactively 'org-priority-up))
  14943. ((and (not org-support-shift-select) (org-at-item-p))
  14944. (call-interactively 'org-previous-item))
  14945. ((org-clocktable-try-shift 'up arg))
  14946. ((run-hook-with-args-until-success 'org-shiftup-final-hook))
  14947. (org-support-shift-select
  14948. (org-call-for-shift-select 'previous-line))
  14949. (t (org-shiftselect-error))))
  14950. (defun org-shiftdown (&optional arg)
  14951. "Decrease item in timestamp or decrease priority of current headline.
  14952. Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
  14953. depending on context. See the individual commands for more information."
  14954. (interactive "P")
  14955. (cond
  14956. ((run-hook-with-args-until-success 'org-shiftdown-hook))
  14957. ((and org-support-shift-select (org-region-active-p))
  14958. (org-call-for-shift-select 'next-line))
  14959. ((org-at-timestamp-p t)
  14960. (call-interactively (if org-edit-timestamp-down-means-later
  14961. 'org-timestamp-up 'org-timestamp-down)))
  14962. ((and (not (eq org-support-shift-select 'always))
  14963. org-enable-priority-commands
  14964. (org-on-heading-p))
  14965. (call-interactively 'org-priority-down))
  14966. ((and (not org-support-shift-select) (org-at-item-p))
  14967. (call-interactively 'org-next-item))
  14968. ((org-clocktable-try-shift 'down arg))
  14969. ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
  14970. (org-support-shift-select
  14971. (org-call-for-shift-select 'next-line))
  14972. (t (org-shiftselect-error))))
  14973. (defun org-shiftright (&optional arg)
  14974. "Cycle the thing at point or in the current line, depending on context.
  14975. Depending on context, this does one of the following:
  14976. - switch a timestamp at point one day into the future
  14977. - on a headline, switch to the next TODO keyword.
  14978. - on an item, switch entire list to the next bullet type
  14979. - on a property line, switch to the next allowed value
  14980. - on a clocktable definition line, move time block into the future"
  14981. (interactive "P")
  14982. (cond
  14983. ((run-hook-with-args-until-success 'org-shiftright-hook))
  14984. ((and org-support-shift-select (org-region-active-p))
  14985. (org-call-for-shift-select 'forward-char))
  14986. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
  14987. ((and (not (eq org-support-shift-select 'always))
  14988. (org-on-heading-p))
  14989. (let ((org-inhibit-logging
  14990. (not org-treat-S-cursor-todo-selection-as-state-change))
  14991. (org-inhibit-blocking
  14992. (not org-treat-S-cursor-todo-selection-as-state-change)))
  14993. (org-call-with-arg 'org-todo 'right)))
  14994. ((or (and org-support-shift-select
  14995. (not (eq org-support-shift-select 'always))
  14996. (org-at-item-bullet-p))
  14997. (and (not org-support-shift-select) (org-at-item-p)))
  14998. (org-call-with-arg 'org-cycle-list-bullet nil))
  14999. ((and (not (eq org-support-shift-select 'always))
  15000. (org-at-property-p))
  15001. (call-interactively 'org-property-next-allowed-value))
  15002. ((org-clocktable-try-shift 'right arg))
  15003. ((run-hook-with-args-until-success 'org-shiftright-final-hook))
  15004. (org-support-shift-select
  15005. (org-call-for-shift-select 'forward-char))
  15006. (t (org-shiftselect-error))))
  15007. (defun org-shiftleft (&optional arg)
  15008. "Cycle the thing at point or in the current line, depending on context.
  15009. Depending on context, this does one of the following:
  15010. - switch a timestamp at point one day into the past
  15011. - on a headline, switch to the previous TODO keyword.
  15012. - on an item, switch entire list to the previous bullet type
  15013. - on a property line, switch to the previous allowed value
  15014. - on a clocktable definition line, move time block into the past"
  15015. (interactive "P")
  15016. (cond
  15017. ((run-hook-with-args-until-success 'org-shiftleft-hook))
  15018. ((and org-support-shift-select (org-region-active-p))
  15019. (org-call-for-shift-select 'backward-char))
  15020. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
  15021. ((and (not (eq org-support-shift-select 'always))
  15022. (org-on-heading-p))
  15023. (let ((org-inhibit-logging
  15024. (not org-treat-S-cursor-todo-selection-as-state-change))
  15025. (org-inhibit-blocking
  15026. (not org-treat-S-cursor-todo-selection-as-state-change)))
  15027. (org-call-with-arg 'org-todo 'left)))
  15028. ((or (and org-support-shift-select
  15029. (not (eq org-support-shift-select 'always))
  15030. (org-at-item-bullet-p))
  15031. (and (not org-support-shift-select) (org-at-item-p)))
  15032. (org-call-with-arg 'org-cycle-list-bullet 'previous))
  15033. ((and (not (eq org-support-shift-select 'always))
  15034. (org-at-property-p))
  15035. (call-interactively 'org-property-previous-allowed-value))
  15036. ((org-clocktable-try-shift 'left arg))
  15037. ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
  15038. (org-support-shift-select
  15039. (org-call-for-shift-select 'backward-char))
  15040. (t (org-shiftselect-error))))
  15041. (defun org-shiftcontrolright ()
  15042. "Switch to next TODO set."
  15043. (interactive)
  15044. (cond
  15045. ((and org-support-shift-select (org-region-active-p))
  15046. (org-call-for-shift-select 'forward-word))
  15047. ((and (not (eq org-support-shift-select 'always))
  15048. (org-on-heading-p))
  15049. (org-call-with-arg 'org-todo 'nextset))
  15050. (org-support-shift-select
  15051. (org-call-for-shift-select 'forward-word))
  15052. (t (org-shiftselect-error))))
  15053. (defun org-shiftcontrolleft ()
  15054. "Switch to previous TODO set."
  15055. (interactive)
  15056. (cond
  15057. ((and org-support-shift-select (org-region-active-p))
  15058. (org-call-for-shift-select 'backward-word))
  15059. ((and (not (eq org-support-shift-select 'always))
  15060. (org-on-heading-p))
  15061. (org-call-with-arg 'org-todo 'previousset))
  15062. (org-support-shift-select
  15063. (org-call-for-shift-select 'backward-word))
  15064. (t (org-shiftselect-error))))
  15065. (defun org-ctrl-c-ret ()
  15066. "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
  15067. (interactive)
  15068. (cond
  15069. ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
  15070. (t (call-interactively 'org-insert-heading))))
  15071. (defun org-copy-special ()
  15072. "Copy region in table or copy current subtree.
  15073. Calls `org-table-copy' or `org-copy-subtree', depending on context.
  15074. See the individual commands for more information."
  15075. (interactive)
  15076. (call-interactively
  15077. (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
  15078. (defun org-cut-special ()
  15079. "Cut region in table or cut current subtree.
  15080. Calls `org-table-copy' or `org-cut-subtree', depending on context.
  15081. See the individual commands for more information."
  15082. (interactive)
  15083. (call-interactively
  15084. (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
  15085. (defun org-paste-special (arg)
  15086. "Paste rectangular region into table, or past subtree relative to level.
  15087. Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
  15088. See the individual commands for more information."
  15089. (interactive "P")
  15090. (if (org-at-table-p)
  15091. (org-table-paste-rectangle)
  15092. (org-paste-subtree arg)))
  15093. (defun org-edit-special ()
  15094. "Call a special editor for the stuff at point.
  15095. When at a table, call the formula editor with `org-table-edit-formulas'.
  15096. When at the first line of an src example, call `org-edit-src-code'.
  15097. When in an #+include line, visit the include file. Otherwise call
  15098. `ffap' to visit the file at point."
  15099. (interactive)
  15100. (cond
  15101. ((org-at-table.el-p)
  15102. (org-edit-src-code))
  15103. ((org-at-table-p)
  15104. (call-interactively 'org-table-edit-formulas))
  15105. ((save-excursion
  15106. (beginning-of-line 1)
  15107. (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
  15108. (find-file (org-trim (match-string 1))))
  15109. ((org-edit-src-code))
  15110. ((org-edit-fixed-width-region))
  15111. (t (call-interactively 'ffap))))
  15112. (defun org-ctrl-c-ctrl-c (&optional arg)
  15113. "Set tags in headline, or update according to changed information at point.
  15114. This command does many different things, depending on context:
  15115. - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
  15116. this is what we do.
  15117. - If the cursor is on a statistics cookie, update it.
  15118. - If the cursor is in a headline, prompt for tags and insert them
  15119. into the current line, aligned to `org-tags-column'. When called
  15120. with prefix arg, realign all tags in the current buffer.
  15121. - If the cursor is in one of the special #+KEYWORD lines, this
  15122. triggers scanning the buffer for these lines and updating the
  15123. information.
  15124. - If the cursor is inside a table, realign the table. This command
  15125. works even if the automatic table editor has been turned off.
  15126. - If the cursor is on a #+TBLFM line, re-apply the formulas to
  15127. the entire table.
  15128. - If the cursor is at a footnote reference or definition, jump to
  15129. the corresponding definition or references, respectively.
  15130. - If the cursor is a the beginning of a dynamic block, update it.
  15131. - If the current buffer is a remember buffer, close note and file
  15132. it. A prefix argument of 1 files to the default location
  15133. without further interaction. A prefix argument of 2 files to
  15134. the currently clocking task.
  15135. - If the cursor is on a <<<target>>>, update radio targets and corresponding
  15136. links in this buffer.
  15137. - If the cursor is on a numbered item in a plain list, renumber the
  15138. ordered list.
  15139. - If the cursor is on a checkbox, toggle it."
  15140. (interactive "P")
  15141. (let ((org-enable-table-editor t))
  15142. (cond
  15143. ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
  15144. org-occur-highlights
  15145. org-latex-fragment-image-overlays)
  15146. (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
  15147. (org-remove-occur-highlights)
  15148. (org-remove-latex-fragment-image-overlays)
  15149. (message "Temporary highlights/overlays removed from current buffer"))
  15150. ((and (local-variable-p 'org-finish-function (current-buffer))
  15151. (fboundp org-finish-function))
  15152. (funcall org-finish-function))
  15153. ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
  15154. ((or (looking-at org-property-start-re)
  15155. (org-at-property-p))
  15156. (call-interactively 'org-property-action))
  15157. ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
  15158. ((and (org-in-regexp "\\[\\([0-9]*%\\|[0-9]*/[0-9]*\\)\\]")
  15159. (or (org-on-heading-p) (org-at-item-p)))
  15160. (call-interactively 'org-update-statistics-cookies))
  15161. ((org-on-heading-p) (call-interactively 'org-set-tags))
  15162. ((org-at-table.el-p)
  15163. (message "Use C-c ' to edit table.el tables"))
  15164. ((org-at-table-p)
  15165. (org-table-maybe-eval-formula)
  15166. (if arg
  15167. (call-interactively 'org-table-recalculate)
  15168. (org-table-maybe-recalculate-line))
  15169. (call-interactively 'org-table-align))
  15170. ((or (org-footnote-at-reference-p)
  15171. (org-footnote-at-definition-p))
  15172. (call-interactively 'org-footnote-action))
  15173. ((org-at-item-checkbox-p)
  15174. (call-interactively 'org-toggle-checkbox))
  15175. ((org-at-item-p)
  15176. (if arg
  15177. (call-interactively 'org-toggle-checkbox)
  15178. (call-interactively 'org-maybe-renumber-ordered-list)))
  15179. ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
  15180. ;; Dynamic block
  15181. (beginning-of-line 1)
  15182. (save-excursion (org-update-dblock)))
  15183. ((save-excursion
  15184. (beginning-of-line 1)
  15185. (looking-at "[ \t]*#\\+\\([A-Z]+\\)"))
  15186. (cond
  15187. ((equal (match-string 1) "TBLFM")
  15188. ;; Recalculate the table before this line
  15189. (save-excursion
  15190. (beginning-of-line 1)
  15191. (skip-chars-backward " \r\n\t")
  15192. (if (org-at-table-p)
  15193. (org-call-with-arg 'org-table-recalculate (or arg t)))))
  15194. (t
  15195. (let ((org-inhibit-startup-visibility-stuff t)
  15196. (org-startup-align-all-tables nil))
  15197. (org-save-outline-visibility 'use-markers (org-mode-restart)))
  15198. (message "Local setup has been refreshed"))))
  15199. ((org-clock-update-time-maybe))
  15200. (t (error "C-c C-c can do nothing useful at this location")))))
  15201. (defun org-mode-restart ()
  15202. "Restart Org-mode, to scan again for special lines.
  15203. Also updates the keyword regular expressions."
  15204. (interactive)
  15205. (org-mode)
  15206. (message "Org-mode restarted"))
  15207. (defun org-kill-note-or-show-branches ()
  15208. "If this is a Note buffer, abort storing the note. Else call `show-branches'."
  15209. (interactive)
  15210. (if (not org-finish-function)
  15211. (call-interactively 'show-branches)
  15212. (let ((org-note-abort t))
  15213. (funcall org-finish-function))))
  15214. (defun org-return (&optional indent)
  15215. "Goto next table row or insert a newline.
  15216. Calls `org-table-next-row' or `newline', depending on context.
  15217. See the individual commands for more information."
  15218. (interactive)
  15219. (cond
  15220. ((bobp) (if indent (newline-and-indent) (newline)))
  15221. ((org-at-table-p)
  15222. (org-table-justify-field-maybe)
  15223. (call-interactively 'org-table-next-row))
  15224. ((and org-return-follows-link
  15225. (eq (get-text-property (point) 'face) 'org-link))
  15226. (call-interactively 'org-open-at-point))
  15227. ((and (org-at-heading-p)
  15228. (looking-at
  15229. (org-re "\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)[ \t]*$")))
  15230. (org-show-entry)
  15231. (end-of-line 1)
  15232. (newline))
  15233. (t (if indent (newline-and-indent) (newline)))))
  15234. (defun org-return-indent ()
  15235. "Goto next table row or insert a newline and indent.
  15236. Calls `org-table-next-row' or `newline-and-indent', depending on
  15237. context. See the individual commands for more information."
  15238. (interactive)
  15239. (org-return t))
  15240. (defun org-ctrl-c-star ()
  15241. "Compute table, or change heading status of lines.
  15242. Calls `org-table-recalculate' or `org-toggle-heading',
  15243. depending on context."
  15244. (interactive)
  15245. (cond
  15246. ((org-at-table-p)
  15247. (call-interactively 'org-table-recalculate))
  15248. (t
  15249. ;; Convert all lines in region to list items
  15250. (call-interactively 'org-toggle-heading))))
  15251. (defun org-ctrl-c-minus ()
  15252. "Insert separator line in table or modify bullet status of line.
  15253. Also turns a plain line or a region of lines into list items.
  15254. Calls `org-table-insert-hline', `org-toggle-item', or
  15255. `org-cycle-list-bullet', depending on context."
  15256. (interactive)
  15257. (cond
  15258. ((org-at-table-p)
  15259. (call-interactively 'org-table-insert-hline))
  15260. ((org-region-active-p)
  15261. (call-interactively 'org-toggle-item))
  15262. ((org-in-item-p)
  15263. (call-interactively 'org-cycle-list-bullet))
  15264. (t
  15265. (call-interactively 'org-toggle-item))))
  15266. (defun org-toggle-item ()
  15267. "Convert headings or normal lines to items, items to normal lines.
  15268. If there is no active region, only the current line is considered.
  15269. If the first line in the region is a headline, convert all headlines to items.
  15270. If the first line in the region is an item, convert all items to normal lines.
  15271. If the first line is normal text, add an item bullet to each line."
  15272. (interactive)
  15273. (let (l2 l beg end)
  15274. (if (org-region-active-p)
  15275. (setq beg (region-beginning) end (region-end))
  15276. (setq beg (point-at-bol)
  15277. end (min (1+ (point-at-eol)) (point-max))))
  15278. (save-excursion
  15279. (goto-char end)
  15280. (setq l2 (org-current-line))
  15281. (goto-char beg)
  15282. (beginning-of-line 1)
  15283. (setq l (1- (org-current-line)))
  15284. (if (org-at-item-p)
  15285. ;; We already have items, de-itemize
  15286. (while (< (setq l (1+ l)) l2)
  15287. (when (org-at-item-p)
  15288. (goto-char (match-beginning 2))
  15289. (delete-region (match-beginning 2) (match-end 2))
  15290. (and (looking-at "[ \t]+") (replace-match "")))
  15291. (beginning-of-line 2))
  15292. (if (org-on-heading-p)
  15293. ;; Headings, convert to items
  15294. (while (< (setq l (1+ l)) l2)
  15295. (if (looking-at org-outline-regexp)
  15296. (replace-match "- " t t))
  15297. (beginning-of-line 2))
  15298. ;; normal lines, turn them into items
  15299. (while (< (setq l (1+ l)) l2)
  15300. (unless (org-at-item-p)
  15301. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  15302. (replace-match "\\1- \\2")))
  15303. (beginning-of-line 2)))))))
  15304. (defun org-toggle-heading (&optional nstars)
  15305. "Convert headings to normal text, or items or text to headings.
  15306. If there is no active region, only the current line is considered.
  15307. If the first line is a heading, remove the stars from all headlines
  15308. in the region.
  15309. If the first line is a plain list item, turn all plain list items
  15310. into headings.
  15311. If the first line is a normal line, turn each and every line in the
  15312. region into a heading.
  15313. When converting a line into a heading, the number of stars is chosen
  15314. such that the lines become children of the current entry. However,
  15315. when a prefix argument is given, its value determines the number of
  15316. stars to add."
  15317. (interactive "P")
  15318. (let (l2 l itemp beg end)
  15319. (if (org-region-active-p)
  15320. (setq beg (region-beginning) end (region-end))
  15321. (setq beg (point-at-bol)
  15322. end (min (1+ (point-at-eol)) (point-max))))
  15323. (save-excursion
  15324. (goto-char end)
  15325. (setq l2 (org-current-line))
  15326. (goto-char beg)
  15327. (beginning-of-line 1)
  15328. (setq l (1- (org-current-line)))
  15329. (if (org-on-heading-p)
  15330. ;; We already have headlines, de-star them
  15331. (while (< (setq l (1+ l)) l2)
  15332. (when (org-on-heading-p t)
  15333. (and (looking-at outline-regexp) (replace-match "")))
  15334. (beginning-of-line 2))
  15335. (setq itemp (org-at-item-p))
  15336. (let* ((stars
  15337. (if nstars
  15338. (make-string (prefix-numeric-value current-prefix-arg)
  15339. ?*)
  15340. (save-excursion
  15341. (if (re-search-backward org-complex-heading-regexp nil t)
  15342. (match-string 1) ""))))
  15343. (add-stars (cond (nstars "")
  15344. ((equal stars "") "*")
  15345. (org-odd-levels-only "**")
  15346. (t "*")))
  15347. (rpl (concat stars add-stars " ")))
  15348. (while (< (setq l (1+ l)) l2)
  15349. (if itemp
  15350. (and (org-at-item-p) (replace-match rpl t t))
  15351. (unless (org-on-heading-p)
  15352. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  15353. (replace-match (concat rpl (match-string 2))))))
  15354. (beginning-of-line 2)))))))
  15355. (defun org-meta-return (&optional arg)
  15356. "Insert a new heading or wrap a region in a table.
  15357. Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
  15358. See the individual commands for more information."
  15359. (interactive "P")
  15360. (cond
  15361. ((run-hook-with-args-until-success 'org-metareturn-hook))
  15362. ((org-at-table-p)
  15363. (call-interactively 'org-table-wrap-region))
  15364. (t (call-interactively 'org-insert-heading))))
  15365. ;;; Menu entries
  15366. ;; Define the Org-mode menus
  15367. (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
  15368. '("Tbl"
  15369. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
  15370. ["Next Field" org-cycle (org-at-table-p)]
  15371. ["Previous Field" org-shifttab (org-at-table-p)]
  15372. ["Next Row" org-return (org-at-table-p)]
  15373. "--"
  15374. ["Blank Field" org-table-blank-field (org-at-table-p)]
  15375. ["Edit Field" org-table-edit-field (org-at-table-p)]
  15376. ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
  15377. "--"
  15378. ("Column"
  15379. ["Move Column Left" org-metaleft (org-at-table-p)]
  15380. ["Move Column Right" org-metaright (org-at-table-p)]
  15381. ["Delete Column" org-shiftmetaleft (org-at-table-p)]
  15382. ["Insert Column" org-shiftmetaright (org-at-table-p)])
  15383. ("Row"
  15384. ["Move Row Up" org-metaup (org-at-table-p)]
  15385. ["Move Row Down" org-metadown (org-at-table-p)]
  15386. ["Delete Row" org-shiftmetaup (org-at-table-p)]
  15387. ["Insert Row" org-shiftmetadown (org-at-table-p)]
  15388. ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
  15389. "--"
  15390. ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
  15391. ("Rectangle"
  15392. ["Copy Rectangle" org-copy-special (org-at-table-p)]
  15393. ["Cut Rectangle" org-cut-special (org-at-table-p)]
  15394. ["Paste Rectangle" org-paste-special (org-at-table-p)]
  15395. ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
  15396. "--"
  15397. ("Calculate"
  15398. ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
  15399. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  15400. ["Edit Formulas" org-edit-special (org-at-table-p)]
  15401. "--"
  15402. ["Recalculate line" org-table-recalculate (org-at-table-p)]
  15403. ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
  15404. ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  15405. "--"
  15406. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
  15407. "--"
  15408. ["Sum Column/Rectangle" org-table-sum
  15409. (or (org-at-table-p) (org-region-active-p))]
  15410. ["Which Column?" org-table-current-column (org-at-table-p)])
  15411. ["Debug Formulas"
  15412. org-table-toggle-formula-debugger
  15413. :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
  15414. ["Show Col/Row Numbers"
  15415. org-table-toggle-coordinate-overlays
  15416. :style toggle
  15417. :selected (org-bound-and-true-p org-table-overlay-coordinates)]
  15418. "--"
  15419. ["Create" org-table-create (and (not (org-at-table-p))
  15420. org-enable-table-editor)]
  15421. ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
  15422. ["Import from File" org-table-import (not (org-at-table-p))]
  15423. ["Export to File" org-table-export (org-at-table-p)]
  15424. "--"
  15425. ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
  15426. (easy-menu-define org-org-menu org-mode-map "Org menu"
  15427. '("Org"
  15428. ("Show/Hide"
  15429. ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
  15430. ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
  15431. ["Sparse Tree..." org-sparse-tree t]
  15432. ["Reveal Context" org-reveal t]
  15433. ["Show All" show-all t]
  15434. "--"
  15435. ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
  15436. "--"
  15437. ["New Heading" org-insert-heading t]
  15438. ("Navigate Headings"
  15439. ["Up" outline-up-heading t]
  15440. ["Next" outline-next-visible-heading t]
  15441. ["Previous" outline-previous-visible-heading t]
  15442. ["Next Same Level" outline-forward-same-level t]
  15443. ["Previous Same Level" outline-backward-same-level t]
  15444. "--"
  15445. ["Jump" org-goto t])
  15446. ("Edit Structure"
  15447. ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
  15448. ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
  15449. "--"
  15450. ["Copy Subtree" org-copy-special (not (org-at-table-p))]
  15451. ["Cut Subtree" org-cut-special (not (org-at-table-p))]
  15452. ["Paste Subtree" org-paste-special (not (org-at-table-p))]
  15453. "--"
  15454. ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
  15455. "--"
  15456. ["Promote Heading" org-metaleft (not (org-at-table-p))]
  15457. ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
  15458. ["Demote Heading" org-metaright (not (org-at-table-p))]
  15459. ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
  15460. "--"
  15461. ["Sort Region/Children" org-sort (not (org-at-table-p))]
  15462. "--"
  15463. ["Convert to odd levels" org-convert-to-odd-levels t]
  15464. ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
  15465. ("Editing"
  15466. ["Emphasis..." org-emphasize t]
  15467. ["Edit Source Example" org-edit-special t]
  15468. "--"
  15469. ["Footnote new/jump" org-footnote-action t]
  15470. ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
  15471. ("Archive"
  15472. ["Archive (default method)" org-archive-subtree-default t]
  15473. "--"
  15474. ["Move Subtree to Archive file" org-advertized-archive-subtree t]
  15475. ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
  15476. ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
  15477. )
  15478. "--"
  15479. ("Hyperlinks"
  15480. ["Store Link (Global)" org-store-link t]
  15481. ["Find existing link to here" org-occur-link-in-agenda-files t]
  15482. ["Insert Link" org-insert-link t]
  15483. ["Follow Link" org-open-at-point t]
  15484. "--"
  15485. ["Next link" org-next-link t]
  15486. ["Previous link" org-previous-link t]
  15487. "--"
  15488. ["Descriptive Links"
  15489. (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
  15490. :style radio
  15491. :selected (member '(org-link) buffer-invisibility-spec)]
  15492. ["Literal Links"
  15493. (progn
  15494. (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
  15495. :style radio
  15496. :selected (not (member '(org-link) buffer-invisibility-spec))])
  15497. "--"
  15498. ("TODO Lists"
  15499. ["TODO/DONE/-" org-todo t]
  15500. ("Select keyword"
  15501. ["Next keyword" org-shiftright (org-on-heading-p)]
  15502. ["Previous keyword" org-shiftleft (org-on-heading-p)]
  15503. ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
  15504. ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
  15505. ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
  15506. ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
  15507. ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
  15508. "--"
  15509. ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
  15510. :selected org-enforce-todo-dependencies :style toggle :active t]
  15511. "Settings for tree at point"
  15512. ["Do Children sequentially" org-toggle-ordered-property :style radio
  15513. :selected (ignore-errors (org-entry-get nil "ORDERED"))
  15514. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  15515. ["Do Children parallel" org-toggle-ordered-property :style radio
  15516. :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
  15517. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  15518. "--"
  15519. ["Set Priority" org-priority t]
  15520. ["Priority Up" org-shiftup t]
  15521. ["Priority Down" org-shiftdown t]
  15522. "--"
  15523. ["Get news from all feeds" org-feed-update-all t]
  15524. ["Go to the inbox of a feed..." org-feed-goto-inbox t]
  15525. ["Customize feeds" (customize-variable 'org-feed-alist) t])
  15526. ("TAGS and Properties"
  15527. ["Set Tags" org-set-tags-command t]
  15528. ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
  15529. "--"
  15530. ["Set property" org-set-property t]
  15531. ["Column view of properties" org-columns t]
  15532. ["Insert Column View DBlock" org-insert-columns-dblock t])
  15533. ("Dates and Scheduling"
  15534. ["Timestamp" org-time-stamp t]
  15535. ["Timestamp (inactive)" org-time-stamp-inactive t]
  15536. ("Change Date"
  15537. ["1 Day Later" org-shiftright t]
  15538. ["1 Day Earlier" org-shiftleft t]
  15539. ["1 ... Later" org-shiftup t]
  15540. ["1 ... Earlier" org-shiftdown t])
  15541. ["Compute Time Range" org-evaluate-time-range t]
  15542. ["Schedule Item" org-schedule t]
  15543. ["Deadline" org-deadline t]
  15544. "--"
  15545. ["Custom time format" org-toggle-time-stamp-overlays
  15546. :style radio :selected org-display-custom-times]
  15547. "--"
  15548. ["Goto Calendar" org-goto-calendar t]
  15549. ["Date from Calendar" org-date-from-calendar t]
  15550. "--"
  15551. ["Start/Restart Timer" org-timer-start t]
  15552. ["Pause/Continue Timer" org-timer-pause-or-continue t]
  15553. ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
  15554. ["Insert Timer String" org-timer t]
  15555. ["Insert Timer Item" org-timer-item t])
  15556. ("Logging work"
  15557. ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
  15558. ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
  15559. ["Clock out" org-clock-out t]
  15560. ["Clock cancel" org-clock-cancel t]
  15561. "--"
  15562. ["Mark as default task" org-clock-mark-default-task t]
  15563. ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
  15564. ["Goto running clock" org-clock-goto t]
  15565. "--"
  15566. ["Display times" org-clock-display t]
  15567. ["Create clock table" org-clock-report t]
  15568. "--"
  15569. ["Record DONE time"
  15570. (progn (setq org-log-done (not org-log-done))
  15571. (message "Switching to %s will %s record a timestamp"
  15572. (car org-done-keywords)
  15573. (if org-log-done "automatically" "not")))
  15574. :style toggle :selected org-log-done])
  15575. "--"
  15576. ["Agenda Command..." org-agenda t]
  15577. ["Set Restriction Lock" org-agenda-set-restriction-lock t]
  15578. ("File List for Agenda")
  15579. ("Special views current file"
  15580. ["TODO Tree" org-show-todo-tree t]
  15581. ["Check Deadlines" org-check-deadlines t]
  15582. ["Timeline" org-timeline t]
  15583. ["Tags/Property tree" org-match-sparse-tree t])
  15584. "--"
  15585. ["Export/Publish..." org-export t]
  15586. ("LaTeX"
  15587. ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
  15588. :selected org-cdlatex-mode]
  15589. ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
  15590. ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
  15591. ["Modify math symbol" org-cdlatex-math-modify
  15592. (org-inside-LaTeX-fragment-p)]
  15593. ["Insert citation" org-reftex-citation t]
  15594. "--"
  15595. ["Export LaTeX fragments as images"
  15596. (if (featurep 'org-exp)
  15597. (setq org-export-with-LaTeX-fragments
  15598. (not org-export-with-LaTeX-fragments))
  15599. (require 'org-exp))
  15600. :style toggle :selected (and (boundp 'org-export-with-LaTeX-fragments)
  15601. org-export-with-LaTeX-fragments)]
  15602. "--"
  15603. ["Template for BEAMER" org-beamer-settings-template t])
  15604. "--"
  15605. ("MobileOrg"
  15606. ["Push Files and Views" org-mobile-push t]
  15607. ["Get Captured and Flagged" org-mobile-pull t]
  15608. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  15609. "--"
  15610. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  15611. "--"
  15612. ("Documentation"
  15613. ["Show Version" org-version t]
  15614. ["Info Documentation" org-info t])
  15615. ("Customize"
  15616. ["Browse Org Group" org-customize t]
  15617. "--"
  15618. ["Expand This Menu" org-create-customize-menu
  15619. (fboundp 'customize-menu-create)])
  15620. ["Send bug report" org-submit-bug-report t]
  15621. "--"
  15622. ("Refresh/Reload"
  15623. ["Refresh setup current buffer" org-mode-restart t]
  15624. ["Reload Org (after update)" org-reload t]
  15625. ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
  15626. ))
  15627. (defun org-info (&optional node)
  15628. "Read documentation for Org-mode in the info system.
  15629. With optional NODE, go directly to that node."
  15630. (interactive)
  15631. (info (format "(org)%s" (or node ""))))
  15632. ;;;###autoload
  15633. (defun org-submit-bug-report ()
  15634. "Submit a bug report on Org-mode via mail.
  15635. Don't hesitate to report any problems or inaccurate documentation.
  15636. If you don't have setup sending mail from (X)Emacs, please copy the
  15637. output buffer into your mail program, as it gives us important
  15638. information about your Org-mode version and configuration."
  15639. (interactive)
  15640. (require 'reporter)
  15641. (org-load-modules-maybe)
  15642. (org-require-autoloaded-modules)
  15643. (let ((reporter-prompt-for-summary-p "Bug report subject: "))
  15644. (reporter-submit-bug-report
  15645. "emacs-orgmode@gnu.org"
  15646. (org-version)
  15647. (let (list)
  15648. (save-window-excursion
  15649. (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
  15650. (delete-other-windows)
  15651. (erase-buffer)
  15652. (insert "You are about to submit a bug report to the Org-mode mailing list.
  15653. We would like to add your full Org-mode and Outline configuration to the
  15654. bug report. This greatly simplifies the work of the maintainer and
  15655. other experts on the mailing list.
  15656. HOWEVER, some variables you have customized may contain private
  15657. information. The names of customers, colleagues, or friends, might
  15658. appear in the form of file names, tags, todo states, or search strings.
  15659. If you answer yes to the prompt, you might want to check and remove
  15660. such private information before sending the email.")
  15661. (add-text-properties (point-min) (point-max) '(face org-warning))
  15662. (when (yes-or-no-p "Include your Org-mode configuration ")
  15663. (mapatoms
  15664. (lambda (v)
  15665. (and (boundp v)
  15666. (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
  15667. (or (and (symbol-value v)
  15668. (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
  15669. (and
  15670. (get v 'custom-type) (get v 'standard-value)
  15671. (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
  15672. (push v list)))))
  15673. (kill-buffer (get-buffer "*Warn about privacy*"))
  15674. list))
  15675. nil nil
  15676. "Remember to cover the basics, that is, what you expected to happen and
  15677. what in fact did happen. You don't know how to make a good report? See
  15678. http://orgmode.org/manual/Feedback.html#Feedback
  15679. Your bug report will be posted to the Org-mode mailing list.
  15680. ------------------------------------------------------------------------")
  15681. (save-excursion
  15682. (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
  15683. (replace-match "\\1Bug: \\3 [\\2]")))))
  15684. (defun org-install-agenda-files-menu ()
  15685. (let ((bl (buffer-list)))
  15686. (save-excursion
  15687. (while bl
  15688. (set-buffer (pop bl))
  15689. (if (org-mode-p) (setq bl nil)))
  15690. (when (org-mode-p)
  15691. (easy-menu-change
  15692. '("Org") "File List for Agenda"
  15693. (append
  15694. (list
  15695. ["Edit File List" (org-edit-agenda-file-list) t]
  15696. ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
  15697. ["Remove Current File from List" org-remove-file t]
  15698. ["Cycle through agenda files" org-cycle-agenda-files t]
  15699. ["Occur in all agenda files" org-occur-in-agenda-files t]
  15700. "--")
  15701. (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
  15702. ;;;; Documentation
  15703. ;;;###autoload
  15704. (defun org-require-autoloaded-modules ()
  15705. (interactive)
  15706. (mapc 'require
  15707. '(org-agenda org-archive org-ascii org-attach org-clock org-colview
  15708. org-docbook org-exp org-html org-icalendar
  15709. org-id org-latex
  15710. org-publish org-remember org-table
  15711. org-timer org-xoxo)))
  15712. ;;;###autoload
  15713. (defun org-reload (&optional uncompiled)
  15714. "Reload all org lisp files.
  15715. With prefix arg UNCOMPILED, load the uncompiled versions."
  15716. (interactive "P")
  15717. (require 'find-func)
  15718. (let* ((file-re "^\\(org\\|orgtbl\\)\\(\\.el\\|-.*\\.el\\)")
  15719. (dir-org (file-name-directory (org-find-library-name "org")))
  15720. (dir-org-contrib (ignore-errors
  15721. (file-name-directory
  15722. (org-find-library-name "org-contribdir"))))
  15723. (files
  15724. (append (directory-files dir-org t file-re)
  15725. (and dir-org-contrib
  15726. (directory-files dir-org-contrib t file-re))))
  15727. (remove-re (concat (if (featurep 'xemacs)
  15728. "org-colview" "org-colview-xemacs")
  15729. "\\'")))
  15730. (setq files (mapcar 'file-name-sans-extension files))
  15731. (setq files (mapcar
  15732. (lambda (x) (if (string-match remove-re x) nil x))
  15733. files))
  15734. (setq files (delq nil files))
  15735. (mapc
  15736. (lambda (f)
  15737. (when (featurep (intern (file-name-nondirectory f)))
  15738. (if (and (not uncompiled)
  15739. (file-exists-p (concat f ".elc")))
  15740. (load (concat f ".elc") nil nil t)
  15741. (load (concat f ".el") nil nil t))))
  15742. files))
  15743. (org-version))
  15744. ;;;###autoload
  15745. (defun org-customize ()
  15746. "Call the customize function with org as argument."
  15747. (interactive)
  15748. (org-load-modules-maybe)
  15749. (org-require-autoloaded-modules)
  15750. (customize-browse 'org))
  15751. (defun org-create-customize-menu ()
  15752. "Create a full customization menu for Org-mode, insert it into the menu."
  15753. (interactive)
  15754. (org-load-modules-maybe)
  15755. (org-require-autoloaded-modules)
  15756. (if (fboundp 'customize-menu-create)
  15757. (progn
  15758. (easy-menu-change
  15759. '("Org") "Customize"
  15760. `(["Browse Org group" org-customize t]
  15761. "--"
  15762. ,(customize-menu-create 'org)
  15763. ["Set" Custom-set t]
  15764. ["Save" Custom-save t]
  15765. ["Reset to Current" Custom-reset-current t]
  15766. ["Reset to Saved" Custom-reset-saved t]
  15767. ["Reset to Standard Settings" Custom-reset-standard t]))
  15768. (message "\"Org\"-menu now contains full customization menu"))
  15769. (error "Cannot expand menu (outdated version of cus-edit.el)")))
  15770. ;;;; Miscellaneous stuff
  15771. ;;; Generally useful functions
  15772. (defun org-get-at-bol (property)
  15773. "Get text property PROPERTY at beginning of line."
  15774. (get-text-property (point-at-bol) property))
  15775. (defun org-find-text-property-in-string (prop s)
  15776. "Return the first non-nil value of property PROP in string S."
  15777. (or (get-text-property 0 prop s)
  15778. (get-text-property (or (next-single-property-change 0 prop s) 0)
  15779. prop s)))
  15780. (defun org-display-warning (message) ;; Copied from Emacs-Muse
  15781. "Display the given MESSAGE as a warning."
  15782. (if (fboundp 'display-warning)
  15783. (display-warning 'org message
  15784. (if (featurep 'xemacs) 'warning :warning))
  15785. (let ((buf (get-buffer-create "*Org warnings*")))
  15786. (with-current-buffer buf
  15787. (goto-char (point-max))
  15788. (insert "Warning (Org): " message)
  15789. (unless (bolp)
  15790. (newline)))
  15791. (display-buffer buf)
  15792. (sit-for 0))))
  15793. (defun org-in-commented-line ()
  15794. "Is point in a line starting with `#'?"
  15795. (equal (char-after (point-at-bol)) ?#))
  15796. (defun org-in-verbatim-emphasis ()
  15797. (save-match-data
  15798. (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
  15799. (defun org-goto-marker-or-bmk (marker &optional bookmark)
  15800. "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
  15801. (if (and marker (marker-buffer marker)
  15802. (buffer-live-p (marker-buffer marker)))
  15803. (progn
  15804. (switch-to-buffer (marker-buffer marker))
  15805. (if (or (> marker (point-max)) (< marker (point-min)))
  15806. (widen))
  15807. (goto-char marker)
  15808. (org-show-context 'org-goto))
  15809. (if bookmark
  15810. (bookmark-jump bookmark)
  15811. (error "Cannot find location"))))
  15812. (defun org-quote-csv-field (s)
  15813. "Quote field for inclusion in CSV material."
  15814. (if (string-match "[\",]" s)
  15815. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
  15816. s))
  15817. (defun org-plist-delete (plist property)
  15818. "Delete PROPERTY from PLIST.
  15819. This is in contrast to merely setting it to 0."
  15820. (let (p)
  15821. (while plist
  15822. (if (not (eq property (car plist)))
  15823. (setq p (plist-put p (car plist) (nth 1 plist))))
  15824. (setq plist (cddr plist)))
  15825. p))
  15826. (defun org-force-self-insert (N)
  15827. "Needed to enforce self-insert under remapping."
  15828. (interactive "p")
  15829. (self-insert-command N))
  15830. (defun org-string-width (s)
  15831. "Compute width of string, ignoring invisible characters.
  15832. This ignores character with invisibility property `org-link', and also
  15833. characters with property `org-cwidth', because these will become invisible
  15834. upon the next fontification round."
  15835. (let (b l)
  15836. (when (or (eq t buffer-invisibility-spec)
  15837. (assq 'org-link buffer-invisibility-spec))
  15838. (while (setq b (text-property-any 0 (length s)
  15839. 'invisible 'org-link s))
  15840. (setq s (concat (substring s 0 b)
  15841. (substring s (or (next-single-property-change
  15842. b 'invisible s) (length s)))))))
  15843. (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
  15844. (setq s (concat (substring s 0 b)
  15845. (substring s (or (next-single-property-change
  15846. b 'org-cwidth s) (length s))))))
  15847. (setq l (string-width s) b -1)
  15848. (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
  15849. (setq l (- l (get-text-property b 'org-dwidth-n s))))
  15850. l))
  15851. (defun org-get-indentation (&optional line)
  15852. "Get the indentation of the current line, interpreting tabs.
  15853. When LINE is given, assume it represents a line and compute its indentation."
  15854. (if line
  15855. (if (string-match "^ *" (org-remove-tabs line))
  15856. (match-end 0))
  15857. (save-excursion
  15858. (beginning-of-line 1)
  15859. (skip-chars-forward " \t")
  15860. (current-column))))
  15861. (defun org-remove-tabs (s &optional width)
  15862. "Replace tabulators in S with spaces.
  15863. Assumes that s is a single line, starting in column 0."
  15864. (setq width (or width tab-width))
  15865. (while (string-match "\t" s)
  15866. (setq s (replace-match
  15867. (make-string
  15868. (- (* width (/ (+ (match-beginning 0) width) width))
  15869. (match-beginning 0)) ?\ )
  15870. t t s)))
  15871. s)
  15872. (defun org-fix-indentation (line ind)
  15873. "Fix indentation in LINE.
  15874. IND is a cons cell with target and minimum indentation.
  15875. If the current indentation in LINE is smaller than the minimum,
  15876. leave it alone. If it is larger than ind, set it to the target."
  15877. (let* ((l (org-remove-tabs line))
  15878. (i (org-get-indentation l))
  15879. (i1 (car ind)) (i2 (cdr ind)))
  15880. (if (>= i i2) (setq l (substring line i2)))
  15881. (if (> i1 0)
  15882. (concat (make-string i1 ?\ ) l)
  15883. l)))
  15884. (defun org-remove-indentation (code &optional n)
  15885. "Remove the maximum common indentation from the lines in CODE.
  15886. N may optionally be the number of spaces to remove."
  15887. (with-temp-buffer
  15888. (insert code)
  15889. (org-do-remove-indentation n)
  15890. (buffer-string)))
  15891. (defun org-do-remove-indentation (&optional n)
  15892. "Remove the maximum common indentation from the buffer."
  15893. (untabify (point-min) (point-max))
  15894. (let ((min 10000) re)
  15895. (if n
  15896. (setq min n)
  15897. (goto-char (point-min))
  15898. (while (re-search-forward "^ *[^ \n]" nil t)
  15899. (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
  15900. (unless (or (= min 0) (= min 10000))
  15901. (setq re (format "^ \\{%d\\}" min))
  15902. (goto-char (point-min))
  15903. (while (re-search-forward re nil t)
  15904. (replace-match "")
  15905. (end-of-line 1))
  15906. min)))
  15907. (defun org-fill-template (template alist)
  15908. "Find each %key of ALIST in TEMPLATE and replace it."
  15909. (let ((case-fold-search nil)
  15910. entry key value)
  15911. (setq alist (sort (copy-sequence alist)
  15912. (lambda (a b) (< (length (car a)) (length (car b))))))
  15913. (while (setq entry (pop alist))
  15914. (setq template
  15915. (replace-regexp-in-string
  15916. (concat "%" (regexp-quote (car entry)))
  15917. (cdr entry) template t t)))
  15918. template))
  15919. (defun org-base-buffer (buffer)
  15920. "Return the base buffer of BUFFER, if it has one. Else return the buffer."
  15921. (if (not buffer)
  15922. buffer
  15923. (or (buffer-base-buffer buffer)
  15924. buffer)))
  15925. (defun org-trim (s)
  15926. "Remove whitespace at beginning and end of string."
  15927. (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
  15928. (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
  15929. s)
  15930. (defun org-wrap (string &optional width lines)
  15931. "Wrap string to either a number of lines, or a width in characters.
  15932. If WIDTH is non-nil, the string is wrapped to that width, however many lines
  15933. that costs. If there is a word longer than WIDTH, the text is actually
  15934. wrapped to the length of that word.
  15935. IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
  15936. many lines, whatever width that takes.
  15937. The return value is a list of lines, without newlines at the end."
  15938. (let* ((words (org-split-string string "[ \t\n]+"))
  15939. (maxword (apply 'max (mapcar 'org-string-width words)))
  15940. w ll)
  15941. (cond (width
  15942. (org-do-wrap words (max maxword width)))
  15943. (lines
  15944. (setq w maxword)
  15945. (setq ll (org-do-wrap words maxword))
  15946. (if (<= (length ll) lines)
  15947. ll
  15948. (setq ll words)
  15949. (while (> (length ll) lines)
  15950. (setq w (1+ w))
  15951. (setq ll (org-do-wrap words w)))
  15952. ll))
  15953. (t (error "Cannot wrap this")))))
  15954. (defun org-do-wrap (words width)
  15955. "Create lines of maximum width WIDTH (in characters) from word list WORDS."
  15956. (let (lines line)
  15957. (while words
  15958. (setq line (pop words))
  15959. (while (and words (< (+ (length line) (length (car words))) width))
  15960. (setq line (concat line " " (pop words))))
  15961. (setq lines (push line lines)))
  15962. (nreverse lines)))
  15963. (defun org-split-string (string &optional separators)
  15964. "Splits STRING into substrings at SEPARATORS.
  15965. No empty strings are returned if there are matches at the beginning
  15966. and end of string."
  15967. (let ((rexp (or separators "[ \f\t\n\r\v]+"))
  15968. (start 0)
  15969. notfirst
  15970. (list nil))
  15971. (while (and (string-match rexp string
  15972. (if (and notfirst
  15973. (= start (match-beginning 0))
  15974. (< start (length string)))
  15975. (1+ start) start))
  15976. (< (match-beginning 0) (length string)))
  15977. (setq notfirst t)
  15978. (or (eq (match-beginning 0) 0)
  15979. (and (eq (match-beginning 0) (match-end 0))
  15980. (eq (match-beginning 0) start))
  15981. (setq list
  15982. (cons (substring string start (match-beginning 0))
  15983. list)))
  15984. (setq start (match-end 0)))
  15985. (or (eq start (length string))
  15986. (setq list
  15987. (cons (substring string start)
  15988. list)))
  15989. (nreverse list)))
  15990. (defun org-quote-vert (s)
  15991. "Replace \"|\" with \"\\vert\"."
  15992. (while (string-match "|" s)
  15993. (setq s (replace-match "\\vert" t t s)))
  15994. s)
  15995. (defun org-uuidgen-p (s)
  15996. "Is S an ID created by UUIDGEN?"
  15997. (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
  15998. (defun org-context ()
  15999. "Return a list of contexts of the current cursor position.
  16000. If several contexts apply, all are returned.
  16001. Each context entry is a list with a symbol naming the context, and
  16002. two positions indicating start and end of the context. Possible
  16003. contexts are:
  16004. :headline anywhere in a headline
  16005. :headline-stars on the leading stars in a headline
  16006. :todo-keyword on a TODO keyword (including DONE) in a headline
  16007. :tags on the TAGS in a headline
  16008. :priority on the priority cookie in a headline
  16009. :item on the first line of a plain list item
  16010. :item-bullet on the bullet/number of a plain list item
  16011. :checkbox on the checkbox in a plain list item
  16012. :table in an org-mode table
  16013. :table-special on a special filed in a table
  16014. :table-table in a table.el table
  16015. :link on a hyperlink
  16016. :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
  16017. :target on a <<target>>
  16018. :radio-target on a <<<radio-target>>>
  16019. :latex-fragment on a LaTeX fragment
  16020. :latex-preview on a LaTeX fragment with overlayed preview image
  16021. This function expects the position to be visible because it uses font-lock
  16022. faces as a help to recognize the following contexts: :table-special, :link,
  16023. and :keyword."
  16024. (let* ((f (get-text-property (point) 'face))
  16025. (faces (if (listp f) f (list f)))
  16026. (p (point)) clist o)
  16027. ;; First the large context
  16028. (cond
  16029. ((org-on-heading-p t)
  16030. (push (list :headline (point-at-bol) (point-at-eol)) clist)
  16031. (when (progn
  16032. (beginning-of-line 1)
  16033. (looking-at org-todo-line-tags-regexp))
  16034. (push (org-point-in-group p 1 :headline-stars) clist)
  16035. (push (org-point-in-group p 2 :todo-keyword) clist)
  16036. (push (org-point-in-group p 4 :tags) clist))
  16037. (goto-char p)
  16038. (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
  16039. (if (looking-at "\\[#[A-Z0-9]\\]")
  16040. (push (org-point-in-group p 0 :priority) clist)))
  16041. ((org-at-item-p)
  16042. (push (org-point-in-group p 2 :item-bullet) clist)
  16043. (push (list :item (point-at-bol)
  16044. (save-excursion (org-end-of-item) (point)))
  16045. clist)
  16046. (and (org-at-item-checkbox-p)
  16047. (push (org-point-in-group p 0 :checkbox) clist)))
  16048. ((org-at-table-p)
  16049. (push (list :table (org-table-begin) (org-table-end)) clist)
  16050. (if (memq 'org-formula faces)
  16051. (push (list :table-special
  16052. (previous-single-property-change p 'face)
  16053. (next-single-property-change p 'face)) clist)))
  16054. ((org-at-table-p 'any)
  16055. (push (list :table-table) clist)))
  16056. (goto-char p)
  16057. ;; Now the small context
  16058. (cond
  16059. ((org-at-timestamp-p)
  16060. (push (org-point-in-group p 0 :timestamp) clist))
  16061. ((memq 'org-link faces)
  16062. (push (list :link
  16063. (previous-single-property-change p 'face)
  16064. (next-single-property-change p 'face)) clist))
  16065. ((memq 'org-special-keyword faces)
  16066. (push (list :keyword
  16067. (previous-single-property-change p 'face)
  16068. (next-single-property-change p 'face)) clist))
  16069. ((org-on-target-p)
  16070. (push (org-point-in-group p 0 :target) clist)
  16071. (goto-char (1- (match-beginning 0)))
  16072. (if (looking-at org-radio-target-regexp)
  16073. (push (org-point-in-group p 0 :radio-target) clist))
  16074. (goto-char p))
  16075. ((setq o (car (delq nil
  16076. (mapcar
  16077. (lambda (x)
  16078. (if (memq x org-latex-fragment-image-overlays) x))
  16079. (overlays-at (point))))))
  16080. (push (list :latex-fragment
  16081. (overlay-start o) (overlay-end o)) clist)
  16082. (push (list :latex-preview
  16083. (overlay-start o) (overlay-end o)) clist))
  16084. ((org-inside-LaTeX-fragment-p)
  16085. ;; FIXME: positions wrong.
  16086. (push (list :latex-fragment (point) (point)) clist)))
  16087. (setq clist (nreverse (delq nil clist)))
  16088. clist))
  16089. ;; FIXME: Compare with at-regexp-p Do we need both?
  16090. (defun org-in-regexp (re &optional nlines visually)
  16091. "Check if point is inside a match of regexp.
  16092. Normally only the current line is checked, but you can include NLINES extra
  16093. lines both before and after point into the search.
  16094. If VISUALLY is set, require that the cursor is not after the match but
  16095. really on, so that the block visually is on the match."
  16096. (catch 'exit
  16097. (let ((pos (point))
  16098. (eol (point-at-eol (+ 1 (or nlines 0))))
  16099. (inc (if visually 1 0)))
  16100. (save-excursion
  16101. (beginning-of-line (- 1 (or nlines 0)))
  16102. (while (re-search-forward re eol t)
  16103. (if (and (<= (match-beginning 0) pos)
  16104. (>= (+ inc (match-end 0)) pos))
  16105. (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
  16106. (defun org-at-regexp-p (regexp)
  16107. "Is point inside a match of REGEXP in the current line?"
  16108. (catch 'exit
  16109. (save-excursion
  16110. (let ((pos (point)) (end (point-at-eol)))
  16111. (beginning-of-line 1)
  16112. (while (re-search-forward regexp end t)
  16113. (if (and (<= (match-beginning 0) pos)
  16114. (>= (match-end 0) pos))
  16115. (throw 'exit t)))
  16116. nil))))
  16117. (defun org-in-regexps-block-p (start-re end-re)
  16118. "Returns t if the current point is between matches of START-RE and END-RE.
  16119. This will also return to if point is on one of the two matches."
  16120. (interactive)
  16121. (let ((p (point)))
  16122. (save-excursion
  16123. (and (or (org-at-regexp-p start-re)
  16124. (re-search-backward start-re nil t))
  16125. (re-search-forward end-re nil t)
  16126. (>= (point) p)))))
  16127. (defun org-occur-in-agenda-files (regexp &optional nlines)
  16128. "Call `multi-occur' with buffers for all agenda files."
  16129. (interactive "sOrg-files matching: \np")
  16130. (let* ((files (org-agenda-files))
  16131. (tnames (mapcar 'file-truename files))
  16132. (extra org-agenda-text-search-extra-files)
  16133. f)
  16134. (when (eq (car extra) 'agenda-archives)
  16135. (setq extra (cdr extra))
  16136. (setq files (org-add-archive-files files)))
  16137. (while (setq f (pop extra))
  16138. (unless (member (file-truename f) tnames)
  16139. (add-to-list 'files f 'append)
  16140. (add-to-list 'tnames (file-truename f) 'append)))
  16141. (multi-occur
  16142. (mapcar (lambda (x)
  16143. (with-current-buffer
  16144. (or (get-file-buffer x) (find-file-noselect x))
  16145. (widen)
  16146. (current-buffer)))
  16147. files)
  16148. regexp)))
  16149. (if (boundp 'occur-mode-find-occurrence-hook)
  16150. ;; Emacs 23
  16151. (add-hook 'occur-mode-find-occurrence-hook
  16152. (lambda ()
  16153. (when (org-mode-p)
  16154. (org-reveal))))
  16155. ;; Emacs 22
  16156. (defadvice occur-mode-goto-occurrence
  16157. (after org-occur-reveal activate)
  16158. (and (org-mode-p) (org-reveal)))
  16159. (defadvice occur-mode-goto-occurrence-other-window
  16160. (after org-occur-reveal activate)
  16161. (and (org-mode-p) (org-reveal)))
  16162. (defadvice occur-mode-display-occurrence
  16163. (after org-occur-reveal activate)
  16164. (when (org-mode-p)
  16165. (let ((pos (occur-mode-find-occurrence)))
  16166. (with-current-buffer (marker-buffer pos)
  16167. (save-excursion
  16168. (goto-char pos)
  16169. (org-reveal)))))))
  16170. (defun org-occur-link-in-agenda-files ()
  16171. "Create a link and search for it in the agendas.
  16172. The link is not stored in `org-stored-links', it is just created
  16173. for the search purpose."
  16174. (interactive)
  16175. (let ((link (condition-case nil
  16176. (org-store-link nil)
  16177. (error "Unable to create a link to here"))))
  16178. (org-occur-in-agenda-files (regexp-quote link))))
  16179. (defun org-uniquify (list)
  16180. "Remove duplicate elements from LIST."
  16181. (let (res)
  16182. (mapc (lambda (x) (add-to-list 'res x 'append)) list)
  16183. res))
  16184. (defun org-delete-all (elts list)
  16185. "Remove all elements in ELTS from LIST."
  16186. (while elts
  16187. (setq list (delete (pop elts) list)))
  16188. list)
  16189. (defun org-remove-if (predicate seq)
  16190. "Remove everything from SEQ that fulfills PREDICATE."
  16191. (let (res e)
  16192. (while seq
  16193. (setq e (pop seq))
  16194. (if (not (funcall predicate e)) (push e res)))
  16195. (nreverse res)))
  16196. (defun org-remove-if-not (predicate seq)
  16197. "Remove everything from SEQ that does not fulfill PREDICATE."
  16198. (let (res e)
  16199. (while seq
  16200. (setq e (pop seq))
  16201. (if (funcall predicate e) (push e res)))
  16202. (nreverse res)))
  16203. (defun org-back-over-empty-lines ()
  16204. "Move backwards over whitespace, to the beginning of the first empty line.
  16205. Returns the number of empty lines passed."
  16206. (let ((pos (point)))
  16207. (skip-chars-backward " \t\n\r")
  16208. (beginning-of-line 2)
  16209. (goto-char (min (point) pos))
  16210. (count-lines (point) pos)))
  16211. (defun org-skip-whitespace ()
  16212. (skip-chars-forward " \t\n\r"))
  16213. (defun org-point-in-group (point group &optional context)
  16214. "Check if POINT is in match-group GROUP.
  16215. If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
  16216. match. If the match group does ot exist or point is not inside it,
  16217. return nil."
  16218. (and (match-beginning group)
  16219. (>= point (match-beginning group))
  16220. (<= point (match-end group))
  16221. (if context
  16222. (list context (match-beginning group) (match-end group))
  16223. t)))
  16224. (defun org-switch-to-buffer-other-window (&rest args)
  16225. "Switch to buffer in a second window on the current frame.
  16226. In particular, do not allow pop-up frames."
  16227. (let (pop-up-frames special-display-buffer-names special-display-regexps
  16228. special-display-function)
  16229. (apply 'switch-to-buffer-other-window args)))
  16230. (defun org-combine-plists (&rest plists)
  16231. "Create a single property list from all plists in PLISTS.
  16232. The process starts by copying the first list, and then setting properties
  16233. from the other lists. Settings in the last list are the most significant
  16234. ones and overrule settings in the other lists."
  16235. (let ((rtn (copy-sequence (pop plists)))
  16236. p v ls)
  16237. (while plists
  16238. (setq ls (pop plists))
  16239. (while ls
  16240. (setq p (pop ls) v (pop ls))
  16241. (setq rtn (plist-put rtn p v))))
  16242. rtn))
  16243. (defun org-move-line-down (arg)
  16244. "Move the current line down. With prefix argument, move it past ARG lines."
  16245. (interactive "p")
  16246. (let ((col (current-column))
  16247. beg end pos)
  16248. (beginning-of-line 1) (setq beg (point))
  16249. (beginning-of-line 2) (setq end (point))
  16250. (beginning-of-line (+ 1 arg))
  16251. (setq pos (move-marker (make-marker) (point)))
  16252. (insert (delete-and-extract-region beg end))
  16253. (goto-char pos)
  16254. (org-move-to-column col)))
  16255. (defun org-move-line-up (arg)
  16256. "Move the current line up. With prefix argument, move it past ARG lines."
  16257. (interactive "p")
  16258. (let ((col (current-column))
  16259. beg end pos)
  16260. (beginning-of-line 1) (setq beg (point))
  16261. (beginning-of-line 2) (setq end (point))
  16262. (beginning-of-line (- arg))
  16263. (setq pos (move-marker (make-marker) (point)))
  16264. (insert (delete-and-extract-region beg end))
  16265. (goto-char pos)
  16266. (org-move-to-column col)))
  16267. (defun org-replace-escapes (string table)
  16268. "Replace %-escapes in STRING with values in TABLE.
  16269. TABLE is an association list with keys like \"%a\" and string values.
  16270. The sequences in STRING may contain normal field width and padding information,
  16271. for example \"%-5s\". Replacements happen in the sequence given by TABLE,
  16272. so values can contain further %-escapes if they are define later in TABLE."
  16273. (let ((tbl (copy-alist table))
  16274. (case-fold-search nil)
  16275. (pchg 0)
  16276. e re rpl)
  16277. (while (setq e (pop tbl))
  16278. (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
  16279. (when (and (cdr e) (string-match re (cdr e)))
  16280. (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
  16281. (safe "SREF"))
  16282. (add-text-properties 0 3 (list 'sref sref) safe)
  16283. (setcdr e (replace-match safe t t (cdr e)))))
  16284. (while (string-match re string)
  16285. (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
  16286. (cdr e)))
  16287. (setq string (replace-match rpl t t string))))
  16288. (while (setq pchg (next-property-change pchg string))
  16289. (let ((sref (get-text-property pchg 'sref string)))
  16290. (when (and sref (string-match "SREF" string pchg))
  16291. (setq string (replace-match sref t t string)))))
  16292. string))
  16293. (defun org-sublist (list start end)
  16294. "Return a section of LIST, from START to END.
  16295. Counting starts at 1."
  16296. (let (rtn (c start))
  16297. (setq list (nthcdr (1- start) list))
  16298. (while (and list (<= c end))
  16299. (push (pop list) rtn)
  16300. (setq c (1+ c)))
  16301. (nreverse rtn)))
  16302. (defun org-find-base-buffer-visiting (file)
  16303. "Like `find-buffer-visiting' but always return the base buffer and
  16304. not an indirect buffer."
  16305. (let ((buf (or (get-file-buffer file)
  16306. (find-buffer-visiting file))))
  16307. (if buf
  16308. (or (buffer-base-buffer buf) buf)
  16309. nil)))
  16310. (defun org-image-file-name-regexp (&optional extensions)
  16311. "Return regexp matching the file names of images.
  16312. If EXTENSIONS is given, only match these."
  16313. (if (and (not extensions) (fboundp 'image-file-name-regexp))
  16314. (image-file-name-regexp)
  16315. (let ((image-file-name-extensions
  16316. (or extensions
  16317. '("png" "jpeg" "jpg" "gif" "tiff" "tif"
  16318. "xbm" "xpm" "pbm" "pgm" "ppm"))))
  16319. (concat "\\."
  16320. (regexp-opt (nconc (mapcar 'upcase
  16321. image-file-name-extensions)
  16322. image-file-name-extensions)
  16323. t)
  16324. "\\'"))))
  16325. (defun org-file-image-p (file &optional extensions)
  16326. "Return non-nil if FILE is an image."
  16327. (save-match-data
  16328. (string-match (org-image-file-name-regexp extensions) file)))
  16329. (defun org-get-cursor-date ()
  16330. "Return the date at cursor in as a time.
  16331. This works in the calendar and in the agenda, anywhere else it just
  16332. returns the current time."
  16333. (let (date day defd)
  16334. (cond
  16335. ((eq major-mode 'calendar-mode)
  16336. (setq date (calendar-cursor-to-date)
  16337. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  16338. ((eq major-mode 'org-agenda-mode)
  16339. (setq day (get-text-property (point) 'day))
  16340. (if day
  16341. (setq date (calendar-gregorian-from-absolute day)
  16342. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  16343. (nth 2 date))))))
  16344. (or defd (current-time))))
  16345. (defvar org-agenda-action-marker (make-marker)
  16346. "Marker pointing to the entry for the next agenda action.")
  16347. (defun org-mark-entry-for-agenda-action ()
  16348. "Mark the current entry as target of an agenda action.
  16349. Agenda actions are actions executed from the agenda with the key `k',
  16350. which make use of the date at the cursor."
  16351. (interactive)
  16352. (move-marker org-agenda-action-marker
  16353. (save-excursion (org-back-to-heading t) (point))
  16354. (current-buffer))
  16355. (message
  16356. "Entry marked for action; press `k' at desired date in agenda or calendar"))
  16357. ;;; Paragraph filling stuff.
  16358. ;; We want this to be just right, so use the full arsenal.
  16359. (defun org-indent-line-function ()
  16360. "Indent line like previous, but further if previous was headline or item."
  16361. (interactive)
  16362. (let* ((pos (point))
  16363. (itemp (org-at-item-p))
  16364. (case-fold-search t)
  16365. (org-drawer-regexp (or org-drawer-regexp "\000"))
  16366. column bpos bcol tpos tcol bullet btype bullet-type)
  16367. ;; Find the previous relevant line
  16368. (beginning-of-line 1)
  16369. (cond
  16370. ((looking-at "#") (setq column 0))
  16371. ((looking-at "\\*+ ") (setq column 0))
  16372. ((and (looking-at "[ \t]*:END:")
  16373. (save-excursion (re-search-backward org-drawer-regexp nil t)))
  16374. (save-excursion
  16375. (goto-char (1- (match-beginning 1)))
  16376. (setq column (current-column))))
  16377. ((and (looking-at "[ \t]+#\\+end_\\([a-z]+\\)")
  16378. (save-excursion
  16379. (re-search-backward
  16380. (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
  16381. (setq column (org-get-indentation (match-string 0))))
  16382. (t
  16383. (beginning-of-line 0)
  16384. (while (and (not (bobp)) (looking-at "[ \t]*[\n:#|]")
  16385. (not (looking-at "[ \t]*:END:"))
  16386. (not (looking-at org-drawer-regexp)))
  16387. (beginning-of-line 0))
  16388. (cond
  16389. ((looking-at "\\*+[ \t]+")
  16390. (if (not org-adapt-indentation)
  16391. (setq column 0)
  16392. (goto-char (match-end 0))
  16393. (setq column (current-column))))
  16394. ((looking-at org-drawer-regexp)
  16395. (goto-char (1- (match-beginning 1)))
  16396. (setq column (current-column)))
  16397. ((looking-at "\\([ \t]*\\):END:")
  16398. (goto-char (match-end 1))
  16399. (setq column (current-column)))
  16400. ((org-in-item-p)
  16401. (org-beginning-of-item)
  16402. (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\[[- X]\\][ \t]*\\|.*? :: \\)?")
  16403. (setq bpos (match-beginning 1) tpos (match-end 0)
  16404. bcol (progn (goto-char bpos) (current-column))
  16405. tcol (progn (goto-char tpos) (current-column))
  16406. bullet (match-string 1)
  16407. bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
  16408. (if (> tcol (+ bcol org-description-max-indent))
  16409. (setq tcol (+ bcol 5)))
  16410. (if (not itemp)
  16411. (setq column tcol)
  16412. (goto-char pos)
  16413. (beginning-of-line 1)
  16414. (if (looking-at "\\S-")
  16415. (progn
  16416. (looking-at "[ \t]*\\(\\S-+\\)[ \t]*")
  16417. (setq bullet (match-string 1)
  16418. btype (if (string-match "[0-9]" bullet) "n" bullet))
  16419. (setq column (if (equal btype bullet-type) bcol tcol)))
  16420. (setq column (org-get-indentation)))))
  16421. (t (setq column (org-get-indentation))))))
  16422. (goto-char pos)
  16423. (if (<= (current-column) (current-indentation))
  16424. (org-indent-line-to column)
  16425. (save-excursion (org-indent-line-to column)))
  16426. (setq column (current-column))
  16427. (beginning-of-line 1)
  16428. (if (looking-at
  16429. "\\([ \t]+\\)\\(:[-_0-9a-zA-Z]+:\\)[ \t]*\\(\\S-.*\\(\\S-\\|$\\)\\)")
  16430. (replace-match (concat (match-string 1)
  16431. (format org-property-format
  16432. (match-string 2) (match-string 3)))
  16433. t t))
  16434. (org-move-to-column column)))
  16435. (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
  16436. "Variable to store copy of `adaptive-fill-regexp'.
  16437. Since `adaptive-fill-regexp' is set to never match, we need to
  16438. store a backup of its value before entering `org-mode' so that
  16439. the functionality can be provided as a fall-back.")
  16440. (defun org-set-autofill-regexps ()
  16441. (interactive)
  16442. ;; In the paragraph separator we include headlines, because filling
  16443. ;; text in a line directly attached to a headline would otherwise
  16444. ;; fill the headline as well.
  16445. (org-set-local 'comment-start-skip "^#+[ \t]*")
  16446. (org-set-local 'paragraph-separate "\f\\|\\*+ \\|[ ]*$\\|[ \t]*[:|#]")
  16447. ;; The paragraph starter includes hand-formatted lists.
  16448. (org-set-local
  16449. 'paragraph-start
  16450. (concat
  16451. "\f" "\\|"
  16452. "[ ]*$" "\\|"
  16453. "\\*+ " "\\|"
  16454. "[ \t]*#" "\\|"
  16455. "[ \t]*\\([-+*][ \t]+\\|[0-9]+[.)][ \t]+\\)" "\\|"
  16456. "[ \t]*[:|]" "\\|"
  16457. "\\$\\$" "\\|"
  16458. "\\\\\\(begin\\|end\\|[][]\\)"))
  16459. ;; Inhibit auto-fill for headers, tables and fixed-width lines.
  16460. ;; But only if the user has not turned off tables or fixed-width regions
  16461. (org-set-local
  16462. 'auto-fill-inhibit-regexp
  16463. (concat "\\*+ \\|#\\+"
  16464. "\\|[ \t]*" org-keyword-time-regexp
  16465. (if (or org-enable-table-editor org-enable-fixed-width-editor)
  16466. (concat
  16467. "\\|[ \t]*["
  16468. (if org-enable-table-editor "|" "")
  16469. (if org-enable-fixed-width-editor ":" "")
  16470. "]"))))
  16471. ;; We use our own fill-paragraph function, to make sure that tables
  16472. ;; and fixed-width regions are not wrapped. That function will pass
  16473. ;; through to `fill-paragraph' when appropriate.
  16474. (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
  16475. ;; Adaptive filling: To get full control, first make sure that
  16476. ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
  16477. (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
  16478. (org-set-local 'org-adaptive-fill-regexp-backup
  16479. adaptive-fill-regexp))
  16480. (org-set-local 'adaptive-fill-regexp "\000")
  16481. (org-set-local 'adaptive-fill-function
  16482. 'org-adaptive-fill-function)
  16483. (org-set-local
  16484. 'align-mode-rules-list
  16485. '((org-in-buffer-settings
  16486. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  16487. (modes . '(org-mode))))))
  16488. (defun org-fill-paragraph (&optional justify)
  16489. "Re-align a table, pass through to fill-paragraph if no table."
  16490. (let ((table-p (org-at-table-p))
  16491. (table.el-p (org-at-table.el-p)))
  16492. (cond ((and (equal (char-after (point-at-bol)) ?*)
  16493. (save-excursion (goto-char (point-at-bol))
  16494. (looking-at outline-regexp)))
  16495. t) ; skip headlines
  16496. (table.el-p t) ; skip table.el tables
  16497. (table-p (org-table-align) t) ; align org-mode tables
  16498. (t nil)))) ; call paragraph-fill
  16499. ;; For reference, this is the default value of adaptive-fill-regexp
  16500. ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
  16501. (defun org-adaptive-fill-function ()
  16502. "Return a fill prefix for org-mode files.
  16503. In particular, this makes sure hanging paragraphs for hand-formatted lists
  16504. work correctly."
  16505. (cond
  16506. ;; Comment line
  16507. ((looking-at "#[ \t]+")
  16508. (match-string-no-properties 0))
  16509. ;; Description list
  16510. ((looking-at "[ \t]*\\([-*+] .*? :: \\)")
  16511. (save-excursion
  16512. (if (> (match-end 1) (+ (match-beginning 1)
  16513. org-description-max-indent))
  16514. (goto-char (+ (match-beginning 1) 5))
  16515. (goto-char (match-end 0)))
  16516. (make-string (current-column) ?\ )))
  16517. ;; Ordered or unordered list
  16518. ((looking-at "[ \t]*\\([-*+] \\|[0-9]+[.)] ?\\)")
  16519. (save-excursion
  16520. (goto-char (match-end 0))
  16521. (make-string (current-column) ?\ )))
  16522. ;; Other text
  16523. ((looking-at org-adaptive-fill-regexp-backup)
  16524. (match-string-no-properties 0))))
  16525. ;;; Other stuff.
  16526. (defun org-toggle-fixed-width-section (arg)
  16527. "Toggle the fixed-width export.
  16528. If there is no active region, the QUOTE keyword at the current headline is
  16529. inserted or removed. When present, it causes the text between this headline
  16530. and the next to be exported as fixed-width text, and unmodified.
  16531. If there is an active region, this command adds or removes a colon as the
  16532. first character of this line. If the first character of a line is a colon,
  16533. this line is also exported in fixed-width font."
  16534. (interactive "P")
  16535. (let* ((cc 0)
  16536. (regionp (org-region-active-p))
  16537. (beg (if regionp (region-beginning) (point)))
  16538. (end (if regionp (region-end)))
  16539. (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
  16540. (case-fold-search nil)
  16541. (re "[ \t]*\\(: \\)")
  16542. off)
  16543. (if regionp
  16544. (save-excursion
  16545. (goto-char beg)
  16546. (setq cc (current-column))
  16547. (beginning-of-line 1)
  16548. (setq off (looking-at re))
  16549. (while (> nlines 0)
  16550. (setq nlines (1- nlines))
  16551. (beginning-of-line 1)
  16552. (cond
  16553. (arg
  16554. (org-move-to-column cc t)
  16555. (insert ": \n")
  16556. (forward-line -1))
  16557. ((and off (looking-at re))
  16558. (replace-match "" t t nil 1))
  16559. ((not off) (org-move-to-column cc t) (insert ": ")))
  16560. (forward-line 1)))
  16561. (save-excursion
  16562. (org-back-to-heading)
  16563. (if (looking-at (concat outline-regexp
  16564. "\\( *\\<" org-quote-string "\\>[ \t]*\\)"))
  16565. (replace-match "" t t nil 1)
  16566. (if (looking-at outline-regexp)
  16567. (progn
  16568. (goto-char (match-end 0))
  16569. (insert org-quote-string " "))))))))
  16570. (defun org-reftex-citation ()
  16571. "Use reftex-citation to insert a citation into the buffer.
  16572. This looks for a line like
  16573. #+BIBLIOGRAPHY: foo plain option:-d
  16574. and derives from it that foo.bib is the bibliography file relevant
  16575. for this document. It then installs the necessary environment for RefTeX
  16576. to work in this buffer and calls `reftex-citation' to insert a citation
  16577. into the buffer.
  16578. Export of such citations to both LaTeX and HTML is handled by the contributed
  16579. package org-exp-bibtex by Taru Karttunen."
  16580. (interactive)
  16581. (let ((reftex-docstruct-symbol 'rds)
  16582. (reftex-cite-format "\\cite{%l}")
  16583. rds bib)
  16584. (save-excursion
  16585. (save-restriction
  16586. (widen)
  16587. (let ((case-fold-search t)
  16588. (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
  16589. (if (not (save-excursion
  16590. (or (re-search-forward re nil t)
  16591. (re-search-backward re nil t))))
  16592. (error "No bibliography defined in file")
  16593. (setq bib (concat (match-string 1) ".bib")
  16594. rds (list (list 'bib bib)))))))
  16595. (call-interactively 'reftex-citation)))
  16596. ;;;; Functions extending outline functionality
  16597. (defun org-beginning-of-line (&optional arg)
  16598. "Go to the beginning of the current line. If that is invisible, continue
  16599. to a visible line beginning. This makes the function of C-a more intuitive.
  16600. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  16601. first attempt, and only move to after the tags when the cursor is already
  16602. beyond the end of the headline."
  16603. (interactive "P")
  16604. (let ((pos (point))
  16605. (special (if (consp org-special-ctrl-a/e)
  16606. (car org-special-ctrl-a/e)
  16607. org-special-ctrl-a/e))
  16608. refpos)
  16609. (if (org-bound-and-true-p line-move-visual)
  16610. (beginning-of-visual-line 1)
  16611. (beginning-of-line 1))
  16612. (if (and arg (fboundp 'move-beginning-of-line))
  16613. (call-interactively 'move-beginning-of-line)
  16614. (if (bobp)
  16615. nil
  16616. (backward-char 1)
  16617. (if (org-invisible-p)
  16618. (while (and (not (bobp)) (org-invisible-p))
  16619. (backward-char 1)
  16620. (beginning-of-line 1))
  16621. (forward-char 1))))
  16622. (when special
  16623. (cond
  16624. ((and (looking-at org-complex-heading-regexp)
  16625. (= (char-after (match-end 1)) ?\ ))
  16626. (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
  16627. (point-at-eol)))
  16628. (goto-char
  16629. (if (eq special t)
  16630. (cond ((> pos refpos) refpos)
  16631. ((= pos (point)) refpos)
  16632. (t (point)))
  16633. (cond ((> pos (point)) (point))
  16634. ((not (eq last-command this-command)) (point))
  16635. (t refpos)))))
  16636. ((org-at-item-p)
  16637. (goto-char
  16638. (if (eq special t)
  16639. (cond ((> pos (match-end 4)) (match-end 4))
  16640. ((= pos (point)) (match-end 4))
  16641. (t (point)))
  16642. (cond ((> pos (point)) (point))
  16643. ((not (eq last-command this-command)) (point))
  16644. (t (match-end 4))))))))
  16645. (org-no-warnings
  16646. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  16647. (defun org-end-of-line (&optional arg)
  16648. "Go to the end of the line.
  16649. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  16650. first attempt, and only move to after the tags when the cursor is already
  16651. beyond the end of the headline."
  16652. (interactive "P")
  16653. (let ((special (if (consp org-special-ctrl-a/e)
  16654. (cdr org-special-ctrl-a/e)
  16655. org-special-ctrl-a/e)))
  16656. (if (or (not special)
  16657. (not (org-on-heading-p))
  16658. arg)
  16659. (call-interactively
  16660. (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
  16661. ((fboundp 'move-end-of-line) 'move-end-of-line)
  16662. (t 'end-of-line)))
  16663. (let ((pos (point)))
  16664. (beginning-of-line 1)
  16665. (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@:]+:\\)?[ \t]*\\)?$"))
  16666. (if (eq special t)
  16667. (if (or (< pos (match-beginning 1))
  16668. (= pos (match-end 0)))
  16669. (goto-char (match-beginning 1))
  16670. (goto-char (match-end 0)))
  16671. (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
  16672. (goto-char (match-end 0))
  16673. (goto-char (match-beginning 1))))
  16674. (call-interactively (if (fboundp 'move-end-of-line)
  16675. 'move-end-of-line
  16676. 'end-of-line)))))
  16677. (org-no-warnings
  16678. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  16679. (define-key org-mode-map "\C-a" 'org-beginning-of-line)
  16680. (define-key org-mode-map "\C-e" 'org-end-of-line)
  16681. (define-key org-mode-map [home] 'org-beginning-of-line)
  16682. (define-key org-mode-map [end] 'org-end-of-line)
  16683. (defun org-backward-sentence (&optional arg)
  16684. "Go to beginning of sentence, or beginning of table field.
  16685. This will call `backward-sentence' or `org-table-beginning-of-field',
  16686. depending on context."
  16687. (interactive "P")
  16688. (cond
  16689. ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
  16690. (t (call-interactively 'backward-sentence))))
  16691. (defun org-forward-sentence (&optional arg)
  16692. "Go to end of sentence, or end of table field.
  16693. This will call `forward-sentence' or `org-table-end-of-field',
  16694. depending on context."
  16695. (interactive "P")
  16696. (cond
  16697. ((org-at-table-p) (call-interactively 'org-table-end-of-field))
  16698. (t (call-interactively 'forward-sentence))))
  16699. (define-key org-mode-map "\M-a" 'org-backward-sentence)
  16700. (define-key org-mode-map "\M-e" 'org-forward-sentence)
  16701. (defun org-kill-line (&optional arg)
  16702. "Kill line, to tags or end of line."
  16703. (interactive "P")
  16704. (cond
  16705. ((or (not org-special-ctrl-k)
  16706. (bolp)
  16707. (not (org-on-heading-p)))
  16708. (call-interactively 'kill-line))
  16709. ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)[ \t]*$"))
  16710. (kill-region (point) (match-beginning 1))
  16711. (org-set-tags nil t))
  16712. (t (kill-region (point) (point-at-eol)))))
  16713. (define-key org-mode-map "\C-k" 'org-kill-line)
  16714. (defun org-yank (&optional arg)
  16715. "Yank. If the kill is a subtree, treat it specially.
  16716. This command will look at the current kill and check if is a single
  16717. subtree, or a series of subtrees[1]. If it passes the test, and if the
  16718. cursor is at the beginning of a line or after the stars of a currently
  16719. empty headline, then the yank is handled specially. How exactly depends
  16720. on the value of the following variables, both set by default.
  16721. org-yank-folded-subtrees
  16722. When set, the subtree(s) will be folded after insertion, but only
  16723. if doing so would now swallow text after the yanked text.
  16724. org-yank-adjusted-subtrees
  16725. When set, the subtree will be promoted or demoted in order to
  16726. fit into the local outline tree structure, which means that the level
  16727. will be adjusted so that it becomes the smaller one of the two
  16728. *visible* surrounding headings.
  16729. Any prefix to this command will cause `yank' to be called directly with
  16730. no special treatment. In particular, a simple `C-u' prefix will just
  16731. plainly yank the text as it is.
  16732. \[1] The test checks if the first non-white line is a heading
  16733. and if there are no other headings with fewer stars."
  16734. (interactive "P")
  16735. (org-yank-generic 'yank arg))
  16736. (defun org-yank-generic (command arg)
  16737. "Perform some yank-like command.
  16738. This function implements the behavior described in the `org-yank'
  16739. documentation. However, it has been generalized to work for any
  16740. interactive command with similar behavior."
  16741. ;; pretend to be command COMMAND
  16742. (setq this-command command)
  16743. (if arg
  16744. (call-interactively command)
  16745. (let ((subtreep ; is kill a subtree, and the yank position appropriate?
  16746. (and (org-kill-is-subtree-p)
  16747. (or (bolp)
  16748. (and (looking-at "[ \t]*$")
  16749. (string-match
  16750. "\\`\\*+\\'"
  16751. (buffer-substring (point-at-bol) (point)))))))
  16752. swallowp)
  16753. (cond
  16754. ((and subtreep org-yank-folded-subtrees)
  16755. (let ((beg (point))
  16756. end)
  16757. (if (and subtreep org-yank-adjusted-subtrees)
  16758. (org-paste-subtree nil nil 'for-yank)
  16759. (call-interactively command))
  16760. (setq end (point))
  16761. (goto-char beg)
  16762. (when (and (bolp) subtreep
  16763. (not (setq swallowp
  16764. (org-yank-folding-would-swallow-text beg end))))
  16765. (or (looking-at outline-regexp)
  16766. (re-search-forward (concat "^" outline-regexp) end t))
  16767. (while (and (< (point) end) (looking-at outline-regexp))
  16768. (hide-subtree)
  16769. (org-cycle-show-empty-lines 'folded)
  16770. (condition-case nil
  16771. (outline-forward-same-level 1)
  16772. (error (goto-char end)))))
  16773. (when swallowp
  16774. (message
  16775. "Inserted text not folded because that would swallow text"))
  16776. (goto-char end)
  16777. (skip-chars-forward " \t\n\r")
  16778. (beginning-of-line 1)
  16779. (push-mark beg 'nomsg)))
  16780. ((and subtreep org-yank-adjusted-subtrees)
  16781. (let ((beg (point-at-bol)))
  16782. (org-paste-subtree nil nil 'for-yank)
  16783. (push-mark beg 'nomsg)))
  16784. (t
  16785. (call-interactively command))))))
  16786. (defun org-yank-folding-would-swallow-text (beg end)
  16787. "Would hide-subtree at BEG swallow any text after END?"
  16788. (let (level)
  16789. (save-excursion
  16790. (goto-char beg)
  16791. (when (or (looking-at outline-regexp)
  16792. (re-search-forward (concat "^" outline-regexp) end t))
  16793. (setq level (org-outline-level)))
  16794. (goto-char end)
  16795. (skip-chars-forward " \t\r\n\v\f")
  16796. (if (or (eobp)
  16797. (and (bolp) (looking-at org-outline-regexp)
  16798. (<= (org-outline-level) level)))
  16799. nil ; Nothing would be swallowed
  16800. t)))) ; something would swallow
  16801. (define-key org-mode-map "\C-y" 'org-yank)
  16802. (defun org-invisible-p ()
  16803. "Check if point is at a character currently not visible."
  16804. ;; Early versions of noutline don't have `outline-invisible-p'.
  16805. (if (fboundp 'outline-invisible-p)
  16806. (outline-invisible-p)
  16807. (get-char-property (point) 'invisible)))
  16808. (defun org-invisible-p2 ()
  16809. "Check if point is at a character currently not visible."
  16810. (save-excursion
  16811. (if (and (eolp) (not (bobp))) (backward-char 1))
  16812. ;; Early versions of noutline don't have `outline-invisible-p'.
  16813. (if (fboundp 'outline-invisible-p)
  16814. (outline-invisible-p)
  16815. (get-char-property (point) 'invisible))))
  16816. (defun org-back-to-heading (&optional invisible-ok)
  16817. "Call `outline-back-to-heading', but provide a better error message."
  16818. (condition-case nil
  16819. (outline-back-to-heading invisible-ok)
  16820. (error (error "Before first headline at position %d in buffer %s"
  16821. (point) (current-buffer)))))
  16822. (defun org-before-first-heading-p ()
  16823. "Before first heading?"
  16824. (save-excursion
  16825. (null (re-search-backward "^\\*+ " nil t))))
  16826. (defun org-on-heading-p (&optional ignored)
  16827. (outline-on-heading-p t))
  16828. (defun org-at-heading-p (&optional ignored)
  16829. (outline-on-heading-p t))
  16830. (defun org-point-at-end-of-empty-headline ()
  16831. "If point is at the end of an empty headline, return t, else nil.
  16832. If the heading only contains a TODO keyword, it is still still considered
  16833. empty."
  16834. (and (looking-at "[ \t]*$")
  16835. (save-excursion
  16836. (beginning-of-line 1)
  16837. (looking-at (concat "^\\(\\*+\\)[ \t]+\\(" org-todo-regexp
  16838. "\\)?[ \t]*$")))))
  16839. (defun org-at-heading-or-item-p ()
  16840. (or (org-on-heading-p) (org-at-item-p)))
  16841. (defun org-on-target-p ()
  16842. (or (org-in-regexp org-radio-target-regexp)
  16843. (org-in-regexp org-target-regexp)))
  16844. (defun org-up-heading-all (arg)
  16845. "Move to the heading line of which the present line is a subheading.
  16846. This function considers both visible and invisible heading lines.
  16847. With argument, move up ARG levels."
  16848. (if (fboundp 'outline-up-heading-all)
  16849. (outline-up-heading-all arg) ; emacs 21 version of outline.el
  16850. (outline-up-heading arg t))) ; emacs 22 version of outline.el
  16851. (defun org-up-heading-safe ()
  16852. "Move to the heading line of which the present line is a subheading.
  16853. This version will not throw an error. It will return the level of the
  16854. headline found, or nil if no higher level is found.
  16855. Also, this function will be a lot faster than `outline-up-heading',
  16856. because it relies on stars being the outline starters. This can really
  16857. make a significant difference in outlines with very many siblings."
  16858. (let (start-level re)
  16859. (org-back-to-heading t)
  16860. (setq start-level (funcall outline-level))
  16861. (if (equal start-level 1)
  16862. nil
  16863. (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
  16864. (if (re-search-backward re nil t)
  16865. (funcall outline-level)))))
  16866. (defun org-first-sibling-p ()
  16867. "Is this heading the first child of its parents?"
  16868. (interactive)
  16869. (let ((re (concat "^" outline-regexp))
  16870. level l)
  16871. (unless (org-at-heading-p t)
  16872. (error "Not at a heading"))
  16873. (setq level (funcall outline-level))
  16874. (save-excursion
  16875. (if (not (re-search-backward re nil t))
  16876. t
  16877. (setq l (funcall outline-level))
  16878. (< l level)))))
  16879. (defun org-goto-sibling (&optional previous)
  16880. "Goto the next sibling, even if it is invisible.
  16881. When PREVIOUS is set, go to the previous sibling instead. Returns t
  16882. when a sibling was found. When none is found, return nil and don't
  16883. move point."
  16884. (let ((fun (if previous 're-search-backward 're-search-forward))
  16885. (pos (point))
  16886. (re (concat "^" outline-regexp))
  16887. level l)
  16888. (when (condition-case nil (org-back-to-heading t) (error nil))
  16889. (setq level (funcall outline-level))
  16890. (catch 'exit
  16891. (or previous (forward-char 1))
  16892. (while (funcall fun re nil t)
  16893. (setq l (funcall outline-level))
  16894. (when (< l level) (goto-char pos) (throw 'exit nil))
  16895. (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
  16896. (goto-char pos)
  16897. nil))))
  16898. (defun org-show-siblings ()
  16899. "Show all siblings of the current headline."
  16900. (save-excursion
  16901. (while (org-goto-sibling) (org-flag-heading nil)))
  16902. (save-excursion
  16903. (while (org-goto-sibling 'previous)
  16904. (org-flag-heading nil))))
  16905. (defun org-show-hidden-entry ()
  16906. "Show an entry where even the heading is hidden."
  16907. (save-excursion
  16908. (org-show-entry)))
  16909. (defun org-flag-heading (flag &optional entry)
  16910. "Flag the current heading. FLAG non-nil means make invisible.
  16911. When ENTRY is non-nil, show the entire entry."
  16912. (save-excursion
  16913. (org-back-to-heading t)
  16914. ;; Check if we should show the entire entry
  16915. (if entry
  16916. (progn
  16917. (org-show-entry)
  16918. (save-excursion
  16919. (and (outline-next-heading)
  16920. (org-flag-heading nil))))
  16921. (outline-flag-region (max (point-min) (1- (point)))
  16922. (save-excursion (outline-end-of-heading) (point))
  16923. flag))))
  16924. (defun org-get-next-sibling ()
  16925. "Move to next heading of the same level, and return point.
  16926. If there is no such heading, return nil.
  16927. This is like outline-next-sibling, but invisible headings are ok."
  16928. (let ((level (funcall outline-level)))
  16929. (outline-next-heading)
  16930. (while (and (not (eobp)) (> (funcall outline-level) level))
  16931. (outline-next-heading))
  16932. (if (or (eobp) (< (funcall outline-level) level))
  16933. nil
  16934. (point))))
  16935. (defun org-get-last-sibling ()
  16936. "Move to previous heading of the same level, and return point.
  16937. If there is no such heading, return nil."
  16938. (let ((opoint (point))
  16939. (level (funcall outline-level)))
  16940. (outline-previous-heading)
  16941. (when (and (/= (point) opoint) (outline-on-heading-p t))
  16942. (while (and (> (funcall outline-level) level)
  16943. (not (bobp)))
  16944. (outline-previous-heading))
  16945. (if (< (funcall outline-level) level)
  16946. nil
  16947. (point)))))
  16948. (defun org-end-of-subtree (&optional invisible-OK to-heading)
  16949. ;; This contains an exact copy of the original function, but it uses
  16950. ;; `org-back-to-heading', to make it work also in invisible
  16951. ;; trees. And is uses an invisible-OK argument.
  16952. ;; Under Emacs this is not needed, but the old outline.el needs this fix.
  16953. ;; Furthermore, when used inside Org, finding the end of a large subtree
  16954. ;; with many children and grandchildren etc, this can be much faster
  16955. ;; than the outline version.
  16956. (org-back-to-heading invisible-OK)
  16957. (let ((first t)
  16958. (level (funcall outline-level)))
  16959. (if (and (org-mode-p) (< level 1000))
  16960. ;; A true heading (not a plain list item), in Org-mode
  16961. ;; This means we can easily find the end by looking
  16962. ;; only for the right number of stars. Using a regexp to do
  16963. ;; this is so much faster than using a Lisp loop.
  16964. (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
  16965. (forward-char 1)
  16966. (and (re-search-forward re nil 'move) (beginning-of-line 1)))
  16967. ;; something else, do it the slow way
  16968. (while (and (not (eobp))
  16969. (or first (> (funcall outline-level) level)))
  16970. (setq first nil)
  16971. (outline-next-heading)))
  16972. (unless to-heading
  16973. (if (memq (preceding-char) '(?\n ?\^M))
  16974. (progn
  16975. ;; Go to end of line before heading
  16976. (forward-char -1)
  16977. (if (memq (preceding-char) '(?\n ?\^M))
  16978. ;; leave blank line before heading
  16979. (forward-char -1))))))
  16980. (point))
  16981. (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
  16982. "Use Org version in org-mode, for dramatic speed-up."
  16983. (if (eq major-mode 'org-mode)
  16984. (progn
  16985. (org-end-of-subtree nil t)
  16986. (unless (eobp) (backward-char 1)))
  16987. ad-do-it))
  16988. (defun org-forward-same-level (arg &optional invisible-ok)
  16989. "Move forward to the arg'th subheading at same level as this one.
  16990. Stop at the first and last subheadings of a superior heading."
  16991. (interactive "p")
  16992. (org-back-to-heading invisible-ok)
  16993. (org-on-heading-p)
  16994. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  16995. (re (format "^\\*\\{1,%d\\} " level))
  16996. l)
  16997. (forward-char 1)
  16998. (while (> arg 0)
  16999. (while (and (re-search-forward re nil 'move)
  17000. (setq l (- (match-end 0) (match-beginning 0) 1))
  17001. (= l level)
  17002. (not invisible-ok)
  17003. (progn (backward-char 1) (org-invisible-p)))
  17004. (if (< l level) (setq arg 1)))
  17005. (setq arg (1- arg)))
  17006. (beginning-of-line 1)))
  17007. (defun org-backward-same-level (arg &optional invisible-ok)
  17008. "Move backward to the arg'th subheading at same level as this one.
  17009. Stop at the first and last subheadings of a superior heading."
  17010. (interactive "p")
  17011. (org-back-to-heading)
  17012. (org-on-heading-p)
  17013. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  17014. (re (format "^\\*\\{1,%d\\} " level))
  17015. l)
  17016. (while (> arg 0)
  17017. (while (and (re-search-backward re nil 'move)
  17018. (setq l (- (match-end 0) (match-beginning 0) 1))
  17019. (= l level)
  17020. (not invisible-ok)
  17021. (org-invisible-p))
  17022. (if (< l level) (setq arg 1)))
  17023. (setq arg (1- arg)))))
  17024. (defun org-show-subtree ()
  17025. "Show everything after this heading at deeper levels."
  17026. (outline-flag-region
  17027. (point)
  17028. (save-excursion
  17029. (org-end-of-subtree t t))
  17030. nil))
  17031. (defun org-show-entry ()
  17032. "Show the body directly following this heading.
  17033. Show the heading too, if it is currently invisible."
  17034. (interactive)
  17035. (save-excursion
  17036. (condition-case nil
  17037. (progn
  17038. (org-back-to-heading t)
  17039. (outline-flag-region
  17040. (max (point-min) (1- (point)))
  17041. (save-excursion
  17042. (if (re-search-forward
  17043. (concat "[\r\n]\\(" outline-regexp "\\)") nil t)
  17044. (match-beginning 1)
  17045. (point-max)))
  17046. nil)
  17047. (org-cycle-hide-drawers 'children))
  17048. (error nil))))
  17049. (defun org-make-options-regexp (kwds &optional extra)
  17050. "Make a regular expression for keyword lines."
  17051. (concat
  17052. "^"
  17053. "#?[ \t]*\\+\\("
  17054. (mapconcat 'regexp-quote kwds "\\|")
  17055. (if extra (concat "\\|" extra))
  17056. "\\):[ \t]*"
  17057. "\\(.*\\)"))
  17058. ;; Make isearch reveal the necessary context
  17059. (defun org-isearch-end ()
  17060. "Reveal context after isearch exits."
  17061. (when isearch-success ; only if search was successful
  17062. (if (featurep 'xemacs)
  17063. ;; Under XEmacs, the hook is run in the correct place,
  17064. ;; we directly show the context.
  17065. (org-show-context 'isearch)
  17066. ;; In Emacs the hook runs *before* restoring the overlays.
  17067. ;; So we have to use a one-time post-command-hook to do this.
  17068. ;; (Emacs 22 has a special variable, see function `org-mode')
  17069. (unless (and (boundp 'isearch-mode-end-hook-quit)
  17070. isearch-mode-end-hook-quit)
  17071. ;; Only when the isearch was not quitted.
  17072. (org-add-hook 'post-command-hook 'org-isearch-post-command
  17073. 'append 'local)))))
  17074. (defun org-isearch-post-command ()
  17075. "Remove self from hook, and show context."
  17076. (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
  17077. (org-show-context 'isearch))
  17078. ;;;; Integration with and fixes for other packages
  17079. ;;; Imenu support
  17080. (defvar org-imenu-markers nil
  17081. "All markers currently used by Imenu.")
  17082. (make-variable-buffer-local 'org-imenu-markers)
  17083. (defun org-imenu-new-marker (&optional pos)
  17084. "Return a new marker for use by Imenu, and remember the marker."
  17085. (let ((m (make-marker)))
  17086. (move-marker m (or pos (point)))
  17087. (push m org-imenu-markers)
  17088. m))
  17089. (defun org-imenu-get-tree ()
  17090. "Produce the index for Imenu."
  17091. (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
  17092. (setq org-imenu-markers nil)
  17093. (let* ((n org-imenu-depth)
  17094. (re (concat "^" outline-regexp))
  17095. (subs (make-vector (1+ n) nil))
  17096. (last-level 0)
  17097. m level head)
  17098. (save-excursion
  17099. (save-restriction
  17100. (widen)
  17101. (goto-char (point-max))
  17102. (while (re-search-backward re nil t)
  17103. (setq level (org-reduced-level (funcall outline-level)))
  17104. (when (<= level n)
  17105. (looking-at org-complex-heading-regexp)
  17106. (setq head (org-link-display-format
  17107. (org-match-string-no-properties 4))
  17108. m (org-imenu-new-marker))
  17109. (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
  17110. (if (>= level last-level)
  17111. (push (cons head m) (aref subs level))
  17112. (push (cons head (aref subs (1+ level))) (aref subs level))
  17113. (loop for i from (1+ level) to n do (aset subs i nil)))
  17114. (setq last-level level)))))
  17115. (aref subs 1)))
  17116. (eval-after-load "imenu"
  17117. '(progn
  17118. (add-hook 'imenu-after-jump-hook
  17119. (lambda ()
  17120. (if (eq major-mode 'org-mode)
  17121. (org-show-context 'org-goto))))))
  17122. (defun org-link-display-format (link)
  17123. "Replace a link with either the description, or the link target
  17124. if no description is present"
  17125. (save-match-data
  17126. (if (string-match org-bracket-link-analytic-regexp link)
  17127. (replace-match (if (match-end 5)
  17128. (match-string 5 link)
  17129. (concat (match-string 1 link)
  17130. (match-string 3 link)))
  17131. nil t link)
  17132. link)))
  17133. ;; Speedbar support
  17134. (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
  17135. "Overlay marking the agenda restriction line in speedbar.")
  17136. (overlay-put org-speedbar-restriction-lock-overlay
  17137. 'face 'org-agenda-restriction-lock)
  17138. (overlay-put org-speedbar-restriction-lock-overlay
  17139. 'help-echo "Agendas are currently limited to this item.")
  17140. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  17141. (defun org-speedbar-set-agenda-restriction ()
  17142. "Restrict future agenda commands to the location at point in speedbar.
  17143. To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
  17144. (interactive)
  17145. (require 'org-agenda)
  17146. (let (p m tp np dir txt)
  17147. (cond
  17148. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  17149. 'org-imenu t))
  17150. (setq m (get-text-property p 'org-imenu-marker))
  17151. (with-current-buffer (marker-buffer m)
  17152. (goto-char m)
  17153. (org-agenda-set-restriction-lock 'subtree)))
  17154. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  17155. 'speedbar-function 'speedbar-find-file))
  17156. (setq tp (previous-single-property-change
  17157. (1+ p) 'speedbar-function)
  17158. np (next-single-property-change
  17159. tp 'speedbar-function)
  17160. dir (speedbar-line-directory)
  17161. txt (buffer-substring-no-properties (or tp (point-min))
  17162. (or np (point-max))))
  17163. (with-current-buffer (find-file-noselect
  17164. (let ((default-directory dir))
  17165. (expand-file-name txt)))
  17166. (unless (org-mode-p)
  17167. (error "Cannot restrict to non-Org-mode file"))
  17168. (org-agenda-set-restriction-lock 'file)))
  17169. (t (error "Don't know how to restrict Org-mode's agenda")))
  17170. (move-overlay org-speedbar-restriction-lock-overlay
  17171. (point-at-bol) (point-at-eol))
  17172. (setq current-prefix-arg nil)
  17173. (org-agenda-maybe-redo)))
  17174. (eval-after-load "speedbar"
  17175. '(progn
  17176. (speedbar-add-supported-extension ".org")
  17177. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  17178. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  17179. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  17180. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  17181. (add-hook 'speedbar-visiting-tag-hook
  17182. (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
  17183. ;;; Fixes and Hacks for problems with other packages
  17184. ;; Make flyspell not check words in links, to not mess up our keymap
  17185. (defun org-mode-flyspell-verify ()
  17186. "Don't let flyspell put overlays at active buttons."
  17187. (and (not (get-text-property (point) 'keymap))
  17188. (not (get-text-property (point) 'org-no-flyspell))))
  17189. (defun org-remove-flyspell-overlays-in (beg end)
  17190. "Remove flyspell overlays in region."
  17191. (and (org-bound-and-true-p flyspell-mode)
  17192. (fboundp 'flyspell-delete-region-overlays)
  17193. (flyspell-delete-region-overlays beg end))
  17194. (add-text-properties beg end '(org-no-flyspell t)))
  17195. ;; Make `bookmark-jump' shows the jump location if it was hidden.
  17196. (eval-after-load "bookmark"
  17197. '(if (boundp 'bookmark-after-jump-hook)
  17198. ;; We can use the hook
  17199. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  17200. ;; Hook not available, use advice
  17201. (defadvice bookmark-jump (after org-make-visible activate)
  17202. "Make the position visible."
  17203. (org-bookmark-jump-unhide))))
  17204. ;; Make sure saveplace shows the location if it was hidden
  17205. (eval-after-load "saveplace"
  17206. '(defadvice save-place-find-file-hook (after org-make-visible activate)
  17207. "Make the position visible."
  17208. (org-bookmark-jump-unhide)))
  17209. ;; Make sure ecb shows the location if it was hidden
  17210. (eval-after-load "ecb"
  17211. '(defadvice ecb-method-clicked (after esf/org-show-context activate)
  17212. "Make hierarchy visible when jumping into location from ECB tree buffer."
  17213. (if (eq major-mode 'org-mode)
  17214. (org-show-context))))
  17215. (defun org-bookmark-jump-unhide ()
  17216. "Unhide the current position, to show the bookmark location."
  17217. (and (org-mode-p)
  17218. (or (org-invisible-p)
  17219. (save-excursion (goto-char (max (point-min) (1- (point))))
  17220. (org-invisible-p)))
  17221. (org-show-context 'bookmark-jump)))
  17222. ;; Make session.el ignore our circular variable
  17223. (eval-after-load "session"
  17224. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  17225. ;;;; Experimental code
  17226. (defun org-closed-in-range ()
  17227. "Sparse tree of items closed in a certain time range.
  17228. Still experimental, may disappear in the future."
  17229. (interactive)
  17230. ;; Get the time interval from the user.
  17231. (let* ((time1 (org-float-time
  17232. (org-read-date nil 'to-time nil "Starting date: ")))
  17233. (time2 (org-float-time
  17234. (org-read-date nil 'to-time nil "End date:")))
  17235. ;; callback function
  17236. (callback (lambda ()
  17237. (let ((time
  17238. (org-float-time
  17239. (apply 'encode-time
  17240. (org-parse-time-string
  17241. (match-string 1))))))
  17242. ;; check if time in interval
  17243. (and (>= time time1) (<= time time2))))))
  17244. ;; make tree, check each match with the callback
  17245. (org-occur "CLOSED: +\\[\\(.*?\\)\\]" nil callback)))
  17246. ;;;; Finish up
  17247. (provide 'org)
  17248. (run-hooks 'org-load-hook)
  17249. ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
  17250. ;;; org.el ends here