org.el 723 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354
  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. ;; babel
  99. (let* ((babel-path (expand-file-name
  100. "babel"
  101. (file-name-directory (or (buffer-file-name)
  102. load-file-name))))
  103. (babel-langs-path (expand-file-name "langs" babel-path)))
  104. (add-to-list 'load-path babel-path)
  105. (add-to-list 'load-path babel-langs-path))
  106. (require 'ob)
  107. (require 'ob-table)
  108. (require 'ob-lob)
  109. (require 'ob-ref)
  110. (require 'ob-tangle)
  111. (require 'ob-comint)
  112. (require 'ob-keys)
  113. (require 'ob-emacs-lisp)
  114. ;;;; Customization variables
  115. (defcustom org-clone-delete-id nil
  116. "Remove ID property of clones of a subtree.
  117. When non-nil, clones of a subtree don't inherit the ID property.
  118. Otherwise they inherit the ID property with a new unique
  119. identifier."
  120. :type 'boolean
  121. :group 'org-id)
  122. ;;; Version
  123. (defconst org-version "6.36trans"
  124. "The version number of the file org.el.")
  125. (defun org-version (&optional here)
  126. "Show the org-mode version in the echo area.
  127. With prefix arg HERE, insert it at point."
  128. (interactive "P")
  129. (let* ((origin default-directory)
  130. (version org-version)
  131. (git-version)
  132. (dir (concat (file-name-directory (locate-library "org")) "../" )))
  133. (when (and (file-exists-p (expand-file-name ".git" dir))
  134. (executable-find "git"))
  135. (unwind-protect
  136. (progn
  137. (cd dir)
  138. (when (eql 0 (shell-command "git describe --abbrev=4 HEAD"))
  139. (with-current-buffer "*Shell Command Output*"
  140. (goto-char (point-min))
  141. (setq git-version (buffer-substring (point) (point-at-eol))))
  142. (subst-char-in-string ?- ?. git-version t)
  143. (when (string-match "\\S-"
  144. (shell-command-to-string
  145. "git diff-index --name-only HEAD --"))
  146. (setq git-version (concat git-version ".dirty")))
  147. (setq version (concat version " (" git-version ")"))))
  148. (cd origin)))
  149. (setq version (format "Org-mode version %s" version))
  150. (if here (insert version))
  151. (message version)))
  152. ;;; Compatibility constants
  153. ;;; The custom variables
  154. (defgroup org nil
  155. "Outline-based notes management and organizer."
  156. :tag "Org"
  157. :group 'outlines
  158. :group 'calendar)
  159. (defcustom org-mode-hook nil
  160. "Mode hook for Org-mode, run after the mode was turned on."
  161. :group 'org
  162. :type 'hook)
  163. (defcustom org-load-hook nil
  164. "Hook that is run after org.el has been loaded."
  165. :group 'org
  166. :type 'hook)
  167. (defvar org-modules) ; defined below
  168. (defvar org-modules-loaded nil
  169. "Have the modules been loaded already?")
  170. (defun org-load-modules-maybe (&optional force)
  171. "Load all extensions listed in `org-modules'."
  172. (when (or force (not org-modules-loaded))
  173. (mapc (lambda (ext)
  174. (condition-case nil (require ext)
  175. (error (message "Problems while trying to load feature `%s'" ext))))
  176. org-modules)
  177. (setq org-modules-loaded t)))
  178. (defun org-set-modules (var value)
  179. "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
  180. (set var value)
  181. (when (featurep 'org)
  182. (org-load-modules-maybe 'force)))
  183. (when (org-bound-and-true-p org-modules)
  184. (let ((a (member 'org-infojs org-modules)))
  185. (and a (setcar a 'org-jsinfo))))
  186. (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)
  187. "Modules that should always be loaded together with org.el.
  188. If a description starts with <C>, the file is not part of Emacs
  189. and loading it will require that you have downloaded and properly installed
  190. the org-mode distribution.
  191. You can also use this system to load external packages (i.e. neither Org
  192. core modules, nor modules from the CONTRIB directory). Just add symbols
  193. to the end of the list. If the package is called org-xyz.el, then you need
  194. to add the symbol `xyz', and the package must have a call to
  195. (provide 'org-xyz)"
  196. :group 'org
  197. :set 'org-set-modules
  198. :type
  199. '(set :greedy t
  200. (const :tag " bbdb: Links to BBDB entries" org-bbdb)
  201. (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
  202. (const :tag " crypt: Encryption of subtrees" org-crypt)
  203. (const :tag " ctags: Access to Emacs tags with links" org-ctags)
  204. (const :tag " docview: Links to doc-view buffers" org-docview)
  205. (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
  206. (const :tag " id: Global IDs for identifying entries" org-id)
  207. (const :tag " info: Links to Info nodes" org-info)
  208. (const :tag " jsinfo: Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo)
  209. (const :tag " habit: Track your consistency with habits" org-habit)
  210. (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
  211. (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
  212. (const :tag " mac-message: Links to messages in Apple Mail" org-mac-message)
  213. (const :tag " mew Links to Mew folders/messages" org-mew)
  214. (const :tag " mhe: Links to MHE folders/messages" org-mhe)
  215. (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
  216. (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
  217. (const :tag " vm: Links to VM folders/messages" org-vm)
  218. (const :tag " wl: Links to Wanderlust folders/messages" org-wl)
  219. (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
  220. (const :tag " mouse: Additional mouse support" org-mouse)
  221. (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
  222. (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
  223. (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
  224. (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
  225. (const :tag "C collector: Collect properties into tables" org-collector)
  226. (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
  227. (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
  228. (const :tag "C eval: Include command output as text" org-eval)
  229. (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
  230. (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
  231. (const :tag "C exp-bibtex: Export citations using BibTeX" org-exp-bibtex)
  232. (const :tag "C git-link: Provide org links to specific file version" org-git-link)
  233. (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
  234. (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
  235. (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
  236. (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
  237. (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
  238. (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
  239. (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
  240. (const :tag "C man: Support for links to manpages in Org-mode" org-man)
  241. (const :tag "C mtags: Support for muse-like tags" org-mtags)
  242. (const :tag "C panel: Simple routines for us with bad memory" org-panel)
  243. (const :tag "C registry: A registry for Org-mode links" org-registry)
  244. (const :tag "C org2rem: Convert org appointments into reminders" org2rem)
  245. (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
  246. (const :tag "C secretary: Team management with org-mode" org-secretary)
  247. (const :tag "C special-blocks: Turn blocks into LaTeX envs and HTML divs" org-special-blocks)
  248. (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
  249. (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
  250. (const :tag "C track: Keep up with Org-mode development" org-track)
  251. (const :tag "C TaskJuggler: Export tasks to a TaskJuggler project" org-taskjuggler)
  252. (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
  253. (defcustom org-support-shift-select nil
  254. "Non-nil means make shift-cursor commands select text when possible.
  255. In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
  256. selecting a region, or enlarge thusly regions started in this way.
  257. In Org-mode, in special contexts, these same keys are used for other
  258. purposes, important enough to compete with shift selection. Org tries
  259. to balance these needs by supporting `shift-select-mode' outside these
  260. special contexts, under control of this variable.
  261. The default of this variable is nil, to avoid confusing behavior. Shifted
  262. cursor keys will then execute Org commands in the following contexts:
  263. - on a headline, changing TODO state (left/right) and priority (up/down)
  264. - on a time stamp, changing the time
  265. - in a plain list item, changing the bullet type
  266. - in a property definition line, switching between allowed values
  267. - in the BEGIN line of a clock table (changing the time block).
  268. Outside these contexts, the commands will throw an error.
  269. When this variable is t and the cursor is not in a special context,
  270. Org-mode will support shift-selection for making and enlarging regions.
  271. To make this more effective, the bullet cycling will no longer happen
  272. anywhere in an item line, but only if the cursor is exactly on the bullet.
  273. If you set this variable to the symbol `always', then the keys
  274. will not be special in headlines, property lines, and item lines, to make
  275. shift selection work there as well. If this is what you want, you can
  276. use the following alternative commands: `C-c C-t' and `C-c ,' to
  277. change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
  278. TODO sets, `C-c -' to cycle item bullet types, and properties can be
  279. edited by hand or in column view.
  280. However, when the cursor is on a timestamp, shift-cursor commands
  281. will still edit the time stamp - this is just too good to give up.
  282. XEmacs user should have this variable set to nil, because shift-select-mode
  283. is Emacs 23 only."
  284. :group 'org
  285. :type '(choice
  286. (const :tag "Never" nil)
  287. (const :tag "When outside special context" t)
  288. (const :tag "Everywhere except timestamps" always)))
  289. (defgroup org-startup nil
  290. "Options concerning startup of Org-mode."
  291. :tag "Org Startup"
  292. :group 'org)
  293. (defcustom org-startup-folded t
  294. "Non-nil means entering Org-mode will switch to OVERVIEW.
  295. This can also be configured on a per-file basis by adding one of
  296. the following lines anywhere in the buffer:
  297. #+STARTUP: fold (or `overview', this is equivalent)
  298. #+STARTUP: nofold (or `showall', this is equivalent)
  299. #+STARTUP: content
  300. #+STARTUP: showeverything"
  301. :group 'org-startup
  302. :type '(choice
  303. (const :tag "nofold: show all" nil)
  304. (const :tag "fold: overview" t)
  305. (const :tag "content: all headlines" content)
  306. (const :tag "show everything, even drawers" showeverything)))
  307. (defcustom org-startup-truncated t
  308. "Non-nil means entering Org-mode will set `truncate-lines'.
  309. This is useful since some lines containing links can be very long and
  310. uninteresting. Also tables look terrible when wrapped."
  311. :group 'org-startup
  312. :type 'boolean)
  313. (defcustom org-startup-indented nil
  314. "Non-nil means turn on `org-indent-mode' on startup.
  315. This can also be configured on a per-file basis by adding one of
  316. the following lines anywhere in the buffer:
  317. #+STARTUP: indent
  318. #+STARTUP: noindent"
  319. :group 'org-structure
  320. :type '(choice
  321. (const :tag "Not" nil)
  322. (const :tag "Globally (slow on startup in large files)" t)))
  323. (defcustom org-use-sub-superscripts t
  324. "Non-nil means interpret \"_\" and \"^\" for export.
  325. When this option is turned on, you can use TeX-like syntax for sub- and
  326. superscripts. Several characters after \"_\" or \"^\" will be
  327. considered as a single item - so grouping with {} is normally not
  328. needed. For example, the following things will be parsed as single
  329. sub- or superscripts.
  330. 10^24 or 10^tau several digits will be considered 1 item.
  331. 10^-12 or 10^-tau a leading sign with digits or a word
  332. x^2-y^3 will be read as x^2 - y^3, because items are
  333. terminated by almost any nonword/nondigit char.
  334. x_{i^2} or x^(2-i) braces or parenthesis do grouping.
  335. Still, ambiguity is possible - so when in doubt use {} to enclose the
  336. sub/superscript. If you set this variable to the symbol `{}',
  337. the braces are *required* in order to trigger interpretations as
  338. sub/superscript. This can be helpful in documents that need \"_\"
  339. frequently in plain text.
  340. Not all export backends support this, but HTML does.
  341. This option can also be set with the +OPTIONS line, e.g. \"^:nil\"."
  342. :group 'org-startup
  343. :group 'org-export-translation
  344. :type '(choice
  345. (const :tag "Always interpret" t)
  346. (const :tag "Only with braces" {})
  347. (const :tag "Never interpret" nil)))
  348. (defvaralias 'org-export-with-sub-superscripts 'org-use-sub-superscripts)
  349. (defcustom org-startup-with-beamer-mode nil
  350. "Non-nil means turn on `org-beamer-mode' on startup.
  351. This can also be configured on a per-file basis by adding one of
  352. the following lines anywhere in the buffer:
  353. #+STARTUP: beamer"
  354. :group 'org-startup
  355. :type 'boolean)
  356. (defcustom org-startup-align-all-tables nil
  357. "Non-nil means align all tables when visiting a file.
  358. This is useful when the column width in tables is forced with <N> cookies
  359. in table fields. Such tables will look correct only after the first re-align.
  360. This can also be configured on a per-file basis by adding one of
  361. the following lines anywhere in the buffer:
  362. #+STARTUP: align
  363. #+STARTUP: noalign"
  364. :group 'org-startup
  365. :type 'boolean)
  366. (defcustom org-insert-mode-line-in-empty-file nil
  367. "Non-nil means insert the first line setting Org-mode in empty files.
  368. When the function `org-mode' is called interactively in an empty file, this
  369. normally means that the file name does not automatically trigger Org-mode.
  370. To ensure that the file will always be in Org-mode in the future, a
  371. line enforcing Org-mode will be inserted into the buffer, if this option
  372. has been set."
  373. :group 'org-startup
  374. :type 'boolean)
  375. (defcustom org-replace-disputed-keys nil
  376. "Non-nil means use alternative key bindings for some keys.
  377. Org-mode uses S-<cursor> keys for changing timestamps and priorities.
  378. These keys are also used by other packages like shift-selection-mode'
  379. \(built into Emacs 23), `CUA-mode' or `windmove.el'.
  380. If you want to use Org-mode together with one of these other modes,
  381. or more generally if you would like to move some Org-mode commands to
  382. other keys, set this variable and configure the keys with the variable
  383. `org-disputed-keys'.
  384. This option is only relevant at load-time of Org-mode, and must be set
  385. *before* org.el is loaded. Changing it requires a restart of Emacs to
  386. become effective."
  387. :group 'org-startup
  388. :type 'boolean)
  389. (defcustom org-use-extra-keys nil
  390. "Non-nil means use extra key sequence definitions for certain
  391. commands. This happens automatically if you run XEmacs or if
  392. window-system is nil. This variable lets you do the same
  393. manually. You must set it before loading org.
  394. Example: on Carbon Emacs 22 running graphically, with an external
  395. keyboard on a Powerbook, the default way of setting M-left might
  396. not work for either Alt or ESC. Setting this variable will make
  397. it work for ESC."
  398. :group 'org-startup
  399. :type 'boolean)
  400. (if (fboundp 'defvaralias)
  401. (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys))
  402. (defcustom org-disputed-keys
  403. '(([(shift up)] . [(meta p)])
  404. ([(shift down)] . [(meta n)])
  405. ([(shift left)] . [(meta -)])
  406. ([(shift right)] . [(meta +)])
  407. ([(control shift right)] . [(meta shift +)])
  408. ([(control shift left)] . [(meta shift -)]))
  409. "Keys for which Org-mode and other modes compete.
  410. This is an alist, cars are the default keys, second element specifies
  411. the alternative to use when `org-replace-disputed-keys' is t.
  412. Keys can be specified in any syntax supported by `define-key'.
  413. The value of this option takes effect only at Org-mode's startup,
  414. therefore you'll have to restart Emacs to apply it after changing."
  415. :group 'org-startup
  416. :type 'alist)
  417. (defun org-key (key)
  418. "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
  419. Or return the original if not disputed.
  420. Also apply the trnaslations defined in `org-xemacs-key-equivalents'."
  421. (when org-replace-disputed-keys
  422. (let* ((nkey (key-description key))
  423. (x (org-find-if (lambda (x)
  424. (equal (key-description (car x)) nkey))
  425. org-disputed-keys)))
  426. (setq key (if x (cdr x) key))))
  427. (when (featurep 'xemacs)
  428. (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
  429. key)
  430. (defun org-find-if (predicate seq)
  431. (catch 'exit
  432. (while seq
  433. (if (funcall predicate (car seq))
  434. (throw 'exit (car seq))
  435. (pop seq)))))
  436. (defun org-defkey (keymap key def)
  437. "Define a key, possibly translated, as returned by `org-key'."
  438. (define-key keymap (org-key key) def))
  439. (defcustom org-ellipsis nil
  440. "The ellipsis to use in the Org-mode outline.
  441. When nil, just use the standard three dots. When a string, use that instead,
  442. When a face, use the standard 3 dots, but with the specified face.
  443. The change affects only Org-mode (which will then use its own display table).
  444. Changing this requires executing `M-x org-mode' in a buffer to become
  445. effective."
  446. :group 'org-startup
  447. :type '(choice (const :tag "Default" nil)
  448. (face :tag "Face" :value org-warning)
  449. (string :tag "String" :value "...#")))
  450. (defvar org-display-table nil
  451. "The display table for org-mode, in case `org-ellipsis' is non-nil.")
  452. (defgroup org-keywords nil
  453. "Keywords in Org-mode."
  454. :tag "Org Keywords"
  455. :group 'org)
  456. (defcustom org-deadline-string "DEADLINE:"
  457. "String to mark deadline entries.
  458. A deadline is this string, followed by a time stamp. Should be a word,
  459. terminated by a colon. You can insert a schedule keyword and
  460. a timestamp with \\[org-deadline].
  461. Changes become only effective after restarting Emacs."
  462. :group 'org-keywords
  463. :type 'string)
  464. (defcustom org-scheduled-string "SCHEDULED:"
  465. "String to mark scheduled TODO entries.
  466. A schedule is this string, followed by a time stamp. Should be a word,
  467. terminated by a colon. You can insert a schedule keyword and
  468. a timestamp with \\[org-schedule].
  469. Changes become only effective after restarting Emacs."
  470. :group 'org-keywords
  471. :type 'string)
  472. (defcustom org-closed-string "CLOSED:"
  473. "String used as the prefix for timestamps logging closing a TODO entry."
  474. :group 'org-keywords
  475. :type 'string)
  476. (defcustom org-clock-string "CLOCK:"
  477. "String used as prefix for timestamps clocking work hours on an item."
  478. :group 'org-keywords
  479. :type 'string)
  480. (defcustom org-comment-string "COMMENT"
  481. "Entries starting with this keyword will never be exported.
  482. An entry can be toggled between COMMENT and normal with
  483. \\[org-toggle-comment].
  484. Changes become only effective after restarting Emacs."
  485. :group 'org-keywords
  486. :type 'string)
  487. (defcustom org-quote-string "QUOTE"
  488. "Entries starting with this keyword will be exported in fixed-width font.
  489. Quoting applies only to the text in the entry following the headline, and does
  490. not extend beyond the next headline, even if that is lower level.
  491. An entry can be toggled between QUOTE and normal with
  492. \\[org-toggle-fixed-width-section]."
  493. :group 'org-keywords
  494. :type 'string)
  495. (defconst org-repeat-re
  496. "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)"
  497. "Regular expression for specifying repeated events.
  498. After a match, group 1 contains the repeat expression.")
  499. (defgroup org-structure nil
  500. "Options concerning the general structure of Org-mode files."
  501. :tag "Org Structure"
  502. :group 'org)
  503. (defgroup org-reveal-location nil
  504. "Options about how to make context of a location visible."
  505. :tag "Org Reveal Location"
  506. :group 'org-structure)
  507. (defconst org-context-choice
  508. '(choice
  509. (const :tag "Always" t)
  510. (const :tag "Never" nil)
  511. (repeat :greedy t :tag "Individual contexts"
  512. (cons
  513. (choice :tag "Context"
  514. (const agenda)
  515. (const org-goto)
  516. (const occur-tree)
  517. (const tags-tree)
  518. (const link-search)
  519. (const mark-goto)
  520. (const bookmark-jump)
  521. (const isearch)
  522. (const default))
  523. (boolean))))
  524. "Contexts for the reveal options.")
  525. (defcustom org-show-hierarchy-above '((default . t))
  526. "Non-nil means show full hierarchy when revealing a location.
  527. Org-mode often shows locations in an org-mode file which might have
  528. been invisible before. When this is set, the hierarchy of headings
  529. above the exposed location is shown.
  530. Turning this off for example for sparse trees makes them very compact.
  531. Instead of t, this can also be an alist specifying this option for different
  532. contexts. Valid contexts are
  533. agenda when exposing an entry from the agenda
  534. org-goto when using the command `org-goto' on key C-c C-j
  535. occur-tree when using the command `org-occur' on key C-c /
  536. tags-tree when constructing a sparse tree based on tags matches
  537. link-search when exposing search matches associated with a link
  538. mark-goto when exposing the jump goal of a mark
  539. bookmark-jump when exposing a bookmark location
  540. isearch when exiting from an incremental search
  541. default default for all contexts not set explicitly"
  542. :group 'org-reveal-location
  543. :type org-context-choice)
  544. (defcustom org-show-following-heading '((default . nil))
  545. "Non-nil means show following heading when revealing a location.
  546. Org-mode often shows locations in an org-mode file which might have
  547. been invisible before. When this is set, the heading following the
  548. match is shown.
  549. Turning this off for example for sparse trees makes them very compact,
  550. but makes it harder to edit the location of the match. In such a case,
  551. use the command \\[org-reveal] to show more context.
  552. Instead of t, this can also be an alist specifying this option for different
  553. contexts. See `org-show-hierarchy-above' for valid contexts."
  554. :group 'org-reveal-location
  555. :type org-context-choice)
  556. (defcustom org-show-siblings '((default . nil) (isearch t))
  557. "Non-nil means show all sibling heading when revealing a location.
  558. Org-mode often shows locations in an org-mode file which might have
  559. been invisible before. When this is set, the sibling of the current entry
  560. heading are all made visible. If `org-show-hierarchy-above' is t,
  561. the same happens on each level of the hierarchy above the current entry.
  562. By default this is on for the isearch context, off for all other contexts.
  563. Turning this off for example for sparse trees makes them very compact,
  564. but makes it harder to edit the location of the match. In such a case,
  565. use the command \\[org-reveal] to show more context.
  566. Instead of t, this can also be an alist specifying this option for different
  567. contexts. See `org-show-hierarchy-above' for valid contexts."
  568. :group 'org-reveal-location
  569. :type org-context-choice)
  570. (defcustom org-show-entry-below '((default . nil))
  571. "Non-nil means show the entry below a headline when revealing a location.
  572. Org-mode often shows locations in an org-mode file which might have
  573. been invisible before. When this is set, the text below the headline that is
  574. exposed is also shown.
  575. By default this is off for all contexts.
  576. Instead of t, this can also be an alist specifying this option for different
  577. contexts. See `org-show-hierarchy-above' for valid contexts."
  578. :group 'org-reveal-location
  579. :type org-context-choice)
  580. (defcustom org-indirect-buffer-display 'other-window
  581. "How should indirect tree buffers be displayed?
  582. This applies to indirect buffers created with the commands
  583. \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
  584. Valid values are:
  585. current-window Display in the current window
  586. other-window Just display in another window.
  587. dedicated-frame Create one new frame, and re-use it each time.
  588. new-frame Make a new frame each time. Note that in this case
  589. previously-made indirect buffers are kept, and you need to
  590. kill these buffers yourself."
  591. :group 'org-structure
  592. :group 'org-agenda-windows
  593. :type '(choice
  594. (const :tag "In current window" current-window)
  595. (const :tag "In current frame, other window" other-window)
  596. (const :tag "Each time a new frame" new-frame)
  597. (const :tag "One dedicated frame" dedicated-frame)))
  598. (defcustom org-use-speed-commands nil
  599. "Non-nil means activate single letter commands at beginning of a headline.
  600. This may also be a function to test for appropriate locations where speed
  601. commands should be active."
  602. :group 'org-structure
  603. :type '(choice
  604. (const :tag "Never" nil)
  605. (const :tag "At beginning of headline stars" t)
  606. (function)))
  607. (defcustom org-speed-commands-user nil
  608. "Alist of additional speed commands.
  609. This list will be checked before `org-speed-commands-default'
  610. when the variable `org-use-speed-commands' is non-nil
  611. and when the cursor is at the beginning of a headline.
  612. The car if each entry is a string with a single letter, which must
  613. be assigned to `self-insert-command' in the global map.
  614. The cdr is either a command to be called interactively, a function
  615. to be called, or a form to be evaluated.
  616. An entry that is just a list with a single string will be interpreted
  617. as a descriptive headline that will be added when listing the speed
  618. copmmands in the Help buffer using the `?' speed command."
  619. :group 'org-structure
  620. :type '(repeat :value ("k" . ignore)
  621. (choice :value ("k" . ignore)
  622. (list :tag "Descriptive Headline" (string :tag "Headline"))
  623. (cons :tag "Letter and Command"
  624. (string :tag "Command letter")
  625. (choice
  626. (function)
  627. (sexp))))))
  628. (defgroup org-cycle nil
  629. "Options concerning visibility cycling in Org-mode."
  630. :tag "Org Cycle"
  631. :group 'org-structure)
  632. (defcustom org-cycle-skip-children-state-if-no-children t
  633. "Non-nil means skip CHILDREN state in entries that don't have any."
  634. :group 'org-cycle
  635. :type 'boolean)
  636. (defcustom org-cycle-max-level nil
  637. "Maximum level which should still be subject to visibility cycling.
  638. Levels higher than this will, for cycling, be treated as text, not a headline.
  639. When `org-odd-levels-only' is set, a value of N in this variable actually
  640. means 2N-1 stars as the limiting headline.
  641. When nil, cycle all levels.
  642. Note that the limiting level of cycling is also influenced by
  643. `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
  644. `org-inlinetask-min-level' is, cycling will be limited to levels one less
  645. than its value."
  646. :group 'org-cycle
  647. :type '(choice
  648. (const :tag "No limit" nil)
  649. (integer :tag "Maximum level")))
  650. (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK")
  651. "Names of drawers. Drawers are not opened by cycling on the headline above.
  652. Drawers only open with a TAB on the drawer line itself. A drawer looks like
  653. this:
  654. :DRAWERNAME:
  655. .....
  656. :END:
  657. The drawer \"PROPERTIES\" is special for capturing properties through
  658. the property API.
  659. Drawers can be defined on the per-file basis with a line like:
  660. #+DRAWERS: HIDDEN STATE PROPERTIES"
  661. :group 'org-structure
  662. :group 'org-cycle
  663. :type '(repeat (string :tag "Drawer Name")))
  664. (defcustom org-hide-block-startup nil
  665. "Non-nil means entering Org-mode will fold all blocks.
  666. This can also be set in on a per-file basis with
  667. #+STARTUP: hideblocks
  668. #+STARTUP: showblocks"
  669. :group 'org-startup
  670. :group 'org-cycle
  671. :type 'boolean)
  672. (defcustom org-cycle-global-at-bob nil
  673. "Cycle globally if cursor is at beginning of buffer and not at a headline.
  674. This makes it possible to do global cycling without having to use S-TAB or
  675. C-u TAB. For this special case to work, the first line of the buffer
  676. must not be a headline - it may be empty or some other text. When used in
  677. this way, `org-cycle-hook' is disables temporarily, to make sure the
  678. cursor stays at the beginning of the buffer.
  679. When this option is nil, don't do anything special at the beginning
  680. of the buffer."
  681. :group 'org-cycle
  682. :type 'boolean)
  683. (defcustom org-cycle-level-after-item/entry-creation t
  684. "Non-nil means cycle entry level or item indentation in new empty entries.
  685. When the cursor is at the end of an empty headline, i.e with only stars
  686. and maybe a TODO keyword, TAB will then switch the entry to become a child,
  687. and then all possible anchestor states, before returning to the original state.
  688. This makes data entry extremely fast: M-RET to create a new headline,
  689. on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
  690. When the cursor is at the end of an empty plain list item, one TAB will
  691. make it a subitem, two or more tabs will back up to make this an item
  692. higher up in the item hierarchy."
  693. :group 'org-cycle
  694. :type 'boolean)
  695. (defcustom org-cycle-emulate-tab t
  696. "Where should `org-cycle' emulate TAB.
  697. nil Never
  698. white Only in completely white lines
  699. whitestart Only at the beginning of lines, before the first non-white char
  700. t Everywhere except in headlines
  701. exc-hl-bol Everywhere except at the start of a headline
  702. If TAB is used in a place where it does not emulate TAB, the current subtree
  703. visibility is cycled."
  704. :group 'org-cycle
  705. :type '(choice (const :tag "Never" nil)
  706. (const :tag "Only in completely white lines" white)
  707. (const :tag "Before first char in a line" whitestart)
  708. (const :tag "Everywhere except in headlines" t)
  709. (const :tag "Everywhere except at bol in headlines" exc-hl-bol)
  710. ))
  711. (defcustom org-cycle-separator-lines 2
  712. "Number of empty lines needed to keep an empty line between collapsed trees.
  713. If you leave an empty line between the end of a subtree and the following
  714. headline, this empty line is hidden when the subtree is folded.
  715. Org-mode will leave (exactly) one empty line visible if the number of
  716. empty lines is equal or larger to the number given in this variable.
  717. So the default 2 means at least 2 empty lines after the end of a subtree
  718. are needed to produce free space between a collapsed subtree and the
  719. following headline.
  720. If the number is negative, and the number of empty lines is at least -N,
  721. all empty lines are shown.
  722. Special case: when 0, never leave empty lines in collapsed view."
  723. :group 'org-cycle
  724. :type 'integer)
  725. (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
  726. (defcustom org-pre-cycle-hook nil
  727. "Hook that is run before visibility cycling is happening.
  728. The function(s) in this hook must accept a single argument which indicates
  729. the new state that will be set right after running this hook. The
  730. argument is a symbol. Before a global state change, it can have the values
  731. `overview', `content', or `all'. Before a local state change, it can have
  732. the values `folded', `children', or `subtree'."
  733. :group 'org-cycle
  734. :type 'hook)
  735. (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
  736. org-cycle-hide-drawers
  737. org-cycle-show-empty-lines
  738. org-optimize-window-after-visibility-change)
  739. "Hook that is run after `org-cycle' has changed the buffer visibility.
  740. The function(s) in this hook must accept a single argument which indicates
  741. the new state that was set by the most recent `org-cycle' command. The
  742. argument is a symbol. After a global state change, it can have the values
  743. `overview', `content', or `all'. After a local state change, it can have
  744. the values `folded', `children', or `subtree'."
  745. :group 'org-cycle
  746. :type 'hook)
  747. (defgroup org-edit-structure nil
  748. "Options concerning structure editing in Org-mode."
  749. :tag "Org Edit Structure"
  750. :group 'org-structure)
  751. (defcustom org-odd-levels-only nil
  752. "Non-nil means skip even levels and only use odd levels for the outline.
  753. This has the effect that two stars are being added/taken away in
  754. promotion/demotion commands. It also influences how levels are
  755. handled by the exporters.
  756. Changing it requires restart of `font-lock-mode' to become effective
  757. for fontification also in regions already fontified.
  758. You may also set this on a per-file basis by adding one of the following
  759. lines to the buffer:
  760. #+STARTUP: odd
  761. #+STARTUP: oddeven"
  762. :group 'org-edit-structure
  763. :group 'org-appearance
  764. :type 'boolean)
  765. (defcustom org-adapt-indentation t
  766. "Non-nil means adapt indentation to outline node level.
  767. When this variable is set, Org assumes that you write outlines by
  768. indenting text in each node to align with the headline (after the stars).
  769. The following issues are influenced by this variable:
  770. - When this is set and the *entire* text in an entry is indented, the
  771. indentation is increased by one space in a demotion command, and
  772. decreased by one in a promotion command. If any line in the entry
  773. body starts with text at column 0, indentation is not changed at all.
  774. - Property drawers and planning information is inserted indented when
  775. this variable s set. When nil, they will not be indented.
  776. - TAB indents a line relative to context. The lines below a headline
  777. will be indented when this variable is set.
  778. Note that this is all about true indentation, by adding and removing
  779. space characters. See also `org-indent.el' which does level-dependent
  780. indentation in a virtual way, i.e. at display time in Emacs."
  781. :group 'org-edit-structure
  782. :type 'boolean)
  783. (defcustom org-special-ctrl-a/e nil
  784. "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
  785. When t, `C-a' will bring back the cursor to the beginning of the
  786. headline text, i.e. after the stars and after a possible TODO keyword.
  787. In an item, this will be the position after the bullet.
  788. When the cursor is already at that position, another `C-a' will bring
  789. it to the beginning of the line.
  790. `C-e' will jump to the end of the headline, ignoring the presence of tags
  791. in the headline. A second `C-e' will then jump to the true end of the
  792. line, after any tags. This also means that, when this variable is
  793. non-nil, `C-e' also will never jump beyond the end of the heading of a
  794. folded section, i.e. not after the ellipses.
  795. When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
  796. going to the true line boundary first. Only a directly following, identical
  797. keypress will bring the cursor to the special positions.
  798. This may also be a cons cell where the behavior for `C-a' and `C-e' is
  799. set separately."
  800. :group 'org-edit-structure
  801. :type '(choice
  802. (const :tag "off" nil)
  803. (const :tag "on: after stars/bullet and before tags first" t)
  804. (const :tag "reversed: true line boundary first" reversed)
  805. (cons :tag "Set C-a and C-e separately"
  806. (choice :tag "Special C-a"
  807. (const :tag "off" nil)
  808. (const :tag "on: after stars/bullet first" t)
  809. (const :tag "reversed: before stars/bullet first" reversed))
  810. (choice :tag "Special C-e"
  811. (const :tag "off" nil)
  812. (const :tag "on: before tags first" t)
  813. (const :tag "reversed: after tags first" reversed)))))
  814. (if (fboundp 'defvaralias)
  815. (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e))
  816. (defcustom org-special-ctrl-k nil
  817. "Non-nil means `C-k' will behave specially in headlines.
  818. When nil, `C-k' will call the default `kill-line' command.
  819. When t, the following will happen while the cursor is in the headline:
  820. - When the cursor is at the beginning of a headline, kill the entire
  821. line and possible the folded subtree below the line.
  822. - When in the middle of the headline text, kill the headline up to the tags.
  823. - When after the headline text, kill the tags."
  824. :group 'org-edit-structure
  825. :type 'boolean)
  826. (defcustom org-ctrl-k-protect-subtree nil
  827. "Non-nil means, do not delete a hidden subtree with C-k.
  828. When set to the symbol `error', simply throw an error when C-k is
  829. used to kill (part-of) a headline that has hidden text behind it.
  830. Any other non-nil value will result in a query to the user, if it is
  831. OK to kill that hidden subtree. When nil, kill without remorse."
  832. :group 'org-edit-structure
  833. :type '(choice
  834. (const :tag "Do not protect hidden subtrees" nil)
  835. (const :tag "Protect hidden subtrees with a security query" t)
  836. (const :tag "Never kill a hidden subtree with C-k" error)))
  837. (defcustom org-yank-folded-subtrees t
  838. "Non-nil means when yanking subtrees, fold them.
  839. If the kill is a single subtree, or a sequence of subtrees, i.e. if
  840. it starts with a heading and all other headings in it are either children
  841. or siblings, then fold all the subtrees. However, do this only if no
  842. text after the yank would be swallowed into a folded tree by this action."
  843. :group 'org-edit-structure
  844. :type 'boolean)
  845. (defcustom org-yank-adjusted-subtrees nil
  846. "Non-nil means when yanking subtrees, adjust the level.
  847. With this setting, `org-paste-subtree' is used to insert the subtree, see
  848. this function for details."
  849. :group 'org-edit-structure
  850. :type 'boolean)
  851. (defcustom org-M-RET-may-split-line '((default . t))
  852. "Non-nil means M-RET will split the line at the cursor position.
  853. When nil, it will go to the end of the line before making a
  854. new line.
  855. You may also set this option in a different way for different
  856. contexts. Valid contexts are:
  857. headline when creating a new headline
  858. item when creating a new item
  859. table in a table field
  860. default the value to be used for all contexts not explicitly
  861. customized"
  862. :group 'org-structure
  863. :group 'org-table
  864. :type '(choice
  865. (const :tag "Always" t)
  866. (const :tag "Never" nil)
  867. (repeat :greedy t :tag "Individual contexts"
  868. (cons
  869. (choice :tag "Context"
  870. (const headline)
  871. (const item)
  872. (const table)
  873. (const default))
  874. (boolean)))))
  875. (defcustom org-insert-heading-respect-content nil
  876. "Non-nil means insert new headings after the current subtree.
  877. When nil, the new heading is created directly after the current line.
  878. The commands \\[org-insert-heading-respect-content] and
  879. \\[org-insert-todo-heading-respect-content] turn this variable on
  880. for the duration of the command."
  881. :group 'org-structure
  882. :type 'boolean)
  883. (defcustom org-blank-before-new-entry '((heading . auto)
  884. (plain-list-item . auto))
  885. "Should `org-insert-heading' leave a blank line before new heading/item?
  886. The value is an alist, with `heading' and `plain-list-item' as car,
  887. and a boolean flag as cdr. For plain lists, if the variable
  888. `org-empty-line-terminates-plain-lists' is set, the setting here
  889. is ignored and no empty line is inserted, to keep the list in tact."
  890. :group 'org-edit-structure
  891. :type '(list
  892. (cons (const heading)
  893. (choice (const :tag "Never" nil)
  894. (const :tag "Always" t)
  895. (const :tag "Auto" auto)))
  896. (cons (const plain-list-item)
  897. (choice (const :tag "Never" nil)
  898. (const :tag "Always" t)
  899. (const :tag "Auto" auto)))))
  900. (defcustom org-insert-heading-hook nil
  901. "Hook being run after inserting a new heading."
  902. :group 'org-edit-structure
  903. :type 'hook)
  904. (defcustom org-enable-fixed-width-editor t
  905. "Non-nil means lines starting with \":\" are treated as fixed-width.
  906. This currently only means they are never auto-wrapped.
  907. When nil, such lines will be treated like ordinary lines.
  908. See also the QUOTE keyword."
  909. :group 'org-edit-structure
  910. :type 'boolean)
  911. (defcustom org-goto-auto-isearch t
  912. "Non-nil means typing characters in org-goto starts incremental search."
  913. :group 'org-edit-structure
  914. :type 'boolean)
  915. (defgroup org-sparse-trees nil
  916. "Options concerning sparse trees in Org-mode."
  917. :tag "Org Sparse Trees"
  918. :group 'org-structure)
  919. (defcustom org-highlight-sparse-tree-matches t
  920. "Non-nil means highlight all matches that define a sparse tree.
  921. The highlights will automatically disappear the next time the buffer is
  922. changed by an edit command."
  923. :group 'org-sparse-trees
  924. :type 'boolean)
  925. (defcustom org-remove-highlights-with-change t
  926. "Non-nil means any change to the buffer will remove temporary highlights.
  927. Such highlights are created by `org-occur' and `org-clock-display'.
  928. When nil, `C-c C-c needs to be used to get rid of the highlights.
  929. The highlights created by `org-preview-latex-fragment' always need
  930. `C-c C-c' to be removed."
  931. :group 'org-sparse-trees
  932. :group 'org-time
  933. :type 'boolean)
  934. (defcustom org-occur-hook '(org-first-headline-recenter)
  935. "Hook that is run after `org-occur' has constructed a sparse tree.
  936. This can be used to recenter the window to show as much of the structure
  937. as possible."
  938. :group 'org-sparse-trees
  939. :type 'hook)
  940. (defgroup org-imenu-and-speedbar nil
  941. "Options concerning imenu and speedbar in Org-mode."
  942. :tag "Org Imenu and Speedbar"
  943. :group 'org-structure)
  944. (defcustom org-imenu-depth 2
  945. "The maximum level for Imenu access to Org-mode headlines.
  946. This also applied for speedbar access."
  947. :group 'org-imenu-and-speedbar
  948. :type 'integer)
  949. (defgroup org-table nil
  950. "Options concerning tables in Org-mode."
  951. :tag "Org Table"
  952. :group 'org)
  953. (defcustom org-enable-table-editor 'optimized
  954. "Non-nil means lines starting with \"|\" are handled by the table editor.
  955. When nil, such lines will be treated like ordinary lines.
  956. When equal to the symbol `optimized', the table editor will be optimized to
  957. do the following:
  958. - Automatic overwrite mode in front of whitespace in table fields.
  959. This makes the structure of the table stay in tact as long as the edited
  960. field does not exceed the column width.
  961. - Minimize the number of realigns. Normally, the table is aligned each time
  962. TAB or RET are pressed to move to another field. With optimization this
  963. happens only if changes to a field might have changed the column width.
  964. Optimization requires replacing the functions `self-insert-command',
  965. `delete-char', and `backward-delete-char' in Org-mode buffers, with a
  966. slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
  967. very good at guessing when a re-align will be necessary, but you can always
  968. force one with \\[org-ctrl-c-ctrl-c].
  969. If you would like to use the optimized version in Org-mode, but the
  970. un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
  971. This variable can be used to turn on and off the table editor during a session,
  972. but in order to toggle optimization, a restart is required.
  973. See also the variable `org-table-auto-blank-field'."
  974. :group 'org-table
  975. :type '(choice
  976. (const :tag "off" nil)
  977. (const :tag "on" t)
  978. (const :tag "on, optimized" optimized)))
  979. (defcustom org-self-insert-cluster-for-undo t
  980. "Non-nil means cluster self-insert commands for undo when possible.
  981. If this is set, then, like in the Emacs command loop, 20 consecutive
  982. characters will be undone together.
  983. This is configurable, because there is some impact on typing performance."
  984. :group 'org-table
  985. :type 'boolean)
  986. (defcustom org-table-tab-recognizes-table.el t
  987. "Non-nil means TAB will automatically notice a table.el table.
  988. When it sees such a table, it moves point into it and - if necessary -
  989. calls `table-recognize-table'."
  990. :group 'org-table-editing
  991. :type 'boolean)
  992. (defgroup org-link nil
  993. "Options concerning links in Org-mode."
  994. :tag "Org Link"
  995. :group 'org)
  996. (defvar org-link-abbrev-alist-local nil
  997. "Buffer-local version of `org-link-abbrev-alist', which see.
  998. The value of this is taken from the #+LINK lines.")
  999. (make-variable-buffer-local 'org-link-abbrev-alist-local)
  1000. (defcustom org-link-abbrev-alist nil
  1001. "Alist of link abbreviations.
  1002. The car of each element is a string, to be replaced at the start of a link.
  1003. The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
  1004. links in Org-mode buffers can have an optional tag after a double colon, e.g.
  1005. [[linkkey:tag][description]]
  1006. The 'linkkey' must be a word word, starting with a letter, followed
  1007. by letters, numbers, '-' or '_'.
  1008. If REPLACE is a string, the tag will simply be appended to create the link.
  1009. If the string contains \"%s\", the tag will be inserted there. Alternatively,
  1010. the placeholder \"%h\" will cause a url-encoded version of the tag to
  1011. be inserted at that point (see the function `url-hexify-string').
  1012. REPLACE may also be a function that will be called with the tag as the
  1013. only argument to create the link, which should be returned as a string.
  1014. See the manual for examples."
  1015. :group 'org-link
  1016. :type '(repeat
  1017. (cons
  1018. (string :tag "Protocol")
  1019. (choice
  1020. (string :tag "Format")
  1021. (function)))))
  1022. (defcustom org-descriptive-links t
  1023. "Non-nil means hide link part and only show description of bracket links.
  1024. Bracket links are like [[link][description]]. This variable sets the initial
  1025. state in new org-mode buffers. The setting can then be toggled on a
  1026. per-buffer basis from the Org->Hyperlinks menu."
  1027. :group 'org-link
  1028. :type 'boolean)
  1029. (defcustom org-link-file-path-type 'adaptive
  1030. "How the path name in file links should be stored.
  1031. Valid values are:
  1032. relative Relative to the current directory, i.e. the directory of the file
  1033. into which the link is being inserted.
  1034. absolute Absolute path, if possible with ~ for home directory.
  1035. noabbrev Absolute path, no abbreviation of home directory.
  1036. adaptive Use relative path for files in the current directory and sub-
  1037. directories of it. For other files, use an absolute path."
  1038. :group 'org-link
  1039. :type '(choice
  1040. (const relative)
  1041. (const absolute)
  1042. (const noabbrev)
  1043. (const adaptive)))
  1044. (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
  1045. "Types of links that should be activated in Org-mode files.
  1046. This is a list of symbols, each leading to the activation of a certain link
  1047. type. In principle, it does not hurt to turn on most link types - there may
  1048. be a small gain when turning off unused link types. The types are:
  1049. bracket The recommended [[link][description]] or [[link]] links with hiding.
  1050. angular Links in angular brackets that may contain whitespace like
  1051. <bbdb:Carsten Dominik>.
  1052. plain Plain links in normal text, no whitespace, like http://google.com.
  1053. radio Text that is matched by a radio target, see manual for details.
  1054. tag Tag settings in a headline (link to tag search).
  1055. date Time stamps (link to calendar).
  1056. footnote Footnote labels.
  1057. Changing this variable requires a restart of Emacs to become effective."
  1058. :group 'org-link
  1059. :type '(set :greedy t
  1060. (const :tag "Double bracket links (new style)" bracket)
  1061. (const :tag "Angular bracket links (old style)" angular)
  1062. (const :tag "Plain text links" plain)
  1063. (const :tag "Radio target matches" radio)
  1064. (const :tag "Tags" tag)
  1065. (const :tag "Timestamps" date)
  1066. (const :tag "Footnotes" footnote)))
  1067. (defcustom org-make-link-description-function nil
  1068. "Function to use to generate link descriptions from links. If
  1069. nil the link location will be used. This function must take two
  1070. parameters; the first is the link and the second the description
  1071. org-insert-link has generated, and should return the description
  1072. to use."
  1073. :group 'org-link
  1074. :type 'function)
  1075. (defgroup org-link-store nil
  1076. "Options concerning storing links in Org-mode."
  1077. :tag "Org Store Link"
  1078. :group 'org-link)
  1079. (defcustom org-email-link-description-format "Email %c: %.30s"
  1080. "Format of the description part of a link to an email or usenet message.
  1081. The following %-escapes will be replaced by corresponding information:
  1082. %F full \"From\" field
  1083. %f name, taken from \"From\" field, address if no name
  1084. %T full \"To\" field
  1085. %t first name in \"To\" field, address if no name
  1086. %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
  1087. will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
  1088. %s subject
  1089. %m message-id.
  1090. You may use normal field width specification between the % and the letter.
  1091. This is for example useful to limit the length of the subject.
  1092. Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
  1093. :group 'org-link-store
  1094. :type 'string)
  1095. (defcustom org-from-is-user-regexp
  1096. (let (r1 r2)
  1097. (when (and user-mail-address (not (string= user-mail-address "")))
  1098. (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
  1099. (when (and user-full-name (not (string= user-full-name "")))
  1100. (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
  1101. (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
  1102. "Regexp matched against the \"From:\" header of an email or usenet message.
  1103. It should match if the message is from the user him/herself."
  1104. :group 'org-link-store
  1105. :type 'regexp)
  1106. (defcustom org-link-to-org-use-id 'create-if-interactive-and-no-custom-id
  1107. "Non-nil means storing a link to an Org file will use entry IDs.
  1108. Note that before this variable is even considered, org-id must be loaded,
  1109. so please customize `org-modules' and turn it on.
  1110. The variable can have the following values:
  1111. t Create an ID if needed to make a link to the current entry.
  1112. create-if-interactive
  1113. If `org-store-link' is called directly (interactively, as a user
  1114. command), do create an ID to support the link. But when doing the
  1115. job for remember, only use the ID if it already exists. The
  1116. purpose of this setting is to avoid proliferation of unwanted
  1117. IDs, just because you happen to be in an Org file when you
  1118. call `org-remember' that automatically and preemptively
  1119. creates a link. If you do want to get an ID link in a remember
  1120. template to an entry not having an ID, create it first by
  1121. explicitly creating a link to it, using `C-c C-l' first.
  1122. create-if-interactive-and-no-custom-id
  1123. Like create-if-interactive, but do not create an ID if there is
  1124. a CUSTOM_ID property defined in the entry. This is the default.
  1125. use-existing
  1126. Use existing ID, do not create one.
  1127. nil Never use an ID to make a link, instead link using a text search for
  1128. the headline text."
  1129. :group 'org-link-store
  1130. :type '(choice
  1131. (const :tag "Create ID to make link" t)
  1132. (const :tag "Create if storing link interactively"
  1133. create-if-interactive)
  1134. (const :tag "Create if storing link interactively and no CUSTOM_ID is present"
  1135. create-if-interactive-and-no-custom-id)
  1136. (const :tag "Only use existing" use-existing)
  1137. (const :tag "Do not use ID to create link" nil)))
  1138. (defcustom org-context-in-file-links t
  1139. "Non-nil means file links from `org-store-link' contain context.
  1140. A search string will be added to the file name with :: as separator and
  1141. used to find the context when the link is activated by the command
  1142. `org-open-at-point'.
  1143. Using a prefix arg to the command \\[org-store-link] (`org-store-link')
  1144. negates this setting for the duration of the command."
  1145. :group 'org-link-store
  1146. :type 'boolean)
  1147. (defcustom org-keep-stored-link-after-insertion nil
  1148. "Non-nil means keep link in list for entire session.
  1149. The command `org-store-link' adds a link pointing to the current
  1150. location to an internal list. These links accumulate during a session.
  1151. The command `org-insert-link' can be used to insert links into any
  1152. Org-mode file (offering completion for all stored links). When this
  1153. option is nil, every link which has been inserted once using \\[org-insert-link]
  1154. will be removed from the list, to make completing the unused links
  1155. more efficient."
  1156. :group 'org-link-store
  1157. :type 'boolean)
  1158. (defgroup org-link-follow nil
  1159. "Options concerning following links in Org-mode."
  1160. :tag "Org Follow Link"
  1161. :group 'org-link)
  1162. (defcustom org-link-translation-function nil
  1163. "Function to translate links with different syntax to Org syntax.
  1164. This can be used to translate links created for example by the Planner
  1165. or emacs-wiki packages to Org syntax.
  1166. The function must accept two parameters, a TYPE containing the link
  1167. protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
  1168. which is everything after the link protocol. It should return a cons
  1169. with possibly modified values of type and path.
  1170. Org contains a function for this, so if you set this variable to
  1171. `org-translate-link-from-planner', you should be able follow many
  1172. links created by planner."
  1173. :group 'org-link-follow
  1174. :type 'function)
  1175. (defcustom org-follow-link-hook nil
  1176. "Hook that is run after a link has been followed."
  1177. :group 'org-link-follow
  1178. :type 'hook)
  1179. (defcustom org-tab-follows-link nil
  1180. "Non-nil means on links TAB will follow the link.
  1181. Needs to be set before org.el is loaded.
  1182. This really should not be used, it does not make sense, and the
  1183. implementation is bad."
  1184. :group 'org-link-follow
  1185. :type 'boolean)
  1186. (defcustom org-return-follows-link nil
  1187. "Non-nil means on links RET will follow the link."
  1188. :group 'org-link-follow
  1189. :type 'boolean)
  1190. (defcustom org-mouse-1-follows-link
  1191. (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
  1192. "Non-nil means mouse-1 on a link will follow the link.
  1193. A longer mouse click will still set point. Does not work on XEmacs.
  1194. Needs to be set before org.el is loaded."
  1195. :group 'org-link-follow
  1196. :type 'boolean)
  1197. (defcustom org-mark-ring-length 4
  1198. "Number of different positions to be recorded in the ring
  1199. Changing this requires a restart of Emacs to work correctly."
  1200. :group 'org-link-follow
  1201. :type 'integer)
  1202. (defcustom org-link-frame-setup
  1203. '((vm . vm-visit-folder-other-frame)
  1204. (gnus . org-gnus-no-new-news)
  1205. (file . find-file-other-window)
  1206. (wl . wl-other-frame))
  1207. "Setup the frame configuration for following links.
  1208. When following a link with Emacs, it may often be useful to display
  1209. this link in another window or frame. This variable can be used to
  1210. set this up for the different types of links.
  1211. For VM, use any of
  1212. `vm-visit-folder'
  1213. `vm-visit-folder-other-frame'
  1214. For Gnus, use any of
  1215. `gnus'
  1216. `gnus-other-frame'
  1217. `org-gnus-no-new-news'
  1218. For FILE, use any of
  1219. `find-file'
  1220. `find-file-other-window'
  1221. `find-file-other-frame'
  1222. For Wanderlust use any of
  1223. `wl'
  1224. `wl-other-frame'
  1225. For the calendar, use the variable `calendar-setup'.
  1226. For BBDB, it is currently only possible to display the matches in
  1227. another window."
  1228. :group 'org-link-follow
  1229. :type '(list
  1230. (cons (const vm)
  1231. (choice
  1232. (const vm-visit-folder)
  1233. (const vm-visit-folder-other-window)
  1234. (const vm-visit-folder-other-frame)))
  1235. (cons (const gnus)
  1236. (choice
  1237. (const gnus)
  1238. (const gnus-other-frame)
  1239. (const org-gnus-no-new-news)))
  1240. (cons (const file)
  1241. (choice
  1242. (const find-file)
  1243. (const find-file-other-window)
  1244. (const find-file-other-frame)))
  1245. (cons (const wl)
  1246. (choice
  1247. (const wl)
  1248. (const wl-other-frame)))))
  1249. (defcustom org-display-internal-link-with-indirect-buffer nil
  1250. "Non-nil means use indirect buffer to display infile links.
  1251. Activating internal links (from one location in a file to another location
  1252. in the same file) normally just jumps to the location. When the link is
  1253. activated with a C-u prefix (or with mouse-3), the link is displayed in
  1254. another window. When this option is set, the other window actually displays
  1255. an indirect buffer clone of the current buffer, to avoid any visibility
  1256. changes to the current buffer."
  1257. :group 'org-link-follow
  1258. :type 'boolean)
  1259. (defcustom org-open-non-existing-files nil
  1260. "Non-nil means `org-open-file' will open non-existing files.
  1261. When nil, an error will be generated.
  1262. This variable applies only to external applications because they
  1263. might choke on non-existing files. If the link is to a file that
  1264. will be opened in Emacs, the variable is ignored."
  1265. :group 'org-link-follow
  1266. :type 'boolean)
  1267. (defcustom org-open-directory-means-index-dot-org nil
  1268. "Non-nil means a link to a directory really means to index.org.
  1269. When nil, following a directory link will run dired or open a finder/explorer
  1270. window on that directory."
  1271. :group 'org-link-follow
  1272. :type 'boolean)
  1273. (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
  1274. "Function and arguments to call for following mailto links.
  1275. This is a list with the first element being a lisp function, and the
  1276. remaining elements being arguments to the function. In string arguments,
  1277. %a will be replaced by the address, and %s will be replaced by the subject
  1278. if one was given like in <mailto:arthur@galaxy.org::this subject>."
  1279. :group 'org-link-follow
  1280. :type '(choice
  1281. (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
  1282. (const :tag "compose-mail" (compose-mail "%a" "%s"))
  1283. (const :tag "message-mail" (message-mail "%a" "%s"))
  1284. (cons :tag "other" (function) (repeat :tag "argument" sexp))))
  1285. (defcustom org-confirm-shell-link-function 'yes-or-no-p
  1286. "Non-nil means ask for confirmation before executing shell links.
  1287. Shell links can be dangerous: just think about a link
  1288. [[shell:rm -rf ~/*][Google Search]]
  1289. This link would show up in your Org-mode document as \"Google Search\",
  1290. but really it would remove your entire home directory.
  1291. Therefore we advise against setting this variable to nil.
  1292. Just change it to `y-or-n-p' if you want to confirm with a
  1293. single keystroke rather than having to type \"yes\"."
  1294. :group 'org-link-follow
  1295. :type '(choice
  1296. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1297. (const :tag "with y-or-n (faster)" y-or-n-p)
  1298. (const :tag "no confirmation (dangerous)" nil)))
  1299. (put 'org-confirm-shell-link-function
  1300. 'safe-local-variable
  1301. '(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1302. (defcustom org-confirm-elisp-link-function 'yes-or-no-p
  1303. "Non-nil means ask for confirmation before executing Emacs Lisp links.
  1304. Elisp links can be dangerous: just think about a link
  1305. [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
  1306. This link would show up in your Org-mode document as \"Google Search\",
  1307. but really it would remove your entire home directory.
  1308. Therefore we advise against setting this variable to nil.
  1309. Just change it to `y-or-n-p' if you want to confirm with a
  1310. single keystroke rather than having to type \"yes\"."
  1311. :group 'org-link-follow
  1312. :type '(choice
  1313. (const :tag "with yes-or-no (safer)" yes-or-no-p)
  1314. (const :tag "with y-or-n (faster)" y-or-n-p)
  1315. (const :tag "no confirmation (dangerous)" nil)))
  1316. (put 'org-confirm-shell-link-function
  1317. 'safe-local-variable
  1318. '(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
  1319. (defconst org-file-apps-defaults-gnu
  1320. '((remote . emacs)
  1321. (system . mailcap)
  1322. (t . mailcap))
  1323. "Default file applications on a UNIX or GNU/Linux system.
  1324. See `org-file-apps'.")
  1325. (defconst org-file-apps-defaults-macosx
  1326. '((remote . emacs)
  1327. (t . "open %s")
  1328. (system . "open %s")
  1329. ("ps.gz" . "gv %s")
  1330. ("eps.gz" . "gv %s")
  1331. ("dvi" . "xdvi %s")
  1332. ("fig" . "xfig %s"))
  1333. "Default file applications on a MacOS X system.
  1334. The system \"open\" is known as a default, but we use X11 applications
  1335. for some files for which the OS does not have a good default.
  1336. See `org-file-apps'.")
  1337. (defconst org-file-apps-defaults-windowsnt
  1338. (list
  1339. '(remote . emacs)
  1340. (cons t
  1341. (list (if (featurep 'xemacs)
  1342. 'mswindows-shell-execute
  1343. 'w32-shell-execute)
  1344. "open" 'file))
  1345. (cons 'system
  1346. (list (if (featurep 'xemacs)
  1347. 'mswindows-shell-execute
  1348. 'w32-shell-execute)
  1349. "open" 'file)))
  1350. "Default file applications on a Windows NT system.
  1351. The system \"open\" is used for most files.
  1352. See `org-file-apps'.")
  1353. (defcustom org-file-apps
  1354. '(
  1355. (auto-mode . emacs)
  1356. ("\\.mm\\'" . default)
  1357. ("\\.x?html?\\'" . default)
  1358. ("\\.pdf\\'" . default)
  1359. )
  1360. "External applications for opening `file:path' items in a document.
  1361. Org-mode uses system defaults for different file types, but
  1362. you can use this variable to set the application for a given file
  1363. extension. The entries in this list are cons cells where the car identifies
  1364. files and the cdr the corresponding command. Possible values for the
  1365. file identifier are
  1366. \"string\" A string as a file identifier can be interpreted in different
  1367. ways, depending on its contents:
  1368. - Alphanumeric characters only:
  1369. Match links with this file extension.
  1370. Example: (\"pdf\" . \"evince %s\")
  1371. to open PDFs with evince.
  1372. - Regular expression: Match links where the
  1373. filename matches the regexp. If you want to
  1374. use groups here, use shy groups.
  1375. Example: (\"\\.x?html\\'\" . \"firefox %s\")
  1376. (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
  1377. to open *.html and *.xhtml with firefox.
  1378. - Regular expression which contains (non-shy) groups:
  1379. Match links where the whole link, including \"::\", and
  1380. anything after that, matches the regexp.
  1381. In a custom command string, %1, %2, etc. are replaced with
  1382. the parts of the link that were matched by the groups.
  1383. For backwards compatibility, if a command string is given
  1384. that does not use any of the group matches, this case is
  1385. handled identically to the second one (i.e. match against
  1386. file name only).
  1387. In a custom lisp form, you can access the group matches with
  1388. (match-string n link).
  1389. Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
  1390. to open [[file:document.pdf::5]] with evince at page 5.
  1391. `directory' Matches a directory
  1392. `remote' Matches a remote file, accessible through tramp or efs.
  1393. Remote files most likely should be visited through Emacs
  1394. because external applications cannot handle such paths.
  1395. `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
  1396. so all files Emacs knows how to handle. Using this with
  1397. command `emacs' will open most files in Emacs. Beware that this
  1398. will also open html files inside Emacs, unless you add
  1399. (\"html\" . default) to the list as well.
  1400. t Default for files not matched by any of the other options.
  1401. `system' The system command to open files, like `open' on Windows
  1402. and Mac OS X, and mailcap under GNU/Linux. This is the command
  1403. that will be selected if you call `C-c C-o' with a double
  1404. `C-u C-u' prefix.
  1405. Possible values for the command are:
  1406. `emacs' The file will be visited by the current Emacs process.
  1407. `default' Use the default application for this file type, which is the
  1408. association for t in the list, most likely in the system-specific
  1409. part.
  1410. This can be used to overrule an unwanted setting in the
  1411. system-specific variable.
  1412. `system' Use the system command for opening files, like \"open\".
  1413. This command is specified by the entry whose car is `system'.
  1414. Most likely, the system-specific version of this variable
  1415. does define this command, but you can overrule/replace it
  1416. here.
  1417. string A command to be executed by a shell; %s will be replaced
  1418. by the path to the file.
  1419. sexp A Lisp form which will be evaluated. The file path will
  1420. be available in the Lisp variable `file'.
  1421. For more examples, see the system specific constants
  1422. `org-file-apps-defaults-macosx'
  1423. `org-file-apps-defaults-windowsnt'
  1424. `org-file-apps-defaults-gnu'."
  1425. :group 'org-link-follow
  1426. :type '(repeat
  1427. (cons (choice :value ""
  1428. (string :tag "Extension")
  1429. (const :tag "System command to open files" system)
  1430. (const :tag "Default for unrecognized files" t)
  1431. (const :tag "Remote file" remote)
  1432. (const :tag "Links to a directory" directory)
  1433. (const :tag "Any files that have Emacs modes"
  1434. auto-mode))
  1435. (choice :value ""
  1436. (const :tag "Visit with Emacs" emacs)
  1437. (const :tag "Use default" default)
  1438. (const :tag "Use the system command" system)
  1439. (string :tag "Command")
  1440. (sexp :tag "Lisp form")))))
  1441. (defgroup org-refile nil
  1442. "Options concerning refiling entries in Org-mode."
  1443. :tag "Org Refile"
  1444. :group 'org)
  1445. (defcustom org-directory "~/org"
  1446. "Directory with org files.
  1447. This is just a default location to look for Org files. There is no need
  1448. at all to put your files into this directory. It is only used in the
  1449. following situations:
  1450. 1. When a remember template specifies a target file that is not an
  1451. absolute path. The path will then be interpreted relative to
  1452. `org-directory'
  1453. 2. When a remember note is filed away in an interactive way (when exiting the
  1454. note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
  1455. with `org-directory' as the default path."
  1456. :group 'org-refile
  1457. :group 'org-remember
  1458. :type 'directory)
  1459. (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
  1460. "Default target for storing notes.
  1461. Used as a fall back file for org-remember.el and org-capture.el, for
  1462. templates that do not specify a target file."
  1463. :group 'org-refile
  1464. :group 'org-remember
  1465. :type '(choice
  1466. (const :tag "Default from remember-data-file" nil)
  1467. file))
  1468. (defcustom org-goto-interface 'outline
  1469. "The default interface to be used for `org-goto'.
  1470. Allowed values are:
  1471. outline The interface shows an outline of the relevant file
  1472. and the correct heading is found by moving through
  1473. the outline or by searching with incremental search.
  1474. outline-path-completion Headlines in the current buffer are offered via
  1475. completion. This is the interface also used by
  1476. the refile command."
  1477. :group 'org-refile
  1478. :type '(choice
  1479. (const :tag "Outline" outline)
  1480. (const :tag "Outline-path-completion" outline-path-completion)))
  1481. (defcustom org-goto-max-level 5
  1482. "Maximum level to be considered when running org-goto with refile interface."
  1483. :group 'org-refile
  1484. :type 'integer)
  1485. (defcustom org-reverse-note-order nil
  1486. "Non-nil means store new notes at the beginning of a file or entry.
  1487. When nil, new notes will be filed to the end of a file or entry.
  1488. This can also be a list with cons cells of regular expressions that
  1489. are matched against file names, and values."
  1490. :group 'org-remember
  1491. :group 'org-refile
  1492. :type '(choice
  1493. (const :tag "Reverse always" t)
  1494. (const :tag "Reverse never" nil)
  1495. (repeat :tag "By file name regexp"
  1496. (cons regexp boolean))))
  1497. (defcustom org-log-refile nil
  1498. "Information to record when a task is refiled.
  1499. Possible values are:
  1500. nil Don't add anything
  1501. time Add a time stamp to the task
  1502. note Prompt for a note and add it with template `org-log-note-headings'
  1503. This option can also be set with on a per-file-basis with
  1504. #+STARTUP: nologrefile
  1505. #+STARTUP: logrefile
  1506. #+STARTUP: lognoterefile
  1507. You can have local logging settings for a subtree by setting the LOGGING
  1508. property to one or more of these keywords.
  1509. When bulk-refiling from the agenda, the value `note' is forbidden and
  1510. will temporarily be changed to `time'."
  1511. :group 'org-refile
  1512. :group 'org-progress
  1513. :type '(choice
  1514. (const :tag "No logging" nil)
  1515. (const :tag "Record timestamp" time)
  1516. (const :tag "Record timestamp with note." note)))
  1517. (defcustom org-refile-targets nil
  1518. "Targets for refiling entries with \\[org-refile].
  1519. This is list of cons cells. Each cell contains:
  1520. - a specification of the files to be considered, either a list of files,
  1521. or a symbol whose function or variable value will be used to retrieve
  1522. a file name or a list of file names. If you use `org-agenda-files' for
  1523. that, all agenda files will be scanned for targets. Nil means consider
  1524. headings in the current buffer.
  1525. - A specification of how to find candidate refile targets. This may be
  1526. any of:
  1527. - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
  1528. This tag has to be present in all target headlines, inheritance will
  1529. not be considered.
  1530. - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
  1531. todo keyword.
  1532. - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
  1533. headlines that are refiling targets.
  1534. - a cons cell (:level . N). Any headline of level N is considered a target.
  1535. Note that, when `org-odd-levels-only' is set, level corresponds to
  1536. order in hierarchy, not to the number of stars.
  1537. - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
  1538. Note that, when `org-odd-levels-only' is set, level corresponds to
  1539. order in hierarchy, not to the number of stars.
  1540. You can set the variable `org-refile-target-verify-function' to a function
  1541. to verify each headline found by the simple critery above.
  1542. When this variable is nil, all top-level headlines in the current buffer
  1543. are used, equivalent to the value `((nil . (:level . 1))'."
  1544. :group 'org-refile
  1545. :type '(repeat
  1546. (cons
  1547. (choice :value org-agenda-files
  1548. (const :tag "All agenda files" org-agenda-files)
  1549. (const :tag "Current buffer" nil)
  1550. (function) (variable) (file))
  1551. (choice :tag "Identify target headline by"
  1552. (cons :tag "Specific tag" (const :value :tag) (string))
  1553. (cons :tag "TODO keyword" (const :value :todo) (string))
  1554. (cons :tag "Regular expression" (const :value :regexp) (regexp))
  1555. (cons :tag "Level number" (const :value :level) (integer))
  1556. (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
  1557. (defcustom org-refile-target-verify-function nil
  1558. "Function to verify if the headline at point should be a refile target.
  1559. The function will be called without arguments, with point at the
  1560. beginning of the headline. It should return t and leave point
  1561. where it is if the headline is a valid target for refiling.
  1562. If the target should not be selected, the function must return nil.
  1563. In addition to this, it may move point to a place from where the search
  1564. should be continued. For example, the function may decide that the entire
  1565. subtree of the current entry should be excluded and move point to the end
  1566. of the subtree."
  1567. :group 'org-refile
  1568. :type 'function)
  1569. (defcustom org-refile-use-cache nil
  1570. "Non-nil means cache refile targets to speed up the process.
  1571. The cache for a particular file will be updated automatically when
  1572. the buffer has been killed, or when any of the marker used for flagging
  1573. refile targets no longer points at a live buffer.
  1574. If you have added new entries to a buffer that might themselves be targets,
  1575. you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
  1576. find that easier, `C-u C-u C-u C-c C-w'."
  1577. :group 'org-refile
  1578. :type 'boolean)
  1579. (defcustom org-refile-use-outline-path nil
  1580. "Non-nil means provide refile targets as paths.
  1581. So a level 3 headline will be available as level1/level2/level3.
  1582. When the value is `file', also include the file name (without directory)
  1583. into the path. In this case, you can also stop the completion after
  1584. the file name, to get entries inserted as top level in the file.
  1585. When `full-file-path', include the full file path."
  1586. :group 'org-refile
  1587. :type '(choice
  1588. (const :tag "Not" nil)
  1589. (const :tag "Yes" t)
  1590. (const :tag "Start with file name" file)
  1591. (const :tag "Start with full file path" full-file-path)))
  1592. (defcustom org-outline-path-complete-in-steps t
  1593. "Non-nil means complete the outline path in hierarchical steps.
  1594. When Org-mode uses the refile interface to select an outline path
  1595. \(see variable `org-refile-use-outline-path'), the completion of
  1596. the path can be done is a single go, or if can be done in steps down
  1597. the headline hierarchy. Going in steps is probably the best if you
  1598. do not use a special completion package like `ido' or `icicles'.
  1599. However, when using these packages, going in one step can be very
  1600. fast, while still showing the whole path to the entry."
  1601. :group 'org-refile
  1602. :type 'boolean)
  1603. (defcustom org-refile-allow-creating-parent-nodes nil
  1604. "Non-nil means allow to create new nodes as refile targets.
  1605. New nodes are then created by adding \"/new node name\" to the completion
  1606. of an existing node. When the value of this variable is `confirm',
  1607. new node creation must be confirmed by the user (recommended)
  1608. When nil, the completion must match an existing entry.
  1609. Note that, if the new heading is not seen by the criteria
  1610. listed in `org-refile-targets', multiple instances of the same
  1611. heading would be created by trying again to file under the new
  1612. heading."
  1613. :group 'org-refile
  1614. :type '(choice
  1615. (const :tag "Never" nil)
  1616. (const :tag "Always" t)
  1617. (const :tag "Prompt for confirmation" confirm)))
  1618. (defgroup org-todo nil
  1619. "Options concerning TODO items in Org-mode."
  1620. :tag "Org TODO"
  1621. :group 'org)
  1622. (defgroup org-progress nil
  1623. "Options concerning Progress logging in Org-mode."
  1624. :tag "Org Progress"
  1625. :group 'org-time)
  1626. (defvar org-todo-interpretation-widgets
  1627. '(
  1628. (:tag "Sequence (cycling hits every state)" sequence)
  1629. (:tag "Type (cycling directly to DONE)" type))
  1630. "The available interpretation symbols for customizing
  1631. `org-todo-keywords'.
  1632. Interested libraries should add to this list.")
  1633. (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
  1634. "List of TODO entry keyword sequences and their interpretation.
  1635. \\<org-mode-map>This is a list of sequences.
  1636. Each sequence starts with a symbol, either `sequence' or `type',
  1637. indicating if the keywords should be interpreted as a sequence of
  1638. action steps, or as different types of TODO items. The first
  1639. keywords are states requiring action - these states will select a headline
  1640. for inclusion into the global TODO list Org-mode produces. If one of
  1641. the \"keywords\" is the vertical bat \"|\" the remaining keywords
  1642. signify that no further action is necessary. If \"|\" is not found,
  1643. the last keyword is treated as the only DONE state of the sequence.
  1644. The command \\[org-todo] cycles an entry through these states, and one
  1645. additional state where no keyword is present. For details about this
  1646. cycling, see the manual.
  1647. TODO keywords and interpretation can also be set on a per-file basis with
  1648. the special #+SEQ_TODO and #+TYP_TODO lines.
  1649. Each keyword can optionally specify a character for fast state selection
  1650. \(in combination with the variable `org-use-fast-todo-selection')
  1651. and specifiers for state change logging, using the same syntax
  1652. that is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says
  1653. that the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
  1654. indicates to record a time stamp each time this state is selected.
  1655. Each keyword may also specify if a timestamp or a note should be
  1656. recorded when entering or leaving the state, by adding additional
  1657. characters in the parenthesis after the keyword. This looks like this:
  1658. \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
  1659. record only the time of the state change. With X and Y being either
  1660. \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
  1661. Y when leaving the state if and only if the *target* state does not
  1662. define X. You may omit any of the fast-selection key or X or /Y,
  1663. so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
  1664. For backward compatibility, this variable may also be just a list
  1665. of keywords - in this case the interpretation (sequence or type) will be
  1666. taken from the (otherwise obsolete) variable `org-todo-interpretation'."
  1667. :group 'org-todo
  1668. :group 'org-keywords
  1669. :type '(choice
  1670. (repeat :tag "Old syntax, just keywords"
  1671. (string :tag "Keyword"))
  1672. (repeat :tag "New syntax"
  1673. (cons
  1674. (choice
  1675. :tag "Interpretation"
  1676. ;;Quick and dirty way to see
  1677. ;;`org-todo-interpretations'. This takes the
  1678. ;;place of item arguments
  1679. :convert-widget
  1680. (lambda (widget)
  1681. (widget-put widget
  1682. :args (mapcar
  1683. #'(lambda (x)
  1684. (widget-convert
  1685. (cons 'const x)))
  1686. org-todo-interpretation-widgets))
  1687. widget))
  1688. (repeat
  1689. (string :tag "Keyword"))))))
  1690. (defvar org-todo-keywords-1 nil
  1691. "All TODO and DONE keywords active in a buffer.")
  1692. (make-variable-buffer-local 'org-todo-keywords-1)
  1693. (defvar org-todo-keywords-for-agenda nil)
  1694. (defvar org-done-keywords-for-agenda nil)
  1695. (defvar org-drawers-for-agenda nil)
  1696. (defvar org-todo-keyword-alist-for-agenda nil)
  1697. (defvar org-tag-alist-for-agenda nil)
  1698. (defvar org-agenda-contributing-files nil)
  1699. (defvar org-not-done-keywords nil)
  1700. (make-variable-buffer-local 'org-not-done-keywords)
  1701. (defvar org-done-keywords nil)
  1702. (make-variable-buffer-local 'org-done-keywords)
  1703. (defvar org-todo-heads nil)
  1704. (make-variable-buffer-local 'org-todo-heads)
  1705. (defvar org-todo-sets nil)
  1706. (make-variable-buffer-local 'org-todo-sets)
  1707. (defvar org-todo-log-states nil)
  1708. (make-variable-buffer-local 'org-todo-log-states)
  1709. (defvar org-todo-kwd-alist nil)
  1710. (make-variable-buffer-local 'org-todo-kwd-alist)
  1711. (defvar org-todo-key-alist nil)
  1712. (make-variable-buffer-local 'org-todo-key-alist)
  1713. (defvar org-todo-key-trigger nil)
  1714. (make-variable-buffer-local 'org-todo-key-trigger)
  1715. (defcustom org-todo-interpretation 'sequence
  1716. "Controls how TODO keywords are interpreted.
  1717. This variable is in principle obsolete and is only used for
  1718. backward compatibility, if the interpretation of todo keywords is
  1719. not given already in `org-todo-keywords'. See that variable for
  1720. more information."
  1721. :group 'org-todo
  1722. :group 'org-keywords
  1723. :type '(choice (const sequence)
  1724. (const type)))
  1725. (defcustom org-use-fast-todo-selection t
  1726. "Non-nil means use the fast todo selection scheme with C-c C-t.
  1727. This variable describes if and under what circumstances the cycling
  1728. mechanism for TODO keywords will be replaced by a single-key, direct
  1729. selection scheme.
  1730. When nil, fast selection is never used.
  1731. When the symbol `prefix', it will be used when `org-todo' is called with
  1732. a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
  1733. in an agenda buffer.
  1734. When t, fast selection is used by default. In this case, the prefix
  1735. argument forces cycling instead.
  1736. In all cases, the special interface is only used if access keys have actually
  1737. been assigned by the user, i.e. if keywords in the configuration are followed
  1738. by a letter in parenthesis, like TODO(t)."
  1739. :group 'org-todo
  1740. :type '(choice
  1741. (const :tag "Never" nil)
  1742. (const :tag "By default" t)
  1743. (const :tag "Only with C-u C-c C-t" prefix)))
  1744. (defcustom org-provide-todo-statistics t
  1745. "Non-nil means update todo statistics after insert and toggle.
  1746. ALL-HEADLINES means update todo statistics by including headlines
  1747. with no TODO keyword as well, counting them as not done.
  1748. A list of TODO keywords means the same, but skip keywords that are
  1749. not in this list.
  1750. When this is set, todo statistics is updated in the parent of the
  1751. current entry each time a todo state is changed."
  1752. :group 'org-todo
  1753. :type '(choice
  1754. (const :tag "Yes, only for TODO entries" t)
  1755. (const :tag "Yes, including all entries" 'all-headlines)
  1756. (repeat :tag "Yes, for TODOs in this list"
  1757. (string :tag "TODO keyword"))
  1758. (other :tag "No TODO statistics" nil)))
  1759. (defcustom org-hierarchical-todo-statistics t
  1760. "Non-nil means TODO statistics covers just direct children.
  1761. When nil, all entries in the subtree are considered.
  1762. This has only an effect if `org-provide-todo-statistics' is set.
  1763. To set this to nil for only a single subtree, use a COOKIE_DATA
  1764. property and include the word \"recursive\" into the value."
  1765. :group 'org-todo
  1766. :type 'boolean)
  1767. (defcustom org-after-todo-state-change-hook nil
  1768. "Hook which is run after the state of a TODO item was changed.
  1769. The new state (a string with a TODO keyword, or nil) is available in the
  1770. Lisp variable `state'."
  1771. :group 'org-todo
  1772. :type 'hook)
  1773. (defvar org-blocker-hook nil
  1774. "Hook for functions that are allowed to block a state change.
  1775. Each function gets as its single argument a property list, see
  1776. `org-trigger-hook' for more information about this list.
  1777. If any of the functions in this hook returns nil, the state change
  1778. is blocked.")
  1779. (defvar org-trigger-hook nil
  1780. "Hook for functions that are triggered by a state change.
  1781. Each function gets as its single argument a property list with at least
  1782. the following elements:
  1783. (:type type-of-change :position pos-at-entry-start
  1784. :from old-state :to new-state)
  1785. Depending on the type, more properties may be present.
  1786. This mechanism is currently implemented for:
  1787. TODO state changes
  1788. ------------------
  1789. :type todo-state-change
  1790. :from previous state (keyword as a string), or nil, or a symbol
  1791. 'todo' or 'done', to indicate the general type of state.
  1792. :to new state, like in :from")
  1793. (defcustom org-enforce-todo-dependencies nil
  1794. "Non-nil means undone TODO entries will block switching the parent to DONE.
  1795. Also, if a parent has an :ORDERED: property, switching an entry to DONE will
  1796. be blocked if any prior sibling is not yet done.
  1797. Finally, if the parent is blocked because of ordered siblings of its own,
  1798. the child will also be blocked.
  1799. This variable needs to be set before org.el is loaded, and you need to
  1800. restart Emacs after a change to make the change effective. The only way
  1801. to change is while Emacs is running is through the customize interface."
  1802. :set (lambda (var val)
  1803. (set var val)
  1804. (if val
  1805. (add-hook 'org-blocker-hook
  1806. 'org-block-todo-from-children-or-siblings-or-parent)
  1807. (remove-hook 'org-blocker-hook
  1808. 'org-block-todo-from-children-or-siblings-or-parent)))
  1809. :group 'org-todo
  1810. :type 'boolean)
  1811. (defcustom org-enforce-todo-checkbox-dependencies nil
  1812. "Non-nil means unchecked boxes will block switching the parent to DONE.
  1813. When this is nil, checkboxes have no influence on switching TODO states.
  1814. When non-nil, you first need to check off all check boxes before the TODO
  1815. entry can be switched to DONE.
  1816. This variable needs to be set before org.el is loaded, and you need to
  1817. restart Emacs after a change to make the change effective. The only way
  1818. to change is while Emacs is running is through the customize interface."
  1819. :set (lambda (var val)
  1820. (set var val)
  1821. (if val
  1822. (add-hook 'org-blocker-hook
  1823. 'org-block-todo-from-checkboxes)
  1824. (remove-hook 'org-blocker-hook
  1825. 'org-block-todo-from-checkboxes)))
  1826. :group 'org-todo
  1827. :type 'boolean)
  1828. (defcustom org-treat-insert-todo-heading-as-state-change nil
  1829. "Non-nil means inserting a TODO heading is treated as state change.
  1830. So when the command \\[org-insert-todo-heading] is used, state change
  1831. logging will apply if appropriate. When nil, the new TODO item will
  1832. be inserted directly, and no logging will take place."
  1833. :group 'org-todo
  1834. :type 'boolean)
  1835. (defcustom org-treat-S-cursor-todo-selection-as-state-change t
  1836. "Non-nil means switching TODO states with S-cursor counts as state change.
  1837. This is the default behavior. However, setting this to nil allows a
  1838. convenient way to select a TODO state and bypass any logging associated
  1839. with that."
  1840. :group 'org-todo
  1841. :type 'boolean)
  1842. (defcustom org-todo-state-tags-triggers nil
  1843. "Tag changes that should be triggered by TODO state changes.
  1844. This is a list. Each entry is
  1845. (state-change (tag . flag) .......)
  1846. State-change can be a string with a state, and empty string to indicate the
  1847. state that has no TODO keyword, or it can be one of the symbols `todo'
  1848. or `done', meaning any not-done or done state, respectively."
  1849. :group 'org-todo
  1850. :group 'org-tags
  1851. :type '(repeat
  1852. (cons (choice :tag "When changing to"
  1853. (const :tag "Not-done state" todo)
  1854. (const :tag "Done state" done)
  1855. (string :tag "State"))
  1856. (repeat
  1857. (cons :tag "Tag action"
  1858. (string :tag "Tag")
  1859. (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
  1860. (defcustom org-log-done nil
  1861. "Information to record when a task moves to the DONE state.
  1862. Possible values are:
  1863. nil Don't add anything, just change the keyword
  1864. time Add a time stamp to the task
  1865. note Prompt for a note and add it with template `org-log-note-headings'
  1866. This option can also be set with on a per-file-basis with
  1867. #+STARTUP: nologdone
  1868. #+STARTUP: logdone
  1869. #+STARTUP: lognotedone
  1870. You can have local logging settings for a subtree by setting the LOGGING
  1871. property to one or more of these keywords."
  1872. :group 'org-todo
  1873. :group 'org-progress
  1874. :type '(choice
  1875. (const :tag "No logging" nil)
  1876. (const :tag "Record CLOSED timestamp" time)
  1877. (const :tag "Record CLOSED timestamp with note." note)))
  1878. ;; Normalize old uses of org-log-done.
  1879. (cond
  1880. ((eq org-log-done t) (setq org-log-done 'time))
  1881. ((and (listp org-log-done) (memq 'done org-log-done))
  1882. (setq org-log-done 'note)))
  1883. (defcustom org-log-reschedule nil
  1884. "Information to record when the scheduling date of a tasks is modified.
  1885. Possible values are:
  1886. nil Don't add anything, just change the date
  1887. time Add a time stamp to the task
  1888. note Prompt for a note and add it with template `org-log-note-headings'
  1889. This option can also be set with on a per-file-basis with
  1890. #+STARTUP: nologreschedule
  1891. #+STARTUP: logreschedule
  1892. #+STARTUP: lognotereschedule"
  1893. :group 'org-todo
  1894. :group 'org-progress
  1895. :type '(choice
  1896. (const :tag "No logging" nil)
  1897. (const :tag "Record timestamp" time)
  1898. (const :tag "Record timestamp with note." note)))
  1899. (defcustom org-log-redeadline nil
  1900. "Information to record when the deadline date of a tasks is modified.
  1901. Possible values are:
  1902. nil Don't add anything, just change the date
  1903. time Add a time stamp to the task
  1904. note Prompt for a note and add it with template `org-log-note-headings'
  1905. This option can also be set with on a per-file-basis with
  1906. #+STARTUP: nologredeadline
  1907. #+STARTUP: logredeadline
  1908. #+STARTUP: lognoteredeadline
  1909. You can have local logging settings for a subtree by setting the LOGGING
  1910. property to one or more of these keywords."
  1911. :group 'org-todo
  1912. :group 'org-progress
  1913. :type '(choice
  1914. (const :tag "No logging" nil)
  1915. (const :tag "Record timestamp" time)
  1916. (const :tag "Record timestamp with note." note)))
  1917. (defcustom org-log-note-clock-out nil
  1918. "Non-nil means record a note when clocking out of an item.
  1919. This can also be configured on a per-file basis by adding one of
  1920. the following lines anywhere in the buffer:
  1921. #+STARTUP: lognoteclock-out
  1922. #+STARTUP: nolognoteclock-out"
  1923. :group 'org-todo
  1924. :group 'org-progress
  1925. :type 'boolean)
  1926. (defcustom org-log-done-with-time t
  1927. "Non-nil means the CLOSED time stamp will contain date and time.
  1928. When nil, only the date will be recorded."
  1929. :group 'org-progress
  1930. :type 'boolean)
  1931. (defcustom org-log-note-headings
  1932. '((done . "CLOSING NOTE %t")
  1933. (state . "State %-12s from %-12S %t")
  1934. (note . "Note taken on %t")
  1935. (reschedule . "Rescheduled from %S on %t")
  1936. (delschedule . "Not scheduled, was %S on %t")
  1937. (redeadline . "New deadline from %S on %t")
  1938. (deldeadline . "Removed deadline, was %S on %t")
  1939. (refile . "Refiled on %t")
  1940. (clock-out . ""))
  1941. "Headings for notes added to entries.
  1942. The value is an alist, with the car being a symbol indicating the note
  1943. context, and the cdr is the heading to be used. The heading may also be the
  1944. empty string.
  1945. %t in the heading will be replaced by a time stamp.
  1946. %T will be an acive time stamp instead the default inacive one
  1947. %s will be replaced by the new TODO state, in double quotes.
  1948. %S will be replaced by the old TODO state, in double quotes.
  1949. %u will be replaced by the user name.
  1950. %U will be replaced by the full user name.
  1951. In fact, it is not a good idea to change the `state' entry, because
  1952. agenda log mode depends on the format of these entries."
  1953. :group 'org-todo
  1954. :group 'org-progress
  1955. :type '(list :greedy t
  1956. (cons (const :tag "Heading when closing an item" done) string)
  1957. (cons (const :tag
  1958. "Heading when changing todo state (todo sequence only)"
  1959. state) string)
  1960. (cons (const :tag "Heading when just taking a note" note) string)
  1961. (cons (const :tag "Heading when clocking out" clock-out) string)
  1962. (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
  1963. (cons (const :tag "Heading when rescheduling" reschedule) string)
  1964. (cons (const :tag "Heading when changing deadline" redeadline) string)
  1965. (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
  1966. (cons (const :tag "Heading when refiling" refile) string)))
  1967. (unless (assq 'note org-log-note-headings)
  1968. (push '(note . "%t") org-log-note-headings))
  1969. (defcustom org-log-into-drawer nil
  1970. "Non-nil means insert state change notes and time stamps into a drawer.
  1971. When nil, state changes notes will be inserted after the headline and
  1972. any scheduling and clock lines, but not inside a drawer.
  1973. The value of this variable should be the name of the drawer to use.
  1974. LOGBOOK is proposed at the default drawer for this purpose, you can
  1975. also set this to a string to define the drawer of your choice.
  1976. A value of t is also allowed, representing \"LOGBOOK\".
  1977. If this variable is set, `org-log-state-notes-insert-after-drawers'
  1978. will be ignored.
  1979. You can set the property LOG_INTO_DRAWER to overrule this setting for
  1980. a subtree."
  1981. :group 'org-todo
  1982. :group 'org-progress
  1983. :type '(choice
  1984. (const :tag "Not into a drawer" nil)
  1985. (const :tag "LOGBOOK" t)
  1986. (string :tag "Other")))
  1987. (if (fboundp 'defvaralias)
  1988. (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer))
  1989. (defun org-log-into-drawer ()
  1990. "Return the value of `org-log-into-drawer', but let properties overrule.
  1991. If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
  1992. used instead of the default value."
  1993. (let ((p (ignore-errors (org-entry-get nil "LOG_INTO_DRAWER" 'inherit))))
  1994. (cond
  1995. ((or (not p) (equal p "nil")) org-log-into-drawer)
  1996. ((equal p "t") "LOGBOOK")
  1997. (t p))))
  1998. (defcustom org-log-state-notes-insert-after-drawers nil
  1999. "Non-nil means insert state change notes after any drawers in entry.
  2000. Only the drawers that *immediately* follow the headline and the
  2001. deadline/scheduled line are skipped.
  2002. When nil, insert notes right after the heading and perhaps the line
  2003. with deadline/scheduling if present.
  2004. This variable will have no effect if `org-log-into-drawer' is
  2005. set."
  2006. :group 'org-todo
  2007. :group 'org-progress
  2008. :type 'boolean)
  2009. (defcustom org-log-states-order-reversed t
  2010. "Non-nil means the latest state note will be directly after heading.
  2011. When nil, the state change notes will be ordered according to time."
  2012. :group 'org-todo
  2013. :group 'org-progress
  2014. :type 'boolean)
  2015. (defcustom org-todo-repeat-to-state nil
  2016. "The TODO state to which a repeater should return the repeating task.
  2017. By default this is the first task in a TODO sequence, or the previous state
  2018. in a TODO_TYP set. But you can specify another task here.
  2019. alternatively, set the :REPEAT_TO_STATE: property of the entry."
  2020. :group 'org-todo
  2021. :type '(choice (const :tag "Head of sequence" nil)
  2022. (string :tag "Specific state")))
  2023. (defcustom org-log-repeat 'time
  2024. "Non-nil means record moving through the DONE state when triggering repeat.
  2025. An auto-repeating task is immediately switched back to TODO when
  2026. marked DONE. If you are not logging state changes (by adding \"@\"
  2027. or \"!\" to the TODO keyword definition), or set `org-log-done' to
  2028. record a closing note, there will be no record of the task moving
  2029. through DONE. This variable forces taking a note anyway.
  2030. nil Don't force a record
  2031. time Record a time stamp
  2032. note Record a note
  2033. This option can also be set with on a per-file-basis with
  2034. #+STARTUP: logrepeat
  2035. #+STARTUP: lognoterepeat
  2036. #+STARTUP: nologrepeat
  2037. You can have local logging settings for a subtree by setting the LOGGING
  2038. property to one or more of these keywords."
  2039. :group 'org-todo
  2040. :group 'org-progress
  2041. :type '(choice
  2042. (const :tag "Don't force a record" nil)
  2043. (const :tag "Force recording the DONE state" time)
  2044. (const :tag "Force recording a note with the DONE state" note)))
  2045. (defgroup org-priorities nil
  2046. "Priorities in Org-mode."
  2047. :tag "Org Priorities"
  2048. :group 'org-todo)
  2049. (defcustom org-enable-priority-commands t
  2050. "Non-nil means priority commands are active.
  2051. When nil, these commands will be disabled, so that you never accidentally
  2052. set a priority."
  2053. :group 'org-priorities
  2054. :type 'boolean)
  2055. (defcustom org-highest-priority ?A
  2056. "The highest priority of TODO items. A character like ?A, ?B etc.
  2057. Must have a smaller ASCII number than `org-lowest-priority'."
  2058. :group 'org-priorities
  2059. :type 'character)
  2060. (defcustom org-lowest-priority ?C
  2061. "The lowest priority of TODO items. A character like ?A, ?B etc.
  2062. Must have a larger ASCII number than `org-highest-priority'."
  2063. :group 'org-priorities
  2064. :type 'character)
  2065. (defcustom org-default-priority ?B
  2066. "The default priority of TODO items.
  2067. This is the priority an item get if no explicit priority is given."
  2068. :group 'org-priorities
  2069. :type 'character)
  2070. (defcustom org-priority-start-cycle-with-default t
  2071. "Non-nil means start with default priority when starting to cycle.
  2072. When this is nil, the first step in the cycle will be (depending on the
  2073. command used) one higher or lower that the default priority."
  2074. :group 'org-priorities
  2075. :type 'boolean)
  2076. (defgroup org-time nil
  2077. "Options concerning time stamps and deadlines in Org-mode."
  2078. :tag "Org Time"
  2079. :group 'org)
  2080. (defcustom org-insert-labeled-timestamps-at-point nil
  2081. "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
  2082. When nil, these labeled time stamps are forces into the second line of an
  2083. entry, just after the headline. When scheduling from the global TODO list,
  2084. the time stamp will always be forced into the second line."
  2085. :group 'org-time
  2086. :type 'boolean)
  2087. (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
  2088. "Formats for `format-time-string' which are used for time stamps.
  2089. It is not recommended to change this constant.")
  2090. (defcustom org-time-stamp-rounding-minutes '(0 5)
  2091. "Number of minutes to round time stamps to.
  2092. These are two values, the first applies when first creating a time stamp.
  2093. The second applies when changing it with the commands `S-up' and `S-down'.
  2094. When changing the time stamp, this means that it will change in steps
  2095. of N minutes, as given by the second value.
  2096. When a setting is 0 or 1, insert the time unmodified. Useful rounding
  2097. numbers should be factors of 60, so for example 5, 10, 15.
  2098. When this is larger than 1, you can still force an exact time-stamp by using
  2099. a double prefix argument to a time-stamp command like `C-c .' or `C-c !',
  2100. and by using a prefix arg to `S-up/down' to specify the exact number
  2101. of minutes to shift."
  2102. :group 'org-time
  2103. :get '(lambda (var) ; Make sure both elements are there
  2104. (if (integerp (default-value var))
  2105. (list (default-value var) 5)
  2106. (default-value var)))
  2107. :type '(list
  2108. (integer :tag "when inserting times")
  2109. (integer :tag "when modifying times")))
  2110. ;; Normalize old customizations of this variable.
  2111. (when (integerp org-time-stamp-rounding-minutes)
  2112. (setq org-time-stamp-rounding-minutes
  2113. (list org-time-stamp-rounding-minutes
  2114. org-time-stamp-rounding-minutes)))
  2115. (defcustom org-display-custom-times nil
  2116. "Non-nil means overlay custom formats over all time stamps.
  2117. The formats are defined through the variable `org-time-stamp-custom-formats'.
  2118. To turn this on on a per-file basis, insert anywhere in the file:
  2119. #+STARTUP: customtime"
  2120. :group 'org-time
  2121. :set 'set-default
  2122. :type 'sexp)
  2123. (make-variable-buffer-local 'org-display-custom-times)
  2124. (defcustom org-time-stamp-custom-formats
  2125. '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
  2126. "Custom formats for time stamps. See `format-time-string' for the syntax.
  2127. These are overlayed over the default ISO format if the variable
  2128. `org-display-custom-times' is set. Time like %H:%M should be at the
  2129. end of the second format. The custom formats are also honored by export
  2130. commands, if custom time display is turned on at the time of export."
  2131. :group 'org-time
  2132. :type 'sexp)
  2133. (defun org-time-stamp-format (&optional long inactive)
  2134. "Get the right format for a time string."
  2135. (let ((f (if long (cdr org-time-stamp-formats)
  2136. (car org-time-stamp-formats))))
  2137. (if inactive
  2138. (concat "[" (substring f 1 -1) "]")
  2139. f)))
  2140. (defcustom org-time-clocksum-format "%d:%02d"
  2141. "The format string used when creating CLOCKSUM lines, or when
  2142. org-mode generates a time duration."
  2143. :group 'org-time
  2144. :type 'string)
  2145. (defcustom org-time-clocksum-use-fractional nil
  2146. "If non-nil, \\[org-clock-display] uses fractional times.
  2147. org-mode generates a time duration."
  2148. :group 'org-time
  2149. :type 'boolean)
  2150. (defcustom org-time-clocksum-fractional-format "%.2f"
  2151. "The format string used when creating CLOCKSUM lines, or when
  2152. org-mode generates a time duration."
  2153. :group 'org-time
  2154. :type 'string)
  2155. (defcustom org-deadline-warning-days 14
  2156. "No. of days before expiration during which a deadline becomes active.
  2157. This variable governs the display in sparse trees and in the agenda.
  2158. When 0 or negative, it means use this number (the absolute value of it)
  2159. even if a deadline has a different individual lead time specified.
  2160. Custom commands can set this variable in the options section."
  2161. :group 'org-time
  2162. :group 'org-agenda-daily/weekly
  2163. :type 'integer)
  2164. (defcustom org-read-date-prefer-future t
  2165. "Non-nil means assume future for incomplete date input from user.
  2166. This affects the following situations:
  2167. 1. The user gives a month but not a year.
  2168. For example, if it is april and you enter \"feb 2\", this will be read
  2169. as feb 2, *next* year. \"May 5\", however, will be this year.
  2170. 2. The user gives a day, but no month.
  2171. For example, if today is the 15th, and you enter \"3\", Org-mode will
  2172. read this as the third of *next* month. However, if you enter \"17\",
  2173. it will be considered as *this* month.
  2174. If you set this variable to the symbol `time', then also the following
  2175. will work:
  2176. 3. If the user gives a time, but no day. If the time is before now,
  2177. to will be interpreted as tomorrow.
  2178. Currently none of this works for ISO week specifications.
  2179. When this option is nil, the current day, month and year will always be
  2180. used as defaults."
  2181. :group 'org-time
  2182. :type '(choice
  2183. (const :tag "Never" nil)
  2184. (const :tag "Check month and day" t)
  2185. (const :tag "Check month, day, and time" time)))
  2186. (defcustom org-read-date-display-live t
  2187. "Non-nil means display current interpretation of date prompt live.
  2188. This display will be in an overlay, in the minibuffer."
  2189. :group 'org-time
  2190. :type 'boolean)
  2191. (defcustom org-read-date-popup-calendar t
  2192. "Non-nil means pop up a calendar when prompting for a date.
  2193. In the calendar, the date can be selected with mouse-1. However, the
  2194. minibuffer will also be active, and you can simply enter the date as well.
  2195. When nil, only the minibuffer will be available."
  2196. :group 'org-time
  2197. :type 'boolean)
  2198. (if (fboundp 'defvaralias)
  2199. (defvaralias 'org-popup-calendar-for-date-prompt
  2200. 'org-read-date-popup-calendar))
  2201. (defcustom org-read-date-minibuffer-setup-hook nil
  2202. "Hook to be used to set up keys for the date/time interface.
  2203. Add key definitions to `minibuffer-local-map', which will be a temporary
  2204. copy."
  2205. :group 'org-time
  2206. :type 'hook)
  2207. (defcustom org-extend-today-until 0
  2208. "The hour when your day really ends. Must be an integer.
  2209. This has influence for the following applications:
  2210. - When switching the agenda to \"today\". It it is still earlier than
  2211. the time given here, the day recognized as TODAY is actually yesterday.
  2212. - When a date is read from the user and it is still before the time given
  2213. here, the current date and time will be assumed to be yesterday, 23:59.
  2214. Also, timestamps inserted in remember templates follow this rule.
  2215. IMPORTANT: This is a feature whose implementation is and likely will
  2216. remain incomplete. Really, it is only here because past midnight seems to
  2217. be the favorite working time of John Wiegley :-)"
  2218. :group 'org-time
  2219. :type 'integer)
  2220. (defcustom org-edit-timestamp-down-means-later nil
  2221. "Non-nil means S-down will increase the time in a time stamp.
  2222. When nil, S-up will increase."
  2223. :group 'org-time
  2224. :type 'boolean)
  2225. (defcustom org-calendar-follow-timestamp-change t
  2226. "Non-nil means make the calendar window follow timestamp changes.
  2227. When a timestamp is modified and the calendar window is visible, it will be
  2228. moved to the new date."
  2229. :group 'org-time
  2230. :type 'boolean)
  2231. (defgroup org-tags nil
  2232. "Options concerning tags in Org-mode."
  2233. :tag "Org Tags"
  2234. :group 'org)
  2235. (defcustom org-tag-alist nil
  2236. "List of tags allowed in Org-mode files.
  2237. When this list is nil, Org-mode will base TAG input on what is already in the
  2238. buffer.
  2239. The value of this variable is an alist, the car of each entry must be a
  2240. keyword as a string, the cdr may be a character that is used to select
  2241. that tag through the fast-tag-selection interface.
  2242. See the manual for details."
  2243. :group 'org-tags
  2244. :type '(repeat
  2245. (choice
  2246. (cons (string :tag "Tag name")
  2247. (character :tag "Access char"))
  2248. (list :tag "Start radio group"
  2249. (const :startgroup)
  2250. (option (string :tag "Group description")))
  2251. (list :tag "End radio group"
  2252. (const :endgroup)
  2253. (option (string :tag "Group description")))
  2254. (const :tag "New line" (:newline)))))
  2255. (defcustom org-tag-persistent-alist nil
  2256. "List of tags that will always appear in all Org-mode files.
  2257. This is in addition to any in buffer settings or customizations
  2258. of `org-tag-alist'.
  2259. When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
  2260. The value of this variable is an alist, the car of each entry must be a
  2261. keyword as a string, the cdr may be a character that is used to select
  2262. that tag through the fast-tag-selection interface.
  2263. See the manual for details.
  2264. To disable these tags on a per-file basis, insert anywhere in the file:
  2265. #+STARTUP: noptag"
  2266. :group 'org-tags
  2267. :type '(repeat
  2268. (choice
  2269. (cons (string :tag "Tag name")
  2270. (character :tag "Access char"))
  2271. (const :tag "Start radio group" (:startgroup))
  2272. (const :tag "End radio group" (:endgroup))
  2273. (const :tag "New line" (:newline)))))
  2274. (defcustom org-complete-tags-always-offer-all-agenda-tags nil
  2275. "If non-nil, always offer completion for all tags of all agenda files.
  2276. Instead of customizing this variable directly, you might want to
  2277. set it locally for remember buffers, because there no list of
  2278. tags in that file can be created dynamically (there are none).
  2279. (add-hook 'org-remember-mode-hook
  2280. (lambda ()
  2281. (set (make-local-variable
  2282. 'org-complete-tags-always-offer-all-agenda-tags)
  2283. t)))"
  2284. :group 'org-tags
  2285. :type 'boolean)
  2286. (defvar org-file-tags nil
  2287. "List of tags that can be inherited by all entries in the file.
  2288. The tags will be inherited if the variable `org-use-tag-inheritance'
  2289. says they should be.
  2290. This variable is populated from #+FILETAGS lines.")
  2291. (defcustom org-use-fast-tag-selection 'auto
  2292. "Non-nil means use fast tag selection scheme.
  2293. This is a special interface to select and deselect tags with single keys.
  2294. When nil, fast selection is never used.
  2295. When the symbol `auto', fast selection is used if and only if selection
  2296. characters for tags have been configured, either through the variable
  2297. `org-tag-alist' or through a #+TAGS line in the buffer.
  2298. When t, fast selection is always used and selection keys are assigned
  2299. automatically if necessary."
  2300. :group 'org-tags
  2301. :type '(choice
  2302. (const :tag "Always" t)
  2303. (const :tag "Never" nil)
  2304. (const :tag "When selection characters are configured" 'auto)))
  2305. (defcustom org-fast-tag-selection-single-key nil
  2306. "Non-nil means fast tag selection exits after first change.
  2307. When nil, you have to press RET to exit it.
  2308. During fast tag selection, you can toggle this flag with `C-c'.
  2309. This variable can also have the value `expert'. In this case, the window
  2310. displaying the tags menu is not even shown, until you press C-c again."
  2311. :group 'org-tags
  2312. :type '(choice
  2313. (const :tag "No" nil)
  2314. (const :tag "Yes" t)
  2315. (const :tag "Expert" expert)))
  2316. (defvar org-fast-tag-selection-include-todo nil
  2317. "Non-nil means fast tags selection interface will also offer TODO states.
  2318. This is an undocumented feature, you should not rely on it.")
  2319. (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
  2320. "The column to which tags should be indented in a headline.
  2321. If this number is positive, it specifies the column. If it is negative,
  2322. it means that the tags should be flushright to that column. For example,
  2323. -80 works well for a normal 80 character screen."
  2324. :group 'org-tags
  2325. :type 'integer)
  2326. (defcustom org-auto-align-tags t
  2327. "Non-nil means realign tags after pro/demotion of TODO state change.
  2328. These operations change the length of a headline and therefore shift
  2329. the tags around. With this options turned on, after each such operation
  2330. the tags are again aligned to `org-tags-column'."
  2331. :group 'org-tags
  2332. :type 'boolean)
  2333. (defcustom org-use-tag-inheritance t
  2334. "Non-nil means tags in levels apply also for sublevels.
  2335. When nil, only the tags directly given in a specific line apply there.
  2336. This may also be a list of tags that should be inherited, or a regexp that
  2337. matches tags that should be inherited. Additional control is possible
  2338. with the variable `org-tags-exclude-from-inheritance' which gives an
  2339. explicit list of tags to be excluded from inheritance., even if the value of
  2340. `org-use-tag-inheritance' would select it for inheritance.
  2341. If this option is t, a match early-on in a tree can lead to a large
  2342. number of matches in the subtree when constructing the agenda or creating
  2343. a sparse tree. If you only want to see the first match in a tree during
  2344. a search, check out the variable `org-tags-match-list-sublevels'."
  2345. :group 'org-tags
  2346. :type '(choice
  2347. (const :tag "Not" nil)
  2348. (const :tag "Always" t)
  2349. (repeat :tag "Specific tags" (string :tag "Tag"))
  2350. (regexp :tag "Tags matched by regexp")))
  2351. (defcustom org-tags-exclude-from-inheritance nil
  2352. "List of tags that should never be inherited.
  2353. This is a way to exclude a few tags from inheritance. For way to do
  2354. the opposite, to actively allow inheritance for selected tags,
  2355. see the variable `org-use-tag-inheritance'."
  2356. :group 'org-tags
  2357. :type '(repeat (string :tag "Tag")))
  2358. (defun org-tag-inherit-p (tag)
  2359. "Check if TAG is one that should be inherited."
  2360. (cond
  2361. ((member tag org-tags-exclude-from-inheritance) nil)
  2362. ((eq org-use-tag-inheritance t) t)
  2363. ((not org-use-tag-inheritance) nil)
  2364. ((stringp org-use-tag-inheritance)
  2365. (string-match org-use-tag-inheritance tag))
  2366. ((listp org-use-tag-inheritance)
  2367. (member tag org-use-tag-inheritance))
  2368. (t (error "Invalid setting of `org-use-tag-inheritance'"))))
  2369. (defcustom org-tags-match-list-sublevels t
  2370. "Non-nil means list also sublevels of headlines matching a search.
  2371. This variable applies to tags/property searches, and also to stuck
  2372. projects because this search is based on a tags match as well.
  2373. When set to the symbol `indented', sublevels are indented with
  2374. leading dots.
  2375. Because of tag inheritance (see variable `org-use-tag-inheritance'),
  2376. the sublevels of a headline matching a tag search often also match
  2377. the same search. Listing all of them can create very long lists.
  2378. Setting this variable to nil causes subtrees of a match to be skipped.
  2379. This variable is semi-obsolete and probably should always be true. It
  2380. is better to limit inheritance to certain tags using the variables
  2381. `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
  2382. :group 'org-tags
  2383. :type '(choice
  2384. (const :tag "No, don't list them" nil)
  2385. (const :tag "Yes, do list them" t)
  2386. (const :tag "List them, indented with leading dots" indented)))
  2387. (defcustom org-tags-sort-function nil
  2388. "When set, tags are sorted using this function as a comparator"
  2389. :group 'org-tags
  2390. :type '(choice
  2391. (const :tag "No sorting" nil)
  2392. (const :tag "Alphabetical" string<)
  2393. (const :tag "Reverse alphabetical" string>)
  2394. (function :tag "Custom function" nil)))
  2395. (defvar org-tags-history nil
  2396. "History of minibuffer reads for tags.")
  2397. (defvar org-last-tags-completion-table nil
  2398. "The last used completion table for tags.")
  2399. (defvar org-after-tags-change-hook nil
  2400. "Hook that is run after the tags in a line have changed.")
  2401. (defgroup org-properties nil
  2402. "Options concerning properties in Org-mode."
  2403. :tag "Org Properties"
  2404. :group 'org)
  2405. (defcustom org-property-format "%-10s %s"
  2406. "How property key/value pairs should be formatted by `indent-line'.
  2407. When `indent-line' hits a property definition, it will format the line
  2408. according to this format, mainly to make sure that the values are
  2409. lined-up with respect to each other."
  2410. :group 'org-properties
  2411. :type 'string)
  2412. (defcustom org-use-property-inheritance nil
  2413. "Non-nil means properties apply also for sublevels.
  2414. This setting is chiefly used during property searches. Turning it on can
  2415. cause significant overhead when doing a search, which is why it is not
  2416. on by default.
  2417. When nil, only the properties directly given in the current entry count.
  2418. When t, every property is inherited. The value may also be a list of
  2419. properties that should have inheritance, or a regular expression matching
  2420. properties that should be inherited.
  2421. However, note that some special properties use inheritance under special
  2422. circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
  2423. and the properties ending in \"_ALL\" when they are used as descriptor
  2424. for valid values of a property.
  2425. Note for programmers:
  2426. When querying an entry with `org-entry-get', you can control if inheritance
  2427. should be used. By default, `org-entry-get' looks only at the local
  2428. properties. You can request inheritance by setting the inherit argument
  2429. to t (to force inheritance) or to `selective' (to respect the setting
  2430. in this variable)."
  2431. :group 'org-properties
  2432. :type '(choice
  2433. (const :tag "Not" nil)
  2434. (const :tag "Always" t)
  2435. (repeat :tag "Specific properties" (string :tag "Property"))
  2436. (regexp :tag "Properties matched by regexp")))
  2437. (defun org-property-inherit-p (property)
  2438. "Check if PROPERTY is one that should be inherited."
  2439. (cond
  2440. ((eq org-use-property-inheritance t) t)
  2441. ((not org-use-property-inheritance) nil)
  2442. ((stringp org-use-property-inheritance)
  2443. (string-match org-use-property-inheritance property))
  2444. ((listp org-use-property-inheritance)
  2445. (member property org-use-property-inheritance))
  2446. (t (error "Invalid setting of `org-use-property-inheritance'"))))
  2447. (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
  2448. "The default column format, if no other format has been defined.
  2449. This variable can be set on the per-file basis by inserting a line
  2450. #+COLUMNS: %25ITEM ....."
  2451. :group 'org-properties
  2452. :type 'string)
  2453. (defcustom org-columns-ellipses ".."
  2454. "The ellipses to be used when a field in column view is truncated.
  2455. When this is the empty string, as many characters as possible are shown,
  2456. but then there will be no visual indication that the field has been truncated.
  2457. When this is a string of length N, the last N characters of a truncated
  2458. field are replaced by this string. If the column is narrower than the
  2459. ellipses string, only part of the ellipses string will be shown."
  2460. :group 'org-properties
  2461. :type 'string)
  2462. (defcustom org-columns-modify-value-for-display-function nil
  2463. "Function that modifies values for display in column view.
  2464. For example, it can be used to cut out a certain part from a time stamp.
  2465. The function must take 2 arguments:
  2466. column-title The title of the column (*not* the property name)
  2467. value The value that should be modified.
  2468. The function should return the value that should be displayed,
  2469. or nil if the normal value should be used."
  2470. :group 'org-properties
  2471. :type 'function)
  2472. (defcustom org-effort-property "Effort"
  2473. "The property that is being used to keep track of effort estimates.
  2474. Effort estimates given in this property need to have the format H:MM."
  2475. :group 'org-properties
  2476. :group 'org-progress
  2477. :type '(string :tag "Property"))
  2478. (defconst org-global-properties-fixed
  2479. '(("VISIBILITY_ALL" . "folded children content all")
  2480. ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
  2481. "List of property/value pairs that can be inherited by any entry.
  2482. These are fixed values, for the preset properties. The user variable
  2483. that can be used to add to this list is `org-global-properties'.
  2484. The entries in this list are cons cells where the car is a property
  2485. name and cdr is a string with the value. If the value represents
  2486. multiple items like an \"_ALL\" property, separate the items by
  2487. spaces.")
  2488. (defcustom org-global-properties nil
  2489. "List of property/value pairs that can be inherited by any entry.
  2490. This list will be combined with the constant `org-global-properties-fixed'.
  2491. The entries in this list are cons cells where the car is a property
  2492. name and cdr is a string with the value.
  2493. You can set buffer-local values for the same purpose in the variable
  2494. `org-file-properties' this by adding lines like
  2495. #+PROPERTY: NAME VALUE"
  2496. :group 'org-properties
  2497. :type '(repeat
  2498. (cons (string :tag "Property")
  2499. (string :tag "Value"))))
  2500. (defvar org-file-properties nil
  2501. "List of property/value pairs that can be inherited by any entry.
  2502. Valid for the current buffer.
  2503. This variable is populated from #+PROPERTY lines.")
  2504. (make-variable-buffer-local 'org-file-properties)
  2505. (defgroup org-agenda nil
  2506. "Options concerning agenda views in Org-mode."
  2507. :tag "Org Agenda"
  2508. :group 'org)
  2509. (defvar org-category nil
  2510. "Variable used by org files to set a category for agenda display.
  2511. Such files should use a file variable to set it, for example
  2512. # -*- mode: org; org-category: \"ELisp\"
  2513. or contain a special line
  2514. #+CATEGORY: ELisp
  2515. If the file does not specify a category, then file's base name
  2516. is used instead.")
  2517. (make-variable-buffer-local 'org-category)
  2518. (put 'org-category 'safe-local-variable '(lambda (x) (or (symbolp x) (stringp x))))
  2519. (defcustom org-agenda-files nil
  2520. "The files to be used for agenda display.
  2521. Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
  2522. \\[org-remove-file]. You can also use customize to edit the list.
  2523. If an entry is a directory, all files in that directory that are matched by
  2524. `org-agenda-file-regexp' will be part of the file list.
  2525. If the value of the variable is not a list but a single file name, then
  2526. the list of agenda files is actually stored and maintained in that file, one
  2527. agenda file per line. In this file paths can be given relative to
  2528. `org-directory'. Tilde expansion and environment variable substitution
  2529. are also made."
  2530. :group 'org-agenda
  2531. :type '(choice
  2532. (repeat :tag "List of files and directories" file)
  2533. (file :tag "Store list in a file\n" :value "~/.agenda_files")))
  2534. (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
  2535. "Regular expression to match files for `org-agenda-files'.
  2536. If any element in the list in that variable contains a directory instead
  2537. of a normal file, all files in that directory that are matched by this
  2538. regular expression will be included."
  2539. :group 'org-agenda
  2540. :type 'regexp)
  2541. (defcustom org-agenda-text-search-extra-files nil
  2542. "List of extra files to be searched by text search commands.
  2543. These files will be search in addition to the agenda files by the
  2544. commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
  2545. Note that these files will only be searched for text search commands,
  2546. not for the other agenda views like todo lists, tag searches or the weekly
  2547. agenda. This variable is intended to list notes and possibly archive files
  2548. that should also be searched by these two commands.
  2549. In fact, if the first element in the list is the symbol `agenda-archives',
  2550. than all archive files of all agenda files will be added to the search
  2551. scope."
  2552. :group 'org-agenda
  2553. :type '(set :greedy t
  2554. (const :tag "Agenda Archives" agenda-archives)
  2555. (repeat :inline t (file))))
  2556. (if (fboundp 'defvaralias)
  2557. (defvaralias 'org-agenda-multi-occur-extra-files
  2558. 'org-agenda-text-search-extra-files))
  2559. (defcustom org-agenda-skip-unavailable-files nil
  2560. "Non-nil means to just skip non-reachable files in `org-agenda-files'.
  2561. A nil value means to remove them, after a query, from the list."
  2562. :group 'org-agenda
  2563. :type 'boolean)
  2564. (defcustom org-calendar-to-agenda-key [?c]
  2565. "The key to be installed in `calendar-mode-map' for switching to the agenda.
  2566. The command `org-calendar-goto-agenda' will be bound to this key. The
  2567. default is the character `c' because then `c' can be used to switch back and
  2568. forth between agenda and calendar."
  2569. :group 'org-agenda
  2570. :type 'sexp)
  2571. (defcustom org-calendar-agenda-action-key [?k]
  2572. "The key to be installed in `calendar-mode-map' for agenda-action.
  2573. The command `org-agenda-action' will be bound to this key. The
  2574. default is the character `k' because we use the same key in the agenda."
  2575. :group 'org-agenda
  2576. :type 'sexp)
  2577. (defcustom org-calendar-insert-diary-entry-key [?i]
  2578. "The key to be installed in `calendar-mode-map' for adding diary entries.
  2579. This option is irrelevant until `org-agenda-diary-file' has been configured
  2580. to point to an Org-mode file. When that is the case, the command
  2581. `org-agenda-diary-entry' will be bound to the key given here, by default
  2582. `i'. In the calendar, `i' normally adds entries to `diary-file'. So
  2583. if you want to continue doing this, you need to change this to a different
  2584. key."
  2585. :group 'org-agenda
  2586. :type 'sexp)
  2587. (defcustom org-agenda-diary-file 'diary-file
  2588. "File to which to add new entries with the `i' key in agenda and calendar.
  2589. When this is the symbol `diary-file', the functionality in the Emacs
  2590. calendar will be used to add entries to the `diary-file'. But when this
  2591. points to a file, `org-agenda-diary-entry' will be used instead."
  2592. :group 'org-agenda
  2593. :type '(choice
  2594. (const :tag "The standard Emacs diary file" diary-file)
  2595. (file :tag "Special Org file diary entries")))
  2596. (eval-after-load "calendar"
  2597. '(progn
  2598. (org-defkey calendar-mode-map org-calendar-to-agenda-key
  2599. 'org-calendar-goto-agenda)
  2600. (org-defkey calendar-mode-map org-calendar-agenda-action-key
  2601. 'org-agenda-action)
  2602. (add-hook 'calendar-mode-hook
  2603. (lambda ()
  2604. (unless (eq org-agenda-diary-file 'diary-file)
  2605. (define-key calendar-mode-map
  2606. org-calendar-insert-diary-entry-key
  2607. 'org-agenda-diary-entry))))))
  2608. (defgroup org-latex nil
  2609. "Options for embedding LaTeX code into Org-mode."
  2610. :tag "Org LaTeX"
  2611. :group 'org)
  2612. (defcustom org-format-latex-options
  2613. '(:foreground default :background default :scale 1.0
  2614. :html-foreground "Black" :html-background "Transparent" :html-scale 1.0
  2615. :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
  2616. "Options for creating images from LaTeX fragments.
  2617. This is a property list with the following properties:
  2618. :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
  2619. `default' means use the foreground of the default face.
  2620. :background the background color, or \"Transparent\".
  2621. `default' means use the background of the default face.
  2622. :scale a scaling factor for the size of the images.
  2623. :html-foreground, :html-background, :html-scale
  2624. the same numbers for HTML export.
  2625. :matchers a list indicating which matchers should be used to
  2626. find LaTeX fragments. Valid members of this list are:
  2627. \"begin\" find environments
  2628. \"$1\" find single characters surrounded by $.$
  2629. \"$\" find math expressions surrounded by $...$
  2630. \"$$\" find math expressions surrounded by $$....$$
  2631. \"\\(\" find math expressions surrounded by \\(...\\)
  2632. \"\\ [\" find math expressions surrounded by \\ [...\\]"
  2633. :group 'org-latex
  2634. :type 'plist)
  2635. (defcustom org-format-latex-signal-error t
  2636. "Non-nil means signal an error when image creation of LaTeX snippets fails.
  2637. When nil, just push out a message."
  2638. :group 'org-latex
  2639. :type 'boolean)
  2640. (defcustom org-format-latex-header "\\documentclass{article}
  2641. \\usepackage[usenames]{color}
  2642. \\usepackage{amsmath}
  2643. \\usepackage[mathscr]{eucal}
  2644. \\pagestyle{empty} % do not remove
  2645. \[PACKAGES]
  2646. \[DEFAULT-PACKAGES]
  2647. % The settings below are copied from fullpage.sty
  2648. \\setlength{\\textwidth}{\\paperwidth}
  2649. \\addtolength{\\textwidth}{-3cm}
  2650. \\setlength{\\oddsidemargin}{1.5cm}
  2651. \\addtolength{\\oddsidemargin}{-2.54cm}
  2652. \\setlength{\\evensidemargin}{\\oddsidemargin}
  2653. \\setlength{\\textheight}{\\paperheight}
  2654. \\addtolength{\\textheight}{-\\headheight}
  2655. \\addtolength{\\textheight}{-\\headsep}
  2656. \\addtolength{\\textheight}{-\\footskip}
  2657. \\addtolength{\\textheight}{-3cm}
  2658. \\setlength{\\topmargin}{1.5cm}
  2659. \\addtolength{\\topmargin}{-2.54cm}"
  2660. "The document header used for processing LaTeX fragments.
  2661. It is imperative that this header make sure that no page number
  2662. appears on the page. The package defined in the variables
  2663. `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
  2664. will either replace the placeholder \"[PACKAGES]\" in this header, or they
  2665. will be appended."
  2666. :group 'org-latex
  2667. :type 'string)
  2668. (defvar org-format-latex-header-extra nil)
  2669. (defun org-set-packages-alist (var val)
  2670. "Set the packages alist and make sure it has 3 elements per entry."
  2671. (set var (mapcar (lambda (x)
  2672. (if (and (consp x) (= (length x) 2))
  2673. (list (car x) (nth 1 x) t)
  2674. x))
  2675. val)))
  2676. (defun org-get-packages-alist (var)
  2677. "Get the packages alist and make sure it has 3 elements per entry."
  2678. (mapcar (lambda (x)
  2679. (if (and (consp x) (= (length x) 2))
  2680. (list (car x) (nth 1 x) t)
  2681. x))
  2682. (default-value var)))
  2683. ;; The following variables are defined here because is it also used
  2684. ;; when formatting latex fragments. Originally it was part of the
  2685. ;; LaTeX exporter, which is why the name includes "export".
  2686. (defcustom org-export-latex-default-packages-alist
  2687. '(("AUTO" "inputenc" t)
  2688. ("T1" "fontenc" t)
  2689. ("" "fixltx2e" nil)
  2690. ("" "graphicx" t)
  2691. ("" "longtable" nil)
  2692. ("" "float" nil)
  2693. ("" "wrapfig" nil)
  2694. ("" "soul" t)
  2695. ("" "t1enc" t)
  2696. ("" "textcomp" t)
  2697. ("" "marvosym" t)
  2698. ("" "wasysym" t)
  2699. ("" "latexsym" t)
  2700. ("" "amssymb" t)
  2701. ("" "hyperref" nil)
  2702. "\\tolerance=1000"
  2703. )
  2704. "Alist of default packages to be inserted in the header.
  2705. Change this only if one of the packages here causes an incompatibility
  2706. with another package you are using.
  2707. The packages in this list are needed by one part or another of Org-mode
  2708. to function properly.
  2709. - inputenc, fontenc, t1enc: for basic font and character selection
  2710. - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
  2711. for interpreting the entities in `org-entities'. You can skip some of these
  2712. packages if you don't use any of the symbols in it.
  2713. - graphicx: for including images
  2714. - float, wrapfig: for figure placement
  2715. - longtable: for long tables
  2716. - hyperref: for cross references
  2717. Therefore you should not modify this variable unless you know what you
  2718. are doing. The one reason to change it anyway is that you might be loading
  2719. some other package that conflicts with one of the default packages.
  2720. Each cell is of the format \( \"options\" \"package\" snippet-flag\).
  2721. If SNIPPET-FLAG is t, the package also needs to be included when
  2722. compiling LaTeX snippets into images for inclusion into HTML."
  2723. :group 'org-export-latex
  2724. :set 'org-set-packages-alist
  2725. :get 'org-get-packages-alist
  2726. :type '(repeat
  2727. (choice
  2728. (list :tag "options/package pair"
  2729. (string :tag "options")
  2730. (string :tag "package")
  2731. (boolean :tag "Snippet"))
  2732. (string :tag "A line of LaTeX"))))
  2733. (defcustom org-export-latex-packages-alist nil
  2734. "Alist of packages to be inserted in every LaTeX header.
  2735. These will be inserted after `org-export-latex-default-packages-alist'.
  2736. Each cell is of the format \( \"options\" \"package\" snippet-flag \).
  2737. SNIPPET-FLAG, when t, indicates that this package is also needed when
  2738. turning LaTeX snippets into images for inclusion into HTML.
  2739. Make sure that you only list packages here which:
  2740. - you want in every file
  2741. - do not conflict with the default packages in
  2742. `org-export-latex-default-packages-alist'
  2743. - do not conflict with the setup in `org-format-latex-header'."
  2744. :group 'org-export-latex
  2745. :set 'org-set-packages-alist
  2746. :get 'org-get-packages-alist
  2747. :type '(repeat
  2748. (choice
  2749. (list :tag "options/package pair"
  2750. (string :tag "options")
  2751. (string :tag "package")
  2752. (boolean :tag "Snippet"))
  2753. (string :tag "A line of LaTeX"))))
  2754. (defgroup org-appearance nil
  2755. "Settings for Org-mode appearance."
  2756. :tag "Org Appearance"
  2757. :group 'org)
  2758. (defcustom org-level-color-stars-only nil
  2759. "Non-nil means fontify only the stars in each headline.
  2760. When nil, the entire headline is fontified.
  2761. Changing it requires restart of `font-lock-mode' to become effective
  2762. also in regions already fontified."
  2763. :group 'org-appearance
  2764. :type 'boolean)
  2765. (defcustom org-hide-leading-stars nil
  2766. "Non-nil means hide the first N-1 stars in a headline.
  2767. This works by using the face `org-hide' for these stars. This
  2768. face is white for a light background, and black for a dark
  2769. background. You may have to customize the face `org-hide' to
  2770. make this work.
  2771. Changing it requires restart of `font-lock-mode' to become effective
  2772. also in regions already fontified.
  2773. You may also set this on a per-file basis by adding one of the following
  2774. lines to the buffer:
  2775. #+STARTUP: hidestars
  2776. #+STARTUP: showstars"
  2777. :group 'org-appearance
  2778. :type 'boolean)
  2779. (defcustom org-hidden-keywords nil
  2780. "List of keywords that should be hidden when typed in the org buffer.
  2781. For example, add #+TITLE to this list in order to make the
  2782. document title appear in the buffer without the initial #+TITLE:
  2783. keyword."
  2784. :group 'org-appearance
  2785. :type '(set (const :tag "#+AUTHOR" author)
  2786. (const :tag "#+DATE" date)
  2787. (const :tag "#+EMAIL" email)
  2788. (const :tag "#+TITLE" title)))
  2789. (defcustom org-fontify-done-headline nil
  2790. "Non-nil means change the face of a headline if it is marked DONE.
  2791. Normally, only the TODO/DONE keyword indicates the state of a headline.
  2792. When this is non-nil, the headline after the keyword is set to the
  2793. `org-headline-done' as an additional indication."
  2794. :group 'org-appearance
  2795. :type 'boolean)
  2796. (defcustom org-fontify-emphasized-text t
  2797. "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
  2798. Changing this variable requires a restart of Emacs to take effect."
  2799. :group 'org-appearance
  2800. :type 'boolean)
  2801. (defcustom org-fontify-whole-heading-line nil
  2802. "Non-nil means fontify the whole line for headings.
  2803. This is useful when setting a background color for the
  2804. org-level-* faces."
  2805. :group 'org-appearance
  2806. :type 'boolean)
  2807. (defcustom org-highlight-latex-fragments-and-specials nil
  2808. "Non-nil means fontify what is treated specially by the exporters."
  2809. :group 'org-appearance
  2810. :type 'boolean)
  2811. (defcustom org-hide-emphasis-markers nil
  2812. "Non-nil mean font-lock should hide the emphasis marker characters."
  2813. :group 'org-appearance
  2814. :type 'boolean)
  2815. (defcustom org-pretty-entities nil
  2816. "Non-nil means show entities as UTF8 characters.
  2817. When nil, the \\name form remains in the buffer."
  2818. :group 'org-appearance
  2819. :type 'boolean)
  2820. (defcustom org-pretty-entities-include-sub-superscripts t
  2821. "Non-nil means, pretty entity display includes formatting sub/superscripts."
  2822. :group 'org-appearance
  2823. :type 'boolean)
  2824. (defvar org-emph-re nil
  2825. "Regular expression for matching emphasis.
  2826. After a match, the match groups contain these elements:
  2827. 1 The character before the proper match, or empty at beginning of line
  2828. 2 The proper match, including the leading and trailing markers
  2829. 3 The leading marker like * or /, indicating the type of highlighting
  2830. 4 The text between the emphasis markers, not including the markers
  2831. 5 The character after the match, empty at the end of a line")
  2832. (defvar org-verbatim-re nil
  2833. "Regular expression for matching verbatim text.")
  2834. (defvar org-emphasis-regexp-components) ; defined just below
  2835. (defvar org-emphasis-alist) ; defined just below
  2836. (defun org-set-emph-re (var val)
  2837. "Set variable and compute the emphasis regular expression."
  2838. (set var val)
  2839. (when (and (boundp 'org-emphasis-alist)
  2840. (boundp 'org-emphasis-regexp-components)
  2841. org-emphasis-alist org-emphasis-regexp-components)
  2842. (let* ((e org-emphasis-regexp-components)
  2843. (pre (car e))
  2844. (post (nth 1 e))
  2845. (border (nth 2 e))
  2846. (body (nth 3 e))
  2847. (nl (nth 4 e))
  2848. (body1 (concat body "*?"))
  2849. (markers (mapconcat 'car org-emphasis-alist ""))
  2850. (vmarkers (mapconcat
  2851. (lambda (x) (if (eq (nth 4 x) 'verbatim) (car x) ""))
  2852. org-emphasis-alist "")))
  2853. ;; make sure special characters appear at the right position in the class
  2854. (if (string-match "\\^" markers)
  2855. (setq markers (concat (replace-match "" t t markers) "^")))
  2856. (if (string-match "-" markers)
  2857. (setq markers (concat (replace-match "" t t markers) "-")))
  2858. (if (string-match "\\^" vmarkers)
  2859. (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
  2860. (if (string-match "-" vmarkers)
  2861. (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
  2862. (if (> nl 0)
  2863. (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
  2864. (int-to-string nl) "\\}")))
  2865. ;; Make the regexp
  2866. (setq org-emph-re
  2867. (concat "\\([" pre "]\\|^\\)"
  2868. "\\("
  2869. "\\([" markers "]\\)"
  2870. "\\("
  2871. "[^" border "]\\|"
  2872. "[^" border "]"
  2873. body1
  2874. "[^" border "]"
  2875. "\\)"
  2876. "\\3\\)"
  2877. "\\([" post "]\\|$\\)"))
  2878. (setq org-verbatim-re
  2879. (concat "\\([" pre "]\\|^\\)"
  2880. "\\("
  2881. "\\([" vmarkers "]\\)"
  2882. "\\("
  2883. "[^" border "]\\|"
  2884. "[^" border "]"
  2885. body1
  2886. "[^" border "]"
  2887. "\\)"
  2888. "\\3\\)"
  2889. "\\([" post "]\\|$\\)")))))
  2890. (defcustom org-emphasis-regexp-components
  2891. '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
  2892. "Components used to build the regular expression for emphasis.
  2893. This is a list with 6 entries. Terminology: In an emphasis string
  2894. like \" *strong word* \", we call the initial space PREMATCH, the final
  2895. space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
  2896. and \"trong wor\" is the body. The different components in this variable
  2897. specify what is allowed/forbidden in each part:
  2898. pre Chars allowed as prematch. Beginning of line will be allowed too.
  2899. post Chars allowed as postmatch. End of line will be allowed too.
  2900. border The chars *forbidden* as border characters.
  2901. body-regexp A regexp like \".\" to match a body character. Don't use
  2902. non-shy groups here, and don't allow newline here.
  2903. newline The maximum number of newlines allowed in an emphasis exp.
  2904. Use customize to modify this, or restart Emacs after changing it."
  2905. :group 'org-appearance
  2906. :set 'org-set-emph-re
  2907. :type '(list
  2908. (sexp :tag "Allowed chars in pre ")
  2909. (sexp :tag "Allowed chars in post ")
  2910. (sexp :tag "Forbidden chars in border ")
  2911. (sexp :tag "Regexp for body ")
  2912. (integer :tag "number of newlines allowed")
  2913. (option (boolean :tag "Please ignore this button"))))
  2914. (defcustom org-emphasis-alist
  2915. `(("*" bold "<b>" "</b>")
  2916. ("/" italic "<i>" "</i>")
  2917. ("_" underline "<span style=\"text-decoration:underline;\">" "</span>")
  2918. ("=" org-code "<code>" "</code>" verbatim)
  2919. ("~" org-verbatim "<code>" "</code>" verbatim)
  2920. ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))
  2921. "<del>" "</del>")
  2922. )
  2923. "Special syntax for emphasized text.
  2924. Text starting and ending with a special character will be emphasized, for
  2925. example *bold*, _underlined_ and /italic/. This variable sets the marker
  2926. characters, the face to be used by font-lock for highlighting in Org-mode
  2927. Emacs buffers, and the HTML tags to be used for this.
  2928. For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
  2929. For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
  2930. Use customize to modify this, or restart Emacs after changing it."
  2931. :group 'org-appearance
  2932. :set 'org-set-emph-re
  2933. :type '(repeat
  2934. (list
  2935. (string :tag "Marker character")
  2936. (choice
  2937. (face :tag "Font-lock-face")
  2938. (plist :tag "Face property list"))
  2939. (string :tag "HTML start tag")
  2940. (string :tag "HTML end tag")
  2941. (option (const verbatim)))))
  2942. (defvar org-protecting-blocks
  2943. '("src" "example" "latex" "ascii" "html" "docbook" "ditaa" "dot" "r" "R")
  2944. "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
  2945. This is needed for font-lock setup.")
  2946. ;;; Miscellaneous options
  2947. (defgroup org-completion nil
  2948. "Completion in Org-mode."
  2949. :tag "Org Completion"
  2950. :group 'org)
  2951. (defcustom org-completion-use-ido nil
  2952. "Non-nil means use ido completion wherever possible.
  2953. Note that `ido-mode' must be active for this variable to be relevant.
  2954. If you decide to turn this variable on, you might well want to turn off
  2955. `org-outline-path-complete-in-steps'.
  2956. See also `org-completion-use-iswitchb'."
  2957. :group 'org-completion
  2958. :type 'boolean)
  2959. (defcustom org-completion-use-iswitchb nil
  2960. "Non-nil means use iswitchb completion wherever possible.
  2961. Note that `iswitchb-mode' must be active for this variable to be relevant.
  2962. If you decide to turn this variable on, you might well want to turn off
  2963. `org-outline-path-complete-in-steps'.
  2964. Note that this variable has only an effect if `org-completion-use-ido' is nil."
  2965. :group 'org-completion
  2966. :type 'boolean)
  2967. (defcustom org-completion-fallback-command 'hippie-expand
  2968. "The expansion command called by \\[org-complete] in normal context.
  2969. Normal means no org-mode-specific context."
  2970. :group 'org-completion
  2971. :type 'function)
  2972. ;;; Functions and variables from their packages
  2973. ;; Declared here to avoid compiler warnings
  2974. ;; XEmacs only
  2975. (defvar outline-mode-menu-heading)
  2976. (defvar outline-mode-menu-show)
  2977. (defvar outline-mode-menu-hide)
  2978. (defvar zmacs-regions) ; XEmacs regions
  2979. ;; Emacs only
  2980. (defvar mark-active)
  2981. ;; Various packages
  2982. (declare-function calendar-absolute-from-iso "cal-iso" (date))
  2983. (declare-function calendar-forward-day "cal-move" (arg))
  2984. (declare-function calendar-goto-date "cal-move" (date))
  2985. (declare-function calendar-goto-today "cal-move" ())
  2986. (declare-function calendar-iso-from-absolute "cal-iso" (date))
  2987. (defvar calc-embedded-close-formula)
  2988. (defvar calc-embedded-open-formula)
  2989. (declare-function cdlatex-tab "ext:cdlatex" ())
  2990. (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
  2991. (defvar font-lock-unfontify-region-function)
  2992. (declare-function iswitchb-read-buffer "iswitchb"
  2993. (prompt &optional default require-match start matches-set))
  2994. (defvar iswitchb-temp-buflist)
  2995. (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
  2996. (defvar org-agenda-tags-todo-honor-ignore-options)
  2997. (declare-function org-agenda-skip "org-agenda" ())
  2998. (declare-function
  2999. org-format-agenda-item "org-agenda"
  3000. (extra txt &optional category tags dotime noprefix remove-re habitp))
  3001. (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
  3002. (declare-function org-agenda-change-all-lines "org-agenda"
  3003. (newhead hdmarker &optional fixface just-this))
  3004. (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
  3005. (declare-function org-agenda-maybe-redo "org-agenda" ())
  3006. (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
  3007. (beg end))
  3008. (declare-function org-agenda-copy-local-variable "org-agenda" (var))
  3009. (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
  3010. "org-agenda" (&optional end))
  3011. (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
  3012. (declare-function org-indent-mode "org-indent" (&optional arg))
  3013. (declare-function parse-time-string "parse-time" (string))
  3014. (declare-function org-attach-reveal "org-attach" (&optional if-exists))
  3015. (declare-function org-export-latex-fix-inputenc "org-latex" ())
  3016. (defvar remember-data-file)
  3017. (defvar texmathp-why)
  3018. (declare-function speedbar-line-directory "speedbar" (&optional depth))
  3019. (declare-function table--at-cell-p "table" (position &optional object at-column))
  3020. (defvar w3m-current-url)
  3021. (defvar w3m-current-title)
  3022. (defvar org-latex-regexps)
  3023. ;;; Autoload and prepare some org modules
  3024. ;; Some table stuff that needs to be defined here, because it is used
  3025. ;; by the functions setting up org-mode or checking for table context.
  3026. (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
  3027. "Detects an org-type or table-type table.")
  3028. (defconst org-table-line-regexp "^[ \t]*|"
  3029. "Detects an org-type table line.")
  3030. (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
  3031. "Detects an org-type table line.")
  3032. (defconst org-table-hline-regexp "^[ \t]*|-"
  3033. "Detects an org-type table hline.")
  3034. (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
  3035. "Detects a table-type table hline.")
  3036. (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
  3037. "Searching from within a table (any type) this finds the first line
  3038. outside the table.")
  3039. ;; Autoload the functions in org-table.el that are needed by functions here.
  3040. (eval-and-compile
  3041. (org-autoload "org-table"
  3042. '(org-table-align org-table-begin org-table-blank-field
  3043. org-table-convert org-table-convert-region org-table-copy-down
  3044. org-table-copy-region org-table-create
  3045. org-table-create-or-convert-from-region
  3046. org-table-create-with-table.el org-table-current-dline
  3047. org-table-cut-region org-table-delete-column org-table-edit-field
  3048. org-table-edit-formulas org-table-end org-table-eval-formula
  3049. org-table-export org-table-field-info
  3050. org-table-get-stored-formulas org-table-goto-column
  3051. org-table-hline-and-move org-table-import org-table-insert-column
  3052. org-table-insert-hline org-table-insert-row org-table-iterate
  3053. org-table-justify-field-maybe org-table-kill-row
  3054. org-table-maybe-eval-formula org-table-maybe-recalculate-line
  3055. org-table-move-column org-table-move-column-left
  3056. org-table-move-column-right org-table-move-row
  3057. org-table-move-row-down org-table-move-row-up
  3058. org-table-next-field org-table-next-row org-table-paste-rectangle
  3059. org-table-previous-field org-table-recalculate
  3060. org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
  3061. org-table-toggle-coordinate-overlays
  3062. org-table-toggle-formula-debugger org-table-wrap-region
  3063. orgtbl-mode turn-on-orgtbl org-table-to-lisp)))
  3064. (defun org-at-table-p (&optional table-type)
  3065. "Return t if the cursor is inside an org-type table.
  3066. If TABLE-TYPE is non-nil, also check for table.el-type tables."
  3067. (if org-enable-table-editor
  3068. (save-excursion
  3069. (beginning-of-line 1)
  3070. (looking-at (if table-type org-table-any-line-regexp
  3071. org-table-line-regexp)))
  3072. nil))
  3073. (defsubst org-table-p () (org-at-table-p))
  3074. (defun org-at-table.el-p ()
  3075. "Return t if and only if we are at a table.el table."
  3076. (and (org-at-table-p 'any)
  3077. (save-excursion
  3078. (goto-char (org-table-begin 'any))
  3079. (looking-at org-table1-hline-regexp))))
  3080. (defun org-table-recognize-table.el ()
  3081. "If there is a table.el table nearby, recognize it and move into it."
  3082. (if org-table-tab-recognizes-table.el
  3083. (if (org-at-table.el-p)
  3084. (progn
  3085. (beginning-of-line 1)
  3086. (if (looking-at org-table-dataline-regexp)
  3087. nil
  3088. (if (looking-at org-table1-hline-regexp)
  3089. (progn
  3090. (beginning-of-line 2)
  3091. (if (looking-at org-table-any-border-regexp)
  3092. (beginning-of-line -1)))))
  3093. (if (re-search-forward "|" (org-table-end t) t)
  3094. (progn
  3095. (require 'table)
  3096. (if (table--at-cell-p (point))
  3097. t
  3098. (message "recognizing table.el table...")
  3099. (table-recognize-table)
  3100. (message "recognizing table.el table...done")))
  3101. (error "This should not happen..."))
  3102. t)
  3103. nil)
  3104. nil))
  3105. (defun org-at-table-hline-p ()
  3106. "Return t if the cursor is inside a hline in a table."
  3107. (if org-enable-table-editor
  3108. (save-excursion
  3109. (beginning-of-line 1)
  3110. (looking-at org-table-hline-regexp))
  3111. nil))
  3112. (defvar org-table-clean-did-remove-column nil)
  3113. (defun org-table-map-tables (function &optional quietly)
  3114. "Apply FUNCTION to the start of all tables in the buffer."
  3115. (save-excursion
  3116. (save-restriction
  3117. (widen)
  3118. (goto-char (point-min))
  3119. (while (re-search-forward org-table-any-line-regexp nil t)
  3120. (unless quietly
  3121. (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
  3122. (beginning-of-line 1)
  3123. (when (looking-at org-table-line-regexp)
  3124. (save-excursion (funcall function))
  3125. (or (looking-at org-table-line-regexp)
  3126. (forward-char 1)))
  3127. (re-search-forward org-table-any-border-regexp nil 1))))
  3128. (unless quietly (message "Mapping tables: done")))
  3129. ;; Declare and autoload functions from org-exp.el & Co
  3130. (declare-function org-default-export-plist "org-exp")
  3131. (declare-function org-infile-export-plist "org-exp")
  3132. (declare-function org-get-current-options "org-exp")
  3133. (eval-and-compile
  3134. (org-autoload "org-exp"
  3135. '(org-export org-export-visible
  3136. org-insert-export-options-template
  3137. org-table-clean-before-export))
  3138. (org-autoload "org-ascii"
  3139. '(org-export-as-ascii org-export-ascii-preprocess
  3140. org-export-as-ascii-to-buffer org-replace-region-by-ascii
  3141. org-export-region-as-ascii))
  3142. (org-autoload "org-latex"
  3143. '(org-export-as-latex-batch org-export-as-latex-to-buffer
  3144. org-replace-region-by-latex org-export-region-as-latex
  3145. org-export-as-latex org-export-as-pdf
  3146. org-export-as-pdf-and-open))
  3147. (org-autoload "org-html"
  3148. '(org-export-as-html-and-open
  3149. org-export-as-html-batch org-export-as-html-to-buffer
  3150. org-replace-region-by-html org-export-region-as-html
  3151. org-export-as-html))
  3152. (org-autoload "org-docbook"
  3153. '(org-export-as-docbook-batch org-export-as-docbook-to-buffer
  3154. org-replace-region-by-docbook org-export-region-as-docbook
  3155. org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
  3156. org-export-as-docbook))
  3157. (org-autoload "org-icalendar"
  3158. '(org-export-icalendar-this-file
  3159. org-export-icalendar-all-agenda-files
  3160. org-export-icalendar-combine-agenda-files))
  3161. (org-autoload "org-xoxo" '(org-export-as-xoxo))
  3162. (org-autoload "org-beamer" '(org-beamer-mode org-beamer-sectioning)))
  3163. ;; Declare and autoload functions from org-agenda.el
  3164. (eval-and-compile
  3165. (org-autoload "org-agenda"
  3166. '(org-agenda org-agenda-list org-search-view
  3167. org-todo-list org-tags-view org-agenda-list-stuck-projects
  3168. org-diary org-agenda-to-appt
  3169. org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
  3170. ;; Autoload org-remember
  3171. (eval-and-compile
  3172. (org-autoload "org-remember"
  3173. '(org-remember-insinuate org-remember-annotation
  3174. org-remember-apply-template org-remember org-remember-handler)))
  3175. (eval-and-compile
  3176. (org-autoload "org-capture"
  3177. '(org-capture org-capture-insert-template-here
  3178. org-capture-import-remember-templates)))
  3179. ;; Autoload org-clock.el
  3180. (declare-function org-clock-save-markers-for-cut-and-paste "org-clock"
  3181. (beg end))
  3182. (declare-function org-clock-update-mode-line "org-clock" ())
  3183. (declare-function org-resolve-clocks "org-clock"
  3184. (&optional also-non-dangling-p prompt last-valid))
  3185. (defvar org-clock-start-time)
  3186. (defvar org-clock-marker (make-marker)
  3187. "Marker recording the last clock-in.")
  3188. (defvar org-clock-hd-marker (make-marker)
  3189. "Marker recording the last clock-in, but the headline position.")
  3190. (defvar org-clock-heading ""
  3191. "The heading of the current clock entry.")
  3192. (defun org-clock-is-active ()
  3193. "Return non-nil if clock is currently running.
  3194. The return value is actually the clock marker."
  3195. (marker-buffer org-clock-marker))
  3196. (eval-and-compile
  3197. (org-autoload
  3198. "org-clock"
  3199. '(org-clock-in org-clock-out org-clock-cancel
  3200. org-clock-goto org-clock-sum org-clock-display
  3201. org-clock-remove-overlays org-clock-report
  3202. org-clocktable-shift org-dblock-write:clocktable
  3203. org-get-clocktable org-resolve-clocks)))
  3204. (defun org-clock-update-time-maybe ()
  3205. "If this is a CLOCK line, update it and return t.
  3206. Otherwise, return nil."
  3207. (interactive)
  3208. (save-excursion
  3209. (beginning-of-line 1)
  3210. (skip-chars-forward " \t")
  3211. (when (looking-at org-clock-string)
  3212. (let ((re (concat "[ \t]*" org-clock-string
  3213. " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
  3214. "\\([ \t]*=>.*\\)?\\)?"))
  3215. ts te h m s neg)
  3216. (cond
  3217. ((not (looking-at re))
  3218. nil)
  3219. ((not (match-end 2))
  3220. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3221. (> org-clock-marker (point))
  3222. (<= org-clock-marker (point-at-eol)))
  3223. ;; The clock is running here
  3224. (setq org-clock-start-time
  3225. (apply 'encode-time
  3226. (org-parse-time-string (match-string 1))))
  3227. (org-clock-update-mode-line)))
  3228. (t
  3229. (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
  3230. (end-of-line 1)
  3231. (setq ts (match-string 1)
  3232. te (match-string 3))
  3233. (setq s (- (org-float-time
  3234. (apply 'encode-time (org-parse-time-string te)))
  3235. (org-float-time
  3236. (apply 'encode-time (org-parse-time-string ts))))
  3237. neg (< s 0)
  3238. s (abs s)
  3239. h (floor (/ s 3600))
  3240. s (- s (* 3600 h))
  3241. m (floor (/ s 60))
  3242. s (- s (* 60 s)))
  3243. (insert " => " (format (if neg "-%d:%02d" "%2d:%02d") h m))
  3244. t))))))
  3245. (defun org-check-running-clock ()
  3246. "Check if the current buffer contains the running clock.
  3247. If yes, offer to stop it and to save the buffer with the changes."
  3248. (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
  3249. (y-or-n-p (format "Clock-out in buffer %s before killing it? "
  3250. (buffer-name))))
  3251. (org-clock-out)
  3252. (when (y-or-n-p "Save changed buffer?")
  3253. (save-buffer))))
  3254. (defun org-clocktable-try-shift (dir n)
  3255. "Check if this line starts a clock table, if yes, shift the time block."
  3256. (when (org-match-line "#\\+BEGIN: clocktable\\>")
  3257. (org-clocktable-shift dir n)))
  3258. ;; Autoload org-timer.el
  3259. (eval-and-compile
  3260. (org-autoload
  3261. "org-timer"
  3262. '(org-timer-start org-timer org-timer-item
  3263. org-timer-change-times-in-region
  3264. org-timer-set-timer
  3265. org-timer-reset-timers
  3266. org-timer-show-remaining-time)))
  3267. ;; Autoload org-feed.el
  3268. (eval-and-compile
  3269. (org-autoload
  3270. "org-feed"
  3271. '(org-feed-update org-feed-update-all org-feed-goto-inbox)))
  3272. ;; Autoload org-indent.el
  3273. ;; Define the variable already here, to make sure we have it.
  3274. (defvar org-indent-mode nil
  3275. "Non-nil if Org-Indent mode is enabled.
  3276. Use the command `org-indent-mode' to change this variable.")
  3277. (eval-and-compile
  3278. (org-autoload
  3279. "org-indent"
  3280. '(org-indent-mode)))
  3281. ;; Autoload org-mobile.el
  3282. (eval-and-compile
  3283. (org-autoload
  3284. "org-mobile"
  3285. '(org-mobile-push org-mobile-pull org-mobile-create-sumo-agenda)))
  3286. ;; Autoload archiving code
  3287. ;; The stuff that is needed for cycling and tags has to be defined here.
  3288. (defgroup org-archive nil
  3289. "Options concerning archiving in Org-mode."
  3290. :tag "Org Archive"
  3291. :group 'org-structure)
  3292. (defcustom org-archive-location "%s_archive::"
  3293. "The location where subtrees should be archived.
  3294. The value of this variable is a string, consisting of two parts,
  3295. separated by a double-colon. The first part is a filename and
  3296. the second part is a headline.
  3297. When the filename is omitted, archiving happens in the same file.
  3298. %s in the filename will be replaced by the current file
  3299. name (without the directory part). Archiving to a different file
  3300. is useful to keep archived entries from contributing to the
  3301. Org-mode Agenda.
  3302. The archived entries will be filed as subtrees of the specified
  3303. headline. When the headline is omitted, the subtrees are simply
  3304. filed away at the end of the file, as top-level entries. Also in
  3305. the heading you can use %s to represent the file name, this can be
  3306. useful when using the same archive for a number of different files.
  3307. Here are a few examples:
  3308. \"%s_archive::\"
  3309. If the current file is Projects.org, archive in file
  3310. Projects.org_archive, as top-level trees. This is the default.
  3311. \"::* Archived Tasks\"
  3312. Archive in the current file, under the top-level headline
  3313. \"* Archived Tasks\".
  3314. \"~/org/archive.org::\"
  3315. Archive in file ~/org/archive.org (absolute path), as top-level trees.
  3316. \"~/org/archive.org::From %s\"
  3317. Archive in file ~/org/archive.org (absolute path), under headlines
  3318. \"From FILENAME\" where file name is the current file name.
  3319. \"basement::** Finished Tasks\"
  3320. Archive in file ./basement (relative path), as level 3 trees
  3321. below the level 2 heading \"** Finished Tasks\".
  3322. You may set this option on a per-file basis by adding to the buffer a
  3323. line like
  3324. #+ARCHIVE: basement::** Finished Tasks
  3325. You may also define it locally for a subtree by setting an ARCHIVE property
  3326. in the entry. If such a property is found in an entry, or anywhere up
  3327. the hierarchy, it will be used."
  3328. :group 'org-archive
  3329. :type 'string)
  3330. (defcustom org-archive-tag "ARCHIVE"
  3331. "The tag that marks a subtree as archived.
  3332. An archived subtree does not open during visibility cycling, and does
  3333. not contribute to the agenda listings.
  3334. After changing this, font-lock must be restarted in the relevant buffers to
  3335. get the proper fontification."
  3336. :group 'org-archive
  3337. :group 'org-keywords
  3338. :type 'string)
  3339. (defcustom org-agenda-skip-archived-trees t
  3340. "Non-nil means the agenda will skip any items located in archived trees.
  3341. An archived tree is a tree marked with the tag ARCHIVE. The use of this
  3342. variable is no longer recommended, you should leave it at the value t.
  3343. Instead, use the key `v' to cycle the archives-mode in the agenda."
  3344. :group 'org-archive
  3345. :group 'org-agenda-skip
  3346. :type 'boolean)
  3347. (defcustom org-columns-skip-archived-trees t
  3348. "Non-nil means ignore archived trees when creating column view."
  3349. :group 'org-archive
  3350. :group 'org-properties
  3351. :type 'boolean)
  3352. (defcustom org-cycle-open-archived-trees nil
  3353. "Non-nil means `org-cycle' will open archived trees.
  3354. An archived tree is a tree marked with the tag ARCHIVE.
  3355. When nil, archived trees will stay folded. You can still open them with
  3356. normal outline commands like `show-all', but not with the cycling commands."
  3357. :group 'org-archive
  3358. :group 'org-cycle
  3359. :type 'boolean)
  3360. (defcustom org-sparse-tree-open-archived-trees nil
  3361. "Non-nil means sparse tree construction shows matches in archived trees.
  3362. When nil, matches in these trees are highlighted, but the trees are kept in
  3363. collapsed state."
  3364. :group 'org-archive
  3365. :group 'org-sparse-trees
  3366. :type 'boolean)
  3367. (defun org-cycle-hide-archived-subtrees (state)
  3368. "Re-hide all archived subtrees after a visibility state change."
  3369. (when (and (not org-cycle-open-archived-trees)
  3370. (not (memq state '(overview folded))))
  3371. (save-excursion
  3372. (let* ((globalp (memq state '(contents all)))
  3373. (beg (if globalp (point-min) (point)))
  3374. (end (if globalp (point-max) (org-end-of-subtree t))))
  3375. (org-hide-archived-subtrees beg end)
  3376. (goto-char beg)
  3377. (if (looking-at (concat ".*:" org-archive-tag ":"))
  3378. (message "%s" (substitute-command-keys
  3379. "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
  3380. (defun org-force-cycle-archived ()
  3381. "Cycle subtree even if it is archived."
  3382. (interactive)
  3383. (setq this-command 'org-cycle)
  3384. (let ((org-cycle-open-archived-trees t))
  3385. (call-interactively 'org-cycle)))
  3386. (defun org-hide-archived-subtrees (beg end)
  3387. "Re-hide all archived subtrees after a visibility state change."
  3388. (save-excursion
  3389. (let* ((re (concat ":" org-archive-tag ":")))
  3390. (goto-char beg)
  3391. (while (re-search-forward re end t)
  3392. (when (org-on-heading-p)
  3393. (org-flag-subtree t)
  3394. (org-end-of-subtree t))))))
  3395. (defun org-flag-subtree (flag)
  3396. (save-excursion
  3397. (org-back-to-heading t)
  3398. (outline-end-of-heading)
  3399. (outline-flag-region (point)
  3400. (progn (org-end-of-subtree t) (point))
  3401. flag)))
  3402. (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
  3403. (eval-and-compile
  3404. (org-autoload "org-archive"
  3405. '(org-add-archive-files org-archive-subtree
  3406. org-archive-to-archive-sibling org-toggle-archive-tag
  3407. org-archive-subtree-default
  3408. org-archive-subtree-default-with-confirmation)))
  3409. ;; Autoload Column View Code
  3410. (declare-function org-columns-number-to-string "org-colview")
  3411. (declare-function org-columns-get-format-and-top-level "org-colview")
  3412. (declare-function org-columns-compute "org-colview")
  3413. (org-autoload (if (featurep 'xemacs) "org-colview-xemacs" "org-colview")
  3414. '(org-columns-number-to-string org-columns-get-format-and-top-level
  3415. org-columns-compute org-agenda-columns org-columns-remove-overlays
  3416. org-columns org-insert-columns-dblock org-dblock-write:columnview))
  3417. ;; Autoload ID code
  3418. (declare-function org-id-store-link "org-id")
  3419. (declare-function org-id-locations-load "org-id")
  3420. (declare-function org-id-locations-save "org-id")
  3421. (defvar org-id-track-globally)
  3422. (org-autoload "org-id"
  3423. '(org-id-get-create org-id-new org-id-copy org-id-get
  3424. org-id-get-with-outline-path-completion
  3425. org-id-get-with-outline-drilling
  3426. org-id-goto org-id-find org-id-store-link))
  3427. ;; Autoload Plotting Code
  3428. (org-autoload "org-plot"
  3429. '(org-plot/gnuplot))
  3430. ;;; Variables for pre-computed regular expressions, all buffer local
  3431. (defvar org-drawer-regexp nil
  3432. "Matches first line of a hidden block.")
  3433. (make-variable-buffer-local 'org-drawer-regexp)
  3434. (defvar org-todo-regexp nil
  3435. "Matches any of the TODO state keywords.")
  3436. (make-variable-buffer-local 'org-todo-regexp)
  3437. (defvar org-not-done-regexp nil
  3438. "Matches any of the TODO state keywords except the last one.")
  3439. (make-variable-buffer-local 'org-not-done-regexp)
  3440. (defvar org-not-done-heading-regexp nil
  3441. "Matches a TODO headline that is not done.")
  3442. (make-variable-buffer-local 'org-not-done-regexp)
  3443. (defvar org-todo-line-regexp nil
  3444. "Matches a headline and puts TODO state into group 2 if present.")
  3445. (make-variable-buffer-local 'org-todo-line-regexp)
  3446. (defvar org-complex-heading-regexp nil
  3447. "Matches a headline and puts everything into groups:
  3448. group 1: the stars
  3449. group 2: The todo keyword, maybe
  3450. group 3: Priority cookie
  3451. group 4: True headline
  3452. group 5: Tags")
  3453. (make-variable-buffer-local 'org-complex-heading-regexp)
  3454. (defvar org-complex-heading-regexp-format nil)
  3455. (make-variable-buffer-local 'org-complex-heading-regexp-format)
  3456. (defvar org-todo-line-tags-regexp nil
  3457. "Matches a headline and puts TODO state into group 2 if present.
  3458. Also put tags into group 4 if tags are present.")
  3459. (make-variable-buffer-local 'org-todo-line-tags-regexp)
  3460. (defvar org-nl-done-regexp nil
  3461. "Matches newline followed by a headline with the DONE keyword.")
  3462. (make-variable-buffer-local 'org-nl-done-regexp)
  3463. (defvar org-looking-at-done-regexp nil
  3464. "Matches the DONE keyword a point.")
  3465. (make-variable-buffer-local 'org-looking-at-done-regexp)
  3466. (defvar org-ds-keyword-length 12
  3467. "Maximum length of the Deadline and SCHEDULED keywords.")
  3468. (make-variable-buffer-local 'org-ds-keyword-length)
  3469. (defvar org-deadline-regexp nil
  3470. "Matches the DEADLINE keyword.")
  3471. (make-variable-buffer-local 'org-deadline-regexp)
  3472. (defvar org-deadline-time-regexp nil
  3473. "Matches the DEADLINE keyword together with a time stamp.")
  3474. (make-variable-buffer-local 'org-deadline-time-regexp)
  3475. (defvar org-deadline-line-regexp nil
  3476. "Matches the DEADLINE keyword and the rest of the line.")
  3477. (make-variable-buffer-local 'org-deadline-line-regexp)
  3478. (defvar org-scheduled-regexp nil
  3479. "Matches the SCHEDULED keyword.")
  3480. (make-variable-buffer-local 'org-scheduled-regexp)
  3481. (defvar org-scheduled-time-regexp nil
  3482. "Matches the SCHEDULED keyword together with a time stamp.")
  3483. (make-variable-buffer-local 'org-scheduled-time-regexp)
  3484. (defvar org-closed-time-regexp nil
  3485. "Matches the CLOSED keyword together with a time stamp.")
  3486. (make-variable-buffer-local 'org-closed-time-regexp)
  3487. (defvar org-keyword-time-regexp nil
  3488. "Matches any of the 4 keywords, together with the time stamp.")
  3489. (make-variable-buffer-local 'org-keyword-time-regexp)
  3490. (defvar org-keyword-time-not-clock-regexp nil
  3491. "Matches any of the 3 keywords, together with the time stamp.")
  3492. (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
  3493. (defvar org-maybe-keyword-time-regexp nil
  3494. "Matches a timestamp, possibly preceeded by a keyword.")
  3495. (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
  3496. (defvar org-planning-or-clock-line-re nil
  3497. "Matches a line with planning or clock info.")
  3498. (make-variable-buffer-local 'org-planning-or-clock-line-re)
  3499. (defvar org-all-time-keywords nil
  3500. "List of time keywords.")
  3501. (make-variable-buffer-local 'org-all-time-keywords)
  3502. (defconst org-plain-time-of-day-regexp
  3503. (concat
  3504. "\\(\\<[012]?[0-9]"
  3505. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3506. "\\(--?"
  3507. "\\(\\<[012]?[0-9]"
  3508. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3509. "\\)?")
  3510. "Regular expression to match a plain time or time range.
  3511. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3512. groups carry important information:
  3513. 0 the full match
  3514. 1 the first time, range or not
  3515. 8 the second time, if it is a range.")
  3516. (defconst org-plain-time-extension-regexp
  3517. (concat
  3518. "\\(\\<[012]?[0-9]"
  3519. "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
  3520. "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
  3521. "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
  3522. Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
  3523. groups carry important information:
  3524. 0 the full match
  3525. 7 hours of duration
  3526. 9 minutes of duration")
  3527. (defconst org-stamp-time-of-day-regexp
  3528. (concat
  3529. "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
  3530. "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
  3531. "\\(--?"
  3532. "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
  3533. "Regular expression to match a timestamp time or time range.
  3534. After a match, the following groups carry important information:
  3535. 0 the full match
  3536. 1 date plus weekday, for back referencing to make sure both times are on the same day
  3537. 2 the first time, range or not
  3538. 4 the second time, if it is a range.")
  3539. (defconst org-startup-options
  3540. '(("fold" org-startup-folded t)
  3541. ("overview" org-startup-folded t)
  3542. ("nofold" org-startup-folded nil)
  3543. ("showall" org-startup-folded nil)
  3544. ("showeverything" org-startup-folded showeverything)
  3545. ("content" org-startup-folded content)
  3546. ("indent" org-startup-indented t)
  3547. ("noindent" org-startup-indented nil)
  3548. ("hidestars" org-hide-leading-stars t)
  3549. ("showstars" org-hide-leading-stars nil)
  3550. ("odd" org-odd-levels-only t)
  3551. ("oddeven" org-odd-levels-only nil)
  3552. ("align" org-startup-align-all-tables t)
  3553. ("noalign" org-startup-align-all-tables nil)
  3554. ("customtime" org-display-custom-times t)
  3555. ("logdone" org-log-done time)
  3556. ("lognotedone" org-log-done note)
  3557. ("nologdone" org-log-done nil)
  3558. ("lognoteclock-out" org-log-note-clock-out t)
  3559. ("nolognoteclock-out" org-log-note-clock-out nil)
  3560. ("logrepeat" org-log-repeat state)
  3561. ("lognoterepeat" org-log-repeat note)
  3562. ("nologrepeat" org-log-repeat nil)
  3563. ("logreschedule" org-log-reschedule time)
  3564. ("lognotereschedule" org-log-reschedule note)
  3565. ("nologreschedule" org-log-reschedule nil)
  3566. ("logredeadline" org-log-redeadline time)
  3567. ("lognoteredeadline" org-log-redeadline note)
  3568. ("nologredeadline" org-log-redeadline nil)
  3569. ("logrefile" org-log-refile time)
  3570. ("lognoterefile" org-log-refile note)
  3571. ("nologrefile" org-log-refile nil)
  3572. ("fninline" org-footnote-define-inline t)
  3573. ("nofninline" org-footnote-define-inline nil)
  3574. ("fnlocal" org-footnote-section nil)
  3575. ("fnauto" org-footnote-auto-label t)
  3576. ("fnprompt" org-footnote-auto-label nil)
  3577. ("fnconfirm" org-footnote-auto-label confirm)
  3578. ("fnplain" org-footnote-auto-label plain)
  3579. ("fnadjust" org-footnote-auto-adjust t)
  3580. ("nofnadjust" org-footnote-auto-adjust nil)
  3581. ("constcgs" constants-unit-system cgs)
  3582. ("constSI" constants-unit-system SI)
  3583. ("noptag" org-tag-persistent-alist nil)
  3584. ("hideblocks" org-hide-block-startup t)
  3585. ("nohideblocks" org-hide-block-startup nil)
  3586. ("beamer" org-startup-with-beamer-mode t)
  3587. ("entitiespretty" org-pretty-entities t)
  3588. ("entitiesplain" org-pretty-entities nil))
  3589. "Variable associated with STARTUP options for org-mode.
  3590. Each element is a list of three items: The startup options as written
  3591. in the #+STARTUP line, the corresponding variable, and the value to
  3592. set this variable to if the option is found. An optional forth element PUSH
  3593. means to push this value onto the list in the variable.")
  3594. (defun org-set-regexps-and-options ()
  3595. "Precompute regular expressions for current buffer."
  3596. (when (org-mode-p)
  3597. (org-set-local 'org-todo-kwd-alist nil)
  3598. (org-set-local 'org-todo-key-alist nil)
  3599. (org-set-local 'org-todo-key-trigger nil)
  3600. (org-set-local 'org-todo-keywords-1 nil)
  3601. (org-set-local 'org-done-keywords nil)
  3602. (org-set-local 'org-todo-heads nil)
  3603. (org-set-local 'org-todo-sets nil)
  3604. (org-set-local 'org-todo-log-states nil)
  3605. (org-set-local 'org-file-properties nil)
  3606. (org-set-local 'org-file-tags nil)
  3607. (let ((re (org-make-options-regexp
  3608. '("CATEGORY" "TODO" "COLUMNS"
  3609. "STARTUP" "ARCHIVE" "FILETAGS" "TAGS" "LINK" "PRIORITIES"
  3610. "CONSTANTS" "PROPERTY" "DRAWERS" "SETUPFILE" "LATEX_CLASS"
  3611. "OPTIONS")
  3612. "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
  3613. (splitre "[ \t]+")
  3614. (scripts org-use-sub-superscripts)
  3615. kwds kws0 kwsa key log value cat arch tags const links hw dws
  3616. tail sep kws1 prio props ftags drawers beamer-p
  3617. ext-setup-or-nil setup-contents (start 0))
  3618. (save-excursion
  3619. (save-restriction
  3620. (widen)
  3621. (goto-char (point-min))
  3622. (while (or (and ext-setup-or-nil
  3623. (string-match re ext-setup-or-nil start)
  3624. (setq start (match-end 0)))
  3625. (and (setq ext-setup-or-nil nil start 0)
  3626. (re-search-forward re nil t)))
  3627. (setq key (upcase (match-string 1 ext-setup-or-nil))
  3628. value (org-match-string-no-properties 2 ext-setup-or-nil))
  3629. (if (stringp value) (setq value (org-trim value)))
  3630. (cond
  3631. ((equal key "CATEGORY")
  3632. (setq cat value))
  3633. ((member key '("SEQ_TODO" "TODO"))
  3634. (push (cons 'sequence (org-split-string value splitre)) kwds))
  3635. ((equal key "TYP_TODO")
  3636. (push (cons 'type (org-split-string value splitre)) kwds))
  3637. ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
  3638. ;; general TODO-like setup
  3639. (push (cons (intern (downcase (match-string 1 key)))
  3640. (org-split-string value splitre)) kwds))
  3641. ((equal key "TAGS")
  3642. (setq tags (append tags (if tags '("\\n") nil)
  3643. (org-split-string value splitre))))
  3644. ((equal key "COLUMNS")
  3645. (org-set-local 'org-columns-default-format value))
  3646. ((equal key "LINK")
  3647. (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
  3648. (push (cons (match-string 1 value)
  3649. (org-trim (match-string 2 value)))
  3650. links)))
  3651. ((equal key "PRIORITIES")
  3652. (setq prio (org-split-string value " +")))
  3653. ((equal key "PROPERTY")
  3654. (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
  3655. (push (cons (match-string 1 value) (match-string 2 value))
  3656. props)))
  3657. ((equal key "FILETAGS")
  3658. (when (string-match "\\S-" value)
  3659. (setq ftags
  3660. (append
  3661. ftags
  3662. (apply 'append
  3663. (mapcar (lambda (x) (org-split-string x ":"))
  3664. (org-split-string value)))))))
  3665. ((equal key "DRAWERS")
  3666. (setq drawers (org-split-string value splitre)))
  3667. ((equal key "CONSTANTS")
  3668. (setq const (append const (org-split-string value splitre))))
  3669. ((equal key "STARTUP")
  3670. (let ((opts (org-split-string value splitre))
  3671. l var val)
  3672. (while (setq l (pop opts))
  3673. (when (setq l (assoc l org-startup-options))
  3674. (setq var (nth 1 l) val (nth 2 l))
  3675. (if (not (nth 3 l))
  3676. (set (make-local-variable var) val)
  3677. (if (not (listp (symbol-value var)))
  3678. (set (make-local-variable var) nil))
  3679. (set (make-local-variable var) (symbol-value var))
  3680. (add-to-list var val))))))
  3681. ((equal key "ARCHIVE")
  3682. (setq arch value)
  3683. (remove-text-properties 0 (length arch)
  3684. '(face t fontified t) arch))
  3685. ((equal key "LATEX_CLASS")
  3686. (setq beamer-p (equal value "beamer")))
  3687. ((equal key "OPTIONS")
  3688. (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value)
  3689. (setq scripts (read (match-string 2 value)))))
  3690. ((equal key "SETUPFILE")
  3691. (setq setup-contents (org-file-contents
  3692. (expand-file-name
  3693. (org-remove-double-quotes value))
  3694. 'noerror))
  3695. (if (not ext-setup-or-nil)
  3696. (setq ext-setup-or-nil setup-contents start 0)
  3697. (setq ext-setup-or-nil
  3698. (concat (substring ext-setup-or-nil 0 start)
  3699. "\n" setup-contents "\n"
  3700. (substring ext-setup-or-nil start)))))
  3701. ))))
  3702. (org-set-local 'org-use-sub-superscripts scripts)
  3703. (when cat
  3704. (org-set-local 'org-category (intern cat))
  3705. (push (cons "CATEGORY" cat) props))
  3706. (when prio
  3707. (if (< (length prio) 3) (setq prio '("A" "C" "B")))
  3708. (setq prio (mapcar 'string-to-char prio))
  3709. (org-set-local 'org-highest-priority (nth 0 prio))
  3710. (org-set-local 'org-lowest-priority (nth 1 prio))
  3711. (org-set-local 'org-default-priority (nth 2 prio)))
  3712. (and props (org-set-local 'org-file-properties (nreverse props)))
  3713. (and ftags (org-set-local 'org-file-tags
  3714. (mapcar 'org-add-prop-inherited ftags)))
  3715. (and drawers (org-set-local 'org-drawers drawers))
  3716. (and arch (org-set-local 'org-archive-location arch))
  3717. (and links (setq org-link-abbrev-alist-local (nreverse links)))
  3718. ;; Process the TODO keywords
  3719. (unless kwds
  3720. ;; Use the global values as if they had been given locally.
  3721. (setq kwds (default-value 'org-todo-keywords))
  3722. (if (stringp (car kwds))
  3723. (setq kwds (list (cons org-todo-interpretation
  3724. (default-value 'org-todo-keywords)))))
  3725. (setq kwds (reverse kwds)))
  3726. (setq kwds (nreverse kwds))
  3727. (let (inter kws kw)
  3728. (while (setq kws (pop kwds))
  3729. (let ((kws (or
  3730. (run-hook-with-args-until-success
  3731. 'org-todo-setup-filter-hook kws)
  3732. kws)))
  3733. (setq inter (pop kws) sep (member "|" kws)
  3734. kws0 (delete "|" (copy-sequence kws))
  3735. kwsa nil
  3736. kws1 (mapcar
  3737. (lambda (x)
  3738. ;; 1 2
  3739. (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
  3740. (progn
  3741. (setq kw (match-string 1 x)
  3742. key (and (match-end 2) (match-string 2 x))
  3743. log (org-extract-log-state-settings x))
  3744. (push (cons kw (and key (string-to-char key))) kwsa)
  3745. (and log (push log org-todo-log-states))
  3746. kw)
  3747. (error "Invalid TODO keyword %s" x)))
  3748. kws0)
  3749. kwsa (if kwsa (append '((:startgroup))
  3750. (nreverse kwsa)
  3751. '((:endgroup))))
  3752. hw (car kws1)
  3753. dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
  3754. tail (list inter hw (car dws) (org-last dws))))
  3755. (add-to-list 'org-todo-heads hw 'append)
  3756. (push kws1 org-todo-sets)
  3757. (setq org-done-keywords (append org-done-keywords dws nil))
  3758. (setq org-todo-key-alist (append org-todo-key-alist kwsa))
  3759. (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
  3760. (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
  3761. (setq org-todo-sets (nreverse org-todo-sets)
  3762. org-todo-kwd-alist (nreverse org-todo-kwd-alist)
  3763. org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
  3764. org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
  3765. ;; Process the constants
  3766. (when const
  3767. (let (e cst)
  3768. (while (setq e (pop const))
  3769. (if (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)" e)
  3770. (push (cons (match-string 1 e) (match-string 2 e)) cst)))
  3771. (setq org-table-formula-constants-local cst)))
  3772. ;; Process the tags.
  3773. (when tags
  3774. (let (e tgs)
  3775. (while (setq e (pop tags))
  3776. (cond
  3777. ((equal e "{") (push '(:startgroup) tgs))
  3778. ((equal e "}") (push '(:endgroup) tgs))
  3779. ((equal e "\\n") (push '(:newline) tgs))
  3780. ((string-match (org-re "^\\([[:alnum:]_@]+\\)(\\(.\\))$") e)
  3781. (push (cons (match-string 1 e)
  3782. (string-to-char (match-string 2 e)))
  3783. tgs))
  3784. (t (push (list e) tgs))))
  3785. (org-set-local 'org-tag-alist nil)
  3786. (while (setq e (pop tgs))
  3787. (or (and (stringp (car e))
  3788. (assoc (car e) org-tag-alist))
  3789. (push e org-tag-alist)))))
  3790. ;; Compute the regular expressions and other local variables
  3791. (if (not org-done-keywords)
  3792. (setq org-done-keywords (and org-todo-keywords-1
  3793. (list (org-last org-todo-keywords-1)))))
  3794. (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
  3795. (length org-scheduled-string)
  3796. (length org-clock-string)
  3797. (length org-closed-string)))
  3798. org-drawer-regexp
  3799. (concat "^[ \t]*:\\("
  3800. (mapconcat 'regexp-quote org-drawers "\\|")
  3801. "\\):[ \t]*$")
  3802. org-not-done-keywords
  3803. (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
  3804. org-todo-regexp
  3805. (concat "\\<\\(" (mapconcat 'regexp-quote org-todo-keywords-1
  3806. "\\|") "\\)\\>")
  3807. org-not-done-regexp
  3808. (concat "\\<\\("
  3809. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  3810. "\\)\\>")
  3811. org-not-done-heading-regexp
  3812. (concat "^\\(\\*+\\)[ \t]+\\("
  3813. (mapconcat 'regexp-quote org-not-done-keywords "\\|")
  3814. "\\)\\>")
  3815. org-todo-line-regexp
  3816. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3817. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3818. "\\)\\>\\)?[ \t]*\\(.*\\)")
  3819. org-complex-heading-regexp
  3820. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3821. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3822. "\\)\\>\\)?\\(?:[ \t]*\\(\\[#.\\]\\)\\)?[ \t]*\\(.*?\\)"
  3823. "\\(?:[ \t]+\\(:[[:alnum:]_@:]+:\\)\\)?[ \t]*$")
  3824. org-complex-heading-regexp-format
  3825. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3826. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3827. "\\)\\>\\)?"
  3828. "\\(?:[ \t]*\\(\\[#.\\]\\)\\)?"
  3829. "\\(?:[ \t]*\\(?:\\[[0-9%%/]+\\]\\)\\)?" ;; stats cookie
  3830. "[ \t]*\\(%s\\)"
  3831. "\\(?:[ \t]*\\(?:\\[[0-9%%/]+\\]\\)\\)?" ;; stats cookie
  3832. "\\(?:[ \t]+\\(:[[:alnum:]_@:]+:\\)\\)?[ \t]*$")
  3833. org-nl-done-regexp
  3834. (concat "\n\\*+[ \t]+"
  3835. "\\(?:" (mapconcat 'regexp-quote org-done-keywords "\\|")
  3836. "\\)" "\\>")
  3837. org-todo-line-tags-regexp
  3838. (concat "^\\(\\*+\\)[ \t]+\\(?:\\("
  3839. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  3840. (org-re
  3841. "\\)\\>\\)? *\\(.*?\\([ \t]:[[:alnum:]:_@]+:[ \t]*\\)?$\\)"))
  3842. org-looking-at-done-regexp
  3843. (concat "^" "\\(?:"
  3844. (mapconcat 'regexp-quote org-done-keywords "\\|") "\\)"
  3845. "\\>")
  3846. org-deadline-regexp (concat "\\<" org-deadline-string)
  3847. org-deadline-time-regexp
  3848. (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
  3849. org-deadline-line-regexp
  3850. (concat "\\<\\(" org-deadline-string "\\).*")
  3851. org-scheduled-regexp
  3852. (concat "\\<" org-scheduled-string)
  3853. org-scheduled-time-regexp
  3854. (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
  3855. org-closed-time-regexp
  3856. (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
  3857. org-keyword-time-regexp
  3858. (concat "\\<\\(" org-scheduled-string
  3859. "\\|" org-deadline-string
  3860. "\\|" org-closed-string
  3861. "\\|" org-clock-string "\\)"
  3862. " *[[<]\\([^]>]+\\)[]>]")
  3863. org-keyword-time-not-clock-regexp
  3864. (concat "\\<\\(" org-scheduled-string
  3865. "\\|" org-deadline-string
  3866. "\\|" org-closed-string
  3867. "\\)"
  3868. " *[[<]\\([^]>]+\\)[]>]")
  3869. org-maybe-keyword-time-regexp
  3870. (concat "\\(\\<\\(" org-scheduled-string
  3871. "\\|" org-deadline-string
  3872. "\\|" org-closed-string
  3873. "\\|" org-clock-string "\\)\\)?"
  3874. " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
  3875. org-planning-or-clock-line-re
  3876. (concat "\\(?:^[ \t]*\\(" org-scheduled-string
  3877. "\\|" org-deadline-string
  3878. "\\|" org-closed-string "\\|" org-clock-string
  3879. "\\)\\>\\)")
  3880. org-all-time-keywords
  3881. (mapcar (lambda (w) (substring w 0 -1))
  3882. (list org-scheduled-string org-deadline-string
  3883. org-clock-string org-closed-string))
  3884. )
  3885. (org-compute-latex-and-specials-regexp)
  3886. (org-set-font-lock-defaults))))
  3887. (defun org-file-contents (file &optional noerror)
  3888. "Return the contents of FILE, as a string."
  3889. (if (or (not file)
  3890. (not (file-readable-p file)))
  3891. (if noerror
  3892. (progn
  3893. (message "Cannot read file \"%s\"" file)
  3894. (ding) (sit-for 2)
  3895. "")
  3896. (error "Cannot read file \"%s\"" file))
  3897. (with-temp-buffer
  3898. (insert-file-contents file)
  3899. (buffer-string))))
  3900. (defun org-extract-log-state-settings (x)
  3901. "Extract the log state setting from a TODO keyword string.
  3902. This will extract info from a string like \"WAIT(w@/!)\"."
  3903. (let (kw key log1 log2)
  3904. (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
  3905. (setq kw (match-string 1 x)
  3906. key (and (match-end 2) (match-string 2 x))
  3907. log1 (and (match-end 3) (match-string 3 x))
  3908. log2 (and (match-end 4) (match-string 4 x)))
  3909. (and (or log1 log2)
  3910. (list kw
  3911. (and log1 (if (equal log1 "!") 'time 'note))
  3912. (and log2 (if (equal log2 "!") 'time 'note)))))))
  3913. (defun org-remove-keyword-keys (list)
  3914. "Remove a pair of parenthesis at the end of each string in LIST."
  3915. (mapcar (lambda (x)
  3916. (if (string-match "(.*)$" x)
  3917. (substring x 0 (match-beginning 0))
  3918. x))
  3919. list))
  3920. (defun org-assign-fast-keys (alist)
  3921. "Assign fast keys to a keyword-key alist.
  3922. Respect keys that are already there."
  3923. (let (new e (alt ?0))
  3924. (while (setq e (pop alist))
  3925. (if (or (memq (car e) '(:newline :endgroup :startgroup))
  3926. (cdr e)) ;; Key already assigned.
  3927. (push e new)
  3928. (let ((clist (string-to-list (downcase (car e))))
  3929. (used (append new alist)))
  3930. (when (= (car clist) ?@)
  3931. (pop clist))
  3932. (while (and clist (rassoc (car clist) used))
  3933. (pop clist))
  3934. (unless clist
  3935. (while (rassoc alt used)
  3936. (incf alt)))
  3937. (push (cons (car e) (or (car clist) alt)) new))))
  3938. (nreverse new)))
  3939. ;;; Some variables used in various places
  3940. (defvar org-window-configuration nil
  3941. "Used in various places to store a window configuration.")
  3942. (defvar org-selected-window nil
  3943. "Used in various places to store a window configuration.")
  3944. (defvar org-finish-function nil
  3945. "Function to be called when `C-c C-c' is used.
  3946. This is for getting out of special buffers like remember.")
  3947. ;; FIXME: Occasionally check by commenting these, to make sure
  3948. ;; no other functions uses these, forgetting to let-bind them.
  3949. (defvar entry)
  3950. (defvar last-state)
  3951. (defvar date)
  3952. ;; Defined somewhere in this file, but used before definition.
  3953. (defvar org-entities) ;; defined in org-entities.el
  3954. (defvar org-struct-menu)
  3955. (defvar org-org-menu)
  3956. (defvar org-tbl-menu)
  3957. ;;;; Define the Org-mode
  3958. (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
  3959. (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."))
  3960. ;; We use a before-change function to check if a table might need
  3961. ;; an update.
  3962. (defvar org-table-may-need-update t
  3963. "Indicates that a table might need an update.
  3964. This variable is set by `org-before-change-function'.
  3965. `org-table-align' sets it back to nil.")
  3966. (defun org-before-change-function (beg end)
  3967. "Every change indicates that a table might need an update."
  3968. (setq org-table-may-need-update t))
  3969. (defvar org-mode-map)
  3970. (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
  3971. (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
  3972. (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
  3973. (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
  3974. (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
  3975. (defvar org-table-buffer-is-an nil)
  3976. (defconst org-outline-regexp "\\*+ ")
  3977. ;;;###autoload
  3978. (define-derived-mode org-mode outline-mode "Org"
  3979. "Outline-based notes management and organizer, alias
  3980. \"Carsten's outline-mode for keeping track of everything.\"
  3981. Org-mode develops organizational tasks around a NOTES file which
  3982. contains information about projects as plain text. Org-mode is
  3983. implemented on top of outline-mode, which is ideal to keep the content
  3984. of large files well structured. It supports ToDo items, deadlines and
  3985. time stamps, which magically appear in the diary listing of the Emacs
  3986. calendar. Tables are easily created with a built-in table editor.
  3987. Plain text URL-like links connect to websites, emails (VM), Usenet
  3988. messages (Gnus), BBDB entries, and any files related to the project.
  3989. For printing and sharing of notes, an Org-mode file (or a part of it)
  3990. can be exported as a structured ASCII or HTML file.
  3991. The following commands are available:
  3992. \\{org-mode-map}"
  3993. ;; Get rid of Outline menus, they are not needed
  3994. ;; Need to do this here because define-derived-mode sets up
  3995. ;; the keymap so late. Still, it is a waste to call this each time
  3996. ;; we switch another buffer into org-mode.
  3997. (if (featurep 'xemacs)
  3998. (when (boundp 'outline-mode-menu-heading)
  3999. ;; Assume this is Greg's port, it uses easymenu
  4000. (easy-menu-remove outline-mode-menu-heading)
  4001. (easy-menu-remove outline-mode-menu-show)
  4002. (easy-menu-remove outline-mode-menu-hide))
  4003. (define-key org-mode-map [menu-bar headings] 'undefined)
  4004. (define-key org-mode-map [menu-bar hide] 'undefined)
  4005. (define-key org-mode-map [menu-bar show] 'undefined))
  4006. (org-load-modules-maybe)
  4007. (easy-menu-add org-org-menu)
  4008. (easy-menu-add org-tbl-menu)
  4009. (org-install-agenda-files-menu)
  4010. (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
  4011. (add-to-invisibility-spec '(org-cwidth))
  4012. (add-to-invisibility-spec '(org-hide-block . t))
  4013. (when (featurep 'xemacs)
  4014. (org-set-local 'line-move-ignore-invisible t))
  4015. (org-set-local 'outline-regexp org-outline-regexp)
  4016. (org-set-local 'outline-level 'org-outline-level)
  4017. (when (and org-ellipsis
  4018. (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
  4019. (fboundp 'make-glyph-code))
  4020. (unless org-display-table
  4021. (setq org-display-table (make-display-table)))
  4022. (set-display-table-slot
  4023. org-display-table 4
  4024. (vconcat (mapcar
  4025. (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
  4026. org-ellipsis)))
  4027. (if (stringp org-ellipsis) org-ellipsis "..."))))
  4028. (setq buffer-display-table org-display-table))
  4029. (org-set-regexps-and-options)
  4030. (when (and org-tag-faces (not org-tags-special-faces-re))
  4031. ;; tag faces set outside customize.... force initialization.
  4032. (org-set-tag-faces 'org-tag-faces org-tag-faces))
  4033. ;; Calc embedded
  4034. (org-set-local 'calc-embedded-open-mode "# ")
  4035. (modify-syntax-entry ?@ "w")
  4036. (if org-startup-truncated (setq truncate-lines t))
  4037. (org-set-local 'font-lock-unfontify-region-function
  4038. 'org-unfontify-region)
  4039. ;; Activate before-change-function
  4040. (org-set-local 'org-table-may-need-update t)
  4041. (org-add-hook 'before-change-functions 'org-before-change-function nil
  4042. 'local)
  4043. ;; Check for running clock before killing a buffer
  4044. (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
  4045. ;; Paragraphs and auto-filling
  4046. (org-set-autofill-regexps)
  4047. (setq indent-line-function 'org-indent-line-function)
  4048. (org-update-radio-target-regexp)
  4049. ;; Beginning/end of defun
  4050. (org-set-local 'beginning-of-defun-function 'org-beginning-of-defun)
  4051. (org-set-local 'end-of-defun-function 'org-end-of-defun)
  4052. ;; Make sure dependence stuff works reliably, even for users who set it
  4053. ;; too late :-(
  4054. (if org-enforce-todo-dependencies
  4055. (add-hook 'org-blocker-hook
  4056. 'org-block-todo-from-children-or-siblings-or-parent)
  4057. (remove-hook 'org-blocker-hook
  4058. 'org-block-todo-from-children-or-siblings-or-parent))
  4059. (if org-enforce-todo-checkbox-dependencies
  4060. (add-hook 'org-blocker-hook
  4061. 'org-block-todo-from-checkboxes)
  4062. (remove-hook 'org-blocker-hook
  4063. 'org-block-todo-from-checkboxes))
  4064. ;; Comment characters
  4065. (org-set-local 'comment-start "#")
  4066. (org-set-local 'comment-padding " ")
  4067. ;; Align options lines
  4068. (org-set-local
  4069. 'align-mode-rules-list
  4070. '((org-in-buffer-settings
  4071. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  4072. (modes . '(org-mode)))))
  4073. ;; Imenu
  4074. (org-set-local 'imenu-create-index-function
  4075. 'org-imenu-get-tree)
  4076. ;; Make isearch reveal context
  4077. (if (or (featurep 'xemacs)
  4078. (not (boundp 'outline-isearch-open-invisible-function)))
  4079. ;; Emacs 21 and XEmacs make use of the hook
  4080. (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
  4081. ;; Emacs 22 deals with this through a special variable
  4082. (org-set-local 'outline-isearch-open-invisible-function
  4083. (lambda (&rest ignore) (org-show-context 'isearch))))
  4084. ;; Turn on org-beamer-mode?
  4085. (and org-startup-with-beamer-mode (org-beamer-mode 1))
  4086. ;; If empty file that did not turn on org-mode automatically, make it to.
  4087. (if (and org-insert-mode-line-in-empty-file
  4088. (interactive-p)
  4089. (= (point-min) (point-max)))
  4090. (insert "# -*- mode: org -*-\n\n"))
  4091. (unless org-inhibit-startup
  4092. (when org-startup-align-all-tables
  4093. (let ((bmp (buffer-modified-p)))
  4094. (org-table-map-tables 'org-table-align 'quietly)
  4095. (set-buffer-modified-p bmp)))
  4096. (when org-startup-indented
  4097. (require 'org-indent)
  4098. (org-indent-mode 1))
  4099. (unless org-inhibit-startup-visibility-stuff
  4100. (org-set-startup-visibility))))
  4101. (when (fboundp 'abbrev-table-put)
  4102. (abbrev-table-put org-mode-abbrev-table
  4103. :parents (list text-mode-abbrev-table)))
  4104. (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
  4105. (defun org-current-time ()
  4106. "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
  4107. (if (> (car org-time-stamp-rounding-minutes) 1)
  4108. (let ((r (car org-time-stamp-rounding-minutes))
  4109. (time (decode-time)))
  4110. (apply 'encode-time
  4111. (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
  4112. (nthcdr 2 time))))
  4113. (current-time)))
  4114. ;;;; Font-Lock stuff, including the activators
  4115. (defvar org-mouse-map (make-sparse-keymap))
  4116. (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
  4117. (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
  4118. (when org-mouse-1-follows-link
  4119. (org-defkey org-mouse-map [follow-link] 'mouse-face))
  4120. (when org-tab-follows-link
  4121. (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
  4122. (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
  4123. (require 'font-lock)
  4124. (defconst org-non-link-chars "]\t\n\r<>")
  4125. (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
  4126. "shell" "elisp" "doi"))
  4127. (defvar org-link-types-re nil
  4128. "Matches a link that has a url-like prefix like \"http:\"")
  4129. (defvar org-link-re-with-space nil
  4130. "Matches a link with spaces, optional angular brackets around it.")
  4131. (defvar org-link-re-with-space2 nil
  4132. "Matches a link with spaces, optional angular brackets around it.")
  4133. (defvar org-link-re-with-space3 nil
  4134. "Matches a link with spaces, only for internal part in bracket links.")
  4135. (defvar org-angle-link-re nil
  4136. "Matches link with angular brackets, spaces are allowed.")
  4137. (defvar org-plain-link-re nil
  4138. "Matches plain link, without spaces.")
  4139. (defvar org-bracket-link-regexp nil
  4140. "Matches a link in double brackets.")
  4141. (defvar org-bracket-link-analytic-regexp nil
  4142. "Regular expression used to analyze links.
  4143. Here is what the match groups contain after a match:
  4144. 1: http:
  4145. 2: http
  4146. 3: path
  4147. 4: [desc]
  4148. 5: desc")
  4149. (defvar org-bracket-link-analytic-regexp++ nil
  4150. "Like org-bracket-link-analytic-regexp, but include coderef internal type.")
  4151. (defvar org-any-link-re nil
  4152. "Regular expression matching any link.")
  4153. (defcustom org-match-sexp-depth 3
  4154. "Number of stacked braces for sub/superscript matching.
  4155. This has to be set before loading org.el to be effective."
  4156. :group 'org-export-translation ; ??????????????????????????/
  4157. :type 'integer)
  4158. (defun org-create-multibrace-regexp (left right n)
  4159. "Create a regular expression which will match a balanced sexp.
  4160. Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
  4161. as single character strings.
  4162. The regexp returned will match the entire expression including the
  4163. delimiters. It will also define a single group which contains the
  4164. match except for the outermost delimiters. The maximum depth of
  4165. stacked delimiters is N. Escaping delimiters is not possible."
  4166. (let* ((nothing (concat "[^" left right "]*?"))
  4167. (or "\\|")
  4168. (re nothing)
  4169. (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
  4170. (while (> n 1)
  4171. (setq n (1- n)
  4172. re (concat re or next)
  4173. next (concat "\\(?:" nothing left next right "\\)+" nothing)))
  4174. (concat left "\\(" re "\\)" right)))
  4175. (defvar org-match-substring-regexp
  4176. (concat
  4177. "\\([^\\]\\)\\([_^]\\)\\("
  4178. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4179. "\\|"
  4180. "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
  4181. "\\|"
  4182. "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
  4183. "The regular expression matching a sub- or superscript.")
  4184. (defvar org-match-substring-with-braces-regexp
  4185. (concat
  4186. "\\([^\\]\\)\\([_^]\\)\\("
  4187. "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
  4188. "\\)")
  4189. "The regular expression matching a sub- or superscript, forcing braces.")
  4190. (defun org-make-link-regexps ()
  4191. "Update the link regular expressions.
  4192. This should be called after the variable `org-link-types' has changed."
  4193. (setq org-link-types-re
  4194. (concat
  4195. "\\`\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):")
  4196. org-link-re-with-space
  4197. (concat
  4198. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4199. "\\([^" org-non-link-chars " ]"
  4200. "[^" org-non-link-chars "]*"
  4201. "[^" org-non-link-chars " ]\\)>?")
  4202. org-link-re-with-space2
  4203. (concat
  4204. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4205. "\\([^" org-non-link-chars " ]"
  4206. "[^\t\n\r]*"
  4207. "[^" org-non-link-chars " ]\\)>?")
  4208. org-link-re-with-space3
  4209. (concat
  4210. "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4211. "\\([^" org-non-link-chars " ]"
  4212. "[^\t\n\r]*\\)")
  4213. org-angle-link-re
  4214. (concat
  4215. "<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4216. "\\([^" org-non-link-chars " ]"
  4217. "[^" org-non-link-chars "]*"
  4218. "\\)>")
  4219. org-plain-link-re
  4220. (concat
  4221. "\\<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
  4222. (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
  4223. ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
  4224. org-bracket-link-regexp
  4225. "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
  4226. org-bracket-link-analytic-regexp
  4227. (concat
  4228. "\\[\\["
  4229. "\\(\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):\\)?"
  4230. "\\([^]]+\\)"
  4231. "\\]"
  4232. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4233. "\\]")
  4234. org-bracket-link-analytic-regexp++
  4235. (concat
  4236. "\\[\\["
  4237. "\\(\\(" (mapconcat 'regexp-quote (cons "coderef" org-link-types) "\\|") "\\):\\)?"
  4238. "\\([^]]+\\)"
  4239. "\\]"
  4240. "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
  4241. "\\]")
  4242. org-any-link-re
  4243. (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
  4244. org-angle-link-re "\\)\\|\\("
  4245. org-plain-link-re "\\)")))
  4246. (org-make-link-regexps)
  4247. (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^\r\n>]*?\\)>"
  4248. "Regular expression for fast time stamp matching.")
  4249. (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^\r\n>]*?\\)[]>]"
  4250. "Regular expression for fast time stamp matching.")
  4251. (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4252. "Regular expression matching time strings for analysis.
  4253. This one does not require the space after the date, so it can be used
  4254. on a string that terminates immediately after the date.")
  4255. (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
  4256. "Regular expression matching time strings for analysis.")
  4257. (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
  4258. "Regular expression matching time stamps, with groups.")
  4259. (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
  4260. "Regular expression matching time stamps (also [..]), with groups.")
  4261. (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
  4262. "Regular expression matching a time stamp range.")
  4263. (defconst org-tr-regexp-both
  4264. (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
  4265. "Regular expression matching a time stamp range.")
  4266. (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
  4267. org-ts-regexp "\\)?")
  4268. "Regular expression matching a time stamp or time stamp range.")
  4269. (defconst org-tsr-regexp-both (concat org-ts-regexp-both "\\(--?-?"
  4270. org-ts-regexp-both "\\)?")
  4271. "Regular expression matching a time stamp or time stamp range.
  4272. The time stamps may be either active or inactive.")
  4273. (defvar org-emph-face nil)
  4274. (defun org-do-emphasis-faces (limit)
  4275. "Run through the buffer and add overlays to links."
  4276. (let (rtn a)
  4277. (while (and (not rtn) (re-search-forward org-emph-re limit t))
  4278. (if (not (= (char-after (match-beginning 3))
  4279. (char-after (match-beginning 4))))
  4280. (progn
  4281. (setq rtn t)
  4282. (setq a (assoc (match-string 3) org-emphasis-alist))
  4283. (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
  4284. 'face
  4285. (nth 1 a))
  4286. (and (nth 4 a)
  4287. (org-remove-flyspell-overlays-in
  4288. (match-beginning 0) (match-end 0)))
  4289. (add-text-properties (match-beginning 2) (match-end 2)
  4290. '(font-lock-multiline t org-emphasis t))
  4291. (when org-hide-emphasis-markers
  4292. (add-text-properties (match-end 4) (match-beginning 5)
  4293. '(invisible org-link))
  4294. (add-text-properties (match-beginning 3) (match-end 3)
  4295. '(invisible org-link)))))
  4296. (backward-char 1))
  4297. rtn))
  4298. (defun org-emphasize (&optional char)
  4299. "Insert or change an emphasis, i.e. a font like bold or italic.
  4300. If there is an active region, change that region to a new emphasis.
  4301. If there is no region, just insert the marker characters and position
  4302. the cursor between them.
  4303. CHAR should be either the marker character, or the first character of the
  4304. HTML tag associated with that emphasis. If CHAR is a space, the means
  4305. to remove the emphasis of the selected region.
  4306. If char is not given (for example in an interactive call) it
  4307. will be prompted for."
  4308. (interactive)
  4309. (let ((eal org-emphasis-alist) e det
  4310. (erc org-emphasis-regexp-components)
  4311. (prompt "")
  4312. (string "") beg end move tag c s)
  4313. (if (org-region-active-p)
  4314. (setq beg (region-beginning) end (region-end)
  4315. string (buffer-substring beg end))
  4316. (setq move t))
  4317. (while (setq e (pop eal))
  4318. (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
  4319. c (aref tag 0))
  4320. (push (cons c (string-to-char (car e))) det)
  4321. (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
  4322. (substring tag 1)))))
  4323. (setq det (nreverse det))
  4324. (unless char
  4325. (message "%s" (concat "Emphasis marker or tag:" prompt))
  4326. (setq char (read-char-exclusive)))
  4327. (setq char (or (cdr (assoc char det)) char))
  4328. (if (equal char ?\ )
  4329. (setq s "" move nil)
  4330. (unless (assoc (char-to-string char) org-emphasis-alist)
  4331. (error "No such emphasis marker: \"%c\"" char))
  4332. (setq s (char-to-string char)))
  4333. (while (and (> (length string) 1)
  4334. (equal (substring string 0 1) (substring string -1))
  4335. (assoc (substring string 0 1) org-emphasis-alist))
  4336. (setq string (substring string 1 -1)))
  4337. (setq string (concat s string s))
  4338. (if beg (delete-region beg end))
  4339. (unless (or (bolp)
  4340. (string-match (concat "[" (nth 0 erc) "\n]")
  4341. (char-to-string (char-before (point)))))
  4342. (insert " "))
  4343. (unless (or (eobp)
  4344. (string-match (concat "[" (nth 1 erc) "\n]")
  4345. (char-to-string (char-after (point)))))
  4346. (insert " ") (backward-char 1))
  4347. (insert string)
  4348. (and move (backward-char 1))))
  4349. (defconst org-nonsticky-props
  4350. '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
  4351. (defsubst org-rear-nonsticky-at (pos)
  4352. (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
  4353. (defun org-activate-plain-links (limit)
  4354. "Run through the buffer and add overlays to links."
  4355. (catch 'exit
  4356. (let (f)
  4357. (if (re-search-forward org-plain-link-re limit t)
  4358. (progn
  4359. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4360. (setq f (get-text-property (match-beginning 0) 'face))
  4361. (if (or (eq f 'org-tag)
  4362. (and (listp f) (memq 'org-tag f)))
  4363. nil
  4364. (add-text-properties (match-beginning 0) (match-end 0)
  4365. (list 'mouse-face 'highlight
  4366. 'face 'org-link
  4367. 'keymap org-mouse-map))
  4368. (org-rear-nonsticky-at (match-end 0)))
  4369. t)))))
  4370. (defun org-activate-code (limit)
  4371. (if (re-search-forward "^[ \t]*\\(: .*\n?\\)" limit t)
  4372. (progn
  4373. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4374. (remove-text-properties (match-beginning 0) (match-end 0)
  4375. '(display t invisible t intangible t))
  4376. t)))
  4377. (defun org-fontify-meta-lines-and-blocks (limit)
  4378. "Fontify #+ lines and blocks, in the correct ways."
  4379. (let ((case-fold-search t))
  4380. (if (re-search-forward
  4381. "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)\\(.*\\)\\)"
  4382. limit t)
  4383. (let ((beg (match-beginning 0))
  4384. (beg1 (line-beginning-position 2))
  4385. (dc1 (downcase (match-string 2)))
  4386. (dc3 (downcase (match-string 3)))
  4387. end end1 quoting block-type)
  4388. (cond
  4389. ((member dc1 '("html:" "ascii:" "latex:" "docbook:"))
  4390. ;; a single line of backend-specific content
  4391. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4392. (remove-text-properties (match-beginning 0) (match-end 0)
  4393. '(display t invisible t intangible t))
  4394. (add-text-properties (match-beginning 1) (match-end 3)
  4395. '(font-lock-fontified t face org-meta-line))
  4396. (add-text-properties (match-beginning 6) (match-end 6)
  4397. '(font-lock-fontified t face org-block))
  4398. t)
  4399. ((and (match-end 4) (equal dc3 "begin"))
  4400. ;; Truly a block
  4401. (setq block-type (downcase (match-string 5))
  4402. quoting (member block-type org-protecting-blocks))
  4403. (when (re-search-forward
  4404. (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
  4405. nil t) ;; on purpose, we look further than LIMIT
  4406. (setq end (match-end 0) end1 (1- (match-beginning 0)))
  4407. (when quoting
  4408. (remove-text-properties beg end
  4409. '(display t invisible t intangible t)))
  4410. (add-text-properties
  4411. beg end
  4412. '(font-lock-fontified t font-lock-multiline t))
  4413. (add-text-properties beg beg1 '(face org-meta-line))
  4414. (add-text-properties end1 end '(face org-meta-line))
  4415. (cond
  4416. (quoting
  4417. (add-text-properties beg1 end1 '(face org-block)))
  4418. ((not org-fontify-quote-and-verse-blocks))
  4419. ((string= block-type "quote")
  4420. (add-text-properties beg1 end1 '(face org-quote)))
  4421. ((string= block-type "verse")
  4422. (add-text-properties beg1 end1 '(face org-verse))))
  4423. t))
  4424. ((member dc1 '("title:" "author:" "email:" "date:"))
  4425. (add-text-properties
  4426. beg (match-end 3)
  4427. (if (member (intern (substring dc1 0 -1)) org-hidden-keywords)
  4428. '(font-lock-fontified t invisible t)
  4429. '(font-lock-fontified t face org-document-info-keyword)))
  4430. (add-text-properties
  4431. (match-beginning 6) (match-end 6)
  4432. (if (string-equal dc1 "title:")
  4433. '(font-lock-fontified t face org-document-title)
  4434. '(font-lock-fontified t face org-document-info))))
  4435. ((not (member (char-after beg) '(?\ ?\t)))
  4436. ;; just any other in-buffer setting, but not indented
  4437. (add-text-properties
  4438. beg (match-end 0)
  4439. '(font-lock-fontified t face org-meta-line))
  4440. t)
  4441. ((or (member dc1 '("begin:" "end:" "caption:" "label:"
  4442. "orgtbl:" "tblfm:" "tblname:" "result:"
  4443. "results:" "source:" "srcname:" "call:"))
  4444. (and (match-end 4) (equal dc3 "attr")))
  4445. (add-text-properties
  4446. beg (match-end 0)
  4447. '(font-lock-fontified t face org-meta-line))
  4448. t)
  4449. ((member dc3 '(" " ""))
  4450. (add-text-properties
  4451. beg (match-end 0)
  4452. '(font-lock-fontified t face font-lock-comment-face)))
  4453. (t nil))))))
  4454. (defun org-activate-angle-links (limit)
  4455. "Run through the buffer and add overlays to links."
  4456. (if (re-search-forward org-angle-link-re limit t)
  4457. (progn
  4458. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4459. (add-text-properties (match-beginning 0) (match-end 0)
  4460. (list 'mouse-face 'highlight
  4461. 'keymap org-mouse-map))
  4462. (org-rear-nonsticky-at (match-end 0))
  4463. t)))
  4464. (defun org-activate-footnote-links (limit)
  4465. "Run through the buffer and add overlays to links."
  4466. (if (re-search-forward "\\(^\\|[^][]\\)\\(\\[\\([0-9]+\\]\\|fn:[^ \t\r\n:]+?[]:]\\)\\)"
  4467. limit t)
  4468. (progn
  4469. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4470. (add-text-properties (match-beginning 2) (match-end 2)
  4471. (list 'mouse-face 'highlight
  4472. 'keymap org-mouse-map
  4473. 'help-echo
  4474. (if (= (point-at-bol) (match-beginning 2))
  4475. "Footnote definition"
  4476. "Footnote reference")
  4477. ))
  4478. (org-rear-nonsticky-at (match-end 2))
  4479. t)))
  4480. (defun org-activate-bracket-links (limit)
  4481. "Run through the buffer and add overlays to bracketed links."
  4482. (if (re-search-forward org-bracket-link-regexp limit t)
  4483. (let* ((help (concat "LINK: "
  4484. (org-match-string-no-properties 1)))
  4485. ;; FIXME: above we should remove the escapes.
  4486. ;; but that requires another match, protecting match data,
  4487. ;; a lot of overhead for font-lock.
  4488. (ip (org-maybe-intangible
  4489. (list 'invisible 'org-link
  4490. 'keymap org-mouse-map 'mouse-face 'highlight
  4491. 'font-lock-multiline t 'help-echo help)))
  4492. (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
  4493. 'font-lock-multiline t 'help-echo help)))
  4494. ;; We need to remove the invisible property here. Table narrowing
  4495. ;; may have made some of this invisible.
  4496. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4497. (remove-text-properties (match-beginning 0) (match-end 0)
  4498. '(invisible nil))
  4499. (if (match-end 3)
  4500. (progn
  4501. (add-text-properties (match-beginning 0) (match-beginning 3) ip)
  4502. (org-rear-nonsticky-at (match-beginning 3))
  4503. (add-text-properties (match-beginning 3) (match-end 3) vp)
  4504. (org-rear-nonsticky-at (match-end 3))
  4505. (add-text-properties (match-end 3) (match-end 0) ip)
  4506. (org-rear-nonsticky-at (match-end 0)))
  4507. (add-text-properties (match-beginning 0) (match-beginning 1) ip)
  4508. (org-rear-nonsticky-at (match-beginning 1))
  4509. (add-text-properties (match-beginning 1) (match-end 1) vp)
  4510. (org-rear-nonsticky-at (match-end 1))
  4511. (add-text-properties (match-end 1) (match-end 0) ip)
  4512. (org-rear-nonsticky-at (match-end 0)))
  4513. t)))
  4514. (defun org-activate-dates (limit)
  4515. "Run through the buffer and add overlays to dates."
  4516. (if (re-search-forward org-tsr-regexp-both limit t)
  4517. (progn
  4518. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4519. (add-text-properties (match-beginning 0) (match-end 0)
  4520. (list 'mouse-face 'highlight
  4521. 'keymap org-mouse-map))
  4522. (org-rear-nonsticky-at (match-end 0))
  4523. (when org-display-custom-times
  4524. (if (match-end 3)
  4525. (org-display-custom-time (match-beginning 3) (match-end 3)))
  4526. (org-display-custom-time (match-beginning 1) (match-end 1)))
  4527. t)))
  4528. (defvar org-target-link-regexp nil
  4529. "Regular expression matching radio targets in plain text.")
  4530. (make-variable-buffer-local 'org-target-link-regexp)
  4531. (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
  4532. "Regular expression matching a link target.")
  4533. (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
  4534. "Regular expression matching a radio target.")
  4535. (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
  4536. "Regular expression matching any target.")
  4537. (defun org-activate-target-links (limit)
  4538. "Run through the buffer and add overlays to target matches."
  4539. (when org-target-link-regexp
  4540. (let ((case-fold-search t))
  4541. (if (re-search-forward org-target-link-regexp limit t)
  4542. (progn
  4543. (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
  4544. (add-text-properties (match-beginning 0) (match-end 0)
  4545. (list 'mouse-face 'highlight
  4546. 'keymap org-mouse-map
  4547. 'help-echo "Radio target link"
  4548. 'org-linked-text t))
  4549. (org-rear-nonsticky-at (match-end 0))
  4550. t)))))
  4551. (defun org-update-radio-target-regexp ()
  4552. "Find all radio targets in this file and update the regular expression."
  4553. (interactive)
  4554. (when (memq 'radio org-activate-links)
  4555. (setq org-target-link-regexp
  4556. (org-make-target-link-regexp (org-all-targets 'radio)))
  4557. (org-restart-font-lock)))
  4558. (defun org-hide-wide-columns (limit)
  4559. (let (s e)
  4560. (setq s (text-property-any (point) (or limit (point-max))
  4561. 'org-cwidth t))
  4562. (when s
  4563. (setq e (next-single-property-change s 'org-cwidth))
  4564. (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
  4565. (goto-char e)
  4566. t)))
  4567. (defvar org-latex-and-specials-regexp nil
  4568. "Regular expression for highlighting export special stuff.")
  4569. (defvar org-match-substring-regexp)
  4570. (defvar org-match-substring-with-braces-regexp)
  4571. ;; This should be with the exporter code, but we also use if for font-locking
  4572. (defconst org-export-html-special-string-regexps
  4573. '(("\\\\-" . "&shy;")
  4574. ("---\\([^-]\\)" . "&mdash;\\1")
  4575. ("--\\([^-]\\)" . "&ndash;\\1")
  4576. ("\\.\\.\\." . "&hellip;"))
  4577. "Regular expressions for special string conversion.")
  4578. (defun org-compute-latex-and-specials-regexp ()
  4579. "Compute regular expression for stuff treated specially by exporters."
  4580. (if (not org-highlight-latex-fragments-and-specials)
  4581. (org-set-local 'org-latex-and-specials-regexp nil)
  4582. (require 'org-exp)
  4583. (let*
  4584. ((matchers (plist-get org-format-latex-options :matchers))
  4585. (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
  4586. org-latex-regexps)))
  4587. (org-export-allow-BIND nil)
  4588. (options (org-combine-plists (org-default-export-plist)
  4589. (org-infile-export-plist)))
  4590. (org-export-with-sub-superscripts (plist-get options :sub-superscript))
  4591. (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
  4592. (org-export-with-TeX-macros (plist-get options :TeX-macros))
  4593. (org-export-html-expand (plist-get options :expand-quoted-html))
  4594. (org-export-with-special-strings (plist-get options :special-strings))
  4595. (re-sub
  4596. (cond
  4597. ((equal org-export-with-sub-superscripts '{})
  4598. (list org-match-substring-with-braces-regexp))
  4599. (org-export-with-sub-superscripts
  4600. (list org-match-substring-regexp))
  4601. (t nil)))
  4602. (re-latex
  4603. (if org-export-with-LaTeX-fragments
  4604. (mapcar (lambda (x) (nth 1 x)) latexs)))
  4605. (re-macros
  4606. (if org-export-with-TeX-macros
  4607. (list (concat "\\\\"
  4608. (regexp-opt
  4609. (append
  4610. (delq nil
  4611. (mapcar 'car-safe
  4612. (append org-entities-user
  4613. org-entities)))
  4614. (if (boundp 'org-latex-entities)
  4615. (mapcar (lambda (x)
  4616. (or (car-safe x) x))
  4617. org-latex-entities)
  4618. nil))
  4619. 'words))) ; FIXME
  4620. ))
  4621. ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
  4622. (re-special (if org-export-with-special-strings
  4623. (mapcar (lambda (x) (car x))
  4624. org-export-html-special-string-regexps)))
  4625. (re-rest
  4626. (delq nil
  4627. (list
  4628. (if org-export-html-expand "@<[^>\n]+>")
  4629. ))))
  4630. (org-set-local
  4631. 'org-latex-and-specials-regexp
  4632. (mapconcat 'identity (append re-latex re-sub re-macros re-special
  4633. re-rest) "\\|")))))
  4634. (defun org-do-latex-and-special-faces (limit)
  4635. "Run through the buffer and add overlays to links."
  4636. (when org-latex-and-specials-regexp
  4637. (let (rtn d)
  4638. (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
  4639. limit t))
  4640. (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
  4641. 'face))
  4642. '(org-code org-verbatim underline)))
  4643. (progn
  4644. (setq rtn t
  4645. d (cond ((member (char-after (1+ (match-beginning 0)))
  4646. '(?_ ?^)) 1)
  4647. (t 0)))
  4648. (font-lock-prepend-text-property
  4649. (+ d (match-beginning 0)) (match-end 0)
  4650. 'face 'org-latex-and-export-specials)
  4651. (add-text-properties (+ d (match-beginning 0)) (match-end 0)
  4652. '(font-lock-multiline t)))))
  4653. rtn)))
  4654. (defun org-restart-font-lock ()
  4655. "Restart font-lock-mode, to force refontification."
  4656. (when (and (boundp 'font-lock-mode) font-lock-mode)
  4657. (font-lock-mode -1)
  4658. (font-lock-mode 1)))
  4659. (defun org-all-targets (&optional radio)
  4660. "Return a list of all targets in this file.
  4661. With optional argument RADIO, only find radio targets."
  4662. (let ((re (if radio org-radio-target-regexp org-target-regexp))
  4663. rtn)
  4664. (save-excursion
  4665. (goto-char (point-min))
  4666. (while (re-search-forward re nil t)
  4667. (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
  4668. rtn)))
  4669. (defun org-make-target-link-regexp (targets)
  4670. "Make regular expression matching all strings in TARGETS.
  4671. The regular expression finds the targets also if there is a line break
  4672. between words."
  4673. (and targets
  4674. (concat
  4675. "\\<\\("
  4676. (mapconcat
  4677. (lambda (x)
  4678. (while (string-match " +" x)
  4679. (setq x (replace-match "\\s-+" t t x)))
  4680. x)
  4681. targets
  4682. "\\|")
  4683. "\\)\\>")))
  4684. (defun org-activate-tags (limit)
  4685. (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \r\n]") limit t)
  4686. (progn
  4687. (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
  4688. (add-text-properties (match-beginning 1) (match-end 1)
  4689. (list 'mouse-face 'highlight
  4690. 'keymap org-mouse-map))
  4691. (org-rear-nonsticky-at (match-end 1))
  4692. t)))
  4693. (defun org-outline-level ()
  4694. "Compute the outline level of the heading at point.
  4695. This function assumes that the cursor is at the beginning of a line matched
  4696. by outline-regexp. Otherwise it returns garbage.
  4697. If this is called at a normal headline, the level is the number of stars.
  4698. Use `org-reduced-level' to remove the effect of `org-odd-levels'.
  4699. For plain list items, if they are matched by `outline-regexp', this returns
  4700. 1000 plus the line indentation."
  4701. (save-excursion
  4702. (looking-at outline-regexp)
  4703. (if (match-beginning 1)
  4704. (+ (org-get-string-indentation (match-string 1)) 1000)
  4705. (1- (- (match-end 0) (match-beginning 0))))))
  4706. (defvar org-font-lock-keywords nil)
  4707. (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
  4708. "Regular expression matching a property line.")
  4709. (defvar org-font-lock-hook nil
  4710. "Functions to be called for special font lock stuff.")
  4711. (defun org-font-lock-hook (limit)
  4712. (run-hook-with-args 'org-font-lock-hook limit))
  4713. (defun org-set-font-lock-defaults ()
  4714. (let* ((em org-fontify-emphasized-text)
  4715. (lk org-activate-links)
  4716. (org-font-lock-extra-keywords
  4717. (list
  4718. ;; Call the hook
  4719. '(org-font-lock-hook)
  4720. ;; Headlines
  4721. `(,(if org-fontify-whole-heading-line
  4722. "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
  4723. "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
  4724. (1 (org-get-level-face 1))
  4725. (2 (org-get-level-face 2))
  4726. (3 (org-get-level-face 3)))
  4727. ;; Table lines
  4728. '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
  4729. (1 'org-table t))
  4730. ;; Table internals
  4731. '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
  4732. '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
  4733. '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
  4734. '("| *\\(<[lr]?[0-9]*>\\)" (1 'org-formula t))
  4735. ;; Drawers
  4736. (list org-drawer-regexp '(0 'org-special-keyword t))
  4737. (list "^[ \t]*:END:" '(0 'org-special-keyword t))
  4738. ;; Properties
  4739. (list org-property-re
  4740. '(1 'org-special-keyword t)
  4741. '(3 'org-property-value t))
  4742. ;; Links
  4743. (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
  4744. (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
  4745. (if (memq 'plain lk) '(org-activate-plain-links))
  4746. (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
  4747. (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
  4748. (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
  4749. (if (memq 'footnote lk) '(org-activate-footnote-links
  4750. (2 'org-footnote t)))
  4751. '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
  4752. '(org-hide-wide-columns (0 nil append))
  4753. ;; TODO lines
  4754. (list (concat "^\\*+[ \t]+" org-todo-regexp "\\([ \t]\\|$\\)")
  4755. '(1 (org-get-todo-face 1) t))
  4756. ;; DONE
  4757. (if org-fontify-done-headline
  4758. (list (concat "^[*]+ +\\<\\("
  4759. (mapconcat 'regexp-quote org-done-keywords "\\|")
  4760. "\\)\\(.*\\)")
  4761. '(2 'org-headline-done t))
  4762. nil)
  4763. ;; Priorities
  4764. '(org-font-lock-add-priority-faces)
  4765. ;; Tags
  4766. '(org-font-lock-add-tag-faces)
  4767. ;; Special keywords
  4768. (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
  4769. (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
  4770. (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
  4771. (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
  4772. ;; Emphasis
  4773. (if em
  4774. (if (featurep 'xemacs)
  4775. '(org-do-emphasis-faces (0 nil append))
  4776. '(org-do-emphasis-faces)))
  4777. ;; Checkboxes
  4778. '("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(\\[[- X]\\]\\)"
  4779. 2 'org-checkbox prepend)
  4780. (if org-provide-checkbox-statistics
  4781. '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
  4782. (0 (org-get-checkbox-statistics-face) t)))
  4783. ;; Description list items
  4784. '("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(.*? ::\\)"
  4785. 2 'bold prepend)
  4786. ;; ARCHIVEd headings
  4787. (list (concat "^\\*+ \\(.*:" org-archive-tag ":.*\\)")
  4788. '(1 'org-archived prepend))
  4789. ;; Specials
  4790. '(org-do-latex-and-special-faces)
  4791. '(org-fontify-entities)
  4792. '(org-raise-scripts)
  4793. ;; Code
  4794. '(org-activate-code (1 'org-code t))
  4795. ;; COMMENT
  4796. (list (concat "^\\*+[ \t]+\\<\\(" org-comment-string
  4797. "\\|" org-quote-string "\\)\\>")
  4798. '(1 'org-special-keyword t))
  4799. '("^#.*" (0 'font-lock-comment-face t))
  4800. ;; Blocks and meta lines
  4801. '(org-fontify-meta-lines-and-blocks)
  4802. )))
  4803. (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
  4804. ;; Now set the full font-lock-keywords
  4805. (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
  4806. (org-set-local 'font-lock-defaults
  4807. '(org-font-lock-keywords t nil nil backward-paragraph))
  4808. (kill-local-variable 'font-lock-keywords) nil))
  4809. (defun org-toggle-pretty-entities ()
  4810. "Toggle the compostion display of entities as UTF8 characters."
  4811. (interactive)
  4812. (org-set-local 'org-pretty-entities (not org-pretty-entities))
  4813. (org-restart-font-lock)
  4814. (if org-pretty-entities
  4815. (message "Entities are displayed as UTF8 characers")
  4816. (save-restriction
  4817. (widen)
  4818. (decompose-region (point-min) (point-max))
  4819. (message "Entities are displayed plain"))))
  4820. (defun org-fontify-entities (limit)
  4821. "Find an entity to fontify."
  4822. (let (ee)
  4823. (when org-pretty-entities
  4824. (catch 'match
  4825. (while (re-search-forward
  4826. "\\\\\\([a-zA-Z][a-zA-Z0-9]*\\)\\($\\|[^[:alnum:]\n]\\)"
  4827. limit t)
  4828. (if (and (not (org-in-indented-comment-line))
  4829. (setq ee (org-entity-get (match-string 1)))
  4830. (= (length (nth 6 ee)) 1))
  4831. (progn
  4832. (add-text-properties
  4833. (match-beginning 0) (match-end 1)
  4834. (list 'font-lock-fontified t))
  4835. (compose-region (match-beginning 0) (match-end 1)
  4836. (nth 6 ee) nil)
  4837. (backward-char 1)
  4838. (throw 'match t))))
  4839. nil))))
  4840. (defun org-fontify-like-in-org-mode (s &optional odd-levels)
  4841. "Fontify string S like in Org-mode"
  4842. (with-temp-buffer
  4843. (insert s)
  4844. (let ((org-odd-levels-only odd-levels))
  4845. (org-mode)
  4846. (font-lock-fontify-buffer)
  4847. (buffer-string))))
  4848. (defvar org-m nil)
  4849. (defvar org-l nil)
  4850. (defvar org-f nil)
  4851. (defun org-get-level-face (n)
  4852. "Get the right face for match N in font-lock matching of headlines."
  4853. (setq org-l (- (match-end 2) (match-beginning 1) 1))
  4854. (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
  4855. (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
  4856. (cond
  4857. ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
  4858. ((eq n 2) org-f)
  4859. (t (if org-level-color-stars-only nil org-f))))
  4860. (defun org-get-todo-face (kwd)
  4861. "Get the right face for a TODO keyword KWD.
  4862. If KWD is a number, get the corresponding match group."
  4863. (if (numberp kwd) (setq kwd (match-string kwd)))
  4864. (or (org-face-from-face-or-color
  4865. 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
  4866. (and (member kwd org-done-keywords) 'org-done)
  4867. 'org-todo))
  4868. (defun org-face-from-face-or-color (context inherit face-or-color)
  4869. "Create a face list that inherits INHERIT, but sets the foreground color.
  4870. When FACE-OR-COLOR is not a string, just return it."
  4871. (if (stringp face-or-color)
  4872. (list :inherit inherit
  4873. (cdr (assoc context org-faces-easy-properties))
  4874. face-or-color)
  4875. face-or-color))
  4876. (defun org-font-lock-add-tag-faces (limit)
  4877. "Add the special tag faces."
  4878. (when (and org-tag-faces org-tags-special-faces-re)
  4879. (while (re-search-forward org-tags-special-faces-re limit t)
  4880. (add-text-properties (match-beginning 1) (match-end 1)
  4881. (list 'face (org-get-tag-face 1)
  4882. 'font-lock-fontified t))
  4883. (backward-char 1))))
  4884. (defun org-font-lock-add-priority-faces (limit)
  4885. "Add the special priority faces."
  4886. (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
  4887. (add-text-properties
  4888. (match-beginning 0) (match-end 0)
  4889. (list 'face (or (org-face-from-face-or-color
  4890. 'priority 'org-special-keyword
  4891. (cdr (assoc (char-after (match-beginning 1))
  4892. org-priority-faces)))
  4893. 'org-special-keyword)
  4894. 'font-lock-fontified t))))
  4895. (defun org-get-tag-face (kwd)
  4896. "Get the right face for a TODO keyword KWD.
  4897. If KWD is a number, get the corresponding match group."
  4898. (if (numberp kwd) (setq kwd (match-string kwd)))
  4899. (or (org-face-from-face-or-color
  4900. 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
  4901. 'org-tag))
  4902. (defun org-unfontify-region (beg end &optional maybe_loudly)
  4903. "Remove fontification and activation overlays from links."
  4904. (font-lock-default-unfontify-region beg end)
  4905. (let* ((buffer-undo-list t)
  4906. (inhibit-read-only t) (inhibit-point-motion-hooks t)
  4907. (inhibit-modification-hooks t)
  4908. deactivate-mark buffer-file-name buffer-file-truename)
  4909. (decompose-region beg end)
  4910. (remove-text-properties
  4911. beg end
  4912. (if org-indent-mode
  4913. ;; also remove line-prefix and wrap-prefix properties
  4914. '(mouse-face t keymap t org-linked-text t
  4915. invisible t intangible t
  4916. line-prefix t wrap-prefix t
  4917. org-no-flyspell t org-emphasis t)
  4918. '(mouse-face t keymap t org-linked-text t
  4919. invisible t intangible t
  4920. org-no-flyspell t org-emphasis t)))
  4921. (org-remove-font-lock-display-properties beg end)))
  4922. (defconst org-script-display '(((raise -0.3) (height 0.7))
  4923. ((raise 0.3) (height 0.7))
  4924. ((raise -0.5))
  4925. ((raise 0.5)))
  4926. "Display properties for showing superscripts and subscripts.")
  4927. (defun org-remove-font-lock-display-properties (beg end)
  4928. "Remove specific display properties that have been added by font lock.
  4929. The will remove the raise properties that are used to show superscripts
  4930. and subscriipts."
  4931. (let (next prop)
  4932. (while (< beg end)
  4933. (setq next (next-single-property-change beg 'display nil end)
  4934. prop (get-text-property beg 'display))
  4935. (if (member prop org-script-display)
  4936. (put-text-property beg next 'display nil))
  4937. (setq beg next))))
  4938. (defun org-raise-scripts (limit)
  4939. "Add raise properties to sub/superscripts."
  4940. (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
  4941. (if (re-search-forward
  4942. (if (eq org-use-sub-superscripts t)
  4943. org-match-substring-regexp
  4944. org-match-substring-with-braces-regexp)
  4945. limit t)
  4946. (let* ((pos (point)) table-p comment-p
  4947. (mpos (match-beginning 3))
  4948. (emph-p (get-text-property mpos 'org-emphasis))
  4949. (link-p (get-text-property mpos 'mouse-face))
  4950. (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
  4951. (goto-char (point-at-bol))
  4952. (setq table-p (org-looking-at-p org-table-dataline-regexp)
  4953. comment-p (org-looking-at-p "[ \t]*#"))
  4954. (goto-char pos)
  4955. (if (or comment-p emph-p link-p keyw-p)
  4956. t
  4957. (put-text-property (match-beginning 3) (match-end 0)
  4958. 'display
  4959. (if (equal (char-after (match-beginning 2)) ?^)
  4960. (nth (if table-p 3 1) org-script-display)
  4961. (nth (if table-p 2 0) org-script-display)))
  4962. (add-text-properties (match-beginning 2) (match-end 2)
  4963. (list 'invisible t
  4964. 'org-dwidth t 'org-dwidth-n 1))
  4965. (if (and (eq (char-after (match-beginning 3)) ?{)
  4966. (eq (char-before (match-end 3)) ?}))
  4967. (progn
  4968. (add-text-properties
  4969. (match-beginning 3) (1+ (match-beginning 3))
  4970. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
  4971. (add-text-properties
  4972. (1- (match-end 3)) (match-end 3)
  4973. (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
  4974. t)))))
  4975. ;;;; Visibility cycling, including org-goto and indirect buffer
  4976. ;;; Cycling
  4977. (defvar org-cycle-global-status nil)
  4978. (make-variable-buffer-local 'org-cycle-global-status)
  4979. (defvar org-cycle-subtree-status nil)
  4980. (make-variable-buffer-local 'org-cycle-subtree-status)
  4981. ;;;###autoload
  4982. (defvar org-inlinetask-min-level)
  4983. (defun org-cycle (&optional arg)
  4984. "TAB-action and visibility cycling for Org-mode.
  4985. This is the command invoked in Org-mode by the TAB key. Its main purpose
  4986. is outline visibility cycling, but it also invokes other actions
  4987. in special contexts.
  4988. - When this function is called with a prefix argument, rotate the entire
  4989. buffer through 3 states (global cycling)
  4990. 1. OVERVIEW: Show only top-level headlines.
  4991. 2. CONTENTS: Show all headlines of all levels, but no body text.
  4992. 3. SHOW ALL: Show everything.
  4993. When called with two `C-u C-u' prefixes, switch to the startup visibility,
  4994. determined by the variable `org-startup-folded', and by any VISIBILITY
  4995. properties in the buffer.
  4996. When called with three `C-u C-u C-u' prefixed, show the entire buffer,
  4997. including any drawers.
  4998. - When inside a table, re-align the table and move to the next field.
  4999. - When point is at the beginning of a headline, rotate the subtree started
  5000. by this line through 3 different states (local cycling)
  5001. 1. FOLDED: Only the main headline is shown.
  5002. 2. CHILDREN: The main headline and the direct children are shown.
  5003. From this state, you can move to one of the children
  5004. and zoom in further.
  5005. 3. SUBTREE: Show the entire subtree, including body text.
  5006. If there is no subtree, switch directly from CHILDREN to FOLDED.
  5007. - When point is at the beginning of an empty headline and the variable
  5008. `org-cycle-level-after-item/entry-creation' is set, cycle the level
  5009. of the headline by demoting and promoting it to likely levels. This
  5010. speeds up creation document structure by presing TAB once or several
  5011. times right after creating a new headline.
  5012. - When there is a numeric prefix, go up to a heading with level ARG, do
  5013. a `show-subtree' and return to the previous cursor position. If ARG
  5014. is negative, go up that many levels.
  5015. - When point is not at the beginning of a headline, execute the global
  5016. binding for TAB, which is re-indenting the line. See the option
  5017. `org-cycle-emulate-tab' for details.
  5018. - Special case: if point is at the beginning of the buffer and there is
  5019. no headline in line 1, this function will act as if called with prefix arg.
  5020. But only if also the variable `org-cycle-global-at-bob' is t."
  5021. (interactive "P")
  5022. (org-load-modules-maybe)
  5023. (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
  5024. (and org-cycle-level-after-item/entry-creation
  5025. (or (org-cycle-level)
  5026. (org-cycle-item-indentation))))
  5027. (let* ((limit-level
  5028. (or org-cycle-max-level
  5029. (and (boundp 'org-inlinetask-min-level)
  5030. org-inlinetask-min-level
  5031. (1- org-inlinetask-min-level))))
  5032. (nstars (and limit-level
  5033. (if org-odd-levels-only
  5034. (and limit-level (1- (* limit-level 2)))
  5035. limit-level)))
  5036. (outline-regexp
  5037. (cond
  5038. ((not (org-mode-p)) outline-regexp)
  5039. ((or (eq org-cycle-include-plain-lists 'integrate)
  5040. (and org-cycle-include-plain-lists (org-at-item-p)))
  5041. (concat "\\(?:\\*"
  5042. (if nstars (format "\\{1,%d\\}" nstars) "+")
  5043. " \\|\\([ \t]*\\)\\([-+*]\\|[0-9]+[.)]\\) \\)"))
  5044. (t (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ ")))))
  5045. (bob-special (and org-cycle-global-at-bob (bobp)
  5046. (not (looking-at outline-regexp))))
  5047. (org-cycle-hook
  5048. (if bob-special
  5049. (delq 'org-optimize-window-after-visibility-change
  5050. (copy-sequence org-cycle-hook))
  5051. org-cycle-hook))
  5052. (pos (point)))
  5053. (if (or bob-special (equal arg '(4)))
  5054. ;; special case: use global cycling
  5055. (setq arg t))
  5056. (cond
  5057. ((equal arg '(16))
  5058. (org-set-startup-visibility)
  5059. (message "Startup visibility, plus VISIBILITY properties"))
  5060. ((equal arg '(64))
  5061. (show-all)
  5062. (message "Entire buffer visible, including drawers"))
  5063. ((org-at-table-p 'any)
  5064. ;; Enter the table or move to the next field in the table
  5065. (if (org-at-table.el-p)
  5066. (message "Use C-c ' to edit table.el tables")
  5067. (if arg (org-table-edit-field t)
  5068. (org-table-justify-field-maybe)
  5069. (call-interactively 'org-table-next-field))))
  5070. ((run-hook-with-args-until-success
  5071. 'org-tab-after-check-for-table-hook))
  5072. ((eq arg t) ;; Global cycling
  5073. (org-cycle-internal-global))
  5074. ((and org-drawers org-drawer-regexp
  5075. (save-excursion
  5076. (beginning-of-line 1)
  5077. (looking-at org-drawer-regexp)))
  5078. ;; Toggle block visibility
  5079. (org-flag-drawer
  5080. (not (get-char-property (match-end 0) 'invisible))))
  5081. ((integerp arg)
  5082. ;; Show-subtree, ARG levels up from here.
  5083. (save-excursion
  5084. (org-back-to-heading)
  5085. (outline-up-heading (if (< arg 0) (- arg)
  5086. (- (funcall outline-level) arg)))
  5087. (org-show-subtree)))
  5088. ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
  5089. (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
  5090. (org-cycle-internal-local))
  5091. ;; TAB emulation and template completion
  5092. (buffer-read-only (org-back-to-heading))
  5093. ((run-hook-with-args-until-success
  5094. 'org-tab-after-check-for-cycling-hook))
  5095. ((org-try-structure-completion))
  5096. ((org-try-cdlatex-tab))
  5097. ((run-hook-with-args-until-success
  5098. 'org-tab-before-tab-emulation-hook))
  5099. ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
  5100. (or (not (bolp))
  5101. (not (looking-at outline-regexp))))
  5102. (call-interactively (global-key-binding "\t")))
  5103. ((if (and (memq org-cycle-emulate-tab '(white whitestart))
  5104. (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
  5105. (or (and (eq org-cycle-emulate-tab 'white)
  5106. (= (match-end 0) (point-at-eol)))
  5107. (and (eq org-cycle-emulate-tab 'whitestart)
  5108. (>= (match-end 0) pos))))
  5109. t
  5110. (eq org-cycle-emulate-tab t))
  5111. (call-interactively (global-key-binding "\t")))
  5112. (t (save-excursion
  5113. (org-back-to-heading)
  5114. (org-cycle)))))))
  5115. (defun org-cycle-internal-global ()
  5116. "Do the global cycling action."
  5117. (cond
  5118. ((and (eq last-command this-command)
  5119. (eq org-cycle-global-status 'overview))
  5120. ;; We just created the overview - now do table of contents
  5121. ;; This can be slow in very large buffers, so indicate action
  5122. (run-hook-with-args 'org-pre-cycle-hook 'contents)
  5123. (message "CONTENTS...")
  5124. (org-content)
  5125. (message "CONTENTS...done")
  5126. (setq org-cycle-global-status 'contents)
  5127. (run-hook-with-args 'org-cycle-hook 'contents))
  5128. ((and (eq last-command this-command)
  5129. (eq org-cycle-global-status 'contents))
  5130. ;; We just showed the table of contents - now show everything
  5131. (run-hook-with-args 'org-pre-cycle-hook 'all)
  5132. (show-all)
  5133. (message "SHOW ALL")
  5134. (setq org-cycle-global-status 'all)
  5135. (run-hook-with-args 'org-cycle-hook 'all))
  5136. (t
  5137. ;; Default action: go to overview
  5138. (run-hook-with-args 'org-pre-cycle-hook 'overview)
  5139. (org-overview)
  5140. (message "OVERVIEW")
  5141. (setq org-cycle-global-status 'overview)
  5142. (run-hook-with-args 'org-cycle-hook 'overview))))
  5143. (defun org-cycle-internal-local ()
  5144. "Do the local cycling action."
  5145. (org-back-to-heading)
  5146. (let ((goal-column 0) eoh eol eos level has-children children-skipped)
  5147. ;; First, some boundaries
  5148. (save-excursion
  5149. (org-back-to-heading)
  5150. (setq level (funcall outline-level))
  5151. (save-excursion
  5152. (beginning-of-line 2)
  5153. (if (or (featurep 'xemacs) (<= emacs-major-version 21))
  5154. ; XEmacs does not have `next-single-char-property-change'
  5155. ; I'm not sure about Emacs 21.
  5156. (while (and (not (eobp)) ;; this is like `next-line'
  5157. (get-char-property (1- (point)) 'invisible))
  5158. (beginning-of-line 2))
  5159. (while (and (not (eobp)) ;; this is like `next-line'
  5160. (get-char-property (1- (point)) 'invisible))
  5161. (goto-char (next-single-char-property-change (point) 'invisible))
  5162. (and (eolp) (beginning-of-line 2))))
  5163. (setq eol (point)))
  5164. (outline-end-of-heading) (setq eoh (point))
  5165. (save-excursion
  5166. (outline-next-heading)
  5167. (setq has-children (and (org-at-heading-p t)
  5168. (> (funcall outline-level) level))))
  5169. (org-end-of-subtree t)
  5170. (unless (eobp)
  5171. (skip-chars-forward " \t\n")
  5172. (beginning-of-line 1) ; in case this is an item
  5173. )
  5174. (setq eos (if (eobp) (point) (1- (point)))))
  5175. ;; Find out what to do next and set `this-command'
  5176. (cond
  5177. ((= eos eoh)
  5178. ;; Nothing is hidden behind this heading
  5179. (run-hook-with-args 'org-pre-cycle-hook 'empty)
  5180. (message "EMPTY ENTRY")
  5181. (setq org-cycle-subtree-status nil)
  5182. (save-excursion
  5183. (goto-char eos)
  5184. (outline-next-heading)
  5185. (if (org-invisible-p) (org-flag-heading nil))))
  5186. ((and (or (>= eol eos)
  5187. (not (string-match "\\S-" (buffer-substring eol eos))))
  5188. (or has-children
  5189. (not (setq children-skipped
  5190. org-cycle-skip-children-state-if-no-children))))
  5191. ;; Entire subtree is hidden in one line: children view
  5192. (run-hook-with-args 'org-pre-cycle-hook 'children)
  5193. (org-show-entry)
  5194. (show-children)
  5195. (message "CHILDREN")
  5196. (save-excursion
  5197. (goto-char eos)
  5198. (outline-next-heading)
  5199. (if (org-invisible-p) (org-flag-heading nil)))
  5200. (setq org-cycle-subtree-status 'children)
  5201. (run-hook-with-args 'org-cycle-hook 'children))
  5202. ((or children-skipped
  5203. (and (eq last-command this-command)
  5204. (eq org-cycle-subtree-status 'children)))
  5205. ;; We just showed the children, or no children are there,
  5206. ;; now show everything.
  5207. (run-hook-with-args 'org-pre-cycle-hook 'subtree)
  5208. (org-show-subtree)
  5209. (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
  5210. (setq org-cycle-subtree-status 'subtree)
  5211. (run-hook-with-args 'org-cycle-hook 'subtree))
  5212. (t
  5213. ;; Default action: hide the subtree.
  5214. (run-hook-with-args 'org-pre-cycle-hook 'folded)
  5215. (hide-subtree)
  5216. (message "FOLDED")
  5217. (setq org-cycle-subtree-status 'folded)
  5218. (run-hook-with-args 'org-cycle-hook 'folded)))))
  5219. ;;;###autoload
  5220. (defun org-global-cycle (&optional arg)
  5221. "Cycle the global visibility. For details see `org-cycle'.
  5222. With C-u prefix arg, switch to startup visibility.
  5223. With a numeric prefix, show all headlines up to that level."
  5224. (interactive "P")
  5225. (let ((org-cycle-include-plain-lists
  5226. (if (org-mode-p) org-cycle-include-plain-lists nil)))
  5227. (cond
  5228. ((integerp arg)
  5229. (show-all)
  5230. (hide-sublevels arg)
  5231. (setq org-cycle-global-status 'contents))
  5232. ((equal arg '(4))
  5233. (org-set-startup-visibility)
  5234. (message "Startup visibility, plus VISIBILITY properties."))
  5235. (t
  5236. (org-cycle '(4))))))
  5237. (defun org-set-startup-visibility ()
  5238. "Set the visibility required by startup options and properties."
  5239. (cond
  5240. ((eq org-startup-folded t)
  5241. (org-cycle '(4)))
  5242. ((eq org-startup-folded 'content)
  5243. (let ((this-command 'org-cycle) (last-command 'org-cycle))
  5244. (org-cycle '(4)) (org-cycle '(4)))))
  5245. (unless (eq org-startup-folded 'showeverything)
  5246. (if org-hide-block-startup (org-hide-block-all))
  5247. (org-set-visibility-according-to-property 'no-cleanup)
  5248. (org-cycle-hide-archived-subtrees 'all)
  5249. (org-cycle-hide-drawers 'all)
  5250. (org-cycle-show-empty-lines t)))
  5251. (defun org-set-visibility-according-to-property (&optional no-cleanup)
  5252. "Switch subtree visibilities according to :VISIBILITY: property."
  5253. (interactive)
  5254. (let (org-show-entry-below state)
  5255. (save-excursion
  5256. (goto-char (point-min))
  5257. (while (re-search-forward
  5258. "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
  5259. nil t)
  5260. (setq state (match-string 1))
  5261. (save-excursion
  5262. (org-back-to-heading t)
  5263. (hide-subtree)
  5264. (org-reveal)
  5265. (cond
  5266. ((equal state '("fold" "folded"))
  5267. (hide-subtree))
  5268. ((equal state "children")
  5269. (org-show-hidden-entry)
  5270. (show-children))
  5271. ((equal state "content")
  5272. (save-excursion
  5273. (save-restriction
  5274. (org-narrow-to-subtree)
  5275. (org-content))))
  5276. ((member state '("all" "showall"))
  5277. (show-subtree)))))
  5278. (unless no-cleanup
  5279. (org-cycle-hide-archived-subtrees 'all)
  5280. (org-cycle-hide-drawers 'all)
  5281. (org-cycle-show-empty-lines 'all)))))
  5282. (defun org-overview ()
  5283. "Switch to overview mode, showing only top-level headlines.
  5284. Really, this shows all headlines with level equal or greater than the level
  5285. of the first headline in the buffer. This is important, because if the
  5286. first headline is not level one, then (hide-sublevels 1) gives confusing
  5287. results."
  5288. (interactive)
  5289. (let ((level (save-excursion
  5290. (goto-char (point-min))
  5291. (if (re-search-forward (concat "^" outline-regexp) nil t)
  5292. (progn
  5293. (goto-char (match-beginning 0))
  5294. (funcall outline-level))))))
  5295. (and level (hide-sublevels level))))
  5296. (defun org-content (&optional arg)
  5297. "Show all headlines in the buffer, like a table of contents.
  5298. With numerical argument N, show content up to level N."
  5299. (interactive "P")
  5300. (save-excursion
  5301. ;; Visit all headings and show their offspring
  5302. (and (integerp arg) (org-overview))
  5303. (goto-char (point-max))
  5304. (catch 'exit
  5305. (while (and (progn (condition-case nil
  5306. (outline-previous-visible-heading 1)
  5307. (error (goto-char (point-min))))
  5308. t)
  5309. (looking-at outline-regexp))
  5310. (if (integerp arg)
  5311. (show-children (1- arg))
  5312. (show-branches))
  5313. (if (bobp) (throw 'exit nil))))))
  5314. (defun org-optimize-window-after-visibility-change (state)
  5315. "Adjust the window after a change in outline visibility.
  5316. This function is the default value of the hook `org-cycle-hook'."
  5317. (when (get-buffer-window (current-buffer))
  5318. (cond
  5319. ((eq state 'content) nil)
  5320. ((eq state 'all) nil)
  5321. ((eq state 'folded) nil)
  5322. ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
  5323. ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
  5324. (defun org-remove-empty-overlays-at (pos)
  5325. "Remove outline overlays that do not contain non-white stuff."
  5326. (mapc
  5327. (lambda (o)
  5328. (and (eq 'outline (overlay-get o 'invisible))
  5329. (not (string-match "\\S-" (buffer-substring (overlay-start o)
  5330. (overlay-end o))))
  5331. (delete-overlay o)))
  5332. (overlays-at pos)))
  5333. (defun org-clean-visibility-after-subtree-move ()
  5334. "Fix visibility issues after moving a subtree."
  5335. ;; First, find a reasonable region to look at:
  5336. ;; Start two siblings above, end three below
  5337. (let* ((beg (save-excursion
  5338. (and (org-get-last-sibling)
  5339. (org-get-last-sibling))
  5340. (point)))
  5341. (end (save-excursion
  5342. (and (org-get-next-sibling)
  5343. (org-get-next-sibling)
  5344. (org-get-next-sibling))
  5345. (if (org-at-heading-p)
  5346. (point-at-eol)
  5347. (point))))
  5348. (level (looking-at "\\*+"))
  5349. (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
  5350. (save-excursion
  5351. (save-restriction
  5352. (narrow-to-region beg end)
  5353. (when re
  5354. ;; Properly fold already folded siblings
  5355. (goto-char (point-min))
  5356. (while (re-search-forward re nil t)
  5357. (if (and (not (org-invisible-p))
  5358. (save-excursion
  5359. (goto-char (point-at-eol)) (org-invisible-p)))
  5360. (hide-entry))))
  5361. (org-cycle-show-empty-lines 'overview)
  5362. (org-cycle-hide-drawers 'overview)))))
  5363. (defun org-cycle-show-empty-lines (state)
  5364. "Show empty lines above all visible headlines.
  5365. The region to be covered depends on STATE when called through
  5366. `org-cycle-hook'. Lisp program can use t for STATE to get the
  5367. entire buffer covered. Note that an empty line is only shown if there
  5368. are at least `org-cycle-separator-lines' empty lines before the headline."
  5369. (when (not (= org-cycle-separator-lines 0))
  5370. (save-excursion
  5371. (let* ((n (abs org-cycle-separator-lines))
  5372. (re (cond
  5373. ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
  5374. ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
  5375. (t (let ((ns (number-to-string (- n 2))))
  5376. (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
  5377. "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
  5378. beg end b e)
  5379. (cond
  5380. ((memq state '(overview contents t))
  5381. (setq beg (point-min) end (point-max)))
  5382. ((memq state '(children folded))
  5383. (setq beg (point) end (progn (org-end-of-subtree t t)
  5384. (beginning-of-line 2)
  5385. (point)))))
  5386. (when beg
  5387. (goto-char beg)
  5388. (while (re-search-forward re end t)
  5389. (unless (get-char-property (match-end 1) 'invisible)
  5390. (setq e (match-end 1))
  5391. (if (< org-cycle-separator-lines 0)
  5392. (setq b (save-excursion
  5393. (goto-char (match-beginning 0))
  5394. (org-back-over-empty-lines)
  5395. (if (save-excursion
  5396. (goto-char (max (point-min) (1- (point))))
  5397. (org-on-heading-p))
  5398. (1- (point))
  5399. (point))))
  5400. (setq b (match-beginning 1)))
  5401. (outline-flag-region b e nil)))))))
  5402. ;; Never hide empty lines at the end of the file.
  5403. (save-excursion
  5404. (goto-char (point-max))
  5405. (outline-previous-heading)
  5406. (outline-end-of-heading)
  5407. (if (and (looking-at "[ \t\n]+")
  5408. (= (match-end 0) (point-max)))
  5409. (outline-flag-region (point) (match-end 0) nil))))
  5410. (defun org-show-empty-lines-in-parent ()
  5411. "Move to the parent and re-show empty lines before visible headlines."
  5412. (save-excursion
  5413. (let ((context (if (org-up-heading-safe) 'children 'overview)))
  5414. (org-cycle-show-empty-lines context))))
  5415. (defun org-files-list ()
  5416. "Return `org-agenda-files' list, plus all open org-mode files.
  5417. This is useful for operations that need to scan all of a user's
  5418. open and agenda-wise Org files."
  5419. (let ((files (mapcar 'expand-file-name (org-agenda-files))))
  5420. (dolist (buf (buffer-list))
  5421. (with-current-buffer buf
  5422. (if (and (eq major-mode 'org-mode) (buffer-file-name))
  5423. (let ((file (expand-file-name (buffer-file-name))))
  5424. (unless (member file files)
  5425. (push file files))))))
  5426. files))
  5427. (defsubst org-entry-beginning-position ()
  5428. "Return the beginning position of the current entry."
  5429. (save-excursion (outline-back-to-heading t) (point)))
  5430. (defsubst org-entry-end-position ()
  5431. "Return the end position of the current entry."
  5432. (save-excursion (outline-next-heading) (point)))
  5433. (defun org-cycle-hide-drawers (state)
  5434. "Re-hide all drawers after a visibility state change."
  5435. (when (and (org-mode-p)
  5436. (not (memq state '(overview folded contents))))
  5437. (save-excursion
  5438. (let* ((globalp (memq state '(contents all)))
  5439. (beg (if globalp (point-min) (point)))
  5440. (end (if globalp (point-max)
  5441. (if (eq state 'children)
  5442. (save-excursion (outline-next-heading) (point))
  5443. (org-end-of-subtree t)))))
  5444. (goto-char beg)
  5445. (while (re-search-forward org-drawer-regexp end t)
  5446. (org-flag-drawer t))))))
  5447. (defun org-flag-drawer (flag)
  5448. (save-excursion
  5449. (beginning-of-line 1)
  5450. (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
  5451. (let ((b (match-end 0))
  5452. (outline-regexp org-outline-regexp))
  5453. (if (re-search-forward
  5454. "^[ \t]*:END:"
  5455. (save-excursion (outline-next-heading) (point)) t)
  5456. (outline-flag-region b (point-at-eol) flag)
  5457. (error ":END: line missing at position %s" b))))))
  5458. (defun org-subtree-end-visible-p ()
  5459. "Is the end of the current subtree visible?"
  5460. (pos-visible-in-window-p
  5461. (save-excursion (org-end-of-subtree t) (point))))
  5462. (defun org-first-headline-recenter (&optional N)
  5463. "Move cursor to the first headline and recenter the headline.
  5464. Optional argument N means put the headline into the Nth line of the window."
  5465. (goto-char (point-min))
  5466. (when (re-search-forward (concat "^\\(" outline-regexp "\\)") nil t)
  5467. (beginning-of-line)
  5468. (recenter (prefix-numeric-value N))))
  5469. ;;; Saving and restoring visibility
  5470. (defun org-outline-overlay-data (&optional use-markers)
  5471. "Return a list of the locations of all outline overlays.
  5472. The are overlays with the `invisible' property value `outline'.
  5473. The return valus is a list of cons cells, with start and stop
  5474. positions for each overlay.
  5475. If USE-MARKERS is set, return the positions as markers."
  5476. (let (beg end)
  5477. (save-excursion
  5478. (save-restriction
  5479. (widen)
  5480. (delq nil
  5481. (mapcar (lambda (o)
  5482. (when (eq (overlay-get o 'invisible) 'outline)
  5483. (setq beg (overlay-start o)
  5484. end (overlay-end o))
  5485. (and beg end (> end beg)
  5486. (if use-markers
  5487. (cons (move-marker (make-marker) beg)
  5488. (move-marker (make-marker) end))
  5489. (cons beg end)))))
  5490. (overlays-in (point-min) (point-max))))))))
  5491. (defun org-set-outline-overlay-data (data)
  5492. "Create visibility overlays for all positions in DATA.
  5493. DATA should have been made by `org-outline-overlay-data'."
  5494. (let (o)
  5495. (save-excursion
  5496. (save-restriction
  5497. (widen)
  5498. (show-all)
  5499. (mapc (lambda (c)
  5500. (setq o (make-overlay (car c) (cdr c)))
  5501. (overlay-put o 'invisible 'outline))
  5502. data)))))
  5503. (defmacro org-save-outline-visibility (use-markers &rest body)
  5504. "Save and restore outline visibility around BODY.
  5505. If USE-MARKERS is non-nil, use markers for the positions.
  5506. This means that the buffer may change while running BODY,
  5507. but it also means that the buffer should stay alive
  5508. during the operation, because otherwise all these markers will
  5509. point nowhere."
  5510. (declare (indent 1))
  5511. `(let ((data (org-outline-overlay-data ,use-markers)))
  5512. (unwind-protect
  5513. (progn
  5514. ,@body
  5515. (org-set-outline-overlay-data data))
  5516. (when ,use-markers
  5517. (mapc (lambda (c)
  5518. (and (markerp (car c)) (move-marker (car c) nil))
  5519. (and (markerp (cdr c)) (move-marker (cdr c) nil)))
  5520. data)))))
  5521. ;;; Folding of blocks
  5522. (defconst org-block-regexp
  5523. "^[ \t]*#\\+begin_\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_\\1[ \t]*$"
  5524. "Regular expression for hiding blocks.")
  5525. (defvar org-hide-block-overlays nil
  5526. "Overlays hiding blocks.")
  5527. (make-variable-buffer-local 'org-hide-block-overlays)
  5528. (defun org-block-map (function &optional start end)
  5529. "Call func at the head of all source blocks in the current
  5530. buffer. Optional arguments START and END can be used to limit
  5531. the range."
  5532. (let ((start (or start (point-min)))
  5533. (end (or end (point-max))))
  5534. (save-excursion
  5535. (goto-char start)
  5536. (while (and (< (point) end) (re-search-forward org-block-regexp end t))
  5537. (save-excursion
  5538. (save-match-data
  5539. (goto-char (match-beginning 0))
  5540. (funcall function)))))))
  5541. (defun org-hide-block-toggle-all ()
  5542. "Toggle the visibility of all blocks in the current buffer."
  5543. (org-block-map #'org-hide-block-toggle))
  5544. (defun org-hide-block-all ()
  5545. "Fold all blocks in the current buffer."
  5546. (interactive)
  5547. (org-show-block-all)
  5548. (org-block-map #'org-hide-block-toggle-maybe))
  5549. (defun org-show-block-all ()
  5550. "Unfold all blocks in the current buffer."
  5551. (interactive)
  5552. (mapc 'delete-overlay org-hide-block-overlays)
  5553. (setq org-hide-block-overlays nil))
  5554. (defun org-hide-block-toggle-maybe ()
  5555. "Toggle visibility of block at point."
  5556. (interactive)
  5557. (let ((case-fold-search t))
  5558. (if (save-excursion
  5559. (beginning-of-line 1)
  5560. (looking-at org-block-regexp))
  5561. (progn (org-hide-block-toggle)
  5562. t) ;; to signal that we took action
  5563. nil))) ;; to signal that we did not
  5564. (defun org-hide-block-toggle (&optional force)
  5565. "Toggle the visibility of the current block."
  5566. (interactive)
  5567. (save-excursion
  5568. (beginning-of-line)
  5569. (if (re-search-forward org-block-regexp nil t)
  5570. (let ((start (- (match-beginning 4) 1)) ;; beginning of body
  5571. (end (match-end 0)) ;; end of entire body
  5572. ov)
  5573. (if (memq t (mapcar (lambda (overlay)
  5574. (eq (overlay-get overlay 'invisible)
  5575. 'org-hide-block))
  5576. (overlays-at start)))
  5577. (if (or (not force) (eq force 'off))
  5578. (mapc (lambda (ov)
  5579. (when (member ov org-hide-block-overlays)
  5580. (setq org-hide-block-overlays
  5581. (delq ov org-hide-block-overlays)))
  5582. (when (eq (overlay-get ov 'invisible)
  5583. 'org-hide-block)
  5584. (delete-overlay ov)))
  5585. (overlays-at start)))
  5586. (setq ov (make-overlay start end))
  5587. (overlay-put ov 'invisible 'org-hide-block)
  5588. ;; make the block accessible to isearch
  5589. (overlay-put
  5590. ov 'isearch-open-invisible
  5591. (lambda (ov)
  5592. (when (member ov org-hide-block-overlays)
  5593. (setq org-hide-block-overlays
  5594. (delq ov org-hide-block-overlays)))
  5595. (when (eq (overlay-get ov 'invisible)
  5596. 'org-hide-block)
  5597. (delete-overlay ov))))
  5598. (push ov org-hide-block-overlays)))
  5599. (error "Not looking at a source block"))))
  5600. ;; org-tab-after-check-for-cycling-hook
  5601. (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
  5602. ;; Remove overlays when changing major mode
  5603. (add-hook 'org-mode-hook
  5604. (lambda () (org-add-hook 'change-major-mode-hook
  5605. 'org-show-block-all 'append 'local)))
  5606. ;;; Org-goto
  5607. (defvar org-goto-window-configuration nil)
  5608. (defvar org-goto-marker nil)
  5609. (defvar org-goto-map
  5610. (let ((map (make-sparse-keymap)))
  5611. (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
  5612. (while (setq cmd (pop cmds))
  5613. (substitute-key-definition cmd cmd map global-map)))
  5614. (suppress-keymap map)
  5615. (org-defkey map "\C-m" 'org-goto-ret)
  5616. (org-defkey map [(return)] 'org-goto-ret)
  5617. (org-defkey map [(left)] 'org-goto-left)
  5618. (org-defkey map [(right)] 'org-goto-right)
  5619. (org-defkey map [(control ?g)] 'org-goto-quit)
  5620. (org-defkey map "\C-i" 'org-cycle)
  5621. (org-defkey map [(tab)] 'org-cycle)
  5622. (org-defkey map [(down)] 'outline-next-visible-heading)
  5623. (org-defkey map [(up)] 'outline-previous-visible-heading)
  5624. (if org-goto-auto-isearch
  5625. (if (fboundp 'define-key-after)
  5626. (define-key-after map [t] 'org-goto-local-auto-isearch)
  5627. nil)
  5628. (org-defkey map "q" 'org-goto-quit)
  5629. (org-defkey map "n" 'outline-next-visible-heading)
  5630. (org-defkey map "p" 'outline-previous-visible-heading)
  5631. (org-defkey map "f" 'outline-forward-same-level)
  5632. (org-defkey map "b" 'outline-backward-same-level)
  5633. (org-defkey map "u" 'outline-up-heading))
  5634. (org-defkey map "/" 'org-occur)
  5635. (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
  5636. (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
  5637. (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
  5638. (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
  5639. (org-defkey map "\C-c\C-u" 'outline-up-heading)
  5640. map))
  5641. (defconst org-goto-help
  5642. "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
  5643. RET=jump to location [Q]uit and return to previous location
  5644. \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
  5645. (defvar org-goto-start-pos) ; dynamically scoped parameter
  5646. ;; FIXME: Docstring does not mention both interfaces
  5647. (defun org-goto (&optional alternative-interface)
  5648. "Look up a different location in the current file, keeping current visibility.
  5649. When you want look-up or go to a different location in a document, the
  5650. fastest way is often to fold the entire buffer and then dive into the tree.
  5651. This method has the disadvantage, that the previous location will be folded,
  5652. which may not be what you want.
  5653. This command works around this by showing a copy of the current buffer
  5654. in an indirect buffer, in overview mode. You can dive into the tree in
  5655. that copy, use org-occur and incremental search to find a location.
  5656. When pressing RET or `Q', the command returns to the original buffer in
  5657. which the visibility is still unchanged. After RET is will also jump to
  5658. the location selected in the indirect buffer and expose the
  5659. the headline hierarchy above."
  5660. (interactive "P")
  5661. (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
  5662. (org-refile-use-outline-path t)
  5663. (org-refile-target-verify-function nil)
  5664. (interface
  5665. (if (not alternative-interface)
  5666. org-goto-interface
  5667. (if (eq org-goto-interface 'outline)
  5668. 'outline-path-completion
  5669. 'outline)))
  5670. (org-goto-start-pos (point))
  5671. (selected-point
  5672. (if (eq interface 'outline)
  5673. (car (org-get-location (current-buffer) org-goto-help))
  5674. (nth 3 (org-refile-get-location "Goto: ")))))
  5675. (if selected-point
  5676. (progn
  5677. (org-mark-ring-push org-goto-start-pos)
  5678. (goto-char selected-point)
  5679. (if (or (org-invisible-p) (org-invisible-p2))
  5680. (org-show-context 'org-goto)))
  5681. (message "Quit"))))
  5682. (defvar org-goto-selected-point nil) ; dynamically scoped parameter
  5683. (defvar org-goto-exit-command nil) ; dynamically scoped parameter
  5684. (defvar org-goto-local-auto-isearch-map) ; defined below
  5685. (defun org-get-location (buf help)
  5686. "Let the user select a location in the Org-mode buffer BUF.
  5687. This function uses a recursive edit. It returns the selected position
  5688. or nil."
  5689. (let ((isearch-mode-map org-goto-local-auto-isearch-map)
  5690. (isearch-hide-immediately nil)
  5691. (isearch-search-fun-function
  5692. (lambda () 'org-goto-local-search-headings))
  5693. (org-goto-selected-point org-goto-exit-command)
  5694. (pop-up-frames nil)
  5695. (special-display-buffer-names nil)
  5696. (special-display-regexps nil)
  5697. (special-display-function nil))
  5698. (save-excursion
  5699. (save-window-excursion
  5700. (delete-other-windows)
  5701. (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
  5702. (switch-to-buffer
  5703. (condition-case nil
  5704. (make-indirect-buffer (current-buffer) "*org-goto*")
  5705. (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
  5706. (with-output-to-temp-buffer "*Help*"
  5707. (princ help))
  5708. (org-fit-window-to-buffer (get-buffer-window "*Help*"))
  5709. (setq buffer-read-only nil)
  5710. (let ((org-startup-truncated t)
  5711. (org-startup-folded nil)
  5712. (org-startup-align-all-tables nil))
  5713. (org-mode)
  5714. (org-overview))
  5715. (setq buffer-read-only t)
  5716. (if (and (boundp 'org-goto-start-pos)
  5717. (integer-or-marker-p org-goto-start-pos))
  5718. (let ((org-show-hierarchy-above t)
  5719. (org-show-siblings t)
  5720. (org-show-following-heading t))
  5721. (goto-char org-goto-start-pos)
  5722. (and (org-invisible-p) (org-show-context)))
  5723. (goto-char (point-min)))
  5724. (let (org-special-ctrl-a/e) (org-beginning-of-line))
  5725. (message "Select location and press RET")
  5726. (use-local-map org-goto-map)
  5727. (recursive-edit)
  5728. ))
  5729. (kill-buffer "*org-goto*")
  5730. (cons org-goto-selected-point org-goto-exit-command)))
  5731. (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
  5732. (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
  5733. (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
  5734. (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
  5735. (defun org-goto-local-search-headings (string bound noerror)
  5736. "Search and make sure that any matches are in headlines."
  5737. (catch 'return
  5738. (while (if isearch-forward
  5739. (search-forward string bound noerror)
  5740. (search-backward string bound noerror))
  5741. (when (let ((context (mapcar 'car (save-match-data (org-context)))))
  5742. (and (member :headline context)
  5743. (not (member :tags context))))
  5744. (throw 'return (point))))))
  5745. (defun org-goto-local-auto-isearch ()
  5746. "Start isearch."
  5747. (interactive)
  5748. (goto-char (point-min))
  5749. (let ((keys (this-command-keys)))
  5750. (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
  5751. (isearch-mode t)
  5752. (isearch-process-search-char (string-to-char keys)))))
  5753. (defun org-goto-ret (&optional arg)
  5754. "Finish `org-goto' by going to the new location."
  5755. (interactive "P")
  5756. (setq org-goto-selected-point (point)
  5757. org-goto-exit-command 'return)
  5758. (throw 'exit nil))
  5759. (defun org-goto-left ()
  5760. "Finish `org-goto' by going to the new location."
  5761. (interactive)
  5762. (if (org-on-heading-p)
  5763. (progn
  5764. (beginning-of-line 1)
  5765. (setq org-goto-selected-point (point)
  5766. org-goto-exit-command 'left)
  5767. (throw 'exit nil))
  5768. (error "Not on a heading")))
  5769. (defun org-goto-right ()
  5770. "Finish `org-goto' by going to the new location."
  5771. (interactive)
  5772. (if (org-on-heading-p)
  5773. (progn
  5774. (setq org-goto-selected-point (point)
  5775. org-goto-exit-command 'right)
  5776. (throw 'exit nil))
  5777. (error "Not on a heading")))
  5778. (defun org-goto-quit ()
  5779. "Finish `org-goto' without cursor motion."
  5780. (interactive)
  5781. (setq org-goto-selected-point nil)
  5782. (setq org-goto-exit-command 'quit)
  5783. (throw 'exit nil))
  5784. ;;; Indirect buffer display of subtrees
  5785. (defvar org-indirect-dedicated-frame nil
  5786. "This is the frame being used for indirect tree display.")
  5787. (defvar org-last-indirect-buffer nil)
  5788. (defun org-tree-to-indirect-buffer (&optional arg)
  5789. "Create indirect buffer and narrow it to current subtree.
  5790. With numerical prefix ARG, go up to this level and then take that tree.
  5791. If ARG is negative, go up that many levels.
  5792. If `org-indirect-buffer-display' is not `new-frame', the command removes the
  5793. indirect buffer previously made with this command, to avoid proliferation of
  5794. indirect buffers. However, when you call the command with a `C-u' prefix, or
  5795. when `org-indirect-buffer-display' is `new-frame', the last buffer
  5796. is kept so that you can work with several indirect buffers at the same time.
  5797. If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
  5798. requests that a new frame be made for the new buffer, so that the dedicated
  5799. frame is not changed."
  5800. (interactive "P")
  5801. (let ((cbuf (current-buffer))
  5802. (cwin (selected-window))
  5803. (pos (point))
  5804. beg end level heading ibuf)
  5805. (save-excursion
  5806. (org-back-to-heading t)
  5807. (when (numberp arg)
  5808. (setq level (org-outline-level))
  5809. (if (< arg 0) (setq arg (+ level arg)))
  5810. (while (> (setq level (org-outline-level)) arg)
  5811. (outline-up-heading 1 t)))
  5812. (setq beg (point)
  5813. heading (org-get-heading))
  5814. (org-end-of-subtree t t)
  5815. (if (org-on-heading-p) (backward-char 1))
  5816. (setq end (point)))
  5817. (if (and (buffer-live-p org-last-indirect-buffer)
  5818. (not (eq org-indirect-buffer-display 'new-frame))
  5819. (not arg))
  5820. (kill-buffer org-last-indirect-buffer))
  5821. (setq ibuf (org-get-indirect-buffer cbuf)
  5822. org-last-indirect-buffer ibuf)
  5823. (cond
  5824. ((or (eq org-indirect-buffer-display 'new-frame)
  5825. (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
  5826. (select-frame (make-frame))
  5827. (delete-other-windows)
  5828. (switch-to-buffer ibuf)
  5829. (org-set-frame-title heading))
  5830. ((eq org-indirect-buffer-display 'dedicated-frame)
  5831. (raise-frame
  5832. (select-frame (or (and org-indirect-dedicated-frame
  5833. (frame-live-p org-indirect-dedicated-frame)
  5834. org-indirect-dedicated-frame)
  5835. (setq org-indirect-dedicated-frame (make-frame)))))
  5836. (delete-other-windows)
  5837. (switch-to-buffer ibuf)
  5838. (org-set-frame-title (concat "Indirect: " heading)))
  5839. ((eq org-indirect-buffer-display 'current-window)
  5840. (switch-to-buffer ibuf))
  5841. ((eq org-indirect-buffer-display 'other-window)
  5842. (pop-to-buffer ibuf))
  5843. (t (error "Invalid value")))
  5844. (if (featurep 'xemacs)
  5845. (save-excursion (org-mode) (turn-on-font-lock)))
  5846. (narrow-to-region beg end)
  5847. (show-all)
  5848. (goto-char pos)
  5849. (and (window-live-p cwin) (select-window cwin))))
  5850. (defun org-get-indirect-buffer (&optional buffer)
  5851. (setq buffer (or buffer (current-buffer)))
  5852. (let ((n 1) (base (buffer-name buffer)) bname)
  5853. (while (buffer-live-p
  5854. (get-buffer (setq bname (concat base "-" (number-to-string n)))))
  5855. (setq n (1+ n)))
  5856. (condition-case nil
  5857. (make-indirect-buffer buffer bname 'clone)
  5858. (error (make-indirect-buffer buffer bname)))))
  5859. (defun org-set-frame-title (title)
  5860. "Set the title of the current frame to the string TITLE."
  5861. ;; FIXME: how to name a single frame in XEmacs???
  5862. (unless (featurep 'xemacs)
  5863. (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
  5864. ;;;; Structure editing
  5865. ;;; Inserting headlines
  5866. (defun org-previous-line-empty-p ()
  5867. (save-excursion
  5868. (and (not (bobp))
  5869. (or (beginning-of-line 0) t)
  5870. (save-match-data
  5871. (looking-at "[ \t]*$")))))
  5872. (defun org-insert-heading (&optional force-heading invisible-ok)
  5873. "Insert a new heading or item with same depth at point.
  5874. If point is in a plain list and FORCE-HEADING is nil, create a new list item.
  5875. If point is at the beginning of a headline, insert a sibling before the
  5876. current headline. If point is not at the beginning, do not split the line,
  5877. but create the new headline after the current line.
  5878. When INVISIBLE-OK is set, stop at invisible headlines when going back.
  5879. This is important for non-interactive uses of the command."
  5880. (interactive "P")
  5881. (if (or (= (buffer-size) 0)
  5882. (and (not (save-excursion (and (ignore-errors (org-back-to-heading invisible-ok))
  5883. (org-on-heading-p))))
  5884. (not (org-in-item-p))))
  5885. (insert "\n* ")
  5886. (when (or force-heading (not (org-insert-item)))
  5887. (let* ((empty-line-p nil)
  5888. (head (save-excursion
  5889. (condition-case nil
  5890. (progn
  5891. (org-back-to-heading invisible-ok)
  5892. (setq empty-line-p (org-previous-line-empty-p))
  5893. (match-string 0))
  5894. (error "*"))))
  5895. (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
  5896. (blank (if (eq blank-a 'auto) empty-line-p blank-a))
  5897. pos hide-previous previous-pos)
  5898. (cond
  5899. ((and (org-on-heading-p) (bolp)
  5900. (or (bobp)
  5901. (save-excursion (backward-char 1) (not (org-invisible-p)))))
  5902. ;; insert before the current line
  5903. (open-line (if blank 2 1)))
  5904. ((and (bolp)
  5905. (not org-insert-heading-respect-content)
  5906. (or (bobp)
  5907. (save-excursion
  5908. (backward-char 1) (not (org-invisible-p)))))
  5909. ;; insert right here
  5910. nil)
  5911. (t
  5912. ;; somewhere in the line
  5913. (save-excursion
  5914. (setq previous-pos (point-at-bol))
  5915. (end-of-line)
  5916. (setq hide-previous (org-invisible-p)))
  5917. (and org-insert-heading-respect-content (org-show-subtree))
  5918. (let ((split
  5919. (and (org-get-alist-option org-M-RET-may-split-line 'headline)
  5920. (save-excursion
  5921. (let ((p (point)))
  5922. (goto-char (point-at-bol))
  5923. (and (looking-at org-complex-heading-regexp)
  5924. (> p (match-beginning 4)))))))
  5925. tags pos)
  5926. (cond
  5927. (org-insert-heading-respect-content
  5928. (org-end-of-subtree nil t)
  5929. (or (bolp) (newline))
  5930. (or (org-previous-line-empty-p)
  5931. (and blank (newline)))
  5932. (open-line 1))
  5933. ((org-on-heading-p)
  5934. (when hide-previous
  5935. (show-children)
  5936. (org-show-entry))
  5937. (looking-at ".*?\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)?[ \t]*$")
  5938. (setq tags (and (match-end 2) (match-string 2)))
  5939. (and (match-end 1)
  5940. (delete-region (match-beginning 1) (match-end 1)))
  5941. (setq pos (point-at-bol))
  5942. (or split (end-of-line 1))
  5943. (delete-horizontal-space)
  5944. (if (string-match "\\`\\*+\\'"
  5945. (buffer-substring (point-at-bol) (point)))
  5946. (insert " "))
  5947. (newline (if blank 2 1))
  5948. (when tags
  5949. (save-excursion
  5950. (goto-char pos)
  5951. (end-of-line 1)
  5952. (insert " " tags)
  5953. (org-set-tags nil 'align))))
  5954. (t
  5955. (or split (end-of-line 1))
  5956. (newline (if blank 2 1)))))))
  5957. (insert head) (just-one-space)
  5958. (setq pos (point))
  5959. (end-of-line 1)
  5960. (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
  5961. (when (and org-insert-heading-respect-content hide-previous)
  5962. (save-excursion
  5963. (goto-char previous-pos)
  5964. (hide-subtree)))
  5965. (run-hooks 'org-insert-heading-hook)))))
  5966. (defun org-get-heading (&optional no-tags)
  5967. "Return the heading of the current entry, without the stars."
  5968. (save-excursion
  5969. (org-back-to-heading t)
  5970. (if (looking-at
  5971. (if no-tags
  5972. (org-re "\\*+[ \t]+\\([^\n\r]*?\\)\\([ \t]+:[[:alnum:]:_@]+:[ \t]*\\)?$")
  5973. "\\*+[ \t]+\\([^\r\n]*\\)"))
  5974. (match-string 1) "")))
  5975. (defun org-heading-components ()
  5976. "Return the components of the current heading.
  5977. This is a list with the following elements:
  5978. - the level as an integer
  5979. - the reduced level, different if `org-odd-levels-only' is set.
  5980. - the TODO keyword, or nil
  5981. - the priority character, like ?A, or nil if no priority is given
  5982. - the headline text itself, or the tags string if no headline text
  5983. - the tags string, or nil."
  5984. (save-excursion
  5985. (org-back-to-heading t)
  5986. (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
  5987. (list (length (match-string 1))
  5988. (org-reduced-level (length (match-string 1)))
  5989. (org-match-string-no-properties 2)
  5990. (and (match-end 3) (aref (match-string 3) 2))
  5991. (org-match-string-no-properties 4)
  5992. (org-match-string-no-properties 5)))))
  5993. (defun org-get-entry ()
  5994. "Get the entry text, after heading, entire subtree."
  5995. (save-excursion
  5996. (org-back-to-heading t)
  5997. (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
  5998. (defun org-insert-heading-after-current ()
  5999. "Insert a new heading with same level as current, after current subtree."
  6000. (interactive)
  6001. (org-back-to-heading)
  6002. (org-insert-heading)
  6003. (org-move-subtree-down)
  6004. (end-of-line 1))
  6005. (defun org-insert-heading-respect-content ()
  6006. (interactive)
  6007. (let ((org-insert-heading-respect-content t))
  6008. (org-insert-heading t)))
  6009. (defun org-insert-todo-heading-respect-content (&optional force-state)
  6010. (interactive "P")
  6011. (let ((org-insert-heading-respect-content t))
  6012. (org-insert-todo-heading force-state t)))
  6013. (defun org-insert-todo-heading (arg &optional force-heading)
  6014. "Insert a new heading with the same level and TODO state as current heading.
  6015. If the heading has no TODO state, or if the state is DONE, use the first
  6016. state (TODO by default). Also with prefix arg, force first state."
  6017. (interactive "P")
  6018. (when (or force-heading (not (org-insert-item 'checkbox)))
  6019. (org-insert-heading force-heading)
  6020. (save-excursion
  6021. (org-back-to-heading)
  6022. (outline-previous-heading)
  6023. (looking-at org-todo-line-regexp))
  6024. (let*
  6025. ((new-mark-x
  6026. (if (or arg
  6027. (not (match-beginning 2))
  6028. (member (match-string 2) org-done-keywords))
  6029. (car org-todo-keywords-1)
  6030. (match-string 2)))
  6031. (new-mark
  6032. (or
  6033. (run-hook-with-args-until-success
  6034. 'org-todo-get-default-hook new-mark-x nil)
  6035. new-mark-x)))
  6036. (beginning-of-line 1)
  6037. (and (looking-at "\\*+ ") (goto-char (match-end 0))
  6038. (if org-treat-insert-todo-heading-as-state-change
  6039. (org-todo new-mark)
  6040. (insert new-mark " "))))
  6041. (when org-provide-todo-statistics
  6042. (org-update-parent-todo-statistics))))
  6043. (defun org-insert-subheading (arg)
  6044. "Insert a new subheading and demote it.
  6045. Works for outline headings and for plain lists alike."
  6046. (interactive "P")
  6047. (org-insert-heading arg)
  6048. (cond
  6049. ((org-on-heading-p) (org-do-demote))
  6050. ((org-at-item-p) (org-indent-item 1))))
  6051. (defun org-insert-todo-subheading (arg)
  6052. "Insert a new subheading with TODO keyword or checkbox and demote it.
  6053. Works for outline headings and for plain lists alike."
  6054. (interactive "P")
  6055. (org-insert-todo-heading arg)
  6056. (cond
  6057. ((org-on-heading-p) (org-do-demote))
  6058. ((org-at-item-p) (org-indent-item 1))))
  6059. ;;; Promotion and Demotion
  6060. (defvar org-after-demote-entry-hook nil
  6061. "Hook run after an entry has been demoted.
  6062. The cursor will be at the beginning of the entry.
  6063. When a subtree is being demoted, the hook will be called for each node.")
  6064. (defvar org-after-promote-entry-hook nil
  6065. "Hook run after an entry has been promoted.
  6066. The cursor will be at the beginning of the entry.
  6067. When a subtree is being promoted, the hook will be called for each node.")
  6068. (defun org-promote-subtree ()
  6069. "Promote the entire subtree.
  6070. See also `org-promote'."
  6071. (interactive)
  6072. (save-excursion
  6073. (org-map-tree 'org-promote))
  6074. (org-fix-position-after-promote))
  6075. (defun org-demote-subtree ()
  6076. "Demote the entire subtree. See `org-demote'.
  6077. See also `org-promote'."
  6078. (interactive)
  6079. (save-excursion
  6080. (org-map-tree 'org-demote))
  6081. (org-fix-position-after-promote))
  6082. (defun org-do-promote ()
  6083. "Promote the current heading higher up the tree.
  6084. If the region is active in `transient-mark-mode', promote all headings
  6085. in the region."
  6086. (interactive)
  6087. (save-excursion
  6088. (if (org-region-active-p)
  6089. (org-map-region 'org-promote (region-beginning) (region-end))
  6090. (org-promote)))
  6091. (org-fix-position-after-promote))
  6092. (defun org-do-demote ()
  6093. "Demote the current heading lower down the tree.
  6094. If the region is active in `transient-mark-mode', demote all headings
  6095. in the region."
  6096. (interactive)
  6097. (save-excursion
  6098. (if (org-region-active-p)
  6099. (org-map-region 'org-demote (region-beginning) (region-end))
  6100. (org-demote)))
  6101. (org-fix-position-after-promote))
  6102. (defun org-fix-position-after-promote ()
  6103. "Make sure that after pro/demotion cursor position is right."
  6104. (let ((pos (point)))
  6105. (when (save-excursion
  6106. (beginning-of-line 1)
  6107. (looking-at org-todo-line-regexp)
  6108. (or (equal pos (match-end 1)) (equal pos (match-end 2))))
  6109. (cond ((eobp) (insert " "))
  6110. ((eolp) (insert " "))
  6111. ((equal (char-after) ?\ ) (forward-char 1))))))
  6112. (defun org-current-level ()
  6113. "Return the level of the current entry, or nil if before the first headline.
  6114. The level is the number of stars at the beginning of the headline."
  6115. (save-excursion
  6116. (condition-case nil
  6117. (progn
  6118. (org-back-to-heading t)
  6119. (funcall outline-level))
  6120. (error nil))))
  6121. (defun org-get-previous-line-level ()
  6122. "Return the outline depth of the last headline before the current line.
  6123. Returns 0 for the first headline in the buffer, and nil if before the
  6124. first headline."
  6125. (let ((current-level (org-current-level))
  6126. (prev-level (when (> (line-number-at-pos) 1)
  6127. (save-excursion
  6128. (beginning-of-line 0)
  6129. (org-current-level)))))
  6130. (cond ((null current-level) nil) ; Before first headline
  6131. ((null prev-level) 0) ; At first headline
  6132. (prev-level))))
  6133. (defun org-reduced-level (l)
  6134. "Compute the effective level of a heading.
  6135. This takes into account the setting of `org-odd-levels-only'."
  6136. (if org-odd-levels-only (1+ (floor (/ l 2))) l))
  6137. (defun org-level-increment ()
  6138. "Return the number of stars that will be added or removed at a
  6139. time to headlines when structure editing, based on the value of
  6140. `org-odd-levels-only'."
  6141. (if org-odd-levels-only 2 1))
  6142. (defun org-get-valid-level (level &optional change)
  6143. "Rectify a level change under the influence of `org-odd-levels-only'
  6144. LEVEL is a current level, CHANGE is by how much the level should be
  6145. modified. Even if CHANGE is nil, LEVEL may be returned modified because
  6146. even level numbers will become the next higher odd number."
  6147. (if org-odd-levels-only
  6148. (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
  6149. ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
  6150. ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
  6151. (max 1 (+ level (or change 0)))))
  6152. (if (boundp 'define-obsolete-function-alias)
  6153. (if (or (featurep 'xemacs) (< emacs-major-version 23))
  6154. (define-obsolete-function-alias 'org-get-legal-level
  6155. 'org-get-valid-level)
  6156. (define-obsolete-function-alias 'org-get-legal-level
  6157. 'org-get-valid-level "23.1")))
  6158. (defun org-promote ()
  6159. "Promote the current heading higher up the tree.
  6160. If the region is active in `transient-mark-mode', promote all headings
  6161. in the region."
  6162. (org-back-to-heading t)
  6163. (let* ((level (save-match-data (funcall outline-level)))
  6164. (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
  6165. (diff (abs (- level (length up-head) -1))))
  6166. (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
  6167. (replace-match up-head nil t)
  6168. ;; Fixup tag positioning
  6169. (and org-auto-align-tags (org-set-tags nil t))
  6170. (if org-adapt-indentation (org-fixup-indentation (- diff)))
  6171. (run-hooks 'org-after-promote-entry-hook)))
  6172. (defun org-demote ()
  6173. "Demote the current heading lower down the tree.
  6174. If the region is active in `transient-mark-mode', demote all headings
  6175. in the region."
  6176. (org-back-to-heading t)
  6177. (let* ((level (save-match-data (funcall outline-level)))
  6178. (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
  6179. (diff (abs (- level (length down-head) -1))))
  6180. (replace-match down-head nil t)
  6181. ;; Fixup tag positioning
  6182. (and org-auto-align-tags (org-set-tags nil t))
  6183. (if org-adapt-indentation (org-fixup-indentation diff))
  6184. (run-hooks 'org-after-demote-entry-hook)))
  6185. (defun org-cycle-level ()
  6186. "Cycle the level of an empty headline through possible states.
  6187. This goes first to child, then to parent, level, then up the hierarchy.
  6188. After top level, it switches back to sibling level."
  6189. (interactive)
  6190. (let ((org-adapt-indentation nil))
  6191. (when (org-point-at-end-of-empty-headline)
  6192. (setq this-command 'org-cycle-level) ; Only needed for caching
  6193. (let ((cur-level (org-current-level))
  6194. (prev-level (org-get-previous-line-level)))
  6195. (cond
  6196. ;; If first headline in file, promote to top-level.
  6197. ((= prev-level 0)
  6198. (loop repeat (/ (- cur-level 1) (org-level-increment))
  6199. do (org-do-promote)))
  6200. ;; If same level as prev, demote one.
  6201. ((= prev-level cur-level)
  6202. (org-do-demote))
  6203. ;; If parent is top-level, promote to top level if not already.
  6204. ((= prev-level 1)
  6205. (loop repeat (/ (- cur-level 1) (org-level-increment))
  6206. do (org-do-promote)))
  6207. ;; If top-level, return to prev-level.
  6208. ((= cur-level 1)
  6209. (loop repeat (/ (- prev-level 1) (org-level-increment))
  6210. do (org-do-demote)))
  6211. ;; If less than prev-level, promote one.
  6212. ((< cur-level prev-level)
  6213. (org-do-promote))
  6214. ;; If deeper than prev-level, promote until higher than
  6215. ;; prev-level.
  6216. ((> cur-level prev-level)
  6217. (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
  6218. do (org-do-promote))))
  6219. t))))
  6220. (defun org-map-tree (fun)
  6221. "Call FUN for every heading underneath the current one."
  6222. (org-back-to-heading)
  6223. (let ((level (funcall outline-level)))
  6224. (save-excursion
  6225. (funcall fun)
  6226. (while (and (progn
  6227. (outline-next-heading)
  6228. (> (funcall outline-level) level))
  6229. (not (eobp)))
  6230. (funcall fun)))))
  6231. (defun org-map-region (fun beg end)
  6232. "Call FUN for every heading between BEG and END."
  6233. (let ((org-ignore-region t))
  6234. (save-excursion
  6235. (setq end (copy-marker end))
  6236. (goto-char beg)
  6237. (if (and (re-search-forward (concat "^" outline-regexp) nil t)
  6238. (< (point) end))
  6239. (funcall fun))
  6240. (while (and (progn
  6241. (outline-next-heading)
  6242. (< (point) end))
  6243. (not (eobp)))
  6244. (funcall fun)))))
  6245. (defun org-fixup-indentation (diff)
  6246. "Change the indentation in the current entry by DIFF
  6247. However, if any line in the current entry has no indentation, or if it
  6248. would end up with no indentation after the change, nothing at all is done."
  6249. (save-excursion
  6250. (let ((end (save-excursion (outline-next-heading)
  6251. (point-marker)))
  6252. (prohibit (if (> diff 0)
  6253. "^\\S-"
  6254. (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
  6255. col)
  6256. (unless (save-excursion (end-of-line 1)
  6257. (re-search-forward prohibit end t))
  6258. (while (and (< (point) end)
  6259. (re-search-forward "^[ \t]+" end t))
  6260. (goto-char (match-end 0))
  6261. (setq col (current-column))
  6262. (if (< diff 0) (replace-match ""))
  6263. (org-indent-to-column (+ diff col))))
  6264. (move-marker end nil))))
  6265. (defun org-convert-to-odd-levels ()
  6266. "Convert an org-mode file with all levels allowed to one with odd levels.
  6267. This will leave level 1 alone, convert level 2 to level 3, level 3 to
  6268. level 5 etc."
  6269. (interactive)
  6270. (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
  6271. (let ((outline-regexp org-outline-regexp)
  6272. (outline-level 'org-outline-level)
  6273. (org-odd-levels-only nil) n)
  6274. (save-excursion
  6275. (goto-char (point-min))
  6276. (while (re-search-forward "^\\*\\*+ " nil t)
  6277. (setq n (- (length (match-string 0)) 2))
  6278. (while (>= (setq n (1- n)) 0)
  6279. (org-demote))
  6280. (end-of-line 1))))))
  6281. (defun org-convert-to-oddeven-levels ()
  6282. "Convert an org-mode file with only odd levels to one with odd and even levels.
  6283. This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
  6284. section with an even level, conversion would destroy the structure of the file. An error
  6285. is signaled in this case."
  6286. (interactive)
  6287. (goto-char (point-min))
  6288. ;; First check if there are no even levels
  6289. (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
  6290. (org-show-context t)
  6291. (error "Not all levels are odd in this file. Conversion not possible"))
  6292. (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
  6293. (let ((outline-regexp org-outline-regexp)
  6294. (outline-level 'org-outline-level)
  6295. (org-odd-levels-only nil) n)
  6296. (save-excursion
  6297. (goto-char (point-min))
  6298. (while (re-search-forward "^\\*\\*+ " nil t)
  6299. (setq n (/ (1- (length (match-string 0))) 2))
  6300. (while (>= (setq n (1- n)) 0)
  6301. (org-promote))
  6302. (end-of-line 1))))))
  6303. (defun org-tr-level (n)
  6304. "Make N odd if required."
  6305. (if org-odd-levels-only (1+ (/ n 2)) n))
  6306. ;;; Vertical tree motion, cutting and pasting of subtrees
  6307. (defun org-move-subtree-up (&optional arg)
  6308. "Move the current subtree up past ARG headlines of the same level."
  6309. (interactive "p")
  6310. (org-move-subtree-down (- (prefix-numeric-value arg))))
  6311. (defun org-move-subtree-down (&optional arg)
  6312. "Move the current subtree down past ARG headlines of the same level."
  6313. (interactive "p")
  6314. (setq arg (prefix-numeric-value arg))
  6315. (let ((movfunc (if (> arg 0) 'org-get-next-sibling
  6316. 'org-get-last-sibling))
  6317. (ins-point (make-marker))
  6318. (cnt (abs arg))
  6319. beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
  6320. ;; Select the tree
  6321. (org-back-to-heading)
  6322. (setq beg0 (point))
  6323. (save-excursion
  6324. (setq ne-beg (org-back-over-empty-lines))
  6325. (setq beg (point)))
  6326. (save-match-data
  6327. (save-excursion (outline-end-of-heading)
  6328. (setq folded (org-invisible-p)))
  6329. (outline-end-of-subtree))
  6330. (outline-next-heading)
  6331. (setq ne-end (org-back-over-empty-lines))
  6332. (setq end (point))
  6333. (goto-char beg0)
  6334. (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
  6335. ;; include less whitespace
  6336. (save-excursion
  6337. (goto-char beg)
  6338. (forward-line (- ne-beg ne-end))
  6339. (setq beg (point))))
  6340. ;; Find insertion point, with error handling
  6341. (while (> cnt 0)
  6342. (or (and (funcall movfunc) (looking-at outline-regexp))
  6343. (progn (goto-char beg0)
  6344. (error "Cannot move past superior level or buffer limit")))
  6345. (setq cnt (1- cnt)))
  6346. (if (> arg 0)
  6347. ;; Moving forward - still need to move over subtree
  6348. (progn (org-end-of-subtree t t)
  6349. (save-excursion
  6350. (org-back-over-empty-lines)
  6351. (or (bolp) (newline)))))
  6352. (setq ne-ins (org-back-over-empty-lines))
  6353. (move-marker ins-point (point))
  6354. (setq txt (buffer-substring beg end))
  6355. (org-save-markers-in-region beg end)
  6356. (delete-region beg end)
  6357. (org-remove-empty-overlays-at beg)
  6358. (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
  6359. (or (bobp) (outline-flag-region (1- (point)) (point) nil))
  6360. (and (not (bolp)) (looking-at "\n") (forward-char 1))
  6361. (let ((bbb (point)))
  6362. (insert-before-markers txt)
  6363. (org-reinstall-markers-in-region bbb)
  6364. (move-marker ins-point bbb))
  6365. (or (bolp) (insert "\n"))
  6366. (setq ins-end (point))
  6367. (goto-char ins-point)
  6368. (org-skip-whitespace)
  6369. (when (and (< arg 0)
  6370. (org-first-sibling-p)
  6371. (> ne-ins ne-beg))
  6372. ;; Move whitespace back to beginning
  6373. (save-excursion
  6374. (goto-char ins-end)
  6375. (let ((kill-whole-line t))
  6376. (kill-line (- ne-ins ne-beg)) (point)))
  6377. (insert (make-string (- ne-ins ne-beg) ?\n)))
  6378. (move-marker ins-point nil)
  6379. (if folded
  6380. (hide-subtree)
  6381. (org-show-entry)
  6382. (show-children)
  6383. (org-cycle-hide-drawers 'children))
  6384. (org-clean-visibility-after-subtree-move)))
  6385. (defvar org-subtree-clip ""
  6386. "Clipboard for cut and paste of subtrees.
  6387. This is actually only a copy of the kill, because we use the normal kill
  6388. ring. We need it to check if the kill was created by `org-copy-subtree'.")
  6389. (defvar org-subtree-clip-folded nil
  6390. "Was the last copied subtree folded?
  6391. This is used to fold the tree back after pasting.")
  6392. (defun org-cut-subtree (&optional n)
  6393. "Cut the current subtree into the clipboard.
  6394. With prefix arg N, cut this many sequential subtrees.
  6395. This is a short-hand for marking the subtree and then cutting it."
  6396. (interactive "p")
  6397. (org-copy-subtree n 'cut))
  6398. (defun org-copy-subtree (&optional n cut force-store-markers)
  6399. "Cut the current subtree into the clipboard.
  6400. With prefix arg N, cut this many sequential subtrees.
  6401. This is a short-hand for marking the subtree and then copying it.
  6402. If CUT is non-nil, actually cut the subtree.
  6403. If FORCE-STORE-MARKERS is non-nil, store the relative locations
  6404. of some markers in the region, even if CUT is non-nil. This is
  6405. useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
  6406. (interactive "p")
  6407. (let (beg end folded (beg0 (point)))
  6408. (if (interactive-p)
  6409. (org-back-to-heading nil) ; take what looks like a subtree
  6410. (org-back-to-heading t)) ; take what is really there
  6411. (org-back-over-empty-lines)
  6412. (setq beg (point))
  6413. (skip-chars-forward " \t\r\n")
  6414. (save-match-data
  6415. (save-excursion (outline-end-of-heading)
  6416. (setq folded (org-invisible-p)))
  6417. (condition-case nil
  6418. (org-forward-same-level (1- n) t)
  6419. (error nil))
  6420. (org-end-of-subtree t t))
  6421. (org-back-over-empty-lines)
  6422. (setq end (point))
  6423. (goto-char beg0)
  6424. (when (> end beg)
  6425. (setq org-subtree-clip-folded folded)
  6426. (when (or cut force-store-markers)
  6427. (org-save-markers-in-region beg end))
  6428. (if cut (kill-region beg end) (copy-region-as-kill beg end))
  6429. (setq org-subtree-clip (current-kill 0))
  6430. (message "%s: Subtree(s) with %d characters"
  6431. (if cut "Cut" "Copied")
  6432. (length org-subtree-clip)))))
  6433. (defun org-paste-subtree (&optional level tree for-yank)
  6434. "Paste the clipboard as a subtree, with modification of headline level.
  6435. The entire subtree is promoted or demoted in order to match a new headline
  6436. level.
  6437. If the cursor is at the beginning of a headline, the same level as
  6438. that headline is used to paste the tree
  6439. If not, the new level is derived from the *visible* headings
  6440. before and after the insertion point, and taken to be the inferior headline
  6441. level of the two. So if the previous visible heading is level 3 and the
  6442. next is level 4 (or vice versa), level 4 will be used for insertion.
  6443. This makes sure that the subtree remains an independent subtree and does
  6444. not swallow low level entries.
  6445. You can also force a different level, either by using a numeric prefix
  6446. argument, or by inserting the heading marker by hand. For example, if the
  6447. cursor is after \"*****\", then the tree will be shifted to level 5.
  6448. If optional TREE is given, use this text instead of the kill ring.
  6449. When FOR-YANK is set, this is called by `org-yank'. In this case, do not
  6450. move back over whitespace before inserting, and move point to the end of
  6451. the inserted text when done."
  6452. (interactive "P")
  6453. (setq tree (or tree (and kill-ring (current-kill 0))))
  6454. (unless (org-kill-is-subtree-p tree)
  6455. (error "%s"
  6456. (substitute-command-keys
  6457. "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
  6458. (let* ((visp (not (org-invisible-p)))
  6459. (txt tree)
  6460. (^re (concat "^\\(" outline-regexp "\\)"))
  6461. (re (concat "\\(" outline-regexp "\\)"))
  6462. (^re_ (concat "\\(\\*+\\)[ \t]*"))
  6463. (old-level (if (string-match ^re txt)
  6464. (- (match-end 0) (match-beginning 0) 1)
  6465. -1))
  6466. (force-level (cond (level (prefix-numeric-value level))
  6467. ((and (looking-at "[ \t]*$")
  6468. (string-match
  6469. ^re_ (buffer-substring
  6470. (point-at-bol) (point))))
  6471. (- (match-end 1) (match-beginning 1)))
  6472. ((and (bolp)
  6473. (looking-at org-outline-regexp))
  6474. (- (match-end 0) (point) 1))
  6475. (t nil)))
  6476. (previous-level (save-excursion
  6477. (condition-case nil
  6478. (progn
  6479. (outline-previous-visible-heading 1)
  6480. (if (looking-at re)
  6481. (- (match-end 0) (match-beginning 0) 1)
  6482. 1))
  6483. (error 1))))
  6484. (next-level (save-excursion
  6485. (condition-case nil
  6486. (progn
  6487. (or (looking-at outline-regexp)
  6488. (outline-next-visible-heading 1))
  6489. (if (looking-at re)
  6490. (- (match-end 0) (match-beginning 0) 1)
  6491. 1))
  6492. (error 1))))
  6493. (new-level (or force-level (max previous-level next-level)))
  6494. (shift (if (or (= old-level -1)
  6495. (= new-level -1)
  6496. (= old-level new-level))
  6497. 0
  6498. (- new-level old-level)))
  6499. (delta (if (> shift 0) -1 1))
  6500. (func (if (> shift 0) 'org-demote 'org-promote))
  6501. (org-odd-levels-only nil)
  6502. beg end newend)
  6503. ;; Remove the forced level indicator
  6504. (if force-level
  6505. (delete-region (point-at-bol) (point)))
  6506. ;; Paste
  6507. (beginning-of-line 1)
  6508. (unless for-yank (org-back-over-empty-lines))
  6509. (setq beg (point))
  6510. (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
  6511. (insert-before-markers txt)
  6512. (unless (string-match "\n\\'" txt) (insert "\n"))
  6513. (setq newend (point))
  6514. (org-reinstall-markers-in-region beg)
  6515. (setq end (point))
  6516. (goto-char beg)
  6517. (skip-chars-forward " \t\n\r")
  6518. (setq beg (point))
  6519. (if (and (org-invisible-p) visp)
  6520. (save-excursion (outline-show-heading)))
  6521. ;; Shift if necessary
  6522. (unless (= shift 0)
  6523. (save-restriction
  6524. (narrow-to-region beg end)
  6525. (while (not (= shift 0))
  6526. (org-map-region func (point-min) (point-max))
  6527. (setq shift (+ delta shift)))
  6528. (goto-char (point-min))
  6529. (setq newend (point-max))))
  6530. (when (or (interactive-p) for-yank)
  6531. (message "Clipboard pasted as level %d subtree" new-level))
  6532. (if (and (not for-yank) ; in this case, org-yank will decide about folding
  6533. kill-ring
  6534. (eq org-subtree-clip (current-kill 0))
  6535. org-subtree-clip-folded)
  6536. ;; The tree was folded before it was killed/copied
  6537. (hide-subtree))
  6538. (and for-yank (goto-char newend))))
  6539. (defun org-kill-is-subtree-p (&optional txt)
  6540. "Check if the current kill is an outline subtree, or a set of trees.
  6541. Returns nil if kill does not start with a headline, or if the first
  6542. headline level is not the largest headline level in the tree.
  6543. So this will actually accept several entries of equal levels as well,
  6544. which is OK for `org-paste-subtree'.
  6545. If optional TXT is given, check this string instead of the current kill."
  6546. (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
  6547. (start-level (and kill
  6548. (string-match (concat "\\`\\([ \t\n\r]*?\n\\)?\\("
  6549. org-outline-regexp "\\)")
  6550. kill)
  6551. (- (match-end 2) (match-beginning 2) 1)))
  6552. (re (concat "^" org-outline-regexp))
  6553. (start (1+ (or (match-beginning 2) -1))))
  6554. (if (not start-level)
  6555. (progn
  6556. nil) ;; does not even start with a heading
  6557. (catch 'exit
  6558. (while (setq start (string-match re kill (1+ start)))
  6559. (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
  6560. (throw 'exit nil)))
  6561. t))))
  6562. (defvar org-markers-to-move nil
  6563. "Markers that should be moved with a cut-and-paste operation.
  6564. Those markers are stored together with their positions relative to
  6565. the start of the region.")
  6566. (defun org-save-markers-in-region (beg end)
  6567. "Check markers in region.
  6568. If these markers are between BEG and END, record their position relative
  6569. to BEG, so that after moving the block of text, we can put the markers back
  6570. into place.
  6571. This function gets called just before an entry or tree gets cut from the
  6572. buffer. After re-insertion, `org-reinstall-markers-in-region' must be
  6573. called immediately, to move the markers with the entries."
  6574. (setq org-markers-to-move nil)
  6575. (when (featurep 'org-clock)
  6576. (org-clock-save-markers-for-cut-and-paste beg end))
  6577. (when (featurep 'org-agenda)
  6578. (org-agenda-save-markers-for-cut-and-paste beg end)))
  6579. (defun org-check-and-save-marker (marker beg end)
  6580. "Check if MARKER is between BEG and END.
  6581. If yes, remember the marker and the distance to BEG."
  6582. (when (and (marker-buffer marker)
  6583. (equal (marker-buffer marker) (current-buffer)))
  6584. (if (and (>= marker beg) (< marker end))
  6585. (push (cons marker (- marker beg)) org-markers-to-move))))
  6586. (defun org-reinstall-markers-in-region (beg)
  6587. "Move all remembered markers to their position relative to BEG."
  6588. (mapc (lambda (x)
  6589. (move-marker (car x) (+ beg (cdr x))))
  6590. org-markers-to-move)
  6591. (setq org-markers-to-move nil))
  6592. (defun org-narrow-to-subtree ()
  6593. "Narrow buffer to the current subtree."
  6594. (interactive)
  6595. (save-excursion
  6596. (save-match-data
  6597. (narrow-to-region
  6598. (progn (org-back-to-heading t) (point))
  6599. (progn (org-end-of-subtree t t)
  6600. (if (org-on-heading-p) (backward-char 1))
  6601. (point))))))
  6602. (eval-when-compile
  6603. (defvar org-property-drawer-re))
  6604. (defun org-clone-subtree-with-time-shift (n &optional shift)
  6605. "Clone the task (subtree) at point N times.
  6606. The clones will be inserted as siblings.
  6607. In interactive use, the user will be prompted for the number of
  6608. clones to be produced, and for a time SHIFT, which may be a
  6609. repeater as used in time stamps, for example `+3d'.
  6610. When a valid repeater is given and the entry contains any time
  6611. stamps, the clones will become a sequence in time, with time
  6612. stamps in the subtree shifted for each clone produced. If SHIFT
  6613. is nil or the empty string, time stamps will be left alone. The
  6614. ID property of the original subtree is removed.
  6615. If the original subtree did contain time stamps with a repeater,
  6616. the following will happen:
  6617. - the repeater will be removed in each clone
  6618. - an additional clone will be produced, with the current, unshifted
  6619. date(s) in the entry.
  6620. - the original entry will be placed *after* all the clones, with
  6621. repeater intact.
  6622. - the start days in the repeater in the original entry will be shifted
  6623. to past the last clone.
  6624. I this way you can spell out a number of instances of a repeating task,
  6625. and still retain the repeater to cover future instances of the task."
  6626. (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
  6627. (let (beg end template task idprop
  6628. shift-n shift-what doshift nmin nmax (n-no-remove -1))
  6629. (if (not (and (integerp n) (> n 0)))
  6630. (error "Invalid number of replications %s" n))
  6631. (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
  6632. (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([dwmy]\\)[ \t]*\\'"
  6633. shift)))
  6634. (error "Invalid shift specification %s" shift))
  6635. (when doshift
  6636. (setq shift-n (string-to-number (match-string 1 shift))
  6637. shift-what (cdr (assoc (match-string 2 shift)
  6638. '(("d" . day) ("w" . week)
  6639. ("m" . month) ("y" . year))))))
  6640. (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
  6641. (setq nmin 1 nmax n)
  6642. (org-back-to-heading t)
  6643. (setq beg (point))
  6644. (setq idprop (org-entry-get nil "ID"))
  6645. (org-end-of-subtree t t)
  6646. (or (bolp) (insert "\n"))
  6647. (setq end (point))
  6648. (setq template (buffer-substring beg end))
  6649. (when (and doshift
  6650. (string-match "<[^<>\n]+ \\+[0-9]+[dwmy][^<>\n]*>" template))
  6651. (delete-region beg end)
  6652. (setq end beg)
  6653. (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
  6654. (goto-char end)
  6655. (loop for n from nmin to nmax do
  6656. ;; prepare clone
  6657. (with-temp-buffer
  6658. (insert template)
  6659. (org-mode)
  6660. (goto-char (point-min))
  6661. (and idprop (if org-clone-delete-id
  6662. (org-entry-delete nil "ID")
  6663. (org-id-get-create t)))
  6664. (while (re-search-forward org-property-drawer-re nil t)
  6665. (org-remove-empty-drawer-at "PROPERTIES" (point)))
  6666. (goto-char (point-min))
  6667. (when doshift
  6668. (while (re-search-forward org-ts-regexp-both nil t)
  6669. (org-timestamp-change (* n shift-n) shift-what))
  6670. (unless (= n n-no-remove)
  6671. (goto-char (point-min))
  6672. (while (re-search-forward org-ts-regexp nil t)
  6673. (save-excursion
  6674. (goto-char (match-beginning 0))
  6675. (if (looking-at "<[^<>\n]+\\( +\\+[0-9]+[dwmy]\\)")
  6676. (delete-region (match-beginning 1) (match-end 1)))))))
  6677. (setq task (buffer-string)))
  6678. (insert task))
  6679. (goto-char beg)))
  6680. ;;; Outline Sorting
  6681. (defun org-sort (with-case)
  6682. "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
  6683. Optional argument WITH-CASE means sort case-sensitively.
  6684. With a double prefix argument, also remove duplicate entries."
  6685. (interactive "P")
  6686. (if (org-at-table-p)
  6687. (org-call-with-arg 'org-table-sort-lines with-case)
  6688. (org-call-with-arg 'org-sort-entries-or-items with-case)))
  6689. (defun org-sort-remove-invisible (s)
  6690. (remove-text-properties 0 (length s) org-rm-props s)
  6691. (while (string-match org-bracket-link-regexp s)
  6692. (setq s (replace-match (if (match-end 2)
  6693. (match-string 3 s)
  6694. (match-string 1 s)) t t s)))
  6695. s)
  6696. (defvar org-priority-regexp) ; defined later in the file
  6697. (defvar org-after-sorting-entries-or-items-hook nil
  6698. "Hook that is run after a bunch of entries or items have been sorted.
  6699. When children are sorted, the cursor is in the parent line when this
  6700. hook gets called. When a region or a plain list is sorted, the cursor
  6701. will be in the first entry of the sorted region/list.")
  6702. (defun org-sort-entries-or-items
  6703. (&optional with-case sorting-type getkey-func compare-func property)
  6704. "Sort entries on a certain level of an outline tree, or plain list items.
  6705. If there is an active region, the entries in the region are sorted.
  6706. Else, if the cursor is before the first entry, sort the top-level items.
  6707. Else, the children of the entry at point are sorted.
  6708. If the cursor is at the first item in a plain list, the list items will be
  6709. sorted.
  6710. Sorting can be alphabetically, numerically, by date/time as given by
  6711. a time stamp, by a property or by priority.
  6712. The command prompts for the sorting type unless it has been given to the
  6713. function through the SORTING-TYPE argument, which needs to be a character,
  6714. \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
  6715. precise meaning of each character:
  6716. n Numerically, by converting the beginning of the entry/item to a number.
  6717. a Alphabetically, ignoring the TODO keyword and the priority, if any.
  6718. t By date/time, either the first active time stamp in the entry, or, if
  6719. none exist, by the first inactive one.
  6720. In items, only the first line will be checked.
  6721. s By the scheduled date/time.
  6722. d By deadline date/time.
  6723. c By creation time, which is assumed to be the first inactive time stamp
  6724. at the beginning of a line.
  6725. p By priority according to the cookie.
  6726. r By the value of a property.
  6727. Capital letters will reverse the sort order.
  6728. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
  6729. called with point at the beginning of the record. It must return either
  6730. a string or a number that should serve as the sorting key for that record.
  6731. Comparing entries ignores case by default. However, with an optional argument
  6732. WITH-CASE, the sorting considers case as well."
  6733. (interactive "P")
  6734. (let ((case-func (if with-case 'identity 'downcase))
  6735. start beg end stars re re2
  6736. txt what tmp plain-list-p)
  6737. ;; Find beginning and end of region to sort
  6738. (cond
  6739. ((org-region-active-p)
  6740. ;; we will sort the region
  6741. (setq end (region-end)
  6742. what "region")
  6743. (goto-char (region-beginning))
  6744. (if (not (org-on-heading-p)) (outline-next-heading))
  6745. (setq start (point)))
  6746. ((org-at-item-p)
  6747. ;; we will sort this plain list
  6748. (org-beginning-of-item-list) (setq start (point))
  6749. (org-end-of-item-list)
  6750. (or (bolp) (insert "\n"))
  6751. (setq end (point))
  6752. (goto-char start)
  6753. (setq plain-list-p t
  6754. what "plain list"))
  6755. ((or (org-on-heading-p)
  6756. (condition-case nil (progn (org-back-to-heading) t) (error nil)))
  6757. ;; we will sort the children of the current headline
  6758. (org-back-to-heading)
  6759. (setq start (point)
  6760. end (progn (org-end-of-subtree t t)
  6761. (or (bolp) (insert "\n"))
  6762. (org-back-over-empty-lines)
  6763. (point))
  6764. what "children")
  6765. (goto-char start)
  6766. (show-subtree)
  6767. (outline-next-heading))
  6768. (t
  6769. ;; we will sort the top-level entries in this file
  6770. (goto-char (point-min))
  6771. (or (org-on-heading-p) (outline-next-heading))
  6772. (setq start (point))
  6773. (goto-char (point-max))
  6774. (beginning-of-line 1)
  6775. (when (looking-at ".*?\\S-")
  6776. ;; File ends in a non-white line
  6777. (end-of-line 1)
  6778. (insert "\n"))
  6779. (setq end (point-max))
  6780. (setq what "top-level")
  6781. (goto-char start)
  6782. (show-all)))
  6783. (setq beg (point))
  6784. (if (>= beg end) (error "Nothing to sort"))
  6785. (unless plain-list-p
  6786. (looking-at "\\(\\*+\\)")
  6787. (setq stars (match-string 1)
  6788. re (concat "^" (regexp-quote stars) " +")
  6789. re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
  6790. txt (buffer-substring beg end))
  6791. (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
  6792. (if (and (not (equal stars "*")) (string-match re2 txt))
  6793. (error "Region to sort contains a level above the first entry")))
  6794. (unless sorting-type
  6795. (message
  6796. (if plain-list-p
  6797. "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
  6798. "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
  6799. [t]ime [s]cheduled [d]eadline [c]reated
  6800. A/N/T/S/D/C/P/O/F means reversed:")
  6801. what)
  6802. (setq sorting-type (read-char-exclusive))
  6803. (and (= (downcase sorting-type) ?f)
  6804. (setq getkey-func
  6805. (org-icompleting-read "Sort using function: "
  6806. obarray 'fboundp t nil nil))
  6807. (setq getkey-func (intern getkey-func)))
  6808. (and (= (downcase sorting-type) ?r)
  6809. (setq property
  6810. (org-icompleting-read "Property: "
  6811. (mapcar 'list (org-buffer-property-keys t))
  6812. nil t))))
  6813. (message "Sorting entries...")
  6814. (save-restriction
  6815. (narrow-to-region start end)
  6816. (let ((dcst (downcase sorting-type))
  6817. (case-fold-search nil)
  6818. (now (current-time)))
  6819. (sort-subr
  6820. (/= dcst sorting-type)
  6821. ;; This function moves to the beginning character of the "record" to
  6822. ;; be sorted.
  6823. (if plain-list-p
  6824. (lambda nil
  6825. (if (org-at-item-p) t (goto-char (point-max))))
  6826. (lambda nil
  6827. (if (re-search-forward re nil t)
  6828. (goto-char (match-beginning 0))
  6829. (goto-char (point-max)))))
  6830. ;; This function moves to the last character of the "record" being
  6831. ;; sorted.
  6832. (if plain-list-p
  6833. 'org-end-of-item
  6834. (lambda nil
  6835. (save-match-data
  6836. (condition-case nil
  6837. (outline-forward-same-level 1)
  6838. (error
  6839. (goto-char (point-max)))))))
  6840. ;; This function returns the value that gets sorted against.
  6841. (if plain-list-p
  6842. (lambda nil
  6843. (when (looking-at "[ \t]*[-+*0-9.)]+[ \t]+")
  6844. (cond
  6845. ((= dcst ?n)
  6846. (string-to-number (buffer-substring (match-end 0)
  6847. (point-at-eol))))
  6848. ((= dcst ?a)
  6849. (buffer-substring (match-end 0) (point-at-eol)))
  6850. ((= dcst ?t)
  6851. (if (or (re-search-forward org-ts-regexp (point-at-eol) t)
  6852. (re-search-forward org-ts-regexp-both
  6853. (point-at-eol) t))
  6854. (org-time-string-to-seconds (match-string 0))
  6855. (org-float-time now)))
  6856. ((= dcst ?f)
  6857. (if getkey-func
  6858. (progn
  6859. (setq tmp (funcall getkey-func))
  6860. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  6861. tmp)
  6862. (error "Invalid key function `%s'" getkey-func)))
  6863. (t (error "Invalid sorting type `%c'" sorting-type)))))
  6864. (lambda nil
  6865. (cond
  6866. ((= dcst ?n)
  6867. (if (looking-at org-complex-heading-regexp)
  6868. (string-to-number (match-string 4))
  6869. nil))
  6870. ((= dcst ?a)
  6871. (if (looking-at org-complex-heading-regexp)
  6872. (funcall case-func (match-string 4))
  6873. nil))
  6874. ((= dcst ?t)
  6875. (let ((end (save-excursion (outline-next-heading) (point))))
  6876. (if (or (re-search-forward org-ts-regexp end t)
  6877. (re-search-forward org-ts-regexp-both end t))
  6878. (org-time-string-to-seconds (match-string 0))
  6879. (org-float-time now))))
  6880. ((= dcst ?c)
  6881. (let ((end (save-excursion (outline-next-heading) (point))))
  6882. (if (re-search-forward
  6883. (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
  6884. end t)
  6885. (org-time-string-to-seconds (match-string 0))
  6886. (org-float-time now))))
  6887. ((= dcst ?s)
  6888. (let ((end (save-excursion (outline-next-heading) (point))))
  6889. (if (re-search-forward org-scheduled-time-regexp end t)
  6890. (org-time-string-to-seconds (match-string 1))
  6891. (org-float-time now))))
  6892. ((= dcst ?d)
  6893. (let ((end (save-excursion (outline-next-heading) (point))))
  6894. (if (re-search-forward org-deadline-time-regexp end t)
  6895. (org-time-string-to-seconds (match-string 1))
  6896. (org-float-time now))))
  6897. ((= dcst ?p)
  6898. (if (re-search-forward org-priority-regexp (point-at-eol) t)
  6899. (string-to-char (match-string 2))
  6900. org-default-priority))
  6901. ((= dcst ?r)
  6902. (or (org-entry-get nil property) ""))
  6903. ((= dcst ?o)
  6904. (if (looking-at org-complex-heading-regexp)
  6905. (- 9999 (length (member (match-string 2)
  6906. org-todo-keywords-1)))))
  6907. ((= dcst ?f)
  6908. (if getkey-func
  6909. (progn
  6910. (setq tmp (funcall getkey-func))
  6911. (if (stringp tmp) (setq tmp (funcall case-func tmp)))
  6912. tmp)
  6913. (error "Invalid key function `%s'" getkey-func)))
  6914. (t (error "Invalid sorting type `%c'" sorting-type)))))
  6915. nil
  6916. (cond
  6917. ((= dcst ?a) 'string<)
  6918. ((= dcst ?f) compare-func)
  6919. ((member dcst '(?p ?t ?s ?d ?c)) '<)
  6920. (t nil)))))
  6921. (run-hooks 'org-after-sorting-entries-or-items-hook)
  6922. (message "Sorting entries...done")))
  6923. (defun org-do-sort (table what &optional with-case sorting-type)
  6924. "Sort TABLE of WHAT according to SORTING-TYPE.
  6925. The user will be prompted for the SORTING-TYPE if the call to this
  6926. function does not specify it. WHAT is only for the prompt, to indicate
  6927. what is being sorted. The sorting key will be extracted from
  6928. the car of the elements of the table.
  6929. If WITH-CASE is non-nil, the sorting will be case-sensitive."
  6930. (unless sorting-type
  6931. (message
  6932. "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
  6933. what)
  6934. (setq sorting-type (read-char-exclusive)))
  6935. (let ((dcst (downcase sorting-type))
  6936. extractfun comparefun)
  6937. ;; Define the appropriate functions
  6938. (cond
  6939. ((= dcst ?n)
  6940. (setq extractfun 'string-to-number
  6941. comparefun (if (= dcst sorting-type) '< '>)))
  6942. ((= dcst ?a)
  6943. (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
  6944. (lambda(x) (downcase (org-sort-remove-invisible x))))
  6945. comparefun (if (= dcst sorting-type)
  6946. 'string<
  6947. (lambda (a b) (and (not (string< a b))
  6948. (not (string= a b)))))))
  6949. ((= dcst ?t)
  6950. (setq extractfun
  6951. (lambda (x)
  6952. (if (or (string-match org-ts-regexp x)
  6953. (string-match org-ts-regexp-both x))
  6954. (org-float-time
  6955. (org-time-string-to-time (match-string 0 x)))
  6956. 0))
  6957. comparefun (if (= dcst sorting-type) '< '>)))
  6958. (t (error "Invalid sorting type `%c'" sorting-type)))
  6959. (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
  6960. table)
  6961. (lambda (a b) (funcall comparefun (car a) (car b))))))
  6962. ;;; The orgstruct minor mode
  6963. ;; Define a minor mode which can be used in other modes in order to
  6964. ;; integrate the org-mode structure editing commands.
  6965. ;; This is really a hack, because the org-mode structure commands use
  6966. ;; keys which normally belong to the major mode. Here is how it
  6967. ;; works: The minor mode defines all the keys necessary to operate the
  6968. ;; structure commands, but wraps the commands into a function which
  6969. ;; tests if the cursor is currently at a headline or a plain list
  6970. ;; item. If that is the case, the structure command is used,
  6971. ;; temporarily setting many Org-mode variables like regular
  6972. ;; expressions for filling etc. However, when any of those keys is
  6973. ;; used at a different location, function uses `key-binding' to look
  6974. ;; up if the key has an associated command in another currently active
  6975. ;; keymap (minor modes, major mode, global), and executes that
  6976. ;; command. There might be problems if any of the keys is otherwise
  6977. ;; used as a prefix key.
  6978. ;; Another challenge is that the key binding for TAB can be tab or \C-i,
  6979. ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
  6980. ;; addresses this by checking explicitly for both bindings.
  6981. (defvar orgstruct-mode-map (make-sparse-keymap)
  6982. "Keymap for the minor `orgstruct-mode'.")
  6983. (defvar org-local-vars nil
  6984. "List of local variables, for use by `orgstruct-mode'")
  6985. ;;;###autoload
  6986. (define-minor-mode orgstruct-mode
  6987. "Toggle the minor mode `orgstruct-mode'.
  6988. This mode is for using Org-mode structure commands in other
  6989. modes. The following keys behave as if Org-mode were active, if
  6990. the cursor is on a headline, or on a plain list item (both as
  6991. defined by Org-mode).
  6992. M-up Move entry/item up
  6993. M-down Move entry/item down
  6994. M-left Promote
  6995. M-right Demote
  6996. M-S-up Move entry/item up
  6997. M-S-down Move entry/item down
  6998. M-S-left Promote subtree
  6999. M-S-right Demote subtree
  7000. M-q Fill paragraph and items like in Org-mode
  7001. C-c ^ Sort entries
  7002. C-c - Cycle list bullet
  7003. TAB Cycle item visibility
  7004. M-RET Insert new heading/item
  7005. S-M-RET Insert new TODO heading / Checkbox item
  7006. C-c C-c Set tags / toggle checkbox"
  7007. nil " OrgStruct" nil
  7008. (org-load-modules-maybe)
  7009. (and (orgstruct-setup) (defun orgstruct-setup () nil)))
  7010. ;;;###autoload
  7011. (defun turn-on-orgstruct ()
  7012. "Unconditionally turn on `orgstruct-mode'."
  7013. (orgstruct-mode 1))
  7014. (defun orgstruct++-mode (&optional arg)
  7015. "Toggle `orgstruct-mode', the enhanced version of it.
  7016. In addition to setting orgstruct-mode, this also exports all indentation
  7017. and autofilling variables from org-mode into the buffer. It will also
  7018. recognize item context in multiline items.
  7019. Note that turning off orgstruct-mode will *not* remove the
  7020. indentation/paragraph settings. This can only be done by refreshing the
  7021. major mode, for example with \\[normal-mode]."
  7022. (interactive "P")
  7023. (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
  7024. (if (< arg 1)
  7025. (orgstruct-mode -1)
  7026. (orgstruct-mode 1)
  7027. (let (var val)
  7028. (mapc
  7029. (lambda (x)
  7030. (when (string-match
  7031. "^\\(paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
  7032. (symbol-name (car x)))
  7033. (setq var (car x) val (nth 1 x))
  7034. (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
  7035. org-local-vars)
  7036. (org-set-local 'orgstruct-is-++ t))))
  7037. (defvar orgstruct-is-++ nil
  7038. "Is orgstruct-mode in ++ version in the current-buffer?")
  7039. (make-variable-buffer-local 'orgstruct-is-++)
  7040. ;;;###autoload
  7041. (defun turn-on-orgstruct++ ()
  7042. "Unconditionally turn on `orgstruct++-mode'."
  7043. (orgstruct++-mode 1))
  7044. (defun orgstruct-error ()
  7045. "Error when there is no default binding for a structure key."
  7046. (interactive)
  7047. (error "This key has no function outside structure elements"))
  7048. (defun orgstruct-setup ()
  7049. "Setup orgstruct keymaps."
  7050. (let ((nfunc 0)
  7051. (bindings
  7052. (list
  7053. '([(meta up)] org-metaup)
  7054. '([(meta down)] org-metadown)
  7055. '([(meta left)] org-metaleft)
  7056. '([(meta right)] org-metaright)
  7057. '([(meta shift up)] org-shiftmetaup)
  7058. '([(meta shift down)] org-shiftmetadown)
  7059. '([(meta shift left)] org-shiftmetaleft)
  7060. '([(meta shift right)] org-shiftmetaright)
  7061. '([?\e (up)] org-metaup)
  7062. '([?\e (down)] org-metadown)
  7063. '([?\e (left)] org-metaleft)
  7064. '([?\e (right)] org-metaright)
  7065. '([?\e (shift up)] org-shiftmetaup)
  7066. '([?\e (shift down)] org-shiftmetadown)
  7067. '([?\e (shift left)] org-shiftmetaleft)
  7068. '([?\e (shift right)] org-shiftmetaright)
  7069. '([(shift up)] org-shiftup)
  7070. '([(shift down)] org-shiftdown)
  7071. '([(shift left)] org-shiftleft)
  7072. '([(shift right)] org-shiftright)
  7073. '("\C-c\C-c" org-ctrl-c-ctrl-c)
  7074. '("\M-q" fill-paragraph)
  7075. '("\C-c^" org-sort)
  7076. '("\C-c-" org-cycle-list-bullet)))
  7077. elt key fun cmd)
  7078. (while (setq elt (pop bindings))
  7079. (setq nfunc (1+ nfunc))
  7080. (setq key (org-key (car elt))
  7081. fun (nth 1 elt)
  7082. cmd (orgstruct-make-binding fun nfunc key))
  7083. (org-defkey orgstruct-mode-map key cmd))
  7084. ;; Special treatment needed for TAB and RET
  7085. (org-defkey orgstruct-mode-map [(tab)]
  7086. (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
  7087. (org-defkey orgstruct-mode-map "\C-i"
  7088. (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
  7089. (org-defkey orgstruct-mode-map "\M-\C-m"
  7090. (orgstruct-make-binding 'org-insert-heading 105
  7091. "\M-\C-m" [(meta return)]))
  7092. (org-defkey orgstruct-mode-map [(meta return)]
  7093. (orgstruct-make-binding 'org-insert-heading 106
  7094. [(meta return)] "\M-\C-m"))
  7095. (org-defkey orgstruct-mode-map [(shift meta return)]
  7096. (orgstruct-make-binding 'org-insert-todo-heading 107
  7097. [(meta return)] "\M-\C-m"))
  7098. (org-defkey orgstruct-mode-map "\e\C-m"
  7099. (orgstruct-make-binding 'org-insert-heading 108
  7100. "\e\C-m" [?\e (return)]))
  7101. (org-defkey orgstruct-mode-map [?\e (return)]
  7102. (orgstruct-make-binding 'org-insert-heading 109
  7103. [?\e (return)] "\e\C-m"))
  7104. (org-defkey orgstruct-mode-map [?\e (shift return)]
  7105. (orgstruct-make-binding 'org-insert-todo-heading 110
  7106. [?\e (return)] "\e\C-m"))
  7107. (unless org-local-vars
  7108. (setq org-local-vars (org-get-local-variables)))
  7109. t))
  7110. (defun orgstruct-make-binding (fun n &rest keys)
  7111. "Create a function for binding in the structure minor mode.
  7112. FUN is the command to call inside a table. N is used to create a unique
  7113. command name. KEYS are keys that should be checked in for a command
  7114. to execute outside of tables."
  7115. (eval
  7116. (list 'defun
  7117. (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
  7118. '(arg)
  7119. (concat "In Structure, run `" (symbol-name fun) "'.\n"
  7120. "Outside of structure, run the binding of `"
  7121. (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
  7122. "'.")
  7123. '(interactive "p")
  7124. (list 'if
  7125. `(org-context-p 'headline 'item
  7126. (and orgstruct-is-++
  7127. ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
  7128. 'item-body))
  7129. (list 'org-run-like-in-org-mode (list 'quote fun))
  7130. (list 'let '(orgstruct-mode)
  7131. (list 'call-interactively
  7132. (append '(or)
  7133. (mapcar (lambda (k)
  7134. (list 'key-binding k))
  7135. keys)
  7136. '('orgstruct-error))))))))
  7137. (defun org-context-p (&rest contexts)
  7138. "Check if local context is any of CONTEXTS.
  7139. Possible values in the list of contexts are `table', `headline', and `item'."
  7140. (let ((pos (point)))
  7141. (goto-char (point-at-bol))
  7142. (prog1 (or (and (memq 'table contexts)
  7143. (looking-at "[ \t]*|"))
  7144. (and (memq 'headline contexts)
  7145. ;;????????? (looking-at "\\*+"))
  7146. (looking-at outline-regexp))
  7147. (and (memq 'item contexts)
  7148. (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
  7149. (and (memq 'item-body contexts)
  7150. (org-in-item-p)))
  7151. (goto-char pos))))
  7152. (defun org-get-local-variables ()
  7153. "Return a list of all local variables in an org-mode buffer."
  7154. (let (varlist)
  7155. (with-current-buffer (get-buffer-create "*Org tmp*")
  7156. (erase-buffer)
  7157. (org-mode)
  7158. (setq varlist (buffer-local-variables)))
  7159. (kill-buffer "*Org tmp*")
  7160. (delq nil
  7161. (mapcar
  7162. (lambda (x)
  7163. (setq x
  7164. (if (symbolp x)
  7165. (list x)
  7166. (list (car x) (list 'quote (cdr x)))))
  7167. (if (string-match
  7168. "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
  7169. (symbol-name (car x)))
  7170. x nil))
  7171. varlist))))
  7172. ;;;###autoload
  7173. (defun org-run-like-in-org-mode (cmd)
  7174. "Run a command, pretending that the current buffer is in Org-mode.
  7175. This will temporarily bind local variables that are typically bound in
  7176. Org-mode to the values they have in Org-mode, and then interactively
  7177. call CMD."
  7178. (org-load-modules-maybe)
  7179. (unless org-local-vars
  7180. (setq org-local-vars (org-get-local-variables)))
  7181. (eval (list 'let org-local-vars
  7182. (list 'call-interactively (list 'quote cmd)))))
  7183. ;;;; Archiving
  7184. (defun org-get-category (&optional pos)
  7185. "Get the category applying to position POS."
  7186. (get-text-property (or pos (point)) 'org-category))
  7187. (defun org-refresh-category-properties ()
  7188. "Refresh category text properties in the buffer."
  7189. (let ((def-cat (cond
  7190. ((null org-category)
  7191. (if buffer-file-name
  7192. (file-name-sans-extension
  7193. (file-name-nondirectory buffer-file-name))
  7194. "???"))
  7195. ((symbolp org-category) (symbol-name org-category))
  7196. (t org-category)))
  7197. beg end cat pos optionp)
  7198. (org-unmodified
  7199. (save-excursion
  7200. (save-restriction
  7201. (widen)
  7202. (goto-char (point-min))
  7203. (put-text-property (point) (point-max) 'org-category def-cat)
  7204. (while (re-search-forward
  7205. "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
  7206. (setq pos (match-end 0)
  7207. optionp (equal (char-after (match-beginning 0)) ?#)
  7208. cat (org-trim (match-string 2)))
  7209. (if optionp
  7210. (setq beg (point-at-bol) end (point-max))
  7211. (org-back-to-heading t)
  7212. (setq beg (point) end (org-end-of-subtree t t)))
  7213. (put-text-property beg end 'org-category cat)
  7214. (goto-char pos)))))))
  7215. ;;;; Link Stuff
  7216. ;;; Link abbreviations
  7217. (defun org-link-expand-abbrev (link)
  7218. "Apply replacements as defined in `org-link-abbrev-alist."
  7219. (if (string-match "^\\([a-zA-Z][-_a-zA-Z0-9]*\\)\\(::?\\(.*\\)\\)?$" link)
  7220. (let* ((key (match-string 1 link))
  7221. (as (or (assoc key org-link-abbrev-alist-local)
  7222. (assoc key org-link-abbrev-alist)))
  7223. (tag (and (match-end 2) (match-string 3 link)))
  7224. rpl)
  7225. (if (not as)
  7226. link
  7227. (setq rpl (cdr as))
  7228. (cond
  7229. ((symbolp rpl) (funcall rpl tag))
  7230. ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
  7231. ((string-match "%h" rpl)
  7232. (replace-match (url-hexify-string (or tag "")) t t rpl))
  7233. (t (concat rpl tag)))))
  7234. link))
  7235. ;;; Storing and inserting links
  7236. (defvar org-insert-link-history nil
  7237. "Minibuffer history for links inserted with `org-insert-link'.")
  7238. (defvar org-stored-links nil
  7239. "Contains the links stored with `org-store-link'.")
  7240. (defvar org-store-link-plist nil
  7241. "Plist with info about the most recently link created with `org-store-link'.")
  7242. (defvar org-link-protocols nil
  7243. "Link protocols added to Org-mode using `org-add-link-type'.")
  7244. (defvar org-store-link-functions nil
  7245. "List of functions that are called to create and store a link.
  7246. Each function will be called in turn until one returns a non-nil
  7247. value. Each function should check if it is responsible for creating
  7248. this link (for example by looking at the major mode).
  7249. If not, it must exit and return nil.
  7250. If yes, it should return a non-nil value after a calling
  7251. `org-store-link-props' with a list of properties and values.
  7252. Special properties are:
  7253. :type The link prefix. like \"http\". This must be given.
  7254. :link The link, like \"http://www.astro.uva.nl/~dominik\".
  7255. This is obligatory as well.
  7256. :description Optional default description for the second pair
  7257. of brackets in an Org-mode link. The user can still change
  7258. this when inserting this link into an Org-mode buffer.
  7259. In addition to these, any additional properties can be specified
  7260. and then used in remember templates.")
  7261. (defun org-add-link-type (type &optional follow export)
  7262. "Add TYPE to the list of `org-link-types'.
  7263. Re-compute all regular expressions depending on `org-link-types'
  7264. FOLLOW and EXPORT are two functions.
  7265. FOLLOW should take the link path as the single argument and do whatever
  7266. is necessary to follow the link, for example find a file or display
  7267. a mail message.
  7268. EXPORT should format the link path for export to one of the export formats.
  7269. It should be a function accepting three arguments:
  7270. path the path of the link, the text after the prefix (like \"http:\")
  7271. desc the description of the link, if any, nil if there was no description
  7272. format the export format, a symbol like `html' or `latex'.
  7273. The function may use the FORMAT information to return different values
  7274. depending on the format. The return value will be put literally into
  7275. the exported file.
  7276. Org-mode has a built-in default for exporting links. If you are happy with
  7277. this default, there is no need to define an export function for the link
  7278. type. For a simple example of an export function, see `org-bbdb.el'."
  7279. (add-to-list 'org-link-types type t)
  7280. (org-make-link-regexps)
  7281. (if (assoc type org-link-protocols)
  7282. (setcdr (assoc type org-link-protocols) (list follow export))
  7283. (push (list type follow export) org-link-protocols)))
  7284. (defvar org-agenda-buffer-name)
  7285. ;;;###autoload
  7286. (defun org-store-link (arg)
  7287. "\\<org-mode-map>Store an org-link to the current location.
  7288. This link is added to `org-stored-links' and can later be inserted
  7289. into an org-buffer with \\[org-insert-link].
  7290. For some link types, a prefix arg is interpreted:
  7291. For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
  7292. For file links, arg negates `org-context-in-file-links'."
  7293. (interactive "P")
  7294. (org-load-modules-maybe)
  7295. (setq org-store-link-plist nil) ; reset
  7296. (let ((outline-regexp (org-get-limited-outline-regexp))
  7297. link cpltxt desc description search txt custom-id)
  7298. (cond
  7299. ((run-hook-with-args-until-success 'org-store-link-functions)
  7300. (setq link (plist-get org-store-link-plist :link)
  7301. desc (or (plist-get org-store-link-plist :description) link)))
  7302. ((equal (buffer-name) "*Org Edit Src Example*")
  7303. (let (label gc)
  7304. (while (or (not label)
  7305. (save-excursion
  7306. (save-restriction
  7307. (widen)
  7308. (goto-char (point-min))
  7309. (re-search-forward
  7310. (regexp-quote (format org-coderef-label-format label))
  7311. nil t))))
  7312. (when label (message "Label exists already") (sit-for 2))
  7313. (setq label (read-string "Code line label: " label)))
  7314. (end-of-line 1)
  7315. (setq link (format org-coderef-label-format label))
  7316. (setq gc (- 79 (length link)))
  7317. (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
  7318. (insert link)
  7319. (setq link (concat "(" label ")") desc nil)))
  7320. ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
  7321. ;; We are in the agenda, link to referenced location
  7322. (let ((m (or (get-text-property (point) 'org-hd-marker)
  7323. (get-text-property (point) 'org-marker))))
  7324. (when m
  7325. (org-with-point-at m
  7326. (if (interactive-p)
  7327. (call-interactively 'org-store-link)
  7328. (org-store-link nil))))))
  7329. ((eq major-mode 'calendar-mode)
  7330. (let ((cd (calendar-cursor-to-date)))
  7331. (setq link
  7332. (format-time-string
  7333. (car org-time-stamp-formats)
  7334. (apply 'encode-time
  7335. (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
  7336. nil nil nil))))
  7337. (org-store-link-props :type "calendar" :date cd)))
  7338. ((eq major-mode 'w3-mode)
  7339. (setq cpltxt (if (and (buffer-name)
  7340. (not (string-match "Untitled" (buffer-name))))
  7341. (buffer-name)
  7342. (url-view-url t))
  7343. link (org-make-link (url-view-url t)))
  7344. (org-store-link-props :type "w3" :url (url-view-url t)))
  7345. ((eq major-mode 'w3m-mode)
  7346. (setq cpltxt (or w3m-current-title w3m-current-url)
  7347. link (org-make-link w3m-current-url))
  7348. (org-store-link-props :type "w3m" :url (url-view-url t)))
  7349. ((setq search (run-hook-with-args-until-success
  7350. 'org-create-file-search-functions))
  7351. (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
  7352. "::" search))
  7353. (setq cpltxt (or description link)))
  7354. ((eq major-mode 'image-mode)
  7355. (setq cpltxt (concat "file:"
  7356. (abbreviate-file-name buffer-file-name))
  7357. link (org-make-link cpltxt))
  7358. (org-store-link-props :type "image" :file buffer-file-name))
  7359. ((eq major-mode 'dired-mode)
  7360. ;; link to the file in the current line
  7361. (let ((file (dired-get-filename nil t)))
  7362. (setq file (if file
  7363. (abbreviate-file-name
  7364. (expand-file-name (dired-get-filename nil t)))
  7365. ;; otherwise, no file so use current directory.
  7366. default-directory))
  7367. (setq cpltxt (concat "file:" file)
  7368. link (org-make-link cpltxt))))
  7369. ((and buffer-file-name (org-mode-p))
  7370. (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
  7371. (cond
  7372. ((org-in-regexp "<<\\(.*?\\)>>")
  7373. (setq cpltxt
  7374. (concat "file:"
  7375. (abbreviate-file-name buffer-file-name)
  7376. "::" (match-string 1))
  7377. link (org-make-link cpltxt)))
  7378. ((and (featurep 'org-id)
  7379. (or (eq org-link-to-org-use-id t)
  7380. (and (eq org-link-to-org-use-id 'create-if-interactive)
  7381. (interactive-p))
  7382. (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
  7383. (interactive-p)
  7384. (not custom-id))
  7385. (and org-link-to-org-use-id
  7386. (condition-case nil
  7387. (org-entry-get nil "ID")
  7388. (error nil)))))
  7389. ;; We can make a link using the ID.
  7390. (setq link (condition-case nil
  7391. (prog1 (org-id-store-link)
  7392. (setq desc (plist-get org-store-link-plist
  7393. :description)))
  7394. (error
  7395. ;; probably before first headline, link to file only
  7396. (concat "file:"
  7397. (abbreviate-file-name buffer-file-name))))))
  7398. (t
  7399. ;; Just link to current headline
  7400. (setq cpltxt (concat "file:"
  7401. (abbreviate-file-name buffer-file-name)))
  7402. ;; Add a context search string
  7403. (when (org-xor org-context-in-file-links arg)
  7404. (setq txt (cond
  7405. ((org-on-heading-p) nil)
  7406. ((org-region-active-p)
  7407. (buffer-substring (region-beginning) (region-end)))
  7408. (t nil)))
  7409. (when (or (null txt) (string-match "\\S-" txt))
  7410. (setq cpltxt
  7411. (concat cpltxt "::"
  7412. (condition-case nil
  7413. (org-make-org-heading-search-string txt)
  7414. (error "")))
  7415. desc (or (nth 4 (ignore-errors
  7416. (org-heading-components))) "NONE"))))
  7417. (if (string-match "::\\'" cpltxt)
  7418. (setq cpltxt (substring cpltxt 0 -2)))
  7419. (setq link (org-make-link cpltxt)))))
  7420. ((buffer-file-name (buffer-base-buffer))
  7421. ;; Just link to this file here.
  7422. (setq cpltxt (concat "file:"
  7423. (abbreviate-file-name
  7424. (buffer-file-name (buffer-base-buffer)))))
  7425. ;; Add a context string
  7426. (when (org-xor org-context-in-file-links arg)
  7427. (setq txt (if (org-region-active-p)
  7428. (buffer-substring (region-beginning) (region-end))
  7429. (buffer-substring (point-at-bol) (point-at-eol))))
  7430. ;; Only use search option if there is some text.
  7431. (when (string-match "\\S-" txt)
  7432. (setq cpltxt
  7433. (concat cpltxt "::" (org-make-org-heading-search-string txt))
  7434. desc "NONE")))
  7435. (setq link (org-make-link cpltxt)))
  7436. ((interactive-p)
  7437. (error "Cannot link to a buffer which is not visiting a file"))
  7438. (t (setq link nil)))
  7439. (if (consp link) (setq cpltxt (car link) link (cdr link)))
  7440. (setq link (or link cpltxt)
  7441. desc (or desc cpltxt))
  7442. (if (equal desc "NONE") (setq desc nil))
  7443. (if (and (or (interactive-p) executing-kbd-macro) link)
  7444. (progn
  7445. (setq org-stored-links
  7446. (cons (list link desc) org-stored-links))
  7447. (message "Stored: %s" (or desc link))
  7448. (when custom-id
  7449. (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
  7450. "::#" custom-id))
  7451. (setq org-stored-links
  7452. (cons (list link desc) org-stored-links))))
  7453. (and link (org-make-link-string link desc)))))
  7454. (defun org-store-link-props (&rest plist)
  7455. "Store link properties, extract names and addresses."
  7456. (let (x adr)
  7457. (when (setq x (plist-get plist :from))
  7458. (setq adr (mail-extract-address-components x))
  7459. (setq plist (plist-put plist :fromname (car adr)))
  7460. (setq plist (plist-put plist :fromaddress (nth 1 adr))))
  7461. (when (setq x (plist-get plist :to))
  7462. (setq adr (mail-extract-address-components x))
  7463. (setq plist (plist-put plist :toname (car adr)))
  7464. (setq plist (plist-put plist :toaddress (nth 1 adr)))))
  7465. (let ((from (plist-get plist :from))
  7466. (to (plist-get plist :to)))
  7467. (when (and from to org-from-is-user-regexp)
  7468. (setq plist
  7469. (plist-put plist :fromto
  7470. (if (string-match org-from-is-user-regexp from)
  7471. (concat "to %t")
  7472. (concat "from %f"))))))
  7473. (setq org-store-link-plist plist))
  7474. (defun org-add-link-props (&rest plist)
  7475. "Add these properties to the link property list."
  7476. (let (key value)
  7477. (while plist
  7478. (setq key (pop plist) value (pop plist))
  7479. (setq org-store-link-plist
  7480. (plist-put org-store-link-plist key value)))))
  7481. (defun org-email-link-description (&optional fmt)
  7482. "Return the description part of an email link.
  7483. This takes information from `org-store-link-plist' and formats it
  7484. according to FMT (default from `org-email-link-description-format')."
  7485. (setq fmt (or fmt org-email-link-description-format))
  7486. (let* ((p org-store-link-plist)
  7487. (to (plist-get p :toaddress))
  7488. (from (plist-get p :fromaddress))
  7489. (table
  7490. (list
  7491. (cons "%c" (plist-get p :fromto))
  7492. (cons "%F" (plist-get p :from))
  7493. (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
  7494. (cons "%T" (plist-get p :to))
  7495. (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
  7496. (cons "%s" (plist-get p :subject))
  7497. (cons "%m" (plist-get p :message-id)))))
  7498. (when (string-match "%c" fmt)
  7499. ;; Check if the user wrote this message
  7500. (if (and org-from-is-user-regexp from to
  7501. (save-match-data (string-match org-from-is-user-regexp from)))
  7502. (setq fmt (replace-match "to %t" t t fmt))
  7503. (setq fmt (replace-match "from %f" t t fmt))))
  7504. (org-replace-escapes fmt table)))
  7505. (defun org-make-org-heading-search-string (&optional string heading)
  7506. "Make search string for STRING or current headline."
  7507. (interactive)
  7508. (let ((s (or string (org-get-heading))))
  7509. (unless (and string (not heading))
  7510. ;; We are using a headline, clean up garbage in there.
  7511. (if (string-match org-todo-regexp s)
  7512. (setq s (replace-match "" t t s)))
  7513. (if (string-match (org-re ":[[:alnum:]_@:]+:[ \t]*$") s)
  7514. (setq s (replace-match "" t t s)))
  7515. (setq s (org-trim s))
  7516. (if (string-match (concat "^\\(" org-quote-string "\\|"
  7517. org-comment-string "\\)") s)
  7518. (setq s (replace-match "" t t s)))
  7519. (while (string-match org-ts-regexp s)
  7520. (setq s (replace-match "" t t s))))
  7521. (while (string-match "[^a-zA-Z_0-9 \t]+" s)
  7522. (setq s (replace-match " " t t s)))
  7523. (or string (setq s (concat "*" s))) ; Add * for headlines
  7524. (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
  7525. (defun org-make-link (&rest strings)
  7526. "Concatenate STRINGS."
  7527. (apply 'concat strings))
  7528. (defun org-make-link-string (link &optional description)
  7529. "Make a link with brackets, consisting of LINK and DESCRIPTION."
  7530. (unless (string-match "\\S-" link)
  7531. (error "Empty link"))
  7532. (when (and description
  7533. (stringp description)
  7534. (not (string-match "\\S-" description)))
  7535. (setq description nil))
  7536. (when (stringp description)
  7537. ;; Remove brackets from the description, they are fatal.
  7538. (while (string-match "\\[" description)
  7539. (setq description (replace-match "{" t t description)))
  7540. (while (string-match "\\]" description)
  7541. (setq description (replace-match "}" t t description))))
  7542. (when (equal (org-link-escape link) description)
  7543. ;; No description needed, it is identical
  7544. (setq description nil))
  7545. (when (and (not description)
  7546. (not (equal link (org-link-escape link))))
  7547. (setq description (org-extract-attributes link)))
  7548. (concat "[[" (org-link-escape link) "]"
  7549. (if description (concat "[" description "]") "")
  7550. "]"))
  7551. (defconst org-link-escape-chars
  7552. '((?\ . "%20")
  7553. (?\[ . "%5B")
  7554. (?\] . "%5D")
  7555. (?\340 . "%E0") ; `a
  7556. (?\342 . "%E2") ; ^a
  7557. (?\347 . "%E7") ; ,c
  7558. (?\350 . "%E8") ; `e
  7559. (?\351 . "%E9") ; 'e
  7560. (?\352 . "%EA") ; ^e
  7561. (?\356 . "%EE") ; ^i
  7562. (?\364 . "%F4") ; ^o
  7563. (?\371 . "%F9") ; `u
  7564. (?\373 . "%FB") ; ^u
  7565. (?\; . "%3B")
  7566. ;; (?? . "%3F")
  7567. (?= . "%3D")
  7568. (?+ . "%2B")
  7569. )
  7570. "Association list of escapes for some characters problematic in links.
  7571. This is the list that is used for internal purposes.")
  7572. (defvar org-url-encoding-use-url-hexify nil)
  7573. (defconst org-link-escape-chars-browser
  7574. '((?\ . "%20")) ; 32 for the SPC char
  7575. "Association list of escapes for some characters problematic in links.
  7576. This is the list that is used before handing over to the browser.")
  7577. (defun org-link-escape (text &optional table)
  7578. "Escape characters in TEXT that are problematic for links."
  7579. (if (and org-url-encoding-use-url-hexify (not table))
  7580. (url-hexify-string text)
  7581. (setq table (or table org-link-escape-chars))
  7582. (when text
  7583. (let ((re (mapconcat (lambda (x) (regexp-quote
  7584. (char-to-string (car x))))
  7585. table "\\|")))
  7586. (while (string-match re text)
  7587. (setq text
  7588. (replace-match
  7589. (cdr (assoc (string-to-char (match-string 0 text))
  7590. table))
  7591. t t text)))
  7592. text))))
  7593. (defun org-link-unescape (text &optional table)
  7594. "Reverse the action of `org-link-escape'."
  7595. (if (and org-url-encoding-use-url-hexify (not table))
  7596. (url-unhex-string text)
  7597. (setq table (or table org-link-escape-chars))
  7598. (when text
  7599. (let ((case-fold-search t)
  7600. (re (mapconcat (lambda (x) (regexp-quote (downcase (cdr x))))
  7601. table "\\|")))
  7602. (while (string-match re text)
  7603. (setq text
  7604. (replace-match
  7605. (char-to-string (car (rassoc (upcase (match-string 0 text))
  7606. table)))
  7607. t t text)))
  7608. text))))
  7609. (defun org-xor (a b)
  7610. "Exclusive or."
  7611. (if a (not b) b))
  7612. (defun org-fixup-message-id-for-http (s)
  7613. "Replace special characters in a message id, so it can be used in an http query."
  7614. (when (string-match "%" s)
  7615. (setq s (mapconcat (lambda (c)
  7616. (if (eq c ?%)
  7617. "%25"
  7618. (char-to-string c)))
  7619. s "")))
  7620. (while (string-match "<" s)
  7621. (setq s (replace-match "%3C" t t s)))
  7622. (while (string-match ">" s)
  7623. (setq s (replace-match "%3E" t t s)))
  7624. (while (string-match "@" s)
  7625. (setq s (replace-match "%40" t t s)))
  7626. s)
  7627. ;;;###autoload
  7628. (defun org-insert-link-global ()
  7629. "Insert a link like Org-mode does.
  7630. This command can be called in any mode to insert a link in Org-mode syntax."
  7631. (interactive)
  7632. (org-load-modules-maybe)
  7633. (org-run-like-in-org-mode 'org-insert-link))
  7634. (defun org-insert-link (&optional complete-file link-location)
  7635. "Insert a link. At the prompt, enter the link.
  7636. Completion can be used to insert any of the link protocol prefixes like
  7637. http or ftp in use.
  7638. The history can be used to select a link previously stored with
  7639. `org-store-link'. When the empty string is entered (i.e. if you just
  7640. press RET at the prompt), the link defaults to the most recently
  7641. stored link. As SPC triggers completion in the minibuffer, you need to
  7642. use M-SPC or C-q SPC to force the insertion of a space character.
  7643. You will also be prompted for a description, and if one is given, it will
  7644. be displayed in the buffer instead of the link.
  7645. If there is already a link at point, this command will allow you to edit link
  7646. and description parts.
  7647. With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
  7648. be selected using completion. The path to the file will be relative to the
  7649. current directory if the file is in the current directory or a subdirectory.
  7650. Otherwise, the link will be the absolute path as completed in the minibuffer
  7651. \(i.e. normally ~/path/to/file). You can configure this behavior using the
  7652. option `org-link-file-path-type'.
  7653. With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
  7654. the current directory or below.
  7655. With three \\[universal-argument] prefixes, negate the meaning of
  7656. `org-keep-stored-link-after-insertion'.
  7657. If `org-make-link-description-function' is non-nil, this function will be
  7658. called with the link target, and the result will be the default
  7659. link description.
  7660. If the LINK-LOCATION parameter is non-nil, this value will be
  7661. used as the link location instead of reading one interactively."
  7662. (interactive "P")
  7663. (let* ((wcf (current-window-configuration))
  7664. (region (if (org-region-active-p)
  7665. (buffer-substring (region-beginning) (region-end))))
  7666. (remove (and region (list (region-beginning) (region-end))))
  7667. (desc region)
  7668. tmphist ; byte-compile incorrectly complains about this
  7669. (link link-location)
  7670. entry file all-prefixes)
  7671. (cond
  7672. (link-location) ; specified by arg, just use it.
  7673. ((org-in-regexp org-bracket-link-regexp 1)
  7674. ;; We do have a link at point, and we are going to edit it.
  7675. (setq remove (list (match-beginning 0) (match-end 0)))
  7676. (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
  7677. (setq link (read-string "Link: "
  7678. (org-link-unescape
  7679. (org-match-string-no-properties 1)))))
  7680. ((or (org-in-regexp org-angle-link-re)
  7681. (org-in-regexp org-plain-link-re))
  7682. ;; Convert to bracket link
  7683. (setq remove (list (match-beginning 0) (match-end 0))
  7684. link (read-string "Link: "
  7685. (org-remove-angle-brackets (match-string 0)))))
  7686. ((member complete-file '((4) (16)))
  7687. ;; Completing read for file names.
  7688. (setq link (org-file-complete-link complete-file)))
  7689. (t
  7690. ;; Read link, with completion for stored links.
  7691. (with-output-to-temp-buffer "*Org Links*"
  7692. (princ "Insert a link.
  7693. Use TAB to complete link prefixes, then RET for type-specific completion support\n")
  7694. (when org-stored-links
  7695. (princ "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
  7696. (princ (mapconcat
  7697. (lambda (x)
  7698. (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
  7699. (reverse org-stored-links) "\n"))))
  7700. (let ((cw (selected-window)))
  7701. (select-window (get-buffer-window "*Org Links*" 'visible))
  7702. (setq truncate-lines t)
  7703. (unless (pos-visible-in-window-p (point-max))
  7704. (org-fit-window-to-buffer))
  7705. (and (window-live-p cw) (select-window cw)))
  7706. ;; Fake a link history, containing the stored links.
  7707. (setq tmphist (append (mapcar 'car org-stored-links)
  7708. org-insert-link-history))
  7709. (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
  7710. (mapcar 'car org-link-abbrev-alist)
  7711. org-link-types))
  7712. (unwind-protect
  7713. (progn
  7714. (setq link
  7715. (let ((org-completion-use-ido nil)
  7716. (org-completion-use-iswitchb nil))
  7717. (org-completing-read
  7718. "Link: "
  7719. (append
  7720. (mapcar (lambda (x) (list (concat x ":")))
  7721. all-prefixes)
  7722. (mapcar 'car org-stored-links))
  7723. nil nil nil
  7724. 'tmphist
  7725. (car (car org-stored-links)))))
  7726. (if (not (string-match "\\S-" link))
  7727. (error "No link selected"))
  7728. (if (or (member link all-prefixes)
  7729. (and (equal ":" (substring link -1))
  7730. (member (substring link 0 -1) all-prefixes)
  7731. (setq link (substring link 0 -1))))
  7732. (setq link (org-link-try-special-completion link))))
  7733. (set-window-configuration wcf)
  7734. (kill-buffer "*Org Links*"))
  7735. (setq entry (assoc link org-stored-links))
  7736. (or entry (push link org-insert-link-history))
  7737. (if (funcall (if (equal complete-file '(64)) 'not 'identity)
  7738. (not org-keep-stored-link-after-insertion))
  7739. (setq org-stored-links (delq (assoc link org-stored-links)
  7740. org-stored-links)))
  7741. (setq desc (or desc (nth 1 entry)))))
  7742. (if (string-match org-plain-link-re link)
  7743. ;; URL-like link, normalize the use of angular brackets.
  7744. (setq link (org-make-link (org-remove-angle-brackets link))))
  7745. ;; Check if we are linking to the current file with a search option
  7746. ;; If yes, simplify the link by using only the search option.
  7747. (when (and buffer-file-name
  7748. (string-match "^file:\\(.+?\\)::\\([^>]+\\)" link))
  7749. (let* ((path (match-string 1 link))
  7750. (case-fold-search nil)
  7751. (search (match-string 2 link)))
  7752. (save-match-data
  7753. (if (equal (file-truename buffer-file-name) (file-truename path))
  7754. ;; We are linking to this same file, with a search option
  7755. (setq link search)))))
  7756. ;; Check if we can/should use a relative path. If yes, simplify the link
  7757. (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
  7758. (let* ((type (match-string 1 link))
  7759. (path (match-string 2 link))
  7760. (origpath path)
  7761. (case-fold-search nil))
  7762. (cond
  7763. ((or (eq org-link-file-path-type 'absolute)
  7764. (equal complete-file '(16)))
  7765. (setq path (abbreviate-file-name (expand-file-name path))))
  7766. ((eq org-link-file-path-type 'noabbrev)
  7767. (setq path (expand-file-name path)))
  7768. ((eq org-link-file-path-type 'relative)
  7769. (setq path (file-relative-name path)))
  7770. (t
  7771. (save-match-data
  7772. (if (string-match (concat "^" (regexp-quote
  7773. (file-name-as-directory
  7774. default-directory)))
  7775. (expand-file-name path))
  7776. ;; We are linking a file with relative path name.
  7777. (setq path (substring (expand-file-name path)
  7778. (match-end 0)))
  7779. (setq path (abbreviate-file-name (expand-file-name path)))))))
  7780. (setq link (concat type path))
  7781. (if (equal desc origpath)
  7782. (setq desc path))))
  7783. (if org-make-link-description-function
  7784. (setq desc (funcall org-make-link-description-function link desc)))
  7785. (setq desc (read-string "Description: " desc))
  7786. (unless (string-match "\\S-" desc) (setq desc nil))
  7787. (if remove (apply 'delete-region remove))
  7788. (insert (org-make-link-string link desc))))
  7789. (defun org-link-try-special-completion (type)
  7790. "If there is completion support for link type TYPE, offer it."
  7791. (let ((fun (intern (concat "org-" type "-complete-link"))))
  7792. (if (functionp fun)
  7793. (funcall fun)
  7794. (read-string "Link (no completion support): " (concat type ":")))))
  7795. (defun org-file-complete-link (&optional arg)
  7796. "Create a file link using completion."
  7797. (let (file link)
  7798. (setq file (read-file-name "File: "))
  7799. (let ((pwd (file-name-as-directory (expand-file-name ".")))
  7800. (pwd1 (file-name-as-directory (abbreviate-file-name
  7801. (expand-file-name ".")))))
  7802. (cond
  7803. ((equal arg '(16))
  7804. (setq link (org-make-link
  7805. "file:"
  7806. (abbreviate-file-name (expand-file-name file)))))
  7807. ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
  7808. (setq link (org-make-link "file:" (match-string 1 file))))
  7809. ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
  7810. (expand-file-name file))
  7811. (setq link (org-make-link
  7812. "file:" (match-string 1 (expand-file-name file)))))
  7813. (t (setq link (org-make-link "file:" file)))))
  7814. link))
  7815. (defun org-completing-read (&rest args)
  7816. "Completing-read with SPACE being a normal character."
  7817. (let ((minibuffer-local-completion-map
  7818. (copy-keymap minibuffer-local-completion-map)))
  7819. (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
  7820. (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
  7821. (apply 'org-icompleting-read args)))
  7822. (defun org-completing-read-no-i (&rest args)
  7823. (let (org-completion-use-ido org-completion-use-iswitchb)
  7824. (apply 'org-completing-read args)))
  7825. (defun org-iswitchb-completing-read (prompt choices &rest args)
  7826. "Use iswitch as a completing-read replacement to choose from choices.
  7827. PROMPT is a string to prompt with. CHOICES is a list of strings to choose
  7828. from."
  7829. (let* ((iswitchb-use-virtual-buffers nil)
  7830. (iswitchb-make-buflist-hook
  7831. (lambda ()
  7832. (setq iswitchb-temp-buflist choices))))
  7833. (iswitchb-read-buffer prompt)))
  7834. (defun org-icompleting-read (&rest args)
  7835. "Completing-read using `ido-mode' or `iswitchb' speedups if available."
  7836. (org-without-partial-completion
  7837. (if (and org-completion-use-ido
  7838. (fboundp 'ido-completing-read)
  7839. (boundp 'ido-mode) ido-mode
  7840. (listp (second args)))
  7841. (let ((ido-enter-matching-directory nil))
  7842. (apply 'ido-completing-read (concat (car args))
  7843. (if (consp (car (nth 1 args)))
  7844. (mapcar (lambda (x) (car x)) (nth 1 args))
  7845. (nth 1 args))
  7846. (cddr args)))
  7847. (if (and org-completion-use-iswitchb
  7848. (boundp 'iswitchb-mode) iswitchb-mode
  7849. (listp (second args)))
  7850. (apply 'org-iswitchb-completing-read (concat (car args))
  7851. (if (consp (car (nth 1 args)))
  7852. (mapcar (lambda (x) (car x)) (nth 1 args))
  7853. (nth 1 args))
  7854. (cddr args))
  7855. (apply 'completing-read args)))))
  7856. (defun org-extract-attributes (s)
  7857. "Extract the attributes cookie from a string and set as text property."
  7858. (let (a attr (start 0) key value)
  7859. (save-match-data
  7860. (when (string-match "{{\\([^}]+\\)}}$" s)
  7861. (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
  7862. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
  7863. (setq key (match-string 1 a) value (match-string 2 a)
  7864. start (match-end 0)
  7865. attr (plist-put attr (intern key) value))))
  7866. (org-add-props s nil 'org-attr attr))
  7867. s))
  7868. (defun org-extract-attributes-from-string (tag)
  7869. (let (key value attr)
  7870. (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"\\s-?" tag)
  7871. (setq key (match-string 1 tag) value (match-string 2 tag)
  7872. tag (replace-match "" t t tag)
  7873. attr (plist-put attr (intern key) value)))
  7874. (cons tag attr)))
  7875. (defun org-attributes-to-string (plist)
  7876. "Format a property list into an HTML attribute list."
  7877. (let ((s "") key value)
  7878. (while plist
  7879. (setq key (pop plist) value (pop plist))
  7880. (and value
  7881. (setq s (concat s " " (symbol-name key) "=\"" value "\""))))
  7882. s))
  7883. ;;; Opening/following a link
  7884. (defvar org-link-search-failed nil)
  7885. (defvar org-open-link-functions nil
  7886. "Hook for functions finding a plain text link.
  7887. These functions must take a single argument, the link content.
  7888. They will be called for links that look like [[link text][description]]
  7889. when LINK TEXT does not have a protocol like \"http:\" and does not look
  7890. like a filename (e.g. \"./blue.png\").
  7891. These functions will be called *before* Org attempts to resolve the
  7892. link by doing text searches in the current buffer - so if you want a
  7893. link \"[[target]]\" to still find \"<<target>>\", your function should
  7894. handle this as a special case.
  7895. When the function does handle the link, it must return a non-nil value.
  7896. If it decides that it is not responsible for this link, it must return
  7897. nil to indicate that that Org-mode can continue with other options
  7898. like exact and fuzzy text search.")
  7899. (defun org-next-link ()
  7900. "Move forward to the next link.
  7901. If the link is in hidden text, expose it."
  7902. (interactive)
  7903. (when (and org-link-search-failed (eq this-command last-command))
  7904. (goto-char (point-min))
  7905. (message "Link search wrapped back to beginning of buffer"))
  7906. (setq org-link-search-failed nil)
  7907. (let* ((pos (point))
  7908. (ct (org-context))
  7909. (a (assoc :link ct)))
  7910. (if a (goto-char (nth 2 a)))
  7911. (if (re-search-forward org-any-link-re nil t)
  7912. (progn
  7913. (goto-char (match-beginning 0))
  7914. (if (org-invisible-p) (org-show-context)))
  7915. (goto-char pos)
  7916. (setq org-link-search-failed t)
  7917. (error "No further link found"))))
  7918. (defun org-previous-link ()
  7919. "Move backward to the previous link.
  7920. If the link is in hidden text, expose it."
  7921. (interactive)
  7922. (when (and org-link-search-failed (eq this-command last-command))
  7923. (goto-char (point-max))
  7924. (message "Link search wrapped back to end of buffer"))
  7925. (setq org-link-search-failed nil)
  7926. (let* ((pos (point))
  7927. (ct (org-context))
  7928. (a (assoc :link ct)))
  7929. (if a (goto-char (nth 1 a)))
  7930. (if (re-search-backward org-any-link-re nil t)
  7931. (progn
  7932. (goto-char (match-beginning 0))
  7933. (if (org-invisible-p) (org-show-context)))
  7934. (goto-char pos)
  7935. (setq org-link-search-failed t)
  7936. (error "No further link found"))))
  7937. (defun org-translate-link (s)
  7938. "Translate a link string if a translation function has been defined."
  7939. (if (and org-link-translation-function
  7940. (fboundp org-link-translation-function)
  7941. (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
  7942. (progn
  7943. (setq s (funcall org-link-translation-function
  7944. (match-string 1) (match-string 2)))
  7945. (concat (car s) ":" (cdr s)))
  7946. s))
  7947. (defun org-translate-link-from-planner (type path)
  7948. "Translate a link from Emacs Planner syntax so that Org can follow it.
  7949. This is still an experimental function, your mileage may vary."
  7950. (cond
  7951. ((member type '("http" "https" "news" "ftp"))
  7952. ;; standard Internet links are the same.
  7953. nil)
  7954. ((and (equal type "irc") (string-match "^//" path))
  7955. ;; Planner has two / at the beginning of an irc link, we have 1.
  7956. ;; We should have zero, actually....
  7957. (setq path (substring path 1)))
  7958. ((and (equal type "lisp") (string-match "^/" path))
  7959. ;; Planner has a slash, we do not.
  7960. (setq type "elisp" path (substring path 1)))
  7961. ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
  7962. ;; A typical message link. Planner has the id after the final slash,
  7963. ;; we separate it with a hash mark
  7964. (setq path (concat (match-string 1 path) "#"
  7965. (org-remove-angle-brackets (match-string 2 path)))))
  7966. )
  7967. (cons type path))
  7968. (defun org-find-file-at-mouse (ev)
  7969. "Open file link or URL at mouse."
  7970. (interactive "e")
  7971. (mouse-set-point ev)
  7972. (org-open-at-point 'in-emacs))
  7973. (defun org-open-at-mouse (ev)
  7974. "Open file link or URL at mouse."
  7975. (interactive "e")
  7976. (mouse-set-point ev)
  7977. (if (eq major-mode 'org-agenda-mode)
  7978. (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
  7979. (org-open-at-point))
  7980. (defvar org-window-config-before-follow-link nil
  7981. "The window configuration before following a link.
  7982. This is saved in case the need arises to restore it.")
  7983. (defvar org-open-link-marker (make-marker)
  7984. "Marker pointing to the location where `org-open-at-point; was called.")
  7985. ;;;###autoload
  7986. (defun org-open-at-point-global ()
  7987. "Follow a link like Org-mode does.
  7988. This command can be called in any mode to follow a link that has
  7989. Org-mode syntax."
  7990. (interactive)
  7991. (org-run-like-in-org-mode 'org-open-at-point))
  7992. ;;;###autoload
  7993. (defun org-open-link-from-string (s &optional arg reference-buffer)
  7994. "Open a link in the string S, as if it was in Org-mode."
  7995. (interactive "sLink: \nP")
  7996. (let ((reference-buffer (or reference-buffer (current-buffer))))
  7997. (with-temp-buffer
  7998. (let ((org-inhibit-startup t))
  7999. (org-mode)
  8000. (insert s)
  8001. (goto-char (point-min))
  8002. (when reference-buffer
  8003. (setq org-link-abbrev-alist-local
  8004. (with-current-buffer reference-buffer
  8005. org-link-abbrev-alist-local)))
  8006. (org-open-at-point arg reference-buffer)))))
  8007. (defun org-open-at-point (&optional in-emacs reference-buffer)
  8008. "Open link at or after point.
  8009. If there is no link at point, this function will search forward up to
  8010. the end of the current line.
  8011. Normally, files will be opened by an appropriate application. If the
  8012. optional argument IN-EMACS is non-nil, Emacs will visit the file.
  8013. With a double prefix argument, try to open outside of Emacs, in the
  8014. application the system uses for this file type."
  8015. (interactive "P")
  8016. ;; if in a code block, then open the block's results
  8017. (unless (call-interactively #'org-babel-open-src-block-result)
  8018. (org-load-modules-maybe)
  8019. (move-marker org-open-link-marker (point))
  8020. (setq org-window-config-before-follow-link (current-window-configuration))
  8021. (org-remove-occur-highlights nil nil t)
  8022. (cond
  8023. ((and (org-on-heading-p)
  8024. (not (org-in-regexp
  8025. (concat org-plain-link-re "\\|"
  8026. org-bracket-link-regexp "\\|"
  8027. org-angle-link-re "\\|"
  8028. "[ \t]:[^ \t\n]+:[ \t]*$")))
  8029. (not (get-text-property (point) 'org-linked-text)))
  8030. (or (org-offer-links-in-entry in-emacs)
  8031. (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
  8032. ((org-at-timestamp-p t) (org-follow-timestamp-link))
  8033. ((or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
  8034. (org-footnote-action))
  8035. (t
  8036. (let (type path link line search (pos (point)))
  8037. (catch 'match
  8038. (save-excursion
  8039. (skip-chars-forward "^]\n\r")
  8040. (when (org-in-regexp org-bracket-link-regexp 1)
  8041. (setq link (org-extract-attributes
  8042. (org-link-unescape (org-match-string-no-properties 1))))
  8043. (while (string-match " *\n *" link)
  8044. (setq link (replace-match " " t t link)))
  8045. (setq link (org-link-expand-abbrev link))
  8046. (cond
  8047. ((or (file-name-absolute-p link)
  8048. (string-match "^\\.\\.?/" link))
  8049. (setq type "file" path link))
  8050. ((string-match org-link-re-with-space3 link)
  8051. (setq type (match-string 1 link) path (match-string 2 link)))
  8052. (t (setq type "thisfile" path link)))
  8053. (throw 'match t)))
  8054. (when (get-text-property (point) 'org-linked-text)
  8055. (setq type "thisfile"
  8056. pos (if (get-text-property (1+ (point)) 'org-linked-text)
  8057. (1+ (point)) (point))
  8058. path (buffer-substring
  8059. (previous-single-property-change pos 'org-linked-text)
  8060. (next-single-property-change pos 'org-linked-text)))
  8061. (throw 'match t))
  8062. (save-excursion
  8063. (when (or (org-in-regexp org-angle-link-re)
  8064. (org-in-regexp org-plain-link-re))
  8065. (setq type (match-string 1) path (match-string 2))
  8066. (throw 'match t)))
  8067. (save-excursion
  8068. (when (org-in-regexp (org-re "\\(:[[:alnum:]_@:]+\\):[ \t]*$"))
  8069. (setq type "tags"
  8070. path (match-string 1))
  8071. (while (string-match ":" path)
  8072. (setq path (replace-match "+" t t path)))
  8073. (throw 'match t)))
  8074. (when (org-in-regexp "<\\([^><\n]+\\)>")
  8075. (setq type "tree-match"
  8076. path (match-string 1))
  8077. (throw 'match t)))
  8078. (unless path
  8079. (error "No link found"))
  8080. ;; switch back to reference buffer
  8081. ;; needed when if called in a temporary buffer through
  8082. ;; org-open-link-from-string
  8083. (with-current-buffer (or reference-buffer (current-buffer))
  8084. ;; Remove any trailing spaces in path
  8085. (if (string-match " +\\'" path)
  8086. (setq path (replace-match "" t t path)))
  8087. (if (and org-link-translation-function
  8088. (fboundp org-link-translation-function))
  8089. ;; Check if we need to translate the link
  8090. (let ((tmp (funcall org-link-translation-function type path)))
  8091. (setq type (car tmp) path (cdr tmp))))
  8092. (cond
  8093. ((assoc type org-link-protocols)
  8094. (funcall (nth 1 (assoc type org-link-protocols)) path))
  8095. ((equal type "mailto")
  8096. (let ((cmd (car org-link-mailto-program))
  8097. (args (cdr org-link-mailto-program)) args1
  8098. (address path) (subject "") a)
  8099. (if (string-match "\\(.*\\)::\\(.*\\)" path)
  8100. (setq address (match-string 1 path)
  8101. subject (org-link-escape (match-string 2 path))))
  8102. (while args
  8103. (cond
  8104. ((not (stringp (car args))) (push (pop args) args1))
  8105. (t (setq a (pop args))
  8106. (if (string-match "%a" a)
  8107. (setq a (replace-match address t t a)))
  8108. (if (string-match "%s" a)
  8109. (setq a (replace-match subject t t a)))
  8110. (push a args1))))
  8111. (apply cmd (nreverse args1))))
  8112. ((member type '("http" "https" "ftp" "news"))
  8113. (browse-url (concat type ":" (org-link-escape
  8114. path org-link-escape-chars-browser))))
  8115. ((string= type "doi")
  8116. (browse-url (concat "http://dx.doi.org/"
  8117. (org-link-escape
  8118. path org-link-escape-chars-browser))))
  8119. ((member type '("message"))
  8120. (browse-url (concat type ":" path)))
  8121. ((string= type "tags")
  8122. (org-tags-view in-emacs path))
  8123. ((string= type "tree-match")
  8124. (org-occur (concat "\\[" (regexp-quote path) "\\]")))
  8125. ((string= type "file")
  8126. (if (string-match "::\\([0-9]+\\)\\'" path)
  8127. (setq line (string-to-number (match-string 1 path))
  8128. path (substring path 0 (match-beginning 0)))
  8129. (if (string-match "::\\(.+\\)\\'" path)
  8130. (setq search (match-string 1 path)
  8131. path (substring path 0 (match-beginning 0)))))
  8132. (if (string-match "[*?{]" (file-name-nondirectory path))
  8133. (dired path)
  8134. (org-open-file path in-emacs line search)))
  8135. ((string= type "news")
  8136. (require 'org-gnus)
  8137. (org-gnus-follow-link path))
  8138. ((string= type "shell")
  8139. (let ((cmd path))
  8140. (if (or (not org-confirm-shell-link-function)
  8141. (funcall org-confirm-shell-link-function
  8142. (format "Execute \"%s\" in shell? "
  8143. (org-add-props cmd nil
  8144. 'face 'org-warning))))
  8145. (progn
  8146. (message "Executing %s" cmd)
  8147. (shell-command cmd))
  8148. (error "Abort"))))
  8149. ((string= type "elisp")
  8150. (let ((cmd path))
  8151. (if (or (not org-confirm-elisp-link-function)
  8152. (funcall org-confirm-elisp-link-function
  8153. (format "Execute \"%s\" as elisp? "
  8154. (org-add-props cmd nil
  8155. 'face 'org-warning))))
  8156. (message "%s => %s" cmd
  8157. (if (equal (string-to-char cmd) ?\()
  8158. (eval (read cmd))
  8159. (call-interactively (read cmd))))
  8160. (error "Abort"))))
  8161. ((and (string= type "thisfile")
  8162. (run-hook-with-args-until-success
  8163. 'org-open-link-functions path)))
  8164. ((string= type "thisfile")
  8165. (if in-emacs
  8166. (switch-to-buffer-other-window
  8167. (org-get-buffer-for-internal-link (current-buffer)))
  8168. (org-mark-ring-push))
  8169. (let ((cmd `(org-link-search
  8170. ,path
  8171. ,(cond ((equal in-emacs '(4)) 'occur)
  8172. ((equal in-emacs '(16)) 'org-occur)
  8173. (t nil))
  8174. ,pos)))
  8175. (condition-case nil (eval cmd)
  8176. (error (progn (widen) (eval cmd))))))
  8177. (t
  8178. (browse-url-at-point)))))))
  8179. (move-marker org-open-link-marker nil)
  8180. (run-hook-with-args 'org-follow-link-hook)))
  8181. (defun org-offer-links-in-entry (&optional nth zero)
  8182. "Offer links in the current entry and follow the selected link.
  8183. If there is only one link, follow it immediately as well.
  8184. If NTH is an integer, immediately pick the NTH link found.
  8185. If ZERO is a string, check also this string for a link, and if
  8186. there is one, offer it as link number zero."
  8187. (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
  8188. "\\(" org-angle-link-re "\\)\\|"
  8189. "\\(" org-plain-link-re "\\)"))
  8190. (cnt ?0)
  8191. (in-emacs (if (integerp nth) nil nth))
  8192. have-zero end links link c)
  8193. (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
  8194. (push (match-string 0 zero) links)
  8195. (setq cnt (1- cnt) have-zero t))
  8196. (save-excursion
  8197. (org-back-to-heading t)
  8198. (setq end (save-excursion (outline-next-heading) (point)))
  8199. (while (re-search-forward re end t)
  8200. (push (match-string 0) links))
  8201. (setq links (org-uniquify (reverse links))))
  8202. (cond
  8203. ((null links)
  8204. (message "No links"))
  8205. ((equal (length links) 1)
  8206. (setq link (list (car links))))
  8207. ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
  8208. (setq link (nth (if have-zero nth (1- nth)) links)))
  8209. (t ; we have to select a link
  8210. (save-excursion
  8211. (save-window-excursion
  8212. (delete-other-windows)
  8213. (with-output-to-temp-buffer "*Select Link*"
  8214. (mapc (lambda (l)
  8215. (if (not (string-match org-bracket-link-regexp l))
  8216. (princ (format "[%c] %s\n" (incf cnt)
  8217. (org-remove-angle-brackets l)))
  8218. (if (match-end 3)
  8219. (princ (format "[%c] %s (%s)\n" (incf cnt)
  8220. (match-string 3 l) (match-string 1 l)))
  8221. (princ (format "[%c] %s\n" (incf cnt)
  8222. (match-string 1 l))))))
  8223. links))
  8224. (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
  8225. (message "Select link to open, RET to open all:")
  8226. (setq c (read-char-exclusive))
  8227. (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
  8228. (when (equal c ?q) (error "Abort"))
  8229. (if (equal c ?\C-m)
  8230. (setq link links)
  8231. (setq nth (- c ?0))
  8232. (if have-zero (setq nth (1+ nth)))
  8233. (unless (and (integerp nth) (>= (length links) nth))
  8234. (error "Invalid link selection"))
  8235. (setq link (list (nth (1- nth) links))))))
  8236. (if link
  8237. (let ((buf (current-buffer)))
  8238. (dolist (l link)
  8239. (org-open-link-from-string l in-emacs buf))
  8240. t)
  8241. nil)))
  8242. ;; Add special file links that specify the way of opening
  8243. (org-add-link-type "file+sys" 'org-open-file-with-system)
  8244. (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
  8245. (defun org-open-file-with-system (path)
  8246. "Open file at PATH using the system way of opeing it."
  8247. (org-open-file path 'system))
  8248. (defun org-open-file-with-emacs (path)
  8249. "Open file at PATH in emacs."
  8250. (org-open-file path 'emacs))
  8251. (defun org-remove-file-link-modifiers ()
  8252. "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
  8253. (goto-char (point-min))
  8254. (while (re-search-forward "\\<file\\+\\(sys\\|emacs\\):" nil t)
  8255. (org-if-unprotected
  8256. (replace-match "file:" t t))))
  8257. (eval-after-load "org-exp"
  8258. '(add-hook 'org-export-preprocess-before-normalizing-links-hook
  8259. 'org-remove-file-link-modifiers))
  8260. ;;;; Time estimates
  8261. (defun org-get-effort (&optional pom)
  8262. "Get the effort estimate for the current entry."
  8263. (org-entry-get pom org-effort-property))
  8264. ;;; File search
  8265. (defvar org-create-file-search-functions nil
  8266. "List of functions to construct the right search string for a file link.
  8267. These functions are called in turn with point at the location to
  8268. which the link should point.
  8269. A function in the hook should first test if it would like to
  8270. handle this file type, for example by checking the major-mode or
  8271. the file extension. If it decides not to handle this file, it
  8272. should just return nil to give other functions a chance. If it
  8273. does handle the file, it must return the search string to be used
  8274. when following the link. The search string will be part of the
  8275. file link, given after a double colon, and `org-open-at-point'
  8276. will automatically search for it. If special measures must be
  8277. taken to make the search successful, another function should be
  8278. added to the companion hook `org-execute-file-search-functions',
  8279. which see.
  8280. A function in this hook may also use `setq' to set the variable
  8281. `description' to provide a suggestion for the descriptive text to
  8282. be used for this link when it gets inserted into an Org-mode
  8283. buffer with \\[org-insert-link].")
  8284. (defvar org-execute-file-search-functions nil
  8285. "List of functions to execute a file search triggered by a link.
  8286. Functions added to this hook must accept a single argument, the
  8287. search string that was part of the file link, the part after the
  8288. double colon. The function must first check if it would like to
  8289. handle this search, for example by checking the major-mode or the
  8290. file extension. If it decides not to handle this search, it
  8291. should just return nil to give other functions a chance. If it
  8292. does handle the search, it must return a non-nil value to keep
  8293. other functions from trying.
  8294. Each function can access the current prefix argument through the
  8295. variable `current-prefix-argument'. Note that a single prefix is
  8296. used to force opening a link in Emacs, so it may be good to only
  8297. use a numeric or double prefix to guide the search function.
  8298. In case this is needed, a function in this hook can also restore
  8299. the window configuration before `org-open-at-point' was called using:
  8300. (set-window-configuration org-window-config-before-follow-link)")
  8301. (defun org-link-search (s &optional type avoid-pos)
  8302. "Search for a link search option.
  8303. If S is surrounded by forward slashes, it is interpreted as a
  8304. regular expression. In org-mode files, this will create an `org-occur'
  8305. sparse tree. In ordinary files, `occur' will be used to list matches.
  8306. If the current buffer is in `dired-mode', grep will be used to search
  8307. in all files. If AVOID-POS is given, ignore matches near that position."
  8308. (let ((case-fold-search t)
  8309. (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
  8310. (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
  8311. (append '(("") (" ") ("\t") ("\n"))
  8312. org-emphasis-alist)
  8313. "\\|") "\\)"))
  8314. (pos (point))
  8315. (pre nil) (post nil)
  8316. words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
  8317. (cond
  8318. ;; First check if there are any special
  8319. ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
  8320. ;; Now try the builtin stuff
  8321. ((and (equal (string-to-char s0) ?#)
  8322. (> (length s0) 1)
  8323. (save-excursion
  8324. (goto-char (point-min))
  8325. (and
  8326. (re-search-forward
  8327. (concat "^[ \t]*:CUSTOM_ID:[ \t]+" (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
  8328. (setq type 'dedicated
  8329. pos (match-beginning 0))))
  8330. ;; There is an exact target for this
  8331. (goto-char pos)
  8332. (org-back-to-heading t)))
  8333. ((save-excursion
  8334. (goto-char (point-min))
  8335. (and
  8336. (re-search-forward
  8337. (concat "<<" (regexp-quote s0) ">>") nil t)
  8338. (setq type 'dedicated
  8339. pos (match-beginning 0))))
  8340. ;; There is an exact target for this
  8341. (goto-char pos))
  8342. ((and (string-match "^(\\(.*\\))$" s0)
  8343. (save-excursion
  8344. (goto-char (point-min))
  8345. (and
  8346. (re-search-forward
  8347. (concat "[^[]" (regexp-quote
  8348. (format org-coderef-label-format
  8349. (match-string 1 s0))))
  8350. nil t)
  8351. (setq type 'dedicated
  8352. pos (1+ (match-beginning 0))))))
  8353. ;; There is a coderef target for this
  8354. (goto-char pos))
  8355. ((string-match "^/\\(.*\\)/$" s)
  8356. ;; A regular expression
  8357. (cond
  8358. ((org-mode-p)
  8359. (org-occur (match-string 1 s)))
  8360. ;;((eq major-mode 'dired-mode)
  8361. ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
  8362. (t (org-do-occur (match-string 1 s)))))
  8363. (t
  8364. ;; A normal search strings
  8365. (when (equal (string-to-char s) ?*)
  8366. ;; Anchor on headlines, post may include tags.
  8367. (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
  8368. post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@:+]:[ \t]*\\)?$")
  8369. s (substring s 1)))
  8370. (remove-text-properties
  8371. 0 (length s)
  8372. '(face nil mouse-face nil keymap nil fontified nil) s)
  8373. ;; Make a series of regular expressions to find a match
  8374. (setq words (org-split-string s "[ \n\r\t]+")
  8375. re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
  8376. re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
  8377. "\\)" markers)
  8378. re2a_ (concat "\\(" (mapconcat 'downcase words "[ \t\r\n]+") "\\)[ \t\r\n]")
  8379. re2a (concat "[ \t\r\n]" re2a_)
  8380. re4_ (concat "\\(" (mapconcat 'downcase words "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
  8381. re4 (concat "[^a-zA-Z_]" re4_)
  8382. re1 (concat pre re2 post)
  8383. re3 (concat pre (if pre re4_ re4) post)
  8384. re5 (concat pre ".*" re4)
  8385. re2 (concat pre re2)
  8386. re2a (concat pre (if pre re2a_ re2a))
  8387. re4 (concat pre (if pre re4_ re4))
  8388. reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
  8389. "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
  8390. re5 "\\)"
  8391. ))
  8392. (cond
  8393. ((eq type 'org-occur) (org-occur reall))
  8394. ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
  8395. (t (goto-char (point-min))
  8396. (setq type 'fuzzy)
  8397. (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
  8398. (org-search-not-self 1 re1 nil t)
  8399. (org-search-not-self 1 re2 nil t)
  8400. (org-search-not-self 1 re2a nil t)
  8401. (org-search-not-self 1 re3 nil t)
  8402. (org-search-not-self 1 re4 nil t)
  8403. (org-search-not-self 1 re5 nil t)
  8404. )
  8405. (goto-char (match-beginning 1))
  8406. (goto-char pos)
  8407. (error "No match")))))
  8408. (t
  8409. ;; Normal string-search
  8410. (goto-char (point-min))
  8411. (if (search-forward s nil t)
  8412. (goto-char (match-beginning 0))
  8413. (error "No match"))))
  8414. (and (org-mode-p) (org-show-context 'link-search))
  8415. type))
  8416. (defun org-search-not-self (group &rest args)
  8417. "Execute `re-search-forward', but only accept matches that do not
  8418. enclose the position of `org-open-link-marker'."
  8419. (let ((m org-open-link-marker))
  8420. (catch 'exit
  8421. (while (apply 're-search-forward args)
  8422. (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
  8423. (goto-char (match-end group))
  8424. (if (and (or (not (eq (marker-buffer m) (current-buffer)))
  8425. (> (match-beginning 0) (marker-position m))
  8426. (< (match-end 0) (marker-position m)))
  8427. (save-match-data
  8428. (or (not (org-in-regexp
  8429. org-bracket-link-analytic-regexp 1))
  8430. (not (match-end 4)) ; no description
  8431. (and (<= (match-beginning 4) (point))
  8432. (>= (match-end 4) (point))))))
  8433. (throw 'exit (point))))))))
  8434. (defun org-get-buffer-for-internal-link (buffer)
  8435. "Return a buffer to be used for displaying the link target of internal links."
  8436. (cond
  8437. ((not org-display-internal-link-with-indirect-buffer)
  8438. buffer)
  8439. ((string-match "(Clone)$" (buffer-name buffer))
  8440. (message "Buffer is already a clone, not making another one")
  8441. ;; we also do not modify visibility in this case
  8442. buffer)
  8443. (t ; make a new indirect buffer for displaying the link
  8444. (let* ((bn (buffer-name buffer))
  8445. (ibn (concat bn "(Clone)"))
  8446. (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
  8447. (with-current-buffer ib (org-overview))
  8448. ib))))
  8449. (defun org-do-occur (regexp &optional cleanup)
  8450. "Call the Emacs command `occur'.
  8451. If CLEANUP is non-nil, remove the printout of the regular expression
  8452. in the *Occur* buffer. This is useful if the regex is long and not useful
  8453. to read."
  8454. (occur regexp)
  8455. (when cleanup
  8456. (let ((cwin (selected-window)) win beg end)
  8457. (when (setq win (get-buffer-window "*Occur*"))
  8458. (select-window win))
  8459. (goto-char (point-min))
  8460. (when (re-search-forward "match[a-z]+" nil t)
  8461. (setq beg (match-end 0))
  8462. (if (re-search-forward "^[ \t]*[0-9]+" nil t)
  8463. (setq end (1- (match-beginning 0)))))
  8464. (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
  8465. (goto-char (point-min))
  8466. (select-window cwin))))
  8467. ;;; The mark ring for links jumps
  8468. (defvar org-mark-ring nil
  8469. "Mark ring for positions before jumps in Org-mode.")
  8470. (defvar org-mark-ring-last-goto nil
  8471. "Last position in the mark ring used to go back.")
  8472. ;; Fill and close the ring
  8473. (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
  8474. (loop for i from 1 to org-mark-ring-length do
  8475. (push (make-marker) org-mark-ring))
  8476. (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
  8477. org-mark-ring)
  8478. (defun org-mark-ring-push (&optional pos buffer)
  8479. "Put the current position or POS into the mark ring and rotate it."
  8480. (interactive)
  8481. (setq pos (or pos (point)))
  8482. (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  8483. (move-marker (car org-mark-ring)
  8484. (or pos (point))
  8485. (or buffer (current-buffer)))
  8486. (message "%s"
  8487. (substitute-command-keys
  8488. "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
  8489. (defun org-mark-ring-goto (&optional n)
  8490. "Jump to the previous position in the mark ring.
  8491. With prefix arg N, jump back that many stored positions. When
  8492. called several times in succession, walk through the entire ring.
  8493. Org-mode commands jumping to a different position in the current file,
  8494. or to another Org-mode file, automatically push the old position
  8495. onto the ring."
  8496. (interactive "p")
  8497. (let (p m)
  8498. (if (eq last-command this-command)
  8499. (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
  8500. (setq p org-mark-ring))
  8501. (setq org-mark-ring-last-goto p)
  8502. (setq m (car p))
  8503. (switch-to-buffer (marker-buffer m))
  8504. (goto-char m)
  8505. (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
  8506. (defun org-remove-angle-brackets (s)
  8507. (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
  8508. (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
  8509. s)
  8510. (defun org-add-angle-brackets (s)
  8511. (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
  8512. (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
  8513. s)
  8514. (defun org-remove-double-quotes (s)
  8515. (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
  8516. (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
  8517. s)
  8518. ;;; Following specific links
  8519. (defun org-follow-timestamp-link ()
  8520. (cond
  8521. ((org-at-date-range-p t)
  8522. (let ((org-agenda-start-on-weekday)
  8523. (t1 (match-string 1))
  8524. (t2 (match-string 2)))
  8525. (setq t1 (time-to-days (org-time-string-to-time t1))
  8526. t2 (time-to-days (org-time-string-to-time t2)))
  8527. (org-agenda-list nil t1 (1+ (- t2 t1)))))
  8528. ((org-at-timestamp-p t)
  8529. (org-agenda-list nil (time-to-days (org-time-string-to-time
  8530. (substring (match-string 1) 0 10)))
  8531. 1))
  8532. (t (error "This should not happen"))))
  8533. ;;; Following file links
  8534. (defvar org-wait nil)
  8535. (defun org-open-file (path &optional in-emacs line search)
  8536. "Open the file at PATH.
  8537. First, this expands any special file name abbreviations. Then the
  8538. configuration variable `org-file-apps' is checked if it contains an
  8539. entry for this file type, and if yes, the corresponding command is launched.
  8540. If no application is found, Emacs simply visits the file.
  8541. With optional prefix argument IN-EMACS, Emacs will visit the file.
  8542. With a double C-c C-u prefix arg, Org tries to avoid opening in Emacs
  8543. and to use an external application to visit the file.
  8544. Optional LINE specifies a line to go to, optional SEARCH a string
  8545. to search for. If LINE or SEARCH is given, the file will be
  8546. opened in Emacs, unless an entry from org-file-apps that makes
  8547. use of groups in a regexp matches.
  8548. If the file does not exist, an error is thrown."
  8549. (let* ((file (if (equal path "")
  8550. buffer-file-name
  8551. (substitute-in-file-name (expand-file-name path))))
  8552. (file-apps (append org-file-apps (org-default-apps)))
  8553. (apps (org-remove-if
  8554. 'org-file-apps-entry-match-against-dlink-p file-apps))
  8555. (apps-dlink (org-remove-if-not
  8556. 'org-file-apps-entry-match-against-dlink-p file-apps))
  8557. (remp (and (assq 'remote apps) (org-file-remote-p file)))
  8558. (dirp (if remp nil (file-directory-p file)))
  8559. (file (if (and dirp org-open-directory-means-index-dot-org)
  8560. (concat (file-name-as-directory file) "index.org")
  8561. file))
  8562. (a-m-a-p (assq 'auto-mode apps))
  8563. (dfile (downcase file))
  8564. ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
  8565. (link (cond ((and (eq line nil)
  8566. (eq search nil))
  8567. file)
  8568. (line
  8569. (concat file "::" (number-to-string line)))
  8570. (search
  8571. (concat file "::" search))))
  8572. (dlink (downcase link))
  8573. (old-buffer (current-buffer))
  8574. (old-pos (point))
  8575. (old-mode major-mode)
  8576. ext cmd link-match-data)
  8577. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
  8578. (setq ext (match-string 1 dfile))
  8579. (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
  8580. (setq ext (match-string 1 dfile))))
  8581. (cond
  8582. ((member in-emacs '((16) system))
  8583. (setq cmd (cdr (assoc 'system apps))))
  8584. (in-emacs (setq cmd 'emacs))
  8585. (t
  8586. (setq cmd (or (and remp (cdr (assoc 'remote apps)))
  8587. (and dirp (cdr (assoc 'directory apps)))
  8588. ; first, try matching against apps-dlink
  8589. ; if we get a match here, store the match data for later
  8590. (let ((match (assoc-default dlink apps-dlink
  8591. 'string-match)))
  8592. (if match
  8593. (progn (setq link-match-data (match-data))
  8594. match)
  8595. (progn (setq in-emacs (or in-emacs line search))
  8596. nil))) ; if we have no match in apps-dlink,
  8597. ; always open the file in emacs if line or search
  8598. ; is given (for backwards compatibility)
  8599. (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
  8600. 'string-match)
  8601. (cdr (assoc ext apps))
  8602. (cdr (assoc t apps))))))
  8603. (when (eq cmd 'system)
  8604. (setq cmd (cdr (assoc 'system apps))))
  8605. (when (eq cmd 'default)
  8606. (setq cmd (cdr (assoc t apps))))
  8607. (when (eq cmd 'mailcap)
  8608. (require 'mailcap)
  8609. (mailcap-parse-mailcaps)
  8610. (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
  8611. (command (mailcap-mime-info mime-type)))
  8612. (if (stringp command)
  8613. (setq cmd command)
  8614. (setq cmd 'emacs))))
  8615. (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
  8616. (not (file-exists-p file))
  8617. (not org-open-non-existing-files))
  8618. (error "No such file: %s" file))
  8619. (cond
  8620. ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
  8621. ;; Remove quotes around the file name - we'll use shell-quote-argument.
  8622. (while (string-match "['\"]%s['\"]" cmd)
  8623. (setq cmd (replace-match "%s" t t cmd)))
  8624. (while (string-match "%s" cmd)
  8625. (setq cmd (replace-match
  8626. (save-match-data
  8627. (shell-quote-argument
  8628. (convert-standard-filename file)))
  8629. t t cmd)))
  8630. ;; Replace "%1", "%2" etc. in command with group matches from regex
  8631. (save-match-data
  8632. (let ((match-index 1)
  8633. (number-of-groups (- (/ (length link-match-data) 2) 1)))
  8634. (set-match-data link-match-data)
  8635. (while (<= match-index number-of-groups)
  8636. (let ((regex (concat "%" (number-to-string match-index)))
  8637. (replace-with (match-string match-index dlink)))
  8638. (while (string-match regex cmd)
  8639. (setq cmd (replace-match replace-with t t cmd))))
  8640. (setq match-index (+ match-index 1)))))
  8641. (save-window-excursion
  8642. (start-process-shell-command cmd nil cmd)
  8643. (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
  8644. ))
  8645. ((or (stringp cmd)
  8646. (eq cmd 'emacs))
  8647. (funcall (cdr (assq 'file org-link-frame-setup)) file)
  8648. (widen)
  8649. (if line (org-goto-line line)
  8650. (if search (org-link-search search))))
  8651. ((consp cmd)
  8652. (let ((file (convert-standard-filename file)))
  8653. (save-match-data
  8654. (set-match-data link-match-data)
  8655. (eval cmd))))
  8656. (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
  8657. (and (org-mode-p) (eq old-mode 'org-mode)
  8658. (or (not (equal old-buffer (current-buffer)))
  8659. (not (equal old-pos (point))))
  8660. (org-mark-ring-push old-pos old-buffer))))
  8661. (defun org-file-apps-entry-match-against-dlink-p (entry)
  8662. "This function returns non-nil if `entry' uses a regular
  8663. expression which should be matched against the whole link by
  8664. org-open-file.
  8665. It assumes that is the case when the entry uses a regular
  8666. expression which has at least one grouping construct and the
  8667. action is either a lisp form or a command string containing
  8668. '%1', i.e. using at least one subexpression match as a
  8669. parameter."
  8670. (let ((selector (car entry))
  8671. (action (cdr entry)))
  8672. (if (stringp selector)
  8673. (and (> (regexp-opt-depth selector) 0)
  8674. (or (and (stringp action)
  8675. (string-match "%[0-9]" action))
  8676. (consp action)))
  8677. nil)))
  8678. (defun org-default-apps ()
  8679. "Return the default applications for this operating system."
  8680. (cond
  8681. ((eq system-type 'darwin)
  8682. org-file-apps-defaults-macosx)
  8683. ((eq system-type 'windows-nt)
  8684. org-file-apps-defaults-windowsnt)
  8685. (t org-file-apps-defaults-gnu)))
  8686. (defun org-apps-regexp-alist (list &optional add-auto-mode)
  8687. "Convert extensions to regular expressions in the cars of LIST.
  8688. Also, weed out any non-string entries, because the return value is used
  8689. only for regexp matching.
  8690. When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
  8691. point to the symbol `emacs', indicating that the file should
  8692. be opened in Emacs."
  8693. (append
  8694. (delq nil
  8695. (mapcar (lambda (x)
  8696. (if (not (stringp (car x)))
  8697. nil
  8698. (if (string-match "\\W" (car x))
  8699. x
  8700. (cons (concat "\\." (car x) "\\'") (cdr x)))))
  8701. list))
  8702. (if add-auto-mode
  8703. (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
  8704. (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
  8705. (defun org-file-remote-p (file)
  8706. "Test whether FILE specifies a location on a remote system.
  8707. Return non-nil if the location is indeed remote.
  8708. For example, the filename \"/user@host:/foo\" specifies a location
  8709. on the system \"/user@host:\"."
  8710. (cond ((fboundp 'file-remote-p)
  8711. (file-remote-p file))
  8712. ((fboundp 'tramp-handle-file-remote-p)
  8713. (tramp-handle-file-remote-p file))
  8714. ((and (boundp 'ange-ftp-name-format)
  8715. (string-match (car ange-ftp-name-format) file))
  8716. t)
  8717. (t nil)))
  8718. ;;;; Refiling
  8719. (defun org-get-org-file ()
  8720. "Read a filename, with default directory `org-directory'."
  8721. (let ((default (or org-default-notes-file remember-data-file)))
  8722. (read-file-name (format "File name [%s]: " default)
  8723. (file-name-as-directory org-directory)
  8724. default)))
  8725. (defun org-notes-order-reversed-p ()
  8726. "Check if the current file should receive notes in reversed order."
  8727. (cond
  8728. ((not org-reverse-note-order) nil)
  8729. ((eq t org-reverse-note-order) t)
  8730. ((not (listp org-reverse-note-order)) nil)
  8731. (t (catch 'exit
  8732. (let ((all org-reverse-note-order)
  8733. entry)
  8734. (while (setq entry (pop all))
  8735. (if (string-match (car entry) buffer-file-name)
  8736. (throw 'exit (cdr entry))))
  8737. nil)))))
  8738. (defvar org-refile-target-table nil
  8739. "The list of refile targets, created by `org-refile'.")
  8740. (defvar org-agenda-new-buffers nil
  8741. "Buffers created to visit agenda files.")
  8742. (defvar org-refile-cache nil
  8743. "Cache for refile targets.")
  8744. (defvar org-refile-markers nil
  8745. "All the markers used for caching refile locations.")
  8746. (defun org-refile-marker (pos)
  8747. "Get a new refile marker, but only if caching is in use."
  8748. (if (not org-refile-use-cache)
  8749. pos
  8750. (let ((m (make-marker)))
  8751. (move-marker m pos)
  8752. (push m org-refile-markers)
  8753. m)))
  8754. (defun org-refile-cache-clear ()
  8755. "Clear the refile cache and disable all the markers."
  8756. (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
  8757. (setq org-refile-markers nil)
  8758. (setq org-refile-cache nil)
  8759. (message "Refile cache has been cleared"))
  8760. (defun org-refile-cache-check-set (set)
  8761. "Check if all the markers in the cache still have live buffers."
  8762. (let (marker)
  8763. (catch 'exit
  8764. (while (and set (setq marker (nth 3 (pop set))))
  8765. ;; if org-refile-use-outline-path is 'file, marker may be nil
  8766. (when (and marker (null (marker-buffer marker)))
  8767. (message "not found") (sit-for 3)
  8768. (throw 'exit nil)))
  8769. t)))
  8770. (defun org-refile-cache-put (set &rest identifiers)
  8771. "Push the refile targets SET into the cache, under IDENTIFIERS."
  8772. (let* ((key (sha1 (prin1-to-string identifiers)))
  8773. (entry (assoc key org-refile-cache)))
  8774. (if entry
  8775. (setcdr entry set)
  8776. (push (cons key set) org-refile-cache))))
  8777. (defun org-refile-cache-get (&rest identifiers)
  8778. "Retrieve the cached value for refile targets given by IDENTIFIERS."
  8779. (cond
  8780. ((not org-refile-cache) nil)
  8781. ((not org-refile-use-cache) (org-refile-cache-clear) nil)
  8782. (t
  8783. (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
  8784. org-refile-cache))))
  8785. (and set (org-refile-cache-check-set set) set)))))
  8786. (defun org-get-refile-targets (&optional default-buffer)
  8787. "Produce a table with refile targets."
  8788. (let ((case-fold-search nil)
  8789. ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
  8790. (entries (or org-refile-targets '((nil . (:level . 1)))))
  8791. targets tgs txt re files f desc descre fast-path-p level pos0)
  8792. (message "Getting targets...")
  8793. (with-current-buffer (or default-buffer (current-buffer))
  8794. (while (setq entry (pop entries))
  8795. (setq files (car entry) desc (cdr entry))
  8796. (setq fast-path-p nil)
  8797. (cond
  8798. ((null files) (setq files (list (current-buffer))))
  8799. ((eq files 'org-agenda-files)
  8800. (setq files (org-agenda-files 'unrestricted)))
  8801. ((and (symbolp files) (fboundp files))
  8802. (setq files (funcall files)))
  8803. ((and (symbolp files) (boundp files))
  8804. (setq files (symbol-value files))))
  8805. (if (stringp files) (setq files (list files)))
  8806. (cond
  8807. ((eq (car desc) :tag)
  8808. (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
  8809. ((eq (car desc) :todo)
  8810. (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
  8811. ((eq (car desc) :regexp)
  8812. (setq descre (cdr desc)))
  8813. ((eq (car desc) :level)
  8814. (setq descre (concat "^\\*\\{" (number-to-string
  8815. (if org-odd-levels-only
  8816. (1- (* 2 (cdr desc)))
  8817. (cdr desc)))
  8818. "\\}[ \t]")))
  8819. ((eq (car desc) :maxlevel)
  8820. (setq fast-path-p t)
  8821. (setq descre (concat "^\\*\\{1," (number-to-string
  8822. (if org-odd-levels-only
  8823. (1- (* 2 (cdr desc)))
  8824. (cdr desc)))
  8825. "\\}[ \t]")))
  8826. (t (error "Bad refiling target description %s" desc)))
  8827. (while (setq f (pop files))
  8828. (with-current-buffer
  8829. (if (bufferp f) f (org-get-agenda-file-buffer f))
  8830. (or
  8831. (setq tgs (org-refile-cache-get (buffer-file-name) descre))
  8832. (progn
  8833. (if (bufferp f) (setq f (buffer-file-name
  8834. (buffer-base-buffer f))))
  8835. (setq f (and f (expand-file-name f)))
  8836. (if (eq org-refile-use-outline-path 'file)
  8837. (push (list (file-name-nondirectory f) f nil nil) tgs))
  8838. (save-excursion
  8839. (save-restriction
  8840. (widen)
  8841. (goto-char (point-min))
  8842. (while (re-search-forward descre nil t)
  8843. (goto-char (setq pos0 (point-at-bol)))
  8844. (catch 'next
  8845. (when org-refile-target-verify-function
  8846. (save-match-data
  8847. (or (funcall org-refile-target-verify-function)
  8848. (throw 'next t))))
  8849. (when (looking-at org-complex-heading-regexp)
  8850. (setq level (org-reduced-level
  8851. (- (match-end 1) (match-beginning 1)))
  8852. txt (org-link-display-format (match-string 4))
  8853. re (concat "^" (regexp-quote
  8854. (buffer-substring
  8855. (match-beginning 1)
  8856. (match-end 4)))))
  8857. (if (match-end 5) (setq re (concat
  8858. re "[ \t]+"
  8859. (regexp-quote
  8860. (match-string 5)))))
  8861. (setq re (concat re "[ \t]*$"))
  8862. (when org-refile-use-outline-path
  8863. (setq txt (mapconcat
  8864. 'org-protect-slash
  8865. (append
  8866. (if (eq org-refile-use-outline-path
  8867. 'file)
  8868. (list (file-name-nondirectory
  8869. (buffer-file-name
  8870. (buffer-base-buffer))))
  8871. (if (eq org-refile-use-outline-path
  8872. 'full-file-path)
  8873. (list (buffer-file-name
  8874. (buffer-base-buffer)))))
  8875. (org-get-outline-path fast-path-p
  8876. level txt)
  8877. (list txt))
  8878. "/")))
  8879. (push (list txt f re (org-refile-marker (point)))
  8880. tgs)))
  8881. (when (= (point) pos0)
  8882. ;; verification function has not moved point
  8883. (goto-char (point-at-eol))))))))
  8884. (when org-refile-use-cache
  8885. (org-refile-cache-put tgs (buffer-file-name) descre))
  8886. (setq targets (append tgs targets))
  8887. ))))
  8888. (message "Getting targets...done")
  8889. (nreverse targets)))
  8890. (defun org-protect-slash (s)
  8891. (while (string-match "/" s)
  8892. (setq s (replace-match "\\" t t s)))
  8893. s)
  8894. (defvar org-olpa (make-vector 20 nil))
  8895. (defun org-get-outline-path (&optional fastp level heading)
  8896. "Return the outline path to the current entry, as a list.
  8897. The parameters FASTP, LEVEL, and HEADING are for use by a scanner
  8898. routine which makes outline path derivations for an entire file,
  8899. avoiding backtracing. Refile target collection makes use of that."
  8900. (if fastp
  8901. (progn
  8902. (if (> level 19)
  8903. (error "Outline path failure, more than 19 levels."))
  8904. (loop for i from level upto 19 do
  8905. (aset org-olpa i nil))
  8906. (prog1
  8907. (delq nil (append org-olpa nil))
  8908. (aset org-olpa level heading)))
  8909. (let (rtn case-fold-search)
  8910. (save-excursion
  8911. (save-restriction
  8912. (widen)
  8913. (while (org-up-heading-safe)
  8914. (when (looking-at org-complex-heading-regexp)
  8915. (push (org-match-string-no-properties 4) rtn)))
  8916. rtn)))))
  8917. (defun org-format-outline-path (path &optional width prefix)
  8918. "Format the outlie path PATH for display.
  8919. Width is the maximum number of characters that is available.
  8920. Prefix is a prefix to be included in the returned string,
  8921. such as the file name."
  8922. (setq width (or width 79))
  8923. (if prefix (setq width (- width (length prefix))))
  8924. (if (not path)
  8925. (or prefix "")
  8926. (let* ((nsteps (length path))
  8927. (total-width (+ nsteps (apply '+ (mapcar 'length path))))
  8928. (maxwidth (if (<= total-width width)
  8929. 10000 ;; everything fits
  8930. ;; we need to shorten the level headings
  8931. (/ (- width nsteps) nsteps)))
  8932. (org-odd-levels-only nil)
  8933. (n 0)
  8934. (total (1+ (length prefix))))
  8935. (setq maxwidth (max maxwidth 10))
  8936. (concat prefix
  8937. (mapconcat
  8938. (lambda (h)
  8939. (setq n (1+ n))
  8940. (if (and (= n nsteps) (< maxwidth 10000))
  8941. (setq maxwidth (- total-width total)))
  8942. (if (< (length h) maxwidth)
  8943. (progn (setq total (+ total (length h) 1)) h)
  8944. (setq h (substring h 0 (- maxwidth 2))
  8945. total (+ total maxwidth 1))
  8946. (if (string-match "[ \t]+\\'" h)
  8947. (setq h (substring h 0 (match-beginning 0))))
  8948. (setq h (concat h "..")))
  8949. (org-add-props h nil 'face
  8950. (nth (% (1- n) org-n-level-faces)
  8951. org-level-faces))
  8952. h)
  8953. path "/")))))
  8954. (defun org-display-outline-path (&optional file current)
  8955. "Display the current outline path in the echo area."
  8956. (interactive "P")
  8957. (let* ((bfn (buffer-file-name (buffer-base-buffer)))
  8958. (case-fold-search nil)
  8959. (path (and (org-mode-p) (org-get-outline-path))))
  8960. (if current (setq path (append path
  8961. (save-excursion
  8962. (org-back-to-heading t)
  8963. (if (looking-at org-complex-heading-regexp)
  8964. (list (match-string 4)))))))
  8965. (message "%s"
  8966. (org-format-outline-path
  8967. path
  8968. (1- (frame-width))
  8969. (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
  8970. (defvar org-refile-history nil
  8971. "History for refiling operations.")
  8972. (defvar org-after-refile-insert-hook nil
  8973. "Hook run after `org-refile' has inserted its stuff at the new location.
  8974. Note that this is still *before* the stuff will be removed from
  8975. the *old* location.")
  8976. (defun org-refile (&optional goto default-buffer rfloc)
  8977. "Move the entry at point to another heading.
  8978. The list of target headings is compiled using the information in
  8979. `org-refile-targets', which see. This list is created before each use
  8980. and will therefore always be up-to-date.
  8981. At the target location, the entry is filed as a subitem of the target heading.
  8982. Depending on `org-reverse-note-order', the new subitem will either be the
  8983. first or the last subitem.
  8984. If there is an active region, all entries in that region will be moved.
  8985. However, the region must fulfil the requirement that the first heading
  8986. is the first one sets the top-level of the moved text - at most siblings
  8987. below it are allowed.
  8988. With prefix arg GOTO, the command will only visit the target location,
  8989. not actually move anything.
  8990. With a double prefix `C-u C-u', go to the location where the last refiling
  8991. operation has put the subtree.
  8992. With a prefix argument of `2', refile to the running clock.
  8993. RFLOC can be a refile location obtained in a different way.
  8994. See also `org-refile-use-outline-path' and `org-completion-use-ido'.
  8995. If you are using target caching (see `org-refile-use-cache'),
  8996. You have to clear the target cache in order to find new targets.
  8997. This can be done with a 0 prefix: `C-0 C-c C-w'"
  8998. (interactive "P")
  8999. (if (member goto '(0 (64)))
  9000. (org-refile-cache-clear)
  9001. (let* ((cbuf (current-buffer))
  9002. (regionp (org-region-active-p))
  9003. (region-start (and regionp (region-beginning)))
  9004. (region-end (and regionp (region-end)))
  9005. (region-length (and regionp (- region-end region-start)))
  9006. (filename (buffer-file-name (buffer-base-buffer cbuf)))
  9007. pos it nbuf file re level reversed)
  9008. (setq last-command nil)
  9009. (when regionp
  9010. (goto-char region-start)
  9011. (or (bolp) (goto-char (point-at-bol)))
  9012. (setq region-start (point))
  9013. (unless (org-kill-is-subtree-p
  9014. (buffer-substring region-start region-end))
  9015. (error "The region is not a (sequence of) subtree(s)")))
  9016. (if (equal goto '(16))
  9017. (org-refile-goto-last-stored)
  9018. (when (or
  9019. (and (equal goto 2)
  9020. org-clock-hd-marker (marker-buffer org-clock-hd-marker)
  9021. (prog1
  9022. (setq it (list (or org-clock-heading "running clock")
  9023. (buffer-file-name
  9024. (marker-buffer org-clock-hd-marker))
  9025. ""
  9026. (marker-position org-clock-hd-marker)))
  9027. (setq goto nil)))
  9028. (setq it (or rfloc
  9029. (save-excursion
  9030. (org-refile-get-location
  9031. (if goto "Goto: " "Refile to: ") default-buffer
  9032. org-refile-allow-creating-parent-nodes)))))
  9033. (setq file (nth 1 it)
  9034. re (nth 2 it)
  9035. pos (nth 3 it))
  9036. (if (and (not goto)
  9037. pos
  9038. (equal (buffer-file-name) file)
  9039. (if regionp
  9040. (and (>= pos region-start)
  9041. (<= pos region-end))
  9042. (and (>= pos (point))
  9043. (< pos (save-excursion
  9044. (org-end-of-subtree t t))))))
  9045. (error "Cannot refile to position inside the tree or region"))
  9046. (setq nbuf (or (find-buffer-visiting file)
  9047. (find-file-noselect file)))
  9048. (if goto
  9049. (progn
  9050. (switch-to-buffer nbuf)
  9051. (goto-char pos)
  9052. (org-show-context 'org-goto))
  9053. (if regionp
  9054. (progn
  9055. (org-kill-new (buffer-substring region-start region-end))
  9056. (org-save-markers-in-region region-start region-end))
  9057. (org-copy-subtree 1 nil t))
  9058. (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
  9059. (find-file-noselect file)))
  9060. (setq reversed (org-notes-order-reversed-p))
  9061. (save-excursion
  9062. (save-restriction
  9063. (widen)
  9064. (if pos
  9065. (progn
  9066. (goto-char pos)
  9067. (looking-at outline-regexp)
  9068. (setq level (org-get-valid-level (funcall outline-level) 1))
  9069. (goto-char
  9070. (if reversed
  9071. (or (outline-next-heading) (point-max))
  9072. (or (save-excursion (org-get-next-sibling))
  9073. (org-end-of-subtree t t)
  9074. (point-max)))))
  9075. (setq level 1)
  9076. (if (not reversed)
  9077. (goto-char (point-max))
  9078. (goto-char (point-min))
  9079. (or (outline-next-heading) (goto-char (point-max)))))
  9080. (if (not (bolp)) (newline))
  9081. (org-paste-subtree level)
  9082. (when org-log-refile
  9083. (org-add-log-setup 'refile nil nil 'findpos
  9084. org-log-refile)
  9085. (unless (eq org-log-refile 'note)
  9086. (save-excursion (org-add-log-note))))
  9087. (and org-auto-align-tags (org-set-tags nil t))
  9088. (bookmark-set "org-refile-last-stored")
  9089. (if (fboundp 'deactivate-mark) (deactivate-mark))
  9090. (run-hooks 'org-after-refile-insert-hook))))
  9091. (if regionp
  9092. (delete-region (point) (+ (point) region-length))
  9093. (org-cut-subtree))
  9094. (when (featurep 'org-inlinetask)
  9095. (org-inlinetask-remove-END-maybe))
  9096. (setq org-markers-to-move nil)
  9097. (message "Refiled to \"%s\" in file %s" (car it) file)))))))
  9098. (defun org-refile-goto-last-stored ()
  9099. "Go to the location where the last refile was stored."
  9100. (interactive)
  9101. (bookmark-jump "org-refile-last-stored")
  9102. (message "This is the location of the last refile"))
  9103. (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
  9104. "Prompt the user for a refile location, using PROMPT."
  9105. (let ((org-refile-targets org-refile-targets)
  9106. (org-refile-use-outline-path org-refile-use-outline-path))
  9107. (setq org-refile-target-table (org-get-refile-targets default-buffer)))
  9108. (unless org-refile-target-table
  9109. (error "No refile targets"))
  9110. (let* ((cbuf (current-buffer))
  9111. (partial-completion-mode nil)
  9112. (cfn (buffer-file-name (buffer-base-buffer cbuf)))
  9113. (cfunc (if (and org-refile-use-outline-path
  9114. org-outline-path-complete-in-steps)
  9115. 'org-olpath-completing-read
  9116. 'org-icompleting-read))
  9117. (extra (if org-refile-use-outline-path "/" ""))
  9118. (filename (and cfn (expand-file-name cfn)))
  9119. (tbl (mapcar
  9120. (lambda (x)
  9121. (if (and (not (member org-refile-use-outline-path
  9122. '(file full-file-path)))
  9123. (not (equal filename (nth 1 x))))
  9124. (cons (concat (car x) extra " ("
  9125. (file-name-nondirectory (nth 1 x)) ")")
  9126. (cdr x))
  9127. (cons (concat (car x) extra) (cdr x))))
  9128. org-refile-target-table))
  9129. (completion-ignore-case t)
  9130. pa answ parent-target child parent old-hist)
  9131. (setq old-hist org-refile-history)
  9132. (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
  9133. nil 'org-refile-history))
  9134. (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
  9135. (if pa
  9136. (progn
  9137. (when (or (not org-refile-history)
  9138. (not (eq old-hist org-refile-history))
  9139. (not (equal (car pa) (car org-refile-history))))
  9140. (setq org-refile-history
  9141. (cons (car pa) (if (assoc (car org-refile-history) tbl)
  9142. org-refile-history
  9143. (cdr org-refile-history))))
  9144. (if (equal (car org-refile-history) (nth 1 org-refile-history))
  9145. (pop org-refile-history)))
  9146. pa)
  9147. (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
  9148. (progn
  9149. (setq parent (match-string 1 answ)
  9150. child (match-string 2 answ))
  9151. (setq parent-target (or (assoc parent tbl)
  9152. (assoc (concat parent "/") tbl)))
  9153. (when (and parent-target
  9154. (or (eq new-nodes t)
  9155. (and (eq new-nodes 'confirm)
  9156. (y-or-n-p (format "Create new node \"%s\"? "
  9157. child)))))
  9158. (org-refile-new-child parent-target child)))
  9159. (error "Invalid target location")))))
  9160. (defun org-refile-new-child (parent-target child)
  9161. "Use refile target PARENT-TARGET to add new CHILD below it."
  9162. (unless parent-target
  9163. (error "Cannot find parent for new node"))
  9164. (let ((file (nth 1 parent-target))
  9165. (pos (nth 3 parent-target))
  9166. level)
  9167. (with-current-buffer (or (find-buffer-visiting file)
  9168. (find-file-noselect file))
  9169. (save-excursion
  9170. (save-restriction
  9171. (widen)
  9172. (if pos
  9173. (goto-char pos)
  9174. (goto-char (point-max))
  9175. (if (not (bolp)) (newline)))
  9176. (when (looking-at outline-regexp)
  9177. (setq level (funcall outline-level))
  9178. (org-end-of-subtree t t))
  9179. (org-back-over-empty-lines)
  9180. (insert "\n" (make-string
  9181. (if pos (org-get-valid-level level 1) 1) ?*)
  9182. " " child "\n")
  9183. (beginning-of-line 0)
  9184. (list (concat (car parent-target) "/" child) file "" (point)))))))
  9185. (defun org-olpath-completing-read (prompt collection &rest args)
  9186. "Read an outline path like a file name."
  9187. (let ((thetable collection)
  9188. (org-completion-use-ido nil) ; does not work with ido.
  9189. (org-completion-use-iswitchb nil)) ; or iswitchb
  9190. (apply
  9191. 'org-icompleting-read prompt
  9192. (lambda (string predicate &optional flag)
  9193. (let (rtn r f (l (length string)))
  9194. (cond
  9195. ((eq flag nil)
  9196. ;; try completion
  9197. (try-completion string thetable))
  9198. ((eq flag t)
  9199. ;; all-completions
  9200. (setq rtn (all-completions string thetable predicate))
  9201. (mapcar
  9202. (lambda (x)
  9203. (setq r (substring x l))
  9204. (if (string-match " ([^)]*)$" x)
  9205. (setq f (match-string 0 x))
  9206. (setq f ""))
  9207. (if (string-match "/" r)
  9208. (concat string (substring r 0 (match-end 0)) f)
  9209. x))
  9210. rtn))
  9211. ((eq flag 'lambda)
  9212. ;; exact match?
  9213. (assoc string thetable)))
  9214. ))
  9215. args)))
  9216. ;;;; Dynamic blocks
  9217. (defun org-find-dblock (name)
  9218. "Find the first dynamic block with name NAME in the buffer.
  9219. If not found, stay at current position and return nil."
  9220. (let (pos)
  9221. (save-excursion
  9222. (goto-char (point-min))
  9223. (setq pos (and (re-search-forward (concat "^#\\+BEGIN:[ \t]+" name "\\>")
  9224. nil t)
  9225. (match-beginning 0))))
  9226. (if pos (goto-char pos))
  9227. pos))
  9228. (defconst org-dblock-start-re
  9229. "^[ \t]*#\\+BEGIN:[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
  9230. "Matches the start line of a dynamic block, with parameters.")
  9231. (defconst org-dblock-end-re "^[ \t]*#\\+END\\([: \t\r\n]\\|$\\)"
  9232. "Matches the end of a dynamic block.")
  9233. (defun org-create-dblock (plist)
  9234. "Create a dynamic block section, with parameters taken from PLIST.
  9235. PLIST must contain a :name entry which is used as name of the block."
  9236. (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
  9237. (end-of-line 1)
  9238. (newline))
  9239. (let ((col (current-column))
  9240. (name (plist-get plist :name)))
  9241. (insert "#+BEGIN: " name)
  9242. (while plist
  9243. (if (eq (car plist) :name)
  9244. (setq plist (cddr plist))
  9245. (insert " " (prin1-to-string (pop plist)))))
  9246. (insert "\n\n" (make-string col ?\ ) "#+END:\n")
  9247. (beginning-of-line -2)))
  9248. (defun org-prepare-dblock ()
  9249. "Prepare dynamic block for refresh.
  9250. This empties the block, puts the cursor at the insert position and returns
  9251. the property list including an extra property :name with the block name."
  9252. (unless (looking-at org-dblock-start-re)
  9253. (error "Not at a dynamic block"))
  9254. (let* ((begdel (1+ (match-end 0)))
  9255. (name (org-no-properties (match-string 1)))
  9256. (params (append (list :name name)
  9257. (read (concat "(" (match-string 3) ")")))))
  9258. (save-excursion
  9259. (beginning-of-line 1)
  9260. (skip-chars-forward " \t")
  9261. (setq params (plist-put params :indentation-column (current-column))))
  9262. (unless (re-search-forward org-dblock-end-re nil t)
  9263. (error "Dynamic block not terminated"))
  9264. (setq params
  9265. (append params
  9266. (list :content (buffer-substring
  9267. begdel (match-beginning 0)))))
  9268. (delete-region begdel (match-beginning 0))
  9269. (goto-char begdel)
  9270. (open-line 1)
  9271. params))
  9272. (defun org-map-dblocks (&optional command)
  9273. "Apply COMMAND to all dynamic blocks in the current buffer.
  9274. If COMMAND is not given, use `org-update-dblock'."
  9275. (let ((cmd (or command 'org-update-dblock)))
  9276. (save-excursion
  9277. (goto-char (point-min))
  9278. (while (re-search-forward org-dblock-start-re nil t)
  9279. (goto-char (match-beginning 0))
  9280. (save-excursion
  9281. (condition-case nil
  9282. (funcall cmd)
  9283. (error (message "Error during update of dynamic block"))))
  9284. (unless (re-search-forward org-dblock-end-re nil t)
  9285. (error "Dynamic block not terminated"))))))
  9286. (defun org-dblock-update (&optional arg)
  9287. "User command for updating dynamic blocks.
  9288. Update the dynamic block at point. With prefix ARG, update all dynamic
  9289. blocks in the buffer."
  9290. (interactive "P")
  9291. (if arg
  9292. (org-update-all-dblocks)
  9293. (or (looking-at org-dblock-start-re)
  9294. (org-beginning-of-dblock))
  9295. (org-update-dblock)))
  9296. (defun org-update-dblock ()
  9297. "Update the dynamic block at point
  9298. This means to empty the block, parse for parameters and then call
  9299. the correct writing function."
  9300. (save-window-excursion
  9301. (let* ((pos (point))
  9302. (line (org-current-line))
  9303. (params (org-prepare-dblock))
  9304. (name (plist-get params :name))
  9305. (indent (plist-get params :indentation-column))
  9306. (cmd (intern (concat "org-dblock-write:" name))))
  9307. (message "Updating dynamic block `%s' at line %d..." name line)
  9308. (funcall cmd params)
  9309. (message "Updating dynamic block `%s' at line %d...done" name line)
  9310. (goto-char pos)
  9311. (when (and indent (> indent 0))
  9312. (setq indent (make-string indent ?\ ))
  9313. (save-excursion
  9314. (org-beginning-of-dblock)
  9315. (forward-line 1)
  9316. (while (not (looking-at org-dblock-end-re))
  9317. (insert indent)
  9318. (beginning-of-line 2))
  9319. (when (looking-at org-dblock-end-re)
  9320. (and (looking-at "[ \t]+")
  9321. (replace-match ""))
  9322. (insert indent)))))))
  9323. (defun org-beginning-of-dblock ()
  9324. "Find the beginning of the dynamic block at point.
  9325. Error if there is no such block at point."
  9326. (let ((pos (point))
  9327. beg)
  9328. (end-of-line 1)
  9329. (if (and (re-search-backward org-dblock-start-re nil t)
  9330. (setq beg (match-beginning 0))
  9331. (re-search-forward org-dblock-end-re nil t)
  9332. (> (match-end 0) pos))
  9333. (goto-char beg)
  9334. (goto-char pos)
  9335. (error "Not in a dynamic block"))))
  9336. (defun org-update-all-dblocks ()
  9337. "Update all dynamic blocks in the buffer.
  9338. This function can be used in a hook."
  9339. (when (org-mode-p)
  9340. (org-map-dblocks 'org-update-dblock)))
  9341. ;;;; Completion
  9342. (defconst org-additional-option-like-keywords
  9343. '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML"
  9344. "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook"
  9345. "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
  9346. "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX"
  9347. "BEGIN:" "END:"
  9348. "ORGTBL" "TBLFM:" "TBLNAME:"
  9349. "BEGIN_EXAMPLE" "END_EXAMPLE"
  9350. "BEGIN_QUOTE" "END_QUOTE"
  9351. "BEGIN_VERSE" "END_VERSE"
  9352. "BEGIN_CENTER" "END_CENTER"
  9353. "BEGIN_SRC" "END_SRC"
  9354. "CATEGORY" "COLUMNS"
  9355. "CAPTION" "LABEL"
  9356. "SETUPFILE"
  9357. "BIND"
  9358. "MACRO"))
  9359. (defcustom org-structure-template-alist
  9360. '(
  9361. ("s" "#+begin_src ?\n\n#+end_src"
  9362. "<src lang=\"?\">\n\n</src>")
  9363. ("e" "#+begin_example\n?\n#+end_example"
  9364. "<example>\n?\n</example>")
  9365. ("q" "#+begin_quote\n?\n#+end_quote"
  9366. "<quote>\n?\n</quote>")
  9367. ("v" "#+begin_verse\n?\n#+end_verse"
  9368. "<verse>\n?\n/verse>")
  9369. ("c" "#+begin_center\n?\n#+end_center"
  9370. "<center>\n?\n/center>")
  9371. ("l" "#+begin_latex\n?\n#+end_latex"
  9372. "<literal style=\"latex\">\n?\n</literal>")
  9373. ("L" "#+latex: "
  9374. "<literal style=\"latex\">?</literal>")
  9375. ("h" "#+begin_html\n?\n#+end_html"
  9376. "<literal style=\"html\">\n?\n</literal>")
  9377. ("H" "#+html: "
  9378. "<literal style=\"html\">?</literal>")
  9379. ("a" "#+begin_ascii\n?\n#+end_ascii")
  9380. ("A" "#+ascii: ")
  9381. ("i" "#+include %file ?"
  9382. "<include file=%file markup=\"?\">")
  9383. )
  9384. "Structure completion elements.
  9385. This is a list of abbreviation keys and values. The value gets inserted
  9386. if you type `<' followed by the key and then press the completion key,
  9387. usually `M-TAB'. %file will be replaced by a file name after prompting
  9388. for the file using completion.
  9389. There are two templates for each key, the first uses the original Org syntax,
  9390. the second uses Emacs Muse-like syntax tags. These Muse-like tags become
  9391. the default when the /org-mtags.el/ module has been loaded. See also the
  9392. variable `org-mtags-prefer-muse-templates'.
  9393. This is an experimental feature, it is undecided if it is going to stay in."
  9394. :group 'org-completion
  9395. :type '(repeat
  9396. (string :tag "Key")
  9397. (string :tag "Template")
  9398. (string :tag "Muse Template")))
  9399. (defun org-try-structure-completion ()
  9400. "Try to complete a structure template before point.
  9401. This looks for strings like \"<e\" on an otherwise empty line and
  9402. expands them."
  9403. (let ((l (buffer-substring (point-at-bol) (point)))
  9404. a)
  9405. (when (and (looking-at "[ \t]*$")
  9406. (string-match "^[ \t]*<\\([a-z]+\\)$"l)
  9407. (setq a (assoc (match-string 1 l) org-structure-template-alist)))
  9408. (org-complete-expand-structure-template (+ -1 (point-at-bol)
  9409. (match-beginning 1)) a)
  9410. t)))
  9411. (defun org-complete-expand-structure-template (start cell)
  9412. "Expand a structure template."
  9413. (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
  9414. (rpl (nth (if musep 2 1) cell))
  9415. (ind ""))
  9416. (delete-region start (point))
  9417. (when (string-match "\\`#\\+" rpl)
  9418. (cond
  9419. ((bolp))
  9420. ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
  9421. (setq ind (buffer-substring (point-at-bol) (point))))
  9422. (t (newline))))
  9423. (setq start (point))
  9424. (if (string-match "%file" rpl)
  9425. (setq rpl (replace-match
  9426. (concat
  9427. "\""
  9428. (save-match-data
  9429. (abbreviate-file-name (read-file-name "Include file: ")))
  9430. "\"")
  9431. t t rpl)))
  9432. (setq rpl (mapconcat 'identity (split-string rpl "\n")
  9433. (concat "\n" ind)))
  9434. (insert rpl)
  9435. (if (re-search-backward "\\?" start t) (delete-char 1))))
  9436. (defun org-complete (&optional arg)
  9437. "Perform completion on word at point.
  9438. At the beginning of a headline, this completes TODO keywords as given in
  9439. `org-todo-keywords'.
  9440. If the current word is preceded by a backslash, completes the TeX symbols
  9441. that are supported for HTML support.
  9442. If the current word is preceded by \"#+\", completes special words for
  9443. setting file options.
  9444. In the line after \"#+STARTUP:, complete valid keywords.\"
  9445. At all other locations, this simply calls the value of
  9446. `org-completion-fallback-command'."
  9447. (interactive "P")
  9448. (org-without-partial-completion
  9449. (catch 'exit
  9450. (let* ((a nil)
  9451. (end (point))
  9452. (beg1 (save-excursion
  9453. (skip-chars-backward (org-re "[:alnum:]_@"))
  9454. (point)))
  9455. (beg (save-excursion
  9456. (skip-chars-backward "a-zA-Z0-9_:$")
  9457. (point)))
  9458. (confirm (lambda (x) (stringp (car x))))
  9459. (searchhead (equal (char-before beg) ?*))
  9460. (struct
  9461. (when (and (member (char-before beg1) '(?. ?<))
  9462. (setq a (assoc (buffer-substring beg1 (point))
  9463. org-structure-template-alist)))
  9464. (org-complete-expand-structure-template (1- beg1) a)
  9465. (throw 'exit t)))
  9466. (tag (and (equal (char-before beg1) ?:)
  9467. (equal (char-after (point-at-bol)) ?*)))
  9468. (prop (and (equal (char-before beg1) ?:)
  9469. (not (equal (char-after (point-at-bol)) ?*))))
  9470. (texp (equal (char-before beg) ?\\))
  9471. (link (equal (char-before beg) ?\[))
  9472. (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
  9473. beg)
  9474. "#+"))
  9475. (startup (string-match "^#\\+STARTUP:.*"
  9476. (buffer-substring (point-at-bol) (point))))
  9477. (completion-ignore-case opt)
  9478. (type nil)
  9479. (tbl nil)
  9480. (table (cond
  9481. (opt
  9482. (setq type :opt)
  9483. (require 'org-exp)
  9484. (append
  9485. (delq nil
  9486. (mapcar
  9487. (lambda (x)
  9488. (if (string-match
  9489. "^#\\+\\(\\([A-Z_]+:?\\).*\\)" x)
  9490. (cons (match-string 2 x)
  9491. (match-string 1 x))))
  9492. (org-split-string (org-get-current-options) "\n")))
  9493. (mapcar 'list org-additional-option-like-keywords)))
  9494. (startup
  9495. (setq type :startup)
  9496. org-startup-options)
  9497. (link (append org-link-abbrev-alist-local
  9498. org-link-abbrev-alist))
  9499. (texp
  9500. (setq type :tex)
  9501. (append org-entities-user org-entities))
  9502. ((string-match "\\`\\*+[ \t]+\\'"
  9503. (buffer-substring (point-at-bol) beg))
  9504. (setq type :todo)
  9505. (mapcar 'list org-todo-keywords-1))
  9506. (searchhead
  9507. (setq type :searchhead)
  9508. (save-excursion
  9509. (goto-char (point-min))
  9510. (while (re-search-forward org-todo-line-regexp nil t)
  9511. (push (list
  9512. (org-make-org-heading-search-string
  9513. (match-string 3) t))
  9514. tbl)))
  9515. tbl)
  9516. (tag (setq type :tag beg beg1)
  9517. (or org-tag-alist (org-get-buffer-tags)))
  9518. (prop (setq type :prop beg beg1)
  9519. (mapcar 'list (org-buffer-property-keys nil t t)))
  9520. (t (progn
  9521. (call-interactively org-completion-fallback-command)
  9522. (throw 'exit nil)))))
  9523. (pattern (buffer-substring-no-properties beg end))
  9524. (completion (try-completion pattern table confirm)))
  9525. (cond ((eq completion t)
  9526. (if (not (assoc (upcase pattern) table))
  9527. (message "Already complete")
  9528. (if (and (equal type :opt)
  9529. (not (member (car (assoc (upcase pattern) table))
  9530. org-additional-option-like-keywords)))
  9531. (insert (substring (cdr (assoc (upcase pattern) table))
  9532. (length pattern)))
  9533. (if (memq type '(:tag :prop)) (insert ":")))))
  9534. ((null completion)
  9535. (message "Can't find completion for \"%s\"" pattern)
  9536. (ding))
  9537. ((not (string= pattern completion))
  9538. (delete-region beg end)
  9539. (if (string-match " +$" completion)
  9540. (setq completion (replace-match "" t t completion)))
  9541. (insert completion)
  9542. (if (get-buffer-window "*Completions*")
  9543. (delete-window (get-buffer-window "*Completions*")))
  9544. (if (assoc completion table)
  9545. (if (eq type :todo) (insert " ")
  9546. (if (memq type '(:tag :prop)) (insert ":"))))
  9547. (if (and (equal type :opt) (assoc completion table))
  9548. (message "%s" (substitute-command-keys
  9549. "Press \\[org-complete] again to insert example settings"))))
  9550. (t
  9551. (message "Making completion list...")
  9552. (let ((list (sort (all-completions pattern table confirm)
  9553. 'string<)))
  9554. (with-output-to-temp-buffer "*Completions*"
  9555. (condition-case nil
  9556. ;; Protection needed for XEmacs and emacs 21
  9557. (display-completion-list list pattern)
  9558. (error (display-completion-list list)))))
  9559. (message "Making completion list...%s" "done")))))))
  9560. ;;;; TODO, DEADLINE, Comments
  9561. (defun org-toggle-comment ()
  9562. "Change the COMMENT state of an entry."
  9563. (interactive)
  9564. (save-excursion
  9565. (org-back-to-heading)
  9566. (let (case-fold-search)
  9567. (if (looking-at (concat outline-regexp
  9568. "\\( *\\<" org-comment-string "\\>[ \t]*\\)"))
  9569. (replace-match "" t t nil 1)
  9570. (if (looking-at outline-regexp)
  9571. (progn
  9572. (goto-char (match-end 0))
  9573. (insert org-comment-string " ")))))))
  9574. (defvar org-last-todo-state-is-todo nil
  9575. "This is non-nil when the last TODO state change led to a TODO state.
  9576. If the last change removed the TODO tag or switched to DONE, then
  9577. this is nil.")
  9578. (defvar org-setting-tags nil) ; dynamically skipped
  9579. (defun org-parse-local-options (string var)
  9580. "Parse STRING for startup setting relevant for variable VAR."
  9581. (let ((rtn (symbol-value var))
  9582. e opts)
  9583. (save-match-data
  9584. (if (or (not string) (not (string-match "\\S-" string)))
  9585. rtn
  9586. (setq opts (delq nil (mapcar (lambda (x)
  9587. (setq e (assoc x org-startup-options))
  9588. (if (eq (nth 1 e) var) e nil))
  9589. (org-split-string string "[ \t]+"))))
  9590. (if (not opts)
  9591. rtn
  9592. (setq rtn nil)
  9593. (while (setq e (pop opts))
  9594. (if (not (nth 3 e))
  9595. (setq rtn (nth 2 e))
  9596. (if (not (listp rtn)) (setq rtn nil))
  9597. (push (nth 2 e) rtn)))
  9598. rtn)))))
  9599. (defvar org-todo-setup-filter-hook nil
  9600. "Hook for functions that pre-filter todo specs.
  9601. Each function takes a todo spec and returns either `nil' or the spec
  9602. transformed into canonical form." )
  9603. (defvar org-todo-get-default-hook nil
  9604. "Hook for functions that get a default item for todo.
  9605. Each function takes arguments (NEW-MARK OLD-MARK) and returns either
  9606. `nil' or a string to be used for the todo mark." )
  9607. (defvar org-agenda-headline-snapshot-before-repeat)
  9608. (defun org-todo (&optional arg)
  9609. "Change the TODO state of an item.
  9610. The state of an item is given by a keyword at the start of the heading,
  9611. like
  9612. *** TODO Write paper
  9613. *** DONE Call mom
  9614. The different keywords are specified in the variable `org-todo-keywords'.
  9615. By default the available states are \"TODO\" and \"DONE\".
  9616. So for this example: when the item starts with TODO, it is changed to DONE.
  9617. When it starts with DONE, the DONE is removed. And when neither TODO nor
  9618. DONE are present, add TODO at the beginning of the heading.
  9619. With C-u prefix arg, use completion to determine the new state.
  9620. With numeric prefix arg, switch to that state.
  9621. With a double C-u prefix, switch to the next set of TODO keywords (nextset).
  9622. With a triple C-u prefix, circumvent any state blocking.
  9623. For calling through lisp, arg is also interpreted in the following way:
  9624. 'none -> empty state
  9625. \"\"(empty string) -> switch to empty state
  9626. 'done -> switch to DONE
  9627. 'nextset -> switch to the next set of keywords
  9628. 'previousset -> switch to the previous set of keywords
  9629. \"WAITING\" -> switch to the specified keyword, but only if it
  9630. really is a member of `org-todo-keywords'."
  9631. (interactive "P")
  9632. (if (equal arg '(16)) (setq arg 'nextset))
  9633. (let ((org-blocker-hook org-blocker-hook)
  9634. (case-fold-search nil))
  9635. (when (equal arg '(64))
  9636. (setq arg nil org-blocker-hook nil))
  9637. (when (and org-blocker-hook
  9638. (or org-inhibit-blocking
  9639. (org-entry-get nil "NOBLOCKING")))
  9640. (setq org-blocker-hook nil))
  9641. (save-excursion
  9642. (catch 'exit
  9643. (org-back-to-heading t)
  9644. (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
  9645. (or (looking-at (concat " +" org-todo-regexp "\\( +\\|$\\)"))
  9646. (looking-at " *"))
  9647. (let* ((match-data (match-data))
  9648. (startpos (point-at-bol))
  9649. (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
  9650. (org-log-done org-log-done)
  9651. (org-log-repeat org-log-repeat)
  9652. (org-todo-log-states org-todo-log-states)
  9653. (this (match-string 1))
  9654. (hl-pos (match-beginning 0))
  9655. (head (org-get-todo-sequence-head this))
  9656. (ass (assoc head org-todo-kwd-alist))
  9657. (interpret (nth 1 ass))
  9658. (done-word (nth 3 ass))
  9659. (final-done-word (nth 4 ass))
  9660. (last-state (or this ""))
  9661. (completion-ignore-case t)
  9662. (member (member this org-todo-keywords-1))
  9663. (tail (cdr member))
  9664. (state (cond
  9665. ((and org-todo-key-trigger
  9666. (or (and (equal arg '(4))
  9667. (eq org-use-fast-todo-selection 'prefix))
  9668. (and (not arg) org-use-fast-todo-selection
  9669. (not (eq org-use-fast-todo-selection
  9670. 'prefix)))))
  9671. ;; Use fast selection
  9672. (org-fast-todo-selection))
  9673. ((and (equal arg '(4))
  9674. (or (not org-use-fast-todo-selection)
  9675. (not org-todo-key-trigger)))
  9676. ;; Read a state with completion
  9677. (org-icompleting-read
  9678. "State: " (mapcar (lambda(x) (list x))
  9679. org-todo-keywords-1)
  9680. nil t))
  9681. ((eq arg 'right)
  9682. (if this
  9683. (if tail (car tail) nil)
  9684. (car org-todo-keywords-1)))
  9685. ((eq arg 'left)
  9686. (if (equal member org-todo-keywords-1)
  9687. nil
  9688. (if this
  9689. (nth (- (length org-todo-keywords-1)
  9690. (length tail) 2)
  9691. org-todo-keywords-1)
  9692. (org-last org-todo-keywords-1))))
  9693. ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
  9694. (setq arg nil))) ; hack to fall back to cycling
  9695. (arg
  9696. ;; user or caller requests a specific state
  9697. (cond
  9698. ((equal arg "") nil)
  9699. ((eq arg 'none) nil)
  9700. ((eq arg 'done) (or done-word (car org-done-keywords)))
  9701. ((eq arg 'nextset)
  9702. (or (car (cdr (member head org-todo-heads)))
  9703. (car org-todo-heads)))
  9704. ((eq arg 'previousset)
  9705. (let ((org-todo-heads (reverse org-todo-heads)))
  9706. (or (car (cdr (member head org-todo-heads)))
  9707. (car org-todo-heads))))
  9708. ((car (member arg org-todo-keywords-1)))
  9709. ((stringp arg)
  9710. (error "State `%s' not valid in this file" arg))
  9711. ((nth (1- (prefix-numeric-value arg))
  9712. org-todo-keywords-1))))
  9713. ((null member) (or head (car org-todo-keywords-1)))
  9714. ((equal this final-done-word) nil) ;; -> make empty
  9715. ((null tail) nil) ;; -> first entry
  9716. ((memq interpret '(type priority))
  9717. (if (eq this-command last-command)
  9718. (car tail)
  9719. (if (> (length tail) 0)
  9720. (or done-word (car org-done-keywords))
  9721. nil)))
  9722. (t
  9723. (car tail))))
  9724. (state (or
  9725. (run-hook-with-args-until-success
  9726. 'org-todo-get-default-hook state last-state)
  9727. state))
  9728. (next (if state (concat " " state " ") " "))
  9729. (change-plist (list :type 'todo-state-change :from this :to state
  9730. :position startpos))
  9731. dolog now-done-p)
  9732. (when org-blocker-hook
  9733. (setq org-last-todo-state-is-todo
  9734. (not (member this org-done-keywords)))
  9735. (unless (save-excursion
  9736. (save-match-data
  9737. (run-hook-with-args-until-failure
  9738. 'org-blocker-hook change-plist)))
  9739. (if (interactive-p)
  9740. (error "TODO state change from %s to %s blocked" this state)
  9741. ;; fail silently
  9742. (message "TODO state change from %s to %s blocked" this state)
  9743. (throw 'exit nil))))
  9744. (store-match-data match-data)
  9745. (replace-match next t t)
  9746. (unless (pos-visible-in-window-p hl-pos)
  9747. (message "TODO state changed to %s" (org-trim next)))
  9748. (unless head
  9749. (setq head (org-get-todo-sequence-head state)
  9750. ass (assoc head org-todo-kwd-alist)
  9751. interpret (nth 1 ass)
  9752. done-word (nth 3 ass)
  9753. final-done-word (nth 4 ass)))
  9754. (when (memq arg '(nextset previousset))
  9755. (message "Keyword-Set %d/%d: %s"
  9756. (- (length org-todo-sets) -1
  9757. (length (memq (assoc state org-todo-sets) org-todo-sets)))
  9758. (length org-todo-sets)
  9759. (mapconcat 'identity (assoc state org-todo-sets) " ")))
  9760. (setq org-last-todo-state-is-todo
  9761. (not (member state org-done-keywords)))
  9762. (setq now-done-p (and (member state org-done-keywords)
  9763. (not (member this org-done-keywords))))
  9764. (and logging (org-local-logging logging))
  9765. (when (and (or org-todo-log-states org-log-done)
  9766. (not (eq org-inhibit-logging t))
  9767. (not (memq arg '(nextset previousset))))
  9768. ;; we need to look at recording a time and note
  9769. (setq dolog (or (nth 1 (assoc state org-todo-log-states))
  9770. (nth 2 (assoc this org-todo-log-states))))
  9771. (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
  9772. (setq dolog 'time))
  9773. (when (and state
  9774. (member state org-not-done-keywords)
  9775. (not (member this org-not-done-keywords)))
  9776. ;; This is now a todo state and was not one before
  9777. ;; If there was a CLOSED time stamp, get rid of it.
  9778. (org-add-planning-info nil nil 'closed))
  9779. (when (and now-done-p org-log-done)
  9780. ;; It is now done, and it was not done before
  9781. (org-add-planning-info 'closed (org-current-time))
  9782. (if (and (not dolog) (eq 'note org-log-done))
  9783. (org-add-log-setup 'done state this 'findpos 'note)))
  9784. (when (and state dolog)
  9785. ;; This is a non-nil state, and we need to log it
  9786. (org-add-log-setup 'state state this 'findpos dolog)))
  9787. ;; Fixup tag positioning
  9788. (org-todo-trigger-tag-changes state)
  9789. (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
  9790. (when org-provide-todo-statistics
  9791. (org-update-parent-todo-statistics))
  9792. (run-hooks 'org-after-todo-state-change-hook)
  9793. (if (and arg (not (member state org-done-keywords)))
  9794. (setq head (org-get-todo-sequence-head state)))
  9795. (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
  9796. ;; Do we need to trigger a repeat?
  9797. (when now-done-p
  9798. (when (boundp 'org-agenda-headline-snapshot-before-repeat)
  9799. ;; This is for the agenda, take a snapshot of the headline.
  9800. (save-match-data
  9801. (setq org-agenda-headline-snapshot-before-repeat
  9802. (org-get-heading))))
  9803. (org-auto-repeat-maybe state))
  9804. ;; Fixup cursor location if close to the keyword
  9805. (if (and (outline-on-heading-p)
  9806. (not (bolp))
  9807. (save-excursion (beginning-of-line 1)
  9808. (looking-at org-todo-line-regexp))
  9809. (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
  9810. (progn
  9811. (goto-char (or (match-end 2) (match-end 1)))
  9812. (and (looking-at " ") (just-one-space))))
  9813. (when org-trigger-hook
  9814. (save-excursion
  9815. (run-hook-with-args 'org-trigger-hook change-plist))))))))
  9816. (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
  9817. "Block turning an entry into a TODO, using the hierarchy.
  9818. This checks whether the current task should be blocked from state
  9819. changes. Such blocking occurs when:
  9820. 1. The task has children which are not all in a completed state.
  9821. 2. A task has a parent with the property :ORDERED:, and there
  9822. are siblings prior to the current task with incomplete
  9823. status.
  9824. 3. The parent of the task is blocked because it has siblings that should
  9825. be done first, or is child of a block grandparent TODO entry."
  9826. (if (not org-enforce-todo-dependencies)
  9827. t ; if locally turned off don't block
  9828. (catch 'dont-block
  9829. ;; If this is not a todo state change, or if this entry is already DONE,
  9830. ;; do not block
  9831. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  9832. (member (plist-get change-plist :from)
  9833. (cons 'done org-done-keywords))
  9834. (member (plist-get change-plist :to)
  9835. (cons 'todo org-not-done-keywords))
  9836. (not (plist-get change-plist :to)))
  9837. (throw 'dont-block t))
  9838. ;; If this task has children, and any are undone, it's blocked
  9839. (save-excursion
  9840. (org-back-to-heading t)
  9841. (let ((this-level (funcall outline-level)))
  9842. (outline-next-heading)
  9843. (let ((child-level (funcall outline-level)))
  9844. (while (and (not (eobp))
  9845. (> child-level this-level))
  9846. ;; this todo has children, check whether they are all
  9847. ;; completed
  9848. (if (and (not (org-entry-is-done-p))
  9849. (org-entry-is-todo-p))
  9850. (throw 'dont-block nil))
  9851. (outline-next-heading)
  9852. (setq child-level (funcall outline-level))))))
  9853. ;; Otherwise, if the task's parent has the :ORDERED: property, and
  9854. ;; any previous siblings are undone, it's blocked
  9855. (save-excursion
  9856. (org-back-to-heading t)
  9857. (let* ((pos (point))
  9858. (parent-pos (and (org-up-heading-safe) (point))))
  9859. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  9860. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  9861. (forward-line 1)
  9862. (re-search-forward org-not-done-heading-regexp pos t))
  9863. (throw 'dont-block nil)) ; block, there is an older sibling not done.
  9864. ;; Search further up the hierarchy, to see if an anchestor is blocked
  9865. (while t
  9866. (goto-char parent-pos)
  9867. (if (not (looking-at org-not-done-heading-regexp))
  9868. (throw 'dont-block t)) ; do not block, parent is not a TODO
  9869. (setq pos (point))
  9870. (setq parent-pos (and (org-up-heading-safe) (point)))
  9871. (if (not parent-pos) (throw 'dont-block t)) ; no parent
  9872. (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
  9873. (forward-line 1)
  9874. (re-search-forward org-not-done-heading-regexp pos t))
  9875. (throw 'dont-block nil)))))))) ; block, older sibling not done.
  9876. (defcustom org-track-ordered-property-with-tag nil
  9877. "Should the ORDERED property also be shown as a tag?
  9878. The ORDERED property decides if an entry should require subtasks to be
  9879. completed in sequence. Since a property is not very visible, setting
  9880. this option means that toggling the ORDERED property with the command
  9881. `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
  9882. not relevant for the behavior, but it makes things more visible.
  9883. Note that toggling the tag with tags commands will not change the property
  9884. and therefore not influence behavior!
  9885. This can be t, meaning the tag ORDERED should be used, It can also be a
  9886. string to select a different tag for this task."
  9887. :group 'org-todo
  9888. :type '(choice
  9889. (const :tag "No tracking" nil)
  9890. (const :tag "Track with ORDERED tag" t)
  9891. (string :tag "Use other tag")))
  9892. (defun org-toggle-ordered-property ()
  9893. "Toggle the ORDERED property of the current entry.
  9894. For better visibility, you can track the value of this property with a tag.
  9895. See variable `org-track-ordered-property-with-tag'."
  9896. (interactive)
  9897. (let* ((t1 org-track-ordered-property-with-tag)
  9898. (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
  9899. (save-excursion
  9900. (org-back-to-heading)
  9901. (if (org-entry-get nil "ORDERED")
  9902. (progn
  9903. (org-delete-property "ORDERED")
  9904. (and tag (org-toggle-tag tag 'off))
  9905. (message "Subtasks can be completed in arbitrary order"))
  9906. (org-entry-put nil "ORDERED" "t")
  9907. (and tag (org-toggle-tag tag 'on))
  9908. (message "Subtasks must be completed in sequence")))))
  9909. (defvar org-blocked-by-checkboxes) ; dynamically scoped
  9910. (defun org-block-todo-from-checkboxes (change-plist)
  9911. "Block turning an entry into a TODO, using checkboxes.
  9912. This checks whether the current task should be blocked from state
  9913. changes because there are unchecked boxes in this entry."
  9914. (if (not org-enforce-todo-checkbox-dependencies)
  9915. t ; if locally turned off don't block
  9916. (catch 'dont-block
  9917. ;; If this is not a todo state change, or if this entry is already DONE,
  9918. ;; do not block
  9919. (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
  9920. (member (plist-get change-plist :from)
  9921. (cons 'done org-done-keywords))
  9922. (member (plist-get change-plist :to)
  9923. (cons 'todo org-not-done-keywords))
  9924. (not (plist-get change-plist :to)))
  9925. (throw 'dont-block t))
  9926. ;; If this task has checkboxes that are not checked, it's blocked
  9927. (save-excursion
  9928. (org-back-to-heading t)
  9929. (let ((beg (point)) end)
  9930. (outline-next-heading)
  9931. (setq end (point))
  9932. (goto-char beg)
  9933. (if (re-search-forward "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\)[ \t]+\\[[- ]\\]"
  9934. end t)
  9935. (progn
  9936. (if (boundp 'org-blocked-by-checkboxes)
  9937. (setq org-blocked-by-checkboxes t))
  9938. (throw 'dont-block nil)))))
  9939. t))) ; do not block
  9940. (defun org-entry-blocked-p ()
  9941. "Is the current entry blocked?"
  9942. (if (org-entry-get nil "NOBLOCKING")
  9943. nil ;; Never block this entry
  9944. (not
  9945. (run-hook-with-args-until-failure
  9946. 'org-blocker-hook
  9947. (list :type 'todo-state-change
  9948. :position (point)
  9949. :from 'todo
  9950. :to 'done)))))
  9951. (defun org-update-statistics-cookies (all)
  9952. "Update the statistics cookie, either from TODO or from checkboxes.
  9953. This should be called with the cursor in a line with a statistics cookie."
  9954. (interactive "P")
  9955. (if all
  9956. (progn
  9957. (org-update-checkbox-count 'all)
  9958. (org-map-entries 'org-update-parent-todo-statistics))
  9959. (if (not (org-on-heading-p))
  9960. (org-update-checkbox-count)
  9961. (let ((pos (move-marker (make-marker) (point)))
  9962. end l1 l2)
  9963. (ignore-errors (org-back-to-heading t))
  9964. (if (not (org-on-heading-p))
  9965. (org-update-checkbox-count)
  9966. (setq l1 (org-outline-level))
  9967. (setq end (save-excursion
  9968. (outline-next-heading)
  9969. (if (org-on-heading-p) (setq l2 (org-outline-level)))
  9970. (point)))
  9971. (if (and (save-excursion
  9972. (re-search-forward
  9973. "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
  9974. (not (save-excursion (re-search-forward
  9975. ":COOKIE_DATA:.*\\<todo\\>" end t))))
  9976. (org-update-checkbox-count)
  9977. (if (and l2 (> l2 l1))
  9978. (progn
  9979. (goto-char end)
  9980. (org-update-parent-todo-statistics))
  9981. (goto-char pos)
  9982. (beginning-of-line 1)
  9983. (while (re-search-forward
  9984. "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
  9985. (point-at-eol) t)
  9986. (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
  9987. (goto-char pos)
  9988. (move-marker pos nil)))))
  9989. (defvar org-entry-property-inherited-from) ;; defined below
  9990. (defun org-update-parent-todo-statistics ()
  9991. "Update any statistics cookie in the parent of the current headline.
  9992. When `org-hierarchical-todo-statistics' is nil, statistics will cover
  9993. the entire subtree and this will travel up the hierarchy and update
  9994. statistics everywhere."
  9995. (interactive)
  9996. (let* ((lim 0) prop
  9997. (recursive (or (not org-hierarchical-todo-statistics)
  9998. (string-match
  9999. "\\<recursive\\>"
  10000. (or (setq prop (org-entry-get
  10001. nil "COOKIE_DATA" 'inherit)) ""))))
  10002. (lim (or (and prop (marker-position
  10003. org-entry-property-inherited-from))
  10004. lim))
  10005. (first t)
  10006. (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
  10007. level ltoggle l1 new ndel
  10008. (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
  10009. (catch 'exit
  10010. (save-excursion
  10011. (beginning-of-line 1)
  10012. (if (org-at-heading-p)
  10013. (setq ltoggle (funcall outline-level))
  10014. (error "This should not happen"))
  10015. (while (and (setq level (org-up-heading-safe))
  10016. (or recursive first)
  10017. (>= (point) lim))
  10018. (setq first nil cookie-present nil)
  10019. (unless (and level
  10020. (not (string-match
  10021. "\\<checkbox\\>"
  10022. (downcase
  10023. (or (org-entry-get
  10024. nil "COOKIE_DATA")
  10025. "")))))
  10026. (throw 'exit nil))
  10027. (while (re-search-forward box-re (point-at-eol) t)
  10028. (setq cnt-all 0 cnt-done 0 cookie-present t)
  10029. (setq is-percent (match-end 2))
  10030. (save-match-data
  10031. (unless (outline-next-heading) (throw 'exit nil))
  10032. (while (and (looking-at org-complex-heading-regexp)
  10033. (> (setq l1 (length (match-string 1))) level))
  10034. (setq kwd (and (or recursive (= l1 ltoggle))
  10035. (match-string 2)))
  10036. (if (or (eq org-provide-todo-statistics 'all-headlines)
  10037. (and (listp org-provide-todo-statistics)
  10038. (or (member kwd org-provide-todo-statistics)
  10039. (member kwd org-done-keywords))))
  10040. (setq cnt-all (1+ cnt-all))
  10041. (if (eq org-provide-todo-statistics t)
  10042. (and kwd (setq cnt-all (1+ cnt-all)))))
  10043. (and (member kwd org-done-keywords)
  10044. (setq cnt-done (1+ cnt-done)))
  10045. (outline-next-heading)))
  10046. (setq new
  10047. (if is-percent
  10048. (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
  10049. (format "[%d/%d]" cnt-done cnt-all))
  10050. ndel (- (match-end 0) (match-beginning 0)))
  10051. (goto-char (match-beginning 0))
  10052. (insert new)
  10053. (delete-region (point) (+ (point) ndel)))
  10054. (when cookie-present
  10055. (run-hook-with-args 'org-after-todo-statistics-hook
  10056. cnt-done (- cnt-all cnt-done))))))
  10057. (run-hooks 'org-todo-statistics-hook)))
  10058. (defvar org-after-todo-statistics-hook nil
  10059. "Hook that is called after a TODO statistics cookie has been updated.
  10060. Each function is called with two arguments: the number of not-done entries
  10061. and the number of done entries.
  10062. For example, the following function, when added to this hook, will switch
  10063. an entry to DONE when all children are done, and back to TODO when new
  10064. entries are set to a TODO status. Note that this hook is only called
  10065. when there is a statistics cookie in the headline!
  10066. (defun org-summary-todo (n-done n-not-done)
  10067. \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
  10068. (let (org-log-done org-log-states) ; turn off logging
  10069. (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
  10070. ")
  10071. (defvar org-todo-statistics-hook nil
  10072. "Hook that is run whenever Org thinks TODO statistics should be updated.
  10073. This hook runs even if there is no statistics cookie present, in which case
  10074. `org-after-todo-statistics-hook' would not run.")
  10075. (defun org-todo-trigger-tag-changes (state)
  10076. "Apply the changes defined in `org-todo-state-tags-triggers'."
  10077. (let ((l org-todo-state-tags-triggers)
  10078. changes)
  10079. (when (or (not state) (equal state ""))
  10080. (setq changes (append changes (cdr (assoc "" l)))))
  10081. (when (and (stringp state) (> (length state) 0))
  10082. (setq changes (append changes (cdr (assoc state l)))))
  10083. (when (member state org-not-done-keywords)
  10084. (setq changes (append changes (cdr (assoc 'todo l)))))
  10085. (when (member state org-done-keywords)
  10086. (setq changes (append changes (cdr (assoc 'done l)))))
  10087. (dolist (c changes)
  10088. (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
  10089. (defun org-local-logging (value)
  10090. "Get logging settings from a property VALUE."
  10091. (let* (words w a)
  10092. ;; directly set the variables, they are already local.
  10093. (setq org-log-done nil
  10094. org-log-repeat nil
  10095. org-todo-log-states nil)
  10096. (setq words (org-split-string value))
  10097. (while (setq w (pop words))
  10098. (cond
  10099. ((setq a (assoc w org-startup-options))
  10100. (and (member (nth 1 a) '(org-log-done org-log-repeat))
  10101. (set (nth 1 a) (nth 2 a))))
  10102. ((setq a (org-extract-log-state-settings w))
  10103. (and (member (car a) org-todo-keywords-1)
  10104. (push a org-todo-log-states)))))))
  10105. (defun org-get-todo-sequence-head (kwd)
  10106. "Return the head of the TODO sequence to which KWD belongs.
  10107. If KWD is not set, check if there is a text property remembering the
  10108. right sequence."
  10109. (let (p)
  10110. (cond
  10111. ((not kwd)
  10112. (or (get-text-property (point-at-bol) 'org-todo-head)
  10113. (progn
  10114. (setq p (next-single-property-change (point-at-bol) 'org-todo-head
  10115. nil (point-at-eol)))
  10116. (get-text-property p 'org-todo-head))))
  10117. ((not (member kwd org-todo-keywords-1))
  10118. (car org-todo-keywords-1))
  10119. (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
  10120. (defun org-fast-todo-selection ()
  10121. "Fast TODO keyword selection with single keys.
  10122. Returns the new TODO keyword, or nil if no state change should occur."
  10123. (let* ((fulltable org-todo-key-alist)
  10124. (done-keywords org-done-keywords) ;; needed for the faces.
  10125. (maxlen (apply 'max (mapcar
  10126. (lambda (x)
  10127. (if (stringp (car x)) (string-width (car x)) 0))
  10128. fulltable)))
  10129. (expert nil)
  10130. (fwidth (+ maxlen 3 1 3))
  10131. (ncol (/ (- (window-width) 4) fwidth))
  10132. tg cnt e c tbl
  10133. groups ingroup)
  10134. (save-excursion
  10135. (save-window-excursion
  10136. (if expert
  10137. (set-buffer (get-buffer-create " *Org todo*"))
  10138. (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
  10139. (erase-buffer)
  10140. (org-set-local 'org-done-keywords done-keywords)
  10141. (setq tbl fulltable cnt 0)
  10142. (while (setq e (pop tbl))
  10143. (cond
  10144. ((equal e '(:startgroup))
  10145. (push '() groups) (setq ingroup t)
  10146. (when (not (= cnt 0))
  10147. (setq cnt 0)
  10148. (insert "\n"))
  10149. (insert "{ "))
  10150. ((equal e '(:endgroup))
  10151. (setq ingroup nil cnt 0)
  10152. (insert "}\n"))
  10153. ((equal e '(:newline))
  10154. (when (not (= cnt 0))
  10155. (setq cnt 0)
  10156. (insert "\n")
  10157. (setq e (car tbl))
  10158. (while (equal (car tbl) '(:newline))
  10159. (insert "\n")
  10160. (setq tbl (cdr tbl)))))
  10161. (t
  10162. (setq tg (car e) c (cdr e))
  10163. (if ingroup (push tg (car groups)))
  10164. (setq tg (org-add-props tg nil 'face
  10165. (org-get-todo-face tg)))
  10166. (if (and (= cnt 0) (not ingroup)) (insert " "))
  10167. (insert "[" c "] " tg (make-string
  10168. (- fwidth 4 (length tg)) ?\ ))
  10169. (when (= (setq cnt (1+ cnt)) ncol)
  10170. (insert "\n")
  10171. (if ingroup (insert " "))
  10172. (setq cnt 0)))))
  10173. (insert "\n")
  10174. (goto-char (point-min))
  10175. (if (not expert) (org-fit-window-to-buffer))
  10176. (message "[a-z..]:Set [SPC]:clear")
  10177. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  10178. (cond
  10179. ((or (= c ?\C-g)
  10180. (and (= c ?q) (not (rassoc c fulltable))))
  10181. (setq quit-flag t))
  10182. ((= c ?\ ) nil)
  10183. ((setq e (rassoc c fulltable) tg (car e))
  10184. tg)
  10185. (t (setq quit-flag t)))))))
  10186. (defun org-entry-is-todo-p ()
  10187. (member (org-get-todo-state) org-not-done-keywords))
  10188. (defun org-entry-is-done-p ()
  10189. (member (org-get-todo-state) org-done-keywords))
  10190. (defun org-get-todo-state ()
  10191. (save-excursion
  10192. (org-back-to-heading t)
  10193. (and (looking-at org-todo-line-regexp)
  10194. (match-end 2)
  10195. (match-string 2))))
  10196. (defun org-at-date-range-p (&optional inactive-ok)
  10197. "Is the cursor inside a date range?"
  10198. (interactive)
  10199. (save-excursion
  10200. (catch 'exit
  10201. (let ((pos (point)))
  10202. (skip-chars-backward "^[<\r\n")
  10203. (skip-chars-backward "<[")
  10204. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  10205. (>= (match-end 0) pos)
  10206. (throw 'exit t))
  10207. (skip-chars-backward "^<[\r\n")
  10208. (skip-chars-backward "<[")
  10209. (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
  10210. (>= (match-end 0) pos)
  10211. (throw 'exit t)))
  10212. nil)))
  10213. (defun org-get-repeat (&optional tagline)
  10214. "Check if there is a deadline/schedule with repeater in this entry."
  10215. (save-match-data
  10216. (save-excursion
  10217. (org-back-to-heading t)
  10218. (and (re-search-forward (if tagline
  10219. (concat tagline "\\s-*" org-repeat-re)
  10220. org-repeat-re)
  10221. (org-entry-end-position) t)
  10222. (match-string-no-properties 1)))))
  10223. (defvar org-last-changed-timestamp)
  10224. (defvar org-last-inserted-timestamp)
  10225. (defvar org-log-post-message)
  10226. (defvar org-log-note-purpose)
  10227. (defvar org-log-note-how)
  10228. (defvar org-log-note-extra)
  10229. (defun org-auto-repeat-maybe (done-word)
  10230. "Check if the current headline contains a repeated deadline/schedule.
  10231. If yes, set TODO state back to what it was and change the base date
  10232. of repeating deadline/scheduled time stamps to new date.
  10233. This function is run automatically after each state change to a DONE state."
  10234. ;; last-state is dynamically scoped into this function
  10235. (let* ((repeat (org-get-repeat))
  10236. (aa (assoc last-state org-todo-kwd-alist))
  10237. (interpret (nth 1 aa))
  10238. (head (nth 2 aa))
  10239. (whata '(("d" . day) ("m" . month) ("y" . year)))
  10240. (msg "Entry repeats: ")
  10241. (org-log-done nil)
  10242. (org-todo-log-states nil)
  10243. (nshiftmax 10) (nshift 0)
  10244. re type n what ts time to-state)
  10245. (when repeat
  10246. (if (eq org-log-repeat t) (setq org-log-repeat 'state))
  10247. (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
  10248. org-todo-repeat-to-state))
  10249. (unless (and to-state (member to-state org-todo-keywords-1))
  10250. (setq to-state (if (eq interpret 'type) last-state head)))
  10251. (org-todo to-state)
  10252. (when (or org-log-repeat (org-entry-get nil "CLOCK"))
  10253. (org-entry-put nil "LAST_REPEAT" (format-time-string
  10254. (org-time-stamp-format t t))))
  10255. (when org-log-repeat
  10256. (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
  10257. (memq 'org-add-log-note post-command-hook))
  10258. ;; OK, we are already setup for some record
  10259. (if (eq org-log-repeat 'note)
  10260. ;; make sure we take a note, not only a time stamp
  10261. (setq org-log-note-how 'note))
  10262. ;; Set up for taking a record
  10263. (org-add-log-setup 'state (or done-word (car org-done-keywords))
  10264. last-state
  10265. 'findpos org-log-repeat)))
  10266. (org-back-to-heading t)
  10267. (org-add-planning-info nil nil 'closed)
  10268. (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
  10269. org-deadline-time-regexp "\\)\\|\\("
  10270. org-ts-regexp "\\)"))
  10271. (while (re-search-forward
  10272. re (save-excursion (outline-next-heading) (point)) t)
  10273. (setq type (if (match-end 1) org-scheduled-string
  10274. (if (match-end 3) org-deadline-string "Plain:"))
  10275. ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
  10276. (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([dwmy]\\)" ts)
  10277. (setq n (string-to-number (match-string 2 ts))
  10278. what (match-string 3 ts))
  10279. (if (equal what "w") (setq n (* n 7) what "d"))
  10280. ;; Preparation, see if we need to modify the start date for the change
  10281. (when (match-end 1)
  10282. (setq time (save-match-data (org-time-string-to-time ts)))
  10283. (cond
  10284. ((equal (match-string 1 ts) ".")
  10285. ;; Shift starting date to today
  10286. (org-timestamp-change
  10287. (- (time-to-days (current-time)) (time-to-days time))
  10288. 'day))
  10289. ((equal (match-string 1 ts) "+")
  10290. (while (or (= nshift 0)
  10291. (<= (time-to-days time) (time-to-days (current-time))))
  10292. (when (= (incf nshift) nshiftmax)
  10293. (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
  10294. (error "Abort")))
  10295. (org-timestamp-change n (cdr (assoc what whata)))
  10296. (org-at-timestamp-p t)
  10297. (setq ts (match-string 1))
  10298. (setq time (save-match-data (org-time-string-to-time ts))))
  10299. (org-timestamp-change (- n) (cdr (assoc what whata)))
  10300. ;; rematch, so that we have everything in place for the real shift
  10301. (org-at-timestamp-p t)
  10302. (setq ts (match-string 1))
  10303. (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([dwmy]\\)" ts))))
  10304. (org-timestamp-change n (cdr (assoc what whata)))
  10305. (setq msg (concat msg type " " org-last-changed-timestamp " "))))
  10306. (setq org-log-post-message msg)
  10307. (message "%s" msg))))
  10308. (defun org-show-todo-tree (arg)
  10309. "Make a compact tree which shows all headlines marked with TODO.
  10310. The tree will show the lines where the regexp matches, and all higher
  10311. headlines above the match.
  10312. With a \\[universal-argument] prefix, prompt for a regexp to match.
  10313. With a numeric prefix N, construct a sparse tree for the Nth element
  10314. of `org-todo-keywords-1'."
  10315. (interactive "P")
  10316. (let ((case-fold-search nil)
  10317. (kwd-re
  10318. (cond ((null arg) org-not-done-regexp)
  10319. ((equal arg '(4))
  10320. (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
  10321. (mapcar 'list org-todo-keywords-1))))
  10322. (concat "\\("
  10323. (mapconcat 'identity (org-split-string kwd "|") "\\|")
  10324. "\\)\\>")))
  10325. ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
  10326. (regexp-quote (nth (1- (prefix-numeric-value arg))
  10327. org-todo-keywords-1)))
  10328. (t (error "Invalid prefix argument: %s" arg)))))
  10329. (message "%d TODO entries found"
  10330. (org-occur (concat "^" outline-regexp " *" kwd-re )))))
  10331. (defun org-deadline (&optional remove time)
  10332. "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
  10333. With argument REMOVE, remove any deadline from the item.
  10334. When TIME is set, it should be an internal time specification, and the
  10335. scheduling will use the corresponding date."
  10336. (interactive "P")
  10337. (let* ((old-date (org-entry-get nil "DEADLINE"))
  10338. (repeater (and old-date
  10339. (string-match "\\([.+]+[0-9]+[dwmy]\\) ?" old-date)
  10340. (match-string 1 old-date))))
  10341. (if remove
  10342. (progn
  10343. (when (and old-date org-log-redeadline)
  10344. (org-add-log-setup 'deldeadline nil old-date 'findpos
  10345. org-log-redeadline))
  10346. (org-remove-timestamp-with-keyword org-deadline-string)
  10347. (message "Item no longer has a deadline."))
  10348. (org-add-planning-info 'deadline time 'closed)
  10349. (when (and old-date org-log-redeadline
  10350. (not (equal old-date
  10351. (substring org-last-inserted-timestamp 1 -1))))
  10352. (org-add-log-setup 'redeadline nil old-date 'findpos
  10353. org-log-redeadline))
  10354. (when repeater
  10355. (save-excursion
  10356. (org-back-to-heading t)
  10357. (when (re-search-forward (concat org-deadline-string " "
  10358. org-last-inserted-timestamp)
  10359. (save-excursion
  10360. (outline-next-heading) (point)) t)
  10361. (goto-char (1- (match-end 0)))
  10362. (insert " " repeater)
  10363. (setq org-last-inserted-timestamp
  10364. (concat (substring org-last-inserted-timestamp 0 -1)
  10365. " " repeater
  10366. (substring org-last-inserted-timestamp -1))))))
  10367. (message "Deadline on %s" org-last-inserted-timestamp))))
  10368. (defun org-schedule (&optional remove time)
  10369. "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
  10370. With argument REMOVE, remove any scheduling date from the item.
  10371. When TIME is set, it should be an internal time specification, and the
  10372. scheduling will use the corresponding date."
  10373. (interactive "P")
  10374. (let* ((old-date (org-entry-get nil "SCHEDULED"))
  10375. (repeater (and old-date
  10376. (string-match "\\([.+]+[0-9]+[dwmy]\\) ?" old-date)
  10377. (match-string 1 old-date))))
  10378. (if remove
  10379. (progn
  10380. (when (and old-date org-log-reschedule)
  10381. (org-add-log-setup 'delschedule nil old-date 'findpos
  10382. org-log-reschedule))
  10383. (org-remove-timestamp-with-keyword org-scheduled-string)
  10384. (message "Item is no longer scheduled."))
  10385. (org-add-planning-info 'scheduled time 'closed)
  10386. (when (and old-date org-log-reschedule
  10387. (not (equal old-date
  10388. (substring org-last-inserted-timestamp 1 -1))))
  10389. (org-add-log-setup 'reschedule nil old-date 'findpos
  10390. org-log-reschedule))
  10391. (when repeater
  10392. (save-excursion
  10393. (org-back-to-heading t)
  10394. (when (re-search-forward (concat org-scheduled-string " "
  10395. org-last-inserted-timestamp)
  10396. (save-excursion
  10397. (outline-next-heading) (point)) t)
  10398. (goto-char (1- (match-end 0)))
  10399. (insert " " repeater)
  10400. (setq org-last-inserted-timestamp
  10401. (concat (substring org-last-inserted-timestamp 0 -1)
  10402. " " repeater
  10403. (substring org-last-inserted-timestamp -1))))))
  10404. (message "Scheduled to %s" org-last-inserted-timestamp))))
  10405. (defun org-get-scheduled-time (pom &optional inherit)
  10406. "Get the scheduled time as a time tuple, of a format suitable
  10407. for calling org-schedule with, or if there is no scheduling,
  10408. returns nil."
  10409. (let ((time (org-entry-get pom "SCHEDULED" inherit)))
  10410. (when time
  10411. (apply 'encode-time (org-parse-time-string time)))))
  10412. (defun org-get-deadline-time (pom &optional inherit)
  10413. "Get the deadine as a time tuple, of a format suitable for
  10414. calling org-deadline with, or if there is no scheduling, returns
  10415. nil."
  10416. (let ((time (org-entry-get pom "DEADLINE" inherit)))
  10417. (when time
  10418. (apply 'encode-time (org-parse-time-string time)))))
  10419. (defun org-remove-timestamp-with-keyword (keyword)
  10420. "Remove all time stamps with KEYWORD in the current entry."
  10421. (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
  10422. beg)
  10423. (save-excursion
  10424. (org-back-to-heading t)
  10425. (setq beg (point))
  10426. (outline-next-heading)
  10427. (while (re-search-backward re beg t)
  10428. (replace-match "")
  10429. (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
  10430. (equal (char-before) ?\ ))
  10431. (backward-delete-char 1)
  10432. (if (string-match "^[ \t]*$" (buffer-substring
  10433. (point-at-bol) (point-at-eol)))
  10434. (delete-region (point-at-bol)
  10435. (min (point-max) (1+ (point-at-eol))))))))))
  10436. (defun org-add-planning-info (what &optional time &rest remove)
  10437. "Insert new timestamp with keyword in the line directly after the headline.
  10438. WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
  10439. If non is given, the user is prompted for a date.
  10440. REMOVE indicates what kind of entries to remove. An old WHAT entry will also
  10441. be removed."
  10442. (interactive)
  10443. (let (org-time-was-given org-end-time-was-given ts
  10444. end default-time default-input)
  10445. (catch 'exit
  10446. (when (and (not time) (memq what '(scheduled deadline)))
  10447. ;; Try to get a default date/time from existing timestamp
  10448. (save-excursion
  10449. (org-back-to-heading t)
  10450. (setq end (save-excursion (outline-next-heading) (point)))
  10451. (when (re-search-forward (if (eq what 'scheduled)
  10452. org-scheduled-time-regexp
  10453. org-deadline-time-regexp)
  10454. end t)
  10455. (setq ts (match-string 1)
  10456. default-time
  10457. (apply 'encode-time (org-parse-time-string ts))
  10458. default-input (and ts (org-get-compact-tod ts))))))
  10459. (when what
  10460. ;; If necessary, get the time from the user
  10461. (setq time (or time (org-read-date nil 'to-time nil nil
  10462. default-time default-input))))
  10463. (when (and org-insert-labeled-timestamps-at-point
  10464. (member what '(scheduled deadline)))
  10465. (insert
  10466. (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
  10467. (org-insert-time-stamp time org-time-was-given
  10468. nil nil nil (list org-end-time-was-given))
  10469. (setq what nil))
  10470. (save-excursion
  10471. (save-restriction
  10472. (let (col list elt ts buffer-invisibility-spec)
  10473. (org-back-to-heading t)
  10474. (looking-at (concat outline-regexp "\\( *\\)[^\r\n]*"))
  10475. (goto-char (match-end 1))
  10476. (setq col (current-column))
  10477. (goto-char (match-end 0))
  10478. (if (eobp) (insert "\n") (forward-char 1))
  10479. (when (and (not what)
  10480. (not (looking-at
  10481. (concat "[ \t]*"
  10482. org-keyword-time-not-clock-regexp))))
  10483. ;; Nothing to add, nothing to remove...... :-)
  10484. (throw 'exit nil))
  10485. (if (and (not (looking-at outline-regexp))
  10486. (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
  10487. "[^\r\n]*"))
  10488. (not (equal (match-string 1) org-clock-string)))
  10489. (narrow-to-region (match-beginning 0) (match-end 0))
  10490. (insert-before-markers "\n")
  10491. (backward-char 1)
  10492. (narrow-to-region (point) (point))
  10493. (and org-adapt-indentation (org-indent-to-column col)))
  10494. ;; Check if we have to remove something.
  10495. (setq list (cons what remove))
  10496. (while list
  10497. (setq elt (pop list))
  10498. (goto-char (point-min))
  10499. (when (or (and (eq elt 'scheduled)
  10500. (re-search-forward org-scheduled-time-regexp nil t))
  10501. (and (eq elt 'deadline)
  10502. (re-search-forward org-deadline-time-regexp nil t))
  10503. (and (eq elt 'closed)
  10504. (re-search-forward org-closed-time-regexp nil t)))
  10505. (replace-match "")
  10506. (if (looking-at "--+<[^>]+>") (replace-match ""))
  10507. (skip-chars-backward " ")
  10508. (if (looking-at " +") (replace-match ""))))
  10509. (goto-char (point-max))
  10510. (and org-adapt-indentation (bolp) (org-indent-to-column col))
  10511. (when what
  10512. (insert
  10513. (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
  10514. (cond ((eq what 'scheduled) org-scheduled-string)
  10515. ((eq what 'deadline) org-deadline-string)
  10516. ((eq what 'closed) org-closed-string))
  10517. " ")
  10518. (setq ts (org-insert-time-stamp
  10519. time
  10520. (or org-time-was-given
  10521. (and (eq what 'closed) org-log-done-with-time))
  10522. (eq what 'closed)
  10523. nil nil (list org-end-time-was-given)))
  10524. (end-of-line 1))
  10525. (goto-char (point-min))
  10526. (widen)
  10527. (if (and (looking-at "[ \t]*\n")
  10528. (equal (char-before) ?\n))
  10529. (delete-region (1- (point)) (point-at-eol)))
  10530. ts))))))
  10531. (defvar org-log-note-marker (make-marker))
  10532. (defvar org-log-note-purpose nil)
  10533. (defvar org-log-note-state nil)
  10534. (defvar org-log-note-previous-state nil)
  10535. (defvar org-log-note-how nil)
  10536. (defvar org-log-note-extra nil)
  10537. (defvar org-log-note-window-configuration nil)
  10538. (defvar org-log-note-return-to (make-marker))
  10539. (defvar org-log-post-message nil
  10540. "Message to be displayed after a log note has been stored.
  10541. The auto-repeater uses this.")
  10542. (defun org-add-note ()
  10543. "Add a note to the current entry.
  10544. This is done in the same way as adding a state change note."
  10545. (interactive)
  10546. (org-add-log-setup 'note nil nil 'findpos nil))
  10547. (defvar org-property-end-re)
  10548. (defun org-add-log-setup (&optional purpose state prev-state
  10549. findpos how &optional extra)
  10550. "Set up the post command hook to take a note.
  10551. If this is about to TODO state change, the new state is expected in STATE.
  10552. When FINDPOS is non-nil, find the correct position for the note in
  10553. the current entry. If not, assume that it can be inserted at point.
  10554. HOW is an indicator what kind of note should be created.
  10555. EXTRA is additional text that will be inserted into the notes buffer."
  10556. (let* ((org-log-into-drawer (org-log-into-drawer))
  10557. (drawer (cond ((stringp org-log-into-drawer)
  10558. org-log-into-drawer)
  10559. (org-log-into-drawer "LOGBOOK")
  10560. (t nil))))
  10561. (save-restriction
  10562. (save-excursion
  10563. (when findpos
  10564. (org-back-to-heading t)
  10565. (narrow-to-region (point) (save-excursion
  10566. (outline-next-heading) (point)))
  10567. (looking-at (concat outline-regexp "\\( *\\)[^\r\n]*"
  10568. "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
  10569. "[^\r\n]*\\)?"))
  10570. (goto-char (match-end 0))
  10571. (cond
  10572. (drawer
  10573. (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
  10574. nil t)
  10575. (progn
  10576. (goto-char (match-end 0))
  10577. (or org-log-states-order-reversed
  10578. (and (re-search-forward org-property-end-re nil t)
  10579. (goto-char (1- (match-beginning 0))))))
  10580. (insert "\n:" drawer ":\n:END:")
  10581. (beginning-of-line 0)
  10582. (org-indent-line-function)
  10583. (beginning-of-line 2)
  10584. (org-indent-line-function)
  10585. (end-of-line 0)))
  10586. ((and org-log-state-notes-insert-after-drawers
  10587. (save-excursion
  10588. (forward-line) (looking-at org-drawer-regexp)))
  10589. (forward-line)
  10590. (while (looking-at org-drawer-regexp)
  10591. (goto-char (match-end 0))
  10592. (re-search-forward org-property-end-re (point-max) t)
  10593. (forward-line))
  10594. (forward-line -1)))
  10595. (unless org-log-states-order-reversed
  10596. (and (= (char-after) ?\n) (forward-char 1))
  10597. (org-skip-over-state-notes)
  10598. (skip-chars-backward " \t\n\r")))
  10599. (move-marker org-log-note-marker (point))
  10600. (setq org-log-note-purpose purpose
  10601. org-log-note-state state
  10602. org-log-note-previous-state prev-state
  10603. org-log-note-how how
  10604. org-log-note-extra extra)
  10605. (add-hook 'post-command-hook 'org-add-log-note 'append)))))
  10606. (defun org-skip-over-state-notes ()
  10607. "Skip past the list of State notes in an entry."
  10608. (if (looking-at "\n[ \t]*- State") (forward-char 1))
  10609. (while (looking-at "[ \t]*- State")
  10610. (condition-case nil
  10611. (org-next-item)
  10612. (error (org-end-of-item)))))
  10613. (defun org-add-log-note (&optional purpose)
  10614. "Pop up a window for taking a note, and add this note later at point."
  10615. (remove-hook 'post-command-hook 'org-add-log-note)
  10616. (setq org-log-note-window-configuration (current-window-configuration))
  10617. (delete-other-windows)
  10618. (move-marker org-log-note-return-to (point))
  10619. (switch-to-buffer (marker-buffer org-log-note-marker))
  10620. (goto-char org-log-note-marker)
  10621. (org-switch-to-buffer-other-window "*Org Note*")
  10622. (erase-buffer)
  10623. (if (memq org-log-note-how '(time state))
  10624. (let (current-prefix-arg) (org-store-log-note))
  10625. (let ((org-inhibit-startup t)) (org-mode))
  10626. (insert (format "# Insert note for %s.
  10627. # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
  10628. (cond
  10629. ((eq org-log-note-purpose 'clock-out) "stopped clock")
  10630. ((eq org-log-note-purpose 'done) "closed todo item")
  10631. ((eq org-log-note-purpose 'state)
  10632. (format "state change from \"%s\" to \"%s\""
  10633. (or org-log-note-previous-state "")
  10634. (or org-log-note-state "")))
  10635. ((eq org-log-note-purpose 'reschedule)
  10636. "rescheduling")
  10637. ((eq org-log-note-purpose 'delschedule)
  10638. "no longer scheduled")
  10639. ((eq org-log-note-purpose 'redeadline)
  10640. "changing deadline")
  10641. ((eq org-log-note-purpose 'deldeadline)
  10642. "removing deadline")
  10643. ((eq org-log-note-purpose 'refile)
  10644. "refiling")
  10645. ((eq org-log-note-purpose 'note)
  10646. "this entry")
  10647. (t (error "This should not happen")))))
  10648. (if org-log-note-extra (insert org-log-note-extra))
  10649. (org-set-local 'org-finish-function 'org-store-log-note)))
  10650. (defvar org-note-abort nil) ; dynamically scoped
  10651. (defun org-store-log-note ()
  10652. "Finish taking a log note, and insert it to where it belongs."
  10653. (let ((txt (buffer-string))
  10654. (note (cdr (assq org-log-note-purpose org-log-note-headings)))
  10655. lines ind)
  10656. (kill-buffer (current-buffer))
  10657. (while (string-match "\\`#.*\n[ \t\n]*" txt)
  10658. (setq txt (replace-match "" t t txt)))
  10659. (if (string-match "\\s-+\\'" txt)
  10660. (setq txt (replace-match "" t t txt)))
  10661. (setq lines (org-split-string txt "\n"))
  10662. (when (and note (string-match "\\S-" note))
  10663. (setq note
  10664. (org-replace-escapes
  10665. note
  10666. (list (cons "%u" (user-login-name))
  10667. (cons "%U" user-full-name)
  10668. (cons "%t" (format-time-string
  10669. (org-time-stamp-format 'long 'inactive)
  10670. (current-time)))
  10671. (cons "%T" (format-time-string
  10672. (org-time-stamp-format 'long nil)
  10673. (current-time)))
  10674. (cons "%s" (if org-log-note-state
  10675. (concat "\"" org-log-note-state "\"")
  10676. ""))
  10677. (cons "%S" (if org-log-note-previous-state
  10678. (concat "\"" org-log-note-previous-state "\"")
  10679. "\"\"")))))
  10680. (if lines (setq note (concat note " \\\\")))
  10681. (push note lines))
  10682. (when (or current-prefix-arg org-note-abort)
  10683. (when org-log-into-drawer
  10684. (org-remove-empty-drawer-at
  10685. (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
  10686. org-log-note-marker))
  10687. (setq lines nil))
  10688. (when lines
  10689. (with-current-buffer (marker-buffer org-log-note-marker)
  10690. (save-excursion
  10691. (goto-char org-log-note-marker)
  10692. (move-marker org-log-note-marker nil)
  10693. (end-of-line 1)
  10694. (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
  10695. (insert "- " (pop lines))
  10696. (org-indent-line-function)
  10697. (beginning-of-line 1)
  10698. (looking-at "[ \t]*")
  10699. (setq ind (concat (match-string 0) " "))
  10700. (end-of-line 1)
  10701. (while lines (insert "\n" ind (pop lines)))
  10702. (message "Note stored")
  10703. (org-back-to-heading t)
  10704. (org-cycle-hide-drawers 'children)))))
  10705. (set-window-configuration org-log-note-window-configuration)
  10706. (with-current-buffer (marker-buffer org-log-note-return-to)
  10707. (goto-char org-log-note-return-to))
  10708. (move-marker org-log-note-return-to nil)
  10709. (and org-log-post-message (message "%s" org-log-post-message)))
  10710. (defun org-remove-empty-drawer-at (drawer pos)
  10711. "Remove an empty drawer DRAWER at position POS.
  10712. POS may also be a marker."
  10713. (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
  10714. (save-excursion
  10715. (save-restriction
  10716. (widen)
  10717. (goto-char pos)
  10718. (if (org-in-regexp
  10719. (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
  10720. (replace-match ""))))))
  10721. (defun org-sparse-tree (&optional arg)
  10722. "Create a sparse tree, prompt for the details.
  10723. This command can create sparse trees. You first need to select the type
  10724. of match used to create the tree:
  10725. t Show all TODO entries.
  10726. T Show entries with a specific TODO keyword.
  10727. m Show entries selected by a tags/property match.
  10728. p Enter a property name and its value (both with completion on existing
  10729. names/values) and show entries with that property.
  10730. / Show entries matching a regular expression (`r' can be used as well)
  10731. d Show deadlines due within `org-deadline-warning-days'.
  10732. b Show deadlines and scheduled items before a date.
  10733. a Show deadlines and scheduled items after a date."
  10734. (interactive "P")
  10735. (let (ans kwd value)
  10736. (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty [d]eadlines\n [b]efore-date [a]fter-date")
  10737. (setq ans (read-char-exclusive))
  10738. (cond
  10739. ((equal ans ?d)
  10740. (call-interactively 'org-check-deadlines))
  10741. ((equal ans ?b)
  10742. (call-interactively 'org-check-before-date))
  10743. ((equal ans ?a)
  10744. (call-interactively 'org-check-after-date))
  10745. ((equal ans ?t)
  10746. (org-show-todo-tree nil))
  10747. ((equal ans ?T)
  10748. (org-show-todo-tree '(4)))
  10749. ((member ans '(?T ?m))
  10750. (call-interactively 'org-match-sparse-tree))
  10751. ((member ans '(?p ?P))
  10752. (setq kwd (org-icompleting-read "Property: "
  10753. (mapcar 'list (org-buffer-property-keys))))
  10754. (setq value (org-icompleting-read "Value: "
  10755. (mapcar 'list (org-property-values kwd))))
  10756. (unless (string-match "\\`{.*}\\'" value)
  10757. (setq value (concat "\"" value "\"")))
  10758. (org-match-sparse-tree arg (concat kwd "=" value)))
  10759. ((member ans '(?r ?R ?/))
  10760. (call-interactively 'org-occur))
  10761. (t (error "No such sparse tree command \"%c\"" ans)))))
  10762. (defvar org-occur-highlights nil
  10763. "List of overlays used for occur matches.")
  10764. (make-variable-buffer-local 'org-occur-highlights)
  10765. (defvar org-occur-parameters nil
  10766. "Parameters of the active org-occur calls.
  10767. This is a list, each call to org-occur pushes as cons cell,
  10768. containing the regular expression and the callback, onto the list.
  10769. The list can contain several entries if `org-occur' has been called
  10770. several time with the KEEP-PREVIOUS argument. Otherwise, this list
  10771. will only contain one set of parameters. When the highlights are
  10772. removed (for example with `C-c C-c', or with the next edit (depending
  10773. on `org-remove-highlights-with-change'), this variable is emptied
  10774. as well.")
  10775. (make-variable-buffer-local 'org-occur-parameters)
  10776. (defun org-occur (regexp &optional keep-previous callback)
  10777. "Make a compact tree which shows all matches of REGEXP.
  10778. The tree will show the lines where the regexp matches, and all higher
  10779. headlines above the match. It will also show the heading after the match,
  10780. to make sure editing the matching entry is easy.
  10781. If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
  10782. call to `org-occur' will be kept, to allow stacking of calls to this
  10783. command.
  10784. If CALLBACK is non-nil, it is a function which is called to confirm
  10785. that the match should indeed be shown."
  10786. (interactive "sRegexp: \nP")
  10787. (when (equal regexp "")
  10788. (error "Regexp cannot be empty"))
  10789. (unless keep-previous
  10790. (org-remove-occur-highlights nil nil t))
  10791. (push (cons regexp callback) org-occur-parameters)
  10792. (let ((cnt 0))
  10793. (save-excursion
  10794. (goto-char (point-min))
  10795. (if (or (not keep-previous) ; do not want to keep
  10796. (not org-occur-highlights)) ; no previous matches
  10797. ;; hide everything
  10798. (org-overview))
  10799. (while (re-search-forward regexp nil t)
  10800. (when (or (not callback)
  10801. (save-match-data (funcall callback)))
  10802. (setq cnt (1+ cnt))
  10803. (when org-highlight-sparse-tree-matches
  10804. (org-highlight-new-match (match-beginning 0) (match-end 0)))
  10805. (org-show-context 'occur-tree))))
  10806. (when org-remove-highlights-with-change
  10807. (org-add-hook 'before-change-functions 'org-remove-occur-highlights
  10808. nil 'local))
  10809. (unless org-sparse-tree-open-archived-trees
  10810. (org-hide-archived-subtrees (point-min) (point-max)))
  10811. (run-hooks 'org-occur-hook)
  10812. (if (interactive-p)
  10813. (message "%d match(es) for regexp %s" cnt regexp))
  10814. cnt))
  10815. (defun org-show-context (&optional key)
  10816. "Make sure point and context are visible.
  10817. How much context is shown depends upon the variables
  10818. `org-show-hierarchy-above', `org-show-following-heading'. and
  10819. `org-show-siblings'."
  10820. (let ((heading-p (org-on-heading-p t))
  10821. (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
  10822. (following-p (org-get-alist-option org-show-following-heading key))
  10823. (entry-p (org-get-alist-option org-show-entry-below key))
  10824. (siblings-p (org-get-alist-option org-show-siblings key)))
  10825. (catch 'exit
  10826. ;; Show heading or entry text
  10827. (if (and heading-p (not entry-p))
  10828. (org-flag-heading nil) ; only show the heading
  10829. (and (or entry-p (org-invisible-p) (org-invisible-p2))
  10830. (org-show-hidden-entry))) ; show entire entry
  10831. (when following-p
  10832. ;; Show next sibling, or heading below text
  10833. (save-excursion
  10834. (and (if heading-p (org-goto-sibling) (outline-next-heading))
  10835. (org-flag-heading nil))))
  10836. (when siblings-p (org-show-siblings))
  10837. (when hierarchy-p
  10838. ;; show all higher headings, possibly with siblings
  10839. (save-excursion
  10840. (while (and (condition-case nil
  10841. (progn (org-up-heading-all 1) t)
  10842. (error nil))
  10843. (not (bobp)))
  10844. (org-flag-heading nil)
  10845. (when siblings-p (org-show-siblings))))))))
  10846. (defvar org-reveal-start-hook nil
  10847. "Hook run before revealing a location.")
  10848. (defun org-reveal (&optional siblings)
  10849. "Show current entry, hierarchy above it, and the following headline.
  10850. This can be used to show a consistent set of context around locations
  10851. exposed with `org-show-hierarchy-above' or `org-show-following-heading'
  10852. not t for the search context.
  10853. With optional argument SIBLINGS, on each level of the hierarchy all
  10854. siblings are shown. This repairs the tree structure to what it would
  10855. look like when opened with hierarchical calls to `org-cycle'.
  10856. With double optional argument `C-u C-u', go to the parent and show the
  10857. entire tree."
  10858. (interactive "P")
  10859. (run-hooks 'org-reveal-start-hook)
  10860. (let ((org-show-hierarchy-above t)
  10861. (org-show-following-heading t)
  10862. (org-show-siblings (if siblings t org-show-siblings)))
  10863. (org-show-context nil))
  10864. (when (equal siblings '(16))
  10865. (save-excursion
  10866. (when (org-up-heading-safe)
  10867. (org-show-subtree)
  10868. (run-hook-with-args 'org-cycle-hook 'subtree)))))
  10869. (defun org-highlight-new-match (beg end)
  10870. "Highlight from BEG to END and mark the highlight is an occur headline."
  10871. (let ((ov (make-overlay beg end)))
  10872. (overlay-put ov 'face 'secondary-selection)
  10873. (push ov org-occur-highlights)))
  10874. (defun org-remove-occur-highlights (&optional beg end noremove)
  10875. "Remove the occur highlights from the buffer.
  10876. BEG and END are ignored. If NOREMOVE is nil, remove this function
  10877. from the `before-change-functions' in the current buffer."
  10878. (interactive)
  10879. (unless org-inhibit-highlight-removal
  10880. (mapc 'delete-overlay org-occur-highlights)
  10881. (setq org-occur-highlights nil)
  10882. (setq org-occur-parameters nil)
  10883. (unless noremove
  10884. (remove-hook 'before-change-functions
  10885. 'org-remove-occur-highlights 'local))))
  10886. ;;;; Priorities
  10887. (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
  10888. "Regular expression matching the priority indicator.")
  10889. (defvar org-remove-priority-next-time nil)
  10890. (defun org-priority-up ()
  10891. "Increase the priority of the current item."
  10892. (interactive)
  10893. (org-priority 'up))
  10894. (defun org-priority-down ()
  10895. "Decrease the priority of the current item."
  10896. (interactive)
  10897. (org-priority 'down))
  10898. (defun org-priority (&optional action)
  10899. "Change the priority of an item by ARG.
  10900. ACTION can be `set', `up', `down', or a character."
  10901. (interactive)
  10902. (unless org-enable-priority-commands
  10903. (error "Priority commands are disabled"))
  10904. (setq action (or action 'set))
  10905. (let (current new news have remove)
  10906. (save-excursion
  10907. (org-back-to-heading t)
  10908. (if (looking-at org-priority-regexp)
  10909. (setq current (string-to-char (match-string 2))
  10910. have t)
  10911. (setq current org-default-priority))
  10912. (cond
  10913. ((eq action 'remove)
  10914. (setq remove t new ?\ ))
  10915. ((or (eq action 'set)
  10916. (if (featurep 'xemacs) (characterp action) (integerp action)))
  10917. (if (not (eq action 'set))
  10918. (setq new action)
  10919. (message "Priority %c-%c, SPC to remove: "
  10920. org-highest-priority org-lowest-priority)
  10921. (setq new (read-char-exclusive)))
  10922. (if (and (= (upcase org-highest-priority) org-highest-priority)
  10923. (= (upcase org-lowest-priority) org-lowest-priority))
  10924. (setq new (upcase new)))
  10925. (cond ((equal new ?\ ) (setq remove t))
  10926. ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
  10927. (error "Priority must be between `%c' and `%c'"
  10928. org-highest-priority org-lowest-priority))))
  10929. ((eq action 'up)
  10930. (if (and (not have) (eq last-command this-command))
  10931. (setq new org-lowest-priority)
  10932. (setq new (if (and org-priority-start-cycle-with-default (not have))
  10933. org-default-priority (1- current)))))
  10934. ((eq action 'down)
  10935. (if (and (not have) (eq last-command this-command))
  10936. (setq new org-highest-priority)
  10937. (setq new (if (and org-priority-start-cycle-with-default (not have))
  10938. org-default-priority (1+ current)))))
  10939. (t (error "Invalid action")))
  10940. (if (or (< (upcase new) org-highest-priority)
  10941. (> (upcase new) org-lowest-priority))
  10942. (setq remove t))
  10943. (setq news (format "%c" new))
  10944. (if have
  10945. (if remove
  10946. (replace-match "" t t nil 1)
  10947. (replace-match news t t nil 2))
  10948. (if remove
  10949. (error "No priority cookie found in line")
  10950. (let ((case-fold-search nil))
  10951. (looking-at org-todo-line-regexp))
  10952. (if (match-end 2)
  10953. (progn
  10954. (goto-char (match-end 2))
  10955. (insert " [#" news "]"))
  10956. (goto-char (match-beginning 3))
  10957. (insert "[#" news "] "))))
  10958. (org-preserve-lc (org-set-tags nil 'align)))
  10959. (if remove
  10960. (message "Priority removed")
  10961. (message "Priority of current item set to %s" news))))
  10962. (defun org-get-priority (s)
  10963. "Find priority cookie and return priority."
  10964. (save-match-data
  10965. (if (not (string-match org-priority-regexp s))
  10966. (* 1000 (- org-lowest-priority org-default-priority))
  10967. (* 1000 (- org-lowest-priority
  10968. (string-to-char (match-string 2 s)))))))
  10969. ;;;; Tags
  10970. (defvar org-agenda-archives-mode)
  10971. (defvar org-map-continue-from nil
  10972. "Position from where mapping should continue.
  10973. Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
  10974. (defvar org-scanner-tags nil
  10975. "The current tag list while the tags scanner is running.")
  10976. (defvar org-trust-scanner-tags nil
  10977. "Should `org-get-tags-at' use the tags fro the scanner.
  10978. This is for internal dynamical scoping only.
  10979. When this is non-nil, the function `org-get-tags-at' will return the value
  10980. of `org-scanner-tags' instead of building the list by itself. This
  10981. can lead to large speed-ups when the tags scanner is used in a file with
  10982. many entries, and when the list of tags is retrieved, for example to
  10983. obtain a list of properties. Building the tags list for each entry in such
  10984. a file becomes an N^2 operation - but with this variable set, it scales
  10985. as N.")
  10986. (defun org-scan-tags (action matcher &optional todo-only)
  10987. "Scan headline tags with inheritance and produce output ACTION.
  10988. ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
  10989. or `agenda' to produce an entry list for an agenda view. It can also be
  10990. a Lisp form or a function that should be called at each matched headline, in
  10991. this case the return value is a list of all return values from these calls.
  10992. MATCHER is a Lisp form to be evaluated, testing if a given set of tags
  10993. qualifies a headline for inclusion. When TODO-ONLY is non-nil,
  10994. only lines with a TODO keyword are included in the output."
  10995. (require 'org-agenda)
  10996. (let* ((re (concat "^" outline-regexp " *\\(\\<\\("
  10997. (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
  10998. (org-re
  10999. "\\>\\)\\)? *\\(.*?\\)\\(:[[:alnum:]_@:]+:\\)?[ \t]*$")))
  11000. (props (list 'face 'default
  11001. 'done-face 'org-agenda-done
  11002. 'undone-face 'default
  11003. 'mouse-face 'highlight
  11004. 'org-not-done-regexp org-not-done-regexp
  11005. 'org-todo-regexp org-todo-regexp
  11006. 'help-echo
  11007. (format "mouse-2 or RET jump to org file %s"
  11008. (abbreviate-file-name
  11009. (or (buffer-file-name (buffer-base-buffer))
  11010. (buffer-name (buffer-base-buffer)))))))
  11011. (case-fold-search nil)
  11012. (org-map-continue-from nil)
  11013. lspos tags tags-list
  11014. (tags-alist (list (cons 0 org-file-tags)))
  11015. (llast 0) rtn rtn1 level category i txt
  11016. todo marker entry priority)
  11017. (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
  11018. (setq action (list 'lambda nil action)))
  11019. (save-excursion
  11020. (goto-char (point-min))
  11021. (when (eq action 'sparse-tree)
  11022. (org-overview)
  11023. (org-remove-occur-highlights))
  11024. (while (re-search-forward re nil t)
  11025. (catch :skip
  11026. (setq todo (if (match-end 1) (org-match-string-no-properties 2))
  11027. tags (if (match-end 4) (org-match-string-no-properties 4)))
  11028. (goto-char (setq lspos (match-beginning 0)))
  11029. (setq level (org-reduced-level (funcall outline-level))
  11030. category (org-get-category))
  11031. (setq i llast llast level)
  11032. ;; remove tag lists from same and sublevels
  11033. (while (>= i level)
  11034. (when (setq entry (assoc i tags-alist))
  11035. (setq tags-alist (delete entry tags-alist)))
  11036. (setq i (1- i)))
  11037. ;; add the next tags
  11038. (when tags
  11039. (setq tags (org-split-string tags ":")
  11040. tags-alist
  11041. (cons (cons level tags) tags-alist)))
  11042. ;; compile tags for current headline
  11043. (setq tags-list
  11044. (if org-use-tag-inheritance
  11045. (apply 'append (mapcar 'cdr (reverse tags-alist)))
  11046. tags)
  11047. org-scanner-tags tags-list)
  11048. (when org-use-tag-inheritance
  11049. (setcdr (car tags-alist)
  11050. (mapcar (lambda (x)
  11051. (setq x (copy-sequence x))
  11052. (org-add-prop-inherited x))
  11053. (cdar tags-alist))))
  11054. (when (and tags org-use-tag-inheritance
  11055. (or (not (eq t org-use-tag-inheritance))
  11056. org-tags-exclude-from-inheritance))
  11057. ;; selective inheritance, remove uninherited ones
  11058. (setcdr (car tags-alist)
  11059. (org-remove-uniherited-tags (cdar tags-alist))))
  11060. (when (and (or (not todo-only)
  11061. (and (member todo org-not-done-keywords)
  11062. (or (not org-agenda-tags-todo-honor-ignore-options)
  11063. (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
  11064. (let ((case-fold-search t)) (eval matcher))
  11065. (or
  11066. (not (member org-archive-tag tags-list))
  11067. ;; we have an archive tag, should we use this anyway?
  11068. (or (not org-agenda-skip-archived-trees)
  11069. (and (eq action 'agenda) org-agenda-archives-mode))))
  11070. (unless (eq action 'sparse-tree) (org-agenda-skip))
  11071. ;; select this headline
  11072. (cond
  11073. ((eq action 'sparse-tree)
  11074. (and org-highlight-sparse-tree-matches
  11075. (org-get-heading) (match-end 0)
  11076. (org-highlight-new-match
  11077. (match-beginning 0) (match-beginning 1)))
  11078. (org-show-context 'tags-tree))
  11079. ((eq action 'agenda)
  11080. (setq txt (org-format-agenda-item
  11081. ""
  11082. (concat
  11083. (if (eq org-tags-match-list-sublevels 'indented)
  11084. (make-string (1- level) ?.) "")
  11085. (org-get-heading))
  11086. category
  11087. tags-list
  11088. )
  11089. priority (org-get-priority txt))
  11090. (goto-char lspos)
  11091. (setq marker (org-agenda-new-marker))
  11092. (org-add-props txt props
  11093. 'org-marker marker 'org-hd-marker marker 'org-category category
  11094. 'todo-state todo
  11095. 'priority priority 'type "tagsmatch")
  11096. (push txt rtn))
  11097. ((functionp action)
  11098. (setq org-map-continue-from nil)
  11099. (save-excursion
  11100. (setq rtn1 (funcall action))
  11101. (push rtn1 rtn)))
  11102. (t (error "Invalid action")))
  11103. ;; if we are to skip sublevels, jump to end of subtree
  11104. (unless org-tags-match-list-sublevels
  11105. (org-end-of-subtree t)
  11106. (backward-char 1))))
  11107. ;; Get the correct position from where to continue
  11108. (if org-map-continue-from
  11109. (goto-char org-map-continue-from)
  11110. (and (= (point) lspos) (end-of-line 1)))))
  11111. (when (and (eq action 'sparse-tree)
  11112. (not org-sparse-tree-open-archived-trees))
  11113. (org-hide-archived-subtrees (point-min) (point-max)))
  11114. (nreverse rtn)))
  11115. (defun org-remove-uniherited-tags (tags)
  11116. "Remove all tags that are not inherited from the list TAGS."
  11117. (cond
  11118. ((eq org-use-tag-inheritance t)
  11119. (if org-tags-exclude-from-inheritance
  11120. (org-delete-all org-tags-exclude-from-inheritance tags)
  11121. tags))
  11122. ((not org-use-tag-inheritance) nil)
  11123. ((stringp org-use-tag-inheritance)
  11124. (delq nil (mapcar
  11125. (lambda (x)
  11126. (if (and (string-match org-use-tag-inheritance x)
  11127. (not (member x org-tags-exclude-from-inheritance)))
  11128. x nil))
  11129. tags)))
  11130. ((listp org-use-tag-inheritance)
  11131. (delq nil (mapcar
  11132. (lambda (x)
  11133. (if (member x org-use-tag-inheritance) x nil))
  11134. tags)))))
  11135. (defvar todo-only) ;; dynamically scoped
  11136. (defun org-match-sparse-tree (&optional todo-only match)
  11137. "Create a sparse tree according to tags string MATCH.
  11138. MATCH can contain positive and negative selection of tags, like
  11139. \"+WORK+URGENT-WITHBOSS\".
  11140. If optional argument TODO-ONLY is non-nil, only select lines that are
  11141. also TODO lines."
  11142. (interactive "P")
  11143. (org-prepare-agenda-buffers (list (current-buffer)))
  11144. (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
  11145. (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
  11146. (defvar org-cached-props nil)
  11147. (defun org-cached-entry-get (pom property)
  11148. (if (or (eq t org-use-property-inheritance)
  11149. (and (stringp org-use-property-inheritance)
  11150. (string-match org-use-property-inheritance property))
  11151. (and (listp org-use-property-inheritance)
  11152. (member property org-use-property-inheritance)))
  11153. ;; Caching is not possible, check it directly
  11154. (org-entry-get pom property 'inherit)
  11155. ;; Get all properties, so that we can do complicated checks easily
  11156. (cdr (assoc property (or org-cached-props
  11157. (setq org-cached-props
  11158. (org-entry-properties pom)))))))
  11159. (defun org-global-tags-completion-table (&optional files)
  11160. "Return the list of all tags in all agenda buffer/files."
  11161. (save-excursion
  11162. (org-uniquify
  11163. (delq nil
  11164. (apply 'append
  11165. (mapcar
  11166. (lambda (file)
  11167. (set-buffer (find-file-noselect file))
  11168. (append (org-get-buffer-tags)
  11169. (mapcar (lambda (x) (if (stringp (car-safe x))
  11170. (list (car-safe x)) nil))
  11171. org-tag-alist)))
  11172. (if (and files (car files))
  11173. files
  11174. (org-agenda-files))))))))
  11175. (defun org-make-tags-matcher (match)
  11176. "Create the TAGS//TODO matcher form for the selection string MATCH."
  11177. ;; todo-only is scoped dynamically into this function, and the function
  11178. ;; may change it if the matcher asks for it.
  11179. (unless match
  11180. ;; Get a new match request, with completion
  11181. (let ((org-last-tags-completion-table
  11182. (org-global-tags-completion-table)))
  11183. (setq match (org-completing-read-no-i
  11184. "Match: " 'org-tags-completion-function nil nil nil
  11185. 'org-tags-history))))
  11186. ;; Parse the string and create a lisp form
  11187. (let ((match0 match)
  11188. (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@]+\\)"))
  11189. minus tag mm
  11190. tagsmatch todomatch tagsmatcher todomatcher kwd matcher
  11191. orterms term orlist re-p str-p level-p level-op time-p
  11192. prop-p pn pv po cat-p gv rest)
  11193. (if (string-match "/+" match)
  11194. ;; match contains also a todo-matching request
  11195. (progn
  11196. (setq tagsmatch (substring match 0 (match-beginning 0))
  11197. todomatch (substring match (match-end 0)))
  11198. (if (string-match "^!" todomatch)
  11199. (setq todo-only t todomatch (substring todomatch 1)))
  11200. (if (string-match "^\\s-*$" todomatch)
  11201. (setq todomatch nil)))
  11202. ;; only matching tags
  11203. (setq tagsmatch match todomatch nil))
  11204. ;; Make the tags matcher
  11205. (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
  11206. (setq tagsmatcher t)
  11207. (setq orterms (org-split-string tagsmatch "|") orlist nil)
  11208. (while (setq term (pop orterms))
  11209. (while (and (equal (substring term -1) "\\") orterms)
  11210. (setq term (concat term "|" (pop orterms)))) ; repair bad split
  11211. (while (string-match re term)
  11212. (setq rest (substring term (match-end 0))
  11213. minus (and (match-end 1)
  11214. (equal (match-string 1 term) "-"))
  11215. tag (match-string 2 term)
  11216. re-p (equal (string-to-char tag) ?{)
  11217. level-p (match-end 4)
  11218. prop-p (match-end 5)
  11219. mm (cond
  11220. (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
  11221. (level-p
  11222. (setq level-op (org-op-to-function (match-string 3 term)))
  11223. `(,level-op level ,(string-to-number
  11224. (match-string 4 term))))
  11225. (prop-p
  11226. (setq pn (match-string 5 term)
  11227. po (match-string 6 term)
  11228. pv (match-string 7 term)
  11229. cat-p (equal pn "CATEGORY")
  11230. re-p (equal (string-to-char pv) ?{)
  11231. str-p (equal (string-to-char pv) ?\")
  11232. time-p (save-match-data
  11233. (string-match "^\"[[<].*[]>]\"$" pv))
  11234. pv (if (or re-p str-p) (substring pv 1 -1) pv))
  11235. (if time-p (setq pv (org-matcher-time pv)))
  11236. (setq po (org-op-to-function po (if time-p 'time str-p)))
  11237. (cond
  11238. ((equal pn "CATEGORY")
  11239. (setq gv '(get-text-property (point) 'org-category)))
  11240. ((equal pn "TODO")
  11241. (setq gv 'todo))
  11242. (t
  11243. (setq gv `(org-cached-entry-get nil ,pn))))
  11244. (if re-p
  11245. (if (eq po 'org<>)
  11246. `(not (string-match ,pv (or ,gv "")))
  11247. `(string-match ,pv (or ,gv "")))
  11248. (if str-p
  11249. `(,po (or ,gv "") ,pv)
  11250. `(,po (string-to-number (or ,gv ""))
  11251. ,(string-to-number pv) ))))
  11252. (t `(member ,tag tags-list)))
  11253. mm (if minus (list 'not mm) mm)
  11254. term rest)
  11255. (push mm tagsmatcher))
  11256. (push (if (> (length tagsmatcher) 1)
  11257. (cons 'and tagsmatcher)
  11258. (car tagsmatcher))
  11259. orlist)
  11260. (setq tagsmatcher nil))
  11261. (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
  11262. (setq tagsmatcher
  11263. (list 'progn '(setq org-cached-props nil) tagsmatcher)))
  11264. ;; Make the todo matcher
  11265. (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
  11266. (setq todomatcher t)
  11267. (setq orterms (org-split-string todomatch "|") orlist nil)
  11268. (while (setq term (pop orterms))
  11269. (while (string-match re term)
  11270. (setq minus (and (match-end 1)
  11271. (equal (match-string 1 term) "-"))
  11272. kwd (match-string 2 term)
  11273. re-p (equal (string-to-char kwd) ?{)
  11274. term (substring term (match-end 0))
  11275. mm (if re-p
  11276. `(string-match ,(substring kwd 1 -1) todo)
  11277. (list 'equal 'todo kwd))
  11278. mm (if minus (list 'not mm) mm))
  11279. (push mm todomatcher))
  11280. (push (if (> (length todomatcher) 1)
  11281. (cons 'and todomatcher)
  11282. (car todomatcher))
  11283. orlist)
  11284. (setq todomatcher nil))
  11285. (setq todomatcher (if (> (length orlist) 1)
  11286. (cons 'or orlist) (car orlist))))
  11287. ;; Return the string and lisp forms of the matcher
  11288. (setq matcher (if todomatcher
  11289. (list 'and tagsmatcher todomatcher)
  11290. tagsmatcher))
  11291. (cons match0 matcher)))
  11292. (defun org-op-to-function (op &optional stringp)
  11293. "Turn an operator into the appropriate function."
  11294. (setq op
  11295. (cond
  11296. ((equal op "<" ) '(< string< org-time<))
  11297. ((equal op ">" ) '(> org-string> org-time>))
  11298. ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
  11299. ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
  11300. ((member op '("=" "==")) '(= string= org-time=))
  11301. ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
  11302. (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
  11303. (defun org<> (a b) (not (= a b)))
  11304. (defun org-string<= (a b) (or (string= a b) (string< a b)))
  11305. (defun org-string>= (a b) (not (string< a b)))
  11306. (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
  11307. (defun org-string<> (a b) (not (string= a b)))
  11308. (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
  11309. (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
  11310. (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
  11311. (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
  11312. (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
  11313. (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
  11314. (defun org-2ft (s)
  11315. "Convert S to a floating point time.
  11316. If S is already a number, just return it. If it is a string, parse
  11317. it as a time string and apply `float-time' to it. If S is nil, just return 0."
  11318. (cond
  11319. ((numberp s) s)
  11320. ((stringp s)
  11321. (condition-case nil
  11322. (float-time (apply 'encode-time (org-parse-time-string s)))
  11323. (error 0.)))
  11324. (t 0.)))
  11325. (defun org-time-today ()
  11326. "Time in seconds today at 0:00.
  11327. Returns the float number of seconds since the beginning of the
  11328. epoch to the beginning of today (00:00)."
  11329. (float-time (apply 'encode-time
  11330. (append '(0 0 0) (nthcdr 3 (decode-time))))))
  11331. (defun org-matcher-time (s)
  11332. "Interpret a time comparison value."
  11333. (save-match-data
  11334. (cond
  11335. ((string= s "<now>") (float-time))
  11336. ((string= s "<today>") (org-time-today))
  11337. ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
  11338. ((string= s "<yesterday>") (- (org-time-today) 86400.0))
  11339. ((string-match "^<\\([-+][0-9]+\\)\\([dwmy]\\)>$" s)
  11340. (+ (org-time-today)
  11341. (* (string-to-number (match-string 1 s))
  11342. (cdr (assoc (match-string 2 s)
  11343. '(("d" . 86400.0) ("w" . 604800.0)
  11344. ("m" . 2678400.0) ("y" . 31557600.0)))))))
  11345. (t (org-2ft s)))))
  11346. (defun org-match-any-p (re list)
  11347. "Does re match any element of list?"
  11348. (setq list (mapcar (lambda (x) (string-match re x)) list))
  11349. (delq nil list))
  11350. (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
  11351. (defvar org-tags-overlay (make-overlay 1 1))
  11352. (org-detach-overlay org-tags-overlay)
  11353. (defun org-get-local-tags-at (&optional pos)
  11354. "Get a list of tags defined in the current headline."
  11355. (org-get-tags-at pos 'local))
  11356. (defun org-get-local-tags ()
  11357. "Get a list of tags defined in the current headline."
  11358. (org-get-tags-at nil 'local))
  11359. (defun org-get-tags-at (&optional pos local)
  11360. "Get a list of all headline tags applicable at POS.
  11361. POS defaults to point. If tags are inherited, the list contains
  11362. the targets in the same sequence as the headlines appear, i.e.
  11363. the tags of the current headline come last.
  11364. When LOCAL is non-nil, only return tags from the current headline,
  11365. ignore inherited ones."
  11366. (interactive)
  11367. (if (and org-trust-scanner-tags
  11368. (or (not pos) (equal pos (point)))
  11369. (not local))
  11370. org-scanner-tags
  11371. (let (tags ltags lastpos parent)
  11372. (save-excursion
  11373. (save-restriction
  11374. (widen)
  11375. (goto-char (or pos (point)))
  11376. (save-match-data
  11377. (catch 'done
  11378. (condition-case nil
  11379. (progn
  11380. (org-back-to-heading t)
  11381. (while (not (equal lastpos (point)))
  11382. (setq lastpos (point))
  11383. (when (looking-at
  11384. (org-re "[^\r\n]+?:\\([[:alnum:]_@:]+\\):[ \t]*$"))
  11385. (setq ltags (org-split-string
  11386. (org-match-string-no-properties 1) ":"))
  11387. (when parent
  11388. (setq ltags (mapcar 'org-add-prop-inherited ltags)))
  11389. (setq tags (append
  11390. (if parent
  11391. (org-remove-uniherited-tags ltags)
  11392. ltags)
  11393. tags)))
  11394. (or org-use-tag-inheritance (throw 'done t))
  11395. (if local (throw 'done t))
  11396. (or (org-up-heading-safe) (error nil))
  11397. (setq parent t)))
  11398. (error nil)))))
  11399. (append (org-remove-uniherited-tags org-file-tags) tags)))))
  11400. (defun org-add-prop-inherited (s)
  11401. (add-text-properties 0 (length s) '(inherited t) s)
  11402. s)
  11403. (defun org-toggle-tag (tag &optional onoff)
  11404. "Toggle the tag TAG for the current line.
  11405. If ONOFF is `on' or `off', don't toggle but set to this state."
  11406. (let (res current)
  11407. (save-excursion
  11408. (org-back-to-heading t)
  11409. (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@:]+\\):[ \t]*$")
  11410. (point-at-eol) t)
  11411. (progn
  11412. (setq current (match-string 1))
  11413. (replace-match ""))
  11414. (setq current ""))
  11415. (setq current (nreverse (org-split-string current ":")))
  11416. (cond
  11417. ((eq onoff 'on)
  11418. (setq res t)
  11419. (or (member tag current) (push tag current)))
  11420. ((eq onoff 'off)
  11421. (or (not (member tag current)) (setq current (delete tag current))))
  11422. (t (if (member tag current)
  11423. (setq current (delete tag current))
  11424. (setq res t)
  11425. (push tag current))))
  11426. (end-of-line 1)
  11427. (if current
  11428. (progn
  11429. (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
  11430. (org-set-tags nil t))
  11431. (delete-horizontal-space))
  11432. (run-hooks 'org-after-tags-change-hook))
  11433. res))
  11434. (defun org-align-tags-here (to-col)
  11435. ;; Assumes that this is a headline
  11436. (let ((pos (point)) (col (current-column)) ncol tags-l p)
  11437. (beginning-of-line 1)
  11438. (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
  11439. (< pos (match-beginning 2)))
  11440. (progn
  11441. (setq tags-l (- (match-end 2) (match-beginning 2)))
  11442. (goto-char (match-beginning 1))
  11443. (insert " ")
  11444. (delete-region (point) (1+ (match-beginning 2)))
  11445. (setq ncol (max (1+ (current-column))
  11446. (1+ col)
  11447. (if (> to-col 0)
  11448. to-col
  11449. (- (abs to-col) tags-l))))
  11450. (setq p (point))
  11451. (insert (make-string (- ncol (current-column)) ?\ ))
  11452. (setq ncol (current-column))
  11453. (when indent-tabs-mode (tabify p (point-at-eol)))
  11454. (org-move-to-column (min ncol col) t))
  11455. (goto-char pos))))
  11456. (defun org-set-tags-command (&optional arg just-align)
  11457. "Call the set-tags command for the current entry."
  11458. (interactive "P")
  11459. (if (org-on-heading-p)
  11460. (org-set-tags arg just-align)
  11461. (save-excursion
  11462. (org-back-to-heading t)
  11463. (org-set-tags arg just-align))))
  11464. (defun org-set-tags-to (data)
  11465. "Set the tags of the current entry to DATA, replacing the current tags.
  11466. DATA may be a tags string like :aa:bb:cc:, or a list of tags.
  11467. If DATA is nil or the empty string, any tags will be removed."
  11468. (interactive "sTags: ")
  11469. (setq data
  11470. (cond
  11471. ((eq data nil) "")
  11472. ((equal data "") "")
  11473. ((stringp data)
  11474. (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
  11475. ":"))
  11476. ((listp data)
  11477. (concat ":" (mapconcat 'identity data ":") ":"))
  11478. (t nil)))
  11479. (when data
  11480. (save-excursion
  11481. (org-back-to-heading t)
  11482. (when (looking-at org-complex-heading-regexp)
  11483. (if (match-end 5)
  11484. (progn
  11485. (goto-char (match-beginning 5))
  11486. (insert data)
  11487. (delete-region (point) (point-at-eol))
  11488. (org-set-tags nil 'align))
  11489. (goto-char (point-at-eol))
  11490. (insert " " data)
  11491. (org-set-tags nil 'align)))
  11492. (beginning-of-line 1)
  11493. (if (looking-at ".*?\\([ \t]+\\)$")
  11494. (delete-region (match-beginning 1) (match-end 1))))))
  11495. (defun org-align-all-tags ()
  11496. "Align the tags i all headings."
  11497. (interactive)
  11498. (save-excursion
  11499. (or (ignore-errors (org-back-to-heading t))
  11500. (outline-next-heading))
  11501. (if (org-on-heading-p)
  11502. (org-set-tags t)
  11503. (message "No headings"))))
  11504. (defun org-set-tags (&optional arg just-align)
  11505. "Set the tags for the current headline.
  11506. With prefix ARG, realign all tags in headings in the current buffer."
  11507. (interactive "P")
  11508. (let* ((re (concat "^" outline-regexp))
  11509. (current (org-get-tags-string))
  11510. (col (current-column))
  11511. (org-setting-tags t)
  11512. table current-tags inherited-tags ; computed below when needed
  11513. tags p0 c0 c1 rpl)
  11514. (if arg
  11515. (save-excursion
  11516. (goto-char (point-min))
  11517. (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
  11518. (while (re-search-forward re nil t)
  11519. (org-set-tags nil t)
  11520. (end-of-line 1)))
  11521. (message "All tags realigned to column %d" org-tags-column))
  11522. (if just-align
  11523. (setq tags current)
  11524. ;; Get a new set of tags from the user
  11525. (save-excursion
  11526. (setq table (append org-tag-persistent-alist
  11527. (or org-tag-alist (org-get-buffer-tags))
  11528. (and org-complete-tags-always-offer-all-agenda-tags
  11529. (org-global-tags-completion-table (org-agenda-files))))
  11530. org-last-tags-completion-table table
  11531. current-tags (org-split-string current ":")
  11532. inherited-tags (nreverse
  11533. (nthcdr (length current-tags)
  11534. (nreverse (org-get-tags-at))))
  11535. tags
  11536. (if (or (eq t org-use-fast-tag-selection)
  11537. (and org-use-fast-tag-selection
  11538. (delq nil (mapcar 'cdr table))))
  11539. (org-fast-tag-selection
  11540. current-tags inherited-tags table
  11541. (if org-fast-tag-selection-include-todo org-todo-key-alist))
  11542. (let ((org-add-colon-after-tag-completion t))
  11543. (org-trim
  11544. (org-without-partial-completion
  11545. (org-icompleting-read "Tags: " 'org-tags-completion-function
  11546. nil nil current 'org-tags-history)))))))
  11547. (while (string-match "[-+&]+" tags)
  11548. ;; No boolean logic, just a list
  11549. (setq tags (replace-match ":" t t tags))))
  11550. (if org-tags-sort-function
  11551. (setq tags (mapconcat 'identity
  11552. (sort (org-split-string tags (org-re "[^[:alnum:]_@]+"))
  11553. org-tags-sort-function) ":")))
  11554. (if (string-match "\\`[\t ]*\\'" tags)
  11555. (setq tags "")
  11556. (unless (string-match ":$" tags) (setq tags (concat tags ":")))
  11557. (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
  11558. ;; Insert new tags at the correct column
  11559. (beginning-of-line 1)
  11560. (cond
  11561. ((and (equal current "") (equal tags "")))
  11562. ((re-search-forward
  11563. (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
  11564. (point-at-eol) t)
  11565. (if (equal tags "")
  11566. (setq rpl "")
  11567. (goto-char (match-beginning 0))
  11568. (setq c0 (current-column) p0 (if (equal (char-before) ?*)
  11569. (1+ (point)) (point))
  11570. c1 (max (1+ c0) (if (> org-tags-column 0)
  11571. org-tags-column
  11572. (- (- org-tags-column) (length tags))))
  11573. rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
  11574. (replace-match rpl t t)
  11575. (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
  11576. tags)
  11577. (t (error "Tags alignment failed")))
  11578. (org-move-to-column col)
  11579. (unless just-align
  11580. (run-hooks 'org-after-tags-change-hook)))))
  11581. (defun org-change-tag-in-region (beg end tag off)
  11582. "Add or remove TAG for each entry in the region.
  11583. This works in the agenda, and also in an org-mode buffer."
  11584. (interactive
  11585. (list (region-beginning) (region-end)
  11586. (let ((org-last-tags-completion-table
  11587. (if (org-mode-p)
  11588. (org-get-buffer-tags)
  11589. (org-global-tags-completion-table))))
  11590. (org-icompleting-read
  11591. "Tag: " 'org-tags-completion-function nil nil nil
  11592. 'org-tags-history))
  11593. (progn
  11594. (message "[s]et or [r]emove? ")
  11595. (equal (read-char-exclusive) ?r))))
  11596. (if (fboundp 'deactivate-mark) (deactivate-mark))
  11597. (let ((agendap (equal major-mode 'org-agenda-mode))
  11598. l1 l2 m buf pos newhead (cnt 0))
  11599. (goto-char end)
  11600. (setq l2 (1- (org-current-line)))
  11601. (goto-char beg)
  11602. (setq l1 (org-current-line))
  11603. (loop for l from l1 to l2 do
  11604. (org-goto-line l)
  11605. (setq m (get-text-property (point) 'org-hd-marker))
  11606. (when (or (and (org-mode-p) (org-on-heading-p))
  11607. (and agendap m))
  11608. (setq buf (if agendap (marker-buffer m) (current-buffer))
  11609. pos (if agendap m (point)))
  11610. (with-current-buffer buf
  11611. (save-excursion
  11612. (save-restriction
  11613. (goto-char pos)
  11614. (setq cnt (1+ cnt))
  11615. (org-toggle-tag tag (if off 'off 'on))
  11616. (setq newhead (org-get-heading)))))
  11617. (and agendap (org-agenda-change-all-lines newhead m))))
  11618. (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
  11619. (defun org-tags-completion-function (string predicate &optional flag)
  11620. (let (s1 s2 rtn (ctable org-last-tags-completion-table)
  11621. (confirm (lambda (x) (stringp (car x)))))
  11622. (if (string-match "^\\(.*[-+:&|]\\)\\([^-+:&|]*\\)$" string)
  11623. (setq s1 (match-string 1 string)
  11624. s2 (match-string 2 string))
  11625. (setq s1 "" s2 string))
  11626. (cond
  11627. ((eq flag nil)
  11628. ;; try completion
  11629. (setq rtn (try-completion s2 ctable confirm))
  11630. (if (stringp rtn)
  11631. (setq rtn
  11632. (concat s1 s2 (substring rtn (length s2))
  11633. (if (and org-add-colon-after-tag-completion
  11634. (assoc rtn ctable))
  11635. ":" ""))))
  11636. rtn)
  11637. ((eq flag t)
  11638. ;; all-completions
  11639. (all-completions s2 ctable confirm)
  11640. )
  11641. ((eq flag 'lambda)
  11642. ;; exact match?
  11643. (assoc s2 ctable)))
  11644. ))
  11645. (defun org-fast-tag-insert (kwd tags face &optional end)
  11646. "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
  11647. (insert (format "%-12s" (concat kwd ":"))
  11648. (org-add-props (mapconcat 'identity tags " ") nil 'face face)
  11649. (or end "")))
  11650. (defun org-fast-tag-show-exit (flag)
  11651. (save-excursion
  11652. (org-goto-line 3)
  11653. (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
  11654. (replace-match ""))
  11655. (when flag
  11656. (end-of-line 1)
  11657. (org-move-to-column (- (window-width) 19) t)
  11658. (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
  11659. (defun org-set-current-tags-overlay (current prefix)
  11660. (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
  11661. (if (featurep 'xemacs)
  11662. (org-overlay-display org-tags-overlay (concat prefix s)
  11663. 'secondary-selection)
  11664. (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
  11665. (org-overlay-display org-tags-overlay (concat prefix s)))))
  11666. (defvar org-last-tag-selection-key nil)
  11667. (defun org-fast-tag-selection (current inherited table &optional todo-table)
  11668. "Fast tag selection with single keys.
  11669. CURRENT is the current list of tags in the headline, INHERITED is the
  11670. list of inherited tags, and TABLE is an alist of tags and corresponding keys,
  11671. possibly with grouping information. TODO-TABLE is a similar table with
  11672. TODO keywords, should these have keys assigned to them.
  11673. If the keys are nil, a-z are automatically assigned.
  11674. Returns the new tags string, or nil to not change the current settings."
  11675. (let* ((fulltable (append table todo-table))
  11676. (maxlen (apply 'max (mapcar
  11677. (lambda (x)
  11678. (if (stringp (car x)) (string-width (car x)) 0))
  11679. fulltable)))
  11680. (buf (current-buffer))
  11681. (expert (eq org-fast-tag-selection-single-key 'expert))
  11682. (buffer-tags nil)
  11683. (fwidth (+ maxlen 3 1 3))
  11684. (ncol (/ (- (window-width) 4) fwidth))
  11685. (i-face 'org-done)
  11686. (c-face 'org-todo)
  11687. tg cnt e c char c1 c2 ntable tbl rtn
  11688. ov-start ov-end ov-prefix
  11689. (exit-after-next org-fast-tag-selection-single-key)
  11690. (done-keywords org-done-keywords)
  11691. groups ingroup)
  11692. (save-excursion
  11693. (beginning-of-line 1)
  11694. (if (looking-at
  11695. (org-re ".*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
  11696. (setq ov-start (match-beginning 1)
  11697. ov-end (match-end 1)
  11698. ov-prefix "")
  11699. (setq ov-start (1- (point-at-eol))
  11700. ov-end (1+ ov-start))
  11701. (skip-chars-forward "^\n\r")
  11702. (setq ov-prefix
  11703. (concat
  11704. (buffer-substring (1- (point)) (point))
  11705. (if (> (current-column) org-tags-column)
  11706. " "
  11707. (make-string (- org-tags-column (current-column)) ?\ ))))))
  11708. (move-overlay org-tags-overlay ov-start ov-end)
  11709. (save-window-excursion
  11710. (if expert
  11711. (set-buffer (get-buffer-create " *Org tags*"))
  11712. (delete-other-windows)
  11713. (split-window-vertically)
  11714. (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
  11715. (erase-buffer)
  11716. (org-set-local 'org-done-keywords done-keywords)
  11717. (org-fast-tag-insert "Inherited" inherited i-face "\n")
  11718. (org-fast-tag-insert "Current" current c-face "\n\n")
  11719. (org-fast-tag-show-exit exit-after-next)
  11720. (org-set-current-tags-overlay current ov-prefix)
  11721. (setq tbl fulltable char ?a cnt 0)
  11722. (while (setq e (pop tbl))
  11723. (cond
  11724. ((equal (car e) :startgroup)
  11725. (push '() groups) (setq ingroup t)
  11726. (when (not (= cnt 0))
  11727. (setq cnt 0)
  11728. (insert "\n"))
  11729. (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
  11730. ((equal (car e) :endgroup)
  11731. (setq ingroup nil cnt 0)
  11732. (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
  11733. ((equal e '(:newline))
  11734. (when (not (= cnt 0))
  11735. (setq cnt 0)
  11736. (insert "\n")
  11737. (setq e (car tbl))
  11738. (while (equal (car tbl) '(:newline))
  11739. (insert "\n")
  11740. (setq tbl (cdr tbl)))))
  11741. (t
  11742. (setq tg (copy-sequence (car e)) c2 nil)
  11743. (if (cdr e)
  11744. (setq c (cdr e))
  11745. ;; automatically assign a character.
  11746. (setq c1 (string-to-char
  11747. (downcase (substring
  11748. tg (if (= (string-to-char tg) ?@) 1 0)))))
  11749. (if (or (rassoc c1 ntable) (rassoc c1 table))
  11750. (while (or (rassoc char ntable) (rassoc char table))
  11751. (setq char (1+ char)))
  11752. (setq c2 c1))
  11753. (setq c (or c2 char)))
  11754. (if ingroup (push tg (car groups)))
  11755. (setq tg (org-add-props tg nil 'face
  11756. (cond
  11757. ((not (assoc tg table))
  11758. (org-get-todo-face tg))
  11759. ((member tg current) c-face)
  11760. ((member tg inherited) i-face)
  11761. (t nil))))
  11762. (if (and (= cnt 0) (not ingroup)) (insert " "))
  11763. (insert "[" c "] " tg (make-string
  11764. (- fwidth 4 (length tg)) ?\ ))
  11765. (push (cons tg c) ntable)
  11766. (when (= (setq cnt (1+ cnt)) ncol)
  11767. (insert "\n")
  11768. (if ingroup (insert " "))
  11769. (setq cnt 0)))))
  11770. (setq ntable (nreverse ntable))
  11771. (insert "\n")
  11772. (goto-char (point-min))
  11773. (if (not expert) (org-fit-window-to-buffer))
  11774. (setq rtn
  11775. (catch 'exit
  11776. (while t
  11777. (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
  11778. (if (not groups) "no " "")
  11779. (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
  11780. (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
  11781. (setq org-last-tag-selection-key c)
  11782. (cond
  11783. ((= c ?\r) (throw 'exit t))
  11784. ((= c ?!)
  11785. (setq groups (not groups))
  11786. (goto-char (point-min))
  11787. (while (re-search-forward "[{}]" nil t) (replace-match " ")))
  11788. ((= c ?\C-c)
  11789. (if (not expert)
  11790. (org-fast-tag-show-exit
  11791. (setq exit-after-next (not exit-after-next)))
  11792. (setq expert nil)
  11793. (delete-other-windows)
  11794. (split-window-vertically)
  11795. (org-switch-to-buffer-other-window " *Org tags*")
  11796. (org-fit-window-to-buffer)))
  11797. ((or (= c ?\C-g)
  11798. (and (= c ?q) (not (rassoc c ntable))))
  11799. (org-detach-overlay org-tags-overlay)
  11800. (setq quit-flag t))
  11801. ((= c ?\ )
  11802. (setq current nil)
  11803. (if exit-after-next (setq exit-after-next 'now)))
  11804. ((= c ?\t)
  11805. (condition-case nil
  11806. (setq tg (org-icompleting-read
  11807. "Tag: "
  11808. (or buffer-tags
  11809. (with-current-buffer buf
  11810. (org-get-buffer-tags)))))
  11811. (quit (setq tg "")))
  11812. (when (string-match "\\S-" tg)
  11813. (add-to-list 'buffer-tags (list tg))
  11814. (if (member tg current)
  11815. (setq current (delete tg current))
  11816. (push tg current)))
  11817. (if exit-after-next (setq exit-after-next 'now)))
  11818. ((setq e (rassoc c todo-table) tg (car e))
  11819. (with-current-buffer buf
  11820. (save-excursion (org-todo tg)))
  11821. (if exit-after-next (setq exit-after-next 'now)))
  11822. ((setq e (rassoc c ntable) tg (car e))
  11823. (if (member tg current)
  11824. (setq current (delete tg current))
  11825. (loop for g in groups do
  11826. (if (member tg g)
  11827. (mapc (lambda (x)
  11828. (setq current (delete x current)))
  11829. g)))
  11830. (push tg current))
  11831. (if exit-after-next (setq exit-after-next 'now))))
  11832. ;; Create a sorted list
  11833. (setq current
  11834. (sort current
  11835. (lambda (a b)
  11836. (assoc b (cdr (memq (assoc a ntable) ntable))))))
  11837. (if (eq exit-after-next 'now) (throw 'exit t))
  11838. (goto-char (point-min))
  11839. (beginning-of-line 2)
  11840. (delete-region (point) (point-at-eol))
  11841. (org-fast-tag-insert "Current" current c-face)
  11842. (org-set-current-tags-overlay current ov-prefix)
  11843. (while (re-search-forward
  11844. (org-re "\\[.\\] \\([[:alnum:]_@]+\\)") nil t)
  11845. (setq tg (match-string 1))
  11846. (add-text-properties
  11847. (match-beginning 1) (match-end 1)
  11848. (list 'face
  11849. (cond
  11850. ((member tg current) c-face)
  11851. ((member tg inherited) i-face)
  11852. (t (get-text-property (match-beginning 1) 'face))))))
  11853. (goto-char (point-min)))))
  11854. (org-detach-overlay org-tags-overlay)
  11855. (if rtn
  11856. (mapconcat 'identity current ":")
  11857. nil))))
  11858. (defun org-get-tags-string ()
  11859. "Get the TAGS string in the current headline."
  11860. (unless (org-on-heading-p t)
  11861. (error "Not on a heading"))
  11862. (save-excursion
  11863. (beginning-of-line 1)
  11864. (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@:]+:\\)[ \t]*$"))
  11865. (org-match-string-no-properties 1)
  11866. "")))
  11867. (defun org-get-tags ()
  11868. "Get the list of tags specified in the current headline."
  11869. (org-split-string (org-get-tags-string) ":"))
  11870. (defun org-get-buffer-tags ()
  11871. "Get a table of all tags used in the buffer, for completion."
  11872. (let (tags)
  11873. (save-excursion
  11874. (goto-char (point-min))
  11875. (while (re-search-forward
  11876. (org-re "[ \t]:\\([[:alnum:]_@:]+\\):[ \t\r\n]") nil t)
  11877. (when (equal (char-after (point-at-bol 0)) ?*)
  11878. (mapc (lambda (x) (add-to-list 'tags x))
  11879. (org-split-string (org-match-string-no-properties 1) ":")))))
  11880. (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
  11881. (mapcar 'list tags)))
  11882. ;;;; The mapping API
  11883. ;;;###autoload
  11884. (defun org-map-entries (func &optional match scope &rest skip)
  11885. "Call FUNC at each headline selected by MATCH in SCOPE.
  11886. FUNC is a function or a lisp form. The function will be called without
  11887. arguments, with the cursor positioned at the beginning of the headline.
  11888. The return values of all calls to the function will be collected and
  11889. returned as a list.
  11890. The call to FUNC will be wrapped into a save-excursion form, so FUNC
  11891. does not need to preserve point. After evaluation, the cursor will be
  11892. moved to the end of the line (presumably of the headline of the
  11893. processed entry) and search continues from there. Under some
  11894. circumstances, this may not produce the wanted results. For example,
  11895. if you have removed (e.g. archived) the current (sub)tree it could
  11896. mean that the next entry will be skipped entirely. In such cases, you
  11897. can specify the position from where search should continue by making
  11898. FUNC set the variable `org-map-continue-from' to the desired buffer
  11899. position.
  11900. MATCH is a tags/property/todo match as it is used in the agenda tags view.
  11901. Only headlines that are matched by this query will be considered during
  11902. the iteration. When MATCH is nil or t, all headlines will be
  11903. visited by the iteration.
  11904. SCOPE determines the scope of this command. It can be any of:
  11905. nil The current buffer, respecting the restriction if any
  11906. tree The subtree started with the entry at point
  11907. file The current buffer, without restriction
  11908. file-with-archives
  11909. The current buffer, and any archives associated with it
  11910. agenda All agenda files
  11911. agenda-with-archives
  11912. All agenda files with any archive files associated with them
  11913. \(file1 file2 ...)
  11914. If this is a list, all files in the list will be scanned
  11915. The remaining args are treated as settings for the skipping facilities of
  11916. the scanner. The following items can be given here:
  11917. archive skip trees with the archive tag.
  11918. comment skip trees with the COMMENT keyword
  11919. function or Emacs Lisp form:
  11920. will be used as value for `org-agenda-skip-function', so whenever
  11921. the function returns t, FUNC will not be called for that
  11922. entry and search will continue from the point where the
  11923. function leaves it.
  11924. If your function needs to retrieve the tags including inherited tags
  11925. at the *current* entry, you can use the value of the variable
  11926. `org-scanner-tags' which will be much faster than getting the value
  11927. with `org-get-tags-at'. If your function gets properties with
  11928. `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
  11929. to t around the call to `org-entry-properties' to get the same speedup.
  11930. Note that if your function moves around to retrieve tags and properties at
  11931. a *different* entry, you cannot use these techniques."
  11932. (let* ((org-agenda-archives-mode nil) ; just to make sure
  11933. (org-agenda-skip-archived-trees (memq 'archive skip))
  11934. (org-agenda-skip-comment-trees (memq 'comment skip))
  11935. (org-agenda-skip-function
  11936. (car (org-delete-all '(comment archive) skip)))
  11937. (org-tags-match-list-sublevels t)
  11938. matcher file res
  11939. org-todo-keywords-for-agenda
  11940. org-done-keywords-for-agenda
  11941. org-todo-keyword-alist-for-agenda
  11942. org-drawers-for-agenda
  11943. org-tag-alist-for-agenda)
  11944. (cond
  11945. ((eq match t) (setq matcher t))
  11946. ((eq match nil) (setq matcher t))
  11947. (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
  11948. (save-excursion
  11949. (save-restriction
  11950. (when (eq scope 'tree)
  11951. (org-back-to-heading t)
  11952. (org-narrow-to-subtree)
  11953. (setq scope nil))
  11954. (if (not scope)
  11955. (progn
  11956. (org-prepare-agenda-buffers
  11957. (list (buffer-file-name (current-buffer))))
  11958. (setq res (org-scan-tags func matcher)))
  11959. ;; Get the right scope
  11960. (cond
  11961. ((and scope (listp scope) (symbolp (car scope)))
  11962. (setq scope (eval scope)))
  11963. ((eq scope 'agenda)
  11964. (setq scope (org-agenda-files t)))
  11965. ((eq scope 'agenda-with-archives)
  11966. (setq scope (org-agenda-files t))
  11967. (setq scope (org-add-archive-files scope)))
  11968. ((eq scope 'file)
  11969. (setq scope (list (buffer-file-name))))
  11970. ((eq scope 'file-with-archives)
  11971. (setq scope (org-add-archive-files (list (buffer-file-name))))))
  11972. (org-prepare-agenda-buffers scope)
  11973. (while (setq file (pop scope))
  11974. (with-current-buffer (org-find-base-buffer-visiting file)
  11975. (save-excursion
  11976. (save-restriction
  11977. (widen)
  11978. (goto-char (point-min))
  11979. (setq res (append res (org-scan-tags func matcher))))))))))
  11980. res))
  11981. ;;;; Properties
  11982. ;;; Setting and retrieving properties
  11983. (defconst org-special-properties
  11984. '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
  11985. "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED")
  11986. "The special properties valid in Org-mode.
  11987. These are properties that are not defined in the property drawer,
  11988. but in some other way.")
  11989. (defconst org-default-properties
  11990. '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
  11991. "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
  11992. "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
  11993. "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
  11994. "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
  11995. "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
  11996. "Some properties that are used by Org-mode for various purposes.
  11997. Being in this list makes sure that they are offered for completion.")
  11998. (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
  11999. "Regular expression matching the first line of a property drawer.")
  12000. (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
  12001. "Regular expression matching the last line of a property drawer.")
  12002. (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
  12003. "Regular expression matching the first line of a property drawer.")
  12004. (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
  12005. "Regular expression matching the first line of a property drawer.")
  12006. (defconst org-property-drawer-re
  12007. (concat "\\(" org-property-start-re "\\)[^\000]*\\("
  12008. org-property-end-re "\\)\n?")
  12009. "Matches an entire property drawer.")
  12010. (defconst org-clock-drawer-re
  12011. (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
  12012. org-property-end-re "\\)\n?")
  12013. "Matches an entire clock drawer.")
  12014. (defun org-property-action ()
  12015. "Do an action on properties."
  12016. (interactive)
  12017. (let (c)
  12018. (org-at-property-p)
  12019. (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
  12020. (setq c (read-char-exclusive))
  12021. (cond
  12022. ((equal c ?s)
  12023. (call-interactively 'org-set-property))
  12024. ((equal c ?d)
  12025. (call-interactively 'org-delete-property))
  12026. ((equal c ?D)
  12027. (call-interactively 'org-delete-property-globally))
  12028. ((equal c ?c)
  12029. (call-interactively 'org-compute-property-at-point))
  12030. (t (error "No such property action %c" c)))))
  12031. (defun org-set-effort (&optional value)
  12032. "Set the effort property of the current entry.
  12033. With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
  12034. allowed value."
  12035. (interactive "P")
  12036. (if (equal value 0) (setq value 10))
  12037. (let* ((completion-ignore-case t)
  12038. (prop org-effort-property)
  12039. (cur (org-entry-get nil prop))
  12040. (allowed (org-property-get-allowed-values nil prop 'table))
  12041. (existing (mapcar 'list (org-property-values prop)))
  12042. rpl
  12043. (val (cond
  12044. ((stringp value) value)
  12045. ((and allowed (integerp value))
  12046. (or (car (nth (1- value) allowed))
  12047. (car (org-last allowed))))
  12048. (allowed
  12049. (message "Select 1-9,0, [RET%s]: %s"
  12050. (if cur (concat "=" cur) "")
  12051. (mapconcat 'car allowed " "))
  12052. (setq rpl (read-char-exclusive))
  12053. (if (equal rpl ?\r)
  12054. cur
  12055. (setq rpl (- rpl ?0))
  12056. (if (equal rpl 0) (setq rpl 10))
  12057. (if (and (> rpl 0) (<= rpl (length allowed)))
  12058. (car (nth (1- rpl) allowed))
  12059. (org-completing-read "Effort: " allowed nil))))
  12060. (t
  12061. (let (org-completion-use-ido org-completion-use-iswitchb)
  12062. (org-completing-read
  12063. (concat "Effort " (if (and cur (string-match "\\S-" cur))
  12064. (concat "[" cur "]") "")
  12065. ": ")
  12066. existing nil nil "" nil cur))))))
  12067. (unless (equal (org-entry-get nil prop) val)
  12068. (org-entry-put nil prop val))
  12069. (message "%s is now %s" prop val)))
  12070. (defun org-at-property-p ()
  12071. "Is cursor inside a property drawer?"
  12072. (save-excursion
  12073. (beginning-of-line 1)
  12074. (when (looking-at (org-re "^[ \t]*\\(:\\([[:alpha:]][[:alnum:]_-]*\\):\\)[ \t]*\\(.*\\)"))
  12075. (save-match-data ;; Used by calling procedures
  12076. (let ((p (point))
  12077. (range (unless (org-before-first-heading-p)
  12078. (org-get-property-block))))
  12079. (and range (<= (car range) p) (< p (cdr range))))))))
  12080. (defun org-get-property-block (&optional beg end force)
  12081. "Return the (beg . end) range of the body of the property drawer.
  12082. BEG and END can be beginning and end of subtree, if not given
  12083. they will be found.
  12084. If the drawer does not exist and FORCE is non-nil, create the drawer."
  12085. (catch 'exit
  12086. (save-excursion
  12087. (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
  12088. (end (or end (progn (outline-next-heading) (point)))))
  12089. (goto-char beg)
  12090. (if (re-search-forward org-property-start-re end t)
  12091. (setq beg (1+ (match-end 0)))
  12092. (if force
  12093. (save-excursion
  12094. (org-insert-property-drawer)
  12095. (setq end (progn (outline-next-heading) (point))))
  12096. (throw 'exit nil))
  12097. (goto-char beg)
  12098. (if (re-search-forward org-property-start-re end t)
  12099. (setq beg (1+ (match-end 0)))))
  12100. (if (re-search-forward org-property-end-re end t)
  12101. (setq end (match-beginning 0))
  12102. (or force (throw 'exit nil))
  12103. (goto-char beg)
  12104. (setq end beg)
  12105. (org-indent-line-function)
  12106. (insert ":END:\n"))
  12107. (cons beg end)))))
  12108. (defun org-entry-properties (&optional pom which specific)
  12109. "Get all properties of the entry at point-or-marker POM.
  12110. This includes the TODO keyword, the tags, time strings for deadline,
  12111. scheduled, and clocking, and any additional properties defined in the
  12112. entry. The return value is an alist, keys may occur multiple times
  12113. if the property key was used several times.
  12114. POM may also be nil, in which case the current entry is used.
  12115. If WHICH is nil or `all', get all properties. If WHICH is
  12116. `special' or `standard', only get that subclass. If WHICH
  12117. is a string only get exactly this property. Specific can be a string, the
  12118. specific property we are interested in. Specifying it can speed
  12119. things up because then unnecessary parsing is avoided."
  12120. (setq which (or which 'all))
  12121. (org-with-point-at pom
  12122. (let ((clockstr (substring org-clock-string 0 -1))
  12123. (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
  12124. (case-fold-search nil)
  12125. beg end range props sum-props key key1 value string clocksum)
  12126. (save-excursion
  12127. (when (condition-case nil
  12128. (and (org-mode-p) (org-back-to-heading t))
  12129. (error nil))
  12130. (setq beg (point))
  12131. (setq sum-props (get-text-property (point) 'org-summaries))
  12132. (setq clocksum (get-text-property (point) :org-clock-minutes))
  12133. (outline-next-heading)
  12134. (setq end (point))
  12135. (when (memq which '(all special))
  12136. ;; Get the special properties, like TODO and tags
  12137. (goto-char beg)
  12138. (when (and (or (not specific) (string= specific "TODO"))
  12139. (looking-at org-todo-line-regexp) (match-end 2))
  12140. (push (cons "TODO" (org-match-string-no-properties 2)) props))
  12141. (when (and (or (not specific) (string= specific "PRIORITY"))
  12142. (looking-at org-priority-regexp))
  12143. (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
  12144. (when (and (or (not specific) (string= specific "TAGS"))
  12145. (setq value (org-get-tags-string))
  12146. (string-match "\\S-" value))
  12147. (push (cons "TAGS" value) props))
  12148. (when (and (or (not specific) (string= specific "ALLTAGS"))
  12149. (setq value (org-get-tags-at)))
  12150. (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
  12151. ":"))
  12152. props))
  12153. (when (or (not specific) (string= specific "BLOCKED"))
  12154. (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
  12155. (when (or (not specific)
  12156. (member specific
  12157. '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
  12158. "TIMESTAMP" "TIMESTAMP_IA")))
  12159. (while (re-search-forward org-maybe-keyword-time-regexp end t)
  12160. (setq key (if (match-end 1)
  12161. (substring (org-match-string-no-properties 1)
  12162. 0 -1))
  12163. string (if (equal key clockstr)
  12164. (org-no-properties
  12165. (org-trim
  12166. (buffer-substring
  12167. (match-beginning 3) (goto-char
  12168. (point-at-eol)))))
  12169. (substring (org-match-string-no-properties 3)
  12170. 1 -1)))
  12171. ;; Get the correct property name from the key. This is
  12172. ;; necessary if the user has configured time keywords.
  12173. (setq key1 (concat key ":"))
  12174. (cond
  12175. ((not key)
  12176. (setq key
  12177. (if (= (char-after (match-beginning 3)) ?\[)
  12178. "TIMESTAMP_IA" "TIMESTAMP")))
  12179. ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
  12180. ((equal key1 org-deadline-string) (setq key "DEADLINE"))
  12181. ((equal key1 org-closed-string) (setq key "CLOSED"))
  12182. ((equal key1 org-clock-string) (setq key "CLOCK")))
  12183. (when (or (equal key "CLOCK") (not (assoc key props)))
  12184. (push (cons key string) props))))
  12185. )
  12186. (when (memq which '(all standard))
  12187. ;; Get the standard properties, like :PROP: ...
  12188. (setq range (org-get-property-block beg end))
  12189. (when range
  12190. (goto-char (car range))
  12191. (while (re-search-forward
  12192. (org-re "^[ \t]*:\\([[:alpha:]][[:alnum:]_-]*\\):[ \t]*\\(\\S-.*\\)?")
  12193. (cdr range) t)
  12194. (setq key (org-match-string-no-properties 1)
  12195. value (org-trim (or (org-match-string-no-properties 2) "")))
  12196. (unless (member key excluded)
  12197. (push (cons key (or value "")) props)))))
  12198. (if clocksum
  12199. (push (cons "CLOCKSUM"
  12200. (org-columns-number-to-string (/ (float clocksum) 60.)
  12201. 'add_times))
  12202. props))
  12203. (unless (assoc "CATEGORY" props)
  12204. (setq value (or (org-get-category)
  12205. (progn (org-refresh-category-properties)
  12206. (org-get-category))))
  12207. (push (cons "CATEGORY" value) props))
  12208. (append sum-props (nreverse props)))))))
  12209. (defun org-entry-get (pom property &optional inherit literal-nil)
  12210. "Get value of PROPERTY for entry at point-or-marker POM.
  12211. If INHERIT is non-nil and the entry does not have the property,
  12212. then also check higher levels of the hierarchy.
  12213. If INHERIT is the symbol `selective', use inheritance only if the setting
  12214. in `org-use-property-inheritance' selects PROPERTY for inheritance.
  12215. If the property is present but empty, the return value is the empty string.
  12216. If the property is not present at all, nil is returned.
  12217. If LITERAL-NIL is set, return the string value \"nil\" as a string,
  12218. do not interpret it as the list atom nil. This is used for inheritance
  12219. when a \"nil\" value can supercede a non-nil value higher up the hierarchy."
  12220. (org-with-point-at pom
  12221. (if (and inherit (if (eq inherit 'selective)
  12222. (org-property-inherit-p property)
  12223. t))
  12224. (org-entry-get-with-inheritance property literal-nil)
  12225. (if (member property org-special-properties)
  12226. ;; We need a special property. Use `org-entry-properties' to
  12227. ;; retrieve it, but specify the wanted property
  12228. (cdr (assoc property (org-entry-properties nil 'special property)))
  12229. (let ((range (org-get-property-block)))
  12230. (if (and range
  12231. (goto-char (car range))
  12232. (re-search-forward
  12233. (concat "^[ \t]*:" property ":[ \t]*\\(.*[^ \t\r\n\f\v]\\)?")
  12234. (cdr range) t))
  12235. ;; Found the property, return it.
  12236. (if (match-end 1)
  12237. (if literal-nil
  12238. (org-match-string-no-properties 1)
  12239. (org-not-nil (org-match-string-no-properties 1)))
  12240. "")))))))
  12241. (defun org-property-or-variable-value (var &optional inherit)
  12242. "Check if there is a property fixing the value of VAR.
  12243. If yes, return this value. If not, return the current value of the variable."
  12244. (let ((prop (org-entry-get nil (symbol-name var) inherit)))
  12245. (if (and prop (stringp prop) (string-match "\\S-" prop))
  12246. (read prop)
  12247. (symbol-value var))))
  12248. (defun org-entry-delete (pom property)
  12249. "Delete the property PROPERTY from entry at point-or-marker POM."
  12250. (org-with-point-at pom
  12251. (if (member property org-special-properties)
  12252. nil ; cannot delete these properties.
  12253. (let ((range (org-get-property-block)))
  12254. (if (and range
  12255. (goto-char (car range))
  12256. (re-search-forward
  12257. (concat "^[ \t]*:" property ":[ \t]*\\(.*[^ \t\r\n\f\v]\\)")
  12258. (cdr range) t))
  12259. (progn
  12260. (delete-region (match-beginning 0) (1+ (point-at-eol)))
  12261. t)
  12262. nil)))))
  12263. ;; Multi-values properties are properties that contain multiple values
  12264. ;; These values are assumed to be single words, separated by whitespace.
  12265. (defun org-entry-add-to-multivalued-property (pom property value)
  12266. "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
  12267. (let* ((old (org-entry-get pom property))
  12268. (values (and old (org-split-string old "[ \t]"))))
  12269. (setq value (org-entry-protect-space value))
  12270. (unless (member value values)
  12271. (setq values (cons value values))
  12272. (org-entry-put pom property
  12273. (mapconcat 'identity values " ")))))
  12274. (defun org-entry-remove-from-multivalued-property (pom property value)
  12275. "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
  12276. (let* ((old (org-entry-get pom property))
  12277. (values (and old (org-split-string old "[ \t]"))))
  12278. (setq value (org-entry-protect-space value))
  12279. (when (member value values)
  12280. (setq values (delete value values))
  12281. (org-entry-put pom property
  12282. (mapconcat 'identity values " ")))))
  12283. (defun org-entry-member-in-multivalued-property (pom property value)
  12284. "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
  12285. (let* ((old (org-entry-get pom property))
  12286. (values (and old (org-split-string old "[ \t]"))))
  12287. (setq value (org-entry-protect-space value))
  12288. (member value values)))
  12289. (defun org-entry-get-multivalued-property (pom property)
  12290. "Return a list of values in a multivalued property."
  12291. (let* ((value (org-entry-get pom property))
  12292. (values (and value (org-split-string value "[ \t]"))))
  12293. (mapcar 'org-entry-restore-space values)))
  12294. (defun org-entry-put-multivalued-property (pom property &rest values)
  12295. "Set multivalued PROPERTY at point-or-marker POM to VALUES.
  12296. VALUES should be a list of strings. Spaces will be protected."
  12297. (org-entry-put pom property
  12298. (mapconcat 'org-entry-protect-space values " "))
  12299. (let* ((value (org-entry-get pom property))
  12300. (values (and value (org-split-string value "[ \t]"))))
  12301. (mapcar 'org-entry-restore-space values)))
  12302. (defun org-entry-protect-space (s)
  12303. "Protect spaces and newline in string S."
  12304. (while (string-match " " s)
  12305. (setq s (replace-match "%20" t t s)))
  12306. (while (string-match "\n" s)
  12307. (setq s (replace-match "%0A" t t s)))
  12308. s)
  12309. (defun org-entry-restore-space (s)
  12310. "Restore spaces and newline in string S."
  12311. (while (string-match "%20" s)
  12312. (setq s (replace-match " " t t s)))
  12313. (while (string-match "%0A" s)
  12314. (setq s (replace-match "\n" t t s)))
  12315. s)
  12316. (defvar org-entry-property-inherited-from (make-marker)
  12317. "Marker pointing to the entry from where a property was inherited.
  12318. Each call to `org-entry-get-with-inheritance' will set this marker to the
  12319. location of the entry where the inheritance search matched. If there was
  12320. no match, the marker will point nowhere.
  12321. Note that also `org-entry-get' calls this function, if the INHERIT flag
  12322. is set.")
  12323. (defun org-entry-get-with-inheritance (property &optional literal-nil)
  12324. "Get entry property, and search higher levels if not present.
  12325. The search will stop at the first ancestor which has the property defined.
  12326. If the value found is \"nil\", return nil to show that the property
  12327. should be considered as undefined (this is the meaning of nil here).
  12328. However, if LITERAL-NIL is set, return the string value \"nil\" instead."
  12329. (move-marker org-entry-property-inherited-from nil)
  12330. (let (tmp)
  12331. (save-excursion
  12332. (save-restriction
  12333. (widen)
  12334. (catch 'ex
  12335. (while t
  12336. (when (setq tmp (org-entry-get nil property nil 'literal-nil))
  12337. (org-back-to-heading t)
  12338. (move-marker org-entry-property-inherited-from (point))
  12339. (throw 'ex tmp))
  12340. (or (org-up-heading-safe) (throw 'ex nil)))))
  12341. (setq tmp (or tmp
  12342. (cdr (assoc property org-file-properties))
  12343. (cdr (assoc property org-global-properties))
  12344. (cdr (assoc property org-global-properties-fixed))))
  12345. (if literal-nil tmp (org-not-nil tmp)))))
  12346. (defvar org-property-changed-functions nil
  12347. "Hook called when the value of a property has changed.
  12348. Each hook function should accept two arguments, the name of the property
  12349. and the new value.")
  12350. (defun org-entry-put (pom property value)
  12351. "Set PROPERTY to VALUE for entry at point-or-marker POM."
  12352. (org-with-point-at pom
  12353. (org-back-to-heading t)
  12354. (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
  12355. range)
  12356. (cond
  12357. ((equal property "TODO")
  12358. (when (and (stringp value) (string-match "\\S-" value)
  12359. (not (member value org-todo-keywords-1)))
  12360. (error "\"%s\" is not a valid TODO state" value))
  12361. (if (or (not value)
  12362. (not (string-match "\\S-" value)))
  12363. (setq value 'none))
  12364. (org-todo value)
  12365. (org-set-tags nil 'align))
  12366. ((equal property "PRIORITY")
  12367. (org-priority (if (and value (stringp value) (string-match "\\S-" value))
  12368. (string-to-char value) ?\ ))
  12369. (org-set-tags nil 'align))
  12370. ((equal property "SCHEDULED")
  12371. (if (re-search-forward org-scheduled-time-regexp end t)
  12372. (cond
  12373. ((eq value 'earlier) (org-timestamp-change -1 'day))
  12374. ((eq value 'later) (org-timestamp-change 1 'day))
  12375. (t (call-interactively 'org-schedule)))
  12376. (call-interactively 'org-schedule)))
  12377. ((equal property "DEADLINE")
  12378. (if (re-search-forward org-deadline-time-regexp end t)
  12379. (cond
  12380. ((eq value 'earlier) (org-timestamp-change -1 'day))
  12381. ((eq value 'later) (org-timestamp-change 1 'day))
  12382. (t (call-interactively 'org-deadline)))
  12383. (call-interactively 'org-deadline)))
  12384. ((member property org-special-properties)
  12385. (error "The %s property can not yet be set with `org-entry-put'"
  12386. property))
  12387. (t ; a non-special property
  12388. (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
  12389. (setq range (org-get-property-block beg end 'force))
  12390. (goto-char (car range))
  12391. (if (re-search-forward
  12392. (concat "^[ \t]*:" property ":\\(.*\\)") (cdr range) t)
  12393. (progn
  12394. (delete-region (match-beginning 1) (match-end 1))
  12395. (goto-char (match-beginning 1)))
  12396. (goto-char (cdr range))
  12397. (insert "\n")
  12398. (backward-char 1)
  12399. (org-indent-line-function)
  12400. (insert ":" property ":"))
  12401. (and value (insert " " value))
  12402. (org-indent-line-function)))))
  12403. (run-hook-with-args 'org-property-changed-functions property value)))
  12404. (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
  12405. "Get all property keys in the current buffer.
  12406. With INCLUDE-SPECIALS, also list the special properties that reflect things
  12407. like tags and TODO state.
  12408. With INCLUDE-DEFAULTS, also include properties that has special meaning
  12409. internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
  12410. With INCLUDE-COLUMNS, also include property names given in COLUMN
  12411. formats in the current buffer."
  12412. (let (rtn range cfmt s p)
  12413. (save-excursion
  12414. (save-restriction
  12415. (widen)
  12416. (goto-char (point-min))
  12417. (while (re-search-forward org-property-start-re nil t)
  12418. (setq range (org-get-property-block))
  12419. (goto-char (car range))
  12420. (while (re-search-forward
  12421. (org-re "^[ \t]*:\\([-[:alnum:]_]+\\):")
  12422. (cdr range) t)
  12423. (add-to-list 'rtn (org-match-string-no-properties 1)))
  12424. (outline-next-heading))))
  12425. (when include-specials
  12426. (setq rtn (append org-special-properties rtn)))
  12427. (when include-defaults
  12428. (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
  12429. (add-to-list 'rtn org-effort-property))
  12430. (when include-columns
  12431. (save-excursion
  12432. (save-restriction
  12433. (widen)
  12434. (goto-char (point-min))
  12435. (while (re-search-forward
  12436. "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
  12437. nil t)
  12438. (setq cfmt (match-string 2) s 0)
  12439. (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
  12440. cfmt s)
  12441. (setq s (match-end 0)
  12442. p (match-string 1 cfmt))
  12443. (unless (or (equal p "ITEM")
  12444. (member p org-special-properties))
  12445. (add-to-list 'rtn (match-string 1 cfmt))))))))
  12446. (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
  12447. (defun org-property-values (key)
  12448. "Return a list of all values of property KEY."
  12449. (save-excursion
  12450. (save-restriction
  12451. (widen)
  12452. (goto-char (point-min))
  12453. (let ((re (concat "^[ \t]*:" key ":[ \t]*\\(\\S-.*\\)"))
  12454. values)
  12455. (while (re-search-forward re nil t)
  12456. (add-to-list 'values (org-trim (match-string 1))))
  12457. (delete "" values)))))
  12458. (defun org-insert-property-drawer ()
  12459. "Insert a property drawer into the current entry."
  12460. (interactive)
  12461. (org-back-to-heading t)
  12462. (looking-at outline-regexp)
  12463. (let ((indent (if org-adapt-indentation
  12464. (- (match-end 0)(match-beginning 0))
  12465. 0))
  12466. (beg (point))
  12467. (re (concat "^[ \t]*" org-keyword-time-regexp))
  12468. end hiddenp)
  12469. (outline-next-heading)
  12470. (setq end (point))
  12471. (goto-char beg)
  12472. (while (re-search-forward re end t))
  12473. (setq hiddenp (org-invisible-p))
  12474. (end-of-line 1)
  12475. (and (equal (char-after) ?\n) (forward-char 1))
  12476. (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
  12477. (if (member (match-string 1) '("CLOCK:" ":END:"))
  12478. ;; just skip this line
  12479. (beginning-of-line 2)
  12480. ;; Drawer start, find the end
  12481. (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
  12482. (beginning-of-line 1)))
  12483. (org-skip-over-state-notes)
  12484. (skip-chars-backward " \t\n\r")
  12485. (if (eq (char-before) ?*) (forward-char 1))
  12486. (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
  12487. (beginning-of-line 0)
  12488. (org-indent-to-column indent)
  12489. (beginning-of-line 2)
  12490. (org-indent-to-column indent)
  12491. (beginning-of-line 0)
  12492. (if hiddenp
  12493. (save-excursion
  12494. (org-back-to-heading t)
  12495. (hide-entry))
  12496. (org-flag-drawer t))))
  12497. (defun org-set-property (property value)
  12498. "In the current entry, set PROPERTY to VALUE.
  12499. When called interactively, this will prompt for a property name, offering
  12500. completion on existing and default properties. And then it will prompt
  12501. for a value, offering completion either on allowed values (via an inherited
  12502. xxx_ALL property) or on existing values in other instances of this property
  12503. in the current file."
  12504. (interactive
  12505. (let* ((completion-ignore-case t)
  12506. (keys (org-buffer-property-keys nil t t))
  12507. (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
  12508. (prop (if (member prop0 keys)
  12509. prop0
  12510. (or (cdr (assoc (downcase prop0)
  12511. (mapcar (lambda (x) (cons (downcase x) x))
  12512. keys)))
  12513. prop0)))
  12514. (cur (org-entry-get nil prop))
  12515. (prompt (concat prop " value"
  12516. (if (and cur (string-match "\\S-" cur))
  12517. (concat " [" cur "]") "") ": "))
  12518. (allowed (org-property-get-allowed-values nil prop 'table))
  12519. (existing (mapcar 'list (org-property-values prop)))
  12520. (val (if allowed
  12521. (org-completing-read prompt allowed nil
  12522. (not (get-text-property 0 'org-unrestricted
  12523. (caar allowed))))
  12524. (let (org-completion-use-ido org-completion-use-iswitchb)
  12525. (org-completing-read prompt existing nil nil "" nil cur)))))
  12526. (list prop (if (equal val "") cur val))))
  12527. (unless (equal (org-entry-get nil property) value)
  12528. (org-entry-put nil property value)))
  12529. (defun org-delete-property (property)
  12530. "In the current entry, delete PROPERTY."
  12531. (interactive
  12532. (let* ((completion-ignore-case t)
  12533. (prop (org-icompleting-read "Property: "
  12534. (org-entry-properties nil 'standard))))
  12535. (list prop)))
  12536. (message "Property %s %s" property
  12537. (if (org-entry-delete nil property)
  12538. "deleted"
  12539. "was not present in the entry")))
  12540. (defun org-delete-property-globally (property)
  12541. "Remove PROPERTY globally, from all entries."
  12542. (interactive
  12543. (let* ((completion-ignore-case t)
  12544. (prop (org-icompleting-read
  12545. "Globally remove property: "
  12546. (mapcar 'list (org-buffer-property-keys)))))
  12547. (list prop)))
  12548. (save-excursion
  12549. (save-restriction
  12550. (widen)
  12551. (goto-char (point-min))
  12552. (let ((cnt 0))
  12553. (while (re-search-forward
  12554. (concat "^[ \t]*:" (regexp-quote property) ":.*\n?")
  12555. nil t)
  12556. (setq cnt (1+ cnt))
  12557. (replace-match ""))
  12558. (message "Property \"%s\" removed from %d entries" property cnt)))))
  12559. (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
  12560. (defun org-compute-property-at-point ()
  12561. "Compute the property at point.
  12562. This looks for an enclosing column format, extracts the operator and
  12563. then applies it to the property in the column format's scope."
  12564. (interactive)
  12565. (unless (org-at-property-p)
  12566. (error "Not at a property"))
  12567. (let ((prop (org-match-string-no-properties 2)))
  12568. (org-columns-get-format-and-top-level)
  12569. (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
  12570. (error "No operator defined for property %s" prop))
  12571. (org-columns-compute prop)))
  12572. (defvar org-property-allowed-value-functions nil
  12573. "Hook for functions supplying allowed values for a specific property.
  12574. The functions must take a single argument, the name of the property, and
  12575. return a flat list of allowed values. If \":ETC\" is one of
  12576. the values, this means that these values are intended as defaults for
  12577. completion, but that other values should be allowed too.
  12578. The functions must return nil if they are not responsible for this
  12579. property.")
  12580. (defun org-property-get-allowed-values (pom property &optional table)
  12581. "Get allowed values for the property PROPERTY.
  12582. When TABLE is non-nil, return an alist that can directly be used for
  12583. completion."
  12584. (let (vals)
  12585. (cond
  12586. ((equal property "TODO")
  12587. (setq vals (org-with-point-at pom
  12588. (append org-todo-keywords-1 '("")))))
  12589. ((equal property "PRIORITY")
  12590. (let ((n org-lowest-priority))
  12591. (while (>= n org-highest-priority)
  12592. (push (char-to-string n) vals)
  12593. (setq n (1- n)))))
  12594. ((member property org-special-properties))
  12595. ((setq vals (run-hook-with-args-until-success
  12596. 'org-property-allowed-value-functions property)))
  12597. (t
  12598. (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
  12599. (when (and vals (string-match "\\S-" vals))
  12600. (setq vals (car (read-from-string (concat "(" vals ")"))))
  12601. (setq vals (mapcar (lambda (x)
  12602. (cond ((stringp x) x)
  12603. ((numberp x) (number-to-string x))
  12604. ((symbolp x) (symbol-name x))
  12605. (t "???")))
  12606. vals)))))
  12607. (when (member ":ETC" vals)
  12608. (setq vals (remove ":ETC" vals))
  12609. (org-add-props (car vals) '(org-unrestricted t)))
  12610. (if table (mapcar 'list vals) vals)))
  12611. (defun org-property-previous-allowed-value (&optional previous)
  12612. "Switch to the next allowed value for this property."
  12613. (interactive)
  12614. (org-property-next-allowed-value t))
  12615. (defun org-property-next-allowed-value (&optional previous)
  12616. "Switch to the next allowed value for this property."
  12617. (interactive)
  12618. (unless (org-at-property-p)
  12619. (error "Not at a property"))
  12620. (let* ((key (match-string 2))
  12621. (value (match-string 3))
  12622. (allowed (or (org-property-get-allowed-values (point) key)
  12623. (and (member value '("[ ]" "[-]" "[X]"))
  12624. '("[ ]" "[X]"))))
  12625. nval)
  12626. (unless allowed
  12627. (error "Allowed values for this property have not been defined"))
  12628. (if previous (setq allowed (reverse allowed)))
  12629. (if (member value allowed)
  12630. (setq nval (car (cdr (member value allowed)))))
  12631. (setq nval (or nval (car allowed)))
  12632. (if (equal nval value)
  12633. (error "Only one allowed value for this property"))
  12634. (org-at-property-p)
  12635. (replace-match (concat " :" key ": " nval) t t)
  12636. (org-indent-line-function)
  12637. (beginning-of-line 1)
  12638. (skip-chars-forward " \t")
  12639. (run-hook-with-args 'org-property-changed-functions key nval)))
  12640. (defun org-find-olp (path &optional this-buffer)
  12641. "Return a marker pointing to the entry at outline path OLP.
  12642. If anything goes wrong, throw an error.
  12643. You can wrap this call to cathc the error like this:
  12644. (condition-case msg
  12645. (org-mobile-locate-entry (match-string 4))
  12646. (error (nth 1 msg)))
  12647. The return value will then be either a string with the error message,
  12648. or a marker if everyhing is OK.
  12649. If THIS-BUFFER is set, the putline path does not contain a file,
  12650. only headings."
  12651. (let* ((file (if this-buffer buffer-file-name (pop path)))
  12652. (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
  12653. (level 1)
  12654. (lmin 1)
  12655. (lmax 1)
  12656. limit re end found pos heading cnt)
  12657. (unless buffer (error "File not found :%s" file))
  12658. (with-current-buffer buffer
  12659. (save-excursion
  12660. (save-restriction
  12661. (widen)
  12662. (setq limit (point-max))
  12663. (goto-char (point-min))
  12664. (while (setq heading (pop path))
  12665. (setq re (format org-complex-heading-regexp-format
  12666. (regexp-quote heading)))
  12667. (setq cnt 0 pos (point))
  12668. (while (re-search-forward re end t)
  12669. (setq level (- (match-end 1) (match-beginning 1)))
  12670. (if (and (>= level lmin) (<= level lmax))
  12671. (setq found (match-beginning 0) cnt (1+ cnt))))
  12672. (when (= cnt 0) (error "Heading not found on level %d: %s"
  12673. lmax heading))
  12674. (when (> cnt 1) (error "Heading not unique on level %d: %s"
  12675. lmax heading))
  12676. (goto-char found)
  12677. (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0)))
  12678. (setq end (save-excursion (org-end-of-subtree t t))))
  12679. (when (org-on-heading-p)
  12680. (move-marker (make-marker) (point))))))))
  12681. (defun org-find-entry-with-id (ident)
  12682. "Locate the entry that contains the ID property with exact value IDENT.
  12683. IDENT can be a string, a symbol or a number, this function will search for
  12684. the string representation of it.
  12685. Return the position where this entry starts, or nil if there is no such entry."
  12686. (interactive "sID: ")
  12687. (let ((id (cond
  12688. ((stringp ident) ident)
  12689. ((symbol-name ident) (symbol-name ident))
  12690. ((numberp ident) (number-to-string ident))
  12691. (t (error "IDENT %s must be a string, symbol or number" ident))))
  12692. (case-fold-search nil))
  12693. (save-excursion
  12694. (save-restriction
  12695. (widen)
  12696. (goto-char (point-min))
  12697. (when (re-search-forward
  12698. (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
  12699. nil t)
  12700. (org-back-to-heading t)
  12701. (point))))))
  12702. ;;;; Timestamps
  12703. (defvar org-last-changed-timestamp nil)
  12704. (defvar org-last-inserted-timestamp nil
  12705. "The last time stamp inserted with `org-insert-time-stamp'.")
  12706. (defvar org-time-was-given) ; dynamically scoped parameter
  12707. (defvar org-end-time-was-given) ; dynamically scoped parameter
  12708. (defvar org-ts-what) ; dynamically scoped parameter
  12709. (defun org-time-stamp (arg &optional inactive)
  12710. "Prompt for a date/time and insert a time stamp.
  12711. If the user specifies a time like HH:MM, or if this command is called
  12712. with a prefix argument, the time stamp will contain date and time.
  12713. Otherwise, only the date will be included. All parts of a date not
  12714. specified by the user will be filled in from the current date/time.
  12715. So if you press just return without typing anything, the time stamp
  12716. will represent the current date/time. If there is already a timestamp
  12717. at the cursor, it will be modified."
  12718. (interactive "P")
  12719. (let* ((ts nil)
  12720. (default-time
  12721. ;; Default time is either today, or, when entering a range,
  12722. ;; the range start.
  12723. (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
  12724. (save-excursion
  12725. (re-search-backward
  12726. (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
  12727. (- (point) 20) t)))
  12728. (apply 'encode-time (org-parse-time-string (match-string 1)))
  12729. (current-time)))
  12730. (default-input (and ts (org-get-compact-tod ts)))
  12731. org-time-was-given org-end-time-was-given time)
  12732. (cond
  12733. ((and (org-at-timestamp-p t)
  12734. (memq last-command '(org-time-stamp org-time-stamp-inactive))
  12735. (memq this-command '(org-time-stamp org-time-stamp-inactive)))
  12736. (insert "--")
  12737. (setq time (let ((this-command this-command))
  12738. (org-read-date arg 'totime nil nil
  12739. default-time default-input)))
  12740. (org-insert-time-stamp time (or org-time-was-given arg) inactive))
  12741. ((org-at-timestamp-p t)
  12742. (setq time (let ((this-command this-command))
  12743. (org-read-date arg 'totime nil nil default-time default-input)))
  12744. (when (org-at-timestamp-p t) ; just to get the match data
  12745. ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
  12746. (replace-match "")
  12747. (setq org-last-changed-timestamp
  12748. (org-insert-time-stamp
  12749. time (or org-time-was-given arg)
  12750. inactive nil nil (list org-end-time-was-given))))
  12751. (message "Timestamp updated"))
  12752. (t
  12753. (setq time (let ((this-command this-command))
  12754. (org-read-date arg 'totime nil nil default-time default-input)))
  12755. (org-insert-time-stamp time (or org-time-was-given arg) inactive
  12756. nil nil (list org-end-time-was-given))))))
  12757. ;; FIXME: can we use this for something else, like computing time differences?
  12758. (defun org-get-compact-tod (s)
  12759. (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
  12760. (let* ((t1 (match-string 1 s))
  12761. (h1 (string-to-number (match-string 2 s)))
  12762. (m1 (string-to-number (match-string 3 s)))
  12763. (t2 (and (match-end 4) (match-string 5 s)))
  12764. (h2 (and t2 (string-to-number (match-string 6 s))))
  12765. (m2 (and t2 (string-to-number (match-string 7 s))))
  12766. dh dm)
  12767. (if (not t2)
  12768. t1
  12769. (setq dh (- h2 h1) dm (- m2 m1))
  12770. (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
  12771. (concat t1 "+" (number-to-string dh)
  12772. (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
  12773. (defun org-time-stamp-inactive (&optional arg)
  12774. "Insert an inactive time stamp.
  12775. An inactive time stamp is enclosed in square brackets instead of angle
  12776. brackets. It is inactive in the sense that it does not trigger agenda entries,
  12777. does not link to the calendar and cannot be changed with the S-cursor keys.
  12778. So these are more for recording a certain time/date."
  12779. (interactive "P")
  12780. (org-time-stamp arg 'inactive))
  12781. (defvar org-date-ovl (make-overlay 1 1))
  12782. (overlay-put org-date-ovl 'face 'org-warning)
  12783. (org-detach-overlay org-date-ovl)
  12784. (defvar org-ans1) ; dynamically scoped parameter
  12785. (defvar org-ans2) ; dynamically scoped parameter
  12786. (defvar org-plain-time-of-day-regexp) ; defined below
  12787. (defvar org-overriding-default-time nil) ; dynamically scoped
  12788. (defvar org-read-date-overlay nil)
  12789. (defvar org-dcst nil) ; dynamically scoped
  12790. (defvar org-read-date-history nil)
  12791. (defvar org-read-date-final-answer nil)
  12792. (defun org-read-date (&optional with-time to-time from-string prompt
  12793. default-time default-input)
  12794. "Read a date, possibly a time, and make things smooth for the user.
  12795. The prompt will suggest to enter an ISO date, but you can also enter anything
  12796. which will at least partially be understood by `parse-time-string'.
  12797. Unrecognized parts of the date will default to the current day, month, year,
  12798. hour and minute. If this command is called to replace a timestamp at point,
  12799. of to enter the second timestamp of a range, the default time is taken
  12800. from the existing stamp. Furthermore, the command prefers the future,
  12801. so if you are giving a date where the year is not given, and the day-month
  12802. combination is already past in the current year, it will assume you
  12803. mean next year. For details, see the manual. A few examples:
  12804. 3-2-5 --> 2003-02-05
  12805. feb 15 --> currentyear-02-15
  12806. 2/15 --> currentyear-02-15
  12807. sep 12 9 --> 2009-09-12
  12808. 12:45 --> today 12:45
  12809. 22 sept 0:34 --> currentyear-09-22 0:34
  12810. 12 --> currentyear-currentmonth-12
  12811. Fri --> nearest Friday (today or later)
  12812. etc.
  12813. Furthermore you can specify a relative date by giving, as the *first* thing
  12814. in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
  12815. change in days weeks, months, years.
  12816. With a single plus or minus, the date is relative to today. With a double
  12817. plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
  12818. +4d --> four days from today
  12819. +4 --> same as above
  12820. +2w --> two weeks from today
  12821. ++5 --> five days from default date
  12822. The function understands only English month and weekday abbreviations,
  12823. but this can be configured with the variables `parse-time-months' and
  12824. `parse-time-weekdays'.
  12825. While prompting, a calendar is popped up - you can also select the
  12826. date with the mouse (button 1). The calendar shows a period of three
  12827. months. To scroll it to other months, use the keys `>' and `<'.
  12828. If you don't like the calendar, turn it off with
  12829. \(setq org-read-date-popup-calendar nil)
  12830. With optional argument TO-TIME, the date will immediately be converted
  12831. to an internal time.
  12832. With an optional argument WITH-TIME, the prompt will suggest to also
  12833. insert a time. Note that when WITH-TIME is not set, you can still
  12834. enter a time, and this function will inform the calling routine about
  12835. this change. The calling routine may then choose to change the format
  12836. used to insert the time stamp into the buffer to include the time.
  12837. With optional argument FROM-STRING, read from this string instead from
  12838. the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
  12839. the time/date that is used for everything that is not specified by the
  12840. user."
  12841. (require 'parse-time)
  12842. (let* ((org-time-stamp-rounding-minutes
  12843. (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
  12844. (org-dcst org-display-custom-times)
  12845. (ct (org-current-time))
  12846. (def (or org-overriding-default-time default-time ct))
  12847. (defdecode (decode-time def))
  12848. (dummy (progn
  12849. (when (< (nth 2 defdecode) org-extend-today-until)
  12850. (setcar (nthcdr 2 defdecode) -1)
  12851. (setcar (nthcdr 1 defdecode) 59)
  12852. (setq def (apply 'encode-time defdecode)
  12853. defdecode (decode-time def)))))
  12854. (calendar-frame-setup nil)
  12855. (calendar-setup nil)
  12856. (calendar-move-hook nil)
  12857. (calendar-view-diary-initially-flag nil)
  12858. (calendar-view-holidays-initially-flag nil)
  12859. (timestr (format-time-string
  12860. (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
  12861. (prompt (concat (if prompt (concat prompt " ") "")
  12862. (format "Date+time [%s]: " timestr)))
  12863. ans (org-ans0 "") org-ans1 org-ans2 final)
  12864. (cond
  12865. (from-string (setq ans from-string))
  12866. (org-read-date-popup-calendar
  12867. (save-excursion
  12868. (save-window-excursion
  12869. (calendar)
  12870. (calendar-forward-day (- (time-to-days def)
  12871. (calendar-absolute-from-gregorian
  12872. (calendar-current-date))))
  12873. (org-eval-in-calendar nil t)
  12874. (let* ((old-map (current-local-map))
  12875. (map (copy-keymap calendar-mode-map))
  12876. (minibuffer-local-map (copy-keymap minibuffer-local-map)))
  12877. (org-defkey map (kbd "RET") 'org-calendar-select)
  12878. (org-defkey map [mouse-1] 'org-calendar-select-mouse)
  12879. (org-defkey map [mouse-2] 'org-calendar-select-mouse)
  12880. (org-defkey minibuffer-local-map [(meta shift left)]
  12881. (lambda () (interactive)
  12882. (org-eval-in-calendar '(calendar-backward-month 1))))
  12883. (org-defkey minibuffer-local-map [(meta shift right)]
  12884. (lambda () (interactive)
  12885. (org-eval-in-calendar '(calendar-forward-month 1))))
  12886. (org-defkey minibuffer-local-map [(meta shift up)]
  12887. (lambda () (interactive)
  12888. (org-eval-in-calendar '(calendar-backward-year 1))))
  12889. (org-defkey minibuffer-local-map [(meta shift down)]
  12890. (lambda () (interactive)
  12891. (org-eval-in-calendar '(calendar-forward-year 1))))
  12892. (org-defkey minibuffer-local-map [?\e (shift left)]
  12893. (lambda () (interactive)
  12894. (org-eval-in-calendar '(calendar-backward-month 1))))
  12895. (org-defkey minibuffer-local-map [?\e (shift right)]
  12896. (lambda () (interactive)
  12897. (org-eval-in-calendar '(calendar-forward-month 1))))
  12898. (org-defkey minibuffer-local-map [?\e (shift up)]
  12899. (lambda () (interactive)
  12900. (org-eval-in-calendar '(calendar-backward-year 1))))
  12901. (org-defkey minibuffer-local-map [?\e (shift down)]
  12902. (lambda () (interactive)
  12903. (org-eval-in-calendar '(calendar-forward-year 1))))
  12904. (org-defkey minibuffer-local-map [(shift up)]
  12905. (lambda () (interactive)
  12906. (org-eval-in-calendar '(calendar-backward-week 1))))
  12907. (org-defkey minibuffer-local-map [(shift down)]
  12908. (lambda () (interactive)
  12909. (org-eval-in-calendar '(calendar-forward-week 1))))
  12910. (org-defkey minibuffer-local-map [(shift left)]
  12911. (lambda () (interactive)
  12912. (org-eval-in-calendar '(calendar-backward-day 1))))
  12913. (org-defkey minibuffer-local-map [(shift right)]
  12914. (lambda () (interactive)
  12915. (org-eval-in-calendar '(calendar-forward-day 1))))
  12916. (org-defkey minibuffer-local-map ">"
  12917. (lambda () (interactive)
  12918. (org-eval-in-calendar '(scroll-calendar-left 1))))
  12919. (org-defkey minibuffer-local-map "<"
  12920. (lambda () (interactive)
  12921. (org-eval-in-calendar '(scroll-calendar-right 1))))
  12922. (org-defkey minibuffer-local-map "\C-v"
  12923. (lambda () (interactive)
  12924. (org-eval-in-calendar
  12925. '(calendar-scroll-left-three-months 1))))
  12926. (org-defkey minibuffer-local-map "\M-v"
  12927. (lambda () (interactive)
  12928. (org-eval-in-calendar
  12929. '(calendar-scroll-right-three-months 1))))
  12930. (run-hooks 'org-read-date-minibuffer-setup-hook)
  12931. (unwind-protect
  12932. (progn
  12933. (use-local-map map)
  12934. (add-hook 'post-command-hook 'org-read-date-display)
  12935. (setq org-ans0 (read-string prompt default-input
  12936. 'org-read-date-history nil))
  12937. ;; org-ans0: from prompt
  12938. ;; org-ans1: from mouse click
  12939. ;; org-ans2: from calendar motion
  12940. (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
  12941. (remove-hook 'post-command-hook 'org-read-date-display)
  12942. (use-local-map old-map)
  12943. (when org-read-date-overlay
  12944. (delete-overlay org-read-date-overlay)
  12945. (setq org-read-date-overlay nil)))))))
  12946. (t ; Naked prompt only
  12947. (unwind-protect
  12948. (setq ans (read-string prompt default-input
  12949. 'org-read-date-history timestr))
  12950. (when org-read-date-overlay
  12951. (delete-overlay org-read-date-overlay)
  12952. (setq org-read-date-overlay nil)))))
  12953. (setq final (org-read-date-analyze ans def defdecode))
  12954. (setq org-read-date-final-answer ans)
  12955. (if to-time
  12956. (apply 'encode-time final)
  12957. (if (and (boundp 'org-time-was-given) org-time-was-given)
  12958. (format "%04d-%02d-%02d %02d:%02d"
  12959. (nth 5 final) (nth 4 final) (nth 3 final)
  12960. (nth 2 final) (nth 1 final))
  12961. (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
  12962. (defvar def)
  12963. (defvar defdecode)
  12964. (defvar with-time)
  12965. (defvar org-read-date-analyze-futurep nil)
  12966. (defun org-read-date-display ()
  12967. "Display the current date prompt interpretation in the minibuffer."
  12968. (when org-read-date-display-live
  12969. (when org-read-date-overlay
  12970. (delete-overlay org-read-date-overlay))
  12971. (let ((p (point)))
  12972. (end-of-line 1)
  12973. (while (not (equal (buffer-substring
  12974. (max (point-min) (- (point) 4)) (point))
  12975. " "))
  12976. (insert " "))
  12977. (goto-char p))
  12978. (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
  12979. " " (or org-ans1 org-ans2)))
  12980. (org-end-time-was-given nil)
  12981. (f (org-read-date-analyze ans def defdecode))
  12982. (fmts (if org-dcst
  12983. org-time-stamp-custom-formats
  12984. org-time-stamp-formats))
  12985. (fmt (if (or with-time
  12986. (and (boundp 'org-time-was-given) org-time-was-given))
  12987. (cdr fmts)
  12988. (car fmts)))
  12989. (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
  12990. (when (and org-end-time-was-given
  12991. (string-match org-plain-time-of-day-regexp txt))
  12992. (setq txt (concat (substring txt 0 (match-end 0)) "-"
  12993. org-end-time-was-given
  12994. (substring txt (match-end 0)))))
  12995. (when org-read-date-analyze-futurep
  12996. (setq txt (concat txt " (=>F)")))
  12997. (setq org-read-date-overlay
  12998. (make-overlay (1- (point-at-eol)) (point-at-eol)))
  12999. (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
  13000. (defun org-read-date-analyze (ans def defdecode)
  13001. "Analyse the combined answer of the date prompt."
  13002. ;; FIXME: cleanup and comment
  13003. (let ((nowdecode (decode-time (current-time)))
  13004. delta deltan deltaw deltadef year month day
  13005. hour minute second wday pm h2 m2 tl wday1
  13006. iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
  13007. (setq org-read-date-analyze-futurep nil)
  13008. (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
  13009. (setq ans "+0"))
  13010. (when (setq delta (org-read-date-get-relative ans (current-time) def))
  13011. (setq ans (replace-match "" t t ans)
  13012. deltan (car delta)
  13013. deltaw (nth 1 delta)
  13014. deltadef (nth 2 delta)))
  13015. ;; Check if there is an iso week date in there
  13016. ;; If yes, store the info and postpone interpreting it until the rest
  13017. ;; of the parsing is done
  13018. (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
  13019. (setq iso-year (if (match-end 1)
  13020. (org-small-year-to-year
  13021. (string-to-number (match-string 1 ans))))
  13022. iso-weekday (if (match-end 3)
  13023. (string-to-number (match-string 3 ans)))
  13024. iso-week (string-to-number (match-string 2 ans)))
  13025. (setq ans (replace-match "" t t ans)))
  13026. ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
  13027. (when (string-match
  13028. "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
  13029. (setq year (if (match-end 2)
  13030. (string-to-number (match-string 2 ans))
  13031. (progn (setq kill-year t)
  13032. (string-to-number (format-time-string "%Y"))))
  13033. month (string-to-number (match-string 3 ans))
  13034. day (string-to-number (match-string 4 ans)))
  13035. (if (< year 100) (setq year (+ 2000 year)))
  13036. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  13037. t nil ans)))
  13038. ;; Help matching american dates, like 5/30 or 5/30/7
  13039. (when (string-match
  13040. "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
  13041. (setq year (if (match-end 4)
  13042. (string-to-number (match-string 4 ans))
  13043. (progn (setq kill-year t)
  13044. (string-to-number (format-time-string "%Y"))))
  13045. month (string-to-number (match-string 1 ans))
  13046. day (string-to-number (match-string 2 ans)))
  13047. (if (< year 100) (setq year (+ 2000 year)))
  13048. (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
  13049. t nil ans)))
  13050. ;; Help matching am/pm times, because `parse-time-string' does not do that.
  13051. ;; If there is a time with am/pm, and *no* time without it, we convert
  13052. ;; so that matching will be successful.
  13053. (loop for i from 1 to 2 do ; twice, for end time as well
  13054. (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
  13055. (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
  13056. (setq hour (string-to-number (match-string 1 ans))
  13057. minute (if (match-end 3)
  13058. (string-to-number (match-string 3 ans))
  13059. 0)
  13060. pm (equal ?p
  13061. (string-to-char (downcase (match-string 4 ans)))))
  13062. (if (and (= hour 12) (not pm))
  13063. (setq hour 0)
  13064. (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
  13065. (setq ans (replace-match (format "%02d:%02d" hour minute)
  13066. t t ans))))
  13067. ;; Check if a time range is given as a duration
  13068. (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
  13069. (setq hour (string-to-number (match-string 1 ans))
  13070. h2 (+ hour (string-to-number (match-string 3 ans)))
  13071. minute (string-to-number (match-string 2 ans))
  13072. m2 (+ minute (if (match-end 5) (string-to-number
  13073. (match-string 5 ans))0)))
  13074. (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
  13075. (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
  13076. t t ans)))
  13077. ;; Check if there is a time range
  13078. (when (boundp 'org-end-time-was-given)
  13079. (setq org-time-was-given nil)
  13080. (when (and (string-match org-plain-time-of-day-regexp ans)
  13081. (match-end 8))
  13082. (setq org-end-time-was-given (match-string 8 ans))
  13083. (setq ans (concat (substring ans 0 (match-beginning 7))
  13084. (substring ans (match-end 7))))))
  13085. (setq tl (parse-time-string ans)
  13086. day (or (nth 3 tl) (nth 3 defdecode))
  13087. month (or (nth 4 tl)
  13088. (if (and org-read-date-prefer-future
  13089. (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
  13090. (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
  13091. (nth 4 defdecode)))
  13092. year (or (and (not kill-year) (nth 5 tl))
  13093. (if (and org-read-date-prefer-future
  13094. (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
  13095. (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
  13096. (nth 5 defdecode)))
  13097. hour (or (nth 2 tl) (nth 2 defdecode))
  13098. minute (or (nth 1 tl) (nth 1 defdecode))
  13099. second (or (nth 0 tl) 0)
  13100. wday (nth 6 tl))
  13101. (when (and (eq org-read-date-prefer-future 'time)
  13102. (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
  13103. (equal day (nth 3 nowdecode))
  13104. (equal month (nth 4 nowdecode))
  13105. (equal year (nth 5 nowdecode))
  13106. (nth 2 tl)
  13107. (or (< (nth 2 tl) (nth 2 nowdecode))
  13108. (and (= (nth 2 tl) (nth 2 nowdecode))
  13109. (nth 1 tl)
  13110. (< (nth 1 tl) (nth 1 nowdecode)))))
  13111. (setq day (1+ day)
  13112. futurep t))
  13113. ;; Special date definitions below
  13114. (cond
  13115. (iso-week
  13116. ;; There was an iso week
  13117. (require 'cal-iso)
  13118. (setq futurep nil)
  13119. (setq year (or iso-year year)
  13120. day (or iso-weekday wday 1)
  13121. wday nil ; to make sure that the trigger below does not match
  13122. iso-date (calendar-gregorian-from-absolute
  13123. (calendar-absolute-from-iso
  13124. (list iso-week day year))))
  13125. ; FIXME: Should we also push ISO weeks into the future?
  13126. ; (when (and org-read-date-prefer-future
  13127. ; (not iso-year)
  13128. ; (< (calendar-absolute-from-gregorian iso-date)
  13129. ; (time-to-days (current-time))))
  13130. ; (setq year (1+ year)
  13131. ; iso-date (calendar-gregorian-from-absolute
  13132. ; (calendar-absolute-from-iso
  13133. ; (list iso-week day year)))))
  13134. (setq month (car iso-date)
  13135. year (nth 2 iso-date)
  13136. day (nth 1 iso-date)))
  13137. (deltan
  13138. (setq futurep nil)
  13139. (unless deltadef
  13140. (let ((now (decode-time (current-time))))
  13141. (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
  13142. (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
  13143. ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
  13144. ((equal deltaw "m") (setq month (+ month deltan)))
  13145. ((equal deltaw "y") (setq year (+ year deltan)))))
  13146. ((and wday (not (nth 3 tl)))
  13147. (setq futurep nil)
  13148. ;; Weekday was given, but no day, so pick that day in the week
  13149. ;; on or after the derived date.
  13150. (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
  13151. (unless (equal wday wday1)
  13152. (setq day (+ day (% (- wday wday1 -7) 7))))))
  13153. (if (and (boundp 'org-time-was-given)
  13154. (nth 2 tl))
  13155. (setq org-time-was-given t))
  13156. (if (< year 100) (setq year (+ 2000 year)))
  13157. (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
  13158. (setq org-read-date-analyze-futurep futurep)
  13159. (list second minute hour day month year)))
  13160. (defvar parse-time-weekdays)
  13161. (defun org-read-date-get-relative (s today default)
  13162. "Check string S for special relative date string.
  13163. TODAY and DEFAULT are internal times, for today and for a default.
  13164. Return shift list (N what def-flag)
  13165. WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
  13166. N is the number of WHATs to shift.
  13167. DEF-FLAG is t when a double ++ or -- indicates shift relative to
  13168. the DEFAULT date rather than TODAY."
  13169. (when (and
  13170. (string-match
  13171. (concat
  13172. "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
  13173. "\\([0-9]+\\)?"
  13174. "\\([dwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
  13175. "\\([ \t]\\|$\\)") s)
  13176. (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
  13177. (let* ((dir (if (> (match-end 1) (match-beginning 1))
  13178. (string-to-char (substring (match-string 1 s) -1))
  13179. ?+))
  13180. (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
  13181. (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
  13182. (what (if (match-end 3) (match-string 3 s) "d"))
  13183. (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
  13184. (date (if rel default today))
  13185. (wday (nth 6 (decode-time date)))
  13186. delta)
  13187. (if wday1
  13188. (progn
  13189. (setq delta (mod (+ 7 (- wday1 wday)) 7))
  13190. (if (= dir ?-) (setq delta (- delta 7)))
  13191. (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
  13192. (list delta "d" rel))
  13193. (list (* n (if (= dir ?-) -1 1)) what rel)))))
  13194. (defun org-order-calendar-date-args (arg1 arg2 arg3)
  13195. "Turn a user-specified date into the internal representation.
  13196. The internal representation needed by the calendar is (month day year).
  13197. This is a wrapper to handle the brain-dead convention in calendar that
  13198. user function argument order change dependent on argument order."
  13199. (if (boundp 'calendar-date-style)
  13200. (cond
  13201. ((eq calendar-date-style 'american)
  13202. (list arg1 arg2 arg3))
  13203. ((eq calendar-date-style 'european)
  13204. (list arg2 arg1 arg3))
  13205. ((eq calendar-date-style 'iso)
  13206. (list arg2 arg3 arg1)))
  13207. (if (org-bound-and-true-p european-calendar-style)
  13208. (list arg2 arg1 arg3)
  13209. (list arg1 arg2 arg3))))
  13210. (defun org-eval-in-calendar (form &optional keepdate)
  13211. "Eval FORM in the calendar window and return to current window.
  13212. Also, store the cursor date in variable org-ans2."
  13213. (let ((sf (selected-frame))
  13214. (sw (selected-window)))
  13215. (select-window (get-buffer-window "*Calendar*" t))
  13216. (eval form)
  13217. (when (and (not keepdate) (calendar-cursor-to-date))
  13218. (let* ((date (calendar-cursor-to-date))
  13219. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  13220. (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
  13221. (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
  13222. (select-window sw)
  13223. (org-select-frame-set-input-focus sf)))
  13224. (defun org-calendar-select ()
  13225. "Return to `org-read-date' with the date currently selected.
  13226. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  13227. (interactive)
  13228. (when (calendar-cursor-to-date)
  13229. (let* ((date (calendar-cursor-to-date))
  13230. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  13231. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  13232. (if (active-minibuffer-window) (exit-minibuffer))))
  13233. (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
  13234. "Insert a date stamp for the date given by the internal TIME.
  13235. WITH-HM means use the stamp format that includes the time of the day.
  13236. INACTIVE means use square brackets instead of angular ones, so that the
  13237. stamp will not contribute to the agenda.
  13238. PRE and POST are optional strings to be inserted before and after the
  13239. stamp.
  13240. The command returns the inserted time stamp."
  13241. (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
  13242. stamp)
  13243. (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
  13244. (insert-before-markers (or pre ""))
  13245. (insert-before-markers (setq stamp (format-time-string fmt time)))
  13246. (when (listp extra)
  13247. (setq extra (car extra))
  13248. (if (and (stringp extra)
  13249. (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
  13250. (setq extra (format "-%02d:%02d"
  13251. (string-to-number (match-string 1 extra))
  13252. (string-to-number (match-string 2 extra))))
  13253. (setq extra nil)))
  13254. (when extra
  13255. (backward-char 1)
  13256. (insert-before-markers extra)
  13257. (forward-char 1))
  13258. (insert-before-markers (or post ""))
  13259. (setq org-last-inserted-timestamp stamp)))
  13260. (defun org-toggle-time-stamp-overlays ()
  13261. "Toggle the use of custom time stamp formats."
  13262. (interactive)
  13263. (setq org-display-custom-times (not org-display-custom-times))
  13264. (unless org-display-custom-times
  13265. (let ((p (point-min)) (bmp (buffer-modified-p)))
  13266. (while (setq p (next-single-property-change p 'display))
  13267. (if (and (get-text-property p 'display)
  13268. (eq (get-text-property p 'face) 'org-date))
  13269. (remove-text-properties
  13270. p (setq p (next-single-property-change p 'display))
  13271. '(display t))))
  13272. (set-buffer-modified-p bmp)))
  13273. (if (featurep 'xemacs)
  13274. (remove-text-properties (point-min) (point-max) '(end-glyph t)))
  13275. (org-restart-font-lock)
  13276. (setq org-table-may-need-update t)
  13277. (if org-display-custom-times
  13278. (message "Time stamps are overlayed with custom format")
  13279. (message "Time stamp overlays removed")))
  13280. (defun org-display-custom-time (beg end)
  13281. "Overlay modified time stamp format over timestamp between BEG and END."
  13282. (let* ((ts (buffer-substring beg end))
  13283. t1 w1 with-hm tf time str w2 (off 0))
  13284. (save-match-data
  13285. (setq t1 (org-parse-time-string ts t))
  13286. (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
  13287. (setq off (- (match-end 0) (match-beginning 0)))))
  13288. (setq end (- end off))
  13289. (setq w1 (- end beg)
  13290. with-hm (and (nth 1 t1) (nth 2 t1))
  13291. tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
  13292. time (org-fix-decoded-time t1)
  13293. str (org-add-props
  13294. (format-time-string
  13295. (substring tf 1 -1) (apply 'encode-time time))
  13296. nil 'mouse-face 'highlight)
  13297. w2 (length str))
  13298. (if (not (= w2 w1))
  13299. (add-text-properties (1+ beg) (+ 2 beg)
  13300. (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
  13301. (if (featurep 'xemacs)
  13302. (progn
  13303. (put-text-property beg end 'invisible t)
  13304. (put-text-property beg end 'end-glyph (make-glyph str)))
  13305. (put-text-property beg end 'display str))))
  13306. (defun org-translate-time (string)
  13307. "Translate all timestamps in STRING to custom format.
  13308. But do this only if the variable `org-display-custom-times' is set."
  13309. (when org-display-custom-times
  13310. (save-match-data
  13311. (let* ((start 0)
  13312. (re org-ts-regexp-both)
  13313. t1 with-hm inactive tf time str beg end)
  13314. (while (setq start (string-match re string start))
  13315. (setq beg (match-beginning 0)
  13316. end (match-end 0)
  13317. t1 (save-match-data
  13318. (org-parse-time-string (substring string beg end) t))
  13319. with-hm (and (nth 1 t1) (nth 2 t1))
  13320. inactive (equal (substring string beg (1+ beg)) "[")
  13321. tf (funcall (if with-hm 'cdr 'car)
  13322. org-time-stamp-custom-formats)
  13323. time (org-fix-decoded-time t1)
  13324. str (format-time-string
  13325. (concat
  13326. (if inactive "[" "<") (substring tf 1 -1)
  13327. (if inactive "]" ">"))
  13328. (apply 'encode-time time))
  13329. string (replace-match str t t string)
  13330. start (+ start (length str)))))))
  13331. string)
  13332. (defun org-fix-decoded-time (time)
  13333. "Set 0 instead of nil for the first 6 elements of time.
  13334. Don't touch the rest."
  13335. (let ((n 0))
  13336. (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
  13337. (defun org-days-to-time (timestamp-string)
  13338. "Difference between TIMESTAMP-STRING and now in days."
  13339. (- (time-to-days (org-time-string-to-time timestamp-string))
  13340. (time-to-days (current-time))))
  13341. (defun org-deadline-close (timestamp-string &optional ndays)
  13342. "Is the time in TIMESTAMP-STRING close to the current date?"
  13343. (setq ndays (or ndays (org-get-wdays timestamp-string)))
  13344. (and (< (org-days-to-time timestamp-string) ndays)
  13345. (not (org-entry-is-done-p))))
  13346. (defun org-get-wdays (ts)
  13347. "Get the deadline lead time appropriate for timestring TS."
  13348. (cond
  13349. ((<= org-deadline-warning-days 0)
  13350. ;; 0 or negative, enforce this value no matter what
  13351. (- org-deadline-warning-days))
  13352. ((string-match "-\\([0-9]+\\)\\([dwmy]\\)\\(\\'\\|>\\| \\)" ts)
  13353. ;; lead time is specified.
  13354. (floor (* (string-to-number (match-string 1 ts))
  13355. (cdr (assoc (match-string 2 ts)
  13356. '(("d" . 1) ("w" . 7)
  13357. ("m" . 30.4) ("y" . 365.25)))))))
  13358. ;; go for the default.
  13359. (t org-deadline-warning-days)))
  13360. (defun org-calendar-select-mouse (ev)
  13361. "Return to `org-read-date' with the date currently selected.
  13362. This is used by `org-read-date' in a temporary keymap for the calendar buffer."
  13363. (interactive "e")
  13364. (mouse-set-point ev)
  13365. (when (calendar-cursor-to-date)
  13366. (let* ((date (calendar-cursor-to-date))
  13367. (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  13368. (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
  13369. (if (active-minibuffer-window) (exit-minibuffer))))
  13370. (defun org-check-deadlines (ndays)
  13371. "Check if there are any deadlines due or past due.
  13372. A deadline is considered due if it happens within `org-deadline-warning-days'
  13373. days from today's date. If the deadline appears in an entry marked DONE,
  13374. it is not shown. The prefix arg NDAYS can be used to test that many
  13375. days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
  13376. (interactive "P")
  13377. (let* ((org-warn-days
  13378. (cond
  13379. ((equal ndays '(4)) 100000)
  13380. (ndays (prefix-numeric-value ndays))
  13381. (t (abs org-deadline-warning-days))))
  13382. (case-fold-search nil)
  13383. (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
  13384. (callback
  13385. (lambda () (org-deadline-close (match-string 1) org-warn-days))))
  13386. (message "%d deadlines past-due or due within %d days"
  13387. (org-occur regexp nil callback)
  13388. org-warn-days)))
  13389. (defun org-check-before-date (date)
  13390. "Check if there are deadlines or scheduled entries before DATE."
  13391. (interactive (list (org-read-date)))
  13392. (let ((case-fold-search nil)
  13393. (regexp (concat "\\<\\(" org-deadline-string
  13394. "\\|" org-scheduled-string
  13395. "\\) *<\\([^>]+\\)>"))
  13396. (callback
  13397. (lambda () (time-less-p
  13398. (org-time-string-to-time (match-string 2))
  13399. (org-time-string-to-time date)))))
  13400. (message "%d entries before %s"
  13401. (org-occur regexp nil callback) date)))
  13402. (defun org-check-after-date (date)
  13403. "Check if there are deadlines or scheduled entries after DATE."
  13404. (interactive (list (org-read-date)))
  13405. (let ((case-fold-search nil)
  13406. (regexp (concat "\\<\\(" org-deadline-string
  13407. "\\|" org-scheduled-string
  13408. "\\) *<\\([^>]+\\)>"))
  13409. (callback
  13410. (lambda () (not
  13411. (time-less-p
  13412. (org-time-string-to-time (match-string 2))
  13413. (org-time-string-to-time date))))))
  13414. (message "%d entries after %s"
  13415. (org-occur regexp nil callback) date)))
  13416. (defun org-evaluate-time-range (&optional to-buffer)
  13417. "Evaluate a time range by computing the difference between start and end.
  13418. Normally the result is just printed in the echo area, but with prefix arg
  13419. TO-BUFFER, the result is inserted just after the date stamp into the buffer.
  13420. If the time range is actually in a table, the result is inserted into the
  13421. next column.
  13422. For time difference computation, a year is assumed to be exactly 365
  13423. days in order to avoid rounding problems."
  13424. (interactive "P")
  13425. (or
  13426. (org-clock-update-time-maybe)
  13427. (save-excursion
  13428. (unless (org-at-date-range-p t)
  13429. (goto-char (point-at-bol))
  13430. (re-search-forward org-tr-regexp-both (point-at-eol) t))
  13431. (if (not (org-at-date-range-p t))
  13432. (error "Not at a time-stamp range, and none found in current line")))
  13433. (let* ((ts1 (match-string 1))
  13434. (ts2 (match-string 2))
  13435. (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
  13436. (match-end (match-end 0))
  13437. (time1 (org-time-string-to-time ts1))
  13438. (time2 (org-time-string-to-time ts2))
  13439. (t1 (org-float-time time1))
  13440. (t2 (org-float-time time2))
  13441. (diff (abs (- t2 t1)))
  13442. (negative (< (- t2 t1) 0))
  13443. ;; (ys (floor (* 365 24 60 60)))
  13444. (ds (* 24 60 60))
  13445. (hs (* 60 60))
  13446. (fy "%dy %dd %02d:%02d")
  13447. (fy1 "%dy %dd")
  13448. (fd "%dd %02d:%02d")
  13449. (fd1 "%dd")
  13450. (fh "%02d:%02d")
  13451. y d h m align)
  13452. (if havetime
  13453. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  13454. y 0
  13455. d (floor (/ diff ds)) diff (mod diff ds)
  13456. h (floor (/ diff hs)) diff (mod diff hs)
  13457. m (floor (/ diff 60)))
  13458. (setq ; y (floor (/ diff ys)) diff (mod diff ys)
  13459. y 0
  13460. d (floor (+ (/ diff ds) 0.5))
  13461. h 0 m 0))
  13462. (if (not to-buffer)
  13463. (message "%s" (org-make-tdiff-string y d h m))
  13464. (if (org-at-table-p)
  13465. (progn
  13466. (goto-char match-end)
  13467. (setq align t)
  13468. (and (looking-at " *|") (goto-char (match-end 0))))
  13469. (goto-char match-end))
  13470. (if (looking-at
  13471. "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
  13472. (replace-match ""))
  13473. (if negative (insert " -"))
  13474. (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
  13475. (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
  13476. (insert " " (format fh h m))))
  13477. (if align (org-table-align))
  13478. (message "Time difference inserted")))))
  13479. (defun org-make-tdiff-string (y d h m)
  13480. (let ((fmt "")
  13481. (l nil))
  13482. (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
  13483. l (push y l)))
  13484. (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
  13485. l (push d l)))
  13486. (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
  13487. l (push h l)))
  13488. (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
  13489. l (push m l)))
  13490. (apply 'format fmt (nreverse l))))
  13491. (defun org-time-string-to-time (s)
  13492. (apply 'encode-time (org-parse-time-string s)))
  13493. (defun org-time-string-to-seconds (s)
  13494. (org-float-time (org-time-string-to-time s)))
  13495. (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
  13496. "Convert a time stamp to an absolute day number.
  13497. If there is a specifyer for a cyclic time stamp, get the closest date to
  13498. DAYNR.
  13499. PREFER and SHOW-ALL are passed through to `org-closest-date'.
  13500. the variable date is bound by the calendar when this is called."
  13501. (let ((today (calendar-absolute-from-gregorian (calendar-current-date))))
  13502. (cond
  13503. ((and daynr (string-match "\\`%%\\((.*)\\)" s))
  13504. (if (org-diary-sexp-entry (match-string 1 s) "" date)
  13505. daynr
  13506. (+ daynr 1000)))
  13507. ((and daynr (not (eq daynr today)) (string-match "\\+[0-9]+[dwmy]" s))
  13508. (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
  13509. (time-to-days (current-time))) (match-string 0 s)
  13510. prefer show-all))
  13511. (t (time-to-days (apply 'encode-time (org-parse-time-string s)))))))
  13512. (defun org-days-to-iso-week (days)
  13513. "Return the iso week number."
  13514. (require 'cal-iso)
  13515. (car (calendar-iso-from-absolute days)))
  13516. (defun org-small-year-to-year (year)
  13517. "Convert 2-digit years into 4-digit years.
  13518. 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
  13519. The year 2000 cannot be abbreviated. Any year larger than 99
  13520. is returned unchanged."
  13521. (if (< year 38)
  13522. (setq year (+ 2000 year))
  13523. (if (< year 100)
  13524. (setq year (+ 1900 year))))
  13525. year)
  13526. (defun org-time-from-absolute (d)
  13527. "Return the time corresponding to date D.
  13528. D may be an absolute day number, or a calendar-type list (month day year)."
  13529. (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
  13530. (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
  13531. (defun org-calendar-holiday ()
  13532. "List of holidays, for Diary display in Org-mode."
  13533. (require 'holidays)
  13534. (let ((hl (funcall
  13535. (if (fboundp 'calendar-check-holidays)
  13536. 'calendar-check-holidays 'check-calendar-holidays) date)))
  13537. (if hl (mapconcat 'identity hl "; "))))
  13538. (defun org-diary-sexp-entry (sexp entry date)
  13539. "Process a SEXP diary ENTRY for DATE."
  13540. (require 'diary-lib)
  13541. (let ((result (if calendar-debug-sexp
  13542. (let ((stack-trace-on-error t))
  13543. (eval (car (read-from-string sexp))))
  13544. (condition-case nil
  13545. (eval (car (read-from-string sexp)))
  13546. (error
  13547. (beep)
  13548. (message "Bad sexp at line %d in %s: %s"
  13549. (org-current-line)
  13550. (buffer-file-name) sexp)
  13551. (sleep-for 2))))))
  13552. (cond ((stringp result) result)
  13553. ((and (consp result)
  13554. (stringp (cdr result))) (cdr result))
  13555. (result entry)
  13556. (t nil))))
  13557. (defun org-diary-to-ical-string (frombuf)
  13558. "Get iCalendar entries from diary entries in buffer FROMBUF.
  13559. This uses the icalendar.el library."
  13560. (let* ((tmpdir (if (featurep 'xemacs)
  13561. (temp-directory)
  13562. temporary-file-directory))
  13563. (tmpfile (make-temp-name
  13564. (expand-file-name "orgics" tmpdir)))
  13565. buf rtn b e)
  13566. (with-current-buffer frombuf
  13567. (icalendar-export-region (point-min) (point-max) tmpfile)
  13568. (setq buf (find-buffer-visiting tmpfile))
  13569. (set-buffer buf)
  13570. (goto-char (point-min))
  13571. (if (re-search-forward "^BEGIN:VEVENT" nil t)
  13572. (setq b (match-beginning 0)))
  13573. (goto-char (point-max))
  13574. (if (re-search-backward "^END:VEVENT" nil t)
  13575. (setq e (match-end 0)))
  13576. (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
  13577. (kill-buffer buf)
  13578. (delete-file tmpfile)
  13579. rtn))
  13580. (defun org-closest-date (start current change prefer show-all)
  13581. "Find the date closest to CURRENT that is consistent with START and CHANGE.
  13582. When PREFER is `past' return a date that is either CURRENT or past.
  13583. When PREFER is `future', return a date that is either CURRENT or future.
  13584. When SHOW-ALL is nil, only return the current occurrence of a time stamp."
  13585. ;; Make the proper lists from the dates
  13586. (catch 'exit
  13587. (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
  13588. dn dw sday cday n1 n2 n0
  13589. d m y y1 y2 date1 date2 nmonths nm ny m2)
  13590. (setq start (org-date-to-gregorian start)
  13591. current (org-date-to-gregorian
  13592. (if show-all
  13593. current
  13594. (time-to-days (current-time))))
  13595. sday (calendar-absolute-from-gregorian start)
  13596. cday (calendar-absolute-from-gregorian current))
  13597. (if (<= cday sday) (throw 'exit sday))
  13598. (if (string-match "\\(\\+[0-9]+\\)\\([dwmy]\\)" change)
  13599. (setq dn (string-to-number (match-string 1 change))
  13600. dw (cdr (assoc (match-string 2 change) a1)))
  13601. (error "Invalid change specifyer: %s" change))
  13602. (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
  13603. (cond
  13604. ((eq dw 'day)
  13605. (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
  13606. n2 (+ n1 dn)))
  13607. ((eq dw 'year)
  13608. (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
  13609. (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
  13610. (setq date1 (list m d y1)
  13611. n1 (calendar-absolute-from-gregorian date1)
  13612. date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
  13613. n2 (calendar-absolute-from-gregorian date2)))
  13614. ((eq dw 'month)
  13615. ;; approx number of month between the two dates
  13616. (setq nmonths (floor (/ (- cday sday) 30.436875)))
  13617. ;; How often does dn fit in there?
  13618. (setq d (nth 1 start) m (car start) y (nth 2 start)
  13619. nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
  13620. m (+ m nm)
  13621. ny (floor (/ m 12))
  13622. y (+ y ny)
  13623. m (- m (* ny 12)))
  13624. (while (> m 12) (setq m (- m 12) y (1+ y)))
  13625. (setq n1 (calendar-absolute-from-gregorian (list m d y)))
  13626. (setq m2 (+ m dn) y2 y)
  13627. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  13628. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
  13629. (while (<= n2 cday)
  13630. (setq n1 n2 m m2 y y2)
  13631. (setq m2 (+ m dn) y2 y)
  13632. (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
  13633. (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
  13634. ;; Make sure n1 is the earlier date
  13635. (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
  13636. (if show-all
  13637. (cond
  13638. ((eq prefer 'past) (if (= cday n2) n2 n1))
  13639. ((eq prefer 'future) (if (= cday n1) n1 n2))
  13640. (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
  13641. (cond
  13642. ((eq prefer 'past) (if (= cday n2) n2 n1))
  13643. ((eq prefer 'future) (if (= cday n1) n1 n2))
  13644. (t (if (= cday n1) n1 n2)))))))
  13645. (defun org-date-to-gregorian (date)
  13646. "Turn any specification of DATE into a gregorian date for the calendar."
  13647. (cond ((integerp date) (calendar-gregorian-from-absolute date))
  13648. ((and (listp date) (= (length date) 3)) date)
  13649. ((stringp date)
  13650. (setq date (org-parse-time-string date))
  13651. (list (nth 4 date) (nth 3 date) (nth 5 date)))
  13652. ((listp date)
  13653. (list (nth 4 date) (nth 3 date) (nth 5 date)))))
  13654. (defun org-parse-time-string (s &optional nodefault)
  13655. "Parse the standard Org-mode time string.
  13656. This should be a lot faster than the normal `parse-time-string'.
  13657. If time is not given, defaults to 0:00. However, with optional NODEFAULT,
  13658. hour and minute fields will be nil if not given."
  13659. (if (string-match org-ts-regexp0 s)
  13660. (list 0
  13661. (if (or (match-beginning 8) (not nodefault))
  13662. (string-to-number (or (match-string 8 s) "0")))
  13663. (if (or (match-beginning 7) (not nodefault))
  13664. (string-to-number (or (match-string 7 s) "0")))
  13665. (string-to-number (match-string 4 s))
  13666. (string-to-number (match-string 3 s))
  13667. (string-to-number (match-string 2 s))
  13668. nil nil nil)
  13669. (error "Not a standard Org-mode time string: %s" s)))
  13670. (defun org-timestamp-up (&optional arg)
  13671. "Increase the date item at the cursor by one.
  13672. If the cursor is on the year, change the year. If it is on the month or
  13673. the day, change that.
  13674. With prefix ARG, change by that many units."
  13675. (interactive "p")
  13676. (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
  13677. (defun org-timestamp-down (&optional arg)
  13678. "Decrease the date item at the cursor by one.
  13679. If the cursor is on the year, change the year. If it is on the month or
  13680. the day, change that.
  13681. With prefix ARG, change by that many units."
  13682. (interactive "p")
  13683. (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
  13684. (defun org-timestamp-up-day (&optional arg)
  13685. "Increase the date in the time stamp by one day.
  13686. With prefix ARG, change that many days."
  13687. (interactive "p")
  13688. (if (and (not (org-at-timestamp-p t))
  13689. (org-on-heading-p))
  13690. (org-todo 'up)
  13691. (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
  13692. (defun org-timestamp-down-day (&optional arg)
  13693. "Decrease the date in the time stamp by one day.
  13694. With prefix ARG, change that many days."
  13695. (interactive "p")
  13696. (if (and (not (org-at-timestamp-p t))
  13697. (org-on-heading-p))
  13698. (org-todo 'down)
  13699. (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
  13700. (defun org-at-timestamp-p (&optional inactive-ok)
  13701. "Determine if the cursor is in or at a timestamp."
  13702. (interactive)
  13703. (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
  13704. (pos (point))
  13705. (ans (or (looking-at tsr)
  13706. (save-excursion
  13707. (skip-chars-backward "^[<\n\r\t")
  13708. (if (> (point) (point-min)) (backward-char 1))
  13709. (and (looking-at tsr)
  13710. (> (- (match-end 0) pos) -1))))))
  13711. (and ans
  13712. (boundp 'org-ts-what)
  13713. (setq org-ts-what
  13714. (cond
  13715. ((= pos (match-beginning 0)) 'bracket)
  13716. ((= pos (1- (match-end 0))) 'bracket)
  13717. ((org-pos-in-match-range pos 2) 'year)
  13718. ((org-pos-in-match-range pos 3) 'month)
  13719. ((org-pos-in-match-range pos 7) 'hour)
  13720. ((org-pos-in-match-range pos 8) 'minute)
  13721. ((or (org-pos-in-match-range pos 4)
  13722. (org-pos-in-match-range pos 5)) 'day)
  13723. ((and (> pos (or (match-end 8) (match-end 5)))
  13724. (< pos (match-end 0)))
  13725. (- pos (or (match-end 8) (match-end 5))))
  13726. (t 'day))))
  13727. ans))
  13728. (defun org-toggle-timestamp-type ()
  13729. "Toggle the type (<active> or [inactive]) of a time stamp."
  13730. (interactive)
  13731. (when (org-at-timestamp-p t)
  13732. (let ((beg (match-beginning 0)) (end (match-end 0))
  13733. (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
  13734. (save-excursion
  13735. (goto-char beg)
  13736. (while (re-search-forward "[][<>]" end t)
  13737. (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
  13738. t t)))
  13739. (message "Timestamp is now %sactive"
  13740. (if (equal (char-after beg) ?<) "" "in")))))
  13741. (defun org-timestamp-change (n &optional what updown)
  13742. "Change the date in the time stamp at point.
  13743. The date will be changed by N times WHAT. WHAT can be `day', `month',
  13744. `year', `minute', `second'. If WHAT is not given, the cursor position
  13745. in the timestamp determines what will be changed."
  13746. (let ((pos (point))
  13747. with-hm inactive
  13748. (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
  13749. org-ts-what
  13750. extra rem
  13751. ts time time0)
  13752. (if (not (org-at-timestamp-p t))
  13753. (error "Not at a timestamp"))
  13754. (if (and (not what) (eq org-ts-what 'bracket))
  13755. (org-toggle-timestamp-type)
  13756. (if (and (not what) (not (eq org-ts-what 'day))
  13757. org-display-custom-times
  13758. (get-text-property (point) 'display)
  13759. (not (get-text-property (1- (point)) 'display)))
  13760. (setq org-ts-what 'day))
  13761. (setq org-ts-what (or what org-ts-what)
  13762. inactive (= (char-after (match-beginning 0)) ?\[)
  13763. ts (match-string 0))
  13764. (replace-match "")
  13765. (if (string-match
  13766. "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?[-+][0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)*\\)[]>]"
  13767. ts)
  13768. (setq extra (match-string 1 ts)))
  13769. (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
  13770. (setq with-hm t))
  13771. (setq time0 (org-parse-time-string ts))
  13772. (when (and updown
  13773. (eq org-ts-what 'minute)
  13774. (not current-prefix-arg))
  13775. ;; This looks like s-up and s-down. Change by one rounding step.
  13776. (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
  13777. (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
  13778. (setcar (cdr time0) (+ (nth 1 time0)
  13779. (if (> n 0) (- rem) (- dm rem))))))
  13780. (setq time
  13781. (encode-time (or (car time0) 0)
  13782. (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
  13783. (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
  13784. (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
  13785. (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
  13786. (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
  13787. (nthcdr 6 time0)))
  13788. (when (and (member org-ts-what '(hour minute))
  13789. extra
  13790. (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
  13791. (setq extra (org-modify-ts-extra
  13792. extra
  13793. (if (eq org-ts-what 'hour) 2 5)
  13794. n dm)))
  13795. (when (integerp org-ts-what)
  13796. (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
  13797. (if (eq what 'calendar)
  13798. (let ((cal-date (org-get-date-from-calendar)))
  13799. (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
  13800. (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
  13801. (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
  13802. (setcar time0 (or (car time0) 0))
  13803. (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
  13804. (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
  13805. (setq time (apply 'encode-time time0))))
  13806. (setq org-last-changed-timestamp
  13807. (org-insert-time-stamp time with-hm inactive nil nil extra))
  13808. (org-clock-update-time-maybe)
  13809. (goto-char pos)
  13810. ;; Try to recenter the calendar window, if any
  13811. (if (and org-calendar-follow-timestamp-change
  13812. (get-buffer-window "*Calendar*" t)
  13813. (memq org-ts-what '(day month year)))
  13814. (org-recenter-calendar (time-to-days time))))))
  13815. (defun org-modify-ts-extra (s pos n dm)
  13816. "Change the different parts of the lead-time and repeat fields in timestamp."
  13817. (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
  13818. ng h m new rem)
  13819. (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
  13820. (cond
  13821. ((or (org-pos-in-match-range pos 2)
  13822. (org-pos-in-match-range pos 3))
  13823. (setq m (string-to-number (match-string 3 s))
  13824. h (string-to-number (match-string 2 s)))
  13825. (if (org-pos-in-match-range pos 2)
  13826. (setq h (+ h n))
  13827. (setq n (* dm (org-no-warnings (signum n))))
  13828. (when (not (= 0 (setq rem (% m dm))))
  13829. (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
  13830. (setq m (+ m n)))
  13831. (if (< m 0) (setq m (+ m 60) h (1- h)))
  13832. (if (> m 59) (setq m (- m 60) h (1+ h)))
  13833. (setq h (min 24 (max 0 h)))
  13834. (setq ng 1 new (format "-%02d:%02d" h m)))
  13835. ((org-pos-in-match-range pos 6)
  13836. (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
  13837. ((org-pos-in-match-range pos 5)
  13838. (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
  13839. ((org-pos-in-match-range pos 9)
  13840. (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
  13841. ((org-pos-in-match-range pos 8)
  13842. (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
  13843. (when ng
  13844. (setq s (concat
  13845. (substring s 0 (match-beginning ng))
  13846. new
  13847. (substring s (match-end ng))))))
  13848. s))
  13849. (defun org-recenter-calendar (date)
  13850. "If the calendar is visible, recenter it to DATE."
  13851. (let* ((win (selected-window))
  13852. (cwin (get-buffer-window "*Calendar*" t))
  13853. (calendar-move-hook nil))
  13854. (when cwin
  13855. (select-window cwin)
  13856. (calendar-goto-date (if (listp date) date
  13857. (calendar-gregorian-from-absolute date)))
  13858. (select-window win))))
  13859. (defun org-goto-calendar (&optional arg)
  13860. "Go to the Emacs calendar at the current date.
  13861. If there is a time stamp in the current line, go to that date.
  13862. A prefix ARG can be used to force the current date."
  13863. (interactive "P")
  13864. (let ((tsr org-ts-regexp) diff
  13865. (calendar-move-hook nil)
  13866. (calendar-view-holidays-initially-flag nil)
  13867. (calendar-view-diary-initially-flag nil))
  13868. (if (or (org-at-timestamp-p)
  13869. (save-excursion
  13870. (beginning-of-line 1)
  13871. (looking-at (concat ".*" tsr))))
  13872. (let ((d1 (time-to-days (current-time)))
  13873. (d2 (time-to-days
  13874. (org-time-string-to-time (match-string 1)))))
  13875. (setq diff (- d2 d1))))
  13876. (calendar)
  13877. (calendar-goto-today)
  13878. (if (and diff (not arg)) (calendar-forward-day diff))))
  13879. (defun org-get-date-from-calendar ()
  13880. "Return a list (month day year) of date at point in calendar."
  13881. (with-current-buffer "*Calendar*"
  13882. (save-match-data
  13883. (calendar-cursor-to-date))))
  13884. (defun org-date-from-calendar ()
  13885. "Insert time stamp corresponding to cursor date in *Calendar* buffer.
  13886. If there is already a time stamp at the cursor position, update it."
  13887. (interactive)
  13888. (if (org-at-timestamp-p t)
  13889. (org-timestamp-change 0 'calendar)
  13890. (let ((cal-date (org-get-date-from-calendar)))
  13891. (org-insert-time-stamp
  13892. (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
  13893. (defun org-minutes-to-hh:mm-string (m)
  13894. "Compute H:MM from a number of minutes."
  13895. (let ((h (/ m 60)))
  13896. (setq m (- m (* 60 h)))
  13897. (format org-time-clocksum-format h m)))
  13898. (defun org-hh:mm-string-to-minutes (s)
  13899. "Convert a string H:MM to a number of minutes.
  13900. If the string is just a number, interpret it as minutes.
  13901. In fact, the first hh:mm or number in the string will be taken,
  13902. there can be extra stuff in the string.
  13903. If no number is found, the return value is 0."
  13904. (cond
  13905. ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
  13906. (+ (* (string-to-number (match-string 1 s)) 60)
  13907. (string-to-number (match-string 2 s))))
  13908. ((string-match "\\([0-9]+\\)" s)
  13909. (string-to-number (match-string 1 s)))
  13910. (t 0)))
  13911. ;;;; Files
  13912. (defun org-save-all-org-buffers ()
  13913. "Save all Org-mode buffers without user confirmation."
  13914. (interactive)
  13915. (message "Saving all Org-mode buffers...")
  13916. (save-some-buffers t 'org-mode-p)
  13917. (when (featurep 'org-id) (org-id-locations-save))
  13918. (message "Saving all Org-mode buffers... done"))
  13919. (defun org-revert-all-org-buffers ()
  13920. "Revert all Org-mode buffers.
  13921. Prompt for confirmation when there are unsaved changes.
  13922. Be sure you know what you are doing before letting this function
  13923. overwrite your changes.
  13924. This function is useful in a setup where one tracks org files
  13925. with a version control system, to revert on one machine after pulling
  13926. changes from another. I believe the procedure must be like this:
  13927. 1. M-x org-save-all-org-buffers
  13928. 2. Pull changes from the other machine, resolve conflicts
  13929. 3. M-x org-revert-all-org-buffers"
  13930. (interactive)
  13931. (unless (yes-or-no-p "Revert all Org buffers from their files? ")
  13932. (error "Abort"))
  13933. (save-excursion
  13934. (save-window-excursion
  13935. (mapc
  13936. (lambda (b)
  13937. (when (and (with-current-buffer b (org-mode-p))
  13938. (with-current-buffer b buffer-file-name))
  13939. (switch-to-buffer b)
  13940. (revert-buffer t 'no-confirm)))
  13941. (buffer-list))
  13942. (when (and (featurep 'org-id) org-id-track-globally)
  13943. (org-id-locations-load)))))
  13944. ;;;; Agenda files
  13945. ;;;###autoload
  13946. (defun org-switchb (&optional arg)
  13947. "Switch between Org buffers.
  13948. With a prefix argument, restrict available to files.
  13949. With two prefix arguments, restrict available buffers to agenda files.
  13950. Defaults to `iswitchb' for buffer name completion.
  13951. Set `org-completion-use-ido' to make it use ido instead."
  13952. (interactive "P")
  13953. (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
  13954. ((equal arg '(16)) (org-buffer-list 'agenda))
  13955. (t (org-buffer-list))))
  13956. (org-completion-use-iswitchb org-completion-use-iswitchb)
  13957. (org-completion-use-ido org-completion-use-ido))
  13958. (unless (or org-completion-use-ido org-completion-use-iswitchb)
  13959. (setq org-completion-use-iswitchb t))
  13960. (switch-to-buffer
  13961. (org-icompleting-read "Org buffer: "
  13962. (mapcar 'list (mapcar 'buffer-name blist))
  13963. nil t))))
  13964. ;;; Define some older names previously used for this functionality
  13965. ;;;###autoload
  13966. (defalias 'org-ido-switchb 'org-switchb)
  13967. ;;;###autoload
  13968. (defalias 'org-iswitchb 'org-switchb)
  13969. (defun org-buffer-list (&optional predicate exclude-tmp)
  13970. "Return a list of Org buffers.
  13971. PREDICATE can be `export', `files' or `agenda'.
  13972. export restrict the list to Export buffers.
  13973. files restrict the list to buffers visiting Org files.
  13974. agenda restrict the list to buffers visiting agenda files.
  13975. If EXCLUDE-TMP is non-nil, ignore temporary buffers."
  13976. (let* ((bfn nil)
  13977. (agenda-files (and (eq predicate 'agenda)
  13978. (mapcar 'file-truename (org-agenda-files t))))
  13979. (filter
  13980. (cond
  13981. ((eq predicate 'files)
  13982. (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
  13983. ((eq predicate 'export)
  13984. (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
  13985. ((eq predicate 'agenda)
  13986. (lambda (b)
  13987. (with-current-buffer b
  13988. (and (eq major-mode 'org-mode)
  13989. (setq bfn (buffer-file-name b))
  13990. (member (file-truename bfn) agenda-files)))))
  13991. (t (lambda (b) (with-current-buffer b
  13992. (or (eq major-mode 'org-mode)
  13993. (string-match "\*Org .*Export"
  13994. (buffer-name b)))))))))
  13995. (delq nil
  13996. (mapcar
  13997. (lambda(b)
  13998. (if (and (funcall filter b)
  13999. (or (not exclude-tmp)
  14000. (not (string-match "tmp" (buffer-name b)))))
  14001. b
  14002. nil))
  14003. (buffer-list)))))
  14004. (defun org-agenda-files (&optional unrestricted archives)
  14005. "Get the list of agenda files.
  14006. Optional UNRESTRICTED means return the full list even if a restriction
  14007. is currently in place.
  14008. When ARCHIVES is t, include all archive files that are really being
  14009. used by the agenda files. If ARCHIVE is `ifmode', do this only if
  14010. `org-agenda-archives-mode' is t."
  14011. (let ((files
  14012. (cond
  14013. ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
  14014. ((stringp org-agenda-files) (org-read-agenda-file-list))
  14015. ((listp org-agenda-files) org-agenda-files)
  14016. (t (error "Invalid value of `org-agenda-files'")))))
  14017. (setq files (apply 'append
  14018. (mapcar (lambda (f)
  14019. (if (file-directory-p f)
  14020. (directory-files
  14021. f t org-agenda-file-regexp)
  14022. (list f)))
  14023. files)))
  14024. (when org-agenda-skip-unavailable-files
  14025. (setq files (delq nil
  14026. (mapcar (function
  14027. (lambda (file)
  14028. (and (file-readable-p file) file)))
  14029. files))))
  14030. (when (or (eq archives t)
  14031. (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
  14032. (setq files (org-add-archive-files files)))
  14033. files))
  14034. (defun org-agenda-file-p (&optional file)
  14035. "Return non-nil, if FILE is an agenda file.
  14036. If FILE is omitted, use the file associated with the current
  14037. buffer."
  14038. (member (or file (buffer-file-name))
  14039. (org-agenda-files t)))
  14040. (defun org-edit-agenda-file-list ()
  14041. "Edit the list of agenda files.
  14042. Depending on setup, this either uses customize to edit the variable
  14043. `org-agenda-files', or it visits the file that is holding the list. In the
  14044. latter case, the buffer is set up in a way that saving it automatically kills
  14045. the buffer and restores the previous window configuration."
  14046. (interactive)
  14047. (if (stringp org-agenda-files)
  14048. (let ((cw (current-window-configuration)))
  14049. (find-file org-agenda-files)
  14050. (org-set-local 'org-window-configuration cw)
  14051. (org-add-hook 'after-save-hook
  14052. (lambda ()
  14053. (set-window-configuration
  14054. (prog1 org-window-configuration
  14055. (kill-buffer (current-buffer))))
  14056. (org-install-agenda-files-menu)
  14057. (message "New agenda file list installed"))
  14058. nil 'local)
  14059. (message "%s" (substitute-command-keys
  14060. "Edit list and finish with \\[save-buffer]")))
  14061. (customize-variable 'org-agenda-files)))
  14062. (defun org-store-new-agenda-file-list (list)
  14063. "Set new value for the agenda file list and save it correctly."
  14064. (if (stringp org-agenda-files)
  14065. (let ((fe (org-read-agenda-file-list t)) b u)
  14066. (while (setq b (find-buffer-visiting org-agenda-files))
  14067. (kill-buffer b))
  14068. (with-temp-file org-agenda-files
  14069. (insert
  14070. (mapconcat
  14071. (lambda (f) ;; Keep un-expanded entries.
  14072. (if (setq u (assoc f fe))
  14073. (cdr u)
  14074. f))
  14075. list "\n")
  14076. "\n")))
  14077. (let ((org-mode-hook nil) (org-inhibit-startup t)
  14078. (org-insert-mode-line-in-empty-file nil))
  14079. (setq org-agenda-files list)
  14080. (customize-save-variable 'org-agenda-files org-agenda-files))))
  14081. (defun org-read-agenda-file-list (&optional pair-with-expansion)
  14082. "Read the list of agenda files from a file.
  14083. If PAIR-WITH-EXPANSION is t return pairs with un-expanded
  14084. filenames, used by `org-store-new-agenda-file-list' to write back
  14085. un-expanded file names."
  14086. (when (file-directory-p org-agenda-files)
  14087. (error "`org-agenda-files' cannot be a single directory"))
  14088. (when (stringp org-agenda-files)
  14089. (with-temp-buffer
  14090. (insert-file-contents org-agenda-files)
  14091. (mapcar
  14092. (lambda (f)
  14093. (let ((e (expand-file-name (substitute-in-file-name f)
  14094. org-directory)))
  14095. (if pair-with-expansion
  14096. (cons e f)
  14097. e)))
  14098. (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
  14099. ;;;###autoload
  14100. (defun org-cycle-agenda-files ()
  14101. "Cycle through the files in `org-agenda-files'.
  14102. If the current buffer visits an agenda file, find the next one in the list.
  14103. If the current buffer does not, find the first agenda file."
  14104. (interactive)
  14105. (let* ((fs (org-agenda-files t))
  14106. (files (append fs (list (car fs))))
  14107. (tcf (if buffer-file-name (file-truename buffer-file-name)))
  14108. file)
  14109. (unless files (error "No agenda files"))
  14110. (catch 'exit
  14111. (while (setq file (pop files))
  14112. (if (equal (file-truename file) tcf)
  14113. (when (car files)
  14114. (find-file (car files))
  14115. (throw 'exit t))))
  14116. (find-file (car fs)))
  14117. (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
  14118. (defun org-agenda-file-to-front (&optional to-end)
  14119. "Move/add the current file to the top of the agenda file list.
  14120. If the file is not present in the list, it is added to the front. If it is
  14121. present, it is moved there. With optional argument TO-END, add/move to the
  14122. end of the list."
  14123. (interactive "P")
  14124. (let ((org-agenda-skip-unavailable-files nil)
  14125. (file-alist (mapcar (lambda (x)
  14126. (cons (file-truename x) x))
  14127. (org-agenda-files t)))
  14128. (ctf (file-truename buffer-file-name))
  14129. x had)
  14130. (setq x (assoc ctf file-alist) had x)
  14131. (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
  14132. (if to-end
  14133. (setq file-alist (append (delq x file-alist) (list x)))
  14134. (setq file-alist (cons x (delq x file-alist))))
  14135. (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
  14136. (org-install-agenda-files-menu)
  14137. (message "File %s to %s of agenda file list"
  14138. (if had "moved" "added") (if to-end "end" "front"))))
  14139. (defun org-remove-file (&optional file)
  14140. "Remove current file from the list of files in variable `org-agenda-files'.
  14141. These are the files which are being checked for agenda entries.
  14142. Optional argument FILE means use this file instead of the current."
  14143. (interactive)
  14144. (let* ((org-agenda-skip-unavailable-files nil)
  14145. (file (or file buffer-file-name))
  14146. (true-file (file-truename file))
  14147. (afile (abbreviate-file-name file))
  14148. (files (delq nil (mapcar
  14149. (lambda (x)
  14150. (if (equal true-file
  14151. (file-truename x))
  14152. nil x))
  14153. (org-agenda-files t)))))
  14154. (if (not (= (length files) (length (org-agenda-files t))))
  14155. (progn
  14156. (org-store-new-agenda-file-list files)
  14157. (org-install-agenda-files-menu)
  14158. (message "Removed file: %s" afile))
  14159. (message "File was not in list: %s (not removed)" afile))))
  14160. (defun org-file-menu-entry (file)
  14161. (vector file (list 'find-file file) t))
  14162. (defun org-check-agenda-file (file)
  14163. "Make sure FILE exists. If not, ask user what to do."
  14164. (when (not (file-exists-p file))
  14165. (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
  14166. (abbreviate-file-name file))
  14167. (let ((r (downcase (read-char-exclusive))))
  14168. (cond
  14169. ((equal r ?r)
  14170. (org-remove-file file)
  14171. (throw 'nextfile t))
  14172. (t (error "Abort"))))))
  14173. (defun org-get-agenda-file-buffer (file)
  14174. "Get a buffer visiting FILE. If the buffer needs to be created, add
  14175. it to the list of buffers which might be released later."
  14176. (let ((buf (org-find-base-buffer-visiting file)))
  14177. (if buf
  14178. buf ; just return it
  14179. ;; Make a new buffer and remember it
  14180. (setq buf (find-file-noselect file))
  14181. (if buf (push buf org-agenda-new-buffers))
  14182. buf)))
  14183. (defun org-release-buffers (blist)
  14184. "Release all buffers in list, asking the user for confirmation when needed.
  14185. When a buffer is unmodified, it is just killed. When modified, it is saved
  14186. \(if the user agrees) and then killed."
  14187. (let (buf file)
  14188. (while (setq buf (pop blist))
  14189. (setq file (buffer-file-name buf))
  14190. (when (and (buffer-modified-p buf)
  14191. file
  14192. (y-or-n-p (format "Save file %s? " file)))
  14193. (with-current-buffer buf (save-buffer)))
  14194. (kill-buffer buf))))
  14195. (defun org-prepare-agenda-buffers (files)
  14196. "Create buffers for all agenda files, protect archived trees and comments."
  14197. (interactive)
  14198. (let ((pa '(:org-archived t))
  14199. (pc '(:org-comment t))
  14200. (pall '(:org-archived t :org-comment t))
  14201. (inhibit-read-only t)
  14202. (rea (concat ":" org-archive-tag ":"))
  14203. bmp file re)
  14204. (save-excursion
  14205. (save-restriction
  14206. (while (setq file (pop files))
  14207. (catch 'nextfile
  14208. (if (bufferp file)
  14209. (set-buffer file)
  14210. (org-check-agenda-file file)
  14211. (set-buffer (org-get-agenda-file-buffer file)))
  14212. (widen)
  14213. (setq bmp (buffer-modified-p))
  14214. (org-refresh-category-properties)
  14215. (setq org-todo-keywords-for-agenda
  14216. (append org-todo-keywords-for-agenda org-todo-keywords-1))
  14217. (setq org-done-keywords-for-agenda
  14218. (append org-done-keywords-for-agenda org-done-keywords))
  14219. (setq org-todo-keyword-alist-for-agenda
  14220. (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
  14221. (setq org-drawers-for-agenda
  14222. (append org-drawers-for-agenda org-drawers))
  14223. (setq org-tag-alist-for-agenda
  14224. (append org-tag-alist-for-agenda org-tag-alist))
  14225. (save-excursion
  14226. (remove-text-properties (point-min) (point-max) pall)
  14227. (when org-agenda-skip-archived-trees
  14228. (goto-char (point-min))
  14229. (while (re-search-forward rea nil t)
  14230. (if (org-on-heading-p t)
  14231. (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
  14232. (goto-char (point-min))
  14233. (setq re (concat "^\\*+ +" org-comment-string "\\>"))
  14234. (while (re-search-forward re nil t)
  14235. (add-text-properties
  14236. (match-beginning 0) (org-end-of-subtree t) pc)))
  14237. (set-buffer-modified-p bmp)))))
  14238. (setq org-todo-keywords-for-agenda
  14239. (org-uniquify org-todo-keywords-for-agenda))
  14240. (setq org-todo-keyword-alist-for-agenda
  14241. (org-uniquify org-todo-keyword-alist-for-agenda)
  14242. org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
  14243. ;;;; Embedded LaTeX
  14244. (defvar org-cdlatex-mode-map (make-sparse-keymap)
  14245. "Keymap for the minor `org-cdlatex-mode'.")
  14246. (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
  14247. (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
  14248. (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
  14249. (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
  14250. (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
  14251. (defvar org-cdlatex-texmathp-advice-is-done nil
  14252. "Flag remembering if we have applied the advice to texmathp already.")
  14253. (define-minor-mode org-cdlatex-mode
  14254. "Toggle the minor `org-cdlatex-mode'.
  14255. This mode supports entering LaTeX environment and math in LaTeX fragments
  14256. in Org-mode.
  14257. \\{org-cdlatex-mode-map}"
  14258. nil " OCDL" nil
  14259. (when org-cdlatex-mode (require 'cdlatex))
  14260. (unless org-cdlatex-texmathp-advice-is-done
  14261. (setq org-cdlatex-texmathp-advice-is-done t)
  14262. (defadvice texmathp (around org-math-always-on activate)
  14263. "Always return t in org-mode buffers.
  14264. This is because we want to insert math symbols without dollars even outside
  14265. the LaTeX math segments. If Orgmode thinks that point is actually inside
  14266. an embedded LaTeX fragment, let texmathp do its job.
  14267. \\[org-cdlatex-mode-map]"
  14268. (interactive)
  14269. (let (p)
  14270. (cond
  14271. ((not (org-mode-p)) ad-do-it)
  14272. ((eq this-command 'cdlatex-math-symbol)
  14273. (setq ad-return-value t
  14274. texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
  14275. (t
  14276. (let ((p (org-inside-LaTeX-fragment-p)))
  14277. (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
  14278. (setq ad-return-value t
  14279. texmathp-why '("Org-mode embedded math" . 0))
  14280. (if p ad-do-it)))))))))
  14281. (defun turn-on-org-cdlatex ()
  14282. "Unconditionally turn on `org-cdlatex-mode'."
  14283. (org-cdlatex-mode 1))
  14284. (defun org-inside-LaTeX-fragment-p ()
  14285. "Test if point is inside a LaTeX fragment.
  14286. I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
  14287. sequence appearing also before point.
  14288. Even though the matchers for math are configurable, this function assumes
  14289. that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
  14290. delimiters are skipped when they have been removed by customization.
  14291. The return value is nil, or a cons cell with the delimiter and
  14292. and the position of this delimiter.
  14293. This function does a reasonably good job, but can locally be fooled by
  14294. for example currency specifications. For example it will assume being in
  14295. inline math after \"$22.34\". The LaTeX fragment formatter will only format
  14296. fragments that are properly closed, but during editing, we have to live
  14297. with the uncertainty caused by missing closing delimiters. This function
  14298. looks only before point, not after."
  14299. (catch 'exit
  14300. (let ((pos (point))
  14301. (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
  14302. (lim (progn
  14303. (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
  14304. (point)))
  14305. dd-on str (start 0) m re)
  14306. (goto-char pos)
  14307. (when dodollar
  14308. (setq str (concat (buffer-substring lim (point)) "\000 X$.")
  14309. re (nth 1 (assoc "$" org-latex-regexps)))
  14310. (while (string-match re str start)
  14311. (cond
  14312. ((= (match-end 0) (length str))
  14313. (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
  14314. ((= (match-end 0) (- (length str) 5))
  14315. (throw 'exit nil))
  14316. (t (setq start (match-end 0))))))
  14317. (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
  14318. (goto-char pos)
  14319. (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
  14320. (and (match-beginning 2) (throw 'exit nil))
  14321. ;; count $$
  14322. (while (re-search-backward "\\$\\$" lim t)
  14323. (setq dd-on (not dd-on)))
  14324. (goto-char pos)
  14325. (if dd-on (cons "$$" m))))))
  14326. (defun org-inside-latex-macro-p ()
  14327. "Is point inside a LaTeX macro or its arguments?"
  14328. (save-match-data
  14329. (org-in-regexp
  14330. "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
  14331. (defun org-try-cdlatex-tab ()
  14332. "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
  14333. It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
  14334. - inside a LaTeX fragment, or
  14335. - after the first word in a line, where an abbreviation expansion could
  14336. insert a LaTeX environment."
  14337. (when org-cdlatex-mode
  14338. (cond
  14339. ((save-excursion
  14340. (skip-chars-backward "a-zA-Z0-9*")
  14341. (skip-chars-backward " \t")
  14342. (bolp))
  14343. (cdlatex-tab) t)
  14344. ((org-inside-LaTeX-fragment-p)
  14345. (cdlatex-tab) t)
  14346. (t nil))))
  14347. (defun org-cdlatex-underscore-caret (&optional arg)
  14348. "Execute `cdlatex-sub-superscript' in LaTeX fragments.
  14349. Revert to the normal definition outside of these fragments."
  14350. (interactive "P")
  14351. (if (org-inside-LaTeX-fragment-p)
  14352. (call-interactively 'cdlatex-sub-superscript)
  14353. (let (org-cdlatex-mode)
  14354. (call-interactively (key-binding (vector last-input-event))))))
  14355. (defun org-cdlatex-math-modify (&optional arg)
  14356. "Execute `cdlatex-math-modify' in LaTeX fragments.
  14357. Revert to the normal definition outside of these fragments."
  14358. (interactive "P")
  14359. (if (org-inside-LaTeX-fragment-p)
  14360. (call-interactively 'cdlatex-math-modify)
  14361. (let (org-cdlatex-mode)
  14362. (call-interactively (key-binding (vector last-input-event))))))
  14363. (defvar org-latex-fragment-image-overlays nil
  14364. "List of overlays carrying the images of latex fragments.")
  14365. (make-variable-buffer-local 'org-latex-fragment-image-overlays)
  14366. (defun org-remove-latex-fragment-image-overlays ()
  14367. "Remove all overlays with LaTeX fragment images in current buffer."
  14368. (mapc 'delete-overlay org-latex-fragment-image-overlays)
  14369. (setq org-latex-fragment-image-overlays nil))
  14370. (defun org-preview-latex-fragment (&optional subtree)
  14371. "Preview the LaTeX fragment at point, or all locally or globally.
  14372. If the cursor is in a LaTeX fragment, create the image and overlay
  14373. it over the source code. If there is no fragment at point, display
  14374. all fragments in the current text, from one headline to the next. With
  14375. prefix SUBTREE, display all fragments in the current subtree. With a
  14376. double prefix `C-u C-u', or when the cursor is before the first headline,
  14377. display all fragments in the buffer.
  14378. The images can be removed again with \\[org-ctrl-c-ctrl-c]."
  14379. (interactive "P")
  14380. (org-remove-latex-fragment-image-overlays)
  14381. (save-excursion
  14382. (save-restriction
  14383. (let (beg end at msg)
  14384. (cond
  14385. ((or (equal subtree '(16))
  14386. (not (save-excursion
  14387. (re-search-backward (concat "^" outline-regexp) nil t))))
  14388. (setq beg (point-min) end (point-max)
  14389. msg "Creating images for buffer...%s"))
  14390. ((equal subtree '(4))
  14391. (org-back-to-heading)
  14392. (setq beg (point) end (org-end-of-subtree t)
  14393. msg "Creating images for subtree...%s"))
  14394. (t
  14395. (if (setq at (org-inside-LaTeX-fragment-p))
  14396. (goto-char (max (point-min) (- (cdr at) 2)))
  14397. (org-back-to-heading))
  14398. (setq beg (point) end (progn (outline-next-heading) (point))
  14399. msg (if at "Creating image...%s"
  14400. "Creating images for entry...%s"))))
  14401. (message msg "")
  14402. (narrow-to-region beg end)
  14403. (goto-char beg)
  14404. (org-format-latex
  14405. (concat "ltxpng/" (file-name-sans-extension
  14406. (file-name-nondirectory
  14407. buffer-file-name)))
  14408. default-directory 'overlays msg at 'forbuffer)
  14409. (message msg "done. Use `C-c C-c' to remove images.")))))
  14410. (defvar org-latex-regexps
  14411. '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
  14412. ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
  14413. ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
  14414. ("$1" "\\([^$]\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  14415. ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
  14416. ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
  14417. ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
  14418. ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
  14419. "Regular expressions for matching embedded LaTeX.")
  14420. (defun org-format-latex (prefix &optional dir overlays msg at
  14421. forbuffer protect-only)
  14422. "Replace LaTeX fragments with links to an image, and produce images.
  14423. Some of the options can be changed using the variable
  14424. `org-format-latex-options'."
  14425. (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
  14426. (let* ((prefixnodir (file-name-nondirectory prefix))
  14427. (absprefix (expand-file-name prefix dir))
  14428. (todir (file-name-directory absprefix))
  14429. (opt org-format-latex-options)
  14430. (matchers (plist-get opt :matchers))
  14431. (re-list org-latex-regexps)
  14432. (org-format-latex-header-extra
  14433. (plist-get (org-infile-export-plist) :latex-header-extra))
  14434. (cnt 0) txt hash link beg end re e checkdir
  14435. executables-checked
  14436. m n block linkfile movefile ov)
  14437. ;; Check the different regular expressions
  14438. (while (setq e (pop re-list))
  14439. (setq m (car e) re (nth 1 e) n (nth 2 e)
  14440. block (if (nth 3 e) "\n\n" ""))
  14441. (when (member m matchers)
  14442. (goto-char (point-min))
  14443. (while (re-search-forward re nil t)
  14444. (when (and (or (not at) (equal (cdr at) (match-beginning n)))
  14445. (not (get-text-property (match-beginning n)
  14446. 'org-protected))
  14447. (or (not overlays)
  14448. (not (eq (get-char-property (match-beginning n)
  14449. 'org-overlay-type)
  14450. 'org-latex-overlay))))
  14451. (if protect-only
  14452. (add-text-properties (match-beginning n) (match-end n)
  14453. '(org-protected t))
  14454. (setq txt (match-string n)
  14455. beg (match-beginning n) end (match-end n)
  14456. cnt (1+ cnt))
  14457. (let (print-length print-level) ; make sure full list is printed
  14458. (setq hash (sha1 (prin1-to-string
  14459. (list org-format-latex-header
  14460. org-format-latex-header-extra
  14461. org-export-latex-default-packages-alist
  14462. org-export-latex-packages-alist
  14463. org-format-latex-options
  14464. forbuffer txt)))
  14465. linkfile (format "%s_%s.png" prefix hash)
  14466. movefile (format "%s_%s.png" absprefix hash)))
  14467. (setq link (concat block "[[file:" linkfile "]]" block))
  14468. (if msg (message msg cnt))
  14469. (goto-char beg)
  14470. (unless checkdir ; make sure the directory exists
  14471. (setq checkdir t)
  14472. (or (file-directory-p todir) (make-directory todir)))
  14473. (unless executables-checked
  14474. (org-check-external-command
  14475. "latex" "needed to convert LaTeX fragments to images")
  14476. (org-check-external-command
  14477. "dvipng" "needed to convert LaTeX fragments to images")
  14478. (setq executables-checked t))
  14479. (unless (file-exists-p movefile)
  14480. (org-create-formula-image
  14481. txt movefile opt forbuffer))
  14482. (if overlays
  14483. (progn
  14484. (mapc (lambda (o)
  14485. (if (eq (overlay-get o 'org-overlay-type)
  14486. 'org-latex-overlay)
  14487. (delete-overlay o)))
  14488. (overlays-in beg end))
  14489. (setq ov (make-overlay beg end))
  14490. (overlay-put ov 'org-overlay-type 'org-latex-overlay)
  14491. (if (featurep 'xemacs)
  14492. (progn
  14493. (overlay-put ov 'invisible t)
  14494. (overlay-put
  14495. ov 'end-glyph
  14496. (make-glyph (vector 'png :file movefile))))
  14497. (overlay-put
  14498. ov 'display
  14499. (list 'image :type 'png :file movefile :ascent 'center)))
  14500. (push ov org-latex-fragment-image-overlays)
  14501. (goto-char end))
  14502. (delete-region beg end)
  14503. (insert (org-add-props link
  14504. (list 'org-latex-src
  14505. (replace-regexp-in-string "\"" "" txt))))))))))))
  14506. ;; This function borrows from Ganesh Swami's latex2png.el
  14507. (defun org-create-formula-image (string tofile options buffer)
  14508. "This calls dvipng."
  14509. (require 'org-latex)
  14510. (let* ((tmpdir (if (featurep 'xemacs)
  14511. (temp-directory)
  14512. temporary-file-directory))
  14513. (texfilebase (make-temp-name
  14514. (expand-file-name "orgtex" tmpdir)))
  14515. (texfile (concat texfilebase ".tex"))
  14516. (dvifile (concat texfilebase ".dvi"))
  14517. (pngfile (concat texfilebase ".png"))
  14518. (fnh (if (featurep 'xemacs)
  14519. (font-height (get-face-font 'default))
  14520. (face-attribute 'default :height nil)))
  14521. (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
  14522. (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
  14523. (fg (or (plist-get options (if buffer :foreground :html-foreground))
  14524. "Black"))
  14525. (bg (or (plist-get options (if buffer :background :html-background))
  14526. "Transparent")))
  14527. (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
  14528. (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
  14529. (with-temp-file texfile
  14530. (insert (org-splice-latex-header
  14531. org-format-latex-header
  14532. org-export-latex-default-packages-alist
  14533. org-export-latex-packages-alist t
  14534. org-format-latex-header-extra))
  14535. (insert "\n\\begin{document}\n" string "\n\\end{document}\n")
  14536. (require 'org-latex)
  14537. (org-export-latex-fix-inputenc))
  14538. (let ((dir default-directory))
  14539. (condition-case nil
  14540. (progn
  14541. (cd tmpdir)
  14542. (call-process "latex" nil nil nil texfile))
  14543. (error nil))
  14544. (cd dir))
  14545. (if (not (file-exists-p dvifile))
  14546. (progn (message "Failed to create dvi file from %s" texfile) nil)
  14547. (condition-case nil
  14548. (call-process "dvipng" nil nil nil
  14549. "-fg" fg "-bg" bg
  14550. "-D" dpi
  14551. ;;"-x" scale "-y" scale
  14552. "-T" "tight"
  14553. "-o" pngfile
  14554. dvifile)
  14555. (error nil))
  14556. (if (not (file-exists-p pngfile))
  14557. (if org-format-latex-signal-error
  14558. (error "Failed to create png file from %s" texfile)
  14559. (message "Failed to create png file from %s" texfile)
  14560. nil)
  14561. ;; Use the requested file name and clean up
  14562. (copy-file pngfile tofile 'replace)
  14563. (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
  14564. (delete-file (concat texfilebase e)))
  14565. pngfile))))
  14566. (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
  14567. "Fill a LaTeX header template TPL.
  14568. In the template, the following place holders will be recognized:
  14569. [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
  14570. [NO-DEFAULT-PACKAGES] do not include DEF-PKG
  14571. [PACKAGES] \\usepackage statements for PKG
  14572. [NO-PACKAGES] do not include PKG
  14573. [EXTRA] the string EXTRA
  14574. [NO-EXTRA] do not include EXTRA
  14575. For backward compatibility, if both the positive and the negative place
  14576. holder is missing, the positive one (without the \"NO-\") will be
  14577. assumed to be present at the end of the template.
  14578. DEF-PKG and PKG are assumed to be alists of options/packagename lists.
  14579. EXTRA is a string.
  14580. SNIPPETS-P indicates if this is run to create snippet images for HTML."
  14581. (let (rpl (end ""))
  14582. (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
  14583. (setq rpl (if (or (match-end 1) (not def-pkg))
  14584. "" (org-latex-packages-to-string def-pkg snippets-p t))
  14585. tpl (replace-match rpl t t tpl))
  14586. (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
  14587. (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
  14588. (setq rpl (if (or (match-end 1) (not pkg))
  14589. "" (org-latex-packages-to-string pkg snippets-p t))
  14590. tpl (replace-match rpl t t tpl))
  14591. (if pkg (setq end
  14592. (concat end "\n"
  14593. (org-latex-packages-to-string pkg snippets-p)))))
  14594. (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
  14595. (setq rpl (if (or (match-end 1) (not extra))
  14596. "" (concat extra "\n"))
  14597. tpl (replace-match rpl t t tpl))
  14598. (if (and extra (string-match "\\S-" extra))
  14599. (setq end (concat end "\n" extra))))
  14600. (if (string-match "\\S-" end)
  14601. (concat tpl "\n" end)
  14602. tpl)))
  14603. (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
  14604. "Turn an alist of packages into a string with the \\usepackage macros."
  14605. (setq pkg (mapconcat (lambda(p)
  14606. (cond
  14607. ((stringp p) p)
  14608. ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
  14609. (format "%% Package %s omitted" (cadr p)))
  14610. ((equal "" (car p))
  14611. (format "\\usepackage{%s}" (cadr p)))
  14612. (t
  14613. (format "\\usepackage[%s]{%s}"
  14614. (car p) (cadr p)))))
  14615. pkg
  14616. "\n"))
  14617. (if newline (concat pkg "\n") pkg))
  14618. (defun org-dvipng-color (attr)
  14619. "Return an rgb color specification for dvipng."
  14620. (apply 'format "rgb %s %s %s"
  14621. (mapcar 'org-normalize-color
  14622. (color-values (face-attribute 'default attr nil)))))
  14623. (defun org-normalize-color (value)
  14624. "Return string to be used as color value for an RGB component."
  14625. (format "%g" (/ value 65535.0)))
  14626. ;; Image display
  14627. (defvar org-inline-image-overlays nil)
  14628. (make-variable-buffer-local 'org-inline-image-overlays)
  14629. (defun org-toggle-inline-images (&optional include-linked)
  14630. "Toggle the display of inline images.
  14631. INCLUDE-LINKED is passed to `org-display-inline-images'."
  14632. (interactive "P")
  14633. (if org-inline-image-overlays
  14634. (progn
  14635. (org-remove-inline-images)
  14636. (message "Inline image display turned off"))
  14637. (org-display-inline-images include-linked)
  14638. (if org-inline-image-overlays
  14639. (message "%d images displayed inline"
  14640. (length org-inline-image-overlays))
  14641. (message "No images to display inline"))))
  14642. (defun org-display-inline-images (&optional include-linked refresh beg end)
  14643. "Display inline images.
  14644. Normally only links without a description part are inlined, because this
  14645. is how it will work for export. When INCLUDE-LINKED is set, also links
  14646. with a description part will be inlined. This can be nice for a quick
  14647. look at those images, but it does not reflect whatexported files will look
  14648. like.
  14649. When REFRESH is set, refresh existing images between BEG and END.
  14650. This will create new image displays only if necessary.
  14651. BEG and END default to the buffer boundaries."
  14652. (interactive "P")
  14653. (unless refresh
  14654. (org-remove-inline-images)
  14655. (clear-image-cache))
  14656. (save-excursion
  14657. (save-restriction
  14658. (widen)
  14659. (setq beg (or beg (point-min)) end (or end (point-max)))
  14660. (goto-char (point-min))
  14661. (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([-+~.:/\\_0-9a-zA-Z ]+"
  14662. (substring (org-image-file-name-regexp) 0 -2)
  14663. "\\)\\]" (if include-linked "" "\\]")))
  14664. old file ov img)
  14665. (while (re-search-forward re end t)
  14666. (setq old (get-char-property-and-overlay (match-beginning 1)
  14667. 'org-image-overlay))
  14668. (setq file (expand-file-name
  14669. (concat (or (match-string 3) "") (match-string 4))))
  14670. (when (file-exists-p file)
  14671. (if (and (car-safe old) refresh)
  14672. (image-refresh (overlay-get (cdr old) 'display))
  14673. (setq img (create-image file))
  14674. (when img
  14675. (setq ov (make-overlay (match-beginning 0) (match-end 0)))
  14676. (overlay-put ov 'display img)
  14677. (overlay-put ov 'face 'default)
  14678. (overlay-put ov 'org-image-overlay t)
  14679. (overlay-put ov 'modification-hooks
  14680. (list 'org-display-inline-modification-hook))
  14681. (push ov org-inline-image-overlays)))))))))
  14682. (defun org-display-inline-modification-hook (ov after beg end &optional len)
  14683. "Remove inline-display overlay if a corresponding region is modified."
  14684. (let ((inhibit-modification-hooks t))
  14685. (when (and ov after)
  14686. (delete ov org-inline-image-overlays)
  14687. (delete-overlay ov))))
  14688. (defun org-remove-inline-images ()
  14689. "Remove inline display of images."
  14690. (interactive)
  14691. (mapc 'delete-overlay org-inline-image-overlays)
  14692. (setq org-inline-image-overlays nil))
  14693. ;;;; Key bindings
  14694. ;; Make `C-c C-x' a prefix key
  14695. (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
  14696. ;; TAB key with modifiers
  14697. (org-defkey org-mode-map "\C-i" 'org-cycle)
  14698. (org-defkey org-mode-map [(tab)] 'org-cycle)
  14699. (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
  14700. (org-defkey org-mode-map [(meta tab)] 'org-complete)
  14701. (org-defkey org-mode-map "\M-\t" 'org-complete)
  14702. (org-defkey org-mode-map "\M-\C-i" 'org-complete)
  14703. ;; The following line is necessary under Suse GNU/Linux
  14704. (unless (featurep 'xemacs)
  14705. (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
  14706. (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
  14707. (define-key org-mode-map [backtab] 'org-shifttab)
  14708. (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
  14709. (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
  14710. (org-defkey org-mode-map [(meta return)] 'org-meta-return)
  14711. ;; Cursor keys with modifiers
  14712. (org-defkey org-mode-map [(meta left)] 'org-metaleft)
  14713. (org-defkey org-mode-map [(meta right)] 'org-metaright)
  14714. (org-defkey org-mode-map [(meta up)] 'org-metaup)
  14715. (org-defkey org-mode-map [(meta down)] 'org-metadown)
  14716. (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
  14717. (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
  14718. (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
  14719. (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
  14720. (org-defkey org-mode-map [(shift up)] 'org-shiftup)
  14721. (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
  14722. (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
  14723. (org-defkey org-mode-map [(shift right)] 'org-shiftright)
  14724. (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
  14725. (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
  14726. ;; Babel keys
  14727. (define-key org-mode-map org-babel-key-prefix org-babel-map)
  14728. (mapc (lambda (pair)
  14729. (define-key org-babel-map (car pair) (cdr pair)))
  14730. org-babel-key-bindings)
  14731. ;;; Extra keys for tty access.
  14732. ;; We only set them when really needed because otherwise the
  14733. ;; menus don't show the simple keys
  14734. (when (or org-use-extra-keys
  14735. (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
  14736. (not window-system))
  14737. (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
  14738. (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
  14739. (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
  14740. (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
  14741. (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
  14742. (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
  14743. (org-defkey org-mode-map [?\e (right)] 'org-metaright)
  14744. (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
  14745. (org-defkey org-mode-map [?\e (up)] 'org-metaup)
  14746. (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
  14747. (org-defkey org-mode-map [?\e (down)] 'org-metadown)
  14748. (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
  14749. (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
  14750. (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
  14751. (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
  14752. (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
  14753. (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
  14754. (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
  14755. (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
  14756. (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
  14757. (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
  14758. (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
  14759. (org-defkey org-mode-map [?\e (tab)] 'org-complete)
  14760. (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
  14761. (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
  14762. (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
  14763. (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
  14764. (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
  14765. ;; All the other keys
  14766. (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
  14767. (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
  14768. (if (boundp 'narrow-map)
  14769. (org-defkey narrow-map "s" 'org-narrow-to-subtree)
  14770. (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
  14771. (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
  14772. (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
  14773. (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
  14774. (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
  14775. (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
  14776. (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
  14777. (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
  14778. (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
  14779. (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
  14780. (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
  14781. (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
  14782. (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
  14783. (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
  14784. (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
  14785. (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
  14786. (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
  14787. (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
  14788. (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
  14789. (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
  14790. (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
  14791. (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
  14792. (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
  14793. (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
  14794. (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
  14795. (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
  14796. (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
  14797. (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
  14798. (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
  14799. (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
  14800. (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
  14801. (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
  14802. (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
  14803. (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
  14804. (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
  14805. (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
  14806. (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
  14807. (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
  14808. (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
  14809. (org-defkey org-mode-map "\C-c]" 'org-remove-file)
  14810. (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
  14811. (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  14812. (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
  14813. (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
  14814. (org-defkey org-mode-map "\C-c^" 'org-sort)
  14815. (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
  14816. (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
  14817. (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
  14818. (org-defkey org-mode-map "\C-m" 'org-return)
  14819. (org-defkey org-mode-map "\C-j" 'org-return-indent)
  14820. (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
  14821. (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
  14822. (org-defkey org-mode-map "\C-c+" 'org-table-sum)
  14823. (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
  14824. (org-defkey org-mode-map "\C-c'" 'org-edit-special)
  14825. (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
  14826. (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
  14827. (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
  14828. (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
  14829. (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
  14830. (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
  14831. (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
  14832. (org-defkey org-mode-map "\C-c\C-e" 'org-export)
  14833. (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
  14834. (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
  14835. (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
  14836. (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
  14837. (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
  14838. (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
  14839. ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
  14840. (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
  14841. (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
  14842. (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
  14843. (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
  14844. (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
  14845. (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
  14846. (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
  14847. (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
  14848. (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
  14849. (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
  14850. (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
  14851. (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
  14852. (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
  14853. (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
  14854. (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
  14855. (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
  14856. (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
  14857. (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
  14858. (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
  14859. (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
  14860. (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
  14861. (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
  14862. (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
  14863. (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
  14864. (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
  14865. (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
  14866. (define-key org-mode-map "\C-c\C-x!" 'org-reload)
  14867. (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
  14868. (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
  14869. (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
  14870. (when (featurep 'xemacs)
  14871. (org-defkey org-mode-map 'button3 'popup-mode-menu))
  14872. (defconst org-speed-commands-default
  14873. '(
  14874. ("Outline Navigation")
  14875. ("n" . (org-speed-move-safe 'outline-next-visible-heading))
  14876. ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
  14877. ("f" . (org-speed-move-safe 'org-forward-same-level))
  14878. ("b" . (org-speed-move-safe 'org-backward-same-level))
  14879. ("u" . (org-speed-move-safe 'outline-up-heading))
  14880. ("j" . org-goto)
  14881. ("g" . (org-refile t))
  14882. ("Outline Visibility")
  14883. ("c" . org-cycle)
  14884. ("C" . org-shifttab)
  14885. (" " . org-display-outline-path)
  14886. ("Outline Structure Editing")
  14887. ("U" . org-shiftmetaup)
  14888. ("D" . org-shiftmetadown)
  14889. ("r" . org-metaright)
  14890. ("l" . org-metaleft)
  14891. ("R" . org-shiftmetaright)
  14892. ("L" . org-shiftmetaleft)
  14893. ("i" . (progn (forward-char 1) (call-interactively
  14894. 'org-insert-heading-respect-content)))
  14895. ("^" . org-sort)
  14896. ("w" . org-refile)
  14897. ("a" . org-archive-subtree-default-with-confirmation)
  14898. ("." . outline-mark-subtree)
  14899. ("Clock Commands")
  14900. ("I" . org-clock-in)
  14901. ("O" . org-clock-out)
  14902. ("Meta Data Editing")
  14903. ("t" . org-todo)
  14904. ("0" . (org-priority ?\ ))
  14905. ("1" . (org-priority ?A))
  14906. ("2" . (org-priority ?B))
  14907. ("3" . (org-priority ?C))
  14908. (";" . org-set-tags-command)
  14909. ("e" . org-set-effort)
  14910. ("Agenda Views etc")
  14911. ("v" . org-agenda)
  14912. ("/" . org-sparse-tree)
  14913. ("Misc")
  14914. ("o" . org-open-at-point)
  14915. ("?" . org-speed-command-help)
  14916. )
  14917. "The default speed commands.")
  14918. (defun org-print-speed-command (e)
  14919. (if (> (length (car e)) 1)
  14920. (progn
  14921. (princ "\n")
  14922. (princ (car e))
  14923. (princ "\n")
  14924. (princ (make-string (length (car e)) ?-))
  14925. (princ "\n"))
  14926. (princ (car e))
  14927. (princ " ")
  14928. (if (symbolp (cdr e))
  14929. (princ (symbol-name (cdr e)))
  14930. (prin1 (cdr e)))
  14931. (princ "\n")))
  14932. (defun org-speed-command-help ()
  14933. "Show the available speed commands."
  14934. (interactive)
  14935. (if (not org-use-speed-commands)
  14936. (error "Speed commands are not activated, customize `org-use-speed-commands'.")
  14937. (with-output-to-temp-buffer "*Help*"
  14938. (princ "User-defined Speed commands\n===========================\n")
  14939. (mapc 'org-print-speed-command org-speed-commands-user)
  14940. (princ "\n")
  14941. (princ "Built-in Speed commands\n=======================\n")
  14942. (mapc 'org-print-speed-command org-speed-commands-default))
  14943. (with-current-buffer "*Help*"
  14944. (setq truncate-lines t))))
  14945. (defun org-speed-move-safe (cmd)
  14946. "Execute CMD, but make sure that the cursor always ends up in a headline.
  14947. If not, return to the original position and throw an error."
  14948. (interactive)
  14949. (let ((pos (point)))
  14950. (call-interactively cmd)
  14951. (unless (and (bolp) (org-on-heading-p))
  14952. (goto-char pos)
  14953. (error "Boundary reached while executing %s" cmd))))
  14954. (defvar org-self-insert-command-undo-counter 0)
  14955. (defvar org-table-auto-blank-field) ; defined in org-table.el
  14956. (defvar org-speed-command nil)
  14957. (defun org-self-insert-command (N)
  14958. "Like `self-insert-command', use overwrite-mode for whitespace in tables.
  14959. If the cursor is in a table looking at whitespace, the whitespace is
  14960. overwritten, and the table is not marked as requiring realignment."
  14961. (interactive "p")
  14962. (cond
  14963. ((and org-use-speed-commands
  14964. (or (and (bolp) (looking-at outline-regexp))
  14965. (and (functionp org-use-speed-commands)
  14966. (funcall org-use-speed-commands)))
  14967. (setq
  14968. org-speed-command
  14969. (or (cdr (assoc (this-command-keys) org-speed-commands-user))
  14970. (cdr (assoc (this-command-keys) org-speed-commands-default)))))
  14971. (cond
  14972. ((commandp org-speed-command)
  14973. (setq this-command org-speed-command)
  14974. (call-interactively org-speed-command))
  14975. ((functionp org-speed-command)
  14976. (funcall org-speed-command))
  14977. ((and org-speed-command (listp org-speed-command))
  14978. (eval org-speed-command))
  14979. (t (let (org-use-speed-commands)
  14980. (call-interactively 'org-self-insert-command)))))
  14981. ((and
  14982. (org-table-p)
  14983. (progn
  14984. ;; check if we blank the field, and if that triggers align
  14985. (and (featurep 'org-table) org-table-auto-blank-field
  14986. (member last-command
  14987. '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
  14988. (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
  14989. ;; got extra space, this field does not determine column width
  14990. (let (org-table-may-need-update) (org-table-blank-field))
  14991. ;; no extra space, this field may determine column width
  14992. (org-table-blank-field)))
  14993. t)
  14994. (eq N 1)
  14995. (looking-at "[^|\n]* |"))
  14996. (let (org-table-may-need-update)
  14997. (goto-char (1- (match-end 0)))
  14998. (delete-backward-char 1)
  14999. (goto-char (match-beginning 0))
  15000. (self-insert-command N)))
  15001. (t
  15002. (setq org-table-may-need-update t)
  15003. (self-insert-command N)
  15004. (org-fix-tags-on-the-fly)
  15005. (if org-self-insert-cluster-for-undo
  15006. (if (not (eq last-command 'org-self-insert-command))
  15007. (setq org-self-insert-command-undo-counter 1)
  15008. (if (>= org-self-insert-command-undo-counter 20)
  15009. (setq org-self-insert-command-undo-counter 1)
  15010. (and (> org-self-insert-command-undo-counter 0)
  15011. buffer-undo-list
  15012. (not (cadr buffer-undo-list)) ; remove nil entry
  15013. (setcdr buffer-undo-list (cddr buffer-undo-list)))
  15014. (setq org-self-insert-command-undo-counter
  15015. (1+ org-self-insert-command-undo-counter))))))))
  15016. (defun org-fix-tags-on-the-fly ()
  15017. (when (and (equal (char-after (point-at-bol)) ?*)
  15018. (org-on-heading-p))
  15019. (org-align-tags-here org-tags-column)))
  15020. (defun org-delete-backward-char (N)
  15021. "Like `delete-backward-char', insert whitespace at field end in tables.
  15022. When deleting backwards, in tables this function will insert whitespace in
  15023. front of the next \"|\" separator, to keep the table aligned. The table will
  15024. still be marked for re-alignment if the field did fill the entire column,
  15025. because, in this case the deletion might narrow the column."
  15026. (interactive "p")
  15027. (if (and (org-table-p)
  15028. (eq N 1)
  15029. (string-match "|" (buffer-substring (point-at-bol) (point)))
  15030. (looking-at ".*?|"))
  15031. (let ((pos (point))
  15032. (noalign (looking-at "[^|\n\r]* |"))
  15033. (c org-table-may-need-update))
  15034. (backward-delete-char N)
  15035. (skip-chars-forward "^|")
  15036. (insert " ")
  15037. (goto-char (1- pos))
  15038. ;; noalign: if there were two spaces at the end, this field
  15039. ;; does not determine the width of the column.
  15040. (if noalign (setq org-table-may-need-update c)))
  15041. (backward-delete-char N)
  15042. (org-fix-tags-on-the-fly)))
  15043. (defun org-delete-char (N)
  15044. "Like `delete-char', but insert whitespace at field end in tables.
  15045. When deleting characters, in tables this function will insert whitespace in
  15046. front of the next \"|\" separator, to keep the table aligned. The table will
  15047. still be marked for re-alignment if the field did fill the entire column,
  15048. because, in this case the deletion might narrow the column."
  15049. (interactive "p")
  15050. (if (and (org-table-p)
  15051. (not (bolp))
  15052. (not (= (char-after) ?|))
  15053. (eq N 1))
  15054. (if (looking-at ".*?|")
  15055. (let ((pos (point))
  15056. (noalign (looking-at "[^|\n\r]* |"))
  15057. (c org-table-may-need-update))
  15058. (replace-match (concat
  15059. (substring (match-string 0) 1 -1)
  15060. " |"))
  15061. (goto-char pos)
  15062. ;; noalign: if there were two spaces at the end, this field
  15063. ;; does not determine the width of the column.
  15064. (if noalign (setq org-table-may-need-update c)))
  15065. (delete-char N))
  15066. (delete-char N)
  15067. (org-fix-tags-on-the-fly)))
  15068. ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
  15069. (put 'org-self-insert-command 'delete-selection t)
  15070. (put 'orgtbl-self-insert-command 'delete-selection t)
  15071. (put 'org-delete-char 'delete-selection 'supersede)
  15072. (put 'org-delete-backward-char 'delete-selection 'supersede)
  15073. (put 'org-yank 'delete-selection 'yank)
  15074. ;; Make `flyspell-mode' delay after some commands
  15075. (put 'org-self-insert-command 'flyspell-delayed t)
  15076. (put 'orgtbl-self-insert-command 'flyspell-delayed t)
  15077. (put 'org-delete-char 'flyspell-delayed t)
  15078. (put 'org-delete-backward-char 'flyspell-delayed t)
  15079. ;; Make pabbrev-mode expand after org-mode commands
  15080. (put 'org-self-insert-command 'pabbrev-expand-after-command t)
  15081. (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
  15082. ;; How to do this: Measure non-white length of current string
  15083. ;; If equal to column width, we should realign.
  15084. (defun org-remap (map &rest commands)
  15085. "In MAP, remap the functions given in COMMANDS.
  15086. COMMANDS is a list of alternating OLDDEF NEWDEF command names."
  15087. (let (new old)
  15088. (while commands
  15089. (setq old (pop commands) new (pop commands))
  15090. (if (fboundp 'command-remapping)
  15091. (org-defkey map (vector 'remap old) new)
  15092. (substitute-key-definition old new map global-map)))))
  15093. (when (eq org-enable-table-editor 'optimized)
  15094. ;; If the user wants maximum table support, we need to hijack
  15095. ;; some standard editing functions
  15096. (org-remap org-mode-map
  15097. 'self-insert-command 'org-self-insert-command
  15098. 'delete-char 'org-delete-char
  15099. 'delete-backward-char 'org-delete-backward-char)
  15100. (org-defkey org-mode-map "|" 'org-force-self-insert))
  15101. (defvar org-ctrl-c-ctrl-c-hook nil
  15102. "Hook for functions attaching themselves to `C-c C-c'.
  15103. This can be used to add additional functionality to the C-c C-c key which
  15104. executes context-dependent commands.
  15105. Each function will be called with no arguments. The function must check
  15106. if the context is appropriate for it to act. If yes, it should do its
  15107. thing and then return a non-nil value. If the context is wrong,
  15108. just do nothing and return nil.")
  15109. (defvar org-tab-first-hook nil
  15110. "Hook for functions to attach themselves to TAB.
  15111. See `org-ctrl-c-ctrl-c-hook' for more information.
  15112. This hook runs as the first action when TAB is pressed, even before
  15113. `org-cycle' messes around with the `outline-regexp' to cater for
  15114. inline tasks and plain list item folding.
  15115. If any function in this hook returns t, any other actions that
  15116. would have been caused by TAB (such as table field motion or visibility
  15117. cycling) will not occur.")
  15118. (defvar org-tab-after-check-for-table-hook nil
  15119. "Hook for functions to attach themselves to TAB.
  15120. See `org-ctrl-c-ctrl-c-hook' for more information.
  15121. This hook runs after it has been established that the cursor is not in a
  15122. table, but before checking if the cursor is in a headline or if global cycling
  15123. should be done.
  15124. If any function in this hook returns t, not other actions like visibility
  15125. cycling will be done.")
  15126. (defvar org-tab-after-check-for-cycling-hook nil
  15127. "Hook for functions to attach themselves to TAB.
  15128. See `org-ctrl-c-ctrl-c-hook' for more information.
  15129. This hook runs after it has been established that not table field motion and
  15130. not visibility should be done because of current context. This is probably
  15131. the place where a package like yasnippets can hook in.")
  15132. (defvar org-tab-before-tab-emulation-hook nil
  15133. "Hook for functions to attach themselves to TAB.
  15134. See `org-ctrl-c-ctrl-c-hook' for more information.
  15135. This hook runs after every other options for TAB have been exhausted, but
  15136. before indentation and \t insertion takes place.")
  15137. (defvar org-metaleft-hook nil
  15138. "Hook for functions attaching themselves to `M-left'.
  15139. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15140. (defvar org-metaright-hook nil
  15141. "Hook for functions attaching themselves to `M-right'.
  15142. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15143. (defvar org-metaup-hook nil
  15144. "Hook for functions attaching themselves to `M-up'.
  15145. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15146. (defvar org-metadown-hook nil
  15147. "Hook for functions attaching themselves to `M-down'.
  15148. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15149. (defvar org-shiftmetaleft-hook nil
  15150. "Hook for functions attaching themselves to `M-S-left'.
  15151. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15152. (defvar org-shiftmetaright-hook nil
  15153. "Hook for functions attaching themselves to `M-S-right'.
  15154. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15155. (defvar org-shiftmetaup-hook nil
  15156. "Hook for functions attaching themselves to `M-S-up'.
  15157. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15158. (defvar org-shiftmetadown-hook nil
  15159. "Hook for functions attaching themselves to `M-S-down'.
  15160. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15161. (defvar org-metareturn-hook nil
  15162. "Hook for functions attaching themselves to `M-RET'.
  15163. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15164. (defvar org-shiftup-hook nil
  15165. "Hook for functions attaching themselves to `S-up'.
  15166. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15167. (defvar org-shiftup-final-hook nil
  15168. "Hook for functions attaching themselves to `S-up'.
  15169. This one runs after all other options except shift-select have been excluded.
  15170. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15171. (defvar org-shiftdown-hook nil
  15172. "Hook for functions attaching themselves to `S-down'.
  15173. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15174. (defvar org-shiftdown-final-hook nil
  15175. "Hook for functions attaching themselves to `S-down'.
  15176. This one runs after all other options except shift-select have been excluded.
  15177. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15178. (defvar org-shiftleft-hook nil
  15179. "Hook for functions attaching themselves to `S-left'.
  15180. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15181. (defvar org-shiftleft-final-hook nil
  15182. "Hook for functions attaching themselves to `S-left'.
  15183. This one runs after all other options except shift-select have been excluded.
  15184. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15185. (defvar org-shiftright-hook nil
  15186. "Hook for functions attaching themselves to `S-right'.
  15187. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15188. (defvar org-shiftright-final-hook nil
  15189. "Hook for functions attaching themselves to `S-right'.
  15190. This one runs after all other options except shift-select have been excluded.
  15191. See `org-ctrl-c-ctrl-c-hook' for more information.")
  15192. (defun org-modifier-cursor-error ()
  15193. "Throw an error, a modified cursor command was applied in wrong context."
  15194. (error "This command is active in special context like tables, headlines or items"))
  15195. (defun org-shiftselect-error ()
  15196. "Throw an error because Shift-Cursor command was applied in wrong context."
  15197. (if (and (boundp 'shift-select-mode) shift-select-mode)
  15198. (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
  15199. (error "This command works only in special context like headlines or timestamps")))
  15200. (defun org-call-for-shift-select (cmd)
  15201. (let ((this-command-keys-shift-translated t))
  15202. (call-interactively cmd)))
  15203. (defun org-shifttab (&optional arg)
  15204. "Global visibility cycling or move to previous table field.
  15205. Calls `org-cycle' with argument t, or `org-table-previous-field', depending
  15206. on context.
  15207. See the individual commands for more information."
  15208. (interactive "P")
  15209. (cond
  15210. ((org-at-table-p) (call-interactively 'org-table-previous-field))
  15211. ((integerp arg)
  15212. (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
  15213. (message "Content view to level: %d" arg)
  15214. (org-content (prefix-numeric-value arg2))
  15215. (setq org-cycle-global-status 'overview)))
  15216. (t (call-interactively 'org-global-cycle))))
  15217. (defun org-shiftmetaleft ()
  15218. "Promote subtree or delete table column.
  15219. Calls `org-promote-subtree', `org-outdent-item',
  15220. or `org-table-delete-column', depending on context.
  15221. See the individual commands for more information."
  15222. (interactive)
  15223. (cond
  15224. ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
  15225. ((org-at-table-p) (call-interactively 'org-table-delete-column))
  15226. ((org-on-heading-p) (call-interactively 'org-promote-subtree))
  15227. ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
  15228. (t (org-modifier-cursor-error))))
  15229. (defun org-shiftmetaright ()
  15230. "Demote subtree or insert table column.
  15231. Calls `org-demote-subtree', `org-indent-item',
  15232. or `org-table-insert-column', depending on context.
  15233. See the individual commands for more information."
  15234. (interactive)
  15235. (cond
  15236. ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
  15237. ((org-at-table-p) (call-interactively 'org-table-insert-column))
  15238. ((org-on-heading-p) (call-interactively 'org-demote-subtree))
  15239. ((org-at-item-p) (call-interactively 'org-indent-item-tree))
  15240. (t (org-modifier-cursor-error))))
  15241. (defun org-shiftmetaup (&optional arg)
  15242. "Move subtree up or kill table row.
  15243. Calls `org-move-subtree-up' or `org-table-kill-row' or
  15244. `org-move-item-up' depending on context. See the individual commands
  15245. for more information."
  15246. (interactive "P")
  15247. (cond
  15248. ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
  15249. ((org-at-table-p) (call-interactively 'org-table-kill-row))
  15250. ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
  15251. ((org-at-item-p) (call-interactively 'org-move-item-up))
  15252. (t (org-modifier-cursor-error))))
  15253. (defun org-shiftmetadown (&optional arg)
  15254. "Move subtree down or insert table row.
  15255. Calls `org-move-subtree-down' or `org-table-insert-row' or
  15256. `org-move-item-down', depending on context. See the individual
  15257. commands for more information."
  15258. (interactive "P")
  15259. (cond
  15260. ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
  15261. ((org-at-table-p) (call-interactively 'org-table-insert-row))
  15262. ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
  15263. ((org-at-item-p) (call-interactively 'org-move-item-down))
  15264. (t (org-modifier-cursor-error))))
  15265. (defsubst org-hidden-tree-error ()
  15266. (error
  15267. "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
  15268. (defun org-metaleft (&optional arg)
  15269. "Promote heading or move table column to left.
  15270. Calls `org-do-promote' or `org-table-move-column', depending on context.
  15271. With no specific context, calls the Emacs default `backward-word'.
  15272. See the individual commands for more information."
  15273. (interactive "P")
  15274. (cond
  15275. ((run-hook-with-args-until-success 'org-metaleft-hook))
  15276. ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
  15277. ((or (org-on-heading-p)
  15278. (and (org-region-active-p)
  15279. (save-excursion
  15280. (goto-char (region-beginning))
  15281. (org-on-heading-p))))
  15282. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  15283. (call-interactively 'org-do-promote))
  15284. ((or (org-at-item-p)
  15285. (and (org-region-active-p)
  15286. (save-excursion
  15287. (goto-char (region-beginning))
  15288. (org-at-item-p))))
  15289. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  15290. (call-interactively 'org-outdent-item))
  15291. (t (call-interactively 'backward-word))))
  15292. (defun org-metaright (&optional arg)
  15293. "Demote subtree or move table column to right.
  15294. Calls `org-do-demote' or `org-table-move-column', depending on context.
  15295. With no specific context, calls the Emacs default `forward-word'.
  15296. See the individual commands for more information."
  15297. (interactive "P")
  15298. (cond
  15299. ((run-hook-with-args-until-success 'org-metaright-hook))
  15300. ((org-at-table-p) (call-interactively 'org-table-move-column))
  15301. ((or (org-on-heading-p)
  15302. (and (org-region-active-p)
  15303. (save-excursion
  15304. (goto-char (region-beginning))
  15305. (org-on-heading-p))))
  15306. (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
  15307. (call-interactively 'org-do-demote))
  15308. ((or (org-at-item-p)
  15309. (and (org-region-active-p)
  15310. (save-excursion
  15311. (goto-char (region-beginning))
  15312. (org-at-item-p))))
  15313. (when (org-check-for-hidden 'items) (org-hidden-tree-error))
  15314. (call-interactively 'org-indent-item))
  15315. (t (call-interactively 'forward-word))))
  15316. (defun org-check-for-hidden (what)
  15317. "Check if there are hidden headlines/items in the current visual line.
  15318. WHAT can be either `headlines' or `items'. If the current line is
  15319. an outline or item heading and it has a folded subtree below it,
  15320. this fucntion returns t, nil otherwise."
  15321. (let ((re (cond
  15322. ((eq what 'headlines) (concat "^" org-outline-regexp))
  15323. ((eq what 'items) (concat "^" (org-item-re t)))
  15324. (t (error "This should not happen"))))
  15325. beg end)
  15326. (save-excursion
  15327. (catch 'exit
  15328. (unless (org-region-active-p)
  15329. (setq beg (point-at-bol))
  15330. (beginning-of-line 2)
  15331. (while (and (not (eobp)) ;; this is like `next-line'
  15332. (get-char-property (1- (point)) 'invisible))
  15333. (beginning-of-line 2))
  15334. (setq end (point))
  15335. (goto-char beg)
  15336. (goto-char (point-at-eol))
  15337. (setq end (max end (point)))
  15338. (while (re-search-forward re end t)
  15339. (if (get-char-property (match-beginning 0) 'invisible)
  15340. (throw 'exit t))))
  15341. nil))))
  15342. (defun org-metaup (&optional arg)
  15343. "Move subtree up or move table row up.
  15344. Calls `org-move-subtree-up' or `org-table-move-row' or
  15345. `org-move-item-up', depending on context. See the individual commands
  15346. for more information."
  15347. (interactive "P")
  15348. (cond
  15349. ((run-hook-with-args-until-success 'org-metaup-hook))
  15350. ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
  15351. ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
  15352. ((org-at-item-p) (call-interactively 'org-move-item-up))
  15353. (t (transpose-lines 1) (beginning-of-line -1))))
  15354. (defun org-metadown (&optional arg)
  15355. "Move subtree down or move table row down.
  15356. Calls `org-move-subtree-down' or `org-table-move-row' or
  15357. `org-move-item-down', depending on context. See the individual
  15358. commands for more information."
  15359. (interactive "P")
  15360. (cond
  15361. ((run-hook-with-args-until-success 'org-metadown-hook))
  15362. ((org-at-table-p) (call-interactively 'org-table-move-row))
  15363. ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
  15364. ((org-at-item-p) (call-interactively 'org-move-item-down))
  15365. (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
  15366. (defun org-shiftup (&optional arg)
  15367. "Increase item in timestamp or increase priority of current headline.
  15368. Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
  15369. depending on context. See the individual commands for more information."
  15370. (interactive "P")
  15371. (cond
  15372. ((run-hook-with-args-until-success 'org-shiftup-hook))
  15373. ((and org-support-shift-select (org-region-active-p))
  15374. (org-call-for-shift-select 'previous-line))
  15375. ((org-at-timestamp-p t)
  15376. (call-interactively (if org-edit-timestamp-down-means-later
  15377. 'org-timestamp-down 'org-timestamp-up)))
  15378. ((and (not (eq org-support-shift-select 'always))
  15379. org-enable-priority-commands
  15380. (org-on-heading-p))
  15381. (call-interactively 'org-priority-up))
  15382. ((and (not org-support-shift-select) (org-at-item-p))
  15383. (call-interactively 'org-previous-item))
  15384. ((org-clocktable-try-shift 'up arg))
  15385. ((run-hook-with-args-until-success 'org-shiftup-final-hook))
  15386. (org-support-shift-select
  15387. (org-call-for-shift-select 'previous-line))
  15388. (t (org-shiftselect-error))))
  15389. (defun org-shiftdown (&optional arg)
  15390. "Decrease item in timestamp or decrease priority of current headline.
  15391. Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
  15392. depending on context. See the individual commands for more information."
  15393. (interactive "P")
  15394. (cond
  15395. ((run-hook-with-args-until-success 'org-shiftdown-hook))
  15396. ((and org-support-shift-select (org-region-active-p))
  15397. (org-call-for-shift-select 'next-line))
  15398. ((org-at-timestamp-p t)
  15399. (call-interactively (if org-edit-timestamp-down-means-later
  15400. 'org-timestamp-up 'org-timestamp-down)))
  15401. ((and (not (eq org-support-shift-select 'always))
  15402. org-enable-priority-commands
  15403. (org-on-heading-p))
  15404. (call-interactively 'org-priority-down))
  15405. ((and (not org-support-shift-select) (org-at-item-p))
  15406. (call-interactively 'org-next-item))
  15407. ((org-clocktable-try-shift 'down arg))
  15408. ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
  15409. (org-support-shift-select
  15410. (org-call-for-shift-select 'next-line))
  15411. (t (org-shiftselect-error))))
  15412. (defun org-shiftright (&optional arg)
  15413. "Cycle the thing at point or in the current line, depending on context.
  15414. Depending on context, this does one of the following:
  15415. - switch a timestamp at point one day into the future
  15416. - on a headline, switch to the next TODO keyword.
  15417. - on an item, switch entire list to the next bullet type
  15418. - on a property line, switch to the next allowed value
  15419. - on a clocktable definition line, move time block into the future"
  15420. (interactive "P")
  15421. (cond
  15422. ((run-hook-with-args-until-success 'org-shiftright-hook))
  15423. ((and org-support-shift-select (org-region-active-p))
  15424. (org-call-for-shift-select 'forward-char))
  15425. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
  15426. ((and (not (eq org-support-shift-select 'always))
  15427. (org-on-heading-p))
  15428. (let ((org-inhibit-logging
  15429. (not org-treat-S-cursor-todo-selection-as-state-change))
  15430. (org-inhibit-blocking
  15431. (not org-treat-S-cursor-todo-selection-as-state-change)))
  15432. (org-call-with-arg 'org-todo 'right)))
  15433. ((or (and org-support-shift-select
  15434. (not (eq org-support-shift-select 'always))
  15435. (org-at-item-bullet-p))
  15436. (and (not org-support-shift-select) (org-at-item-p)))
  15437. (org-call-with-arg 'org-cycle-list-bullet nil))
  15438. ((and (not (eq org-support-shift-select 'always))
  15439. (org-at-property-p))
  15440. (call-interactively 'org-property-next-allowed-value))
  15441. ((org-clocktable-try-shift 'right arg))
  15442. ((run-hook-with-args-until-success 'org-shiftright-final-hook))
  15443. (org-support-shift-select
  15444. (org-call-for-shift-select 'forward-char))
  15445. (t (org-shiftselect-error))))
  15446. (defun org-shiftleft (&optional arg)
  15447. "Cycle the thing at point or in the current line, depending on context.
  15448. Depending on context, this does one of the following:
  15449. - switch a timestamp at point one day into the past
  15450. - on a headline, switch to the previous TODO keyword.
  15451. - on an item, switch entire list to the previous bullet type
  15452. - on a property line, switch to the previous allowed value
  15453. - on a clocktable definition line, move time block into the past"
  15454. (interactive "P")
  15455. (cond
  15456. ((run-hook-with-args-until-success 'org-shiftleft-hook))
  15457. ((and org-support-shift-select (org-region-active-p))
  15458. (org-call-for-shift-select 'backward-char))
  15459. ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
  15460. ((and (not (eq org-support-shift-select 'always))
  15461. (org-on-heading-p))
  15462. (let ((org-inhibit-logging
  15463. (not org-treat-S-cursor-todo-selection-as-state-change))
  15464. (org-inhibit-blocking
  15465. (not org-treat-S-cursor-todo-selection-as-state-change)))
  15466. (org-call-with-arg 'org-todo 'left)))
  15467. ((or (and org-support-shift-select
  15468. (not (eq org-support-shift-select 'always))
  15469. (org-at-item-bullet-p))
  15470. (and (not org-support-shift-select) (org-at-item-p)))
  15471. (org-call-with-arg 'org-cycle-list-bullet 'previous))
  15472. ((and (not (eq org-support-shift-select 'always))
  15473. (org-at-property-p))
  15474. (call-interactively 'org-property-previous-allowed-value))
  15475. ((org-clocktable-try-shift 'left arg))
  15476. ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
  15477. (org-support-shift-select
  15478. (org-call-for-shift-select 'backward-char))
  15479. (t (org-shiftselect-error))))
  15480. (defun org-shiftcontrolright ()
  15481. "Switch to next TODO set."
  15482. (interactive)
  15483. (cond
  15484. ((and org-support-shift-select (org-region-active-p))
  15485. (org-call-for-shift-select 'forward-word))
  15486. ((and (not (eq org-support-shift-select 'always))
  15487. (org-on-heading-p))
  15488. (org-call-with-arg 'org-todo 'nextset))
  15489. (org-support-shift-select
  15490. (org-call-for-shift-select 'forward-word))
  15491. (t (org-shiftselect-error))))
  15492. (defun org-shiftcontrolleft ()
  15493. "Switch to previous TODO set."
  15494. (interactive)
  15495. (cond
  15496. ((and org-support-shift-select (org-region-active-p))
  15497. (org-call-for-shift-select 'backward-word))
  15498. ((and (not (eq org-support-shift-select 'always))
  15499. (org-on-heading-p))
  15500. (org-call-with-arg 'org-todo 'previousset))
  15501. (org-support-shift-select
  15502. (org-call-for-shift-select 'backward-word))
  15503. (t (org-shiftselect-error))))
  15504. (defun org-ctrl-c-ret ()
  15505. "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
  15506. (interactive)
  15507. (cond
  15508. ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
  15509. (t (call-interactively 'org-insert-heading))))
  15510. (defun org-copy-special ()
  15511. "Copy region in table or copy current subtree.
  15512. Calls `org-table-copy' or `org-copy-subtree', depending on context.
  15513. See the individual commands for more information."
  15514. (interactive)
  15515. (call-interactively
  15516. (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
  15517. (defun org-cut-special ()
  15518. "Cut region in table or cut current subtree.
  15519. Calls `org-table-copy' or `org-cut-subtree', depending on context.
  15520. See the individual commands for more information."
  15521. (interactive)
  15522. (call-interactively
  15523. (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
  15524. (defun org-paste-special (arg)
  15525. "Paste rectangular region into table, or past subtree relative to level.
  15526. Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
  15527. See the individual commands for more information."
  15528. (interactive "P")
  15529. (if (org-at-table-p)
  15530. (org-table-paste-rectangle)
  15531. (org-paste-subtree arg)))
  15532. (defun org-edit-special (&optional arg)
  15533. "Call a special editor for the stuff at point.
  15534. When at a table, call the formula editor with `org-table-edit-formulas'.
  15535. When at the first line of an src example, call `org-edit-src-code'.
  15536. When in an #+include line, visit the include file. Otherwise call
  15537. `ffap' to visit the file at point."
  15538. (interactive)
  15539. ;; possibly prep session before editing source
  15540. (when arg
  15541. (let* ((info (org-babel-get-src-block-info))
  15542. (lang (nth 0 info))
  15543. (params (nth 2 info))
  15544. (session (cdr (assoc :session params))))
  15545. (when (and info session) ;; we are in a source-code block with a session
  15546. (funcall
  15547. (intern (concat "org-babel-prep-session:" lang)) session params))))
  15548. (cond ;; proceed with `org-edit-special'
  15549. ((save-excursion
  15550. (beginning-of-line 1)
  15551. (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
  15552. (find-file (org-trim (match-string 1))))
  15553. ((org-edit-src-code))
  15554. ((org-edit-fixed-width-region))
  15555. ((org-at-table.el-p)
  15556. (org-edit-src-code))
  15557. ((org-at-table-p)
  15558. (call-interactively 'org-table-edit-formulas))
  15559. (t (call-interactively 'ffap))))
  15560. (defun org-ctrl-c-ctrl-c (&optional arg)
  15561. "Set tags in headline, or update according to changed information at point.
  15562. This command does many different things, depending on context:
  15563. - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
  15564. this is what we do.
  15565. - If the cursor is on a statistics cookie, update it.
  15566. - If the cursor is in a headline, prompt for tags and insert them
  15567. into the current line, aligned to `org-tags-column'. When called
  15568. with prefix arg, realign all tags in the current buffer.
  15569. - If the cursor is in one of the special #+KEYWORD lines, this
  15570. triggers scanning the buffer for these lines and updating the
  15571. information.
  15572. - If the cursor is inside a table, realign the table. This command
  15573. works even if the automatic table editor has been turned off.
  15574. - If the cursor is on a #+TBLFM line, re-apply the formulas to
  15575. the entire table.
  15576. - If the cursor is at a footnote reference or definition, jump to
  15577. the corresponding definition or references, respectively.
  15578. - If the cursor is a the beginning of a dynamic block, update it.
  15579. - If the current buffer is a remember buffer, close note and file
  15580. it. A prefix argument of 1 files to the default location
  15581. without further interaction. A prefix argument of 2 files to
  15582. the currently clocking task.
  15583. - If the cursor is on a <<<target>>>, update radio targets and corresponding
  15584. links in this buffer.
  15585. - If the cursor is on a numbered item in a plain list, renumber the
  15586. ordered list.
  15587. - If the cursor is on a checkbox, toggle it.
  15588. - If the cursor is on a code block, evaluate it. The variable
  15589. `org-confirm-babel-evaluate' can be used to control prompting
  15590. before code block evaluation, by default every code block
  15591. evaluation requires confirmation. Code block evaluation can be
  15592. inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
  15593. (interactive "P")
  15594. (let ((org-enable-table-editor t))
  15595. (cond
  15596. ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
  15597. org-occur-highlights
  15598. org-latex-fragment-image-overlays)
  15599. (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
  15600. (org-remove-occur-highlights)
  15601. (org-remove-latex-fragment-image-overlays)
  15602. (message "Temporary highlights/overlays removed from current buffer"))
  15603. ((and (local-variable-p 'org-finish-function (current-buffer))
  15604. (fboundp org-finish-function))
  15605. (funcall org-finish-function))
  15606. ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
  15607. ((or (looking-at org-property-start-re)
  15608. (org-at-property-p))
  15609. (call-interactively 'org-property-action))
  15610. ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
  15611. ((and (org-in-regexp "\\[\\([0-9]*%\\|[0-9]*/[0-9]*\\)\\]")
  15612. (or (org-on-heading-p) (org-at-item-p)))
  15613. (call-interactively 'org-update-statistics-cookies))
  15614. ((org-on-heading-p) (call-interactively 'org-set-tags))
  15615. ((org-at-table.el-p)
  15616. (message "Use C-c ' to edit table.el tables"))
  15617. ((org-at-table-p)
  15618. (org-table-maybe-eval-formula)
  15619. (if arg
  15620. (call-interactively 'org-table-recalculate)
  15621. (org-table-maybe-recalculate-line))
  15622. (call-interactively 'org-table-align))
  15623. ((or (org-footnote-at-reference-p)
  15624. (org-footnote-at-definition-p))
  15625. (call-interactively 'org-footnote-action))
  15626. ((org-at-item-checkbox-p)
  15627. (call-interactively 'org-toggle-checkbox))
  15628. ((org-at-item-p)
  15629. (if arg
  15630. (call-interactively 'org-toggle-checkbox)
  15631. (call-interactively 'org-maybe-renumber-ordered-list)))
  15632. ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
  15633. ;; Dynamic block
  15634. (beginning-of-line 1)
  15635. (save-excursion (org-update-dblock)))
  15636. ((save-excursion
  15637. (beginning-of-line 1)
  15638. (looking-at "[ \t]*#\\+\\([A-Z]+\\)"))
  15639. (cond
  15640. ((equal (match-string 1) "TBLFM")
  15641. ;; Recalculate the table before this line
  15642. (save-excursion
  15643. (beginning-of-line 1)
  15644. (skip-chars-backward " \r\n\t")
  15645. (if (org-at-table-p)
  15646. (org-call-with-arg 'org-table-recalculate (or arg t)))))
  15647. (t
  15648. (let ((org-inhibit-startup-visibility-stuff t)
  15649. (org-startup-align-all-tables nil))
  15650. (org-save-outline-visibility 'use-markers (org-mode-restart)))
  15651. (message "Local setup has been refreshed"))))
  15652. ((org-clock-update-time-maybe))
  15653. (t (error "C-c C-c can do nothing useful at this location")))))
  15654. (defun org-mode-restart ()
  15655. "Restart Org-mode, to scan again for special lines.
  15656. Also updates the keyword regular expressions."
  15657. (interactive)
  15658. (org-mode)
  15659. (message "Org-mode restarted"))
  15660. (defun org-kill-note-or-show-branches ()
  15661. "If this is a Note buffer, abort storing the note. Else call `show-branches'."
  15662. (interactive)
  15663. (if (not org-finish-function)
  15664. (progn
  15665. (hide-subtree)
  15666. (call-interactively 'show-branches))
  15667. (let ((org-note-abort t))
  15668. (funcall org-finish-function))))
  15669. (defun org-return (&optional indent)
  15670. "Goto next table row or insert a newline.
  15671. Calls `org-table-next-row' or `newline', depending on context.
  15672. See the individual commands for more information."
  15673. (interactive)
  15674. (cond
  15675. ((bobp) (if indent (newline-and-indent) (newline)))
  15676. ((org-at-table-p)
  15677. (org-table-justify-field-maybe)
  15678. (call-interactively 'org-table-next-row))
  15679. ((and org-return-follows-link
  15680. (eq (get-text-property (point) 'face) 'org-link))
  15681. (call-interactively 'org-open-at-point))
  15682. ((and (org-at-heading-p)
  15683. (looking-at
  15684. (org-re "\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)[ \t]*$")))
  15685. (org-show-entry)
  15686. (end-of-line 1)
  15687. (newline))
  15688. (t (if indent (newline-and-indent) (newline)))))
  15689. (defun org-return-indent ()
  15690. "Goto next table row or insert a newline and indent.
  15691. Calls `org-table-next-row' or `newline-and-indent', depending on
  15692. context. See the individual commands for more information."
  15693. (interactive)
  15694. (org-return t))
  15695. (defun org-ctrl-c-star ()
  15696. "Compute table, or change heading status of lines.
  15697. Calls `org-table-recalculate' or `org-toggle-heading',
  15698. depending on context."
  15699. (interactive)
  15700. (cond
  15701. ((org-at-table-p)
  15702. (call-interactively 'org-table-recalculate))
  15703. (t
  15704. ;; Convert all lines in region to list items
  15705. (call-interactively 'org-toggle-heading))))
  15706. (defun org-ctrl-c-minus ()
  15707. "Insert separator line in table or modify bullet status of line.
  15708. Also turns a plain line or a region of lines into list items.
  15709. Calls `org-table-insert-hline', `org-toggle-item', or
  15710. `org-cycle-list-bullet', depending on context."
  15711. (interactive)
  15712. (cond
  15713. ((org-at-table-p)
  15714. (call-interactively 'org-table-insert-hline))
  15715. ((org-region-active-p)
  15716. (call-interactively 'org-toggle-item))
  15717. ((org-in-item-p)
  15718. (call-interactively 'org-cycle-list-bullet))
  15719. (t
  15720. (call-interactively 'org-toggle-item))))
  15721. (defun org-toggle-item ()
  15722. "Convert headings or normal lines to items, items to normal lines.
  15723. If there is no active region, only the current line is considered.
  15724. If the first line in the region is a headline, convert all headlines to items.
  15725. If the first line in the region is an item, convert all items to normal lines.
  15726. If the first line is normal text, add an item bullet to each line."
  15727. (interactive)
  15728. (let (l2 l beg end)
  15729. (if (org-region-active-p)
  15730. (setq beg (region-beginning) end (region-end))
  15731. (setq beg (point-at-bol)
  15732. end (min (1+ (point-at-eol)) (point-max))))
  15733. (save-excursion
  15734. (goto-char end)
  15735. (setq l2 (org-current-line))
  15736. (goto-char beg)
  15737. (beginning-of-line 1)
  15738. (setq l (1- (org-current-line)))
  15739. (if (org-at-item-p)
  15740. ;; We already have items, de-itemize
  15741. (while (< (setq l (1+ l)) l2)
  15742. (when (org-at-item-p)
  15743. (goto-char (match-beginning 2))
  15744. (delete-region (match-beginning 2) (match-end 2))
  15745. (and (looking-at "[ \t]+") (replace-match "")))
  15746. (beginning-of-line 2))
  15747. (if (org-on-heading-p)
  15748. ;; Headings, convert to items
  15749. (while (< (setq l (1+ l)) l2)
  15750. (if (looking-at org-outline-regexp)
  15751. (replace-match "- " t t))
  15752. (beginning-of-line 2))
  15753. ;; normal lines, turn them into items
  15754. (while (< (setq l (1+ l)) l2)
  15755. (unless (org-at-item-p)
  15756. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  15757. (replace-match "\\1- \\2")))
  15758. (beginning-of-line 2)))))))
  15759. (defun org-toggle-heading (&optional nstars)
  15760. "Convert headings to normal text, or items or text to headings.
  15761. If there is no active region, only the current line is considered.
  15762. If the first line is a heading, remove the stars from all headlines
  15763. in the region.
  15764. If the first line is a plain list item, turn all plain list items
  15765. into headings.
  15766. If the first line is a normal line, turn each and every line in the
  15767. region into a heading.
  15768. When converting a line into a heading, the number of stars is chosen
  15769. such that the lines become children of the current entry. However,
  15770. when a prefix argument is given, its value determines the number of
  15771. stars to add."
  15772. (interactive "P")
  15773. (let (l2 l itemp beg end)
  15774. (if (org-region-active-p)
  15775. (setq beg (region-beginning) end (region-end))
  15776. (setq beg (point-at-bol)
  15777. end (min (1+ (point-at-eol)) (point-max))))
  15778. (save-excursion
  15779. (goto-char end)
  15780. (setq l2 (org-current-line))
  15781. (goto-char beg)
  15782. (beginning-of-line 1)
  15783. (setq l (1- (org-current-line)))
  15784. (if (org-on-heading-p)
  15785. ;; We already have headlines, de-star them
  15786. (while (< (setq l (1+ l)) l2)
  15787. (when (org-on-heading-p t)
  15788. (and (looking-at outline-regexp) (replace-match "")))
  15789. (beginning-of-line 2))
  15790. (setq itemp (org-at-item-p))
  15791. (let* ((stars
  15792. (if nstars
  15793. (make-string (prefix-numeric-value current-prefix-arg)
  15794. ?*)
  15795. (save-excursion
  15796. (if (re-search-backward org-complex-heading-regexp nil t)
  15797. (match-string 1) ""))))
  15798. (add-stars (cond (nstars "")
  15799. ((equal stars "") "*")
  15800. (org-odd-levels-only "**")
  15801. (t "*")))
  15802. (rpl (concat stars add-stars " ")))
  15803. (while (< (setq l (1+ l)) l2)
  15804. (if itemp
  15805. (and (org-at-item-p) (replace-match rpl t t))
  15806. (unless (org-on-heading-p)
  15807. (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
  15808. (replace-match (concat rpl (match-string 2))))))
  15809. (beginning-of-line 2)))))))
  15810. (defun org-meta-return (&optional arg)
  15811. "Insert a new heading or wrap a region in a table.
  15812. Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
  15813. See the individual commands for more information."
  15814. (interactive "P")
  15815. (cond
  15816. ((run-hook-with-args-until-success 'org-metareturn-hook))
  15817. ((org-at-table-p)
  15818. (call-interactively 'org-table-wrap-region))
  15819. (t (call-interactively 'org-insert-heading))))
  15820. ;;; Menu entries
  15821. ;; Define the Org-mode menus
  15822. (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
  15823. '("Tbl"
  15824. ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
  15825. ["Next Field" org-cycle (org-at-table-p)]
  15826. ["Previous Field" org-shifttab (org-at-table-p)]
  15827. ["Next Row" org-return (org-at-table-p)]
  15828. "--"
  15829. ["Blank Field" org-table-blank-field (org-at-table-p)]
  15830. ["Edit Field" org-table-edit-field (org-at-table-p)]
  15831. ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
  15832. "--"
  15833. ("Column"
  15834. ["Move Column Left" org-metaleft (org-at-table-p)]
  15835. ["Move Column Right" org-metaright (org-at-table-p)]
  15836. ["Delete Column" org-shiftmetaleft (org-at-table-p)]
  15837. ["Insert Column" org-shiftmetaright (org-at-table-p)])
  15838. ("Row"
  15839. ["Move Row Up" org-metaup (org-at-table-p)]
  15840. ["Move Row Down" org-metadown (org-at-table-p)]
  15841. ["Delete Row" org-shiftmetaup (org-at-table-p)]
  15842. ["Insert Row" org-shiftmetadown (org-at-table-p)]
  15843. ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
  15844. "--"
  15845. ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
  15846. ("Rectangle"
  15847. ["Copy Rectangle" org-copy-special (org-at-table-p)]
  15848. ["Cut Rectangle" org-cut-special (org-at-table-p)]
  15849. ["Paste Rectangle" org-paste-special (org-at-table-p)]
  15850. ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
  15851. "--"
  15852. ("Calculate"
  15853. ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
  15854. ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
  15855. ["Edit Formulas" org-edit-special (org-at-table-p)]
  15856. "--"
  15857. ["Recalculate line" org-table-recalculate (org-at-table-p)]
  15858. ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
  15859. ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
  15860. "--"
  15861. ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
  15862. "--"
  15863. ["Sum Column/Rectangle" org-table-sum
  15864. (or (org-at-table-p) (org-region-active-p))]
  15865. ["Which Column?" org-table-current-column (org-at-table-p)])
  15866. ["Debug Formulas"
  15867. org-table-toggle-formula-debugger
  15868. :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
  15869. ["Show Col/Row Numbers"
  15870. org-table-toggle-coordinate-overlays
  15871. :style toggle
  15872. :selected (org-bound-and-true-p org-table-overlay-coordinates)]
  15873. "--"
  15874. ["Create" org-table-create (and (not (org-at-table-p))
  15875. org-enable-table-editor)]
  15876. ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
  15877. ["Import from File" org-table-import (not (org-at-table-p))]
  15878. ["Export to File" org-table-export (org-at-table-p)]
  15879. "--"
  15880. ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
  15881. (easy-menu-define org-org-menu org-mode-map "Org menu"
  15882. '("Org"
  15883. ("Show/Hide"
  15884. ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
  15885. ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
  15886. ["Sparse Tree..." org-sparse-tree t]
  15887. ["Reveal Context" org-reveal t]
  15888. ["Show All" show-all t]
  15889. "--"
  15890. ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
  15891. "--"
  15892. ["New Heading" org-insert-heading t]
  15893. ("Navigate Headings"
  15894. ["Up" outline-up-heading t]
  15895. ["Next" outline-next-visible-heading t]
  15896. ["Previous" outline-previous-visible-heading t]
  15897. ["Next Same Level" outline-forward-same-level t]
  15898. ["Previous Same Level" outline-backward-same-level t]
  15899. "--"
  15900. ["Jump" org-goto t])
  15901. ("Edit Structure"
  15902. ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
  15903. ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
  15904. "--"
  15905. ["Copy Subtree" org-copy-special (not (org-at-table-p))]
  15906. ["Cut Subtree" org-cut-special (not (org-at-table-p))]
  15907. ["Paste Subtree" org-paste-special (not (org-at-table-p))]
  15908. "--"
  15909. ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
  15910. "--"
  15911. ["Promote Heading" org-metaleft (not (org-at-table-p))]
  15912. ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
  15913. ["Demote Heading" org-metaright (not (org-at-table-p))]
  15914. ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
  15915. "--"
  15916. ["Sort Region/Children" org-sort (not (org-at-table-p))]
  15917. "--"
  15918. ["Convert to odd levels" org-convert-to-odd-levels t]
  15919. ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
  15920. ("Editing"
  15921. ["Emphasis..." org-emphasize t]
  15922. ["Edit Source Example" org-edit-special t]
  15923. "--"
  15924. ["Footnote new/jump" org-footnote-action t]
  15925. ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
  15926. ("Archive"
  15927. ["Archive (default method)" org-archive-subtree-default t]
  15928. "--"
  15929. ["Move Subtree to Archive file" org-advertized-archive-subtree t]
  15930. ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
  15931. ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
  15932. )
  15933. "--"
  15934. ("Hyperlinks"
  15935. ["Store Link (Global)" org-store-link t]
  15936. ["Find existing link to here" org-occur-link-in-agenda-files t]
  15937. ["Insert Link" org-insert-link t]
  15938. ["Follow Link" org-open-at-point t]
  15939. "--"
  15940. ["Next link" org-next-link t]
  15941. ["Previous link" org-previous-link t]
  15942. "--"
  15943. ["Descriptive Links"
  15944. (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
  15945. :style radio
  15946. :selected (member '(org-link) buffer-invisibility-spec)]
  15947. ["Literal Links"
  15948. (progn
  15949. (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
  15950. :style radio
  15951. :selected (not (member '(org-link) buffer-invisibility-spec))])
  15952. "--"
  15953. ("TODO Lists"
  15954. ["TODO/DONE/-" org-todo t]
  15955. ("Select keyword"
  15956. ["Next keyword" org-shiftright (org-on-heading-p)]
  15957. ["Previous keyword" org-shiftleft (org-on-heading-p)]
  15958. ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
  15959. ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
  15960. ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
  15961. ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
  15962. ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
  15963. "--"
  15964. ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
  15965. :selected org-enforce-todo-dependencies :style toggle :active t]
  15966. "Settings for tree at point"
  15967. ["Do Children sequentially" org-toggle-ordered-property :style radio
  15968. :selected (ignore-errors (org-entry-get nil "ORDERED"))
  15969. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  15970. ["Do Children parallel" org-toggle-ordered-property :style radio
  15971. :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
  15972. :active org-enforce-todo-dependencies :keys "C-c C-x o"]
  15973. "--"
  15974. ["Set Priority" org-priority t]
  15975. ["Priority Up" org-shiftup t]
  15976. ["Priority Down" org-shiftdown t]
  15977. "--"
  15978. ["Get news from all feeds" org-feed-update-all t]
  15979. ["Go to the inbox of a feed..." org-feed-goto-inbox t]
  15980. ["Customize feeds" (customize-variable 'org-feed-alist) t])
  15981. ("TAGS and Properties"
  15982. ["Set Tags" org-set-tags-command t]
  15983. ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
  15984. "--"
  15985. ["Set property" org-set-property t]
  15986. ["Column view of properties" org-columns t]
  15987. ["Insert Column View DBlock" org-insert-columns-dblock t])
  15988. ("Dates and Scheduling"
  15989. ["Timestamp" org-time-stamp t]
  15990. ["Timestamp (inactive)" org-time-stamp-inactive t]
  15991. ("Change Date"
  15992. ["1 Day Later" org-shiftright t]
  15993. ["1 Day Earlier" org-shiftleft t]
  15994. ["1 ... Later" org-shiftup t]
  15995. ["1 ... Earlier" org-shiftdown t])
  15996. ["Compute Time Range" org-evaluate-time-range t]
  15997. ["Schedule Item" org-schedule t]
  15998. ["Deadline" org-deadline t]
  15999. "--"
  16000. ["Custom time format" org-toggle-time-stamp-overlays
  16001. :style radio :selected org-display-custom-times]
  16002. "--"
  16003. ["Goto Calendar" org-goto-calendar t]
  16004. ["Date from Calendar" org-date-from-calendar t]
  16005. "--"
  16006. ["Start/Restart Timer" org-timer-start t]
  16007. ["Pause/Continue Timer" org-timer-pause-or-continue t]
  16008. ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
  16009. ["Insert Timer String" org-timer t]
  16010. ["Insert Timer Item" org-timer-item t])
  16011. ("Logging work"
  16012. ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
  16013. ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
  16014. ["Clock out" org-clock-out t]
  16015. ["Clock cancel" org-clock-cancel t]
  16016. "--"
  16017. ["Mark as default task" org-clock-mark-default-task t]
  16018. ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
  16019. ["Goto running clock" org-clock-goto t]
  16020. "--"
  16021. ["Display times" org-clock-display t]
  16022. ["Create clock table" org-clock-report t]
  16023. "--"
  16024. ["Record DONE time"
  16025. (progn (setq org-log-done (not org-log-done))
  16026. (message "Switching to %s will %s record a timestamp"
  16027. (car org-done-keywords)
  16028. (if org-log-done "automatically" "not")))
  16029. :style toggle :selected org-log-done])
  16030. "--"
  16031. ["Agenda Command..." org-agenda t]
  16032. ["Set Restriction Lock" org-agenda-set-restriction-lock t]
  16033. ("File List for Agenda")
  16034. ("Special views current file"
  16035. ["TODO Tree" org-show-todo-tree t]
  16036. ["Check Deadlines" org-check-deadlines t]
  16037. ["Timeline" org-timeline t]
  16038. ["Tags/Property tree" org-match-sparse-tree t])
  16039. "--"
  16040. ["Export/Publish..." org-export t]
  16041. ("LaTeX"
  16042. ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
  16043. :selected org-cdlatex-mode]
  16044. ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
  16045. ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
  16046. ["Modify math symbol" org-cdlatex-math-modify
  16047. (org-inside-LaTeX-fragment-p)]
  16048. ["Insert citation" org-reftex-citation t]
  16049. "--"
  16050. ["Export LaTeX fragments as images"
  16051. (if (featurep 'org-exp)
  16052. (setq org-export-with-LaTeX-fragments
  16053. (not org-export-with-LaTeX-fragments))
  16054. (require 'org-exp))
  16055. :style toggle :selected (and (boundp 'org-export-with-LaTeX-fragments)
  16056. org-export-with-LaTeX-fragments)]
  16057. "--"
  16058. ["Template for BEAMER" org-insert-beamer-options-template t])
  16059. "--"
  16060. ("MobileOrg"
  16061. ["Push Files and Views" org-mobile-push t]
  16062. ["Get Captured and Flagged" org-mobile-pull t]
  16063. ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
  16064. "--"
  16065. ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
  16066. "--"
  16067. ("Documentation"
  16068. ["Show Version" org-version t]
  16069. ["Info Documentation" org-info t])
  16070. ("Customize"
  16071. ["Browse Org Group" org-customize t]
  16072. "--"
  16073. ["Expand This Menu" org-create-customize-menu
  16074. (fboundp 'customize-menu-create)])
  16075. ["Send bug report" org-submit-bug-report t]
  16076. "--"
  16077. ("Refresh/Reload"
  16078. ["Refresh setup current buffer" org-mode-restart t]
  16079. ["Reload Org (after update)" org-reload t]
  16080. ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
  16081. ))
  16082. (defun org-info (&optional node)
  16083. "Read documentation for Org-mode in the info system.
  16084. With optional NODE, go directly to that node."
  16085. (interactive)
  16086. (info (format "(org)%s" (or node ""))))
  16087. ;;;###autoload
  16088. (defun org-submit-bug-report ()
  16089. "Submit a bug report on Org-mode via mail.
  16090. Don't hesitate to report any problems or inaccurate documentation.
  16091. If you don't have setup sending mail from (X)Emacs, please copy the
  16092. output buffer into your mail program, as it gives us important
  16093. information about your Org-mode version and configuration."
  16094. (interactive)
  16095. (require 'reporter)
  16096. (org-load-modules-maybe)
  16097. (org-require-autoloaded-modules)
  16098. (let ((reporter-prompt-for-summary-p "Bug report subject: "))
  16099. (reporter-submit-bug-report
  16100. "emacs-orgmode@gnu.org"
  16101. (org-version)
  16102. (let (list)
  16103. (save-window-excursion
  16104. (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
  16105. (delete-other-windows)
  16106. (erase-buffer)
  16107. (insert "You are about to submit a bug report to the Org-mode mailing list.
  16108. We would like to add your full Org-mode and Outline configuration to the
  16109. bug report. This greatly simplifies the work of the maintainer and
  16110. other experts on the mailing list.
  16111. HOWEVER, some variables you have customized may contain private
  16112. information. The names of customers, colleagues, or friends, might
  16113. appear in the form of file names, tags, todo states, or search strings.
  16114. If you answer yes to the prompt, you might want to check and remove
  16115. such private information before sending the email.")
  16116. (add-text-properties (point-min) (point-max) '(face org-warning))
  16117. (when (yes-or-no-p "Include your Org-mode configuration ")
  16118. (mapatoms
  16119. (lambda (v)
  16120. (and (boundp v)
  16121. (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
  16122. (or (and (symbol-value v)
  16123. (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
  16124. (and
  16125. (get v 'custom-type) (get v 'standard-value)
  16126. (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
  16127. (push v list)))))
  16128. (kill-buffer (get-buffer "*Warn about privacy*"))
  16129. list))
  16130. nil nil
  16131. "Remember to cover the basics, that is, what you expected to happen and
  16132. what in fact did happen. You don't know how to make a good report? See
  16133. http://orgmode.org/manual/Feedback.html#Feedback
  16134. Your bug report will be posted to the Org-mode mailing list.
  16135. ------------------------------------------------------------------------")
  16136. (save-excursion
  16137. (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
  16138. (replace-match "\\1Bug: \\3 [\\2]")))))
  16139. (defun org-install-agenda-files-menu ()
  16140. (let ((bl (buffer-list)))
  16141. (save-excursion
  16142. (while bl
  16143. (set-buffer (pop bl))
  16144. (if (org-mode-p) (setq bl nil)))
  16145. (when (org-mode-p)
  16146. (easy-menu-change
  16147. '("Org") "File List for Agenda"
  16148. (append
  16149. (list
  16150. ["Edit File List" (org-edit-agenda-file-list) t]
  16151. ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
  16152. ["Remove Current File from List" org-remove-file t]
  16153. ["Cycle through agenda files" org-cycle-agenda-files t]
  16154. ["Occur in all agenda files" org-occur-in-agenda-files t]
  16155. "--")
  16156. (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
  16157. ;;;; Documentation
  16158. ;;;###autoload
  16159. (defun org-require-autoloaded-modules ()
  16160. (interactive)
  16161. (mapc 'require
  16162. '(org-agenda org-archive org-ascii org-attach org-clock org-colview
  16163. org-docbook org-exp org-html org-icalendar
  16164. org-id org-latex
  16165. org-publish org-remember org-table
  16166. org-timer org-xoxo)))
  16167. ;;;###autoload
  16168. (defun org-reload (&optional uncompiled)
  16169. "Reload all org lisp files.
  16170. With prefix arg UNCOMPILED, load the uncompiled versions."
  16171. (interactive "P")
  16172. (require 'find-func)
  16173. (let* ((file-re "^\\(org\\|orgtbl\\)\\(\\.el\\|-.*\\.el\\)")
  16174. (dir-org (file-name-directory (org-find-library-name "org")))
  16175. (dir-org-contrib (ignore-errors
  16176. (file-name-directory
  16177. (org-find-library-name "org-contribdir"))))
  16178. (files
  16179. (append (directory-files dir-org t file-re)
  16180. (and dir-org-contrib
  16181. (directory-files dir-org-contrib t file-re))))
  16182. (remove-re (concat (if (featurep 'xemacs)
  16183. "org-colview" "org-colview-xemacs")
  16184. "\\'")))
  16185. (setq files (mapcar 'file-name-sans-extension files))
  16186. (setq files (mapcar
  16187. (lambda (x) (if (string-match remove-re x) nil x))
  16188. files))
  16189. (setq files (delq nil files))
  16190. (mapc
  16191. (lambda (f)
  16192. (when (featurep (intern (file-name-nondirectory f)))
  16193. (if (and (not uncompiled)
  16194. (file-exists-p (concat f ".elc")))
  16195. (load (concat f ".elc") nil nil t)
  16196. (load (concat f ".el") nil nil t))))
  16197. files))
  16198. (org-version))
  16199. ;;;###autoload
  16200. (defun org-customize ()
  16201. "Call the customize function with org as argument."
  16202. (interactive)
  16203. (org-load-modules-maybe)
  16204. (org-require-autoloaded-modules)
  16205. (customize-browse 'org))
  16206. (defun org-create-customize-menu ()
  16207. "Create a full customization menu for Org-mode, insert it into the menu."
  16208. (interactive)
  16209. (org-load-modules-maybe)
  16210. (org-require-autoloaded-modules)
  16211. (if (fboundp 'customize-menu-create)
  16212. (progn
  16213. (easy-menu-change
  16214. '("Org") "Customize"
  16215. `(["Browse Org group" org-customize t]
  16216. "--"
  16217. ,(customize-menu-create 'org)
  16218. ["Set" Custom-set t]
  16219. ["Save" Custom-save t]
  16220. ["Reset to Current" Custom-reset-current t]
  16221. ["Reset to Saved" Custom-reset-saved t]
  16222. ["Reset to Standard Settings" Custom-reset-standard t]))
  16223. (message "\"Org\"-menu now contains full customization menu"))
  16224. (error "Cannot expand menu (outdated version of cus-edit.el)")))
  16225. ;;;; Miscellaneous stuff
  16226. ;;; Generally useful functions
  16227. (defun org-get-at-bol (property)
  16228. "Get text property PROPERTY at beginning of line."
  16229. (get-text-property (point-at-bol) property))
  16230. (defun org-find-text-property-in-string (prop s)
  16231. "Return the first non-nil value of property PROP in string S."
  16232. (or (get-text-property 0 prop s)
  16233. (get-text-property (or (next-single-property-change 0 prop s) 0)
  16234. prop s)))
  16235. (defun org-display-warning (message) ;; Copied from Emacs-Muse
  16236. "Display the given MESSAGE as a warning."
  16237. (if (fboundp 'display-warning)
  16238. (display-warning 'org message
  16239. (if (featurep 'xemacs) 'warning :warning))
  16240. (let ((buf (get-buffer-create "*Org warnings*")))
  16241. (with-current-buffer buf
  16242. (goto-char (point-max))
  16243. (insert "Warning (Org): " message)
  16244. (unless (bolp)
  16245. (newline)))
  16246. (display-buffer buf)
  16247. (sit-for 0))))
  16248. (defun org-in-commented-line ()
  16249. "Is point in a line starting with `#'?"
  16250. (equal (char-after (point-at-bol)) ?#))
  16251. (defun org-in-indented-comment-line ()
  16252. "Is point in a line starting with `#' after some white space?"
  16253. (save-excursion
  16254. (save-match-data
  16255. (goto-char (point-at-bol))
  16256. (looking-at "[ \t]*#"))))
  16257. (defun org-in-verbatim-emphasis ()
  16258. (save-match-data
  16259. (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
  16260. (defun org-goto-marker-or-bmk (marker &optional bookmark)
  16261. "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
  16262. (if (and marker (marker-buffer marker)
  16263. (buffer-live-p (marker-buffer marker)))
  16264. (progn
  16265. (switch-to-buffer (marker-buffer marker))
  16266. (if (or (> marker (point-max)) (< marker (point-min)))
  16267. (widen))
  16268. (goto-char marker)
  16269. (org-show-context 'org-goto))
  16270. (if bookmark
  16271. (bookmark-jump bookmark)
  16272. (error "Cannot find location"))))
  16273. (defun org-quote-csv-field (s)
  16274. "Quote field for inclusion in CSV material."
  16275. (if (string-match "[\",]" s)
  16276. (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
  16277. s))
  16278. (defun org-plist-delete (plist property)
  16279. "Delete PROPERTY from PLIST.
  16280. This is in contrast to merely setting it to 0."
  16281. (let (p)
  16282. (while plist
  16283. (if (not (eq property (car plist)))
  16284. (setq p (plist-put p (car plist) (nth 1 plist))))
  16285. (setq plist (cddr plist)))
  16286. p))
  16287. (defun org-force-self-insert (N)
  16288. "Needed to enforce self-insert under remapping."
  16289. (interactive "p")
  16290. (self-insert-command N))
  16291. (defun org-string-width (s)
  16292. "Compute width of string, ignoring invisible characters.
  16293. This ignores character with invisibility property `org-link', and also
  16294. characters with property `org-cwidth', because these will become invisible
  16295. upon the next fontification round."
  16296. (let (b l)
  16297. (when (or (eq t buffer-invisibility-spec)
  16298. (assq 'org-link buffer-invisibility-spec))
  16299. (while (setq b (text-property-any 0 (length s)
  16300. 'invisible 'org-link s))
  16301. (setq s (concat (substring s 0 b)
  16302. (substring s (or (next-single-property-change
  16303. b 'invisible s) (length s)))))))
  16304. (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
  16305. (setq s (concat (substring s 0 b)
  16306. (substring s (or (next-single-property-change
  16307. b 'org-cwidth s) (length s))))))
  16308. (setq l (string-width s) b -1)
  16309. (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
  16310. (setq l (- l (get-text-property b 'org-dwidth-n s))))
  16311. l))
  16312. (defun org-get-indentation (&optional line)
  16313. "Get the indentation of the current line, interpreting tabs.
  16314. When LINE is given, assume it represents a line and compute its indentation."
  16315. (if line
  16316. (if (string-match "^ *" (org-remove-tabs line))
  16317. (match-end 0))
  16318. (save-excursion
  16319. (beginning-of-line 1)
  16320. (skip-chars-forward " \t")
  16321. (current-column))))
  16322. (defun org-remove-tabs (s &optional width)
  16323. "Replace tabulators in S with spaces.
  16324. Assumes that s is a single line, starting in column 0."
  16325. (setq width (or width tab-width))
  16326. (while (string-match "\t" s)
  16327. (setq s (replace-match
  16328. (make-string
  16329. (- (* width (/ (+ (match-beginning 0) width) width))
  16330. (match-beginning 0)) ?\ )
  16331. t t s)))
  16332. s)
  16333. (defun org-fix-indentation (line ind)
  16334. "Fix indentation in LINE.
  16335. IND is a cons cell with target and minimum indentation.
  16336. If the current indentation in LINE is smaller than the minimum,
  16337. leave it alone. If it is larger than ind, set it to the target."
  16338. (let* ((l (org-remove-tabs line))
  16339. (i (org-get-indentation l))
  16340. (i1 (car ind)) (i2 (cdr ind)))
  16341. (if (>= i i2) (setq l (substring line i2)))
  16342. (if (> i1 0)
  16343. (concat (make-string i1 ?\ ) l)
  16344. l)))
  16345. (defun org-remove-indentation (code &optional n)
  16346. "Remove the maximum common indentation from the lines in CODE.
  16347. N may optionally be the number of spaces to remove."
  16348. (with-temp-buffer
  16349. (insert code)
  16350. (org-do-remove-indentation n)
  16351. (buffer-string)))
  16352. (defun org-do-remove-indentation (&optional n)
  16353. "Remove the maximum common indentation from the buffer."
  16354. (untabify (point-min) (point-max))
  16355. (let ((min 10000) re)
  16356. (if n
  16357. (setq min n)
  16358. (goto-char (point-min))
  16359. (while (re-search-forward "^ *[^ \n]" nil t)
  16360. (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
  16361. (unless (or (= min 0) (= min 10000))
  16362. (setq re (format "^ \\{%d\\}" min))
  16363. (goto-char (point-min))
  16364. (while (re-search-forward re nil t)
  16365. (replace-match "")
  16366. (end-of-line 1))
  16367. min)))
  16368. (defun org-fill-template (template alist)
  16369. "Find each %key of ALIST in TEMPLATE and replace it."
  16370. (let ((case-fold-search nil)
  16371. entry key value)
  16372. (setq alist (sort (copy-sequence alist)
  16373. (lambda (a b) (< (length (car a)) (length (car b))))))
  16374. (while (setq entry (pop alist))
  16375. (setq template
  16376. (replace-regexp-in-string
  16377. (concat "%" (regexp-quote (car entry)))
  16378. (cdr entry) template t t)))
  16379. template))
  16380. (defun org-base-buffer (buffer)
  16381. "Return the base buffer of BUFFER, if it has one. Else return the buffer."
  16382. (if (not buffer)
  16383. buffer
  16384. (or (buffer-base-buffer buffer)
  16385. buffer)))
  16386. (defun org-trim (s)
  16387. "Remove whitespace at beginning and end of string."
  16388. (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
  16389. (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
  16390. s)
  16391. (defun org-wrap (string &optional width lines)
  16392. "Wrap string to either a number of lines, or a width in characters.
  16393. If WIDTH is non-nil, the string is wrapped to that width, however many lines
  16394. that costs. If there is a word longer than WIDTH, the text is actually
  16395. wrapped to the length of that word.
  16396. IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
  16397. many lines, whatever width that takes.
  16398. The return value is a list of lines, without newlines at the end."
  16399. (let* ((words (org-split-string string "[ \t\n]+"))
  16400. (maxword (apply 'max (mapcar 'org-string-width words)))
  16401. w ll)
  16402. (cond (width
  16403. (org-do-wrap words (max maxword width)))
  16404. (lines
  16405. (setq w maxword)
  16406. (setq ll (org-do-wrap words maxword))
  16407. (if (<= (length ll) lines)
  16408. ll
  16409. (setq ll words)
  16410. (while (> (length ll) lines)
  16411. (setq w (1+ w))
  16412. (setq ll (org-do-wrap words w)))
  16413. ll))
  16414. (t (error "Cannot wrap this")))))
  16415. (defun org-do-wrap (words width)
  16416. "Create lines of maximum width WIDTH (in characters) from word list WORDS."
  16417. (let (lines line)
  16418. (while words
  16419. (setq line (pop words))
  16420. (while (and words (< (+ (length line) (length (car words))) width))
  16421. (setq line (concat line " " (pop words))))
  16422. (setq lines (push line lines)))
  16423. (nreverse lines)))
  16424. (defun org-split-string (string &optional separators)
  16425. "Splits STRING into substrings at SEPARATORS.
  16426. No empty strings are returned if there are matches at the beginning
  16427. and end of string."
  16428. (let ((rexp (or separators "[ \f\t\n\r\v]+"))
  16429. (start 0)
  16430. notfirst
  16431. (list nil))
  16432. (while (and (string-match rexp string
  16433. (if (and notfirst
  16434. (= start (match-beginning 0))
  16435. (< start (length string)))
  16436. (1+ start) start))
  16437. (< (match-beginning 0) (length string)))
  16438. (setq notfirst t)
  16439. (or (eq (match-beginning 0) 0)
  16440. (and (eq (match-beginning 0) (match-end 0))
  16441. (eq (match-beginning 0) start))
  16442. (setq list
  16443. (cons (substring string start (match-beginning 0))
  16444. list)))
  16445. (setq start (match-end 0)))
  16446. (or (eq start (length string))
  16447. (setq list
  16448. (cons (substring string start)
  16449. list)))
  16450. (nreverse list)))
  16451. (defun org-quote-vert (s)
  16452. "Replace \"|\" with \"\\vert\"."
  16453. (while (string-match "|" s)
  16454. (setq s (replace-match "\\vert" t t s)))
  16455. s)
  16456. (defun org-uuidgen-p (s)
  16457. "Is S an ID created by UUIDGEN?"
  16458. (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
  16459. (defun org-context ()
  16460. "Return a list of contexts of the current cursor position.
  16461. If several contexts apply, all are returned.
  16462. Each context entry is a list with a symbol naming the context, and
  16463. two positions indicating start and end of the context. Possible
  16464. contexts are:
  16465. :headline anywhere in a headline
  16466. :headline-stars on the leading stars in a headline
  16467. :todo-keyword on a TODO keyword (including DONE) in a headline
  16468. :tags on the TAGS in a headline
  16469. :priority on the priority cookie in a headline
  16470. :item on the first line of a plain list item
  16471. :item-bullet on the bullet/number of a plain list item
  16472. :checkbox on the checkbox in a plain list item
  16473. :table in an org-mode table
  16474. :table-special on a special filed in a table
  16475. :table-table in a table.el table
  16476. :link on a hyperlink
  16477. :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
  16478. :target on a <<target>>
  16479. :radio-target on a <<<radio-target>>>
  16480. :latex-fragment on a LaTeX fragment
  16481. :latex-preview on a LaTeX fragment with overlayed preview image
  16482. This function expects the position to be visible because it uses font-lock
  16483. faces as a help to recognize the following contexts: :table-special, :link,
  16484. and :keyword."
  16485. (let* ((f (get-text-property (point) 'face))
  16486. (faces (if (listp f) f (list f)))
  16487. (p (point)) clist o)
  16488. ;; First the large context
  16489. (cond
  16490. ((org-on-heading-p t)
  16491. (push (list :headline (point-at-bol) (point-at-eol)) clist)
  16492. (when (progn
  16493. (beginning-of-line 1)
  16494. (looking-at org-todo-line-tags-regexp))
  16495. (push (org-point-in-group p 1 :headline-stars) clist)
  16496. (push (org-point-in-group p 2 :todo-keyword) clist)
  16497. (push (org-point-in-group p 4 :tags) clist))
  16498. (goto-char p)
  16499. (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
  16500. (if (looking-at "\\[#[A-Z0-9]\\]")
  16501. (push (org-point-in-group p 0 :priority) clist)))
  16502. ((org-at-item-p)
  16503. (push (org-point-in-group p 2 :item-bullet) clist)
  16504. (push (list :item (point-at-bol)
  16505. (save-excursion (org-end-of-item) (point)))
  16506. clist)
  16507. (and (org-at-item-checkbox-p)
  16508. (push (org-point-in-group p 0 :checkbox) clist)))
  16509. ((org-at-table-p)
  16510. (push (list :table (org-table-begin) (org-table-end)) clist)
  16511. (if (memq 'org-formula faces)
  16512. (push (list :table-special
  16513. (previous-single-property-change p 'face)
  16514. (next-single-property-change p 'face)) clist)))
  16515. ((org-at-table-p 'any)
  16516. (push (list :table-table) clist)))
  16517. (goto-char p)
  16518. ;; Now the small context
  16519. (cond
  16520. ((org-at-timestamp-p)
  16521. (push (org-point-in-group p 0 :timestamp) clist))
  16522. ((memq 'org-link faces)
  16523. (push (list :link
  16524. (previous-single-property-change p 'face)
  16525. (next-single-property-change p 'face)) clist))
  16526. ((memq 'org-special-keyword faces)
  16527. (push (list :keyword
  16528. (previous-single-property-change p 'face)
  16529. (next-single-property-change p 'face)) clist))
  16530. ((org-on-target-p)
  16531. (push (org-point-in-group p 0 :target) clist)
  16532. (goto-char (1- (match-beginning 0)))
  16533. (if (looking-at org-radio-target-regexp)
  16534. (push (org-point-in-group p 0 :radio-target) clist))
  16535. (goto-char p))
  16536. ((setq o (car (delq nil
  16537. (mapcar
  16538. (lambda (x)
  16539. (if (memq x org-latex-fragment-image-overlays) x))
  16540. (overlays-at (point))))))
  16541. (push (list :latex-fragment
  16542. (overlay-start o) (overlay-end o)) clist)
  16543. (push (list :latex-preview
  16544. (overlay-start o) (overlay-end o)) clist))
  16545. ((org-inside-LaTeX-fragment-p)
  16546. ;; FIXME: positions wrong.
  16547. (push (list :latex-fragment (point) (point)) clist)))
  16548. (setq clist (nreverse (delq nil clist)))
  16549. clist))
  16550. ;; FIXME: Compare with at-regexp-p Do we need both?
  16551. (defun org-in-regexp (re &optional nlines visually)
  16552. "Check if point is inside a match of regexp.
  16553. Normally only the current line is checked, but you can include NLINES extra
  16554. lines both before and after point into the search.
  16555. If VISUALLY is set, require that the cursor is not after the match but
  16556. really on, so that the block visually is on the match."
  16557. (catch 'exit
  16558. (let ((pos (point))
  16559. (eol (point-at-eol (+ 1 (or nlines 0))))
  16560. (inc (if visually 1 0)))
  16561. (save-excursion
  16562. (beginning-of-line (- 1 (or nlines 0)))
  16563. (while (re-search-forward re eol t)
  16564. (if (and (<= (match-beginning 0) pos)
  16565. (>= (+ inc (match-end 0)) pos))
  16566. (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
  16567. (defun org-at-regexp-p (regexp)
  16568. "Is point inside a match of REGEXP in the current line?"
  16569. (catch 'exit
  16570. (save-excursion
  16571. (let ((pos (point)) (end (point-at-eol)))
  16572. (beginning-of-line 1)
  16573. (while (re-search-forward regexp end t)
  16574. (if (and (<= (match-beginning 0) pos)
  16575. (>= (match-end 0) pos))
  16576. (throw 'exit t)))
  16577. nil))))
  16578. (defun org-in-regexps-block-p (start-re end-re)
  16579. "Returns t if the current point is between matches of START-RE and END-RE.
  16580. This will also return to if point is on one of the two matches."
  16581. (interactive)
  16582. (let ((p (point)))
  16583. (save-excursion
  16584. (and (or (org-at-regexp-p start-re)
  16585. (re-search-backward start-re nil t))
  16586. (re-search-forward end-re nil t)
  16587. (>= (point) p)))))
  16588. (defun org-occur-in-agenda-files (regexp &optional nlines)
  16589. "Call `multi-occur' with buffers for all agenda files."
  16590. (interactive "sOrg-files matching: \np")
  16591. (let* ((files (org-agenda-files))
  16592. (tnames (mapcar 'file-truename files))
  16593. (extra org-agenda-text-search-extra-files)
  16594. f)
  16595. (when (eq (car extra) 'agenda-archives)
  16596. (setq extra (cdr extra))
  16597. (setq files (org-add-archive-files files)))
  16598. (while (setq f (pop extra))
  16599. (unless (member (file-truename f) tnames)
  16600. (add-to-list 'files f 'append)
  16601. (add-to-list 'tnames (file-truename f) 'append)))
  16602. (multi-occur
  16603. (mapcar (lambda (x)
  16604. (with-current-buffer
  16605. (or (get-file-buffer x) (find-file-noselect x))
  16606. (widen)
  16607. (current-buffer)))
  16608. files)
  16609. regexp)))
  16610. (if (boundp 'occur-mode-find-occurrence-hook)
  16611. ;; Emacs 23
  16612. (add-hook 'occur-mode-find-occurrence-hook
  16613. (lambda ()
  16614. (when (org-mode-p)
  16615. (org-reveal))))
  16616. ;; Emacs 22
  16617. (defadvice occur-mode-goto-occurrence
  16618. (after org-occur-reveal activate)
  16619. (and (org-mode-p) (org-reveal)))
  16620. (defadvice occur-mode-goto-occurrence-other-window
  16621. (after org-occur-reveal activate)
  16622. (and (org-mode-p) (org-reveal)))
  16623. (defadvice occur-mode-display-occurrence
  16624. (after org-occur-reveal activate)
  16625. (when (org-mode-p)
  16626. (let ((pos (occur-mode-find-occurrence)))
  16627. (with-current-buffer (marker-buffer pos)
  16628. (save-excursion
  16629. (goto-char pos)
  16630. (org-reveal)))))))
  16631. (defun org-occur-link-in-agenda-files ()
  16632. "Create a link and search for it in the agendas.
  16633. The link is not stored in `org-stored-links', it is just created
  16634. for the search purpose."
  16635. (interactive)
  16636. (let ((link (condition-case nil
  16637. (org-store-link nil)
  16638. (error "Unable to create a link to here"))))
  16639. (org-occur-in-agenda-files (regexp-quote link))))
  16640. (defun org-uniquify (list)
  16641. "Remove duplicate elements from LIST."
  16642. (let (res)
  16643. (mapc (lambda (x) (add-to-list 'res x 'append)) list)
  16644. res))
  16645. (defun org-delete-all (elts list)
  16646. "Remove all elements in ELTS from LIST."
  16647. (while elts
  16648. (setq list (delete (pop elts) list)))
  16649. list)
  16650. (defun org-remove-if (predicate seq)
  16651. "Remove everything from SEQ that fulfills PREDICATE."
  16652. (let (res e)
  16653. (while seq
  16654. (setq e (pop seq))
  16655. (if (not (funcall predicate e)) (push e res)))
  16656. (nreverse res)))
  16657. (defun org-remove-if-not (predicate seq)
  16658. "Remove everything from SEQ that does not fulfill PREDICATE."
  16659. (let (res e)
  16660. (while seq
  16661. (setq e (pop seq))
  16662. (if (funcall predicate e) (push e res)))
  16663. (nreverse res)))
  16664. (defun org-back-over-empty-lines ()
  16665. "Move backwards over whitespace, to the beginning of the first empty line.
  16666. Returns the number of empty lines passed."
  16667. (let ((pos (point)))
  16668. (skip-chars-backward " \t\n\r")
  16669. (beginning-of-line 2)
  16670. (goto-char (min (point) pos))
  16671. (count-lines (point) pos)))
  16672. (defun org-skip-whitespace ()
  16673. (skip-chars-forward " \t\n\r"))
  16674. (defun org-point-in-group (point group &optional context)
  16675. "Check if POINT is in match-group GROUP.
  16676. If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
  16677. match. If the match group does ot exist or point is not inside it,
  16678. return nil."
  16679. (and (match-beginning group)
  16680. (>= point (match-beginning group))
  16681. (<= point (match-end group))
  16682. (if context
  16683. (list context (match-beginning group) (match-end group))
  16684. t)))
  16685. (defun org-switch-to-buffer-other-window (&rest args)
  16686. "Switch to buffer in a second window on the current frame.
  16687. In particular, do not allow pop-up frames.
  16688. Returns the newly created buffer."
  16689. (let (pop-up-frames special-display-buffer-names special-display-regexps
  16690. special-display-function)
  16691. (apply 'switch-to-buffer-other-window args)))
  16692. (defun org-combine-plists (&rest plists)
  16693. "Create a single property list from all plists in PLISTS.
  16694. The process starts by copying the first list, and then setting properties
  16695. from the other lists. Settings in the last list are the most significant
  16696. ones and overrule settings in the other lists."
  16697. (let ((rtn (copy-sequence (pop plists)))
  16698. p v ls)
  16699. (while plists
  16700. (setq ls (pop plists))
  16701. (while ls
  16702. (setq p (pop ls) v (pop ls))
  16703. (setq rtn (plist-put rtn p v))))
  16704. rtn))
  16705. (defun org-move-line-down (arg)
  16706. "Move the current line down. With prefix argument, move it past ARG lines."
  16707. (interactive "p")
  16708. (let ((col (current-column))
  16709. beg end pos)
  16710. (beginning-of-line 1) (setq beg (point))
  16711. (beginning-of-line 2) (setq end (point))
  16712. (beginning-of-line (+ 1 arg))
  16713. (setq pos (move-marker (make-marker) (point)))
  16714. (insert (delete-and-extract-region beg end))
  16715. (goto-char pos)
  16716. (org-move-to-column col)))
  16717. (defun org-move-line-up (arg)
  16718. "Move the current line up. With prefix argument, move it past ARG lines."
  16719. (interactive "p")
  16720. (let ((col (current-column))
  16721. beg end pos)
  16722. (beginning-of-line 1) (setq beg (point))
  16723. (beginning-of-line 2) (setq end (point))
  16724. (beginning-of-line (- arg))
  16725. (setq pos (move-marker (make-marker) (point)))
  16726. (insert (delete-and-extract-region beg end))
  16727. (goto-char pos)
  16728. (org-move-to-column col)))
  16729. (defun org-replace-escapes (string table)
  16730. "Replace %-escapes in STRING with values in TABLE.
  16731. TABLE is an association list with keys like \"%a\" and string values.
  16732. The sequences in STRING may contain normal field width and padding information,
  16733. for example \"%-5s\". Replacements happen in the sequence given by TABLE,
  16734. so values can contain further %-escapes if they are define later in TABLE."
  16735. (let ((tbl (copy-alist table))
  16736. (case-fold-search nil)
  16737. (pchg 0)
  16738. e re rpl)
  16739. (while (setq e (pop tbl))
  16740. (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
  16741. (when (and (cdr e) (string-match re (cdr e)))
  16742. (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
  16743. (safe "SREF"))
  16744. (add-text-properties 0 3 (list 'sref sref) safe)
  16745. (setcdr e (replace-match safe t t (cdr e)))))
  16746. (while (string-match re string)
  16747. (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
  16748. (cdr e)))
  16749. (setq string (replace-match rpl t t string))))
  16750. (while (setq pchg (next-property-change pchg string))
  16751. (let ((sref (get-text-property pchg 'sref string)))
  16752. (when (and sref (string-match "SREF" string pchg))
  16753. (setq string (replace-match sref t t string)))))
  16754. string))
  16755. (defun org-sublist (list start end)
  16756. "Return a section of LIST, from START to END.
  16757. Counting starts at 1."
  16758. (let (rtn (c start))
  16759. (setq list (nthcdr (1- start) list))
  16760. (while (and list (<= c end))
  16761. (push (pop list) rtn)
  16762. (setq c (1+ c)))
  16763. (nreverse rtn)))
  16764. (defun org-find-base-buffer-visiting (file)
  16765. "Like `find-buffer-visiting' but always return the base buffer and
  16766. not an indirect buffer."
  16767. (let ((buf (or (get-file-buffer file)
  16768. (find-buffer-visiting file))))
  16769. (if buf
  16770. (or (buffer-base-buffer buf) buf)
  16771. nil)))
  16772. (defun org-image-file-name-regexp (&optional extensions)
  16773. "Return regexp matching the file names of images.
  16774. If EXTENSIONS is given, only match these."
  16775. (if (and (not extensions) (fboundp 'image-file-name-regexp))
  16776. (image-file-name-regexp)
  16777. (let ((image-file-name-extensions
  16778. (or extensions
  16779. '("png" "jpeg" "jpg" "gif" "tiff" "tif"
  16780. "xbm" "xpm" "pbm" "pgm" "ppm"))))
  16781. (concat "\\."
  16782. (regexp-opt (nconc (mapcar 'upcase
  16783. image-file-name-extensions)
  16784. image-file-name-extensions)
  16785. t)
  16786. "\\'"))))
  16787. (defun org-file-image-p (file &optional extensions)
  16788. "Return non-nil if FILE is an image."
  16789. (save-match-data
  16790. (string-match (org-image-file-name-regexp extensions) file)))
  16791. (defun org-get-cursor-date ()
  16792. "Return the date at cursor in as a time.
  16793. This works in the calendar and in the agenda, anywhere else it just
  16794. returns the current time."
  16795. (let (date day defd)
  16796. (cond
  16797. ((eq major-mode 'calendar-mode)
  16798. (setq date (calendar-cursor-to-date)
  16799. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
  16800. ((eq major-mode 'org-agenda-mode)
  16801. (setq day (get-text-property (point) 'day))
  16802. (if day
  16803. (setq date (calendar-gregorian-from-absolute day)
  16804. defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
  16805. (nth 2 date))))))
  16806. (or defd (current-time))))
  16807. (defvar org-agenda-action-marker (make-marker)
  16808. "Marker pointing to the entry for the next agenda action.")
  16809. (defun org-mark-entry-for-agenda-action ()
  16810. "Mark the current entry as target of an agenda action.
  16811. Agenda actions are actions executed from the agenda with the key `k',
  16812. which make use of the date at the cursor."
  16813. (interactive)
  16814. (move-marker org-agenda-action-marker
  16815. (save-excursion (org-back-to-heading t) (point))
  16816. (current-buffer))
  16817. (message
  16818. "Entry marked for action; press `k' at desired date in agenda or calendar"))
  16819. ;;; Paragraph filling stuff.
  16820. ;; We want this to be just right, so use the full arsenal.
  16821. (defun org-indent-line-function ()
  16822. "Indent line like previous, but further if previous was headline or item."
  16823. (interactive)
  16824. (let* ((pos (point))
  16825. (itemp (org-at-item-p))
  16826. (case-fold-search t)
  16827. (org-drawer-regexp (or org-drawer-regexp "\000"))
  16828. column bpos bcol tpos tcol bullet btype bullet-type)
  16829. ;; Find the previous relevant line
  16830. (beginning-of-line 1)
  16831. (cond
  16832. ((looking-at "#") (setq column 0))
  16833. ((looking-at "\\*+ ") (setq column 0))
  16834. ((and (looking-at "[ \t]*:END:")
  16835. (save-excursion (re-search-backward org-drawer-regexp nil t)))
  16836. (save-excursion
  16837. (goto-char (1- (match-beginning 1)))
  16838. (setq column (current-column))))
  16839. ((and (looking-at "[ \t]+#\\+end_\\([a-z]+\\)")
  16840. (save-excursion
  16841. (re-search-backward
  16842. (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
  16843. (setq column (org-get-indentation (match-string 0))))
  16844. (t
  16845. (beginning-of-line 0)
  16846. (while (and (not (bobp)) (looking-at "[ \t]*[\n:#|]")
  16847. (not (looking-at "[ \t]*:END:"))
  16848. (not (looking-at org-drawer-regexp)))
  16849. (beginning-of-line 0))
  16850. (cond
  16851. ((looking-at "\\*+[ \t]+")
  16852. (if (not org-adapt-indentation)
  16853. (setq column 0)
  16854. (goto-char (match-end 0))
  16855. (setq column (current-column))))
  16856. ((looking-at org-drawer-regexp)
  16857. (goto-char (1- (match-beginning 1)))
  16858. (setq column (current-column)))
  16859. ((looking-at "\\([ \t]*\\):END:")
  16860. (goto-char (match-end 1))
  16861. (setq column (current-column)))
  16862. ((org-in-item-p)
  16863. (org-beginning-of-item)
  16864. (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\[[- X]\\][ \t]*\\|.*? :: \\)?")
  16865. (setq bpos (match-beginning 1) tpos (match-end 0)
  16866. bcol (progn (goto-char bpos) (current-column))
  16867. tcol (progn (goto-char tpos) (current-column))
  16868. bullet (match-string 1)
  16869. bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
  16870. (if (> tcol (+ bcol org-description-max-indent))
  16871. (setq tcol (+ bcol 5)))
  16872. (if (not itemp)
  16873. (setq column tcol)
  16874. (goto-char pos)
  16875. (beginning-of-line 1)
  16876. (if (looking-at "\\S-")
  16877. (progn
  16878. (looking-at "[ \t]*\\(\\S-+\\)[ \t]*")
  16879. (setq bullet (match-string 1)
  16880. btype (if (string-match "[0-9]" bullet) "n" bullet))
  16881. (setq column (if (equal btype bullet-type) bcol tcol)))
  16882. (setq column (org-get-indentation)))))
  16883. (t (setq column (org-get-indentation))))))
  16884. (goto-char pos)
  16885. (if (<= (current-column) (current-indentation))
  16886. (org-indent-line-to column)
  16887. (save-excursion (org-indent-line-to column)))
  16888. (setq column (current-column))
  16889. (beginning-of-line 1)
  16890. (if (looking-at
  16891. "\\([ \t]+\\)\\(:[-_0-9a-zA-Z]+:\\)[ \t]*\\(\\S-.*\\(\\S-\\|$\\)\\)")
  16892. (replace-match (concat (match-string 1)
  16893. (format org-property-format
  16894. (match-string 2) (match-string 3)))
  16895. t t))
  16896. (org-move-to-column column)))
  16897. (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
  16898. "Variable to store copy of `adaptive-fill-regexp'.
  16899. Since `adaptive-fill-regexp' is set to never match, we need to
  16900. store a backup of its value before entering `org-mode' so that
  16901. the functionality can be provided as a fall-back.")
  16902. (defun org-set-autofill-regexps ()
  16903. (interactive)
  16904. ;; In the paragraph separator we include headlines, because filling
  16905. ;; text in a line directly attached to a headline would otherwise
  16906. ;; fill the headline as well.
  16907. (org-set-local 'comment-start-skip "^#+[ \t]*")
  16908. (org-set-local 'paragraph-separate "\f\\|\\*+ \\|[ ]*$\\|[ \t]*[:|#]")
  16909. ;; The paragraph starter includes hand-formatted lists.
  16910. (org-set-local
  16911. 'paragraph-start
  16912. (concat
  16913. "\f" "\\|"
  16914. "[ ]*$" "\\|"
  16915. "\\*+ " "\\|"
  16916. "[ \t]*#" "\\|"
  16917. "[ \t]*\\([-+*][ \t]+\\|[0-9]+[.)][ \t]+\\)" "\\|"
  16918. "[ \t]*[:|]" "\\|"
  16919. "\\$\\$" "\\|"
  16920. "\\\\\\(begin\\|end\\|[][]\\)"))
  16921. ;; Inhibit auto-fill for headers, tables and fixed-width lines.
  16922. ;; But only if the user has not turned off tables or fixed-width regions
  16923. (org-set-local
  16924. 'auto-fill-inhibit-regexp
  16925. (concat "\\*+ \\|#\\+"
  16926. "\\|[ \t]*" org-keyword-time-regexp
  16927. (if (or org-enable-table-editor org-enable-fixed-width-editor)
  16928. (concat
  16929. "\\|[ \t]*["
  16930. (if org-enable-table-editor "|" "")
  16931. (if org-enable-fixed-width-editor ":" "")
  16932. "]"))))
  16933. ;; We use our own fill-paragraph function, to make sure that tables
  16934. ;; and fixed-width regions are not wrapped. That function will pass
  16935. ;; through to `fill-paragraph' when appropriate.
  16936. (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
  16937. ;; Adaptive filling: To get full control, first make sure that
  16938. ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
  16939. (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
  16940. (org-set-local 'org-adaptive-fill-regexp-backup
  16941. adaptive-fill-regexp))
  16942. (org-set-local 'adaptive-fill-regexp "\000")
  16943. (org-set-local 'adaptive-fill-function
  16944. 'org-adaptive-fill-function)
  16945. (org-set-local
  16946. 'align-mode-rules-list
  16947. '((org-in-buffer-settings
  16948. (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
  16949. (modes . '(org-mode))))))
  16950. (defun org-fill-paragraph (&optional justify)
  16951. "Re-align a table, pass through to fill-paragraph if no table."
  16952. (let ((table-p (org-at-table-p))
  16953. (table.el-p (org-at-table.el-p)))
  16954. (cond ((and (equal (char-after (point-at-bol)) ?*)
  16955. (save-excursion (goto-char (point-at-bol))
  16956. (looking-at outline-regexp)))
  16957. t) ; skip headlines
  16958. (table.el-p t) ; skip table.el tables
  16959. (table-p (org-table-align) t) ; align org-mode tables
  16960. (t nil)))) ; call paragraph-fill
  16961. ;; For reference, this is the default value of adaptive-fill-regexp
  16962. ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
  16963. (defun org-adaptive-fill-function ()
  16964. "Return a fill prefix for org-mode files.
  16965. In particular, this makes sure hanging paragraphs for hand-formatted lists
  16966. work correctly."
  16967. (cond
  16968. ;; Comment line
  16969. ((looking-at "#[ \t]+")
  16970. (match-string-no-properties 0))
  16971. ;; Description list
  16972. ((looking-at "[ \t]*\\([-*+] .*? :: \\)")
  16973. (save-excursion
  16974. (if (> (match-end 1) (+ (match-beginning 1)
  16975. org-description-max-indent))
  16976. (goto-char (+ (match-beginning 1) 5))
  16977. (goto-char (match-end 0)))
  16978. (make-string (current-column) ?\ )))
  16979. ;; Ordered or unordered list
  16980. ((looking-at "[ \t]*\\([-*+] \\|[0-9]+[.)] ?\\)")
  16981. (save-excursion
  16982. (goto-char (match-end 0))
  16983. (make-string (current-column) ?\ )))
  16984. ;; Other text
  16985. ((looking-at org-adaptive-fill-regexp-backup)
  16986. (match-string-no-properties 0))))
  16987. ;;; Other stuff.
  16988. (defun org-toggle-fixed-width-section (arg)
  16989. "Toggle the fixed-width export.
  16990. If there is no active region, the QUOTE keyword at the current headline is
  16991. inserted or removed. When present, it causes the text between this headline
  16992. and the next to be exported as fixed-width text, and unmodified.
  16993. If there is an active region, this command adds or removes a colon as the
  16994. first character of this line. If the first character of a line is a colon,
  16995. this line is also exported in fixed-width font."
  16996. (interactive "P")
  16997. (let* ((cc 0)
  16998. (regionp (org-region-active-p))
  16999. (beg (if regionp (region-beginning) (point)))
  17000. (end (if regionp (region-end)))
  17001. (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
  17002. (case-fold-search nil)
  17003. (re "[ \t]*\\(: \\)")
  17004. off)
  17005. (if regionp
  17006. (save-excursion
  17007. (goto-char beg)
  17008. (setq cc (current-column))
  17009. (beginning-of-line 1)
  17010. (setq off (looking-at re))
  17011. (while (> nlines 0)
  17012. (setq nlines (1- nlines))
  17013. (beginning-of-line 1)
  17014. (cond
  17015. (arg
  17016. (org-move-to-column cc t)
  17017. (insert ": \n")
  17018. (forward-line -1))
  17019. ((and off (looking-at re))
  17020. (replace-match "" t t nil 1))
  17021. ((not off) (org-move-to-column cc t) (insert ": ")))
  17022. (forward-line 1)))
  17023. (save-excursion
  17024. (org-back-to-heading)
  17025. (if (looking-at (concat outline-regexp
  17026. "\\( *\\<" org-quote-string "\\>[ \t]*\\)"))
  17027. (replace-match "" t t nil 1)
  17028. (if (looking-at outline-regexp)
  17029. (progn
  17030. (goto-char (match-end 0))
  17031. (insert org-quote-string " "))))))))
  17032. (defun org-reftex-citation ()
  17033. "Use reftex-citation to insert a citation into the buffer.
  17034. This looks for a line like
  17035. #+BIBLIOGRAPHY: foo plain option:-d
  17036. and derives from it that foo.bib is the bibliography file relevant
  17037. for this document. It then installs the necessary environment for RefTeX
  17038. to work in this buffer and calls `reftex-citation' to insert a citation
  17039. into the buffer.
  17040. Export of such citations to both LaTeX and HTML is handled by the contributed
  17041. package org-exp-bibtex by Taru Karttunen."
  17042. (interactive)
  17043. (let ((reftex-docstruct-symbol 'rds)
  17044. (reftex-cite-format "\\cite{%l}")
  17045. rds bib)
  17046. (save-excursion
  17047. (save-restriction
  17048. (widen)
  17049. (let ((case-fold-search t)
  17050. (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
  17051. (if (not (save-excursion
  17052. (or (re-search-forward re nil t)
  17053. (re-search-backward re nil t))))
  17054. (error "No bibliography defined in file")
  17055. (setq bib (concat (match-string 1) ".bib")
  17056. rds (list (list 'bib bib)))))))
  17057. (call-interactively 'reftex-citation)))
  17058. ;;;; Functions extending outline functionality
  17059. (defun org-beginning-of-line (&optional arg)
  17060. "Go to the beginning of the current line. If that is invisible, continue
  17061. to a visible line beginning. This makes the function of C-a more intuitive.
  17062. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  17063. first attempt, and only move to after the tags when the cursor is already
  17064. beyond the end of the headline."
  17065. (interactive "P")
  17066. (let ((pos (point))
  17067. (special (if (consp org-special-ctrl-a/e)
  17068. (car org-special-ctrl-a/e)
  17069. org-special-ctrl-a/e))
  17070. refpos)
  17071. (if (org-bound-and-true-p line-move-visual)
  17072. (beginning-of-visual-line 1)
  17073. (beginning-of-line 1))
  17074. (if (and arg (fboundp 'move-beginning-of-line))
  17075. (call-interactively 'move-beginning-of-line)
  17076. (if (bobp)
  17077. nil
  17078. (backward-char 1)
  17079. (if (org-truely-invisible-p)
  17080. (while (and (not (bobp)) (org-truely-invisible-p))
  17081. (backward-char 1)
  17082. (beginning-of-line 1))
  17083. (forward-char 1))))
  17084. (when special
  17085. (cond
  17086. ((and (looking-at org-complex-heading-regexp)
  17087. (= (char-after (match-end 1)) ?\ ))
  17088. (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
  17089. (point-at-eol)))
  17090. (goto-char
  17091. (if (eq special t)
  17092. (cond ((> pos refpos) refpos)
  17093. ((= pos (point)) refpos)
  17094. (t (point)))
  17095. (cond ((> pos (point)) (point))
  17096. ((not (eq last-command this-command)) (point))
  17097. (t refpos)))))
  17098. ((org-at-item-p)
  17099. (goto-char
  17100. (if (eq special t)
  17101. (cond ((> pos (match-end 4)) (match-end 4))
  17102. ((= pos (point)) (match-end 4))
  17103. (t (point)))
  17104. (cond ((> pos (point)) (point))
  17105. ((not (eq last-command this-command)) (point))
  17106. (t (match-end 4))))))))
  17107. (org-no-warnings
  17108. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  17109. (defun org-end-of-line (&optional arg)
  17110. "Go to the end of the line.
  17111. If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
  17112. first attempt, and only move to after the tags when the cursor is already
  17113. beyond the end of the headline."
  17114. (interactive "P")
  17115. (let ((special (if (consp org-special-ctrl-a/e)
  17116. (cdr org-special-ctrl-a/e)
  17117. org-special-ctrl-a/e)))
  17118. (if (or (not special)
  17119. (not (org-on-heading-p))
  17120. arg)
  17121. (call-interactively
  17122. (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
  17123. ((fboundp 'move-end-of-line) 'move-end-of-line)
  17124. (t 'end-of-line)))
  17125. (let ((pos (point)))
  17126. (beginning-of-line 1)
  17127. (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@:]+:\\)?[ \t]*\\)?$"))
  17128. (if (eq special t)
  17129. (if (or (< pos (match-beginning 1))
  17130. (= pos (match-end 0)))
  17131. (goto-char (match-beginning 1))
  17132. (goto-char (match-end 0)))
  17133. (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
  17134. (goto-char (match-end 0))
  17135. (goto-char (match-beginning 1))))
  17136. (call-interactively (if (fboundp 'move-end-of-line)
  17137. 'move-end-of-line
  17138. 'end-of-line)))))
  17139. (org-no-warnings
  17140. (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
  17141. (define-key org-mode-map "\C-a" 'org-beginning-of-line)
  17142. (define-key org-mode-map "\C-e" 'org-end-of-line)
  17143. (define-key org-mode-map [home] 'org-beginning-of-line)
  17144. (define-key org-mode-map [end] 'org-end-of-line)
  17145. (defun org-backward-sentence (&optional arg)
  17146. "Go to beginning of sentence, or beginning of table field.
  17147. This will call `backward-sentence' or `org-table-beginning-of-field',
  17148. depending on context."
  17149. (interactive "P")
  17150. (cond
  17151. ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
  17152. (t (call-interactively 'backward-sentence))))
  17153. (defun org-forward-sentence (&optional arg)
  17154. "Go to end of sentence, or end of table field.
  17155. This will call `forward-sentence' or `org-table-end-of-field',
  17156. depending on context."
  17157. (interactive "P")
  17158. (cond
  17159. ((org-at-table-p) (call-interactively 'org-table-end-of-field))
  17160. (t (call-interactively 'forward-sentence))))
  17161. (define-key org-mode-map "\M-a" 'org-backward-sentence)
  17162. (define-key org-mode-map "\M-e" 'org-forward-sentence)
  17163. (defun org-kill-line (&optional arg)
  17164. "Kill line, to tags or end of line."
  17165. (interactive "P")
  17166. (cond
  17167. ((or (not org-special-ctrl-k)
  17168. (bolp)
  17169. (not (org-on-heading-p)))
  17170. (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
  17171. org-ctrl-k-protect-subtree)
  17172. (if (or (eq org-ctrl-k-protect-subtree 'error)
  17173. (not (y-or-n-p "Kill hidden subtree along with headline? ")))
  17174. (error "C-k aborted - would kill hidden subtree")))
  17175. (call-interactively 'kill-line))
  17176. ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@:]+:\\)\\)[ \t]*$"))
  17177. (kill-region (point) (match-beginning 1))
  17178. (org-set-tags nil t))
  17179. (t (kill-region (point) (point-at-eol)))))
  17180. (define-key org-mode-map "\C-k" 'org-kill-line)
  17181. (defun org-yank (&optional arg)
  17182. "Yank. If the kill is a subtree, treat it specially.
  17183. This command will look at the current kill and check if is a single
  17184. subtree, or a series of subtrees[1]. If it passes the test, and if the
  17185. cursor is at the beginning of a line or after the stars of a currently
  17186. empty headline, then the yank is handled specially. How exactly depends
  17187. on the value of the following variables, both set by default.
  17188. org-yank-folded-subtrees
  17189. When set, the subtree(s) will be folded after insertion, but only
  17190. if doing so would now swallow text after the yanked text.
  17191. org-yank-adjusted-subtrees
  17192. When set, the subtree will be promoted or demoted in order to
  17193. fit into the local outline tree structure, which means that the level
  17194. will be adjusted so that it becomes the smaller one of the two
  17195. *visible* surrounding headings.
  17196. Any prefix to this command will cause `yank' to be called directly with
  17197. no special treatment. In particular, a simple `C-u' prefix will just
  17198. plainly yank the text as it is.
  17199. \[1] The test checks if the first non-white line is a heading
  17200. and if there are no other headings with fewer stars."
  17201. (interactive "P")
  17202. (org-yank-generic 'yank arg))
  17203. (defun org-yank-generic (command arg)
  17204. "Perform some yank-like command.
  17205. This function implements the behavior described in the `org-yank'
  17206. documentation. However, it has been generalized to work for any
  17207. interactive command with similar behavior."
  17208. ;; pretend to be command COMMAND
  17209. (setq this-command command)
  17210. (if arg
  17211. (call-interactively command)
  17212. (let ((subtreep ; is kill a subtree, and the yank position appropriate?
  17213. (and (org-kill-is-subtree-p)
  17214. (or (bolp)
  17215. (and (looking-at "[ \t]*$")
  17216. (string-match
  17217. "\\`\\*+\\'"
  17218. (buffer-substring (point-at-bol) (point)))))))
  17219. swallowp)
  17220. (cond
  17221. ((and subtreep org-yank-folded-subtrees)
  17222. (let ((beg (point))
  17223. end)
  17224. (if (and subtreep org-yank-adjusted-subtrees)
  17225. (org-paste-subtree nil nil 'for-yank)
  17226. (call-interactively command))
  17227. (setq end (point))
  17228. (goto-char beg)
  17229. (when (and (bolp) subtreep
  17230. (not (setq swallowp
  17231. (org-yank-folding-would-swallow-text beg end))))
  17232. (or (looking-at outline-regexp)
  17233. (re-search-forward (concat "^" outline-regexp) end t))
  17234. (while (and (< (point) end) (looking-at outline-regexp))
  17235. (hide-subtree)
  17236. (org-cycle-show-empty-lines 'folded)
  17237. (condition-case nil
  17238. (outline-forward-same-level 1)
  17239. (error (goto-char end)))))
  17240. (when swallowp
  17241. (message
  17242. "Inserted text not folded because that would swallow text"))
  17243. (goto-char end)
  17244. (skip-chars-forward " \t\n\r")
  17245. (beginning-of-line 1)
  17246. (push-mark beg 'nomsg)))
  17247. ((and subtreep org-yank-adjusted-subtrees)
  17248. (let ((beg (point-at-bol)))
  17249. (org-paste-subtree nil nil 'for-yank)
  17250. (push-mark beg 'nomsg)))
  17251. (t
  17252. (call-interactively command))))))
  17253. (defun org-yank-folding-would-swallow-text (beg end)
  17254. "Would hide-subtree at BEG swallow any text after END?"
  17255. (let (level)
  17256. (save-excursion
  17257. (goto-char beg)
  17258. (when (or (looking-at outline-regexp)
  17259. (re-search-forward (concat "^" outline-regexp) end t))
  17260. (setq level (org-outline-level)))
  17261. (goto-char end)
  17262. (skip-chars-forward " \t\r\n\v\f")
  17263. (if (or (eobp)
  17264. (and (bolp) (looking-at org-outline-regexp)
  17265. (<= (org-outline-level) level)))
  17266. nil ; Nothing would be swallowed
  17267. t)))) ; something would swallow
  17268. (define-key org-mode-map "\C-y" 'org-yank)
  17269. (defun org-invisible-p ()
  17270. "Check if point is at a character currently not visible."
  17271. ;; Early versions of noutline don't have `outline-invisible-p'.
  17272. (if (fboundp 'outline-invisible-p)
  17273. (outline-invisible-p)
  17274. (get-char-property (point) 'invisible)))
  17275. (defun org-truely-invisible-p ()
  17276. "Check if point is at a character currently not visible.
  17277. This version does not only check the character property, but also
  17278. `visible-mode'."
  17279. ;; Early versions of noutline don't have `outline-invisible-p'.
  17280. (if (org-bound-and-true-p visible-mode)
  17281. nil
  17282. (if (fboundp 'outline-invisible-p)
  17283. (outline-invisible-p)
  17284. (get-char-property (point) 'invisible))))
  17285. (defun org-invisible-p2 ()
  17286. "Check if point is at a character currently not visible."
  17287. (save-excursion
  17288. (if (and (eolp) (not (bobp))) (backward-char 1))
  17289. ;; Early versions of noutline don't have `outline-invisible-p'.
  17290. (if (fboundp 'outline-invisible-p)
  17291. (outline-invisible-p)
  17292. (get-char-property (point) 'invisible))))
  17293. (defun org-back-to-heading (&optional invisible-ok)
  17294. "Call `outline-back-to-heading', but provide a better error message."
  17295. (condition-case nil
  17296. (outline-back-to-heading invisible-ok)
  17297. (error (error "Before first headline at position %d in buffer %s"
  17298. (point) (current-buffer)))))
  17299. (defun org-beginning-of-defun ()
  17300. "Go to the beginning of the subtree, i.e. back to the heading."
  17301. (org-back-to-heading))
  17302. (defun org-end-of-defun ()
  17303. "Go to the end of the subtree."
  17304. (org-end-of-subtree nil t))
  17305. (defun org-before-first-heading-p ()
  17306. "Before first heading?"
  17307. (save-excursion
  17308. (null (re-search-backward "^\\*+ " nil t))))
  17309. (defun org-on-heading-p (&optional ignored)
  17310. (outline-on-heading-p t))
  17311. (defun org-at-heading-p (&optional ignored)
  17312. (outline-on-heading-p t))
  17313. (defun org-point-at-end-of-empty-headline ()
  17314. "If point is at the end of an empty headline, return t, else nil.
  17315. If the heading only contains a TODO keyword, it is still still considered
  17316. empty."
  17317. (and (looking-at "[ \t]*$")
  17318. (save-excursion
  17319. (beginning-of-line 1)
  17320. (looking-at (concat "^\\(\\*+\\)[ \t]+\\(" org-todo-regexp
  17321. "\\)?[ \t]*$")))))
  17322. (defun org-at-heading-or-item-p ()
  17323. (or (org-on-heading-p) (org-at-item-p)))
  17324. (defun org-on-target-p ()
  17325. (or (org-in-regexp org-radio-target-regexp)
  17326. (org-in-regexp org-target-regexp)))
  17327. (defun org-up-heading-all (arg)
  17328. "Move to the heading line of which the present line is a subheading.
  17329. This function considers both visible and invisible heading lines.
  17330. With argument, move up ARG levels."
  17331. (if (fboundp 'outline-up-heading-all)
  17332. (outline-up-heading-all arg) ; emacs 21 version of outline.el
  17333. (outline-up-heading arg t))) ; emacs 22 version of outline.el
  17334. (defun org-up-heading-safe ()
  17335. "Move to the heading line of which the present line is a subheading.
  17336. This version will not throw an error. It will return the level of the
  17337. headline found, or nil if no higher level is found.
  17338. Also, this function will be a lot faster than `outline-up-heading',
  17339. because it relies on stars being the outline starters. This can really
  17340. make a significant difference in outlines with very many siblings."
  17341. (let (start-level re)
  17342. (org-back-to-heading t)
  17343. (setq start-level (funcall outline-level))
  17344. (if (equal start-level 1)
  17345. nil
  17346. (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
  17347. (if (re-search-backward re nil t)
  17348. (funcall outline-level)))))
  17349. (defun org-first-sibling-p ()
  17350. "Is this heading the first child of its parents?"
  17351. (interactive)
  17352. (let ((re (concat "^" outline-regexp))
  17353. level l)
  17354. (unless (org-at-heading-p t)
  17355. (error "Not at a heading"))
  17356. (setq level (funcall outline-level))
  17357. (save-excursion
  17358. (if (not (re-search-backward re nil t))
  17359. t
  17360. (setq l (funcall outline-level))
  17361. (< l level)))))
  17362. (defun org-goto-sibling (&optional previous)
  17363. "Goto the next sibling, even if it is invisible.
  17364. When PREVIOUS is set, go to the previous sibling instead. Returns t
  17365. when a sibling was found. When none is found, return nil and don't
  17366. move point."
  17367. (let ((fun (if previous 're-search-backward 're-search-forward))
  17368. (pos (point))
  17369. (re (concat "^" outline-regexp))
  17370. level l)
  17371. (when (condition-case nil (org-back-to-heading t) (error nil))
  17372. (setq level (funcall outline-level))
  17373. (catch 'exit
  17374. (or previous (forward-char 1))
  17375. (while (funcall fun re nil t)
  17376. (setq l (funcall outline-level))
  17377. (when (< l level) (goto-char pos) (throw 'exit nil))
  17378. (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
  17379. (goto-char pos)
  17380. nil))))
  17381. (defun org-show-siblings ()
  17382. "Show all siblings of the current headline."
  17383. (save-excursion
  17384. (while (org-goto-sibling) (org-flag-heading nil)))
  17385. (save-excursion
  17386. (while (org-goto-sibling 'previous)
  17387. (org-flag-heading nil))))
  17388. (defun org-show-hidden-entry ()
  17389. "Show an entry where even the heading is hidden."
  17390. (save-excursion
  17391. (org-show-entry)))
  17392. (defun org-flag-heading (flag &optional entry)
  17393. "Flag the current heading. FLAG non-nil means make invisible.
  17394. When ENTRY is non-nil, show the entire entry."
  17395. (save-excursion
  17396. (org-back-to-heading t)
  17397. ;; Check if we should show the entire entry
  17398. (if entry
  17399. (progn
  17400. (org-show-entry)
  17401. (save-excursion
  17402. (and (outline-next-heading)
  17403. (org-flag-heading nil))))
  17404. (outline-flag-region (max (point-min) (1- (point)))
  17405. (save-excursion (outline-end-of-heading) (point))
  17406. flag))))
  17407. (defun org-get-next-sibling ()
  17408. "Move to next heading of the same level, and return point.
  17409. If there is no such heading, return nil.
  17410. This is like outline-next-sibling, but invisible headings are ok."
  17411. (let ((level (funcall outline-level)))
  17412. (outline-next-heading)
  17413. (while (and (not (eobp)) (> (funcall outline-level) level))
  17414. (outline-next-heading))
  17415. (if (or (eobp) (< (funcall outline-level) level))
  17416. nil
  17417. (point))))
  17418. (defun org-get-last-sibling ()
  17419. "Move to previous heading of the same level, and return point.
  17420. If there is no such heading, return nil."
  17421. (let ((opoint (point))
  17422. (level (funcall outline-level)))
  17423. (outline-previous-heading)
  17424. (when (and (/= (point) opoint) (outline-on-heading-p t))
  17425. (while (and (> (funcall outline-level) level)
  17426. (not (bobp)))
  17427. (outline-previous-heading))
  17428. (if (< (funcall outline-level) level)
  17429. nil
  17430. (point)))))
  17431. (defun org-end-of-subtree (&optional invisible-OK to-heading)
  17432. ;; This contains an exact copy of the original function, but it uses
  17433. ;; `org-back-to-heading', to make it work also in invisible
  17434. ;; trees. And is uses an invisible-OK argument.
  17435. ;; Under Emacs this is not needed, but the old outline.el needs this fix.
  17436. ;; Furthermore, when used inside Org, finding the end of a large subtree
  17437. ;; with many children and grandchildren etc, this can be much faster
  17438. ;; than the outline version.
  17439. (org-back-to-heading invisible-OK)
  17440. (let ((first t)
  17441. (level (funcall outline-level)))
  17442. (if (and (org-mode-p) (< level 1000))
  17443. ;; A true heading (not a plain list item), in Org-mode
  17444. ;; This means we can easily find the end by looking
  17445. ;; only for the right number of stars. Using a regexp to do
  17446. ;; this is so much faster than using a Lisp loop.
  17447. (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
  17448. (forward-char 1)
  17449. (and (re-search-forward re nil 'move) (beginning-of-line 1)))
  17450. ;; something else, do it the slow way
  17451. (while (and (not (eobp))
  17452. (or first (> (funcall outline-level) level)))
  17453. (setq first nil)
  17454. (outline-next-heading)))
  17455. (unless to-heading
  17456. (if (memq (preceding-char) '(?\n ?\^M))
  17457. (progn
  17458. ;; Go to end of line before heading
  17459. (forward-char -1)
  17460. (if (memq (preceding-char) '(?\n ?\^M))
  17461. ;; leave blank line before heading
  17462. (forward-char -1))))))
  17463. (point))
  17464. (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
  17465. "Use Org version in org-mode, for dramatic speed-up."
  17466. (if (eq major-mode 'org-mode)
  17467. (progn
  17468. (org-end-of-subtree nil t)
  17469. (unless (eobp) (backward-char 1)))
  17470. ad-do-it))
  17471. (defun org-forward-same-level (arg &optional invisible-ok)
  17472. "Move forward to the arg'th subheading at same level as this one.
  17473. Stop at the first and last subheadings of a superior heading."
  17474. (interactive "p")
  17475. (org-back-to-heading invisible-ok)
  17476. (org-on-heading-p)
  17477. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  17478. (re (format "^\\*\\{1,%d\\} " level))
  17479. l)
  17480. (forward-char 1)
  17481. (while (> arg 0)
  17482. (while (and (re-search-forward re nil 'move)
  17483. (setq l (- (match-end 0) (match-beginning 0) 1))
  17484. (= l level)
  17485. (not invisible-ok)
  17486. (progn (backward-char 1) (org-invisible-p)))
  17487. (if (< l level) (setq arg 1)))
  17488. (setq arg (1- arg)))
  17489. (beginning-of-line 1)))
  17490. (defun org-backward-same-level (arg &optional invisible-ok)
  17491. "Move backward to the arg'th subheading at same level as this one.
  17492. Stop at the first and last subheadings of a superior heading."
  17493. (interactive "p")
  17494. (org-back-to-heading)
  17495. (org-on-heading-p)
  17496. (let* ((level (- (match-end 0) (match-beginning 0) 1))
  17497. (re (format "^\\*\\{1,%d\\} " level))
  17498. l)
  17499. (while (> arg 0)
  17500. (while (and (re-search-backward re nil 'move)
  17501. (setq l (- (match-end 0) (match-beginning 0) 1))
  17502. (= l level)
  17503. (not invisible-ok)
  17504. (org-invisible-p))
  17505. (if (< l level) (setq arg 1)))
  17506. (setq arg (1- arg)))))
  17507. (defun org-show-subtree ()
  17508. "Show everything after this heading at deeper levels."
  17509. (outline-flag-region
  17510. (point)
  17511. (save-excursion
  17512. (org-end-of-subtree t t))
  17513. nil))
  17514. (defun org-show-entry ()
  17515. "Show the body directly following this heading.
  17516. Show the heading too, if it is currently invisible."
  17517. (interactive)
  17518. (save-excursion
  17519. (condition-case nil
  17520. (progn
  17521. (org-back-to-heading t)
  17522. (outline-flag-region
  17523. (max (point-min) (1- (point)))
  17524. (save-excursion
  17525. (if (re-search-forward
  17526. (concat "[\r\n]\\(" outline-regexp "\\)") nil t)
  17527. (match-beginning 1)
  17528. (point-max)))
  17529. nil)
  17530. (org-cycle-hide-drawers 'children))
  17531. (error nil))))
  17532. (defun org-make-options-regexp (kwds &optional extra)
  17533. "Make a regular expression for keyword lines."
  17534. (concat
  17535. "^"
  17536. "#?[ \t]*\\+\\("
  17537. (mapconcat 'regexp-quote kwds "\\|")
  17538. (if extra (concat "\\|" extra))
  17539. "\\):[ \t]*"
  17540. "\\(.*\\)"))
  17541. ;; Make isearch reveal the necessary context
  17542. (defun org-isearch-end ()
  17543. "Reveal context after isearch exits."
  17544. (when isearch-success ; only if search was successful
  17545. (if (featurep 'xemacs)
  17546. ;; Under XEmacs, the hook is run in the correct place,
  17547. ;; we directly show the context.
  17548. (org-show-context 'isearch)
  17549. ;; In Emacs the hook runs *before* restoring the overlays.
  17550. ;; So we have to use a one-time post-command-hook to do this.
  17551. ;; (Emacs 22 has a special variable, see function `org-mode')
  17552. (unless (and (boundp 'isearch-mode-end-hook-quit)
  17553. isearch-mode-end-hook-quit)
  17554. ;; Only when the isearch was not quitted.
  17555. (org-add-hook 'post-command-hook 'org-isearch-post-command
  17556. 'append 'local)))))
  17557. (defun org-isearch-post-command ()
  17558. "Remove self from hook, and show context."
  17559. (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
  17560. (org-show-context 'isearch))
  17561. ;;;; Integration with and fixes for other packages
  17562. ;;; Imenu support
  17563. (defvar org-imenu-markers nil
  17564. "All markers currently used by Imenu.")
  17565. (make-variable-buffer-local 'org-imenu-markers)
  17566. (defun org-imenu-new-marker (&optional pos)
  17567. "Return a new marker for use by Imenu, and remember the marker."
  17568. (let ((m (make-marker)))
  17569. (move-marker m (or pos (point)))
  17570. (push m org-imenu-markers)
  17571. m))
  17572. (defun org-imenu-get-tree ()
  17573. "Produce the index for Imenu."
  17574. (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
  17575. (setq org-imenu-markers nil)
  17576. (let* ((n org-imenu-depth)
  17577. (re (concat "^" outline-regexp))
  17578. (subs (make-vector (1+ n) nil))
  17579. (last-level 0)
  17580. m level head)
  17581. (save-excursion
  17582. (save-restriction
  17583. (widen)
  17584. (goto-char (point-max))
  17585. (while (re-search-backward re nil t)
  17586. (setq level (org-reduced-level (funcall outline-level)))
  17587. (when (<= level n)
  17588. (looking-at org-complex-heading-regexp)
  17589. (setq head (org-link-display-format
  17590. (org-match-string-no-properties 4))
  17591. m (org-imenu-new-marker))
  17592. (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
  17593. (if (>= level last-level)
  17594. (push (cons head m) (aref subs level))
  17595. (push (cons head (aref subs (1+ level))) (aref subs level))
  17596. (loop for i from (1+ level) to n do (aset subs i nil)))
  17597. (setq last-level level)))))
  17598. (aref subs 1)))
  17599. (eval-after-load "imenu"
  17600. '(progn
  17601. (add-hook 'imenu-after-jump-hook
  17602. (lambda ()
  17603. (if (eq major-mode 'org-mode)
  17604. (org-show-context 'org-goto))))))
  17605. (defun org-link-display-format (link)
  17606. "Replace a link with either the description, or the link target
  17607. if no description is present"
  17608. (save-match-data
  17609. (if (string-match org-bracket-link-analytic-regexp link)
  17610. (replace-match (if (match-end 5)
  17611. (match-string 5 link)
  17612. (concat (match-string 1 link)
  17613. (match-string 3 link)))
  17614. nil t link)
  17615. link)))
  17616. ;; Speedbar support
  17617. (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
  17618. "Overlay marking the agenda restriction line in speedbar.")
  17619. (overlay-put org-speedbar-restriction-lock-overlay
  17620. 'face 'org-agenda-restriction-lock)
  17621. (overlay-put org-speedbar-restriction-lock-overlay
  17622. 'help-echo "Agendas are currently limited to this item.")
  17623. (org-detach-overlay org-speedbar-restriction-lock-overlay)
  17624. (defun org-speedbar-set-agenda-restriction ()
  17625. "Restrict future agenda commands to the location at point in speedbar.
  17626. To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
  17627. (interactive)
  17628. (require 'org-agenda)
  17629. (let (p m tp np dir txt)
  17630. (cond
  17631. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  17632. 'org-imenu t))
  17633. (setq m (get-text-property p 'org-imenu-marker))
  17634. (with-current-buffer (marker-buffer m)
  17635. (goto-char m)
  17636. (org-agenda-set-restriction-lock 'subtree)))
  17637. ((setq p (text-property-any (point-at-bol) (point-at-eol)
  17638. 'speedbar-function 'speedbar-find-file))
  17639. (setq tp (previous-single-property-change
  17640. (1+ p) 'speedbar-function)
  17641. np (next-single-property-change
  17642. tp 'speedbar-function)
  17643. dir (speedbar-line-directory)
  17644. txt (buffer-substring-no-properties (or tp (point-min))
  17645. (or np (point-max))))
  17646. (with-current-buffer (find-file-noselect
  17647. (let ((default-directory dir))
  17648. (expand-file-name txt)))
  17649. (unless (org-mode-p)
  17650. (error "Cannot restrict to non-Org-mode file"))
  17651. (org-agenda-set-restriction-lock 'file)))
  17652. (t (error "Don't know how to restrict Org-mode's agenda")))
  17653. (move-overlay org-speedbar-restriction-lock-overlay
  17654. (point-at-bol) (point-at-eol))
  17655. (setq current-prefix-arg nil)
  17656. (org-agenda-maybe-redo)))
  17657. (eval-after-load "speedbar"
  17658. '(progn
  17659. (speedbar-add-supported-extension ".org")
  17660. (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
  17661. (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
  17662. (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
  17663. (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
  17664. (add-hook 'speedbar-visiting-tag-hook
  17665. (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
  17666. ;;; Fixes and Hacks for problems with other packages
  17667. ;; Make flyspell not check words in links, to not mess up our keymap
  17668. (defun org-mode-flyspell-verify ()
  17669. "Don't let flyspell put overlays at active buttons."
  17670. (and (not (get-text-property (point) 'keymap))
  17671. (not (get-text-property (point) 'org-no-flyspell))))
  17672. (defun org-remove-flyspell-overlays-in (beg end)
  17673. "Remove flyspell overlays in region."
  17674. (and (org-bound-and-true-p flyspell-mode)
  17675. (fboundp 'flyspell-delete-region-overlays)
  17676. (flyspell-delete-region-overlays beg end))
  17677. (add-text-properties beg end '(org-no-flyspell t)))
  17678. ;; Make `bookmark-jump' shows the jump location if it was hidden.
  17679. (eval-after-load "bookmark"
  17680. '(if (boundp 'bookmark-after-jump-hook)
  17681. ;; We can use the hook
  17682. (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
  17683. ;; Hook not available, use advice
  17684. (defadvice bookmark-jump (after org-make-visible activate)
  17685. "Make the position visible."
  17686. (org-bookmark-jump-unhide))))
  17687. ;; Make sure saveplace shows the location if it was hidden
  17688. (eval-after-load "saveplace"
  17689. '(defadvice save-place-find-file-hook (after org-make-visible activate)
  17690. "Make the position visible."
  17691. (org-bookmark-jump-unhide)))
  17692. ;; Make sure ecb shows the location if it was hidden
  17693. (eval-after-load "ecb"
  17694. '(defadvice ecb-method-clicked (after esf/org-show-context activate)
  17695. "Make hierarchy visible when jumping into location from ECB tree buffer."
  17696. (if (eq major-mode 'org-mode)
  17697. (org-show-context))))
  17698. (defun org-bookmark-jump-unhide ()
  17699. "Unhide the current position, to show the bookmark location."
  17700. (and (org-mode-p)
  17701. (or (org-invisible-p)
  17702. (save-excursion (goto-char (max (point-min) (1- (point))))
  17703. (org-invisible-p)))
  17704. (org-show-context 'bookmark-jump)))
  17705. ;; Make session.el ignore our circular variable
  17706. (eval-after-load "session"
  17707. '(add-to-list 'session-globals-exclude 'org-mark-ring))
  17708. ;;;; Experimental code
  17709. (defun org-closed-in-range ()
  17710. "Sparse tree of items closed in a certain time range.
  17711. Still experimental, may disappear in the future."
  17712. (interactive)
  17713. ;; Get the time interval from the user.
  17714. (let* ((time1 (org-float-time
  17715. (org-read-date nil 'to-time nil "Starting date: ")))
  17716. (time2 (org-float-time
  17717. (org-read-date nil 'to-time nil "End date:")))
  17718. ;; callback function
  17719. (callback (lambda ()
  17720. (let ((time
  17721. (org-float-time
  17722. (apply 'encode-time
  17723. (org-parse-time-string
  17724. (match-string 1))))))
  17725. ;; check if time in interval
  17726. (and (>= time time1) (<= time time2))))))
  17727. ;; make tree, check each match with the callback
  17728. (org-occur "CLOSED: +\\[\\(.*?\\)\\]" nil callback)))
  17729. ;;;; Finish up
  17730. (provide 'org)
  17731. (run-hooks 'org-load-hook)
  17732. ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
  17733. ;;; org.el ends here